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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.1475  ! raeburn     4: # $Id: loncommon.pm,v 1.1474 2025/03/22 21:18:30 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)=@_;
1.1469    raeburn   969:    my $labeltext = &HTML::Entities::encode(&mt('Select Time Zone'));
                    970:    my $output='<select name="'.$name.'" '.$id.$onchange.$disabled.
                    971:               ' aria-label="'.$labeltext.'">'."\n";
1.659     raeburn   972:    if ($includeempty) {
                    973:        $output .= '<option value=""';
                    974:        if (($selected eq '') || ($selected eq 'local')) {
                    975:            $output .= ' selected="selected" ';
                    976:        }
                    977:        $output .= '> </option>';
                    978:    }
1.657     raeburn   979:    my @timezones = DateTime::TimeZone->all_names;
                    980:    foreach my $tzone (@timezones) {
                    981:        $output.= '<option value="'.$tzone.'"';
                    982:        if ($tzone eq $selected) {
                    983:            $output.=' selected="selected"';
                    984:        }
                    985:        $output.=">$tzone</option>\n";
1.656     www       986:    }
                    987:    $output.="</select>";
                    988:    return $output;
                    989: }
1.273     raeburn   990: 
1.687     raeburn   991: sub select_datelocale {
1.1256    raeburn   992:     my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
                    993:     my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687     raeburn   994:     if ($includeempty) {
                    995:         $output .= '<option value=""';
                    996:         if ($selected eq '') {
                    997:             $output .= ' selected="selected" ';
                    998:         }
                    999:         $output .= '> </option>';
                   1000:     }
1.1241    raeburn  1001:     my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn  1002:     my (@possibles,%locale_names);
1.1241    raeburn  1003:     my @locales = DateTime::Locale->ids();
                   1004:     foreach my $id (@locales) {
                   1005:         if ($id ne '') {
                   1006:             my ($en_terr,$native_terr);
                   1007:             my $loc = DateTime::Locale->load($id);
                   1008:             if (ref($loc)) {
                   1009:                 $en_terr = $loc->name();
                   1010:                 $native_terr = $loc->native_name();
1.687     raeburn  1011:                 if (grep(/^en$/,@languages) || !@languages) {
                   1012:                     if ($en_terr ne '') {
                   1013:                         $locale_names{$id} = '('.$en_terr.')';
                   1014:                     } elsif ($native_terr ne '') {
                   1015:                         $locale_names{$id} = $native_terr;
                   1016:                     }
                   1017:                 } else {
                   1018:                     if ($native_terr ne '') {
                   1019:                         $locale_names{$id} = $native_terr.' ';
                   1020:                     } elsif ($en_terr ne '') {
                   1021:                         $locale_names{$id} = '('.$en_terr.')';
                   1022:                     }
                   1023:                 }
1.1220    raeburn  1024:                 $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1241    raeburn  1025:                 push(@possibles,$id);
                   1026:             } 
1.687     raeburn  1027:         }
                   1028:     }
                   1029:     foreach my $item (sort(@possibles)) {
                   1030:         $output.= '<option value="'.$item.'"';
                   1031:         if ($item eq $selected) {
                   1032:             $output.=' selected="selected"';
                   1033:         }
                   1034:         $output.=">$item";
                   1035:         if ($locale_names{$item} ne '') {
1.1220    raeburn  1036:             $output.='  '.$locale_names{$item};
1.687     raeburn  1037:         }
                   1038:         $output.="</option>\n";
                   1039:     }
                   1040:     $output.="</select>";
                   1041:     return $output;
                   1042: }
                   1043: 
1.792     raeburn  1044: sub select_language {
1.1256    raeburn  1045:     my ($name,$selected,$includeempty,$noedit) = @_;
1.792     raeburn  1046:     my %langchoices;
                   1047:     if ($includeempty) {
1.1117    raeburn  1048:         %langchoices = ('' => 'No language preference');
1.792     raeburn  1049:     }
                   1050:     foreach my $id (&languageids()) {
                   1051:         my $code = &supportedlanguagecode($id);
                   1052:         if ($code) {
                   1053:             $langchoices{$code} = &plainlanguagedescription($id);
                   1054:         }
                   1055:     }
1.1117    raeburn  1056:     %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1256    raeburn  1057:     return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792     raeburn  1058: }
                   1059: 
1.42      matthew  1060: =pod
1.36      matthew  1061: 
1.1088    foxr     1062: 
                   1063: =item * &list_languages()
                   1064: 
                   1065: Returns an array reference that is suitable for use in language prompters.
                   1066: Each array element is itself a two element array.  The first element
                   1067: is the language code.  The second element a descsriptiuon of the 
                   1068: language itself.  This is suitable for use in e.g.
                   1069: &Apache::edit::select_arg (once dereferenced that is).
                   1070: 
                   1071: =cut 
                   1072: 
                   1073: sub list_languages {
                   1074:     my @lang_choices;
                   1075: 
                   1076:     foreach my $id (&languageids()) {
                   1077: 	my $code = &supportedlanguagecode($id);
                   1078: 	if ($code) {
                   1079: 	    my $selector    = $supported_codes{$id};
                   1080: 	    my $description = &plainlanguagedescription($id);
1.1263    raeburn  1081: 	    push(@lang_choices, [$selector, $description]);
1.1088    foxr     1082: 	}
                   1083:     }
                   1084:     return \@lang_choices;
                   1085: }
                   1086: 
                   1087: =pod
                   1088: 
1.648     raeburn  1089: =item * &linked_select_forms(...)
1.36      matthew  1090: 
                   1091: linked_select_forms returns a string containing a <script></script> block
                   1092: and html for two <select> menus.  The select menus will be linked in that
                   1093: changing the value of the first menu will result in new values being placed
                   1094: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn  1095: order unless a defined order is provided.
1.36      matthew  1096: 
                   1097: linked_select_forms takes the following ordered inputs:
                   1098: 
                   1099: =over 4
                   1100: 
1.112     bowersj2 1101: =item * $formname, the name of the <form> tag
1.36      matthew  1102: 
1.112     bowersj2 1103: =item * $middletext, the text which appears between the <select> tags
1.36      matthew  1104: 
1.112     bowersj2 1105: =item * $firstdefault, the default value for the first menu
1.36      matthew  1106: 
1.112     bowersj2 1107: =item * $firstselectname, the name of the first <select> tag
1.36      matthew  1108: 
1.112     bowersj2 1109: =item * $secondselectname, the name of the second <select> tag
1.36      matthew  1110: 
1.112     bowersj2 1111: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew  1112: 
1.609     raeburn  1113: =item * $menuorder, the order of values in the first menu
                   1114: 
1.1115    raeburn  1115: =item * $onchangefirst, additional javascript call to execute for an onchange
                   1116:         event for the first <select> tag
                   1117: 
                   1118: =item * $onchangesecond, additional javascript call to execute for an onchange
                   1119:         event for the second <select> tag
                   1120: 
1.1245    raeburn  1121: =item * $suffix, to differentiate separate uses of select2data javascript
                   1122:         objects in a page.
                   1123: 
1.41      ng       1124: =back 
                   1125: 
1.36      matthew  1126: Below is an example of such a hash.  Only the 'text', 'default', and 
                   1127: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                   1128: values for the first select menu.  The text that coincides with the 
1.41      ng       1129: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew  1130: and text for the second menu are given in the hash pointed to by 
                   1131: $menu{$choice1}->{'select2'}.  
                   1132: 
1.112     bowersj2 1133:  my %menu = ( A1 => { text =>"Choice A1" ,
                   1134:                        default => "B3",
                   1135:                        select2 => { 
                   1136:                            B1 => "Choice B1",
                   1137:                            B2 => "Choice B2",
                   1138:                            B3 => "Choice B3",
                   1139:                            B4 => "Choice B4"
1.609     raeburn  1140:                            },
                   1141:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2 1142:                    },
                   1143:                A2 => { text =>"Choice A2" ,
                   1144:                        default => "C2",
                   1145:                        select2 => { 
                   1146:                            C1 => "Choice C1",
                   1147:                            C2 => "Choice C2",
                   1148:                            C3 => "Choice C3"
1.609     raeburn  1149:                            },
                   1150:                        order => ['C2','C1','C3'],
1.112     bowersj2 1151:                    },
                   1152:                A3 => { text =>"Choice A3" ,
                   1153:                        default => "D6",
                   1154:                        select2 => { 
                   1155:                            D1 => "Choice D1",
                   1156:                            D2 => "Choice D2",
                   1157:                            D3 => "Choice D3",
                   1158:                            D4 => "Choice D4",
                   1159:                            D5 => "Choice D5",
                   1160:                            D6 => "Choice D6",
                   1161:                            D7 => "Choice D7"
1.609     raeburn  1162:                            },
                   1163:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2 1164:                    }
                   1165:                );
1.36      matthew  1166: 
                   1167: =cut
                   1168: 
                   1169: sub linked_select_forms {
                   1170:     my ($formname,
                   1171:         $middletext,
                   1172:         $firstdefault,
                   1173:         $firstselectname,
                   1174:         $secondselectname, 
1.609     raeburn  1175:         $hashref,
                   1176:         $menuorder,
1.1115    raeburn  1177:         $onchangefirst,
1.1245    raeburn  1178:         $onchangesecond,
1.1450    raeburn  1179:         $suffix,
                   1180:         $haslabel
1.36      matthew  1181:         ) = @_;
                   1182:     my $second = "document.$formname.$secondselectname";
                   1183:     my $first = "document.$formname.$firstselectname";
                   1184:     # output the javascript to do the changing
                   1185:     my $result = '';
1.776     bisitz   1186:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz   1187:     $result.="// <![CDATA[\n";
1.1245    raeburn  1188:     $result.="var select2data${suffix} = new Object();\n";
1.36      matthew  1189:     $" = '","';
                   1190:     my $debug = '';
                   1191:     foreach my $s1 (sort(keys(%$hashref))) {
1.1245    raeburn  1192:         $result.="select2data${suffix}['d_$s1'] = new Object();\n";        
                   1193:         $result.="select2data${suffix}['d_$s1'].def = new String('".
1.36      matthew  1194:             $hashref->{$s1}->{'default'}."');\n";
1.1245    raeburn  1195:         $result.="select2data${suffix}['d_$s1'].values = new Array(";
1.36      matthew  1196:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1197:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1198:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1199:         }
1.36      matthew  1200:         $result.="\"@s2values\");\n";
1.1245    raeburn  1201:         $result.="select2data${suffix}['d_$s1'].texts = new Array(";        
1.36      matthew  1202:         my @s2texts;
                   1203:         foreach my $value (@s2values) {
1.1263    raeburn  1204:             push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36      matthew  1205:         }
                   1206:         $result.="\"@s2texts\");\n";
                   1207:     }
                   1208:     $"=' ';
                   1209:     $result.= <<"END";
                   1210: 
1.1245    raeburn  1211: function select1${suffix}_changed() {
1.36      matthew  1212:     // Determine new choice
1.1245    raeburn  1213:     var newvalue = "d_" + $first.options[$first.selectedIndex].value;
1.36      matthew  1214:     // update select2
1.1245    raeburn  1215:     var values     = select2data${suffix}[newvalue].values;
                   1216:     var texts      = select2data${suffix}[newvalue].texts;
                   1217:     var select2def = select2data${suffix}[newvalue].def;
1.36      matthew  1218:     var i;
                   1219:     // out with the old
1.1245    raeburn  1220:     $second.options.length = 0;
                   1221:     // in with the new
1.36      matthew  1222:     for (i=0;i<values.length; i++) {
                   1223:         $second.options[i] = new Option(values[i]);
1.143     matthew  1224:         $second.options[i].value = values[i];
1.36      matthew  1225:         $second.options[i].text = texts[i];
                   1226:         if (values[i] == select2def) {
                   1227:             $second.options[i].selected = true;
                   1228:         }
                   1229:     }
                   1230: }
1.824     bisitz   1231: // ]]>
1.36      matthew  1232: </script>
                   1233: END
                   1234:     # output the initial values for the selection lists
1.1245    raeburn  1235:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1${suffix}_changed();$onchangefirst\">\n";
1.609     raeburn  1236:     my @order = sort(keys(%{$hashref}));
                   1237:     if (ref($menuorder) eq 'ARRAY') {
                   1238:         @order = @{$menuorder};
                   1239:     }
                   1240:     foreach my $value (@order) {
1.36      matthew  1241:         $result.="    <option value=\"$value\" ";
1.253     albertel 1242:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1243:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1244:     }
                   1245:     $result .= "</select>\n";
1.1450    raeburn  1246:     if ($haslabel) {
                   1247:         $result .= '</label>';
                   1248:     }
1.1400    raeburn  1249:     my %select2;
                   1250:     if (ref($hashref->{$firstdefault}) eq 'HASH') {
                   1251:         if (ref($hashref->{$firstdefault}->{'select2'}) eq 'HASH') {
                   1252:             %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1253:         }
                   1254:     }
1.1450    raeburn  1255:     if ($middletext ne '') {
1.1452    raeburn  1256:         $result .= '<label>'.$middletext;
1.1450    raeburn  1257:     }
1.1115    raeburn  1258:     $result .= "<select size=\"1\" name=\"$secondselectname\"";
                   1259:     if ($onchangesecond) {
                   1260:         $result .= ' onchange="'.$onchangesecond.'"';
                   1261:     }
                   1262:     $result .= ">\n";
1.36      matthew  1263:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1264:     
                   1265:     my @secondorder = sort(keys(%select2));
                   1266:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1267:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1268:     }
                   1269:     foreach my $value (@secondorder) {
1.36      matthew  1270:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1271:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1272:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1273:     }
                   1274:     $result .= "</select>\n";
1.1450    raeburn  1275:     if ($middletext ne '') {
                   1276:         $result .= '</label>';
                   1277:     }
1.36      matthew  1278:     #    return $debug;
                   1279:     return $result;
                   1280: }   #  end of sub linked_select_forms {
                   1281: 
1.45      matthew  1282: =pod
1.44      bowersj2 1283: 
1.1381    raeburn  1284: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid,$links_target)
1.44      bowersj2 1285: 
1.112     bowersj2 1286: Returns a string corresponding to an HTML link to the given help
                   1287: $topic, where $topic corresponds to the name of a .tex file in
                   1288: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1289: spaces. 
                   1290: 
                   1291: $text will optionally be linked to the same topic, allowing you to
                   1292: link text in addition to the graphic. If you do not want to link
                   1293: text, but wish to specify one of the later parameters, pass an
                   1294: empty string. 
                   1295: 
                   1296: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1297: the link will not open a new window. If false, the link will open
                   1298: a new window using Javascript. (Default is false.) 
                   1299: 
                   1300: $width and $height are optional numerical parameters that will
                   1301: override the width and height of the popped up window, which may
1.973     raeburn  1302: be useful for certain help topics with big pictures included.
                   1303: 
                   1304: $imgid is the id of the img tag used for the help icon. This may be
                   1305: used in a javascript call to switch the image src.  See 
                   1306: lonhtmlcommon::htmlareaselectactive() for an example.
1.44      bowersj2 1307: 
1.1381    raeburn  1308: $links_target will optionally be set to a target (_top, _parent or _self).
                   1309: 
1.44      bowersj2 1310: =cut
                   1311: 
                   1312: sub help_open_topic {
1.1381    raeburn  1313:     my ($topic, $text, $stayOnPage, $width, $height, $imgid, $links_target) = @_;
1.48      bowersj2 1314:     $text = "" if (not defined $text);
1.44      bowersj2 1315:     $stayOnPage = 0 if (not defined $stayOnPage);
1.1033    www      1316:     $width = 500 if (not defined $width);
1.44      bowersj2 1317:     $height = 400 if (not defined $height);
                   1318:     my $filename = $topic;
                   1319:     $filename =~ s/ /_/g;
                   1320: 
1.48      bowersj2 1321:     my $template = "";
                   1322:     my $link;
1.572     banghart 1323:     
1.159     www      1324:     $topic=~s/\W/\_/g;
1.44      bowersj2 1325: 
1.572     banghart 1326:     if (!$stayOnPage) {
1.1033    www      1327: 	$link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037    www      1328:     } elsif ($stayOnPage eq 'popup') {
                   1329:         $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 1330:     } else {
1.48      bowersj2 1331: 	$link = "/adm/help/${filename}.hlp";
                   1332:     }
                   1333: 
                   1334:     # Add the text
1.1314    raeburn  1335:     my $target = ' target="_top"';
1.1381    raeburn  1336:     if ($links_target) {
                   1337:         $target = ' target="'.$links_target.'"';
                   1338:     } elsif ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
                   1339:              (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
                   1340:         $target = '';
1.1378    raeburn  1341:     }
1.1380    raeburn  1342:     if ($text ne "") {
1.763     bisitz   1343: 	$template.='<span class="LC_help_open_topic">'
1.1314    raeburn  1344:                   .'<a'.$target.' href="'.$link.'">'
1.763     bisitz   1345:                   .$text.'</a>';
1.48      bowersj2 1346:     }
                   1347: 
1.763     bisitz   1348:     # (Always) Add the graphic
1.179     matthew  1349:     my $title = &mt('Online Help');
1.667     raeburn  1350:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973     raeburn  1351:     if ($imgid ne '') {
                   1352:         $imgid = ' id="'.$imgid.'"';
                   1353:     }
1.1314    raeburn  1354:     $template.=' <a'.$target.' href="'.$link.'" title="'.$title.'">'
1.763     bisitz   1355:               .'<img src="'.$helpicon.'" border="0"'
1.1469    raeburn  1356:               .' alt="'.&mt('Help icon').'"'
1.973     raeburn  1357:               .' title="'.$title.'" style="vertical-align:middle;"'.$imgid 
1.763     bisitz   1358:               .' /></a>';
                   1359:     if ($text ne "") {	
                   1360:         $template.='</span>';
                   1361:     }
1.44      bowersj2 1362:     return $template;
                   1363: 
1.106     bowersj2 1364: }
                   1365: 
                   1366: # This is a quicky function for Latex cheatsheet editing, since it 
                   1367: # appears in at least four places
                   1368: sub helpLatexCheatsheet {
1.1037    www      1369:     my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732     raeburn  1370:     my $out;
1.106     bowersj2 1371:     my $addOther = '';
1.732     raeburn  1372:     if ($topic) {
1.1037    www      1373: 	$addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763     bisitz   1374:     }
                   1375:     $out = '<span>' # Start cheatsheet
                   1376: 	  .$addOther
                   1377:           .'<span>'
1.1037    www      1378: 	  .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1379: 	  .'</span> <span>'
1.1037    www      1380: 	  .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1381: 	  .'</span>';
1.732     raeburn  1382:     unless ($not_author) {
1.1186    kruse    1383:         $out .= '<span>'
                   1384:                .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
                   1385:                .'</span> <span>'
1.1424    raeburn  1386:                .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.763     bisitz   1387: 	       .'</span>';
1.732     raeburn  1388:     }
1.763     bisitz   1389:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1390:     return $out;
1.172     www      1391: }
                   1392: 
1.430     albertel 1393: sub general_help {
                   1394:     my $helptopic='Student_Intro';
                   1395:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1396: 	$helptopic='Authoring_Intro';
1.907     raeburn  1397:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1398: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1399:     } elsif ($env{'request.role'}=~/^dc/) {
                   1400:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1401:     }
                   1402:     return $helptopic;
                   1403: }
                   1404: 
                   1405: sub update_help_link {
                   1406:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1407:     my $origurl = $ENV{'REQUEST_URI'};
                   1408:     $origurl=~s|^/~|/priv/|;
                   1409:     my $timestamp = time;
                   1410:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1411:         $$datum = &escape($$datum);
                   1412:     }
                   1413: 
                   1414:     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";
                   1415:     my $output .= <<"ENDOUTPUT";
                   1416: <script type="text/javascript">
1.824     bisitz   1417: // <![CDATA[
1.430     albertel 1418: banner_link = '$banner_link';
1.824     bisitz   1419: // ]]>
1.430     albertel 1420: </script>
                   1421: ENDOUTPUT
                   1422:     return $output;
                   1423: }
                   1424: 
                   1425: # now just updates the help link and generates a blue icon
1.193     raeburn  1426: sub help_open_menu {
1.1381    raeburn  1427:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text,$links_target) 
1.552     banghart 1428: 	= @_;    
1.949     droeschl 1429:     $stayOnPage = 1;
1.430     albertel 1430:     my $output;
                   1431:     if ($component_help) {
                   1432: 	if (!$text) {
                   1433: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
1.1381    raeburn  1434: 				       $width,$height,'',$links_target);
1.430     albertel 1435: 	} else {
                   1436: 	    my $help_text;
                   1437: 	    $help_text=&unescape($topic);
                   1438: 	    $output='<table><tr><td>'.
                   1439: 		&help_open_topic($component_help,$help_text,$stayOnPage,
1.1381    raeburn  1440: 				 $width,$height,'',$links_target).'</td></tr></table>';
1.430     albertel 1441: 	}
                   1442:     }
                   1443:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1444:     return $output.$banner_link;
                   1445: }
                   1446: 
                   1447: sub top_nav_help {
1.1369    raeburn  1448:     my ($text,$linkattr) = @_;
1.436     albertel 1449:     $text = &mt($text);
1.949     droeschl 1450:     my $stay_on_page = 1;
                   1451: 
1.1168    raeburn  1452:     my ($link,$banner_link);
                   1453:     unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
                   1454:         $link = ($stay_on_page) ? "javascript:helpMenu('display')"
                   1455: 	                         : "javascript:helpMenu('open')";
                   1456:         $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
                   1457:     }
1.201     raeburn  1458:     my $title = &mt('Get help');
1.1168    raeburn  1459:     if ($link) {
                   1460:         return <<"END";
1.436     albertel 1461: $banner_link
1.1369    raeburn  1462: <a href="$link" title="$title" $linkattr>$text</a>
1.436     albertel 1463: END
1.1168    raeburn  1464:     } else {
1.1459    raeburn  1465:         return '&nbsp;<h1 class="LC_helpmenu">'.$text.'</h1>&nbsp;';
1.1168    raeburn  1466:     }
1.436     albertel 1467: }
                   1468: 
                   1469: sub help_menu_js {
1.1154    raeburn  1470:     my ($httphost) = @_;
1.949     droeschl 1471:     my $stayOnPage = 1;
1.436     albertel 1472:     my $width = 620;
                   1473:     my $height = 600;
1.430     albertel 1474:     my $helptopic=&general_help();
1.1154    raeburn  1475:     my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1476:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.1459    raeburn  1477:     my $bannertitle = &mt('Help Menu');
                   1478:     &js_escape(\$bannertitle);
                   1479:     my $bodytitle = &mt('Documentation');
                   1480:     &js_escape(\$bodytitle);
1.331     albertel 1481:     my $start_page =
                   1482:         &Apache::loncommon::start_page('Help Menu', undef,
                   1483: 				       {'frameset'    => 1,
                   1484: 					'js_ready'    => 1,
1.1154    raeburn  1485:                                         'use_absolute' => $httphost,
1.331     albertel 1486: 					'add_entries' => {
1.1168    raeburn  1487: 					    'border' => '0', 
1.579     raeburn  1488: 					    'rows'   => "110,*",},});
1.331     albertel 1489:     my $end_page =
                   1490:         &Apache::loncommon::end_page({'frameset' => 1,
                   1491: 				      'js_ready' => 1,});
1.436     albertel 1492:     my $template .= <<"ENDTEMPLATE";
                   1493: <script type="text/javascript">
1.877     bisitz   1494: // <![CDATA[
1.253     albertel 1495: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1496: var banner_link = '';
1.243     raeburn  1497: function helpMenu(target) {
                   1498:     var caller = this;
                   1499:     if (target == 'open') {
                   1500:         var newWindow = null;
                   1501:         try {
1.262     albertel 1502:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1503:         }
                   1504:         catch(error) {
                   1505:             writeHelp(caller);
                   1506:             return;
                   1507:         }
                   1508:         if (newWindow) {
                   1509:             caller = newWindow;
                   1510:         }
1.193     raeburn  1511:     }
1.243     raeburn  1512:     writeHelp(caller);
                   1513:     return;
                   1514: }
                   1515: function writeHelp(caller) {
1.1459    raeburn  1516:     caller.document.writeln('$start_page\\n<frame name="bannerframe" title="$bannertitle" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
                   1517:     caller.document.writeln('<frame name="bodyframe" title="$bodytitle" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
1.1168    raeburn  1518:     caller.document.close();
                   1519:     caller.focus();
1.193     raeburn  1520: }
1.877     bisitz   1521: // END LON-CAPA Internal -->
1.253     albertel 1522: // ]]>
1.436     albertel 1523: </script>
1.193     raeburn  1524: ENDTEMPLATE
                   1525:     return $template;
                   1526: }
                   1527: 
1.172     www      1528: sub help_open_bug {
                   1529:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1530:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1531:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1532:     $text = "" if (not defined $text);
                   1533: 	$stayOnPage=1;
1.184     albertel 1534:     $width = 600 if (not defined $width);
                   1535:     $height = 600 if (not defined $height);
1.172     www      1536: 
                   1537:     $topic=~s/\W+/\+/g;
                   1538:     my $link='';
                   1539:     my $template='';
1.379     albertel 1540:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1541: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1542:     if (!$stayOnPage)
                   1543:     {
                   1544: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1545:     }
                   1546:     else
                   1547:     {
                   1548: 	$link = $url;
                   1549:     }
1.1314    raeburn  1550: 
1.1382    raeburn  1551:     my $target = '_top';
                   1552:     if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
                   1553:         (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
                   1554:         $target = '_blank';
1.1378    raeburn  1555:     }
1.1382    raeburn  1556: 
1.172     www      1557:     # Add the text
                   1558:     if ($text ne "")
                   1559:     {
                   1560: 	$template .= 
                   1561:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.1382    raeburn  1562:   "<td bgcolor='#FF5555'><a target=\"$target\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1563:     }
                   1564: 
                   1565:     # Add the graphic
1.179     matthew  1566:     my $title = &mt('Report a Bug');
1.215     albertel 1567:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1568:     $template .= <<"ENDTEMPLATE";
1.1382    raeburn  1569:  <a target="$target" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1570: ENDTEMPLATE
                   1571:     if ($text ne '') { $template.='</td></tr></table>' };
                   1572:     return $template;
                   1573: 
                   1574: }
                   1575: 
                   1576: sub help_open_faq {
                   1577:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1578:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1579:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1580:     $text = "" if (not defined $text);
                   1581: 	$stayOnPage=1;
                   1582:     $width = 350 if (not defined $width);
                   1583:     $height = 400 if (not defined $height);
                   1584: 
                   1585:     $topic=~s/\W+/\+/g;
                   1586:     my $link='';
                   1587:     my $template='';
                   1588:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1589:     if (!$stayOnPage)
                   1590:     {
                   1591: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1592:     }
                   1593:     else
                   1594:     {
                   1595: 	$link = $url;
                   1596:     }
                   1597: 
                   1598:     # Add the text
                   1599:     if ($text ne "")
                   1600:     {
                   1601: 	$template .= 
1.173     www      1602:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1603:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1604:     }
                   1605: 
                   1606:     # Add the graphic
1.179     matthew  1607:     my $title = &mt('View the FAQ');
1.215     albertel 1608:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1609:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1610:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1611: ENDTEMPLATE
                   1612:     if ($text ne '') { $template.='</td></tr></table>' };
                   1613:     return $template;
                   1614: 
1.44      bowersj2 1615: }
1.37      matthew  1616: 
1.180     matthew  1617: ###############################################################
                   1618: ###############################################################
                   1619: 
1.45      matthew  1620: =pod
                   1621: 
1.648     raeburn  1622: =item * &change_content_javascript():
1.256     matthew  1623: 
                   1624: This and the next function allow you to create small sections of an
                   1625: otherwise static HTML page that you can update on the fly with
                   1626: Javascript, even in Netscape 4.
                   1627: 
                   1628: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1629: must be written to the HTML page once. It will prove the Javascript
                   1630: function "change(name, content)". Calling the change function with the
                   1631: name of the section 
                   1632: you want to update, matching the name passed to C<changable_area>, and
                   1633: the new content you want to put in there, will put the content into
                   1634: that area.
                   1635: 
                   1636: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1637: to contain room for the original contents. You need to "make space"
                   1638: for whatever changes you wish to make, and be B<sure> to check your
                   1639: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1640: it's adequate for updating a one-line status display, but little more.
                   1641: This script will set the space to 100% width, so you only need to
                   1642: worry about height in Netscape 4.
                   1643: 
                   1644: Modern browsers are much less limiting, and if you can commit to the
                   1645: user not using Netscape 4, this feature may be used freely with
                   1646: pretty much any HTML.
                   1647: 
                   1648: =cut
                   1649: 
                   1650: sub change_content_javascript {
                   1651:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1652:     if ($env{'browser.type'} eq 'netscape' &&
                   1653: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1654: 	return (<<NETSCAPE4);
                   1655: 	function change(name, content) {
                   1656: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1657: 	    doc.open();
                   1658: 	    doc.write(content);
                   1659: 	    doc.close();
                   1660: 	}
                   1661: NETSCAPE4
                   1662:     } else {
                   1663: 	# Otherwise, we need to use semi-standards-compliant code
                   1664: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1665: 	# is really scary, and every useful browser supports it
                   1666: 	return (<<DOMBASED);
                   1667: 	function change(name, content) {
                   1668: 	    element = document.getElementById(name);
                   1669: 	    element.innerHTML = content;
                   1670: 	}
                   1671: DOMBASED
                   1672:     }
                   1673: }
                   1674: 
                   1675: =pod
                   1676: 
1.648     raeburn  1677: =item * &changable_area($name,$origContent):
1.256     matthew  1678: 
                   1679: This provides a "changable area" that can be modified on the fly via
                   1680: the Javascript code provided in C<change_content_javascript>. $name is
                   1681: the name you will use to reference the area later; do not repeat the
                   1682: same name on a given HTML page more then once. $origContent is what
                   1683: the area will originally contain, which can be left blank.
                   1684: 
                   1685: =cut
                   1686: 
                   1687: sub changable_area {
                   1688:     my ($name, $origContent) = @_;
                   1689: 
1.258     albertel 1690:     if ($env{'browser.type'} eq 'netscape' &&
                   1691: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1692: 	# If this is netscape 4, we need to use the Layer tag
                   1693: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1694:     } else {
                   1695: 	return "<span id='$name'>$origContent</span>";
                   1696:     }
                   1697: }
                   1698: 
                   1699: =pod
                   1700: 
1.648     raeburn  1701: =item * &viewport_geometry_js 
1.590     raeburn  1702: 
                   1703: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1704: 
                   1705: =cut
                   1706: 
                   1707: 
                   1708: sub viewport_geometry_js { 
                   1709:     return <<"GEOMETRY";
                   1710: var Geometry = {};
                   1711: function init_geometry() {
                   1712:     if (Geometry.init) { return };
                   1713:     Geometry.init=1;
                   1714:     if (window.innerHeight) {
                   1715:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1716:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1717:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1718:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1719:     }
                   1720:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1721:         Geometry.getViewportHeight =
                   1722:             function() { return document.documentElement.clientHeight; };
                   1723:         Geometry.getViewportWidth =
                   1724:             function() { return document.documentElement.clientWidth; };
                   1725: 
                   1726:         Geometry.getHorizontalScroll =
                   1727:             function() { return document.documentElement.scrollLeft; };
                   1728:         Geometry.getVerticalScroll =
                   1729:             function() { return document.documentElement.scrollTop; };
                   1730:     }
                   1731:     else if (document.body.clientHeight) {
                   1732:         Geometry.getViewportHeight =
                   1733:             function() { return document.body.clientHeight; };
                   1734:         Geometry.getViewportWidth =
                   1735:             function() { return document.body.clientWidth; };
                   1736:         Geometry.getHorizontalScroll =
                   1737:             function() { return document.body.scrollLeft; };
                   1738:         Geometry.getVerticalScroll =
                   1739:             function() { return document.body.scrollTop; };
                   1740:     }
                   1741: }
                   1742: 
                   1743: GEOMETRY
                   1744: }
                   1745: 
                   1746: =pod
                   1747: 
1.648     raeburn  1748: =item * &viewport_size_js()
1.590     raeburn  1749: 
                   1750: 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. 
                   1751: 
                   1752: =cut
                   1753: 
                   1754: sub viewport_size_js {
                   1755:     my $geometry = &viewport_geometry_js();
                   1756:     return <<"DIMS";
                   1757: 
                   1758: $geometry
                   1759: 
                   1760: function getViewportDims(width,height) {
                   1761:     init_geometry();
                   1762:     width.value = Geometry.getViewportWidth();
                   1763:     height.value = Geometry.getViewportHeight();
                   1764:     return;
                   1765: }
                   1766: 
                   1767: DIMS
                   1768: }
                   1769: 
                   1770: =pod
                   1771: 
1.648     raeburn  1772: =item * &resize_textarea_js()
1.565     albertel 1773: 
                   1774: emits the needed javascript to resize a textarea to be as big as possible
                   1775: 
                   1776: creates a function resize_textrea that takes two IDs first should be
                   1777: the id of the element to resize, second should be the id of a div that
                   1778: surrounds everything that comes after the textarea, this routine needs
                   1779: to be attached to the <body> for the onload and onresize events.
                   1780: 
                   1781: =cut
                   1782: 
                   1783: sub resize_textarea_js {
1.590     raeburn  1784:     my $geometry = &viewport_geometry_js();
1.565     albertel 1785:     return <<"RESIZE";
                   1786:     <script type="text/javascript">
1.824     bisitz   1787: // <![CDATA[
1.590     raeburn  1788: $geometry
1.565     albertel 1789: 
1.588     albertel 1790: function getX(element) {
                   1791:     var x = 0;
                   1792:     while (element) {
                   1793: 	x += element.offsetLeft;
                   1794: 	element = element.offsetParent;
                   1795:     }
                   1796:     return x;
                   1797: }
                   1798: function getY(element) {
                   1799:     var y = 0;
                   1800:     while (element) {
                   1801: 	y += element.offsetTop;
                   1802: 	element = element.offsetParent;
                   1803:     }
                   1804:     return y;
                   1805: }
                   1806: 
                   1807: 
1.565     albertel 1808: function resize_textarea(textarea_id,bottom_id) {
                   1809:     init_geometry();
                   1810:     var textarea        = document.getElementById(textarea_id);
                   1811:     //alert(textarea);
                   1812: 
1.588     albertel 1813:     var textarea_top    = getY(textarea);
1.565     albertel 1814:     var textarea_height = textarea.offsetHeight;
                   1815:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1816:     var bottom_top      = getY(bottom);
1.565     albertel 1817:     var bottom_height   = bottom.offsetHeight;
                   1818:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1819:     var fudge           = 23;
1.565     albertel 1820:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1821:     if (new_height < 300) {
                   1822: 	new_height = 300;
                   1823:     }
                   1824:     textarea.style.height=new_height+'px';
                   1825: }
1.824     bisitz   1826: // ]]>
1.565     albertel 1827: </script>
                   1828: RESIZE
                   1829: 
                   1830: }
                   1831: 
1.1205    golterma 1832: sub colorfuleditor_js {
1.1248    raeburn  1833:     my $browse_or_search;
                   1834:     my $respath;
                   1835:     my ($cnum,$cdom) = &crsauthor_url();
                   1836:     if ($cnum) {
                   1837:         $respath = "/res/$cdom/$cnum/";
                   1838:         my %js_lt = &Apache::lonlocal::texthash(
                   1839:             sunm => 'Sub-directory name',
                   1840:             save => 'Save page to make this permanent',
                   1841:         );
                   1842:         &js_escape(\%js_lt);
1.1400    raeburn  1843:         my $showfile_js = &show_crsfiles_js();
1.1248    raeburn  1844:         $browse_or_search = <<"END";
                   1845: 
1.1400    raeburn  1846:     $showfile_js
                   1847: 
1.1248    raeburn  1848:     function toggleChooser(form,element,titleid,only,search) {
                   1849:         var disp = 'none';
                   1850:         if (document.getElementById('chooser_'+element)) {
                   1851:             var curr = document.getElementById('chooser_'+element).style.display;
                   1852:             if (curr == 'none') {
                   1853:                 disp='inline';
                   1854:                 if (form.elements['chooser_'+element].length) {
                   1855:                     for (var i=0; i<form.elements['chooser_'+element].length; i++) {
                   1856:                         form.elements['chooser_'+element][i].checked = false;
                   1857:                     }
                   1858:                 }
                   1859:                 toggleResImport(form,element);
                   1860:             }
                   1861:             document.getElementById('chooser_'+element).style.display = disp;
1.1400    raeburn  1862:             var dirsel = '';
                   1863:             var filesel = '';
                   1864:             if (document.getElementById('chooser_'+element+'_crsres')) {
                   1865:                 var currcrsres = document.getElementById('chooser_'+element+'_crsres').style.display;
                   1866:                 if (currcrsres == 'none') {
                   1867:                     dirsel = 'coursepath_'+element;
                   1868:                     var filesel = 'coursefile_'+element;
                   1869:                     var include;
                   1870:                     if (document.getElementById('crsres_include_'+element)) {
                   1871:                         include = document.getElementById('crsres_include_'+element).value;
                   1872:                     }
1.1402    raeburn  1873:                     populateCrsSelects(form,dirsel,filesel,1,include,1,0,1,1,0);
1.1400    raeburn  1874:                 }
                   1875:             }
                   1876:             if (document.getElementById('chooser_'+element+'_upload')) {
                   1877:                 var currcrsupload = document.getElementById('chooser_'+element+'_upload').style.display;
                   1878:                 if (currcrsupload == 'none') {
                   1879:                     dirsel = 'crsauthorpath_'+element;
                   1880:                     filesel = '';
1.1402    raeburn  1881:                     populateCrsSelects(form,dirsel,filesel,0,'',1,0,1,0,1);
1.1400    raeburn  1882:                 }
                   1883:             }
1.1248    raeburn  1884:         }
                   1885:     }
                   1886: 
1.1400    raeburn  1887:     function toggleCrsFile(form,element) {
1.1248    raeburn  1888:         if (document.getElementById('chooser_'+element+'_crsres')) {
                   1889:             var curr = document.getElementById('chooser_'+element+'_crsres').style.display;
                   1890:             if (curr == 'none') {
1.1400    raeburn  1891:                 if (document.getElementById('coursepath_'+element)) {
                   1892:                     var numdirs;
                   1893:                     if (document.getElementById('coursepath_'+element).length) {
                   1894:                         numdirs = document.getElementById('coursepath_'+element).length;
                   1895:                     }
1.1402    raeburn  1896:                     if ((document.getElementById('hascrsres_'+element)) &&
                   1897:                         (document.getElementById('nocrsres_'+element))) {
                   1898:                         if (numdirs) {
                   1899:                             document.getElementById('hascrsres_'+element).style.display='inline-block';
                   1900:                             document.getElementById('nocrsres_'+element).style.display='none';
                   1901:                         } else {
                   1902:                             document.getElementById('hascrsres_'+element).style.display='none';
                   1903:                             document.getElementById('nocrsres_'+element).style.display='inline-block';
                   1904:                         }
                   1905:                     }
1.1248    raeburn  1906:                     form.elements['coursepath_'+element].selectedIndex = 0;
                   1907:                     if (numdirs > 1) {
1.1400    raeburn  1908:                         var selelem = form.elements['coursefile_'+element];
                   1909:                         var i, len = selelem.options.length -1;
                   1910:                         if (len >=0) {
                   1911:                             for (i = len; i >= 0; i--) {
                   1912:                                 selelem.remove(i);
                   1913:                             }
                   1914:                             selelem.options[0] = new Option('','');
                   1915:                         }
1.1248    raeburn  1916:                     }
                   1917:                 }
1.1400    raeburn  1918:             }
1.1248    raeburn  1919:             document.getElementById('chooser_'+element+'_crsres').style.display = 'block';
                   1920:         }
                   1921:         if (document.getElementById('chooser_'+element+'_upload')) {
                   1922:             document.getElementById('chooser_'+element+'_upload').style.display = 'none';
                   1923:             if (document.getElementById('uploadcrsres_'+element)) {
                   1924:                 document.getElementById('uploadcrsres_'+element).value = '';
                   1925:             }
                   1926:         }
                   1927:         return;
                   1928:     }
                   1929: 
1.1400    raeburn  1930:     function toggleCrsUpload(form,element) {
1.1248    raeburn  1931:         if (document.getElementById('chooser_'+element+'_crsres')) {
                   1932:             document.getElementById('chooser_'+element+'_crsres').style.display = 'none';
                   1933:         }
                   1934:         if (document.getElementById('chooser_'+element+'_upload')) {
                   1935:             var curr = document.getElementById('chooser_'+element+'_upload').style.display;
                   1936:             if (curr == 'none') {
1.1400    raeburn  1937:                 form.elements['newsubdir_'+element][0].checked = true;
                   1938:                 toggleNewsubdir(form,element);
                   1939:                 document.getElementById('chooser_'+element+'_upload').style.display = 'block';
                   1940:                 if (document.getElementById('uploadcrsres_'+element)) {
                   1941:                     document.getElementById('uploadcrsres_'+element).value = '';
1.1248    raeburn  1942:                 }
                   1943:             }
                   1944:         }
                   1945:         return;
                   1946:     }
                   1947: 
                   1948:     function toggleResImport(form,element) {
                   1949:         var choices = new Array('crsres','upload');
                   1950:         for (var i=0; i<choices.length; i++) {
                   1951:             if (document.getElementById('chooser_'+element+'_'+choices[i])) {
                   1952:                 document.getElementById('chooser_'+element+'_'+choices[i]).style.display = 'none';
                   1953:             }
                   1954:         }
                   1955:     }
                   1956: 
                   1957:     function toggleNewsubdir(form,element) {
                   1958:         var newsub = form.elements['newsubdir_'+element];
                   1959:         if (newsub) {
                   1960:             if (newsub.length) {
                   1961:                 for (var j=0; j<newsub.length; j++) {
                   1962:                     if (newsub[j].checked) {
                   1963:                         if (document.getElementById('newsubdirname_'+element)) {
                   1964:                             if (newsub[j].value == '1') {
                   1965:                                 document.getElementById('newsubdirname_'+element).type = "text";
                   1966:                                 if (document.getElementById('newsubdir_'+element)) {
                   1967:                                     document.getElementById('newsubdir_'+element).innerHTML = '<br />$js_lt{sunm}';
                   1968:                                 }
                   1969:                             } else {
                   1970:                                 document.getElementById('newsubdirname_'+element).type = "hidden";
                   1971:                                 document.getElementById('newsubdirname_'+element).value = "";
                   1972:                                 document.getElementById('newsubdir_'+element).innerHTML = "";
                   1973:                             }
                   1974:                         }
                   1975:                         break; 
                   1976:                     }
                   1977:                 }
                   1978:             }
                   1979:         }
                   1980:     }
                   1981: 
                   1982:     function updateCrsFile(form,element) {
                   1983:         var directory = form.elements['coursepath_'+element];
                   1984:         var filename = form.elements['coursefile_'+element];
                   1985:         var path = directory.options[directory.selectedIndex].value;
                   1986:         var file = filename.options[filename.selectedIndex].value;
1.1400    raeburn  1987:         if (file != '') {
                   1988:             form.elements[element].value = '$respath';
                   1989:             if (path == '/') {
                   1990:                 form.elements[element].value += file;
                   1991:             } else {
                   1992:                 form.elements[element].value += path+'/'+file;
                   1993:             }
                   1994:             unClean();
                   1995:             if (document.getElementById('previewimg_'+element)) {
                   1996:                 document.getElementById('previewimg_'+element).src = form.elements[element].value;
                   1997:                 var newsrc = document.getElementById('previewimg_'+element).src; 
                   1998:             }
                   1999:             if (document.getElementById('showimg_'+element)) {
                   2000:                 document.getElementById('showimg_'+element).innerHTML = '($js_lt{save})';
                   2001:             }
1.1248    raeburn  2002:         }
                   2003:         toggleChooser(form,element);
                   2004:         return;
                   2005:     }
                   2006: 
                   2007:     function uploadDone(suffix,name) {
                   2008:         if (name) {
                   2009: 	    document.forms["lonhomework"].elements[suffix].value = name;
                   2010:             unClean();
                   2011:             toggleChooser(document.forms["lonhomework"],suffix);
                   2012:         }
                   2013:     }
                   2014: 
                   2015: \$(document).ready(function(){
                   2016: 
                   2017:     \$(document).delegate('form :submit', 'click', function( event ) {
                   2018:         if ( \$( this ).hasClass( "LC_uploadcrsres" ) ) {
                   2019:             var buttonId = this.id;
                   2020:             var suffix = buttonId.toString();
                   2021:             suffix = suffix.replace(/^crsupload_/,'');
                   2022:             event.preventDefault();
                   2023:             document.lonhomework.target = 'crsupload_target_'+suffix;
                   2024:             document.lonhomework.action = '/adm/coursepub?LC_uploadcrsres='+suffix;
                   2025:             \$(this.form).submit();
                   2026:             document.lonhomework.target = '';
                   2027:             if (document.getElementById('crsuploadto_'+suffix)) {
                   2028:                 document.lonhomework.action = document.getElementById('crsuploadto_'+suffix).value;
                   2029:             }
                   2030:             return false;
                   2031:         }
                   2032:     });
                   2033: });
                   2034: END
                   2035:     }
1.1205    golterma 2036:     return <<"COLORFULEDIT"
                   2037: <script type="text/javascript">
                   2038: // <![CDATA[>
                   2039:     function fold_box(curDepth, lastresource){
                   2040: 
                   2041:     // we need a list because there can be several blocks you need to fold in one tag
                   2042:         var block = document.getElementsByName('foldblock_'+curDepth);
                   2043:     // but there is only one folding button per tag
                   2044:         var foldbutton = document.getElementById('folding_btn_'+curDepth);
                   2045: 
                   2046:         if(block.item(0).style.display == 'none'){
                   2047: 
                   2048:             foldbutton.value = '@{[&mt("Hide")]}';
                   2049:             for (i = 0; i < block.length; i++){
                   2050:                 block.item(i).style.display = '';
                   2051:             }
                   2052:         }else{
                   2053: 
                   2054:             foldbutton.value = '@{[&mt("Show")]}';
                   2055:             for (i = 0; i < block.length; i++){
                   2056:                 // block.item(i).style.visibility = 'collapse';
                   2057:                 block.item(i).style.display = 'none';
                   2058:             }
                   2059:         };
                   2060:         saveState(lastresource);
                   2061:     }
                   2062: 
                   2063:     function saveState (lastresource) {
                   2064: 
                   2065:         var tag_list = getTagList();
                   2066:         if(tag_list != null){
                   2067:             var timestamp = new Date().getTime();
                   2068:             var key = lastresource;
                   2069: 
                   2070:             // the value pattern is: 'time;key1,value1;key2,value2; ... '
                   2071:             // starting with timestamp
                   2072:             var value = timestamp+';';
                   2073: 
                   2074:             // building the list of key-value pairs
                   2075:             for(var i = 0; i < tag_list.length; i++){
                   2076:                 value += tag_list[i]+',';
                   2077:                 value += document.getElementsByName(tag_list[i])[0].style.display+';';
                   2078:             }
                   2079: 
                   2080:             // only iterate whole storage if nothing to override
                   2081:             if(localStorage.getItem(key) == null){        
                   2082: 
                   2083:                 // prevent storage from growing large
                   2084:                 if(localStorage.length > 50){
                   2085:                     var regex_getTimestamp = /^(?:\d)+;/;
                   2086:                     var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
                   2087:                     var oldest_key;
                   2088:                     
                   2089:                     for(var i = 1; i < localStorage.length; i++){
                   2090:                         if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
                   2091:                             oldest_key = localStorage.key(i);
                   2092:                             oldest_timestamp = regex_getTimestamp.exec(oldest_key);
                   2093:                         }
                   2094:                     }
                   2095:                     localStorage.removeItem(oldest_key);
                   2096:                 }
                   2097:             }
                   2098:             localStorage.setItem(key,value);
                   2099:         }
                   2100:     }
                   2101: 
                   2102:     // restore folding status of blocks (on page load)
                   2103:     function restoreState (lastresource) {
                   2104:         if(localStorage.getItem(lastresource) != null){
                   2105:             var key = lastresource;
                   2106:             var value = localStorage.getItem(key);
                   2107:             var regex_delTimestamp = /^\d+;/;
                   2108: 
                   2109:             value.replace(regex_delTimestamp, '');
                   2110: 
                   2111:             var valueArr = value.split(';');
                   2112:             var pairs;
                   2113:             var elements;
                   2114:             for (var i = 0; i < valueArr.length; i++){
                   2115:                 pairs = valueArr[i].split(',');
                   2116:                 elements = document.getElementsByName(pairs[0]);
                   2117: 
                   2118:                 for (var j = 0; j < elements.length; j++){  
                   2119:                     elements[j].style.display = pairs[1];
                   2120:                     if (pairs[1] == "none"){
                   2121:                         var regex_id = /([_\\d]+)\$/;
                   2122:                         regex_id.exec(pairs[0]);
                   2123:                         document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
                   2124:                     }
                   2125:                 }
                   2126:             }
                   2127:         }
                   2128:     }
                   2129: 
                   2130:     function getTagList () {
                   2131:         
                   2132:         var stringToSearch = document.lonhomework.innerHTML;
                   2133: 
                   2134:         var ret = new Array();
                   2135:         var regex_findBlock = /(foldblock_.*?)"/g;
                   2136:         var tag_list = stringToSearch.match(regex_findBlock);
                   2137: 
                   2138:         if(tag_list != null){
                   2139:             for(var i = 0; i < tag_list.length; i++){            
                   2140:                 ret.push(tag_list[i].replace(/"/, ''));
                   2141:             }
                   2142:         }
                   2143:         return ret;
                   2144:     }
                   2145: 
                   2146:     function saveScrollPosition (resource) {
                   2147:         var tag_list = getTagList();
                   2148: 
                   2149:         // we dont always want to jump to the first block
                   2150:         // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
                   2151:         if(\$(window).scrollTop() > 170){
                   2152:             if(tag_list != null){
                   2153:                 var result;
                   2154:                 for(var i = 0; i < tag_list.length; i++){
                   2155:                     if(isElementInViewport(tag_list[i])){
                   2156:                         result += tag_list[i]+';';
                   2157:                     }
                   2158:                 }
                   2159:                 sessionStorage.setItem('anchor_'+resource, result);
                   2160:             }
                   2161:         } else {
                   2162:             // we dont need to save zero, just delete the item to leave everything tidy
                   2163:             sessionStorage.removeItem('anchor_'+resource);
                   2164:         }
                   2165:     }
                   2166: 
                   2167:     function restoreScrollPosition(resource){
                   2168: 
                   2169:         var elem = sessionStorage.getItem('anchor_'+resource);
                   2170:         if(elem != null){
                   2171:             var tag_list = elem.split(';');
                   2172:             var elem_list;
                   2173: 
                   2174:             for(var i = 0; i < tag_list.length; i++){
                   2175:                 elem_list = document.getElementsByName(tag_list[i]);
                   2176:                 
                   2177:                 if(elem_list.length > 0){
                   2178:                     elem = elem_list[0];
                   2179:                     break;
                   2180:                 }
                   2181:             }
                   2182:             elem.scrollIntoView();
                   2183:         }
                   2184:     }
                   2185: 
                   2186:     function isElementInViewport(el) {
                   2187: 
                   2188:         // change to last element instead of first
                   2189:         var elem = document.getElementsByName(el);
                   2190:         var rect = elem[0].getBoundingClientRect();
                   2191: 
                   2192:         return (
                   2193:             rect.top >= 0 &&
                   2194:             rect.left >= 0 &&
                   2195:             rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
                   2196:             rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
                   2197:         );
                   2198:     }
                   2199:     
                   2200:     function autosize(depth){
                   2201:         var cmInst = window['cm'+depth];
                   2202:         var fitsizeButton = document.getElementById('fitsize'+depth);
                   2203: 
                   2204:         // is fixed size, switching to dynamic
                   2205:         if (sessionStorage.getItem("autosized_"+depth) == null) {
                   2206:             cmInst.setSize("","auto");
                   2207:             fitsizeButton.value = "@{[&mt('Fixed size')]}";
                   2208:             sessionStorage.setItem("autosized_"+depth, "yes");
                   2209: 
                   2210:         // is dynamic size, switching to fixed
                   2211:         } else {
                   2212:             cmInst.setSize("","300px");
                   2213:             fitsizeButton.value = "@{[&mt('Dynamic size')]}";
                   2214:             sessionStorage.removeItem("autosized_"+depth);
                   2215:         }
                   2216:     }
                   2217: 
1.1248    raeburn  2218: $browse_or_search
1.1205    golterma 2219: 
                   2220: // ]]>
                   2221: </script>
                   2222: COLORFULEDIT
                   2223: }
                   2224: 
                   2225: sub xmleditor_js {
                   2226:     return <<XMLEDIT
                   2227: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
                   2228: <script type="text/javascript">
                   2229: // <![CDATA[>
                   2230: 
                   2231:     function saveScrollPosition (resource) {
                   2232: 
                   2233:         var scrollPos = \$(window).scrollTop();
                   2234:         sessionStorage.setItem(resource,scrollPos);
                   2235:     }
                   2236: 
                   2237:     function restoreScrollPosition(resource){
                   2238: 
                   2239:         var scrollPos = sessionStorage.getItem(resource);
                   2240:         \$(window).scrollTop(scrollPos);
                   2241:     }
                   2242: 
                   2243:     // unless internet explorer
                   2244:     if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
                   2245: 
                   2246:         \$(document).ready(function() {
                   2247:              \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
                   2248:         });
                   2249:     }
                   2250: 
                   2251:     // inserts text at cursor position into codemirror (xml editor only)
                   2252:     function insertText(text){
                   2253:         cm.focus();
                   2254:         var curPos = cm.getCursor();
                   2255:         cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
                   2256:     }
                   2257: // ]]>
                   2258: </script>
                   2259: XMLEDIT
                   2260: }
                   2261: 
                   2262: sub insert_folding_button {
                   2263:     my $curDepth = $Apache::lonxml::curdepth;
                   2264:     my $lastresource = $env{'request.ambiguous'};
                   2265: 
                   2266:     return "<input type=\"button\" id=\"folding_btn_$curDepth\" 
                   2267:             value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
                   2268: }
                   2269: 
1.1248    raeburn  2270: sub crsauthor_url {
                   2271:     my ($url) = @_;
                   2272:     if ($url eq '') {
                   2273:         $url = $ENV{'REQUEST_URI'};
                   2274:     }
                   2275:     my ($cnum,$cdom);
                   2276:     if ($env{'request.course.id'}) {
                   2277:         my ($audom,$auname) = ($url =~ m{^/priv/($match_domain)/($match_name)/});
                   2278:         if ($audom ne '' && $auname ne '') {
                   2279:             if (($env{'course.'.$env{'request.course.id'}.'.num'} eq $auname) &&
                   2280:                 ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $audom)) {
                   2281:                 $cnum = $auname;
                   2282:                 $cdom = $audom;
                   2283:             }
                   2284:         }
                   2285:     }
                   2286:     return ($cnum,$cdom);
                   2287: }
                   2288: 
                   2289: sub import_crsauthor_form {
1.1400    raeburn  2290:     my ($firstselectname,$secondselectname,$onchangefirst,$only,$suffix,$disabled) = @_;
1.1248    raeburn  2291:     return (0) unless ($env{'request.course.id'});
                   2292:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   2293:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   2294:     my $crshome = $env{'course.'.$env{'request.course.id'}.'.home'};
                   2295:     return (0) unless (($cnum ne '') && ($cdom ne ''));
                   2296:     my @ids=&Apache::lonnet::current_machine_ids();
1.1400    raeburn  2297:     my ($output,$is_home,$toppath,%subdirs,%files,%selimport_menus,$include,$exclude);
1.1402    raeburn  2298: 
1.1248    raeburn  2299:     if (grep(/^\Q$crshome\E$/,@ids)) {
                   2300:         $is_home = 1;
                   2301:     }
1.1400    raeburn  2302:     $toppath = "/priv/$cdom/$cnum";
                   2303:     my $nonemptydir = 1;
                   2304:     my $js_only;
                   2305:     if ($only) {
                   2306:         map { $include->{$_} = 1; } split(/\s*,\s*/,$only);
                   2307:         $js_only = join(',',map { &js_escape($_); } sort(keys(%{$include})));
                   2308:     }
                   2309:     $exclude = &Apache::lonnet::priv_exclude();
1.1402    raeburn  2310:     &Apache::lonnet::recursedirs($is_home,1,$include,$exclude,1,0,$toppath,'',\%subdirs,\%files);
1.1400    raeburn  2311:     my $numdirs = scalar(keys(%files));
1.1248    raeburn  2312:     my %lt = &Apache::lonlocal::texthash (
                   2313:         fnam => 'Filename',
                   2314:         dire => 'Directory',
1.1400    raeburn  2315:         se   => 'Select',
1.1248    raeburn  2316:     );
1.1450    raeburn  2317:     $output = '<label>'.$lt{'dire'}.':&nbsp;'.
1.1400    raeburn  2318:               '<select id="'.$firstselectname.'" name="'.$firstselectname.'" '.
1.1402    raeburn  2319:               'onchange="populateCrsSelects(this.form,'."'$firstselectname','$secondselectname',1,'$js_only',0,1,0,0,0".');">'.
1.1400    raeburn  2320:               '<option value="" selected="selected">'.$lt{'se'}.'</option>';
1.1402    raeburn  2321:     if ($files{'/'}) {
                   2322:         $output .= '<option value="/">/</option>'."\n";
                   2323:     }
1.1400    raeburn  2324:     foreach my $key (sort { lc($a) cmp lc($b) } (keys(%files))) {
1.1402    raeburn  2325:         next if ($key eq '/');
1.1400    raeburn  2326:         $output .= '<option value="'.$key.'">'.$key.'</option>'."\n";
                   2327:     }
1.1450    raeburn  2328:     $output .= '</select></label><br /><label>'."\n".
1.1402    raeburn  2329:                $lt{'fnam'}.':&nbsp;<select id="'.$secondselectname.'" name="'.$secondselectname.'">'."\n".
1.1400    raeburn  2330:                '<option value="" selected="selected"></option>'."\n".
1.1450    raeburn  2331:                '</select></label>'."\n".
1.1402    raeburn  2332:                '<input type="hidden" id="crsres_include_'.$suffix.'" value="'.$only.'" />';
1.1400    raeburn  2333:     return ($numdirs,$output);
                   2334: }
                   2335: 
                   2336: sub show_crsfiles_js {
                   2337:     my $excluderef = &Apache::lonnet::priv_exclude();
                   2338:     my $se = &js_escape(&mt('Select'));
                   2339:     my $exclude;
                   2340:     if (ref($excluderef) eq 'HASH') {
                   2341:         $exclude = join(',', map { &js_escape($_); } sort(keys(%{$excluderef})));
                   2342:     }
                   2343:     my $js = <<"END";
                   2344: 
                   2345: 
1.1402    raeburn  2346:     function populateCrsSelects (form,dirsel,filesel,exc,include,setdir,setfile,recurse,nonemptydir,addtopdir) {
1.1400    raeburn  2347:         var relpath = '';
                   2348:         if ((setfile) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
                   2349:             var currdir = form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value;
                   2350:             if (currdir == '') {
                   2351:                 if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
                   2352:                     selelem = form.elements[filesel];
                   2353:                     var j, numfiles = selelem.options.length -1;
                   2354:                     if (numfiles >=0) {
                   2355:                         for (j = numfiles; j >= 0; j--) {
                   2356:                             selelem.remove(j);
                   2357:                         }
                   2358:                     }
                   2359:                     if (selelem.options.length == 0) {
                   2360:                         selelem.options[selelem.options.length] = new Option('','');
                   2361:                         selelem.selectedIndex = 0;
1.1248    raeburn  2362:                     }
                   2363:                 }
1.1400    raeburn  2364:                 return;
                   2365:             } else {
                   2366:                 relpath = encodeURIComponent(form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value);
1.1248    raeburn  2367:             }
                   2368:         }
1.1400    raeburn  2369:         var http = new XMLHttpRequest();
                   2370:         var url = "/adm/courseauthor";
                   2371:         var crsrole = "$env{'request.role'}";
                   2372:         var exclude = '';
                   2373:         if (exc) {
                   2374:             exclude = '$exclude';
                   2375:         }
1.1402    raeburn  2376:         var params = "role=course&files=1&rec="+recurse+"&nonempty="+nonemptydir+"&exc="+exclude+"&inc="+include+"&addtop="+addtopdir+"&path="+relpath;
1.1400    raeburn  2377:         http.open("POST", url, true);
                   2378:         http.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
                   2379:         http.onreadystatechange = function() {
                   2380:             if (http.readyState == 4 && http.status == 200) {
                   2381:                 var data = JSON.parse(http.responseText);
                   2382:                 var selelem;
                   2383:                 if ((setdir) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
                   2384:                     if (Array.isArray(data.dirs)) {
                   2385:                         selelem = form.elements[dirsel];
                   2386:                         var i, numdirs = selelem.options.length -1;
                   2387:                         if (numdirs >=0) {
                   2388:                             for (i = numdirs; i >= 0; i--) {
                   2389:                                 selelem.remove(i);
                   2390:                             }
                   2391:                         }
                   2392:                         var len = data.dirs.length;
                   2393:                         if (len) {
1.1402    raeburn  2394:                             selelem.options[selelem.options.length] = new Option('$se','');
1.1400    raeburn  2395:                             var j;
                   2396:                             for (j = 0; j < len; j++) {
                   2397:                                 selelem.options[selelem.options.length] = new Option(data.dirs[j],data.dirs[j]);
                   2398:                             }
                   2399:                             selelem.selectedIndex = 0;
                   2400:                         }
                   2401:                         if (!setfile) {
                   2402:                             if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
                   2403:                                 selelem = form.elements[filesel];
                   2404:                                 var j, numfiles = selelem.options.length -1;
                   2405:                                 if (numfiles >=0) {
                   2406:                                     for (j = numfiles; j >= 0; j--) {
                   2407:                                         selelem.remove(j);
                   2408:                                     }
                   2409:                                 }
                   2410:                                 if (selelem.options.length == 0) {
                   2411:                                     selelem.options[selelem.options.length] = new Option('','');
                   2412:                                     selelem.selectedIndex = 0;
                   2413:                                 }
                   2414:                             }
                   2415:                         }
                   2416:                     }
                   2417:                 }
                   2418:                 if ((setfile) && (filesel != null) && (filesel != 'undefined') && (filesel != '')) {
                   2419:                     selelem = form.elements[filesel];
                   2420:                     var i, numfiles = selelem.options.length -1;
                   2421:                     if (numfiles >=0) {
                   2422:                         for (i = numfiles; i >= 0; i--) {
                   2423:                             selelem.remove(i);
                   2424:                         }
                   2425:                     }
                   2426:                     var x;
                   2427:                     for (x in data.files) {
                   2428:                         if (Array.isArray(data.files[x])) {
                   2429:                             if (data.files[x].length > 1) {
                   2430:                                 selelem.options[selelem.options.length] = new Option('$se','');
                   2431:                             }
                   2432:                             var len = data.files[x].length;
                   2433:                             if (len) {
                   2434:                                 var k;
                   2435:                                 for (k = 0; k < len; k++) {
                   2436:                                     selelem.options[selelem.options.length] = new Option(data.files[x][k],data.files[x][k]);
                   2437:                                 }
                   2438:                                 selelem.selectedIndex = 0;
                   2439:                             }
                   2440:                         }
                   2441:                     }
                   2442:                     if (selelem.options.length == 0) {
                   2443:                         selelem.options[selelem.options.length] = new Option('','');
                   2444:                         selelem.selectedIndex = 0;
                   2445:                     }
1.1248    raeburn  2446:                 }
                   2447:             }
                   2448:         }
1.1400    raeburn  2449:         http.send(params);
1.1248    raeburn  2450:     }
1.1400    raeburn  2451: END
1.1248    raeburn  2452: }
                   2453: 
1.1426    raeburn  2454: sub crsauthor_rights {
                   2455:     my ($rightsfile,$path,$docroot,$cnum,$cdom) = @_;
                   2456:     my $sourcerights = "$path/$rightsfile";
                   2457:     my $now = time;
                   2458:     if (!-e $sourcerights) {
                   2459:         my $cid = $cdom.'_'.$cnum;
                   2460:         if (!-e "$docroot/priv/$cdom") {
                   2461:             mkdir("$docroot/priv/$cdom",0755);
                   2462:         }
                   2463:         if (!-e "$docroot/priv/$cdom/$cnum") {
                   2464:             mkdir("$docroot/priv/$cdom/$cnum",0755);
                   2465:         }
                   2466:         if (open(my $fh,">$sourcerights")) {
                   2467:             print $fh <<END;
                   2468: <accessrule effect="deny" realm="" type="course" role="" />
                   2469: <accessrule effect="allow" realm="$cid" type="course" role="" />
                   2470: END
                   2471:             close($fh);
                   2472:         }
                   2473:     }
                   2474:     if (!-e "$sourcerights.meta") {
                   2475:         if (open(my $fh,">$sourcerights.meta")) {
                   2476:             my $author=$env{'environment.firstname'}.' '.
                   2477:                        $env{'environment.middlename'}.' '.
                   2478:                        $env{'environment.lastname'}.' '.
                   2479:                        $env{'environment.generation'};
                   2480:             $author =~ s/\s+$//;
                   2481:             print $fh <<"END";
                   2482: 
                   2483: <abstract></abstract>
                   2484: <author>$author</author>
                   2485: <authorspace>$cnum:$cdom</authorspace>
                   2486: <copyright>private</copyright>
                   2487: <creationdate>$now</creationdate>
                   2488: <customdistributionfile></customdistributionfile>
                   2489: <dependencies></dependencies>
                   2490: <domain>$cdom</domain>
                   2491: <highestgradelevel>0</highestgradelevel>
                   2492: <keywords></keywords>
1.1445    raeburn  2493: <language>notset</language>
1.1426    raeburn  2494: <lastrevisiondate>$now</lastrevisiondate>
                   2495: <lowestgradelevel>0</lowestgradelevel>
                   2496: <mime>rights</mime>
                   2497: <modifyinguser>$env{'user.name'}:$env{'user.domain'}</modifyinguser>
                   2498: <notes></notes>
                   2499: <obsolete></obsolete>
                   2500: <obsoletereplacement></obsoletereplacement>
                   2501: <owner>$cnum:$cdom</owner>
                   2502: <rule>deny:::course,allow:$cid::course</rule>
                   2503: <sourceavail></sourceavail>
                   2504: <standards></standards>
                   2505: <subject></subject>
                   2506: <title>Course Authoring Rights</title>
                   2507: END
                   2508:             close($fh);
                   2509:         }
                   2510:     }
                   2511:     return;
                   2512: }
                   2513: 
1.565     albertel 2514: =pod
                   2515: 
1.1420    raeburn  2516: =item * &iframe_wrapper_headjs()
                   2517: 
1.1425    raeburn  2518: emits javascript containing two global vars to facilitate handling of resizing
                   2519: by code in iframe_wrapper_resizejs() used when an iframe is present in a page
                   2520: with standard LON-CAPA menus.
                   2521: 
                   2522: =cut
                   2523: 
1.1420    raeburn  2524: #
                   2525: # Where iframe is in use, if window.onload() executes before the custom resize function
                   2526: # has been defined (jQuery), two global javascript vars (LCnotready and LCresizedef)
                   2527: # are used to ensure document.ready() triggers a call to resize, so the iframe contents
                   2528: # do not obscure the Functions menu.
                   2529: #
                   2530: 
                   2531: sub iframe_wrapper_headjs {
                   2532:     return <<"ENDJS";
                   2533: <script type="text/javascript">
                   2534: // <![CDATA[
                   2535: var LCnotready = 0;
                   2536: var LCresizedef = 0;
                   2537: // ]]>
                   2538: </script>
                   2539: 
                   2540: ENDJS
                   2541: 
                   2542: }
                   2543: 
                   2544: =pod
                   2545: 
                   2546: =item * &iframe_wrapper_resizejs()
                   2547: 
1.1425    raeburn  2548: emits javascript used to handle resizing for a page containing
                   2549: an iframe, to ensure that the iframe does not obscure any
                   2550: standard LON-CAPA menu items.
                   2551: 
                   2552: =back
                   2553: 
                   2554: =cut
                   2555: 
1.1420    raeburn  2556: #
                   2557: # jQuery to use when iframe is in use and a page resize occurs.
                   2558: # This script will ensure that the iframe does not obscure any
                   2559: # standard LON-CAPA inline menus (primary, secondary, and/or
                   2560: # breadcrumbs and Functions menus. Expects javascript from
                   2561: # &iframe_wrapper_headjs() to be in head portion of the web page,
                   2562: # e.g., by inclusion in second arg passed to &start_page().
                   2563: #
                   2564: 
                   2565: sub iframe_wrapper_resizejs {
                   2566:     my $offset = 5;
                   2567:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
                   2568:     if (($env{'form.inhibitmenu'} eq 'yes') || ($env{'form.only_body'})) {
                   2569:         $offset = 0;
                   2570:     }
                   2571:     return &Apache::lonhtmlcommon::scripttag(<<SCRIPT);
                   2572:     \$(document).ready( function() {
                   2573:         \$(window).unbind('resize').resize(function(){
                   2574:             var header = null;
                   2575:             var offset = $offset;
                   2576:             var height = 0;
                   2577:             var hdrtop = 0;
1.1421    raeburn  2578:             if (\$('div.LC_menus_content:first').length) {
                   2579:                 if (\$('div.LC_menus_content:first').hasClass ("shown")) {
                   2580:                     header = \$('div.LC_menus_content:first');
1.1423    raeburn  2581:                     offset = 12;
1.1421    raeburn  2582:                 }
                   2583:             } else if (\$('div.LC_head_subbox:first').length) {
1.1420    raeburn  2584:                 header = \$('div.LC_head_subbox:first');
                   2585:                 offset = 9;
                   2586:             } else {
                   2587:                 if (\$('#LC_breadcrumbs').length) {
                   2588:                     header = \$('#LC_breadcrumbs');
                   2589:                 }
                   2590:             }
                   2591:             if (header != null && header.length) {
                   2592:                 height = header.height();
                   2593:                 hdrtop = header.position().top;
                   2594:             }
                   2595:             var pos = height + hdrtop + offset;
                   2596:             \$('.LC_iframecontainer').css('top', pos);
                   2597:         });
                   2598:         LCresizedef = 1;
                   2599:         if (LCnotready == 1) {
                   2600:             LCnotready = 0;
                   2601:             \$(window).trigger('resize');
                   2602:         }
                   2603:     });
                   2604:     window.onload = function(){
                   2605:          if (LCresizedef) {
                   2606:              LCnotready = 0;
                   2607:              \$(window).trigger('resize');
                   2608:          } else {
                   2609:              LCnotready = 1;
                   2610:          }
                   2611:     };
                   2612: SCRIPT
                   2613: 
                   2614: }
                   2615: 
                   2616: =pod
                   2617: 
1.256     matthew  2618: =head1 Excel and CSV file utility routines
                   2619: 
                   2620: =cut
                   2621: 
                   2622: ###############################################################
                   2623: ###############################################################
                   2624: 
                   2625: =pod
                   2626: 
1.1162    raeburn  2627: =over 4
                   2628: 
1.648     raeburn  2629: =item * &csv_translate($text) 
1.37      matthew  2630: 
1.185     www      2631: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  2632: format.
                   2633: 
                   2634: =cut
                   2635: 
1.180     matthew  2636: ###############################################################
                   2637: ###############################################################
1.37      matthew  2638: sub csv_translate {
                   2639:     my $text = shift;
                   2640:     $text =~ s/\"/\"\"/g;
1.209     albertel 2641:     $text =~ s/\n/ /g;
1.37      matthew  2642:     return $text;
                   2643: }
1.180     matthew  2644: 
                   2645: ###############################################################
                   2646: ###############################################################
                   2647: 
                   2648: =pod
                   2649: 
1.648     raeburn  2650: =item * &define_excel_formats()
1.180     matthew  2651: 
                   2652: Define some commonly used Excel cell formats.
                   2653: 
                   2654: Currently supported formats:
                   2655: 
                   2656: =over 4
                   2657: 
                   2658: =item header
                   2659: 
                   2660: =item bold
                   2661: 
                   2662: =item h1
                   2663: 
                   2664: =item h2
                   2665: 
                   2666: =item h3
                   2667: 
1.256     matthew  2668: =item h4
                   2669: 
                   2670: =item i
                   2671: 
1.180     matthew  2672: =item date
                   2673: 
                   2674: =back
                   2675: 
                   2676: Inputs: $workbook
                   2677: 
                   2678: Returns: $format, a hash reference.
                   2679: 
1.1057    foxr     2680: 
1.180     matthew  2681: =cut
                   2682: 
                   2683: ###############################################################
                   2684: ###############################################################
                   2685: sub define_excel_formats {
                   2686:     my ($workbook) = @_;
                   2687:     my $format;
                   2688:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   2689:                                                 bottom    => 1,
                   2690:                                                 align     => 'center');
                   2691:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   2692:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   2693:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   2694:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  2695:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  2696:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  2697:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  2698:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  2699:     return $format;
                   2700: }
                   2701: 
                   2702: ###############################################################
                   2703: ###############################################################
1.113     bowersj2 2704: 
                   2705: =pod
                   2706: 
1.648     raeburn  2707: =item * &create_workbook()
1.255     matthew  2708: 
                   2709: Create an Excel worksheet.  If it fails, output message on the
                   2710: request object and return undefs.
                   2711: 
                   2712: Inputs: Apache request object
                   2713: 
                   2714: Returns (undef) on failure, 
                   2715:     Excel worksheet object, scalar with filename, and formats 
                   2716:     from &Apache::loncommon::define_excel_formats on success
                   2717: 
                   2718: =cut
                   2719: 
                   2720: ###############################################################
                   2721: ###############################################################
                   2722: sub create_workbook {
                   2723:     my ($r) = @_;
                   2724:         #
                   2725:     # Create the excel spreadsheet
                   2726:     my $filename = '/prtspool/'.
1.258     albertel 2727:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  2728:         time.'_'.rand(1000000000).'.xls';
                   2729:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   2730:     if (! defined($workbook)) {
                   2731:         $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928     bisitz   2732:         $r->print(
                   2733:             '<p class="LC_error">'
                   2734:            .&mt('Problems occurred in creating the new Excel file.')
                   2735:            .' '.&mt('This error has been logged.')
                   2736:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2737:            .'</p>'
                   2738:         );
1.255     matthew  2739:         return (undef);
                   2740:     }
                   2741:     #
1.1014    foxr     2742:     $workbook->set_tempdir(LONCAPA::tempdir());
1.255     matthew  2743:     #
                   2744:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   2745:     return ($workbook,$filename,$format);
                   2746: }
                   2747: 
                   2748: ###############################################################
                   2749: ###############################################################
                   2750: 
                   2751: =pod
                   2752: 
1.648     raeburn  2753: =item * &create_text_file()
1.113     bowersj2 2754: 
1.542     raeburn  2755: Create a file to write to and eventually make available to the user.
1.256     matthew  2756: If file creation fails, outputs an error message on the request object and 
                   2757: return undefs.
1.113     bowersj2 2758: 
1.256     matthew  2759: Inputs: Apache request object, and file suffix
1.113     bowersj2 2760: 
1.256     matthew  2761: Returns (undef) on failure, 
                   2762:     Filehandle and filename on success.
1.113     bowersj2 2763: 
                   2764: =cut
                   2765: 
1.256     matthew  2766: ###############################################################
                   2767: ###############################################################
                   2768: sub create_text_file {
                   2769:     my ($r,$suffix) = @_;
                   2770:     if (! defined($suffix)) { $suffix = 'txt'; };
                   2771:     my $fh;
                   2772:     my $filename = '/prtspool/'.
1.258     albertel 2773:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  2774:         time.'_'.rand(1000000000).'.'.$suffix;
                   2775:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   2776:     if (! defined($fh)) {
                   2777:         $r->log_error("Couldn't open $filename for output $!");
1.928     bisitz   2778:         $r->print(
                   2779:             '<p class="LC_error">'
                   2780:            .&mt('Problems occurred in creating the output file.')
                   2781:            .' '.&mt('This error has been logged.')
                   2782:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2783:            .'</p>'
                   2784:         );
1.113     bowersj2 2785:     }
1.256     matthew  2786:     return ($fh,$filename)
1.113     bowersj2 2787: }
                   2788: 
                   2789: 
1.256     matthew  2790: =pod 
1.113     bowersj2 2791: 
                   2792: =back
                   2793: 
                   2794: =cut
1.37      matthew  2795: 
                   2796: ###############################################################
1.33      matthew  2797: ##        Home server <option> list generating code          ##
                   2798: ###############################################################
1.35      matthew  2799: 
1.169     www      2800: # ------------------------------------------
                   2801: 
                   2802: sub domain_select {
1.1471    raeburn  2803:     my ($name,$value,$multiple,$incdoms,$excdoms,$id)=@_;
1.1289    raeburn  2804:     my @possdoms;
                   2805:     if (ref($incdoms) eq 'ARRAY') {
                   2806:         @possdoms = @{$incdoms};
                   2807:     } else {
                   2808:         @possdoms = &Apache::lonnet::all_domains();
                   2809:     }
                   2810: 
1.169     www      2811:     my %domains=map { 
1.514     albertel 2812: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.1289    raeburn  2813:     } @possdoms;
                   2814: 
                   2815:     if ((ref($excdoms) eq 'ARRAY') && (@{$excdoms} > 0)) {
                   2816:         foreach my $dom (@{$excdoms}) {
                   2817:             delete($domains{$dom});
                   2818:         }
                   2819:     }
                   2820: 
1.169     www      2821:     if ($multiple) {
                   2822: 	$domains{''}=&mt('Any domain');
1.550     albertel 2823: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.1471    raeburn  2824: 	return &multiple_select_form($name,$value,4,\%domains,undef,$id);
1.169     www      2825:     } else {
1.550     albertel 2826: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.1471    raeburn  2827: 	return &select_form($name,$value,\%domains,'','',$id);
1.169     www      2828:     }
                   2829: }
                   2830: 
1.282     albertel 2831: #-------------------------------------------
                   2832: 
                   2833: =pod
                   2834: 
1.519     raeburn  2835: =head1 Routines for form select boxes
                   2836: 
                   2837: =over 4
                   2838: 
1.1471    raeburn  2839: =item * &multiple_select_form($name,$value,$size,$hash,$order,$id)
1.282     albertel 2840: 
                   2841: Returns a string containing a <select> element int multiple mode
                   2842: 
                   2843: 
                   2844: Args:
                   2845:   $name - name of the <select> element
1.506     raeburn  2846:   $value - scalar or array ref of values that should already be selected
1.282     albertel 2847:   $size - number of rows long the select element is
1.283     albertel 2848:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 2849:           (shown text should already have been &mt())
1.506     raeburn  2850:   $order - (optional) array ref of the order to show the elements in
1.1472    raeburn  2851:   $id = (optional) id for <select> element
1.283     albertel 2852: 
1.282     albertel 2853: =cut
                   2854: 
                   2855: #-------------------------------------------
1.169     www      2856: sub multiple_select_form {
1.1471    raeburn  2857:     my ($name,$value,$size,$hash,$order,$id)=@_;
1.169     www      2858:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   2859:     my $output='';
1.191     matthew  2860:     if (! defined($size)) {
                   2861:         $size = 4;
1.283     albertel 2862:         if (scalar(keys(%$hash))<4) {
                   2863:             $size = scalar(keys(%$hash));
1.191     matthew  2864:         }
                   2865:     }
1.1471    raeburn  2866:     if ($id ne '') {
                   2867:         $id = ' id="'.$id.'"'; 
                   2868:     }
                   2869:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple"'.$id.'>';
1.501     banghart 2870:     my @order;
1.506     raeburn  2871:     if (ref($order) eq 'ARRAY')  {
                   2872:         @order = @{$order};
                   2873:     } else {
                   2874:         @order = sort(keys(%$hash));
1.501     banghart 2875:     }
                   2876:     if (exists($$hash{'select_form_order'})) {
                   2877:         @order = @{$$hash{'select_form_order'}};
                   2878:     }
                   2879:         
1.284     albertel 2880:     foreach my $key (@order) {
1.356     albertel 2881:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 2882:         $output.='selected="selected" ' if ($selected{$key});
                   2883:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      2884:     }
                   2885:     $output.="</select>\n";
                   2886:     return $output;
                   2887: }
                   2888: 
1.88      www      2889: #-------------------------------------------
                   2890: 
                   2891: =pod
                   2892: 
1.1472    raeburn  2893: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly,$id,$aria_labelledby)
1.88      www      2894: 
                   2895: Returns a string containing a <select name='$name' size='1'> form to 
1.970     raeburn  2896: allow a user to select options from a ref to a hash containing:
                   2897: option_name => displayed text. An optional $onchange can include
1.1254    raeburn  2898: a javascript onchange item, e.g., onchange="this.form.submit();".
                   2899: An optional arg -- $readonly -- if true will cause the select form
                   2900: to be disabled, e.g., for the case where an instructor has a section-
1.1471    raeburn  2901: specific role, and is viewing/modifying parameters. An optional arg
1.1472    raeburn  2902: -- $id -- will be used as the id attribute of the select element. An
                   2903: optional arg -- $aria_labelledby -- will be included as the aria-labelledby
                   2904: attribute of the select element.
1.970     raeburn  2905: 
1.88      www      2906: See lonrights.pm for an example invocation and use.
                   2907: 
                   2908: =cut
                   2909: 
                   2910: #-------------------------------------------
                   2911: sub select_form {
1.1472    raeburn  2912:     my ($def,$name,$hashref,$onchange,$readonly,$id,$aria_labelledby) = @_;
1.970     raeburn  2913:     return unless (ref($hashref) eq 'HASH');
                   2914:     if ($onchange) {
                   2915:         $onchange = ' onchange="'.$onchange.'"';
                   2916:     }
1.1228    raeburn  2917:     my $disabled;
                   2918:     if ($readonly) {
                   2919:         $disabled = ' disabled="disabled"';
                   2920:     }
1.1471    raeburn  2921:     if ($id ne '') {
                   2922:         $id = ' id="'.$id.'"';
                   2923:     }
1.1472    raeburn  2924:     if ($aria_labelledby ne '') {
                   2925:         $aria_labelledby = ' aria-labelledby="'.$aria_labelledby.'"';
                   2926:     }
                   2927:     my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled$id$aria_labelledby>\n";
1.128     albertel 2928:     my @keys;
1.970     raeburn  2929:     if (exists($hashref->{'select_form_order'})) {
                   2930: 	@keys=@{$hashref->{'select_form_order'}};
1.128     albertel 2931:     } else {
1.970     raeburn  2932: 	@keys=sort(keys(%{$hashref}));
1.128     albertel 2933:     }
1.356     albertel 2934:     foreach my $key (@keys) {
                   2935:         $selectform.=
                   2936: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   2937:             ($key eq $def ? 'selected="selected" ' : '').
1.970     raeburn  2938:                 ">".$hashref->{$key}."</option>\n";
1.88      www      2939:     }
                   2940:     $selectform.="</select>";
                   2941:     return $selectform;
                   2942: }
                   2943: 
1.475     www      2944: # For display filters
                   2945: 
                   2946: sub display_filter {
1.1074    raeburn  2947:     my ($context) = @_;
1.475     www      2948:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      2949:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074    raeburn  2950:     my $phraseinput = 'hidden';
                   2951:     my $includeinput = 'hidden';
                   2952:     my ($checked,$includetypestext);
                   2953:     if ($env{'form.displayfilter'} eq 'containing') {
                   2954:         $phraseinput = 'text'; 
                   2955:         if ($context eq 'parmslog') {
                   2956:             $includeinput = 'checkbox';
                   2957:             if ($env{'form.includetypes'}) {
                   2958:                 $checked = ' checked="checked"';
                   2959:             }
                   2960:             $includetypestext = &mt('Include parameter types');
                   2961:         }
                   2962:     } else {
                   2963:         $includetypestext = '&nbsp;';
                   2964:     }
                   2965:     my ($additional,$secondid,$thirdid);
                   2966:     if ($context eq 'parmslog') {
                   2967:         $additional = 
                   2968:             '<label><input type="'.$includeinput.'" name="includetypes"'. 
                   2969:             $checked.' name="includetypes" value="1" id="includetypes" />'.
                   2970:             '&nbsp;<span id="includetypestext">'.$includetypestext.'</span>'.
                   2971:             '</label>';
                   2972:         $secondid = 'includetypes';
                   2973:         $thirdid = 'includetypestext';
                   2974:     }
                   2975:     my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
                   2976:                                                     '$secondid','$thirdid')";
                   2977:     return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.1471    raeburn  2978: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},'','',undef,
1.475     www      2979: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   2980: 	   '</label></span> <span class="LC_nobreak">'.
1.1074    raeburn  2981:            &mt('Filter: [_1]',
1.477     www      2982: 	   &select_form($env{'form.displayfilter'},
                   2983: 			'displayfilter',
1.970     raeburn  2984: 			{'currentfolder' => 'Current folder/page',
1.477     www      2985: 			 'containing' => 'Containing phrase',
1.1074    raeburn  2986: 			 'none' => 'None'},$onchange)).'&nbsp;'.
                   2987: 			 '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
                   2988:                          &HTML::Entities::encode($env{'form.containingphrase'}).
                   2989:                          '" />'.$additional;
                   2990: }
                   2991: 
                   2992: sub display_filter_js {
                   2993:     my $includetext = &mt('Include parameter types');
                   2994:     return <<"ENDJS";
                   2995:   
                   2996: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
                   2997:     var firstType = 'hidden';
                   2998:     if (setter.options[setter.selectedIndex].value == 'containing') {
                   2999:         firstType = 'text';
                   3000:     }
                   3001:     firstObject = document.getElementById(firstid);
                   3002:     if (typeof(firstObject) == 'object') {
                   3003:         if (firstObject.type != firstType) {
                   3004:             changeInputType(firstObject,firstType);
                   3005:         }
                   3006:     }
                   3007:     if (context == 'parmslog') {
                   3008:         var secondType = 'hidden';
                   3009:         if (firstType == 'text') {
                   3010:             secondType = 'checkbox';
                   3011:         }
                   3012:         secondObject = document.getElementById(secondid);  
                   3013:         if (typeof(secondObject) == 'object') {
                   3014:             if (secondObject.type != secondType) {
                   3015:                 changeInputType(secondObject,secondType);
                   3016:             }
                   3017:         }
                   3018:         var textItem = document.getElementById(thirdid);
                   3019:         var currtext = textItem.innerHTML;
                   3020:         var newtext;
                   3021:         if (firstType == 'text') {
                   3022:             newtext = '$includetext';
                   3023:         } else {
                   3024:             newtext = '&nbsp;';
                   3025:         }
                   3026:         if (currtext != newtext) {
                   3027:             textItem.innerHTML = newtext;
                   3028:         }
                   3029:     }
                   3030:     return;
                   3031: }
                   3032: 
                   3033: function changeInputType(oldObject,newType) {
                   3034:     var newObject = document.createElement('input');
                   3035:     newObject.type = newType;
                   3036:     if (oldObject.size) {
                   3037:         newObject.size = oldObject.size;
                   3038:     }
                   3039:     if (oldObject.value) {
                   3040:         newObject.value = oldObject.value;
                   3041:     }
                   3042:     if (oldObject.name) {
                   3043:         newObject.name = oldObject.name;
                   3044:     }
                   3045:     if (oldObject.id) {
                   3046:         newObject.id = oldObject.id;
                   3047:     }
                   3048:     oldObject.parentNode.replaceChild(newObject,oldObject);
                   3049:     return;
                   3050: }
                   3051: 
                   3052: ENDJS
1.475     www      3053: }
                   3054: 
1.167     www      3055: sub gradeleveldescription {
                   3056:     my $gradelevel=shift;
                   3057:     my %gradelevels=(0 => 'Not specified',
                   3058: 		     1 => 'Grade 1',
                   3059: 		     2 => 'Grade 2',
                   3060: 		     3 => 'Grade 3',
                   3061: 		     4 => 'Grade 4',
                   3062: 		     5 => 'Grade 5',
                   3063: 		     6 => 'Grade 6',
                   3064: 		     7 => 'Grade 7',
                   3065: 		     8 => 'Grade 8',
                   3066: 		     9 => 'Grade 9',
                   3067: 		     10 => 'Grade 10',
                   3068: 		     11 => 'Grade 11',
                   3069: 		     12 => 'Grade 12',
                   3070: 		     13 => 'Grade 13',
                   3071: 		     14 => '100 Level',
                   3072: 		     15 => '200 Level',
                   3073: 		     16 => '300 Level',
                   3074: 		     17 => '400 Level',
                   3075: 		     18 => 'Graduate Level');
                   3076:     return &mt($gradelevels{$gradelevel});
                   3077: }
                   3078: 
1.163     www      3079: sub select_level_form {
1.1471    raeburn  3080:     my ($deflevel,$name,$id)=@_;
                   3081:     if ($id ne '') {
                   3082:         $id = ' id="'.$id.'"';
                   3083:     }
1.163     www      3084:     unless ($deflevel) { $deflevel=0; }
1.1471    raeburn  3085:     my $selectform = "<select name=\"$name\" size=\"1\"$id>\n";
1.167     www      3086:     for (my $i=0; $i<=18; $i++) {
                   3087:         $selectform.="<option value=\"$i\" ".
1.253     albertel 3088:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      3089:                 ">".&gradeleveldescription($i)."</option>\n";
                   3090:     }
                   3091:     $selectform.="</select>";
                   3092:     return $selectform;
1.163     www      3093: }
1.167     www      3094: 
1.35      matthew  3095: #-------------------------------------------
                   3096: 
1.45      matthew  3097: =pod
                   3098: 
1.1453    raeburn  3099: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled,$id)
1.35      matthew  3100: 
                   3101: Returns a string containing a <select name='$name' size='1'> form to 
                   3102: allow a user to select the domain to preform an operation in.  
                   3103: See loncreateuser.pm for an example invocation and use.
                   3104: 
1.90      www      3105: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   3106: selected");
                   3107: 
1.743     raeburn  3108: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   3109: 
1.910     raeburn  3110: 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.
                   3111: 
1.1121    raeburn  3112: The optional $incdoms is a reference to an array of domains which will be the only available options.
                   3113: 
                   3114: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563     raeburn  3115: 
1.1256    raeburn  3116: The optional $disabled argument, if true, adds the disabled attribute to the select tag.
                   3117: 
1.1453    raeburn  3118: The option $id argument is the value (if any) to set as the (unique) id attribute for the select tag.
                   3119: 
1.35      matthew  3120: =cut
                   3121: 
                   3122: #-------------------------------------------
1.34      matthew  3123: sub select_dom_form {
1.1453    raeburn  3124:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled,$id) = @_;
1.872     raeburn  3125:     if ($onchange) {
1.874     raeburn  3126:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  3127:     }
1.1256    raeburn  3128:     if ($disabled) {
                   3129:         $disabled = ' disabled="disabled"';
                   3130:     }
1.1453    raeburn  3131:     if ($id ne '') {
                   3132:         $id = ' id="'.$id.'"';
                   3133:     }
1.1121    raeburn  3134:     my (@domains,%exclude);
1.910     raeburn  3135:     if (ref($incdoms) eq 'ARRAY') {
                   3136:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   3137:     } else {
                   3138:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   3139:     }
1.90      www      3140:     if ($includeempty) { @domains=('',@domains); }
1.1121    raeburn  3141:     if (ref($excdoms) eq 'ARRAY') {
                   3142:         map { $exclude{$_} = 1; } @{$excdoms}; 
                   3143:     }
1.1453    raeburn  3144:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled$id>\n";
1.356     albertel 3145:     foreach my $dom (@domains) {
1.1121    raeburn  3146:         next if ($exclude{$dom});
1.356     albertel 3147:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  3148:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   3149:         if ($showdomdesc) {
                   3150:             if ($dom ne '') {
                   3151:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   3152:                 if ($domdesc ne '') {
                   3153:                     $selectdomain .= ' ('.$domdesc.')';
                   3154:                 }
                   3155:             } 
                   3156:         }
                   3157:         $selectdomain .= "</option>\n";
1.34      matthew  3158:     }
                   3159:     $selectdomain.="</select>";
                   3160:     return $selectdomain;
                   3161: }
                   3162: 
1.35      matthew  3163: #-------------------------------------------
                   3164: 
1.45      matthew  3165: =pod
                   3166: 
1.648     raeburn  3167: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  3168: 
1.586     raeburn  3169: input: 4 arguments (two required, two optional) - 
                   3170:     $domain - domain of new user
                   3171:     $name - name of form element
                   3172:     $default - Value of 'default' causes a default item to be first 
                   3173:                             option, and selected by default. 
                   3174:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   3175:                             if 1 server found, or default, if 0 found.
1.594     raeburn  3176: output: returns 2 items: 
1.586     raeburn  3177: (a) form element which contains either:
                   3178:    (i) <select name="$name">
                   3179:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   3180:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   3181:        </select>
                   3182:        form item if there are multiple library servers in $domain, or
                   3183:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   3184:        if there is only one library server in $domain.
                   3185: 
                   3186: (b) number of library servers found.
                   3187: 
                   3188: See loncreateuser.pm for example of use.
1.35      matthew  3189: 
                   3190: =cut
                   3191: 
                   3192: #-------------------------------------------
1.586     raeburn  3193: sub home_server_form_item {
                   3194:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 3195:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  3196:     my $result;
                   3197:     my $numlib = keys(%servers);
                   3198:     if ($numlib > 1) {
                   3199:         $result .= '<select name="'.$name.'" />'."\n";
                   3200:         if ($default) {
1.804     bisitz   3201:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  3202:                        '</option>'."\n";
                   3203:         }
                   3204:         foreach my $hostid (sort(keys(%servers))) {
                   3205:             $result.= '<option value="'.$hostid.'">'.
                   3206: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   3207:         }
                   3208:         $result .= '</select>'."\n";
                   3209:     } elsif ($numlib == 1) {
                   3210:         my $hostid;
                   3211:         foreach my $item (keys(%servers)) {
                   3212:             $hostid = $item;
                   3213:         }
                   3214:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   3215:                    $hostid.'" />';
                   3216:                    if (!$hide) {
                   3217:                        $result .= $hostid.' '.$servers{$hostid};
                   3218:                    }
                   3219:                    $result .= "\n";
                   3220:     } elsif ($default) {
                   3221:         $result .= '<input type="hidden" name="'.$name.
                   3222:                    '" value="default" />';
                   3223:                    if (!$hide) {
                   3224:                        $result .= &mt('default');
                   3225:                    }
                   3226:                    $result .= "\n";
1.33      matthew  3227:     }
1.586     raeburn  3228:     return ($result,$numlib);
1.33      matthew  3229: }
1.112     bowersj2 3230: 
                   3231: =pod
                   3232: 
1.534     albertel 3233: =back 
                   3234: 
1.112     bowersj2 3235: =cut
1.87      matthew  3236: 
                   3237: ###############################################################
1.112     bowersj2 3238: ##                  Decoding User Agent                      ##
1.87      matthew  3239: ###############################################################
                   3240: 
                   3241: =pod
                   3242: 
1.112     bowersj2 3243: =head1 Decoding the User Agent
                   3244: 
                   3245: =over 4
                   3246: 
                   3247: =item * &decode_user_agent()
1.87      matthew  3248: 
                   3249: Inputs: $r
                   3250: 
                   3251: Outputs:
                   3252: 
                   3253: =over 4
                   3254: 
1.112     bowersj2 3255: =item * $httpbrowser
1.87      matthew  3256: 
1.112     bowersj2 3257: =item * $clientbrowser
1.87      matthew  3258: 
1.112     bowersj2 3259: =item * $clientversion
1.87      matthew  3260: 
1.112     bowersj2 3261: =item * $clientmathml
1.87      matthew  3262: 
1.112     bowersj2 3263: =item * $clientunicode
1.87      matthew  3264: 
1.112     bowersj2 3265: =item * $clientos
1.87      matthew  3266: 
1.1137    raeburn  3267: =item * $clientmobile
                   3268: 
1.1141    raeburn  3269: =item * $clientinfo
                   3270: 
1.1194    raeburn  3271: =item * $clientosversion
                   3272: 
1.87      matthew  3273: =back
                   3274: 
1.157     matthew  3275: =back 
                   3276: 
1.87      matthew  3277: =cut
                   3278: 
                   3279: ###############################################################
                   3280: ###############################################################
                   3281: sub decode_user_agent {
1.247     albertel 3282:     my ($r)=@_;
1.87      matthew  3283:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   3284:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   3285:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 3286:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  3287:     my $clientbrowser='unknown';
                   3288:     my $clientversion='0';
                   3289:     my $clientmathml='';
                   3290:     my $clientunicode='0';
1.1137    raeburn  3291:     my $clientmobile=0;
1.1194    raeburn  3292:     my $clientosversion='';
1.87      matthew  3293:     for (my $i=0;$i<=$#browsertype;$i++) {
1.1193    raeburn  3294:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87      matthew  3295: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   3296: 	    $clientbrowser=$bname;
                   3297:             $httpbrowser=~/$vreg/i;
                   3298: 	    $clientversion=$1;
                   3299:             $clientmathml=($clientversion>=$minv);
                   3300:             $clientunicode=($clientversion>=$univ);
                   3301: 	}
                   3302:     }
                   3303:     my $clientos='unknown';
1.1141    raeburn  3304:     my $clientinfo;
1.87      matthew  3305:     if (($httpbrowser=~/linux/i) ||
                   3306:         ($httpbrowser=~/unix/i) ||
                   3307:         ($httpbrowser=~/ux/i) ||
                   3308:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   3309:     if (($httpbrowser=~/vax/i) ||
                   3310:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   3311:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   3312:     if (($httpbrowser=~/mac/i) ||
                   3313:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1194    raeburn  3314:     if ($httpbrowser=~/win/i) {
                   3315:         $clientos='win';
                   3316:         if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
                   3317:             $clientosversion = $1;
                   3318:         }
                   3319:     }
1.87      matthew  3320:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1137    raeburn  3321:     if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
                   3322:         $clientmobile=lc($1);
                   3323:     }
1.1141    raeburn  3324:     if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
                   3325:         $clientinfo = 'firefox-'.$1;
                   3326:     } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
                   3327:         $clientinfo = 'chromeframe-'.$1;
                   3328:     }
1.87      matthew  3329:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1194    raeburn  3330:             $clientunicode,$clientos,$clientmobile,$clientinfo,
                   3331:             $clientosversion);
1.87      matthew  3332: }
                   3333: 
1.32      matthew  3334: ###############################################################
                   3335: ##    Authentication changing form generation subroutines    ##
                   3336: ###############################################################
                   3337: ##
                   3338: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   3339: ## hash, and have reasonable default values.
                   3340: ##
                   3341: ##    formname = the name given in the <form> tag.
1.35      matthew  3342: #-------------------------------------------
                   3343: 
1.45      matthew  3344: =pod
                   3345: 
1.112     bowersj2 3346: =head1 Authentication Routines
                   3347: 
                   3348: =over 4
                   3349: 
1.648     raeburn  3350: =item * &authform_xxxxxx()
1.35      matthew  3351: 
                   3352: The authform_xxxxxx subroutines provide javascript and html forms which 
                   3353: handle some of the conveniences required for authentication forms.  
                   3354: This is not an optimal method, but it works.  
                   3355: 
                   3356: =over 4
                   3357: 
1.112     bowersj2 3358: =item * authform_header
1.35      matthew  3359: 
1.112     bowersj2 3360: =item * authform_authorwarning
1.35      matthew  3361: 
1.112     bowersj2 3362: =item * authform_nochange
1.35      matthew  3363: 
1.112     bowersj2 3364: =item * authform_kerberos
1.35      matthew  3365: 
1.112     bowersj2 3366: =item * authform_internal
1.35      matthew  3367: 
1.112     bowersj2 3368: =item * authform_filesystem
1.35      matthew  3369: 
1.1310    raeburn  3370: =item * authform_lti
                   3371: 
1.35      matthew  3372: =back
                   3373: 
1.648     raeburn  3374: See loncreateuser.pm for invocation and use examples.
1.157     matthew  3375: 
1.35      matthew  3376: =cut
                   3377: 
                   3378: #-------------------------------------------
1.32      matthew  3379: sub authform_header{  
                   3380:     my %in = (
                   3381:         formname => 'cu',
1.80      albertel 3382:         kerb_def_dom => '',
1.32      matthew  3383:         @_,
                   3384:     );
                   3385:     $in{'formname'} = 'document.' . $in{'formname'};
                   3386:     my $result='';
1.80      albertel 3387: 
                   3388: #---------------------------------------------- Code for upper case translation
                   3389:     my $Javascript_toUpperCase;
                   3390:     unless ($in{kerb_def_dom}) {
                   3391:         $Javascript_toUpperCase =<<"END";
                   3392:         switch (choice) {
                   3393:            case 'krb': currentform.elements[choicearg].value =
                   3394:                currentform.elements[choicearg].value.toUpperCase();
                   3395:                break;
                   3396:            default:
                   3397:         }
                   3398: END
                   3399:     } else {
                   3400:         $Javascript_toUpperCase = "";
                   3401:     }
                   3402: 
1.165     raeburn  3403:     my $radioval = "'nochange'";
1.591     raeburn  3404:     if (defined($in{'curr_authtype'})) {
                   3405:         if ($in{'curr_authtype'} ne '') {
                   3406:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   3407:         }
1.174     matthew  3408:     }
1.165     raeburn  3409:     my $argfield = 'null';
1.591     raeburn  3410:     if (defined($in{'mode'})) {
1.165     raeburn  3411:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  3412:             if (defined($in{'curr_autharg'})) {
                   3413:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  3414:                     $argfield = "'$in{'curr_autharg'}'";
                   3415:                 }
                   3416:             }
                   3417:         }
                   3418:     }
                   3419: 
1.32      matthew  3420:     $result.=<<"END";
                   3421: var current = new Object();
1.165     raeburn  3422: current.radiovalue = $radioval;
                   3423: current.argfield = $argfield;
1.32      matthew  3424: 
                   3425: function changed_radio(choice,currentform) {
                   3426:     var choicearg = choice + 'arg';
                   3427:     // If a radio button in changed, we need to change the argfield
                   3428:     if (current.radiovalue != choice) {
                   3429:         current.radiovalue = choice;
                   3430:         if (current.argfield != null) {
                   3431:             currentform.elements[current.argfield].value = '';
                   3432:         }
                   3433:         if (choice == 'nochange') {
                   3434:             current.argfield = null;
                   3435:         } else {
                   3436:             current.argfield = choicearg;
                   3437:             switch(choice) {
                   3438:                 case 'krb': 
                   3439:                     currentform.elements[current.argfield].value = 
                   3440:                         "$in{'kerb_def_dom'}";
                   3441:                 break;
                   3442:               default:
                   3443:                 break;
                   3444:             }
                   3445:         }
                   3446:     }
                   3447:     return;
                   3448: }
1.22      www      3449: 
1.32      matthew  3450: function changed_text(choice,currentform) {
                   3451:     var choicearg = choice + 'arg';
                   3452:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 3453:         $Javascript_toUpperCase
1.32      matthew  3454:         // clear old field
                   3455:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   3456:             currentform.elements[current.argfield].value = '';
                   3457:         }
                   3458:         current.argfield = choicearg;
                   3459:     }
                   3460:     set_auth_radio_buttons(choice,currentform);
                   3461:     return;
1.20      www      3462: }
1.32      matthew  3463: 
                   3464: function set_auth_radio_buttons(newvalue,currentform) {
1.986     raeburn  3465:     var numauthchoices = currentform.login.length;
                   3466:     if (typeof numauthchoices  == "undefined") {
                   3467:         return;
                   3468:     } 
1.32      matthew  3469:     var i=0;
1.986     raeburn  3470:     while (i < numauthchoices) {
1.32      matthew  3471:         if (currentform.login[i].value == newvalue) { break; }
                   3472:         i++;
                   3473:     }
1.986     raeburn  3474:     if (i == numauthchoices) {
1.32      matthew  3475:         return;
                   3476:     }
                   3477:     current.radiovalue = newvalue;
                   3478:     currentform.login[i].checked = true;
                   3479:     return;
                   3480: }
                   3481: END
                   3482:     return $result;
                   3483: }
                   3484: 
1.1106    raeburn  3485: sub authform_authorwarning {
1.32      matthew  3486:     my $result='';
1.144     matthew  3487:     $result='<i>'.
                   3488:         &mt('As a general rule, only authors or co-authors should be '.
                   3489:             'filesystem authenticated '.
                   3490:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  3491:     return $result;
                   3492: }
                   3493: 
1.1106    raeburn  3494: sub authform_nochange {
1.32      matthew  3495:     my %in = (
                   3496:               formname => 'document.cu',
                   3497:               kerb_def_dom => 'MSU.EDU',
                   3498:               @_,
                   3499:           );
1.1106    raeburn  3500:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586     raeburn  3501:     my $result;
1.1104    raeburn  3502:     if (!$authnum) {
1.1105    raeburn  3503:         $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586     raeburn  3504:     } else {
                   3505:         $result = '<label>'.&mt('[_1] Do not change login data',
                   3506:                   '<input type="radio" name="login" value="nochange" '.
                   3507:                   'checked="checked" onclick="'.
1.281     albertel 3508:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   3509: 	    '</label>';
1.586     raeburn  3510:     }
1.32      matthew  3511:     return $result;
                   3512: }
                   3513: 
1.591     raeburn  3514: sub authform_kerberos {
1.32      matthew  3515:     my %in = (
                   3516:               formname => 'document.cu',
                   3517:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 3518:               kerb_def_auth => 'krb4',
1.32      matthew  3519:               @_,
                   3520:               );
1.586     raeburn  3521:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1259    raeburn  3522:         $autharg,$jscall,$disabled);
1.1106    raeburn  3523:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80      albertel 3524:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   3525:        $check5 = ' checked="checked"';
1.80      albertel 3526:     } else {
1.772     bisitz   3527:        $check4 = ' checked="checked"';
1.80      albertel 3528:     }
1.1259    raeburn  3529:     if ($in{'readonly'}) {
                   3530:         $disabled = ' disabled="disabled"';
                   3531:     }
1.165     raeburn  3532:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  3533:     if (defined($in{'curr_authtype'})) {
                   3534:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   3535:             $krbcheck = ' checked="checked"';
1.623     raeburn  3536:             if (defined($in{'mode'})) {
                   3537:                 if ($in{'mode'} eq 'modifyuser') {
                   3538:                     $krbcheck = '';
                   3539:                 }
                   3540:             }
1.591     raeburn  3541:             if (defined($in{'curr_kerb_ver'})) {
                   3542:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   3543:                     $check5 = ' checked="checked"';
1.591     raeburn  3544:                     $check4 = '';
                   3545:                 } else {
1.772     bisitz   3546:                     $check4 = ' checked="checked"';
1.591     raeburn  3547:                     $check5 = '';
                   3548:                 }
1.586     raeburn  3549:             }
1.591     raeburn  3550:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  3551:                 $krbarg = $in{'curr_autharg'};
                   3552:             }
1.586     raeburn  3553:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  3554:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  3555:                     $result = 
                   3556:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   3557:         $in{'curr_autharg'},$krbver);
                   3558:                 } else {
                   3559:                     $result =
                   3560:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   3561:                 }
                   3562:                 return $result; 
                   3563:             }
                   3564:         }
                   3565:     } else {
                   3566:         if ($authnum == 1) {
1.784     bisitz   3567:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  3568:         }
                   3569:     }
1.586     raeburn  3570:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   3571:         return;
1.587     raeburn  3572:     } elsif ($authtype eq '') {
1.591     raeburn  3573:         if (defined($in{'mode'})) {
1.587     raeburn  3574:             if ($in{'mode'} eq 'modifycourse') {
                   3575:                 if ($authnum == 1) {
1.1259    raeburn  3576:                     $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587     raeburn  3577:                 }
                   3578:             }
                   3579:         }
1.586     raeburn  3580:     }
                   3581:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   3582:     if ($authtype eq '') {
                   3583:         $authtype = '<input type="radio" name="login" value="krb" '.
                   3584:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1259    raeburn  3585:                     $krbcheck.$disabled.' />';
1.586     raeburn  3586:     }
                   3587:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106    raeburn  3588:         ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586     raeburn  3589:          $in{'curr_authtype'} eq 'krb5') ||
1.1106    raeburn  3590:         (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586     raeburn  3591:          $in{'curr_authtype'} eq 'krb4')) {
                   3592:         $result .= &mt
1.144     matthew  3593:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 3594:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  3595:          '<label>'.$authtype,
1.281     albertel 3596:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  3597:              'value="'.$krbarg.'" '.
1.1259    raeburn  3598:              'onchange="'.$jscall.'"'.$disabled.' />',
                   3599:          '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
                   3600:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281     albertel 3601: 	 '</label>');
1.586     raeburn  3602:     } elsif ($can_assign{'krb4'}) {
                   3603:         $result .= &mt
                   3604:         ('[_1] Kerberos authenticated with domain [_2] '.
                   3605:          '[_3] Version 4 [_4]',
                   3606:          '<label>'.$authtype,
                   3607:          '</label><input type="text" size="10" name="krbarg" '.
                   3608:              'value="'.$krbarg.'" '.
1.1259    raeburn  3609:              'onchange="'.$jscall.'"'.$disabled.' />',
1.586     raeburn  3610:          '<label><input type="hidden" name="krbver" value="4" />',
                   3611:          '</label>');
                   3612:     } elsif ($can_assign{'krb5'}) {
                   3613:         $result .= &mt
                   3614:         ('[_1] Kerberos authenticated with domain [_2] '.
                   3615:          '[_3] Version 5 [_4]',
                   3616:          '<label>'.$authtype,
                   3617:          '</label><input type="text" size="10" name="krbarg" '.
                   3618:              'value="'.$krbarg.'" '.
1.1259    raeburn  3619:              'onchange="'.$jscall.'"'.$disabled.' />',
1.586     raeburn  3620:          '<label><input type="hidden" name="krbver" value="5" />',
                   3621:          '</label>');
                   3622:     }
1.32      matthew  3623:     return $result;
                   3624: }
                   3625: 
1.1106    raeburn  3626: sub authform_internal {
1.586     raeburn  3627:     my %in = (
1.32      matthew  3628:                 formname => 'document.cu',
                   3629:                 kerb_def_dom => 'MSU.EDU',
                   3630:                 @_,
                   3631:                 );
1.1259    raeburn  3632:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106    raeburn  3633:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259    raeburn  3634:     if ($in{'readonly'}) {
                   3635:         $disabled = ' disabled="disabled"';
                   3636:     }
1.591     raeburn  3637:     if (defined($in{'curr_authtype'})) {
                   3638:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  3639:             if ($can_assign{'int'}) {
1.772     bisitz   3640:                 $intcheck = 'checked="checked" ';
1.623     raeburn  3641:                 if (defined($in{'mode'})) {
                   3642:                     if ($in{'mode'} eq 'modifyuser') {
                   3643:                         $intcheck = '';
                   3644:                     }
                   3645:                 }
1.591     raeburn  3646:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  3647:                     $intarg = $in{'curr_autharg'};
                   3648:                 }
                   3649:             } else {
                   3650:                 $result = &mt('Currently internally authenticated.');
                   3651:                 return $result;
1.165     raeburn  3652:             }
                   3653:         }
1.586     raeburn  3654:     } else {
                   3655:         if ($authnum == 1) {
1.784     bisitz   3656:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  3657:         }
                   3658:     }
                   3659:     if (!$can_assign{'int'}) {
                   3660:         return;
1.587     raeburn  3661:     } elsif ($authtype eq '') {
1.591     raeburn  3662:         if (defined($in{'mode'})) {
1.587     raeburn  3663:             if ($in{'mode'} eq 'modifycourse') {
                   3664:                 if ($authnum == 1) {
1.1259    raeburn  3665:                     $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587     raeburn  3666:                 }
                   3667:             }
                   3668:         }
1.165     raeburn  3669:     }
1.586     raeburn  3670:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   3671:     if ($authtype eq '') {
                   3672:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1259    raeburn  3673:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3674:     }
1.605     bisitz   3675:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1259    raeburn  3676:                $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3677:     $result = &mt
1.144     matthew  3678:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  3679:          '<label>'.$authtype,'</label>'.$autharg);
1.1259    raeburn  3680:     $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  3681:     return $result;
                   3682: }
                   3683: 
1.1104    raeburn  3684: sub authform_local {
1.32      matthew  3685:     my %in = (
                   3686:               formname => 'document.cu',
                   3687:               kerb_def_dom => 'MSU.EDU',
                   3688:               @_,
                   3689:               );
1.1259    raeburn  3690:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106    raeburn  3691:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259    raeburn  3692:     if ($in{'readonly'}) {
                   3693:         $disabled = ' disabled="disabled"';
                   3694:     } 
1.591     raeburn  3695:     if (defined($in{'curr_authtype'})) {
                   3696:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  3697:             if ($can_assign{'loc'}) {
1.772     bisitz   3698:                 $loccheck = 'checked="checked" ';
1.623     raeburn  3699:                 if (defined($in{'mode'})) {
                   3700:                     if ($in{'mode'} eq 'modifyuser') {
                   3701:                         $loccheck = '';
                   3702:                     }
                   3703:                 }
1.591     raeburn  3704:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  3705:                     $locarg = $in{'curr_autharg'};
                   3706:                 }
                   3707:             } else {
                   3708:                 $result = &mt('Currently using local (institutional) authentication.');
                   3709:                 return $result;
1.165     raeburn  3710:             }
                   3711:         }
1.586     raeburn  3712:     } else {
                   3713:         if ($authnum == 1) {
1.784     bisitz   3714:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  3715:         }
                   3716:     }
                   3717:     if (!$can_assign{'loc'}) {
                   3718:         return;
1.587     raeburn  3719:     } elsif ($authtype eq '') {
1.591     raeburn  3720:         if (defined($in{'mode'})) {
1.587     raeburn  3721:             if ($in{'mode'} eq 'modifycourse') {
                   3722:                 if ($authnum == 1) {
1.1259    raeburn  3723:                     $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587     raeburn  3724:                 }
                   3725:             }
                   3726:         }
1.165     raeburn  3727:     }
1.586     raeburn  3728:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   3729:     if ($authtype eq '') {
                   3730:         $authtype = '<input type="radio" name="login" value="loc" '.
                   3731:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1259    raeburn  3732:                     $jscall.'"'.$disabled.' />';
1.586     raeburn  3733:     }
                   3734:     $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1259    raeburn  3735:                $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3736:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   3737:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  3738:     return $result;
                   3739: }
                   3740: 
1.1106    raeburn  3741: sub authform_filesystem {
1.32      matthew  3742:     my %in = (
                   3743:               formname => 'document.cu',
                   3744:               kerb_def_dom => 'MSU.EDU',
                   3745:               @_,
                   3746:               );
1.1259    raeburn  3747:     my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1106    raeburn  3748:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259    raeburn  3749:     if ($in{'readonly'}) {
                   3750:         $disabled = ' disabled="disabled"';
                   3751:     }
1.591     raeburn  3752:     if (defined($in{'curr_authtype'})) {
                   3753:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  3754:             if ($can_assign{'fsys'}) {
1.772     bisitz   3755:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  3756:                 if (defined($in{'mode'})) {
                   3757:                     if ($in{'mode'} eq 'modifyuser') {
                   3758:                         $fsyscheck = '';
                   3759:                     }
                   3760:                 }
1.586     raeburn  3761:             } else {
                   3762:                 $result = &mt('Currently Filesystem Authenticated.');
                   3763:                 return $result;
1.1259    raeburn  3764:             }
1.586     raeburn  3765:         }
                   3766:     } else {
                   3767:         if ($authnum == 1) {
1.784     bisitz   3768:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  3769:         }
                   3770:     }
                   3771:     if (!$can_assign{'fsys'}) {
                   3772:         return;
1.587     raeburn  3773:     } elsif ($authtype eq '') {
1.591     raeburn  3774:         if (defined($in{'mode'})) {
1.587     raeburn  3775:             if ($in{'mode'} eq 'modifycourse') {
                   3776:                 if ($authnum == 1) {
1.1259    raeburn  3777:                     $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587     raeburn  3778:                 }
                   3779:             }
                   3780:         }
1.586     raeburn  3781:     }
                   3782:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   3783:     if ($authtype eq '') {
                   3784:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   3785:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1259    raeburn  3786:                     $jscall.'"'.$disabled.' />';
1.586     raeburn  3787:     }
1.1310    raeburn  3788:     $autharg = '<input type="password" size="10" name="fsysarg" value=""'.
1.1259    raeburn  3789:                ' onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3790:     $result = &mt
1.144     matthew  3791:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.1310    raeburn  3792:          '<label>'.$authtype,'</label>'.$autharg);
                   3793:     return $result;
                   3794: }
                   3795: 
                   3796: sub authform_lti {
                   3797:     my %in = (
                   3798:               formname => 'document.cu',
                   3799:               kerb_def_dom => 'MSU.EDU',
                   3800:               @_,
                   3801:               );
                   3802:     my ($lticheck,$result,$authtype,$autharg,$jscall,$disabled);
                   3803:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
                   3804:     if ($in{'readonly'}) {
                   3805:         $disabled = ' disabled="disabled"';
                   3806:     }
                   3807:     if (defined($in{'curr_authtype'})) {
                   3808:         if ($in{'curr_authtype'} eq 'lti') {
                   3809:             if ($can_assign{'lti'}) {
                   3810:                 $lticheck = 'checked="checked" ';
                   3811:                 if (defined($in{'mode'})) {
                   3812:                     if ($in{'mode'} eq 'modifyuser') {
                   3813:                         $lticheck = '';
                   3814:                     }
                   3815:                 }
                   3816:             } else {
                   3817:                 $result = &mt('Currently LTI Authenticated.');
                   3818:                 return $result;
                   3819:             }
                   3820:         }
                   3821:     } else {
                   3822:         if ($authnum == 1) {
                   3823:             $authtype = '<input type="hidden" name="login" value="lti" />';
                   3824:         }
                   3825:     }
                   3826:     if (!$can_assign{'lti'}) {
                   3827:         return;
                   3828:     } elsif ($authtype eq '') {
                   3829:         if (defined($in{'mode'})) {
                   3830:             if ($in{'mode'} eq 'modifycourse') {
                   3831:                 if ($authnum == 1) {
                   3832:                     $authtype = '<input type="radio" name="login" value="lti"'.$disabled.' />';
                   3833:                 }
                   3834:             }
                   3835:         }
                   3836:     }
                   3837:     $jscall = "javascript:changed_radio('lti',$in{'formname'});";
                   3838:     if (($authtype eq '') && (($in{'mode'} eq 'modifycourse') || ($in{'curr_authtype'} ne 'lti'))) {
                   3839:         $authtype = '<input type="radio" name="login" value="lti" '.
                   3840:                     $lticheck.' onchange="'.$jscall.'" onclick="'.
                   3841:                     $jscall.'"'.$disabled.' />';
                   3842:     }
                   3843:     $autharg = '<input type="hidden" name="ltiarg" value="" />';
                   3844:     if ($authtype) {
                   3845:         $result = &mt('[_1] LTI Authenticated',
                   3846:                       '<label>'.$authtype.'</label>'.$autharg);
                   3847:     } else {
                   3848:         $result = '<b>'.&mt('LTI Authenticated').'</b>'.
                   3849:                   $autharg;
                   3850:     }
1.32      matthew  3851:     return $result;
                   3852: }
                   3853: 
1.586     raeburn  3854: sub get_assignable_auth {
                   3855:     my ($dom) = @_;
                   3856:     if ($dom eq '') {
                   3857:         $dom = $env{'request.role.domain'};
                   3858:     }
                   3859:     my %can_assign = (
                   3860:                           krb4 => 1,
                   3861:                           krb5 => 1,
                   3862:                           int  => 1,
                   3863:                           loc  => 1,
1.1310    raeburn  3864:                           lti  => 1,
1.586     raeburn  3865:                      );
                   3866:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   3867:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   3868:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   3869:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   3870:             my $context;
                   3871:             if ($env{'request.role'} =~ /^au/) {
                   3872:                 $context = 'author';
1.1259    raeburn  3873:             } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586     raeburn  3874:                 $context = 'domain';
                   3875:             } elsif ($env{'request.course.id'}) {
                   3876:                 $context = 'course';
                   3877:             }
                   3878:             if ($context) {
                   3879:                 if (ref($authhash->{$context}) eq 'HASH') {
                   3880:                    %can_assign = %{$authhash->{$context}}; 
                   3881:                 }
                   3882:             }
                   3883:         }
                   3884:     }
                   3885:     my $authnum = 0;
                   3886:     foreach my $key (keys(%can_assign)) {
                   3887:         if ($can_assign{$key}) {
                   3888:             $authnum ++;
                   3889:         }
                   3890:     }
                   3891:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   3892:         $authnum --;
                   3893:     }
                   3894:     return ($authnum,%can_assign);
                   3895: }
                   3896: 
1.1331    raeburn  3897: sub check_passwd_rules {
                   3898:     my ($domain,$plainpass) = @_;
                   3899:     my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
                   3900:     my ($min,$max,@chars,@brokerule,$warning);
1.1333    raeburn  3901:     $min = $Apache::lonnet::passwdmin;
1.1331    raeburn  3902:     if (ref($passwdconf{'chars'}) eq 'ARRAY') {
                   3903:         if ($passwdconf{'min'} =~ /^\d+$/) {
1.1333    raeburn  3904:             if ($passwdconf{'min'} > $min) {
                   3905:                 $min = $passwdconf{'min'};
                   3906:             }
1.1331    raeburn  3907:         }
                   3908:         if ($passwdconf{'max'} =~ /^\d+$/) {
                   3909:             $max = $passwdconf{'max'};
                   3910:         }
                   3911:         @chars = @{$passwdconf{'chars'}};
                   3912:     }
                   3913:     if (($min) && (length($plainpass) < $min)) {
                   3914:         push(@brokerule,'min');
                   3915:     }
                   3916:     if (($max) && (length($plainpass) > $max)) {
                   3917:         push(@brokerule,'max');
                   3918:     }
                   3919:     if (@chars) {
                   3920:         my %rules;
                   3921:         map { $rules{$_} = 1; } @chars;
                   3922:         if ($rules{'uc'}) {
                   3923:             unless ($plainpass =~ /[A-Z]/) {
                   3924:                 push(@brokerule,'uc');
                   3925:             }
                   3926:         }
                   3927:         if ($rules{'lc'}) {
1.1332    raeburn  3928:             unless ($plainpass =~ /[a-z]/) {
1.1331    raeburn  3929:                 push(@brokerule,'lc');
                   3930:             }
                   3931:         }
                   3932:         if ($rules{'num'}) {
                   3933:             unless ($plainpass =~ /\d/) {
                   3934:                 push(@brokerule,'num');
                   3935:             }
                   3936:         }
                   3937:         if ($rules{'spec'}) {
                   3938:             unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
                   3939:                 push(@brokerule,'spec');
                   3940:             }
                   3941:         }
                   3942:     }
                   3943:     if (@brokerule) {
                   3944:         my %rulenames = &Apache::lonlocal::texthash(
                   3945:             uc   => 'At least one upper case letter',
                   3946:             lc   => 'At least one lower case letter',
                   3947:             num  => 'At least one number',
                   3948:             spec => 'At least one non-alphanumeric',
                   3949:         );
                   3950:         $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
                   3951:         $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
                   3952:         $rulenames{'num'} .= ': 0123456789';
                   3953:         $rulenames{'spec'} .= ': !&quot;\#$%&amp;\'()*+,-./:;&lt;=&gt;?@[\]^_\`{|}~';
                   3954:         $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
                   3955:         $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
                   3956:         $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1336    raeburn  3957:         foreach my $rule ('min','max','uc','lc','num','spec') {
1.1331    raeburn  3958:             if (grep(/^$rule$/,@brokerule)) {
                   3959:                 $warning .= '<li>'.$rulenames{$rule}.'</li>';
                   3960:             }
                   3961:         }
                   3962:         $warning .= '</ul>';
                   3963:     }
1.1332    raeburn  3964:     if (wantarray) {
                   3965:         return @brokerule;
                   3966:     }
1.1331    raeburn  3967:     return $warning;
                   3968: }
                   3969: 
1.1376    raeburn  3970: sub passwd_validation_js {
1.1377    raeburn  3971:     my ($currpasswdval,$domain,$context,$id) = @_;
                   3972:     my (%passwdconf,$alertmsg);
                   3973:     if ($context eq 'linkprot') {
                   3974:         my %domconfig = &Apache::lonnet::get_dom('configuration',['ltisec'],$domain);
                   3975:         if (ref($domconfig{'ltisec'}) eq 'HASH') {
                   3976:             if (ref($domconfig{'ltisec'}{'rules'}) eq 'HASH') {
                   3977:                 %passwdconf = %{$domconfig{'ltisec'}{'rules'}};
                   3978:             }
                   3979:         }
                   3980:         if ($id eq 'add') {
                   3981:             $alertmsg = &mt('Secret for added launcher did not satisfy requirement(s):').'\n\n';
                   3982:         } elsif ($id =~ /^\d+$/) {
                   3983:             my $pos = $id+1;
                   3984:             $alertmsg = &mt('Secret for launcher [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
                   3985:         } else {
                   3986:             $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
                   3987:         }
1.1434    raeburn  3988:     } elsif ($context eq 'ltitools') {
                   3989:         my %domconfig = &Apache::lonnet::get_dom('configuration',['toolsec'],$domain);
                   3990:         if (ref($domconfig{'toolsec'}) eq 'HASH') {
                   3991:             if (ref($domconfig{'toolsec'}{'rules'}) eq 'HASH') {
                   3992:                 %passwdconf = %{$domconfig{'toolsec'}{'rules'}};
                   3993:             }
                   3994:         }
                   3995:         if ($id eq 'add') {
                   3996:             $alertmsg = &mt('Secret for added external tool did not satisfy requirement(s):').'\n\n';
                   3997:         } elsif ($id =~ /^\d+$/) {
                   3998:             my $pos = $id+1;
                   3999:             $alertmsg = &mt('Secret for external tool [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
                   4000:         } else {
                   4001:             $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
                   4002:         }
1.1377    raeburn  4003:     } else {
                   4004:         %passwdconf = &Apache::lonnet::get_passwdconf($domain);
                   4005:         $alertmsg = &mt('Initial password did not satisfy requirement(s):').'\n\n';
                   4006:     }
1.1376    raeburn  4007:     my ($min,$max,@chars,$numrules,$intargjs,%alert);
                   4008:     $numrules = 0;
                   4009:     $min = $Apache::lonnet::passwdmin;
                   4010:     if (ref($passwdconf{'chars'}) eq 'ARRAY') {
                   4011:         if ($passwdconf{'min'} =~ /^\d+$/) {
                   4012:             if ($passwdconf{'min'} > $min) {
                   4013:                 $min = $passwdconf{'min'};
                   4014:             }
                   4015:         }
                   4016:         if ($passwdconf{'max'} =~ /^\d+$/) {
                   4017:             $max = $passwdconf{'max'};
                   4018:             $numrules ++;
                   4019:         }
                   4020:         @chars = @{$passwdconf{'chars'}};
                   4021:         if (@chars) {
                   4022:             $numrules ++;
                   4023:         }
                   4024:     }
                   4025:     if ($min > 0) {
                   4026:         $numrules ++;
                   4027:     }
                   4028:     if (($min > 0) || ($max ne '') || (@chars > 0)) {
                   4029:         if ($min) {
                   4030:             $alert{'min'} = &mt('minimum [quant,_1,character]',$min).'\n';
                   4031:         }
                   4032:         if ($max) {
                   4033:             $alert{'max'} = &mt('maximum [quant,_1,character]',$max).'\n';
                   4034:         }
                   4035:         my (@charalerts,@charrules);
                   4036:         if (@chars) {
                   4037:             if (grep(/^uc$/,@chars)) {
                   4038:                 push(@charalerts,&mt('contain at least one upper case letter'));
                   4039:                 push(@charrules,'uc');
                   4040:             }
                   4041:             if (grep(/^lc$/,@chars)) {
                   4042:                 push(@charalerts,&mt('contain at least one lower case letter'));
                   4043:                 push(@charrules,'lc');
                   4044:             }
                   4045:             if (grep(/^num$/,@chars)) {
                   4046:                 push(@charalerts,&mt('contain at least one number'));
                   4047:                 push(@charrules,'num');
                   4048:             }
                   4049:             if (grep(/^spec$/,@chars)) {
                   4050:                 push(@charalerts,&mt('contain at least one non-alphanumeric'));
                   4051:                 push(@charrules,'spec');
                   4052:             }
                   4053:         }
                   4054:         $intargjs = qq|            var rulesmsg = '';\n|.
                   4055:                     qq|            var currpwval = $currpasswdval;\n|;
                   4056:             if ($min) {
                   4057:                 $intargjs .= qq|
                   4058:             if (currpwval.length < $min) {
                   4059:                 rulesmsg += ' - $alert{min}';
                   4060:             }
                   4061: |;
                   4062:             }
                   4063:             if ($max) {
                   4064:                 $intargjs .= qq|
                   4065:             if (currpwval.length > $max) {
                   4066:                 rulesmsg += ' - $alert{max}';
                   4067:             }
                   4068: |;
                   4069:             }
                   4070:             if (@chars > 0) {
                   4071:                 my $charrulestr = '"'.join('","',@charrules).'"';
                   4072:                 my $charalertstr = '"'.join('","',@charalerts).'"';
                   4073:                 $intargjs .= qq|            var brokerules = new Array();\n|.
                   4074:                              qq|            var charrules = new Array($charrulestr);\n|.
                   4075:                              qq|            var charalerts = new Array($charalertstr);\n|;
                   4076:                 my %rules;
                   4077:                 map { $rules{$_} = 1; } @chars;
                   4078:                 if ($rules{'uc'}) {
                   4079:                     $intargjs .= qq|
                   4080:             var ucRegExp = /[A-Z]/;
                   4081:             if (!ucRegExp.test(currpwval)) {
                   4082:                 brokerules.push('uc');
                   4083:             }
                   4084: |;
                   4085:                 }
                   4086:                 if ($rules{'lc'}) {
                   4087:                     $intargjs .= qq|
                   4088:             var lcRegExp = /[a-z]/;
                   4089:             if (!lcRegExp.test(currpwval)) {
                   4090:                 brokerules.push('lc');
                   4091:             }
                   4092: |;
                   4093:                 }
                   4094:                 if ($rules{'num'}) {
                   4095:                      $intargjs .= qq|
                   4096:             var numRegExp = /[0-9]/;
                   4097:             if (!numRegExp.test(currpwval)) {
                   4098:                 brokerules.push('num');
                   4099:             }
                   4100: |;
                   4101:                 }
                   4102:                 if ($rules{'spec'}) {
                   4103:                      $intargjs .= q|
                   4104:             var specRegExp = /[!"#$%&'()*+,\-.\/:;<=>?@[\\^\]_`{\|}~]/;
                   4105:             if (!specRegExp.test(currpwval)) {
                   4106:                 brokerules.push('spec');
                   4107:             }
                   4108: |;
                   4109:                 }
                   4110:                 $intargjs .= qq|
                   4111:             if (brokerules.length > 0) {
                   4112:                 for (var i=0; i<brokerules.length; i++) {
                   4113:                     for (var j=0; j<charrules.length; j++) {
                   4114:                         if (brokerules[i] == charrules[j]) {
                   4115:                             rulesmsg += ' - '+charalerts[j]+'\\n';
                   4116:                             break;
                   4117:                         }
                   4118:                     }
                   4119:                 }
                   4120:             }
                   4121: |;
                   4122:             }
                   4123:             $intargjs .= qq|
                   4124:             if (rulesmsg != '') {
                   4125:                 rulesmsg = '$alertmsg'+rulesmsg;
                   4126:                 alert(rulesmsg);
                   4127:                 return false;
                   4128:             }
                   4129: |;
                   4130:     }
                   4131:     return ($numrules,$intargjs);
                   4132: }
                   4133: 
1.80      albertel 4134: ###############################################################
                   4135: ##    Get Kerberos Defaults for Domain                 ##
                   4136: ###############################################################
                   4137: ##
                   4138: ## Returns default kerberos version and an associated argument
                   4139: ## as listed in file domain.tab. If not listed, provides
                   4140: ## appropriate default domain and kerberos version.
                   4141: ##
                   4142: #-------------------------------------------
                   4143: 
                   4144: =pod
                   4145: 
1.648     raeburn  4146: =item * &get_kerberos_defaults()
1.80      albertel 4147: 
                   4148: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  4149: version and domain. If not found, it defaults to version 4 and the 
                   4150: domain of the server.
1.80      albertel 4151: 
1.648     raeburn  4152: =over 4
                   4153: 
1.80      albertel 4154: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   4155: 
1.648     raeburn  4156: =back
                   4157: 
                   4158: =back
                   4159: 
1.80      albertel 4160: =cut
                   4161: 
                   4162: #-------------------------------------------
                   4163: sub get_kerberos_defaults {
                   4164:     my $domain=shift;
1.641     raeburn  4165:     my ($krbdef,$krbdefdom);
                   4166:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   4167:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   4168:         $krbdef = $domdefaults{'auth_def'};
                   4169:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   4170:     } else {
1.80      albertel 4171:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   4172:         my $krbdefdom=$1;
                   4173:         $krbdefdom=~tr/a-z/A-Z/;
                   4174:         $krbdef = "krb4";
                   4175:     }
                   4176:     return ($krbdef,$krbdefdom);
                   4177: }
1.112     bowersj2 4178: 
1.32      matthew  4179: 
1.46      matthew  4180: ###############################################################
                   4181: ##                Thesaurus Functions                        ##
                   4182: ###############################################################
1.20      www      4183: 
1.46      matthew  4184: =pod
1.20      www      4185: 
1.112     bowersj2 4186: =head1 Thesaurus Functions
                   4187: 
                   4188: =over 4
                   4189: 
1.648     raeburn  4190: =item * &initialize_keywords()
1.46      matthew  4191: 
                   4192: Initializes the package variable %Keywords if it is empty.  Uses the
                   4193: package variable $thesaurus_db_file.
                   4194: 
                   4195: =cut
                   4196: 
                   4197: ###################################################
                   4198: 
                   4199: sub initialize_keywords {
                   4200:     return 1 if (scalar keys(%Keywords));
                   4201:     # If we are here, %Keywords is empty, so fill it up
                   4202:     #   Make sure the file we need exists...
                   4203:     if (! -e $thesaurus_db_file) {
                   4204:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   4205:                                  " failed because it does not exist");
                   4206:         return 0;
                   4207:     }
                   4208:     #   Set up the hash as a database
                   4209:     my %thesaurus_db;
                   4210:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 4211:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  4212:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   4213:                                  $thesaurus_db_file);
                   4214:         return 0;
                   4215:     } 
                   4216:     #  Get the average number of appearances of a word.
                   4217:     my $avecount = $thesaurus_db{'average.count'};
                   4218:     #  Put keywords (those that appear > average) into %Keywords
                   4219:     while (my ($word,$data)=each (%thesaurus_db)) {
                   4220:         my ($count,undef) = split /:/,$data;
                   4221:         $Keywords{$word}++ if ($count > $avecount);
                   4222:     }
                   4223:     untie %thesaurus_db;
                   4224:     # Remove special values from %Keywords.
1.356     albertel 4225:     foreach my $value ('total.count','average.count') {
                   4226:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  4227:   }
1.46      matthew  4228:     return 1;
                   4229: }
                   4230: 
                   4231: ###################################################
                   4232: 
                   4233: =pod
                   4234: 
1.648     raeburn  4235: =item * &keyword($word)
1.46      matthew  4236: 
                   4237: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   4238: than the average number of times in the thesaurus database.  Calls 
                   4239: &initialize_keywords
                   4240: 
                   4241: =cut
                   4242: 
                   4243: ###################################################
1.20      www      4244: 
                   4245: sub keyword {
1.46      matthew  4246:     return if (!&initialize_keywords());
                   4247:     my $word=lc(shift());
                   4248:     $word=~s/\W//g;
                   4249:     return exists($Keywords{$word});
1.20      www      4250: }
1.46      matthew  4251: 
                   4252: ###############################################################
                   4253: 
                   4254: =pod 
1.20      www      4255: 
1.648     raeburn  4256: =item * &get_related_words()
1.46      matthew  4257: 
1.160     matthew  4258: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  4259: an array of words.  If the keyword is not in the thesaurus, an empty array
                   4260: will be returned.  The order of the words returned is determined by the
                   4261: database which holds them.
                   4262: 
                   4263: Uses global $thesaurus_db_file.
                   4264: 
1.1057    foxr     4265: 
1.46      matthew  4266: =cut
                   4267: 
                   4268: ###############################################################
                   4269: sub get_related_words {
                   4270:     my $keyword = shift;
                   4271:     my %thesaurus_db;
                   4272:     if (! -e $thesaurus_db_file) {
                   4273:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   4274:                                  "failed because the file does not exist");
                   4275:         return ();
                   4276:     }
                   4277:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 4278:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  4279:         return ();
                   4280:     } 
                   4281:     my @Words=();
1.429     www      4282:     my $count=0;
1.46      matthew  4283:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 4284: 	# The first element is the number of times
                   4285: 	# the word appears.  We do not need it now.
1.429     www      4286: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   4287: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   4288: 	my $threshold=$mostfrequentcount/10;
                   4289:         foreach my $possibleword (@RelatedWords) {
                   4290:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   4291:             if ($wordcount>$threshold) {
                   4292: 		push(@Words,$word);
                   4293:                 $count++;
                   4294:                 if ($count>10) { last; }
                   4295: 	    }
1.20      www      4296:         }
                   4297:     }
1.46      matthew  4298:     untie %thesaurus_db;
                   4299:     return @Words;
1.14      harris41 4300: }
1.1090    foxr     4301: ###############################################################
                   4302: #
                   4303: #  Spell checking
                   4304: #
                   4305: 
                   4306: =pod
                   4307: 
1.1142    raeburn  4308: =back
                   4309: 
1.1090    foxr     4310: =head1 Spell checking
                   4311: 
                   4312: =over 4
                   4313: 
                   4314: =item * &check_spelling($wordlist $language)
                   4315: 
                   4316: Takes a string containing words and feeds it to an external
                   4317: spellcheck program via a pipeline. Returns a string containing
                   4318: them mis-spelled words.
                   4319: 
                   4320: Parameters:
                   4321: 
                   4322: =over 4
                   4323: 
                   4324: =item - $wordlist
                   4325: 
                   4326: String that will be fed into the spellcheck program.
                   4327: 
                   4328: =item - $language
                   4329: 
                   4330: Language string that specifies the language for which the spell
                   4331: check will be performed.
                   4332: 
                   4333: =back
                   4334: 
                   4335: =back
                   4336: 
                   4337: Note: This sub assumes that aspell is installed.
                   4338: 
                   4339: 
                   4340: =cut
                   4341: 
1.46      matthew  4342: 
1.1090    foxr     4343: sub check_spelling {
                   4344:     my ($wordlist, $language) = @_;
1.1091    foxr     4345:     my @misspellings;
                   4346:     
                   4347:     # Generate the speller and set the langauge.
                   4348:     # if explicitly selected:
1.1090    foxr     4349: 
1.1091    foxr     4350:     my $speller = Text::Aspell->new;
1.1090    foxr     4351:     if ($language) {
1.1091    foxr     4352: 	$speller->set_option('lang', $language);
1.1090    foxr     4353:     }
                   4354: 
1.1091    foxr     4355:     # Turn the word list into an array of words by splittingon whitespace
1.1090    foxr     4356: 
1.1091    foxr     4357:     my @words = split(/\s+/, $wordlist);
1.1090    foxr     4358: 
1.1091    foxr     4359:     foreach my $word (@words) {
                   4360: 	if(! $speller->check($word)) {
                   4361: 	    push(@misspellings, $word);
1.1090    foxr     4362: 	}
                   4363:     }
1.1091    foxr     4364:     return join(' ', @misspellings);
                   4365:     
1.1090    foxr     4366: }
                   4367: 
1.61      www      4368: # -------------------------------------------------------------- Plaintext name
1.81      albertel 4369: =pod
                   4370: 
1.112     bowersj2 4371: =head1 User Name Functions
                   4372: 
                   4373: =over 4
                   4374: 
1.648     raeburn  4375: =item * &plainname($uname,$udom,$first)
1.81      albertel 4376: 
1.112     bowersj2 4377: Takes a users logon name and returns it as a string in
1.226     albertel 4378: "first middle last generation" form 
                   4379: if $first is set to 'lastname' then it returns it as
                   4380: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 4381: 
                   4382: =cut
1.61      www      4383: 
1.295     www      4384: 
1.81      albertel 4385: ###############################################################
1.61      www      4386: sub plainname {
1.226     albertel 4387:     my ($uname,$udom,$first)=@_;
1.537     albertel 4388:     return if (!defined($uname) || !defined($udom));
1.295     www      4389:     my %names=&getnames($uname,$udom);
1.226     albertel 4390:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   4391: 					  $names{'middlename'},
                   4392: 					  $names{'lastname'},
                   4393: 					  $names{'generation'},$first);
                   4394:     $name=~s/^\s+//;
1.62      www      4395:     $name=~s/\s+$//;
                   4396:     $name=~s/\s+/ /g;
1.353     albertel 4397:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      4398:     return $name;
1.61      www      4399: }
1.66      www      4400: 
                   4401: # -------------------------------------------------------------------- Nickname
1.81      albertel 4402: =pod
                   4403: 
1.648     raeburn  4404: =item * &nickname($uname,$udom)
1.81      albertel 4405: 
                   4406: Gets a users name and returns it as a string as
                   4407: 
                   4408: "&quot;nickname&quot;"
1.66      www      4409: 
1.81      albertel 4410: if the user has a nickname or
                   4411: 
                   4412: "first middle last generation"
                   4413: 
                   4414: if the user does not
                   4415: 
                   4416: =cut
1.66      www      4417: 
                   4418: sub nickname {
                   4419:     my ($uname,$udom)=@_;
1.537     albertel 4420:     return if (!defined($uname) || !defined($udom));
1.295     www      4421:     my %names=&getnames($uname,$udom);
1.68      albertel 4422:     my $name=$names{'nickname'};
1.66      www      4423:     if ($name) {
                   4424:        $name='&quot;'.$name.'&quot;'; 
                   4425:     } else {
                   4426:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   4427: 	     $names{'lastname'}.' '.$names{'generation'};
                   4428:        $name=~s/\s+$//;
                   4429:        $name=~s/\s+/ /g;
                   4430:     }
                   4431:     return $name;
                   4432: }
                   4433: 
1.295     www      4434: sub getnames {
                   4435:     my ($uname,$udom)=@_;
1.537     albertel 4436:     return if (!defined($uname) || !defined($udom));
1.433     albertel 4437:     if ($udom eq 'public' && $uname eq 'public') {
                   4438: 	return ('lastname' => &mt('Public'));
                   4439:     }
1.295     www      4440:     my $id=$uname.':'.$udom;
                   4441:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   4442:     if ($cached) {
                   4443: 	return %{$names};
                   4444:     } else {
                   4445: 	my %loadnames=&Apache::lonnet::get('environment',
                   4446:                     ['firstname','middlename','lastname','generation','nickname'],
                   4447: 					 $udom,$uname);
                   4448: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   4449: 	return %loadnames;
                   4450:     }
                   4451: }
1.61      www      4452: 
1.542     raeburn  4453: # -------------------------------------------------------------------- getemails
1.648     raeburn  4454: 
1.542     raeburn  4455: =pod
                   4456: 
1.648     raeburn  4457: =item * &getemails($uname,$udom)
1.542     raeburn  4458: 
                   4459: Gets a user's email information and returns it as a hash with keys:
                   4460: notification, critnotification, permanentemail
                   4461: 
                   4462: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  4463: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  4464:  
1.648     raeburn  4465: 
1.542     raeburn  4466: =cut
                   4467: 
1.648     raeburn  4468: 
1.466     albertel 4469: sub getemails {
                   4470:     my ($uname,$udom)=@_;
                   4471:     if ($udom eq 'public' && $uname eq 'public') {
                   4472: 	return;
                   4473:     }
1.467     www      4474:     if (!$udom) { $udom=$env{'user.domain'}; }
                   4475:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 4476:     my $id=$uname.':'.$udom;
                   4477:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   4478:     if ($cached) {
                   4479: 	return %{$names};
                   4480:     } else {
                   4481: 	my %loadnames=&Apache::lonnet::get('environment',
                   4482:                     			   ['notification','critnotification',
                   4483: 					    'permanentemail'],
                   4484: 					   $udom,$uname);
                   4485: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   4486: 	return %loadnames;
                   4487:     }
                   4488: }
                   4489: 
1.551     albertel 4490: sub flush_email_cache {
                   4491:     my ($uname,$udom)=@_;
                   4492:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   4493:     if (!$uname) { $uname=$env{'user.name'};   }
                   4494:     return if ($udom eq 'public' && $uname eq 'public');
                   4495:     my $id=$uname.':'.$udom;
                   4496:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   4497: }
                   4498: 
1.728     raeburn  4499: # -------------------------------------------------------------------- getlangs
                   4500: 
                   4501: =pod
                   4502: 
                   4503: =item * &getlangs($uname,$udom)
                   4504: 
                   4505: Gets a user's language preference and returns it as a hash with key:
                   4506: language.
                   4507: 
                   4508: =cut
                   4509: 
                   4510: 
                   4511: sub getlangs {
                   4512:     my ($uname,$udom) = @_;
                   4513:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   4514:     if (!$uname) { $uname=$env{'user.name'};   }
                   4515:     my $id=$uname.':'.$udom;
                   4516:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   4517:     if ($cached) {
                   4518:         return %{$langs};
                   4519:     } else {
                   4520:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   4521:                                            $udom,$uname);
                   4522:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   4523:         return %loadlangs;
                   4524:     }
                   4525: }
                   4526: 
                   4527: sub flush_langs_cache {
                   4528:     my ($uname,$udom)=@_;
                   4529:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   4530:     if (!$uname) { $uname=$env{'user.name'};   }
                   4531:     return if ($udom eq 'public' && $uname eq 'public');
                   4532:     my $id=$uname.':'.$udom;
                   4533:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   4534: }
                   4535: 
1.61      www      4536: # ------------------------------------------------------------------ Screenname
1.81      albertel 4537: 
                   4538: =pod
                   4539: 
1.648     raeburn  4540: =item * &screenname($uname,$udom)
1.81      albertel 4541: 
                   4542: Gets a users screenname and returns it as a string
                   4543: 
                   4544: =cut
1.61      www      4545: 
                   4546: sub screenname {
                   4547:     my ($uname,$udom)=@_;
1.258     albertel 4548:     if ($uname eq $env{'user.name'} &&
                   4549: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 4550:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 4551:     return $names{'screenname'};
1.62      www      4552: }
                   4553: 
1.212     albertel 4554: 
1.802     bisitz   4555: # ------------------------------------------------------------- Confirm Wrapper
                   4556: =pod
                   4557: 
1.1142    raeburn  4558: =item * &confirmwrapper($message)
1.802     bisitz   4559: 
                   4560: Wrap messages about completion of operation in box
                   4561: 
                   4562: =cut
                   4563: 
                   4564: sub confirmwrapper {
                   4565:     my ($message)=@_;
                   4566:     if ($message) {
                   4567:         return "\n".'<div class="LC_confirm_box">'."\n"
                   4568:                .$message."\n"
                   4569:                .'</div>'."\n";
                   4570:     } else {
                   4571:         return $message;
                   4572:     }
                   4573: }
                   4574: 
1.62      www      4575: # ------------------------------------------------------------- Message Wrapper
                   4576: 
                   4577: sub messagewrapper {
1.369     www      4578:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      4579:     return 
1.441     albertel 4580:         '<a href="/adm/email?compose=individual&amp;'.
                   4581:         'recname='.$username.'&amp;recdom='.$domain.
                   4582: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  4583:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      4584: }
1.802     bisitz   4585: 
1.74      www      4586: # --------------------------------------------------------------- Notes Wrapper
                   4587: 
                   4588: sub noteswrapper {
                   4589:     my ($link,$un,$do)=@_;
                   4590:     return 
1.896     amueller 4591: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      4592: }
1.802     bisitz   4593: 
1.62      www      4594: # ------------------------------------------------------------- Aboutme Wrapper
                   4595: 
                   4596: sub aboutmewrapper {
1.1070    raeburn  4597:     my ($link,$username,$domain,$target,$class)=@_;
1.447     raeburn  4598:     if (!defined($username)  && !defined($domain)) {
                   4599:         return;
                   4600:     }
1.1096    raeburn  4601:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070    raeburn  4602: 	($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      4603: }
                   4604: 
                   4605: # ------------------------------------------------------------ Syllabus Wrapper
                   4606: 
                   4607: sub syllabuswrapper {
1.707     bisitz   4608:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  4609:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      4610: }
1.14      harris41 4611: 
1.1397    raeburn  4612: # -----------------------------------------------------------------------------
                   4613: 
1.1396    raeburn  4614: sub aboutme_on {
                   4615:     my ($uname,$udom)=@_;
                   4616:     unless ($uname) { $uname=$env{'user.name'}; }
                   4617:     unless ($udom)  { $udom=$env{'user.domain'}; }
                   4618:     return if ($udom eq 'public' && $uname eq 'public');
                   4619:     my $hashkey=$uname.':'.$udom;
                   4620:     my ($aboutme,$cached)=&Apache::lonnet::is_cached_new('aboutme',$hashkey);
                   4621:     if ($cached) {
                   4622:         return $aboutme;
                   4623:     }
                   4624:     $aboutme = &Apache::lonnet::usertools_access($uname,$udom,'aboutme');
                   4625:     &Apache::lonnet::do_cache_new('aboutme',$hashkey,$aboutme,3600);
                   4626:     return $aboutme;
                   4627: }
                   4628: 
                   4629: sub devalidate_aboutme_cache {
                   4630:     my ($uname,$udom)=@_;
                   4631:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   4632:     if (!$uname) { $uname=$env{'user.name'};   }
                   4633:     return if ($udom eq 'public' && $uname eq 'public');
                   4634:     my $id=$uname.':'.$udom;
                   4635:     &Apache::lonnet::devalidate_cache_new('aboutme',$id);
                   4636: }
                   4637: 
1.208     matthew  4638: sub track_student_link {
1.887     raeburn  4639:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 4640:     my $link ="/adm/trackstudent?";
1.208     matthew  4641:     my $title = 'View recent activity';
                   4642:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   4643:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 4644:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  4645:         $title .= ' of this student';
1.268     albertel 4646:     } 
1.208     matthew  4647:     if (defined($target) && $target !~ /^\s*$/) {
                   4648:         $target = qq{target="$target"};
                   4649:     } else {
                   4650:         $target = '';
                   4651:     }
1.268     albertel 4652:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  4653:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 4654:     $title = &mt($title);
                   4655:     $linktext = &mt($linktext);
1.448     albertel 4656:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   4657: 	&help_open_topic('View_recent_activity');
1.208     matthew  4658: }
                   4659: 
1.781     raeburn  4660: sub slot_reservations_link {
                   4661:     my ($linktext,$sname,$sdom,$target) = @_;
                   4662:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   4663:     my $title = 'View slot reservation history';
                   4664:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   4665:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   4666:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   4667:         $title .= ' of this student';
                   4668:     }
                   4669:     if (defined($target) && $target !~ /^\s*$/) {
                   4670:         $target = qq{target="$target"};
                   4671:     } else {
                   4672:         $target = '';
                   4673:     }
                   4674:     $title = &mt($title);
                   4675:     $linktext = &mt($linktext);
                   4676:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   4677: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   4678: 
                   4679: }
                   4680: 
1.508     www      4681: # ===================================================== Display a student photo
                   4682: 
                   4683: 
1.509     albertel 4684: sub student_image_tag {
1.508     www      4685:     my ($domain,$user)=@_;
                   4686:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   4687:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   4688: 	return '<img src="'.$imgsrc.'" align="right" />';
                   4689:     } else {
                   4690: 	return '';
                   4691:     }
                   4692: }
                   4693: 
1.112     bowersj2 4694: =pod
                   4695: 
                   4696: =back
                   4697: 
                   4698: =head1 Access .tab File Data
                   4699: 
                   4700: =over 4
                   4701: 
1.648     raeburn  4702: =item * &languageids() 
1.112     bowersj2 4703: 
                   4704: returns list of all language ids
                   4705: 
                   4706: =cut
                   4707: 
1.14      harris41 4708: sub languageids {
1.16      harris41 4709:     return sort(keys(%language));
1.14      harris41 4710: }
                   4711: 
1.112     bowersj2 4712: =pod
                   4713: 
1.648     raeburn  4714: =item * &languagedescription() 
1.112     bowersj2 4715: 
                   4716: returns description of a specified language id
                   4717: 
                   4718: =cut
                   4719: 
1.14      harris41 4720: sub languagedescription {
1.125     www      4721:     my $code=shift;
                   4722:     return  ($supported_language{$code}?'* ':'').
                   4723:             $language{$code}.
1.126     www      4724: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      4725: }
                   4726: 
1.1048    foxr     4727: =pod
                   4728: 
                   4729: =item * &plainlanguagedescription
                   4730: 
                   4731: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
                   4732: and the language character encoding (e.g. ISO) separated by a ' - ' string.
                   4733: 
                   4734: =cut
                   4735: 
1.145     www      4736: sub plainlanguagedescription {
                   4737:     my $code=shift;
                   4738:     return $language{$code};
                   4739: }
                   4740: 
1.1048    foxr     4741: =pod
                   4742: 
                   4743: =item * &supportedlanguagecode
                   4744: 
                   4745: Returns the supported language code (e.g. sptutf maps to pt) given a language
                   4746: code.
                   4747: 
                   4748: =cut
                   4749: 
1.145     www      4750: sub supportedlanguagecode {
                   4751:     my $code=shift;
                   4752:     return $supported_language{$code};
1.97      www      4753: }
                   4754: 
1.112     bowersj2 4755: =pod
                   4756: 
1.1048    foxr     4757: =item * &latexlanguage()
                   4758: 
                   4759: Given a language key code returns the correspondnig language to use
                   4760: to select the correct hyphenation on LaTeX printouts.  This is undef if there
                   4761: is no supported hyphenation for the language code.
                   4762: 
                   4763: =cut
                   4764: 
                   4765: sub latexlanguage {
                   4766:     my $code = shift;
                   4767:     return $latex_language{$code};
                   4768: }
                   4769: 
                   4770: =pod
                   4771: 
                   4772: =item * &latexhyphenation()
                   4773: 
                   4774: Same as above but what's supplied is the language as it might be stored
                   4775: in the metadata.
                   4776: 
                   4777: =cut
                   4778: 
                   4779: sub latexhyphenation {
                   4780:     my $key = shift;
                   4781:     return $latex_language_bykey{$key};
                   4782: }
                   4783: 
                   4784: =pod
                   4785: 
1.648     raeburn  4786: =item * &copyrightids() 
1.112     bowersj2 4787: 
                   4788: returns list of all copyrights
                   4789: 
                   4790: =cut
                   4791: 
                   4792: sub copyrightids {
                   4793:     return sort(keys(%cprtag));
                   4794: }
                   4795: 
                   4796: =pod
                   4797: 
1.648     raeburn  4798: =item * &copyrightdescription() 
1.112     bowersj2 4799: 
                   4800: returns description of a specified copyright id
                   4801: 
                   4802: =cut
                   4803: 
                   4804: sub copyrightdescription {
1.166     www      4805:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 4806: }
1.197     matthew  4807: 
                   4808: =pod
                   4809: 
1.648     raeburn  4810: =item * &source_copyrightids() 
1.192     taceyjo1 4811: 
                   4812: returns list of all source copyrights
                   4813: 
                   4814: =cut
                   4815: 
                   4816: sub source_copyrightids {
                   4817:     return sort(keys(%scprtag));
                   4818: }
                   4819: 
                   4820: =pod
                   4821: 
1.648     raeburn  4822: =item * &source_copyrightdescription() 
1.192     taceyjo1 4823: 
                   4824: returns description of a specified source copyright id
                   4825: 
                   4826: =cut
                   4827: 
                   4828: sub source_copyrightdescription {
                   4829:     return &mt($scprtag{shift(@_)});
                   4830: }
1.112     bowersj2 4831: 
                   4832: =pod
                   4833: 
1.648     raeburn  4834: =item * &filecategories() 
1.112     bowersj2 4835: 
                   4836: returns list of all file categories
                   4837: 
                   4838: =cut
                   4839: 
                   4840: sub filecategories {
                   4841:     return sort(keys(%category_extensions));
                   4842: }
                   4843: 
                   4844: =pod
                   4845: 
1.648     raeburn  4846: =item * &filecategorytypes() 
1.112     bowersj2 4847: 
                   4848: returns list of file types belonging to a given file
                   4849: category
                   4850: 
                   4851: =cut
                   4852: 
                   4853: sub filecategorytypes {
1.356     albertel 4854:     my ($cat) = @_;
1.1248    raeburn  4855:     if (ref($category_extensions{lc($cat)}) eq 'ARRAY') { 
                   4856:         return @{$category_extensions{lc($cat)}};
                   4857:     } else {
                   4858:         return ();
                   4859:     }
1.112     bowersj2 4860: }
                   4861: 
                   4862: =pod
                   4863: 
1.648     raeburn  4864: =item * &fileembstyle() 
1.112     bowersj2 4865: 
                   4866: returns embedding style for a specified file type
                   4867: 
                   4868: =cut
                   4869: 
                   4870: sub fileembstyle {
                   4871:     return $fe{lc(shift(@_))};
1.169     www      4872: }
                   4873: 
1.351     www      4874: sub filemimetype {
                   4875:     return $fm{lc(shift(@_))};
                   4876: }
                   4877: 
1.169     www      4878: 
                   4879: sub filecategoryselect {
1.1471    raeburn  4880:     my ($name,$value,$id)=@_;
1.189     matthew  4881:     return &select_form($value,$name,
1.1471    raeburn  4882:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))},
                   4883:                         '','',$id);
1.112     bowersj2 4884: }
                   4885: 
                   4886: =pod
                   4887: 
1.648     raeburn  4888: =item * &filedescription() 
1.112     bowersj2 4889: 
                   4890: returns description for a specified file type
                   4891: 
                   4892: =cut
                   4893: 
                   4894: sub filedescription {
1.188     matthew  4895:     my $file_description = $fd{lc(shift())};
                   4896:     $file_description =~ s:([\[\]]):~$1:g;
                   4897:     return &mt($file_description);
1.112     bowersj2 4898: }
                   4899: 
                   4900: =pod
                   4901: 
1.648     raeburn  4902: =item * &filedescriptionex() 
1.112     bowersj2 4903: 
                   4904: returns description for a specified file type with
                   4905: extra formatting
                   4906: 
                   4907: =cut
                   4908: 
                   4909: sub filedescriptionex {
                   4910:     my $ex=shift;
1.188     matthew  4911:     my $file_description = $fd{lc($ex)};
                   4912:     $file_description =~ s:([\[\]]):~$1:g;
                   4913:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 4914: }
                   4915: 
                   4916: # End of .tab access
                   4917: =pod
                   4918: 
                   4919: =back
                   4920: 
                   4921: =cut
                   4922: 
                   4923: # ------------------------------------------------------------------ File Types
                   4924: sub fileextensions {
                   4925:     return sort(keys(%fe));
                   4926: }
                   4927: 
1.97      www      4928: # ----------------------------------------------------------- Display Languages
                   4929: # returns a hash with all desired display languages
                   4930: #
                   4931: 
                   4932: sub display_languages {
                   4933:     my %languages=();
1.695     raeburn  4934:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 4935: 	$languages{$lang}=1;
1.97      www      4936:     }
                   4937:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 4938:     if ($env{'form.displaylanguage'}) {
1.356     albertel 4939: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   4940: 	    $languages{$lang}=1;
1.97      www      4941:         }
                   4942:     }
                   4943:     return %languages;
1.14      harris41 4944: }
                   4945: 
1.582     albertel 4946: sub languages {
                   4947:     my ($possible_langs) = @_;
1.695     raeburn  4948:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 4949:     if (!ref($possible_langs)) {
                   4950: 	if( wantarray ) {
                   4951: 	    return @preferred_langs;
                   4952: 	} else {
                   4953: 	    return $preferred_langs[0];
                   4954: 	}
                   4955:     }
                   4956:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   4957:     my @preferred_possibilities;
                   4958:     foreach my $preferred_lang (@preferred_langs) {
                   4959: 	if (exists($possibilities{$preferred_lang})) {
                   4960: 	    push(@preferred_possibilities, $preferred_lang);
                   4961: 	}
                   4962:     }
                   4963:     if( wantarray ) {
                   4964: 	return @preferred_possibilities;
                   4965:     }
                   4966:     return $preferred_possibilities[0];
                   4967: }
                   4968: 
1.742     raeburn  4969: sub user_lang {
                   4970:     my ($touname,$toudom,$fromcid) = @_;
                   4971:     my @userlangs;
                   4972:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   4973:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   4974:                     $env{'course.'.$fromcid.'.languages'}));
                   4975:     } else {
                   4976:         my %langhash = &getlangs($touname,$toudom);
                   4977:         if ($langhash{'languages'} ne '') {
                   4978:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   4979:         } else {
                   4980:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   4981:             if ($domdefs{'lang_def'} ne '') {
                   4982:                 @userlangs = ($domdefs{'lang_def'});
                   4983:             }
                   4984:         }
                   4985:     }
                   4986:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   4987:     my $user_lh = Apache::localize->get_handle(@languages);
                   4988:     return $user_lh;
                   4989: }
                   4990: 
                   4991: 
1.112     bowersj2 4992: ###############################################################
                   4993: ##               Student Answer Attempts                     ##
                   4994: ###############################################################
                   4995: 
                   4996: =pod
                   4997: 
                   4998: =head1 Alternate Problem Views
                   4999: 
                   5000: =over 4
                   5001: 
1.648     raeburn  5002: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1199    raeburn  5003:     $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112     bowersj2 5004: 
                   5005: Return string with previous attempt on problem. Arguments:
                   5006: 
                   5007: =over 4
                   5008: 
                   5009: =item * $symb: Problem, including path
                   5010: 
                   5011: =item * $username: username of the desired student
                   5012: 
                   5013: =item * $domain: domain of the desired student
1.14      harris41 5014: 
1.112     bowersj2 5015: =item * $course: Course ID
1.14      harris41 5016: 
1.112     bowersj2 5017: =item * $getattempt: Leave blank for all attempts, otherwise put
                   5018:     something
1.14      harris41 5019: 
1.112     bowersj2 5020: =item * $regexp: if string matches this regexp, the string will be
                   5021:     sent to $gradesub
1.14      harris41 5022: 
1.112     bowersj2 5023: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 5024: 
1.1199    raeburn  5025: =item * $usec: section of the desired student
                   5026: 
                   5027: =item * $identifier: counter for student (multiple students one problem) or 
                   5028:     problem (one student; whole sequence).
                   5029: 
1.112     bowersj2 5030: =back
1.14      harris41 5031: 
1.112     bowersj2 5032: The output string is a table containing all desired attempts, if any.
1.16      harris41 5033: 
1.112     bowersj2 5034: =cut
1.1       albertel 5035: 
                   5036: sub get_previous_attempt {
1.1199    raeburn  5037:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1       albertel 5038:   my $prevattempts='';
1.43      ng       5039:   no strict 'refs';
1.1       albertel 5040:   if ($symb) {
1.3       albertel 5041:     my (%returnhash)=
                   5042:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 5043:     if ($returnhash{'version'}) {
                   5044:       my %lasthash=();
                   5045:       my $version;
                   5046:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1212    raeburn  5047:         foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
                   5048:             if ($key =~ /\.rawrndseed$/) {
                   5049:                 my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
                   5050:                 $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
                   5051:             } else {
                   5052:                 $lasthash{$key}=$returnhash{$version.':'.$key};
                   5053:             }
1.19      harris41 5054:         }
1.1       albertel 5055:       }
1.596     albertel 5056:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   5057:       $prevattempts.='<th>'.&mt('History').'</th>';
1.1199    raeburn  5058:       my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945     raeburn  5059:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 5060:       foreach my $key (sort(keys(%lasthash))) {
                   5061: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       5062: 	if ($#parts > 0) {
1.31      albertel 5063: 	  my $data=$parts[-1];
1.989     raeburn  5064:           next if ($data eq 'foilorder');
1.31      albertel 5065: 	  pop(@parts);
1.1010    www      5066:           $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.945     raeburn  5067:           if ($data eq 'type') {
                   5068:               unless ($showsurv) {
                   5069:                   my $id = join(',',@parts);
                   5070:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978     raeburn  5071:                   if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                   5072:                       $lasthidden{$ign.'.'.$id} = 1;
                   5073:                   }
1.945     raeburn  5074:               }
1.1199    raeburn  5075:               if ($identifier ne '') {
                   5076:                   my $id = join(',',@parts);
                   5077:                   if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
                   5078:                                                $domain,$username,$usec,undef,$course) =~ /^no/) {
                   5079:                       $hidestatus{$ign.'.'.$id} = 1;
                   5080:                   }
                   5081:               }
                   5082:           } elsif ($data eq 'regrader') {
                   5083:               if (($identifier ne '') && (@parts)) {
1.1200    raeburn  5084:                   my $id = join(',',@parts);
                   5085:                   $regraded{$ign.'.'.$id} = 1;
1.1199    raeburn  5086:               }
1.1010    www      5087:           } 
1.31      albertel 5088: 	} else {
1.41      ng       5089: 	  if ($#parts == 0) {
                   5090: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   5091: 	  } else {
                   5092: 	    $prevattempts.='<th>'.$ign.'</th>';
                   5093: 	  }
1.31      albertel 5094: 	}
1.16      harris41 5095:       }
1.596     albertel 5096:       $prevattempts.=&end_data_table_header_row();
1.40      ng       5097:       if ($getattempt eq '') {
1.1199    raeburn  5098:         my (%solved,%resets,%probstatus);
1.1200    raeburn  5099:         if (($identifier ne '') && (keys(%regraded) > 0)) {
                   5100:             for ($version=1;$version<=$returnhash{'version'};$version++) {
                   5101:                 foreach my $id (keys(%regraded)) {
                   5102:                     if (($returnhash{$version.':'.$id.'.regrader'}) &&
                   5103:                         ($returnhash{$version.':'.$id.'.tries'} eq '') &&
                   5104:                         ($returnhash{$version.':'.$id.'.award'} eq '')) {
                   5105:                         push(@{$resets{$id}},$version);
1.1199    raeburn  5106:                     }
                   5107:                 }
                   5108:             }
1.1200    raeburn  5109:         }
                   5110: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1199    raeburn  5111:             my (@hidden,@unsolved);
1.945     raeburn  5112:             if (%typeparts) {
                   5113:                 foreach my $id (keys(%typeparts)) {
1.1199    raeburn  5114:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || 
                   5115:                         ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945     raeburn  5116:                         push(@hidden,$id);
1.1199    raeburn  5117:                     } elsif ($identifier ne '') {
                   5118:                         unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
                   5119:                                 ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
                   5120:                                 ($hidestatus{$id})) {
1.1200    raeburn  5121:                             next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
1.1199    raeburn  5122:                             if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
                   5123:                                 push(@{$solved{$id}},$version);
                   5124:                             } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
                   5125:                                      (ref($solved{$id}) eq 'ARRAY')) {
                   5126:                                 my $skip;
                   5127:                                 if (ref($resets{$id}) eq 'ARRAY') {
                   5128:                                     foreach my $reset (@{$resets{$id}}) {
                   5129:                                         if ($reset > $solved{$id}[-1]) {
                   5130:                                             $skip=1;
                   5131:                                             last;
                   5132:                                         }
                   5133:                                     }
                   5134:                                 }
                   5135:                                 unless ($skip) {
                   5136:                                     my ($ign,$partslist) = split(/\./,$id,2);
                   5137:                                     push(@unsolved,$partslist);
                   5138:                                 }
                   5139:                             }
                   5140:                         }
1.945     raeburn  5141:                     }
                   5142:                 }
                   5143:             }
                   5144:             $prevattempts.=&start_data_table_row().
1.1199    raeburn  5145:                            '<td>'.&mt('Transaction [_1]',$version);
                   5146:             if (@unsolved) {
                   5147:                 $prevattempts .= '<span class="LC_nobreak"><label>'.
                   5148:                                  '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
                   5149:                                  &mt('Hide').'</label></span>';
                   5150:             }
                   5151:             $prevattempts .= '</td>';
1.945     raeburn  5152:             if (@hidden) {
                   5153:                 foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  5154:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  5155:                     my $hide;
                   5156:                     foreach my $id (@hidden) {
                   5157:                         if ($key =~ /^\Q$id\E/) {
                   5158:                             $hide = 1;
                   5159:                             last;
                   5160:                         }
                   5161:                     }
                   5162:                     if ($hide) {
                   5163:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   5164:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   5165:                             my $value = &format_previous_attempt_value($key,
                   5166:                                              $returnhash{$version.':'.$key});
1.1173    kruse    5167:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
1.945     raeburn  5168:                         } else {
                   5169:                             $prevattempts.='<td>&nbsp;</td>';
                   5170:                         }
                   5171:                     } else {
                   5172:                         if ($key =~ /\./) {
1.1212    raeburn  5173:                             my $value = $returnhash{$version.':'.$key};
                   5174:                             if ($key =~ /\.rndseed$/) {
                   5175:                                 my ($id) = ($key =~ /^(.+)\.[^.]+$/);
                   5176:                                 if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   5177:                                     $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   5178:                                 }
                   5179:                             }
                   5180:                             $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   5181:                                            '&nbsp;</td>';
1.945     raeburn  5182:                         } else {
                   5183:                             $prevattempts.='<td>&nbsp;</td>';
                   5184:                         }
                   5185:                     }
                   5186:                 }
                   5187:             } else {
                   5188: 	        foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  5189:                     next if ($key =~ /\.foilorder$/);
1.1212    raeburn  5190:                     my $value = $returnhash{$version.':'.$key};
                   5191:                     if ($key =~ /\.rndseed$/) {
                   5192:                         my ($id) = ($key =~ /^(.+)\.[^.]+$/);
                   5193:                         if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   5194:                             $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   5195:                         }
                   5196:                     }
                   5197:                     $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   5198:                                    '&nbsp;</td>';
1.945     raeburn  5199: 	        }
                   5200:             }
                   5201: 	    $prevattempts.=&end_data_table_row();
1.40      ng       5202: 	 }
1.1       albertel 5203:       }
1.945     raeburn  5204:       my @currhidden = keys(%lasthidden);
1.596     albertel 5205:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 5206:       foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  5207:           next if ($key =~ /\.foilorder$/);
1.945     raeburn  5208:           if (%typeparts) {
                   5209:               my $hidden;
                   5210:               foreach my $id (@currhidden) {
                   5211:                   if ($key =~ /^\Q$id\E/) {
                   5212:                       $hidden = 1;
                   5213:                       last;
                   5214:                   }
                   5215:               }
                   5216:               if ($hidden) {
                   5217:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   5218:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   5219:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   5220:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   5221:                           $value = &$gradesub($value);
                   5222:                       }
1.1173    kruse    5223:                       $prevattempts.='<td>'. $value.'&nbsp;</td>';
1.945     raeburn  5224:                   } else {
                   5225:                       $prevattempts.='<td>&nbsp;</td>';
                   5226:                   }
                   5227:               } else {
                   5228:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   5229:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   5230:                       $value = &$gradesub($value);
                   5231:                   }
1.1173    kruse    5232:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
1.945     raeburn  5233:               }
                   5234:           } else {
                   5235: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   5236: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   5237:                   $value = &$gradesub($value);
                   5238:               }
1.1173    kruse    5239: 	     $prevattempts.='<td>'.$value.'&nbsp;</td>';
1.945     raeburn  5240:           }
1.16      harris41 5241:       }
1.596     albertel 5242:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 5243:     } else {
1.1305    raeburn  5244:       my $msg;
                   5245:       if ($symb =~ /ext\.tool$/) {
                   5246:           $msg = &mt('No grade passed back.');
                   5247:       } else {
                   5248:           $msg = &mt('Nothing submitted - no attempts.');
                   5249:       }
1.596     albertel 5250:       $prevattempts=
                   5251: 	  &start_data_table().&start_data_table_row().
1.1305    raeburn  5252: 	  '<td>'.$msg.'</td>'.
1.596     albertel 5253: 	  &end_data_table_row().&end_data_table();
1.1       albertel 5254:     }
                   5255:   } else {
1.596     albertel 5256:     $prevattempts=
                   5257: 	  &start_data_table().&start_data_table_row().
                   5258: 	  '<td>'.&mt('No data.').'</td>'.
                   5259: 	  &end_data_table_row().&end_data_table();
1.1       albertel 5260:   }
1.10      albertel 5261: }
                   5262: 
1.581     albertel 5263: sub format_previous_attempt_value {
                   5264:     my ($key,$value) = @_;
1.1011    www      5265:     if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.1173    kruse    5266:         $value = &Apache::lonlocal::locallocaltime($value);
1.581     albertel 5267:     } elsif (ref($value) eq 'ARRAY') {
1.1173    kruse    5268:         $value = &HTML::Entities::encode('('.join(', ', @{ $value }).')','"<>&');
1.988     raeburn  5269:     } elsif ($key =~ /answerstring$/) {
                   5270:         my %answers = &Apache::lonnet::str2hash($value);
1.1173    kruse    5271:         my @answer = %answers;
                   5272:         %answers = map {&HTML::Entities::encode($_, '"<>&')} @answer;
1.988     raeburn  5273:         my @anskeys = sort(keys(%answers));
                   5274:         if (@anskeys == 1) {
                   5275:             my $answer = $answers{$anskeys[0]};
1.1001    raeburn  5276:             if ($answer =~ m{\0}) {
                   5277:                 $answer =~ s{\0}{,}g;
1.988     raeburn  5278:             }
                   5279:             my $tag_internal_answer_name = 'INTERNAL';
                   5280:             if ($anskeys[0] eq $tag_internal_answer_name) {
                   5281:                 $value = $answer; 
                   5282:             } else {
                   5283:                 $value = $anskeys[0].'='.$answer;
                   5284:             }
                   5285:         } else {
                   5286:             foreach my $ans (@anskeys) {
                   5287:                 my $answer = $answers{$ans};
1.1001    raeburn  5288:                 if ($answer =~ m{\0}) {
                   5289:                     $answer =~ s{\0}{,}g;
1.988     raeburn  5290:                 }
                   5291:                 $value .=  $ans.'='.$answer.'<br />';;
                   5292:             } 
                   5293:         }
1.581     albertel 5294:     } else {
1.1173    kruse    5295:         $value = &HTML::Entities::encode(&unescape($value), '"<>&');
1.581     albertel 5296:     }
                   5297:     return $value;
                   5298: }
                   5299: 
                   5300: 
1.107     albertel 5301: sub relative_to_absolute {
                   5302:     my ($url,$output)=@_;
                   5303:     my $parser=HTML::TokeParser->new(\$output);
                   5304:     my $token;
                   5305:     my $thisdir=$url;
                   5306:     my @rlinks=();
                   5307:     while ($token=$parser->get_token) {
                   5308: 	if ($token->[0] eq 'S') {
                   5309: 	    if ($token->[1] eq 'a') {
                   5310: 		if ($token->[2]->{'href'}) {
                   5311: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   5312: 		}
                   5313: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   5314: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   5315: 	    } elsif ($token->[1] eq 'base') {
                   5316: 		$thisdir=$token->[2]->{'href'};
                   5317: 	    }
                   5318: 	}
                   5319:     }
                   5320:     $thisdir=~s-/[^/]*$--;
1.356     albertel 5321:     foreach my $link (@rlinks) {
1.726     raeburn  5322: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 5323: 		($link=~/^\//) ||
                   5324: 		($link=~/^javascript:/i) ||
                   5325: 		($link=~/^mailto:/i) ||
                   5326: 		($link=~/^\#/)) {
                   5327: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   5328: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 5329: 	}
                   5330:     }
                   5331: # -------------------------------------------------- Deal with Applet codebases
                   5332:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   5333:     return $output;
                   5334: }
                   5335: 
1.112     bowersj2 5336: =pod
                   5337: 
1.648     raeburn  5338: =item * &get_student_view()
1.112     bowersj2 5339: 
                   5340: show a snapshot of what student was looking at
                   5341: 
                   5342: =cut
                   5343: 
1.10      albertel 5344: sub get_student_view {
1.186     albertel 5345:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      5346:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 5347:   my (%form);
1.10      albertel 5348:   my @elements=('symb','courseid','domain','username');
                   5349:   foreach my $element (@elements) {
1.186     albertel 5350:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 5351:   }
1.186     albertel 5352:   if (defined($moreenv)) {
                   5353:       %form=(%form,%{$moreenv});
                   5354:   }
1.236     albertel 5355:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 5356:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.1306    raeburn  5357:   if (($feedurl =~ /ext\.tool$/) && ($target eq 'tex')) {
                   5358:       $feedurl =~ s{^/adm/wrapper}{};
                   5359:   }
1.650     www      5360:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 5361:   $userview=~s/\<body[^\>]*\>//gi;
                   5362:   $userview=~s/\<\/body\>//gi;
                   5363:   $userview=~s/\<html\>//gi;
                   5364:   $userview=~s/\<\/html\>//gi;
                   5365:   $userview=~s/\<head\>//gi;
                   5366:   $userview=~s/\<\/head\>//gi;
1.1460    raeburn  5367:   $userview=~s/\Q<div class="LC_landmark" role="main"\E/<div class="LC_landmark"/; 
1.11      albertel 5368:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 5369:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      5370:   if (wantarray) {
                   5371:      return ($userview,$response);
                   5372:   } else {
                   5373:      return $userview;
                   5374:   }
                   5375: }
                   5376: 
                   5377: sub get_student_view_with_retries {
                   5378:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   5379: 
                   5380:     my $ok = 0;                 # True if we got a good response.
                   5381:     my $content;
                   5382:     my $response;
                   5383: 
                   5384:     # Try to get the student_view done. within the retries count:
                   5385:     
                   5386:     do {
                   5387:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   5388:          $ok      = $response->is_success;
                   5389:          if (!$ok) {
                   5390:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   5391:          }
                   5392:          $retries--;
                   5393:     } while (!$ok && ($retries > 0));
                   5394:     
                   5395:     if (!$ok) {
                   5396:        $content = '';          # On error return an empty content.
                   5397:     }
1.651     www      5398:     if (wantarray) {
                   5399:        return ($content, $response);
                   5400:     } else {
                   5401:        return $content;
                   5402:     }
1.11      albertel 5403: }
                   5404: 
1.1349    raeburn  5405: sub css_links {
                   5406:     my ($currsymb,$level) = @_;
                   5407:     my ($links,@symbs,%cssrefs,%httpref);
                   5408:     if ($level eq 'map') {
                   5409:         my $navmap = Apache::lonnavmaps::navmap->new();
                   5410:         if (ref($navmap)) {
                   5411:             my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
                   5412:             my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
                   5413:             foreach my $res (@resources) {
                   5414:                 if (ref($res) && $res->symb()) {
                   5415:                     push(@symbs,$res->symb());
                   5416:                 }
                   5417:             }
                   5418:         }
                   5419:     } else {
                   5420:         @symbs = ($currsymb);
                   5421:     }
                   5422:     foreach my $symb (@symbs) {
                   5423:         my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
                   5424:         if ($css_href =~ /\S/) {
                   5425:             unless ($css_href =~ m{https?://}) {
                   5426:                 my $url = (&Apache::lonnet::decode_symb($symb))[-1];
                   5427:                 my $proburl =  &Apache::lonnet::clutter($url);
                   5428:                 my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
                   5429:                 unless ($css_href =~ m{^/}) {
                   5430:                     $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
                   5431:                 }
                   5432:                 if ($css_href =~ m{^/(res|uploaded)/}) {
                   5433:                     unless (($httpref{'httpref.'.$css_href}) ||
                   5434:                             (&Apache::lonnet::is_on_map($css_href))) {
                   5435:                         my $thisurl = $proburl;
                   5436:                         if ($env{'httpref.'.$proburl}) {
                   5437:                             $thisurl = $env{'httpref.'.$proburl};
                   5438:                         }
                   5439:                         $httpref{'httpref.'.$css_href} = $thisurl;
                   5440:                     }
                   5441:                 }
                   5442:             }
                   5443:             $cssrefs{$css_href} = 1;
                   5444:         }
                   5445:     }
                   5446:     if (keys(%httpref)) {
                   5447:         &Apache::lonnet::appenv(\%httpref);
                   5448:     }
                   5449:     if (keys(%cssrefs)) {
                   5450:         foreach my $css_href (keys(%cssrefs)) {
                   5451:             next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
                   5452:             $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
                   5453:         }
                   5454:     }
                   5455:     return $links;
                   5456: }
                   5457: 
1.112     bowersj2 5458: =pod
                   5459: 
1.648     raeburn  5460: =item * &get_student_answers() 
1.112     bowersj2 5461: 
                   5462: show a snapshot of how student was answering problem
                   5463: 
                   5464: =cut
                   5465: 
1.11      albertel 5466: sub get_student_answers {
1.100     sakharuk 5467:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      5468:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 5469:   my (%moreenv);
1.11      albertel 5470:   my @elements=('symb','courseid','domain','username');
                   5471:   foreach my $element (@elements) {
1.186     albertel 5472:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 5473:   }
1.186     albertel 5474:   $moreenv{'grade_target'}='answer';
                   5475:   %moreenv=(%form,%moreenv);
1.497     raeburn  5476:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   5477:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 5478:   return $userview;
1.1       albertel 5479: }
1.116     albertel 5480: 
                   5481: =pod
                   5482: 
                   5483: =item * &submlink()
                   5484: 
1.242     albertel 5485: Inputs: $text $uname $udom $symb $target
1.116     albertel 5486: 
                   5487: Returns: A link to grades.pm such as to see the SUBM view of a student
                   5488: 
                   5489: =cut
                   5490: 
                   5491: ###############################################
                   5492: sub submlink {
1.242     albertel 5493:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 5494:     if (!($uname && $udom)) {
                   5495: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 5496: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 5497: 	if (!$symb) { $symb=$cursymb; }
                   5498:     }
1.254     matthew  5499:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      5500:     $symb=&escape($symb);
1.960     bisitz   5501:     if ($target) { $target=" target=\"$target\""; }
                   5502:     return
                   5503:         '<a href="/adm/grades?command=submission'.
                   5504:         '&amp;symb='.$symb.
                   5505:         '&amp;student='.$uname.
                   5506:         '&amp;userdom='.$udom.'"'.
                   5507:         $target.'>'.$text.'</a>';
1.242     albertel 5508: }
                   5509: ##############################################
                   5510: 
                   5511: =pod
                   5512: 
                   5513: =item * &pgrdlink()
                   5514: 
                   5515: Inputs: $text $uname $udom $symb $target
                   5516: 
                   5517: Returns: A link to grades.pm such as to see the PGRD view of a student
                   5518: 
                   5519: =cut
                   5520: 
                   5521: ###############################################
                   5522: sub pgrdlink {
                   5523:     my $link=&submlink(@_);
                   5524:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   5525:     return $link;
                   5526: }
                   5527: ##############################################
                   5528: 
                   5529: =pod
                   5530: 
                   5531: =item * &pprmlink()
                   5532: 
                   5533: Inputs: $text $uname $udom $symb $target
                   5534: 
                   5535: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 5536: student and a specific resource
1.242     albertel 5537: 
                   5538: =cut
                   5539: 
                   5540: ###############################################
                   5541: sub pprmlink {
                   5542:     my ($text,$uname,$udom,$symb,$target)=@_;
                   5543:     if (!($uname && $udom)) {
                   5544: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 5545: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 5546: 	if (!$symb) { $symb=$cursymb; }
                   5547:     }
1.254     matthew  5548:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      5549:     $symb=&escape($symb);
1.242     albertel 5550:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 5551:     return '<a href="/adm/parmset?command=set&amp;'.
                   5552: 	'symb='.$symb.'&amp;uname='.$uname.
                   5553: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 5554: }
                   5555: ##############################################
1.37      matthew  5556: 
1.112     bowersj2 5557: =pod
                   5558: 
                   5559: =back
                   5560: 
                   5561: =cut
                   5562: 
1.37      matthew  5563: ###############################################
1.51      www      5564: 
                   5565: 
                   5566: sub timehash {
1.687     raeburn  5567:     my ($thistime) = @_;
                   5568:     my $timezone = &Apache::lonlocal::gettimezone();
                   5569:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   5570:                      ->set_time_zone($timezone);
                   5571:     my $wday = $dt->day_of_week();
                   5572:     if ($wday == 7) { $wday = 0; }
                   5573:     return ( 'second' => $dt->second(),
                   5574:              'minute' => $dt->minute(),
                   5575:              'hour'   => $dt->hour(),
                   5576:              'day'     => $dt->day_of_month(),
                   5577:              'month'   => $dt->month(),
                   5578:              'year'    => $dt->year(),
                   5579:              'weekday' => $wday,
                   5580:              'dayyear' => $dt->day_of_year(),
                   5581:              'dlsav'   => $dt->is_dst() );
1.51      www      5582: }
                   5583: 
1.370     www      5584: sub utc_string {
                   5585:     my ($date)=@_;
1.371     www      5586:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      5587: }
                   5588: 
1.51      www      5589: sub maketime {
                   5590:     my %th=@_;
1.687     raeburn  5591:     my ($epoch_time,$timezone,$dt);
                   5592:     $timezone = &Apache::lonlocal::gettimezone();
                   5593:     eval {
                   5594:         $dt = DateTime->new( year   => $th{'year'},
                   5595:                              month  => $th{'month'},
                   5596:                              day    => $th{'day'},
                   5597:                              hour   => $th{'hour'},
                   5598:                              minute => $th{'minute'},
                   5599:                              second => $th{'second'},
                   5600:                              time_zone => $timezone,
                   5601:                          );
                   5602:     };
                   5603:     if (!$@) {
                   5604:         $epoch_time = $dt->epoch;
                   5605:         if ($epoch_time) {
                   5606:             return $epoch_time;
                   5607:         }
                   5608:     }
1.51      www      5609:     return POSIX::mktime(
                   5610:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      5611:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      5612: }
                   5613: 
                   5614: #########################################
1.51      www      5615: 
                   5616: sub findallcourses {
1.482     raeburn  5617:     my ($roles,$uname,$udom) = @_;
1.355     albertel 5618:     my %roles;
                   5619:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 5620:     my %courses;
1.51      www      5621:     my $now=time;
1.482     raeburn  5622:     if (!defined($uname)) {
                   5623:         $uname = $env{'user.name'};
                   5624:     }
                   5625:     if (!defined($udom)) {
                   5626:         $udom = $env{'user.domain'};
                   5627:     }
                   5628:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073    raeburn  5629:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482     raeburn  5630:         if (!%roles) {
                   5631:             %roles = (
                   5632:                        cc => 1,
1.907     raeburn  5633:                        co => 1,
1.482     raeburn  5634:                        in => 1,
                   5635:                        ep => 1,
                   5636:                        ta => 1,
                   5637:                        cr => 1,
                   5638:                        st => 1,
                   5639:              );
                   5640:         }
                   5641:         foreach my $entry (keys(%roleshash)) {
                   5642:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   5643:             if ($trole =~ /^cr/) { 
                   5644:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   5645:             } else {
                   5646:                 next if (!exists($roles{$trole}));
                   5647:             }
                   5648:             if ($tend) {
                   5649:                 next if ($tend < $now);
                   5650:             }
                   5651:             if ($tstart) {
                   5652:                 next if ($tstart > $now);
                   5653:             }
1.1058    raeburn  5654:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482     raeburn  5655:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058    raeburn  5656:             my $value = $trole.'/'.$cdom.'/';
1.482     raeburn  5657:             if ($secpart eq '') {
                   5658:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   5659:                 $sec = 'none';
1.1058    raeburn  5660:                 $value .= $cnum.'/';
1.482     raeburn  5661:             } else {
                   5662:                 $cnum = $cnumpart;
                   5663:                 ($sec,$role) = split(/_/,$secpart);
1.1058    raeburn  5664:                 $value .= $cnum.'/'.$sec;
                   5665:             }
                   5666:             if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   5667:                 unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   5668:                     push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   5669:                 }
                   5670:             } else {
                   5671:                 @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490     raeburn  5672:             }
1.482     raeburn  5673:         }
                   5674:     } else {
                   5675:         foreach my $key (keys(%env)) {
1.483     albertel 5676: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   5677:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  5678: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   5679: 	        next if ($role eq 'ca' || $role eq 'aa');
                   5680: 	        next if (%roles && !exists($roles{$role}));
                   5681: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   5682:                 my $active=1;
                   5683:                 if ($starttime) {
                   5684: 		    if ($now<$starttime) { $active=0; }
                   5685:                 }
                   5686:                 if ($endtime) {
                   5687:                     if ($now>$endtime) { $active=0; }
                   5688:                 }
                   5689:                 if ($active) {
1.1058    raeburn  5690:                     my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482     raeburn  5691:                     if ($sec eq '') {
                   5692:                         $sec = 'none';
1.1058    raeburn  5693:                     } else {
                   5694:                         $value .= $sec;
                   5695:                     }
                   5696:                     if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   5697:                         unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   5698:                             push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   5699:                         }
                   5700:                     } else {
                   5701:                         @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482     raeburn  5702:                     }
1.474     raeburn  5703:                 }
                   5704:             }
1.51      www      5705:         }
                   5706:     }
1.474     raeburn  5707:     return %courses;
1.51      www      5708: }
1.37      matthew  5709: 
1.54      www      5710: ###############################################
1.474     raeburn  5711: 
                   5712: sub blockcheck {
1.1372    raeburn  5713:     my ($setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
                   5714:     unless (($activity eq 'docs') || ($activity eq 'reinit') || ($activity eq 'alert')) {
                   5715:         my ($has_evb,$check_ipaccess);
                   5716:         my $dom = $env{'user.domain'};
                   5717:         if ($env{'request.course.id'}) {
                   5718:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   5719:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   5720:             my $checkrole = "cm./$cdom/$cnum";
                   5721:             my $sec = $env{'request.course.sec'};
                   5722:             if ($sec ne '') {
                   5723:                 $checkrole .= "/$sec";
                   5724:             }
                   5725:             if ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   5726:                 ($env{'request.role'} !~ /^st/)) {
                   5727:                 $has_evb = 1;
                   5728:             }
                   5729:             unless ($has_evb) {
                   5730:                 if (($activity eq 'printout') || ($activity eq 'grades') || ($activity eq 'search') ||
1.1444    raeburn  5731:                     ($activity eq 'index') || ($activity eq 'boards') || ($activity eq 'groups') || 
                   5732:                     ($activity eq 'chat')) {
1.1372    raeburn  5733:                     if ($udom eq $cdom) {
                   5734:                         $check_ipaccess = 1;
                   5735:                     }
                   5736:                 }
                   5737:             }
1.1375    raeburn  5738:         } elsif (($activity eq 'com') || ($activity eq 'port') || ($activity eq 'blogs') ||
                   5739:                 ($activity eq 'about') || ($activity eq 'wishlist') || ($activity eq 'passwd')) {
                   5740:             my $checkrole;
                   5741:             if ($env{'request.role.domain'} eq '') {
                   5742:                 $checkrole = "cm./$env{'user.domain'}/";
                   5743:             } else {
                   5744:                 $checkrole = "cm./$env{'request.role.domain'}/";
                   5745:             }
                   5746:             if (($checkrole) && (&Apache::lonnet::allowed('evb',undef,undef,$checkrole))) {
                   5747:                 $has_evb = 1;
                   5748:             }
1.1372    raeburn  5749:         }
                   5750:         unless ($has_evb || $check_ipaccess) {
                   5751:             my @machinedoms = &Apache::lonnet::current_machine_domains();
                   5752:             if (($dom eq 'public') && ($activity eq 'port')) {
                   5753:                 $dom = $udom;
                   5754:             }
                   5755:             if (($dom ne '') && (grep(/^\Q$dom\E$/,@machinedoms))) {
                   5756:                 $check_ipaccess = 1;
                   5757:             } else {
                   5758:                 my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   5759:                 my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
                   5760:                 my $prim = &Apache::lonnet::domain($dom,'primary');
                   5761:                 my $intdom = &Apache::lonnet::internet_dom($prim);
                   5762:                 if (($intdom ne '') && (ref($internet_names) eq 'ARRAY')) {
                   5763:                     if (grep(/^\Q$intdom\E$/,@{$internet_names})) {
                   5764:                         $check_ipaccess = 1;
                   5765:                     }
                   5766:                 }
                   5767:             }
                   5768:         }
                   5769:         if ($check_ipaccess) {
                   5770:             my ($ipaccessref,$cached)=&Apache::lonnet::is_cached_new('ipaccess',$dom);
                   5771:             unless (defined($cached)) {
                   5772:                 my %domconfig =
                   5773:                     &Apache::lonnet::get_dom('configuration',['ipaccess'],$dom);
                   5774:                 $ipaccessref = &Apache::lonnet::do_cache_new('ipaccess',$dom,$domconfig{'ipaccess'},1800);
                   5775:             }
                   5776:             if ((ref($ipaccessref) eq 'HASH') && ($clientip)) {
                   5777:                 foreach my $id (keys(%{$ipaccessref})) {
                   5778:                     if (ref($ipaccessref->{$id}) eq 'HASH') {
                   5779:                         my $range = $ipaccessref->{$id}->{'ip'};
                   5780:                         if ($range) {
                   5781:                             if (&Apache::lonnet::ip_match($clientip,$range)) {
                   5782:                                 if (ref($ipaccessref->{$id}->{'commblocks'}) eq 'HASH') {
                   5783:                                     if ($ipaccessref->{$id}->{'commblocks'}->{$activity} eq 'on') {
                   5784:                                         return ('','','',$id,$dom);
                   5785:                                         last;
                   5786:                                     }
                   5787:                                 }
                   5788:                             }
                   5789:                         }
                   5790:                     }
                   5791:                 }
                   5792:             }
                   5793:         }
1.1373    raeburn  5794:         if (($activity eq 'wishlist') || ($activity eq 'annotate')) {
                   5795:             return ();
                   5796:         }
1.1372    raeburn  5797:     }
1.1189    raeburn  5798:     if (defined($udom) && defined($uname)) {
                   5799:         # If uname and udom are for a course, check for blocks in the course.
                   5800:         if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
                   5801:             my ($startblock,$endblock,$triggerblock) =
1.1347    raeburn  5802:                 &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1189    raeburn  5803:             return ($startblock,$endblock,$triggerblock);
                   5804:         }
                   5805:     } else {
1.490     raeburn  5806:         $udom = $env{'user.domain'};
                   5807:         $uname = $env{'user.name'};
                   5808:     }
                   5809: 
1.502     raeburn  5810:     my $startblock = 0;
                   5811:     my $endblock = 0;
1.1062    raeburn  5812:     my $triggerblock = '';
1.1373    raeburn  5813:     my %live_courses;
                   5814:     unless (($activity eq 'wishlist') || ($activity eq 'annotate')) {
                   5815:         %live_courses = &findallcourses(undef,$uname,$udom);
                   5816:     }
1.474     raeburn  5817: 
1.490     raeburn  5818:     # If uname is for a user, and activity is course-specific, i.e.,
                   5819:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  5820: 
1.490     raeburn  5821:     if (($activity eq 'boards' || $activity eq 'chat' ||
1.1282    raeburn  5822:          $activity eq 'groups' || $activity eq 'printout' ||
1.1444    raeburn  5823:          $activity eq 'search' || $activity eq 'index' ||
                   5824:          $activity eq 'reinit' || $activity eq 'alert') &&
1.1189    raeburn  5825:         ($env{'request.course.id'})) {
1.490     raeburn  5826:         foreach my $key (keys(%live_courses)) {
                   5827:             if ($key ne $env{'request.course.id'}) {
                   5828:                 delete($live_courses{$key});
                   5829:             }
                   5830:         }
                   5831:     }
                   5832: 
                   5833:     my $otheruser = 0;
                   5834:     my %own_courses;
                   5835:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   5836:         # Resource belongs to user other than current user.
                   5837:         $otheruser = 1;
                   5838:         # Gather courses for current user
                   5839:         %own_courses = 
                   5840:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   5841:     }
                   5842: 
                   5843:     # Gather active course roles - course coordinator, instructor, 
                   5844:     # exam proctor, ta, student, or custom role.
1.474     raeburn  5845: 
                   5846:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  5847:         my ($cdom,$cnum);
                   5848:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   5849:             $cdom = $env{'course.'.$course.'.domain'};
                   5850:             $cnum = $env{'course.'.$course.'.num'};
                   5851:         } else {
1.490     raeburn  5852:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  5853:         }
                   5854:         my $no_ownblock = 0;
                   5855:         my $no_userblock = 0;
1.533     raeburn  5856:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  5857:             # Check if current user has 'evb' priv for this
                   5858:             if (defined($own_courses{$course})) {
                   5859:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   5860:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   5861:                     if ($sec ne 'none') {
                   5862:                         $checkrole .= '/'.$sec;
                   5863:                     }
                   5864:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   5865:                         $no_ownblock = 1;
                   5866:                         last;
                   5867:                     }
                   5868:                 }
                   5869:             }
                   5870:             # if they have 'evb' priv and are currently not playing student
                   5871:             next if (($no_ownblock) &&
                   5872:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   5873:         }
1.474     raeburn  5874:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  5875:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  5876:             if ($sec ne 'none') {
1.482     raeburn  5877:                 $checkrole .= '/'.$sec;
1.474     raeburn  5878:             }
1.490     raeburn  5879:             if ($otheruser) {
                   5880:                 # Resource belongs to user other than current user.
                   5881:                 # Assemble privs for that user, and check for 'evb' priv.
1.1058    raeburn  5882:                 my (%allroles,%userroles);
                   5883:                 if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
                   5884:                     foreach my $entry (@{$live_courses{$course}{$sec}}) { 
                   5885:                         my ($trole,$tdom,$tnum,$tsec);
                   5886:                         if ($entry =~ /^cr/) {
                   5887:                             ($trole,$tdom,$tnum,$tsec) = 
                   5888:                                 ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   5889:                         } else {
                   5890:                            ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   5891:                         }
                   5892:                         my ($spec,$area,$trest);
                   5893:                         $area = '/'.$tdom.'/'.$tnum;
                   5894:                         $trest = $tnum;
                   5895:                         if ($tsec ne '') {
                   5896:                             $area .= '/'.$tsec;
                   5897:                             $trest .= '/'.$tsec;
                   5898:                         }
                   5899:                         $spec = $trole.'.'.$area;
                   5900:                         if ($trole =~ /^cr/) {
                   5901:                             &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   5902:                                                               $tdom,$spec,$trest,$area);
                   5903:                         } else {
                   5904:                             &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   5905:                                                                 $tdom,$spec,$trest,$area);
                   5906:                         }
                   5907:                     }
1.1276    raeburn  5908:                     my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058    raeburn  5909:                     if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   5910:                         if ($1) {
                   5911:                             $no_userblock = 1;
                   5912:                             last;
                   5913:                         }
1.486     raeburn  5914:                     }
                   5915:                 }
1.490     raeburn  5916:             } else {
                   5917:                 # Resource belongs to current user
                   5918:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  5919:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   5920:                     $no_ownblock = 1;
                   5921:                     last;
                   5922:                 }
1.474     raeburn  5923:             }
                   5924:         }
                   5925:         # if they have the evb priv and are currently not playing student
1.482     raeburn  5926:         next if (($no_ownblock) &&
1.491     albertel 5927:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  5928:         next if ($no_userblock);
1.474     raeburn  5929: 
1.1303    raeburn  5930:         # Retrieve blocking times and identity of blocker for course
1.490     raeburn  5931:         # of specified user, unless user has 'evb' privilege.
1.1284    raeburn  5932: 
1.1062    raeburn  5933:         my ($start,$end,$trigger) = 
1.1347    raeburn  5934:             &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502     raeburn  5935:         if (($start != 0) && 
                   5936:             (($startblock == 0) || ($startblock > $start))) {
                   5937:             $startblock = $start;
1.1062    raeburn  5938:             if ($trigger ne '') {
                   5939:                 $triggerblock = $trigger;
                   5940:             }
1.502     raeburn  5941:         }
                   5942:         if (($end != 0)  &&
                   5943:             (($endblock == 0) || ($endblock < $end))) {
                   5944:             $endblock = $end;
1.1062    raeburn  5945:             if ($trigger ne '') {
                   5946:                 $triggerblock = $trigger;
                   5947:             }
1.502     raeburn  5948:         }
1.490     raeburn  5949:     }
1.1062    raeburn  5950:     return ($startblock,$endblock,$triggerblock);
1.490     raeburn  5951: }
                   5952: 
                   5953: sub get_blocks {
1.1347    raeburn  5954:     my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490     raeburn  5955:     my $startblock = 0;
                   5956:     my $endblock = 0;
1.1062    raeburn  5957:     my $triggerblock = '';
1.490     raeburn  5958:     my $course = $cdom.'_'.$cnum;
                   5959:     $setters->{$course} = {};
                   5960:     $setters->{$course}{'staff'} = [];
                   5961:     $setters->{$course}{'times'} = [];
1.1062    raeburn  5962:     $setters->{$course}{'triggers'} = [];
                   5963:     my (@blockers,%triggered);
                   5964:     my $now = time;
                   5965:     my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
                   5966:     if ($activity eq 'docs') {
1.1348    raeburn  5967:         my ($blocked,$nosymbcache,$noenccheck);
1.1347    raeburn  5968:         if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
                   5969:             $blocked = 1;
                   5970:             $nosymbcache = 1;
1.1348    raeburn  5971:             $noenccheck = 1;
1.1347    raeburn  5972:         }
1.1348    raeburn  5973:         @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062    raeburn  5974:         foreach my $block (@blockers) {
                   5975:             if ($block =~ /^firstaccess____(.+)$/) {
                   5976:                 my $item = $1;
                   5977:                 my $type = 'map';
                   5978:                 my $timersymb = $item;
                   5979:                 if ($item eq 'course') {
                   5980:                     $type = 'course';
                   5981:                 } elsif ($item =~ /___\d+___/) {
                   5982:                     $type = 'resource';
                   5983:                 } else {
                   5984:                     $timersymb = &Apache::lonnet::symbread($item);
                   5985:                 }
                   5986:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   5987:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
                   5988:                 $triggered{$block} = {
                   5989:                                        start => $start,
                   5990:                                        end   => $end,
                   5991:                                        type  => $type,
                   5992:                                      };
                   5993:             }
                   5994:         }
                   5995:     } else {
                   5996:         foreach my $block (keys(%commblocks)) {
                   5997:             if ($block =~ m/^(\d+)____(\d+)$/) { 
                   5998:                 my ($start,$end) = ($1,$2);
                   5999:                 if ($start <= time && $end >= time) {
                   6000:                     if (ref($commblocks{$block}) eq 'HASH') {
                   6001:                         if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   6002:                             if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   6003:                                 unless(grep(/^\Q$block\E$/,@blockers)) {
                   6004:                                     push(@blockers,$block);
                   6005:                                 }
                   6006:                             }
                   6007:                         }
                   6008:                     }
                   6009:                 }
                   6010:             } elsif ($block =~ /^firstaccess____(.+)$/) {
                   6011:                 my $item = $1;
                   6012:                 my $timersymb = $item; 
                   6013:                 my $type = 'map';
                   6014:                 if ($item eq 'course') {
                   6015:                     $type = 'course';
                   6016:                 } elsif ($item =~ /___\d+___/) {
                   6017:                     $type = 'resource';
                   6018:                 } else {
                   6019:                     $timersymb = &Apache::lonnet::symbread($item);
                   6020:                 }
                   6021:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   6022:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb}; 
                   6023:                 if ($start && $end) {
                   6024:                     if (($start <= time) && ($end >= time)) {
1.1281    raeburn  6025:                         if (ref($commblocks{$block}) eq 'HASH') {
                   6026:                             if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   6027:                                 if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   6028:                                     unless(grep(/^\Q$block\E$/,@blockers)) {
                   6029:                                         push(@blockers,$block);
                   6030:                                         $triggered{$block} = {
                   6031:                                                                start => $start,
                   6032:                                                                end   => $end,
                   6033:                                                                type  => $type,
                   6034:                                                              };
                   6035:                                     }
                   6036:                                 }
                   6037:                             }
1.1062    raeburn  6038:                         }
                   6039:                     }
1.490     raeburn  6040:                 }
1.1062    raeburn  6041:             }
                   6042:         }
                   6043:     }
                   6044:     foreach my $blocker (@blockers) {
                   6045:         my ($staff_name,$staff_dom,$title,$blocks) =
                   6046:             &parse_block_record($commblocks{$blocker});
                   6047:         push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   6048:         my ($start,$end,$triggertype);
                   6049:         if ($blocker =~ m/^(\d+)____(\d+)$/) {
                   6050:             ($start,$end) = ($1,$2);
                   6051:         } elsif (ref($triggered{$blocker}) eq 'HASH') {
                   6052:             $start = $triggered{$blocker}{'start'};
                   6053:             $end = $triggered{$blocker}{'end'};
                   6054:             $triggertype = $triggered{$blocker}{'type'};
                   6055:         }
                   6056:         if ($start) {
                   6057:             push(@{$$setters{$course}{'times'}}, [$start,$end]);
                   6058:             if ($triggertype) {
                   6059:                 push(@{$$setters{$course}{'triggers'}},$triggertype);
                   6060:             } else {
                   6061:                 push(@{$$setters{$course}{'triggers'}},0);
                   6062:             }
                   6063:             if ( ($startblock == 0) || ($startblock > $start) ) {
                   6064:                 $startblock = $start;
                   6065:                 if ($triggertype) {
                   6066:                     $triggerblock = $blocker;
1.474     raeburn  6067:                 }
                   6068:             }
1.1062    raeburn  6069:             if ( ($endblock == 0) || ($endblock < $end) ) {
                   6070:                $endblock = $end;
                   6071:                if ($triggertype) {
                   6072:                    $triggerblock = $blocker;
                   6073:                }
                   6074:             }
1.474     raeburn  6075:         }
                   6076:     }
1.1062    raeburn  6077:     return ($startblock,$endblock,$triggerblock);
1.474     raeburn  6078: }
                   6079: 
                   6080: sub parse_block_record {
                   6081:     my ($record) = @_;
                   6082:     my ($setuname,$setudom,$title,$blocks);
                   6083:     if (ref($record) eq 'HASH') {
                   6084:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   6085:         $title = &unescape($record->{'event'});
                   6086:         $blocks = $record->{'blocks'};
                   6087:     } else {
                   6088:         my @data = split(/:/,$record,3);
                   6089:         if (scalar(@data) eq 2) {
                   6090:             $title = $data[1];
                   6091:             ($setuname,$setudom) = split(/@/,$data[0]);
                   6092:         } else {
                   6093:             ($setuname,$setudom,$title) = @data;
                   6094:         }
                   6095:         $blocks = { 'com' => 'on' };
                   6096:     }
                   6097:     return ($setuname,$setudom,$title,$blocks);
                   6098: }
                   6099: 
1.854     kalberla 6100: sub blocking_status {
1.1372    raeburn  6101:     my ($activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061    raeburn  6102:     my %setters;
1.890     droeschl 6103: 
1.1061    raeburn  6104: # check for active blocking
1.1372    raeburn  6105:     if ($clientip eq '') {
                   6106:         $clientip = &Apache::lonnet::get_requestor_ip();
                   6107:     }
                   6108:     my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) = 
                   6109:         &blockcheck(\%setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062    raeburn  6110:     my $blocked = 0;
1.1372    raeburn  6111:     if (($startblock && $endblock) || ($by_ip)) {
1.1062    raeburn  6112:         $blocked = 1;
                   6113:     }
1.890     droeschl 6114: 
1.1061    raeburn  6115: # caller just wants to know whether a block is active
                   6116:     if (!wantarray) { return $blocked; }
                   6117: 
                   6118: # build a link to a popup window containing the details
                   6119:     my $querystring  = "?activity=$activity";
1.1351    raeburn  6120: # $uname and $udom decide whose portfolio (or information page) the user is trying to look at
                   6121:     if (($activity eq 'port') || ($activity eq 'about') || ($activity eq 'passwd')) {
1.1232    raeburn  6122:         $querystring .= "&amp;udom=$udom"      if ($udom =~ /^$match_domain$/); 
                   6123:         $querystring .= "&amp;uname=$uname"    if ($uname =~ /^$match_username$/);
1.1062    raeburn  6124:     } elsif ($activity eq 'docs') {
1.1347    raeburn  6125:         my $showurl = &Apache::lonenc::check_encrypt($url);
                   6126:         $querystring .= '&amp;url='.&HTML::Entities::encode($showurl,'\'&"<>');
                   6127:         if ($symb) {
                   6128:             my $showsymb = &Apache::lonenc::check_encrypt($symb);
                   6129:             $querystring .= '&amp;symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
                   6130:         }
1.1062    raeburn  6131:     }
1.1061    raeburn  6132: 
                   6133:     my $output .= <<'END_MYBLOCK';
                   6134: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   6135:     var options = "width=" + w + ",height=" + h + ",";
                   6136:     options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   6137:     options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   6138:     var newWin = window.open(url, wdwName, options);
                   6139:     newWin.focus();
                   6140: }
1.890     droeschl 6141: END_MYBLOCK
1.854     kalberla 6142: 
1.1061    raeburn  6143:     $output = Apache::lonhtmlcommon::scripttag($output);
1.890     droeschl 6144:   
1.1061    raeburn  6145:     my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062    raeburn  6146:     my $text = &mt('Communication Blocked');
1.1217    raeburn  6147:     my $class = 'LC_comblock';
1.1062    raeburn  6148:     if ($activity eq 'docs') {
                   6149:         $text = &mt('Content Access Blocked');
1.1217    raeburn  6150:         $class = '';
1.1063    raeburn  6151:     } elsif ($activity eq 'printout') {
                   6152:         $text = &mt('Printing Blocked');
1.1232    raeburn  6153:     } elsif ($activity eq 'passwd') {
                   6154:         $text = &mt('Password Changing Blocked');
1.1345    raeburn  6155:     } elsif ($activity eq 'grades') {
                   6156:         $text = &mt('Gradebook Blocked');
1.1346    raeburn  6157:     } elsif ($activity eq 'search') {
                   6158:         $text = &mt('Search Blocked');
1.1444    raeburn  6159:     } elsif ($activity eq 'index') {
                   6160:         $text = &mt('Content Index Blocked');
1.1282    raeburn  6161:     } elsif ($activity eq 'alert') {
                   6162:         $text = &mt('Checking Critical Messages Blocked');
                   6163:     } elsif ($activity eq 'reinit') {
                   6164:         $text = &mt('Checking Course Update Blocked');
1.1351    raeburn  6165:     } elsif ($activity eq 'about') {
                   6166:         $text = &mt('Access to User Information Pages Blocked');
1.1373    raeburn  6167:     } elsif ($activity eq 'wishlist') {
                   6168:         $text = &mt('Access to Stored Links Blocked');
                   6169:     } elsif ($activity eq 'annotate') {
                   6170:         $text = &mt('Access to Annotations Blocked');
1.1062    raeburn  6171:     }
1.1061    raeburn  6172:     $output .= <<"END_BLOCK";
1.1217    raeburn  6173: <div class='$class'>
1.869     kalberla 6174:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 6175:   title='$text'>
                   6176:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 6177:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 6178:   title='$text'>$text</a>
1.867     kalberla 6179: </div>
                   6180: 
                   6181: END_BLOCK
1.474     raeburn  6182: 
1.1061    raeburn  6183:     return ($blocked, $output);
1.854     kalberla 6184: }
1.490     raeburn  6185: 
1.60      matthew  6186: ###############################################
                   6187: 
1.682     raeburn  6188: sub check_ip_acc {
1.1201    raeburn  6189:     my ($acc,$clientip)=@_;
1.682     raeburn  6190:     &Apache::lonxml::debug("acc is $acc");
                   6191:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   6192:         return 1;
                   6193:     }
1.1339    raeburn  6194:     my ($ip,$allowed);
                   6195:     if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
                   6196:         ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
                   6197:         $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
                   6198:     } else {
1.1350    raeburn  6199:         my $remote_ip = &Apache::lonnet::get_requestor_ip();
                   6200:         $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1339    raeburn  6201:     }
1.682     raeburn  6202: 
                   6203:     my $name;
1.1219    raeburn  6204:     my %access = (
                   6205:                      allowfrom => 1,
                   6206:                      denyfrom  => 0,
                   6207:                  );
                   6208:     my @allows;
                   6209:     my @denies;
                   6210:     foreach my $item (split(',',$acc)) {
                   6211:         $item =~ s/^\s*//;
                   6212:         $item =~ s/\s*$//;
                   6213:         my $pattern;
                   6214:         if ($item =~ /^\!(.+)$/) {
                   6215:             push(@denies,$1);
                   6216:         } else {
                   6217:             push(@allows,$item);
                   6218:         }
                   6219:    }
                   6220:    my $numdenies = scalar(@denies);
                   6221:    my $numallows = scalar(@allows);
                   6222:    my $count = 0;
                   6223:    foreach my $pattern (@denies,@allows) {
                   6224:         $count ++; 
                   6225:         my $acctype = 'allowfrom';
                   6226:         if ($count <= $numdenies) {
                   6227:             $acctype = 'denyfrom';
                   6228:         }
1.682     raeburn  6229:         if ($pattern =~ /\*$/) {
                   6230:             #35.8.*
                   6231:             $pattern=~s/\*//;
1.1219    raeburn  6232:             if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682     raeburn  6233:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   6234:             #35.8.3.[34-56]
                   6235:             my $low=$2;
                   6236:             my $high=$3;
                   6237:             $pattern=$1;
                   6238:             if ($ip =~ /^\Q$pattern\E/) {
                   6239:                 my $last=(split(/\./,$ip))[3];
1.1219    raeburn  6240:                 if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682     raeburn  6241:             }
                   6242:         } elsif ($pattern =~ /^\*/) {
                   6243:             #*.msu.edu
                   6244:             $pattern=~s/\*//;
                   6245:             if (!defined($name)) {
                   6246:                 use Socket;
                   6247:                 my $netaddr=inet_aton($ip);
                   6248:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   6249:             }
1.1219    raeburn  6250:             if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682     raeburn  6251:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   6252:             #127.0.0.1
1.1219    raeburn  6253:             if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682     raeburn  6254:         } else {
                   6255:             #some.name.com
                   6256:             if (!defined($name)) {
                   6257:                 use Socket;
                   6258:                 my $netaddr=inet_aton($ip);
                   6259:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   6260:             }
1.1219    raeburn  6261:             if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
                   6262:         }
                   6263:         if ($allowed =~ /^(0|1)$/) { last; }
                   6264:     }
                   6265:     if ($allowed eq '') {
                   6266:         if ($numdenies && !$numallows) {
                   6267:             $allowed = 1;
                   6268:         } else {
                   6269:             $allowed = 0;
1.682     raeburn  6270:         }
                   6271:     }
                   6272:     return $allowed;
                   6273: }
                   6274: 
                   6275: ###############################################
                   6276: 
1.60      matthew  6277: =pod
                   6278: 
1.112     bowersj2 6279: =head1 Domain Template Functions
                   6280: 
                   6281: =over 4
                   6282: 
                   6283: =item * &determinedomain()
1.60      matthew  6284: 
                   6285: Inputs: $domain (usually will be undef)
                   6286: 
1.63      www      6287: Returns: Determines which domain should be used for designs
1.60      matthew  6288: 
                   6289: =cut
1.54      www      6290: 
1.60      matthew  6291: ###############################################
1.63      www      6292: sub determinedomain {
                   6293:     my $domain=shift;
1.531     albertel 6294:     if (! $domain) {
1.60      matthew  6295:         # Determine domain if we have not been given one
1.893     raeburn  6296:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 6297:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   6298:         if ($env{'request.role.domain'}) { 
                   6299:             $domain=$env{'request.role.domain'}; 
1.60      matthew  6300:         }
                   6301:     }
1.63      www      6302:     return $domain;
                   6303: }
                   6304: ###############################################
1.517     raeburn  6305: 
1.518     albertel 6306: sub devalidate_domconfig_cache {
                   6307:     my ($udom)=@_;
                   6308:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   6309: }
                   6310: 
                   6311: # ---------------------- Get domain configuration for a domain
                   6312: sub get_domainconf {
                   6313:     my ($udom) = @_;
                   6314:     my $cachetime=1800;
                   6315:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   6316:     if (defined($cached)) { return %{$result}; }
                   6317: 
                   6318:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  6319: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  6320:     my (%designhash,%legacy);
1.518     albertel 6321:     if (keys(%domconfig) > 0) {
                   6322:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  6323:             if (keys(%{$domconfig{'login'}})) {
                   6324:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  6325:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1208    raeburn  6326:                         if (($key eq 'loginvia') || ($key eq 'headtag')) {
                   6327:                             if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   6328:                                 foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
                   6329:                                     if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
                   6330:                                         if ($key eq 'loginvia') {
                   6331:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   6332:                                                 my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   6333:                                                 $designhash{$udom.'.login.loginvia'} = $server;
                   6334:                                                 if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   6335: 
                   6336:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   6337:                                                 } else {
                   6338:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
                   6339:                                                 }
1.948     raeburn  6340:                                             }
1.1208    raeburn  6341:                                         } elsif ($key eq 'headtag') {
                   6342:                                             if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
                   6343:                                                 $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948     raeburn  6344:                                             }
1.946     raeburn  6345:                                         }
1.1208    raeburn  6346:                                         if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
                   6347:                                             $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
                   6348:                                         }
1.946     raeburn  6349:                                     }
                   6350:                                 }
                   6351:                             }
1.1366    raeburn  6352:                         } elsif ($key eq 'saml') {
                   6353:                             if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   6354:                                 foreach my $host (keys(%{$domconfig{'login'}{$key}})) {
                   6355:                                     if (ref($domconfig{'login'}{$key}{$host}) eq 'HASH') {
                   6356:                                         $designhash{$udom.'.login.'.$key.'_'.$host} = 1;
1.1386    raeburn  6357:                                         foreach my $item ('text','img','alt','url','title','window','notsso') {
1.1366    raeburn  6358:                                             $designhash{$udom.'.login.'.$key.'_'.$item.'_'.$host} = $domconfig{'login'}{$key}{$host}{$item};
                   6359:                                         }
                   6360:                                     }
                   6361:                                 }
                   6362:                             }
1.946     raeburn  6363:                         } else {
                   6364:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   6365:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   6366:                                     $domconfig{'login'}{$key}{$img};
                   6367:                             }
1.699     raeburn  6368:                         }
                   6369:                     } else {
                   6370:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   6371:                     }
1.632     raeburn  6372:                 }
                   6373:             } else {
                   6374:                 $legacy{'login'} = 1;
1.518     albertel 6375:             }
1.632     raeburn  6376:         } else {
                   6377:             $legacy{'login'} = 1;
1.518     albertel 6378:         }
                   6379:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  6380:             if (keys(%{$domconfig{'rolecolors'}})) {
                   6381:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   6382:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   6383:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   6384:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   6385:                         }
1.518     albertel 6386:                     }
                   6387:                 }
1.632     raeburn  6388:             } else {
                   6389:                 $legacy{'rolecolors'} = 1;
1.518     albertel 6390:             }
1.632     raeburn  6391:         } else {
                   6392:             $legacy{'rolecolors'} = 1;
1.518     albertel 6393:         }
1.948     raeburn  6394:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   6395:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   6396:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   6397:             }
                   6398:         }
1.632     raeburn  6399:         if (keys(%legacy) > 0) {
                   6400:             my %legacyhash = &get_legacy_domconf($udom);
                   6401:             foreach my $item (keys(%legacyhash)) {
                   6402:                 if ($item =~ /^\Q$udom\E\.login/) {
                   6403:                     if ($legacy{'login'}) { 
                   6404:                         $designhash{$item} = $legacyhash{$item};
                   6405:                     }
                   6406:                 } else {
                   6407:                     if ($legacy{'rolecolors'}) {
                   6408:                         $designhash{$item} = $legacyhash{$item};
                   6409:                     }
1.518     albertel 6410:                 }
                   6411:             }
                   6412:         }
1.632     raeburn  6413:     } else {
                   6414:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 6415:     }
                   6416:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   6417: 				  $cachetime);
                   6418:     return %designhash;
                   6419: }
                   6420: 
1.632     raeburn  6421: sub get_legacy_domconf {
                   6422:     my ($udom) = @_;
                   6423:     my %legacyhash;
                   6424:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   6425:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   6426:     if (-e $designfile) {
1.1317    raeburn  6427:         if ( open (my $fh,'<',$designfile) ) {
1.632     raeburn  6428:             while (my $line = <$fh>) {
                   6429:                 next if ($line =~ /^\#/);
                   6430:                 chomp($line);
                   6431:                 my ($key,$val)=(split(/\=/,$line));
                   6432:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   6433:             }
                   6434:             close($fh);
                   6435:         }
                   6436:     }
1.1026    raeburn  6437:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  6438:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   6439:     }
                   6440:     return %legacyhash;
                   6441: }
                   6442: 
1.63      www      6443: =pod
                   6444: 
1.112     bowersj2 6445: =item * &domainlogo()
1.63      www      6446: 
                   6447: Inputs: $domain (usually will be undef)
                   6448: 
                   6449: Returns: A link to a domain logo, if the domain logo exists.
                   6450: If the domain logo does not exist, a description of the domain.
                   6451: 
                   6452: =cut
1.112     bowersj2 6453: 
1.63      www      6454: ###############################################
                   6455: sub domainlogo {
1.517     raeburn  6456:     my $domain = &determinedomain(shift);
1.518     albertel 6457:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  6458:     # See if there is a logo
                   6459:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  6460:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 6461:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   6462: 	    if ($imgsrc =~ m{^/res/}) {
                   6463: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   6464: 		&Apache::lonnet::repcopy($local_name);
                   6465: 	    }
                   6466: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.1374    raeburn  6467:         }
                   6468:         my $alttext = $domain;
                   6469:         if ($designhash{$domain.'.login.alttext_domlogo'} ne '') {
                   6470:             $alttext = $designhash{$domain.'.login.alttext_domlogo'};
                   6471:         }
                   6472:         return '<img src="'.$imgsrc.'" alt="'.$alttext.'" id="lclogindomlogo" />';
1.514     albertel 6473:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   6474:         return &Apache::lonnet::domain($domain,'description');
1.59      www      6475:     } else {
1.60      matthew  6476:         return '';
1.59      www      6477:     }
                   6478: }
1.63      www      6479: ##############################################
                   6480: 
                   6481: =pod
                   6482: 
1.112     bowersj2 6483: =item * &designparm()
1.63      www      6484: 
                   6485: Inputs: $which parameter; $domain (usually will be undef)
                   6486: 
                   6487: Returns: value of designparamter $which
                   6488: 
                   6489: =cut
1.112     bowersj2 6490: 
1.397     albertel 6491: 
1.400     albertel 6492: ##############################################
1.397     albertel 6493: sub designparm {
                   6494:     my ($which,$domain)=@_;
                   6495:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   6496:         return $env{'environment.color.'.$which};
1.96      www      6497:     }
1.63      www      6498:     $domain=&determinedomain($domain);
1.1016    raeburn  6499:     my %domdesign;
                   6500:     unless ($domain eq 'public') {
                   6501:         %domdesign = &get_domainconf($domain);
                   6502:     }
1.520     raeburn  6503:     my $output;
1.517     raeburn  6504:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   6505:         $output = $domdesign{$domain.'.'.$which};
1.63      www      6506:     } else {
1.520     raeburn  6507:         $output = $defaultdesign{$which};
                   6508:     }
                   6509:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  6510:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 6511:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   6512:             if ($output =~ m{^/res/}) {
                   6513:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   6514:                 &Apache::lonnet::repcopy($local_name);
                   6515:             }
1.520     raeburn  6516:             $output = &lonhttpdurl($output);
                   6517:         }
1.63      www      6518:     }
1.520     raeburn  6519:     return $output;
1.63      www      6520: }
1.59      www      6521: 
1.822     bisitz   6522: ##############################################
                   6523: =pod
                   6524: 
1.832     bisitz   6525: =item * &authorspace()
                   6526: 
1.1028    raeburn  6527: Inputs: $url (usually will be undef).
1.832     bisitz   6528: 
1.1132    raeburn  6529: Returns: Path to Authoring Space containing the resource or 
1.1028    raeburn  6530:          directory being viewed (or for which action is being taken). 
                   6531:          If $url is provided, and begins /priv/<domain>/<uname>
                   6532:          the path will be that portion of the $context argument.
                   6533:          Otherwise the path will be for the author space of the current
                   6534:          user when the current role is author, or for that of the 
                   6535:          co-author/assistant co-author space when the current role 
                   6536:          is co-author or assistant co-author.
1.832     bisitz   6537: 
                   6538: =cut
                   6539: 
                   6540: sub authorspace {
1.1028    raeburn  6541:     my ($url) = @_;
                   6542:     if ($url ne '') {
                   6543:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   6544:            return $1;
                   6545:         }
                   6546:     }
1.832     bisitz   6547:     my $caname = '';
1.1024    www      6548:     my $cadom = '';
1.1028    raeburn  6549:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      6550:         ($cadom,$caname) =
1.832     bisitz   6551:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  6552:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   6553:         $caname = $env{'user.name'};
1.1024    www      6554:         $cadom = $env{'user.domain'};
1.832     bisitz   6555:     }
1.1028    raeburn  6556:     if (($caname ne '') && ($cadom ne '')) {
                   6557:         return "/priv/$cadom/$caname/";
                   6558:     }
                   6559:     return;
1.832     bisitz   6560: }
                   6561: 
                   6562: ##############################################
                   6563: =pod
                   6564: 
1.822     bisitz   6565: =item * &head_subbox()
                   6566: 
                   6567: Inputs: $content (contains HTML code with page functions, etc.)
                   6568: 
                   6569: Returns: HTML div with $content
                   6570:          To be included in page header
                   6571: 
                   6572: =cut
                   6573: 
                   6574: sub head_subbox {
                   6575:     my ($content)=@_;
                   6576:     my $output =
1.993     raeburn  6577:         '<div class="LC_head_subbox">'
1.822     bisitz   6578:        .$content
                   6579:        .'</div>'
                   6580: }
                   6581: 
                   6582: ##############################################
                   6583: =pod
                   6584: 
                   6585: =item * &CSTR_pageheader()
                   6586: 
1.1026    raeburn  6587: Input: (optional) filename from which breadcrumb trail is built.
                   6588:        In most cases no input as needed, as $env{'request.filename'}
                   6589:        is appropriate for use in building the breadcrumb trail.
1.1379    raeburn  6590:        frameset flag
                   6591:        If page header is being requested for use in a frameset, then
                   6592:        the second (option) argument -- frameset will be true, and
                   6593:        the target attribute set for links should be target="_parent".
1.1433    raeburn  6594:        If $title is supplied as the third arg, that will be used to 
1.1407    raeburn  6595:        the left of the breadcrumbs tail for the current path.
1.822     bisitz   6596: 
                   6597: Returns: HTML div with CSTR path and recent box
1.1132    raeburn  6598:          To be included on Authoring Space pages
1.822     bisitz   6599: 
                   6600: =cut
                   6601: 
                   6602: sub CSTR_pageheader {
1.1407    raeburn  6603:     my ($trailfile,$frameset,$title) = @_;
1.1026    raeburn  6604:     if ($trailfile eq '') {
                   6605:         $trailfile = $env{'request.filename'};
                   6606:     }
                   6607: 
                   6608: # this is for resources; directories have customtitle, and crumbs
                   6609: # and select recent are created in lonpubdir.pm
                   6610: 
                   6611:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      6612:     my ($udom,$uname,$thisdisfn)=
1.1113    raeburn  6613:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026    raeburn  6614:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   6615:     $formaction =~ s{/+}{/}g;
1.822     bisitz   6616: 
                   6617:     my $parentpath = '';
                   6618:     my $lastitem = '';
                   6619:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   6620:         $parentpath = $1;
                   6621:         $lastitem = $2;
                   6622:     } else {
                   6623:         $lastitem = $thisdisfn;
                   6624:     }
1.921     bisitz   6625: 
1.1406    raeburn  6626:     my $crsauthor;
1.1246    raeburn  6627:     if (($env{'request.course.id'}) &&
                   6628:         ($env{'course.'.$env{'request.course.id'}.'.num'} eq $uname) &&
1.1247    raeburn  6629:         ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom)) {
1.1246    raeburn  6630:         $crsauthor = 1;
1.1406    raeburn  6631:         if ($title eq '') {
                   6632:             $title = &mt('Course Authoring Space');
                   6633:         }
                   6634:     } elsif ($title eq '') {
1.1246    raeburn  6635:         $title = &mt('Authoring Space');
                   6636:     }
                   6637: 
1.1379    raeburn  6638:     my ($target,$crumbtarget) = (' target="_top"','_top');
                   6639:     if ($frameset) {
                   6640:         $target = ' target="_parent"';
                   6641:         $crumbtarget = '_parent';
                   6642:     } elsif (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
1.1314    raeburn  6643:         $target = '';
                   6644:         $crumbtarget = '';
1.1379    raeburn  6645:     } elsif (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'})) {
1.1378    raeburn  6646:         $target = ' target="'.$env{'request.deeplink.target'}.'"';
                   6647:         $crumbtarget = $env{'request.deeplink.target'};
                   6648:     }
1.1313    raeburn  6649: 
1.921     bisitz   6650:     my $output =
1.1407    raeburn  6651:          '<div>'
1.822     bisitz   6652:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1246    raeburn  6653:         .'<b>'.$title.'</b> '
1.1314    raeburn  6654:         .'<form name="dirs" method="post" action="'.$formaction.'"'.$target.'>'
                   6655:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,$crumbtarget,'/priv/'.$udom,undef,undef);
1.921     bisitz   6656: 
                   6657:     if ($lastitem) {
                   6658:         $output .=
                   6659:              '<span class="LC_filename">'
                   6660:             .$lastitem
                   6661:             .'</span>';
                   6662:     }
1.1245    raeburn  6663: 
1.1246    raeburn  6664:     if ($crsauthor) {
1.1379    raeburn  6665:         $output .= '</form>'.&Apache::lonmenu::constspaceform($frameset);
1.1246    raeburn  6666:     } else {
                   6667:         $output .=
                   6668:              '<br />'
1.1314    raeburn  6669:             #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/',$crumbtarget,'/priv','','+1',1)."</b></tt><br />"
1.1246    raeburn  6670:             .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   6671:             .'</form>'
1.1379    raeburn  6672:             .&Apache::lonmenu::constspaceform($frameset);
1.1246    raeburn  6673:     }
1.1407    raeburn  6674:     $output .= '</div>';
1.921     bisitz   6675: 
                   6676:     return $output;
1.822     bisitz   6677: }
                   6678: 
1.1419    raeburn  6679: ##############################################
                   6680: =pod
                   6681: 
                   6682: =item * &nocodemirror()
                   6683: 
                   6684: Input: None
                   6685: 
                   6686: Returns: 1 if CodeMirror is deactivated based on
                   6687:          user's preference, or domain default,
                   6688:          if user indicated use of default.
                   6689: 
                   6690: =cut
                   6691: 
1.1416    raeburn  6692: sub nocodemirror {
                   6693:     my $nocodem = $env{'environment.nocodemirror'};
                   6694:     unless ($nocodem) {
                   6695:         my %domdefs = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   6696:         if ($domdefs{'nocodemirror'}) {
                   6697:             $nocodem = 'yes';
                   6698:         }
                   6699:     }
1.1417    raeburn  6700:     if ($nocodem eq 'yes') {
                   6701:         return 1;
                   6702:     }
                   6703:     return;
1.1416    raeburn  6704: }
                   6705: 
1.1419    raeburn  6706: ##############################################
                   6707: =pod
                   6708: 
                   6709: =item * &permitted_editors()
                   6710: 
1.1422    raeburn  6711: Input: $uri (optional)
1.1419    raeburn  6712: 
                   6713: Returns: %editors hash in which keys are editors
1.1429    raeburn  6714:          permitted in current Authoring Space,
                   6715:          or in current course for web pages
                   6716:          created in a course.
                   6717: 
1.1419    raeburn  6718:          Value for each key is 1. Possible keys
1.1429    raeburn  6719:          are: edit, xml, and daxe.
                   6720: 
                   6721:          For a regular Authoring Space, if no specific
1.1419    raeburn  6722:          set of editors has been set for the Author
                   6723:          who owns the Authoring Space, then the
                   6724:          domain default will be used.  If no domain
                   6725:          default has been set, then the keys will be
                   6726:          edit and xml.
                   6727: 
1.1429    raeburn  6728:          For a course author, or for web pages created
                   6729:          in a course, if no specific set of editors has
                   6730:          been set for the course, then the domain
                   6731:          course default will be used. If no domain
                   6732:          course default has been set, then the keys
                   6733:          will be edit and xml.
                   6734: 
1.1419    raeburn  6735: =cut
                   6736: 
1.1418    raeburn  6737: sub permitted_editors {
1.1422    raeburn  6738:     my ($uri) = @_;
1.1429    raeburn  6739:     my ($is_author,$is_coauthor,$is_course,$auname,$audom,%editors);
1.1418    raeburn  6740:     if ($env{'request.role'} =~ m{^au\./}) {
                   6741:         $is_author = 1;
                   6742:     } elsif ($env{'request.role'} =~ m{^(?:ca|aa)\./($match_domain)/($match_username)}) {
                   6743:         ($audom,$auname) = ($1,$2);
                   6744:         if (($audom ne '') && ($auname ne '')) {
                   6745:             if (($env{'user.domain'} eq $audom) &&
                   6746:                 ($env{'user.name'} eq $auname)) {
                   6747:                 $is_author = 1;
                   6748:             } else {
                   6749:                 $is_coauthor = 1;
                   6750:             }
                   6751:         }
                   6752:     } elsif ($env{'request.course.id'}) {
1.1429    raeburn  6753:         my ($cdom,$cnum);
                   6754:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   6755:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   6756:         if (($env{'request.editurl'} =~ m{^/priv/\Q$cdom/$cnum\E/}) ||
1.1430    raeburn  6757:             ($env{'request.editurl'} =~ m{^/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/}) ||
                   6758:             ($uri =~ m{^/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/})) {
1.1429    raeburn  6759:             $is_course = 1;
                   6760:         } elsif ($env{'request.editurl'} =~ m{^/priv/($match_domain)/($match_username)/}) {
1.1418    raeburn  6761:             ($audom,$auname) = ($1,$2);
                   6762:         } elsif ($env{'request.uri'} =~ m{^/priv/($match_domain)/($match_username)/}) {
                   6763:             ($audom,$auname) = ($1,$2);
1.1422    raeburn  6764:         } elsif (($uri eq '/daxesave') &&
1.1429    raeburn  6765:                  (($env{'form.path'} =~ m{^/daxeopen/priv/\Q$cdom/$cnum\E/}) ||
                   6766:                   ($env{'form.path'} =~ m{^/daxeopen/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/}))) {
                   6767:             $is_course = 1;
                   6768:         } elsif (($uri eq '/daxesave') &&
1.1422    raeburn  6769:                  ($env{'form.path'} =~ m{^/daxeopen/priv/($match_domain)/($match_username)/})) {
                   6770:             ($audom,$auname) = ($1,$2);
1.1418    raeburn  6771:         }
1.1429    raeburn  6772:         unless ($is_course) {
                   6773:             if (($audom ne '') && ($auname ne '')) {
                   6774:                 if (($env{'user.domain'} eq $audom) &&
                   6775:                     ($env{'user.name'} eq $auname)) {
                   6776:                     $is_author = 1;
                   6777:                 } else {
                   6778:                     $is_coauthor = 1;
                   6779:                 }
1.1418    raeburn  6780:             }
                   6781:         }
                   6782:     }
                   6783:     if ($is_author) {
                   6784:         if (exists($env{'environment.editors'})) {
                   6785:             map { $editors{$_} = 1; } split(/,/,$env{'environment.editors'});
                   6786:         } else {
                   6787:             %editors = ( edit => 1,
                   6788:                          xml => 1,
                   6789:                        );
                   6790:         }
                   6791:     } elsif ($is_coauthor) {
                   6792:         if (exists($env{"environment.internal.editors./$audom/$auname"})) {
                   6793:             map { $editors{$_} = 1; } split(/,/,$env{"environment.internal.editors./$audom/$auname"});
                   6794:         } else {
                   6795:             %editors = ( edit => 1,
                   6796:                          xml => 1,
                   6797:                        );
                   6798:         }
1.1429    raeburn  6799:     } elsif ($is_course) {
                   6800:         if (exists($env{'course.'.$env{'request.course.id'}.'.internal.crseditors'})) {
                   6801:             map { $editors{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.internal.crseditors'});
                   6802:         } else {
                   6803:             my %domdefaults = &Apache::lonnet::get_domain_defaults($env{'course.'.$env{'request.course.id'}.'.domain'});
                   6804:             if (exists($domdefaults{'crseditors'})) {
                   6805:                 map { $editors{$_} = 1; } split(/,/,$domdefaults{'crseditors'});
                   6806:             } else {
                   6807:                 %editors = ( edit => 1,
                   6808:                              xml => 1,
                   6809:                            );
                   6810:             }
                   6811:         }
1.1418    raeburn  6812:     } else {
                   6813:         %editors = ( edit => 1,
                   6814:                      xml => 1,
                   6815:                    );
                   6816:     }
                   6817:     return %editors;
                   6818: }
                   6819: 
1.60      matthew  6820: ###############################################
                   6821: ###############################################
                   6822: 
                   6823: =pod
                   6824: 
1.112     bowersj2 6825: =back
                   6826: 
1.549     albertel 6827: =head1 HTML Helpers
1.112     bowersj2 6828: 
                   6829: =over 4
                   6830: 
                   6831: =item * &bodytag()
1.60      matthew  6832: 
                   6833: Returns a uniform header for LON-CAPA web pages.
                   6834: 
                   6835: Inputs: 
                   6836: 
1.112     bowersj2 6837: =over 4
                   6838: 
                   6839: =item * $title, A title to be displayed on the page.
                   6840: 
                   6841: =item * $function, the current role (can be undef).
                   6842: 
                   6843: =item * $addentries, extra parameters for the <body> tag.
                   6844: 
                   6845: =item * $bodyonly, if defined, only return the <body> tag.
                   6846: 
                   6847: =item * $domain, if defined, force a given domain.
                   6848: 
                   6849: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      6850:             text interface only)
1.60      matthew  6851: 
1.814     bisitz   6852: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   6853:                      navigational links
1.317     albertel 6854: 
1.338     albertel 6855: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   6856: 
1.460     albertel 6857: =item * $args, optional argument valid values are
                   6858:             no_auto_mt_title -> prevents &mt()ing the title arg
1.1274    raeburn  6859:             use_absolute     -> for external resource or syllabus, this will
                   6860:                                 contain https://<hostname> if server uses
                   6861:                                 https (as per hosts.tab), but request is for http
                   6862:             hostname         -> hostname, from $r->hostname().
1.460     albertel 6863: 
1.1096    raeburn  6864: =item * $advtoolsref, optional argument, ref to an array containing
                   6865:             inlineremote items to be added in "Functions" menu below
                   6866:             breadcrumbs.
                   6867: 
1.1316    raeburn  6868: =item * $ltiscope, optional argument, will be one of: resource, map or
                   6869:             course, if LON-CAPA is in LTI Provider context. Value is
                   6870:             the scope of use, i.e., launch was for access to a single, a map
                   6871:             or the entire course.
                   6872: 
                   6873: =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
                   6874:             context, this will contain the URL for the landing item in
                   6875:             the course, after launch from an LTI Consumer
                   6876: 
1.1318    raeburn  6877: =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
                   6878:             context, this will contain a reference to hash of items
                   6879:             to be included in the page header and/or inline menu.
                   6880: 
1.1385    raeburn  6881: =item * $menucoll, optional argument, if specific menu collection is in
                   6882:             effect, either set as the default for the course, or set for
                   6883:             the deeplink paramater for $env{'request.deeplink.login'}
                   6884:             then $menucoll will be the number of that collection. 
                   6885: 
                   6886: =item * $menuref, optional argument, reference to a hash, containing the
                   6887:             menu options included for the menu in effect, based on the
                   6888:             configuration for the numbered menu collection in use.  
                   6889: 
                   6890: =item * $showncrumbsref, reference to a scalar. Calls to lonmenu::innerregister
                   6891:             within &bodytag() can result in calls to lonhtmlcommon::breadcrumbs(),
                   6892:             if so, $showncrumbsref is set there to 1, and will propagate back
                   6893:             via &bodytag() to &start_page(), to prevent lonhtmlcommon::breadcrumbs()
                   6894:             being called a second time.
                   6895: 
1.112     bowersj2 6896: =back
                   6897: 
1.60      matthew  6898: Returns: A uniform header for LON-CAPA web pages.  
                   6899: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   6900: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   6901: other decorations will be returned.
                   6902: 
                   6903: =cut
                   6904: 
1.54      www      6905: sub bodytag {
1.831     bisitz   6906:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1359    raeburn  6907:         $no_nav_bar,$bgcolor,$args,$advtoolsref,$ltiscope,$ltiuri,
1.1385    raeburn  6908:         $ltimenu,$menucoll,$menuref,$showncrumbsref)=@_;
1.339     albertel 6909: 
1.954     raeburn  6910:     my $public;
                   6911:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   6912:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   6913:         $public = 1;
                   6914:     }
1.460     albertel 6915:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154    raeburn  6916:     my $httphost = $args->{'use_absolute'};
1.1274    raeburn  6917:     my $hostname = $args->{'hostname'};
1.339     albertel 6918: 
1.183     matthew  6919:     $function = &get_users_function() if (!$function);
1.339     albertel 6920:     my $font =   &designparm($function.'.font',$domain);
                   6921:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   6922: 
1.803     bisitz   6923:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 6924: 		   'bgcolor' => $pgbg,
1.339     albertel 6925: 		   'text'    => $font,
                   6926:                    'alink'   => &designparm($function.'.alink',$domain),
                   6927: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   6928: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 6929:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 6930: 
1.63      www      6931:  # role and realm
1.1178    raeburn  6932:     my ($role,$realm) = split(m{\./},$env{'request.role'},2);
                   6933:     if ($realm) {
                   6934:         $realm = '/'.$realm;
                   6935:     }
1.1357    raeburn  6936:     if ($role eq 'ca') {
1.479     albertel 6937:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 6938:         $realm = &plainname($rname,$rdom);
1.378     raeburn  6939:     } 
1.55      www      6940: # realm
1.1357    raeburn  6941:     my ($cid,$sec);
1.258     albertel 6942:     if ($env{'request.course.id'}) {
1.1357    raeburn  6943:         $cid = $env{'request.course.id'};
                   6944:         if ($env{'request.course.sec'}) {
                   6945:             $sec = $env{'request.course.sec'};
                   6946:         }
                   6947:     } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
                   6948:         if (&Apache::lonnet::is_course($1,$2)) {
                   6949:             $cid = $1.'_'.$2;
                   6950:             $sec = $3;
                   6951:         }
                   6952:     }
                   6953:     if ($cid) {
1.378     raeburn  6954:         if ($env{'request.role'} !~ /^cr/) {
                   6955:             $role = &Apache::lonnet::plaintext($role,&course_type());
1.1257    raeburn  6956:         } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1269    raeburn  6957:             if ($env{'request.role.desc'}) {
                   6958:                 $role = $env{'request.role.desc'};
                   6959:             } else {
                   6960:                 $role = &mt('Helpdesk[_1]','&nbsp;'.$2);
                   6961:             }
1.1257    raeburn  6962:         } else {
                   6963:             $role = (split(/\//,$role,4))[-1]; 
1.378     raeburn  6964:         }
1.1357    raeburn  6965:         if ($sec) {
                   6966:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$sec;
1.898     raeburn  6967:         }   
1.1357    raeburn  6968: 	$realm = $env{'course.'.$cid.'.description'};
1.378     raeburn  6969:     } else {
                   6970:         $role = &Apache::lonnet::plaintext($role);
1.54      www      6971:     }
1.433     albertel 6972: 
1.438     albertel 6973:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 6974: 
1.101     www      6975: # construct main body tag
1.359     albertel 6976:     my $bodytag = "<body $extra_body_attr>".
1.1235    raeburn  6977: 	&Apache::lontexconvert::init_math_support();
1.252     albertel 6978: 
1.1131    raeburn  6979:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6980: 
1.1130    raeburn  6981:     if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60      matthew  6982:         return $bodytag;
1.1130    raeburn  6983:     }
1.359     albertel 6984: 
1.954     raeburn  6985:     if ($public) {
1.433     albertel 6986: 	undef($role);
                   6987:     }
1.1318    raeburn  6988: 
1.1359    raeburn  6989:     my $showcrstitle = 1;
1.1357    raeburn  6990:     if (($cid) && ($env{'request.lti.login'})) {
1.1318    raeburn  6991:         if (ref($ltimenu) eq 'HASH') {
                   6992:             unless ($ltimenu->{'role'}) {
                   6993:                 undef($role);
                   6994:             }
                   6995:             unless ($ltimenu->{'coursetitle'}) {
1.1359    raeburn  6996:                 $showcrstitle = 0;
                   6997:             }
                   6998:         }
                   6999:     } elsif (($cid) && ($menucoll)) {
                   7000:         if (ref($menuref) eq 'HASH') {
                   7001:             unless ($menuref->{'role'}) {
                   7002:                 undef($role);
                   7003:             }
                   7004:             unless ($menuref->{'crs'}) {
                   7005:                 $showcrstitle = 0;
1.1318    raeburn  7006:             }
                   7007:         }
                   7008:     }
                   7009: 
1.762     bisitz   7010:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 7011:     #
                   7012:     # Extra info if you are the DC
                   7013:     my $dc_info = '';
1.1359    raeburn  7014:     if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1357    raeburn  7015:         (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917     raeburn  7016:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      7017:         $dc_info =~ s/\s+$//;
1.359     albertel 7018:     }
                   7019: 
1.1237    raeburn  7020:     my $crstype;
1.1357    raeburn  7021:     if ($cid) {
                   7022:         $crstype = $env{'course.'.$cid.'.type'};
1.1237    raeburn  7023:     } elsif ($args->{'crstype'}) {
                   7024:         $crstype = $args->{'crstype'};
                   7025:     }
                   7026:     if (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
                   7027:         undef($role);
                   7028:     } else {
1.1242    raeburn  7029:         $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.1237    raeburn  7030:     }
1.853     droeschl 7031: 
1.903     droeschl 7032:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   7033: 
                   7034:         #    if ($env{'request.state'} eq 'construct') {
                   7035:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   7036:         #    }
                   7037: 
1.1440    raeburn  7038:         my $need_endlcint;
                   7039:         unless ($args->{'switchserver'}) {
                   7040:             $bodytag .= Apache::lonhtmlcommon::scripttag(
                   7041:                 Apache::lonmenu::utilityfunctions($httphost), 'start');
                   7042:             $need_endlcint = 1;
                   7043:         }
1.359     albertel 7044: 
1.1427    raeburn  7045:         my $collapsible;
1.1423    raeburn  7046:         if ($args->{'collapsible_header'} ne '') {
1.1427    raeburn  7047:             $collapsible = 1;
                   7048:             my ($menustate,$tiptext,$divclass);
                   7049:             if ($args->{'start_collapsed'}) {
                   7050:                 $menustate = 'collapsed';
                   7051:                 $tiptext = 'display';
                   7052:                 $divclass = 'hidden';
                   7053:             } else {
                   7054:                 $menustate = 'expanded';
                   7055:                 $tiptext = 'hide';
                   7056:                 $divclass = 'shown';
                   7057:             }
                   7058:             my $alttext = &mt('menu state: '.$menustate);
                   7059:             my $tooltip = &mt($tiptext.' standard menus');
1.1421    raeburn  7060:             $bodytag .= <<"END";
1.1461    raeburn  7061: <div id="LC_expandingContainer" style="display:inline;" role="navigation">
1.1421    raeburn  7062: <div id="LC_collapsible" class="LC_collapse_trigger" style="position: absolute;top: -5px;left: 0px; z-index:101; display:inline;">
1.1427    raeburn  7063: <a href="#" style="text-decoration:none;"><img class="LC_collapsible_indicator" alt="$alttext" title="$tooltip" src="/res/adm/pages/$menustate.png" style="border:0;margin:0;padding:0;max-width:100%;height:auto" /></a></div>
                   7064: <div class="LC_menus_content $divclass">
1.1421    raeburn  7065: END
                   7066:         }
1.1318    raeburn  7067:         unless ($args->{'no_primary_menu'}) {
1.1369    raeburn  7068:             my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref,
1.1380    raeburn  7069:                                                               $args->{'links_disabled'},
1.1421    raeburn  7070:                                                               $args->{'links_target'},
1.1427    raeburn  7071:                                                               $collapsible);
1.1454    raeburn  7072:             my $labeltext = &HTML::Entities::encode(&mt('Primary links'));
1.1318    raeburn  7073:             if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
                   7074:                 if ($dc_info) {
                   7075:                     $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   7076:                 }
1.1456    raeburn  7077:                 $bodytag .= qq|<div id="LC_nav_bar" role="navigation" aria-label="$labeltext">$left $role</div>|;
1.1454    raeburn  7078:                 unless (($realm eq '') && ($dc_info eq '')) {
                   7079:                     $bodytag .= qq|<div id="LC_realm" role="complementary"><em>$realm</em> $dc_info</div>|;
                   7080:                 }
1.1440    raeburn  7081:                 if ($need_endlcint) {
                   7082:                     $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   7083:                 }
1.1318    raeburn  7084:                 return $bodytag;
                   7085:             }
1.894     droeschl 7086: 
1.1457    raeburn  7087:             $bodytag .= '<div class="LC_landmark" style="margin: 3px 0 0 0;" role="navigation" aria-label="'.$labeltext.'">';
1.1318    raeburn  7088:             unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
                   7089:                 $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
                   7090:             }
1.916     droeschl 7091: 
1.1454    raeburn  7092:             $bodytag .= $right.'</div>';
1.852     droeschl 7093: 
1.1318    raeburn  7094:             if ($dc_info) {
                   7095:                 $dc_info = &dc_courseid_toggle($dc_info);
                   7096:             }
1.1454    raeburn  7097:             unless (($realm eq '') && ($dc_info eq '')) {
1.1457    raeburn  7098:                 $bodytag .= qq|<div id="LC_realm" role="complementary">$realm $dc_info</div>|;
1.1454    raeburn  7099:             }
1.1457    raeburn  7100:             $bodytag .= qq|<div style="clear: both; margin: 5px 0 0 0;"></div>|;
1.917     raeburn  7101:         }
1.916     droeschl 7102: 
1.1169    raeburn  7103:         #if directed to not display the secondary menu, don't.  
1.1168    raeburn  7104:         if ($args->{'no_secondary_menu'}) {
1.1440    raeburn  7105:             if ($need_endlcint) {
                   7106:                 $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   7107:             }
1.1168    raeburn  7108:             return $bodytag;
                   7109:         }
1.1169    raeburn  7110:         #don't show menus for public users
1.954     raeburn  7111:         if (!$public){
1.1318    raeburn  7112:             unless ($args->{'no_inline_menu'}) {
1.1459    raeburn  7113:                 $bodytag .= '<div class="LC_landmark" role="navigation" aria-label="Secondary Links">'.
                   7114:                             Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
1.1359    raeburn  7115:                                                             $args->{'no_primary_menu'},
1.1369    raeburn  7116:                                                             $menucoll,$menuref,
1.1380    raeburn  7117:                                                             $args->{'links_disabled'},
1.1459    raeburn  7118:                                                             $args->{'links_target'}).
1.1460    raeburn  7119:                             '</div>';
1.1318    raeburn  7120:             }
1.903     droeschl 7121:             $bodytag .= Apache::lonmenu::serverform();
1.1440    raeburn  7122:             if ($need_endlcint) {
                   7123:                 $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   7124:             }
1.920     raeburn  7125:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 7126:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1385    raeburn  7127:                                 $args->{'bread_crumbs'},'','',$hostname,
                   7128:                                 $ltiscope,$ltiuri,$showncrumbsref);
1.1096    raeburn  7129:             } elsif ($forcereg) {
                   7130:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1385    raeburn  7131:                                 $args->{'group'},$args->{'hide_buttons'},
                   7132:                                 $hostname,$ltiscope,$ltiuri,$showncrumbsref);
1.1096    raeburn  7133:             } else {
1.1459    raeburn  7134:                 $bodytag .=
1.1096    raeburn  7135:                     &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   7136:                                                         $forcereg,$args->{'group'},
                   7137:                                                         $args->{'bread_crumbs'},
1.1274    raeburn  7138:                                                         $advtoolsref,'',$hostname);
1.920     raeburn  7139:             }
1.1440    raeburn  7140:         } else {
                   7141:             # this is to separate menu from content when there's no secondary
1.1441    raeburn  7142:             # menu. Especially needed for publicly accessible resources.
1.1459    raeburn  7143:             $bodytag .= '<hr style="clear:both" role="complementary" />';
1.1440    raeburn  7144:             if ($need_endlcint) {
                   7145:                 $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   7146:             }
1.235     raeburn  7147:         }
1.1423    raeburn  7148:         if ($args->{'collapsible_header'} ne '') {
                   7149:             $bodytag .= $args->{'collapsible_header'}.
                   7150:                         '<div id="LC_collapsible_separator"></div>'.
1.1421    raeburn  7151:                         '</div></div>';
                   7152:         }
1.235     raeburn  7153:         return $bodytag;
1.182     matthew  7154: }
                   7155: 
1.917     raeburn  7156: sub dc_courseid_toggle {
                   7157:     my ($dc_info) = @_;
1.980     raeburn  7158:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  7159:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  7160:            &mt('(More ...)').'</a></span>'.
                   7161:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   7162: }
                   7163: 
1.330     albertel 7164: sub make_attr_string {
                   7165:     my ($register,$attr_ref) = @_;
                   7166: 
                   7167:     if ($attr_ref && !ref($attr_ref)) {
                   7168: 	die("addentries Must be a hash ref ".
                   7169: 	    join(':',caller(1))." ".
                   7170: 	    join(':',caller(0))." ");
                   7171:     }
                   7172: 
                   7173:     if ($register) {
1.339     albertel 7174: 	my ($on_load,$on_unload);
                   7175: 	foreach my $key (keys(%{$attr_ref})) {
                   7176: 	    if      (lc($key) eq 'onload') {
                   7177: 		$on_load.=$attr_ref->{$key}.';';
                   7178: 		delete($attr_ref->{$key});
                   7179: 
                   7180: 	    } elsif (lc($key) eq 'onunload') {
                   7181: 		$on_unload.=$attr_ref->{$key}.';';
                   7182: 		delete($attr_ref->{$key});
                   7183: 	    }
                   7184: 	}
1.953     droeschl 7185: 	$attr_ref->{'onload'}  = $on_load;
                   7186: 	$attr_ref->{'onunload'}= $on_unload;
1.330     albertel 7187:     }
1.339     albertel 7188: 
1.330     albertel 7189:     my $attr_string;
1.1159    raeburn  7190:     foreach my $attr (sort(keys(%$attr_ref))) {
1.330     albertel 7191: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   7192:     }
                   7193:     return $attr_string;
                   7194: }
                   7195: 
                   7196: 
1.182     matthew  7197: ###############################################
1.251     albertel 7198: ###############################################
                   7199: 
                   7200: =pod
                   7201: 
                   7202: =item * &endbodytag()
                   7203: 
                   7204: Returns a uniform footer for LON-CAPA web pages.
                   7205: 
1.635     raeburn  7206: Inputs: 1 - optional reference to an args hash
                   7207: If in the hash, key for noredirectlink has a value which evaluates to true,
                   7208: a 'Continue' link is not displayed if the page contains an
                   7209: internal redirect in the <head></head> section,
                   7210: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 7211: 
                   7212: =cut
                   7213: 
                   7214: sub endbodytag {
1.635     raeburn  7215:     my ($args) = @_;
1.1080    raeburn  7216:     my $endbodytag;
                   7217:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   7218:         $endbodytag='</body>';
                   7219:     }
1.315     albertel 7220:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  7221:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
1.1386    raeburn  7222:             my ($endbodyjs,$idattr);
                   7223:             if ($env{'internal.head.to_opener'}) {
                   7224:                 my $linkid = 'LC_continue_link';
                   7225:                 $idattr = ' id="'.$linkid.'"';
                   7226:                 my $redirect_for_js = &js_escape($env{'internal.head.redirect'});
                   7227:                 $endbodyjs=<<ENDJS;
                   7228: <script type="text/javascript">
                   7229: // <![CDATA[
                   7230: function ebFunction(evt) {
                   7231:     evt.preventDefault();
                   7232:     var dest = '$redirect_for_js';
                   7233:     if (window.opener != null && !window.opener.closed) {
                   7234:         window.opener.location.href=dest;
                   7235:         window.close();
                   7236:     } else {
                   7237:         window.location.href=dest;
                   7238:     }
                   7239:     return false;
                   7240: }
                   7241: 
                   7242: \$(document).ready(function () {
                   7243:   if (document.getElementById('$linkid')) {
                   7244:     var clickelem = document.getElementById('$linkid');
                   7245:     clickelem.addEventListener('click',ebFunction,false);
                   7246:   }
                   7247: });
                   7248: // ]]>
                   7249: </script>
                   7250: ENDJS
                   7251:             }
1.635     raeburn  7252: 	    $endbodytag=
1.1386    raeburn  7253: 	        "$endbodyjs<br /><a href=\"$env{'internal.head.redirect'}\"$idattr>".
1.635     raeburn  7254: 	        &mt('Continue').'</a>'.
                   7255: 	        $endbodytag;
                   7256:         }
1.315     albertel 7257:     }
1.1411    raeburn  7258:     if ((ref($args) eq 'HASH') && ($args->{'dashjs'})) {
                   7259:         $endbodytag = &Apache::lonhtmlcommon::dash_to_minus_js().$endbodytag;
                   7260:     }
1.251     albertel 7261:     return $endbodytag;
                   7262: }
                   7263: 
1.352     albertel 7264: =pod
                   7265: 
                   7266: =item * &standard_css()
                   7267: 
                   7268: Returns a style sheet
                   7269: 
                   7270: Inputs: (all optional)
                   7271:             domain         -> force to color decorate a page for a specific
                   7272:                                domain
                   7273:             function       -> force usage of a specific rolish color scheme
                   7274:             bgcolor        -> override the default page bgcolor
                   7275: 
                   7276: =cut
                   7277: 
1.343     albertel 7278: sub standard_css {
1.345     albertel 7279:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 7280:     $function  = &get_users_function() if (!$function);
                   7281:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   7282:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 7283:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 7284: #second colour for later usage
1.345     albertel 7285:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 7286:     my $pgbg_or_bgcolor =
                   7287: 	         $bgcolor ||
1.352     albertel 7288: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 7289:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 7290:     my $alink  = &designparm($function.'.alink', $domain);
                   7291:     my $vlink  = &designparm($function.'.vlink', $domain);
                   7292:     my $link   = &designparm($function.'.link',  $domain);
                   7293: 
1.602     albertel 7294:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 7295:     my $mono                 = 'monospace';
1.850     bisitz   7296:     my $data_table_head      = $sidebg;
                   7297:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   7298:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 7299:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 7300:     my $data_table_highlight = '#FFFF00';
1.352     albertel 7301:     my $mail_new             = '#FFBB77';
                   7302:     my $mail_new_hover       = '#DD9955';
                   7303:     my $mail_read            = '#BBBB77';
                   7304:     my $mail_read_hover      = '#999944';
                   7305:     my $mail_replied         = '#AAAA88';
                   7306:     my $mail_replied_hover   = '#888855';
                   7307:     my $mail_other           = '#99BBBB';
                   7308:     my $mail_other_hover     = '#669999';
1.391     albertel 7309:     my $table_header         = '#DDDDDD';
1.489     raeburn  7310:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   7311:     my $lg_border_color      = '#C8C8C8';
1.952     onken    7312:     my $button_hover         = '#BF2317';
1.392     albertel 7313: 
1.608     albertel 7314:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   7315:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   7316:                                              : '0 3px 0 4px';
1.448     albertel 7317: 
1.523     albertel 7318: 
1.343     albertel 7319:     return <<END;
1.947     droeschl 7320: 
                   7321: /* needed for iframe to allow 100% height in FF */
                   7322: body, html { 
                   7323:     margin: 0;
                   7324:     padding: 0 0.5%;
                   7325:     height: 99%; /* to avoid scrollbars */
                   7326: }
                   7327: 
1.795     www      7328: body {
1.911     bisitz   7329:   font-family: $sans;
                   7330:   line-height:130%;
                   7331:   font-size:0.83em;
                   7332:   color:$font;
1.1436    raeburn  7333:   background-color: $pgbg_or_bgcolor;
1.795     www      7334: }
                   7335: 
1.959     onken    7336: a:focus,
                   7337: a:focus img {
1.795     www      7338:   color: red;
                   7339: }
1.698     harmsja  7340: 
1.911     bisitz   7341: form, .inline {
                   7342:   display: inline;
1.795     www      7343: }
1.721     harmsja  7344: 
1.1453    raeburn  7345: .LC_landmark {
                   7346:   margin: 0;
                   7347:   padding: 0;
                   7348:   border: none;
                   7349: }
                   7350: 
1.1443    raeburn  7351: .LC_visually_hidden:not(:focus):not(:active) {
                   7352:     clip-path: inset(50%);
                   7353:     height: 1px;
                   7354:     overflow: hidden;
                   7355:     position: absolute;
                   7356:     white-space: nowrap;
                   7357:     width: 1px;
                   7358:     display: inline;
                   7359: }
                   7360: 
1.1453    raeburn  7361: .LC_heading_2 {
                   7362:   font-size: 1.17em;
                   7363: }
                   7364: 
1.1458    raeburn  7365: .LC_heading_3 {
                   7366:   font-size: 1.0em;
                   7367: }
                   7368: 
1.1472    raeburn  7369: h1.LC_search_results {
                   7370:   font-size: 1.0em;
                   7371:   font-weight: normal;
                   7372: }
                   7373: 
1.1421    raeburn  7374: .LC_menus_content.shown{
1.1428    raeburn  7375:   display: block;
1.1421    raeburn  7376: }
                   7377: 
                   7378: .LC_menus_content.hidden {
                   7379:   display: none;
                   7380: }
                   7381: 
1.795     www      7382: .LC_right {
1.911     bisitz   7383:   text-align:right;
1.795     www      7384: }
                   7385: 
1.1470    raeburn  7386: .LC_left {
                   7387:   text-align:left;
                   7388: }
                   7389: 
1.1449    raeburn  7390: .LC_center {
                   7391:   text-align:center;
                   7392: }
                   7393: 
1.795     www      7394: .LC_middle {
1.911     bisitz   7395:   vertical-align:middle;
1.795     www      7396: }
1.721     harmsja  7397: 
1.1475  ! raeburn  7398: .LC_bottom {
        !          7399:   vertical-align:bottom;
        !          7400: }
        !          7401: 
1.1130    raeburn  7402: .LC_floatleft {
                   7403:   float: left;
                   7404: }
                   7405: 
                   7406: .LC_floatright {
                   7407:   float: right;
                   7408: }
                   7409: 
1.911     bisitz   7410: .LC_400Box {
                   7411:   width:400px;
                   7412: }
1.721     harmsja  7413: 
1.1421    raeburn  7414: #LC_collapsible_separator {
                   7415:     border: 1px solid black;
                   7416:     width: 99.9%;
                   7417:     height: 0px;
                   7418: }
                   7419: 
1.947     droeschl 7420: .LC_iframecontainer {
                   7421:     width: 98%;
                   7422:     margin: 0;
                   7423:     position: fixed;
                   7424:     top: 8.5em;
                   7425:     bottom: 0;
                   7426: }
                   7427: 
                   7428: .LC_iframecontainer iframe{
                   7429:     border: none;
                   7430:     width: 100%;
                   7431:     height: 100%;
                   7432: }
                   7433: 
1.778     bisitz   7434: .LC_filename {
                   7435:   font-family: $mono;
                   7436:   white-space:pre;
1.921     bisitz   7437:   font-size: 120%;
1.778     bisitz   7438: }
                   7439: 
                   7440: .LC_fileicon {
                   7441:   border: none;
                   7442:   height: 1.3em;
                   7443:   vertical-align: text-bottom;
                   7444:   margin-right: 0.3em;
                   7445:   text-decoration:none;
                   7446: }
                   7447: 
1.1008    www      7448: .LC_setting {
                   7449:   text-decoration:underline;
                   7450: }
                   7451: 
1.350     albertel 7452: .LC_error {
                   7453:   color: red;
                   7454: }
1.795     www      7455: 
1.1097    bisitz   7456: .LC_warning {
                   7457:   color: darkorange;
                   7458: }
                   7459: 
1.457     albertel 7460: .LC_diff_removed {
1.733     bisitz   7461:   color: red;
1.394     albertel 7462: }
1.532     albertel 7463: 
                   7464: .LC_info,
1.457     albertel 7465: .LC_success,
                   7466: .LC_diff_added {
1.350     albertel 7467:   color: green;
                   7468: }
1.795     www      7469: 
1.802     bisitz   7470: div.LC_confirm_box {
                   7471:   background-color: #FAFAFA;
                   7472:   border: 1px solid $lg_border_color;
                   7473:   margin-right: 0;
                   7474:   padding: 5px;
                   7475: }
                   7476: 
                   7477: div.LC_confirm_box .LC_error img,
                   7478: div.LC_confirm_box .LC_success img {
                   7479:   vertical-align: middle;
                   7480: }
                   7481: 
1.1242    raeburn  7482: .LC_maxwidth {
                   7483:   max-width: 100%;
                   7484:   height: auto;
                   7485: }
                   7486: 
1.1474    raeburn  7487: div.LC_minheight {
                   7488:   min-height: 24px;
                   7489:   border: 0;
                   7490:   margin: 4px 0 0 0;
                   7491:   padding: 0;
                   7492:   vertical-align: middle;
                   7493: }
                   7494: 
1.1243    raeburn  7495: .LC_textsize_mobile {
                   7496:   \@media only screen and (max-device-width: 480px) {
                   7497:       -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
                   7498:   }
                   7499: }
                   7500: 
1.440     albertel 7501: .LC_icon {
1.771     droeschl 7502:   border: none;
1.790     droeschl 7503:   vertical-align: middle;
1.771     droeschl 7504: }
                   7505: 
1.543     albertel 7506: .LC_docs_spacer {
                   7507:   width: 25px;
                   7508:   height: 1px;
1.771     droeschl 7509:   border: none;
1.543     albertel 7510: }
1.346     albertel 7511: 
1.532     albertel 7512: .LC_internal_info {
1.735     bisitz   7513:   color: #999999;
1.532     albertel 7514: }
                   7515: 
1.794     www      7516: .LC_discussion {
1.1050    www      7517:   background: $data_table_dark;
1.911     bisitz   7518:   border: 1px solid black;
                   7519:   margin: 2px;
1.794     www      7520: }
                   7521: 
                   7522: .LC_disc_action_left {
1.1050    www      7523:   background: $sidebg;
1.911     bisitz   7524:   text-align: left;
1.1050    www      7525:   padding: 4px;
                   7526:   margin: 2px;
1.794     www      7527: }
                   7528: 
                   7529: .LC_disc_action_right {
1.1050    www      7530:   background: $sidebg;
1.911     bisitz   7531:   text-align: right;
1.1050    www      7532:   padding: 4px;
                   7533:   margin: 2px;
1.794     www      7534: }
                   7535: 
                   7536: .LC_disc_new_item {
1.911     bisitz   7537:   background: white;
                   7538:   border: 2px solid red;
1.1050    www      7539:   margin: 4px;
                   7540:   padding: 4px;
1.794     www      7541: }
                   7542: 
                   7543: .LC_disc_old_item {
1.911     bisitz   7544:   background: white;
1.1050    www      7545:   margin: 4px;
                   7546:   padding: 4px;
1.794     www      7547: }
                   7548: 
1.1468    raeburn  7549: .LC_pastsubmission {
1.458     albertel 7550:   border: 1px solid black;
                   7551:   margin: 2px;
1.1468    raeburn  7552:   padding: 2px;
1.458     albertel 7553: }
                   7554: 
1.924     bisitz   7555: table#LC_menubuttons {
1.345     albertel 7556:   width: 100%;
                   7557:   background: $pgbg;
1.392     albertel 7558:   border: 2px;
1.402     albertel 7559:   border-collapse: separate;
1.803     bisitz   7560:   padding: 0;
1.345     albertel 7561: }
1.392     albertel 7562: 
1.801     tempelho 7563: table#LC_title_bar a {
                   7564:   color: $fontmenu;
                   7565: }
1.836     bisitz   7566: 
1.807     droeschl 7567: table#LC_title_bar {
1.819     tempelho 7568:   clear: both;
1.836     bisitz   7569:   display: none;
1.807     droeschl 7570: }
                   7571: 
1.795     www      7572: table#LC_title_bar,
1.933     droeschl 7573: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 7574: table#LC_title_bar.LC_with_remote {
1.359     albertel 7575:   width: 100%;
1.392     albertel 7576:   border-color: $pgbg;
                   7577:   border-style: solid;
                   7578:   border-width: $border;
1.379     albertel 7579:   background: $pgbg;
1.801     tempelho 7580:   color: $fontmenu;
1.392     albertel 7581:   border-collapse: collapse;
1.803     bisitz   7582:   padding: 0;
1.819     tempelho 7583:   margin: 0;
1.359     albertel 7584: }
1.795     www      7585: 
1.933     droeschl 7586: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 7587:     margin: 0;
                   7588:     padding: 0;
1.933     droeschl 7589:     position: relative;
                   7590:     list-style: none;
1.913     droeschl 7591: }
1.933     droeschl 7592: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 7593:     display: inline;
                   7594: }
1.933     droeschl 7595: 
                   7596: .LC_breadcrumb_tools_navigation {
1.913     droeschl 7597:     padding: 0;
1.933     droeschl 7598:     margin: 0;
                   7599:     float: left;
1.913     droeschl 7600: }
1.933     droeschl 7601: .LC_breadcrumb_tools_tools {
                   7602:     padding: 0;
                   7603:     margin: 0;
1.913     droeschl 7604:     float: right;
                   7605: }
                   7606: 
1.1240    raeburn  7607: .LC_placement_prog {
                   7608:     padding-right: 20px;
                   7609:     font-weight: bold;
                   7610:     font-size: 90%;
                   7611: }
                   7612: 
1.359     albertel 7613: table#LC_title_bar td {
                   7614:   background: $tabbg;
                   7615: }
1.795     www      7616: 
1.911     bisitz   7617: table#LC_menubuttons img {
1.803     bisitz   7618:   border: none;
1.346     albertel 7619: }
1.795     www      7620: 
1.842     droeschl 7621: .LC_breadcrumbs_component {
1.911     bisitz   7622:   float: right;
                   7623:   margin: 0 1em;
1.357     albertel 7624: }
1.842     droeschl 7625: .LC_breadcrumbs_component img {
1.911     bisitz   7626:   vertical-align: middle;
1.777     tempelho 7627: }
1.795     www      7628: 
1.1243    raeburn  7629: .LC_breadcrumbs_hoverable {
                   7630:   background: $sidebg;
                   7631: }
                   7632: 
1.383     albertel 7633: td.LC_table_cell_checkbox {
                   7634:   text-align: center;
                   7635: }
1.795     www      7636: 
                   7637: .LC_fontsize_small {
1.911     bisitz   7638:   font-size: 70%;
1.705     tempelho 7639: }
                   7640: 
1.844     bisitz   7641: #LC_breadcrumbs {
1.911     bisitz   7642:   clear:both;
                   7643:   background: $sidebg;
                   7644:   border-bottom: 1px solid $lg_border_color;
                   7645:   line-height: 2.5em;
1.933     droeschl 7646:   overflow: hidden;
1.911     bisitz   7647:   margin: 0;
                   7648:   padding: 0;
1.995     raeburn  7649:   text-align: left;
1.819     tempelho 7650: }
1.862     bisitz   7651: 
1.1098    bisitz   7652: .LC_head_subbox, .LC_actionbox {
1.911     bisitz   7653:   clear:both;
                   7654:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 7655:   border: 1px solid $sidebg;
1.1098    bisitz   7656:   margin: 0 0 10px 0;
1.966     bisitz   7657:   padding: 3px;
1.995     raeburn  7658:   text-align: left;
1.822     bisitz   7659: }
                   7660: 
1.795     www      7661: .LC_fontsize_medium {
1.911     bisitz   7662:   font-size: 85%;
1.705     tempelho 7663: }
                   7664: 
1.795     www      7665: .LC_fontsize_large {
1.911     bisitz   7666:   font-size: 120%;
1.705     tempelho 7667: }
                   7668: 
1.346     albertel 7669: .LC_menubuttons_inline_text {
                   7670:   color: $font;
1.698     harmsja  7671:   font-size: 90%;
1.701     harmsja  7672:   padding-left:3px;
1.346     albertel 7673: }
                   7674: 
1.934     droeschl 7675: .LC_menubuttons_inline_text img{
                   7676:   vertical-align: middle;
                   7677: }
                   7678: 
1.1051    www      7679: li.LC_menubuttons_inline_text img {
1.951     onken    7680:   cursor:pointer;
1.1002    droeschl 7681:   text-decoration: none;
1.951     onken    7682: }
                   7683: 
1.526     www      7684: .LC_menubuttons_link {
                   7685:   text-decoration: none;
                   7686: }
1.795     www      7687: 
1.522     albertel 7688: .LC_menubuttons_category {
1.521     www      7689:   color: $font;
1.526     www      7690:   background: $pgbg;
1.521     www      7691:   font-size: larger;
                   7692:   font-weight: bold;
                   7693: }
                   7694: 
1.346     albertel 7695: td.LC_menubuttons_text {
1.911     bisitz   7696:   color: $font;
1.346     albertel 7697: }
1.706     harmsja  7698: 
1.346     albertel 7699: .LC_current_location {
                   7700:   background: $tabbg;
                   7701: }
1.795     www      7702: 
1.1286    raeburn  7703: td.LC_zero_height {
                   7704:   line-height: 0; 
                   7705:   cellpadding: 0;
                   7706: }
                   7707: 
1.938     bisitz   7708: table.LC_data_table {
1.347     albertel 7709:   border: 1px solid #000000;
1.402     albertel 7710:   border-collapse: separate;
1.426     albertel 7711:   border-spacing: 1px;
1.610     albertel 7712:   background: $pgbg;
1.347     albertel 7713: }
1.795     www      7714: 
1.422     albertel 7715: .LC_data_table_dense {
                   7716:   font-size: small;
                   7717: }
1.795     www      7718: 
1.507     raeburn  7719: table.LC_nested_outer {
                   7720:   border: 1px solid #000000;
1.589     raeburn  7721:   border-collapse: collapse;
1.803     bisitz   7722:   border-spacing: 0;
1.507     raeburn  7723:   width: 100%;
                   7724: }
1.795     www      7725: 
1.879     raeburn  7726: table.LC_innerpickbox,
1.507     raeburn  7727: table.LC_nested {
1.803     bisitz   7728:   border: none;
1.589     raeburn  7729:   border-collapse: collapse;
1.803     bisitz   7730:   border-spacing: 0;
1.507     raeburn  7731:   width: 100%;
                   7732: }
1.795     www      7733: 
1.911     bisitz   7734: table.LC_data_table tr th,
                   7735: table.LC_calendar tr th,
1.879     raeburn  7736: table.LC_prior_tries tr th,
                   7737: table.LC_innerpickbox tr th {
1.349     albertel 7738:   font-weight: bold;
                   7739:   background-color: $data_table_head;
1.801     tempelho 7740:   color:$fontmenu;
1.701     harmsja  7741:   font-size:90%;
1.347     albertel 7742: }
1.795     www      7743: 
1.879     raeburn  7744: table.LC_innerpickbox tr th,
                   7745: table.LC_innerpickbox tr td {
                   7746:   vertical-align: top;
                   7747: }
                   7748: 
1.711     raeburn  7749: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   7750:   background-color: #CCCCCC;
1.711     raeburn  7751:   font-weight: bold;
                   7752:   text-align: left;
                   7753: }
1.795     www      7754: 
1.912     bisitz   7755: table.LC_data_table tr.LC_odd_row > td {
                   7756:   background-color: $data_table_light;
                   7757:   padding: 2px;
                   7758:   vertical-align: top;
                   7759: }
                   7760: 
1.809     bisitz   7761: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 7762:   background-color: $data_table_light;
1.912     bisitz   7763:   vertical-align: top;
                   7764: }
                   7765: 
                   7766: table.LC_data_table tr.LC_even_row > td {
                   7767:   background-color: $data_table_dark;
1.425     albertel 7768:   padding: 2px;
1.900     bisitz   7769:   vertical-align: top;
1.347     albertel 7770: }
1.795     www      7771: 
1.809     bisitz   7772: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 7773:   background-color: $data_table_dark;
1.900     bisitz   7774:   vertical-align: top;
1.347     albertel 7775: }
1.795     www      7776: 
1.425     albertel 7777: table.LC_data_table tr.LC_data_table_highlight td {
                   7778:   background-color: $data_table_darker;
                   7779: }
1.795     www      7780: 
1.639     raeburn  7781: table.LC_data_table tr td.LC_leftcol_header {
                   7782:   background-color: $data_table_head;
                   7783:   font-weight: bold;
                   7784: }
1.795     www      7785: 
1.451     albertel 7786: table.LC_data_table tr.LC_empty_row td,
1.1474    raeburn  7787: table.LC_nested tr.LC_empty_row td,
                   7788: table.LC_nested tr.LC_empty_row th {
1.421     albertel 7789:   font-weight: bold;
                   7790:   font-style: italic;
                   7791:   text-align: center;
                   7792:   padding: 8px;
1.1474    raeburn  7793:   border: 0;
1.347     albertel 7794: }
1.795     www      7795: 
1.1114    raeburn  7796: table.LC_data_table tr.LC_empty_row td,
                   7797: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   7798:   background-color: $sidebg;
                   7799: }
                   7800: 
1.1474    raeburn  7801: table.LC_nested tr.LC_empty_row th,
1.940     bisitz   7802: table.LC_nested tr.LC_empty_row td {
1.1474    raeburn  7803:   padding: 4ex;
1.940     bisitz   7804:   background-color: #FFFFFF;
                   7805: }
                   7806: 
1.890     droeschl 7807: table.LC_caption {
                   7808: }
                   7809: 
1.1469    raeburn  7810: caption.LC_caption_prefs {
                   7811:   font-weight: normal;
                   7812:   text-align: left;
                   7813:   padding-bottom: 0.8em;
                   7814: }
                   7815: 
1.507     raeburn  7816: table.LC_nested_outer tr th {
                   7817:   font-weight: bold;
1.801     tempelho 7818:   color:$fontmenu;
1.507     raeburn  7819:   background-color: $data_table_head;
1.701     harmsja  7820:   font-size: small;
1.507     raeburn  7821:   border-bottom: 1px solid #000000;
                   7822: }
1.795     www      7823: 
1.507     raeburn  7824: table.LC_nested_outer tr td.LC_subheader {
                   7825:   background-color: $data_table_head;
                   7826:   font-weight: bold;
                   7827:   font-size: small;
                   7828:   border-bottom: 1px solid #000000;
                   7829:   text-align: right;
1.451     albertel 7830: }
1.795     www      7831: 
1.1474    raeburn  7832: table.LC_nested tr.LC_info_row td,
                   7833: table.LC_nested tr.LC_info_row th {
1.735     bisitz   7834:   background-color: #CCCCCC;
1.451     albertel 7835:   font-weight: bold;
                   7836:   font-size: small;
1.507     raeburn  7837:   text-align: center;
1.1474    raeburn  7838:   border: 0;
1.507     raeburn  7839: }
1.795     www      7840: 
1.589     raeburn  7841: table.LC_nested tr.LC_info_row td.LC_left_item,
1.1474    raeburn  7842: table.LC_nested tr.LC_info_row th.LC_left_item,
1.589     raeburn  7843: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  7844:   text-align: left;
1.451     albertel 7845: }
1.795     www      7846: 
1.507     raeburn  7847: table.LC_nested td {
1.735     bisitz   7848:   background-color: #FFFFFF;
1.451     albertel 7849:   font-size: small;
1.507     raeburn  7850: }
1.795     www      7851: 
1.507     raeburn  7852: table.LC_nested_outer tr th.LC_right_item,
                   7853: table.LC_nested tr.LC_info_row td.LC_right_item,
                   7854: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   7855: table.LC_nested tr td.LC_right_item {
1.451     albertel 7856:   text-align: right;
                   7857: }
                   7858: 
1.507     raeburn  7859: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   7860:   background-color: #EEEEEE;
1.451     albertel 7861: }
                   7862: 
1.473     raeburn  7863: table.LC_createuser {
                   7864: }
                   7865: 
                   7866: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  7867:   font-size: small;
1.473     raeburn  7868: }
                   7869: 
                   7870: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   7871:   background-color: #CCCCCC;
1.473     raeburn  7872:   font-weight: bold;
                   7873:   text-align: center;
                   7874: }
                   7875: 
1.349     albertel 7876: table.LC_calendar {
                   7877:   border: 1px solid #000000;
                   7878:   border-collapse: collapse;
1.917     raeburn  7879:   width: 98%;
1.349     albertel 7880: }
1.795     www      7881: 
1.349     albertel 7882: table.LC_calendar_pickdate {
                   7883:   font-size: xx-small;
                   7884: }
1.795     www      7885: 
1.349     albertel 7886: table.LC_calendar tr td {
                   7887:   border: 1px solid #000000;
                   7888:   vertical-align: top;
1.917     raeburn  7889:   width: 14%;
1.349     albertel 7890: }
1.795     www      7891: 
1.349     albertel 7892: table.LC_calendar tr td.LC_calendar_day_empty {
                   7893:   background-color: $data_table_dark;
                   7894: }
1.795     www      7895: 
1.779     bisitz   7896: table.LC_calendar tr td.LC_calendar_day_current {
                   7897:   background-color: $data_table_highlight;
1.777     tempelho 7898: }
1.795     www      7899: 
1.938     bisitz   7900: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 7901:   background-color: $mail_new;
                   7902: }
1.795     www      7903: 
1.938     bisitz   7904: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 7905:   background-color: $mail_new_hover;
                   7906: }
1.795     www      7907: 
1.938     bisitz   7908: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 7909:   background-color: $mail_read;
                   7910: }
1.795     www      7911: 
1.938     bisitz   7912: /*
                   7913: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 7914:   background-color: $mail_read_hover;
                   7915: }
1.938     bisitz   7916: */
1.795     www      7917: 
1.938     bisitz   7918: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 7919:   background-color: $mail_replied;
                   7920: }
1.795     www      7921: 
1.938     bisitz   7922: /*
                   7923: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 7924:   background-color: $mail_replied_hover;
                   7925: }
1.938     bisitz   7926: */
1.795     www      7927: 
1.938     bisitz   7928: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 7929:   background-color: $mail_other;
                   7930: }
1.795     www      7931: 
1.938     bisitz   7932: /*
                   7933: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 7934:   background-color: $mail_other_hover;
                   7935: }
1.938     bisitz   7936: */
1.494     raeburn  7937: 
1.777     tempelho 7938: table.LC_data_table tr > td.LC_browser_file,
                   7939: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   7940:   background: #AAEE77;
1.389     albertel 7941: }
1.795     www      7942: 
1.777     tempelho 7943: table.LC_data_table tr > td.LC_browser_file_locked,
                   7944: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 7945:   background: #FFAA99;
1.387     albertel 7946: }
1.795     www      7947: 
1.777     tempelho 7948: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   7949:   background: #888888;
1.779     bisitz   7950: }
1.795     www      7951: 
1.777     tempelho 7952: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   7953: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   7954:   background: #F8F866;
1.777     tempelho 7955: }
1.795     www      7956: 
1.696     bisitz   7957: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   7958:   background: #E0E8FF;
1.387     albertel 7959: }
1.696     bisitz   7960: 
1.707     bisitz   7961: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   7962:   /* background: #77FF77; */
1.707     bisitz   7963: }
1.795     www      7964: 
1.707     bisitz   7965: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   7966:   border-right: 8px solid #FFFF77;
1.707     bisitz   7967: }
1.795     www      7968: 
1.707     bisitz   7969: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   7970:   border-right: 8px solid #FFAA77;
1.707     bisitz   7971: }
1.795     www      7972: 
1.707     bisitz   7973: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   7974:   border-right: 8px solid #FF7777;
1.707     bisitz   7975: }
1.795     www      7976: 
1.707     bisitz   7977: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   7978:   border-right: 8px solid #AAFF77;
1.707     bisitz   7979: }
1.795     www      7980: 
1.707     bisitz   7981: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   7982:   border-right: 8px solid #11CC55;
1.707     bisitz   7983: }
                   7984: 
1.1469    raeburn  7985: table.LC_data_table tr.LC_prefs_row {
                   7986:    line-height: 250%;
                   7987: }
                   7988: 
1.388     albertel 7989: span.LC_current_location {
1.701     harmsja  7990:   font-size:larger;
1.388     albertel 7991:   background: $pgbg;
                   7992: }
1.387     albertel 7993: 
1.1029    www      7994: span.LC_current_nav_location {
                   7995:   font-weight:bold;
                   7996:   background: $sidebg;
                   7997: }
                   7998: 
1.395     albertel 7999: span.LC_parm_menu_item {
                   8000:   font-size: larger;
                   8001: }
1.795     www      8002: 
1.395     albertel 8003: span.LC_parm_scope_all {
                   8004:   color: red;
                   8005: }
1.795     www      8006: 
1.395     albertel 8007: span.LC_parm_scope_folder {
                   8008:   color: green;
                   8009: }
1.795     www      8010: 
1.395     albertel 8011: span.LC_parm_scope_resource {
                   8012:   color: orange;
                   8013: }
1.795     www      8014: 
1.395     albertel 8015: span.LC_parm_part {
                   8016:   color: blue;
                   8017: }
1.795     www      8018: 
1.911     bisitz   8019: span.LC_parm_folder,
                   8020: span.LC_parm_symb {
1.395     albertel 8021:   font-size: x-small;
                   8022:   font-family: $mono;
                   8023:   color: #AAAAAA;
                   8024: }
                   8025: 
1.977     bisitz   8026: ul.LC_parm_parmlist li {
                   8027:   display: inline-block;
                   8028:   padding: 0.3em 0.8em;
                   8029:   vertical-align: top;
                   8030:   width: 150px;
                   8031:   border-top:1px solid $lg_border_color;
                   8032: }
                   8033: 
1.795     www      8034: td.LC_parm_overview_level_menu,
                   8035: td.LC_parm_overview_map_menu,
                   8036: td.LC_parm_overview_parm_selectors,
                   8037: td.LC_parm_overview_restrictions  {
1.396     albertel 8038:   border: 1px solid black;
                   8039:   border-collapse: collapse;
                   8040: }
1.795     www      8041: 
1.1285    raeburn  8042: span.LC_parm_recursive,
                   8043: td.LC_parm_recursive {
                   8044:   font-weight: bold;
                   8045:   font-size: smaller;
                   8046: }
                   8047: 
1.396     albertel 8048: table.LC_parm_overview_restrictions td {
                   8049:   border-width: 1px 4px 1px 4px;
                   8050:   border-style: solid;
                   8051:   border-color: $pgbg;
                   8052:   text-align: center;
                   8053: }
1.795     www      8054: 
1.396     albertel 8055: table.LC_parm_overview_restrictions th {
                   8056:   background: $tabbg;
                   8057:   border-width: 1px 4px 1px 4px;
                   8058:   border-style: solid;
                   8059:   border-color: $pgbg;
                   8060: }
1.795     www      8061: 
1.1459    raeburn  8062: h1.LC_helpmenu {
                   8063:   display: inline;
                   8064:   font-size: 100%;
                   8065:   font-weight: normal;
                   8066:   line-height: 1em;
                   8067:   margin: 0;
                   8068:   padding: 0;
                   8069:   border: 0;
1.398     albertel 8070: }
1.795     www      8071: 
1.1456    raeburn  8072: .LC_helpdesk_headbox {
                   8073:   border: 2px groove threedface;
                   8074:   padding: 1em;
                   8075: }
                   8076: 
                   8077: h1.LC_helpdesk_legend {
                   8078:   float: left;
                   8079:   margin: -1.7em 0 0;
                   8080:   padding: 0 .5em;
1.397     albertel 8081:   background: $pgbg;
1.1456    raeburn  8082:   font-size: 1em;
                   8083:   font-weight: bold;
                   8084: }
                   8085: 
                   8086: h1.LC_helpdesk_title {
                   8087:   display: inline;
                   8088:   font-size: 1em;
                   8089:   line-height: 2.5em;
                   8090:   margin: 0;
1.803     bisitz   8091:   padding: 0;
1.1456    raeburn  8092:   vertical-align: bottom;
1.397     albertel 8093: }
1.795     www      8094: 
1.1456    raeburn  8095: .LC_helpdesk_links {
                   8096:   border: 1px solid black;
                   8097:   padding: 3px;
1.397     albertel 8098:   background: $tabbg;
1.399     albertel 8099:   text-align: center;
                   8100:   font-weight: bold;
1.1456    raeburn  8101:   display: inline;
                   8102:   margin-right: -6px;
                   8103: }
                   8104: 
                   8105: .LC_helpdesk_img,
                   8106: .LC_helpdesk_text {
                   8107:   padding: 0;
                   8108:   margin: 0;
                   8109:   border: 0;
                   8110:   display: inline;
1.397     albertel 8111: }
1.396     albertel 8112: 
1.1456    raeburn  8113: .LC_helpdesk_img a:link,
                   8114: .LC_helpdesk_img a:visited,
                   8115: .LC_helpdesk_img a:active,
                   8116: .LC_helpdesk_text a:link,
                   8117: .LC_helpdesk_text a:visited,
                   8118: .LC_helpdesk_text a:active {
1.397     albertel 8119:   text-decoration: none;
                   8120:   color: $font;
                   8121: }
1.795     www      8122: 
1.1456    raeburn  8123: div.LC_helpdesk_text a:hover {
1.397     albertel 8124:   text-decoration: underline;
                   8125:   color: $vlink;
                   8126: }
1.396     albertel 8127: 
1.417     albertel 8128: .LC_chrt_popup_exists {
                   8129:   border: 1px solid #339933;
                   8130:   margin: -1px;
                   8131: }
1.795     www      8132: 
1.417     albertel 8133: .LC_chrt_popup_up {
                   8134:   border: 1px solid yellow;
                   8135:   margin: -1px;
                   8136: }
1.795     www      8137: 
1.417     albertel 8138: .LC_chrt_popup {
                   8139:   border: 1px solid #8888FF;
                   8140:   background: #CCCCFF;
                   8141: }
1.795     www      8142: 
1.421     albertel 8143: table.LC_pick_box {
                   8144:   border-collapse: separate;
                   8145:   background: white;
                   8146:   border: 1px solid black;
                   8147:   border-spacing: 1px;
                   8148: }
1.795     www      8149: 
1.1454    raeburn  8150: table.LC_pick_box th.LC_pick_box_title {
1.850     bisitz   8151:   background: $sidebg;
1.421     albertel 8152:   font-weight: bold;
1.900     bisitz   8153:   text-align: left;
1.740     bisitz   8154:   vertical-align: top;
1.421     albertel 8155:   width: 184px;
                   8156:   padding: 8px;
                   8157: }
1.795     www      8158: 
1.579     raeburn  8159: table.LC_pick_box td.LC_pick_box_value {
                   8160:   text-align: left;
                   8161:   padding: 8px;
                   8162: }
1.795     www      8163: 
1.579     raeburn  8164: table.LC_pick_box td.LC_pick_box_select {
                   8165:   text-align: left;
                   8166:   padding: 8px;
                   8167: }
1.795     www      8168: 
1.424     albertel 8169: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   8170:   padding: 0;
1.421     albertel 8171:   height: 1px;
                   8172:   background: black;
                   8173: }
1.795     www      8174: 
1.421     albertel 8175: table.LC_pick_box td.LC_pick_box_submit {
                   8176:   text-align: right;
                   8177: }
1.795     www      8178: 
1.579     raeburn  8179: table.LC_pick_box td.LC_evenrow_value {
                   8180:   text-align: left;
                   8181:   padding: 8px;
                   8182:   background-color: $data_table_light;
                   8183: }
1.795     www      8184: 
1.579     raeburn  8185: table.LC_pick_box td.LC_oddrow_value {
                   8186:   text-align: left;
                   8187:   padding: 8px;
                   8188:   background-color: $data_table_light;
                   8189: }
1.795     www      8190: 
1.1473    raeburn  8191: td.LC_log_filter,
                   8192: th.LC_log_filter {
                   8193:   vertical-align: top;
                   8194:   text-align: left;
                   8195:   padding: 0 4px;
                   8196: }
                   8197: 
1.579     raeburn  8198: span.LC_helpform_receipt_cat {
                   8199:   font-weight: bold;
                   8200: }
1.795     www      8201: 
1.424     albertel 8202: table.LC_group_priv_box {
                   8203:   background: white;
                   8204:   border: 1px solid black;
                   8205:   border-spacing: 1px;
                   8206: }
1.795     www      8207: 
1.424     albertel 8208: table.LC_group_priv_box td.LC_pick_box_title {
                   8209:   background: $tabbg;
                   8210:   font-weight: bold;
                   8211:   text-align: right;
                   8212:   width: 184px;
                   8213: }
1.795     www      8214: 
1.424     albertel 8215: table.LC_group_priv_box td.LC_groups_fixed {
                   8216:   background: $data_table_light;
                   8217:   text-align: center;
                   8218: }
1.795     www      8219: 
1.424     albertel 8220: table.LC_group_priv_box td.LC_groups_optional {
                   8221:   background: $data_table_dark;
                   8222:   text-align: center;
                   8223: }
1.795     www      8224: 
1.424     albertel 8225: table.LC_group_priv_box td.LC_groups_functionality {
                   8226:   background: $data_table_darker;
                   8227:   text-align: center;
                   8228:   font-weight: bold;
                   8229: }
1.795     www      8230: 
1.424     albertel 8231: table.LC_group_priv td {
                   8232:   text-align: left;
1.803     bisitz   8233:   padding: 0;
1.424     albertel 8234: }
                   8235: 
                   8236: .LC_navbuttons {
                   8237:   margin: 2ex 0ex 2ex 0ex;
                   8238: }
1.795     www      8239: 
1.423     albertel 8240: .LC_topic_bar {
                   8241:   font-weight: bold;
                   8242:   background: $tabbg;
1.918     wenzelju 8243:   margin: 1em 0em 1em 2em;
1.805     bisitz   8244:   padding: 3px;
1.918     wenzelju 8245:   font-size: 1.2em;
1.423     albertel 8246: }
1.795     www      8247: 
1.423     albertel 8248: .LC_topic_bar span {
1.918     wenzelju 8249:   left: 0.5em;
                   8250:   position: absolute;
1.423     albertel 8251:   vertical-align: middle;
1.918     wenzelju 8252:   font-size: 1.2em;
1.423     albertel 8253: }
1.795     www      8254: 
1.423     albertel 8255: table.LC_course_group_status {
                   8256:   margin: 20px;
                   8257: }
1.795     www      8258: 
1.423     albertel 8259: table.LC_status_selector td {
                   8260:   vertical-align: top;
                   8261:   text-align: center;
1.424     albertel 8262:   padding: 4px;
                   8263: }
1.795     www      8264: 
1.599     albertel 8265: div.LC_feedback_link {
1.616     albertel 8266:   clear: both;
1.829     kalberla 8267:   background: $sidebg;
1.779     bisitz   8268:   width: 100%;
1.829     kalberla 8269:   padding-bottom: 10px;
                   8270:   border: 1px $tabbg solid;
1.833     kalberla 8271:   height: 22px;
                   8272:   line-height: 22px;
                   8273:   padding-top: 5px;
                   8274: }
                   8275: 
                   8276: div.LC_feedback_link img {
                   8277:   height: 22px;
1.867     kalberla 8278:   vertical-align:middle;
1.829     kalberla 8279: }
                   8280: 
1.911     bisitz   8281: div.LC_feedback_link a {
1.829     kalberla 8282:   text-decoration: none;
1.489     raeburn  8283: }
1.795     www      8284: 
1.867     kalberla 8285: div.LC_comblock {
1.911     bisitz   8286:   display:inline;
1.867     kalberla 8287:   color:$font;
                   8288:   font-size:90%;
                   8289: }
                   8290: 
                   8291: div.LC_feedback_link div.LC_comblock {
                   8292:   padding-left:5px;
                   8293: }
                   8294: 
                   8295: div.LC_feedback_link div.LC_comblock a {
                   8296:   color:$font;
                   8297: }
                   8298: 
1.489     raeburn  8299: span.LC_feedback_link {
1.858     bisitz   8300:   /* background: $feedback_link_bg; */
1.599     albertel 8301:   font-size: larger;
                   8302: }
1.795     www      8303: 
1.599     albertel 8304: span.LC_message_link {
1.858     bisitz   8305:   /* background: $feedback_link_bg; */
1.599     albertel 8306:   font-size: larger;
                   8307:   position: absolute;
                   8308:   right: 1em;
1.489     raeburn  8309: }
1.421     albertel 8310: 
1.515     albertel 8311: table.LC_prior_tries {
1.524     albertel 8312:   border: 1px solid #000000;
                   8313:   border-collapse: separate;
                   8314:   border-spacing: 1px;
1.515     albertel 8315: }
1.523     albertel 8316: 
1.515     albertel 8317: table.LC_prior_tries td {
1.524     albertel 8318:   padding: 2px;
1.515     albertel 8319: }
1.523     albertel 8320: 
                   8321: .LC_answer_correct {
1.795     www      8322:   background: lightgreen;
                   8323:   color: darkgreen;
                   8324:   padding: 6px;
1.523     albertel 8325: }
1.795     www      8326: 
1.523     albertel 8327: .LC_answer_charged_try {
1.797     www      8328:   background: #FFAAAA;
1.795     www      8329:   color: darkred;
                   8330:   padding: 6px;
1.523     albertel 8331: }
1.795     www      8332: 
1.779     bisitz   8333: .LC_answer_not_charged_try,
1.523     albertel 8334: .LC_answer_no_grade,
                   8335: .LC_answer_late {
1.795     www      8336:   background: lightyellow;
1.523     albertel 8337:   color: black;
1.795     www      8338:   padding: 6px;
1.523     albertel 8339: }
1.795     www      8340: 
1.523     albertel 8341: .LC_answer_previous {
1.795     www      8342:   background: lightblue;
                   8343:   color: darkblue;
                   8344:   padding: 6px;
1.523     albertel 8345: }
1.795     www      8346: 
1.779     bisitz   8347: .LC_answer_no_message {
1.777     tempelho 8348:   background: #FFFFFF;
                   8349:   color: black;
1.795     www      8350:   padding: 6px;
1.779     bisitz   8351: }
1.795     www      8352: 
1.1334    raeburn  8353: .LC_answer_unknown,
                   8354: .LC_answer_warning {
1.779     bisitz   8355:   background: orange;
                   8356:   color: black;
1.795     www      8357:   padding: 6px;
1.777     tempelho 8358: }
1.795     www      8359: 
1.1467    raeburn  8360: span.LC_prob_status {
                   8361:   margin: 5px 0 0 0;
                   8362:   padding: 0 5px 0 0;
                   8363:   vertical-align: middle;
                   8364: }
                   8365: 
                   8366: div.LC_prob_status_outer {
                   8367:   display: inline-block;
                   8368:   margin: -5px 0 0 0;
                   8369:   padding: 0;
                   8370: }
                   8371: 
                   8372: div.LC_prob_status_inner {
                   8373:   display: inline-block;
                   8374:   margin: 0 5px 0 0;
                   8375:   padding: 5px;
1.1446    raeburn  8376: }
                   8377: 
1.1468    raeburn  8378: caption.LC_filesub_status {
                   8379:   text-align: left;
                   8380:   font-weight: bold;
                   8381: }
                   8382: 
1.1448    raeburn  8383: .LC_mail_actions {
                   8384:   float: left;
                   8385:   padding: 0;
                   8386:   margin: 6px;
                   8387: }
                   8388: 
                   8389: .LC_vertical_line {
                   8390:   width: 1px;
                   8391:   background-color: black;
                   8392:   height: 4em;
                   8393:   float: left;
                   8394:   margin: 0;
                   8395:   padding: 0;
                   8396: }
                   8397: 
1.529     albertel 8398: span.LC_prior_numerical,
                   8399: span.LC_prior_string,
                   8400: span.LC_prior_custom,
                   8401: span.LC_prior_reaction,
                   8402: span.LC_prior_math {
1.925     bisitz   8403:   font-family: $mono;
1.523     albertel 8404:   white-space: pre;
                   8405: }
                   8406: 
1.525     albertel 8407: span.LC_prior_string {
1.925     bisitz   8408:   font-family: $mono;
1.525     albertel 8409:   white-space: pre;
                   8410: }
                   8411: 
1.523     albertel 8412: table.LC_prior_option {
                   8413:   width: 100%;
                   8414:   border-collapse: collapse;
                   8415: }
1.795     www      8416: 
1.911     bisitz   8417: table.LC_prior_rank,
1.795     www      8418: table.LC_prior_match {
1.528     albertel 8419:   border-collapse: collapse;
                   8420: }
1.795     www      8421: 
1.528     albertel 8422: table.LC_prior_option tr td,
                   8423: table.LC_prior_rank tr td,
                   8424: table.LC_prior_match tr td {
1.524     albertel 8425:   border: 1px solid #000000;
1.515     albertel 8426: }
                   8427: 
1.855     bisitz   8428: .LC_nobreak {
1.544     albertel 8429:   white-space: nowrap;
1.519     raeburn  8430: }
                   8431: 
1.576     raeburn  8432: span.LC_cusr_emph {
                   8433:   font-style: italic;
                   8434: }
                   8435: 
1.633     raeburn  8436: span.LC_cusr_subheading {
                   8437:   font-weight: normal;
                   8438:   font-size: 85%;
                   8439: }
                   8440: 
1.861     bisitz   8441: div.LC_docs_entry_move {
1.859     bisitz   8442:   border: 1px solid #BBBBBB;
1.545     albertel 8443:   background: #DDDDDD;
1.861     bisitz   8444:   width: 22px;
1.859     bisitz   8445:   padding: 1px;
                   8446:   margin: 0;
1.545     albertel 8447: }
                   8448: 
1.861     bisitz   8449: table.LC_data_table tr > td.LC_docs_entry_commands,
                   8450: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 8451:   font-size: x-small;
                   8452: }
1.795     www      8453: 
1.861     bisitz   8454: .LC_docs_entry_parameter {
                   8455:   white-space: nowrap;
                   8456: }
                   8457: 
1.544     albertel 8458: .LC_docs_copy {
1.545     albertel 8459:   color: #000099;
1.544     albertel 8460: }
1.795     www      8461: 
1.544     albertel 8462: .LC_docs_cut {
1.545     albertel 8463:   color: #550044;
1.544     albertel 8464: }
1.795     www      8465: 
1.544     albertel 8466: .LC_docs_rename {
1.545     albertel 8467:   color: #009900;
1.544     albertel 8468: }
1.795     www      8469: 
1.544     albertel 8470: .LC_docs_remove {
1.545     albertel 8471:   color: #990000;
                   8472: }
                   8473: 
1.1284    raeburn  8474: .LC_docs_alias {
                   8475:   color: #440055;  
                   8476: }
                   8477: 
1.1286    raeburn  8478: .LC_domprefs_email,
1.1284    raeburn  8479: .LC_docs_alias_name,
1.547     albertel 8480: .LC_docs_reinit_warn,
                   8481: .LC_docs_ext_edit {
                   8482:   font-size: x-small;
                   8483: }
                   8484: 
1.545     albertel 8485: table.LC_docs_adddocs td,
                   8486: table.LC_docs_adddocs th {
                   8487:   border: 1px solid #BBBBBB;
                   8488:   padding: 4px;
                   8489:   background: #DDDDDD;
1.543     albertel 8490: }
                   8491: 
1.584     albertel 8492: table.LC_sty_begin {
                   8493:   background: #BBFFBB;
                   8494: }
1.795     www      8495: 
1.584     albertel 8496: table.LC_sty_end {
                   8497:   background: #FFBBBB;
                   8498: }
                   8499: 
1.589     raeburn  8500: table.LC_double_column {
1.803     bisitz   8501:   border-width: 0;
1.589     raeburn  8502:   border-collapse: collapse;
                   8503:   width: 100%;
                   8504:   padding: 2px;
                   8505: }
                   8506: 
                   8507: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  8508:   top: 2px;
1.589     raeburn  8509:   left: 2px;
                   8510:   width: 47%;
                   8511:   vertical-align: top;
                   8512: }
                   8513: 
                   8514: table.LC_double_column tr td.LC_right_col {
                   8515:   top: 2px;
1.779     bisitz   8516:   right: 2px;
1.589     raeburn  8517:   width: 47%;
                   8518:   vertical-align: top;
                   8519: }
                   8520: 
1.591     raeburn  8521: div.LC_left_float {
                   8522:   float: left;
                   8523:   padding-right: 5%;
1.597     albertel 8524:   padding-bottom: 4px;
1.591     raeburn  8525: }
                   8526: 
                   8527: div.LC_clear_float_header {
1.597     albertel 8528:   padding-bottom: 2px;
1.591     raeburn  8529: }
                   8530: 
                   8531: div.LC_clear_float_footer {
1.597     albertel 8532:   padding-top: 10px;
1.591     raeburn  8533:   clear: both;
                   8534: }
                   8535: 
1.597     albertel 8536: div.LC_grade_show_user {
1.941     bisitz   8537: /*  border-left: 5px solid $sidebg; */
                   8538:   border-top: 5px solid #000000;
                   8539:   margin: 50px 0 0 0;
1.936     bisitz   8540:   padding: 15px 0 5px 10px;
1.597     albertel 8541: }
1.795     www      8542: 
1.936     bisitz   8543: div.LC_grade_show_user_odd_row {
1.941     bisitz   8544: /*  border-left: 5px solid #000000; */
                   8545: }
                   8546: 
                   8547: div.LC_grade_show_user div.LC_Box {
                   8548:   margin-right: 50px;
1.597     albertel 8549: }
                   8550: 
1.1461    raeburn  8551: div.LC_grade_show_user div.LC_Box table tr th {
                   8552:   font-weight: normal;
                   8553: }
                   8554: 
1.597     albertel 8555: div.LC_grade_submissions,
                   8556: div.LC_grade_message_center,
1.936     bisitz   8557: div.LC_grade_info_links {
1.597     albertel 8558:   margin: 5px;
                   8559:   width: 99%;
                   8560:   background: #FFFFFF;
                   8561: }
1.795     www      8562: 
1.597     albertel 8563: div.LC_grade_submissions_header,
1.936     bisitz   8564: div.LC_grade_message_center_header {
1.705     tempelho 8565:   font-weight: bold;
                   8566:   font-size: large;
1.597     albertel 8567: }
1.795     www      8568: 
1.597     albertel 8569: div.LC_grade_submissions_body,
1.936     bisitz   8570: div.LC_grade_message_center_body {
1.597     albertel 8571:   border: 1px solid black;
                   8572:   width: 99%;
                   8573:   background: #FFFFFF;
                   8574: }
1.795     www      8575: 
1.613     albertel 8576: table.LC_scantron_action {
                   8577:   width: 100%;
                   8578: }
1.795     www      8579: 
1.613     albertel 8580: table.LC_scantron_action tr th {
1.698     harmsja  8581:   font-weight:bold;
                   8582:   font-style:normal;
1.613     albertel 8583: }
1.795     www      8584: 
1.1461    raeburn  8585: div.LC_edit_problem_daxe_header {
                   8586:   padding: 3px;
                   8587:   background: $tabbg;
                   8588:   z-index: 100;
                   8589: }
                   8590: 
1.779     bisitz   8591: .LC_edit_problem_header,
1.614     albertel 8592: div.LC_edit_problem_footer {
1.705     tempelho 8593:   font-weight: normal;
                   8594:   font-size:  medium;
1.602     albertel 8595:   margin: 2px;
1.1060    bisitz   8596:   background-color: $sidebg;
1.600     albertel 8597: }
1.795     www      8598: 
1.600     albertel 8599: div.LC_edit_problem_header,
1.602     albertel 8600: div.LC_edit_problem_header div,
1.614     albertel 8601: div.LC_edit_problem_footer,
                   8602: div.LC_edit_problem_footer div,
1.602     albertel 8603: div.LC_edit_problem_editxml_header,
                   8604: div.LC_edit_problem_editxml_header div {
1.1205    golterma 8605:   z-index: 100;
1.600     albertel 8606: }
1.795     www      8607: 
1.600     albertel 8608: div.LC_edit_problem_header_title {
1.705     tempelho 8609:   font-weight: bold;
                   8610:   font-size: larger;
1.602     albertel 8611:   background: $tabbg;
                   8612:   padding: 3px;
1.1060    bisitz   8613:   margin: 0 0 5px 0;
1.602     albertel 8614: }
1.795     www      8615: 
1.602     albertel 8616: table.LC_edit_problem_header_title {
                   8617:   width: 100%;
1.600     albertel 8618:   background: $tabbg;
1.602     albertel 8619: }
                   8620: 
1.1205    golterma 8621: div.LC_edit_actionbar {
                   8622:     background-color: $sidebg;
1.1218    droeschl 8623:     margin: 0;
                   8624:     padding: 0;
                   8625:     line-height: 200%;
1.602     albertel 8626: }
1.795     www      8627: 
1.1218    droeschl 8628: div.LC_edit_actionbar div{
                   8629:     padding: 0;
                   8630:     margin: 0;
                   8631:     display: inline-block;
1.600     albertel 8632: }
1.795     www      8633: 
1.1124    bisitz   8634: .LC_edit_opt {
                   8635:   padding-left: 1em;
                   8636:   white-space: nowrap;
                   8637: }
                   8638: 
1.1152    golterma 8639: .LC_edit_problem_latexhelper{
                   8640:     text-align: right;
                   8641: }
                   8642: 
                   8643: #LC_edit_problem_colorful div{
                   8644:     margin-left: 40px;
                   8645: }
                   8646: 
1.1205    golterma 8647: #LC_edit_problem_codemirror div{
                   8648:     margin-left: 0px;
                   8649: }
                   8650: 
1.911     bisitz   8651: img.stift {
1.803     bisitz   8652:   border-width: 0;
                   8653:   vertical-align: middle;
1.677     riegler  8654: }
1.680     riegler  8655: 
1.1460    raeburn  8656: div.LC_mainmenu {
                   8657:   margin: 3px 2px 2px 1px;
                   8658:   float: left;
1.777     tempelho 8659: }
1.795     www      8660: 
1.716     raeburn  8661: div.LC_createcourse {
1.911     bisitz   8662:   margin: 10px 10px 10px 10px;
1.716     raeburn  8663: }
                   8664: 
1.917     raeburn  8665: .LC_dccid {
1.1130    raeburn  8666:   float: right;
1.917     raeburn  8667:   margin: 0.2em 0 0 0;
                   8668:   padding: 0;
                   8669:   font-size: 90%;
                   8670:   display:none;
                   8671: }
                   8672: 
1.897     wenzelju 8673: ol.LC_primary_menu a:hover,
1.721     harmsja  8674: ol#LC_MenuBreadcrumbs a:hover,
                   8675: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 8676: ul#LC_secondary_menu a:hover,
1.721     harmsja  8677: .LC_FormSectionClearButton input:hover
1.795     www      8678: ul.LC_TabContent   li:hover a {
1.952     onken    8679:   color:$button_hover;
1.911     bisitz   8680:   text-decoration:none;
1.693     droeschl 8681: }
                   8682: 
1.779     bisitz   8683: h1 {
1.911     bisitz   8684:   padding: 0;
                   8685:   line-height:130%;
1.693     droeschl 8686: }
1.698     harmsja  8687: 
1.911     bisitz   8688: h2,
                   8689: h3,
                   8690: h4,
                   8691: h5,
                   8692: h6 {
                   8693:   margin: 5px 0 5px 0;
                   8694:   padding: 0;
                   8695:   line-height:130%;
1.693     droeschl 8696: }
1.795     www      8697: 
                   8698: .LC_hcell {
1.911     bisitz   8699:   padding:3px 15px 3px 15px;
                   8700:   margin: 0;
                   8701:   background-color:$tabbg;
                   8702:   color:$fontmenu;
                   8703:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 8704: }
1.795     www      8705: 
1.840     bisitz   8706: .LC_Box > .LC_hcell {
1.911     bisitz   8707:   margin: 0 -10px 10px -10px;
1.835     bisitz   8708: }
                   8709: 
1.721     harmsja  8710: .LC_noBorder {
1.911     bisitz   8711:   border: 0;
1.698     harmsja  8712: }
1.693     droeschl 8713: 
1.721     harmsja  8714: .LC_FormSectionClearButton input {
1.911     bisitz   8715:   background-color:transparent;
                   8716:   border: none;
                   8717:   cursor:pointer;
                   8718:   text-decoration:underline;
1.693     droeschl 8719: }
1.763     bisitz   8720: 
                   8721: .LC_help_open_topic {
1.911     bisitz   8722:   color: #FFFFFF;
                   8723:   background-color: #EEEEFF;
                   8724:   margin: 1px;
                   8725:   padding: 4px;
                   8726:   border: 1px solid #000033;
                   8727:   white-space: nowrap;
                   8728:   /* vertical-align: middle; */
1.759     neumanie 8729: }
1.693     droeschl 8730: 
1.911     bisitz   8731: dl,
                   8732: ul,
                   8733: div,
                   8734: fieldset {
                   8735:   margin: 10px 10px 10px 0;
                   8736:   /* overflow: hidden; */
1.693     droeschl 8737: }
1.795     www      8738: 
1.1404    raeburn  8739: fieldset#LC_selectuser {
1.1460    raeburn  8740:   margin: -1px 0 0 0;
                   8741:   padding: 0;
                   8742:   border: 0;
1.1404    raeburn  8743: }
                   8744: 
1.1473    raeburn  8745: fieldset.LC_delete_slot {
                   8746:   display:inline;
                   8747:   margin: 0 4px 4px;
                   8748:   padding: 4px;
                   8749: }
                   8750: 
                   8751: fieldset.LC_delete_slot > legend {
                   8752:   font-weight: normal;
                   8753: }
                   8754: 
                   8755: p.LC_medium_line {
                   8756:   line-height: 0.85em;
                   8757: }
                   8758: 
1.1211    raeburn  8759: article.geogebraweb div {
                   8760:     margin: 0;
                   8761: }
                   8762: 
1.838     bisitz   8763: fieldset > legend {
1.911     bisitz   8764:   font-weight: bold;
                   8765:   padding: 0 5px 0 5px;
1.838     bisitz   8766: }
                   8767: 
1.813     bisitz   8768: #LC_nav_bar {
1.911     bisitz   8769:   float: left;
1.995     raeburn  8770:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   8771:   margin: 0 0 2px 0;
1.807     droeschl 8772: }
                   8773: 
1.916     droeschl 8774: #LC_realm {
                   8775:   margin: 0.2em 0 0 0;
                   8776:   padding: 0;
                   8777:   font-weight: bold;
                   8778:   text-align: center;
1.995     raeburn  8779:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 8780: }
                   8781: 
1.911     bisitz   8782: #LC_nav_bar em {
                   8783:   font-weight: bold;
                   8784:   font-style: normal;
1.807     droeschl 8785: }
                   8786: 
1.897     wenzelju 8787: ol.LC_primary_menu {
1.934     droeschl 8788:   margin: 0;
1.1076    raeburn  8789:   padding: 0;
1.807     droeschl 8790: }
                   8791: 
1.852     droeschl 8792: ol#LC_PathBreadcrumbs {
1.911     bisitz   8793:   margin: 0;
1.693     droeschl 8794: }
                   8795: 
1.897     wenzelju 8796: ol.LC_primary_menu li {
1.1076    raeburn  8797:   color: RGB(80, 80, 80);
                   8798:   vertical-align: middle;
                   8799:   text-align: left;
                   8800:   list-style: none;
1.1205    golterma 8801:   position: relative;
1.1076    raeburn  8802:   float: left;
1.1205    golterma 8803:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   8804:   line-height: 1.5em;
1.1076    raeburn  8805: }
                   8806: 
1.1205    golterma 8807: ol.LC_primary_menu li a,
                   8808: ol.LC_primary_menu li p {
1.1076    raeburn  8809:   display: block;
                   8810:   margin: 0;
                   8811:   padding: 0 5px 0 10px;
                   8812:   text-decoration: none;
                   8813: }
                   8814: 
1.1205    golterma 8815: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   8816:   display: inline-block;
                   8817:   width: 95%;
                   8818:   text-align: left;
                   8819: }
                   8820: 
                   8821: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   8822:   display: inline-block;	
                   8823:   width: 5%;
                   8824:   float: right;
                   8825:   text-align: right;
                   8826:   font-size: 70%;
                   8827: }
                   8828: 
                   8829: ol.LC_primary_menu ul {
1.1076    raeburn  8830:   display: none;
1.1205    golterma 8831:   width: 15em;
1.1076    raeburn  8832:   background-color: $data_table_light;
1.1205    golterma 8833:   position: absolute;
                   8834:   top: 100%;
1.1076    raeburn  8835: }
                   8836: 
1.1205    golterma 8837: ol.LC_primary_menu ul ul {
                   8838:   left: 100%;
                   8839:   top: 0;
                   8840: }
                   8841: 
                   8842: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076    raeburn  8843:   display: block;
                   8844:   position: absolute;
                   8845:   margin: 0;
                   8846:   padding: 0;
1.1078    raeburn  8847:   z-index: 2;
1.1076    raeburn  8848: }
                   8849: 
                   8850: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205    golterma 8851: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076    raeburn  8852:   font-size: 90%;
1.911     bisitz   8853:   vertical-align: top;
1.1076    raeburn  8854:   float: none;
1.1079    raeburn  8855:   border-left: 1px solid black;
                   8856:   border-right: 1px solid black;
1.1205    golterma 8857: /* A dark bottom border to visualize different menu options; 
                   8858: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   8859:   border-bottom: 1px solid $data_table_dark; 
1.1076    raeburn  8860: }
                   8861: 
1.1205    golterma 8862: ol.LC_primary_menu li li p:hover {
                   8863:   color:$button_hover;
                   8864:   text-decoration:none;
                   8865:   background-color:$data_table_dark;
1.1076    raeburn  8866: }
                   8867: 
                   8868: ol.LC_primary_menu li li a:hover {
                   8869:    color:$button_hover;
                   8870:    background-color:$data_table_dark;
1.693     droeschl 8871: }
                   8872: 
1.1205    golterma 8873: /* Font-size equal to the size of the predecessors*/
                   8874: ol.LC_primary_menu li:hover li li {
                   8875:   font-size: 100%;
                   8876: }
                   8877: 
1.897     wenzelju 8878: ol.LC_primary_menu li img {
1.911     bisitz   8879:   vertical-align: bottom;
1.934     droeschl 8880:   height: 1.1em;
1.1077    raeburn  8881:   margin: 0.2em 0 0 0;
1.693     droeschl 8882: }
                   8883: 
1.897     wenzelju 8884: ol.LC_primary_menu a {
1.911     bisitz   8885:   color: RGB(80, 80, 80);
                   8886:   text-decoration: none;
1.693     droeschl 8887: }
1.795     www      8888: 
1.949     droeschl 8889: ol.LC_primary_menu a.LC_new_message {
                   8890:   font-weight:bold;
                   8891:   color: darkred;
                   8892: }
                   8893: 
1.975     raeburn  8894: ol.LC_docs_parameters {
                   8895:   margin-left: 0;
                   8896:   padding: 0;
                   8897:   list-style: none;
                   8898: }
                   8899: 
                   8900: ol.LC_docs_parameters li {
                   8901:   margin: 0;
                   8902:   padding-right: 20px;
                   8903:   display: inline;
                   8904: }
                   8905: 
1.976     raeburn  8906: ol.LC_docs_parameters li:before {
                   8907:   content: "\\002022 \\0020";
                   8908: }
                   8909: 
                   8910: li.LC_docs_parameters_title {
                   8911:   font-weight: bold;
                   8912: }
                   8913: 
                   8914: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   8915:   content: "";
                   8916: }
                   8917: 
1.897     wenzelju 8918: ul#LC_secondary_menu {
1.1107    raeburn  8919:   clear: right;
1.911     bisitz   8920:   color: $fontmenu;
                   8921:   background: $tabbg;
                   8922:   list-style: none;
                   8923:   padding: 0;
                   8924:   margin: 0;
                   8925:   width: 100%;
1.995     raeburn  8926:   text-align: left;
1.1107    raeburn  8927:   float: left;
1.808     droeschl 8928: }
                   8929: 
1.897     wenzelju 8930: ul#LC_secondary_menu li {
1.911     bisitz   8931:   font-weight: bold;
                   8932:   line-height: 1.8em;
1.1107    raeburn  8933:   border-right: 1px solid black;
                   8934:   float: left;
                   8935: }
                   8936: 
                   8937: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   8938:   background-color: $data_table_light;
                   8939: }
                   8940: 
                   8941: ul#LC_secondary_menu li a {
1.911     bisitz   8942:   padding: 0 0.8em;
1.1107    raeburn  8943: }
                   8944: 
                   8945: ul#LC_secondary_menu li ul {
                   8946:   display: none;
                   8947: }
                   8948: 
                   8949: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   8950:   display: block;
                   8951:   position: absolute;
                   8952:   margin: 0;
                   8953:   padding: 0;
                   8954:   list-style:none;
                   8955:   float: none;
                   8956:   background-color: $data_table_light;
                   8957:   z-index: 2;
                   8958:   margin-left: -1px;
                   8959: }
                   8960: 
                   8961: ul#LC_secondary_menu li ul li {
                   8962:   font-size: 90%;
                   8963:   vertical-align: top;
                   8964:   border-left: 1px solid black;
1.911     bisitz   8965:   border-right: 1px solid black;
1.1119    raeburn  8966:   background-color: $data_table_light;
1.1107    raeburn  8967:   list-style:none;
                   8968:   float: none;
                   8969: }
                   8970: 
                   8971: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   8972:   background-color: $data_table_dark;
1.807     droeschl 8973: }
                   8974: 
1.847     tempelho 8975: ul.LC_TabContent {
1.911     bisitz   8976:   display:block;
                   8977:   background: $sidebg;
                   8978:   border-bottom: solid 1px $lg_border_color;
                   8979:   list-style:none;
1.1020    raeburn  8980:   margin: -1px -10px 0 -10px;
1.911     bisitz   8981:   padding: 0;
1.693     droeschl 8982: }
                   8983: 
1.795     www      8984: ul.LC_TabContent li,
                   8985: ul.LC_TabContentBigger li {
1.911     bisitz   8986:   float:left;
1.741     harmsja  8987: }
1.795     www      8988: 
1.897     wenzelju 8989: ul#LC_secondary_menu li a {
1.911     bisitz   8990:   color: $fontmenu;
                   8991:   text-decoration: none;
1.693     droeschl 8992: }
1.795     www      8993: 
1.721     harmsja  8994: ul.LC_TabContent {
1.952     onken    8995:   min-height:20px;
1.721     harmsja  8996: }
1.795     www      8997: 
                   8998: ul.LC_TabContent li {
1.911     bisitz   8999:   vertical-align:middle;
1.959     onken    9000:   padding: 0 16px 0 10px;
1.911     bisitz   9001:   background-color:$tabbg;
                   9002:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  9003:   border-left: solid 1px $font;
1.721     harmsja  9004: }
1.795     www      9005: 
1.847     tempelho 9006: ul.LC_TabContent .right {
1.911     bisitz   9007:   float:right;
1.847     tempelho 9008: }
                   9009: 
1.911     bisitz   9010: ul.LC_TabContent li a,
                   9011: ul.LC_TabContent li {
                   9012:   color:rgb(47,47,47);
                   9013:   text-decoration:none;
                   9014:   font-size:95%;
                   9015:   font-weight:bold;
1.952     onken    9016:   min-height:20px;
                   9017: }
                   9018: 
1.959     onken    9019: ul.LC_TabContent li a:hover,
                   9020: ul.LC_TabContent li a:focus {
1.952     onken    9021:   color: $button_hover;
1.959     onken    9022:   background:none;
                   9023:   outline:none;
1.952     onken    9024: }
                   9025: 
                   9026: ul.LC_TabContent li:hover {
                   9027:   color: $button_hover;
                   9028:   cursor:pointer;
1.721     harmsja  9029: }
1.795     www      9030: 
1.911     bisitz   9031: ul.LC_TabContent li.active {
1.952     onken    9032:   color: $font;
1.911     bisitz   9033:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    9034:   border-bottom:solid 1px #FFFFFF;
                   9035:   cursor: default;
1.744     ehlerst  9036: }
1.795     www      9037: 
1.959     onken    9038: ul.LC_TabContent li.active a {
                   9039:   color:$font;
                   9040:   background:#FFFFFF;
                   9041:   outline: none;
                   9042: }
1.1047    raeburn  9043: 
                   9044: ul.LC_TabContent li.goback {
                   9045:   float: left;
                   9046:   border-left: none;
                   9047: }
                   9048: 
1.870     tempelho 9049: #maincoursedoc {
1.911     bisitz   9050:   clear:both;
1.870     tempelho 9051: }
                   9052: 
                   9053: ul.LC_TabContentBigger {
1.911     bisitz   9054:   display:block;
                   9055:   list-style:none;
                   9056:   padding: 0;
1.870     tempelho 9057: }
                   9058: 
1.795     www      9059: ul.LC_TabContentBigger li {
1.911     bisitz   9060:   vertical-align:bottom;
                   9061:   height: 30px;
                   9062:   font-size:110%;
                   9063:   font-weight:bold;
                   9064:   color: #737373;
1.841     tempelho 9065: }
                   9066: 
1.957     onken    9067: ul.LC_TabContentBigger li.active {
                   9068:   position: relative;
                   9069:   top: 1px;
                   9070: }
                   9071: 
1.870     tempelho 9072: ul.LC_TabContentBigger li a {
1.911     bisitz   9073:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   9074:   height: 30px;
                   9075:   line-height: 30px;
                   9076:   text-align: center;
                   9077:   display: block;
                   9078:   text-decoration: none;
1.958     onken    9079:   outline: none;  
1.741     harmsja  9080: }
1.795     www      9081: 
1.870     tempelho 9082: ul.LC_TabContentBigger li.active a {
1.911     bisitz   9083:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   9084:   color:$font;
1.744     ehlerst  9085: }
1.795     www      9086: 
1.870     tempelho 9087: ul.LC_TabContentBigger li b {
1.911     bisitz   9088:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   9089:   display: block;
                   9090:   float: left;
                   9091:   padding: 0 30px;
1.957     onken    9092:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 9093: }
                   9094: 
1.956     onken    9095: ul.LC_TabContentBigger li:hover b {
                   9096:   color:$button_hover;
                   9097: }
                   9098: 
1.870     tempelho 9099: ul.LC_TabContentBigger li.active b {
1.911     bisitz   9100:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   9101:   color:$font;
1.957     onken    9102:   border: 0;
1.741     harmsja  9103: }
1.693     droeschl 9104: 
1.870     tempelho 9105: 
1.862     bisitz   9106: ul.LC_CourseBreadcrumbs {
                   9107:   background: $sidebg;
1.1020    raeburn  9108:   height: 2em;
1.862     bisitz   9109:   padding-left: 10px;
1.1020    raeburn  9110:   margin: 0;
1.862     bisitz   9111:   list-style-position: inside;
                   9112: }
                   9113: 
1.911     bisitz   9114: ol#LC_MenuBreadcrumbs,
1.862     bisitz   9115: ol#LC_PathBreadcrumbs {
1.911     bisitz   9116:   padding-left: 10px;
                   9117:   margin: 0;
1.933     droeschl 9118:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 9119: }
                   9120: 
1.911     bisitz   9121: ol#LC_MenuBreadcrumbs li,
                   9122: ol#LC_PathBreadcrumbs li,
1.862     bisitz   9123: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   9124:   display: inline;
1.933     droeschl 9125:   white-space: normal;  
1.693     droeschl 9126: }
                   9127: 
1.823     bisitz   9128: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   9129: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   9130:   text-decoration: none;
                   9131:   font-size:90%;
1.693     droeschl 9132: }
1.795     www      9133: 
1.969     droeschl 9134: ol#LC_MenuBreadcrumbs h1 {
                   9135:   display: inline;
                   9136:   font-size: 90%;
                   9137:   line-height: 2.5em;
                   9138:   margin: 0;
                   9139:   padding: 0;
                   9140: }
                   9141: 
1.795     www      9142: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   9143:   text-decoration:none;
                   9144:   font-size:100%;
                   9145:   font-weight:bold;
1.693     droeschl 9146: }
1.795     www      9147: 
1.840     bisitz   9148: .LC_Box {
1.911     bisitz   9149:   border: solid 1px $lg_border_color;
                   9150:   padding: 0 10px 10px 10px;
1.746     neumanie 9151: }
1.795     www      9152: 
1.1020    raeburn  9153: .LC_DocsBox {
                   9154:   border: solid 1px $lg_border_color;
                   9155:   padding: 0 0 10px 10px;
                   9156: }
                   9157: 
1.795     www      9158: .LC_AboutMe_Image {
1.911     bisitz   9159:   float:left;
                   9160:   margin-right:10px;
1.747     neumanie 9161: }
1.795     www      9162: 
                   9163: .LC_Clear_AboutMe_Image {
1.911     bisitz   9164:   clear:left;
1.747     neumanie 9165: }
1.795     www      9166: 
1.721     harmsja  9167: dl.LC_ListStyleClean dt {
1.911     bisitz   9168:   padding-right: 5px;
                   9169:   display: table-header-group;
1.693     droeschl 9170: }
                   9171: 
1.721     harmsja  9172: dl.LC_ListStyleClean dd {
1.911     bisitz   9173:   display: table-row;
1.693     droeschl 9174: }
                   9175: 
1.721     harmsja  9176: .LC_ListStyleClean,
                   9177: .LC_ListStyleSimple,
                   9178: .LC_ListStyleNormal,
1.795     www      9179: .LC_ListStyleSpecial {
1.911     bisitz   9180:   /* display:block; */
                   9181:   list-style-position: inside;
                   9182:   list-style-type: none;
                   9183:   overflow: hidden;
                   9184:   padding: 0;
1.693     droeschl 9185: }
                   9186: 
1.721     harmsja  9187: .LC_ListStyleSimple li,
                   9188: .LC_ListStyleSimple dd,
                   9189: .LC_ListStyleNormal li,
                   9190: .LC_ListStyleNormal dd,
                   9191: .LC_ListStyleSpecial li,
1.795     www      9192: .LC_ListStyleSpecial dd {
1.911     bisitz   9193:   margin: 0;
                   9194:   padding: 5px 5px 5px 10px;
                   9195:   clear: both;
1.693     droeschl 9196: }
                   9197: 
1.721     harmsja  9198: .LC_ListStyleClean li,
                   9199: .LC_ListStyleClean dd {
1.911     bisitz   9200:   padding-top: 0;
                   9201:   padding-bottom: 0;
1.693     droeschl 9202: }
                   9203: 
1.721     harmsja  9204: .LC_ListStyleSimple dd,
1.795     www      9205: .LC_ListStyleSimple li {
1.911     bisitz   9206:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 9207: }
                   9208: 
1.721     harmsja  9209: .LC_ListStyleSpecial li,
                   9210: .LC_ListStyleSpecial dd {
1.911     bisitz   9211:   list-style-type: none;
                   9212:   background-color: RGB(220, 220, 220);
                   9213:   margin-bottom: 4px;
1.693     droeschl 9214: }
                   9215: 
1.721     harmsja  9216: table.LC_SimpleTable {
1.911     bisitz   9217:   margin:5px;
                   9218:   border:solid 1px $lg_border_color;
1.795     www      9219: }
1.693     droeschl 9220: 
1.721     harmsja  9221: table.LC_SimpleTable tr {
1.911     bisitz   9222:   padding: 0;
                   9223:   border:solid 1px $lg_border_color;
1.693     droeschl 9224: }
1.795     www      9225: 
                   9226: table.LC_SimpleTable thead {
1.911     bisitz   9227:   background:rgb(220,220,220);
1.693     droeschl 9228: }
                   9229: 
1.721     harmsja  9230: div.LC_columnSection {
1.911     bisitz   9231:   display: block;
                   9232:   clear: both;
                   9233:   overflow: hidden;
                   9234:   margin: 0;
1.693     droeschl 9235: }
                   9236: 
1.721     harmsja  9237: div.LC_columnSection>* {
1.911     bisitz   9238:   float: left;
                   9239:   margin: 10px 20px 10px 0;
                   9240:   overflow:hidden;
1.693     droeschl 9241: }
1.721     harmsja  9242: 
1.795     www      9243: table em {
1.911     bisitz   9244:   font-weight: bold;
                   9245:   font-style: normal;
1.748     schulted 9246: }
1.795     www      9247: 
1.779     bisitz   9248: table.LC_tableBrowseRes,
1.795     www      9249: table.LC_tableOfContent {
1.911     bisitz   9250:   border:none;
                   9251:   border-spacing: 1px;
                   9252:   padding: 3px;
                   9253:   background-color: #FFFFFF;
                   9254:   font-size: 90%;
1.753     droeschl 9255: }
1.789     droeschl 9256: 
1.911     bisitz   9257: table.LC_tableOfContent {
                   9258:   border-collapse: collapse;
1.789     droeschl 9259: }
                   9260: 
1.771     droeschl 9261: table.LC_tableBrowseRes a,
1.768     schulted 9262: table.LC_tableOfContent a {
1.911     bisitz   9263:   background-color: transparent;
                   9264:   text-decoration: none;
1.753     droeschl 9265: }
                   9266: 
1.795     www      9267: table.LC_tableOfContent img {
1.911     bisitz   9268:   border: none;
                   9269:   height: 1.3em;
                   9270:   vertical-align: text-bottom;
                   9271:   margin-right: 0.3em;
1.753     droeschl 9272: }
1.757     schulted 9273: 
1.795     www      9274: a#LC_content_toolbar_firsthomework {
1.911     bisitz   9275:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  9276: }
                   9277: 
1.795     www      9278: a#LC_content_toolbar_everything {
1.911     bisitz   9279:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  9280: }
                   9281: 
1.795     www      9282: a#LC_content_toolbar_uncompleted {
1.911     bisitz   9283:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  9284: }
                   9285: 
1.795     www      9286: #LC_content_toolbar_clearbubbles {
1.911     bisitz   9287:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  9288: }
                   9289: 
1.795     www      9290: a#LC_content_toolbar_changefolder {
1.911     bisitz   9291:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 9292: }
                   9293: 
1.795     www      9294: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   9295:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 9296: }
                   9297: 
1.1043    raeburn  9298: a#LC_content_toolbar_edittoplevel {
                   9299:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   9300: }
                   9301: 
1.1384    raeburn  9302: a#LC_content_toolbar_printout {
                   9303:   background-image:url(/res/adm/pages/printout.gif);
                   9304: }
                   9305: 
1.795     www      9306: ul#LC_toolbar li a:hover {
1.911     bisitz   9307:   background-position: bottom center;
1.757     schulted 9308: }
                   9309: 
1.795     www      9310: ul#LC_toolbar {
1.911     bisitz   9311:   padding: 0;
                   9312:   margin: 2px;
                   9313:   list-style:none;
1.1449    raeburn  9314:   display:inline;
1.911     bisitz   9315:   background-color:white;
1.1082    raeburn  9316:   overflow: auto;
1.757     schulted 9317: }
                   9318: 
1.795     www      9319: ul#LC_toolbar li {
1.911     bisitz   9320:   border:1px solid white;
                   9321:   padding: 0;
                   9322:   margin: 0;
                   9323:   float: left;
                   9324:   display:inline;
                   9325:   vertical-align:middle;
1.1082    raeburn  9326:   white-space: nowrap;
1.911     bisitz   9327: }
1.757     schulted 9328: 
1.783     amueller 9329: 
1.795     www      9330: a.LC_toolbarItem {
1.911     bisitz   9331:   display:block;
                   9332:   padding: 0;
                   9333:   margin: 0;
                   9334:   height: 32px;
                   9335:   width: 32px;
                   9336:   color:white;
                   9337:   border: none;
                   9338:   background-repeat:no-repeat;
                   9339:   background-color:transparent;
1.757     schulted 9340: }
                   9341: 
1.1449    raeburn  9342: .LC_navtools {
                   9343:   display: inline-block;
                   9344:   padding: 0;
                   9345:   margin: 2px;
                   9346:   vertical-align: middle;
                   9347: }
                   9348: 
1.915     droeschl 9349: ul.LC_funclist {
                   9350:     margin: 0;
                   9351:     padding: 0.5em 1em 0.5em 0;
                   9352: }
                   9353: 
1.933     droeschl 9354: ul.LC_funclist > li:first-child {
                   9355:     font-weight:bold; 
                   9356:     margin-left:0.8em;
                   9357: }
                   9358: 
1.915     droeschl 9359: ul.LC_funclist + ul.LC_funclist {
                   9360:     /* 
                   9361:        left border as a seperator if we have more than
                   9362:        one list 
                   9363:     */
                   9364:     border-left: 1px solid $sidebg;
                   9365:     /* 
                   9366:        this hides the left border behind the border of the 
                   9367:        outer box if element is wrapped to the next 'line' 
                   9368:     */
                   9369:     margin-left: -1px;
                   9370: }
                   9371: 
1.843     bisitz   9372: ul.LC_funclist li {
1.915     droeschl 9373:   display: inline;
1.782     bisitz   9374:   white-space: nowrap;
1.915     droeschl 9375:   margin: 0 0 0 25px;
                   9376:   line-height: 150%;
1.782     bisitz   9377: }
                   9378: 
1.974     wenzelju 9379: .LC_hidden {
                   9380:   display: none;
                   9381: }
                   9382: 
1.1030    www      9383: .LCmodal-overlay {
                   9384: 		position:fixed;
                   9385: 		top:0;
                   9386: 		right:0;
                   9387: 		bottom:0;
                   9388: 		left:0;
                   9389: 		height:100%;
                   9390: 		width:100%;
                   9391: 		margin:0;
                   9392: 		padding:0;
                   9393: 		background:#999;
                   9394: 		opacity:.75;
                   9395: 		filter: alpha(opacity=75);
                   9396: 		-moz-opacity: 0.75;
                   9397: 		z-index:101;
                   9398: }
                   9399: 
                   9400: * html .LCmodal-overlay {   
                   9401: 		position: absolute;
                   9402: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   9403: }
                   9404: 
                   9405: .LCmodal-window {
                   9406: 		position:fixed;
                   9407: 		top:50%;
                   9408: 		left:50%;
                   9409: 		margin:0;
                   9410: 		padding:0;
                   9411: 		z-index:102;
                   9412: 	}
                   9413: 
                   9414: * html .LCmodal-window {
                   9415: 		position:absolute;
                   9416: }
                   9417: 
                   9418: .LCclose-window {
                   9419: 		position:absolute;
                   9420: 		width:32px;
                   9421: 		height:32px;
                   9422: 		right:8px;
                   9423: 		top:8px;
                   9424: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   9425: 		text-indent:-99999px;
                   9426: 		overflow:hidden;
                   9427: 		cursor:pointer;
                   9428: }
                   9429: 
1.1369    raeburn  9430: .LCisDisabled {
                   9431:   cursor: not-allowed;
                   9432:   opacity: 0.5;
                   9433: }
                   9434: 
                   9435: a[aria-disabled="true"] {
                   9436:   color: currentColor;
                   9437:   display: inline-block;  /* For IE11/ MS Edge bug */
                   9438:   pointer-events: none;
                   9439:   text-decoration: none;
                   9440: }
                   9441: 
1.1335    raeburn  9442: pre.LC_wordwrap {
                   9443:   white-space: pre-wrap;
                   9444:   white-space: -moz-pre-wrap;
                   9445:   white-space: -pre-wrap;
                   9446:   white-space: -o-pre-wrap;
                   9447:   word-wrap: break-word;
                   9448: }
                   9449: 
1.1100    raeburn  9450: /*
1.1231    damieng  9451:   styles used for response display
                   9452: */
1.1464    raeburn  9453: div.LC_radiofoil, div.LC_rankfoil, div.LC_optionfoil, div.LC_matchfoil, div.LC_login_links {
1.1231    damieng  9454:   margin: .5em 0em .5em 0em;
                   9455: }
                   9456: table.LC_itemgroup {
                   9457:   margin-top: 1em;
                   9458: }
                   9459: 
1.1462    raeburn  9460: table.LC_itemgroup tr th {
                   9461:   font-weight: normal;
                   9462: }
                   9463: 
                   9464: fieldset.LC_webbubbles {
                   9465:   margin: 2px 0 0 0;
                   9466:   padding: 0;
                   9467:   border: 0;
                   9468: }
                   9469: 
                   9470: ul.LC_webbubbles {
                   9471:   list-style: none;
                   9472:   padding: 0;
                   9473:   margin: 0;
                   9474:   text-align: left;
                   9475:   float: left;
                   9476: }
                   9477: 
                   9478: ul.LC_webbubbles li {
                   9479:   line-height: 1.8em;
                   9480:   border: 1px solid black;
                   9481:   padding: 0 2px 0 5px;
                   9482:   margin: 0 0 0 -1px;
                   9483:   float: left;
                   9484: }
                   9485: 
1.1231    damieng  9486: /*
1.1100    raeburn  9487:   styles used by TTH when "Default set of options to pass to tth/m
                   9488:   when converting TeX" in course settings has been set
                   9489: 
                   9490:   option passed: -t
                   9491: 
                   9492: */
                   9493: 
                   9494: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   9495: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   9496: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   9497: td div.norm {line-height:normal;}
                   9498: 
                   9499: /*
                   9500:   option passed -y3
                   9501: */
                   9502: 
                   9503: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   9504: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   9505: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   9506: 
1.1230    damieng  9507: /*
                   9508:   sections with roles, for content only
                   9509: */
                   9510: section[class^="role-"] {
                   9511:   padding-left: 10px;
                   9512:   padding-right: 5px;
                   9513:   margin-top: 8px;
                   9514:   margin-bottom: 8px;
                   9515:   border: 1px solid #2A4;
                   9516:   border-radius: 5px;
                   9517:   box-shadow: 0px 1px 1px #BBB;
                   9518: }
                   9519: section[class^="role-"]>h1 {
                   9520:   position: relative;
                   9521:   margin: 0px;
                   9522:   padding-top: 10px;
                   9523:   padding-left: 40px;
                   9524: }
                   9525: section[class^="role-"]>h1:before {
                   9526:   position: absolute;
                   9527:   left: -5px;
                   9528:   top: 5px;
                   9529: }
                   9530: section.role-activity>h1:before {
                   9531:   content:url('/adm/daxe/images/section_icons/activity.png');
                   9532: }
                   9533: section.role-advice>h1:before {
                   9534:   content:url('/adm/daxe/images/section_icons/advice.png');
                   9535: }
                   9536: section.role-bibliography>h1:before {
                   9537:   content:url('/adm/daxe/images/section_icons/bibliography.png');
                   9538: }
                   9539: section.role-citation>h1:before {
                   9540:   content:url('/adm/daxe/images/section_icons/citation.png');
                   9541: }
                   9542: section.role-conclusion>h1:before {
                   9543:   content:url('/adm/daxe/images/section_icons/conclusion.png');
                   9544: }
                   9545: section.role-definition>h1:before {
                   9546:   content:url('/adm/daxe/images/section_icons/definition.png');
                   9547: }
                   9548: section.role-demonstration>h1:before {
                   9549:   content:url('/adm/daxe/images/section_icons/demonstration.png');
                   9550: }
                   9551: section.role-example>h1:before {
                   9552:   content:url('/adm/daxe/images/section_icons/example.png');
                   9553: }
                   9554: section.role-explanation>h1:before {
                   9555:   content:url('/adm/daxe/images/section_icons/explanation.png');
                   9556: }
                   9557: section.role-introduction>h1:before {
                   9558:   content:url('/adm/daxe/images/section_icons/introduction.png');
                   9559: }
                   9560: section.role-method>h1:before {
                   9561:   content:url('/adm/daxe/images/section_icons/method.png');
                   9562: }
                   9563: section.role-more_information>h1:before {
                   9564:   content:url('/adm/daxe/images/section_icons/more_information.png');
                   9565: }
                   9566: section.role-objectives>h1:before {
                   9567:   content:url('/adm/daxe/images/section_icons/objectives.png');
                   9568: }
                   9569: section.role-prerequisites>h1:before {
                   9570:   content:url('/adm/daxe/images/section_icons/prerequisites.png');
                   9571: }
                   9572: section.role-remark>h1:before {
                   9573:   content:url('/adm/daxe/images/section_icons/remark.png');
                   9574: }
                   9575: section.role-reminder>h1:before {
                   9576:   content:url('/adm/daxe/images/section_icons/reminder.png');
                   9577: }
                   9578: section.role-summary>h1:before {
                   9579:   content:url('/adm/daxe/images/section_icons/summary.png');
                   9580: }
                   9581: section.role-syntax>h1:before {
                   9582:   content:url('/adm/daxe/images/section_icons/syntax.png');
                   9583: }
                   9584: section.role-warning>h1:before {
                   9585:   content:url('/adm/daxe/images/section_icons/warning.png');
                   9586: }
                   9587: 
1.1269    raeburn  9588: #LC_minitab_header {
                   9589:   float:left;
                   9590:   width:100%;
                   9591:   background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
                   9592:   font-size:93%;
                   9593:   line-height:normal;
                   9594:   margin: 0.5em 0 0.5em 0;
                   9595: }
                   9596: #LC_minitab_header ul {
                   9597:   margin:0;
                   9598:   padding:10px 10px 0;
                   9599:   list-style:none;
                   9600: }
                   9601: #LC_minitab_header li {
                   9602:   float:left;
                   9603:   background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
                   9604:   margin:0;
                   9605:   padding:0 0 0 9px;
                   9606: }
                   9607: #LC_minitab_header a {
                   9608:   display:block;
                   9609:   background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
                   9610:   padding:5px 15px 4px 6px;
                   9611: }
                   9612: #LC_minitab_header #LC_current_minitab {
                   9613:   background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
                   9614: }
                   9615: #LC_minitab_header #LC_current_minitab a {
                   9616:   background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
                   9617:   padding-bottom:5px;
                   9618: }
                   9619: 
                   9620: 
1.343     albertel 9621: END
                   9622: }
                   9623: 
1.306     albertel 9624: =pod
                   9625: 
                   9626: =item * &headtag()
                   9627: 
                   9628: Returns a uniform footer for LON-CAPA web pages.
                   9629: 
1.307     albertel 9630: Inputs: $title - optional title for the head
                   9631:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 9632:         $args - optional arguments
1.319     albertel 9633:             force_register - if is true call registerurl so the remote is 
                   9634:                              informed
1.415     albertel 9635:             redirect       -> array ref of
                   9636:                                    1- seconds before redirect occurs
                   9637:                                    2- url to redirect to
                   9638:                                    3- whether the side effect should occur
1.315     albertel 9639:                            (side effect of setting 
                   9640:                                $env{'internal.head.redirect'} to the url 
1.1386    raeburn  9641:                                redirected to)
                   9642:                                    4- whether the redirect target should be
                   9643:                                       the opener of the current (pop-up)
                   9644:                                       window (side effect of setting
                   9645:                                       $env{'internal.head.to_opener'} to
                   9646:                                       1, if true.
1.1388    raeburn  9647:                                    5- whether encrypt check should be skipped
1.352     albertel 9648:             domain         -> force to color decorate a page for a specific
                   9649:                                domain
                   9650:             function       -> force usage of a specific rolish color scheme
                   9651:             bgcolor        -> override the default page bgcolor
1.460     albertel 9652:             no_auto_mt_title
                   9653:                            -> prevent &mt()ing the title arg
1.464     albertel 9654: 
1.306     albertel 9655: =cut
                   9656: 
                   9657: sub headtag {
1.313     albertel 9658:     my ($title,$head_extra,$args) = @_;
1.306     albertel 9659:     
1.363     albertel 9660:     my $function = $args->{'function'} || &get_users_function();
                   9661:     my $domain   = $args->{'domain'}   || &determinedomain();
                   9662:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1154    raeburn  9663:     my $httphost = $args->{'use_absolute'};
1.418     albertel 9664:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 9665: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 9666: 		   #time(),
1.418     albertel 9667: 		   $env{'environment.color.timestamp'},
1.363     albertel 9668: 		   $function,$domain,$bgcolor);
                   9669: 
1.369     www      9670:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 9671: 
1.308     albertel 9672:     my $result =
                   9673: 	'<head>'.
1.1160    raeburn  9674: 	&font_settings($args);
1.319     albertel 9675: 
1.1188    raeburn  9676:     my $inhibitprint;
                   9677:     if ($args->{'print_suppress'}) {
                   9678:         $inhibitprint = &print_suppression();
                   9679:     }
1.1064    raeburn  9680: 
1.1439    raeburn  9681:     if (!$args->{'frameset'} && !$args->{'switchserver'}) {
1.461     albertel 9682: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   9683:     }
1.962     droeschl 9684:     if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
                   9685:         $result .= Apache::lonxml::display_title();
1.319     albertel 9686:     }
1.436     albertel 9687:     if (!$args->{'no_nav_bar'} 
                   9688: 	&& !$args->{'only_body'}
1.1438    raeburn  9689: 	&& !$args->{'frameset'}
                   9690: 	&& !$args->{'switchserver'}) {
1.1154    raeburn  9691: 	$result .= &help_menu_js($httphost);
1.1032    www      9692:         $result.=&modal_window();
1.1038    www      9693:         $result.=&togglebox_script();
1.1034    www      9694:         $result.=&wishlist_window();
1.1041    www      9695:         $result.=&LCprogressbarUpdate_script();
1.1034    www      9696:     } else {
                   9697:         if ($args->{'add_modal'}) {
                   9698:            $result.=&modal_window();
                   9699:         }
                   9700:         if ($args->{'add_wishlist'}) {
                   9701:            $result.=&wishlist_window();
                   9702:         }
1.1038    www      9703:         if ($args->{'add_togglebox'}) {
                   9704:            $result.=&togglebox_script();
                   9705:         }
1.1041    www      9706:         if ($args->{'add_progressbar'}) {
                   9707:            $result.=&LCprogressbarUpdate_script();
                   9708:         }
1.436     albertel 9709:     }
1.314     albertel 9710:     if (ref($args->{'redirect'})) {
1.1388    raeburn  9711: 	my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
                   9712:         if (!$skip_enc_check) {
                   9713:             $url = &Apache::lonenc::check_encrypt($url);
                   9714:         }
1.414     albertel 9715: 	if (!$inhibit_continue) {
                   9716: 	    $env{'internal.head.redirect'} = $url;
                   9717: 	}
1.1386    raeburn  9718: 	$result.=<<"ADDMETA";
1.313     albertel 9719: <meta http-equiv="pragma" content="no-cache" />
1.1386    raeburn  9720: ADDMETA
                   9721:         if ($to_opener) {
                   9722:             $env{'internal.head.to_opener'} = 1;
                   9723:             my $dest = &js_escape($url);
                   9724:             my $timeout = int($time * 1000);
                   9725:             $result .=<<"ENDJS";
                   9726: <script type="text/javascript">
                   9727: // <![CDATA[
                   9728: function LC_To_Opener() {
                   9729:     var dest = '$dest';
                   9730:     if (dest != '') {
                   9731:         if (window.opener != null && !window.opener.closed) {
                   9732:             window.opener.location.href=dest;
                   9733:             window.close();
                   9734:         } else {
                   9735:             window.location.href=dest;
                   9736:         }
                   9737:     }
                   9738: }
                   9739: \$(document).ready(function () {
                   9740:     setTimeout('LC_To_Opener()',$timeout);
                   9741: });
                   9742: // ]]>
                   9743: </script>
                   9744: ENDJS
                   9745:         } else {
                   9746:             $result.=<<"ADDMETA";
1.344     albertel 9747: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 9748: ADDMETA
1.1386    raeburn  9749:         }
1.1210    raeburn  9750:     } else {
                   9751:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
                   9752:             my $requrl = $env{'request.uri'};
                   9753:             if ($requrl eq '') {
                   9754:                 $requrl = $ENV{'REQUEST_URI'};
                   9755:                 $requrl =~ s/\?.+$//;
                   9756:             }
                   9757:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
                   9758:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
                   9759:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
                   9760:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
                   9761:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
                   9762:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340    raeburn  9763:                     my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352    raeburn  9764:                     my ($offload,$offloadoth);
1.1210    raeburn  9765:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
                   9766:                         if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340    raeburn  9767:                             $offload = 1;
1.1353    raeburn  9768:                             if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   9769:                                 (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   9770:                                 unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   9771:                                     $offloadoth = 1;
                   9772:                                     $dom_in_use = $env{'user.domain'};
                   9773:                                 }
                   9774:                             }
1.1340    raeburn  9775:                         }
                   9776:                     }
                   9777:                     unless ($offload) {
                   9778:                         if (ref($domdefs{'offloadoth'}) eq 'HASH') {
                   9779:                             if ($domdefs{'offloadoth'}{$lonhost}) {
                   9780:                                 if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   9781:                                     (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   9782:                                     unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   9783:                                         $offload = 1;
1.1352    raeburn  9784:                                         $offloadoth = 1;
1.1340    raeburn  9785:                                         $dom_in_use = $env{'user.domain'};
                   9786:                                     }
1.1210    raeburn  9787:                                 }
1.1340    raeburn  9788:                             }
                   9789:                         }
                   9790:                     }
                   9791:                     if ($offload) {
1.1358    raeburn  9792:                         my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352    raeburn  9793:                         if (($newserver eq '') && ($offloadoth)) {
                   9794:                             my @domains = &Apache::lonnet::current_machine_domains();
                   9795:                             if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) { 
                   9796:                                 ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
                   9797:                             }
                   9798:                         }
1.1340    raeburn  9799:                         if (($newserver) && ($newserver ne $lonhost)) {
                   9800:                             my $numsec = 5;
                   9801:                             my $timeout = $numsec * 1000;
                   9802:                             my ($newurl,$locknum,%locks,$msg);
                   9803:                             if ($env{'request.role.adv'}) {
                   9804:                                 ($locknum,%locks) = &Apache::lonnet::get_locks();
                   9805:                             }
                   9806:                             my $disable_submit = 0;
                   9807:                             if ($requrl =~ /$LONCAPA::assess_re/) {
                   9808:                                 $disable_submit = 1;
                   9809:                             }
                   9810:                             if ($locknum) {
                   9811:                                 my @lockinfo = sort(values(%locks));
1.1354    raeburn  9812:                                 $msg = &mt('Once the following tasks are complete:')." \n".
1.1340    raeburn  9813:                                        join(", ",sort(values(%locks)))."\n";
                   9814:                                 if (&show_course()) {
                   9815:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
                   9816:                                 } else {
                   9817:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210    raeburn  9818:                                 }
1.1340    raeburn  9819:                             } else {
                   9820:                                 if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
                   9821:                                     $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
                   9822:                                 }
                   9823:                                 $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
                   9824:                                 $newurl = '/adm/switchserver?otherserver='.$newserver;
                   9825:                                 if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
                   9826:                                     $newurl .= '&role='.$env{'request.role'};
                   9827:                                 }
                   9828:                                 if ($env{'request.symb'}) {
                   9829:                                     my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
                   9830:                                     if ($shownsymb =~ m{^/enc/}) {
                   9831:                                         my $reqdmajor = 2;
                   9832:                                         my $reqdminor = 11;
                   9833:                                         my $reqdsubminor = 3;
                   9834:                                         my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
                   9835:                                         my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
                   9836:                                         my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
                   9837:                                         if (($major eq '' && $minor eq '') ||
                   9838:                                             (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
                   9839:                                             (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
                   9840:                                              ($reqdsubminor > $subminor))))) {
                   9841:                                             undef($shownsymb);
                   9842:                                         }
1.1210    raeburn  9843:                                     }
1.1340    raeburn  9844:                                     if ($shownsymb) {
                   9845:                                         &js_escape(\$shownsymb);
                   9846:                                         $newurl .= '&symb='.$shownsymb;
1.1210    raeburn  9847:                                     }
1.1340    raeburn  9848:                                 } else {
                   9849:                                     my $shownurl = &Apache::lonenc::check_encrypt($requrl);
                   9850:                                     &js_escape(\$shownurl);
                   9851:                                     $newurl .= '&origurl='.$shownurl;
1.1210    raeburn  9852:                                 }
1.1340    raeburn  9853:                             }
                   9854:                             &js_escape(\$msg);
                   9855:                             $result.=<<OFFLOAD
1.1210    raeburn  9856: <meta http-equiv="pragma" content="no-cache" />
                   9857: <script type="text/javascript">
1.1215    raeburn  9858: // <![CDATA[
1.1210    raeburn  9859: function LC_Offload_Now() {
                   9860:     var dest = "$newurl";
                   9861:     if (dest != '') {
                   9862:         window.location.href="$newurl";
                   9863:     }
                   9864: }
1.1214    raeburn  9865: \$(document).ready(function () {
                   9866:     window.alert('$msg');
                   9867:     if ($disable_submit) {
1.1210    raeburn  9868:         \$(".LC_hwk_submit").prop("disabled", true);
                   9869:         \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214    raeburn  9870:     }
                   9871:     setTimeout('LC_Offload_Now()', $timeout);
                   9872: });
1.1215    raeburn  9873: // ]]>
1.1210    raeburn  9874: </script>
                   9875: OFFLOAD
                   9876:                         }
                   9877:                     }
                   9878:                 }
                   9879:             }
                   9880:         }
1.313     albertel 9881:     }
1.306     albertel 9882:     if (!defined($title)) {
                   9883: 	$title = 'The LearningOnline Network with CAPA';
                   9884:     }
1.460     albertel 9885:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1432    raeburn  9886:     if ($title =~ /^LON-CAPA\s+/) {
                   9887:         $result .= '<title> '.$title.'</title>';
                   9888:     } else {
                   9889:         $result .= '<title> LON-CAPA '.$title.'</title>';
                   9890:     }
                   9891:     $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1168    raeburn  9892:     if (!$args->{'frameset'}) {
                   9893:         $result .= ' /';
                   9894:     }
                   9895:     $result .= '>' 
1.1064    raeburn  9896:         .$inhibitprint
1.414     albertel 9897: 	.$head_extra;
1.1242    raeburn  9898:     my $clientmobile;
                   9899:     if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   9900:         (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
                   9901:     } else {
                   9902:         $clientmobile = $env{'browser.mobile'};
                   9903:     }
                   9904:     if ($clientmobile) {
1.1137    raeburn  9905:         $result .= '
1.1435    raeburn  9906: <meta name="viewport" content="width=device-width, initial-scale=1.0">
1.1137    raeburn  9907: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   9908:     }
1.1455    raeburn  9909:     $result .= '<meta name="google" content="notranslate"';
                   9910:     if (!$args->{'frameset'}) {
                   9911:         $result .= ' /';
                   9912:     }
                   9913:     $result .= '>'."\n";
1.962     droeschl 9914:     return $result.'</head>';
1.306     albertel 9915: }
                   9916: 
                   9917: =pod
                   9918: 
1.340     albertel 9919: =item * &font_settings()
                   9920: 
                   9921: Returns neccessary <meta> to set the proper encoding
                   9922: 
1.1160    raeburn  9923: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 9924: 
                   9925: =cut
                   9926: 
                   9927: sub font_settings {
1.1160    raeburn  9928:     my ($args) = @_;
1.340     albertel 9929:     my $headerstring='';
1.1160    raeburn  9930:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   9931:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168    raeburn  9932:         $headerstring.=
                   9933:             '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   9934:         if (!$args->{'frameset'}) {
                   9935: 	    $headerstring.= ' /';
                   9936:         }
                   9937: 	$headerstring .= '>'."\n";
1.340     albertel 9938:     }
                   9939:     return $headerstring;
                   9940: }
                   9941: 
1.341     albertel 9942: =pod
                   9943: 
1.1064    raeburn  9944: =item * &print_suppression()
                   9945: 
                   9946: In course context returns css which causes the body to be blank when media="print",
                   9947: if printout generation is unavailable for the current resource.
                   9948: 
                   9949: This could be because:
                   9950: 
                   9951: (a) printstartdate is in the future
                   9952: 
                   9953: (b) printenddate is in the past
                   9954: 
                   9955: (c) there is an active exam block with "printout"
                   9956: functionality blocked
                   9957: 
                   9958: Users with pav, pfo or evb privileges are exempt.
                   9959: 
                   9960: Inputs: none
                   9961: 
                   9962: =cut
                   9963: 
                   9964: 
                   9965: sub print_suppression {
                   9966:     my $noprint;
                   9967:     if ($env{'request.course.id'}) {
                   9968:         my $scope = $env{'request.course.id'};
                   9969:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   9970:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   9971:             return;
                   9972:         }
                   9973:         if ($env{'request.course.sec'} ne '') {
                   9974:             $scope .= "/$env{'request.course.sec'}";
                   9975:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   9976:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  9977:                 return;
1.1064    raeburn  9978:             }
                   9979:         }
                   9980:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   9981:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372    raeburn  9982:         my $clientip = &Apache::lonnet::get_requestor_ip();
                   9983:         my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064    raeburn  9984:         if ($blocked) {
                   9985:             my $checkrole = "cm./$cdom/$cnum";
                   9986:             if ($env{'request.course.sec'} ne '') {
                   9987:                 $checkrole .= "/$env{'request.course.sec'}";
                   9988:             }
                   9989:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   9990:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   9991:                 $noprint = 1;
                   9992:             }
                   9993:         }
                   9994:         unless ($noprint) {
                   9995:             my $symb = &Apache::lonnet::symbread();
                   9996:             if ($symb ne '') {
                   9997:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   9998:                 if (ref($navmap)) {
                   9999:                     my $res = $navmap->getBySymb($symb);
                   10000:                     if (ref($res)) {
                   10001:                         if (!$res->resprintable()) {
                   10002:                             $noprint = 1;
                   10003:                         }
                   10004:                     }
                   10005:                 }
                   10006:             }
                   10007:         }
                   10008:         if ($noprint) {
                   10009:             return <<"ENDSTYLE";
                   10010: <style type="text/css" media="print">
                   10011:     body { display:none }
                   10012: </style>
                   10013: ENDSTYLE
                   10014:         }
                   10015:     }
                   10016:     return;
                   10017: }
                   10018: 
                   10019: =pod
                   10020: 
1.341     albertel 10021: =item * &xml_begin()
                   10022: 
                   10023: Returns the needed doctype and <html>
                   10024: 
                   10025: Inputs: none
                   10026: 
                   10027: =cut
                   10028: 
                   10029: sub xml_begin {
1.1168    raeburn  10030:     my ($is_frameset) = @_;
1.341     albertel 10031:     my $output='';
                   10032: 
                   10033:     if ($env{'browser.mathml'}) {
                   10034: 	$output='<?xml version="1.0"?>'
                   10035:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   10036: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   10037:             
                   10038: #	    .'<!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">] >'
                   10039: 	    .'<!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">'
                   10040:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   10041: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168    raeburn  10042:     } elsif ($is_frameset) {
                   10043:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
1.1459    raeburn  10044:                 '<html lang="en">'."\n";
1.341     albertel 10045:     } else {
1.1168    raeburn  10046: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   10047:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 10048:     }
                   10049:     return $output;
                   10050: }
1.340     albertel 10051: 
                   10052: =pod
                   10053: 
1.306     albertel 10054: =item * &start_page()
                   10055: 
                   10056: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   10057: 
1.648     raeburn  10058: Inputs:
                   10059: 
                   10060: =over 4
                   10061: 
                   10062: $title - optional title for the page
                   10063: 
                   10064: $head_extra - optional extra HTML to incude inside the <head>
                   10065: 
                   10066: $args - additional optional args supported are:
                   10067: 
                   10068: =over 8
                   10069: 
                   10070:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 10071:                                     arg on
1.814     bisitz   10072:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  10073:              add_entries    -> additional attributes to add to the  <body>
                   10074:              domain         -> force to color decorate a page for a 
1.317     albertel 10075:                                     specific domain
1.648     raeburn  10076:              function       -> force usage of a specific rolish color
1.317     albertel 10077:                                     scheme
1.648     raeburn  10078:              redirect       -> see &headtag()
                   10079:              bgcolor        -> override the default page bg color
                   10080:              js_ready       -> return a string ready for being used in 
1.317     albertel 10081:                                     a javascript writeln
1.648     raeburn  10082:              html_encode    -> return a string ready for being used in 
1.320     albertel 10083:                                     a html attribute
1.648     raeburn  10084:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 10085:                                     $forcereg arg
1.648     raeburn  10086:              frameset       -> if true will start with a <frameset>
1.330     albertel 10087:                                     rather than <body>
1.648     raeburn  10088:              skip_phases    -> hash ref of 
1.338     albertel 10089:                                     head -> skip the <html><head> generation
                   10090:                                     body -> skip all <body> generation
1.648     raeburn  10091:              no_auto_mt_title -> prevent &mt()ing the title arg
1.867     kalberla 10092:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  10093:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1437    raeburn  10094:              bread_crumbs_style -> breadcrumbs are contained within <div id="LC_breadcrumbs">,
                   10095:                                    and &standard_css() contains CSS for #LC_breadcrumbs, if you want
                   10096:                                    to override those values, or add to them, specify the value to
                   10097:                                    include in the style attribute to include in the div tag by using
                   10098:                                    bread_crumbs_style (e.g., overflow: visible)
1.1272    raeburn  10099:              bread_crumbs_nomenu -> if true will pass false as the value of $menulink
                   10100:                                     to lonhtmlcommon::breadcrumbs
1.1096    raeburn  10101:              group          -> includes the current group, if page is for a 
1.1274    raeburn  10102:                                specific group
                   10103:              use_absolute   -> for request for external resource or syllabus, this
                   10104:                                will contain https://<hostname> if server uses
                   10105:                                https (as per hosts.tab), but request is for http
                   10106:              hostname       -> hostname, originally from $r->hostname(), (optional).
1.1369    raeburn  10107:              links_disabled -> Links in primary and secondary menus are disabled
                   10108:                                (Can enable them once page has loaded - see lonroles.pm
                   10109:                                for an example).
1.1380    raeburn  10110:              links_target   -> Target for links, e.g., _parent (optional).
1.361     albertel 10111: 
1.648     raeburn  10112: =back
1.460     albertel 10113: 
1.648     raeburn  10114: =back
1.562     albertel 10115: 
1.306     albertel 10116: =cut
                   10117: 
                   10118: sub start_page {
1.309     albertel 10119:     my ($title,$head_extra,$args) = @_;
1.318     albertel 10120:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 10121: 
1.315     albertel 10122:     $env{'internal.start_page'}++;
1.1359    raeburn  10123:     my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964     droeschl 10124: 
1.338     albertel 10125:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168    raeburn  10126:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 10127:     }
1.1316    raeburn  10128: 
                   10129:     if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318    raeburn  10130:         if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
                   10131:             unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
                   10132:                 $args->{'no_primary_menu'} = 1;
                   10133:             }
                   10134:             unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
                   10135:                 $args->{'no_inline_menu'} = 1;
                   10136:             }
                   10137:             if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
                   10138:                 map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
                   10139:             }
                   10140:         } else {
                   10141:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10142:             my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
                   10143:             if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
                   10144:                 unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
                   10145:                     $args->{'no_primary_menu'} = 1;
                   10146:                 }
                   10147:                 unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
                   10148:                     $args->{'no_inline_menu'} = 1;
                   10149:                 }
                   10150:                 if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
                   10151:                     map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
                   10152:                 }
                   10153:             }
                   10154:         }
1.1316    raeburn  10155:         ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
                   10156:                                   $env{'course.'.$env{'request.course.id'}.'.domain'},
                   10157:                                   $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359    raeburn  10158:     } elsif ($env{'request.course.id'}) {
                   10159:         my $expiretime=600;
                   10160:         if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
                   10161:             &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
                   10162:         }
                   10163:         my ($deeplinkmenu,$menuref);
                   10164:         ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
                   10165:         if ($menucoll) {
                   10166:             if (ref($menuref) eq 'HASH') {
                   10167:                 %menu = %{$menuref};
                   10168:             }
                   10169:             if ($menu{'top'} eq 'n') {
                   10170:                 $args->{'no_primary_menu'} = 1;
                   10171:             }
                   10172:             if ($menu{'inline'} eq 'n') {
                   10173:                 unless (&Apache::lonnet::allowed('opa')) {
                   10174:                     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10175:                     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   10176:                     my $crstype = &course_type();
                   10177:                     my $now = time;
                   10178:                     my $ccrole;
                   10179:                     if ($crstype eq 'Community') {
                   10180:                         $ccrole = 'co';
                   10181:                     } else {
                   10182:                         $ccrole = 'cc';
                   10183:                     }
                   10184:                     if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
                   10185:                         my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
                   10186:                         if ((($start) && ($start<0)) ||
                   10187:                             (($end) && ($end<$now))  ||
                   10188:                             (($start) && ($now<$start))) {
                   10189:                             $args->{'no_inline_menu'} = 1;
                   10190:                         }
                   10191:                     } else {
                   10192:                         $args->{'no_inline_menu'} = 1;
                   10193:                     }
                   10194:                 }
                   10195:             }
                   10196:         }
1.1316    raeburn  10197:     }
1.1359    raeburn  10198: 
1.1385    raeburn  10199:     my $showncrumbs;
1.338     albertel 10200:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   10201: 	if ($args->{'frameset'}) {
                   10202: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   10203: 						$args->{'add_entries'});
                   10204: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   10205:         } else {
                   10206:             $result .=
                   10207:                 &bodytag($title, 
                   10208:                          $args->{'function'},       $args->{'add_entries'},
                   10209:                          $args->{'only_body'},      $args->{'domain'},
                   10210:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096    raeburn  10211:                          $args->{'bgcolor'},        $args,
1.1385    raeburn  10212:                          \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
                   10213:                          \%menu,\$showncrumbs);
1.831     bisitz   10214:         }
1.330     albertel 10215:     }
1.338     albertel 10216: 
1.315     albertel 10217:     if ($args->{'js_ready'}) {
1.713     kaisler  10218: 		$result = &js_ready($result);
1.315     albertel 10219:     }
1.320     albertel 10220:     if ($args->{'html_encode'}) {
1.713     kaisler  10221: 		$result = &html_encode($result);
                   10222:     }
                   10223: 
1.813     bisitz   10224:     # Preparation for new and consistent functionlist at top of screen
                   10225:     # if ($args->{'functionlist'}) {
                   10226:     #            $result .= &build_functionlist();
                   10227:     #}
                   10228: 
1.964     droeschl 10229:     # Don't add anything more if only_body wanted or in const space
                   10230:     return $result if    $args->{'only_body'} 
                   10231:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   10232: 
                   10233:     #Breadcrumbs
1.758     kaisler  10234:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385    raeburn  10235:         unless ($showncrumbs) {
1.758     kaisler  10236: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   10237: 		#if any br links exists, add them to the breadcrumbs
                   10238: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   10239: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   10240: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   10241: 			}
                   10242: 		}
1.1096    raeburn  10243:                 # if @advtools array contains items add then to the breadcrumbs
                   10244:                 if (@advtools > 0) {
                   10245:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   10246:                 }
1.1272    raeburn  10247:                 my $menulink;
                   10248:                 # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
                   10249:                 if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312    raeburn  10250:                      ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272    raeburn  10251:                      ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
                   10252:                      ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
                   10253:                      (!$env{'request.role.adv'}))) {
                   10254:                     $menulink = 0;
                   10255:                 } else {
                   10256:                     undef($menulink);
                   10257:                 }
1.1385    raeburn  10258:                 my $linkprotout;
                   10259:                 if ($env{'request.deeplink.login'}) {
                   10260:                     my $linkprotout = &Apache::lonmenu::linkprot_exit();
                   10261:                     if ($linkprotout) {
                   10262:                         &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
                   10263:                     }
                   10264:                 }
1.758     kaisler  10265: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   10266: 		if(exists($args->{'bread_crumbs_component'})){
1.1437    raeburn  10267: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},
                   10268:                                                                        '',$menulink,'',
                   10269:                                                                        $args->{'bread_crumbs_style'});
1.1237    raeburn  10270:                 } else {
1.1437    raeburn  10271: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink,'',
                   10272:                                                                        $args->{'bread_crumbs_style'});
1.758     kaisler  10273: 		}
1.1385    raeburn  10274:         }
1.320     albertel 10275:     }
1.315     albertel 10276:     return $result;
1.306     albertel 10277: }
                   10278: 
                   10279: sub end_page {
1.315     albertel 10280:     my ($args) = @_;
                   10281:     $env{'internal.end_page'}++;
1.330     albertel 10282:     my $result;
1.335     albertel 10283:     if ($args->{'discussion'}) {
                   10284: 	my ($target,$parser);
                   10285: 	if (ref($args->{'discussion'})) {
                   10286: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   10287: 				$args->{'discussion'}{'parser'});
                   10288: 	}
                   10289: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   10290:     }
1.330     albertel 10291:     if ($args->{'frameset'}) {
                   10292: 	$result .= '</frameset>';
                   10293:     } else {
1.635     raeburn  10294: 	$result .= &endbodytag($args);
1.330     albertel 10295:     }
1.1080    raeburn  10296:     unless ($args->{'notbody'}) {
                   10297:         $result .= "\n</html>";
                   10298:     }
1.330     albertel 10299: 
1.315     albertel 10300:     if ($args->{'js_ready'}) {
1.317     albertel 10301: 	$result = &js_ready($result);
1.315     albertel 10302:     }
1.335     albertel 10303: 
1.320     albertel 10304:     if ($args->{'html_encode'}) {
                   10305: 	$result = &html_encode($result);
                   10306:     }
1.335     albertel 10307: 
1.315     albertel 10308:     return $result;
                   10309: }
                   10310: 
1.1359    raeburn  10311: sub menucoll_in_effect {
                   10312:     my ($menucoll,$deeplinkmenu,%menu);
                   10313:     if ($env{'request.course.id'}) {
                   10314:         $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362    raeburn  10315:         if ($env{'request.deeplink.login'}) {
1.1370    raeburn  10316:             my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362    raeburn  10317:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   10318:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10319:             if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
                   10320:                 if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
                   10321:                     my $navmap = Apache::lonnavmaps::navmap->new();
                   10322:                     if (ref($navmap)) {
                   10323:                         $deeplink = $navmap->get_mapparam(undef,
                   10324:                                                           &Apache::lonnet::declutter($env{'request.noversionuri'}),
                   10325:                                                           '0.deeplink');
1.1370    raeburn  10326:                     } else {
                   10327:                         $check_login_symb = 1;
1.1362    raeburn  10328:                     }
                   10329:                 } else {
1.1370    raeburn  10330:                     my $symb = &Apache::lonnet::symbread();
                   10331:                     if ($symb) {
                   10332:                         $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
                   10333:                     } else {
                   10334:                         $check_login_symb = 1;
                   10335:                     }
1.1362    raeburn  10336:                 }
                   10337:             } else {
1.1370    raeburn  10338:                 $check_login_symb = 1;
                   10339:             }
                   10340:             if ($check_login_symb) {
1.1362    raeburn  10341:                 $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
                   10342:                 if ($deeplink_symb =~ /\.(page|sequence)$/) {
                   10343:                     my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
                   10344:                     my $navmap = Apache::lonnavmaps::navmap->new();
                   10345:                     if (ref($navmap)) {
                   10346:                         $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
                   10347:                     }
                   10348:                 } else {
                   10349:                     $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
                   10350:                 }
                   10351:             }
1.1359    raeburn  10352:             if ($deeplink ne '') {
1.1378    raeburn  10353:                 my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359    raeburn  10354:                 if ($display =~ /^\d+$/) {
                   10355:                     $deeplinkmenu = 1;
                   10356:                     $menucoll = $display;
                   10357:                 }
                   10358:             }
                   10359:         }
                   10360:         if ($menucoll) {
                   10361:             %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
                   10362:         }
                   10363:     }
                   10364:     return ($menucoll,$deeplinkmenu,\%menu);
                   10365: }
                   10366: 
1.1362    raeburn  10367: sub deeplink_login_symb {
                   10368:     my ($cnum,$cdom) = @_;
                   10369:     my $login_symb;
                   10370:     if ($env{'request.deeplink.login'}) {
1.1364    raeburn  10371:         $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
                   10372:     }
                   10373:     return $login_symb;
                   10374: }
                   10375: 
                   10376: sub symb_from_tinyurl {
                   10377:     my ($url,$cnum,$cdom) = @_;
                   10378:     if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
                   10379:         my $key = $1;
                   10380:         my ($tinyurl,$login);
                   10381:         my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
                   10382:         if (defined($cached)) {
                   10383:             $tinyurl = $result;
                   10384:         } else {
                   10385:             my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
                   10386:             my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
                   10387:             if ($currtiny{$key} ne '') {
                   10388:                 $tinyurl = $currtiny{$key};
                   10389:                 &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362    raeburn  10390:             }
1.1364    raeburn  10391:         }
                   10392:         if ($tinyurl ne '') {
                   10393:             my ($cnumreq,$symb) = split(/\&/,$tinyurl);
                   10394:             if (wantarray) {
                   10395:                 return ($cnumreq,$symb);
                   10396:             } elsif ($cnumreq eq $cnum) {
                   10397:                 return $symb;
1.1362    raeburn  10398:             }
                   10399:         }
                   10400:     }
1.1364    raeburn  10401:     if (wantarray) {
                   10402:         return ();
                   10403:     } else {
                   10404:         return;
                   10405:     }
1.1362    raeburn  10406: }
                   10407: 
1.1405    raeburn  10408: sub usable_exttools {
                   10409:     my %tooltypes;
                   10410:     if ($env{'request.course.id'}) {
                   10411:         if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
                   10412:            if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
                   10413:                %tooltypes = (
                   10414:                              crs => 1,
                   10415:                              dom => 1,
                   10416:                             );
                   10417:            } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
                   10418:                $tooltypes{'crs'} = 1;
                   10419:            } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
                   10420:                $tooltypes{'dom'} = 1;
                   10421:            }
                   10422:         } else {
                   10423:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10424:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   10425:             my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
                   10426:             if ($crstype eq '') {
                   10427:                 $crstype = 'course';
                   10428:             }
                   10429:             if ($crstype eq 'course') {
                   10430:                 if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
                   10431:                     $crstype = 'official';
                   10432:                 } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
                   10433:                     $crstype = 'textbook';
                   10434:                 } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
                   10435:                     $crstype = 'lti';
                   10436:                 } else {
                   10437:                     $crstype = 'unofficial';
                   10438:                 }
                   10439:             }
                   10440:             my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
                   10441:             if ($domdefaults{$crstype.'domexttool'}) {
                   10442:                 $tooltypes{'dom'} = 1;
                   10443:             }
                   10444:             if ($domdefaults{$crstype.'exttool'}) {
                   10445:                 $tooltypes{'crs'} = 1;
                   10446:             }
                   10447:         }
                   10448:     }
                   10449:     return %tooltypes;
                   10450: }
                   10451: 
1.1034    www      10452: sub wishlist_window {
                   10453:     return(<<'ENDWISHLIST');
1.1046    raeburn  10454: <script type="text/javascript">
1.1034    www      10455: // <![CDATA[
                   10456: // <!-- BEGIN LON-CAPA Internal
                   10457: function set_wishlistlink(title, path) {
                   10458:     if (!title) {
                   10459:         title = document.title;
                   10460:         title = title.replace(/^LON-CAPA /,'');
                   10461:     }
1.1175    raeburn  10462:     title = encodeURIComponent(title);
1.1203    raeburn  10463:     title = title.replace("'","\\\'");
1.1034    www      10464:     if (!path) {
                   10465:         path = location.pathname;
                   10466:     }
1.1175    raeburn  10467:     path = encodeURIComponent(path);
1.1203    raeburn  10468:     path = path.replace("'","\\\'");
1.1034    www      10469:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   10470:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   10471: }
                   10472: // END LON-CAPA Internal -->
                   10473: // ]]>
                   10474: </script>
                   10475: ENDWISHLIST
                   10476: }
                   10477: 
1.1030    www      10478: sub modal_window {
                   10479:     return(<<'ENDMODAL');
1.1046    raeburn  10480: <script type="text/javascript">
1.1030    www      10481: // <![CDATA[
                   10482: // <!-- BEGIN LON-CAPA Internal
                   10483: var modalWindow = {
                   10484: 	parent:"body",
                   10485: 	windowId:null,
                   10486: 	content:null,
                   10487: 	width:null,
                   10488: 	height:null,
                   10489: 	close:function()
                   10490: 	{
                   10491: 	        $(".LCmodal-window").remove();
                   10492: 	        $(".LCmodal-overlay").remove();
                   10493: 	},
                   10494: 	open:function()
                   10495: 	{
                   10496: 		var modal = "";
                   10497: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   10498: 		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;\">";
                   10499: 		modal += this.content;
                   10500: 		modal += "</div>";	
                   10501: 
                   10502: 		$(this.parent).append(modal);
                   10503: 
                   10504: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   10505: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   10506: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   10507: 	}
                   10508: };
1.1140    raeburn  10509: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      10510: 	{
1.1266    raeburn  10511:                 source = source.replace(/'/g,"&#39;");
1.1030    www      10512: 		modalWindow.windowId = "myModal";
                   10513: 		modalWindow.width = width;
                   10514: 		modalWindow.height = height;
1.1196    raeburn  10515: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      10516: 		modalWindow.open();
1.1208    raeburn  10517: 	};
1.1030    www      10518: // END LON-CAPA Internal -->
                   10519: // ]]>
                   10520: </script>
                   10521: ENDMODAL
                   10522: }
                   10523: 
                   10524: sub modal_link {
1.1140    raeburn  10525:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      10526:     unless ($width) { $width=480; }
                   10527:     unless ($height) { $height=400; }
1.1031    www      10528:     unless ($scrolling) { $scrolling='yes'; }
1.1140    raeburn  10529:     unless ($transparency) { $transparency='true'; }
                   10530: 
1.1074    raeburn  10531:     my $target_attr;
                   10532:     if (defined($target)) {
                   10533:         $target_attr = 'target="'.$target.'"';
                   10534:     }
                   10535:     return <<"ENDLINK";
1.1336    raeburn  10536: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074    raeburn  10537: ENDLINK
1.1030    www      10538: }
                   10539: 
1.1032    www      10540: sub modal_adhoc_script {
1.1365    raeburn  10541:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
                   10542:     my $mathjax;
                   10543:     if ($possmathjax) {
                   10544:         $mathjax = <<'ENDJAX';
                   10545:                if (typeof MathJax == 'object') {
                   10546:                    MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
                   10547:                }
                   10548: ENDJAX
                   10549:     }
1.1032    www      10550:     return (<<ENDADHOC);
1.1046    raeburn  10551: <script type="text/javascript">
1.1032    www      10552: // <![CDATA[
                   10553:         var $funcname = function()
                   10554:         {
                   10555:                 modalWindow.windowId = "myModal";
                   10556:                 modalWindow.width = $width;
                   10557:                 modalWindow.height = $height;
                   10558:                 modalWindow.content = '$content';
                   10559:                 modalWindow.open();
1.1365    raeburn  10560:                 $mathjax
1.1032    www      10561:         };  
                   10562: // ]]>
                   10563: </script>
                   10564: ENDADHOC
                   10565: }
                   10566: 
1.1041    www      10567: sub modal_adhoc_inner {
1.1365    raeburn  10568:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041    www      10569:     my $innerwidth=$width-20;
                   10570:     $content=&js_ready(
1.1140    raeburn  10571:                  &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
                   10572:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   10573:                  $content.
1.1041    www      10574:                  &end_scrollbox().
1.1140    raeburn  10575:                  &end_page()
1.1041    www      10576:              );
1.1365    raeburn  10577:     return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041    www      10578: }
                   10579: 
                   10580: sub modal_adhoc_window {
1.1365    raeburn  10581:     my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
                   10582:     return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041    www      10583:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   10584: }
                   10585: 
                   10586: sub modal_adhoc_launch {
                   10587:     my ($funcname,$width,$height,$content)=@_;
                   10588:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   10589: <script type="text/javascript">
                   10590: // <![CDATA[
                   10591: $funcname();
                   10592: // ]]>
                   10593: </script>
                   10594: ENDLAUNCH
                   10595: }
                   10596: 
                   10597: sub modal_adhoc_close {
                   10598:     return (<<ENDCLOSE);
                   10599: <script type="text/javascript">
                   10600: // <![CDATA[
                   10601: modalWindow.close();
                   10602: // ]]>
                   10603: </script>
                   10604: ENDCLOSE
                   10605: }
                   10606: 
1.1038    www      10607: sub togglebox_script {
                   10608:    return(<<ENDTOGGLE);
                   10609: <script type="text/javascript"> 
                   10610: // <![CDATA[
                   10611: function LCtoggleDisplay(id,hidetext,showtext) {
                   10612:    link = document.getElementById(id + "link").childNodes[0];
                   10613:    with (document.getElementById(id).style) {
                   10614:       if (display == "none" ) {
                   10615:           display = "inline";
                   10616:           link.nodeValue = hidetext;
                   10617:         } else {
                   10618:           display = "none";
                   10619:           link.nodeValue = showtext;
                   10620:        }
                   10621:    }
                   10622: }
                   10623: // ]]>
                   10624: </script>
                   10625: ENDTOGGLE
                   10626: }
                   10627: 
1.1039    www      10628: sub start_togglebox {
                   10629:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   10630:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   10631:     unless ($showtext) { $showtext=&mt('show'); }
                   10632:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   10633:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   10634:     return &start_data_table().
                   10635:            &start_data_table_header_row().
                   10636:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   10637:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   10638:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   10639:            &end_data_table_header_row().
                   10640:            '<tr id="'.$id.'" style="display:none""><td>';
                   10641: }
                   10642: 
                   10643: sub end_togglebox {
                   10644:     return '</td></tr>'.&end_data_table();
                   10645: }
                   10646: 
1.1041    www      10647: sub LCprogressbar_script {
1.1302    raeburn  10648:    my ($id,$number_to_do)=@_;
                   10649:    if ($number_to_do) {
                   10650:        return(<<ENDPROGRESS);
1.1041    www      10651: <script type="text/javascript">
                   10652: // <![CDATA[
1.1045    www      10653: \$('#progressbar$id').progressbar({
1.1041    www      10654:   value: 0,
                   10655:   change: function(event, ui) {
                   10656:     var newVal = \$(this).progressbar('option', 'value');
                   10657:     \$('.pblabel', this).text(LCprogressTxt);
                   10658:   }
                   10659: });
                   10660: // ]]>
                   10661: </script>
                   10662: ENDPROGRESS
1.1302    raeburn  10663:    } else {
                   10664:        return(<<ENDPROGRESS);
                   10665: <script type="text/javascript">
                   10666: // <![CDATA[
                   10667: \$('#progressbar$id').progressbar({
                   10668:   value: false,
                   10669:   create: function(event, ui) {
                   10670:     \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
                   10671:     \$('.ui-progressbar-overlay', this).css({'margin':'0'});
                   10672:   }
                   10673: });
                   10674: // ]]>
                   10675: </script>
                   10676: ENDPROGRESS
                   10677:    }
1.1041    www      10678: }
                   10679: 
                   10680: sub LCprogressbarUpdate_script {
                   10681:    return(<<ENDPROGRESSUPDATE);
                   10682: <style type="text/css">
                   10683: .ui-progressbar { position:relative; }
1.1302    raeburn  10684: .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      10685: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   10686: </style>
                   10687: <script type="text/javascript">
                   10688: // <![CDATA[
1.1045    www      10689: var LCprogressTxt='---';
                   10690: 
1.1302    raeburn  10691: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041    www      10692:    LCprogressTxt=progresstext;
1.1302    raeburn  10693:    if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
                   10694:        \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
                   10695:    } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301    raeburn  10696:        \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
                   10697:    } else {
                   10698:        \$('#progressbar'+id).progressbar('value',percent);
                   10699:    }
1.1041    www      10700: }
                   10701: // ]]>
                   10702: </script>
                   10703: ENDPROGRESSUPDATE
                   10704: }
                   10705: 
1.1042    www      10706: my $LClastpercent;
1.1045    www      10707: my $LCidcnt;
                   10708: my $LCcurrentid;
1.1042    www      10709: 
1.1041    www      10710: sub LCprogressbar {
1.1302    raeburn  10711:     my ($r,$number_to_do,$preamble)=@_;
1.1042    www      10712:     $LClastpercent=0;
1.1045    www      10713:     $LCidcnt++;
                   10714:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1302    raeburn  10715:     my ($starting,$content);
                   10716:     if ($number_to_do) {
                   10717:         $starting=&mt('Starting');
                   10718:         $content=(<<ENDPROGBAR);
                   10719: $preamble
1.1045    www      10720:   <div id="progressbar$LCcurrentid">
1.1041    www      10721:     <span class="pblabel">$starting</span>
                   10722:   </div>
                   10723: ENDPROGBAR
1.1302    raeburn  10724:     } else {
                   10725:         $starting=&mt('Loading...');
                   10726:         $LClastpercent='false';
                   10727:         $content=(<<ENDPROGBAR);
                   10728: $preamble
                   10729:   <div id="progressbar$LCcurrentid">
                   10730:       <div class="progress-label">$starting</div>
                   10731:   </div>
                   10732: ENDPROGBAR
                   10733:     }
                   10734:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041    www      10735: }
                   10736: 
                   10737: sub LCprogressbarUpdate {
1.1302    raeburn  10738:     my ($r,$val,$text,$number_to_do)=@_;
                   10739:     if ($number_to_do) {
                   10740:         unless ($val) { 
                   10741:             if ($LClastpercent) {
                   10742:                 $val=$LClastpercent;
                   10743:             } else {
                   10744:                 $val=0;
                   10745:             }
                   10746:         }
                   10747:         if ($val<0) { $val=0; }
                   10748:         if ($val>100) { $val=0; }
                   10749:         $LClastpercent=$val;
                   10750:         unless ($text) { $text=$val.'%'; }
                   10751:     } else {
                   10752:         $val = 'false';
1.1042    www      10753:     }
1.1041    www      10754:     $text=&js_ready($text);
1.1044    www      10755:     &r_print($r,<<ENDUPDATE);
1.1041    www      10756: <script type="text/javascript">
                   10757: // <![CDATA[
1.1302    raeburn  10758: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041    www      10759: // ]]>
                   10760: </script>
                   10761: ENDUPDATE
1.1035    www      10762: }
                   10763: 
1.1042    www      10764: sub LCprogressbarClose {
                   10765:     my ($r)=@_;
                   10766:     $LClastpercent=0;
1.1044    www      10767:     &r_print($r,<<ENDCLOSE);
1.1042    www      10768: <script type="text/javascript">
                   10769: // <![CDATA[
1.1045    www      10770: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      10771: // ]]>
                   10772: </script>
                   10773: ENDCLOSE
1.1044    www      10774: }
                   10775: 
                   10776: sub r_print {
                   10777:     my ($r,$to_print)=@_;
                   10778:     if ($r) {
                   10779:       $r->print($to_print);
                   10780:       $r->rflush();
                   10781:     } else {
                   10782:       print($to_print);
                   10783:     }
1.1042    www      10784: }
                   10785: 
1.320     albertel 10786: sub html_encode {
                   10787:     my ($result) = @_;
                   10788: 
1.322     albertel 10789:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 10790:     
                   10791:     return $result;
                   10792: }
1.1044    www      10793: 
1.317     albertel 10794: sub js_ready {
                   10795:     my ($result) = @_;
                   10796: 
1.323     albertel 10797:     $result =~ s/[\n\r]/ /xmsg;
                   10798:     $result =~ s/\\/\\\\/xmsg;
                   10799:     $result =~ s/'/\\'/xmsg;
1.372     albertel 10800:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 10801:     
                   10802:     return $result;
                   10803: }
                   10804: 
1.315     albertel 10805: sub validate_page {
                   10806:     if (  exists($env{'internal.start_page'})
1.316     albertel 10807: 	  &&     $env{'internal.start_page'} > 1) {
                   10808: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 10809: 				 $env{'internal.start_page'}.' '.
1.316     albertel 10810: 				 $ENV{'request.filename'});
1.315     albertel 10811:     }
                   10812:     if (  exists($env{'internal.end_page'})
1.316     albertel 10813: 	  &&     $env{'internal.end_page'} > 1) {
                   10814: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 10815: 				 $env{'internal.end_page'}.' '.
1.316     albertel 10816: 				 $env{'request.filename'});
1.315     albertel 10817:     }
                   10818:     if (     exists($env{'internal.start_page'})
                   10819: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 10820: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   10821: 				 $env{'request.filename'});
1.315     albertel 10822:     }
                   10823:     if (   ! exists($env{'internal.start_page'})
                   10824: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 10825: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   10826: 				 $env{'request.filename'});
1.315     albertel 10827:     }
1.306     albertel 10828: }
1.315     albertel 10829: 
1.996     www      10830: 
                   10831: sub start_scrollbox {
1.1140    raeburn  10832:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  10833:     unless ($outerwidth) { $outerwidth='520px'; }
                   10834:     unless ($width) { $width='500px'; }
                   10835:     unless ($height) { $height='200px'; }
1.1075    raeburn  10836:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  10837:     if ($id ne '') {
1.1140    raeburn  10838:         $table_id = ' id="table_'.$id.'"';
1.1137    raeburn  10839:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  10840:     }
1.1075    raeburn  10841:     if ($bgcolor ne '') {
                   10842:         $tdcol = "background-color: $bgcolor;";
                   10843:     }
1.1137    raeburn  10844:     my $nicescroll_js;
                   10845:     if ($env{'browser.mobile'}) {
1.1140    raeburn  10846:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   10847:     }
                   10848:     return <<"END";
                   10849: $nicescroll_js
                   10850: 
                   10851: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
                   10852: <div style="overflow:auto; width:$width; height:$height;"$div_id>
                   10853: END
                   10854: }
                   10855: 
                   10856: sub end_scrollbox {
                   10857:     return '</div></td></tr></table>';
                   10858: }
                   10859: 
                   10860: sub nicescroll_javascript {
                   10861:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   10862:     my %options;
                   10863:     if (ref($cursor) eq 'HASH') {
                   10864:         %options = %{$cursor};
                   10865:     }
                   10866:     unless ($options{'railalign'} =~ /^left|right$/) {
                   10867:         $options{'railalign'} = 'left';
                   10868:     }
                   10869:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   10870:         my $function  = &get_users_function();
                   10871:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138    raeburn  10872:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140    raeburn  10873:             $options{'cursorcolor'} = '#00F';
1.1138    raeburn  10874:         }
1.1140    raeburn  10875:     }
                   10876:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   10877:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138    raeburn  10878:             $options{'cursoropacity'}='1.0';
                   10879:         }
1.1140    raeburn  10880:     } else {
                   10881:         $options{'cursoropacity'}='1.0';
                   10882:     }
                   10883:     if ($options{'cursorfixedheight'} eq 'none') {
                   10884:         delete($options{'cursorfixedheight'});
                   10885:     } else {
                   10886:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   10887:     }
                   10888:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   10889:         delete($options{'railoffset'});
                   10890:     }
                   10891:     my @niceoptions;
                   10892:     while (my($key,$value) = each(%options)) {
                   10893:         if ($value =~ /^\{.+\}$/) {
                   10894:             push(@niceoptions,$key.':'.$value);
1.1138    raeburn  10895:         } else {
1.1140    raeburn  10896:             push(@niceoptions,$key.':"'.$value.'"');
1.1138    raeburn  10897:         }
1.1140    raeburn  10898:     }
                   10899:     my $nicescroll_js = '
1.1137    raeburn  10900: $(document).ready(
1.1140    raeburn  10901:       function() {
                   10902:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   10903:       }
1.1137    raeburn  10904: );
                   10905: ';
1.1140    raeburn  10906:     if ($framecheck) {
                   10907:         $nicescroll_js .= '
                   10908: function expand_div(caller) {
                   10909:     if (top === self) {
                   10910:         document.getElementById("'.$id.'").style.width = "auto";
                   10911:         document.getElementById("'.$id.'").style.height = "auto";
                   10912:     } else {
                   10913:         try {
                   10914:             if (parent.frames) {
                   10915:                 if (parent.frames.length > 1) {
                   10916:                     var framesrc = parent.frames[1].location.href;
                   10917:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   10918:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   10919:                         document.getElementById("'.$id.'").style.width = "auto";
                   10920:                         document.getElementById("'.$id.'").style.height = "auto";
                   10921:                     }
                   10922:                 }
                   10923:             }
                   10924:         } catch (e) {
                   10925:             return;
                   10926:         }
1.1137    raeburn  10927:     }
1.1140    raeburn  10928:     return;
1.996     www      10929: }
1.1140    raeburn  10930: ';
                   10931:     }
                   10932:     if ($needjsready) {
                   10933:         $nicescroll_js = '
                   10934: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   10935:     } else {
                   10936:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   10937:     }
                   10938:     return $nicescroll_js;
1.996     www      10939: }
                   10940: 
1.318     albertel 10941: sub simple_error_page {
1.1150    bisitz   10942:     my ($r,$title,$msg,$args) = @_;
1.1304    raeburn  10943:     my %displayargs;
1.1151    raeburn  10944:     if (ref($args) eq 'HASH') {
                   10945:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304    raeburn  10946:         if ($args->{'only_body'}) {
                   10947:             $displayargs{'only_body'} = 1;
                   10948:         }
                   10949:         if ($args->{'no_nav_bar'}) {
                   10950:             $displayargs{'no_nav_bar'} = 1;
                   10951:         }
1.1151    raeburn  10952:     } else {
                   10953:         $msg = &mt($msg);
                   10954:     }
1.1150    bisitz   10955: 
1.318     albertel 10956:     my $page =
1.1459    raeburn  10957: 	&Apache::loncommon::start_page($title,'',\%displayargs)."\n".
1.1460    raeburn  10958:         '<div class="LC_landmark" style="clear:both" role="main">'.
1.1150    bisitz   10959: 	'<p class="LC_error">'.$msg.'</p>'.
1.1459    raeburn  10960:         '</div>'.
1.318     albertel 10961: 	&Apache::loncommon::end_page();
                   10962:     if (ref($r)) {
                   10963: 	$r->print($page);
1.327     albertel 10964: 	return;
1.318     albertel 10965:     }
                   10966:     return $page;
                   10967: }
1.347     albertel 10968: 
                   10969: {
1.610     albertel 10970:     my @row_count;
1.961     onken    10971: 
                   10972:     sub start_data_table_count {
                   10973:         unshift(@row_count, 0);
                   10974:         return;
                   10975:     }
                   10976: 
                   10977:     sub end_data_table_count {
                   10978:         shift(@row_count);
                   10979:         return;
                   10980:     }
                   10981: 
1.1466    raeburn  10982:     sub set_data_table_count {
                   10983:         my ($count) = @_;
                   10984:         unshift(@row_count,$count);
                   10985:     }
                   10986: 
1.347     albertel 10987:     sub start_data_table {
1.1018    raeburn  10988: 	my ($add_class,$id) = @_;
1.422     albertel 10989: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  10990:         my $table_id;
                   10991:         if (defined($id)) {
                   10992:             $table_id = ' id="'.$id.'"';
                   10993:         }
1.961     onken    10994: 	&start_data_table_count();
1.1018    raeburn  10995: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 10996:     }
                   10997: 
                   10998:     sub end_data_table {
1.961     onken    10999: 	&end_data_table_count();
1.389     albertel 11000: 	return '</table>'."\n";;
1.347     albertel 11001:     }
                   11002: 
                   11003:     sub start_data_table_row {
1.974     wenzelju 11004: 	my ($add_class, $id) = @_;
1.610     albertel 11005: 	$row_count[0]++;
                   11006: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   11007: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 11008:         $id = (' id="'.$id.'"') unless ($id eq '');
                   11009:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 11010:     }
1.471     banghart 11011:     
                   11012:     sub continue_data_table_row {
1.974     wenzelju 11013: 	my ($add_class, $id) = @_;
1.610     albertel 11014: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 11015: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   11016:         $id = (' id="'.$id.'"') unless ($id eq '');
                   11017:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 11018:     }
1.347     albertel 11019: 
                   11020:     sub end_data_table_row {
1.389     albertel 11021: 	return '</tr>'."\n";;
1.347     albertel 11022:     }
1.367     www      11023: 
1.421     albertel 11024:     sub start_data_table_empty_row {
1.707     bisitz   11025: #	$row_count[0]++;
1.421     albertel 11026: 	return  '<tr class="LC_empty_row" >'."\n";;
                   11027:     }
                   11028: 
                   11029:     sub end_data_table_empty_row {
                   11030: 	return '</tr>'."\n";;
                   11031:     }
                   11032: 
1.367     www      11033:     sub start_data_table_header_row {
1.1465    raeburn  11034: 	my ($add_class,$id) = @_;
                   11035: 	my $css_class = 'LC_header_row';
                   11036: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   11037: 	$id = (' id="'.$id.'"') unless ($id eq '');
                   11038: 	return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.367     www      11039:     }
                   11040: 
                   11041:     sub end_data_table_header_row {
1.389     albertel 11042: 	return '</tr>'."\n";;
1.367     www      11043:     }
1.890     droeschl 11044: 
                   11045:     sub data_table_caption {
1.1468    raeburn  11046:         my ($caption,$css_class) = @_;
                   11047:         return "<caption class=\"LC_caption $css_class\">$caption</caption>";
1.890     droeschl 11048:     }
1.347     albertel 11049: }
                   11050: 
1.548     albertel 11051: =pod
                   11052: 
                   11053: =item * &inhibit_menu_check($arg)
                   11054: 
                   11055: Checks for a inhibitmenu state and generates output to preserve it
                   11056: 
                   11057: Inputs:         $arg - can be any of
                   11058:                      - undef - in which case the return value is a string 
                   11059:                                to add  into arguments list of a uri
                   11060:                      - 'input' - in which case the return value is a HTML
                   11061:                                  <form> <input> field of type hidden to
                   11062:                                  preserve the value
                   11063:                      - a url - in which case the return value is the url with
                   11064:                                the neccesary cgi args added to preserve the
                   11065:                                inhibitmenu state
                   11066:                      - a ref to a url - no return value, but the string is
                   11067:                                         updated to include the neccessary cgi
                   11068:                                         args to preserve the inhibitmenu state
                   11069: 
                   11070: =cut
                   11071: 
                   11072: sub inhibit_menu_check {
                   11073:     my ($arg) = @_;
                   11074:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   11075:     if ($arg eq 'input') {
                   11076: 	if ($env{'form.inhibitmenu'}) {
                   11077: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   11078: 	} else {
                   11079: 	    return
                   11080: 	}
                   11081:     }
                   11082:     if ($env{'form.inhibitmenu'}) {
                   11083: 	if (ref($arg)) {
                   11084: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   11085: 	} elsif ($arg eq '') {
                   11086: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   11087: 	} else {
                   11088: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   11089: 	}
                   11090:     }
                   11091:     if (!ref($arg)) {
                   11092: 	return $arg;
                   11093:     }
                   11094: }
                   11095: 
1.251     albertel 11096: ###############################################
1.182     matthew  11097: 
                   11098: =pod
                   11099: 
1.549     albertel 11100: =back
                   11101: 
                   11102: =head1 User Information Routines
                   11103: 
                   11104: =over 4
                   11105: 
1.405     albertel 11106: =item * &get_users_function()
1.182     matthew  11107: 
                   11108: Used by &bodytag to determine the current users primary role.
                   11109: Returns either 'student','coordinator','admin', or 'author'.
                   11110: 
                   11111: =cut
                   11112: 
                   11113: ###############################################
                   11114: sub get_users_function {
1.815     tempelho 11115:     my $function = 'norole';
1.818     tempelho 11116:     if ($env{'request.role'}=~/^(st)/) {
                   11117:         $function='student';
                   11118:     }
1.907     raeburn  11119:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  11120:         $function='coordinator';
                   11121:     }
1.258     albertel 11122:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  11123:         $function='admin';
                   11124:     }
1.826     bisitz   11125:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  11126:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  11127:         $function='author';
                   11128:     }
                   11129:     return $function;
1.54      www      11130: }
1.99      www      11131: 
                   11132: ###############################################
                   11133: 
1.233     raeburn  11134: =pod
                   11135: 
1.821     raeburn  11136: =item * &show_course()
                   11137: 
                   11138: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   11139: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   11140: 
                   11141: Inputs:
                   11142: None
                   11143: 
                   11144: Outputs:
                   11145: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   11146: 
                   11147: =cut
                   11148: 
                   11149: ###############################################
                   11150: sub show_course {
1.1408    raeburn  11151:     my ($udom,$uname) = @_;
                   11152:     if (($udom ne '') && ($uname ne '')) {
                   11153:         if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410    raeburn  11154:             if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408    raeburn  11155:                 return 0;
                   11156:             } else {
                   11157:                 return 1;
                   11158:             }
                   11159:         }
                   11160:     }
1.821     raeburn  11161:     my $course = !$env{'user.adv'};
                   11162:     if (!$env{'user.adv'}) {
                   11163:         foreach my $env (keys(%env)) {
                   11164:             next if ($env !~ m/^user\.priv\./);
                   11165:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   11166:                 $course = 0;
                   11167:                 last;
                   11168:             }
                   11169:         }
                   11170:     }
                   11171:     return $course;
                   11172: }
                   11173: 
                   11174: ###############################################
                   11175: 
                   11176: =pod
                   11177: 
1.542     raeburn  11178: =item * &check_user_status()
1.274     raeburn  11179: 
                   11180: Determines current status of supplied role for a
                   11181: specific user. Roles can be active, previous or future.
                   11182: 
                   11183: Inputs: 
                   11184: user's domain, user's username, course's domain,
1.375     raeburn  11185: course's number, optional section ID.
1.274     raeburn  11186: 
                   11187: Outputs:
                   11188: role status: active, previous or future. 
                   11189: 
                   11190: =cut
                   11191: 
                   11192: sub check_user_status {
1.412     raeburn  11193:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  11194:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202    raeburn  11195:     my @uroles = keys(%userinfo);
1.274     raeburn  11196:     my $srchstr;
                   11197:     my $active_chk = 'none';
1.412     raeburn  11198:     my $now = time;
1.274     raeburn  11199:     if (@uroles > 0) {
1.908     raeburn  11200:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  11201:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   11202:         } else {
1.412     raeburn  11203:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   11204:         }
                   11205:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  11206:             my $role_end = 0;
                   11207:             my $role_start = 0;
                   11208:             $active_chk = 'active';
1.412     raeburn  11209:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   11210:                 $role_end = $1;
                   11211:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   11212:                     $role_start = $1;
1.274     raeburn  11213:                 }
                   11214:             }
                   11215:             if ($role_start > 0) {
1.412     raeburn  11216:                 if ($now < $role_start) {
1.274     raeburn  11217:                     $active_chk = 'future';
                   11218:                 }
                   11219:             }
                   11220:             if ($role_end > 0) {
1.412     raeburn  11221:                 if ($now > $role_end) {
1.274     raeburn  11222:                     $active_chk = 'previous';
                   11223:                 }
                   11224:             }
                   11225:         }
                   11226:     }
                   11227:     return $active_chk;
                   11228: }
                   11229: 
                   11230: ###############################################
                   11231: 
                   11232: =pod
                   11233: 
1.405     albertel 11234: =item * &get_sections()
1.233     raeburn  11235: 
                   11236: Determines all the sections for a course including
                   11237: sections with students and sections containing other roles.
1.419     raeburn  11238: Incoming parameters: 
                   11239: 
                   11240: 1. domain
                   11241: 2. course number 
                   11242: 3. reference to array containing roles for which sections should 
                   11243: be gathered (optional).
                   11244: 4. reference to array containing status types for which sections 
                   11245: should be gathered (optional).
                   11246: 
                   11247: If the third argument is undefined, sections are gathered for any role. 
                   11248: If the fourth argument is undefined, sections are gathered for any status.
                   11249: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  11250:  
1.374     raeburn  11251: Returns section hash (keys are section IDs, values are
                   11252: number of users in each section), subject to the
1.419     raeburn  11253: optional roles filter, optional status filter 
1.233     raeburn  11254: 
                   11255: =cut
                   11256: 
                   11257: ###############################################
                   11258: sub get_sections {
1.419     raeburn  11259:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 11260:     if (!defined($cdom) || !defined($cnum)) {
                   11261:         my $cid =  $env{'request.course.id'};
                   11262: 
                   11263: 	return if (!defined($cid));
                   11264: 
                   11265:         $cdom = $env{'course.'.$cid.'.domain'};
                   11266:         $cnum = $env{'course.'.$cid.'.num'};
                   11267:     }
                   11268: 
                   11269:     my %sectioncount;
1.419     raeburn  11270:     my $now = time;
1.240     albertel 11271: 
1.1118    raeburn  11272:     my $check_students = 1;
                   11273:     my $only_students = 0;
                   11274:     if (ref($possible_roles) eq 'ARRAY') {
                   11275:         if (grep(/^st$/,@{$possible_roles})) {
                   11276:             if (@{$possible_roles} == 1) {
                   11277:                 $only_students = 1;
                   11278:             }
                   11279:         } else {
                   11280:             $check_students = 0;
                   11281:         }
                   11282:     }
                   11283: 
                   11284:     if ($check_students) { 
1.276     albertel 11285: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 11286: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   11287: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  11288:         my $start_index = &Apache::loncoursedata::CL_START();
                   11289:         my $end_index = &Apache::loncoursedata::CL_END();
                   11290:         my $status;
1.366     albertel 11291: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  11292: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   11293: 				                     $data->[$status_index],
                   11294:                                                      $data->[$start_index],
                   11295:                                                      $data->[$end_index]);
                   11296:             if ($stu_status eq 'Active') {
                   11297:                 $status = 'active';
                   11298:             } elsif ($end < $now) {
                   11299:                 $status = 'previous';
                   11300:             } elsif ($start > $now) {
                   11301:                 $status = 'future';
                   11302:             } 
                   11303: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   11304:                 if ((!defined($possible_status)) || (($status ne '') && 
                   11305:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   11306: 		    $sectioncount{$section}++;
                   11307:                 }
1.240     albertel 11308: 	    }
                   11309: 	}
                   11310:     }
1.1118    raeburn  11311:     if ($only_students) {
                   11312:         return %sectioncount;
                   11313:     }
1.240     albertel 11314:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   11315:     foreach my $user (sort(keys(%courseroles))) {
                   11316: 	if ($user !~ /^(\w{2})/) { next; }
                   11317: 	my ($role) = ($user =~ /^(\w{2})/);
                   11318: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  11319: 	my ($section,$status);
1.240     albertel 11320: 	if ($role eq 'cr' &&
                   11321: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   11322: 	    $section=$1;
                   11323: 	}
                   11324: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   11325: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  11326:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   11327:         if ($end == -1 && $start == -1) {
                   11328:             next; #deleted role
                   11329:         }
                   11330:         if (!defined($possible_status)) { 
                   11331:             $sectioncount{$section}++;
                   11332:         } else {
                   11333:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   11334:                 $status = 'active';
                   11335:             } elsif ($end < $now) {
                   11336:                 $status = 'future';
                   11337:             } elsif ($start > $now) {
                   11338:                 $status = 'previous';
                   11339:             }
                   11340:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   11341:                 $sectioncount{$section}++;
                   11342:             }
                   11343:         }
1.233     raeburn  11344:     }
1.366     albertel 11345:     return %sectioncount;
1.233     raeburn  11346: }
                   11347: 
1.274     raeburn  11348: ###############################################
1.294     raeburn  11349: 
                   11350: =pod
1.405     albertel 11351: 
                   11352: =item * &get_course_users()
                   11353: 
1.275     raeburn  11354: Retrieves usernames:domains for users in the specified course
                   11355: with specific role(s), and access status. 
                   11356: 
                   11357: Incoming parameters:
1.277     albertel 11358: 1. course domain
                   11359: 2. course number
                   11360: 3. access status: users must have - either active, 
1.275     raeburn  11361: previous, future, or all.
1.277     albertel 11362: 4. reference to array of permissible roles
1.288     raeburn  11363: 5. reference to array of section restrictions (optional)
                   11364: 6. reference to results object (hash of hashes).
                   11365: 7. reference to optional userdata hash
1.609     raeburn  11366: 8. reference to optional statushash
1.630     raeburn  11367: 9. flag if privileged users (except those set to unhide in
                   11368:    course settings) should be excluded    
1.609     raeburn  11369: Keys of top level results hash are roles.
1.275     raeburn  11370: Keys of inner hashes are username:domain, with 
                   11371: values set to access type.
1.288     raeburn  11372: Optional userdata hash returns an array with arguments in the 
                   11373: same order as loncoursedata::get_classlist() for student data.
                   11374: 
1.609     raeburn  11375: Optional statushash returns
                   11376: 
1.288     raeburn  11377: Entries for end, start, section and status are blank because
                   11378: of the possibility of multiple values for non-student roles.
                   11379: 
1.275     raeburn  11380: =cut
1.405     albertel 11381: 
1.275     raeburn  11382: ###############################################
1.405     albertel 11383: 
1.275     raeburn  11384: sub get_course_users {
1.630     raeburn  11385:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  11386:     my %idx = ();
1.419     raeburn  11387:     my %seclists;
1.288     raeburn  11388: 
                   11389:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   11390:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   11391:     $idx{end} = &Apache::loncoursedata::CL_END();
                   11392:     $idx{start} = &Apache::loncoursedata::CL_START();
                   11393:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   11394:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   11395:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   11396:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   11397: 
1.290     albertel 11398:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 11399:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  11400:         my $now = time;
1.277     albertel 11401:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  11402:             my $match = 0;
1.412     raeburn  11403:             my $secmatch = 0;
1.419     raeburn  11404:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  11405:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  11406:             if ($section eq '') {
                   11407:                 $section = 'none';
                   11408:             }
1.291     albertel 11409:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 11410:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  11411:                     $secmatch = 1;
                   11412:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 11413:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  11414:                         $secmatch = 1;
                   11415:                     }
                   11416:                 } else {  
1.419     raeburn  11417: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  11418: 		        $secmatch = 1;
                   11419:                     }
1.290     albertel 11420: 		}
1.412     raeburn  11421:                 if (!$secmatch) {
                   11422:                     next;
                   11423:                 }
1.419     raeburn  11424:             }
1.275     raeburn  11425:             if (defined($$types{'active'})) {
1.288     raeburn  11426:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  11427:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  11428:                     $match = 1;
1.275     raeburn  11429:                 }
                   11430:             }
                   11431:             if (defined($$types{'previous'})) {
1.609     raeburn  11432:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  11433:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  11434:                     $match = 1;
1.275     raeburn  11435:                 }
                   11436:             }
                   11437:             if (defined($$types{'future'})) {
1.609     raeburn  11438:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  11439:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  11440:                     $match = 1;
1.275     raeburn  11441:                 }
                   11442:             }
1.609     raeburn  11443:             if ($match) {
                   11444:                 push(@{$seclists{$student}},$section);
                   11445:                 if (ref($userdata) eq 'HASH') {
                   11446:                     $$userdata{$student} = $$classlist{$student};
                   11447:                 }
                   11448:                 if (ref($statushash) eq 'HASH') {
                   11449:                     $statushash->{$student}{'st'}{$section} = $status;
                   11450:                 }
1.288     raeburn  11451:             }
1.275     raeburn  11452:         }
                   11453:     }
1.412     raeburn  11454:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  11455:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   11456:         my $now = time;
1.609     raeburn  11457:         my %displaystatus = ( previous => 'Expired',
                   11458:                               active   => 'Active',
                   11459:                               future   => 'Future',
                   11460:                             );
1.1121    raeburn  11461:         my (%nothide,@possdoms);
1.630     raeburn  11462:         if ($hidepriv) {
                   11463:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   11464:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   11465:                 if ($user !~ /:/) {
                   11466:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   11467:                 } else {
                   11468:                     $nothide{$user} = 1;
                   11469:                 }
                   11470:             }
1.1121    raeburn  11471:             my @possdoms = ($cdom);
                   11472:             if ($coursehash{'checkforpriv'}) {
                   11473:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   11474:             }
1.630     raeburn  11475:         }
1.439     raeburn  11476:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  11477:             my $match = 0;
1.412     raeburn  11478:             my $secmatch = 0;
1.439     raeburn  11479:             my $status;
1.412     raeburn  11480:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  11481:             $user =~ s/:$//;
1.439     raeburn  11482:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   11483:             if ($end == -1 || $start == -1) {
                   11484:                 next;
                   11485:             }
                   11486:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   11487:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  11488:                 my ($uname,$udom) = split(/:/,$user);
                   11489:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 11490:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  11491:                         $secmatch = 1;
                   11492:                     } elsif ($usec eq '') {
1.420     albertel 11493:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  11494:                             $secmatch = 1;
                   11495:                         }
                   11496:                     } else {
                   11497:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   11498:                             $secmatch = 1;
                   11499:                         }
                   11500:                     }
                   11501:                     if (!$secmatch) {
                   11502:                         next;
                   11503:                     }
1.288     raeburn  11504:                 }
1.419     raeburn  11505:                 if ($usec eq '') {
                   11506:                     $usec = 'none';
                   11507:                 }
1.275     raeburn  11508:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  11509:                     if ($hidepriv) {
1.1121    raeburn  11510:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  11511:                             (!$nothide{$uname.':'.$udom})) {
                   11512:                             next;
                   11513:                         }
                   11514:                     }
1.503     raeburn  11515:                     if ($end > 0 && $end < $now) {
1.439     raeburn  11516:                         $status = 'previous';
                   11517:                     } elsif ($start > $now) {
                   11518:                         $status = 'future';
                   11519:                     } else {
                   11520:                         $status = 'active';
                   11521:                     }
1.277     albertel 11522:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  11523:                         if ($status eq $type) {
1.420     albertel 11524:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  11525:                                 push(@{$$users{$role}{$user}},$type);
                   11526:                             }
1.288     raeburn  11527:                             $match = 1;
                   11528:                         }
                   11529:                     }
1.419     raeburn  11530:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   11531:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   11532: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   11533:                         }
1.420     albertel 11534:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  11535:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   11536:                         }
1.609     raeburn  11537:                         if (ref($statushash) eq 'HASH') {
                   11538:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   11539:                         }
1.275     raeburn  11540:                     }
                   11541:                 }
                   11542:             }
                   11543:         }
1.290     albertel 11544:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  11545:             if ((defined($cdom)) && (defined($cnum))) {
                   11546:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   11547:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   11548:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  11549:                     next if ($owner eq '');
                   11550:                     my ($ownername,$ownerdom);
                   11551:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   11552:                         $ownername = $1;
                   11553:                         $ownerdom = $2;
                   11554:                     } else {
                   11555:                         $ownername = $owner;
                   11556:                         $ownerdom = $cdom;
                   11557:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  11558:                     }
                   11559:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 11560:                     if (defined($userdata) && 
1.609     raeburn  11561: 			!exists($$userdata{$owner})) {
                   11562: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   11563:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   11564:                             push(@{$seclists{$owner}},'none');
                   11565:                         }
                   11566:                         if (ref($statushash) eq 'HASH') {
                   11567:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  11568:                         }
1.290     albertel 11569: 		    }
1.279     raeburn  11570:                 }
                   11571:             }
                   11572:         }
1.419     raeburn  11573:         foreach my $user (keys(%seclists)) {
                   11574:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   11575:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   11576:         }
1.275     raeburn  11577:     }
                   11578:     return;
                   11579: }
                   11580: 
1.288     raeburn  11581: sub get_user_info {
                   11582:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 11583:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   11584: 	&plainname($uname,$udom,'lastname');
1.291     albertel 11585:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  11586:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  11587:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   11588:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  11589:     return;
                   11590: }
1.275     raeburn  11591: 
1.472     raeburn  11592: ###############################################
                   11593: 
                   11594: =pod
                   11595: 
                   11596: =item * &get_user_quota()
                   11597: 
1.1134    raeburn  11598: Retrieves quota assigned for storage of user files.
                   11599: Default is to report quota for portfolio files.
1.472     raeburn  11600: 
                   11601: Incoming parameters:
                   11602: 1. user's username
                   11603: 2. user's domain
1.1134    raeburn  11604: 3. quota name - portfolio, author, or course
1.1136    raeburn  11605:    (if no quota name provided, defaults to portfolio).
1.1237    raeburn  11606: 4. crstype - official, unofficial, textbook, placement or community, 
                   11607:    if quota name is course
1.472     raeburn  11608: 
                   11609: Returns:
1.1163    raeburn  11610: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  11611: 2. (Optional) Type of setting: custom or default
                   11612:    (individually assigned or default for user's 
                   11613:    institutional status).
                   11614: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   11615:    or student - types as defined in localenroll::inst_usertypes 
                   11616:    for user's domain, which determines default quota for user.
                   11617: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  11618: 
                   11619: If a value has been stored in the user's environment, 
1.536     raeburn  11620: it will return that, otherwise it returns the maximal default
1.1134    raeburn  11621: defined for the user's institutional status(es) in the domain.
1.472     raeburn  11622: 
                   11623: =cut
                   11624: 
                   11625: ###############################################
                   11626: 
                   11627: 
                   11628: sub get_user_quota {
1.1136    raeburn  11629:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  11630:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  11631:     if (!defined($udom)) {
                   11632:         $udom = $env{'user.domain'};
                   11633:     }
                   11634:     if (!defined($uname)) {
                   11635:         $uname = $env{'user.name'};
                   11636:     }
                   11637:     if (($udom eq '' || $uname eq '') ||
                   11638:         ($udom eq 'public') && ($uname eq 'public')) {
                   11639:         $quota = 0;
1.536     raeburn  11640:         $quotatype = 'default';
                   11641:         $defquota = 0; 
1.472     raeburn  11642:     } else {
1.536     raeburn  11643:         my $inststatus;
1.1134    raeburn  11644:         if ($quotaname eq 'course') {
                   11645:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   11646:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   11647:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   11648:             } else {
                   11649:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   11650:                 $quota = $cenv{'internal.uploadquota'};
                   11651:             }
1.536     raeburn  11652:         } else {
1.1134    raeburn  11653:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   11654:                 if ($quotaname eq 'author') {
                   11655:                     $quota = $env{'environment.authorquota'};
                   11656:                 } else {
                   11657:                     $quota = $env{'environment.portfolioquota'};
                   11658:                 }
                   11659:                 $inststatus = $env{'environment.inststatus'};
                   11660:             } else {
                   11661:                 my %userenv = 
                   11662:                     &Apache::lonnet::get('environment',['portfolioquota',
                   11663:                                          'authorquota','inststatus'],$udom,$uname);
                   11664:                 my ($tmp) = keys(%userenv);
                   11665:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   11666:                     if ($quotaname eq 'author') {
                   11667:                         $quota = $userenv{'authorquota'};
                   11668:                     } else {
                   11669:                         $quota = $userenv{'portfolioquota'};
                   11670:                     }
                   11671:                     $inststatus = $userenv{'inststatus'};
                   11672:                 } else {
                   11673:                     undef(%userenv);
                   11674:                 }
                   11675:             }
                   11676:         }
                   11677:         if ($quota eq '' || wantarray) {
                   11678:             if ($quotaname eq 'course') {
                   11679:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165    raeburn  11680:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') || 
1.1237    raeburn  11681:                     ($crstype eq 'community') || ($crstype eq 'textbook') ||
                   11682:                     ($crstype eq 'placement')) { 
1.1136    raeburn  11683:                     $defquota = $domdefs{$crstype.'quota'};
                   11684:                 }
                   11685:                 if ($defquota eq '') {
                   11686:                     $defquota = 500;
                   11687:                 }
1.1134    raeburn  11688:             } else {
                   11689:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   11690:             }
                   11691:             if ($quota eq '') {
                   11692:                 $quota = $defquota;
                   11693:                 $quotatype = 'default';
                   11694:             } else {
                   11695:                 $quotatype = 'custom';
                   11696:             }
1.472     raeburn  11697:         }
                   11698:     }
1.536     raeburn  11699:     if (wantarray) {
                   11700:         return ($quota,$quotatype,$settingstatus,$defquota);
                   11701:     } else {
                   11702:         return $quota;
                   11703:     }
1.472     raeburn  11704: }
                   11705: 
                   11706: ###############################################
                   11707: 
                   11708: =pod
                   11709: 
                   11710: =item * &default_quota()
                   11711: 
1.536     raeburn  11712: Retrieves default quota assigned for storage of user portfolio files,
                   11713: given an (optional) user's institutional status.
1.472     raeburn  11714: 
                   11715: Incoming parameters:
1.1142    raeburn  11716: 
1.472     raeburn  11717: 1. domain
1.536     raeburn  11718: 2. (Optional) institutional status(es).  This is a : separated list of 
                   11719:    status types (e.g., faculty, staff, student etc.)
                   11720:    which apply to the user for whom the default is being retrieved.
                   11721:    If the institutional status string in undefined, the domain
1.1134    raeburn  11722:    default quota will be returned.
                   11723: 3.  quota name - portfolio, author, or course
                   11724:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  11725: 
                   11726: Returns:
1.1142    raeburn  11727: 
1.1163    raeburn  11728: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  11729: 2. (Optional) institutional type which determined the value of the
                   11730:    default quota.
1.472     raeburn  11731: 
                   11732: If a value has been stored in the domain's configuration db,
                   11733: it will return that, otherwise it returns 20 (for backwards 
                   11734: compatibility with domains which have not set up a configuration
1.1163    raeburn  11735: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  11736: 
1.536     raeburn  11737: If the user's status includes multiple types (e.g., staff and student),
                   11738: the largest default quota which applies to the user determines the
                   11739: default quota returned.
                   11740: 
1.472     raeburn  11741: =cut
                   11742: 
                   11743: ###############################################
                   11744: 
                   11745: 
                   11746: sub default_quota {
1.1134    raeburn  11747:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  11748:     my ($defquota,$settingstatus);
                   11749:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  11750:                                             ['quotas'],$udom);
1.1134    raeburn  11751:     my $key = 'defaultquota';
                   11752:     if ($quotaname eq 'author') {
                   11753:         $key = 'authorquota';
                   11754:     }
1.622     raeburn  11755:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  11756:         if ($inststatus ne '') {
1.765     raeburn  11757:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  11758:             foreach my $item (@statuses) {
1.1134    raeburn  11759:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   11760:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  11761:                         if ($defquota eq '') {
1.1134    raeburn  11762:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  11763:                             $settingstatus = $item;
1.1134    raeburn  11764:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   11765:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  11766:                             $settingstatus = $item;
                   11767:                         }
                   11768:                     }
1.1134    raeburn  11769:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  11770:                     if ($quotahash{'quotas'}{$item} ne '') {
                   11771:                         if ($defquota eq '') {
                   11772:                             $defquota = $quotahash{'quotas'}{$item};
                   11773:                             $settingstatus = $item;
                   11774:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   11775:                             $defquota = $quotahash{'quotas'}{$item};
                   11776:                             $settingstatus = $item;
                   11777:                         }
1.536     raeburn  11778:                     }
                   11779:                 }
                   11780:             }
                   11781:         }
                   11782:         if ($defquota eq '') {
1.1134    raeburn  11783:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   11784:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   11785:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  11786:                 $defquota = $quotahash{'quotas'}{'default'};
                   11787:             }
1.536     raeburn  11788:             $settingstatus = 'default';
1.1139    raeburn  11789:             if ($defquota eq '') {
                   11790:                 if ($quotaname eq 'author') {
                   11791:                     $defquota = 500;
                   11792:                 }
                   11793:             }
1.536     raeburn  11794:         }
                   11795:     } else {
                   11796:         $settingstatus = 'default';
1.1134    raeburn  11797:         if ($quotaname eq 'author') {
                   11798:             $defquota = 500;
                   11799:         } else {
                   11800:             $defquota = 20;
                   11801:         }
1.536     raeburn  11802:     }
                   11803:     if (wantarray) {
                   11804:         return ($defquota,$settingstatus);
1.472     raeburn  11805:     } else {
1.536     raeburn  11806:         return $defquota;
1.472     raeburn  11807:     }
                   11808: }
                   11809: 
1.1135    raeburn  11810: ###############################################
                   11811: 
                   11812: =pod
                   11813: 
1.1136    raeburn  11814: =item * &excess_filesize_warning()
1.1135    raeburn  11815: 
                   11816: Returns warning message if upload of file to authoring space, or copying
1.1136    raeburn  11817: of existing file within authoring space will cause quota for the authoring
1.1146    raeburn  11818: space to be exceeded.
1.1136    raeburn  11819: 
                   11820: Same, if upload of a file directly to a course/community via Course Editor
1.1137    raeburn  11821: will cause quota for uploaded content for the course to be exceeded.
1.1135    raeburn  11822: 
1.1165    raeburn  11823: Inputs: 7 
1.1136    raeburn  11824: 1. username or coursenum
1.1135    raeburn  11825: 2. domain
1.1136    raeburn  11826: 3. context ('author' or 'course')
1.1135    raeburn  11827: 4. filename of file for which action is being requested
                   11828: 5. filesize (kB) of file
                   11829: 6. action being taken: copy or upload.
1.1237    raeburn  11830: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135    raeburn  11831: 
                   11832: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142    raeburn  11833:          otherwise return null.
                   11834: 
                   11835: =back
1.1135    raeburn  11836: 
                   11837: =cut
                   11838: 
1.1136    raeburn  11839: sub excess_filesize_warning {
1.1165    raeburn  11840:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136    raeburn  11841:     my $current_disk_usage = 0;
1.1165    raeburn  11842:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136    raeburn  11843:     if ($context eq 'author') {
                   11844:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   11845:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   11846:     } else {
                   11847:         foreach my $subdir ('docs','supplemental') {
                   11848:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   11849:         }
                   11850:     }
1.1135    raeburn  11851:     $disk_quota = int($disk_quota * 1000);
                   11852:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179    bisitz   11853:         return '<p class="LC_warning">'.
1.1135    raeburn  11854:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179    bisitz   11855:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   11856:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135    raeburn  11857:                             $disk_quota,$current_disk_usage).
                   11858:                '</p>';
                   11859:     }
                   11860:     return;
                   11861: }
                   11862: 
                   11863: ###############################################
                   11864: 
                   11865: 
1.1136    raeburn  11866: 
                   11867: 
1.384     raeburn  11868: sub get_secgrprole_info {
                   11869:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   11870:     my %sections_count = &get_sections($cdom,$cnum);
                   11871:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   11872:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   11873:     my @groups = sort(keys(%curr_groups));
                   11874:     my $allroles = [];
                   11875:     my $rolehash;
                   11876:     my $accesshash = {
                   11877:                      active => 'Currently has access',
                   11878:                      future => 'Will have future access',
                   11879:                      previous => 'Previously had access',
                   11880:                   };
                   11881:     if ($needroles) {
                   11882:         $rolehash = {'all' => 'all'};
1.385     albertel 11883:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   11884: 	if (&Apache::lonnet::error(%user_roles)) {
                   11885: 	    undef(%user_roles);
                   11886: 	}
                   11887:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  11888:             my ($role)=split(/\:/,$item,2);
                   11889:             if ($role eq 'cr') { next; }
                   11890:             if ($role =~ /^cr/) {
                   11891:                 $$rolehash{$role} = (split('/',$role))[3];
                   11892:             } else {
                   11893:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   11894:             }
                   11895:         }
                   11896:         foreach my $key (sort(keys(%{$rolehash}))) {
                   11897:             push(@{$allroles},$key);
                   11898:         }
                   11899:         push (@{$allroles},'st');
                   11900:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   11901:     }
                   11902:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   11903: }
                   11904: 
1.555     raeburn  11905: sub user_picker {
1.1279    raeburn  11906:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  11907:     my $currdom = $dom;
1.1253    raeburn  11908:     my @alldoms = &Apache::lonnet::all_domains();
                   11909:     if (@alldoms == 1) {
                   11910:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   11911:                                                ['directorysrch'],$alldoms[0]);
                   11912:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   11913:         my $showdom = $domdesc;
                   11914:         if ($showdom eq '') {
                   11915:             $showdom = $dom;
                   11916:         }
                   11917:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   11918:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   11919:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   11920:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   11921:             }
                   11922:         }
                   11923:     }
1.555     raeburn  11924:     my %curr_selected = (
                   11925:                         srchin => 'dom',
1.580     raeburn  11926:                         srchby => 'lastname',
1.555     raeburn  11927:                       );
                   11928:     my $srchterm;
1.625     raeburn  11929:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  11930:         if ($srch->{'srchby'} ne '') {
                   11931:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   11932:         }
                   11933:         if ($srch->{'srchin'} ne '') {
                   11934:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   11935:         }
                   11936:         if ($srch->{'srchtype'} ne '') {
                   11937:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   11938:         }
                   11939:         if ($srch->{'srchdomain'} ne '') {
                   11940:             $currdom = $srch->{'srchdomain'};
                   11941:         }
                   11942:         $srchterm = $srch->{'srchterm'};
                   11943:     }
1.1222    damieng  11944:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  11945:                     'usr'       => 'Search criteria',
1.563     raeburn  11946:                     'doma'      => 'Domain/institution to search',
1.558     albertel 11947:                     'uname'     => 'username',
                   11948:                     'lastname'  => 'last name',
1.555     raeburn  11949:                     'lastfirst' => 'last name, first name',
1.558     albertel 11950:                     'crs'       => 'in this course',
1.576     raeburn  11951:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 11952:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  11953:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 11954:                     'exact'     => 'is',
                   11955:                     'contains'  => 'contains',
1.569     raeburn  11956:                     'begins'    => 'begins with',
1.1222    damieng  11957:                                        );
                   11958:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  11959:                     'youm'      => "You must include some text to search for.",
                   11960:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   11961:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   11962:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   11963:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   11964:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   11965:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   11966:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  11967:                                        );
1.1222    damieng  11968:     &html_escape(\%html_lt);
                   11969:     &js_escape(\%js_lt);
1.1255    raeburn  11970:     my $domform;
1.1277    raeburn  11971:     my $allow_blank = 1;
1.1255    raeburn  11972:     if ($fixeddom) {
1.1277    raeburn  11973:         $allow_blank = 0;
                   11974:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255    raeburn  11975:     } else {
1.1287    raeburn  11976:         my $defdom = $env{'request.role.domain'};
1.1288    raeburn  11977:         my ($trusted,$untrusted);
1.1287    raeburn  11978:         if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288    raeburn  11979:             ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287    raeburn  11980:         } elsif ($context eq 'author') {
1.1288    raeburn  11981:             ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287    raeburn  11982:         } elsif ($context eq 'domain') {
1.1288    raeburn  11983:             ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287    raeburn  11984:         }
1.1288    raeburn  11985:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255    raeburn  11986:     }
1.563     raeburn  11987:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  11988: 
                   11989:     my @srchins = ('crs','dom','alc','instd');
                   11990: 
                   11991:     foreach my $option (@srchins) {
                   11992:         # FIXME 'alc' option unavailable until 
                   11993:         #       loncreateuser::print_user_query_page()
                   11994:         #       has been completed.
                   11995:         next if ($option eq 'alc');
1.880     raeburn  11996:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  11997:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279    raeburn  11998:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  11999:         if ($curr_selected{'srchin'} eq $option) {
                   12000:             $srchinsel .= ' 
1.1222    damieng  12001:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  12002:         } else {
                   12003:             $srchinsel .= '
1.1222    damieng  12004:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  12005:         }
1.555     raeburn  12006:     }
1.563     raeburn  12007:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  12008: 
                   12009:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  12010:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  12011:         if ($curr_selected{'srchby'} eq $option) {
                   12012:             $srchbysel .= '
1.1222    damieng  12013:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  12014:         } else {
                   12015:             $srchbysel .= '
1.1222    damieng  12016:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  12017:          }
                   12018:     }
                   12019:     $srchbysel .= "\n  </select>\n";
                   12020: 
                   12021:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  12022:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  12023:         if ($curr_selected{'srchtype'} eq $option) {
                   12024:             $srchtypesel .= '
1.1222    damieng  12025:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  12026:         } else {
                   12027:             $srchtypesel .= '
1.1222    damieng  12028:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  12029:         }
                   12030:     }
                   12031:     $srchtypesel .= "\n  </select>\n";
                   12032: 
1.558     albertel 12033:     my ($newuserscript,$new_user_create);
1.994     raeburn  12034:     my $context_dom = $env{'request.role.domain'};
                   12035:     if ($context eq 'requestcrs') {
                   12036:         if ($env{'form.coursedom'} ne '') { 
                   12037:             $context_dom = $env{'form.coursedom'};
                   12038:         }
                   12039:     }
1.556     raeburn  12040:     if ($forcenewuser) {
1.576     raeburn  12041:         if (ref($srch) eq 'HASH') {
1.994     raeburn  12042:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  12043:                 if ($cancreate) {
                   12044:                     $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>';
                   12045:                 } else {
1.799     bisitz   12046:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  12047:                     my %usertypetext = (
                   12048:                         official   => 'institutional',
                   12049:                         unofficial => 'non-institutional',
                   12050:                     );
1.799     bisitz   12051:                     $new_user_create = '<p class="LC_warning">'
                   12052:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   12053:                                       .' '
                   12054:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   12055:                                           ,'<a href="'.$helplink.'">','</a>')
                   12056:                                       .'</p><br />';
1.627     raeburn  12057:                 }
1.576     raeburn  12058:             }
                   12059:         }
                   12060: 
1.556     raeburn  12061:         $newuserscript = <<"ENDSCRIPT";
                   12062: 
1.570     raeburn  12063: function setSearch(createnew,callingForm) {
1.556     raeburn  12064:     if (createnew == 1) {
1.570     raeburn  12065:         for (var i=0; i<callingForm.srchby.length; i++) {
                   12066:             if (callingForm.srchby.options[i].value == 'uname') {
                   12067:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  12068:             }
                   12069:         }
1.570     raeburn  12070:         for (var i=0; i<callingForm.srchin.length; i++) {
                   12071:             if ( callingForm.srchin.options[i].value == 'dom') {
                   12072: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  12073:             }
                   12074:         }
1.570     raeburn  12075:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   12076:             if (callingForm.srchtype.options[i].value == 'exact') {
                   12077:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  12078:             }
                   12079:         }
1.570     raeburn  12080:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  12081:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  12082:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  12083:             }
                   12084:         }
                   12085:     }
                   12086: }
                   12087: ENDSCRIPT
1.558     albertel 12088: 
1.556     raeburn  12089:     }
                   12090: 
1.555     raeburn  12091:     my $output = <<"END_BLOCK";
1.556     raeburn  12092: <script type="text/javascript">
1.824     bisitz   12093: // <![CDATA[
1.570     raeburn  12094: function validateEntry(callingForm) {
1.558     albertel 12095: 
1.556     raeburn  12096:     var checkok = 1;
1.558     albertel 12097:     var srchin;
1.570     raeburn  12098:     for (var i=0; i<callingForm.srchin.length; i++) {
                   12099: 	if ( callingForm.srchin[i].checked ) {
                   12100: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 12101: 	}
                   12102:     }
                   12103: 
1.570     raeburn  12104:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   12105:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   12106:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   12107:     var srchterm =  callingForm.srchterm.value;
                   12108:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  12109:     var msg = "";
                   12110: 
                   12111:     if (srchterm == "") {
                   12112:         checkok = 0;
1.1222    damieng  12113:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  12114:     }
                   12115: 
1.569     raeburn  12116:     if (srchtype== 'begins') {
                   12117:         if (srchterm.length < 2) {
                   12118:             checkok = 0;
1.1222    damieng  12119:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  12120:         }
                   12121:     }
                   12122: 
1.556     raeburn  12123:     if (srchtype== 'contains') {
                   12124:         if (srchterm.length < 3) {
                   12125:             checkok = 0;
1.1222    damieng  12126:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  12127:         }
                   12128:     }
                   12129:     if (srchin == 'instd') {
                   12130:         if (srchdomain == '') {
                   12131:             checkok = 0;
1.1222    damieng  12132:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  12133:         }
                   12134:     }
                   12135:     if (srchin == 'dom') {
                   12136:         if (srchdomain == '') {
                   12137:             checkok = 0;
1.1222    damieng  12138:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  12139:         }
                   12140:     }
                   12141:     if (srchby == 'lastfirst') {
                   12142:         if (srchterm.indexOf(",") == -1) {
                   12143:             checkok = 0;
1.1222    damieng  12144:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  12145:         }
                   12146:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   12147:             checkok = 0;
1.1222    damieng  12148:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  12149:         }
                   12150:     }
                   12151:     if (checkok == 0) {
1.1222    damieng  12152:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  12153:         return;
                   12154:     }
                   12155:     if (checkok == 1) {
1.570     raeburn  12156:         callingForm.submit();
1.556     raeburn  12157:     }
                   12158: }
                   12159: 
                   12160: $newuserscript
                   12161: 
1.824     bisitz   12162: // ]]>
1.556     raeburn  12163: </script>
1.558     albertel 12164: 
                   12165: $new_user_create
                   12166: 
1.555     raeburn  12167: END_BLOCK
1.558     albertel 12168: 
1.876     raeburn  12169:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222    damieng  12170:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  12171:                $domform.
                   12172:                &Apache::lonhtmlcommon::row_closure().
1.1222    damieng  12173:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  12174:                $srchbysel.
                   12175:                $srchtypesel. 
                   12176:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   12177:                $srchinsel.
                   12178:                &Apache::lonhtmlcommon::row_closure(1). 
                   12179:                &Apache::lonhtmlcommon::end_pick_box().
                   12180:                '<br />';
1.1253    raeburn  12181:     return ($output,1);
1.555     raeburn  12182: }
                   12183: 
1.612     raeburn  12184: sub user_rule_check {
1.615     raeburn  12185:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226    raeburn  12186:     my ($response,%inst_response);
1.612     raeburn  12187:     if (ref($usershash) eq 'HASH') {
1.1226    raeburn  12188:         if (keys(%{$usershash}) > 1) {
                   12189:             my (%by_username,%by_id,%userdoms);
                   12190:             my $checkid; 
                   12191:             if (ref($checks) eq 'HASH') {
                   12192:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   12193:                     $checkid = 1;
                   12194:                 }
                   12195:             }
                   12196:             foreach my $user (keys(%{$usershash})) {
                   12197:                 my ($uname,$udom) = split(/:/,$user);
                   12198:                 if ($checkid) {
                   12199:                     if (ref($usershash->{$user}) eq 'HASH') {
                   12200:                         if ($usershash->{$user}->{'id'} ne '') {
1.1227    raeburn  12201:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname; 
1.1226    raeburn  12202:                             $userdoms{$udom} = 1;
1.1227    raeburn  12203:                             if (ref($inst_results) eq 'HASH') {
                   12204:                                 $inst_results->{$uname.':'.$udom} = {};
                   12205:                             }
1.1226    raeburn  12206:                         }
                   12207:                     }
                   12208:                 } else {
                   12209:                     $by_username{$udom}{$uname} = 1;
                   12210:                     $userdoms{$udom} = 1;
1.1227    raeburn  12211:                     if (ref($inst_results) eq 'HASH') {
                   12212:                         $inst_results->{$uname.':'.$udom} = {};
                   12213:                     }
1.1226    raeburn  12214:                 }
                   12215:             }
                   12216:             foreach my $udom (keys(%userdoms)) {
                   12217:                 if (!$got_rules->{$udom}) {
                   12218:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   12219:                                                              ['usercreation'],$udom);
                   12220:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   12221:                         foreach my $item ('username','id') {
                   12222:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227    raeburn  12223:                                 $$curr_rules{$udom}{$item} =
                   12224:                                     $domconfig{'usercreation'}{$item.'_rule'};
1.1226    raeburn  12225:                             }
                   12226:                         }
                   12227:                     }
                   12228:                     $got_rules->{$udom} = 1;
                   12229:                 }
1.612     raeburn  12230:             }
1.1226    raeburn  12231:             if ($checkid) {
                   12232:                 foreach my $udom (keys(%by_id)) {
                   12233:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   12234:                     if ($outcome eq 'ok') {
1.1227    raeburn  12235:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   12236:                             my $uname = $by_id{$udom}{$id};
                   12237:                             $inst_response{$uname.':'.$udom} = $outcome;
                   12238:                         }
1.1226    raeburn  12239:                         if (ref($results) eq 'HASH') {
                   12240:                             foreach my $uname (keys(%{$results})) {
1.1227    raeburn  12241:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   12242:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   12243:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   12244:                                 }
1.1226    raeburn  12245:                             }
                   12246:                         }
                   12247:                     }
1.612     raeburn  12248:                 }
1.615     raeburn  12249:             } else {
1.1226    raeburn  12250:                 foreach my $udom (keys(%by_username)) {
                   12251:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   12252:                     if ($outcome eq 'ok') {
1.1227    raeburn  12253:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   12254:                             $inst_response{$uname.':'.$udom} = $outcome;
                   12255:                         }
1.1226    raeburn  12256:                         if (ref($results) eq 'HASH') {
                   12257:                             foreach my $uname (keys(%{$results})) {
                   12258:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   12259:                             }
                   12260:                         }
                   12261:                     }
                   12262:                 }
1.612     raeburn  12263:             }
1.1226    raeburn  12264:         } elsif (keys(%{$usershash}) == 1) {
                   12265:             my $user = (keys(%{$usershash}))[0];
                   12266:             my ($uname,$udom) = split(/:/,$user);
                   12267:             if (($udom ne '') && ($uname ne '')) {
                   12268:                 if (ref($usershash->{$user}) eq 'HASH') {
                   12269:                     if (ref($checks) eq 'HASH') {
                   12270:                         if (defined($checks->{'username'})) {
                   12271:                             ($inst_response{$user},%{$inst_results->{$user}}) = 
                   12272:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   12273:                         } elsif (defined($checks->{'id'})) {
                   12274:                             if ($usershash->{$user}->{'id'} ne '') {
                   12275:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   12276:                                     &Apache::lonnet::get_instuser($udom,undef,
                   12277:                                                                   $usershash->{$user}->{'id'});
                   12278:                             } else {
                   12279:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   12280:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   12281:                             }
1.585     raeburn  12282:                         }
1.1226    raeburn  12283:                     } else {
                   12284:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   12285:                             &Apache::lonnet::get_instuser($udom,$uname);
                   12286:                        return;
                   12287:                     }
                   12288:                     if (!$got_rules->{$udom}) {
                   12289:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   12290:                                                                  ['usercreation'],$udom);
                   12291:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   12292:                             foreach my $item ('username','id') {
                   12293:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   12294:                                    $$curr_rules{$udom}{$item} = 
                   12295:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   12296:                                 }
                   12297:                             }
                   12298:                         }
                   12299:                         $got_rules->{$udom} = 1;
1.585     raeburn  12300:                     }
                   12301:                 }
1.1226    raeburn  12302:             } else {
                   12303:                 return;
                   12304:             }
                   12305:         } else {
                   12306:             return;
                   12307:         }
                   12308:         foreach my $user (keys(%{$usershash})) {
                   12309:             my ($uname,$udom) = split(/:/,$user);
                   12310:             next if (($udom eq '') || ($uname eq ''));
                   12311:             my $id;
1.1227    raeburn  12312:             if (ref($inst_results) eq 'HASH') {
                   12313:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   12314:                     $id = $inst_results->{$user}->{'id'};
                   12315:                 }
                   12316:             }
                   12317:             if ($id eq '') { 
                   12318:                 if (ref($usershash->{$user})) {
                   12319:                     $id = $usershash->{$user}->{'id'};
                   12320:                 }
1.585     raeburn  12321:             }
1.612     raeburn  12322:             foreach my $item (keys(%{$checks})) {
                   12323:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   12324:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   12325:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226    raeburn  12326:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   12327:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  12328:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   12329:                                 if ($rule_check{$rule}) {
                   12330:                                     $$rulematch{$user}{$item} = $rule;
1.1226    raeburn  12331:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  12332:                                         if (ref($inst_results) eq 'HASH') {
                   12333:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   12334:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   12335:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1227    raeburn  12336:                                                 } elsif ($item eq 'id') {
                   12337:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   12338:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   12339:                                                     }
1.615     raeburn  12340:                                                 }
1.612     raeburn  12341:                                             }
                   12342:                                         }
1.615     raeburn  12343:                                     }
                   12344:                                     last;
1.585     raeburn  12345:                                 }
                   12346:                             }
                   12347:                         }
                   12348:                     }
                   12349:                 }
                   12350:             }
                   12351:         }
                   12352:     }
1.612     raeburn  12353:     return;
                   12354: }
                   12355: 
                   12356: sub user_rule_formats {
                   12357:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   12358:     my %text = ( 
                   12359:                  'username' => 'Usernames',
                   12360:                  'id'       => 'IDs',
                   12361:                );
                   12362:     my $output;
                   12363:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   12364:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   12365:         if (@{$ruleorder} > 0) {
1.1102    raeburn  12366:             $output = '<br />'.
                   12367:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   12368:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   12369:                       ' <ul>';
1.612     raeburn  12370:             foreach my $rule (@{$ruleorder}) {
                   12371:                 if (ref($curr_rules) eq 'ARRAY') {
                   12372:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   12373:                         if (ref($rules->{$rule}) eq 'HASH') {
                   12374:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   12375:                                         $rules->{$rule}{'desc'}.'</li>';
                   12376:                         }
                   12377:                     }
                   12378:                 }
                   12379:             }
                   12380:             $output .= '</ul>';
                   12381:         }
                   12382:     }
                   12383:     return $output;
                   12384: }
                   12385: 
                   12386: sub instrule_disallow_msg {
1.615     raeburn  12387:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  12388:     my $response;
                   12389:     my %text = (
                   12390:                   item   => 'username',
                   12391:                   items  => 'usernames',
                   12392:                   match  => 'matches',
                   12393:                   do     => 'does',
                   12394:                   action => 'a username',
                   12395:                   one    => 'one',
                   12396:                );
                   12397:     if ($count > 1) {
                   12398:         $text{'item'} = 'usernames';
                   12399:         $text{'match'} ='match';
                   12400:         $text{'do'} = 'do';
                   12401:         $text{'action'} = 'usernames',
                   12402:         $text{'one'} = 'ones';
                   12403:     }
                   12404:     if ($checkitem eq 'id') {
                   12405:         $text{'items'} = 'IDs';
                   12406:         $text{'item'} = 'ID';
                   12407:         $text{'action'} = 'an ID';
1.615     raeburn  12408:         if ($count > 1) {
                   12409:             $text{'item'} = 'IDs';
                   12410:             $text{'action'} = 'IDs';
                   12411:         }
1.612     raeburn  12412:     }
1.674     bisitz   12413:     $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  12414:     if ($mode eq 'upload') {
                   12415:         if ($checkitem eq 'username') {
                   12416:             $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'}.");
                   12417:         } elsif ($checkitem eq 'id') {
1.674     bisitz   12418:             $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  12419:         }
1.669     raeburn  12420:     } elsif ($mode eq 'selfcreate') {
                   12421:         if ($checkitem eq 'id') {
                   12422:             $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.");
                   12423:         }
1.615     raeburn  12424:     } else {
                   12425:         if ($checkitem eq 'username') {
                   12426:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   12427:         } elsif ($checkitem eq 'id') {
                   12428:             $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.");
                   12429:         }
1.612     raeburn  12430:     }
                   12431:     return $response;
1.585     raeburn  12432: }
                   12433: 
1.624     raeburn  12434: sub personal_data_fieldtitles {
                   12435:     my %fieldtitles = &Apache::lonlocal::texthash (
                   12436:                         id => 'Student/Employee ID',
                   12437:                         permanentemail => 'E-mail address',
                   12438:                         lastname => 'Last Name',
                   12439:                         firstname => 'First Name',
                   12440:                         middlename => 'Middle Name',
                   12441:                         generation => 'Generation',
                   12442:                         gen => 'Generation',
1.765     raeburn  12443:                         inststatus => 'Affiliation',
1.624     raeburn  12444:                    );
                   12445:     return %fieldtitles;
                   12446: }
                   12447: 
1.642     raeburn  12448: sub sorted_inst_types {
                   12449:     my ($dom) = @_;
1.1185    raeburn  12450:     my ($usertypes,$order);
                   12451:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   12452:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   12453:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   12454:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   12455:     } else {
                   12456:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   12457:     }
1.642     raeburn  12458:     my $othertitle = &mt('All users');
                   12459:     if ($env{'request.course.id'}) {
1.668     raeburn  12460:         $othertitle  = &mt('Any users');
1.642     raeburn  12461:     }
                   12462:     my @types;
                   12463:     if (ref($order) eq 'ARRAY') {
                   12464:         @types = @{$order};
                   12465:     }
                   12466:     if (@types == 0) {
                   12467:         if (ref($usertypes) eq 'HASH') {
                   12468:             @types = sort(keys(%{$usertypes}));
                   12469:         }
                   12470:     }
                   12471:     if (keys(%{$usertypes}) > 0) {
                   12472:         $othertitle = &mt('Other users');
                   12473:     }
                   12474:     return ($othertitle,$usertypes,\@types);
                   12475: }
                   12476: 
1.645     raeburn  12477: sub get_institutional_codes {
1.1361    raeburn  12478:     my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645     raeburn  12479: # Get complete list of course sections to update
                   12480:     my @currsections = ();
                   12481:     my @currxlists = ();
1.1361    raeburn  12482:     my (%unclutteredsec,%unclutteredlcsec);
1.645     raeburn  12483:     my $coursecode = $$settings{'internal.coursecode'};
1.1361    raeburn  12484:     my $crskey = $crs.':'.$coursecode;
                   12485:     @{$unclutteredsec{$crskey}} = ();
                   12486:     @{$unclutteredlcsec{$crskey}} = ();
1.645     raeburn  12487: 
                   12488:     if ($$settings{'internal.sectionnums'} ne '') {
                   12489:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   12490:     }
                   12491: 
                   12492:     if ($$settings{'internal.crosslistings'} ne '') {
                   12493:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   12494:     }
                   12495: 
                   12496:     if (@currxlists > 0) {
1.1361    raeburn  12497:         foreach my $xl (@currxlists) {
                   12498:             if ($xl =~ /^([^:]+):(\w*)$/) {
1.645     raeburn  12499:                 unless (grep/^$1$/,@{$allcourses}) {
1.1263    raeburn  12500:                     push(@{$allcourses},$1);
1.645     raeburn  12501:                     $$LC_code{$1} = $2;
                   12502:                 }
                   12503:             }
                   12504:         }
                   12505:     }
1.1361    raeburn  12506: 
1.645     raeburn  12507:     if (@currsections > 0) {
1.1361    raeburn  12508:         foreach my $sec (@currsections) {
                   12509:             if ($sec =~ m/^(\w+):(\w*)$/ ) {
                   12510:                 my $instsec = $1;
1.645     raeburn  12511:                 my $lc_sec = $2;
1.1361    raeburn  12512:                 unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
                   12513:                     push(@{$unclutteredsec{$crskey}},$instsec);
                   12514:                     push(@{$unclutteredlcsec{$crskey}},$lc_sec);
                   12515:                 }
                   12516:             }
                   12517:         }
                   12518:     }
                   12519: 
                   12520:     if (@{$unclutteredsec{$crskey}} > 0) {
                   12521:         my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
                   12522:         if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
                   12523:             for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
                   12524:                 my $sec = $coursecode.$formattedsec{$crskey}[$i];
                   12525:                 unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263    raeburn  12526:                     push(@{$allcourses},$sec);
1.1361    raeburn  12527:                     $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645     raeburn  12528:                 }
                   12529:             }
                   12530:         }
                   12531:     }
                   12532:     return;
                   12533: }
                   12534: 
1.971     raeburn  12535: sub get_standard_codeitems {
                   12536:     return ('Year','Semester','Department','Number','Section');
                   12537: }
                   12538: 
1.112     bowersj2 12539: =pod
                   12540: 
1.780     raeburn  12541: =head1 Slot Helpers
                   12542: 
                   12543: =over 4
                   12544: 
                   12545: =item * sorted_slots()
                   12546: 
1.1040    raeburn  12547: Sorts an array of slot names in order of an optional sort key,
                   12548: default sort is by slot start time (earliest first). 
1.780     raeburn  12549: 
                   12550: Inputs:
                   12551: 
                   12552: =over 4
                   12553: 
                   12554: slotsarr  - Reference to array of unsorted slot names.
                   12555: 
                   12556: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   12557: 
1.1040    raeburn  12558: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   12559: 
1.549     albertel 12560: =back
                   12561: 
1.780     raeburn  12562: Returns:
                   12563: 
                   12564: =over 4
                   12565: 
1.1040    raeburn  12566: sorted   - An array of slot names sorted by a specified sort key 
                   12567:            (default sort key is start time of the slot).
1.780     raeburn  12568: 
                   12569: =back
                   12570: 
                   12571: =cut
                   12572: 
                   12573: 
                   12574: sub sorted_slots {
1.1040    raeburn  12575:     my ($slotsarr,$slots,$sortkey) = @_;
                   12576:     if ($sortkey eq '') {
                   12577:         $sortkey = 'starttime';
                   12578:     }
1.780     raeburn  12579:     my @sorted;
                   12580:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   12581:         @sorted =
                   12582:             sort {
                   12583:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  12584:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  12585:                      }
                   12586:                      if (ref($slots->{$a})) { return -1;}
                   12587:                      if (ref($slots->{$b})) { return 1;}
                   12588:                      return 0;
                   12589:                  } @{$slotsarr};
                   12590:     }
                   12591:     return @sorted;
                   12592: }
                   12593: 
1.1040    raeburn  12594: =pod
                   12595: 
                   12596: =item * get_future_slots()
                   12597: 
                   12598: Inputs:
                   12599: 
                   12600: =over 4
                   12601: 
                   12602: cnum - course number
                   12603: 
                   12604: cdom - course domain
                   12605: 
                   12606: now - current UNIX time
                   12607: 
                   12608: symb - optional symb
                   12609: 
                   12610: =back
                   12611: 
                   12612: Returns:
                   12613: 
                   12614: =over 4
                   12615: 
                   12616: sorted_reservable - ref to array of student_schedulable slots currently 
                   12617:                     reservable, ordered by end date of reservation period.
                   12618: 
                   12619: reservable_now - ref to hash of student_schedulable slots currently
                   12620:                  reservable.
                   12621: 
                   12622:     Keys in inner hash are:
                   12623:     (a) symb: either blank or symb to which slot use is restricted.
1.1250    raeburn  12624:     (b) endreserve: end date of reservation period.
                   12625:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   12626:         selected.
1.1040    raeburn  12627: 
                   12628: sorted_future - ref to array of student_schedulable slots reservable in
                   12629:                 the future, ordered by start date of reservation period.
                   12630: 
                   12631: future_reservable - ref to hash of student_schedulable slots reservable
                   12632:                     in the future.
                   12633: 
                   12634:     Keys in inner hash are:
                   12635:     (a) symb: either blank or symb to which slot use is restricted.
1.1250    raeburn  12636:     (b) startreserve: start date of reservation period.
                   12637:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   12638:         selected.
1.1040    raeburn  12639: 
                   12640: =back
                   12641: 
                   12642: =cut
                   12643: 
                   12644: sub get_future_slots {
                   12645:     my ($cnum,$cdom,$now,$symb) = @_;
1.1229    raeburn  12646:     my $map;
                   12647:     if ($symb) {
                   12648:         ($map) = &Apache::lonnet::decode_symb($symb);
                   12649:     }
1.1040    raeburn  12650:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   12651:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   12652:     foreach my $slot (keys(%slots)) {
                   12653:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   12654:         if ($symb) {
1.1229    raeburn  12655:             if ($slots{$slot}->{'symb'} ne '') {
                   12656:                 my $canuse;
                   12657:                 my %oksymbs;
                   12658:                 my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
                   12659:                 map { $oksymbs{$_} = 1; } @slotsymbs;
                   12660:                 if ($oksymbs{$symb}) {
                   12661:                     $canuse = 1;
                   12662:                 } else {
                   12663:                     foreach my $item (@slotsymbs) {
                   12664:                         if ($item =~ /\.(page|sequence)$/) {
                   12665:                             (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
                   12666:                             if (($map ne '') && ($map eq $sloturl)) {
                   12667:                                 $canuse = 1;
                   12668:                                 last;
                   12669:                             }
                   12670:                         }
                   12671:                     }
                   12672:                 }
                   12673:                 next unless ($canuse);
                   12674:             }
1.1040    raeburn  12675:         }
                   12676:         if (($slots{$slot}->{'starttime'} > $now) &&
                   12677:             ($slots{$slot}->{'endtime'} > $now)) {
                   12678:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   12679:                 my $userallowed = 0;
                   12680:                 if ($slots{$slot}->{'allowedsections'}) {
                   12681:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   12682:                     if (!defined($env{'request.role.sec'})
                   12683:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   12684:                         $userallowed=1;
                   12685:                     } else {
                   12686:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   12687:                             $userallowed=1;
                   12688:                         }
                   12689:                     }
                   12690:                     unless ($userallowed) {
                   12691:                         if (defined($env{'request.course.groups'})) {
                   12692:                             my @groups = split(/:/,$env{'request.course.groups'});
                   12693:                             foreach my $group (@groups) {
                   12694:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   12695:                                     $userallowed=1;
                   12696:                                     last;
                   12697:                                 }
                   12698:                             }
                   12699:                         }
                   12700:                     }
                   12701:                 }
                   12702:                 if ($slots{$slot}->{'allowedusers'}) {
                   12703:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   12704:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   12705:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   12706:                         $userallowed = 1;
                   12707:                     }
                   12708:                 }
                   12709:                 next unless($userallowed);
                   12710:             }
                   12711:             my $startreserve = $slots{$slot}->{'startreserve'};
                   12712:             my $endreserve = $slots{$slot}->{'endreserve'};
                   12713:             my $symb = $slots{$slot}->{'symb'};
1.1250    raeburn  12714:             my $uniqueperiod;
                   12715:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   12716:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   12717:             }
1.1040    raeburn  12718:             if (($startreserve < $now) &&
                   12719:                 (!$endreserve || $endreserve > $now)) {
                   12720:                 my $lastres = $endreserve;
                   12721:                 if (!$lastres) {
                   12722:                     $lastres = $slots{$slot}->{'starttime'};
                   12723:                 }
                   12724:                 $reservable_now{$slot} = {
                   12725:                                            symb       => $symb,
1.1250    raeburn  12726:                                            endreserve => $lastres,
                   12727:                                            uniqueperiod => $uniqueperiod,
1.1040    raeburn  12728:                                          };
                   12729:             } elsif (($startreserve > $now) &&
                   12730:                      (!$endreserve || $endreserve > $startreserve)) {
                   12731:                 $future_reservable{$slot} = {
                   12732:                                               symb         => $symb,
1.1250    raeburn  12733:                                               startreserve => $startreserve,
                   12734:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  12735:                                             };
                   12736:             }
                   12737:         }
                   12738:     }
                   12739:     my @unsorted_reservable = keys(%reservable_now);
                   12740:     if (@unsorted_reservable > 0) {
                   12741:         @sorted_reservable = 
                   12742:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   12743:     }
                   12744:     my @unsorted_future = keys(%future_reservable);
                   12745:     if (@unsorted_future > 0) {
                   12746:         @sorted_future =
                   12747:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   12748:     }
                   12749:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   12750: }
1.780     raeburn  12751: 
                   12752: =pod
                   12753: 
1.1057    foxr     12754: =back
                   12755: 
1.549     albertel 12756: =head1 HTTP Helpers
                   12757: 
                   12758: =over 4
                   12759: 
1.648     raeburn  12760: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 12761: 
1.258     albertel 12762: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 12763: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 12764: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 12765: 
                   12766: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   12767: $possible_names is an ref to an array of form element names.  As an example:
                   12768: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 12769: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 12770: 
                   12771: =cut
1.1       albertel 12772: 
1.6       albertel 12773: sub get_unprocessed_cgi {
1.25      albertel 12774:   my ($query,$possible_names)= @_;
1.26      matthew  12775:   # $Apache::lonxml::debug=1;
1.356     albertel 12776:   foreach my $pair (split(/&/,$query)) {
                   12777:     my ($name, $value) = split(/=/,$pair);
1.369     www      12778:     $name = &unescape($name);
1.25      albertel 12779:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   12780:       $value =~ tr/+/ /;
                   12781:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 12782:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 12783:     }
1.16      harris41 12784:   }
1.6       albertel 12785: }
                   12786: 
1.112     bowersj2 12787: =pod
                   12788: 
1.648     raeburn  12789: =item * &cacheheader() 
1.112     bowersj2 12790: 
                   12791: returns cache-controlling header code
                   12792: 
                   12793: =cut
                   12794: 
1.7       albertel 12795: sub cacheheader {
1.258     albertel 12796:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 12797:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   12798:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 12799:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   12800:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 12801:     return $output;
1.7       albertel 12802: }
                   12803: 
1.112     bowersj2 12804: =pod
                   12805: 
1.648     raeburn  12806: =item * &no_cache($r) 
1.112     bowersj2 12807: 
                   12808: specifies header code to not have cache
                   12809: 
                   12810: =cut
                   12811: 
1.9       albertel 12812: sub no_cache {
1.216     albertel 12813:     my ($r) = @_;
                   12814:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 12815: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 12816:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   12817:     $r->no_cache(1);
                   12818:     $r->header_out("Expires" => $date);
                   12819:     $r->header_out("Pragma" => "no-cache");
1.123     www      12820: }
                   12821: 
                   12822: sub content_type {
1.181     albertel 12823:     my ($r,$type,$charset) = @_;
1.299     foxr     12824:     if ($r) {
                   12825: 	#  Note that printout.pl calls this with undef for $r.
                   12826: 	&no_cache($r);
                   12827:     }
1.258     albertel 12828:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 12829:     unless ($charset) {
                   12830: 	$charset=&Apache::lonlocal::current_encoding;
                   12831:     }
                   12832:     if ($charset) { $type.='; charset='.$charset; }
                   12833:     if ($r) {
                   12834: 	$r->content_type($type);
                   12835:     } else {
                   12836: 	print("Content-type: $type\n\n");
                   12837:     }
1.9       albertel 12838: }
1.25      albertel 12839: 
1.112     bowersj2 12840: =pod
                   12841: 
1.648     raeburn  12842: =item * &add_to_env($name,$value) 
1.112     bowersj2 12843: 
1.258     albertel 12844: adds $name to the %env hash with value
1.112     bowersj2 12845: $value, if $name already exists, the entry is converted to an array
                   12846: reference and $value is added to the array.
                   12847: 
                   12848: =cut
                   12849: 
1.25      albertel 12850: sub add_to_env {
                   12851:   my ($name,$value)=@_;
1.258     albertel 12852:   if (defined($env{$name})) {
                   12853:     if (ref($env{$name})) {
1.25      albertel 12854:       #already have multiple values
1.258     albertel 12855:       push(@{ $env{$name} },$value);
1.25      albertel 12856:     } else {
                   12857:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 12858:       my $first=$env{$name};
                   12859:       undef($env{$name});
                   12860:       push(@{ $env{$name} },$first,$value);
1.25      albertel 12861:     }
                   12862:   } else {
1.258     albertel 12863:     $env{$name}=$value;
1.25      albertel 12864:   }
1.31      albertel 12865: }
1.149     albertel 12866: 
                   12867: =pod
                   12868: 
1.648     raeburn  12869: =item * &get_env_multiple($name) 
1.149     albertel 12870: 
1.258     albertel 12871: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 12872: values may be defined and end up as an array ref.
                   12873: 
                   12874: returns an array of values
                   12875: 
                   12876: =cut
                   12877: 
                   12878: sub get_env_multiple {
                   12879:     my ($name) = @_;
                   12880:     my @values;
1.258     albertel 12881:     if (defined($env{$name})) {
1.149     albertel 12882:         # exists is it an array
1.258     albertel 12883:         if (ref($env{$name})) {
                   12884:             @values=@{ $env{$name} };
1.149     albertel 12885:         } else {
1.258     albertel 12886:             $values[0]=$env{$name};
1.149     albertel 12887:         }
                   12888:     }
                   12889:     return(@values);
                   12890: }
                   12891: 
1.1249    damieng  12892: # Looks at given dependencies, and returns something depending on the context.
                   12893: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
                   12894: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
                   12895: # For all other contexts, returns ($output, $counter, $numpathchg).
                   12896: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
                   12897: # $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.
                   12898: # $numpathchg: integer with the number of cleaned up dependency paths.
                   12899: # \%existing: hash reference clean path -> 1 only for existing dependencies.
                   12900: # \%mapping: hash reference clean path -> original path for all dependencies.
                   12901: # @param {string} actionurl - The path to the handler, indicative of the context.
                   12902: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
                   12903: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
                   12904: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
                   12905: # @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)
                   12906: # @return {Array} - array depending on the context (not a reference)
1.660     raeburn  12907: sub ask_for_embedded_content {
1.1249    damieng  12908:     # NOTE: documentation was added afterwards, it could be wrong
1.660     raeburn  12909:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  12910:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085    raeburn  12911:         %currsubfile,%unused,$rem);
1.1071    raeburn  12912:     my $counter = 0;
                   12913:     my $numnew = 0;
1.987     raeburn  12914:     my $numremref = 0;
                   12915:     my $numinvalid = 0;
                   12916:     my $numpathchg = 0;
                   12917:     my $numexisting = 0;
1.1071    raeburn  12918:     my $numunused = 0;
                   12919:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156    raeburn  12920:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  12921:     my $heading = &mt('Upload embedded files');
                   12922:     my $buttontext = &mt('Upload');
                   12923: 
1.1249    damieng  12924:     # fills these variables based on the context:
                   12925:     # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
                   12926:     # $path, $fileloc, $title, $rem, $filename
1.1085    raeburn  12927:     if ($env{'request.course.id'}) {
1.1123    raeburn  12928:         if ($actionurl eq '/adm/dependencies') {
                   12929:             $navmap = Apache::lonnavmaps::navmap->new();
                   12930:         }
                   12931:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   12932:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085    raeburn  12933:     }
1.1123    raeburn  12934:     if (($actionurl eq '/adm/portfolio') || 
                   12935:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  12936:         my $current_path='/';
                   12937:         if ($env{'form.currentpath'}) {
                   12938:             $current_path = $env{'form.currentpath'};
                   12939:         }
                   12940:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123    raeburn  12941:             $udom = $cdom;
                   12942:             $uname = $cnum;
1.984     raeburn  12943:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   12944:         } else {
                   12945:             $udom = $env{'user.domain'};
                   12946:             $uname = $env{'user.name'};
                   12947:             $url = '/userfiles/portfolio';
                   12948:         }
1.987     raeburn  12949:         $toplevel = $url.'/';
1.984     raeburn  12950:         $url .= $current_path;
                   12951:         $getpropath = 1;
1.987     raeburn  12952:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   12953:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      12954:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  12955:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  12956:         $toplevel = $url;
1.984     raeburn  12957:         if ($rest ne '') {
1.987     raeburn  12958:             $url .= $rest;
                   12959:         }
                   12960:     } elsif ($actionurl eq '/adm/coursedocs') {
                   12961:         if (ref($args) eq 'HASH') {
1.1071    raeburn  12962:             $url = $args->{'docs_url'};
                   12963:             $toplevel = $url;
1.1084    raeburn  12964:             if ($args->{'context'} eq 'paste') {
                   12965:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   12966:                 ($path) = 
                   12967:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   12968:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   12969:                 $fileloc =~ s{^/}{};
                   12970:             }
1.1071    raeburn  12971:         }
1.1084    raeburn  12972:     } elsif ($actionurl eq '/adm/dependencies')  {
1.1071    raeburn  12973:         if ($env{'request.course.id'} ne '') {
                   12974:             if (ref($args) eq 'HASH') {
                   12975:                 $url = $args->{'docs_url'};
                   12976:                 $title = $args->{'docs_title'};
1.1126    raeburn  12977:                 $toplevel = $url; 
                   12978:                 unless ($toplevel =~ m{^/}) {
                   12979:                     $toplevel = "/$url";
                   12980:                 }
1.1085    raeburn  12981:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126    raeburn  12982:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   12983:                     $path = $1;
                   12984:                 } else {
                   12985:                     ($path) =
                   12986:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   12987:                 }
1.1195    raeburn  12988:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   12989:                     $fileloc = $toplevel;
                   12990:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   12991:                     my ($udom,$uname,$fname) =
                   12992:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   12993:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   12994:                 } else {
                   12995:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   12996:                 }
1.1071    raeburn  12997:                 $fileloc =~ s{^/}{};
                   12998:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   12999:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   13000:             }
1.987     raeburn  13001:         }
1.1123    raeburn  13002:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   13003:         $udom = $cdom;
                   13004:         $uname = $cnum;
                   13005:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   13006:         $toplevel = $url;
                   13007:         $path = $url;
                   13008:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   13009:         $fileloc =~ s{^/}{};
1.987     raeburn  13010:     }
1.1249    damieng  13011:     
                   13012:     # parses the dependency paths to get some info
                   13013:     # fills $newfiles, $mapping, $subdependencies, $dependencies
                   13014:     # $newfiles: hash URL -> 1 for new files or external URLs
                   13015:     # (will be completed later)
                   13016:     # $mapping:
                   13017:     #   for external URLs: external URL -> external URL
                   13018:     #   for relative paths: clean path -> original path
                   13019:     # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
                   13020:     # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126    raeburn  13021:     foreach my $file (keys(%{$allfiles})) {
                   13022:         my $embed_file;
                   13023:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   13024:             $embed_file = $1;
                   13025:         } else {
                   13026:             $embed_file = $file;
                   13027:         }
1.1158    raeburn  13028:         my ($absolutepath,$cleaned_file);
                   13029:         if ($embed_file =~ m{^\w+://}) {
                   13030:             $cleaned_file = $embed_file;
1.1147    raeburn  13031:             $newfiles{$cleaned_file} = 1;
                   13032:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  13033:         } else {
1.1158    raeburn  13034:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  13035:             if ($embed_file =~ m{^/}) {
                   13036:                 $absolutepath = $embed_file;
                   13037:             }
1.1147    raeburn  13038:             if ($cleaned_file =~ m{/}) {
                   13039:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  13040:                 $path = &check_for_traversal($path,$url,$toplevel);
                   13041:                 my $item = $fname;
                   13042:                 if ($path ne '') {
                   13043:                     $item = $path.'/'.$fname;
                   13044:                     $subdependencies{$path}{$fname} = 1;
                   13045:                 } else {
                   13046:                     $dependencies{$item} = 1;
                   13047:                 }
                   13048:                 if ($absolutepath) {
                   13049:                     $mapping{$item} = $absolutepath;
                   13050:                 } else {
                   13051:                     $mapping{$item} = $embed_file;
                   13052:                 }
                   13053:             } else {
                   13054:                 $dependencies{$embed_file} = 1;
                   13055:                 if ($absolutepath) {
1.1147    raeburn  13056:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  13057:                 } else {
1.1147    raeburn  13058:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  13059:                 }
                   13060:             }
1.984     raeburn  13061:         }
                   13062:     }
1.1249    damieng  13063:     
                   13064:     # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
                   13065:     # and lists
                   13066:     # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
                   13067:     # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
                   13068:     # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
                   13069:     #                                    the path had to be cleaned up
                   13070:     # $existing: hash clean path -> 1 if the file exists
                   13071:     # $numexisting: number of keys in $existing
                   13072:     # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
                   13073:     # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
                   13074:     #                                      dependency subdirectories that are
                   13075:     #                                      not listed as dependencies, with some exceptions using $rem
1.1071    raeburn  13076:     my $dirptr = 16384;
1.984     raeburn  13077:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  13078:         $currsubfile{$path} = {};
1.1123    raeburn  13079:         if (($actionurl eq '/adm/portfolio') || 
                   13080:             ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  13081:             my ($sublistref,$listerror) =
                   13082:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   13083:             if (ref($sublistref) eq 'ARRAY') {
                   13084:                 foreach my $line (@{$sublistref}) {
                   13085:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  13086:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  13087:                 }
1.984     raeburn  13088:             }
1.987     raeburn  13089:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  13090:             if (opendir(my $dir,$url.'/'.$path)) {
                   13091:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  13092:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   13093:             }
1.1084    raeburn  13094:         } elsif (($actionurl eq '/adm/dependencies') ||
                   13095:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123    raeburn  13096:                   ($args->{'context'} eq 'paste')) ||
                   13097:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  13098:             if ($env{'request.course.id'} ne '') {
1.1123    raeburn  13099:                 my $dir;
                   13100:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   13101:                     $dir = $fileloc;
                   13102:                 } else {
                   13103:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   13104:                 }
1.1071    raeburn  13105:                 if ($dir ne '') {
                   13106:                     my ($sublistref,$listerror) =
                   13107:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   13108:                     if (ref($sublistref) eq 'ARRAY') {
                   13109:                         foreach my $line (@{$sublistref}) {
                   13110:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   13111:                                 undef,$mtime)=split(/\&/,$line,12);
                   13112:                             unless (($testdir&$dirptr) ||
                   13113:                                     ($file_name =~ /^\.\.?$/)) {
                   13114:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   13115:                             }
                   13116:                         }
                   13117:                     }
                   13118:                 }
1.984     raeburn  13119:             }
                   13120:         }
                   13121:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  13122:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  13123:                 my $item = $path.'/'.$file;
                   13124:                 unless ($mapping{$item} eq $item) {
                   13125:                     $pathchanges{$item} = 1;
                   13126:                 }
                   13127:                 $existing{$item} = 1;
                   13128:                 $numexisting ++;
                   13129:             } else {
                   13130:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  13131:             }
                   13132:         }
1.1071    raeburn  13133:         if ($actionurl eq '/adm/dependencies') {
                   13134:             foreach my $path (keys(%currsubfile)) {
                   13135:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   13136:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   13137:                          unless ($subdependencies{$path}{$file}) {
1.1085    raeburn  13138:                              next if (($rem ne '') &&
                   13139:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   13140:                                        (ref($navmap) &&
                   13141:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   13142:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   13143:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  13144:                              $unused{$path.'/'.$file} = 1; 
                   13145:                          }
                   13146:                     }
                   13147:                 }
                   13148:             }
                   13149:         }
1.984     raeburn  13150:     }
1.1249    damieng  13151:     
                   13152:     # fills $currfile, hash file name -> 1 or [$size,$mtime]
                   13153:     # for files in $url or $fileloc (target directory) in some contexts
1.987     raeburn  13154:     my %currfile;
1.1123    raeburn  13155:     if (($actionurl eq '/adm/portfolio') ||
                   13156:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  13157:         my ($dirlistref,$listerror) =
                   13158:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   13159:         if (ref($dirlistref) eq 'ARRAY') {
                   13160:             foreach my $line (@{$dirlistref}) {
                   13161:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   13162:                 $currfile{$file_name} = 1;
                   13163:             }
1.984     raeburn  13164:         }
1.987     raeburn  13165:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  13166:         if (opendir(my $dir,$url)) {
1.987     raeburn  13167:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  13168:             map {$currfile{$_} = 1;} @dir_list;
                   13169:         }
1.1084    raeburn  13170:     } elsif (($actionurl eq '/adm/dependencies') ||
                   13171:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123    raeburn  13172:               ($args->{'context'} eq 'paste')) ||
                   13173:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  13174:         if ($env{'request.course.id'} ne '') {
                   13175:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   13176:             if ($dir ne '') {
                   13177:                 my ($dirlistref,$listerror) =
                   13178:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   13179:                 if (ref($dirlistref) eq 'ARRAY') {
                   13180:                     foreach my $line (@{$dirlistref}) {
                   13181:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   13182:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   13183:                         unless (($testdir&$dirptr) ||
                   13184:                                 ($file_name =~ /^\.\.?$/)) {
                   13185:                             $currfile{$file_name} = [$size,$mtime];
                   13186:                         }
                   13187:                     }
                   13188:                 }
                   13189:             }
                   13190:         }
1.984     raeburn  13191:     }
1.1249    damieng  13192:     # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
                   13193:     # are not in subdirectories, using $currfile
1.984     raeburn  13194:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  13195:         if (exists($currfile{$file})) {
1.987     raeburn  13196:             unless ($mapping{$file} eq $file) {
                   13197:                 $pathchanges{$file} = 1;
                   13198:             }
                   13199:             $existing{$file} = 1;
                   13200:             $numexisting ++;
                   13201:         } else {
1.984     raeburn  13202:             $newfiles{$file} = 1;
                   13203:         }
                   13204:     }
1.1071    raeburn  13205:     foreach my $file (keys(%currfile)) {
                   13206:         unless (($file eq $filename) ||
                   13207:                 ($file eq $filename.'.bak') ||
                   13208:                 ($dependencies{$file})) {
1.1085    raeburn  13209:             if ($actionurl eq '/adm/dependencies') {
1.1126    raeburn  13210:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   13211:                     next if (($rem ne '') &&
                   13212:                              (($env{"httpref.$rem".$file} ne '') ||
                   13213:                               (ref($navmap) &&
                   13214:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   13215:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   13216:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   13217:                 }
1.1085    raeburn  13218:             }
1.1071    raeburn  13219:             $unused{$file} = 1;
                   13220:         }
                   13221:     }
1.1249    damieng  13222:     
                   13223:     # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084    raeburn  13224:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   13225:         ($args->{'context'} eq 'paste')) {
                   13226:         $counter = scalar(keys(%existing));
                   13227:         $numpathchg = scalar(keys(%pathchanges));
1.1123    raeburn  13228:         return ($output,$counter,$numpathchg,\%existing);
                   13229:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") && 
                   13230:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   13231:         $counter = scalar(keys(%existing));
                   13232:         $numpathchg = scalar(keys(%pathchanges));
                   13233:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084    raeburn  13234:     }
1.1249    damieng  13235:     
                   13236:     # returns HTML otherwise, with dependency results and to ask for more uploads
                   13237:     
                   13238:     # $upload_output: missing dependencies (with upload form)
                   13239:     # $modify_output: uploaded dependencies (in use)
                   13240:     # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984     raeburn  13241:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  13242:         if ($actionurl eq '/adm/dependencies') {
                   13243:             next if ($embed_file =~ m{^\w+://});
                   13244:         }
1.660     raeburn  13245:         $upload_output .= &start_data_table_row().
1.1123    raeburn  13246:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  13247:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  13248:         unless ($mapping{$embed_file} eq $embed_file) {
1.1123    raeburn  13249:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   13250:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  13251:         }
1.1123    raeburn  13252:         $upload_output .= '</td>';
1.1071    raeburn  13253:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1123    raeburn  13254:             $upload_output.='<td align="right">'.
                   13255:                             '<span class="LC_info LC_fontsize_medium">'.
                   13256:                             &mt("URL points to web address").'</span>';
1.987     raeburn  13257:             $numremref++;
1.660     raeburn  13258:         } elsif ($args->{'error_on_invalid_names'}
                   13259:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123    raeburn  13260:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   13261:                             &mt('Invalid characters').'</span>';
1.987     raeburn  13262:             $numinvalid++;
1.660     raeburn  13263:         } else {
1.1123    raeburn  13264:             $upload_output .= '<td>'.
                   13265:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  13266:                                                      $embed_file,\%mapping,
1.1071    raeburn  13267:                                                      $allfiles,$codebase,'upload');
                   13268:             $counter ++;
                   13269:             $numnew ++;
1.987     raeburn  13270:         }
                   13271:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   13272:     }
                   13273:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  13274:         if ($actionurl eq '/adm/dependencies') {
                   13275:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   13276:             $modify_output .= &start_data_table_row().
                   13277:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   13278:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   13279:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   13280:                               '<td>'.$size.'</td>'.
                   13281:                               '<td>'.$mtime.'</td>'.
                   13282:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   13283:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   13284:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   13285:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   13286:                               &embedded_file_element('upload_embedded',$counter,
                   13287:                                                      $embed_file,\%mapping,
                   13288:                                                      $allfiles,$codebase,'modify').
                   13289:                               '</div></td>'.
                   13290:                               &end_data_table_row()."\n";
                   13291:             $counter ++;
                   13292:         } else {
                   13293:             $upload_output .= &start_data_table_row().
1.1123    raeburn  13294:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   13295:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   13296:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  13297:                               &Apache::loncommon::end_data_table_row()."\n";
                   13298:         }
                   13299:     }
                   13300:     my $delidx = $counter;
                   13301:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   13302:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   13303:         $delete_output .= &start_data_table_row().
                   13304:                           '<td><img src="'.&icon($oldfile).'" />'.
                   13305:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   13306:                           '<td>'.$size.'</td>'.
                   13307:                           '<td>'.$mtime.'</td>'.
                   13308:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   13309:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   13310:                           &embedded_file_element('upload_embedded',$delidx,
                   13311:                                                  $oldfile,\%mapping,$allfiles,
                   13312:                                                  $codebase,'delete').'</td>'.
                   13313:                           &end_data_table_row()."\n"; 
                   13314:         $numunused ++;
                   13315:         $delidx ++;
1.987     raeburn  13316:     }
                   13317:     if ($upload_output) {
                   13318:         $upload_output = &start_data_table().
                   13319:                          $upload_output.
                   13320:                          &end_data_table()."\n";
                   13321:     }
1.1071    raeburn  13322:     if ($modify_output) {
                   13323:         $modify_output = &start_data_table().
                   13324:                          &start_data_table_header_row().
                   13325:                          '<th>'.&mt('File').'</th>'.
                   13326:                          '<th>'.&mt('Size (KB)').'</th>'.
                   13327:                          '<th>'.&mt('Modified').'</th>'.
                   13328:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   13329:                          &end_data_table_header_row().
                   13330:                          $modify_output.
                   13331:                          &end_data_table()."\n";
                   13332:     }
                   13333:     if ($delete_output) {
                   13334:         $delete_output = &start_data_table().
                   13335:                          &start_data_table_header_row().
                   13336:                          '<th>'.&mt('File').'</th>'.
                   13337:                          '<th>'.&mt('Size (KB)').'</th>'.
                   13338:                          '<th>'.&mt('Modified').'</th>'.
                   13339:                          '<th>'.&mt('Delete?').'</th>'.
                   13340:                          &end_data_table_header_row().
                   13341:                          $delete_output.
                   13342:                          &end_data_table()."\n";
                   13343:     }
1.987     raeburn  13344:     my $applies = 0;
                   13345:     if ($numremref) {
                   13346:         $applies ++;
                   13347:     }
                   13348:     if ($numinvalid) {
                   13349:         $applies ++;
                   13350:     }
                   13351:     if ($numexisting) {
                   13352:         $applies ++;
                   13353:     }
1.1071    raeburn  13354:     if ($counter || $numunused) {
1.987     raeburn  13355:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   13356:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  13357:                   $state.'<h3>'.$heading.'</h3>'; 
                   13358:         if ($actionurl eq '/adm/dependencies') {
                   13359:             if ($numnew) {
                   13360:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   13361:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   13362:                            $upload_output.'<br />'."\n";
                   13363:             }
                   13364:             if ($numexisting) {
                   13365:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   13366:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   13367:                            $modify_output.'<br />'."\n";
                   13368:                            $buttontext = &mt('Save changes');
                   13369:             }
                   13370:             if ($numunused) {
                   13371:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   13372:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   13373:                            $delete_output.'<br />'."\n";
                   13374:                            $buttontext = &mt('Save changes');
                   13375:             }
                   13376:         } else {
                   13377:             $output .= $upload_output.'<br />'."\n";
                   13378:         }
                   13379:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   13380:                    $counter.'" />'."\n";
                   13381:         if ($actionurl eq '/adm/dependencies') { 
                   13382:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   13383:                        $numnew.'" />'."\n";
                   13384:         } elsif ($actionurl eq '') {
1.987     raeburn  13385:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   13386:         }
                   13387:     } elsif ($applies) {
                   13388:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   13389:         if ($applies > 1) {
                   13390:             $output .=  
1.1123    raeburn  13391:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  13392:             if ($numremref) {
                   13393:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   13394:             }
                   13395:             if ($numinvalid) {
                   13396:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   13397:             }
                   13398:             if ($numexisting) {
                   13399:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   13400:             }
                   13401:             $output .= '</ul><br />';
                   13402:         } elsif ($numremref) {
                   13403:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   13404:         } elsif ($numinvalid) {
                   13405:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   13406:         } elsif ($numexisting) {
                   13407:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   13408:         }
                   13409:         $output .= $upload_output.'<br />';
                   13410:     }
                   13411:     my ($pathchange_output,$chgcount);
1.1071    raeburn  13412:     $chgcount = $counter;
1.987     raeburn  13413:     if (keys(%pathchanges) > 0) {
                   13414:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  13415:             if ($counter) {
1.987     raeburn  13416:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   13417:                                                   $embed_file,\%mapping,
1.1071    raeburn  13418:                                                   $allfiles,$codebase,'change');
1.987     raeburn  13419:             } else {
                   13420:                 $pathchange_output .= 
                   13421:                     &start_data_table_row().
                   13422:                     '<td><input type ="checkbox" name="namechange" value="'.
                   13423:                     $chgcount.'" checked="checked" /></td>'.
                   13424:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   13425:                     '<td>'.$embed_file.
                   13426:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  13427:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  13428:                     '</td>'.&end_data_table_row();
1.660     raeburn  13429:             }
1.987     raeburn  13430:             $numpathchg ++;
                   13431:             $chgcount ++;
1.660     raeburn  13432:         }
                   13433:     }
1.1127    raeburn  13434:     if (($counter) || ($numunused)) {
1.987     raeburn  13435:         if ($numpathchg) {
                   13436:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   13437:                        $numpathchg.'" />'."\n";
                   13438:         }
                   13439:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   13440:             ($actionurl eq '/adm/imsimport')) {
                   13441:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   13442:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   13443:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  13444:         } elsif ($actionurl eq '/adm/dependencies') {
                   13445:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  13446:         }
1.1123    raeburn  13447:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  13448:     } elsif ($numpathchg) {
                   13449:         my %pathchange = ();
                   13450:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   13451:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   13452:             $output .= '<p>'.&mt('or').'</p>'; 
1.1123    raeburn  13453:         }
1.987     raeburn  13454:     }
1.1071    raeburn  13455:     return ($output,$counter,$numpathchg);
1.987     raeburn  13456: }
                   13457: 
1.1147    raeburn  13458: =pod
                   13459: 
                   13460: =item * clean_path($name)
                   13461: 
                   13462: Performs clean-up of directories, subdirectories and filename in an
                   13463: embedded object, referenced in an HTML file which is being uploaded
                   13464: to a course or portfolio, where 
                   13465: "Upload embedded images/multimedia files if HTML file" checkbox was
                   13466: checked.
                   13467: 
                   13468: Clean-up is similar to replacements in lonnet::clean_filename()
                   13469: except each / between sub-directory and next level is preserved.
                   13470: 
                   13471: =cut
                   13472: 
                   13473: sub clean_path {
                   13474:     my ($embed_file) = @_;
                   13475:     $embed_file =~s{^/+}{};
                   13476:     my @contents;
                   13477:     if ($embed_file =~ m{/}) {
                   13478:         @contents = split(/\//,$embed_file);
                   13479:     } else {
                   13480:         @contents = ($embed_file);
                   13481:     }
                   13482:     my $lastidx = scalar(@contents)-1;
                   13483:     for (my $i=0; $i<=$lastidx; $i++) { 
                   13484:         $contents[$i]=~s{\\}{/}g;
                   13485:         $contents[$i]=~s/\s+/\_/g;
                   13486:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   13487:         if ($i == $lastidx) {
                   13488:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   13489:         }
                   13490:     }
                   13491:     if ($lastidx > 0) {
                   13492:         return join('/',@contents);
                   13493:     } else {
                   13494:         return $contents[0];
                   13495:     }
                   13496: }
                   13497: 
1.987     raeburn  13498: sub embedded_file_element {
1.1071    raeburn  13499:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  13500:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   13501:                    (ref($codebase) eq 'HASH'));
                   13502:     my $output;
1.1071    raeburn  13503:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  13504:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   13505:     }
                   13506:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   13507:                &escape($embed_file).'" />';
                   13508:     unless (($context eq 'upload_embedded') && 
                   13509:             ($mapping->{$embed_file} eq $embed_file)) {
                   13510:         $output .='
                   13511:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   13512:     }
                   13513:     my $attrib;
                   13514:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   13515:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   13516:     }
                   13517:     $output .=
                   13518:         "\n\t\t".
                   13519:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   13520:         $attrib.'" />';
                   13521:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   13522:         $output .=
                   13523:             "\n\t\t".
                   13524:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   13525:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  13526:     }
1.987     raeburn  13527:     return $output;
1.660     raeburn  13528: }
                   13529: 
1.1071    raeburn  13530: sub get_dependency_details {
                   13531:     my ($currfile,$currsubfile,$embed_file) = @_;
                   13532:     my ($size,$mtime,$showsize,$showmtime);
                   13533:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   13534:         if ($embed_file =~ m{/}) {
                   13535:             my ($path,$fname) = split(/\//,$embed_file);
                   13536:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   13537:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   13538:             }
                   13539:         } else {
                   13540:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   13541:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   13542:             }
                   13543:         }
                   13544:         $showsize = $size/1024.0;
                   13545:         $showsize = sprintf("%.1f",$showsize);
                   13546:         if ($mtime > 0) {
                   13547:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   13548:         }
                   13549:     }
                   13550:     return ($showsize,$showmtime);
                   13551: }
                   13552: 
                   13553: sub ask_embedded_js {
                   13554:     return <<"END";
                   13555: <script type="text/javascript"">
                   13556: // <![CDATA[
                   13557: function toggleBrowse(counter) {
                   13558:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   13559:     var fileid = document.getElementById('embedded_item_'+counter);
                   13560:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   13561:     if (chkboxid.checked == true) {
                   13562:         uploaddivid.style.display='block';
                   13563:     } else {
                   13564:         uploaddivid.style.display='none';
                   13565:         fileid.value = '';
                   13566:     }
                   13567: }
                   13568: // ]]>
                   13569: </script>
                   13570: 
                   13571: END
                   13572: }
                   13573: 
1.661     raeburn  13574: sub upload_embedded {
                   13575:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  13576:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   13577:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  13578:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   13579:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   13580:         my $orig_uploaded_filename =
                   13581:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  13582:         foreach my $type ('orig','ref','attrib','codebase') {
                   13583:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   13584:                 $env{'form.embedded_'.$type.'_'.$i} =
                   13585:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   13586:             }
                   13587:         }
1.661     raeburn  13588:         my ($path,$fname) =
                   13589:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   13590:         # no path, whole string is fname
                   13591:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   13592:         $fname = &Apache::lonnet::clean_filename($fname);
                   13593:         # See if there is anything left
                   13594:         next if ($fname eq '');
                   13595: 
                   13596:         # Check if file already exists as a file or directory.
                   13597:         my ($state,$msg);
                   13598:         if ($context eq 'portfolio') {
                   13599:             my $port_path = $dirpath;
                   13600:             if ($group ne '') {
                   13601:                 $port_path = "groups/$group/$port_path";
                   13602:             }
1.987     raeburn  13603:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   13604:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  13605:                                               $dir_root,$port_path,$disk_quota,
                   13606:                                               $current_disk_usage,$uname,$udom);
                   13607:             if ($state eq 'will_exceed_quota'
1.984     raeburn  13608:                 || $state eq 'file_locked') {
1.661     raeburn  13609:                 $output .= $msg;
                   13610:                 next;
                   13611:             }
                   13612:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   13613:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   13614:             if ($state eq 'exists') {
                   13615:                 $output .= $msg;
                   13616:                 next;
                   13617:             }
                   13618:         }
                   13619:         # Check if extension is valid
                   13620:         if (($fname =~ /\.(\w+)$/) &&
                   13621:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155    bisitz   13622:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   13623:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  13624:             next;
                   13625:         } elsif (($fname =~ /\.(\w+)$/) &&
                   13626:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  13627:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  13628:             next;
                   13629:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120    bisitz   13630:             $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  13631:             next;
                   13632:         }
                   13633:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123    raeburn  13634:         my $subdir = $path;
                   13635:         $subdir =~ s{/+$}{};
1.661     raeburn  13636:         if ($context eq 'portfolio') {
1.984     raeburn  13637:             my $result;
                   13638:             if ($state eq 'existingfile') {
                   13639:                 $result=
                   13640:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123    raeburn  13641:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  13642:             } else {
1.984     raeburn  13643:                 $result=
                   13644:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  13645:                                                     $dirpath.
1.1123    raeburn  13646:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  13647:                 if ($result !~ m|^/uploaded/|) {
                   13648:                     $output .= '<span class="LC_error">'
                   13649:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   13650:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   13651:                                .'</span><br />';
                   13652:                     next;
                   13653:                 } else {
1.987     raeburn  13654:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   13655:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  13656:                 }
1.661     raeburn  13657:             }
1.1123    raeburn  13658:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126    raeburn  13659:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   13660:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  13661:             my $result =
1.1126    raeburn  13662:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  13663:             if ($result !~ m|^/uploaded/|) {
                   13664:                 $output .= '<span class="LC_error">'
                   13665:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   13666:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   13667:                            .'</span><br />';
                   13668:                     next;
                   13669:             } else {
                   13670:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   13671:                            $path.$fname.'</span>').'<br />';
1.1125    raeburn  13672:                 if ($context eq 'syllabus') {
                   13673:                     &Apache::lonnet::make_public_indefinitely($result);
                   13674:                 }
1.987     raeburn  13675:             }
1.661     raeburn  13676:         } else {
                   13677: # Save the file
                   13678:             my $target = $env{'form.embedded_item_'.$i};
                   13679:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   13680:             my $dest = $fullpath.$fname;
                   13681:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  13682:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  13683:             my $count;
                   13684:             my $filepath = $dir_root;
1.1027    raeburn  13685:             foreach my $subdir (@parts) {
                   13686:                 $filepath .= "/$subdir";
                   13687:                 if (!-e $filepath) {
1.661     raeburn  13688:                     mkdir($filepath,0770);
                   13689:                 }
                   13690:             }
                   13691:             my $fh;
                   13692:             if (!open($fh,'>'.$dest)) {
                   13693:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   13694:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  13695:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   13696:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  13697:                            '</span><br />';
                   13698:             } else {
                   13699:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   13700:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   13701:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  13702:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   13703:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  13704:                               '</span><br />';
                   13705:                 } else {
1.987     raeburn  13706:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   13707:                                $url.'</span>').'<br />';
                   13708:                     unless ($context eq 'testbank') {
                   13709:                         $footer .= &mt('View embedded file: [_1]',
                   13710:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   13711:                     }
                   13712:                 }
                   13713:                 close($fh);
                   13714:             }
                   13715:         }
                   13716:         if ($env{'form.embedded_ref_'.$i}) {
                   13717:             $pathchange{$i} = 1;
                   13718:         }
                   13719:     }
                   13720:     if ($output) {
                   13721:         $output = '<p>'.$output.'</p>';
                   13722:     }
                   13723:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   13724:     $returnflag = 'ok';
1.1071    raeburn  13725:     my $numpathchgs = scalar(keys(%pathchange));
                   13726:     if ($numpathchgs > 0) {
1.987     raeburn  13727:         if ($context eq 'portfolio') {
                   13728:             $output .= '<p>'.&mt('or').'</p>';
                   13729:         } elsif ($context eq 'testbank') {
1.1071    raeburn  13730:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   13731:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  13732:             $returnflag = 'modify_orightml';
                   13733:         }
                   13734:     }
1.1071    raeburn  13735:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  13736: }
                   13737: 
                   13738: sub modify_html_form {
                   13739:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   13740:     my $end = 0;
                   13741:     my $modifyform;
                   13742:     if ($context eq 'upload_embedded') {
                   13743:         return unless (ref($pathchange) eq 'HASH');
                   13744:         if ($env{'form.number_embedded_items'}) {
                   13745:             $end += $env{'form.number_embedded_items'};
                   13746:         }
                   13747:         if ($env{'form.number_pathchange_items'}) {
                   13748:             $end += $env{'form.number_pathchange_items'};
                   13749:         }
                   13750:         if ($end) {
                   13751:             for (my $i=0; $i<$end; $i++) {
                   13752:                 if ($i < $env{'form.number_embedded_items'}) {
                   13753:                     next unless($pathchange->{$i});
                   13754:                 }
                   13755:                 $modifyform .=
                   13756:                     &start_data_table_row().
                   13757:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   13758:                     'checked="checked" /></td>'.
                   13759:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   13760:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   13761:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   13762:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   13763:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   13764:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   13765:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   13766:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   13767:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   13768:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   13769:                     &end_data_table_row();
1.1071    raeburn  13770:             }
1.987     raeburn  13771:         }
                   13772:     } else {
                   13773:         $modifyform = $pathchgtable;
                   13774:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   13775:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   13776:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   13777:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   13778:         }
                   13779:     }
                   13780:     if ($modifyform) {
1.1071    raeburn  13781:         if ($actionurl eq '/adm/dependencies') {
                   13782:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   13783:         }
1.987     raeburn  13784:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   13785:                '<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".
                   13786:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   13787:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   13788:                '</ol></p>'."\n".'<p>'.
                   13789:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   13790:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   13791:                &start_data_table()."\n".
                   13792:                &start_data_table_header_row().
                   13793:                '<th>'.&mt('Change?').'</th>'.
                   13794:                '<th>'.&mt('Current reference').'</th>'.
                   13795:                '<th>'.&mt('Required reference').'</th>'.
                   13796:                &end_data_table_header_row()."\n".
                   13797:                $modifyform.
                   13798:                &end_data_table().'<br />'."\n".$hiddenstate.
                   13799:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   13800:                '</form>'."\n";
                   13801:     }
                   13802:     return;
                   13803: }
                   13804: 
                   13805: sub modify_html_refs {
1.1123    raeburn  13806:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  13807:     my $container;
                   13808:     if ($context eq 'portfolio') {
                   13809:         $container = $env{'form.container'};
                   13810:     } elsif ($context eq 'coursedoc') {
                   13811:         $container = $env{'form.primaryurl'};
1.1071    raeburn  13812:     } elsif ($context eq 'manage_dependencies') {
                   13813:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   13814:         $container = "/$container";
1.1123    raeburn  13815:     } elsif ($context eq 'syllabus') {
                   13816:         $container = $url;
1.987     raeburn  13817:     } else {
1.1027    raeburn  13818:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  13819:     }
                   13820:     my (%allfiles,%codebase,$output,$content);
                   13821:     my @changes = &get_env_multiple('form.namechange');
1.1126    raeburn  13822:     unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071    raeburn  13823:         if (wantarray) {
                   13824:             return ('',0,0); 
                   13825:         } else {
                   13826:             return;
                   13827:         }
                   13828:     }
                   13829:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1123    raeburn  13830:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  13831:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   13832:             if (wantarray) {
                   13833:                 return ('',0,0);
                   13834:             } else {
                   13835:                 return;
                   13836:             }
                   13837:         } 
1.987     raeburn  13838:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  13839:         if ($content eq '-1') {
                   13840:             if (wantarray) {
                   13841:                 return ('',0,0);
                   13842:             } else {
                   13843:                 return;
                   13844:             }
                   13845:         }
1.987     raeburn  13846:     } else {
1.1071    raeburn  13847:         unless ($container =~ /^\Q$dir_root\E/) {
                   13848:             if (wantarray) {
                   13849:                 return ('',0,0);
                   13850:             } else {
                   13851:                 return;
                   13852:             }
                   13853:         } 
1.1317    raeburn  13854:         if (open(my $fh,'<',$container)) {
1.987     raeburn  13855:             $content = join('', <$fh>);
                   13856:             close($fh);
                   13857:         } else {
1.1071    raeburn  13858:             if (wantarray) {
                   13859:                 return ('',0,0);
                   13860:             } else {
                   13861:                 return;
                   13862:             }
1.987     raeburn  13863:         }
                   13864:     }
                   13865:     my ($count,$codebasecount) = (0,0);
                   13866:     my $mm = new File::MMagic;
                   13867:     my $mime_type = $mm->checktype_contents($content);
                   13868:     if ($mime_type eq 'text/html') {
                   13869:         my $parse_result = 
                   13870:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   13871:                                                     \%codebase,\$content);
                   13872:         if ($parse_result eq 'ok') {
                   13873:             foreach my $i (@changes) {
                   13874:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   13875:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   13876:                 if ($allfiles{$ref}) {
                   13877:                     my $newname =  $orig;
                   13878:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  13879:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  13880:                     if ($attrib_regexp =~ /:/) {
                   13881:                         $attrib_regexp =~ s/\:/|/g;
                   13882:                     }
                   13883:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   13884:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   13885:                         $count += $numchg;
1.1123    raeburn  13886:                         $allfiles{$newname} = $allfiles{$ref};
1.1148    raeburn  13887:                         delete($allfiles{$ref});
1.987     raeburn  13888:                     }
                   13889:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  13890:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  13891:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   13892:                         $codebasecount ++;
                   13893:                     }
                   13894:                 }
                   13895:             }
1.1123    raeburn  13896:             my $skiprewrites;
1.987     raeburn  13897:             if ($count || $codebasecount) {
                   13898:                 my $saveresult;
1.1071    raeburn  13899:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1123    raeburn  13900:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  13901:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   13902:                     if ($url eq $container) {
                   13903:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   13904:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   13905:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  13906:                                             $fname.'</span>').'</p>';
1.987     raeburn  13907:                     } else {
                   13908:                          $output = '<p class="LC_error">'.
                   13909:                                    &mt('Error: update failed for: [_1].',
                   13910:                                    '<span class="LC_filename">'.
                   13911:                                    $container.'</span>').'</p>';
                   13912:                     }
1.1123    raeburn  13913:                     if ($context eq 'syllabus') {
                   13914:                         unless ($saveresult eq 'ok') {
                   13915:                             $skiprewrites = 1;
                   13916:                         }
                   13917:                     }
1.987     raeburn  13918:                 } else {
1.1317    raeburn  13919:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  13920:                         print $fh $content;
                   13921:                         close($fh);
                   13922:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   13923:                                   $count,'<span class="LC_filename">'.
                   13924:                                   $container.'</span>').'</p>';
1.661     raeburn  13925:                     } else {
1.987     raeburn  13926:                          $output = '<p class="LC_error">'.
                   13927:                                    &mt('Error: could not update [_1].',
                   13928:                                    '<span class="LC_filename">'.
                   13929:                                    $container.'</span>').'</p>';
1.661     raeburn  13930:                     }
                   13931:                 }
                   13932:             }
1.1123    raeburn  13933:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   13934:                 my ($actionurl,$state);
                   13935:                 $actionurl = "/public/$udom/$uname/syllabus";
                   13936:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   13937:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   13938:                                               \%codebase,
                   13939:                                               {'context' => 'rewrites',
                   13940:                                                'ignore_remote_references' => 1,});
                   13941:                 if (ref($mapping) eq 'HASH') {
                   13942:                     my $rewrites = 0;
                   13943:                     foreach my $key (keys(%{$mapping})) {
                   13944:                         next if ($key =~ m{^https?://});
                   13945:                         my $ref = $mapping->{$key};
                   13946:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   13947:                         my $attrib;
                   13948:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   13949:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   13950:                         }
                   13951:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   13952:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   13953:                             $rewrites += $numchg;
                   13954:                         }
                   13955:                     }
                   13956:                     if ($rewrites) {
                   13957:                         my $saveresult; 
                   13958:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   13959:                         if ($url eq $container) {
                   13960:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   13961:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   13962:                                             $count,'<span class="LC_filename">'.
                   13963:                                             $fname.'</span>').'</p>';
                   13964:                         } else {
                   13965:                             $output .= '<p class="LC_error">'.
                   13966:                                        &mt('Error: could not update links in [_1].',
                   13967:                                        '<span class="LC_filename">'.
                   13968:                                        $container.'</span>').'</p>';
                   13969: 
                   13970:                         }
                   13971:                     }
                   13972:                 }
                   13973:             }
1.987     raeburn  13974:         } else {
                   13975:             &logthis('Failed to parse '.$container.
                   13976:                      ' to modify references: '.$parse_result);
1.661     raeburn  13977:         }
                   13978:     }
1.1071    raeburn  13979:     if (wantarray) {
                   13980:         return ($output,$count,$codebasecount);
                   13981:     } else {
                   13982:         return $output;
                   13983:     }
1.661     raeburn  13984: }
                   13985: 
                   13986: sub check_for_existing {
                   13987:     my ($path,$fname,$element) = @_;
                   13988:     my ($state,$msg);
                   13989:     if (-d $path.'/'.$fname) {
                   13990:         $state = 'exists';
                   13991:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   13992:     } elsif (-e $path.'/'.$fname) {
                   13993:         $state = 'exists';
                   13994:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   13995:     }
                   13996:     if ($state eq 'exists') {
                   13997:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   13998:     }
                   13999:     return ($state,$msg);
                   14000: }
                   14001: 
                   14002: sub check_for_upload {
                   14003:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   14004:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  14005:     my $filesize = length($env{'form.'.$element});
                   14006:     if (!$filesize) {
                   14007:         my $msg = '<span class="LC_error">'.
                   14008:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   14009:                       '<span class="LC_filename">'.$fname.'</span>',
                   14010:                       $filesize).'<br />'.
1.1007    raeburn  14011:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  14012:                   '</span>';
                   14013:         return ('zero_bytes',$msg);
                   14014:     }
                   14015:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  14016:     my $getpropath = 1;
1.1021    raeburn  14017:     my ($dirlistref,$listerror) =
                   14018:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  14019:     my $found_file = 0;
                   14020:     my $locked_file = 0;
1.991     raeburn  14021:     my @lockers;
                   14022:     my $navmap;
                   14023:     if ($env{'request.course.id'}) {
                   14024:         $navmap = Apache::lonnavmaps::navmap->new();
                   14025:     }
1.1021    raeburn  14026:     if (ref($dirlistref) eq 'ARRAY') {
                   14027:         foreach my $line (@{$dirlistref}) {
                   14028:             my ($file_name,$rest)=split(/\&/,$line,2);
                   14029:             if ($file_name eq $fname){
                   14030:                 $file_name = $path.$file_name;
                   14031:                 if ($group ne '') {
                   14032:                     $file_name = $group.$file_name;
                   14033:                 }
                   14034:                 $found_file = 1;
                   14035:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   14036:                     foreach my $lock (@lockers) {
                   14037:                         if (ref($lock) eq 'ARRAY') {
                   14038:                             my ($symb,$crsid) = @{$lock};
                   14039:                             if ($crsid eq $env{'request.course.id'}) {
                   14040:                                 if (ref($navmap)) {
                   14041:                                     my $res = $navmap->getBySymb($symb);
                   14042:                                     foreach my $part (@{$res->parts()}) { 
                   14043:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   14044:                                         unless (($slot_status == $res->RESERVED) ||
                   14045:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   14046:                                             $locked_file = 1;
                   14047:                                         }
1.991     raeburn  14048:                                     }
1.1021    raeburn  14049:                                 } else {
                   14050:                                     $locked_file = 1;
1.991     raeburn  14051:                                 }
                   14052:                             } else {
                   14053:                                 $locked_file = 1;
                   14054:                             }
                   14055:                         }
1.1021    raeburn  14056:                    }
                   14057:                 } else {
                   14058:                     my @info = split(/\&/,$rest);
                   14059:                     my $currsize = $info[6]/1000;
                   14060:                     if ($currsize < $filesize) {
                   14061:                         my $extra = $filesize - $currsize;
                   14062:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1179    bisitz   14063:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  14064:                                       &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   14065:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   14066:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   14067:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  14068:                             return ('will_exceed_quota',$msg);
                   14069:                         }
1.984     raeburn  14070:                     }
                   14071:                 }
1.661     raeburn  14072:             }
                   14073:         }
                   14074:     }
                   14075:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1179    bisitz   14076:         my $msg = '<p class="LC_warning">'.
                   14077:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184    raeburn  14078:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  14079:         return ('will_exceed_quota',$msg);
                   14080:     } elsif ($found_file) {
                   14081:         if ($locked_file) {
1.1179    bisitz   14082:             my $msg = '<p class="LC_warning">';
1.661     raeburn  14083:             $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   14084:             $msg .= '</p>';
1.661     raeburn  14085:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   14086:             return ('file_locked',$msg);
                   14087:         } else {
1.1179    bisitz   14088:             my $msg = '<p class="LC_error">';
1.984     raeburn  14089:             $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   14090:             $msg .= '</p>';
1.984     raeburn  14091:             return ('existingfile',$msg);
1.661     raeburn  14092:         }
                   14093:     }
                   14094: }
                   14095: 
1.987     raeburn  14096: sub check_for_traversal {
                   14097:     my ($path,$url,$toplevel) = @_;
                   14098:     my @parts=split(/\//,$path);
                   14099:     my $cleanpath;
                   14100:     my $fullpath = $url;
                   14101:     for (my $i=0;$i<@parts;$i++) {
                   14102:         next if ($parts[$i] eq '.');
                   14103:         if ($parts[$i] eq '..') {
                   14104:             $fullpath =~ s{([^/]+/)$}{};
                   14105:         } else {
                   14106:             $fullpath .= $parts[$i].'/';
                   14107:         }
                   14108:     }
                   14109:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   14110:         $cleanpath = $1;
                   14111:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   14112:         my $curr_toprel = $1;
                   14113:         my @parts = split(/\//,$curr_toprel);
                   14114:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   14115:         my @urlparts = split(/\//,$url_toprel);
                   14116:         my $doubledots;
                   14117:         my $startdiff = -1;
                   14118:         for (my $i=0; $i<@urlparts; $i++) {
                   14119:             if ($startdiff == -1) {
                   14120:                 unless ($urlparts[$i] eq $parts[$i]) {
                   14121:                     $startdiff = $i;
                   14122:                     $doubledots .= '../';
                   14123:                 }
                   14124:             } else {
                   14125:                 $doubledots .= '../';
                   14126:             }
                   14127:         }
                   14128:         if ($startdiff > -1) {
                   14129:             $cleanpath = $doubledots;
                   14130:             for (my $i=$startdiff; $i<@parts; $i++) {
                   14131:                 $cleanpath .= $parts[$i].'/';
                   14132:             }
                   14133:         }
                   14134:     }
                   14135:     $cleanpath =~ s{(/)$}{};
                   14136:     return $cleanpath;
                   14137: }
1.31      albertel 14138: 
1.1053    raeburn  14139: sub is_archive_file {
                   14140:     my ($mimetype) = @_;
                   14141:     if (($mimetype eq 'application/octet-stream') ||
                   14142:         ($mimetype eq 'application/x-stuffit') ||
                   14143:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   14144:         return 1;
                   14145:     }
                   14146:     return;
                   14147: }
                   14148: 
                   14149: sub decompress_form {
1.1065    raeburn  14150:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  14151:     my %lt = &Apache::lonlocal::texthash (
                   14152:         this => 'This file is an archive file.',
1.1067    raeburn  14153:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  14154:         itsc => 'Its contents are as follows:',
1.1053    raeburn  14155:         youm => 'You may wish to extract its contents.',
                   14156:         extr => 'Extract contents',
1.1067    raeburn  14157:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   14158:         proa => 'Process automatically?',
1.1053    raeburn  14159:         yes  => 'Yes',
                   14160:         no   => 'No',
1.1067    raeburn  14161:         fold => 'Title for folder containing movie',
                   14162:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  14163:     );
1.1065    raeburn  14164:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  14165:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  14166:     my $info = &list_archive_contents($fileloc,\@paths);
                   14167:     if (@paths) {
                   14168:         foreach my $path (@paths) {
                   14169:             $path =~ s{^/}{};
1.1067    raeburn  14170:             if ($path =~ m{^([^/]+)/$}) {
                   14171:                 $topdir = $1;
                   14172:             }
1.1065    raeburn  14173:             if ($path =~ m{^([^/]+)/}) {
                   14174:                 $toplevel{$1} = $path;
                   14175:             } else {
                   14176:                 $toplevel{$path} = $path;
                   14177:             }
                   14178:         }
                   14179:     }
1.1067    raeburn  14180:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164    raeburn  14181:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  14182:                         "$topdir/media/",
                   14183:                         "$topdir/media/$topdir.mp4",
                   14184:                         "$topdir/media/FirstFrame.png",
                   14185:                         "$topdir/media/player.swf",
                   14186:                         "$topdir/media/swfobject.js",
                   14187:                         "$topdir/media/expressInstall.swf");
1.1197    raeburn  14188:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164    raeburn  14189:                          "$topdir/$topdir.mp4",
                   14190:                          "$topdir/$topdir\_config.xml",
                   14191:                          "$topdir/$topdir\_controller.swf",
                   14192:                          "$topdir/$topdir\_embed.css",
                   14193:                          "$topdir/$topdir\_First_Frame.png",
                   14194:                          "$topdir/$topdir\_player.html",
                   14195:                          "$topdir/$topdir\_Thumbnails.png",
                   14196:                          "$topdir/playerProductInstall.swf",
                   14197:                          "$topdir/scripts/",
                   14198:                          "$topdir/scripts/config_xml.js",
                   14199:                          "$topdir/scripts/handlebars.js",
                   14200:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   14201:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   14202:                          "$topdir/scripts/modernizr.js",
                   14203:                          "$topdir/scripts/player-min.js",
                   14204:                          "$topdir/scripts/swfobject.js",
                   14205:                          "$topdir/skins/",
                   14206:                          "$topdir/skins/configuration_express.xml",
                   14207:                          "$topdir/skins/express_show/",
                   14208:                          "$topdir/skins/express_show/player-min.css",
                   14209:                          "$topdir/skins/express_show/spritesheet.png");
1.1197    raeburn  14210:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   14211:                          "$topdir/$topdir.mp4",
                   14212:                          "$topdir/$topdir\_config.xml",
                   14213:                          "$topdir/$topdir\_controller.swf",
                   14214:                          "$topdir/$topdir\_embed.css",
                   14215:                          "$topdir/$topdir\_First_Frame.png",
                   14216:                          "$topdir/$topdir\_player.html",
                   14217:                          "$topdir/$topdir\_Thumbnails.png",
                   14218:                          "$topdir/playerProductInstall.swf",
                   14219:                          "$topdir/scripts/",
                   14220:                          "$topdir/scripts/config_xml.js",
                   14221:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   14222:                          "$topdir/skins/",
                   14223:                          "$topdir/skins/configuration_express.xml",
                   14224:                          "$topdir/skins/express_show/",
                   14225:                          "$topdir/skins/express_show/spritesheet.min.css",
                   14226:                          "$topdir/skins/express_show/spritesheet.png",
                   14227:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164    raeburn  14228:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  14229:         if (@diffs == 0) {
1.1164    raeburn  14230:             $is_camtasia = 6;
                   14231:         } else {
1.1197    raeburn  14232:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164    raeburn  14233:             if (@diffs == 0) {
                   14234:                 $is_camtasia = 8;
1.1197    raeburn  14235:             } else {
                   14236:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   14237:                 if (@diffs == 0) {
                   14238:                     $is_camtasia = 8;
                   14239:                 }
1.1164    raeburn  14240:             }
1.1067    raeburn  14241:         }
                   14242:     }
                   14243:     my $output;
                   14244:     if ($is_camtasia) {
                   14245:         $output = <<"ENDCAM";
                   14246: <script type="text/javascript" language="Javascript">
                   14247: // <![CDATA[
                   14248: 
                   14249: function camtasiaToggle() {
                   14250:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   14251:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164    raeburn  14252:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  14253:                 document.getElementById('camtasia_titles').style.display='block';
                   14254:             } else {
                   14255:                 document.getElementById('camtasia_titles').style.display='none';
                   14256:             }
                   14257:         }
                   14258:     }
                   14259:     return;
                   14260: }
                   14261: 
                   14262: // ]]>
                   14263: </script>
                   14264: <p>$lt{'camt'}</p>
                   14265: ENDCAM
1.1065    raeburn  14266:     } else {
1.1067    raeburn  14267:         $output = '<p>'.$lt{'this'};
                   14268:         if ($info eq '') {
                   14269:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   14270:         } else {
                   14271:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   14272:                        '<div><pre>'.$info.'</pre></div>';
                   14273:         }
1.1065    raeburn  14274:     }
1.1067    raeburn  14275:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  14276:     my $duplicates;
                   14277:     my $num = 0;
                   14278:     if (ref($dirlist) eq 'ARRAY') {
                   14279:         foreach my $item (@{$dirlist}) {
                   14280:             if (ref($item) eq 'ARRAY') {
                   14281:                 if (exists($toplevel{$item->[0]})) {
                   14282:                     $duplicates .= 
                   14283:                         &start_data_table_row().
                   14284:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   14285:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   14286:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   14287:                         'value="1" />'.&mt('Yes').'</label>'.
                   14288:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   14289:                         '<td>'.$item->[0].'</td>';
                   14290:                     if ($item->[2]) {
                   14291:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   14292:                     } else {
                   14293:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   14294:                     }
                   14295:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   14296:                                    '<td>'.
                   14297:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   14298:                                    '</td>'.
                   14299:                                    &end_data_table_row();
                   14300:                     $num ++;
                   14301:                 }
                   14302:             }
                   14303:         }
                   14304:     }
                   14305:     my $itemcount;
                   14306:     if (@paths > 0) {
                   14307:         $itemcount = scalar(@paths);
                   14308:     } else {
                   14309:         $itemcount = 1;
                   14310:     }
1.1067    raeburn  14311:     if ($is_camtasia) {
                   14312:         $output .= $lt{'auto'}.'<br />'.
                   14313:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164    raeburn  14314:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  14315:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   14316:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   14317:                    $lt{'no'}.'</label></span><br />'.
                   14318:                    '<div id="camtasia_titles" style="display:block">'.
                   14319:                    &Apache::lonhtmlcommon::start_pick_box().
                   14320:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   14321:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   14322:                    &Apache::lonhtmlcommon::row_closure().
                   14323:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   14324:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   14325:                    &Apache::lonhtmlcommon::row_closure(1).
                   14326:                    &Apache::lonhtmlcommon::end_pick_box().
                   14327:                    '</div>';
                   14328:     }
1.1065    raeburn  14329:     $output .= 
                   14330:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  14331:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   14332:         "\n";
1.1065    raeburn  14333:     if ($duplicates ne '') {
                   14334:         $output .= '<p><span class="LC_warning">'.
                   14335:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   14336:                    &start_data_table().
                   14337:                    &start_data_table_header_row().
                   14338:                    '<th>'.&mt('Overwrite?').'</th>'.
                   14339:                    '<th>'.&mt('Name').'</th>'.
                   14340:                    '<th>'.&mt('Type').'</th>'.
                   14341:                    '<th>'.&mt('Size').'</th>'.
                   14342:                    '<th>'.&mt('Last modified').'</th>'.
                   14343:                    &end_data_table_header_row().
                   14344:                    $duplicates.
                   14345:                    &end_data_table().
                   14346:                    '</p>';
                   14347:     }
1.1067    raeburn  14348:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  14349:     if (ref($hiddenelements) eq 'HASH') {
                   14350:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   14351:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   14352:         }
                   14353:     }
                   14354:     $output .= <<"END";
1.1067    raeburn  14355: <br />
1.1053    raeburn  14356: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   14357: </form>
                   14358: $noextract
                   14359: END
                   14360:     return $output;
                   14361: }
                   14362: 
1.1065    raeburn  14363: sub decompression_utility {
                   14364:     my ($program) = @_;
                   14365:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   14366:     my $location;
                   14367:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   14368:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   14369:                          '/usr/sbin/') {
                   14370:             if (-x $dir.$program) {
                   14371:                 $location = $dir.$program;
                   14372:                 last;
                   14373:             }
                   14374:         }
                   14375:     }
                   14376:     return $location;
                   14377: }
                   14378: 
                   14379: sub list_archive_contents {
                   14380:     my ($file,$pathsref) = @_;
                   14381:     my (@cmd,$output);
                   14382:     my $needsregexp;
                   14383:     if ($file =~ /\.zip$/) {
                   14384:         @cmd = (&decompression_utility('unzip'),"-l");
                   14385:         $needsregexp = 1;
                   14386:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   14387:              ($file =~ /\.tgz$/)) {
                   14388:         @cmd = (&decompression_utility('tar'),"-ztf");
                   14389:     } elsif ($file =~ /\.tar\.bz2$/) {
                   14390:         @cmd = (&decompression_utility('tar'),"-jtf");
                   14391:     } elsif ($file =~ m|\.tar$|) {
                   14392:         @cmd = (&decompression_utility('tar'),"-tf");
                   14393:     }
                   14394:     if (@cmd) {
                   14395:         undef($!);
                   14396:         undef($@);
                   14397:         if (open(my $fh,"-|", @cmd, $file)) {
                   14398:             while (my $line = <$fh>) {
                   14399:                 $output .= $line;
                   14400:                 chomp($line);
                   14401:                 my $item;
                   14402:                 if ($needsregexp) {
                   14403:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   14404:                 } else {
                   14405:                     $item = $line;
                   14406:                 }
                   14407:                 if ($item ne '') {
                   14408:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   14409:                         push(@{$pathsref},$item);
                   14410:                     } 
                   14411:                 }
                   14412:             }
                   14413:             close($fh);
                   14414:         }
                   14415:     }
                   14416:     return $output;
                   14417: }
                   14418: 
1.1053    raeburn  14419: sub decompress_uploaded_file {
                   14420:     my ($file,$dir) = @_;
                   14421:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   14422:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   14423:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   14424:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   14425:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   14426:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   14427:     my $decompressed = $env{'cgi.decompressed'};
                   14428:     &Apache::lonnet::delenv('cgi.file');
                   14429:     &Apache::lonnet::delenv('cgi.dir');
                   14430:     &Apache::lonnet::delenv('cgi.decompressed');
                   14431:     return ($decompressed,$result);
                   14432: }
                   14433: 
1.1055    raeburn  14434: sub process_decompression {
                   14435:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292    raeburn  14436:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   14437:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14438:                &mt('Unexpected file path.').'</p>'."\n";
                   14439:     }
                   14440:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   14441:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14442:                &mt('Unexpected course context.').'</p>'."\n";
                   14443:     }
1.1293    raeburn  14444:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292    raeburn  14445:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14446:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   14447:     }
1.1055    raeburn  14448:     my ($dir,$error,$warning,$output);
1.1180    raeburn  14449:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120    bisitz   14450:         $error = &mt('Filename not a supported archive file type.').
                   14451:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  14452:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   14453:     } else {
                   14454:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   14455:         if ($docuhome eq 'no_host') {
                   14456:             $error = &mt('Could not determine home server for course.');
                   14457:         } else {
                   14458:             my @ids=&Apache::lonnet::current_machine_ids();
                   14459:             my $currdir = "$dir_root/$destination";
                   14460:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   14461:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   14462:                        "$dir_root/$destination";
                   14463:             } else {
                   14464:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   14465:                        "$dir_root/$docudom/$docuname/$destination";
                   14466:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   14467:                     $error = &mt('Archive file not found.');
                   14468:                 }
                   14469:             }
1.1065    raeburn  14470:             my (@to_overwrite,@to_skip);
                   14471:             if ($env{'form.archive_overwrite_total'} > 0) {
                   14472:                 my $total = $env{'form.archive_overwrite_total'};
                   14473:                 for (my $i=0; $i<$total; $i++) {
                   14474:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   14475:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   14476:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   14477:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   14478:                     }
                   14479:                 }
                   14480:             }
                   14481:             my $numskip = scalar(@to_skip);
1.1292    raeburn  14482:             my $numoverwrite = scalar(@to_overwrite);
                   14483:             if (($numskip) && (!$numoverwrite)) { 
1.1065    raeburn  14484:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   14485:             } elsif ($dir eq '') {
1.1055    raeburn  14486:                 $error = &mt('Directory containing archive file unavailable.');
                   14487:             } elsif (!$error) {
1.1065    raeburn  14488:                 my ($decompressed,$display);
1.1292    raeburn  14489:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  14490:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   14491:                     mkdir("$dir/$tempdir",0755);
1.1292    raeburn  14492:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   14493:                         ($decompressed,$display) = 
                   14494:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   14495:                         foreach my $item (@to_skip) {
                   14496:                             if (($item ne '') && ($item !~ /\.\./)) {
                   14497:                                 if (-f "$dir/$tempdir/$item") { 
                   14498:                                     unlink("$dir/$tempdir/$item");
                   14499:                                 } elsif (-d "$dir/$tempdir/$item") {
1.1300    raeburn  14500:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292    raeburn  14501:                                 }
                   14502:                             }
                   14503:                         }
                   14504:                         foreach my $item (@to_overwrite) {
                   14505:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   14506:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   14507:                                     if (-f "$dir/$item") {
                   14508:                                         unlink("$dir/$item");
                   14509:                                     } elsif (-d "$dir/$item") {
1.1300    raeburn  14510:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292    raeburn  14511:                                     }
                   14512:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   14513:                                 }
1.1065    raeburn  14514:                             }
                   14515:                         }
1.1292    raeburn  14516:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300    raeburn  14517:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292    raeburn  14518:                         }
1.1065    raeburn  14519:                     }
                   14520:                 } else {
                   14521:                     ($decompressed,$display) = 
                   14522:                         &decompress_uploaded_file($file,$dir);
                   14523:                 }
1.1055    raeburn  14524:                 if ($decompressed eq 'ok') {
1.1065    raeburn  14525:                     $output = '<p class="LC_info">'.
                   14526:                               &mt('Files extracted successfully from archive.').
                   14527:                               '</p>'."\n";
1.1055    raeburn  14528:                     my ($warning,$result,@contents);
                   14529:                     my ($newdirlistref,$newlisterror) =
                   14530:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   14531:                                                  $docuname,1);
                   14532:                     my (%is_dir,%changes,@newitems);
                   14533:                     my $dirptr = 16384;
1.1065    raeburn  14534:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  14535:                         foreach my $dir_line (@{$newdirlistref}) {
                   14536:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292    raeburn  14537:                             unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055    raeburn  14538:                                 push(@newitems,$item);
                   14539:                                 if ($dirptr&$testdir) {
                   14540:                                     $is_dir{$item} = 1;
                   14541:                                 }
                   14542:                                 $changes{$item} = 1;
                   14543:                             }
                   14544:                         }
                   14545:                     }
                   14546:                     if (keys(%changes) > 0) {
                   14547:                         foreach my $item (sort(@newitems)) {
                   14548:                             if ($changes{$item}) {
                   14549:                                 push(@contents,$item);
                   14550:                             }
                   14551:                         }
                   14552:                     }
                   14553:                     if (@contents > 0) {
1.1067    raeburn  14554:                         my $wantform;
                   14555:                         unless ($env{'form.autoextract_camtasia'}) {
                   14556:                             $wantform = 1;
                   14557:                         }
1.1056    raeburn  14558:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  14559:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   14560:                                                                 $currdir,\%is_dir,
                   14561:                                                                 \%children,\%parent,
1.1056    raeburn  14562:                                                                 \@contents,\%dirorder,
                   14563:                                                                 \%titles,$wantform);
1.1055    raeburn  14564:                         if ($datatable ne '') {
                   14565:                             $output .= &archive_options_form('decompressed',$datatable,
                   14566:                                                              $count,$hiddenelem);
1.1065    raeburn  14567:                             my $startcount = 6;
1.1055    raeburn  14568:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  14569:                                                            \%titles,\%children);
1.1055    raeburn  14570:                         }
1.1067    raeburn  14571:                         if ($env{'form.autoextract_camtasia'}) {
1.1164    raeburn  14572:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  14573:                             my %displayed;
                   14574:                             my $total = 1;
                   14575:                             $env{'form.archive_directory'} = [];
                   14576:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   14577:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   14578:                                 $path =~ s{/$}{};
                   14579:                                 my $item;
                   14580:                                 if ($path ne '') {
                   14581:                                     $item = "$path/$titles{$i}";
                   14582:                                 } else {
                   14583:                                     $item = $titles{$i};
                   14584:                                 }
                   14585:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   14586:                                 if ($item eq $contents[0]) {
                   14587:                                     push(@{$env{'form.archive_directory'}},$i);
                   14588:                                     $env{'form.archive_'.$i} = 'display';
                   14589:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   14590:                                     $displayed{'folder'} = $i;
1.1164    raeburn  14591:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   14592:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) { 
1.1067    raeburn  14593:                                     $env{'form.archive_'.$i} = 'display';
                   14594:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   14595:                                     $displayed{'web'} = $i;
                   14596:                                 } else {
1.1164    raeburn  14597:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   14598:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   14599:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  14600:                                         push(@{$env{'form.archive_directory'}},$i);
                   14601:                                     }
                   14602:                                     $env{'form.archive_'.$i} = 'dependency';
                   14603:                                 }
                   14604:                                 $total ++;
                   14605:                             }
                   14606:                             for (my $i=1; $i<$total; $i++) {
                   14607:                                 next if ($i == $displayed{'web'});
                   14608:                                 next if ($i == $displayed{'folder'});
                   14609:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   14610:                             }
                   14611:                             $env{'form.phase'} = 'decompress_cleanup';
                   14612:                             $env{'form.archivedelete'} = 1;
                   14613:                             $env{'form.archive_count'} = $total-1;
                   14614:                             $output .=
                   14615:                                 &process_extracted_files('coursedocs',$docudom,
                   14616:                                                          $docuname,$destination,
                   14617:                                                          $dir_root,$hiddenelem);
                   14618:                         }
1.1055    raeburn  14619:                     } else {
                   14620:                         $warning = &mt('No new items extracted from archive file.');
                   14621:                     }
                   14622:                 } else {
                   14623:                     $output = $display;
                   14624:                     $error = &mt('An error occurred during extraction from the archive file.');
                   14625:                 }
                   14626:             }
                   14627:         }
                   14628:     }
                   14629:     if ($error) {
                   14630:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14631:                    $error.'</p>'."\n";
                   14632:     }
                   14633:     if ($warning) {
                   14634:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   14635:     }
                   14636:     return $output;
                   14637: }
                   14638: 
                   14639: sub get_extracted {
1.1056    raeburn  14640:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   14641:         $titles,$wantform) = @_;
1.1055    raeburn  14642:     my $count = 0;
                   14643:     my $depth = 0;
                   14644:     my $datatable;
1.1056    raeburn  14645:     my @hierarchy;
1.1055    raeburn  14646:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  14647:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   14648:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  14649:     foreach my $item (@{$contents}) {
                   14650:         $count ++;
1.1056    raeburn  14651:         @{$dirorder->{$count}} = @hierarchy;
                   14652:         $titles->{$count} = $item;
1.1055    raeburn  14653:         &archive_hierarchy($depth,$count,$parent,$children);
                   14654:         if ($wantform) {
                   14655:             $datatable .= &archive_row($is_dir->{$item},$item,
                   14656:                                        $currdir,$depth,$count);
                   14657:         }
                   14658:         if ($is_dir->{$item}) {
                   14659:             $depth ++;
1.1056    raeburn  14660:             push(@hierarchy,$count);
                   14661:             $parent->{$depth} = $count;
1.1055    raeburn  14662:             $datatable .=
                   14663:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  14664:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   14665:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  14666:             $depth --;
1.1056    raeburn  14667:             pop(@hierarchy);
1.1055    raeburn  14668:         }
                   14669:     }
                   14670:     return ($count,$datatable);
                   14671: }
                   14672: 
                   14673: sub recurse_extracted_archive {
1.1056    raeburn  14674:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   14675:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  14676:     my $result='';
1.1056    raeburn  14677:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   14678:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   14679:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  14680:         return $result;
                   14681:     }
                   14682:     my $dirptr = 16384;
                   14683:     my ($newdirlistref,$newlisterror) =
                   14684:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   14685:     if (ref($newdirlistref) eq 'ARRAY') {
                   14686:         foreach my $dir_line (@{$newdirlistref}) {
                   14687:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   14688:             unless ($item =~ /^\.+$/) {
                   14689:                 $$count ++;
1.1056    raeburn  14690:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   14691:                 $titles->{$$count} = $item;
1.1055    raeburn  14692:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  14693: 
1.1055    raeburn  14694:                 my $is_dir;
                   14695:                 if ($dirptr&$testdir) {
                   14696:                     $is_dir = 1;
                   14697:                 }
                   14698:                 if ($wantform) {
                   14699:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   14700:                 }
                   14701:                 if ($is_dir) {
                   14702:                     $$depth ++;
1.1056    raeburn  14703:                     push(@{$hierarchy},$$count);
                   14704:                     $parent->{$$depth} = $$count;
1.1055    raeburn  14705:                     $result .=
                   14706:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   14707:                                                    $docuname,$depth,$count,
1.1056    raeburn  14708:                                                    $hierarchy,$dirorder,$children,
                   14709:                                                    $parent,$titles,$wantform);
1.1055    raeburn  14710:                     $$depth --;
1.1056    raeburn  14711:                     pop(@{$hierarchy});
1.1055    raeburn  14712:                 }
                   14713:             }
                   14714:         }
                   14715:     }
                   14716:     return $result;
                   14717: }
                   14718: 
                   14719: sub archive_hierarchy {
                   14720:     my ($depth,$count,$parent,$children) =@_;
                   14721:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   14722:         if (exists($parent->{$depth})) {
                   14723:              $children->{$parent->{$depth}} .= $count.':';
                   14724:         }
                   14725:     }
                   14726:     return;
                   14727: }
                   14728: 
                   14729: sub archive_row {
                   14730:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   14731:     my ($name) = ($item =~ m{([^/]+)$});
                   14732:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  14733:                                        'display'    => 'Add as file',
1.1055    raeburn  14734:                                        'dependency' => 'Include as dependency',
                   14735:                                        'discard'    => 'Discard',
                   14736:                                       );
                   14737:     if ($is_dir) {
1.1059    raeburn  14738:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  14739:     }
1.1056    raeburn  14740:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   14741:     my $offset = 0;
1.1055    raeburn  14742:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  14743:         $offset ++;
1.1065    raeburn  14744:         if ($action ne 'display') {
                   14745:             $offset ++;
                   14746:         }  
1.1055    raeburn  14747:         $output .= '<td><span class="LC_nobreak">'.
                   14748:                    '<label><input type="radio" name="archive_'.$count.
                   14749:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   14750:         my $text = $choices{$action};
                   14751:         if ($is_dir) {
                   14752:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   14753:             if ($action eq 'display') {
1.1059    raeburn  14754:                 $text = &mt('Add as folder');
1.1055    raeburn  14755:             }
1.1056    raeburn  14756:         } else {
                   14757:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   14758: 
                   14759:         }
                   14760:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   14761:         if ($action eq 'dependency') {
                   14762:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   14763:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   14764:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   14765:                        '<option value=""></option>'."\n".
                   14766:                        '</select>'."\n".
                   14767:                        '</div>';
1.1059    raeburn  14768:         } elsif ($action eq 'display') {
                   14769:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   14770:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   14771:                        '</div>';
1.1055    raeburn  14772:         }
1.1056    raeburn  14773:         $output .= '</td>';
1.1055    raeburn  14774:     }
                   14775:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   14776:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   14777:     for (my $i=0; $i<$depth; $i++) {
                   14778:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   14779:     }
                   14780:     if ($is_dir) {
                   14781:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   14782:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   14783:     } else {
                   14784:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   14785:     }
                   14786:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   14787:                &end_data_table_row();
                   14788:     return $output;
                   14789: }
                   14790: 
                   14791: sub archive_options_form {
1.1065    raeburn  14792:     my ($form,$display,$count,$hiddenelem) = @_;
                   14793:     my %lt = &Apache::lonlocal::texthash(
                   14794:                perm => 'Permanently remove archive file?',
                   14795:                hows => 'How should each extracted item be incorporated in the course?',
                   14796:                cont => 'Content actions for all',
                   14797:                addf => 'Add as folder/file',
                   14798:                incd => 'Include as dependency for a displayed file',
                   14799:                disc => 'Discard',
                   14800:                no   => 'No',
                   14801:                yes  => 'Yes',
                   14802:                save => 'Save',
                   14803:     );
                   14804:     my $output = <<"END";
                   14805: <form name="$form" method="post" action="">
                   14806: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   14807: <label>
                   14808:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   14809: </label>
                   14810: &nbsp;
                   14811: <label>
                   14812:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   14813: </span>
                   14814: </p>
                   14815: <input type="hidden" name="phase" value="decompress_cleanup" />
                   14816: <br />$lt{'hows'}
                   14817: <div class="LC_columnSection">
                   14818:   <fieldset>
                   14819:     <legend>$lt{'cont'}</legend>
                   14820:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   14821:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   14822:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   14823:   </fieldset>
                   14824: </div>
                   14825: END
                   14826:     return $output.
1.1055    raeburn  14827:            &start_data_table()."\n".
1.1065    raeburn  14828:            $display."\n".
1.1055    raeburn  14829:            &end_data_table()."\n".
                   14830:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   14831:            $hiddenelem.
1.1065    raeburn  14832:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  14833:            '</form>';
                   14834: }
                   14835: 
                   14836: sub archive_javascript {
1.1056    raeburn  14837:     my ($startcount,$numitems,$titles,$children) = @_;
                   14838:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  14839:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  14840:     my $scripttag = <<START;
                   14841: <script type="text/javascript">
                   14842: // <![CDATA[
                   14843: 
                   14844: function checkAll(form,prefix) {
                   14845:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   14846:     for (var i=0; i < form.elements.length; i++) {
                   14847:         var id = form.elements[i].id;
                   14848:         if ((id != '') && (id != undefined)) {
                   14849:             if (idstr.test(id)) {
                   14850:                 if (form.elements[i].type == 'radio') {
                   14851:                     form.elements[i].checked = true;
1.1056    raeburn  14852:                     var nostart = i-$startcount;
1.1059    raeburn  14853:                     var offset = nostart%7;
                   14854:                     var count = (nostart-offset)/7;    
1.1056    raeburn  14855:                     dependencyCheck(form,count,offset);
1.1055    raeburn  14856:                 }
                   14857:             }
                   14858:         }
                   14859:     }
                   14860: }
                   14861: 
                   14862: function propagateCheck(form,count) {
                   14863:     if (count > 0) {
1.1059    raeburn  14864:         var startelement = $startcount + ((count-1) * 7);
                   14865:         for (var j=1; j<6; j++) {
                   14866:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  14867:                 var item = startelement + j; 
                   14868:                 if (form.elements[item].type == 'radio') {
                   14869:                     if (form.elements[item].checked) {
                   14870:                         containerCheck(form,count,j);
                   14871:                         break;
                   14872:                     }
1.1055    raeburn  14873:                 }
                   14874:             }
                   14875:         }
                   14876:     }
                   14877: }
                   14878: 
                   14879: numitems = $numitems
1.1056    raeburn  14880: var titles = new Array(numitems);
                   14881: var parents = new Array(numitems);
1.1055    raeburn  14882: for (var i=0; i<numitems; i++) {
1.1056    raeburn  14883:     parents[i] = new Array;
1.1055    raeburn  14884: }
1.1059    raeburn  14885: var maintitle = '$maintitle';
1.1055    raeburn  14886: 
                   14887: START
                   14888: 
1.1056    raeburn  14889:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   14890:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  14891:         for (my $i=0; $i<@contents; $i ++) {
                   14892:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   14893:         }
                   14894:     }
                   14895: 
1.1056    raeburn  14896:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   14897:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   14898:     }
                   14899: 
1.1055    raeburn  14900:     $scripttag .= <<END;
                   14901: 
                   14902: function containerCheck(form,count,offset) {
                   14903:     if (count > 0) {
1.1056    raeburn  14904:         dependencyCheck(form,count,offset);
1.1059    raeburn  14905:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  14906:         form.elements[item].checked = true;
                   14907:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   14908:             if (parents[count].length > 0) {
                   14909:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  14910:                     containerCheck(form,parents[count][j],offset);
                   14911:                 }
                   14912:             }
                   14913:         }
                   14914:     }
                   14915: }
                   14916: 
                   14917: function dependencyCheck(form,count,offset) {
                   14918:     if (count > 0) {
1.1059    raeburn  14919:         var chosen = (offset+$startcount)+7*(count-1);
                   14920:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  14921:         var currtype = form.elements[depitem].type;
                   14922:         if (form.elements[chosen].value == 'dependency') {
                   14923:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   14924:             form.elements[depitem].options.length = 0;
                   14925:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085    raeburn  14926:             for (var i=1; i<=numitems; i++) {
                   14927:                 if (i == count) {
                   14928:                     continue;
                   14929:                 }
1.1059    raeburn  14930:                 var startelement = $startcount + (i-1) * 7;
                   14931:                 for (var j=1; j<6; j++) {
                   14932:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  14933:                         var item = startelement + j;
                   14934:                         if (form.elements[item].type == 'radio') {
                   14935:                             if (form.elements[item].checked) {
                   14936:                                 if (form.elements[item].value == 'display') {
                   14937:                                     var n = form.elements[depitem].options.length;
                   14938:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   14939:                                 }
                   14940:                             }
                   14941:                         }
                   14942:                     }
                   14943:                 }
                   14944:             }
                   14945:         } else {
                   14946:             document.getElementById('arc_depon_'+count).style.display='none';
                   14947:             form.elements[depitem].options.length = 0;
                   14948:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   14949:         }
1.1059    raeburn  14950:         titleCheck(form,count,offset);
1.1056    raeburn  14951:     }
                   14952: }
                   14953: 
                   14954: function propagateSelect(form,count,offset) {
                   14955:     if (count > 0) {
1.1065    raeburn  14956:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  14957:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   14958:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   14959:             if (parents[count].length > 0) {
                   14960:                 for (var j=0; j<parents[count].length; j++) {
                   14961:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  14962:                 }
                   14963:             }
                   14964:         }
                   14965:     }
                   14966: }
1.1056    raeburn  14967: 
                   14968: function containerSelect(form,count,offset,picked) {
                   14969:     if (count > 0) {
1.1065    raeburn  14970:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  14971:         if (form.elements[item].type == 'radio') {
                   14972:             if (form.elements[item].value == 'dependency') {
                   14973:                 if (form.elements[item+1].type == 'select-one') {
                   14974:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   14975:                         if (form.elements[item+1].options[i].value == picked) {
                   14976:                             form.elements[item+1].selectedIndex = i;
                   14977:                             break;
                   14978:                         }
                   14979:                     }
                   14980:                 }
                   14981:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   14982:                     if (parents[count].length > 0) {
                   14983:                         for (var j=0; j<parents[count].length; j++) {
                   14984:                             containerSelect(form,parents[count][j],offset,picked);
                   14985:                         }
                   14986:                     }
                   14987:                 }
                   14988:             }
                   14989:         }
                   14990:     }
                   14991: }
                   14992: 
1.1059    raeburn  14993: function titleCheck(form,count,offset) {
                   14994:     if (count > 0) {
                   14995:         var chosen = (offset+$startcount)+7*(count-1);
                   14996:         var depitem = $startcount + ((count-1) * 7) + 2;
                   14997:         var currtype = form.elements[depitem].type;
                   14998:         if (form.elements[chosen].value == 'display') {
                   14999:             document.getElementById('arc_title_'+count).style.display='block';
                   15000:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   15001:                 document.getElementById('archive_title_'+count).value=maintitle;
                   15002:             }
                   15003:         } else {
                   15004:             document.getElementById('arc_title_'+count).style.display='none';
                   15005:             if (currtype == 'text') { 
                   15006:                 document.getElementById('archive_title_'+count).value='';
                   15007:             }
                   15008:         }
                   15009:     }
                   15010:     return;
                   15011: }
                   15012: 
1.1055    raeburn  15013: // ]]>
                   15014: </script>
                   15015: END
                   15016:     return $scripttag;
                   15017: }
                   15018: 
                   15019: sub process_extracted_files {
1.1067    raeburn  15020:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  15021:     my $numitems = $env{'form.archive_count'};
1.1294    raeburn  15022:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  15023:     my @ids=&Apache::lonnet::current_machine_ids();
                   15024:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  15025:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  15026:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   15027:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   15028:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   15029:         $pathtocheck = "$dir_root/$destination";
                   15030:         $dir = $dir_root;
                   15031:         $ishome = 1;
                   15032:     } else {
                   15033:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   15034:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294    raeburn  15035:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  15036:     }
                   15037:     my $currdir = "$dir_root/$destination";
                   15038:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   15039:     if ($env{'form.folderpath'}) {
                   15040:         my @items = split('&',$env{'form.folderpath'});
                   15041:         $folders{'0'} = $items[-2];
1.1099    raeburn  15042:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   15043:             $containers{'0'}='page';
                   15044:         } else {  
                   15045:             $containers{'0'}='sequence';
                   15046:         }
1.1055    raeburn  15047:     }
                   15048:     my @archdirs = &get_env_multiple('form.archive_directory');
                   15049:     if ($numitems) {
                   15050:         for (my $i=1; $i<=$numitems; $i++) {
                   15051:             my $path = $env{'form.archive_content_'.$i};
                   15052:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   15053:                 my $item = $1;
                   15054:                 $toplevelitems{$item} = $i;
                   15055:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   15056:                     $is_dir{$item} = 1;
                   15057:                 }
                   15058:             }
                   15059:         }
                   15060:     }
1.1067    raeburn  15061:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  15062:     if (keys(%toplevelitems) > 0) {
                   15063:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  15064:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   15065:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  15066:     }
1.1066    raeburn  15067:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  15068:     if ($numitems) {
                   15069:         for (my $i=1; $i<=$numitems; $i++) {
1.1086    raeburn  15070:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  15071:             my $path = $env{'form.archive_content_'.$i};
                   15072:             if ($path =~ /^\Q$pathtocheck\E/) {
                   15073:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   15074:                     if ($prefix ne '' && $path ne '') {
                   15075:                         if (-e $prefix.$path) {
1.1066    raeburn  15076:                             if ((@archdirs > 0) && 
                   15077:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   15078:                                 $todeletedir{$prefix.$path} = 1;
                   15079:                             } else {
                   15080:                                 $todelete{$prefix.$path} = 1;
                   15081:                             }
1.1055    raeburn  15082:                         }
                   15083:                     }
                   15084:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  15085:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  15086:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  15087:                     $docstitle = $env{'form.archive_title_'.$i};
                   15088:                     if ($docstitle eq '') {
                   15089:                         $docstitle = $title;
                   15090:                     }
1.1055    raeburn  15091:                     $outer = 0;
1.1056    raeburn  15092:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   15093:                         if (@{$dirorder{$i}} > 0) {
                   15094:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  15095:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   15096:                                     $outer = $item;
                   15097:                                     last;
                   15098:                                 }
                   15099:                             }
                   15100:                         }
                   15101:                     }
                   15102:                     my ($errtext,$fatal) = 
                   15103:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   15104:                                                '/'.$folders{$outer}.'.'.
                   15105:                                                $containers{$outer});
                   15106:                     next if ($fatal);
                   15107:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   15108:                         if ($context eq 'coursedocs') {
1.1056    raeburn  15109:                             $mapinner{$i} = time;
1.1055    raeburn  15110:                             $folders{$i} = 'default_'.$mapinner{$i};
                   15111:                             $containers{$i} = 'sequence';
                   15112:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   15113:                                       $folders{$i}.'.'.$containers{$i};
                   15114:                             my $newidx = &LONCAPA::map::getresidx();
                   15115:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  15116:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  15117:                             push(@LONCAPA::map::order,$newidx);
                   15118:                             my ($outtext,$errtext) =
                   15119:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   15120:                                                         $docuname.'/'.$folders{$outer}.
1.1087    raeburn  15121:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  15122:                             $newseqid{$i} = $newidx;
1.1067    raeburn  15123:                             unless ($errtext) {
1.1294    raeburn  15124:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   15125:                                                        &HTML::Entities::encode($docstitle,'<>&"')).
                   15126:                                             '</li>'."\n";
1.1067    raeburn  15127:                             }
1.1055    raeburn  15128:                         }
                   15129:                     } else {
                   15130:                         if ($context eq 'coursedocs') {
                   15131:                             my $newidx=&LONCAPA::map::getresidx();
                   15132:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   15133:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   15134:                                       $title;
1.1392    raeburn  15135:                             if (($outer !~ /\D/) &&
                   15136:                                 (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
                   15137:                                 ($newidx !~ /\D/)) {
1.1294    raeburn  15138:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   15139:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
                   15140:                                 }
                   15141:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   15142:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   15143:                                 }
                   15144:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   15145:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   15146:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   15147:                                         unless ($ishome) {
                   15148:                                             my $fetch = "$newdest{$i}/$title";
                   15149:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   15150:                                             $prompttofetch{$fetch} = 1;
                   15151:                                         }
1.1292    raeburn  15152:                                     }
1.1067    raeburn  15153:                                 }
1.1294    raeburn  15154:                                 $LONCAPA::map::resources[$newidx]=
                   15155:                                     $docstitle.':'.$url.':false:normal:res';
                   15156:                                 push(@LONCAPA::map::order, $newidx);
                   15157:                                 my ($outtext,$errtext)=
                   15158:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   15159:                                                             $docuname.'/'.$folders{$outer}.
                   15160:                                                             '.'.$containers{$outer},1,1);
                   15161:                                 unless ($errtext) {
                   15162:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   15163:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   15164:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   15165:                                                    '</li>'."\n";
                   15166:                                     }
1.1067    raeburn  15167:                                 }
1.1294    raeburn  15168:                             } else {
                   15169:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   15170:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296    raeburn  15171:                             }
1.1055    raeburn  15172:                         }
                   15173:                     }
1.1086    raeburn  15174:                 }
                   15175:             } else {
1.1294    raeburn  15176:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   15177:                                 &HTML::Entities::encode($path,'<>&"')).'<br />'; 
1.1086    raeburn  15178:             }
                   15179:         }
                   15180:         for (my $i=1; $i<=$numitems; $i++) {
                   15181:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   15182:             my $path = $env{'form.archive_content_'.$i};
                   15183:             if ($path =~ /^\Q$pathtocheck\E/) {
                   15184:                 my ($title) = ($path =~ m{/([^/]+)$});
                   15185:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   15186:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   15187:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   15188:                         my ($itemidx,$fullpath,$relpath);
                   15189:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   15190:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  15191:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086    raeburn  15192:                                 if ($dirorder{$i}->[$j] eq $container) {
                   15193:                                     $itemidx = $j;
1.1056    raeburn  15194:                                 }
                   15195:                             }
1.1086    raeburn  15196:                         }
                   15197:                         if ($itemidx eq '') {
                   15198:                             $itemidx =  0;
                   15199:                         } 
                   15200:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   15201:                             if ($mapinner{$referrer{$i}}) {
                   15202:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   15203:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   15204:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   15205:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   15206:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   15207:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   15208:                                             if (!-e $fullpath) {
                   15209:                                                 mkdir($fullpath,0755);
1.1056    raeburn  15210:                                             }
                   15211:                                         }
1.1086    raeburn  15212:                                     } else {
                   15213:                                         last;
1.1056    raeburn  15214:                                     }
1.1086    raeburn  15215:                                 }
                   15216:                             }
                   15217:                         } elsif ($newdest{$referrer{$i}}) {
                   15218:                             $fullpath = $newdest{$referrer{$i}};
                   15219:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   15220:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   15221:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   15222:                                     last;
                   15223:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   15224:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   15225:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   15226:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   15227:                                         if (!-e $fullpath) {
                   15228:                                             mkdir($fullpath,0755);
1.1056    raeburn  15229:                                         }
                   15230:                                     }
1.1086    raeburn  15231:                                 } else {
                   15232:                                     last;
1.1056    raeburn  15233:                                 }
1.1055    raeburn  15234:                             }
                   15235:                         }
1.1086    raeburn  15236:                         if ($fullpath ne '') {
                   15237:                             if (-e "$prefix$path") {
1.1292    raeburn  15238:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   15239:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   15240:                                 }
1.1086    raeburn  15241:                             }
                   15242:                             if (-e "$fullpath/$title") {
                   15243:                                 my $showpath;
                   15244:                                 if ($relpath ne '') {
                   15245:                                     $showpath = "$relpath/$title";
                   15246:                                 } else {
                   15247:                                     $showpath = "/$title";
                   15248:                                 } 
1.1294    raeburn  15249:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   15250:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   15251:                                            '</li>'."\n";
1.1292    raeburn  15252:                                 unless ($ishome) {
                   15253:                                     my $fetch = "$fullpath/$title";
                   15254:                                     $fetch =~ s/^\Q$prefix$dir\E//; 
                   15255:                                     $prompttofetch{$fetch} = 1;
                   15256:                                 }
1.1086    raeburn  15257:                             }
                   15258:                         }
1.1055    raeburn  15259:                     }
1.1086    raeburn  15260:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   15261:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294    raeburn  15262:                                     &HTML::Entities::encode($path,'<>&"'),
                   15263:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   15264:                                 '<br />';
1.1055    raeburn  15265:                 }
                   15266:             } else {
1.1294    raeburn  15267:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296    raeburn  15268:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  15269:             }
                   15270:         }
                   15271:         if (keys(%todelete)) {
                   15272:             foreach my $key (keys(%todelete)) {
                   15273:                 unlink($key);
1.1066    raeburn  15274:             }
                   15275:         }
                   15276:         if (keys(%todeletedir)) {
                   15277:             foreach my $key (keys(%todeletedir)) {
                   15278:                 rmdir($key);
                   15279:             }
                   15280:         }
                   15281:         foreach my $dir (sort(keys(%is_dir))) {
                   15282:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   15283:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  15284:             }
                   15285:         }
1.1067    raeburn  15286:         if ($result ne '') {
                   15287:             $output .= '<ul>'."\n".
                   15288:                        $result."\n".
                   15289:                        '</ul>';
                   15290:         }
                   15291:         unless ($ishome) {
                   15292:             my $replicationfail;
                   15293:             foreach my $item (keys(%prompttofetch)) {
                   15294:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   15295:                 unless ($fetchresult eq 'ok') {
                   15296:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   15297:                 }
                   15298:             }
                   15299:             if ($replicationfail) {
                   15300:                 $output .= '<p class="LC_error">'.
                   15301:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   15302:                            $replicationfail.
                   15303:                            '</ul></p>';
                   15304:             }
                   15305:         }
1.1055    raeburn  15306:     } else {
                   15307:         $warning = &mt('No items found in archive.');
                   15308:     }
                   15309:     if ($error) {
                   15310:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   15311:                    $error.'</p>'."\n";
                   15312:     }
                   15313:     if ($warning) {
                   15314:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   15315:     }
                   15316:     return $output;
                   15317: }
                   15318: 
1.1066    raeburn  15319: sub cleanup_empty_dirs {
                   15320:     my ($path) = @_;
                   15321:     if (($path ne '') && (-d $path)) {
                   15322:         if (opendir(my $dirh,$path)) {
                   15323:             my @dircontents = grep(!/^\./,readdir($dirh));
                   15324:             my $numitems = 0;
                   15325:             foreach my $item (@dircontents) {
                   15326:                 if (-d "$path/$item") {
1.1111    raeburn  15327:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  15328:                     if (-e "$path/$item") {
                   15329:                         $numitems ++;
                   15330:                     }
                   15331:                 } else {
                   15332:                     $numitems ++;
                   15333:                 }
                   15334:             }
                   15335:             if ($numitems == 0) {
                   15336:                 rmdir($path);
                   15337:             }
                   15338:             closedir($dirh);
                   15339:         }
                   15340:     }
                   15341:     return;
                   15342: }
                   15343: 
1.41      ng       15344: =pod
1.45      matthew  15345: 
1.1162    raeburn  15346: =item * &get_folder_hierarchy()
1.1068    raeburn  15347: 
                   15348: Provides hierarchy of names of folders/sub-folders containing the current
                   15349: item,
                   15350: 
                   15351: Inputs: 3
                   15352:      - $navmap - navmaps object
                   15353: 
                   15354:      - $map - url for map (either the trigger itself, or map containing
                   15355:                            the resource, which is the trigger).
                   15356: 
                   15357:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   15358: 
                   15359: Outputs: 1 @pathitems - array of folder/subfolder names.
                   15360: 
                   15361: =cut
                   15362: 
                   15363: sub get_folder_hierarchy {
                   15364:     my ($navmap,$map,$showitem) = @_;
                   15365:     my @pathitems;
                   15366:     if (ref($navmap)) {
                   15367:         my $mapres = $navmap->getResourceByUrl($map);
                   15368:         if (ref($mapres)) {
                   15369:             my $pcslist = $mapres->map_hierarchy();
                   15370:             if ($pcslist ne '') {
                   15371:                 my @pcs = split(/,/,$pcslist);
                   15372:                 foreach my $pc (@pcs) {
                   15373:                     if ($pc == 1) {
1.1129    raeburn  15374:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  15375:                     } else {
                   15376:                         my $res = $navmap->getByMapPc($pc);
                   15377:                         if (ref($res)) {
                   15378:                             my $title = $res->compTitle();
                   15379:                             $title =~ s/\W+/_/g;
                   15380:                             if ($title ne '') {
                   15381:                                 push(@pathitems,$title);
                   15382:                             }
                   15383:                         }
                   15384:                     }
                   15385:                 }
                   15386:             }
1.1071    raeburn  15387:             if ($showitem) {
                   15388:                 if ($mapres->{ID} eq '0.0') {
1.1129    raeburn  15389:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  15390:                 } else {
                   15391:                     my $maptitle = $mapres->compTitle();
                   15392:                     $maptitle =~ s/\W+/_/g;
                   15393:                     if ($maptitle ne '') {
                   15394:                         push(@pathitems,$maptitle);
                   15395:                     }
1.1068    raeburn  15396:                 }
                   15397:             }
                   15398:         }
                   15399:     }
                   15400:     return @pathitems;
                   15401: }
                   15402: 
                   15403: =pod
                   15404: 
1.1015    raeburn  15405: =item * &get_turnedin_filepath()
                   15406: 
                   15407: Determines path in a user's portfolio file for storage of files uploaded
                   15408: to a specific essayresponse or dropbox item.
                   15409: 
                   15410: Inputs: 3 required + 1 optional.
                   15411: $symb is symb for resource, $uname and $udom are for current user (required).
                   15412: $caller is optional (can be "submission", if routine is called when storing
                   15413: an upoaded file when "Submit Answer" button was pressed).
                   15414: 
                   15415: Returns array containing $path and $multiresp. 
                   15416: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   15417: than one file upload item.  Callers of routine should append partid as a 
                   15418: subdirectory to $path in cases where $multiresp is 1.
                   15419: 
                   15420: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   15421: 
                   15422: =cut
                   15423: 
                   15424: sub get_turnedin_filepath {
                   15425:     my ($symb,$uname,$udom,$caller) = @_;
                   15426:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   15427:     my $turnindir;
                   15428:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   15429:     $turnindir = $userhash{'turnindir'};
                   15430:     my ($path,$multiresp);
                   15431:     if ($turnindir eq '') {
                   15432:         if ($caller eq 'submission') {
                   15433:             $turnindir = &mt('turned in');
                   15434:             $turnindir =~ s/\W+/_/g;
                   15435:             my %newhash = (
                   15436:                             'turnindir' => $turnindir,
                   15437:                           );
                   15438:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   15439:         }
                   15440:     }
                   15441:     if ($turnindir ne '') {
                   15442:         $path = '/'.$turnindir.'/';
                   15443:         my ($multipart,$turnin,@pathitems);
                   15444:         my $navmap = Apache::lonnavmaps::navmap->new();
                   15445:         if (defined($navmap)) {
                   15446:             my $mapres = $navmap->getResourceByUrl($map);
                   15447:             if (ref($mapres)) {
                   15448:                 my $pcslist = $mapres->map_hierarchy();
                   15449:                 if ($pcslist ne '') {
                   15450:                     foreach my $pc (split(/,/,$pcslist)) {
                   15451:                         my $res = $navmap->getByMapPc($pc);
                   15452:                         if (ref($res)) {
                   15453:                             my $title = $res->compTitle();
                   15454:                             $title =~ s/\W+/_/g;
                   15455:                             if ($title ne '') {
1.1149    raeburn  15456:                                 if (($pc > 1) && (length($title) > 12)) {
                   15457:                                     $title = substr($title,0,12);
                   15458:                                 }
1.1015    raeburn  15459:                                 push(@pathitems,$title);
                   15460:                             }
                   15461:                         }
                   15462:                     }
                   15463:                 }
                   15464:                 my $maptitle = $mapres->compTitle();
                   15465:                 $maptitle =~ s/\W+/_/g;
                   15466:                 if ($maptitle ne '') {
1.1149    raeburn  15467:                     if (length($maptitle) > 12) {
                   15468:                         $maptitle = substr($maptitle,0,12);
                   15469:                     }
1.1015    raeburn  15470:                     push(@pathitems,$maptitle);
                   15471:                 }
                   15472:                 unless ($env{'request.state'} eq 'construct') {
                   15473:                     my $res = $navmap->getBySymb($symb);
                   15474:                     if (ref($res)) {
                   15475:                         my $partlist = $res->parts();
                   15476:                         my $totaluploads = 0;
                   15477:                         if (ref($partlist) eq 'ARRAY') {
                   15478:                             foreach my $part (@{$partlist}) {
                   15479:                                 my @types = $res->responseType($part);
                   15480:                                 my @ids = $res->responseIds($part);
                   15481:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   15482:                                     if ($types[$i] eq 'essay') {
                   15483:                                         my $partid = $part.'_'.$ids[$i];
                   15484:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   15485:                                             $totaluploads ++;
                   15486:                                         }
                   15487:                                     }
                   15488:                                 }
                   15489:                             }
                   15490:                             if ($totaluploads > 1) {
                   15491:                                 $multiresp = 1;
                   15492:                             }
                   15493:                         }
                   15494:                     }
                   15495:                 }
                   15496:             } else {
                   15497:                 return;
                   15498:             }
                   15499:         } else {
                   15500:             return;
                   15501:         }
                   15502:         my $restitle=&Apache::lonnet::gettitle($symb);
                   15503:         $restitle =~ s/\W+/_/g;
                   15504:         if ($restitle eq '') {
                   15505:             $restitle = ($resurl =~ m{/[^/]+$});
                   15506:             if ($restitle eq '') {
                   15507:                 $restitle = time;
                   15508:             }
                   15509:         }
1.1149    raeburn  15510:         if (length($restitle) > 12) {
                   15511:             $restitle = substr($restitle,0,12);
                   15512:         }
1.1015    raeburn  15513:         push(@pathitems,$restitle);
                   15514:         $path .= join('/',@pathitems);
                   15515:     }
                   15516:     return ($path,$multiresp);
                   15517: }
                   15518: 
                   15519: =pod
                   15520: 
1.464     albertel 15521: =back
1.41      ng       15522: 
1.112     bowersj2 15523: =head1 CSV Upload/Handling functions
1.38      albertel 15524: 
1.41      ng       15525: =over 4
                   15526: 
1.648     raeburn  15527: =item * &upfile_store($r)
1.41      ng       15528: 
                   15529: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 15530: needs $env{'form.upfile'}
1.41      ng       15531: returns $datatoken to be put into hidden field
                   15532: 
                   15533: =cut
1.31      albertel 15534: 
                   15535: sub upfile_store {
                   15536:     my $r=shift;
1.258     albertel 15537:     $env{'form.upfile'}=~s/\r/\n/gs;
                   15538:     $env{'form.upfile'}=~s/\f/\n/gs;
                   15539:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   15540:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 15541: 
1.1299    raeburn  15542:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   15543:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   15544:                                      time.'_'.$$);
                   15545:     return if ($datatoken eq '');
                   15546: 
1.31      albertel 15547:     {
1.158     raeburn  15548:         my $datafile = $r->dir_config('lonDaemons').
                   15549:                            '/tmp/'.$datatoken.'.tmp';
1.1317    raeburn  15550:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 15551:             print $fh $env{'form.upfile'};
1.158     raeburn  15552:             close($fh);
                   15553:         }
1.31      albertel 15554:     }
                   15555:     return $datatoken;
                   15556: }
                   15557: 
1.56      matthew  15558: =pod
                   15559: 
1.1290    raeburn  15560: =item * &load_tmp_file($r,$datatoken)
1.41      ng       15561: 
                   15562: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290    raeburn  15563: $datatoken is the name to assign to the temporary file.
1.258     albertel 15564: sets $env{'form.upfile'} to the contents of the file
1.41      ng       15565: 
                   15566: =cut
1.31      albertel 15567: 
                   15568: sub load_tmp_file {
1.1290    raeburn  15569:     my ($r,$datatoken) = @_;
                   15570:     return if ($datatoken eq '');
1.31      albertel 15571:     my @studentdata=();
                   15572:     {
1.158     raeburn  15573:         my $studentfile = $r->dir_config('lonDaemons').
1.1290    raeburn  15574:                               '/tmp/'.$datatoken.'.tmp';
1.1317    raeburn  15575:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  15576:             @studentdata=<$fh>;
                   15577:             close($fh);
                   15578:         }
1.31      albertel 15579:     }
1.258     albertel 15580:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 15581: }
                   15582: 
1.1290    raeburn  15583: sub valid_datatoken {
                   15584:     my ($datatoken) = @_;
1.1325    raeburn  15585:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290    raeburn  15586:         return $datatoken;
                   15587:     }
                   15588:     return;
                   15589: }
                   15590: 
1.56      matthew  15591: =pod
                   15592: 
1.648     raeburn  15593: =item * &upfile_record_sep()
1.41      ng       15594: 
                   15595: Separate uploaded file into records
                   15596: returns array of records,
1.258     albertel 15597: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       15598: 
                   15599: =cut
1.31      albertel 15600: 
                   15601: sub upfile_record_sep {
1.258     albertel 15602:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 15603:     } else {
1.248     albertel 15604: 	my @records;
1.258     albertel 15605: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 15606: 	    if ($line=~/^\s*$/) { next; }
                   15607: 	    push(@records,$line);
                   15608: 	}
                   15609: 	return @records;
1.31      albertel 15610:     }
                   15611: }
                   15612: 
1.56      matthew  15613: =pod
                   15614: 
1.648     raeburn  15615: =item * &record_sep($record)
1.41      ng       15616: 
1.258     albertel 15617: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       15618: 
                   15619: =cut
                   15620: 
1.263     www      15621: sub takeleft {
                   15622:     my $index=shift;
                   15623:     return substr('0000'.$index,-4,4);
                   15624: }
                   15625: 
1.31      albertel 15626: sub record_sep {
                   15627:     my $record=shift;
                   15628:     my %components=();
1.258     albertel 15629:     if ($env{'form.upfiletype'} eq 'xml') {
                   15630:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 15631:         my $i=0;
1.356     albertel 15632:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 15633:             $field=~s/^(\"|\')//;
                   15634:             $field=~s/(\"|\')$//;
1.263     www      15635:             $components{&takeleft($i)}=$field;
1.31      albertel 15636:             $i++;
                   15637:         }
1.258     albertel 15638:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 15639:         my $i=0;
1.356     albertel 15640:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 15641:             $field=~s/^(\"|\')//;
                   15642:             $field=~s/(\"|\')$//;
1.263     www      15643:             $components{&takeleft($i)}=$field;
1.31      albertel 15644:             $i++;
                   15645:         }
                   15646:     } else {
1.561     www      15647:         my $separator=',';
1.480     banghart 15648:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      15649:             $separator=';';
1.480     banghart 15650:         }
1.31      albertel 15651:         my $i=0;
1.561     www      15652: # the character we are looking for to indicate the end of a quote or a record 
                   15653:         my $looking_for=$separator;
                   15654: # do not add the characters to the fields
                   15655:         my $ignore=0;
                   15656: # we just encountered a separator (or the beginning of the record)
                   15657:         my $just_found_separator=1;
                   15658: # store the field we are working on here
                   15659:         my $field='';
                   15660: # work our way through all characters in record
                   15661:         foreach my $character ($record=~/(.)/g) {
                   15662:             if ($character eq $looking_for) {
                   15663:                if ($character ne $separator) {
                   15664: # Found the end of a quote, again looking for separator
                   15665:                   $looking_for=$separator;
                   15666:                   $ignore=1;
                   15667:                } else {
                   15668: # Found a separator, store away what we got
                   15669:                   $components{&takeleft($i)}=$field;
                   15670: 	          $i++;
                   15671:                   $just_found_separator=1;
                   15672:                   $ignore=0;
                   15673:                   $field='';
                   15674:                }
                   15675:                next;
                   15676:             }
                   15677: # single or double quotation marks after a separator indicate beginning of a quote
                   15678: # we are now looking for the end of the quote and need to ignore separators
                   15679:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   15680:                $looking_for=$character;
                   15681:                next;
                   15682:             }
                   15683: # ignore would be true after we reached the end of a quote
                   15684:             if ($ignore) { next; }
                   15685:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   15686:             $field.=$character;
                   15687:             $just_found_separator=0; 
1.31      albertel 15688:         }
1.561     www      15689: # catch the very last entry, since we never encountered the separator
                   15690:         $components{&takeleft($i)}=$field;
1.31      albertel 15691:     }
                   15692:     return %components;
                   15693: }
                   15694: 
1.144     matthew  15695: ######################################################
                   15696: ######################################################
                   15697: 
1.56      matthew  15698: =pod
                   15699: 
1.648     raeburn  15700: =item * &upfile_select_html()
1.41      ng       15701: 
1.144     matthew  15702: Return HTML code to select a file from the users machine and specify 
                   15703: the file type.
1.41      ng       15704: 
                   15705: =cut
                   15706: 
1.144     matthew  15707: ######################################################
                   15708: ######################################################
1.31      albertel 15709: sub upfile_select_html {
1.144     matthew  15710:     my %Types = (
                   15711:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 15712:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  15713:                  space => &mt('Space separated'),
                   15714:                  tab   => &mt('Tabulator separated'),
                   15715: #                 xml   => &mt('HTML/XML'),
                   15716:                  );
1.1473    raeburn  15717:     my $Str = '<input type="file" name="upfile" id="upfile" size="50" />'.
                   15718:         '<br /><label>'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  15719:     foreach my $type (sort(keys(%Types))) {
                   15720:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   15721:     }
1.1473    raeburn  15722:     $Str .= "</select></label>\n";
1.144     matthew  15723:     return $Str;
1.31      albertel 15724: }
                   15725: 
1.301     albertel 15726: sub get_samples {
                   15727:     my ($records,$toget) = @_;
                   15728:     my @samples=({});
                   15729:     my $got=0;
                   15730:     foreach my $rec (@$records) {
                   15731: 	my %temp = &record_sep($rec);
                   15732: 	if (! grep(/\S/, values(%temp))) { next; }
                   15733: 	if (%temp) {
                   15734: 	    $samples[$got]=\%temp;
                   15735: 	    $got++;
                   15736: 	    if ($got == $toget) { last; }
                   15737: 	}
                   15738:     }
                   15739:     return \@samples;
                   15740: }
                   15741: 
1.144     matthew  15742: ######################################################
                   15743: ######################################################
                   15744: 
1.56      matthew  15745: =pod
                   15746: 
1.648     raeburn  15747: =item * &csv_print_samples($r,$records)
1.41      ng       15748: 
                   15749: Prints a table of sample values from each column uploaded $r is an
                   15750: Apache Request ref, $records is an arrayref from
                   15751: &Apache::loncommon::upfile_record_sep
                   15752: 
                   15753: =cut
                   15754: 
1.144     matthew  15755: ######################################################
                   15756: ######################################################
1.31      albertel 15757: sub csv_print_samples {
                   15758:     my ($r,$records) = @_;
1.662     bisitz   15759:     my $samples = &get_samples($records,5);
1.301     albertel 15760: 
1.594     raeburn  15761:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   15762:               &start_data_table_header_row());
1.356     albertel 15763:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   15764:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  15765:     $r->print(&end_data_table_header_row());
1.301     albertel 15766:     foreach my $hash (@$samples) {
1.594     raeburn  15767: 	$r->print(&start_data_table_row());
1.356     albertel 15768: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 15769: 	    $r->print('<td>');
1.356     albertel 15770: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 15771: 	    $r->print('</td>');
                   15772: 	}
1.594     raeburn  15773: 	$r->print(&end_data_table_row());
1.31      albertel 15774:     }
1.594     raeburn  15775:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 15776: }
                   15777: 
1.144     matthew  15778: ######################################################
                   15779: ######################################################
                   15780: 
1.56      matthew  15781: =pod
                   15782: 
1.648     raeburn  15783: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       15784: 
                   15785: Prints a table to create associations between values and table columns.
1.144     matthew  15786: 
1.41      ng       15787: $r is an Apache Request ref,
                   15788: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  15789: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       15790: 
                   15791: =cut
                   15792: 
1.144     matthew  15793: ######################################################
                   15794: ######################################################
1.31      albertel 15795: sub csv_print_select_table {
                   15796:     my ($r,$records,$d) = @_;
1.301     albertel 15797:     my $i=0;
                   15798:     my $samples = &get_samples($records,1);
1.144     matthew  15799:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  15800: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  15801:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  15802:               '<th>'.&mt('Column').'</th>'.
                   15803:               &end_data_table_header_row()."\n");
1.356     albertel 15804:     foreach my $array_ref (@$d) {
                   15805: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.1473    raeburn  15806: 	$r->print(&start_data_table_row().'<td><label for="f'.$i.'">'.$display.'</label></td>');
1.31      albertel 15807: 
1.1473    raeburn  15808: 	$r->print('<td><select name="f'.$i.'" id="f'.$i.'"'.
1.32      matthew  15809: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 15810: 	$r->print('<option value="none"></option>');
1.356     albertel 15811: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   15812: 	    $r->print('<option value="'.$sample.'"'.
                   15813:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   15814:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 15815: 	}
1.594     raeburn  15816: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 15817: 	$i++;
                   15818:     }
1.594     raeburn  15819:     $r->print(&end_data_table());
1.31      albertel 15820:     $i--;
                   15821:     return $i;
                   15822: }
1.56      matthew  15823: 
1.144     matthew  15824: ######################################################
                   15825: ######################################################
                   15826: 
1.56      matthew  15827: =pod
1.31      albertel 15828: 
1.648     raeburn  15829: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       15830: 
                   15831: Prints a table of sample values from the upload and can make associate samples to internal names.
                   15832: 
                   15833: $r is an Apache Request ref,
                   15834: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   15835: $d is an array of 2 element arrays (internal name, displayed name)
                   15836: 
                   15837: =cut
                   15838: 
1.144     matthew  15839: ######################################################
                   15840: ######################################################
1.31      albertel 15841: sub csv_samples_select_table {
                   15842:     my ($r,$records,$d) = @_;
                   15843:     my $i=0;
1.144     matthew  15844:     #
1.662     bisitz   15845:     my $max_samples = 5;
                   15846:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  15847:     $r->print(&start_data_table().
                   15848:               &start_data_table_header_row().'<th>'.
                   15849:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   15850:               &end_data_table_header_row());
1.301     albertel 15851: 
                   15852:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.1473    raeburn  15853:         my $num = $i+1;
                   15854:         my $labeltext = &HTML::Entities::encode(&mt('Field for data in column [_1]',$num));
1.594     raeburn  15855: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.1473    raeburn  15856: 		  ' onchange="javascript:flip(this.form,'.$i.');" aria-label="'.$labeltext.'">');
1.301     albertel 15857: 	foreach my $option (@$d) {
                   15858: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  15859: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 15860:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  15861:                       $display.'</option>');
1.31      albertel 15862: 	}
                   15863: 	$r->print('</select></td><td>');
1.662     bisitz   15864: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 15865: 	    if (defined($samples->[$line]{$key})) { 
                   15866: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   15867: 	    }
                   15868: 	}
1.594     raeburn  15869: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 15870: 	$i++;
                   15871:     }
1.594     raeburn  15872:     $r->print(&end_data_table());
1.31      albertel 15873:     $i--;
                   15874:     return($i);
1.115     matthew  15875: }
                   15876: 
1.144     matthew  15877: ######################################################
                   15878: ######################################################
                   15879: 
1.115     matthew  15880: =pod
                   15881: 
1.648     raeburn  15882: =item * &clean_excel_name($name)
1.115     matthew  15883: 
                   15884: Returns a replacement for $name which does not contain any illegal characters.
                   15885: 
                   15886: =cut
                   15887: 
1.144     matthew  15888: ######################################################
                   15889: ######################################################
1.115     matthew  15890: sub clean_excel_name {
                   15891:     my ($name) = @_;
                   15892:     $name =~ s/[:\*\?\/\\]//g;
                   15893:     if (length($name) > 31) {
                   15894:         $name = substr($name,0,31);
                   15895:     }
                   15896:     return $name;
1.25      albertel 15897: }
1.84      albertel 15898: 
1.85      albertel 15899: =pod
                   15900: 
1.648     raeburn  15901: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 15902: 
                   15903: Returns either 1 or undef
                   15904: 
                   15905: 1 if the part is to be hidden, undef if it is to be shown
                   15906: 
                   15907: Arguments are:
                   15908: 
                   15909: $id the id of the part to be checked
                   15910: $symb, optional the symb of the resource to check
                   15911: $udom, optional the domain of the user to check for
                   15912: $uname, optional the username of the user to check for
                   15913: 
                   15914: =cut
1.84      albertel 15915: 
                   15916: sub check_if_partid_hidden {
                   15917:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 15918:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 15919: 					 $symb,$udom,$uname);
1.141     albertel 15920:     my $truth=1;
                   15921:     #if the string starts with !, then the list is the list to show not hide
                   15922:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 15923:     my @hiddenlist=split(/,/,$hiddenparts);
                   15924:     foreach my $checkid (@hiddenlist) {
1.141     albertel 15925: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 15926:     }
1.141     albertel 15927:     return !$truth;
1.84      albertel 15928: }
1.127     matthew  15929: 
1.138     matthew  15930: 
                   15931: ############################################################
                   15932: ############################################################
                   15933: 
                   15934: =pod
                   15935: 
1.157     matthew  15936: =back 
                   15937: 
1.138     matthew  15938: =head1 cgi-bin script and graphing routines
                   15939: 
1.157     matthew  15940: =over 4
                   15941: 
1.648     raeburn  15942: =item * &get_cgi_id()
1.138     matthew  15943: 
                   15944: Inputs: none
                   15945: 
                   15946: Returns an id which can be used to pass environment variables
                   15947: to various cgi-bin scripts.  These environment variables will
                   15948: be removed from the users environment after a given time by
                   15949: the routine &Apache::lonnet::transfer_profile_to_env.
                   15950: 
                   15951: =cut
                   15952: 
                   15953: ############################################################
                   15954: ############################################################
1.152     albertel 15955: my $uniq=0;
1.136     matthew  15956: sub get_cgi_id {
1.154     albertel 15957:     $uniq=($uniq+1)%100000;
1.280     albertel 15958:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  15959: }
                   15960: 
1.127     matthew  15961: ############################################################
                   15962: ############################################################
                   15963: 
                   15964: =pod
                   15965: 
1.648     raeburn  15966: =item * &DrawBarGraph()
1.127     matthew  15967: 
1.138     matthew  15968: Facilitates the plotting of data in a (stacked) bar graph.
                   15969: Puts plot definition data into the users environment in order for 
                   15970: graph.png to plot it.  Returns an <img> tag for the plot.
                   15971: The bars on the plot are labeled '1','2',...,'n'.
                   15972: 
                   15973: Inputs:
                   15974: 
                   15975: =over 4
                   15976: 
                   15977: =item $Title: string, the title of the plot
                   15978: 
                   15979: =item $xlabel: string, text describing the X-axis of the plot
                   15980: 
                   15981: =item $ylabel: string, text describing the Y-axis of the plot
                   15982: 
                   15983: =item $Max: scalar, the maximum Y value to use in the plot
                   15984: If $Max is < any data point, the graph will not be rendered.
                   15985: 
1.140     matthew  15986: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  15987: they are plotted.  If undefined, default values will be used.
                   15988: 
1.178     matthew  15989: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   15990: 
1.138     matthew  15991: =item @Values: An array of array references.  Each array reference holds data
                   15992: to be plotted in a stacked bar chart.
                   15993: 
1.239     matthew  15994: =item If the final element of @Values is a hash reference the key/value
                   15995: pairs will be added to the graph definition.
                   15996: 
1.138     matthew  15997: =back
                   15998: 
                   15999: Returns:
                   16000: 
                   16001: An <img> tag which references graph.png and the appropriate identifying
                   16002: information for the plot.
                   16003: 
1.127     matthew  16004: =cut
                   16005: 
                   16006: ############################################################
                   16007: ############################################################
1.134     matthew  16008: sub DrawBarGraph {
1.178     matthew  16009:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  16010:     #
                   16011:     if (! defined($colors)) {
                   16012:         $colors = ['#33ff00', 
                   16013:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   16014:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   16015:                   ]; 
                   16016:     }
1.228     matthew  16017:     my $extra_settings = {};
                   16018:     if (ref($Values[-1]) eq 'HASH') {
                   16019:         $extra_settings = pop(@Values);
                   16020:     }
1.127     matthew  16021:     #
1.136     matthew  16022:     my $identifier = &get_cgi_id();
                   16023:     my $id = 'cgi.'.$identifier;        
1.129     matthew  16024:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  16025:         return '';
                   16026:     }
1.225     matthew  16027:     #
                   16028:     my @Labels;
                   16029:     if (defined($labels)) {
                   16030:         @Labels = @$labels;
                   16031:     } else {
                   16032:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263    raeburn  16033:             push(@Labels,$i+1);
1.225     matthew  16034:         }
                   16035:     }
                   16036:     #
1.129     matthew  16037:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  16038:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  16039:     my %ValuesHash;
                   16040:     my $NumSets=1;
                   16041:     foreach my $array (@Values) {
                   16042:         next if (! ref($array));
1.136     matthew  16043:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  16044:             join(',',@$array);
1.129     matthew  16045:     }
1.127     matthew  16046:     #
1.136     matthew  16047:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  16048:     if ($NumBars < 3) {
                   16049:         $width = 120+$NumBars*32;
1.220     matthew  16050:         $xskip = 1;
1.225     matthew  16051:         $bar_width = 30;
                   16052:     } elsif ($NumBars < 5) {
                   16053:         $width = 120+$NumBars*20;
                   16054:         $xskip = 1;
                   16055:         $bar_width = 20;
1.220     matthew  16056:     } elsif ($NumBars < 10) {
1.136     matthew  16057:         $width = 120+$NumBars*15;
                   16058:         $xskip = 1;
                   16059:         $bar_width = 15;
                   16060:     } elsif ($NumBars <= 25) {
                   16061:         $width = 120+$NumBars*11;
                   16062:         $xskip = 5;
                   16063:         $bar_width = 8;
                   16064:     } elsif ($NumBars <= 50) {
                   16065:         $width = 120+$NumBars*8;
                   16066:         $xskip = 5;
                   16067:         $bar_width = 4;
                   16068:     } else {
                   16069:         $width = 120+$NumBars*8;
                   16070:         $xskip = 5;
                   16071:         $bar_width = 4;
                   16072:     }
                   16073:     #
1.137     matthew  16074:     $Max = 1 if ($Max < 1);
                   16075:     if ( int($Max) < $Max ) {
                   16076:         $Max++;
                   16077:         $Max = int($Max);
                   16078:     }
1.127     matthew  16079:     $Title  = '' if (! defined($Title));
                   16080:     $xlabel = '' if (! defined($xlabel));
                   16081:     $ylabel = '' if (! defined($ylabel));
1.369     www      16082:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   16083:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   16084:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  16085:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  16086:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   16087:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   16088:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   16089:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   16090:     $ValuesHash{$id.'.height'}   = $height;
                   16091:     $ValuesHash{$id.'.width'}    = $width;
                   16092:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   16093:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   16094:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  16095:     #
1.228     matthew  16096:     # Deal with other parameters
                   16097:     while (my ($key,$value) = each(%$extra_settings)) {
                   16098:         $ValuesHash{$id.'.'.$key} = $value;
                   16099:     }
                   16100:     #
1.646     raeburn  16101:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  16102:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   16103: }
                   16104: 
                   16105: ############################################################
                   16106: ############################################################
                   16107: 
                   16108: =pod
                   16109: 
1.648     raeburn  16110: =item * &DrawXYGraph()
1.137     matthew  16111: 
1.138     matthew  16112: Facilitates the plotting of data in an XY graph.
                   16113: Puts plot definition data into the users environment in order for 
                   16114: graph.png to plot it.  Returns an <img> tag for the plot.
                   16115: 
                   16116: Inputs:
                   16117: 
                   16118: =over 4
                   16119: 
                   16120: =item $Title: string, the title of the plot
                   16121: 
                   16122: =item $xlabel: string, text describing the X-axis of the plot
                   16123: 
                   16124: =item $ylabel: string, text describing the Y-axis of the plot
                   16125: 
                   16126: =item $Max: scalar, the maximum Y value to use in the plot
                   16127: If $Max is < any data point, the graph will not be rendered.
                   16128: 
                   16129: =item $colors: Array ref containing the hex color codes for the data to be 
                   16130: plotted in.  If undefined, default values will be used.
                   16131: 
                   16132: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   16133: 
                   16134: =item $Ydata: Array ref containing Array refs.  
1.185     www      16135: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  16136: 
                   16137: =item %Values: hash indicating or overriding any default values which are 
                   16138: passed to graph.png.  
                   16139: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   16140: 
                   16141: =back
                   16142: 
                   16143: Returns:
                   16144: 
                   16145: An <img> tag which references graph.png and the appropriate identifying
                   16146: information for the plot.
                   16147: 
1.137     matthew  16148: =cut
                   16149: 
                   16150: ############################################################
                   16151: ############################################################
                   16152: sub DrawXYGraph {
                   16153:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   16154:     #
                   16155:     # Create the identifier for the graph
                   16156:     my $identifier = &get_cgi_id();
                   16157:     my $id = 'cgi.'.$identifier;
                   16158:     #
                   16159:     $Title  = '' if (! defined($Title));
                   16160:     $xlabel = '' if (! defined($xlabel));
                   16161:     $ylabel = '' if (! defined($ylabel));
                   16162:     my %ValuesHash = 
                   16163:         (
1.369     www      16164:          $id.'.title'  => &escape($Title),
                   16165:          $id.'.xlabel' => &escape($xlabel),
                   16166:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  16167:          $id.'.y_max_value'=> $Max,
                   16168:          $id.'.labels'     => join(',',@$Xlabels),
                   16169:          $id.'.PlotType'   => 'XY',
                   16170:          );
                   16171:     #
                   16172:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   16173:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   16174:     }
                   16175:     #
                   16176:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   16177:         return '';
                   16178:     }
                   16179:     my $NumSets=1;
1.138     matthew  16180:     foreach my $array (@{$Ydata}){
1.137     matthew  16181:         next if (! ref($array));
                   16182:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   16183:     }
1.138     matthew  16184:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  16185:     #
                   16186:     # Deal with other parameters
                   16187:     while (my ($key,$value) = each(%Values)) {
                   16188:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  16189:     }
                   16190:     #
1.646     raeburn  16191:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  16192:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   16193: }
                   16194: 
                   16195: ############################################################
                   16196: ############################################################
                   16197: 
                   16198: =pod
                   16199: 
1.648     raeburn  16200: =item * &DrawXYYGraph()
1.138     matthew  16201: 
                   16202: Facilitates the plotting of data in an XY graph with two Y axes.
                   16203: Puts plot definition data into the users environment in order for 
                   16204: graph.png to plot it.  Returns an <img> tag for the plot.
                   16205: 
                   16206: Inputs:
                   16207: 
                   16208: =over 4
                   16209: 
                   16210: =item $Title: string, the title of the plot
                   16211: 
                   16212: =item $xlabel: string, text describing the X-axis of the plot
                   16213: 
                   16214: =item $ylabel: string, text describing the Y-axis of the plot
                   16215: 
                   16216: =item $colors: Array ref containing the hex color codes for the data to be 
                   16217: plotted in.  If undefined, default values will be used.
                   16218: 
                   16219: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   16220: 
                   16221: =item $Ydata1: The first data set
                   16222: 
                   16223: =item $Min1: The minimum value of the left Y-axis
                   16224: 
                   16225: =item $Max1: The maximum value of the left Y-axis
                   16226: 
                   16227: =item $Ydata2: The second data set
                   16228: 
                   16229: =item $Min2: The minimum value of the right Y-axis
                   16230: 
                   16231: =item $Max2: The maximum value of the left Y-axis
                   16232: 
                   16233: =item %Values: hash indicating or overriding any default values which are 
                   16234: passed to graph.png.  
                   16235: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   16236: 
                   16237: =back
                   16238: 
                   16239: Returns:
                   16240: 
                   16241: An <img> tag which references graph.png and the appropriate identifying
                   16242: information for the plot.
1.136     matthew  16243: 
                   16244: =cut
                   16245: 
                   16246: ############################################################
                   16247: ############################################################
1.137     matthew  16248: sub DrawXYYGraph {
                   16249:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   16250:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  16251:     #
                   16252:     # Create the identifier for the graph
                   16253:     my $identifier = &get_cgi_id();
                   16254:     my $id = 'cgi.'.$identifier;
                   16255:     #
                   16256:     $Title  = '' if (! defined($Title));
                   16257:     $xlabel = '' if (! defined($xlabel));
                   16258:     $ylabel = '' if (! defined($ylabel));
                   16259:     my %ValuesHash = 
                   16260:         (
1.369     www      16261:          $id.'.title'  => &escape($Title),
                   16262:          $id.'.xlabel' => &escape($xlabel),
                   16263:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  16264:          $id.'.labels' => join(',',@$Xlabels),
                   16265:          $id.'.PlotType' => 'XY',
                   16266:          $id.'.NumSets' => 2,
1.137     matthew  16267:          $id.'.two_axes' => 1,
                   16268:          $id.'.y1_max_value' => $Max1,
                   16269:          $id.'.y1_min_value' => $Min1,
                   16270:          $id.'.y2_max_value' => $Max2,
                   16271:          $id.'.y2_min_value' => $Min2,
1.136     matthew  16272:          );
                   16273:     #
1.137     matthew  16274:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   16275:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   16276:     }
                   16277:     #
                   16278:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   16279:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  16280:         return '';
                   16281:     }
                   16282:     my $NumSets=1;
1.137     matthew  16283:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  16284:         next if (! ref($array));
                   16285:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  16286:     }
                   16287:     #
                   16288:     # Deal with other parameters
                   16289:     while (my ($key,$value) = each(%Values)) {
                   16290:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  16291:     }
                   16292:     #
1.646     raeburn  16293:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 16294:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  16295: }
                   16296: 
                   16297: ############################################################
                   16298: ############################################################
                   16299: 
                   16300: =pod
                   16301: 
1.157     matthew  16302: =back 
                   16303: 
1.139     matthew  16304: =head1 Statistics helper routines?  
                   16305: 
                   16306: Bad place for them but what the hell.
                   16307: 
1.157     matthew  16308: =over 4
                   16309: 
1.648     raeburn  16310: =item * &chartlink()
1.139     matthew  16311: 
                   16312: Returns a link to the chart for a specific student.  
                   16313: 
                   16314: Inputs:
                   16315: 
                   16316: =over 4
                   16317: 
                   16318: =item $linktext: The text of the link
                   16319: 
                   16320: =item $sname: The students username
                   16321: 
                   16322: =item $sdomain: The students domain
                   16323: 
                   16324: =back
                   16325: 
1.157     matthew  16326: =back
                   16327: 
1.139     matthew  16328: =cut
                   16329: 
                   16330: ############################################################
                   16331: ############################################################
                   16332: sub chartlink {
                   16333:     my ($linktext, $sname, $sdomain) = @_;
                   16334:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      16335:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 16336:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  16337:        '">'.$linktext.'</a>';
1.153     matthew  16338: }
                   16339: 
                   16340: #######################################################
                   16341: #######################################################
                   16342: 
                   16343: =pod
                   16344: 
                   16345: =head1 Course Environment Routines
1.157     matthew  16346: 
                   16347: =over 4
1.153     matthew  16348: 
1.648     raeburn  16349: =item * &restore_course_settings()
1.153     matthew  16350: 
1.648     raeburn  16351: =item * &store_course_settings()
1.153     matthew  16352: 
                   16353: Restores/Store indicated form parameters from the course environment.
                   16354: Will not overwrite existing values of the form parameters.
                   16355: 
                   16356: Inputs: 
                   16357: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   16358: 
                   16359: a hash ref describing the data to be stored.  For example:
                   16360:    
                   16361: %Save_Parameters = ('Status' => 'scalar',
                   16362:     'chartoutputmode' => 'scalar',
                   16363:     'chartoutputdata' => 'scalar',
                   16364:     'Section' => 'array',
1.373     raeburn  16365:     'Group' => 'array',
1.153     matthew  16366:     'StudentData' => 'array',
                   16367:     'Maps' => 'array');
                   16368: 
                   16369: Returns: both routines return nothing
                   16370: 
1.631     raeburn  16371: =back
                   16372: 
1.153     matthew  16373: =cut
                   16374: 
                   16375: #######################################################
                   16376: #######################################################
                   16377: sub store_course_settings {
1.496     albertel 16378:     return &store_settings($env{'request.course.id'},@_);
                   16379: }
                   16380: 
                   16381: sub store_settings {
1.153     matthew  16382:     # save to the environment
                   16383:     # appenv the same items, just to be safe
1.300     albertel 16384:     my $udom  = $env{'user.domain'};
                   16385:     my $uname = $env{'user.name'};
1.496     albertel 16386:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  16387:     my %SaveHash;
                   16388:     my %AppHash;
                   16389:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 16390:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 16391:         my $envname = 'environment.'.$basename;
1.258     albertel 16392:         if (exists($env{'form.'.$setting})) {
1.153     matthew  16393:             # Save this value away
                   16394:             if ($type eq 'scalar' &&
1.258     albertel 16395:                 (! exists($env{$envname}) || 
                   16396:                  $env{$envname} ne $env{'form.'.$setting})) {
                   16397:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   16398:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  16399:             } elsif ($type eq 'array') {
                   16400:                 my $stored_form;
1.258     albertel 16401:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  16402:                     $stored_form = join(',',
                   16403:                                         map {
1.369     www      16404:                                             &escape($_);
1.258     albertel 16405:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  16406:                 } else {
                   16407:                     $stored_form = 
1.369     www      16408:                         &escape($env{'form.'.$setting});
1.153     matthew  16409:                 }
                   16410:                 # Determine if the array contents are the same.
1.258     albertel 16411:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  16412:                     $SaveHash{$basename} = $stored_form;
                   16413:                     $AppHash{$envname}   = $stored_form;
                   16414:                 }
                   16415:             }
                   16416:         }
                   16417:     }
                   16418:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 16419:                                           $udom,$uname);
1.153     matthew  16420:     if ($put_result !~ /^(ok|delayed)/) {
                   16421:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   16422:                                  'got error:'.$put_result);
                   16423:     }
                   16424:     # Make sure these settings stick around in this session, too
1.646     raeburn  16425:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  16426:     return;
                   16427: }
                   16428: 
                   16429: sub restore_course_settings {
1.499     albertel 16430:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 16431: }
                   16432: 
                   16433: sub restore_settings {
                   16434:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  16435:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 16436:         next if (exists($env{'form.'.$setting}));
1.496     albertel 16437:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  16438:             '.'.$setting;
1.258     albertel 16439:         if (exists($env{$envname})) {
1.153     matthew  16440:             if ($type eq 'scalar') {
1.258     albertel 16441:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  16442:             } elsif ($type eq 'array') {
1.258     albertel 16443:                 $env{'form.'.$setting} = [ 
1.153     matthew  16444:                                            map { 
1.369     www      16445:                                                &unescape($_); 
1.258     albertel 16446:                                            } split(',',$env{$envname})
1.153     matthew  16447:                                            ];
                   16448:             }
                   16449:         }
                   16450:     }
1.127     matthew  16451: }
                   16452: 
1.618     raeburn  16453: #######################################################
                   16454: #######################################################
                   16455: 
                   16456: =pod
                   16457: 
                   16458: =head1 Domain E-mail Routines  
                   16459: 
                   16460: =over 4
                   16461: 
1.648     raeburn  16462: =item * &build_recipient_list()
1.618     raeburn  16463: 
1.1144    raeburn  16464: Build recipient lists for following types of e-mail:
1.766     raeburn  16465: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144    raeburn  16466: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   16467: module change checking, student/employee ID conflict checks, as
                   16468: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   16469: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  16470: 
                   16471: Inputs:
1.619     raeburn  16472: defmail (scalar - email address of default recipient), 
1.1144    raeburn  16473: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   16474: requestsmail, updatesmail, or idconflictsmail).
                   16475: 
1.619     raeburn  16476: defdom (domain for which to retrieve configuration settings),
1.1144    raeburn  16477: 
1.619     raeburn  16478: origmail (scalar - email address of recipient from loncapa.conf, 
1.1297    raeburn  16479: i.e., predates configuration by DC via domainprefs.pm
                   16480: 
                   16481: $requname username of requester (if mailing type is helpdeskmail)
                   16482: 
                   16483: $requdom domain of requester (if mailing type is helpdeskmail)
                   16484: 
                   16485: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
                   16486: 
1.618     raeburn  16487: 
1.655     raeburn  16488: Returns: comma separated list of addresses to which to send e-mail.
                   16489: 
                   16490: =back
1.618     raeburn  16491: 
                   16492: =cut
                   16493: 
                   16494: ############################################################
                   16495: ############################################################
                   16496: sub build_recipient_list {
1.1297    raeburn  16497:     my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618     raeburn  16498:     my @recipients;
1.1270    raeburn  16499:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  16500:     my %domconfig =
1.1270    raeburn  16501:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  16502:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  16503:         if (exists($domconfig{'contacts'}{$mailing})) {
                   16504:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   16505:                 my @contacts = ('adminemail','supportemail');
                   16506:                 foreach my $item (@contacts) {
                   16507:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   16508:                         my $addr = $domconfig{'contacts'}{$item}; 
                   16509:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   16510:                             push(@recipients,$addr);
                   16511:                         }
1.619     raeburn  16512:                     }
1.1270    raeburn  16513:                 }
                   16514:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   16515:                 if ($mailing eq 'helpdeskmail') {
                   16516:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   16517:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   16518:                         my @ok_bccs;
                   16519:                         foreach my $bcc (@bccs) {
                   16520:                             $bcc =~ s/^\s+//g;
                   16521:                             $bcc =~ s/\s+$//g;
                   16522:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   16523:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   16524:                                     push(@ok_bccs,$bcc);
                   16525:                                 }
                   16526:                             }
                   16527:                         }
                   16528:                         if (@ok_bccs > 0) {
                   16529:                             $allbcc = join(', ',@ok_bccs);
                   16530:                         }
                   16531:                     }
                   16532:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  16533:                 }
                   16534:             }
1.766     raeburn  16535:         } elsif ($origmail ne '') {
1.1270    raeburn  16536:             $lastresort = $origmail;
1.618     raeburn  16537:         }
1.1297    raeburn  16538:         if ($mailing eq 'helpdeskmail') {
                   16539:             if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
                   16540:                 (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
                   16541:                 my ($inststatus,$inststatus_checked);
                   16542:                 if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
                   16543:                     ($env{'user.domain'} ne 'public')) {
                   16544:                     $inststatus_checked = 1;
                   16545:                     $inststatus = $env{'environment.inststatus'};
                   16546:                 }
                   16547:                 unless ($inststatus_checked) {
                   16548:                     if (($requname ne '') && ($requdom ne '')) {
                   16549:                         if (($requname =~ /^$match_username$/) &&
                   16550:                             ($requdom =~ /^$match_domain$/) &&
                   16551:                             (&Apache::lonnet::domain($requdom))) {
                   16552:                             my $requhome = &Apache::lonnet::homeserver($requname,
                   16553:                                                                       $requdom);
                   16554:                             unless ($requhome eq 'no_host') {
                   16555:                                 my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
                   16556:                                 $inststatus = $userenv{'inststatus'};
                   16557:                                 $inststatus_checked = 1;
                   16558:                             }
                   16559:                         }
                   16560:                     }
                   16561:                 }
                   16562:                 unless ($inststatus_checked) {
                   16563:                     if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
                   16564:                         my %srch = (srchby     => 'email',
                   16565:                                     srchdomain => $defdom,
                   16566:                                     srchterm   => $reqemail,
                   16567:                                     srchtype   => 'exact');
                   16568:                         my %srch_results = &Apache::lonnet::usersearch(\%srch);
                   16569:                         foreach my $uname (keys(%srch_results)) {
                   16570:                             if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   16571:                                 $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   16572:                                 $inststatus_checked = 1;
                   16573:                                 last;
                   16574:                             }
                   16575:                         }
                   16576:                         unless ($inststatus_checked) {
                   16577:                             my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
                   16578:                             if ($dirsrchres eq 'ok') {
                   16579:                                 foreach my $uname (keys(%srch_results)) {
                   16580:                                     if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   16581:                                         $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   16582:                                         $inststatus_checked = 1;
                   16583:                                         last;
                   16584:                                     }
                   16585:                                 }
                   16586:                             }
                   16587:                         }
                   16588:                     }
                   16589:                 }
                   16590:                 if ($inststatus ne '') {
                   16591:                     foreach my $status (split(/\:/,$inststatus)) {
                   16592:                         if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
                   16593:                             my @contacts = ('adminemail','supportemail');
                   16594:                             foreach my $item (@contacts) {
                   16595:                                 if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
                   16596:                                     my $addr = $domconfig{'contacts'}{'overrides'}{$status};
                   16597:                                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   16598:                                         push(@recipients,$addr);
                   16599:                                     }
                   16600:                                 }
                   16601:                             }
                   16602:                             $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
                   16603:                             if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
                   16604:                                 my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
                   16605:                                 my @ok_bccs;
                   16606:                                 foreach my $bcc (@bccs) {
                   16607:                                     $bcc =~ s/^\s+//g;
                   16608:                                     $bcc =~ s/\s+$//g;
                   16609:                                     if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   16610:                                         if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   16611:                                             push(@ok_bccs,$bcc);
                   16612:                                         }
                   16613:                                     }
                   16614:                                 }
                   16615:                                 if (@ok_bccs > 0) {
                   16616:                                     $allbcc = join(', ',@ok_bccs);
                   16617:                                 }
                   16618:                             }
                   16619:                             $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
                   16620:                             last;
                   16621:                         }
                   16622:                     }
                   16623:                 }
                   16624:             }
                   16625:         }
1.619     raeburn  16626:     } elsif ($origmail ne '') {
1.1270    raeburn  16627:         $lastresort = $origmail;
                   16628:     }
1.1297    raeburn  16629:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270    raeburn  16630:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   16631:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   16632:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   16633:             my %what = (
                   16634:                           perlvar => 1,
                   16635:                        );
                   16636:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   16637:             if ($primary) {
                   16638:                 my $gotaddr;
                   16639:                 my ($result,$returnhash) =
                   16640:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   16641:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   16642:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   16643:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   16644:                         $gotaddr = 1;
                   16645:                     }
                   16646:                 }
                   16647:                 unless ($gotaddr) {
                   16648:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   16649:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   16650:                     unless ($uintdom eq $intdom) {
                   16651:                         my %domconfig =
                   16652:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   16653:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   16654:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   16655:                                 my @contacts = ('adminemail','supportemail');
                   16656:                                 foreach my $item (@contacts) {
                   16657:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   16658:                                         my $addr = $domconfig{'contacts'}{$item};
                   16659:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   16660:                                             push(@recipients,$addr);
                   16661:                                         }
                   16662:                                     }
                   16663:                                 }
                   16664:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   16665:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   16666:                                 }
                   16667:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   16668:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   16669:                                     my @ok_bccs;
                   16670:                                     foreach my $bcc (@bccs) {
                   16671:                                         $bcc =~ s/^\s+//g;
                   16672:                                         $bcc =~ s/\s+$//g;
                   16673:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   16674:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   16675:                                                 push(@ok_bccs,$bcc);
                   16676:                                             }
                   16677:                                         }
                   16678:                                     }
                   16679:                                     if (@ok_bccs > 0) {
                   16680:                                         $allbcc = join(', ',@ok_bccs);
                   16681:                                     }
                   16682:                                 }
                   16683:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   16684:                             }
                   16685:                         }
                   16686:                     }
                   16687:                 }
                   16688:             }
                   16689:         }
1.618     raeburn  16690:     }
1.688     raeburn  16691:     if (defined($defmail)) {
                   16692:         if ($defmail ne '') {
                   16693:             push(@recipients,$defmail);
                   16694:         }
1.618     raeburn  16695:     }
                   16696:     if ($otheremails) {
1.619     raeburn  16697:         my @others;
                   16698:         if ($otheremails =~ /,/) {
                   16699:             @others = split(/,/,$otheremails);
1.618     raeburn  16700:         } else {
1.619     raeburn  16701:             push(@others,$otheremails);
                   16702:         }
                   16703:         foreach my $addr (@others) {
                   16704:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   16705:                 push(@recipients,$addr);
                   16706:             }
1.618     raeburn  16707:         }
                   16708:     }
1.1298    raeburn  16709:     if ($mailing eq 'helpdeskmail') {
1.1270    raeburn  16710:         if ((!@recipients) && ($lastresort ne '')) {
                   16711:             push(@recipients,$lastresort);
                   16712:         }
                   16713:     } elsif ($lastresort ne '') {
                   16714:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   16715:             push(@recipients,$lastresort);
                   16716:         }
                   16717:     }
1.1271    raeburn  16718:     my $recipientlist = join(',',@recipients);
1.1270    raeburn  16719:     if (wantarray) {
                   16720:         return ($recipientlist,$allbcc,$addtext);
                   16721:     } else {
                   16722:         return $recipientlist;
                   16723:     }
1.618     raeburn  16724: }
                   16725: 
1.127     matthew  16726: ############################################################
                   16727: ############################################################
1.154     albertel 16728: 
1.655     raeburn  16729: =pod
                   16730: 
1.1224    musolffc 16731: =over 4
                   16732: 
1.1223    musolffc 16733: =item * &mime_email()
                   16734: 
                   16735: Sends an email with a possible attachment
                   16736: 
                   16737: Inputs:
                   16738: 
                   16739: =over 4
                   16740: 
                   16741: from -              Sender's email address
                   16742: 
1.1343    raeburn  16743: replyto -           Reply-To email address
                   16744: 
1.1223    musolffc 16745: to -                Email address of recipient
                   16746: 
                   16747: subject -           Subject of email
                   16748: 
                   16749: body -              Body of email
                   16750: 
                   16751: cc_string -         Carbon copy email address
                   16752: 
                   16753: bcc -               Blind carbon copy email address
                   16754: 
                   16755: attachment_path -   Path of file to be attached
                   16756: 
                   16757: file_name -         Name of file to be attached
                   16758: 
                   16759: attachment_text -   The body of an attachment of type "TEXT"
                   16760: 
                   16761: =back
                   16762: 
                   16763: =back
                   16764: 
                   16765: =cut
                   16766: 
                   16767: ############################################################
                   16768: ############################################################
                   16769: 
                   16770: sub mime_email {
1.1343    raeburn  16771:     my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path, 
                   16772:         $file_name,$attachment_text) = @_;
                   16773:  
1.1223    musolffc 16774:     my $msg = MIME::Lite->new(
                   16775:              From    => $from,
                   16776:              To      => $to,
                   16777:              Subject => $subject,
                   16778:              Type    =>'TEXT',
                   16779:              Data    => $body,
                   16780:              );
1.1343    raeburn  16781:     if ($replyto ne '') {
                   16782:         $msg->add("Reply-To" => $replyto);
                   16783:     }
1.1223    musolffc 16784:     if ($cc_string ne '') {
                   16785:         $msg->add("Cc" => $cc_string);
                   16786:     }
                   16787:     if ($bcc ne '') {
                   16788:         $msg->add("Bcc" => $bcc);
                   16789:     }
                   16790:     $msg->attr("content-type"         => "text/plain");
                   16791:     $msg->attr("content-type.charset" => "UTF-8");
                   16792:     # Attach file if given
                   16793:     if ($attachment_path) {
                   16794:         unless ($file_name) {
                   16795:             if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
                   16796:         }
                   16797:         my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
                   16798:         $msg->attach(Type     => $type,
                   16799:                      Path     => $attachment_path,
                   16800:                      Filename => $file_name
                   16801:                      );
                   16802:     # Otherwise attach text if given
                   16803:     } elsif ($attachment_text) {
                   16804:         $msg->attach(Type => 'TEXT',
                   16805:                      Data => $attachment_text);
                   16806:     }
                   16807:     # Send it
                   16808:     $msg->send('sendmail');
                   16809: }
                   16810: 
                   16811: ############################################################
                   16812: ############################################################
                   16813: 
                   16814: =pod
                   16815: 
1.655     raeburn  16816: =head1 Course Catalog Routines
                   16817: 
                   16818: =over 4
                   16819: 
                   16820: =item * &gather_categories()
                   16821: 
                   16822: Converts category definitions - keys of categories hash stored in  
                   16823: coursecategories in configuration.db on the primary library server in a 
                   16824: domain - to an array.  Also generates javascript and idx hash used to 
                   16825: generate Domain Coordinator interface for editing Course Categories.
                   16826: 
                   16827: Inputs:
1.663     raeburn  16828: 
1.655     raeburn  16829: categories (reference to hash of category definitions).
1.663     raeburn  16830: 
1.655     raeburn  16831: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   16832:       categories and subcategories).
1.663     raeburn  16833: 
1.655     raeburn  16834: idx (reference to hash of counters used in Domain Coordinator interface for 
                   16835:       editing Course Categories).
1.663     raeburn  16836: 
1.655     raeburn  16837: jsarray (reference to array of categories used to create Javascript arrays for
                   16838:          Domain Coordinator interface for editing Course Categories).
                   16839: 
                   16840: Returns: nothing
                   16841: 
                   16842: Side effects: populates cats, idx and jsarray. 
                   16843: 
                   16844: =cut
                   16845: 
                   16846: sub gather_categories {
                   16847:     my ($categories,$cats,$idx,$jsarray) = @_;
                   16848:     my %counters;
                   16849:     my $num = 0;
                   16850:     foreach my $item (keys(%{$categories})) {
                   16851:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   16852:         if ($container eq '' && $depth == 0) {
                   16853:             $cats->[$depth][$categories->{$item}] = $cat;
                   16854:         } else {
                   16855:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   16856:         }
                   16857:         my ($escitem,$tail) = split(/:/,$item,2);
                   16858:         if ($counters{$tail} eq '') {
                   16859:             $counters{$tail} = $num;
                   16860:             $num ++;
                   16861:         }
                   16862:         if (ref($idx) eq 'HASH') {
                   16863:             $idx->{$item} = $counters{$tail};
                   16864:         }
                   16865:         if (ref($jsarray) eq 'ARRAY') {
                   16866:             push(@{$jsarray->[$counters{$tail}]},$item);
                   16867:         }
                   16868:     }
                   16869:     return;
                   16870: }
                   16871: 
                   16872: =pod
                   16873: 
                   16874: =item * &extract_categories()
                   16875: 
                   16876: Used to generate breadcrumb trails for course categories.
                   16877: 
                   16878: Inputs:
1.663     raeburn  16879: 
1.655     raeburn  16880: categories (reference to hash of category definitions).
1.663     raeburn  16881: 
1.655     raeburn  16882: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   16883:       categories and subcategories).
1.663     raeburn  16884: 
1.655     raeburn  16885: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  16886: 
1.655     raeburn  16887: allitems (reference to hash - key is category key 
                   16888:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  16889: 
1.655     raeburn  16890: idx (reference to hash of counters used in Domain Coordinator interface for
                   16891:       editing Course Categories).
1.663     raeburn  16892: 
1.655     raeburn  16893: jsarray (reference to array of categories used to create Javascript arrays for
                   16894:          Domain Coordinator interface for editing Course Categories).
                   16895: 
1.665     raeburn  16896: subcats (reference to hash of arrays containing all subcategories within each 
                   16897:          category, -recursive)
                   16898: 
1.1321    raeburn  16899: maxd (reference to hash used to hold max depth for all top-level categories).
                   16900: 
1.655     raeburn  16901: Returns: nothing
                   16902: 
                   16903: Side effects: populates trails and allitems hash references.
                   16904: 
                   16905: =cut
                   16906: 
                   16907: sub extract_categories {
1.1321    raeburn  16908:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655     raeburn  16909:     if (ref($categories) eq 'HASH') {
                   16910:         &gather_categories($categories,$cats,$idx,$jsarray);
                   16911:         if (ref($cats->[0]) eq 'ARRAY') {
                   16912:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   16913:                 my $name = $cats->[0][$i];
                   16914:                 my $item = &escape($name).'::0';
                   16915:                 my $trailstr;
                   16916:                 if ($name eq 'instcode') {
                   16917:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  16918:                 } elsif ($name eq 'communities') {
                   16919:                     $trailstr = &mt('Communities');
1.1239    raeburn  16920:                 } elsif ($name eq 'placement') {
                   16921:                     $trailstr = &mt('Placement Tests');
1.655     raeburn  16922:                 } else {
                   16923:                     $trailstr = $name;
                   16924:                 }
                   16925:                 if ($allitems->{$item} eq '') {
                   16926:                     push(@{$trails},$trailstr);
                   16927:                     $allitems->{$item} = scalar(@{$trails})-1;
                   16928:                 }
                   16929:                 my @parents = ($name);
                   16930:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   16931:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   16932:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  16933:                         if (ref($subcats) eq 'HASH') {
                   16934:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   16935:                         }
1.1321    raeburn  16936:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665     raeburn  16937:                     }
                   16938:                 } else {
                   16939:                     if (ref($subcats) eq 'HASH') {
                   16940:                         $subcats->{$item} = [];
1.655     raeburn  16941:                     }
1.1321    raeburn  16942:                     if (ref($maxd) eq 'HASH') {
                   16943:                         $maxd->{$name} = 1;
                   16944:                     }
1.655     raeburn  16945:                 }
                   16946:             }
                   16947:         }
                   16948:     }
                   16949:     return;
                   16950: }
                   16951: 
                   16952: =pod
                   16953: 
1.1162    raeburn  16954: =item * &recurse_categories()
1.655     raeburn  16955: 
                   16956: Recursively used to generate breadcrumb trails for course categories.
                   16957: 
                   16958: Inputs:
1.663     raeburn  16959: 
1.655     raeburn  16960: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   16961:       categories and subcategories).
1.663     raeburn  16962: 
1.655     raeburn  16963: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  16964: 
                   16965: category (current course category, for which breadcrumb trail is being generated).
                   16966: 
                   16967: trails (reference to array of breadcrumb trails for each category).
                   16968: 
1.655     raeburn  16969: allitems (reference to hash - key is category key
                   16970:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  16971: 
1.655     raeburn  16972: parents (array containing containers directories for current category, 
                   16973:          back to top level). 
                   16974: 
                   16975: Returns: nothing
                   16976: 
                   16977: Side effects: populates trails and allitems hash references
                   16978: 
                   16979: =cut
                   16980: 
                   16981: sub recurse_categories {
1.1321    raeburn  16982:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655     raeburn  16983:     my $shallower = $depth - 1;
                   16984:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   16985:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   16986:             my $name = $cats->[$depth]{$category}[$k];
                   16987:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321    raeburn  16988:             my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  16989:             if ($allitems->{$item} eq '') {
                   16990:                 push(@{$trails},$trailstr);
                   16991:                 $allitems->{$item} = scalar(@{$trails})-1;
                   16992:             }
                   16993:             my $deeper = $depth+1;
                   16994:             push(@{$parents},$category);
1.665     raeburn  16995:             if (ref($subcats) eq 'HASH') {
                   16996:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   16997:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   16998:                     my $higher;
                   16999:                     if ($j > 0) {
                   17000:                         $higher = &escape($parents->[$j]).':'.
                   17001:                                   &escape($parents->[$j-1]).':'.$j;
                   17002:                     } else {
                   17003:                         $higher = &escape($parents->[$j]).'::'.$j;
                   17004:                     }
                   17005:                     push(@{$subcats->{$higher}},$subcat);
                   17006:                 }
                   17007:             }
                   17008:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321    raeburn  17009:                                 $subcats,$maxd);
1.655     raeburn  17010:             pop(@{$parents});
                   17011:         }
                   17012:     } else {
                   17013:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321    raeburn  17014:         my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  17015:         if ($allitems->{$item} eq '') {
                   17016:             push(@{$trails},$trailstr);
                   17017:             $allitems->{$item} = scalar(@{$trails})-1;
                   17018:         }
1.1321    raeburn  17019:         if (ref($maxd) eq 'HASH') {
                   17020:             if ($depth > $maxd->{$parents->[0]}) {
                   17021:                 $maxd->{$parents->[0]} = $depth;
                   17022:             }
                   17023:         }
1.655     raeburn  17024:     }
                   17025:     return;
                   17026: }
                   17027: 
1.663     raeburn  17028: =pod
                   17029: 
1.1162    raeburn  17030: =item * &assign_categories_table()
1.663     raeburn  17031: 
                   17032: Create a datatable for display of hierarchical categories in a domain,
                   17033: with checkboxes to allow a course to be categorized. 
                   17034: 
                   17035: Inputs:
                   17036: 
                   17037: cathash - reference to hash of categories defined for the domain (from
                   17038:           configuration.db)
                   17039: 
                   17040: currcat - scalar with an & separated list of categories assigned to a course. 
                   17041: 
1.919     raeburn  17042: type    - scalar contains course type (Course or Community).
                   17043: 
1.1260    raeburn  17044: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   17045:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   17046: 
1.663     raeburn  17047: Returns: $output (markup to be displayed) 
                   17048: 
                   17049: =cut
                   17050: 
                   17051: sub assign_categories_table {
1.1259    raeburn  17052:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  17053:     my $output;
                   17054:     if (ref($cathash) eq 'HASH') {
1.1321    raeburn  17055:         my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
                   17056:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663     raeburn  17057:         $maxdepth = scalar(@cats);
                   17058:         if (@cats > 0) {
                   17059:             my $itemcount = 0;
                   17060:             if (ref($cats[0]) eq 'ARRAY') {
                   17061:                 my @currcategories;
                   17062:                 if ($currcat ne '') {
                   17063:                     @currcategories = split('&',$currcat);
                   17064:                 }
1.919     raeburn  17065:                 my $table;
1.663     raeburn  17066:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   17067:                     my $parent = $cats[0][$i];
1.919     raeburn  17068:                     next if ($parent eq 'instcode');
                   17069:                     if ($type eq 'Community') {
                   17070:                         next unless ($parent eq 'communities');
1.1239    raeburn  17071:                     } elsif ($type eq 'Placement') {
                   17072:                         next unless ($parent eq 'placement');
1.919     raeburn  17073:                     } else {
1.1239    raeburn  17074:                         next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919     raeburn  17075:                     }
1.663     raeburn  17076:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   17077:                     my $item = &escape($parent).'::0';
                   17078:                     my $checked = '';
                   17079:                     if (@currcategories > 0) {
                   17080:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   17081:                             $checked = ' checked="checked"';
1.663     raeburn  17082:                         }
                   17083:                     }
1.919     raeburn  17084:                     my $parent_title = $parent;
                   17085:                     if ($parent eq 'communities') {
                   17086:                         $parent_title = &mt('Communities');
1.1239    raeburn  17087:                     } elsif ($parent eq 'placement') {
                   17088:                         $parent_title = &mt('Placement Tests');
1.919     raeburn  17089:                     }
                   17090:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   17091:                               '<input type="checkbox" name="usecategory" value="'.
1.1259    raeburn  17092:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  17093:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  17094:                     my $depth = 1;
                   17095:                     push(@path,$parent);
1.1259    raeburn  17096:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  17097:                     pop(@path);
1.919     raeburn  17098:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  17099:                     $itemcount ++;
                   17100:                 }
1.919     raeburn  17101:                 if ($itemcount) {
                   17102:                     $output = &Apache::loncommon::start_data_table().
                   17103:                               $table.
                   17104:                               &Apache::loncommon::end_data_table();
                   17105:                 }
1.663     raeburn  17106:             }
                   17107:         }
                   17108:     }
                   17109:     return $output;
                   17110: }
                   17111: 
                   17112: =pod
                   17113: 
1.1162    raeburn  17114: =item * &assign_category_rows()
1.663     raeburn  17115: 
                   17116: Create a datatable row for display of nested categories in a domain,
                   17117: with checkboxes to allow a course to be categorized,called recursively.
                   17118: 
                   17119: Inputs:
                   17120: 
                   17121: itemcount - track row number for alternating colors
                   17122: 
                   17123: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   17124:       categories and subcategories.
                   17125: 
                   17126: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   17127: 
                   17128: parent - parent of current category item
                   17129: 
                   17130: path - Array containing all categories back up through the hierarchy from the
                   17131:        current category to the top level.
                   17132: 
                   17133: currcategories - reference to array of current categories assigned to the course
                   17134: 
1.1260    raeburn  17135: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   17136:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   17137: 
1.663     raeburn  17138: Returns: $output (markup to be displayed).
                   17139: 
                   17140: =cut
                   17141: 
                   17142: sub assign_category_rows {
1.1259    raeburn  17143:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  17144:     my ($text,$name,$item,$chgstr);
                   17145:     if (ref($cats) eq 'ARRAY') {
                   17146:         my $maxdepth = scalar(@{$cats});
                   17147:         if (ref($cats->[$depth]) eq 'HASH') {
                   17148:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   17149:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   17150:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145    raeburn  17151:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  17152:                 for (my $j=0; $j<$numchildren; $j++) {
                   17153:                     $name = $cats->[$depth]{$parent}[$j];
                   17154:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   17155:                     my $deeper = $depth+1;
                   17156:                     my $checked = '';
                   17157:                     if (ref($currcategories) eq 'ARRAY') {
                   17158:                         if (@{$currcategories} > 0) {
                   17159:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   17160:                                 $checked = ' checked="checked"';
1.663     raeburn  17161:                             }
                   17162:                         }
                   17163:                     }
1.664     raeburn  17164:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   17165:                              '<input type="checkbox" name="usecategory" value="'.
1.1259    raeburn  17166:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  17167:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   17168:                              '</td><td>';
1.663     raeburn  17169:                     if (ref($path) eq 'ARRAY') {
                   17170:                         push(@{$path},$name);
1.1259    raeburn  17171:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  17172:                         pop(@{$path});
                   17173:                     }
                   17174:                     $text .= '</td></tr>';
                   17175:                 }
                   17176:                 $text .= '</table></td>';
                   17177:             }
                   17178:         }
                   17179:     }
                   17180:     return $text;
                   17181: }
                   17182: 
1.1181    raeburn  17183: =pod
                   17184: 
                   17185: =back
                   17186: 
                   17187: =cut
                   17188: 
1.655     raeburn  17189: ############################################################
                   17190: ############################################################
                   17191: 
                   17192: 
1.443     albertel 17193: sub commit_customrole {
1.1408    raeburn  17194:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399    raeburn  17195:     my $result = &Apache::lonnet::assigncustomrole(
1.1408    raeburn  17196:                      $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
                   17197:                      $context,$othdomby,$requester);
1.630     raeburn  17198:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 17199:                          ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399    raeburn  17200:                          ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
                   17201:     if (wantarray) {
                   17202:         return ($output,$result);
                   17203:     } else {
                   17204:         return $output;
                   17205:     }
1.443     albertel 17206: }
                   17207: 
                   17208: sub commit_standardrole {
1.1408    raeburn  17209:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
                   17210:         $othdomby,$requester) = @_;
1.1399    raeburn  17211:     my ($output,$logmsg,$linefeed,$result);
1.541     raeburn  17212:     if ($context eq 'auto') {
                   17213:         $linefeed = "\n";
                   17214:     } else {
                   17215:         $linefeed = "<br />\n";
                   17216:     }  
1.443     albertel 17217:     if ($three eq 'st') {
1.1399    raeburn  17218:         $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408    raeburn  17219:                                       $one,$two,$sec,$context,$credits,$othdomby,
                   17220:                                       $requester);
1.541     raeburn  17221:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  17222:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   17223:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 17224:         } else {
1.541     raeburn  17225:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 17226:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  17227:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   17228:             if ($context eq 'auto') {
                   17229:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   17230:             } else {
                   17231:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   17232:                &mt('Add to classlist').': <b>ok</b>';
                   17233:             }
                   17234:             $output .= $linefeed;
1.443     albertel 17235:         }
                   17236:     } else {
                   17237:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   17238:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  17239:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408    raeburn  17240:         $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
                   17241:                                               '','',$context,$othdomby,$requester);
1.541     raeburn  17242:         if ($context eq 'auto') {
                   17243:             $output .= $result.$linefeed;
                   17244:         } else {
                   17245:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   17246:         }
1.443     albertel 17247:     }
1.1399    raeburn  17248:     if (wantarray) {
                   17249:         return ($output,$result);
                   17250:     } else {
                   17251:         return $output;
                   17252:     }
1.443     albertel 17253: }
                   17254: 
                   17255: sub commit_studentrole {
1.1116    raeburn  17256:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408    raeburn  17257:         $credits,$othdomby,$requester) = @_;
1.626     raeburn  17258:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  17259:     if ($context eq 'auto') {
                   17260:         $linefeed = "\n";
                   17261:     } else {
                   17262:         $linefeed = '<br />'."\n";
                   17263:     }
1.443     albertel 17264:     if (defined($one) && defined($two)) {
                   17265:         my $cid=$one.'_'.$two;
                   17266:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   17267:         my $secchange = 0;
                   17268:         my $expire_role_result;
                   17269:         my $modify_section_result;
1.628     raeburn  17270:         if ($oldsec ne '-1') { 
                   17271:             if ($oldsec ne $sec) {
1.443     albertel 17272:                 $secchange = 1;
1.628     raeburn  17273:                 my $now = time;
1.443     albertel 17274:                 my $uurl='/'.$cid;
                   17275:                 $uurl=~s/\_/\//g;
                   17276:                 if ($oldsec) {
                   17277:                     $uurl.='/'.$oldsec;
                   17278:                 }
1.626     raeburn  17279:                 $oldsecurl = $uurl;
1.628     raeburn  17280:                 $expire_role_result = 
1.1408    raeburn  17281:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
                   17282:                                                 '','','',$context,$othdomby,$requester);
                   17283:                 if ($env{'request.course.sec'} ne '') {
1.628     raeburn  17284:                     if ($expire_role_result eq 'refused') {
                   17285:                         my @roles = ('st');
                   17286:                         my @statuses = ('previous');
                   17287:                         my @roledoms = ($one);
                   17288:                         my $withsec = 1;
                   17289:                         my %roleshash = 
                   17290:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   17291:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   17292:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   17293:                             my ($oldstart,$oldend) = 
                   17294:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   17295:                             if ($oldend > 0 && $oldend <= $now) {
                   17296:                                 $expire_role_result = 'ok';
                   17297:                             }
                   17298:                         }
                   17299:                     }
                   17300:                 }
1.443     albertel 17301:                 $result = $expire_role_result;
                   17302:             }
                   17303:         }
                   17304:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116    raeburn  17305:             $modify_section_result = 
                   17306:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   17307:                                                            undef,undef,undef,$sec,
                   17308:                                                            $end,$start,'','',$cid,
1.1408    raeburn  17309:                                                            '',$context,$credits,'',
                   17310:                                                            $othdomby,$requester);
1.443     albertel 17311:             if ($modify_section_result =~ /^ok/) {
                   17312:                 if ($secchange == 1) {
1.628     raeburn  17313:                     if ($sec eq '') {
                   17314:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   17315:                     } else {
                   17316:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   17317:                     }
1.443     albertel 17318:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  17319:                     if ($sec eq '') {
                   17320:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   17321:                     } else {
                   17322:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   17323:                     }
1.443     albertel 17324:                 } else {
1.628     raeburn  17325:                     if ($sec eq '') {
                   17326:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   17327:                     } else {
                   17328:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   17329:                     }
1.443     albertel 17330:                 }
                   17331:             } else {
1.1115    raeburn  17332:                 if ($secchange) { 
1.628     raeburn  17333:                     $$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;
                   17334:                 } else {
                   17335:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   17336:                 }
1.443     albertel 17337:             }
                   17338:             $result = $modify_section_result;
                   17339:         } elsif ($secchange == 1) {
1.628     raeburn  17340:             if ($oldsec eq '') {
1.1103    raeburn  17341:                 $$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  17342:             } else {
                   17343:                 $$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;
                   17344:             }
1.626     raeburn  17345:             if ($expire_role_result eq 'refused') {
                   17346:                 my $newsecurl = '/'.$cid;
                   17347:                 $newsecurl =~ s/\_/\//g;
                   17348:                 if ($sec ne '') {
                   17349:                     $newsecurl.='/'.$sec;
                   17350:                 }
                   17351:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   17352:                     if ($sec eq '') {
                   17353:                         $$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;
                   17354:                     } else {
                   17355:                         $$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;
                   17356:                     }
                   17357:                 }
                   17358:             }
1.443     albertel 17359:         }
                   17360:     } else {
1.626     raeburn  17361:         $$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 17362:         $result = "error: incomplete course id\n";
                   17363:     }
                   17364:     return $result;
                   17365: }
                   17366: 
1.1108    raeburn  17367: sub show_role_extent {
                   17368:     my ($scope,$context,$role) = @_;
                   17369:     $scope =~ s{^/}{};
                   17370:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   17371:     push(@courseroles,'co');
                   17372:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   17373:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   17374:         $scope =~ s{/}{_};
                   17375:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   17376:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   17377:         my ($audom,$auname) = split(/\//,$scope);
                   17378:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   17379:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   17380:     } else {
                   17381:         $scope =~ s{/$}{};
                   17382:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   17383:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   17384:     }
                   17385: }
                   17386: 
1.443     albertel 17387: ############################################################
                   17388: ############################################################
                   17389: 
1.566     albertel 17390: sub check_clone {
1.578     raeburn  17391:     my ($args,$linefeed) = @_;
1.566     albertel 17392:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   17393:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   17394:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344    raeburn  17395:     my $clonetitle;
                   17396:     my @clonemsg;
1.566     albertel 17397:     my $can_clone = 0;
1.944     raeburn  17398:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  17399:     if ($lctype ne 'community') {
                   17400:         $lctype = 'course';
                   17401:     }
1.566     albertel 17402:     if ($clonehome eq 'no_host') {
1.944     raeburn  17403:         if ($args->{'crstype'} eq 'Community') {
1.1344    raeburn  17404:             push(@clonemsg,({
                   17405:                               mt => 'No new community created.',
                   17406:                               args => [],
                   17407:                             },
                   17408:                             {
                   17409:                               mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
                   17410:                               args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
                   17411:                             }));
1.908     raeburn  17412:         } else {
1.1344    raeburn  17413:             push(@clonemsg,({
                   17414:                               mt => 'No new course created.',
                   17415:                               args => [],
                   17416:                             },
                   17417:                             {
                   17418:                               mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
                   17419:                               args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   17420:                             }));
                   17421:         }
1.566     albertel 17422:     } else {
                   17423: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344    raeburn  17424:         $clonetitle = $clonedesc{'description'};
1.944     raeburn  17425:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  17426:             if ($clonedesc{'type'} ne 'Community') {
1.1344    raeburn  17427:                 push(@clonemsg,({
                   17428:                                   mt => 'No new community created.',
                   17429:                                   args => [],
                   17430:                                 },
                   17431:                                 {
                   17432:                                   mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
                   17433:                                   args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   17434:                                 }));
                   17435:                 return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908     raeburn  17436:             }
                   17437:         }
1.1262    raeburn  17438: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  17439:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 17440: 	    $can_clone = 1;
                   17441: 	} else {
1.1221    raeburn  17442: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 17443: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1221    raeburn  17444:             if ($clonehash{'cloners'} eq '') {
                   17445:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   17446:                 if ($domdefs{'canclone'}) {
                   17447:                     unless ($domdefs{'canclone'} eq 'none') {
                   17448:                         if ($domdefs{'canclone'} eq 'domain') {
                   17449:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   17450:                                 $can_clone = 1;
                   17451:                             }
                   17452:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) && 
                   17453:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   17454:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   17455:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   17456:                                 $can_clone = 1;
                   17457:                             }
                   17458:                         }
                   17459:                     }
                   17460:                 }
1.578     raeburn  17461:             } else {
1.1221    raeburn  17462: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   17463:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  17464:                     $can_clone = 1;
1.1221    raeburn  17465:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  17466:                     $can_clone = 1;
1.1225    raeburn  17467:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   17468:                     $can_clone = 1;
1.1221    raeburn  17469:                 }
                   17470:                 unless ($can_clone) {
1.1225    raeburn  17471:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) && 
                   17472:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1221    raeburn  17473:                         my (%gotdomdefaults,%gotcodedefaults);
                   17474:                         foreach my $cloner (@cloners) {
                   17475:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   17476:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   17477:                                 my (%codedefaults,@code_order);
                   17478:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   17479:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   17480:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   17481:                                     }
                   17482:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   17483:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   17484:                                     }
                   17485:                                 } else {
                   17486:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   17487:                                                                             \%codedefaults,
                   17488:                                                                             \@code_order);
                   17489:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   17490:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   17491:                                 }
                   17492:                                 if (@code_order > 0) {
                   17493:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   17494:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   17495:                                                                                 $args->{'crscode'})) {
                   17496:                                         $can_clone = 1;
                   17497:                                         last;
                   17498:                                     }
                   17499:                                 }
                   17500:                             }
                   17501:                         }
                   17502:                     }
1.1225    raeburn  17503:                 }
                   17504:             }
                   17505:             unless ($can_clone) {
                   17506:                 my $ccrole = 'cc';
                   17507:                 if ($args->{'crstype'} eq 'Community') {
                   17508:                     $ccrole = 'co';
                   17509:                 }
                   17510: 	        my %roleshash =
                   17511: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   17512: 					          $args->{'ccdomain'},
                   17513:                                                   'userroles',['active'],[$ccrole],
                   17514: 					          [$args->{'clonedomain'}]);
                   17515: 	        if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   17516:                     $can_clone = 1;
                   17517:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   17518:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   17519:                     $can_clone = 1;
1.1221    raeburn  17520:                 }
                   17521:             }
                   17522:             unless ($can_clone) {
                   17523:                 if ($args->{'crstype'} eq 'Community') {
1.1344    raeburn  17524:                     push(@clonemsg,({
                   17525:                                       mt => 'No new community created.',
                   17526:                                       args => [],
                   17527:                                     },
                   17528:                                     {
                   17529:                                       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]).',
                   17530:                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   17531:                                     }));
1.942     raeburn  17532:                 } else {
1.1344    raeburn  17533:                     push(@clonemsg,({
                   17534:                                       mt => 'No new course created.',
                   17535:                                       args => [],
                   17536:                                     },
                   17537:                                     {
                   17538:                                       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]).',
                   17539:                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   17540:                                     }));
1.1221    raeburn  17541:                 }
1.566     albertel 17542: 	    }
1.578     raeburn  17543:         }
1.566     albertel 17544:     }
1.1344    raeburn  17545:     return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566     albertel 17546: }
                   17547: 
1.444     albertel 17548: sub construct_course {
1.1262    raeburn  17549:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344    raeburn  17550:         $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
                   17551:     my ($outcome,$msgref,$clonemsgref);
1.541     raeburn  17552:     my $linefeed =  '<br />'."\n";
                   17553:     if ($context eq 'auto') {
                   17554:         $linefeed = "\n";
                   17555:     }
1.566     albertel 17556: 
                   17557: #
                   17558: # Are we cloning?
                   17559: #
1.1344    raeburn  17560:     my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566     albertel 17561:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344    raeburn  17562: 	($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566     albertel 17563:         if (!$can_clone) {
1.1344    raeburn  17564: 	    return (0,$outcome,$clonemsgref);
1.566     albertel 17565: 	}
                   17566:     }
                   17567: 
1.444     albertel 17568: #
                   17569: # Open course
                   17570: #
1.1239    raeburn  17571:     my $showncrstype;
                   17572:     if ($args->{'crstype'} eq 'Placement') {
                   17573:         $showncrstype = 'placement test'; 
                   17574:     } else {  
                   17575:         $showncrstype = lc($args->{'crstype'});
                   17576:     }
1.444     albertel 17577:     my %cenv=();
                   17578:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   17579:                                              $args->{'cdescr'},
                   17580:                                              $args->{'curl'},
                   17581:                                              $args->{'course_home'},
                   17582:                                              $args->{'nonstandard'},
                   17583:                                              $args->{'crscode'},
                   17584:                                              $args->{'ccuname'}.':'.
                   17585:                                              $args->{'ccdomain'},
1.882     raeburn  17586:                                              $args->{'crstype'},
1.1344    raeburn  17587:                                              $cnum,$context,$category,
                   17588:                                              $callercontext);
1.444     albertel 17589: 
                   17590:     # Note: The testing routines depend on this being output; see 
                   17591:     # Utils::Course. This needs to at least be output as a comment
                   17592:     # if anyone ever decides to not show this, and Utils::Course::new
                   17593:     # will need to be suitably modified.
1.1344    raeburn  17594:     if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   17595:         $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
                   17596:     } else {
                   17597:         $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
                   17598:     }
1.943     raeburn  17599:     if ($$courseid =~ /^error:/) {
1.1344    raeburn  17600:         return (0,$outcome,$clonemsgref);
1.943     raeburn  17601:     }
                   17602: 
1.444     albertel 17603: #
                   17604: # Check if created correctly
                   17605: #
1.479     albertel 17606:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 17607:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  17608:     if ($crsuhome eq 'no_host') {
1.1344    raeburn  17609:         if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   17610:             $outcome .= &mt_user($user_lh,
                   17611:                             'Course creation failed, unrecognized course home server.');
                   17612:         } else {
                   17613:             $outcome .= &mt('Course creation failed, unrecognized course home server.');
                   17614:         }
                   17615:         $outcome .= $linefeed;
                   17616:         return (0,$outcome,$clonemsgref);
1.943     raeburn  17617:     }
1.541     raeburn  17618:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 17619: 
1.444     albertel 17620: #
1.566     albertel 17621: # Do the cloning
                   17622: #   
1.1344    raeburn  17623:     my @clonemsg;
1.566     albertel 17624:     if ($can_clone && $cloneid) {
1.1344    raeburn  17625:         push(@clonemsg,
                   17626:                       {
                   17627:                           mt => 'Created [_1] by cloning from [_2]',
                   17628:                           args => [$showncrstype,$clonetitle],
                   17629:                       });
1.566     albertel 17630: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 17631: # Copy all files
1.1344    raeburn  17632:         my @info =
                   17633: 	    &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
                   17634: 	                                             $args->{'dateshift'},$args->{'crscode'},
                   17635:                                                      $args->{'ccuname'}.':'.$args->{'ccdomain'},
                   17636:                                                      $args->{'tinyurls'});
                   17637:         if (@info) {
                   17638:             push(@clonemsg,@info);
                   17639:         }
1.444     albertel 17640: # Restore URL
1.566     albertel 17641: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 17642: # Restore title
1.566     albertel 17643: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  17644: # Restore creation date, creator and creation context.
                   17645:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   17646:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   17647:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 17648: # Mark as cloned
1.566     albertel 17649: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      17650: # Need to clone grading mode
                   17651:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   17652:         $cenv{'grading'}=$newenv{'grading'};
                   17653: # Do not clone these environment entries
                   17654:         &Apache::lonnet::del('environment',
                   17655:                   ['default_enrollment_start_date',
                   17656:                    'default_enrollment_end_date',
                   17657:                    'question.email',
                   17658:                    'policy.email',
                   17659:                    'comment.email',
                   17660:                    'pch.users.denied',
1.725     raeburn  17661:                    'plc.users.denied',
                   17662:                    'hidefromcat',
1.1121    raeburn  17663:                    'checkforpriv',
1.1355    raeburn  17664:                    'categories'],
1.638     www      17665:                    $$crsudom,$$crsunum);
1.1170    raeburn  17666:         if ($args->{'textbook'}) {
                   17667:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   17668:         }
1.444     albertel 17669:     }
1.566     albertel 17670: 
1.444     albertel 17671: #
                   17672: # Set environment (will override cloned, if existing)
                   17673: #
                   17674:     my @sections = ();
                   17675:     my @xlists = ();
                   17676:     if ($args->{'crstype'}) {
                   17677:         $cenv{'type'}=$args->{'crstype'};
                   17678:     }
1.1371    raeburn  17679:     if ($args->{'lti'}) {
                   17680:         $cenv{'internal.lti'}=$args->{'lti'};
                   17681:     }
1.444     albertel 17682:     if ($args->{'crsid'}) {
                   17683:         $cenv{'courseid'}=$args->{'crsid'};
                   17684:     }
                   17685:     if ($args->{'crscode'}) {
                   17686:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   17687:     }
                   17688:     if ($args->{'crsquota'} ne '') {
                   17689:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   17690:     } else {
                   17691:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   17692:     }
                   17693:     if ($args->{'ccuname'}) {
                   17694:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   17695:                                         ':'.$args->{'ccdomain'};
                   17696:     } else {
                   17697:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   17698:     }
1.1116    raeburn  17699:     if ($args->{'defaultcredits'}) {
                   17700:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   17701:     }
1.444     albertel 17702:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412    raeburn  17703:     my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444     albertel 17704:     if ($args->{'crssections'}) {
                   17705:         $cenv{'internal.sectionnums'} = '';
                   17706:         if ($args->{'crssections'} =~ m/,/) {
                   17707:             @sections = split/,/,$args->{'crssections'};
                   17708:         } else {
                   17709:             $sections[0] = $args->{'crssections'};
                   17710:         }
                   17711:         if (@sections > 0) {
                   17712:             foreach my $item (@sections) {
                   17713:                 my ($sec,$gp) = split/:/,$item;
                   17714:                 my $class = $args->{'crscode'}.$sec;
                   17715:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   17716:                 $cenv{'internal.sectionnums'} .= $item.',';
1.1412    raeburn  17717:                 if ($addcheck eq 'ok') {
                   17718:                     unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
                   17719:                         push(@oklcsecs,$gp);
                   17720:                     }
                   17721:                 } else {
1.1263    raeburn  17722:                     push(@badclasses,$class);
1.444     albertel 17723:                 }
                   17724:             }
                   17725:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   17726:         }
                   17727:     }
                   17728: # do not hide course coordinator from staff listing, 
                   17729: # even if privileged
                   17730:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121    raeburn  17731: # add course coordinator's domain to domains to check for privileged users
                   17732: # if different to course domain
                   17733:     if ($$crsudom ne $args->{'ccdomain'}) {
                   17734:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   17735:     }
1.444     albertel 17736: # add crosslistings
                   17737:     if ($args->{'crsxlist'}) {
                   17738:         $cenv{'internal.crosslistings'}='';
                   17739:         if ($args->{'crsxlist'} =~ m/,/) {
                   17740:             @xlists = split/,/,$args->{'crsxlist'};
                   17741:         } else {
                   17742:             $xlists[0] = $args->{'crsxlist'};
                   17743:         }
                   17744:         if (@xlists > 0) {
                   17745:             foreach my $item (@xlists) {
                   17746:                 my ($xl,$gp) = split/:/,$item;
                   17747:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   17748:                 $cenv{'internal.crosslistings'} .= $item.',';
1.1412    raeburn  17749:                 if ($addcheck eq 'ok') {
                   17750:                     unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
                   17751:                         push(@oklcsecs,$gp);
                   17752:                     }
                   17753:                 } else {
1.1263    raeburn  17754:                     push(@badclasses,$xl);
1.444     albertel 17755:                 }
                   17756:             }
                   17757:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   17758:         }
                   17759:     }
                   17760:     if ($args->{'autoadds'}) {
                   17761:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   17762:     }
                   17763:     if ($args->{'autodrops'}) {
                   17764:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   17765:     }
                   17766: # check for notification of enrollment changes
                   17767:     my @notified = ();
                   17768:     if ($args->{'notify_owner'}) {
                   17769:         if ($args->{'ccuname'} ne '') {
                   17770:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   17771:         }
                   17772:     }
                   17773:     if ($args->{'notify_dc'}) {
                   17774:         if ($uname ne '') { 
1.630     raeburn  17775:             push(@notified,$uname.':'.$udom);
1.444     albertel 17776:         }
                   17777:     }
                   17778:     if (@notified > 0) {
                   17779:         my $notifylist;
                   17780:         if (@notified > 1) {
                   17781:             $notifylist = join(',',@notified);
                   17782:         } else {
                   17783:             $notifylist = $notified[0];
                   17784:         }
                   17785:         $cenv{'internal.notifylist'} = $notifylist;
                   17786:     }
                   17787:     if (@badclasses > 0) {
                   17788:         my %lt=&Apache::lonlocal::texthash(
1.1264    raeburn  17789:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   17790:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   17791:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 17792:         );
1.1264    raeburn  17793:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   17794:                            &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  17795:         if ($context eq 'auto') {
                   17796:             $outcome .= $badclass_msg.$linefeed;
1.1261    raeburn  17797:         } else {
1.566     albertel 17798:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261    raeburn  17799:         }
                   17800:         foreach my $item (@badclasses) {
1.541     raeburn  17801:             if ($context eq 'auto') {
1.1261    raeburn  17802:                 $outcome .= " - $item\n";
1.541     raeburn  17803:             } else {
1.1261    raeburn  17804:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  17805:             }
1.1261    raeburn  17806:         }
                   17807:         if ($context eq 'auto') {
                   17808:             $outcome .= $linefeed;
                   17809:         } else {
                   17810:             $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  17811:         } 
1.444     albertel 17812:     }
                   17813:     if ($args->{'no_end_date'}) {
                   17814:         $args->{'endaccess'} = 0;
                   17815:     }
1.1412    raeburn  17816: #  If an official course with institutional sections is created by cloning 
                   17817: #  an existing course, section-specific hiding of course totals in student's
                   17818: #  view of grades as copied from cloned course, will be checked for valid 
                   17819: #  sections.
                   17820:     if (($can_clone && $cloneid) &&
                   17821:         ($cenv{'internal.coursecode'} ne '') &&
                   17822:         ($cenv{'grading'} eq 'standard') &&
                   17823:         ($cenv{'hidetotals'} ne '') &&
                   17824:         ($cenv{'hidetotals'} ne 'all')) {
                   17825:         my @hidesecs;
                   17826:         my $deletehidetotals;
                   17827:         if (@oklcsecs) {
                   17828:             foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
                   17829:                 if (grep(/^\Q$sec$/,@oklcsecs)) {
                   17830:                     push(@hidesecs,$sec);
                   17831:                 }
                   17832:             }
                   17833:             if (@hidesecs) {
                   17834:                 $cenv{'hidetotals'} = join(',',@hidesecs);
                   17835:             } else {
                   17836:                 $deletehidetotals = 1;
                   17837:             }
                   17838:         } else {
                   17839:             $deletehidetotals = 1;
                   17840:         }
                   17841:         if ($deletehidetotals) {
                   17842:             delete($cenv{'hidetotals'});
                   17843:             &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
                   17844:         }
                   17845:     }
1.444     albertel 17846:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   17847:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   17848:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   17849:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   17850:     if ($args->{'showphotos'}) {
                   17851:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   17852:     }
                   17853:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   17854:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   17855:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   17856:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  17857:             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'); 
                   17858:             if ($context eq 'auto') {
                   17859:                 $outcome .= $krb_msg;
                   17860:             } else {
1.566     albertel 17861:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  17862:             }
                   17863:             $outcome .= $linefeed;
1.444     albertel 17864:         }
                   17865:     }
                   17866:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   17867:        if ($args->{'setpolicy'}) {
                   17868:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   17869:        }
                   17870:        if ($args->{'setcontent'}) {
                   17871:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   17872:        }
1.1251    raeburn  17873:        if ($args->{'setcomment'}) {
                   17874:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   17875:        }
1.444     albertel 17876:     }
                   17877:     if ($args->{'reshome'}) {
                   17878: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   17879: 	$cenv{'reshome'}=~s/\/+$/\//;
                   17880:     }
                   17881: #
                   17882: # course has keyed access
                   17883: #
                   17884:     if ($args->{'setkeys'}) {
                   17885:        $cenv{'keyaccess'}='yes';
                   17886:     }
                   17887: # if specified, key authority is not course, but user
                   17888: # only active if keyaccess is yes
                   17889:     if ($args->{'keyauth'}) {
1.487     albertel 17890: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   17891: 	$user = &LONCAPA::clean_username($user);
                   17892: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     17893: 	if ($user ne '' && $domain ne '') {
1.487     albertel 17894: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 17895: 	}
                   17896:     }
                   17897: 
1.1166    raeburn  17898: #
1.1167    raeburn  17899: #  generate and store uniquecode (available to course requester), if course should have one.
1.1166    raeburn  17900: #
                   17901:     if ($args->{'uniquecode'}) {
                   17902:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   17903:         if ($code) {
                   17904:             $cenv{'internal.uniquecode'} = $code;
1.1167    raeburn  17905:             my %crsinfo =
                   17906:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   17907:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   17908:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   17909:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   17910:             } 
1.1166    raeburn  17911:             if (ref($coderef)) {
                   17912:                 $$coderef = $code;
                   17913:             }
                   17914:         }
                   17915:     }
                   17916: 
1.444     albertel 17917:     if ($args->{'disresdis'}) {
                   17918:         $cenv{'pch.roles.denied'}='st';
                   17919:     }
                   17920:     if ($args->{'disablechat'}) {
                   17921:         $cenv{'plc.roles.denied'}='st';
                   17922:     }
                   17923: 
                   17924:     # Record we've not yet viewed the Course Initialization Helper for this 
                   17925:     # course
                   17926:     $cenv{'course.helper.not.run'} = 1;
                   17927:     #
                   17928:     # Use new Randomseed
                   17929:     #
                   17930:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   17931:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   17932:     #
                   17933:     # The encryption code and receipt prefix for this course
                   17934:     #
                   17935:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   17936:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   17937:     #
                   17938:     # By default, use standard grading
                   17939:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   17940: 
1.541     raeburn  17941:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   17942:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 17943: #
                   17944: # Open all assignments
                   17945: #
                   17946:     if ($args->{'openall'}) {
1.1341    raeburn  17947:        my $opendate = time;
                   17948:        if ($args->{'openallfrom'} =~ /^\d+$/) {
                   17949:            $opendate = $args->{'openallfrom'};
                   17950:        }
1.444     albertel 17951:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341    raeburn  17952:        my %storecontent = ($storeunder         => $opendate,
1.444     albertel 17953:                            $storeunder.'.type' => 'date_start');
1.1341    raeburn  17954:        $outcome .= &mt('All assignments open starting [_1]',
                   17955:                        &Apache::lonlocal::locallocaltime($opendate)).': '.
                   17956:                    &Apache::lonnet::cput
                   17957:                        ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 17958:    }
                   17959: #
                   17960: # Set first page
                   17961: #
                   17962:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   17963: 	    || ($cloneid)) {
                   17964: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 17965: 
                   17966: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   17967:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   17968: 
1.444     albertel 17969:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   17970:         my $title; my $url;
                   17971:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   17972: 	    $title=&mt('Syllabus');
1.444     albertel 17973:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   17974:         } else {
1.963     raeburn  17975:             $title=&mt('Table of Contents');
1.444     albertel 17976:             $url='/adm/navmaps';
                   17977:         }
1.445     albertel 17978: 
                   17979:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   17980: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   17981: 
                   17982: 	if ($errtext) { $fatal=2; }
1.541     raeburn  17983:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 17984:     }
1.566     albertel 17985: 
1.1237    raeburn  17986: # 
                   17987: # Set params for Placement Tests
                   17988: #
1.1239    raeburn  17989:     if ($args->{'crstype'} eq 'Placement') {
                   17990:        my %storecontent; 
                   17991:        my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
                   17992:        my %defaults = (
                   17993:                         buttonshide   => { value => 'yes',
                   17994:                                            type => 'string_yesno',},
                   17995:                         type          => { value => 'randomizetry',
                   17996:                                            type  => 'string_questiontype',},
                   17997:                         maxtries      => { value => 1,
                   17998:                                            type => 'int_pos',},
                   17999:                         problemstatus => { value => 'no',
                   18000:                                            type  => 'string_problemstatus',},
                   18001:                       );
                   18002:        foreach my $key (keys(%defaults)) {
                   18003:            $storecontent{$prefix.$key} = $defaults{$key}{'value'};
                   18004:            $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
                   18005:        }
1.1237    raeburn  18006:        &Apache::lonnet::cput
                   18007:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum); 
                   18008:     }
                   18009: 
1.1344    raeburn  18010:     return (1,$outcome,\@clonemsg);
1.444     albertel 18011: }
                   18012: 
1.1166    raeburn  18013: sub make_unique_code {
                   18014:     my ($cdom,$cnum) = @_;
                   18015:     # get lock on uniquecodes db
                   18016:     my $lockhash = {
                   18017:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   18018:                                                   ':'.$env{'user.domain'},
                   18019:                    };
                   18020:     my $tries = 0;
                   18021:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   18022:     my ($code,$error);
                   18023:   
                   18024:     while (($gotlock ne 'ok') && ($tries<3)) {
                   18025:         $tries ++;
                   18026:         sleep 1;
                   18027:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   18028:     }
                   18029:     if ($gotlock eq 'ok') {
                   18030:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   18031:         my $gotcode;
                   18032:         my $attempts = 0;
                   18033:         while ((!$gotcode) && ($attempts < 100)) {
                   18034:             $code = &generate_code();
                   18035:             if (!exists($currcodes{$code})) {
                   18036:                 $gotcode = 1;
                   18037:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   18038:                     $error = 'nostore';
                   18039:                 }
                   18040:             }
                   18041:             $attempts ++;
                   18042:         }
                   18043:         my @del_lock = ($cnum."\0".'uniquecodes');
                   18044:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   18045:     } else {
                   18046:         $error = 'nolock';
                   18047:     }
                   18048:     return ($code,$error);
                   18049: }
                   18050: 
                   18051: sub generate_code {
                   18052:     my $code;
                   18053:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   18054:     for (my $i=0; $i<6; $i++) {
                   18055:         my $lettnum = int (rand 2);
                   18056:         my $item = '';
                   18057:         if ($lettnum) {
                   18058:             $item = $letts[int( rand(18) )];
                   18059:         } else {
                   18060:             $item = 1+int( rand(8) );
                   18061:         }
                   18062:         $code .= $item;
                   18063:     }
                   18064:     return $code;
                   18065: }
                   18066: 
1.444     albertel 18067: ############################################################
                   18068: ############################################################
                   18069: 
1.1237    raeburn  18070: # Community, Course and Placement Test
1.378     raeburn  18071: sub course_type {
                   18072:     my ($cid) = @_;
                   18073:     if (!defined($cid)) {
                   18074:         $cid = $env{'request.course.id'};
                   18075:     }
1.404     albertel 18076:     if (defined($env{'course.'.$cid.'.type'})) {
                   18077:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  18078:     } else {
                   18079:         return 'Course';
1.377     raeburn  18080:     }
                   18081: }
1.156     albertel 18082: 
1.406     raeburn  18083: sub group_term {
                   18084:     my $crstype = &course_type();
                   18085:     my %names = (
                   18086:                   'Course' => 'group',
1.865     raeburn  18087:                   'Community' => 'group',
1.1237    raeburn  18088:                   'Placement' => 'group',
1.406     raeburn  18089:                 );
                   18090:     return $names{$crstype};
                   18091: }
                   18092: 
1.902     raeburn  18093: sub course_types {
1.1310    raeburn  18094:     my @types = ('official','unofficial','community','textbook','placement','lti');
1.902     raeburn  18095:     my %typename = (
                   18096:                          official   => 'Official course',
                   18097:                          unofficial => 'Unofficial course',
                   18098:                          community  => 'Community',
1.1165    raeburn  18099:                          textbook   => 'Textbook course',
1.1237    raeburn  18100:                          placement  => 'Placement test',
1.1310    raeburn  18101:                          lti        => 'LTI provider',
1.902     raeburn  18102:                    );
                   18103:     return (\@types,\%typename);
                   18104: }
                   18105: 
1.156     albertel 18106: sub icon {
                   18107:     my ($file)=@_;
1.505     albertel 18108:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 18109:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 18110:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 18111:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   18112: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   18113: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   18114: 	            $curfext.".gif") {
                   18115: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   18116: 		$curfext.".gif";
                   18117: 	}
                   18118:     }
1.249     albertel 18119:     return &lonhttpdurl($iconname);
1.154     albertel 18120: } 
1.84      albertel 18121: 
1.575     albertel 18122: sub lonhttpdurl {
1.692     www      18123: #
                   18124: # Had been used for "small fry" static images on separate port 8080.
                   18125: # Modify here if lightweight http functionality desired again.
                   18126: # Currently eliminated due to increasing firewall issues.
                   18127: #
1.575     albertel 18128:     my ($url)=@_;
1.692     www      18129:     return $url;
1.215     albertel 18130: }
                   18131: 
1.213     albertel 18132: sub connection_aborted {
                   18133:     my ($r)=@_;
                   18134:     $r->print(" ");$r->rflush();
                   18135:     my $c = $r->connection;
                   18136:     return $c->aborted();
                   18137: }
                   18138: 
1.221     foxr     18139: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     18140: #    strings as 'strings'.
                   18141: sub escape_single {
1.221     foxr     18142:     my ($input) = @_;
1.223     albertel 18143:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     18144:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   18145:     return $input;
                   18146: }
1.223     albertel 18147: 
1.222     foxr     18148: #  Same as escape_single, but escape's "'s  This 
                   18149: #  can be used for  "strings"
                   18150: sub escape_double {
                   18151:     my ($input) = @_;
                   18152:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   18153:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   18154:     return $input;
                   18155: }
1.223     albertel 18156:  
1.222     foxr     18157: #   Escapes the last element of a full URL.
                   18158: sub escape_url {
                   18159:     my ($url)   = @_;
1.238     raeburn  18160:     my @urlslices = split(/\//, $url,-1);
1.369     www      18161:     my $lastitem = &escape(pop(@urlslices));
1.1203    raeburn  18162:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     18163: }
1.462     albertel 18164: 
1.820     raeburn  18165: sub compare_arrays {
                   18166:     my ($arrayref1,$arrayref2) = @_;
                   18167:     my (@difference,%count);
                   18168:     @difference = ();
                   18169:     %count = ();
                   18170:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   18171:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   18172:         foreach my $element (keys(%count)) {
                   18173:             if ($count{$element} == 1) {
                   18174:                 push(@difference,$element);
                   18175:             }
                   18176:         }
                   18177:     }
                   18178:     return @difference;
                   18179: }
                   18180: 
1.1322    raeburn  18181: sub lon_status_items {
                   18182:     my %defaults = (
                   18183:                      E         => 100,
                   18184:                      W         => 4,
                   18185:                      N         => 1,
1.1324    raeburn  18186:                      U         => 5,
1.1322    raeburn  18187:                      threshold => 200,
                   18188:                      sysmail   => 2500,
                   18189:                    );
                   18190:     my %names = (
                   18191:                    E => 'Errors',
                   18192:                    W => 'Warnings',
                   18193:                    N => 'Notices',
1.1324    raeburn  18194:                    U => 'Unsent',
1.1322    raeburn  18195:                 );
                   18196:     return (\%defaults,\%names);
                   18197: }
                   18198: 
1.817     bisitz   18199: # -------------------------------------------------------- Initialize user login
1.462     albertel 18200: sub init_user_environment {
1.463     albertel 18201:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 18202:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   18203: 
                   18204:     my $public=($username eq 'public' && $domain eq 'public');
                   18205: 
1.1415    raeburn  18206:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
                   18207:         $coauthorenv);
1.462     albertel 18208:     my $now=time;
                   18209: 
                   18210:     if ($public) {
                   18211: 	my $max_public=100;
                   18212: 	my $oldest;
                   18213: 	my $oldest_time=0;
                   18214: 	for(my $next=1;$next<=$max_public;$next++) {
                   18215: 	    if (-e $lonids."/publicuser_$next.id") {
                   18216: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   18217: 		if ($mtime<$oldest_time || !$oldest_time) {
                   18218: 		    $oldest_time=$mtime;
                   18219: 		    $oldest=$next;
                   18220: 		}
                   18221: 	    } else {
                   18222: 		$cookie="publicuser_$next";
                   18223: 		last;
                   18224: 	    }
                   18225: 	}
                   18226: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   18227:     } else {
1.1275    raeburn  18228: 	# See if old ID present, if so, remove if this isn't a robot,
                   18229: 	# killing any existing non-robot sessions
1.463     albertel 18230: 	if (!$args->{'robot'}) {
                   18231: 	    opendir(DIR,$lonids);
                   18232: 	    while ($filename=readdir(DIR)) {
                   18233: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320    raeburn  18234:                     if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
                   18235:                             &GDBM_READER(),0640)) {
1.1295    raeburn  18236:                         my $linkedfile;
1.1320    raeburn  18237:                         if (exists($oldenv{'user.linkedenv'})) {
                   18238:                             $linkedfile = $oldenv{'user.linkedenv'};
1.1295    raeburn  18239:                         }
1.1320    raeburn  18240:                         untie(%oldenv);
                   18241:                         if (unlink("$lonids/$filename")) {
                   18242:                             if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                   18243:                                 if (-l "$lonids/$linkedfile.id") {
                   18244:                                     unlink("$lonids/$linkedfile.id");
                   18245:                                 }
1.1295    raeburn  18246:                             }
                   18247:                         }
                   18248:                     } else {
                   18249:                         unlink($lonids.'/'.$filename);
                   18250:                     }
1.463     albertel 18251: 		}
1.462     albertel 18252: 	    }
1.463     albertel 18253: 	    closedir(DIR);
1.1204    raeburn  18254: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   18255:             my $namespace = 'nohist_courseeditor';
                   18256:             my $lockingkey = 'paste'."\0".'locked_num';
                   18257:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   18258:                                                 $domain,$username);
                   18259:             if (exists($lockhash{$lockingkey})) {
                   18260:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   18261:                 unless ($delresult eq 'ok') {
                   18262:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   18263:                 }
                   18264:             }
1.462     albertel 18265: 	}
                   18266: # Give them a new cookie
1.463     albertel 18267: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      18268: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 18269: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 18270:     
                   18271: # Initialize roles
                   18272: 
1.1414    raeburn  18273: 	($userroles,$firstaccenv,$timerintenv,$coauthorenv) = 
1.1062    raeburn  18274:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 18275:     }
                   18276: # ------------------------------------ Check browser type and MathML capability
                   18277: 
1.1194    raeburn  18278:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   18279:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 18280: 
                   18281: # ------------------------------------------------------------- Get environment
                   18282: 
                   18283:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   18284:     my ($tmp) = keys(%userenv);
1.1275    raeburn  18285:     if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462     albertel 18286: 	undef(%userenv);
                   18287:     }
                   18288:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   18289: 	$form->{'interface'}=$userenv{'interface'};
                   18290:     }
                   18291:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   18292: 
                   18293: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   18294:     foreach my $option ('interface','localpath','localres') {
                   18295:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 18296:     }
                   18297: # --------------------------------------------------------- Write first profile
                   18298: 
                   18299:     {
1.1350    raeburn  18300:         my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462     albertel 18301: 	my %initial_env = 
                   18302: 	    ("user.name"          => $username,
                   18303: 	     "user.domain"        => $domain,
                   18304: 	     "user.home"          => $authhost,
                   18305: 	     "browser.type"       => $clientbrowser,
                   18306: 	     "browser.version"    => $clientversion,
                   18307: 	     "browser.mathml"     => $clientmathml,
                   18308: 	     "browser.unicode"    => $clientunicode,
                   18309: 	     "browser.os"         => $clientos,
1.1137    raeburn  18310:              "browser.mobile"     => $clientmobile,
1.1141    raeburn  18311:              "browser.info"       => $clientinfo,
1.1194    raeburn  18312:              "browser.osversion"  => $clientosversion,
1.462     albertel 18313: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   18314: 	     "request.course.fn"  => '',
                   18315: 	     "request.course.uri" => '',
                   18316: 	     "request.course.sec" => '',
                   18317: 	     "request.role"       => 'cm',
                   18318: 	     "request.role.adv"   => $env{'user.adv'},
1.1350    raeburn  18319: 	     "request.host"       => $ip,);
1.462     albertel 18320: 
                   18321:         if ($form->{'localpath'}) {
                   18322: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   18323: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   18324:         }
                   18325: 	
                   18326: 	if ($form->{'interface'}) {
                   18327: 	    $form->{'interface'}=~s/\W//gs;
                   18328: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   18329: 	    $env{'browser.interface'}=$form->{'interface'};
                   18330: 	}
                   18331: 
1.1157    raeburn  18332:         if ($form->{'iptoken'}) {
                   18333:             my $lonhost = $r->dir_config('lonHostID');
                   18334:             $initial_env{"user.noloadbalance"} = $lonhost;
                   18335:             $env{'user.noloadbalance'} = $lonhost;
                   18336:         }
                   18337: 
1.1268    raeburn  18338:         if ($form->{'noloadbalance'}) {
                   18339:             my @hosts = &Apache::lonnet::current_machine_ids();
                   18340:             my $hosthere = $form->{'noloadbalance'};
                   18341:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   18342:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   18343:                 $env{'user.noloadbalance'} = $hosthere;
                   18344:             }
                   18345:         }
                   18346: 
1.1016    raeburn  18347:         unless ($domain eq 'public') {
1.1273    raeburn  18348:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   18349:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
                   18350: 
1.1414    raeburn  18351:             foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
                   18352:                 $userenv{'availabletools.'.$tool} =
1.1273    raeburn  18353:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   18354:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   18355:             }
1.980     raeburn  18356: 
1.1311    raeburn  18357:             foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273    raeburn  18358:                 $userenv{'canrequest.'.$crstype} =
                   18359:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   18360:                                                       'reload','requestcourses',
                   18361:                                                       \%userenv,\%domdef,\%is_adv);
                   18362:             }
1.724     raeburn  18363: 
1.1418    raeburn  18364:             if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
                   18365:                 (exists($userroles->{"user.role.au./$domain/"}))) {
                   18366:                 if ($userenv{'authoreditors'}) {
                   18367:                     $userenv{'editors'} = $userenv{'authoreditors'};
                   18368:                 } elsif ($domdef{'editors'} ne '') {
                   18369:                     $userenv{'editors'} = $domdef{'editors'};
                   18370:                 } else {
                   18371:                     $userenv{'editors'} = 'edit,xml';
                   18372:                 }
1.1431    raeburn  18373:                 if ($userenv{'authorarchive'}) {
                   18374:                     $userenv{'canarchive'} = 1;
                   18375:                 } elsif (($userenv{'authorarchive'} eq '') &&
                   18376:                          ($domdef{'archive'})) {
                   18377:                     $userenv{'canarchive'} = 1;
                   18378:                 }
1.1418    raeburn  18379:             }
                   18380: 
1.1273    raeburn  18381:             $userenv{'canrequest.author'} =
                   18382:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   18383:                                                   'reload','requestauthor',
1.980     raeburn  18384:                                                   \%userenv,\%domdef,\%is_adv);
1.1273    raeburn  18385:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   18386:                                                  $domain,$username);
                   18387:             my $reqstatus = $reqauthor{'author_status'};
                   18388:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') { 
                   18389:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   18390:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   18391:                                                       $reqauthor{'author'}{'timestamp'};
                   18392:                 }
1.1092    raeburn  18393:             }
1.1287    raeburn  18394:             my ($types,$typename) = &course_types();
                   18395:             if (ref($types) eq 'ARRAY') {
                   18396:                 my @options = ('approval','validate','autolimit');
                   18397:                 my $optregex = join('|',@options);
                   18398:                 my (%willtrust,%trustchecked);
                   18399:                 foreach my $type (@{$types}) {
                   18400:                     my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
                   18401:                     if ($dom_str ne '') {
                   18402:                         my $updatedstr = '';
                   18403:                         my @possdomains = split(',',$dom_str);
                   18404:                         foreach my $entry (@possdomains) {
                   18405:                             my ($extdom,$extopt) = split(':',$entry);
                   18406:                             unless ($trustchecked{$extdom}) {
                   18407:                                 $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
                   18408:                                 $trustchecked{$extdom} = 1;
                   18409:                             }
                   18410:                             if ($willtrust{$extdom}) {
                   18411:                                 $updatedstr .= $entry.',';
                   18412:                             }
                   18413:                         }
                   18414:                         $updatedstr =~ s/,$//;
                   18415:                         if ($updatedstr) {
                   18416:                             $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
                   18417:                         } else {
                   18418:                             delete($userenv{'reqcrsotherdom.'.$type});
                   18419:                         }
                   18420:                     }
                   18421:                 }
                   18422:             }
1.1092    raeburn  18423:         }
1.462     albertel 18424: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  18425: 
1.462     albertel 18426: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   18427: 		 &GDBM_WRCREAT(),0640)) {
                   18428: 	    &_add_to_env(\%disk_env,\%initial_env);
                   18429: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   18430: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  18431:             if (ref($firstaccenv) eq 'HASH') {
                   18432:                 &_add_to_env(\%disk_env,$firstaccenv);
                   18433:             }
                   18434:             if (ref($timerintenv) eq 'HASH') {
                   18435:                 &_add_to_env(\%disk_env,$timerintenv);
                   18436:             }
1.1414    raeburn  18437:             if (ref($coauthorenv) eq 'HASH') {
                   18438:                 if (keys(%{$coauthorenv})) {
                   18439:                     &_add_to_env(\%disk_env,$coauthorenv);
                   18440:                 }
                   18441:             }
1.463     albertel 18442: 	    if (ref($args->{'extra_env'})) {
                   18443: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   18444: 	    }
1.462     albertel 18445: 	    untie(%disk_env);
                   18446: 	} else {
1.705     tempelho 18447: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   18448: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 18449: 	    return 'error: '.$!;
                   18450: 	}
                   18451:     }
                   18452:     $env{'request.role'}='cm';
                   18453:     $env{'request.role.adv'}=$env{'user.adv'};
                   18454:     $env{'browser.type'}=$clientbrowser;
                   18455: 
                   18456:     return $cookie;
                   18457: 
                   18458: }
                   18459: 
                   18460: sub _add_to_env {
                   18461:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  18462:     if (ref($env_data) eq 'HASH') {
                   18463:         while (my ($key,$value) = each(%$env_data)) {
                   18464: 	    $idf->{$prefix.$key} = $value;
                   18465: 	    $env{$prefix.$key}   = $value;
                   18466:         }
1.462     albertel 18467:     }
                   18468: }
                   18469: 
1.685     tempelho 18470: # --- Get the symbolic name of a problem and the url
                   18471: sub get_symb {
                   18472:     my ($request,$silent) = @_;
1.726     raeburn  18473:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 18474:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   18475:     if ($symb eq '') {
                   18476:         if (!$silent) {
1.1071    raeburn  18477:             if (ref($request)) { 
                   18478:                 $request->print("Unable to handle ambiguous references:$url:.");
                   18479:             }
1.685     tempelho 18480:             return ();
                   18481:         }
                   18482:     }
                   18483:     &Apache::lonenc::check_decrypt(\$symb);
                   18484:     return ($symb);
                   18485: }
                   18486: 
                   18487: # --------------------------------------------------------------Get annotation
                   18488: 
                   18489: sub get_annotation {
                   18490:     my ($symb,$enc) = @_;
                   18491: 
                   18492:     my $key = $symb;
                   18493:     if (!$enc) {
                   18494:         $key =
                   18495:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   18496:     }
                   18497:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   18498:     return $annotation{$key};
                   18499: }
                   18500: 
                   18501: sub clean_symb {
1.731     raeburn  18502:     my ($symb,$delete_enc) = @_;
1.685     tempelho 18503: 
                   18504:     &Apache::lonenc::check_decrypt(\$symb);
                   18505:     my $enc = $env{'request.enc'};
1.731     raeburn  18506:     if ($delete_enc) {
1.730     raeburn  18507:         delete($env{'request.enc'});
                   18508:     }
1.685     tempelho 18509: 
                   18510:     return ($symb,$enc);
                   18511: }
1.462     albertel 18512: 
1.1181    raeburn  18513: ############################################################
                   18514: ############################################################
                   18515: 
                   18516: =pod
                   18517: 
                   18518: =head1 Routines for building display used to search for courses
                   18519: 
                   18520: 
                   18521: =over 4
                   18522: 
                   18523: =item * &build_filters()
                   18524: 
                   18525: Create markup for a table used to set filters to use when selecting
1.1182    raeburn  18526: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   18527: and quotacheck.pl
                   18528: 
1.1181    raeburn  18529: 
                   18530: Inputs:
                   18531: 
                   18532: filterlist - anonymous array of fields to include as potential filters 
                   18533: 
                   18534: crstype - course type
                   18535: 
                   18536: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   18537:               to pop-open a course selector (will contain "extra element"). 
                   18538: 
                   18539: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   18540: 
                   18541: filter - anonymous hash of criteria and their values
                   18542: 
                   18543: action - form action
                   18544: 
                   18545: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   18546: 
1.1182    raeburn  18547: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181    raeburn  18548: 
                   18549: cloneruname - username of owner of new course who wants to clone
                   18550: 
                   18551: clonerudom - domain of owner of new course who wants to clone
                   18552: 
                   18553: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community) 
                   18554: 
                   18555: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   18556: 
                   18557: codedom - domain
                   18558: 
                   18559: formname - value of form element named "form". 
                   18560: 
                   18561: fixeddom - domain, if fixed.
                   18562: 
                   18563: prevphase - value to assign to form element named "phase" when going back to the previous screen  
                   18564: 
                   18565: cnameelement - name of form element in form on opener page which will receive title of selected course 
                   18566: 
                   18567: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   18568: 
                   18569: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   18570: 
                   18571: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   18572: 
                   18573: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   18574: 
                   18575: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   18576: 
1.1182    raeburn  18577: 
1.1181    raeburn  18578: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   18579: 
1.1182    raeburn  18580: 
1.1181    raeburn  18581: Side Effects: None
                   18582: 
                   18583: =cut
                   18584: 
                   18585: # ---------------------------------------------- search for courses based on last activity etc.
                   18586: 
                   18587: sub build_filters {
                   18588:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   18589:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   18590:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   18591:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   18592:         $clonetext,$clonewarning) = @_;
1.1182    raeburn  18593:     my ($list,$jscript);
1.1181    raeburn  18594:     my $onchange = 'javascript:updateFilters(this)';
                   18595:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   18596:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   18597:         $typeselectform,$instcodetitle);
                   18598:     if ($formname eq '') {
                   18599:         $formname = $caller;
                   18600:     }
                   18601:     foreach my $item (@{$filterlist}) {
                   18602:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   18603:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   18604:             if ($item eq 'domainfilter') {
                   18605:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   18606:             } elsif ($item eq 'coursefilter') {
                   18607:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   18608:             } elsif ($item eq 'ownerfilter') {
                   18609:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   18610:             } elsif ($item eq 'ownerdomfilter') {
                   18611:                 $filter->{'ownerdomfilter'} =
                   18612:                     &LONCAPA::clean_domain($filter->{$item});
                   18613:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   18614:                                                        'ownerdomfilter',1);
                   18615:             } elsif ($item eq 'personfilter') {
                   18616:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   18617:             } elsif ($item eq 'persondomfilter') {
                   18618:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   18619:                                                         'persondomfilter',1);
                   18620:             } else {
                   18621:                 $filter->{$item} =~ s/\W//g;
                   18622:             }
                   18623:             if (!$filter->{$item}) {
                   18624:                 $filter->{$item} = '';
                   18625:             }
                   18626:         }
                   18627:         if ($item eq 'domainfilter') {
                   18628:             my $allow_blank = 1;
                   18629:             if ($formname eq 'portform') {
                   18630:                 $allow_blank=0;
                   18631:             } elsif ($formname eq 'studentform') {
                   18632:                 $allow_blank=0;
                   18633:             }
                   18634:             if ($fixeddom) {
                   18635:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   18636:                                     ' value="'.$codedom.'" />'.
                   18637:                                     &Apache::lonnet::domain($codedom,'description');
                   18638:             } else {
                   18639:                 $domainselectform = &select_dom_form($filter->{$item},
                   18640:                                                      'domainfilter',
                   18641:                                                       $allow_blank,'',$onchange);
                   18642:             }
                   18643:         } else {
                   18644:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   18645:         }
                   18646:     }
                   18647: 
                   18648:     # last course activity filter and selection
                   18649:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   18650: 
                   18651:     # course created filter and selection
                   18652:     if (exists($filter->{'createdfilter'})) {
                   18653:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   18654:     }
                   18655: 
1.1239    raeburn  18656:     my $prefix = $crstype;
                   18657:     if ($crstype eq 'Placement') {
                   18658:         $prefix = 'Placement Test'
                   18659:     }
1.1181    raeburn  18660:     my %lt = &Apache::lonlocal::texthash(
1.1239    raeburn  18661:                 'cac' => "$prefix Activity",
                   18662:                 'ccr' => "$prefix Created",
                   18663:                 'cde' => "$prefix Title",
                   18664:                 'cdo' => "$prefix Domain",
1.1181    raeburn  18665:                 'ins' => 'Institutional Code',
                   18666:                 'inc' => 'Institutional Categorization',
1.1239    raeburn  18667:                 'cow' => "$prefix Owner/Co-owner",
                   18668:                 'cop' => "$prefix Personnel Includes",
1.1181    raeburn  18669:                 'cog' => 'Type',
                   18670:              );
                   18671: 
                   18672:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   18673:         my $typeval = 'Course';
                   18674:         if ($crstype eq 'Community') {
                   18675:             $typeval = 'Community';
1.1239    raeburn  18676:         } elsif ($crstype eq 'Placement') {
                   18677:             $typeval = 'Placement';
1.1181    raeburn  18678:         }
                   18679:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   18680:     } else {
                   18681:         $typeselectform =  '<select name="type" size="1"';
                   18682:         if ($onchange) {
                   18683:             $typeselectform .= ' onchange="'.$onchange.'"';
                   18684:         }
                   18685:         $typeselectform .= '>'."\n";
1.1237    raeburn  18686:         foreach my $posstype ('Course','Community','Placement') {
1.1239    raeburn  18687:             my $shown;
                   18688:             if ($posstype eq 'Placement') {
                   18689:                 $shown = &mt('Placement Test');
                   18690:             } else {
                   18691:                 $shown = &mt($posstype);
                   18692:             }
1.1181    raeburn  18693:             $typeselectform.='<option value="'.$posstype.'"'.
1.1239    raeburn  18694:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181    raeburn  18695:         }
                   18696:         $typeselectform.="</select>";
                   18697:     }
                   18698: 
                   18699:     my ($cloneableonlyform,$cloneabletitle);
                   18700:     if (exists($filter->{'cloneableonly'})) {
                   18701:         my $cloneableon = '';
                   18702:         my $cloneableoff = ' checked="checked"';
                   18703:         if ($filter->{'cloneableonly'}) {
                   18704:             $cloneableon = $cloneableoff;
                   18705:             $cloneableoff = '';
                   18706:         }
                   18707:         $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>';
                   18708:         if ($formname eq 'ccrs') {
1.1187    bisitz   18709:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181    raeburn  18710:         } else {
                   18711:             $cloneabletitle = &mt('Cloneable by you');
                   18712:         }
                   18713:     }
                   18714:     my $officialjs;
                   18715:     if ($crstype eq 'Course') {
                   18716:         if (exists($filter->{'instcodefilter'})) {
1.1182    raeburn  18717: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   18718: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   18719:             if ($codedom) { 
1.1181    raeburn  18720:                 $officialjs = 1;
                   18721:                 ($instcodeform,$jscript,$$numtitlesref) =
                   18722:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   18723:                                                                   $officialjs,$codetitlesref);
                   18724:                 if ($jscript) {
1.1182    raeburn  18725:                     $jscript = '<script type="text/javascript">'."\n".
                   18726:                                '// <![CDATA['."\n".
                   18727:                                $jscript."\n".
                   18728:                                '// ]]>'."\n".
                   18729:                                '</script>'."\n";
1.1181    raeburn  18730:                 }
                   18731:             }
                   18732:             if ($instcodeform eq '') {
                   18733:                 $instcodeform =
                   18734:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   18735:                     $list->{'instcodefilter'}.'" />';
                   18736:                 $instcodetitle = $lt{'ins'};
                   18737:             } else {
                   18738:                 $instcodetitle = $lt{'inc'};
                   18739:             }
                   18740:             if ($fixeddom) {
                   18741:                 $instcodetitle .= '<br />('.$codedom.')';
                   18742:             }
                   18743:         }
                   18744:     }
                   18745:     my $output = qq|
                   18746: <form method="post" name="filterpicker" action="$action">
                   18747: <input type="hidden" name="form" value="$formname" />
                   18748: |;
                   18749:     if ($formname eq 'modifycourse') {
                   18750:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   18751:                    '<input type="hidden" name="prevphase" value="'.
                   18752:                    $prevphase.'" />'."\n";
1.1198    musolffc 18753:     } elsif ($formname eq 'quotacheck') {
                   18754:         $output .= qq|
                   18755: <input type="hidden" name="sortby" value="" />
                   18756: <input type="hidden" name="sortorder" value="" />
                   18757: |;
                   18758:     } else {
1.1181    raeburn  18759:         my $name_input;
                   18760:         if ($cnameelement ne '') {
                   18761:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   18762:                           $cnameelement.'" />';
                   18763:         }
                   18764:         $output .= qq|
1.1182    raeburn  18765: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   18766: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181    raeburn  18767: $name_input
                   18768: $roleelement
                   18769: $multelement
                   18770: $typeelement
                   18771: |;
                   18772:         if ($formname eq 'portform') {
                   18773:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   18774:         }
                   18775:     }
                   18776:     if ($fixeddom) {
                   18777:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   18778:     }
                   18779:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   18780:     if ($sincefilterform) {
                   18781:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   18782:                   .$sincefilterform
                   18783:                   .&Apache::lonhtmlcommon::row_closure();
                   18784:     }
                   18785:     if ($createdfilterform) {
                   18786:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   18787:                   .$createdfilterform
                   18788:                   .&Apache::lonhtmlcommon::row_closure();
                   18789:     }
                   18790:     if ($domainselectform) {
                   18791:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   18792:                   .$domainselectform
                   18793:                   .&Apache::lonhtmlcommon::row_closure();
                   18794:     }
                   18795:     if ($typeselectform) {
                   18796:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   18797:             $output .= $typeselectform;
                   18798:         } else {
                   18799:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   18800:                       .$typeselectform
                   18801:                       .&Apache::lonhtmlcommon::row_closure();
                   18802:         }
                   18803:     }
                   18804:     if ($instcodeform) {
                   18805:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   18806:                   .$instcodeform
                   18807:                   .&Apache::lonhtmlcommon::row_closure();
                   18808:     }
                   18809:     if (exists($filter->{'ownerfilter'})) {
                   18810:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   18811:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   18812:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   18813:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   18814:                    $ownerdomselectform.'</td></tr></table>'.
                   18815:                    &Apache::lonhtmlcommon::row_closure();
                   18816:     }
                   18817:     if (exists($filter->{'personfilter'})) {
                   18818:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   18819:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   18820:                    '<input type="text" name="personfilter" size="20" value="'.
                   18821:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   18822:                    $persondomselectform.'</td></tr></table>'.
                   18823:                    &Apache::lonhtmlcommon::row_closure();
                   18824:     }
                   18825:     if (exists($filter->{'coursefilter'})) {
                   18826:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   18827:                   .'<input type="text" name="coursefilter" size="25" value="'
                   18828:                   .$list->{'coursefilter'}.'" />'
                   18829:                   .&Apache::lonhtmlcommon::row_closure();
                   18830:     }
                   18831:     if ($cloneableonlyform) {
                   18832:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   18833:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   18834:     }
                   18835:     if (exists($filter->{'descriptfilter'})) {
                   18836:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   18837:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   18838:                   .$list->{'descriptfilter'}.'" />'
                   18839:                   .&Apache::lonhtmlcommon::row_closure(1);
                   18840:     }
                   18841:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   18842:                '<input type="hidden" name="updater" value="" />'."\n".
                   18843:                '<input type="submit" name="gosearch" value="'.
                   18844:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   18845:     return $jscript.$clonewarning.$output;
                   18846: }
                   18847: 
                   18848: =pod 
                   18849: 
                   18850: =item * &timebased_select_form()
                   18851: 
1.1182    raeburn  18852: Create markup for a dropdown list used to select a time-based
1.1181    raeburn  18853: filter e.g., Course Activity, Course Created, when searching for courses
                   18854: or communities
                   18855: 
                   18856: Inputs:
                   18857: 
                   18858: item - name of form element (sincefilter or createdfilter)
                   18859: 
                   18860: filter - anonymous hash of criteria and their values
                   18861: 
                   18862: Returns: HTML for a select box contained a blank, then six time selections,
                   18863:          with value set in incoming form variables currently selected. 
                   18864: 
                   18865: Side Effects: None
                   18866: 
                   18867: =cut
                   18868: 
                   18869: sub timebased_select_form {
                   18870:     my ($item,$filter) = @_;
                   18871:     if (ref($filter) eq 'HASH') {
                   18872:         $filter->{$item} =~ s/[^\d-]//g;
                   18873:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   18874:         return &select_form(
                   18875:                             $filter->{$item},
                   18876:                             $item,
                   18877:                             {      '-1' => '',
                   18878:                                 '86400' => &mt('today'),
                   18879:                                '604800' => &mt('last week'),
                   18880:                               '2592000' => &mt('last month'),
                   18881:                               '7776000' => &mt('last three months'),
                   18882:                              '15552000' => &mt('last six months'),
                   18883:                              '31104000' => &mt('last year'),
                   18884:                     'select_form_order' =>
                   18885:                            ['-1','86400','604800','2592000','7776000',
                   18886:                             '15552000','31104000']});
                   18887:     }
                   18888: }
                   18889: 
                   18890: =pod
                   18891: 
                   18892: =item * &js_changer()
                   18893: 
                   18894: Create script tag containing Javascript used to submit course search form
1.1183    raeburn  18895: when course type or domain is changed, and also to hide 'Searching ...' on
                   18896: page load completion for page showing search result.
1.1181    raeburn  18897: 
                   18898: Inputs: None
                   18899: 
1.1183    raeburn  18900: Returns: markup containing updateFilters() and hideSearching() javascript functions. 
1.1181    raeburn  18901: 
                   18902: Side Effects: None
                   18903: 
                   18904: =cut
                   18905: 
                   18906: sub js_changer {
                   18907:     return <<ENDJS;
                   18908: <script type="text/javascript">
                   18909: // <![CDATA[
                   18910: function updateFilters(caller) {
                   18911:     if (typeof(caller) != "undefined") {
                   18912:         document.filterpicker.updater.value = caller.name;
                   18913:     }
                   18914:     document.filterpicker.submit();
                   18915: }
1.1183    raeburn  18916: 
                   18917: function hideSearching() {
                   18918:     if (document.getElementById('searching')) {
                   18919:         document.getElementById('searching').style.display = 'none';
                   18920:     }
                   18921:     return;
                   18922: }
                   18923: 
1.1181    raeburn  18924: // ]]>
                   18925: </script>
                   18926: 
                   18927: ENDJS
                   18928: }
                   18929: 
                   18930: =pod
                   18931: 
1.1182    raeburn  18932: =item * &search_courses()
                   18933: 
                   18934: Process selected filters form course search form and pass to lonnet::courseiddump
                   18935: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   18936: 
                   18937: Inputs:
                   18938: 
                   18939: dom - domain being searched 
                   18940: 
                   18941: type - course type ('Course' or 'Community' or '.' if any).
                   18942: 
                   18943: filter - anonymous hash of criteria and their values
                   18944: 
                   18945: numtitles - for institutional codes - number of categories
                   18946: 
                   18947: cloneruname - optional username of new course owner
                   18948: 
                   18949: clonerudom - optional domain of new course owner
                   18950: 
1.1221    raeburn  18951: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by, 
1.1182    raeburn  18952:             (used when DC is using course creation form)
                   18953: 
                   18954: codetitles - reference to array of titles of components in institutional codes (official courses).
                   18955: 
1.1221    raeburn  18956: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   18957:            (and so can clone automatically)
                   18958: 
                   18959: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   18960: 
                   18961: reqinstcode - institutional code of new course, where search_courses is used to identify potential 
                   18962:               courses to clone 
1.1182    raeburn  18963: 
                   18964: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   18965: 
                   18966: 
                   18967: Side Effects: None
                   18968: 
                   18969: =cut
                   18970: 
                   18971: 
                   18972: sub search_courses {
1.1221    raeburn  18973:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   18974:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182    raeburn  18975:     my (%courses,%showcourses,$cloner);
                   18976:     if (($filter->{'ownerfilter'} ne '') ||
                   18977:         ($filter->{'ownerdomfilter'} ne '')) {
                   18978:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   18979:                                        $filter->{'ownerdomfilter'};
                   18980:     }
                   18981:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   18982:         if (!$filter->{$item}) {
                   18983:             $filter->{$item}='.';
                   18984:         }
                   18985:     }
                   18986:     my $now = time;
                   18987:     my $timefilter =
                   18988:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   18989:     my ($createdbefore,$createdafter);
                   18990:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   18991:         $createdbefore = $now;
                   18992:         $createdafter = $now-$filter->{'createdfilter'};
                   18993:     }
                   18994:     my ($instcodefilter,$regexpok);
                   18995:     if ($numtitles) {
                   18996:         if ($env{'form.official'} eq 'on') {
                   18997:             $instcodefilter =
                   18998:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   18999:             $regexpok = 1;
                   19000:         } elsif ($env{'form.official'} eq 'off') {
                   19001:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   19002:             unless ($instcodefilter eq '') {
                   19003:                 $regexpok = -1;
                   19004:             }
                   19005:         }
                   19006:     } else {
                   19007:         $instcodefilter = $filter->{'instcodefilter'};
                   19008:     }
                   19009:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   19010:     if ($type eq '') { $type = '.'; }
                   19011: 
                   19012:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   19013:         $cloner = $cloneruname.':'.$clonerudom;
                   19014:     }
                   19015:     %courses = &Apache::lonnet::courseiddump($dom,
                   19016:                                              $filter->{'descriptfilter'},
                   19017:                                              $timefilter,
                   19018:                                              $instcodefilter,
                   19019:                                              $filter->{'combownerfilter'},
                   19020:                                              $filter->{'coursefilter'},
                   19021:                                              undef,undef,$type,$regexpok,undef,undef,
1.1221    raeburn  19022:                                              undef,undef,$cloner,$cc_clone,
1.1182    raeburn  19023:                                              $filter->{'cloneableonly'},
                   19024:                                              $createdbefore,$createdafter,undef,
1.1221    raeburn  19025:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182    raeburn  19026:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   19027:         my $ccrole;
                   19028:         if ($type eq 'Community') {
                   19029:             $ccrole = 'co';
                   19030:         } else {
                   19031:             $ccrole = 'cc';
                   19032:         }
                   19033:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   19034:                                                      $filter->{'persondomfilter'},
                   19035:                                                      'userroles',undef,
                   19036:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   19037:                                                      $dom);
                   19038:         foreach my $role (keys(%rolehash)) {
                   19039:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   19040:             my $cid = $cdom.'_'.$cnum;
                   19041:             if (exists($courses{$cid})) {
                   19042:                 if (ref($courses{$cid}) eq 'HASH') {
                   19043:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   19044:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263    raeburn  19045:                             push(@{$courses{$cid}{roles}},$courserole);
1.1182    raeburn  19046:                         }
                   19047:                     } else {
                   19048:                         $courses{$cid}{roles} = [$courserole];
                   19049:                     }
                   19050:                     $showcourses{$cid} = $courses{$cid};
                   19051:                 }
                   19052:             }
                   19053:         }
                   19054:         %courses = %showcourses;
                   19055:     }
                   19056:     return %courses;
                   19057: }
                   19058: 
                   19059: =pod
                   19060: 
1.1181    raeburn  19061: =back
                   19062: 
1.1207    raeburn  19063: =head1 Routines for version requirements for current course.
                   19064: 
                   19065: =over 4
                   19066: 
                   19067: =item * &check_release_required()
                   19068: 
                   19069: Compares required LON-CAPA version with version on server, and
                   19070: if required version is newer looks for a server with the required version.
                   19071: 
                   19072: Looks first at servers in user's owen domain; if none suitable, looks at
                   19073: servers in course's domain are permitted to host sessions for user's domain.
                   19074: 
                   19075: Inputs:
                   19076: 
                   19077: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   19078: 
                   19079: $courseid - Course ID of current course
                   19080: 
                   19081: $rolecode - User's current role in course (for switchserver query string).
                   19082: 
                   19083: $required - LON-CAPA version needed by course (format: Major.Minor).
                   19084: 
                   19085: 
                   19086: Returns:
                   19087: 
                   19088: $switchserver - query string tp append to /adm/switchserver call (if 
                   19089:                 current server's LON-CAPA version is too old. 
                   19090: 
                   19091: $warning - Message is displayed if no suitable server could be found.
                   19092: 
                   19093: =cut
                   19094: 
                   19095: sub check_release_required {
                   19096:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   19097:     my ($switchserver,$warning);
                   19098:     if ($required ne '') {
                   19099:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   19100:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   19101:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   19102:             my $otherserver;
                   19103:             if (($major eq '' && $minor eq '') ||
                   19104:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   19105:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   19106:                 my $switchlcrev =
                   19107:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   19108:                                                            $userdomserver);
                   19109:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   19110:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   19111:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   19112:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   19113:                     if ($cdom ne $env{'user.domain'}) {
                   19114:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   19115:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   19116:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   19117:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   19118:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   19119:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   19120:                         my $canhost =
                   19121:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   19122:                                                               $coursedomserver,
                   19123:                                                               $remoterev,
                   19124:                                                               $udomdefaults{'remotesessions'},
                   19125:                                                               $defdomdefaults{'hostedsessions'});
                   19126: 
                   19127:                         if ($canhost) {
                   19128:                             $otherserver = $coursedomserver;
                   19129:                         } else {
                   19130:                             $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.");
                   19131:                         }
                   19132:                     } else {
                   19133:                         $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).");
                   19134:                     }
                   19135:                 } else {
                   19136:                     $otherserver = $userdomserver;
                   19137:                 }
                   19138:             }
                   19139:             if ($otherserver ne '') {
                   19140:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   19141:             }
                   19142:         }
                   19143:     }
                   19144:     return ($switchserver,$warning);
                   19145: }
                   19146: 
                   19147: =pod
                   19148: 
                   19149: =item * &check_release_result()
                   19150: 
                   19151: Inputs:
                   19152: 
                   19153: $switchwarning - Warning message if no suitable server found to host session.
                   19154: 
                   19155: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   19156:                 and current role.
                   19157: 
                   19158: Returns: HTML to display with information about requirement to switch server.
                   19159:          Either displaying warning with link to Roles/Courses screen or
                   19160:          display link to switchserver.
                   19161: 
1.1181    raeburn  19162: =cut
                   19163: 
1.1207    raeburn  19164: sub check_release_result {
                   19165:     my ($switchwarning,$switchserver) = @_;
                   19166:     my $output = &start_page('Selected course unavailable on this server').
1.1463    raeburn  19167:                  '<div class="LC_landmark" role="main"><p class="LC_warning">';
1.1207    raeburn  19168:     if ($switchwarning) {
                   19169:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   19170:         if (&show_course()) {
                   19171:             $output .= &mt('Display courses');
                   19172:         } else {
                   19173:             $output .= &mt('Display roles');
                   19174:         }
                   19175:         $output .= '</a>';
                   19176:     } elsif ($switchserver) {
                   19177:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   19178:                    '<br />'.
                   19179:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   19180:                    &mt('Switch Server').
                   19181:                    '</a>';
                   19182:     }
1.1463    raeburn  19183:     $output .= '</p></div>'.&end_page();
1.1207    raeburn  19184:     return $output;
                   19185: }
                   19186: 
                   19187: =pod
                   19188: 
                   19189: =item * &needs_coursereinit()
                   19190: 
                   19191: Determine if course contents stored for user's session needs to be
                   19192: refreshed, because content has changed since "Big Hash" last tied.
                   19193: 
                   19194: Check for change is made if time last checked is more than 10 minutes ago
                   19195: (by default).
                   19196: 
                   19197: Inputs:
                   19198: 
                   19199: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   19200: 
                   19201: $interval (optional) - Time which may elapse (in s) between last check for content
                   19202:                        change in current course. (default: 600 s).  
                   19203: 
                   19204: Returns: an array; first element is:
                   19205: 
                   19206: =over 4
                   19207: 
                   19208: 'switch' - if content updates mean user's session
                   19209:            needs to be switched to a server running a newer LON-CAPA version
                   19210:  
                   19211: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   19212:            on current server hosting user's session                
                   19213: 
                   19214: ''       - if no action required.
                   19215: 
                   19216: =back
                   19217: 
                   19218: If first item element is 'switch':
                   19219: 
                   19220: second item is $switchwarning - Warning message if no suitable server found to host session. 
                   19221: 
                   19222: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   19223:                               and current role. 
                   19224: 
                   19225: otherwise: no other elements returned.
                   19226: 
                   19227: =back
                   19228: 
                   19229: =cut
                   19230: 
                   19231: sub needs_coursereinit {
                   19232:     my ($loncaparev,$interval) = @_;
                   19233:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   19234:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   19235:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   19236:     my $now = time;
                   19237:     if ($interval eq '') {
                   19238:         $interval = 600;
                   19239:     }
                   19240:     if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282    raeburn  19241:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372    raeburn  19242:         my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282    raeburn  19243:         if ($blocked) {
                   19244:             return ();
                   19245:         }
1.1391    raeburn  19246:         my $update;
                   19247:         my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
                   19248:         my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
                   19249:         if ($lastmainchange > $env{'request.course.tied'}) {
                   19250:             my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
                   19251:             if ($needswitch) {
                   19252:                 return ('switch',$switchwarning,$switchserver);
                   19253:             }
                   19254:             $update = 'main';
                   19255:         }
                   19256:         if ($lastsuppchange > $env{'request.course.suppupdated'}) {
                   19257:             if ($update) {
                   19258:                 $update = 'both';
                   19259:             } else {
                   19260:                 my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
                   19261:                 if ($needswitch) {
                   19262:                     return ('switch',$switchwarning,$switchserver);
                   19263:                 } else {
                   19264:                     $update = 'supp';
1.1207    raeburn  19265:                 }
                   19266:             }
1.1391    raeburn  19267:         }
1.1453    raeburn  19268:         return ($update);
1.1391    raeburn  19269:     }
                   19270:     return ();
                   19271: }
                   19272: 
                   19273: sub switch_for_update {
                   19274:     my ($loncaparev,$cdom,$cnum) = @_;
                   19275:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   19276:     if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   19277:         my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   19278:         if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   19279:             &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   19280:                                     $curr_reqd_hash{'internal.releaserequired'}});
                   19281:             my ($switchserver,$switchwarning) =
                   19282:                 &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   19283:                                         $curr_reqd_hash{'internal.releaserequired'});
                   19284:             if ($switchwarning ne '' || $switchserver ne '') {
                   19285:                 return ('switch',$switchwarning,$switchserver);
                   19286:             }
1.1207    raeburn  19287:         }
                   19288:     }
                   19289:     return ();
                   19290: }
1.1181    raeburn  19291: 
1.1083    raeburn  19292: sub update_content_constraints {
1.1395    raeburn  19293:     my ($cdom,$cnum,$chome,$cid) = @_;
1.1083    raeburn  19294:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   19295:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307    raeburn  19296:     my (%checkresponsetypes,%checkcrsrestypes);
1.1083    raeburn  19297:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236    raeburn  19298:         my ($item,$name,$value) = split(/:/,$key);
1.1083    raeburn  19299:         if ($item eq 'resourcetag') {
                   19300:             if ($name eq 'responsetype') {
                   19301:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   19302:             }
1.1307    raeburn  19303:         } elsif ($item eq 'course') {
                   19304:             if ($name eq 'courserestype') {
                   19305:                 $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
                   19306:             }
1.1083    raeburn  19307:         }
                   19308:     }
                   19309:     my $navmap = Apache::lonnavmaps::navmap->new();
                   19310:     if (defined($navmap)) {
1.1307    raeburn  19311:         my (%allresponses,%allcrsrestypes);
                   19312:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
                   19313:             if ($res->is_tool()) {
                   19314:                 if ($allcrsrestypes{'exttool'}) {
                   19315:                     $allcrsrestypes{'exttool'} ++;
                   19316:                 } else {
                   19317:                     $allcrsrestypes{'exttool'} = 1;
                   19318:                 }
                   19319:                 next;
                   19320:             }
1.1083    raeburn  19321:             my %responses = $res->responseTypes();
                   19322:             foreach my $key (keys(%responses)) {
                   19323:                 next unless(exists($checkresponsetypes{$key}));
                   19324:                 $allresponses{$key} += $responses{$key};
                   19325:             }
                   19326:         }
                   19327:         foreach my $key (keys(%allresponses)) {
                   19328:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   19329:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   19330:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   19331:             }
                   19332:         }
1.1307    raeburn  19333:         foreach my $key (keys(%allcrsrestypes)) {
1.1308    raeburn  19334:             my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307    raeburn  19335:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   19336:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   19337:             }
                   19338:         }
1.1083    raeburn  19339:         undef($navmap);
                   19340:     }
1.1391    raeburn  19341:     if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308    raeburn  19342:         my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
                   19343:         if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   19344:             ($reqdmajor,$reqdminor) = ($major,$minor);
                   19345:         }
                   19346:     }
1.1083    raeburn  19347:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   19348:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   19349:     }
                   19350:     return;
                   19351: }
                   19352: 
1.1110    raeburn  19353: sub allmaps_incourse {
                   19354:     my ($cdom,$cnum,$chome,$cid) = @_;
                   19355:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   19356:         $cid = $env{'request.course.id'};
                   19357:         $cdom = $env{'course.'.$cid.'.domain'};
                   19358:         $cnum = $env{'course.'.$cid.'.num'};
                   19359:         $chome = $env{'course.'.$cid.'.home'};
                   19360:     }
                   19361:     my %allmaps = ();
                   19362:     my $lastchange =
                   19363:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   19364:     if ($lastchange > $env{'request.course.tied'}) {
                   19365:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   19366:         unless ($ferr) {
1.1395    raeburn  19367:             &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110    raeburn  19368:         }
                   19369:     }
                   19370:     my $navmap = Apache::lonnavmaps::navmap->new();
                   19371:     if (defined($navmap)) {
                   19372:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   19373:             $allmaps{$res->src()} = 1;
                   19374:         }
                   19375:     }
                   19376:     return \%allmaps;
                   19377: }
                   19378: 
1.1083    raeburn  19379: sub parse_supplemental_title {
                   19380:     my ($title) = @_;
                   19381: 
                   19382:     my ($foldertitle,$renametitle);
                   19383:     if ($title =~ /&amp;&amp;&amp;/) {
                   19384:         $title = &HTML::Entites::decode($title);
                   19385:     }
                   19386:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   19387:         $renametitle=$4;
                   19388:         my ($time,$uname,$udom) = ($1,$2,$3);
                   19389:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   19390:         my $name =  &plainname($uname,$udom);
                   19391:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   19392:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401    raeburn  19393:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402    raeburn  19394:         if ($foldertitle ne '') {
1.1401    raeburn  19395:             $title .= ': <br />'.$foldertitle;
                   19396:         }
1.1083    raeburn  19397:     }
                   19398:     if (wantarray) {
                   19399:         return ($title,$foldertitle,$renametitle);
                   19400:     }
                   19401:     return $title;
                   19402: }
                   19403: 
1.1395    raeburn  19404: sub get_supplemental {
                   19405:     my ($cnum,$cdom,$ignorecache,$possdel)=@_;
                   19406:     my $hashid=$cnum.':'.$cdom;
                   19407:     my ($supplemental,$cached,$set_httprefs);
                   19408:     unless ($ignorecache) {
                   19409:         ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
                   19410:     }
                   19411:     unless (defined($cached)) {
                   19412:         my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
                   19413:         unless ($chome eq 'no_host') {
                   19414:             my @order = @LONCAPA::map::order;
                   19415:             my @resources = @LONCAPA::map::resources;
                   19416:             my @resparms = @LONCAPA::map::resparms;
                   19417:             my @zombies = @LONCAPA::map::zombies;
                   19418:             my ($errors,%ids,%hidden);
                   19419:             $errors =
                   19420:                 &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
                   19421:                                       $errors,$possdel,\%ids,\%hidden);
                   19422:             @LONCAPA::map::order = @order;
                   19423:             @LONCAPA::map::resources = @resources;
                   19424:             @LONCAPA::map::resparms = @resparms;
                   19425:             @LONCAPA::map::zombies = @zombies;
                   19426:             $set_httprefs = 1;
                   19427:             if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
                   19428:                 &Apache::lonnet::appenv({'request.course.suppupdated' => time});
                   19429:             }
                   19430:             $supplemental = {
                   19431:                                ids => \%ids,
                   19432:                                hidden => \%hidden,
                   19433:                             };
                   19434:             &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
                   19435:         }
                   19436:     }
                   19437:     return ($supplemental,$set_httprefs);
                   19438: }
                   19439: 
1.1143    raeburn  19440: sub recurse_supplemental {
1.1391    raeburn  19441:     my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
                   19442:     if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
                   19443:         my $mapnum;
                   19444:         if ($suppmap eq 'supplemental.sequence') {
                   19445:             $mapnum = 0;
                   19446:         } else {
                   19447:             ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
                   19448:         }
1.1143    raeburn  19449:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   19450:         if ($fatal) {
                   19451:             $errors ++;
                   19452:         } else {
1.1389    raeburn  19453:             my @order = @LONCAPA::map::order;
                   19454:             if (@order > 0) {
                   19455:                 my @resources = @LONCAPA::map::resources;
1.1391    raeburn  19456:                 my @resparms = @LONCAPA::map::resparms;
1.1389    raeburn  19457:                 foreach my $idx (@order) {
                   19458:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143    raeburn  19459:                     if (($src ne '') && ($status eq 'res')) {
1.1391    raeburn  19460:                         my $id = $mapnum.':'.$idx;
                   19461:                         push(@{$suppids->{$src}},$id);
                   19462:                         if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
                   19463:                             $hiddensupp->{$id} = 1;
                   19464:                         }
1.1146    raeburn  19465:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391    raeburn  19466:                             $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
                   19467:                                                             $hiddensupp,$hiddensupp->{$id});
1.1143    raeburn  19468:                         } else {
1.1391    raeburn  19469:                             my $allowed;
                   19470:                             if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
                   19471:                                 $allowed = 1;
                   19472:                             } elsif ($possdel) {
                   19473:                                 foreach my $item (@{$suppids->{$src}}) {
                   19474:                                     next if ($item eq $id);
                   19475:                                     unless ($hiddensupp->{$item}) {
                   19476:                                        $allowed = 1;
                   19477:                                        last;
                   19478:                                     }
                   19479:                                 }
                   19480:                                 if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
                   19481:                                     &Apache::lonnet::delenv('httpref.'.$src);
                   19482:                                 }
                   19483:                             }
                   19484:                             if ($allowed && (!exists($env{'httpref.'.$src}))) {
                   19485:                                 &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308    raeburn  19486:                             }
1.1143    raeburn  19487:                         }
                   19488:                     }
                   19489:                 }
                   19490:             }
                   19491:         }
                   19492:     }
1.1391    raeburn  19493:     return $errors;
                   19494: }
                   19495: 
                   19496: sub set_supp_httprefs {
                   19497:     my ($cnum,$cdom,$supplemental,$possdel) = @_;
                   19498:     if (ref($supplemental) eq 'HASH') {
                   19499:         if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
                   19500:             foreach my $src (keys(%{$supplemental->{'ids'}})) {
                   19501:                 next if ($src =~ /\.sequence$/);
                   19502:                 if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
                   19503:                     my $allowed;
                   19504:                     if ($env{'request.role.adv'}) {
                   19505:                         $allowed = 1;
                   19506:                     } else {
                   19507:                         foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
                   19508:                             unless ($supplemental->{'hidden'}->{$id}) {
                   19509:                                 $allowed = 1;
                   19510:                                 last;
                   19511:                             }
                   19512:                         }
                   19513:                     }
                   19514:                     if (exists($env{'httpref.'.$src})) {
                   19515:                         if ($possdel) {
                   19516:                             unless ($allowed) {
                   19517:                                 &Apache::lonnet::delenv('httpref.'.$src);
                   19518:                             }
                   19519:                         }
                   19520:                     } elsif ($allowed) {
                   19521:                         &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
                   19522:                     }
                   19523:                 }
                   19524:             }
                   19525:             if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
                   19526:                 &Apache::lonnet::appenv({'request.course.suppupdated' => time});
                   19527:             }
                   19528:         }
                   19529:     }
                   19530: }
                   19531: 
                   19532: sub get_supp_parameter {
                   19533:     my ($resparm,$name)=@_;
                   19534:     return if ($resparm eq '');
                   19535:     my $value=undef;
                   19536:     my $ptype=undef;
                   19537:     foreach (split('&&&',$resparm)) {
                   19538:         my ($thistype,$thisname,$thisvalue)=split('___',$_);
                   19539:         if ($thisname eq $name) {
                   19540:             $value=$thisvalue;
                   19541:             $ptype=$thistype;
                   19542:         }
                   19543:     }
                   19544:     return $value;
1.1143    raeburn  19545: }
                   19546: 
1.1101    raeburn  19547: sub symb_to_docspath {
1.1267    raeburn  19548:     my ($symb,$navmapref) = @_;
                   19549:     return unless ($symb && ref($navmapref));
1.1101    raeburn  19550:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   19551:     if ($resurl=~/\.(sequence|page)$/) {
                   19552:         $mapurl=$resurl;
                   19553:     } elsif ($resurl eq 'adm/navmaps') {
                   19554:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   19555:     }
                   19556:     my $mapresobj;
1.1267    raeburn  19557:     unless (ref($$navmapref)) {
                   19558:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   19559:     }
                   19560:     if (ref($$navmapref)) {
                   19561:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101    raeburn  19562:     }
                   19563:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   19564:     my $type=$2;
                   19565:     my $path;
                   19566:     if (ref($mapresobj)) {
                   19567:         my $pcslist = $mapresobj->map_hierarchy();
                   19568:         if ($pcslist ne '') {
                   19569:             foreach my $pc (split(/,/,$pcslist)) {
                   19570:                 next if ($pc <= 1);
1.1267    raeburn  19571:                 my $res = $$navmapref->getByMapPc($pc);
1.1101    raeburn  19572:                 if (ref($res)) {
                   19573:                     my $thisurl = $res->src();
                   19574:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   19575:                     my $thistitle = $res->title();
                   19576:                     $path .= '&'.
                   19577:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146    raeburn  19578:                              &escape($thistitle).
1.1101    raeburn  19579:                              ':'.$res->randompick().
                   19580:                              ':'.$res->randomout().
                   19581:                              ':'.$res->encrypted().
                   19582:                              ':'.$res->randomorder().
                   19583:                              ':'.$res->is_page();
                   19584:                 }
                   19585:             }
                   19586:         }
                   19587:         $path =~ s/^\&//;
                   19588:         my $maptitle = $mapresobj->title();
                   19589:         if ($mapurl eq 'default') {
1.1129    raeburn  19590:             $maptitle = 'Main Content';
1.1101    raeburn  19591:         }
                   19592:         $path .= (($path ne '')? '&' : '').
                   19593:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146    raeburn  19594:                  &escape($maptitle).
1.1101    raeburn  19595:                  ':'.$mapresobj->randompick().
                   19596:                  ':'.$mapresobj->randomout().
                   19597:                  ':'.$mapresobj->encrypted().
                   19598:                  ':'.$mapresobj->randomorder().
                   19599:                  ':'.$mapresobj->is_page();
                   19600:     } else {
                   19601:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   19602:         my $ispage = (($type eq 'page')? 1 : '');
                   19603:         if ($mapurl eq 'default') {
1.1129    raeburn  19604:             $maptitle = 'Main Content';
1.1101    raeburn  19605:         }
                   19606:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146    raeburn  19607:                 &escape($maptitle).':::::'.$ispage;
1.1101    raeburn  19608:     }
                   19609:     unless ($mapurl eq 'default') {
                   19610:         $path = 'default&'.
1.1146    raeburn  19611:                 &escape('Main Content').
1.1101    raeburn  19612:                 ':::::&'.$path;
                   19613:     }
                   19614:     return $path;
                   19615: }
                   19616: 
1.1393    raeburn  19617: sub validate_folderpath {
                   19618:     my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
                   19619:     if ($env{'form.folderpath'} ne '') {
                   19620:         my @items = split(/\&/,$env{'form.folderpath'});
1.1394    raeburn  19621:         my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393    raeburn  19622:         for (my $i=0; $i<@items; $i++) {
                   19623:             my $odd = $i%2;
                   19624:             if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
                   19625:                 $badpath = 1;
1.1394    raeburn  19626:             } elsif ($odd && $supplementalflag) {
1.1393    raeburn  19627:                 my $idx = $i-1;
1.1394    raeburn  19628:                 if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
                   19629:                     my $esc_name = $1;
                   19630:                     if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
                   19631:                         $supppath .= '&'.$esc_name;
                   19632:                         $changed = 1;
                   19633:                     } else {
                   19634:                         $supppath .= '&'.$items[$i];
                   19635:                     }
                   19636:                 } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
                   19637:                     $changed = 1;
1.1393    raeburn  19638:                     my $is_hidden;
                   19639:                     unless ($got_supp) {
1.1395    raeburn  19640:                         my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393    raeburn  19641:                         if (ref($supplemental) eq 'HASH') {
                   19642:                             if (ref($supplemental->{'hidden'}) eq 'HASH') {
                   19643:                                 %supphidden = %{$supplemental->{'hidden'}};
                   19644:                             }
                   19645:                             if (ref($supplemental->{'ids'}) eq 'HASH') {
                   19646:                                 %suppids = %{$supplemental->{'ids'}};
                   19647:                             }
                   19648:                         }
                   19649:                         $got_supp = 1;
                   19650:                     }
                   19651:                     if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
                   19652:                         my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
                   19653:                         if ($supphidden{$mapid}) {
                   19654:                             $is_hidden = 1;
                   19655:                         }
                   19656:                     }
1.1394    raeburn  19657:                     $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
                   19658:                 } else {
                   19659:                     $supppath .= '&'.$items[$i];
1.1393    raeburn  19660:                 }
                   19661:             } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
                   19662:                 $badpath = 1;
1.1394    raeburn  19663:             } elsif ($supplementalflag) {
1.1393    raeburn  19664:                 $supppath .= '&'.$items[$i];
                   19665:             }
                   19666:             last if ($badpath);
                   19667:         }
                   19668:         if ($badpath) {
                   19669:             delete($env{'form.folderpath'});
1.1394    raeburn  19670:         } elsif ($changed && $supplementalflag) {
1.1393    raeburn  19671:             $supppath =~ s/^\&//;
                   19672:             $env{'form.folderpath'} = $supppath;
                   19673:         }
                   19674:     }
                   19675:     return;
                   19676: }
                   19677: 
1.1094    raeburn  19678: sub captcha_display {
1.1327    raeburn  19679:     my ($context,$lonhost,$defdom) = @_;
1.1094    raeburn  19680:     my ($output,$error);
1.1234    raeburn  19681:     my ($captcha,$pubkey,$privkey,$version) = 
1.1327    raeburn  19682:         &get_captcha_config($context,$lonhost,$defdom);
1.1095    raeburn  19683:     if ($captcha eq 'original') {
1.1094    raeburn  19684:         $output = &create_captcha();
                   19685:         unless ($output) {
1.1172    raeburn  19686:             $error = 'captcha';
1.1094    raeburn  19687:         }
                   19688:     } elsif ($captcha eq 'recaptcha') {
1.1234    raeburn  19689:         $output = &create_recaptcha($pubkey,$version);
1.1094    raeburn  19690:         unless ($output) {
1.1172    raeburn  19691:             $error = 'recaptcha';
1.1094    raeburn  19692:         }
                   19693:     }
1.1234    raeburn  19694:     return ($output,$error,$captcha,$version);
1.1094    raeburn  19695: }
                   19696: 
                   19697: sub captcha_response {
1.1327    raeburn  19698:     my ($context,$lonhost,$defdom) = @_;
1.1094    raeburn  19699:     my ($captcha_chk,$captcha_error);
1.1327    raeburn  19700:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095    raeburn  19701:     if ($captcha eq 'original') {
1.1094    raeburn  19702:         ($captcha_chk,$captcha_error) = &check_captcha();
                   19703:     } elsif ($captcha eq 'recaptcha') {
1.1234    raeburn  19704:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1094    raeburn  19705:     } else {
                   19706:         $captcha_chk = 1;
                   19707:     }
                   19708:     return ($captcha_chk,$captcha_error);
                   19709: }
                   19710: 
                   19711: sub get_captcha_config {
1.1327    raeburn  19712:     my ($context,$lonhost,$dom_in_effect) = @_;
1.1234    raeburn  19713:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094    raeburn  19714:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   19715:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   19716:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095    raeburn  19717:     if ($context eq 'usercreation') {
                   19718:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   19719:         if (ref($domconfig{$context}) eq 'HASH') {
                   19720:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   19721:             if (ref($hashtocheck) eq 'HASH') {
                   19722:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   19723:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   19724:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   19725:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   19726:                     }
                   19727:                     if ($privkey && $pubkey) {
                   19728:                         $captcha = 'recaptcha';
1.1234    raeburn  19729:                         $version = $hashtocheck->{'recaptchaversion'};
                   19730:                         if ($version ne '2') {
                   19731:                             $version = 1;
                   19732:                         }
1.1095    raeburn  19733:                     } else {
                   19734:                         $captcha = 'original';
                   19735:                     }
                   19736:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   19737:                     $captcha = 'original';
                   19738:                 }
1.1094    raeburn  19739:             }
1.1095    raeburn  19740:         } else {
                   19741:             $captcha = 'captcha';
                   19742:         }
                   19743:     } elsif ($context eq 'login') {
                   19744:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   19745:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   19746:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   19747:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094    raeburn  19748:             if ($privkey && $pubkey) {
                   19749:                 $captcha = 'recaptcha';
1.1234    raeburn  19750:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   19751:                 if ($version ne '2') {
                   19752:                     $version = 1; 
                   19753:                 }
1.1095    raeburn  19754:             } else {
                   19755:                 $captcha = 'original';
1.1094    raeburn  19756:             }
1.1095    raeburn  19757:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   19758:             $captcha = 'original';
1.1094    raeburn  19759:         }
1.1327    raeburn  19760:     } elsif ($context eq 'passwords') {
                   19761:         if ($dom_in_effect) {
                   19762:             my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
                   19763:             if ($passwdconf{'captcha'} eq 'recaptcha') {
                   19764:                 if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
                   19765:                     $pubkey = $passwdconf{'recaptchakeys'}{'public'};
                   19766:                     $privkey = $passwdconf{'recaptchakeys'}{'private'};
                   19767:                 }
                   19768:                 if ($privkey && $pubkey) {
                   19769:                     $captcha = 'recaptcha';
                   19770:                     $version = $passwdconf{'recaptchaversion'};
                   19771:                     if ($version ne '2') {
                   19772:                         $version = 1;
                   19773:                     }
                   19774:                 } else {
                   19775:                     $captcha = 'original';
                   19776:                 }
                   19777:             } elsif ($passwdconf{'captcha'} ne 'notused') {
                   19778:                 $captcha = 'original';
                   19779:             }
                   19780:         }
                   19781:     } 
1.1234    raeburn  19782:     return ($captcha,$pubkey,$privkey,$version);
1.1094    raeburn  19783: }
                   19784: 
                   19785: sub create_captcha {
                   19786:     my %captcha_params = &captcha_settings();
                   19787:     my ($output,$maxtries,$tries) = ('',10,0);
                   19788:     while ($tries < $maxtries) {
                   19789:         $tries ++;
                   19790:         my $captcha = Authen::Captcha->new (
                   19791:                                            output_folder => $captcha_params{'output_dir'},
                   19792:                                            data_folder   => $captcha_params{'db_dir'},
                   19793:                                           );
                   19794:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   19795: 
                   19796:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   19797:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367    raeburn  19798:                       '<span class="LC_nobreak">'.
1.1453    raeburn  19799:                       '<label>'.&mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1463    raeburn  19800:                       '<input type="text" size="5" name="code" value="" autocomplete="new-password" aria-required="true" />'.
1.1453    raeburn  19801:                       '</label></span><br />'.
1.1176    raeburn  19802:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094    raeburn  19803:             last;
                   19804:         }
                   19805:     }
1.1323    raeburn  19806:     if ($output eq '') {
                   19807:         &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
                   19808:     }
1.1094    raeburn  19809:     return $output;
                   19810: }
                   19811: 
                   19812: sub captcha_settings {
                   19813:     my %captcha_params = (
                   19814:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   19815:                            www_output_dir => "/captchaspool",
                   19816:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   19817:                            numchars       => '5',
                   19818:                          );
                   19819:     return %captcha_params;
                   19820: }
                   19821: 
                   19822: sub check_captcha {
                   19823:     my ($captcha_chk,$captcha_error);
                   19824:     my $code = $env{'form.code'};
                   19825:     my $md5sum = $env{'form.crypt'};
                   19826:     my %captcha_params = &captcha_settings();
                   19827:     my $captcha = Authen::Captcha->new(
                   19828:                       output_folder => $captcha_params{'output_dir'},
                   19829:                       data_folder   => $captcha_params{'db_dir'},
                   19830:                   );
1.1109    raeburn  19831:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094    raeburn  19832:     my %captcha_hash = (
                   19833:                         0       => 'Code not checked (file error)',
                   19834:                        -1      => 'Failed: code expired',
                   19835:                        -2      => 'Failed: invalid code (not in database)',
                   19836:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   19837:     );
                   19838:     if ($captcha_chk != 1) {
                   19839:         $captcha_error = $captcha_hash{$captcha_chk}
                   19840:     }
                   19841:     return ($captcha_chk,$captcha_error);
                   19842: }
                   19843: 
                   19844: sub create_recaptcha {
1.1234    raeburn  19845:     my ($pubkey,$version) = @_;
                   19846:     if ($version >= 2) {
1.1367    raeburn  19847:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
                   19848:                '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234    raeburn  19849:     } else {
                   19850:         my $use_ssl;
                   19851:         if ($ENV{'SERVER_PORT'} == 443) {
                   19852:             $use_ssl = 1;
                   19853:         }
                   19854:         my $captcha = Captcha::reCAPTCHA->new;
                   19855:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   19856:                $captcha->get_html($pubkey,undef,$use_ssl).
                   19857:                &mt('If the text is hard to read, [_1] will replace them.',
                   19858:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   19859:                '<br /><br />';
                   19860:     }
1.1094    raeburn  19861: }
                   19862: 
                   19863: sub check_recaptcha {
1.1234    raeburn  19864:     my ($privkey,$version) = @_;
1.1094    raeburn  19865:     my $captcha_chk;
1.1350    raeburn  19866:     my $ip = &Apache::lonnet::get_requestor_ip();
1.1234    raeburn  19867:     if ($version >= 2) {
                   19868:         my %info = (
                   19869:                      secret   => $privkey, 
                   19870:                      response => $env{'form.g-recaptcha-response'},
1.1350    raeburn  19871:                      remoteip => $ip,
1.1234    raeburn  19872:                    );
1.1280    raeburn  19873:         my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
                   19874:         $request->content(join('&',map {
                   19875:                          my $name = escape($_);
                   19876:                          "$name=" . ( ref($info{$_}) eq 'ARRAY'
                   19877:                          ? join("&$name=", map {escape($_) } @{$info{$_}})
                   19878:                          : &escape($info{$_}) );
                   19879:         } keys(%info)));
                   19880:         my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234    raeburn  19881:         if ($response->is_success)  {
                   19882:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   19883:             if (ref($data) eq 'HASH') {
                   19884:                 if ($data->{'success'}) {
                   19885:                     $captcha_chk = 1;
                   19886:                 }
                   19887:             }
                   19888:         }
                   19889:     } else {
                   19890:         my $captcha = Captcha::reCAPTCHA->new;
                   19891:         my $captcha_result =
                   19892:             $captcha->check_answer(
                   19893:                                     $privkey,
1.1350    raeburn  19894:                                     $ip,
1.1234    raeburn  19895:                                     $env{'form.recaptcha_challenge_field'},
                   19896:                                     $env{'form.recaptcha_response_field'},
                   19897:                                   );
                   19898:         if ($captcha_result->{is_valid}) {
                   19899:             $captcha_chk = 1;
                   19900:         }
1.1094    raeburn  19901:     }
                   19902:     return $captcha_chk;
                   19903: }
                   19904: 
1.1174    raeburn  19905: sub emailusername_info {
1.1244    raeburn  19906:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174    raeburn  19907:     my %titles = &Apache::lonlocal::texthash (
                   19908:                      lastname      => 'Last Name',
                   19909:                      firstname     => 'First Name',
                   19910:                      institution   => 'School/college/university',
                   19911:                      location      => "School's city, state/province, country",
                   19912:                      web           => "School's web address",
                   19913:                      officialemail => 'E-mail address at institution (if different)',
1.1244    raeburn  19914:                      id            => 'Student/Employee ID',
1.1174    raeburn  19915:                  );
                   19916:     return (\@fields,\%titles);
                   19917: }
                   19918: 
1.1161    raeburn  19919: sub cleanup_html {
                   19920:     my ($incoming) = @_;
                   19921:     my $outgoing;
                   19922:     if ($incoming ne '') {
                   19923:         $outgoing = $incoming;
                   19924:         $outgoing =~ s/;/&#059;/g;
                   19925:         $outgoing =~ s/\#/&#035;/g;
                   19926:         $outgoing =~ s/\&/&#038;/g;
                   19927:         $outgoing =~ s/</&#060;/g;
                   19928:         $outgoing =~ s/>/&#062;/g;
                   19929:         $outgoing =~ s/\(/&#040/g;
                   19930:         $outgoing =~ s/\)/&#041;/g;
                   19931:         $outgoing =~ s/"/&#034;/g;
                   19932:         $outgoing =~ s/'/&#039;/g;
                   19933:         $outgoing =~ s/\$/&#036;/g;
                   19934:         $outgoing =~ s{/}{&#047;}g;
                   19935:         $outgoing =~ s/=/&#061;/g;
                   19936:         $outgoing =~ s/\\/&#092;/g
                   19937:     }
                   19938:     return $outgoing;
                   19939: }
                   19940: 
1.1190    musolffc 19941: # Checks for critical messages and returns a redirect url if one exists.
                   19942: # $interval indicates how often to check for messages.
1.1282    raeburn  19943: # $context is the calling context -- roles, grades, contents, menu or flip. 
1.1190    musolffc 19944: sub critical_redirect {
1.1282    raeburn  19945:     my ($interval,$context) = @_;
1.1356    raeburn  19946:     unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
                   19947:         return ();
                   19948:     }
1.1190    musolffc 19949:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282    raeburn  19950:         if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
                   19951:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   19952:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372    raeburn  19953:             my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282    raeburn  19954:             if ($blocked) {
                   19955:                 my $checkrole = "cm./$cdom/$cnum";
                   19956:                 if ($env{'request.course.sec'} ne '') {
                   19957:                     $checkrole .= "/$env{'request.course.sec'}";
                   19958:                 }
                   19959:                 unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   19960:                         ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   19961:                     return;
                   19962:                 }
                   19963:             }
                   19964:         }
1.1190    musolffc 19965:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'}, 
                   19966:                                         $env{'user.name'});
                   19967:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191    raeburn  19968:         my $redirecturl;
1.1190    musolffc 19969:         if ($what[0]) {
1.1356    raeburn  19970: 	    if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190    musolffc 19971: 	        $redirecturl='/adm/email?critical=display';
1.1191    raeburn  19972: 	        my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   19973:                 return (1, $url);
1.1190    musolffc 19974:             }
1.1191    raeburn  19975:         }
                   19976:     } 
                   19977:     return ();
1.1190    musolffc 19978: }
                   19979: 
1.1174    raeburn  19980: # Use:
                   19981: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   19982: #
                   19983: ##################################################
                   19984: #          password associated functions         #
                   19985: ##################################################
                   19986: sub des_keys {
                   19987:     # Make a new key for DES encryption.
                   19988:     # Each key has two parts which are returned separately.
                   19989:     # Please note:  Each key must be passed through the &hex function
                   19990:     # before it is output to the web browser.  The hex versions cannot
                   19991:     # be used to decrypt.
                   19992:     my @hexstr=('0','1','2','3','4','5','6','7',
                   19993:                 '8','9','a','b','c','d','e','f');
                   19994:     my $lkey='';
                   19995:     for (0..7) {
                   19996:         $lkey.=$hexstr[rand(15)];
                   19997:     }
                   19998:     my $ukey='';
                   19999:     for (0..7) {
                   20000:         $ukey.=$hexstr[rand(15)];
                   20001:     }
                   20002:     return ($lkey,$ukey);
                   20003: }
                   20004: 
                   20005: sub des_decrypt {
                   20006:     my ($key,$cyphertext) = @_;
                   20007:     my $keybin=pack("H16",$key);
                   20008:     my $cypher;
                   20009:     if ($Crypt::DES::VERSION>=2.03) {
                   20010:         $cypher=new Crypt::DES $keybin;
                   20011:     } else {
                   20012:         $cypher=new DES $keybin;
                   20013:     }
1.1233    raeburn  20014:     my $plaintext='';
                   20015:     my $cypherlength = length($cyphertext);
                   20016:     my $numchunks = int($cypherlength/32);
                   20017:     for (my $j=0; $j<$numchunks; $j++) {
                   20018:         my $start = $j*32;
                   20019:         my $cypherblock = substr($cyphertext,$start,32);
                   20020:         my $chunk =
                   20021:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   20022:         $chunk .=
                   20023:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   20024:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   20025:         $plaintext .= $chunk;
                   20026:     }
1.1174    raeburn  20027:     return $plaintext;
                   20028: }
                   20029: 
1.1344    raeburn  20030: sub get_requested_shorturls {
1.1309    raeburn  20031:     my ($cdom,$cnum,$navmap) = @_;
                   20032:     return unless (ref($navmap));
1.1344    raeburn  20033:     my ($numnew,$errors);
1.1309    raeburn  20034:     my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
                   20035:     if (@toshorten) {
                   20036:         my (%maps,%resources,%titles);
                   20037:         &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
                   20038:                                                                'shorturls',$cdom,$cnum);
                   20039:         if (keys(%resources)) {
1.1344    raeburn  20040:             my %tocreate;
1.1309    raeburn  20041:             foreach my $item (sort {$a <=> $b} (@toshorten)) {
                   20042:                 my $symb = $resources{$item};
                   20043:                 if ($symb) {
                   20044:                     $tocreate{$cnum.'&'.$symb} = 1;
                   20045:                 }
                   20046:             }
1.1344    raeburn  20047:             if (keys(%tocreate)) {
                   20048:                 ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
                   20049:                                                       \%tocreate);
                   20050:             }
1.1309    raeburn  20051:         }
1.1344    raeburn  20052:     }
                   20053:     return ($numnew,$errors);
                   20054: }
                   20055: 
                   20056: sub make_short_symbs {
                   20057:     my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
                   20058:     my ($numnew,@errors);
                   20059:     if (ref($tocreateref) eq 'HASH') {
                   20060:         my %tocreate = %{$tocreateref};
1.1309    raeburn  20061:         if (keys(%tocreate)) {
                   20062:             my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
                   20063:             my $su = Short::URL->new(no_vowels => 1);
                   20064:             my $init = '';
                   20065:             my (%newunique,%addcourse,%courseonly,%failed);
                   20066:             # get lock on tiny db
                   20067:             my $now = time;
1.1344    raeburn  20068:             if ($lockuser eq '') {
                   20069:                 $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
                   20070:             }
1.1309    raeburn  20071:             my $lockhash = {
1.1344    raeburn  20072:                                 "lock\0$now" => $lockuser,
1.1309    raeburn  20073:                             };
                   20074:             my $tries = 0;
                   20075:             my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
                   20076:             my ($code,$error);
                   20077:             while (($gotlock ne 'ok') && ($tries<3)) {
                   20078:                 $tries ++;
                   20079:                 sleep 1;
1.1319    raeburn  20080:                 $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309    raeburn  20081:             }
                   20082:             if ($gotlock eq 'ok') {
                   20083:                 $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
                   20084:                                        \%addcourse,\%courseonly,\%failed);
                   20085:                 if (keys(%failed)) {
                   20086:                     my $numfailed = scalar(keys(%failed));
                   20087:                     push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
                   20088:                 }
                   20089:                 if (keys(%newunique)) {
                   20090:                     my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
                   20091:                     if ($putres eq 'ok') {
                   20092:                         $numnew = scalar(keys(%newunique));
                   20093:                         my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
                   20094:                         unless ($newputres eq 'ok') {
                   20095:                             push(@errors,&mt('error: could not store course look-up of short URLs'));
                   20096:                         }
                   20097:                     } else {
                   20098:                         push(@errors,&mt('error: could not store unique six character URLs'));
                   20099:                     }
                   20100:                 }
                   20101:                 my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
                   20102:                 unless ($dellockres eq 'ok') {
                   20103:                     push(@errors,&mt('error: could not release lockfile'));
                   20104:                 }
                   20105:             } else {
                   20106:                 push(@errors,&mt('error: could not obtain lockfile'));
                   20107:             }
                   20108:             if (keys(%courseonly)) {
                   20109:                 my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
                   20110:                 if ($result ne 'ok') {
                   20111:                     push(@errors,&mt('error: could not update course look-up of short URLs'));
                   20112:                 }
                   20113:             }
                   20114:         }
                   20115:     }
                   20116:     return ($numnew,\@errors);
                   20117: }
                   20118: 
                   20119: sub shorten_symbs {
                   20120:     my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
                   20121:     return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
                   20122:                    (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
                   20123:                    (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
                   20124:     my (%possibles,%collisions);
                   20125:     foreach my $key (keys(%{$tocreate})) {
                   20126:         my $num = String::CRC32::crc32($key);
                   20127:         my $tiny = $su->encode($num,$init);
                   20128:         if ($tiny) {
                   20129:             $possibles{$tiny} = $key;
                   20130:         }
                   20131:     }
                   20132:     if (!$init) {
                   20133:         $init = 1;
                   20134:     } else {
                   20135:         $init ++;
                   20136:     }
                   20137:     if (keys(%possibles)) {
                   20138:         my @posstiny = keys(%possibles);
                   20139:         my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
                   20140:         my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
                   20141:         if (keys(%currtiny)) {
                   20142:             foreach my $key (keys(%currtiny)) {
                   20143:                 next if ($currtiny{$key} eq '');
                   20144:                 if ($currtiny{$key} eq $possibles{$key}) {
                   20145:                     my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
                   20146:                     unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   20147:                         $courseonly->{$tsymb} = $key;
                   20148:                     }
                   20149:                 } else {
                   20150:                     $collisions{$possibles{$key}} = 1;
                   20151:                 }
                   20152:                 delete($possibles{$key});
                   20153:             }
                   20154:         }
                   20155:         foreach my $key (keys(%possibles)) {
                   20156:             $newunique->{$key} = $possibles{$key};
                   20157:             my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
                   20158:             unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   20159:                 $addcourse->{$tsymb} = $key;
                   20160:             }
                   20161:         }
                   20162:     }
                   20163:     if (keys(%collisions)) {
                   20164:         if ($init <5) {
                   20165:             if (!$init) {
                   20166:                 $init = 1;
                   20167:             } else {
                   20168:                 $init ++;
                   20169:             }
                   20170:             $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
                   20171:                                    $newunique,$addcourse,$courseonly,$failed);
                   20172:         } else {
                   20173:             foreach my $key (keys(%collisions)) {
                   20174:                 $failed->{$key} = 1;
                   20175:             }
                   20176:         }
                   20177:     }
                   20178:     return $init;
                   20179: }
                   20180: 
1.1328    raeburn  20181: sub is_nonframeable {
1.1329    raeburn  20182:     my ($url,$absolute,$hostname,$ip,$nocache) = @_;
                   20183:     my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330    raeburn  20184:     return if (($remprotocol eq '') || ($remhost eq ''));
1.1329    raeburn  20185: 
                   20186:     $remprotocol = lc($remprotocol);
                   20187:     $remhost = lc($remhost);
                   20188:     my $remport = 80;
                   20189:     if ($remprotocol eq 'https') {
                   20190:         $remport = 443;
                   20191:     }
1.1330    raeburn  20192:     my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329    raeburn  20193:     if ($cached) {
                   20194:         unless ($nocache) {
                   20195:             if ($result) {
                   20196:                 return 1;
                   20197:             } else {
                   20198:                 return 0;
                   20199:             }
                   20200:         }
                   20201:     }
1.1328    raeburn  20202:     my $uselink;
                   20203:     my $request = new HTTP::Request('HEAD',$url);
                   20204:     my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
                   20205:     if ($response->is_success()) {
                   20206:         my $secpolicy = lc($response->header('content-security-policy'));
                   20207:         my $xframeop = lc($response->header('x-frame-options'));
                   20208:         $secpolicy =~ s/^\s+|\s+$//g;
                   20209:         $xframeop =~ s/^\s+|\s+$//g;
                   20210:         if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329    raeburn  20211:             my $remotehost = $remprotocol.'://'.$remhost;
1.1328    raeburn  20212:             my ($origin,$protocol,$port);
                   20213:             if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
                   20214:                 $port = $ENV{'SERVER_PORT'};
                   20215:             } else {
                   20216:                 $port = 80;
                   20217:             }
                   20218:             if ($absolute eq '') {
                   20219:                 $protocol = 'http:';
                   20220:                 if ($port == 443) {
                   20221:                     $protocol = 'https:';
                   20222:                 }
                   20223:                 $origin = $protocol.'//'.lc($hostname);
                   20224:             } else {
                   20225:                 $origin = lc($absolute);
                   20226:                 ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
                   20227:             }
                   20228:             if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
                   20229:                 my $framepolicy = $1;
                   20230:                 $framepolicy =~ s/^\s+|\s+$//g;
                   20231:                 my @policies = split(/\s+/,$framepolicy);
                   20232:                 if (@policies) {
                   20233:                     if (grep(/^\Q'none'\E$/,@policies)) {
                   20234:                         $uselink = 1;
                   20235:                     } else {
                   20236:                         $uselink = 1;
                   20237:                         if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
                   20238:                                 (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
                   20239:                                 (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
                   20240:                             undef($uselink);
                   20241:                         }
                   20242:                         if ($uselink) {
                   20243:                             if (grep(/^\Q'self'\E$/,@policies)) {
                   20244:                                 if (($origin ne '') && ($remotehost eq $origin)) {
                   20245:                                     undef($uselink);
                   20246:                                 }
                   20247:                             }
                   20248:                         }
                   20249:                         if ($uselink) {
                   20250:                             my @possok;
                   20251:                             if ($ip ne '') {
                   20252:                                 push(@possok,$ip);
                   20253:                             }
                   20254:                             my $hoststr = '';
                   20255:                             foreach my $part (reverse(split(/\./,$hostname))) {
                   20256:                                 if ($hoststr eq '') {
                   20257:                                     $hoststr = $part;
                   20258:                                 } else {
                   20259:                                     $hoststr = "$part.$hoststr";
                   20260:                                 }
                   20261:                                 if ($hoststr eq $hostname) {
                   20262:                                     push(@possok,$hostname);
                   20263:                                 } else {
                   20264:                                     push(@possok,"*.$hoststr");
                   20265:                                 }
                   20266:                             }
                   20267:                             if (@possok) {
                   20268:                                 foreach my $poss (@possok) {
                   20269:                                     last if (!$uselink);
                   20270:                                     foreach my $policy (@policies) {
                   20271:                                         if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
                   20272:                                             undef($uselink);
                   20273:                                             last;
                   20274:                                         }
                   20275:                                     }
                   20276:                                 }
                   20277:                             }
                   20278:                         }
                   20279:                     }
                   20280:                 }
                   20281:             } elsif ($xframeop ne '') {
                   20282:                 $uselink = 1;
                   20283:                 my @policies = split(/\s*,\s*/,$xframeop);
                   20284:                 if (@policies) {
                   20285:                     unless (grep(/^deny$/,@policies)) {
                   20286:                         if ($origin ne '') {
                   20287:                             if (grep(/^sameorigin$/,@policies)) {
                   20288:                                 if ($remotehost eq $origin) {
                   20289:                                     undef($uselink);
                   20290:                                 }
                   20291:                             }
                   20292:                             if ($uselink) {
                   20293:                                 foreach my $policy (@policies) {
                   20294:                                     if ($policy =~ /^allow-from\s*(.+)$/) {
                   20295:                                         my $allowfrom = $1;
                   20296:                                         if (($allowfrom ne '') && ($allowfrom eq $origin)) {
                   20297:                                             undef($uselink);
                   20298:                                             last;
                   20299:                                         }
                   20300:                                     }
                   20301:                                 }
                   20302:                             }
                   20303:                         }
                   20304:                     }
                   20305:                 }
                   20306:             }
                   20307:         }
                   20308:     }
1.1329    raeburn  20309:     if ($nocache) {
                   20310:         if ($cached) {
                   20311:             my $devalidate;
                   20312:             if ($uselink && !$result) {
                   20313:                 $devalidate = 1;
                   20314:             } elsif (!$uselink && $result) {
                   20315:                 $devalidate = 1;
                   20316:             }
                   20317:             if ($devalidate) {
                   20318:                 &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
                   20319:             }
                   20320:         }
                   20321:     } else {
                   20322:         if ($uselink) {
                   20323:             $result = 1;
                   20324:         } else {
                   20325:             $result = 0;
                   20326:         }
                   20327:         &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
                   20328:     }
1.1328    raeburn  20329:     return $uselink;
                   20330: }
                   20331: 
1.1359    raeburn  20332: sub page_menu {
                   20333:     my ($menucolls,$menunum) = @_;
                   20334:     my %menu;
                   20335:     foreach my $item (split(/;/,$menucolls)) {
                   20336:         my ($num,$value) = split(/\%/,$item);
                   20337:         if ($num eq $menunum) {
                   20338:             my @entries = split(/\&/,$value);
                   20339:             foreach my $entry (@entries) {
                   20340:                 my ($name,$fields) = split(/=/,$entry);
1.1368    raeburn  20341:                 if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359    raeburn  20342:                     $menu{$name} = $fields;
                   20343:                 } else {
                   20344:                     my @shown;
                   20345:                     if ($fields =~ /,/) {
                   20346:                         @shown = split(/,/,$fields);
                   20347:                     } else {
                   20348:                         @shown = ($fields);
                   20349:                     }
                   20350:                     if (@shown) {
                   20351:                         foreach my $field (@shown) {
                   20352:                             next if ($field eq '');
                   20353:                             $menu{$field} = 1;
                   20354:                         }
                   20355:                     }
                   20356:                 }
                   20357:             }
                   20358:         }
                   20359:     }
                   20360:     return %menu;
                   20361: }
                   20362: 
1.112     bowersj2 20363: 1;
                   20364: __END__;
1.41      ng       20365: 

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