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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.1476  ! raeburn     4: # $Id: loncommon.pm,v 1.1475 2025/03/24 17:05:59 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.388     albertel 7995: span.LC_current_location {
1.701     harmsja  7996:   font-size:larger;
1.388     albertel 7997:   background: $pgbg;
                   7998: }
1.387     albertel 7999: 
1.1029    www      8000: span.LC_current_nav_location {
                   8001:   font-weight:bold;
                   8002:   background: $sidebg;
                   8003: }
                   8004: 
1.395     albertel 8005: span.LC_parm_menu_item {
                   8006:   font-size: larger;
                   8007: }
1.795     www      8008: 
1.395     albertel 8009: span.LC_parm_scope_all {
                   8010:   color: red;
                   8011: }
1.795     www      8012: 
1.395     albertel 8013: span.LC_parm_scope_folder {
                   8014:   color: green;
                   8015: }
1.795     www      8016: 
1.395     albertel 8017: span.LC_parm_scope_resource {
                   8018:   color: orange;
                   8019: }
1.795     www      8020: 
1.395     albertel 8021: span.LC_parm_part {
                   8022:   color: blue;
                   8023: }
1.795     www      8024: 
1.911     bisitz   8025: span.LC_parm_folder,
                   8026: span.LC_parm_symb {
1.395     albertel 8027:   font-size: x-small;
                   8028:   font-family: $mono;
                   8029:   color: #AAAAAA;
                   8030: }
                   8031: 
1.977     bisitz   8032: ul.LC_parm_parmlist li {
                   8033:   display: inline-block;
                   8034:   padding: 0.3em 0.8em;
                   8035:   vertical-align: top;
                   8036:   width: 150px;
                   8037:   border-top:1px solid $lg_border_color;
                   8038: }
                   8039: 
1.795     www      8040: td.LC_parm_overview_level_menu,
                   8041: td.LC_parm_overview_map_menu,
                   8042: td.LC_parm_overview_parm_selectors,
                   8043: td.LC_parm_overview_restrictions  {
1.396     albertel 8044:   border: 1px solid black;
                   8045:   border-collapse: collapse;
                   8046: }
1.795     www      8047: 
1.1285    raeburn  8048: span.LC_parm_recursive,
                   8049: td.LC_parm_recursive {
                   8050:   font-weight: bold;
                   8051:   font-size: smaller;
                   8052: }
                   8053: 
1.396     albertel 8054: table.LC_parm_overview_restrictions td {
                   8055:   border-width: 1px 4px 1px 4px;
                   8056:   border-style: solid;
                   8057:   border-color: $pgbg;
                   8058:   text-align: center;
                   8059: }
1.795     www      8060: 
1.396     albertel 8061: table.LC_parm_overview_restrictions th {
                   8062:   background: $tabbg;
                   8063:   border-width: 1px 4px 1px 4px;
                   8064:   border-style: solid;
                   8065:   border-color: $pgbg;
                   8066: }
1.795     www      8067: 
1.1459    raeburn  8068: h1.LC_helpmenu {
                   8069:   display: inline;
                   8070:   font-size: 100%;
                   8071:   font-weight: normal;
                   8072:   line-height: 1em;
                   8073:   margin: 0;
                   8074:   padding: 0;
                   8075:   border: 0;
1.398     albertel 8076: }
1.795     www      8077: 
1.1456    raeburn  8078: .LC_helpdesk_headbox {
                   8079:   border: 2px groove threedface;
                   8080:   padding: 1em;
                   8081: }
                   8082: 
                   8083: h1.LC_helpdesk_legend {
                   8084:   float: left;
                   8085:   margin: -1.7em 0 0;
                   8086:   padding: 0 .5em;
1.397     albertel 8087:   background: $pgbg;
1.1456    raeburn  8088:   font-size: 1em;
                   8089:   font-weight: bold;
                   8090: }
                   8091: 
                   8092: h1.LC_helpdesk_title {
                   8093:   display: inline;
                   8094:   font-size: 1em;
                   8095:   line-height: 2.5em;
                   8096:   margin: 0;
1.803     bisitz   8097:   padding: 0;
1.1456    raeburn  8098:   vertical-align: bottom;
1.397     albertel 8099: }
1.795     www      8100: 
1.1456    raeburn  8101: .LC_helpdesk_links {
                   8102:   border: 1px solid black;
                   8103:   padding: 3px;
1.397     albertel 8104:   background: $tabbg;
1.399     albertel 8105:   text-align: center;
                   8106:   font-weight: bold;
1.1456    raeburn  8107:   display: inline;
                   8108:   margin-right: -6px;
                   8109: }
                   8110: 
                   8111: .LC_helpdesk_img,
                   8112: .LC_helpdesk_text {
                   8113:   padding: 0;
                   8114:   margin: 0;
                   8115:   border: 0;
                   8116:   display: inline;
1.397     albertel 8117: }
1.396     albertel 8118: 
1.1456    raeburn  8119: .LC_helpdesk_img a:link,
                   8120: .LC_helpdesk_img a:visited,
                   8121: .LC_helpdesk_img a:active,
                   8122: .LC_helpdesk_text a:link,
                   8123: .LC_helpdesk_text a:visited,
                   8124: .LC_helpdesk_text a:active {
1.397     albertel 8125:   text-decoration: none;
                   8126:   color: $font;
                   8127: }
1.795     www      8128: 
1.1456    raeburn  8129: div.LC_helpdesk_text a:hover {
1.397     albertel 8130:   text-decoration: underline;
                   8131:   color: $vlink;
                   8132: }
1.396     albertel 8133: 
1.417     albertel 8134: .LC_chrt_popup_exists {
                   8135:   border: 1px solid #339933;
                   8136:   margin: -1px;
                   8137: }
1.795     www      8138: 
1.417     albertel 8139: .LC_chrt_popup_up {
                   8140:   border: 1px solid yellow;
                   8141:   margin: -1px;
                   8142: }
1.795     www      8143: 
1.417     albertel 8144: .LC_chrt_popup {
                   8145:   border: 1px solid #8888FF;
                   8146:   background: #CCCCFF;
                   8147: }
1.795     www      8148: 
1.421     albertel 8149: table.LC_pick_box {
                   8150:   border-collapse: separate;
                   8151:   background: white;
                   8152:   border: 1px solid black;
                   8153:   border-spacing: 1px;
                   8154: }
1.795     www      8155: 
1.1454    raeburn  8156: table.LC_pick_box th.LC_pick_box_title {
1.850     bisitz   8157:   background: $sidebg;
1.421     albertel 8158:   font-weight: bold;
1.900     bisitz   8159:   text-align: left;
1.740     bisitz   8160:   vertical-align: top;
1.421     albertel 8161:   width: 184px;
                   8162:   padding: 8px;
                   8163: }
1.795     www      8164: 
1.579     raeburn  8165: table.LC_pick_box td.LC_pick_box_value {
                   8166:   text-align: left;
                   8167:   padding: 8px;
                   8168: }
1.795     www      8169: 
1.579     raeburn  8170: table.LC_pick_box td.LC_pick_box_select {
                   8171:   text-align: left;
                   8172:   padding: 8px;
                   8173: }
1.795     www      8174: 
1.424     albertel 8175: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   8176:   padding: 0;
1.421     albertel 8177:   height: 1px;
                   8178:   background: black;
                   8179: }
1.795     www      8180: 
1.421     albertel 8181: table.LC_pick_box td.LC_pick_box_submit {
                   8182:   text-align: right;
                   8183: }
1.795     www      8184: 
1.579     raeburn  8185: table.LC_pick_box td.LC_evenrow_value {
                   8186:   text-align: left;
                   8187:   padding: 8px;
                   8188:   background-color: $data_table_light;
                   8189: }
1.795     www      8190: 
1.579     raeburn  8191: table.LC_pick_box td.LC_oddrow_value {
                   8192:   text-align: left;
                   8193:   padding: 8px;
                   8194:   background-color: $data_table_light;
                   8195: }
1.795     www      8196: 
1.1473    raeburn  8197: td.LC_log_filter,
                   8198: th.LC_log_filter {
                   8199:   vertical-align: top;
                   8200:   text-align: left;
                   8201:   padding: 0 4px;
                   8202: }
                   8203: 
1.579     raeburn  8204: span.LC_helpform_receipt_cat {
                   8205:   font-weight: bold;
                   8206: }
1.795     www      8207: 
1.424     albertel 8208: table.LC_group_priv_box {
                   8209:   background: white;
                   8210:   border: 1px solid black;
                   8211:   border-spacing: 1px;
                   8212: }
1.795     www      8213: 
1.424     albertel 8214: table.LC_group_priv_box td.LC_pick_box_title {
                   8215:   background: $tabbg;
                   8216:   font-weight: bold;
                   8217:   text-align: right;
                   8218:   width: 184px;
                   8219: }
1.795     www      8220: 
1.424     albertel 8221: table.LC_group_priv_box td.LC_groups_fixed {
                   8222:   background: $data_table_light;
                   8223:   text-align: center;
                   8224: }
1.795     www      8225: 
1.424     albertel 8226: table.LC_group_priv_box td.LC_groups_optional {
                   8227:   background: $data_table_dark;
                   8228:   text-align: center;
                   8229: }
1.795     www      8230: 
1.424     albertel 8231: table.LC_group_priv_box td.LC_groups_functionality {
                   8232:   background: $data_table_darker;
                   8233:   text-align: center;
                   8234:   font-weight: bold;
                   8235: }
1.795     www      8236: 
1.424     albertel 8237: table.LC_group_priv td {
                   8238:   text-align: left;
1.803     bisitz   8239:   padding: 0;
1.424     albertel 8240: }
                   8241: 
                   8242: .LC_navbuttons {
                   8243:   margin: 2ex 0ex 2ex 0ex;
                   8244: }
1.795     www      8245: 
1.423     albertel 8246: .LC_topic_bar {
                   8247:   font-weight: bold;
                   8248:   background: $tabbg;
1.918     wenzelju 8249:   margin: 1em 0em 1em 2em;
1.805     bisitz   8250:   padding: 3px;
1.918     wenzelju 8251:   font-size: 1.2em;
1.423     albertel 8252: }
1.795     www      8253: 
1.423     albertel 8254: .LC_topic_bar span {
1.918     wenzelju 8255:   left: 0.5em;
                   8256:   position: absolute;
1.423     albertel 8257:   vertical-align: middle;
1.918     wenzelju 8258:   font-size: 1.2em;
1.423     albertel 8259: }
1.795     www      8260: 
1.423     albertel 8261: table.LC_course_group_status {
                   8262:   margin: 20px;
                   8263: }
1.795     www      8264: 
1.423     albertel 8265: table.LC_status_selector td {
                   8266:   vertical-align: top;
                   8267:   text-align: center;
1.424     albertel 8268:   padding: 4px;
                   8269: }
1.795     www      8270: 
1.599     albertel 8271: div.LC_feedback_link {
1.616     albertel 8272:   clear: both;
1.829     kalberla 8273:   background: $sidebg;
1.779     bisitz   8274:   width: 100%;
1.829     kalberla 8275:   padding-bottom: 10px;
                   8276:   border: 1px $tabbg solid;
1.833     kalberla 8277:   height: 22px;
                   8278:   line-height: 22px;
                   8279:   padding-top: 5px;
                   8280: }
                   8281: 
                   8282: div.LC_feedback_link img {
                   8283:   height: 22px;
1.867     kalberla 8284:   vertical-align:middle;
1.829     kalberla 8285: }
                   8286: 
1.911     bisitz   8287: div.LC_feedback_link a {
1.829     kalberla 8288:   text-decoration: none;
1.489     raeburn  8289: }
1.795     www      8290: 
1.867     kalberla 8291: div.LC_comblock {
1.911     bisitz   8292:   display:inline;
1.867     kalberla 8293:   color:$font;
                   8294:   font-size:90%;
                   8295: }
                   8296: 
                   8297: div.LC_feedback_link div.LC_comblock {
                   8298:   padding-left:5px;
                   8299: }
                   8300: 
                   8301: div.LC_feedback_link div.LC_comblock a {
                   8302:   color:$font;
                   8303: }
                   8304: 
1.489     raeburn  8305: span.LC_feedback_link {
1.858     bisitz   8306:   /* background: $feedback_link_bg; */
1.599     albertel 8307:   font-size: larger;
                   8308: }
1.795     www      8309: 
1.599     albertel 8310: span.LC_message_link {
1.858     bisitz   8311:   /* background: $feedback_link_bg; */
1.599     albertel 8312:   font-size: larger;
                   8313:   position: absolute;
                   8314:   right: 1em;
1.489     raeburn  8315: }
1.421     albertel 8316: 
1.515     albertel 8317: table.LC_prior_tries {
1.524     albertel 8318:   border: 1px solid #000000;
                   8319:   border-collapse: separate;
                   8320:   border-spacing: 1px;
1.515     albertel 8321: }
1.523     albertel 8322: 
1.515     albertel 8323: table.LC_prior_tries td {
1.524     albertel 8324:   padding: 2px;
1.515     albertel 8325: }
1.523     albertel 8326: 
                   8327: .LC_answer_correct {
1.795     www      8328:   background: lightgreen;
                   8329:   color: darkgreen;
                   8330:   padding: 6px;
1.523     albertel 8331: }
1.795     www      8332: 
1.523     albertel 8333: .LC_answer_charged_try {
1.797     www      8334:   background: #FFAAAA;
1.795     www      8335:   color: darkred;
                   8336:   padding: 6px;
1.523     albertel 8337: }
1.795     www      8338: 
1.779     bisitz   8339: .LC_answer_not_charged_try,
1.523     albertel 8340: .LC_answer_no_grade,
                   8341: .LC_answer_late {
1.795     www      8342:   background: lightyellow;
1.523     albertel 8343:   color: black;
1.795     www      8344:   padding: 6px;
1.523     albertel 8345: }
1.795     www      8346: 
1.523     albertel 8347: .LC_answer_previous {
1.795     www      8348:   background: lightblue;
                   8349:   color: darkblue;
                   8350:   padding: 6px;
1.523     albertel 8351: }
1.795     www      8352: 
1.779     bisitz   8353: .LC_answer_no_message {
1.777     tempelho 8354:   background: #FFFFFF;
                   8355:   color: black;
1.795     www      8356:   padding: 6px;
1.779     bisitz   8357: }
1.795     www      8358: 
1.1334    raeburn  8359: .LC_answer_unknown,
                   8360: .LC_answer_warning {
1.779     bisitz   8361:   background: orange;
                   8362:   color: black;
1.795     www      8363:   padding: 6px;
1.777     tempelho 8364: }
1.795     www      8365: 
1.1467    raeburn  8366: span.LC_prob_status {
                   8367:   margin: 5px 0 0 0;
                   8368:   padding: 0 5px 0 0;
                   8369:   vertical-align: middle;
                   8370: }
                   8371: 
                   8372: div.LC_prob_status_outer {
                   8373:   display: inline-block;
                   8374:   margin: -5px 0 0 0;
                   8375:   padding: 0;
                   8376: }
                   8377: 
                   8378: div.LC_prob_status_inner {
                   8379:   display: inline-block;
                   8380:   margin: 0 5px 0 0;
                   8381:   padding: 5px;
1.1446    raeburn  8382: }
                   8383: 
1.1468    raeburn  8384: caption.LC_filesub_status {
                   8385:   text-align: left;
                   8386:   font-weight: bold;
                   8387: }
                   8388: 
1.1448    raeburn  8389: .LC_mail_actions {
                   8390:   float: left;
                   8391:   padding: 0;
                   8392:   margin: 6px;
                   8393: }
                   8394: 
                   8395: .LC_vertical_line {
                   8396:   width: 1px;
                   8397:   background-color: black;
                   8398:   height: 4em;
                   8399:   float: left;
                   8400:   margin: 0;
                   8401:   padding: 0;
                   8402: }
                   8403: 
1.529     albertel 8404: span.LC_prior_numerical,
                   8405: span.LC_prior_string,
                   8406: span.LC_prior_custom,
                   8407: span.LC_prior_reaction,
                   8408: span.LC_prior_math {
1.925     bisitz   8409:   font-family: $mono;
1.523     albertel 8410:   white-space: pre;
                   8411: }
                   8412: 
1.525     albertel 8413: span.LC_prior_string {
1.925     bisitz   8414:   font-family: $mono;
1.525     albertel 8415:   white-space: pre;
                   8416: }
                   8417: 
1.523     albertel 8418: table.LC_prior_option {
                   8419:   width: 100%;
                   8420:   border-collapse: collapse;
                   8421: }
1.795     www      8422: 
1.911     bisitz   8423: table.LC_prior_rank,
1.795     www      8424: table.LC_prior_match {
1.528     albertel 8425:   border-collapse: collapse;
                   8426: }
1.795     www      8427: 
1.528     albertel 8428: table.LC_prior_option tr td,
                   8429: table.LC_prior_rank tr td,
                   8430: table.LC_prior_match tr td {
1.524     albertel 8431:   border: 1px solid #000000;
1.515     albertel 8432: }
                   8433: 
1.855     bisitz   8434: .LC_nobreak {
1.544     albertel 8435:   white-space: nowrap;
1.519     raeburn  8436: }
                   8437: 
1.576     raeburn  8438: span.LC_cusr_emph {
                   8439:   font-style: italic;
                   8440: }
                   8441: 
1.633     raeburn  8442: span.LC_cusr_subheading {
                   8443:   font-weight: normal;
                   8444:   font-size: 85%;
                   8445: }
                   8446: 
1.861     bisitz   8447: div.LC_docs_entry_move {
1.859     bisitz   8448:   border: 1px solid #BBBBBB;
1.545     albertel 8449:   background: #DDDDDD;
1.861     bisitz   8450:   width: 22px;
1.859     bisitz   8451:   padding: 1px;
                   8452:   margin: 0;
1.545     albertel 8453: }
                   8454: 
1.861     bisitz   8455: table.LC_data_table tr > td.LC_docs_entry_commands,
                   8456: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 8457:   font-size: x-small;
                   8458: }
1.795     www      8459: 
1.861     bisitz   8460: .LC_docs_entry_parameter {
                   8461:   white-space: nowrap;
                   8462: }
                   8463: 
1.544     albertel 8464: .LC_docs_copy {
1.545     albertel 8465:   color: #000099;
1.544     albertel 8466: }
1.795     www      8467: 
1.544     albertel 8468: .LC_docs_cut {
1.545     albertel 8469:   color: #550044;
1.544     albertel 8470: }
1.795     www      8471: 
1.544     albertel 8472: .LC_docs_rename {
1.545     albertel 8473:   color: #009900;
1.544     albertel 8474: }
1.795     www      8475: 
1.544     albertel 8476: .LC_docs_remove {
1.545     albertel 8477:   color: #990000;
                   8478: }
                   8479: 
1.1284    raeburn  8480: .LC_docs_alias {
                   8481:   color: #440055;  
                   8482: }
                   8483: 
1.1286    raeburn  8484: .LC_domprefs_email,
1.1284    raeburn  8485: .LC_docs_alias_name,
1.547     albertel 8486: .LC_docs_reinit_warn,
                   8487: .LC_docs_ext_edit {
                   8488:   font-size: x-small;
                   8489: }
                   8490: 
1.545     albertel 8491: table.LC_docs_adddocs td,
                   8492: table.LC_docs_adddocs th {
                   8493:   border: 1px solid #BBBBBB;
                   8494:   padding: 4px;
                   8495:   background: #DDDDDD;
1.543     albertel 8496: }
                   8497: 
1.584     albertel 8498: table.LC_sty_begin {
                   8499:   background: #BBFFBB;
                   8500: }
1.795     www      8501: 
1.584     albertel 8502: table.LC_sty_end {
                   8503:   background: #FFBBBB;
                   8504: }
                   8505: 
1.589     raeburn  8506: table.LC_double_column {
1.803     bisitz   8507:   border-width: 0;
1.589     raeburn  8508:   border-collapse: collapse;
                   8509:   width: 100%;
                   8510:   padding: 2px;
                   8511: }
                   8512: 
                   8513: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  8514:   top: 2px;
1.589     raeburn  8515:   left: 2px;
                   8516:   width: 47%;
                   8517:   vertical-align: top;
                   8518: }
                   8519: 
                   8520: table.LC_double_column tr td.LC_right_col {
                   8521:   top: 2px;
1.779     bisitz   8522:   right: 2px;
1.589     raeburn  8523:   width: 47%;
                   8524:   vertical-align: top;
                   8525: }
                   8526: 
1.591     raeburn  8527: div.LC_left_float {
                   8528:   float: left;
                   8529:   padding-right: 5%;
1.597     albertel 8530:   padding-bottom: 4px;
1.591     raeburn  8531: }
                   8532: 
                   8533: div.LC_clear_float_header {
1.597     albertel 8534:   padding-bottom: 2px;
1.591     raeburn  8535: }
                   8536: 
                   8537: div.LC_clear_float_footer {
1.597     albertel 8538:   padding-top: 10px;
1.591     raeburn  8539:   clear: both;
                   8540: }
                   8541: 
1.597     albertel 8542: div.LC_grade_show_user {
1.941     bisitz   8543: /*  border-left: 5px solid $sidebg; */
                   8544:   border-top: 5px solid #000000;
                   8545:   margin: 50px 0 0 0;
1.936     bisitz   8546:   padding: 15px 0 5px 10px;
1.597     albertel 8547: }
1.795     www      8548: 
1.936     bisitz   8549: div.LC_grade_show_user_odd_row {
1.941     bisitz   8550: /*  border-left: 5px solid #000000; */
                   8551: }
                   8552: 
                   8553: div.LC_grade_show_user div.LC_Box {
                   8554:   margin-right: 50px;
1.597     albertel 8555: }
                   8556: 
1.1461    raeburn  8557: div.LC_grade_show_user div.LC_Box table tr th {
                   8558:   font-weight: normal;
                   8559: }
                   8560: 
1.597     albertel 8561: div.LC_grade_submissions,
                   8562: div.LC_grade_message_center,
1.936     bisitz   8563: div.LC_grade_info_links {
1.597     albertel 8564:   margin: 5px;
                   8565:   width: 99%;
                   8566:   background: #FFFFFF;
                   8567: }
1.795     www      8568: 
1.597     albertel 8569: div.LC_grade_submissions_header,
1.936     bisitz   8570: div.LC_grade_message_center_header {
1.705     tempelho 8571:   font-weight: bold;
                   8572:   font-size: large;
1.597     albertel 8573: }
1.795     www      8574: 
1.597     albertel 8575: div.LC_grade_submissions_body,
1.936     bisitz   8576: div.LC_grade_message_center_body {
1.597     albertel 8577:   border: 1px solid black;
                   8578:   width: 99%;
                   8579:   background: #FFFFFF;
                   8580: }
1.795     www      8581: 
1.613     albertel 8582: table.LC_scantron_action {
                   8583:   width: 100%;
                   8584: }
1.795     www      8585: 
1.613     albertel 8586: table.LC_scantron_action tr th {
1.698     harmsja  8587:   font-weight:bold;
                   8588:   font-style:normal;
1.613     albertel 8589: }
1.795     www      8590: 
1.1461    raeburn  8591: div.LC_edit_problem_daxe_header {
                   8592:   padding: 3px;
                   8593:   background: $tabbg;
                   8594:   z-index: 100;
                   8595: }
                   8596: 
1.779     bisitz   8597: .LC_edit_problem_header,
1.614     albertel 8598: div.LC_edit_problem_footer {
1.705     tempelho 8599:   font-weight: normal;
                   8600:   font-size:  medium;
1.602     albertel 8601:   margin: 2px;
1.1060    bisitz   8602:   background-color: $sidebg;
1.600     albertel 8603: }
1.795     www      8604: 
1.600     albertel 8605: div.LC_edit_problem_header,
1.602     albertel 8606: div.LC_edit_problem_header div,
1.614     albertel 8607: div.LC_edit_problem_footer,
                   8608: div.LC_edit_problem_footer div,
1.602     albertel 8609: div.LC_edit_problem_editxml_header,
                   8610: div.LC_edit_problem_editxml_header div {
1.1205    golterma 8611:   z-index: 100;
1.600     albertel 8612: }
1.795     www      8613: 
1.600     albertel 8614: div.LC_edit_problem_header_title {
1.705     tempelho 8615:   font-weight: bold;
                   8616:   font-size: larger;
1.602     albertel 8617:   background: $tabbg;
                   8618:   padding: 3px;
1.1060    bisitz   8619:   margin: 0 0 5px 0;
1.602     albertel 8620: }
1.795     www      8621: 
1.602     albertel 8622: table.LC_edit_problem_header_title {
                   8623:   width: 100%;
1.600     albertel 8624:   background: $tabbg;
1.602     albertel 8625: }
                   8626: 
1.1205    golterma 8627: div.LC_edit_actionbar {
                   8628:     background-color: $sidebg;
1.1218    droeschl 8629:     margin: 0;
                   8630:     padding: 0;
                   8631:     line-height: 200%;
1.602     albertel 8632: }
1.795     www      8633: 
1.1218    droeschl 8634: div.LC_edit_actionbar div{
                   8635:     padding: 0;
                   8636:     margin: 0;
                   8637:     display: inline-block;
1.600     albertel 8638: }
1.795     www      8639: 
1.1124    bisitz   8640: .LC_edit_opt {
                   8641:   padding-left: 1em;
                   8642:   white-space: nowrap;
                   8643: }
                   8644: 
1.1152    golterma 8645: .LC_edit_problem_latexhelper{
                   8646:     text-align: right;
                   8647: }
                   8648: 
                   8649: #LC_edit_problem_colorful div{
                   8650:     margin-left: 40px;
                   8651: }
                   8652: 
1.1205    golterma 8653: #LC_edit_problem_codemirror div{
                   8654:     margin-left: 0px;
                   8655: }
                   8656: 
1.911     bisitz   8657: img.stift {
1.803     bisitz   8658:   border-width: 0;
                   8659:   vertical-align: middle;
1.677     riegler  8660: }
1.680     riegler  8661: 
1.1460    raeburn  8662: div.LC_mainmenu {
                   8663:   margin: 3px 2px 2px 1px;
                   8664:   float: left;
1.777     tempelho 8665: }
1.795     www      8666: 
1.716     raeburn  8667: div.LC_createcourse {
1.911     bisitz   8668:   margin: 10px 10px 10px 10px;
1.716     raeburn  8669: }
                   8670: 
1.917     raeburn  8671: .LC_dccid {
1.1130    raeburn  8672:   float: right;
1.917     raeburn  8673:   margin: 0.2em 0 0 0;
                   8674:   padding: 0;
                   8675:   font-size: 90%;
                   8676:   display:none;
                   8677: }
                   8678: 
1.897     wenzelju 8679: ol.LC_primary_menu a:hover,
1.721     harmsja  8680: ol#LC_MenuBreadcrumbs a:hover,
                   8681: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 8682: ul#LC_secondary_menu a:hover,
1.721     harmsja  8683: .LC_FormSectionClearButton input:hover
1.795     www      8684: ul.LC_TabContent   li:hover a {
1.952     onken    8685:   color:$button_hover;
1.911     bisitz   8686:   text-decoration:none;
1.693     droeschl 8687: }
                   8688: 
1.779     bisitz   8689: h1 {
1.911     bisitz   8690:   padding: 0;
                   8691:   line-height:130%;
1.693     droeschl 8692: }
1.698     harmsja  8693: 
1.911     bisitz   8694: h2,
                   8695: h3,
                   8696: h4,
                   8697: h5,
                   8698: h6 {
                   8699:   margin: 5px 0 5px 0;
                   8700:   padding: 0;
                   8701:   line-height:130%;
1.693     droeschl 8702: }
1.795     www      8703: 
                   8704: .LC_hcell {
1.911     bisitz   8705:   padding:3px 15px 3px 15px;
                   8706:   margin: 0;
                   8707:   background-color:$tabbg;
                   8708:   color:$fontmenu;
                   8709:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 8710: }
1.795     www      8711: 
1.1476  ! raeburn  8712: .LC_MainMenu_Box > .LC_hcell,
1.840     bisitz   8713: .LC_Box > .LC_hcell {
1.911     bisitz   8714:   margin: 0 -10px 10px -10px;
1.835     bisitz   8715: }
                   8716: 
1.721     harmsja  8717: .LC_noBorder {
1.911     bisitz   8718:   border: 0;
1.698     harmsja  8719: }
1.693     droeschl 8720: 
1.721     harmsja  8721: .LC_FormSectionClearButton input {
1.911     bisitz   8722:   background-color:transparent;
                   8723:   border: none;
                   8724:   cursor:pointer;
                   8725:   text-decoration:underline;
1.693     droeschl 8726: }
1.763     bisitz   8727: 
                   8728: .LC_help_open_topic {
1.911     bisitz   8729:   color: #FFFFFF;
                   8730:   background-color: #EEEEFF;
                   8731:   margin: 1px;
                   8732:   padding: 4px;
                   8733:   border: 1px solid #000033;
                   8734:   white-space: nowrap;
                   8735:   /* vertical-align: middle; */
1.759     neumanie 8736: }
1.693     droeschl 8737: 
1.911     bisitz   8738: dl,
                   8739: ul,
                   8740: div,
                   8741: fieldset {
                   8742:   margin: 10px 10px 10px 0;
                   8743:   /* overflow: hidden; */
1.693     droeschl 8744: }
1.795     www      8745: 
1.1404    raeburn  8746: fieldset#LC_selectuser {
1.1460    raeburn  8747:   margin: -1px 0 0 0;
                   8748:   padding: 0;
                   8749:   border: 0;
1.1404    raeburn  8750: }
                   8751: 
1.1473    raeburn  8752: fieldset.LC_delete_slot {
                   8753:   display:inline;
                   8754:   margin: 0 4px 4px;
                   8755:   padding: 4px;
                   8756: }
                   8757: 
                   8758: fieldset.LC_delete_slot > legend {
                   8759:   font-weight: normal;
                   8760: }
                   8761: 
                   8762: p.LC_medium_line {
                   8763:   line-height: 0.85em;
                   8764: }
                   8765: 
1.1211    raeburn  8766: article.geogebraweb div {
                   8767:     margin: 0;
                   8768: }
                   8769: 
1.838     bisitz   8770: fieldset > legend {
1.911     bisitz   8771:   font-weight: bold;
                   8772:   padding: 0 5px 0 5px;
1.838     bisitz   8773: }
                   8774: 
1.813     bisitz   8775: #LC_nav_bar {
1.911     bisitz   8776:   float: left;
1.995     raeburn  8777:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   8778:   margin: 0 0 2px 0;
1.807     droeschl 8779: }
                   8780: 
1.916     droeschl 8781: #LC_realm {
                   8782:   margin: 0.2em 0 0 0;
                   8783:   padding: 0;
                   8784:   font-weight: bold;
                   8785:   text-align: center;
1.995     raeburn  8786:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 8787: }
                   8788: 
1.911     bisitz   8789: #LC_nav_bar em {
                   8790:   font-weight: bold;
                   8791:   font-style: normal;
1.807     droeschl 8792: }
                   8793: 
1.897     wenzelju 8794: ol.LC_primary_menu {
1.934     droeschl 8795:   margin: 0;
1.1076    raeburn  8796:   padding: 0;
1.807     droeschl 8797: }
                   8798: 
1.852     droeschl 8799: ol#LC_PathBreadcrumbs {
1.911     bisitz   8800:   margin: 0;
1.693     droeschl 8801: }
                   8802: 
1.897     wenzelju 8803: ol.LC_primary_menu li {
1.1076    raeburn  8804:   color: RGB(80, 80, 80);
                   8805:   vertical-align: middle;
                   8806:   text-align: left;
                   8807:   list-style: none;
1.1205    golterma 8808:   position: relative;
1.1076    raeburn  8809:   float: left;
1.1205    golterma 8810:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   8811:   line-height: 1.5em;
1.1076    raeburn  8812: }
                   8813: 
1.1205    golterma 8814: ol.LC_primary_menu li a,
                   8815: ol.LC_primary_menu li p {
1.1076    raeburn  8816:   display: block;
                   8817:   margin: 0;
                   8818:   padding: 0 5px 0 10px;
                   8819:   text-decoration: none;
                   8820: }
                   8821: 
1.1205    golterma 8822: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   8823:   display: inline-block;
                   8824:   width: 95%;
                   8825:   text-align: left;
                   8826: }
                   8827: 
                   8828: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   8829:   display: inline-block;	
                   8830:   width: 5%;
                   8831:   float: right;
                   8832:   text-align: right;
                   8833:   font-size: 70%;
                   8834: }
                   8835: 
                   8836: ol.LC_primary_menu ul {
1.1076    raeburn  8837:   display: none;
1.1205    golterma 8838:   width: 15em;
1.1076    raeburn  8839:   background-color: $data_table_light;
1.1205    golterma 8840:   position: absolute;
                   8841:   top: 100%;
1.1076    raeburn  8842: }
                   8843: 
1.1205    golterma 8844: ol.LC_primary_menu ul ul {
                   8845:   left: 100%;
                   8846:   top: 0;
                   8847: }
                   8848: 
                   8849: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076    raeburn  8850:   display: block;
                   8851:   position: absolute;
                   8852:   margin: 0;
                   8853:   padding: 0;
1.1078    raeburn  8854:   z-index: 2;
1.1076    raeburn  8855: }
                   8856: 
                   8857: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205    golterma 8858: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076    raeburn  8859:   font-size: 90%;
1.911     bisitz   8860:   vertical-align: top;
1.1076    raeburn  8861:   float: none;
1.1079    raeburn  8862:   border-left: 1px solid black;
                   8863:   border-right: 1px solid black;
1.1205    golterma 8864: /* A dark bottom border to visualize different menu options; 
                   8865: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   8866:   border-bottom: 1px solid $data_table_dark; 
1.1076    raeburn  8867: }
                   8868: 
1.1205    golterma 8869: ol.LC_primary_menu li li p:hover {
                   8870:   color:$button_hover;
                   8871:   text-decoration:none;
                   8872:   background-color:$data_table_dark;
1.1076    raeburn  8873: }
                   8874: 
                   8875: ol.LC_primary_menu li li a:hover {
                   8876:    color:$button_hover;
                   8877:    background-color:$data_table_dark;
1.693     droeschl 8878: }
                   8879: 
1.1205    golterma 8880: /* Font-size equal to the size of the predecessors*/
                   8881: ol.LC_primary_menu li:hover li li {
                   8882:   font-size: 100%;
                   8883: }
                   8884: 
1.897     wenzelju 8885: ol.LC_primary_menu li img {
1.911     bisitz   8886:   vertical-align: bottom;
1.934     droeschl 8887:   height: 1.1em;
1.1077    raeburn  8888:   margin: 0.2em 0 0 0;
1.693     droeschl 8889: }
                   8890: 
1.897     wenzelju 8891: ol.LC_primary_menu a {
1.911     bisitz   8892:   color: RGB(80, 80, 80);
                   8893:   text-decoration: none;
1.693     droeschl 8894: }
1.795     www      8895: 
1.949     droeschl 8896: ol.LC_primary_menu a.LC_new_message {
                   8897:   font-weight:bold;
                   8898:   color: darkred;
                   8899: }
                   8900: 
1.975     raeburn  8901: ol.LC_docs_parameters {
                   8902:   margin-left: 0;
                   8903:   padding: 0;
                   8904:   list-style: none;
                   8905: }
                   8906: 
                   8907: ol.LC_docs_parameters li {
                   8908:   margin: 0;
                   8909:   padding-right: 20px;
                   8910:   display: inline;
                   8911: }
                   8912: 
1.976     raeburn  8913: ol.LC_docs_parameters li:before {
                   8914:   content: "\\002022 \\0020";
                   8915: }
                   8916: 
                   8917: li.LC_docs_parameters_title {
                   8918:   font-weight: bold;
                   8919: }
                   8920: 
                   8921: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   8922:   content: "";
                   8923: }
                   8924: 
1.897     wenzelju 8925: ul#LC_secondary_menu {
1.1107    raeburn  8926:   clear: right;
1.911     bisitz   8927:   color: $fontmenu;
                   8928:   background: $tabbg;
                   8929:   list-style: none;
                   8930:   padding: 0;
                   8931:   margin: 0;
                   8932:   width: 100%;
1.995     raeburn  8933:   text-align: left;
1.1107    raeburn  8934:   float: left;
1.808     droeschl 8935: }
                   8936: 
1.897     wenzelju 8937: ul#LC_secondary_menu li {
1.911     bisitz   8938:   font-weight: bold;
                   8939:   line-height: 1.8em;
1.1107    raeburn  8940:   border-right: 1px solid black;
                   8941:   float: left;
                   8942: }
                   8943: 
                   8944: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   8945:   background-color: $data_table_light;
                   8946: }
                   8947: 
                   8948: ul#LC_secondary_menu li a {
1.911     bisitz   8949:   padding: 0 0.8em;
1.1107    raeburn  8950: }
                   8951: 
                   8952: ul#LC_secondary_menu li ul {
                   8953:   display: none;
                   8954: }
                   8955: 
                   8956: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   8957:   display: block;
                   8958:   position: absolute;
                   8959:   margin: 0;
                   8960:   padding: 0;
                   8961:   list-style:none;
                   8962:   float: none;
                   8963:   background-color: $data_table_light;
                   8964:   z-index: 2;
                   8965:   margin-left: -1px;
                   8966: }
                   8967: 
                   8968: ul#LC_secondary_menu li ul li {
                   8969:   font-size: 90%;
                   8970:   vertical-align: top;
                   8971:   border-left: 1px solid black;
1.911     bisitz   8972:   border-right: 1px solid black;
1.1119    raeburn  8973:   background-color: $data_table_light;
1.1107    raeburn  8974:   list-style:none;
                   8975:   float: none;
                   8976: }
                   8977: 
                   8978: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   8979:   background-color: $data_table_dark;
1.807     droeschl 8980: }
                   8981: 
1.847     tempelho 8982: ul.LC_TabContent {
1.911     bisitz   8983:   display:block;
                   8984:   background: $sidebg;
                   8985:   border-bottom: solid 1px $lg_border_color;
                   8986:   list-style:none;
1.1020    raeburn  8987:   margin: -1px -10px 0 -10px;
1.911     bisitz   8988:   padding: 0;
1.693     droeschl 8989: }
                   8990: 
1.795     www      8991: ul.LC_TabContent li,
                   8992: ul.LC_TabContentBigger li {
1.911     bisitz   8993:   float:left;
1.741     harmsja  8994: }
1.795     www      8995: 
1.897     wenzelju 8996: ul#LC_secondary_menu li a {
1.911     bisitz   8997:   color: $fontmenu;
                   8998:   text-decoration: none;
1.693     droeschl 8999: }
1.795     www      9000: 
1.721     harmsja  9001: ul.LC_TabContent {
1.952     onken    9002:   min-height:20px;
1.721     harmsja  9003: }
1.795     www      9004: 
                   9005: ul.LC_TabContent li {
1.911     bisitz   9006:   vertical-align:middle;
1.959     onken    9007:   padding: 0 16px 0 10px;
1.911     bisitz   9008:   background-color:$tabbg;
                   9009:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  9010:   border-left: solid 1px $font;
1.721     harmsja  9011: }
1.795     www      9012: 
1.847     tempelho 9013: ul.LC_TabContent .right {
1.911     bisitz   9014:   float:right;
1.847     tempelho 9015: }
                   9016: 
1.911     bisitz   9017: ul.LC_TabContent li a,
                   9018: ul.LC_TabContent li {
                   9019:   color:rgb(47,47,47);
                   9020:   text-decoration:none;
                   9021:   font-size:95%;
                   9022:   font-weight:bold;
1.952     onken    9023:   min-height:20px;
                   9024: }
                   9025: 
1.959     onken    9026: ul.LC_TabContent li a:hover,
                   9027: ul.LC_TabContent li a:focus {
1.952     onken    9028:   color: $button_hover;
1.959     onken    9029:   background:none;
                   9030:   outline:none;
1.952     onken    9031: }
                   9032: 
                   9033: ul.LC_TabContent li:hover {
                   9034:   color: $button_hover;
                   9035:   cursor:pointer;
1.721     harmsja  9036: }
1.795     www      9037: 
1.911     bisitz   9038: ul.LC_TabContent li.active {
1.952     onken    9039:   color: $font;
1.911     bisitz   9040:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    9041:   border-bottom:solid 1px #FFFFFF;
                   9042:   cursor: default;
1.744     ehlerst  9043: }
1.795     www      9044: 
1.959     onken    9045: ul.LC_TabContent li.active a {
                   9046:   color:$font;
                   9047:   background:#FFFFFF;
                   9048:   outline: none;
                   9049: }
1.1047    raeburn  9050: 
                   9051: ul.LC_TabContent li.goback {
                   9052:   float: left;
                   9053:   border-left: none;
                   9054: }
                   9055: 
1.870     tempelho 9056: #maincoursedoc {
1.911     bisitz   9057:   clear:both;
1.870     tempelho 9058: }
                   9059: 
                   9060: ul.LC_TabContentBigger {
1.911     bisitz   9061:   display:block;
                   9062:   list-style:none;
                   9063:   padding: 0;
1.870     tempelho 9064: }
                   9065: 
1.795     www      9066: ul.LC_TabContentBigger li {
1.911     bisitz   9067:   vertical-align:bottom;
                   9068:   height: 30px;
                   9069:   font-size:110%;
                   9070:   font-weight:bold;
                   9071:   color: #737373;
1.841     tempelho 9072: }
                   9073: 
1.957     onken    9074: ul.LC_TabContentBigger li.active {
                   9075:   position: relative;
                   9076:   top: 1px;
                   9077: }
                   9078: 
1.870     tempelho 9079: ul.LC_TabContentBigger li a {
1.911     bisitz   9080:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   9081:   height: 30px;
                   9082:   line-height: 30px;
                   9083:   text-align: center;
                   9084:   display: block;
                   9085:   text-decoration: none;
1.958     onken    9086:   outline: none;  
1.741     harmsja  9087: }
1.795     www      9088: 
1.870     tempelho 9089: ul.LC_TabContentBigger li.active a {
1.911     bisitz   9090:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   9091:   color:$font;
1.744     ehlerst  9092: }
1.795     www      9093: 
1.870     tempelho 9094: ul.LC_TabContentBigger li b {
1.911     bisitz   9095:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   9096:   display: block;
                   9097:   float: left;
                   9098:   padding: 0 30px;
1.957     onken    9099:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 9100: }
                   9101: 
1.956     onken    9102: ul.LC_TabContentBigger li:hover b {
                   9103:   color:$button_hover;
                   9104: }
                   9105: 
1.870     tempelho 9106: ul.LC_TabContentBigger li.active b {
1.911     bisitz   9107:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   9108:   color:$font;
1.957     onken    9109:   border: 0;
1.741     harmsja  9110: }
1.693     droeschl 9111: 
1.870     tempelho 9112: 
1.862     bisitz   9113: ul.LC_CourseBreadcrumbs {
                   9114:   background: $sidebg;
1.1020    raeburn  9115:   height: 2em;
1.862     bisitz   9116:   padding-left: 10px;
1.1020    raeburn  9117:   margin: 0;
1.862     bisitz   9118:   list-style-position: inside;
                   9119: }
                   9120: 
1.911     bisitz   9121: ol#LC_MenuBreadcrumbs,
1.862     bisitz   9122: ol#LC_PathBreadcrumbs {
1.911     bisitz   9123:   padding-left: 10px;
                   9124:   margin: 0;
1.933     droeschl 9125:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 9126: }
                   9127: 
1.911     bisitz   9128: ol#LC_MenuBreadcrumbs li,
                   9129: ol#LC_PathBreadcrumbs li,
1.862     bisitz   9130: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   9131:   display: inline;
1.933     droeschl 9132:   white-space: normal;  
1.693     droeschl 9133: }
                   9134: 
1.823     bisitz   9135: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   9136: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   9137:   text-decoration: none;
                   9138:   font-size:90%;
1.693     droeschl 9139: }
1.795     www      9140: 
1.969     droeschl 9141: ol#LC_MenuBreadcrumbs h1 {
                   9142:   display: inline;
                   9143:   font-size: 90%;
                   9144:   line-height: 2.5em;
                   9145:   margin: 0;
                   9146:   padding: 0;
                   9147: }
                   9148: 
1.795     www      9149: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   9150:   text-decoration:none;
                   9151:   font-size:100%;
                   9152:   font-weight:bold;
1.693     droeschl 9153: }
1.795     www      9154: 
1.840     bisitz   9155: .LC_Box {
1.911     bisitz   9156:   border: solid 1px $lg_border_color;
                   9157:   padding: 0 10px 10px 10px;
1.746     neumanie 9158: }
1.795     www      9159: 
1.1020    raeburn  9160: .LC_DocsBox {
                   9161:   border: solid 1px $lg_border_color;
                   9162:   padding: 0 0 10px 10px;
                   9163: }
                   9164: 
1.1476  ! raeburn  9165: .LC_MainMenu_Box {
        !          9166:   border: solid 1px $lg_border_color;
        !          9167:   padding: 0 10px 0 10px;
        !          9168: }
        !          9169: 
1.795     www      9170: .LC_AboutMe_Image {
1.911     bisitz   9171:   float:left;
                   9172:   margin-right:10px;
1.747     neumanie 9173: }
1.795     www      9174: 
                   9175: .LC_Clear_AboutMe_Image {
1.911     bisitz   9176:   clear:left;
1.747     neumanie 9177: }
1.795     www      9178: 
1.721     harmsja  9179: dl.LC_ListStyleClean dt {
1.911     bisitz   9180:   padding-right: 5px;
                   9181:   display: table-header-group;
1.693     droeschl 9182: }
                   9183: 
1.721     harmsja  9184: dl.LC_ListStyleClean dd {
1.911     bisitz   9185:   display: table-row;
1.693     droeschl 9186: }
                   9187: 
1.721     harmsja  9188: .LC_ListStyleClean,
                   9189: .LC_ListStyleSimple,
                   9190: .LC_ListStyleNormal,
1.1476  ! raeburn  9191: .LC_ListStyleMainMenu,
1.795     www      9192: .LC_ListStyleSpecial {
1.911     bisitz   9193:   /* display:block; */
                   9194:   list-style-position: inside;
                   9195:   list-style-type: none;
                   9196:   overflow: hidden;
                   9197:   padding: 0;
1.693     droeschl 9198: }
                   9199: 
1.721     harmsja  9200: .LC_ListStyleSimple li,
                   9201: .LC_ListStyleSimple dd,
                   9202: .LC_ListStyleNormal li,
                   9203: .LC_ListStyleNormal dd,
                   9204: .LC_ListStyleSpecial li,
1.795     www      9205: .LC_ListStyleSpecial dd {
1.911     bisitz   9206:   margin: 0;
                   9207:   padding: 5px 5px 5px 10px;
                   9208:   clear: both;
1.693     droeschl 9209: }
                   9210: 
1.721     harmsja  9211: .LC_ListStyleClean li,
                   9212: .LC_ListStyleClean dd {
1.911     bisitz   9213:   padding-top: 0;
                   9214:   padding-bottom: 0;
1.693     droeschl 9215: }
                   9216: 
1.721     harmsja  9217: .LC_ListStyleSimple dd,
1.795     www      9218: .LC_ListStyleSimple li {
1.911     bisitz   9219:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 9220: }
                   9221: 
1.721     harmsja  9222: .LC_ListStyleSpecial li,
                   9223: .LC_ListStyleSpecial dd {
1.911     bisitz   9224:   list-style-type: none;
                   9225:   background-color: RGB(220, 220, 220);
                   9226:   margin-bottom: 4px;
1.693     droeschl 9227: }
                   9228: 
1.1476  ! raeburn  9229: .LC_ListStyleMainMenu li {
        !          9230:   margin: 0;
        !          9231:   padding: 2px 5px 2px 10px;
        !          9232:   clear: both;
        !          9233: }
        !          9234: 
1.721     harmsja  9235: table.LC_SimpleTable {
1.911     bisitz   9236:   margin:5px;
                   9237:   border:solid 1px $lg_border_color;
1.795     www      9238: }
1.693     droeschl 9239: 
1.721     harmsja  9240: table.LC_SimpleTable tr {
1.911     bisitz   9241:   padding: 0;
                   9242:   border:solid 1px $lg_border_color;
1.693     droeschl 9243: }
1.795     www      9244: 
                   9245: table.LC_SimpleTable thead {
1.911     bisitz   9246:   background:rgb(220,220,220);
1.693     droeschl 9247: }
                   9248: 
1.721     harmsja  9249: div.LC_columnSection {
1.911     bisitz   9250:   display: block;
                   9251:   clear: both;
                   9252:   overflow: hidden;
                   9253:   margin: 0;
1.693     droeschl 9254: }
                   9255: 
1.721     harmsja  9256: div.LC_columnSection>* {
1.911     bisitz   9257:   float: left;
                   9258:   margin: 10px 20px 10px 0;
                   9259:   overflow:hidden;
1.693     droeschl 9260: }
1.721     harmsja  9261: 
1.795     www      9262: table em {
1.911     bisitz   9263:   font-weight: bold;
                   9264:   font-style: normal;
1.748     schulted 9265: }
1.795     www      9266: 
1.779     bisitz   9267: table.LC_tableBrowseRes,
1.795     www      9268: table.LC_tableOfContent {
1.911     bisitz   9269:   border:none;
                   9270:   border-spacing: 1px;
                   9271:   padding: 3px;
                   9272:   background-color: #FFFFFF;
                   9273:   font-size: 90%;
1.753     droeschl 9274: }
1.789     droeschl 9275: 
1.911     bisitz   9276: table.LC_tableOfContent {
                   9277:   border-collapse: collapse;
1.789     droeschl 9278: }
                   9279: 
1.771     droeschl 9280: table.LC_tableBrowseRes a,
1.768     schulted 9281: table.LC_tableOfContent a {
1.911     bisitz   9282:   background-color: transparent;
                   9283:   text-decoration: none;
1.753     droeschl 9284: }
                   9285: 
1.795     www      9286: table.LC_tableOfContent img {
1.911     bisitz   9287:   border: none;
                   9288:   height: 1.3em;
                   9289:   vertical-align: text-bottom;
                   9290:   margin-right: 0.3em;
1.753     droeschl 9291: }
1.757     schulted 9292: 
1.795     www      9293: a#LC_content_toolbar_firsthomework {
1.911     bisitz   9294:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  9295: }
                   9296: 
1.795     www      9297: a#LC_content_toolbar_everything {
1.911     bisitz   9298:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  9299: }
                   9300: 
1.795     www      9301: a#LC_content_toolbar_uncompleted {
1.911     bisitz   9302:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  9303: }
                   9304: 
1.795     www      9305: #LC_content_toolbar_clearbubbles {
1.911     bisitz   9306:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  9307: }
                   9308: 
1.795     www      9309: a#LC_content_toolbar_changefolder {
1.911     bisitz   9310:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 9311: }
                   9312: 
1.795     www      9313: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   9314:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 9315: }
                   9316: 
1.1043    raeburn  9317: a#LC_content_toolbar_edittoplevel {
                   9318:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   9319: }
                   9320: 
1.1384    raeburn  9321: a#LC_content_toolbar_printout {
                   9322:   background-image:url(/res/adm/pages/printout.gif);
                   9323: }
                   9324: 
1.795     www      9325: ul#LC_toolbar li a:hover {
1.911     bisitz   9326:   background-position: bottom center;
1.757     schulted 9327: }
                   9328: 
1.795     www      9329: ul#LC_toolbar {
1.911     bisitz   9330:   padding: 0;
                   9331:   margin: 2px;
                   9332:   list-style:none;
1.1449    raeburn  9333:   display:inline;
1.911     bisitz   9334:   background-color:white;
1.1082    raeburn  9335:   overflow: auto;
1.757     schulted 9336: }
                   9337: 
1.795     www      9338: ul#LC_toolbar li {
1.911     bisitz   9339:   border:1px solid white;
                   9340:   padding: 0;
                   9341:   margin: 0;
                   9342:   float: left;
                   9343:   display:inline;
                   9344:   vertical-align:middle;
1.1082    raeburn  9345:   white-space: nowrap;
1.911     bisitz   9346: }
1.757     schulted 9347: 
1.783     amueller 9348: 
1.795     www      9349: a.LC_toolbarItem {
1.911     bisitz   9350:   display:block;
                   9351:   padding: 0;
                   9352:   margin: 0;
                   9353:   height: 32px;
                   9354:   width: 32px;
                   9355:   color:white;
                   9356:   border: none;
                   9357:   background-repeat:no-repeat;
                   9358:   background-color:transparent;
1.757     schulted 9359: }
                   9360: 
1.1449    raeburn  9361: .LC_navtools {
                   9362:   display: inline-block;
                   9363:   padding: 0;
                   9364:   margin: 2px;
                   9365:   vertical-align: middle;
                   9366: }
                   9367: 
1.915     droeschl 9368: ul.LC_funclist {
                   9369:     margin: 0;
                   9370:     padding: 0.5em 1em 0.5em 0;
                   9371: }
                   9372: 
1.933     droeschl 9373: ul.LC_funclist > li:first-child {
                   9374:     font-weight:bold; 
                   9375:     margin-left:0.8em;
                   9376: }
                   9377: 
1.915     droeschl 9378: ul.LC_funclist + ul.LC_funclist {
                   9379:     /* 
                   9380:        left border as a seperator if we have more than
                   9381:        one list 
                   9382:     */
                   9383:     border-left: 1px solid $sidebg;
                   9384:     /* 
                   9385:        this hides the left border behind the border of the 
                   9386:        outer box if element is wrapped to the next 'line' 
                   9387:     */
                   9388:     margin-left: -1px;
                   9389: }
                   9390: 
1.843     bisitz   9391: ul.LC_funclist li {
1.915     droeschl 9392:   display: inline;
1.782     bisitz   9393:   white-space: nowrap;
1.915     droeschl 9394:   margin: 0 0 0 25px;
                   9395:   line-height: 150%;
1.782     bisitz   9396: }
                   9397: 
1.974     wenzelju 9398: .LC_hidden {
                   9399:   display: none;
                   9400: }
                   9401: 
1.1030    www      9402: .LCmodal-overlay {
                   9403: 		position:fixed;
                   9404: 		top:0;
                   9405: 		right:0;
                   9406: 		bottom:0;
                   9407: 		left:0;
                   9408: 		height:100%;
                   9409: 		width:100%;
                   9410: 		margin:0;
                   9411: 		padding:0;
                   9412: 		background:#999;
                   9413: 		opacity:.75;
                   9414: 		filter: alpha(opacity=75);
                   9415: 		-moz-opacity: 0.75;
                   9416: 		z-index:101;
                   9417: }
                   9418: 
                   9419: * html .LCmodal-overlay {   
                   9420: 		position: absolute;
                   9421: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   9422: }
                   9423: 
                   9424: .LCmodal-window {
                   9425: 		position:fixed;
                   9426: 		top:50%;
                   9427: 		left:50%;
                   9428: 		margin:0;
                   9429: 		padding:0;
                   9430: 		z-index:102;
                   9431: 	}
                   9432: 
                   9433: * html .LCmodal-window {
                   9434: 		position:absolute;
                   9435: }
                   9436: 
                   9437: .LCclose-window {
                   9438: 		position:absolute;
                   9439: 		width:32px;
                   9440: 		height:32px;
                   9441: 		right:8px;
                   9442: 		top:8px;
                   9443: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   9444: 		text-indent:-99999px;
                   9445: 		overflow:hidden;
                   9446: 		cursor:pointer;
                   9447: }
                   9448: 
1.1369    raeburn  9449: .LCisDisabled {
                   9450:   cursor: not-allowed;
                   9451:   opacity: 0.5;
                   9452: }
                   9453: 
                   9454: a[aria-disabled="true"] {
                   9455:   color: currentColor;
                   9456:   display: inline-block;  /* For IE11/ MS Edge bug */
                   9457:   pointer-events: none;
                   9458:   text-decoration: none;
                   9459: }
                   9460: 
1.1335    raeburn  9461: pre.LC_wordwrap {
                   9462:   white-space: pre-wrap;
                   9463:   white-space: -moz-pre-wrap;
                   9464:   white-space: -pre-wrap;
                   9465:   white-space: -o-pre-wrap;
                   9466:   word-wrap: break-word;
                   9467: }
                   9468: 
1.1100    raeburn  9469: /*
1.1231    damieng  9470:   styles used for response display
                   9471: */
1.1464    raeburn  9472: div.LC_radiofoil, div.LC_rankfoil, div.LC_optionfoil, div.LC_matchfoil, div.LC_login_links {
1.1231    damieng  9473:   margin: .5em 0em .5em 0em;
                   9474: }
                   9475: table.LC_itemgroup {
                   9476:   margin-top: 1em;
                   9477: }
                   9478: 
1.1462    raeburn  9479: table.LC_itemgroup tr th {
                   9480:   font-weight: normal;
                   9481: }
                   9482: 
                   9483: fieldset.LC_webbubbles {
                   9484:   margin: 2px 0 0 0;
                   9485:   padding: 0;
                   9486:   border: 0;
                   9487: }
                   9488: 
                   9489: ul.LC_webbubbles {
                   9490:   list-style: none;
                   9491:   padding: 0;
                   9492:   margin: 0;
                   9493:   text-align: left;
                   9494:   float: left;
                   9495: }
                   9496: 
                   9497: ul.LC_webbubbles li {
                   9498:   line-height: 1.8em;
                   9499:   border: 1px solid black;
                   9500:   padding: 0 2px 0 5px;
                   9501:   margin: 0 0 0 -1px;
                   9502:   float: left;
                   9503: }
                   9504: 
1.1231    damieng  9505: /*
1.1100    raeburn  9506:   styles used by TTH when "Default set of options to pass to tth/m
                   9507:   when converting TeX" in course settings has been set
                   9508: 
                   9509:   option passed: -t
                   9510: 
                   9511: */
                   9512: 
                   9513: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   9514: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   9515: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   9516: td div.norm {line-height:normal;}
                   9517: 
                   9518: /*
                   9519:   option passed -y3
                   9520: */
                   9521: 
                   9522: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   9523: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   9524: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   9525: 
1.1230    damieng  9526: /*
                   9527:   sections with roles, for content only
                   9528: */
                   9529: section[class^="role-"] {
                   9530:   padding-left: 10px;
                   9531:   padding-right: 5px;
                   9532:   margin-top: 8px;
                   9533:   margin-bottom: 8px;
                   9534:   border: 1px solid #2A4;
                   9535:   border-radius: 5px;
                   9536:   box-shadow: 0px 1px 1px #BBB;
                   9537: }
                   9538: section[class^="role-"]>h1 {
                   9539:   position: relative;
                   9540:   margin: 0px;
                   9541:   padding-top: 10px;
                   9542:   padding-left: 40px;
                   9543: }
                   9544: section[class^="role-"]>h1:before {
                   9545:   position: absolute;
                   9546:   left: -5px;
                   9547:   top: 5px;
                   9548: }
                   9549: section.role-activity>h1:before {
                   9550:   content:url('/adm/daxe/images/section_icons/activity.png');
                   9551: }
                   9552: section.role-advice>h1:before {
                   9553:   content:url('/adm/daxe/images/section_icons/advice.png');
                   9554: }
                   9555: section.role-bibliography>h1:before {
                   9556:   content:url('/adm/daxe/images/section_icons/bibliography.png');
                   9557: }
                   9558: section.role-citation>h1:before {
                   9559:   content:url('/adm/daxe/images/section_icons/citation.png');
                   9560: }
                   9561: section.role-conclusion>h1:before {
                   9562:   content:url('/adm/daxe/images/section_icons/conclusion.png');
                   9563: }
                   9564: section.role-definition>h1:before {
                   9565:   content:url('/adm/daxe/images/section_icons/definition.png');
                   9566: }
                   9567: section.role-demonstration>h1:before {
                   9568:   content:url('/adm/daxe/images/section_icons/demonstration.png');
                   9569: }
                   9570: section.role-example>h1:before {
                   9571:   content:url('/adm/daxe/images/section_icons/example.png');
                   9572: }
                   9573: section.role-explanation>h1:before {
                   9574:   content:url('/adm/daxe/images/section_icons/explanation.png');
                   9575: }
                   9576: section.role-introduction>h1:before {
                   9577:   content:url('/adm/daxe/images/section_icons/introduction.png');
                   9578: }
                   9579: section.role-method>h1:before {
                   9580:   content:url('/adm/daxe/images/section_icons/method.png');
                   9581: }
                   9582: section.role-more_information>h1:before {
                   9583:   content:url('/adm/daxe/images/section_icons/more_information.png');
                   9584: }
                   9585: section.role-objectives>h1:before {
                   9586:   content:url('/adm/daxe/images/section_icons/objectives.png');
                   9587: }
                   9588: section.role-prerequisites>h1:before {
                   9589:   content:url('/adm/daxe/images/section_icons/prerequisites.png');
                   9590: }
                   9591: section.role-remark>h1:before {
                   9592:   content:url('/adm/daxe/images/section_icons/remark.png');
                   9593: }
                   9594: section.role-reminder>h1:before {
                   9595:   content:url('/adm/daxe/images/section_icons/reminder.png');
                   9596: }
                   9597: section.role-summary>h1:before {
                   9598:   content:url('/adm/daxe/images/section_icons/summary.png');
                   9599: }
                   9600: section.role-syntax>h1:before {
                   9601:   content:url('/adm/daxe/images/section_icons/syntax.png');
                   9602: }
                   9603: section.role-warning>h1:before {
                   9604:   content:url('/adm/daxe/images/section_icons/warning.png');
                   9605: }
                   9606: 
1.1269    raeburn  9607: #LC_minitab_header {
                   9608:   float:left;
                   9609:   width:100%;
                   9610:   background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
                   9611:   font-size:93%;
                   9612:   line-height:normal;
                   9613:   margin: 0.5em 0 0.5em 0;
                   9614: }
                   9615: #LC_minitab_header ul {
                   9616:   margin:0;
                   9617:   padding:10px 10px 0;
                   9618:   list-style:none;
                   9619: }
                   9620: #LC_minitab_header li {
                   9621:   float:left;
                   9622:   background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
                   9623:   margin:0;
                   9624:   padding:0 0 0 9px;
                   9625: }
                   9626: #LC_minitab_header a {
                   9627:   display:block;
                   9628:   background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
                   9629:   padding:5px 15px 4px 6px;
                   9630: }
                   9631: #LC_minitab_header #LC_current_minitab {
                   9632:   background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
                   9633: }
                   9634: #LC_minitab_header #LC_current_minitab a {
                   9635:   background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
                   9636:   padding-bottom:5px;
                   9637: }
                   9638: 
                   9639: 
1.343     albertel 9640: END
                   9641: }
                   9642: 
1.306     albertel 9643: =pod
                   9644: 
                   9645: =item * &headtag()
                   9646: 
                   9647: Returns a uniform footer for LON-CAPA web pages.
                   9648: 
1.307     albertel 9649: Inputs: $title - optional title for the head
                   9650:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 9651:         $args - optional arguments
1.319     albertel 9652:             force_register - if is true call registerurl so the remote is 
                   9653:                              informed
1.415     albertel 9654:             redirect       -> array ref of
                   9655:                                    1- seconds before redirect occurs
                   9656:                                    2- url to redirect to
                   9657:                                    3- whether the side effect should occur
1.315     albertel 9658:                            (side effect of setting 
                   9659:                                $env{'internal.head.redirect'} to the url 
1.1386    raeburn  9660:                                redirected to)
                   9661:                                    4- whether the redirect target should be
                   9662:                                       the opener of the current (pop-up)
                   9663:                                       window (side effect of setting
                   9664:                                       $env{'internal.head.to_opener'} to
                   9665:                                       1, if true.
1.1388    raeburn  9666:                                    5- whether encrypt check should be skipped
1.352     albertel 9667:             domain         -> force to color decorate a page for a specific
                   9668:                                domain
                   9669:             function       -> force usage of a specific rolish color scheme
                   9670:             bgcolor        -> override the default page bgcolor
1.460     albertel 9671:             no_auto_mt_title
                   9672:                            -> prevent &mt()ing the title arg
1.464     albertel 9673: 
1.306     albertel 9674: =cut
                   9675: 
                   9676: sub headtag {
1.313     albertel 9677:     my ($title,$head_extra,$args) = @_;
1.306     albertel 9678:     
1.363     albertel 9679:     my $function = $args->{'function'} || &get_users_function();
                   9680:     my $domain   = $args->{'domain'}   || &determinedomain();
                   9681:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1154    raeburn  9682:     my $httphost = $args->{'use_absolute'};
1.418     albertel 9683:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 9684: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 9685: 		   #time(),
1.418     albertel 9686: 		   $env{'environment.color.timestamp'},
1.363     albertel 9687: 		   $function,$domain,$bgcolor);
                   9688: 
1.369     www      9689:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 9690: 
1.308     albertel 9691:     my $result =
                   9692: 	'<head>'.
1.1160    raeburn  9693: 	&font_settings($args);
1.319     albertel 9694: 
1.1188    raeburn  9695:     my $inhibitprint;
                   9696:     if ($args->{'print_suppress'}) {
                   9697:         $inhibitprint = &print_suppression();
                   9698:     }
1.1064    raeburn  9699: 
1.1439    raeburn  9700:     if (!$args->{'frameset'} && !$args->{'switchserver'}) {
1.461     albertel 9701: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   9702:     }
1.962     droeschl 9703:     if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
                   9704:         $result .= Apache::lonxml::display_title();
1.319     albertel 9705:     }
1.436     albertel 9706:     if (!$args->{'no_nav_bar'} 
                   9707: 	&& !$args->{'only_body'}
1.1438    raeburn  9708: 	&& !$args->{'frameset'}
                   9709: 	&& !$args->{'switchserver'}) {
1.1154    raeburn  9710: 	$result .= &help_menu_js($httphost);
1.1032    www      9711:         $result.=&modal_window();
1.1038    www      9712:         $result.=&togglebox_script();
1.1034    www      9713:         $result.=&wishlist_window();
1.1041    www      9714:         $result.=&LCprogressbarUpdate_script();
1.1034    www      9715:     } else {
                   9716:         if ($args->{'add_modal'}) {
                   9717:            $result.=&modal_window();
                   9718:         }
                   9719:         if ($args->{'add_wishlist'}) {
                   9720:            $result.=&wishlist_window();
                   9721:         }
1.1038    www      9722:         if ($args->{'add_togglebox'}) {
                   9723:            $result.=&togglebox_script();
                   9724:         }
1.1041    www      9725:         if ($args->{'add_progressbar'}) {
                   9726:            $result.=&LCprogressbarUpdate_script();
                   9727:         }
1.436     albertel 9728:     }
1.314     albertel 9729:     if (ref($args->{'redirect'})) {
1.1388    raeburn  9730: 	my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
                   9731:         if (!$skip_enc_check) {
                   9732:             $url = &Apache::lonenc::check_encrypt($url);
                   9733:         }
1.414     albertel 9734: 	if (!$inhibit_continue) {
                   9735: 	    $env{'internal.head.redirect'} = $url;
                   9736: 	}
1.1386    raeburn  9737: 	$result.=<<"ADDMETA";
1.313     albertel 9738: <meta http-equiv="pragma" content="no-cache" />
1.1386    raeburn  9739: ADDMETA
                   9740:         if ($to_opener) {
                   9741:             $env{'internal.head.to_opener'} = 1;
                   9742:             my $dest = &js_escape($url);
                   9743:             my $timeout = int($time * 1000);
                   9744:             $result .=<<"ENDJS";
                   9745: <script type="text/javascript">
                   9746: // <![CDATA[
                   9747: function LC_To_Opener() {
                   9748:     var dest = '$dest';
                   9749:     if (dest != '') {
                   9750:         if (window.opener != null && !window.opener.closed) {
                   9751:             window.opener.location.href=dest;
                   9752:             window.close();
                   9753:         } else {
                   9754:             window.location.href=dest;
                   9755:         }
                   9756:     }
                   9757: }
                   9758: \$(document).ready(function () {
                   9759:     setTimeout('LC_To_Opener()',$timeout);
                   9760: });
                   9761: // ]]>
                   9762: </script>
                   9763: ENDJS
                   9764:         } else {
                   9765:             $result.=<<"ADDMETA";
1.344     albertel 9766: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 9767: ADDMETA
1.1386    raeburn  9768:         }
1.1210    raeburn  9769:     } else {
                   9770:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
                   9771:             my $requrl = $env{'request.uri'};
                   9772:             if ($requrl eq '') {
                   9773:                 $requrl = $ENV{'REQUEST_URI'};
                   9774:                 $requrl =~ s/\?.+$//;
                   9775:             }
                   9776:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
                   9777:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
                   9778:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
                   9779:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
                   9780:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
                   9781:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340    raeburn  9782:                     my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352    raeburn  9783:                     my ($offload,$offloadoth);
1.1210    raeburn  9784:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
                   9785:                         if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340    raeburn  9786:                             $offload = 1;
1.1353    raeburn  9787:                             if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   9788:                                 (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   9789:                                 unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   9790:                                     $offloadoth = 1;
                   9791:                                     $dom_in_use = $env{'user.domain'};
                   9792:                                 }
                   9793:                             }
1.1340    raeburn  9794:                         }
                   9795:                     }
                   9796:                     unless ($offload) {
                   9797:                         if (ref($domdefs{'offloadoth'}) eq 'HASH') {
                   9798:                             if ($domdefs{'offloadoth'}{$lonhost}) {
                   9799:                                 if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   9800:                                     (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   9801:                                     unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   9802:                                         $offload = 1;
1.1352    raeburn  9803:                                         $offloadoth = 1;
1.1340    raeburn  9804:                                         $dom_in_use = $env{'user.domain'};
                   9805:                                     }
1.1210    raeburn  9806:                                 }
1.1340    raeburn  9807:                             }
                   9808:                         }
                   9809:                     }
                   9810:                     if ($offload) {
1.1358    raeburn  9811:                         my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352    raeburn  9812:                         if (($newserver eq '') && ($offloadoth)) {
                   9813:                             my @domains = &Apache::lonnet::current_machine_domains();
                   9814:                             if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) { 
                   9815:                                 ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
                   9816:                             }
                   9817:                         }
1.1340    raeburn  9818:                         if (($newserver) && ($newserver ne $lonhost)) {
                   9819:                             my $numsec = 5;
                   9820:                             my $timeout = $numsec * 1000;
                   9821:                             my ($newurl,$locknum,%locks,$msg);
                   9822:                             if ($env{'request.role.adv'}) {
                   9823:                                 ($locknum,%locks) = &Apache::lonnet::get_locks();
                   9824:                             }
                   9825:                             my $disable_submit = 0;
                   9826:                             if ($requrl =~ /$LONCAPA::assess_re/) {
                   9827:                                 $disable_submit = 1;
                   9828:                             }
                   9829:                             if ($locknum) {
                   9830:                                 my @lockinfo = sort(values(%locks));
1.1354    raeburn  9831:                                 $msg = &mt('Once the following tasks are complete:')." \n".
1.1340    raeburn  9832:                                        join(", ",sort(values(%locks)))."\n";
                   9833:                                 if (&show_course()) {
                   9834:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
                   9835:                                 } else {
                   9836:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210    raeburn  9837:                                 }
1.1340    raeburn  9838:                             } else {
                   9839:                                 if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
                   9840:                                     $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
                   9841:                                 }
                   9842:                                 $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
                   9843:                                 $newurl = '/adm/switchserver?otherserver='.$newserver;
                   9844:                                 if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
                   9845:                                     $newurl .= '&role='.$env{'request.role'};
                   9846:                                 }
                   9847:                                 if ($env{'request.symb'}) {
                   9848:                                     my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
                   9849:                                     if ($shownsymb =~ m{^/enc/}) {
                   9850:                                         my $reqdmajor = 2;
                   9851:                                         my $reqdminor = 11;
                   9852:                                         my $reqdsubminor = 3;
                   9853:                                         my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
                   9854:                                         my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
                   9855:                                         my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
                   9856:                                         if (($major eq '' && $minor eq '') ||
                   9857:                                             (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
                   9858:                                             (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
                   9859:                                              ($reqdsubminor > $subminor))))) {
                   9860:                                             undef($shownsymb);
                   9861:                                         }
1.1210    raeburn  9862:                                     }
1.1340    raeburn  9863:                                     if ($shownsymb) {
                   9864:                                         &js_escape(\$shownsymb);
                   9865:                                         $newurl .= '&symb='.$shownsymb;
1.1210    raeburn  9866:                                     }
1.1340    raeburn  9867:                                 } else {
                   9868:                                     my $shownurl = &Apache::lonenc::check_encrypt($requrl);
                   9869:                                     &js_escape(\$shownurl);
                   9870:                                     $newurl .= '&origurl='.$shownurl;
1.1210    raeburn  9871:                                 }
1.1340    raeburn  9872:                             }
                   9873:                             &js_escape(\$msg);
                   9874:                             $result.=<<OFFLOAD
1.1210    raeburn  9875: <meta http-equiv="pragma" content="no-cache" />
                   9876: <script type="text/javascript">
1.1215    raeburn  9877: // <![CDATA[
1.1210    raeburn  9878: function LC_Offload_Now() {
                   9879:     var dest = "$newurl";
                   9880:     if (dest != '') {
                   9881:         window.location.href="$newurl";
                   9882:     }
                   9883: }
1.1214    raeburn  9884: \$(document).ready(function () {
                   9885:     window.alert('$msg');
                   9886:     if ($disable_submit) {
1.1210    raeburn  9887:         \$(".LC_hwk_submit").prop("disabled", true);
                   9888:         \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214    raeburn  9889:     }
                   9890:     setTimeout('LC_Offload_Now()', $timeout);
                   9891: });
1.1215    raeburn  9892: // ]]>
1.1210    raeburn  9893: </script>
                   9894: OFFLOAD
                   9895:                         }
                   9896:                     }
                   9897:                 }
                   9898:             }
                   9899:         }
1.313     albertel 9900:     }
1.306     albertel 9901:     if (!defined($title)) {
                   9902: 	$title = 'The LearningOnline Network with CAPA';
                   9903:     }
1.460     albertel 9904:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1432    raeburn  9905:     if ($title =~ /^LON-CAPA\s+/) {
                   9906:         $result .= '<title> '.$title.'</title>';
                   9907:     } else {
                   9908:         $result .= '<title> LON-CAPA '.$title.'</title>';
                   9909:     }
                   9910:     $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1168    raeburn  9911:     if (!$args->{'frameset'}) {
                   9912:         $result .= ' /';
                   9913:     }
                   9914:     $result .= '>' 
1.1064    raeburn  9915:         .$inhibitprint
1.414     albertel 9916: 	.$head_extra;
1.1242    raeburn  9917:     my $clientmobile;
                   9918:     if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   9919:         (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
                   9920:     } else {
                   9921:         $clientmobile = $env{'browser.mobile'};
                   9922:     }
                   9923:     if ($clientmobile) {
1.1137    raeburn  9924:         $result .= '
1.1435    raeburn  9925: <meta name="viewport" content="width=device-width, initial-scale=1.0">
1.1137    raeburn  9926: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   9927:     }
1.1455    raeburn  9928:     $result .= '<meta name="google" content="notranslate"';
                   9929:     if (!$args->{'frameset'}) {
                   9930:         $result .= ' /';
                   9931:     }
                   9932:     $result .= '>'."\n";
1.962     droeschl 9933:     return $result.'</head>';
1.306     albertel 9934: }
                   9935: 
                   9936: =pod
                   9937: 
1.340     albertel 9938: =item * &font_settings()
                   9939: 
                   9940: Returns neccessary <meta> to set the proper encoding
                   9941: 
1.1160    raeburn  9942: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 9943: 
                   9944: =cut
                   9945: 
                   9946: sub font_settings {
1.1160    raeburn  9947:     my ($args) = @_;
1.340     albertel 9948:     my $headerstring='';
1.1160    raeburn  9949:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   9950:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168    raeburn  9951:         $headerstring.=
                   9952:             '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   9953:         if (!$args->{'frameset'}) {
                   9954: 	    $headerstring.= ' /';
                   9955:         }
                   9956: 	$headerstring .= '>'."\n";
1.340     albertel 9957:     }
                   9958:     return $headerstring;
                   9959: }
                   9960: 
1.341     albertel 9961: =pod
                   9962: 
1.1064    raeburn  9963: =item * &print_suppression()
                   9964: 
                   9965: In course context returns css which causes the body to be blank when media="print",
                   9966: if printout generation is unavailable for the current resource.
                   9967: 
                   9968: This could be because:
                   9969: 
                   9970: (a) printstartdate is in the future
                   9971: 
                   9972: (b) printenddate is in the past
                   9973: 
                   9974: (c) there is an active exam block with "printout"
                   9975: functionality blocked
                   9976: 
                   9977: Users with pav, pfo or evb privileges are exempt.
                   9978: 
                   9979: Inputs: none
                   9980: 
                   9981: =cut
                   9982: 
                   9983: 
                   9984: sub print_suppression {
                   9985:     my $noprint;
                   9986:     if ($env{'request.course.id'}) {
                   9987:         my $scope = $env{'request.course.id'};
                   9988:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   9989:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   9990:             return;
                   9991:         }
                   9992:         if ($env{'request.course.sec'} ne '') {
                   9993:             $scope .= "/$env{'request.course.sec'}";
                   9994:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   9995:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  9996:                 return;
1.1064    raeburn  9997:             }
                   9998:         }
                   9999:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10000:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372    raeburn  10001:         my $clientip = &Apache::lonnet::get_requestor_ip();
                   10002:         my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064    raeburn  10003:         if ($blocked) {
                   10004:             my $checkrole = "cm./$cdom/$cnum";
                   10005:             if ($env{'request.course.sec'} ne '') {
                   10006:                 $checkrole .= "/$env{'request.course.sec'}";
                   10007:             }
                   10008:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   10009:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   10010:                 $noprint = 1;
                   10011:             }
                   10012:         }
                   10013:         unless ($noprint) {
                   10014:             my $symb = &Apache::lonnet::symbread();
                   10015:             if ($symb ne '') {
                   10016:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   10017:                 if (ref($navmap)) {
                   10018:                     my $res = $navmap->getBySymb($symb);
                   10019:                     if (ref($res)) {
                   10020:                         if (!$res->resprintable()) {
                   10021:                             $noprint = 1;
                   10022:                         }
                   10023:                     }
                   10024:                 }
                   10025:             }
                   10026:         }
                   10027:         if ($noprint) {
                   10028:             return <<"ENDSTYLE";
                   10029: <style type="text/css" media="print">
                   10030:     body { display:none }
                   10031: </style>
                   10032: ENDSTYLE
                   10033:         }
                   10034:     }
                   10035:     return;
                   10036: }
                   10037: 
                   10038: =pod
                   10039: 
1.341     albertel 10040: =item * &xml_begin()
                   10041: 
                   10042: Returns the needed doctype and <html>
                   10043: 
                   10044: Inputs: none
                   10045: 
                   10046: =cut
                   10047: 
                   10048: sub xml_begin {
1.1168    raeburn  10049:     my ($is_frameset) = @_;
1.341     albertel 10050:     my $output='';
                   10051: 
                   10052:     if ($env{'browser.mathml'}) {
                   10053: 	$output='<?xml version="1.0"?>'
                   10054:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   10055: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   10056:             
                   10057: #	    .'<!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">] >'
                   10058: 	    .'<!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">'
                   10059:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   10060: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168    raeburn  10061:     } elsif ($is_frameset) {
                   10062:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
1.1459    raeburn  10063:                 '<html lang="en">'."\n";
1.341     albertel 10064:     } else {
1.1168    raeburn  10065: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   10066:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 10067:     }
                   10068:     return $output;
                   10069: }
1.340     albertel 10070: 
                   10071: =pod
                   10072: 
1.306     albertel 10073: =item * &start_page()
                   10074: 
                   10075: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   10076: 
1.648     raeburn  10077: Inputs:
                   10078: 
                   10079: =over 4
                   10080: 
                   10081: $title - optional title for the page
                   10082: 
                   10083: $head_extra - optional extra HTML to incude inside the <head>
                   10084: 
                   10085: $args - additional optional args supported are:
                   10086: 
                   10087: =over 8
                   10088: 
                   10089:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 10090:                                     arg on
1.814     bisitz   10091:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  10092:              add_entries    -> additional attributes to add to the  <body>
                   10093:              domain         -> force to color decorate a page for a 
1.317     albertel 10094:                                     specific domain
1.648     raeburn  10095:              function       -> force usage of a specific rolish color
1.317     albertel 10096:                                     scheme
1.648     raeburn  10097:              redirect       -> see &headtag()
                   10098:              bgcolor        -> override the default page bg color
                   10099:              js_ready       -> return a string ready for being used in 
1.317     albertel 10100:                                     a javascript writeln
1.648     raeburn  10101:              html_encode    -> return a string ready for being used in 
1.320     albertel 10102:                                     a html attribute
1.648     raeburn  10103:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 10104:                                     $forcereg arg
1.648     raeburn  10105:              frameset       -> if true will start with a <frameset>
1.330     albertel 10106:                                     rather than <body>
1.648     raeburn  10107:              skip_phases    -> hash ref of 
1.338     albertel 10108:                                     head -> skip the <html><head> generation
                   10109:                                     body -> skip all <body> generation
1.648     raeburn  10110:              no_auto_mt_title -> prevent &mt()ing the title arg
1.867     kalberla 10111:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  10112:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1437    raeburn  10113:              bread_crumbs_style -> breadcrumbs are contained within <div id="LC_breadcrumbs">,
                   10114:                                    and &standard_css() contains CSS for #LC_breadcrumbs, if you want
                   10115:                                    to override those values, or add to them, specify the value to
                   10116:                                    include in the style attribute to include in the div tag by using
                   10117:                                    bread_crumbs_style (e.g., overflow: visible)
1.1272    raeburn  10118:              bread_crumbs_nomenu -> if true will pass false as the value of $menulink
                   10119:                                     to lonhtmlcommon::breadcrumbs
1.1096    raeburn  10120:              group          -> includes the current group, if page is for a 
1.1274    raeburn  10121:                                specific group
                   10122:              use_absolute   -> for request for external resource or syllabus, this
                   10123:                                will contain https://<hostname> if server uses
                   10124:                                https (as per hosts.tab), but request is for http
                   10125:              hostname       -> hostname, originally from $r->hostname(), (optional).
1.1369    raeburn  10126:              links_disabled -> Links in primary and secondary menus are disabled
                   10127:                                (Can enable them once page has loaded - see lonroles.pm
                   10128:                                for an example).
1.1380    raeburn  10129:              links_target   -> Target for links, e.g., _parent (optional).
1.361     albertel 10130: 
1.648     raeburn  10131: =back
1.460     albertel 10132: 
1.648     raeburn  10133: =back
1.562     albertel 10134: 
1.306     albertel 10135: =cut
                   10136: 
                   10137: sub start_page {
1.309     albertel 10138:     my ($title,$head_extra,$args) = @_;
1.318     albertel 10139:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 10140: 
1.315     albertel 10141:     $env{'internal.start_page'}++;
1.1359    raeburn  10142:     my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964     droeschl 10143: 
1.338     albertel 10144:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168    raeburn  10145:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 10146:     }
1.1316    raeburn  10147: 
                   10148:     if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318    raeburn  10149:         if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
                   10150:             unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
                   10151:                 $args->{'no_primary_menu'} = 1;
                   10152:             }
                   10153:             unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
                   10154:                 $args->{'no_inline_menu'} = 1;
                   10155:             }
                   10156:             if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
                   10157:                 map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
                   10158:             }
                   10159:         } else {
                   10160:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10161:             my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
                   10162:             if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
                   10163:                 unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
                   10164:                     $args->{'no_primary_menu'} = 1;
                   10165:                 }
                   10166:                 unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
                   10167:                     $args->{'no_inline_menu'} = 1;
                   10168:                 }
                   10169:                 if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
                   10170:                     map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
                   10171:                 }
                   10172:             }
                   10173:         }
1.1316    raeburn  10174:         ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
                   10175:                                   $env{'course.'.$env{'request.course.id'}.'.domain'},
                   10176:                                   $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359    raeburn  10177:     } elsif ($env{'request.course.id'}) {
                   10178:         my $expiretime=600;
                   10179:         if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
                   10180:             &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
                   10181:         }
                   10182:         my ($deeplinkmenu,$menuref);
                   10183:         ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
                   10184:         if ($menucoll) {
                   10185:             if (ref($menuref) eq 'HASH') {
                   10186:                 %menu = %{$menuref};
                   10187:             }
                   10188:             if ($menu{'top'} eq 'n') {
                   10189:                 $args->{'no_primary_menu'} = 1;
                   10190:             }
                   10191:             if ($menu{'inline'} eq 'n') {
                   10192:                 unless (&Apache::lonnet::allowed('opa')) {
                   10193:                     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10194:                     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   10195:                     my $crstype = &course_type();
                   10196:                     my $now = time;
                   10197:                     my $ccrole;
                   10198:                     if ($crstype eq 'Community') {
                   10199:                         $ccrole = 'co';
                   10200:                     } else {
                   10201:                         $ccrole = 'cc';
                   10202:                     }
                   10203:                     if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
                   10204:                         my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
                   10205:                         if ((($start) && ($start<0)) ||
                   10206:                             (($end) && ($end<$now))  ||
                   10207:                             (($start) && ($now<$start))) {
                   10208:                             $args->{'no_inline_menu'} = 1;
                   10209:                         }
                   10210:                     } else {
                   10211:                         $args->{'no_inline_menu'} = 1;
                   10212:                     }
                   10213:                 }
                   10214:             }
                   10215:         }
1.1316    raeburn  10216:     }
1.1359    raeburn  10217: 
1.1385    raeburn  10218:     my $showncrumbs;
1.338     albertel 10219:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   10220: 	if ($args->{'frameset'}) {
                   10221: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   10222: 						$args->{'add_entries'});
                   10223: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   10224:         } else {
                   10225:             $result .=
                   10226:                 &bodytag($title, 
                   10227:                          $args->{'function'},       $args->{'add_entries'},
                   10228:                          $args->{'only_body'},      $args->{'domain'},
                   10229:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096    raeburn  10230:                          $args->{'bgcolor'},        $args,
1.1385    raeburn  10231:                          \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
                   10232:                          \%menu,\$showncrumbs);
1.831     bisitz   10233:         }
1.330     albertel 10234:     }
1.338     albertel 10235: 
1.315     albertel 10236:     if ($args->{'js_ready'}) {
1.713     kaisler  10237: 		$result = &js_ready($result);
1.315     albertel 10238:     }
1.320     albertel 10239:     if ($args->{'html_encode'}) {
1.713     kaisler  10240: 		$result = &html_encode($result);
                   10241:     }
                   10242: 
1.813     bisitz   10243:     # Preparation for new and consistent functionlist at top of screen
                   10244:     # if ($args->{'functionlist'}) {
                   10245:     #            $result .= &build_functionlist();
                   10246:     #}
                   10247: 
1.964     droeschl 10248:     # Don't add anything more if only_body wanted or in const space
                   10249:     return $result if    $args->{'only_body'} 
                   10250:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   10251: 
                   10252:     #Breadcrumbs
1.758     kaisler  10253:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385    raeburn  10254:         unless ($showncrumbs) {
1.758     kaisler  10255: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   10256: 		#if any br links exists, add them to the breadcrumbs
                   10257: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   10258: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   10259: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   10260: 			}
                   10261: 		}
1.1096    raeburn  10262:                 # if @advtools array contains items add then to the breadcrumbs
                   10263:                 if (@advtools > 0) {
                   10264:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   10265:                 }
1.1272    raeburn  10266:                 my $menulink;
                   10267:                 # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
                   10268:                 if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312    raeburn  10269:                      ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272    raeburn  10270:                      ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
                   10271:                      ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
                   10272:                      (!$env{'request.role.adv'}))) {
                   10273:                     $menulink = 0;
                   10274:                 } else {
                   10275:                     undef($menulink);
                   10276:                 }
1.1385    raeburn  10277:                 my $linkprotout;
                   10278:                 if ($env{'request.deeplink.login'}) {
                   10279:                     my $linkprotout = &Apache::lonmenu::linkprot_exit();
                   10280:                     if ($linkprotout) {
                   10281:                         &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
                   10282:                     }
                   10283:                 }
1.758     kaisler  10284: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   10285: 		if(exists($args->{'bread_crumbs_component'})){
1.1437    raeburn  10286: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},
                   10287:                                                                        '',$menulink,'',
                   10288:                                                                        $args->{'bread_crumbs_style'});
1.1237    raeburn  10289:                 } else {
1.1437    raeburn  10290: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink,'',
                   10291:                                                                        $args->{'bread_crumbs_style'});
1.758     kaisler  10292: 		}
1.1385    raeburn  10293:         }
1.320     albertel 10294:     }
1.315     albertel 10295:     return $result;
1.306     albertel 10296: }
                   10297: 
                   10298: sub end_page {
1.315     albertel 10299:     my ($args) = @_;
                   10300:     $env{'internal.end_page'}++;
1.330     albertel 10301:     my $result;
1.335     albertel 10302:     if ($args->{'discussion'}) {
                   10303: 	my ($target,$parser);
                   10304: 	if (ref($args->{'discussion'})) {
                   10305: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   10306: 				$args->{'discussion'}{'parser'});
                   10307: 	}
                   10308: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   10309:     }
1.330     albertel 10310:     if ($args->{'frameset'}) {
                   10311: 	$result .= '</frameset>';
                   10312:     } else {
1.635     raeburn  10313: 	$result .= &endbodytag($args);
1.330     albertel 10314:     }
1.1080    raeburn  10315:     unless ($args->{'notbody'}) {
                   10316:         $result .= "\n</html>";
                   10317:     }
1.330     albertel 10318: 
1.315     albertel 10319:     if ($args->{'js_ready'}) {
1.317     albertel 10320: 	$result = &js_ready($result);
1.315     albertel 10321:     }
1.335     albertel 10322: 
1.320     albertel 10323:     if ($args->{'html_encode'}) {
                   10324: 	$result = &html_encode($result);
                   10325:     }
1.335     albertel 10326: 
1.315     albertel 10327:     return $result;
                   10328: }
                   10329: 
1.1359    raeburn  10330: sub menucoll_in_effect {
                   10331:     my ($menucoll,$deeplinkmenu,%menu);
                   10332:     if ($env{'request.course.id'}) {
                   10333:         $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362    raeburn  10334:         if ($env{'request.deeplink.login'}) {
1.1370    raeburn  10335:             my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362    raeburn  10336:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   10337:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10338:             if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
                   10339:                 if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
                   10340:                     my $navmap = Apache::lonnavmaps::navmap->new();
                   10341:                     if (ref($navmap)) {
                   10342:                         $deeplink = $navmap->get_mapparam(undef,
                   10343:                                                           &Apache::lonnet::declutter($env{'request.noversionuri'}),
                   10344:                                                           '0.deeplink');
1.1370    raeburn  10345:                     } else {
                   10346:                         $check_login_symb = 1;
1.1362    raeburn  10347:                     }
                   10348:                 } else {
1.1370    raeburn  10349:                     my $symb = &Apache::lonnet::symbread();
                   10350:                     if ($symb) {
                   10351:                         $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
                   10352:                     } else {
                   10353:                         $check_login_symb = 1;
                   10354:                     }
1.1362    raeburn  10355:                 }
                   10356:             } else {
1.1370    raeburn  10357:                 $check_login_symb = 1;
                   10358:             }
                   10359:             if ($check_login_symb) {
1.1362    raeburn  10360:                 $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
                   10361:                 if ($deeplink_symb =~ /\.(page|sequence)$/) {
                   10362:                     my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
                   10363:                     my $navmap = Apache::lonnavmaps::navmap->new();
                   10364:                     if (ref($navmap)) {
                   10365:                         $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
                   10366:                     }
                   10367:                 } else {
                   10368:                     $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
                   10369:                 }
                   10370:             }
1.1359    raeburn  10371:             if ($deeplink ne '') {
1.1378    raeburn  10372:                 my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359    raeburn  10373:                 if ($display =~ /^\d+$/) {
                   10374:                     $deeplinkmenu = 1;
                   10375:                     $menucoll = $display;
                   10376:                 }
                   10377:             }
                   10378:         }
                   10379:         if ($menucoll) {
                   10380:             %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
                   10381:         }
                   10382:     }
                   10383:     return ($menucoll,$deeplinkmenu,\%menu);
                   10384: }
                   10385: 
1.1362    raeburn  10386: sub deeplink_login_symb {
                   10387:     my ($cnum,$cdom) = @_;
                   10388:     my $login_symb;
                   10389:     if ($env{'request.deeplink.login'}) {
1.1364    raeburn  10390:         $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
                   10391:     }
                   10392:     return $login_symb;
                   10393: }
                   10394: 
                   10395: sub symb_from_tinyurl {
                   10396:     my ($url,$cnum,$cdom) = @_;
                   10397:     if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
                   10398:         my $key = $1;
                   10399:         my ($tinyurl,$login);
                   10400:         my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
                   10401:         if (defined($cached)) {
                   10402:             $tinyurl = $result;
                   10403:         } else {
                   10404:             my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
                   10405:             my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
                   10406:             if ($currtiny{$key} ne '') {
                   10407:                 $tinyurl = $currtiny{$key};
                   10408:                 &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362    raeburn  10409:             }
1.1364    raeburn  10410:         }
                   10411:         if ($tinyurl ne '') {
                   10412:             my ($cnumreq,$symb) = split(/\&/,$tinyurl);
                   10413:             if (wantarray) {
                   10414:                 return ($cnumreq,$symb);
                   10415:             } elsif ($cnumreq eq $cnum) {
                   10416:                 return $symb;
1.1362    raeburn  10417:             }
                   10418:         }
                   10419:     }
1.1364    raeburn  10420:     if (wantarray) {
                   10421:         return ();
                   10422:     } else {
                   10423:         return;
                   10424:     }
1.1362    raeburn  10425: }
                   10426: 
1.1405    raeburn  10427: sub usable_exttools {
                   10428:     my %tooltypes;
                   10429:     if ($env{'request.course.id'}) {
                   10430:         if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
                   10431:            if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
                   10432:                %tooltypes = (
                   10433:                              crs => 1,
                   10434:                              dom => 1,
                   10435:                             );
                   10436:            } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
                   10437:                $tooltypes{'crs'} = 1;
                   10438:            } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
                   10439:                $tooltypes{'dom'} = 1;
                   10440:            }
                   10441:         } else {
                   10442:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10443:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   10444:             my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
                   10445:             if ($crstype eq '') {
                   10446:                 $crstype = 'course';
                   10447:             }
                   10448:             if ($crstype eq 'course') {
                   10449:                 if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
                   10450:                     $crstype = 'official';
                   10451:                 } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
                   10452:                     $crstype = 'textbook';
                   10453:                 } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
                   10454:                     $crstype = 'lti';
                   10455:                 } else {
                   10456:                     $crstype = 'unofficial';
                   10457:                 }
                   10458:             }
                   10459:             my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
                   10460:             if ($domdefaults{$crstype.'domexttool'}) {
                   10461:                 $tooltypes{'dom'} = 1;
                   10462:             }
                   10463:             if ($domdefaults{$crstype.'exttool'}) {
                   10464:                 $tooltypes{'crs'} = 1;
                   10465:             }
                   10466:         }
                   10467:     }
                   10468:     return %tooltypes;
                   10469: }
                   10470: 
1.1034    www      10471: sub wishlist_window {
                   10472:     return(<<'ENDWISHLIST');
1.1046    raeburn  10473: <script type="text/javascript">
1.1034    www      10474: // <![CDATA[
                   10475: // <!-- BEGIN LON-CAPA Internal
                   10476: function set_wishlistlink(title, path) {
                   10477:     if (!title) {
                   10478:         title = document.title;
                   10479:         title = title.replace(/^LON-CAPA /,'');
                   10480:     }
1.1175    raeburn  10481:     title = encodeURIComponent(title);
1.1203    raeburn  10482:     title = title.replace("'","\\\'");
1.1034    www      10483:     if (!path) {
                   10484:         path = location.pathname;
                   10485:     }
1.1175    raeburn  10486:     path = encodeURIComponent(path);
1.1203    raeburn  10487:     path = path.replace("'","\\\'");
1.1034    www      10488:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   10489:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   10490: }
                   10491: // END LON-CAPA Internal -->
                   10492: // ]]>
                   10493: </script>
                   10494: ENDWISHLIST
                   10495: }
                   10496: 
1.1030    www      10497: sub modal_window {
                   10498:     return(<<'ENDMODAL');
1.1046    raeburn  10499: <script type="text/javascript">
1.1030    www      10500: // <![CDATA[
                   10501: // <!-- BEGIN LON-CAPA Internal
                   10502: var modalWindow = {
                   10503: 	parent:"body",
                   10504: 	windowId:null,
                   10505: 	content:null,
                   10506: 	width:null,
                   10507: 	height:null,
                   10508: 	close:function()
                   10509: 	{
                   10510: 	        $(".LCmodal-window").remove();
                   10511: 	        $(".LCmodal-overlay").remove();
                   10512: 	},
                   10513: 	open:function()
                   10514: 	{
                   10515: 		var modal = "";
                   10516: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   10517: 		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;\">";
                   10518: 		modal += this.content;
                   10519: 		modal += "</div>";	
                   10520: 
                   10521: 		$(this.parent).append(modal);
                   10522: 
                   10523: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   10524: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   10525: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   10526: 	}
                   10527: };
1.1140    raeburn  10528: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      10529: 	{
1.1266    raeburn  10530:                 source = source.replace(/'/g,"&#39;");
1.1030    www      10531: 		modalWindow.windowId = "myModal";
                   10532: 		modalWindow.width = width;
                   10533: 		modalWindow.height = height;
1.1196    raeburn  10534: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      10535: 		modalWindow.open();
1.1208    raeburn  10536: 	};
1.1030    www      10537: // END LON-CAPA Internal -->
                   10538: // ]]>
                   10539: </script>
                   10540: ENDMODAL
                   10541: }
                   10542: 
                   10543: sub modal_link {
1.1140    raeburn  10544:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      10545:     unless ($width) { $width=480; }
                   10546:     unless ($height) { $height=400; }
1.1031    www      10547:     unless ($scrolling) { $scrolling='yes'; }
1.1140    raeburn  10548:     unless ($transparency) { $transparency='true'; }
                   10549: 
1.1074    raeburn  10550:     my $target_attr;
                   10551:     if (defined($target)) {
                   10552:         $target_attr = 'target="'.$target.'"';
                   10553:     }
                   10554:     return <<"ENDLINK";
1.1336    raeburn  10555: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074    raeburn  10556: ENDLINK
1.1030    www      10557: }
                   10558: 
1.1032    www      10559: sub modal_adhoc_script {
1.1365    raeburn  10560:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
                   10561:     my $mathjax;
                   10562:     if ($possmathjax) {
                   10563:         $mathjax = <<'ENDJAX';
                   10564:                if (typeof MathJax == 'object') {
                   10565:                    MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
                   10566:                }
                   10567: ENDJAX
                   10568:     }
1.1032    www      10569:     return (<<ENDADHOC);
1.1046    raeburn  10570: <script type="text/javascript">
1.1032    www      10571: // <![CDATA[
                   10572:         var $funcname = function()
                   10573:         {
                   10574:                 modalWindow.windowId = "myModal";
                   10575:                 modalWindow.width = $width;
                   10576:                 modalWindow.height = $height;
                   10577:                 modalWindow.content = '$content';
                   10578:                 modalWindow.open();
1.1365    raeburn  10579:                 $mathjax
1.1032    www      10580:         };  
                   10581: // ]]>
                   10582: </script>
                   10583: ENDADHOC
                   10584: }
                   10585: 
1.1041    www      10586: sub modal_adhoc_inner {
1.1365    raeburn  10587:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041    www      10588:     my $innerwidth=$width-20;
                   10589:     $content=&js_ready(
1.1140    raeburn  10590:                  &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
                   10591:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   10592:                  $content.
1.1041    www      10593:                  &end_scrollbox().
1.1140    raeburn  10594:                  &end_page()
1.1041    www      10595:              );
1.1365    raeburn  10596:     return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041    www      10597: }
                   10598: 
                   10599: sub modal_adhoc_window {
1.1365    raeburn  10600:     my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
                   10601:     return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041    www      10602:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   10603: }
                   10604: 
                   10605: sub modal_adhoc_launch {
                   10606:     my ($funcname,$width,$height,$content)=@_;
                   10607:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   10608: <script type="text/javascript">
                   10609: // <![CDATA[
                   10610: $funcname();
                   10611: // ]]>
                   10612: </script>
                   10613: ENDLAUNCH
                   10614: }
                   10615: 
                   10616: sub modal_adhoc_close {
                   10617:     return (<<ENDCLOSE);
                   10618: <script type="text/javascript">
                   10619: // <![CDATA[
                   10620: modalWindow.close();
                   10621: // ]]>
                   10622: </script>
                   10623: ENDCLOSE
                   10624: }
                   10625: 
1.1038    www      10626: sub togglebox_script {
                   10627:    return(<<ENDTOGGLE);
                   10628: <script type="text/javascript"> 
                   10629: // <![CDATA[
                   10630: function LCtoggleDisplay(id,hidetext,showtext) {
                   10631:    link = document.getElementById(id + "link").childNodes[0];
                   10632:    with (document.getElementById(id).style) {
                   10633:       if (display == "none" ) {
                   10634:           display = "inline";
                   10635:           link.nodeValue = hidetext;
                   10636:         } else {
                   10637:           display = "none";
                   10638:           link.nodeValue = showtext;
                   10639:        }
                   10640:    }
                   10641: }
                   10642: // ]]>
                   10643: </script>
                   10644: ENDTOGGLE
                   10645: }
                   10646: 
1.1039    www      10647: sub start_togglebox {
                   10648:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   10649:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   10650:     unless ($showtext) { $showtext=&mt('show'); }
                   10651:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   10652:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   10653:     return &start_data_table().
                   10654:            &start_data_table_header_row().
                   10655:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   10656:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   10657:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   10658:            &end_data_table_header_row().
                   10659:            '<tr id="'.$id.'" style="display:none""><td>';
                   10660: }
                   10661: 
                   10662: sub end_togglebox {
                   10663:     return '</td></tr>'.&end_data_table();
                   10664: }
                   10665: 
1.1041    www      10666: sub LCprogressbar_script {
1.1302    raeburn  10667:    my ($id,$number_to_do)=@_;
                   10668:    if ($number_to_do) {
                   10669:        return(<<ENDPROGRESS);
1.1041    www      10670: <script type="text/javascript">
                   10671: // <![CDATA[
1.1045    www      10672: \$('#progressbar$id').progressbar({
1.1041    www      10673:   value: 0,
                   10674:   change: function(event, ui) {
                   10675:     var newVal = \$(this).progressbar('option', 'value');
                   10676:     \$('.pblabel', this).text(LCprogressTxt);
                   10677:   }
                   10678: });
                   10679: // ]]>
                   10680: </script>
                   10681: ENDPROGRESS
1.1302    raeburn  10682:    } else {
                   10683:        return(<<ENDPROGRESS);
                   10684: <script type="text/javascript">
                   10685: // <![CDATA[
                   10686: \$('#progressbar$id').progressbar({
                   10687:   value: false,
                   10688:   create: function(event, ui) {
                   10689:     \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
                   10690:     \$('.ui-progressbar-overlay', this).css({'margin':'0'});
                   10691:   }
                   10692: });
                   10693: // ]]>
                   10694: </script>
                   10695: ENDPROGRESS
                   10696:    }
1.1041    www      10697: }
                   10698: 
                   10699: sub LCprogressbarUpdate_script {
                   10700:    return(<<ENDPROGRESSUPDATE);
                   10701: <style type="text/css">
                   10702: .ui-progressbar { position:relative; }
1.1302    raeburn  10703: .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      10704: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   10705: </style>
                   10706: <script type="text/javascript">
                   10707: // <![CDATA[
1.1045    www      10708: var LCprogressTxt='---';
                   10709: 
1.1302    raeburn  10710: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041    www      10711:    LCprogressTxt=progresstext;
1.1302    raeburn  10712:    if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
                   10713:        \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
                   10714:    } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301    raeburn  10715:        \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
                   10716:    } else {
                   10717:        \$('#progressbar'+id).progressbar('value',percent);
                   10718:    }
1.1041    www      10719: }
                   10720: // ]]>
                   10721: </script>
                   10722: ENDPROGRESSUPDATE
                   10723: }
                   10724: 
1.1042    www      10725: my $LClastpercent;
1.1045    www      10726: my $LCidcnt;
                   10727: my $LCcurrentid;
1.1042    www      10728: 
1.1041    www      10729: sub LCprogressbar {
1.1302    raeburn  10730:     my ($r,$number_to_do,$preamble)=@_;
1.1042    www      10731:     $LClastpercent=0;
1.1045    www      10732:     $LCidcnt++;
                   10733:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1302    raeburn  10734:     my ($starting,$content);
                   10735:     if ($number_to_do) {
                   10736:         $starting=&mt('Starting');
                   10737:         $content=(<<ENDPROGBAR);
                   10738: $preamble
1.1045    www      10739:   <div id="progressbar$LCcurrentid">
1.1041    www      10740:     <span class="pblabel">$starting</span>
                   10741:   </div>
                   10742: ENDPROGBAR
1.1302    raeburn  10743:     } else {
                   10744:         $starting=&mt('Loading...');
                   10745:         $LClastpercent='false';
                   10746:         $content=(<<ENDPROGBAR);
                   10747: $preamble
                   10748:   <div id="progressbar$LCcurrentid">
                   10749:       <div class="progress-label">$starting</div>
                   10750:   </div>
                   10751: ENDPROGBAR
                   10752:     }
                   10753:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041    www      10754: }
                   10755: 
                   10756: sub LCprogressbarUpdate {
1.1302    raeburn  10757:     my ($r,$val,$text,$number_to_do)=@_;
                   10758:     if ($number_to_do) {
                   10759:         unless ($val) { 
                   10760:             if ($LClastpercent) {
                   10761:                 $val=$LClastpercent;
                   10762:             } else {
                   10763:                 $val=0;
                   10764:             }
                   10765:         }
                   10766:         if ($val<0) { $val=0; }
                   10767:         if ($val>100) { $val=0; }
                   10768:         $LClastpercent=$val;
                   10769:         unless ($text) { $text=$val.'%'; }
                   10770:     } else {
                   10771:         $val = 'false';
1.1042    www      10772:     }
1.1041    www      10773:     $text=&js_ready($text);
1.1044    www      10774:     &r_print($r,<<ENDUPDATE);
1.1041    www      10775: <script type="text/javascript">
                   10776: // <![CDATA[
1.1302    raeburn  10777: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041    www      10778: // ]]>
                   10779: </script>
                   10780: ENDUPDATE
1.1035    www      10781: }
                   10782: 
1.1042    www      10783: sub LCprogressbarClose {
                   10784:     my ($r)=@_;
                   10785:     $LClastpercent=0;
1.1044    www      10786:     &r_print($r,<<ENDCLOSE);
1.1042    www      10787: <script type="text/javascript">
                   10788: // <![CDATA[
1.1045    www      10789: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      10790: // ]]>
                   10791: </script>
                   10792: ENDCLOSE
1.1044    www      10793: }
                   10794: 
                   10795: sub r_print {
                   10796:     my ($r,$to_print)=@_;
                   10797:     if ($r) {
                   10798:       $r->print($to_print);
                   10799:       $r->rflush();
                   10800:     } else {
                   10801:       print($to_print);
                   10802:     }
1.1042    www      10803: }
                   10804: 
1.320     albertel 10805: sub html_encode {
                   10806:     my ($result) = @_;
                   10807: 
1.322     albertel 10808:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 10809:     
                   10810:     return $result;
                   10811: }
1.1044    www      10812: 
1.317     albertel 10813: sub js_ready {
                   10814:     my ($result) = @_;
                   10815: 
1.323     albertel 10816:     $result =~ s/[\n\r]/ /xmsg;
                   10817:     $result =~ s/\\/\\\\/xmsg;
                   10818:     $result =~ s/'/\\'/xmsg;
1.372     albertel 10819:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 10820:     
                   10821:     return $result;
                   10822: }
                   10823: 
1.315     albertel 10824: sub validate_page {
                   10825:     if (  exists($env{'internal.start_page'})
1.316     albertel 10826: 	  &&     $env{'internal.start_page'} > 1) {
                   10827: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 10828: 				 $env{'internal.start_page'}.' '.
1.316     albertel 10829: 				 $ENV{'request.filename'});
1.315     albertel 10830:     }
                   10831:     if (  exists($env{'internal.end_page'})
1.316     albertel 10832: 	  &&     $env{'internal.end_page'} > 1) {
                   10833: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 10834: 				 $env{'internal.end_page'}.' '.
1.316     albertel 10835: 				 $env{'request.filename'});
1.315     albertel 10836:     }
                   10837:     if (     exists($env{'internal.start_page'})
                   10838: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 10839: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   10840: 				 $env{'request.filename'});
1.315     albertel 10841:     }
                   10842:     if (   ! exists($env{'internal.start_page'})
                   10843: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 10844: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   10845: 				 $env{'request.filename'});
1.315     albertel 10846:     }
1.306     albertel 10847: }
1.315     albertel 10848: 
1.996     www      10849: 
                   10850: sub start_scrollbox {
1.1140    raeburn  10851:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  10852:     unless ($outerwidth) { $outerwidth='520px'; }
                   10853:     unless ($width) { $width='500px'; }
                   10854:     unless ($height) { $height='200px'; }
1.1075    raeburn  10855:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  10856:     if ($id ne '') {
1.1140    raeburn  10857:         $table_id = ' id="table_'.$id.'"';
1.1137    raeburn  10858:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  10859:     }
1.1075    raeburn  10860:     if ($bgcolor ne '') {
                   10861:         $tdcol = "background-color: $bgcolor;";
                   10862:     }
1.1137    raeburn  10863:     my $nicescroll_js;
                   10864:     if ($env{'browser.mobile'}) {
1.1140    raeburn  10865:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   10866:     }
                   10867:     return <<"END";
                   10868: $nicescroll_js
                   10869: 
                   10870: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
                   10871: <div style="overflow:auto; width:$width; height:$height;"$div_id>
                   10872: END
                   10873: }
                   10874: 
                   10875: sub end_scrollbox {
                   10876:     return '</div></td></tr></table>';
                   10877: }
                   10878: 
                   10879: sub nicescroll_javascript {
                   10880:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   10881:     my %options;
                   10882:     if (ref($cursor) eq 'HASH') {
                   10883:         %options = %{$cursor};
                   10884:     }
                   10885:     unless ($options{'railalign'} =~ /^left|right$/) {
                   10886:         $options{'railalign'} = 'left';
                   10887:     }
                   10888:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   10889:         my $function  = &get_users_function();
                   10890:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138    raeburn  10891:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140    raeburn  10892:             $options{'cursorcolor'} = '#00F';
1.1138    raeburn  10893:         }
1.1140    raeburn  10894:     }
                   10895:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   10896:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138    raeburn  10897:             $options{'cursoropacity'}='1.0';
                   10898:         }
1.1140    raeburn  10899:     } else {
                   10900:         $options{'cursoropacity'}='1.0';
                   10901:     }
                   10902:     if ($options{'cursorfixedheight'} eq 'none') {
                   10903:         delete($options{'cursorfixedheight'});
                   10904:     } else {
                   10905:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   10906:     }
                   10907:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   10908:         delete($options{'railoffset'});
                   10909:     }
                   10910:     my @niceoptions;
                   10911:     while (my($key,$value) = each(%options)) {
                   10912:         if ($value =~ /^\{.+\}$/) {
                   10913:             push(@niceoptions,$key.':'.$value);
1.1138    raeburn  10914:         } else {
1.1140    raeburn  10915:             push(@niceoptions,$key.':"'.$value.'"');
1.1138    raeburn  10916:         }
1.1140    raeburn  10917:     }
                   10918:     my $nicescroll_js = '
1.1137    raeburn  10919: $(document).ready(
1.1140    raeburn  10920:       function() {
                   10921:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   10922:       }
1.1137    raeburn  10923: );
                   10924: ';
1.1140    raeburn  10925:     if ($framecheck) {
                   10926:         $nicescroll_js .= '
                   10927: function expand_div(caller) {
                   10928:     if (top === self) {
                   10929:         document.getElementById("'.$id.'").style.width = "auto";
                   10930:         document.getElementById("'.$id.'").style.height = "auto";
                   10931:     } else {
                   10932:         try {
                   10933:             if (parent.frames) {
                   10934:                 if (parent.frames.length > 1) {
                   10935:                     var framesrc = parent.frames[1].location.href;
                   10936:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   10937:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   10938:                         document.getElementById("'.$id.'").style.width = "auto";
                   10939:                         document.getElementById("'.$id.'").style.height = "auto";
                   10940:                     }
                   10941:                 }
                   10942:             }
                   10943:         } catch (e) {
                   10944:             return;
                   10945:         }
1.1137    raeburn  10946:     }
1.1140    raeburn  10947:     return;
1.996     www      10948: }
1.1140    raeburn  10949: ';
                   10950:     }
                   10951:     if ($needjsready) {
                   10952:         $nicescroll_js = '
                   10953: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   10954:     } else {
                   10955:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   10956:     }
                   10957:     return $nicescroll_js;
1.996     www      10958: }
                   10959: 
1.318     albertel 10960: sub simple_error_page {
1.1150    bisitz   10961:     my ($r,$title,$msg,$args) = @_;
1.1304    raeburn  10962:     my %displayargs;
1.1151    raeburn  10963:     if (ref($args) eq 'HASH') {
                   10964:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304    raeburn  10965:         if ($args->{'only_body'}) {
                   10966:             $displayargs{'only_body'} = 1;
                   10967:         }
                   10968:         if ($args->{'no_nav_bar'}) {
                   10969:             $displayargs{'no_nav_bar'} = 1;
                   10970:         }
1.1151    raeburn  10971:     } else {
                   10972:         $msg = &mt($msg);
                   10973:     }
1.1150    bisitz   10974: 
1.318     albertel 10975:     my $page =
1.1459    raeburn  10976: 	&Apache::loncommon::start_page($title,'',\%displayargs)."\n".
1.1460    raeburn  10977:         '<div class="LC_landmark" style="clear:both" role="main">'.
1.1150    bisitz   10978: 	'<p class="LC_error">'.$msg.'</p>'.
1.1459    raeburn  10979:         '</div>'.
1.318     albertel 10980: 	&Apache::loncommon::end_page();
                   10981:     if (ref($r)) {
                   10982: 	$r->print($page);
1.327     albertel 10983: 	return;
1.318     albertel 10984:     }
                   10985:     return $page;
                   10986: }
1.347     albertel 10987: 
                   10988: {
1.610     albertel 10989:     my @row_count;
1.961     onken    10990: 
                   10991:     sub start_data_table_count {
                   10992:         unshift(@row_count, 0);
                   10993:         return;
                   10994:     }
                   10995: 
                   10996:     sub end_data_table_count {
                   10997:         shift(@row_count);
                   10998:         return;
                   10999:     }
                   11000: 
1.1466    raeburn  11001:     sub set_data_table_count {
                   11002:         my ($count) = @_;
                   11003:         unshift(@row_count,$count);
                   11004:     }
                   11005: 
1.347     albertel 11006:     sub start_data_table {
1.1018    raeburn  11007: 	my ($add_class,$id) = @_;
1.422     albertel 11008: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  11009:         my $table_id;
                   11010:         if (defined($id)) {
                   11011:             $table_id = ' id="'.$id.'"';
                   11012:         }
1.961     onken    11013: 	&start_data_table_count();
1.1018    raeburn  11014: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 11015:     }
                   11016: 
                   11017:     sub end_data_table {
1.961     onken    11018: 	&end_data_table_count();
1.389     albertel 11019: 	return '</table>'."\n";;
1.347     albertel 11020:     }
                   11021: 
                   11022:     sub start_data_table_row {
1.974     wenzelju 11023: 	my ($add_class, $id) = @_;
1.610     albertel 11024: 	$row_count[0]++;
                   11025: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   11026: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 11027:         $id = (' id="'.$id.'"') unless ($id eq '');
                   11028:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 11029:     }
1.471     banghart 11030:     
                   11031:     sub continue_data_table_row {
1.974     wenzelju 11032: 	my ($add_class, $id) = @_;
1.610     albertel 11033: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 11034: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   11035:         $id = (' id="'.$id.'"') unless ($id eq '');
                   11036:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 11037:     }
1.347     albertel 11038: 
                   11039:     sub end_data_table_row {
1.389     albertel 11040: 	return '</tr>'."\n";;
1.347     albertel 11041:     }
1.367     www      11042: 
1.421     albertel 11043:     sub start_data_table_empty_row {
1.707     bisitz   11044: #	$row_count[0]++;
1.421     albertel 11045: 	return  '<tr class="LC_empty_row" >'."\n";;
                   11046:     }
                   11047: 
                   11048:     sub end_data_table_empty_row {
                   11049: 	return '</tr>'."\n";;
                   11050:     }
                   11051: 
1.367     www      11052:     sub start_data_table_header_row {
1.1465    raeburn  11053: 	my ($add_class,$id) = @_;
                   11054: 	my $css_class = 'LC_header_row';
                   11055: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   11056: 	$id = (' id="'.$id.'"') unless ($id eq '');
                   11057: 	return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.367     www      11058:     }
                   11059: 
                   11060:     sub end_data_table_header_row {
1.389     albertel 11061: 	return '</tr>'."\n";;
1.367     www      11062:     }
1.890     droeschl 11063: 
                   11064:     sub data_table_caption {
1.1468    raeburn  11065:         my ($caption,$css_class) = @_;
                   11066:         return "<caption class=\"LC_caption $css_class\">$caption</caption>";
1.890     droeschl 11067:     }
1.347     albertel 11068: }
                   11069: 
1.548     albertel 11070: =pod
                   11071: 
                   11072: =item * &inhibit_menu_check($arg)
                   11073: 
                   11074: Checks for a inhibitmenu state and generates output to preserve it
                   11075: 
                   11076: Inputs:         $arg - can be any of
                   11077:                      - undef - in which case the return value is a string 
                   11078:                                to add  into arguments list of a uri
                   11079:                      - 'input' - in which case the return value is a HTML
                   11080:                                  <form> <input> field of type hidden to
                   11081:                                  preserve the value
                   11082:                      - a url - in which case the return value is the url with
                   11083:                                the neccesary cgi args added to preserve the
                   11084:                                inhibitmenu state
                   11085:                      - a ref to a url - no return value, but the string is
                   11086:                                         updated to include the neccessary cgi
                   11087:                                         args to preserve the inhibitmenu state
                   11088: 
                   11089: =cut
                   11090: 
                   11091: sub inhibit_menu_check {
                   11092:     my ($arg) = @_;
                   11093:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   11094:     if ($arg eq 'input') {
                   11095: 	if ($env{'form.inhibitmenu'}) {
                   11096: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   11097: 	} else {
                   11098: 	    return
                   11099: 	}
                   11100:     }
                   11101:     if ($env{'form.inhibitmenu'}) {
                   11102: 	if (ref($arg)) {
                   11103: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   11104: 	} elsif ($arg eq '') {
                   11105: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   11106: 	} else {
                   11107: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   11108: 	}
                   11109:     }
                   11110:     if (!ref($arg)) {
                   11111: 	return $arg;
                   11112:     }
                   11113: }
                   11114: 
1.251     albertel 11115: ###############################################
1.182     matthew  11116: 
                   11117: =pod
                   11118: 
1.549     albertel 11119: =back
                   11120: 
                   11121: =head1 User Information Routines
                   11122: 
                   11123: =over 4
                   11124: 
1.405     albertel 11125: =item * &get_users_function()
1.182     matthew  11126: 
                   11127: Used by &bodytag to determine the current users primary role.
                   11128: Returns either 'student','coordinator','admin', or 'author'.
                   11129: 
                   11130: =cut
                   11131: 
                   11132: ###############################################
                   11133: sub get_users_function {
1.815     tempelho 11134:     my $function = 'norole';
1.818     tempelho 11135:     if ($env{'request.role'}=~/^(st)/) {
                   11136:         $function='student';
                   11137:     }
1.907     raeburn  11138:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  11139:         $function='coordinator';
                   11140:     }
1.258     albertel 11141:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  11142:         $function='admin';
                   11143:     }
1.826     bisitz   11144:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  11145:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  11146:         $function='author';
                   11147:     }
                   11148:     return $function;
1.54      www      11149: }
1.99      www      11150: 
                   11151: ###############################################
                   11152: 
1.233     raeburn  11153: =pod
                   11154: 
1.821     raeburn  11155: =item * &show_course()
                   11156: 
                   11157: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   11158: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   11159: 
                   11160: Inputs:
                   11161: None
                   11162: 
                   11163: Outputs:
                   11164: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   11165: 
                   11166: =cut
                   11167: 
                   11168: ###############################################
                   11169: sub show_course {
1.1408    raeburn  11170:     my ($udom,$uname) = @_;
                   11171:     if (($udom ne '') && ($uname ne '')) {
                   11172:         if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410    raeburn  11173:             if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408    raeburn  11174:                 return 0;
                   11175:             } else {
                   11176:                 return 1;
                   11177:             }
                   11178:         }
                   11179:     }
1.821     raeburn  11180:     my $course = !$env{'user.adv'};
                   11181:     if (!$env{'user.adv'}) {
                   11182:         foreach my $env (keys(%env)) {
                   11183:             next if ($env !~ m/^user\.priv\./);
                   11184:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   11185:                 $course = 0;
                   11186:                 last;
                   11187:             }
                   11188:         }
                   11189:     }
                   11190:     return $course;
                   11191: }
                   11192: 
                   11193: ###############################################
                   11194: 
                   11195: =pod
                   11196: 
1.542     raeburn  11197: =item * &check_user_status()
1.274     raeburn  11198: 
                   11199: Determines current status of supplied role for a
                   11200: specific user. Roles can be active, previous or future.
                   11201: 
                   11202: Inputs: 
                   11203: user's domain, user's username, course's domain,
1.375     raeburn  11204: course's number, optional section ID.
1.274     raeburn  11205: 
                   11206: Outputs:
                   11207: role status: active, previous or future. 
                   11208: 
                   11209: =cut
                   11210: 
                   11211: sub check_user_status {
1.412     raeburn  11212:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  11213:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202    raeburn  11214:     my @uroles = keys(%userinfo);
1.274     raeburn  11215:     my $srchstr;
                   11216:     my $active_chk = 'none';
1.412     raeburn  11217:     my $now = time;
1.274     raeburn  11218:     if (@uroles > 0) {
1.908     raeburn  11219:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  11220:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   11221:         } else {
1.412     raeburn  11222:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   11223:         }
                   11224:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  11225:             my $role_end = 0;
                   11226:             my $role_start = 0;
                   11227:             $active_chk = 'active';
1.412     raeburn  11228:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   11229:                 $role_end = $1;
                   11230:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   11231:                     $role_start = $1;
1.274     raeburn  11232:                 }
                   11233:             }
                   11234:             if ($role_start > 0) {
1.412     raeburn  11235:                 if ($now < $role_start) {
1.274     raeburn  11236:                     $active_chk = 'future';
                   11237:                 }
                   11238:             }
                   11239:             if ($role_end > 0) {
1.412     raeburn  11240:                 if ($now > $role_end) {
1.274     raeburn  11241:                     $active_chk = 'previous';
                   11242:                 }
                   11243:             }
                   11244:         }
                   11245:     }
                   11246:     return $active_chk;
                   11247: }
                   11248: 
                   11249: ###############################################
                   11250: 
                   11251: =pod
                   11252: 
1.405     albertel 11253: =item * &get_sections()
1.233     raeburn  11254: 
                   11255: Determines all the sections for a course including
                   11256: sections with students and sections containing other roles.
1.419     raeburn  11257: Incoming parameters: 
                   11258: 
                   11259: 1. domain
                   11260: 2. course number 
                   11261: 3. reference to array containing roles for which sections should 
                   11262: be gathered (optional).
                   11263: 4. reference to array containing status types for which sections 
                   11264: should be gathered (optional).
                   11265: 
                   11266: If the third argument is undefined, sections are gathered for any role. 
                   11267: If the fourth argument is undefined, sections are gathered for any status.
                   11268: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  11269:  
1.374     raeburn  11270: Returns section hash (keys are section IDs, values are
                   11271: number of users in each section), subject to the
1.419     raeburn  11272: optional roles filter, optional status filter 
1.233     raeburn  11273: 
                   11274: =cut
                   11275: 
                   11276: ###############################################
                   11277: sub get_sections {
1.419     raeburn  11278:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 11279:     if (!defined($cdom) || !defined($cnum)) {
                   11280:         my $cid =  $env{'request.course.id'};
                   11281: 
                   11282: 	return if (!defined($cid));
                   11283: 
                   11284:         $cdom = $env{'course.'.$cid.'.domain'};
                   11285:         $cnum = $env{'course.'.$cid.'.num'};
                   11286:     }
                   11287: 
                   11288:     my %sectioncount;
1.419     raeburn  11289:     my $now = time;
1.240     albertel 11290: 
1.1118    raeburn  11291:     my $check_students = 1;
                   11292:     my $only_students = 0;
                   11293:     if (ref($possible_roles) eq 'ARRAY') {
                   11294:         if (grep(/^st$/,@{$possible_roles})) {
                   11295:             if (@{$possible_roles} == 1) {
                   11296:                 $only_students = 1;
                   11297:             }
                   11298:         } else {
                   11299:             $check_students = 0;
                   11300:         }
                   11301:     }
                   11302: 
                   11303:     if ($check_students) { 
1.276     albertel 11304: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 11305: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   11306: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  11307:         my $start_index = &Apache::loncoursedata::CL_START();
                   11308:         my $end_index = &Apache::loncoursedata::CL_END();
                   11309:         my $status;
1.366     albertel 11310: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  11311: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   11312: 				                     $data->[$status_index],
                   11313:                                                      $data->[$start_index],
                   11314:                                                      $data->[$end_index]);
                   11315:             if ($stu_status eq 'Active') {
                   11316:                 $status = 'active';
                   11317:             } elsif ($end < $now) {
                   11318:                 $status = 'previous';
                   11319:             } elsif ($start > $now) {
                   11320:                 $status = 'future';
                   11321:             } 
                   11322: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   11323:                 if ((!defined($possible_status)) || (($status ne '') && 
                   11324:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   11325: 		    $sectioncount{$section}++;
                   11326:                 }
1.240     albertel 11327: 	    }
                   11328: 	}
                   11329:     }
1.1118    raeburn  11330:     if ($only_students) {
                   11331:         return %sectioncount;
                   11332:     }
1.240     albertel 11333:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   11334:     foreach my $user (sort(keys(%courseroles))) {
                   11335: 	if ($user !~ /^(\w{2})/) { next; }
                   11336: 	my ($role) = ($user =~ /^(\w{2})/);
                   11337: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  11338: 	my ($section,$status);
1.240     albertel 11339: 	if ($role eq 'cr' &&
                   11340: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   11341: 	    $section=$1;
                   11342: 	}
                   11343: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   11344: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  11345:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   11346:         if ($end == -1 && $start == -1) {
                   11347:             next; #deleted role
                   11348:         }
                   11349:         if (!defined($possible_status)) { 
                   11350:             $sectioncount{$section}++;
                   11351:         } else {
                   11352:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   11353:                 $status = 'active';
                   11354:             } elsif ($end < $now) {
                   11355:                 $status = 'future';
                   11356:             } elsif ($start > $now) {
                   11357:                 $status = 'previous';
                   11358:             }
                   11359:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   11360:                 $sectioncount{$section}++;
                   11361:             }
                   11362:         }
1.233     raeburn  11363:     }
1.366     albertel 11364:     return %sectioncount;
1.233     raeburn  11365: }
                   11366: 
1.274     raeburn  11367: ###############################################
1.294     raeburn  11368: 
                   11369: =pod
1.405     albertel 11370: 
                   11371: =item * &get_course_users()
                   11372: 
1.275     raeburn  11373: Retrieves usernames:domains for users in the specified course
                   11374: with specific role(s), and access status. 
                   11375: 
                   11376: Incoming parameters:
1.277     albertel 11377: 1. course domain
                   11378: 2. course number
                   11379: 3. access status: users must have - either active, 
1.275     raeburn  11380: previous, future, or all.
1.277     albertel 11381: 4. reference to array of permissible roles
1.288     raeburn  11382: 5. reference to array of section restrictions (optional)
                   11383: 6. reference to results object (hash of hashes).
                   11384: 7. reference to optional userdata hash
1.609     raeburn  11385: 8. reference to optional statushash
1.630     raeburn  11386: 9. flag if privileged users (except those set to unhide in
                   11387:    course settings) should be excluded    
1.609     raeburn  11388: Keys of top level results hash are roles.
1.275     raeburn  11389: Keys of inner hashes are username:domain, with 
                   11390: values set to access type.
1.288     raeburn  11391: Optional userdata hash returns an array with arguments in the 
                   11392: same order as loncoursedata::get_classlist() for student data.
                   11393: 
1.609     raeburn  11394: Optional statushash returns
                   11395: 
1.288     raeburn  11396: Entries for end, start, section and status are blank because
                   11397: of the possibility of multiple values for non-student roles.
                   11398: 
1.275     raeburn  11399: =cut
1.405     albertel 11400: 
1.275     raeburn  11401: ###############################################
1.405     albertel 11402: 
1.275     raeburn  11403: sub get_course_users {
1.630     raeburn  11404:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  11405:     my %idx = ();
1.419     raeburn  11406:     my %seclists;
1.288     raeburn  11407: 
                   11408:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   11409:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   11410:     $idx{end} = &Apache::loncoursedata::CL_END();
                   11411:     $idx{start} = &Apache::loncoursedata::CL_START();
                   11412:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   11413:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   11414:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   11415:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   11416: 
1.290     albertel 11417:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 11418:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  11419:         my $now = time;
1.277     albertel 11420:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  11421:             my $match = 0;
1.412     raeburn  11422:             my $secmatch = 0;
1.419     raeburn  11423:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  11424:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  11425:             if ($section eq '') {
                   11426:                 $section = 'none';
                   11427:             }
1.291     albertel 11428:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 11429:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  11430:                     $secmatch = 1;
                   11431:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 11432:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  11433:                         $secmatch = 1;
                   11434:                     }
                   11435:                 } else {  
1.419     raeburn  11436: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  11437: 		        $secmatch = 1;
                   11438:                     }
1.290     albertel 11439: 		}
1.412     raeburn  11440:                 if (!$secmatch) {
                   11441:                     next;
                   11442:                 }
1.419     raeburn  11443:             }
1.275     raeburn  11444:             if (defined($$types{'active'})) {
1.288     raeburn  11445:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  11446:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  11447:                     $match = 1;
1.275     raeburn  11448:                 }
                   11449:             }
                   11450:             if (defined($$types{'previous'})) {
1.609     raeburn  11451:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  11452:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  11453:                     $match = 1;
1.275     raeburn  11454:                 }
                   11455:             }
                   11456:             if (defined($$types{'future'})) {
1.609     raeburn  11457:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  11458:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  11459:                     $match = 1;
1.275     raeburn  11460:                 }
                   11461:             }
1.609     raeburn  11462:             if ($match) {
                   11463:                 push(@{$seclists{$student}},$section);
                   11464:                 if (ref($userdata) eq 'HASH') {
                   11465:                     $$userdata{$student} = $$classlist{$student};
                   11466:                 }
                   11467:                 if (ref($statushash) eq 'HASH') {
                   11468:                     $statushash->{$student}{'st'}{$section} = $status;
                   11469:                 }
1.288     raeburn  11470:             }
1.275     raeburn  11471:         }
                   11472:     }
1.412     raeburn  11473:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  11474:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   11475:         my $now = time;
1.609     raeburn  11476:         my %displaystatus = ( previous => 'Expired',
                   11477:                               active   => 'Active',
                   11478:                               future   => 'Future',
                   11479:                             );
1.1121    raeburn  11480:         my (%nothide,@possdoms);
1.630     raeburn  11481:         if ($hidepriv) {
                   11482:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   11483:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   11484:                 if ($user !~ /:/) {
                   11485:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   11486:                 } else {
                   11487:                     $nothide{$user} = 1;
                   11488:                 }
                   11489:             }
1.1121    raeburn  11490:             my @possdoms = ($cdom);
                   11491:             if ($coursehash{'checkforpriv'}) {
                   11492:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   11493:             }
1.630     raeburn  11494:         }
1.439     raeburn  11495:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  11496:             my $match = 0;
1.412     raeburn  11497:             my $secmatch = 0;
1.439     raeburn  11498:             my $status;
1.412     raeburn  11499:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  11500:             $user =~ s/:$//;
1.439     raeburn  11501:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   11502:             if ($end == -1 || $start == -1) {
                   11503:                 next;
                   11504:             }
                   11505:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   11506:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  11507:                 my ($uname,$udom) = split(/:/,$user);
                   11508:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 11509:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  11510:                         $secmatch = 1;
                   11511:                     } elsif ($usec eq '') {
1.420     albertel 11512:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  11513:                             $secmatch = 1;
                   11514:                         }
                   11515:                     } else {
                   11516:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   11517:                             $secmatch = 1;
                   11518:                         }
                   11519:                     }
                   11520:                     if (!$secmatch) {
                   11521:                         next;
                   11522:                     }
1.288     raeburn  11523:                 }
1.419     raeburn  11524:                 if ($usec eq '') {
                   11525:                     $usec = 'none';
                   11526:                 }
1.275     raeburn  11527:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  11528:                     if ($hidepriv) {
1.1121    raeburn  11529:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  11530:                             (!$nothide{$uname.':'.$udom})) {
                   11531:                             next;
                   11532:                         }
                   11533:                     }
1.503     raeburn  11534:                     if ($end > 0 && $end < $now) {
1.439     raeburn  11535:                         $status = 'previous';
                   11536:                     } elsif ($start > $now) {
                   11537:                         $status = 'future';
                   11538:                     } else {
                   11539:                         $status = 'active';
                   11540:                     }
1.277     albertel 11541:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  11542:                         if ($status eq $type) {
1.420     albertel 11543:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  11544:                                 push(@{$$users{$role}{$user}},$type);
                   11545:                             }
1.288     raeburn  11546:                             $match = 1;
                   11547:                         }
                   11548:                     }
1.419     raeburn  11549:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   11550:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   11551: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   11552:                         }
1.420     albertel 11553:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  11554:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   11555:                         }
1.609     raeburn  11556:                         if (ref($statushash) eq 'HASH') {
                   11557:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   11558:                         }
1.275     raeburn  11559:                     }
                   11560:                 }
                   11561:             }
                   11562:         }
1.290     albertel 11563:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  11564:             if ((defined($cdom)) && (defined($cnum))) {
                   11565:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   11566:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   11567:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  11568:                     next if ($owner eq '');
                   11569:                     my ($ownername,$ownerdom);
                   11570:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   11571:                         $ownername = $1;
                   11572:                         $ownerdom = $2;
                   11573:                     } else {
                   11574:                         $ownername = $owner;
                   11575:                         $ownerdom = $cdom;
                   11576:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  11577:                     }
                   11578:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 11579:                     if (defined($userdata) && 
1.609     raeburn  11580: 			!exists($$userdata{$owner})) {
                   11581: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   11582:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   11583:                             push(@{$seclists{$owner}},'none');
                   11584:                         }
                   11585:                         if (ref($statushash) eq 'HASH') {
                   11586:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  11587:                         }
1.290     albertel 11588: 		    }
1.279     raeburn  11589:                 }
                   11590:             }
                   11591:         }
1.419     raeburn  11592:         foreach my $user (keys(%seclists)) {
                   11593:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   11594:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   11595:         }
1.275     raeburn  11596:     }
                   11597:     return;
                   11598: }
                   11599: 
1.288     raeburn  11600: sub get_user_info {
                   11601:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 11602:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   11603: 	&plainname($uname,$udom,'lastname');
1.291     albertel 11604:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  11605:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  11606:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   11607:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  11608:     return;
                   11609: }
1.275     raeburn  11610: 
1.472     raeburn  11611: ###############################################
                   11612: 
                   11613: =pod
                   11614: 
                   11615: =item * &get_user_quota()
                   11616: 
1.1134    raeburn  11617: Retrieves quota assigned for storage of user files.
                   11618: Default is to report quota for portfolio files.
1.472     raeburn  11619: 
                   11620: Incoming parameters:
                   11621: 1. user's username
                   11622: 2. user's domain
1.1134    raeburn  11623: 3. quota name - portfolio, author, or course
1.1136    raeburn  11624:    (if no quota name provided, defaults to portfolio).
1.1237    raeburn  11625: 4. crstype - official, unofficial, textbook, placement or community, 
                   11626:    if quota name is course
1.472     raeburn  11627: 
                   11628: Returns:
1.1163    raeburn  11629: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  11630: 2. (Optional) Type of setting: custom or default
                   11631:    (individually assigned or default for user's 
                   11632:    institutional status).
                   11633: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   11634:    or student - types as defined in localenroll::inst_usertypes 
                   11635:    for user's domain, which determines default quota for user.
                   11636: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  11637: 
                   11638: If a value has been stored in the user's environment, 
1.536     raeburn  11639: it will return that, otherwise it returns the maximal default
1.1134    raeburn  11640: defined for the user's institutional status(es) in the domain.
1.472     raeburn  11641: 
                   11642: =cut
                   11643: 
                   11644: ###############################################
                   11645: 
                   11646: 
                   11647: sub get_user_quota {
1.1136    raeburn  11648:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  11649:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  11650:     if (!defined($udom)) {
                   11651:         $udom = $env{'user.domain'};
                   11652:     }
                   11653:     if (!defined($uname)) {
                   11654:         $uname = $env{'user.name'};
                   11655:     }
                   11656:     if (($udom eq '' || $uname eq '') ||
                   11657:         ($udom eq 'public') && ($uname eq 'public')) {
                   11658:         $quota = 0;
1.536     raeburn  11659:         $quotatype = 'default';
                   11660:         $defquota = 0; 
1.472     raeburn  11661:     } else {
1.536     raeburn  11662:         my $inststatus;
1.1134    raeburn  11663:         if ($quotaname eq 'course') {
                   11664:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   11665:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   11666:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   11667:             } else {
                   11668:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   11669:                 $quota = $cenv{'internal.uploadquota'};
                   11670:             }
1.536     raeburn  11671:         } else {
1.1134    raeburn  11672:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   11673:                 if ($quotaname eq 'author') {
                   11674:                     $quota = $env{'environment.authorquota'};
                   11675:                 } else {
                   11676:                     $quota = $env{'environment.portfolioquota'};
                   11677:                 }
                   11678:                 $inststatus = $env{'environment.inststatus'};
                   11679:             } else {
                   11680:                 my %userenv = 
                   11681:                     &Apache::lonnet::get('environment',['portfolioquota',
                   11682:                                          'authorquota','inststatus'],$udom,$uname);
                   11683:                 my ($tmp) = keys(%userenv);
                   11684:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   11685:                     if ($quotaname eq 'author') {
                   11686:                         $quota = $userenv{'authorquota'};
                   11687:                     } else {
                   11688:                         $quota = $userenv{'portfolioquota'};
                   11689:                     }
                   11690:                     $inststatus = $userenv{'inststatus'};
                   11691:                 } else {
                   11692:                     undef(%userenv);
                   11693:                 }
                   11694:             }
                   11695:         }
                   11696:         if ($quota eq '' || wantarray) {
                   11697:             if ($quotaname eq 'course') {
                   11698:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165    raeburn  11699:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') || 
1.1237    raeburn  11700:                     ($crstype eq 'community') || ($crstype eq 'textbook') ||
                   11701:                     ($crstype eq 'placement')) { 
1.1136    raeburn  11702:                     $defquota = $domdefs{$crstype.'quota'};
                   11703:                 }
                   11704:                 if ($defquota eq '') {
                   11705:                     $defquota = 500;
                   11706:                 }
1.1134    raeburn  11707:             } else {
                   11708:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   11709:             }
                   11710:             if ($quota eq '') {
                   11711:                 $quota = $defquota;
                   11712:                 $quotatype = 'default';
                   11713:             } else {
                   11714:                 $quotatype = 'custom';
                   11715:             }
1.472     raeburn  11716:         }
                   11717:     }
1.536     raeburn  11718:     if (wantarray) {
                   11719:         return ($quota,$quotatype,$settingstatus,$defquota);
                   11720:     } else {
                   11721:         return $quota;
                   11722:     }
1.472     raeburn  11723: }
                   11724: 
                   11725: ###############################################
                   11726: 
                   11727: =pod
                   11728: 
                   11729: =item * &default_quota()
                   11730: 
1.536     raeburn  11731: Retrieves default quota assigned for storage of user portfolio files,
                   11732: given an (optional) user's institutional status.
1.472     raeburn  11733: 
                   11734: Incoming parameters:
1.1142    raeburn  11735: 
1.472     raeburn  11736: 1. domain
1.536     raeburn  11737: 2. (Optional) institutional status(es).  This is a : separated list of 
                   11738:    status types (e.g., faculty, staff, student etc.)
                   11739:    which apply to the user for whom the default is being retrieved.
                   11740:    If the institutional status string in undefined, the domain
1.1134    raeburn  11741:    default quota will be returned.
                   11742: 3.  quota name - portfolio, author, or course
                   11743:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  11744: 
                   11745: Returns:
1.1142    raeburn  11746: 
1.1163    raeburn  11747: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  11748: 2. (Optional) institutional type which determined the value of the
                   11749:    default quota.
1.472     raeburn  11750: 
                   11751: If a value has been stored in the domain's configuration db,
                   11752: it will return that, otherwise it returns 20 (for backwards 
                   11753: compatibility with domains which have not set up a configuration
1.1163    raeburn  11754: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  11755: 
1.536     raeburn  11756: If the user's status includes multiple types (e.g., staff and student),
                   11757: the largest default quota which applies to the user determines the
                   11758: default quota returned.
                   11759: 
1.472     raeburn  11760: =cut
                   11761: 
                   11762: ###############################################
                   11763: 
                   11764: 
                   11765: sub default_quota {
1.1134    raeburn  11766:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  11767:     my ($defquota,$settingstatus);
                   11768:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  11769:                                             ['quotas'],$udom);
1.1134    raeburn  11770:     my $key = 'defaultquota';
                   11771:     if ($quotaname eq 'author') {
                   11772:         $key = 'authorquota';
                   11773:     }
1.622     raeburn  11774:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  11775:         if ($inststatus ne '') {
1.765     raeburn  11776:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  11777:             foreach my $item (@statuses) {
1.1134    raeburn  11778:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   11779:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  11780:                         if ($defquota eq '') {
1.1134    raeburn  11781:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  11782:                             $settingstatus = $item;
1.1134    raeburn  11783:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   11784:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  11785:                             $settingstatus = $item;
                   11786:                         }
                   11787:                     }
1.1134    raeburn  11788:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  11789:                     if ($quotahash{'quotas'}{$item} ne '') {
                   11790:                         if ($defquota eq '') {
                   11791:                             $defquota = $quotahash{'quotas'}{$item};
                   11792:                             $settingstatus = $item;
                   11793:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   11794:                             $defquota = $quotahash{'quotas'}{$item};
                   11795:                             $settingstatus = $item;
                   11796:                         }
1.536     raeburn  11797:                     }
                   11798:                 }
                   11799:             }
                   11800:         }
                   11801:         if ($defquota eq '') {
1.1134    raeburn  11802:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   11803:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   11804:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  11805:                 $defquota = $quotahash{'quotas'}{'default'};
                   11806:             }
1.536     raeburn  11807:             $settingstatus = 'default';
1.1139    raeburn  11808:             if ($defquota eq '') {
                   11809:                 if ($quotaname eq 'author') {
                   11810:                     $defquota = 500;
                   11811:                 }
                   11812:             }
1.536     raeburn  11813:         }
                   11814:     } else {
                   11815:         $settingstatus = 'default';
1.1134    raeburn  11816:         if ($quotaname eq 'author') {
                   11817:             $defquota = 500;
                   11818:         } else {
                   11819:             $defquota = 20;
                   11820:         }
1.536     raeburn  11821:     }
                   11822:     if (wantarray) {
                   11823:         return ($defquota,$settingstatus);
1.472     raeburn  11824:     } else {
1.536     raeburn  11825:         return $defquota;
1.472     raeburn  11826:     }
                   11827: }
                   11828: 
1.1135    raeburn  11829: ###############################################
                   11830: 
                   11831: =pod
                   11832: 
1.1136    raeburn  11833: =item * &excess_filesize_warning()
1.1135    raeburn  11834: 
                   11835: Returns warning message if upload of file to authoring space, or copying
1.1136    raeburn  11836: of existing file within authoring space will cause quota for the authoring
1.1146    raeburn  11837: space to be exceeded.
1.1136    raeburn  11838: 
                   11839: Same, if upload of a file directly to a course/community via Course Editor
1.1137    raeburn  11840: will cause quota for uploaded content for the course to be exceeded.
1.1135    raeburn  11841: 
1.1165    raeburn  11842: Inputs: 7 
1.1136    raeburn  11843: 1. username or coursenum
1.1135    raeburn  11844: 2. domain
1.1136    raeburn  11845: 3. context ('author' or 'course')
1.1135    raeburn  11846: 4. filename of file for which action is being requested
                   11847: 5. filesize (kB) of file
                   11848: 6. action being taken: copy or upload.
1.1237    raeburn  11849: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135    raeburn  11850: 
                   11851: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142    raeburn  11852:          otherwise return null.
                   11853: 
                   11854: =back
1.1135    raeburn  11855: 
                   11856: =cut
                   11857: 
1.1136    raeburn  11858: sub excess_filesize_warning {
1.1165    raeburn  11859:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136    raeburn  11860:     my $current_disk_usage = 0;
1.1165    raeburn  11861:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136    raeburn  11862:     if ($context eq 'author') {
                   11863:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   11864:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   11865:     } else {
                   11866:         foreach my $subdir ('docs','supplemental') {
                   11867:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   11868:         }
                   11869:     }
1.1135    raeburn  11870:     $disk_quota = int($disk_quota * 1000);
                   11871:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179    bisitz   11872:         return '<p class="LC_warning">'.
1.1135    raeburn  11873:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179    bisitz   11874:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   11875:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135    raeburn  11876:                             $disk_quota,$current_disk_usage).
                   11877:                '</p>';
                   11878:     }
                   11879:     return;
                   11880: }
                   11881: 
                   11882: ###############################################
                   11883: 
                   11884: 
1.1136    raeburn  11885: 
                   11886: 
1.384     raeburn  11887: sub get_secgrprole_info {
                   11888:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   11889:     my %sections_count = &get_sections($cdom,$cnum);
                   11890:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   11891:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   11892:     my @groups = sort(keys(%curr_groups));
                   11893:     my $allroles = [];
                   11894:     my $rolehash;
                   11895:     my $accesshash = {
                   11896:                      active => 'Currently has access',
                   11897:                      future => 'Will have future access',
                   11898:                      previous => 'Previously had access',
                   11899:                   };
                   11900:     if ($needroles) {
                   11901:         $rolehash = {'all' => 'all'};
1.385     albertel 11902:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   11903: 	if (&Apache::lonnet::error(%user_roles)) {
                   11904: 	    undef(%user_roles);
                   11905: 	}
                   11906:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  11907:             my ($role)=split(/\:/,$item,2);
                   11908:             if ($role eq 'cr') { next; }
                   11909:             if ($role =~ /^cr/) {
                   11910:                 $$rolehash{$role} = (split('/',$role))[3];
                   11911:             } else {
                   11912:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   11913:             }
                   11914:         }
                   11915:         foreach my $key (sort(keys(%{$rolehash}))) {
                   11916:             push(@{$allroles},$key);
                   11917:         }
                   11918:         push (@{$allroles},'st');
                   11919:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   11920:     }
                   11921:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   11922: }
                   11923: 
1.555     raeburn  11924: sub user_picker {
1.1279    raeburn  11925:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  11926:     my $currdom = $dom;
1.1253    raeburn  11927:     my @alldoms = &Apache::lonnet::all_domains();
                   11928:     if (@alldoms == 1) {
                   11929:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   11930:                                                ['directorysrch'],$alldoms[0]);
                   11931:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   11932:         my $showdom = $domdesc;
                   11933:         if ($showdom eq '') {
                   11934:             $showdom = $dom;
                   11935:         }
                   11936:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   11937:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   11938:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   11939:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   11940:             }
                   11941:         }
                   11942:     }
1.555     raeburn  11943:     my %curr_selected = (
                   11944:                         srchin => 'dom',
1.580     raeburn  11945:                         srchby => 'lastname',
1.555     raeburn  11946:                       );
                   11947:     my $srchterm;
1.625     raeburn  11948:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  11949:         if ($srch->{'srchby'} ne '') {
                   11950:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   11951:         }
                   11952:         if ($srch->{'srchin'} ne '') {
                   11953:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   11954:         }
                   11955:         if ($srch->{'srchtype'} ne '') {
                   11956:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   11957:         }
                   11958:         if ($srch->{'srchdomain'} ne '') {
                   11959:             $currdom = $srch->{'srchdomain'};
                   11960:         }
                   11961:         $srchterm = $srch->{'srchterm'};
                   11962:     }
1.1222    damieng  11963:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  11964:                     'usr'       => 'Search criteria',
1.563     raeburn  11965:                     'doma'      => 'Domain/institution to search',
1.558     albertel 11966:                     'uname'     => 'username',
                   11967:                     'lastname'  => 'last name',
1.555     raeburn  11968:                     'lastfirst' => 'last name, first name',
1.558     albertel 11969:                     'crs'       => 'in this course',
1.576     raeburn  11970:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 11971:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  11972:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 11973:                     'exact'     => 'is',
                   11974:                     'contains'  => 'contains',
1.569     raeburn  11975:                     'begins'    => 'begins with',
1.1222    damieng  11976:                                        );
                   11977:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  11978:                     'youm'      => "You must include some text to search for.",
                   11979:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   11980:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   11981:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   11982:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   11983:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   11984:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   11985:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  11986:                                        );
1.1222    damieng  11987:     &html_escape(\%html_lt);
                   11988:     &js_escape(\%js_lt);
1.1255    raeburn  11989:     my $domform;
1.1277    raeburn  11990:     my $allow_blank = 1;
1.1255    raeburn  11991:     if ($fixeddom) {
1.1277    raeburn  11992:         $allow_blank = 0;
                   11993:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255    raeburn  11994:     } else {
1.1287    raeburn  11995:         my $defdom = $env{'request.role.domain'};
1.1288    raeburn  11996:         my ($trusted,$untrusted);
1.1287    raeburn  11997:         if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288    raeburn  11998:             ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287    raeburn  11999:         } elsif ($context eq 'author') {
1.1288    raeburn  12000:             ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287    raeburn  12001:         } elsif ($context eq 'domain') {
1.1288    raeburn  12002:             ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287    raeburn  12003:         }
1.1288    raeburn  12004:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255    raeburn  12005:     }
1.563     raeburn  12006:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  12007: 
                   12008:     my @srchins = ('crs','dom','alc','instd');
                   12009: 
                   12010:     foreach my $option (@srchins) {
                   12011:         # FIXME 'alc' option unavailable until 
                   12012:         #       loncreateuser::print_user_query_page()
                   12013:         #       has been completed.
                   12014:         next if ($option eq 'alc');
1.880     raeburn  12015:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  12016:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279    raeburn  12017:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  12018:         if ($curr_selected{'srchin'} eq $option) {
                   12019:             $srchinsel .= ' 
1.1222    damieng  12020:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  12021:         } else {
                   12022:             $srchinsel .= '
1.1222    damieng  12023:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  12024:         }
1.555     raeburn  12025:     }
1.563     raeburn  12026:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  12027: 
                   12028:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  12029:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  12030:         if ($curr_selected{'srchby'} eq $option) {
                   12031:             $srchbysel .= '
1.1222    damieng  12032:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  12033:         } else {
                   12034:             $srchbysel .= '
1.1222    damieng  12035:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  12036:          }
                   12037:     }
                   12038:     $srchbysel .= "\n  </select>\n";
                   12039: 
                   12040:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  12041:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  12042:         if ($curr_selected{'srchtype'} eq $option) {
                   12043:             $srchtypesel .= '
1.1222    damieng  12044:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  12045:         } else {
                   12046:             $srchtypesel .= '
1.1222    damieng  12047:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  12048:         }
                   12049:     }
                   12050:     $srchtypesel .= "\n  </select>\n";
                   12051: 
1.558     albertel 12052:     my ($newuserscript,$new_user_create);
1.994     raeburn  12053:     my $context_dom = $env{'request.role.domain'};
                   12054:     if ($context eq 'requestcrs') {
                   12055:         if ($env{'form.coursedom'} ne '') { 
                   12056:             $context_dom = $env{'form.coursedom'};
                   12057:         }
                   12058:     }
1.556     raeburn  12059:     if ($forcenewuser) {
1.576     raeburn  12060:         if (ref($srch) eq 'HASH') {
1.994     raeburn  12061:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  12062:                 if ($cancreate) {
                   12063:                     $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>';
                   12064:                 } else {
1.799     bisitz   12065:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  12066:                     my %usertypetext = (
                   12067:                         official   => 'institutional',
                   12068:                         unofficial => 'non-institutional',
                   12069:                     );
1.799     bisitz   12070:                     $new_user_create = '<p class="LC_warning">'
                   12071:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   12072:                                       .' '
                   12073:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   12074:                                           ,'<a href="'.$helplink.'">','</a>')
                   12075:                                       .'</p><br />';
1.627     raeburn  12076:                 }
1.576     raeburn  12077:             }
                   12078:         }
                   12079: 
1.556     raeburn  12080:         $newuserscript = <<"ENDSCRIPT";
                   12081: 
1.570     raeburn  12082: function setSearch(createnew,callingForm) {
1.556     raeburn  12083:     if (createnew == 1) {
1.570     raeburn  12084:         for (var i=0; i<callingForm.srchby.length; i++) {
                   12085:             if (callingForm.srchby.options[i].value == 'uname') {
                   12086:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  12087:             }
                   12088:         }
1.570     raeburn  12089:         for (var i=0; i<callingForm.srchin.length; i++) {
                   12090:             if ( callingForm.srchin.options[i].value == 'dom') {
                   12091: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  12092:             }
                   12093:         }
1.570     raeburn  12094:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   12095:             if (callingForm.srchtype.options[i].value == 'exact') {
                   12096:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  12097:             }
                   12098:         }
1.570     raeburn  12099:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  12100:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  12101:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  12102:             }
                   12103:         }
                   12104:     }
                   12105: }
                   12106: ENDSCRIPT
1.558     albertel 12107: 
1.556     raeburn  12108:     }
                   12109: 
1.555     raeburn  12110:     my $output = <<"END_BLOCK";
1.556     raeburn  12111: <script type="text/javascript">
1.824     bisitz   12112: // <![CDATA[
1.570     raeburn  12113: function validateEntry(callingForm) {
1.558     albertel 12114: 
1.556     raeburn  12115:     var checkok = 1;
1.558     albertel 12116:     var srchin;
1.570     raeburn  12117:     for (var i=0; i<callingForm.srchin.length; i++) {
                   12118: 	if ( callingForm.srchin[i].checked ) {
                   12119: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 12120: 	}
                   12121:     }
                   12122: 
1.570     raeburn  12123:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   12124:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   12125:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   12126:     var srchterm =  callingForm.srchterm.value;
                   12127:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  12128:     var msg = "";
                   12129: 
                   12130:     if (srchterm == "") {
                   12131:         checkok = 0;
1.1222    damieng  12132:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  12133:     }
                   12134: 
1.569     raeburn  12135:     if (srchtype== 'begins') {
                   12136:         if (srchterm.length < 2) {
                   12137:             checkok = 0;
1.1222    damieng  12138:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  12139:         }
                   12140:     }
                   12141: 
1.556     raeburn  12142:     if (srchtype== 'contains') {
                   12143:         if (srchterm.length < 3) {
                   12144:             checkok = 0;
1.1222    damieng  12145:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  12146:         }
                   12147:     }
                   12148:     if (srchin == 'instd') {
                   12149:         if (srchdomain == '') {
                   12150:             checkok = 0;
1.1222    damieng  12151:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  12152:         }
                   12153:     }
                   12154:     if (srchin == 'dom') {
                   12155:         if (srchdomain == '') {
                   12156:             checkok = 0;
1.1222    damieng  12157:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  12158:         }
                   12159:     }
                   12160:     if (srchby == 'lastfirst') {
                   12161:         if (srchterm.indexOf(",") == -1) {
                   12162:             checkok = 0;
1.1222    damieng  12163:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  12164:         }
                   12165:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   12166:             checkok = 0;
1.1222    damieng  12167:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  12168:         }
                   12169:     }
                   12170:     if (checkok == 0) {
1.1222    damieng  12171:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  12172:         return;
                   12173:     }
                   12174:     if (checkok == 1) {
1.570     raeburn  12175:         callingForm.submit();
1.556     raeburn  12176:     }
                   12177: }
                   12178: 
                   12179: $newuserscript
                   12180: 
1.824     bisitz   12181: // ]]>
1.556     raeburn  12182: </script>
1.558     albertel 12183: 
                   12184: $new_user_create
                   12185: 
1.555     raeburn  12186: END_BLOCK
1.558     albertel 12187: 
1.876     raeburn  12188:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222    damieng  12189:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  12190:                $domform.
                   12191:                &Apache::lonhtmlcommon::row_closure().
1.1222    damieng  12192:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  12193:                $srchbysel.
                   12194:                $srchtypesel. 
                   12195:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   12196:                $srchinsel.
                   12197:                &Apache::lonhtmlcommon::row_closure(1). 
                   12198:                &Apache::lonhtmlcommon::end_pick_box().
                   12199:                '<br />';
1.1253    raeburn  12200:     return ($output,1);
1.555     raeburn  12201: }
                   12202: 
1.612     raeburn  12203: sub user_rule_check {
1.615     raeburn  12204:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226    raeburn  12205:     my ($response,%inst_response);
1.612     raeburn  12206:     if (ref($usershash) eq 'HASH') {
1.1226    raeburn  12207:         if (keys(%{$usershash}) > 1) {
                   12208:             my (%by_username,%by_id,%userdoms);
                   12209:             my $checkid; 
                   12210:             if (ref($checks) eq 'HASH') {
                   12211:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   12212:                     $checkid = 1;
                   12213:                 }
                   12214:             }
                   12215:             foreach my $user (keys(%{$usershash})) {
                   12216:                 my ($uname,$udom) = split(/:/,$user);
                   12217:                 if ($checkid) {
                   12218:                     if (ref($usershash->{$user}) eq 'HASH') {
                   12219:                         if ($usershash->{$user}->{'id'} ne '') {
1.1227    raeburn  12220:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname; 
1.1226    raeburn  12221:                             $userdoms{$udom} = 1;
1.1227    raeburn  12222:                             if (ref($inst_results) eq 'HASH') {
                   12223:                                 $inst_results->{$uname.':'.$udom} = {};
                   12224:                             }
1.1226    raeburn  12225:                         }
                   12226:                     }
                   12227:                 } else {
                   12228:                     $by_username{$udom}{$uname} = 1;
                   12229:                     $userdoms{$udom} = 1;
1.1227    raeburn  12230:                     if (ref($inst_results) eq 'HASH') {
                   12231:                         $inst_results->{$uname.':'.$udom} = {};
                   12232:                     }
1.1226    raeburn  12233:                 }
                   12234:             }
                   12235:             foreach my $udom (keys(%userdoms)) {
                   12236:                 if (!$got_rules->{$udom}) {
                   12237:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   12238:                                                              ['usercreation'],$udom);
                   12239:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   12240:                         foreach my $item ('username','id') {
                   12241:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227    raeburn  12242:                                 $$curr_rules{$udom}{$item} =
                   12243:                                     $domconfig{'usercreation'}{$item.'_rule'};
1.1226    raeburn  12244:                             }
                   12245:                         }
                   12246:                     }
                   12247:                     $got_rules->{$udom} = 1;
                   12248:                 }
1.612     raeburn  12249:             }
1.1226    raeburn  12250:             if ($checkid) {
                   12251:                 foreach my $udom (keys(%by_id)) {
                   12252:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   12253:                     if ($outcome eq 'ok') {
1.1227    raeburn  12254:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   12255:                             my $uname = $by_id{$udom}{$id};
                   12256:                             $inst_response{$uname.':'.$udom} = $outcome;
                   12257:                         }
1.1226    raeburn  12258:                         if (ref($results) eq 'HASH') {
                   12259:                             foreach my $uname (keys(%{$results})) {
1.1227    raeburn  12260:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   12261:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   12262:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   12263:                                 }
1.1226    raeburn  12264:                             }
                   12265:                         }
                   12266:                     }
1.612     raeburn  12267:                 }
1.615     raeburn  12268:             } else {
1.1226    raeburn  12269:                 foreach my $udom (keys(%by_username)) {
                   12270:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   12271:                     if ($outcome eq 'ok') {
1.1227    raeburn  12272:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   12273:                             $inst_response{$uname.':'.$udom} = $outcome;
                   12274:                         }
1.1226    raeburn  12275:                         if (ref($results) eq 'HASH') {
                   12276:                             foreach my $uname (keys(%{$results})) {
                   12277:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   12278:                             }
                   12279:                         }
                   12280:                     }
                   12281:                 }
1.612     raeburn  12282:             }
1.1226    raeburn  12283:         } elsif (keys(%{$usershash}) == 1) {
                   12284:             my $user = (keys(%{$usershash}))[0];
                   12285:             my ($uname,$udom) = split(/:/,$user);
                   12286:             if (($udom ne '') && ($uname ne '')) {
                   12287:                 if (ref($usershash->{$user}) eq 'HASH') {
                   12288:                     if (ref($checks) eq 'HASH') {
                   12289:                         if (defined($checks->{'username'})) {
                   12290:                             ($inst_response{$user},%{$inst_results->{$user}}) = 
                   12291:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   12292:                         } elsif (defined($checks->{'id'})) {
                   12293:                             if ($usershash->{$user}->{'id'} ne '') {
                   12294:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   12295:                                     &Apache::lonnet::get_instuser($udom,undef,
                   12296:                                                                   $usershash->{$user}->{'id'});
                   12297:                             } else {
                   12298:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   12299:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   12300:                             }
1.585     raeburn  12301:                         }
1.1226    raeburn  12302:                     } else {
                   12303:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   12304:                             &Apache::lonnet::get_instuser($udom,$uname);
                   12305:                        return;
                   12306:                     }
                   12307:                     if (!$got_rules->{$udom}) {
                   12308:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   12309:                                                                  ['usercreation'],$udom);
                   12310:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   12311:                             foreach my $item ('username','id') {
                   12312:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   12313:                                    $$curr_rules{$udom}{$item} = 
                   12314:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   12315:                                 }
                   12316:                             }
                   12317:                         }
                   12318:                         $got_rules->{$udom} = 1;
1.585     raeburn  12319:                     }
                   12320:                 }
1.1226    raeburn  12321:             } else {
                   12322:                 return;
                   12323:             }
                   12324:         } else {
                   12325:             return;
                   12326:         }
                   12327:         foreach my $user (keys(%{$usershash})) {
                   12328:             my ($uname,$udom) = split(/:/,$user);
                   12329:             next if (($udom eq '') || ($uname eq ''));
                   12330:             my $id;
1.1227    raeburn  12331:             if (ref($inst_results) eq 'HASH') {
                   12332:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   12333:                     $id = $inst_results->{$user}->{'id'};
                   12334:                 }
                   12335:             }
                   12336:             if ($id eq '') { 
                   12337:                 if (ref($usershash->{$user})) {
                   12338:                     $id = $usershash->{$user}->{'id'};
                   12339:                 }
1.585     raeburn  12340:             }
1.612     raeburn  12341:             foreach my $item (keys(%{$checks})) {
                   12342:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   12343:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   12344:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226    raeburn  12345:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   12346:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  12347:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   12348:                                 if ($rule_check{$rule}) {
                   12349:                                     $$rulematch{$user}{$item} = $rule;
1.1226    raeburn  12350:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  12351:                                         if (ref($inst_results) eq 'HASH') {
                   12352:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   12353:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   12354:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1227    raeburn  12355:                                                 } elsif ($item eq 'id') {
                   12356:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   12357:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   12358:                                                     }
1.615     raeburn  12359:                                                 }
1.612     raeburn  12360:                                             }
                   12361:                                         }
1.615     raeburn  12362:                                     }
                   12363:                                     last;
1.585     raeburn  12364:                                 }
                   12365:                             }
                   12366:                         }
                   12367:                     }
                   12368:                 }
                   12369:             }
                   12370:         }
                   12371:     }
1.612     raeburn  12372:     return;
                   12373: }
                   12374: 
                   12375: sub user_rule_formats {
                   12376:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   12377:     my %text = ( 
                   12378:                  'username' => 'Usernames',
                   12379:                  'id'       => 'IDs',
                   12380:                );
                   12381:     my $output;
                   12382:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   12383:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   12384:         if (@{$ruleorder} > 0) {
1.1102    raeburn  12385:             $output = '<br />'.
                   12386:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   12387:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   12388:                       ' <ul>';
1.612     raeburn  12389:             foreach my $rule (@{$ruleorder}) {
                   12390:                 if (ref($curr_rules) eq 'ARRAY') {
                   12391:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   12392:                         if (ref($rules->{$rule}) eq 'HASH') {
                   12393:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   12394:                                         $rules->{$rule}{'desc'}.'</li>';
                   12395:                         }
                   12396:                     }
                   12397:                 }
                   12398:             }
                   12399:             $output .= '</ul>';
                   12400:         }
                   12401:     }
                   12402:     return $output;
                   12403: }
                   12404: 
                   12405: sub instrule_disallow_msg {
1.615     raeburn  12406:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  12407:     my $response;
                   12408:     my %text = (
                   12409:                   item   => 'username',
                   12410:                   items  => 'usernames',
                   12411:                   match  => 'matches',
                   12412:                   do     => 'does',
                   12413:                   action => 'a username',
                   12414:                   one    => 'one',
                   12415:                );
                   12416:     if ($count > 1) {
                   12417:         $text{'item'} = 'usernames';
                   12418:         $text{'match'} ='match';
                   12419:         $text{'do'} = 'do';
                   12420:         $text{'action'} = 'usernames',
                   12421:         $text{'one'} = 'ones';
                   12422:     }
                   12423:     if ($checkitem eq 'id') {
                   12424:         $text{'items'} = 'IDs';
                   12425:         $text{'item'} = 'ID';
                   12426:         $text{'action'} = 'an ID';
1.615     raeburn  12427:         if ($count > 1) {
                   12428:             $text{'item'} = 'IDs';
                   12429:             $text{'action'} = 'IDs';
                   12430:         }
1.612     raeburn  12431:     }
1.674     bisitz   12432:     $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  12433:     if ($mode eq 'upload') {
                   12434:         if ($checkitem eq 'username') {
                   12435:             $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'}.");
                   12436:         } elsif ($checkitem eq 'id') {
1.674     bisitz   12437:             $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  12438:         }
1.669     raeburn  12439:     } elsif ($mode eq 'selfcreate') {
                   12440:         if ($checkitem eq 'id') {
                   12441:             $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.");
                   12442:         }
1.615     raeburn  12443:     } else {
                   12444:         if ($checkitem eq 'username') {
                   12445:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   12446:         } elsif ($checkitem eq 'id') {
                   12447:             $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.");
                   12448:         }
1.612     raeburn  12449:     }
                   12450:     return $response;
1.585     raeburn  12451: }
                   12452: 
1.624     raeburn  12453: sub personal_data_fieldtitles {
                   12454:     my %fieldtitles = &Apache::lonlocal::texthash (
                   12455:                         id => 'Student/Employee ID',
                   12456:                         permanentemail => 'E-mail address',
                   12457:                         lastname => 'Last Name',
                   12458:                         firstname => 'First Name',
                   12459:                         middlename => 'Middle Name',
                   12460:                         generation => 'Generation',
                   12461:                         gen => 'Generation',
1.765     raeburn  12462:                         inststatus => 'Affiliation',
1.624     raeburn  12463:                    );
                   12464:     return %fieldtitles;
                   12465: }
                   12466: 
1.642     raeburn  12467: sub sorted_inst_types {
                   12468:     my ($dom) = @_;
1.1185    raeburn  12469:     my ($usertypes,$order);
                   12470:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   12471:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   12472:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   12473:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   12474:     } else {
                   12475:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   12476:     }
1.642     raeburn  12477:     my $othertitle = &mt('All users');
                   12478:     if ($env{'request.course.id'}) {
1.668     raeburn  12479:         $othertitle  = &mt('Any users');
1.642     raeburn  12480:     }
                   12481:     my @types;
                   12482:     if (ref($order) eq 'ARRAY') {
                   12483:         @types = @{$order};
                   12484:     }
                   12485:     if (@types == 0) {
                   12486:         if (ref($usertypes) eq 'HASH') {
                   12487:             @types = sort(keys(%{$usertypes}));
                   12488:         }
                   12489:     }
                   12490:     if (keys(%{$usertypes}) > 0) {
                   12491:         $othertitle = &mt('Other users');
                   12492:     }
                   12493:     return ($othertitle,$usertypes,\@types);
                   12494: }
                   12495: 
1.645     raeburn  12496: sub get_institutional_codes {
1.1361    raeburn  12497:     my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645     raeburn  12498: # Get complete list of course sections to update
                   12499:     my @currsections = ();
                   12500:     my @currxlists = ();
1.1361    raeburn  12501:     my (%unclutteredsec,%unclutteredlcsec);
1.645     raeburn  12502:     my $coursecode = $$settings{'internal.coursecode'};
1.1361    raeburn  12503:     my $crskey = $crs.':'.$coursecode;
                   12504:     @{$unclutteredsec{$crskey}} = ();
                   12505:     @{$unclutteredlcsec{$crskey}} = ();
1.645     raeburn  12506: 
                   12507:     if ($$settings{'internal.sectionnums'} ne '') {
                   12508:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   12509:     }
                   12510: 
                   12511:     if ($$settings{'internal.crosslistings'} ne '') {
                   12512:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   12513:     }
                   12514: 
                   12515:     if (@currxlists > 0) {
1.1361    raeburn  12516:         foreach my $xl (@currxlists) {
                   12517:             if ($xl =~ /^([^:]+):(\w*)$/) {
1.645     raeburn  12518:                 unless (grep/^$1$/,@{$allcourses}) {
1.1263    raeburn  12519:                     push(@{$allcourses},$1);
1.645     raeburn  12520:                     $$LC_code{$1} = $2;
                   12521:                 }
                   12522:             }
                   12523:         }
                   12524:     }
1.1361    raeburn  12525: 
1.645     raeburn  12526:     if (@currsections > 0) {
1.1361    raeburn  12527:         foreach my $sec (@currsections) {
                   12528:             if ($sec =~ m/^(\w+):(\w*)$/ ) {
                   12529:                 my $instsec = $1;
1.645     raeburn  12530:                 my $lc_sec = $2;
1.1361    raeburn  12531:                 unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
                   12532:                     push(@{$unclutteredsec{$crskey}},$instsec);
                   12533:                     push(@{$unclutteredlcsec{$crskey}},$lc_sec);
                   12534:                 }
                   12535:             }
                   12536:         }
                   12537:     }
                   12538: 
                   12539:     if (@{$unclutteredsec{$crskey}} > 0) {
                   12540:         my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
                   12541:         if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
                   12542:             for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
                   12543:                 my $sec = $coursecode.$formattedsec{$crskey}[$i];
                   12544:                 unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263    raeburn  12545:                     push(@{$allcourses},$sec);
1.1361    raeburn  12546:                     $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645     raeburn  12547:                 }
                   12548:             }
                   12549:         }
                   12550:     }
                   12551:     return;
                   12552: }
                   12553: 
1.971     raeburn  12554: sub get_standard_codeitems {
                   12555:     return ('Year','Semester','Department','Number','Section');
                   12556: }
                   12557: 
1.112     bowersj2 12558: =pod
                   12559: 
1.780     raeburn  12560: =head1 Slot Helpers
                   12561: 
                   12562: =over 4
                   12563: 
                   12564: =item * sorted_slots()
                   12565: 
1.1040    raeburn  12566: Sorts an array of slot names in order of an optional sort key,
                   12567: default sort is by slot start time (earliest first). 
1.780     raeburn  12568: 
                   12569: Inputs:
                   12570: 
                   12571: =over 4
                   12572: 
                   12573: slotsarr  - Reference to array of unsorted slot names.
                   12574: 
                   12575: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   12576: 
1.1040    raeburn  12577: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   12578: 
1.549     albertel 12579: =back
                   12580: 
1.780     raeburn  12581: Returns:
                   12582: 
                   12583: =over 4
                   12584: 
1.1040    raeburn  12585: sorted   - An array of slot names sorted by a specified sort key 
                   12586:            (default sort key is start time of the slot).
1.780     raeburn  12587: 
                   12588: =back
                   12589: 
                   12590: =cut
                   12591: 
                   12592: 
                   12593: sub sorted_slots {
1.1040    raeburn  12594:     my ($slotsarr,$slots,$sortkey) = @_;
                   12595:     if ($sortkey eq '') {
                   12596:         $sortkey = 'starttime';
                   12597:     }
1.780     raeburn  12598:     my @sorted;
                   12599:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   12600:         @sorted =
                   12601:             sort {
                   12602:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  12603:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  12604:                      }
                   12605:                      if (ref($slots->{$a})) { return -1;}
                   12606:                      if (ref($slots->{$b})) { return 1;}
                   12607:                      return 0;
                   12608:                  } @{$slotsarr};
                   12609:     }
                   12610:     return @sorted;
                   12611: }
                   12612: 
1.1040    raeburn  12613: =pod
                   12614: 
                   12615: =item * get_future_slots()
                   12616: 
                   12617: Inputs:
                   12618: 
                   12619: =over 4
                   12620: 
                   12621: cnum - course number
                   12622: 
                   12623: cdom - course domain
                   12624: 
                   12625: now - current UNIX time
                   12626: 
                   12627: symb - optional symb
                   12628: 
                   12629: =back
                   12630: 
                   12631: Returns:
                   12632: 
                   12633: =over 4
                   12634: 
                   12635: sorted_reservable - ref to array of student_schedulable slots currently 
                   12636:                     reservable, ordered by end date of reservation period.
                   12637: 
                   12638: reservable_now - ref to hash of student_schedulable slots currently
                   12639:                  reservable.
                   12640: 
                   12641:     Keys in inner hash are:
                   12642:     (a) symb: either blank or symb to which slot use is restricted.
1.1250    raeburn  12643:     (b) endreserve: end date of reservation period.
                   12644:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   12645:         selected.
1.1040    raeburn  12646: 
                   12647: sorted_future - ref to array of student_schedulable slots reservable in
                   12648:                 the future, ordered by start date of reservation period.
                   12649: 
                   12650: future_reservable - ref to hash of student_schedulable slots reservable
                   12651:                     in the future.
                   12652: 
                   12653:     Keys in inner hash are:
                   12654:     (a) symb: either blank or symb to which slot use is restricted.
1.1250    raeburn  12655:     (b) startreserve: start date of reservation period.
                   12656:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   12657:         selected.
1.1040    raeburn  12658: 
                   12659: =back
                   12660: 
                   12661: =cut
                   12662: 
                   12663: sub get_future_slots {
                   12664:     my ($cnum,$cdom,$now,$symb) = @_;
1.1229    raeburn  12665:     my $map;
                   12666:     if ($symb) {
                   12667:         ($map) = &Apache::lonnet::decode_symb($symb);
                   12668:     }
1.1040    raeburn  12669:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   12670:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   12671:     foreach my $slot (keys(%slots)) {
                   12672:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   12673:         if ($symb) {
1.1229    raeburn  12674:             if ($slots{$slot}->{'symb'} ne '') {
                   12675:                 my $canuse;
                   12676:                 my %oksymbs;
                   12677:                 my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
                   12678:                 map { $oksymbs{$_} = 1; } @slotsymbs;
                   12679:                 if ($oksymbs{$symb}) {
                   12680:                     $canuse = 1;
                   12681:                 } else {
                   12682:                     foreach my $item (@slotsymbs) {
                   12683:                         if ($item =~ /\.(page|sequence)$/) {
                   12684:                             (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
                   12685:                             if (($map ne '') && ($map eq $sloturl)) {
                   12686:                                 $canuse = 1;
                   12687:                                 last;
                   12688:                             }
                   12689:                         }
                   12690:                     }
                   12691:                 }
                   12692:                 next unless ($canuse);
                   12693:             }
1.1040    raeburn  12694:         }
                   12695:         if (($slots{$slot}->{'starttime'} > $now) &&
                   12696:             ($slots{$slot}->{'endtime'} > $now)) {
                   12697:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   12698:                 my $userallowed = 0;
                   12699:                 if ($slots{$slot}->{'allowedsections'}) {
                   12700:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   12701:                     if (!defined($env{'request.role.sec'})
                   12702:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   12703:                         $userallowed=1;
                   12704:                     } else {
                   12705:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   12706:                             $userallowed=1;
                   12707:                         }
                   12708:                     }
                   12709:                     unless ($userallowed) {
                   12710:                         if (defined($env{'request.course.groups'})) {
                   12711:                             my @groups = split(/:/,$env{'request.course.groups'});
                   12712:                             foreach my $group (@groups) {
                   12713:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   12714:                                     $userallowed=1;
                   12715:                                     last;
                   12716:                                 }
                   12717:                             }
                   12718:                         }
                   12719:                     }
                   12720:                 }
                   12721:                 if ($slots{$slot}->{'allowedusers'}) {
                   12722:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   12723:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   12724:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   12725:                         $userallowed = 1;
                   12726:                     }
                   12727:                 }
                   12728:                 next unless($userallowed);
                   12729:             }
                   12730:             my $startreserve = $slots{$slot}->{'startreserve'};
                   12731:             my $endreserve = $slots{$slot}->{'endreserve'};
                   12732:             my $symb = $slots{$slot}->{'symb'};
1.1250    raeburn  12733:             my $uniqueperiod;
                   12734:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   12735:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   12736:             }
1.1040    raeburn  12737:             if (($startreserve < $now) &&
                   12738:                 (!$endreserve || $endreserve > $now)) {
                   12739:                 my $lastres = $endreserve;
                   12740:                 if (!$lastres) {
                   12741:                     $lastres = $slots{$slot}->{'starttime'};
                   12742:                 }
                   12743:                 $reservable_now{$slot} = {
                   12744:                                            symb       => $symb,
1.1250    raeburn  12745:                                            endreserve => $lastres,
                   12746:                                            uniqueperiod => $uniqueperiod,
1.1040    raeburn  12747:                                          };
                   12748:             } elsif (($startreserve > $now) &&
                   12749:                      (!$endreserve || $endreserve > $startreserve)) {
                   12750:                 $future_reservable{$slot} = {
                   12751:                                               symb         => $symb,
1.1250    raeburn  12752:                                               startreserve => $startreserve,
                   12753:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  12754:                                             };
                   12755:             }
                   12756:         }
                   12757:     }
                   12758:     my @unsorted_reservable = keys(%reservable_now);
                   12759:     if (@unsorted_reservable > 0) {
                   12760:         @sorted_reservable = 
                   12761:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   12762:     }
                   12763:     my @unsorted_future = keys(%future_reservable);
                   12764:     if (@unsorted_future > 0) {
                   12765:         @sorted_future =
                   12766:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   12767:     }
                   12768:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   12769: }
1.780     raeburn  12770: 
                   12771: =pod
                   12772: 
1.1057    foxr     12773: =back
                   12774: 
1.549     albertel 12775: =head1 HTTP Helpers
                   12776: 
                   12777: =over 4
                   12778: 
1.648     raeburn  12779: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 12780: 
1.258     albertel 12781: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 12782: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 12783: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 12784: 
                   12785: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   12786: $possible_names is an ref to an array of form element names.  As an example:
                   12787: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 12788: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 12789: 
                   12790: =cut
1.1       albertel 12791: 
1.6       albertel 12792: sub get_unprocessed_cgi {
1.25      albertel 12793:   my ($query,$possible_names)= @_;
1.26      matthew  12794:   # $Apache::lonxml::debug=1;
1.356     albertel 12795:   foreach my $pair (split(/&/,$query)) {
                   12796:     my ($name, $value) = split(/=/,$pair);
1.369     www      12797:     $name = &unescape($name);
1.25      albertel 12798:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   12799:       $value =~ tr/+/ /;
                   12800:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 12801:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 12802:     }
1.16      harris41 12803:   }
1.6       albertel 12804: }
                   12805: 
1.112     bowersj2 12806: =pod
                   12807: 
1.648     raeburn  12808: =item * &cacheheader() 
1.112     bowersj2 12809: 
                   12810: returns cache-controlling header code
                   12811: 
                   12812: =cut
                   12813: 
1.7       albertel 12814: sub cacheheader {
1.258     albertel 12815:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 12816:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   12817:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 12818:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   12819:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 12820:     return $output;
1.7       albertel 12821: }
                   12822: 
1.112     bowersj2 12823: =pod
                   12824: 
1.648     raeburn  12825: =item * &no_cache($r) 
1.112     bowersj2 12826: 
                   12827: specifies header code to not have cache
                   12828: 
                   12829: =cut
                   12830: 
1.9       albertel 12831: sub no_cache {
1.216     albertel 12832:     my ($r) = @_;
                   12833:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 12834: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 12835:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   12836:     $r->no_cache(1);
                   12837:     $r->header_out("Expires" => $date);
                   12838:     $r->header_out("Pragma" => "no-cache");
1.123     www      12839: }
                   12840: 
                   12841: sub content_type {
1.181     albertel 12842:     my ($r,$type,$charset) = @_;
1.299     foxr     12843:     if ($r) {
                   12844: 	#  Note that printout.pl calls this with undef for $r.
                   12845: 	&no_cache($r);
                   12846:     }
1.258     albertel 12847:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 12848:     unless ($charset) {
                   12849: 	$charset=&Apache::lonlocal::current_encoding;
                   12850:     }
                   12851:     if ($charset) { $type.='; charset='.$charset; }
                   12852:     if ($r) {
                   12853: 	$r->content_type($type);
                   12854:     } else {
                   12855: 	print("Content-type: $type\n\n");
                   12856:     }
1.9       albertel 12857: }
1.25      albertel 12858: 
1.112     bowersj2 12859: =pod
                   12860: 
1.648     raeburn  12861: =item * &add_to_env($name,$value) 
1.112     bowersj2 12862: 
1.258     albertel 12863: adds $name to the %env hash with value
1.112     bowersj2 12864: $value, if $name already exists, the entry is converted to an array
                   12865: reference and $value is added to the array.
                   12866: 
                   12867: =cut
                   12868: 
1.25      albertel 12869: sub add_to_env {
                   12870:   my ($name,$value)=@_;
1.258     albertel 12871:   if (defined($env{$name})) {
                   12872:     if (ref($env{$name})) {
1.25      albertel 12873:       #already have multiple values
1.258     albertel 12874:       push(@{ $env{$name} },$value);
1.25      albertel 12875:     } else {
                   12876:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 12877:       my $first=$env{$name};
                   12878:       undef($env{$name});
                   12879:       push(@{ $env{$name} },$first,$value);
1.25      albertel 12880:     }
                   12881:   } else {
1.258     albertel 12882:     $env{$name}=$value;
1.25      albertel 12883:   }
1.31      albertel 12884: }
1.149     albertel 12885: 
                   12886: =pod
                   12887: 
1.648     raeburn  12888: =item * &get_env_multiple($name) 
1.149     albertel 12889: 
1.258     albertel 12890: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 12891: values may be defined and end up as an array ref.
                   12892: 
                   12893: returns an array of values
                   12894: 
                   12895: =cut
                   12896: 
                   12897: sub get_env_multiple {
                   12898:     my ($name) = @_;
                   12899:     my @values;
1.258     albertel 12900:     if (defined($env{$name})) {
1.149     albertel 12901:         # exists is it an array
1.258     albertel 12902:         if (ref($env{$name})) {
                   12903:             @values=@{ $env{$name} };
1.149     albertel 12904:         } else {
1.258     albertel 12905:             $values[0]=$env{$name};
1.149     albertel 12906:         }
                   12907:     }
                   12908:     return(@values);
                   12909: }
                   12910: 
1.1249    damieng  12911: # Looks at given dependencies, and returns something depending on the context.
                   12912: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
                   12913: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
                   12914: # For all other contexts, returns ($output, $counter, $numpathchg).
                   12915: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
                   12916: # $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.
                   12917: # $numpathchg: integer with the number of cleaned up dependency paths.
                   12918: # \%existing: hash reference clean path -> 1 only for existing dependencies.
                   12919: # \%mapping: hash reference clean path -> original path for all dependencies.
                   12920: # @param {string} actionurl - The path to the handler, indicative of the context.
                   12921: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
                   12922: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
                   12923: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
                   12924: # @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)
                   12925: # @return {Array} - array depending on the context (not a reference)
1.660     raeburn  12926: sub ask_for_embedded_content {
1.1249    damieng  12927:     # NOTE: documentation was added afterwards, it could be wrong
1.660     raeburn  12928:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  12929:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085    raeburn  12930:         %currsubfile,%unused,$rem);
1.1071    raeburn  12931:     my $counter = 0;
                   12932:     my $numnew = 0;
1.987     raeburn  12933:     my $numremref = 0;
                   12934:     my $numinvalid = 0;
                   12935:     my $numpathchg = 0;
                   12936:     my $numexisting = 0;
1.1071    raeburn  12937:     my $numunused = 0;
                   12938:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156    raeburn  12939:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  12940:     my $heading = &mt('Upload embedded files');
                   12941:     my $buttontext = &mt('Upload');
                   12942: 
1.1249    damieng  12943:     # fills these variables based on the context:
                   12944:     # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
                   12945:     # $path, $fileloc, $title, $rem, $filename
1.1085    raeburn  12946:     if ($env{'request.course.id'}) {
1.1123    raeburn  12947:         if ($actionurl eq '/adm/dependencies') {
                   12948:             $navmap = Apache::lonnavmaps::navmap->new();
                   12949:         }
                   12950:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   12951:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085    raeburn  12952:     }
1.1123    raeburn  12953:     if (($actionurl eq '/adm/portfolio') || 
                   12954:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  12955:         my $current_path='/';
                   12956:         if ($env{'form.currentpath'}) {
                   12957:             $current_path = $env{'form.currentpath'};
                   12958:         }
                   12959:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123    raeburn  12960:             $udom = $cdom;
                   12961:             $uname = $cnum;
1.984     raeburn  12962:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   12963:         } else {
                   12964:             $udom = $env{'user.domain'};
                   12965:             $uname = $env{'user.name'};
                   12966:             $url = '/userfiles/portfolio';
                   12967:         }
1.987     raeburn  12968:         $toplevel = $url.'/';
1.984     raeburn  12969:         $url .= $current_path;
                   12970:         $getpropath = 1;
1.987     raeburn  12971:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   12972:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      12973:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  12974:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  12975:         $toplevel = $url;
1.984     raeburn  12976:         if ($rest ne '') {
1.987     raeburn  12977:             $url .= $rest;
                   12978:         }
                   12979:     } elsif ($actionurl eq '/adm/coursedocs') {
                   12980:         if (ref($args) eq 'HASH') {
1.1071    raeburn  12981:             $url = $args->{'docs_url'};
                   12982:             $toplevel = $url;
1.1084    raeburn  12983:             if ($args->{'context'} eq 'paste') {
                   12984:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   12985:                 ($path) = 
                   12986:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   12987:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   12988:                 $fileloc =~ s{^/}{};
                   12989:             }
1.1071    raeburn  12990:         }
1.1084    raeburn  12991:     } elsif ($actionurl eq '/adm/dependencies')  {
1.1071    raeburn  12992:         if ($env{'request.course.id'} ne '') {
                   12993:             if (ref($args) eq 'HASH') {
                   12994:                 $url = $args->{'docs_url'};
                   12995:                 $title = $args->{'docs_title'};
1.1126    raeburn  12996:                 $toplevel = $url; 
                   12997:                 unless ($toplevel =~ m{^/}) {
                   12998:                     $toplevel = "/$url";
                   12999:                 }
1.1085    raeburn  13000:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126    raeburn  13001:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   13002:                     $path = $1;
                   13003:                 } else {
                   13004:                     ($path) =
                   13005:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   13006:                 }
1.1195    raeburn  13007:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   13008:                     $fileloc = $toplevel;
                   13009:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   13010:                     my ($udom,$uname,$fname) =
                   13011:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   13012:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   13013:                 } else {
                   13014:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   13015:                 }
1.1071    raeburn  13016:                 $fileloc =~ s{^/}{};
                   13017:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   13018:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   13019:             }
1.987     raeburn  13020:         }
1.1123    raeburn  13021:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   13022:         $udom = $cdom;
                   13023:         $uname = $cnum;
                   13024:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   13025:         $toplevel = $url;
                   13026:         $path = $url;
                   13027:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   13028:         $fileloc =~ s{^/}{};
1.987     raeburn  13029:     }
1.1249    damieng  13030:     
                   13031:     # parses the dependency paths to get some info
                   13032:     # fills $newfiles, $mapping, $subdependencies, $dependencies
                   13033:     # $newfiles: hash URL -> 1 for new files or external URLs
                   13034:     # (will be completed later)
                   13035:     # $mapping:
                   13036:     #   for external URLs: external URL -> external URL
                   13037:     #   for relative paths: clean path -> original path
                   13038:     # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
                   13039:     # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126    raeburn  13040:     foreach my $file (keys(%{$allfiles})) {
                   13041:         my $embed_file;
                   13042:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   13043:             $embed_file = $1;
                   13044:         } else {
                   13045:             $embed_file = $file;
                   13046:         }
1.1158    raeburn  13047:         my ($absolutepath,$cleaned_file);
                   13048:         if ($embed_file =~ m{^\w+://}) {
                   13049:             $cleaned_file = $embed_file;
1.1147    raeburn  13050:             $newfiles{$cleaned_file} = 1;
                   13051:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  13052:         } else {
1.1158    raeburn  13053:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  13054:             if ($embed_file =~ m{^/}) {
                   13055:                 $absolutepath = $embed_file;
                   13056:             }
1.1147    raeburn  13057:             if ($cleaned_file =~ m{/}) {
                   13058:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  13059:                 $path = &check_for_traversal($path,$url,$toplevel);
                   13060:                 my $item = $fname;
                   13061:                 if ($path ne '') {
                   13062:                     $item = $path.'/'.$fname;
                   13063:                     $subdependencies{$path}{$fname} = 1;
                   13064:                 } else {
                   13065:                     $dependencies{$item} = 1;
                   13066:                 }
                   13067:                 if ($absolutepath) {
                   13068:                     $mapping{$item} = $absolutepath;
                   13069:                 } else {
                   13070:                     $mapping{$item} = $embed_file;
                   13071:                 }
                   13072:             } else {
                   13073:                 $dependencies{$embed_file} = 1;
                   13074:                 if ($absolutepath) {
1.1147    raeburn  13075:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  13076:                 } else {
1.1147    raeburn  13077:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  13078:                 }
                   13079:             }
1.984     raeburn  13080:         }
                   13081:     }
1.1249    damieng  13082:     
                   13083:     # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
                   13084:     # and lists
                   13085:     # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
                   13086:     # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
                   13087:     # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
                   13088:     #                                    the path had to be cleaned up
                   13089:     # $existing: hash clean path -> 1 if the file exists
                   13090:     # $numexisting: number of keys in $existing
                   13091:     # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
                   13092:     # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
                   13093:     #                                      dependency subdirectories that are
                   13094:     #                                      not listed as dependencies, with some exceptions using $rem
1.1071    raeburn  13095:     my $dirptr = 16384;
1.984     raeburn  13096:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  13097:         $currsubfile{$path} = {};
1.1123    raeburn  13098:         if (($actionurl eq '/adm/portfolio') || 
                   13099:             ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  13100:             my ($sublistref,$listerror) =
                   13101:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   13102:             if (ref($sublistref) eq 'ARRAY') {
                   13103:                 foreach my $line (@{$sublistref}) {
                   13104:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  13105:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  13106:                 }
1.984     raeburn  13107:             }
1.987     raeburn  13108:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  13109:             if (opendir(my $dir,$url.'/'.$path)) {
                   13110:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  13111:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   13112:             }
1.1084    raeburn  13113:         } elsif (($actionurl eq '/adm/dependencies') ||
                   13114:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123    raeburn  13115:                   ($args->{'context'} eq 'paste')) ||
                   13116:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  13117:             if ($env{'request.course.id'} ne '') {
1.1123    raeburn  13118:                 my $dir;
                   13119:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   13120:                     $dir = $fileloc;
                   13121:                 } else {
                   13122:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   13123:                 }
1.1071    raeburn  13124:                 if ($dir ne '') {
                   13125:                     my ($sublistref,$listerror) =
                   13126:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   13127:                     if (ref($sublistref) eq 'ARRAY') {
                   13128:                         foreach my $line (@{$sublistref}) {
                   13129:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   13130:                                 undef,$mtime)=split(/\&/,$line,12);
                   13131:                             unless (($testdir&$dirptr) ||
                   13132:                                     ($file_name =~ /^\.\.?$/)) {
                   13133:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   13134:                             }
                   13135:                         }
                   13136:                     }
                   13137:                 }
1.984     raeburn  13138:             }
                   13139:         }
                   13140:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  13141:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  13142:                 my $item = $path.'/'.$file;
                   13143:                 unless ($mapping{$item} eq $item) {
                   13144:                     $pathchanges{$item} = 1;
                   13145:                 }
                   13146:                 $existing{$item} = 1;
                   13147:                 $numexisting ++;
                   13148:             } else {
                   13149:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  13150:             }
                   13151:         }
1.1071    raeburn  13152:         if ($actionurl eq '/adm/dependencies') {
                   13153:             foreach my $path (keys(%currsubfile)) {
                   13154:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   13155:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   13156:                          unless ($subdependencies{$path}{$file}) {
1.1085    raeburn  13157:                              next if (($rem ne '') &&
                   13158:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   13159:                                        (ref($navmap) &&
                   13160:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   13161:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   13162:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  13163:                              $unused{$path.'/'.$file} = 1; 
                   13164:                          }
                   13165:                     }
                   13166:                 }
                   13167:             }
                   13168:         }
1.984     raeburn  13169:     }
1.1249    damieng  13170:     
                   13171:     # fills $currfile, hash file name -> 1 or [$size,$mtime]
                   13172:     # for files in $url or $fileloc (target directory) in some contexts
1.987     raeburn  13173:     my %currfile;
1.1123    raeburn  13174:     if (($actionurl eq '/adm/portfolio') ||
                   13175:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  13176:         my ($dirlistref,$listerror) =
                   13177:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   13178:         if (ref($dirlistref) eq 'ARRAY') {
                   13179:             foreach my $line (@{$dirlistref}) {
                   13180:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   13181:                 $currfile{$file_name} = 1;
                   13182:             }
1.984     raeburn  13183:         }
1.987     raeburn  13184:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  13185:         if (opendir(my $dir,$url)) {
1.987     raeburn  13186:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  13187:             map {$currfile{$_} = 1;} @dir_list;
                   13188:         }
1.1084    raeburn  13189:     } elsif (($actionurl eq '/adm/dependencies') ||
                   13190:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123    raeburn  13191:               ($args->{'context'} eq 'paste')) ||
                   13192:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  13193:         if ($env{'request.course.id'} ne '') {
                   13194:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   13195:             if ($dir ne '') {
                   13196:                 my ($dirlistref,$listerror) =
                   13197:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   13198:                 if (ref($dirlistref) eq 'ARRAY') {
                   13199:                     foreach my $line (@{$dirlistref}) {
                   13200:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   13201:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   13202:                         unless (($testdir&$dirptr) ||
                   13203:                                 ($file_name =~ /^\.\.?$/)) {
                   13204:                             $currfile{$file_name} = [$size,$mtime];
                   13205:                         }
                   13206:                     }
                   13207:                 }
                   13208:             }
                   13209:         }
1.984     raeburn  13210:     }
1.1249    damieng  13211:     # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
                   13212:     # are not in subdirectories, using $currfile
1.984     raeburn  13213:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  13214:         if (exists($currfile{$file})) {
1.987     raeburn  13215:             unless ($mapping{$file} eq $file) {
                   13216:                 $pathchanges{$file} = 1;
                   13217:             }
                   13218:             $existing{$file} = 1;
                   13219:             $numexisting ++;
                   13220:         } else {
1.984     raeburn  13221:             $newfiles{$file} = 1;
                   13222:         }
                   13223:     }
1.1071    raeburn  13224:     foreach my $file (keys(%currfile)) {
                   13225:         unless (($file eq $filename) ||
                   13226:                 ($file eq $filename.'.bak') ||
                   13227:                 ($dependencies{$file})) {
1.1085    raeburn  13228:             if ($actionurl eq '/adm/dependencies') {
1.1126    raeburn  13229:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   13230:                     next if (($rem ne '') &&
                   13231:                              (($env{"httpref.$rem".$file} ne '') ||
                   13232:                               (ref($navmap) &&
                   13233:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   13234:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   13235:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   13236:                 }
1.1085    raeburn  13237:             }
1.1071    raeburn  13238:             $unused{$file} = 1;
                   13239:         }
                   13240:     }
1.1249    damieng  13241:     
                   13242:     # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084    raeburn  13243:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   13244:         ($args->{'context'} eq 'paste')) {
                   13245:         $counter = scalar(keys(%existing));
                   13246:         $numpathchg = scalar(keys(%pathchanges));
1.1123    raeburn  13247:         return ($output,$counter,$numpathchg,\%existing);
                   13248:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") && 
                   13249:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   13250:         $counter = scalar(keys(%existing));
                   13251:         $numpathchg = scalar(keys(%pathchanges));
                   13252:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084    raeburn  13253:     }
1.1249    damieng  13254:     
                   13255:     # returns HTML otherwise, with dependency results and to ask for more uploads
                   13256:     
                   13257:     # $upload_output: missing dependencies (with upload form)
                   13258:     # $modify_output: uploaded dependencies (in use)
                   13259:     # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984     raeburn  13260:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  13261:         if ($actionurl eq '/adm/dependencies') {
                   13262:             next if ($embed_file =~ m{^\w+://});
                   13263:         }
1.660     raeburn  13264:         $upload_output .= &start_data_table_row().
1.1123    raeburn  13265:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  13266:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  13267:         unless ($mapping{$embed_file} eq $embed_file) {
1.1123    raeburn  13268:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   13269:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  13270:         }
1.1123    raeburn  13271:         $upload_output .= '</td>';
1.1071    raeburn  13272:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1123    raeburn  13273:             $upload_output.='<td align="right">'.
                   13274:                             '<span class="LC_info LC_fontsize_medium">'.
                   13275:                             &mt("URL points to web address").'</span>';
1.987     raeburn  13276:             $numremref++;
1.660     raeburn  13277:         } elsif ($args->{'error_on_invalid_names'}
                   13278:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123    raeburn  13279:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   13280:                             &mt('Invalid characters').'</span>';
1.987     raeburn  13281:             $numinvalid++;
1.660     raeburn  13282:         } else {
1.1123    raeburn  13283:             $upload_output .= '<td>'.
                   13284:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  13285:                                                      $embed_file,\%mapping,
1.1071    raeburn  13286:                                                      $allfiles,$codebase,'upload');
                   13287:             $counter ++;
                   13288:             $numnew ++;
1.987     raeburn  13289:         }
                   13290:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   13291:     }
                   13292:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  13293:         if ($actionurl eq '/adm/dependencies') {
                   13294:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   13295:             $modify_output .= &start_data_table_row().
                   13296:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   13297:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   13298:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   13299:                               '<td>'.$size.'</td>'.
                   13300:                               '<td>'.$mtime.'</td>'.
                   13301:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   13302:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   13303:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   13304:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   13305:                               &embedded_file_element('upload_embedded',$counter,
                   13306:                                                      $embed_file,\%mapping,
                   13307:                                                      $allfiles,$codebase,'modify').
                   13308:                               '</div></td>'.
                   13309:                               &end_data_table_row()."\n";
                   13310:             $counter ++;
                   13311:         } else {
                   13312:             $upload_output .= &start_data_table_row().
1.1123    raeburn  13313:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   13314:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   13315:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  13316:                               &Apache::loncommon::end_data_table_row()."\n";
                   13317:         }
                   13318:     }
                   13319:     my $delidx = $counter;
                   13320:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   13321:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   13322:         $delete_output .= &start_data_table_row().
                   13323:                           '<td><img src="'.&icon($oldfile).'" />'.
                   13324:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   13325:                           '<td>'.$size.'</td>'.
                   13326:                           '<td>'.$mtime.'</td>'.
                   13327:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   13328:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   13329:                           &embedded_file_element('upload_embedded',$delidx,
                   13330:                                                  $oldfile,\%mapping,$allfiles,
                   13331:                                                  $codebase,'delete').'</td>'.
                   13332:                           &end_data_table_row()."\n"; 
                   13333:         $numunused ++;
                   13334:         $delidx ++;
1.987     raeburn  13335:     }
                   13336:     if ($upload_output) {
                   13337:         $upload_output = &start_data_table().
                   13338:                          $upload_output.
                   13339:                          &end_data_table()."\n";
                   13340:     }
1.1071    raeburn  13341:     if ($modify_output) {
                   13342:         $modify_output = &start_data_table().
                   13343:                          &start_data_table_header_row().
                   13344:                          '<th>'.&mt('File').'</th>'.
                   13345:                          '<th>'.&mt('Size (KB)').'</th>'.
                   13346:                          '<th>'.&mt('Modified').'</th>'.
                   13347:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   13348:                          &end_data_table_header_row().
                   13349:                          $modify_output.
                   13350:                          &end_data_table()."\n";
                   13351:     }
                   13352:     if ($delete_output) {
                   13353:         $delete_output = &start_data_table().
                   13354:                          &start_data_table_header_row().
                   13355:                          '<th>'.&mt('File').'</th>'.
                   13356:                          '<th>'.&mt('Size (KB)').'</th>'.
                   13357:                          '<th>'.&mt('Modified').'</th>'.
                   13358:                          '<th>'.&mt('Delete?').'</th>'.
                   13359:                          &end_data_table_header_row().
                   13360:                          $delete_output.
                   13361:                          &end_data_table()."\n";
                   13362:     }
1.987     raeburn  13363:     my $applies = 0;
                   13364:     if ($numremref) {
                   13365:         $applies ++;
                   13366:     }
                   13367:     if ($numinvalid) {
                   13368:         $applies ++;
                   13369:     }
                   13370:     if ($numexisting) {
                   13371:         $applies ++;
                   13372:     }
1.1071    raeburn  13373:     if ($counter || $numunused) {
1.987     raeburn  13374:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   13375:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  13376:                   $state.'<h3>'.$heading.'</h3>'; 
                   13377:         if ($actionurl eq '/adm/dependencies') {
                   13378:             if ($numnew) {
                   13379:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   13380:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   13381:                            $upload_output.'<br />'."\n";
                   13382:             }
                   13383:             if ($numexisting) {
                   13384:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   13385:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   13386:                            $modify_output.'<br />'."\n";
                   13387:                            $buttontext = &mt('Save changes');
                   13388:             }
                   13389:             if ($numunused) {
                   13390:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   13391:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   13392:                            $delete_output.'<br />'."\n";
                   13393:                            $buttontext = &mt('Save changes');
                   13394:             }
                   13395:         } else {
                   13396:             $output .= $upload_output.'<br />'."\n";
                   13397:         }
                   13398:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   13399:                    $counter.'" />'."\n";
                   13400:         if ($actionurl eq '/adm/dependencies') { 
                   13401:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   13402:                        $numnew.'" />'."\n";
                   13403:         } elsif ($actionurl eq '') {
1.987     raeburn  13404:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   13405:         }
                   13406:     } elsif ($applies) {
                   13407:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   13408:         if ($applies > 1) {
                   13409:             $output .=  
1.1123    raeburn  13410:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  13411:             if ($numremref) {
                   13412:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   13413:             }
                   13414:             if ($numinvalid) {
                   13415:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   13416:             }
                   13417:             if ($numexisting) {
                   13418:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   13419:             }
                   13420:             $output .= '</ul><br />';
                   13421:         } elsif ($numremref) {
                   13422:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   13423:         } elsif ($numinvalid) {
                   13424:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   13425:         } elsif ($numexisting) {
                   13426:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   13427:         }
                   13428:         $output .= $upload_output.'<br />';
                   13429:     }
                   13430:     my ($pathchange_output,$chgcount);
1.1071    raeburn  13431:     $chgcount = $counter;
1.987     raeburn  13432:     if (keys(%pathchanges) > 0) {
                   13433:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  13434:             if ($counter) {
1.987     raeburn  13435:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   13436:                                                   $embed_file,\%mapping,
1.1071    raeburn  13437:                                                   $allfiles,$codebase,'change');
1.987     raeburn  13438:             } else {
                   13439:                 $pathchange_output .= 
                   13440:                     &start_data_table_row().
                   13441:                     '<td><input type ="checkbox" name="namechange" value="'.
                   13442:                     $chgcount.'" checked="checked" /></td>'.
                   13443:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   13444:                     '<td>'.$embed_file.
                   13445:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  13446:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  13447:                     '</td>'.&end_data_table_row();
1.660     raeburn  13448:             }
1.987     raeburn  13449:             $numpathchg ++;
                   13450:             $chgcount ++;
1.660     raeburn  13451:         }
                   13452:     }
1.1127    raeburn  13453:     if (($counter) || ($numunused)) {
1.987     raeburn  13454:         if ($numpathchg) {
                   13455:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   13456:                        $numpathchg.'" />'."\n";
                   13457:         }
                   13458:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   13459:             ($actionurl eq '/adm/imsimport')) {
                   13460:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   13461:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   13462:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  13463:         } elsif ($actionurl eq '/adm/dependencies') {
                   13464:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  13465:         }
1.1123    raeburn  13466:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  13467:     } elsif ($numpathchg) {
                   13468:         my %pathchange = ();
                   13469:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   13470:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   13471:             $output .= '<p>'.&mt('or').'</p>'; 
1.1123    raeburn  13472:         }
1.987     raeburn  13473:     }
1.1071    raeburn  13474:     return ($output,$counter,$numpathchg);
1.987     raeburn  13475: }
                   13476: 
1.1147    raeburn  13477: =pod
                   13478: 
                   13479: =item * clean_path($name)
                   13480: 
                   13481: Performs clean-up of directories, subdirectories and filename in an
                   13482: embedded object, referenced in an HTML file which is being uploaded
                   13483: to a course or portfolio, where 
                   13484: "Upload embedded images/multimedia files if HTML file" checkbox was
                   13485: checked.
                   13486: 
                   13487: Clean-up is similar to replacements in lonnet::clean_filename()
                   13488: except each / between sub-directory and next level is preserved.
                   13489: 
                   13490: =cut
                   13491: 
                   13492: sub clean_path {
                   13493:     my ($embed_file) = @_;
                   13494:     $embed_file =~s{^/+}{};
                   13495:     my @contents;
                   13496:     if ($embed_file =~ m{/}) {
                   13497:         @contents = split(/\//,$embed_file);
                   13498:     } else {
                   13499:         @contents = ($embed_file);
                   13500:     }
                   13501:     my $lastidx = scalar(@contents)-1;
                   13502:     for (my $i=0; $i<=$lastidx; $i++) { 
                   13503:         $contents[$i]=~s{\\}{/}g;
                   13504:         $contents[$i]=~s/\s+/\_/g;
                   13505:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   13506:         if ($i == $lastidx) {
                   13507:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   13508:         }
                   13509:     }
                   13510:     if ($lastidx > 0) {
                   13511:         return join('/',@contents);
                   13512:     } else {
                   13513:         return $contents[0];
                   13514:     }
                   13515: }
                   13516: 
1.987     raeburn  13517: sub embedded_file_element {
1.1071    raeburn  13518:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  13519:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   13520:                    (ref($codebase) eq 'HASH'));
                   13521:     my $output;
1.1071    raeburn  13522:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  13523:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   13524:     }
                   13525:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   13526:                &escape($embed_file).'" />';
                   13527:     unless (($context eq 'upload_embedded') && 
                   13528:             ($mapping->{$embed_file} eq $embed_file)) {
                   13529:         $output .='
                   13530:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   13531:     }
                   13532:     my $attrib;
                   13533:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   13534:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   13535:     }
                   13536:     $output .=
                   13537:         "\n\t\t".
                   13538:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   13539:         $attrib.'" />';
                   13540:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   13541:         $output .=
                   13542:             "\n\t\t".
                   13543:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   13544:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  13545:     }
1.987     raeburn  13546:     return $output;
1.660     raeburn  13547: }
                   13548: 
1.1071    raeburn  13549: sub get_dependency_details {
                   13550:     my ($currfile,$currsubfile,$embed_file) = @_;
                   13551:     my ($size,$mtime,$showsize,$showmtime);
                   13552:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   13553:         if ($embed_file =~ m{/}) {
                   13554:             my ($path,$fname) = split(/\//,$embed_file);
                   13555:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   13556:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   13557:             }
                   13558:         } else {
                   13559:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   13560:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   13561:             }
                   13562:         }
                   13563:         $showsize = $size/1024.0;
                   13564:         $showsize = sprintf("%.1f",$showsize);
                   13565:         if ($mtime > 0) {
                   13566:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   13567:         }
                   13568:     }
                   13569:     return ($showsize,$showmtime);
                   13570: }
                   13571: 
                   13572: sub ask_embedded_js {
                   13573:     return <<"END";
                   13574: <script type="text/javascript"">
                   13575: // <![CDATA[
                   13576: function toggleBrowse(counter) {
                   13577:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   13578:     var fileid = document.getElementById('embedded_item_'+counter);
                   13579:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   13580:     if (chkboxid.checked == true) {
                   13581:         uploaddivid.style.display='block';
                   13582:     } else {
                   13583:         uploaddivid.style.display='none';
                   13584:         fileid.value = '';
                   13585:     }
                   13586: }
                   13587: // ]]>
                   13588: </script>
                   13589: 
                   13590: END
                   13591: }
                   13592: 
1.661     raeburn  13593: sub upload_embedded {
                   13594:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  13595:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   13596:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  13597:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   13598:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   13599:         my $orig_uploaded_filename =
                   13600:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  13601:         foreach my $type ('orig','ref','attrib','codebase') {
                   13602:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   13603:                 $env{'form.embedded_'.$type.'_'.$i} =
                   13604:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   13605:             }
                   13606:         }
1.661     raeburn  13607:         my ($path,$fname) =
                   13608:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   13609:         # no path, whole string is fname
                   13610:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   13611:         $fname = &Apache::lonnet::clean_filename($fname);
                   13612:         # See if there is anything left
                   13613:         next if ($fname eq '');
                   13614: 
                   13615:         # Check if file already exists as a file or directory.
                   13616:         my ($state,$msg);
                   13617:         if ($context eq 'portfolio') {
                   13618:             my $port_path = $dirpath;
                   13619:             if ($group ne '') {
                   13620:                 $port_path = "groups/$group/$port_path";
                   13621:             }
1.987     raeburn  13622:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   13623:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  13624:                                               $dir_root,$port_path,$disk_quota,
                   13625:                                               $current_disk_usage,$uname,$udom);
                   13626:             if ($state eq 'will_exceed_quota'
1.984     raeburn  13627:                 || $state eq 'file_locked') {
1.661     raeburn  13628:                 $output .= $msg;
                   13629:                 next;
                   13630:             }
                   13631:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   13632:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   13633:             if ($state eq 'exists') {
                   13634:                 $output .= $msg;
                   13635:                 next;
                   13636:             }
                   13637:         }
                   13638:         # Check if extension is valid
                   13639:         if (($fname =~ /\.(\w+)$/) &&
                   13640:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155    bisitz   13641:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   13642:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  13643:             next;
                   13644:         } elsif (($fname =~ /\.(\w+)$/) &&
                   13645:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  13646:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  13647:             next;
                   13648:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120    bisitz   13649:             $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  13650:             next;
                   13651:         }
                   13652:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123    raeburn  13653:         my $subdir = $path;
                   13654:         $subdir =~ s{/+$}{};
1.661     raeburn  13655:         if ($context eq 'portfolio') {
1.984     raeburn  13656:             my $result;
                   13657:             if ($state eq 'existingfile') {
                   13658:                 $result=
                   13659:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123    raeburn  13660:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  13661:             } else {
1.984     raeburn  13662:                 $result=
                   13663:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  13664:                                                     $dirpath.
1.1123    raeburn  13665:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  13666:                 if ($result !~ m|^/uploaded/|) {
                   13667:                     $output .= '<span class="LC_error">'
                   13668:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   13669:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   13670:                                .'</span><br />';
                   13671:                     next;
                   13672:                 } else {
1.987     raeburn  13673:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   13674:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  13675:                 }
1.661     raeburn  13676:             }
1.1123    raeburn  13677:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126    raeburn  13678:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   13679:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  13680:             my $result =
1.1126    raeburn  13681:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  13682:             if ($result !~ m|^/uploaded/|) {
                   13683:                 $output .= '<span class="LC_error">'
                   13684:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   13685:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   13686:                            .'</span><br />';
                   13687:                     next;
                   13688:             } else {
                   13689:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   13690:                            $path.$fname.'</span>').'<br />';
1.1125    raeburn  13691:                 if ($context eq 'syllabus') {
                   13692:                     &Apache::lonnet::make_public_indefinitely($result);
                   13693:                 }
1.987     raeburn  13694:             }
1.661     raeburn  13695:         } else {
                   13696: # Save the file
                   13697:             my $target = $env{'form.embedded_item_'.$i};
                   13698:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   13699:             my $dest = $fullpath.$fname;
                   13700:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  13701:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  13702:             my $count;
                   13703:             my $filepath = $dir_root;
1.1027    raeburn  13704:             foreach my $subdir (@parts) {
                   13705:                 $filepath .= "/$subdir";
                   13706:                 if (!-e $filepath) {
1.661     raeburn  13707:                     mkdir($filepath,0770);
                   13708:                 }
                   13709:             }
                   13710:             my $fh;
                   13711:             if (!open($fh,'>'.$dest)) {
                   13712:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   13713:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  13714:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   13715:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  13716:                            '</span><br />';
                   13717:             } else {
                   13718:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   13719:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   13720:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  13721:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   13722:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  13723:                               '</span><br />';
                   13724:                 } else {
1.987     raeburn  13725:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   13726:                                $url.'</span>').'<br />';
                   13727:                     unless ($context eq 'testbank') {
                   13728:                         $footer .= &mt('View embedded file: [_1]',
                   13729:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   13730:                     }
                   13731:                 }
                   13732:                 close($fh);
                   13733:             }
                   13734:         }
                   13735:         if ($env{'form.embedded_ref_'.$i}) {
                   13736:             $pathchange{$i} = 1;
                   13737:         }
                   13738:     }
                   13739:     if ($output) {
                   13740:         $output = '<p>'.$output.'</p>';
                   13741:     }
                   13742:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   13743:     $returnflag = 'ok';
1.1071    raeburn  13744:     my $numpathchgs = scalar(keys(%pathchange));
                   13745:     if ($numpathchgs > 0) {
1.987     raeburn  13746:         if ($context eq 'portfolio') {
                   13747:             $output .= '<p>'.&mt('or').'</p>';
                   13748:         } elsif ($context eq 'testbank') {
1.1071    raeburn  13749:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   13750:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  13751:             $returnflag = 'modify_orightml';
                   13752:         }
                   13753:     }
1.1071    raeburn  13754:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  13755: }
                   13756: 
                   13757: sub modify_html_form {
                   13758:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   13759:     my $end = 0;
                   13760:     my $modifyform;
                   13761:     if ($context eq 'upload_embedded') {
                   13762:         return unless (ref($pathchange) eq 'HASH');
                   13763:         if ($env{'form.number_embedded_items'}) {
                   13764:             $end += $env{'form.number_embedded_items'};
                   13765:         }
                   13766:         if ($env{'form.number_pathchange_items'}) {
                   13767:             $end += $env{'form.number_pathchange_items'};
                   13768:         }
                   13769:         if ($end) {
                   13770:             for (my $i=0; $i<$end; $i++) {
                   13771:                 if ($i < $env{'form.number_embedded_items'}) {
                   13772:                     next unless($pathchange->{$i});
                   13773:                 }
                   13774:                 $modifyform .=
                   13775:                     &start_data_table_row().
                   13776:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   13777:                     'checked="checked" /></td>'.
                   13778:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   13779:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   13780:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   13781:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   13782:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   13783:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   13784:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   13785:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   13786:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   13787:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   13788:                     &end_data_table_row();
1.1071    raeburn  13789:             }
1.987     raeburn  13790:         }
                   13791:     } else {
                   13792:         $modifyform = $pathchgtable;
                   13793:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   13794:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   13795:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   13796:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   13797:         }
                   13798:     }
                   13799:     if ($modifyform) {
1.1071    raeburn  13800:         if ($actionurl eq '/adm/dependencies') {
                   13801:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   13802:         }
1.987     raeburn  13803:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   13804:                '<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".
                   13805:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   13806:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   13807:                '</ol></p>'."\n".'<p>'.
                   13808:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   13809:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   13810:                &start_data_table()."\n".
                   13811:                &start_data_table_header_row().
                   13812:                '<th>'.&mt('Change?').'</th>'.
                   13813:                '<th>'.&mt('Current reference').'</th>'.
                   13814:                '<th>'.&mt('Required reference').'</th>'.
                   13815:                &end_data_table_header_row()."\n".
                   13816:                $modifyform.
                   13817:                &end_data_table().'<br />'."\n".$hiddenstate.
                   13818:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   13819:                '</form>'."\n";
                   13820:     }
                   13821:     return;
                   13822: }
                   13823: 
                   13824: sub modify_html_refs {
1.1123    raeburn  13825:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  13826:     my $container;
                   13827:     if ($context eq 'portfolio') {
                   13828:         $container = $env{'form.container'};
                   13829:     } elsif ($context eq 'coursedoc') {
                   13830:         $container = $env{'form.primaryurl'};
1.1071    raeburn  13831:     } elsif ($context eq 'manage_dependencies') {
                   13832:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   13833:         $container = "/$container";
1.1123    raeburn  13834:     } elsif ($context eq 'syllabus') {
                   13835:         $container = $url;
1.987     raeburn  13836:     } else {
1.1027    raeburn  13837:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  13838:     }
                   13839:     my (%allfiles,%codebase,$output,$content);
                   13840:     my @changes = &get_env_multiple('form.namechange');
1.1126    raeburn  13841:     unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071    raeburn  13842:         if (wantarray) {
                   13843:             return ('',0,0); 
                   13844:         } else {
                   13845:             return;
                   13846:         }
                   13847:     }
                   13848:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1123    raeburn  13849:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  13850:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   13851:             if (wantarray) {
                   13852:                 return ('',0,0);
                   13853:             } else {
                   13854:                 return;
                   13855:             }
                   13856:         } 
1.987     raeburn  13857:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  13858:         if ($content eq '-1') {
                   13859:             if (wantarray) {
                   13860:                 return ('',0,0);
                   13861:             } else {
                   13862:                 return;
                   13863:             }
                   13864:         }
1.987     raeburn  13865:     } else {
1.1071    raeburn  13866:         unless ($container =~ /^\Q$dir_root\E/) {
                   13867:             if (wantarray) {
                   13868:                 return ('',0,0);
                   13869:             } else {
                   13870:                 return;
                   13871:             }
                   13872:         } 
1.1317    raeburn  13873:         if (open(my $fh,'<',$container)) {
1.987     raeburn  13874:             $content = join('', <$fh>);
                   13875:             close($fh);
                   13876:         } else {
1.1071    raeburn  13877:             if (wantarray) {
                   13878:                 return ('',0,0);
                   13879:             } else {
                   13880:                 return;
                   13881:             }
1.987     raeburn  13882:         }
                   13883:     }
                   13884:     my ($count,$codebasecount) = (0,0);
                   13885:     my $mm = new File::MMagic;
                   13886:     my $mime_type = $mm->checktype_contents($content);
                   13887:     if ($mime_type eq 'text/html') {
                   13888:         my $parse_result = 
                   13889:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   13890:                                                     \%codebase,\$content);
                   13891:         if ($parse_result eq 'ok') {
                   13892:             foreach my $i (@changes) {
                   13893:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   13894:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   13895:                 if ($allfiles{$ref}) {
                   13896:                     my $newname =  $orig;
                   13897:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  13898:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  13899:                     if ($attrib_regexp =~ /:/) {
                   13900:                         $attrib_regexp =~ s/\:/|/g;
                   13901:                     }
                   13902:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   13903:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   13904:                         $count += $numchg;
1.1123    raeburn  13905:                         $allfiles{$newname} = $allfiles{$ref};
1.1148    raeburn  13906:                         delete($allfiles{$ref});
1.987     raeburn  13907:                     }
                   13908:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  13909:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  13910:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   13911:                         $codebasecount ++;
                   13912:                     }
                   13913:                 }
                   13914:             }
1.1123    raeburn  13915:             my $skiprewrites;
1.987     raeburn  13916:             if ($count || $codebasecount) {
                   13917:                 my $saveresult;
1.1071    raeburn  13918:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1123    raeburn  13919:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  13920:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   13921:                     if ($url eq $container) {
                   13922:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   13923:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   13924:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  13925:                                             $fname.'</span>').'</p>';
1.987     raeburn  13926:                     } else {
                   13927:                          $output = '<p class="LC_error">'.
                   13928:                                    &mt('Error: update failed for: [_1].',
                   13929:                                    '<span class="LC_filename">'.
                   13930:                                    $container.'</span>').'</p>';
                   13931:                     }
1.1123    raeburn  13932:                     if ($context eq 'syllabus') {
                   13933:                         unless ($saveresult eq 'ok') {
                   13934:                             $skiprewrites = 1;
                   13935:                         }
                   13936:                     }
1.987     raeburn  13937:                 } else {
1.1317    raeburn  13938:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  13939:                         print $fh $content;
                   13940:                         close($fh);
                   13941:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   13942:                                   $count,'<span class="LC_filename">'.
                   13943:                                   $container.'</span>').'</p>';
1.661     raeburn  13944:                     } else {
1.987     raeburn  13945:                          $output = '<p class="LC_error">'.
                   13946:                                    &mt('Error: could not update [_1].',
                   13947:                                    '<span class="LC_filename">'.
                   13948:                                    $container.'</span>').'</p>';
1.661     raeburn  13949:                     }
                   13950:                 }
                   13951:             }
1.1123    raeburn  13952:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   13953:                 my ($actionurl,$state);
                   13954:                 $actionurl = "/public/$udom/$uname/syllabus";
                   13955:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   13956:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   13957:                                               \%codebase,
                   13958:                                               {'context' => 'rewrites',
                   13959:                                                'ignore_remote_references' => 1,});
                   13960:                 if (ref($mapping) eq 'HASH') {
                   13961:                     my $rewrites = 0;
                   13962:                     foreach my $key (keys(%{$mapping})) {
                   13963:                         next if ($key =~ m{^https?://});
                   13964:                         my $ref = $mapping->{$key};
                   13965:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   13966:                         my $attrib;
                   13967:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   13968:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   13969:                         }
                   13970:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   13971:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   13972:                             $rewrites += $numchg;
                   13973:                         }
                   13974:                     }
                   13975:                     if ($rewrites) {
                   13976:                         my $saveresult; 
                   13977:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   13978:                         if ($url eq $container) {
                   13979:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   13980:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   13981:                                             $count,'<span class="LC_filename">'.
                   13982:                                             $fname.'</span>').'</p>';
                   13983:                         } else {
                   13984:                             $output .= '<p class="LC_error">'.
                   13985:                                        &mt('Error: could not update links in [_1].',
                   13986:                                        '<span class="LC_filename">'.
                   13987:                                        $container.'</span>').'</p>';
                   13988: 
                   13989:                         }
                   13990:                     }
                   13991:                 }
                   13992:             }
1.987     raeburn  13993:         } else {
                   13994:             &logthis('Failed to parse '.$container.
                   13995:                      ' to modify references: '.$parse_result);
1.661     raeburn  13996:         }
                   13997:     }
1.1071    raeburn  13998:     if (wantarray) {
                   13999:         return ($output,$count,$codebasecount);
                   14000:     } else {
                   14001:         return $output;
                   14002:     }
1.661     raeburn  14003: }
                   14004: 
                   14005: sub check_for_existing {
                   14006:     my ($path,$fname,$element) = @_;
                   14007:     my ($state,$msg);
                   14008:     if (-d $path.'/'.$fname) {
                   14009:         $state = 'exists';
                   14010:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   14011:     } elsif (-e $path.'/'.$fname) {
                   14012:         $state = 'exists';
                   14013:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   14014:     }
                   14015:     if ($state eq 'exists') {
                   14016:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   14017:     }
                   14018:     return ($state,$msg);
                   14019: }
                   14020: 
                   14021: sub check_for_upload {
                   14022:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   14023:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  14024:     my $filesize = length($env{'form.'.$element});
                   14025:     if (!$filesize) {
                   14026:         my $msg = '<span class="LC_error">'.
                   14027:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   14028:                       '<span class="LC_filename">'.$fname.'</span>',
                   14029:                       $filesize).'<br />'.
1.1007    raeburn  14030:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  14031:                   '</span>';
                   14032:         return ('zero_bytes',$msg);
                   14033:     }
                   14034:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  14035:     my $getpropath = 1;
1.1021    raeburn  14036:     my ($dirlistref,$listerror) =
                   14037:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  14038:     my $found_file = 0;
                   14039:     my $locked_file = 0;
1.991     raeburn  14040:     my @lockers;
                   14041:     my $navmap;
                   14042:     if ($env{'request.course.id'}) {
                   14043:         $navmap = Apache::lonnavmaps::navmap->new();
                   14044:     }
1.1021    raeburn  14045:     if (ref($dirlistref) eq 'ARRAY') {
                   14046:         foreach my $line (@{$dirlistref}) {
                   14047:             my ($file_name,$rest)=split(/\&/,$line,2);
                   14048:             if ($file_name eq $fname){
                   14049:                 $file_name = $path.$file_name;
                   14050:                 if ($group ne '') {
                   14051:                     $file_name = $group.$file_name;
                   14052:                 }
                   14053:                 $found_file = 1;
                   14054:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   14055:                     foreach my $lock (@lockers) {
                   14056:                         if (ref($lock) eq 'ARRAY') {
                   14057:                             my ($symb,$crsid) = @{$lock};
                   14058:                             if ($crsid eq $env{'request.course.id'}) {
                   14059:                                 if (ref($navmap)) {
                   14060:                                     my $res = $navmap->getBySymb($symb);
                   14061:                                     foreach my $part (@{$res->parts()}) { 
                   14062:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   14063:                                         unless (($slot_status == $res->RESERVED) ||
                   14064:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   14065:                                             $locked_file = 1;
                   14066:                                         }
1.991     raeburn  14067:                                     }
1.1021    raeburn  14068:                                 } else {
                   14069:                                     $locked_file = 1;
1.991     raeburn  14070:                                 }
                   14071:                             } else {
                   14072:                                 $locked_file = 1;
                   14073:                             }
                   14074:                         }
1.1021    raeburn  14075:                    }
                   14076:                 } else {
                   14077:                     my @info = split(/\&/,$rest);
                   14078:                     my $currsize = $info[6]/1000;
                   14079:                     if ($currsize < $filesize) {
                   14080:                         my $extra = $filesize - $currsize;
                   14081:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1179    bisitz   14082:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  14083:                                       &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   14084:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   14085:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   14086:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  14087:                             return ('will_exceed_quota',$msg);
                   14088:                         }
1.984     raeburn  14089:                     }
                   14090:                 }
1.661     raeburn  14091:             }
                   14092:         }
                   14093:     }
                   14094:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1179    bisitz   14095:         my $msg = '<p class="LC_warning">'.
                   14096:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184    raeburn  14097:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  14098:         return ('will_exceed_quota',$msg);
                   14099:     } elsif ($found_file) {
                   14100:         if ($locked_file) {
1.1179    bisitz   14101:             my $msg = '<p class="LC_warning">';
1.661     raeburn  14102:             $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   14103:             $msg .= '</p>';
1.661     raeburn  14104:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   14105:             return ('file_locked',$msg);
                   14106:         } else {
1.1179    bisitz   14107:             my $msg = '<p class="LC_error">';
1.984     raeburn  14108:             $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   14109:             $msg .= '</p>';
1.984     raeburn  14110:             return ('existingfile',$msg);
1.661     raeburn  14111:         }
                   14112:     }
                   14113: }
                   14114: 
1.987     raeburn  14115: sub check_for_traversal {
                   14116:     my ($path,$url,$toplevel) = @_;
                   14117:     my @parts=split(/\//,$path);
                   14118:     my $cleanpath;
                   14119:     my $fullpath = $url;
                   14120:     for (my $i=0;$i<@parts;$i++) {
                   14121:         next if ($parts[$i] eq '.');
                   14122:         if ($parts[$i] eq '..') {
                   14123:             $fullpath =~ s{([^/]+/)$}{};
                   14124:         } else {
                   14125:             $fullpath .= $parts[$i].'/';
                   14126:         }
                   14127:     }
                   14128:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   14129:         $cleanpath = $1;
                   14130:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   14131:         my $curr_toprel = $1;
                   14132:         my @parts = split(/\//,$curr_toprel);
                   14133:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   14134:         my @urlparts = split(/\//,$url_toprel);
                   14135:         my $doubledots;
                   14136:         my $startdiff = -1;
                   14137:         for (my $i=0; $i<@urlparts; $i++) {
                   14138:             if ($startdiff == -1) {
                   14139:                 unless ($urlparts[$i] eq $parts[$i]) {
                   14140:                     $startdiff = $i;
                   14141:                     $doubledots .= '../';
                   14142:                 }
                   14143:             } else {
                   14144:                 $doubledots .= '../';
                   14145:             }
                   14146:         }
                   14147:         if ($startdiff > -1) {
                   14148:             $cleanpath = $doubledots;
                   14149:             for (my $i=$startdiff; $i<@parts; $i++) {
                   14150:                 $cleanpath .= $parts[$i].'/';
                   14151:             }
                   14152:         }
                   14153:     }
                   14154:     $cleanpath =~ s{(/)$}{};
                   14155:     return $cleanpath;
                   14156: }
1.31      albertel 14157: 
1.1053    raeburn  14158: sub is_archive_file {
                   14159:     my ($mimetype) = @_;
                   14160:     if (($mimetype eq 'application/octet-stream') ||
                   14161:         ($mimetype eq 'application/x-stuffit') ||
                   14162:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   14163:         return 1;
                   14164:     }
                   14165:     return;
                   14166: }
                   14167: 
                   14168: sub decompress_form {
1.1065    raeburn  14169:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  14170:     my %lt = &Apache::lonlocal::texthash (
                   14171:         this => 'This file is an archive file.',
1.1067    raeburn  14172:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  14173:         itsc => 'Its contents are as follows:',
1.1053    raeburn  14174:         youm => 'You may wish to extract its contents.',
                   14175:         extr => 'Extract contents',
1.1067    raeburn  14176:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   14177:         proa => 'Process automatically?',
1.1053    raeburn  14178:         yes  => 'Yes',
                   14179:         no   => 'No',
1.1067    raeburn  14180:         fold => 'Title for folder containing movie',
                   14181:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  14182:     );
1.1065    raeburn  14183:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  14184:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  14185:     my $info = &list_archive_contents($fileloc,\@paths);
                   14186:     if (@paths) {
                   14187:         foreach my $path (@paths) {
                   14188:             $path =~ s{^/}{};
1.1067    raeburn  14189:             if ($path =~ m{^([^/]+)/$}) {
                   14190:                 $topdir = $1;
                   14191:             }
1.1065    raeburn  14192:             if ($path =~ m{^([^/]+)/}) {
                   14193:                 $toplevel{$1} = $path;
                   14194:             } else {
                   14195:                 $toplevel{$path} = $path;
                   14196:             }
                   14197:         }
                   14198:     }
1.1067    raeburn  14199:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164    raeburn  14200:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  14201:                         "$topdir/media/",
                   14202:                         "$topdir/media/$topdir.mp4",
                   14203:                         "$topdir/media/FirstFrame.png",
                   14204:                         "$topdir/media/player.swf",
                   14205:                         "$topdir/media/swfobject.js",
                   14206:                         "$topdir/media/expressInstall.swf");
1.1197    raeburn  14207:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164    raeburn  14208:                          "$topdir/$topdir.mp4",
                   14209:                          "$topdir/$topdir\_config.xml",
                   14210:                          "$topdir/$topdir\_controller.swf",
                   14211:                          "$topdir/$topdir\_embed.css",
                   14212:                          "$topdir/$topdir\_First_Frame.png",
                   14213:                          "$topdir/$topdir\_player.html",
                   14214:                          "$topdir/$topdir\_Thumbnails.png",
                   14215:                          "$topdir/playerProductInstall.swf",
                   14216:                          "$topdir/scripts/",
                   14217:                          "$topdir/scripts/config_xml.js",
                   14218:                          "$topdir/scripts/handlebars.js",
                   14219:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   14220:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   14221:                          "$topdir/scripts/modernizr.js",
                   14222:                          "$topdir/scripts/player-min.js",
                   14223:                          "$topdir/scripts/swfobject.js",
                   14224:                          "$topdir/skins/",
                   14225:                          "$topdir/skins/configuration_express.xml",
                   14226:                          "$topdir/skins/express_show/",
                   14227:                          "$topdir/skins/express_show/player-min.css",
                   14228:                          "$topdir/skins/express_show/spritesheet.png");
1.1197    raeburn  14229:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   14230:                          "$topdir/$topdir.mp4",
                   14231:                          "$topdir/$topdir\_config.xml",
                   14232:                          "$topdir/$topdir\_controller.swf",
                   14233:                          "$topdir/$topdir\_embed.css",
                   14234:                          "$topdir/$topdir\_First_Frame.png",
                   14235:                          "$topdir/$topdir\_player.html",
                   14236:                          "$topdir/$topdir\_Thumbnails.png",
                   14237:                          "$topdir/playerProductInstall.swf",
                   14238:                          "$topdir/scripts/",
                   14239:                          "$topdir/scripts/config_xml.js",
                   14240:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   14241:                          "$topdir/skins/",
                   14242:                          "$topdir/skins/configuration_express.xml",
                   14243:                          "$topdir/skins/express_show/",
                   14244:                          "$topdir/skins/express_show/spritesheet.min.css",
                   14245:                          "$topdir/skins/express_show/spritesheet.png",
                   14246:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164    raeburn  14247:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  14248:         if (@diffs == 0) {
1.1164    raeburn  14249:             $is_camtasia = 6;
                   14250:         } else {
1.1197    raeburn  14251:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164    raeburn  14252:             if (@diffs == 0) {
                   14253:                 $is_camtasia = 8;
1.1197    raeburn  14254:             } else {
                   14255:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   14256:                 if (@diffs == 0) {
                   14257:                     $is_camtasia = 8;
                   14258:                 }
1.1164    raeburn  14259:             }
1.1067    raeburn  14260:         }
                   14261:     }
                   14262:     my $output;
                   14263:     if ($is_camtasia) {
                   14264:         $output = <<"ENDCAM";
                   14265: <script type="text/javascript" language="Javascript">
                   14266: // <![CDATA[
                   14267: 
                   14268: function camtasiaToggle() {
                   14269:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   14270:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164    raeburn  14271:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  14272:                 document.getElementById('camtasia_titles').style.display='block';
                   14273:             } else {
                   14274:                 document.getElementById('camtasia_titles').style.display='none';
                   14275:             }
                   14276:         }
                   14277:     }
                   14278:     return;
                   14279: }
                   14280: 
                   14281: // ]]>
                   14282: </script>
                   14283: <p>$lt{'camt'}</p>
                   14284: ENDCAM
1.1065    raeburn  14285:     } else {
1.1067    raeburn  14286:         $output = '<p>'.$lt{'this'};
                   14287:         if ($info eq '') {
                   14288:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   14289:         } else {
                   14290:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   14291:                        '<div><pre>'.$info.'</pre></div>';
                   14292:         }
1.1065    raeburn  14293:     }
1.1067    raeburn  14294:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  14295:     my $duplicates;
                   14296:     my $num = 0;
                   14297:     if (ref($dirlist) eq 'ARRAY') {
                   14298:         foreach my $item (@{$dirlist}) {
                   14299:             if (ref($item) eq 'ARRAY') {
                   14300:                 if (exists($toplevel{$item->[0]})) {
                   14301:                     $duplicates .= 
                   14302:                         &start_data_table_row().
                   14303:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   14304:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   14305:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   14306:                         'value="1" />'.&mt('Yes').'</label>'.
                   14307:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   14308:                         '<td>'.$item->[0].'</td>';
                   14309:                     if ($item->[2]) {
                   14310:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   14311:                     } else {
                   14312:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   14313:                     }
                   14314:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   14315:                                    '<td>'.
                   14316:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   14317:                                    '</td>'.
                   14318:                                    &end_data_table_row();
                   14319:                     $num ++;
                   14320:                 }
                   14321:             }
                   14322:         }
                   14323:     }
                   14324:     my $itemcount;
                   14325:     if (@paths > 0) {
                   14326:         $itemcount = scalar(@paths);
                   14327:     } else {
                   14328:         $itemcount = 1;
                   14329:     }
1.1067    raeburn  14330:     if ($is_camtasia) {
                   14331:         $output .= $lt{'auto'}.'<br />'.
                   14332:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164    raeburn  14333:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  14334:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   14335:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   14336:                    $lt{'no'}.'</label></span><br />'.
                   14337:                    '<div id="camtasia_titles" style="display:block">'.
                   14338:                    &Apache::lonhtmlcommon::start_pick_box().
                   14339:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   14340:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   14341:                    &Apache::lonhtmlcommon::row_closure().
                   14342:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   14343:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   14344:                    &Apache::lonhtmlcommon::row_closure(1).
                   14345:                    &Apache::lonhtmlcommon::end_pick_box().
                   14346:                    '</div>';
                   14347:     }
1.1065    raeburn  14348:     $output .= 
                   14349:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  14350:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   14351:         "\n";
1.1065    raeburn  14352:     if ($duplicates ne '') {
                   14353:         $output .= '<p><span class="LC_warning">'.
                   14354:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   14355:                    &start_data_table().
                   14356:                    &start_data_table_header_row().
                   14357:                    '<th>'.&mt('Overwrite?').'</th>'.
                   14358:                    '<th>'.&mt('Name').'</th>'.
                   14359:                    '<th>'.&mt('Type').'</th>'.
                   14360:                    '<th>'.&mt('Size').'</th>'.
                   14361:                    '<th>'.&mt('Last modified').'</th>'.
                   14362:                    &end_data_table_header_row().
                   14363:                    $duplicates.
                   14364:                    &end_data_table().
                   14365:                    '</p>';
                   14366:     }
1.1067    raeburn  14367:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  14368:     if (ref($hiddenelements) eq 'HASH') {
                   14369:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   14370:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   14371:         }
                   14372:     }
                   14373:     $output .= <<"END";
1.1067    raeburn  14374: <br />
1.1053    raeburn  14375: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   14376: </form>
                   14377: $noextract
                   14378: END
                   14379:     return $output;
                   14380: }
                   14381: 
1.1065    raeburn  14382: sub decompression_utility {
                   14383:     my ($program) = @_;
                   14384:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   14385:     my $location;
                   14386:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   14387:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   14388:                          '/usr/sbin/') {
                   14389:             if (-x $dir.$program) {
                   14390:                 $location = $dir.$program;
                   14391:                 last;
                   14392:             }
                   14393:         }
                   14394:     }
                   14395:     return $location;
                   14396: }
                   14397: 
                   14398: sub list_archive_contents {
                   14399:     my ($file,$pathsref) = @_;
                   14400:     my (@cmd,$output);
                   14401:     my $needsregexp;
                   14402:     if ($file =~ /\.zip$/) {
                   14403:         @cmd = (&decompression_utility('unzip'),"-l");
                   14404:         $needsregexp = 1;
                   14405:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   14406:              ($file =~ /\.tgz$/)) {
                   14407:         @cmd = (&decompression_utility('tar'),"-ztf");
                   14408:     } elsif ($file =~ /\.tar\.bz2$/) {
                   14409:         @cmd = (&decompression_utility('tar'),"-jtf");
                   14410:     } elsif ($file =~ m|\.tar$|) {
                   14411:         @cmd = (&decompression_utility('tar'),"-tf");
                   14412:     }
                   14413:     if (@cmd) {
                   14414:         undef($!);
                   14415:         undef($@);
                   14416:         if (open(my $fh,"-|", @cmd, $file)) {
                   14417:             while (my $line = <$fh>) {
                   14418:                 $output .= $line;
                   14419:                 chomp($line);
                   14420:                 my $item;
                   14421:                 if ($needsregexp) {
                   14422:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   14423:                 } else {
                   14424:                     $item = $line;
                   14425:                 }
                   14426:                 if ($item ne '') {
                   14427:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   14428:                         push(@{$pathsref},$item);
                   14429:                     } 
                   14430:                 }
                   14431:             }
                   14432:             close($fh);
                   14433:         }
                   14434:     }
                   14435:     return $output;
                   14436: }
                   14437: 
1.1053    raeburn  14438: sub decompress_uploaded_file {
                   14439:     my ($file,$dir) = @_;
                   14440:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   14441:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   14442:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   14443:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   14444:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   14445:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   14446:     my $decompressed = $env{'cgi.decompressed'};
                   14447:     &Apache::lonnet::delenv('cgi.file');
                   14448:     &Apache::lonnet::delenv('cgi.dir');
                   14449:     &Apache::lonnet::delenv('cgi.decompressed');
                   14450:     return ($decompressed,$result);
                   14451: }
                   14452: 
1.1055    raeburn  14453: sub process_decompression {
                   14454:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292    raeburn  14455:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   14456:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14457:                &mt('Unexpected file path.').'</p>'."\n";
                   14458:     }
                   14459:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   14460:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14461:                &mt('Unexpected course context.').'</p>'."\n";
                   14462:     }
1.1293    raeburn  14463:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292    raeburn  14464:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14465:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   14466:     }
1.1055    raeburn  14467:     my ($dir,$error,$warning,$output);
1.1180    raeburn  14468:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120    bisitz   14469:         $error = &mt('Filename not a supported archive file type.').
                   14470:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  14471:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   14472:     } else {
                   14473:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   14474:         if ($docuhome eq 'no_host') {
                   14475:             $error = &mt('Could not determine home server for course.');
                   14476:         } else {
                   14477:             my @ids=&Apache::lonnet::current_machine_ids();
                   14478:             my $currdir = "$dir_root/$destination";
                   14479:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   14480:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   14481:                        "$dir_root/$destination";
                   14482:             } else {
                   14483:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   14484:                        "$dir_root/$docudom/$docuname/$destination";
                   14485:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   14486:                     $error = &mt('Archive file not found.');
                   14487:                 }
                   14488:             }
1.1065    raeburn  14489:             my (@to_overwrite,@to_skip);
                   14490:             if ($env{'form.archive_overwrite_total'} > 0) {
                   14491:                 my $total = $env{'form.archive_overwrite_total'};
                   14492:                 for (my $i=0; $i<$total; $i++) {
                   14493:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   14494:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   14495:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   14496:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   14497:                     }
                   14498:                 }
                   14499:             }
                   14500:             my $numskip = scalar(@to_skip);
1.1292    raeburn  14501:             my $numoverwrite = scalar(@to_overwrite);
                   14502:             if (($numskip) && (!$numoverwrite)) { 
1.1065    raeburn  14503:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   14504:             } elsif ($dir eq '') {
1.1055    raeburn  14505:                 $error = &mt('Directory containing archive file unavailable.');
                   14506:             } elsif (!$error) {
1.1065    raeburn  14507:                 my ($decompressed,$display);
1.1292    raeburn  14508:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  14509:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   14510:                     mkdir("$dir/$tempdir",0755);
1.1292    raeburn  14511:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   14512:                         ($decompressed,$display) = 
                   14513:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   14514:                         foreach my $item (@to_skip) {
                   14515:                             if (($item ne '') && ($item !~ /\.\./)) {
                   14516:                                 if (-f "$dir/$tempdir/$item") { 
                   14517:                                     unlink("$dir/$tempdir/$item");
                   14518:                                 } elsif (-d "$dir/$tempdir/$item") {
1.1300    raeburn  14519:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292    raeburn  14520:                                 }
                   14521:                             }
                   14522:                         }
                   14523:                         foreach my $item (@to_overwrite) {
                   14524:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   14525:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   14526:                                     if (-f "$dir/$item") {
                   14527:                                         unlink("$dir/$item");
                   14528:                                     } elsif (-d "$dir/$item") {
1.1300    raeburn  14529:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292    raeburn  14530:                                     }
                   14531:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   14532:                                 }
1.1065    raeburn  14533:                             }
                   14534:                         }
1.1292    raeburn  14535:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300    raeburn  14536:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292    raeburn  14537:                         }
1.1065    raeburn  14538:                     }
                   14539:                 } else {
                   14540:                     ($decompressed,$display) = 
                   14541:                         &decompress_uploaded_file($file,$dir);
                   14542:                 }
1.1055    raeburn  14543:                 if ($decompressed eq 'ok') {
1.1065    raeburn  14544:                     $output = '<p class="LC_info">'.
                   14545:                               &mt('Files extracted successfully from archive.').
                   14546:                               '</p>'."\n";
1.1055    raeburn  14547:                     my ($warning,$result,@contents);
                   14548:                     my ($newdirlistref,$newlisterror) =
                   14549:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   14550:                                                  $docuname,1);
                   14551:                     my (%is_dir,%changes,@newitems);
                   14552:                     my $dirptr = 16384;
1.1065    raeburn  14553:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  14554:                         foreach my $dir_line (@{$newdirlistref}) {
                   14555:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292    raeburn  14556:                             unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055    raeburn  14557:                                 push(@newitems,$item);
                   14558:                                 if ($dirptr&$testdir) {
                   14559:                                     $is_dir{$item} = 1;
                   14560:                                 }
                   14561:                                 $changes{$item} = 1;
                   14562:                             }
                   14563:                         }
                   14564:                     }
                   14565:                     if (keys(%changes) > 0) {
                   14566:                         foreach my $item (sort(@newitems)) {
                   14567:                             if ($changes{$item}) {
                   14568:                                 push(@contents,$item);
                   14569:                             }
                   14570:                         }
                   14571:                     }
                   14572:                     if (@contents > 0) {
1.1067    raeburn  14573:                         my $wantform;
                   14574:                         unless ($env{'form.autoextract_camtasia'}) {
                   14575:                             $wantform = 1;
                   14576:                         }
1.1056    raeburn  14577:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  14578:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   14579:                                                                 $currdir,\%is_dir,
                   14580:                                                                 \%children,\%parent,
1.1056    raeburn  14581:                                                                 \@contents,\%dirorder,
                   14582:                                                                 \%titles,$wantform);
1.1055    raeburn  14583:                         if ($datatable ne '') {
                   14584:                             $output .= &archive_options_form('decompressed',$datatable,
                   14585:                                                              $count,$hiddenelem);
1.1065    raeburn  14586:                             my $startcount = 6;
1.1055    raeburn  14587:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  14588:                                                            \%titles,\%children);
1.1055    raeburn  14589:                         }
1.1067    raeburn  14590:                         if ($env{'form.autoextract_camtasia'}) {
1.1164    raeburn  14591:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  14592:                             my %displayed;
                   14593:                             my $total = 1;
                   14594:                             $env{'form.archive_directory'} = [];
                   14595:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   14596:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   14597:                                 $path =~ s{/$}{};
                   14598:                                 my $item;
                   14599:                                 if ($path ne '') {
                   14600:                                     $item = "$path/$titles{$i}";
                   14601:                                 } else {
                   14602:                                     $item = $titles{$i};
                   14603:                                 }
                   14604:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   14605:                                 if ($item eq $contents[0]) {
                   14606:                                     push(@{$env{'form.archive_directory'}},$i);
                   14607:                                     $env{'form.archive_'.$i} = 'display';
                   14608:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   14609:                                     $displayed{'folder'} = $i;
1.1164    raeburn  14610:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   14611:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) { 
1.1067    raeburn  14612:                                     $env{'form.archive_'.$i} = 'display';
                   14613:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   14614:                                     $displayed{'web'} = $i;
                   14615:                                 } else {
1.1164    raeburn  14616:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   14617:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   14618:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  14619:                                         push(@{$env{'form.archive_directory'}},$i);
                   14620:                                     }
                   14621:                                     $env{'form.archive_'.$i} = 'dependency';
                   14622:                                 }
                   14623:                                 $total ++;
                   14624:                             }
                   14625:                             for (my $i=1; $i<$total; $i++) {
                   14626:                                 next if ($i == $displayed{'web'});
                   14627:                                 next if ($i == $displayed{'folder'});
                   14628:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   14629:                             }
                   14630:                             $env{'form.phase'} = 'decompress_cleanup';
                   14631:                             $env{'form.archivedelete'} = 1;
                   14632:                             $env{'form.archive_count'} = $total-1;
                   14633:                             $output .=
                   14634:                                 &process_extracted_files('coursedocs',$docudom,
                   14635:                                                          $docuname,$destination,
                   14636:                                                          $dir_root,$hiddenelem);
                   14637:                         }
1.1055    raeburn  14638:                     } else {
                   14639:                         $warning = &mt('No new items extracted from archive file.');
                   14640:                     }
                   14641:                 } else {
                   14642:                     $output = $display;
                   14643:                     $error = &mt('An error occurred during extraction from the archive file.');
                   14644:                 }
                   14645:             }
                   14646:         }
                   14647:     }
                   14648:     if ($error) {
                   14649:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14650:                    $error.'</p>'."\n";
                   14651:     }
                   14652:     if ($warning) {
                   14653:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   14654:     }
                   14655:     return $output;
                   14656: }
                   14657: 
                   14658: sub get_extracted {
1.1056    raeburn  14659:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   14660:         $titles,$wantform) = @_;
1.1055    raeburn  14661:     my $count = 0;
                   14662:     my $depth = 0;
                   14663:     my $datatable;
1.1056    raeburn  14664:     my @hierarchy;
1.1055    raeburn  14665:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  14666:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   14667:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  14668:     foreach my $item (@{$contents}) {
                   14669:         $count ++;
1.1056    raeburn  14670:         @{$dirorder->{$count}} = @hierarchy;
                   14671:         $titles->{$count} = $item;
1.1055    raeburn  14672:         &archive_hierarchy($depth,$count,$parent,$children);
                   14673:         if ($wantform) {
                   14674:             $datatable .= &archive_row($is_dir->{$item},$item,
                   14675:                                        $currdir,$depth,$count);
                   14676:         }
                   14677:         if ($is_dir->{$item}) {
                   14678:             $depth ++;
1.1056    raeburn  14679:             push(@hierarchy,$count);
                   14680:             $parent->{$depth} = $count;
1.1055    raeburn  14681:             $datatable .=
                   14682:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  14683:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   14684:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  14685:             $depth --;
1.1056    raeburn  14686:             pop(@hierarchy);
1.1055    raeburn  14687:         }
                   14688:     }
                   14689:     return ($count,$datatable);
                   14690: }
                   14691: 
                   14692: sub recurse_extracted_archive {
1.1056    raeburn  14693:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   14694:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  14695:     my $result='';
1.1056    raeburn  14696:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   14697:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   14698:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  14699:         return $result;
                   14700:     }
                   14701:     my $dirptr = 16384;
                   14702:     my ($newdirlistref,$newlisterror) =
                   14703:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   14704:     if (ref($newdirlistref) eq 'ARRAY') {
                   14705:         foreach my $dir_line (@{$newdirlistref}) {
                   14706:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   14707:             unless ($item =~ /^\.+$/) {
                   14708:                 $$count ++;
1.1056    raeburn  14709:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   14710:                 $titles->{$$count} = $item;
1.1055    raeburn  14711:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  14712: 
1.1055    raeburn  14713:                 my $is_dir;
                   14714:                 if ($dirptr&$testdir) {
                   14715:                     $is_dir = 1;
                   14716:                 }
                   14717:                 if ($wantform) {
                   14718:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   14719:                 }
                   14720:                 if ($is_dir) {
                   14721:                     $$depth ++;
1.1056    raeburn  14722:                     push(@{$hierarchy},$$count);
                   14723:                     $parent->{$$depth} = $$count;
1.1055    raeburn  14724:                     $result .=
                   14725:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   14726:                                                    $docuname,$depth,$count,
1.1056    raeburn  14727:                                                    $hierarchy,$dirorder,$children,
                   14728:                                                    $parent,$titles,$wantform);
1.1055    raeburn  14729:                     $$depth --;
1.1056    raeburn  14730:                     pop(@{$hierarchy});
1.1055    raeburn  14731:                 }
                   14732:             }
                   14733:         }
                   14734:     }
                   14735:     return $result;
                   14736: }
                   14737: 
                   14738: sub archive_hierarchy {
                   14739:     my ($depth,$count,$parent,$children) =@_;
                   14740:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   14741:         if (exists($parent->{$depth})) {
                   14742:              $children->{$parent->{$depth}} .= $count.':';
                   14743:         }
                   14744:     }
                   14745:     return;
                   14746: }
                   14747: 
                   14748: sub archive_row {
                   14749:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   14750:     my ($name) = ($item =~ m{([^/]+)$});
                   14751:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  14752:                                        'display'    => 'Add as file',
1.1055    raeburn  14753:                                        'dependency' => 'Include as dependency',
                   14754:                                        'discard'    => 'Discard',
                   14755:                                       );
                   14756:     if ($is_dir) {
1.1059    raeburn  14757:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  14758:     }
1.1056    raeburn  14759:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   14760:     my $offset = 0;
1.1055    raeburn  14761:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  14762:         $offset ++;
1.1065    raeburn  14763:         if ($action ne 'display') {
                   14764:             $offset ++;
                   14765:         }  
1.1055    raeburn  14766:         $output .= '<td><span class="LC_nobreak">'.
                   14767:                    '<label><input type="radio" name="archive_'.$count.
                   14768:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   14769:         my $text = $choices{$action};
                   14770:         if ($is_dir) {
                   14771:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   14772:             if ($action eq 'display') {
1.1059    raeburn  14773:                 $text = &mt('Add as folder');
1.1055    raeburn  14774:             }
1.1056    raeburn  14775:         } else {
                   14776:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   14777: 
                   14778:         }
                   14779:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   14780:         if ($action eq 'dependency') {
                   14781:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   14782:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   14783:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   14784:                        '<option value=""></option>'."\n".
                   14785:                        '</select>'."\n".
                   14786:                        '</div>';
1.1059    raeburn  14787:         } elsif ($action eq 'display') {
                   14788:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   14789:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   14790:                        '</div>';
1.1055    raeburn  14791:         }
1.1056    raeburn  14792:         $output .= '</td>';
1.1055    raeburn  14793:     }
                   14794:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   14795:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   14796:     for (my $i=0; $i<$depth; $i++) {
                   14797:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   14798:     }
                   14799:     if ($is_dir) {
                   14800:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   14801:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   14802:     } else {
                   14803:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   14804:     }
                   14805:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   14806:                &end_data_table_row();
                   14807:     return $output;
                   14808: }
                   14809: 
                   14810: sub archive_options_form {
1.1065    raeburn  14811:     my ($form,$display,$count,$hiddenelem) = @_;
                   14812:     my %lt = &Apache::lonlocal::texthash(
                   14813:                perm => 'Permanently remove archive file?',
                   14814:                hows => 'How should each extracted item be incorporated in the course?',
                   14815:                cont => 'Content actions for all',
                   14816:                addf => 'Add as folder/file',
                   14817:                incd => 'Include as dependency for a displayed file',
                   14818:                disc => 'Discard',
                   14819:                no   => 'No',
                   14820:                yes  => 'Yes',
                   14821:                save => 'Save',
                   14822:     );
                   14823:     my $output = <<"END";
                   14824: <form name="$form" method="post" action="">
                   14825: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   14826: <label>
                   14827:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   14828: </label>
                   14829: &nbsp;
                   14830: <label>
                   14831:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   14832: </span>
                   14833: </p>
                   14834: <input type="hidden" name="phase" value="decompress_cleanup" />
                   14835: <br />$lt{'hows'}
                   14836: <div class="LC_columnSection">
                   14837:   <fieldset>
                   14838:     <legend>$lt{'cont'}</legend>
                   14839:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   14840:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   14841:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   14842:   </fieldset>
                   14843: </div>
                   14844: END
                   14845:     return $output.
1.1055    raeburn  14846:            &start_data_table()."\n".
1.1065    raeburn  14847:            $display."\n".
1.1055    raeburn  14848:            &end_data_table()."\n".
                   14849:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   14850:            $hiddenelem.
1.1065    raeburn  14851:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  14852:            '</form>';
                   14853: }
                   14854: 
                   14855: sub archive_javascript {
1.1056    raeburn  14856:     my ($startcount,$numitems,$titles,$children) = @_;
                   14857:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  14858:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  14859:     my $scripttag = <<START;
                   14860: <script type="text/javascript">
                   14861: // <![CDATA[
                   14862: 
                   14863: function checkAll(form,prefix) {
                   14864:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   14865:     for (var i=0; i < form.elements.length; i++) {
                   14866:         var id = form.elements[i].id;
                   14867:         if ((id != '') && (id != undefined)) {
                   14868:             if (idstr.test(id)) {
                   14869:                 if (form.elements[i].type == 'radio') {
                   14870:                     form.elements[i].checked = true;
1.1056    raeburn  14871:                     var nostart = i-$startcount;
1.1059    raeburn  14872:                     var offset = nostart%7;
                   14873:                     var count = (nostart-offset)/7;    
1.1056    raeburn  14874:                     dependencyCheck(form,count,offset);
1.1055    raeburn  14875:                 }
                   14876:             }
                   14877:         }
                   14878:     }
                   14879: }
                   14880: 
                   14881: function propagateCheck(form,count) {
                   14882:     if (count > 0) {
1.1059    raeburn  14883:         var startelement = $startcount + ((count-1) * 7);
                   14884:         for (var j=1; j<6; j++) {
                   14885:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  14886:                 var item = startelement + j; 
                   14887:                 if (form.elements[item].type == 'radio') {
                   14888:                     if (form.elements[item].checked) {
                   14889:                         containerCheck(form,count,j);
                   14890:                         break;
                   14891:                     }
1.1055    raeburn  14892:                 }
                   14893:             }
                   14894:         }
                   14895:     }
                   14896: }
                   14897: 
                   14898: numitems = $numitems
1.1056    raeburn  14899: var titles = new Array(numitems);
                   14900: var parents = new Array(numitems);
1.1055    raeburn  14901: for (var i=0; i<numitems; i++) {
1.1056    raeburn  14902:     parents[i] = new Array;
1.1055    raeburn  14903: }
1.1059    raeburn  14904: var maintitle = '$maintitle';
1.1055    raeburn  14905: 
                   14906: START
                   14907: 
1.1056    raeburn  14908:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   14909:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  14910:         for (my $i=0; $i<@contents; $i ++) {
                   14911:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   14912:         }
                   14913:     }
                   14914: 
1.1056    raeburn  14915:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   14916:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   14917:     }
                   14918: 
1.1055    raeburn  14919:     $scripttag .= <<END;
                   14920: 
                   14921: function containerCheck(form,count,offset) {
                   14922:     if (count > 0) {
1.1056    raeburn  14923:         dependencyCheck(form,count,offset);
1.1059    raeburn  14924:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  14925:         form.elements[item].checked = true;
                   14926:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   14927:             if (parents[count].length > 0) {
                   14928:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  14929:                     containerCheck(form,parents[count][j],offset);
                   14930:                 }
                   14931:             }
                   14932:         }
                   14933:     }
                   14934: }
                   14935: 
                   14936: function dependencyCheck(form,count,offset) {
                   14937:     if (count > 0) {
1.1059    raeburn  14938:         var chosen = (offset+$startcount)+7*(count-1);
                   14939:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  14940:         var currtype = form.elements[depitem].type;
                   14941:         if (form.elements[chosen].value == 'dependency') {
                   14942:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   14943:             form.elements[depitem].options.length = 0;
                   14944:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085    raeburn  14945:             for (var i=1; i<=numitems; i++) {
                   14946:                 if (i == count) {
                   14947:                     continue;
                   14948:                 }
1.1059    raeburn  14949:                 var startelement = $startcount + (i-1) * 7;
                   14950:                 for (var j=1; j<6; j++) {
                   14951:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  14952:                         var item = startelement + j;
                   14953:                         if (form.elements[item].type == 'radio') {
                   14954:                             if (form.elements[item].checked) {
                   14955:                                 if (form.elements[item].value == 'display') {
                   14956:                                     var n = form.elements[depitem].options.length;
                   14957:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   14958:                                 }
                   14959:                             }
                   14960:                         }
                   14961:                     }
                   14962:                 }
                   14963:             }
                   14964:         } else {
                   14965:             document.getElementById('arc_depon_'+count).style.display='none';
                   14966:             form.elements[depitem].options.length = 0;
                   14967:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   14968:         }
1.1059    raeburn  14969:         titleCheck(form,count,offset);
1.1056    raeburn  14970:     }
                   14971: }
                   14972: 
                   14973: function propagateSelect(form,count,offset) {
                   14974:     if (count > 0) {
1.1065    raeburn  14975:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  14976:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   14977:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   14978:             if (parents[count].length > 0) {
                   14979:                 for (var j=0; j<parents[count].length; j++) {
                   14980:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  14981:                 }
                   14982:             }
                   14983:         }
                   14984:     }
                   14985: }
1.1056    raeburn  14986: 
                   14987: function containerSelect(form,count,offset,picked) {
                   14988:     if (count > 0) {
1.1065    raeburn  14989:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  14990:         if (form.elements[item].type == 'radio') {
                   14991:             if (form.elements[item].value == 'dependency') {
                   14992:                 if (form.elements[item+1].type == 'select-one') {
                   14993:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   14994:                         if (form.elements[item+1].options[i].value == picked) {
                   14995:                             form.elements[item+1].selectedIndex = i;
                   14996:                             break;
                   14997:                         }
                   14998:                     }
                   14999:                 }
                   15000:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   15001:                     if (parents[count].length > 0) {
                   15002:                         for (var j=0; j<parents[count].length; j++) {
                   15003:                             containerSelect(form,parents[count][j],offset,picked);
                   15004:                         }
                   15005:                     }
                   15006:                 }
                   15007:             }
                   15008:         }
                   15009:     }
                   15010: }
                   15011: 
1.1059    raeburn  15012: function titleCheck(form,count,offset) {
                   15013:     if (count > 0) {
                   15014:         var chosen = (offset+$startcount)+7*(count-1);
                   15015:         var depitem = $startcount + ((count-1) * 7) + 2;
                   15016:         var currtype = form.elements[depitem].type;
                   15017:         if (form.elements[chosen].value == 'display') {
                   15018:             document.getElementById('arc_title_'+count).style.display='block';
                   15019:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   15020:                 document.getElementById('archive_title_'+count).value=maintitle;
                   15021:             }
                   15022:         } else {
                   15023:             document.getElementById('arc_title_'+count).style.display='none';
                   15024:             if (currtype == 'text') { 
                   15025:                 document.getElementById('archive_title_'+count).value='';
                   15026:             }
                   15027:         }
                   15028:     }
                   15029:     return;
                   15030: }
                   15031: 
1.1055    raeburn  15032: // ]]>
                   15033: </script>
                   15034: END
                   15035:     return $scripttag;
                   15036: }
                   15037: 
                   15038: sub process_extracted_files {
1.1067    raeburn  15039:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  15040:     my $numitems = $env{'form.archive_count'};
1.1294    raeburn  15041:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  15042:     my @ids=&Apache::lonnet::current_machine_ids();
                   15043:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  15044:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  15045:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   15046:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   15047:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   15048:         $pathtocheck = "$dir_root/$destination";
                   15049:         $dir = $dir_root;
                   15050:         $ishome = 1;
                   15051:     } else {
                   15052:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   15053:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294    raeburn  15054:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  15055:     }
                   15056:     my $currdir = "$dir_root/$destination";
                   15057:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   15058:     if ($env{'form.folderpath'}) {
                   15059:         my @items = split('&',$env{'form.folderpath'});
                   15060:         $folders{'0'} = $items[-2];
1.1099    raeburn  15061:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   15062:             $containers{'0'}='page';
                   15063:         } else {  
                   15064:             $containers{'0'}='sequence';
                   15065:         }
1.1055    raeburn  15066:     }
                   15067:     my @archdirs = &get_env_multiple('form.archive_directory');
                   15068:     if ($numitems) {
                   15069:         for (my $i=1; $i<=$numitems; $i++) {
                   15070:             my $path = $env{'form.archive_content_'.$i};
                   15071:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   15072:                 my $item = $1;
                   15073:                 $toplevelitems{$item} = $i;
                   15074:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   15075:                     $is_dir{$item} = 1;
                   15076:                 }
                   15077:             }
                   15078:         }
                   15079:     }
1.1067    raeburn  15080:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  15081:     if (keys(%toplevelitems) > 0) {
                   15082:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  15083:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   15084:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  15085:     }
1.1066    raeburn  15086:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  15087:     if ($numitems) {
                   15088:         for (my $i=1; $i<=$numitems; $i++) {
1.1086    raeburn  15089:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  15090:             my $path = $env{'form.archive_content_'.$i};
                   15091:             if ($path =~ /^\Q$pathtocheck\E/) {
                   15092:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   15093:                     if ($prefix ne '' && $path ne '') {
                   15094:                         if (-e $prefix.$path) {
1.1066    raeburn  15095:                             if ((@archdirs > 0) && 
                   15096:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   15097:                                 $todeletedir{$prefix.$path} = 1;
                   15098:                             } else {
                   15099:                                 $todelete{$prefix.$path} = 1;
                   15100:                             }
1.1055    raeburn  15101:                         }
                   15102:                     }
                   15103:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  15104:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  15105:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  15106:                     $docstitle = $env{'form.archive_title_'.$i};
                   15107:                     if ($docstitle eq '') {
                   15108:                         $docstitle = $title;
                   15109:                     }
1.1055    raeburn  15110:                     $outer = 0;
1.1056    raeburn  15111:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   15112:                         if (@{$dirorder{$i}} > 0) {
                   15113:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  15114:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   15115:                                     $outer = $item;
                   15116:                                     last;
                   15117:                                 }
                   15118:                             }
                   15119:                         }
                   15120:                     }
                   15121:                     my ($errtext,$fatal) = 
                   15122:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   15123:                                                '/'.$folders{$outer}.'.'.
                   15124:                                                $containers{$outer});
                   15125:                     next if ($fatal);
                   15126:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   15127:                         if ($context eq 'coursedocs') {
1.1056    raeburn  15128:                             $mapinner{$i} = time;
1.1055    raeburn  15129:                             $folders{$i} = 'default_'.$mapinner{$i};
                   15130:                             $containers{$i} = 'sequence';
                   15131:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   15132:                                       $folders{$i}.'.'.$containers{$i};
                   15133:                             my $newidx = &LONCAPA::map::getresidx();
                   15134:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  15135:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  15136:                             push(@LONCAPA::map::order,$newidx);
                   15137:                             my ($outtext,$errtext) =
                   15138:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   15139:                                                         $docuname.'/'.$folders{$outer}.
1.1087    raeburn  15140:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  15141:                             $newseqid{$i} = $newidx;
1.1067    raeburn  15142:                             unless ($errtext) {
1.1294    raeburn  15143:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   15144:                                                        &HTML::Entities::encode($docstitle,'<>&"')).
                   15145:                                             '</li>'."\n";
1.1067    raeburn  15146:                             }
1.1055    raeburn  15147:                         }
                   15148:                     } else {
                   15149:                         if ($context eq 'coursedocs') {
                   15150:                             my $newidx=&LONCAPA::map::getresidx();
                   15151:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   15152:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   15153:                                       $title;
1.1392    raeburn  15154:                             if (($outer !~ /\D/) &&
                   15155:                                 (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
                   15156:                                 ($newidx !~ /\D/)) {
1.1294    raeburn  15157:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   15158:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
                   15159:                                 }
                   15160:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   15161:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   15162:                                 }
                   15163:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   15164:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   15165:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   15166:                                         unless ($ishome) {
                   15167:                                             my $fetch = "$newdest{$i}/$title";
                   15168:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   15169:                                             $prompttofetch{$fetch} = 1;
                   15170:                                         }
1.1292    raeburn  15171:                                     }
1.1067    raeburn  15172:                                 }
1.1294    raeburn  15173:                                 $LONCAPA::map::resources[$newidx]=
                   15174:                                     $docstitle.':'.$url.':false:normal:res';
                   15175:                                 push(@LONCAPA::map::order, $newidx);
                   15176:                                 my ($outtext,$errtext)=
                   15177:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   15178:                                                             $docuname.'/'.$folders{$outer}.
                   15179:                                                             '.'.$containers{$outer},1,1);
                   15180:                                 unless ($errtext) {
                   15181:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   15182:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   15183:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   15184:                                                    '</li>'."\n";
                   15185:                                     }
1.1067    raeburn  15186:                                 }
1.1294    raeburn  15187:                             } else {
                   15188:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   15189:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296    raeburn  15190:                             }
1.1055    raeburn  15191:                         }
                   15192:                     }
1.1086    raeburn  15193:                 }
                   15194:             } else {
1.1294    raeburn  15195:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   15196:                                 &HTML::Entities::encode($path,'<>&"')).'<br />'; 
1.1086    raeburn  15197:             }
                   15198:         }
                   15199:         for (my $i=1; $i<=$numitems; $i++) {
                   15200:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   15201:             my $path = $env{'form.archive_content_'.$i};
                   15202:             if ($path =~ /^\Q$pathtocheck\E/) {
                   15203:                 my ($title) = ($path =~ m{/([^/]+)$});
                   15204:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   15205:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   15206:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   15207:                         my ($itemidx,$fullpath,$relpath);
                   15208:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   15209:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  15210:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086    raeburn  15211:                                 if ($dirorder{$i}->[$j] eq $container) {
                   15212:                                     $itemidx = $j;
1.1056    raeburn  15213:                                 }
                   15214:                             }
1.1086    raeburn  15215:                         }
                   15216:                         if ($itemidx eq '') {
                   15217:                             $itemidx =  0;
                   15218:                         } 
                   15219:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   15220:                             if ($mapinner{$referrer{$i}}) {
                   15221:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   15222:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   15223:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   15224:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   15225:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   15226:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   15227:                                             if (!-e $fullpath) {
                   15228:                                                 mkdir($fullpath,0755);
1.1056    raeburn  15229:                                             }
                   15230:                                         }
1.1086    raeburn  15231:                                     } else {
                   15232:                                         last;
1.1056    raeburn  15233:                                     }
1.1086    raeburn  15234:                                 }
                   15235:                             }
                   15236:                         } elsif ($newdest{$referrer{$i}}) {
                   15237:                             $fullpath = $newdest{$referrer{$i}};
                   15238:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   15239:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   15240:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   15241:                                     last;
                   15242:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   15243:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   15244:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   15245:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   15246:                                         if (!-e $fullpath) {
                   15247:                                             mkdir($fullpath,0755);
1.1056    raeburn  15248:                                         }
                   15249:                                     }
1.1086    raeburn  15250:                                 } else {
                   15251:                                     last;
1.1056    raeburn  15252:                                 }
1.1055    raeburn  15253:                             }
                   15254:                         }
1.1086    raeburn  15255:                         if ($fullpath ne '') {
                   15256:                             if (-e "$prefix$path") {
1.1292    raeburn  15257:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   15258:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   15259:                                 }
1.1086    raeburn  15260:                             }
                   15261:                             if (-e "$fullpath/$title") {
                   15262:                                 my $showpath;
                   15263:                                 if ($relpath ne '') {
                   15264:                                     $showpath = "$relpath/$title";
                   15265:                                 } else {
                   15266:                                     $showpath = "/$title";
                   15267:                                 } 
1.1294    raeburn  15268:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   15269:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   15270:                                            '</li>'."\n";
1.1292    raeburn  15271:                                 unless ($ishome) {
                   15272:                                     my $fetch = "$fullpath/$title";
                   15273:                                     $fetch =~ s/^\Q$prefix$dir\E//; 
                   15274:                                     $prompttofetch{$fetch} = 1;
                   15275:                                 }
1.1086    raeburn  15276:                             }
                   15277:                         }
1.1055    raeburn  15278:                     }
1.1086    raeburn  15279:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   15280:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294    raeburn  15281:                                     &HTML::Entities::encode($path,'<>&"'),
                   15282:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   15283:                                 '<br />';
1.1055    raeburn  15284:                 }
                   15285:             } else {
1.1294    raeburn  15286:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296    raeburn  15287:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  15288:             }
                   15289:         }
                   15290:         if (keys(%todelete)) {
                   15291:             foreach my $key (keys(%todelete)) {
                   15292:                 unlink($key);
1.1066    raeburn  15293:             }
                   15294:         }
                   15295:         if (keys(%todeletedir)) {
                   15296:             foreach my $key (keys(%todeletedir)) {
                   15297:                 rmdir($key);
                   15298:             }
                   15299:         }
                   15300:         foreach my $dir (sort(keys(%is_dir))) {
                   15301:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   15302:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  15303:             }
                   15304:         }
1.1067    raeburn  15305:         if ($result ne '') {
                   15306:             $output .= '<ul>'."\n".
                   15307:                        $result."\n".
                   15308:                        '</ul>';
                   15309:         }
                   15310:         unless ($ishome) {
                   15311:             my $replicationfail;
                   15312:             foreach my $item (keys(%prompttofetch)) {
                   15313:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   15314:                 unless ($fetchresult eq 'ok') {
                   15315:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   15316:                 }
                   15317:             }
                   15318:             if ($replicationfail) {
                   15319:                 $output .= '<p class="LC_error">'.
                   15320:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   15321:                            $replicationfail.
                   15322:                            '</ul></p>';
                   15323:             }
                   15324:         }
1.1055    raeburn  15325:     } else {
                   15326:         $warning = &mt('No items found in archive.');
                   15327:     }
                   15328:     if ($error) {
                   15329:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   15330:                    $error.'</p>'."\n";
                   15331:     }
                   15332:     if ($warning) {
                   15333:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   15334:     }
                   15335:     return $output;
                   15336: }
                   15337: 
1.1066    raeburn  15338: sub cleanup_empty_dirs {
                   15339:     my ($path) = @_;
                   15340:     if (($path ne '') && (-d $path)) {
                   15341:         if (opendir(my $dirh,$path)) {
                   15342:             my @dircontents = grep(!/^\./,readdir($dirh));
                   15343:             my $numitems = 0;
                   15344:             foreach my $item (@dircontents) {
                   15345:                 if (-d "$path/$item") {
1.1111    raeburn  15346:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  15347:                     if (-e "$path/$item") {
                   15348:                         $numitems ++;
                   15349:                     }
                   15350:                 } else {
                   15351:                     $numitems ++;
                   15352:                 }
                   15353:             }
                   15354:             if ($numitems == 0) {
                   15355:                 rmdir($path);
                   15356:             }
                   15357:             closedir($dirh);
                   15358:         }
                   15359:     }
                   15360:     return;
                   15361: }
                   15362: 
1.41      ng       15363: =pod
1.45      matthew  15364: 
1.1162    raeburn  15365: =item * &get_folder_hierarchy()
1.1068    raeburn  15366: 
                   15367: Provides hierarchy of names of folders/sub-folders containing the current
                   15368: item,
                   15369: 
                   15370: Inputs: 3
                   15371:      - $navmap - navmaps object
                   15372: 
                   15373:      - $map - url for map (either the trigger itself, or map containing
                   15374:                            the resource, which is the trigger).
                   15375: 
                   15376:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   15377: 
                   15378: Outputs: 1 @pathitems - array of folder/subfolder names.
                   15379: 
                   15380: =cut
                   15381: 
                   15382: sub get_folder_hierarchy {
                   15383:     my ($navmap,$map,$showitem) = @_;
                   15384:     my @pathitems;
                   15385:     if (ref($navmap)) {
                   15386:         my $mapres = $navmap->getResourceByUrl($map);
                   15387:         if (ref($mapres)) {
                   15388:             my $pcslist = $mapres->map_hierarchy();
                   15389:             if ($pcslist ne '') {
                   15390:                 my @pcs = split(/,/,$pcslist);
                   15391:                 foreach my $pc (@pcs) {
                   15392:                     if ($pc == 1) {
1.1129    raeburn  15393:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  15394:                     } else {
                   15395:                         my $res = $navmap->getByMapPc($pc);
                   15396:                         if (ref($res)) {
                   15397:                             my $title = $res->compTitle();
                   15398:                             $title =~ s/\W+/_/g;
                   15399:                             if ($title ne '') {
                   15400:                                 push(@pathitems,$title);
                   15401:                             }
                   15402:                         }
                   15403:                     }
                   15404:                 }
                   15405:             }
1.1071    raeburn  15406:             if ($showitem) {
                   15407:                 if ($mapres->{ID} eq '0.0') {
1.1129    raeburn  15408:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  15409:                 } else {
                   15410:                     my $maptitle = $mapres->compTitle();
                   15411:                     $maptitle =~ s/\W+/_/g;
                   15412:                     if ($maptitle ne '') {
                   15413:                         push(@pathitems,$maptitle);
                   15414:                     }
1.1068    raeburn  15415:                 }
                   15416:             }
                   15417:         }
                   15418:     }
                   15419:     return @pathitems;
                   15420: }
                   15421: 
                   15422: =pod
                   15423: 
1.1015    raeburn  15424: =item * &get_turnedin_filepath()
                   15425: 
                   15426: Determines path in a user's portfolio file for storage of files uploaded
                   15427: to a specific essayresponse or dropbox item.
                   15428: 
                   15429: Inputs: 3 required + 1 optional.
                   15430: $symb is symb for resource, $uname and $udom are for current user (required).
                   15431: $caller is optional (can be "submission", if routine is called when storing
                   15432: an upoaded file when "Submit Answer" button was pressed).
                   15433: 
                   15434: Returns array containing $path and $multiresp. 
                   15435: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   15436: than one file upload item.  Callers of routine should append partid as a 
                   15437: subdirectory to $path in cases where $multiresp is 1.
                   15438: 
                   15439: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   15440: 
                   15441: =cut
                   15442: 
                   15443: sub get_turnedin_filepath {
                   15444:     my ($symb,$uname,$udom,$caller) = @_;
                   15445:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   15446:     my $turnindir;
                   15447:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   15448:     $turnindir = $userhash{'turnindir'};
                   15449:     my ($path,$multiresp);
                   15450:     if ($turnindir eq '') {
                   15451:         if ($caller eq 'submission') {
                   15452:             $turnindir = &mt('turned in');
                   15453:             $turnindir =~ s/\W+/_/g;
                   15454:             my %newhash = (
                   15455:                             'turnindir' => $turnindir,
                   15456:                           );
                   15457:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   15458:         }
                   15459:     }
                   15460:     if ($turnindir ne '') {
                   15461:         $path = '/'.$turnindir.'/';
                   15462:         my ($multipart,$turnin,@pathitems);
                   15463:         my $navmap = Apache::lonnavmaps::navmap->new();
                   15464:         if (defined($navmap)) {
                   15465:             my $mapres = $navmap->getResourceByUrl($map);
                   15466:             if (ref($mapres)) {
                   15467:                 my $pcslist = $mapres->map_hierarchy();
                   15468:                 if ($pcslist ne '') {
                   15469:                     foreach my $pc (split(/,/,$pcslist)) {
                   15470:                         my $res = $navmap->getByMapPc($pc);
                   15471:                         if (ref($res)) {
                   15472:                             my $title = $res->compTitle();
                   15473:                             $title =~ s/\W+/_/g;
                   15474:                             if ($title ne '') {
1.1149    raeburn  15475:                                 if (($pc > 1) && (length($title) > 12)) {
                   15476:                                     $title = substr($title,0,12);
                   15477:                                 }
1.1015    raeburn  15478:                                 push(@pathitems,$title);
                   15479:                             }
                   15480:                         }
                   15481:                     }
                   15482:                 }
                   15483:                 my $maptitle = $mapres->compTitle();
                   15484:                 $maptitle =~ s/\W+/_/g;
                   15485:                 if ($maptitle ne '') {
1.1149    raeburn  15486:                     if (length($maptitle) > 12) {
                   15487:                         $maptitle = substr($maptitle,0,12);
                   15488:                     }
1.1015    raeburn  15489:                     push(@pathitems,$maptitle);
                   15490:                 }
                   15491:                 unless ($env{'request.state'} eq 'construct') {
                   15492:                     my $res = $navmap->getBySymb($symb);
                   15493:                     if (ref($res)) {
                   15494:                         my $partlist = $res->parts();
                   15495:                         my $totaluploads = 0;
                   15496:                         if (ref($partlist) eq 'ARRAY') {
                   15497:                             foreach my $part (@{$partlist}) {
                   15498:                                 my @types = $res->responseType($part);
                   15499:                                 my @ids = $res->responseIds($part);
                   15500:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   15501:                                     if ($types[$i] eq 'essay') {
                   15502:                                         my $partid = $part.'_'.$ids[$i];
                   15503:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   15504:                                             $totaluploads ++;
                   15505:                                         }
                   15506:                                     }
                   15507:                                 }
                   15508:                             }
                   15509:                             if ($totaluploads > 1) {
                   15510:                                 $multiresp = 1;
                   15511:                             }
                   15512:                         }
                   15513:                     }
                   15514:                 }
                   15515:             } else {
                   15516:                 return;
                   15517:             }
                   15518:         } else {
                   15519:             return;
                   15520:         }
                   15521:         my $restitle=&Apache::lonnet::gettitle($symb);
                   15522:         $restitle =~ s/\W+/_/g;
                   15523:         if ($restitle eq '') {
                   15524:             $restitle = ($resurl =~ m{/[^/]+$});
                   15525:             if ($restitle eq '') {
                   15526:                 $restitle = time;
                   15527:             }
                   15528:         }
1.1149    raeburn  15529:         if (length($restitle) > 12) {
                   15530:             $restitle = substr($restitle,0,12);
                   15531:         }
1.1015    raeburn  15532:         push(@pathitems,$restitle);
                   15533:         $path .= join('/',@pathitems);
                   15534:     }
                   15535:     return ($path,$multiresp);
                   15536: }
                   15537: 
                   15538: =pod
                   15539: 
1.464     albertel 15540: =back
1.41      ng       15541: 
1.112     bowersj2 15542: =head1 CSV Upload/Handling functions
1.38      albertel 15543: 
1.41      ng       15544: =over 4
                   15545: 
1.648     raeburn  15546: =item * &upfile_store($r)
1.41      ng       15547: 
                   15548: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 15549: needs $env{'form.upfile'}
1.41      ng       15550: returns $datatoken to be put into hidden field
                   15551: 
                   15552: =cut
1.31      albertel 15553: 
                   15554: sub upfile_store {
                   15555:     my $r=shift;
1.258     albertel 15556:     $env{'form.upfile'}=~s/\r/\n/gs;
                   15557:     $env{'form.upfile'}=~s/\f/\n/gs;
                   15558:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   15559:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 15560: 
1.1299    raeburn  15561:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   15562:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   15563:                                      time.'_'.$$);
                   15564:     return if ($datatoken eq '');
                   15565: 
1.31      albertel 15566:     {
1.158     raeburn  15567:         my $datafile = $r->dir_config('lonDaemons').
                   15568:                            '/tmp/'.$datatoken.'.tmp';
1.1317    raeburn  15569:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 15570:             print $fh $env{'form.upfile'};
1.158     raeburn  15571:             close($fh);
                   15572:         }
1.31      albertel 15573:     }
                   15574:     return $datatoken;
                   15575: }
                   15576: 
1.56      matthew  15577: =pod
                   15578: 
1.1290    raeburn  15579: =item * &load_tmp_file($r,$datatoken)
1.41      ng       15580: 
                   15581: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290    raeburn  15582: $datatoken is the name to assign to the temporary file.
1.258     albertel 15583: sets $env{'form.upfile'} to the contents of the file
1.41      ng       15584: 
                   15585: =cut
1.31      albertel 15586: 
                   15587: sub load_tmp_file {
1.1290    raeburn  15588:     my ($r,$datatoken) = @_;
                   15589:     return if ($datatoken eq '');
1.31      albertel 15590:     my @studentdata=();
                   15591:     {
1.158     raeburn  15592:         my $studentfile = $r->dir_config('lonDaemons').
1.1290    raeburn  15593:                               '/tmp/'.$datatoken.'.tmp';
1.1317    raeburn  15594:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  15595:             @studentdata=<$fh>;
                   15596:             close($fh);
                   15597:         }
1.31      albertel 15598:     }
1.258     albertel 15599:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 15600: }
                   15601: 
1.1290    raeburn  15602: sub valid_datatoken {
                   15603:     my ($datatoken) = @_;
1.1325    raeburn  15604:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290    raeburn  15605:         return $datatoken;
                   15606:     }
                   15607:     return;
                   15608: }
                   15609: 
1.56      matthew  15610: =pod
                   15611: 
1.648     raeburn  15612: =item * &upfile_record_sep()
1.41      ng       15613: 
                   15614: Separate uploaded file into records
                   15615: returns array of records,
1.258     albertel 15616: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       15617: 
                   15618: =cut
1.31      albertel 15619: 
                   15620: sub upfile_record_sep {
1.258     albertel 15621:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 15622:     } else {
1.248     albertel 15623: 	my @records;
1.258     albertel 15624: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 15625: 	    if ($line=~/^\s*$/) { next; }
                   15626: 	    push(@records,$line);
                   15627: 	}
                   15628: 	return @records;
1.31      albertel 15629:     }
                   15630: }
                   15631: 
1.56      matthew  15632: =pod
                   15633: 
1.648     raeburn  15634: =item * &record_sep($record)
1.41      ng       15635: 
1.258     albertel 15636: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       15637: 
                   15638: =cut
                   15639: 
1.263     www      15640: sub takeleft {
                   15641:     my $index=shift;
                   15642:     return substr('0000'.$index,-4,4);
                   15643: }
                   15644: 
1.31      albertel 15645: sub record_sep {
                   15646:     my $record=shift;
                   15647:     my %components=();
1.258     albertel 15648:     if ($env{'form.upfiletype'} eq 'xml') {
                   15649:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 15650:         my $i=0;
1.356     albertel 15651:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 15652:             $field=~s/^(\"|\')//;
                   15653:             $field=~s/(\"|\')$//;
1.263     www      15654:             $components{&takeleft($i)}=$field;
1.31      albertel 15655:             $i++;
                   15656:         }
1.258     albertel 15657:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 15658:         my $i=0;
1.356     albertel 15659:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 15660:             $field=~s/^(\"|\')//;
                   15661:             $field=~s/(\"|\')$//;
1.263     www      15662:             $components{&takeleft($i)}=$field;
1.31      albertel 15663:             $i++;
                   15664:         }
                   15665:     } else {
1.561     www      15666:         my $separator=',';
1.480     banghart 15667:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      15668:             $separator=';';
1.480     banghart 15669:         }
1.31      albertel 15670:         my $i=0;
1.561     www      15671: # the character we are looking for to indicate the end of a quote or a record 
                   15672:         my $looking_for=$separator;
                   15673: # do not add the characters to the fields
                   15674:         my $ignore=0;
                   15675: # we just encountered a separator (or the beginning of the record)
                   15676:         my $just_found_separator=1;
                   15677: # store the field we are working on here
                   15678:         my $field='';
                   15679: # work our way through all characters in record
                   15680:         foreach my $character ($record=~/(.)/g) {
                   15681:             if ($character eq $looking_for) {
                   15682:                if ($character ne $separator) {
                   15683: # Found the end of a quote, again looking for separator
                   15684:                   $looking_for=$separator;
                   15685:                   $ignore=1;
                   15686:                } else {
                   15687: # Found a separator, store away what we got
                   15688:                   $components{&takeleft($i)}=$field;
                   15689: 	          $i++;
                   15690:                   $just_found_separator=1;
                   15691:                   $ignore=0;
                   15692:                   $field='';
                   15693:                }
                   15694:                next;
                   15695:             }
                   15696: # single or double quotation marks after a separator indicate beginning of a quote
                   15697: # we are now looking for the end of the quote and need to ignore separators
                   15698:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   15699:                $looking_for=$character;
                   15700:                next;
                   15701:             }
                   15702: # ignore would be true after we reached the end of a quote
                   15703:             if ($ignore) { next; }
                   15704:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   15705:             $field.=$character;
                   15706:             $just_found_separator=0; 
1.31      albertel 15707:         }
1.561     www      15708: # catch the very last entry, since we never encountered the separator
                   15709:         $components{&takeleft($i)}=$field;
1.31      albertel 15710:     }
                   15711:     return %components;
                   15712: }
                   15713: 
1.144     matthew  15714: ######################################################
                   15715: ######################################################
                   15716: 
1.56      matthew  15717: =pod
                   15718: 
1.648     raeburn  15719: =item * &upfile_select_html()
1.41      ng       15720: 
1.144     matthew  15721: Return HTML code to select a file from the users machine and specify 
                   15722: the file type.
1.41      ng       15723: 
                   15724: =cut
                   15725: 
1.144     matthew  15726: ######################################################
                   15727: ######################################################
1.31      albertel 15728: sub upfile_select_html {
1.144     matthew  15729:     my %Types = (
                   15730:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 15731:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  15732:                  space => &mt('Space separated'),
                   15733:                  tab   => &mt('Tabulator separated'),
                   15734: #                 xml   => &mt('HTML/XML'),
                   15735:                  );
1.1473    raeburn  15736:     my $Str = '<input type="file" name="upfile" id="upfile" size="50" />'.
                   15737:         '<br /><label>'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  15738:     foreach my $type (sort(keys(%Types))) {
                   15739:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   15740:     }
1.1473    raeburn  15741:     $Str .= "</select></label>\n";
1.144     matthew  15742:     return $Str;
1.31      albertel 15743: }
                   15744: 
1.301     albertel 15745: sub get_samples {
                   15746:     my ($records,$toget) = @_;
                   15747:     my @samples=({});
                   15748:     my $got=0;
                   15749:     foreach my $rec (@$records) {
                   15750: 	my %temp = &record_sep($rec);
                   15751: 	if (! grep(/\S/, values(%temp))) { next; }
                   15752: 	if (%temp) {
                   15753: 	    $samples[$got]=\%temp;
                   15754: 	    $got++;
                   15755: 	    if ($got == $toget) { last; }
                   15756: 	}
                   15757:     }
                   15758:     return \@samples;
                   15759: }
                   15760: 
1.144     matthew  15761: ######################################################
                   15762: ######################################################
                   15763: 
1.56      matthew  15764: =pod
                   15765: 
1.648     raeburn  15766: =item * &csv_print_samples($r,$records)
1.41      ng       15767: 
                   15768: Prints a table of sample values from each column uploaded $r is an
                   15769: Apache Request ref, $records is an arrayref from
                   15770: &Apache::loncommon::upfile_record_sep
                   15771: 
                   15772: =cut
                   15773: 
1.144     matthew  15774: ######################################################
                   15775: ######################################################
1.31      albertel 15776: sub csv_print_samples {
                   15777:     my ($r,$records) = @_;
1.662     bisitz   15778:     my $samples = &get_samples($records,5);
1.301     albertel 15779: 
1.594     raeburn  15780:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   15781:               &start_data_table_header_row());
1.356     albertel 15782:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   15783:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  15784:     $r->print(&end_data_table_header_row());
1.301     albertel 15785:     foreach my $hash (@$samples) {
1.594     raeburn  15786: 	$r->print(&start_data_table_row());
1.356     albertel 15787: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 15788: 	    $r->print('<td>');
1.356     albertel 15789: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 15790: 	    $r->print('</td>');
                   15791: 	}
1.594     raeburn  15792: 	$r->print(&end_data_table_row());
1.31      albertel 15793:     }
1.594     raeburn  15794:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 15795: }
                   15796: 
1.144     matthew  15797: ######################################################
                   15798: ######################################################
                   15799: 
1.56      matthew  15800: =pod
                   15801: 
1.648     raeburn  15802: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       15803: 
                   15804: Prints a table to create associations between values and table columns.
1.144     matthew  15805: 
1.41      ng       15806: $r is an Apache Request ref,
                   15807: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  15808: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       15809: 
                   15810: =cut
                   15811: 
1.144     matthew  15812: ######################################################
                   15813: ######################################################
1.31      albertel 15814: sub csv_print_select_table {
                   15815:     my ($r,$records,$d) = @_;
1.301     albertel 15816:     my $i=0;
                   15817:     my $samples = &get_samples($records,1);
1.144     matthew  15818:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  15819: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  15820:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  15821:               '<th>'.&mt('Column').'</th>'.
                   15822:               &end_data_table_header_row()."\n");
1.356     albertel 15823:     foreach my $array_ref (@$d) {
                   15824: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.1473    raeburn  15825: 	$r->print(&start_data_table_row().'<td><label for="f'.$i.'">'.$display.'</label></td>');
1.31      albertel 15826: 
1.1473    raeburn  15827: 	$r->print('<td><select name="f'.$i.'" id="f'.$i.'"'.
1.32      matthew  15828: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 15829: 	$r->print('<option value="none"></option>');
1.356     albertel 15830: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   15831: 	    $r->print('<option value="'.$sample.'"'.
                   15832:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   15833:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 15834: 	}
1.594     raeburn  15835: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 15836: 	$i++;
                   15837:     }
1.594     raeburn  15838:     $r->print(&end_data_table());
1.31      albertel 15839:     $i--;
                   15840:     return $i;
                   15841: }
1.56      matthew  15842: 
1.144     matthew  15843: ######################################################
                   15844: ######################################################
                   15845: 
1.56      matthew  15846: =pod
1.31      albertel 15847: 
1.648     raeburn  15848: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       15849: 
                   15850: Prints a table of sample values from the upload and can make associate samples to internal names.
                   15851: 
                   15852: $r is an Apache Request ref,
                   15853: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   15854: $d is an array of 2 element arrays (internal name, displayed name)
                   15855: 
                   15856: =cut
                   15857: 
1.144     matthew  15858: ######################################################
                   15859: ######################################################
1.31      albertel 15860: sub csv_samples_select_table {
                   15861:     my ($r,$records,$d) = @_;
                   15862:     my $i=0;
1.144     matthew  15863:     #
1.662     bisitz   15864:     my $max_samples = 5;
                   15865:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  15866:     $r->print(&start_data_table().
                   15867:               &start_data_table_header_row().'<th>'.
                   15868:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   15869:               &end_data_table_header_row());
1.301     albertel 15870: 
                   15871:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.1473    raeburn  15872:         my $num = $i+1;
                   15873:         my $labeltext = &HTML::Entities::encode(&mt('Field for data in column [_1]',$num));
1.594     raeburn  15874: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.1473    raeburn  15875: 		  ' onchange="javascript:flip(this.form,'.$i.');" aria-label="'.$labeltext.'">');
1.301     albertel 15876: 	foreach my $option (@$d) {
                   15877: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  15878: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 15879:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  15880:                       $display.'</option>');
1.31      albertel 15881: 	}
                   15882: 	$r->print('</select></td><td>');
1.662     bisitz   15883: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 15884: 	    if (defined($samples->[$line]{$key})) { 
                   15885: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   15886: 	    }
                   15887: 	}
1.594     raeburn  15888: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 15889: 	$i++;
                   15890:     }
1.594     raeburn  15891:     $r->print(&end_data_table());
1.31      albertel 15892:     $i--;
                   15893:     return($i);
1.115     matthew  15894: }
                   15895: 
1.144     matthew  15896: ######################################################
                   15897: ######################################################
                   15898: 
1.115     matthew  15899: =pod
                   15900: 
1.648     raeburn  15901: =item * &clean_excel_name($name)
1.115     matthew  15902: 
                   15903: Returns a replacement for $name which does not contain any illegal characters.
                   15904: 
                   15905: =cut
                   15906: 
1.144     matthew  15907: ######################################################
                   15908: ######################################################
1.115     matthew  15909: sub clean_excel_name {
                   15910:     my ($name) = @_;
                   15911:     $name =~ s/[:\*\?\/\\]//g;
                   15912:     if (length($name) > 31) {
                   15913:         $name = substr($name,0,31);
                   15914:     }
                   15915:     return $name;
1.25      albertel 15916: }
1.84      albertel 15917: 
1.85      albertel 15918: =pod
                   15919: 
1.648     raeburn  15920: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 15921: 
                   15922: Returns either 1 or undef
                   15923: 
                   15924: 1 if the part is to be hidden, undef if it is to be shown
                   15925: 
                   15926: Arguments are:
                   15927: 
                   15928: $id the id of the part to be checked
                   15929: $symb, optional the symb of the resource to check
                   15930: $udom, optional the domain of the user to check for
                   15931: $uname, optional the username of the user to check for
                   15932: 
                   15933: =cut
1.84      albertel 15934: 
                   15935: sub check_if_partid_hidden {
                   15936:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 15937:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 15938: 					 $symb,$udom,$uname);
1.141     albertel 15939:     my $truth=1;
                   15940:     #if the string starts with !, then the list is the list to show not hide
                   15941:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 15942:     my @hiddenlist=split(/,/,$hiddenparts);
                   15943:     foreach my $checkid (@hiddenlist) {
1.141     albertel 15944: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 15945:     }
1.141     albertel 15946:     return !$truth;
1.84      albertel 15947: }
1.127     matthew  15948: 
1.138     matthew  15949: 
                   15950: ############################################################
                   15951: ############################################################
                   15952: 
                   15953: =pod
                   15954: 
1.157     matthew  15955: =back 
                   15956: 
1.138     matthew  15957: =head1 cgi-bin script and graphing routines
                   15958: 
1.157     matthew  15959: =over 4
                   15960: 
1.648     raeburn  15961: =item * &get_cgi_id()
1.138     matthew  15962: 
                   15963: Inputs: none
                   15964: 
                   15965: Returns an id which can be used to pass environment variables
                   15966: to various cgi-bin scripts.  These environment variables will
                   15967: be removed from the users environment after a given time by
                   15968: the routine &Apache::lonnet::transfer_profile_to_env.
                   15969: 
                   15970: =cut
                   15971: 
                   15972: ############################################################
                   15973: ############################################################
1.152     albertel 15974: my $uniq=0;
1.136     matthew  15975: sub get_cgi_id {
1.154     albertel 15976:     $uniq=($uniq+1)%100000;
1.280     albertel 15977:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  15978: }
                   15979: 
1.127     matthew  15980: ############################################################
                   15981: ############################################################
                   15982: 
                   15983: =pod
                   15984: 
1.648     raeburn  15985: =item * &DrawBarGraph()
1.127     matthew  15986: 
1.138     matthew  15987: Facilitates the plotting of data in a (stacked) bar graph.
                   15988: Puts plot definition data into the users environment in order for 
                   15989: graph.png to plot it.  Returns an <img> tag for the plot.
                   15990: The bars on the plot are labeled '1','2',...,'n'.
                   15991: 
                   15992: Inputs:
                   15993: 
                   15994: =over 4
                   15995: 
                   15996: =item $Title: string, the title of the plot
                   15997: 
                   15998: =item $xlabel: string, text describing the X-axis of the plot
                   15999: 
                   16000: =item $ylabel: string, text describing the Y-axis of the plot
                   16001: 
                   16002: =item $Max: scalar, the maximum Y value to use in the plot
                   16003: If $Max is < any data point, the graph will not be rendered.
                   16004: 
1.140     matthew  16005: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  16006: they are plotted.  If undefined, default values will be used.
                   16007: 
1.178     matthew  16008: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   16009: 
1.138     matthew  16010: =item @Values: An array of array references.  Each array reference holds data
                   16011: to be plotted in a stacked bar chart.
                   16012: 
1.239     matthew  16013: =item If the final element of @Values is a hash reference the key/value
                   16014: pairs will be added to the graph definition.
                   16015: 
1.138     matthew  16016: =back
                   16017: 
                   16018: Returns:
                   16019: 
                   16020: An <img> tag which references graph.png and the appropriate identifying
                   16021: information for the plot.
                   16022: 
1.127     matthew  16023: =cut
                   16024: 
                   16025: ############################################################
                   16026: ############################################################
1.134     matthew  16027: sub DrawBarGraph {
1.178     matthew  16028:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  16029:     #
                   16030:     if (! defined($colors)) {
                   16031:         $colors = ['#33ff00', 
                   16032:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   16033:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   16034:                   ]; 
                   16035:     }
1.228     matthew  16036:     my $extra_settings = {};
                   16037:     if (ref($Values[-1]) eq 'HASH') {
                   16038:         $extra_settings = pop(@Values);
                   16039:     }
1.127     matthew  16040:     #
1.136     matthew  16041:     my $identifier = &get_cgi_id();
                   16042:     my $id = 'cgi.'.$identifier;        
1.129     matthew  16043:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  16044:         return '';
                   16045:     }
1.225     matthew  16046:     #
                   16047:     my @Labels;
                   16048:     if (defined($labels)) {
                   16049:         @Labels = @$labels;
                   16050:     } else {
                   16051:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263    raeburn  16052:             push(@Labels,$i+1);
1.225     matthew  16053:         }
                   16054:     }
                   16055:     #
1.129     matthew  16056:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  16057:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  16058:     my %ValuesHash;
                   16059:     my $NumSets=1;
                   16060:     foreach my $array (@Values) {
                   16061:         next if (! ref($array));
1.136     matthew  16062:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  16063:             join(',',@$array);
1.129     matthew  16064:     }
1.127     matthew  16065:     #
1.136     matthew  16066:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  16067:     if ($NumBars < 3) {
                   16068:         $width = 120+$NumBars*32;
1.220     matthew  16069:         $xskip = 1;
1.225     matthew  16070:         $bar_width = 30;
                   16071:     } elsif ($NumBars < 5) {
                   16072:         $width = 120+$NumBars*20;
                   16073:         $xskip = 1;
                   16074:         $bar_width = 20;
1.220     matthew  16075:     } elsif ($NumBars < 10) {
1.136     matthew  16076:         $width = 120+$NumBars*15;
                   16077:         $xskip = 1;
                   16078:         $bar_width = 15;
                   16079:     } elsif ($NumBars <= 25) {
                   16080:         $width = 120+$NumBars*11;
                   16081:         $xskip = 5;
                   16082:         $bar_width = 8;
                   16083:     } elsif ($NumBars <= 50) {
                   16084:         $width = 120+$NumBars*8;
                   16085:         $xskip = 5;
                   16086:         $bar_width = 4;
                   16087:     } else {
                   16088:         $width = 120+$NumBars*8;
                   16089:         $xskip = 5;
                   16090:         $bar_width = 4;
                   16091:     }
                   16092:     #
1.137     matthew  16093:     $Max = 1 if ($Max < 1);
                   16094:     if ( int($Max) < $Max ) {
                   16095:         $Max++;
                   16096:         $Max = int($Max);
                   16097:     }
1.127     matthew  16098:     $Title  = '' if (! defined($Title));
                   16099:     $xlabel = '' if (! defined($xlabel));
                   16100:     $ylabel = '' if (! defined($ylabel));
1.369     www      16101:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   16102:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   16103:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  16104:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  16105:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   16106:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   16107:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   16108:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   16109:     $ValuesHash{$id.'.height'}   = $height;
                   16110:     $ValuesHash{$id.'.width'}    = $width;
                   16111:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   16112:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   16113:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  16114:     #
1.228     matthew  16115:     # Deal with other parameters
                   16116:     while (my ($key,$value) = each(%$extra_settings)) {
                   16117:         $ValuesHash{$id.'.'.$key} = $value;
                   16118:     }
                   16119:     #
1.646     raeburn  16120:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  16121:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   16122: }
                   16123: 
                   16124: ############################################################
                   16125: ############################################################
                   16126: 
                   16127: =pod
                   16128: 
1.648     raeburn  16129: =item * &DrawXYGraph()
1.137     matthew  16130: 
1.138     matthew  16131: Facilitates the plotting of data in an XY graph.
                   16132: Puts plot definition data into the users environment in order for 
                   16133: graph.png to plot it.  Returns an <img> tag for the plot.
                   16134: 
                   16135: Inputs:
                   16136: 
                   16137: =over 4
                   16138: 
                   16139: =item $Title: string, the title of the plot
                   16140: 
                   16141: =item $xlabel: string, text describing the X-axis of the plot
                   16142: 
                   16143: =item $ylabel: string, text describing the Y-axis of the plot
                   16144: 
                   16145: =item $Max: scalar, the maximum Y value to use in the plot
                   16146: If $Max is < any data point, the graph will not be rendered.
                   16147: 
                   16148: =item $colors: Array ref containing the hex color codes for the data to be 
                   16149: plotted in.  If undefined, default values will be used.
                   16150: 
                   16151: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   16152: 
                   16153: =item $Ydata: Array ref containing Array refs.  
1.185     www      16154: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  16155: 
                   16156: =item %Values: hash indicating or overriding any default values which are 
                   16157: passed to graph.png.  
                   16158: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   16159: 
                   16160: =back
                   16161: 
                   16162: Returns:
                   16163: 
                   16164: An <img> tag which references graph.png and the appropriate identifying
                   16165: information for the plot.
                   16166: 
1.137     matthew  16167: =cut
                   16168: 
                   16169: ############################################################
                   16170: ############################################################
                   16171: sub DrawXYGraph {
                   16172:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   16173:     #
                   16174:     # Create the identifier for the graph
                   16175:     my $identifier = &get_cgi_id();
                   16176:     my $id = 'cgi.'.$identifier;
                   16177:     #
                   16178:     $Title  = '' if (! defined($Title));
                   16179:     $xlabel = '' if (! defined($xlabel));
                   16180:     $ylabel = '' if (! defined($ylabel));
                   16181:     my %ValuesHash = 
                   16182:         (
1.369     www      16183:          $id.'.title'  => &escape($Title),
                   16184:          $id.'.xlabel' => &escape($xlabel),
                   16185:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  16186:          $id.'.y_max_value'=> $Max,
                   16187:          $id.'.labels'     => join(',',@$Xlabels),
                   16188:          $id.'.PlotType'   => 'XY',
                   16189:          );
                   16190:     #
                   16191:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   16192:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   16193:     }
                   16194:     #
                   16195:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   16196:         return '';
                   16197:     }
                   16198:     my $NumSets=1;
1.138     matthew  16199:     foreach my $array (@{$Ydata}){
1.137     matthew  16200:         next if (! ref($array));
                   16201:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   16202:     }
1.138     matthew  16203:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  16204:     #
                   16205:     # Deal with other parameters
                   16206:     while (my ($key,$value) = each(%Values)) {
                   16207:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  16208:     }
                   16209:     #
1.646     raeburn  16210:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  16211:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   16212: }
                   16213: 
                   16214: ############################################################
                   16215: ############################################################
                   16216: 
                   16217: =pod
                   16218: 
1.648     raeburn  16219: =item * &DrawXYYGraph()
1.138     matthew  16220: 
                   16221: Facilitates the plotting of data in an XY graph with two Y axes.
                   16222: Puts plot definition data into the users environment in order for 
                   16223: graph.png to plot it.  Returns an <img> tag for the plot.
                   16224: 
                   16225: Inputs:
                   16226: 
                   16227: =over 4
                   16228: 
                   16229: =item $Title: string, the title of the plot
                   16230: 
                   16231: =item $xlabel: string, text describing the X-axis of the plot
                   16232: 
                   16233: =item $ylabel: string, text describing the Y-axis of the plot
                   16234: 
                   16235: =item $colors: Array ref containing the hex color codes for the data to be 
                   16236: plotted in.  If undefined, default values will be used.
                   16237: 
                   16238: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   16239: 
                   16240: =item $Ydata1: The first data set
                   16241: 
                   16242: =item $Min1: The minimum value of the left Y-axis
                   16243: 
                   16244: =item $Max1: The maximum value of the left Y-axis
                   16245: 
                   16246: =item $Ydata2: The second data set
                   16247: 
                   16248: =item $Min2: The minimum value of the right Y-axis
                   16249: 
                   16250: =item $Max2: The maximum value of the left Y-axis
                   16251: 
                   16252: =item %Values: hash indicating or overriding any default values which are 
                   16253: passed to graph.png.  
                   16254: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   16255: 
                   16256: =back
                   16257: 
                   16258: Returns:
                   16259: 
                   16260: An <img> tag which references graph.png and the appropriate identifying
                   16261: information for the plot.
1.136     matthew  16262: 
                   16263: =cut
                   16264: 
                   16265: ############################################################
                   16266: ############################################################
1.137     matthew  16267: sub DrawXYYGraph {
                   16268:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   16269:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  16270:     #
                   16271:     # Create the identifier for the graph
                   16272:     my $identifier = &get_cgi_id();
                   16273:     my $id = 'cgi.'.$identifier;
                   16274:     #
                   16275:     $Title  = '' if (! defined($Title));
                   16276:     $xlabel = '' if (! defined($xlabel));
                   16277:     $ylabel = '' if (! defined($ylabel));
                   16278:     my %ValuesHash = 
                   16279:         (
1.369     www      16280:          $id.'.title'  => &escape($Title),
                   16281:          $id.'.xlabel' => &escape($xlabel),
                   16282:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  16283:          $id.'.labels' => join(',',@$Xlabels),
                   16284:          $id.'.PlotType' => 'XY',
                   16285:          $id.'.NumSets' => 2,
1.137     matthew  16286:          $id.'.two_axes' => 1,
                   16287:          $id.'.y1_max_value' => $Max1,
                   16288:          $id.'.y1_min_value' => $Min1,
                   16289:          $id.'.y2_max_value' => $Max2,
                   16290:          $id.'.y2_min_value' => $Min2,
1.136     matthew  16291:          );
                   16292:     #
1.137     matthew  16293:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   16294:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   16295:     }
                   16296:     #
                   16297:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   16298:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  16299:         return '';
                   16300:     }
                   16301:     my $NumSets=1;
1.137     matthew  16302:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  16303:         next if (! ref($array));
                   16304:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  16305:     }
                   16306:     #
                   16307:     # Deal with other parameters
                   16308:     while (my ($key,$value) = each(%Values)) {
                   16309:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  16310:     }
                   16311:     #
1.646     raeburn  16312:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 16313:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  16314: }
                   16315: 
                   16316: ############################################################
                   16317: ############################################################
                   16318: 
                   16319: =pod
                   16320: 
1.157     matthew  16321: =back 
                   16322: 
1.139     matthew  16323: =head1 Statistics helper routines?  
                   16324: 
                   16325: Bad place for them but what the hell.
                   16326: 
1.157     matthew  16327: =over 4
                   16328: 
1.648     raeburn  16329: =item * &chartlink()
1.139     matthew  16330: 
                   16331: Returns a link to the chart for a specific student.  
                   16332: 
                   16333: Inputs:
                   16334: 
                   16335: =over 4
                   16336: 
                   16337: =item $linktext: The text of the link
                   16338: 
                   16339: =item $sname: The students username
                   16340: 
                   16341: =item $sdomain: The students domain
                   16342: 
                   16343: =back
                   16344: 
1.157     matthew  16345: =back
                   16346: 
1.139     matthew  16347: =cut
                   16348: 
                   16349: ############################################################
                   16350: ############################################################
                   16351: sub chartlink {
                   16352:     my ($linktext, $sname, $sdomain) = @_;
                   16353:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      16354:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 16355:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  16356:        '">'.$linktext.'</a>';
1.153     matthew  16357: }
                   16358: 
                   16359: #######################################################
                   16360: #######################################################
                   16361: 
                   16362: =pod
                   16363: 
                   16364: =head1 Course Environment Routines
1.157     matthew  16365: 
                   16366: =over 4
1.153     matthew  16367: 
1.648     raeburn  16368: =item * &restore_course_settings()
1.153     matthew  16369: 
1.648     raeburn  16370: =item * &store_course_settings()
1.153     matthew  16371: 
                   16372: Restores/Store indicated form parameters from the course environment.
                   16373: Will not overwrite existing values of the form parameters.
                   16374: 
                   16375: Inputs: 
                   16376: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   16377: 
                   16378: a hash ref describing the data to be stored.  For example:
                   16379:    
                   16380: %Save_Parameters = ('Status' => 'scalar',
                   16381:     'chartoutputmode' => 'scalar',
                   16382:     'chartoutputdata' => 'scalar',
                   16383:     'Section' => 'array',
1.373     raeburn  16384:     'Group' => 'array',
1.153     matthew  16385:     'StudentData' => 'array',
                   16386:     'Maps' => 'array');
                   16387: 
                   16388: Returns: both routines return nothing
                   16389: 
1.631     raeburn  16390: =back
                   16391: 
1.153     matthew  16392: =cut
                   16393: 
                   16394: #######################################################
                   16395: #######################################################
                   16396: sub store_course_settings {
1.496     albertel 16397:     return &store_settings($env{'request.course.id'},@_);
                   16398: }
                   16399: 
                   16400: sub store_settings {
1.153     matthew  16401:     # save to the environment
                   16402:     # appenv the same items, just to be safe
1.300     albertel 16403:     my $udom  = $env{'user.domain'};
                   16404:     my $uname = $env{'user.name'};
1.496     albertel 16405:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  16406:     my %SaveHash;
                   16407:     my %AppHash;
                   16408:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 16409:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 16410:         my $envname = 'environment.'.$basename;
1.258     albertel 16411:         if (exists($env{'form.'.$setting})) {
1.153     matthew  16412:             # Save this value away
                   16413:             if ($type eq 'scalar' &&
1.258     albertel 16414:                 (! exists($env{$envname}) || 
                   16415:                  $env{$envname} ne $env{'form.'.$setting})) {
                   16416:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   16417:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  16418:             } elsif ($type eq 'array') {
                   16419:                 my $stored_form;
1.258     albertel 16420:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  16421:                     $stored_form = join(',',
                   16422:                                         map {
1.369     www      16423:                                             &escape($_);
1.258     albertel 16424:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  16425:                 } else {
                   16426:                     $stored_form = 
1.369     www      16427:                         &escape($env{'form.'.$setting});
1.153     matthew  16428:                 }
                   16429:                 # Determine if the array contents are the same.
1.258     albertel 16430:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  16431:                     $SaveHash{$basename} = $stored_form;
                   16432:                     $AppHash{$envname}   = $stored_form;
                   16433:                 }
                   16434:             }
                   16435:         }
                   16436:     }
                   16437:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 16438:                                           $udom,$uname);
1.153     matthew  16439:     if ($put_result !~ /^(ok|delayed)/) {
                   16440:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   16441:                                  'got error:'.$put_result);
                   16442:     }
                   16443:     # Make sure these settings stick around in this session, too
1.646     raeburn  16444:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  16445:     return;
                   16446: }
                   16447: 
                   16448: sub restore_course_settings {
1.499     albertel 16449:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 16450: }
                   16451: 
                   16452: sub restore_settings {
                   16453:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  16454:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 16455:         next if (exists($env{'form.'.$setting}));
1.496     albertel 16456:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  16457:             '.'.$setting;
1.258     albertel 16458:         if (exists($env{$envname})) {
1.153     matthew  16459:             if ($type eq 'scalar') {
1.258     albertel 16460:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  16461:             } elsif ($type eq 'array') {
1.258     albertel 16462:                 $env{'form.'.$setting} = [ 
1.153     matthew  16463:                                            map { 
1.369     www      16464:                                                &unescape($_); 
1.258     albertel 16465:                                            } split(',',$env{$envname})
1.153     matthew  16466:                                            ];
                   16467:             }
                   16468:         }
                   16469:     }
1.127     matthew  16470: }
                   16471: 
1.618     raeburn  16472: #######################################################
                   16473: #######################################################
                   16474: 
                   16475: =pod
                   16476: 
                   16477: =head1 Domain E-mail Routines  
                   16478: 
                   16479: =over 4
                   16480: 
1.648     raeburn  16481: =item * &build_recipient_list()
1.618     raeburn  16482: 
1.1144    raeburn  16483: Build recipient lists for following types of e-mail:
1.766     raeburn  16484: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144    raeburn  16485: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   16486: module change checking, student/employee ID conflict checks, as
                   16487: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   16488: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  16489: 
                   16490: Inputs:
1.619     raeburn  16491: defmail (scalar - email address of default recipient), 
1.1144    raeburn  16492: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   16493: requestsmail, updatesmail, or idconflictsmail).
                   16494: 
1.619     raeburn  16495: defdom (domain for which to retrieve configuration settings),
1.1144    raeburn  16496: 
1.619     raeburn  16497: origmail (scalar - email address of recipient from loncapa.conf, 
1.1297    raeburn  16498: i.e., predates configuration by DC via domainprefs.pm
                   16499: 
                   16500: $requname username of requester (if mailing type is helpdeskmail)
                   16501: 
                   16502: $requdom domain of requester (if mailing type is helpdeskmail)
                   16503: 
                   16504: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
                   16505: 
1.618     raeburn  16506: 
1.655     raeburn  16507: Returns: comma separated list of addresses to which to send e-mail.
                   16508: 
                   16509: =back
1.618     raeburn  16510: 
                   16511: =cut
                   16512: 
                   16513: ############################################################
                   16514: ############################################################
                   16515: sub build_recipient_list {
1.1297    raeburn  16516:     my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618     raeburn  16517:     my @recipients;
1.1270    raeburn  16518:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  16519:     my %domconfig =
1.1270    raeburn  16520:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  16521:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  16522:         if (exists($domconfig{'contacts'}{$mailing})) {
                   16523:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   16524:                 my @contacts = ('adminemail','supportemail');
                   16525:                 foreach my $item (@contacts) {
                   16526:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   16527:                         my $addr = $domconfig{'contacts'}{$item}; 
                   16528:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   16529:                             push(@recipients,$addr);
                   16530:                         }
1.619     raeburn  16531:                     }
1.1270    raeburn  16532:                 }
                   16533:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   16534:                 if ($mailing eq 'helpdeskmail') {
                   16535:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   16536:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   16537:                         my @ok_bccs;
                   16538:                         foreach my $bcc (@bccs) {
                   16539:                             $bcc =~ s/^\s+//g;
                   16540:                             $bcc =~ s/\s+$//g;
                   16541:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   16542:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   16543:                                     push(@ok_bccs,$bcc);
                   16544:                                 }
                   16545:                             }
                   16546:                         }
                   16547:                         if (@ok_bccs > 0) {
                   16548:                             $allbcc = join(', ',@ok_bccs);
                   16549:                         }
                   16550:                     }
                   16551:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  16552:                 }
                   16553:             }
1.766     raeburn  16554:         } elsif ($origmail ne '') {
1.1270    raeburn  16555:             $lastresort = $origmail;
1.618     raeburn  16556:         }
1.1297    raeburn  16557:         if ($mailing eq 'helpdeskmail') {
                   16558:             if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
                   16559:                 (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
                   16560:                 my ($inststatus,$inststatus_checked);
                   16561:                 if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
                   16562:                     ($env{'user.domain'} ne 'public')) {
                   16563:                     $inststatus_checked = 1;
                   16564:                     $inststatus = $env{'environment.inststatus'};
                   16565:                 }
                   16566:                 unless ($inststatus_checked) {
                   16567:                     if (($requname ne '') && ($requdom ne '')) {
                   16568:                         if (($requname =~ /^$match_username$/) &&
                   16569:                             ($requdom =~ /^$match_domain$/) &&
                   16570:                             (&Apache::lonnet::domain($requdom))) {
                   16571:                             my $requhome = &Apache::lonnet::homeserver($requname,
                   16572:                                                                       $requdom);
                   16573:                             unless ($requhome eq 'no_host') {
                   16574:                                 my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
                   16575:                                 $inststatus = $userenv{'inststatus'};
                   16576:                                 $inststatus_checked = 1;
                   16577:                             }
                   16578:                         }
                   16579:                     }
                   16580:                 }
                   16581:                 unless ($inststatus_checked) {
                   16582:                     if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
                   16583:                         my %srch = (srchby     => 'email',
                   16584:                                     srchdomain => $defdom,
                   16585:                                     srchterm   => $reqemail,
                   16586:                                     srchtype   => 'exact');
                   16587:                         my %srch_results = &Apache::lonnet::usersearch(\%srch);
                   16588:                         foreach my $uname (keys(%srch_results)) {
                   16589:                             if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   16590:                                 $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   16591:                                 $inststatus_checked = 1;
                   16592:                                 last;
                   16593:                             }
                   16594:                         }
                   16595:                         unless ($inststatus_checked) {
                   16596:                             my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
                   16597:                             if ($dirsrchres eq 'ok') {
                   16598:                                 foreach my $uname (keys(%srch_results)) {
                   16599:                                     if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   16600:                                         $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   16601:                                         $inststatus_checked = 1;
                   16602:                                         last;
                   16603:                                     }
                   16604:                                 }
                   16605:                             }
                   16606:                         }
                   16607:                     }
                   16608:                 }
                   16609:                 if ($inststatus ne '') {
                   16610:                     foreach my $status (split(/\:/,$inststatus)) {
                   16611:                         if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
                   16612:                             my @contacts = ('adminemail','supportemail');
                   16613:                             foreach my $item (@contacts) {
                   16614:                                 if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
                   16615:                                     my $addr = $domconfig{'contacts'}{'overrides'}{$status};
                   16616:                                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   16617:                                         push(@recipients,$addr);
                   16618:                                     }
                   16619:                                 }
                   16620:                             }
                   16621:                             $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
                   16622:                             if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
                   16623:                                 my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
                   16624:                                 my @ok_bccs;
                   16625:                                 foreach my $bcc (@bccs) {
                   16626:                                     $bcc =~ s/^\s+//g;
                   16627:                                     $bcc =~ s/\s+$//g;
                   16628:                                     if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   16629:                                         if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   16630:                                             push(@ok_bccs,$bcc);
                   16631:                                         }
                   16632:                                     }
                   16633:                                 }
                   16634:                                 if (@ok_bccs > 0) {
                   16635:                                     $allbcc = join(', ',@ok_bccs);
                   16636:                                 }
                   16637:                             }
                   16638:                             $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
                   16639:                             last;
                   16640:                         }
                   16641:                     }
                   16642:                 }
                   16643:             }
                   16644:         }
1.619     raeburn  16645:     } elsif ($origmail ne '') {
1.1270    raeburn  16646:         $lastresort = $origmail;
                   16647:     }
1.1297    raeburn  16648:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270    raeburn  16649:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   16650:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   16651:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   16652:             my %what = (
                   16653:                           perlvar => 1,
                   16654:                        );
                   16655:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   16656:             if ($primary) {
                   16657:                 my $gotaddr;
                   16658:                 my ($result,$returnhash) =
                   16659:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   16660:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   16661:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   16662:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   16663:                         $gotaddr = 1;
                   16664:                     }
                   16665:                 }
                   16666:                 unless ($gotaddr) {
                   16667:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   16668:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   16669:                     unless ($uintdom eq $intdom) {
                   16670:                         my %domconfig =
                   16671:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   16672:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   16673:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   16674:                                 my @contacts = ('adminemail','supportemail');
                   16675:                                 foreach my $item (@contacts) {
                   16676:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   16677:                                         my $addr = $domconfig{'contacts'}{$item};
                   16678:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   16679:                                             push(@recipients,$addr);
                   16680:                                         }
                   16681:                                     }
                   16682:                                 }
                   16683:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   16684:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   16685:                                 }
                   16686:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   16687:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   16688:                                     my @ok_bccs;
                   16689:                                     foreach my $bcc (@bccs) {
                   16690:                                         $bcc =~ s/^\s+//g;
                   16691:                                         $bcc =~ s/\s+$//g;
                   16692:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   16693:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   16694:                                                 push(@ok_bccs,$bcc);
                   16695:                                             }
                   16696:                                         }
                   16697:                                     }
                   16698:                                     if (@ok_bccs > 0) {
                   16699:                                         $allbcc = join(', ',@ok_bccs);
                   16700:                                     }
                   16701:                                 }
                   16702:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   16703:                             }
                   16704:                         }
                   16705:                     }
                   16706:                 }
                   16707:             }
                   16708:         }
1.618     raeburn  16709:     }
1.688     raeburn  16710:     if (defined($defmail)) {
                   16711:         if ($defmail ne '') {
                   16712:             push(@recipients,$defmail);
                   16713:         }
1.618     raeburn  16714:     }
                   16715:     if ($otheremails) {
1.619     raeburn  16716:         my @others;
                   16717:         if ($otheremails =~ /,/) {
                   16718:             @others = split(/,/,$otheremails);
1.618     raeburn  16719:         } else {
1.619     raeburn  16720:             push(@others,$otheremails);
                   16721:         }
                   16722:         foreach my $addr (@others) {
                   16723:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   16724:                 push(@recipients,$addr);
                   16725:             }
1.618     raeburn  16726:         }
                   16727:     }
1.1298    raeburn  16728:     if ($mailing eq 'helpdeskmail') {
1.1270    raeburn  16729:         if ((!@recipients) && ($lastresort ne '')) {
                   16730:             push(@recipients,$lastresort);
                   16731:         }
                   16732:     } elsif ($lastresort ne '') {
                   16733:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   16734:             push(@recipients,$lastresort);
                   16735:         }
                   16736:     }
1.1271    raeburn  16737:     my $recipientlist = join(',',@recipients);
1.1270    raeburn  16738:     if (wantarray) {
                   16739:         return ($recipientlist,$allbcc,$addtext);
                   16740:     } else {
                   16741:         return $recipientlist;
                   16742:     }
1.618     raeburn  16743: }
                   16744: 
1.127     matthew  16745: ############################################################
                   16746: ############################################################
1.154     albertel 16747: 
1.655     raeburn  16748: =pod
                   16749: 
1.1224    musolffc 16750: =over 4
                   16751: 
1.1223    musolffc 16752: =item * &mime_email()
                   16753: 
                   16754: Sends an email with a possible attachment
                   16755: 
                   16756: Inputs:
                   16757: 
                   16758: =over 4
                   16759: 
                   16760: from -              Sender's email address
                   16761: 
1.1343    raeburn  16762: replyto -           Reply-To email address
                   16763: 
1.1223    musolffc 16764: to -                Email address of recipient
                   16765: 
                   16766: subject -           Subject of email
                   16767: 
                   16768: body -              Body of email
                   16769: 
                   16770: cc_string -         Carbon copy email address
                   16771: 
                   16772: bcc -               Blind carbon copy email address
                   16773: 
                   16774: attachment_path -   Path of file to be attached
                   16775: 
                   16776: file_name -         Name of file to be attached
                   16777: 
                   16778: attachment_text -   The body of an attachment of type "TEXT"
                   16779: 
                   16780: =back
                   16781: 
                   16782: =back
                   16783: 
                   16784: =cut
                   16785: 
                   16786: ############################################################
                   16787: ############################################################
                   16788: 
                   16789: sub mime_email {
1.1343    raeburn  16790:     my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path, 
                   16791:         $file_name,$attachment_text) = @_;
                   16792:  
1.1223    musolffc 16793:     my $msg = MIME::Lite->new(
                   16794:              From    => $from,
                   16795:              To      => $to,
                   16796:              Subject => $subject,
                   16797:              Type    =>'TEXT',
                   16798:              Data    => $body,
                   16799:              );
1.1343    raeburn  16800:     if ($replyto ne '') {
                   16801:         $msg->add("Reply-To" => $replyto);
                   16802:     }
1.1223    musolffc 16803:     if ($cc_string ne '') {
                   16804:         $msg->add("Cc" => $cc_string);
                   16805:     }
                   16806:     if ($bcc ne '') {
                   16807:         $msg->add("Bcc" => $bcc);
                   16808:     }
                   16809:     $msg->attr("content-type"         => "text/plain");
                   16810:     $msg->attr("content-type.charset" => "UTF-8");
                   16811:     # Attach file if given
                   16812:     if ($attachment_path) {
                   16813:         unless ($file_name) {
                   16814:             if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
                   16815:         }
                   16816:         my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
                   16817:         $msg->attach(Type     => $type,
                   16818:                      Path     => $attachment_path,
                   16819:                      Filename => $file_name
                   16820:                      );
                   16821:     # Otherwise attach text if given
                   16822:     } elsif ($attachment_text) {
                   16823:         $msg->attach(Type => 'TEXT',
                   16824:                      Data => $attachment_text);
                   16825:     }
                   16826:     # Send it
                   16827:     $msg->send('sendmail');
                   16828: }
                   16829: 
                   16830: ############################################################
                   16831: ############################################################
                   16832: 
                   16833: =pod
                   16834: 
1.655     raeburn  16835: =head1 Course Catalog Routines
                   16836: 
                   16837: =over 4
                   16838: 
                   16839: =item * &gather_categories()
                   16840: 
                   16841: Converts category definitions - keys of categories hash stored in  
                   16842: coursecategories in configuration.db on the primary library server in a 
                   16843: domain - to an array.  Also generates javascript and idx hash used to 
                   16844: generate Domain Coordinator interface for editing Course Categories.
                   16845: 
                   16846: Inputs:
1.663     raeburn  16847: 
1.655     raeburn  16848: categories (reference to hash of category definitions).
1.663     raeburn  16849: 
1.655     raeburn  16850: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   16851:       categories and subcategories).
1.663     raeburn  16852: 
1.655     raeburn  16853: idx (reference to hash of counters used in Domain Coordinator interface for 
                   16854:       editing Course Categories).
1.663     raeburn  16855: 
1.655     raeburn  16856: jsarray (reference to array of categories used to create Javascript arrays for
                   16857:          Domain Coordinator interface for editing Course Categories).
                   16858: 
                   16859: Returns: nothing
                   16860: 
                   16861: Side effects: populates cats, idx and jsarray. 
                   16862: 
                   16863: =cut
                   16864: 
                   16865: sub gather_categories {
                   16866:     my ($categories,$cats,$idx,$jsarray) = @_;
                   16867:     my %counters;
                   16868:     my $num = 0;
                   16869:     foreach my $item (keys(%{$categories})) {
                   16870:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   16871:         if ($container eq '' && $depth == 0) {
                   16872:             $cats->[$depth][$categories->{$item}] = $cat;
                   16873:         } else {
                   16874:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   16875:         }
                   16876:         my ($escitem,$tail) = split(/:/,$item,2);
                   16877:         if ($counters{$tail} eq '') {
                   16878:             $counters{$tail} = $num;
                   16879:             $num ++;
                   16880:         }
                   16881:         if (ref($idx) eq 'HASH') {
                   16882:             $idx->{$item} = $counters{$tail};
                   16883:         }
                   16884:         if (ref($jsarray) eq 'ARRAY') {
                   16885:             push(@{$jsarray->[$counters{$tail}]},$item);
                   16886:         }
                   16887:     }
                   16888:     return;
                   16889: }
                   16890: 
                   16891: =pod
                   16892: 
                   16893: =item * &extract_categories()
                   16894: 
                   16895: Used to generate breadcrumb trails for course categories.
                   16896: 
                   16897: Inputs:
1.663     raeburn  16898: 
1.655     raeburn  16899: categories (reference to hash of category definitions).
1.663     raeburn  16900: 
1.655     raeburn  16901: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   16902:       categories and subcategories).
1.663     raeburn  16903: 
1.655     raeburn  16904: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  16905: 
1.655     raeburn  16906: allitems (reference to hash - key is category key 
                   16907:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  16908: 
1.655     raeburn  16909: idx (reference to hash of counters used in Domain Coordinator interface for
                   16910:       editing Course Categories).
1.663     raeburn  16911: 
1.655     raeburn  16912: jsarray (reference to array of categories used to create Javascript arrays for
                   16913:          Domain Coordinator interface for editing Course Categories).
                   16914: 
1.665     raeburn  16915: subcats (reference to hash of arrays containing all subcategories within each 
                   16916:          category, -recursive)
                   16917: 
1.1321    raeburn  16918: maxd (reference to hash used to hold max depth for all top-level categories).
                   16919: 
1.655     raeburn  16920: Returns: nothing
                   16921: 
                   16922: Side effects: populates trails and allitems hash references.
                   16923: 
                   16924: =cut
                   16925: 
                   16926: sub extract_categories {
1.1321    raeburn  16927:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655     raeburn  16928:     if (ref($categories) eq 'HASH') {
                   16929:         &gather_categories($categories,$cats,$idx,$jsarray);
                   16930:         if (ref($cats->[0]) eq 'ARRAY') {
                   16931:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   16932:                 my $name = $cats->[0][$i];
                   16933:                 my $item = &escape($name).'::0';
                   16934:                 my $trailstr;
                   16935:                 if ($name eq 'instcode') {
                   16936:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  16937:                 } elsif ($name eq 'communities') {
                   16938:                     $trailstr = &mt('Communities');
1.1239    raeburn  16939:                 } elsif ($name eq 'placement') {
                   16940:                     $trailstr = &mt('Placement Tests');
1.655     raeburn  16941:                 } else {
                   16942:                     $trailstr = $name;
                   16943:                 }
                   16944:                 if ($allitems->{$item} eq '') {
                   16945:                     push(@{$trails},$trailstr);
                   16946:                     $allitems->{$item} = scalar(@{$trails})-1;
                   16947:                 }
                   16948:                 my @parents = ($name);
                   16949:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   16950:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   16951:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  16952:                         if (ref($subcats) eq 'HASH') {
                   16953:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   16954:                         }
1.1321    raeburn  16955:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665     raeburn  16956:                     }
                   16957:                 } else {
                   16958:                     if (ref($subcats) eq 'HASH') {
                   16959:                         $subcats->{$item} = [];
1.655     raeburn  16960:                     }
1.1321    raeburn  16961:                     if (ref($maxd) eq 'HASH') {
                   16962:                         $maxd->{$name} = 1;
                   16963:                     }
1.655     raeburn  16964:                 }
                   16965:             }
                   16966:         }
                   16967:     }
                   16968:     return;
                   16969: }
                   16970: 
                   16971: =pod
                   16972: 
1.1162    raeburn  16973: =item * &recurse_categories()
1.655     raeburn  16974: 
                   16975: Recursively used to generate breadcrumb trails for course categories.
                   16976: 
                   16977: Inputs:
1.663     raeburn  16978: 
1.655     raeburn  16979: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   16980:       categories and subcategories).
1.663     raeburn  16981: 
1.655     raeburn  16982: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  16983: 
                   16984: category (current course category, for which breadcrumb trail is being generated).
                   16985: 
                   16986: trails (reference to array of breadcrumb trails for each category).
                   16987: 
1.655     raeburn  16988: allitems (reference to hash - key is category key
                   16989:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  16990: 
1.655     raeburn  16991: parents (array containing containers directories for current category, 
                   16992:          back to top level). 
                   16993: 
                   16994: Returns: nothing
                   16995: 
                   16996: Side effects: populates trails and allitems hash references
                   16997: 
                   16998: =cut
                   16999: 
                   17000: sub recurse_categories {
1.1321    raeburn  17001:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655     raeburn  17002:     my $shallower = $depth - 1;
                   17003:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   17004:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   17005:             my $name = $cats->[$depth]{$category}[$k];
                   17006:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321    raeburn  17007:             my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  17008:             if ($allitems->{$item} eq '') {
                   17009:                 push(@{$trails},$trailstr);
                   17010:                 $allitems->{$item} = scalar(@{$trails})-1;
                   17011:             }
                   17012:             my $deeper = $depth+1;
                   17013:             push(@{$parents},$category);
1.665     raeburn  17014:             if (ref($subcats) eq 'HASH') {
                   17015:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   17016:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   17017:                     my $higher;
                   17018:                     if ($j > 0) {
                   17019:                         $higher = &escape($parents->[$j]).':'.
                   17020:                                   &escape($parents->[$j-1]).':'.$j;
                   17021:                     } else {
                   17022:                         $higher = &escape($parents->[$j]).'::'.$j;
                   17023:                     }
                   17024:                     push(@{$subcats->{$higher}},$subcat);
                   17025:                 }
                   17026:             }
                   17027:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321    raeburn  17028:                                 $subcats,$maxd);
1.655     raeburn  17029:             pop(@{$parents});
                   17030:         }
                   17031:     } else {
                   17032:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321    raeburn  17033:         my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  17034:         if ($allitems->{$item} eq '') {
                   17035:             push(@{$trails},$trailstr);
                   17036:             $allitems->{$item} = scalar(@{$trails})-1;
                   17037:         }
1.1321    raeburn  17038:         if (ref($maxd) eq 'HASH') {
                   17039:             if ($depth > $maxd->{$parents->[0]}) {
                   17040:                 $maxd->{$parents->[0]} = $depth;
                   17041:             }
                   17042:         }
1.655     raeburn  17043:     }
                   17044:     return;
                   17045: }
                   17046: 
1.663     raeburn  17047: =pod
                   17048: 
1.1162    raeburn  17049: =item * &assign_categories_table()
1.663     raeburn  17050: 
                   17051: Create a datatable for display of hierarchical categories in a domain,
                   17052: with checkboxes to allow a course to be categorized. 
                   17053: 
                   17054: Inputs:
                   17055: 
                   17056: cathash - reference to hash of categories defined for the domain (from
                   17057:           configuration.db)
                   17058: 
                   17059: currcat - scalar with an & separated list of categories assigned to a course. 
                   17060: 
1.919     raeburn  17061: type    - scalar contains course type (Course or Community).
                   17062: 
1.1260    raeburn  17063: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   17064:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   17065: 
1.663     raeburn  17066: Returns: $output (markup to be displayed) 
                   17067: 
                   17068: =cut
                   17069: 
                   17070: sub assign_categories_table {
1.1259    raeburn  17071:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  17072:     my $output;
                   17073:     if (ref($cathash) eq 'HASH') {
1.1321    raeburn  17074:         my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
                   17075:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663     raeburn  17076:         $maxdepth = scalar(@cats);
                   17077:         if (@cats > 0) {
                   17078:             my $itemcount = 0;
                   17079:             if (ref($cats[0]) eq 'ARRAY') {
                   17080:                 my @currcategories;
                   17081:                 if ($currcat ne '') {
                   17082:                     @currcategories = split('&',$currcat);
                   17083:                 }
1.919     raeburn  17084:                 my $table;
1.663     raeburn  17085:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   17086:                     my $parent = $cats[0][$i];
1.919     raeburn  17087:                     next if ($parent eq 'instcode');
                   17088:                     if ($type eq 'Community') {
                   17089:                         next unless ($parent eq 'communities');
1.1239    raeburn  17090:                     } elsif ($type eq 'Placement') {
                   17091:                         next unless ($parent eq 'placement');
1.919     raeburn  17092:                     } else {
1.1239    raeburn  17093:                         next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919     raeburn  17094:                     }
1.663     raeburn  17095:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   17096:                     my $item = &escape($parent).'::0';
                   17097:                     my $checked = '';
                   17098:                     if (@currcategories > 0) {
                   17099:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   17100:                             $checked = ' checked="checked"';
1.663     raeburn  17101:                         }
                   17102:                     }
1.919     raeburn  17103:                     my $parent_title = $parent;
                   17104:                     if ($parent eq 'communities') {
                   17105:                         $parent_title = &mt('Communities');
1.1239    raeburn  17106:                     } elsif ($parent eq 'placement') {
                   17107:                         $parent_title = &mt('Placement Tests');
1.919     raeburn  17108:                     }
                   17109:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   17110:                               '<input type="checkbox" name="usecategory" value="'.
1.1259    raeburn  17111:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  17112:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  17113:                     my $depth = 1;
                   17114:                     push(@path,$parent);
1.1259    raeburn  17115:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  17116:                     pop(@path);
1.919     raeburn  17117:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  17118:                     $itemcount ++;
                   17119:                 }
1.919     raeburn  17120:                 if ($itemcount) {
                   17121:                     $output = &Apache::loncommon::start_data_table().
                   17122:                               $table.
                   17123:                               &Apache::loncommon::end_data_table();
                   17124:                 }
1.663     raeburn  17125:             }
                   17126:         }
                   17127:     }
                   17128:     return $output;
                   17129: }
                   17130: 
                   17131: =pod
                   17132: 
1.1162    raeburn  17133: =item * &assign_category_rows()
1.663     raeburn  17134: 
                   17135: Create a datatable row for display of nested categories in a domain,
                   17136: with checkboxes to allow a course to be categorized,called recursively.
                   17137: 
                   17138: Inputs:
                   17139: 
                   17140: itemcount - track row number for alternating colors
                   17141: 
                   17142: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   17143:       categories and subcategories.
                   17144: 
                   17145: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   17146: 
                   17147: parent - parent of current category item
                   17148: 
                   17149: path - Array containing all categories back up through the hierarchy from the
                   17150:        current category to the top level.
                   17151: 
                   17152: currcategories - reference to array of current categories assigned to the course
                   17153: 
1.1260    raeburn  17154: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   17155:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   17156: 
1.663     raeburn  17157: Returns: $output (markup to be displayed).
                   17158: 
                   17159: =cut
                   17160: 
                   17161: sub assign_category_rows {
1.1259    raeburn  17162:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  17163:     my ($text,$name,$item,$chgstr);
                   17164:     if (ref($cats) eq 'ARRAY') {
                   17165:         my $maxdepth = scalar(@{$cats});
                   17166:         if (ref($cats->[$depth]) eq 'HASH') {
                   17167:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   17168:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   17169:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145    raeburn  17170:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  17171:                 for (my $j=0; $j<$numchildren; $j++) {
                   17172:                     $name = $cats->[$depth]{$parent}[$j];
                   17173:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   17174:                     my $deeper = $depth+1;
                   17175:                     my $checked = '';
                   17176:                     if (ref($currcategories) eq 'ARRAY') {
                   17177:                         if (@{$currcategories} > 0) {
                   17178:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   17179:                                 $checked = ' checked="checked"';
1.663     raeburn  17180:                             }
                   17181:                         }
                   17182:                     }
1.664     raeburn  17183:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   17184:                              '<input type="checkbox" name="usecategory" value="'.
1.1259    raeburn  17185:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  17186:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   17187:                              '</td><td>';
1.663     raeburn  17188:                     if (ref($path) eq 'ARRAY') {
                   17189:                         push(@{$path},$name);
1.1259    raeburn  17190:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  17191:                         pop(@{$path});
                   17192:                     }
                   17193:                     $text .= '</td></tr>';
                   17194:                 }
                   17195:                 $text .= '</table></td>';
                   17196:             }
                   17197:         }
                   17198:     }
                   17199:     return $text;
                   17200: }
                   17201: 
1.1181    raeburn  17202: =pod
                   17203: 
                   17204: =back
                   17205: 
                   17206: =cut
                   17207: 
1.655     raeburn  17208: ############################################################
                   17209: ############################################################
                   17210: 
                   17211: 
1.443     albertel 17212: sub commit_customrole {
1.1408    raeburn  17213:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399    raeburn  17214:     my $result = &Apache::lonnet::assigncustomrole(
1.1408    raeburn  17215:                      $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
                   17216:                      $context,$othdomby,$requester);
1.630     raeburn  17217:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 17218:                          ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399    raeburn  17219:                          ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
                   17220:     if (wantarray) {
                   17221:         return ($output,$result);
                   17222:     } else {
                   17223:         return $output;
                   17224:     }
1.443     albertel 17225: }
                   17226: 
                   17227: sub commit_standardrole {
1.1408    raeburn  17228:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
                   17229:         $othdomby,$requester) = @_;
1.1399    raeburn  17230:     my ($output,$logmsg,$linefeed,$result);
1.541     raeburn  17231:     if ($context eq 'auto') {
                   17232:         $linefeed = "\n";
                   17233:     } else {
                   17234:         $linefeed = "<br />\n";
                   17235:     }  
1.443     albertel 17236:     if ($three eq 'st') {
1.1399    raeburn  17237:         $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408    raeburn  17238:                                       $one,$two,$sec,$context,$credits,$othdomby,
                   17239:                                       $requester);
1.541     raeburn  17240:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  17241:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   17242:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 17243:         } else {
1.541     raeburn  17244:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 17245:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  17246:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   17247:             if ($context eq 'auto') {
                   17248:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   17249:             } else {
                   17250:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   17251:                &mt('Add to classlist').': <b>ok</b>';
                   17252:             }
                   17253:             $output .= $linefeed;
1.443     albertel 17254:         }
                   17255:     } else {
                   17256:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   17257:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  17258:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408    raeburn  17259:         $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
                   17260:                                               '','',$context,$othdomby,$requester);
1.541     raeburn  17261:         if ($context eq 'auto') {
                   17262:             $output .= $result.$linefeed;
                   17263:         } else {
                   17264:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   17265:         }
1.443     albertel 17266:     }
1.1399    raeburn  17267:     if (wantarray) {
                   17268:         return ($output,$result);
                   17269:     } else {
                   17270:         return $output;
                   17271:     }
1.443     albertel 17272: }
                   17273: 
                   17274: sub commit_studentrole {
1.1116    raeburn  17275:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408    raeburn  17276:         $credits,$othdomby,$requester) = @_;
1.626     raeburn  17277:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  17278:     if ($context eq 'auto') {
                   17279:         $linefeed = "\n";
                   17280:     } else {
                   17281:         $linefeed = '<br />'."\n";
                   17282:     }
1.443     albertel 17283:     if (defined($one) && defined($two)) {
                   17284:         my $cid=$one.'_'.$two;
                   17285:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   17286:         my $secchange = 0;
                   17287:         my $expire_role_result;
                   17288:         my $modify_section_result;
1.628     raeburn  17289:         if ($oldsec ne '-1') { 
                   17290:             if ($oldsec ne $sec) {
1.443     albertel 17291:                 $secchange = 1;
1.628     raeburn  17292:                 my $now = time;
1.443     albertel 17293:                 my $uurl='/'.$cid;
                   17294:                 $uurl=~s/\_/\//g;
                   17295:                 if ($oldsec) {
                   17296:                     $uurl.='/'.$oldsec;
                   17297:                 }
1.626     raeburn  17298:                 $oldsecurl = $uurl;
1.628     raeburn  17299:                 $expire_role_result = 
1.1408    raeburn  17300:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
                   17301:                                                 '','','',$context,$othdomby,$requester);
                   17302:                 if ($env{'request.course.sec'} ne '') {
1.628     raeburn  17303:                     if ($expire_role_result eq 'refused') {
                   17304:                         my @roles = ('st');
                   17305:                         my @statuses = ('previous');
                   17306:                         my @roledoms = ($one);
                   17307:                         my $withsec = 1;
                   17308:                         my %roleshash = 
                   17309:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   17310:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   17311:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   17312:                             my ($oldstart,$oldend) = 
                   17313:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   17314:                             if ($oldend > 0 && $oldend <= $now) {
                   17315:                                 $expire_role_result = 'ok';
                   17316:                             }
                   17317:                         }
                   17318:                     }
                   17319:                 }
1.443     albertel 17320:                 $result = $expire_role_result;
                   17321:             }
                   17322:         }
                   17323:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116    raeburn  17324:             $modify_section_result = 
                   17325:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   17326:                                                            undef,undef,undef,$sec,
                   17327:                                                            $end,$start,'','',$cid,
1.1408    raeburn  17328:                                                            '',$context,$credits,'',
                   17329:                                                            $othdomby,$requester);
1.443     albertel 17330:             if ($modify_section_result =~ /^ok/) {
                   17331:                 if ($secchange == 1) {
1.628     raeburn  17332:                     if ($sec eq '') {
                   17333:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   17334:                     } else {
                   17335:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   17336:                     }
1.443     albertel 17337:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  17338:                     if ($sec eq '') {
                   17339:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   17340:                     } else {
                   17341:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   17342:                     }
1.443     albertel 17343:                 } else {
1.628     raeburn  17344:                     if ($sec eq '') {
                   17345:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   17346:                     } else {
                   17347:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   17348:                     }
1.443     albertel 17349:                 }
                   17350:             } else {
1.1115    raeburn  17351:                 if ($secchange) { 
1.628     raeburn  17352:                     $$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;
                   17353:                 } else {
                   17354:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   17355:                 }
1.443     albertel 17356:             }
                   17357:             $result = $modify_section_result;
                   17358:         } elsif ($secchange == 1) {
1.628     raeburn  17359:             if ($oldsec eq '') {
1.1103    raeburn  17360:                 $$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  17361:             } else {
                   17362:                 $$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;
                   17363:             }
1.626     raeburn  17364:             if ($expire_role_result eq 'refused') {
                   17365:                 my $newsecurl = '/'.$cid;
                   17366:                 $newsecurl =~ s/\_/\//g;
                   17367:                 if ($sec ne '') {
                   17368:                     $newsecurl.='/'.$sec;
                   17369:                 }
                   17370:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   17371:                     if ($sec eq '') {
                   17372:                         $$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;
                   17373:                     } else {
                   17374:                         $$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;
                   17375:                     }
                   17376:                 }
                   17377:             }
1.443     albertel 17378:         }
                   17379:     } else {
1.626     raeburn  17380:         $$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 17381:         $result = "error: incomplete course id\n";
                   17382:     }
                   17383:     return $result;
                   17384: }
                   17385: 
1.1108    raeburn  17386: sub show_role_extent {
                   17387:     my ($scope,$context,$role) = @_;
                   17388:     $scope =~ s{^/}{};
                   17389:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   17390:     push(@courseroles,'co');
                   17391:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   17392:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   17393:         $scope =~ s{/}{_};
                   17394:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   17395:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   17396:         my ($audom,$auname) = split(/\//,$scope);
                   17397:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   17398:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   17399:     } else {
                   17400:         $scope =~ s{/$}{};
                   17401:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   17402:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   17403:     }
                   17404: }
                   17405: 
1.443     albertel 17406: ############################################################
                   17407: ############################################################
                   17408: 
1.566     albertel 17409: sub check_clone {
1.578     raeburn  17410:     my ($args,$linefeed) = @_;
1.566     albertel 17411:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   17412:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   17413:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344    raeburn  17414:     my $clonetitle;
                   17415:     my @clonemsg;
1.566     albertel 17416:     my $can_clone = 0;
1.944     raeburn  17417:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  17418:     if ($lctype ne 'community') {
                   17419:         $lctype = 'course';
                   17420:     }
1.566     albertel 17421:     if ($clonehome eq 'no_host') {
1.944     raeburn  17422:         if ($args->{'crstype'} eq 'Community') {
1.1344    raeburn  17423:             push(@clonemsg,({
                   17424:                               mt => 'No new community created.',
                   17425:                               args => [],
                   17426:                             },
                   17427:                             {
                   17428:                               mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
                   17429:                               args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
                   17430:                             }));
1.908     raeburn  17431:         } else {
1.1344    raeburn  17432:             push(@clonemsg,({
                   17433:                               mt => 'No new course created.',
                   17434:                               args => [],
                   17435:                             },
                   17436:                             {
                   17437:                               mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
                   17438:                               args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   17439:                             }));
                   17440:         }
1.566     albertel 17441:     } else {
                   17442: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344    raeburn  17443:         $clonetitle = $clonedesc{'description'};
1.944     raeburn  17444:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  17445:             if ($clonedesc{'type'} ne 'Community') {
1.1344    raeburn  17446:                 push(@clonemsg,({
                   17447:                                   mt => 'No new community created.',
                   17448:                                   args => [],
                   17449:                                 },
                   17450:                                 {
                   17451:                                   mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
                   17452:                                   args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   17453:                                 }));
                   17454:                 return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908     raeburn  17455:             }
                   17456:         }
1.1262    raeburn  17457: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  17458:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 17459: 	    $can_clone = 1;
                   17460: 	} else {
1.1221    raeburn  17461: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 17462: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1221    raeburn  17463:             if ($clonehash{'cloners'} eq '') {
                   17464:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   17465:                 if ($domdefs{'canclone'}) {
                   17466:                     unless ($domdefs{'canclone'} eq 'none') {
                   17467:                         if ($domdefs{'canclone'} eq 'domain') {
                   17468:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   17469:                                 $can_clone = 1;
                   17470:                             }
                   17471:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) && 
                   17472:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   17473:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   17474:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   17475:                                 $can_clone = 1;
                   17476:                             }
                   17477:                         }
                   17478:                     }
                   17479:                 }
1.578     raeburn  17480:             } else {
1.1221    raeburn  17481: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   17482:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  17483:                     $can_clone = 1;
1.1221    raeburn  17484:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  17485:                     $can_clone = 1;
1.1225    raeburn  17486:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   17487:                     $can_clone = 1;
1.1221    raeburn  17488:                 }
                   17489:                 unless ($can_clone) {
1.1225    raeburn  17490:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) && 
                   17491:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1221    raeburn  17492:                         my (%gotdomdefaults,%gotcodedefaults);
                   17493:                         foreach my $cloner (@cloners) {
                   17494:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   17495:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   17496:                                 my (%codedefaults,@code_order);
                   17497:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   17498:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   17499:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   17500:                                     }
                   17501:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   17502:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   17503:                                     }
                   17504:                                 } else {
                   17505:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   17506:                                                                             \%codedefaults,
                   17507:                                                                             \@code_order);
                   17508:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   17509:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   17510:                                 }
                   17511:                                 if (@code_order > 0) {
                   17512:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   17513:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   17514:                                                                                 $args->{'crscode'})) {
                   17515:                                         $can_clone = 1;
                   17516:                                         last;
                   17517:                                     }
                   17518:                                 }
                   17519:                             }
                   17520:                         }
                   17521:                     }
1.1225    raeburn  17522:                 }
                   17523:             }
                   17524:             unless ($can_clone) {
                   17525:                 my $ccrole = 'cc';
                   17526:                 if ($args->{'crstype'} eq 'Community') {
                   17527:                     $ccrole = 'co';
                   17528:                 }
                   17529: 	        my %roleshash =
                   17530: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   17531: 					          $args->{'ccdomain'},
                   17532:                                                   'userroles',['active'],[$ccrole],
                   17533: 					          [$args->{'clonedomain'}]);
                   17534: 	        if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   17535:                     $can_clone = 1;
                   17536:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   17537:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   17538:                     $can_clone = 1;
1.1221    raeburn  17539:                 }
                   17540:             }
                   17541:             unless ($can_clone) {
                   17542:                 if ($args->{'crstype'} eq 'Community') {
1.1344    raeburn  17543:                     push(@clonemsg,({
                   17544:                                       mt => 'No new community created.',
                   17545:                                       args => [],
                   17546:                                     },
                   17547:                                     {
                   17548:                                       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]).',
                   17549:                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   17550:                                     }));
1.942     raeburn  17551:                 } else {
1.1344    raeburn  17552:                     push(@clonemsg,({
                   17553:                                       mt => 'No new course created.',
                   17554:                                       args => [],
                   17555:                                     },
                   17556:                                     {
                   17557:                                       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]).',
                   17558:                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   17559:                                     }));
1.1221    raeburn  17560:                 }
1.566     albertel 17561: 	    }
1.578     raeburn  17562:         }
1.566     albertel 17563:     }
1.1344    raeburn  17564:     return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566     albertel 17565: }
                   17566: 
1.444     albertel 17567: sub construct_course {
1.1262    raeburn  17568:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344    raeburn  17569:         $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
                   17570:     my ($outcome,$msgref,$clonemsgref);
1.541     raeburn  17571:     my $linefeed =  '<br />'."\n";
                   17572:     if ($context eq 'auto') {
                   17573:         $linefeed = "\n";
                   17574:     }
1.566     albertel 17575: 
                   17576: #
                   17577: # Are we cloning?
                   17578: #
1.1344    raeburn  17579:     my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566     albertel 17580:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344    raeburn  17581: 	($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566     albertel 17582:         if (!$can_clone) {
1.1344    raeburn  17583: 	    return (0,$outcome,$clonemsgref);
1.566     albertel 17584: 	}
                   17585:     }
                   17586: 
1.444     albertel 17587: #
                   17588: # Open course
                   17589: #
1.1239    raeburn  17590:     my $showncrstype;
                   17591:     if ($args->{'crstype'} eq 'Placement') {
                   17592:         $showncrstype = 'placement test'; 
                   17593:     } else {  
                   17594:         $showncrstype = lc($args->{'crstype'});
                   17595:     }
1.444     albertel 17596:     my %cenv=();
                   17597:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   17598:                                              $args->{'cdescr'},
                   17599:                                              $args->{'curl'},
                   17600:                                              $args->{'course_home'},
                   17601:                                              $args->{'nonstandard'},
                   17602:                                              $args->{'crscode'},
                   17603:                                              $args->{'ccuname'}.':'.
                   17604:                                              $args->{'ccdomain'},
1.882     raeburn  17605:                                              $args->{'crstype'},
1.1344    raeburn  17606:                                              $cnum,$context,$category,
                   17607:                                              $callercontext);
1.444     albertel 17608: 
                   17609:     # Note: The testing routines depend on this being output; see 
                   17610:     # Utils::Course. This needs to at least be output as a comment
                   17611:     # if anyone ever decides to not show this, and Utils::Course::new
                   17612:     # will need to be suitably modified.
1.1344    raeburn  17613:     if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   17614:         $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
                   17615:     } else {
                   17616:         $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
                   17617:     }
1.943     raeburn  17618:     if ($$courseid =~ /^error:/) {
1.1344    raeburn  17619:         return (0,$outcome,$clonemsgref);
1.943     raeburn  17620:     }
                   17621: 
1.444     albertel 17622: #
                   17623: # Check if created correctly
                   17624: #
1.479     albertel 17625:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 17626:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  17627:     if ($crsuhome eq 'no_host') {
1.1344    raeburn  17628:         if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   17629:             $outcome .= &mt_user($user_lh,
                   17630:                             'Course creation failed, unrecognized course home server.');
                   17631:         } else {
                   17632:             $outcome .= &mt('Course creation failed, unrecognized course home server.');
                   17633:         }
                   17634:         $outcome .= $linefeed;
                   17635:         return (0,$outcome,$clonemsgref);
1.943     raeburn  17636:     }
1.541     raeburn  17637:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 17638: 
1.444     albertel 17639: #
1.566     albertel 17640: # Do the cloning
                   17641: #   
1.1344    raeburn  17642:     my @clonemsg;
1.566     albertel 17643:     if ($can_clone && $cloneid) {
1.1344    raeburn  17644:         push(@clonemsg,
                   17645:                       {
                   17646:                           mt => 'Created [_1] by cloning from [_2]',
                   17647:                           args => [$showncrstype,$clonetitle],
                   17648:                       });
1.566     albertel 17649: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 17650: # Copy all files
1.1344    raeburn  17651:         my @info =
                   17652: 	    &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
                   17653: 	                                             $args->{'dateshift'},$args->{'crscode'},
                   17654:                                                      $args->{'ccuname'}.':'.$args->{'ccdomain'},
                   17655:                                                      $args->{'tinyurls'});
                   17656:         if (@info) {
                   17657:             push(@clonemsg,@info);
                   17658:         }
1.444     albertel 17659: # Restore URL
1.566     albertel 17660: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 17661: # Restore title
1.566     albertel 17662: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  17663: # Restore creation date, creator and creation context.
                   17664:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   17665:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   17666:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 17667: # Mark as cloned
1.566     albertel 17668: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      17669: # Need to clone grading mode
                   17670:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   17671:         $cenv{'grading'}=$newenv{'grading'};
                   17672: # Do not clone these environment entries
                   17673:         &Apache::lonnet::del('environment',
                   17674:                   ['default_enrollment_start_date',
                   17675:                    'default_enrollment_end_date',
                   17676:                    'question.email',
                   17677:                    'policy.email',
                   17678:                    'comment.email',
                   17679:                    'pch.users.denied',
1.725     raeburn  17680:                    'plc.users.denied',
                   17681:                    'hidefromcat',
1.1121    raeburn  17682:                    'checkforpriv',
1.1355    raeburn  17683:                    'categories'],
1.638     www      17684:                    $$crsudom,$$crsunum);
1.1170    raeburn  17685:         if ($args->{'textbook'}) {
                   17686:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   17687:         }
1.444     albertel 17688:     }
1.566     albertel 17689: 
1.444     albertel 17690: #
                   17691: # Set environment (will override cloned, if existing)
                   17692: #
                   17693:     my @sections = ();
                   17694:     my @xlists = ();
                   17695:     if ($args->{'crstype'}) {
                   17696:         $cenv{'type'}=$args->{'crstype'};
                   17697:     }
1.1371    raeburn  17698:     if ($args->{'lti'}) {
                   17699:         $cenv{'internal.lti'}=$args->{'lti'};
                   17700:     }
1.444     albertel 17701:     if ($args->{'crsid'}) {
                   17702:         $cenv{'courseid'}=$args->{'crsid'};
                   17703:     }
                   17704:     if ($args->{'crscode'}) {
                   17705:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   17706:     }
                   17707:     if ($args->{'crsquota'} ne '') {
                   17708:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   17709:     } else {
                   17710:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   17711:     }
                   17712:     if ($args->{'ccuname'}) {
                   17713:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   17714:                                         ':'.$args->{'ccdomain'};
                   17715:     } else {
                   17716:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   17717:     }
1.1116    raeburn  17718:     if ($args->{'defaultcredits'}) {
                   17719:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   17720:     }
1.444     albertel 17721:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412    raeburn  17722:     my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444     albertel 17723:     if ($args->{'crssections'}) {
                   17724:         $cenv{'internal.sectionnums'} = '';
                   17725:         if ($args->{'crssections'} =~ m/,/) {
                   17726:             @sections = split/,/,$args->{'crssections'};
                   17727:         } else {
                   17728:             $sections[0] = $args->{'crssections'};
                   17729:         }
                   17730:         if (@sections > 0) {
                   17731:             foreach my $item (@sections) {
                   17732:                 my ($sec,$gp) = split/:/,$item;
                   17733:                 my $class = $args->{'crscode'}.$sec;
                   17734:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   17735:                 $cenv{'internal.sectionnums'} .= $item.',';
1.1412    raeburn  17736:                 if ($addcheck eq 'ok') {
                   17737:                     unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
                   17738:                         push(@oklcsecs,$gp);
                   17739:                     }
                   17740:                 } else {
1.1263    raeburn  17741:                     push(@badclasses,$class);
1.444     albertel 17742:                 }
                   17743:             }
                   17744:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   17745:         }
                   17746:     }
                   17747: # do not hide course coordinator from staff listing, 
                   17748: # even if privileged
                   17749:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121    raeburn  17750: # add course coordinator's domain to domains to check for privileged users
                   17751: # if different to course domain
                   17752:     if ($$crsudom ne $args->{'ccdomain'}) {
                   17753:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   17754:     }
1.444     albertel 17755: # add crosslistings
                   17756:     if ($args->{'crsxlist'}) {
                   17757:         $cenv{'internal.crosslistings'}='';
                   17758:         if ($args->{'crsxlist'} =~ m/,/) {
                   17759:             @xlists = split/,/,$args->{'crsxlist'};
                   17760:         } else {
                   17761:             $xlists[0] = $args->{'crsxlist'};
                   17762:         }
                   17763:         if (@xlists > 0) {
                   17764:             foreach my $item (@xlists) {
                   17765:                 my ($xl,$gp) = split/:/,$item;
                   17766:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   17767:                 $cenv{'internal.crosslistings'} .= $item.',';
1.1412    raeburn  17768:                 if ($addcheck eq 'ok') {
                   17769:                     unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
                   17770:                         push(@oklcsecs,$gp);
                   17771:                     }
                   17772:                 } else {
1.1263    raeburn  17773:                     push(@badclasses,$xl);
1.444     albertel 17774:                 }
                   17775:             }
                   17776:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   17777:         }
                   17778:     }
                   17779:     if ($args->{'autoadds'}) {
                   17780:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   17781:     }
                   17782:     if ($args->{'autodrops'}) {
                   17783:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   17784:     }
                   17785: # check for notification of enrollment changes
                   17786:     my @notified = ();
                   17787:     if ($args->{'notify_owner'}) {
                   17788:         if ($args->{'ccuname'} ne '') {
                   17789:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   17790:         }
                   17791:     }
                   17792:     if ($args->{'notify_dc'}) {
                   17793:         if ($uname ne '') { 
1.630     raeburn  17794:             push(@notified,$uname.':'.$udom);
1.444     albertel 17795:         }
                   17796:     }
                   17797:     if (@notified > 0) {
                   17798:         my $notifylist;
                   17799:         if (@notified > 1) {
                   17800:             $notifylist = join(',',@notified);
                   17801:         } else {
                   17802:             $notifylist = $notified[0];
                   17803:         }
                   17804:         $cenv{'internal.notifylist'} = $notifylist;
                   17805:     }
                   17806:     if (@badclasses > 0) {
                   17807:         my %lt=&Apache::lonlocal::texthash(
1.1264    raeburn  17808:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   17809:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   17810:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 17811:         );
1.1264    raeburn  17812:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   17813:                            &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  17814:         if ($context eq 'auto') {
                   17815:             $outcome .= $badclass_msg.$linefeed;
1.1261    raeburn  17816:         } else {
1.566     albertel 17817:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261    raeburn  17818:         }
                   17819:         foreach my $item (@badclasses) {
1.541     raeburn  17820:             if ($context eq 'auto') {
1.1261    raeburn  17821:                 $outcome .= " - $item\n";
1.541     raeburn  17822:             } else {
1.1261    raeburn  17823:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  17824:             }
1.1261    raeburn  17825:         }
                   17826:         if ($context eq 'auto') {
                   17827:             $outcome .= $linefeed;
                   17828:         } else {
                   17829:             $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  17830:         } 
1.444     albertel 17831:     }
                   17832:     if ($args->{'no_end_date'}) {
                   17833:         $args->{'endaccess'} = 0;
                   17834:     }
1.1412    raeburn  17835: #  If an official course with institutional sections is created by cloning 
                   17836: #  an existing course, section-specific hiding of course totals in student's
                   17837: #  view of grades as copied from cloned course, will be checked for valid 
                   17838: #  sections.
                   17839:     if (($can_clone && $cloneid) &&
                   17840:         ($cenv{'internal.coursecode'} ne '') &&
                   17841:         ($cenv{'grading'} eq 'standard') &&
                   17842:         ($cenv{'hidetotals'} ne '') &&
                   17843:         ($cenv{'hidetotals'} ne 'all')) {
                   17844:         my @hidesecs;
                   17845:         my $deletehidetotals;
                   17846:         if (@oklcsecs) {
                   17847:             foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
                   17848:                 if (grep(/^\Q$sec$/,@oklcsecs)) {
                   17849:                     push(@hidesecs,$sec);
                   17850:                 }
                   17851:             }
                   17852:             if (@hidesecs) {
                   17853:                 $cenv{'hidetotals'} = join(',',@hidesecs);
                   17854:             } else {
                   17855:                 $deletehidetotals = 1;
                   17856:             }
                   17857:         } else {
                   17858:             $deletehidetotals = 1;
                   17859:         }
                   17860:         if ($deletehidetotals) {
                   17861:             delete($cenv{'hidetotals'});
                   17862:             &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
                   17863:         }
                   17864:     }
1.444     albertel 17865:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   17866:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   17867:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   17868:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   17869:     if ($args->{'showphotos'}) {
                   17870:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   17871:     }
                   17872:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   17873:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   17874:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   17875:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  17876:             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'); 
                   17877:             if ($context eq 'auto') {
                   17878:                 $outcome .= $krb_msg;
                   17879:             } else {
1.566     albertel 17880:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  17881:             }
                   17882:             $outcome .= $linefeed;
1.444     albertel 17883:         }
                   17884:     }
                   17885:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   17886:        if ($args->{'setpolicy'}) {
                   17887:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   17888:        }
                   17889:        if ($args->{'setcontent'}) {
                   17890:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   17891:        }
1.1251    raeburn  17892:        if ($args->{'setcomment'}) {
                   17893:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   17894:        }
1.444     albertel 17895:     }
                   17896:     if ($args->{'reshome'}) {
                   17897: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   17898: 	$cenv{'reshome'}=~s/\/+$/\//;
                   17899:     }
                   17900: #
                   17901: # course has keyed access
                   17902: #
                   17903:     if ($args->{'setkeys'}) {
                   17904:        $cenv{'keyaccess'}='yes';
                   17905:     }
                   17906: # if specified, key authority is not course, but user
                   17907: # only active if keyaccess is yes
                   17908:     if ($args->{'keyauth'}) {
1.487     albertel 17909: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   17910: 	$user = &LONCAPA::clean_username($user);
                   17911: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     17912: 	if ($user ne '' && $domain ne '') {
1.487     albertel 17913: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 17914: 	}
                   17915:     }
                   17916: 
1.1166    raeburn  17917: #
1.1167    raeburn  17918: #  generate and store uniquecode (available to course requester), if course should have one.
1.1166    raeburn  17919: #
                   17920:     if ($args->{'uniquecode'}) {
                   17921:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   17922:         if ($code) {
                   17923:             $cenv{'internal.uniquecode'} = $code;
1.1167    raeburn  17924:             my %crsinfo =
                   17925:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   17926:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   17927:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   17928:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   17929:             } 
1.1166    raeburn  17930:             if (ref($coderef)) {
                   17931:                 $$coderef = $code;
                   17932:             }
                   17933:         }
                   17934:     }
                   17935: 
1.444     albertel 17936:     if ($args->{'disresdis'}) {
                   17937:         $cenv{'pch.roles.denied'}='st';
                   17938:     }
                   17939:     if ($args->{'disablechat'}) {
                   17940:         $cenv{'plc.roles.denied'}='st';
                   17941:     }
                   17942: 
                   17943:     # Record we've not yet viewed the Course Initialization Helper for this 
                   17944:     # course
                   17945:     $cenv{'course.helper.not.run'} = 1;
                   17946:     #
                   17947:     # Use new Randomseed
                   17948:     #
                   17949:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   17950:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   17951:     #
                   17952:     # The encryption code and receipt prefix for this course
                   17953:     #
                   17954:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   17955:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   17956:     #
                   17957:     # By default, use standard grading
                   17958:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   17959: 
1.541     raeburn  17960:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   17961:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 17962: #
                   17963: # Open all assignments
                   17964: #
                   17965:     if ($args->{'openall'}) {
1.1341    raeburn  17966:        my $opendate = time;
                   17967:        if ($args->{'openallfrom'} =~ /^\d+$/) {
                   17968:            $opendate = $args->{'openallfrom'};
                   17969:        }
1.444     albertel 17970:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341    raeburn  17971:        my %storecontent = ($storeunder         => $opendate,
1.444     albertel 17972:                            $storeunder.'.type' => 'date_start');
1.1341    raeburn  17973:        $outcome .= &mt('All assignments open starting [_1]',
                   17974:                        &Apache::lonlocal::locallocaltime($opendate)).': '.
                   17975:                    &Apache::lonnet::cput
                   17976:                        ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 17977:    }
                   17978: #
                   17979: # Set first page
                   17980: #
                   17981:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   17982: 	    || ($cloneid)) {
                   17983: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 17984: 
                   17985: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   17986:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   17987: 
1.444     albertel 17988:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   17989:         my $title; my $url;
                   17990:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   17991: 	    $title=&mt('Syllabus');
1.444     albertel 17992:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   17993:         } else {
1.963     raeburn  17994:             $title=&mt('Table of Contents');
1.444     albertel 17995:             $url='/adm/navmaps';
                   17996:         }
1.445     albertel 17997: 
                   17998:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   17999: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   18000: 
                   18001: 	if ($errtext) { $fatal=2; }
1.541     raeburn  18002:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 18003:     }
1.566     albertel 18004: 
1.1237    raeburn  18005: # 
                   18006: # Set params for Placement Tests
                   18007: #
1.1239    raeburn  18008:     if ($args->{'crstype'} eq 'Placement') {
                   18009:        my %storecontent; 
                   18010:        my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
                   18011:        my %defaults = (
                   18012:                         buttonshide   => { value => 'yes',
                   18013:                                            type => 'string_yesno',},
                   18014:                         type          => { value => 'randomizetry',
                   18015:                                            type  => 'string_questiontype',},
                   18016:                         maxtries      => { value => 1,
                   18017:                                            type => 'int_pos',},
                   18018:                         problemstatus => { value => 'no',
                   18019:                                            type  => 'string_problemstatus',},
                   18020:                       );
                   18021:        foreach my $key (keys(%defaults)) {
                   18022:            $storecontent{$prefix.$key} = $defaults{$key}{'value'};
                   18023:            $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
                   18024:        }
1.1237    raeburn  18025:        &Apache::lonnet::cput
                   18026:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum); 
                   18027:     }
                   18028: 
1.1344    raeburn  18029:     return (1,$outcome,\@clonemsg);
1.444     albertel 18030: }
                   18031: 
1.1166    raeburn  18032: sub make_unique_code {
                   18033:     my ($cdom,$cnum) = @_;
                   18034:     # get lock on uniquecodes db
                   18035:     my $lockhash = {
                   18036:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   18037:                                                   ':'.$env{'user.domain'},
                   18038:                    };
                   18039:     my $tries = 0;
                   18040:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   18041:     my ($code,$error);
                   18042:   
                   18043:     while (($gotlock ne 'ok') && ($tries<3)) {
                   18044:         $tries ++;
                   18045:         sleep 1;
                   18046:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   18047:     }
                   18048:     if ($gotlock eq 'ok') {
                   18049:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   18050:         my $gotcode;
                   18051:         my $attempts = 0;
                   18052:         while ((!$gotcode) && ($attempts < 100)) {
                   18053:             $code = &generate_code();
                   18054:             if (!exists($currcodes{$code})) {
                   18055:                 $gotcode = 1;
                   18056:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   18057:                     $error = 'nostore';
                   18058:                 }
                   18059:             }
                   18060:             $attempts ++;
                   18061:         }
                   18062:         my @del_lock = ($cnum."\0".'uniquecodes');
                   18063:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   18064:     } else {
                   18065:         $error = 'nolock';
                   18066:     }
                   18067:     return ($code,$error);
                   18068: }
                   18069: 
                   18070: sub generate_code {
                   18071:     my $code;
                   18072:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   18073:     for (my $i=0; $i<6; $i++) {
                   18074:         my $lettnum = int (rand 2);
                   18075:         my $item = '';
                   18076:         if ($lettnum) {
                   18077:             $item = $letts[int( rand(18) )];
                   18078:         } else {
                   18079:             $item = 1+int( rand(8) );
                   18080:         }
                   18081:         $code .= $item;
                   18082:     }
                   18083:     return $code;
                   18084: }
                   18085: 
1.444     albertel 18086: ############################################################
                   18087: ############################################################
                   18088: 
1.1237    raeburn  18089: # Community, Course and Placement Test
1.378     raeburn  18090: sub course_type {
                   18091:     my ($cid) = @_;
                   18092:     if (!defined($cid)) {
                   18093:         $cid = $env{'request.course.id'};
                   18094:     }
1.404     albertel 18095:     if (defined($env{'course.'.$cid.'.type'})) {
                   18096:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  18097:     } else {
                   18098:         return 'Course';
1.377     raeburn  18099:     }
                   18100: }
1.156     albertel 18101: 
1.406     raeburn  18102: sub group_term {
                   18103:     my $crstype = &course_type();
                   18104:     my %names = (
                   18105:                   'Course' => 'group',
1.865     raeburn  18106:                   'Community' => 'group',
1.1237    raeburn  18107:                   'Placement' => 'group',
1.406     raeburn  18108:                 );
                   18109:     return $names{$crstype};
                   18110: }
                   18111: 
1.902     raeburn  18112: sub course_types {
1.1310    raeburn  18113:     my @types = ('official','unofficial','community','textbook','placement','lti');
1.902     raeburn  18114:     my %typename = (
                   18115:                          official   => 'Official course',
                   18116:                          unofficial => 'Unofficial course',
                   18117:                          community  => 'Community',
1.1165    raeburn  18118:                          textbook   => 'Textbook course',
1.1237    raeburn  18119:                          placement  => 'Placement test',
1.1310    raeburn  18120:                          lti        => 'LTI provider',
1.902     raeburn  18121:                    );
                   18122:     return (\@types,\%typename);
                   18123: }
                   18124: 
1.156     albertel 18125: sub icon {
                   18126:     my ($file)=@_;
1.505     albertel 18127:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 18128:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 18129:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 18130:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   18131: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   18132: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   18133: 	            $curfext.".gif") {
                   18134: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   18135: 		$curfext.".gif";
                   18136: 	}
                   18137:     }
1.249     albertel 18138:     return &lonhttpdurl($iconname);
1.154     albertel 18139: } 
1.84      albertel 18140: 
1.575     albertel 18141: sub lonhttpdurl {
1.692     www      18142: #
                   18143: # Had been used for "small fry" static images on separate port 8080.
                   18144: # Modify here if lightweight http functionality desired again.
                   18145: # Currently eliminated due to increasing firewall issues.
                   18146: #
1.575     albertel 18147:     my ($url)=@_;
1.692     www      18148:     return $url;
1.215     albertel 18149: }
                   18150: 
1.213     albertel 18151: sub connection_aborted {
                   18152:     my ($r)=@_;
                   18153:     $r->print(" ");$r->rflush();
                   18154:     my $c = $r->connection;
                   18155:     return $c->aborted();
                   18156: }
                   18157: 
1.221     foxr     18158: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     18159: #    strings as 'strings'.
                   18160: sub escape_single {
1.221     foxr     18161:     my ($input) = @_;
1.223     albertel 18162:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     18163:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   18164:     return $input;
                   18165: }
1.223     albertel 18166: 
1.222     foxr     18167: #  Same as escape_single, but escape's "'s  This 
                   18168: #  can be used for  "strings"
                   18169: sub escape_double {
                   18170:     my ($input) = @_;
                   18171:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   18172:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   18173:     return $input;
                   18174: }
1.223     albertel 18175:  
1.222     foxr     18176: #   Escapes the last element of a full URL.
                   18177: sub escape_url {
                   18178:     my ($url)   = @_;
1.238     raeburn  18179:     my @urlslices = split(/\//, $url,-1);
1.369     www      18180:     my $lastitem = &escape(pop(@urlslices));
1.1203    raeburn  18181:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     18182: }
1.462     albertel 18183: 
1.820     raeburn  18184: sub compare_arrays {
                   18185:     my ($arrayref1,$arrayref2) = @_;
                   18186:     my (@difference,%count);
                   18187:     @difference = ();
                   18188:     %count = ();
                   18189:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   18190:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   18191:         foreach my $element (keys(%count)) {
                   18192:             if ($count{$element} == 1) {
                   18193:                 push(@difference,$element);
                   18194:             }
                   18195:         }
                   18196:     }
                   18197:     return @difference;
                   18198: }
                   18199: 
1.1322    raeburn  18200: sub lon_status_items {
                   18201:     my %defaults = (
                   18202:                      E         => 100,
                   18203:                      W         => 4,
                   18204:                      N         => 1,
1.1324    raeburn  18205:                      U         => 5,
1.1322    raeburn  18206:                      threshold => 200,
                   18207:                      sysmail   => 2500,
                   18208:                    );
                   18209:     my %names = (
                   18210:                    E => 'Errors',
                   18211:                    W => 'Warnings',
                   18212:                    N => 'Notices',
1.1324    raeburn  18213:                    U => 'Unsent',
1.1322    raeburn  18214:                 );
                   18215:     return (\%defaults,\%names);
                   18216: }
                   18217: 
1.817     bisitz   18218: # -------------------------------------------------------- Initialize user login
1.462     albertel 18219: sub init_user_environment {
1.463     albertel 18220:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 18221:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   18222: 
                   18223:     my $public=($username eq 'public' && $domain eq 'public');
                   18224: 
1.1415    raeburn  18225:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
                   18226:         $coauthorenv);
1.462     albertel 18227:     my $now=time;
                   18228: 
                   18229:     if ($public) {
                   18230: 	my $max_public=100;
                   18231: 	my $oldest;
                   18232: 	my $oldest_time=0;
                   18233: 	for(my $next=1;$next<=$max_public;$next++) {
                   18234: 	    if (-e $lonids."/publicuser_$next.id") {
                   18235: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   18236: 		if ($mtime<$oldest_time || !$oldest_time) {
                   18237: 		    $oldest_time=$mtime;
                   18238: 		    $oldest=$next;
                   18239: 		}
                   18240: 	    } else {
                   18241: 		$cookie="publicuser_$next";
                   18242: 		last;
                   18243: 	    }
                   18244: 	}
                   18245: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   18246:     } else {
1.1275    raeburn  18247: 	# See if old ID present, if so, remove if this isn't a robot,
                   18248: 	# killing any existing non-robot sessions
1.463     albertel 18249: 	if (!$args->{'robot'}) {
                   18250: 	    opendir(DIR,$lonids);
                   18251: 	    while ($filename=readdir(DIR)) {
                   18252: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320    raeburn  18253:                     if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
                   18254:                             &GDBM_READER(),0640)) {
1.1295    raeburn  18255:                         my $linkedfile;
1.1320    raeburn  18256:                         if (exists($oldenv{'user.linkedenv'})) {
                   18257:                             $linkedfile = $oldenv{'user.linkedenv'};
1.1295    raeburn  18258:                         }
1.1320    raeburn  18259:                         untie(%oldenv);
                   18260:                         if (unlink("$lonids/$filename")) {
                   18261:                             if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                   18262:                                 if (-l "$lonids/$linkedfile.id") {
                   18263:                                     unlink("$lonids/$linkedfile.id");
                   18264:                                 }
1.1295    raeburn  18265:                             }
                   18266:                         }
                   18267:                     } else {
                   18268:                         unlink($lonids.'/'.$filename);
                   18269:                     }
1.463     albertel 18270: 		}
1.462     albertel 18271: 	    }
1.463     albertel 18272: 	    closedir(DIR);
1.1204    raeburn  18273: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   18274:             my $namespace = 'nohist_courseeditor';
                   18275:             my $lockingkey = 'paste'."\0".'locked_num';
                   18276:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   18277:                                                 $domain,$username);
                   18278:             if (exists($lockhash{$lockingkey})) {
                   18279:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   18280:                 unless ($delresult eq 'ok') {
                   18281:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   18282:                 }
                   18283:             }
1.462     albertel 18284: 	}
                   18285: # Give them a new cookie
1.463     albertel 18286: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      18287: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 18288: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 18289:     
                   18290: # Initialize roles
                   18291: 
1.1414    raeburn  18292: 	($userroles,$firstaccenv,$timerintenv,$coauthorenv) = 
1.1062    raeburn  18293:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 18294:     }
                   18295: # ------------------------------------ Check browser type and MathML capability
                   18296: 
1.1194    raeburn  18297:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   18298:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 18299: 
                   18300: # ------------------------------------------------------------- Get environment
                   18301: 
                   18302:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   18303:     my ($tmp) = keys(%userenv);
1.1275    raeburn  18304:     if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462     albertel 18305: 	undef(%userenv);
                   18306:     }
                   18307:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   18308: 	$form->{'interface'}=$userenv{'interface'};
                   18309:     }
                   18310:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   18311: 
                   18312: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   18313:     foreach my $option ('interface','localpath','localres') {
                   18314:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 18315:     }
                   18316: # --------------------------------------------------------- Write first profile
                   18317: 
                   18318:     {
1.1350    raeburn  18319:         my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462     albertel 18320: 	my %initial_env = 
                   18321: 	    ("user.name"          => $username,
                   18322: 	     "user.domain"        => $domain,
                   18323: 	     "user.home"          => $authhost,
                   18324: 	     "browser.type"       => $clientbrowser,
                   18325: 	     "browser.version"    => $clientversion,
                   18326: 	     "browser.mathml"     => $clientmathml,
                   18327: 	     "browser.unicode"    => $clientunicode,
                   18328: 	     "browser.os"         => $clientos,
1.1137    raeburn  18329:              "browser.mobile"     => $clientmobile,
1.1141    raeburn  18330:              "browser.info"       => $clientinfo,
1.1194    raeburn  18331:              "browser.osversion"  => $clientosversion,
1.462     albertel 18332: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   18333: 	     "request.course.fn"  => '',
                   18334: 	     "request.course.uri" => '',
                   18335: 	     "request.course.sec" => '',
                   18336: 	     "request.role"       => 'cm',
                   18337: 	     "request.role.adv"   => $env{'user.adv'},
1.1350    raeburn  18338: 	     "request.host"       => $ip,);
1.462     albertel 18339: 
                   18340:         if ($form->{'localpath'}) {
                   18341: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   18342: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   18343:         }
                   18344: 	
                   18345: 	if ($form->{'interface'}) {
                   18346: 	    $form->{'interface'}=~s/\W//gs;
                   18347: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   18348: 	    $env{'browser.interface'}=$form->{'interface'};
                   18349: 	}
                   18350: 
1.1157    raeburn  18351:         if ($form->{'iptoken'}) {
                   18352:             my $lonhost = $r->dir_config('lonHostID');
                   18353:             $initial_env{"user.noloadbalance"} = $lonhost;
                   18354:             $env{'user.noloadbalance'} = $lonhost;
                   18355:         }
                   18356: 
1.1268    raeburn  18357:         if ($form->{'noloadbalance'}) {
                   18358:             my @hosts = &Apache::lonnet::current_machine_ids();
                   18359:             my $hosthere = $form->{'noloadbalance'};
                   18360:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   18361:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   18362:                 $env{'user.noloadbalance'} = $hosthere;
                   18363:             }
                   18364:         }
                   18365: 
1.1016    raeburn  18366:         unless ($domain eq 'public') {
1.1273    raeburn  18367:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   18368:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
                   18369: 
1.1414    raeburn  18370:             foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
                   18371:                 $userenv{'availabletools.'.$tool} =
1.1273    raeburn  18372:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   18373:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   18374:             }
1.980     raeburn  18375: 
1.1311    raeburn  18376:             foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273    raeburn  18377:                 $userenv{'canrequest.'.$crstype} =
                   18378:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   18379:                                                       'reload','requestcourses',
                   18380:                                                       \%userenv,\%domdef,\%is_adv);
                   18381:             }
1.724     raeburn  18382: 
1.1418    raeburn  18383:             if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
                   18384:                 (exists($userroles->{"user.role.au./$domain/"}))) {
                   18385:                 if ($userenv{'authoreditors'}) {
                   18386:                     $userenv{'editors'} = $userenv{'authoreditors'};
                   18387:                 } elsif ($domdef{'editors'} ne '') {
                   18388:                     $userenv{'editors'} = $domdef{'editors'};
                   18389:                 } else {
                   18390:                     $userenv{'editors'} = 'edit,xml';
                   18391:                 }
1.1431    raeburn  18392:                 if ($userenv{'authorarchive'}) {
                   18393:                     $userenv{'canarchive'} = 1;
                   18394:                 } elsif (($userenv{'authorarchive'} eq '') &&
                   18395:                          ($domdef{'archive'})) {
                   18396:                     $userenv{'canarchive'} = 1;
                   18397:                 }
1.1418    raeburn  18398:             }
                   18399: 
1.1273    raeburn  18400:             $userenv{'canrequest.author'} =
                   18401:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   18402:                                                   'reload','requestauthor',
1.980     raeburn  18403:                                                   \%userenv,\%domdef,\%is_adv);
1.1273    raeburn  18404:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   18405:                                                  $domain,$username);
                   18406:             my $reqstatus = $reqauthor{'author_status'};
                   18407:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') { 
                   18408:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   18409:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   18410:                                                       $reqauthor{'author'}{'timestamp'};
                   18411:                 }
1.1092    raeburn  18412:             }
1.1287    raeburn  18413:             my ($types,$typename) = &course_types();
                   18414:             if (ref($types) eq 'ARRAY') {
                   18415:                 my @options = ('approval','validate','autolimit');
                   18416:                 my $optregex = join('|',@options);
                   18417:                 my (%willtrust,%trustchecked);
                   18418:                 foreach my $type (@{$types}) {
                   18419:                     my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
                   18420:                     if ($dom_str ne '') {
                   18421:                         my $updatedstr = '';
                   18422:                         my @possdomains = split(',',$dom_str);
                   18423:                         foreach my $entry (@possdomains) {
                   18424:                             my ($extdom,$extopt) = split(':',$entry);
                   18425:                             unless ($trustchecked{$extdom}) {
                   18426:                                 $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
                   18427:                                 $trustchecked{$extdom} = 1;
                   18428:                             }
                   18429:                             if ($willtrust{$extdom}) {
                   18430:                                 $updatedstr .= $entry.',';
                   18431:                             }
                   18432:                         }
                   18433:                         $updatedstr =~ s/,$//;
                   18434:                         if ($updatedstr) {
                   18435:                             $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
                   18436:                         } else {
                   18437:                             delete($userenv{'reqcrsotherdom.'.$type});
                   18438:                         }
                   18439:                     }
                   18440:                 }
                   18441:             }
1.1092    raeburn  18442:         }
1.462     albertel 18443: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  18444: 
1.462     albertel 18445: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   18446: 		 &GDBM_WRCREAT(),0640)) {
                   18447: 	    &_add_to_env(\%disk_env,\%initial_env);
                   18448: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   18449: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  18450:             if (ref($firstaccenv) eq 'HASH') {
                   18451:                 &_add_to_env(\%disk_env,$firstaccenv);
                   18452:             }
                   18453:             if (ref($timerintenv) eq 'HASH') {
                   18454:                 &_add_to_env(\%disk_env,$timerintenv);
                   18455:             }
1.1414    raeburn  18456:             if (ref($coauthorenv) eq 'HASH') {
                   18457:                 if (keys(%{$coauthorenv})) {
                   18458:                     &_add_to_env(\%disk_env,$coauthorenv);
                   18459:                 }
                   18460:             }
1.463     albertel 18461: 	    if (ref($args->{'extra_env'})) {
                   18462: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   18463: 	    }
1.462     albertel 18464: 	    untie(%disk_env);
                   18465: 	} else {
1.705     tempelho 18466: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   18467: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 18468: 	    return 'error: '.$!;
                   18469: 	}
                   18470:     }
                   18471:     $env{'request.role'}='cm';
                   18472:     $env{'request.role.adv'}=$env{'user.adv'};
                   18473:     $env{'browser.type'}=$clientbrowser;
                   18474: 
                   18475:     return $cookie;
                   18476: 
                   18477: }
                   18478: 
                   18479: sub _add_to_env {
                   18480:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  18481:     if (ref($env_data) eq 'HASH') {
                   18482:         while (my ($key,$value) = each(%$env_data)) {
                   18483: 	    $idf->{$prefix.$key} = $value;
                   18484: 	    $env{$prefix.$key}   = $value;
                   18485:         }
1.462     albertel 18486:     }
                   18487: }
                   18488: 
1.685     tempelho 18489: # --- Get the symbolic name of a problem and the url
                   18490: sub get_symb {
                   18491:     my ($request,$silent) = @_;
1.726     raeburn  18492:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 18493:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   18494:     if ($symb eq '') {
                   18495:         if (!$silent) {
1.1071    raeburn  18496:             if (ref($request)) { 
                   18497:                 $request->print("Unable to handle ambiguous references:$url:.");
                   18498:             }
1.685     tempelho 18499:             return ();
                   18500:         }
                   18501:     }
                   18502:     &Apache::lonenc::check_decrypt(\$symb);
                   18503:     return ($symb);
                   18504: }
                   18505: 
                   18506: # --------------------------------------------------------------Get annotation
                   18507: 
                   18508: sub get_annotation {
                   18509:     my ($symb,$enc) = @_;
                   18510: 
                   18511:     my $key = $symb;
                   18512:     if (!$enc) {
                   18513:         $key =
                   18514:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   18515:     }
                   18516:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   18517:     return $annotation{$key};
                   18518: }
                   18519: 
                   18520: sub clean_symb {
1.731     raeburn  18521:     my ($symb,$delete_enc) = @_;
1.685     tempelho 18522: 
                   18523:     &Apache::lonenc::check_decrypt(\$symb);
                   18524:     my $enc = $env{'request.enc'};
1.731     raeburn  18525:     if ($delete_enc) {
1.730     raeburn  18526:         delete($env{'request.enc'});
                   18527:     }
1.685     tempelho 18528: 
                   18529:     return ($symb,$enc);
                   18530: }
1.462     albertel 18531: 
1.1181    raeburn  18532: ############################################################
                   18533: ############################################################
                   18534: 
                   18535: =pod
                   18536: 
                   18537: =head1 Routines for building display used to search for courses
                   18538: 
                   18539: 
                   18540: =over 4
                   18541: 
                   18542: =item * &build_filters()
                   18543: 
                   18544: Create markup for a table used to set filters to use when selecting
1.1182    raeburn  18545: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   18546: and quotacheck.pl
                   18547: 
1.1181    raeburn  18548: 
                   18549: Inputs:
                   18550: 
                   18551: filterlist - anonymous array of fields to include as potential filters 
                   18552: 
                   18553: crstype - course type
                   18554: 
                   18555: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   18556:               to pop-open a course selector (will contain "extra element"). 
                   18557: 
                   18558: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   18559: 
                   18560: filter - anonymous hash of criteria and their values
                   18561: 
                   18562: action - form action
                   18563: 
                   18564: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   18565: 
1.1182    raeburn  18566: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181    raeburn  18567: 
                   18568: cloneruname - username of owner of new course who wants to clone
                   18569: 
                   18570: clonerudom - domain of owner of new course who wants to clone
                   18571: 
                   18572: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community) 
                   18573: 
                   18574: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   18575: 
                   18576: codedom - domain
                   18577: 
                   18578: formname - value of form element named "form". 
                   18579: 
                   18580: fixeddom - domain, if fixed.
                   18581: 
                   18582: prevphase - value to assign to form element named "phase" when going back to the previous screen  
                   18583: 
                   18584: cnameelement - name of form element in form on opener page which will receive title of selected course 
                   18585: 
                   18586: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   18587: 
                   18588: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   18589: 
                   18590: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   18591: 
                   18592: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   18593: 
                   18594: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   18595: 
1.1182    raeburn  18596: 
1.1181    raeburn  18597: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   18598: 
1.1182    raeburn  18599: 
1.1181    raeburn  18600: Side Effects: None
                   18601: 
                   18602: =cut
                   18603: 
                   18604: # ---------------------------------------------- search for courses based on last activity etc.
                   18605: 
                   18606: sub build_filters {
                   18607:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   18608:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   18609:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   18610:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   18611:         $clonetext,$clonewarning) = @_;
1.1182    raeburn  18612:     my ($list,$jscript);
1.1181    raeburn  18613:     my $onchange = 'javascript:updateFilters(this)';
                   18614:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   18615:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   18616:         $typeselectform,$instcodetitle);
                   18617:     if ($formname eq '') {
                   18618:         $formname = $caller;
                   18619:     }
                   18620:     foreach my $item (@{$filterlist}) {
                   18621:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   18622:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   18623:             if ($item eq 'domainfilter') {
                   18624:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   18625:             } elsif ($item eq 'coursefilter') {
                   18626:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   18627:             } elsif ($item eq 'ownerfilter') {
                   18628:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   18629:             } elsif ($item eq 'ownerdomfilter') {
                   18630:                 $filter->{'ownerdomfilter'} =
                   18631:                     &LONCAPA::clean_domain($filter->{$item});
                   18632:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   18633:                                                        'ownerdomfilter',1);
                   18634:             } elsif ($item eq 'personfilter') {
                   18635:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   18636:             } elsif ($item eq 'persondomfilter') {
                   18637:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   18638:                                                         'persondomfilter',1);
                   18639:             } else {
                   18640:                 $filter->{$item} =~ s/\W//g;
                   18641:             }
                   18642:             if (!$filter->{$item}) {
                   18643:                 $filter->{$item} = '';
                   18644:             }
                   18645:         }
                   18646:         if ($item eq 'domainfilter') {
                   18647:             my $allow_blank = 1;
                   18648:             if ($formname eq 'portform') {
                   18649:                 $allow_blank=0;
                   18650:             } elsif ($formname eq 'studentform') {
                   18651:                 $allow_blank=0;
                   18652:             }
                   18653:             if ($fixeddom) {
                   18654:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   18655:                                     ' value="'.$codedom.'" />'.
                   18656:                                     &Apache::lonnet::domain($codedom,'description');
                   18657:             } else {
                   18658:                 $domainselectform = &select_dom_form($filter->{$item},
                   18659:                                                      'domainfilter',
                   18660:                                                       $allow_blank,'',$onchange);
                   18661:             }
                   18662:         } else {
                   18663:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   18664:         }
                   18665:     }
                   18666: 
                   18667:     # last course activity filter and selection
                   18668:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   18669: 
                   18670:     # course created filter and selection
                   18671:     if (exists($filter->{'createdfilter'})) {
                   18672:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   18673:     }
                   18674: 
1.1239    raeburn  18675:     my $prefix = $crstype;
                   18676:     if ($crstype eq 'Placement') {
                   18677:         $prefix = 'Placement Test'
                   18678:     }
1.1181    raeburn  18679:     my %lt = &Apache::lonlocal::texthash(
1.1239    raeburn  18680:                 'cac' => "$prefix Activity",
                   18681:                 'ccr' => "$prefix Created",
                   18682:                 'cde' => "$prefix Title",
                   18683:                 'cdo' => "$prefix Domain",
1.1181    raeburn  18684:                 'ins' => 'Institutional Code',
                   18685:                 'inc' => 'Institutional Categorization',
1.1239    raeburn  18686:                 'cow' => "$prefix Owner/Co-owner",
                   18687:                 'cop' => "$prefix Personnel Includes",
1.1181    raeburn  18688:                 'cog' => 'Type',
                   18689:              );
                   18690: 
                   18691:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   18692:         my $typeval = 'Course';
                   18693:         if ($crstype eq 'Community') {
                   18694:             $typeval = 'Community';
1.1239    raeburn  18695:         } elsif ($crstype eq 'Placement') {
                   18696:             $typeval = 'Placement';
1.1181    raeburn  18697:         }
                   18698:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   18699:     } else {
                   18700:         $typeselectform =  '<select name="type" size="1"';
                   18701:         if ($onchange) {
                   18702:             $typeselectform .= ' onchange="'.$onchange.'"';
                   18703:         }
                   18704:         $typeselectform .= '>'."\n";
1.1237    raeburn  18705:         foreach my $posstype ('Course','Community','Placement') {
1.1239    raeburn  18706:             my $shown;
                   18707:             if ($posstype eq 'Placement') {
                   18708:                 $shown = &mt('Placement Test');
                   18709:             } else {
                   18710:                 $shown = &mt($posstype);
                   18711:             }
1.1181    raeburn  18712:             $typeselectform.='<option value="'.$posstype.'"'.
1.1239    raeburn  18713:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181    raeburn  18714:         }
                   18715:         $typeselectform.="</select>";
                   18716:     }
                   18717: 
                   18718:     my ($cloneableonlyform,$cloneabletitle);
                   18719:     if (exists($filter->{'cloneableonly'})) {
                   18720:         my $cloneableon = '';
                   18721:         my $cloneableoff = ' checked="checked"';
                   18722:         if ($filter->{'cloneableonly'}) {
                   18723:             $cloneableon = $cloneableoff;
                   18724:             $cloneableoff = '';
                   18725:         }
                   18726:         $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>';
                   18727:         if ($formname eq 'ccrs') {
1.1187    bisitz   18728:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181    raeburn  18729:         } else {
                   18730:             $cloneabletitle = &mt('Cloneable by you');
                   18731:         }
                   18732:     }
                   18733:     my $officialjs;
                   18734:     if ($crstype eq 'Course') {
                   18735:         if (exists($filter->{'instcodefilter'})) {
1.1182    raeburn  18736: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   18737: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   18738:             if ($codedom) { 
1.1181    raeburn  18739:                 $officialjs = 1;
                   18740:                 ($instcodeform,$jscript,$$numtitlesref) =
                   18741:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   18742:                                                                   $officialjs,$codetitlesref);
                   18743:                 if ($jscript) {
1.1182    raeburn  18744:                     $jscript = '<script type="text/javascript">'."\n".
                   18745:                                '// <![CDATA['."\n".
                   18746:                                $jscript."\n".
                   18747:                                '// ]]>'."\n".
                   18748:                                '</script>'."\n";
1.1181    raeburn  18749:                 }
                   18750:             }
                   18751:             if ($instcodeform eq '') {
                   18752:                 $instcodeform =
                   18753:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   18754:                     $list->{'instcodefilter'}.'" />';
                   18755:                 $instcodetitle = $lt{'ins'};
                   18756:             } else {
                   18757:                 $instcodetitle = $lt{'inc'};
                   18758:             }
                   18759:             if ($fixeddom) {
                   18760:                 $instcodetitle .= '<br />('.$codedom.')';
                   18761:             }
                   18762:         }
                   18763:     }
                   18764:     my $output = qq|
                   18765: <form method="post" name="filterpicker" action="$action">
                   18766: <input type="hidden" name="form" value="$formname" />
                   18767: |;
                   18768:     if ($formname eq 'modifycourse') {
                   18769:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   18770:                    '<input type="hidden" name="prevphase" value="'.
                   18771:                    $prevphase.'" />'."\n";
1.1198    musolffc 18772:     } elsif ($formname eq 'quotacheck') {
                   18773:         $output .= qq|
                   18774: <input type="hidden" name="sortby" value="" />
                   18775: <input type="hidden" name="sortorder" value="" />
                   18776: |;
                   18777:     } else {
1.1181    raeburn  18778:         my $name_input;
                   18779:         if ($cnameelement ne '') {
                   18780:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   18781:                           $cnameelement.'" />';
                   18782:         }
                   18783:         $output .= qq|
1.1182    raeburn  18784: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   18785: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181    raeburn  18786: $name_input
                   18787: $roleelement
                   18788: $multelement
                   18789: $typeelement
                   18790: |;
                   18791:         if ($formname eq 'portform') {
                   18792:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   18793:         }
                   18794:     }
                   18795:     if ($fixeddom) {
                   18796:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   18797:     }
                   18798:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   18799:     if ($sincefilterform) {
                   18800:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   18801:                   .$sincefilterform
                   18802:                   .&Apache::lonhtmlcommon::row_closure();
                   18803:     }
                   18804:     if ($createdfilterform) {
                   18805:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   18806:                   .$createdfilterform
                   18807:                   .&Apache::lonhtmlcommon::row_closure();
                   18808:     }
                   18809:     if ($domainselectform) {
                   18810:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   18811:                   .$domainselectform
                   18812:                   .&Apache::lonhtmlcommon::row_closure();
                   18813:     }
                   18814:     if ($typeselectform) {
                   18815:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   18816:             $output .= $typeselectform;
                   18817:         } else {
                   18818:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   18819:                       .$typeselectform
                   18820:                       .&Apache::lonhtmlcommon::row_closure();
                   18821:         }
                   18822:     }
                   18823:     if ($instcodeform) {
                   18824:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   18825:                   .$instcodeform
                   18826:                   .&Apache::lonhtmlcommon::row_closure();
                   18827:     }
                   18828:     if (exists($filter->{'ownerfilter'})) {
                   18829:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   18830:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   18831:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   18832:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   18833:                    $ownerdomselectform.'</td></tr></table>'.
                   18834:                    &Apache::lonhtmlcommon::row_closure();
                   18835:     }
                   18836:     if (exists($filter->{'personfilter'})) {
                   18837:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   18838:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   18839:                    '<input type="text" name="personfilter" size="20" value="'.
                   18840:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   18841:                    $persondomselectform.'</td></tr></table>'.
                   18842:                    &Apache::lonhtmlcommon::row_closure();
                   18843:     }
                   18844:     if (exists($filter->{'coursefilter'})) {
                   18845:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   18846:                   .'<input type="text" name="coursefilter" size="25" value="'
                   18847:                   .$list->{'coursefilter'}.'" />'
                   18848:                   .&Apache::lonhtmlcommon::row_closure();
                   18849:     }
                   18850:     if ($cloneableonlyform) {
                   18851:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   18852:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   18853:     }
                   18854:     if (exists($filter->{'descriptfilter'})) {
                   18855:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   18856:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   18857:                   .$list->{'descriptfilter'}.'" />'
                   18858:                   .&Apache::lonhtmlcommon::row_closure(1);
                   18859:     }
                   18860:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   18861:                '<input type="hidden" name="updater" value="" />'."\n".
                   18862:                '<input type="submit" name="gosearch" value="'.
                   18863:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   18864:     return $jscript.$clonewarning.$output;
                   18865: }
                   18866: 
                   18867: =pod 
                   18868: 
                   18869: =item * &timebased_select_form()
                   18870: 
1.1182    raeburn  18871: Create markup for a dropdown list used to select a time-based
1.1181    raeburn  18872: filter e.g., Course Activity, Course Created, when searching for courses
                   18873: or communities
                   18874: 
                   18875: Inputs:
                   18876: 
                   18877: item - name of form element (sincefilter or createdfilter)
                   18878: 
                   18879: filter - anonymous hash of criteria and their values
                   18880: 
                   18881: Returns: HTML for a select box contained a blank, then six time selections,
                   18882:          with value set in incoming form variables currently selected. 
                   18883: 
                   18884: Side Effects: None
                   18885: 
                   18886: =cut
                   18887: 
                   18888: sub timebased_select_form {
                   18889:     my ($item,$filter) = @_;
                   18890:     if (ref($filter) eq 'HASH') {
                   18891:         $filter->{$item} =~ s/[^\d-]//g;
                   18892:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   18893:         return &select_form(
                   18894:                             $filter->{$item},
                   18895:                             $item,
                   18896:                             {      '-1' => '',
                   18897:                                 '86400' => &mt('today'),
                   18898:                                '604800' => &mt('last week'),
                   18899:                               '2592000' => &mt('last month'),
                   18900:                               '7776000' => &mt('last three months'),
                   18901:                              '15552000' => &mt('last six months'),
                   18902:                              '31104000' => &mt('last year'),
                   18903:                     'select_form_order' =>
                   18904:                            ['-1','86400','604800','2592000','7776000',
                   18905:                             '15552000','31104000']});
                   18906:     }
                   18907: }
                   18908: 
                   18909: =pod
                   18910: 
                   18911: =item * &js_changer()
                   18912: 
                   18913: Create script tag containing Javascript used to submit course search form
1.1183    raeburn  18914: when course type or domain is changed, and also to hide 'Searching ...' on
                   18915: page load completion for page showing search result.
1.1181    raeburn  18916: 
                   18917: Inputs: None
                   18918: 
1.1183    raeburn  18919: Returns: markup containing updateFilters() and hideSearching() javascript functions. 
1.1181    raeburn  18920: 
                   18921: Side Effects: None
                   18922: 
                   18923: =cut
                   18924: 
                   18925: sub js_changer {
                   18926:     return <<ENDJS;
                   18927: <script type="text/javascript">
                   18928: // <![CDATA[
                   18929: function updateFilters(caller) {
                   18930:     if (typeof(caller) != "undefined") {
                   18931:         document.filterpicker.updater.value = caller.name;
                   18932:     }
                   18933:     document.filterpicker.submit();
                   18934: }
1.1183    raeburn  18935: 
                   18936: function hideSearching() {
                   18937:     if (document.getElementById('searching')) {
                   18938:         document.getElementById('searching').style.display = 'none';
                   18939:     }
                   18940:     return;
                   18941: }
                   18942: 
1.1181    raeburn  18943: // ]]>
                   18944: </script>
                   18945: 
                   18946: ENDJS
                   18947: }
                   18948: 
                   18949: =pod
                   18950: 
1.1182    raeburn  18951: =item * &search_courses()
                   18952: 
                   18953: Process selected filters form course search form and pass to lonnet::courseiddump
                   18954: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   18955: 
                   18956: Inputs:
                   18957: 
                   18958: dom - domain being searched 
                   18959: 
                   18960: type - course type ('Course' or 'Community' or '.' if any).
                   18961: 
                   18962: filter - anonymous hash of criteria and their values
                   18963: 
                   18964: numtitles - for institutional codes - number of categories
                   18965: 
                   18966: cloneruname - optional username of new course owner
                   18967: 
                   18968: clonerudom - optional domain of new course owner
                   18969: 
1.1221    raeburn  18970: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by, 
1.1182    raeburn  18971:             (used when DC is using course creation form)
                   18972: 
                   18973: codetitles - reference to array of titles of components in institutional codes (official courses).
                   18974: 
1.1221    raeburn  18975: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   18976:            (and so can clone automatically)
                   18977: 
                   18978: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   18979: 
                   18980: reqinstcode - institutional code of new course, where search_courses is used to identify potential 
                   18981:               courses to clone 
1.1182    raeburn  18982: 
                   18983: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   18984: 
                   18985: 
                   18986: Side Effects: None
                   18987: 
                   18988: =cut
                   18989: 
                   18990: 
                   18991: sub search_courses {
1.1221    raeburn  18992:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   18993:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182    raeburn  18994:     my (%courses,%showcourses,$cloner);
                   18995:     if (($filter->{'ownerfilter'} ne '') ||
                   18996:         ($filter->{'ownerdomfilter'} ne '')) {
                   18997:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   18998:                                        $filter->{'ownerdomfilter'};
                   18999:     }
                   19000:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   19001:         if (!$filter->{$item}) {
                   19002:             $filter->{$item}='.';
                   19003:         }
                   19004:     }
                   19005:     my $now = time;
                   19006:     my $timefilter =
                   19007:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   19008:     my ($createdbefore,$createdafter);
                   19009:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   19010:         $createdbefore = $now;
                   19011:         $createdafter = $now-$filter->{'createdfilter'};
                   19012:     }
                   19013:     my ($instcodefilter,$regexpok);
                   19014:     if ($numtitles) {
                   19015:         if ($env{'form.official'} eq 'on') {
                   19016:             $instcodefilter =
                   19017:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   19018:             $regexpok = 1;
                   19019:         } elsif ($env{'form.official'} eq 'off') {
                   19020:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   19021:             unless ($instcodefilter eq '') {
                   19022:                 $regexpok = -1;
                   19023:             }
                   19024:         }
                   19025:     } else {
                   19026:         $instcodefilter = $filter->{'instcodefilter'};
                   19027:     }
                   19028:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   19029:     if ($type eq '') { $type = '.'; }
                   19030: 
                   19031:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   19032:         $cloner = $cloneruname.':'.$clonerudom;
                   19033:     }
                   19034:     %courses = &Apache::lonnet::courseiddump($dom,
                   19035:                                              $filter->{'descriptfilter'},
                   19036:                                              $timefilter,
                   19037:                                              $instcodefilter,
                   19038:                                              $filter->{'combownerfilter'},
                   19039:                                              $filter->{'coursefilter'},
                   19040:                                              undef,undef,$type,$regexpok,undef,undef,
1.1221    raeburn  19041:                                              undef,undef,$cloner,$cc_clone,
1.1182    raeburn  19042:                                              $filter->{'cloneableonly'},
                   19043:                                              $createdbefore,$createdafter,undef,
1.1221    raeburn  19044:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182    raeburn  19045:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   19046:         my $ccrole;
                   19047:         if ($type eq 'Community') {
                   19048:             $ccrole = 'co';
                   19049:         } else {
                   19050:             $ccrole = 'cc';
                   19051:         }
                   19052:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   19053:                                                      $filter->{'persondomfilter'},
                   19054:                                                      'userroles',undef,
                   19055:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   19056:                                                      $dom);
                   19057:         foreach my $role (keys(%rolehash)) {
                   19058:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   19059:             my $cid = $cdom.'_'.$cnum;
                   19060:             if (exists($courses{$cid})) {
                   19061:                 if (ref($courses{$cid}) eq 'HASH') {
                   19062:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   19063:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263    raeburn  19064:                             push(@{$courses{$cid}{roles}},$courserole);
1.1182    raeburn  19065:                         }
                   19066:                     } else {
                   19067:                         $courses{$cid}{roles} = [$courserole];
                   19068:                     }
                   19069:                     $showcourses{$cid} = $courses{$cid};
                   19070:                 }
                   19071:             }
                   19072:         }
                   19073:         %courses = %showcourses;
                   19074:     }
                   19075:     return %courses;
                   19076: }
                   19077: 
                   19078: =pod
                   19079: 
1.1181    raeburn  19080: =back
                   19081: 
1.1207    raeburn  19082: =head1 Routines for version requirements for current course.
                   19083: 
                   19084: =over 4
                   19085: 
                   19086: =item * &check_release_required()
                   19087: 
                   19088: Compares required LON-CAPA version with version on server, and
                   19089: if required version is newer looks for a server with the required version.
                   19090: 
                   19091: Looks first at servers in user's owen domain; if none suitable, looks at
                   19092: servers in course's domain are permitted to host sessions for user's domain.
                   19093: 
                   19094: Inputs:
                   19095: 
                   19096: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   19097: 
                   19098: $courseid - Course ID of current course
                   19099: 
                   19100: $rolecode - User's current role in course (for switchserver query string).
                   19101: 
                   19102: $required - LON-CAPA version needed by course (format: Major.Minor).
                   19103: 
                   19104: 
                   19105: Returns:
                   19106: 
                   19107: $switchserver - query string tp append to /adm/switchserver call (if 
                   19108:                 current server's LON-CAPA version is too old. 
                   19109: 
                   19110: $warning - Message is displayed if no suitable server could be found.
                   19111: 
                   19112: =cut
                   19113: 
                   19114: sub check_release_required {
                   19115:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   19116:     my ($switchserver,$warning);
                   19117:     if ($required ne '') {
                   19118:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   19119:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   19120:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   19121:             my $otherserver;
                   19122:             if (($major eq '' && $minor eq '') ||
                   19123:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   19124:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   19125:                 my $switchlcrev =
                   19126:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   19127:                                                            $userdomserver);
                   19128:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   19129:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   19130:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   19131:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   19132:                     if ($cdom ne $env{'user.domain'}) {
                   19133:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   19134:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   19135:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   19136:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   19137:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   19138:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   19139:                         my $canhost =
                   19140:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   19141:                                                               $coursedomserver,
                   19142:                                                               $remoterev,
                   19143:                                                               $udomdefaults{'remotesessions'},
                   19144:                                                               $defdomdefaults{'hostedsessions'});
                   19145: 
                   19146:                         if ($canhost) {
                   19147:                             $otherserver = $coursedomserver;
                   19148:                         } else {
                   19149:                             $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.");
                   19150:                         }
                   19151:                     } else {
                   19152:                         $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).");
                   19153:                     }
                   19154:                 } else {
                   19155:                     $otherserver = $userdomserver;
                   19156:                 }
                   19157:             }
                   19158:             if ($otherserver ne '') {
                   19159:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   19160:             }
                   19161:         }
                   19162:     }
                   19163:     return ($switchserver,$warning);
                   19164: }
                   19165: 
                   19166: =pod
                   19167: 
                   19168: =item * &check_release_result()
                   19169: 
                   19170: Inputs:
                   19171: 
                   19172: $switchwarning - Warning message if no suitable server found to host session.
                   19173: 
                   19174: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   19175:                 and current role.
                   19176: 
                   19177: Returns: HTML to display with information about requirement to switch server.
                   19178:          Either displaying warning with link to Roles/Courses screen or
                   19179:          display link to switchserver.
                   19180: 
1.1181    raeburn  19181: =cut
                   19182: 
1.1207    raeburn  19183: sub check_release_result {
                   19184:     my ($switchwarning,$switchserver) = @_;
                   19185:     my $output = &start_page('Selected course unavailable on this server').
1.1463    raeburn  19186:                  '<div class="LC_landmark" role="main"><p class="LC_warning">';
1.1207    raeburn  19187:     if ($switchwarning) {
                   19188:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   19189:         if (&show_course()) {
                   19190:             $output .= &mt('Display courses');
                   19191:         } else {
                   19192:             $output .= &mt('Display roles');
                   19193:         }
                   19194:         $output .= '</a>';
                   19195:     } elsif ($switchserver) {
                   19196:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   19197:                    '<br />'.
                   19198:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   19199:                    &mt('Switch Server').
                   19200:                    '</a>';
                   19201:     }
1.1463    raeburn  19202:     $output .= '</p></div>'.&end_page();
1.1207    raeburn  19203:     return $output;
                   19204: }
                   19205: 
                   19206: =pod
                   19207: 
                   19208: =item * &needs_coursereinit()
                   19209: 
                   19210: Determine if course contents stored for user's session needs to be
                   19211: refreshed, because content has changed since "Big Hash" last tied.
                   19212: 
                   19213: Check for change is made if time last checked is more than 10 minutes ago
                   19214: (by default).
                   19215: 
                   19216: Inputs:
                   19217: 
                   19218: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   19219: 
                   19220: $interval (optional) - Time which may elapse (in s) between last check for content
                   19221:                        change in current course. (default: 600 s).  
                   19222: 
                   19223: Returns: an array; first element is:
                   19224: 
                   19225: =over 4
                   19226: 
                   19227: 'switch' - if content updates mean user's session
                   19228:            needs to be switched to a server running a newer LON-CAPA version
                   19229:  
                   19230: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   19231:            on current server hosting user's session                
                   19232: 
                   19233: ''       - if no action required.
                   19234: 
                   19235: =back
                   19236: 
                   19237: If first item element is 'switch':
                   19238: 
                   19239: second item is $switchwarning - Warning message if no suitable server found to host session. 
                   19240: 
                   19241: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   19242:                               and current role. 
                   19243: 
                   19244: otherwise: no other elements returned.
                   19245: 
                   19246: =back
                   19247: 
                   19248: =cut
                   19249: 
                   19250: sub needs_coursereinit {
                   19251:     my ($loncaparev,$interval) = @_;
                   19252:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   19253:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   19254:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   19255:     my $now = time;
                   19256:     if ($interval eq '') {
                   19257:         $interval = 600;
                   19258:     }
                   19259:     if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282    raeburn  19260:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372    raeburn  19261:         my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282    raeburn  19262:         if ($blocked) {
                   19263:             return ();
                   19264:         }
1.1391    raeburn  19265:         my $update;
                   19266:         my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
                   19267:         my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
                   19268:         if ($lastmainchange > $env{'request.course.tied'}) {
                   19269:             my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
                   19270:             if ($needswitch) {
                   19271:                 return ('switch',$switchwarning,$switchserver);
                   19272:             }
                   19273:             $update = 'main';
                   19274:         }
                   19275:         if ($lastsuppchange > $env{'request.course.suppupdated'}) {
                   19276:             if ($update) {
                   19277:                 $update = 'both';
                   19278:             } else {
                   19279:                 my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
                   19280:                 if ($needswitch) {
                   19281:                     return ('switch',$switchwarning,$switchserver);
                   19282:                 } else {
                   19283:                     $update = 'supp';
1.1207    raeburn  19284:                 }
                   19285:             }
1.1391    raeburn  19286:         }
1.1453    raeburn  19287:         return ($update);
1.1391    raeburn  19288:     }
                   19289:     return ();
                   19290: }
                   19291: 
                   19292: sub switch_for_update {
                   19293:     my ($loncaparev,$cdom,$cnum) = @_;
                   19294:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   19295:     if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   19296:         my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   19297:         if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   19298:             &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   19299:                                     $curr_reqd_hash{'internal.releaserequired'}});
                   19300:             my ($switchserver,$switchwarning) =
                   19301:                 &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   19302:                                         $curr_reqd_hash{'internal.releaserequired'});
                   19303:             if ($switchwarning ne '' || $switchserver ne '') {
                   19304:                 return ('switch',$switchwarning,$switchserver);
                   19305:             }
1.1207    raeburn  19306:         }
                   19307:     }
                   19308:     return ();
                   19309: }
1.1181    raeburn  19310: 
1.1083    raeburn  19311: sub update_content_constraints {
1.1395    raeburn  19312:     my ($cdom,$cnum,$chome,$cid) = @_;
1.1083    raeburn  19313:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   19314:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307    raeburn  19315:     my (%checkresponsetypes,%checkcrsrestypes);
1.1083    raeburn  19316:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236    raeburn  19317:         my ($item,$name,$value) = split(/:/,$key);
1.1083    raeburn  19318:         if ($item eq 'resourcetag') {
                   19319:             if ($name eq 'responsetype') {
                   19320:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   19321:             }
1.1307    raeburn  19322:         } elsif ($item eq 'course') {
                   19323:             if ($name eq 'courserestype') {
                   19324:                 $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
                   19325:             }
1.1083    raeburn  19326:         }
                   19327:     }
                   19328:     my $navmap = Apache::lonnavmaps::navmap->new();
                   19329:     if (defined($navmap)) {
1.1307    raeburn  19330:         my (%allresponses,%allcrsrestypes);
                   19331:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
                   19332:             if ($res->is_tool()) {
                   19333:                 if ($allcrsrestypes{'exttool'}) {
                   19334:                     $allcrsrestypes{'exttool'} ++;
                   19335:                 } else {
                   19336:                     $allcrsrestypes{'exttool'} = 1;
                   19337:                 }
                   19338:                 next;
                   19339:             }
1.1083    raeburn  19340:             my %responses = $res->responseTypes();
                   19341:             foreach my $key (keys(%responses)) {
                   19342:                 next unless(exists($checkresponsetypes{$key}));
                   19343:                 $allresponses{$key} += $responses{$key};
                   19344:             }
                   19345:         }
                   19346:         foreach my $key (keys(%allresponses)) {
                   19347:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   19348:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   19349:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   19350:             }
                   19351:         }
1.1307    raeburn  19352:         foreach my $key (keys(%allcrsrestypes)) {
1.1308    raeburn  19353:             my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307    raeburn  19354:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   19355:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   19356:             }
                   19357:         }
1.1083    raeburn  19358:         undef($navmap);
                   19359:     }
1.1391    raeburn  19360:     if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308    raeburn  19361:         my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
                   19362:         if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   19363:             ($reqdmajor,$reqdminor) = ($major,$minor);
                   19364:         }
                   19365:     }
1.1083    raeburn  19366:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   19367:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   19368:     }
                   19369:     return;
                   19370: }
                   19371: 
1.1110    raeburn  19372: sub allmaps_incourse {
                   19373:     my ($cdom,$cnum,$chome,$cid) = @_;
                   19374:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   19375:         $cid = $env{'request.course.id'};
                   19376:         $cdom = $env{'course.'.$cid.'.domain'};
                   19377:         $cnum = $env{'course.'.$cid.'.num'};
                   19378:         $chome = $env{'course.'.$cid.'.home'};
                   19379:     }
                   19380:     my %allmaps = ();
                   19381:     my $lastchange =
                   19382:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   19383:     if ($lastchange > $env{'request.course.tied'}) {
                   19384:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   19385:         unless ($ferr) {
1.1395    raeburn  19386:             &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110    raeburn  19387:         }
                   19388:     }
                   19389:     my $navmap = Apache::lonnavmaps::navmap->new();
                   19390:     if (defined($navmap)) {
                   19391:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   19392:             $allmaps{$res->src()} = 1;
                   19393:         }
                   19394:     }
                   19395:     return \%allmaps;
                   19396: }
                   19397: 
1.1083    raeburn  19398: sub parse_supplemental_title {
                   19399:     my ($title) = @_;
                   19400: 
                   19401:     my ($foldertitle,$renametitle);
                   19402:     if ($title =~ /&amp;&amp;&amp;/) {
                   19403:         $title = &HTML::Entites::decode($title);
                   19404:     }
                   19405:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   19406:         $renametitle=$4;
                   19407:         my ($time,$uname,$udom) = ($1,$2,$3);
                   19408:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   19409:         my $name =  &plainname($uname,$udom);
                   19410:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   19411:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401    raeburn  19412:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402    raeburn  19413:         if ($foldertitle ne '') {
1.1401    raeburn  19414:             $title .= ': <br />'.$foldertitle;
                   19415:         }
1.1083    raeburn  19416:     }
                   19417:     if (wantarray) {
                   19418:         return ($title,$foldertitle,$renametitle);
                   19419:     }
                   19420:     return $title;
                   19421: }
                   19422: 
1.1395    raeburn  19423: sub get_supplemental {
                   19424:     my ($cnum,$cdom,$ignorecache,$possdel)=@_;
                   19425:     my $hashid=$cnum.':'.$cdom;
                   19426:     my ($supplemental,$cached,$set_httprefs);
                   19427:     unless ($ignorecache) {
                   19428:         ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
                   19429:     }
                   19430:     unless (defined($cached)) {
                   19431:         my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
                   19432:         unless ($chome eq 'no_host') {
                   19433:             my @order = @LONCAPA::map::order;
                   19434:             my @resources = @LONCAPA::map::resources;
                   19435:             my @resparms = @LONCAPA::map::resparms;
                   19436:             my @zombies = @LONCAPA::map::zombies;
                   19437:             my ($errors,%ids,%hidden);
                   19438:             $errors =
                   19439:                 &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
                   19440:                                       $errors,$possdel,\%ids,\%hidden);
                   19441:             @LONCAPA::map::order = @order;
                   19442:             @LONCAPA::map::resources = @resources;
                   19443:             @LONCAPA::map::resparms = @resparms;
                   19444:             @LONCAPA::map::zombies = @zombies;
                   19445:             $set_httprefs = 1;
                   19446:             if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
                   19447:                 &Apache::lonnet::appenv({'request.course.suppupdated' => time});
                   19448:             }
                   19449:             $supplemental = {
                   19450:                                ids => \%ids,
                   19451:                                hidden => \%hidden,
                   19452:                             };
                   19453:             &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
                   19454:         }
                   19455:     }
                   19456:     return ($supplemental,$set_httprefs);
                   19457: }
                   19458: 
1.1143    raeburn  19459: sub recurse_supplemental {
1.1391    raeburn  19460:     my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
                   19461:     if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
                   19462:         my $mapnum;
                   19463:         if ($suppmap eq 'supplemental.sequence') {
                   19464:             $mapnum = 0;
                   19465:         } else {
                   19466:             ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
                   19467:         }
1.1143    raeburn  19468:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   19469:         if ($fatal) {
                   19470:             $errors ++;
                   19471:         } else {
1.1389    raeburn  19472:             my @order = @LONCAPA::map::order;
                   19473:             if (@order > 0) {
                   19474:                 my @resources = @LONCAPA::map::resources;
1.1391    raeburn  19475:                 my @resparms = @LONCAPA::map::resparms;
1.1389    raeburn  19476:                 foreach my $idx (@order) {
                   19477:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143    raeburn  19478:                     if (($src ne '') && ($status eq 'res')) {
1.1391    raeburn  19479:                         my $id = $mapnum.':'.$idx;
                   19480:                         push(@{$suppids->{$src}},$id);
                   19481:                         if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
                   19482:                             $hiddensupp->{$id} = 1;
                   19483:                         }
1.1146    raeburn  19484:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391    raeburn  19485:                             $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
                   19486:                                                             $hiddensupp,$hiddensupp->{$id});
1.1143    raeburn  19487:                         } else {
1.1391    raeburn  19488:                             my $allowed;
                   19489:                             if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
                   19490:                                 $allowed = 1;
                   19491:                             } elsif ($possdel) {
                   19492:                                 foreach my $item (@{$suppids->{$src}}) {
                   19493:                                     next if ($item eq $id);
                   19494:                                     unless ($hiddensupp->{$item}) {
                   19495:                                        $allowed = 1;
                   19496:                                        last;
                   19497:                                     }
                   19498:                                 }
                   19499:                                 if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
                   19500:                                     &Apache::lonnet::delenv('httpref.'.$src);
                   19501:                                 }
                   19502:                             }
                   19503:                             if ($allowed && (!exists($env{'httpref.'.$src}))) {
                   19504:                                 &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308    raeburn  19505:                             }
1.1143    raeburn  19506:                         }
                   19507:                     }
                   19508:                 }
                   19509:             }
                   19510:         }
                   19511:     }
1.1391    raeburn  19512:     return $errors;
                   19513: }
                   19514: 
                   19515: sub set_supp_httprefs {
                   19516:     my ($cnum,$cdom,$supplemental,$possdel) = @_;
                   19517:     if (ref($supplemental) eq 'HASH') {
                   19518:         if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
                   19519:             foreach my $src (keys(%{$supplemental->{'ids'}})) {
                   19520:                 next if ($src =~ /\.sequence$/);
                   19521:                 if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
                   19522:                     my $allowed;
                   19523:                     if ($env{'request.role.adv'}) {
                   19524:                         $allowed = 1;
                   19525:                     } else {
                   19526:                         foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
                   19527:                             unless ($supplemental->{'hidden'}->{$id}) {
                   19528:                                 $allowed = 1;
                   19529:                                 last;
                   19530:                             }
                   19531:                         }
                   19532:                     }
                   19533:                     if (exists($env{'httpref.'.$src})) {
                   19534:                         if ($possdel) {
                   19535:                             unless ($allowed) {
                   19536:                                 &Apache::lonnet::delenv('httpref.'.$src);
                   19537:                             }
                   19538:                         }
                   19539:                     } elsif ($allowed) {
                   19540:                         &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
                   19541:                     }
                   19542:                 }
                   19543:             }
                   19544:             if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
                   19545:                 &Apache::lonnet::appenv({'request.course.suppupdated' => time});
                   19546:             }
                   19547:         }
                   19548:     }
                   19549: }
                   19550: 
                   19551: sub get_supp_parameter {
                   19552:     my ($resparm,$name)=@_;
                   19553:     return if ($resparm eq '');
                   19554:     my $value=undef;
                   19555:     my $ptype=undef;
                   19556:     foreach (split('&&&',$resparm)) {
                   19557:         my ($thistype,$thisname,$thisvalue)=split('___',$_);
                   19558:         if ($thisname eq $name) {
                   19559:             $value=$thisvalue;
                   19560:             $ptype=$thistype;
                   19561:         }
                   19562:     }
                   19563:     return $value;
1.1143    raeburn  19564: }
                   19565: 
1.1101    raeburn  19566: sub symb_to_docspath {
1.1267    raeburn  19567:     my ($symb,$navmapref) = @_;
                   19568:     return unless ($symb && ref($navmapref));
1.1101    raeburn  19569:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   19570:     if ($resurl=~/\.(sequence|page)$/) {
                   19571:         $mapurl=$resurl;
                   19572:     } elsif ($resurl eq 'adm/navmaps') {
                   19573:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   19574:     }
                   19575:     my $mapresobj;
1.1267    raeburn  19576:     unless (ref($$navmapref)) {
                   19577:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   19578:     }
                   19579:     if (ref($$navmapref)) {
                   19580:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101    raeburn  19581:     }
                   19582:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   19583:     my $type=$2;
                   19584:     my $path;
                   19585:     if (ref($mapresobj)) {
                   19586:         my $pcslist = $mapresobj->map_hierarchy();
                   19587:         if ($pcslist ne '') {
                   19588:             foreach my $pc (split(/,/,$pcslist)) {
                   19589:                 next if ($pc <= 1);
1.1267    raeburn  19590:                 my $res = $$navmapref->getByMapPc($pc);
1.1101    raeburn  19591:                 if (ref($res)) {
                   19592:                     my $thisurl = $res->src();
                   19593:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   19594:                     my $thistitle = $res->title();
                   19595:                     $path .= '&'.
                   19596:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146    raeburn  19597:                              &escape($thistitle).
1.1101    raeburn  19598:                              ':'.$res->randompick().
                   19599:                              ':'.$res->randomout().
                   19600:                              ':'.$res->encrypted().
                   19601:                              ':'.$res->randomorder().
                   19602:                              ':'.$res->is_page();
                   19603:                 }
                   19604:             }
                   19605:         }
                   19606:         $path =~ s/^\&//;
                   19607:         my $maptitle = $mapresobj->title();
                   19608:         if ($mapurl eq 'default') {
1.1129    raeburn  19609:             $maptitle = 'Main Content';
1.1101    raeburn  19610:         }
                   19611:         $path .= (($path ne '')? '&' : '').
                   19612:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146    raeburn  19613:                  &escape($maptitle).
1.1101    raeburn  19614:                  ':'.$mapresobj->randompick().
                   19615:                  ':'.$mapresobj->randomout().
                   19616:                  ':'.$mapresobj->encrypted().
                   19617:                  ':'.$mapresobj->randomorder().
                   19618:                  ':'.$mapresobj->is_page();
                   19619:     } else {
                   19620:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   19621:         my $ispage = (($type eq 'page')? 1 : '');
                   19622:         if ($mapurl eq 'default') {
1.1129    raeburn  19623:             $maptitle = 'Main Content';
1.1101    raeburn  19624:         }
                   19625:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146    raeburn  19626:                 &escape($maptitle).':::::'.$ispage;
1.1101    raeburn  19627:     }
                   19628:     unless ($mapurl eq 'default') {
                   19629:         $path = 'default&'.
1.1146    raeburn  19630:                 &escape('Main Content').
1.1101    raeburn  19631:                 ':::::&'.$path;
                   19632:     }
                   19633:     return $path;
                   19634: }
                   19635: 
1.1393    raeburn  19636: sub validate_folderpath {
                   19637:     my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
                   19638:     if ($env{'form.folderpath'} ne '') {
                   19639:         my @items = split(/\&/,$env{'form.folderpath'});
1.1394    raeburn  19640:         my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393    raeburn  19641:         for (my $i=0; $i<@items; $i++) {
                   19642:             my $odd = $i%2;
                   19643:             if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
                   19644:                 $badpath = 1;
1.1394    raeburn  19645:             } elsif ($odd && $supplementalflag) {
1.1393    raeburn  19646:                 my $idx = $i-1;
1.1394    raeburn  19647:                 if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
                   19648:                     my $esc_name = $1;
                   19649:                     if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
                   19650:                         $supppath .= '&'.$esc_name;
                   19651:                         $changed = 1;
                   19652:                     } else {
                   19653:                         $supppath .= '&'.$items[$i];
                   19654:                     }
                   19655:                 } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
                   19656:                     $changed = 1;
1.1393    raeburn  19657:                     my $is_hidden;
                   19658:                     unless ($got_supp) {
1.1395    raeburn  19659:                         my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393    raeburn  19660:                         if (ref($supplemental) eq 'HASH') {
                   19661:                             if (ref($supplemental->{'hidden'}) eq 'HASH') {
                   19662:                                 %supphidden = %{$supplemental->{'hidden'}};
                   19663:                             }
                   19664:                             if (ref($supplemental->{'ids'}) eq 'HASH') {
                   19665:                                 %suppids = %{$supplemental->{'ids'}};
                   19666:                             }
                   19667:                         }
                   19668:                         $got_supp = 1;
                   19669:                     }
                   19670:                     if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
                   19671:                         my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
                   19672:                         if ($supphidden{$mapid}) {
                   19673:                             $is_hidden = 1;
                   19674:                         }
                   19675:                     }
1.1394    raeburn  19676:                     $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
                   19677:                 } else {
                   19678:                     $supppath .= '&'.$items[$i];
1.1393    raeburn  19679:                 }
                   19680:             } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
                   19681:                 $badpath = 1;
1.1394    raeburn  19682:             } elsif ($supplementalflag) {
1.1393    raeburn  19683:                 $supppath .= '&'.$items[$i];
                   19684:             }
                   19685:             last if ($badpath);
                   19686:         }
                   19687:         if ($badpath) {
                   19688:             delete($env{'form.folderpath'});
1.1394    raeburn  19689:         } elsif ($changed && $supplementalflag) {
1.1393    raeburn  19690:             $supppath =~ s/^\&//;
                   19691:             $env{'form.folderpath'} = $supppath;
                   19692:         }
                   19693:     }
                   19694:     return;
                   19695: }
                   19696: 
1.1094    raeburn  19697: sub captcha_display {
1.1327    raeburn  19698:     my ($context,$lonhost,$defdom) = @_;
1.1094    raeburn  19699:     my ($output,$error);
1.1234    raeburn  19700:     my ($captcha,$pubkey,$privkey,$version) = 
1.1327    raeburn  19701:         &get_captcha_config($context,$lonhost,$defdom);
1.1095    raeburn  19702:     if ($captcha eq 'original') {
1.1094    raeburn  19703:         $output = &create_captcha();
                   19704:         unless ($output) {
1.1172    raeburn  19705:             $error = 'captcha';
1.1094    raeburn  19706:         }
                   19707:     } elsif ($captcha eq 'recaptcha') {
1.1234    raeburn  19708:         $output = &create_recaptcha($pubkey,$version);
1.1094    raeburn  19709:         unless ($output) {
1.1172    raeburn  19710:             $error = 'recaptcha';
1.1094    raeburn  19711:         }
                   19712:     }
1.1234    raeburn  19713:     return ($output,$error,$captcha,$version);
1.1094    raeburn  19714: }
                   19715: 
                   19716: sub captcha_response {
1.1327    raeburn  19717:     my ($context,$lonhost,$defdom) = @_;
1.1094    raeburn  19718:     my ($captcha_chk,$captcha_error);
1.1327    raeburn  19719:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095    raeburn  19720:     if ($captcha eq 'original') {
1.1094    raeburn  19721:         ($captcha_chk,$captcha_error) = &check_captcha();
                   19722:     } elsif ($captcha eq 'recaptcha') {
1.1234    raeburn  19723:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1094    raeburn  19724:     } else {
                   19725:         $captcha_chk = 1;
                   19726:     }
                   19727:     return ($captcha_chk,$captcha_error);
                   19728: }
                   19729: 
                   19730: sub get_captcha_config {
1.1327    raeburn  19731:     my ($context,$lonhost,$dom_in_effect) = @_;
1.1234    raeburn  19732:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094    raeburn  19733:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   19734:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   19735:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095    raeburn  19736:     if ($context eq 'usercreation') {
                   19737:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   19738:         if (ref($domconfig{$context}) eq 'HASH') {
                   19739:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   19740:             if (ref($hashtocheck) eq 'HASH') {
                   19741:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   19742:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   19743:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   19744:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   19745:                     }
                   19746:                     if ($privkey && $pubkey) {
                   19747:                         $captcha = 'recaptcha';
1.1234    raeburn  19748:                         $version = $hashtocheck->{'recaptchaversion'};
                   19749:                         if ($version ne '2') {
                   19750:                             $version = 1;
                   19751:                         }
1.1095    raeburn  19752:                     } else {
                   19753:                         $captcha = 'original';
                   19754:                     }
                   19755:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   19756:                     $captcha = 'original';
                   19757:                 }
1.1094    raeburn  19758:             }
1.1095    raeburn  19759:         } else {
                   19760:             $captcha = 'captcha';
                   19761:         }
                   19762:     } elsif ($context eq 'login') {
                   19763:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   19764:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   19765:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   19766:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094    raeburn  19767:             if ($privkey && $pubkey) {
                   19768:                 $captcha = 'recaptcha';
1.1234    raeburn  19769:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   19770:                 if ($version ne '2') {
                   19771:                     $version = 1; 
                   19772:                 }
1.1095    raeburn  19773:             } else {
                   19774:                 $captcha = 'original';
1.1094    raeburn  19775:             }
1.1095    raeburn  19776:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   19777:             $captcha = 'original';
1.1094    raeburn  19778:         }
1.1327    raeburn  19779:     } elsif ($context eq 'passwords') {
                   19780:         if ($dom_in_effect) {
                   19781:             my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
                   19782:             if ($passwdconf{'captcha'} eq 'recaptcha') {
                   19783:                 if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
                   19784:                     $pubkey = $passwdconf{'recaptchakeys'}{'public'};
                   19785:                     $privkey = $passwdconf{'recaptchakeys'}{'private'};
                   19786:                 }
                   19787:                 if ($privkey && $pubkey) {
                   19788:                     $captcha = 'recaptcha';
                   19789:                     $version = $passwdconf{'recaptchaversion'};
                   19790:                     if ($version ne '2') {
                   19791:                         $version = 1;
                   19792:                     }
                   19793:                 } else {
                   19794:                     $captcha = 'original';
                   19795:                 }
                   19796:             } elsif ($passwdconf{'captcha'} ne 'notused') {
                   19797:                 $captcha = 'original';
                   19798:             }
                   19799:         }
                   19800:     } 
1.1234    raeburn  19801:     return ($captcha,$pubkey,$privkey,$version);
1.1094    raeburn  19802: }
                   19803: 
                   19804: sub create_captcha {
                   19805:     my %captcha_params = &captcha_settings();
                   19806:     my ($output,$maxtries,$tries) = ('',10,0);
                   19807:     while ($tries < $maxtries) {
                   19808:         $tries ++;
                   19809:         my $captcha = Authen::Captcha->new (
                   19810:                                            output_folder => $captcha_params{'output_dir'},
                   19811:                                            data_folder   => $captcha_params{'db_dir'},
                   19812:                                           );
                   19813:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   19814: 
                   19815:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   19816:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367    raeburn  19817:                       '<span class="LC_nobreak">'.
1.1453    raeburn  19818:                       '<label>'.&mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1463    raeburn  19819:                       '<input type="text" size="5" name="code" value="" autocomplete="new-password" aria-required="true" />'.
1.1453    raeburn  19820:                       '</label></span><br />'.
1.1176    raeburn  19821:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094    raeburn  19822:             last;
                   19823:         }
                   19824:     }
1.1323    raeburn  19825:     if ($output eq '') {
                   19826:         &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
                   19827:     }
1.1094    raeburn  19828:     return $output;
                   19829: }
                   19830: 
                   19831: sub captcha_settings {
                   19832:     my %captcha_params = (
                   19833:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   19834:                            www_output_dir => "/captchaspool",
                   19835:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   19836:                            numchars       => '5',
                   19837:                          );
                   19838:     return %captcha_params;
                   19839: }
                   19840: 
                   19841: sub check_captcha {
                   19842:     my ($captcha_chk,$captcha_error);
                   19843:     my $code = $env{'form.code'};
                   19844:     my $md5sum = $env{'form.crypt'};
                   19845:     my %captcha_params = &captcha_settings();
                   19846:     my $captcha = Authen::Captcha->new(
                   19847:                       output_folder => $captcha_params{'output_dir'},
                   19848:                       data_folder   => $captcha_params{'db_dir'},
                   19849:                   );
1.1109    raeburn  19850:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094    raeburn  19851:     my %captcha_hash = (
                   19852:                         0       => 'Code not checked (file error)',
                   19853:                        -1      => 'Failed: code expired',
                   19854:                        -2      => 'Failed: invalid code (not in database)',
                   19855:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   19856:     );
                   19857:     if ($captcha_chk != 1) {
                   19858:         $captcha_error = $captcha_hash{$captcha_chk}
                   19859:     }
                   19860:     return ($captcha_chk,$captcha_error);
                   19861: }
                   19862: 
                   19863: sub create_recaptcha {
1.1234    raeburn  19864:     my ($pubkey,$version) = @_;
                   19865:     if ($version >= 2) {
1.1367    raeburn  19866:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
                   19867:                '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234    raeburn  19868:     } else {
                   19869:         my $use_ssl;
                   19870:         if ($ENV{'SERVER_PORT'} == 443) {
                   19871:             $use_ssl = 1;
                   19872:         }
                   19873:         my $captcha = Captcha::reCAPTCHA->new;
                   19874:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   19875:                $captcha->get_html($pubkey,undef,$use_ssl).
                   19876:                &mt('If the text is hard to read, [_1] will replace them.',
                   19877:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   19878:                '<br /><br />';
                   19879:     }
1.1094    raeburn  19880: }
                   19881: 
                   19882: sub check_recaptcha {
1.1234    raeburn  19883:     my ($privkey,$version) = @_;
1.1094    raeburn  19884:     my $captcha_chk;
1.1350    raeburn  19885:     my $ip = &Apache::lonnet::get_requestor_ip();
1.1234    raeburn  19886:     if ($version >= 2) {
                   19887:         my %info = (
                   19888:                      secret   => $privkey, 
                   19889:                      response => $env{'form.g-recaptcha-response'},
1.1350    raeburn  19890:                      remoteip => $ip,
1.1234    raeburn  19891:                    );
1.1280    raeburn  19892:         my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
                   19893:         $request->content(join('&',map {
                   19894:                          my $name = escape($_);
                   19895:                          "$name=" . ( ref($info{$_}) eq 'ARRAY'
                   19896:                          ? join("&$name=", map {escape($_) } @{$info{$_}})
                   19897:                          : &escape($info{$_}) );
                   19898:         } keys(%info)));
                   19899:         my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234    raeburn  19900:         if ($response->is_success)  {
                   19901:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   19902:             if (ref($data) eq 'HASH') {
                   19903:                 if ($data->{'success'}) {
                   19904:                     $captcha_chk = 1;
                   19905:                 }
                   19906:             }
                   19907:         }
                   19908:     } else {
                   19909:         my $captcha = Captcha::reCAPTCHA->new;
                   19910:         my $captcha_result =
                   19911:             $captcha->check_answer(
                   19912:                                     $privkey,
1.1350    raeburn  19913:                                     $ip,
1.1234    raeburn  19914:                                     $env{'form.recaptcha_challenge_field'},
                   19915:                                     $env{'form.recaptcha_response_field'},
                   19916:                                   );
                   19917:         if ($captcha_result->{is_valid}) {
                   19918:             $captcha_chk = 1;
                   19919:         }
1.1094    raeburn  19920:     }
                   19921:     return $captcha_chk;
                   19922: }
                   19923: 
1.1174    raeburn  19924: sub emailusername_info {
1.1244    raeburn  19925:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174    raeburn  19926:     my %titles = &Apache::lonlocal::texthash (
                   19927:                      lastname      => 'Last Name',
                   19928:                      firstname     => 'First Name',
                   19929:                      institution   => 'School/college/university',
                   19930:                      location      => "School's city, state/province, country",
                   19931:                      web           => "School's web address",
                   19932:                      officialemail => 'E-mail address at institution (if different)',
1.1244    raeburn  19933:                      id            => 'Student/Employee ID',
1.1174    raeburn  19934:                  );
                   19935:     return (\@fields,\%titles);
                   19936: }
                   19937: 
1.1161    raeburn  19938: sub cleanup_html {
                   19939:     my ($incoming) = @_;
                   19940:     my $outgoing;
                   19941:     if ($incoming ne '') {
                   19942:         $outgoing = $incoming;
                   19943:         $outgoing =~ s/;/&#059;/g;
                   19944:         $outgoing =~ s/\#/&#035;/g;
                   19945:         $outgoing =~ s/\&/&#038;/g;
                   19946:         $outgoing =~ s/</&#060;/g;
                   19947:         $outgoing =~ s/>/&#062;/g;
                   19948:         $outgoing =~ s/\(/&#040/g;
                   19949:         $outgoing =~ s/\)/&#041;/g;
                   19950:         $outgoing =~ s/"/&#034;/g;
                   19951:         $outgoing =~ s/'/&#039;/g;
                   19952:         $outgoing =~ s/\$/&#036;/g;
                   19953:         $outgoing =~ s{/}{&#047;}g;
                   19954:         $outgoing =~ s/=/&#061;/g;
                   19955:         $outgoing =~ s/\\/&#092;/g
                   19956:     }
                   19957:     return $outgoing;
                   19958: }
                   19959: 
1.1190    musolffc 19960: # Checks for critical messages and returns a redirect url if one exists.
                   19961: # $interval indicates how often to check for messages.
1.1282    raeburn  19962: # $context is the calling context -- roles, grades, contents, menu or flip. 
1.1190    musolffc 19963: sub critical_redirect {
1.1282    raeburn  19964:     my ($interval,$context) = @_;
1.1356    raeburn  19965:     unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
                   19966:         return ();
                   19967:     }
1.1190    musolffc 19968:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282    raeburn  19969:         if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
                   19970:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   19971:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372    raeburn  19972:             my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282    raeburn  19973:             if ($blocked) {
                   19974:                 my $checkrole = "cm./$cdom/$cnum";
                   19975:                 if ($env{'request.course.sec'} ne '') {
                   19976:                     $checkrole .= "/$env{'request.course.sec'}";
                   19977:                 }
                   19978:                 unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   19979:                         ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   19980:                     return;
                   19981:                 }
                   19982:             }
                   19983:         }
1.1190    musolffc 19984:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'}, 
                   19985:                                         $env{'user.name'});
                   19986:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191    raeburn  19987:         my $redirecturl;
1.1190    musolffc 19988:         if ($what[0]) {
1.1356    raeburn  19989: 	    if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190    musolffc 19990: 	        $redirecturl='/adm/email?critical=display';
1.1191    raeburn  19991: 	        my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   19992:                 return (1, $url);
1.1190    musolffc 19993:             }
1.1191    raeburn  19994:         }
                   19995:     } 
                   19996:     return ();
1.1190    musolffc 19997: }
                   19998: 
1.1174    raeburn  19999: # Use:
                   20000: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   20001: #
                   20002: ##################################################
                   20003: #          password associated functions         #
                   20004: ##################################################
                   20005: sub des_keys {
                   20006:     # Make a new key for DES encryption.
                   20007:     # Each key has two parts which are returned separately.
                   20008:     # Please note:  Each key must be passed through the &hex function
                   20009:     # before it is output to the web browser.  The hex versions cannot
                   20010:     # be used to decrypt.
                   20011:     my @hexstr=('0','1','2','3','4','5','6','7',
                   20012:                 '8','9','a','b','c','d','e','f');
                   20013:     my $lkey='';
                   20014:     for (0..7) {
                   20015:         $lkey.=$hexstr[rand(15)];
                   20016:     }
                   20017:     my $ukey='';
                   20018:     for (0..7) {
                   20019:         $ukey.=$hexstr[rand(15)];
                   20020:     }
                   20021:     return ($lkey,$ukey);
                   20022: }
                   20023: 
                   20024: sub des_decrypt {
                   20025:     my ($key,$cyphertext) = @_;
                   20026:     my $keybin=pack("H16",$key);
                   20027:     my $cypher;
                   20028:     if ($Crypt::DES::VERSION>=2.03) {
                   20029:         $cypher=new Crypt::DES $keybin;
                   20030:     } else {
                   20031:         $cypher=new DES $keybin;
                   20032:     }
1.1233    raeburn  20033:     my $plaintext='';
                   20034:     my $cypherlength = length($cyphertext);
                   20035:     my $numchunks = int($cypherlength/32);
                   20036:     for (my $j=0; $j<$numchunks; $j++) {
                   20037:         my $start = $j*32;
                   20038:         my $cypherblock = substr($cyphertext,$start,32);
                   20039:         my $chunk =
                   20040:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   20041:         $chunk .=
                   20042:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   20043:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   20044:         $plaintext .= $chunk;
                   20045:     }
1.1174    raeburn  20046:     return $plaintext;
                   20047: }
                   20048: 
1.1344    raeburn  20049: sub get_requested_shorturls {
1.1309    raeburn  20050:     my ($cdom,$cnum,$navmap) = @_;
                   20051:     return unless (ref($navmap));
1.1344    raeburn  20052:     my ($numnew,$errors);
1.1309    raeburn  20053:     my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
                   20054:     if (@toshorten) {
                   20055:         my (%maps,%resources,%titles);
                   20056:         &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
                   20057:                                                                'shorturls',$cdom,$cnum);
                   20058:         if (keys(%resources)) {
1.1344    raeburn  20059:             my %tocreate;
1.1309    raeburn  20060:             foreach my $item (sort {$a <=> $b} (@toshorten)) {
                   20061:                 my $symb = $resources{$item};
                   20062:                 if ($symb) {
                   20063:                     $tocreate{$cnum.'&'.$symb} = 1;
                   20064:                 }
                   20065:             }
1.1344    raeburn  20066:             if (keys(%tocreate)) {
                   20067:                 ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
                   20068:                                                       \%tocreate);
                   20069:             }
1.1309    raeburn  20070:         }
1.1344    raeburn  20071:     }
                   20072:     return ($numnew,$errors);
                   20073: }
                   20074: 
                   20075: sub make_short_symbs {
                   20076:     my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
                   20077:     my ($numnew,@errors);
                   20078:     if (ref($tocreateref) eq 'HASH') {
                   20079:         my %tocreate = %{$tocreateref};
1.1309    raeburn  20080:         if (keys(%tocreate)) {
                   20081:             my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
                   20082:             my $su = Short::URL->new(no_vowels => 1);
                   20083:             my $init = '';
                   20084:             my (%newunique,%addcourse,%courseonly,%failed);
                   20085:             # get lock on tiny db
                   20086:             my $now = time;
1.1344    raeburn  20087:             if ($lockuser eq '') {
                   20088:                 $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
                   20089:             }
1.1309    raeburn  20090:             my $lockhash = {
1.1344    raeburn  20091:                                 "lock\0$now" => $lockuser,
1.1309    raeburn  20092:                             };
                   20093:             my $tries = 0;
                   20094:             my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
                   20095:             my ($code,$error);
                   20096:             while (($gotlock ne 'ok') && ($tries<3)) {
                   20097:                 $tries ++;
                   20098:                 sleep 1;
1.1319    raeburn  20099:                 $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309    raeburn  20100:             }
                   20101:             if ($gotlock eq 'ok') {
                   20102:                 $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
                   20103:                                        \%addcourse,\%courseonly,\%failed);
                   20104:                 if (keys(%failed)) {
                   20105:                     my $numfailed = scalar(keys(%failed));
                   20106:                     push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
                   20107:                 }
                   20108:                 if (keys(%newunique)) {
                   20109:                     my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
                   20110:                     if ($putres eq 'ok') {
                   20111:                         $numnew = scalar(keys(%newunique));
                   20112:                         my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
                   20113:                         unless ($newputres eq 'ok') {
                   20114:                             push(@errors,&mt('error: could not store course look-up of short URLs'));
                   20115:                         }
                   20116:                     } else {
                   20117:                         push(@errors,&mt('error: could not store unique six character URLs'));
                   20118:                     }
                   20119:                 }
                   20120:                 my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
                   20121:                 unless ($dellockres eq 'ok') {
                   20122:                     push(@errors,&mt('error: could not release lockfile'));
                   20123:                 }
                   20124:             } else {
                   20125:                 push(@errors,&mt('error: could not obtain lockfile'));
                   20126:             }
                   20127:             if (keys(%courseonly)) {
                   20128:                 my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
                   20129:                 if ($result ne 'ok') {
                   20130:                     push(@errors,&mt('error: could not update course look-up of short URLs'));
                   20131:                 }
                   20132:             }
                   20133:         }
                   20134:     }
                   20135:     return ($numnew,\@errors);
                   20136: }
                   20137: 
                   20138: sub shorten_symbs {
                   20139:     my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
                   20140:     return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
                   20141:                    (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
                   20142:                    (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
                   20143:     my (%possibles,%collisions);
                   20144:     foreach my $key (keys(%{$tocreate})) {
                   20145:         my $num = String::CRC32::crc32($key);
                   20146:         my $tiny = $su->encode($num,$init);
                   20147:         if ($tiny) {
                   20148:             $possibles{$tiny} = $key;
                   20149:         }
                   20150:     }
                   20151:     if (!$init) {
                   20152:         $init = 1;
                   20153:     } else {
                   20154:         $init ++;
                   20155:     }
                   20156:     if (keys(%possibles)) {
                   20157:         my @posstiny = keys(%possibles);
                   20158:         my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
                   20159:         my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
                   20160:         if (keys(%currtiny)) {
                   20161:             foreach my $key (keys(%currtiny)) {
                   20162:                 next if ($currtiny{$key} eq '');
                   20163:                 if ($currtiny{$key} eq $possibles{$key}) {
                   20164:                     my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
                   20165:                     unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   20166:                         $courseonly->{$tsymb} = $key;
                   20167:                     }
                   20168:                 } else {
                   20169:                     $collisions{$possibles{$key}} = 1;
                   20170:                 }
                   20171:                 delete($possibles{$key});
                   20172:             }
                   20173:         }
                   20174:         foreach my $key (keys(%possibles)) {
                   20175:             $newunique->{$key} = $possibles{$key};
                   20176:             my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
                   20177:             unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   20178:                 $addcourse->{$tsymb} = $key;
                   20179:             }
                   20180:         }
                   20181:     }
                   20182:     if (keys(%collisions)) {
                   20183:         if ($init <5) {
                   20184:             if (!$init) {
                   20185:                 $init = 1;
                   20186:             } else {
                   20187:                 $init ++;
                   20188:             }
                   20189:             $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
                   20190:                                    $newunique,$addcourse,$courseonly,$failed);
                   20191:         } else {
                   20192:             foreach my $key (keys(%collisions)) {
                   20193:                 $failed->{$key} = 1;
                   20194:             }
                   20195:         }
                   20196:     }
                   20197:     return $init;
                   20198: }
                   20199: 
1.1328    raeburn  20200: sub is_nonframeable {
1.1329    raeburn  20201:     my ($url,$absolute,$hostname,$ip,$nocache) = @_;
                   20202:     my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330    raeburn  20203:     return if (($remprotocol eq '') || ($remhost eq ''));
1.1329    raeburn  20204: 
                   20205:     $remprotocol = lc($remprotocol);
                   20206:     $remhost = lc($remhost);
                   20207:     my $remport = 80;
                   20208:     if ($remprotocol eq 'https') {
                   20209:         $remport = 443;
                   20210:     }
1.1330    raeburn  20211:     my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329    raeburn  20212:     if ($cached) {
                   20213:         unless ($nocache) {
                   20214:             if ($result) {
                   20215:                 return 1;
                   20216:             } else {
                   20217:                 return 0;
                   20218:             }
                   20219:         }
                   20220:     }
1.1328    raeburn  20221:     my $uselink;
                   20222:     my $request = new HTTP::Request('HEAD',$url);
                   20223:     my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
                   20224:     if ($response->is_success()) {
                   20225:         my $secpolicy = lc($response->header('content-security-policy'));
                   20226:         my $xframeop = lc($response->header('x-frame-options'));
                   20227:         $secpolicy =~ s/^\s+|\s+$//g;
                   20228:         $xframeop =~ s/^\s+|\s+$//g;
                   20229:         if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329    raeburn  20230:             my $remotehost = $remprotocol.'://'.$remhost;
1.1328    raeburn  20231:             my ($origin,$protocol,$port);
                   20232:             if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
                   20233:                 $port = $ENV{'SERVER_PORT'};
                   20234:             } else {
                   20235:                 $port = 80;
                   20236:             }
                   20237:             if ($absolute eq '') {
                   20238:                 $protocol = 'http:';
                   20239:                 if ($port == 443) {
                   20240:                     $protocol = 'https:';
                   20241:                 }
                   20242:                 $origin = $protocol.'//'.lc($hostname);
                   20243:             } else {
                   20244:                 $origin = lc($absolute);
                   20245:                 ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
                   20246:             }
                   20247:             if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
                   20248:                 my $framepolicy = $1;
                   20249:                 $framepolicy =~ s/^\s+|\s+$//g;
                   20250:                 my @policies = split(/\s+/,$framepolicy);
                   20251:                 if (@policies) {
                   20252:                     if (grep(/^\Q'none'\E$/,@policies)) {
                   20253:                         $uselink = 1;
                   20254:                     } else {
                   20255:                         $uselink = 1;
                   20256:                         if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
                   20257:                                 (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
                   20258:                                 (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
                   20259:                             undef($uselink);
                   20260:                         }
                   20261:                         if ($uselink) {
                   20262:                             if (grep(/^\Q'self'\E$/,@policies)) {
                   20263:                                 if (($origin ne '') && ($remotehost eq $origin)) {
                   20264:                                     undef($uselink);
                   20265:                                 }
                   20266:                             }
                   20267:                         }
                   20268:                         if ($uselink) {
                   20269:                             my @possok;
                   20270:                             if ($ip ne '') {
                   20271:                                 push(@possok,$ip);
                   20272:                             }
                   20273:                             my $hoststr = '';
                   20274:                             foreach my $part (reverse(split(/\./,$hostname))) {
                   20275:                                 if ($hoststr eq '') {
                   20276:                                     $hoststr = $part;
                   20277:                                 } else {
                   20278:                                     $hoststr = "$part.$hoststr";
                   20279:                                 }
                   20280:                                 if ($hoststr eq $hostname) {
                   20281:                                     push(@possok,$hostname);
                   20282:                                 } else {
                   20283:                                     push(@possok,"*.$hoststr");
                   20284:                                 }
                   20285:                             }
                   20286:                             if (@possok) {
                   20287:                                 foreach my $poss (@possok) {
                   20288:                                     last if (!$uselink);
                   20289:                                     foreach my $policy (@policies) {
                   20290:                                         if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
                   20291:                                             undef($uselink);
                   20292:                                             last;
                   20293:                                         }
                   20294:                                     }
                   20295:                                 }
                   20296:                             }
                   20297:                         }
                   20298:                     }
                   20299:                 }
                   20300:             } elsif ($xframeop ne '') {
                   20301:                 $uselink = 1;
                   20302:                 my @policies = split(/\s*,\s*/,$xframeop);
                   20303:                 if (@policies) {
                   20304:                     unless (grep(/^deny$/,@policies)) {
                   20305:                         if ($origin ne '') {
                   20306:                             if (grep(/^sameorigin$/,@policies)) {
                   20307:                                 if ($remotehost eq $origin) {
                   20308:                                     undef($uselink);
                   20309:                                 }
                   20310:                             }
                   20311:                             if ($uselink) {
                   20312:                                 foreach my $policy (@policies) {
                   20313:                                     if ($policy =~ /^allow-from\s*(.+)$/) {
                   20314:                                         my $allowfrom = $1;
                   20315:                                         if (($allowfrom ne '') && ($allowfrom eq $origin)) {
                   20316:                                             undef($uselink);
                   20317:                                             last;
                   20318:                                         }
                   20319:                                     }
                   20320:                                 }
                   20321:                             }
                   20322:                         }
                   20323:                     }
                   20324:                 }
                   20325:             }
                   20326:         }
                   20327:     }
1.1329    raeburn  20328:     if ($nocache) {
                   20329:         if ($cached) {
                   20330:             my $devalidate;
                   20331:             if ($uselink && !$result) {
                   20332:                 $devalidate = 1;
                   20333:             } elsif (!$uselink && $result) {
                   20334:                 $devalidate = 1;
                   20335:             }
                   20336:             if ($devalidate) {
                   20337:                 &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
                   20338:             }
                   20339:         }
                   20340:     } else {
                   20341:         if ($uselink) {
                   20342:             $result = 1;
                   20343:         } else {
                   20344:             $result = 0;
                   20345:         }
                   20346:         &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
                   20347:     }
1.1328    raeburn  20348:     return $uselink;
                   20349: }
                   20350: 
1.1359    raeburn  20351: sub page_menu {
                   20352:     my ($menucolls,$menunum) = @_;
                   20353:     my %menu;
                   20354:     foreach my $item (split(/;/,$menucolls)) {
                   20355:         my ($num,$value) = split(/\%/,$item);
                   20356:         if ($num eq $menunum) {
                   20357:             my @entries = split(/\&/,$value);
                   20358:             foreach my $entry (@entries) {
                   20359:                 my ($name,$fields) = split(/=/,$entry);
1.1368    raeburn  20360:                 if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359    raeburn  20361:                     $menu{$name} = $fields;
                   20362:                 } else {
                   20363:                     my @shown;
                   20364:                     if ($fields =~ /,/) {
                   20365:                         @shown = split(/,/,$fields);
                   20366:                     } else {
                   20367:                         @shown = ($fields);
                   20368:                     }
                   20369:                     if (@shown) {
                   20370:                         foreach my $field (@shown) {
                   20371:                             next if ($field eq '');
                   20372:                             $menu{$field} = 1;
                   20373:                         }
                   20374:                     }
                   20375:                 }
                   20376:             }
                   20377:         }
                   20378:     }
                   20379:     return %menu;
                   20380: }
                   20381: 
1.112     bowersj2 20382: 1;
                   20383: __END__;
1.41      ng       20384: 

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