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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.1062  ! raeburn     4: # $Id: loncommon.pm,v 1.1061 2012/03/24 23:35:25 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.685     tempelho   64: use Apache::lonnet();
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.479     albertel   70: use LONCAPA qw(:DEFAULT :match);
1.657     raeburn    71: use DateTime::TimeZone;
1.687     raeburn    72: use DateTime::Locale::Catalog;
1.117     www        73: 
1.517     raeburn    74: # ---------------------------------------------- Designs
                     75: use vars qw(%defaultdesign);
                     76: 
1.22      www        77: my $readit;
                     78: 
1.517     raeburn    79: 
1.157     matthew    80: ##
                     81: ## Global Variables
                     82: ##
1.46      matthew    83: 
1.643     foxr       84: 
                     85: # ----------------------------------------------- SSI with retries:
                     86: #
                     87: 
                     88: =pod
                     89: 
1.648     raeburn    90: =head1 Server Side include with retries:
1.643     foxr       91: 
                     92: =over 4
                     93: 
1.648     raeburn    94: =item * &ssi_with_retries(resource,retries form)
1.643     foxr       95: 
                     96: Performs an ssi with some number of retries.  Retries continue either
                     97: until the result is ok or until the retry count supplied by the
                     98: caller is exhausted.  
                     99: 
                    100: Inputs:
1.648     raeburn   101: 
                    102: =over 4
                    103: 
1.643     foxr      104: resource   - Identifies the resource to insert.
1.648     raeburn   105: 
1.643     foxr      106: retries    - Count of the number of retries allowed.
1.648     raeburn   107: 
1.643     foxr      108: form       - Hash that identifies the rendering options.
                    109: 
1.648     raeburn   110: =back
                    111: 
                    112: Returns:
                    113: 
                    114: =over 4
                    115: 
1.643     foxr      116: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   117: 
1.643     foxr      118: response   - The response from the last attempt (which may or may not have been successful.
                    119: 
1.648     raeburn   120: =back
                    121: 
                    122: =back
                    123: 
1.643     foxr      124: =cut
                    125: 
                    126: sub ssi_with_retries {
                    127:     my ($resource, $retries, %form) = @_;
                    128: 
                    129: 
                    130:     my $ok = 0;			# True if we got a good response.
                    131:     my $content;
                    132:     my $response;
                    133: 
                    134:     # Try to get the ssi done. within the retries count:
                    135: 
                    136:     do {
                    137: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    138: 	$ok      = $response->is_success;
1.650     www       139:         if (!$ok) {
                    140:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    141:         }
1.643     foxr      142: 	$retries--;
                    143:     } while (!$ok && ($retries > 0));
                    144: 
                    145:     if (!$ok) {
                    146: 	$content = '';		# On error return an empty content.
                    147:     }
                    148:     return ($content, $response);
                    149: 
                    150: }
                    151: 
                    152: 
                    153: 
1.20      www       154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  155: my %language;
1.124     www       156: my %supported_language;
1.1048    foxr      157: my %latex_language;		# For choosing hyphenation in <transl..>
                    158: my %latex_language_bykey;	# for choosing hyphenation from metadata
1.12      harris41  159: my %cprtag;
1.192     taceyjo1  160: my %scprtag;
1.351     www       161: my %fe; my %fd; my %fm;
1.41      ng        162: my %category_extensions;
1.12      harris41  163: 
1.46      matthew   164: # ---------------------------------------------- Thesaurus variables
1.144     matthew   165: #
                    166: # %Keywords:
                    167: #      A hash used by &keyword to determine if a word is considered a keyword.
                    168: # $thesaurus_db_file 
                    169: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   170: 
                    171: my %Keywords;
                    172: my $thesaurus_db_file;
                    173: 
1.144     matthew   174: #
                    175: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    176: # thesaurus.tab, and filecategories.tab.
                    177: #
1.18      www       178: BEGIN {
1.46      matthew   179:     # Variable initialization
                    180:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    181:     #
1.22      www       182:     unless ($readit) {
1.12      harris41  183: # ------------------------------------------------------------------- languages
                    184:     {
1.158     raeburn   185:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    186:                                    '/language.tab';
                    187:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  188:             while (my $line = <$fh>) {
                    189:                 next if ($line=~/^\#/);
                    190:                 chomp($line);
1.1048    foxr      191:                 my ($key,$two,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158     raeburn   192:                 $language{$key}=$val.' - '.$enc;
                    193:                 if ($sup) {
                    194:                     $supported_language{$key}=$sup;
                    195:                 }
1.1048    foxr      196: 		if ($latex) {
                    197: 		    $latex_language_bykey{$key} = $latex;
                    198: 		    $latex_language{$two} = $latex;
                    199: 		}
1.158     raeburn   200:             }
                    201:             close($fh);
                    202:         }
1.12      harris41  203:     }
                    204: # ------------------------------------------------------------------ copyrights
                    205:     {
1.158     raeburn   206:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    207:                                   '/copyright.tab';
                    208:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  209:             while (my $line = <$fh>) {
                    210:                 next if ($line=~/^\#/);
                    211:                 chomp($line);
                    212:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   213:                 $cprtag{$key}=$val;
                    214:             }
                    215:             close($fh);
                    216:         }
1.12      harris41  217:     }
1.351     www       218: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  219:     {
                    220:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    221:                                   '/source_copyright.tab';
                    222:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  223:             while (my $line = <$fh>) {
                    224:                 next if ($line =~ /^\#/);
                    225:                 chomp($line);
                    226:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  227:                 $scprtag{$key}=$val;
                    228:             }
                    229:             close($fh);
                    230:         }
                    231:     }
1.63      www       232: 
1.517     raeburn   233: # -------------------------------------------------------------- default domain designs
1.63      www       234:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   235:     my $designfile = $designdir.'/default.tab';
                    236:     if ( open (my $fh,"<$designfile") ) {
                    237:         while (my $line = <$fh>) {
                    238:             next if ($line =~ /^\#/);
                    239:             chomp($line);
                    240:             my ($key,$val)=(split(/\=/,$line));
                    241:             if ($val) { $defaultdesign{$key}=$val; }
                    242:         }
                    243:         close($fh);
1.63      www       244:     }
                    245: 
1.15      harris41  246: # ------------------------------------------------------------- file categories
                    247:     {
1.158     raeburn   248:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    249:                                   '/filecategories.tab';
                    250:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  251: 	    while (my $line = <$fh>) {
                    252: 		next if ($line =~ /^\#/);
                    253: 		chomp($line);
                    254:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   255:                 push @{$category_extensions{lc($category)}},$extension;
                    256:             }
                    257:             close($fh);
                    258:         }
                    259: 
1.15      harris41  260:     }
1.12      harris41  261: # ------------------------------------------------------------------ file types
                    262:     {
1.158     raeburn   263:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    264:                '/filetypes.tab';
                    265:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  266:             while (my $line = <$fh>) {
                    267: 		next if ($line =~ /^\#/);
                    268: 		chomp($line);
                    269:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   270:                 if ($descr ne '') {
                    271:                     $fe{$ending}=lc($emb);
                    272:                     $fd{$ending}=$descr;
1.351     www       273:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   274:                 }
                    275:             }
                    276:             close($fh);
                    277:         }
1.12      harris41  278:     }
1.22      www       279:     &Apache::lonnet::logthis(
1.705     tempelho  280:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       281:     $readit=1;
1.46      matthew   282:     }  # end of unless($readit) 
1.32      matthew   283:     
                    284: }
1.112     bowersj2  285: 
1.42      matthew   286: ###############################################################
                    287: ##           HTML and Javascript Helper Functions            ##
                    288: ###############################################################
                    289: 
                    290: =pod 
                    291: 
1.112     bowersj2  292: =head1 HTML and Javascript Functions
1.42      matthew   293: 
1.112     bowersj2  294: =over 4
                    295: 
1.648     raeburn   296: =item * &browser_and_searcher_javascript()
1.112     bowersj2  297: 
                    298: X<browsing, javascript>X<searching, javascript>Returns a string
                    299: containing javascript with two functions, C<openbrowser> and
                    300: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    301: tags.
1.42      matthew   302: 
1.648     raeburn   303: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   304: 
                    305: inputs: formname, elementname, only, omit
                    306: 
                    307: formname and elementname indicate the name of the html form and name of
                    308: the element that the results of the browsing selection are to be placed in. 
                    309: 
                    310: Specifying 'only' will restrict the browser to displaying only files
1.185     www       311: with the given extension.  Can be a comma separated list.
1.42      matthew   312: 
                    313: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       314: with the given extension.  Can be a comma separated list.
1.42      matthew   315: 
1.648     raeburn   316: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   317: 
                    318: Inputs: formname, elementname
                    319: 
                    320: formname and elementname specify the name of the html form and the name
                    321: of the element the selection from the search results will be placed in.
1.542     raeburn   322: 
1.42      matthew   323: =cut
                    324: 
                    325: sub browser_and_searcher_javascript {
1.199     albertel  326:     my ($mode)=@_;
                    327:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  328:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   329:     return <<END;
1.219     albertel  330: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   331:     var editbrowser = null;
1.135     albertel  332:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       333:         var url = '$resurl/?';
1.42      matthew   334:         if (editbrowser == null) {
                    335:             url += 'launch=1&';
                    336:         }
                    337:         url += 'catalogmode=interactive&';
1.199     albertel  338:         url += 'mode=$mode&';
1.611     albertel  339:         url += 'inhibitmenu=yes&';
1.42      matthew   340:         url += 'form=' + formname + '&';
                    341:         if (only != null) {
                    342:             url += 'only=' + only + '&';
1.217     albertel  343:         } else {
                    344:             url += 'only=&';
                    345: 	}
1.42      matthew   346:         if (omit != null) {
                    347:             url += 'omit=' + omit + '&';
1.217     albertel  348:         } else {
                    349:             url += 'omit=&';
                    350: 	}
1.135     albertel  351:         if (titleelement != null) {
                    352:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  353:         } else {
                    354: 	    url += 'titleelement=&';
                    355: 	}
1.42      matthew   356:         url += 'element=' + elementname + '';
                    357:         var title = 'Browser';
1.435     albertel  358:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   359:         options += ',width=700,height=600';
                    360:         editbrowser = open(url,title,options,'1');
                    361:         editbrowser.focus();
                    362:     }
                    363:     var editsearcher;
1.135     albertel  364:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   365:         var url = '/adm/searchcat?';
                    366:         if (editsearcher == null) {
                    367:             url += 'launch=1&';
                    368:         }
                    369:         url += 'catalogmode=interactive&';
1.199     albertel  370:         url += 'mode=$mode&';
1.42      matthew   371:         url += 'form=' + formname + '&';
1.135     albertel  372:         if (titleelement != null) {
                    373:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  374:         } else {
                    375: 	    url += 'titleelement=&';
                    376: 	}
1.42      matthew   377:         url += 'element=' + elementname + '';
                    378:         var title = 'Search';
1.435     albertel  379:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   380:         options += ',width=700,height=600';
                    381:         editsearcher = open(url,title,options,'1');
                    382:         editsearcher.focus();
                    383:     }
1.219     albertel  384: // END LON-CAPA Internal -->
1.42      matthew   385: END
1.170     www       386: }
                    387: 
                    388: sub lastresurl {
1.258     albertel  389:     if ($env{'environment.lastresurl'}) {
                    390: 	return $env{'environment.lastresurl'}
1.170     www       391:     } else {
                    392: 	return '/res';
                    393:     }
                    394: }
                    395: 
                    396: sub storeresurl {
                    397:     my $resurl=&Apache::lonnet::clutter(shift);
                    398:     unless ($resurl=~/^\/res/) { return 0; }
                    399:     $resurl=~s/\/$//;
                    400:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   401:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       402:     return 1;
1.42      matthew   403: }
                    404: 
1.74      www       405: sub studentbrowser_javascript {
1.111     www       406:    unless (
1.258     albertel  407:             (($env{'request.course.id'}) && 
1.302     albertel  408:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    409: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    410: 					  '/'.$env{'request.course.sec'})
                    411: 	      ))
1.258     albertel  412:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       413:           ) { return ''; }  
1.74      www       414:    return (<<'ENDSTDBRW');
1.776     bisitz    415: <script type="text/javascript" language="Javascript">
1.824     bisitz    416: // <![CDATA[
1.74      www       417:     var stdeditbrowser;
1.999     www       418:     function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadvonly) {
1.74      www       419:         var url = '/adm/pickstudent?';
                    420:         var filter;
1.558     albertel  421: 	if (!ignorefilter) {
                    422: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    423: 	}
1.74      www       424:         if (filter != null) {
                    425:            if (filter != '') {
                    426:                url += 'filter='+filter+'&';
                    427: 	   }
                    428:         }
                    429:         url += 'form=' + formname + '&unameelement='+uname+
1.999     www       430:                                     '&udomelement='+udom+
                    431:                                     '&clicker='+clicker;
1.111     www       432: 	if (roleflag) { url+="&roles=1"; }
1.793     raeburn   433:         if (courseadvonly) { url+="&courseadvonly=1"; }
1.102     www       434:         var title = 'Student_Browser';
1.74      www       435:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    436:         options += ',width=700,height=600';
                    437:         stdeditbrowser = open(url,title,options,'1');
                    438:         stdeditbrowser.focus();
                    439:     }
1.824     bisitz    440: // ]]>
1.74      www       441: </script>
                    442: ENDSTDBRW
                    443: }
1.42      matthew   444: 
1.1003    www       445: sub resourcebrowser_javascript {
                    446:    unless ($env{'request.course.id'}) { return ''; }
1.1004    www       447:    return (<<'ENDRESBRW');
1.1003    www       448: <script type="text/javascript" language="Javascript">
                    449: // <![CDATA[
                    450:     var reseditbrowser;
1.1004    www       451:     function openresbrowser(formname,reslink) {
1.1005    www       452:         var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003    www       453:         var title = 'Resource_Browser';
                    454:         var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005    www       455:         options += ',width=700,height=500';
1.1004    www       456:         reseditbrowser = open(url,title,options,'1');
                    457:         reseditbrowser.focus();
1.1003    www       458:     }
                    459: // ]]>
                    460: </script>
1.1004    www       461: ENDRESBRW
1.1003    www       462: }
                    463: 
1.74      www       464: sub selectstudent_link {
1.999     www       465:    my ($form,$unameele,$udomele,$courseadvonly,$clickerid)=@_;
                    466:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    467:                       &Apache::lonhtmlcommon::entity_encode($unameele)."','".
                    468:                       &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258     albertel  469:    if ($env{'request.course.id'}) {  
1.302     albertel  470:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    471: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    472: 					'/'.$env{'request.course.sec'})) {
1.111     www       473: 	   return '';
                    474:        }
1.999     www       475:        $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.793     raeburn   476:        if ($courseadvonly)  {
                    477:            $callargs .= ",'',1,1";
                    478:        }
                    479:        return '<span class="LC_nobreak">'.
                    480:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    481:               &mt('Select User').'</a></span>';
1.74      www       482:    }
1.258     albertel  483:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012    www       484:        $callargs .= ",'',1"; 
1.793     raeburn   485:        return '<span class="LC_nobreak">'.
                    486:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    487:               &mt('Select User').'</a></span>';
1.111     www       488:    }
                    489:    return '';
1.91      www       490: }
                    491: 
1.1004    www       492: sub selectresource_link {
                    493:    my ($form,$reslink,$arg)=@_;
                    494:    
                    495:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    496:                       &Apache::lonhtmlcommon::entity_encode($reslink)."'";
                    497:    unless ($env{'request.course.id'}) { return $arg; }
                    498:    return '<span class="LC_nobreak">'.
                    499:               '<a href="javascript:openresbrowser('.$callargs.');">'.
                    500:               $arg.'</a></span>';
                    501: }
                    502: 
                    503: 
                    504: 
1.653     raeburn   505: sub authorbrowser_javascript {
                    506:     return <<"ENDAUTHORBRW";
1.776     bisitz    507: <script type="text/javascript" language="JavaScript">
1.824     bisitz    508: // <![CDATA[
1.653     raeburn   509: var stdeditbrowser;
                    510: 
                    511: function openauthorbrowser(formname,udom) {
                    512:     var url = '/adm/pickauthor?';
                    513:     url += 'form='+formname+'&roledom='+udom;
                    514:     var title = 'Author_Browser';
                    515:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    516:     options += ',width=700,height=600';
                    517:     stdeditbrowser = open(url,title,options,'1');
                    518:     stdeditbrowser.focus();
                    519: }
                    520: 
1.824     bisitz    521: // ]]>
1.653     raeburn   522: </script>
                    523: ENDAUTHORBRW
                    524: }
                    525: 
1.91      www       526: sub coursebrowser_javascript {
1.909     raeburn   527:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932     raeburn   528:     my $wintitle = 'Course_Browser';
1.931     raeburn   529:     if ($crstype eq 'Community') {
1.932     raeburn   530:         $wintitle = 'Community_Browser';
1.909     raeburn   531:     }
1.876     raeburn   532:     my $id_functions = &javascript_index_functions();
                    533:     my $output = '
1.776     bisitz    534: <script type="text/javascript" language="JavaScript">
1.824     bisitz    535: // <![CDATA[
1.468     raeburn   536:     var stdeditbrowser;'."\n";
1.876     raeburn   537: 
                    538:     $output .= <<"ENDSTDBRW";
1.909     raeburn   539:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       540:         var url = '/adm/pickcourse?';
1.895     raeburn   541:         var formid = getFormIdByName(formname);
1.876     raeburn   542:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  543:         if (domainfilter != null) {
                    544:            if (domainfilter != '') {
                    545:                url += 'domainfilter='+domainfilter+'&';
                    546: 	   }
                    547:         }
1.91      www       548:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  549: 	                            '&cdomelement='+udom+
                    550:                                     '&cnameelement='+desc;
1.468     raeburn   551:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   552:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   553:                 url += '&roleelement='+extra_element;
                    554:                 if (domainfilter == null || domainfilter == '') {
                    555:                     url += '&domainfilter='+extra_element;
                    556:                 }
1.234     raeburn   557:             }
1.468     raeburn   558:             else {
                    559:                 if (formname == 'portform') {
                    560:                     url += '&setroles='+extra_element;
1.800     raeburn   561:                 } else {
                    562:                     if (formname == 'rules') {
                    563:                         url += '&fixeddom='+extra_element; 
                    564:                     }
1.468     raeburn   565:                 }
                    566:             }     
1.230     raeburn   567:         }
1.909     raeburn   568:         if (type != null && type != '') {
                    569:             url += '&type='+type;
                    570:         }
                    571:         if (type_elem != null && type_elem != '') {
                    572:             url += '&typeelement='+type_elem;
                    573:         }
1.872     raeburn   574:         if (formname == 'ccrs') {
                    575:             var ownername = document.forms[formid].ccuname.value;
                    576:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
                    577:             url += '&cloner='+ownername+':'+ownerdom;
                    578:         }
1.293     raeburn   579:         if (multflag !=null && multflag != '') {
                    580:             url += '&multiple='+multflag;
                    581:         }
1.909     raeburn   582:         var title = '$wintitle';
1.91      www       583:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    584:         options += ',width=700,height=600';
                    585:         stdeditbrowser = open(url,title,options,'1');
                    586:         stdeditbrowser.focus();
                    587:     }
1.876     raeburn   588: $id_functions
                    589: ENDSTDBRW
1.905     raeburn   590:     if (($sec_element ne '') || ($role_element ne '')) {
                    591:         $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876     raeburn   592:     }
                    593:     $output .= '
                    594: // ]]>
                    595: </script>';
                    596:     return $output;
                    597: }
                    598: 
                    599: sub javascript_index_functions {
                    600:     return <<"ENDJS";
                    601: 
                    602: function getFormIdByName(formname) {
                    603:     for (var i=0;i<document.forms.length;i++) {
                    604:         if (document.forms[i].name == formname) {
                    605:             return i;
                    606:         }
                    607:     }
                    608:     return -1;
                    609: }
                    610: 
                    611: function getIndexByName(formid,item) {
                    612:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    613:         if (document.forms[formid].elements[i].name == item) {
                    614:             return i;
                    615:         }
                    616:     }
                    617:     return -1;
                    618: }
1.468     raeburn   619: 
1.876     raeburn   620: function getDomainFromSelectbox(formname,udom) {
                    621:     var userdom;
                    622:     var formid = getFormIdByName(formname);
                    623:     if (formid > -1) {
                    624:         var domid = getIndexByName(formid,udom);
                    625:         if (domid > -1) {
                    626:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    627:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    628:             }
                    629:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    630:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   631:             }
                    632:         }
                    633:     }
1.876     raeburn   634:     return userdom;
                    635: }
                    636: 
                    637: ENDJS
1.468     raeburn   638: 
1.876     raeburn   639: }
                    640: 
1.1017    raeburn   641: sub javascript_array_indexof {
1.1018    raeburn   642:     return <<ENDJS;
1.1017    raeburn   643: <script type="text/javascript" language="JavaScript">
                    644: // <![CDATA[
                    645: 
                    646: if (!Array.prototype.indexOf) {
                    647:     Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
                    648:         "use strict";
                    649:         if (this === void 0 || this === null) {
                    650:             throw new TypeError();
                    651:         }
                    652:         var t = Object(this);
                    653:         var len = t.length >>> 0;
                    654:         if (len === 0) {
                    655:             return -1;
                    656:         }
                    657:         var n = 0;
                    658:         if (arguments.length > 0) {
                    659:             n = Number(arguments[1]);
                    660:             if (n !== n) { // shortcut for verifying if it's NaN
                    661:                 n = 0;
                    662:             } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
                    663:                 n = (n > 0 || -1) * Math.floor(Math.abs(n));
                    664:             }
                    665:         }
                    666:         if (n >= len) {
                    667:             return -1;
                    668:         }
                    669:         var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
                    670:         for (; k < len; k++) {
                    671:             if (k in t && t[k] === searchElement) {
                    672:                 return k;
                    673:             }
                    674:         }
                    675:         return -1;
                    676:     }
                    677: }
                    678: 
                    679: // ]]>
                    680: </script>
                    681: 
                    682: ENDJS
                    683: 
                    684: }
                    685: 
1.876     raeburn   686: sub userbrowser_javascript {
                    687:     my $id_functions = &javascript_index_functions();
                    688:     return <<"ENDUSERBRW";
                    689: 
1.888     raeburn   690: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   691:     var url = '/adm/pickuser?';
                    692:     var userdom = getDomainFromSelectbox(formname,udom);
                    693:     if (userdom != null) {
                    694:        if (userdom != '') {
                    695:            url += 'srchdom='+userdom+'&';
                    696:        }
                    697:     }
                    698:     url += 'form=' + formname + '&unameelement='+uname+
                    699:                                 '&udomelement='+udom+
                    700:                                 '&ulastelement='+ulast+
                    701:                                 '&ufirstelement='+ufirst+
                    702:                                 '&uemailelement='+uemail+
1.881     raeburn   703:                                 '&hideudomelement='+hideudom+
                    704:                                 '&coursedom='+crsdom;
1.888     raeburn   705:     if ((caller != null) && (caller != undefined)) {
                    706:         url += '&caller='+caller;
                    707:     }
1.876     raeburn   708:     var title = 'User_Browser';
                    709:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    710:     options += ',width=700,height=600';
                    711:     var stdeditbrowser = open(url,title,options,'1');
                    712:     stdeditbrowser.focus();
                    713: }
                    714: 
1.888     raeburn   715: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   716:     var formid = getFormIdByName(formname);
                    717:     if (formid > -1) {
1.888     raeburn   718:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   719:         var domid = getIndexByName(formid,udom);
                    720:         var hidedomid = getIndexByName(formid,origdom);
                    721:         if (hidedomid > -1) {
                    722:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   723:             var unameval = document.forms[formid].elements[unameid].value;
                    724:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    725:                 if (domid > -1) {
                    726:                     var slct = document.forms[formid].elements[domid];
                    727:                     if (slct.type == 'select-one') {
                    728:                         var i;
                    729:                         for (i=0;i<slct.length;i++) {
                    730:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    731:                         }
                    732:                     }
                    733:                     if (slct.type == 'hidden') {
                    734:                         slct.value = fixeddom;
1.876     raeburn   735:                     }
                    736:                 }
1.468     raeburn   737:             }
                    738:         }
                    739:     }
1.876     raeburn   740:     return;
                    741: }
                    742: 
                    743: $id_functions
                    744: ENDUSERBRW
1.468     raeburn   745: }
                    746: 
                    747: sub setsec_javascript {
1.905     raeburn   748:     my ($sec_element,$formname,$role_element) = @_;
                    749:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    750:         $communityrolestr);
                    751:     if ($role_element ne '') {
                    752:         my @allroles = ('st','ta','ep','in','ad');
                    753:         foreach my $crstype ('Course','Community') {
                    754:             if ($crstype eq 'Community') {
                    755:                 foreach my $role (@allroles) {
                    756:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    757:                 }
                    758:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    759:             } else {
                    760:                 foreach my $role (@allroles) {
                    761:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    762:                 }
                    763:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    764:             }
                    765:         }
                    766:         $rolestr = '"'.join('","',@allroles).'"';
                    767:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    768:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    769:     }
1.468     raeburn   770:     my $setsections = qq|
                    771: function setSect(sectionlist) {
1.629     raeburn   772:     var sectionsArray = new Array();
                    773:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    774:         sectionsArray = sectionlist.split(",");
                    775:     }
1.468     raeburn   776:     var numSections = sectionsArray.length;
                    777:     document.$formname.$sec_element.length = 0;
                    778:     if (numSections == 0) {
                    779:         document.$formname.$sec_element.multiple=false;
                    780:         document.$formname.$sec_element.size=1;
                    781:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    782:     } else {
                    783:         if (numSections == 1) {
                    784:             document.$formname.$sec_element.multiple=false;
                    785:             document.$formname.$sec_element.size=1;
                    786:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    787:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    788:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    789:         } else {
                    790:             for (var i=0; i<numSections; i++) {
                    791:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    792:             }
                    793:             document.$formname.$sec_element.multiple=true
                    794:             if (numSections < 3) {
                    795:                 document.$formname.$sec_element.size=numSections;
                    796:             } else {
                    797:                 document.$formname.$sec_element.size=3;
                    798:             }
                    799:             document.$formname.$sec_element.options[0].selected = false
                    800:         }
                    801:     }
1.91      www       802: }
1.905     raeburn   803: 
                    804: function setRole(crstype) {
1.468     raeburn   805: |;
1.905     raeburn   806:     if ($role_element eq '') {
                    807:         $setsections .= '    return;
                    808: }
                    809: ';
                    810:     } else {
                    811:         $setsections .= qq|
                    812:     var elementLength = document.$formname.$role_element.length;
                    813:     var allroles = Array($rolestr);
                    814:     var courserolenames = Array($courserolestr);
                    815:     var communityrolenames = Array($communityrolestr);
                    816:     if (elementLength != undefined) {
                    817:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    818:             if (crstype == 'Course') {
                    819:                 return;
                    820:             } else {
                    821:                 allroles[5] = 'co';
                    822:                 for (var i=0; i<6; i++) {
                    823:                     document.$formname.$role_element.options[i].value = allroles[i];
                    824:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    825:                 }
                    826:             }
                    827:         } else {
                    828:             if (crstype == 'Community') {
                    829:                 return;
                    830:             } else {
                    831:                 allroles[5] = 'cc';
                    832:                 for (var i=0; i<6; i++) {
                    833:                     document.$formname.$role_element.options[i].value = allroles[i];
                    834:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    835:                 }
                    836:             }
                    837:         }
                    838:     }
                    839:     return;
                    840: }
                    841: |;
                    842:     }
1.468     raeburn   843:     return $setsections;
                    844: }
                    845: 
1.91      www       846: sub selectcourse_link {
1.909     raeburn   847:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    848:        $typeelement) = @_;
                    849:    my $type = $selecttype;
1.871     raeburn   850:    my $linktext = &mt('Select Course');
                    851:    if ($selecttype eq 'Community') {
1.909     raeburn   852:        $linktext = &mt('Select Community');
1.906     raeburn   853:    } elsif ($selecttype eq 'Course/Community') {
                    854:        $linktext = &mt('Select Course/Community');
1.909     raeburn   855:        $type = '';
1.1019    raeburn   856:    } elsif ($selecttype eq 'Select') {
                    857:        $linktext = &mt('Select');
                    858:        $type = '';
1.871     raeburn   859:    }
1.787     bisitz    860:    return '<span class="LC_nobreak">'
                    861:          ."<a href='"
                    862:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    863:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   864:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   865:          ."'>".$linktext.'</a>'
1.787     bisitz    866:          .'</span>';
1.74      www       867: }
1.42      matthew   868: 
1.653     raeburn   869: sub selectauthor_link {
                    870:    my ($form,$udom)=@_;
                    871:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    872:           &mt('Select Author').'</a>';
                    873: }
                    874: 
1.876     raeburn   875: sub selectuser_link {
1.881     raeburn   876:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   877:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   878:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   879:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   880:            ');">'.$linktext.'</a>';
1.876     raeburn   881: }
                    882: 
1.273     raeburn   883: sub check_uncheck_jscript {
                    884:     my $jscript = <<"ENDSCRT";
                    885: function checkAll(field) {
                    886:     if (field.length > 0) {
                    887:         for (i = 0; i < field.length; i++) {
                    888:             field[i].checked = true ;
                    889:         }
                    890:     } else {
                    891:         field.checked = true
                    892:     }
                    893: }
                    894:  
                    895: function uncheckAll(field) {
                    896:     if (field.length > 0) {
                    897:         for (i = 0; i < field.length; i++) {
                    898:             field[i].checked = false ;
1.543     albertel  899:         }
                    900:     } else {
1.273     raeburn   901:         field.checked = false ;
                    902:     }
                    903: }
                    904: ENDSCRT
                    905:     return $jscript;
                    906: }
                    907: 
1.656     www       908: sub select_timezone {
1.659     raeburn   909:    my ($name,$selected,$onchange,$includeempty)=@_;
                    910:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    911:    if ($includeempty) {
                    912:        $output .= '<option value=""';
                    913:        if (($selected eq '') || ($selected eq 'local')) {
                    914:            $output .= ' selected="selected" ';
                    915:        }
                    916:        $output .= '> </option>';
                    917:    }
1.657     raeburn   918:    my @timezones = DateTime::TimeZone->all_names;
                    919:    foreach my $tzone (@timezones) {
                    920:        $output.= '<option value="'.$tzone.'"';
                    921:        if ($tzone eq $selected) {
                    922:            $output.=' selected="selected"';
                    923:        }
                    924:        $output.=">$tzone</option>\n";
1.656     www       925:    }
                    926:    $output.="</select>";
                    927:    return $output;
                    928: }
1.273     raeburn   929: 
1.687     raeburn   930: sub select_datelocale {
                    931:     my ($name,$selected,$onchange,$includeempty)=@_;
                    932:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    933:     if ($includeempty) {
                    934:         $output .= '<option value=""';
                    935:         if ($selected eq '') {
                    936:             $output .= ' selected="selected" ';
                    937:         }
                    938:         $output .= '> </option>';
                    939:     }
                    940:     my (@possibles,%locale_names);
                    941:     my @locales = DateTime::Locale::Catalog::Locales;
                    942:     foreach my $locale (@locales) {
                    943:         if (ref($locale) eq 'HASH') {
                    944:             my $id = $locale->{'id'};
                    945:             if ($id ne '') {
                    946:                 my $en_terr = $locale->{'en_territory'};
                    947:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   948:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   949:                 if (grep(/^en$/,@languages) || !@languages) {
                    950:                     if ($en_terr ne '') {
                    951:                         $locale_names{$id} = '('.$en_terr.')';
                    952:                     } elsif ($native_terr ne '') {
                    953:                         $locale_names{$id} = $native_terr;
                    954:                     }
                    955:                 } else {
                    956:                     if ($native_terr ne '') {
                    957:                         $locale_names{$id} = $native_terr.' ';
                    958:                     } elsif ($en_terr ne '') {
                    959:                         $locale_names{$id} = '('.$en_terr.')';
                    960:                     }
                    961:                 }
                    962:                 push (@possibles,$id);
                    963:             }
                    964:         }
                    965:     }
                    966:     foreach my $item (sort(@possibles)) {
                    967:         $output.= '<option value="'.$item.'"';
                    968:         if ($item eq $selected) {
                    969:             $output.=' selected="selected"';
                    970:         }
                    971:         $output.=">$item";
                    972:         if ($locale_names{$item} ne '') {
                    973:             $output.="  $locale_names{$item}</option>\n";
                    974:         }
                    975:         $output.="</option>\n";
                    976:     }
                    977:     $output.="</select>";
                    978:     return $output;
                    979: }
                    980: 
1.792     raeburn   981: sub select_language {
                    982:     my ($name,$selected,$includeempty) = @_;
                    983:     my %langchoices;
                    984:     if ($includeempty) {
                    985:         %langchoices = ('' => 'No language preference');
                    986:     }
                    987:     foreach my $id (&languageids()) {
                    988:         my $code = &supportedlanguagecode($id);
                    989:         if ($code) {
                    990:             $langchoices{$code} = &plainlanguagedescription($id);
                    991:         }
                    992:     }
1.970     raeburn   993:     return &select_form($selected,$name,\%langchoices);
1.792     raeburn   994: }
                    995: 
1.42      matthew   996: =pod
1.36      matthew   997: 
1.648     raeburn   998: =item * &linked_select_forms(...)
1.36      matthew   999: 
                   1000: linked_select_forms returns a string containing a <script></script> block
                   1001: and html for two <select> menus.  The select menus will be linked in that
                   1002: changing the value of the first menu will result in new values being placed
                   1003: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn  1004: order unless a defined order is provided.
1.36      matthew  1005: 
                   1006: linked_select_forms takes the following ordered inputs:
                   1007: 
                   1008: =over 4
                   1009: 
1.112     bowersj2 1010: =item * $formname, the name of the <form> tag
1.36      matthew  1011: 
1.112     bowersj2 1012: =item * $middletext, the text which appears between the <select> tags
1.36      matthew  1013: 
1.112     bowersj2 1014: =item * $firstdefault, the default value for the first menu
1.36      matthew  1015: 
1.112     bowersj2 1016: =item * $firstselectname, the name of the first <select> tag
1.36      matthew  1017: 
1.112     bowersj2 1018: =item * $secondselectname, the name of the second <select> tag
1.36      matthew  1019: 
1.112     bowersj2 1020: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew  1021: 
1.609     raeburn  1022: =item * $menuorder, the order of values in the first menu
                   1023: 
1.41      ng       1024: =back 
                   1025: 
1.36      matthew  1026: Below is an example of such a hash.  Only the 'text', 'default', and 
                   1027: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                   1028: values for the first select menu.  The text that coincides with the 
1.41      ng       1029: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew  1030: and text for the second menu are given in the hash pointed to by 
                   1031: $menu{$choice1}->{'select2'}.  
                   1032: 
1.112     bowersj2 1033:  my %menu = ( A1 => { text =>"Choice A1" ,
                   1034:                        default => "B3",
                   1035:                        select2 => { 
                   1036:                            B1 => "Choice B1",
                   1037:                            B2 => "Choice B2",
                   1038:                            B3 => "Choice B3",
                   1039:                            B4 => "Choice B4"
1.609     raeburn  1040:                            },
                   1041:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2 1042:                    },
                   1043:                A2 => { text =>"Choice A2" ,
                   1044:                        default => "C2",
                   1045:                        select2 => { 
                   1046:                            C1 => "Choice C1",
                   1047:                            C2 => "Choice C2",
                   1048:                            C3 => "Choice C3"
1.609     raeburn  1049:                            },
                   1050:                        order => ['C2','C1','C3'],
1.112     bowersj2 1051:                    },
                   1052:                A3 => { text =>"Choice A3" ,
                   1053:                        default => "D6",
                   1054:                        select2 => { 
                   1055:                            D1 => "Choice D1",
                   1056:                            D2 => "Choice D2",
                   1057:                            D3 => "Choice D3",
                   1058:                            D4 => "Choice D4",
                   1059:                            D5 => "Choice D5",
                   1060:                            D6 => "Choice D6",
                   1061:                            D7 => "Choice D7"
1.609     raeburn  1062:                            },
                   1063:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2 1064:                    }
                   1065:                );
1.36      matthew  1066: 
                   1067: =cut
                   1068: 
                   1069: sub linked_select_forms {
                   1070:     my ($formname,
                   1071:         $middletext,
                   1072:         $firstdefault,
                   1073:         $firstselectname,
                   1074:         $secondselectname, 
1.609     raeburn  1075:         $hashref,
                   1076:         $menuorder,
1.36      matthew  1077:         ) = @_;
                   1078:     my $second = "document.$formname.$secondselectname";
                   1079:     my $first = "document.$formname.$firstselectname";
                   1080:     # output the javascript to do the changing
                   1081:     my $result = '';
1.776     bisitz   1082:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz   1083:     $result.="// <![CDATA[\n";
1.36      matthew  1084:     $result.="var select2data = new Object();\n";
                   1085:     $" = '","';
                   1086:     my $debug = '';
                   1087:     foreach my $s1 (sort(keys(%$hashref))) {
                   1088:         $result.="select2data.d_$s1 = new Object();\n";        
                   1089:         $result.="select2data.d_$s1.def = new String('".
                   1090:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn  1091:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew  1092:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1093:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1094:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1095:         }
1.36      matthew  1096:         $result.="\"@s2values\");\n";
                   1097:         $result.="select2data.d_$s1.texts = new Array(";        
                   1098:         my @s2texts;
                   1099:         foreach my $value (@s2values) {
                   1100:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                   1101:         }
                   1102:         $result.="\"@s2texts\");\n";
                   1103:     }
                   1104:     $"=' ';
                   1105:     $result.= <<"END";
                   1106: 
                   1107: function select1_changed() {
                   1108:     // Determine new choice
                   1109:     var newvalue = "d_" + $first.value;
                   1110:     // update select2
                   1111:     var values     = select2data[newvalue].values;
                   1112:     var texts      = select2data[newvalue].texts;
                   1113:     var select2def = select2data[newvalue].def;
                   1114:     var i;
                   1115:     // out with the old
                   1116:     for (i = 0; i < $second.options.length; i++) {
                   1117:         $second.options[i] = null;
                   1118:     }
                   1119:     // in with the nuclear
                   1120:     for (i=0;i<values.length; i++) {
                   1121:         $second.options[i] = new Option(values[i]);
1.143     matthew  1122:         $second.options[i].value = values[i];
1.36      matthew  1123:         $second.options[i].text = texts[i];
                   1124:         if (values[i] == select2def) {
                   1125:             $second.options[i].selected = true;
                   1126:         }
                   1127:     }
                   1128: }
1.824     bisitz   1129: // ]]>
1.36      matthew  1130: </script>
                   1131: END
                   1132:     # output the initial values for the selection lists
                   1133:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn  1134:     my @order = sort(keys(%{$hashref}));
                   1135:     if (ref($menuorder) eq 'ARRAY') {
                   1136:         @order = @{$menuorder};
                   1137:     }
                   1138:     foreach my $value (@order) {
1.36      matthew  1139:         $result.="    <option value=\"$value\" ";
1.253     albertel 1140:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1141:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1142:     }
                   1143:     $result .= "</select>\n";
                   1144:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1145:     $result .= $middletext;
                   1146:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                   1147:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1148:     
                   1149:     my @secondorder = sort(keys(%select2));
                   1150:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1151:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1152:     }
                   1153:     foreach my $value (@secondorder) {
1.36      matthew  1154:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1155:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1156:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1157:     }
                   1158:     $result .= "</select>\n";
                   1159:     #    return $debug;
                   1160:     return $result;
                   1161: }   #  end of sub linked_select_forms {
                   1162: 
1.45      matthew  1163: =pod
1.44      bowersj2 1164: 
1.973     raeburn  1165: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44      bowersj2 1166: 
1.112     bowersj2 1167: Returns a string corresponding to an HTML link to the given help
                   1168: $topic, where $topic corresponds to the name of a .tex file in
                   1169: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1170: spaces. 
                   1171: 
                   1172: $text will optionally be linked to the same topic, allowing you to
                   1173: link text in addition to the graphic. If you do not want to link
                   1174: text, but wish to specify one of the later parameters, pass an
                   1175: empty string. 
                   1176: 
                   1177: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1178: the link will not open a new window. If false, the link will open
                   1179: a new window using Javascript. (Default is false.) 
                   1180: 
                   1181: $width and $height are optional numerical parameters that will
                   1182: override the width and height of the popped up window, which may
1.973     raeburn  1183: be useful for certain help topics with big pictures included.
                   1184: 
                   1185: $imgid is the id of the img tag used for the help icon. This may be
                   1186: used in a javascript call to switch the image src.  See 
                   1187: lonhtmlcommon::htmlareaselectactive() for an example.
1.44      bowersj2 1188: 
                   1189: =cut
                   1190: 
                   1191: sub help_open_topic {
1.973     raeburn  1192:     my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48      bowersj2 1193:     $text = "" if (not defined $text);
1.44      bowersj2 1194:     $stayOnPage = 0 if (not defined $stayOnPage);
1.1033    www      1195:     $width = 500 if (not defined $width);
1.44      bowersj2 1196:     $height = 400 if (not defined $height);
                   1197:     my $filename = $topic;
                   1198:     $filename =~ s/ /_/g;
                   1199: 
1.48      bowersj2 1200:     my $template = "";
                   1201:     my $link;
1.572     banghart 1202:     
1.159     www      1203:     $topic=~s/\W/\_/g;
1.44      bowersj2 1204: 
1.572     banghart 1205:     if (!$stayOnPage) {
1.1033    www      1206: 	$link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037    www      1207:     } elsif ($stayOnPage eq 'popup') {
                   1208:         $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 1209:     } else {
1.48      bowersj2 1210: 	$link = "/adm/help/${filename}.hlp";
                   1211:     }
                   1212: 
                   1213:     # Add the text
1.755     neumanie 1214:     if ($text ne "") {	
1.763     bisitz   1215: 	$template.='<span class="LC_help_open_topic">'
                   1216:                   .'<a target="_top" href="'.$link.'">'
                   1217:                   .$text.'</a>';
1.48      bowersj2 1218:     }
                   1219: 
1.763     bisitz   1220:     # (Always) Add the graphic
1.179     matthew  1221:     my $title = &mt('Online Help');
1.667     raeburn  1222:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973     raeburn  1223:     if ($imgid ne '') {
                   1224:         $imgid = ' id="'.$imgid.'"';
                   1225:     }
1.763     bisitz   1226:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1227:               .'<img src="'.$helpicon.'" border="0"'
                   1228:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973     raeburn  1229:               .' title="'.$title.'" style="vertical-align:middle;"'.$imgid 
1.763     bisitz   1230:               .' /></a>';
                   1231:     if ($text ne "") {	
                   1232:         $template.='</span>';
                   1233:     }
1.44      bowersj2 1234:     return $template;
                   1235: 
1.106     bowersj2 1236: }
                   1237: 
                   1238: # This is a quicky function for Latex cheatsheet editing, since it 
                   1239: # appears in at least four places
                   1240: sub helpLatexCheatsheet {
1.1037    www      1241:     my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732     raeburn  1242:     my $out;
1.106     bowersj2 1243:     my $addOther = '';
1.732     raeburn  1244:     if ($topic) {
1.1037    www      1245: 	$addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763     bisitz   1246:     }
                   1247:     $out = '<span>' # Start cheatsheet
                   1248: 	  .$addOther
                   1249:           .'<span>'
1.1037    www      1250: 	  .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1251: 	  .'</span> <span>'
1.1037    www      1252: 	  .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1253: 	  .'</span>';
1.732     raeburn  1254:     unless ($not_author) {
1.763     bisitz   1255:         $out .= ' <span>'
1.1037    www      1256: 	       .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.763     bisitz   1257: 	       .'</span>';
1.732     raeburn  1258:     }
1.763     bisitz   1259:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1260:     return $out;
1.172     www      1261: }
                   1262: 
1.430     albertel 1263: sub general_help {
                   1264:     my $helptopic='Student_Intro';
                   1265:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1266: 	$helptopic='Authoring_Intro';
1.907     raeburn  1267:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1268: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1269:     } elsif ($env{'request.role'}=~/^dc/) {
                   1270:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1271:     }
                   1272:     return $helptopic;
                   1273: }
                   1274: 
                   1275: sub update_help_link {
                   1276:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1277:     my $origurl = $ENV{'REQUEST_URI'};
                   1278:     $origurl=~s|^/~|/priv/|;
                   1279:     my $timestamp = time;
                   1280:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1281:         $$datum = &escape($$datum);
                   1282:     }
                   1283: 
                   1284:     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";
                   1285:     my $output .= <<"ENDOUTPUT";
                   1286: <script type="text/javascript">
1.824     bisitz   1287: // <![CDATA[
1.430     albertel 1288: banner_link = '$banner_link';
1.824     bisitz   1289: // ]]>
1.430     albertel 1290: </script>
                   1291: ENDOUTPUT
                   1292:     return $output;
                   1293: }
                   1294: 
                   1295: # now just updates the help link and generates a blue icon
1.193     raeburn  1296: sub help_open_menu {
1.430     albertel 1297:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1298: 	= @_;    
1.949     droeschl 1299:     $stayOnPage = 1;
1.430     albertel 1300:     my $output;
                   1301:     if ($component_help) {
                   1302: 	if (!$text) {
                   1303: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1304: 				       $width,$height);
                   1305: 	} else {
                   1306: 	    my $help_text;
                   1307: 	    $help_text=&unescape($topic);
                   1308: 	    $output='<table><tr><td>'.
                   1309: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1310: 				 $width,$height).'</td></tr></table>';
                   1311: 	}
                   1312:     }
                   1313:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1314:     return $output.$banner_link;
                   1315: }
                   1316: 
                   1317: sub top_nav_help {
                   1318:     my ($text) = @_;
1.436     albertel 1319:     $text = &mt($text);
1.949     droeschl 1320:     my $stay_on_page = 1;
                   1321: 
1.572     banghart 1322:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1323: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1324:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1325: 
1.201     raeburn  1326:     my $title = &mt('Get help');
1.436     albertel 1327: 
                   1328:     return <<"END";
                   1329: $banner_link
                   1330:  <a href="$link" title="$title">$text</a>
                   1331: END
                   1332: }
                   1333: 
                   1334: sub help_menu_js {
                   1335:     my ($text) = @_;
1.949     droeschl 1336:     my $stayOnPage = 1;
1.436     albertel 1337:     my $width = 620;
                   1338:     my $height = 600;
1.430     albertel 1339:     my $helptopic=&general_help();
                   1340:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1341:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1342:     my $start_page =
                   1343:         &Apache::loncommon::start_page('Help Menu', undef,
                   1344: 				       {'frameset'    => 1,
                   1345: 					'js_ready'    => 1,
                   1346: 					'add_entries' => {
                   1347: 					    'border' => '0',
1.579     raeburn  1348: 					    'rows'   => "110,*",},});
1.331     albertel 1349:     my $end_page =
                   1350:         &Apache::loncommon::end_page({'frameset' => 1,
                   1351: 				      'js_ready' => 1,});
                   1352: 
1.436     albertel 1353:     my $template .= <<"ENDTEMPLATE";
                   1354: <script type="text/javascript">
1.877     bisitz   1355: // <![CDATA[
1.253     albertel 1356: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1357: var banner_link = '';
1.243     raeburn  1358: function helpMenu(target) {
                   1359:     var caller = this;
                   1360:     if (target == 'open') {
                   1361:         var newWindow = null;
                   1362:         try {
1.262     albertel 1363:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1364:         }
                   1365:         catch(error) {
                   1366:             writeHelp(caller);
                   1367:             return;
                   1368:         }
                   1369:         if (newWindow) {
                   1370:             caller = newWindow;
                   1371:         }
1.193     raeburn  1372:     }
1.243     raeburn  1373:     writeHelp(caller);
                   1374:     return;
                   1375: }
                   1376: function writeHelp(caller) {
1.430     albertel 1377:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1378:     caller.document.close()
                   1379:     caller.focus()
1.193     raeburn  1380: }
1.877     bisitz   1381: // END LON-CAPA Internal -->
1.253     albertel 1382: // ]]>
1.436     albertel 1383: </script>
1.193     raeburn  1384: ENDTEMPLATE
                   1385:     return $template;
                   1386: }
                   1387: 
1.172     www      1388: sub help_open_bug {
                   1389:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1390:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1391:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1392:     $text = "" if (not defined $text);
                   1393: 	$stayOnPage=1;
1.184     albertel 1394:     $width = 600 if (not defined $width);
                   1395:     $height = 600 if (not defined $height);
1.172     www      1396: 
                   1397:     $topic=~s/\W+/\+/g;
                   1398:     my $link='';
                   1399:     my $template='';
1.379     albertel 1400:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1401: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1402:     if (!$stayOnPage)
                   1403:     {
                   1404: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1405:     }
                   1406:     else
                   1407:     {
                   1408: 	$link = $url;
                   1409:     }
                   1410:     # Add the text
                   1411:     if ($text ne "")
                   1412:     {
                   1413: 	$template .= 
                   1414:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1415:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1416:     }
                   1417: 
                   1418:     # Add the graphic
1.179     matthew  1419:     my $title = &mt('Report a Bug');
1.215     albertel 1420:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1421:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1422:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1423: ENDTEMPLATE
                   1424:     if ($text ne '') { $template.='</td></tr></table>' };
                   1425:     return $template;
                   1426: 
                   1427: }
                   1428: 
                   1429: sub help_open_faq {
                   1430:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1431:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1432:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1433:     $text = "" if (not defined $text);
                   1434: 	$stayOnPage=1;
                   1435:     $width = 350 if (not defined $width);
                   1436:     $height = 400 if (not defined $height);
                   1437: 
                   1438:     $topic=~s/\W+/\+/g;
                   1439:     my $link='';
                   1440:     my $template='';
                   1441:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1442:     if (!$stayOnPage)
                   1443:     {
                   1444: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1445:     }
                   1446:     else
                   1447:     {
                   1448: 	$link = $url;
                   1449:     }
                   1450: 
                   1451:     # Add the text
                   1452:     if ($text ne "")
                   1453:     {
                   1454: 	$template .= 
1.173     www      1455:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1456:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1457:     }
                   1458: 
                   1459:     # Add the graphic
1.179     matthew  1460:     my $title = &mt('View the FAQ');
1.215     albertel 1461:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1462:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1463:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1464: ENDTEMPLATE
                   1465:     if ($text ne '') { $template.='</td></tr></table>' };
                   1466:     return $template;
                   1467: 
1.44      bowersj2 1468: }
1.37      matthew  1469: 
1.180     matthew  1470: ###############################################################
                   1471: ###############################################################
                   1472: 
1.45      matthew  1473: =pod
                   1474: 
1.648     raeburn  1475: =item * &change_content_javascript():
1.256     matthew  1476: 
                   1477: This and the next function allow you to create small sections of an
                   1478: otherwise static HTML page that you can update on the fly with
                   1479: Javascript, even in Netscape 4.
                   1480: 
                   1481: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1482: must be written to the HTML page once. It will prove the Javascript
                   1483: function "change(name, content)". Calling the change function with the
                   1484: name of the section 
                   1485: you want to update, matching the name passed to C<changable_area>, and
                   1486: the new content you want to put in there, will put the content into
                   1487: that area.
                   1488: 
                   1489: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1490: to contain room for the original contents. You need to "make space"
                   1491: for whatever changes you wish to make, and be B<sure> to check your
                   1492: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1493: it's adequate for updating a one-line status display, but little more.
                   1494: This script will set the space to 100% width, so you only need to
                   1495: worry about height in Netscape 4.
                   1496: 
                   1497: Modern browsers are much less limiting, and if you can commit to the
                   1498: user not using Netscape 4, this feature may be used freely with
                   1499: pretty much any HTML.
                   1500: 
                   1501: =cut
                   1502: 
                   1503: sub change_content_javascript {
                   1504:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1505:     if ($env{'browser.type'} eq 'netscape' &&
                   1506: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1507: 	return (<<NETSCAPE4);
                   1508: 	function change(name, content) {
                   1509: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1510: 	    doc.open();
                   1511: 	    doc.write(content);
                   1512: 	    doc.close();
                   1513: 	}
                   1514: NETSCAPE4
                   1515:     } else {
                   1516: 	# Otherwise, we need to use semi-standards-compliant code
                   1517: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1518: 	# is really scary, and every useful browser supports it
                   1519: 	return (<<DOMBASED);
                   1520: 	function change(name, content) {
                   1521: 	    element = document.getElementById(name);
                   1522: 	    element.innerHTML = content;
                   1523: 	}
                   1524: DOMBASED
                   1525:     }
                   1526: }
                   1527: 
                   1528: =pod
                   1529: 
1.648     raeburn  1530: =item * &changable_area($name,$origContent):
1.256     matthew  1531: 
                   1532: This provides a "changable area" that can be modified on the fly via
                   1533: the Javascript code provided in C<change_content_javascript>. $name is
                   1534: the name you will use to reference the area later; do not repeat the
                   1535: same name on a given HTML page more then once. $origContent is what
                   1536: the area will originally contain, which can be left blank.
                   1537: 
                   1538: =cut
                   1539: 
                   1540: sub changable_area {
                   1541:     my ($name, $origContent) = @_;
                   1542: 
1.258     albertel 1543:     if ($env{'browser.type'} eq 'netscape' &&
                   1544: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1545: 	# If this is netscape 4, we need to use the Layer tag
                   1546: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1547:     } else {
                   1548: 	return "<span id='$name'>$origContent</span>";
                   1549:     }
                   1550: }
                   1551: 
                   1552: =pod
                   1553: 
1.648     raeburn  1554: =item * &viewport_geometry_js 
1.590     raeburn  1555: 
                   1556: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1557: 
                   1558: =cut
                   1559: 
                   1560: 
                   1561: sub viewport_geometry_js { 
                   1562:     return <<"GEOMETRY";
                   1563: var Geometry = {};
                   1564: function init_geometry() {
                   1565:     if (Geometry.init) { return };
                   1566:     Geometry.init=1;
                   1567:     if (window.innerHeight) {
                   1568:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1569:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1570:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1571:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1572:     }
                   1573:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1574:         Geometry.getViewportHeight =
                   1575:             function() { return document.documentElement.clientHeight; };
                   1576:         Geometry.getViewportWidth =
                   1577:             function() { return document.documentElement.clientWidth; };
                   1578: 
                   1579:         Geometry.getHorizontalScroll =
                   1580:             function() { return document.documentElement.scrollLeft; };
                   1581:         Geometry.getVerticalScroll =
                   1582:             function() { return document.documentElement.scrollTop; };
                   1583:     }
                   1584:     else if (document.body.clientHeight) {
                   1585:         Geometry.getViewportHeight =
                   1586:             function() { return document.body.clientHeight; };
                   1587:         Geometry.getViewportWidth =
                   1588:             function() { return document.body.clientWidth; };
                   1589:         Geometry.getHorizontalScroll =
                   1590:             function() { return document.body.scrollLeft; };
                   1591:         Geometry.getVerticalScroll =
                   1592:             function() { return document.body.scrollTop; };
                   1593:     }
                   1594: }
                   1595: 
                   1596: GEOMETRY
                   1597: }
                   1598: 
                   1599: =pod
                   1600: 
1.648     raeburn  1601: =item * &viewport_size_js()
1.590     raeburn  1602: 
                   1603: 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. 
                   1604: 
                   1605: =cut
                   1606: 
                   1607: sub viewport_size_js {
                   1608:     my $geometry = &viewport_geometry_js();
                   1609:     return <<"DIMS";
                   1610: 
                   1611: $geometry
                   1612: 
                   1613: function getViewportDims(width,height) {
                   1614:     init_geometry();
                   1615:     width.value = Geometry.getViewportWidth();
                   1616:     height.value = Geometry.getViewportHeight();
                   1617:     return;
                   1618: }
                   1619: 
                   1620: DIMS
                   1621: }
                   1622: 
                   1623: =pod
                   1624: 
1.648     raeburn  1625: =item * &resize_textarea_js()
1.565     albertel 1626: 
                   1627: emits the needed javascript to resize a textarea to be as big as possible
                   1628: 
                   1629: creates a function resize_textrea that takes two IDs first should be
                   1630: the id of the element to resize, second should be the id of a div that
                   1631: surrounds everything that comes after the textarea, this routine needs
                   1632: to be attached to the <body> for the onload and onresize events.
                   1633: 
1.648     raeburn  1634: =back
1.565     albertel 1635: 
                   1636: =cut
                   1637: 
                   1638: sub resize_textarea_js {
1.590     raeburn  1639:     my $geometry = &viewport_geometry_js();
1.565     albertel 1640:     return <<"RESIZE";
                   1641:     <script type="text/javascript">
1.824     bisitz   1642: // <![CDATA[
1.590     raeburn  1643: $geometry
1.565     albertel 1644: 
1.588     albertel 1645: function getX(element) {
                   1646:     var x = 0;
                   1647:     while (element) {
                   1648: 	x += element.offsetLeft;
                   1649: 	element = element.offsetParent;
                   1650:     }
                   1651:     return x;
                   1652: }
                   1653: function getY(element) {
                   1654:     var y = 0;
                   1655:     while (element) {
                   1656: 	y += element.offsetTop;
                   1657: 	element = element.offsetParent;
                   1658:     }
                   1659:     return y;
                   1660: }
                   1661: 
                   1662: 
1.565     albertel 1663: function resize_textarea(textarea_id,bottom_id) {
                   1664:     init_geometry();
                   1665:     var textarea        = document.getElementById(textarea_id);
                   1666:     //alert(textarea);
                   1667: 
1.588     albertel 1668:     var textarea_top    = getY(textarea);
1.565     albertel 1669:     var textarea_height = textarea.offsetHeight;
                   1670:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1671:     var bottom_top      = getY(bottom);
1.565     albertel 1672:     var bottom_height   = bottom.offsetHeight;
                   1673:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1674:     var fudge           = 23;
1.565     albertel 1675:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1676:     if (new_height < 300) {
                   1677: 	new_height = 300;
                   1678:     }
                   1679:     textarea.style.height=new_height+'px';
                   1680: }
1.824     bisitz   1681: // ]]>
1.565     albertel 1682: </script>
                   1683: RESIZE
                   1684: 
                   1685: }
                   1686: 
                   1687: =pod
                   1688: 
1.256     matthew  1689: =head1 Excel and CSV file utility routines
                   1690: 
                   1691: =over 4
                   1692: 
                   1693: =cut
                   1694: 
                   1695: ###############################################################
                   1696: ###############################################################
                   1697: 
                   1698: =pod
                   1699: 
1.648     raeburn  1700: =item * &csv_translate($text) 
1.37      matthew  1701: 
1.185     www      1702: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1703: format.
                   1704: 
                   1705: =cut
                   1706: 
1.180     matthew  1707: ###############################################################
                   1708: ###############################################################
1.37      matthew  1709: sub csv_translate {
                   1710:     my $text = shift;
                   1711:     $text =~ s/\"/\"\"/g;
1.209     albertel 1712:     $text =~ s/\n/ /g;
1.37      matthew  1713:     return $text;
                   1714: }
1.180     matthew  1715: 
                   1716: ###############################################################
                   1717: ###############################################################
                   1718: 
                   1719: =pod
                   1720: 
1.648     raeburn  1721: =item * &define_excel_formats()
1.180     matthew  1722: 
                   1723: Define some commonly used Excel cell formats.
                   1724: 
                   1725: Currently supported formats:
                   1726: 
                   1727: =over 4
                   1728: 
                   1729: =item header
                   1730: 
                   1731: =item bold
                   1732: 
                   1733: =item h1
                   1734: 
                   1735: =item h2
                   1736: 
                   1737: =item h3
                   1738: 
1.256     matthew  1739: =item h4
                   1740: 
                   1741: =item i
                   1742: 
1.180     matthew  1743: =item date
                   1744: 
                   1745: =back
                   1746: 
                   1747: Inputs: $workbook
                   1748: 
                   1749: Returns: $format, a hash reference.
                   1750: 
1.1057    foxr     1751: 
1.180     matthew  1752: =cut
                   1753: 
                   1754: ###############################################################
                   1755: ###############################################################
                   1756: sub define_excel_formats {
                   1757:     my ($workbook) = @_;
                   1758:     my $format;
                   1759:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1760:                                                 bottom    => 1,
                   1761:                                                 align     => 'center');
                   1762:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1763:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1764:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1765:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1766:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1767:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1768:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1769:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1770:     return $format;
                   1771: }
                   1772: 
                   1773: ###############################################################
                   1774: ###############################################################
1.113     bowersj2 1775: 
                   1776: =pod
                   1777: 
1.648     raeburn  1778: =item * &create_workbook()
1.255     matthew  1779: 
                   1780: Create an Excel worksheet.  If it fails, output message on the
                   1781: request object and return undefs.
                   1782: 
                   1783: Inputs: Apache request object
                   1784: 
                   1785: Returns (undef) on failure, 
                   1786:     Excel worksheet object, scalar with filename, and formats 
                   1787:     from &Apache::loncommon::define_excel_formats on success
                   1788: 
                   1789: =cut
                   1790: 
                   1791: ###############################################################
                   1792: ###############################################################
                   1793: sub create_workbook {
                   1794:     my ($r) = @_;
                   1795:         #
                   1796:     # Create the excel spreadsheet
                   1797:     my $filename = '/prtspool/'.
1.258     albertel 1798:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1799:         time.'_'.rand(1000000000).'.xls';
                   1800:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1801:     if (! defined($workbook)) {
                   1802:         $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928     bisitz   1803:         $r->print(
                   1804:             '<p class="LC_error">'
                   1805:            .&mt('Problems occurred in creating the new Excel file.')
                   1806:            .' '.&mt('This error has been logged.')
                   1807:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   1808:            .'</p>'
                   1809:         );
1.255     matthew  1810:         return (undef);
                   1811:     }
                   1812:     #
1.1014    foxr     1813:     $workbook->set_tempdir(LONCAPA::tempdir());
1.255     matthew  1814:     #
                   1815:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1816:     return ($workbook,$filename,$format);
                   1817: }
                   1818: 
                   1819: ###############################################################
                   1820: ###############################################################
                   1821: 
                   1822: =pod
                   1823: 
1.648     raeburn  1824: =item * &create_text_file()
1.113     bowersj2 1825: 
1.542     raeburn  1826: Create a file to write to and eventually make available to the user.
1.256     matthew  1827: If file creation fails, outputs an error message on the request object and 
                   1828: return undefs.
1.113     bowersj2 1829: 
1.256     matthew  1830: Inputs: Apache request object, and file suffix
1.113     bowersj2 1831: 
1.256     matthew  1832: Returns (undef) on failure, 
                   1833:     Filehandle and filename on success.
1.113     bowersj2 1834: 
                   1835: =cut
                   1836: 
1.256     matthew  1837: ###############################################################
                   1838: ###############################################################
                   1839: sub create_text_file {
                   1840:     my ($r,$suffix) = @_;
                   1841:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1842:     my $fh;
                   1843:     my $filename = '/prtspool/'.
1.258     albertel 1844:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1845:         time.'_'.rand(1000000000).'.'.$suffix;
                   1846:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1847:     if (! defined($fh)) {
                   1848:         $r->log_error("Couldn't open $filename for output $!");
1.928     bisitz   1849:         $r->print(
                   1850:             '<p class="LC_error">'
                   1851:            .&mt('Problems occurred in creating the output file.')
                   1852:            .' '.&mt('This error has been logged.')
                   1853:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   1854:            .'</p>'
                   1855:         );
1.113     bowersj2 1856:     }
1.256     matthew  1857:     return ($fh,$filename)
1.113     bowersj2 1858: }
                   1859: 
                   1860: 
1.256     matthew  1861: =pod 
1.113     bowersj2 1862: 
                   1863: =back
                   1864: 
                   1865: =cut
1.37      matthew  1866: 
                   1867: ###############################################################
1.33      matthew  1868: ##        Home server <option> list generating code          ##
                   1869: ###############################################################
1.35      matthew  1870: 
1.169     www      1871: # ------------------------------------------
                   1872: 
                   1873: sub domain_select {
                   1874:     my ($name,$value,$multiple)=@_;
                   1875:     my %domains=map { 
1.514     albertel 1876: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1877:     } &Apache::lonnet::all_domains();
1.169     www      1878:     if ($multiple) {
                   1879: 	$domains{''}=&mt('Any domain');
1.550     albertel 1880: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1881: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1882:     } else {
1.550     albertel 1883: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970     raeburn  1884: 	return &select_form($name,$value,\%domains);
1.169     www      1885:     }
                   1886: }
                   1887: 
1.282     albertel 1888: #-------------------------------------------
                   1889: 
                   1890: =pod
                   1891: 
1.519     raeburn  1892: =head1 Routines for form select boxes
                   1893: 
                   1894: =over 4
                   1895: 
1.648     raeburn  1896: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1897: 
                   1898: Returns a string containing a <select> element int multiple mode
                   1899: 
                   1900: 
                   1901: Args:
                   1902:   $name - name of the <select> element
1.506     raeburn  1903:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1904:   $size - number of rows long the select element is
1.283     albertel 1905:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1906:           (shown text should already have been &mt())
1.506     raeburn  1907:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1908: 
1.282     albertel 1909: =cut
                   1910: 
                   1911: #-------------------------------------------
1.169     www      1912: sub multiple_select_form {
1.284     albertel 1913:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1914:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1915:     my $output='';
1.191     matthew  1916:     if (! defined($size)) {
                   1917:         $size = 4;
1.283     albertel 1918:         if (scalar(keys(%$hash))<4) {
                   1919:             $size = scalar(keys(%$hash));
1.191     matthew  1920:         }
                   1921:     }
1.734     bisitz   1922:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1923:     my @order;
1.506     raeburn  1924:     if (ref($order) eq 'ARRAY')  {
                   1925:         @order = @{$order};
                   1926:     } else {
                   1927:         @order = sort(keys(%$hash));
1.501     banghart 1928:     }
                   1929:     if (exists($$hash{'select_form_order'})) {
                   1930:         @order = @{$$hash{'select_form_order'}};
                   1931:     }
                   1932:         
1.284     albertel 1933:     foreach my $key (@order) {
1.356     albertel 1934:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1935:         $output.='selected="selected" ' if ($selected{$key});
                   1936:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1937:     }
                   1938:     $output.="</select>\n";
                   1939:     return $output;
                   1940: }
                   1941: 
1.88      www      1942: #-------------------------------------------
                   1943: 
                   1944: =pod
                   1945: 
1.970     raeburn  1946: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88      www      1947: 
                   1948: Returns a string containing a <select name='$name' size='1'> form to 
1.970     raeburn  1949: allow a user to select options from a ref to a hash containing:
                   1950: option_name => displayed text. An optional $onchange can include
                   1951: a javascript onchange item, e.g., onchange="this.form.submit();"  
                   1952: 
1.88      www      1953: See lonrights.pm for an example invocation and use.
                   1954: 
                   1955: =cut
                   1956: 
                   1957: #-------------------------------------------
                   1958: sub select_form {
1.970     raeburn  1959:     my ($def,$name,$hashref,$onchange) = @_;
                   1960:     return unless (ref($hashref) eq 'HASH');
                   1961:     if ($onchange) {
                   1962:         $onchange = ' onchange="'.$onchange.'"';
                   1963:     }
                   1964:     my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128     albertel 1965:     my @keys;
1.970     raeburn  1966:     if (exists($hashref->{'select_form_order'})) {
                   1967: 	@keys=@{$hashref->{'select_form_order'}};
1.128     albertel 1968:     } else {
1.970     raeburn  1969: 	@keys=sort(keys(%{$hashref}));
1.128     albertel 1970:     }
1.356     albertel 1971:     foreach my $key (@keys) {
                   1972:         $selectform.=
                   1973: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1974:             ($key eq $def ? 'selected="selected" ' : '').
1.970     raeburn  1975:                 ">".$hashref->{$key}."</option>\n";
1.88      www      1976:     }
                   1977:     $selectform.="</select>";
                   1978:     return $selectform;
                   1979: }
                   1980: 
1.475     www      1981: # For display filters
                   1982: 
                   1983: sub display_filter {
                   1984:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1985:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1986:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1987: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1988: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1989: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1990:            &mt('Filter [_1]',
1.477     www      1991: 	   &select_form($env{'form.displayfilter'},
                   1992: 			'displayfilter',
1.970     raeburn  1993: 			{'currentfolder' => 'Current folder/page',
1.477     www      1994: 			 'containing' => 'Containing phrase',
1.970     raeburn  1995: 			 'none' => 'None'})).
1.714     bisitz   1996: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1997: }
                   1998: 
1.167     www      1999: sub gradeleveldescription {
                   2000:     my $gradelevel=shift;
                   2001:     my %gradelevels=(0 => 'Not specified',
                   2002: 		     1 => 'Grade 1',
                   2003: 		     2 => 'Grade 2',
                   2004: 		     3 => 'Grade 3',
                   2005: 		     4 => 'Grade 4',
                   2006: 		     5 => 'Grade 5',
                   2007: 		     6 => 'Grade 6',
                   2008: 		     7 => 'Grade 7',
                   2009: 		     8 => 'Grade 8',
                   2010: 		     9 => 'Grade 9',
                   2011: 		     10 => 'Grade 10',
                   2012: 		     11 => 'Grade 11',
                   2013: 		     12 => 'Grade 12',
                   2014: 		     13 => 'Grade 13',
                   2015: 		     14 => '100 Level',
                   2016: 		     15 => '200 Level',
                   2017: 		     16 => '300 Level',
                   2018: 		     17 => '400 Level',
                   2019: 		     18 => 'Graduate Level');
                   2020:     return &mt($gradelevels{$gradelevel});
                   2021: }
                   2022: 
1.163     www      2023: sub select_level_form {
                   2024:     my ($deflevel,$name)=@_;
                   2025:     unless ($deflevel) { $deflevel=0; }
1.167     www      2026:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   2027:     for (my $i=0; $i<=18; $i++) {
                   2028:         $selectform.="<option value=\"$i\" ".
1.253     albertel 2029:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      2030:                 ">".&gradeleveldescription($i)."</option>\n";
                   2031:     }
                   2032:     $selectform.="</select>";
                   2033:     return $selectform;
1.163     www      2034: }
1.167     www      2035: 
1.35      matthew  2036: #-------------------------------------------
                   2037: 
1.45      matthew  2038: =pod
                   2039: 
1.910     raeburn  2040: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35      matthew  2041: 
                   2042: Returns a string containing a <select name='$name' size='1'> form to 
                   2043: allow a user to select the domain to preform an operation in.  
                   2044: See loncreateuser.pm for an example invocation and use.
                   2045: 
1.90      www      2046: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   2047: selected");
                   2048: 
1.743     raeburn  2049: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   2050: 
1.910     raeburn  2051: 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.
                   2052: 
                   2053: The optional $incdoms is a reference to an array of domains which will be the only available options. 
1.563     raeburn  2054: 
1.35      matthew  2055: =cut
                   2056: 
                   2057: #-------------------------------------------
1.34      matthew  2058: sub select_dom_form {
1.910     raeburn  2059:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872     raeburn  2060:     if ($onchange) {
1.874     raeburn  2061:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  2062:     }
1.910     raeburn  2063:     my @domains;
                   2064:     if (ref($incdoms) eq 'ARRAY') {
                   2065:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   2066:     } else {
                   2067:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   2068:     }
1.90      www      2069:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  2070:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 2071:     foreach my $dom (@domains) {
                   2072:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  2073:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   2074:         if ($showdomdesc) {
                   2075:             if ($dom ne '') {
                   2076:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   2077:                 if ($domdesc ne '') {
                   2078:                     $selectdomain .= ' ('.$domdesc.')';
                   2079:                 }
                   2080:             } 
                   2081:         }
                   2082:         $selectdomain .= "</option>\n";
1.34      matthew  2083:     }
                   2084:     $selectdomain.="</select>";
                   2085:     return $selectdomain;
                   2086: }
                   2087: 
1.35      matthew  2088: #-------------------------------------------
                   2089: 
1.45      matthew  2090: =pod
                   2091: 
1.648     raeburn  2092: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2093: 
1.586     raeburn  2094: input: 4 arguments (two required, two optional) - 
                   2095:     $domain - domain of new user
                   2096:     $name - name of form element
                   2097:     $default - Value of 'default' causes a default item to be first 
                   2098:                             option, and selected by default. 
                   2099:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2100:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2101: output: returns 2 items: 
1.586     raeburn  2102: (a) form element which contains either:
                   2103:    (i) <select name="$name">
                   2104:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2105:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2106:        </select>
                   2107:        form item if there are multiple library servers in $domain, or
                   2108:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2109:        if there is only one library server in $domain.
                   2110: 
                   2111: (b) number of library servers found.
                   2112: 
                   2113: See loncreateuser.pm for example of use.
1.35      matthew  2114: 
                   2115: =cut
                   2116: 
                   2117: #-------------------------------------------
1.586     raeburn  2118: sub home_server_form_item {
                   2119:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2120:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2121:     my $result;
                   2122:     my $numlib = keys(%servers);
                   2123:     if ($numlib > 1) {
                   2124:         $result .= '<select name="'.$name.'" />'."\n";
                   2125:         if ($default) {
1.804     bisitz   2126:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2127:                        '</option>'."\n";
                   2128:         }
                   2129:         foreach my $hostid (sort(keys(%servers))) {
                   2130:             $result.= '<option value="'.$hostid.'">'.
                   2131: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2132:         }
                   2133:         $result .= '</select>'."\n";
                   2134:     } elsif ($numlib == 1) {
                   2135:         my $hostid;
                   2136:         foreach my $item (keys(%servers)) {
                   2137:             $hostid = $item;
                   2138:         }
                   2139:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2140:                    $hostid.'" />';
                   2141:                    if (!$hide) {
                   2142:                        $result .= $hostid.' '.$servers{$hostid};
                   2143:                    }
                   2144:                    $result .= "\n";
                   2145:     } elsif ($default) {
                   2146:         $result .= '<input type="hidden" name="'.$name.
                   2147:                    '" value="default" />';
                   2148:                    if (!$hide) {
                   2149:                        $result .= &mt('default');
                   2150:                    }
                   2151:                    $result .= "\n";
1.33      matthew  2152:     }
1.586     raeburn  2153:     return ($result,$numlib);
1.33      matthew  2154: }
1.112     bowersj2 2155: 
                   2156: =pod
                   2157: 
1.534     albertel 2158: =back 
                   2159: 
1.112     bowersj2 2160: =cut
1.87      matthew  2161: 
                   2162: ###############################################################
1.112     bowersj2 2163: ##                  Decoding User Agent                      ##
1.87      matthew  2164: ###############################################################
                   2165: 
                   2166: =pod
                   2167: 
1.112     bowersj2 2168: =head1 Decoding the User Agent
                   2169: 
                   2170: =over 4
                   2171: 
                   2172: =item * &decode_user_agent()
1.87      matthew  2173: 
                   2174: Inputs: $r
                   2175: 
                   2176: Outputs:
                   2177: 
                   2178: =over 4
                   2179: 
1.112     bowersj2 2180: =item * $httpbrowser
1.87      matthew  2181: 
1.112     bowersj2 2182: =item * $clientbrowser
1.87      matthew  2183: 
1.112     bowersj2 2184: =item * $clientversion
1.87      matthew  2185: 
1.112     bowersj2 2186: =item * $clientmathml
1.87      matthew  2187: 
1.112     bowersj2 2188: =item * $clientunicode
1.87      matthew  2189: 
1.112     bowersj2 2190: =item * $clientos
1.87      matthew  2191: 
                   2192: =back
                   2193: 
1.157     matthew  2194: =back 
                   2195: 
1.87      matthew  2196: =cut
                   2197: 
                   2198: ###############################################################
                   2199: ###############################################################
                   2200: sub decode_user_agent {
1.247     albertel 2201:     my ($r)=@_;
1.87      matthew  2202:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2203:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2204:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2205:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2206:     my $clientbrowser='unknown';
                   2207:     my $clientversion='0';
                   2208:     my $clientmathml='';
                   2209:     my $clientunicode='0';
                   2210:     for (my $i=0;$i<=$#browsertype;$i++) {
                   2211:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   2212: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2213: 	    $clientbrowser=$bname;
                   2214:             $httpbrowser=~/$vreg/i;
                   2215: 	    $clientversion=$1;
                   2216:             $clientmathml=($clientversion>=$minv);
                   2217:             $clientunicode=($clientversion>=$univ);
                   2218: 	}
                   2219:     }
                   2220:     my $clientos='unknown';
                   2221:     if (($httpbrowser=~/linux/i) ||
                   2222:         ($httpbrowser=~/unix/i) ||
                   2223:         ($httpbrowser=~/ux/i) ||
                   2224:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2225:     if (($httpbrowser=~/vax/i) ||
                   2226:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2227:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2228:     if (($httpbrowser=~/mac/i) ||
                   2229:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   2230:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   2231:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   2232:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   2233:             $clientunicode,$clientos,);
                   2234: }
                   2235: 
1.32      matthew  2236: ###############################################################
                   2237: ##    Authentication changing form generation subroutines    ##
                   2238: ###############################################################
                   2239: ##
                   2240: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2241: ## hash, and have reasonable default values.
                   2242: ##
                   2243: ##    formname = the name given in the <form> tag.
1.35      matthew  2244: #-------------------------------------------
                   2245: 
1.45      matthew  2246: =pod
                   2247: 
1.112     bowersj2 2248: =head1 Authentication Routines
                   2249: 
                   2250: =over 4
                   2251: 
1.648     raeburn  2252: =item * &authform_xxxxxx()
1.35      matthew  2253: 
                   2254: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2255: handle some of the conveniences required for authentication forms.  
                   2256: This is not an optimal method, but it works.  
                   2257: 
                   2258: =over 4
                   2259: 
1.112     bowersj2 2260: =item * authform_header
1.35      matthew  2261: 
1.112     bowersj2 2262: =item * authform_authorwarning
1.35      matthew  2263: 
1.112     bowersj2 2264: =item * authform_nochange
1.35      matthew  2265: 
1.112     bowersj2 2266: =item * authform_kerberos
1.35      matthew  2267: 
1.112     bowersj2 2268: =item * authform_internal
1.35      matthew  2269: 
1.112     bowersj2 2270: =item * authform_filesystem
1.35      matthew  2271: 
                   2272: =back
                   2273: 
1.648     raeburn  2274: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2275: 
1.35      matthew  2276: =cut
                   2277: 
                   2278: #-------------------------------------------
1.32      matthew  2279: sub authform_header{  
                   2280:     my %in = (
                   2281:         formname => 'cu',
1.80      albertel 2282:         kerb_def_dom => '',
1.32      matthew  2283:         @_,
                   2284:     );
                   2285:     $in{'formname'} = 'document.' . $in{'formname'};
                   2286:     my $result='';
1.80      albertel 2287: 
                   2288: #---------------------------------------------- Code for upper case translation
                   2289:     my $Javascript_toUpperCase;
                   2290:     unless ($in{kerb_def_dom}) {
                   2291:         $Javascript_toUpperCase =<<"END";
                   2292:         switch (choice) {
                   2293:            case 'krb': currentform.elements[choicearg].value =
                   2294:                currentform.elements[choicearg].value.toUpperCase();
                   2295:                break;
                   2296:            default:
                   2297:         }
                   2298: END
                   2299:     } else {
                   2300:         $Javascript_toUpperCase = "";
                   2301:     }
                   2302: 
1.165     raeburn  2303:     my $radioval = "'nochange'";
1.591     raeburn  2304:     if (defined($in{'curr_authtype'})) {
                   2305:         if ($in{'curr_authtype'} ne '') {
                   2306:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2307:         }
1.174     matthew  2308:     }
1.165     raeburn  2309:     my $argfield = 'null';
1.591     raeburn  2310:     if (defined($in{'mode'})) {
1.165     raeburn  2311:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2312:             if (defined($in{'curr_autharg'})) {
                   2313:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2314:                     $argfield = "'$in{'curr_autharg'}'";
                   2315:                 }
                   2316:             }
                   2317:         }
                   2318:     }
                   2319: 
1.32      matthew  2320:     $result.=<<"END";
                   2321: var current = new Object();
1.165     raeburn  2322: current.radiovalue = $radioval;
                   2323: current.argfield = $argfield;
1.32      matthew  2324: 
                   2325: function changed_radio(choice,currentform) {
                   2326:     var choicearg = choice + 'arg';
                   2327:     // If a radio button in changed, we need to change the argfield
                   2328:     if (current.radiovalue != choice) {
                   2329:         current.radiovalue = choice;
                   2330:         if (current.argfield != null) {
                   2331:             currentform.elements[current.argfield].value = '';
                   2332:         }
                   2333:         if (choice == 'nochange') {
                   2334:             current.argfield = null;
                   2335:         } else {
                   2336:             current.argfield = choicearg;
                   2337:             switch(choice) {
                   2338:                 case 'krb': 
                   2339:                     currentform.elements[current.argfield].value = 
                   2340:                         "$in{'kerb_def_dom'}";
                   2341:                 break;
                   2342:               default:
                   2343:                 break;
                   2344:             }
                   2345:         }
                   2346:     }
                   2347:     return;
                   2348: }
1.22      www      2349: 
1.32      matthew  2350: function changed_text(choice,currentform) {
                   2351:     var choicearg = choice + 'arg';
                   2352:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2353:         $Javascript_toUpperCase
1.32      matthew  2354:         // clear old field
                   2355:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2356:             currentform.elements[current.argfield].value = '';
                   2357:         }
                   2358:         current.argfield = choicearg;
                   2359:     }
                   2360:     set_auth_radio_buttons(choice,currentform);
                   2361:     return;
1.20      www      2362: }
1.32      matthew  2363: 
                   2364: function set_auth_radio_buttons(newvalue,currentform) {
1.986     raeburn  2365:     var numauthchoices = currentform.login.length;
                   2366:     if (typeof numauthchoices  == "undefined") {
                   2367:         return;
                   2368:     } 
1.32      matthew  2369:     var i=0;
1.986     raeburn  2370:     while (i < numauthchoices) {
1.32      matthew  2371:         if (currentform.login[i].value == newvalue) { break; }
                   2372:         i++;
                   2373:     }
1.986     raeburn  2374:     if (i == numauthchoices) {
1.32      matthew  2375:         return;
                   2376:     }
                   2377:     current.radiovalue = newvalue;
                   2378:     currentform.login[i].checked = true;
                   2379:     return;
                   2380: }
                   2381: END
                   2382:     return $result;
                   2383: }
                   2384: 
                   2385: sub authform_authorwarning{
                   2386:     my $result='';
1.144     matthew  2387:     $result='<i>'.
                   2388:         &mt('As a general rule, only authors or co-authors should be '.
                   2389:             'filesystem authenticated '.
                   2390:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2391:     return $result;
                   2392: }
                   2393: 
                   2394: sub authform_nochange{  
                   2395:     my %in = (
                   2396:               formname => 'document.cu',
                   2397:               kerb_def_dom => 'MSU.EDU',
                   2398:               @_,
                   2399:           );
1.586     raeburn  2400:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2401:     my $result;
                   2402:     if (keys(%can_assign) == 0) {
                   2403:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2404:     } else {
                   2405:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2406:                   '<input type="radio" name="login" value="nochange" '.
                   2407:                   'checked="checked" onclick="'.
1.281     albertel 2408:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2409: 	    '</label>';
1.586     raeburn  2410:     }
1.32      matthew  2411:     return $result;
                   2412: }
                   2413: 
1.591     raeburn  2414: sub authform_kerberos {
1.32      matthew  2415:     my %in = (
                   2416:               formname => 'document.cu',
                   2417:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2418:               kerb_def_auth => 'krb4',
1.32      matthew  2419:               @_,
                   2420:               );
1.586     raeburn  2421:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2422:         $autharg,$jscall);
                   2423:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2424:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2425:        $check5 = ' checked="checked"';
1.80      albertel 2426:     } else {
1.772     bisitz   2427:        $check4 = ' checked="checked"';
1.80      albertel 2428:     }
1.165     raeburn  2429:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2430:     if (defined($in{'curr_authtype'})) {
                   2431:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2432:             $krbcheck = ' checked="checked"';
1.623     raeburn  2433:             if (defined($in{'mode'})) {
                   2434:                 if ($in{'mode'} eq 'modifyuser') {
                   2435:                     $krbcheck = '';
                   2436:                 }
                   2437:             }
1.591     raeburn  2438:             if (defined($in{'curr_kerb_ver'})) {
                   2439:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2440:                     $check5 = ' checked="checked"';
1.591     raeburn  2441:                     $check4 = '';
                   2442:                 } else {
1.772     bisitz   2443:                     $check4 = ' checked="checked"';
1.591     raeburn  2444:                     $check5 = '';
                   2445:                 }
1.586     raeburn  2446:             }
1.591     raeburn  2447:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2448:                 $krbarg = $in{'curr_autharg'};
                   2449:             }
1.586     raeburn  2450:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2451:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2452:                     $result = 
                   2453:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2454:         $in{'curr_autharg'},$krbver);
                   2455:                 } else {
                   2456:                     $result =
                   2457:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2458:                 }
                   2459:                 return $result; 
                   2460:             }
                   2461:         }
                   2462:     } else {
                   2463:         if ($authnum == 1) {
1.784     bisitz   2464:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2465:         }
                   2466:     }
1.586     raeburn  2467:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2468:         return;
1.587     raeburn  2469:     } elsif ($authtype eq '') {
1.591     raeburn  2470:         if (defined($in{'mode'})) {
1.587     raeburn  2471:             if ($in{'mode'} eq 'modifycourse') {
                   2472:                 if ($authnum == 1) {
1.784     bisitz   2473:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2474:                 }
                   2475:             }
                   2476:         }
1.586     raeburn  2477:     }
                   2478:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2479:     if ($authtype eq '') {
                   2480:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2481:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2482:                     $krbcheck.' />';
                   2483:     }
                   2484:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2485:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2486:          $in{'curr_authtype'} eq 'krb5') ||
                   2487:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2488:          $in{'curr_authtype'} eq 'krb4')) {
                   2489:         $result .= &mt
1.144     matthew  2490:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2491:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2492:          '<label>'.$authtype,
1.281     albertel 2493:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2494:              'value="'.$krbarg.'" '.
1.144     matthew  2495:              'onchange="'.$jscall.'" />',
1.281     albertel 2496:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2497:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2498: 	 '</label>');
1.586     raeburn  2499:     } elsif ($can_assign{'krb4'}) {
                   2500:         $result .= &mt
                   2501:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2502:          '[_3] Version 4 [_4]',
                   2503:          '<label>'.$authtype,
                   2504:          '</label><input type="text" size="10" name="krbarg" '.
                   2505:              'value="'.$krbarg.'" '.
                   2506:              'onchange="'.$jscall.'" />',
                   2507:          '<label><input type="hidden" name="krbver" value="4" />',
                   2508:          '</label>');
                   2509:     } elsif ($can_assign{'krb5'}) {
                   2510:         $result .= &mt
                   2511:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2512:          '[_3] Version 5 [_4]',
                   2513:          '<label>'.$authtype,
                   2514:          '</label><input type="text" size="10" name="krbarg" '.
                   2515:              'value="'.$krbarg.'" '.
                   2516:              'onchange="'.$jscall.'" />',
                   2517:          '<label><input type="hidden" name="krbver" value="5" />',
                   2518:          '</label>');
                   2519:     }
1.32      matthew  2520:     return $result;
                   2521: }
                   2522: 
                   2523: sub authform_internal{  
1.586     raeburn  2524:     my %in = (
1.32      matthew  2525:                 formname => 'document.cu',
                   2526:                 kerb_def_dom => 'MSU.EDU',
                   2527:                 @_,
                   2528:                 );
1.586     raeburn  2529:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2530:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2531:     if (defined($in{'curr_authtype'})) {
                   2532:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2533:             if ($can_assign{'int'}) {
1.772     bisitz   2534:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2535:                 if (defined($in{'mode'})) {
                   2536:                     if ($in{'mode'} eq 'modifyuser') {
                   2537:                         $intcheck = '';
                   2538:                     }
                   2539:                 }
1.591     raeburn  2540:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2541:                     $intarg = $in{'curr_autharg'};
                   2542:                 }
                   2543:             } else {
                   2544:                 $result = &mt('Currently internally authenticated.');
                   2545:                 return $result;
1.165     raeburn  2546:             }
                   2547:         }
1.586     raeburn  2548:     } else {
                   2549:         if ($authnum == 1) {
1.784     bisitz   2550:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2551:         }
                   2552:     }
                   2553:     if (!$can_assign{'int'}) {
                   2554:         return;
1.587     raeburn  2555:     } elsif ($authtype eq '') {
1.591     raeburn  2556:         if (defined($in{'mode'})) {
1.587     raeburn  2557:             if ($in{'mode'} eq 'modifycourse') {
                   2558:                 if ($authnum == 1) {
1.784     bisitz   2559:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2560:                 }
                   2561:             }
                   2562:         }
1.165     raeburn  2563:     }
1.586     raeburn  2564:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2565:     if ($authtype eq '') {
                   2566:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2567:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2568:     }
1.605     bisitz   2569:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2570:                $intarg.'" onchange="'.$jscall.'" />';
                   2571:     $result = &mt
1.144     matthew  2572:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2573:          '<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2574:     $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32      matthew  2575:     return $result;
                   2576: }
                   2577: 
                   2578: sub authform_local{  
                   2579:     my %in = (
                   2580:               formname => 'document.cu',
                   2581:               kerb_def_dom => 'MSU.EDU',
                   2582:               @_,
                   2583:               );
1.586     raeburn  2584:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2585:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2586:     if (defined($in{'curr_authtype'})) {
                   2587:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2588:             if ($can_assign{'loc'}) {
1.772     bisitz   2589:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2590:                 if (defined($in{'mode'})) {
                   2591:                     if ($in{'mode'} eq 'modifyuser') {
                   2592:                         $loccheck = '';
                   2593:                     }
                   2594:                 }
1.591     raeburn  2595:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2596:                     $locarg = $in{'curr_autharg'};
                   2597:                 }
                   2598:             } else {
                   2599:                 $result = &mt('Currently using local (institutional) authentication.');
                   2600:                 return $result;
1.165     raeburn  2601:             }
                   2602:         }
1.586     raeburn  2603:     } else {
                   2604:         if ($authnum == 1) {
1.784     bisitz   2605:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2606:         }
                   2607:     }
                   2608:     if (!$can_assign{'loc'}) {
                   2609:         return;
1.587     raeburn  2610:     } elsif ($authtype eq '') {
1.591     raeburn  2611:         if (defined($in{'mode'})) {
1.587     raeburn  2612:             if ($in{'mode'} eq 'modifycourse') {
                   2613:                 if ($authnum == 1) {
1.784     bisitz   2614:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2615:                 }
                   2616:             }
                   2617:         }
1.165     raeburn  2618:     }
1.586     raeburn  2619:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2620:     if ($authtype eq '') {
                   2621:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2622:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2623:                     $jscall.'" />';
                   2624:     }
                   2625:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2626:                $locarg.'" onchange="'.$jscall.'" />';
                   2627:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2628:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2629:     return $result;
                   2630: }
                   2631: 
                   2632: sub authform_filesystem{  
                   2633:     my %in = (
                   2634:               formname => 'document.cu',
                   2635:               kerb_def_dom => 'MSU.EDU',
                   2636:               @_,
                   2637:               );
1.586     raeburn  2638:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2639:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2640:     if (defined($in{'curr_authtype'})) {
                   2641:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2642:             if ($can_assign{'fsys'}) {
1.772     bisitz   2643:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2644:                 if (defined($in{'mode'})) {
                   2645:                     if ($in{'mode'} eq 'modifyuser') {
                   2646:                         $fsyscheck = '';
                   2647:                     }
                   2648:                 }
1.586     raeburn  2649:             } else {
                   2650:                 $result = &mt('Currently Filesystem Authenticated.');
                   2651:                 return $result;
                   2652:             }           
                   2653:         }
                   2654:     } else {
                   2655:         if ($authnum == 1) {
1.784     bisitz   2656:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2657:         }
                   2658:     }
                   2659:     if (!$can_assign{'fsys'}) {
                   2660:         return;
1.587     raeburn  2661:     } elsif ($authtype eq '') {
1.591     raeburn  2662:         if (defined($in{'mode'})) {
1.587     raeburn  2663:             if ($in{'mode'} eq 'modifycourse') {
                   2664:                 if ($authnum == 1) {
1.784     bisitz   2665:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2666:                 }
                   2667:             }
                   2668:         }
1.586     raeburn  2669:     }
                   2670:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2671:     if ($authtype eq '') {
                   2672:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2673:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2674:                     $jscall.'" />';
                   2675:     }
                   2676:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2677:                ' onchange="'.$jscall.'" />';
                   2678:     $result = &mt
1.144     matthew  2679:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2680:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2681:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2682:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2683:                   'onchange="'.$jscall.'" />');
1.32      matthew  2684:     return $result;
                   2685: }
                   2686: 
1.586     raeburn  2687: sub get_assignable_auth {
                   2688:     my ($dom) = @_;
                   2689:     if ($dom eq '') {
                   2690:         $dom = $env{'request.role.domain'};
                   2691:     }
                   2692:     my %can_assign = (
                   2693:                           krb4 => 1,
                   2694:                           krb5 => 1,
                   2695:                           int  => 1,
                   2696:                           loc  => 1,
                   2697:                      );
                   2698:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2699:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2700:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2701:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2702:             my $context;
                   2703:             if ($env{'request.role'} =~ /^au/) {
                   2704:                 $context = 'author';
                   2705:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2706:                 $context = 'domain';
                   2707:             } elsif ($env{'request.course.id'}) {
                   2708:                 $context = 'course';
                   2709:             }
                   2710:             if ($context) {
                   2711:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2712:                    %can_assign = %{$authhash->{$context}}; 
                   2713:                 }
                   2714:             }
                   2715:         }
                   2716:     }
                   2717:     my $authnum = 0;
                   2718:     foreach my $key (keys(%can_assign)) {
                   2719:         if ($can_assign{$key}) {
                   2720:             $authnum ++;
                   2721:         }
                   2722:     }
                   2723:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2724:         $authnum --;
                   2725:     }
                   2726:     return ($authnum,%can_assign);
                   2727: }
                   2728: 
1.80      albertel 2729: ###############################################################
                   2730: ##    Get Kerberos Defaults for Domain                 ##
                   2731: ###############################################################
                   2732: ##
                   2733: ## Returns default kerberos version and an associated argument
                   2734: ## as listed in file domain.tab. If not listed, provides
                   2735: ## appropriate default domain and kerberos version.
                   2736: ##
                   2737: #-------------------------------------------
                   2738: 
                   2739: =pod
                   2740: 
1.648     raeburn  2741: =item * &get_kerberos_defaults()
1.80      albertel 2742: 
                   2743: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2744: version and domain. If not found, it defaults to version 4 and the 
                   2745: domain of the server.
1.80      albertel 2746: 
1.648     raeburn  2747: =over 4
                   2748: 
1.80      albertel 2749: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2750: 
1.648     raeburn  2751: =back
                   2752: 
                   2753: =back
                   2754: 
1.80      albertel 2755: =cut
                   2756: 
                   2757: #-------------------------------------------
                   2758: sub get_kerberos_defaults {
                   2759:     my $domain=shift;
1.641     raeburn  2760:     my ($krbdef,$krbdefdom);
                   2761:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2762:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2763:         $krbdef = $domdefaults{'auth_def'};
                   2764:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2765:     } else {
1.80      albertel 2766:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2767:         my $krbdefdom=$1;
                   2768:         $krbdefdom=~tr/a-z/A-Z/;
                   2769:         $krbdef = "krb4";
                   2770:     }
                   2771:     return ($krbdef,$krbdefdom);
                   2772: }
1.112     bowersj2 2773: 
1.32      matthew  2774: 
1.46      matthew  2775: ###############################################################
                   2776: ##                Thesaurus Functions                        ##
                   2777: ###############################################################
1.20      www      2778: 
1.46      matthew  2779: =pod
1.20      www      2780: 
1.112     bowersj2 2781: =head1 Thesaurus Functions
                   2782: 
                   2783: =over 4
                   2784: 
1.648     raeburn  2785: =item * &initialize_keywords()
1.46      matthew  2786: 
                   2787: Initializes the package variable %Keywords if it is empty.  Uses the
                   2788: package variable $thesaurus_db_file.
                   2789: 
                   2790: =cut
                   2791: 
                   2792: ###################################################
                   2793: 
                   2794: sub initialize_keywords {
                   2795:     return 1 if (scalar keys(%Keywords));
                   2796:     # If we are here, %Keywords is empty, so fill it up
                   2797:     #   Make sure the file we need exists...
                   2798:     if (! -e $thesaurus_db_file) {
                   2799:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2800:                                  " failed because it does not exist");
                   2801:         return 0;
                   2802:     }
                   2803:     #   Set up the hash as a database
                   2804:     my %thesaurus_db;
                   2805:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2806:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2807:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2808:                                  $thesaurus_db_file);
                   2809:         return 0;
                   2810:     } 
                   2811:     #  Get the average number of appearances of a word.
                   2812:     my $avecount = $thesaurus_db{'average.count'};
                   2813:     #  Put keywords (those that appear > average) into %Keywords
                   2814:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2815:         my ($count,undef) = split /:/,$data;
                   2816:         $Keywords{$word}++ if ($count > $avecount);
                   2817:     }
                   2818:     untie %thesaurus_db;
                   2819:     # Remove special values from %Keywords.
1.356     albertel 2820:     foreach my $value ('total.count','average.count') {
                   2821:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2822:   }
1.46      matthew  2823:     return 1;
                   2824: }
                   2825: 
                   2826: ###################################################
                   2827: 
                   2828: =pod
                   2829: 
1.648     raeburn  2830: =item * &keyword($word)
1.46      matthew  2831: 
                   2832: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2833: than the average number of times in the thesaurus database.  Calls 
                   2834: &initialize_keywords
                   2835: 
                   2836: =cut
                   2837: 
                   2838: ###################################################
1.20      www      2839: 
                   2840: sub keyword {
1.46      matthew  2841:     return if (!&initialize_keywords());
                   2842:     my $word=lc(shift());
                   2843:     $word=~s/\W//g;
                   2844:     return exists($Keywords{$word});
1.20      www      2845: }
1.46      matthew  2846: 
                   2847: ###############################################################
                   2848: 
                   2849: =pod 
1.20      www      2850: 
1.648     raeburn  2851: =item * &get_related_words()
1.46      matthew  2852: 
1.160     matthew  2853: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2854: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2855: will be returned.  The order of the words returned is determined by the
                   2856: database which holds them.
                   2857: 
                   2858: Uses global $thesaurus_db_file.
                   2859: 
1.1057    foxr     2860: 
1.46      matthew  2861: =cut
                   2862: 
                   2863: ###############################################################
                   2864: sub get_related_words {
                   2865:     my $keyword = shift;
                   2866:     my %thesaurus_db;
                   2867:     if (! -e $thesaurus_db_file) {
                   2868:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2869:                                  "failed because the file does not exist");
                   2870:         return ();
                   2871:     }
                   2872:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2873:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2874:         return ();
                   2875:     } 
                   2876:     my @Words=();
1.429     www      2877:     my $count=0;
1.46      matthew  2878:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2879: 	# The first element is the number of times
                   2880: 	# the word appears.  We do not need it now.
1.429     www      2881: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2882: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2883: 	my $threshold=$mostfrequentcount/10;
                   2884:         foreach my $possibleword (@RelatedWords) {
                   2885:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2886:             if ($wordcount>$threshold) {
                   2887: 		push(@Words,$word);
                   2888:                 $count++;
                   2889:                 if ($count>10) { last; }
                   2890: 	    }
1.20      www      2891:         }
                   2892:     }
1.46      matthew  2893:     untie %thesaurus_db;
                   2894:     return @Words;
1.14      harris41 2895: }
1.46      matthew  2896: 
1.112     bowersj2 2897: =pod
                   2898: 
                   2899: =back
                   2900: 
                   2901: =cut
1.61      www      2902: 
                   2903: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2904: =pod
                   2905: 
1.112     bowersj2 2906: =head1 User Name Functions
                   2907: 
                   2908: =over 4
                   2909: 
1.648     raeburn  2910: =item * &plainname($uname,$udom,$first)
1.81      albertel 2911: 
1.112     bowersj2 2912: Takes a users logon name and returns it as a string in
1.226     albertel 2913: "first middle last generation" form 
                   2914: if $first is set to 'lastname' then it returns it as
                   2915: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2916: 
                   2917: =cut
1.61      www      2918: 
1.295     www      2919: 
1.81      albertel 2920: ###############################################################
1.61      www      2921: sub plainname {
1.226     albertel 2922:     my ($uname,$udom,$first)=@_;
1.537     albertel 2923:     return if (!defined($uname) || !defined($udom));
1.295     www      2924:     my %names=&getnames($uname,$udom);
1.226     albertel 2925:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2926: 					  $names{'middlename'},
                   2927: 					  $names{'lastname'},
                   2928: 					  $names{'generation'},$first);
                   2929:     $name=~s/^\s+//;
1.62      www      2930:     $name=~s/\s+$//;
                   2931:     $name=~s/\s+/ /g;
1.353     albertel 2932:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2933:     return $name;
1.61      www      2934: }
1.66      www      2935: 
                   2936: # -------------------------------------------------------------------- Nickname
1.81      albertel 2937: =pod
                   2938: 
1.648     raeburn  2939: =item * &nickname($uname,$udom)
1.81      albertel 2940: 
                   2941: Gets a users name and returns it as a string as
                   2942: 
                   2943: "&quot;nickname&quot;"
1.66      www      2944: 
1.81      albertel 2945: if the user has a nickname or
                   2946: 
                   2947: "first middle last generation"
                   2948: 
                   2949: if the user does not
                   2950: 
                   2951: =cut
1.66      www      2952: 
                   2953: sub nickname {
                   2954:     my ($uname,$udom)=@_;
1.537     albertel 2955:     return if (!defined($uname) || !defined($udom));
1.295     www      2956:     my %names=&getnames($uname,$udom);
1.68      albertel 2957:     my $name=$names{'nickname'};
1.66      www      2958:     if ($name) {
                   2959:        $name='&quot;'.$name.'&quot;'; 
                   2960:     } else {
                   2961:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2962: 	     $names{'lastname'}.' '.$names{'generation'};
                   2963:        $name=~s/\s+$//;
                   2964:        $name=~s/\s+/ /g;
                   2965:     }
                   2966:     return $name;
                   2967: }
                   2968: 
1.295     www      2969: sub getnames {
                   2970:     my ($uname,$udom)=@_;
1.537     albertel 2971:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2972:     if ($udom eq 'public' && $uname eq 'public') {
                   2973: 	return ('lastname' => &mt('Public'));
                   2974:     }
1.295     www      2975:     my $id=$uname.':'.$udom;
                   2976:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2977:     if ($cached) {
                   2978: 	return %{$names};
                   2979:     } else {
                   2980: 	my %loadnames=&Apache::lonnet::get('environment',
                   2981:                     ['firstname','middlename','lastname','generation','nickname'],
                   2982: 					 $udom,$uname);
                   2983: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2984: 	return %loadnames;
                   2985:     }
                   2986: }
1.61      www      2987: 
1.542     raeburn  2988: # -------------------------------------------------------------------- getemails
1.648     raeburn  2989: 
1.542     raeburn  2990: =pod
                   2991: 
1.648     raeburn  2992: =item * &getemails($uname,$udom)
1.542     raeburn  2993: 
                   2994: Gets a user's email information and returns it as a hash with keys:
                   2995: notification, critnotification, permanentemail
                   2996: 
                   2997: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2998: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2999:  
1.648     raeburn  3000: 
1.542     raeburn  3001: =cut
                   3002: 
1.648     raeburn  3003: 
1.466     albertel 3004: sub getemails {
                   3005:     my ($uname,$udom)=@_;
                   3006:     if ($udom eq 'public' && $uname eq 'public') {
                   3007: 	return;
                   3008:     }
1.467     www      3009:     if (!$udom) { $udom=$env{'user.domain'}; }
                   3010:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 3011:     my $id=$uname.':'.$udom;
                   3012:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   3013:     if ($cached) {
                   3014: 	return %{$names};
                   3015:     } else {
                   3016: 	my %loadnames=&Apache::lonnet::get('environment',
                   3017:                     			   ['notification','critnotification',
                   3018: 					    'permanentemail'],
                   3019: 					   $udom,$uname);
                   3020: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   3021: 	return %loadnames;
                   3022:     }
                   3023: }
                   3024: 
1.551     albertel 3025: sub flush_email_cache {
                   3026:     my ($uname,$udom)=@_;
                   3027:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3028:     if (!$uname) { $uname=$env{'user.name'};   }
                   3029:     return if ($udom eq 'public' && $uname eq 'public');
                   3030:     my $id=$uname.':'.$udom;
                   3031:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   3032: }
                   3033: 
1.728     raeburn  3034: # -------------------------------------------------------------------- getlangs
                   3035: 
                   3036: =pod
                   3037: 
                   3038: =item * &getlangs($uname,$udom)
                   3039: 
                   3040: Gets a user's language preference and returns it as a hash with key:
                   3041: language.
                   3042: 
                   3043: =cut
                   3044: 
                   3045: 
                   3046: sub getlangs {
                   3047:     my ($uname,$udom) = @_;
                   3048:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3049:     if (!$uname) { $uname=$env{'user.name'};   }
                   3050:     my $id=$uname.':'.$udom;
                   3051:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   3052:     if ($cached) {
                   3053:         return %{$langs};
                   3054:     } else {
                   3055:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   3056:                                            $udom,$uname);
                   3057:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   3058:         return %loadlangs;
                   3059:     }
                   3060: }
                   3061: 
                   3062: sub flush_langs_cache {
                   3063:     my ($uname,$udom)=@_;
                   3064:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3065:     if (!$uname) { $uname=$env{'user.name'};   }
                   3066:     return if ($udom eq 'public' && $uname eq 'public');
                   3067:     my $id=$uname.':'.$udom;
                   3068:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   3069: }
                   3070: 
1.61      www      3071: # ------------------------------------------------------------------ Screenname
1.81      albertel 3072: 
                   3073: =pod
                   3074: 
1.648     raeburn  3075: =item * &screenname($uname,$udom)
1.81      albertel 3076: 
                   3077: Gets a users screenname and returns it as a string
                   3078: 
                   3079: =cut
1.61      www      3080: 
                   3081: sub screenname {
                   3082:     my ($uname,$udom)=@_;
1.258     albertel 3083:     if ($uname eq $env{'user.name'} &&
                   3084: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 3085:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 3086:     return $names{'screenname'};
1.62      www      3087: }
                   3088: 
1.212     albertel 3089: 
1.802     bisitz   3090: # ------------------------------------------------------------- Confirm Wrapper
                   3091: =pod
                   3092: 
                   3093: =item confirmwrapper
                   3094: 
                   3095: Wrap messages about completion of operation in box
                   3096: 
                   3097: =cut
                   3098: 
                   3099: sub confirmwrapper {
                   3100:     my ($message)=@_;
                   3101:     if ($message) {
                   3102:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3103:                .$message."\n"
                   3104:                .'</div>'."\n";
                   3105:     } else {
                   3106:         return $message;
                   3107:     }
                   3108: }
                   3109: 
1.62      www      3110: # ------------------------------------------------------------- Message Wrapper
                   3111: 
                   3112: sub messagewrapper {
1.369     www      3113:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3114:     return 
1.441     albertel 3115:         '<a href="/adm/email?compose=individual&amp;'.
                   3116:         'recname='.$username.'&amp;recdom='.$domain.
                   3117: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3118:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3119: }
1.802     bisitz   3120: 
1.74      www      3121: # --------------------------------------------------------------- Notes Wrapper
                   3122: 
                   3123: sub noteswrapper {
                   3124:     my ($link,$un,$do)=@_;
                   3125:     return 
1.896     amueller 3126: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3127: }
1.802     bisitz   3128: 
1.62      www      3129: # ------------------------------------------------------------- Aboutme Wrapper
                   3130: 
                   3131: sub aboutmewrapper {
1.166     www      3132:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  3133:     if (!defined($username)  && !defined($domain)) {
                   3134:         return;
                   3135:     }
1.892     amueller 3136:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756     weissno  3137: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3138: }
                   3139: 
                   3140: # ------------------------------------------------------------ Syllabus Wrapper
                   3141: 
                   3142: sub syllabuswrapper {
1.707     bisitz   3143:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3144:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3145: }
1.14      harris41 3146: 
1.802     bisitz   3147: # -----------------------------------------------------------------------------
                   3148: 
1.208     matthew  3149: sub track_student_link {
1.887     raeburn  3150:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3151:     my $link ="/adm/trackstudent?";
1.208     matthew  3152:     my $title = 'View recent activity';
                   3153:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3154:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3155:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3156:         $title .= ' of this student';
1.268     albertel 3157:     } 
1.208     matthew  3158:     if (defined($target) && $target !~ /^\s*$/) {
                   3159:         $target = qq{target="$target"};
                   3160:     } else {
                   3161:         $target = '';
                   3162:     }
1.268     albertel 3163:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3164:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3165:     $title = &mt($title);
                   3166:     $linktext = &mt($linktext);
1.448     albertel 3167:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3168: 	&help_open_topic('View_recent_activity');
1.208     matthew  3169: }
                   3170: 
1.781     raeburn  3171: sub slot_reservations_link {
                   3172:     my ($linktext,$sname,$sdom,$target) = @_;
                   3173:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3174:     my $title = 'View slot reservation history';
                   3175:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3176:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3177:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3178:         $title .= ' of this student';
                   3179:     }
                   3180:     if (defined($target) && $target !~ /^\s*$/) {
                   3181:         $target = qq{target="$target"};
                   3182:     } else {
                   3183:         $target = '';
                   3184:     }
                   3185:     $title = &mt($title);
                   3186:     $linktext = &mt($linktext);
                   3187:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3188: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3189: 
                   3190: }
                   3191: 
1.508     www      3192: # ===================================================== Display a student photo
                   3193: 
                   3194: 
1.509     albertel 3195: sub student_image_tag {
1.508     www      3196:     my ($domain,$user)=@_;
                   3197:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3198:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3199: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3200:     } else {
                   3201: 	return '';
                   3202:     }
                   3203: }
                   3204: 
1.112     bowersj2 3205: =pod
                   3206: 
                   3207: =back
                   3208: 
                   3209: =head1 Access .tab File Data
                   3210: 
                   3211: =over 4
                   3212: 
1.648     raeburn  3213: =item * &languageids() 
1.112     bowersj2 3214: 
                   3215: returns list of all language ids
                   3216: 
                   3217: =cut
                   3218: 
1.14      harris41 3219: sub languageids {
1.16      harris41 3220:     return sort(keys(%language));
1.14      harris41 3221: }
                   3222: 
1.112     bowersj2 3223: =pod
                   3224: 
1.648     raeburn  3225: =item * &languagedescription() 
1.112     bowersj2 3226: 
                   3227: returns description of a specified language id
                   3228: 
                   3229: =cut
                   3230: 
1.14      harris41 3231: sub languagedescription {
1.125     www      3232:     my $code=shift;
                   3233:     return  ($supported_language{$code}?'* ':'').
                   3234:             $language{$code}.
1.126     www      3235: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3236: }
                   3237: 
1.1048    foxr     3238: =pod
                   3239: 
                   3240: =item * &plainlanguagedescription
                   3241: 
                   3242: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
                   3243: and the language character encoding (e.g. ISO) separated by a ' - ' string.
                   3244: 
                   3245: =cut
                   3246: 
1.145     www      3247: sub plainlanguagedescription {
                   3248:     my $code=shift;
                   3249:     return $language{$code};
                   3250: }
                   3251: 
1.1048    foxr     3252: =pod
                   3253: 
                   3254: =item * &supportedlanguagecode
                   3255: 
                   3256: Returns the supported language code (e.g. sptutf maps to pt) given a language
                   3257: code.
                   3258: 
                   3259: =cut
                   3260: 
1.145     www      3261: sub supportedlanguagecode {
                   3262:     my $code=shift;
                   3263:     return $supported_language{$code};
1.97      www      3264: }
                   3265: 
1.112     bowersj2 3266: =pod
                   3267: 
1.1048    foxr     3268: =item * &latexlanguage()
                   3269: 
                   3270: Given a language key code returns the correspondnig language to use
                   3271: to select the correct hyphenation on LaTeX printouts.  This is undef if there
                   3272: is no supported hyphenation for the language code.
                   3273: 
                   3274: =cut
                   3275: 
                   3276: sub latexlanguage {
                   3277:     my $code = shift;
                   3278:     return $latex_language{$code};
                   3279: }
                   3280: 
                   3281: =pod
                   3282: 
                   3283: =item * &latexhyphenation()
                   3284: 
                   3285: Same as above but what's supplied is the language as it might be stored
                   3286: in the metadata.
                   3287: 
                   3288: =cut
                   3289: 
                   3290: sub latexhyphenation {
                   3291:     my $key = shift;
                   3292:     return $latex_language_bykey{$key};
                   3293: }
                   3294: 
                   3295: =pod
                   3296: 
1.648     raeburn  3297: =item * &copyrightids() 
1.112     bowersj2 3298: 
                   3299: returns list of all copyrights
                   3300: 
                   3301: =cut
                   3302: 
                   3303: sub copyrightids {
                   3304:     return sort(keys(%cprtag));
                   3305: }
                   3306: 
                   3307: =pod
                   3308: 
1.648     raeburn  3309: =item * &copyrightdescription() 
1.112     bowersj2 3310: 
                   3311: returns description of a specified copyright id
                   3312: 
                   3313: =cut
                   3314: 
                   3315: sub copyrightdescription {
1.166     www      3316:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3317: }
1.197     matthew  3318: 
                   3319: =pod
                   3320: 
1.648     raeburn  3321: =item * &source_copyrightids() 
1.192     taceyjo1 3322: 
                   3323: returns list of all source copyrights
                   3324: 
                   3325: =cut
                   3326: 
                   3327: sub source_copyrightids {
                   3328:     return sort(keys(%scprtag));
                   3329: }
                   3330: 
                   3331: =pod
                   3332: 
1.648     raeburn  3333: =item * &source_copyrightdescription() 
1.192     taceyjo1 3334: 
                   3335: returns description of a specified source copyright id
                   3336: 
                   3337: =cut
                   3338: 
                   3339: sub source_copyrightdescription {
                   3340:     return &mt($scprtag{shift(@_)});
                   3341: }
1.112     bowersj2 3342: 
                   3343: =pod
                   3344: 
1.648     raeburn  3345: =item * &filecategories() 
1.112     bowersj2 3346: 
                   3347: returns list of all file categories
                   3348: 
                   3349: =cut
                   3350: 
                   3351: sub filecategories {
                   3352:     return sort(keys(%category_extensions));
                   3353: }
                   3354: 
                   3355: =pod
                   3356: 
1.648     raeburn  3357: =item * &filecategorytypes() 
1.112     bowersj2 3358: 
                   3359: returns list of file types belonging to a given file
                   3360: category
                   3361: 
                   3362: =cut
                   3363: 
                   3364: sub filecategorytypes {
1.356     albertel 3365:     my ($cat) = @_;
                   3366:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3367: }
                   3368: 
                   3369: =pod
                   3370: 
1.648     raeburn  3371: =item * &fileembstyle() 
1.112     bowersj2 3372: 
                   3373: returns embedding style for a specified file type
                   3374: 
                   3375: =cut
                   3376: 
                   3377: sub fileembstyle {
                   3378:     return $fe{lc(shift(@_))};
1.169     www      3379: }
                   3380: 
1.351     www      3381: sub filemimetype {
                   3382:     return $fm{lc(shift(@_))};
                   3383: }
                   3384: 
1.169     www      3385: 
                   3386: sub filecategoryselect {
                   3387:     my ($name,$value)=@_;
1.189     matthew  3388:     return &select_form($value,$name,
1.970     raeburn  3389:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112     bowersj2 3390: }
                   3391: 
                   3392: =pod
                   3393: 
1.648     raeburn  3394: =item * &filedescription() 
1.112     bowersj2 3395: 
                   3396: returns description for a specified file type
                   3397: 
                   3398: =cut
                   3399: 
                   3400: sub filedescription {
1.188     matthew  3401:     my $file_description = $fd{lc(shift())};
                   3402:     $file_description =~ s:([\[\]]):~$1:g;
                   3403:     return &mt($file_description);
1.112     bowersj2 3404: }
                   3405: 
                   3406: =pod
                   3407: 
1.648     raeburn  3408: =item * &filedescriptionex() 
1.112     bowersj2 3409: 
                   3410: returns description for a specified file type with
                   3411: extra formatting
                   3412: 
                   3413: =cut
                   3414: 
                   3415: sub filedescriptionex {
                   3416:     my $ex=shift;
1.188     matthew  3417:     my $file_description = $fd{lc($ex)};
                   3418:     $file_description =~ s:([\[\]]):~$1:g;
                   3419:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3420: }
                   3421: 
                   3422: # End of .tab access
                   3423: =pod
                   3424: 
                   3425: =back
                   3426: 
                   3427: =cut
                   3428: 
                   3429: # ------------------------------------------------------------------ File Types
                   3430: sub fileextensions {
                   3431:     return sort(keys(%fe));
                   3432: }
                   3433: 
1.97      www      3434: # ----------------------------------------------------------- Display Languages
                   3435: # returns a hash with all desired display languages
                   3436: #
                   3437: 
                   3438: sub display_languages {
                   3439:     my %languages=();
1.695     raeburn  3440:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3441: 	$languages{$lang}=1;
1.97      www      3442:     }
                   3443:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3444:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3445: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3446: 	    $languages{$lang}=1;
1.97      www      3447:         }
                   3448:     }
                   3449:     return %languages;
1.14      harris41 3450: }
                   3451: 
1.582     albertel 3452: sub languages {
                   3453:     my ($possible_langs) = @_;
1.695     raeburn  3454:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3455:     if (!ref($possible_langs)) {
                   3456: 	if( wantarray ) {
                   3457: 	    return @preferred_langs;
                   3458: 	} else {
                   3459: 	    return $preferred_langs[0];
                   3460: 	}
                   3461:     }
                   3462:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3463:     my @preferred_possibilities;
                   3464:     foreach my $preferred_lang (@preferred_langs) {
                   3465: 	if (exists($possibilities{$preferred_lang})) {
                   3466: 	    push(@preferred_possibilities, $preferred_lang);
                   3467: 	}
                   3468:     }
                   3469:     if( wantarray ) {
                   3470: 	return @preferred_possibilities;
                   3471:     }
                   3472:     return $preferred_possibilities[0];
                   3473: }
                   3474: 
1.742     raeburn  3475: sub user_lang {
                   3476:     my ($touname,$toudom,$fromcid) = @_;
                   3477:     my @userlangs;
                   3478:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3479:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3480:                     $env{'course.'.$fromcid.'.languages'}));
                   3481:     } else {
                   3482:         my %langhash = &getlangs($touname,$toudom);
                   3483:         if ($langhash{'languages'} ne '') {
                   3484:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3485:         } else {
                   3486:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3487:             if ($domdefs{'lang_def'} ne '') {
                   3488:                 @userlangs = ($domdefs{'lang_def'});
                   3489:             }
                   3490:         }
                   3491:     }
                   3492:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3493:     my $user_lh = Apache::localize->get_handle(@languages);
                   3494:     return $user_lh;
                   3495: }
                   3496: 
                   3497: 
1.112     bowersj2 3498: ###############################################################
                   3499: ##               Student Answer Attempts                     ##
                   3500: ###############################################################
                   3501: 
                   3502: =pod
                   3503: 
                   3504: =head1 Alternate Problem Views
                   3505: 
                   3506: =over 4
                   3507: 
1.648     raeburn  3508: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3509:     $getattempt, $regexp, $gradesub)
                   3510: 
                   3511: Return string with previous attempt on problem. Arguments:
                   3512: 
                   3513: =over 4
                   3514: 
                   3515: =item * $symb: Problem, including path
                   3516: 
                   3517: =item * $username: username of the desired student
                   3518: 
                   3519: =item * $domain: domain of the desired student
1.14      harris41 3520: 
1.112     bowersj2 3521: =item * $course: Course ID
1.14      harris41 3522: 
1.112     bowersj2 3523: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3524:     something
1.14      harris41 3525: 
1.112     bowersj2 3526: =item * $regexp: if string matches this regexp, the string will be
                   3527:     sent to $gradesub
1.14      harris41 3528: 
1.112     bowersj2 3529: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3530: 
1.112     bowersj2 3531: =back
1.14      harris41 3532: 
1.112     bowersj2 3533: The output string is a table containing all desired attempts, if any.
1.16      harris41 3534: 
1.112     bowersj2 3535: =cut
1.1       albertel 3536: 
                   3537: sub get_previous_attempt {
1.43      ng       3538:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3539:   my $prevattempts='';
1.43      ng       3540:   no strict 'refs';
1.1       albertel 3541:   if ($symb) {
1.3       albertel 3542:     my (%returnhash)=
                   3543:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3544:     if ($returnhash{'version'}) {
                   3545:       my %lasthash=();
                   3546:       my $version;
                   3547:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3548:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3549: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3550:         }
1.1       albertel 3551:       }
1.596     albertel 3552:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3553:       $prevattempts.='<th>'.&mt('History').'</th>';
1.978     raeburn  3554:       my (%typeparts,%lasthidden);
1.945     raeburn  3555:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 3556:       foreach my $key (sort(keys(%lasthash))) {
                   3557: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3558: 	if ($#parts > 0) {
1.31      albertel 3559: 	  my $data=$parts[-1];
1.989     raeburn  3560:           next if ($data eq 'foilorder');
1.31      albertel 3561: 	  pop(@parts);
1.1010    www      3562:           $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.945     raeburn  3563:           if ($data eq 'type') {
                   3564:               unless ($showsurv) {
                   3565:                   my $id = join(',',@parts);
                   3566:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978     raeburn  3567:                   if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                   3568:                       $lasthidden{$ign.'.'.$id} = 1;
                   3569:                   }
1.945     raeburn  3570:               }
1.1010    www      3571:           } 
1.31      albertel 3572: 	} else {
1.41      ng       3573: 	  if ($#parts == 0) {
                   3574: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3575: 	  } else {
                   3576: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3577: 	  }
1.31      albertel 3578: 	}
1.16      harris41 3579:       }
1.596     albertel 3580:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3581:       if ($getattempt eq '') {
                   3582: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945     raeburn  3583:             my @hidden;
                   3584:             if (%typeparts) {
                   3585:                 foreach my $id (keys(%typeparts)) {
                   3586:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
                   3587:                         push(@hidden,$id);
                   3588:                     }
                   3589:                 }
                   3590:             }
                   3591:             $prevattempts.=&start_data_table_row().
                   3592:                            '<td>'.&mt('Transaction [_1]',$version).'</td>';
                   3593:             if (@hidden) {
                   3594:                 foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  3595:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  3596:                     my $hide;
                   3597:                     foreach my $id (@hidden) {
                   3598:                         if ($key =~ /^\Q$id\E/) {
                   3599:                             $hide = 1;
                   3600:                             last;
                   3601:                         }
                   3602:                     }
                   3603:                     if ($hide) {
                   3604:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   3605:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   3606:                             my $value = &format_previous_attempt_value($key,
                   3607:                                              $returnhash{$version.':'.$key});
                   3608:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3609:                         } else {
                   3610:                             $prevattempts.='<td>&nbsp;</td>';
                   3611:                         }
                   3612:                     } else {
                   3613:                         if ($key =~ /\./) {
                   3614:                             my $value = &format_previous_attempt_value($key,
                   3615:                                               $returnhash{$version.':'.$key});
                   3616:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3617:                         } else {
                   3618:                             $prevattempts.='<td>&nbsp;</td>';
                   3619:                         }
                   3620:                     }
                   3621:                 }
                   3622:             } else {
                   3623: 	        foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  3624:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  3625: 		    my $value = &format_previous_attempt_value($key,
                   3626: 			            $returnhash{$version.':'.$key});
                   3627: 		    $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3628: 	        }
                   3629:             }
                   3630: 	    $prevattempts.=&end_data_table_row();
1.40      ng       3631: 	 }
1.1       albertel 3632:       }
1.945     raeburn  3633:       my @currhidden = keys(%lasthidden);
1.596     albertel 3634:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3635:       foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  3636:           next if ($key =~ /\.foilorder$/);
1.945     raeburn  3637:           if (%typeparts) {
                   3638:               my $hidden;
                   3639:               foreach my $id (@currhidden) {
                   3640:                   if ($key =~ /^\Q$id\E/) {
                   3641:                       $hidden = 1;
                   3642:                       last;
                   3643:                   }
                   3644:               }
                   3645:               if ($hidden) {
                   3646:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   3647:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   3648:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3649:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3650:                           $value = &$gradesub($value);
                   3651:                       }
                   3652:                       $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3653:                   } else {
                   3654:                       $prevattempts.='<td>&nbsp;</td>';
                   3655:                   }
                   3656:               } else {
                   3657:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3658:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3659:                       $value = &$gradesub($value);
                   3660:                   }
                   3661:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3662:               }
                   3663:           } else {
                   3664: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3665: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3666:                   $value = &$gradesub($value);
                   3667:               }
                   3668: 	      $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3669:           }
1.16      harris41 3670:       }
1.596     albertel 3671:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3672:     } else {
1.596     albertel 3673:       $prevattempts=
                   3674: 	  &start_data_table().&start_data_table_row().
                   3675: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3676: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3677:     }
                   3678:   } else {
1.596     albertel 3679:     $prevattempts=
                   3680: 	  &start_data_table().&start_data_table_row().
                   3681: 	  '<td>'.&mt('No data.').'</td>'.
                   3682: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3683:   }
1.10      albertel 3684: }
                   3685: 
1.581     albertel 3686: sub format_previous_attempt_value {
                   3687:     my ($key,$value) = @_;
1.1011    www      3688:     if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581     albertel 3689: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3690:     } elsif (ref($value) eq 'ARRAY') {
                   3691: 	$value = '('.join(', ', @{ $value }).')';
1.988     raeburn  3692:     } elsif ($key =~ /answerstring$/) {
                   3693:         my %answers = &Apache::lonnet::str2hash($value);
                   3694:         my @anskeys = sort(keys(%answers));
                   3695:         if (@anskeys == 1) {
                   3696:             my $answer = $answers{$anskeys[0]};
1.1001    raeburn  3697:             if ($answer =~ m{\0}) {
                   3698:                 $answer =~ s{\0}{,}g;
1.988     raeburn  3699:             }
                   3700:             my $tag_internal_answer_name = 'INTERNAL';
                   3701:             if ($anskeys[0] eq $tag_internal_answer_name) {
                   3702:                 $value = $answer; 
                   3703:             } else {
                   3704:                 $value = $anskeys[0].'='.$answer;
                   3705:             }
                   3706:         } else {
                   3707:             foreach my $ans (@anskeys) {
                   3708:                 my $answer = $answers{$ans};
1.1001    raeburn  3709:                 if ($answer =~ m{\0}) {
                   3710:                     $answer =~ s{\0}{,}g;
1.988     raeburn  3711:                 }
                   3712:                 $value .=  $ans.'='.$answer.'<br />';;
                   3713:             } 
                   3714:         }
1.581     albertel 3715:     } else {
                   3716: 	$value = &unescape($value);
                   3717:     }
                   3718:     return $value;
                   3719: }
                   3720: 
                   3721: 
1.107     albertel 3722: sub relative_to_absolute {
                   3723:     my ($url,$output)=@_;
                   3724:     my $parser=HTML::TokeParser->new(\$output);
                   3725:     my $token;
                   3726:     my $thisdir=$url;
                   3727:     my @rlinks=();
                   3728:     while ($token=$parser->get_token) {
                   3729: 	if ($token->[0] eq 'S') {
                   3730: 	    if ($token->[1] eq 'a') {
                   3731: 		if ($token->[2]->{'href'}) {
                   3732: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3733: 		}
                   3734: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3735: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3736: 	    } elsif ($token->[1] eq 'base') {
                   3737: 		$thisdir=$token->[2]->{'href'};
                   3738: 	    }
                   3739: 	}
                   3740:     }
                   3741:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3742:     foreach my $link (@rlinks) {
1.726     raeburn  3743: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3744: 		($link=~/^\//) ||
                   3745: 		($link=~/^javascript:/i) ||
                   3746: 		($link=~/^mailto:/i) ||
                   3747: 		($link=~/^\#/)) {
                   3748: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3749: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3750: 	}
                   3751:     }
                   3752: # -------------------------------------------------- Deal with Applet codebases
                   3753:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3754:     return $output;
                   3755: }
                   3756: 
1.112     bowersj2 3757: =pod
                   3758: 
1.648     raeburn  3759: =item * &get_student_view()
1.112     bowersj2 3760: 
                   3761: show a snapshot of what student was looking at
                   3762: 
                   3763: =cut
                   3764: 
1.10      albertel 3765: sub get_student_view {
1.186     albertel 3766:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3767:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3768:   my (%form);
1.10      albertel 3769:   my @elements=('symb','courseid','domain','username');
                   3770:   foreach my $element (@elements) {
1.186     albertel 3771:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3772:   }
1.186     albertel 3773:   if (defined($moreenv)) {
                   3774:       %form=(%form,%{$moreenv});
                   3775:   }
1.236     albertel 3776:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3777:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3778:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3779:   $userview=~s/\<body[^\>]*\>//gi;
                   3780:   $userview=~s/\<\/body\>//gi;
                   3781:   $userview=~s/\<html\>//gi;
                   3782:   $userview=~s/\<\/html\>//gi;
                   3783:   $userview=~s/\<head\>//gi;
                   3784:   $userview=~s/\<\/head\>//gi;
                   3785:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3786:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3787:   if (wantarray) {
                   3788:      return ($userview,$response);
                   3789:   } else {
                   3790:      return $userview;
                   3791:   }
                   3792: }
                   3793: 
                   3794: sub get_student_view_with_retries {
                   3795:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3796: 
                   3797:     my $ok = 0;                 # True if we got a good response.
                   3798:     my $content;
                   3799:     my $response;
                   3800: 
                   3801:     # Try to get the student_view done. within the retries count:
                   3802:     
                   3803:     do {
                   3804:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3805:          $ok      = $response->is_success;
                   3806:          if (!$ok) {
                   3807:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3808:          }
                   3809:          $retries--;
                   3810:     } while (!$ok && ($retries > 0));
                   3811:     
                   3812:     if (!$ok) {
                   3813:        $content = '';          # On error return an empty content.
                   3814:     }
1.651     www      3815:     if (wantarray) {
                   3816:        return ($content, $response);
                   3817:     } else {
                   3818:        return $content;
                   3819:     }
1.11      albertel 3820: }
                   3821: 
1.112     bowersj2 3822: =pod
                   3823: 
1.648     raeburn  3824: =item * &get_student_answers() 
1.112     bowersj2 3825: 
                   3826: show a snapshot of how student was answering problem
                   3827: 
                   3828: =cut
                   3829: 
1.11      albertel 3830: sub get_student_answers {
1.100     sakharuk 3831:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3832:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3833:   my (%moreenv);
1.11      albertel 3834:   my @elements=('symb','courseid','domain','username');
                   3835:   foreach my $element (@elements) {
1.186     albertel 3836:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3837:   }
1.186     albertel 3838:   $moreenv{'grade_target'}='answer';
                   3839:   %moreenv=(%form,%moreenv);
1.497     raeburn  3840:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3841:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3842:   return $userview;
1.1       albertel 3843: }
1.116     albertel 3844: 
                   3845: =pod
                   3846: 
                   3847: =item * &submlink()
                   3848: 
1.242     albertel 3849: Inputs: $text $uname $udom $symb $target
1.116     albertel 3850: 
                   3851: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3852: 
                   3853: =cut
                   3854: 
                   3855: ###############################################
                   3856: sub submlink {
1.242     albertel 3857:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3858:     if (!($uname && $udom)) {
                   3859: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3860: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3861: 	if (!$symb) { $symb=$cursymb; }
                   3862:     }
1.254     matthew  3863:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3864:     $symb=&escape($symb);
1.960     bisitz   3865:     if ($target) { $target=" target=\"$target\""; }
                   3866:     return
                   3867:         '<a href="/adm/grades?command=submission'.
                   3868:         '&amp;symb='.$symb.
                   3869:         '&amp;student='.$uname.
                   3870:         '&amp;userdom='.$udom.'"'.
                   3871:         $target.'>'.$text.'</a>';
1.242     albertel 3872: }
                   3873: ##############################################
                   3874: 
                   3875: =pod
                   3876: 
                   3877: =item * &pgrdlink()
                   3878: 
                   3879: Inputs: $text $uname $udom $symb $target
                   3880: 
                   3881: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3882: 
                   3883: =cut
                   3884: 
                   3885: ###############################################
                   3886: sub pgrdlink {
                   3887:     my $link=&submlink(@_);
                   3888:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3889:     return $link;
                   3890: }
                   3891: ##############################################
                   3892: 
                   3893: =pod
                   3894: 
                   3895: =item * &pprmlink()
                   3896: 
                   3897: Inputs: $text $uname $udom $symb $target
                   3898: 
                   3899: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3900: student and a specific resource
1.242     albertel 3901: 
                   3902: =cut
                   3903: 
                   3904: ###############################################
                   3905: sub pprmlink {
                   3906:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3907:     if (!($uname && $udom)) {
                   3908: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3909: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3910: 	if (!$symb) { $symb=$cursymb; }
                   3911:     }
1.254     matthew  3912:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3913:     $symb=&escape($symb);
1.242     albertel 3914:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3915:     return '<a href="/adm/parmset?command=set&amp;'.
                   3916: 	'symb='.$symb.'&amp;uname='.$uname.
                   3917: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3918: }
                   3919: ##############################################
1.37      matthew  3920: 
1.112     bowersj2 3921: =pod
                   3922: 
                   3923: =back
                   3924: 
                   3925: =cut
                   3926: 
1.37      matthew  3927: ###############################################
1.51      www      3928: 
                   3929: 
                   3930: sub timehash {
1.687     raeburn  3931:     my ($thistime) = @_;
                   3932:     my $timezone = &Apache::lonlocal::gettimezone();
                   3933:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3934:                      ->set_time_zone($timezone);
                   3935:     my $wday = $dt->day_of_week();
                   3936:     if ($wday == 7) { $wday = 0; }
                   3937:     return ( 'second' => $dt->second(),
                   3938:              'minute' => $dt->minute(),
                   3939:              'hour'   => $dt->hour(),
                   3940:              'day'     => $dt->day_of_month(),
                   3941:              'month'   => $dt->month(),
                   3942:              'year'    => $dt->year(),
                   3943:              'weekday' => $wday,
                   3944:              'dayyear' => $dt->day_of_year(),
                   3945:              'dlsav'   => $dt->is_dst() );
1.51      www      3946: }
                   3947: 
1.370     www      3948: sub utc_string {
                   3949:     my ($date)=@_;
1.371     www      3950:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3951: }
                   3952: 
1.51      www      3953: sub maketime {
                   3954:     my %th=@_;
1.687     raeburn  3955:     my ($epoch_time,$timezone,$dt);
                   3956:     $timezone = &Apache::lonlocal::gettimezone();
                   3957:     eval {
                   3958:         $dt = DateTime->new( year   => $th{'year'},
                   3959:                              month  => $th{'month'},
                   3960:                              day    => $th{'day'},
                   3961:                              hour   => $th{'hour'},
                   3962:                              minute => $th{'minute'},
                   3963:                              second => $th{'second'},
                   3964:                              time_zone => $timezone,
                   3965:                          );
                   3966:     };
                   3967:     if (!$@) {
                   3968:         $epoch_time = $dt->epoch;
                   3969:         if ($epoch_time) {
                   3970:             return $epoch_time;
                   3971:         }
                   3972:     }
1.51      www      3973:     return POSIX::mktime(
                   3974:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3975:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3976: }
                   3977: 
                   3978: #########################################
1.51      www      3979: 
                   3980: sub findallcourses {
1.482     raeburn  3981:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3982:     my %roles;
                   3983:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3984:     my %courses;
1.51      www      3985:     my $now=time;
1.482     raeburn  3986:     if (!defined($uname)) {
                   3987:         $uname = $env{'user.name'};
                   3988:     }
                   3989:     if (!defined($udom)) {
                   3990:         $udom = $env{'user.domain'};
                   3991:     }
                   3992:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.982     raeburn  3993:         my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
                   3994:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,
                   3995:                                               $extra);
1.482     raeburn  3996:         if (!%roles) {
                   3997:             %roles = (
                   3998:                        cc => 1,
1.907     raeburn  3999:                        co => 1,
1.482     raeburn  4000:                        in => 1,
                   4001:                        ep => 1,
                   4002:                        ta => 1,
                   4003:                        cr => 1,
                   4004:                        st => 1,
                   4005:              );
                   4006:         }
                   4007:         foreach my $entry (keys(%roleshash)) {
                   4008:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   4009:             if ($trole =~ /^cr/) { 
                   4010:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   4011:             } else {
                   4012:                 next if (!exists($roles{$trole}));
                   4013:             }
                   4014:             if ($tend) {
                   4015:                 next if ($tend < $now);
                   4016:             }
                   4017:             if ($tstart) {
                   4018:                 next if ($tstart > $now);
                   4019:             }
1.1058    raeburn  4020:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482     raeburn  4021:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058    raeburn  4022:             my $value = $trole.'/'.$cdom.'/';
1.482     raeburn  4023:             if ($secpart eq '') {
                   4024:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   4025:                 $sec = 'none';
1.1058    raeburn  4026:                 $value .= $cnum.'/';
1.482     raeburn  4027:             } else {
                   4028:                 $cnum = $cnumpart;
                   4029:                 ($sec,$role) = split(/_/,$secpart);
1.1058    raeburn  4030:                 $value .= $cnum.'/'.$sec;
                   4031:             }
                   4032:             if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4033:                 unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4034:                     push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4035:                 }
                   4036:             } else {
                   4037:                 @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490     raeburn  4038:             }
1.482     raeburn  4039:         }
                   4040:     } else {
                   4041:         foreach my $key (keys(%env)) {
1.483     albertel 4042: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   4043:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  4044: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   4045: 	        next if ($role eq 'ca' || $role eq 'aa');
                   4046: 	        next if (%roles && !exists($roles{$role}));
                   4047: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   4048:                 my $active=1;
                   4049:                 if ($starttime) {
                   4050: 		    if ($now<$starttime) { $active=0; }
                   4051:                 }
                   4052:                 if ($endtime) {
                   4053:                     if ($now>$endtime) { $active=0; }
                   4054:                 }
                   4055:                 if ($active) {
1.1058    raeburn  4056:                     my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482     raeburn  4057:                     if ($sec eq '') {
                   4058:                         $sec = 'none';
1.1058    raeburn  4059:                     } else {
                   4060:                         $value .= $sec;
                   4061:                     }
                   4062:                     if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4063:                         unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4064:                             push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4065:                         }
                   4066:                     } else {
                   4067:                         @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482     raeburn  4068:                     }
1.474     raeburn  4069:                 }
                   4070:             }
1.51      www      4071:         }
                   4072:     }
1.474     raeburn  4073:     return %courses;
1.51      www      4074: }
1.37      matthew  4075: 
1.54      www      4076: ###############################################
1.474     raeburn  4077: 
                   4078: sub blockcheck {
1.1062  ! raeburn  4079:     my ($setters,$activity,$uname,$udom,$url) = @_;
1.490     raeburn  4080: 
                   4081:     if (!defined($udom)) {
                   4082:         $udom = $env{'user.domain'};
                   4083:     }
                   4084:     if (!defined($uname)) {
                   4085:         $uname = $env{'user.name'};
                   4086:     }
                   4087: 
                   4088:     # If uname and udom are for a course, check for blocks in the course.
                   4089: 
                   4090:     if (&Apache::lonnet::is_course($udom,$uname)) {
1.1062  ! raeburn  4091:         my ($startblock,$endblock,$triggerblock) = 
        !          4092:             &get_blocks($setters,$activity,$udom,$uname,$url);
        !          4093:         return ($startblock,$endblock,$triggerblock);
1.490     raeburn  4094:     }
1.474     raeburn  4095: 
1.502     raeburn  4096:     my $startblock = 0;
                   4097:     my $endblock = 0;
1.1062  ! raeburn  4098:     my $triggerblock = '';
1.482     raeburn  4099:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  4100: 
1.490     raeburn  4101:     # If uname is for a user, and activity is course-specific, i.e.,
                   4102:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  4103: 
1.490     raeburn  4104:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   4105:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   4106:         foreach my $key (keys(%live_courses)) {
                   4107:             if ($key ne $env{'request.course.id'}) {
                   4108:                 delete($live_courses{$key});
                   4109:             }
                   4110:         }
                   4111:     }
                   4112: 
                   4113:     my $otheruser = 0;
                   4114:     my %own_courses;
                   4115:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   4116:         # Resource belongs to user other than current user.
                   4117:         $otheruser = 1;
                   4118:         # Gather courses for current user
                   4119:         %own_courses = 
                   4120:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   4121:     }
                   4122: 
                   4123:     # Gather active course roles - course coordinator, instructor, 
                   4124:     # exam proctor, ta, student, or custom role.
1.474     raeburn  4125: 
                   4126:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  4127:         my ($cdom,$cnum);
                   4128:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   4129:             $cdom = $env{'course.'.$course.'.domain'};
                   4130:             $cnum = $env{'course.'.$course.'.num'};
                   4131:         } else {
1.490     raeburn  4132:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  4133:         }
                   4134:         my $no_ownblock = 0;
                   4135:         my $no_userblock = 0;
1.533     raeburn  4136:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  4137:             # Check if current user has 'evb' priv for this
                   4138:             if (defined($own_courses{$course})) {
                   4139:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   4140:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   4141:                     if ($sec ne 'none') {
                   4142:                         $checkrole .= '/'.$sec;
                   4143:                     }
                   4144:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4145:                         $no_ownblock = 1;
                   4146:                         last;
                   4147:                     }
                   4148:                 }
                   4149:             }
                   4150:             # if they have 'evb' priv and are currently not playing student
                   4151:             next if (($no_ownblock) &&
                   4152:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   4153:         }
1.474     raeburn  4154:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  4155:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  4156:             if ($sec ne 'none') {
1.482     raeburn  4157:                 $checkrole .= '/'.$sec;
1.474     raeburn  4158:             }
1.490     raeburn  4159:             if ($otheruser) {
                   4160:                 # Resource belongs to user other than current user.
                   4161:                 # Assemble privs for that user, and check for 'evb' priv.
1.1058    raeburn  4162:                 my (%allroles,%userroles);
                   4163:                 if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
                   4164:                     foreach my $entry (@{$live_courses{$course}{$sec}}) { 
                   4165:                         my ($trole,$tdom,$tnum,$tsec);
                   4166:                         if ($entry =~ /^cr/) {
                   4167:                             ($trole,$tdom,$tnum,$tsec) = 
                   4168:                                 ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   4169:                         } else {
                   4170:                            ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   4171:                         }
                   4172:                         my ($spec,$area,$trest);
                   4173:                         $area = '/'.$tdom.'/'.$tnum;
                   4174:                         $trest = $tnum;
                   4175:                         if ($tsec ne '') {
                   4176:                             $area .= '/'.$tsec;
                   4177:                             $trest .= '/'.$tsec;
                   4178:                         }
                   4179:                         $spec = $trole.'.'.$area;
                   4180:                         if ($trole =~ /^cr/) {
                   4181:                             &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   4182:                                                               $tdom,$spec,$trest,$area);
                   4183:                         } else {
                   4184:                             &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   4185:                                                                 $tdom,$spec,$trest,$area);
                   4186:                         }
                   4187:                     }
                   4188:                     my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
                   4189:                     if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   4190:                         if ($1) {
                   4191:                             $no_userblock = 1;
                   4192:                             last;
                   4193:                         }
1.486     raeburn  4194:                     }
                   4195:                 }
1.490     raeburn  4196:             } else {
                   4197:                 # Resource belongs to current user
                   4198:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  4199:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4200:                     $no_ownblock = 1;
                   4201:                     last;
                   4202:                 }
1.474     raeburn  4203:             }
                   4204:         }
                   4205:         # if they have the evb priv and are currently not playing student
1.482     raeburn  4206:         next if (($no_ownblock) &&
1.491     albertel 4207:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  4208:         next if ($no_userblock);
1.474     raeburn  4209: 
1.866     kalberla 4210:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  4211:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  4212:         
1.1062  ! raeburn  4213:         my ($start,$end,$trigger) = 
        !          4214:             &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502     raeburn  4215:         if (($start != 0) && 
                   4216:             (($startblock == 0) || ($startblock > $start))) {
                   4217:             $startblock = $start;
1.1062  ! raeburn  4218:             if ($trigger ne '') {
        !          4219:                 $triggerblock = $trigger;
        !          4220:             }
1.502     raeburn  4221:         }
                   4222:         if (($end != 0)  &&
                   4223:             (($endblock == 0) || ($endblock < $end))) {
                   4224:             $endblock = $end;
1.1062  ! raeburn  4225:             if ($trigger ne '') {
        !          4226:                 $triggerblock = $trigger;
        !          4227:             }
1.502     raeburn  4228:         }
1.490     raeburn  4229:     }
1.1062  ! raeburn  4230:     return ($startblock,$endblock,$triggerblock);
1.490     raeburn  4231: }
                   4232: 
                   4233: sub get_blocks {
1.1062  ! raeburn  4234:     my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490     raeburn  4235:     my $startblock = 0;
                   4236:     my $endblock = 0;
1.1062  ! raeburn  4237:     my $triggerblock = '';
1.490     raeburn  4238:     my $course = $cdom.'_'.$cnum;
                   4239:     $setters->{$course} = {};
                   4240:     $setters->{$course}{'staff'} = [];
                   4241:     $setters->{$course}{'times'} = [];
1.1062  ! raeburn  4242:     $setters->{$course}{'triggers'} = [];
        !          4243:     my (@blockers,%triggered);
        !          4244:     my $now = time;
        !          4245:     my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
        !          4246:     if ($activity eq 'docs') {
        !          4247:         @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
        !          4248:         foreach my $block (@blockers) {
        !          4249:             if ($block =~ /^firstaccess____(.+)$/) {
        !          4250:                 my $item = $1;
        !          4251:                 my $type = 'map';
        !          4252:                 my $timersymb = $item;
        !          4253:                 if ($item eq 'course') {
        !          4254:                     $type = 'course';
        !          4255:                 } elsif ($item =~ /___\d+___/) {
        !          4256:                     $type = 'resource';
        !          4257:                 } else {
        !          4258:                     $timersymb = &Apache::lonnet::symbread($item);
        !          4259:                 }
        !          4260:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
        !          4261:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
        !          4262:                 $triggered{$block} = {
        !          4263:                                        start => $start,
        !          4264:                                        end   => $end,
        !          4265:                                        type  => $type,
        !          4266:                                      };
        !          4267:             }
        !          4268:         }
        !          4269:     } else {
        !          4270:         foreach my $block (keys(%commblocks)) {
        !          4271:             if ($block =~ m/^(\d+)____(\d+)$/) { 
        !          4272:                 my ($start,$end) = ($1,$2);
        !          4273:                 if ($start <= time && $end >= time) {
        !          4274:                     if (ref($commblocks{$block}) eq 'HASH') {
        !          4275:                         if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
        !          4276:                             if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
        !          4277:                                 unless(grep(/^\Q$block\E$/,@blockers)) {
        !          4278:                                     push(@blockers,$block);
        !          4279:                                 }
        !          4280:                             }
        !          4281:                         }
        !          4282:                     }
        !          4283:                 }
        !          4284:             } elsif ($block =~ /^firstaccess____(.+)$/) {
        !          4285:                 my $item = $1;
        !          4286:                 my $timersymb = $item; 
        !          4287:                 my $type = 'map';
        !          4288:                 if ($item eq 'course') {
        !          4289:                     $type = 'course';
        !          4290:                 } elsif ($item =~ /___\d+___/) {
        !          4291:                     $type = 'resource';
        !          4292:                 } else {
        !          4293:                     $timersymb = &Apache::lonnet::symbread($item);
        !          4294:                 }
        !          4295:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
        !          4296:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb}; 
        !          4297:                 if ($start && $end) {
        !          4298:                     if (($start <= time) && ($end >= time)) {
        !          4299:                         unless (grep(/^\Q$block\E$/,@blockers)) {
        !          4300:                             push(@blockers,$block);
        !          4301:                             $triggered{$block} = {
        !          4302:                                                    start => $start,
        !          4303:                                                    end   => $end,
        !          4304:                                                    type  => $type,
        !          4305:                                                  };
        !          4306:                         }
        !          4307:                     }
1.490     raeburn  4308:                 }
1.1062  ! raeburn  4309:             }
        !          4310:         }
        !          4311:     }
        !          4312:     foreach my $blocker (@blockers) {
        !          4313:         my ($staff_name,$staff_dom,$title,$blocks) =
        !          4314:             &parse_block_record($commblocks{$blocker});
        !          4315:         push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
        !          4316:         my ($start,$end,$triggertype);
        !          4317:         if ($blocker =~ m/^(\d+)____(\d+)$/) {
        !          4318:             ($start,$end) = ($1,$2);
        !          4319:         } elsif (ref($triggered{$blocker}) eq 'HASH') {
        !          4320:             $start = $triggered{$blocker}{'start'};
        !          4321:             $end = $triggered{$blocker}{'end'};
        !          4322:             $triggertype = $triggered{$blocker}{'type'};
        !          4323:         }
        !          4324:         if ($start) {
        !          4325:             push(@{$$setters{$course}{'times'}}, [$start,$end]);
        !          4326:             if ($triggertype) {
        !          4327:                 push(@{$$setters{$course}{'triggers'}},$triggertype);
        !          4328:             } else {
        !          4329:                 push(@{$$setters{$course}{'triggers'}},0);
        !          4330:             }
        !          4331:             if ( ($startblock == 0) || ($startblock > $start) ) {
        !          4332:                 $startblock = $start;
        !          4333:                 if ($triggertype) {
        !          4334:                     $triggerblock = $blocker;
1.474     raeburn  4335:                 }
                   4336:             }
1.1062  ! raeburn  4337:             if ( ($endblock == 0) || ($endblock < $end) ) {
        !          4338:                $endblock = $end;
        !          4339:                if ($triggertype) {
        !          4340:                    $triggerblock = $blocker;
        !          4341:                }
        !          4342:             }
1.474     raeburn  4343:         }
                   4344:     }
1.1062  ! raeburn  4345:     return ($startblock,$endblock,$triggerblock);
1.474     raeburn  4346: }
                   4347: 
                   4348: sub parse_block_record {
                   4349:     my ($record) = @_;
                   4350:     my ($setuname,$setudom,$title,$blocks);
                   4351:     if (ref($record) eq 'HASH') {
                   4352:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   4353:         $title = &unescape($record->{'event'});
                   4354:         $blocks = $record->{'blocks'};
                   4355:     } else {
                   4356:         my @data = split(/:/,$record,3);
                   4357:         if (scalar(@data) eq 2) {
                   4358:             $title = $data[1];
                   4359:             ($setuname,$setudom) = split(/@/,$data[0]);
                   4360:         } else {
                   4361:             ($setuname,$setudom,$title) = @data;
                   4362:         }
                   4363:         $blocks = { 'com' => 'on' };
                   4364:     }
                   4365:     return ($setuname,$setudom,$title,$blocks);
                   4366: }
                   4367: 
1.854     kalberla 4368: sub blocking_status {
1.1062  ! raeburn  4369:     my ($activity,$uname,$udom,$url) = @_;
1.1061    raeburn  4370:     my %setters;
1.890     droeschl 4371: 
1.1061    raeburn  4372: # check for active blocking
1.1062  ! raeburn  4373:     my ($startblock,$endblock,$triggerblock) = 
        !          4374:         &blockcheck(\%setters,$activity,$uname,$udom,$url);
        !          4375:     my $blocked = 0;
        !          4376:     if ($startblock && $endblock) {
        !          4377:         $blocked = 1;
        !          4378:     }
1.890     droeschl 4379: 
1.1061    raeburn  4380: # caller just wants to know whether a block is active
                   4381:     if (!wantarray) { return $blocked; }
                   4382: 
                   4383: # build a link to a popup window containing the details
                   4384:     my $querystring  = "?activity=$activity";
                   4385: # $uname and $udom decide whose portfolio the user is trying to look at
1.1062  ! raeburn  4386:     if ($activity eq 'port') {
        !          4387:         $querystring .= "&amp;udom=$udom"      if $udom;
        !          4388:         $querystring .= "&amp;uname=$uname"    if $uname;
        !          4389:     } elsif ($activity eq 'docs') {
        !          4390:         $querystring .= '&amp;url='.&HTML::Entities::encode($url,'&"');
        !          4391:     }
1.1061    raeburn  4392: 
                   4393:     my $output .= <<'END_MYBLOCK';
                   4394: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4395:     var options = "width=" + w + ",height=" + h + ",";
                   4396:     options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4397:     options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4398:     var newWin = window.open(url, wdwName, options);
                   4399:     newWin.focus();
                   4400: }
1.890     droeschl 4401: END_MYBLOCK
1.854     kalberla 4402: 
1.1061    raeburn  4403:     $output = Apache::lonhtmlcommon::scripttag($output);
1.890     droeschl 4404:   
1.1061    raeburn  4405:     my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062  ! raeburn  4406:     my $text = &mt('Communication Blocked');
        !          4407:     if ($activity eq 'docs') {
        !          4408:         $text = &mt('Content Access Blocked');
        !          4409:     }
1.890     droeschl 4410: 
1.1061    raeburn  4411:     $output .= <<"END_BLOCK";
1.867     kalberla 4412: <div class='LC_comblock'>
1.869     kalberla 4413:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 4414:   title='$text'>
                   4415:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 4416:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 4417:   title='$text'>$text</a>
1.867     kalberla 4418: </div>
                   4419: 
                   4420: END_BLOCK
1.474     raeburn  4421: 
1.1061    raeburn  4422:     return ($blocked, $output);
1.854     kalberla 4423: }
1.490     raeburn  4424: 
1.60      matthew  4425: ###############################################
                   4426: 
1.682     raeburn  4427: sub check_ip_acc {
                   4428:     my ($acc)=@_;
                   4429:     &Apache::lonxml::debug("acc is $acc");
                   4430:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   4431:         return 1;
                   4432:     }
                   4433:     my $allowed=0;
                   4434:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   4435: 
                   4436:     my $name;
                   4437:     foreach my $pattern (split(',',$acc)) {
                   4438:         $pattern =~ s/^\s*//;
                   4439:         $pattern =~ s/\s*$//;
                   4440:         if ($pattern =~ /\*$/) {
                   4441:             #35.8.*
                   4442:             $pattern=~s/\*//;
                   4443:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4444:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   4445:             #35.8.3.[34-56]
                   4446:             my $low=$2;
                   4447:             my $high=$3;
                   4448:             $pattern=$1;
                   4449:             if ($ip =~ /^\Q$pattern\E/) {
                   4450:                 my $last=(split(/\./,$ip))[3];
                   4451:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4452:             }
                   4453:         } elsif ($pattern =~ /^\*/) {
                   4454:             #*.msu.edu
                   4455:             $pattern=~s/\*//;
                   4456:             if (!defined($name)) {
                   4457:                 use Socket;
                   4458:                 my $netaddr=inet_aton($ip);
                   4459:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4460:             }
                   4461:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4462:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4463:             #127.0.0.1
                   4464:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4465:         } else {
                   4466:             #some.name.com
                   4467:             if (!defined($name)) {
                   4468:                 use Socket;
                   4469:                 my $netaddr=inet_aton($ip);
                   4470:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4471:             }
                   4472:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4473:         }
                   4474:         if ($allowed) { last; }
                   4475:     }
                   4476:     return $allowed;
                   4477: }
                   4478: 
                   4479: ###############################################
                   4480: 
1.60      matthew  4481: =pod
                   4482: 
1.112     bowersj2 4483: =head1 Domain Template Functions
                   4484: 
                   4485: =over 4
                   4486: 
                   4487: =item * &determinedomain()
1.60      matthew  4488: 
                   4489: Inputs: $domain (usually will be undef)
                   4490: 
1.63      www      4491: Returns: Determines which domain should be used for designs
1.60      matthew  4492: 
                   4493: =cut
1.54      www      4494: 
1.60      matthew  4495: ###############################################
1.63      www      4496: sub determinedomain {
                   4497:     my $domain=shift;
1.531     albertel 4498:     if (! $domain) {
1.60      matthew  4499:         # Determine domain if we have not been given one
1.893     raeburn  4500:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 4501:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4502:         if ($env{'request.role.domain'}) { 
                   4503:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4504:         }
                   4505:     }
1.63      www      4506:     return $domain;
                   4507: }
                   4508: ###############################################
1.517     raeburn  4509: 
1.518     albertel 4510: sub devalidate_domconfig_cache {
                   4511:     my ($udom)=@_;
                   4512:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4513: }
                   4514: 
                   4515: # ---------------------- Get domain configuration for a domain
                   4516: sub get_domainconf {
                   4517:     my ($udom) = @_;
                   4518:     my $cachetime=1800;
                   4519:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4520:     if (defined($cached)) { return %{$result}; }
                   4521: 
                   4522:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  4523: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  4524:     my (%designhash,%legacy);
1.518     albertel 4525:     if (keys(%domconfig) > 0) {
                   4526:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4527:             if (keys(%{$domconfig{'login'}})) {
                   4528:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4529:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946     raeburn  4530:                         if ($key eq 'loginvia') {
                   4531:                             if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013    raeburn  4532:                                 foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948     raeburn  4533:                                     if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
                   4534:                                         if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   4535:                                             my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   4536:                                             $designhash{$udom.'.login.loginvia'} = $server;
                   4537:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   4538: 
                   4539:                                                 $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   4540:                                             } else {
1.1013    raeburn  4541:                                                 $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948     raeburn  4542:                                             }
                   4543:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
                   4544:                                                 $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
                   4545:                                             }
1.946     raeburn  4546:                                         }
                   4547:                                     }
                   4548:                                 }
                   4549:                             }
                   4550:                         } else {
                   4551:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4552:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4553:                                     $domconfig{'login'}{$key}{$img};
                   4554:                             }
1.699     raeburn  4555:                         }
                   4556:                     } else {
                   4557:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4558:                     }
1.632     raeburn  4559:                 }
                   4560:             } else {
                   4561:                 $legacy{'login'} = 1;
1.518     albertel 4562:             }
1.632     raeburn  4563:         } else {
                   4564:             $legacy{'login'} = 1;
1.518     albertel 4565:         }
                   4566:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4567:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4568:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4569:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4570:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4571:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4572:                         }
1.518     albertel 4573:                     }
                   4574:                 }
1.632     raeburn  4575:             } else {
                   4576:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4577:             }
1.632     raeburn  4578:         } else {
                   4579:             $legacy{'rolecolors'} = 1;
1.518     albertel 4580:         }
1.948     raeburn  4581:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   4582:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   4583:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   4584:             }
                   4585:         }
1.632     raeburn  4586:         if (keys(%legacy) > 0) {
                   4587:             my %legacyhash = &get_legacy_domconf($udom);
                   4588:             foreach my $item (keys(%legacyhash)) {
                   4589:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4590:                     if ($legacy{'login'}) { 
                   4591:                         $designhash{$item} = $legacyhash{$item};
                   4592:                     }
                   4593:                 } else {
                   4594:                     if ($legacy{'rolecolors'}) {
                   4595:                         $designhash{$item} = $legacyhash{$item};
                   4596:                     }
1.518     albertel 4597:                 }
                   4598:             }
                   4599:         }
1.632     raeburn  4600:     } else {
                   4601:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4602:     }
                   4603:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4604: 				  $cachetime);
                   4605:     return %designhash;
                   4606: }
                   4607: 
1.632     raeburn  4608: sub get_legacy_domconf {
                   4609:     my ($udom) = @_;
                   4610:     my %legacyhash;
                   4611:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4612:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4613:     if (-e $designfile) {
                   4614:         if ( open (my $fh,"<$designfile") ) {
                   4615:             while (my $line = <$fh>) {
                   4616:                 next if ($line =~ /^\#/);
                   4617:                 chomp($line);
                   4618:                 my ($key,$val)=(split(/\=/,$line));
                   4619:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4620:             }
                   4621:             close($fh);
                   4622:         }
                   4623:     }
1.1026    raeburn  4624:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  4625:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4626:     }
                   4627:     return %legacyhash;
                   4628: }
                   4629: 
1.63      www      4630: =pod
                   4631: 
1.112     bowersj2 4632: =item * &domainlogo()
1.63      www      4633: 
                   4634: Inputs: $domain (usually will be undef)
                   4635: 
                   4636: Returns: A link to a domain logo, if the domain logo exists.
                   4637: If the domain logo does not exist, a description of the domain.
                   4638: 
                   4639: =cut
1.112     bowersj2 4640: 
1.63      www      4641: ###############################################
                   4642: sub domainlogo {
1.517     raeburn  4643:     my $domain = &determinedomain(shift);
1.518     albertel 4644:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4645:     # See if there is a logo
                   4646:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4647:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4648:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4649: 	    if ($imgsrc =~ m{^/res/}) {
                   4650: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4651: 		&Apache::lonnet::repcopy($local_name);
                   4652: 	    }
                   4653: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4654:         } 
                   4655:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4656:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4657:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4658:     } else {
1.60      matthew  4659:         return '';
1.59      www      4660:     }
                   4661: }
1.63      www      4662: ##############################################
                   4663: 
                   4664: =pod
                   4665: 
1.112     bowersj2 4666: =item * &designparm()
1.63      www      4667: 
                   4668: Inputs: $which parameter; $domain (usually will be undef)
                   4669: 
                   4670: Returns: value of designparamter $which
                   4671: 
                   4672: =cut
1.112     bowersj2 4673: 
1.397     albertel 4674: 
1.400     albertel 4675: ##############################################
1.397     albertel 4676: sub designparm {
                   4677:     my ($which,$domain)=@_;
                   4678:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4679:         return $env{'environment.color.'.$which};
1.96      www      4680:     }
1.63      www      4681:     $domain=&determinedomain($domain);
1.1016    raeburn  4682:     my %domdesign;
                   4683:     unless ($domain eq 'public') {
                   4684:         %domdesign = &get_domainconf($domain);
                   4685:     }
1.520     raeburn  4686:     my $output;
1.517     raeburn  4687:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4688:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4689:     } else {
1.520     raeburn  4690:         $output = $defaultdesign{$which};
                   4691:     }
                   4692:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4693:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4694:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4695:             if ($output =~ m{^/res/}) {
                   4696:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4697:                 &Apache::lonnet::repcopy($local_name);
                   4698:             }
1.520     raeburn  4699:             $output = &lonhttpdurl($output);
                   4700:         }
1.63      www      4701:     }
1.520     raeburn  4702:     return $output;
1.63      www      4703: }
1.59      www      4704: 
1.822     bisitz   4705: ##############################################
                   4706: =pod
                   4707: 
1.832     bisitz   4708: =item * &authorspace()
                   4709: 
1.1028    raeburn  4710: Inputs: $url (usually will be undef).
1.832     bisitz   4711: 
1.1028    raeburn  4712: Returns: Path to Construction Space containing the resource or 
                   4713:          directory being viewed (or for which action is being taken). 
                   4714:          If $url is provided, and begins /priv/<domain>/<uname>
                   4715:          the path will be that portion of the $context argument.
                   4716:          Otherwise the path will be for the author space of the current
                   4717:          user when the current role is author, or for that of the 
                   4718:          co-author/assistant co-author space when the current role 
                   4719:          is co-author or assistant co-author.
1.832     bisitz   4720: 
                   4721: =cut
                   4722: 
                   4723: sub authorspace {
1.1028    raeburn  4724:     my ($url) = @_;
                   4725:     if ($url ne '') {
                   4726:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   4727:            return $1;
                   4728:         }
                   4729:     }
1.832     bisitz   4730:     my $caname = '';
1.1024    www      4731:     my $cadom = '';
1.1028    raeburn  4732:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      4733:         ($cadom,$caname) =
1.832     bisitz   4734:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  4735:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   4736:         $caname = $env{'user.name'};
1.1024    www      4737:         $cadom = $env{'user.domain'};
1.832     bisitz   4738:     }
1.1028    raeburn  4739:     if (($caname ne '') && ($cadom ne '')) {
                   4740:         return "/priv/$cadom/$caname/";
                   4741:     }
                   4742:     return;
1.832     bisitz   4743: }
                   4744: 
                   4745: ##############################################
                   4746: =pod
                   4747: 
1.822     bisitz   4748: =item * &head_subbox()
                   4749: 
                   4750: Inputs: $content (contains HTML code with page functions, etc.)
                   4751: 
                   4752: Returns: HTML div with $content
                   4753:          To be included in page header
                   4754: 
                   4755: =cut
                   4756: 
                   4757: sub head_subbox {
                   4758:     my ($content)=@_;
                   4759:     my $output =
1.993     raeburn  4760:         '<div class="LC_head_subbox">'
1.822     bisitz   4761:        .$content
                   4762:        .'</div>'
                   4763: }
                   4764: 
                   4765: ##############################################
                   4766: =pod
                   4767: 
                   4768: =item * &CSTR_pageheader()
                   4769: 
1.1026    raeburn  4770: Input: (optional) filename from which breadcrumb trail is built.
                   4771:        In most cases no input as needed, as $env{'request.filename'}
                   4772:        is appropriate for use in building the breadcrumb trail.
1.822     bisitz   4773: 
                   4774: Returns: HTML div with CSTR path and recent box
                   4775:          To be included on Construction Space pages
                   4776: 
                   4777: =cut
                   4778: 
                   4779: sub CSTR_pageheader {
1.1026    raeburn  4780:     my ($trailfile) = @_;
                   4781:     if ($trailfile eq '') {
                   4782:         $trailfile = $env{'request.filename'};
                   4783:     }
                   4784: 
                   4785: # this is for resources; directories have customtitle, and crumbs
                   4786: # and select recent are created in lonpubdir.pm
                   4787: 
                   4788:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      4789:     my ($udom,$uname,$thisdisfn)=
1.1026    raeburn  4790:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)/(.*)$});
                   4791:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   4792:     $formaction =~ s{/+}{/}g;
1.822     bisitz   4793: 
                   4794:     my $parentpath = '';
                   4795:     my $lastitem = '';
                   4796:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4797:         $parentpath = $1;
                   4798:         $lastitem = $2;
                   4799:     } else {
                   4800:         $lastitem = $thisdisfn;
                   4801:     }
1.921     bisitz   4802: 
                   4803:     my $output =
1.822     bisitz   4804:          '<div>'
                   4805:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4806:         .'<b>'.&mt('Construction Space:').'</b> '
                   4807:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   4808:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024    www      4809:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921     bisitz   4810: 
                   4811:     if ($lastitem) {
                   4812:         $output .=
                   4813:              '<span class="LC_filename">'
                   4814:             .$lastitem
                   4815:             .'</span>';
                   4816:     }
                   4817:     $output .=
                   4818:          '<br />'
1.822     bisitz   4819:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4820:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4821:         .'</form>'
                   4822:         .&Apache::lonmenu::constspaceform()
                   4823:         .'</div>';
1.921     bisitz   4824: 
                   4825:     return $output;
1.822     bisitz   4826: }
                   4827: 
1.60      matthew  4828: ###############################################
                   4829: ###############################################
                   4830: 
                   4831: =pod
                   4832: 
1.112     bowersj2 4833: =back
                   4834: 
1.549     albertel 4835: =head1 HTML Helpers
1.112     bowersj2 4836: 
                   4837: =over 4
                   4838: 
                   4839: =item * &bodytag()
1.60      matthew  4840: 
                   4841: Returns a uniform header for LON-CAPA web pages.
                   4842: 
                   4843: Inputs: 
                   4844: 
1.112     bowersj2 4845: =over 4
                   4846: 
                   4847: =item * $title, A title to be displayed on the page.
                   4848: 
                   4849: =item * $function, the current role (can be undef).
                   4850: 
                   4851: =item * $addentries, extra parameters for the <body> tag.
                   4852: 
                   4853: =item * $bodyonly, if defined, only return the <body> tag.
                   4854: 
                   4855: =item * $domain, if defined, force a given domain.
                   4856: 
                   4857: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4858:             text interface only)
1.60      matthew  4859: 
1.814     bisitz   4860: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4861:                      navigational links
1.317     albertel 4862: 
1.338     albertel 4863: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4864: 
1.460     albertel 4865: =item * $args, optional argument valid values are
                   4866:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4867:             inherit_jsmath -> when creating popup window in a page,
                   4868:                               should it have jsmath forced on by the
                   4869:                               current page
1.460     albertel 4870: 
1.112     bowersj2 4871: =back
                   4872: 
1.60      matthew  4873: Returns: A uniform header for LON-CAPA web pages.  
                   4874: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4875: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4876: other decorations will be returned.
                   4877: 
                   4878: =cut
                   4879: 
1.54      www      4880: sub bodytag {
1.831     bisitz   4881:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962     droeschl 4882:         $no_nav_bar,$bgcolor,$args)=@_;
1.339     albertel 4883: 
1.954     raeburn  4884:     my $public;
                   4885:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   4886:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   4887:         $public = 1;
                   4888:     }
1.460     albertel 4889:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4890: 
1.183     matthew  4891:     $function = &get_users_function() if (!$function);
1.339     albertel 4892:     my $img =    &designparm($function.'.img',$domain);
                   4893:     my $font =   &designparm($function.'.font',$domain);
                   4894:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4895: 
1.803     bisitz   4896:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4897: 		   'bgcolor' => $pgbg,
1.339     albertel 4898: 		   'text'    => $font,
                   4899:                    'alink'   => &designparm($function.'.alink',$domain),
                   4900: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4901: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4902:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4903: 
1.63      www      4904:  # role and realm
1.378     raeburn  4905:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4906:     if ($role  eq 'ca') {
1.479     albertel 4907:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4908:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4909:     } 
1.55      www      4910: # realm
1.258     albertel 4911:     if ($env{'request.course.id'}) {
1.378     raeburn  4912:         if ($env{'request.role'} !~ /^cr/) {
                   4913:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4914:         }
1.898     raeburn  4915:         if ($env{'request.course.sec'}) {
                   4916:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   4917:         }   
1.359     albertel 4918: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4919:     } else {
                   4920:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4921:     }
1.433     albertel 4922: 
1.359     albertel 4923:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 4924: 
1.438     albertel 4925:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4926: 
1.101     www      4927: # construct main body tag
1.359     albertel 4928:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4929: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4930: 
1.530     albertel 4931:     if ($bodyonly) {
1.60      matthew  4932:         return $bodytag;
1.798     tempelho 4933:     } 
1.359     albertel 4934: 
1.410     albertel 4935:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954     raeburn  4936:     if ($public) {
1.433     albertel 4937: 	undef($role);
1.434     albertel 4938:     } else {
                   4939: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4940:     }
1.359     albertel 4941:     
1.762     bisitz   4942:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4943:     #
                   4944:     # Extra info if you are the DC
                   4945:     my $dc_info = '';
                   4946:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4947:                         $env{'course.'.$env{'request.course.id'}.
                   4948:                                  '.domain'}.'/'})) {
                   4949:         my $cid = $env{'request.course.id'};
1.917     raeburn  4950:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4951:         $dc_info =~ s/\s+$//;
1.359     albertel 4952:     }
                   4953: 
1.898     raeburn  4954:     $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853     droeschl 4955:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   4956: 
1.916     droeschl 4957:         if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') { 
                   4958:             return $bodytag; 
                   4959:         } 
1.903     droeschl 4960: 
                   4961:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   4962: 
                   4963:         #    if ($env{'request.state'} eq 'construct') {
                   4964:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4965:         #    }
                   4966: 
1.359     albertel 4967: 
                   4968: 
1.916     droeschl 4969:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917     raeburn  4970:              if ($dc_info) {
                   4971:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   4972:              }
1.916     droeschl 4973:              $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   4974:                 <em>$realm</em> $dc_info</div>|;
1.903     droeschl 4975:             return $bodytag;
                   4976:         }
1.894     droeschl 4977: 
1.927     raeburn  4978:         unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
                   4979:             $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
                   4980:         }
1.916     droeschl 4981: 
1.903     droeschl 4982:         $bodytag .= Apache::lonhtmlcommon::scripttag(
                   4983:             Apache::lonmenu::utilityfunctions(), 'start');
1.816     bisitz   4984: 
1.903     droeschl 4985:         $bodytag .= Apache::lonmenu::primary_menu();
1.852     droeschl 4986: 
1.917     raeburn  4987:         if ($dc_info) {
                   4988:             $dc_info = &dc_courseid_toggle($dc_info);
                   4989:         }
                   4990:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 4991: 
1.903     droeschl 4992:         #don't show menus for public users
1.954     raeburn  4993:         if (!$public){
1.903     droeschl 4994:             $bodytag .= Apache::lonmenu::secondary_menu();
                   4995:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  4996:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   4997:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 4998:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920     raeburn  4999:                                 $args->{'bread_crumbs'});
                   5000:             } elsif ($forcereg) { 
                   5001:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg);
                   5002:             }
1.903     droeschl 5003:         }else{
                   5004:             # this is to seperate menu from content when there's no secondary
                   5005:             # menu. Especially needed for public accessible ressources.
                   5006:             $bodytag .= '<hr style="clear:both" />';
                   5007:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  5008:         }
1.903     droeschl 5009: 
1.235     raeburn  5010:         return $bodytag;
1.182     matthew  5011: }
                   5012: 
1.917     raeburn  5013: sub dc_courseid_toggle {
                   5014:     my ($dc_info) = @_;
1.980     raeburn  5015:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.917     raeburn  5016:            '<a href="javascript:showCourseID();">'.
                   5017:            &mt('(More ...)').'</a></span>'.
                   5018:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5019: }
                   5020: 
1.330     albertel 5021: sub make_attr_string {
                   5022:     my ($register,$attr_ref) = @_;
                   5023: 
                   5024:     if ($attr_ref && !ref($attr_ref)) {
                   5025: 	die("addentries Must be a hash ref ".
                   5026: 	    join(':',caller(1))." ".
                   5027: 	    join(':',caller(0))." ");
                   5028:     }
                   5029: 
                   5030:     if ($register) {
1.339     albertel 5031: 	my ($on_load,$on_unload);
                   5032: 	foreach my $key (keys(%{$attr_ref})) {
                   5033: 	    if      (lc($key) eq 'onload') {
                   5034: 		$on_load.=$attr_ref->{$key}.';';
                   5035: 		delete($attr_ref->{$key});
                   5036: 
                   5037: 	    } elsif (lc($key) eq 'onunload') {
                   5038: 		$on_unload.=$attr_ref->{$key}.';';
                   5039: 		delete($attr_ref->{$key});
                   5040: 	    }
                   5041: 	}
1.953     droeschl 5042: 	$attr_ref->{'onload'}  = $on_load;
                   5043: 	$attr_ref->{'onunload'}= $on_unload;
1.330     albertel 5044:     }
1.339     albertel 5045: 
1.330     albertel 5046:     my $attr_string;
                   5047:     foreach my $attr (keys(%$attr_ref)) {
                   5048: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   5049:     }
                   5050:     return $attr_string;
                   5051: }
                   5052: 
                   5053: 
1.182     matthew  5054: ###############################################
1.251     albertel 5055: ###############################################
                   5056: 
                   5057: =pod
                   5058: 
                   5059: =item * &endbodytag()
                   5060: 
                   5061: Returns a uniform footer for LON-CAPA web pages.
                   5062: 
1.635     raeburn  5063: Inputs: 1 - optional reference to an args hash
                   5064: If in the hash, key for noredirectlink has a value which evaluates to true,
                   5065: a 'Continue' link is not displayed if the page contains an
                   5066: internal redirect in the <head></head> section,
                   5067: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 5068: 
                   5069: =cut
                   5070: 
                   5071: sub endbodytag {
1.635     raeburn  5072:     my ($args) = @_;
1.251     albertel 5073:     my $endbodytag='</body>';
1.269     albertel 5074:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 5075:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  5076:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   5077: 	    $endbodytag=
                   5078: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   5079: 	        &mt('Continue').'</a>'.
                   5080: 	        $endbodytag;
                   5081:         }
1.315     albertel 5082:     }
1.251     albertel 5083:     return $endbodytag;
                   5084: }
                   5085: 
1.352     albertel 5086: =pod
                   5087: 
                   5088: =item * &standard_css()
                   5089: 
                   5090: Returns a style sheet
                   5091: 
                   5092: Inputs: (all optional)
                   5093:             domain         -> force to color decorate a page for a specific
                   5094:                                domain
                   5095:             function       -> force usage of a specific rolish color scheme
                   5096:             bgcolor        -> override the default page bgcolor
                   5097: 
                   5098: =cut
                   5099: 
1.343     albertel 5100: sub standard_css {
1.345     albertel 5101:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 5102:     $function  = &get_users_function() if (!$function);
                   5103:     my $img    = &designparm($function.'.img',   $domain);
                   5104:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   5105:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 5106:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 5107: #second colour for later usage
1.345     albertel 5108:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 5109:     my $pgbg_or_bgcolor =
                   5110: 	         $bgcolor ||
1.352     albertel 5111: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 5112:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 5113:     my $alink  = &designparm($function.'.alink', $domain);
                   5114:     my $vlink  = &designparm($function.'.vlink', $domain);
                   5115:     my $link   = &designparm($function.'.link',  $domain);
                   5116: 
1.602     albertel 5117:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 5118:     my $mono                 = 'monospace';
1.850     bisitz   5119:     my $data_table_head      = $sidebg;
                   5120:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   5121:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 5122:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 5123:     my $data_table_highlight = '#FFFF00';
1.352     albertel 5124:     my $mail_new             = '#FFBB77';
                   5125:     my $mail_new_hover       = '#DD9955';
                   5126:     my $mail_read            = '#BBBB77';
                   5127:     my $mail_read_hover      = '#999944';
                   5128:     my $mail_replied         = '#AAAA88';
                   5129:     my $mail_replied_hover   = '#888855';
                   5130:     my $mail_other           = '#99BBBB';
                   5131:     my $mail_other_hover     = '#669999';
1.391     albertel 5132:     my $table_header         = '#DDDDDD';
1.489     raeburn  5133:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   5134:     my $lg_border_color      = '#C8C8C8';
1.952     onken    5135:     my $button_hover         = '#BF2317';
1.392     albertel 5136: 
1.608     albertel 5137:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   5138:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   5139:                                              : '0 3px 0 4px';
1.448     albertel 5140: 
1.523     albertel 5141: 
1.343     albertel 5142:     return <<END;
1.947     droeschl 5143: 
                   5144: /* needed for iframe to allow 100% height in FF */
                   5145: body, html { 
                   5146:     margin: 0;
                   5147:     padding: 0 0.5%;
                   5148:     height: 99%; /* to avoid scrollbars */
                   5149: }
                   5150: 
1.795     www      5151: body {
1.911     bisitz   5152:   font-family: $sans;
                   5153:   line-height:130%;
                   5154:   font-size:0.83em;
                   5155:   color:$font;
1.795     www      5156: }
                   5157: 
1.959     onken    5158: a:focus,
                   5159: a:focus img {
1.795     www      5160:   color: red;
                   5161: }
1.698     harmsja  5162: 
1.911     bisitz   5163: form, .inline {
                   5164:   display: inline;
1.795     www      5165: }
1.721     harmsja  5166: 
1.795     www      5167: .LC_right {
1.911     bisitz   5168:   text-align:right;
1.795     www      5169: }
                   5170: 
                   5171: .LC_middle {
1.911     bisitz   5172:   vertical-align:middle;
1.795     www      5173: }
1.721     harmsja  5174: 
1.911     bisitz   5175: .LC_400Box {
                   5176:   width:400px;
                   5177: }
1.721     harmsja  5178: 
1.947     droeschl 5179: .LC_iframecontainer {
                   5180:     width: 98%;
                   5181:     margin: 0;
                   5182:     position: fixed;
                   5183:     top: 8.5em;
                   5184:     bottom: 0;
                   5185: }
                   5186: 
                   5187: .LC_iframecontainer iframe{
                   5188:     border: none;
                   5189:     width: 100%;
                   5190:     height: 100%;
                   5191: }
                   5192: 
1.778     bisitz   5193: .LC_filename {
                   5194:   font-family: $mono;
                   5195:   white-space:pre;
1.921     bisitz   5196:   font-size: 120%;
1.778     bisitz   5197: }
                   5198: 
                   5199: .LC_fileicon {
                   5200:   border: none;
                   5201:   height: 1.3em;
                   5202:   vertical-align: text-bottom;
                   5203:   margin-right: 0.3em;
                   5204:   text-decoration:none;
                   5205: }
                   5206: 
1.1008    www      5207: .LC_setting {
                   5208:   text-decoration:underline;
                   5209: }
                   5210: 
1.350     albertel 5211: .LC_error {
                   5212:   color: red;
                   5213:   font-size: larger;
                   5214: }
1.795     www      5215: 
1.457     albertel 5216: .LC_warning,
                   5217: .LC_diff_removed {
1.733     bisitz   5218:   color: red;
1.394     albertel 5219: }
1.532     albertel 5220: 
                   5221: .LC_info,
1.457     albertel 5222: .LC_success,
                   5223: .LC_diff_added {
1.350     albertel 5224:   color: green;
                   5225: }
1.795     www      5226: 
1.802     bisitz   5227: div.LC_confirm_box {
                   5228:   background-color: #FAFAFA;
                   5229:   border: 1px solid $lg_border_color;
                   5230:   margin-right: 0;
                   5231:   padding: 5px;
                   5232: }
                   5233: 
                   5234: div.LC_confirm_box .LC_error img,
                   5235: div.LC_confirm_box .LC_success img {
                   5236:   vertical-align: middle;
                   5237: }
                   5238: 
1.440     albertel 5239: .LC_icon {
1.771     droeschl 5240:   border: none;
1.790     droeschl 5241:   vertical-align: middle;
1.771     droeschl 5242: }
                   5243: 
1.543     albertel 5244: .LC_docs_spacer {
                   5245:   width: 25px;
                   5246:   height: 1px;
1.771     droeschl 5247:   border: none;
1.543     albertel 5248: }
1.346     albertel 5249: 
1.532     albertel 5250: .LC_internal_info {
1.735     bisitz   5251:   color: #999999;
1.532     albertel 5252: }
                   5253: 
1.794     www      5254: .LC_discussion {
1.1050    www      5255:   background: $data_table_dark;
1.911     bisitz   5256:   border: 1px solid black;
                   5257:   margin: 2px;
1.794     www      5258: }
                   5259: 
                   5260: .LC_disc_action_left {
1.1050    www      5261:   background: $sidebg;
1.911     bisitz   5262:   text-align: left;
1.1050    www      5263:   padding: 4px;
                   5264:   margin: 2px;
1.794     www      5265: }
                   5266: 
                   5267: .LC_disc_action_right {
1.1050    www      5268:   background: $sidebg;
1.911     bisitz   5269:   text-align: right;
1.1050    www      5270:   padding: 4px;
                   5271:   margin: 2px;
1.794     www      5272: }
                   5273: 
                   5274: .LC_disc_new_item {
1.911     bisitz   5275:   background: white;
                   5276:   border: 2px solid red;
1.1050    www      5277:   margin: 4px;
                   5278:   padding: 4px;
1.794     www      5279: }
                   5280: 
                   5281: .LC_disc_old_item {
1.911     bisitz   5282:   background: white;
1.1050    www      5283:   margin: 4px;
                   5284:   padding: 4px;
1.794     www      5285: }
                   5286: 
1.458     albertel 5287: table.LC_pastsubmission {
                   5288:   border: 1px solid black;
                   5289:   margin: 2px;
                   5290: }
                   5291: 
1.924     bisitz   5292: table#LC_menubuttons {
1.345     albertel 5293:   width: 100%;
                   5294:   background: $pgbg;
1.392     albertel 5295:   border: 2px;
1.402     albertel 5296:   border-collapse: separate;
1.803     bisitz   5297:   padding: 0;
1.345     albertel 5298: }
1.392     albertel 5299: 
1.801     tempelho 5300: table#LC_title_bar a {
                   5301:   color: $fontmenu;
                   5302: }
1.836     bisitz   5303: 
1.807     droeschl 5304: table#LC_title_bar {
1.819     tempelho 5305:   clear: both;
1.836     bisitz   5306:   display: none;
1.807     droeschl 5307: }
                   5308: 
1.795     www      5309: table#LC_title_bar,
1.933     droeschl 5310: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 5311: table#LC_title_bar.LC_with_remote {
1.359     albertel 5312:   width: 100%;
1.392     albertel 5313:   border-color: $pgbg;
                   5314:   border-style: solid;
                   5315:   border-width: $border;
1.379     albertel 5316:   background: $pgbg;
1.801     tempelho 5317:   color: $fontmenu;
1.392     albertel 5318:   border-collapse: collapse;
1.803     bisitz   5319:   padding: 0;
1.819     tempelho 5320:   margin: 0;
1.359     albertel 5321: }
1.795     www      5322: 
1.933     droeschl 5323: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 5324:     margin: 0;
                   5325:     padding: 0;
1.933     droeschl 5326:     position: relative;
                   5327:     list-style: none;
1.913     droeschl 5328: }
1.933     droeschl 5329: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 5330:     display: inline;
                   5331: }
1.933     droeschl 5332: 
                   5333: .LC_breadcrumb_tools_navigation {
1.913     droeschl 5334:     padding: 0;
1.933     droeschl 5335:     margin: 0;
                   5336:     float: left;
1.913     droeschl 5337: }
1.933     droeschl 5338: .LC_breadcrumb_tools_tools {
                   5339:     padding: 0;
                   5340:     margin: 0;
1.913     droeschl 5341:     float: right;
                   5342: }
                   5343: 
1.359     albertel 5344: table#LC_title_bar td {
                   5345:   background: $tabbg;
                   5346: }
1.795     www      5347: 
1.911     bisitz   5348: table#LC_menubuttons img {
1.803     bisitz   5349:   border: none;
1.346     albertel 5350: }
1.795     www      5351: 
1.842     droeschl 5352: .LC_breadcrumbs_component {
1.911     bisitz   5353:   float: right;
                   5354:   margin: 0 1em;
1.357     albertel 5355: }
1.842     droeschl 5356: .LC_breadcrumbs_component img {
1.911     bisitz   5357:   vertical-align: middle;
1.777     tempelho 5358: }
1.795     www      5359: 
1.383     albertel 5360: td.LC_table_cell_checkbox {
                   5361:   text-align: center;
                   5362: }
1.795     www      5363: 
                   5364: .LC_fontsize_small {
1.911     bisitz   5365:   font-size: 70%;
1.705     tempelho 5366: }
                   5367: 
1.844     bisitz   5368: #LC_breadcrumbs {
1.911     bisitz   5369:   clear:both;
                   5370:   background: $sidebg;
                   5371:   border-bottom: 1px solid $lg_border_color;
                   5372:   line-height: 2.5em;
1.933     droeschl 5373:   overflow: hidden;
1.911     bisitz   5374:   margin: 0;
                   5375:   padding: 0;
1.995     raeburn  5376:   text-align: left;
1.819     tempelho 5377: }
1.862     bisitz   5378: 
1.993     raeburn  5379: .LC_head_subbox {
1.911     bisitz   5380:   clear:both;
                   5381:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 5382:   border: 1px solid $sidebg;
                   5383:   margin: 0 0 10px 0;      
1.966     bisitz   5384:   padding: 3px;
1.995     raeburn  5385:   text-align: left;
1.822     bisitz   5386: }
                   5387: 
1.795     www      5388: .LC_fontsize_medium {
1.911     bisitz   5389:   font-size: 85%;
1.705     tempelho 5390: }
                   5391: 
1.795     www      5392: .LC_fontsize_large {
1.911     bisitz   5393:   font-size: 120%;
1.705     tempelho 5394: }
                   5395: 
1.346     albertel 5396: .LC_menubuttons_inline_text {
                   5397:   color: $font;
1.698     harmsja  5398:   font-size: 90%;
1.701     harmsja  5399:   padding-left:3px;
1.346     albertel 5400: }
                   5401: 
1.934     droeschl 5402: .LC_menubuttons_inline_text img{
                   5403:   vertical-align: middle;
                   5404: }
                   5405: 
1.1051    www      5406: li.LC_menubuttons_inline_text img {
1.951     onken    5407:   cursor:pointer;
1.1002    droeschl 5408:   text-decoration: none;
1.951     onken    5409: }
                   5410: 
1.526     www      5411: .LC_menubuttons_link {
                   5412:   text-decoration: none;
                   5413: }
1.795     www      5414: 
1.522     albertel 5415: .LC_menubuttons_category {
1.521     www      5416:   color: $font;
1.526     www      5417:   background: $pgbg;
1.521     www      5418:   font-size: larger;
                   5419:   font-weight: bold;
                   5420: }
                   5421: 
1.346     albertel 5422: td.LC_menubuttons_text {
1.911     bisitz   5423:   color: $font;
1.346     albertel 5424: }
1.706     harmsja  5425: 
1.346     albertel 5426: .LC_current_location {
                   5427:   background: $tabbg;
                   5428: }
1.795     www      5429: 
1.938     bisitz   5430: table.LC_data_table {
1.347     albertel 5431:   border: 1px solid #000000;
1.402     albertel 5432:   border-collapse: separate;
1.426     albertel 5433:   border-spacing: 1px;
1.610     albertel 5434:   background: $pgbg;
1.347     albertel 5435: }
1.795     www      5436: 
1.422     albertel 5437: .LC_data_table_dense {
                   5438:   font-size: small;
                   5439: }
1.795     www      5440: 
1.507     raeburn  5441: table.LC_nested_outer {
                   5442:   border: 1px solid #000000;
1.589     raeburn  5443:   border-collapse: collapse;
1.803     bisitz   5444:   border-spacing: 0;
1.507     raeburn  5445:   width: 100%;
                   5446: }
1.795     www      5447: 
1.879     raeburn  5448: table.LC_innerpickbox,
1.507     raeburn  5449: table.LC_nested {
1.803     bisitz   5450:   border: none;
1.589     raeburn  5451:   border-collapse: collapse;
1.803     bisitz   5452:   border-spacing: 0;
1.507     raeburn  5453:   width: 100%;
                   5454: }
1.795     www      5455: 
1.911     bisitz   5456: table.LC_data_table tr th,
                   5457: table.LC_calendar tr th,
1.879     raeburn  5458: table.LC_prior_tries tr th,
                   5459: table.LC_innerpickbox tr th {
1.349     albertel 5460:   font-weight: bold;
                   5461:   background-color: $data_table_head;
1.801     tempelho 5462:   color:$fontmenu;
1.701     harmsja  5463:   font-size:90%;
1.347     albertel 5464: }
1.795     www      5465: 
1.879     raeburn  5466: table.LC_innerpickbox tr th,
                   5467: table.LC_innerpickbox tr td {
                   5468:   vertical-align: top;
                   5469: }
                   5470: 
1.711     raeburn  5471: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   5472:   background-color: #CCCCCC;
1.711     raeburn  5473:   font-weight: bold;
                   5474:   text-align: left;
                   5475: }
1.795     www      5476: 
1.912     bisitz   5477: table.LC_data_table tr.LC_odd_row > td {
                   5478:   background-color: $data_table_light;
                   5479:   padding: 2px;
                   5480:   vertical-align: top;
                   5481: }
                   5482: 
1.809     bisitz   5483: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 5484:   background-color: $data_table_light;
1.912     bisitz   5485:   vertical-align: top;
                   5486: }
                   5487: 
                   5488: table.LC_data_table tr.LC_even_row > td {
                   5489:   background-color: $data_table_dark;
1.425     albertel 5490:   padding: 2px;
1.900     bisitz   5491:   vertical-align: top;
1.347     albertel 5492: }
1.795     www      5493: 
1.809     bisitz   5494: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5495:   background-color: $data_table_dark;
1.900     bisitz   5496:   vertical-align: top;
1.347     albertel 5497: }
1.795     www      5498: 
1.425     albertel 5499: table.LC_data_table tr.LC_data_table_highlight td {
                   5500:   background-color: $data_table_darker;
                   5501: }
1.795     www      5502: 
1.639     raeburn  5503: table.LC_data_table tr td.LC_leftcol_header {
                   5504:   background-color: $data_table_head;
                   5505:   font-weight: bold;
                   5506: }
1.795     www      5507: 
1.451     albertel 5508: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5509: table.LC_nested tr.LC_empty_row td {
1.421     albertel 5510:   font-weight: bold;
                   5511:   font-style: italic;
                   5512:   text-align: center;
                   5513:   padding: 8px;
1.347     albertel 5514: }
1.795     www      5515: 
1.940     bisitz   5516: table.LC_data_table tr.LC_empty_row td {
                   5517:   background-color: $sidebg;
                   5518: }
                   5519: 
                   5520: table.LC_nested tr.LC_empty_row td {
                   5521:   background-color: #FFFFFF;
                   5522: }
                   5523: 
1.890     droeschl 5524: table.LC_caption {
                   5525: }
                   5526: 
1.507     raeburn  5527: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5528:   padding: 4ex
                   5529: }
1.795     www      5530: 
1.507     raeburn  5531: table.LC_nested_outer tr th {
                   5532:   font-weight: bold;
1.801     tempelho 5533:   color:$fontmenu;
1.507     raeburn  5534:   background-color: $data_table_head;
1.701     harmsja  5535:   font-size: small;
1.507     raeburn  5536:   border-bottom: 1px solid #000000;
                   5537: }
1.795     www      5538: 
1.507     raeburn  5539: table.LC_nested_outer tr td.LC_subheader {
                   5540:   background-color: $data_table_head;
                   5541:   font-weight: bold;
                   5542:   font-size: small;
                   5543:   border-bottom: 1px solid #000000;
                   5544:   text-align: right;
1.451     albertel 5545: }
1.795     www      5546: 
1.507     raeburn  5547: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5548:   background-color: #CCCCCC;
1.451     albertel 5549:   font-weight: bold;
                   5550:   font-size: small;
1.507     raeburn  5551:   text-align: center;
                   5552: }
1.795     www      5553: 
1.589     raeburn  5554: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5555: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5556:   text-align: left;
1.451     albertel 5557: }
1.795     www      5558: 
1.507     raeburn  5559: table.LC_nested td {
1.735     bisitz   5560:   background-color: #FFFFFF;
1.451     albertel 5561:   font-size: small;
1.507     raeburn  5562: }
1.795     www      5563: 
1.507     raeburn  5564: table.LC_nested_outer tr th.LC_right_item,
                   5565: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5566: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5567: table.LC_nested tr td.LC_right_item {
1.451     albertel 5568:   text-align: right;
                   5569: }
                   5570: 
1.507     raeburn  5571: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5572:   background-color: #EEEEEE;
1.451     albertel 5573: }
                   5574: 
1.473     raeburn  5575: table.LC_createuser {
                   5576: }
                   5577: 
                   5578: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5579:   font-size: small;
1.473     raeburn  5580: }
                   5581: 
                   5582: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5583:   background-color: #CCCCCC;
1.473     raeburn  5584:   font-weight: bold;
                   5585:   text-align: center;
                   5586: }
                   5587: 
1.349     albertel 5588: table.LC_calendar {
                   5589:   border: 1px solid #000000;
                   5590:   border-collapse: collapse;
1.917     raeburn  5591:   width: 98%;
1.349     albertel 5592: }
1.795     www      5593: 
1.349     albertel 5594: table.LC_calendar_pickdate {
                   5595:   font-size: xx-small;
                   5596: }
1.795     www      5597: 
1.349     albertel 5598: table.LC_calendar tr td {
                   5599:   border: 1px solid #000000;
                   5600:   vertical-align: top;
1.917     raeburn  5601:   width: 14%;
1.349     albertel 5602: }
1.795     www      5603: 
1.349     albertel 5604: table.LC_calendar tr td.LC_calendar_day_empty {
                   5605:   background-color: $data_table_dark;
                   5606: }
1.795     www      5607: 
1.779     bisitz   5608: table.LC_calendar tr td.LC_calendar_day_current {
                   5609:   background-color: $data_table_highlight;
1.777     tempelho 5610: }
1.795     www      5611: 
1.938     bisitz   5612: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 5613:   background-color: $mail_new;
                   5614: }
1.795     www      5615: 
1.938     bisitz   5616: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 5617:   background-color: $mail_new_hover;
                   5618: }
1.795     www      5619: 
1.938     bisitz   5620: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 5621:   background-color: $mail_read;
                   5622: }
1.795     www      5623: 
1.938     bisitz   5624: /*
                   5625: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 5626:   background-color: $mail_read_hover;
                   5627: }
1.938     bisitz   5628: */
1.795     www      5629: 
1.938     bisitz   5630: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 5631:   background-color: $mail_replied;
                   5632: }
1.795     www      5633: 
1.938     bisitz   5634: /*
                   5635: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 5636:   background-color: $mail_replied_hover;
                   5637: }
1.938     bisitz   5638: */
1.795     www      5639: 
1.938     bisitz   5640: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 5641:   background-color: $mail_other;
                   5642: }
1.795     www      5643: 
1.938     bisitz   5644: /*
                   5645: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 5646:   background-color: $mail_other_hover;
                   5647: }
1.938     bisitz   5648: */
1.494     raeburn  5649: 
1.777     tempelho 5650: table.LC_data_table tr > td.LC_browser_file,
                   5651: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5652:   background: #AAEE77;
1.389     albertel 5653: }
1.795     www      5654: 
1.777     tempelho 5655: table.LC_data_table tr > td.LC_browser_file_locked,
                   5656: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5657:   background: #FFAA99;
1.387     albertel 5658: }
1.795     www      5659: 
1.777     tempelho 5660: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5661:   background: #888888;
1.779     bisitz   5662: }
1.795     www      5663: 
1.777     tempelho 5664: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5665: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5666:   background: #F8F866;
1.777     tempelho 5667: }
1.795     www      5668: 
1.696     bisitz   5669: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5670:   background: #E0E8FF;
1.387     albertel 5671: }
1.696     bisitz   5672: 
1.707     bisitz   5673: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   5674:   /* background: #77FF77; */
1.707     bisitz   5675: }
1.795     www      5676: 
1.707     bisitz   5677: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   5678:   border-right: 8px solid #FFFF77;
1.707     bisitz   5679: }
1.795     www      5680: 
1.707     bisitz   5681: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   5682:   border-right: 8px solid #FFAA77;
1.707     bisitz   5683: }
1.795     www      5684: 
1.707     bisitz   5685: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   5686:   border-right: 8px solid #FF7777;
1.707     bisitz   5687: }
1.795     www      5688: 
1.707     bisitz   5689: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   5690:   border-right: 8px solid #AAFF77;
1.707     bisitz   5691: }
1.795     www      5692: 
1.707     bisitz   5693: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   5694:   border-right: 8px solid #11CC55;
1.707     bisitz   5695: }
                   5696: 
1.388     albertel 5697: span.LC_current_location {
1.701     harmsja  5698:   font-size:larger;
1.388     albertel 5699:   background: $pgbg;
                   5700: }
1.387     albertel 5701: 
1.1029    www      5702: span.LC_current_nav_location {
                   5703:   font-weight:bold;
                   5704:   background: $sidebg;
                   5705: }
                   5706: 
1.395     albertel 5707: span.LC_parm_menu_item {
                   5708:   font-size: larger;
                   5709: }
1.795     www      5710: 
1.395     albertel 5711: span.LC_parm_scope_all {
                   5712:   color: red;
                   5713: }
1.795     www      5714: 
1.395     albertel 5715: span.LC_parm_scope_folder {
                   5716:   color: green;
                   5717: }
1.795     www      5718: 
1.395     albertel 5719: span.LC_parm_scope_resource {
                   5720:   color: orange;
                   5721: }
1.795     www      5722: 
1.395     albertel 5723: span.LC_parm_part {
                   5724:   color: blue;
                   5725: }
1.795     www      5726: 
1.911     bisitz   5727: span.LC_parm_folder,
                   5728: span.LC_parm_symb {
1.395     albertel 5729:   font-size: x-small;
                   5730:   font-family: $mono;
                   5731:   color: #AAAAAA;
                   5732: }
                   5733: 
1.977     bisitz   5734: ul.LC_parm_parmlist li {
                   5735:   display: inline-block;
                   5736:   padding: 0.3em 0.8em;
                   5737:   vertical-align: top;
                   5738:   width: 150px;
                   5739:   border-top:1px solid $lg_border_color;
                   5740: }
                   5741: 
1.795     www      5742: td.LC_parm_overview_level_menu,
                   5743: td.LC_parm_overview_map_menu,
                   5744: td.LC_parm_overview_parm_selectors,
                   5745: td.LC_parm_overview_restrictions  {
1.396     albertel 5746:   border: 1px solid black;
                   5747:   border-collapse: collapse;
                   5748: }
1.795     www      5749: 
1.396     albertel 5750: table.LC_parm_overview_restrictions td {
                   5751:   border-width: 1px 4px 1px 4px;
                   5752:   border-style: solid;
                   5753:   border-color: $pgbg;
                   5754:   text-align: center;
                   5755: }
1.795     www      5756: 
1.396     albertel 5757: table.LC_parm_overview_restrictions th {
                   5758:   background: $tabbg;
                   5759:   border-width: 1px 4px 1px 4px;
                   5760:   border-style: solid;
                   5761:   border-color: $pgbg;
                   5762: }
1.795     www      5763: 
1.398     albertel 5764: table#LC_helpmenu {
1.803     bisitz   5765:   border: none;
1.398     albertel 5766:   height: 55px;
1.803     bisitz   5767:   border-spacing: 0;
1.398     albertel 5768: }
                   5769: 
                   5770: table#LC_helpmenu fieldset legend {
                   5771:   font-size: larger;
                   5772: }
1.795     www      5773: 
1.397     albertel 5774: table#LC_helpmenu_links {
                   5775:   width: 100%;
                   5776:   border: 1px solid black;
                   5777:   background: $pgbg;
1.803     bisitz   5778:   padding: 0;
1.397     albertel 5779:   border-spacing: 1px;
                   5780: }
1.795     www      5781: 
1.397     albertel 5782: table#LC_helpmenu_links tr td {
                   5783:   padding: 1px;
                   5784:   background: $tabbg;
1.399     albertel 5785:   text-align: center;
                   5786:   font-weight: bold;
1.397     albertel 5787: }
1.396     albertel 5788: 
1.795     www      5789: table#LC_helpmenu_links a:link,
                   5790: table#LC_helpmenu_links a:visited,
1.397     albertel 5791: table#LC_helpmenu_links a:active {
                   5792:   text-decoration: none;
                   5793:   color: $font;
                   5794: }
1.795     www      5795: 
1.397     albertel 5796: table#LC_helpmenu_links a:hover {
                   5797:   text-decoration: underline;
                   5798:   color: $vlink;
                   5799: }
1.396     albertel 5800: 
1.417     albertel 5801: .LC_chrt_popup_exists {
                   5802:   border: 1px solid #339933;
                   5803:   margin: -1px;
                   5804: }
1.795     www      5805: 
1.417     albertel 5806: .LC_chrt_popup_up {
                   5807:   border: 1px solid yellow;
                   5808:   margin: -1px;
                   5809: }
1.795     www      5810: 
1.417     albertel 5811: .LC_chrt_popup {
                   5812:   border: 1px solid #8888FF;
                   5813:   background: #CCCCFF;
                   5814: }
1.795     www      5815: 
1.421     albertel 5816: table.LC_pick_box {
                   5817:   border-collapse: separate;
                   5818:   background: white;
                   5819:   border: 1px solid black;
                   5820:   border-spacing: 1px;
                   5821: }
1.795     www      5822: 
1.421     albertel 5823: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5824:   background: $sidebg;
1.421     albertel 5825:   font-weight: bold;
1.900     bisitz   5826:   text-align: left;
1.740     bisitz   5827:   vertical-align: top;
1.421     albertel 5828:   width: 184px;
                   5829:   padding: 8px;
                   5830: }
1.795     www      5831: 
1.579     raeburn  5832: table.LC_pick_box td.LC_pick_box_value {
                   5833:   text-align: left;
                   5834:   padding: 8px;
                   5835: }
1.795     www      5836: 
1.579     raeburn  5837: table.LC_pick_box td.LC_pick_box_select {
                   5838:   text-align: left;
                   5839:   padding: 8px;
                   5840: }
1.795     www      5841: 
1.424     albertel 5842: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5843:   padding: 0;
1.421     albertel 5844:   height: 1px;
                   5845:   background: black;
                   5846: }
1.795     www      5847: 
1.421     albertel 5848: table.LC_pick_box td.LC_pick_box_submit {
                   5849:   text-align: right;
                   5850: }
1.795     www      5851: 
1.579     raeburn  5852: table.LC_pick_box td.LC_evenrow_value {
                   5853:   text-align: left;
                   5854:   padding: 8px;
                   5855:   background-color: $data_table_light;
                   5856: }
1.795     www      5857: 
1.579     raeburn  5858: table.LC_pick_box td.LC_oddrow_value {
                   5859:   text-align: left;
                   5860:   padding: 8px;
                   5861:   background-color: $data_table_light;
                   5862: }
1.795     www      5863: 
1.579     raeburn  5864: span.LC_helpform_receipt_cat {
                   5865:   font-weight: bold;
                   5866: }
1.795     www      5867: 
1.424     albertel 5868: table.LC_group_priv_box {
                   5869:   background: white;
                   5870:   border: 1px solid black;
                   5871:   border-spacing: 1px;
                   5872: }
1.795     www      5873: 
1.424     albertel 5874: table.LC_group_priv_box td.LC_pick_box_title {
                   5875:   background: $tabbg;
                   5876:   font-weight: bold;
                   5877:   text-align: right;
                   5878:   width: 184px;
                   5879: }
1.795     www      5880: 
1.424     albertel 5881: table.LC_group_priv_box td.LC_groups_fixed {
                   5882:   background: $data_table_light;
                   5883:   text-align: center;
                   5884: }
1.795     www      5885: 
1.424     albertel 5886: table.LC_group_priv_box td.LC_groups_optional {
                   5887:   background: $data_table_dark;
                   5888:   text-align: center;
                   5889: }
1.795     www      5890: 
1.424     albertel 5891: table.LC_group_priv_box td.LC_groups_functionality {
                   5892:   background: $data_table_darker;
                   5893:   text-align: center;
                   5894:   font-weight: bold;
                   5895: }
1.795     www      5896: 
1.424     albertel 5897: table.LC_group_priv td {
                   5898:   text-align: left;
1.803     bisitz   5899:   padding: 0;
1.424     albertel 5900: }
                   5901: 
                   5902: .LC_navbuttons {
                   5903:   margin: 2ex 0ex 2ex 0ex;
                   5904: }
1.795     www      5905: 
1.423     albertel 5906: .LC_topic_bar {
                   5907:   font-weight: bold;
                   5908:   background: $tabbg;
1.918     wenzelju 5909:   margin: 1em 0em 1em 2em;
1.805     bisitz   5910:   padding: 3px;
1.918     wenzelju 5911:   font-size: 1.2em;
1.423     albertel 5912: }
1.795     www      5913: 
1.423     albertel 5914: .LC_topic_bar span {
1.918     wenzelju 5915:   left: 0.5em;
                   5916:   position: absolute;
1.423     albertel 5917:   vertical-align: middle;
1.918     wenzelju 5918:   font-size: 1.2em;
1.423     albertel 5919: }
1.795     www      5920: 
1.423     albertel 5921: table.LC_course_group_status {
                   5922:   margin: 20px;
                   5923: }
1.795     www      5924: 
1.423     albertel 5925: table.LC_status_selector td {
                   5926:   vertical-align: top;
                   5927:   text-align: center;
1.424     albertel 5928:   padding: 4px;
                   5929: }
1.795     www      5930: 
1.599     albertel 5931: div.LC_feedback_link {
1.616     albertel 5932:   clear: both;
1.829     kalberla 5933:   background: $sidebg;
1.779     bisitz   5934:   width: 100%;
1.829     kalberla 5935:   padding-bottom: 10px;
                   5936:   border: 1px $tabbg solid;
1.833     kalberla 5937:   height: 22px;
                   5938:   line-height: 22px;
                   5939:   padding-top: 5px;
                   5940: }
                   5941: 
                   5942: div.LC_feedback_link img {
                   5943:   height: 22px;
1.867     kalberla 5944:   vertical-align:middle;
1.829     kalberla 5945: }
                   5946: 
1.911     bisitz   5947: div.LC_feedback_link a {
1.829     kalberla 5948:   text-decoration: none;
1.489     raeburn  5949: }
1.795     www      5950: 
1.867     kalberla 5951: div.LC_comblock {
1.911     bisitz   5952:   display:inline;
1.867     kalberla 5953:   color:$font;
                   5954:   font-size:90%;
                   5955: }
                   5956: 
                   5957: div.LC_feedback_link div.LC_comblock {
                   5958:   padding-left:5px;
                   5959: }
                   5960: 
                   5961: div.LC_feedback_link div.LC_comblock a {
                   5962:   color:$font;
                   5963: }
                   5964: 
1.489     raeburn  5965: span.LC_feedback_link {
1.858     bisitz   5966:   /* background: $feedback_link_bg; */
1.599     albertel 5967:   font-size: larger;
                   5968: }
1.795     www      5969: 
1.599     albertel 5970: span.LC_message_link {
1.858     bisitz   5971:   /* background: $feedback_link_bg; */
1.599     albertel 5972:   font-size: larger;
                   5973:   position: absolute;
                   5974:   right: 1em;
1.489     raeburn  5975: }
1.421     albertel 5976: 
1.515     albertel 5977: table.LC_prior_tries {
1.524     albertel 5978:   border: 1px solid #000000;
                   5979:   border-collapse: separate;
                   5980:   border-spacing: 1px;
1.515     albertel 5981: }
1.523     albertel 5982: 
1.515     albertel 5983: table.LC_prior_tries td {
1.524     albertel 5984:   padding: 2px;
1.515     albertel 5985: }
1.523     albertel 5986: 
                   5987: .LC_answer_correct {
1.795     www      5988:   background: lightgreen;
                   5989:   color: darkgreen;
                   5990:   padding: 6px;
1.523     albertel 5991: }
1.795     www      5992: 
1.523     albertel 5993: .LC_answer_charged_try {
1.797     www      5994:   background: #FFAAAA;
1.795     www      5995:   color: darkred;
                   5996:   padding: 6px;
1.523     albertel 5997: }
1.795     www      5998: 
1.779     bisitz   5999: .LC_answer_not_charged_try,
1.523     albertel 6000: .LC_answer_no_grade,
                   6001: .LC_answer_late {
1.795     www      6002:   background: lightyellow;
1.523     albertel 6003:   color: black;
1.795     www      6004:   padding: 6px;
1.523     albertel 6005: }
1.795     www      6006: 
1.523     albertel 6007: .LC_answer_previous {
1.795     www      6008:   background: lightblue;
                   6009:   color: darkblue;
                   6010:   padding: 6px;
1.523     albertel 6011: }
1.795     www      6012: 
1.779     bisitz   6013: .LC_answer_no_message {
1.777     tempelho 6014:   background: #FFFFFF;
                   6015:   color: black;
1.795     www      6016:   padding: 6px;
1.779     bisitz   6017: }
1.795     www      6018: 
1.779     bisitz   6019: .LC_answer_unknown {
                   6020:   background: orange;
                   6021:   color: black;
1.795     www      6022:   padding: 6px;
1.777     tempelho 6023: }
1.795     www      6024: 
1.529     albertel 6025: span.LC_prior_numerical,
                   6026: span.LC_prior_string,
                   6027: span.LC_prior_custom,
                   6028: span.LC_prior_reaction,
                   6029: span.LC_prior_math {
1.925     bisitz   6030:   font-family: $mono;
1.523     albertel 6031:   white-space: pre;
                   6032: }
                   6033: 
1.525     albertel 6034: span.LC_prior_string {
1.925     bisitz   6035:   font-family: $mono;
1.525     albertel 6036:   white-space: pre;
                   6037: }
                   6038: 
1.523     albertel 6039: table.LC_prior_option {
                   6040:   width: 100%;
                   6041:   border-collapse: collapse;
                   6042: }
1.795     www      6043: 
1.911     bisitz   6044: table.LC_prior_rank,
1.795     www      6045: table.LC_prior_match {
1.528     albertel 6046:   border-collapse: collapse;
                   6047: }
1.795     www      6048: 
1.528     albertel 6049: table.LC_prior_option tr td,
                   6050: table.LC_prior_rank tr td,
                   6051: table.LC_prior_match tr td {
1.524     albertel 6052:   border: 1px solid #000000;
1.515     albertel 6053: }
                   6054: 
1.855     bisitz   6055: .LC_nobreak {
1.544     albertel 6056:   white-space: nowrap;
1.519     raeburn  6057: }
                   6058: 
1.576     raeburn  6059: span.LC_cusr_emph {
                   6060:   font-style: italic;
                   6061: }
                   6062: 
1.633     raeburn  6063: span.LC_cusr_subheading {
                   6064:   font-weight: normal;
                   6065:   font-size: 85%;
                   6066: }
                   6067: 
1.861     bisitz   6068: div.LC_docs_entry_move {
1.859     bisitz   6069:   border: 1px solid #BBBBBB;
1.545     albertel 6070:   background: #DDDDDD;
1.861     bisitz   6071:   width: 22px;
1.859     bisitz   6072:   padding: 1px;
                   6073:   margin: 0;
1.545     albertel 6074: }
                   6075: 
1.861     bisitz   6076: table.LC_data_table tr > td.LC_docs_entry_commands,
                   6077: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 6078:   background: #DDDDDD;
                   6079:   font-size: x-small;
                   6080: }
1.795     www      6081: 
1.861     bisitz   6082: .LC_docs_entry_parameter {
                   6083:   white-space: nowrap;
                   6084: }
                   6085: 
1.544     albertel 6086: .LC_docs_copy {
1.545     albertel 6087:   color: #000099;
1.544     albertel 6088: }
1.795     www      6089: 
1.544     albertel 6090: .LC_docs_cut {
1.545     albertel 6091:   color: #550044;
1.544     albertel 6092: }
1.795     www      6093: 
1.544     albertel 6094: .LC_docs_rename {
1.545     albertel 6095:   color: #009900;
1.544     albertel 6096: }
1.795     www      6097: 
1.544     albertel 6098: .LC_docs_remove {
1.545     albertel 6099:   color: #990000;
                   6100: }
                   6101: 
1.547     albertel 6102: .LC_docs_reinit_warn,
                   6103: .LC_docs_ext_edit {
                   6104:   font-size: x-small;
                   6105: }
                   6106: 
1.545     albertel 6107: table.LC_docs_adddocs td,
                   6108: table.LC_docs_adddocs th {
                   6109:   border: 1px solid #BBBBBB;
                   6110:   padding: 4px;
                   6111:   background: #DDDDDD;
1.543     albertel 6112: }
                   6113: 
1.584     albertel 6114: table.LC_sty_begin {
                   6115:   background: #BBFFBB;
                   6116: }
1.795     www      6117: 
1.584     albertel 6118: table.LC_sty_end {
                   6119:   background: #FFBBBB;
                   6120: }
                   6121: 
1.589     raeburn  6122: table.LC_double_column {
1.803     bisitz   6123:   border-width: 0;
1.589     raeburn  6124:   border-collapse: collapse;
                   6125:   width: 100%;
                   6126:   padding: 2px;
                   6127: }
                   6128: 
                   6129: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  6130:   top: 2px;
1.589     raeburn  6131:   left: 2px;
                   6132:   width: 47%;
                   6133:   vertical-align: top;
                   6134: }
                   6135: 
                   6136: table.LC_double_column tr td.LC_right_col {
                   6137:   top: 2px;
1.779     bisitz   6138:   right: 2px;
1.589     raeburn  6139:   width: 47%;
                   6140:   vertical-align: top;
                   6141: }
                   6142: 
1.591     raeburn  6143: div.LC_left_float {
                   6144:   float: left;
                   6145:   padding-right: 5%;
1.597     albertel 6146:   padding-bottom: 4px;
1.591     raeburn  6147: }
                   6148: 
                   6149: div.LC_clear_float_header {
1.597     albertel 6150:   padding-bottom: 2px;
1.591     raeburn  6151: }
                   6152: 
                   6153: div.LC_clear_float_footer {
1.597     albertel 6154:   padding-top: 10px;
1.591     raeburn  6155:   clear: both;
                   6156: }
                   6157: 
1.597     albertel 6158: div.LC_grade_show_user {
1.941     bisitz   6159: /*  border-left: 5px solid $sidebg; */
                   6160:   border-top: 5px solid #000000;
                   6161:   margin: 50px 0 0 0;
1.936     bisitz   6162:   padding: 15px 0 5px 10px;
1.597     albertel 6163: }
1.795     www      6164: 
1.936     bisitz   6165: div.LC_grade_show_user_odd_row {
1.941     bisitz   6166: /*  border-left: 5px solid #000000; */
                   6167: }
                   6168: 
                   6169: div.LC_grade_show_user div.LC_Box {
                   6170:   margin-right: 50px;
1.597     albertel 6171: }
                   6172: 
                   6173: div.LC_grade_submissions,
                   6174: div.LC_grade_message_center,
1.936     bisitz   6175: div.LC_grade_info_links {
1.597     albertel 6176:   margin: 5px;
                   6177:   width: 99%;
                   6178:   background: #FFFFFF;
                   6179: }
1.795     www      6180: 
1.597     albertel 6181: div.LC_grade_submissions_header,
1.936     bisitz   6182: div.LC_grade_message_center_header {
1.705     tempelho 6183:   font-weight: bold;
                   6184:   font-size: large;
1.597     albertel 6185: }
1.795     www      6186: 
1.597     albertel 6187: div.LC_grade_submissions_body,
1.936     bisitz   6188: div.LC_grade_message_center_body {
1.597     albertel 6189:   border: 1px solid black;
                   6190:   width: 99%;
                   6191:   background: #FFFFFF;
                   6192: }
1.795     www      6193: 
1.613     albertel 6194: table.LC_scantron_action {
                   6195:   width: 100%;
                   6196: }
1.795     www      6197: 
1.613     albertel 6198: table.LC_scantron_action tr th {
1.698     harmsja  6199:   font-weight:bold;
                   6200:   font-style:normal;
1.613     albertel 6201: }
1.795     www      6202: 
1.779     bisitz   6203: .LC_edit_problem_header,
1.614     albertel 6204: div.LC_edit_problem_footer {
1.705     tempelho 6205:   font-weight: normal;
                   6206:   font-size:  medium;
1.602     albertel 6207:   margin: 2px;
1.1060    bisitz   6208:   background-color: $sidebg;
1.600     albertel 6209: }
1.795     www      6210: 
1.600     albertel 6211: div.LC_edit_problem_header,
1.602     albertel 6212: div.LC_edit_problem_header div,
1.614     albertel 6213: div.LC_edit_problem_footer,
                   6214: div.LC_edit_problem_footer div,
1.602     albertel 6215: div.LC_edit_problem_editxml_header,
                   6216: div.LC_edit_problem_editxml_header div {
1.600     albertel 6217:   margin-top: 5px;
                   6218: }
1.795     www      6219: 
1.600     albertel 6220: div.LC_edit_problem_header_title {
1.705     tempelho 6221:   font-weight: bold;
                   6222:   font-size: larger;
1.602     albertel 6223:   background: $tabbg;
                   6224:   padding: 3px;
1.1060    bisitz   6225:   margin: 0 0 5px 0;
1.602     albertel 6226: }
1.795     www      6227: 
1.602     albertel 6228: table.LC_edit_problem_header_title {
                   6229:   width: 100%;
1.600     albertel 6230:   background: $tabbg;
1.602     albertel 6231: }
                   6232: 
                   6233: div.LC_edit_problem_discards {
                   6234:   float: left;
                   6235:   padding-bottom: 5px;
                   6236: }
1.795     www      6237: 
1.602     albertel 6238: div.LC_edit_problem_saves {
                   6239:   float: right;
                   6240:   padding-bottom: 5px;
1.600     albertel 6241: }
1.795     www      6242: 
1.911     bisitz   6243: img.stift {
1.803     bisitz   6244:   border-width: 0;
                   6245:   vertical-align: middle;
1.677     riegler  6246: }
1.680     riegler  6247: 
1.923     bisitz   6248: table td.LC_mainmenu_col_fieldset {
1.680     riegler  6249:   vertical-align: top;
1.777     tempelho 6250: }
1.795     www      6251: 
1.716     raeburn  6252: div.LC_createcourse {
1.911     bisitz   6253:   margin: 10px 10px 10px 10px;
1.716     raeburn  6254: }
                   6255: 
1.917     raeburn  6256: .LC_dccid {
                   6257:   margin: 0.2em 0 0 0;
                   6258:   padding: 0;
                   6259:   font-size: 90%;
                   6260:   display:none;
                   6261: }
                   6262: 
1.897     wenzelju 6263: ol.LC_primary_menu a:hover,
1.721     harmsja  6264: ol#LC_MenuBreadcrumbs a:hover,
                   6265: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 6266: ul#LC_secondary_menu a:hover,
1.721     harmsja  6267: .LC_FormSectionClearButton input:hover
1.795     www      6268: ul.LC_TabContent   li:hover a {
1.952     onken    6269:   color:$button_hover;
1.911     bisitz   6270:   text-decoration:none;
1.693     droeschl 6271: }
                   6272: 
1.779     bisitz   6273: h1 {
1.911     bisitz   6274:   padding: 0;
                   6275:   line-height:130%;
1.693     droeschl 6276: }
1.698     harmsja  6277: 
1.911     bisitz   6278: h2,
                   6279: h3,
                   6280: h4,
                   6281: h5,
                   6282: h6 {
                   6283:   margin: 5px 0 5px 0;
                   6284:   padding: 0;
                   6285:   line-height:130%;
1.693     droeschl 6286: }
1.795     www      6287: 
                   6288: .LC_hcell {
1.911     bisitz   6289:   padding:3px 15px 3px 15px;
                   6290:   margin: 0;
                   6291:   background-color:$tabbg;
                   6292:   color:$fontmenu;
                   6293:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 6294: }
1.795     www      6295: 
1.840     bisitz   6296: .LC_Box > .LC_hcell {
1.911     bisitz   6297:   margin: 0 -10px 10px -10px;
1.835     bisitz   6298: }
                   6299: 
1.721     harmsja  6300: .LC_noBorder {
1.911     bisitz   6301:   border: 0;
1.698     harmsja  6302: }
1.693     droeschl 6303: 
1.721     harmsja  6304: .LC_FormSectionClearButton input {
1.911     bisitz   6305:   background-color:transparent;
                   6306:   border: none;
                   6307:   cursor:pointer;
                   6308:   text-decoration:underline;
1.693     droeschl 6309: }
1.763     bisitz   6310: 
                   6311: .LC_help_open_topic {
1.911     bisitz   6312:   color: #FFFFFF;
                   6313:   background-color: #EEEEFF;
                   6314:   margin: 1px;
                   6315:   padding: 4px;
                   6316:   border: 1px solid #000033;
                   6317:   white-space: nowrap;
                   6318:   /* vertical-align: middle; */
1.759     neumanie 6319: }
1.693     droeschl 6320: 
1.911     bisitz   6321: dl,
                   6322: ul,
                   6323: div,
                   6324: fieldset {
                   6325:   margin: 10px 10px 10px 0;
                   6326:   /* overflow: hidden; */
1.693     droeschl 6327: }
1.795     www      6328: 
1.838     bisitz   6329: fieldset > legend {
1.911     bisitz   6330:   font-weight: bold;
                   6331:   padding: 0 5px 0 5px;
1.838     bisitz   6332: }
                   6333: 
1.813     bisitz   6334: #LC_nav_bar {
1.911     bisitz   6335:   float: left;
1.995     raeburn  6336:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   6337:   margin: 0 0 2px 0;
1.807     droeschl 6338: }
                   6339: 
1.916     droeschl 6340: #LC_realm {
                   6341:   margin: 0.2em 0 0 0;
                   6342:   padding: 0;
                   6343:   font-weight: bold;
                   6344:   text-align: center;
1.995     raeburn  6345:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 6346: }
                   6347: 
1.911     bisitz   6348: #LC_nav_bar em {
                   6349:   font-weight: bold;
                   6350:   font-style: normal;
1.807     droeschl 6351: }
                   6352: 
1.897     wenzelju 6353: ol.LC_primary_menu {
1.911     bisitz   6354:   float: right;
1.934     droeschl 6355:   margin: 0;
1.995     raeburn  6356:   background-color: $pgbg_or_bgcolor;
1.807     droeschl 6357: }
                   6358: 
1.852     droeschl 6359: ol#LC_PathBreadcrumbs {
1.911     bisitz   6360:   margin: 0;
1.693     droeschl 6361: }
                   6362: 
1.897     wenzelju 6363: ol.LC_primary_menu li {
1.911     bisitz   6364:   display: inline;
                   6365:   padding: 5px 5px 0 10px;
                   6366:   vertical-align: top;
1.693     droeschl 6367: }
                   6368: 
1.897     wenzelju 6369: ol.LC_primary_menu li img {
1.911     bisitz   6370:   vertical-align: bottom;
1.934     droeschl 6371:   height: 1.1em;
1.693     droeschl 6372: }
                   6373: 
1.897     wenzelju 6374: ol.LC_primary_menu a {
1.911     bisitz   6375:   color: RGB(80, 80, 80);
                   6376:   text-decoration: none;
1.693     droeschl 6377: }
1.795     www      6378: 
1.949     droeschl 6379: ol.LC_primary_menu a.LC_new_message {
                   6380:   font-weight:bold;
                   6381:   color: darkred;
                   6382: }
                   6383: 
1.975     raeburn  6384: ol.LC_docs_parameters {
                   6385:   margin-left: 0;
                   6386:   padding: 0;
                   6387:   list-style: none;
                   6388: }
                   6389: 
                   6390: ol.LC_docs_parameters li {
                   6391:   margin: 0;
                   6392:   padding-right: 20px;
                   6393:   display: inline;
                   6394: }
                   6395: 
1.976     raeburn  6396: ol.LC_docs_parameters li:before {
                   6397:   content: "\\002022 \\0020";
                   6398: }
                   6399: 
                   6400: li.LC_docs_parameters_title {
                   6401:   font-weight: bold;
                   6402: }
                   6403: 
                   6404: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   6405:   content: "";
                   6406: }
                   6407: 
1.897     wenzelju 6408: ul#LC_secondary_menu {
1.911     bisitz   6409:   clear: both;
                   6410:   color: $fontmenu;
                   6411:   background: $tabbg;
                   6412:   list-style: none;
                   6413:   padding: 0;
                   6414:   margin: 0;
                   6415:   width: 100%;
1.995     raeburn  6416:   text-align: left;
1.808     droeschl 6417: }
                   6418: 
1.897     wenzelju 6419: ul#LC_secondary_menu li {
1.911     bisitz   6420:   font-weight: bold;
                   6421:   line-height: 1.8em;
                   6422:   padding: 0 0.8em;
                   6423:   border-right: 1px solid black;
                   6424:   display: inline;
                   6425:   vertical-align: middle;
1.807     droeschl 6426: }
                   6427: 
1.847     tempelho 6428: ul.LC_TabContent {
1.911     bisitz   6429:   display:block;
                   6430:   background: $sidebg;
                   6431:   border-bottom: solid 1px $lg_border_color;
                   6432:   list-style:none;
1.1020    raeburn  6433:   margin: -1px -10px 0 -10px;
1.911     bisitz   6434:   padding: 0;
1.693     droeschl 6435: }
                   6436: 
1.795     www      6437: ul.LC_TabContent li,
                   6438: ul.LC_TabContentBigger li {
1.911     bisitz   6439:   float:left;
1.741     harmsja  6440: }
1.795     www      6441: 
1.897     wenzelju 6442: ul#LC_secondary_menu li a {
1.911     bisitz   6443:   color: $fontmenu;
                   6444:   text-decoration: none;
1.693     droeschl 6445: }
1.795     www      6446: 
1.721     harmsja  6447: ul.LC_TabContent {
1.952     onken    6448:   min-height:20px;
1.721     harmsja  6449: }
1.795     www      6450: 
                   6451: ul.LC_TabContent li {
1.911     bisitz   6452:   vertical-align:middle;
1.959     onken    6453:   padding: 0 16px 0 10px;
1.911     bisitz   6454:   background-color:$tabbg;
                   6455:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  6456:   border-left: solid 1px $font;
1.721     harmsja  6457: }
1.795     www      6458: 
1.847     tempelho 6459: ul.LC_TabContent .right {
1.911     bisitz   6460:   float:right;
1.847     tempelho 6461: }
                   6462: 
1.911     bisitz   6463: ul.LC_TabContent li a,
                   6464: ul.LC_TabContent li {
                   6465:   color:rgb(47,47,47);
                   6466:   text-decoration:none;
                   6467:   font-size:95%;
                   6468:   font-weight:bold;
1.952     onken    6469:   min-height:20px;
                   6470: }
                   6471: 
1.959     onken    6472: ul.LC_TabContent li a:hover,
                   6473: ul.LC_TabContent li a:focus {
1.952     onken    6474:   color: $button_hover;
1.959     onken    6475:   background:none;
                   6476:   outline:none;
1.952     onken    6477: }
                   6478: 
                   6479: ul.LC_TabContent li:hover {
                   6480:   color: $button_hover;
                   6481:   cursor:pointer;
1.721     harmsja  6482: }
1.795     www      6483: 
1.911     bisitz   6484: ul.LC_TabContent li.active {
1.952     onken    6485:   color: $font;
1.911     bisitz   6486:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    6487:   border-bottom:solid 1px #FFFFFF;
                   6488:   cursor: default;
1.744     ehlerst  6489: }
1.795     www      6490: 
1.959     onken    6491: ul.LC_TabContent li.active a {
                   6492:   color:$font;
                   6493:   background:#FFFFFF;
                   6494:   outline: none;
                   6495: }
1.1047    raeburn  6496: 
                   6497: ul.LC_TabContent li.goback {
                   6498:   float: left;
                   6499:   border-left: none;
                   6500: }
                   6501: 
1.870     tempelho 6502: #maincoursedoc {
1.911     bisitz   6503:   clear:both;
1.870     tempelho 6504: }
                   6505: 
                   6506: ul.LC_TabContentBigger {
1.911     bisitz   6507:   display:block;
                   6508:   list-style:none;
                   6509:   padding: 0;
1.870     tempelho 6510: }
                   6511: 
1.795     www      6512: ul.LC_TabContentBigger li {
1.911     bisitz   6513:   vertical-align:bottom;
                   6514:   height: 30px;
                   6515:   font-size:110%;
                   6516:   font-weight:bold;
                   6517:   color: #737373;
1.841     tempelho 6518: }
                   6519: 
1.957     onken    6520: ul.LC_TabContentBigger li.active {
                   6521:   position: relative;
                   6522:   top: 1px;
                   6523: }
                   6524: 
1.870     tempelho 6525: ul.LC_TabContentBigger li a {
1.911     bisitz   6526:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6527:   height: 30px;
                   6528:   line-height: 30px;
                   6529:   text-align: center;
                   6530:   display: block;
                   6531:   text-decoration: none;
1.958     onken    6532:   outline: none;  
1.741     harmsja  6533: }
1.795     www      6534: 
1.870     tempelho 6535: ul.LC_TabContentBigger li.active a {
1.911     bisitz   6536:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   6537:   color:$font;
1.744     ehlerst  6538: }
1.795     www      6539: 
1.870     tempelho 6540: ul.LC_TabContentBigger li b {
1.911     bisitz   6541:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6542:   display: block;
                   6543:   float: left;
                   6544:   padding: 0 30px;
1.957     onken    6545:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 6546: }
                   6547: 
1.956     onken    6548: ul.LC_TabContentBigger li:hover b {
                   6549:   color:$button_hover;
                   6550: }
                   6551: 
1.870     tempelho 6552: ul.LC_TabContentBigger li.active b {
1.911     bisitz   6553:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6554:   color:$font;
1.957     onken    6555:   border: 0;
1.741     harmsja  6556: }
1.693     droeschl 6557: 
1.870     tempelho 6558: 
1.862     bisitz   6559: ul.LC_CourseBreadcrumbs {
                   6560:   background: $sidebg;
1.1020    raeburn  6561:   height: 2em;
1.862     bisitz   6562:   padding-left: 10px;
1.1020    raeburn  6563:   margin: 0;
1.862     bisitz   6564:   list-style-position: inside;
                   6565: }
                   6566: 
1.911     bisitz   6567: ol#LC_MenuBreadcrumbs,
1.862     bisitz   6568: ol#LC_PathBreadcrumbs {
1.911     bisitz   6569:   padding-left: 10px;
                   6570:   margin: 0;
1.933     droeschl 6571:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 6572: }
                   6573: 
1.911     bisitz   6574: ol#LC_MenuBreadcrumbs li,
                   6575: ol#LC_PathBreadcrumbs li,
1.862     bisitz   6576: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   6577:   display: inline;
1.933     droeschl 6578:   white-space: normal;  
1.693     droeschl 6579: }
                   6580: 
1.823     bisitz   6581: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6582: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   6583:   text-decoration: none;
                   6584:   font-size:90%;
1.693     droeschl 6585: }
1.795     www      6586: 
1.969     droeschl 6587: ol#LC_MenuBreadcrumbs h1 {
                   6588:   display: inline;
                   6589:   font-size: 90%;
                   6590:   line-height: 2.5em;
                   6591:   margin: 0;
                   6592:   padding: 0;
                   6593: }
                   6594: 
1.795     www      6595: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   6596:   text-decoration:none;
                   6597:   font-size:100%;
                   6598:   font-weight:bold;
1.693     droeschl 6599: }
1.795     www      6600: 
1.840     bisitz   6601: .LC_Box {
1.911     bisitz   6602:   border: solid 1px $lg_border_color;
                   6603:   padding: 0 10px 10px 10px;
1.746     neumanie 6604: }
1.795     www      6605: 
1.1020    raeburn  6606: .LC_DocsBox {
                   6607:   border: solid 1px $lg_border_color;
                   6608:   padding: 0 0 10px 10px;
                   6609: }
                   6610: 
1.795     www      6611: .LC_AboutMe_Image {
1.911     bisitz   6612:   float:left;
                   6613:   margin-right:10px;
1.747     neumanie 6614: }
1.795     www      6615: 
                   6616: .LC_Clear_AboutMe_Image {
1.911     bisitz   6617:   clear:left;
1.747     neumanie 6618: }
1.795     www      6619: 
1.721     harmsja  6620: dl.LC_ListStyleClean dt {
1.911     bisitz   6621:   padding-right: 5px;
                   6622:   display: table-header-group;
1.693     droeschl 6623: }
                   6624: 
1.721     harmsja  6625: dl.LC_ListStyleClean dd {
1.911     bisitz   6626:   display: table-row;
1.693     droeschl 6627: }
                   6628: 
1.721     harmsja  6629: .LC_ListStyleClean,
                   6630: .LC_ListStyleSimple,
                   6631: .LC_ListStyleNormal,
1.795     www      6632: .LC_ListStyleSpecial {
1.911     bisitz   6633:   /* display:block; */
                   6634:   list-style-position: inside;
                   6635:   list-style-type: none;
                   6636:   overflow: hidden;
                   6637:   padding: 0;
1.693     droeschl 6638: }
                   6639: 
1.721     harmsja  6640: .LC_ListStyleSimple li,
                   6641: .LC_ListStyleSimple dd,
                   6642: .LC_ListStyleNormal li,
                   6643: .LC_ListStyleNormal dd,
                   6644: .LC_ListStyleSpecial li,
1.795     www      6645: .LC_ListStyleSpecial dd {
1.911     bisitz   6646:   margin: 0;
                   6647:   padding: 5px 5px 5px 10px;
                   6648:   clear: both;
1.693     droeschl 6649: }
                   6650: 
1.721     harmsja  6651: .LC_ListStyleClean li,
                   6652: .LC_ListStyleClean dd {
1.911     bisitz   6653:   padding-top: 0;
                   6654:   padding-bottom: 0;
1.693     droeschl 6655: }
                   6656: 
1.721     harmsja  6657: .LC_ListStyleSimple dd,
1.795     www      6658: .LC_ListStyleSimple li {
1.911     bisitz   6659:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6660: }
                   6661: 
1.721     harmsja  6662: .LC_ListStyleSpecial li,
                   6663: .LC_ListStyleSpecial dd {
1.911     bisitz   6664:   list-style-type: none;
                   6665:   background-color: RGB(220, 220, 220);
                   6666:   margin-bottom: 4px;
1.693     droeschl 6667: }
                   6668: 
1.721     harmsja  6669: table.LC_SimpleTable {
1.911     bisitz   6670:   margin:5px;
                   6671:   border:solid 1px $lg_border_color;
1.795     www      6672: }
1.693     droeschl 6673: 
1.721     harmsja  6674: table.LC_SimpleTable tr {
1.911     bisitz   6675:   padding: 0;
                   6676:   border:solid 1px $lg_border_color;
1.693     droeschl 6677: }
1.795     www      6678: 
                   6679: table.LC_SimpleTable thead {
1.911     bisitz   6680:   background:rgb(220,220,220);
1.693     droeschl 6681: }
                   6682: 
1.721     harmsja  6683: div.LC_columnSection {
1.911     bisitz   6684:   display: block;
                   6685:   clear: both;
                   6686:   overflow: hidden;
                   6687:   margin: 0;
1.693     droeschl 6688: }
                   6689: 
1.721     harmsja  6690: div.LC_columnSection>* {
1.911     bisitz   6691:   float: left;
                   6692:   margin: 10px 20px 10px 0;
                   6693:   overflow:hidden;
1.693     droeschl 6694: }
1.721     harmsja  6695: 
1.795     www      6696: table em {
1.911     bisitz   6697:   font-weight: bold;
                   6698:   font-style: normal;
1.748     schulted 6699: }
1.795     www      6700: 
1.779     bisitz   6701: table.LC_tableBrowseRes,
1.795     www      6702: table.LC_tableOfContent {
1.911     bisitz   6703:   border:none;
                   6704:   border-spacing: 1px;
                   6705:   padding: 3px;
                   6706:   background-color: #FFFFFF;
                   6707:   font-size: 90%;
1.753     droeschl 6708: }
1.789     droeschl 6709: 
1.911     bisitz   6710: table.LC_tableOfContent {
                   6711:   border-collapse: collapse;
1.789     droeschl 6712: }
                   6713: 
1.771     droeschl 6714: table.LC_tableBrowseRes a,
1.768     schulted 6715: table.LC_tableOfContent a {
1.911     bisitz   6716:   background-color: transparent;
                   6717:   text-decoration: none;
1.753     droeschl 6718: }
                   6719: 
1.795     www      6720: table.LC_tableOfContent img {
1.911     bisitz   6721:   border: none;
                   6722:   height: 1.3em;
                   6723:   vertical-align: text-bottom;
                   6724:   margin-right: 0.3em;
1.753     droeschl 6725: }
1.757     schulted 6726: 
1.795     www      6727: a#LC_content_toolbar_firsthomework {
1.911     bisitz   6728:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  6729: }
                   6730: 
1.795     www      6731: a#LC_content_toolbar_everything {
1.911     bisitz   6732:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  6733: }
                   6734: 
1.795     www      6735: a#LC_content_toolbar_uncompleted {
1.911     bisitz   6736:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  6737: }
                   6738: 
1.795     www      6739: #LC_content_toolbar_clearbubbles {
1.911     bisitz   6740:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  6741: }
                   6742: 
1.795     www      6743: a#LC_content_toolbar_changefolder {
1.911     bisitz   6744:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 6745: }
                   6746: 
1.795     www      6747: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   6748:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 6749: }
                   6750: 
1.1043    raeburn  6751: a#LC_content_toolbar_edittoplevel {
                   6752:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   6753: }
                   6754: 
1.795     www      6755: ul#LC_toolbar li a:hover {
1.911     bisitz   6756:   background-position: bottom center;
1.757     schulted 6757: }
                   6758: 
1.795     www      6759: ul#LC_toolbar {
1.911     bisitz   6760:   padding: 0;
                   6761:   margin: 2px;
                   6762:   list-style:none;
                   6763:   position:relative;
                   6764:   background-color:white;
1.757     schulted 6765: }
                   6766: 
1.795     www      6767: ul#LC_toolbar li {
1.911     bisitz   6768:   border:1px solid white;
                   6769:   padding: 0;
                   6770:   margin: 0;
                   6771:   float: left;
                   6772:   display:inline;
                   6773:   vertical-align:middle;
                   6774: }
1.757     schulted 6775: 
1.783     amueller 6776: 
1.795     www      6777: a.LC_toolbarItem {
1.911     bisitz   6778:   display:block;
                   6779:   padding: 0;
                   6780:   margin: 0;
                   6781:   height: 32px;
                   6782:   width: 32px;
                   6783:   color:white;
                   6784:   border: none;
                   6785:   background-repeat:no-repeat;
                   6786:   background-color:transparent;
1.757     schulted 6787: }
                   6788: 
1.915     droeschl 6789: ul.LC_funclist {
                   6790:     margin: 0;
                   6791:     padding: 0.5em 1em 0.5em 0;
                   6792: }
                   6793: 
1.933     droeschl 6794: ul.LC_funclist > li:first-child {
                   6795:     font-weight:bold; 
                   6796:     margin-left:0.8em;
                   6797: }
                   6798: 
1.915     droeschl 6799: ul.LC_funclist + ul.LC_funclist {
                   6800:     /* 
                   6801:        left border as a seperator if we have more than
                   6802:        one list 
                   6803:     */
                   6804:     border-left: 1px solid $sidebg;
                   6805:     /* 
                   6806:        this hides the left border behind the border of the 
                   6807:        outer box if element is wrapped to the next 'line' 
                   6808:     */
                   6809:     margin-left: -1px;
                   6810: }
                   6811: 
1.843     bisitz   6812: ul.LC_funclist li {
1.915     droeschl 6813:   display: inline;
1.782     bisitz   6814:   white-space: nowrap;
1.915     droeschl 6815:   margin: 0 0 0 25px;
                   6816:   line-height: 150%;
1.782     bisitz   6817: }
                   6818: 
1.974     wenzelju 6819: .LC_hidden {
                   6820:   display: none;
                   6821: }
                   6822: 
1.1030    www      6823: .LCmodal-overlay {
                   6824: 		position:fixed;
                   6825: 		top:0;
                   6826: 		right:0;
                   6827: 		bottom:0;
                   6828: 		left:0;
                   6829: 		height:100%;
                   6830: 		width:100%;
                   6831: 		margin:0;
                   6832: 		padding:0;
                   6833: 		background:#999;
                   6834: 		opacity:.75;
                   6835: 		filter: alpha(opacity=75);
                   6836: 		-moz-opacity: 0.75;
                   6837: 		z-index:101;
                   6838: }
                   6839: 
                   6840: * html .LCmodal-overlay {   
                   6841: 		position: absolute;
                   6842: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   6843: }
                   6844: 
                   6845: .LCmodal-window {
                   6846: 		position:fixed;
                   6847: 		top:50%;
                   6848: 		left:50%;
                   6849: 		margin:0;
                   6850: 		padding:0;
                   6851: 		z-index:102;
                   6852: 	}
                   6853: 
                   6854: * html .LCmodal-window {
                   6855: 		position:absolute;
                   6856: }
                   6857: 
                   6858: .LCclose-window {
                   6859: 		position:absolute;
                   6860: 		width:32px;
                   6861: 		height:32px;
                   6862: 		right:8px;
                   6863: 		top:8px;
                   6864: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   6865: 		text-indent:-99999px;
                   6866: 		overflow:hidden;
                   6867: 		cursor:pointer;
                   6868: }
                   6869: 
1.343     albertel 6870: END
                   6871: }
                   6872: 
1.306     albertel 6873: =pod
                   6874: 
                   6875: =item * &headtag()
                   6876: 
                   6877: Returns a uniform footer for LON-CAPA web pages.
                   6878: 
1.307     albertel 6879: Inputs: $title - optional title for the head
                   6880:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6881:         $args - optional arguments
1.319     albertel 6882:             force_register - if is true call registerurl so the remote is 
                   6883:                              informed
1.415     albertel 6884:             redirect       -> array ref of
                   6885:                                    1- seconds before redirect occurs
                   6886:                                    2- url to redirect to
                   6887:                                    3- whether the side effect should occur
1.315     albertel 6888:                            (side effect of setting 
                   6889:                                $env{'internal.head.redirect'} to the url 
                   6890:                                redirected too)
1.352     albertel 6891:             domain         -> force to color decorate a page for a specific
                   6892:                                domain
                   6893:             function       -> force usage of a specific rolish color scheme
                   6894:             bgcolor        -> override the default page bgcolor
1.460     albertel 6895:             no_auto_mt_title
                   6896:                            -> prevent &mt()ing the title arg
1.464     albertel 6897: 
1.306     albertel 6898: =cut
                   6899: 
                   6900: sub headtag {
1.313     albertel 6901:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6902:     
1.363     albertel 6903:     my $function = $args->{'function'} || &get_users_function();
                   6904:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6905:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6906:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6907: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6908: 		   #time(),
1.418     albertel 6909: 		   $env{'environment.color.timestamp'},
1.363     albertel 6910: 		   $function,$domain,$bgcolor);
                   6911: 
1.369     www      6912:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6913: 
1.308     albertel 6914:     my $result =
                   6915: 	'<head>'.
1.461     albertel 6916: 	&font_settings();
1.319     albertel 6917: 
1.461     albertel 6918:     if (!$args->{'frameset'}) {
                   6919: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6920:     }
1.962     droeschl 6921:     if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
                   6922:         $result .= Apache::lonxml::display_title();
1.319     albertel 6923:     }
1.436     albertel 6924:     if (!$args->{'no_nav_bar'} 
                   6925: 	&& !$args->{'only_body'}
                   6926: 	&& !$args->{'frameset'}) {
                   6927: 	$result .= &help_menu_js();
1.1032    www      6928:         $result.=&modal_window();
1.1038    www      6929:         $result.=&togglebox_script();
1.1034    www      6930:         $result.=&wishlist_window();
1.1041    www      6931:         $result.=&LCprogressbarUpdate_script();
1.1034    www      6932:     } else {
                   6933:         if ($args->{'add_modal'}) {
                   6934:            $result.=&modal_window();
                   6935:         }
                   6936:         if ($args->{'add_wishlist'}) {
                   6937:            $result.=&wishlist_window();
                   6938:         }
1.1038    www      6939:         if ($args->{'add_togglebox'}) {
                   6940:            $result.=&togglebox_script();
                   6941:         }
1.1041    www      6942:         if ($args->{'add_progressbar'}) {
                   6943:            $result.=&LCprogressbarUpdate_script();
                   6944:         }
1.436     albertel 6945:     }
1.314     albertel 6946:     if (ref($args->{'redirect'})) {
1.414     albertel 6947: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6948: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6949: 	if (!$inhibit_continue) {
                   6950: 	    $env{'internal.head.redirect'} = $url;
                   6951: 	}
1.313     albertel 6952: 	$result.=<<ADDMETA
                   6953: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6954: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6955: ADDMETA
                   6956:     }
1.306     albertel 6957:     if (!defined($title)) {
                   6958: 	$title = 'The LearningOnline Network with CAPA';
                   6959:     }
1.460     albertel 6960:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6961:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6962: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6963: 	.$head_extra;
1.962     droeschl 6964:     return $result.'</head>';
1.306     albertel 6965: }
                   6966: 
                   6967: =pod
                   6968: 
1.340     albertel 6969: =item * &font_settings()
                   6970: 
                   6971: Returns neccessary <meta> to set the proper encoding
                   6972: 
                   6973: Inputs: none
                   6974: 
                   6975: =cut
                   6976: 
                   6977: sub font_settings {
                   6978:     my $headerstring='';
1.647     www      6979:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6980: 	$headerstring.=
                   6981: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6982:     }
                   6983:     return $headerstring;
                   6984: }
                   6985: 
1.341     albertel 6986: =pod
                   6987: 
                   6988: =item * &xml_begin()
                   6989: 
                   6990: Returns the needed doctype and <html>
                   6991: 
                   6992: Inputs: none
                   6993: 
                   6994: =cut
                   6995: 
                   6996: sub xml_begin {
                   6997:     my $output='';
                   6998: 
                   6999:     if ($env{'browser.mathml'}) {
                   7000: 	$output='<?xml version="1.0"?>'
                   7001:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   7002: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   7003:             
                   7004: #	    .'<!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">] >'
                   7005: 	    .'<!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">'
                   7006:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   7007: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   7008:     } else {
1.849     bisitz   7009: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   7010:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 7011:     }
                   7012:     return $output;
                   7013: }
1.340     albertel 7014: 
                   7015: =pod
                   7016: 
1.306     albertel 7017: =item * &start_page()
                   7018: 
                   7019: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   7020: 
1.648     raeburn  7021: Inputs:
                   7022: 
                   7023: =over 4
                   7024: 
                   7025: $title - optional title for the page
                   7026: 
                   7027: $head_extra - optional extra HTML to incude inside the <head>
                   7028: 
                   7029: $args - additional optional args supported are:
                   7030: 
                   7031: =over 8
                   7032: 
                   7033:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 7034:                                     arg on
1.814     bisitz   7035:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  7036:              add_entries    -> additional attributes to add to the  <body>
                   7037:              domain         -> force to color decorate a page for a 
1.317     albertel 7038:                                     specific domain
1.648     raeburn  7039:              function       -> force usage of a specific rolish color
1.317     albertel 7040:                                     scheme
1.648     raeburn  7041:              redirect       -> see &headtag()
                   7042:              bgcolor        -> override the default page bg color
                   7043:              js_ready       -> return a string ready for being used in 
1.317     albertel 7044:                                     a javascript writeln
1.648     raeburn  7045:              html_encode    -> return a string ready for being used in 
1.320     albertel 7046:                                     a html attribute
1.648     raeburn  7047:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 7048:                                     $forcereg arg
1.648     raeburn  7049:              frameset       -> if true will start with a <frameset>
1.330     albertel 7050:                                     rather than <body>
1.648     raeburn  7051:              skip_phases    -> hash ref of 
1.338     albertel 7052:                                     head -> skip the <html><head> generation
                   7053:                                     body -> skip all <body> generation
1.648     raeburn  7054:              no_auto_mt_title -> prevent &mt()ing the title arg
                   7055:              inherit_jsmath -> when creating popup window in a page,
                   7056:                                     should it have jsmath forced on by the
                   7057:                                     current page
1.867     kalberla 7058:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  7059:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 7060: 
1.648     raeburn  7061: =back
1.460     albertel 7062: 
1.648     raeburn  7063: =back
1.562     albertel 7064: 
1.306     albertel 7065: =cut
                   7066: 
                   7067: sub start_page {
1.309     albertel 7068:     my ($title,$head_extra,$args) = @_;
1.318     albertel 7069:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 7070: 
1.315     albertel 7071:     $env{'internal.start_page'}++;
1.338     albertel 7072:     my $result;
1.964     droeschl 7073: 
1.338     albertel 7074:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030    www      7075:         $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338     albertel 7076:     }
                   7077:     
                   7078:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   7079: 	if ($args->{'frameset'}) {
                   7080: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   7081: 						$args->{'add_entries'});
                   7082: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   7083:         } else {
                   7084:             $result .=
                   7085:                 &bodytag($title, 
                   7086:                          $args->{'function'},       $args->{'add_entries'},
                   7087:                          $args->{'only_body'},      $args->{'domain'},
                   7088:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.962     droeschl 7089:                          $args->{'bgcolor'},        $args);
1.831     bisitz   7090:         }
1.330     albertel 7091:     }
1.338     albertel 7092: 
1.315     albertel 7093:     if ($args->{'js_ready'}) {
1.713     kaisler  7094: 		$result = &js_ready($result);
1.315     albertel 7095:     }
1.320     albertel 7096:     if ($args->{'html_encode'}) {
1.713     kaisler  7097: 		$result = &html_encode($result);
                   7098:     }
                   7099: 
1.813     bisitz   7100:     # Preparation for new and consistent functionlist at top of screen
                   7101:     # if ($args->{'functionlist'}) {
                   7102:     #            $result .= &build_functionlist();
                   7103:     #}
                   7104: 
1.964     droeschl 7105:     # Don't add anything more if only_body wanted or in const space
                   7106:     return $result if    $args->{'only_body'} 
                   7107:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   7108: 
                   7109:     #Breadcrumbs
1.758     kaisler  7110:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   7111: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   7112: 		#if any br links exists, add them to the breadcrumbs
                   7113: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   7114: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   7115: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   7116: 			}
                   7117: 		}
                   7118: 
                   7119: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   7120: 		if(exists($args->{'bread_crumbs_component'})){
                   7121: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   7122: 		}else{
                   7123: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   7124: 		}
1.320     albertel 7125:     }
1.315     albertel 7126:     return $result;
1.306     albertel 7127: }
                   7128: 
                   7129: sub end_page {
1.315     albertel 7130:     my ($args) = @_;
                   7131:     $env{'internal.end_page'}++;
1.330     albertel 7132:     my $result;
1.335     albertel 7133:     if ($args->{'discussion'}) {
                   7134: 	my ($target,$parser);
                   7135: 	if (ref($args->{'discussion'})) {
                   7136: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   7137: 				$args->{'discussion'}{'parser'});
                   7138: 	}
                   7139: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   7140:     }
1.330     albertel 7141:     if ($args->{'frameset'}) {
                   7142: 	$result .= '</frameset>';
                   7143:     } else {
1.635     raeburn  7144: 	$result .= &endbodytag($args);
1.330     albertel 7145:     }
                   7146:     $result .= "\n</html>";
                   7147: 
1.315     albertel 7148:     if ($args->{'js_ready'}) {
1.317     albertel 7149: 	$result = &js_ready($result);
1.315     albertel 7150:     }
1.335     albertel 7151: 
1.320     albertel 7152:     if ($args->{'html_encode'}) {
                   7153: 	$result = &html_encode($result);
                   7154:     }
1.335     albertel 7155: 
1.315     albertel 7156:     return $result;
                   7157: }
                   7158: 
1.1034    www      7159: sub wishlist_window {
                   7160:     return(<<'ENDWISHLIST');
1.1046    raeburn  7161: <script type="text/javascript">
1.1034    www      7162: // <![CDATA[
                   7163: // <!-- BEGIN LON-CAPA Internal
                   7164: function set_wishlistlink(title, path) {
                   7165:     if (!title) {
                   7166:         title = document.title;
                   7167:         title = title.replace(/^LON-CAPA /,'');
                   7168:     }
                   7169:     if (!path) {
                   7170:         path = location.pathname;
                   7171:     }
                   7172:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   7173:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   7174: }
                   7175: // END LON-CAPA Internal -->
                   7176: // ]]>
                   7177: </script>
                   7178: ENDWISHLIST
                   7179: }
                   7180: 
1.1030    www      7181: sub modal_window {
                   7182:     return(<<'ENDMODAL');
1.1046    raeburn  7183: <script type="text/javascript">
1.1030    www      7184: // <![CDATA[
                   7185: // <!-- BEGIN LON-CAPA Internal
                   7186: var modalWindow = {
                   7187: 	parent:"body",
                   7188: 	windowId:null,
                   7189: 	content:null,
                   7190: 	width:null,
                   7191: 	height:null,
                   7192: 	close:function()
                   7193: 	{
                   7194: 	        $(".LCmodal-window").remove();
                   7195: 	        $(".LCmodal-overlay").remove();
                   7196: 	},
                   7197: 	open:function()
                   7198: 	{
                   7199: 		var modal = "";
                   7200: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   7201: 		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;\">";
                   7202: 		modal += this.content;
                   7203: 		modal += "</div>";	
                   7204: 
                   7205: 		$(this.parent).append(modal);
                   7206: 
                   7207: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   7208: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   7209: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   7210: 	}
                   7211: };
1.1031    www      7212: 	var openMyModal = function(source,width,height,scrolling)
1.1030    www      7213: 	{
                   7214: 		modalWindow.windowId = "myModal";
                   7215: 		modalWindow.width = width;
                   7216: 		modalWindow.height = height;
1.1031    www      7217: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='true' src='" + source + "'>&lt/iframe>";
1.1030    www      7218: 		modalWindow.open();
                   7219: 	};	
                   7220: // END LON-CAPA Internal -->
                   7221: // ]]>
                   7222: </script>
                   7223: ENDMODAL
                   7224: }
                   7225: 
                   7226: sub modal_link {
1.1052    www      7227:     my ($link,$linktext,$width,$height,$target,$scrolling,$title)=@_;
1.1030    www      7228:     unless ($width) { $width=480; }
                   7229:     unless ($height) { $height=400; }
1.1031    www      7230:     unless ($scrolling) { $scrolling='yes'; }
1.1052    www      7231:     return '<a href="'.$link.'" target="'.$target.'" title="'.$title.'" onclick="openMyModal(\''.$link.'\','.$width.','.$height.',\''.$scrolling.'\'); return false;">'.
1.1031    www      7232:            $linktext.'</a>';
1.1030    www      7233: }
                   7234: 
1.1032    www      7235: sub modal_adhoc_script {
                   7236:     my ($funcname,$width,$height,$content)=@_;
                   7237:     return (<<ENDADHOC);
1.1046    raeburn  7238: <script type="text/javascript">
1.1032    www      7239: // <![CDATA[
                   7240:         var $funcname = function()
                   7241:         {
                   7242:                 modalWindow.windowId = "myModal";
                   7243:                 modalWindow.width = $width;
                   7244:                 modalWindow.height = $height;
                   7245:                 modalWindow.content = '$content';
                   7246:                 modalWindow.open();
                   7247:         };  
                   7248: // ]]>
                   7249: </script>
                   7250: ENDADHOC
                   7251: }
                   7252: 
1.1041    www      7253: sub modal_adhoc_inner {
                   7254:     my ($funcname,$width,$height,$content)=@_;
                   7255:     my $innerwidth=$width-20;
                   7256:     $content=&js_ready(
1.1042    www      7257:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1041    www      7258:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px').
                   7259:                     $content.
                   7260:                  &end_scrollbox().
                   7261:                &end_page()
                   7262:              );
                   7263:     return &modal_adhoc_script($funcname,$width,$height,$content);
                   7264: }
                   7265: 
                   7266: sub modal_adhoc_window {
                   7267:     my ($funcname,$width,$height,$content,$linktext)=@_;
                   7268:     return &modal_adhoc_inner($funcname,$width,$height,$content).
                   7269:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   7270: }
                   7271: 
                   7272: sub modal_adhoc_launch {
                   7273:     my ($funcname,$width,$height,$content)=@_;
                   7274:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   7275: <script type="text/javascript">
                   7276: // <![CDATA[
                   7277: $funcname();
                   7278: // ]]>
                   7279: </script>
                   7280: ENDLAUNCH
                   7281: }
                   7282: 
                   7283: sub modal_adhoc_close {
                   7284:     return (<<ENDCLOSE);
                   7285: <script type="text/javascript">
                   7286: // <![CDATA[
                   7287: modalWindow.close();
                   7288: // ]]>
                   7289: </script>
                   7290: ENDCLOSE
                   7291: }
                   7292: 
1.1038    www      7293: sub togglebox_script {
                   7294:    return(<<ENDTOGGLE);
                   7295: <script type="text/javascript"> 
                   7296: // <![CDATA[
                   7297: function LCtoggleDisplay(id,hidetext,showtext) {
                   7298:    link = document.getElementById(id + "link").childNodes[0];
                   7299:    with (document.getElementById(id).style) {
                   7300:       if (display == "none" ) {
                   7301:           display = "inline";
                   7302:           link.nodeValue = hidetext;
                   7303:         } else {
                   7304:           display = "none";
                   7305:           link.nodeValue = showtext;
                   7306:        }
                   7307:    }
                   7308: }
                   7309: // ]]>
                   7310: </script>
                   7311: ENDTOGGLE
                   7312: }
                   7313: 
1.1039    www      7314: sub start_togglebox {
                   7315:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   7316:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   7317:     unless ($showtext) { $showtext=&mt('show'); }
                   7318:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   7319:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   7320:     return &start_data_table().
                   7321:            &start_data_table_header_row().
                   7322:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   7323:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   7324:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   7325:            &end_data_table_header_row().
                   7326:            '<tr id="'.$id.'" style="display:none""><td>';
                   7327: }
                   7328: 
                   7329: sub end_togglebox {
                   7330:     return '</td></tr>'.&end_data_table();
                   7331: }
                   7332: 
1.1041    www      7333: sub LCprogressbar_script {
1.1045    www      7334:    my ($id)=@_;
1.1041    www      7335:    return(<<ENDPROGRESS);
                   7336: <script type="text/javascript">
                   7337: // <![CDATA[
1.1045    www      7338: \$('#progressbar$id').progressbar({
1.1041    www      7339:   value: 0,
                   7340:   change: function(event, ui) {
                   7341:     var newVal = \$(this).progressbar('option', 'value');
                   7342:     \$('.pblabel', this).text(LCprogressTxt);
                   7343:   }
                   7344: });
                   7345: // ]]>
                   7346: </script>
                   7347: ENDPROGRESS
                   7348: }
                   7349: 
                   7350: sub LCprogressbarUpdate_script {
                   7351:    return(<<ENDPROGRESSUPDATE);
                   7352: <style type="text/css">
                   7353: .ui-progressbar { position:relative; }
                   7354: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   7355: </style>
                   7356: <script type="text/javascript">
                   7357: // <![CDATA[
1.1045    www      7358: var LCprogressTxt='---';
                   7359: 
                   7360: function LCupdateProgress(percent,progresstext,id) {
1.1041    www      7361:    LCprogressTxt=progresstext;
1.1045    www      7362:    \$('#progressbar'+id).progressbar('value',percent);
1.1041    www      7363: }
                   7364: // ]]>
                   7365: </script>
                   7366: ENDPROGRESSUPDATE
                   7367: }
                   7368: 
1.1042    www      7369: my $LClastpercent;
1.1045    www      7370: my $LCidcnt;
                   7371: my $LCcurrentid;
1.1042    www      7372: 
1.1041    www      7373: sub LCprogressbar {
1.1042    www      7374:     my ($r)=(@_);
                   7375:     $LClastpercent=0;
1.1045    www      7376:     $LCidcnt++;
                   7377:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1041    www      7378:     my $starting=&mt('Starting');
                   7379:     my $content=(<<ENDPROGBAR);
                   7380: <p>
1.1045    www      7381:   <div id="progressbar$LCcurrentid">
1.1041    www      7382:     <span class="pblabel">$starting</span>
                   7383:   </div>
                   7384: </p>
                   7385: ENDPROGBAR
1.1045    www      7386:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041    www      7387: }
                   7388: 
                   7389: sub LCprogressbarUpdate {
1.1042    www      7390:     my ($r,$val,$text)=@_;
                   7391:     unless ($val) { 
                   7392:        if ($LClastpercent) {
                   7393:            $val=$LClastpercent;
                   7394:        } else {
                   7395:            $val=0;
                   7396:        }
                   7397:     }
1.1041    www      7398:     if ($val<0) { $val=0; }
                   7399:     if ($val>100) { $val=0; }
1.1042    www      7400:     $LClastpercent=$val;
1.1041    www      7401:     unless ($text) { $text=$val.'%'; }
                   7402:     $text=&js_ready($text);
1.1044    www      7403:     &r_print($r,<<ENDUPDATE);
1.1041    www      7404: <script type="text/javascript">
                   7405: // <![CDATA[
1.1045    www      7406: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041    www      7407: // ]]>
                   7408: </script>
                   7409: ENDUPDATE
1.1035    www      7410: }
                   7411: 
1.1042    www      7412: sub LCprogressbarClose {
                   7413:     my ($r)=@_;
                   7414:     $LClastpercent=0;
1.1044    www      7415:     &r_print($r,<<ENDCLOSE);
1.1042    www      7416: <script type="text/javascript">
                   7417: // <![CDATA[
1.1045    www      7418: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      7419: // ]]>
                   7420: </script>
                   7421: ENDCLOSE
1.1044    www      7422: }
                   7423: 
                   7424: sub r_print {
                   7425:     my ($r,$to_print)=@_;
                   7426:     if ($r) {
                   7427:       $r->print($to_print);
                   7428:       $r->rflush();
                   7429:     } else {
                   7430:       print($to_print);
                   7431:     }
1.1042    www      7432: }
                   7433: 
1.320     albertel 7434: sub html_encode {
                   7435:     my ($result) = @_;
                   7436: 
1.322     albertel 7437:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 7438:     
                   7439:     return $result;
                   7440: }
1.1044    www      7441: 
1.317     albertel 7442: sub js_ready {
                   7443:     my ($result) = @_;
                   7444: 
1.323     albertel 7445:     $result =~ s/[\n\r]/ /xmsg;
                   7446:     $result =~ s/\\/\\\\/xmsg;
                   7447:     $result =~ s/'/\\'/xmsg;
1.372     albertel 7448:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 7449:     
                   7450:     return $result;
                   7451: }
                   7452: 
1.315     albertel 7453: sub validate_page {
                   7454:     if (  exists($env{'internal.start_page'})
1.316     albertel 7455: 	  &&     $env{'internal.start_page'} > 1) {
                   7456: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 7457: 				 $env{'internal.start_page'}.' '.
1.316     albertel 7458: 				 $ENV{'request.filename'});
1.315     albertel 7459:     }
                   7460:     if (  exists($env{'internal.end_page'})
1.316     albertel 7461: 	  &&     $env{'internal.end_page'} > 1) {
                   7462: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 7463: 				 $env{'internal.end_page'}.' '.
1.316     albertel 7464: 				 $env{'request.filename'});
1.315     albertel 7465:     }
                   7466:     if (     exists($env{'internal.start_page'})
                   7467: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 7468: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   7469: 				 $env{'request.filename'});
1.315     albertel 7470:     }
                   7471:     if (   ! exists($env{'internal.start_page'})
                   7472: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 7473: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   7474: 				 $env{'request.filename'});
1.315     albertel 7475:     }
1.306     albertel 7476: }
1.315     albertel 7477: 
1.996     www      7478: 
                   7479: sub start_scrollbox {
1.1018    raeburn  7480:     my ($outerwidth,$width,$height,$id)=@_;
1.998     raeburn  7481:     unless ($outerwidth) { $outerwidth='520px'; }
                   7482:     unless ($width) { $width='500px'; }
                   7483:     unless ($height) { $height='200px'; }
1.1020    raeburn  7484:     my ($table_id,$div_id);
1.1018    raeburn  7485:     if ($id ne '') {
1.1020    raeburn  7486:         $table_id = " id='table_$id'";
                   7487:         $div_id = " id='div_$id'";
1.1018    raeburn  7488:     }
1.1020    raeburn  7489:     return "<table style='width: $outerwidth; border: 1px solid none;'$table_id><tr><td style='width: $width;' bgcolor='#FFFFFF'><div style='overflow:auto; width:$width; height: $height;'$div_id>";
1.996     www      7490: }
                   7491: 
                   7492: sub end_scrollbox {
1.1036    www      7493:     return '</div></td></tr></table>';
1.996     www      7494: }
                   7495: 
1.318     albertel 7496: sub simple_error_page {
                   7497:     my ($r,$title,$msg) = @_;
                   7498:     my $page =
                   7499: 	&Apache::loncommon::start_page($title).
                   7500: 	&mt($msg).
                   7501: 	&Apache::loncommon::end_page();
                   7502:     if (ref($r)) {
                   7503: 	$r->print($page);
1.327     albertel 7504: 	return;
1.318     albertel 7505:     }
                   7506:     return $page;
                   7507: }
1.347     albertel 7508: 
                   7509: {
1.610     albertel 7510:     my @row_count;
1.961     onken    7511: 
                   7512:     sub start_data_table_count {
                   7513:         unshift(@row_count, 0);
                   7514:         return;
                   7515:     }
                   7516: 
                   7517:     sub end_data_table_count {
                   7518:         shift(@row_count);
                   7519:         return;
                   7520:     }
                   7521: 
1.347     albertel 7522:     sub start_data_table {
1.1018    raeburn  7523: 	my ($add_class,$id) = @_;
1.422     albertel 7524: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  7525:         my $table_id;
                   7526:         if (defined($id)) {
                   7527:             $table_id = ' id="'.$id.'"';
                   7528:         }
1.961     onken    7529: 	&start_data_table_count();
1.1018    raeburn  7530: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 7531:     }
                   7532: 
                   7533:     sub end_data_table {
1.961     onken    7534: 	&end_data_table_count();
1.389     albertel 7535: 	return '</table>'."\n";;
1.347     albertel 7536:     }
                   7537: 
                   7538:     sub start_data_table_row {
1.974     wenzelju 7539: 	my ($add_class, $id) = @_;
1.610     albertel 7540: 	$row_count[0]++;
                   7541: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   7542: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 7543:         $id = (' id="'.$id.'"') unless ($id eq '');
                   7544:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 7545:     }
1.471     banghart 7546:     
                   7547:     sub continue_data_table_row {
1.974     wenzelju 7548: 	my ($add_class, $id) = @_;
1.610     albertel 7549: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 7550: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   7551:         $id = (' id="'.$id.'"') unless ($id eq '');
                   7552:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 7553:     }
1.347     albertel 7554: 
                   7555:     sub end_data_table_row {
1.389     albertel 7556: 	return '</tr>'."\n";;
1.347     albertel 7557:     }
1.367     www      7558: 
1.421     albertel 7559:     sub start_data_table_empty_row {
1.707     bisitz   7560: #	$row_count[0]++;
1.421     albertel 7561: 	return  '<tr class="LC_empty_row" >'."\n";;
                   7562:     }
                   7563: 
                   7564:     sub end_data_table_empty_row {
                   7565: 	return '</tr>'."\n";;
                   7566:     }
                   7567: 
1.367     www      7568:     sub start_data_table_header_row {
1.389     albertel 7569: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      7570:     }
                   7571: 
                   7572:     sub end_data_table_header_row {
1.389     albertel 7573: 	return '</tr>'."\n";;
1.367     www      7574:     }
1.890     droeschl 7575: 
                   7576:     sub data_table_caption {
                   7577:         my $caption = shift;
                   7578:         return "<caption class=\"LC_caption\">$caption</caption>";
                   7579:     }
1.347     albertel 7580: }
                   7581: 
1.548     albertel 7582: =pod
                   7583: 
                   7584: =item * &inhibit_menu_check($arg)
                   7585: 
                   7586: Checks for a inhibitmenu state and generates output to preserve it
                   7587: 
                   7588: Inputs:         $arg - can be any of
                   7589:                      - undef - in which case the return value is a string 
                   7590:                                to add  into arguments list of a uri
                   7591:                      - 'input' - in which case the return value is a HTML
                   7592:                                  <form> <input> field of type hidden to
                   7593:                                  preserve the value
                   7594:                      - a url - in which case the return value is the url with
                   7595:                                the neccesary cgi args added to preserve the
                   7596:                                inhibitmenu state
                   7597:                      - a ref to a url - no return value, but the string is
                   7598:                                         updated to include the neccessary cgi
                   7599:                                         args to preserve the inhibitmenu state
                   7600: 
                   7601: =cut
                   7602: 
                   7603: sub inhibit_menu_check {
                   7604:     my ($arg) = @_;
                   7605:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   7606:     if ($arg eq 'input') {
                   7607: 	if ($env{'form.inhibitmenu'}) {
                   7608: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   7609: 	} else {
                   7610: 	    return
                   7611: 	}
                   7612:     }
                   7613:     if ($env{'form.inhibitmenu'}) {
                   7614: 	if (ref($arg)) {
                   7615: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7616: 	} elsif ($arg eq '') {
                   7617: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   7618: 	} else {
                   7619: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7620: 	}
                   7621:     }
                   7622:     if (!ref($arg)) {
                   7623: 	return $arg;
                   7624:     }
                   7625: }
                   7626: 
1.251     albertel 7627: ###############################################
1.182     matthew  7628: 
                   7629: =pod
                   7630: 
1.549     albertel 7631: =back
                   7632: 
                   7633: =head1 User Information Routines
                   7634: 
                   7635: =over 4
                   7636: 
1.405     albertel 7637: =item * &get_users_function()
1.182     matthew  7638: 
                   7639: Used by &bodytag to determine the current users primary role.
                   7640: Returns either 'student','coordinator','admin', or 'author'.
                   7641: 
                   7642: =cut
                   7643: 
                   7644: ###############################################
                   7645: sub get_users_function {
1.815     tempelho 7646:     my $function = 'norole';
1.818     tempelho 7647:     if ($env{'request.role'}=~/^(st)/) {
                   7648:         $function='student';
                   7649:     }
1.907     raeburn  7650:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  7651:         $function='coordinator';
                   7652:     }
1.258     albertel 7653:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  7654:         $function='admin';
                   7655:     }
1.826     bisitz   7656:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  7657:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  7658:         $function='author';
                   7659:     }
                   7660:     return $function;
1.54      www      7661: }
1.99      www      7662: 
                   7663: ###############################################
                   7664: 
1.233     raeburn  7665: =pod
                   7666: 
1.821     raeburn  7667: =item * &show_course()
                   7668: 
                   7669: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   7670: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   7671: 
                   7672: Inputs:
                   7673: None
                   7674: 
                   7675: Outputs:
                   7676: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   7677: 
                   7678: =cut
                   7679: 
                   7680: ###############################################
                   7681: sub show_course {
                   7682:     my $course = !$env{'user.adv'};
                   7683:     if (!$env{'user.adv'}) {
                   7684:         foreach my $env (keys(%env)) {
                   7685:             next if ($env !~ m/^user\.priv\./);
                   7686:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   7687:                 $course = 0;
                   7688:                 last;
                   7689:             }
                   7690:         }
                   7691:     }
                   7692:     return $course;
                   7693: }
                   7694: 
                   7695: ###############################################
                   7696: 
                   7697: =pod
                   7698: 
1.542     raeburn  7699: =item * &check_user_status()
1.274     raeburn  7700: 
                   7701: Determines current status of supplied role for a
                   7702: specific user. Roles can be active, previous or future.
                   7703: 
                   7704: Inputs: 
                   7705: user's domain, user's username, course's domain,
1.375     raeburn  7706: course's number, optional section ID.
1.274     raeburn  7707: 
                   7708: Outputs:
                   7709: role status: active, previous or future. 
                   7710: 
                   7711: =cut
                   7712: 
                   7713: sub check_user_status {
1.412     raeburn  7714:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.982     raeburn  7715:     my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
                   7716:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,$extra);
1.274     raeburn  7717:     my @uroles = keys %userinfo;
                   7718:     my $srchstr;
                   7719:     my $active_chk = 'none';
1.412     raeburn  7720:     my $now = time;
1.274     raeburn  7721:     if (@uroles > 0) {
1.908     raeburn  7722:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  7723:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   7724:         } else {
1.412     raeburn  7725:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   7726:         }
                   7727:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  7728:             my $role_end = 0;
                   7729:             my $role_start = 0;
                   7730:             $active_chk = 'active';
1.412     raeburn  7731:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   7732:                 $role_end = $1;
                   7733:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   7734:                     $role_start = $1;
1.274     raeburn  7735:                 }
                   7736:             }
                   7737:             if ($role_start > 0) {
1.412     raeburn  7738:                 if ($now < $role_start) {
1.274     raeburn  7739:                     $active_chk = 'future';
                   7740:                 }
                   7741:             }
                   7742:             if ($role_end > 0) {
1.412     raeburn  7743:                 if ($now > $role_end) {
1.274     raeburn  7744:                     $active_chk = 'previous';
                   7745:                 }
                   7746:             }
                   7747:         }
                   7748:     }
                   7749:     return $active_chk;
                   7750: }
                   7751: 
                   7752: ###############################################
                   7753: 
                   7754: =pod
                   7755: 
1.405     albertel 7756: =item * &get_sections()
1.233     raeburn  7757: 
                   7758: Determines all the sections for a course including
                   7759: sections with students and sections containing other roles.
1.419     raeburn  7760: Incoming parameters: 
                   7761: 
                   7762: 1. domain
                   7763: 2. course number 
                   7764: 3. reference to array containing roles for which sections should 
                   7765: be gathered (optional).
                   7766: 4. reference to array containing status types for which sections 
                   7767: should be gathered (optional).
                   7768: 
                   7769: If the third argument is undefined, sections are gathered for any role. 
                   7770: If the fourth argument is undefined, sections are gathered for any status.
                   7771: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  7772:  
1.374     raeburn  7773: Returns section hash (keys are section IDs, values are
                   7774: number of users in each section), subject to the
1.419     raeburn  7775: optional roles filter, optional status filter 
1.233     raeburn  7776: 
                   7777: =cut
                   7778: 
                   7779: ###############################################
                   7780: sub get_sections {
1.419     raeburn  7781:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 7782:     if (!defined($cdom) || !defined($cnum)) {
                   7783:         my $cid =  $env{'request.course.id'};
                   7784: 
                   7785: 	return if (!defined($cid));
                   7786: 
                   7787:         $cdom = $env{'course.'.$cid.'.domain'};
                   7788:         $cnum = $env{'course.'.$cid.'.num'};
                   7789:     }
                   7790: 
                   7791:     my %sectioncount;
1.419     raeburn  7792:     my $now = time;
1.240     albertel 7793: 
1.366     albertel 7794:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 7795: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 7796: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   7797: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  7798:         my $start_index = &Apache::loncoursedata::CL_START();
                   7799:         my $end_index = &Apache::loncoursedata::CL_END();
                   7800:         my $status;
1.366     albertel 7801: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  7802: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   7803: 				                     $data->[$status_index],
                   7804:                                                      $data->[$start_index],
                   7805:                                                      $data->[$end_index]);
                   7806:             if ($stu_status eq 'Active') {
                   7807:                 $status = 'active';
                   7808:             } elsif ($end < $now) {
                   7809:                 $status = 'previous';
                   7810:             } elsif ($start > $now) {
                   7811:                 $status = 'future';
                   7812:             } 
                   7813: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7814:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7815:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7816: 		    $sectioncount{$section}++;
                   7817:                 }
1.240     albertel 7818: 	    }
                   7819: 	}
                   7820:     }
                   7821:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7822:     foreach my $user (sort(keys(%courseroles))) {
                   7823: 	if ($user !~ /^(\w{2})/) { next; }
                   7824: 	my ($role) = ($user =~ /^(\w{2})/);
                   7825: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7826: 	my ($section,$status);
1.240     albertel 7827: 	if ($role eq 'cr' &&
                   7828: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7829: 	    $section=$1;
                   7830: 	}
                   7831: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7832: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7833:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7834:         if ($end == -1 && $start == -1) {
                   7835:             next; #deleted role
                   7836:         }
                   7837:         if (!defined($possible_status)) { 
                   7838:             $sectioncount{$section}++;
                   7839:         } else {
                   7840:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7841:                 $status = 'active';
                   7842:             } elsif ($end < $now) {
                   7843:                 $status = 'future';
                   7844:             } elsif ($start > $now) {
                   7845:                 $status = 'previous';
                   7846:             }
                   7847:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7848:                 $sectioncount{$section}++;
                   7849:             }
                   7850:         }
1.233     raeburn  7851:     }
1.366     albertel 7852:     return %sectioncount;
1.233     raeburn  7853: }
                   7854: 
1.274     raeburn  7855: ###############################################
1.294     raeburn  7856: 
                   7857: =pod
1.405     albertel 7858: 
                   7859: =item * &get_course_users()
                   7860: 
1.275     raeburn  7861: Retrieves usernames:domains for users in the specified course
                   7862: with specific role(s), and access status. 
                   7863: 
                   7864: Incoming parameters:
1.277     albertel 7865: 1. course domain
                   7866: 2. course number
                   7867: 3. access status: users must have - either active, 
1.275     raeburn  7868: previous, future, or all.
1.277     albertel 7869: 4. reference to array of permissible roles
1.288     raeburn  7870: 5. reference to array of section restrictions (optional)
                   7871: 6. reference to results object (hash of hashes).
                   7872: 7. reference to optional userdata hash
1.609     raeburn  7873: 8. reference to optional statushash
1.630     raeburn  7874: 9. flag if privileged users (except those set to unhide in
                   7875:    course settings) should be excluded    
1.609     raeburn  7876: Keys of top level results hash are roles.
1.275     raeburn  7877: Keys of inner hashes are username:domain, with 
                   7878: values set to access type.
1.288     raeburn  7879: Optional userdata hash returns an array with arguments in the 
                   7880: same order as loncoursedata::get_classlist() for student data.
                   7881: 
1.609     raeburn  7882: Optional statushash returns
                   7883: 
1.288     raeburn  7884: Entries for end, start, section and status are blank because
                   7885: of the possibility of multiple values for non-student roles.
                   7886: 
1.275     raeburn  7887: =cut
1.405     albertel 7888: 
1.275     raeburn  7889: ###############################################
1.405     albertel 7890: 
1.275     raeburn  7891: sub get_course_users {
1.630     raeburn  7892:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7893:     my %idx = ();
1.419     raeburn  7894:     my %seclists;
1.288     raeburn  7895: 
                   7896:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7897:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7898:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7899:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7900:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7901:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7902:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7903:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7904: 
1.290     albertel 7905:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7906:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7907:         my $now = time;
1.277     albertel 7908:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7909:             my $match = 0;
1.412     raeburn  7910:             my $secmatch = 0;
1.419     raeburn  7911:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7912:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7913:             if ($section eq '') {
                   7914:                 $section = 'none';
                   7915:             }
1.291     albertel 7916:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7917:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7918:                     $secmatch = 1;
                   7919:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7920:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7921:                         $secmatch = 1;
                   7922:                     }
                   7923:                 } else {  
1.419     raeburn  7924: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7925: 		        $secmatch = 1;
                   7926:                     }
1.290     albertel 7927: 		}
1.412     raeburn  7928:                 if (!$secmatch) {
                   7929:                     next;
                   7930:                 }
1.419     raeburn  7931:             }
1.275     raeburn  7932:             if (defined($$types{'active'})) {
1.288     raeburn  7933:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7934:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7935:                     $match = 1;
1.275     raeburn  7936:                 }
                   7937:             }
                   7938:             if (defined($$types{'previous'})) {
1.609     raeburn  7939:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7940:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7941:                     $match = 1;
1.275     raeburn  7942:                 }
                   7943:             }
                   7944:             if (defined($$types{'future'})) {
1.609     raeburn  7945:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7946:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7947:                     $match = 1;
1.275     raeburn  7948:                 }
                   7949:             }
1.609     raeburn  7950:             if ($match) {
                   7951:                 push(@{$seclists{$student}},$section);
                   7952:                 if (ref($userdata) eq 'HASH') {
                   7953:                     $$userdata{$student} = $$classlist{$student};
                   7954:                 }
                   7955:                 if (ref($statushash) eq 'HASH') {
                   7956:                     $statushash->{$student}{'st'}{$section} = $status;
                   7957:                 }
1.288     raeburn  7958:             }
1.275     raeburn  7959:         }
                   7960:     }
1.412     raeburn  7961:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7962:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7963:         my $now = time;
1.609     raeburn  7964:         my %displaystatus = ( previous => 'Expired',
                   7965:                               active   => 'Active',
                   7966:                               future   => 'Future',
                   7967:                             );
1.630     raeburn  7968:         my %nothide;
                   7969:         if ($hidepriv) {
                   7970:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7971:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7972:                 if ($user !~ /:/) {
                   7973:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7974:                 } else {
                   7975:                     $nothide{$user} = 1;
                   7976:                 }
                   7977:             }
                   7978:         }
1.439     raeburn  7979:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7980:             my $match = 0;
1.412     raeburn  7981:             my $secmatch = 0;
1.439     raeburn  7982:             my $status;
1.412     raeburn  7983:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7984:             $user =~ s/:$//;
1.439     raeburn  7985:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7986:             if ($end == -1 || $start == -1) {
                   7987:                 next;
                   7988:             }
                   7989:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7990:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7991:                 my ($uname,$udom) = split(/:/,$user);
                   7992:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7993:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7994:                         $secmatch = 1;
                   7995:                     } elsif ($usec eq '') {
1.420     albertel 7996:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7997:                             $secmatch = 1;
                   7998:                         }
                   7999:                     } else {
                   8000:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   8001:                             $secmatch = 1;
                   8002:                         }
                   8003:                     }
                   8004:                     if (!$secmatch) {
                   8005:                         next;
                   8006:                     }
1.288     raeburn  8007:                 }
1.419     raeburn  8008:                 if ($usec eq '') {
                   8009:                     $usec = 'none';
                   8010:                 }
1.275     raeburn  8011:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  8012:                     if ($hidepriv) {
                   8013:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   8014:                             (!$nothide{$uname.':'.$udom})) {
                   8015:                             next;
                   8016:                         }
                   8017:                     }
1.503     raeburn  8018:                     if ($end > 0 && $end < $now) {
1.439     raeburn  8019:                         $status = 'previous';
                   8020:                     } elsif ($start > $now) {
                   8021:                         $status = 'future';
                   8022:                     } else {
                   8023:                         $status = 'active';
                   8024:                     }
1.277     albertel 8025:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  8026:                         if ($status eq $type) {
1.420     albertel 8027:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  8028:                                 push(@{$$users{$role}{$user}},$type);
                   8029:                             }
1.288     raeburn  8030:                             $match = 1;
                   8031:                         }
                   8032:                     }
1.419     raeburn  8033:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   8034:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   8035: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   8036:                         }
1.420     albertel 8037:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  8038:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   8039:                         }
1.609     raeburn  8040:                         if (ref($statushash) eq 'HASH') {
                   8041:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   8042:                         }
1.275     raeburn  8043:                     }
                   8044:                 }
                   8045:             }
                   8046:         }
1.290     albertel 8047:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  8048:             if ((defined($cdom)) && (defined($cnum))) {
                   8049:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   8050:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   8051:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  8052:                     next if ($owner eq '');
                   8053:                     my ($ownername,$ownerdom);
                   8054:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   8055:                         $ownername = $1;
                   8056:                         $ownerdom = $2;
                   8057:                     } else {
                   8058:                         $ownername = $owner;
                   8059:                         $ownerdom = $cdom;
                   8060:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  8061:                     }
                   8062:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 8063:                     if (defined($userdata) && 
1.609     raeburn  8064: 			!exists($$userdata{$owner})) {
                   8065: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   8066:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   8067:                             push(@{$seclists{$owner}},'none');
                   8068:                         }
                   8069:                         if (ref($statushash) eq 'HASH') {
                   8070:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  8071:                         }
1.290     albertel 8072: 		    }
1.279     raeburn  8073:                 }
                   8074:             }
                   8075:         }
1.419     raeburn  8076:         foreach my $user (keys(%seclists)) {
                   8077:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   8078:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   8079:         }
1.275     raeburn  8080:     }
                   8081:     return;
                   8082: }
                   8083: 
1.288     raeburn  8084: sub get_user_info {
                   8085:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 8086:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   8087: 	&plainname($uname,$udom,'lastname');
1.291     albertel 8088:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  8089:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  8090:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   8091:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  8092:     return;
                   8093: }
1.275     raeburn  8094: 
1.472     raeburn  8095: ###############################################
                   8096: 
                   8097: =pod
                   8098: 
                   8099: =item * &get_user_quota()
                   8100: 
                   8101: Retrieves quota assigned for storage of portfolio files for a user  
                   8102: 
                   8103: Incoming parameters:
                   8104: 1. user's username
                   8105: 2. user's domain
                   8106: 
                   8107: Returns:
1.536     raeburn  8108: 1. Disk quota (in Mb) assigned to student.
                   8109: 2. (Optional) Type of setting: custom or default
                   8110:    (individually assigned or default for user's 
                   8111:    institutional status).
                   8112: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   8113:    or student - types as defined in localenroll::inst_usertypes 
                   8114:    for user's domain, which determines default quota for user.
                   8115: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  8116: 
                   8117: If a value has been stored in the user's environment, 
1.536     raeburn  8118: it will return that, otherwise it returns the maximal default
                   8119: defined for the user's instituional status(es) in the domain.
1.472     raeburn  8120: 
                   8121: =cut
                   8122: 
                   8123: ###############################################
                   8124: 
                   8125: 
                   8126: sub get_user_quota {
                   8127:     my ($uname,$udom) = @_;
1.536     raeburn  8128:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  8129:     if (!defined($udom)) {
                   8130:         $udom = $env{'user.domain'};
                   8131:     }
                   8132:     if (!defined($uname)) {
                   8133:         $uname = $env{'user.name'};
                   8134:     }
                   8135:     if (($udom eq '' || $uname eq '') ||
                   8136:         ($udom eq 'public') && ($uname eq 'public')) {
                   8137:         $quota = 0;
1.536     raeburn  8138:         $quotatype = 'default';
                   8139:         $defquota = 0; 
1.472     raeburn  8140:     } else {
1.536     raeburn  8141:         my $inststatus;
1.472     raeburn  8142:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   8143:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  8144:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  8145:         } else {
1.536     raeburn  8146:             my %userenv = 
                   8147:                 &Apache::lonnet::get('environment',['portfolioquota',
                   8148:                                      'inststatus'],$udom,$uname);
1.472     raeburn  8149:             my ($tmp) = keys(%userenv);
                   8150:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   8151:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  8152:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  8153:             } else {
                   8154:                 undef(%userenv);
                   8155:             }
                   8156:         }
1.536     raeburn  8157:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  8158:         if ($quota eq '') {
1.536     raeburn  8159:             $quota = $defquota;
                   8160:             $quotatype = 'default';
                   8161:         } else {
                   8162:             $quotatype = 'custom';
1.472     raeburn  8163:         }
                   8164:     }
1.536     raeburn  8165:     if (wantarray) {
                   8166:         return ($quota,$quotatype,$settingstatus,$defquota);
                   8167:     } else {
                   8168:         return $quota;
                   8169:     }
1.472     raeburn  8170: }
                   8171: 
                   8172: ###############################################
                   8173: 
                   8174: =pod
                   8175: 
                   8176: =item * &default_quota()
                   8177: 
1.536     raeburn  8178: Retrieves default quota assigned for storage of user portfolio files,
                   8179: given an (optional) user's institutional status.
1.472     raeburn  8180: 
                   8181: Incoming parameters:
                   8182: 1. domain
1.536     raeburn  8183: 2. (Optional) institutional status(es).  This is a : separated list of 
                   8184:    status types (e.g., faculty, staff, student etc.)
                   8185:    which apply to the user for whom the default is being retrieved.
                   8186:    If the institutional status string in undefined, the domain
                   8187:    default quota will be returned. 
1.472     raeburn  8188: 
                   8189: Returns:
                   8190: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  8191: 2. (Optional) institutional type which determined the value of the
                   8192:    default quota.
1.472     raeburn  8193: 
                   8194: If a value has been stored in the domain's configuration db,
                   8195: it will return that, otherwise it returns 20 (for backwards 
                   8196: compatibility with domains which have not set up a configuration
                   8197: db file; the original statically defined portfolio quota was 20 Mb). 
                   8198: 
1.536     raeburn  8199: If the user's status includes multiple types (e.g., staff and student),
                   8200: the largest default quota which applies to the user determines the
                   8201: default quota returned.
                   8202: 
1.780     raeburn  8203: =back
                   8204: 
1.472     raeburn  8205: =cut
                   8206: 
                   8207: ###############################################
                   8208: 
                   8209: 
                   8210: sub default_quota {
1.536     raeburn  8211:     my ($udom,$inststatus) = @_;
                   8212:     my ($defquota,$settingstatus);
                   8213:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  8214:                                             ['quotas'],$udom);
                   8215:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  8216:         if ($inststatus ne '') {
1.765     raeburn  8217:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  8218:             foreach my $item (@statuses) {
1.711     raeburn  8219:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   8220:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   8221:                         if ($defquota eq '') {
                   8222:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   8223:                             $settingstatus = $item;
                   8224:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   8225:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   8226:                             $settingstatus = $item;
                   8227:                         }
                   8228:                     }
                   8229:                 } else {
                   8230:                     if ($quotahash{'quotas'}{$item} ne '') {
                   8231:                         if ($defquota eq '') {
                   8232:                             $defquota = $quotahash{'quotas'}{$item};
                   8233:                             $settingstatus = $item;
                   8234:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   8235:                             $defquota = $quotahash{'quotas'}{$item};
                   8236:                             $settingstatus = $item;
                   8237:                         }
1.536     raeburn  8238:                     }
                   8239:                 }
                   8240:             }
                   8241:         }
                   8242:         if ($defquota eq '') {
1.711     raeburn  8243:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   8244:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   8245:             } else {
                   8246:                 $defquota = $quotahash{'quotas'}{'default'};
                   8247:             }
1.536     raeburn  8248:             $settingstatus = 'default';
                   8249:         }
                   8250:     } else {
                   8251:         $settingstatus = 'default';
                   8252:         $defquota = 20;
                   8253:     }
                   8254:     if (wantarray) {
                   8255:         return ($defquota,$settingstatus);
1.472     raeburn  8256:     } else {
1.536     raeburn  8257:         return $defquota;
1.472     raeburn  8258:     }
                   8259: }
                   8260: 
1.384     raeburn  8261: sub get_secgrprole_info {
                   8262:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   8263:     my %sections_count = &get_sections($cdom,$cnum);
                   8264:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   8265:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   8266:     my @groups = sort(keys(%curr_groups));
                   8267:     my $allroles = [];
                   8268:     my $rolehash;
                   8269:     my $accesshash = {
                   8270:                      active => 'Currently has access',
                   8271:                      future => 'Will have future access',
                   8272:                      previous => 'Previously had access',
                   8273:                   };
                   8274:     if ($needroles) {
                   8275:         $rolehash = {'all' => 'all'};
1.385     albertel 8276:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   8277: 	if (&Apache::lonnet::error(%user_roles)) {
                   8278: 	    undef(%user_roles);
                   8279: 	}
                   8280:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  8281:             my ($role)=split(/\:/,$item,2);
                   8282:             if ($role eq 'cr') { next; }
                   8283:             if ($role =~ /^cr/) {
                   8284:                 $$rolehash{$role} = (split('/',$role))[3];
                   8285:             } else {
                   8286:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   8287:             }
                   8288:         }
                   8289:         foreach my $key (sort(keys(%{$rolehash}))) {
                   8290:             push(@{$allroles},$key);
                   8291:         }
                   8292:         push (@{$allroles},'st');
                   8293:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   8294:     }
                   8295:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   8296: }
                   8297: 
1.555     raeburn  8298: sub user_picker {
1.994     raeburn  8299:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555     raeburn  8300:     my $currdom = $dom;
                   8301:     my %curr_selected = (
                   8302:                         srchin => 'dom',
1.580     raeburn  8303:                         srchby => 'lastname',
1.555     raeburn  8304:                       );
                   8305:     my $srchterm;
1.625     raeburn  8306:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  8307:         if ($srch->{'srchby'} ne '') {
                   8308:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   8309:         }
                   8310:         if ($srch->{'srchin'} ne '') {
                   8311:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   8312:         }
                   8313:         if ($srch->{'srchtype'} ne '') {
                   8314:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   8315:         }
                   8316:         if ($srch->{'srchdomain'} ne '') {
                   8317:             $currdom = $srch->{'srchdomain'};
                   8318:         }
                   8319:         $srchterm = $srch->{'srchterm'};
                   8320:     }
                   8321:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  8322:                     'usr'       => 'Search criteria',
1.563     raeburn  8323:                     'doma'      => 'Domain/institution to search',
1.558     albertel 8324:                     'uname'     => 'username',
                   8325:                     'lastname'  => 'last name',
1.555     raeburn  8326:                     'lastfirst' => 'last name, first name',
1.558     albertel 8327:                     'crs'       => 'in this course',
1.576     raeburn  8328:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 8329:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  8330:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 8331:                     'exact'     => 'is',
                   8332:                     'contains'  => 'contains',
1.569     raeburn  8333:                     'begins'    => 'begins with',
1.571     raeburn  8334:                     'youm'      => "You must include some text to search for.",
                   8335:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   8336:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   8337:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   8338:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   8339:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   8340:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   8341:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  8342:                                        );
1.563     raeburn  8343:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   8344:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  8345: 
                   8346:     my @srchins = ('crs','dom','alc','instd');
                   8347: 
                   8348:     foreach my $option (@srchins) {
                   8349:         # FIXME 'alc' option unavailable until 
                   8350:         #       loncreateuser::print_user_query_page()
                   8351:         #       has been completed.
                   8352:         next if ($option eq 'alc');
1.880     raeburn  8353:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  8354:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  8355:         if ($curr_selected{'srchin'} eq $option) {
                   8356:             $srchinsel .= ' 
                   8357:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8358:         } else {
                   8359:             $srchinsel .= '
                   8360:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8361:         }
1.555     raeburn  8362:     }
1.563     raeburn  8363:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  8364: 
                   8365:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  8366:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  8367:         if ($curr_selected{'srchby'} eq $option) {
                   8368:             $srchbysel .= '
                   8369:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8370:         } else {
                   8371:             $srchbysel .= '
                   8372:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8373:          }
                   8374:     }
                   8375:     $srchbysel .= "\n  </select>\n";
                   8376: 
                   8377:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  8378:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  8379:         if ($curr_selected{'srchtype'} eq $option) {
                   8380:             $srchtypesel .= '
                   8381:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8382:         } else {
                   8383:             $srchtypesel .= '
                   8384:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8385:         }
                   8386:     }
                   8387:     $srchtypesel .= "\n  </select>\n";
                   8388: 
1.558     albertel 8389:     my ($newuserscript,$new_user_create);
1.994     raeburn  8390:     my $context_dom = $env{'request.role.domain'};
                   8391:     if ($context eq 'requestcrs') {
                   8392:         if ($env{'form.coursedom'} ne '') { 
                   8393:             $context_dom = $env{'form.coursedom'};
                   8394:         }
                   8395:     }
1.556     raeburn  8396:     if ($forcenewuser) {
1.576     raeburn  8397:         if (ref($srch) eq 'HASH') {
1.994     raeburn  8398:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  8399:                 if ($cancreate) {
                   8400:                     $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>';
                   8401:                 } else {
1.799     bisitz   8402:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  8403:                     my %usertypetext = (
                   8404:                         official   => 'institutional',
                   8405:                         unofficial => 'non-institutional',
                   8406:                     );
1.799     bisitz   8407:                     $new_user_create = '<p class="LC_warning">'
                   8408:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   8409:                                       .' '
                   8410:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   8411:                                           ,'<a href="'.$helplink.'">','</a>')
                   8412:                                       .'</p><br />';
1.627     raeburn  8413:                 }
1.576     raeburn  8414:             }
                   8415:         }
                   8416: 
1.556     raeburn  8417:         $newuserscript = <<"ENDSCRIPT";
                   8418: 
1.570     raeburn  8419: function setSearch(createnew,callingForm) {
1.556     raeburn  8420:     if (createnew == 1) {
1.570     raeburn  8421:         for (var i=0; i<callingForm.srchby.length; i++) {
                   8422:             if (callingForm.srchby.options[i].value == 'uname') {
                   8423:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  8424:             }
                   8425:         }
1.570     raeburn  8426:         for (var i=0; i<callingForm.srchin.length; i++) {
                   8427:             if ( callingForm.srchin.options[i].value == 'dom') {
                   8428: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  8429:             }
                   8430:         }
1.570     raeburn  8431:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   8432:             if (callingForm.srchtype.options[i].value == 'exact') {
                   8433:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  8434:             }
                   8435:         }
1.570     raeburn  8436:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  8437:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  8438:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  8439:             }
                   8440:         }
                   8441:     }
                   8442: }
                   8443: ENDSCRIPT
1.558     albertel 8444: 
1.556     raeburn  8445:     }
                   8446: 
1.555     raeburn  8447:     my $output = <<"END_BLOCK";
1.556     raeburn  8448: <script type="text/javascript">
1.824     bisitz   8449: // <![CDATA[
1.570     raeburn  8450: function validateEntry(callingForm) {
1.558     albertel 8451: 
1.556     raeburn  8452:     var checkok = 1;
1.558     albertel 8453:     var srchin;
1.570     raeburn  8454:     for (var i=0; i<callingForm.srchin.length; i++) {
                   8455: 	if ( callingForm.srchin[i].checked ) {
                   8456: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 8457: 	}
                   8458:     }
                   8459: 
1.570     raeburn  8460:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   8461:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   8462:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   8463:     var srchterm =  callingForm.srchterm.value;
                   8464:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  8465:     var msg = "";
                   8466: 
                   8467:     if (srchterm == "") {
                   8468:         checkok = 0;
1.571     raeburn  8469:         msg += "$lt{'youm'}\\n";
1.556     raeburn  8470:     }
                   8471: 
1.569     raeburn  8472:     if (srchtype== 'begins') {
                   8473:         if (srchterm.length < 2) {
                   8474:             checkok = 0;
1.571     raeburn  8475:             msg += "$lt{'thte'}\\n";
1.569     raeburn  8476:         }
                   8477:     }
                   8478: 
1.556     raeburn  8479:     if (srchtype== 'contains') {
                   8480:         if (srchterm.length < 3) {
                   8481:             checkok = 0;
1.571     raeburn  8482:             msg += "$lt{'thet'}\\n";
1.556     raeburn  8483:         }
                   8484:     }
                   8485:     if (srchin == 'instd') {
                   8486:         if (srchdomain == '') {
                   8487:             checkok = 0;
1.571     raeburn  8488:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  8489:         }
                   8490:     }
                   8491:     if (srchin == 'dom') {
                   8492:         if (srchdomain == '') {
                   8493:             checkok = 0;
1.571     raeburn  8494:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  8495:         }
                   8496:     }
                   8497:     if (srchby == 'lastfirst') {
                   8498:         if (srchterm.indexOf(",") == -1) {
                   8499:             checkok = 0;
1.571     raeburn  8500:             msg += "$lt{'whus'}\\n";
1.556     raeburn  8501:         }
                   8502:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   8503:             checkok = 0;
1.571     raeburn  8504:             msg += "$lt{'whse'}\\n";
1.556     raeburn  8505:         }
                   8506:     }
                   8507:     if (checkok == 0) {
1.571     raeburn  8508:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  8509:         return;
                   8510:     }
                   8511:     if (checkok == 1) {
1.570     raeburn  8512:         callingForm.submit();
1.556     raeburn  8513:     }
                   8514: }
                   8515: 
                   8516: $newuserscript
                   8517: 
1.824     bisitz   8518: // ]]>
1.556     raeburn  8519: </script>
1.558     albertel 8520: 
                   8521: $new_user_create
                   8522: 
1.555     raeburn  8523: END_BLOCK
1.558     albertel 8524: 
1.876     raeburn  8525:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   8526:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   8527:                $domform.
                   8528:                &Apache::lonhtmlcommon::row_closure().
                   8529:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   8530:                $srchbysel.
                   8531:                $srchtypesel. 
                   8532:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   8533:                $srchinsel.
                   8534:                &Apache::lonhtmlcommon::row_closure(1). 
                   8535:                &Apache::lonhtmlcommon::end_pick_box().
                   8536:                '<br />';
1.555     raeburn  8537:     return $output;
                   8538: }
                   8539: 
1.612     raeburn  8540: sub user_rule_check {
1.615     raeburn  8541:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  8542:     my $response;
                   8543:     if (ref($usershash) eq 'HASH') {
                   8544:         foreach my $user (keys(%{$usershash})) {
                   8545:             my ($uname,$udom) = split(/:/,$user);
                   8546:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  8547:             my ($id,$newuser);
1.612     raeburn  8548:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  8549:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  8550:                 $id = $usershash->{$user}->{'id'};
                   8551:             }
                   8552:             my $inst_response;
                   8553:             if (ref($checks) eq 'HASH') {
                   8554:                 if (defined($checks->{'username'})) {
1.615     raeburn  8555:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  8556:                         &Apache::lonnet::get_instuser($udom,$uname);
                   8557:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  8558:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  8559:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   8560:                 }
1.615     raeburn  8561:             } else {
                   8562:                 ($inst_response,%{$inst_results->{$user}}) =
                   8563:                     &Apache::lonnet::get_instuser($udom,$uname);
                   8564:                 return;
1.612     raeburn  8565:             }
1.615     raeburn  8566:             if (!$got_rules->{$udom}) {
1.612     raeburn  8567:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   8568:                                                   ['usercreation'],$udom);
                   8569:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  8570:                     foreach my $item ('username','id') {
1.612     raeburn  8571:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   8572:                             $$curr_rules{$udom}{$item} = 
                   8573:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  8574:                         }
                   8575:                     }
                   8576:                 }
1.615     raeburn  8577:                 $got_rules->{$udom} = 1;  
1.585     raeburn  8578:             }
1.612     raeburn  8579:             foreach my $item (keys(%{$checks})) {
                   8580:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   8581:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   8582:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   8583:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   8584:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   8585:                                 if ($rule_check{$rule}) {
                   8586:                                     $$rulematch{$user}{$item} = $rule;
                   8587:                                     if ($inst_response eq 'ok') {
1.615     raeburn  8588:                                         if (ref($inst_results) eq 'HASH') {
                   8589:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   8590:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   8591:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   8592:                                                 }
1.612     raeburn  8593:                                             }
                   8594:                                         }
1.615     raeburn  8595:                                     }
                   8596:                                     last;
1.585     raeburn  8597:                                 }
                   8598:                             }
                   8599:                         }
                   8600:                     }
                   8601:                 }
                   8602:             }
                   8603:         }
                   8604:     }
1.612     raeburn  8605:     return;
                   8606: }
                   8607: 
                   8608: sub user_rule_formats {
                   8609:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   8610:     my %text = ( 
                   8611:                  'username' => 'Usernames',
                   8612:                  'id'       => 'IDs',
                   8613:                );
                   8614:     my $output;
                   8615:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   8616:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   8617:         if (@{$ruleorder} > 0) {
                   8618:             $output = '<br />'.&mt("$text{$check} with the following format(s) may <span class=\"LC_cusr_emph\">only</span> be used for verified users at [_1]:",$domdesc).' <ul>';
                   8619:             foreach my $rule (@{$ruleorder}) {
                   8620:                 if (ref($curr_rules) eq 'ARRAY') {
                   8621:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   8622:                         if (ref($rules->{$rule}) eq 'HASH') {
                   8623:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   8624:                                         $rules->{$rule}{'desc'}.'</li>';
                   8625:                         }
                   8626:                     }
                   8627:                 }
                   8628:             }
                   8629:             $output .= '</ul>';
                   8630:         }
                   8631:     }
                   8632:     return $output;
                   8633: }
                   8634: 
                   8635: sub instrule_disallow_msg {
1.615     raeburn  8636:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  8637:     my $response;
                   8638:     my %text = (
                   8639:                   item   => 'username',
                   8640:                   items  => 'usernames',
                   8641:                   match  => 'matches',
                   8642:                   do     => 'does',
                   8643:                   action => 'a username',
                   8644:                   one    => 'one',
                   8645:                );
                   8646:     if ($count > 1) {
                   8647:         $text{'item'} = 'usernames';
                   8648:         $text{'match'} ='match';
                   8649:         $text{'do'} = 'do';
                   8650:         $text{'action'} = 'usernames',
                   8651:         $text{'one'} = 'ones';
                   8652:     }
                   8653:     if ($checkitem eq 'id') {
                   8654:         $text{'items'} = 'IDs';
                   8655:         $text{'item'} = 'ID';
                   8656:         $text{'action'} = 'an ID';
1.615     raeburn  8657:         if ($count > 1) {
                   8658:             $text{'item'} = 'IDs';
                   8659:             $text{'action'} = 'IDs';
                   8660:         }
1.612     raeburn  8661:     }
1.674     bisitz   8662:     $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  8663:     if ($mode eq 'upload') {
                   8664:         if ($checkitem eq 'username') {
                   8665:             $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'}.");
                   8666:         } elsif ($checkitem eq 'id') {
1.674     bisitz   8667:             $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  8668:         }
1.669     raeburn  8669:     } elsif ($mode eq 'selfcreate') {
                   8670:         if ($checkitem eq 'id') {
                   8671:             $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.");
                   8672:         }
1.615     raeburn  8673:     } else {
                   8674:         if ($checkitem eq 'username') {
                   8675:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   8676:         } elsif ($checkitem eq 'id') {
                   8677:             $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.");
                   8678:         }
1.612     raeburn  8679:     }
                   8680:     return $response;
1.585     raeburn  8681: }
                   8682: 
1.624     raeburn  8683: sub personal_data_fieldtitles {
                   8684:     my %fieldtitles = &Apache::lonlocal::texthash (
                   8685:                         id => 'Student/Employee ID',
                   8686:                         permanentemail => 'E-mail address',
                   8687:                         lastname => 'Last Name',
                   8688:                         firstname => 'First Name',
                   8689:                         middlename => 'Middle Name',
                   8690:                         generation => 'Generation',
                   8691:                         gen => 'Generation',
1.765     raeburn  8692:                         inststatus => 'Affiliation',
1.624     raeburn  8693:                    );
                   8694:     return %fieldtitles;
                   8695: }
                   8696: 
1.642     raeburn  8697: sub sorted_inst_types {
                   8698:     my ($dom) = @_;
                   8699:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   8700:     my $othertitle = &mt('All users');
                   8701:     if ($env{'request.course.id'}) {
1.668     raeburn  8702:         $othertitle  = &mt('Any users');
1.642     raeburn  8703:     }
                   8704:     my @types;
                   8705:     if (ref($order) eq 'ARRAY') {
                   8706:         @types = @{$order};
                   8707:     }
                   8708:     if (@types == 0) {
                   8709:         if (ref($usertypes) eq 'HASH') {
                   8710:             @types = sort(keys(%{$usertypes}));
                   8711:         }
                   8712:     }
                   8713:     if (keys(%{$usertypes}) > 0) {
                   8714:         $othertitle = &mt('Other users');
                   8715:     }
                   8716:     return ($othertitle,$usertypes,\@types);
                   8717: }
                   8718: 
1.645     raeburn  8719: sub get_institutional_codes {
                   8720:     my ($settings,$allcourses,$LC_code) = @_;
                   8721: # Get complete list of course sections to update
                   8722:     my @currsections = ();
                   8723:     my @currxlists = ();
                   8724:     my $coursecode = $$settings{'internal.coursecode'};
                   8725: 
                   8726:     if ($$settings{'internal.sectionnums'} ne '') {
                   8727:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   8728:     }
                   8729: 
                   8730:     if ($$settings{'internal.crosslistings'} ne '') {
                   8731:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   8732:     }
                   8733: 
                   8734:     if (@currxlists > 0) {
                   8735:         foreach (@currxlists) {
                   8736:             if (m/^([^:]+):(\w*)$/) {
                   8737:                 unless (grep/^$1$/,@{$allcourses}) {
                   8738:                     push @{$allcourses},$1;
                   8739:                     $$LC_code{$1} = $2;
                   8740:                 }
                   8741:             }
                   8742:         }
                   8743:     }
                   8744:  
                   8745:     if (@currsections > 0) {
                   8746:         foreach (@currsections) {
                   8747:             if (m/^(\w+):(\w*)$/) {
                   8748:                 my $sec = $coursecode.$1;
                   8749:                 my $lc_sec = $2;
                   8750:                 unless (grep/^$sec$/,@{$allcourses}) {
                   8751:                     push @{$allcourses},$sec;
                   8752:                     $$LC_code{$sec} = $lc_sec;
                   8753:                 }
                   8754:             }
                   8755:         }
                   8756:     }
                   8757:     return;
                   8758: }
                   8759: 
1.971     raeburn  8760: sub get_standard_codeitems {
                   8761:     return ('Year','Semester','Department','Number','Section');
                   8762: }
                   8763: 
1.112     bowersj2 8764: =pod
                   8765: 
1.780     raeburn  8766: =head1 Slot Helpers
                   8767: 
                   8768: =over 4
                   8769: 
                   8770: =item * sorted_slots()
                   8771: 
1.1040    raeburn  8772: Sorts an array of slot names in order of an optional sort key,
                   8773: default sort is by slot start time (earliest first). 
1.780     raeburn  8774: 
                   8775: Inputs:
                   8776: 
                   8777: =over 4
                   8778: 
                   8779: slotsarr  - Reference to array of unsorted slot names.
                   8780: 
                   8781: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   8782: 
1.1040    raeburn  8783: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   8784: 
1.549     albertel 8785: =back
                   8786: 
1.780     raeburn  8787: Returns:
                   8788: 
                   8789: =over 4
                   8790: 
1.1040    raeburn  8791: sorted   - An array of slot names sorted by a specified sort key 
                   8792:            (default sort key is start time of the slot).
1.780     raeburn  8793: 
                   8794: =back
                   8795: 
                   8796: =cut
                   8797: 
                   8798: 
                   8799: sub sorted_slots {
1.1040    raeburn  8800:     my ($slotsarr,$slots,$sortkey) = @_;
                   8801:     if ($sortkey eq '') {
                   8802:         $sortkey = 'starttime';
                   8803:     }
1.780     raeburn  8804:     my @sorted;
                   8805:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   8806:         @sorted =
                   8807:             sort {
                   8808:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  8809:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  8810:                      }
                   8811:                      if (ref($slots->{$a})) { return -1;}
                   8812:                      if (ref($slots->{$b})) { return 1;}
                   8813:                      return 0;
                   8814:                  } @{$slotsarr};
                   8815:     }
                   8816:     return @sorted;
                   8817: }
                   8818: 
1.1040    raeburn  8819: =pod
                   8820: 
                   8821: =item * get_future_slots()
                   8822: 
                   8823: Inputs:
                   8824: 
                   8825: =over 4
                   8826: 
                   8827: cnum - course number
                   8828: 
                   8829: cdom - course domain
                   8830: 
                   8831: now - current UNIX time
                   8832: 
                   8833: symb - optional symb
                   8834: 
                   8835: =back
                   8836: 
                   8837: Returns:
                   8838: 
                   8839: =over 4
                   8840: 
                   8841: sorted_reservable - ref to array of student_schedulable slots currently 
                   8842:                     reservable, ordered by end date of reservation period.
                   8843: 
                   8844: reservable_now - ref to hash of student_schedulable slots currently
                   8845:                  reservable.
                   8846: 
                   8847:     Keys in inner hash are:
                   8848:     (a) symb: either blank or symb to which slot use is restricted.
                   8849:     (b) endreserve: end date of reservation period. 
                   8850: 
                   8851: sorted_future - ref to array of student_schedulable slots reservable in
                   8852:                 the future, ordered by start date of reservation period.
                   8853: 
                   8854: future_reservable - ref to hash of student_schedulable slots reservable
                   8855:                     in the future.
                   8856: 
                   8857:     Keys in inner hash are:
                   8858:     (a) symb: either blank or symb to which slot use is restricted.
                   8859:     (b) startreserve:  start date of reservation period.
                   8860: 
                   8861: =back
                   8862: 
                   8863: =cut
                   8864: 
                   8865: sub get_future_slots {
                   8866:     my ($cnum,$cdom,$now,$symb) = @_;
                   8867:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   8868:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   8869:     foreach my $slot (keys(%slots)) {
                   8870:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   8871:         if ($symb) {
                   8872:             next if (($slots{$slot}->{'symb'} ne '') && 
                   8873:                      ($slots{$slot}->{'symb'} ne $symb));
                   8874:         }
                   8875:         if (($slots{$slot}->{'starttime'} > $now) &&
                   8876:             ($slots{$slot}->{'endtime'} > $now)) {
                   8877:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   8878:                 my $userallowed = 0;
                   8879:                 if ($slots{$slot}->{'allowedsections'}) {
                   8880:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   8881:                     if (!defined($env{'request.role.sec'})
                   8882:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   8883:                         $userallowed=1;
                   8884:                     } else {
                   8885:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   8886:                             $userallowed=1;
                   8887:                         }
                   8888:                     }
                   8889:                     unless ($userallowed) {
                   8890:                         if (defined($env{'request.course.groups'})) {
                   8891:                             my @groups = split(/:/,$env{'request.course.groups'});
                   8892:                             foreach my $group (@groups) {
                   8893:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   8894:                                     $userallowed=1;
                   8895:                                     last;
                   8896:                                 }
                   8897:                             }
                   8898:                         }
                   8899:                     }
                   8900:                 }
                   8901:                 if ($slots{$slot}->{'allowedusers'}) {
                   8902:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   8903:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   8904:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   8905:                         $userallowed = 1;
                   8906:                     }
                   8907:                 }
                   8908:                 next unless($userallowed);
                   8909:             }
                   8910:             my $startreserve = $slots{$slot}->{'startreserve'};
                   8911:             my $endreserve = $slots{$slot}->{'endreserve'};
                   8912:             my $symb = $slots{$slot}->{'symb'};
                   8913:             if (($startreserve < $now) &&
                   8914:                 (!$endreserve || $endreserve > $now)) {
                   8915:                 my $lastres = $endreserve;
                   8916:                 if (!$lastres) {
                   8917:                     $lastres = $slots{$slot}->{'starttime'};
                   8918:                 }
                   8919:                 $reservable_now{$slot} = {
                   8920:                                            symb       => $symb,
                   8921:                                            endreserve => $lastres
                   8922:                                          };
                   8923:             } elsif (($startreserve > $now) &&
                   8924:                      (!$endreserve || $endreserve > $startreserve)) {
                   8925:                 $future_reservable{$slot} = {
                   8926:                                               symb         => $symb,
                   8927:                                               startreserve => $startreserve
                   8928:                                             };
                   8929:             }
                   8930:         }
                   8931:     }
                   8932:     my @unsorted_reservable = keys(%reservable_now);
                   8933:     if (@unsorted_reservable > 0) {
                   8934:         @sorted_reservable = 
                   8935:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   8936:     }
                   8937:     my @unsorted_future = keys(%future_reservable);
                   8938:     if (@unsorted_future > 0) {
                   8939:         @sorted_future =
                   8940:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   8941:     }
                   8942:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   8943: }
1.780     raeburn  8944: 
                   8945: =pod
                   8946: 
1.1057    foxr     8947: =back
                   8948: 
1.549     albertel 8949: =head1 HTTP Helpers
                   8950: 
                   8951: =over 4
                   8952: 
1.648     raeburn  8953: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 8954: 
1.258     albertel 8955: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8956: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8957: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8958: 
                   8959: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8960: $possible_names is an ref to an array of form element names.  As an example:
                   8961: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8962: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8963: 
                   8964: =cut
1.1       albertel 8965: 
1.6       albertel 8966: sub get_unprocessed_cgi {
1.25      albertel 8967:   my ($query,$possible_names)= @_;
1.26      matthew  8968:   # $Apache::lonxml::debug=1;
1.356     albertel 8969:   foreach my $pair (split(/&/,$query)) {
                   8970:     my ($name, $value) = split(/=/,$pair);
1.369     www      8971:     $name = &unescape($name);
1.25      albertel 8972:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8973:       $value =~ tr/+/ /;
                   8974:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8975:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8976:     }
1.16      harris41 8977:   }
1.6       albertel 8978: }
                   8979: 
1.112     bowersj2 8980: =pod
                   8981: 
1.648     raeburn  8982: =item * &cacheheader() 
1.112     bowersj2 8983: 
                   8984: returns cache-controlling header code
                   8985: 
                   8986: =cut
                   8987: 
1.7       albertel 8988: sub cacheheader {
1.258     albertel 8989:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8990:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8991:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8992:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8993:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8994:     return $output;
1.7       albertel 8995: }
                   8996: 
1.112     bowersj2 8997: =pod
                   8998: 
1.648     raeburn  8999: =item * &no_cache($r) 
1.112     bowersj2 9000: 
                   9001: specifies header code to not have cache
                   9002: 
                   9003: =cut
                   9004: 
1.9       albertel 9005: sub no_cache {
1.216     albertel 9006:     my ($r) = @_;
                   9007:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 9008: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 9009:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   9010:     $r->no_cache(1);
                   9011:     $r->header_out("Expires" => $date);
                   9012:     $r->header_out("Pragma" => "no-cache");
1.123     www      9013: }
                   9014: 
                   9015: sub content_type {
1.181     albertel 9016:     my ($r,$type,$charset) = @_;
1.299     foxr     9017:     if ($r) {
                   9018: 	#  Note that printout.pl calls this with undef for $r.
                   9019: 	&no_cache($r);
                   9020:     }
1.258     albertel 9021:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 9022:     unless ($charset) {
                   9023: 	$charset=&Apache::lonlocal::current_encoding;
                   9024:     }
                   9025:     if ($charset) { $type.='; charset='.$charset; }
                   9026:     if ($r) {
                   9027: 	$r->content_type($type);
                   9028:     } else {
                   9029: 	print("Content-type: $type\n\n");
                   9030:     }
1.9       albertel 9031: }
1.25      albertel 9032: 
1.112     bowersj2 9033: =pod
                   9034: 
1.648     raeburn  9035: =item * &add_to_env($name,$value) 
1.112     bowersj2 9036: 
1.258     albertel 9037: adds $name to the %env hash with value
1.112     bowersj2 9038: $value, if $name already exists, the entry is converted to an array
                   9039: reference and $value is added to the array.
                   9040: 
                   9041: =cut
                   9042: 
1.25      albertel 9043: sub add_to_env {
                   9044:   my ($name,$value)=@_;
1.258     albertel 9045:   if (defined($env{$name})) {
                   9046:     if (ref($env{$name})) {
1.25      albertel 9047:       #already have multiple values
1.258     albertel 9048:       push(@{ $env{$name} },$value);
1.25      albertel 9049:     } else {
                   9050:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 9051:       my $first=$env{$name};
                   9052:       undef($env{$name});
                   9053:       push(@{ $env{$name} },$first,$value);
1.25      albertel 9054:     }
                   9055:   } else {
1.258     albertel 9056:     $env{$name}=$value;
1.25      albertel 9057:   }
1.31      albertel 9058: }
1.149     albertel 9059: 
                   9060: =pod
                   9061: 
1.648     raeburn  9062: =item * &get_env_multiple($name) 
1.149     albertel 9063: 
1.258     albertel 9064: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 9065: values may be defined and end up as an array ref.
                   9066: 
                   9067: returns an array of values
                   9068: 
                   9069: =cut
                   9070: 
                   9071: sub get_env_multiple {
                   9072:     my ($name) = @_;
                   9073:     my @values;
1.258     albertel 9074:     if (defined($env{$name})) {
1.149     albertel 9075:         # exists is it an array
1.258     albertel 9076:         if (ref($env{$name})) {
                   9077:             @values=@{ $env{$name} };
1.149     albertel 9078:         } else {
1.258     albertel 9079:             $values[0]=$env{$name};
1.149     albertel 9080:         }
                   9081:     }
                   9082:     return(@values);
                   9083: }
                   9084: 
1.660     raeburn  9085: sub ask_for_embedded_content {
                   9086:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.987     raeburn  9087:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges);
1.660     raeburn  9088:     my $num = 0;
1.987     raeburn  9089:     my $numremref = 0;
                   9090:     my $numinvalid = 0;
                   9091:     my $numpathchg = 0;
                   9092:     my $numexisting = 0;
                   9093:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath);
1.984     raeburn  9094:     if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   9095:         my $current_path='/';
                   9096:         if ($env{'form.currentpath'}) {
                   9097:             $current_path = $env{'form.currentpath'};
                   9098:         }
                   9099:         if ($actionurl eq '/adm/coursegrp_portfolio') {
                   9100:             $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   9101:             $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
                   9102:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   9103:         } else {
                   9104:             $udom = $env{'user.domain'};
                   9105:             $uname = $env{'user.name'};
                   9106:             $url = '/userfiles/portfolio';
                   9107:         }
1.987     raeburn  9108:         $toplevel = $url.'/';
1.984     raeburn  9109:         $url .= $current_path;
                   9110:         $getpropath = 1;
1.987     raeburn  9111:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   9112:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      9113:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  9114:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  9115:         $toplevel = $url;
1.984     raeburn  9116:         if ($rest ne '') {
1.987     raeburn  9117:             $url .= $rest;
                   9118:         }
                   9119:     } elsif ($actionurl eq '/adm/coursedocs') {
                   9120:         if (ref($args) eq 'HASH') {
                   9121:            $url = $args->{'docs_url'};
                   9122:            $toplevel = $url;
                   9123:         }
                   9124:     }
                   9125:     my $now = time();
                   9126:     foreach my $embed_file (keys(%{$allfiles})) {
                   9127:         my $absolutepath;
                   9128:         if ($embed_file =~ m{^\w+://}) {
                   9129:             $newfiles{$embed_file} = 1;
                   9130:             $mapping{$embed_file} = $embed_file;
                   9131:         } else {
                   9132:             if ($embed_file =~ m{^/}) {
                   9133:                 $absolutepath = $embed_file;
                   9134:                 $embed_file =~ s{^(/+)}{};
                   9135:             }
                   9136:             if ($embed_file =~ m{/}) {
                   9137:                 my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
                   9138:                 $path = &check_for_traversal($path,$url,$toplevel);
                   9139:                 my $item = $fname;
                   9140:                 if ($path ne '') {
                   9141:                     $item = $path.'/'.$fname;
                   9142:                     $subdependencies{$path}{$fname} = 1;
                   9143:                 } else {
                   9144:                     $dependencies{$item} = 1;
                   9145:                 }
                   9146:                 if ($absolutepath) {
                   9147:                     $mapping{$item} = $absolutepath;
                   9148:                 } else {
                   9149:                     $mapping{$item} = $embed_file;
                   9150:                 }
                   9151:             } else {
                   9152:                 $dependencies{$embed_file} = 1;
                   9153:                 if ($absolutepath) {
                   9154:                     $mapping{$embed_file} = $absolutepath;
                   9155:                 } else {
                   9156:                     $mapping{$embed_file} = $embed_file;
                   9157:                 }
                   9158:             }
1.984     raeburn  9159:         }
                   9160:     }
                   9161:     foreach my $path (keys(%subdependencies)) {
                   9162:         my %currsubfile;
                   9163:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  9164:             my ($sublistref,$listerror) =
                   9165:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   9166:             if (ref($sublistref) eq 'ARRAY') {
                   9167:                 foreach my $line (@{$sublistref}) {
                   9168:                     my ($file_name,$rest) = split(/\&/,$line,2);
                   9169:                     $currsubfile{$file_name} = 1;
                   9170:                 }
1.984     raeburn  9171:             }
1.987     raeburn  9172:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  9173:             if (opendir(my $dir,$url.'/'.$path)) {
                   9174:                 my @subdir_list = grep(!/^\./,readdir($dir));
                   9175:                 map {$currsubfile{$_} = 1;} @subdir_list;
                   9176:             }
                   9177:         }
                   9178:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.987     raeburn  9179:             if ($currsubfile{$file}) {
                   9180:                 my $item = $path.'/'.$file;
                   9181:                 unless ($mapping{$item} eq $item) {
                   9182:                     $pathchanges{$item} = 1;
                   9183:                 }
                   9184:                 $existing{$item} = 1;
                   9185:                 $numexisting ++;
                   9186:             } else {
                   9187:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  9188:             }
                   9189:         }
                   9190:     }
1.987     raeburn  9191:     my %currfile;
1.984     raeburn  9192:     if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  9193:         my ($dirlistref,$listerror) =
                   9194:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   9195:         if (ref($dirlistref) eq 'ARRAY') {
                   9196:             foreach my $line (@{$dirlistref}) {
                   9197:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   9198:                 $currfile{$file_name} = 1;
                   9199:             }
1.984     raeburn  9200:         }
1.987     raeburn  9201:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  9202:         if (opendir(my $dir,$url)) {
1.987     raeburn  9203:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  9204:             map {$currfile{$_} = 1;} @dir_list;
                   9205:         }
                   9206:     }
                   9207:     foreach my $file (keys(%dependencies)) {
1.987     raeburn  9208:         if ($currfile{$file}) {
                   9209:             unless ($mapping{$file} eq $file) {
                   9210:                 $pathchanges{$file} = 1;
                   9211:             }
                   9212:             $existing{$file} = 1;
                   9213:             $numexisting ++;
                   9214:         } else {
1.984     raeburn  9215:             $newfiles{$file} = 1;
                   9216:         }
                   9217:     }
                   9218:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.660     raeburn  9219:         $upload_output .= &start_data_table_row().
1.987     raeburn  9220:                           '<td><span class="LC_filename">'.$embed_file.'</span>';
                   9221:         unless ($mapping{$embed_file} eq $embed_file) {
                   9222:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
                   9223:         }
                   9224:         $upload_output .= '</td><td>';
1.660     raeburn  9225:         if ($args->{'ignore_remote_references'}
                   9226:             && $embed_file =~ m{^\w+://}) {
                   9227:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987     raeburn  9228:             $numremref++;
1.660     raeburn  9229:         } elsif ($args->{'error_on_invalid_names'}
                   9230:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   9231: 
1.987     raeburn  9232:             $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
                   9233:             $numinvalid++;
1.660     raeburn  9234:         } else {
1.987     raeburn  9235:             $upload_output .= &embedded_file_element('upload_embedded',$num,
                   9236:                                                      $embed_file,\%mapping,
                   9237:                                                      $allfiles,$codebase);
                   9238:             $num++;
                   9239:         }
                   9240:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   9241:     }
                   9242:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
                   9243:         $upload_output .= &start_data_table_row().
                   9244:                           '<td><span class="LC_filename">'.$embed_file.'</span></td>'.
                   9245:                           '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
                   9246:                           &Apache::loncommon::end_data_table_row()."\n";
                   9247:     }
                   9248:     if ($upload_output) {
                   9249:         $upload_output = &start_data_table().
                   9250:                          $upload_output.
                   9251:                          &end_data_table()."\n";
                   9252:     }
                   9253:     my $applies = 0;
                   9254:     if ($numremref) {
                   9255:         $applies ++;
                   9256:     }
                   9257:     if ($numinvalid) {
                   9258:         $applies ++;
                   9259:     }
                   9260:     if ($numexisting) {
                   9261:         $applies ++;
                   9262:     }
                   9263:     if ($num) {
                   9264:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   9265:                   ' method="post" enctype="multipart/form-data">'."\n".
                   9266:                   $state.
                   9267:                   '<h3>'.&mt('Upload embedded files').
                   9268:                   ':</h3>'.$upload_output.'<br />'."\n".
                   9269:                   '<input type ="hidden" name="number_embedded_items" value="'.
                   9270:                   $num.'" />'."\n";
                   9271:         if ($actionurl eq '') {
                   9272:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   9273:         }
                   9274:     } elsif ($applies) {
                   9275:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   9276:         if ($applies > 1) {
                   9277:             $output .=  
                   9278:                 &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
                   9279:             if ($numremref) {
                   9280:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   9281:             }
                   9282:             if ($numinvalid) {
                   9283:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   9284:             }
                   9285:             if ($numexisting) {
                   9286:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   9287:             }
                   9288:             $output .= '</ul><br />';
                   9289:         } elsif ($numremref) {
                   9290:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   9291:         } elsif ($numinvalid) {
                   9292:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   9293:         } elsif ($numexisting) {
                   9294:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   9295:         }
                   9296:         $output .= $upload_output.'<br />';
                   9297:     }
                   9298:     my ($pathchange_output,$chgcount);
                   9299:     $chgcount = $num;
                   9300:     if (keys(%pathchanges) > 0) {
                   9301:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
                   9302:             if ($num) {
                   9303:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   9304:                                                   $embed_file,\%mapping,
                   9305:                                                   $allfiles,$codebase);
                   9306:             } else {
                   9307:                 $pathchange_output .= 
                   9308:                     &start_data_table_row().
                   9309:                     '<td><input type ="checkbox" name="namechange" value="'.
                   9310:                     $chgcount.'" checked="checked" /></td>'.
                   9311:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   9312:                     '<td>'.$embed_file.
                   9313:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
                   9314:                                            \%mapping,$allfiles,$codebase).
                   9315:                     '</td>'.&end_data_table_row();
1.660     raeburn  9316:             }
1.987     raeburn  9317:             $numpathchg ++;
                   9318:             $chgcount ++;
1.660     raeburn  9319:         }
                   9320:     }
1.984     raeburn  9321:     if ($num) {
1.987     raeburn  9322:         if ($numpathchg) {
                   9323:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   9324:                        $numpathchg.'" />'."\n";
                   9325:         }
                   9326:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   9327:             ($actionurl eq '/adm/imsimport')) {
                   9328:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   9329:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   9330:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
                   9331:         }
                   9332:         $output .=  '<input type ="submit" value="'.&mt('Upload Listed Files').'" />'."\n".
                   9333:                     &mt('(only files for which a location has been provided will be uploaded)').'</form>'."\n";
                   9334:     } elsif ($numpathchg) {
                   9335:         my %pathchange = ();
                   9336:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   9337:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   9338:             $output .= '<p>'.&mt('or').'</p>'; 
                   9339:         } 
                   9340:     }
                   9341:     return ($output,$num,$numpathchg);
                   9342: }
                   9343: 
                   9344: sub embedded_file_element {
                   9345:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase) = @_;
                   9346:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   9347:                    (ref($codebase) eq 'HASH'));
                   9348:     my $output;
                   9349:     if ($context eq 'upload_embedded') {
                   9350:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   9351:     }
                   9352:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   9353:                &escape($embed_file).'" />';
                   9354:     unless (($context eq 'upload_embedded') && 
                   9355:             ($mapping->{$embed_file} eq $embed_file)) {
                   9356:         $output .='
                   9357:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   9358:     }
                   9359:     my $attrib;
                   9360:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   9361:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   9362:     }
                   9363:     $output .=
                   9364:         "\n\t\t".
                   9365:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   9366:         $attrib.'" />';
                   9367:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   9368:         $output .=
                   9369:             "\n\t\t".
                   9370:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   9371:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  9372:     }
1.987     raeburn  9373:     return $output;
1.660     raeburn  9374: }
                   9375: 
1.661     raeburn  9376: sub upload_embedded {
                   9377:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  9378:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   9379:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  9380:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   9381:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   9382:         my $orig_uploaded_filename =
                   9383:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  9384:         foreach my $type ('orig','ref','attrib','codebase') {
                   9385:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   9386:                 $env{'form.embedded_'.$type.'_'.$i} =
                   9387:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   9388:             }
                   9389:         }
1.661     raeburn  9390:         my ($path,$fname) =
                   9391:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   9392:         # no path, whole string is fname
                   9393:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   9394:         $fname = &Apache::lonnet::clean_filename($fname);
                   9395:         # See if there is anything left
                   9396:         next if ($fname eq '');
                   9397: 
                   9398:         # Check if file already exists as a file or directory.
                   9399:         my ($state,$msg);
                   9400:         if ($context eq 'portfolio') {
                   9401:             my $port_path = $dirpath;
                   9402:             if ($group ne '') {
                   9403:                 $port_path = "groups/$group/$port_path";
                   9404:             }
1.987     raeburn  9405:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   9406:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  9407:                                               $dir_root,$port_path,$disk_quota,
                   9408:                                               $current_disk_usage,$uname,$udom);
                   9409:             if ($state eq 'will_exceed_quota'
1.984     raeburn  9410:                 || $state eq 'file_locked') {
1.661     raeburn  9411:                 $output .= $msg;
                   9412:                 next;
                   9413:             }
                   9414:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   9415:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   9416:             if ($state eq 'exists') {
                   9417:                 $output .= $msg;
                   9418:                 next;
                   9419:             }
                   9420:         }
                   9421:         # Check if extension is valid
                   9422:         if (($fname =~ /\.(\w+)$/) &&
                   9423:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987     raeburn  9424:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1).'<br />';
1.661     raeburn  9425:             next;
                   9426:         } elsif (($fname =~ /\.(\w+)$/) &&
                   9427:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  9428:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  9429:             next;
                   9430:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987     raeburn  9431:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2).'<br />';
1.661     raeburn  9432:             next;
                   9433:         }
                   9434: 
                   9435:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   9436:         if ($context eq 'portfolio') {
1.984     raeburn  9437:             my $result;
                   9438:             if ($state eq 'existingfile') {
                   9439:                 $result=
                   9440:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987     raeburn  9441:                                                     $dirpath.$env{'form.currentpath'}.$path);
1.661     raeburn  9442:             } else {
1.984     raeburn  9443:                 $result=
                   9444:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  9445:                                                     $dirpath.
                   9446:                                                     $env{'form.currentpath'}.$path);
1.984     raeburn  9447:                 if ($result !~ m|^/uploaded/|) {
                   9448:                     $output .= '<span class="LC_error">'
                   9449:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   9450:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   9451:                                .'</span><br />';
                   9452:                     next;
                   9453:                 } else {
1.987     raeburn  9454:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9455:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  9456:                 }
1.661     raeburn  9457:             }
1.987     raeburn  9458:         } elsif ($context eq 'coursedoc') {
                   9459:             my $result =
                   9460:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
                   9461:                                                 $dirpath.'/'.$path);
                   9462:             if ($result !~ m|^/uploaded/|) {
                   9463:                 $output .= '<span class="LC_error">'
                   9464:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   9465:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   9466:                            .'</span><br />';
                   9467:                     next;
                   9468:             } else {
                   9469:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9470:                            $path.$fname.'</span>').'<br />';
                   9471:             }
1.661     raeburn  9472:         } else {
                   9473: # Save the file
                   9474:             my $target = $env{'form.embedded_item_'.$i};
                   9475:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   9476:             my $dest = $fullpath.$fname;
                   9477:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  9478:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  9479:             my $count;
                   9480:             my $filepath = $dir_root;
1.1027    raeburn  9481:             foreach my $subdir (@parts) {
                   9482:                 $filepath .= "/$subdir";
                   9483:                 if (!-e $filepath) {
1.661     raeburn  9484:                     mkdir($filepath,0770);
                   9485:                 }
                   9486:             }
                   9487:             my $fh;
                   9488:             if (!open($fh,'>'.$dest)) {
                   9489:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   9490:                 $output .= '<span class="LC_error">'.
                   9491:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   9492:                            '</span><br />';
                   9493:             } else {
                   9494:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   9495:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   9496:                     $output .= '<span class="LC_error">'.
                   9497:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   9498:                               '</span><br />';
                   9499:                 } else {
1.987     raeburn  9500:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9501:                                $url.'</span>').'<br />';
                   9502:                     unless ($context eq 'testbank') {
                   9503:                         $footer .= &mt('View embedded file: [_1]',
                   9504:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   9505:                     }
                   9506:                 }
                   9507:                 close($fh);
                   9508:             }
                   9509:         }
                   9510:         if ($env{'form.embedded_ref_'.$i}) {
                   9511:             $pathchange{$i} = 1;
                   9512:         }
                   9513:     }
                   9514:     if ($output) {
                   9515:         $output = '<p>'.$output.'</p>';
                   9516:     }
                   9517:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   9518:     $returnflag = 'ok';
                   9519:     if (keys(%pathchange) > 0) {
                   9520:         if ($context eq 'portfolio') {
                   9521:             $output .= '<p>'.&mt('or').'</p>';
                   9522:         } elsif ($context eq 'testbank') {
1.988     raeburn  9523:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).','<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  9524:             $returnflag = 'modify_orightml';
                   9525:         }
                   9526:     }
                   9527:     return ($output.$footer,$returnflag);
                   9528: }
                   9529: 
                   9530: sub modify_html_form {
                   9531:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   9532:     my $end = 0;
                   9533:     my $modifyform;
                   9534:     if ($context eq 'upload_embedded') {
                   9535:         return unless (ref($pathchange) eq 'HASH');
                   9536:         if ($env{'form.number_embedded_items'}) {
                   9537:             $end += $env{'form.number_embedded_items'};
                   9538:         }
                   9539:         if ($env{'form.number_pathchange_items'}) {
                   9540:             $end += $env{'form.number_pathchange_items'};
                   9541:         }
                   9542:         if ($end) {
                   9543:             for (my $i=0; $i<$end; $i++) {
                   9544:                 if ($i < $env{'form.number_embedded_items'}) {
                   9545:                     next unless($pathchange->{$i});
                   9546:                 }
                   9547:                 $modifyform .=
                   9548:                     &start_data_table_row().
                   9549:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   9550:                     'checked="checked" /></td>'.
                   9551:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   9552:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   9553:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   9554:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   9555:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   9556:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   9557:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   9558:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   9559:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   9560:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   9561:                     &end_data_table_row();
                   9562:             } 
                   9563:         }
                   9564:     } else {
                   9565:         $modifyform = $pathchgtable;
                   9566:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   9567:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   9568:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   9569:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   9570:         }
                   9571:     }
                   9572:     if ($modifyform) {
                   9573:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   9574:                '<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".
                   9575:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   9576:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   9577:                '</ol></p>'."\n".'<p>'.
                   9578:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   9579:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   9580:                &start_data_table()."\n".
                   9581:                &start_data_table_header_row().
                   9582:                '<th>'.&mt('Change?').'</th>'.
                   9583:                '<th>'.&mt('Current reference').'</th>'.
                   9584:                '<th>'.&mt('Required reference').'</th>'.
                   9585:                &end_data_table_header_row()."\n".
                   9586:                $modifyform.
                   9587:                &end_data_table().'<br />'."\n".$hiddenstate.
                   9588:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   9589:                '</form>'."\n";
                   9590:     }
                   9591:     return;
                   9592: }
                   9593: 
                   9594: sub modify_html_refs {
                   9595:     my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
                   9596:     my $container;
                   9597:     if ($context eq 'portfolio') {
                   9598:         $container = $env{'form.container'};
                   9599:     } elsif ($context eq 'coursedoc') {
                   9600:         $container = $env{'form.primaryurl'};
                   9601:     } else {
1.1027    raeburn  9602:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  9603:     }
                   9604:     my (%allfiles,%codebase,$output,$content);
                   9605:     my @changes = &get_env_multiple('form.namechange');
                   9606:     return unless (@changes > 0);
                   9607:     if (($context eq 'portfolio') || ($context eq 'coursedoc')) {
                   9608:         return unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/});
                   9609:         $content = &Apache::lonnet::getfile($container);
                   9610:         return if ($content eq '-1');
                   9611:     } else {
                   9612:         return unless ($container =~ /^\Q$dir_root\E/); 
                   9613:         if (open(my $fh,"<$container")) {
                   9614:             $content = join('', <$fh>);
                   9615:             close($fh);
                   9616:         } else {
                   9617:             return;
                   9618:         }
                   9619:     }
                   9620:     my ($count,$codebasecount) = (0,0);
                   9621:     my $mm = new File::MMagic;
                   9622:     my $mime_type = $mm->checktype_contents($content);
                   9623:     if ($mime_type eq 'text/html') {
                   9624:         my $parse_result = 
                   9625:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   9626:                                                     \%codebase,\$content);
                   9627:         if ($parse_result eq 'ok') {
                   9628:             foreach my $i (@changes) {
                   9629:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   9630:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   9631:                 if ($allfiles{$ref}) {
                   9632:                     my $newname =  $orig;
                   9633:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  9634:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  9635:                     if ($attrib_regexp =~ /:/) {
                   9636:                         $attrib_regexp =~ s/\:/|/g;
                   9637:                     }
                   9638:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   9639:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   9640:                         $count += $numchg;
                   9641:                     }
                   9642:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  9643:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  9644:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   9645:                         $codebasecount ++;
                   9646:                     }
                   9647:                 }
                   9648:             }
                   9649:             if ($count || $codebasecount) {
                   9650:                 my $saveresult;
                   9651:                 if ($context eq 'portfolio' || $context eq 'coursedoc') {
                   9652:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   9653:                     if ($url eq $container) {
                   9654:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   9655:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   9656:                                             $count,'<span class="LC_filename">'.
                   9657:                                             $fname.'</span>').'</p>'; 
                   9658:                     } else {
                   9659:                          $output = '<p class="LC_error">'.
                   9660:                                    &mt('Error: update failed for: [_1].',
                   9661:                                    '<span class="LC_filename">'.
                   9662:                                    $container.'</span>').'</p>';
                   9663:                     }
                   9664:                 } else {
                   9665:                     if (open(my $fh,">$container")) {
                   9666:                         print $fh $content;
                   9667:                         close($fh);
                   9668:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   9669:                                   $count,'<span class="LC_filename">'.
                   9670:                                   $container.'</span>').'</p>';
1.661     raeburn  9671:                     } else {
1.987     raeburn  9672:                          $output = '<p class="LC_error">'.
                   9673:                                    &mt('Error: could not update [_1].',
                   9674:                                    '<span class="LC_filename">'.
                   9675:                                    $container.'</span>').'</p>';
1.661     raeburn  9676:                     }
                   9677:                 }
                   9678:             }
1.987     raeburn  9679:         } else {
                   9680:             &logthis('Failed to parse '.$container.
                   9681:                      ' to modify references: '.$parse_result);
1.661     raeburn  9682:         }
                   9683:     }
                   9684:     return $output;
                   9685: }
                   9686: 
                   9687: sub check_for_existing {
                   9688:     my ($path,$fname,$element) = @_;
                   9689:     my ($state,$msg);
                   9690:     if (-d $path.'/'.$fname) {
                   9691:         $state = 'exists';
                   9692:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   9693:     } elsif (-e $path.'/'.$fname) {
                   9694:         $state = 'exists';
                   9695:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   9696:     }
                   9697:     if ($state eq 'exists') {
                   9698:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   9699:     }
                   9700:     return ($state,$msg);
                   9701: }
                   9702: 
                   9703: sub check_for_upload {
                   9704:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   9705:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  9706:     my $filesize = length($env{'form.'.$element});
                   9707:     if (!$filesize) {
                   9708:         my $msg = '<span class="LC_error">'.
                   9709:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   9710:                       '<span class="LC_filename">'.$fname.'</span>',
                   9711:                       $filesize).'<br />'.
1.1007    raeburn  9712:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  9713:                   '</span>';
                   9714:         return ('zero_bytes',$msg);
                   9715:     }
                   9716:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  9717:     my $getpropath = 1;
1.1021    raeburn  9718:     my ($dirlistref,$listerror) =
                   9719:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  9720:     my $found_file = 0;
                   9721:     my $locked_file = 0;
1.991     raeburn  9722:     my @lockers;
                   9723:     my $navmap;
                   9724:     if ($env{'request.course.id'}) {
                   9725:         $navmap = Apache::lonnavmaps::navmap->new();
                   9726:     }
1.1021    raeburn  9727:     if (ref($dirlistref) eq 'ARRAY') {
                   9728:         foreach my $line (@{$dirlistref}) {
                   9729:             my ($file_name,$rest)=split(/\&/,$line,2);
                   9730:             if ($file_name eq $fname){
                   9731:                 $file_name = $path.$file_name;
                   9732:                 if ($group ne '') {
                   9733:                     $file_name = $group.$file_name;
                   9734:                 }
                   9735:                 $found_file = 1;
                   9736:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   9737:                     foreach my $lock (@lockers) {
                   9738:                         if (ref($lock) eq 'ARRAY') {
                   9739:                             my ($symb,$crsid) = @{$lock};
                   9740:                             if ($crsid eq $env{'request.course.id'}) {
                   9741:                                 if (ref($navmap)) {
                   9742:                                     my $res = $navmap->getBySymb($symb);
                   9743:                                     foreach my $part (@{$res->parts()}) { 
                   9744:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   9745:                                         unless (($slot_status == $res->RESERVED) ||
                   9746:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   9747:                                             $locked_file = 1;
                   9748:                                         }
1.991     raeburn  9749:                                     }
1.1021    raeburn  9750:                                 } else {
                   9751:                                     $locked_file = 1;
1.991     raeburn  9752:                                 }
                   9753:                             } else {
                   9754:                                 $locked_file = 1;
                   9755:                             }
                   9756:                         }
1.1021    raeburn  9757:                    }
                   9758:                 } else {
                   9759:                     my @info = split(/\&/,$rest);
                   9760:                     my $currsize = $info[6]/1000;
                   9761:                     if ($currsize < $filesize) {
                   9762:                         my $extra = $filesize - $currsize;
                   9763:                         if (($current_disk_usage + $extra) > $disk_quota) {
                   9764:                             my $msg = '<span class="LC_error">'.
                   9765:                                       &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.',
                   9766:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
                   9767:                                       '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   9768:                                                    $disk_quota,$current_disk_usage);
                   9769:                             return ('will_exceed_quota',$msg);
                   9770:                         }
1.984     raeburn  9771:                     }
                   9772:                 }
1.661     raeburn  9773:             }
                   9774:         }
                   9775:     }
                   9776:     if (($current_disk_usage + $filesize) > $disk_quota){
                   9777:         my $msg = '<span class="LC_error">'.
                   9778:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   9779:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   9780:         return ('will_exceed_quota',$msg);
                   9781:     } elsif ($found_file) {
                   9782:         if ($locked_file) {
                   9783:             my $msg = '<span class="LC_error">';
                   9784:             $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>');
                   9785:             $msg .= '</span><br />';
                   9786:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   9787:             return ('file_locked',$msg);
                   9788:         } else {
                   9789:             my $msg = '<span class="LC_error">';
1.984     raeburn  9790:             $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
1.661     raeburn  9791:             $msg .= '</span>';
1.984     raeburn  9792:             return ('existingfile',$msg);
1.661     raeburn  9793:         }
                   9794:     }
                   9795: }
                   9796: 
1.987     raeburn  9797: sub check_for_traversal {
                   9798:     my ($path,$url,$toplevel) = @_;
                   9799:     my @parts=split(/\//,$path);
                   9800:     my $cleanpath;
                   9801:     my $fullpath = $url;
                   9802:     for (my $i=0;$i<@parts;$i++) {
                   9803:         next if ($parts[$i] eq '.');
                   9804:         if ($parts[$i] eq '..') {
                   9805:             $fullpath =~ s{([^/]+/)$}{};
                   9806:         } else {
                   9807:             $fullpath .= $parts[$i].'/';
                   9808:         }
                   9809:     }
                   9810:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   9811:         $cleanpath = $1;
                   9812:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   9813:         my $curr_toprel = $1;
                   9814:         my @parts = split(/\//,$curr_toprel);
                   9815:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   9816:         my @urlparts = split(/\//,$url_toprel);
                   9817:         my $doubledots;
                   9818:         my $startdiff = -1;
                   9819:         for (my $i=0; $i<@urlparts; $i++) {
                   9820:             if ($startdiff == -1) {
                   9821:                 unless ($urlparts[$i] eq $parts[$i]) {
                   9822:                     $startdiff = $i;
                   9823:                     $doubledots .= '../';
                   9824:                 }
                   9825:             } else {
                   9826:                 $doubledots .= '../';
                   9827:             }
                   9828:         }
                   9829:         if ($startdiff > -1) {
                   9830:             $cleanpath = $doubledots;
                   9831:             for (my $i=$startdiff; $i<@parts; $i++) {
                   9832:                 $cleanpath .= $parts[$i].'/';
                   9833:             }
                   9834:         }
                   9835:     }
                   9836:     $cleanpath =~ s{(/)$}{};
                   9837:     return $cleanpath;
                   9838: }
1.31      albertel 9839: 
1.1053    raeburn  9840: sub is_archive_file {
                   9841:     my ($mimetype) = @_;
                   9842:     if (($mimetype eq 'application/octet-stream') ||
                   9843:         ($mimetype eq 'application/x-stuffit') ||
                   9844:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   9845:         return 1;
                   9846:     }
                   9847:     return;
                   9848: }
                   9849: 
                   9850: sub decompress_form {
                   9851:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements) = @_;
                   9852:     my %lt = &Apache::lonlocal::texthash (
                   9853:         this => 'This file is an archive file.',
                   9854:         youm => 'You may wish to extract its contents.',
                   9855:         camt => 'Extraction of contents is recommended for Camtasia zip files.',
                   9856:         perm => 'Permanently remove archive file after extraction of contents?',
                   9857:         extr => 'Extract contents',
                   9858:         yes  => 'Yes',
                   9859:         no   => 'No',
                   9860:     );
                   9861:     my $output = '<p>'.$lt{'this'}.' '.$lt{'youm'}.'<br />';
                   9862:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
                   9863:         $output .= $lt{'camt'};
                   9864:     }
                   9865:     $output .= '</p>';
                   9866:     $output .= <<"START";
                   9867: <div id="uploadfileresult">
                   9868:   <form name="uploaded_decompress" action="$action" method="post">
                   9869:   <input type="hidden" name="archiveurl" value="$archiveurl" />
                   9870: START
                   9871:     if (ref($hiddenelements) eq 'HASH') {
                   9872:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   9873:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   9874:         }
                   9875:     }
                   9876:     $output .= <<"END";
                   9877: <span class="LC_nobreak">$lt{'perm'}&nbsp;
                   9878: <label><input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}</label>&nbsp;&nbsp;
                   9879: <label><input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label></span><br />
                   9880: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   9881: </form>
                   9882: $noextract
                   9883: </div>
                   9884: END
                   9885:     return $output;
                   9886: }
                   9887: 
                   9888: sub decompress_uploaded_file {
                   9889:     my ($file,$dir) = @_;
                   9890:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   9891:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   9892:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   9893:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   9894:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   9895:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   9896:     my $decompressed = $env{'cgi.decompressed'};
                   9897:     &Apache::lonnet::delenv('cgi.file');
                   9898:     &Apache::lonnet::delenv('cgi.dir');
                   9899:     &Apache::lonnet::delenv('cgi.decompressed');
                   9900:     return ($decompressed,$result);
                   9901: }
                   9902: 
1.1055    raeburn  9903: sub process_decompression {
                   9904:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
                   9905:     my ($dir,$error,$warning,$output);
                   9906:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
                   9907:         $error = &mt('File name not a supported archive file type.').
                   9908:                  '<br />'.&mt('File name should end with one of: [_1].',
                   9909:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   9910:     } else {
                   9911:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   9912:         if ($docuhome eq 'no_host') {
                   9913:             $error = &mt('Could not determine home server for course.');
                   9914:         } else {
                   9915:             my @ids=&Apache::lonnet::current_machine_ids();
                   9916:             my $currdir = "$dir_root/$destination";
                   9917:             my ($currdirlistref,$currlisterror) =
                   9918:                 &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   9919:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   9920:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   9921:                        "$dir_root/$destination";
                   9922:             } else {
                   9923:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   9924:                        "$dir_root/$docudom/$docuname/$destination";
                   9925:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   9926:                     $error = &mt('Archive file not found.');
                   9927:                 }
                   9928:             }
                   9929:             if ($dir eq '') {
                   9930:                 $error = &mt('Directory containing archive file unavailable.');
                   9931:             } elsif (!$error) {
                   9932:                 my ($decompressed,$display) = &decompress_uploaded_file($file,$dir);
                   9933:                 if ($decompressed eq 'ok') {
                   9934:                     $output = &mt('Files extracted successfully from archive.').'<br />';
                   9935:                     my ($warning,$result,@contents);
                   9936:                     my ($newdirlistref,$newlisterror) =
                   9937:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   9938:                                                  $docuname,1);
                   9939:                     my (%is_dir,%changes,@newitems);
                   9940:                     my $dirptr = 16384;
                   9941:                     if (ref($currdirlistref) eq 'ARRAY') {
                   9942:                         my @curritems;
                   9943:                         foreach my $dir_line (@{$currdirlistref}) {
                   9944:                             my ($item,$rest)=split(/\&/,$dir_line,2);
                   9945:                             unless ($item =~ /\.+$/) {
                   9946:                                 push(@curritems,$item);
                   9947:                             }
                   9948:                         }
                   9949:                         if (ref($newdirlistref) eq 'ARRAY') {
                   9950:                             foreach my $dir_line (@{$newdirlistref}) {
                   9951:                                 my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,4);
                   9952:                                 unless ($item =~ /^\.+$/) {
                   9953:                                     if ($dirptr&$testdir) {
                   9954:                                         $is_dir{$item} = 1;
                   9955:                                     }
                   9956:                                     push(@newitems,$item);
                   9957:                                 }
                   9958:                             }
                   9959:                             my @diffs = &compare_arrays(\@curritems,\@newitems);
                   9960:                             if (@diffs > 0) {
                   9961:                                foreach my $item (@diffs) {
                   9962:                                    $changes{$item} = 1;
                   9963:                                }
                   9964:                             }
                   9965:                         }
                   9966:                     } elsif (ref($newdirlistref) eq 'ARRAY') {
                   9967:                         foreach my $dir_line (@{$newdirlistref}) {
                   9968:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   9969:                             unless ($item =~ /\.+$/) {
                   9970:                                 push(@newitems,$item);
                   9971:                                 if ($dirptr&$testdir) {
                   9972:                                     $is_dir{$item} = 1;
                   9973:                                 }
                   9974:                                 $changes{$item} = 1;
                   9975:                             }
                   9976:                         }
                   9977:                     }
                   9978:                     if (keys(%changes) > 0) {
                   9979:                         foreach my $item (sort(@newitems)) {
                   9980:                             if ($changes{$item}) {
                   9981:                                 push(@contents,$item);
                   9982:                             }
                   9983:                         }
                   9984:                     }
                   9985:                     if (@contents > 0) {
1.1056    raeburn  9986:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  9987:                         my $wantform = 1;
                   9988:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   9989:                                                                 $currdir,\%is_dir,
                   9990:                                                                 \%children,\%parent,
1.1056    raeburn  9991:                                                                 \@contents,\%dirorder,
                   9992:                                                                 \%titles,$wantform);
1.1055    raeburn  9993:                         if ($datatable ne '') {
                   9994:                             $output .= &archive_options_form('decompressed',$datatable,
                   9995:                                                              $count,$hiddenelem);
1.1056    raeburn  9996:                             my $startcount = 4;
1.1055    raeburn  9997:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  9998:                                                            \%titles,\%children);
1.1055    raeburn  9999:                         }
                   10000:                     } else {
                   10001:                         $warning = &mt('No new items extracted from archive file.');
                   10002:                     }
                   10003:                 } else {
                   10004:                     $output = $display;
                   10005:                     $error = &mt('An error occurred during extraction from the archive file.');
                   10006:                 }
                   10007:             }
                   10008:         }
                   10009:     }
                   10010:     if ($error) {
                   10011:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   10012:                    $error.'</p>'."\n";
                   10013:     }
                   10014:     if ($warning) {
                   10015:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   10016:     }
                   10017:     return $output;
                   10018: }
                   10019: 
                   10020: sub get_extracted {
1.1056    raeburn  10021:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   10022:         $titles,$wantform) = @_;
1.1055    raeburn  10023:     my $count = 0;
                   10024:     my $depth = 0;
                   10025:     my $datatable;
1.1056    raeburn  10026:     my @hierarchy;
1.1055    raeburn  10027:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  10028:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   10029:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  10030:     foreach my $item (@{$contents}) {
                   10031:         $count ++;
1.1056    raeburn  10032:         @{$dirorder->{$count}} = @hierarchy;
                   10033:         $titles->{$count} = $item;
1.1055    raeburn  10034:         &archive_hierarchy($depth,$count,$parent,$children);
                   10035:         if ($wantform) {
                   10036:             $datatable .= &archive_row($is_dir->{$item},$item,
                   10037:                                        $currdir,$depth,$count);
                   10038:         }
                   10039:         if ($is_dir->{$item}) {
                   10040:             $depth ++;
1.1056    raeburn  10041:             push(@hierarchy,$count);
                   10042:             $parent->{$depth} = $count;
1.1055    raeburn  10043:             $datatable .=
                   10044:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  10045:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   10046:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  10047:             $depth --;
1.1056    raeburn  10048:             pop(@hierarchy);
1.1055    raeburn  10049:         }
                   10050:     }
                   10051:     return ($count,$datatable);
                   10052: }
                   10053: 
                   10054: sub recurse_extracted_archive {
1.1056    raeburn  10055:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   10056:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  10057:     my $result='';
1.1056    raeburn  10058:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   10059:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   10060:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  10061:         return $result;
                   10062:     }
                   10063:     my $dirptr = 16384;
                   10064:     my ($newdirlistref,$newlisterror) =
                   10065:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   10066:     if (ref($newdirlistref) eq 'ARRAY') {
                   10067:         foreach my $dir_line (@{$newdirlistref}) {
                   10068:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   10069:             unless ($item =~ /^\.+$/) {
                   10070:                 $$count ++;
1.1056    raeburn  10071:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   10072:                 $titles->{$$count} = $item;
1.1055    raeburn  10073:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  10074: 
1.1055    raeburn  10075:                 my $is_dir;
                   10076:                 if ($dirptr&$testdir) {
                   10077:                     $is_dir = 1;
                   10078:                 }
                   10079:                 if ($wantform) {
                   10080:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   10081:                 }
                   10082:                 if ($is_dir) {
                   10083:                     $$depth ++;
1.1056    raeburn  10084:                     push(@{$hierarchy},$$count);
                   10085:                     $parent->{$$depth} = $$count;
1.1055    raeburn  10086:                     $result .=
                   10087:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   10088:                                                    $docuname,$depth,$count,
1.1056    raeburn  10089:                                                    $hierarchy,$dirorder,$children,
                   10090:                                                    $parent,$titles,$wantform);
1.1055    raeburn  10091:                     $$depth --;
1.1056    raeburn  10092:                     pop(@{$hierarchy});
1.1055    raeburn  10093:                 }
                   10094:             }
                   10095:         }
                   10096:     }
                   10097:     return $result;
                   10098: }
                   10099: 
                   10100: sub archive_hierarchy {
                   10101:     my ($depth,$count,$parent,$children) =@_;
                   10102:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   10103:         if (exists($parent->{$depth})) {
                   10104:              $children->{$parent->{$depth}} .= $count.':';
                   10105:         }
                   10106:     }
                   10107:     return;
                   10108: }
                   10109: 
                   10110: sub archive_row {
                   10111:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   10112:     my ($name) = ($item =~ m{([^/]+)$});
                   10113:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  10114:                                        'display'    => 'Add as file',
1.1055    raeburn  10115:                                        'dependency' => 'Include as dependency',
                   10116:                                        'discard'    => 'Discard',
                   10117:                                       );
                   10118:     if ($is_dir) {
1.1059    raeburn  10119:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  10120:     }
1.1056    raeburn  10121:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   10122:     my $offset = 0;
1.1055    raeburn  10123:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  10124:         $offset ++;
1.1055    raeburn  10125:         $output .= '<td><span class="LC_nobreak">'.
                   10126:                    '<label><input type="radio" name="archive_'.$count.
                   10127:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   10128:         my $text = $choices{$action};
                   10129:         if ($is_dir) {
                   10130:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   10131:             if ($action eq 'display') {
1.1059    raeburn  10132:                 $text = &mt('Add as folder');
1.1055    raeburn  10133:             }
1.1056    raeburn  10134:         } else {
                   10135:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   10136: 
                   10137:         }
                   10138:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   10139:         if ($action eq 'dependency') {
                   10140:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   10141:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   10142:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   10143:                        '<option value=""></option>'."\n".
                   10144:                        '</select>'."\n".
                   10145:                        '</div>';
1.1059    raeburn  10146:         } elsif ($action eq 'display') {
                   10147:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   10148:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   10149:                        '</div>';
1.1055    raeburn  10150:         }
1.1056    raeburn  10151:         $output .= '</td>';
1.1055    raeburn  10152:     }
                   10153:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   10154:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   10155:     for (my $i=0; $i<$depth; $i++) {
                   10156:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   10157:     }
                   10158:     if ($is_dir) {
                   10159:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   10160:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   10161:     } else {
                   10162:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   10163:     }
                   10164:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   10165:                &end_data_table_row();
                   10166:     return $output;
                   10167: }
                   10168: 
                   10169: sub archive_options_form {
                   10170:     my ($form,$output,$count,$hiddenelem) = @_;
                   10171:     return '<form name="'.$form.'" method="post" action="">'."\n".
                   10172:            '<input type="hidden" name="phase" value="decompress_cleanup" />'."\n".
                   10173:                     '<p>'.
                   10174:                     &mt('How should each item be incorporated in the course?').
                   10175:                     '</p>'.
                   10176:                     '<div class="LC_columnSection"><fieldset>'.
                   10177:                     '<legend>'.&mt('Content actions for all').'</legend>'.
1.1059    raeburn  10178:                     '<input type="button" value="'.&mt('Add as folder/file').'" '.
1.1055    raeburn  10179:                     'onclick="javascript:checkAll(document.'.$form.",'display'".')" />'.
1.1059    raeburn  10180:                     '&nbsp;&nbsp;<input type="button" value="'.&mt('Include as dependency for a displayed file').'"'.
1.1055    raeburn  10181:                     ' onclick="javascript:checkAll(document.'.$form.",'dependency'".')" />'.
                   10182:                     '&nbsp;&nbsp;<input type="button" value="'.&mt('Discard').'"'.
                   10183:                     ' onclick="javascript:checkAll(document.'.$form.",'discard'".')" />'.
                   10184:                      '</fieldset></div>'.
                   10185:            &start_data_table()."\n".
                   10186:            $output."\n".
                   10187:            &end_data_table()."\n".
                   10188:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   10189:            $hiddenelem.
                   10190:            '<br /><input type="submit" name="archive_submit" value="'.&mt('Save').'" />'.
                   10191:            '</form>';
                   10192: }
                   10193: 
                   10194: sub archive_javascript {
1.1056    raeburn  10195:     my ($startcount,$numitems,$titles,$children) = @_;
                   10196:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  10197:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  10198:     my $scripttag = <<START;
                   10199: <script type="text/javascript">
                   10200: // <![CDATA[
                   10201: 
                   10202: function checkAll(form,prefix) {
                   10203:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   10204:     for (var i=0; i < form.elements.length; i++) {
                   10205:         var id = form.elements[i].id;
                   10206:         if ((id != '') && (id != undefined)) {
                   10207:             if (idstr.test(id)) {
                   10208:                 if (form.elements[i].type == 'radio') {
                   10209:                     form.elements[i].checked = true;
1.1056    raeburn  10210:                     var nostart = i-$startcount;
1.1059    raeburn  10211:                     var offset = nostart%7;
                   10212:                     var count = (nostart-offset)/7;    
1.1056    raeburn  10213:                     dependencyCheck(form,count,offset);
1.1055    raeburn  10214:                 }
                   10215:             }
                   10216:         }
                   10217:     }
                   10218: }
                   10219: 
                   10220: function propagateCheck(form,count) {
                   10221:     if (count > 0) {
1.1059    raeburn  10222:         var startelement = $startcount + ((count-1) * 7);
                   10223:         for (var j=1; j<6; j++) {
                   10224:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  10225:                 var item = startelement + j; 
                   10226:                 if (form.elements[item].type == 'radio') {
                   10227:                     if (form.elements[item].checked) {
                   10228:                         containerCheck(form,count,j);
                   10229:                         break;
                   10230:                     }
1.1055    raeburn  10231:                 }
                   10232:             }
                   10233:         }
                   10234:     }
                   10235: }
                   10236: 
                   10237: numitems = $numitems
1.1056    raeburn  10238: var titles = new Array(numitems);
                   10239: var parents = new Array(numitems);
1.1055    raeburn  10240: for (var i=0; i<numitems; i++) {
1.1056    raeburn  10241:     parents[i] = new Array;
1.1055    raeburn  10242: }
1.1059    raeburn  10243: var maintitle = '$maintitle';
1.1055    raeburn  10244: 
                   10245: START
                   10246: 
1.1056    raeburn  10247:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   10248:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  10249:         for (my $i=0; $i<@contents; $i ++) {
                   10250:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   10251:         }
                   10252:     }
                   10253: 
1.1056    raeburn  10254:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   10255:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   10256:     }
                   10257: 
1.1055    raeburn  10258:     $scripttag .= <<END;
                   10259: 
                   10260: function containerCheck(form,count,offset) {
                   10261:     if (count > 0) {
1.1056    raeburn  10262:         dependencyCheck(form,count,offset);
1.1059    raeburn  10263:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  10264:         form.elements[item].checked = true;
                   10265:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   10266:             if (parents[count].length > 0) {
                   10267:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  10268:                     containerCheck(form,parents[count][j],offset);
                   10269:                 }
                   10270:             }
                   10271:         }
                   10272:     }
                   10273: }
                   10274: 
                   10275: function dependencyCheck(form,count,offset) {
                   10276:     if (count > 0) {
1.1059    raeburn  10277:         var chosen = (offset+$startcount)+7*(count-1);
                   10278:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  10279:         var currtype = form.elements[depitem].type;
                   10280:         if (form.elements[chosen].value == 'dependency') {
                   10281:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   10282:             form.elements[depitem].options.length = 0;
                   10283:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   10284:             for (var i=1; i<count; i++) {
1.1059    raeburn  10285:                 var startelement = $startcount + (i-1) * 7;
                   10286:                 for (var j=1; j<6; j++) {
                   10287:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  10288:                         var item = startelement + j;
                   10289:                         if (form.elements[item].type == 'radio') {
                   10290:                             if (form.elements[item].checked) {
                   10291:                                 if (form.elements[item].value == 'display') {
                   10292:                                     var n = form.elements[depitem].options.length;
                   10293:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   10294:                                 }
                   10295:                             }
                   10296:                         }
                   10297:                     }
                   10298:                 }
                   10299:             }
                   10300:         } else {
                   10301:             document.getElementById('arc_depon_'+count).style.display='none';
                   10302:             form.elements[depitem].options.length = 0;
                   10303:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   10304:         }
1.1059    raeburn  10305:         titleCheck(form,count,offset);
1.1056    raeburn  10306:     }
                   10307: }
                   10308: 
                   10309: function propagateSelect(form,count,offset) {
                   10310:     if (count > 0) {
1.1059    raeburn  10311:         var item = (2+offset+$startcount)+7*(count-1);
1.1056    raeburn  10312:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   10313:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   10314:             if (parents[count].length > 0) {
                   10315:                 for (var j=0; j<parents[count].length; j++) {
                   10316:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  10317:                 }
                   10318:             }
                   10319:         }
                   10320:     }
                   10321: }
1.1056    raeburn  10322: 
                   10323: function containerSelect(form,count,offset,picked) {
                   10324:     if (count > 0) {
1.1059    raeburn  10325:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  10326:         if (form.elements[item].type == 'radio') {
                   10327:             if (form.elements[item].value == 'dependency') {
                   10328:                 if (form.elements[item+1].type == 'select-one') {
                   10329:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   10330:                         if (form.elements[item+1].options[i].value == picked) {
                   10331:                             form.elements[item+1].selectedIndex = i;
                   10332:                             break;
                   10333:                         }
                   10334:                     }
                   10335:                 }
                   10336:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   10337:                     if (parents[count].length > 0) {
                   10338:                         for (var j=0; j<parents[count].length; j++) {
                   10339:                             containerSelect(form,parents[count][j],offset,picked);
                   10340:                         }
                   10341:                     }
                   10342:                 }
                   10343:             }
                   10344:         }
                   10345:     }
                   10346: }
                   10347: 
1.1059    raeburn  10348: function titleCheck(form,count,offset) {
                   10349:     if (count > 0) {
                   10350:         var chosen = (offset+$startcount)+7*(count-1);
                   10351:         var depitem = $startcount + ((count-1) * 7) + 2;
                   10352:         var currtype = form.elements[depitem].type;
                   10353:         if (form.elements[chosen].value == 'display') {
                   10354:             document.getElementById('arc_title_'+count).style.display='block';
                   10355:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   10356:                 document.getElementById('archive_title_'+count).value=maintitle;
                   10357:             }
                   10358:         } else {
                   10359:             document.getElementById('arc_title_'+count).style.display='none';
                   10360:             if (currtype == 'text') { 
                   10361:                 document.getElementById('archive_title_'+count).value='';
                   10362:             }
                   10363:         }
                   10364:     }
                   10365:     return;
                   10366: }
                   10367: 
1.1055    raeburn  10368: // ]]>
                   10369: </script>
                   10370: END
                   10371:     return $scripttag;
                   10372: }
                   10373: 
                   10374: sub process_extracted_files {
                   10375:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
                   10376:     my $numitems = $env{'form.archive_count'};
                   10377:     return unless ($numitems);
                   10378:     my @ids=&Apache::lonnet::current_machine_ids();
                   10379:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
                   10380:         %folders,%containers,%mapinner);
                   10381:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   10382:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   10383:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   10384:         $pathtocheck = "$dir_root/$destination";
                   10385:         $dir = $dir_root;
                   10386:         $ishome = 1;
                   10387:     } else {
                   10388:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   10389:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
                   10390:         $dir = "$dir_root/$docudom/$docuname";    
                   10391:     }
                   10392:     my $currdir = "$dir_root/$destination";
                   10393:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   10394:     if ($env{'form.folderpath'}) {
                   10395:         my @items = split('&',$env{'form.folderpath'});
                   10396:         $folders{'0'} = $items[-2];
                   10397:         $containers{'0'}='sequence';
                   10398:     } elsif ($env{'form.pagepath'}) {
                   10399:         my @items = split('&',$env{'form.pagepath'});
                   10400:         $folders{'0'} = $items[-2];
                   10401:         $containers{'0'}='page';
                   10402:     }
                   10403:     my @archdirs = &get_env_multiple('form.archive_directory');
                   10404:     if ($numitems) {
                   10405:         for (my $i=1; $i<=$numitems; $i++) {
                   10406:             my $path = $env{'form.archive_content_'.$i};
                   10407:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   10408:                 my $item = $1;
                   10409:                 $toplevelitems{$item} = $i;
                   10410:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   10411:                     $is_dir{$item} = 1;
                   10412:                 }
                   10413:             }
                   10414:         }
                   10415:     }
1.1056    raeburn  10416:     my ($output,%children,%parent,%titles,%dirorder);
1.1055    raeburn  10417:     if (keys(%toplevelitems) > 0) {
                   10418:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  10419:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   10420:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  10421:     }
1.1056    raeburn  10422:     my (%referrer,%orphaned,%todelete,%newdest,%newseqid);
1.1055    raeburn  10423:     if ($numitems) {
                   10424:         for (my $i=1; $i<=$numitems; $i++) {
                   10425:             my $path = $env{'form.archive_content_'.$i};
                   10426:             if ($path =~ /^\Q$pathtocheck\E/) {
                   10427:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   10428:                     if ($prefix ne '' && $path ne '') {
                   10429:                         if (-e $prefix.$path) {
                   10430:                             $todelete{$prefix.$path} = 1;
                   10431:                         }
                   10432:                     }
                   10433:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  10434:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  10435:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  10436:                     $docstitle = $env{'form.archive_title_'.$i};
                   10437:                     if ($docstitle eq '') {
                   10438:                         $docstitle = $title;
                   10439:                     }
1.1055    raeburn  10440:                     $outer = 0;
1.1056    raeburn  10441:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   10442:                         if (@{$dirorder{$i}} > 0) {
                   10443:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  10444:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   10445:                                     $outer = $item;
                   10446:                                     last;
                   10447:                                 }
                   10448:                             }
                   10449:                         }
                   10450:                     }
                   10451:                     my ($errtext,$fatal) = 
                   10452:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   10453:                                                '/'.$folders{$outer}.'.'.
                   10454:                                                $containers{$outer});
                   10455:                     next if ($fatal);
                   10456:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   10457:                         if ($context eq 'coursedocs') {
1.1056    raeburn  10458:                             $mapinner{$i} = time;
1.1055    raeburn  10459:                             $folders{$i} = 'default_'.$mapinner{$i};
                   10460:                             $containers{$i} = 'sequence';
                   10461:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   10462:                                       $folders{$i}.'.'.$containers{$i};
                   10463:                             my $newidx = &LONCAPA::map::getresidx();
                   10464:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  10465:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  10466:                             push(@LONCAPA::map::order,$newidx);
                   10467:                             my ($outtext,$errtext) =
                   10468:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   10469:                                                         $docuname.'/'.$folders{$outer}.
                   10470:                                                         '.'.$containers{$outer},1);
1.1056    raeburn  10471:                             $newseqid{$i} = $newidx;
1.1055    raeburn  10472:                         }
                   10473:                     } else {
                   10474:                         if ($context eq 'coursedocs') {
                   10475:                             my $newidx=&LONCAPA::map::getresidx();
                   10476:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   10477:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   10478:                                       $title;
                   10479:                             if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   10480:                                 mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
                   10481:                             }
                   10482:                             if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   10483:                                 mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   10484:                             }
                   10485:                             if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   10486:                                 system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056    raeburn  10487:                                 $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1055    raeburn  10488:                             }
                   10489:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  10490:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  10491:                             push(@LONCAPA::map::order, $newidx);
                   10492:                             my ($outtext,$errtext)=
                   10493:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   10494:                                                         $docuname.'/'.$folders{$outer}.
                   10495:                                                         '.'.$containers{$outer},1);
                   10496:                         }
                   10497:                     }
                   10498:                 } elsif ($env{'form.archive_'.$i} eq 'dependency') {
1.1056    raeburn  10499:                     my ($title) = ($path =~ m{/([^/]+)$});
                   10500:                     $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   10501:                     if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   10502:                         if (ref($dirorder{$i}) eq 'ARRAY') {
                   10503:                             my ($itemidx,$fullpath);
                   10504:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
                   10505:                                 if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   10506:                                     my $container = $dirorder{$referrer{$i}}->[-1];
                   10507:                                     for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
                   10508:                                         if ($dirorder{$i}->[$j] eq $container) {
                   10509:                                             $itemidx = $j;
                   10510:                                         }
                   10511:                                     }
                   10512:                                 }
                   10513:                             }
                   10514:                             if ($itemidx ne '') {
                   10515:                                 if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   10516:                                     if ($mapinner{$referrer{$i}}) {
                   10517:                                         $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   10518:                                         for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   10519:                                             if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   10520:                                                 unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   10521:                                                     $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   10522:                                                     if (!-e $fullpath) {
                   10523:                                                         mkdir($fullpath,0755);
                   10524:                                                     }
                   10525:                                                 }
                   10526:                                             } else {
                   10527:                                                 last;
                   10528:                                             }
                   10529:                                         }
                   10530:                                     }
                   10531:                                 } elsif ($newdest{$referrer{$i}}) {
                   10532:                                     $fullpath = $newdest{$referrer{$i}};
                   10533:                                     for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   10534:                                         if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   10535:                                             $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   10536:                                             last;
                   10537:                                         } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   10538:                                             unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   10539:                                                 $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   10540:                                                 if (!-e $fullpath) {
                   10541:                                                     mkdir($fullpath,0755);
                   10542:                                                 }
                   10543:                                             }
                   10544:                                         } else {
                   10545:                                             last;
                   10546:                                         }
                   10547:                                     }
                   10548:                                 }
                   10549:                                 if ($fullpath ne '') {
                   10550:                                     system("mv $prefix$path $fullpath/$title");
                   10551:                                 }
1.1055    raeburn  10552:                             }
                   10553:                         }
1.1056    raeburn  10554:                     } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   10555:                         $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
                   10556:                                         $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055    raeburn  10557:                     }
                   10558:                 }
                   10559:             } else {
                   10560:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />'; 
                   10561:             }
                   10562:         }
                   10563:         if (keys(%todelete)) {
                   10564:             foreach my $key (keys(%todelete)) {
                   10565:                 unlink($key);
                   10566:                 unless ($ishome) {
                   10567:                     #FIXME Need to notify homeserver to delete files.
                   10568:                 }
                   10569:             }
                   10570:         }
                   10571:     } else {
                   10572:         $warning = &mt('No items found in archive.');
                   10573:     }
                   10574:     if ($error) {
                   10575:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   10576:                    $error.'</p>'."\n";
                   10577:     }
                   10578:     if ($warning) {
                   10579:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   10580:     }
                   10581:     return $output;
                   10582: }
                   10583: 
1.41      ng       10584: =pod
1.45      matthew  10585: 
1.1015    raeburn  10586: =item * &get_turnedin_filepath()
                   10587: 
                   10588: Determines path in a user's portfolio file for storage of files uploaded
                   10589: to a specific essayresponse or dropbox item.
                   10590: 
                   10591: Inputs: 3 required + 1 optional.
                   10592: $symb is symb for resource, $uname and $udom are for current user (required).
                   10593: $caller is optional (can be "submission", if routine is called when storing
                   10594: an upoaded file when "Submit Answer" button was pressed).
                   10595: 
                   10596: Returns array containing $path and $multiresp. 
                   10597: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   10598: than one file upload item.  Callers of routine should append partid as a 
                   10599: subdirectory to $path in cases where $multiresp is 1.
                   10600: 
                   10601: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   10602: 
                   10603: =cut
                   10604: 
                   10605: sub get_turnedin_filepath {
                   10606:     my ($symb,$uname,$udom,$caller) = @_;
                   10607:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   10608:     my $turnindir;
                   10609:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   10610:     $turnindir = $userhash{'turnindir'};
                   10611:     my ($path,$multiresp);
                   10612:     if ($turnindir eq '') {
                   10613:         if ($caller eq 'submission') {
                   10614:             $turnindir = &mt('turned in');
                   10615:             $turnindir =~ s/\W+/_/g;
                   10616:             my %newhash = (
                   10617:                             'turnindir' => $turnindir,
                   10618:                           );
                   10619:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   10620:         }
                   10621:     }
                   10622:     if ($turnindir ne '') {
                   10623:         $path = '/'.$turnindir.'/';
                   10624:         my ($multipart,$turnin,@pathitems);
                   10625:         my $navmap = Apache::lonnavmaps::navmap->new();
                   10626:         if (defined($navmap)) {
                   10627:             my $mapres = $navmap->getResourceByUrl($map);
                   10628:             if (ref($mapres)) {
                   10629:                 my $pcslist = $mapres->map_hierarchy();
                   10630:                 if ($pcslist ne '') {
                   10631:                     foreach my $pc (split(/,/,$pcslist)) {
                   10632:                         my $res = $navmap->getByMapPc($pc);
                   10633:                         if (ref($res)) {
                   10634:                             my $title = $res->compTitle();
                   10635:                             $title =~ s/\W+/_/g;
                   10636:                             if ($title ne '') {
                   10637:                                 push(@pathitems,$title);
                   10638:                             }
                   10639:                         }
                   10640:                     }
                   10641:                 }
                   10642:                 my $maptitle = $mapres->compTitle();
                   10643:                 $maptitle =~ s/\W+/_/g;
                   10644:                 if ($maptitle ne '') {
                   10645:                     push(@pathitems,$maptitle);
                   10646:                 }
                   10647:                 unless ($env{'request.state'} eq 'construct') {
                   10648:                     my $res = $navmap->getBySymb($symb);
                   10649:                     if (ref($res)) {
                   10650:                         my $partlist = $res->parts();
                   10651:                         my $totaluploads = 0;
                   10652:                         if (ref($partlist) eq 'ARRAY') {
                   10653:                             foreach my $part (@{$partlist}) {
                   10654:                                 my @types = $res->responseType($part);
                   10655:                                 my @ids = $res->responseIds($part);
                   10656:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   10657:                                     if ($types[$i] eq 'essay') {
                   10658:                                         my $partid = $part.'_'.$ids[$i];
                   10659:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   10660:                                             $totaluploads ++;
                   10661:                                         }
                   10662:                                     }
                   10663:                                 }
                   10664:                             }
                   10665:                             if ($totaluploads > 1) {
                   10666:                                 $multiresp = 1;
                   10667:                             }
                   10668:                         }
                   10669:                     }
                   10670:                 }
                   10671:             } else {
                   10672:                 return;
                   10673:             }
                   10674:         } else {
                   10675:             return;
                   10676:         }
                   10677:         my $restitle=&Apache::lonnet::gettitle($symb);
                   10678:         $restitle =~ s/\W+/_/g;
                   10679:         if ($restitle eq '') {
                   10680:             $restitle = ($resurl =~ m{/[^/]+$});
                   10681:             if ($restitle eq '') {
                   10682:                 $restitle = time;
                   10683:             }
                   10684:         }
                   10685:         push(@pathitems,$restitle);
                   10686:         $path .= join('/',@pathitems);
                   10687:     }
                   10688:     return ($path,$multiresp);
                   10689: }
                   10690: 
                   10691: =pod
                   10692: 
1.464     albertel 10693: =back
1.41      ng       10694: 
1.112     bowersj2 10695: =head1 CSV Upload/Handling functions
1.38      albertel 10696: 
1.41      ng       10697: =over 4
                   10698: 
1.648     raeburn  10699: =item * &upfile_store($r)
1.41      ng       10700: 
                   10701: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 10702: needs $env{'form.upfile'}
1.41      ng       10703: returns $datatoken to be put into hidden field
                   10704: 
                   10705: =cut
1.31      albertel 10706: 
                   10707: sub upfile_store {
                   10708:     my $r=shift;
1.258     albertel 10709:     $env{'form.upfile'}=~s/\r/\n/gs;
                   10710:     $env{'form.upfile'}=~s/\f/\n/gs;
                   10711:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   10712:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 10713: 
1.258     albertel 10714:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   10715: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 10716:     {
1.158     raeburn  10717:         my $datafile = $r->dir_config('lonDaemons').
                   10718:                            '/tmp/'.$datatoken.'.tmp';
                   10719:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 10720:             print $fh $env{'form.upfile'};
1.158     raeburn  10721:             close($fh);
                   10722:         }
1.31      albertel 10723:     }
                   10724:     return $datatoken;
                   10725: }
                   10726: 
1.56      matthew  10727: =pod
                   10728: 
1.648     raeburn  10729: =item * &load_tmp_file($r)
1.41      ng       10730: 
                   10731: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 10732: needs $env{'form.datatoken'},
                   10733: sets $env{'form.upfile'} to the contents of the file
1.41      ng       10734: 
                   10735: =cut
1.31      albertel 10736: 
                   10737: sub load_tmp_file {
                   10738:     my $r=shift;
                   10739:     my @studentdata=();
                   10740:     {
1.158     raeburn  10741:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 10742:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  10743:         if ( open(my $fh,"<$studentfile") ) {
                   10744:             @studentdata=<$fh>;
                   10745:             close($fh);
                   10746:         }
1.31      albertel 10747:     }
1.258     albertel 10748:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 10749: }
                   10750: 
1.56      matthew  10751: =pod
                   10752: 
1.648     raeburn  10753: =item * &upfile_record_sep()
1.41      ng       10754: 
                   10755: Separate uploaded file into records
                   10756: returns array of records,
1.258     albertel 10757: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       10758: 
                   10759: =cut
1.31      albertel 10760: 
                   10761: sub upfile_record_sep {
1.258     albertel 10762:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 10763:     } else {
1.248     albertel 10764: 	my @records;
1.258     albertel 10765: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 10766: 	    if ($line=~/^\s*$/) { next; }
                   10767: 	    push(@records,$line);
                   10768: 	}
                   10769: 	return @records;
1.31      albertel 10770:     }
                   10771: }
                   10772: 
1.56      matthew  10773: =pod
                   10774: 
1.648     raeburn  10775: =item * &record_sep($record)
1.41      ng       10776: 
1.258     albertel 10777: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       10778: 
                   10779: =cut
                   10780: 
1.263     www      10781: sub takeleft {
                   10782:     my $index=shift;
                   10783:     return substr('0000'.$index,-4,4);
                   10784: }
                   10785: 
1.31      albertel 10786: sub record_sep {
                   10787:     my $record=shift;
                   10788:     my %components=();
1.258     albertel 10789:     if ($env{'form.upfiletype'} eq 'xml') {
                   10790:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 10791:         my $i=0;
1.356     albertel 10792:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 10793:             $field=~s/^(\"|\')//;
                   10794:             $field=~s/(\"|\')$//;
1.263     www      10795:             $components{&takeleft($i)}=$field;
1.31      albertel 10796:             $i++;
                   10797:         }
1.258     albertel 10798:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 10799:         my $i=0;
1.356     albertel 10800:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 10801:             $field=~s/^(\"|\')//;
                   10802:             $field=~s/(\"|\')$//;
1.263     www      10803:             $components{&takeleft($i)}=$field;
1.31      albertel 10804:             $i++;
                   10805:         }
                   10806:     } else {
1.561     www      10807:         my $separator=',';
1.480     banghart 10808:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      10809:             $separator=';';
1.480     banghart 10810:         }
1.31      albertel 10811:         my $i=0;
1.561     www      10812: # the character we are looking for to indicate the end of a quote or a record 
                   10813:         my $looking_for=$separator;
                   10814: # do not add the characters to the fields
                   10815:         my $ignore=0;
                   10816: # we just encountered a separator (or the beginning of the record)
                   10817:         my $just_found_separator=1;
                   10818: # store the field we are working on here
                   10819:         my $field='';
                   10820: # work our way through all characters in record
                   10821:         foreach my $character ($record=~/(.)/g) {
                   10822:             if ($character eq $looking_for) {
                   10823:                if ($character ne $separator) {
                   10824: # Found the end of a quote, again looking for separator
                   10825:                   $looking_for=$separator;
                   10826:                   $ignore=1;
                   10827:                } else {
                   10828: # Found a separator, store away what we got
                   10829:                   $components{&takeleft($i)}=$field;
                   10830: 	          $i++;
                   10831:                   $just_found_separator=1;
                   10832:                   $ignore=0;
                   10833:                   $field='';
                   10834:                }
                   10835:                next;
                   10836:             }
                   10837: # single or double quotation marks after a separator indicate beginning of a quote
                   10838: # we are now looking for the end of the quote and need to ignore separators
                   10839:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   10840:                $looking_for=$character;
                   10841:                next;
                   10842:             }
                   10843: # ignore would be true after we reached the end of a quote
                   10844:             if ($ignore) { next; }
                   10845:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   10846:             $field.=$character;
                   10847:             $just_found_separator=0; 
1.31      albertel 10848:         }
1.561     www      10849: # catch the very last entry, since we never encountered the separator
                   10850:         $components{&takeleft($i)}=$field;
1.31      albertel 10851:     }
                   10852:     return %components;
                   10853: }
                   10854: 
1.144     matthew  10855: ######################################################
                   10856: ######################################################
                   10857: 
1.56      matthew  10858: =pod
                   10859: 
1.648     raeburn  10860: =item * &upfile_select_html()
1.41      ng       10861: 
1.144     matthew  10862: Return HTML code to select a file from the users machine and specify 
                   10863: the file type.
1.41      ng       10864: 
                   10865: =cut
                   10866: 
1.144     matthew  10867: ######################################################
                   10868: ######################################################
1.31      albertel 10869: sub upfile_select_html {
1.144     matthew  10870:     my %Types = (
                   10871:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 10872:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  10873:                  space => &mt('Space separated'),
                   10874:                  tab   => &mt('Tabulator separated'),
                   10875: #                 xml   => &mt('HTML/XML'),
                   10876:                  );
                   10877:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  10878:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  10879:     foreach my $type (sort(keys(%Types))) {
                   10880:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   10881:     }
                   10882:     $Str .= "</select>\n";
                   10883:     return $Str;
1.31      albertel 10884: }
                   10885: 
1.301     albertel 10886: sub get_samples {
                   10887:     my ($records,$toget) = @_;
                   10888:     my @samples=({});
                   10889:     my $got=0;
                   10890:     foreach my $rec (@$records) {
                   10891: 	my %temp = &record_sep($rec);
                   10892: 	if (! grep(/\S/, values(%temp))) { next; }
                   10893: 	if (%temp) {
                   10894: 	    $samples[$got]=\%temp;
                   10895: 	    $got++;
                   10896: 	    if ($got == $toget) { last; }
                   10897: 	}
                   10898:     }
                   10899:     return \@samples;
                   10900: }
                   10901: 
1.144     matthew  10902: ######################################################
                   10903: ######################################################
                   10904: 
1.56      matthew  10905: =pod
                   10906: 
1.648     raeburn  10907: =item * &csv_print_samples($r,$records)
1.41      ng       10908: 
                   10909: Prints a table of sample values from each column uploaded $r is an
                   10910: Apache Request ref, $records is an arrayref from
                   10911: &Apache::loncommon::upfile_record_sep
                   10912: 
                   10913: =cut
                   10914: 
1.144     matthew  10915: ######################################################
                   10916: ######################################################
1.31      albertel 10917: sub csv_print_samples {
                   10918:     my ($r,$records) = @_;
1.662     bisitz   10919:     my $samples = &get_samples($records,5);
1.301     albertel 10920: 
1.594     raeburn  10921:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   10922:               &start_data_table_header_row());
1.356     albertel 10923:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   10924:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  10925:     $r->print(&end_data_table_header_row());
1.301     albertel 10926:     foreach my $hash (@$samples) {
1.594     raeburn  10927: 	$r->print(&start_data_table_row());
1.356     albertel 10928: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 10929: 	    $r->print('<td>');
1.356     albertel 10930: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 10931: 	    $r->print('</td>');
                   10932: 	}
1.594     raeburn  10933: 	$r->print(&end_data_table_row());
1.31      albertel 10934:     }
1.594     raeburn  10935:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 10936: }
                   10937: 
1.144     matthew  10938: ######################################################
                   10939: ######################################################
                   10940: 
1.56      matthew  10941: =pod
                   10942: 
1.648     raeburn  10943: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       10944: 
                   10945: Prints a table to create associations between values and table columns.
1.144     matthew  10946: 
1.41      ng       10947: $r is an Apache Request ref,
                   10948: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  10949: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       10950: 
                   10951: =cut
                   10952: 
1.144     matthew  10953: ######################################################
                   10954: ######################################################
1.31      albertel 10955: sub csv_print_select_table {
                   10956:     my ($r,$records,$d) = @_;
1.301     albertel 10957:     my $i=0;
                   10958:     my $samples = &get_samples($records,1);
1.144     matthew  10959:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  10960: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  10961:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  10962:               '<th>'.&mt('Column').'</th>'.
                   10963:               &end_data_table_header_row()."\n");
1.356     albertel 10964:     foreach my $array_ref (@$d) {
                   10965: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  10966: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 10967: 
1.875     bisitz   10968: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  10969: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 10970: 	$r->print('<option value="none"></option>');
1.356     albertel 10971: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   10972: 	    $r->print('<option value="'.$sample.'"'.
                   10973:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   10974:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 10975: 	}
1.594     raeburn  10976: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 10977: 	$i++;
                   10978:     }
1.594     raeburn  10979:     $r->print(&end_data_table());
1.31      albertel 10980:     $i--;
                   10981:     return $i;
                   10982: }
1.56      matthew  10983: 
1.144     matthew  10984: ######################################################
                   10985: ######################################################
                   10986: 
1.56      matthew  10987: =pod
1.31      albertel 10988: 
1.648     raeburn  10989: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       10990: 
                   10991: Prints a table of sample values from the upload and can make associate samples to internal names.
                   10992: 
                   10993: $r is an Apache Request ref,
                   10994: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   10995: $d is an array of 2 element arrays (internal name, displayed name)
                   10996: 
                   10997: =cut
                   10998: 
1.144     matthew  10999: ######################################################
                   11000: ######################################################
1.31      albertel 11001: sub csv_samples_select_table {
                   11002:     my ($r,$records,$d) = @_;
                   11003:     my $i=0;
1.144     matthew  11004:     #
1.662     bisitz   11005:     my $max_samples = 5;
                   11006:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  11007:     $r->print(&start_data_table().
                   11008:               &start_data_table_header_row().'<th>'.
                   11009:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   11010:               &end_data_table_header_row());
1.301     albertel 11011: 
                   11012:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  11013: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  11014: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 11015: 	foreach my $option (@$d) {
                   11016: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  11017: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 11018:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  11019:                       $display.'</option>');
1.31      albertel 11020: 	}
                   11021: 	$r->print('</select></td><td>');
1.662     bisitz   11022: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 11023: 	    if (defined($samples->[$line]{$key})) { 
                   11024: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   11025: 	    }
                   11026: 	}
1.594     raeburn  11027: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 11028: 	$i++;
                   11029:     }
1.594     raeburn  11030:     $r->print(&end_data_table());
1.31      albertel 11031:     $i--;
                   11032:     return($i);
1.115     matthew  11033: }
                   11034: 
1.144     matthew  11035: ######################################################
                   11036: ######################################################
                   11037: 
1.115     matthew  11038: =pod
                   11039: 
1.648     raeburn  11040: =item * &clean_excel_name($name)
1.115     matthew  11041: 
                   11042: Returns a replacement for $name which does not contain any illegal characters.
                   11043: 
                   11044: =cut
                   11045: 
1.144     matthew  11046: ######################################################
                   11047: ######################################################
1.115     matthew  11048: sub clean_excel_name {
                   11049:     my ($name) = @_;
                   11050:     $name =~ s/[:\*\?\/\\]//g;
                   11051:     if (length($name) > 31) {
                   11052:         $name = substr($name,0,31);
                   11053:     }
                   11054:     return $name;
1.25      albertel 11055: }
1.84      albertel 11056: 
1.85      albertel 11057: =pod
                   11058: 
1.648     raeburn  11059: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 11060: 
                   11061: Returns either 1 or undef
                   11062: 
                   11063: 1 if the part is to be hidden, undef if it is to be shown
                   11064: 
                   11065: Arguments are:
                   11066: 
                   11067: $id the id of the part to be checked
                   11068: $symb, optional the symb of the resource to check
                   11069: $udom, optional the domain of the user to check for
                   11070: $uname, optional the username of the user to check for
                   11071: 
                   11072: =cut
1.84      albertel 11073: 
                   11074: sub check_if_partid_hidden {
                   11075:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 11076:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 11077: 					 $symb,$udom,$uname);
1.141     albertel 11078:     my $truth=1;
                   11079:     #if the string starts with !, then the list is the list to show not hide
                   11080:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 11081:     my @hiddenlist=split(/,/,$hiddenparts);
                   11082:     foreach my $checkid (@hiddenlist) {
1.141     albertel 11083: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 11084:     }
1.141     albertel 11085:     return !$truth;
1.84      albertel 11086: }
1.127     matthew  11087: 
1.138     matthew  11088: 
                   11089: ############################################################
                   11090: ############################################################
                   11091: 
                   11092: =pod
                   11093: 
1.157     matthew  11094: =back 
                   11095: 
1.138     matthew  11096: =head1 cgi-bin script and graphing routines
                   11097: 
1.157     matthew  11098: =over 4
                   11099: 
1.648     raeburn  11100: =item * &get_cgi_id()
1.138     matthew  11101: 
                   11102: Inputs: none
                   11103: 
                   11104: Returns an id which can be used to pass environment variables
                   11105: to various cgi-bin scripts.  These environment variables will
                   11106: be removed from the users environment after a given time by
                   11107: the routine &Apache::lonnet::transfer_profile_to_env.
                   11108: 
                   11109: =cut
                   11110: 
                   11111: ############################################################
                   11112: ############################################################
1.152     albertel 11113: my $uniq=0;
1.136     matthew  11114: sub get_cgi_id {
1.154     albertel 11115:     $uniq=($uniq+1)%100000;
1.280     albertel 11116:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  11117: }
                   11118: 
1.127     matthew  11119: ############################################################
                   11120: ############################################################
                   11121: 
                   11122: =pod
                   11123: 
1.648     raeburn  11124: =item * &DrawBarGraph()
1.127     matthew  11125: 
1.138     matthew  11126: Facilitates the plotting of data in a (stacked) bar graph.
                   11127: Puts plot definition data into the users environment in order for 
                   11128: graph.png to plot it.  Returns an <img> tag for the plot.
                   11129: The bars on the plot are labeled '1','2',...,'n'.
                   11130: 
                   11131: Inputs:
                   11132: 
                   11133: =over 4
                   11134: 
                   11135: =item $Title: string, the title of the plot
                   11136: 
                   11137: =item $xlabel: string, text describing the X-axis of the plot
                   11138: 
                   11139: =item $ylabel: string, text describing the Y-axis of the plot
                   11140: 
                   11141: =item $Max: scalar, the maximum Y value to use in the plot
                   11142: If $Max is < any data point, the graph will not be rendered.
                   11143: 
1.140     matthew  11144: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  11145: they are plotted.  If undefined, default values will be used.
                   11146: 
1.178     matthew  11147: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   11148: 
1.138     matthew  11149: =item @Values: An array of array references.  Each array reference holds data
                   11150: to be plotted in a stacked bar chart.
                   11151: 
1.239     matthew  11152: =item If the final element of @Values is a hash reference the key/value
                   11153: pairs will be added to the graph definition.
                   11154: 
1.138     matthew  11155: =back
                   11156: 
                   11157: Returns:
                   11158: 
                   11159: An <img> tag which references graph.png and the appropriate identifying
                   11160: information for the plot.
                   11161: 
1.127     matthew  11162: =cut
                   11163: 
                   11164: ############################################################
                   11165: ############################################################
1.134     matthew  11166: sub DrawBarGraph {
1.178     matthew  11167:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  11168:     #
                   11169:     if (! defined($colors)) {
                   11170:         $colors = ['#33ff00', 
                   11171:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   11172:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   11173:                   ]; 
                   11174:     }
1.228     matthew  11175:     my $extra_settings = {};
                   11176:     if (ref($Values[-1]) eq 'HASH') {
                   11177:         $extra_settings = pop(@Values);
                   11178:     }
1.127     matthew  11179:     #
1.136     matthew  11180:     my $identifier = &get_cgi_id();
                   11181:     my $id = 'cgi.'.$identifier;        
1.129     matthew  11182:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  11183:         return '';
                   11184:     }
1.225     matthew  11185:     #
                   11186:     my @Labels;
                   11187:     if (defined($labels)) {
                   11188:         @Labels = @$labels;
                   11189:     } else {
                   11190:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   11191:             push (@Labels,$i+1);
                   11192:         }
                   11193:     }
                   11194:     #
1.129     matthew  11195:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  11196:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  11197:     my %ValuesHash;
                   11198:     my $NumSets=1;
                   11199:     foreach my $array (@Values) {
                   11200:         next if (! ref($array));
1.136     matthew  11201:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  11202:             join(',',@$array);
1.129     matthew  11203:     }
1.127     matthew  11204:     #
1.136     matthew  11205:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  11206:     if ($NumBars < 3) {
                   11207:         $width = 120+$NumBars*32;
1.220     matthew  11208:         $xskip = 1;
1.225     matthew  11209:         $bar_width = 30;
                   11210:     } elsif ($NumBars < 5) {
                   11211:         $width = 120+$NumBars*20;
                   11212:         $xskip = 1;
                   11213:         $bar_width = 20;
1.220     matthew  11214:     } elsif ($NumBars < 10) {
1.136     matthew  11215:         $width = 120+$NumBars*15;
                   11216:         $xskip = 1;
                   11217:         $bar_width = 15;
                   11218:     } elsif ($NumBars <= 25) {
                   11219:         $width = 120+$NumBars*11;
                   11220:         $xskip = 5;
                   11221:         $bar_width = 8;
                   11222:     } elsif ($NumBars <= 50) {
                   11223:         $width = 120+$NumBars*8;
                   11224:         $xskip = 5;
                   11225:         $bar_width = 4;
                   11226:     } else {
                   11227:         $width = 120+$NumBars*8;
                   11228:         $xskip = 5;
                   11229:         $bar_width = 4;
                   11230:     }
                   11231:     #
1.137     matthew  11232:     $Max = 1 if ($Max < 1);
                   11233:     if ( int($Max) < $Max ) {
                   11234:         $Max++;
                   11235:         $Max = int($Max);
                   11236:     }
1.127     matthew  11237:     $Title  = '' if (! defined($Title));
                   11238:     $xlabel = '' if (! defined($xlabel));
                   11239:     $ylabel = '' if (! defined($ylabel));
1.369     www      11240:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   11241:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   11242:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  11243:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  11244:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   11245:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   11246:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   11247:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   11248:     $ValuesHash{$id.'.height'}   = $height;
                   11249:     $ValuesHash{$id.'.width'}    = $width;
                   11250:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   11251:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   11252:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  11253:     #
1.228     matthew  11254:     # Deal with other parameters
                   11255:     while (my ($key,$value) = each(%$extra_settings)) {
                   11256:         $ValuesHash{$id.'.'.$key} = $value;
                   11257:     }
                   11258:     #
1.646     raeburn  11259:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  11260:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   11261: }
                   11262: 
                   11263: ############################################################
                   11264: ############################################################
                   11265: 
                   11266: =pod
                   11267: 
1.648     raeburn  11268: =item * &DrawXYGraph()
1.137     matthew  11269: 
1.138     matthew  11270: Facilitates the plotting of data in an XY graph.
                   11271: Puts plot definition data into the users environment in order for 
                   11272: graph.png to plot it.  Returns an <img> tag for the plot.
                   11273: 
                   11274: Inputs:
                   11275: 
                   11276: =over 4
                   11277: 
                   11278: =item $Title: string, the title of the plot
                   11279: 
                   11280: =item $xlabel: string, text describing the X-axis of the plot
                   11281: 
                   11282: =item $ylabel: string, text describing the Y-axis of the plot
                   11283: 
                   11284: =item $Max: scalar, the maximum Y value to use in the plot
                   11285: If $Max is < any data point, the graph will not be rendered.
                   11286: 
                   11287: =item $colors: Array ref containing the hex color codes for the data to be 
                   11288: plotted in.  If undefined, default values will be used.
                   11289: 
                   11290: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   11291: 
                   11292: =item $Ydata: Array ref containing Array refs.  
1.185     www      11293: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  11294: 
                   11295: =item %Values: hash indicating or overriding any default values which are 
                   11296: passed to graph.png.  
                   11297: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   11298: 
                   11299: =back
                   11300: 
                   11301: Returns:
                   11302: 
                   11303: An <img> tag which references graph.png and the appropriate identifying
                   11304: information for the plot.
                   11305: 
1.137     matthew  11306: =cut
                   11307: 
                   11308: ############################################################
                   11309: ############################################################
                   11310: sub DrawXYGraph {
                   11311:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   11312:     #
                   11313:     # Create the identifier for the graph
                   11314:     my $identifier = &get_cgi_id();
                   11315:     my $id = 'cgi.'.$identifier;
                   11316:     #
                   11317:     $Title  = '' if (! defined($Title));
                   11318:     $xlabel = '' if (! defined($xlabel));
                   11319:     $ylabel = '' if (! defined($ylabel));
                   11320:     my %ValuesHash = 
                   11321:         (
1.369     www      11322:          $id.'.title'  => &escape($Title),
                   11323:          $id.'.xlabel' => &escape($xlabel),
                   11324:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  11325:          $id.'.y_max_value'=> $Max,
                   11326:          $id.'.labels'     => join(',',@$Xlabels),
                   11327:          $id.'.PlotType'   => 'XY',
                   11328:          );
                   11329:     #
                   11330:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   11331:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   11332:     }
                   11333:     #
                   11334:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   11335:         return '';
                   11336:     }
                   11337:     my $NumSets=1;
1.138     matthew  11338:     foreach my $array (@{$Ydata}){
1.137     matthew  11339:         next if (! ref($array));
                   11340:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   11341:     }
1.138     matthew  11342:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  11343:     #
                   11344:     # Deal with other parameters
                   11345:     while (my ($key,$value) = each(%Values)) {
                   11346:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  11347:     }
                   11348:     #
1.646     raeburn  11349:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  11350:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   11351: }
                   11352: 
                   11353: ############################################################
                   11354: ############################################################
                   11355: 
                   11356: =pod
                   11357: 
1.648     raeburn  11358: =item * &DrawXYYGraph()
1.138     matthew  11359: 
                   11360: Facilitates the plotting of data in an XY graph with two Y axes.
                   11361: Puts plot definition data into the users environment in order for 
                   11362: graph.png to plot it.  Returns an <img> tag for the plot.
                   11363: 
                   11364: Inputs:
                   11365: 
                   11366: =over 4
                   11367: 
                   11368: =item $Title: string, the title of the plot
                   11369: 
                   11370: =item $xlabel: string, text describing the X-axis of the plot
                   11371: 
                   11372: =item $ylabel: string, text describing the Y-axis of the plot
                   11373: 
                   11374: =item $colors: Array ref containing the hex color codes for the data to be 
                   11375: plotted in.  If undefined, default values will be used.
                   11376: 
                   11377: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   11378: 
                   11379: =item $Ydata1: The first data set
                   11380: 
                   11381: =item $Min1: The minimum value of the left Y-axis
                   11382: 
                   11383: =item $Max1: The maximum value of the left Y-axis
                   11384: 
                   11385: =item $Ydata2: The second data set
                   11386: 
                   11387: =item $Min2: The minimum value of the right Y-axis
                   11388: 
                   11389: =item $Max2: The maximum value of the left Y-axis
                   11390: 
                   11391: =item %Values: hash indicating or overriding any default values which are 
                   11392: passed to graph.png.  
                   11393: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   11394: 
                   11395: =back
                   11396: 
                   11397: Returns:
                   11398: 
                   11399: An <img> tag which references graph.png and the appropriate identifying
                   11400: information for the plot.
1.136     matthew  11401: 
                   11402: =cut
                   11403: 
                   11404: ############################################################
                   11405: ############################################################
1.137     matthew  11406: sub DrawXYYGraph {
                   11407:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   11408:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  11409:     #
                   11410:     # Create the identifier for the graph
                   11411:     my $identifier = &get_cgi_id();
                   11412:     my $id = 'cgi.'.$identifier;
                   11413:     #
                   11414:     $Title  = '' if (! defined($Title));
                   11415:     $xlabel = '' if (! defined($xlabel));
                   11416:     $ylabel = '' if (! defined($ylabel));
                   11417:     my %ValuesHash = 
                   11418:         (
1.369     www      11419:          $id.'.title'  => &escape($Title),
                   11420:          $id.'.xlabel' => &escape($xlabel),
                   11421:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  11422:          $id.'.labels' => join(',',@$Xlabels),
                   11423:          $id.'.PlotType' => 'XY',
                   11424:          $id.'.NumSets' => 2,
1.137     matthew  11425:          $id.'.two_axes' => 1,
                   11426:          $id.'.y1_max_value' => $Max1,
                   11427:          $id.'.y1_min_value' => $Min1,
                   11428:          $id.'.y2_max_value' => $Max2,
                   11429:          $id.'.y2_min_value' => $Min2,
1.136     matthew  11430:          );
                   11431:     #
1.137     matthew  11432:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   11433:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   11434:     }
                   11435:     #
                   11436:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   11437:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  11438:         return '';
                   11439:     }
                   11440:     my $NumSets=1;
1.137     matthew  11441:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  11442:         next if (! ref($array));
                   11443:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  11444:     }
                   11445:     #
                   11446:     # Deal with other parameters
                   11447:     while (my ($key,$value) = each(%Values)) {
                   11448:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  11449:     }
                   11450:     #
1.646     raeburn  11451:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 11452:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  11453: }
                   11454: 
                   11455: ############################################################
                   11456: ############################################################
                   11457: 
                   11458: =pod
                   11459: 
1.157     matthew  11460: =back 
                   11461: 
1.139     matthew  11462: =head1 Statistics helper routines?  
                   11463: 
                   11464: Bad place for them but what the hell.
                   11465: 
1.157     matthew  11466: =over 4
                   11467: 
1.648     raeburn  11468: =item * &chartlink()
1.139     matthew  11469: 
                   11470: Returns a link to the chart for a specific student.  
                   11471: 
                   11472: Inputs:
                   11473: 
                   11474: =over 4
                   11475: 
                   11476: =item $linktext: The text of the link
                   11477: 
                   11478: =item $sname: The students username
                   11479: 
                   11480: =item $sdomain: The students domain
                   11481: 
                   11482: =back
                   11483: 
1.157     matthew  11484: =back
                   11485: 
1.139     matthew  11486: =cut
                   11487: 
                   11488: ############################################################
                   11489: ############################################################
                   11490: sub chartlink {
                   11491:     my ($linktext, $sname, $sdomain) = @_;
                   11492:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      11493:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 11494:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  11495:        '">'.$linktext.'</a>';
1.153     matthew  11496: }
                   11497: 
                   11498: #######################################################
                   11499: #######################################################
                   11500: 
                   11501: =pod
                   11502: 
                   11503: =head1 Course Environment Routines
1.157     matthew  11504: 
                   11505: =over 4
1.153     matthew  11506: 
1.648     raeburn  11507: =item * &restore_course_settings()
1.153     matthew  11508: 
1.648     raeburn  11509: =item * &store_course_settings()
1.153     matthew  11510: 
                   11511: Restores/Store indicated form parameters from the course environment.
                   11512: Will not overwrite existing values of the form parameters.
                   11513: 
                   11514: Inputs: 
                   11515: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   11516: 
                   11517: a hash ref describing the data to be stored.  For example:
                   11518:    
                   11519: %Save_Parameters = ('Status' => 'scalar',
                   11520:     'chartoutputmode' => 'scalar',
                   11521:     'chartoutputdata' => 'scalar',
                   11522:     'Section' => 'array',
1.373     raeburn  11523:     'Group' => 'array',
1.153     matthew  11524:     'StudentData' => 'array',
                   11525:     'Maps' => 'array');
                   11526: 
                   11527: Returns: both routines return nothing
                   11528: 
1.631     raeburn  11529: =back
                   11530: 
1.153     matthew  11531: =cut
                   11532: 
                   11533: #######################################################
                   11534: #######################################################
                   11535: sub store_course_settings {
1.496     albertel 11536:     return &store_settings($env{'request.course.id'},@_);
                   11537: }
                   11538: 
                   11539: sub store_settings {
1.153     matthew  11540:     # save to the environment
                   11541:     # appenv the same items, just to be safe
1.300     albertel 11542:     my $udom  = $env{'user.domain'};
                   11543:     my $uname = $env{'user.name'};
1.496     albertel 11544:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  11545:     my %SaveHash;
                   11546:     my %AppHash;
                   11547:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 11548:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 11549:         my $envname = 'environment.'.$basename;
1.258     albertel 11550:         if (exists($env{'form.'.$setting})) {
1.153     matthew  11551:             # Save this value away
                   11552:             if ($type eq 'scalar' &&
1.258     albertel 11553:                 (! exists($env{$envname}) || 
                   11554:                  $env{$envname} ne $env{'form.'.$setting})) {
                   11555:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   11556:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  11557:             } elsif ($type eq 'array') {
                   11558:                 my $stored_form;
1.258     albertel 11559:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  11560:                     $stored_form = join(',',
                   11561:                                         map {
1.369     www      11562:                                             &escape($_);
1.258     albertel 11563:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  11564:                 } else {
                   11565:                     $stored_form = 
1.369     www      11566:                         &escape($env{'form.'.$setting});
1.153     matthew  11567:                 }
                   11568:                 # Determine if the array contents are the same.
1.258     albertel 11569:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  11570:                     $SaveHash{$basename} = $stored_form;
                   11571:                     $AppHash{$envname}   = $stored_form;
                   11572:                 }
                   11573:             }
                   11574:         }
                   11575:     }
                   11576:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 11577:                                           $udom,$uname);
1.153     matthew  11578:     if ($put_result !~ /^(ok|delayed)/) {
                   11579:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   11580:                                  'got error:'.$put_result);
                   11581:     }
                   11582:     # Make sure these settings stick around in this session, too
1.646     raeburn  11583:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  11584:     return;
                   11585: }
                   11586: 
                   11587: sub restore_course_settings {
1.499     albertel 11588:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 11589: }
                   11590: 
                   11591: sub restore_settings {
                   11592:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  11593:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 11594:         next if (exists($env{'form.'.$setting}));
1.496     albertel 11595:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  11596:             '.'.$setting;
1.258     albertel 11597:         if (exists($env{$envname})) {
1.153     matthew  11598:             if ($type eq 'scalar') {
1.258     albertel 11599:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  11600:             } elsif ($type eq 'array') {
1.258     albertel 11601:                 $env{'form.'.$setting} = [ 
1.153     matthew  11602:                                            map { 
1.369     www      11603:                                                &unescape($_); 
1.258     albertel 11604:                                            } split(',',$env{$envname})
1.153     matthew  11605:                                            ];
                   11606:             }
                   11607:         }
                   11608:     }
1.127     matthew  11609: }
                   11610: 
1.618     raeburn  11611: #######################################################
                   11612: #######################################################
                   11613: 
                   11614: =pod
                   11615: 
                   11616: =head1 Domain E-mail Routines  
                   11617: 
                   11618: =over 4
                   11619: 
1.648     raeburn  11620: =item * &build_recipient_list()
1.618     raeburn  11621: 
1.884     raeburn  11622: Build recipient lists for five types of e-mail:
1.766     raeburn  11623: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  11624: (d) Help requests, (e) Course requests needing approval,  generated by
                   11625: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   11626: loncoursequeueadmin.pm respectively.
1.618     raeburn  11627: 
                   11628: Inputs:
1.619     raeburn  11629: defmail (scalar - email address of default recipient), 
1.618     raeburn  11630: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  11631: defdom (domain for which to retrieve configuration settings),
                   11632: origmail (scalar - email address of recipient from loncapa.conf, 
                   11633: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  11634: 
1.655     raeburn  11635: Returns: comma separated list of addresses to which to send e-mail.
                   11636: 
                   11637: =back
1.618     raeburn  11638: 
                   11639: =cut
                   11640: 
                   11641: ############################################################
                   11642: ############################################################
                   11643: sub build_recipient_list {
1.619     raeburn  11644:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  11645:     my @recipients;
                   11646:     my $otheremails;
                   11647:     my %domconfig =
                   11648:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   11649:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  11650:         if (exists($domconfig{'contacts'}{$mailing})) {
                   11651:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   11652:                 my @contacts = ('adminemail','supportemail');
                   11653:                 foreach my $item (@contacts) {
                   11654:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   11655:                         my $addr = $domconfig{'contacts'}{$item}; 
                   11656:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   11657:                             push(@recipients,$addr);
                   11658:                         }
1.619     raeburn  11659:                     }
1.766     raeburn  11660:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  11661:                 }
                   11662:             }
1.766     raeburn  11663:         } elsif ($origmail ne '') {
                   11664:             push(@recipients,$origmail);
1.618     raeburn  11665:         }
1.619     raeburn  11666:     } elsif ($origmail ne '') {
                   11667:         push(@recipients,$origmail);
1.618     raeburn  11668:     }
1.688     raeburn  11669:     if (defined($defmail)) {
                   11670:         if ($defmail ne '') {
                   11671:             push(@recipients,$defmail);
                   11672:         }
1.618     raeburn  11673:     }
                   11674:     if ($otheremails) {
1.619     raeburn  11675:         my @others;
                   11676:         if ($otheremails =~ /,/) {
                   11677:             @others = split(/,/,$otheremails);
1.618     raeburn  11678:         } else {
1.619     raeburn  11679:             push(@others,$otheremails);
                   11680:         }
                   11681:         foreach my $addr (@others) {
                   11682:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   11683:                 push(@recipients,$addr);
                   11684:             }
1.618     raeburn  11685:         }
                   11686:     }
1.619     raeburn  11687:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  11688:     return $recipientlist;
                   11689: }
                   11690: 
1.127     matthew  11691: ############################################################
                   11692: ############################################################
1.154     albertel 11693: 
1.655     raeburn  11694: =pod
                   11695: 
                   11696: =head1 Course Catalog Routines
                   11697: 
                   11698: =over 4
                   11699: 
                   11700: =item * &gather_categories()
                   11701: 
                   11702: Converts category definitions - keys of categories hash stored in  
                   11703: coursecategories in configuration.db on the primary library server in a 
                   11704: domain - to an array.  Also generates javascript and idx hash used to 
                   11705: generate Domain Coordinator interface for editing Course Categories.
                   11706: 
                   11707: Inputs:
1.663     raeburn  11708: 
1.655     raeburn  11709: categories (reference to hash of category definitions).
1.663     raeburn  11710: 
1.655     raeburn  11711: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   11712:       categories and subcategories).
1.663     raeburn  11713: 
1.655     raeburn  11714: idx (reference to hash of counters used in Domain Coordinator interface for 
                   11715:       editing Course Categories).
1.663     raeburn  11716: 
1.655     raeburn  11717: jsarray (reference to array of categories used to create Javascript arrays for
                   11718:          Domain Coordinator interface for editing Course Categories).
                   11719: 
                   11720: Returns: nothing
                   11721: 
                   11722: Side effects: populates cats, idx and jsarray. 
                   11723: 
                   11724: =cut
                   11725: 
                   11726: sub gather_categories {
                   11727:     my ($categories,$cats,$idx,$jsarray) = @_;
                   11728:     my %counters;
                   11729:     my $num = 0;
                   11730:     foreach my $item (keys(%{$categories})) {
                   11731:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   11732:         if ($container eq '' && $depth == 0) {
                   11733:             $cats->[$depth][$categories->{$item}] = $cat;
                   11734:         } else {
                   11735:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   11736:         }
                   11737:         my ($escitem,$tail) = split(/:/,$item,2);
                   11738:         if ($counters{$tail} eq '') {
                   11739:             $counters{$tail} = $num;
                   11740:             $num ++;
                   11741:         }
                   11742:         if (ref($idx) eq 'HASH') {
                   11743:             $idx->{$item} = $counters{$tail};
                   11744:         }
                   11745:         if (ref($jsarray) eq 'ARRAY') {
                   11746:             push(@{$jsarray->[$counters{$tail}]},$item);
                   11747:         }
                   11748:     }
                   11749:     return;
                   11750: }
                   11751: 
                   11752: =pod
                   11753: 
                   11754: =item * &extract_categories()
                   11755: 
                   11756: Used to generate breadcrumb trails for course categories.
                   11757: 
                   11758: Inputs:
1.663     raeburn  11759: 
1.655     raeburn  11760: categories (reference to hash of category definitions).
1.663     raeburn  11761: 
1.655     raeburn  11762: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   11763:       categories and subcategories).
1.663     raeburn  11764: 
1.655     raeburn  11765: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  11766: 
1.655     raeburn  11767: allitems (reference to hash - key is category key 
                   11768:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  11769: 
1.655     raeburn  11770: idx (reference to hash of counters used in Domain Coordinator interface for
                   11771:       editing Course Categories).
1.663     raeburn  11772: 
1.655     raeburn  11773: jsarray (reference to array of categories used to create Javascript arrays for
                   11774:          Domain Coordinator interface for editing Course Categories).
                   11775: 
1.665     raeburn  11776: subcats (reference to hash of arrays containing all subcategories within each 
                   11777:          category, -recursive)
                   11778: 
1.655     raeburn  11779: Returns: nothing
                   11780: 
                   11781: Side effects: populates trails and allitems hash references.
                   11782: 
                   11783: =cut
                   11784: 
                   11785: sub extract_categories {
1.665     raeburn  11786:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  11787:     if (ref($categories) eq 'HASH') {
                   11788:         &gather_categories($categories,$cats,$idx,$jsarray);
                   11789:         if (ref($cats->[0]) eq 'ARRAY') {
                   11790:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   11791:                 my $name = $cats->[0][$i];
                   11792:                 my $item = &escape($name).'::0';
                   11793:                 my $trailstr;
                   11794:                 if ($name eq 'instcode') {
                   11795:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  11796:                 } elsif ($name eq 'communities') {
                   11797:                     $trailstr = &mt('Communities');
1.655     raeburn  11798:                 } else {
                   11799:                     $trailstr = $name;
                   11800:                 }
                   11801:                 if ($allitems->{$item} eq '') {
                   11802:                     push(@{$trails},$trailstr);
                   11803:                     $allitems->{$item} = scalar(@{$trails})-1;
                   11804:                 }
                   11805:                 my @parents = ($name);
                   11806:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   11807:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   11808:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  11809:                         if (ref($subcats) eq 'HASH') {
                   11810:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   11811:                         }
                   11812:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   11813:                     }
                   11814:                 } else {
                   11815:                     if (ref($subcats) eq 'HASH') {
                   11816:                         $subcats->{$item} = [];
1.655     raeburn  11817:                     }
                   11818:                 }
                   11819:             }
                   11820:         }
                   11821:     }
                   11822:     return;
                   11823: }
                   11824: 
                   11825: =pod
                   11826: 
                   11827: =item *&recurse_categories()
                   11828: 
                   11829: Recursively used to generate breadcrumb trails for course categories.
                   11830: 
                   11831: Inputs:
1.663     raeburn  11832: 
1.655     raeburn  11833: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   11834:       categories and subcategories).
1.663     raeburn  11835: 
1.655     raeburn  11836: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  11837: 
                   11838: category (current course category, for which breadcrumb trail is being generated).
                   11839: 
                   11840: trails (reference to array of breadcrumb trails for each category).
                   11841: 
1.655     raeburn  11842: allitems (reference to hash - key is category key
                   11843:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  11844: 
1.655     raeburn  11845: parents (array containing containers directories for current category, 
                   11846:          back to top level). 
                   11847: 
                   11848: Returns: nothing
                   11849: 
                   11850: Side effects: populates trails and allitems hash references
                   11851: 
                   11852: =cut
                   11853: 
                   11854: sub recurse_categories {
1.665     raeburn  11855:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  11856:     my $shallower = $depth - 1;
                   11857:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   11858:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   11859:             my $name = $cats->[$depth]{$category}[$k];
                   11860:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   11861:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   11862:             if ($allitems->{$item} eq '') {
                   11863:                 push(@{$trails},$trailstr);
                   11864:                 $allitems->{$item} = scalar(@{$trails})-1;
                   11865:             }
                   11866:             my $deeper = $depth+1;
                   11867:             push(@{$parents},$category);
1.665     raeburn  11868:             if (ref($subcats) eq 'HASH') {
                   11869:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   11870:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   11871:                     my $higher;
                   11872:                     if ($j > 0) {
                   11873:                         $higher = &escape($parents->[$j]).':'.
                   11874:                                   &escape($parents->[$j-1]).':'.$j;
                   11875:                     } else {
                   11876:                         $higher = &escape($parents->[$j]).'::'.$j;
                   11877:                     }
                   11878:                     push(@{$subcats->{$higher}},$subcat);
                   11879:                 }
                   11880:             }
                   11881:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   11882:                                 $subcats);
1.655     raeburn  11883:             pop(@{$parents});
                   11884:         }
                   11885:     } else {
                   11886:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   11887:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   11888:         if ($allitems->{$item} eq '') {
                   11889:             push(@{$trails},$trailstr);
                   11890:             $allitems->{$item} = scalar(@{$trails})-1;
                   11891:         }
                   11892:     }
                   11893:     return;
                   11894: }
                   11895: 
1.663     raeburn  11896: =pod
                   11897: 
                   11898: =item *&assign_categories_table()
                   11899: 
                   11900: Create a datatable for display of hierarchical categories in a domain,
                   11901: with checkboxes to allow a course to be categorized. 
                   11902: 
                   11903: Inputs:
                   11904: 
                   11905: cathash - reference to hash of categories defined for the domain (from
                   11906:           configuration.db)
                   11907: 
                   11908: currcat - scalar with an & separated list of categories assigned to a course. 
                   11909: 
1.919     raeburn  11910: type    - scalar contains course type (Course or Community).
                   11911: 
1.663     raeburn  11912: Returns: $output (markup to be displayed) 
                   11913: 
                   11914: =cut
                   11915: 
                   11916: sub assign_categories_table {
1.919     raeburn  11917:     my ($cathash,$currcat,$type) = @_;
1.663     raeburn  11918:     my $output;
                   11919:     if (ref($cathash) eq 'HASH') {
                   11920:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   11921:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   11922:         $maxdepth = scalar(@cats);
                   11923:         if (@cats > 0) {
                   11924:             my $itemcount = 0;
                   11925:             if (ref($cats[0]) eq 'ARRAY') {
                   11926:                 my @currcategories;
                   11927:                 if ($currcat ne '') {
                   11928:                     @currcategories = split('&',$currcat);
                   11929:                 }
1.919     raeburn  11930:                 my $table;
1.663     raeburn  11931:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   11932:                     my $parent = $cats[0][$i];
1.919     raeburn  11933:                     next if ($parent eq 'instcode');
                   11934:                     if ($type eq 'Community') {
                   11935:                         next unless ($parent eq 'communities');
                   11936:                     } else {
                   11937:                         next if ($parent eq 'communities');
                   11938:                     }
1.663     raeburn  11939:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   11940:                     my $item = &escape($parent).'::0';
                   11941:                     my $checked = '';
                   11942:                     if (@currcategories > 0) {
                   11943:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   11944:                             $checked = ' checked="checked"';
1.663     raeburn  11945:                         }
                   11946:                     }
1.919     raeburn  11947:                     my $parent_title = $parent;
                   11948:                     if ($parent eq 'communities') {
                   11949:                         $parent_title = &mt('Communities');
                   11950:                     }
                   11951:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   11952:                               '<input type="checkbox" name="usecategory" value="'.
                   11953:                               $item.'"'.$checked.' />'.$parent_title.'</span>'.
                   11954:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  11955:                     my $depth = 1;
                   11956:                     push(@path,$parent);
1.919     raeburn  11957:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663     raeburn  11958:                     pop(@path);
1.919     raeburn  11959:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  11960:                     $itemcount ++;
                   11961:                 }
1.919     raeburn  11962:                 if ($itemcount) {
                   11963:                     $output = &Apache::loncommon::start_data_table().
                   11964:                               $table.
                   11965:                               &Apache::loncommon::end_data_table();
                   11966:                 }
1.663     raeburn  11967:             }
                   11968:         }
                   11969:     }
                   11970:     return $output;
                   11971: }
                   11972: 
                   11973: =pod
                   11974: 
                   11975: =item *&assign_category_rows()
                   11976: 
                   11977: Create a datatable row for display of nested categories in a domain,
                   11978: with checkboxes to allow a course to be categorized,called recursively.
                   11979: 
                   11980: Inputs:
                   11981: 
                   11982: itemcount - track row number for alternating colors
                   11983: 
                   11984: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   11985:       categories and subcategories.
                   11986: 
                   11987: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   11988: 
                   11989: parent - parent of current category item
                   11990: 
                   11991: path - Array containing all categories back up through the hierarchy from the
                   11992:        current category to the top level.
                   11993: 
                   11994: currcategories - reference to array of current categories assigned to the course
                   11995: 
                   11996: Returns: $output (markup to be displayed).
                   11997: 
                   11998: =cut
                   11999: 
                   12000: sub assign_category_rows {
                   12001:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   12002:     my ($text,$name,$item,$chgstr);
                   12003:     if (ref($cats) eq 'ARRAY') {
                   12004:         my $maxdepth = scalar(@{$cats});
                   12005:         if (ref($cats->[$depth]) eq 'HASH') {
                   12006:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   12007:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   12008:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   12009:                 $text .= '<td><table class="LC_datatable">';
                   12010:                 for (my $j=0; $j<$numchildren; $j++) {
                   12011:                     $name = $cats->[$depth]{$parent}[$j];
                   12012:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   12013:                     my $deeper = $depth+1;
                   12014:                     my $checked = '';
                   12015:                     if (ref($currcategories) eq 'ARRAY') {
                   12016:                         if (@{$currcategories} > 0) {
                   12017:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   12018:                                 $checked = ' checked="checked"';
1.663     raeburn  12019:                             }
                   12020:                         }
                   12021:                     }
1.664     raeburn  12022:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   12023:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  12024:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   12025:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   12026:                              '</td><td>';
1.663     raeburn  12027:                     if (ref($path) eq 'ARRAY') {
                   12028:                         push(@{$path},$name);
                   12029:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   12030:                         pop(@{$path});
                   12031:                     }
                   12032:                     $text .= '</td></tr>';
                   12033:                 }
                   12034:                 $text .= '</table></td>';
                   12035:             }
                   12036:         }
                   12037:     }
                   12038:     return $text;
                   12039: }
                   12040: 
1.655     raeburn  12041: ############################################################
                   12042: ############################################################
                   12043: 
                   12044: 
1.443     albertel 12045: sub commit_customrole {
1.664     raeburn  12046:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  12047:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 12048:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   12049:                          ($end?', ending '.localtime($end):'').': <b>'.
                   12050:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  12051:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 12052:                  '</b><br />';
                   12053:     return $output;
                   12054: }
                   12055: 
                   12056: sub commit_standardrole {
1.541     raeburn  12057:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   12058:     my ($output,$logmsg,$linefeed);
                   12059:     if ($context eq 'auto') {
                   12060:         $linefeed = "\n";
                   12061:     } else {
                   12062:         $linefeed = "<br />\n";
                   12063:     }  
1.443     albertel 12064:     if ($three eq 'st') {
1.541     raeburn  12065:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   12066:                                          $one,$two,$sec,$context);
                   12067:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  12068:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   12069:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 12070:         } else {
1.541     raeburn  12071:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 12072:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  12073:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   12074:             if ($context eq 'auto') {
                   12075:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   12076:             } else {
                   12077:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   12078:                &mt('Add to classlist').': <b>ok</b>';
                   12079:             }
                   12080:             $output .= $linefeed;
1.443     albertel 12081:         }
                   12082:     } else {
                   12083:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   12084:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  12085:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  12086:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  12087:         if ($context eq 'auto') {
                   12088:             $output .= $result.$linefeed;
                   12089:         } else {
                   12090:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   12091:         }
1.443     albertel 12092:     }
                   12093:     return $output;
                   12094: }
                   12095: 
                   12096: sub commit_studentrole {
1.541     raeburn  12097:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  12098:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  12099:     if ($context eq 'auto') {
                   12100:         $linefeed = "\n";
                   12101:     } else {
                   12102:         $linefeed = '<br />'."\n";
                   12103:     }
1.443     albertel 12104:     if (defined($one) && defined($two)) {
                   12105:         my $cid=$one.'_'.$two;
                   12106:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   12107:         my $secchange = 0;
                   12108:         my $expire_role_result;
                   12109:         my $modify_section_result;
1.628     raeburn  12110:         if ($oldsec ne '-1') { 
                   12111:             if ($oldsec ne $sec) {
1.443     albertel 12112:                 $secchange = 1;
1.628     raeburn  12113:                 my $now = time;
1.443     albertel 12114:                 my $uurl='/'.$cid;
                   12115:                 $uurl=~s/\_/\//g;
                   12116:                 if ($oldsec) {
                   12117:                     $uurl.='/'.$oldsec;
                   12118:                 }
1.626     raeburn  12119:                 $oldsecurl = $uurl;
1.628     raeburn  12120:                 $expire_role_result = 
1.652     raeburn  12121:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  12122:                 if ($env{'request.course.sec'} ne '') { 
                   12123:                     if ($expire_role_result eq 'refused') {
                   12124:                         my @roles = ('st');
                   12125:                         my @statuses = ('previous');
                   12126:                         my @roledoms = ($one);
                   12127:                         my $withsec = 1;
                   12128:                         my %roleshash = 
                   12129:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   12130:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   12131:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   12132:                             my ($oldstart,$oldend) = 
                   12133:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   12134:                             if ($oldend > 0 && $oldend <= $now) {
                   12135:                                 $expire_role_result = 'ok';
                   12136:                             }
                   12137:                         }
                   12138:                     }
                   12139:                 }
1.443     albertel 12140:                 $result = $expire_role_result;
                   12141:             }
                   12142:         }
                   12143:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  12144:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 12145:             if ($modify_section_result =~ /^ok/) {
                   12146:                 if ($secchange == 1) {
1.628     raeburn  12147:                     if ($sec eq '') {
                   12148:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   12149:                     } else {
                   12150:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   12151:                     }
1.443     albertel 12152:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  12153:                     if ($sec eq '') {
                   12154:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   12155:                     } else {
                   12156:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   12157:                     }
1.443     albertel 12158:                 } else {
1.628     raeburn  12159:                     if ($sec eq '') {
                   12160:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   12161:                     } else {
                   12162:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   12163:                     }
1.443     albertel 12164:                 }
                   12165:             } else {
1.628     raeburn  12166:                 if ($secchange) {       
                   12167:                     $$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;
                   12168:                 } else {
                   12169:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   12170:                 }
1.443     albertel 12171:             }
                   12172:             $result = $modify_section_result;
                   12173:         } elsif ($secchange == 1) {
1.628     raeburn  12174:             if ($oldsec eq '') {
                   12175:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   12176:             } else {
                   12177:                 $$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;
                   12178:             }
1.626     raeburn  12179:             if ($expire_role_result eq 'refused') {
                   12180:                 my $newsecurl = '/'.$cid;
                   12181:                 $newsecurl =~ s/\_/\//g;
                   12182:                 if ($sec ne '') {
                   12183:                     $newsecurl.='/'.$sec;
                   12184:                 }
                   12185:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   12186:                     if ($sec eq '') {
                   12187:                         $$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;
                   12188:                     } else {
                   12189:                         $$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;
                   12190:                     }
                   12191:                 }
                   12192:             }
1.443     albertel 12193:         }
                   12194:     } else {
1.626     raeburn  12195:         $$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 12196:         $result = "error: incomplete course id\n";
                   12197:     }
                   12198:     return $result;
                   12199: }
                   12200: 
                   12201: ############################################################
                   12202: ############################################################
                   12203: 
1.566     albertel 12204: sub check_clone {
1.578     raeburn  12205:     my ($args,$linefeed) = @_;
1.566     albertel 12206:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   12207:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   12208:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   12209:     my $clonemsg;
                   12210:     my $can_clone = 0;
1.944     raeburn  12211:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  12212:     if ($lctype ne 'community') {
                   12213:         $lctype = 'course';
                   12214:     }
1.566     albertel 12215:     if ($clonehome eq 'no_host') {
1.944     raeburn  12216:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  12217:             $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
                   12218:         } else {
                   12219:             $clonemsg = &mt('No new course created.').$linefeed.&mt('A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
                   12220:         }     
1.566     albertel 12221:     } else {
                   12222: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  12223:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  12224:             if ($clonedesc{'type'} ne 'Community') {
                   12225:                  $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
                   12226:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   12227:             }
                   12228:         }
1.882     raeburn  12229: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   12230:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 12231: 	    $can_clone = 1;
                   12232: 	} else {
                   12233: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   12234: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   12235: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  12236:             if (grep(/^\*$/,@cloners)) {
                   12237:                 $can_clone = 1;
                   12238:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   12239:                 $can_clone = 1;
                   12240:             } else {
1.908     raeburn  12241:                 my $ccrole = 'cc';
1.944     raeburn  12242:                 if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  12243:                     $ccrole = 'co';
                   12244:                 }
1.578     raeburn  12245: 	        my %roleshash =
                   12246: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   12247: 					 $args->{'ccdomain'},
1.908     raeburn  12248:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  12249: 					 [$args->{'clonedomain'}]);
1.908     raeburn  12250: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942     raeburn  12251:                     $can_clone = 1;
                   12252:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
                   12253:                     $can_clone = 1;
                   12254:                 } else {
1.944     raeburn  12255:                     if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  12256:                         $clonemsg = &mt('No new community created.').$linefeed.&mt('The new community could not be cloned from the existing community because the new community owner ([_1]) does not have cloning rights in the existing community ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
                   12257:                     } else {
                   12258:                         $clonemsg = &mt('No new course created.').$linefeed.&mt('The new course could not be cloned from the existing course because the new course owner ([_1]) does not have cloning rights in the existing course ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
                   12259:                     }
1.578     raeburn  12260: 	        }
1.566     albertel 12261: 	    }
1.578     raeburn  12262:         }
1.566     albertel 12263:     }
                   12264:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   12265: }
                   12266: 
1.444     albertel 12267: sub construct_course {
1.885     raeburn  12268:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 12269:     my $outcome;
1.541     raeburn  12270:     my $linefeed =  '<br />'."\n";
                   12271:     if ($context eq 'auto') {
                   12272:         $linefeed = "\n";
                   12273:     }
1.566     albertel 12274: 
                   12275: #
                   12276: # Are we cloning?
                   12277: #
                   12278:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   12279:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  12280: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 12281: 	if ($context ne 'auto') {
1.578     raeburn  12282:             if ($clonemsg ne '') {
                   12283: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   12284:             }
1.566     albertel 12285: 	}
                   12286: 	$outcome .= $clonemsg.$linefeed;
                   12287: 
                   12288:         if (!$can_clone) {
                   12289: 	    return (0,$outcome);
                   12290: 	}
                   12291:     }
                   12292: 
1.444     albertel 12293: #
                   12294: # Open course
                   12295: #
                   12296:     my $crstype = lc($args->{'crstype'});
                   12297:     my %cenv=();
                   12298:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   12299:                                              $args->{'cdescr'},
                   12300:                                              $args->{'curl'},
                   12301:                                              $args->{'course_home'},
                   12302:                                              $args->{'nonstandard'},
                   12303:                                              $args->{'crscode'},
                   12304:                                              $args->{'ccuname'}.':'.
                   12305:                                              $args->{'ccdomain'},
1.882     raeburn  12306:                                              $args->{'crstype'},
1.885     raeburn  12307:                                              $cnum,$context,$category);
1.444     albertel 12308: 
                   12309:     # Note: The testing routines depend on this being output; see 
                   12310:     # Utils::Course. This needs to at least be output as a comment
                   12311:     # if anyone ever decides to not show this, and Utils::Course::new
                   12312:     # will need to be suitably modified.
1.541     raeburn  12313:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  12314:     if ($$courseid =~ /^error:/) {
                   12315:         return (0,$outcome);
                   12316:     }
                   12317: 
1.444     albertel 12318: #
                   12319: # Check if created correctly
                   12320: #
1.479     albertel 12321:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 12322:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  12323:     if ($crsuhome eq 'no_host') {
                   12324:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   12325:         return (0,$outcome);
                   12326:     }
1.541     raeburn  12327:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 12328: 
1.444     albertel 12329: #
1.566     albertel 12330: # Do the cloning
                   12331: #   
                   12332:     if ($can_clone && $cloneid) {
                   12333: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   12334: 	if ($context ne 'auto') {
                   12335: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   12336: 	}
                   12337: 	$outcome .= $clonemsg.$linefeed;
                   12338: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 12339: # Copy all files
1.637     www      12340: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 12341: # Restore URL
1.566     albertel 12342: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 12343: # Restore title
1.566     albertel 12344: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  12345: # Restore creation date, creator and creation context.
                   12346:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   12347:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   12348:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 12349: # Mark as cloned
1.566     albertel 12350: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      12351: # Need to clone grading mode
                   12352:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   12353:         $cenv{'grading'}=$newenv{'grading'};
                   12354: # Do not clone these environment entries
                   12355:         &Apache::lonnet::del('environment',
                   12356:                   ['default_enrollment_start_date',
                   12357:                    'default_enrollment_end_date',
                   12358:                    'question.email',
                   12359:                    'policy.email',
                   12360:                    'comment.email',
                   12361:                    'pch.users.denied',
1.725     raeburn  12362:                    'plc.users.denied',
                   12363:                    'hidefromcat',
                   12364:                    'categories'],
1.638     www      12365:                    $$crsudom,$$crsunum);
1.444     albertel 12366:     }
1.566     albertel 12367: 
1.444     albertel 12368: #
                   12369: # Set environment (will override cloned, if existing)
                   12370: #
                   12371:     my @sections = ();
                   12372:     my @xlists = ();
                   12373:     if ($args->{'crstype'}) {
                   12374:         $cenv{'type'}=$args->{'crstype'};
                   12375:     }
                   12376:     if ($args->{'crsid'}) {
                   12377:         $cenv{'courseid'}=$args->{'crsid'};
                   12378:     }
                   12379:     if ($args->{'crscode'}) {
                   12380:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   12381:     }
                   12382:     if ($args->{'crsquota'} ne '') {
                   12383:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   12384:     } else {
                   12385:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   12386:     }
                   12387:     if ($args->{'ccuname'}) {
                   12388:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   12389:                                         ':'.$args->{'ccdomain'};
                   12390:     } else {
                   12391:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   12392:     }
                   12393:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   12394:     if ($args->{'crssections'}) {
                   12395:         $cenv{'internal.sectionnums'} = '';
                   12396:         if ($args->{'crssections'} =~ m/,/) {
                   12397:             @sections = split/,/,$args->{'crssections'};
                   12398:         } else {
                   12399:             $sections[0] = $args->{'crssections'};
                   12400:         }
                   12401:         if (@sections > 0) {
                   12402:             foreach my $item (@sections) {
                   12403:                 my ($sec,$gp) = split/:/,$item;
                   12404:                 my $class = $args->{'crscode'}.$sec;
                   12405:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   12406:                 $cenv{'internal.sectionnums'} .= $item.',';
                   12407:                 unless ($addcheck eq 'ok') {
                   12408:                     push @badclasses, $class;
                   12409:                 }
                   12410:             }
                   12411:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   12412:         }
                   12413:     }
                   12414: # do not hide course coordinator from staff listing, 
                   12415: # even if privileged
                   12416:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   12417: # add crosslistings
                   12418:     if ($args->{'crsxlist'}) {
                   12419:         $cenv{'internal.crosslistings'}='';
                   12420:         if ($args->{'crsxlist'} =~ m/,/) {
                   12421:             @xlists = split/,/,$args->{'crsxlist'};
                   12422:         } else {
                   12423:             $xlists[0] = $args->{'crsxlist'};
                   12424:         }
                   12425:         if (@xlists > 0) {
                   12426:             foreach my $item (@xlists) {
                   12427:                 my ($xl,$gp) = split/:/,$item;
                   12428:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   12429:                 $cenv{'internal.crosslistings'} .= $item.',';
                   12430:                 unless ($addcheck eq 'ok') {
                   12431:                     push @badclasses, $xl;
                   12432:                 }
                   12433:             }
                   12434:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   12435:         }
                   12436:     }
                   12437:     if ($args->{'autoadds'}) {
                   12438:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   12439:     }
                   12440:     if ($args->{'autodrops'}) {
                   12441:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   12442:     }
                   12443: # check for notification of enrollment changes
                   12444:     my @notified = ();
                   12445:     if ($args->{'notify_owner'}) {
                   12446:         if ($args->{'ccuname'} ne '') {
                   12447:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   12448:         }
                   12449:     }
                   12450:     if ($args->{'notify_dc'}) {
                   12451:         if ($uname ne '') { 
1.630     raeburn  12452:             push(@notified,$uname.':'.$udom);
1.444     albertel 12453:         }
                   12454:     }
                   12455:     if (@notified > 0) {
                   12456:         my $notifylist;
                   12457:         if (@notified > 1) {
                   12458:             $notifylist = join(',',@notified);
                   12459:         } else {
                   12460:             $notifylist = $notified[0];
                   12461:         }
                   12462:         $cenv{'internal.notifylist'} = $notifylist;
                   12463:     }
                   12464:     if (@badclasses > 0) {
                   12465:         my %lt=&Apache::lonlocal::texthash(
                   12466:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.  However, if automated course roster updates are enabled for this class, these particular sections/crosslistings will not contribute towards enrollment, because the user identified as the course owner for this LON-CAPA course',
                   12467:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   12468:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   12469:         );
1.541     raeburn  12470:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   12471:                            ' ('.$lt{'adby'}.')';
                   12472:         if ($context eq 'auto') {
                   12473:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 12474:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  12475:             foreach my $item (@badclasses) {
                   12476:                 if ($context eq 'auto') {
                   12477:                     $outcome .= " - $item\n";
                   12478:                 } else {
                   12479:                     $outcome .= "<li>$item</li>\n";
                   12480:                 }
                   12481:             }
                   12482:             if ($context eq 'auto') {
                   12483:                 $outcome .= $linefeed;
                   12484:             } else {
1.566     albertel 12485:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  12486:             }
                   12487:         } 
1.444     albertel 12488:     }
                   12489:     if ($args->{'no_end_date'}) {
                   12490:         $args->{'endaccess'} = 0;
                   12491:     }
                   12492:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   12493:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   12494:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   12495:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   12496:     if ($args->{'showphotos'}) {
                   12497:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   12498:     }
                   12499:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   12500:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   12501:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   12502:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  12503:             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'); 
                   12504:             if ($context eq 'auto') {
                   12505:                 $outcome .= $krb_msg;
                   12506:             } else {
1.566     albertel 12507:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  12508:             }
                   12509:             $outcome .= $linefeed;
1.444     albertel 12510:         }
                   12511:     }
                   12512:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   12513:        if ($args->{'setpolicy'}) {
                   12514:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   12515:        }
                   12516:        if ($args->{'setcontent'}) {
                   12517:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   12518:        }
                   12519:     }
                   12520:     if ($args->{'reshome'}) {
                   12521: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   12522: 	$cenv{'reshome'}=~s/\/+$/\//;
                   12523:     }
                   12524: #
                   12525: # course has keyed access
                   12526: #
                   12527:     if ($args->{'setkeys'}) {
                   12528:        $cenv{'keyaccess'}='yes';
                   12529:     }
                   12530: # if specified, key authority is not course, but user
                   12531: # only active if keyaccess is yes
                   12532:     if ($args->{'keyauth'}) {
1.487     albertel 12533: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   12534: 	$user = &LONCAPA::clean_username($user);
                   12535: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     12536: 	if ($user ne '' && $domain ne '') {
1.487     albertel 12537: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 12538: 	}
                   12539:     }
                   12540: 
                   12541:     if ($args->{'disresdis'}) {
                   12542:         $cenv{'pch.roles.denied'}='st';
                   12543:     }
                   12544:     if ($args->{'disablechat'}) {
                   12545:         $cenv{'plc.roles.denied'}='st';
                   12546:     }
                   12547: 
                   12548:     # Record we've not yet viewed the Course Initialization Helper for this 
                   12549:     # course
                   12550:     $cenv{'course.helper.not.run'} = 1;
                   12551:     #
                   12552:     # Use new Randomseed
                   12553:     #
                   12554:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   12555:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   12556:     #
                   12557:     # The encryption code and receipt prefix for this course
                   12558:     #
                   12559:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   12560:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   12561:     #
                   12562:     # By default, use standard grading
                   12563:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   12564: 
1.541     raeburn  12565:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   12566:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 12567: #
                   12568: # Open all assignments
                   12569: #
                   12570:     if ($args->{'openall'}) {
                   12571:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   12572:        my %storecontent = ($storeunder         => time,
                   12573:                            $storeunder.'.type' => 'date_start');
                   12574:        
                   12575:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  12576:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 12577:    }
                   12578: #
                   12579: # Set first page
                   12580: #
                   12581:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   12582: 	    || ($cloneid)) {
1.445     albertel 12583: 	use LONCAPA::map;
1.444     albertel 12584: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 12585: 
                   12586: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   12587:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   12588: 
1.444     albertel 12589:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   12590:         my $title; my $url;
                   12591:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   12592: 	    $title=&mt('Syllabus');
1.444     albertel 12593:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   12594:         } else {
1.963     raeburn  12595:             $title=&mt('Table of Contents');
1.444     albertel 12596:             $url='/adm/navmaps';
                   12597:         }
1.445     albertel 12598: 
                   12599:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   12600: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   12601: 
                   12602: 	if ($errtext) { $fatal=2; }
1.541     raeburn  12603:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 12604:     }
1.566     albertel 12605: 
                   12606:     return (1,$outcome);
1.444     albertel 12607: }
                   12608: 
                   12609: ############################################################
                   12610: ############################################################
                   12611: 
1.953     droeschl 12612: #SD
                   12613: # only Community and Course, or anything else?
1.378     raeburn  12614: sub course_type {
                   12615:     my ($cid) = @_;
                   12616:     if (!defined($cid)) {
                   12617:         $cid = $env{'request.course.id'};
                   12618:     }
1.404     albertel 12619:     if (defined($env{'course.'.$cid.'.type'})) {
                   12620:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  12621:     } else {
                   12622:         return 'Course';
1.377     raeburn  12623:     }
                   12624: }
1.156     albertel 12625: 
1.406     raeburn  12626: sub group_term {
                   12627:     my $crstype = &course_type();
                   12628:     my %names = (
                   12629:                   'Course' => 'group',
1.865     raeburn  12630:                   'Community' => 'group',
1.406     raeburn  12631:                 );
                   12632:     return $names{$crstype};
                   12633: }
                   12634: 
1.902     raeburn  12635: sub course_types {
                   12636:     my @types = ('official','unofficial','community');
                   12637:     my %typename = (
                   12638:                          official   => 'Official course',
                   12639:                          unofficial => 'Unofficial course',
                   12640:                          community  => 'Community',
                   12641:                    );
                   12642:     return (\@types,\%typename);
                   12643: }
                   12644: 
1.156     albertel 12645: sub icon {
                   12646:     my ($file)=@_;
1.505     albertel 12647:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 12648:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 12649:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 12650:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   12651: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   12652: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   12653: 	            $curfext.".gif") {
                   12654: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   12655: 		$curfext.".gif";
                   12656: 	}
                   12657:     }
1.249     albertel 12658:     return &lonhttpdurl($iconname);
1.154     albertel 12659: } 
1.84      albertel 12660: 
1.575     albertel 12661: sub lonhttpdurl {
1.692     www      12662: #
                   12663: # Had been used for "small fry" static images on separate port 8080.
                   12664: # Modify here if lightweight http functionality desired again.
                   12665: # Currently eliminated due to increasing firewall issues.
                   12666: #
1.575     albertel 12667:     my ($url)=@_;
1.692     www      12668:     return $url;
1.215     albertel 12669: }
                   12670: 
1.213     albertel 12671: sub connection_aborted {
                   12672:     my ($r)=@_;
                   12673:     $r->print(" ");$r->rflush();
                   12674:     my $c = $r->connection;
                   12675:     return $c->aborted();
                   12676: }
                   12677: 
1.221     foxr     12678: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     12679: #    strings as 'strings'.
                   12680: sub escape_single {
1.221     foxr     12681:     my ($input) = @_;
1.223     albertel 12682:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     12683:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   12684:     return $input;
                   12685: }
1.223     albertel 12686: 
1.222     foxr     12687: #  Same as escape_single, but escape's "'s  This 
                   12688: #  can be used for  "strings"
                   12689: sub escape_double {
                   12690:     my ($input) = @_;
                   12691:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   12692:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   12693:     return $input;
                   12694: }
1.223     albertel 12695:  
1.222     foxr     12696: #   Escapes the last element of a full URL.
                   12697: sub escape_url {
                   12698:     my ($url)   = @_;
1.238     raeburn  12699:     my @urlslices = split(/\//, $url,-1);
1.369     www      12700:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 12701:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     12702: }
1.462     albertel 12703: 
1.820     raeburn  12704: sub compare_arrays {
                   12705:     my ($arrayref1,$arrayref2) = @_;
                   12706:     my (@difference,%count);
                   12707:     @difference = ();
                   12708:     %count = ();
                   12709:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   12710:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   12711:         foreach my $element (keys(%count)) {
                   12712:             if ($count{$element} == 1) {
                   12713:                 push(@difference,$element);
                   12714:             }
                   12715:         }
                   12716:     }
                   12717:     return @difference;
                   12718: }
                   12719: 
1.817     bisitz   12720: # -------------------------------------------------------- Initialize user login
1.462     albertel 12721: sub init_user_environment {
1.463     albertel 12722:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 12723:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   12724: 
                   12725:     my $public=($username eq 'public' && $domain eq 'public');
                   12726: 
                   12727: # See if old ID present, if so, remove
                   12728: 
1.1062  ! raeburn  12729:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 12730:     my $now=time;
                   12731: 
                   12732:     if ($public) {
                   12733: 	my $max_public=100;
                   12734: 	my $oldest;
                   12735: 	my $oldest_time=0;
                   12736: 	for(my $next=1;$next<=$max_public;$next++) {
                   12737: 	    if (-e $lonids."/publicuser_$next.id") {
                   12738: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   12739: 		if ($mtime<$oldest_time || !$oldest_time) {
                   12740: 		    $oldest_time=$mtime;
                   12741: 		    $oldest=$next;
                   12742: 		}
                   12743: 	    } else {
                   12744: 		$cookie="publicuser_$next";
                   12745: 		last;
                   12746: 	    }
                   12747: 	}
                   12748: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   12749:     } else {
1.463     albertel 12750: 	# if this isn't a robot, kill any existing non-robot sessions
                   12751: 	if (!$args->{'robot'}) {
                   12752: 	    opendir(DIR,$lonids);
                   12753: 	    while ($filename=readdir(DIR)) {
                   12754: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   12755: 		    unlink($lonids.'/'.$filename);
                   12756: 		}
1.462     albertel 12757: 	    }
1.463     albertel 12758: 	    closedir(DIR);
1.462     albertel 12759: 	}
                   12760: # Give them a new cookie
1.463     albertel 12761: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      12762: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 12763: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 12764:     
                   12765: # Initialize roles
                   12766: 
1.1062  ! raeburn  12767: 	($userroles,$firstaccenv,$timerintenv) = 
        !          12768:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 12769:     }
                   12770: # ------------------------------------ Check browser type and MathML capability
                   12771: 
                   12772:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   12773:         $clientunicode,$clientos) = &decode_user_agent($r);
                   12774: 
                   12775: # ------------------------------------------------------------- Get environment
                   12776: 
                   12777:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   12778:     my ($tmp) = keys(%userenv);
                   12779:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   12780:     } else {
                   12781: 	undef(%userenv);
                   12782:     }
                   12783:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   12784: 	$form->{'interface'}=$userenv{'interface'};
                   12785:     }
                   12786:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   12787: 
                   12788: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   12789:     foreach my $option ('interface','localpath','localres') {
                   12790:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 12791:     }
                   12792: # --------------------------------------------------------- Write first profile
                   12793: 
                   12794:     {
                   12795: 	my %initial_env = 
                   12796: 	    ("user.name"          => $username,
                   12797: 	     "user.domain"        => $domain,
                   12798: 	     "user.home"          => $authhost,
                   12799: 	     "browser.type"       => $clientbrowser,
                   12800: 	     "browser.version"    => $clientversion,
                   12801: 	     "browser.mathml"     => $clientmathml,
                   12802: 	     "browser.unicode"    => $clientunicode,
                   12803: 	     "browser.os"         => $clientos,
                   12804: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   12805: 	     "request.course.fn"  => '',
                   12806: 	     "request.course.uri" => '',
                   12807: 	     "request.course.sec" => '',
                   12808: 	     "request.role"       => 'cm',
                   12809: 	     "request.role.adv"   => $env{'user.adv'},
                   12810: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   12811: 
                   12812:         if ($form->{'localpath'}) {
                   12813: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   12814: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   12815:         }
                   12816: 	
                   12817: 	if ($form->{'interface'}) {
                   12818: 	    $form->{'interface'}=~s/\W//gs;
                   12819: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   12820: 	    $env{'browser.interface'}=$form->{'interface'};
                   12821: 	}
                   12822: 
1.981     raeburn  12823:         my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016    raeburn  12824:         my %domdef;
                   12825:         unless ($domain eq 'public') {
                   12826:             %domdef = &Apache::lonnet::get_domain_defaults($domain);
                   12827:         }
1.980     raeburn  12828: 
1.724     raeburn  12829:         foreach my $tool ('aboutme','blog','portfolio') {
                   12830:             $userenv{'availabletools.'.$tool} = 
1.980     raeburn  12831:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   12832:                                                   undef,\%userenv,\%domdef,\%is_adv);
1.724     raeburn  12833:         }
                   12834: 
1.864     raeburn  12835:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  12836:             $userenv{'canrequest.'.$crstype} =
                   12837:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980     raeburn  12838:                                                   'reload','requestcourses',
                   12839:                                                   \%userenv,\%domdef,\%is_adv);
1.765     raeburn  12840:         }
                   12841: 
1.462     albertel 12842: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062  ! raeburn  12843: 
1.462     albertel 12844: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   12845: 		 &GDBM_WRCREAT(),0640)) {
                   12846: 	    &_add_to_env(\%disk_env,\%initial_env);
                   12847: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   12848: 	    &_add_to_env(\%disk_env,$userroles);
1.1062  ! raeburn  12849:             if (ref($firstaccenv) eq 'HASH') {
        !          12850:                 &_add_to_env(\%disk_env,$firstaccenv);
        !          12851:             }
        !          12852:             if (ref($timerintenv) eq 'HASH') {
        !          12853:                 &_add_to_env(\%disk_env,$timerintenv);
        !          12854:             }
1.463     albertel 12855: 	    if (ref($args->{'extra_env'})) {
                   12856: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   12857: 	    }
1.462     albertel 12858: 	    untie(%disk_env);
                   12859: 	} else {
1.705     tempelho 12860: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   12861: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 12862: 	    return 'error: '.$!;
                   12863: 	}
                   12864:     }
                   12865:     $env{'request.role'}='cm';
                   12866:     $env{'request.role.adv'}=$env{'user.adv'};
                   12867:     $env{'browser.type'}=$clientbrowser;
                   12868: 
                   12869:     return $cookie;
                   12870: 
                   12871: }
                   12872: 
                   12873: sub _add_to_env {
                   12874:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  12875:     if (ref($env_data) eq 'HASH') {
                   12876:         while (my ($key,$value) = each(%$env_data)) {
                   12877: 	    $idf->{$prefix.$key} = $value;
                   12878: 	    $env{$prefix.$key}   = $value;
                   12879:         }
1.462     albertel 12880:     }
                   12881: }
                   12882: 
1.685     tempelho 12883: # --- Get the symbolic name of a problem and the url
                   12884: sub get_symb {
                   12885:     my ($request,$silent) = @_;
1.726     raeburn  12886:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 12887:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   12888:     if ($symb eq '') {
                   12889:         if (!$silent) {
                   12890:             $request->print("Unable to handle ambiguous references:$url:.");
                   12891:             return ();
                   12892:         }
                   12893:     }
                   12894:     &Apache::lonenc::check_decrypt(\$symb);
                   12895:     return ($symb);
                   12896: }
                   12897: 
                   12898: # --------------------------------------------------------------Get annotation
                   12899: 
                   12900: sub get_annotation {
                   12901:     my ($symb,$enc) = @_;
                   12902: 
                   12903:     my $key = $symb;
                   12904:     if (!$enc) {
                   12905:         $key =
                   12906:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   12907:     }
                   12908:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   12909:     return $annotation{$key};
                   12910: }
                   12911: 
                   12912: sub clean_symb {
1.731     raeburn  12913:     my ($symb,$delete_enc) = @_;
1.685     tempelho 12914: 
                   12915:     &Apache::lonenc::check_decrypt(\$symb);
                   12916:     my $enc = $env{'request.enc'};
1.731     raeburn  12917:     if ($delete_enc) {
1.730     raeburn  12918:         delete($env{'request.enc'});
                   12919:     }
1.685     tempelho 12920: 
                   12921:     return ($symb,$enc);
                   12922: }
1.462     albertel 12923: 
1.990     raeburn  12924: sub build_release_hashes {
                   12925:     my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
                   12926:     return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
                   12927:                   (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
                   12928:                   (ref($randomizetry) eq 'HASH'));
                   12929:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   12930:         my ($item,$name,$value) = split(/:/,$key);
                   12931:         if ($item eq 'parameter') {
                   12932:             if (ref($checkparms->{$name}) eq 'ARRAY') {
                   12933:                 unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
                   12934:                     push(@{$checkparms->{$name}},$value);
                   12935:                 }
                   12936:             } else {
                   12937:                 push(@{$checkparms->{$name}},$value);
                   12938:             }
                   12939:         } elsif ($item eq 'resourcetag') {
                   12940:             if ($name eq 'responsetype') {
                   12941:                 $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
                   12942:             }
                   12943:         } elsif ($item eq 'course') {
                   12944:             if ($name eq 'crstype') {
                   12945:                 $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
                   12946:             }
                   12947:         }
                   12948:     }
                   12949:     ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
                   12950:     ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
                   12951:     return;
                   12952: }
                   12953: 
1.41      ng       12954: =pod
                   12955: 
                   12956: =back
                   12957: 
1.112     bowersj2 12958: =cut
1.41      ng       12959: 
1.112     bowersj2 12960: 1;
                   12961: __END__;
1.41      ng       12962: 

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