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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.1478  ! raeburn     4: # $Id: loncommon.pm,v 1.1477 2025/03/31 13:55:07 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.1476    raeburn  7688: .LC_menubuttons_link img {
                   7689:   vertical-align: middle;
                   7690: }
                   7691: 
1.522     albertel 7692: .LC_menubuttons_category {
1.521     www      7693:   color: $font;
1.526     www      7694:   background: $pgbg;
1.521     www      7695:   font-size: larger;
                   7696:   font-weight: bold;
                   7697: }
                   7698: 
1.1476    raeburn  7699: .LC_menu_text {
                   7700:   clear: left;
                   7701:   text-align: left;
1.911     bisitz   7702:   color: $font;
1.346     albertel 7703: }
1.706     harmsja  7704: 
1.346     albertel 7705: .LC_current_location {
                   7706:   background: $tabbg;
                   7707: }
1.795     www      7708: 
1.1286    raeburn  7709: td.LC_zero_height {
                   7710:   line-height: 0; 
                   7711:   cellpadding: 0;
                   7712: }
                   7713: 
1.938     bisitz   7714: table.LC_data_table {
1.347     albertel 7715:   border: 1px solid #000000;
1.402     albertel 7716:   border-collapse: separate;
1.426     albertel 7717:   border-spacing: 1px;
1.610     albertel 7718:   background: $pgbg;
1.347     albertel 7719: }
1.795     www      7720: 
1.422     albertel 7721: .LC_data_table_dense {
                   7722:   font-size: small;
                   7723: }
1.795     www      7724: 
1.507     raeburn  7725: table.LC_nested_outer {
                   7726:   border: 1px solid #000000;
1.589     raeburn  7727:   border-collapse: collapse;
1.803     bisitz   7728:   border-spacing: 0;
1.507     raeburn  7729:   width: 100%;
                   7730: }
1.795     www      7731: 
1.879     raeburn  7732: table.LC_innerpickbox,
1.507     raeburn  7733: table.LC_nested {
1.803     bisitz   7734:   border: none;
1.589     raeburn  7735:   border-collapse: collapse;
1.803     bisitz   7736:   border-spacing: 0;
1.507     raeburn  7737:   width: 100%;
                   7738: }
1.795     www      7739: 
1.911     bisitz   7740: table.LC_data_table tr th,
                   7741: table.LC_calendar tr th,
1.879     raeburn  7742: table.LC_prior_tries tr th,
                   7743: table.LC_innerpickbox tr th {
1.349     albertel 7744:   font-weight: bold;
                   7745:   background-color: $data_table_head;
1.801     tempelho 7746:   color:$fontmenu;
1.701     harmsja  7747:   font-size:90%;
1.347     albertel 7748: }
1.795     www      7749: 
1.879     raeburn  7750: table.LC_innerpickbox tr th,
                   7751: table.LC_innerpickbox tr td {
                   7752:   vertical-align: top;
                   7753: }
                   7754: 
1.711     raeburn  7755: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   7756:   background-color: #CCCCCC;
1.711     raeburn  7757:   font-weight: bold;
                   7758:   text-align: left;
                   7759: }
1.795     www      7760: 
1.912     bisitz   7761: table.LC_data_table tr.LC_odd_row > td {
                   7762:   background-color: $data_table_light;
                   7763:   padding: 2px;
                   7764:   vertical-align: top;
                   7765: }
                   7766: 
1.809     bisitz   7767: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 7768:   background-color: $data_table_light;
1.912     bisitz   7769:   vertical-align: top;
                   7770: }
                   7771: 
                   7772: table.LC_data_table tr.LC_even_row > td {
                   7773:   background-color: $data_table_dark;
1.425     albertel 7774:   padding: 2px;
1.900     bisitz   7775:   vertical-align: top;
1.347     albertel 7776: }
1.795     www      7777: 
1.809     bisitz   7778: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 7779:   background-color: $data_table_dark;
1.900     bisitz   7780:   vertical-align: top;
1.347     albertel 7781: }
1.795     www      7782: 
1.425     albertel 7783: table.LC_data_table tr.LC_data_table_highlight td {
                   7784:   background-color: $data_table_darker;
                   7785: }
1.795     www      7786: 
1.639     raeburn  7787: table.LC_data_table tr td.LC_leftcol_header {
                   7788:   background-color: $data_table_head;
                   7789:   font-weight: bold;
                   7790: }
1.795     www      7791: 
1.451     albertel 7792: table.LC_data_table tr.LC_empty_row td,
1.1474    raeburn  7793: table.LC_nested tr.LC_empty_row td,
                   7794: table.LC_nested tr.LC_empty_row th {
1.421     albertel 7795:   font-weight: bold;
                   7796:   font-style: italic;
                   7797:   text-align: center;
                   7798:   padding: 8px;
1.1474    raeburn  7799:   border: 0;
1.347     albertel 7800: }
1.795     www      7801: 
1.1114    raeburn  7802: table.LC_data_table tr.LC_empty_row td,
                   7803: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   7804:   background-color: $sidebg;
                   7805: }
                   7806: 
1.1474    raeburn  7807: table.LC_nested tr.LC_empty_row th,
1.940     bisitz   7808: table.LC_nested tr.LC_empty_row td {
1.1474    raeburn  7809:   padding: 4ex;
1.940     bisitz   7810:   background-color: #FFFFFF;
                   7811: }
                   7812: 
1.890     droeschl 7813: table.LC_caption {
                   7814: }
                   7815: 
1.1469    raeburn  7816: caption.LC_caption_prefs {
                   7817:   font-weight: normal;
                   7818:   text-align: left;
                   7819:   padding-bottom: 0.8em;
                   7820: }
                   7821: 
1.507     raeburn  7822: table.LC_nested_outer tr th {
                   7823:   font-weight: bold;
1.801     tempelho 7824:   color:$fontmenu;
1.507     raeburn  7825:   background-color: $data_table_head;
1.701     harmsja  7826:   font-size: small;
1.507     raeburn  7827:   border-bottom: 1px solid #000000;
                   7828: }
1.795     www      7829: 
1.507     raeburn  7830: table.LC_nested_outer tr td.LC_subheader {
                   7831:   background-color: $data_table_head;
                   7832:   font-weight: bold;
                   7833:   font-size: small;
                   7834:   border-bottom: 1px solid #000000;
                   7835:   text-align: right;
1.451     albertel 7836: }
1.795     www      7837: 
1.1474    raeburn  7838: table.LC_nested tr.LC_info_row td,
                   7839: table.LC_nested tr.LC_info_row th {
1.735     bisitz   7840:   background-color: #CCCCCC;
1.451     albertel 7841:   font-weight: bold;
                   7842:   font-size: small;
1.507     raeburn  7843:   text-align: center;
1.1474    raeburn  7844:   border: 0;
1.507     raeburn  7845: }
1.795     www      7846: 
1.589     raeburn  7847: table.LC_nested tr.LC_info_row td.LC_left_item,
1.1474    raeburn  7848: table.LC_nested tr.LC_info_row th.LC_left_item,
1.589     raeburn  7849: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  7850:   text-align: left;
1.451     albertel 7851: }
1.795     www      7852: 
1.507     raeburn  7853: table.LC_nested td {
1.735     bisitz   7854:   background-color: #FFFFFF;
1.451     albertel 7855:   font-size: small;
1.507     raeburn  7856: }
1.795     www      7857: 
1.507     raeburn  7858: table.LC_nested_outer tr th.LC_right_item,
                   7859: table.LC_nested tr.LC_info_row td.LC_right_item,
                   7860: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   7861: table.LC_nested tr td.LC_right_item {
1.451     albertel 7862:   text-align: right;
                   7863: }
                   7864: 
1.507     raeburn  7865: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   7866:   background-color: #EEEEEE;
1.451     albertel 7867: }
                   7868: 
1.473     raeburn  7869: table.LC_createuser {
                   7870: }
                   7871: 
                   7872: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  7873:   font-size: small;
1.473     raeburn  7874: }
                   7875: 
                   7876: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   7877:   background-color: #CCCCCC;
1.473     raeburn  7878:   font-weight: bold;
                   7879:   text-align: center;
                   7880: }
                   7881: 
1.349     albertel 7882: table.LC_calendar {
                   7883:   border: 1px solid #000000;
                   7884:   border-collapse: collapse;
1.917     raeburn  7885:   width: 98%;
1.349     albertel 7886: }
1.795     www      7887: 
1.349     albertel 7888: table.LC_calendar_pickdate {
                   7889:   font-size: xx-small;
                   7890: }
1.795     www      7891: 
1.349     albertel 7892: table.LC_calendar tr td {
                   7893:   border: 1px solid #000000;
                   7894:   vertical-align: top;
1.917     raeburn  7895:   width: 14%;
1.349     albertel 7896: }
1.795     www      7897: 
1.349     albertel 7898: table.LC_calendar tr td.LC_calendar_day_empty {
                   7899:   background-color: $data_table_dark;
                   7900: }
1.795     www      7901: 
1.779     bisitz   7902: table.LC_calendar tr td.LC_calendar_day_current {
                   7903:   background-color: $data_table_highlight;
1.777     tempelho 7904: }
1.795     www      7905: 
1.938     bisitz   7906: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 7907:   background-color: $mail_new;
                   7908: }
1.795     www      7909: 
1.938     bisitz   7910: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 7911:   background-color: $mail_new_hover;
                   7912: }
1.795     www      7913: 
1.938     bisitz   7914: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 7915:   background-color: $mail_read;
                   7916: }
1.795     www      7917: 
1.938     bisitz   7918: /*
                   7919: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 7920:   background-color: $mail_read_hover;
                   7921: }
1.938     bisitz   7922: */
1.795     www      7923: 
1.938     bisitz   7924: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 7925:   background-color: $mail_replied;
                   7926: }
1.795     www      7927: 
1.938     bisitz   7928: /*
                   7929: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 7930:   background-color: $mail_replied_hover;
                   7931: }
1.938     bisitz   7932: */
1.795     www      7933: 
1.938     bisitz   7934: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 7935:   background-color: $mail_other;
                   7936: }
1.795     www      7937: 
1.938     bisitz   7938: /*
                   7939: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 7940:   background-color: $mail_other_hover;
                   7941: }
1.938     bisitz   7942: */
1.494     raeburn  7943: 
1.777     tempelho 7944: table.LC_data_table tr > td.LC_browser_file,
                   7945: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   7946:   background: #AAEE77;
1.389     albertel 7947: }
1.795     www      7948: 
1.777     tempelho 7949: table.LC_data_table tr > td.LC_browser_file_locked,
                   7950: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 7951:   background: #FFAA99;
1.387     albertel 7952: }
1.795     www      7953: 
1.777     tempelho 7954: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   7955:   background: #888888;
1.779     bisitz   7956: }
1.795     www      7957: 
1.777     tempelho 7958: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   7959: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   7960:   background: #F8F866;
1.777     tempelho 7961: }
1.795     www      7962: 
1.696     bisitz   7963: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   7964:   background: #E0E8FF;
1.387     albertel 7965: }
1.696     bisitz   7966: 
1.707     bisitz   7967: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   7968:   /* background: #77FF77; */
1.707     bisitz   7969: }
1.795     www      7970: 
1.707     bisitz   7971: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   7972:   border-right: 8px solid #FFFF77;
1.707     bisitz   7973: }
1.795     www      7974: 
1.707     bisitz   7975: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   7976:   border-right: 8px solid #FFAA77;
1.707     bisitz   7977: }
1.795     www      7978: 
1.707     bisitz   7979: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   7980:   border-right: 8px solid #FF7777;
1.707     bisitz   7981: }
1.795     www      7982: 
1.707     bisitz   7983: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   7984:   border-right: 8px solid #AAFF77;
1.707     bisitz   7985: }
1.795     www      7986: 
1.707     bisitz   7987: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   7988:   border-right: 8px solid #11CC55;
1.707     bisitz   7989: }
                   7990: 
1.1469    raeburn  7991: table.LC_data_table tr.LC_prefs_row {
                   7992:    line-height: 250%;
                   7993: }
                   7994: 
1.1477    raeburn  7995: table.LC_manage_reservations tr th {
                   7996:   font-weight: normal;
                   7997:   font-style: italic;
                   7998:   text-align: left;
                   7999:   background: transparent;
                   8000:   font-size: 100%;
                   8001: }
                   8002: 
1.388     albertel 8003: span.LC_current_location {
1.701     harmsja  8004:   font-size:larger;
1.388     albertel 8005:   background: $pgbg;
                   8006: }
1.387     albertel 8007: 
1.1029    www      8008: span.LC_current_nav_location {
                   8009:   font-weight:bold;
                   8010:   background: $sidebg;
                   8011: }
                   8012: 
1.395     albertel 8013: span.LC_parm_menu_item {
                   8014:   font-size: larger;
                   8015: }
1.795     www      8016: 
1.395     albertel 8017: span.LC_parm_scope_all {
                   8018:   color: red;
                   8019: }
1.795     www      8020: 
1.395     albertel 8021: span.LC_parm_scope_folder {
                   8022:   color: green;
                   8023: }
1.795     www      8024: 
1.395     albertel 8025: span.LC_parm_scope_resource {
                   8026:   color: orange;
                   8027: }
1.795     www      8028: 
1.395     albertel 8029: span.LC_parm_part {
                   8030:   color: blue;
                   8031: }
1.795     www      8032: 
1.911     bisitz   8033: span.LC_parm_folder,
                   8034: span.LC_parm_symb {
1.395     albertel 8035:   font-size: x-small;
                   8036:   font-family: $mono;
                   8037:   color: #AAAAAA;
                   8038: }
                   8039: 
1.977     bisitz   8040: ul.LC_parm_parmlist li {
                   8041:   display: inline-block;
                   8042:   padding: 0.3em 0.8em;
                   8043:   vertical-align: top;
                   8044:   width: 150px;
                   8045:   border-top:1px solid $lg_border_color;
                   8046: }
                   8047: 
1.795     www      8048: td.LC_parm_overview_level_menu,
                   8049: td.LC_parm_overview_map_menu,
                   8050: td.LC_parm_overview_parm_selectors,
                   8051: td.LC_parm_overview_restrictions  {
1.396     albertel 8052:   border: 1px solid black;
                   8053:   border-collapse: collapse;
                   8054: }
1.795     www      8055: 
1.1285    raeburn  8056: span.LC_parm_recursive,
                   8057: td.LC_parm_recursive {
                   8058:   font-weight: bold;
                   8059:   font-size: smaller;
                   8060: }
                   8061: 
1.396     albertel 8062: table.LC_parm_overview_restrictions td {
                   8063:   border-width: 1px 4px 1px 4px;
                   8064:   border-style: solid;
                   8065:   border-color: $pgbg;
                   8066:   text-align: center;
                   8067: }
1.795     www      8068: 
1.396     albertel 8069: table.LC_parm_overview_restrictions th {
                   8070:   background: $tabbg;
                   8071:   border-width: 1px 4px 1px 4px;
                   8072:   border-style: solid;
                   8073:   border-color: $pgbg;
                   8074: }
1.795     www      8075: 
1.1459    raeburn  8076: h1.LC_helpmenu {
                   8077:   display: inline;
                   8078:   font-size: 100%;
                   8079:   font-weight: normal;
                   8080:   line-height: 1em;
                   8081:   margin: 0;
                   8082:   padding: 0;
                   8083:   border: 0;
1.398     albertel 8084: }
1.795     www      8085: 
1.1456    raeburn  8086: .LC_helpdesk_headbox {
                   8087:   border: 2px groove threedface;
                   8088:   padding: 1em;
                   8089: }
                   8090: 
                   8091: h1.LC_helpdesk_legend {
                   8092:   float: left;
                   8093:   margin: -1.7em 0 0;
                   8094:   padding: 0 .5em;
1.397     albertel 8095:   background: $pgbg;
1.1456    raeburn  8096:   font-size: 1em;
                   8097:   font-weight: bold;
                   8098: }
                   8099: 
                   8100: h1.LC_helpdesk_title {
                   8101:   display: inline;
                   8102:   font-size: 1em;
                   8103:   line-height: 2.5em;
                   8104:   margin: 0;
1.803     bisitz   8105:   padding: 0;
1.1456    raeburn  8106:   vertical-align: bottom;
1.397     albertel 8107: }
1.795     www      8108: 
1.1456    raeburn  8109: .LC_helpdesk_links {
                   8110:   border: 1px solid black;
                   8111:   padding: 3px;
1.397     albertel 8112:   background: $tabbg;
1.399     albertel 8113:   text-align: center;
                   8114:   font-weight: bold;
1.1456    raeburn  8115:   display: inline;
                   8116:   margin-right: -6px;
                   8117: }
                   8118: 
                   8119: .LC_helpdesk_img,
                   8120: .LC_helpdesk_text {
                   8121:   padding: 0;
                   8122:   margin: 0;
                   8123:   border: 0;
                   8124:   display: inline;
1.397     albertel 8125: }
1.396     albertel 8126: 
1.1456    raeburn  8127: .LC_helpdesk_img a:link,
                   8128: .LC_helpdesk_img a:visited,
                   8129: .LC_helpdesk_img a:active,
                   8130: .LC_helpdesk_text a:link,
                   8131: .LC_helpdesk_text a:visited,
                   8132: .LC_helpdesk_text a:active {
1.397     albertel 8133:   text-decoration: none;
                   8134:   color: $font;
                   8135: }
1.795     www      8136: 
1.1456    raeburn  8137: div.LC_helpdesk_text a:hover {
1.397     albertel 8138:   text-decoration: underline;
                   8139:   color: $vlink;
                   8140: }
1.396     albertel 8141: 
1.417     albertel 8142: .LC_chrt_popup_exists {
                   8143:   border: 1px solid #339933;
                   8144:   margin: -1px;
                   8145: }
1.795     www      8146: 
1.417     albertel 8147: .LC_chrt_popup_up {
                   8148:   border: 1px solid yellow;
                   8149:   margin: -1px;
                   8150: }
1.795     www      8151: 
1.417     albertel 8152: .LC_chrt_popup {
                   8153:   border: 1px solid #8888FF;
                   8154:   background: #CCCCFF;
                   8155: }
1.795     www      8156: 
1.421     albertel 8157: table.LC_pick_box {
                   8158:   border-collapse: separate;
                   8159:   background: white;
                   8160:   border: 1px solid black;
                   8161:   border-spacing: 1px;
                   8162: }
1.795     www      8163: 
1.1454    raeburn  8164: table.LC_pick_box th.LC_pick_box_title {
1.850     bisitz   8165:   background: $sidebg;
1.421     albertel 8166:   font-weight: bold;
1.900     bisitz   8167:   text-align: left;
1.740     bisitz   8168:   vertical-align: top;
1.421     albertel 8169:   width: 184px;
                   8170:   padding: 8px;
                   8171: }
1.795     www      8172: 
1.579     raeburn  8173: table.LC_pick_box td.LC_pick_box_value {
                   8174:   text-align: left;
                   8175:   padding: 8px;
                   8176: }
1.795     www      8177: 
1.579     raeburn  8178: table.LC_pick_box td.LC_pick_box_select {
                   8179:   text-align: left;
                   8180:   padding: 8px;
                   8181: }
1.795     www      8182: 
1.424     albertel 8183: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   8184:   padding: 0;
1.421     albertel 8185:   height: 1px;
                   8186:   background: black;
                   8187: }
1.795     www      8188: 
1.421     albertel 8189: table.LC_pick_box td.LC_pick_box_submit {
                   8190:   text-align: right;
                   8191: }
1.795     www      8192: 
1.579     raeburn  8193: table.LC_pick_box td.LC_evenrow_value {
                   8194:   text-align: left;
                   8195:   padding: 8px;
                   8196:   background-color: $data_table_light;
                   8197: }
1.795     www      8198: 
1.579     raeburn  8199: table.LC_pick_box td.LC_oddrow_value {
                   8200:   text-align: left;
                   8201:   padding: 8px;
                   8202:   background-color: $data_table_light;
                   8203: }
1.795     www      8204: 
1.1473    raeburn  8205: td.LC_log_filter,
                   8206: th.LC_log_filter {
                   8207:   vertical-align: top;
                   8208:   text-align: left;
                   8209:   padding: 0 4px;
                   8210: }
                   8211: 
1.579     raeburn  8212: span.LC_helpform_receipt_cat {
                   8213:   font-weight: bold;
                   8214: }
1.795     www      8215: 
1.424     albertel 8216: table.LC_group_priv_box {
                   8217:   background: white;
                   8218:   border: 1px solid black;
                   8219:   border-spacing: 1px;
                   8220: }
1.795     www      8221: 
1.424     albertel 8222: table.LC_group_priv_box td.LC_pick_box_title {
                   8223:   background: $tabbg;
                   8224:   font-weight: bold;
                   8225:   text-align: right;
                   8226:   width: 184px;
                   8227: }
1.795     www      8228: 
1.424     albertel 8229: table.LC_group_priv_box td.LC_groups_fixed {
                   8230:   background: $data_table_light;
                   8231:   text-align: center;
                   8232: }
1.795     www      8233: 
1.424     albertel 8234: table.LC_group_priv_box td.LC_groups_optional {
                   8235:   background: $data_table_dark;
                   8236:   text-align: center;
                   8237: }
1.795     www      8238: 
1.424     albertel 8239: table.LC_group_priv_box td.LC_groups_functionality {
                   8240:   background: $data_table_darker;
                   8241:   text-align: center;
                   8242:   font-weight: bold;
                   8243: }
1.795     www      8244: 
1.424     albertel 8245: table.LC_group_priv td {
                   8246:   text-align: left;
1.803     bisitz   8247:   padding: 0;
1.424     albertel 8248: }
                   8249: 
                   8250: .LC_navbuttons {
                   8251:   margin: 2ex 0ex 2ex 0ex;
                   8252: }
1.795     www      8253: 
1.423     albertel 8254: .LC_topic_bar {
                   8255:   font-weight: bold;
                   8256:   background: $tabbg;
1.918     wenzelju 8257:   margin: 1em 0em 1em 2em;
1.805     bisitz   8258:   padding: 3px;
1.918     wenzelju 8259:   font-size: 1.2em;
1.423     albertel 8260: }
1.795     www      8261: 
1.423     albertel 8262: .LC_topic_bar span {
1.918     wenzelju 8263:   left: 0.5em;
                   8264:   position: absolute;
1.423     albertel 8265:   vertical-align: middle;
1.918     wenzelju 8266:   font-size: 1.2em;
1.423     albertel 8267: }
1.795     www      8268: 
1.423     albertel 8269: table.LC_course_group_status {
                   8270:   margin: 20px;
                   8271: }
1.795     www      8272: 
1.423     albertel 8273: table.LC_status_selector td {
                   8274:   vertical-align: top;
                   8275:   text-align: center;
1.424     albertel 8276:   padding: 4px;
                   8277: }
1.795     www      8278: 
1.599     albertel 8279: div.LC_feedback_link {
1.616     albertel 8280:   clear: both;
1.829     kalberla 8281:   background: $sidebg;
1.779     bisitz   8282:   width: 100%;
1.829     kalberla 8283:   padding-bottom: 10px;
                   8284:   border: 1px $tabbg solid;
1.833     kalberla 8285:   height: 22px;
                   8286:   line-height: 22px;
                   8287:   padding-top: 5px;
                   8288: }
                   8289: 
                   8290: div.LC_feedback_link img {
                   8291:   height: 22px;
1.867     kalberla 8292:   vertical-align:middle;
1.829     kalberla 8293: }
                   8294: 
1.911     bisitz   8295: div.LC_feedback_link a {
1.829     kalberla 8296:   text-decoration: none;
1.489     raeburn  8297: }
1.795     www      8298: 
1.867     kalberla 8299: div.LC_comblock {
1.911     bisitz   8300:   display:inline;
1.867     kalberla 8301:   color:$font;
                   8302:   font-size:90%;
                   8303: }
                   8304: 
                   8305: div.LC_feedback_link div.LC_comblock {
                   8306:   padding-left:5px;
                   8307: }
                   8308: 
                   8309: div.LC_feedback_link div.LC_comblock a {
                   8310:   color:$font;
                   8311: }
                   8312: 
1.489     raeburn  8313: span.LC_feedback_link {
1.858     bisitz   8314:   /* background: $feedback_link_bg; */
1.599     albertel 8315:   font-size: larger;
                   8316: }
1.795     www      8317: 
1.599     albertel 8318: span.LC_message_link {
1.858     bisitz   8319:   /* background: $feedback_link_bg; */
1.599     albertel 8320:   font-size: larger;
                   8321:   position: absolute;
                   8322:   right: 1em;
1.489     raeburn  8323: }
1.421     albertel 8324: 
1.515     albertel 8325: table.LC_prior_tries {
1.524     albertel 8326:   border: 1px solid #000000;
                   8327:   border-collapse: separate;
                   8328:   border-spacing: 1px;
1.515     albertel 8329: }
1.523     albertel 8330: 
1.515     albertel 8331: table.LC_prior_tries td {
1.524     albertel 8332:   padding: 2px;
1.515     albertel 8333: }
1.523     albertel 8334: 
                   8335: .LC_answer_correct {
1.795     www      8336:   background: lightgreen;
                   8337:   color: darkgreen;
                   8338:   padding: 6px;
1.523     albertel 8339: }
1.795     www      8340: 
1.523     albertel 8341: .LC_answer_charged_try {
1.797     www      8342:   background: #FFAAAA;
1.795     www      8343:   color: darkred;
                   8344:   padding: 6px;
1.523     albertel 8345: }
1.795     www      8346: 
1.779     bisitz   8347: .LC_answer_not_charged_try,
1.523     albertel 8348: .LC_answer_no_grade,
                   8349: .LC_answer_late {
1.795     www      8350:   background: lightyellow;
1.523     albertel 8351:   color: black;
1.795     www      8352:   padding: 6px;
1.523     albertel 8353: }
1.795     www      8354: 
1.523     albertel 8355: .LC_answer_previous {
1.795     www      8356:   background: lightblue;
                   8357:   color: darkblue;
                   8358:   padding: 6px;
1.523     albertel 8359: }
1.795     www      8360: 
1.779     bisitz   8361: .LC_answer_no_message {
1.777     tempelho 8362:   background: #FFFFFF;
                   8363:   color: black;
1.795     www      8364:   padding: 6px;
1.779     bisitz   8365: }
1.795     www      8366: 
1.1334    raeburn  8367: .LC_answer_unknown,
                   8368: .LC_answer_warning {
1.779     bisitz   8369:   background: orange;
                   8370:   color: black;
1.795     www      8371:   padding: 6px;
1.777     tempelho 8372: }
1.795     www      8373: 
1.1467    raeburn  8374: span.LC_prob_status {
                   8375:   margin: 5px 0 0 0;
                   8376:   padding: 0 5px 0 0;
                   8377:   vertical-align: middle;
                   8378: }
                   8379: 
                   8380: div.LC_prob_status_outer {
                   8381:   display: inline-block;
                   8382:   margin: -5px 0 0 0;
                   8383:   padding: 0;
                   8384: }
                   8385: 
                   8386: div.LC_prob_status_inner {
                   8387:   display: inline-block;
                   8388:   margin: 0 5px 0 0;
                   8389:   padding: 5px;
1.1446    raeburn  8390: }
                   8391: 
1.1468    raeburn  8392: caption.LC_filesub_status {
                   8393:   text-align: left;
                   8394:   font-weight: bold;
                   8395: }
                   8396: 
1.1448    raeburn  8397: .LC_mail_actions {
                   8398:   float: left;
                   8399:   padding: 0;
                   8400:   margin: 6px;
                   8401: }
                   8402: 
                   8403: .LC_vertical_line {
                   8404:   width: 1px;
                   8405:   background-color: black;
                   8406:   height: 4em;
                   8407:   float: left;
                   8408:   margin: 0;
                   8409:   padding: 0;
                   8410: }
                   8411: 
1.529     albertel 8412: span.LC_prior_numerical,
                   8413: span.LC_prior_string,
                   8414: span.LC_prior_custom,
                   8415: span.LC_prior_reaction,
                   8416: span.LC_prior_math {
1.925     bisitz   8417:   font-family: $mono;
1.523     albertel 8418:   white-space: pre;
                   8419: }
                   8420: 
1.525     albertel 8421: span.LC_prior_string {
1.925     bisitz   8422:   font-family: $mono;
1.525     albertel 8423:   white-space: pre;
                   8424: }
                   8425: 
1.523     albertel 8426: table.LC_prior_option {
                   8427:   width: 100%;
                   8428:   border-collapse: collapse;
                   8429: }
1.795     www      8430: 
1.911     bisitz   8431: table.LC_prior_rank,
1.795     www      8432: table.LC_prior_match {
1.528     albertel 8433:   border-collapse: collapse;
                   8434: }
1.795     www      8435: 
1.528     albertel 8436: table.LC_prior_option tr td,
                   8437: table.LC_prior_rank tr td,
                   8438: table.LC_prior_match tr td {
1.524     albertel 8439:   border: 1px solid #000000;
1.515     albertel 8440: }
                   8441: 
1.855     bisitz   8442: .LC_nobreak {
1.544     albertel 8443:   white-space: nowrap;
1.519     raeburn  8444: }
                   8445: 
1.576     raeburn  8446: span.LC_cusr_emph {
                   8447:   font-style: italic;
                   8448: }
                   8449: 
1.633     raeburn  8450: span.LC_cusr_subheading {
                   8451:   font-weight: normal;
                   8452:   font-size: 85%;
                   8453: }
                   8454: 
1.861     bisitz   8455: div.LC_docs_entry_move {
1.859     bisitz   8456:   border: 1px solid #BBBBBB;
1.545     albertel 8457:   background: #DDDDDD;
1.861     bisitz   8458:   width: 22px;
1.859     bisitz   8459:   padding: 1px;
                   8460:   margin: 0;
1.545     albertel 8461: }
                   8462: 
1.861     bisitz   8463: table.LC_data_table tr > td.LC_docs_entry_commands,
                   8464: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 8465:   font-size: x-small;
                   8466: }
1.795     www      8467: 
1.861     bisitz   8468: .LC_docs_entry_parameter {
                   8469:   white-space: nowrap;
                   8470: }
                   8471: 
1.544     albertel 8472: .LC_docs_copy {
1.545     albertel 8473:   color: #000099;
1.544     albertel 8474: }
1.795     www      8475: 
1.544     albertel 8476: .LC_docs_cut {
1.545     albertel 8477:   color: #550044;
1.544     albertel 8478: }
1.795     www      8479: 
1.544     albertel 8480: .LC_docs_rename {
1.545     albertel 8481:   color: #009900;
1.544     albertel 8482: }
1.795     www      8483: 
1.544     albertel 8484: .LC_docs_remove {
1.545     albertel 8485:   color: #990000;
                   8486: }
                   8487: 
1.1284    raeburn  8488: .LC_docs_alias {
                   8489:   color: #440055;  
                   8490: }
                   8491: 
1.1286    raeburn  8492: .LC_domprefs_email,
1.1284    raeburn  8493: .LC_docs_alias_name,
1.547     albertel 8494: .LC_docs_reinit_warn,
                   8495: .LC_docs_ext_edit {
                   8496:   font-size: x-small;
                   8497: }
                   8498: 
1.545     albertel 8499: table.LC_docs_adddocs td,
                   8500: table.LC_docs_adddocs th {
                   8501:   border: 1px solid #BBBBBB;
                   8502:   padding: 4px;
                   8503:   background: #DDDDDD;
1.543     albertel 8504: }
                   8505: 
1.584     albertel 8506: table.LC_sty_begin {
                   8507:   background: #BBFFBB;
                   8508: }
1.795     www      8509: 
1.584     albertel 8510: table.LC_sty_end {
                   8511:   background: #FFBBBB;
                   8512: }
                   8513: 
1.589     raeburn  8514: table.LC_double_column {
1.803     bisitz   8515:   border-width: 0;
1.589     raeburn  8516:   border-collapse: collapse;
                   8517:   width: 100%;
                   8518:   padding: 2px;
                   8519: }
                   8520: 
                   8521: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  8522:   top: 2px;
1.589     raeburn  8523:   left: 2px;
                   8524:   width: 47%;
                   8525:   vertical-align: top;
                   8526: }
                   8527: 
                   8528: table.LC_double_column tr td.LC_right_col {
                   8529:   top: 2px;
1.779     bisitz   8530:   right: 2px;
1.589     raeburn  8531:   width: 47%;
                   8532:   vertical-align: top;
                   8533: }
                   8534: 
1.591     raeburn  8535: div.LC_left_float {
                   8536:   float: left;
                   8537:   padding-right: 5%;
1.597     albertel 8538:   padding-bottom: 4px;
1.591     raeburn  8539: }
                   8540: 
                   8541: div.LC_clear_float_header {
1.597     albertel 8542:   padding-bottom: 2px;
1.591     raeburn  8543: }
                   8544: 
                   8545: div.LC_clear_float_footer {
1.597     albertel 8546:   padding-top: 10px;
1.591     raeburn  8547:   clear: both;
                   8548: }
                   8549: 
1.597     albertel 8550: div.LC_grade_show_user {
1.941     bisitz   8551: /*  border-left: 5px solid $sidebg; */
                   8552:   border-top: 5px solid #000000;
                   8553:   margin: 50px 0 0 0;
1.936     bisitz   8554:   padding: 15px 0 5px 10px;
1.597     albertel 8555: }
1.795     www      8556: 
1.936     bisitz   8557: div.LC_grade_show_user_odd_row {
1.941     bisitz   8558: /*  border-left: 5px solid #000000; */
                   8559: }
                   8560: 
                   8561: div.LC_grade_show_user div.LC_Box {
                   8562:   margin-right: 50px;
1.597     albertel 8563: }
                   8564: 
1.1461    raeburn  8565: div.LC_grade_show_user div.LC_Box table tr th {
                   8566:   font-weight: normal;
                   8567: }
                   8568: 
1.597     albertel 8569: div.LC_grade_submissions,
                   8570: div.LC_grade_message_center,
1.936     bisitz   8571: div.LC_grade_info_links {
1.597     albertel 8572:   margin: 5px;
                   8573:   width: 99%;
                   8574:   background: #FFFFFF;
                   8575: }
1.795     www      8576: 
1.597     albertel 8577: div.LC_grade_submissions_header,
1.936     bisitz   8578: div.LC_grade_message_center_header {
1.705     tempelho 8579:   font-weight: bold;
                   8580:   font-size: large;
1.597     albertel 8581: }
1.795     www      8582: 
1.597     albertel 8583: div.LC_grade_submissions_body,
1.936     bisitz   8584: div.LC_grade_message_center_body {
1.597     albertel 8585:   border: 1px solid black;
                   8586:   width: 99%;
                   8587:   background: #FFFFFF;
                   8588: }
1.795     www      8589: 
1.613     albertel 8590: table.LC_scantron_action {
                   8591:   width: 100%;
                   8592: }
1.795     www      8593: 
1.613     albertel 8594: table.LC_scantron_action tr th {
1.698     harmsja  8595:   font-weight:bold;
                   8596:   font-style:normal;
1.613     albertel 8597: }
1.795     www      8598: 
1.1461    raeburn  8599: div.LC_edit_problem_daxe_header {
                   8600:   padding: 3px;
                   8601:   background: $tabbg;
                   8602:   z-index: 100;
                   8603: }
                   8604: 
1.779     bisitz   8605: .LC_edit_problem_header,
1.614     albertel 8606: div.LC_edit_problem_footer {
1.705     tempelho 8607:   font-weight: normal;
                   8608:   font-size:  medium;
1.602     albertel 8609:   margin: 2px;
1.1060    bisitz   8610:   background-color: $sidebg;
1.600     albertel 8611: }
1.795     www      8612: 
1.600     albertel 8613: div.LC_edit_problem_header,
1.602     albertel 8614: div.LC_edit_problem_header div,
1.614     albertel 8615: div.LC_edit_problem_footer,
                   8616: div.LC_edit_problem_footer div,
1.602     albertel 8617: div.LC_edit_problem_editxml_header,
                   8618: div.LC_edit_problem_editxml_header div {
1.1205    golterma 8619:   z-index: 100;
1.600     albertel 8620: }
1.795     www      8621: 
1.600     albertel 8622: div.LC_edit_problem_header_title {
1.705     tempelho 8623:   font-weight: bold;
                   8624:   font-size: larger;
1.602     albertel 8625:   background: $tabbg;
                   8626:   padding: 3px;
1.1060    bisitz   8627:   margin: 0 0 5px 0;
1.602     albertel 8628: }
1.795     www      8629: 
1.602     albertel 8630: table.LC_edit_problem_header_title {
                   8631:   width: 100%;
1.600     albertel 8632:   background: $tabbg;
1.602     albertel 8633: }
                   8634: 
1.1205    golterma 8635: div.LC_edit_actionbar {
                   8636:     background-color: $sidebg;
1.1218    droeschl 8637:     margin: 0;
                   8638:     padding: 0;
                   8639:     line-height: 200%;
1.602     albertel 8640: }
1.795     www      8641: 
1.1218    droeschl 8642: div.LC_edit_actionbar div{
                   8643:     padding: 0;
                   8644:     margin: 0;
                   8645:     display: inline-block;
1.600     albertel 8646: }
1.795     www      8647: 
1.1124    bisitz   8648: .LC_edit_opt {
                   8649:   padding-left: 1em;
                   8650:   white-space: nowrap;
                   8651: }
                   8652: 
1.1152    golterma 8653: .LC_edit_problem_latexhelper{
                   8654:     text-align: right;
                   8655: }
                   8656: 
                   8657: #LC_edit_problem_colorful div{
                   8658:     margin-left: 40px;
                   8659: }
                   8660: 
1.1205    golterma 8661: #LC_edit_problem_codemirror div{
                   8662:     margin-left: 0px;
                   8663: }
                   8664: 
1.911     bisitz   8665: img.stift {
1.803     bisitz   8666:   border-width: 0;
                   8667:   vertical-align: middle;
1.677     riegler  8668: }
1.680     riegler  8669: 
1.1460    raeburn  8670: div.LC_mainmenu {
                   8671:   margin: 3px 2px 2px 1px;
                   8672:   float: left;
1.777     tempelho 8673: }
1.795     www      8674: 
1.716     raeburn  8675: div.LC_createcourse {
1.911     bisitz   8676:   margin: 10px 10px 10px 10px;
1.716     raeburn  8677: }
                   8678: 
1.917     raeburn  8679: .LC_dccid {
1.1130    raeburn  8680:   float: right;
1.917     raeburn  8681:   margin: 0.2em 0 0 0;
                   8682:   padding: 0;
                   8683:   font-size: 90%;
                   8684:   display:none;
                   8685: }
                   8686: 
1.897     wenzelju 8687: ol.LC_primary_menu a:hover,
1.721     harmsja  8688: ol#LC_MenuBreadcrumbs a:hover,
                   8689: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 8690: ul#LC_secondary_menu a:hover,
1.721     harmsja  8691: .LC_FormSectionClearButton input:hover
1.795     www      8692: ul.LC_TabContent   li:hover a {
1.952     onken    8693:   color:$button_hover;
1.911     bisitz   8694:   text-decoration:none;
1.693     droeschl 8695: }
                   8696: 
1.779     bisitz   8697: h1 {
1.911     bisitz   8698:   padding: 0;
                   8699:   line-height:130%;
1.693     droeschl 8700: }
1.698     harmsja  8701: 
1.911     bisitz   8702: h2,
                   8703: h3,
                   8704: h4,
                   8705: h5,
                   8706: h6 {
                   8707:   margin: 5px 0 5px 0;
                   8708:   padding: 0;
                   8709:   line-height:130%;
1.693     droeschl 8710: }
1.795     www      8711: 
                   8712: .LC_hcell {
1.911     bisitz   8713:   padding:3px 15px 3px 15px;
                   8714:   margin: 0;
                   8715:   background-color:$tabbg;
                   8716:   color:$fontmenu;
                   8717:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 8718: }
1.795     www      8719: 
1.1476    raeburn  8720: .LC_MainMenu_Box > .LC_hcell,
1.840     bisitz   8721: .LC_Box > .LC_hcell {
1.911     bisitz   8722:   margin: 0 -10px 10px -10px;
1.835     bisitz   8723: }
                   8724: 
1.721     harmsja  8725: .LC_noBorder {
1.911     bisitz   8726:   border: 0;
1.698     harmsja  8727: }
1.693     droeschl 8728: 
1.721     harmsja  8729: .LC_FormSectionClearButton input {
1.911     bisitz   8730:   background-color:transparent;
                   8731:   border: none;
                   8732:   cursor:pointer;
                   8733:   text-decoration:underline;
1.693     droeschl 8734: }
1.763     bisitz   8735: 
                   8736: .LC_help_open_topic {
1.911     bisitz   8737:   color: #FFFFFF;
                   8738:   background-color: #EEEEFF;
                   8739:   margin: 1px;
                   8740:   padding: 4px;
                   8741:   border: 1px solid #000033;
                   8742:   white-space: nowrap;
                   8743:   /* vertical-align: middle; */
1.759     neumanie 8744: }
1.693     droeschl 8745: 
1.911     bisitz   8746: dl,
                   8747: ul,
                   8748: div,
                   8749: fieldset {
                   8750:   margin: 10px 10px 10px 0;
                   8751:   /* overflow: hidden; */
1.693     droeschl 8752: }
1.795     www      8753: 
1.1404    raeburn  8754: fieldset#LC_selectuser {
1.1460    raeburn  8755:   margin: -1px 0 0 0;
                   8756:   padding: 0;
                   8757:   border: 0;
1.1404    raeburn  8758: }
                   8759: 
1.1473    raeburn  8760: fieldset.LC_delete_slot {
                   8761:   display:inline;
                   8762:   margin: 0 4px 4px;
                   8763:   padding: 4px;
                   8764: }
                   8765: 
1.1478  ! raeburn  8766: fieldset.LC_grace {
        !          8767:   display:inline;
        !          8768: }
        !          8769: 
        !          8770: fieldset.LC_delete_slot > legend,
        !          8771: fieldset.LC_grace > legend {
1.1473    raeburn  8772:   font-weight: normal;
                   8773: }
                   8774: 
                   8775: p.LC_medium_line {
                   8776:   line-height: 0.85em;
                   8777: }
                   8778: 
1.1211    raeburn  8779: article.geogebraweb div {
                   8780:     margin: 0;
                   8781: }
                   8782: 
1.838     bisitz   8783: fieldset > legend {
1.911     bisitz   8784:   font-weight: bold;
                   8785:   padding: 0 5px 0 5px;
1.838     bisitz   8786: }
                   8787: 
1.813     bisitz   8788: #LC_nav_bar {
1.911     bisitz   8789:   float: left;
1.995     raeburn  8790:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   8791:   margin: 0 0 2px 0;
1.807     droeschl 8792: }
                   8793: 
1.916     droeschl 8794: #LC_realm {
                   8795:   margin: 0.2em 0 0 0;
                   8796:   padding: 0;
                   8797:   font-weight: bold;
                   8798:   text-align: center;
1.995     raeburn  8799:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 8800: }
                   8801: 
1.911     bisitz   8802: #LC_nav_bar em {
                   8803:   font-weight: bold;
                   8804:   font-style: normal;
1.807     droeschl 8805: }
                   8806: 
1.897     wenzelju 8807: ol.LC_primary_menu {
1.934     droeschl 8808:   margin: 0;
1.1076    raeburn  8809:   padding: 0;
1.807     droeschl 8810: }
                   8811: 
1.852     droeschl 8812: ol#LC_PathBreadcrumbs {
1.911     bisitz   8813:   margin: 0;
1.693     droeschl 8814: }
                   8815: 
1.897     wenzelju 8816: ol.LC_primary_menu li {
1.1076    raeburn  8817:   color: RGB(80, 80, 80);
                   8818:   vertical-align: middle;
                   8819:   text-align: left;
                   8820:   list-style: none;
1.1205    golterma 8821:   position: relative;
1.1076    raeburn  8822:   float: left;
1.1205    golterma 8823:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   8824:   line-height: 1.5em;
1.1076    raeburn  8825: }
                   8826: 
1.1205    golterma 8827: ol.LC_primary_menu li a,
                   8828: ol.LC_primary_menu li p {
1.1076    raeburn  8829:   display: block;
                   8830:   margin: 0;
                   8831:   padding: 0 5px 0 10px;
                   8832:   text-decoration: none;
                   8833: }
                   8834: 
1.1205    golterma 8835: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   8836:   display: inline-block;
                   8837:   width: 95%;
                   8838:   text-align: left;
                   8839: }
                   8840: 
                   8841: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   8842:   display: inline-block;	
                   8843:   width: 5%;
                   8844:   float: right;
                   8845:   text-align: right;
                   8846:   font-size: 70%;
                   8847: }
                   8848: 
                   8849: ol.LC_primary_menu ul {
1.1076    raeburn  8850:   display: none;
1.1205    golterma 8851:   width: 15em;
1.1076    raeburn  8852:   background-color: $data_table_light;
1.1205    golterma 8853:   position: absolute;
                   8854:   top: 100%;
1.1076    raeburn  8855: }
                   8856: 
1.1205    golterma 8857: ol.LC_primary_menu ul ul {
                   8858:   left: 100%;
                   8859:   top: 0;
                   8860: }
                   8861: 
                   8862: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076    raeburn  8863:   display: block;
                   8864:   position: absolute;
                   8865:   margin: 0;
                   8866:   padding: 0;
1.1078    raeburn  8867:   z-index: 2;
1.1076    raeburn  8868: }
                   8869: 
                   8870: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205    golterma 8871: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076    raeburn  8872:   font-size: 90%;
1.911     bisitz   8873:   vertical-align: top;
1.1076    raeburn  8874:   float: none;
1.1079    raeburn  8875:   border-left: 1px solid black;
                   8876:   border-right: 1px solid black;
1.1205    golterma 8877: /* A dark bottom border to visualize different menu options; 
                   8878: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   8879:   border-bottom: 1px solid $data_table_dark; 
1.1076    raeburn  8880: }
                   8881: 
1.1205    golterma 8882: ol.LC_primary_menu li li p:hover {
                   8883:   color:$button_hover;
                   8884:   text-decoration:none;
                   8885:   background-color:$data_table_dark;
1.1076    raeburn  8886: }
                   8887: 
                   8888: ol.LC_primary_menu li li a:hover {
                   8889:    color:$button_hover;
                   8890:    background-color:$data_table_dark;
1.693     droeschl 8891: }
                   8892: 
1.1205    golterma 8893: /* Font-size equal to the size of the predecessors*/
                   8894: ol.LC_primary_menu li:hover li li {
                   8895:   font-size: 100%;
                   8896: }
                   8897: 
1.897     wenzelju 8898: ol.LC_primary_menu li img {
1.911     bisitz   8899:   vertical-align: bottom;
1.934     droeschl 8900:   height: 1.1em;
1.1077    raeburn  8901:   margin: 0.2em 0 0 0;
1.693     droeschl 8902: }
                   8903: 
1.897     wenzelju 8904: ol.LC_primary_menu a {
1.911     bisitz   8905:   color: RGB(80, 80, 80);
                   8906:   text-decoration: none;
1.693     droeschl 8907: }
1.795     www      8908: 
1.949     droeschl 8909: ol.LC_primary_menu a.LC_new_message {
                   8910:   font-weight:bold;
                   8911:   color: darkred;
                   8912: }
                   8913: 
1.975     raeburn  8914: ol.LC_docs_parameters {
                   8915:   margin-left: 0;
                   8916:   padding: 0;
                   8917:   list-style: none;
                   8918: }
                   8919: 
                   8920: ol.LC_docs_parameters li {
                   8921:   margin: 0;
                   8922:   padding-right: 20px;
                   8923:   display: inline;
                   8924: }
                   8925: 
1.976     raeburn  8926: ol.LC_docs_parameters li:before {
                   8927:   content: "\\002022 \\0020";
                   8928: }
                   8929: 
                   8930: li.LC_docs_parameters_title {
                   8931:   font-weight: bold;
                   8932: }
                   8933: 
                   8934: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   8935:   content: "";
                   8936: }
                   8937: 
1.897     wenzelju 8938: ul#LC_secondary_menu {
1.1107    raeburn  8939:   clear: right;
1.911     bisitz   8940:   color: $fontmenu;
                   8941:   background: $tabbg;
                   8942:   list-style: none;
                   8943:   padding: 0;
                   8944:   margin: 0;
                   8945:   width: 100%;
1.995     raeburn  8946:   text-align: left;
1.1107    raeburn  8947:   float: left;
1.808     droeschl 8948: }
                   8949: 
1.897     wenzelju 8950: ul#LC_secondary_menu li {
1.911     bisitz   8951:   font-weight: bold;
                   8952:   line-height: 1.8em;
1.1107    raeburn  8953:   border-right: 1px solid black;
                   8954:   float: left;
                   8955: }
                   8956: 
                   8957: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   8958:   background-color: $data_table_light;
                   8959: }
                   8960: 
                   8961: ul#LC_secondary_menu li a {
1.911     bisitz   8962:   padding: 0 0.8em;
1.1107    raeburn  8963: }
                   8964: 
                   8965: ul#LC_secondary_menu li ul {
                   8966:   display: none;
                   8967: }
                   8968: 
                   8969: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   8970:   display: block;
                   8971:   position: absolute;
                   8972:   margin: 0;
                   8973:   padding: 0;
                   8974:   list-style:none;
                   8975:   float: none;
                   8976:   background-color: $data_table_light;
                   8977:   z-index: 2;
                   8978:   margin-left: -1px;
                   8979: }
                   8980: 
                   8981: ul#LC_secondary_menu li ul li {
                   8982:   font-size: 90%;
                   8983:   vertical-align: top;
                   8984:   border-left: 1px solid black;
1.911     bisitz   8985:   border-right: 1px solid black;
1.1119    raeburn  8986:   background-color: $data_table_light;
1.1107    raeburn  8987:   list-style:none;
                   8988:   float: none;
                   8989: }
                   8990: 
                   8991: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   8992:   background-color: $data_table_dark;
1.807     droeschl 8993: }
                   8994: 
1.847     tempelho 8995: ul.LC_TabContent {
1.911     bisitz   8996:   display:block;
                   8997:   background: $sidebg;
                   8998:   border-bottom: solid 1px $lg_border_color;
                   8999:   list-style:none;
1.1020    raeburn  9000:   margin: -1px -10px 0 -10px;
1.911     bisitz   9001:   padding: 0;
1.693     droeschl 9002: }
                   9003: 
1.795     www      9004: ul.LC_TabContent li,
                   9005: ul.LC_TabContentBigger li {
1.911     bisitz   9006:   float:left;
1.741     harmsja  9007: }
1.795     www      9008: 
1.897     wenzelju 9009: ul#LC_secondary_menu li a {
1.911     bisitz   9010:   color: $fontmenu;
                   9011:   text-decoration: none;
1.693     droeschl 9012: }
1.795     www      9013: 
1.721     harmsja  9014: ul.LC_TabContent {
1.952     onken    9015:   min-height:20px;
1.721     harmsja  9016: }
1.795     www      9017: 
                   9018: ul.LC_TabContent li {
1.911     bisitz   9019:   vertical-align:middle;
1.959     onken    9020:   padding: 0 16px 0 10px;
1.911     bisitz   9021:   background-color:$tabbg;
                   9022:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  9023:   border-left: solid 1px $font;
1.721     harmsja  9024: }
1.795     www      9025: 
1.847     tempelho 9026: ul.LC_TabContent .right {
1.911     bisitz   9027:   float:right;
1.847     tempelho 9028: }
                   9029: 
1.911     bisitz   9030: ul.LC_TabContent li a,
                   9031: ul.LC_TabContent li {
                   9032:   color:rgb(47,47,47);
                   9033:   text-decoration:none;
                   9034:   font-size:95%;
                   9035:   font-weight:bold;
1.952     onken    9036:   min-height:20px;
                   9037: }
                   9038: 
1.959     onken    9039: ul.LC_TabContent li a:hover,
                   9040: ul.LC_TabContent li a:focus {
1.952     onken    9041:   color: $button_hover;
1.959     onken    9042:   background:none;
                   9043:   outline:none;
1.952     onken    9044: }
                   9045: 
                   9046: ul.LC_TabContent li:hover {
                   9047:   color: $button_hover;
                   9048:   cursor:pointer;
1.721     harmsja  9049: }
1.795     www      9050: 
1.911     bisitz   9051: ul.LC_TabContent li.active {
1.952     onken    9052:   color: $font;
1.911     bisitz   9053:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    9054:   border-bottom:solid 1px #FFFFFF;
                   9055:   cursor: default;
1.744     ehlerst  9056: }
1.795     www      9057: 
1.959     onken    9058: ul.LC_TabContent li.active a {
                   9059:   color:$font;
                   9060:   background:#FFFFFF;
                   9061:   outline: none;
                   9062: }
1.1047    raeburn  9063: 
                   9064: ul.LC_TabContent li.goback {
                   9065:   float: left;
                   9066:   border-left: none;
                   9067: }
                   9068: 
1.870     tempelho 9069: #maincoursedoc {
1.911     bisitz   9070:   clear:both;
1.870     tempelho 9071: }
                   9072: 
                   9073: ul.LC_TabContentBigger {
1.911     bisitz   9074:   display:block;
                   9075:   list-style:none;
                   9076:   padding: 0;
1.870     tempelho 9077: }
                   9078: 
1.795     www      9079: ul.LC_TabContentBigger li {
1.911     bisitz   9080:   vertical-align:bottom;
                   9081:   height: 30px;
                   9082:   font-size:110%;
                   9083:   font-weight:bold;
                   9084:   color: #737373;
1.841     tempelho 9085: }
                   9086: 
1.957     onken    9087: ul.LC_TabContentBigger li.active {
                   9088:   position: relative;
                   9089:   top: 1px;
                   9090: }
                   9091: 
1.870     tempelho 9092: ul.LC_TabContentBigger li a {
1.911     bisitz   9093:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   9094:   height: 30px;
                   9095:   line-height: 30px;
                   9096:   text-align: center;
                   9097:   display: block;
                   9098:   text-decoration: none;
1.958     onken    9099:   outline: none;  
1.741     harmsja  9100: }
1.795     www      9101: 
1.870     tempelho 9102: ul.LC_TabContentBigger li.active a {
1.911     bisitz   9103:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   9104:   color:$font;
1.744     ehlerst  9105: }
1.795     www      9106: 
1.870     tempelho 9107: ul.LC_TabContentBigger li b {
1.911     bisitz   9108:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   9109:   display: block;
                   9110:   float: left;
                   9111:   padding: 0 30px;
1.957     onken    9112:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 9113: }
                   9114: 
1.956     onken    9115: ul.LC_TabContentBigger li:hover b {
                   9116:   color:$button_hover;
                   9117: }
                   9118: 
1.870     tempelho 9119: ul.LC_TabContentBigger li.active b {
1.911     bisitz   9120:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   9121:   color:$font;
1.957     onken    9122:   border: 0;
1.741     harmsja  9123: }
1.693     droeschl 9124: 
1.870     tempelho 9125: 
1.862     bisitz   9126: ul.LC_CourseBreadcrumbs {
                   9127:   background: $sidebg;
1.1020    raeburn  9128:   height: 2em;
1.862     bisitz   9129:   padding-left: 10px;
1.1020    raeburn  9130:   margin: 0;
1.862     bisitz   9131:   list-style-position: inside;
                   9132: }
                   9133: 
1.911     bisitz   9134: ol#LC_MenuBreadcrumbs,
1.862     bisitz   9135: ol#LC_PathBreadcrumbs {
1.911     bisitz   9136:   padding-left: 10px;
                   9137:   margin: 0;
1.933     droeschl 9138:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 9139: }
                   9140: 
1.911     bisitz   9141: ol#LC_MenuBreadcrumbs li,
                   9142: ol#LC_PathBreadcrumbs li,
1.862     bisitz   9143: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   9144:   display: inline;
1.933     droeschl 9145:   white-space: normal;  
1.693     droeschl 9146: }
                   9147: 
1.823     bisitz   9148: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   9149: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   9150:   text-decoration: none;
                   9151:   font-size:90%;
1.693     droeschl 9152: }
1.795     www      9153: 
1.969     droeschl 9154: ol#LC_MenuBreadcrumbs h1 {
                   9155:   display: inline;
                   9156:   font-size: 90%;
                   9157:   line-height: 2.5em;
                   9158:   margin: 0;
                   9159:   padding: 0;
                   9160: }
                   9161: 
1.795     www      9162: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   9163:   text-decoration:none;
                   9164:   font-size:100%;
                   9165:   font-weight:bold;
1.693     droeschl 9166: }
1.795     www      9167: 
1.840     bisitz   9168: .LC_Box {
1.911     bisitz   9169:   border: solid 1px $lg_border_color;
                   9170:   padding: 0 10px 10px 10px;
1.746     neumanie 9171: }
1.795     www      9172: 
1.1020    raeburn  9173: .LC_DocsBox {
                   9174:   border: solid 1px $lg_border_color;
                   9175:   padding: 0 0 10px 10px;
                   9176: }
                   9177: 
1.1476    raeburn  9178: .LC_MainMenu_Box {
                   9179:   border: solid 1px $lg_border_color;
                   9180:   padding: 0 10px 0 10px;
                   9181: }
                   9182: 
1.795     www      9183: .LC_AboutMe_Image {
1.911     bisitz   9184:   float:left;
                   9185:   margin-right:10px;
1.747     neumanie 9186: }
1.795     www      9187: 
                   9188: .LC_Clear_AboutMe_Image {
1.911     bisitz   9189:   clear:left;
1.747     neumanie 9190: }
1.795     www      9191: 
1.721     harmsja  9192: dl.LC_ListStyleClean dt {
1.911     bisitz   9193:   padding-right: 5px;
                   9194:   display: table-header-group;
1.693     droeschl 9195: }
                   9196: 
1.721     harmsja  9197: dl.LC_ListStyleClean dd {
1.911     bisitz   9198:   display: table-row;
1.693     droeschl 9199: }
                   9200: 
1.721     harmsja  9201: .LC_ListStyleClean,
                   9202: .LC_ListStyleSimple,
                   9203: .LC_ListStyleNormal,
1.1476    raeburn  9204: .LC_ListStyleMainMenu,
1.795     www      9205: .LC_ListStyleSpecial {
1.911     bisitz   9206:   /* display:block; */
                   9207:   list-style-position: inside;
                   9208:   list-style-type: none;
                   9209:   overflow: hidden;
                   9210:   padding: 0;
1.693     droeschl 9211: }
                   9212: 
1.721     harmsja  9213: .LC_ListStyleSimple li,
                   9214: .LC_ListStyleSimple dd,
                   9215: .LC_ListStyleNormal li,
                   9216: .LC_ListStyleNormal dd,
                   9217: .LC_ListStyleSpecial li,
1.795     www      9218: .LC_ListStyleSpecial dd {
1.911     bisitz   9219:   margin: 0;
                   9220:   padding: 5px 5px 5px 10px;
                   9221:   clear: both;
1.693     droeschl 9222: }
                   9223: 
1.721     harmsja  9224: .LC_ListStyleClean li,
                   9225: .LC_ListStyleClean dd {
1.911     bisitz   9226:   padding-top: 0;
                   9227:   padding-bottom: 0;
1.693     droeschl 9228: }
                   9229: 
1.721     harmsja  9230: .LC_ListStyleSimple dd,
1.795     www      9231: .LC_ListStyleSimple li {
1.911     bisitz   9232:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 9233: }
                   9234: 
1.721     harmsja  9235: .LC_ListStyleSpecial li,
                   9236: .LC_ListStyleSpecial dd {
1.911     bisitz   9237:   list-style-type: none;
                   9238:   background-color: RGB(220, 220, 220);
                   9239:   margin-bottom: 4px;
1.693     droeschl 9240: }
                   9241: 
1.1476    raeburn  9242: .LC_ListStyleMainMenu li {
                   9243:   margin: 0;
                   9244:   padding: 2px 5px 2px 10px;
                   9245:   clear: both;
                   9246: }
                   9247: 
1.721     harmsja  9248: table.LC_SimpleTable {
1.911     bisitz   9249:   margin:5px;
                   9250:   border:solid 1px $lg_border_color;
1.795     www      9251: }
1.693     droeschl 9252: 
1.721     harmsja  9253: table.LC_SimpleTable tr {
1.911     bisitz   9254:   padding: 0;
                   9255:   border:solid 1px $lg_border_color;
1.693     droeschl 9256: }
1.795     www      9257: 
                   9258: table.LC_SimpleTable thead {
1.911     bisitz   9259:   background:rgb(220,220,220);
1.693     droeschl 9260: }
                   9261: 
1.721     harmsja  9262: div.LC_columnSection {
1.911     bisitz   9263:   display: block;
                   9264:   clear: both;
                   9265:   overflow: hidden;
                   9266:   margin: 0;
1.693     droeschl 9267: }
                   9268: 
1.721     harmsja  9269: div.LC_columnSection>* {
1.911     bisitz   9270:   float: left;
                   9271:   margin: 10px 20px 10px 0;
                   9272:   overflow:hidden;
1.693     droeschl 9273: }
1.721     harmsja  9274: 
1.795     www      9275: table em {
1.911     bisitz   9276:   font-weight: bold;
                   9277:   font-style: normal;
1.748     schulted 9278: }
1.795     www      9279: 
1.779     bisitz   9280: table.LC_tableBrowseRes,
1.795     www      9281: table.LC_tableOfContent {
1.911     bisitz   9282:   border:none;
                   9283:   border-spacing: 1px;
                   9284:   padding: 3px;
                   9285:   background-color: #FFFFFF;
                   9286:   font-size: 90%;
1.753     droeschl 9287: }
1.789     droeschl 9288: 
1.911     bisitz   9289: table.LC_tableOfContent {
                   9290:   border-collapse: collapse;
1.789     droeschl 9291: }
                   9292: 
1.771     droeschl 9293: table.LC_tableBrowseRes a,
1.768     schulted 9294: table.LC_tableOfContent a {
1.911     bisitz   9295:   background-color: transparent;
                   9296:   text-decoration: none;
1.753     droeschl 9297: }
                   9298: 
1.795     www      9299: table.LC_tableOfContent img {
1.911     bisitz   9300:   border: none;
                   9301:   height: 1.3em;
                   9302:   vertical-align: text-bottom;
                   9303:   margin-right: 0.3em;
1.753     droeschl 9304: }
1.757     schulted 9305: 
1.795     www      9306: a#LC_content_toolbar_firsthomework {
1.911     bisitz   9307:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  9308: }
                   9309: 
1.795     www      9310: a#LC_content_toolbar_everything {
1.911     bisitz   9311:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  9312: }
                   9313: 
1.795     www      9314: a#LC_content_toolbar_uncompleted {
1.911     bisitz   9315:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  9316: }
                   9317: 
1.795     www      9318: #LC_content_toolbar_clearbubbles {
1.911     bisitz   9319:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  9320: }
                   9321: 
1.795     www      9322: a#LC_content_toolbar_changefolder {
1.911     bisitz   9323:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 9324: }
                   9325: 
1.795     www      9326: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   9327:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 9328: }
                   9329: 
1.1043    raeburn  9330: a#LC_content_toolbar_edittoplevel {
                   9331:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   9332: }
                   9333: 
1.1384    raeburn  9334: a#LC_content_toolbar_printout {
                   9335:   background-image:url(/res/adm/pages/printout.gif);
                   9336: }
                   9337: 
1.795     www      9338: ul#LC_toolbar li a:hover {
1.911     bisitz   9339:   background-position: bottom center;
1.757     schulted 9340: }
                   9341: 
1.795     www      9342: ul#LC_toolbar {
1.911     bisitz   9343:   padding: 0;
                   9344:   margin: 2px;
                   9345:   list-style:none;
1.1449    raeburn  9346:   display:inline;
1.911     bisitz   9347:   background-color:white;
1.1082    raeburn  9348:   overflow: auto;
1.757     schulted 9349: }
                   9350: 
1.795     www      9351: ul#LC_toolbar li {
1.911     bisitz   9352:   border:1px solid white;
                   9353:   padding: 0;
                   9354:   margin: 0;
                   9355:   float: left;
                   9356:   display:inline;
                   9357:   vertical-align:middle;
1.1082    raeburn  9358:   white-space: nowrap;
1.911     bisitz   9359: }
1.757     schulted 9360: 
1.783     amueller 9361: 
1.795     www      9362: a.LC_toolbarItem {
1.911     bisitz   9363:   display:block;
                   9364:   padding: 0;
                   9365:   margin: 0;
                   9366:   height: 32px;
                   9367:   width: 32px;
                   9368:   color:white;
                   9369:   border: none;
                   9370:   background-repeat:no-repeat;
                   9371:   background-color:transparent;
1.757     schulted 9372: }
                   9373: 
1.1449    raeburn  9374: .LC_navtools {
                   9375:   display: inline-block;
                   9376:   padding: 0;
                   9377:   margin: 2px;
                   9378:   vertical-align: middle;
                   9379: }
                   9380: 
1.915     droeschl 9381: ul.LC_funclist {
                   9382:     margin: 0;
                   9383:     padding: 0.5em 1em 0.5em 0;
                   9384: }
                   9385: 
1.933     droeschl 9386: ul.LC_funclist > li:first-child {
                   9387:     font-weight:bold; 
                   9388:     margin-left:0.8em;
                   9389: }
                   9390: 
1.915     droeschl 9391: ul.LC_funclist + ul.LC_funclist {
                   9392:     /* 
                   9393:        left border as a seperator if we have more than
                   9394:        one list 
                   9395:     */
                   9396:     border-left: 1px solid $sidebg;
                   9397:     /* 
                   9398:        this hides the left border behind the border of the 
                   9399:        outer box if element is wrapped to the next 'line' 
                   9400:     */
                   9401:     margin-left: -1px;
                   9402: }
                   9403: 
1.843     bisitz   9404: ul.LC_funclist li {
1.915     droeschl 9405:   display: inline;
1.782     bisitz   9406:   white-space: nowrap;
1.915     droeschl 9407:   margin: 0 0 0 25px;
                   9408:   line-height: 150%;
1.782     bisitz   9409: }
                   9410: 
1.974     wenzelju 9411: .LC_hidden {
                   9412:   display: none;
                   9413: }
                   9414: 
1.1030    www      9415: .LCmodal-overlay {
                   9416: 		position:fixed;
                   9417: 		top:0;
                   9418: 		right:0;
                   9419: 		bottom:0;
                   9420: 		left:0;
                   9421: 		height:100%;
                   9422: 		width:100%;
                   9423: 		margin:0;
                   9424: 		padding:0;
                   9425: 		background:#999;
                   9426: 		opacity:.75;
                   9427: 		filter: alpha(opacity=75);
                   9428: 		-moz-opacity: 0.75;
                   9429: 		z-index:101;
                   9430: }
                   9431: 
                   9432: * html .LCmodal-overlay {   
                   9433: 		position: absolute;
                   9434: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   9435: }
                   9436: 
                   9437: .LCmodal-window {
                   9438: 		position:fixed;
                   9439: 		top:50%;
                   9440: 		left:50%;
                   9441: 		margin:0;
                   9442: 		padding:0;
                   9443: 		z-index:102;
                   9444: 	}
                   9445: 
                   9446: * html .LCmodal-window {
                   9447: 		position:absolute;
                   9448: }
                   9449: 
                   9450: .LCclose-window {
                   9451: 		position:absolute;
                   9452: 		width:32px;
                   9453: 		height:32px;
                   9454: 		right:8px;
                   9455: 		top:8px;
                   9456: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   9457: 		text-indent:-99999px;
                   9458: 		overflow:hidden;
                   9459: 		cursor:pointer;
                   9460: }
                   9461: 
1.1369    raeburn  9462: .LCisDisabled {
                   9463:   cursor: not-allowed;
                   9464:   opacity: 0.5;
                   9465: }
                   9466: 
                   9467: a[aria-disabled="true"] {
                   9468:   color: currentColor;
                   9469:   display: inline-block;  /* For IE11/ MS Edge bug */
                   9470:   pointer-events: none;
                   9471:   text-decoration: none;
                   9472: }
                   9473: 
1.1335    raeburn  9474: pre.LC_wordwrap {
                   9475:   white-space: pre-wrap;
                   9476:   white-space: -moz-pre-wrap;
                   9477:   white-space: -pre-wrap;
                   9478:   white-space: -o-pre-wrap;
                   9479:   word-wrap: break-word;
                   9480: }
                   9481: 
1.1100    raeburn  9482: /*
1.1231    damieng  9483:   styles used for response display
                   9484: */
1.1464    raeburn  9485: div.LC_radiofoil, div.LC_rankfoil, div.LC_optionfoil, div.LC_matchfoil, div.LC_login_links {
1.1231    damieng  9486:   margin: .5em 0em .5em 0em;
                   9487: }
                   9488: table.LC_itemgroup {
                   9489:   margin-top: 1em;
                   9490: }
                   9491: 
1.1462    raeburn  9492: table.LC_itemgroup tr th {
                   9493:   font-weight: normal;
                   9494: }
                   9495: 
                   9496: fieldset.LC_webbubbles {
                   9497:   margin: 2px 0 0 0;
                   9498:   padding: 0;
                   9499:   border: 0;
                   9500: }
                   9501: 
                   9502: ul.LC_webbubbles {
                   9503:   list-style: none;
                   9504:   padding: 0;
                   9505:   margin: 0;
                   9506:   text-align: left;
                   9507:   float: left;
                   9508: }
                   9509: 
                   9510: ul.LC_webbubbles li {
                   9511:   line-height: 1.8em;
                   9512:   border: 1px solid black;
                   9513:   padding: 0 2px 0 5px;
                   9514:   margin: 0 0 0 -1px;
                   9515:   float: left;
                   9516: }
                   9517: 
1.1231    damieng  9518: /*
1.1100    raeburn  9519:   styles used by TTH when "Default set of options to pass to tth/m
                   9520:   when converting TeX" in course settings has been set
                   9521: 
                   9522:   option passed: -t
                   9523: 
                   9524: */
                   9525: 
                   9526: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   9527: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   9528: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   9529: td div.norm {line-height:normal;}
                   9530: 
                   9531: /*
                   9532:   option passed -y3
                   9533: */
                   9534: 
                   9535: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   9536: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   9537: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   9538: 
1.1230    damieng  9539: /*
                   9540:   sections with roles, for content only
                   9541: */
                   9542: section[class^="role-"] {
                   9543:   padding-left: 10px;
                   9544:   padding-right: 5px;
                   9545:   margin-top: 8px;
                   9546:   margin-bottom: 8px;
                   9547:   border: 1px solid #2A4;
                   9548:   border-radius: 5px;
                   9549:   box-shadow: 0px 1px 1px #BBB;
                   9550: }
                   9551: section[class^="role-"]>h1 {
                   9552:   position: relative;
                   9553:   margin: 0px;
                   9554:   padding-top: 10px;
                   9555:   padding-left: 40px;
                   9556: }
                   9557: section[class^="role-"]>h1:before {
                   9558:   position: absolute;
                   9559:   left: -5px;
                   9560:   top: 5px;
                   9561: }
                   9562: section.role-activity>h1:before {
                   9563:   content:url('/adm/daxe/images/section_icons/activity.png');
                   9564: }
                   9565: section.role-advice>h1:before {
                   9566:   content:url('/adm/daxe/images/section_icons/advice.png');
                   9567: }
                   9568: section.role-bibliography>h1:before {
                   9569:   content:url('/adm/daxe/images/section_icons/bibliography.png');
                   9570: }
                   9571: section.role-citation>h1:before {
                   9572:   content:url('/adm/daxe/images/section_icons/citation.png');
                   9573: }
                   9574: section.role-conclusion>h1:before {
                   9575:   content:url('/adm/daxe/images/section_icons/conclusion.png');
                   9576: }
                   9577: section.role-definition>h1:before {
                   9578:   content:url('/adm/daxe/images/section_icons/definition.png');
                   9579: }
                   9580: section.role-demonstration>h1:before {
                   9581:   content:url('/adm/daxe/images/section_icons/demonstration.png');
                   9582: }
                   9583: section.role-example>h1:before {
                   9584:   content:url('/adm/daxe/images/section_icons/example.png');
                   9585: }
                   9586: section.role-explanation>h1:before {
                   9587:   content:url('/adm/daxe/images/section_icons/explanation.png');
                   9588: }
                   9589: section.role-introduction>h1:before {
                   9590:   content:url('/adm/daxe/images/section_icons/introduction.png');
                   9591: }
                   9592: section.role-method>h1:before {
                   9593:   content:url('/adm/daxe/images/section_icons/method.png');
                   9594: }
                   9595: section.role-more_information>h1:before {
                   9596:   content:url('/adm/daxe/images/section_icons/more_information.png');
                   9597: }
                   9598: section.role-objectives>h1:before {
                   9599:   content:url('/adm/daxe/images/section_icons/objectives.png');
                   9600: }
                   9601: section.role-prerequisites>h1:before {
                   9602:   content:url('/adm/daxe/images/section_icons/prerequisites.png');
                   9603: }
                   9604: section.role-remark>h1:before {
                   9605:   content:url('/adm/daxe/images/section_icons/remark.png');
                   9606: }
                   9607: section.role-reminder>h1:before {
                   9608:   content:url('/adm/daxe/images/section_icons/reminder.png');
                   9609: }
                   9610: section.role-summary>h1:before {
                   9611:   content:url('/adm/daxe/images/section_icons/summary.png');
                   9612: }
                   9613: section.role-syntax>h1:before {
                   9614:   content:url('/adm/daxe/images/section_icons/syntax.png');
                   9615: }
                   9616: section.role-warning>h1:before {
                   9617:   content:url('/adm/daxe/images/section_icons/warning.png');
                   9618: }
                   9619: 
1.1269    raeburn  9620: #LC_minitab_header {
                   9621:   float:left;
                   9622:   width:100%;
                   9623:   background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
                   9624:   font-size:93%;
                   9625:   line-height:normal;
                   9626:   margin: 0.5em 0 0.5em 0;
                   9627: }
                   9628: #LC_minitab_header ul {
                   9629:   margin:0;
                   9630:   padding:10px 10px 0;
                   9631:   list-style:none;
                   9632: }
                   9633: #LC_minitab_header li {
                   9634:   float:left;
                   9635:   background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
                   9636:   margin:0;
                   9637:   padding:0 0 0 9px;
                   9638: }
                   9639: #LC_minitab_header a {
                   9640:   display:block;
                   9641:   background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
                   9642:   padding:5px 15px 4px 6px;
                   9643: }
                   9644: #LC_minitab_header #LC_current_minitab {
                   9645:   background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
                   9646: }
                   9647: #LC_minitab_header #LC_current_minitab a {
                   9648:   background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
                   9649:   padding-bottom:5px;
                   9650: }
                   9651: 
                   9652: 
1.343     albertel 9653: END
                   9654: }
                   9655: 
1.306     albertel 9656: =pod
                   9657: 
                   9658: =item * &headtag()
                   9659: 
                   9660: Returns a uniform footer for LON-CAPA web pages.
                   9661: 
1.307     albertel 9662: Inputs: $title - optional title for the head
                   9663:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 9664:         $args - optional arguments
1.319     albertel 9665:             force_register - if is true call registerurl so the remote is 
                   9666:                              informed
1.415     albertel 9667:             redirect       -> array ref of
                   9668:                                    1- seconds before redirect occurs
                   9669:                                    2- url to redirect to
                   9670:                                    3- whether the side effect should occur
1.315     albertel 9671:                            (side effect of setting 
                   9672:                                $env{'internal.head.redirect'} to the url 
1.1386    raeburn  9673:                                redirected to)
                   9674:                                    4- whether the redirect target should be
                   9675:                                       the opener of the current (pop-up)
                   9676:                                       window (side effect of setting
                   9677:                                       $env{'internal.head.to_opener'} to
                   9678:                                       1, if true.
1.1388    raeburn  9679:                                    5- whether encrypt check should be skipped
1.352     albertel 9680:             domain         -> force to color decorate a page for a specific
                   9681:                                domain
                   9682:             function       -> force usage of a specific rolish color scheme
                   9683:             bgcolor        -> override the default page bgcolor
1.460     albertel 9684:             no_auto_mt_title
                   9685:                            -> prevent &mt()ing the title arg
1.464     albertel 9686: 
1.306     albertel 9687: =cut
                   9688: 
                   9689: sub headtag {
1.313     albertel 9690:     my ($title,$head_extra,$args) = @_;
1.306     albertel 9691:     
1.363     albertel 9692:     my $function = $args->{'function'} || &get_users_function();
                   9693:     my $domain   = $args->{'domain'}   || &determinedomain();
                   9694:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1154    raeburn  9695:     my $httphost = $args->{'use_absolute'};
1.418     albertel 9696:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 9697: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 9698: 		   #time(),
1.418     albertel 9699: 		   $env{'environment.color.timestamp'},
1.363     albertel 9700: 		   $function,$domain,$bgcolor);
                   9701: 
1.369     www      9702:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 9703: 
1.308     albertel 9704:     my $result =
                   9705: 	'<head>'.
1.1160    raeburn  9706: 	&font_settings($args);
1.319     albertel 9707: 
1.1188    raeburn  9708:     my $inhibitprint;
                   9709:     if ($args->{'print_suppress'}) {
                   9710:         $inhibitprint = &print_suppression();
                   9711:     }
1.1064    raeburn  9712: 
1.1439    raeburn  9713:     if (!$args->{'frameset'} && !$args->{'switchserver'}) {
1.461     albertel 9714: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   9715:     }
1.962     droeschl 9716:     if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
                   9717:         $result .= Apache::lonxml::display_title();
1.319     albertel 9718:     }
1.436     albertel 9719:     if (!$args->{'no_nav_bar'} 
                   9720: 	&& !$args->{'only_body'}
1.1438    raeburn  9721: 	&& !$args->{'frameset'}
                   9722: 	&& !$args->{'switchserver'}) {
1.1154    raeburn  9723: 	$result .= &help_menu_js($httphost);
1.1032    www      9724:         $result.=&modal_window();
1.1038    www      9725:         $result.=&togglebox_script();
1.1034    www      9726:         $result.=&wishlist_window();
1.1041    www      9727:         $result.=&LCprogressbarUpdate_script();
1.1034    www      9728:     } else {
                   9729:         if ($args->{'add_modal'}) {
                   9730:            $result.=&modal_window();
                   9731:         }
                   9732:         if ($args->{'add_wishlist'}) {
                   9733:            $result.=&wishlist_window();
                   9734:         }
1.1038    www      9735:         if ($args->{'add_togglebox'}) {
                   9736:            $result.=&togglebox_script();
                   9737:         }
1.1041    www      9738:         if ($args->{'add_progressbar'}) {
                   9739:            $result.=&LCprogressbarUpdate_script();
                   9740:         }
1.436     albertel 9741:     }
1.314     albertel 9742:     if (ref($args->{'redirect'})) {
1.1388    raeburn  9743: 	my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
                   9744:         if (!$skip_enc_check) {
                   9745:             $url = &Apache::lonenc::check_encrypt($url);
                   9746:         }
1.414     albertel 9747: 	if (!$inhibit_continue) {
                   9748: 	    $env{'internal.head.redirect'} = $url;
                   9749: 	}
1.1386    raeburn  9750: 	$result.=<<"ADDMETA";
1.313     albertel 9751: <meta http-equiv="pragma" content="no-cache" />
1.1386    raeburn  9752: ADDMETA
                   9753:         if ($to_opener) {
                   9754:             $env{'internal.head.to_opener'} = 1;
                   9755:             my $dest = &js_escape($url);
                   9756:             my $timeout = int($time * 1000);
                   9757:             $result .=<<"ENDJS";
                   9758: <script type="text/javascript">
                   9759: // <![CDATA[
                   9760: function LC_To_Opener() {
                   9761:     var dest = '$dest';
                   9762:     if (dest != '') {
                   9763:         if (window.opener != null && !window.opener.closed) {
                   9764:             window.opener.location.href=dest;
                   9765:             window.close();
                   9766:         } else {
                   9767:             window.location.href=dest;
                   9768:         }
                   9769:     }
                   9770: }
                   9771: \$(document).ready(function () {
                   9772:     setTimeout('LC_To_Opener()',$timeout);
                   9773: });
                   9774: // ]]>
                   9775: </script>
                   9776: ENDJS
                   9777:         } else {
                   9778:             $result.=<<"ADDMETA";
1.344     albertel 9779: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 9780: ADDMETA
1.1386    raeburn  9781:         }
1.1210    raeburn  9782:     } else {
                   9783:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
                   9784:             my $requrl = $env{'request.uri'};
                   9785:             if ($requrl eq '') {
                   9786:                 $requrl = $ENV{'REQUEST_URI'};
                   9787:                 $requrl =~ s/\?.+$//;
                   9788:             }
                   9789:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
                   9790:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
                   9791:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
                   9792:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
                   9793:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
                   9794:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340    raeburn  9795:                     my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352    raeburn  9796:                     my ($offload,$offloadoth);
1.1210    raeburn  9797:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
                   9798:                         if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340    raeburn  9799:                             $offload = 1;
1.1353    raeburn  9800:                             if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   9801:                                 (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   9802:                                 unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   9803:                                     $offloadoth = 1;
                   9804:                                     $dom_in_use = $env{'user.domain'};
                   9805:                                 }
                   9806:                             }
1.1340    raeburn  9807:                         }
                   9808:                     }
                   9809:                     unless ($offload) {
                   9810:                         if (ref($domdefs{'offloadoth'}) eq 'HASH') {
                   9811:                             if ($domdefs{'offloadoth'}{$lonhost}) {
                   9812:                                 if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   9813:                                     (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   9814:                                     unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   9815:                                         $offload = 1;
1.1352    raeburn  9816:                                         $offloadoth = 1;
1.1340    raeburn  9817:                                         $dom_in_use = $env{'user.domain'};
                   9818:                                     }
1.1210    raeburn  9819:                                 }
1.1340    raeburn  9820:                             }
                   9821:                         }
                   9822:                     }
                   9823:                     if ($offload) {
1.1358    raeburn  9824:                         my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352    raeburn  9825:                         if (($newserver eq '') && ($offloadoth)) {
                   9826:                             my @domains = &Apache::lonnet::current_machine_domains();
                   9827:                             if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) { 
                   9828:                                 ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
                   9829:                             }
                   9830:                         }
1.1340    raeburn  9831:                         if (($newserver) && ($newserver ne $lonhost)) {
                   9832:                             my $numsec = 5;
                   9833:                             my $timeout = $numsec * 1000;
                   9834:                             my ($newurl,$locknum,%locks,$msg);
                   9835:                             if ($env{'request.role.adv'}) {
                   9836:                                 ($locknum,%locks) = &Apache::lonnet::get_locks();
                   9837:                             }
                   9838:                             my $disable_submit = 0;
                   9839:                             if ($requrl =~ /$LONCAPA::assess_re/) {
                   9840:                                 $disable_submit = 1;
                   9841:                             }
                   9842:                             if ($locknum) {
                   9843:                                 my @lockinfo = sort(values(%locks));
1.1354    raeburn  9844:                                 $msg = &mt('Once the following tasks are complete:')." \n".
1.1340    raeburn  9845:                                        join(", ",sort(values(%locks)))."\n";
                   9846:                                 if (&show_course()) {
                   9847:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
                   9848:                                 } else {
                   9849:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210    raeburn  9850:                                 }
1.1340    raeburn  9851:                             } else {
                   9852:                                 if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
                   9853:                                     $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
                   9854:                                 }
                   9855:                                 $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
                   9856:                                 $newurl = '/adm/switchserver?otherserver='.$newserver;
                   9857:                                 if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
                   9858:                                     $newurl .= '&role='.$env{'request.role'};
                   9859:                                 }
                   9860:                                 if ($env{'request.symb'}) {
                   9861:                                     my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
                   9862:                                     if ($shownsymb =~ m{^/enc/}) {
                   9863:                                         my $reqdmajor = 2;
                   9864:                                         my $reqdminor = 11;
                   9865:                                         my $reqdsubminor = 3;
                   9866:                                         my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
                   9867:                                         my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
                   9868:                                         my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
                   9869:                                         if (($major eq '' && $minor eq '') ||
                   9870:                                             (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
                   9871:                                             (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
                   9872:                                              ($reqdsubminor > $subminor))))) {
                   9873:                                             undef($shownsymb);
                   9874:                                         }
1.1210    raeburn  9875:                                     }
1.1340    raeburn  9876:                                     if ($shownsymb) {
                   9877:                                         &js_escape(\$shownsymb);
                   9878:                                         $newurl .= '&symb='.$shownsymb;
1.1210    raeburn  9879:                                     }
1.1340    raeburn  9880:                                 } else {
                   9881:                                     my $shownurl = &Apache::lonenc::check_encrypt($requrl);
                   9882:                                     &js_escape(\$shownurl);
                   9883:                                     $newurl .= '&origurl='.$shownurl;
1.1210    raeburn  9884:                                 }
1.1340    raeburn  9885:                             }
                   9886:                             &js_escape(\$msg);
                   9887:                             $result.=<<OFFLOAD
1.1210    raeburn  9888: <meta http-equiv="pragma" content="no-cache" />
                   9889: <script type="text/javascript">
1.1215    raeburn  9890: // <![CDATA[
1.1210    raeburn  9891: function LC_Offload_Now() {
                   9892:     var dest = "$newurl";
                   9893:     if (dest != '') {
                   9894:         window.location.href="$newurl";
                   9895:     }
                   9896: }
1.1214    raeburn  9897: \$(document).ready(function () {
                   9898:     window.alert('$msg');
                   9899:     if ($disable_submit) {
1.1210    raeburn  9900:         \$(".LC_hwk_submit").prop("disabled", true);
                   9901:         \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214    raeburn  9902:     }
                   9903:     setTimeout('LC_Offload_Now()', $timeout);
                   9904: });
1.1215    raeburn  9905: // ]]>
1.1210    raeburn  9906: </script>
                   9907: OFFLOAD
                   9908:                         }
                   9909:                     }
                   9910:                 }
                   9911:             }
                   9912:         }
1.313     albertel 9913:     }
1.306     albertel 9914:     if (!defined($title)) {
                   9915: 	$title = 'The LearningOnline Network with CAPA';
                   9916:     }
1.460     albertel 9917:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1432    raeburn  9918:     if ($title =~ /^LON-CAPA\s+/) {
                   9919:         $result .= '<title> '.$title.'</title>';
                   9920:     } else {
                   9921:         $result .= '<title> LON-CAPA '.$title.'</title>';
                   9922:     }
                   9923:     $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1168    raeburn  9924:     if (!$args->{'frameset'}) {
                   9925:         $result .= ' /';
                   9926:     }
                   9927:     $result .= '>' 
1.1064    raeburn  9928:         .$inhibitprint
1.414     albertel 9929: 	.$head_extra;
1.1242    raeburn  9930:     my $clientmobile;
                   9931:     if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   9932:         (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
                   9933:     } else {
                   9934:         $clientmobile = $env{'browser.mobile'};
                   9935:     }
                   9936:     if ($clientmobile) {
1.1137    raeburn  9937:         $result .= '
1.1435    raeburn  9938: <meta name="viewport" content="width=device-width, initial-scale=1.0">
1.1137    raeburn  9939: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   9940:     }
1.1455    raeburn  9941:     $result .= '<meta name="google" content="notranslate"';
                   9942:     if (!$args->{'frameset'}) {
                   9943:         $result .= ' /';
                   9944:     }
                   9945:     $result .= '>'."\n";
1.962     droeschl 9946:     return $result.'</head>';
1.306     albertel 9947: }
                   9948: 
                   9949: =pod
                   9950: 
1.340     albertel 9951: =item * &font_settings()
                   9952: 
                   9953: Returns neccessary <meta> to set the proper encoding
                   9954: 
1.1160    raeburn  9955: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 9956: 
                   9957: =cut
                   9958: 
                   9959: sub font_settings {
1.1160    raeburn  9960:     my ($args) = @_;
1.340     albertel 9961:     my $headerstring='';
1.1160    raeburn  9962:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   9963:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168    raeburn  9964:         $headerstring.=
                   9965:             '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   9966:         if (!$args->{'frameset'}) {
                   9967: 	    $headerstring.= ' /';
                   9968:         }
                   9969: 	$headerstring .= '>'."\n";
1.340     albertel 9970:     }
                   9971:     return $headerstring;
                   9972: }
                   9973: 
1.341     albertel 9974: =pod
                   9975: 
1.1064    raeburn  9976: =item * &print_suppression()
                   9977: 
                   9978: In course context returns css which causes the body to be blank when media="print",
                   9979: if printout generation is unavailable for the current resource.
                   9980: 
                   9981: This could be because:
                   9982: 
                   9983: (a) printstartdate is in the future
                   9984: 
                   9985: (b) printenddate is in the past
                   9986: 
                   9987: (c) there is an active exam block with "printout"
                   9988: functionality blocked
                   9989: 
                   9990: Users with pav, pfo or evb privileges are exempt.
                   9991: 
                   9992: Inputs: none
                   9993: 
                   9994: =cut
                   9995: 
                   9996: 
                   9997: sub print_suppression {
                   9998:     my $noprint;
                   9999:     if ($env{'request.course.id'}) {
                   10000:         my $scope = $env{'request.course.id'};
                   10001:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   10002:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   10003:             return;
                   10004:         }
                   10005:         if ($env{'request.course.sec'} ne '') {
                   10006:             $scope .= "/$env{'request.course.sec'}";
                   10007:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   10008:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  10009:                 return;
1.1064    raeburn  10010:             }
                   10011:         }
                   10012:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10013:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372    raeburn  10014:         my $clientip = &Apache::lonnet::get_requestor_ip();
                   10015:         my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064    raeburn  10016:         if ($blocked) {
                   10017:             my $checkrole = "cm./$cdom/$cnum";
                   10018:             if ($env{'request.course.sec'} ne '') {
                   10019:                 $checkrole .= "/$env{'request.course.sec'}";
                   10020:             }
                   10021:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   10022:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   10023:                 $noprint = 1;
                   10024:             }
                   10025:         }
                   10026:         unless ($noprint) {
                   10027:             my $symb = &Apache::lonnet::symbread();
                   10028:             if ($symb ne '') {
                   10029:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   10030:                 if (ref($navmap)) {
                   10031:                     my $res = $navmap->getBySymb($symb);
                   10032:                     if (ref($res)) {
                   10033:                         if (!$res->resprintable()) {
                   10034:                             $noprint = 1;
                   10035:                         }
                   10036:                     }
                   10037:                 }
                   10038:             }
                   10039:         }
                   10040:         if ($noprint) {
                   10041:             return <<"ENDSTYLE";
                   10042: <style type="text/css" media="print">
                   10043:     body { display:none }
                   10044: </style>
                   10045: ENDSTYLE
                   10046:         }
                   10047:     }
                   10048:     return;
                   10049: }
                   10050: 
                   10051: =pod
                   10052: 
1.341     albertel 10053: =item * &xml_begin()
                   10054: 
                   10055: Returns the needed doctype and <html>
                   10056: 
                   10057: Inputs: none
                   10058: 
                   10059: =cut
                   10060: 
                   10061: sub xml_begin {
1.1168    raeburn  10062:     my ($is_frameset) = @_;
1.341     albertel 10063:     my $output='';
                   10064: 
                   10065:     if ($env{'browser.mathml'}) {
                   10066: 	$output='<?xml version="1.0"?>'
                   10067:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   10068: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   10069:             
                   10070: #	    .'<!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">] >'
                   10071: 	    .'<!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">'
                   10072:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   10073: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168    raeburn  10074:     } elsif ($is_frameset) {
                   10075:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
1.1459    raeburn  10076:                 '<html lang="en">'."\n";
1.341     albertel 10077:     } else {
1.1168    raeburn  10078: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   10079:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 10080:     }
                   10081:     return $output;
                   10082: }
1.340     albertel 10083: 
                   10084: =pod
                   10085: 
1.306     albertel 10086: =item * &start_page()
                   10087: 
                   10088: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   10089: 
1.648     raeburn  10090: Inputs:
                   10091: 
                   10092: =over 4
                   10093: 
                   10094: $title - optional title for the page
                   10095: 
                   10096: $head_extra - optional extra HTML to incude inside the <head>
                   10097: 
                   10098: $args - additional optional args supported are:
                   10099: 
                   10100: =over 8
                   10101: 
                   10102:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 10103:                                     arg on
1.814     bisitz   10104:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  10105:              add_entries    -> additional attributes to add to the  <body>
                   10106:              domain         -> force to color decorate a page for a 
1.317     albertel 10107:                                     specific domain
1.648     raeburn  10108:              function       -> force usage of a specific rolish color
1.317     albertel 10109:                                     scheme
1.648     raeburn  10110:              redirect       -> see &headtag()
                   10111:              bgcolor        -> override the default page bg color
                   10112:              js_ready       -> return a string ready for being used in 
1.317     albertel 10113:                                     a javascript writeln
1.648     raeburn  10114:              html_encode    -> return a string ready for being used in 
1.320     albertel 10115:                                     a html attribute
1.648     raeburn  10116:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 10117:                                     $forcereg arg
1.648     raeburn  10118:              frameset       -> if true will start with a <frameset>
1.330     albertel 10119:                                     rather than <body>
1.648     raeburn  10120:              skip_phases    -> hash ref of 
1.338     albertel 10121:                                     head -> skip the <html><head> generation
                   10122:                                     body -> skip all <body> generation
1.648     raeburn  10123:              no_auto_mt_title -> prevent &mt()ing the title arg
1.867     kalberla 10124:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  10125:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1437    raeburn  10126:              bread_crumbs_style -> breadcrumbs are contained within <div id="LC_breadcrumbs">,
                   10127:                                    and &standard_css() contains CSS for #LC_breadcrumbs, if you want
                   10128:                                    to override those values, or add to them, specify the value to
                   10129:                                    include in the style attribute to include in the div tag by using
                   10130:                                    bread_crumbs_style (e.g., overflow: visible)
1.1272    raeburn  10131:              bread_crumbs_nomenu -> if true will pass false as the value of $menulink
                   10132:                                     to lonhtmlcommon::breadcrumbs
1.1096    raeburn  10133:              group          -> includes the current group, if page is for a 
1.1274    raeburn  10134:                                specific group
                   10135:              use_absolute   -> for request for external resource or syllabus, this
                   10136:                                will contain https://<hostname> if server uses
                   10137:                                https (as per hosts.tab), but request is for http
                   10138:              hostname       -> hostname, originally from $r->hostname(), (optional).
1.1369    raeburn  10139:              links_disabled -> Links in primary and secondary menus are disabled
                   10140:                                (Can enable them once page has loaded - see lonroles.pm
                   10141:                                for an example).
1.1380    raeburn  10142:              links_target   -> Target for links, e.g., _parent (optional).
1.361     albertel 10143: 
1.648     raeburn  10144: =back
1.460     albertel 10145: 
1.648     raeburn  10146: =back
1.562     albertel 10147: 
1.306     albertel 10148: =cut
                   10149: 
                   10150: sub start_page {
1.309     albertel 10151:     my ($title,$head_extra,$args) = @_;
1.318     albertel 10152:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 10153: 
1.315     albertel 10154:     $env{'internal.start_page'}++;
1.1359    raeburn  10155:     my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964     droeschl 10156: 
1.338     albertel 10157:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168    raeburn  10158:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 10159:     }
1.1316    raeburn  10160: 
                   10161:     if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318    raeburn  10162:         if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
                   10163:             unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
                   10164:                 $args->{'no_primary_menu'} = 1;
                   10165:             }
                   10166:             unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
                   10167:                 $args->{'no_inline_menu'} = 1;
                   10168:             }
                   10169:             if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
                   10170:                 map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
                   10171:             }
                   10172:         } else {
                   10173:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10174:             my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
                   10175:             if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
                   10176:                 unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
                   10177:                     $args->{'no_primary_menu'} = 1;
                   10178:                 }
                   10179:                 unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
                   10180:                     $args->{'no_inline_menu'} = 1;
                   10181:                 }
                   10182:                 if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
                   10183:                     map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
                   10184:                 }
                   10185:             }
                   10186:         }
1.1316    raeburn  10187:         ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
                   10188:                                   $env{'course.'.$env{'request.course.id'}.'.domain'},
                   10189:                                   $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359    raeburn  10190:     } elsif ($env{'request.course.id'}) {
                   10191:         my $expiretime=600;
                   10192:         if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
                   10193:             &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
                   10194:         }
                   10195:         my ($deeplinkmenu,$menuref);
                   10196:         ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
                   10197:         if ($menucoll) {
                   10198:             if (ref($menuref) eq 'HASH') {
                   10199:                 %menu = %{$menuref};
                   10200:             }
                   10201:             if ($menu{'top'} eq 'n') {
                   10202:                 $args->{'no_primary_menu'} = 1;
                   10203:             }
                   10204:             if ($menu{'inline'} eq 'n') {
                   10205:                 unless (&Apache::lonnet::allowed('opa')) {
                   10206:                     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10207:                     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   10208:                     my $crstype = &course_type();
                   10209:                     my $now = time;
                   10210:                     my $ccrole;
                   10211:                     if ($crstype eq 'Community') {
                   10212:                         $ccrole = 'co';
                   10213:                     } else {
                   10214:                         $ccrole = 'cc';
                   10215:                     }
                   10216:                     if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
                   10217:                         my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
                   10218:                         if ((($start) && ($start<0)) ||
                   10219:                             (($end) && ($end<$now))  ||
                   10220:                             (($start) && ($now<$start))) {
                   10221:                             $args->{'no_inline_menu'} = 1;
                   10222:                         }
                   10223:                     } else {
                   10224:                         $args->{'no_inline_menu'} = 1;
                   10225:                     }
                   10226:                 }
                   10227:             }
                   10228:         }
1.1316    raeburn  10229:     }
1.1359    raeburn  10230: 
1.1385    raeburn  10231:     my $showncrumbs;
1.338     albertel 10232:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   10233: 	if ($args->{'frameset'}) {
                   10234: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   10235: 						$args->{'add_entries'});
                   10236: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   10237:         } else {
                   10238:             $result .=
                   10239:                 &bodytag($title, 
                   10240:                          $args->{'function'},       $args->{'add_entries'},
                   10241:                          $args->{'only_body'},      $args->{'domain'},
                   10242:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096    raeburn  10243:                          $args->{'bgcolor'},        $args,
1.1385    raeburn  10244:                          \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
                   10245:                          \%menu,\$showncrumbs);
1.831     bisitz   10246:         }
1.330     albertel 10247:     }
1.338     albertel 10248: 
1.315     albertel 10249:     if ($args->{'js_ready'}) {
1.713     kaisler  10250: 		$result = &js_ready($result);
1.315     albertel 10251:     }
1.320     albertel 10252:     if ($args->{'html_encode'}) {
1.713     kaisler  10253: 		$result = &html_encode($result);
                   10254:     }
                   10255: 
1.813     bisitz   10256:     # Preparation for new and consistent functionlist at top of screen
                   10257:     # if ($args->{'functionlist'}) {
                   10258:     #            $result .= &build_functionlist();
                   10259:     #}
                   10260: 
1.964     droeschl 10261:     # Don't add anything more if only_body wanted or in const space
                   10262:     return $result if    $args->{'only_body'} 
                   10263:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   10264: 
                   10265:     #Breadcrumbs
1.758     kaisler  10266:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385    raeburn  10267:         unless ($showncrumbs) {
1.758     kaisler  10268: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   10269: 		#if any br links exists, add them to the breadcrumbs
                   10270: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   10271: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   10272: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   10273: 			}
                   10274: 		}
1.1096    raeburn  10275:                 # if @advtools array contains items add then to the breadcrumbs
                   10276:                 if (@advtools > 0) {
                   10277:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   10278:                 }
1.1272    raeburn  10279:                 my $menulink;
                   10280:                 # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
                   10281:                 if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312    raeburn  10282:                      ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272    raeburn  10283:                      ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
                   10284:                      ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
                   10285:                      (!$env{'request.role.adv'}))) {
                   10286:                     $menulink = 0;
                   10287:                 } else {
                   10288:                     undef($menulink);
                   10289:                 }
1.1385    raeburn  10290:                 my $linkprotout;
                   10291:                 if ($env{'request.deeplink.login'}) {
                   10292:                     my $linkprotout = &Apache::lonmenu::linkprot_exit();
                   10293:                     if ($linkprotout) {
                   10294:                         &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
                   10295:                     }
                   10296:                 }
1.758     kaisler  10297: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   10298: 		if(exists($args->{'bread_crumbs_component'})){
1.1437    raeburn  10299: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},
                   10300:                                                                        '',$menulink,'',
                   10301:                                                                        $args->{'bread_crumbs_style'});
1.1237    raeburn  10302:                 } else {
1.1437    raeburn  10303: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink,'',
                   10304:                                                                        $args->{'bread_crumbs_style'});
1.758     kaisler  10305: 		}
1.1385    raeburn  10306:         }
1.320     albertel 10307:     }
1.315     albertel 10308:     return $result;
1.306     albertel 10309: }
                   10310: 
                   10311: sub end_page {
1.315     albertel 10312:     my ($args) = @_;
                   10313:     $env{'internal.end_page'}++;
1.330     albertel 10314:     my $result;
1.335     albertel 10315:     if ($args->{'discussion'}) {
                   10316: 	my ($target,$parser);
                   10317: 	if (ref($args->{'discussion'})) {
                   10318: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   10319: 				$args->{'discussion'}{'parser'});
                   10320: 	}
                   10321: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   10322:     }
1.330     albertel 10323:     if ($args->{'frameset'}) {
                   10324: 	$result .= '</frameset>';
                   10325:     } else {
1.635     raeburn  10326: 	$result .= &endbodytag($args);
1.330     albertel 10327:     }
1.1080    raeburn  10328:     unless ($args->{'notbody'}) {
                   10329:         $result .= "\n</html>";
                   10330:     }
1.330     albertel 10331: 
1.315     albertel 10332:     if ($args->{'js_ready'}) {
1.317     albertel 10333: 	$result = &js_ready($result);
1.315     albertel 10334:     }
1.335     albertel 10335: 
1.320     albertel 10336:     if ($args->{'html_encode'}) {
                   10337: 	$result = &html_encode($result);
                   10338:     }
1.335     albertel 10339: 
1.315     albertel 10340:     return $result;
                   10341: }
                   10342: 
1.1359    raeburn  10343: sub menucoll_in_effect {
                   10344:     my ($menucoll,$deeplinkmenu,%menu);
                   10345:     if ($env{'request.course.id'}) {
                   10346:         $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362    raeburn  10347:         if ($env{'request.deeplink.login'}) {
1.1370    raeburn  10348:             my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362    raeburn  10349:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   10350:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10351:             if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
                   10352:                 if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
                   10353:                     my $navmap = Apache::lonnavmaps::navmap->new();
                   10354:                     if (ref($navmap)) {
                   10355:                         $deeplink = $navmap->get_mapparam(undef,
                   10356:                                                           &Apache::lonnet::declutter($env{'request.noversionuri'}),
                   10357:                                                           '0.deeplink');
1.1370    raeburn  10358:                     } else {
                   10359:                         $check_login_symb = 1;
1.1362    raeburn  10360:                     }
                   10361:                 } else {
1.1370    raeburn  10362:                     my $symb = &Apache::lonnet::symbread();
                   10363:                     if ($symb) {
                   10364:                         $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
                   10365:                     } else {
                   10366:                         $check_login_symb = 1;
                   10367:                     }
1.1362    raeburn  10368:                 }
                   10369:             } else {
1.1370    raeburn  10370:                 $check_login_symb = 1;
                   10371:             }
                   10372:             if ($check_login_symb) {
1.1362    raeburn  10373:                 $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
                   10374:                 if ($deeplink_symb =~ /\.(page|sequence)$/) {
                   10375:                     my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
                   10376:                     my $navmap = Apache::lonnavmaps::navmap->new();
                   10377:                     if (ref($navmap)) {
                   10378:                         $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
                   10379:                     }
                   10380:                 } else {
                   10381:                     $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
                   10382:                 }
                   10383:             }
1.1359    raeburn  10384:             if ($deeplink ne '') {
1.1378    raeburn  10385:                 my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359    raeburn  10386:                 if ($display =~ /^\d+$/) {
                   10387:                     $deeplinkmenu = 1;
                   10388:                     $menucoll = $display;
                   10389:                 }
                   10390:             }
                   10391:         }
                   10392:         if ($menucoll) {
                   10393:             %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
                   10394:         }
                   10395:     }
                   10396:     return ($menucoll,$deeplinkmenu,\%menu);
                   10397: }
                   10398: 
1.1362    raeburn  10399: sub deeplink_login_symb {
                   10400:     my ($cnum,$cdom) = @_;
                   10401:     my $login_symb;
                   10402:     if ($env{'request.deeplink.login'}) {
1.1364    raeburn  10403:         $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
                   10404:     }
                   10405:     return $login_symb;
                   10406: }
                   10407: 
                   10408: sub symb_from_tinyurl {
                   10409:     my ($url,$cnum,$cdom) = @_;
                   10410:     if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
                   10411:         my $key = $1;
                   10412:         my ($tinyurl,$login);
                   10413:         my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
                   10414:         if (defined($cached)) {
                   10415:             $tinyurl = $result;
                   10416:         } else {
                   10417:             my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
                   10418:             my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
                   10419:             if ($currtiny{$key} ne '') {
                   10420:                 $tinyurl = $currtiny{$key};
                   10421:                 &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362    raeburn  10422:             }
1.1364    raeburn  10423:         }
                   10424:         if ($tinyurl ne '') {
                   10425:             my ($cnumreq,$symb) = split(/\&/,$tinyurl);
                   10426:             if (wantarray) {
                   10427:                 return ($cnumreq,$symb);
                   10428:             } elsif ($cnumreq eq $cnum) {
                   10429:                 return $symb;
1.1362    raeburn  10430:             }
                   10431:         }
                   10432:     }
1.1364    raeburn  10433:     if (wantarray) {
                   10434:         return ();
                   10435:     } else {
                   10436:         return;
                   10437:     }
1.1362    raeburn  10438: }
                   10439: 
1.1405    raeburn  10440: sub usable_exttools {
                   10441:     my %tooltypes;
                   10442:     if ($env{'request.course.id'}) {
                   10443:         if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
                   10444:            if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
                   10445:                %tooltypes = (
                   10446:                              crs => 1,
                   10447:                              dom => 1,
                   10448:                             );
                   10449:            } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
                   10450:                $tooltypes{'crs'} = 1;
                   10451:            } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
                   10452:                $tooltypes{'dom'} = 1;
                   10453:            }
                   10454:         } else {
                   10455:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10456:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   10457:             my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
                   10458:             if ($crstype eq '') {
                   10459:                 $crstype = 'course';
                   10460:             }
                   10461:             if ($crstype eq 'course') {
                   10462:                 if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
                   10463:                     $crstype = 'official';
                   10464:                 } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
                   10465:                     $crstype = 'textbook';
                   10466:                 } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
                   10467:                     $crstype = 'lti';
                   10468:                 } else {
                   10469:                     $crstype = 'unofficial';
                   10470:                 }
                   10471:             }
                   10472:             my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
                   10473:             if ($domdefaults{$crstype.'domexttool'}) {
                   10474:                 $tooltypes{'dom'} = 1;
                   10475:             }
                   10476:             if ($domdefaults{$crstype.'exttool'}) {
                   10477:                 $tooltypes{'crs'} = 1;
                   10478:             }
                   10479:         }
                   10480:     }
                   10481:     return %tooltypes;
                   10482: }
                   10483: 
1.1034    www      10484: sub wishlist_window {
                   10485:     return(<<'ENDWISHLIST');
1.1046    raeburn  10486: <script type="text/javascript">
1.1034    www      10487: // <![CDATA[
                   10488: // <!-- BEGIN LON-CAPA Internal
                   10489: function set_wishlistlink(title, path) {
                   10490:     if (!title) {
                   10491:         title = document.title;
                   10492:         title = title.replace(/^LON-CAPA /,'');
                   10493:     }
1.1175    raeburn  10494:     title = encodeURIComponent(title);
1.1203    raeburn  10495:     title = title.replace("'","\\\'");
1.1034    www      10496:     if (!path) {
                   10497:         path = location.pathname;
                   10498:     }
1.1175    raeburn  10499:     path = encodeURIComponent(path);
1.1203    raeburn  10500:     path = path.replace("'","\\\'");
1.1034    www      10501:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   10502:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   10503: }
                   10504: // END LON-CAPA Internal -->
                   10505: // ]]>
                   10506: </script>
                   10507: ENDWISHLIST
                   10508: }
                   10509: 
1.1030    www      10510: sub modal_window {
                   10511:     return(<<'ENDMODAL');
1.1046    raeburn  10512: <script type="text/javascript">
1.1030    www      10513: // <![CDATA[
                   10514: // <!-- BEGIN LON-CAPA Internal
                   10515: var modalWindow = {
                   10516: 	parent:"body",
                   10517: 	windowId:null,
                   10518: 	content:null,
                   10519: 	width:null,
                   10520: 	height:null,
                   10521: 	close:function()
                   10522: 	{
                   10523: 	        $(".LCmodal-window").remove();
                   10524: 	        $(".LCmodal-overlay").remove();
                   10525: 	},
                   10526: 	open:function()
                   10527: 	{
                   10528: 		var modal = "";
                   10529: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   10530: 		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;\">";
                   10531: 		modal += this.content;
                   10532: 		modal += "</div>";	
                   10533: 
                   10534: 		$(this.parent).append(modal);
                   10535: 
                   10536: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   10537: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   10538: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   10539: 	}
                   10540: };
1.1140    raeburn  10541: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      10542: 	{
1.1266    raeburn  10543:                 source = source.replace(/'/g,"&#39;");
1.1030    www      10544: 		modalWindow.windowId = "myModal";
                   10545: 		modalWindow.width = width;
                   10546: 		modalWindow.height = height;
1.1196    raeburn  10547: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      10548: 		modalWindow.open();
1.1208    raeburn  10549: 	};
1.1030    www      10550: // END LON-CAPA Internal -->
                   10551: // ]]>
                   10552: </script>
                   10553: ENDMODAL
                   10554: }
                   10555: 
                   10556: sub modal_link {
1.1140    raeburn  10557:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      10558:     unless ($width) { $width=480; }
                   10559:     unless ($height) { $height=400; }
1.1031    www      10560:     unless ($scrolling) { $scrolling='yes'; }
1.1140    raeburn  10561:     unless ($transparency) { $transparency='true'; }
                   10562: 
1.1074    raeburn  10563:     my $target_attr;
                   10564:     if (defined($target)) {
                   10565:         $target_attr = 'target="'.$target.'"';
                   10566:     }
                   10567:     return <<"ENDLINK";
1.1336    raeburn  10568: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074    raeburn  10569: ENDLINK
1.1030    www      10570: }
                   10571: 
1.1032    www      10572: sub modal_adhoc_script {
1.1365    raeburn  10573:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
                   10574:     my $mathjax;
                   10575:     if ($possmathjax) {
                   10576:         $mathjax = <<'ENDJAX';
                   10577:                if (typeof MathJax == 'object') {
                   10578:                    MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
                   10579:                }
                   10580: ENDJAX
                   10581:     }
1.1032    www      10582:     return (<<ENDADHOC);
1.1046    raeburn  10583: <script type="text/javascript">
1.1032    www      10584: // <![CDATA[
                   10585:         var $funcname = function()
                   10586:         {
                   10587:                 modalWindow.windowId = "myModal";
                   10588:                 modalWindow.width = $width;
                   10589:                 modalWindow.height = $height;
                   10590:                 modalWindow.content = '$content';
                   10591:                 modalWindow.open();
1.1365    raeburn  10592:                 $mathjax
1.1032    www      10593:         };  
                   10594: // ]]>
                   10595: </script>
                   10596: ENDADHOC
                   10597: }
                   10598: 
1.1041    www      10599: sub modal_adhoc_inner {
1.1365    raeburn  10600:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041    www      10601:     my $innerwidth=$width-20;
                   10602:     $content=&js_ready(
1.1140    raeburn  10603:                  &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
                   10604:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   10605:                  $content.
1.1041    www      10606:                  &end_scrollbox().
1.1140    raeburn  10607:                  &end_page()
1.1041    www      10608:              );
1.1365    raeburn  10609:     return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041    www      10610: }
                   10611: 
                   10612: sub modal_adhoc_window {
1.1365    raeburn  10613:     my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
                   10614:     return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041    www      10615:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   10616: }
                   10617: 
                   10618: sub modal_adhoc_launch {
                   10619:     my ($funcname,$width,$height,$content)=@_;
                   10620:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   10621: <script type="text/javascript">
                   10622: // <![CDATA[
                   10623: $funcname();
                   10624: // ]]>
                   10625: </script>
                   10626: ENDLAUNCH
                   10627: }
                   10628: 
                   10629: sub modal_adhoc_close {
                   10630:     return (<<ENDCLOSE);
                   10631: <script type="text/javascript">
                   10632: // <![CDATA[
                   10633: modalWindow.close();
                   10634: // ]]>
                   10635: </script>
                   10636: ENDCLOSE
                   10637: }
                   10638: 
1.1038    www      10639: sub togglebox_script {
                   10640:    return(<<ENDTOGGLE);
                   10641: <script type="text/javascript"> 
                   10642: // <![CDATA[
                   10643: function LCtoggleDisplay(id,hidetext,showtext) {
                   10644:    link = document.getElementById(id + "link").childNodes[0];
                   10645:    with (document.getElementById(id).style) {
                   10646:       if (display == "none" ) {
                   10647:           display = "inline";
                   10648:           link.nodeValue = hidetext;
                   10649:         } else {
                   10650:           display = "none";
                   10651:           link.nodeValue = showtext;
                   10652:        }
                   10653:    }
                   10654: }
                   10655: // ]]>
                   10656: </script>
                   10657: ENDTOGGLE
                   10658: }
                   10659: 
1.1039    www      10660: sub start_togglebox {
                   10661:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   10662:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   10663:     unless ($showtext) { $showtext=&mt('show'); }
                   10664:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   10665:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   10666:     return &start_data_table().
                   10667:            &start_data_table_header_row().
                   10668:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   10669:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   10670:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   10671:            &end_data_table_header_row().
                   10672:            '<tr id="'.$id.'" style="display:none""><td>';
                   10673: }
                   10674: 
                   10675: sub end_togglebox {
                   10676:     return '</td></tr>'.&end_data_table();
                   10677: }
                   10678: 
1.1041    www      10679: sub LCprogressbar_script {
1.1302    raeburn  10680:    my ($id,$number_to_do)=@_;
                   10681:    if ($number_to_do) {
                   10682:        return(<<ENDPROGRESS);
1.1041    www      10683: <script type="text/javascript">
                   10684: // <![CDATA[
1.1045    www      10685: \$('#progressbar$id').progressbar({
1.1041    www      10686:   value: 0,
                   10687:   change: function(event, ui) {
                   10688:     var newVal = \$(this).progressbar('option', 'value');
                   10689:     \$('.pblabel', this).text(LCprogressTxt);
                   10690:   }
                   10691: });
                   10692: // ]]>
                   10693: </script>
                   10694: ENDPROGRESS
1.1302    raeburn  10695:    } else {
                   10696:        return(<<ENDPROGRESS);
                   10697: <script type="text/javascript">
                   10698: // <![CDATA[
                   10699: \$('#progressbar$id').progressbar({
                   10700:   value: false,
                   10701:   create: function(event, ui) {
                   10702:     \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
                   10703:     \$('.ui-progressbar-overlay', this).css({'margin':'0'});
                   10704:   }
                   10705: });
                   10706: // ]]>
                   10707: </script>
                   10708: ENDPROGRESS
                   10709:    }
1.1041    www      10710: }
                   10711: 
                   10712: sub LCprogressbarUpdate_script {
                   10713:    return(<<ENDPROGRESSUPDATE);
                   10714: <style type="text/css">
                   10715: .ui-progressbar { position:relative; }
1.1302    raeburn  10716: .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      10717: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   10718: </style>
                   10719: <script type="text/javascript">
                   10720: // <![CDATA[
1.1045    www      10721: var LCprogressTxt='---';
                   10722: 
1.1302    raeburn  10723: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041    www      10724:    LCprogressTxt=progresstext;
1.1302    raeburn  10725:    if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
                   10726:        \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
                   10727:    } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301    raeburn  10728:        \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
                   10729:    } else {
                   10730:        \$('#progressbar'+id).progressbar('value',percent);
                   10731:    }
1.1041    www      10732: }
                   10733: // ]]>
                   10734: </script>
                   10735: ENDPROGRESSUPDATE
                   10736: }
                   10737: 
1.1042    www      10738: my $LClastpercent;
1.1045    www      10739: my $LCidcnt;
                   10740: my $LCcurrentid;
1.1042    www      10741: 
1.1041    www      10742: sub LCprogressbar {
1.1302    raeburn  10743:     my ($r,$number_to_do,$preamble)=@_;
1.1042    www      10744:     $LClastpercent=0;
1.1045    www      10745:     $LCidcnt++;
                   10746:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1302    raeburn  10747:     my ($starting,$content);
                   10748:     if ($number_to_do) {
                   10749:         $starting=&mt('Starting');
                   10750:         $content=(<<ENDPROGBAR);
                   10751: $preamble
1.1045    www      10752:   <div id="progressbar$LCcurrentid">
1.1041    www      10753:     <span class="pblabel">$starting</span>
                   10754:   </div>
                   10755: ENDPROGBAR
1.1302    raeburn  10756:     } else {
                   10757:         $starting=&mt('Loading...');
                   10758:         $LClastpercent='false';
                   10759:         $content=(<<ENDPROGBAR);
                   10760: $preamble
                   10761:   <div id="progressbar$LCcurrentid">
                   10762:       <div class="progress-label">$starting</div>
                   10763:   </div>
                   10764: ENDPROGBAR
                   10765:     }
                   10766:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041    www      10767: }
                   10768: 
                   10769: sub LCprogressbarUpdate {
1.1302    raeburn  10770:     my ($r,$val,$text,$number_to_do)=@_;
                   10771:     if ($number_to_do) {
                   10772:         unless ($val) { 
                   10773:             if ($LClastpercent) {
                   10774:                 $val=$LClastpercent;
                   10775:             } else {
                   10776:                 $val=0;
                   10777:             }
                   10778:         }
                   10779:         if ($val<0) { $val=0; }
                   10780:         if ($val>100) { $val=0; }
                   10781:         $LClastpercent=$val;
                   10782:         unless ($text) { $text=$val.'%'; }
                   10783:     } else {
                   10784:         $val = 'false';
1.1042    www      10785:     }
1.1041    www      10786:     $text=&js_ready($text);
1.1044    www      10787:     &r_print($r,<<ENDUPDATE);
1.1041    www      10788: <script type="text/javascript">
                   10789: // <![CDATA[
1.1302    raeburn  10790: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041    www      10791: // ]]>
                   10792: </script>
                   10793: ENDUPDATE
1.1035    www      10794: }
                   10795: 
1.1042    www      10796: sub LCprogressbarClose {
                   10797:     my ($r)=@_;
                   10798:     $LClastpercent=0;
1.1044    www      10799:     &r_print($r,<<ENDCLOSE);
1.1042    www      10800: <script type="text/javascript">
                   10801: // <![CDATA[
1.1045    www      10802: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      10803: // ]]>
                   10804: </script>
                   10805: ENDCLOSE
1.1044    www      10806: }
                   10807: 
                   10808: sub r_print {
                   10809:     my ($r,$to_print)=@_;
                   10810:     if ($r) {
                   10811:       $r->print($to_print);
                   10812:       $r->rflush();
                   10813:     } else {
                   10814:       print($to_print);
                   10815:     }
1.1042    www      10816: }
                   10817: 
1.320     albertel 10818: sub html_encode {
                   10819:     my ($result) = @_;
                   10820: 
1.322     albertel 10821:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 10822:     
                   10823:     return $result;
                   10824: }
1.1044    www      10825: 
1.317     albertel 10826: sub js_ready {
                   10827:     my ($result) = @_;
                   10828: 
1.323     albertel 10829:     $result =~ s/[\n\r]/ /xmsg;
                   10830:     $result =~ s/\\/\\\\/xmsg;
                   10831:     $result =~ s/'/\\'/xmsg;
1.372     albertel 10832:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 10833:     
                   10834:     return $result;
                   10835: }
                   10836: 
1.315     albertel 10837: sub validate_page {
                   10838:     if (  exists($env{'internal.start_page'})
1.316     albertel 10839: 	  &&     $env{'internal.start_page'} > 1) {
                   10840: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 10841: 				 $env{'internal.start_page'}.' '.
1.316     albertel 10842: 				 $ENV{'request.filename'});
1.315     albertel 10843:     }
                   10844:     if (  exists($env{'internal.end_page'})
1.316     albertel 10845: 	  &&     $env{'internal.end_page'} > 1) {
                   10846: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 10847: 				 $env{'internal.end_page'}.' '.
1.316     albertel 10848: 				 $env{'request.filename'});
1.315     albertel 10849:     }
                   10850:     if (     exists($env{'internal.start_page'})
                   10851: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 10852: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   10853: 				 $env{'request.filename'});
1.315     albertel 10854:     }
                   10855:     if (   ! exists($env{'internal.start_page'})
                   10856: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 10857: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   10858: 				 $env{'request.filename'});
1.315     albertel 10859:     }
1.306     albertel 10860: }
1.315     albertel 10861: 
1.996     www      10862: 
                   10863: sub start_scrollbox {
1.1140    raeburn  10864:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  10865:     unless ($outerwidth) { $outerwidth='520px'; }
                   10866:     unless ($width) { $width='500px'; }
                   10867:     unless ($height) { $height='200px'; }
1.1075    raeburn  10868:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  10869:     if ($id ne '') {
1.1140    raeburn  10870:         $table_id = ' id="table_'.$id.'"';
1.1137    raeburn  10871:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  10872:     }
1.1075    raeburn  10873:     if ($bgcolor ne '') {
                   10874:         $tdcol = "background-color: $bgcolor;";
                   10875:     }
1.1137    raeburn  10876:     my $nicescroll_js;
                   10877:     if ($env{'browser.mobile'}) {
1.1140    raeburn  10878:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   10879:     }
                   10880:     return <<"END";
                   10881: $nicescroll_js
                   10882: 
                   10883: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
                   10884: <div style="overflow:auto; width:$width; height:$height;"$div_id>
                   10885: END
                   10886: }
                   10887: 
                   10888: sub end_scrollbox {
                   10889:     return '</div></td></tr></table>';
                   10890: }
                   10891: 
                   10892: sub nicescroll_javascript {
                   10893:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   10894:     my %options;
                   10895:     if (ref($cursor) eq 'HASH') {
                   10896:         %options = %{$cursor};
                   10897:     }
                   10898:     unless ($options{'railalign'} =~ /^left|right$/) {
                   10899:         $options{'railalign'} = 'left';
                   10900:     }
                   10901:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   10902:         my $function  = &get_users_function();
                   10903:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138    raeburn  10904:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140    raeburn  10905:             $options{'cursorcolor'} = '#00F';
1.1138    raeburn  10906:         }
1.1140    raeburn  10907:     }
                   10908:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   10909:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138    raeburn  10910:             $options{'cursoropacity'}='1.0';
                   10911:         }
1.1140    raeburn  10912:     } else {
                   10913:         $options{'cursoropacity'}='1.0';
                   10914:     }
                   10915:     if ($options{'cursorfixedheight'} eq 'none') {
                   10916:         delete($options{'cursorfixedheight'});
                   10917:     } else {
                   10918:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   10919:     }
                   10920:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   10921:         delete($options{'railoffset'});
                   10922:     }
                   10923:     my @niceoptions;
                   10924:     while (my($key,$value) = each(%options)) {
                   10925:         if ($value =~ /^\{.+\}$/) {
                   10926:             push(@niceoptions,$key.':'.$value);
1.1138    raeburn  10927:         } else {
1.1140    raeburn  10928:             push(@niceoptions,$key.':"'.$value.'"');
1.1138    raeburn  10929:         }
1.1140    raeburn  10930:     }
                   10931:     my $nicescroll_js = '
1.1137    raeburn  10932: $(document).ready(
1.1140    raeburn  10933:       function() {
                   10934:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   10935:       }
1.1137    raeburn  10936: );
                   10937: ';
1.1140    raeburn  10938:     if ($framecheck) {
                   10939:         $nicescroll_js .= '
                   10940: function expand_div(caller) {
                   10941:     if (top === self) {
                   10942:         document.getElementById("'.$id.'").style.width = "auto";
                   10943:         document.getElementById("'.$id.'").style.height = "auto";
                   10944:     } else {
                   10945:         try {
                   10946:             if (parent.frames) {
                   10947:                 if (parent.frames.length > 1) {
                   10948:                     var framesrc = parent.frames[1].location.href;
                   10949:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   10950:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   10951:                         document.getElementById("'.$id.'").style.width = "auto";
                   10952:                         document.getElementById("'.$id.'").style.height = "auto";
                   10953:                     }
                   10954:                 }
                   10955:             }
                   10956:         } catch (e) {
                   10957:             return;
                   10958:         }
1.1137    raeburn  10959:     }
1.1140    raeburn  10960:     return;
1.996     www      10961: }
1.1140    raeburn  10962: ';
                   10963:     }
                   10964:     if ($needjsready) {
                   10965:         $nicescroll_js = '
                   10966: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   10967:     } else {
                   10968:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   10969:     }
                   10970:     return $nicescroll_js;
1.996     www      10971: }
                   10972: 
1.318     albertel 10973: sub simple_error_page {
1.1150    bisitz   10974:     my ($r,$title,$msg,$args) = @_;
1.1304    raeburn  10975:     my %displayargs;
1.1151    raeburn  10976:     if (ref($args) eq 'HASH') {
                   10977:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304    raeburn  10978:         if ($args->{'only_body'}) {
                   10979:             $displayargs{'only_body'} = 1;
                   10980:         }
                   10981:         if ($args->{'no_nav_bar'}) {
                   10982:             $displayargs{'no_nav_bar'} = 1;
                   10983:         }
1.1151    raeburn  10984:     } else {
                   10985:         $msg = &mt($msg);
                   10986:     }
1.1150    bisitz   10987: 
1.318     albertel 10988:     my $page =
1.1459    raeburn  10989: 	&Apache::loncommon::start_page($title,'',\%displayargs)."\n".
1.1460    raeburn  10990:         '<div class="LC_landmark" style="clear:both" role="main">'.
1.1150    bisitz   10991: 	'<p class="LC_error">'.$msg.'</p>'.
1.1459    raeburn  10992:         '</div>'.
1.318     albertel 10993: 	&Apache::loncommon::end_page();
                   10994:     if (ref($r)) {
                   10995: 	$r->print($page);
1.327     albertel 10996: 	return;
1.318     albertel 10997:     }
                   10998:     return $page;
                   10999: }
1.347     albertel 11000: 
                   11001: {
1.610     albertel 11002:     my @row_count;
1.961     onken    11003: 
                   11004:     sub start_data_table_count {
                   11005:         unshift(@row_count, 0);
                   11006:         return;
                   11007:     }
                   11008: 
                   11009:     sub end_data_table_count {
                   11010:         shift(@row_count);
                   11011:         return;
                   11012:     }
                   11013: 
1.1466    raeburn  11014:     sub set_data_table_count {
                   11015:         my ($count) = @_;
                   11016:         unshift(@row_count,$count);
                   11017:     }
                   11018: 
1.347     albertel 11019:     sub start_data_table {
1.1018    raeburn  11020: 	my ($add_class,$id) = @_;
1.422     albertel 11021: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  11022:         my $table_id;
                   11023:         if (defined($id)) {
                   11024:             $table_id = ' id="'.$id.'"';
                   11025:         }
1.961     onken    11026: 	&start_data_table_count();
1.1018    raeburn  11027: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 11028:     }
                   11029: 
                   11030:     sub end_data_table {
1.961     onken    11031: 	&end_data_table_count();
1.389     albertel 11032: 	return '</table>'."\n";;
1.347     albertel 11033:     }
                   11034: 
                   11035:     sub start_data_table_row {
1.974     wenzelju 11036: 	my ($add_class, $id) = @_;
1.610     albertel 11037: 	$row_count[0]++;
                   11038: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   11039: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 11040:         $id = (' id="'.$id.'"') unless ($id eq '');
                   11041:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 11042:     }
1.471     banghart 11043:     
                   11044:     sub continue_data_table_row {
1.974     wenzelju 11045: 	my ($add_class, $id) = @_;
1.610     albertel 11046: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 11047: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   11048:         $id = (' id="'.$id.'"') unless ($id eq '');
                   11049:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 11050:     }
1.347     albertel 11051: 
                   11052:     sub end_data_table_row {
1.389     albertel 11053: 	return '</tr>'."\n";;
1.347     albertel 11054:     }
1.367     www      11055: 
1.421     albertel 11056:     sub start_data_table_empty_row {
1.707     bisitz   11057: #	$row_count[0]++;
1.421     albertel 11058: 	return  '<tr class="LC_empty_row" >'."\n";;
                   11059:     }
                   11060: 
                   11061:     sub end_data_table_empty_row {
                   11062: 	return '</tr>'."\n";;
                   11063:     }
                   11064: 
1.367     www      11065:     sub start_data_table_header_row {
1.1465    raeburn  11066: 	my ($add_class,$id) = @_;
                   11067: 	my $css_class = 'LC_header_row';
                   11068: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   11069: 	$id = (' id="'.$id.'"') unless ($id eq '');
                   11070: 	return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.367     www      11071:     }
                   11072: 
                   11073:     sub end_data_table_header_row {
1.389     albertel 11074: 	return '</tr>'."\n";;
1.367     www      11075:     }
1.890     droeschl 11076: 
                   11077:     sub data_table_caption {
1.1468    raeburn  11078:         my ($caption,$css_class) = @_;
                   11079:         return "<caption class=\"LC_caption $css_class\">$caption</caption>";
1.890     droeschl 11080:     }
1.347     albertel 11081: }
                   11082: 
1.548     albertel 11083: =pod
                   11084: 
                   11085: =item * &inhibit_menu_check($arg)
                   11086: 
                   11087: Checks for a inhibitmenu state and generates output to preserve it
                   11088: 
                   11089: Inputs:         $arg - can be any of
                   11090:                      - undef - in which case the return value is a string 
                   11091:                                to add  into arguments list of a uri
                   11092:                      - 'input' - in which case the return value is a HTML
                   11093:                                  <form> <input> field of type hidden to
                   11094:                                  preserve the value
                   11095:                      - a url - in which case the return value is the url with
                   11096:                                the neccesary cgi args added to preserve the
                   11097:                                inhibitmenu state
                   11098:                      - a ref to a url - no return value, but the string is
                   11099:                                         updated to include the neccessary cgi
                   11100:                                         args to preserve the inhibitmenu state
                   11101: 
                   11102: =cut
                   11103: 
                   11104: sub inhibit_menu_check {
                   11105:     my ($arg) = @_;
                   11106:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   11107:     if ($arg eq 'input') {
                   11108: 	if ($env{'form.inhibitmenu'}) {
                   11109: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   11110: 	} else {
                   11111: 	    return
                   11112: 	}
                   11113:     }
                   11114:     if ($env{'form.inhibitmenu'}) {
                   11115: 	if (ref($arg)) {
                   11116: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   11117: 	} elsif ($arg eq '') {
                   11118: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   11119: 	} else {
                   11120: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   11121: 	}
                   11122:     }
                   11123:     if (!ref($arg)) {
                   11124: 	return $arg;
                   11125:     }
                   11126: }
                   11127: 
1.251     albertel 11128: ###############################################
1.182     matthew  11129: 
                   11130: =pod
                   11131: 
1.549     albertel 11132: =back
                   11133: 
                   11134: =head1 User Information Routines
                   11135: 
                   11136: =over 4
                   11137: 
1.405     albertel 11138: =item * &get_users_function()
1.182     matthew  11139: 
                   11140: Used by &bodytag to determine the current users primary role.
                   11141: Returns either 'student','coordinator','admin', or 'author'.
                   11142: 
                   11143: =cut
                   11144: 
                   11145: ###############################################
                   11146: sub get_users_function {
1.815     tempelho 11147:     my $function = 'norole';
1.818     tempelho 11148:     if ($env{'request.role'}=~/^(st)/) {
                   11149:         $function='student';
                   11150:     }
1.907     raeburn  11151:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  11152:         $function='coordinator';
                   11153:     }
1.258     albertel 11154:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  11155:         $function='admin';
                   11156:     }
1.826     bisitz   11157:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  11158:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  11159:         $function='author';
                   11160:     }
                   11161:     return $function;
1.54      www      11162: }
1.99      www      11163: 
                   11164: ###############################################
                   11165: 
1.233     raeburn  11166: =pod
                   11167: 
1.821     raeburn  11168: =item * &show_course()
                   11169: 
                   11170: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   11171: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   11172: 
                   11173: Inputs:
                   11174: None
                   11175: 
                   11176: Outputs:
                   11177: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   11178: 
                   11179: =cut
                   11180: 
                   11181: ###############################################
                   11182: sub show_course {
1.1408    raeburn  11183:     my ($udom,$uname) = @_;
                   11184:     if (($udom ne '') && ($uname ne '')) {
                   11185:         if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410    raeburn  11186:             if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408    raeburn  11187:                 return 0;
                   11188:             } else {
                   11189:                 return 1;
                   11190:             }
                   11191:         }
                   11192:     }
1.821     raeburn  11193:     my $course = !$env{'user.adv'};
                   11194:     if (!$env{'user.adv'}) {
                   11195:         foreach my $env (keys(%env)) {
                   11196:             next if ($env !~ m/^user\.priv\./);
                   11197:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   11198:                 $course = 0;
                   11199:                 last;
                   11200:             }
                   11201:         }
                   11202:     }
                   11203:     return $course;
                   11204: }
                   11205: 
                   11206: ###############################################
                   11207: 
                   11208: =pod
                   11209: 
1.542     raeburn  11210: =item * &check_user_status()
1.274     raeburn  11211: 
                   11212: Determines current status of supplied role for a
                   11213: specific user. Roles can be active, previous or future.
                   11214: 
                   11215: Inputs: 
                   11216: user's domain, user's username, course's domain,
1.375     raeburn  11217: course's number, optional section ID.
1.274     raeburn  11218: 
                   11219: Outputs:
                   11220: role status: active, previous or future. 
                   11221: 
                   11222: =cut
                   11223: 
                   11224: sub check_user_status {
1.412     raeburn  11225:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  11226:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202    raeburn  11227:     my @uroles = keys(%userinfo);
1.274     raeburn  11228:     my $srchstr;
                   11229:     my $active_chk = 'none';
1.412     raeburn  11230:     my $now = time;
1.274     raeburn  11231:     if (@uroles > 0) {
1.908     raeburn  11232:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  11233:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   11234:         } else {
1.412     raeburn  11235:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   11236:         }
                   11237:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  11238:             my $role_end = 0;
                   11239:             my $role_start = 0;
                   11240:             $active_chk = 'active';
1.412     raeburn  11241:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   11242:                 $role_end = $1;
                   11243:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   11244:                     $role_start = $1;
1.274     raeburn  11245:                 }
                   11246:             }
                   11247:             if ($role_start > 0) {
1.412     raeburn  11248:                 if ($now < $role_start) {
1.274     raeburn  11249:                     $active_chk = 'future';
                   11250:                 }
                   11251:             }
                   11252:             if ($role_end > 0) {
1.412     raeburn  11253:                 if ($now > $role_end) {
1.274     raeburn  11254:                     $active_chk = 'previous';
                   11255:                 }
                   11256:             }
                   11257:         }
                   11258:     }
                   11259:     return $active_chk;
                   11260: }
                   11261: 
                   11262: ###############################################
                   11263: 
                   11264: =pod
                   11265: 
1.405     albertel 11266: =item * &get_sections()
1.233     raeburn  11267: 
                   11268: Determines all the sections for a course including
                   11269: sections with students and sections containing other roles.
1.419     raeburn  11270: Incoming parameters: 
                   11271: 
                   11272: 1. domain
                   11273: 2. course number 
                   11274: 3. reference to array containing roles for which sections should 
                   11275: be gathered (optional).
                   11276: 4. reference to array containing status types for which sections 
                   11277: should be gathered (optional).
                   11278: 
                   11279: If the third argument is undefined, sections are gathered for any role. 
                   11280: If the fourth argument is undefined, sections are gathered for any status.
                   11281: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  11282:  
1.374     raeburn  11283: Returns section hash (keys are section IDs, values are
                   11284: number of users in each section), subject to the
1.419     raeburn  11285: optional roles filter, optional status filter 
1.233     raeburn  11286: 
                   11287: =cut
                   11288: 
                   11289: ###############################################
                   11290: sub get_sections {
1.419     raeburn  11291:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 11292:     if (!defined($cdom) || !defined($cnum)) {
                   11293:         my $cid =  $env{'request.course.id'};
                   11294: 
                   11295: 	return if (!defined($cid));
                   11296: 
                   11297:         $cdom = $env{'course.'.$cid.'.domain'};
                   11298:         $cnum = $env{'course.'.$cid.'.num'};
                   11299:     }
                   11300: 
                   11301:     my %sectioncount;
1.419     raeburn  11302:     my $now = time;
1.240     albertel 11303: 
1.1118    raeburn  11304:     my $check_students = 1;
                   11305:     my $only_students = 0;
                   11306:     if (ref($possible_roles) eq 'ARRAY') {
                   11307:         if (grep(/^st$/,@{$possible_roles})) {
                   11308:             if (@{$possible_roles} == 1) {
                   11309:                 $only_students = 1;
                   11310:             }
                   11311:         } else {
                   11312:             $check_students = 0;
                   11313:         }
                   11314:     }
                   11315: 
                   11316:     if ($check_students) { 
1.276     albertel 11317: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 11318: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   11319: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  11320:         my $start_index = &Apache::loncoursedata::CL_START();
                   11321:         my $end_index = &Apache::loncoursedata::CL_END();
                   11322:         my $status;
1.366     albertel 11323: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  11324: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   11325: 				                     $data->[$status_index],
                   11326:                                                      $data->[$start_index],
                   11327:                                                      $data->[$end_index]);
                   11328:             if ($stu_status eq 'Active') {
                   11329:                 $status = 'active';
                   11330:             } elsif ($end < $now) {
                   11331:                 $status = 'previous';
                   11332:             } elsif ($start > $now) {
                   11333:                 $status = 'future';
                   11334:             } 
                   11335: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   11336:                 if ((!defined($possible_status)) || (($status ne '') && 
                   11337:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   11338: 		    $sectioncount{$section}++;
                   11339:                 }
1.240     albertel 11340: 	    }
                   11341: 	}
                   11342:     }
1.1118    raeburn  11343:     if ($only_students) {
                   11344:         return %sectioncount;
                   11345:     }
1.240     albertel 11346:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   11347:     foreach my $user (sort(keys(%courseroles))) {
                   11348: 	if ($user !~ /^(\w{2})/) { next; }
                   11349: 	my ($role) = ($user =~ /^(\w{2})/);
                   11350: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  11351: 	my ($section,$status);
1.240     albertel 11352: 	if ($role eq 'cr' &&
                   11353: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   11354: 	    $section=$1;
                   11355: 	}
                   11356: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   11357: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  11358:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   11359:         if ($end == -1 && $start == -1) {
                   11360:             next; #deleted role
                   11361:         }
                   11362:         if (!defined($possible_status)) { 
                   11363:             $sectioncount{$section}++;
                   11364:         } else {
                   11365:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   11366:                 $status = 'active';
                   11367:             } elsif ($end < $now) {
                   11368:                 $status = 'future';
                   11369:             } elsif ($start > $now) {
                   11370:                 $status = 'previous';
                   11371:             }
                   11372:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   11373:                 $sectioncount{$section}++;
                   11374:             }
                   11375:         }
1.233     raeburn  11376:     }
1.366     albertel 11377:     return %sectioncount;
1.233     raeburn  11378: }
                   11379: 
1.274     raeburn  11380: ###############################################
1.294     raeburn  11381: 
                   11382: =pod
1.405     albertel 11383: 
                   11384: =item * &get_course_users()
                   11385: 
1.275     raeburn  11386: Retrieves usernames:domains for users in the specified course
                   11387: with specific role(s), and access status. 
                   11388: 
                   11389: Incoming parameters:
1.277     albertel 11390: 1. course domain
                   11391: 2. course number
                   11392: 3. access status: users must have - either active, 
1.275     raeburn  11393: previous, future, or all.
1.277     albertel 11394: 4. reference to array of permissible roles
1.288     raeburn  11395: 5. reference to array of section restrictions (optional)
                   11396: 6. reference to results object (hash of hashes).
                   11397: 7. reference to optional userdata hash
1.609     raeburn  11398: 8. reference to optional statushash
1.630     raeburn  11399: 9. flag if privileged users (except those set to unhide in
                   11400:    course settings) should be excluded    
1.609     raeburn  11401: Keys of top level results hash are roles.
1.275     raeburn  11402: Keys of inner hashes are username:domain, with 
                   11403: values set to access type.
1.288     raeburn  11404: Optional userdata hash returns an array with arguments in the 
                   11405: same order as loncoursedata::get_classlist() for student data.
                   11406: 
1.609     raeburn  11407: Optional statushash returns
                   11408: 
1.288     raeburn  11409: Entries for end, start, section and status are blank because
                   11410: of the possibility of multiple values for non-student roles.
                   11411: 
1.275     raeburn  11412: =cut
1.405     albertel 11413: 
1.275     raeburn  11414: ###############################################
1.405     albertel 11415: 
1.275     raeburn  11416: sub get_course_users {
1.630     raeburn  11417:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  11418:     my %idx = ();
1.419     raeburn  11419:     my %seclists;
1.288     raeburn  11420: 
                   11421:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   11422:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   11423:     $idx{end} = &Apache::loncoursedata::CL_END();
                   11424:     $idx{start} = &Apache::loncoursedata::CL_START();
                   11425:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   11426:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   11427:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   11428:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   11429: 
1.290     albertel 11430:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 11431:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  11432:         my $now = time;
1.277     albertel 11433:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  11434:             my $match = 0;
1.412     raeburn  11435:             my $secmatch = 0;
1.419     raeburn  11436:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  11437:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  11438:             if ($section eq '') {
                   11439:                 $section = 'none';
                   11440:             }
1.291     albertel 11441:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 11442:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  11443:                     $secmatch = 1;
                   11444:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 11445:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  11446:                         $secmatch = 1;
                   11447:                     }
                   11448:                 } else {  
1.419     raeburn  11449: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  11450: 		        $secmatch = 1;
                   11451:                     }
1.290     albertel 11452: 		}
1.412     raeburn  11453:                 if (!$secmatch) {
                   11454:                     next;
                   11455:                 }
1.419     raeburn  11456:             }
1.275     raeburn  11457:             if (defined($$types{'active'})) {
1.288     raeburn  11458:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  11459:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  11460:                     $match = 1;
1.275     raeburn  11461:                 }
                   11462:             }
                   11463:             if (defined($$types{'previous'})) {
1.609     raeburn  11464:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  11465:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  11466:                     $match = 1;
1.275     raeburn  11467:                 }
                   11468:             }
                   11469:             if (defined($$types{'future'})) {
1.609     raeburn  11470:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  11471:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  11472:                     $match = 1;
1.275     raeburn  11473:                 }
                   11474:             }
1.609     raeburn  11475:             if ($match) {
                   11476:                 push(@{$seclists{$student}},$section);
                   11477:                 if (ref($userdata) eq 'HASH') {
                   11478:                     $$userdata{$student} = $$classlist{$student};
                   11479:                 }
                   11480:                 if (ref($statushash) eq 'HASH') {
                   11481:                     $statushash->{$student}{'st'}{$section} = $status;
                   11482:                 }
1.288     raeburn  11483:             }
1.275     raeburn  11484:         }
                   11485:     }
1.412     raeburn  11486:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  11487:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   11488:         my $now = time;
1.609     raeburn  11489:         my %displaystatus = ( previous => 'Expired',
                   11490:                               active   => 'Active',
                   11491:                               future   => 'Future',
                   11492:                             );
1.1121    raeburn  11493:         my (%nothide,@possdoms);
1.630     raeburn  11494:         if ($hidepriv) {
                   11495:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   11496:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   11497:                 if ($user !~ /:/) {
                   11498:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   11499:                 } else {
                   11500:                     $nothide{$user} = 1;
                   11501:                 }
                   11502:             }
1.1121    raeburn  11503:             my @possdoms = ($cdom);
                   11504:             if ($coursehash{'checkforpriv'}) {
                   11505:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   11506:             }
1.630     raeburn  11507:         }
1.439     raeburn  11508:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  11509:             my $match = 0;
1.412     raeburn  11510:             my $secmatch = 0;
1.439     raeburn  11511:             my $status;
1.412     raeburn  11512:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  11513:             $user =~ s/:$//;
1.439     raeburn  11514:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   11515:             if ($end == -1 || $start == -1) {
                   11516:                 next;
                   11517:             }
                   11518:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   11519:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  11520:                 my ($uname,$udom) = split(/:/,$user);
                   11521:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 11522:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  11523:                         $secmatch = 1;
                   11524:                     } elsif ($usec eq '') {
1.420     albertel 11525:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  11526:                             $secmatch = 1;
                   11527:                         }
                   11528:                     } else {
                   11529:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   11530:                             $secmatch = 1;
                   11531:                         }
                   11532:                     }
                   11533:                     if (!$secmatch) {
                   11534:                         next;
                   11535:                     }
1.288     raeburn  11536:                 }
1.419     raeburn  11537:                 if ($usec eq '') {
                   11538:                     $usec = 'none';
                   11539:                 }
1.275     raeburn  11540:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  11541:                     if ($hidepriv) {
1.1121    raeburn  11542:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  11543:                             (!$nothide{$uname.':'.$udom})) {
                   11544:                             next;
                   11545:                         }
                   11546:                     }
1.503     raeburn  11547:                     if ($end > 0 && $end < $now) {
1.439     raeburn  11548:                         $status = 'previous';
                   11549:                     } elsif ($start > $now) {
                   11550:                         $status = 'future';
                   11551:                     } else {
                   11552:                         $status = 'active';
                   11553:                     }
1.277     albertel 11554:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  11555:                         if ($status eq $type) {
1.420     albertel 11556:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  11557:                                 push(@{$$users{$role}{$user}},$type);
                   11558:                             }
1.288     raeburn  11559:                             $match = 1;
                   11560:                         }
                   11561:                     }
1.419     raeburn  11562:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   11563:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   11564: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   11565:                         }
1.420     albertel 11566:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  11567:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   11568:                         }
1.609     raeburn  11569:                         if (ref($statushash) eq 'HASH') {
                   11570:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   11571:                         }
1.275     raeburn  11572:                     }
                   11573:                 }
                   11574:             }
                   11575:         }
1.290     albertel 11576:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  11577:             if ((defined($cdom)) && (defined($cnum))) {
                   11578:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   11579:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   11580:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  11581:                     next if ($owner eq '');
                   11582:                     my ($ownername,$ownerdom);
                   11583:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   11584:                         $ownername = $1;
                   11585:                         $ownerdom = $2;
                   11586:                     } else {
                   11587:                         $ownername = $owner;
                   11588:                         $ownerdom = $cdom;
                   11589:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  11590:                     }
                   11591:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 11592:                     if (defined($userdata) && 
1.609     raeburn  11593: 			!exists($$userdata{$owner})) {
                   11594: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   11595:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   11596:                             push(@{$seclists{$owner}},'none');
                   11597:                         }
                   11598:                         if (ref($statushash) eq 'HASH') {
                   11599:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  11600:                         }
1.290     albertel 11601: 		    }
1.279     raeburn  11602:                 }
                   11603:             }
                   11604:         }
1.419     raeburn  11605:         foreach my $user (keys(%seclists)) {
                   11606:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   11607:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   11608:         }
1.275     raeburn  11609:     }
                   11610:     return;
                   11611: }
                   11612: 
1.288     raeburn  11613: sub get_user_info {
                   11614:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 11615:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   11616: 	&plainname($uname,$udom,'lastname');
1.291     albertel 11617:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  11618:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  11619:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   11620:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  11621:     return;
                   11622: }
1.275     raeburn  11623: 
1.472     raeburn  11624: ###############################################
                   11625: 
                   11626: =pod
                   11627: 
                   11628: =item * &get_user_quota()
                   11629: 
1.1134    raeburn  11630: Retrieves quota assigned for storage of user files.
                   11631: Default is to report quota for portfolio files.
1.472     raeburn  11632: 
                   11633: Incoming parameters:
                   11634: 1. user's username
                   11635: 2. user's domain
1.1134    raeburn  11636: 3. quota name - portfolio, author, or course
1.1136    raeburn  11637:    (if no quota name provided, defaults to portfolio).
1.1237    raeburn  11638: 4. crstype - official, unofficial, textbook, placement or community, 
                   11639:    if quota name is course
1.472     raeburn  11640: 
                   11641: Returns:
1.1163    raeburn  11642: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  11643: 2. (Optional) Type of setting: custom or default
                   11644:    (individually assigned or default for user's 
                   11645:    institutional status).
                   11646: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   11647:    or student - types as defined in localenroll::inst_usertypes 
                   11648:    for user's domain, which determines default quota for user.
                   11649: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  11650: 
                   11651: If a value has been stored in the user's environment, 
1.536     raeburn  11652: it will return that, otherwise it returns the maximal default
1.1134    raeburn  11653: defined for the user's institutional status(es) in the domain.
1.472     raeburn  11654: 
                   11655: =cut
                   11656: 
                   11657: ###############################################
                   11658: 
                   11659: 
                   11660: sub get_user_quota {
1.1136    raeburn  11661:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  11662:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  11663:     if (!defined($udom)) {
                   11664:         $udom = $env{'user.domain'};
                   11665:     }
                   11666:     if (!defined($uname)) {
                   11667:         $uname = $env{'user.name'};
                   11668:     }
                   11669:     if (($udom eq '' || $uname eq '') ||
                   11670:         ($udom eq 'public') && ($uname eq 'public')) {
                   11671:         $quota = 0;
1.536     raeburn  11672:         $quotatype = 'default';
                   11673:         $defquota = 0; 
1.472     raeburn  11674:     } else {
1.536     raeburn  11675:         my $inststatus;
1.1134    raeburn  11676:         if ($quotaname eq 'course') {
                   11677:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   11678:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   11679:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   11680:             } else {
                   11681:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   11682:                 $quota = $cenv{'internal.uploadquota'};
                   11683:             }
1.536     raeburn  11684:         } else {
1.1134    raeburn  11685:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   11686:                 if ($quotaname eq 'author') {
                   11687:                     $quota = $env{'environment.authorquota'};
                   11688:                 } else {
                   11689:                     $quota = $env{'environment.portfolioquota'};
                   11690:                 }
                   11691:                 $inststatus = $env{'environment.inststatus'};
                   11692:             } else {
                   11693:                 my %userenv = 
                   11694:                     &Apache::lonnet::get('environment',['portfolioquota',
                   11695:                                          'authorquota','inststatus'],$udom,$uname);
                   11696:                 my ($tmp) = keys(%userenv);
                   11697:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   11698:                     if ($quotaname eq 'author') {
                   11699:                         $quota = $userenv{'authorquota'};
                   11700:                     } else {
                   11701:                         $quota = $userenv{'portfolioquota'};
                   11702:                     }
                   11703:                     $inststatus = $userenv{'inststatus'};
                   11704:                 } else {
                   11705:                     undef(%userenv);
                   11706:                 }
                   11707:             }
                   11708:         }
                   11709:         if ($quota eq '' || wantarray) {
                   11710:             if ($quotaname eq 'course') {
                   11711:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165    raeburn  11712:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') || 
1.1237    raeburn  11713:                     ($crstype eq 'community') || ($crstype eq 'textbook') ||
                   11714:                     ($crstype eq 'placement')) { 
1.1136    raeburn  11715:                     $defquota = $domdefs{$crstype.'quota'};
                   11716:                 }
                   11717:                 if ($defquota eq '') {
                   11718:                     $defquota = 500;
                   11719:                 }
1.1134    raeburn  11720:             } else {
                   11721:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   11722:             }
                   11723:             if ($quota eq '') {
                   11724:                 $quota = $defquota;
                   11725:                 $quotatype = 'default';
                   11726:             } else {
                   11727:                 $quotatype = 'custom';
                   11728:             }
1.472     raeburn  11729:         }
                   11730:     }
1.536     raeburn  11731:     if (wantarray) {
                   11732:         return ($quota,$quotatype,$settingstatus,$defquota);
                   11733:     } else {
                   11734:         return $quota;
                   11735:     }
1.472     raeburn  11736: }
                   11737: 
                   11738: ###############################################
                   11739: 
                   11740: =pod
                   11741: 
                   11742: =item * &default_quota()
                   11743: 
1.536     raeburn  11744: Retrieves default quota assigned for storage of user portfolio files,
                   11745: given an (optional) user's institutional status.
1.472     raeburn  11746: 
                   11747: Incoming parameters:
1.1142    raeburn  11748: 
1.472     raeburn  11749: 1. domain
1.536     raeburn  11750: 2. (Optional) institutional status(es).  This is a : separated list of 
                   11751:    status types (e.g., faculty, staff, student etc.)
                   11752:    which apply to the user for whom the default is being retrieved.
                   11753:    If the institutional status string in undefined, the domain
1.1134    raeburn  11754:    default quota will be returned.
                   11755: 3.  quota name - portfolio, author, or course
                   11756:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  11757: 
                   11758: Returns:
1.1142    raeburn  11759: 
1.1163    raeburn  11760: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  11761: 2. (Optional) institutional type which determined the value of the
                   11762:    default quota.
1.472     raeburn  11763: 
                   11764: If a value has been stored in the domain's configuration db,
                   11765: it will return that, otherwise it returns 20 (for backwards 
                   11766: compatibility with domains which have not set up a configuration
1.1163    raeburn  11767: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  11768: 
1.536     raeburn  11769: If the user's status includes multiple types (e.g., staff and student),
                   11770: the largest default quota which applies to the user determines the
                   11771: default quota returned.
                   11772: 
1.472     raeburn  11773: =cut
                   11774: 
                   11775: ###############################################
                   11776: 
                   11777: 
                   11778: sub default_quota {
1.1134    raeburn  11779:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  11780:     my ($defquota,$settingstatus);
                   11781:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  11782:                                             ['quotas'],$udom);
1.1134    raeburn  11783:     my $key = 'defaultquota';
                   11784:     if ($quotaname eq 'author') {
                   11785:         $key = 'authorquota';
                   11786:     }
1.622     raeburn  11787:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  11788:         if ($inststatus ne '') {
1.765     raeburn  11789:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  11790:             foreach my $item (@statuses) {
1.1134    raeburn  11791:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   11792:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  11793:                         if ($defquota eq '') {
1.1134    raeburn  11794:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  11795:                             $settingstatus = $item;
1.1134    raeburn  11796:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   11797:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  11798:                             $settingstatus = $item;
                   11799:                         }
                   11800:                     }
1.1134    raeburn  11801:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  11802:                     if ($quotahash{'quotas'}{$item} ne '') {
                   11803:                         if ($defquota eq '') {
                   11804:                             $defquota = $quotahash{'quotas'}{$item};
                   11805:                             $settingstatus = $item;
                   11806:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   11807:                             $defquota = $quotahash{'quotas'}{$item};
                   11808:                             $settingstatus = $item;
                   11809:                         }
1.536     raeburn  11810:                     }
                   11811:                 }
                   11812:             }
                   11813:         }
                   11814:         if ($defquota eq '') {
1.1134    raeburn  11815:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   11816:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   11817:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  11818:                 $defquota = $quotahash{'quotas'}{'default'};
                   11819:             }
1.536     raeburn  11820:             $settingstatus = 'default';
1.1139    raeburn  11821:             if ($defquota eq '') {
                   11822:                 if ($quotaname eq 'author') {
                   11823:                     $defquota = 500;
                   11824:                 }
                   11825:             }
1.536     raeburn  11826:         }
                   11827:     } else {
                   11828:         $settingstatus = 'default';
1.1134    raeburn  11829:         if ($quotaname eq 'author') {
                   11830:             $defquota = 500;
                   11831:         } else {
                   11832:             $defquota = 20;
                   11833:         }
1.536     raeburn  11834:     }
                   11835:     if (wantarray) {
                   11836:         return ($defquota,$settingstatus);
1.472     raeburn  11837:     } else {
1.536     raeburn  11838:         return $defquota;
1.472     raeburn  11839:     }
                   11840: }
                   11841: 
1.1135    raeburn  11842: ###############################################
                   11843: 
                   11844: =pod
                   11845: 
1.1136    raeburn  11846: =item * &excess_filesize_warning()
1.1135    raeburn  11847: 
                   11848: Returns warning message if upload of file to authoring space, or copying
1.1136    raeburn  11849: of existing file within authoring space will cause quota for the authoring
1.1146    raeburn  11850: space to be exceeded.
1.1136    raeburn  11851: 
                   11852: Same, if upload of a file directly to a course/community via Course Editor
1.1137    raeburn  11853: will cause quota for uploaded content for the course to be exceeded.
1.1135    raeburn  11854: 
1.1165    raeburn  11855: Inputs: 7 
1.1136    raeburn  11856: 1. username or coursenum
1.1135    raeburn  11857: 2. domain
1.1136    raeburn  11858: 3. context ('author' or 'course')
1.1135    raeburn  11859: 4. filename of file for which action is being requested
                   11860: 5. filesize (kB) of file
                   11861: 6. action being taken: copy or upload.
1.1237    raeburn  11862: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135    raeburn  11863: 
                   11864: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142    raeburn  11865:          otherwise return null.
                   11866: 
                   11867: =back
1.1135    raeburn  11868: 
                   11869: =cut
                   11870: 
1.1136    raeburn  11871: sub excess_filesize_warning {
1.1165    raeburn  11872:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136    raeburn  11873:     my $current_disk_usage = 0;
1.1165    raeburn  11874:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136    raeburn  11875:     if ($context eq 'author') {
                   11876:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   11877:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   11878:     } else {
                   11879:         foreach my $subdir ('docs','supplemental') {
                   11880:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   11881:         }
                   11882:     }
1.1135    raeburn  11883:     $disk_quota = int($disk_quota * 1000);
                   11884:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179    bisitz   11885:         return '<p class="LC_warning">'.
1.1135    raeburn  11886:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179    bisitz   11887:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   11888:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135    raeburn  11889:                             $disk_quota,$current_disk_usage).
                   11890:                '</p>';
                   11891:     }
                   11892:     return;
                   11893: }
                   11894: 
                   11895: ###############################################
                   11896: 
                   11897: 
1.1136    raeburn  11898: 
                   11899: 
1.384     raeburn  11900: sub get_secgrprole_info {
                   11901:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   11902:     my %sections_count = &get_sections($cdom,$cnum);
                   11903:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   11904:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   11905:     my @groups = sort(keys(%curr_groups));
                   11906:     my $allroles = [];
                   11907:     my $rolehash;
                   11908:     my $accesshash = {
                   11909:                      active => 'Currently has access',
                   11910:                      future => 'Will have future access',
                   11911:                      previous => 'Previously had access',
                   11912:                   };
                   11913:     if ($needroles) {
                   11914:         $rolehash = {'all' => 'all'};
1.385     albertel 11915:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   11916: 	if (&Apache::lonnet::error(%user_roles)) {
                   11917: 	    undef(%user_roles);
                   11918: 	}
                   11919:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  11920:             my ($role)=split(/\:/,$item,2);
                   11921:             if ($role eq 'cr') { next; }
                   11922:             if ($role =~ /^cr/) {
                   11923:                 $$rolehash{$role} = (split('/',$role))[3];
                   11924:             } else {
                   11925:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   11926:             }
                   11927:         }
                   11928:         foreach my $key (sort(keys(%{$rolehash}))) {
                   11929:             push(@{$allroles},$key);
                   11930:         }
                   11931:         push (@{$allroles},'st');
                   11932:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   11933:     }
                   11934:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   11935: }
                   11936: 
1.555     raeburn  11937: sub user_picker {
1.1279    raeburn  11938:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  11939:     my $currdom = $dom;
1.1253    raeburn  11940:     my @alldoms = &Apache::lonnet::all_domains();
                   11941:     if (@alldoms == 1) {
                   11942:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   11943:                                                ['directorysrch'],$alldoms[0]);
                   11944:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   11945:         my $showdom = $domdesc;
                   11946:         if ($showdom eq '') {
                   11947:             $showdom = $dom;
                   11948:         }
                   11949:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   11950:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   11951:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   11952:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   11953:             }
                   11954:         }
                   11955:     }
1.555     raeburn  11956:     my %curr_selected = (
                   11957:                         srchin => 'dom',
1.580     raeburn  11958:                         srchby => 'lastname',
1.555     raeburn  11959:                       );
                   11960:     my $srchterm;
1.625     raeburn  11961:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  11962:         if ($srch->{'srchby'} ne '') {
                   11963:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   11964:         }
                   11965:         if ($srch->{'srchin'} ne '') {
                   11966:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   11967:         }
                   11968:         if ($srch->{'srchtype'} ne '') {
                   11969:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   11970:         }
                   11971:         if ($srch->{'srchdomain'} ne '') {
                   11972:             $currdom = $srch->{'srchdomain'};
                   11973:         }
                   11974:         $srchterm = $srch->{'srchterm'};
                   11975:     }
1.1222    damieng  11976:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  11977:                     'usr'       => 'Search criteria',
1.563     raeburn  11978:                     'doma'      => 'Domain/institution to search',
1.558     albertel 11979:                     'uname'     => 'username',
                   11980:                     'lastname'  => 'last name',
1.555     raeburn  11981:                     'lastfirst' => 'last name, first name',
1.558     albertel 11982:                     'crs'       => 'in this course',
1.576     raeburn  11983:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 11984:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  11985:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 11986:                     'exact'     => 'is',
                   11987:                     'contains'  => 'contains',
1.569     raeburn  11988:                     'begins'    => 'begins with',
1.1222    damieng  11989:                                        );
                   11990:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  11991:                     'youm'      => "You must include some text to search for.",
                   11992:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   11993:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   11994:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   11995:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   11996:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   11997:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   11998:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  11999:                                        );
1.1222    damieng  12000:     &html_escape(\%html_lt);
                   12001:     &js_escape(\%js_lt);
1.1255    raeburn  12002:     my $domform;
1.1277    raeburn  12003:     my $allow_blank = 1;
1.1255    raeburn  12004:     if ($fixeddom) {
1.1277    raeburn  12005:         $allow_blank = 0;
                   12006:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255    raeburn  12007:     } else {
1.1287    raeburn  12008:         my $defdom = $env{'request.role.domain'};
1.1288    raeburn  12009:         my ($trusted,$untrusted);
1.1287    raeburn  12010:         if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288    raeburn  12011:             ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287    raeburn  12012:         } elsif ($context eq 'author') {
1.1288    raeburn  12013:             ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287    raeburn  12014:         } elsif ($context eq 'domain') {
1.1288    raeburn  12015:             ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287    raeburn  12016:         }
1.1288    raeburn  12017:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255    raeburn  12018:     }
1.563     raeburn  12019:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  12020: 
                   12021:     my @srchins = ('crs','dom','alc','instd');
                   12022: 
                   12023:     foreach my $option (@srchins) {
                   12024:         # FIXME 'alc' option unavailable until 
                   12025:         #       loncreateuser::print_user_query_page()
                   12026:         #       has been completed.
                   12027:         next if ($option eq 'alc');
1.880     raeburn  12028:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  12029:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279    raeburn  12030:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  12031:         if ($curr_selected{'srchin'} eq $option) {
                   12032:             $srchinsel .= ' 
1.1222    damieng  12033:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  12034:         } else {
                   12035:             $srchinsel .= '
1.1222    damieng  12036:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  12037:         }
1.555     raeburn  12038:     }
1.563     raeburn  12039:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  12040: 
                   12041:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  12042:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  12043:         if ($curr_selected{'srchby'} eq $option) {
                   12044:             $srchbysel .= '
1.1222    damieng  12045:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  12046:         } else {
                   12047:             $srchbysel .= '
1.1222    damieng  12048:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  12049:          }
                   12050:     }
                   12051:     $srchbysel .= "\n  </select>\n";
                   12052: 
                   12053:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  12054:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  12055:         if ($curr_selected{'srchtype'} eq $option) {
                   12056:             $srchtypesel .= '
1.1222    damieng  12057:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  12058:         } else {
                   12059:             $srchtypesel .= '
1.1222    damieng  12060:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  12061:         }
                   12062:     }
                   12063:     $srchtypesel .= "\n  </select>\n";
                   12064: 
1.558     albertel 12065:     my ($newuserscript,$new_user_create);
1.994     raeburn  12066:     my $context_dom = $env{'request.role.domain'};
                   12067:     if ($context eq 'requestcrs') {
                   12068:         if ($env{'form.coursedom'} ne '') { 
                   12069:             $context_dom = $env{'form.coursedom'};
                   12070:         }
                   12071:     }
1.556     raeburn  12072:     if ($forcenewuser) {
1.576     raeburn  12073:         if (ref($srch) eq 'HASH') {
1.994     raeburn  12074:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  12075:                 if ($cancreate) {
                   12076:                     $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>';
                   12077:                 } else {
1.799     bisitz   12078:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  12079:                     my %usertypetext = (
                   12080:                         official   => 'institutional',
                   12081:                         unofficial => 'non-institutional',
                   12082:                     );
1.799     bisitz   12083:                     $new_user_create = '<p class="LC_warning">'
                   12084:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   12085:                                       .' '
                   12086:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   12087:                                           ,'<a href="'.$helplink.'">','</a>')
                   12088:                                       .'</p><br />';
1.627     raeburn  12089:                 }
1.576     raeburn  12090:             }
                   12091:         }
                   12092: 
1.556     raeburn  12093:         $newuserscript = <<"ENDSCRIPT";
                   12094: 
1.570     raeburn  12095: function setSearch(createnew,callingForm) {
1.556     raeburn  12096:     if (createnew == 1) {
1.570     raeburn  12097:         for (var i=0; i<callingForm.srchby.length; i++) {
                   12098:             if (callingForm.srchby.options[i].value == 'uname') {
                   12099:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  12100:             }
                   12101:         }
1.570     raeburn  12102:         for (var i=0; i<callingForm.srchin.length; i++) {
                   12103:             if ( callingForm.srchin.options[i].value == 'dom') {
                   12104: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  12105:             }
                   12106:         }
1.570     raeburn  12107:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   12108:             if (callingForm.srchtype.options[i].value == 'exact') {
                   12109:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  12110:             }
                   12111:         }
1.570     raeburn  12112:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  12113:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  12114:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  12115:             }
                   12116:         }
                   12117:     }
                   12118: }
                   12119: ENDSCRIPT
1.558     albertel 12120: 
1.556     raeburn  12121:     }
                   12122: 
1.555     raeburn  12123:     my $output = <<"END_BLOCK";
1.556     raeburn  12124: <script type="text/javascript">
1.824     bisitz   12125: // <![CDATA[
1.570     raeburn  12126: function validateEntry(callingForm) {
1.558     albertel 12127: 
1.556     raeburn  12128:     var checkok = 1;
1.558     albertel 12129:     var srchin;
1.570     raeburn  12130:     for (var i=0; i<callingForm.srchin.length; i++) {
                   12131: 	if ( callingForm.srchin[i].checked ) {
                   12132: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 12133: 	}
                   12134:     }
                   12135: 
1.570     raeburn  12136:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   12137:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   12138:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   12139:     var srchterm =  callingForm.srchterm.value;
                   12140:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  12141:     var msg = "";
                   12142: 
                   12143:     if (srchterm == "") {
                   12144:         checkok = 0;
1.1222    damieng  12145:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  12146:     }
                   12147: 
1.569     raeburn  12148:     if (srchtype== 'begins') {
                   12149:         if (srchterm.length < 2) {
                   12150:             checkok = 0;
1.1222    damieng  12151:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  12152:         }
                   12153:     }
                   12154: 
1.556     raeburn  12155:     if (srchtype== 'contains') {
                   12156:         if (srchterm.length < 3) {
                   12157:             checkok = 0;
1.1222    damieng  12158:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  12159:         }
                   12160:     }
                   12161:     if (srchin == 'instd') {
                   12162:         if (srchdomain == '') {
                   12163:             checkok = 0;
1.1222    damieng  12164:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  12165:         }
                   12166:     }
                   12167:     if (srchin == 'dom') {
                   12168:         if (srchdomain == '') {
                   12169:             checkok = 0;
1.1222    damieng  12170:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  12171:         }
                   12172:     }
                   12173:     if (srchby == 'lastfirst') {
                   12174:         if (srchterm.indexOf(",") == -1) {
                   12175:             checkok = 0;
1.1222    damieng  12176:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  12177:         }
                   12178:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   12179:             checkok = 0;
1.1222    damieng  12180:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  12181:         }
                   12182:     }
                   12183:     if (checkok == 0) {
1.1222    damieng  12184:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  12185:         return;
                   12186:     }
                   12187:     if (checkok == 1) {
1.570     raeburn  12188:         callingForm.submit();
1.556     raeburn  12189:     }
                   12190: }
                   12191: 
                   12192: $newuserscript
                   12193: 
1.824     bisitz   12194: // ]]>
1.556     raeburn  12195: </script>
1.558     albertel 12196: 
                   12197: $new_user_create
                   12198: 
1.555     raeburn  12199: END_BLOCK
1.558     albertel 12200: 
1.876     raeburn  12201:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222    damieng  12202:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  12203:                $domform.
                   12204:                &Apache::lonhtmlcommon::row_closure().
1.1222    damieng  12205:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  12206:                $srchbysel.
                   12207:                $srchtypesel. 
                   12208:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   12209:                $srchinsel.
                   12210:                &Apache::lonhtmlcommon::row_closure(1). 
                   12211:                &Apache::lonhtmlcommon::end_pick_box().
                   12212:                '<br />';
1.1253    raeburn  12213:     return ($output,1);
1.555     raeburn  12214: }
                   12215: 
1.612     raeburn  12216: sub user_rule_check {
1.615     raeburn  12217:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226    raeburn  12218:     my ($response,%inst_response);
1.612     raeburn  12219:     if (ref($usershash) eq 'HASH') {
1.1226    raeburn  12220:         if (keys(%{$usershash}) > 1) {
                   12221:             my (%by_username,%by_id,%userdoms);
                   12222:             my $checkid; 
                   12223:             if (ref($checks) eq 'HASH') {
                   12224:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   12225:                     $checkid = 1;
                   12226:                 }
                   12227:             }
                   12228:             foreach my $user (keys(%{$usershash})) {
                   12229:                 my ($uname,$udom) = split(/:/,$user);
                   12230:                 if ($checkid) {
                   12231:                     if (ref($usershash->{$user}) eq 'HASH') {
                   12232:                         if ($usershash->{$user}->{'id'} ne '') {
1.1227    raeburn  12233:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname; 
1.1226    raeburn  12234:                             $userdoms{$udom} = 1;
1.1227    raeburn  12235:                             if (ref($inst_results) eq 'HASH') {
                   12236:                                 $inst_results->{$uname.':'.$udom} = {};
                   12237:                             }
1.1226    raeburn  12238:                         }
                   12239:                     }
                   12240:                 } else {
                   12241:                     $by_username{$udom}{$uname} = 1;
                   12242:                     $userdoms{$udom} = 1;
1.1227    raeburn  12243:                     if (ref($inst_results) eq 'HASH') {
                   12244:                         $inst_results->{$uname.':'.$udom} = {};
                   12245:                     }
1.1226    raeburn  12246:                 }
                   12247:             }
                   12248:             foreach my $udom (keys(%userdoms)) {
                   12249:                 if (!$got_rules->{$udom}) {
                   12250:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   12251:                                                              ['usercreation'],$udom);
                   12252:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   12253:                         foreach my $item ('username','id') {
                   12254:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227    raeburn  12255:                                 $$curr_rules{$udom}{$item} =
                   12256:                                     $domconfig{'usercreation'}{$item.'_rule'};
1.1226    raeburn  12257:                             }
                   12258:                         }
                   12259:                     }
                   12260:                     $got_rules->{$udom} = 1;
                   12261:                 }
1.612     raeburn  12262:             }
1.1226    raeburn  12263:             if ($checkid) {
                   12264:                 foreach my $udom (keys(%by_id)) {
                   12265:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   12266:                     if ($outcome eq 'ok') {
1.1227    raeburn  12267:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   12268:                             my $uname = $by_id{$udom}{$id};
                   12269:                             $inst_response{$uname.':'.$udom} = $outcome;
                   12270:                         }
1.1226    raeburn  12271:                         if (ref($results) eq 'HASH') {
                   12272:                             foreach my $uname (keys(%{$results})) {
1.1227    raeburn  12273:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   12274:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   12275:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   12276:                                 }
1.1226    raeburn  12277:                             }
                   12278:                         }
                   12279:                     }
1.612     raeburn  12280:                 }
1.615     raeburn  12281:             } else {
1.1226    raeburn  12282:                 foreach my $udom (keys(%by_username)) {
                   12283:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   12284:                     if ($outcome eq 'ok') {
1.1227    raeburn  12285:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   12286:                             $inst_response{$uname.':'.$udom} = $outcome;
                   12287:                         }
1.1226    raeburn  12288:                         if (ref($results) eq 'HASH') {
                   12289:                             foreach my $uname (keys(%{$results})) {
                   12290:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   12291:                             }
                   12292:                         }
                   12293:                     }
                   12294:                 }
1.612     raeburn  12295:             }
1.1226    raeburn  12296:         } elsif (keys(%{$usershash}) == 1) {
                   12297:             my $user = (keys(%{$usershash}))[0];
                   12298:             my ($uname,$udom) = split(/:/,$user);
                   12299:             if (($udom ne '') && ($uname ne '')) {
                   12300:                 if (ref($usershash->{$user}) eq 'HASH') {
                   12301:                     if (ref($checks) eq 'HASH') {
                   12302:                         if (defined($checks->{'username'})) {
                   12303:                             ($inst_response{$user},%{$inst_results->{$user}}) = 
                   12304:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   12305:                         } elsif (defined($checks->{'id'})) {
                   12306:                             if ($usershash->{$user}->{'id'} ne '') {
                   12307:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   12308:                                     &Apache::lonnet::get_instuser($udom,undef,
                   12309:                                                                   $usershash->{$user}->{'id'});
                   12310:                             } else {
                   12311:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   12312:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   12313:                             }
1.585     raeburn  12314:                         }
1.1226    raeburn  12315:                     } else {
                   12316:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   12317:                             &Apache::lonnet::get_instuser($udom,$uname);
                   12318:                        return;
                   12319:                     }
                   12320:                     if (!$got_rules->{$udom}) {
                   12321:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   12322:                                                                  ['usercreation'],$udom);
                   12323:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   12324:                             foreach my $item ('username','id') {
                   12325:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   12326:                                    $$curr_rules{$udom}{$item} = 
                   12327:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   12328:                                 }
                   12329:                             }
                   12330:                         }
                   12331:                         $got_rules->{$udom} = 1;
1.585     raeburn  12332:                     }
                   12333:                 }
1.1226    raeburn  12334:             } else {
                   12335:                 return;
                   12336:             }
                   12337:         } else {
                   12338:             return;
                   12339:         }
                   12340:         foreach my $user (keys(%{$usershash})) {
                   12341:             my ($uname,$udom) = split(/:/,$user);
                   12342:             next if (($udom eq '') || ($uname eq ''));
                   12343:             my $id;
1.1227    raeburn  12344:             if (ref($inst_results) eq 'HASH') {
                   12345:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   12346:                     $id = $inst_results->{$user}->{'id'};
                   12347:                 }
                   12348:             }
                   12349:             if ($id eq '') { 
                   12350:                 if (ref($usershash->{$user})) {
                   12351:                     $id = $usershash->{$user}->{'id'};
                   12352:                 }
1.585     raeburn  12353:             }
1.612     raeburn  12354:             foreach my $item (keys(%{$checks})) {
                   12355:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   12356:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   12357:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226    raeburn  12358:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   12359:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  12360:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   12361:                                 if ($rule_check{$rule}) {
                   12362:                                     $$rulematch{$user}{$item} = $rule;
1.1226    raeburn  12363:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  12364:                                         if (ref($inst_results) eq 'HASH') {
                   12365:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   12366:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   12367:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1227    raeburn  12368:                                                 } elsif ($item eq 'id') {
                   12369:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   12370:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   12371:                                                     }
1.615     raeburn  12372:                                                 }
1.612     raeburn  12373:                                             }
                   12374:                                         }
1.615     raeburn  12375:                                     }
                   12376:                                     last;
1.585     raeburn  12377:                                 }
                   12378:                             }
                   12379:                         }
                   12380:                     }
                   12381:                 }
                   12382:             }
                   12383:         }
                   12384:     }
1.612     raeburn  12385:     return;
                   12386: }
                   12387: 
                   12388: sub user_rule_formats {
                   12389:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   12390:     my %text = ( 
                   12391:                  'username' => 'Usernames',
                   12392:                  'id'       => 'IDs',
                   12393:                );
                   12394:     my $output;
                   12395:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   12396:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   12397:         if (@{$ruleorder} > 0) {
1.1102    raeburn  12398:             $output = '<br />'.
                   12399:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   12400:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   12401:                       ' <ul>';
1.612     raeburn  12402:             foreach my $rule (@{$ruleorder}) {
                   12403:                 if (ref($curr_rules) eq 'ARRAY') {
                   12404:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   12405:                         if (ref($rules->{$rule}) eq 'HASH') {
                   12406:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   12407:                                         $rules->{$rule}{'desc'}.'</li>';
                   12408:                         }
                   12409:                     }
                   12410:                 }
                   12411:             }
                   12412:             $output .= '</ul>';
                   12413:         }
                   12414:     }
                   12415:     return $output;
                   12416: }
                   12417: 
                   12418: sub instrule_disallow_msg {
1.615     raeburn  12419:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  12420:     my $response;
                   12421:     my %text = (
                   12422:                   item   => 'username',
                   12423:                   items  => 'usernames',
                   12424:                   match  => 'matches',
                   12425:                   do     => 'does',
                   12426:                   action => 'a username',
                   12427:                   one    => 'one',
                   12428:                );
                   12429:     if ($count > 1) {
                   12430:         $text{'item'} = 'usernames';
                   12431:         $text{'match'} ='match';
                   12432:         $text{'do'} = 'do';
                   12433:         $text{'action'} = 'usernames',
                   12434:         $text{'one'} = 'ones';
                   12435:     }
                   12436:     if ($checkitem eq 'id') {
                   12437:         $text{'items'} = 'IDs';
                   12438:         $text{'item'} = 'ID';
                   12439:         $text{'action'} = 'an ID';
1.615     raeburn  12440:         if ($count > 1) {
                   12441:             $text{'item'} = 'IDs';
                   12442:             $text{'action'} = 'IDs';
                   12443:         }
1.612     raeburn  12444:     }
1.674     bisitz   12445:     $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  12446:     if ($mode eq 'upload') {
                   12447:         if ($checkitem eq 'username') {
                   12448:             $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'}.");
                   12449:         } elsif ($checkitem eq 'id') {
1.674     bisitz   12450:             $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  12451:         }
1.669     raeburn  12452:     } elsif ($mode eq 'selfcreate') {
                   12453:         if ($checkitem eq 'id') {
                   12454:             $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.");
                   12455:         }
1.615     raeburn  12456:     } else {
                   12457:         if ($checkitem eq 'username') {
                   12458:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   12459:         } elsif ($checkitem eq 'id') {
                   12460:             $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.");
                   12461:         }
1.612     raeburn  12462:     }
                   12463:     return $response;
1.585     raeburn  12464: }
                   12465: 
1.624     raeburn  12466: sub personal_data_fieldtitles {
                   12467:     my %fieldtitles = &Apache::lonlocal::texthash (
                   12468:                         id => 'Student/Employee ID',
                   12469:                         permanentemail => 'E-mail address',
                   12470:                         lastname => 'Last Name',
                   12471:                         firstname => 'First Name',
                   12472:                         middlename => 'Middle Name',
                   12473:                         generation => 'Generation',
                   12474:                         gen => 'Generation',
1.765     raeburn  12475:                         inststatus => 'Affiliation',
1.624     raeburn  12476:                    );
                   12477:     return %fieldtitles;
                   12478: }
                   12479: 
1.642     raeburn  12480: sub sorted_inst_types {
                   12481:     my ($dom) = @_;
1.1185    raeburn  12482:     my ($usertypes,$order);
                   12483:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   12484:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   12485:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   12486:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   12487:     } else {
                   12488:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   12489:     }
1.642     raeburn  12490:     my $othertitle = &mt('All users');
                   12491:     if ($env{'request.course.id'}) {
1.668     raeburn  12492:         $othertitle  = &mt('Any users');
1.642     raeburn  12493:     }
                   12494:     my @types;
                   12495:     if (ref($order) eq 'ARRAY') {
                   12496:         @types = @{$order};
                   12497:     }
                   12498:     if (@types == 0) {
                   12499:         if (ref($usertypes) eq 'HASH') {
                   12500:             @types = sort(keys(%{$usertypes}));
                   12501:         }
                   12502:     }
                   12503:     if (keys(%{$usertypes}) > 0) {
                   12504:         $othertitle = &mt('Other users');
                   12505:     }
                   12506:     return ($othertitle,$usertypes,\@types);
                   12507: }
                   12508: 
1.645     raeburn  12509: sub get_institutional_codes {
1.1361    raeburn  12510:     my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645     raeburn  12511: # Get complete list of course sections to update
                   12512:     my @currsections = ();
                   12513:     my @currxlists = ();
1.1361    raeburn  12514:     my (%unclutteredsec,%unclutteredlcsec);
1.645     raeburn  12515:     my $coursecode = $$settings{'internal.coursecode'};
1.1361    raeburn  12516:     my $crskey = $crs.':'.$coursecode;
                   12517:     @{$unclutteredsec{$crskey}} = ();
                   12518:     @{$unclutteredlcsec{$crskey}} = ();
1.645     raeburn  12519: 
                   12520:     if ($$settings{'internal.sectionnums'} ne '') {
                   12521:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   12522:     }
                   12523: 
                   12524:     if ($$settings{'internal.crosslistings'} ne '') {
                   12525:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   12526:     }
                   12527: 
                   12528:     if (@currxlists > 0) {
1.1361    raeburn  12529:         foreach my $xl (@currxlists) {
                   12530:             if ($xl =~ /^([^:]+):(\w*)$/) {
1.645     raeburn  12531:                 unless (grep/^$1$/,@{$allcourses}) {
1.1263    raeburn  12532:                     push(@{$allcourses},$1);
1.645     raeburn  12533:                     $$LC_code{$1} = $2;
                   12534:                 }
                   12535:             }
                   12536:         }
                   12537:     }
1.1361    raeburn  12538: 
1.645     raeburn  12539:     if (@currsections > 0) {
1.1361    raeburn  12540:         foreach my $sec (@currsections) {
                   12541:             if ($sec =~ m/^(\w+):(\w*)$/ ) {
                   12542:                 my $instsec = $1;
1.645     raeburn  12543:                 my $lc_sec = $2;
1.1361    raeburn  12544:                 unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
                   12545:                     push(@{$unclutteredsec{$crskey}},$instsec);
                   12546:                     push(@{$unclutteredlcsec{$crskey}},$lc_sec);
                   12547:                 }
                   12548:             }
                   12549:         }
                   12550:     }
                   12551: 
                   12552:     if (@{$unclutteredsec{$crskey}} > 0) {
                   12553:         my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
                   12554:         if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
                   12555:             for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
                   12556:                 my $sec = $coursecode.$formattedsec{$crskey}[$i];
                   12557:                 unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263    raeburn  12558:                     push(@{$allcourses},$sec);
1.1361    raeburn  12559:                     $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645     raeburn  12560:                 }
                   12561:             }
                   12562:         }
                   12563:     }
                   12564:     return;
                   12565: }
                   12566: 
1.971     raeburn  12567: sub get_standard_codeitems {
                   12568:     return ('Year','Semester','Department','Number','Section');
                   12569: }
                   12570: 
1.112     bowersj2 12571: =pod
                   12572: 
1.780     raeburn  12573: =head1 Slot Helpers
                   12574: 
                   12575: =over 4
                   12576: 
                   12577: =item * sorted_slots()
                   12578: 
1.1040    raeburn  12579: Sorts an array of slot names in order of an optional sort key,
                   12580: default sort is by slot start time (earliest first). 
1.780     raeburn  12581: 
                   12582: Inputs:
                   12583: 
                   12584: =over 4
                   12585: 
                   12586: slotsarr  - Reference to array of unsorted slot names.
                   12587: 
                   12588: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   12589: 
1.1040    raeburn  12590: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   12591: 
1.549     albertel 12592: =back
                   12593: 
1.780     raeburn  12594: Returns:
                   12595: 
                   12596: =over 4
                   12597: 
1.1040    raeburn  12598: sorted   - An array of slot names sorted by a specified sort key 
                   12599:            (default sort key is start time of the slot).
1.780     raeburn  12600: 
                   12601: =back
                   12602: 
                   12603: =cut
                   12604: 
                   12605: 
                   12606: sub sorted_slots {
1.1040    raeburn  12607:     my ($slotsarr,$slots,$sortkey) = @_;
                   12608:     if ($sortkey eq '') {
                   12609:         $sortkey = 'starttime';
                   12610:     }
1.780     raeburn  12611:     my @sorted;
                   12612:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   12613:         @sorted =
                   12614:             sort {
                   12615:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  12616:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  12617:                      }
                   12618:                      if (ref($slots->{$a})) { return -1;}
                   12619:                      if (ref($slots->{$b})) { return 1;}
                   12620:                      return 0;
                   12621:                  } @{$slotsarr};
                   12622:     }
                   12623:     return @sorted;
                   12624: }
                   12625: 
1.1040    raeburn  12626: =pod
                   12627: 
                   12628: =item * get_future_slots()
                   12629: 
                   12630: Inputs:
                   12631: 
                   12632: =over 4
                   12633: 
                   12634: cnum - course number
                   12635: 
                   12636: cdom - course domain
                   12637: 
                   12638: now - current UNIX time
                   12639: 
                   12640: symb - optional symb
                   12641: 
                   12642: =back
                   12643: 
                   12644: Returns:
                   12645: 
                   12646: =over 4
                   12647: 
                   12648: sorted_reservable - ref to array of student_schedulable slots currently 
                   12649:                     reservable, ordered by end date of reservation period.
                   12650: 
                   12651: reservable_now - ref to hash of student_schedulable slots currently
                   12652:                  reservable.
                   12653: 
                   12654:     Keys in inner hash are:
                   12655:     (a) symb: either blank or symb to which slot use is restricted.
1.1250    raeburn  12656:     (b) endreserve: end date of reservation period.
                   12657:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   12658:         selected.
1.1040    raeburn  12659: 
                   12660: sorted_future - ref to array of student_schedulable slots reservable in
                   12661:                 the future, ordered by start date of reservation period.
                   12662: 
                   12663: future_reservable - ref to hash of student_schedulable slots reservable
                   12664:                     in the future.
                   12665: 
                   12666:     Keys in inner hash are:
                   12667:     (a) symb: either blank or symb to which slot use is restricted.
1.1250    raeburn  12668:     (b) startreserve: start date of reservation period.
                   12669:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   12670:         selected.
1.1040    raeburn  12671: 
                   12672: =back
                   12673: 
                   12674: =cut
                   12675: 
                   12676: sub get_future_slots {
                   12677:     my ($cnum,$cdom,$now,$symb) = @_;
1.1229    raeburn  12678:     my $map;
                   12679:     if ($symb) {
                   12680:         ($map) = &Apache::lonnet::decode_symb($symb);
                   12681:     }
1.1040    raeburn  12682:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   12683:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   12684:     foreach my $slot (keys(%slots)) {
                   12685:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   12686:         if ($symb) {
1.1229    raeburn  12687:             if ($slots{$slot}->{'symb'} ne '') {
                   12688:                 my $canuse;
                   12689:                 my %oksymbs;
                   12690:                 my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
                   12691:                 map { $oksymbs{$_} = 1; } @slotsymbs;
                   12692:                 if ($oksymbs{$symb}) {
                   12693:                     $canuse = 1;
                   12694:                 } else {
                   12695:                     foreach my $item (@slotsymbs) {
                   12696:                         if ($item =~ /\.(page|sequence)$/) {
                   12697:                             (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
                   12698:                             if (($map ne '') && ($map eq $sloturl)) {
                   12699:                                 $canuse = 1;
                   12700:                                 last;
                   12701:                             }
                   12702:                         }
                   12703:                     }
                   12704:                 }
                   12705:                 next unless ($canuse);
                   12706:             }
1.1040    raeburn  12707:         }
                   12708:         if (($slots{$slot}->{'starttime'} > $now) &&
                   12709:             ($slots{$slot}->{'endtime'} > $now)) {
                   12710:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   12711:                 my $userallowed = 0;
                   12712:                 if ($slots{$slot}->{'allowedsections'}) {
                   12713:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   12714:                     if (!defined($env{'request.role.sec'})
                   12715:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   12716:                         $userallowed=1;
                   12717:                     } else {
                   12718:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   12719:                             $userallowed=1;
                   12720:                         }
                   12721:                     }
                   12722:                     unless ($userallowed) {
                   12723:                         if (defined($env{'request.course.groups'})) {
                   12724:                             my @groups = split(/:/,$env{'request.course.groups'});
                   12725:                             foreach my $group (@groups) {
                   12726:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   12727:                                     $userallowed=1;
                   12728:                                     last;
                   12729:                                 }
                   12730:                             }
                   12731:                         }
                   12732:                     }
                   12733:                 }
                   12734:                 if ($slots{$slot}->{'allowedusers'}) {
                   12735:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   12736:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   12737:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   12738:                         $userallowed = 1;
                   12739:                     }
                   12740:                 }
                   12741:                 next unless($userallowed);
                   12742:             }
                   12743:             my $startreserve = $slots{$slot}->{'startreserve'};
                   12744:             my $endreserve = $slots{$slot}->{'endreserve'};
                   12745:             my $symb = $slots{$slot}->{'symb'};
1.1250    raeburn  12746:             my $uniqueperiod;
                   12747:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   12748:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   12749:             }
1.1040    raeburn  12750:             if (($startreserve < $now) &&
                   12751:                 (!$endreserve || $endreserve > $now)) {
                   12752:                 my $lastres = $endreserve;
                   12753:                 if (!$lastres) {
                   12754:                     $lastres = $slots{$slot}->{'starttime'};
                   12755:                 }
                   12756:                 $reservable_now{$slot} = {
                   12757:                                            symb       => $symb,
1.1250    raeburn  12758:                                            endreserve => $lastres,
                   12759:                                            uniqueperiod => $uniqueperiod,
1.1040    raeburn  12760:                                          };
                   12761:             } elsif (($startreserve > $now) &&
                   12762:                      (!$endreserve || $endreserve > $startreserve)) {
                   12763:                 $future_reservable{$slot} = {
                   12764:                                               symb         => $symb,
1.1250    raeburn  12765:                                               startreserve => $startreserve,
                   12766:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  12767:                                             };
                   12768:             }
                   12769:         }
                   12770:     }
                   12771:     my @unsorted_reservable = keys(%reservable_now);
                   12772:     if (@unsorted_reservable > 0) {
                   12773:         @sorted_reservable = 
                   12774:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   12775:     }
                   12776:     my @unsorted_future = keys(%future_reservable);
                   12777:     if (@unsorted_future > 0) {
                   12778:         @sorted_future =
                   12779:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   12780:     }
                   12781:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   12782: }
1.780     raeburn  12783: 
                   12784: =pod
                   12785: 
1.1057    foxr     12786: =back
                   12787: 
1.549     albertel 12788: =head1 HTTP Helpers
                   12789: 
                   12790: =over 4
                   12791: 
1.648     raeburn  12792: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 12793: 
1.258     albertel 12794: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 12795: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 12796: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 12797: 
                   12798: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   12799: $possible_names is an ref to an array of form element names.  As an example:
                   12800: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 12801: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 12802: 
                   12803: =cut
1.1       albertel 12804: 
1.6       albertel 12805: sub get_unprocessed_cgi {
1.25      albertel 12806:   my ($query,$possible_names)= @_;
1.26      matthew  12807:   # $Apache::lonxml::debug=1;
1.356     albertel 12808:   foreach my $pair (split(/&/,$query)) {
                   12809:     my ($name, $value) = split(/=/,$pair);
1.369     www      12810:     $name = &unescape($name);
1.25      albertel 12811:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   12812:       $value =~ tr/+/ /;
                   12813:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 12814:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 12815:     }
1.16      harris41 12816:   }
1.6       albertel 12817: }
                   12818: 
1.112     bowersj2 12819: =pod
                   12820: 
1.648     raeburn  12821: =item * &cacheheader() 
1.112     bowersj2 12822: 
                   12823: returns cache-controlling header code
                   12824: 
                   12825: =cut
                   12826: 
1.7       albertel 12827: sub cacheheader {
1.258     albertel 12828:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 12829:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   12830:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 12831:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   12832:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 12833:     return $output;
1.7       albertel 12834: }
                   12835: 
1.112     bowersj2 12836: =pod
                   12837: 
1.648     raeburn  12838: =item * &no_cache($r) 
1.112     bowersj2 12839: 
                   12840: specifies header code to not have cache
                   12841: 
                   12842: =cut
                   12843: 
1.9       albertel 12844: sub no_cache {
1.216     albertel 12845:     my ($r) = @_;
                   12846:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 12847: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 12848:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   12849:     $r->no_cache(1);
                   12850:     $r->header_out("Expires" => $date);
                   12851:     $r->header_out("Pragma" => "no-cache");
1.123     www      12852: }
                   12853: 
                   12854: sub content_type {
1.181     albertel 12855:     my ($r,$type,$charset) = @_;
1.299     foxr     12856:     if ($r) {
                   12857: 	#  Note that printout.pl calls this with undef for $r.
                   12858: 	&no_cache($r);
                   12859:     }
1.258     albertel 12860:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 12861:     unless ($charset) {
                   12862: 	$charset=&Apache::lonlocal::current_encoding;
                   12863:     }
                   12864:     if ($charset) { $type.='; charset='.$charset; }
                   12865:     if ($r) {
                   12866: 	$r->content_type($type);
                   12867:     } else {
                   12868: 	print("Content-type: $type\n\n");
                   12869:     }
1.9       albertel 12870: }
1.25      albertel 12871: 
1.112     bowersj2 12872: =pod
                   12873: 
1.648     raeburn  12874: =item * &add_to_env($name,$value) 
1.112     bowersj2 12875: 
1.258     albertel 12876: adds $name to the %env hash with value
1.112     bowersj2 12877: $value, if $name already exists, the entry is converted to an array
                   12878: reference and $value is added to the array.
                   12879: 
                   12880: =cut
                   12881: 
1.25      albertel 12882: sub add_to_env {
                   12883:   my ($name,$value)=@_;
1.258     albertel 12884:   if (defined($env{$name})) {
                   12885:     if (ref($env{$name})) {
1.25      albertel 12886:       #already have multiple values
1.258     albertel 12887:       push(@{ $env{$name} },$value);
1.25      albertel 12888:     } else {
                   12889:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 12890:       my $first=$env{$name};
                   12891:       undef($env{$name});
                   12892:       push(@{ $env{$name} },$first,$value);
1.25      albertel 12893:     }
                   12894:   } else {
1.258     albertel 12895:     $env{$name}=$value;
1.25      albertel 12896:   }
1.31      albertel 12897: }
1.149     albertel 12898: 
                   12899: =pod
                   12900: 
1.648     raeburn  12901: =item * &get_env_multiple($name) 
1.149     albertel 12902: 
1.258     albertel 12903: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 12904: values may be defined and end up as an array ref.
                   12905: 
                   12906: returns an array of values
                   12907: 
                   12908: =cut
                   12909: 
                   12910: sub get_env_multiple {
                   12911:     my ($name) = @_;
                   12912:     my @values;
1.258     albertel 12913:     if (defined($env{$name})) {
1.149     albertel 12914:         # exists is it an array
1.258     albertel 12915:         if (ref($env{$name})) {
                   12916:             @values=@{ $env{$name} };
1.149     albertel 12917:         } else {
1.258     albertel 12918:             $values[0]=$env{$name};
1.149     albertel 12919:         }
                   12920:     }
                   12921:     return(@values);
                   12922: }
                   12923: 
1.1249    damieng  12924: # Looks at given dependencies, and returns something depending on the context.
                   12925: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
                   12926: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
                   12927: # For all other contexts, returns ($output, $counter, $numpathchg).
                   12928: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
                   12929: # $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.
                   12930: # $numpathchg: integer with the number of cleaned up dependency paths.
                   12931: # \%existing: hash reference clean path -> 1 only for existing dependencies.
                   12932: # \%mapping: hash reference clean path -> original path for all dependencies.
                   12933: # @param {string} actionurl - The path to the handler, indicative of the context.
                   12934: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
                   12935: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
                   12936: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
                   12937: # @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)
                   12938: # @return {Array} - array depending on the context (not a reference)
1.660     raeburn  12939: sub ask_for_embedded_content {
1.1249    damieng  12940:     # NOTE: documentation was added afterwards, it could be wrong
1.660     raeburn  12941:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  12942:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085    raeburn  12943:         %currsubfile,%unused,$rem);
1.1071    raeburn  12944:     my $counter = 0;
                   12945:     my $numnew = 0;
1.987     raeburn  12946:     my $numremref = 0;
                   12947:     my $numinvalid = 0;
                   12948:     my $numpathchg = 0;
                   12949:     my $numexisting = 0;
1.1071    raeburn  12950:     my $numunused = 0;
                   12951:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156    raeburn  12952:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  12953:     my $heading = &mt('Upload embedded files');
                   12954:     my $buttontext = &mt('Upload');
                   12955: 
1.1249    damieng  12956:     # fills these variables based on the context:
                   12957:     # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
                   12958:     # $path, $fileloc, $title, $rem, $filename
1.1085    raeburn  12959:     if ($env{'request.course.id'}) {
1.1123    raeburn  12960:         if ($actionurl eq '/adm/dependencies') {
                   12961:             $navmap = Apache::lonnavmaps::navmap->new();
                   12962:         }
                   12963:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   12964:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085    raeburn  12965:     }
1.1123    raeburn  12966:     if (($actionurl eq '/adm/portfolio') || 
                   12967:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  12968:         my $current_path='/';
                   12969:         if ($env{'form.currentpath'}) {
                   12970:             $current_path = $env{'form.currentpath'};
                   12971:         }
                   12972:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123    raeburn  12973:             $udom = $cdom;
                   12974:             $uname = $cnum;
1.984     raeburn  12975:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   12976:         } else {
                   12977:             $udom = $env{'user.domain'};
                   12978:             $uname = $env{'user.name'};
                   12979:             $url = '/userfiles/portfolio';
                   12980:         }
1.987     raeburn  12981:         $toplevel = $url.'/';
1.984     raeburn  12982:         $url .= $current_path;
                   12983:         $getpropath = 1;
1.987     raeburn  12984:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   12985:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      12986:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  12987:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  12988:         $toplevel = $url;
1.984     raeburn  12989:         if ($rest ne '') {
1.987     raeburn  12990:             $url .= $rest;
                   12991:         }
                   12992:     } elsif ($actionurl eq '/adm/coursedocs') {
                   12993:         if (ref($args) eq 'HASH') {
1.1071    raeburn  12994:             $url = $args->{'docs_url'};
                   12995:             $toplevel = $url;
1.1084    raeburn  12996:             if ($args->{'context'} eq 'paste') {
                   12997:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   12998:                 ($path) = 
                   12999:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   13000:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   13001:                 $fileloc =~ s{^/}{};
                   13002:             }
1.1071    raeburn  13003:         }
1.1084    raeburn  13004:     } elsif ($actionurl eq '/adm/dependencies')  {
1.1071    raeburn  13005:         if ($env{'request.course.id'} ne '') {
                   13006:             if (ref($args) eq 'HASH') {
                   13007:                 $url = $args->{'docs_url'};
                   13008:                 $title = $args->{'docs_title'};
1.1126    raeburn  13009:                 $toplevel = $url; 
                   13010:                 unless ($toplevel =~ m{^/}) {
                   13011:                     $toplevel = "/$url";
                   13012:                 }
1.1085    raeburn  13013:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126    raeburn  13014:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   13015:                     $path = $1;
                   13016:                 } else {
                   13017:                     ($path) =
                   13018:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   13019:                 }
1.1195    raeburn  13020:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   13021:                     $fileloc = $toplevel;
                   13022:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   13023:                     my ($udom,$uname,$fname) =
                   13024:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   13025:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   13026:                 } else {
                   13027:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   13028:                 }
1.1071    raeburn  13029:                 $fileloc =~ s{^/}{};
                   13030:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   13031:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   13032:             }
1.987     raeburn  13033:         }
1.1123    raeburn  13034:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   13035:         $udom = $cdom;
                   13036:         $uname = $cnum;
                   13037:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   13038:         $toplevel = $url;
                   13039:         $path = $url;
                   13040:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   13041:         $fileloc =~ s{^/}{};
1.987     raeburn  13042:     }
1.1249    damieng  13043:     
                   13044:     # parses the dependency paths to get some info
                   13045:     # fills $newfiles, $mapping, $subdependencies, $dependencies
                   13046:     # $newfiles: hash URL -> 1 for new files or external URLs
                   13047:     # (will be completed later)
                   13048:     # $mapping:
                   13049:     #   for external URLs: external URL -> external URL
                   13050:     #   for relative paths: clean path -> original path
                   13051:     # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
                   13052:     # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126    raeburn  13053:     foreach my $file (keys(%{$allfiles})) {
                   13054:         my $embed_file;
                   13055:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   13056:             $embed_file = $1;
                   13057:         } else {
                   13058:             $embed_file = $file;
                   13059:         }
1.1158    raeburn  13060:         my ($absolutepath,$cleaned_file);
                   13061:         if ($embed_file =~ m{^\w+://}) {
                   13062:             $cleaned_file = $embed_file;
1.1147    raeburn  13063:             $newfiles{$cleaned_file} = 1;
                   13064:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  13065:         } else {
1.1158    raeburn  13066:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  13067:             if ($embed_file =~ m{^/}) {
                   13068:                 $absolutepath = $embed_file;
                   13069:             }
1.1147    raeburn  13070:             if ($cleaned_file =~ m{/}) {
                   13071:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  13072:                 $path = &check_for_traversal($path,$url,$toplevel);
                   13073:                 my $item = $fname;
                   13074:                 if ($path ne '') {
                   13075:                     $item = $path.'/'.$fname;
                   13076:                     $subdependencies{$path}{$fname} = 1;
                   13077:                 } else {
                   13078:                     $dependencies{$item} = 1;
                   13079:                 }
                   13080:                 if ($absolutepath) {
                   13081:                     $mapping{$item} = $absolutepath;
                   13082:                 } else {
                   13083:                     $mapping{$item} = $embed_file;
                   13084:                 }
                   13085:             } else {
                   13086:                 $dependencies{$embed_file} = 1;
                   13087:                 if ($absolutepath) {
1.1147    raeburn  13088:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  13089:                 } else {
1.1147    raeburn  13090:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  13091:                 }
                   13092:             }
1.984     raeburn  13093:         }
                   13094:     }
1.1249    damieng  13095:     
                   13096:     # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
                   13097:     # and lists
                   13098:     # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
                   13099:     # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
                   13100:     # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
                   13101:     #                                    the path had to be cleaned up
                   13102:     # $existing: hash clean path -> 1 if the file exists
                   13103:     # $numexisting: number of keys in $existing
                   13104:     # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
                   13105:     # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
                   13106:     #                                      dependency subdirectories that are
                   13107:     #                                      not listed as dependencies, with some exceptions using $rem
1.1071    raeburn  13108:     my $dirptr = 16384;
1.984     raeburn  13109:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  13110:         $currsubfile{$path} = {};
1.1123    raeburn  13111:         if (($actionurl eq '/adm/portfolio') || 
                   13112:             ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  13113:             my ($sublistref,$listerror) =
                   13114:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   13115:             if (ref($sublistref) eq 'ARRAY') {
                   13116:                 foreach my $line (@{$sublistref}) {
                   13117:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  13118:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  13119:                 }
1.984     raeburn  13120:             }
1.987     raeburn  13121:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  13122:             if (opendir(my $dir,$url.'/'.$path)) {
                   13123:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  13124:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   13125:             }
1.1084    raeburn  13126:         } elsif (($actionurl eq '/adm/dependencies') ||
                   13127:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123    raeburn  13128:                   ($args->{'context'} eq 'paste')) ||
                   13129:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  13130:             if ($env{'request.course.id'} ne '') {
1.1123    raeburn  13131:                 my $dir;
                   13132:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   13133:                     $dir = $fileloc;
                   13134:                 } else {
                   13135:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   13136:                 }
1.1071    raeburn  13137:                 if ($dir ne '') {
                   13138:                     my ($sublistref,$listerror) =
                   13139:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   13140:                     if (ref($sublistref) eq 'ARRAY') {
                   13141:                         foreach my $line (@{$sublistref}) {
                   13142:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   13143:                                 undef,$mtime)=split(/\&/,$line,12);
                   13144:                             unless (($testdir&$dirptr) ||
                   13145:                                     ($file_name =~ /^\.\.?$/)) {
                   13146:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   13147:                             }
                   13148:                         }
                   13149:                     }
                   13150:                 }
1.984     raeburn  13151:             }
                   13152:         }
                   13153:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  13154:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  13155:                 my $item = $path.'/'.$file;
                   13156:                 unless ($mapping{$item} eq $item) {
                   13157:                     $pathchanges{$item} = 1;
                   13158:                 }
                   13159:                 $existing{$item} = 1;
                   13160:                 $numexisting ++;
                   13161:             } else {
                   13162:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  13163:             }
                   13164:         }
1.1071    raeburn  13165:         if ($actionurl eq '/adm/dependencies') {
                   13166:             foreach my $path (keys(%currsubfile)) {
                   13167:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   13168:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   13169:                          unless ($subdependencies{$path}{$file}) {
1.1085    raeburn  13170:                              next if (($rem ne '') &&
                   13171:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   13172:                                        (ref($navmap) &&
                   13173:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   13174:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   13175:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  13176:                              $unused{$path.'/'.$file} = 1; 
                   13177:                          }
                   13178:                     }
                   13179:                 }
                   13180:             }
                   13181:         }
1.984     raeburn  13182:     }
1.1249    damieng  13183:     
                   13184:     # fills $currfile, hash file name -> 1 or [$size,$mtime]
                   13185:     # for files in $url or $fileloc (target directory) in some contexts
1.987     raeburn  13186:     my %currfile;
1.1123    raeburn  13187:     if (($actionurl eq '/adm/portfolio') ||
                   13188:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  13189:         my ($dirlistref,$listerror) =
                   13190:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   13191:         if (ref($dirlistref) eq 'ARRAY') {
                   13192:             foreach my $line (@{$dirlistref}) {
                   13193:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   13194:                 $currfile{$file_name} = 1;
                   13195:             }
1.984     raeburn  13196:         }
1.987     raeburn  13197:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  13198:         if (opendir(my $dir,$url)) {
1.987     raeburn  13199:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  13200:             map {$currfile{$_} = 1;} @dir_list;
                   13201:         }
1.1084    raeburn  13202:     } elsif (($actionurl eq '/adm/dependencies') ||
                   13203:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123    raeburn  13204:               ($args->{'context'} eq 'paste')) ||
                   13205:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  13206:         if ($env{'request.course.id'} ne '') {
                   13207:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   13208:             if ($dir ne '') {
                   13209:                 my ($dirlistref,$listerror) =
                   13210:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   13211:                 if (ref($dirlistref) eq 'ARRAY') {
                   13212:                     foreach my $line (@{$dirlistref}) {
                   13213:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   13214:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   13215:                         unless (($testdir&$dirptr) ||
                   13216:                                 ($file_name =~ /^\.\.?$/)) {
                   13217:                             $currfile{$file_name} = [$size,$mtime];
                   13218:                         }
                   13219:                     }
                   13220:                 }
                   13221:             }
                   13222:         }
1.984     raeburn  13223:     }
1.1249    damieng  13224:     # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
                   13225:     # are not in subdirectories, using $currfile
1.984     raeburn  13226:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  13227:         if (exists($currfile{$file})) {
1.987     raeburn  13228:             unless ($mapping{$file} eq $file) {
                   13229:                 $pathchanges{$file} = 1;
                   13230:             }
                   13231:             $existing{$file} = 1;
                   13232:             $numexisting ++;
                   13233:         } else {
1.984     raeburn  13234:             $newfiles{$file} = 1;
                   13235:         }
                   13236:     }
1.1071    raeburn  13237:     foreach my $file (keys(%currfile)) {
                   13238:         unless (($file eq $filename) ||
                   13239:                 ($file eq $filename.'.bak') ||
                   13240:                 ($dependencies{$file})) {
1.1085    raeburn  13241:             if ($actionurl eq '/adm/dependencies') {
1.1126    raeburn  13242:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   13243:                     next if (($rem ne '') &&
                   13244:                              (($env{"httpref.$rem".$file} ne '') ||
                   13245:                               (ref($navmap) &&
                   13246:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   13247:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   13248:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   13249:                 }
1.1085    raeburn  13250:             }
1.1071    raeburn  13251:             $unused{$file} = 1;
                   13252:         }
                   13253:     }
1.1249    damieng  13254:     
                   13255:     # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084    raeburn  13256:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   13257:         ($args->{'context'} eq 'paste')) {
                   13258:         $counter = scalar(keys(%existing));
                   13259:         $numpathchg = scalar(keys(%pathchanges));
1.1123    raeburn  13260:         return ($output,$counter,$numpathchg,\%existing);
                   13261:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") && 
                   13262:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   13263:         $counter = scalar(keys(%existing));
                   13264:         $numpathchg = scalar(keys(%pathchanges));
                   13265:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084    raeburn  13266:     }
1.1249    damieng  13267:     
                   13268:     # returns HTML otherwise, with dependency results and to ask for more uploads
                   13269:     
                   13270:     # $upload_output: missing dependencies (with upload form)
                   13271:     # $modify_output: uploaded dependencies (in use)
                   13272:     # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984     raeburn  13273:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  13274:         if ($actionurl eq '/adm/dependencies') {
                   13275:             next if ($embed_file =~ m{^\w+://});
                   13276:         }
1.660     raeburn  13277:         $upload_output .= &start_data_table_row().
1.1123    raeburn  13278:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  13279:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  13280:         unless ($mapping{$embed_file} eq $embed_file) {
1.1123    raeburn  13281:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   13282:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  13283:         }
1.1123    raeburn  13284:         $upload_output .= '</td>';
1.1071    raeburn  13285:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1123    raeburn  13286:             $upload_output.='<td align="right">'.
                   13287:                             '<span class="LC_info LC_fontsize_medium">'.
                   13288:                             &mt("URL points to web address").'</span>';
1.987     raeburn  13289:             $numremref++;
1.660     raeburn  13290:         } elsif ($args->{'error_on_invalid_names'}
                   13291:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123    raeburn  13292:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   13293:                             &mt('Invalid characters').'</span>';
1.987     raeburn  13294:             $numinvalid++;
1.660     raeburn  13295:         } else {
1.1123    raeburn  13296:             $upload_output .= '<td>'.
                   13297:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  13298:                                                      $embed_file,\%mapping,
1.1071    raeburn  13299:                                                      $allfiles,$codebase,'upload');
                   13300:             $counter ++;
                   13301:             $numnew ++;
1.987     raeburn  13302:         }
                   13303:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   13304:     }
                   13305:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  13306:         if ($actionurl eq '/adm/dependencies') {
                   13307:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   13308:             $modify_output .= &start_data_table_row().
                   13309:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   13310:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   13311:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   13312:                               '<td>'.$size.'</td>'.
                   13313:                               '<td>'.$mtime.'</td>'.
                   13314:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   13315:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   13316:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   13317:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   13318:                               &embedded_file_element('upload_embedded',$counter,
                   13319:                                                      $embed_file,\%mapping,
                   13320:                                                      $allfiles,$codebase,'modify').
                   13321:                               '</div></td>'.
                   13322:                               &end_data_table_row()."\n";
                   13323:             $counter ++;
                   13324:         } else {
                   13325:             $upload_output .= &start_data_table_row().
1.1123    raeburn  13326:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   13327:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   13328:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  13329:                               &Apache::loncommon::end_data_table_row()."\n";
                   13330:         }
                   13331:     }
                   13332:     my $delidx = $counter;
                   13333:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   13334:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   13335:         $delete_output .= &start_data_table_row().
                   13336:                           '<td><img src="'.&icon($oldfile).'" />'.
                   13337:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   13338:                           '<td>'.$size.'</td>'.
                   13339:                           '<td>'.$mtime.'</td>'.
                   13340:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   13341:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   13342:                           &embedded_file_element('upload_embedded',$delidx,
                   13343:                                                  $oldfile,\%mapping,$allfiles,
                   13344:                                                  $codebase,'delete').'</td>'.
                   13345:                           &end_data_table_row()."\n"; 
                   13346:         $numunused ++;
                   13347:         $delidx ++;
1.987     raeburn  13348:     }
                   13349:     if ($upload_output) {
                   13350:         $upload_output = &start_data_table().
                   13351:                          $upload_output.
                   13352:                          &end_data_table()."\n";
                   13353:     }
1.1071    raeburn  13354:     if ($modify_output) {
                   13355:         $modify_output = &start_data_table().
                   13356:                          &start_data_table_header_row().
                   13357:                          '<th>'.&mt('File').'</th>'.
                   13358:                          '<th>'.&mt('Size (KB)').'</th>'.
                   13359:                          '<th>'.&mt('Modified').'</th>'.
                   13360:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   13361:                          &end_data_table_header_row().
                   13362:                          $modify_output.
                   13363:                          &end_data_table()."\n";
                   13364:     }
                   13365:     if ($delete_output) {
                   13366:         $delete_output = &start_data_table().
                   13367:                          &start_data_table_header_row().
                   13368:                          '<th>'.&mt('File').'</th>'.
                   13369:                          '<th>'.&mt('Size (KB)').'</th>'.
                   13370:                          '<th>'.&mt('Modified').'</th>'.
                   13371:                          '<th>'.&mt('Delete?').'</th>'.
                   13372:                          &end_data_table_header_row().
                   13373:                          $delete_output.
                   13374:                          &end_data_table()."\n";
                   13375:     }
1.987     raeburn  13376:     my $applies = 0;
                   13377:     if ($numremref) {
                   13378:         $applies ++;
                   13379:     }
                   13380:     if ($numinvalid) {
                   13381:         $applies ++;
                   13382:     }
                   13383:     if ($numexisting) {
                   13384:         $applies ++;
                   13385:     }
1.1071    raeburn  13386:     if ($counter || $numunused) {
1.987     raeburn  13387:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   13388:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  13389:                   $state.'<h3>'.$heading.'</h3>'; 
                   13390:         if ($actionurl eq '/adm/dependencies') {
                   13391:             if ($numnew) {
                   13392:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   13393:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   13394:                            $upload_output.'<br />'."\n";
                   13395:             }
                   13396:             if ($numexisting) {
                   13397:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   13398:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   13399:                            $modify_output.'<br />'."\n";
                   13400:                            $buttontext = &mt('Save changes');
                   13401:             }
                   13402:             if ($numunused) {
                   13403:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   13404:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   13405:                            $delete_output.'<br />'."\n";
                   13406:                            $buttontext = &mt('Save changes');
                   13407:             }
                   13408:         } else {
                   13409:             $output .= $upload_output.'<br />'."\n";
                   13410:         }
                   13411:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   13412:                    $counter.'" />'."\n";
                   13413:         if ($actionurl eq '/adm/dependencies') { 
                   13414:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   13415:                        $numnew.'" />'."\n";
                   13416:         } elsif ($actionurl eq '') {
1.987     raeburn  13417:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   13418:         }
                   13419:     } elsif ($applies) {
                   13420:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   13421:         if ($applies > 1) {
                   13422:             $output .=  
1.1123    raeburn  13423:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  13424:             if ($numremref) {
                   13425:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   13426:             }
                   13427:             if ($numinvalid) {
                   13428:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   13429:             }
                   13430:             if ($numexisting) {
                   13431:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   13432:             }
                   13433:             $output .= '</ul><br />';
                   13434:         } elsif ($numremref) {
                   13435:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   13436:         } elsif ($numinvalid) {
                   13437:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   13438:         } elsif ($numexisting) {
                   13439:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   13440:         }
                   13441:         $output .= $upload_output.'<br />';
                   13442:     }
                   13443:     my ($pathchange_output,$chgcount);
1.1071    raeburn  13444:     $chgcount = $counter;
1.987     raeburn  13445:     if (keys(%pathchanges) > 0) {
                   13446:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  13447:             if ($counter) {
1.987     raeburn  13448:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   13449:                                                   $embed_file,\%mapping,
1.1071    raeburn  13450:                                                   $allfiles,$codebase,'change');
1.987     raeburn  13451:             } else {
                   13452:                 $pathchange_output .= 
                   13453:                     &start_data_table_row().
                   13454:                     '<td><input type ="checkbox" name="namechange" value="'.
                   13455:                     $chgcount.'" checked="checked" /></td>'.
                   13456:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   13457:                     '<td>'.$embed_file.
                   13458:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  13459:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  13460:                     '</td>'.&end_data_table_row();
1.660     raeburn  13461:             }
1.987     raeburn  13462:             $numpathchg ++;
                   13463:             $chgcount ++;
1.660     raeburn  13464:         }
                   13465:     }
1.1127    raeburn  13466:     if (($counter) || ($numunused)) {
1.987     raeburn  13467:         if ($numpathchg) {
                   13468:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   13469:                        $numpathchg.'" />'."\n";
                   13470:         }
                   13471:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   13472:             ($actionurl eq '/adm/imsimport')) {
                   13473:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   13474:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   13475:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  13476:         } elsif ($actionurl eq '/adm/dependencies') {
                   13477:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  13478:         }
1.1123    raeburn  13479:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  13480:     } elsif ($numpathchg) {
                   13481:         my %pathchange = ();
                   13482:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   13483:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   13484:             $output .= '<p>'.&mt('or').'</p>'; 
1.1123    raeburn  13485:         }
1.987     raeburn  13486:     }
1.1071    raeburn  13487:     return ($output,$counter,$numpathchg);
1.987     raeburn  13488: }
                   13489: 
1.1147    raeburn  13490: =pod
                   13491: 
                   13492: =item * clean_path($name)
                   13493: 
                   13494: Performs clean-up of directories, subdirectories and filename in an
                   13495: embedded object, referenced in an HTML file which is being uploaded
                   13496: to a course or portfolio, where 
                   13497: "Upload embedded images/multimedia files if HTML file" checkbox was
                   13498: checked.
                   13499: 
                   13500: Clean-up is similar to replacements in lonnet::clean_filename()
                   13501: except each / between sub-directory and next level is preserved.
                   13502: 
                   13503: =cut
                   13504: 
                   13505: sub clean_path {
                   13506:     my ($embed_file) = @_;
                   13507:     $embed_file =~s{^/+}{};
                   13508:     my @contents;
                   13509:     if ($embed_file =~ m{/}) {
                   13510:         @contents = split(/\//,$embed_file);
                   13511:     } else {
                   13512:         @contents = ($embed_file);
                   13513:     }
                   13514:     my $lastidx = scalar(@contents)-1;
                   13515:     for (my $i=0; $i<=$lastidx; $i++) { 
                   13516:         $contents[$i]=~s{\\}{/}g;
                   13517:         $contents[$i]=~s/\s+/\_/g;
                   13518:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   13519:         if ($i == $lastidx) {
                   13520:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   13521:         }
                   13522:     }
                   13523:     if ($lastidx > 0) {
                   13524:         return join('/',@contents);
                   13525:     } else {
                   13526:         return $contents[0];
                   13527:     }
                   13528: }
                   13529: 
1.987     raeburn  13530: sub embedded_file_element {
1.1071    raeburn  13531:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  13532:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   13533:                    (ref($codebase) eq 'HASH'));
                   13534:     my $output;
1.1071    raeburn  13535:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  13536:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   13537:     }
                   13538:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   13539:                &escape($embed_file).'" />';
                   13540:     unless (($context eq 'upload_embedded') && 
                   13541:             ($mapping->{$embed_file} eq $embed_file)) {
                   13542:         $output .='
                   13543:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   13544:     }
                   13545:     my $attrib;
                   13546:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   13547:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   13548:     }
                   13549:     $output .=
                   13550:         "\n\t\t".
                   13551:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   13552:         $attrib.'" />';
                   13553:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   13554:         $output .=
                   13555:             "\n\t\t".
                   13556:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   13557:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  13558:     }
1.987     raeburn  13559:     return $output;
1.660     raeburn  13560: }
                   13561: 
1.1071    raeburn  13562: sub get_dependency_details {
                   13563:     my ($currfile,$currsubfile,$embed_file) = @_;
                   13564:     my ($size,$mtime,$showsize,$showmtime);
                   13565:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   13566:         if ($embed_file =~ m{/}) {
                   13567:             my ($path,$fname) = split(/\//,$embed_file);
                   13568:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   13569:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   13570:             }
                   13571:         } else {
                   13572:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   13573:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   13574:             }
                   13575:         }
                   13576:         $showsize = $size/1024.0;
                   13577:         $showsize = sprintf("%.1f",$showsize);
                   13578:         if ($mtime > 0) {
                   13579:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   13580:         }
                   13581:     }
                   13582:     return ($showsize,$showmtime);
                   13583: }
                   13584: 
                   13585: sub ask_embedded_js {
                   13586:     return <<"END";
                   13587: <script type="text/javascript"">
                   13588: // <![CDATA[
                   13589: function toggleBrowse(counter) {
                   13590:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   13591:     var fileid = document.getElementById('embedded_item_'+counter);
                   13592:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   13593:     if (chkboxid.checked == true) {
                   13594:         uploaddivid.style.display='block';
                   13595:     } else {
                   13596:         uploaddivid.style.display='none';
                   13597:         fileid.value = '';
                   13598:     }
                   13599: }
                   13600: // ]]>
                   13601: </script>
                   13602: 
                   13603: END
                   13604: }
                   13605: 
1.661     raeburn  13606: sub upload_embedded {
                   13607:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  13608:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   13609:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  13610:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   13611:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   13612:         my $orig_uploaded_filename =
                   13613:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  13614:         foreach my $type ('orig','ref','attrib','codebase') {
                   13615:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   13616:                 $env{'form.embedded_'.$type.'_'.$i} =
                   13617:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   13618:             }
                   13619:         }
1.661     raeburn  13620:         my ($path,$fname) =
                   13621:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   13622:         # no path, whole string is fname
                   13623:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   13624:         $fname = &Apache::lonnet::clean_filename($fname);
                   13625:         # See if there is anything left
                   13626:         next if ($fname eq '');
                   13627: 
                   13628:         # Check if file already exists as a file or directory.
                   13629:         my ($state,$msg);
                   13630:         if ($context eq 'portfolio') {
                   13631:             my $port_path = $dirpath;
                   13632:             if ($group ne '') {
                   13633:                 $port_path = "groups/$group/$port_path";
                   13634:             }
1.987     raeburn  13635:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   13636:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  13637:                                               $dir_root,$port_path,$disk_quota,
                   13638:                                               $current_disk_usage,$uname,$udom);
                   13639:             if ($state eq 'will_exceed_quota'
1.984     raeburn  13640:                 || $state eq 'file_locked') {
1.661     raeburn  13641:                 $output .= $msg;
                   13642:                 next;
                   13643:             }
                   13644:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   13645:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   13646:             if ($state eq 'exists') {
                   13647:                 $output .= $msg;
                   13648:                 next;
                   13649:             }
                   13650:         }
                   13651:         # Check if extension is valid
                   13652:         if (($fname =~ /\.(\w+)$/) &&
                   13653:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155    bisitz   13654:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   13655:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  13656:             next;
                   13657:         } elsif (($fname =~ /\.(\w+)$/) &&
                   13658:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  13659:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  13660:             next;
                   13661:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120    bisitz   13662:             $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  13663:             next;
                   13664:         }
                   13665:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123    raeburn  13666:         my $subdir = $path;
                   13667:         $subdir =~ s{/+$}{};
1.661     raeburn  13668:         if ($context eq 'portfolio') {
1.984     raeburn  13669:             my $result;
                   13670:             if ($state eq 'existingfile') {
                   13671:                 $result=
                   13672:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123    raeburn  13673:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  13674:             } else {
1.984     raeburn  13675:                 $result=
                   13676:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  13677:                                                     $dirpath.
1.1123    raeburn  13678:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  13679:                 if ($result !~ m|^/uploaded/|) {
                   13680:                     $output .= '<span class="LC_error">'
                   13681:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   13682:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   13683:                                .'</span><br />';
                   13684:                     next;
                   13685:                 } else {
1.987     raeburn  13686:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   13687:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  13688:                 }
1.661     raeburn  13689:             }
1.1123    raeburn  13690:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126    raeburn  13691:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   13692:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  13693:             my $result =
1.1126    raeburn  13694:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  13695:             if ($result !~ m|^/uploaded/|) {
                   13696:                 $output .= '<span class="LC_error">'
                   13697:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   13698:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   13699:                            .'</span><br />';
                   13700:                     next;
                   13701:             } else {
                   13702:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   13703:                            $path.$fname.'</span>').'<br />';
1.1125    raeburn  13704:                 if ($context eq 'syllabus') {
                   13705:                     &Apache::lonnet::make_public_indefinitely($result);
                   13706:                 }
1.987     raeburn  13707:             }
1.661     raeburn  13708:         } else {
                   13709: # Save the file
                   13710:             my $target = $env{'form.embedded_item_'.$i};
                   13711:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   13712:             my $dest = $fullpath.$fname;
                   13713:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  13714:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  13715:             my $count;
                   13716:             my $filepath = $dir_root;
1.1027    raeburn  13717:             foreach my $subdir (@parts) {
                   13718:                 $filepath .= "/$subdir";
                   13719:                 if (!-e $filepath) {
1.661     raeburn  13720:                     mkdir($filepath,0770);
                   13721:                 }
                   13722:             }
                   13723:             my $fh;
                   13724:             if (!open($fh,'>'.$dest)) {
                   13725:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   13726:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  13727:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   13728:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  13729:                            '</span><br />';
                   13730:             } else {
                   13731:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   13732:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   13733:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  13734:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   13735:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  13736:                               '</span><br />';
                   13737:                 } else {
1.987     raeburn  13738:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   13739:                                $url.'</span>').'<br />';
                   13740:                     unless ($context eq 'testbank') {
                   13741:                         $footer .= &mt('View embedded file: [_1]',
                   13742:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   13743:                     }
                   13744:                 }
                   13745:                 close($fh);
                   13746:             }
                   13747:         }
                   13748:         if ($env{'form.embedded_ref_'.$i}) {
                   13749:             $pathchange{$i} = 1;
                   13750:         }
                   13751:     }
                   13752:     if ($output) {
                   13753:         $output = '<p>'.$output.'</p>';
                   13754:     }
                   13755:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   13756:     $returnflag = 'ok';
1.1071    raeburn  13757:     my $numpathchgs = scalar(keys(%pathchange));
                   13758:     if ($numpathchgs > 0) {
1.987     raeburn  13759:         if ($context eq 'portfolio') {
                   13760:             $output .= '<p>'.&mt('or').'</p>';
                   13761:         } elsif ($context eq 'testbank') {
1.1071    raeburn  13762:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   13763:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  13764:             $returnflag = 'modify_orightml';
                   13765:         }
                   13766:     }
1.1071    raeburn  13767:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  13768: }
                   13769: 
                   13770: sub modify_html_form {
                   13771:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   13772:     my $end = 0;
                   13773:     my $modifyform;
                   13774:     if ($context eq 'upload_embedded') {
                   13775:         return unless (ref($pathchange) eq 'HASH');
                   13776:         if ($env{'form.number_embedded_items'}) {
                   13777:             $end += $env{'form.number_embedded_items'};
                   13778:         }
                   13779:         if ($env{'form.number_pathchange_items'}) {
                   13780:             $end += $env{'form.number_pathchange_items'};
                   13781:         }
                   13782:         if ($end) {
                   13783:             for (my $i=0; $i<$end; $i++) {
                   13784:                 if ($i < $env{'form.number_embedded_items'}) {
                   13785:                     next unless($pathchange->{$i});
                   13786:                 }
                   13787:                 $modifyform .=
                   13788:                     &start_data_table_row().
                   13789:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   13790:                     'checked="checked" /></td>'.
                   13791:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   13792:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   13793:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   13794:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   13795:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   13796:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   13797:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   13798:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   13799:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   13800:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   13801:                     &end_data_table_row();
1.1071    raeburn  13802:             }
1.987     raeburn  13803:         }
                   13804:     } else {
                   13805:         $modifyform = $pathchgtable;
                   13806:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   13807:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   13808:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   13809:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   13810:         }
                   13811:     }
                   13812:     if ($modifyform) {
1.1071    raeburn  13813:         if ($actionurl eq '/adm/dependencies') {
                   13814:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   13815:         }
1.987     raeburn  13816:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   13817:                '<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".
                   13818:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   13819:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   13820:                '</ol></p>'."\n".'<p>'.
                   13821:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   13822:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   13823:                &start_data_table()."\n".
                   13824:                &start_data_table_header_row().
                   13825:                '<th>'.&mt('Change?').'</th>'.
                   13826:                '<th>'.&mt('Current reference').'</th>'.
                   13827:                '<th>'.&mt('Required reference').'</th>'.
                   13828:                &end_data_table_header_row()."\n".
                   13829:                $modifyform.
                   13830:                &end_data_table().'<br />'."\n".$hiddenstate.
                   13831:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   13832:                '</form>'."\n";
                   13833:     }
                   13834:     return;
                   13835: }
                   13836: 
                   13837: sub modify_html_refs {
1.1123    raeburn  13838:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  13839:     my $container;
                   13840:     if ($context eq 'portfolio') {
                   13841:         $container = $env{'form.container'};
                   13842:     } elsif ($context eq 'coursedoc') {
                   13843:         $container = $env{'form.primaryurl'};
1.1071    raeburn  13844:     } elsif ($context eq 'manage_dependencies') {
                   13845:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   13846:         $container = "/$container";
1.1123    raeburn  13847:     } elsif ($context eq 'syllabus') {
                   13848:         $container = $url;
1.987     raeburn  13849:     } else {
1.1027    raeburn  13850:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  13851:     }
                   13852:     my (%allfiles,%codebase,$output,$content);
                   13853:     my @changes = &get_env_multiple('form.namechange');
1.1126    raeburn  13854:     unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071    raeburn  13855:         if (wantarray) {
                   13856:             return ('',0,0); 
                   13857:         } else {
                   13858:             return;
                   13859:         }
                   13860:     }
                   13861:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1123    raeburn  13862:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  13863:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   13864:             if (wantarray) {
                   13865:                 return ('',0,0);
                   13866:             } else {
                   13867:                 return;
                   13868:             }
                   13869:         } 
1.987     raeburn  13870:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  13871:         if ($content eq '-1') {
                   13872:             if (wantarray) {
                   13873:                 return ('',0,0);
                   13874:             } else {
                   13875:                 return;
                   13876:             }
                   13877:         }
1.987     raeburn  13878:     } else {
1.1071    raeburn  13879:         unless ($container =~ /^\Q$dir_root\E/) {
                   13880:             if (wantarray) {
                   13881:                 return ('',0,0);
                   13882:             } else {
                   13883:                 return;
                   13884:             }
                   13885:         } 
1.1317    raeburn  13886:         if (open(my $fh,'<',$container)) {
1.987     raeburn  13887:             $content = join('', <$fh>);
                   13888:             close($fh);
                   13889:         } else {
1.1071    raeburn  13890:             if (wantarray) {
                   13891:                 return ('',0,0);
                   13892:             } else {
                   13893:                 return;
                   13894:             }
1.987     raeburn  13895:         }
                   13896:     }
                   13897:     my ($count,$codebasecount) = (0,0);
                   13898:     my $mm = new File::MMagic;
                   13899:     my $mime_type = $mm->checktype_contents($content);
                   13900:     if ($mime_type eq 'text/html') {
                   13901:         my $parse_result = 
                   13902:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   13903:                                                     \%codebase,\$content);
                   13904:         if ($parse_result eq 'ok') {
                   13905:             foreach my $i (@changes) {
                   13906:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   13907:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   13908:                 if ($allfiles{$ref}) {
                   13909:                     my $newname =  $orig;
                   13910:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  13911:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  13912:                     if ($attrib_regexp =~ /:/) {
                   13913:                         $attrib_regexp =~ s/\:/|/g;
                   13914:                     }
                   13915:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   13916:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   13917:                         $count += $numchg;
1.1123    raeburn  13918:                         $allfiles{$newname} = $allfiles{$ref};
1.1148    raeburn  13919:                         delete($allfiles{$ref});
1.987     raeburn  13920:                     }
                   13921:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  13922:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  13923:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   13924:                         $codebasecount ++;
                   13925:                     }
                   13926:                 }
                   13927:             }
1.1123    raeburn  13928:             my $skiprewrites;
1.987     raeburn  13929:             if ($count || $codebasecount) {
                   13930:                 my $saveresult;
1.1071    raeburn  13931:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1123    raeburn  13932:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  13933:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   13934:                     if ($url eq $container) {
                   13935:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   13936:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   13937:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  13938:                                             $fname.'</span>').'</p>';
1.987     raeburn  13939:                     } else {
                   13940:                          $output = '<p class="LC_error">'.
                   13941:                                    &mt('Error: update failed for: [_1].',
                   13942:                                    '<span class="LC_filename">'.
                   13943:                                    $container.'</span>').'</p>';
                   13944:                     }
1.1123    raeburn  13945:                     if ($context eq 'syllabus') {
                   13946:                         unless ($saveresult eq 'ok') {
                   13947:                             $skiprewrites = 1;
                   13948:                         }
                   13949:                     }
1.987     raeburn  13950:                 } else {
1.1317    raeburn  13951:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  13952:                         print $fh $content;
                   13953:                         close($fh);
                   13954:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   13955:                                   $count,'<span class="LC_filename">'.
                   13956:                                   $container.'</span>').'</p>';
1.661     raeburn  13957:                     } else {
1.987     raeburn  13958:                          $output = '<p class="LC_error">'.
                   13959:                                    &mt('Error: could not update [_1].',
                   13960:                                    '<span class="LC_filename">'.
                   13961:                                    $container.'</span>').'</p>';
1.661     raeburn  13962:                     }
                   13963:                 }
                   13964:             }
1.1123    raeburn  13965:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   13966:                 my ($actionurl,$state);
                   13967:                 $actionurl = "/public/$udom/$uname/syllabus";
                   13968:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   13969:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   13970:                                               \%codebase,
                   13971:                                               {'context' => 'rewrites',
                   13972:                                                'ignore_remote_references' => 1,});
                   13973:                 if (ref($mapping) eq 'HASH') {
                   13974:                     my $rewrites = 0;
                   13975:                     foreach my $key (keys(%{$mapping})) {
                   13976:                         next if ($key =~ m{^https?://});
                   13977:                         my $ref = $mapping->{$key};
                   13978:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   13979:                         my $attrib;
                   13980:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   13981:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   13982:                         }
                   13983:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   13984:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   13985:                             $rewrites += $numchg;
                   13986:                         }
                   13987:                     }
                   13988:                     if ($rewrites) {
                   13989:                         my $saveresult; 
                   13990:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   13991:                         if ($url eq $container) {
                   13992:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   13993:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   13994:                                             $count,'<span class="LC_filename">'.
                   13995:                                             $fname.'</span>').'</p>';
                   13996:                         } else {
                   13997:                             $output .= '<p class="LC_error">'.
                   13998:                                        &mt('Error: could not update links in [_1].',
                   13999:                                        '<span class="LC_filename">'.
                   14000:                                        $container.'</span>').'</p>';
                   14001: 
                   14002:                         }
                   14003:                     }
                   14004:                 }
                   14005:             }
1.987     raeburn  14006:         } else {
                   14007:             &logthis('Failed to parse '.$container.
                   14008:                      ' to modify references: '.$parse_result);
1.661     raeburn  14009:         }
                   14010:     }
1.1071    raeburn  14011:     if (wantarray) {
                   14012:         return ($output,$count,$codebasecount);
                   14013:     } else {
                   14014:         return $output;
                   14015:     }
1.661     raeburn  14016: }
                   14017: 
                   14018: sub check_for_existing {
                   14019:     my ($path,$fname,$element) = @_;
                   14020:     my ($state,$msg);
                   14021:     if (-d $path.'/'.$fname) {
                   14022:         $state = 'exists';
                   14023:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   14024:     } elsif (-e $path.'/'.$fname) {
                   14025:         $state = 'exists';
                   14026:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   14027:     }
                   14028:     if ($state eq 'exists') {
                   14029:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   14030:     }
                   14031:     return ($state,$msg);
                   14032: }
                   14033: 
                   14034: sub check_for_upload {
                   14035:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   14036:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  14037:     my $filesize = length($env{'form.'.$element});
                   14038:     if (!$filesize) {
                   14039:         my $msg = '<span class="LC_error">'.
                   14040:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   14041:                       '<span class="LC_filename">'.$fname.'</span>',
                   14042:                       $filesize).'<br />'.
1.1007    raeburn  14043:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  14044:                   '</span>';
                   14045:         return ('zero_bytes',$msg);
                   14046:     }
                   14047:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  14048:     my $getpropath = 1;
1.1021    raeburn  14049:     my ($dirlistref,$listerror) =
                   14050:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  14051:     my $found_file = 0;
                   14052:     my $locked_file = 0;
1.991     raeburn  14053:     my @lockers;
                   14054:     my $navmap;
                   14055:     if ($env{'request.course.id'}) {
                   14056:         $navmap = Apache::lonnavmaps::navmap->new();
                   14057:     }
1.1021    raeburn  14058:     if (ref($dirlistref) eq 'ARRAY') {
                   14059:         foreach my $line (@{$dirlistref}) {
                   14060:             my ($file_name,$rest)=split(/\&/,$line,2);
                   14061:             if ($file_name eq $fname){
                   14062:                 $file_name = $path.$file_name;
                   14063:                 if ($group ne '') {
                   14064:                     $file_name = $group.$file_name;
                   14065:                 }
                   14066:                 $found_file = 1;
                   14067:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   14068:                     foreach my $lock (@lockers) {
                   14069:                         if (ref($lock) eq 'ARRAY') {
                   14070:                             my ($symb,$crsid) = @{$lock};
                   14071:                             if ($crsid eq $env{'request.course.id'}) {
                   14072:                                 if (ref($navmap)) {
                   14073:                                     my $res = $navmap->getBySymb($symb);
                   14074:                                     foreach my $part (@{$res->parts()}) { 
                   14075:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   14076:                                         unless (($slot_status == $res->RESERVED) ||
                   14077:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   14078:                                             $locked_file = 1;
                   14079:                                         }
1.991     raeburn  14080:                                     }
1.1021    raeburn  14081:                                 } else {
                   14082:                                     $locked_file = 1;
1.991     raeburn  14083:                                 }
                   14084:                             } else {
                   14085:                                 $locked_file = 1;
                   14086:                             }
                   14087:                         }
1.1021    raeburn  14088:                    }
                   14089:                 } else {
                   14090:                     my @info = split(/\&/,$rest);
                   14091:                     my $currsize = $info[6]/1000;
                   14092:                     if ($currsize < $filesize) {
                   14093:                         my $extra = $filesize - $currsize;
                   14094:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1179    bisitz   14095:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  14096:                                       &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   14097:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   14098:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   14099:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  14100:                             return ('will_exceed_quota',$msg);
                   14101:                         }
1.984     raeburn  14102:                     }
                   14103:                 }
1.661     raeburn  14104:             }
                   14105:         }
                   14106:     }
                   14107:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1179    bisitz   14108:         my $msg = '<p class="LC_warning">'.
                   14109:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184    raeburn  14110:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  14111:         return ('will_exceed_quota',$msg);
                   14112:     } elsif ($found_file) {
                   14113:         if ($locked_file) {
1.1179    bisitz   14114:             my $msg = '<p class="LC_warning">';
1.661     raeburn  14115:             $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   14116:             $msg .= '</p>';
1.661     raeburn  14117:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   14118:             return ('file_locked',$msg);
                   14119:         } else {
1.1179    bisitz   14120:             my $msg = '<p class="LC_error">';
1.984     raeburn  14121:             $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   14122:             $msg .= '</p>';
1.984     raeburn  14123:             return ('existingfile',$msg);
1.661     raeburn  14124:         }
                   14125:     }
                   14126: }
                   14127: 
1.987     raeburn  14128: sub check_for_traversal {
                   14129:     my ($path,$url,$toplevel) = @_;
                   14130:     my @parts=split(/\//,$path);
                   14131:     my $cleanpath;
                   14132:     my $fullpath = $url;
                   14133:     for (my $i=0;$i<@parts;$i++) {
                   14134:         next if ($parts[$i] eq '.');
                   14135:         if ($parts[$i] eq '..') {
                   14136:             $fullpath =~ s{([^/]+/)$}{};
                   14137:         } else {
                   14138:             $fullpath .= $parts[$i].'/';
                   14139:         }
                   14140:     }
                   14141:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   14142:         $cleanpath = $1;
                   14143:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   14144:         my $curr_toprel = $1;
                   14145:         my @parts = split(/\//,$curr_toprel);
                   14146:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   14147:         my @urlparts = split(/\//,$url_toprel);
                   14148:         my $doubledots;
                   14149:         my $startdiff = -1;
                   14150:         for (my $i=0; $i<@urlparts; $i++) {
                   14151:             if ($startdiff == -1) {
                   14152:                 unless ($urlparts[$i] eq $parts[$i]) {
                   14153:                     $startdiff = $i;
                   14154:                     $doubledots .= '../';
                   14155:                 }
                   14156:             } else {
                   14157:                 $doubledots .= '../';
                   14158:             }
                   14159:         }
                   14160:         if ($startdiff > -1) {
                   14161:             $cleanpath = $doubledots;
                   14162:             for (my $i=$startdiff; $i<@parts; $i++) {
                   14163:                 $cleanpath .= $parts[$i].'/';
                   14164:             }
                   14165:         }
                   14166:     }
                   14167:     $cleanpath =~ s{(/)$}{};
                   14168:     return $cleanpath;
                   14169: }
1.31      albertel 14170: 
1.1053    raeburn  14171: sub is_archive_file {
                   14172:     my ($mimetype) = @_;
                   14173:     if (($mimetype eq 'application/octet-stream') ||
                   14174:         ($mimetype eq 'application/x-stuffit') ||
                   14175:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   14176:         return 1;
                   14177:     }
                   14178:     return;
                   14179: }
                   14180: 
                   14181: sub decompress_form {
1.1065    raeburn  14182:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  14183:     my %lt = &Apache::lonlocal::texthash (
                   14184:         this => 'This file is an archive file.',
1.1067    raeburn  14185:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  14186:         itsc => 'Its contents are as follows:',
1.1053    raeburn  14187:         youm => 'You may wish to extract its contents.',
                   14188:         extr => 'Extract contents',
1.1067    raeburn  14189:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   14190:         proa => 'Process automatically?',
1.1053    raeburn  14191:         yes  => 'Yes',
                   14192:         no   => 'No',
1.1067    raeburn  14193:         fold => 'Title for folder containing movie',
                   14194:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  14195:     );
1.1065    raeburn  14196:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  14197:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  14198:     my $info = &list_archive_contents($fileloc,\@paths);
                   14199:     if (@paths) {
                   14200:         foreach my $path (@paths) {
                   14201:             $path =~ s{^/}{};
1.1067    raeburn  14202:             if ($path =~ m{^([^/]+)/$}) {
                   14203:                 $topdir = $1;
                   14204:             }
1.1065    raeburn  14205:             if ($path =~ m{^([^/]+)/}) {
                   14206:                 $toplevel{$1} = $path;
                   14207:             } else {
                   14208:                 $toplevel{$path} = $path;
                   14209:             }
                   14210:         }
                   14211:     }
1.1067    raeburn  14212:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164    raeburn  14213:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  14214:                         "$topdir/media/",
                   14215:                         "$topdir/media/$topdir.mp4",
                   14216:                         "$topdir/media/FirstFrame.png",
                   14217:                         "$topdir/media/player.swf",
                   14218:                         "$topdir/media/swfobject.js",
                   14219:                         "$topdir/media/expressInstall.swf");
1.1197    raeburn  14220:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164    raeburn  14221:                          "$topdir/$topdir.mp4",
                   14222:                          "$topdir/$topdir\_config.xml",
                   14223:                          "$topdir/$topdir\_controller.swf",
                   14224:                          "$topdir/$topdir\_embed.css",
                   14225:                          "$topdir/$topdir\_First_Frame.png",
                   14226:                          "$topdir/$topdir\_player.html",
                   14227:                          "$topdir/$topdir\_Thumbnails.png",
                   14228:                          "$topdir/playerProductInstall.swf",
                   14229:                          "$topdir/scripts/",
                   14230:                          "$topdir/scripts/config_xml.js",
                   14231:                          "$topdir/scripts/handlebars.js",
                   14232:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   14233:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   14234:                          "$topdir/scripts/modernizr.js",
                   14235:                          "$topdir/scripts/player-min.js",
                   14236:                          "$topdir/scripts/swfobject.js",
                   14237:                          "$topdir/skins/",
                   14238:                          "$topdir/skins/configuration_express.xml",
                   14239:                          "$topdir/skins/express_show/",
                   14240:                          "$topdir/skins/express_show/player-min.css",
                   14241:                          "$topdir/skins/express_show/spritesheet.png");
1.1197    raeburn  14242:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   14243:                          "$topdir/$topdir.mp4",
                   14244:                          "$topdir/$topdir\_config.xml",
                   14245:                          "$topdir/$topdir\_controller.swf",
                   14246:                          "$topdir/$topdir\_embed.css",
                   14247:                          "$topdir/$topdir\_First_Frame.png",
                   14248:                          "$topdir/$topdir\_player.html",
                   14249:                          "$topdir/$topdir\_Thumbnails.png",
                   14250:                          "$topdir/playerProductInstall.swf",
                   14251:                          "$topdir/scripts/",
                   14252:                          "$topdir/scripts/config_xml.js",
                   14253:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   14254:                          "$topdir/skins/",
                   14255:                          "$topdir/skins/configuration_express.xml",
                   14256:                          "$topdir/skins/express_show/",
                   14257:                          "$topdir/skins/express_show/spritesheet.min.css",
                   14258:                          "$topdir/skins/express_show/spritesheet.png",
                   14259:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164    raeburn  14260:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  14261:         if (@diffs == 0) {
1.1164    raeburn  14262:             $is_camtasia = 6;
                   14263:         } else {
1.1197    raeburn  14264:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164    raeburn  14265:             if (@diffs == 0) {
                   14266:                 $is_camtasia = 8;
1.1197    raeburn  14267:             } else {
                   14268:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   14269:                 if (@diffs == 0) {
                   14270:                     $is_camtasia = 8;
                   14271:                 }
1.1164    raeburn  14272:             }
1.1067    raeburn  14273:         }
                   14274:     }
                   14275:     my $output;
                   14276:     if ($is_camtasia) {
                   14277:         $output = <<"ENDCAM";
                   14278: <script type="text/javascript" language="Javascript">
                   14279: // <![CDATA[
                   14280: 
                   14281: function camtasiaToggle() {
                   14282:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   14283:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164    raeburn  14284:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  14285:                 document.getElementById('camtasia_titles').style.display='block';
                   14286:             } else {
                   14287:                 document.getElementById('camtasia_titles').style.display='none';
                   14288:             }
                   14289:         }
                   14290:     }
                   14291:     return;
                   14292: }
                   14293: 
                   14294: // ]]>
                   14295: </script>
                   14296: <p>$lt{'camt'}</p>
                   14297: ENDCAM
1.1065    raeburn  14298:     } else {
1.1067    raeburn  14299:         $output = '<p>'.$lt{'this'};
                   14300:         if ($info eq '') {
                   14301:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   14302:         } else {
                   14303:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   14304:                        '<div><pre>'.$info.'</pre></div>';
                   14305:         }
1.1065    raeburn  14306:     }
1.1067    raeburn  14307:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  14308:     my $duplicates;
                   14309:     my $num = 0;
                   14310:     if (ref($dirlist) eq 'ARRAY') {
                   14311:         foreach my $item (@{$dirlist}) {
                   14312:             if (ref($item) eq 'ARRAY') {
                   14313:                 if (exists($toplevel{$item->[0]})) {
                   14314:                     $duplicates .= 
                   14315:                         &start_data_table_row().
                   14316:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   14317:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   14318:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   14319:                         'value="1" />'.&mt('Yes').'</label>'.
                   14320:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   14321:                         '<td>'.$item->[0].'</td>';
                   14322:                     if ($item->[2]) {
                   14323:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   14324:                     } else {
                   14325:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   14326:                     }
                   14327:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   14328:                                    '<td>'.
                   14329:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   14330:                                    '</td>'.
                   14331:                                    &end_data_table_row();
                   14332:                     $num ++;
                   14333:                 }
                   14334:             }
                   14335:         }
                   14336:     }
                   14337:     my $itemcount;
                   14338:     if (@paths > 0) {
                   14339:         $itemcount = scalar(@paths);
                   14340:     } else {
                   14341:         $itemcount = 1;
                   14342:     }
1.1067    raeburn  14343:     if ($is_camtasia) {
                   14344:         $output .= $lt{'auto'}.'<br />'.
                   14345:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164    raeburn  14346:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  14347:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   14348:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   14349:                    $lt{'no'}.'</label></span><br />'.
                   14350:                    '<div id="camtasia_titles" style="display:block">'.
                   14351:                    &Apache::lonhtmlcommon::start_pick_box().
                   14352:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   14353:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   14354:                    &Apache::lonhtmlcommon::row_closure().
                   14355:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   14356:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   14357:                    &Apache::lonhtmlcommon::row_closure(1).
                   14358:                    &Apache::lonhtmlcommon::end_pick_box().
                   14359:                    '</div>';
                   14360:     }
1.1065    raeburn  14361:     $output .= 
                   14362:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  14363:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   14364:         "\n";
1.1065    raeburn  14365:     if ($duplicates ne '') {
                   14366:         $output .= '<p><span class="LC_warning">'.
                   14367:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   14368:                    &start_data_table().
                   14369:                    &start_data_table_header_row().
                   14370:                    '<th>'.&mt('Overwrite?').'</th>'.
                   14371:                    '<th>'.&mt('Name').'</th>'.
                   14372:                    '<th>'.&mt('Type').'</th>'.
                   14373:                    '<th>'.&mt('Size').'</th>'.
                   14374:                    '<th>'.&mt('Last modified').'</th>'.
                   14375:                    &end_data_table_header_row().
                   14376:                    $duplicates.
                   14377:                    &end_data_table().
                   14378:                    '</p>';
                   14379:     }
1.1067    raeburn  14380:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  14381:     if (ref($hiddenelements) eq 'HASH') {
                   14382:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   14383:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   14384:         }
                   14385:     }
                   14386:     $output .= <<"END";
1.1067    raeburn  14387: <br />
1.1053    raeburn  14388: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   14389: </form>
                   14390: $noextract
                   14391: END
                   14392:     return $output;
                   14393: }
                   14394: 
1.1065    raeburn  14395: sub decompression_utility {
                   14396:     my ($program) = @_;
                   14397:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   14398:     my $location;
                   14399:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   14400:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   14401:                          '/usr/sbin/') {
                   14402:             if (-x $dir.$program) {
                   14403:                 $location = $dir.$program;
                   14404:                 last;
                   14405:             }
                   14406:         }
                   14407:     }
                   14408:     return $location;
                   14409: }
                   14410: 
                   14411: sub list_archive_contents {
                   14412:     my ($file,$pathsref) = @_;
                   14413:     my (@cmd,$output);
                   14414:     my $needsregexp;
                   14415:     if ($file =~ /\.zip$/) {
                   14416:         @cmd = (&decompression_utility('unzip'),"-l");
                   14417:         $needsregexp = 1;
                   14418:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   14419:              ($file =~ /\.tgz$/)) {
                   14420:         @cmd = (&decompression_utility('tar'),"-ztf");
                   14421:     } elsif ($file =~ /\.tar\.bz2$/) {
                   14422:         @cmd = (&decompression_utility('tar'),"-jtf");
                   14423:     } elsif ($file =~ m|\.tar$|) {
                   14424:         @cmd = (&decompression_utility('tar'),"-tf");
                   14425:     }
                   14426:     if (@cmd) {
                   14427:         undef($!);
                   14428:         undef($@);
                   14429:         if (open(my $fh,"-|", @cmd, $file)) {
                   14430:             while (my $line = <$fh>) {
                   14431:                 $output .= $line;
                   14432:                 chomp($line);
                   14433:                 my $item;
                   14434:                 if ($needsregexp) {
                   14435:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   14436:                 } else {
                   14437:                     $item = $line;
                   14438:                 }
                   14439:                 if ($item ne '') {
                   14440:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   14441:                         push(@{$pathsref},$item);
                   14442:                     } 
                   14443:                 }
                   14444:             }
                   14445:             close($fh);
                   14446:         }
                   14447:     }
                   14448:     return $output;
                   14449: }
                   14450: 
1.1053    raeburn  14451: sub decompress_uploaded_file {
                   14452:     my ($file,$dir) = @_;
                   14453:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   14454:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   14455:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   14456:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   14457:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   14458:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   14459:     my $decompressed = $env{'cgi.decompressed'};
                   14460:     &Apache::lonnet::delenv('cgi.file');
                   14461:     &Apache::lonnet::delenv('cgi.dir');
                   14462:     &Apache::lonnet::delenv('cgi.decompressed');
                   14463:     return ($decompressed,$result);
                   14464: }
                   14465: 
1.1055    raeburn  14466: sub process_decompression {
                   14467:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292    raeburn  14468:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   14469:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14470:                &mt('Unexpected file path.').'</p>'."\n";
                   14471:     }
                   14472:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   14473:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14474:                &mt('Unexpected course context.').'</p>'."\n";
                   14475:     }
1.1293    raeburn  14476:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292    raeburn  14477:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14478:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   14479:     }
1.1055    raeburn  14480:     my ($dir,$error,$warning,$output);
1.1180    raeburn  14481:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120    bisitz   14482:         $error = &mt('Filename not a supported archive file type.').
                   14483:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  14484:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   14485:     } else {
                   14486:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   14487:         if ($docuhome eq 'no_host') {
                   14488:             $error = &mt('Could not determine home server for course.');
                   14489:         } else {
                   14490:             my @ids=&Apache::lonnet::current_machine_ids();
                   14491:             my $currdir = "$dir_root/$destination";
                   14492:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   14493:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   14494:                        "$dir_root/$destination";
                   14495:             } else {
                   14496:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   14497:                        "$dir_root/$docudom/$docuname/$destination";
                   14498:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   14499:                     $error = &mt('Archive file not found.');
                   14500:                 }
                   14501:             }
1.1065    raeburn  14502:             my (@to_overwrite,@to_skip);
                   14503:             if ($env{'form.archive_overwrite_total'} > 0) {
                   14504:                 my $total = $env{'form.archive_overwrite_total'};
                   14505:                 for (my $i=0; $i<$total; $i++) {
                   14506:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   14507:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   14508:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   14509:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   14510:                     }
                   14511:                 }
                   14512:             }
                   14513:             my $numskip = scalar(@to_skip);
1.1292    raeburn  14514:             my $numoverwrite = scalar(@to_overwrite);
                   14515:             if (($numskip) && (!$numoverwrite)) { 
1.1065    raeburn  14516:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   14517:             } elsif ($dir eq '') {
1.1055    raeburn  14518:                 $error = &mt('Directory containing archive file unavailable.');
                   14519:             } elsif (!$error) {
1.1065    raeburn  14520:                 my ($decompressed,$display);
1.1292    raeburn  14521:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  14522:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   14523:                     mkdir("$dir/$tempdir",0755);
1.1292    raeburn  14524:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   14525:                         ($decompressed,$display) = 
                   14526:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   14527:                         foreach my $item (@to_skip) {
                   14528:                             if (($item ne '') && ($item !~ /\.\./)) {
                   14529:                                 if (-f "$dir/$tempdir/$item") { 
                   14530:                                     unlink("$dir/$tempdir/$item");
                   14531:                                 } elsif (-d "$dir/$tempdir/$item") {
1.1300    raeburn  14532:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292    raeburn  14533:                                 }
                   14534:                             }
                   14535:                         }
                   14536:                         foreach my $item (@to_overwrite) {
                   14537:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   14538:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   14539:                                     if (-f "$dir/$item") {
                   14540:                                         unlink("$dir/$item");
                   14541:                                     } elsif (-d "$dir/$item") {
1.1300    raeburn  14542:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292    raeburn  14543:                                     }
                   14544:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   14545:                                 }
1.1065    raeburn  14546:                             }
                   14547:                         }
1.1292    raeburn  14548:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300    raeburn  14549:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292    raeburn  14550:                         }
1.1065    raeburn  14551:                     }
                   14552:                 } else {
                   14553:                     ($decompressed,$display) = 
                   14554:                         &decompress_uploaded_file($file,$dir);
                   14555:                 }
1.1055    raeburn  14556:                 if ($decompressed eq 'ok') {
1.1065    raeburn  14557:                     $output = '<p class="LC_info">'.
                   14558:                               &mt('Files extracted successfully from archive.').
                   14559:                               '</p>'."\n";
1.1055    raeburn  14560:                     my ($warning,$result,@contents);
                   14561:                     my ($newdirlistref,$newlisterror) =
                   14562:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   14563:                                                  $docuname,1);
                   14564:                     my (%is_dir,%changes,@newitems);
                   14565:                     my $dirptr = 16384;
1.1065    raeburn  14566:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  14567:                         foreach my $dir_line (@{$newdirlistref}) {
                   14568:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292    raeburn  14569:                             unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055    raeburn  14570:                                 push(@newitems,$item);
                   14571:                                 if ($dirptr&$testdir) {
                   14572:                                     $is_dir{$item} = 1;
                   14573:                                 }
                   14574:                                 $changes{$item} = 1;
                   14575:                             }
                   14576:                         }
                   14577:                     }
                   14578:                     if (keys(%changes) > 0) {
                   14579:                         foreach my $item (sort(@newitems)) {
                   14580:                             if ($changes{$item}) {
                   14581:                                 push(@contents,$item);
                   14582:                             }
                   14583:                         }
                   14584:                     }
                   14585:                     if (@contents > 0) {
1.1067    raeburn  14586:                         my $wantform;
                   14587:                         unless ($env{'form.autoextract_camtasia'}) {
                   14588:                             $wantform = 1;
                   14589:                         }
1.1056    raeburn  14590:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  14591:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   14592:                                                                 $currdir,\%is_dir,
                   14593:                                                                 \%children,\%parent,
1.1056    raeburn  14594:                                                                 \@contents,\%dirorder,
                   14595:                                                                 \%titles,$wantform);
1.1055    raeburn  14596:                         if ($datatable ne '') {
                   14597:                             $output .= &archive_options_form('decompressed',$datatable,
                   14598:                                                              $count,$hiddenelem);
1.1065    raeburn  14599:                             my $startcount = 6;
1.1055    raeburn  14600:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  14601:                                                            \%titles,\%children);
1.1055    raeburn  14602:                         }
1.1067    raeburn  14603:                         if ($env{'form.autoextract_camtasia'}) {
1.1164    raeburn  14604:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  14605:                             my %displayed;
                   14606:                             my $total = 1;
                   14607:                             $env{'form.archive_directory'} = [];
                   14608:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   14609:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   14610:                                 $path =~ s{/$}{};
                   14611:                                 my $item;
                   14612:                                 if ($path ne '') {
                   14613:                                     $item = "$path/$titles{$i}";
                   14614:                                 } else {
                   14615:                                     $item = $titles{$i};
                   14616:                                 }
                   14617:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   14618:                                 if ($item eq $contents[0]) {
                   14619:                                     push(@{$env{'form.archive_directory'}},$i);
                   14620:                                     $env{'form.archive_'.$i} = 'display';
                   14621:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   14622:                                     $displayed{'folder'} = $i;
1.1164    raeburn  14623:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   14624:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) { 
1.1067    raeburn  14625:                                     $env{'form.archive_'.$i} = 'display';
                   14626:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   14627:                                     $displayed{'web'} = $i;
                   14628:                                 } else {
1.1164    raeburn  14629:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   14630:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   14631:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  14632:                                         push(@{$env{'form.archive_directory'}},$i);
                   14633:                                     }
                   14634:                                     $env{'form.archive_'.$i} = 'dependency';
                   14635:                                 }
                   14636:                                 $total ++;
                   14637:                             }
                   14638:                             for (my $i=1; $i<$total; $i++) {
                   14639:                                 next if ($i == $displayed{'web'});
                   14640:                                 next if ($i == $displayed{'folder'});
                   14641:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   14642:                             }
                   14643:                             $env{'form.phase'} = 'decompress_cleanup';
                   14644:                             $env{'form.archivedelete'} = 1;
                   14645:                             $env{'form.archive_count'} = $total-1;
                   14646:                             $output .=
                   14647:                                 &process_extracted_files('coursedocs',$docudom,
                   14648:                                                          $docuname,$destination,
                   14649:                                                          $dir_root,$hiddenelem);
                   14650:                         }
1.1055    raeburn  14651:                     } else {
                   14652:                         $warning = &mt('No new items extracted from archive file.');
                   14653:                     }
                   14654:                 } else {
                   14655:                     $output = $display;
                   14656:                     $error = &mt('An error occurred during extraction from the archive file.');
                   14657:                 }
                   14658:             }
                   14659:         }
                   14660:     }
                   14661:     if ($error) {
                   14662:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14663:                    $error.'</p>'."\n";
                   14664:     }
                   14665:     if ($warning) {
                   14666:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   14667:     }
                   14668:     return $output;
                   14669: }
                   14670: 
                   14671: sub get_extracted {
1.1056    raeburn  14672:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   14673:         $titles,$wantform) = @_;
1.1055    raeburn  14674:     my $count = 0;
                   14675:     my $depth = 0;
                   14676:     my $datatable;
1.1056    raeburn  14677:     my @hierarchy;
1.1055    raeburn  14678:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  14679:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   14680:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  14681:     foreach my $item (@{$contents}) {
                   14682:         $count ++;
1.1056    raeburn  14683:         @{$dirorder->{$count}} = @hierarchy;
                   14684:         $titles->{$count} = $item;
1.1055    raeburn  14685:         &archive_hierarchy($depth,$count,$parent,$children);
                   14686:         if ($wantform) {
                   14687:             $datatable .= &archive_row($is_dir->{$item},$item,
                   14688:                                        $currdir,$depth,$count);
                   14689:         }
                   14690:         if ($is_dir->{$item}) {
                   14691:             $depth ++;
1.1056    raeburn  14692:             push(@hierarchy,$count);
                   14693:             $parent->{$depth} = $count;
1.1055    raeburn  14694:             $datatable .=
                   14695:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  14696:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   14697:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  14698:             $depth --;
1.1056    raeburn  14699:             pop(@hierarchy);
1.1055    raeburn  14700:         }
                   14701:     }
                   14702:     return ($count,$datatable);
                   14703: }
                   14704: 
                   14705: sub recurse_extracted_archive {
1.1056    raeburn  14706:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   14707:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  14708:     my $result='';
1.1056    raeburn  14709:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   14710:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   14711:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  14712:         return $result;
                   14713:     }
                   14714:     my $dirptr = 16384;
                   14715:     my ($newdirlistref,$newlisterror) =
                   14716:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   14717:     if (ref($newdirlistref) eq 'ARRAY') {
                   14718:         foreach my $dir_line (@{$newdirlistref}) {
                   14719:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   14720:             unless ($item =~ /^\.+$/) {
                   14721:                 $$count ++;
1.1056    raeburn  14722:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   14723:                 $titles->{$$count} = $item;
1.1055    raeburn  14724:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  14725: 
1.1055    raeburn  14726:                 my $is_dir;
                   14727:                 if ($dirptr&$testdir) {
                   14728:                     $is_dir = 1;
                   14729:                 }
                   14730:                 if ($wantform) {
                   14731:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   14732:                 }
                   14733:                 if ($is_dir) {
                   14734:                     $$depth ++;
1.1056    raeburn  14735:                     push(@{$hierarchy},$$count);
                   14736:                     $parent->{$$depth} = $$count;
1.1055    raeburn  14737:                     $result .=
                   14738:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   14739:                                                    $docuname,$depth,$count,
1.1056    raeburn  14740:                                                    $hierarchy,$dirorder,$children,
                   14741:                                                    $parent,$titles,$wantform);
1.1055    raeburn  14742:                     $$depth --;
1.1056    raeburn  14743:                     pop(@{$hierarchy});
1.1055    raeburn  14744:                 }
                   14745:             }
                   14746:         }
                   14747:     }
                   14748:     return $result;
                   14749: }
                   14750: 
                   14751: sub archive_hierarchy {
                   14752:     my ($depth,$count,$parent,$children) =@_;
                   14753:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   14754:         if (exists($parent->{$depth})) {
                   14755:              $children->{$parent->{$depth}} .= $count.':';
                   14756:         }
                   14757:     }
                   14758:     return;
                   14759: }
                   14760: 
                   14761: sub archive_row {
                   14762:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   14763:     my ($name) = ($item =~ m{([^/]+)$});
                   14764:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  14765:                                        'display'    => 'Add as file',
1.1055    raeburn  14766:                                        'dependency' => 'Include as dependency',
                   14767:                                        'discard'    => 'Discard',
                   14768:                                       );
                   14769:     if ($is_dir) {
1.1059    raeburn  14770:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  14771:     }
1.1056    raeburn  14772:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   14773:     my $offset = 0;
1.1055    raeburn  14774:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  14775:         $offset ++;
1.1065    raeburn  14776:         if ($action ne 'display') {
                   14777:             $offset ++;
                   14778:         }  
1.1055    raeburn  14779:         $output .= '<td><span class="LC_nobreak">'.
                   14780:                    '<label><input type="radio" name="archive_'.$count.
                   14781:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   14782:         my $text = $choices{$action};
                   14783:         if ($is_dir) {
                   14784:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   14785:             if ($action eq 'display') {
1.1059    raeburn  14786:                 $text = &mt('Add as folder');
1.1055    raeburn  14787:             }
1.1056    raeburn  14788:         } else {
                   14789:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   14790: 
                   14791:         }
                   14792:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   14793:         if ($action eq 'dependency') {
                   14794:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   14795:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   14796:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   14797:                        '<option value=""></option>'."\n".
                   14798:                        '</select>'."\n".
                   14799:                        '</div>';
1.1059    raeburn  14800:         } elsif ($action eq 'display') {
                   14801:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   14802:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   14803:                        '</div>';
1.1055    raeburn  14804:         }
1.1056    raeburn  14805:         $output .= '</td>';
1.1055    raeburn  14806:     }
                   14807:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   14808:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   14809:     for (my $i=0; $i<$depth; $i++) {
                   14810:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   14811:     }
                   14812:     if ($is_dir) {
                   14813:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   14814:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   14815:     } else {
                   14816:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   14817:     }
                   14818:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   14819:                &end_data_table_row();
                   14820:     return $output;
                   14821: }
                   14822: 
                   14823: sub archive_options_form {
1.1065    raeburn  14824:     my ($form,$display,$count,$hiddenelem) = @_;
                   14825:     my %lt = &Apache::lonlocal::texthash(
                   14826:                perm => 'Permanently remove archive file?',
                   14827:                hows => 'How should each extracted item be incorporated in the course?',
                   14828:                cont => 'Content actions for all',
                   14829:                addf => 'Add as folder/file',
                   14830:                incd => 'Include as dependency for a displayed file',
                   14831:                disc => 'Discard',
                   14832:                no   => 'No',
                   14833:                yes  => 'Yes',
                   14834:                save => 'Save',
                   14835:     );
                   14836:     my $output = <<"END";
                   14837: <form name="$form" method="post" action="">
                   14838: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   14839: <label>
                   14840:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   14841: </label>
                   14842: &nbsp;
                   14843: <label>
                   14844:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   14845: </span>
                   14846: </p>
                   14847: <input type="hidden" name="phase" value="decompress_cleanup" />
                   14848: <br />$lt{'hows'}
                   14849: <div class="LC_columnSection">
                   14850:   <fieldset>
                   14851:     <legend>$lt{'cont'}</legend>
                   14852:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   14853:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   14854:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   14855:   </fieldset>
                   14856: </div>
                   14857: END
                   14858:     return $output.
1.1055    raeburn  14859:            &start_data_table()."\n".
1.1065    raeburn  14860:            $display."\n".
1.1055    raeburn  14861:            &end_data_table()."\n".
                   14862:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   14863:            $hiddenelem.
1.1065    raeburn  14864:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  14865:            '</form>';
                   14866: }
                   14867: 
                   14868: sub archive_javascript {
1.1056    raeburn  14869:     my ($startcount,$numitems,$titles,$children) = @_;
                   14870:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  14871:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  14872:     my $scripttag = <<START;
                   14873: <script type="text/javascript">
                   14874: // <![CDATA[
                   14875: 
                   14876: function checkAll(form,prefix) {
                   14877:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   14878:     for (var i=0; i < form.elements.length; i++) {
                   14879:         var id = form.elements[i].id;
                   14880:         if ((id != '') && (id != undefined)) {
                   14881:             if (idstr.test(id)) {
                   14882:                 if (form.elements[i].type == 'radio') {
                   14883:                     form.elements[i].checked = true;
1.1056    raeburn  14884:                     var nostart = i-$startcount;
1.1059    raeburn  14885:                     var offset = nostart%7;
                   14886:                     var count = (nostart-offset)/7;    
1.1056    raeburn  14887:                     dependencyCheck(form,count,offset);
1.1055    raeburn  14888:                 }
                   14889:             }
                   14890:         }
                   14891:     }
                   14892: }
                   14893: 
                   14894: function propagateCheck(form,count) {
                   14895:     if (count > 0) {
1.1059    raeburn  14896:         var startelement = $startcount + ((count-1) * 7);
                   14897:         for (var j=1; j<6; j++) {
                   14898:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  14899:                 var item = startelement + j; 
                   14900:                 if (form.elements[item].type == 'radio') {
                   14901:                     if (form.elements[item].checked) {
                   14902:                         containerCheck(form,count,j);
                   14903:                         break;
                   14904:                     }
1.1055    raeburn  14905:                 }
                   14906:             }
                   14907:         }
                   14908:     }
                   14909: }
                   14910: 
                   14911: numitems = $numitems
1.1056    raeburn  14912: var titles = new Array(numitems);
                   14913: var parents = new Array(numitems);
1.1055    raeburn  14914: for (var i=0; i<numitems; i++) {
1.1056    raeburn  14915:     parents[i] = new Array;
1.1055    raeburn  14916: }
1.1059    raeburn  14917: var maintitle = '$maintitle';
1.1055    raeburn  14918: 
                   14919: START
                   14920: 
1.1056    raeburn  14921:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   14922:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  14923:         for (my $i=0; $i<@contents; $i ++) {
                   14924:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   14925:         }
                   14926:     }
                   14927: 
1.1056    raeburn  14928:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   14929:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   14930:     }
                   14931: 
1.1055    raeburn  14932:     $scripttag .= <<END;
                   14933: 
                   14934: function containerCheck(form,count,offset) {
                   14935:     if (count > 0) {
1.1056    raeburn  14936:         dependencyCheck(form,count,offset);
1.1059    raeburn  14937:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  14938:         form.elements[item].checked = true;
                   14939:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   14940:             if (parents[count].length > 0) {
                   14941:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  14942:                     containerCheck(form,parents[count][j],offset);
                   14943:                 }
                   14944:             }
                   14945:         }
                   14946:     }
                   14947: }
                   14948: 
                   14949: function dependencyCheck(form,count,offset) {
                   14950:     if (count > 0) {
1.1059    raeburn  14951:         var chosen = (offset+$startcount)+7*(count-1);
                   14952:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  14953:         var currtype = form.elements[depitem].type;
                   14954:         if (form.elements[chosen].value == 'dependency') {
                   14955:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   14956:             form.elements[depitem].options.length = 0;
                   14957:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085    raeburn  14958:             for (var i=1; i<=numitems; i++) {
                   14959:                 if (i == count) {
                   14960:                     continue;
                   14961:                 }
1.1059    raeburn  14962:                 var startelement = $startcount + (i-1) * 7;
                   14963:                 for (var j=1; j<6; j++) {
                   14964:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  14965:                         var item = startelement + j;
                   14966:                         if (form.elements[item].type == 'radio') {
                   14967:                             if (form.elements[item].checked) {
                   14968:                                 if (form.elements[item].value == 'display') {
                   14969:                                     var n = form.elements[depitem].options.length;
                   14970:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   14971:                                 }
                   14972:                             }
                   14973:                         }
                   14974:                     }
                   14975:                 }
                   14976:             }
                   14977:         } else {
                   14978:             document.getElementById('arc_depon_'+count).style.display='none';
                   14979:             form.elements[depitem].options.length = 0;
                   14980:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   14981:         }
1.1059    raeburn  14982:         titleCheck(form,count,offset);
1.1056    raeburn  14983:     }
                   14984: }
                   14985: 
                   14986: function propagateSelect(form,count,offset) {
                   14987:     if (count > 0) {
1.1065    raeburn  14988:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  14989:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   14990:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   14991:             if (parents[count].length > 0) {
                   14992:                 for (var j=0; j<parents[count].length; j++) {
                   14993:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  14994:                 }
                   14995:             }
                   14996:         }
                   14997:     }
                   14998: }
1.1056    raeburn  14999: 
                   15000: function containerSelect(form,count,offset,picked) {
                   15001:     if (count > 0) {
1.1065    raeburn  15002:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  15003:         if (form.elements[item].type == 'radio') {
                   15004:             if (form.elements[item].value == 'dependency') {
                   15005:                 if (form.elements[item+1].type == 'select-one') {
                   15006:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   15007:                         if (form.elements[item+1].options[i].value == picked) {
                   15008:                             form.elements[item+1].selectedIndex = i;
                   15009:                             break;
                   15010:                         }
                   15011:                     }
                   15012:                 }
                   15013:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   15014:                     if (parents[count].length > 0) {
                   15015:                         for (var j=0; j<parents[count].length; j++) {
                   15016:                             containerSelect(form,parents[count][j],offset,picked);
                   15017:                         }
                   15018:                     }
                   15019:                 }
                   15020:             }
                   15021:         }
                   15022:     }
                   15023: }
                   15024: 
1.1059    raeburn  15025: function titleCheck(form,count,offset) {
                   15026:     if (count > 0) {
                   15027:         var chosen = (offset+$startcount)+7*(count-1);
                   15028:         var depitem = $startcount + ((count-1) * 7) + 2;
                   15029:         var currtype = form.elements[depitem].type;
                   15030:         if (form.elements[chosen].value == 'display') {
                   15031:             document.getElementById('arc_title_'+count).style.display='block';
                   15032:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   15033:                 document.getElementById('archive_title_'+count).value=maintitle;
                   15034:             }
                   15035:         } else {
                   15036:             document.getElementById('arc_title_'+count).style.display='none';
                   15037:             if (currtype == 'text') { 
                   15038:                 document.getElementById('archive_title_'+count).value='';
                   15039:             }
                   15040:         }
                   15041:     }
                   15042:     return;
                   15043: }
                   15044: 
1.1055    raeburn  15045: // ]]>
                   15046: </script>
                   15047: END
                   15048:     return $scripttag;
                   15049: }
                   15050: 
                   15051: sub process_extracted_files {
1.1067    raeburn  15052:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  15053:     my $numitems = $env{'form.archive_count'};
1.1294    raeburn  15054:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  15055:     my @ids=&Apache::lonnet::current_machine_ids();
                   15056:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  15057:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  15058:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   15059:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   15060:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   15061:         $pathtocheck = "$dir_root/$destination";
                   15062:         $dir = $dir_root;
                   15063:         $ishome = 1;
                   15064:     } else {
                   15065:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   15066:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294    raeburn  15067:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  15068:     }
                   15069:     my $currdir = "$dir_root/$destination";
                   15070:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   15071:     if ($env{'form.folderpath'}) {
                   15072:         my @items = split('&',$env{'form.folderpath'});
                   15073:         $folders{'0'} = $items[-2];
1.1099    raeburn  15074:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   15075:             $containers{'0'}='page';
                   15076:         } else {  
                   15077:             $containers{'0'}='sequence';
                   15078:         }
1.1055    raeburn  15079:     }
                   15080:     my @archdirs = &get_env_multiple('form.archive_directory');
                   15081:     if ($numitems) {
                   15082:         for (my $i=1; $i<=$numitems; $i++) {
                   15083:             my $path = $env{'form.archive_content_'.$i};
                   15084:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   15085:                 my $item = $1;
                   15086:                 $toplevelitems{$item} = $i;
                   15087:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   15088:                     $is_dir{$item} = 1;
                   15089:                 }
                   15090:             }
                   15091:         }
                   15092:     }
1.1067    raeburn  15093:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  15094:     if (keys(%toplevelitems) > 0) {
                   15095:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  15096:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   15097:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  15098:     }
1.1066    raeburn  15099:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  15100:     if ($numitems) {
                   15101:         for (my $i=1; $i<=$numitems; $i++) {
1.1086    raeburn  15102:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  15103:             my $path = $env{'form.archive_content_'.$i};
                   15104:             if ($path =~ /^\Q$pathtocheck\E/) {
                   15105:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   15106:                     if ($prefix ne '' && $path ne '') {
                   15107:                         if (-e $prefix.$path) {
1.1066    raeburn  15108:                             if ((@archdirs > 0) && 
                   15109:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   15110:                                 $todeletedir{$prefix.$path} = 1;
                   15111:                             } else {
                   15112:                                 $todelete{$prefix.$path} = 1;
                   15113:                             }
1.1055    raeburn  15114:                         }
                   15115:                     }
                   15116:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  15117:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  15118:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  15119:                     $docstitle = $env{'form.archive_title_'.$i};
                   15120:                     if ($docstitle eq '') {
                   15121:                         $docstitle = $title;
                   15122:                     }
1.1055    raeburn  15123:                     $outer = 0;
1.1056    raeburn  15124:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   15125:                         if (@{$dirorder{$i}} > 0) {
                   15126:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  15127:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   15128:                                     $outer = $item;
                   15129:                                     last;
                   15130:                                 }
                   15131:                             }
                   15132:                         }
                   15133:                     }
                   15134:                     my ($errtext,$fatal) = 
                   15135:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   15136:                                                '/'.$folders{$outer}.'.'.
                   15137:                                                $containers{$outer});
                   15138:                     next if ($fatal);
                   15139:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   15140:                         if ($context eq 'coursedocs') {
1.1056    raeburn  15141:                             $mapinner{$i} = time;
1.1055    raeburn  15142:                             $folders{$i} = 'default_'.$mapinner{$i};
                   15143:                             $containers{$i} = 'sequence';
                   15144:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   15145:                                       $folders{$i}.'.'.$containers{$i};
                   15146:                             my $newidx = &LONCAPA::map::getresidx();
                   15147:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  15148:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  15149:                             push(@LONCAPA::map::order,$newidx);
                   15150:                             my ($outtext,$errtext) =
                   15151:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   15152:                                                         $docuname.'/'.$folders{$outer}.
1.1087    raeburn  15153:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  15154:                             $newseqid{$i} = $newidx;
1.1067    raeburn  15155:                             unless ($errtext) {
1.1294    raeburn  15156:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   15157:                                                        &HTML::Entities::encode($docstitle,'<>&"')).
                   15158:                                             '</li>'."\n";
1.1067    raeburn  15159:                             }
1.1055    raeburn  15160:                         }
                   15161:                     } else {
                   15162:                         if ($context eq 'coursedocs') {
                   15163:                             my $newidx=&LONCAPA::map::getresidx();
                   15164:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   15165:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   15166:                                       $title;
1.1392    raeburn  15167:                             if (($outer !~ /\D/) &&
                   15168:                                 (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
                   15169:                                 ($newidx !~ /\D/)) {
1.1294    raeburn  15170:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   15171:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
                   15172:                                 }
                   15173:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   15174:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   15175:                                 }
                   15176:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   15177:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   15178:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   15179:                                         unless ($ishome) {
                   15180:                                             my $fetch = "$newdest{$i}/$title";
                   15181:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   15182:                                             $prompttofetch{$fetch} = 1;
                   15183:                                         }
1.1292    raeburn  15184:                                     }
1.1067    raeburn  15185:                                 }
1.1294    raeburn  15186:                                 $LONCAPA::map::resources[$newidx]=
                   15187:                                     $docstitle.':'.$url.':false:normal:res';
                   15188:                                 push(@LONCAPA::map::order, $newidx);
                   15189:                                 my ($outtext,$errtext)=
                   15190:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   15191:                                                             $docuname.'/'.$folders{$outer}.
                   15192:                                                             '.'.$containers{$outer},1,1);
                   15193:                                 unless ($errtext) {
                   15194:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   15195:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   15196:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   15197:                                                    '</li>'."\n";
                   15198:                                     }
1.1067    raeburn  15199:                                 }
1.1294    raeburn  15200:                             } else {
                   15201:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   15202:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296    raeburn  15203:                             }
1.1055    raeburn  15204:                         }
                   15205:                     }
1.1086    raeburn  15206:                 }
                   15207:             } else {
1.1294    raeburn  15208:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   15209:                                 &HTML::Entities::encode($path,'<>&"')).'<br />'; 
1.1086    raeburn  15210:             }
                   15211:         }
                   15212:         for (my $i=1; $i<=$numitems; $i++) {
                   15213:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   15214:             my $path = $env{'form.archive_content_'.$i};
                   15215:             if ($path =~ /^\Q$pathtocheck\E/) {
                   15216:                 my ($title) = ($path =~ m{/([^/]+)$});
                   15217:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   15218:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   15219:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   15220:                         my ($itemidx,$fullpath,$relpath);
                   15221:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   15222:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  15223:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086    raeburn  15224:                                 if ($dirorder{$i}->[$j] eq $container) {
                   15225:                                     $itemidx = $j;
1.1056    raeburn  15226:                                 }
                   15227:                             }
1.1086    raeburn  15228:                         }
                   15229:                         if ($itemidx eq '') {
                   15230:                             $itemidx =  0;
                   15231:                         } 
                   15232:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   15233:                             if ($mapinner{$referrer{$i}}) {
                   15234:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   15235:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   15236:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   15237:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   15238:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   15239:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   15240:                                             if (!-e $fullpath) {
                   15241:                                                 mkdir($fullpath,0755);
1.1056    raeburn  15242:                                             }
                   15243:                                         }
1.1086    raeburn  15244:                                     } else {
                   15245:                                         last;
1.1056    raeburn  15246:                                     }
1.1086    raeburn  15247:                                 }
                   15248:                             }
                   15249:                         } elsif ($newdest{$referrer{$i}}) {
                   15250:                             $fullpath = $newdest{$referrer{$i}};
                   15251:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   15252:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   15253:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   15254:                                     last;
                   15255:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   15256:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   15257:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   15258:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   15259:                                         if (!-e $fullpath) {
                   15260:                                             mkdir($fullpath,0755);
1.1056    raeburn  15261:                                         }
                   15262:                                     }
1.1086    raeburn  15263:                                 } else {
                   15264:                                     last;
1.1056    raeburn  15265:                                 }
1.1055    raeburn  15266:                             }
                   15267:                         }
1.1086    raeburn  15268:                         if ($fullpath ne '') {
                   15269:                             if (-e "$prefix$path") {
1.1292    raeburn  15270:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   15271:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   15272:                                 }
1.1086    raeburn  15273:                             }
                   15274:                             if (-e "$fullpath/$title") {
                   15275:                                 my $showpath;
                   15276:                                 if ($relpath ne '') {
                   15277:                                     $showpath = "$relpath/$title";
                   15278:                                 } else {
                   15279:                                     $showpath = "/$title";
                   15280:                                 } 
1.1294    raeburn  15281:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   15282:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   15283:                                            '</li>'."\n";
1.1292    raeburn  15284:                                 unless ($ishome) {
                   15285:                                     my $fetch = "$fullpath/$title";
                   15286:                                     $fetch =~ s/^\Q$prefix$dir\E//; 
                   15287:                                     $prompttofetch{$fetch} = 1;
                   15288:                                 }
1.1086    raeburn  15289:                             }
                   15290:                         }
1.1055    raeburn  15291:                     }
1.1086    raeburn  15292:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   15293:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294    raeburn  15294:                                     &HTML::Entities::encode($path,'<>&"'),
                   15295:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   15296:                                 '<br />';
1.1055    raeburn  15297:                 }
                   15298:             } else {
1.1294    raeburn  15299:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296    raeburn  15300:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  15301:             }
                   15302:         }
                   15303:         if (keys(%todelete)) {
                   15304:             foreach my $key (keys(%todelete)) {
                   15305:                 unlink($key);
1.1066    raeburn  15306:             }
                   15307:         }
                   15308:         if (keys(%todeletedir)) {
                   15309:             foreach my $key (keys(%todeletedir)) {
                   15310:                 rmdir($key);
                   15311:             }
                   15312:         }
                   15313:         foreach my $dir (sort(keys(%is_dir))) {
                   15314:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   15315:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  15316:             }
                   15317:         }
1.1067    raeburn  15318:         if ($result ne '') {
                   15319:             $output .= '<ul>'."\n".
                   15320:                        $result."\n".
                   15321:                        '</ul>';
                   15322:         }
                   15323:         unless ($ishome) {
                   15324:             my $replicationfail;
                   15325:             foreach my $item (keys(%prompttofetch)) {
                   15326:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   15327:                 unless ($fetchresult eq 'ok') {
                   15328:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   15329:                 }
                   15330:             }
                   15331:             if ($replicationfail) {
                   15332:                 $output .= '<p class="LC_error">'.
                   15333:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   15334:                            $replicationfail.
                   15335:                            '</ul></p>';
                   15336:             }
                   15337:         }
1.1055    raeburn  15338:     } else {
                   15339:         $warning = &mt('No items found in archive.');
                   15340:     }
                   15341:     if ($error) {
                   15342:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   15343:                    $error.'</p>'."\n";
                   15344:     }
                   15345:     if ($warning) {
                   15346:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   15347:     }
                   15348:     return $output;
                   15349: }
                   15350: 
1.1066    raeburn  15351: sub cleanup_empty_dirs {
                   15352:     my ($path) = @_;
                   15353:     if (($path ne '') && (-d $path)) {
                   15354:         if (opendir(my $dirh,$path)) {
                   15355:             my @dircontents = grep(!/^\./,readdir($dirh));
                   15356:             my $numitems = 0;
                   15357:             foreach my $item (@dircontents) {
                   15358:                 if (-d "$path/$item") {
1.1111    raeburn  15359:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  15360:                     if (-e "$path/$item") {
                   15361:                         $numitems ++;
                   15362:                     }
                   15363:                 } else {
                   15364:                     $numitems ++;
                   15365:                 }
                   15366:             }
                   15367:             if ($numitems == 0) {
                   15368:                 rmdir($path);
                   15369:             }
                   15370:             closedir($dirh);
                   15371:         }
                   15372:     }
                   15373:     return;
                   15374: }
                   15375: 
1.41      ng       15376: =pod
1.45      matthew  15377: 
1.1162    raeburn  15378: =item * &get_folder_hierarchy()
1.1068    raeburn  15379: 
                   15380: Provides hierarchy of names of folders/sub-folders containing the current
                   15381: item,
                   15382: 
                   15383: Inputs: 3
                   15384:      - $navmap - navmaps object
                   15385: 
                   15386:      - $map - url for map (either the trigger itself, or map containing
                   15387:                            the resource, which is the trigger).
                   15388: 
                   15389:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   15390: 
                   15391: Outputs: 1 @pathitems - array of folder/subfolder names.
                   15392: 
                   15393: =cut
                   15394: 
                   15395: sub get_folder_hierarchy {
                   15396:     my ($navmap,$map,$showitem) = @_;
                   15397:     my @pathitems;
                   15398:     if (ref($navmap)) {
                   15399:         my $mapres = $navmap->getResourceByUrl($map);
                   15400:         if (ref($mapres)) {
                   15401:             my $pcslist = $mapres->map_hierarchy();
                   15402:             if ($pcslist ne '') {
                   15403:                 my @pcs = split(/,/,$pcslist);
                   15404:                 foreach my $pc (@pcs) {
                   15405:                     if ($pc == 1) {
1.1129    raeburn  15406:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  15407:                     } else {
                   15408:                         my $res = $navmap->getByMapPc($pc);
                   15409:                         if (ref($res)) {
                   15410:                             my $title = $res->compTitle();
                   15411:                             $title =~ s/\W+/_/g;
                   15412:                             if ($title ne '') {
                   15413:                                 push(@pathitems,$title);
                   15414:                             }
                   15415:                         }
                   15416:                     }
                   15417:                 }
                   15418:             }
1.1071    raeburn  15419:             if ($showitem) {
                   15420:                 if ($mapres->{ID} eq '0.0') {
1.1129    raeburn  15421:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  15422:                 } else {
                   15423:                     my $maptitle = $mapres->compTitle();
                   15424:                     $maptitle =~ s/\W+/_/g;
                   15425:                     if ($maptitle ne '') {
                   15426:                         push(@pathitems,$maptitle);
                   15427:                     }
1.1068    raeburn  15428:                 }
                   15429:             }
                   15430:         }
                   15431:     }
                   15432:     return @pathitems;
                   15433: }
                   15434: 
                   15435: =pod
                   15436: 
1.1015    raeburn  15437: =item * &get_turnedin_filepath()
                   15438: 
                   15439: Determines path in a user's portfolio file for storage of files uploaded
                   15440: to a specific essayresponse or dropbox item.
                   15441: 
                   15442: Inputs: 3 required + 1 optional.
                   15443: $symb is symb for resource, $uname and $udom are for current user (required).
                   15444: $caller is optional (can be "submission", if routine is called when storing
                   15445: an upoaded file when "Submit Answer" button was pressed).
                   15446: 
                   15447: Returns array containing $path and $multiresp. 
                   15448: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   15449: than one file upload item.  Callers of routine should append partid as a 
                   15450: subdirectory to $path in cases where $multiresp is 1.
                   15451: 
                   15452: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   15453: 
                   15454: =cut
                   15455: 
                   15456: sub get_turnedin_filepath {
                   15457:     my ($symb,$uname,$udom,$caller) = @_;
                   15458:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   15459:     my $turnindir;
                   15460:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   15461:     $turnindir = $userhash{'turnindir'};
                   15462:     my ($path,$multiresp);
                   15463:     if ($turnindir eq '') {
                   15464:         if ($caller eq 'submission') {
                   15465:             $turnindir = &mt('turned in');
                   15466:             $turnindir =~ s/\W+/_/g;
                   15467:             my %newhash = (
                   15468:                             'turnindir' => $turnindir,
                   15469:                           );
                   15470:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   15471:         }
                   15472:     }
                   15473:     if ($turnindir ne '') {
                   15474:         $path = '/'.$turnindir.'/';
                   15475:         my ($multipart,$turnin,@pathitems);
                   15476:         my $navmap = Apache::lonnavmaps::navmap->new();
                   15477:         if (defined($navmap)) {
                   15478:             my $mapres = $navmap->getResourceByUrl($map);
                   15479:             if (ref($mapres)) {
                   15480:                 my $pcslist = $mapres->map_hierarchy();
                   15481:                 if ($pcslist ne '') {
                   15482:                     foreach my $pc (split(/,/,$pcslist)) {
                   15483:                         my $res = $navmap->getByMapPc($pc);
                   15484:                         if (ref($res)) {
                   15485:                             my $title = $res->compTitle();
                   15486:                             $title =~ s/\W+/_/g;
                   15487:                             if ($title ne '') {
1.1149    raeburn  15488:                                 if (($pc > 1) && (length($title) > 12)) {
                   15489:                                     $title = substr($title,0,12);
                   15490:                                 }
1.1015    raeburn  15491:                                 push(@pathitems,$title);
                   15492:                             }
                   15493:                         }
                   15494:                     }
                   15495:                 }
                   15496:                 my $maptitle = $mapres->compTitle();
                   15497:                 $maptitle =~ s/\W+/_/g;
                   15498:                 if ($maptitle ne '') {
1.1149    raeburn  15499:                     if (length($maptitle) > 12) {
                   15500:                         $maptitle = substr($maptitle,0,12);
                   15501:                     }
1.1015    raeburn  15502:                     push(@pathitems,$maptitle);
                   15503:                 }
                   15504:                 unless ($env{'request.state'} eq 'construct') {
                   15505:                     my $res = $navmap->getBySymb($symb);
                   15506:                     if (ref($res)) {
                   15507:                         my $partlist = $res->parts();
                   15508:                         my $totaluploads = 0;
                   15509:                         if (ref($partlist) eq 'ARRAY') {
                   15510:                             foreach my $part (@{$partlist}) {
                   15511:                                 my @types = $res->responseType($part);
                   15512:                                 my @ids = $res->responseIds($part);
                   15513:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   15514:                                     if ($types[$i] eq 'essay') {
                   15515:                                         my $partid = $part.'_'.$ids[$i];
                   15516:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   15517:                                             $totaluploads ++;
                   15518:                                         }
                   15519:                                     }
                   15520:                                 }
                   15521:                             }
                   15522:                             if ($totaluploads > 1) {
                   15523:                                 $multiresp = 1;
                   15524:                             }
                   15525:                         }
                   15526:                     }
                   15527:                 }
                   15528:             } else {
                   15529:                 return;
                   15530:             }
                   15531:         } else {
                   15532:             return;
                   15533:         }
                   15534:         my $restitle=&Apache::lonnet::gettitle($symb);
                   15535:         $restitle =~ s/\W+/_/g;
                   15536:         if ($restitle eq '') {
                   15537:             $restitle = ($resurl =~ m{/[^/]+$});
                   15538:             if ($restitle eq '') {
                   15539:                 $restitle = time;
                   15540:             }
                   15541:         }
1.1149    raeburn  15542:         if (length($restitle) > 12) {
                   15543:             $restitle = substr($restitle,0,12);
                   15544:         }
1.1015    raeburn  15545:         push(@pathitems,$restitle);
                   15546:         $path .= join('/',@pathitems);
                   15547:     }
                   15548:     return ($path,$multiresp);
                   15549: }
                   15550: 
                   15551: =pod
                   15552: 
1.464     albertel 15553: =back
1.41      ng       15554: 
1.112     bowersj2 15555: =head1 CSV Upload/Handling functions
1.38      albertel 15556: 
1.41      ng       15557: =over 4
                   15558: 
1.648     raeburn  15559: =item * &upfile_store($r)
1.41      ng       15560: 
                   15561: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 15562: needs $env{'form.upfile'}
1.41      ng       15563: returns $datatoken to be put into hidden field
                   15564: 
                   15565: =cut
1.31      albertel 15566: 
                   15567: sub upfile_store {
                   15568:     my $r=shift;
1.258     albertel 15569:     $env{'form.upfile'}=~s/\r/\n/gs;
                   15570:     $env{'form.upfile'}=~s/\f/\n/gs;
                   15571:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   15572:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 15573: 
1.1299    raeburn  15574:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   15575:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   15576:                                      time.'_'.$$);
                   15577:     return if ($datatoken eq '');
                   15578: 
1.31      albertel 15579:     {
1.158     raeburn  15580:         my $datafile = $r->dir_config('lonDaemons').
                   15581:                            '/tmp/'.$datatoken.'.tmp';
1.1317    raeburn  15582:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 15583:             print $fh $env{'form.upfile'};
1.158     raeburn  15584:             close($fh);
                   15585:         }
1.31      albertel 15586:     }
                   15587:     return $datatoken;
                   15588: }
                   15589: 
1.56      matthew  15590: =pod
                   15591: 
1.1290    raeburn  15592: =item * &load_tmp_file($r,$datatoken)
1.41      ng       15593: 
                   15594: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290    raeburn  15595: $datatoken is the name to assign to the temporary file.
1.258     albertel 15596: sets $env{'form.upfile'} to the contents of the file
1.41      ng       15597: 
                   15598: =cut
1.31      albertel 15599: 
                   15600: sub load_tmp_file {
1.1290    raeburn  15601:     my ($r,$datatoken) = @_;
                   15602:     return if ($datatoken eq '');
1.31      albertel 15603:     my @studentdata=();
                   15604:     {
1.158     raeburn  15605:         my $studentfile = $r->dir_config('lonDaemons').
1.1290    raeburn  15606:                               '/tmp/'.$datatoken.'.tmp';
1.1317    raeburn  15607:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  15608:             @studentdata=<$fh>;
                   15609:             close($fh);
                   15610:         }
1.31      albertel 15611:     }
1.258     albertel 15612:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 15613: }
                   15614: 
1.1290    raeburn  15615: sub valid_datatoken {
                   15616:     my ($datatoken) = @_;
1.1325    raeburn  15617:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290    raeburn  15618:         return $datatoken;
                   15619:     }
                   15620:     return;
                   15621: }
                   15622: 
1.56      matthew  15623: =pod
                   15624: 
1.648     raeburn  15625: =item * &upfile_record_sep()
1.41      ng       15626: 
                   15627: Separate uploaded file into records
                   15628: returns array of records,
1.258     albertel 15629: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       15630: 
                   15631: =cut
1.31      albertel 15632: 
                   15633: sub upfile_record_sep {
1.258     albertel 15634:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 15635:     } else {
1.248     albertel 15636: 	my @records;
1.258     albertel 15637: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 15638: 	    if ($line=~/^\s*$/) { next; }
                   15639: 	    push(@records,$line);
                   15640: 	}
                   15641: 	return @records;
1.31      albertel 15642:     }
                   15643: }
                   15644: 
1.56      matthew  15645: =pod
                   15646: 
1.648     raeburn  15647: =item * &record_sep($record)
1.41      ng       15648: 
1.258     albertel 15649: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       15650: 
                   15651: =cut
                   15652: 
1.263     www      15653: sub takeleft {
                   15654:     my $index=shift;
                   15655:     return substr('0000'.$index,-4,4);
                   15656: }
                   15657: 
1.31      albertel 15658: sub record_sep {
                   15659:     my $record=shift;
                   15660:     my %components=();
1.258     albertel 15661:     if ($env{'form.upfiletype'} eq 'xml') {
                   15662:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 15663:         my $i=0;
1.356     albertel 15664:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 15665:             $field=~s/^(\"|\')//;
                   15666:             $field=~s/(\"|\')$//;
1.263     www      15667:             $components{&takeleft($i)}=$field;
1.31      albertel 15668:             $i++;
                   15669:         }
1.258     albertel 15670:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 15671:         my $i=0;
1.356     albertel 15672:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 15673:             $field=~s/^(\"|\')//;
                   15674:             $field=~s/(\"|\')$//;
1.263     www      15675:             $components{&takeleft($i)}=$field;
1.31      albertel 15676:             $i++;
                   15677:         }
                   15678:     } else {
1.561     www      15679:         my $separator=',';
1.480     banghart 15680:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      15681:             $separator=';';
1.480     banghart 15682:         }
1.31      albertel 15683:         my $i=0;
1.561     www      15684: # the character we are looking for to indicate the end of a quote or a record 
                   15685:         my $looking_for=$separator;
                   15686: # do not add the characters to the fields
                   15687:         my $ignore=0;
                   15688: # we just encountered a separator (or the beginning of the record)
                   15689:         my $just_found_separator=1;
                   15690: # store the field we are working on here
                   15691:         my $field='';
                   15692: # work our way through all characters in record
                   15693:         foreach my $character ($record=~/(.)/g) {
                   15694:             if ($character eq $looking_for) {
                   15695:                if ($character ne $separator) {
                   15696: # Found the end of a quote, again looking for separator
                   15697:                   $looking_for=$separator;
                   15698:                   $ignore=1;
                   15699:                } else {
                   15700: # Found a separator, store away what we got
                   15701:                   $components{&takeleft($i)}=$field;
                   15702: 	          $i++;
                   15703:                   $just_found_separator=1;
                   15704:                   $ignore=0;
                   15705:                   $field='';
                   15706:                }
                   15707:                next;
                   15708:             }
                   15709: # single or double quotation marks after a separator indicate beginning of a quote
                   15710: # we are now looking for the end of the quote and need to ignore separators
                   15711:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   15712:                $looking_for=$character;
                   15713:                next;
                   15714:             }
                   15715: # ignore would be true after we reached the end of a quote
                   15716:             if ($ignore) { next; }
                   15717:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   15718:             $field.=$character;
                   15719:             $just_found_separator=0; 
1.31      albertel 15720:         }
1.561     www      15721: # catch the very last entry, since we never encountered the separator
                   15722:         $components{&takeleft($i)}=$field;
1.31      albertel 15723:     }
                   15724:     return %components;
                   15725: }
                   15726: 
1.144     matthew  15727: ######################################################
                   15728: ######################################################
                   15729: 
1.56      matthew  15730: =pod
                   15731: 
1.648     raeburn  15732: =item * &upfile_select_html()
1.41      ng       15733: 
1.144     matthew  15734: Return HTML code to select a file from the users machine and specify 
                   15735: the file type.
1.41      ng       15736: 
                   15737: =cut
                   15738: 
1.144     matthew  15739: ######################################################
                   15740: ######################################################
1.31      albertel 15741: sub upfile_select_html {
1.144     matthew  15742:     my %Types = (
                   15743:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 15744:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  15745:                  space => &mt('Space separated'),
                   15746:                  tab   => &mt('Tabulator separated'),
                   15747: #                 xml   => &mt('HTML/XML'),
                   15748:                  );
1.1473    raeburn  15749:     my $Str = '<input type="file" name="upfile" id="upfile" size="50" />'.
                   15750:         '<br /><label>'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  15751:     foreach my $type (sort(keys(%Types))) {
                   15752:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   15753:     }
1.1473    raeburn  15754:     $Str .= "</select></label>\n";
1.144     matthew  15755:     return $Str;
1.31      albertel 15756: }
                   15757: 
1.301     albertel 15758: sub get_samples {
                   15759:     my ($records,$toget) = @_;
                   15760:     my @samples=({});
                   15761:     my $got=0;
                   15762:     foreach my $rec (@$records) {
                   15763: 	my %temp = &record_sep($rec);
                   15764: 	if (! grep(/\S/, values(%temp))) { next; }
                   15765: 	if (%temp) {
                   15766: 	    $samples[$got]=\%temp;
                   15767: 	    $got++;
                   15768: 	    if ($got == $toget) { last; }
                   15769: 	}
                   15770:     }
                   15771:     return \@samples;
                   15772: }
                   15773: 
1.144     matthew  15774: ######################################################
                   15775: ######################################################
                   15776: 
1.56      matthew  15777: =pod
                   15778: 
1.648     raeburn  15779: =item * &csv_print_samples($r,$records)
1.41      ng       15780: 
                   15781: Prints a table of sample values from each column uploaded $r is an
                   15782: Apache Request ref, $records is an arrayref from
                   15783: &Apache::loncommon::upfile_record_sep
                   15784: 
                   15785: =cut
                   15786: 
1.144     matthew  15787: ######################################################
                   15788: ######################################################
1.31      albertel 15789: sub csv_print_samples {
                   15790:     my ($r,$records) = @_;
1.662     bisitz   15791:     my $samples = &get_samples($records,5);
1.301     albertel 15792: 
1.594     raeburn  15793:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   15794:               &start_data_table_header_row());
1.356     albertel 15795:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   15796:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  15797:     $r->print(&end_data_table_header_row());
1.301     albertel 15798:     foreach my $hash (@$samples) {
1.594     raeburn  15799: 	$r->print(&start_data_table_row());
1.356     albertel 15800: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 15801: 	    $r->print('<td>');
1.356     albertel 15802: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 15803: 	    $r->print('</td>');
                   15804: 	}
1.594     raeburn  15805: 	$r->print(&end_data_table_row());
1.31      albertel 15806:     }
1.594     raeburn  15807:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 15808: }
                   15809: 
1.144     matthew  15810: ######################################################
                   15811: ######################################################
                   15812: 
1.56      matthew  15813: =pod
                   15814: 
1.648     raeburn  15815: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       15816: 
                   15817: Prints a table to create associations between values and table columns.
1.144     matthew  15818: 
1.41      ng       15819: $r is an Apache Request ref,
                   15820: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  15821: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       15822: 
                   15823: =cut
                   15824: 
1.144     matthew  15825: ######################################################
                   15826: ######################################################
1.31      albertel 15827: sub csv_print_select_table {
                   15828:     my ($r,$records,$d) = @_;
1.301     albertel 15829:     my $i=0;
                   15830:     my $samples = &get_samples($records,1);
1.144     matthew  15831:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  15832: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  15833:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  15834:               '<th>'.&mt('Column').'</th>'.
                   15835:               &end_data_table_header_row()."\n");
1.356     albertel 15836:     foreach my $array_ref (@$d) {
                   15837: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.1473    raeburn  15838: 	$r->print(&start_data_table_row().'<td><label for="f'.$i.'">'.$display.'</label></td>');
1.31      albertel 15839: 
1.1473    raeburn  15840: 	$r->print('<td><select name="f'.$i.'" id="f'.$i.'"'.
1.32      matthew  15841: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 15842: 	$r->print('<option value="none"></option>');
1.356     albertel 15843: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   15844: 	    $r->print('<option value="'.$sample.'"'.
                   15845:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   15846:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 15847: 	}
1.594     raeburn  15848: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 15849: 	$i++;
                   15850:     }
1.594     raeburn  15851:     $r->print(&end_data_table());
1.31      albertel 15852:     $i--;
                   15853:     return $i;
                   15854: }
1.56      matthew  15855: 
1.144     matthew  15856: ######################################################
                   15857: ######################################################
                   15858: 
1.56      matthew  15859: =pod
1.31      albertel 15860: 
1.648     raeburn  15861: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       15862: 
                   15863: Prints a table of sample values from the upload and can make associate samples to internal names.
                   15864: 
                   15865: $r is an Apache Request ref,
                   15866: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   15867: $d is an array of 2 element arrays (internal name, displayed name)
                   15868: 
                   15869: =cut
                   15870: 
1.144     matthew  15871: ######################################################
                   15872: ######################################################
1.31      albertel 15873: sub csv_samples_select_table {
                   15874:     my ($r,$records,$d) = @_;
                   15875:     my $i=0;
1.144     matthew  15876:     #
1.662     bisitz   15877:     my $max_samples = 5;
                   15878:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  15879:     $r->print(&start_data_table().
                   15880:               &start_data_table_header_row().'<th>'.
                   15881:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   15882:               &end_data_table_header_row());
1.301     albertel 15883: 
                   15884:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.1473    raeburn  15885:         my $num = $i+1;
                   15886:         my $labeltext = &HTML::Entities::encode(&mt('Field for data in column [_1]',$num));
1.594     raeburn  15887: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.1473    raeburn  15888: 		  ' onchange="javascript:flip(this.form,'.$i.');" aria-label="'.$labeltext.'">');
1.301     albertel 15889: 	foreach my $option (@$d) {
                   15890: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  15891: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 15892:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  15893:                       $display.'</option>');
1.31      albertel 15894: 	}
                   15895: 	$r->print('</select></td><td>');
1.662     bisitz   15896: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 15897: 	    if (defined($samples->[$line]{$key})) { 
                   15898: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   15899: 	    }
                   15900: 	}
1.594     raeburn  15901: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 15902: 	$i++;
                   15903:     }
1.594     raeburn  15904:     $r->print(&end_data_table());
1.31      albertel 15905:     $i--;
                   15906:     return($i);
1.115     matthew  15907: }
                   15908: 
1.144     matthew  15909: ######################################################
                   15910: ######################################################
                   15911: 
1.115     matthew  15912: =pod
                   15913: 
1.648     raeburn  15914: =item * &clean_excel_name($name)
1.115     matthew  15915: 
                   15916: Returns a replacement for $name which does not contain any illegal characters.
                   15917: 
                   15918: =cut
                   15919: 
1.144     matthew  15920: ######################################################
                   15921: ######################################################
1.115     matthew  15922: sub clean_excel_name {
                   15923:     my ($name) = @_;
                   15924:     $name =~ s/[:\*\?\/\\]//g;
                   15925:     if (length($name) > 31) {
                   15926:         $name = substr($name,0,31);
                   15927:     }
                   15928:     return $name;
1.25      albertel 15929: }
1.84      albertel 15930: 
1.85      albertel 15931: =pod
                   15932: 
1.648     raeburn  15933: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 15934: 
                   15935: Returns either 1 or undef
                   15936: 
                   15937: 1 if the part is to be hidden, undef if it is to be shown
                   15938: 
                   15939: Arguments are:
                   15940: 
                   15941: $id the id of the part to be checked
                   15942: $symb, optional the symb of the resource to check
                   15943: $udom, optional the domain of the user to check for
                   15944: $uname, optional the username of the user to check for
                   15945: 
                   15946: =cut
1.84      albertel 15947: 
                   15948: sub check_if_partid_hidden {
                   15949:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 15950:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 15951: 					 $symb,$udom,$uname);
1.141     albertel 15952:     my $truth=1;
                   15953:     #if the string starts with !, then the list is the list to show not hide
                   15954:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 15955:     my @hiddenlist=split(/,/,$hiddenparts);
                   15956:     foreach my $checkid (@hiddenlist) {
1.141     albertel 15957: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 15958:     }
1.141     albertel 15959:     return !$truth;
1.84      albertel 15960: }
1.127     matthew  15961: 
1.138     matthew  15962: 
                   15963: ############################################################
                   15964: ############################################################
                   15965: 
                   15966: =pod
                   15967: 
1.157     matthew  15968: =back 
                   15969: 
1.138     matthew  15970: =head1 cgi-bin script and graphing routines
                   15971: 
1.157     matthew  15972: =over 4
                   15973: 
1.648     raeburn  15974: =item * &get_cgi_id()
1.138     matthew  15975: 
                   15976: Inputs: none
                   15977: 
                   15978: Returns an id which can be used to pass environment variables
                   15979: to various cgi-bin scripts.  These environment variables will
                   15980: be removed from the users environment after a given time by
                   15981: the routine &Apache::lonnet::transfer_profile_to_env.
                   15982: 
                   15983: =cut
                   15984: 
                   15985: ############################################################
                   15986: ############################################################
1.152     albertel 15987: my $uniq=0;
1.136     matthew  15988: sub get_cgi_id {
1.154     albertel 15989:     $uniq=($uniq+1)%100000;
1.280     albertel 15990:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  15991: }
                   15992: 
1.127     matthew  15993: ############################################################
                   15994: ############################################################
                   15995: 
                   15996: =pod
                   15997: 
1.648     raeburn  15998: =item * &DrawBarGraph()
1.127     matthew  15999: 
1.138     matthew  16000: Facilitates the plotting of data in a (stacked) bar graph.
                   16001: Puts plot definition data into the users environment in order for 
                   16002: graph.png to plot it.  Returns an <img> tag for the plot.
                   16003: The bars on the plot are labeled '1','2',...,'n'.
                   16004: 
                   16005: Inputs:
                   16006: 
                   16007: =over 4
                   16008: 
                   16009: =item $Title: string, the title of the plot
                   16010: 
                   16011: =item $xlabel: string, text describing the X-axis of the plot
                   16012: 
                   16013: =item $ylabel: string, text describing the Y-axis of the plot
                   16014: 
                   16015: =item $Max: scalar, the maximum Y value to use in the plot
                   16016: If $Max is < any data point, the graph will not be rendered.
                   16017: 
1.140     matthew  16018: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  16019: they are plotted.  If undefined, default values will be used.
                   16020: 
1.178     matthew  16021: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   16022: 
1.138     matthew  16023: =item @Values: An array of array references.  Each array reference holds data
                   16024: to be plotted in a stacked bar chart.
                   16025: 
1.239     matthew  16026: =item If the final element of @Values is a hash reference the key/value
                   16027: pairs will be added to the graph definition.
                   16028: 
1.138     matthew  16029: =back
                   16030: 
                   16031: Returns:
                   16032: 
                   16033: An <img> tag which references graph.png and the appropriate identifying
                   16034: information for the plot.
                   16035: 
1.127     matthew  16036: =cut
                   16037: 
                   16038: ############################################################
                   16039: ############################################################
1.134     matthew  16040: sub DrawBarGraph {
1.178     matthew  16041:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  16042:     #
                   16043:     if (! defined($colors)) {
                   16044:         $colors = ['#33ff00', 
                   16045:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   16046:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   16047:                   ]; 
                   16048:     }
1.228     matthew  16049:     my $extra_settings = {};
                   16050:     if (ref($Values[-1]) eq 'HASH') {
                   16051:         $extra_settings = pop(@Values);
                   16052:     }
1.127     matthew  16053:     #
1.136     matthew  16054:     my $identifier = &get_cgi_id();
                   16055:     my $id = 'cgi.'.$identifier;        
1.129     matthew  16056:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  16057:         return '';
                   16058:     }
1.225     matthew  16059:     #
                   16060:     my @Labels;
                   16061:     if (defined($labels)) {
                   16062:         @Labels = @$labels;
                   16063:     } else {
                   16064:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263    raeburn  16065:             push(@Labels,$i+1);
1.225     matthew  16066:         }
                   16067:     }
                   16068:     #
1.129     matthew  16069:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  16070:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  16071:     my %ValuesHash;
                   16072:     my $NumSets=1;
                   16073:     foreach my $array (@Values) {
                   16074:         next if (! ref($array));
1.136     matthew  16075:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  16076:             join(',',@$array);
1.129     matthew  16077:     }
1.127     matthew  16078:     #
1.136     matthew  16079:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  16080:     if ($NumBars < 3) {
                   16081:         $width = 120+$NumBars*32;
1.220     matthew  16082:         $xskip = 1;
1.225     matthew  16083:         $bar_width = 30;
                   16084:     } elsif ($NumBars < 5) {
                   16085:         $width = 120+$NumBars*20;
                   16086:         $xskip = 1;
                   16087:         $bar_width = 20;
1.220     matthew  16088:     } elsif ($NumBars < 10) {
1.136     matthew  16089:         $width = 120+$NumBars*15;
                   16090:         $xskip = 1;
                   16091:         $bar_width = 15;
                   16092:     } elsif ($NumBars <= 25) {
                   16093:         $width = 120+$NumBars*11;
                   16094:         $xskip = 5;
                   16095:         $bar_width = 8;
                   16096:     } elsif ($NumBars <= 50) {
                   16097:         $width = 120+$NumBars*8;
                   16098:         $xskip = 5;
                   16099:         $bar_width = 4;
                   16100:     } else {
                   16101:         $width = 120+$NumBars*8;
                   16102:         $xskip = 5;
                   16103:         $bar_width = 4;
                   16104:     }
                   16105:     #
1.137     matthew  16106:     $Max = 1 if ($Max < 1);
                   16107:     if ( int($Max) < $Max ) {
                   16108:         $Max++;
                   16109:         $Max = int($Max);
                   16110:     }
1.127     matthew  16111:     $Title  = '' if (! defined($Title));
                   16112:     $xlabel = '' if (! defined($xlabel));
                   16113:     $ylabel = '' if (! defined($ylabel));
1.369     www      16114:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   16115:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   16116:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  16117:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  16118:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   16119:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   16120:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   16121:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   16122:     $ValuesHash{$id.'.height'}   = $height;
                   16123:     $ValuesHash{$id.'.width'}    = $width;
                   16124:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   16125:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   16126:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  16127:     #
1.228     matthew  16128:     # Deal with other parameters
                   16129:     while (my ($key,$value) = each(%$extra_settings)) {
                   16130:         $ValuesHash{$id.'.'.$key} = $value;
                   16131:     }
                   16132:     #
1.646     raeburn  16133:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  16134:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   16135: }
                   16136: 
                   16137: ############################################################
                   16138: ############################################################
                   16139: 
                   16140: =pod
                   16141: 
1.648     raeburn  16142: =item * &DrawXYGraph()
1.137     matthew  16143: 
1.138     matthew  16144: Facilitates the plotting of data in an XY graph.
                   16145: Puts plot definition data into the users environment in order for 
                   16146: graph.png to plot it.  Returns an <img> tag for the plot.
                   16147: 
                   16148: Inputs:
                   16149: 
                   16150: =over 4
                   16151: 
                   16152: =item $Title: string, the title of the plot
                   16153: 
                   16154: =item $xlabel: string, text describing the X-axis of the plot
                   16155: 
                   16156: =item $ylabel: string, text describing the Y-axis of the plot
                   16157: 
                   16158: =item $Max: scalar, the maximum Y value to use in the plot
                   16159: If $Max is < any data point, the graph will not be rendered.
                   16160: 
                   16161: =item $colors: Array ref containing the hex color codes for the data to be 
                   16162: plotted in.  If undefined, default values will be used.
                   16163: 
                   16164: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   16165: 
                   16166: =item $Ydata: Array ref containing Array refs.  
1.185     www      16167: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  16168: 
                   16169: =item %Values: hash indicating or overriding any default values which are 
                   16170: passed to graph.png.  
                   16171: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   16172: 
                   16173: =back
                   16174: 
                   16175: Returns:
                   16176: 
                   16177: An <img> tag which references graph.png and the appropriate identifying
                   16178: information for the plot.
                   16179: 
1.137     matthew  16180: =cut
                   16181: 
                   16182: ############################################################
                   16183: ############################################################
                   16184: sub DrawXYGraph {
                   16185:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   16186:     #
                   16187:     # Create the identifier for the graph
                   16188:     my $identifier = &get_cgi_id();
                   16189:     my $id = 'cgi.'.$identifier;
                   16190:     #
                   16191:     $Title  = '' if (! defined($Title));
                   16192:     $xlabel = '' if (! defined($xlabel));
                   16193:     $ylabel = '' if (! defined($ylabel));
                   16194:     my %ValuesHash = 
                   16195:         (
1.369     www      16196:          $id.'.title'  => &escape($Title),
                   16197:          $id.'.xlabel' => &escape($xlabel),
                   16198:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  16199:          $id.'.y_max_value'=> $Max,
                   16200:          $id.'.labels'     => join(',',@$Xlabels),
                   16201:          $id.'.PlotType'   => 'XY',
                   16202:          );
                   16203:     #
                   16204:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   16205:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   16206:     }
                   16207:     #
                   16208:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   16209:         return '';
                   16210:     }
                   16211:     my $NumSets=1;
1.138     matthew  16212:     foreach my $array (@{$Ydata}){
1.137     matthew  16213:         next if (! ref($array));
                   16214:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   16215:     }
1.138     matthew  16216:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  16217:     #
                   16218:     # Deal with other parameters
                   16219:     while (my ($key,$value) = each(%Values)) {
                   16220:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  16221:     }
                   16222:     #
1.646     raeburn  16223:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  16224:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   16225: }
                   16226: 
                   16227: ############################################################
                   16228: ############################################################
                   16229: 
                   16230: =pod
                   16231: 
1.648     raeburn  16232: =item * &DrawXYYGraph()
1.138     matthew  16233: 
                   16234: Facilitates the plotting of data in an XY graph with two Y axes.
                   16235: Puts plot definition data into the users environment in order for 
                   16236: graph.png to plot it.  Returns an <img> tag for the plot.
                   16237: 
                   16238: Inputs:
                   16239: 
                   16240: =over 4
                   16241: 
                   16242: =item $Title: string, the title of the plot
                   16243: 
                   16244: =item $xlabel: string, text describing the X-axis of the plot
                   16245: 
                   16246: =item $ylabel: string, text describing the Y-axis of the plot
                   16247: 
                   16248: =item $colors: Array ref containing the hex color codes for the data to be 
                   16249: plotted in.  If undefined, default values will be used.
                   16250: 
                   16251: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   16252: 
                   16253: =item $Ydata1: The first data set
                   16254: 
                   16255: =item $Min1: The minimum value of the left Y-axis
                   16256: 
                   16257: =item $Max1: The maximum value of the left Y-axis
                   16258: 
                   16259: =item $Ydata2: The second data set
                   16260: 
                   16261: =item $Min2: The minimum value of the right Y-axis
                   16262: 
                   16263: =item $Max2: The maximum value of the left Y-axis
                   16264: 
                   16265: =item %Values: hash indicating or overriding any default values which are 
                   16266: passed to graph.png.  
                   16267: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   16268: 
                   16269: =back
                   16270: 
                   16271: Returns:
                   16272: 
                   16273: An <img> tag which references graph.png and the appropriate identifying
                   16274: information for the plot.
1.136     matthew  16275: 
                   16276: =cut
                   16277: 
                   16278: ############################################################
                   16279: ############################################################
1.137     matthew  16280: sub DrawXYYGraph {
                   16281:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   16282:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  16283:     #
                   16284:     # Create the identifier for the graph
                   16285:     my $identifier = &get_cgi_id();
                   16286:     my $id = 'cgi.'.$identifier;
                   16287:     #
                   16288:     $Title  = '' if (! defined($Title));
                   16289:     $xlabel = '' if (! defined($xlabel));
                   16290:     $ylabel = '' if (! defined($ylabel));
                   16291:     my %ValuesHash = 
                   16292:         (
1.369     www      16293:          $id.'.title'  => &escape($Title),
                   16294:          $id.'.xlabel' => &escape($xlabel),
                   16295:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  16296:          $id.'.labels' => join(',',@$Xlabels),
                   16297:          $id.'.PlotType' => 'XY',
                   16298:          $id.'.NumSets' => 2,
1.137     matthew  16299:          $id.'.two_axes' => 1,
                   16300:          $id.'.y1_max_value' => $Max1,
                   16301:          $id.'.y1_min_value' => $Min1,
                   16302:          $id.'.y2_max_value' => $Max2,
                   16303:          $id.'.y2_min_value' => $Min2,
1.136     matthew  16304:          );
                   16305:     #
1.137     matthew  16306:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   16307:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   16308:     }
                   16309:     #
                   16310:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   16311:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  16312:         return '';
                   16313:     }
                   16314:     my $NumSets=1;
1.137     matthew  16315:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  16316:         next if (! ref($array));
                   16317:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  16318:     }
                   16319:     #
                   16320:     # Deal with other parameters
                   16321:     while (my ($key,$value) = each(%Values)) {
                   16322:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  16323:     }
                   16324:     #
1.646     raeburn  16325:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 16326:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  16327: }
                   16328: 
                   16329: ############################################################
                   16330: ############################################################
                   16331: 
                   16332: =pod
                   16333: 
1.157     matthew  16334: =back 
                   16335: 
1.139     matthew  16336: =head1 Statistics helper routines?  
                   16337: 
                   16338: Bad place for them but what the hell.
                   16339: 
1.157     matthew  16340: =over 4
                   16341: 
1.648     raeburn  16342: =item * &chartlink()
1.139     matthew  16343: 
                   16344: Returns a link to the chart for a specific student.  
                   16345: 
                   16346: Inputs:
                   16347: 
                   16348: =over 4
                   16349: 
                   16350: =item $linktext: The text of the link
                   16351: 
                   16352: =item $sname: The students username
                   16353: 
                   16354: =item $sdomain: The students domain
                   16355: 
                   16356: =back
                   16357: 
1.157     matthew  16358: =back
                   16359: 
1.139     matthew  16360: =cut
                   16361: 
                   16362: ############################################################
                   16363: ############################################################
                   16364: sub chartlink {
                   16365:     my ($linktext, $sname, $sdomain) = @_;
                   16366:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      16367:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 16368:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  16369:        '">'.$linktext.'</a>';
1.153     matthew  16370: }
                   16371: 
                   16372: #######################################################
                   16373: #######################################################
                   16374: 
                   16375: =pod
                   16376: 
                   16377: =head1 Course Environment Routines
1.157     matthew  16378: 
                   16379: =over 4
1.153     matthew  16380: 
1.648     raeburn  16381: =item * &restore_course_settings()
1.153     matthew  16382: 
1.648     raeburn  16383: =item * &store_course_settings()
1.153     matthew  16384: 
                   16385: Restores/Store indicated form parameters from the course environment.
                   16386: Will not overwrite existing values of the form parameters.
                   16387: 
                   16388: Inputs: 
                   16389: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   16390: 
                   16391: a hash ref describing the data to be stored.  For example:
                   16392:    
                   16393: %Save_Parameters = ('Status' => 'scalar',
                   16394:     'chartoutputmode' => 'scalar',
                   16395:     'chartoutputdata' => 'scalar',
                   16396:     'Section' => 'array',
1.373     raeburn  16397:     'Group' => 'array',
1.153     matthew  16398:     'StudentData' => 'array',
                   16399:     'Maps' => 'array');
                   16400: 
                   16401: Returns: both routines return nothing
                   16402: 
1.631     raeburn  16403: =back
                   16404: 
1.153     matthew  16405: =cut
                   16406: 
                   16407: #######################################################
                   16408: #######################################################
                   16409: sub store_course_settings {
1.496     albertel 16410:     return &store_settings($env{'request.course.id'},@_);
                   16411: }
                   16412: 
                   16413: sub store_settings {
1.153     matthew  16414:     # save to the environment
                   16415:     # appenv the same items, just to be safe
1.300     albertel 16416:     my $udom  = $env{'user.domain'};
                   16417:     my $uname = $env{'user.name'};
1.496     albertel 16418:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  16419:     my %SaveHash;
                   16420:     my %AppHash;
                   16421:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 16422:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 16423:         my $envname = 'environment.'.$basename;
1.258     albertel 16424:         if (exists($env{'form.'.$setting})) {
1.153     matthew  16425:             # Save this value away
                   16426:             if ($type eq 'scalar' &&
1.258     albertel 16427:                 (! exists($env{$envname}) || 
                   16428:                  $env{$envname} ne $env{'form.'.$setting})) {
                   16429:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   16430:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  16431:             } elsif ($type eq 'array') {
                   16432:                 my $stored_form;
1.258     albertel 16433:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  16434:                     $stored_form = join(',',
                   16435:                                         map {
1.369     www      16436:                                             &escape($_);
1.258     albertel 16437:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  16438:                 } else {
                   16439:                     $stored_form = 
1.369     www      16440:                         &escape($env{'form.'.$setting});
1.153     matthew  16441:                 }
                   16442:                 # Determine if the array contents are the same.
1.258     albertel 16443:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  16444:                     $SaveHash{$basename} = $stored_form;
                   16445:                     $AppHash{$envname}   = $stored_form;
                   16446:                 }
                   16447:             }
                   16448:         }
                   16449:     }
                   16450:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 16451:                                           $udom,$uname);
1.153     matthew  16452:     if ($put_result !~ /^(ok|delayed)/) {
                   16453:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   16454:                                  'got error:'.$put_result);
                   16455:     }
                   16456:     # Make sure these settings stick around in this session, too
1.646     raeburn  16457:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  16458:     return;
                   16459: }
                   16460: 
                   16461: sub restore_course_settings {
1.499     albertel 16462:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 16463: }
                   16464: 
                   16465: sub restore_settings {
                   16466:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  16467:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 16468:         next if (exists($env{'form.'.$setting}));
1.496     albertel 16469:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  16470:             '.'.$setting;
1.258     albertel 16471:         if (exists($env{$envname})) {
1.153     matthew  16472:             if ($type eq 'scalar') {
1.258     albertel 16473:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  16474:             } elsif ($type eq 'array') {
1.258     albertel 16475:                 $env{'form.'.$setting} = [ 
1.153     matthew  16476:                                            map { 
1.369     www      16477:                                                &unescape($_); 
1.258     albertel 16478:                                            } split(',',$env{$envname})
1.153     matthew  16479:                                            ];
                   16480:             }
                   16481:         }
                   16482:     }
1.127     matthew  16483: }
                   16484: 
1.618     raeburn  16485: #######################################################
                   16486: #######################################################
                   16487: 
                   16488: =pod
                   16489: 
                   16490: =head1 Domain E-mail Routines  
                   16491: 
                   16492: =over 4
                   16493: 
1.648     raeburn  16494: =item * &build_recipient_list()
1.618     raeburn  16495: 
1.1144    raeburn  16496: Build recipient lists for following types of e-mail:
1.766     raeburn  16497: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144    raeburn  16498: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   16499: module change checking, student/employee ID conflict checks, as
                   16500: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   16501: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  16502: 
                   16503: Inputs:
1.619     raeburn  16504: defmail (scalar - email address of default recipient), 
1.1144    raeburn  16505: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   16506: requestsmail, updatesmail, or idconflictsmail).
                   16507: 
1.619     raeburn  16508: defdom (domain for which to retrieve configuration settings),
1.1144    raeburn  16509: 
1.619     raeburn  16510: origmail (scalar - email address of recipient from loncapa.conf, 
1.1297    raeburn  16511: i.e., predates configuration by DC via domainprefs.pm
                   16512: 
                   16513: $requname username of requester (if mailing type is helpdeskmail)
                   16514: 
                   16515: $requdom domain of requester (if mailing type is helpdeskmail)
                   16516: 
                   16517: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
                   16518: 
1.618     raeburn  16519: 
1.655     raeburn  16520: Returns: comma separated list of addresses to which to send e-mail.
                   16521: 
                   16522: =back
1.618     raeburn  16523: 
                   16524: =cut
                   16525: 
                   16526: ############################################################
                   16527: ############################################################
                   16528: sub build_recipient_list {
1.1297    raeburn  16529:     my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618     raeburn  16530:     my @recipients;
1.1270    raeburn  16531:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  16532:     my %domconfig =
1.1270    raeburn  16533:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  16534:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  16535:         if (exists($domconfig{'contacts'}{$mailing})) {
                   16536:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   16537:                 my @contacts = ('adminemail','supportemail');
                   16538:                 foreach my $item (@contacts) {
                   16539:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   16540:                         my $addr = $domconfig{'contacts'}{$item}; 
                   16541:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   16542:                             push(@recipients,$addr);
                   16543:                         }
1.619     raeburn  16544:                     }
1.1270    raeburn  16545:                 }
                   16546:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   16547:                 if ($mailing eq 'helpdeskmail') {
                   16548:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   16549:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   16550:                         my @ok_bccs;
                   16551:                         foreach my $bcc (@bccs) {
                   16552:                             $bcc =~ s/^\s+//g;
                   16553:                             $bcc =~ s/\s+$//g;
                   16554:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   16555:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   16556:                                     push(@ok_bccs,$bcc);
                   16557:                                 }
                   16558:                             }
                   16559:                         }
                   16560:                         if (@ok_bccs > 0) {
                   16561:                             $allbcc = join(', ',@ok_bccs);
                   16562:                         }
                   16563:                     }
                   16564:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  16565:                 }
                   16566:             }
1.766     raeburn  16567:         } elsif ($origmail ne '') {
1.1270    raeburn  16568:             $lastresort = $origmail;
1.618     raeburn  16569:         }
1.1297    raeburn  16570:         if ($mailing eq 'helpdeskmail') {
                   16571:             if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
                   16572:                 (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
                   16573:                 my ($inststatus,$inststatus_checked);
                   16574:                 if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
                   16575:                     ($env{'user.domain'} ne 'public')) {
                   16576:                     $inststatus_checked = 1;
                   16577:                     $inststatus = $env{'environment.inststatus'};
                   16578:                 }
                   16579:                 unless ($inststatus_checked) {
                   16580:                     if (($requname ne '') && ($requdom ne '')) {
                   16581:                         if (($requname =~ /^$match_username$/) &&
                   16582:                             ($requdom =~ /^$match_domain$/) &&
                   16583:                             (&Apache::lonnet::domain($requdom))) {
                   16584:                             my $requhome = &Apache::lonnet::homeserver($requname,
                   16585:                                                                       $requdom);
                   16586:                             unless ($requhome eq 'no_host') {
                   16587:                                 my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
                   16588:                                 $inststatus = $userenv{'inststatus'};
                   16589:                                 $inststatus_checked = 1;
                   16590:                             }
                   16591:                         }
                   16592:                     }
                   16593:                 }
                   16594:                 unless ($inststatus_checked) {
                   16595:                     if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
                   16596:                         my %srch = (srchby     => 'email',
                   16597:                                     srchdomain => $defdom,
                   16598:                                     srchterm   => $reqemail,
                   16599:                                     srchtype   => 'exact');
                   16600:                         my %srch_results = &Apache::lonnet::usersearch(\%srch);
                   16601:                         foreach my $uname (keys(%srch_results)) {
                   16602:                             if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   16603:                                 $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   16604:                                 $inststatus_checked = 1;
                   16605:                                 last;
                   16606:                             }
                   16607:                         }
                   16608:                         unless ($inststatus_checked) {
                   16609:                             my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
                   16610:                             if ($dirsrchres eq 'ok') {
                   16611:                                 foreach my $uname (keys(%srch_results)) {
                   16612:                                     if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   16613:                                         $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   16614:                                         $inststatus_checked = 1;
                   16615:                                         last;
                   16616:                                     }
                   16617:                                 }
                   16618:                             }
                   16619:                         }
                   16620:                     }
                   16621:                 }
                   16622:                 if ($inststatus ne '') {
                   16623:                     foreach my $status (split(/\:/,$inststatus)) {
                   16624:                         if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
                   16625:                             my @contacts = ('adminemail','supportemail');
                   16626:                             foreach my $item (@contacts) {
                   16627:                                 if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
                   16628:                                     my $addr = $domconfig{'contacts'}{'overrides'}{$status};
                   16629:                                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   16630:                                         push(@recipients,$addr);
                   16631:                                     }
                   16632:                                 }
                   16633:                             }
                   16634:                             $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
                   16635:                             if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
                   16636:                                 my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
                   16637:                                 my @ok_bccs;
                   16638:                                 foreach my $bcc (@bccs) {
                   16639:                                     $bcc =~ s/^\s+//g;
                   16640:                                     $bcc =~ s/\s+$//g;
                   16641:                                     if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   16642:                                         if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   16643:                                             push(@ok_bccs,$bcc);
                   16644:                                         }
                   16645:                                     }
                   16646:                                 }
                   16647:                                 if (@ok_bccs > 0) {
                   16648:                                     $allbcc = join(', ',@ok_bccs);
                   16649:                                 }
                   16650:                             }
                   16651:                             $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
                   16652:                             last;
                   16653:                         }
                   16654:                     }
                   16655:                 }
                   16656:             }
                   16657:         }
1.619     raeburn  16658:     } elsif ($origmail ne '') {
1.1270    raeburn  16659:         $lastresort = $origmail;
                   16660:     }
1.1297    raeburn  16661:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270    raeburn  16662:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   16663:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   16664:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   16665:             my %what = (
                   16666:                           perlvar => 1,
                   16667:                        );
                   16668:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   16669:             if ($primary) {
                   16670:                 my $gotaddr;
                   16671:                 my ($result,$returnhash) =
                   16672:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   16673:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   16674:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   16675:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   16676:                         $gotaddr = 1;
                   16677:                     }
                   16678:                 }
                   16679:                 unless ($gotaddr) {
                   16680:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   16681:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   16682:                     unless ($uintdom eq $intdom) {
                   16683:                         my %domconfig =
                   16684:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   16685:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   16686:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   16687:                                 my @contacts = ('adminemail','supportemail');
                   16688:                                 foreach my $item (@contacts) {
                   16689:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   16690:                                         my $addr = $domconfig{'contacts'}{$item};
                   16691:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   16692:                                             push(@recipients,$addr);
                   16693:                                         }
                   16694:                                     }
                   16695:                                 }
                   16696:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   16697:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   16698:                                 }
                   16699:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   16700:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   16701:                                     my @ok_bccs;
                   16702:                                     foreach my $bcc (@bccs) {
                   16703:                                         $bcc =~ s/^\s+//g;
                   16704:                                         $bcc =~ s/\s+$//g;
                   16705:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   16706:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   16707:                                                 push(@ok_bccs,$bcc);
                   16708:                                             }
                   16709:                                         }
                   16710:                                     }
                   16711:                                     if (@ok_bccs > 0) {
                   16712:                                         $allbcc = join(', ',@ok_bccs);
                   16713:                                     }
                   16714:                                 }
                   16715:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   16716:                             }
                   16717:                         }
                   16718:                     }
                   16719:                 }
                   16720:             }
                   16721:         }
1.618     raeburn  16722:     }
1.688     raeburn  16723:     if (defined($defmail)) {
                   16724:         if ($defmail ne '') {
                   16725:             push(@recipients,$defmail);
                   16726:         }
1.618     raeburn  16727:     }
                   16728:     if ($otheremails) {
1.619     raeburn  16729:         my @others;
                   16730:         if ($otheremails =~ /,/) {
                   16731:             @others = split(/,/,$otheremails);
1.618     raeburn  16732:         } else {
1.619     raeburn  16733:             push(@others,$otheremails);
                   16734:         }
                   16735:         foreach my $addr (@others) {
                   16736:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   16737:                 push(@recipients,$addr);
                   16738:             }
1.618     raeburn  16739:         }
                   16740:     }
1.1298    raeburn  16741:     if ($mailing eq 'helpdeskmail') {
1.1270    raeburn  16742:         if ((!@recipients) && ($lastresort ne '')) {
                   16743:             push(@recipients,$lastresort);
                   16744:         }
                   16745:     } elsif ($lastresort ne '') {
                   16746:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   16747:             push(@recipients,$lastresort);
                   16748:         }
                   16749:     }
1.1271    raeburn  16750:     my $recipientlist = join(',',@recipients);
1.1270    raeburn  16751:     if (wantarray) {
                   16752:         return ($recipientlist,$allbcc,$addtext);
                   16753:     } else {
                   16754:         return $recipientlist;
                   16755:     }
1.618     raeburn  16756: }
                   16757: 
1.127     matthew  16758: ############################################################
                   16759: ############################################################
1.154     albertel 16760: 
1.655     raeburn  16761: =pod
                   16762: 
1.1224    musolffc 16763: =over 4
                   16764: 
1.1223    musolffc 16765: =item * &mime_email()
                   16766: 
                   16767: Sends an email with a possible attachment
                   16768: 
                   16769: Inputs:
                   16770: 
                   16771: =over 4
                   16772: 
                   16773: from -              Sender's email address
                   16774: 
1.1343    raeburn  16775: replyto -           Reply-To email address
                   16776: 
1.1223    musolffc 16777: to -                Email address of recipient
                   16778: 
                   16779: subject -           Subject of email
                   16780: 
                   16781: body -              Body of email
                   16782: 
                   16783: cc_string -         Carbon copy email address
                   16784: 
                   16785: bcc -               Blind carbon copy email address
                   16786: 
                   16787: attachment_path -   Path of file to be attached
                   16788: 
                   16789: file_name -         Name of file to be attached
                   16790: 
                   16791: attachment_text -   The body of an attachment of type "TEXT"
                   16792: 
                   16793: =back
                   16794: 
                   16795: =back
                   16796: 
                   16797: =cut
                   16798: 
                   16799: ############################################################
                   16800: ############################################################
                   16801: 
                   16802: sub mime_email {
1.1343    raeburn  16803:     my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path, 
                   16804:         $file_name,$attachment_text) = @_;
                   16805:  
1.1223    musolffc 16806:     my $msg = MIME::Lite->new(
                   16807:              From    => $from,
                   16808:              To      => $to,
                   16809:              Subject => $subject,
                   16810:              Type    =>'TEXT',
                   16811:              Data    => $body,
                   16812:              );
1.1343    raeburn  16813:     if ($replyto ne '') {
                   16814:         $msg->add("Reply-To" => $replyto);
                   16815:     }
1.1223    musolffc 16816:     if ($cc_string ne '') {
                   16817:         $msg->add("Cc" => $cc_string);
                   16818:     }
                   16819:     if ($bcc ne '') {
                   16820:         $msg->add("Bcc" => $bcc);
                   16821:     }
                   16822:     $msg->attr("content-type"         => "text/plain");
                   16823:     $msg->attr("content-type.charset" => "UTF-8");
                   16824:     # Attach file if given
                   16825:     if ($attachment_path) {
                   16826:         unless ($file_name) {
                   16827:             if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
                   16828:         }
                   16829:         my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
                   16830:         $msg->attach(Type     => $type,
                   16831:                      Path     => $attachment_path,
                   16832:                      Filename => $file_name
                   16833:                      );
                   16834:     # Otherwise attach text if given
                   16835:     } elsif ($attachment_text) {
                   16836:         $msg->attach(Type => 'TEXT',
                   16837:                      Data => $attachment_text);
                   16838:     }
                   16839:     # Send it
                   16840:     $msg->send('sendmail');
                   16841: }
                   16842: 
                   16843: ############################################################
                   16844: ############################################################
                   16845: 
                   16846: =pod
                   16847: 
1.655     raeburn  16848: =head1 Course Catalog Routines
                   16849: 
                   16850: =over 4
                   16851: 
                   16852: =item * &gather_categories()
                   16853: 
                   16854: Converts category definitions - keys of categories hash stored in  
                   16855: coursecategories in configuration.db on the primary library server in a 
                   16856: domain - to an array.  Also generates javascript and idx hash used to 
                   16857: generate Domain Coordinator interface for editing Course Categories.
                   16858: 
                   16859: Inputs:
1.663     raeburn  16860: 
1.655     raeburn  16861: categories (reference to hash of category definitions).
1.663     raeburn  16862: 
1.655     raeburn  16863: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   16864:       categories and subcategories).
1.663     raeburn  16865: 
1.655     raeburn  16866: idx (reference to hash of counters used in Domain Coordinator interface for 
                   16867:       editing Course Categories).
1.663     raeburn  16868: 
1.655     raeburn  16869: jsarray (reference to array of categories used to create Javascript arrays for
                   16870:          Domain Coordinator interface for editing Course Categories).
                   16871: 
                   16872: Returns: nothing
                   16873: 
                   16874: Side effects: populates cats, idx and jsarray. 
                   16875: 
                   16876: =cut
                   16877: 
                   16878: sub gather_categories {
                   16879:     my ($categories,$cats,$idx,$jsarray) = @_;
                   16880:     my %counters;
                   16881:     my $num = 0;
                   16882:     foreach my $item (keys(%{$categories})) {
                   16883:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   16884:         if ($container eq '' && $depth == 0) {
                   16885:             $cats->[$depth][$categories->{$item}] = $cat;
                   16886:         } else {
                   16887:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   16888:         }
                   16889:         my ($escitem,$tail) = split(/:/,$item,2);
                   16890:         if ($counters{$tail} eq '') {
                   16891:             $counters{$tail} = $num;
                   16892:             $num ++;
                   16893:         }
                   16894:         if (ref($idx) eq 'HASH') {
                   16895:             $idx->{$item} = $counters{$tail};
                   16896:         }
                   16897:         if (ref($jsarray) eq 'ARRAY') {
                   16898:             push(@{$jsarray->[$counters{$tail}]},$item);
                   16899:         }
                   16900:     }
                   16901:     return;
                   16902: }
                   16903: 
                   16904: =pod
                   16905: 
                   16906: =item * &extract_categories()
                   16907: 
                   16908: Used to generate breadcrumb trails for course categories.
                   16909: 
                   16910: Inputs:
1.663     raeburn  16911: 
1.655     raeburn  16912: categories (reference to hash of category definitions).
1.663     raeburn  16913: 
1.655     raeburn  16914: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   16915:       categories and subcategories).
1.663     raeburn  16916: 
1.655     raeburn  16917: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  16918: 
1.655     raeburn  16919: allitems (reference to hash - key is category key 
                   16920:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  16921: 
1.655     raeburn  16922: idx (reference to hash of counters used in Domain Coordinator interface for
                   16923:       editing Course Categories).
1.663     raeburn  16924: 
1.655     raeburn  16925: jsarray (reference to array of categories used to create Javascript arrays for
                   16926:          Domain Coordinator interface for editing Course Categories).
                   16927: 
1.665     raeburn  16928: subcats (reference to hash of arrays containing all subcategories within each 
                   16929:          category, -recursive)
                   16930: 
1.1321    raeburn  16931: maxd (reference to hash used to hold max depth for all top-level categories).
                   16932: 
1.655     raeburn  16933: Returns: nothing
                   16934: 
                   16935: Side effects: populates trails and allitems hash references.
                   16936: 
                   16937: =cut
                   16938: 
                   16939: sub extract_categories {
1.1321    raeburn  16940:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655     raeburn  16941:     if (ref($categories) eq 'HASH') {
                   16942:         &gather_categories($categories,$cats,$idx,$jsarray);
                   16943:         if (ref($cats->[0]) eq 'ARRAY') {
                   16944:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   16945:                 my $name = $cats->[0][$i];
                   16946:                 my $item = &escape($name).'::0';
                   16947:                 my $trailstr;
                   16948:                 if ($name eq 'instcode') {
                   16949:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  16950:                 } elsif ($name eq 'communities') {
                   16951:                     $trailstr = &mt('Communities');
1.1239    raeburn  16952:                 } elsif ($name eq 'placement') {
                   16953:                     $trailstr = &mt('Placement Tests');
1.655     raeburn  16954:                 } else {
                   16955:                     $trailstr = $name;
                   16956:                 }
                   16957:                 if ($allitems->{$item} eq '') {
                   16958:                     push(@{$trails},$trailstr);
                   16959:                     $allitems->{$item} = scalar(@{$trails})-1;
                   16960:                 }
                   16961:                 my @parents = ($name);
                   16962:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   16963:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   16964:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  16965:                         if (ref($subcats) eq 'HASH') {
                   16966:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   16967:                         }
1.1321    raeburn  16968:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665     raeburn  16969:                     }
                   16970:                 } else {
                   16971:                     if (ref($subcats) eq 'HASH') {
                   16972:                         $subcats->{$item} = [];
1.655     raeburn  16973:                     }
1.1321    raeburn  16974:                     if (ref($maxd) eq 'HASH') {
                   16975:                         $maxd->{$name} = 1;
                   16976:                     }
1.655     raeburn  16977:                 }
                   16978:             }
                   16979:         }
                   16980:     }
                   16981:     return;
                   16982: }
                   16983: 
                   16984: =pod
                   16985: 
1.1162    raeburn  16986: =item * &recurse_categories()
1.655     raeburn  16987: 
                   16988: Recursively used to generate breadcrumb trails for course categories.
                   16989: 
                   16990: Inputs:
1.663     raeburn  16991: 
1.655     raeburn  16992: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   16993:       categories and subcategories).
1.663     raeburn  16994: 
1.655     raeburn  16995: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  16996: 
                   16997: category (current course category, for which breadcrumb trail is being generated).
                   16998: 
                   16999: trails (reference to array of breadcrumb trails for each category).
                   17000: 
1.655     raeburn  17001: allitems (reference to hash - key is category key
                   17002:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  17003: 
1.655     raeburn  17004: parents (array containing containers directories for current category, 
                   17005:          back to top level). 
                   17006: 
                   17007: Returns: nothing
                   17008: 
                   17009: Side effects: populates trails and allitems hash references
                   17010: 
                   17011: =cut
                   17012: 
                   17013: sub recurse_categories {
1.1321    raeburn  17014:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655     raeburn  17015:     my $shallower = $depth - 1;
                   17016:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   17017:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   17018:             my $name = $cats->[$depth]{$category}[$k];
                   17019:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321    raeburn  17020:             my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  17021:             if ($allitems->{$item} eq '') {
                   17022:                 push(@{$trails},$trailstr);
                   17023:                 $allitems->{$item} = scalar(@{$trails})-1;
                   17024:             }
                   17025:             my $deeper = $depth+1;
                   17026:             push(@{$parents},$category);
1.665     raeburn  17027:             if (ref($subcats) eq 'HASH') {
                   17028:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   17029:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   17030:                     my $higher;
                   17031:                     if ($j > 0) {
                   17032:                         $higher = &escape($parents->[$j]).':'.
                   17033:                                   &escape($parents->[$j-1]).':'.$j;
                   17034:                     } else {
                   17035:                         $higher = &escape($parents->[$j]).'::'.$j;
                   17036:                     }
                   17037:                     push(@{$subcats->{$higher}},$subcat);
                   17038:                 }
                   17039:             }
                   17040:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321    raeburn  17041:                                 $subcats,$maxd);
1.655     raeburn  17042:             pop(@{$parents});
                   17043:         }
                   17044:     } else {
                   17045:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321    raeburn  17046:         my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  17047:         if ($allitems->{$item} eq '') {
                   17048:             push(@{$trails},$trailstr);
                   17049:             $allitems->{$item} = scalar(@{$trails})-1;
                   17050:         }
1.1321    raeburn  17051:         if (ref($maxd) eq 'HASH') {
                   17052:             if ($depth > $maxd->{$parents->[0]}) {
                   17053:                 $maxd->{$parents->[0]} = $depth;
                   17054:             }
                   17055:         }
1.655     raeburn  17056:     }
                   17057:     return;
                   17058: }
                   17059: 
1.663     raeburn  17060: =pod
                   17061: 
1.1162    raeburn  17062: =item * &assign_categories_table()
1.663     raeburn  17063: 
                   17064: Create a datatable for display of hierarchical categories in a domain,
                   17065: with checkboxes to allow a course to be categorized. 
                   17066: 
                   17067: Inputs:
                   17068: 
                   17069: cathash - reference to hash of categories defined for the domain (from
                   17070:           configuration.db)
                   17071: 
                   17072: currcat - scalar with an & separated list of categories assigned to a course. 
                   17073: 
1.919     raeburn  17074: type    - scalar contains course type (Course or Community).
                   17075: 
1.1260    raeburn  17076: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   17077:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   17078: 
1.663     raeburn  17079: Returns: $output (markup to be displayed) 
                   17080: 
                   17081: =cut
                   17082: 
                   17083: sub assign_categories_table {
1.1259    raeburn  17084:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  17085:     my $output;
                   17086:     if (ref($cathash) eq 'HASH') {
1.1321    raeburn  17087:         my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
                   17088:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663     raeburn  17089:         $maxdepth = scalar(@cats);
                   17090:         if (@cats > 0) {
                   17091:             my $itemcount = 0;
                   17092:             if (ref($cats[0]) eq 'ARRAY') {
                   17093:                 my @currcategories;
                   17094:                 if ($currcat ne '') {
                   17095:                     @currcategories = split('&',$currcat);
                   17096:                 }
1.919     raeburn  17097:                 my $table;
1.663     raeburn  17098:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   17099:                     my $parent = $cats[0][$i];
1.919     raeburn  17100:                     next if ($parent eq 'instcode');
                   17101:                     if ($type eq 'Community') {
                   17102:                         next unless ($parent eq 'communities');
1.1239    raeburn  17103:                     } elsif ($type eq 'Placement') {
                   17104:                         next unless ($parent eq 'placement');
1.919     raeburn  17105:                     } else {
1.1239    raeburn  17106:                         next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919     raeburn  17107:                     }
1.663     raeburn  17108:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   17109:                     my $item = &escape($parent).'::0';
                   17110:                     my $checked = '';
                   17111:                     if (@currcategories > 0) {
                   17112:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   17113:                             $checked = ' checked="checked"';
1.663     raeburn  17114:                         }
                   17115:                     }
1.919     raeburn  17116:                     my $parent_title = $parent;
                   17117:                     if ($parent eq 'communities') {
                   17118:                         $parent_title = &mt('Communities');
1.1239    raeburn  17119:                     } elsif ($parent eq 'placement') {
                   17120:                         $parent_title = &mt('Placement Tests');
1.919     raeburn  17121:                     }
                   17122:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   17123:                               '<input type="checkbox" name="usecategory" value="'.
1.1259    raeburn  17124:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  17125:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  17126:                     my $depth = 1;
                   17127:                     push(@path,$parent);
1.1259    raeburn  17128:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  17129:                     pop(@path);
1.919     raeburn  17130:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  17131:                     $itemcount ++;
                   17132:                 }
1.919     raeburn  17133:                 if ($itemcount) {
                   17134:                     $output = &Apache::loncommon::start_data_table().
                   17135:                               $table.
                   17136:                               &Apache::loncommon::end_data_table();
                   17137:                 }
1.663     raeburn  17138:             }
                   17139:         }
                   17140:     }
                   17141:     return $output;
                   17142: }
                   17143: 
                   17144: =pod
                   17145: 
1.1162    raeburn  17146: =item * &assign_category_rows()
1.663     raeburn  17147: 
                   17148: Create a datatable row for display of nested categories in a domain,
                   17149: with checkboxes to allow a course to be categorized,called recursively.
                   17150: 
                   17151: Inputs:
                   17152: 
                   17153: itemcount - track row number for alternating colors
                   17154: 
                   17155: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   17156:       categories and subcategories.
                   17157: 
                   17158: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   17159: 
                   17160: parent - parent of current category item
                   17161: 
                   17162: path - Array containing all categories back up through the hierarchy from the
                   17163:        current category to the top level.
                   17164: 
                   17165: currcategories - reference to array of current categories assigned to the course
                   17166: 
1.1260    raeburn  17167: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   17168:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   17169: 
1.663     raeburn  17170: Returns: $output (markup to be displayed).
                   17171: 
                   17172: =cut
                   17173: 
                   17174: sub assign_category_rows {
1.1259    raeburn  17175:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  17176:     my ($text,$name,$item,$chgstr);
                   17177:     if (ref($cats) eq 'ARRAY') {
                   17178:         my $maxdepth = scalar(@{$cats});
                   17179:         if (ref($cats->[$depth]) eq 'HASH') {
                   17180:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   17181:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   17182:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145    raeburn  17183:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  17184:                 for (my $j=0; $j<$numchildren; $j++) {
                   17185:                     $name = $cats->[$depth]{$parent}[$j];
                   17186:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   17187:                     my $deeper = $depth+1;
                   17188:                     my $checked = '';
                   17189:                     if (ref($currcategories) eq 'ARRAY') {
                   17190:                         if (@{$currcategories} > 0) {
                   17191:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   17192:                                 $checked = ' checked="checked"';
1.663     raeburn  17193:                             }
                   17194:                         }
                   17195:                     }
1.664     raeburn  17196:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   17197:                              '<input type="checkbox" name="usecategory" value="'.
1.1259    raeburn  17198:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  17199:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   17200:                              '</td><td>';
1.663     raeburn  17201:                     if (ref($path) eq 'ARRAY') {
                   17202:                         push(@{$path},$name);
1.1259    raeburn  17203:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  17204:                         pop(@{$path});
                   17205:                     }
                   17206:                     $text .= '</td></tr>';
                   17207:                 }
                   17208:                 $text .= '</table></td>';
                   17209:             }
                   17210:         }
                   17211:     }
                   17212:     return $text;
                   17213: }
                   17214: 
1.1181    raeburn  17215: =pod
                   17216: 
                   17217: =back
                   17218: 
                   17219: =cut
                   17220: 
1.655     raeburn  17221: ############################################################
                   17222: ############################################################
                   17223: 
                   17224: 
1.443     albertel 17225: sub commit_customrole {
1.1408    raeburn  17226:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399    raeburn  17227:     my $result = &Apache::lonnet::assigncustomrole(
1.1408    raeburn  17228:                      $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
                   17229:                      $context,$othdomby,$requester);
1.630     raeburn  17230:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 17231:                          ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399    raeburn  17232:                          ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
                   17233:     if (wantarray) {
                   17234:         return ($output,$result);
                   17235:     } else {
                   17236:         return $output;
                   17237:     }
1.443     albertel 17238: }
                   17239: 
                   17240: sub commit_standardrole {
1.1408    raeburn  17241:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
                   17242:         $othdomby,$requester) = @_;
1.1399    raeburn  17243:     my ($output,$logmsg,$linefeed,$result);
1.541     raeburn  17244:     if ($context eq 'auto') {
                   17245:         $linefeed = "\n";
                   17246:     } else {
                   17247:         $linefeed = "<br />\n";
                   17248:     }  
1.443     albertel 17249:     if ($three eq 'st') {
1.1399    raeburn  17250:         $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408    raeburn  17251:                                       $one,$two,$sec,$context,$credits,$othdomby,
                   17252:                                       $requester);
1.541     raeburn  17253:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  17254:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   17255:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 17256:         } else {
1.541     raeburn  17257:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 17258:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  17259:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   17260:             if ($context eq 'auto') {
                   17261:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   17262:             } else {
                   17263:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   17264:                &mt('Add to classlist').': <b>ok</b>';
                   17265:             }
                   17266:             $output .= $linefeed;
1.443     albertel 17267:         }
                   17268:     } else {
                   17269:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   17270:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  17271:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408    raeburn  17272:         $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
                   17273:                                               '','',$context,$othdomby,$requester);
1.541     raeburn  17274:         if ($context eq 'auto') {
                   17275:             $output .= $result.$linefeed;
                   17276:         } else {
                   17277:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   17278:         }
1.443     albertel 17279:     }
1.1399    raeburn  17280:     if (wantarray) {
                   17281:         return ($output,$result);
                   17282:     } else {
                   17283:         return $output;
                   17284:     }
1.443     albertel 17285: }
                   17286: 
                   17287: sub commit_studentrole {
1.1116    raeburn  17288:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408    raeburn  17289:         $credits,$othdomby,$requester) = @_;
1.626     raeburn  17290:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  17291:     if ($context eq 'auto') {
                   17292:         $linefeed = "\n";
                   17293:     } else {
                   17294:         $linefeed = '<br />'."\n";
                   17295:     }
1.443     albertel 17296:     if (defined($one) && defined($two)) {
                   17297:         my $cid=$one.'_'.$two;
                   17298:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   17299:         my $secchange = 0;
                   17300:         my $expire_role_result;
                   17301:         my $modify_section_result;
1.628     raeburn  17302:         if ($oldsec ne '-1') { 
                   17303:             if ($oldsec ne $sec) {
1.443     albertel 17304:                 $secchange = 1;
1.628     raeburn  17305:                 my $now = time;
1.443     albertel 17306:                 my $uurl='/'.$cid;
                   17307:                 $uurl=~s/\_/\//g;
                   17308:                 if ($oldsec) {
                   17309:                     $uurl.='/'.$oldsec;
                   17310:                 }
1.626     raeburn  17311:                 $oldsecurl = $uurl;
1.628     raeburn  17312:                 $expire_role_result = 
1.1408    raeburn  17313:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
                   17314:                                                 '','','',$context,$othdomby,$requester);
                   17315:                 if ($env{'request.course.sec'} ne '') {
1.628     raeburn  17316:                     if ($expire_role_result eq 'refused') {
                   17317:                         my @roles = ('st');
                   17318:                         my @statuses = ('previous');
                   17319:                         my @roledoms = ($one);
                   17320:                         my $withsec = 1;
                   17321:                         my %roleshash = 
                   17322:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   17323:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   17324:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   17325:                             my ($oldstart,$oldend) = 
                   17326:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   17327:                             if ($oldend > 0 && $oldend <= $now) {
                   17328:                                 $expire_role_result = 'ok';
                   17329:                             }
                   17330:                         }
                   17331:                     }
                   17332:                 }
1.443     albertel 17333:                 $result = $expire_role_result;
                   17334:             }
                   17335:         }
                   17336:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116    raeburn  17337:             $modify_section_result = 
                   17338:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   17339:                                                            undef,undef,undef,$sec,
                   17340:                                                            $end,$start,'','',$cid,
1.1408    raeburn  17341:                                                            '',$context,$credits,'',
                   17342:                                                            $othdomby,$requester);
1.443     albertel 17343:             if ($modify_section_result =~ /^ok/) {
                   17344:                 if ($secchange == 1) {
1.628     raeburn  17345:                     if ($sec eq '') {
                   17346:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   17347:                     } else {
                   17348:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   17349:                     }
1.443     albertel 17350:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  17351:                     if ($sec eq '') {
                   17352:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   17353:                     } else {
                   17354:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   17355:                     }
1.443     albertel 17356:                 } else {
1.628     raeburn  17357:                     if ($sec eq '') {
                   17358:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   17359:                     } else {
                   17360:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   17361:                     }
1.443     albertel 17362:                 }
                   17363:             } else {
1.1115    raeburn  17364:                 if ($secchange) { 
1.628     raeburn  17365:                     $$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;
                   17366:                 } else {
                   17367:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   17368:                 }
1.443     albertel 17369:             }
                   17370:             $result = $modify_section_result;
                   17371:         } elsif ($secchange == 1) {
1.628     raeburn  17372:             if ($oldsec eq '') {
1.1103    raeburn  17373:                 $$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  17374:             } else {
                   17375:                 $$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;
                   17376:             }
1.626     raeburn  17377:             if ($expire_role_result eq 'refused') {
                   17378:                 my $newsecurl = '/'.$cid;
                   17379:                 $newsecurl =~ s/\_/\//g;
                   17380:                 if ($sec ne '') {
                   17381:                     $newsecurl.='/'.$sec;
                   17382:                 }
                   17383:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   17384:                     if ($sec eq '') {
                   17385:                         $$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;
                   17386:                     } else {
                   17387:                         $$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;
                   17388:                     }
                   17389:                 }
                   17390:             }
1.443     albertel 17391:         }
                   17392:     } else {
1.626     raeburn  17393:         $$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 17394:         $result = "error: incomplete course id\n";
                   17395:     }
                   17396:     return $result;
                   17397: }
                   17398: 
1.1108    raeburn  17399: sub show_role_extent {
                   17400:     my ($scope,$context,$role) = @_;
                   17401:     $scope =~ s{^/}{};
                   17402:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   17403:     push(@courseroles,'co');
                   17404:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   17405:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   17406:         $scope =~ s{/}{_};
                   17407:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   17408:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   17409:         my ($audom,$auname) = split(/\//,$scope);
                   17410:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   17411:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   17412:     } else {
                   17413:         $scope =~ s{/$}{};
                   17414:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   17415:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   17416:     }
                   17417: }
                   17418: 
1.443     albertel 17419: ############################################################
                   17420: ############################################################
                   17421: 
1.566     albertel 17422: sub check_clone {
1.578     raeburn  17423:     my ($args,$linefeed) = @_;
1.566     albertel 17424:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   17425:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   17426:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344    raeburn  17427:     my $clonetitle;
                   17428:     my @clonemsg;
1.566     albertel 17429:     my $can_clone = 0;
1.944     raeburn  17430:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  17431:     if ($lctype ne 'community') {
                   17432:         $lctype = 'course';
                   17433:     }
1.566     albertel 17434:     if ($clonehome eq 'no_host') {
1.944     raeburn  17435:         if ($args->{'crstype'} eq 'Community') {
1.1344    raeburn  17436:             push(@clonemsg,({
                   17437:                               mt => 'No new community created.',
                   17438:                               args => [],
                   17439:                             },
                   17440:                             {
                   17441:                               mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
                   17442:                               args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
                   17443:                             }));
1.908     raeburn  17444:         } else {
1.1344    raeburn  17445:             push(@clonemsg,({
                   17446:                               mt => 'No new course created.',
                   17447:                               args => [],
                   17448:                             },
                   17449:                             {
                   17450:                               mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
                   17451:                               args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   17452:                             }));
                   17453:         }
1.566     albertel 17454:     } else {
                   17455: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344    raeburn  17456:         $clonetitle = $clonedesc{'description'};
1.944     raeburn  17457:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  17458:             if ($clonedesc{'type'} ne 'Community') {
1.1344    raeburn  17459:                 push(@clonemsg,({
                   17460:                                   mt => 'No new community created.',
                   17461:                                   args => [],
                   17462:                                 },
                   17463:                                 {
                   17464:                                   mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
                   17465:                                   args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   17466:                                 }));
                   17467:                 return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908     raeburn  17468:             }
                   17469:         }
1.1262    raeburn  17470: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  17471:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 17472: 	    $can_clone = 1;
                   17473: 	} else {
1.1221    raeburn  17474: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 17475: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1221    raeburn  17476:             if ($clonehash{'cloners'} eq '') {
                   17477:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   17478:                 if ($domdefs{'canclone'}) {
                   17479:                     unless ($domdefs{'canclone'} eq 'none') {
                   17480:                         if ($domdefs{'canclone'} eq 'domain') {
                   17481:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   17482:                                 $can_clone = 1;
                   17483:                             }
                   17484:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) && 
                   17485:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   17486:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   17487:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   17488:                                 $can_clone = 1;
                   17489:                             }
                   17490:                         }
                   17491:                     }
                   17492:                 }
1.578     raeburn  17493:             } else {
1.1221    raeburn  17494: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   17495:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  17496:                     $can_clone = 1;
1.1221    raeburn  17497:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  17498:                     $can_clone = 1;
1.1225    raeburn  17499:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   17500:                     $can_clone = 1;
1.1221    raeburn  17501:                 }
                   17502:                 unless ($can_clone) {
1.1225    raeburn  17503:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) && 
                   17504:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1221    raeburn  17505:                         my (%gotdomdefaults,%gotcodedefaults);
                   17506:                         foreach my $cloner (@cloners) {
                   17507:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   17508:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   17509:                                 my (%codedefaults,@code_order);
                   17510:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   17511:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   17512:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   17513:                                     }
                   17514:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   17515:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   17516:                                     }
                   17517:                                 } else {
                   17518:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   17519:                                                                             \%codedefaults,
                   17520:                                                                             \@code_order);
                   17521:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   17522:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   17523:                                 }
                   17524:                                 if (@code_order > 0) {
                   17525:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   17526:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   17527:                                                                                 $args->{'crscode'})) {
                   17528:                                         $can_clone = 1;
                   17529:                                         last;
                   17530:                                     }
                   17531:                                 }
                   17532:                             }
                   17533:                         }
                   17534:                     }
1.1225    raeburn  17535:                 }
                   17536:             }
                   17537:             unless ($can_clone) {
                   17538:                 my $ccrole = 'cc';
                   17539:                 if ($args->{'crstype'} eq 'Community') {
                   17540:                     $ccrole = 'co';
                   17541:                 }
                   17542: 	        my %roleshash =
                   17543: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   17544: 					          $args->{'ccdomain'},
                   17545:                                                   'userroles',['active'],[$ccrole],
                   17546: 					          [$args->{'clonedomain'}]);
                   17547: 	        if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   17548:                     $can_clone = 1;
                   17549:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   17550:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   17551:                     $can_clone = 1;
1.1221    raeburn  17552:                 }
                   17553:             }
                   17554:             unless ($can_clone) {
                   17555:                 if ($args->{'crstype'} eq 'Community') {
1.1344    raeburn  17556:                     push(@clonemsg,({
                   17557:                                       mt => 'No new community created.',
                   17558:                                       args => [],
                   17559:                                     },
                   17560:                                     {
                   17561:                                       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]).',
                   17562:                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   17563:                                     }));
1.942     raeburn  17564:                 } else {
1.1344    raeburn  17565:                     push(@clonemsg,({
                   17566:                                       mt => 'No new course created.',
                   17567:                                       args => [],
                   17568:                                     },
                   17569:                                     {
                   17570:                                       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]).',
                   17571:                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   17572:                                     }));
1.1221    raeburn  17573:                 }
1.566     albertel 17574: 	    }
1.578     raeburn  17575:         }
1.566     albertel 17576:     }
1.1344    raeburn  17577:     return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566     albertel 17578: }
                   17579: 
1.444     albertel 17580: sub construct_course {
1.1262    raeburn  17581:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344    raeburn  17582:         $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
                   17583:     my ($outcome,$msgref,$clonemsgref);
1.541     raeburn  17584:     my $linefeed =  '<br />'."\n";
                   17585:     if ($context eq 'auto') {
                   17586:         $linefeed = "\n";
                   17587:     }
1.566     albertel 17588: 
                   17589: #
                   17590: # Are we cloning?
                   17591: #
1.1344    raeburn  17592:     my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566     albertel 17593:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344    raeburn  17594: 	($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566     albertel 17595:         if (!$can_clone) {
1.1344    raeburn  17596: 	    return (0,$outcome,$clonemsgref);
1.566     albertel 17597: 	}
                   17598:     }
                   17599: 
1.444     albertel 17600: #
                   17601: # Open course
                   17602: #
1.1239    raeburn  17603:     my $showncrstype;
                   17604:     if ($args->{'crstype'} eq 'Placement') {
                   17605:         $showncrstype = 'placement test'; 
                   17606:     } else {  
                   17607:         $showncrstype = lc($args->{'crstype'});
                   17608:     }
1.444     albertel 17609:     my %cenv=();
                   17610:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   17611:                                              $args->{'cdescr'},
                   17612:                                              $args->{'curl'},
                   17613:                                              $args->{'course_home'},
                   17614:                                              $args->{'nonstandard'},
                   17615:                                              $args->{'crscode'},
                   17616:                                              $args->{'ccuname'}.':'.
                   17617:                                              $args->{'ccdomain'},
1.882     raeburn  17618:                                              $args->{'crstype'},
1.1344    raeburn  17619:                                              $cnum,$context,$category,
                   17620:                                              $callercontext);
1.444     albertel 17621: 
                   17622:     # Note: The testing routines depend on this being output; see 
                   17623:     # Utils::Course. This needs to at least be output as a comment
                   17624:     # if anyone ever decides to not show this, and Utils::Course::new
                   17625:     # will need to be suitably modified.
1.1344    raeburn  17626:     if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   17627:         $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
                   17628:     } else {
                   17629:         $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
                   17630:     }
1.943     raeburn  17631:     if ($$courseid =~ /^error:/) {
1.1344    raeburn  17632:         return (0,$outcome,$clonemsgref);
1.943     raeburn  17633:     }
                   17634: 
1.444     albertel 17635: #
                   17636: # Check if created correctly
                   17637: #
1.479     albertel 17638:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 17639:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  17640:     if ($crsuhome eq 'no_host') {
1.1344    raeburn  17641:         if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   17642:             $outcome .= &mt_user($user_lh,
                   17643:                             'Course creation failed, unrecognized course home server.');
                   17644:         } else {
                   17645:             $outcome .= &mt('Course creation failed, unrecognized course home server.');
                   17646:         }
                   17647:         $outcome .= $linefeed;
                   17648:         return (0,$outcome,$clonemsgref);
1.943     raeburn  17649:     }
1.541     raeburn  17650:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 17651: 
1.444     albertel 17652: #
1.566     albertel 17653: # Do the cloning
                   17654: #   
1.1344    raeburn  17655:     my @clonemsg;
1.566     albertel 17656:     if ($can_clone && $cloneid) {
1.1344    raeburn  17657:         push(@clonemsg,
                   17658:                       {
                   17659:                           mt => 'Created [_1] by cloning from [_2]',
                   17660:                           args => [$showncrstype,$clonetitle],
                   17661:                       });
1.566     albertel 17662: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 17663: # Copy all files
1.1344    raeburn  17664:         my @info =
                   17665: 	    &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
                   17666: 	                                             $args->{'dateshift'},$args->{'crscode'},
                   17667:                                                      $args->{'ccuname'}.':'.$args->{'ccdomain'},
                   17668:                                                      $args->{'tinyurls'});
                   17669:         if (@info) {
                   17670:             push(@clonemsg,@info);
                   17671:         }
1.444     albertel 17672: # Restore URL
1.566     albertel 17673: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 17674: # Restore title
1.566     albertel 17675: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  17676: # Restore creation date, creator and creation context.
                   17677:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   17678:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   17679:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 17680: # Mark as cloned
1.566     albertel 17681: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      17682: # Need to clone grading mode
                   17683:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   17684:         $cenv{'grading'}=$newenv{'grading'};
                   17685: # Do not clone these environment entries
                   17686:         &Apache::lonnet::del('environment',
                   17687:                   ['default_enrollment_start_date',
                   17688:                    'default_enrollment_end_date',
                   17689:                    'question.email',
                   17690:                    'policy.email',
                   17691:                    'comment.email',
                   17692:                    'pch.users.denied',
1.725     raeburn  17693:                    'plc.users.denied',
                   17694:                    'hidefromcat',
1.1121    raeburn  17695:                    'checkforpriv',
1.1355    raeburn  17696:                    'categories'],
1.638     www      17697:                    $$crsudom,$$crsunum);
1.1170    raeburn  17698:         if ($args->{'textbook'}) {
                   17699:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   17700:         }
1.444     albertel 17701:     }
1.566     albertel 17702: 
1.444     albertel 17703: #
                   17704: # Set environment (will override cloned, if existing)
                   17705: #
                   17706:     my @sections = ();
                   17707:     my @xlists = ();
                   17708:     if ($args->{'crstype'}) {
                   17709:         $cenv{'type'}=$args->{'crstype'};
                   17710:     }
1.1371    raeburn  17711:     if ($args->{'lti'}) {
                   17712:         $cenv{'internal.lti'}=$args->{'lti'};
                   17713:     }
1.444     albertel 17714:     if ($args->{'crsid'}) {
                   17715:         $cenv{'courseid'}=$args->{'crsid'};
                   17716:     }
                   17717:     if ($args->{'crscode'}) {
                   17718:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   17719:     }
                   17720:     if ($args->{'crsquota'} ne '') {
                   17721:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   17722:     } else {
                   17723:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   17724:     }
                   17725:     if ($args->{'ccuname'}) {
                   17726:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   17727:                                         ':'.$args->{'ccdomain'};
                   17728:     } else {
                   17729:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   17730:     }
1.1116    raeburn  17731:     if ($args->{'defaultcredits'}) {
                   17732:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   17733:     }
1.444     albertel 17734:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412    raeburn  17735:     my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444     albertel 17736:     if ($args->{'crssections'}) {
                   17737:         $cenv{'internal.sectionnums'} = '';
                   17738:         if ($args->{'crssections'} =~ m/,/) {
                   17739:             @sections = split/,/,$args->{'crssections'};
                   17740:         } else {
                   17741:             $sections[0] = $args->{'crssections'};
                   17742:         }
                   17743:         if (@sections > 0) {
                   17744:             foreach my $item (@sections) {
                   17745:                 my ($sec,$gp) = split/:/,$item;
                   17746:                 my $class = $args->{'crscode'}.$sec;
                   17747:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   17748:                 $cenv{'internal.sectionnums'} .= $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,$class);
1.444     albertel 17755:                 }
                   17756:             }
                   17757:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   17758:         }
                   17759:     }
                   17760: # do not hide course coordinator from staff listing, 
                   17761: # even if privileged
                   17762:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121    raeburn  17763: # add course coordinator's domain to domains to check for privileged users
                   17764: # if different to course domain
                   17765:     if ($$crsudom ne $args->{'ccdomain'}) {
                   17766:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   17767:     }
1.444     albertel 17768: # add crosslistings
                   17769:     if ($args->{'crsxlist'}) {
                   17770:         $cenv{'internal.crosslistings'}='';
                   17771:         if ($args->{'crsxlist'} =~ m/,/) {
                   17772:             @xlists = split/,/,$args->{'crsxlist'};
                   17773:         } else {
                   17774:             $xlists[0] = $args->{'crsxlist'};
                   17775:         }
                   17776:         if (@xlists > 0) {
                   17777:             foreach my $item (@xlists) {
                   17778:                 my ($xl,$gp) = split/:/,$item;
                   17779:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   17780:                 $cenv{'internal.crosslistings'} .= $item.',';
1.1412    raeburn  17781:                 if ($addcheck eq 'ok') {
                   17782:                     unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
                   17783:                         push(@oklcsecs,$gp);
                   17784:                     }
                   17785:                 } else {
1.1263    raeburn  17786:                     push(@badclasses,$xl);
1.444     albertel 17787:                 }
                   17788:             }
                   17789:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   17790:         }
                   17791:     }
                   17792:     if ($args->{'autoadds'}) {
                   17793:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   17794:     }
                   17795:     if ($args->{'autodrops'}) {
                   17796:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   17797:     }
                   17798: # check for notification of enrollment changes
                   17799:     my @notified = ();
                   17800:     if ($args->{'notify_owner'}) {
                   17801:         if ($args->{'ccuname'} ne '') {
                   17802:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   17803:         }
                   17804:     }
                   17805:     if ($args->{'notify_dc'}) {
                   17806:         if ($uname ne '') { 
1.630     raeburn  17807:             push(@notified,$uname.':'.$udom);
1.444     albertel 17808:         }
                   17809:     }
                   17810:     if (@notified > 0) {
                   17811:         my $notifylist;
                   17812:         if (@notified > 1) {
                   17813:             $notifylist = join(',',@notified);
                   17814:         } else {
                   17815:             $notifylist = $notified[0];
                   17816:         }
                   17817:         $cenv{'internal.notifylist'} = $notifylist;
                   17818:     }
                   17819:     if (@badclasses > 0) {
                   17820:         my %lt=&Apache::lonlocal::texthash(
1.1264    raeburn  17821:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   17822:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   17823:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 17824:         );
1.1264    raeburn  17825:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   17826:                            &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  17827:         if ($context eq 'auto') {
                   17828:             $outcome .= $badclass_msg.$linefeed;
1.1261    raeburn  17829:         } else {
1.566     albertel 17830:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261    raeburn  17831:         }
                   17832:         foreach my $item (@badclasses) {
1.541     raeburn  17833:             if ($context eq 'auto') {
1.1261    raeburn  17834:                 $outcome .= " - $item\n";
1.541     raeburn  17835:             } else {
1.1261    raeburn  17836:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  17837:             }
1.1261    raeburn  17838:         }
                   17839:         if ($context eq 'auto') {
                   17840:             $outcome .= $linefeed;
                   17841:         } else {
                   17842:             $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  17843:         } 
1.444     albertel 17844:     }
                   17845:     if ($args->{'no_end_date'}) {
                   17846:         $args->{'endaccess'} = 0;
                   17847:     }
1.1412    raeburn  17848: #  If an official course with institutional sections is created by cloning 
                   17849: #  an existing course, section-specific hiding of course totals in student's
                   17850: #  view of grades as copied from cloned course, will be checked for valid 
                   17851: #  sections.
                   17852:     if (($can_clone && $cloneid) &&
                   17853:         ($cenv{'internal.coursecode'} ne '') &&
                   17854:         ($cenv{'grading'} eq 'standard') &&
                   17855:         ($cenv{'hidetotals'} ne '') &&
                   17856:         ($cenv{'hidetotals'} ne 'all')) {
                   17857:         my @hidesecs;
                   17858:         my $deletehidetotals;
                   17859:         if (@oklcsecs) {
                   17860:             foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
                   17861:                 if (grep(/^\Q$sec$/,@oklcsecs)) {
                   17862:                     push(@hidesecs,$sec);
                   17863:                 }
                   17864:             }
                   17865:             if (@hidesecs) {
                   17866:                 $cenv{'hidetotals'} = join(',',@hidesecs);
                   17867:             } else {
                   17868:                 $deletehidetotals = 1;
                   17869:             }
                   17870:         } else {
                   17871:             $deletehidetotals = 1;
                   17872:         }
                   17873:         if ($deletehidetotals) {
                   17874:             delete($cenv{'hidetotals'});
                   17875:             &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
                   17876:         }
                   17877:     }
1.444     albertel 17878:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   17879:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   17880:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   17881:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   17882:     if ($args->{'showphotos'}) {
                   17883:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   17884:     }
                   17885:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   17886:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   17887:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   17888:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  17889:             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'); 
                   17890:             if ($context eq 'auto') {
                   17891:                 $outcome .= $krb_msg;
                   17892:             } else {
1.566     albertel 17893:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  17894:             }
                   17895:             $outcome .= $linefeed;
1.444     albertel 17896:         }
                   17897:     }
                   17898:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   17899:        if ($args->{'setpolicy'}) {
                   17900:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   17901:        }
                   17902:        if ($args->{'setcontent'}) {
                   17903:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   17904:        }
1.1251    raeburn  17905:        if ($args->{'setcomment'}) {
                   17906:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   17907:        }
1.444     albertel 17908:     }
                   17909:     if ($args->{'reshome'}) {
                   17910: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   17911: 	$cenv{'reshome'}=~s/\/+$/\//;
                   17912:     }
                   17913: #
                   17914: # course has keyed access
                   17915: #
                   17916:     if ($args->{'setkeys'}) {
                   17917:        $cenv{'keyaccess'}='yes';
                   17918:     }
                   17919: # if specified, key authority is not course, but user
                   17920: # only active if keyaccess is yes
                   17921:     if ($args->{'keyauth'}) {
1.487     albertel 17922: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   17923: 	$user = &LONCAPA::clean_username($user);
                   17924: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     17925: 	if ($user ne '' && $domain ne '') {
1.487     albertel 17926: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 17927: 	}
                   17928:     }
                   17929: 
1.1166    raeburn  17930: #
1.1167    raeburn  17931: #  generate and store uniquecode (available to course requester), if course should have one.
1.1166    raeburn  17932: #
                   17933:     if ($args->{'uniquecode'}) {
                   17934:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   17935:         if ($code) {
                   17936:             $cenv{'internal.uniquecode'} = $code;
1.1167    raeburn  17937:             my %crsinfo =
                   17938:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   17939:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   17940:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   17941:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   17942:             } 
1.1166    raeburn  17943:             if (ref($coderef)) {
                   17944:                 $$coderef = $code;
                   17945:             }
                   17946:         }
                   17947:     }
                   17948: 
1.444     albertel 17949:     if ($args->{'disresdis'}) {
                   17950:         $cenv{'pch.roles.denied'}='st';
                   17951:     }
                   17952:     if ($args->{'disablechat'}) {
                   17953:         $cenv{'plc.roles.denied'}='st';
                   17954:     }
                   17955: 
                   17956:     # Record we've not yet viewed the Course Initialization Helper for this 
                   17957:     # course
                   17958:     $cenv{'course.helper.not.run'} = 1;
                   17959:     #
                   17960:     # Use new Randomseed
                   17961:     #
                   17962:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   17963:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   17964:     #
                   17965:     # The encryption code and receipt prefix for this course
                   17966:     #
                   17967:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   17968:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   17969:     #
                   17970:     # By default, use standard grading
                   17971:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   17972: 
1.541     raeburn  17973:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   17974:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 17975: #
                   17976: # Open all assignments
                   17977: #
                   17978:     if ($args->{'openall'}) {
1.1341    raeburn  17979:        my $opendate = time;
                   17980:        if ($args->{'openallfrom'} =~ /^\d+$/) {
                   17981:            $opendate = $args->{'openallfrom'};
                   17982:        }
1.444     albertel 17983:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341    raeburn  17984:        my %storecontent = ($storeunder         => $opendate,
1.444     albertel 17985:                            $storeunder.'.type' => 'date_start');
1.1341    raeburn  17986:        $outcome .= &mt('All assignments open starting [_1]',
                   17987:                        &Apache::lonlocal::locallocaltime($opendate)).': '.
                   17988:                    &Apache::lonnet::cput
                   17989:                        ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 17990:    }
                   17991: #
                   17992: # Set first page
                   17993: #
                   17994:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   17995: 	    || ($cloneid)) {
                   17996: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 17997: 
                   17998: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   17999:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   18000: 
1.444     albertel 18001:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   18002:         my $title; my $url;
                   18003:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   18004: 	    $title=&mt('Syllabus');
1.444     albertel 18005:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   18006:         } else {
1.963     raeburn  18007:             $title=&mt('Table of Contents');
1.444     albertel 18008:             $url='/adm/navmaps';
                   18009:         }
1.445     albertel 18010: 
                   18011:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   18012: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   18013: 
                   18014: 	if ($errtext) { $fatal=2; }
1.541     raeburn  18015:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 18016:     }
1.566     albertel 18017: 
1.1237    raeburn  18018: # 
                   18019: # Set params for Placement Tests
                   18020: #
1.1239    raeburn  18021:     if ($args->{'crstype'} eq 'Placement') {
                   18022:        my %storecontent; 
                   18023:        my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
                   18024:        my %defaults = (
                   18025:                         buttonshide   => { value => 'yes',
                   18026:                                            type => 'string_yesno',},
                   18027:                         type          => { value => 'randomizetry',
                   18028:                                            type  => 'string_questiontype',},
                   18029:                         maxtries      => { value => 1,
                   18030:                                            type => 'int_pos',},
                   18031:                         problemstatus => { value => 'no',
                   18032:                                            type  => 'string_problemstatus',},
                   18033:                       );
                   18034:        foreach my $key (keys(%defaults)) {
                   18035:            $storecontent{$prefix.$key} = $defaults{$key}{'value'};
                   18036:            $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
                   18037:        }
1.1237    raeburn  18038:        &Apache::lonnet::cput
                   18039:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum); 
                   18040:     }
                   18041: 
1.1344    raeburn  18042:     return (1,$outcome,\@clonemsg);
1.444     albertel 18043: }
                   18044: 
1.1166    raeburn  18045: sub make_unique_code {
                   18046:     my ($cdom,$cnum) = @_;
                   18047:     # get lock on uniquecodes db
                   18048:     my $lockhash = {
                   18049:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   18050:                                                   ':'.$env{'user.domain'},
                   18051:                    };
                   18052:     my $tries = 0;
                   18053:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   18054:     my ($code,$error);
                   18055:   
                   18056:     while (($gotlock ne 'ok') && ($tries<3)) {
                   18057:         $tries ++;
                   18058:         sleep 1;
                   18059:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   18060:     }
                   18061:     if ($gotlock eq 'ok') {
                   18062:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   18063:         my $gotcode;
                   18064:         my $attempts = 0;
                   18065:         while ((!$gotcode) && ($attempts < 100)) {
                   18066:             $code = &generate_code();
                   18067:             if (!exists($currcodes{$code})) {
                   18068:                 $gotcode = 1;
                   18069:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   18070:                     $error = 'nostore';
                   18071:                 }
                   18072:             }
                   18073:             $attempts ++;
                   18074:         }
                   18075:         my @del_lock = ($cnum."\0".'uniquecodes');
                   18076:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   18077:     } else {
                   18078:         $error = 'nolock';
                   18079:     }
                   18080:     return ($code,$error);
                   18081: }
                   18082: 
                   18083: sub generate_code {
                   18084:     my $code;
                   18085:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   18086:     for (my $i=0; $i<6; $i++) {
                   18087:         my $lettnum = int (rand 2);
                   18088:         my $item = '';
                   18089:         if ($lettnum) {
                   18090:             $item = $letts[int( rand(18) )];
                   18091:         } else {
                   18092:             $item = 1+int( rand(8) );
                   18093:         }
                   18094:         $code .= $item;
                   18095:     }
                   18096:     return $code;
                   18097: }
                   18098: 
1.444     albertel 18099: ############################################################
                   18100: ############################################################
                   18101: 
1.1237    raeburn  18102: # Community, Course and Placement Test
1.378     raeburn  18103: sub course_type {
                   18104:     my ($cid) = @_;
                   18105:     if (!defined($cid)) {
                   18106:         $cid = $env{'request.course.id'};
                   18107:     }
1.404     albertel 18108:     if (defined($env{'course.'.$cid.'.type'})) {
                   18109:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  18110:     } else {
                   18111:         return 'Course';
1.377     raeburn  18112:     }
                   18113: }
1.156     albertel 18114: 
1.406     raeburn  18115: sub group_term {
                   18116:     my $crstype = &course_type();
                   18117:     my %names = (
                   18118:                   'Course' => 'group',
1.865     raeburn  18119:                   'Community' => 'group',
1.1237    raeburn  18120:                   'Placement' => 'group',
1.406     raeburn  18121:                 );
                   18122:     return $names{$crstype};
                   18123: }
                   18124: 
1.902     raeburn  18125: sub course_types {
1.1310    raeburn  18126:     my @types = ('official','unofficial','community','textbook','placement','lti');
1.902     raeburn  18127:     my %typename = (
                   18128:                          official   => 'Official course',
                   18129:                          unofficial => 'Unofficial course',
                   18130:                          community  => 'Community',
1.1165    raeburn  18131:                          textbook   => 'Textbook course',
1.1237    raeburn  18132:                          placement  => 'Placement test',
1.1310    raeburn  18133:                          lti        => 'LTI provider',
1.902     raeburn  18134:                    );
                   18135:     return (\@types,\%typename);
                   18136: }
                   18137: 
1.156     albertel 18138: sub icon {
                   18139:     my ($file)=@_;
1.505     albertel 18140:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 18141:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 18142:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 18143:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   18144: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   18145: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   18146: 	            $curfext.".gif") {
                   18147: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   18148: 		$curfext.".gif";
                   18149: 	}
                   18150:     }
1.249     albertel 18151:     return &lonhttpdurl($iconname);
1.154     albertel 18152: } 
1.84      albertel 18153: 
1.575     albertel 18154: sub lonhttpdurl {
1.692     www      18155: #
                   18156: # Had been used for "small fry" static images on separate port 8080.
                   18157: # Modify here if lightweight http functionality desired again.
                   18158: # Currently eliminated due to increasing firewall issues.
                   18159: #
1.575     albertel 18160:     my ($url)=@_;
1.692     www      18161:     return $url;
1.215     albertel 18162: }
                   18163: 
1.213     albertel 18164: sub connection_aborted {
                   18165:     my ($r)=@_;
                   18166:     $r->print(" ");$r->rflush();
                   18167:     my $c = $r->connection;
                   18168:     return $c->aborted();
                   18169: }
                   18170: 
1.221     foxr     18171: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     18172: #    strings as 'strings'.
                   18173: sub escape_single {
1.221     foxr     18174:     my ($input) = @_;
1.223     albertel 18175:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     18176:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   18177:     return $input;
                   18178: }
1.223     albertel 18179: 
1.222     foxr     18180: #  Same as escape_single, but escape's "'s  This 
                   18181: #  can be used for  "strings"
                   18182: sub escape_double {
                   18183:     my ($input) = @_;
                   18184:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   18185:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   18186:     return $input;
                   18187: }
1.223     albertel 18188:  
1.222     foxr     18189: #   Escapes the last element of a full URL.
                   18190: sub escape_url {
                   18191:     my ($url)   = @_;
1.238     raeburn  18192:     my @urlslices = split(/\//, $url,-1);
1.369     www      18193:     my $lastitem = &escape(pop(@urlslices));
1.1203    raeburn  18194:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     18195: }
1.462     albertel 18196: 
1.820     raeburn  18197: sub compare_arrays {
                   18198:     my ($arrayref1,$arrayref2) = @_;
                   18199:     my (@difference,%count);
                   18200:     @difference = ();
                   18201:     %count = ();
                   18202:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   18203:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   18204:         foreach my $element (keys(%count)) {
                   18205:             if ($count{$element} == 1) {
                   18206:                 push(@difference,$element);
                   18207:             }
                   18208:         }
                   18209:     }
                   18210:     return @difference;
                   18211: }
                   18212: 
1.1322    raeburn  18213: sub lon_status_items {
                   18214:     my %defaults = (
                   18215:                      E         => 100,
                   18216:                      W         => 4,
                   18217:                      N         => 1,
1.1324    raeburn  18218:                      U         => 5,
1.1322    raeburn  18219:                      threshold => 200,
                   18220:                      sysmail   => 2500,
                   18221:                    );
                   18222:     my %names = (
                   18223:                    E => 'Errors',
                   18224:                    W => 'Warnings',
                   18225:                    N => 'Notices',
1.1324    raeburn  18226:                    U => 'Unsent',
1.1322    raeburn  18227:                 );
                   18228:     return (\%defaults,\%names);
                   18229: }
                   18230: 
1.817     bisitz   18231: # -------------------------------------------------------- Initialize user login
1.462     albertel 18232: sub init_user_environment {
1.463     albertel 18233:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 18234:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   18235: 
                   18236:     my $public=($username eq 'public' && $domain eq 'public');
                   18237: 
1.1415    raeburn  18238:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
                   18239:         $coauthorenv);
1.462     albertel 18240:     my $now=time;
                   18241: 
                   18242:     if ($public) {
                   18243: 	my $max_public=100;
                   18244: 	my $oldest;
                   18245: 	my $oldest_time=0;
                   18246: 	for(my $next=1;$next<=$max_public;$next++) {
                   18247: 	    if (-e $lonids."/publicuser_$next.id") {
                   18248: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   18249: 		if ($mtime<$oldest_time || !$oldest_time) {
                   18250: 		    $oldest_time=$mtime;
                   18251: 		    $oldest=$next;
                   18252: 		}
                   18253: 	    } else {
                   18254: 		$cookie="publicuser_$next";
                   18255: 		last;
                   18256: 	    }
                   18257: 	}
                   18258: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   18259:     } else {
1.1275    raeburn  18260: 	# See if old ID present, if so, remove if this isn't a robot,
                   18261: 	# killing any existing non-robot sessions
1.463     albertel 18262: 	if (!$args->{'robot'}) {
                   18263: 	    opendir(DIR,$lonids);
                   18264: 	    while ($filename=readdir(DIR)) {
                   18265: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320    raeburn  18266:                     if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
                   18267:                             &GDBM_READER(),0640)) {
1.1295    raeburn  18268:                         my $linkedfile;
1.1320    raeburn  18269:                         if (exists($oldenv{'user.linkedenv'})) {
                   18270:                             $linkedfile = $oldenv{'user.linkedenv'};
1.1295    raeburn  18271:                         }
1.1320    raeburn  18272:                         untie(%oldenv);
                   18273:                         if (unlink("$lonids/$filename")) {
                   18274:                             if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                   18275:                                 if (-l "$lonids/$linkedfile.id") {
                   18276:                                     unlink("$lonids/$linkedfile.id");
                   18277:                                 }
1.1295    raeburn  18278:                             }
                   18279:                         }
                   18280:                     } else {
                   18281:                         unlink($lonids.'/'.$filename);
                   18282:                     }
1.463     albertel 18283: 		}
1.462     albertel 18284: 	    }
1.463     albertel 18285: 	    closedir(DIR);
1.1204    raeburn  18286: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   18287:             my $namespace = 'nohist_courseeditor';
                   18288:             my $lockingkey = 'paste'."\0".'locked_num';
                   18289:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   18290:                                                 $domain,$username);
                   18291:             if (exists($lockhash{$lockingkey})) {
                   18292:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   18293:                 unless ($delresult eq 'ok') {
                   18294:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   18295:                 }
                   18296:             }
1.462     albertel 18297: 	}
                   18298: # Give them a new cookie
1.463     albertel 18299: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      18300: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 18301: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 18302:     
                   18303: # Initialize roles
                   18304: 
1.1414    raeburn  18305: 	($userroles,$firstaccenv,$timerintenv,$coauthorenv) = 
1.1062    raeburn  18306:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 18307:     }
                   18308: # ------------------------------------ Check browser type and MathML capability
                   18309: 
1.1194    raeburn  18310:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   18311:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 18312: 
                   18313: # ------------------------------------------------------------- Get environment
                   18314: 
                   18315:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   18316:     my ($tmp) = keys(%userenv);
1.1275    raeburn  18317:     if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462     albertel 18318: 	undef(%userenv);
                   18319:     }
                   18320:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   18321: 	$form->{'interface'}=$userenv{'interface'};
                   18322:     }
                   18323:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   18324: 
                   18325: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   18326:     foreach my $option ('interface','localpath','localres') {
                   18327:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 18328:     }
                   18329: # --------------------------------------------------------- Write first profile
                   18330: 
                   18331:     {
1.1350    raeburn  18332:         my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462     albertel 18333: 	my %initial_env = 
                   18334: 	    ("user.name"          => $username,
                   18335: 	     "user.domain"        => $domain,
                   18336: 	     "user.home"          => $authhost,
                   18337: 	     "browser.type"       => $clientbrowser,
                   18338: 	     "browser.version"    => $clientversion,
                   18339: 	     "browser.mathml"     => $clientmathml,
                   18340: 	     "browser.unicode"    => $clientunicode,
                   18341: 	     "browser.os"         => $clientos,
1.1137    raeburn  18342:              "browser.mobile"     => $clientmobile,
1.1141    raeburn  18343:              "browser.info"       => $clientinfo,
1.1194    raeburn  18344:              "browser.osversion"  => $clientosversion,
1.462     albertel 18345: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   18346: 	     "request.course.fn"  => '',
                   18347: 	     "request.course.uri" => '',
                   18348: 	     "request.course.sec" => '',
                   18349: 	     "request.role"       => 'cm',
                   18350: 	     "request.role.adv"   => $env{'user.adv'},
1.1350    raeburn  18351: 	     "request.host"       => $ip,);
1.462     albertel 18352: 
                   18353:         if ($form->{'localpath'}) {
                   18354: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   18355: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   18356:         }
                   18357: 	
                   18358: 	if ($form->{'interface'}) {
                   18359: 	    $form->{'interface'}=~s/\W//gs;
                   18360: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   18361: 	    $env{'browser.interface'}=$form->{'interface'};
                   18362: 	}
                   18363: 
1.1157    raeburn  18364:         if ($form->{'iptoken'}) {
                   18365:             my $lonhost = $r->dir_config('lonHostID');
                   18366:             $initial_env{"user.noloadbalance"} = $lonhost;
                   18367:             $env{'user.noloadbalance'} = $lonhost;
                   18368:         }
                   18369: 
1.1268    raeburn  18370:         if ($form->{'noloadbalance'}) {
                   18371:             my @hosts = &Apache::lonnet::current_machine_ids();
                   18372:             my $hosthere = $form->{'noloadbalance'};
                   18373:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   18374:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   18375:                 $env{'user.noloadbalance'} = $hosthere;
                   18376:             }
                   18377:         }
                   18378: 
1.1016    raeburn  18379:         unless ($domain eq 'public') {
1.1273    raeburn  18380:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   18381:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
                   18382: 
1.1414    raeburn  18383:             foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
                   18384:                 $userenv{'availabletools.'.$tool} =
1.1273    raeburn  18385:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   18386:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   18387:             }
1.980     raeburn  18388: 
1.1311    raeburn  18389:             foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273    raeburn  18390:                 $userenv{'canrequest.'.$crstype} =
                   18391:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   18392:                                                       'reload','requestcourses',
                   18393:                                                       \%userenv,\%domdef,\%is_adv);
                   18394:             }
1.724     raeburn  18395: 
1.1418    raeburn  18396:             if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
                   18397:                 (exists($userroles->{"user.role.au./$domain/"}))) {
                   18398:                 if ($userenv{'authoreditors'}) {
                   18399:                     $userenv{'editors'} = $userenv{'authoreditors'};
                   18400:                 } elsif ($domdef{'editors'} ne '') {
                   18401:                     $userenv{'editors'} = $domdef{'editors'};
                   18402:                 } else {
                   18403:                     $userenv{'editors'} = 'edit,xml';
                   18404:                 }
1.1431    raeburn  18405:                 if ($userenv{'authorarchive'}) {
                   18406:                     $userenv{'canarchive'} = 1;
                   18407:                 } elsif (($userenv{'authorarchive'} eq '') &&
                   18408:                          ($domdef{'archive'})) {
                   18409:                     $userenv{'canarchive'} = 1;
                   18410:                 }
1.1418    raeburn  18411:             }
                   18412: 
1.1273    raeburn  18413:             $userenv{'canrequest.author'} =
                   18414:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   18415:                                                   'reload','requestauthor',
1.980     raeburn  18416:                                                   \%userenv,\%domdef,\%is_adv);
1.1273    raeburn  18417:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   18418:                                                  $domain,$username);
                   18419:             my $reqstatus = $reqauthor{'author_status'};
                   18420:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') { 
                   18421:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   18422:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   18423:                                                       $reqauthor{'author'}{'timestamp'};
                   18424:                 }
1.1092    raeburn  18425:             }
1.1287    raeburn  18426:             my ($types,$typename) = &course_types();
                   18427:             if (ref($types) eq 'ARRAY') {
                   18428:                 my @options = ('approval','validate','autolimit');
                   18429:                 my $optregex = join('|',@options);
                   18430:                 my (%willtrust,%trustchecked);
                   18431:                 foreach my $type (@{$types}) {
                   18432:                     my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
                   18433:                     if ($dom_str ne '') {
                   18434:                         my $updatedstr = '';
                   18435:                         my @possdomains = split(',',$dom_str);
                   18436:                         foreach my $entry (@possdomains) {
                   18437:                             my ($extdom,$extopt) = split(':',$entry);
                   18438:                             unless ($trustchecked{$extdom}) {
                   18439:                                 $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
                   18440:                                 $trustchecked{$extdom} = 1;
                   18441:                             }
                   18442:                             if ($willtrust{$extdom}) {
                   18443:                                 $updatedstr .= $entry.',';
                   18444:                             }
                   18445:                         }
                   18446:                         $updatedstr =~ s/,$//;
                   18447:                         if ($updatedstr) {
                   18448:                             $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
                   18449:                         } else {
                   18450:                             delete($userenv{'reqcrsotherdom.'.$type});
                   18451:                         }
                   18452:                     }
                   18453:                 }
                   18454:             }
1.1092    raeburn  18455:         }
1.462     albertel 18456: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  18457: 
1.462     albertel 18458: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   18459: 		 &GDBM_WRCREAT(),0640)) {
                   18460: 	    &_add_to_env(\%disk_env,\%initial_env);
                   18461: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   18462: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  18463:             if (ref($firstaccenv) eq 'HASH') {
                   18464:                 &_add_to_env(\%disk_env,$firstaccenv);
                   18465:             }
                   18466:             if (ref($timerintenv) eq 'HASH') {
                   18467:                 &_add_to_env(\%disk_env,$timerintenv);
                   18468:             }
1.1414    raeburn  18469:             if (ref($coauthorenv) eq 'HASH') {
                   18470:                 if (keys(%{$coauthorenv})) {
                   18471:                     &_add_to_env(\%disk_env,$coauthorenv);
                   18472:                 }
                   18473:             }
1.463     albertel 18474: 	    if (ref($args->{'extra_env'})) {
                   18475: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   18476: 	    }
1.462     albertel 18477: 	    untie(%disk_env);
                   18478: 	} else {
1.705     tempelho 18479: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   18480: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 18481: 	    return 'error: '.$!;
                   18482: 	}
                   18483:     }
                   18484:     $env{'request.role'}='cm';
                   18485:     $env{'request.role.adv'}=$env{'user.adv'};
                   18486:     $env{'browser.type'}=$clientbrowser;
                   18487: 
                   18488:     return $cookie;
                   18489: 
                   18490: }
                   18491: 
                   18492: sub _add_to_env {
                   18493:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  18494:     if (ref($env_data) eq 'HASH') {
                   18495:         while (my ($key,$value) = each(%$env_data)) {
                   18496: 	    $idf->{$prefix.$key} = $value;
                   18497: 	    $env{$prefix.$key}   = $value;
                   18498:         }
1.462     albertel 18499:     }
                   18500: }
                   18501: 
1.685     tempelho 18502: # --- Get the symbolic name of a problem and the url
                   18503: sub get_symb {
                   18504:     my ($request,$silent) = @_;
1.726     raeburn  18505:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 18506:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   18507:     if ($symb eq '') {
                   18508:         if (!$silent) {
1.1071    raeburn  18509:             if (ref($request)) { 
                   18510:                 $request->print("Unable to handle ambiguous references:$url:.");
                   18511:             }
1.685     tempelho 18512:             return ();
                   18513:         }
                   18514:     }
                   18515:     &Apache::lonenc::check_decrypt(\$symb);
                   18516:     return ($symb);
                   18517: }
                   18518: 
                   18519: # --------------------------------------------------------------Get annotation
                   18520: 
                   18521: sub get_annotation {
                   18522:     my ($symb,$enc) = @_;
                   18523: 
                   18524:     my $key = $symb;
                   18525:     if (!$enc) {
                   18526:         $key =
                   18527:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   18528:     }
                   18529:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   18530:     return $annotation{$key};
                   18531: }
                   18532: 
                   18533: sub clean_symb {
1.731     raeburn  18534:     my ($symb,$delete_enc) = @_;
1.685     tempelho 18535: 
                   18536:     &Apache::lonenc::check_decrypt(\$symb);
                   18537:     my $enc = $env{'request.enc'};
1.731     raeburn  18538:     if ($delete_enc) {
1.730     raeburn  18539:         delete($env{'request.enc'});
                   18540:     }
1.685     tempelho 18541: 
                   18542:     return ($symb,$enc);
                   18543: }
1.462     albertel 18544: 
1.1181    raeburn  18545: ############################################################
                   18546: ############################################################
                   18547: 
                   18548: =pod
                   18549: 
                   18550: =head1 Routines for building display used to search for courses
                   18551: 
                   18552: 
                   18553: =over 4
                   18554: 
                   18555: =item * &build_filters()
                   18556: 
                   18557: Create markup for a table used to set filters to use when selecting
1.1182    raeburn  18558: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   18559: and quotacheck.pl
                   18560: 
1.1181    raeburn  18561: 
                   18562: Inputs:
                   18563: 
                   18564: filterlist - anonymous array of fields to include as potential filters 
                   18565: 
                   18566: crstype - course type
                   18567: 
                   18568: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   18569:               to pop-open a course selector (will contain "extra element"). 
                   18570: 
                   18571: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   18572: 
                   18573: filter - anonymous hash of criteria and their values
                   18574: 
                   18575: action - form action
                   18576: 
                   18577: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   18578: 
1.1182    raeburn  18579: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181    raeburn  18580: 
                   18581: cloneruname - username of owner of new course who wants to clone
                   18582: 
                   18583: clonerudom - domain of owner of new course who wants to clone
                   18584: 
                   18585: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community) 
                   18586: 
                   18587: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   18588: 
                   18589: codedom - domain
                   18590: 
                   18591: formname - value of form element named "form". 
                   18592: 
                   18593: fixeddom - domain, if fixed.
                   18594: 
                   18595: prevphase - value to assign to form element named "phase" when going back to the previous screen  
                   18596: 
                   18597: cnameelement - name of form element in form on opener page which will receive title of selected course 
                   18598: 
                   18599: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   18600: 
                   18601: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   18602: 
                   18603: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   18604: 
                   18605: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   18606: 
                   18607: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   18608: 
1.1182    raeburn  18609: 
1.1181    raeburn  18610: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   18611: 
1.1182    raeburn  18612: 
1.1181    raeburn  18613: Side Effects: None
                   18614: 
                   18615: =cut
                   18616: 
                   18617: # ---------------------------------------------- search for courses based on last activity etc.
                   18618: 
                   18619: sub build_filters {
                   18620:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   18621:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   18622:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   18623:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   18624:         $clonetext,$clonewarning) = @_;
1.1182    raeburn  18625:     my ($list,$jscript);
1.1181    raeburn  18626:     my $onchange = 'javascript:updateFilters(this)';
                   18627:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   18628:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   18629:         $typeselectform,$instcodetitle);
                   18630:     if ($formname eq '') {
                   18631:         $formname = $caller;
                   18632:     }
                   18633:     foreach my $item (@{$filterlist}) {
                   18634:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   18635:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   18636:             if ($item eq 'domainfilter') {
                   18637:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   18638:             } elsif ($item eq 'coursefilter') {
                   18639:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   18640:             } elsif ($item eq 'ownerfilter') {
                   18641:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   18642:             } elsif ($item eq 'ownerdomfilter') {
                   18643:                 $filter->{'ownerdomfilter'} =
                   18644:                     &LONCAPA::clean_domain($filter->{$item});
                   18645:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   18646:                                                        'ownerdomfilter',1);
                   18647:             } elsif ($item eq 'personfilter') {
                   18648:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   18649:             } elsif ($item eq 'persondomfilter') {
                   18650:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   18651:                                                         'persondomfilter',1);
                   18652:             } else {
                   18653:                 $filter->{$item} =~ s/\W//g;
                   18654:             }
                   18655:             if (!$filter->{$item}) {
                   18656:                 $filter->{$item} = '';
                   18657:             }
                   18658:         }
                   18659:         if ($item eq 'domainfilter') {
                   18660:             my $allow_blank = 1;
                   18661:             if ($formname eq 'portform') {
                   18662:                 $allow_blank=0;
                   18663:             } elsif ($formname eq 'studentform') {
                   18664:                 $allow_blank=0;
                   18665:             }
                   18666:             if ($fixeddom) {
                   18667:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   18668:                                     ' value="'.$codedom.'" />'.
                   18669:                                     &Apache::lonnet::domain($codedom,'description');
                   18670:             } else {
                   18671:                 $domainselectform = &select_dom_form($filter->{$item},
                   18672:                                                      'domainfilter',
                   18673:                                                       $allow_blank,'',$onchange);
                   18674:             }
                   18675:         } else {
                   18676:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   18677:         }
                   18678:     }
                   18679: 
                   18680:     # last course activity filter and selection
                   18681:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   18682: 
                   18683:     # course created filter and selection
                   18684:     if (exists($filter->{'createdfilter'})) {
                   18685:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   18686:     }
                   18687: 
1.1239    raeburn  18688:     my $prefix = $crstype;
                   18689:     if ($crstype eq 'Placement') {
                   18690:         $prefix = 'Placement Test'
                   18691:     }
1.1181    raeburn  18692:     my %lt = &Apache::lonlocal::texthash(
1.1239    raeburn  18693:                 'cac' => "$prefix Activity",
                   18694:                 'ccr' => "$prefix Created",
                   18695:                 'cde' => "$prefix Title",
                   18696:                 'cdo' => "$prefix Domain",
1.1181    raeburn  18697:                 'ins' => 'Institutional Code',
                   18698:                 'inc' => 'Institutional Categorization',
1.1239    raeburn  18699:                 'cow' => "$prefix Owner/Co-owner",
                   18700:                 'cop' => "$prefix Personnel Includes",
1.1181    raeburn  18701:                 'cog' => 'Type',
                   18702:              );
                   18703: 
                   18704:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   18705:         my $typeval = 'Course';
                   18706:         if ($crstype eq 'Community') {
                   18707:             $typeval = 'Community';
1.1239    raeburn  18708:         } elsif ($crstype eq 'Placement') {
                   18709:             $typeval = 'Placement';
1.1181    raeburn  18710:         }
                   18711:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   18712:     } else {
                   18713:         $typeselectform =  '<select name="type" size="1"';
                   18714:         if ($onchange) {
                   18715:             $typeselectform .= ' onchange="'.$onchange.'"';
                   18716:         }
                   18717:         $typeselectform .= '>'."\n";
1.1237    raeburn  18718:         foreach my $posstype ('Course','Community','Placement') {
1.1239    raeburn  18719:             my $shown;
                   18720:             if ($posstype eq 'Placement') {
                   18721:                 $shown = &mt('Placement Test');
                   18722:             } else {
                   18723:                 $shown = &mt($posstype);
                   18724:             }
1.1181    raeburn  18725:             $typeselectform.='<option value="'.$posstype.'"'.
1.1239    raeburn  18726:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181    raeburn  18727:         }
                   18728:         $typeselectform.="</select>";
                   18729:     }
                   18730: 
                   18731:     my ($cloneableonlyform,$cloneabletitle);
                   18732:     if (exists($filter->{'cloneableonly'})) {
                   18733:         my $cloneableon = '';
                   18734:         my $cloneableoff = ' checked="checked"';
                   18735:         if ($filter->{'cloneableonly'}) {
                   18736:             $cloneableon = $cloneableoff;
                   18737:             $cloneableoff = '';
                   18738:         }
                   18739:         $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>';
                   18740:         if ($formname eq 'ccrs') {
1.1187    bisitz   18741:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181    raeburn  18742:         } else {
                   18743:             $cloneabletitle = &mt('Cloneable by you');
                   18744:         }
                   18745:     }
                   18746:     my $officialjs;
                   18747:     if ($crstype eq 'Course') {
                   18748:         if (exists($filter->{'instcodefilter'})) {
1.1182    raeburn  18749: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   18750: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   18751:             if ($codedom) { 
1.1181    raeburn  18752:                 $officialjs = 1;
                   18753:                 ($instcodeform,$jscript,$$numtitlesref) =
                   18754:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   18755:                                                                   $officialjs,$codetitlesref);
                   18756:                 if ($jscript) {
1.1182    raeburn  18757:                     $jscript = '<script type="text/javascript">'."\n".
                   18758:                                '// <![CDATA['."\n".
                   18759:                                $jscript."\n".
                   18760:                                '// ]]>'."\n".
                   18761:                                '</script>'."\n";
1.1181    raeburn  18762:                 }
                   18763:             }
                   18764:             if ($instcodeform eq '') {
                   18765:                 $instcodeform =
                   18766:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   18767:                     $list->{'instcodefilter'}.'" />';
                   18768:                 $instcodetitle = $lt{'ins'};
                   18769:             } else {
                   18770:                 $instcodetitle = $lt{'inc'};
                   18771:             }
                   18772:             if ($fixeddom) {
                   18773:                 $instcodetitle .= '<br />('.$codedom.')';
                   18774:             }
                   18775:         }
                   18776:     }
                   18777:     my $output = qq|
                   18778: <form method="post" name="filterpicker" action="$action">
                   18779: <input type="hidden" name="form" value="$formname" />
                   18780: |;
                   18781:     if ($formname eq 'modifycourse') {
                   18782:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   18783:                    '<input type="hidden" name="prevphase" value="'.
                   18784:                    $prevphase.'" />'."\n";
1.1198    musolffc 18785:     } elsif ($formname eq 'quotacheck') {
                   18786:         $output .= qq|
                   18787: <input type="hidden" name="sortby" value="" />
                   18788: <input type="hidden" name="sortorder" value="" />
                   18789: |;
                   18790:     } else {
1.1181    raeburn  18791:         my $name_input;
                   18792:         if ($cnameelement ne '') {
                   18793:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   18794:                           $cnameelement.'" />';
                   18795:         }
                   18796:         $output .= qq|
1.1182    raeburn  18797: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   18798: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181    raeburn  18799: $name_input
                   18800: $roleelement
                   18801: $multelement
                   18802: $typeelement
                   18803: |;
                   18804:         if ($formname eq 'portform') {
                   18805:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   18806:         }
                   18807:     }
                   18808:     if ($fixeddom) {
                   18809:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   18810:     }
                   18811:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   18812:     if ($sincefilterform) {
                   18813:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   18814:                   .$sincefilterform
                   18815:                   .&Apache::lonhtmlcommon::row_closure();
                   18816:     }
                   18817:     if ($createdfilterform) {
                   18818:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   18819:                   .$createdfilterform
                   18820:                   .&Apache::lonhtmlcommon::row_closure();
                   18821:     }
                   18822:     if ($domainselectform) {
                   18823:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   18824:                   .$domainselectform
                   18825:                   .&Apache::lonhtmlcommon::row_closure();
                   18826:     }
                   18827:     if ($typeselectform) {
                   18828:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   18829:             $output .= $typeselectform;
                   18830:         } else {
                   18831:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   18832:                       .$typeselectform
                   18833:                       .&Apache::lonhtmlcommon::row_closure();
                   18834:         }
                   18835:     }
                   18836:     if ($instcodeform) {
                   18837:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   18838:                   .$instcodeform
                   18839:                   .&Apache::lonhtmlcommon::row_closure();
                   18840:     }
                   18841:     if (exists($filter->{'ownerfilter'})) {
                   18842:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   18843:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   18844:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   18845:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   18846:                    $ownerdomselectform.'</td></tr></table>'.
                   18847:                    &Apache::lonhtmlcommon::row_closure();
                   18848:     }
                   18849:     if (exists($filter->{'personfilter'})) {
                   18850:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   18851:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   18852:                    '<input type="text" name="personfilter" size="20" value="'.
                   18853:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   18854:                    $persondomselectform.'</td></tr></table>'.
                   18855:                    &Apache::lonhtmlcommon::row_closure();
                   18856:     }
                   18857:     if (exists($filter->{'coursefilter'})) {
                   18858:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   18859:                   .'<input type="text" name="coursefilter" size="25" value="'
                   18860:                   .$list->{'coursefilter'}.'" />'
                   18861:                   .&Apache::lonhtmlcommon::row_closure();
                   18862:     }
                   18863:     if ($cloneableonlyform) {
                   18864:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   18865:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   18866:     }
                   18867:     if (exists($filter->{'descriptfilter'})) {
                   18868:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   18869:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   18870:                   .$list->{'descriptfilter'}.'" />'
                   18871:                   .&Apache::lonhtmlcommon::row_closure(1);
                   18872:     }
                   18873:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   18874:                '<input type="hidden" name="updater" value="" />'."\n".
                   18875:                '<input type="submit" name="gosearch" value="'.
                   18876:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   18877:     return $jscript.$clonewarning.$output;
                   18878: }
                   18879: 
                   18880: =pod 
                   18881: 
                   18882: =item * &timebased_select_form()
                   18883: 
1.1182    raeburn  18884: Create markup for a dropdown list used to select a time-based
1.1181    raeburn  18885: filter e.g., Course Activity, Course Created, when searching for courses
                   18886: or communities
                   18887: 
                   18888: Inputs:
                   18889: 
                   18890: item - name of form element (sincefilter or createdfilter)
                   18891: 
                   18892: filter - anonymous hash of criteria and their values
                   18893: 
                   18894: Returns: HTML for a select box contained a blank, then six time selections,
                   18895:          with value set in incoming form variables currently selected. 
                   18896: 
                   18897: Side Effects: None
                   18898: 
                   18899: =cut
                   18900: 
                   18901: sub timebased_select_form {
                   18902:     my ($item,$filter) = @_;
                   18903:     if (ref($filter) eq 'HASH') {
                   18904:         $filter->{$item} =~ s/[^\d-]//g;
                   18905:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   18906:         return &select_form(
                   18907:                             $filter->{$item},
                   18908:                             $item,
                   18909:                             {      '-1' => '',
                   18910:                                 '86400' => &mt('today'),
                   18911:                                '604800' => &mt('last week'),
                   18912:                               '2592000' => &mt('last month'),
                   18913:                               '7776000' => &mt('last three months'),
                   18914:                              '15552000' => &mt('last six months'),
                   18915:                              '31104000' => &mt('last year'),
                   18916:                     'select_form_order' =>
                   18917:                            ['-1','86400','604800','2592000','7776000',
                   18918:                             '15552000','31104000']});
                   18919:     }
                   18920: }
                   18921: 
                   18922: =pod
                   18923: 
                   18924: =item * &js_changer()
                   18925: 
                   18926: Create script tag containing Javascript used to submit course search form
1.1183    raeburn  18927: when course type or domain is changed, and also to hide 'Searching ...' on
                   18928: page load completion for page showing search result.
1.1181    raeburn  18929: 
                   18930: Inputs: None
                   18931: 
1.1183    raeburn  18932: Returns: markup containing updateFilters() and hideSearching() javascript functions. 
1.1181    raeburn  18933: 
                   18934: Side Effects: None
                   18935: 
                   18936: =cut
                   18937: 
                   18938: sub js_changer {
                   18939:     return <<ENDJS;
                   18940: <script type="text/javascript">
                   18941: // <![CDATA[
                   18942: function updateFilters(caller) {
                   18943:     if (typeof(caller) != "undefined") {
                   18944:         document.filterpicker.updater.value = caller.name;
                   18945:     }
                   18946:     document.filterpicker.submit();
                   18947: }
1.1183    raeburn  18948: 
                   18949: function hideSearching() {
                   18950:     if (document.getElementById('searching')) {
                   18951:         document.getElementById('searching').style.display = 'none';
                   18952:     }
                   18953:     return;
                   18954: }
                   18955: 
1.1181    raeburn  18956: // ]]>
                   18957: </script>
                   18958: 
                   18959: ENDJS
                   18960: }
                   18961: 
                   18962: =pod
                   18963: 
1.1182    raeburn  18964: =item * &search_courses()
                   18965: 
                   18966: Process selected filters form course search form and pass to lonnet::courseiddump
                   18967: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   18968: 
                   18969: Inputs:
                   18970: 
                   18971: dom - domain being searched 
                   18972: 
                   18973: type - course type ('Course' or 'Community' or '.' if any).
                   18974: 
                   18975: filter - anonymous hash of criteria and their values
                   18976: 
                   18977: numtitles - for institutional codes - number of categories
                   18978: 
                   18979: cloneruname - optional username of new course owner
                   18980: 
                   18981: clonerudom - optional domain of new course owner
                   18982: 
1.1221    raeburn  18983: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by, 
1.1182    raeburn  18984:             (used when DC is using course creation form)
                   18985: 
                   18986: codetitles - reference to array of titles of components in institutional codes (official courses).
                   18987: 
1.1221    raeburn  18988: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   18989:            (and so can clone automatically)
                   18990: 
                   18991: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   18992: 
                   18993: reqinstcode - institutional code of new course, where search_courses is used to identify potential 
                   18994:               courses to clone 
1.1182    raeburn  18995: 
                   18996: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   18997: 
                   18998: 
                   18999: Side Effects: None
                   19000: 
                   19001: =cut
                   19002: 
                   19003: 
                   19004: sub search_courses {
1.1221    raeburn  19005:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   19006:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182    raeburn  19007:     my (%courses,%showcourses,$cloner);
                   19008:     if (($filter->{'ownerfilter'} ne '') ||
                   19009:         ($filter->{'ownerdomfilter'} ne '')) {
                   19010:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   19011:                                        $filter->{'ownerdomfilter'};
                   19012:     }
                   19013:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   19014:         if (!$filter->{$item}) {
                   19015:             $filter->{$item}='.';
                   19016:         }
                   19017:     }
                   19018:     my $now = time;
                   19019:     my $timefilter =
                   19020:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   19021:     my ($createdbefore,$createdafter);
                   19022:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   19023:         $createdbefore = $now;
                   19024:         $createdafter = $now-$filter->{'createdfilter'};
                   19025:     }
                   19026:     my ($instcodefilter,$regexpok);
                   19027:     if ($numtitles) {
                   19028:         if ($env{'form.official'} eq 'on') {
                   19029:             $instcodefilter =
                   19030:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   19031:             $regexpok = 1;
                   19032:         } elsif ($env{'form.official'} eq 'off') {
                   19033:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   19034:             unless ($instcodefilter eq '') {
                   19035:                 $regexpok = -1;
                   19036:             }
                   19037:         }
                   19038:     } else {
                   19039:         $instcodefilter = $filter->{'instcodefilter'};
                   19040:     }
                   19041:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   19042:     if ($type eq '') { $type = '.'; }
                   19043: 
                   19044:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   19045:         $cloner = $cloneruname.':'.$clonerudom;
                   19046:     }
                   19047:     %courses = &Apache::lonnet::courseiddump($dom,
                   19048:                                              $filter->{'descriptfilter'},
                   19049:                                              $timefilter,
                   19050:                                              $instcodefilter,
                   19051:                                              $filter->{'combownerfilter'},
                   19052:                                              $filter->{'coursefilter'},
                   19053:                                              undef,undef,$type,$regexpok,undef,undef,
1.1221    raeburn  19054:                                              undef,undef,$cloner,$cc_clone,
1.1182    raeburn  19055:                                              $filter->{'cloneableonly'},
                   19056:                                              $createdbefore,$createdafter,undef,
1.1221    raeburn  19057:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182    raeburn  19058:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   19059:         my $ccrole;
                   19060:         if ($type eq 'Community') {
                   19061:             $ccrole = 'co';
                   19062:         } else {
                   19063:             $ccrole = 'cc';
                   19064:         }
                   19065:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   19066:                                                      $filter->{'persondomfilter'},
                   19067:                                                      'userroles',undef,
                   19068:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   19069:                                                      $dom);
                   19070:         foreach my $role (keys(%rolehash)) {
                   19071:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   19072:             my $cid = $cdom.'_'.$cnum;
                   19073:             if (exists($courses{$cid})) {
                   19074:                 if (ref($courses{$cid}) eq 'HASH') {
                   19075:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   19076:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263    raeburn  19077:                             push(@{$courses{$cid}{roles}},$courserole);
1.1182    raeburn  19078:                         }
                   19079:                     } else {
                   19080:                         $courses{$cid}{roles} = [$courserole];
                   19081:                     }
                   19082:                     $showcourses{$cid} = $courses{$cid};
                   19083:                 }
                   19084:             }
                   19085:         }
                   19086:         %courses = %showcourses;
                   19087:     }
                   19088:     return %courses;
                   19089: }
                   19090: 
                   19091: =pod
                   19092: 
1.1181    raeburn  19093: =back
                   19094: 
1.1207    raeburn  19095: =head1 Routines for version requirements for current course.
                   19096: 
                   19097: =over 4
                   19098: 
                   19099: =item * &check_release_required()
                   19100: 
                   19101: Compares required LON-CAPA version with version on server, and
                   19102: if required version is newer looks for a server with the required version.
                   19103: 
                   19104: Looks first at servers in user's owen domain; if none suitable, looks at
                   19105: servers in course's domain are permitted to host sessions for user's domain.
                   19106: 
                   19107: Inputs:
                   19108: 
                   19109: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   19110: 
                   19111: $courseid - Course ID of current course
                   19112: 
                   19113: $rolecode - User's current role in course (for switchserver query string).
                   19114: 
                   19115: $required - LON-CAPA version needed by course (format: Major.Minor).
                   19116: 
                   19117: 
                   19118: Returns:
                   19119: 
                   19120: $switchserver - query string tp append to /adm/switchserver call (if 
                   19121:                 current server's LON-CAPA version is too old. 
                   19122: 
                   19123: $warning - Message is displayed if no suitable server could be found.
                   19124: 
                   19125: =cut
                   19126: 
                   19127: sub check_release_required {
                   19128:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   19129:     my ($switchserver,$warning);
                   19130:     if ($required ne '') {
                   19131:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   19132:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   19133:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   19134:             my $otherserver;
                   19135:             if (($major eq '' && $minor eq '') ||
                   19136:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   19137:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   19138:                 my $switchlcrev =
                   19139:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   19140:                                                            $userdomserver);
                   19141:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   19142:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   19143:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   19144:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   19145:                     if ($cdom ne $env{'user.domain'}) {
                   19146:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   19147:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   19148:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   19149:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   19150:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   19151:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   19152:                         my $canhost =
                   19153:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   19154:                                                               $coursedomserver,
                   19155:                                                               $remoterev,
                   19156:                                                               $udomdefaults{'remotesessions'},
                   19157:                                                               $defdomdefaults{'hostedsessions'});
                   19158: 
                   19159:                         if ($canhost) {
                   19160:                             $otherserver = $coursedomserver;
                   19161:                         } else {
                   19162:                             $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.");
                   19163:                         }
                   19164:                     } else {
                   19165:                         $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).");
                   19166:                     }
                   19167:                 } else {
                   19168:                     $otherserver = $userdomserver;
                   19169:                 }
                   19170:             }
                   19171:             if ($otherserver ne '') {
                   19172:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   19173:             }
                   19174:         }
                   19175:     }
                   19176:     return ($switchserver,$warning);
                   19177: }
                   19178: 
                   19179: =pod
                   19180: 
                   19181: =item * &check_release_result()
                   19182: 
                   19183: Inputs:
                   19184: 
                   19185: $switchwarning - Warning message if no suitable server found to host session.
                   19186: 
                   19187: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   19188:                 and current role.
                   19189: 
                   19190: Returns: HTML to display with information about requirement to switch server.
                   19191:          Either displaying warning with link to Roles/Courses screen or
                   19192:          display link to switchserver.
                   19193: 
1.1181    raeburn  19194: =cut
                   19195: 
1.1207    raeburn  19196: sub check_release_result {
                   19197:     my ($switchwarning,$switchserver) = @_;
                   19198:     my $output = &start_page('Selected course unavailable on this server').
1.1463    raeburn  19199:                  '<div class="LC_landmark" role="main"><p class="LC_warning">';
1.1207    raeburn  19200:     if ($switchwarning) {
                   19201:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   19202:         if (&show_course()) {
                   19203:             $output .= &mt('Display courses');
                   19204:         } else {
                   19205:             $output .= &mt('Display roles');
                   19206:         }
                   19207:         $output .= '</a>';
                   19208:     } elsif ($switchserver) {
                   19209:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   19210:                    '<br />'.
                   19211:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   19212:                    &mt('Switch Server').
                   19213:                    '</a>';
                   19214:     }
1.1463    raeburn  19215:     $output .= '</p></div>'.&end_page();
1.1207    raeburn  19216:     return $output;
                   19217: }
                   19218: 
                   19219: =pod
                   19220: 
                   19221: =item * &needs_coursereinit()
                   19222: 
                   19223: Determine if course contents stored for user's session needs to be
                   19224: refreshed, because content has changed since "Big Hash" last tied.
                   19225: 
                   19226: Check for change is made if time last checked is more than 10 minutes ago
                   19227: (by default).
                   19228: 
                   19229: Inputs:
                   19230: 
                   19231: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   19232: 
                   19233: $interval (optional) - Time which may elapse (in s) between last check for content
                   19234:                        change in current course. (default: 600 s).  
                   19235: 
                   19236: Returns: an array; first element is:
                   19237: 
                   19238: =over 4
                   19239: 
                   19240: 'switch' - if content updates mean user's session
                   19241:            needs to be switched to a server running a newer LON-CAPA version
                   19242:  
                   19243: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   19244:            on current server hosting user's session                
                   19245: 
                   19246: ''       - if no action required.
                   19247: 
                   19248: =back
                   19249: 
                   19250: If first item element is 'switch':
                   19251: 
                   19252: second item is $switchwarning - Warning message if no suitable server found to host session. 
                   19253: 
                   19254: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   19255:                               and current role. 
                   19256: 
                   19257: otherwise: no other elements returned.
                   19258: 
                   19259: =back
                   19260: 
                   19261: =cut
                   19262: 
                   19263: sub needs_coursereinit {
                   19264:     my ($loncaparev,$interval) = @_;
                   19265:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   19266:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   19267:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   19268:     my $now = time;
                   19269:     if ($interval eq '') {
                   19270:         $interval = 600;
                   19271:     }
                   19272:     if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282    raeburn  19273:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372    raeburn  19274:         my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282    raeburn  19275:         if ($blocked) {
                   19276:             return ();
                   19277:         }
1.1391    raeburn  19278:         my $update;
                   19279:         my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
                   19280:         my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
                   19281:         if ($lastmainchange > $env{'request.course.tied'}) {
                   19282:             my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
                   19283:             if ($needswitch) {
                   19284:                 return ('switch',$switchwarning,$switchserver);
                   19285:             }
                   19286:             $update = 'main';
                   19287:         }
                   19288:         if ($lastsuppchange > $env{'request.course.suppupdated'}) {
                   19289:             if ($update) {
                   19290:                 $update = 'both';
                   19291:             } else {
                   19292:                 my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
                   19293:                 if ($needswitch) {
                   19294:                     return ('switch',$switchwarning,$switchserver);
                   19295:                 } else {
                   19296:                     $update = 'supp';
1.1207    raeburn  19297:                 }
                   19298:             }
1.1391    raeburn  19299:         }
1.1453    raeburn  19300:         return ($update);
1.1391    raeburn  19301:     }
                   19302:     return ();
                   19303: }
                   19304: 
                   19305: sub switch_for_update {
                   19306:     my ($loncaparev,$cdom,$cnum) = @_;
                   19307:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   19308:     if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   19309:         my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   19310:         if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   19311:             &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   19312:                                     $curr_reqd_hash{'internal.releaserequired'}});
                   19313:             my ($switchserver,$switchwarning) =
                   19314:                 &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   19315:                                         $curr_reqd_hash{'internal.releaserequired'});
                   19316:             if ($switchwarning ne '' || $switchserver ne '') {
                   19317:                 return ('switch',$switchwarning,$switchserver);
                   19318:             }
1.1207    raeburn  19319:         }
                   19320:     }
                   19321:     return ();
                   19322: }
1.1181    raeburn  19323: 
1.1083    raeburn  19324: sub update_content_constraints {
1.1395    raeburn  19325:     my ($cdom,$cnum,$chome,$cid) = @_;
1.1083    raeburn  19326:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   19327:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307    raeburn  19328:     my (%checkresponsetypes,%checkcrsrestypes);
1.1083    raeburn  19329:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236    raeburn  19330:         my ($item,$name,$value) = split(/:/,$key);
1.1083    raeburn  19331:         if ($item eq 'resourcetag') {
                   19332:             if ($name eq 'responsetype') {
                   19333:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   19334:             }
1.1307    raeburn  19335:         } elsif ($item eq 'course') {
                   19336:             if ($name eq 'courserestype') {
                   19337:                 $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
                   19338:             }
1.1083    raeburn  19339:         }
                   19340:     }
                   19341:     my $navmap = Apache::lonnavmaps::navmap->new();
                   19342:     if (defined($navmap)) {
1.1307    raeburn  19343:         my (%allresponses,%allcrsrestypes);
                   19344:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
                   19345:             if ($res->is_tool()) {
                   19346:                 if ($allcrsrestypes{'exttool'}) {
                   19347:                     $allcrsrestypes{'exttool'} ++;
                   19348:                 } else {
                   19349:                     $allcrsrestypes{'exttool'} = 1;
                   19350:                 }
                   19351:                 next;
                   19352:             }
1.1083    raeburn  19353:             my %responses = $res->responseTypes();
                   19354:             foreach my $key (keys(%responses)) {
                   19355:                 next unless(exists($checkresponsetypes{$key}));
                   19356:                 $allresponses{$key} += $responses{$key};
                   19357:             }
                   19358:         }
                   19359:         foreach my $key (keys(%allresponses)) {
                   19360:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   19361:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   19362:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   19363:             }
                   19364:         }
1.1307    raeburn  19365:         foreach my $key (keys(%allcrsrestypes)) {
1.1308    raeburn  19366:             my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307    raeburn  19367:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   19368:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   19369:             }
                   19370:         }
1.1083    raeburn  19371:         undef($navmap);
                   19372:     }
1.1391    raeburn  19373:     if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308    raeburn  19374:         my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
                   19375:         if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   19376:             ($reqdmajor,$reqdminor) = ($major,$minor);
                   19377:         }
                   19378:     }
1.1083    raeburn  19379:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   19380:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   19381:     }
                   19382:     return;
                   19383: }
                   19384: 
1.1110    raeburn  19385: sub allmaps_incourse {
                   19386:     my ($cdom,$cnum,$chome,$cid) = @_;
                   19387:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   19388:         $cid = $env{'request.course.id'};
                   19389:         $cdom = $env{'course.'.$cid.'.domain'};
                   19390:         $cnum = $env{'course.'.$cid.'.num'};
                   19391:         $chome = $env{'course.'.$cid.'.home'};
                   19392:     }
                   19393:     my %allmaps = ();
                   19394:     my $lastchange =
                   19395:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   19396:     if ($lastchange > $env{'request.course.tied'}) {
                   19397:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   19398:         unless ($ferr) {
1.1395    raeburn  19399:             &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110    raeburn  19400:         }
                   19401:     }
                   19402:     my $navmap = Apache::lonnavmaps::navmap->new();
                   19403:     if (defined($navmap)) {
                   19404:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   19405:             $allmaps{$res->src()} = 1;
                   19406:         }
                   19407:     }
                   19408:     return \%allmaps;
                   19409: }
                   19410: 
1.1083    raeburn  19411: sub parse_supplemental_title {
                   19412:     my ($title) = @_;
                   19413: 
                   19414:     my ($foldertitle,$renametitle);
                   19415:     if ($title =~ /&amp;&amp;&amp;/) {
                   19416:         $title = &HTML::Entites::decode($title);
                   19417:     }
                   19418:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   19419:         $renametitle=$4;
                   19420:         my ($time,$uname,$udom) = ($1,$2,$3);
                   19421:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   19422:         my $name =  &plainname($uname,$udom);
                   19423:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   19424:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401    raeburn  19425:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402    raeburn  19426:         if ($foldertitle ne '') {
1.1401    raeburn  19427:             $title .= ': <br />'.$foldertitle;
                   19428:         }
1.1083    raeburn  19429:     }
                   19430:     if (wantarray) {
                   19431:         return ($title,$foldertitle,$renametitle);
                   19432:     }
                   19433:     return $title;
                   19434: }
                   19435: 
1.1395    raeburn  19436: sub get_supplemental {
                   19437:     my ($cnum,$cdom,$ignorecache,$possdel)=@_;
                   19438:     my $hashid=$cnum.':'.$cdom;
                   19439:     my ($supplemental,$cached,$set_httprefs);
                   19440:     unless ($ignorecache) {
                   19441:         ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
                   19442:     }
                   19443:     unless (defined($cached)) {
                   19444:         my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
                   19445:         unless ($chome eq 'no_host') {
                   19446:             my @order = @LONCAPA::map::order;
                   19447:             my @resources = @LONCAPA::map::resources;
                   19448:             my @resparms = @LONCAPA::map::resparms;
                   19449:             my @zombies = @LONCAPA::map::zombies;
                   19450:             my ($errors,%ids,%hidden);
                   19451:             $errors =
                   19452:                 &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
                   19453:                                       $errors,$possdel,\%ids,\%hidden);
                   19454:             @LONCAPA::map::order = @order;
                   19455:             @LONCAPA::map::resources = @resources;
                   19456:             @LONCAPA::map::resparms = @resparms;
                   19457:             @LONCAPA::map::zombies = @zombies;
                   19458:             $set_httprefs = 1;
                   19459:             if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
                   19460:                 &Apache::lonnet::appenv({'request.course.suppupdated' => time});
                   19461:             }
                   19462:             $supplemental = {
                   19463:                                ids => \%ids,
                   19464:                                hidden => \%hidden,
                   19465:                             };
                   19466:             &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
                   19467:         }
                   19468:     }
                   19469:     return ($supplemental,$set_httprefs);
                   19470: }
                   19471: 
1.1143    raeburn  19472: sub recurse_supplemental {
1.1391    raeburn  19473:     my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
                   19474:     if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
                   19475:         my $mapnum;
                   19476:         if ($suppmap eq 'supplemental.sequence') {
                   19477:             $mapnum = 0;
                   19478:         } else {
                   19479:             ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
                   19480:         }
1.1143    raeburn  19481:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   19482:         if ($fatal) {
                   19483:             $errors ++;
                   19484:         } else {
1.1389    raeburn  19485:             my @order = @LONCAPA::map::order;
                   19486:             if (@order > 0) {
                   19487:                 my @resources = @LONCAPA::map::resources;
1.1391    raeburn  19488:                 my @resparms = @LONCAPA::map::resparms;
1.1389    raeburn  19489:                 foreach my $idx (@order) {
                   19490:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143    raeburn  19491:                     if (($src ne '') && ($status eq 'res')) {
1.1391    raeburn  19492:                         my $id = $mapnum.':'.$idx;
                   19493:                         push(@{$suppids->{$src}},$id);
                   19494:                         if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
                   19495:                             $hiddensupp->{$id} = 1;
                   19496:                         }
1.1146    raeburn  19497:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391    raeburn  19498:                             $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
                   19499:                                                             $hiddensupp,$hiddensupp->{$id});
1.1143    raeburn  19500:                         } else {
1.1391    raeburn  19501:                             my $allowed;
                   19502:                             if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
                   19503:                                 $allowed = 1;
                   19504:                             } elsif ($possdel) {
                   19505:                                 foreach my $item (@{$suppids->{$src}}) {
                   19506:                                     next if ($item eq $id);
                   19507:                                     unless ($hiddensupp->{$item}) {
                   19508:                                        $allowed = 1;
                   19509:                                        last;
                   19510:                                     }
                   19511:                                 }
                   19512:                                 if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
                   19513:                                     &Apache::lonnet::delenv('httpref.'.$src);
                   19514:                                 }
                   19515:                             }
                   19516:                             if ($allowed && (!exists($env{'httpref.'.$src}))) {
                   19517:                                 &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308    raeburn  19518:                             }
1.1143    raeburn  19519:                         }
                   19520:                     }
                   19521:                 }
                   19522:             }
                   19523:         }
                   19524:     }
1.1391    raeburn  19525:     return $errors;
                   19526: }
                   19527: 
                   19528: sub set_supp_httprefs {
                   19529:     my ($cnum,$cdom,$supplemental,$possdel) = @_;
                   19530:     if (ref($supplemental) eq 'HASH') {
                   19531:         if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
                   19532:             foreach my $src (keys(%{$supplemental->{'ids'}})) {
                   19533:                 next if ($src =~ /\.sequence$/);
                   19534:                 if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
                   19535:                     my $allowed;
                   19536:                     if ($env{'request.role.adv'}) {
                   19537:                         $allowed = 1;
                   19538:                     } else {
                   19539:                         foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
                   19540:                             unless ($supplemental->{'hidden'}->{$id}) {
                   19541:                                 $allowed = 1;
                   19542:                                 last;
                   19543:                             }
                   19544:                         }
                   19545:                     }
                   19546:                     if (exists($env{'httpref.'.$src})) {
                   19547:                         if ($possdel) {
                   19548:                             unless ($allowed) {
                   19549:                                 &Apache::lonnet::delenv('httpref.'.$src);
                   19550:                             }
                   19551:                         }
                   19552:                     } elsif ($allowed) {
                   19553:                         &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
                   19554:                     }
                   19555:                 }
                   19556:             }
                   19557:             if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
                   19558:                 &Apache::lonnet::appenv({'request.course.suppupdated' => time});
                   19559:             }
                   19560:         }
                   19561:     }
                   19562: }
                   19563: 
                   19564: sub get_supp_parameter {
                   19565:     my ($resparm,$name)=@_;
                   19566:     return if ($resparm eq '');
                   19567:     my $value=undef;
                   19568:     my $ptype=undef;
                   19569:     foreach (split('&&&',$resparm)) {
                   19570:         my ($thistype,$thisname,$thisvalue)=split('___',$_);
                   19571:         if ($thisname eq $name) {
                   19572:             $value=$thisvalue;
                   19573:             $ptype=$thistype;
                   19574:         }
                   19575:     }
                   19576:     return $value;
1.1143    raeburn  19577: }
                   19578: 
1.1101    raeburn  19579: sub symb_to_docspath {
1.1267    raeburn  19580:     my ($symb,$navmapref) = @_;
                   19581:     return unless ($symb && ref($navmapref));
1.1101    raeburn  19582:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   19583:     if ($resurl=~/\.(sequence|page)$/) {
                   19584:         $mapurl=$resurl;
                   19585:     } elsif ($resurl eq 'adm/navmaps') {
                   19586:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   19587:     }
                   19588:     my $mapresobj;
1.1267    raeburn  19589:     unless (ref($$navmapref)) {
                   19590:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   19591:     }
                   19592:     if (ref($$navmapref)) {
                   19593:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101    raeburn  19594:     }
                   19595:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   19596:     my $type=$2;
                   19597:     my $path;
                   19598:     if (ref($mapresobj)) {
                   19599:         my $pcslist = $mapresobj->map_hierarchy();
                   19600:         if ($pcslist ne '') {
                   19601:             foreach my $pc (split(/,/,$pcslist)) {
                   19602:                 next if ($pc <= 1);
1.1267    raeburn  19603:                 my $res = $$navmapref->getByMapPc($pc);
1.1101    raeburn  19604:                 if (ref($res)) {
                   19605:                     my $thisurl = $res->src();
                   19606:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   19607:                     my $thistitle = $res->title();
                   19608:                     $path .= '&'.
                   19609:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146    raeburn  19610:                              &escape($thistitle).
1.1101    raeburn  19611:                              ':'.$res->randompick().
                   19612:                              ':'.$res->randomout().
                   19613:                              ':'.$res->encrypted().
                   19614:                              ':'.$res->randomorder().
                   19615:                              ':'.$res->is_page();
                   19616:                 }
                   19617:             }
                   19618:         }
                   19619:         $path =~ s/^\&//;
                   19620:         my $maptitle = $mapresobj->title();
                   19621:         if ($mapurl eq 'default') {
1.1129    raeburn  19622:             $maptitle = 'Main Content';
1.1101    raeburn  19623:         }
                   19624:         $path .= (($path ne '')? '&' : '').
                   19625:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146    raeburn  19626:                  &escape($maptitle).
1.1101    raeburn  19627:                  ':'.$mapresobj->randompick().
                   19628:                  ':'.$mapresobj->randomout().
                   19629:                  ':'.$mapresobj->encrypted().
                   19630:                  ':'.$mapresobj->randomorder().
                   19631:                  ':'.$mapresobj->is_page();
                   19632:     } else {
                   19633:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   19634:         my $ispage = (($type eq 'page')? 1 : '');
                   19635:         if ($mapurl eq 'default') {
1.1129    raeburn  19636:             $maptitle = 'Main Content';
1.1101    raeburn  19637:         }
                   19638:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146    raeburn  19639:                 &escape($maptitle).':::::'.$ispage;
1.1101    raeburn  19640:     }
                   19641:     unless ($mapurl eq 'default') {
                   19642:         $path = 'default&'.
1.1146    raeburn  19643:                 &escape('Main Content').
1.1101    raeburn  19644:                 ':::::&'.$path;
                   19645:     }
                   19646:     return $path;
                   19647: }
                   19648: 
1.1393    raeburn  19649: sub validate_folderpath {
                   19650:     my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
                   19651:     if ($env{'form.folderpath'} ne '') {
                   19652:         my @items = split(/\&/,$env{'form.folderpath'});
1.1394    raeburn  19653:         my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393    raeburn  19654:         for (my $i=0; $i<@items; $i++) {
                   19655:             my $odd = $i%2;
                   19656:             if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
                   19657:                 $badpath = 1;
1.1394    raeburn  19658:             } elsif ($odd && $supplementalflag) {
1.1393    raeburn  19659:                 my $idx = $i-1;
1.1394    raeburn  19660:                 if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
                   19661:                     my $esc_name = $1;
                   19662:                     if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
                   19663:                         $supppath .= '&'.$esc_name;
                   19664:                         $changed = 1;
                   19665:                     } else {
                   19666:                         $supppath .= '&'.$items[$i];
                   19667:                     }
                   19668:                 } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
                   19669:                     $changed = 1;
1.1393    raeburn  19670:                     my $is_hidden;
                   19671:                     unless ($got_supp) {
1.1395    raeburn  19672:                         my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393    raeburn  19673:                         if (ref($supplemental) eq 'HASH') {
                   19674:                             if (ref($supplemental->{'hidden'}) eq 'HASH') {
                   19675:                                 %supphidden = %{$supplemental->{'hidden'}};
                   19676:                             }
                   19677:                             if (ref($supplemental->{'ids'}) eq 'HASH') {
                   19678:                                 %suppids = %{$supplemental->{'ids'}};
                   19679:                             }
                   19680:                         }
                   19681:                         $got_supp = 1;
                   19682:                     }
                   19683:                     if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
                   19684:                         my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
                   19685:                         if ($supphidden{$mapid}) {
                   19686:                             $is_hidden = 1;
                   19687:                         }
                   19688:                     }
1.1394    raeburn  19689:                     $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
                   19690:                 } else {
                   19691:                     $supppath .= '&'.$items[$i];
1.1393    raeburn  19692:                 }
                   19693:             } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
                   19694:                 $badpath = 1;
1.1394    raeburn  19695:             } elsif ($supplementalflag) {
1.1393    raeburn  19696:                 $supppath .= '&'.$items[$i];
                   19697:             }
                   19698:             last if ($badpath);
                   19699:         }
                   19700:         if ($badpath) {
                   19701:             delete($env{'form.folderpath'});
1.1394    raeburn  19702:         } elsif ($changed && $supplementalflag) {
1.1393    raeburn  19703:             $supppath =~ s/^\&//;
                   19704:             $env{'form.folderpath'} = $supppath;
                   19705:         }
                   19706:     }
                   19707:     return;
                   19708: }
                   19709: 
1.1094    raeburn  19710: sub captcha_display {
1.1327    raeburn  19711:     my ($context,$lonhost,$defdom) = @_;
1.1094    raeburn  19712:     my ($output,$error);
1.1234    raeburn  19713:     my ($captcha,$pubkey,$privkey,$version) = 
1.1327    raeburn  19714:         &get_captcha_config($context,$lonhost,$defdom);
1.1095    raeburn  19715:     if ($captcha eq 'original') {
1.1094    raeburn  19716:         $output = &create_captcha();
                   19717:         unless ($output) {
1.1172    raeburn  19718:             $error = 'captcha';
1.1094    raeburn  19719:         }
                   19720:     } elsif ($captcha eq 'recaptcha') {
1.1234    raeburn  19721:         $output = &create_recaptcha($pubkey,$version);
1.1094    raeburn  19722:         unless ($output) {
1.1172    raeburn  19723:             $error = 'recaptcha';
1.1094    raeburn  19724:         }
                   19725:     }
1.1234    raeburn  19726:     return ($output,$error,$captcha,$version);
1.1094    raeburn  19727: }
                   19728: 
                   19729: sub captcha_response {
1.1327    raeburn  19730:     my ($context,$lonhost,$defdom) = @_;
1.1094    raeburn  19731:     my ($captcha_chk,$captcha_error);
1.1327    raeburn  19732:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095    raeburn  19733:     if ($captcha eq 'original') {
1.1094    raeburn  19734:         ($captcha_chk,$captcha_error) = &check_captcha();
                   19735:     } elsif ($captcha eq 'recaptcha') {
1.1234    raeburn  19736:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1094    raeburn  19737:     } else {
                   19738:         $captcha_chk = 1;
                   19739:     }
                   19740:     return ($captcha_chk,$captcha_error);
                   19741: }
                   19742: 
                   19743: sub get_captcha_config {
1.1327    raeburn  19744:     my ($context,$lonhost,$dom_in_effect) = @_;
1.1234    raeburn  19745:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094    raeburn  19746:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   19747:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   19748:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095    raeburn  19749:     if ($context eq 'usercreation') {
                   19750:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   19751:         if (ref($domconfig{$context}) eq 'HASH') {
                   19752:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   19753:             if (ref($hashtocheck) eq 'HASH') {
                   19754:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   19755:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   19756:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   19757:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   19758:                     }
                   19759:                     if ($privkey && $pubkey) {
                   19760:                         $captcha = 'recaptcha';
1.1234    raeburn  19761:                         $version = $hashtocheck->{'recaptchaversion'};
                   19762:                         if ($version ne '2') {
                   19763:                             $version = 1;
                   19764:                         }
1.1095    raeburn  19765:                     } else {
                   19766:                         $captcha = 'original';
                   19767:                     }
                   19768:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   19769:                     $captcha = 'original';
                   19770:                 }
1.1094    raeburn  19771:             }
1.1095    raeburn  19772:         } else {
                   19773:             $captcha = 'captcha';
                   19774:         }
                   19775:     } elsif ($context eq 'login') {
                   19776:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   19777:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   19778:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   19779:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094    raeburn  19780:             if ($privkey && $pubkey) {
                   19781:                 $captcha = 'recaptcha';
1.1234    raeburn  19782:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   19783:                 if ($version ne '2') {
                   19784:                     $version = 1; 
                   19785:                 }
1.1095    raeburn  19786:             } else {
                   19787:                 $captcha = 'original';
1.1094    raeburn  19788:             }
1.1095    raeburn  19789:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   19790:             $captcha = 'original';
1.1094    raeburn  19791:         }
1.1327    raeburn  19792:     } elsif ($context eq 'passwords') {
                   19793:         if ($dom_in_effect) {
                   19794:             my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
                   19795:             if ($passwdconf{'captcha'} eq 'recaptcha') {
                   19796:                 if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
                   19797:                     $pubkey = $passwdconf{'recaptchakeys'}{'public'};
                   19798:                     $privkey = $passwdconf{'recaptchakeys'}{'private'};
                   19799:                 }
                   19800:                 if ($privkey && $pubkey) {
                   19801:                     $captcha = 'recaptcha';
                   19802:                     $version = $passwdconf{'recaptchaversion'};
                   19803:                     if ($version ne '2') {
                   19804:                         $version = 1;
                   19805:                     }
                   19806:                 } else {
                   19807:                     $captcha = 'original';
                   19808:                 }
                   19809:             } elsif ($passwdconf{'captcha'} ne 'notused') {
                   19810:                 $captcha = 'original';
                   19811:             }
                   19812:         }
                   19813:     } 
1.1234    raeburn  19814:     return ($captcha,$pubkey,$privkey,$version);
1.1094    raeburn  19815: }
                   19816: 
                   19817: sub create_captcha {
                   19818:     my %captcha_params = &captcha_settings();
                   19819:     my ($output,$maxtries,$tries) = ('',10,0);
                   19820:     while ($tries < $maxtries) {
                   19821:         $tries ++;
                   19822:         my $captcha = Authen::Captcha->new (
                   19823:                                            output_folder => $captcha_params{'output_dir'},
                   19824:                                            data_folder   => $captcha_params{'db_dir'},
                   19825:                                           );
                   19826:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   19827: 
                   19828:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   19829:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367    raeburn  19830:                       '<span class="LC_nobreak">'.
1.1453    raeburn  19831:                       '<label>'.&mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1463    raeburn  19832:                       '<input type="text" size="5" name="code" value="" autocomplete="new-password" aria-required="true" />'.
1.1453    raeburn  19833:                       '</label></span><br />'.
1.1176    raeburn  19834:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094    raeburn  19835:             last;
                   19836:         }
                   19837:     }
1.1323    raeburn  19838:     if ($output eq '') {
                   19839:         &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
                   19840:     }
1.1094    raeburn  19841:     return $output;
                   19842: }
                   19843: 
                   19844: sub captcha_settings {
                   19845:     my %captcha_params = (
                   19846:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   19847:                            www_output_dir => "/captchaspool",
                   19848:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   19849:                            numchars       => '5',
                   19850:                          );
                   19851:     return %captcha_params;
                   19852: }
                   19853: 
                   19854: sub check_captcha {
                   19855:     my ($captcha_chk,$captcha_error);
                   19856:     my $code = $env{'form.code'};
                   19857:     my $md5sum = $env{'form.crypt'};
                   19858:     my %captcha_params = &captcha_settings();
                   19859:     my $captcha = Authen::Captcha->new(
                   19860:                       output_folder => $captcha_params{'output_dir'},
                   19861:                       data_folder   => $captcha_params{'db_dir'},
                   19862:                   );
1.1109    raeburn  19863:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094    raeburn  19864:     my %captcha_hash = (
                   19865:                         0       => 'Code not checked (file error)',
                   19866:                        -1      => 'Failed: code expired',
                   19867:                        -2      => 'Failed: invalid code (not in database)',
                   19868:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   19869:     );
                   19870:     if ($captcha_chk != 1) {
                   19871:         $captcha_error = $captcha_hash{$captcha_chk}
                   19872:     }
                   19873:     return ($captcha_chk,$captcha_error);
                   19874: }
                   19875: 
                   19876: sub create_recaptcha {
1.1234    raeburn  19877:     my ($pubkey,$version) = @_;
                   19878:     if ($version >= 2) {
1.1367    raeburn  19879:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
                   19880:                '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234    raeburn  19881:     } else {
                   19882:         my $use_ssl;
                   19883:         if ($ENV{'SERVER_PORT'} == 443) {
                   19884:             $use_ssl = 1;
                   19885:         }
                   19886:         my $captcha = Captcha::reCAPTCHA->new;
                   19887:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   19888:                $captcha->get_html($pubkey,undef,$use_ssl).
                   19889:                &mt('If the text is hard to read, [_1] will replace them.',
                   19890:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   19891:                '<br /><br />';
                   19892:     }
1.1094    raeburn  19893: }
                   19894: 
                   19895: sub check_recaptcha {
1.1234    raeburn  19896:     my ($privkey,$version) = @_;
1.1094    raeburn  19897:     my $captcha_chk;
1.1350    raeburn  19898:     my $ip = &Apache::lonnet::get_requestor_ip();
1.1234    raeburn  19899:     if ($version >= 2) {
                   19900:         my %info = (
                   19901:                      secret   => $privkey, 
                   19902:                      response => $env{'form.g-recaptcha-response'},
1.1350    raeburn  19903:                      remoteip => $ip,
1.1234    raeburn  19904:                    );
1.1280    raeburn  19905:         my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
                   19906:         $request->content(join('&',map {
                   19907:                          my $name = escape($_);
                   19908:                          "$name=" . ( ref($info{$_}) eq 'ARRAY'
                   19909:                          ? join("&$name=", map {escape($_) } @{$info{$_}})
                   19910:                          : &escape($info{$_}) );
                   19911:         } keys(%info)));
                   19912:         my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234    raeburn  19913:         if ($response->is_success)  {
                   19914:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   19915:             if (ref($data) eq 'HASH') {
                   19916:                 if ($data->{'success'}) {
                   19917:                     $captcha_chk = 1;
                   19918:                 }
                   19919:             }
                   19920:         }
                   19921:     } else {
                   19922:         my $captcha = Captcha::reCAPTCHA->new;
                   19923:         my $captcha_result =
                   19924:             $captcha->check_answer(
                   19925:                                     $privkey,
1.1350    raeburn  19926:                                     $ip,
1.1234    raeburn  19927:                                     $env{'form.recaptcha_challenge_field'},
                   19928:                                     $env{'form.recaptcha_response_field'},
                   19929:                                   );
                   19930:         if ($captcha_result->{is_valid}) {
                   19931:             $captcha_chk = 1;
                   19932:         }
1.1094    raeburn  19933:     }
                   19934:     return $captcha_chk;
                   19935: }
                   19936: 
1.1174    raeburn  19937: sub emailusername_info {
1.1244    raeburn  19938:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174    raeburn  19939:     my %titles = &Apache::lonlocal::texthash (
                   19940:                      lastname      => 'Last Name',
                   19941:                      firstname     => 'First Name',
                   19942:                      institution   => 'School/college/university',
                   19943:                      location      => "School's city, state/province, country",
                   19944:                      web           => "School's web address",
                   19945:                      officialemail => 'E-mail address at institution (if different)',
1.1244    raeburn  19946:                      id            => 'Student/Employee ID',
1.1174    raeburn  19947:                  );
                   19948:     return (\@fields,\%titles);
                   19949: }
                   19950: 
1.1161    raeburn  19951: sub cleanup_html {
                   19952:     my ($incoming) = @_;
                   19953:     my $outgoing;
                   19954:     if ($incoming ne '') {
                   19955:         $outgoing = $incoming;
                   19956:         $outgoing =~ s/;/&#059;/g;
                   19957:         $outgoing =~ s/\#/&#035;/g;
                   19958:         $outgoing =~ s/\&/&#038;/g;
                   19959:         $outgoing =~ s/</&#060;/g;
                   19960:         $outgoing =~ s/>/&#062;/g;
                   19961:         $outgoing =~ s/\(/&#040/g;
                   19962:         $outgoing =~ s/\)/&#041;/g;
                   19963:         $outgoing =~ s/"/&#034;/g;
                   19964:         $outgoing =~ s/'/&#039;/g;
                   19965:         $outgoing =~ s/\$/&#036;/g;
                   19966:         $outgoing =~ s{/}{&#047;}g;
                   19967:         $outgoing =~ s/=/&#061;/g;
                   19968:         $outgoing =~ s/\\/&#092;/g
                   19969:     }
                   19970:     return $outgoing;
                   19971: }
                   19972: 
1.1190    musolffc 19973: # Checks for critical messages and returns a redirect url if one exists.
                   19974: # $interval indicates how often to check for messages.
1.1282    raeburn  19975: # $context is the calling context -- roles, grades, contents, menu or flip. 
1.1190    musolffc 19976: sub critical_redirect {
1.1282    raeburn  19977:     my ($interval,$context) = @_;
1.1356    raeburn  19978:     unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
                   19979:         return ();
                   19980:     }
1.1190    musolffc 19981:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282    raeburn  19982:         if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
                   19983:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   19984:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372    raeburn  19985:             my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282    raeburn  19986:             if ($blocked) {
                   19987:                 my $checkrole = "cm./$cdom/$cnum";
                   19988:                 if ($env{'request.course.sec'} ne '') {
                   19989:                     $checkrole .= "/$env{'request.course.sec'}";
                   19990:                 }
                   19991:                 unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   19992:                         ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   19993:                     return;
                   19994:                 }
                   19995:             }
                   19996:         }
1.1190    musolffc 19997:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'}, 
                   19998:                                         $env{'user.name'});
                   19999:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191    raeburn  20000:         my $redirecturl;
1.1190    musolffc 20001:         if ($what[0]) {
1.1356    raeburn  20002: 	    if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190    musolffc 20003: 	        $redirecturl='/adm/email?critical=display';
1.1191    raeburn  20004: 	        my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   20005:                 return (1, $url);
1.1190    musolffc 20006:             }
1.1191    raeburn  20007:         }
                   20008:     } 
                   20009:     return ();
1.1190    musolffc 20010: }
                   20011: 
1.1174    raeburn  20012: # Use:
                   20013: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   20014: #
                   20015: ##################################################
                   20016: #          password associated functions         #
                   20017: ##################################################
                   20018: sub des_keys {
                   20019:     # Make a new key for DES encryption.
                   20020:     # Each key has two parts which are returned separately.
                   20021:     # Please note:  Each key must be passed through the &hex function
                   20022:     # before it is output to the web browser.  The hex versions cannot
                   20023:     # be used to decrypt.
                   20024:     my @hexstr=('0','1','2','3','4','5','6','7',
                   20025:                 '8','9','a','b','c','d','e','f');
                   20026:     my $lkey='';
                   20027:     for (0..7) {
                   20028:         $lkey.=$hexstr[rand(15)];
                   20029:     }
                   20030:     my $ukey='';
                   20031:     for (0..7) {
                   20032:         $ukey.=$hexstr[rand(15)];
                   20033:     }
                   20034:     return ($lkey,$ukey);
                   20035: }
                   20036: 
                   20037: sub des_decrypt {
                   20038:     my ($key,$cyphertext) = @_;
                   20039:     my $keybin=pack("H16",$key);
                   20040:     my $cypher;
                   20041:     if ($Crypt::DES::VERSION>=2.03) {
                   20042:         $cypher=new Crypt::DES $keybin;
                   20043:     } else {
                   20044:         $cypher=new DES $keybin;
                   20045:     }
1.1233    raeburn  20046:     my $plaintext='';
                   20047:     my $cypherlength = length($cyphertext);
                   20048:     my $numchunks = int($cypherlength/32);
                   20049:     for (my $j=0; $j<$numchunks; $j++) {
                   20050:         my $start = $j*32;
                   20051:         my $cypherblock = substr($cyphertext,$start,32);
                   20052:         my $chunk =
                   20053:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   20054:         $chunk .=
                   20055:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   20056:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   20057:         $plaintext .= $chunk;
                   20058:     }
1.1174    raeburn  20059:     return $plaintext;
                   20060: }
                   20061: 
1.1344    raeburn  20062: sub get_requested_shorturls {
1.1309    raeburn  20063:     my ($cdom,$cnum,$navmap) = @_;
                   20064:     return unless (ref($navmap));
1.1344    raeburn  20065:     my ($numnew,$errors);
1.1309    raeburn  20066:     my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
                   20067:     if (@toshorten) {
                   20068:         my (%maps,%resources,%titles);
                   20069:         &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
                   20070:                                                                'shorturls',$cdom,$cnum);
                   20071:         if (keys(%resources)) {
1.1344    raeburn  20072:             my %tocreate;
1.1309    raeburn  20073:             foreach my $item (sort {$a <=> $b} (@toshorten)) {
                   20074:                 my $symb = $resources{$item};
                   20075:                 if ($symb) {
                   20076:                     $tocreate{$cnum.'&'.$symb} = 1;
                   20077:                 }
                   20078:             }
1.1344    raeburn  20079:             if (keys(%tocreate)) {
                   20080:                 ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
                   20081:                                                       \%tocreate);
                   20082:             }
1.1309    raeburn  20083:         }
1.1344    raeburn  20084:     }
                   20085:     return ($numnew,$errors);
                   20086: }
                   20087: 
                   20088: sub make_short_symbs {
                   20089:     my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
                   20090:     my ($numnew,@errors);
                   20091:     if (ref($tocreateref) eq 'HASH') {
                   20092:         my %tocreate = %{$tocreateref};
1.1309    raeburn  20093:         if (keys(%tocreate)) {
                   20094:             my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
                   20095:             my $su = Short::URL->new(no_vowels => 1);
                   20096:             my $init = '';
                   20097:             my (%newunique,%addcourse,%courseonly,%failed);
                   20098:             # get lock on tiny db
                   20099:             my $now = time;
1.1344    raeburn  20100:             if ($lockuser eq '') {
                   20101:                 $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
                   20102:             }
1.1309    raeburn  20103:             my $lockhash = {
1.1344    raeburn  20104:                                 "lock\0$now" => $lockuser,
1.1309    raeburn  20105:                             };
                   20106:             my $tries = 0;
                   20107:             my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
                   20108:             my ($code,$error);
                   20109:             while (($gotlock ne 'ok') && ($tries<3)) {
                   20110:                 $tries ++;
                   20111:                 sleep 1;
1.1319    raeburn  20112:                 $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309    raeburn  20113:             }
                   20114:             if ($gotlock eq 'ok') {
                   20115:                 $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
                   20116:                                        \%addcourse,\%courseonly,\%failed);
                   20117:                 if (keys(%failed)) {
                   20118:                     my $numfailed = scalar(keys(%failed));
                   20119:                     push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
                   20120:                 }
                   20121:                 if (keys(%newunique)) {
                   20122:                     my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
                   20123:                     if ($putres eq 'ok') {
                   20124:                         $numnew = scalar(keys(%newunique));
                   20125:                         my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
                   20126:                         unless ($newputres eq 'ok') {
                   20127:                             push(@errors,&mt('error: could not store course look-up of short URLs'));
                   20128:                         }
                   20129:                     } else {
                   20130:                         push(@errors,&mt('error: could not store unique six character URLs'));
                   20131:                     }
                   20132:                 }
                   20133:                 my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
                   20134:                 unless ($dellockres eq 'ok') {
                   20135:                     push(@errors,&mt('error: could not release lockfile'));
                   20136:                 }
                   20137:             } else {
                   20138:                 push(@errors,&mt('error: could not obtain lockfile'));
                   20139:             }
                   20140:             if (keys(%courseonly)) {
                   20141:                 my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
                   20142:                 if ($result ne 'ok') {
                   20143:                     push(@errors,&mt('error: could not update course look-up of short URLs'));
                   20144:                 }
                   20145:             }
                   20146:         }
                   20147:     }
                   20148:     return ($numnew,\@errors);
                   20149: }
                   20150: 
                   20151: sub shorten_symbs {
                   20152:     my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
                   20153:     return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
                   20154:                    (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
                   20155:                    (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
                   20156:     my (%possibles,%collisions);
                   20157:     foreach my $key (keys(%{$tocreate})) {
                   20158:         my $num = String::CRC32::crc32($key);
                   20159:         my $tiny = $su->encode($num,$init);
                   20160:         if ($tiny) {
                   20161:             $possibles{$tiny} = $key;
                   20162:         }
                   20163:     }
                   20164:     if (!$init) {
                   20165:         $init = 1;
                   20166:     } else {
                   20167:         $init ++;
                   20168:     }
                   20169:     if (keys(%possibles)) {
                   20170:         my @posstiny = keys(%possibles);
                   20171:         my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
                   20172:         my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
                   20173:         if (keys(%currtiny)) {
                   20174:             foreach my $key (keys(%currtiny)) {
                   20175:                 next if ($currtiny{$key} eq '');
                   20176:                 if ($currtiny{$key} eq $possibles{$key}) {
                   20177:                     my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
                   20178:                     unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   20179:                         $courseonly->{$tsymb} = $key;
                   20180:                     }
                   20181:                 } else {
                   20182:                     $collisions{$possibles{$key}} = 1;
                   20183:                 }
                   20184:                 delete($possibles{$key});
                   20185:             }
                   20186:         }
                   20187:         foreach my $key (keys(%possibles)) {
                   20188:             $newunique->{$key} = $possibles{$key};
                   20189:             my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
                   20190:             unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   20191:                 $addcourse->{$tsymb} = $key;
                   20192:             }
                   20193:         }
                   20194:     }
                   20195:     if (keys(%collisions)) {
                   20196:         if ($init <5) {
                   20197:             if (!$init) {
                   20198:                 $init = 1;
                   20199:             } else {
                   20200:                 $init ++;
                   20201:             }
                   20202:             $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
                   20203:                                    $newunique,$addcourse,$courseonly,$failed);
                   20204:         } else {
                   20205:             foreach my $key (keys(%collisions)) {
                   20206:                 $failed->{$key} = 1;
                   20207:             }
                   20208:         }
                   20209:     }
                   20210:     return $init;
                   20211: }
                   20212: 
1.1328    raeburn  20213: sub is_nonframeable {
1.1329    raeburn  20214:     my ($url,$absolute,$hostname,$ip,$nocache) = @_;
                   20215:     my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330    raeburn  20216:     return if (($remprotocol eq '') || ($remhost eq ''));
1.1329    raeburn  20217: 
                   20218:     $remprotocol = lc($remprotocol);
                   20219:     $remhost = lc($remhost);
                   20220:     my $remport = 80;
                   20221:     if ($remprotocol eq 'https') {
                   20222:         $remport = 443;
                   20223:     }
1.1330    raeburn  20224:     my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329    raeburn  20225:     if ($cached) {
                   20226:         unless ($nocache) {
                   20227:             if ($result) {
                   20228:                 return 1;
                   20229:             } else {
                   20230:                 return 0;
                   20231:             }
                   20232:         }
                   20233:     }
1.1328    raeburn  20234:     my $uselink;
                   20235:     my $request = new HTTP::Request('HEAD',$url);
                   20236:     my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
                   20237:     if ($response->is_success()) {
                   20238:         my $secpolicy = lc($response->header('content-security-policy'));
                   20239:         my $xframeop = lc($response->header('x-frame-options'));
                   20240:         $secpolicy =~ s/^\s+|\s+$//g;
                   20241:         $xframeop =~ s/^\s+|\s+$//g;
                   20242:         if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329    raeburn  20243:             my $remotehost = $remprotocol.'://'.$remhost;
1.1328    raeburn  20244:             my ($origin,$protocol,$port);
                   20245:             if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
                   20246:                 $port = $ENV{'SERVER_PORT'};
                   20247:             } else {
                   20248:                 $port = 80;
                   20249:             }
                   20250:             if ($absolute eq '') {
                   20251:                 $protocol = 'http:';
                   20252:                 if ($port == 443) {
                   20253:                     $protocol = 'https:';
                   20254:                 }
                   20255:                 $origin = $protocol.'//'.lc($hostname);
                   20256:             } else {
                   20257:                 $origin = lc($absolute);
                   20258:                 ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
                   20259:             }
                   20260:             if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
                   20261:                 my $framepolicy = $1;
                   20262:                 $framepolicy =~ s/^\s+|\s+$//g;
                   20263:                 my @policies = split(/\s+/,$framepolicy);
                   20264:                 if (@policies) {
                   20265:                     if (grep(/^\Q'none'\E$/,@policies)) {
                   20266:                         $uselink = 1;
                   20267:                     } else {
                   20268:                         $uselink = 1;
                   20269:                         if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
                   20270:                                 (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
                   20271:                                 (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
                   20272:                             undef($uselink);
                   20273:                         }
                   20274:                         if ($uselink) {
                   20275:                             if (grep(/^\Q'self'\E$/,@policies)) {
                   20276:                                 if (($origin ne '') && ($remotehost eq $origin)) {
                   20277:                                     undef($uselink);
                   20278:                                 }
                   20279:                             }
                   20280:                         }
                   20281:                         if ($uselink) {
                   20282:                             my @possok;
                   20283:                             if ($ip ne '') {
                   20284:                                 push(@possok,$ip);
                   20285:                             }
                   20286:                             my $hoststr = '';
                   20287:                             foreach my $part (reverse(split(/\./,$hostname))) {
                   20288:                                 if ($hoststr eq '') {
                   20289:                                     $hoststr = $part;
                   20290:                                 } else {
                   20291:                                     $hoststr = "$part.$hoststr";
                   20292:                                 }
                   20293:                                 if ($hoststr eq $hostname) {
                   20294:                                     push(@possok,$hostname);
                   20295:                                 } else {
                   20296:                                     push(@possok,"*.$hoststr");
                   20297:                                 }
                   20298:                             }
                   20299:                             if (@possok) {
                   20300:                                 foreach my $poss (@possok) {
                   20301:                                     last if (!$uselink);
                   20302:                                     foreach my $policy (@policies) {
                   20303:                                         if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
                   20304:                                             undef($uselink);
                   20305:                                             last;
                   20306:                                         }
                   20307:                                     }
                   20308:                                 }
                   20309:                             }
                   20310:                         }
                   20311:                     }
                   20312:                 }
                   20313:             } elsif ($xframeop ne '') {
                   20314:                 $uselink = 1;
                   20315:                 my @policies = split(/\s*,\s*/,$xframeop);
                   20316:                 if (@policies) {
                   20317:                     unless (grep(/^deny$/,@policies)) {
                   20318:                         if ($origin ne '') {
                   20319:                             if (grep(/^sameorigin$/,@policies)) {
                   20320:                                 if ($remotehost eq $origin) {
                   20321:                                     undef($uselink);
                   20322:                                 }
                   20323:                             }
                   20324:                             if ($uselink) {
                   20325:                                 foreach my $policy (@policies) {
                   20326:                                     if ($policy =~ /^allow-from\s*(.+)$/) {
                   20327:                                         my $allowfrom = $1;
                   20328:                                         if (($allowfrom ne '') && ($allowfrom eq $origin)) {
                   20329:                                             undef($uselink);
                   20330:                                             last;
                   20331:                                         }
                   20332:                                     }
                   20333:                                 }
                   20334:                             }
                   20335:                         }
                   20336:                     }
                   20337:                 }
                   20338:             }
                   20339:         }
                   20340:     }
1.1329    raeburn  20341:     if ($nocache) {
                   20342:         if ($cached) {
                   20343:             my $devalidate;
                   20344:             if ($uselink && !$result) {
                   20345:                 $devalidate = 1;
                   20346:             } elsif (!$uselink && $result) {
                   20347:                 $devalidate = 1;
                   20348:             }
                   20349:             if ($devalidate) {
                   20350:                 &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
                   20351:             }
                   20352:         }
                   20353:     } else {
                   20354:         if ($uselink) {
                   20355:             $result = 1;
                   20356:         } else {
                   20357:             $result = 0;
                   20358:         }
                   20359:         &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
                   20360:     }
1.1328    raeburn  20361:     return $uselink;
                   20362: }
                   20363: 
1.1359    raeburn  20364: sub page_menu {
                   20365:     my ($menucolls,$menunum) = @_;
                   20366:     my %menu;
                   20367:     foreach my $item (split(/;/,$menucolls)) {
                   20368:         my ($num,$value) = split(/\%/,$item);
                   20369:         if ($num eq $menunum) {
                   20370:             my @entries = split(/\&/,$value);
                   20371:             foreach my $entry (@entries) {
                   20372:                 my ($name,$fields) = split(/=/,$entry);
1.1368    raeburn  20373:                 if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359    raeburn  20374:                     $menu{$name} = $fields;
                   20375:                 } else {
                   20376:                     my @shown;
                   20377:                     if ($fields =~ /,/) {
                   20378:                         @shown = split(/,/,$fields);
                   20379:                     } else {
                   20380:                         @shown = ($fields);
                   20381:                     }
                   20382:                     if (@shown) {
                   20383:                         foreach my $field (@shown) {
                   20384:                             next if ($field eq '');
                   20385:                             $menu{$field} = 1;
                   20386:                         }
                   20387:                     }
                   20388:                 }
                   20389:             }
                   20390:         }
                   20391:     }
                   20392:     return %menu;
                   20393: }
                   20394: 
1.112     bowersj2 20395: 1;
                   20396: __END__;
1.41      ng       20397: 

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