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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.1057  ! foxr        4: # $Id: loncommon.pm,v 1.1056 2012/02/28 02:02:16 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:             }
                   4020:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   4021:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   4022:             if ($secpart eq '') {
                   4023:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   4024:                 $sec = 'none';
                   4025:                 $realsec = '';
                   4026:             } else {
                   4027:                 $cnum = $cnumpart;
                   4028:                 ($sec,$role) = split(/_/,$secpart);
                   4029:                 $realsec = $sec;
1.490     raeburn  4030:             }
1.482     raeburn  4031:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   4032:         }
                   4033:     } else {
                   4034:         foreach my $key (keys(%env)) {
1.483     albertel 4035: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   4036:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  4037: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   4038: 	        next if ($role eq 'ca' || $role eq 'aa');
                   4039: 	        next if (%roles && !exists($roles{$role}));
                   4040: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   4041:                 my $active=1;
                   4042:                 if ($starttime) {
                   4043: 		    if ($now<$starttime) { $active=0; }
                   4044:                 }
                   4045:                 if ($endtime) {
                   4046:                     if ($now>$endtime) { $active=0; }
                   4047:                 }
                   4048:                 if ($active) {
                   4049:                     if ($sec eq '') {
                   4050:                         $sec = 'none';
                   4051:                     }
                   4052:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   4053:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  4054:                 }
                   4055:             }
1.51      www      4056:         }
                   4057:     }
1.474     raeburn  4058:     return %courses;
1.51      www      4059: }
1.37      matthew  4060: 
1.54      www      4061: ###############################################
1.474     raeburn  4062: 
                   4063: sub blockcheck {
1.482     raeburn  4064:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  4065: 
                   4066:     if (!defined($udom)) {
                   4067:         $udom = $env{'user.domain'};
                   4068:     }
                   4069:     if (!defined($uname)) {
                   4070:         $uname = $env{'user.name'};
                   4071:     }
                   4072: 
                   4073:     # If uname and udom are for a course, check for blocks in the course.
                   4074: 
                   4075:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   4076:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  4077:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  4078:         return ($startblock,$endblock);
                   4079:     }
1.474     raeburn  4080: 
1.502     raeburn  4081:     my $startblock = 0;
                   4082:     my $endblock = 0;
1.482     raeburn  4083:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  4084: 
1.490     raeburn  4085:     # If uname is for a user, and activity is course-specific, i.e.,
                   4086:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  4087: 
1.490     raeburn  4088:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   4089:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   4090:         foreach my $key (keys(%live_courses)) {
                   4091:             if ($key ne $env{'request.course.id'}) {
                   4092:                 delete($live_courses{$key});
                   4093:             }
                   4094:         }
                   4095:     }
                   4096: 
                   4097:     my $otheruser = 0;
                   4098:     my %own_courses;
                   4099:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   4100:         # Resource belongs to user other than current user.
                   4101:         $otheruser = 1;
                   4102:         # Gather courses for current user
                   4103:         %own_courses = 
                   4104:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   4105:     }
                   4106: 
                   4107:     # Gather active course roles - course coordinator, instructor, 
                   4108:     # exam proctor, ta, student, or custom role.
1.474     raeburn  4109: 
                   4110:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  4111:         my ($cdom,$cnum);
                   4112:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   4113:             $cdom = $env{'course.'.$course.'.domain'};
                   4114:             $cnum = $env{'course.'.$course.'.num'};
                   4115:         } else {
1.490     raeburn  4116:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  4117:         }
                   4118:         my $no_ownblock = 0;
                   4119:         my $no_userblock = 0;
1.533     raeburn  4120:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  4121:             # Check if current user has 'evb' priv for this
                   4122:             if (defined($own_courses{$course})) {
                   4123:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   4124:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   4125:                     if ($sec ne 'none') {
                   4126:                         $checkrole .= '/'.$sec;
                   4127:                     }
                   4128:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4129:                         $no_ownblock = 1;
                   4130:                         last;
                   4131:                     }
                   4132:                 }
                   4133:             }
                   4134:             # if they have 'evb' priv and are currently not playing student
                   4135:             next if (($no_ownblock) &&
                   4136:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   4137:         }
1.474     raeburn  4138:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  4139:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  4140:             if ($sec ne 'none') {
1.482     raeburn  4141:                 $checkrole .= '/'.$sec;
1.474     raeburn  4142:             }
1.490     raeburn  4143:             if ($otheruser) {
                   4144:                 # Resource belongs to user other than current user.
                   4145:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  4146:                 my ($trole,$tdom,$tnum,$tsec);
                   4147:                 my $entry = $live_courses{$course}{$sec};
                   4148:                 if ($entry =~ /^cr/) {
                   4149:                     ($trole,$tdom,$tnum,$tsec) = 
                   4150:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   4151:                 } else {
                   4152:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   4153:                 }
                   4154:                 my ($spec,$area,$trest,%allroles,%userroles);
                   4155:                 $area = '/'.$tdom.'/'.$tnum;
                   4156:                 $trest = $tnum;
                   4157:                 if ($tsec ne '') {
                   4158:                     $area .= '/'.$tsec;
                   4159:                     $trest .= '/'.$tsec;
                   4160:                 }
                   4161:                 $spec = $trole.'.'.$area;
                   4162:                 if ($trole =~ /^cr/) {
                   4163:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   4164:                                                       $tdom,$spec,$trest,$area);
                   4165:                 } else {
                   4166:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   4167:                                                        $tdom,$spec,$trest,$area);
                   4168:                 }
                   4169:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  4170:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   4171:                     if ($1) {
                   4172:                         $no_userblock = 1;
                   4173:                         last;
                   4174:                     }
                   4175:                 }
1.490     raeburn  4176:             } else {
                   4177:                 # Resource belongs to current user
                   4178:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  4179:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4180:                     $no_ownblock = 1;
                   4181:                     last;
                   4182:                 }
1.474     raeburn  4183:             }
                   4184:         }
                   4185:         # if they have the evb priv and are currently not playing student
1.482     raeburn  4186:         next if (($no_ownblock) &&
1.491     albertel 4187:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  4188:         next if ($no_userblock);
1.474     raeburn  4189: 
1.866     kalberla 4190:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  4191:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  4192:         
                   4193:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   4194:         if (($start != 0) && 
                   4195:             (($startblock == 0) || ($startblock > $start))) {
                   4196:             $startblock = $start;
                   4197:         }
                   4198:         if (($end != 0)  &&
                   4199:             (($endblock == 0) || ($endblock < $end))) {
                   4200:             $endblock = $end;
                   4201:         }
1.490     raeburn  4202:     }
                   4203:     return ($startblock,$endblock);
                   4204: }
                   4205: 
                   4206: sub get_blocks {
                   4207:     my ($setters,$activity,$cdom,$cnum) = @_;
                   4208:     my $startblock = 0;
                   4209:     my $endblock = 0;
                   4210:     my $course = $cdom.'_'.$cnum;
                   4211:     $setters->{$course} = {};
                   4212:     $setters->{$course}{'staff'} = [];
                   4213:     $setters->{$course}{'times'} = [];
                   4214:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   4215:     foreach my $record (keys(%records)) {
                   4216:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   4217:         if ($start <= time && $end >= time) {
                   4218:             my ($staff_name,$staff_dom,$title,$blocks) =
                   4219:                 &parse_block_record($records{$record});
                   4220:             if ($blocks->{$activity} eq 'on') {
                   4221:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   4222:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 4223:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   4224:                     $startblock = $start;
1.490     raeburn  4225:                 }
1.491     albertel 4226:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   4227:                     $endblock = $end;
1.474     raeburn  4228:                 }
                   4229:             }
                   4230:         }
                   4231:     }
                   4232:     return ($startblock,$endblock);
                   4233: }
                   4234: 
                   4235: sub parse_block_record {
                   4236:     my ($record) = @_;
                   4237:     my ($setuname,$setudom,$title,$blocks);
                   4238:     if (ref($record) eq 'HASH') {
                   4239:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   4240:         $title = &unescape($record->{'event'});
                   4241:         $blocks = $record->{'blocks'};
                   4242:     } else {
                   4243:         my @data = split(/:/,$record,3);
                   4244:         if (scalar(@data) eq 2) {
                   4245:             $title = $data[1];
                   4246:             ($setuname,$setudom) = split(/@/,$data[0]);
                   4247:         } else {
                   4248:             ($setuname,$setudom,$title) = @data;
                   4249:         }
                   4250:         $blocks = { 'com' => 'on' };
                   4251:     }
                   4252:     return ($setuname,$setudom,$title,$blocks);
                   4253: }
                   4254: 
1.854     kalberla 4255: sub blocking_status {
                   4256:   my ($activity,$uname,$udom) = @_;
1.867     kalberla 4257:   my %setters;
1.890     droeschl 4258: 
                   4259:   # check for active blocking
1.867     kalberla 4260:   my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854     kalberla 4261: 
1.890     droeschl 4262:   my $blocked = $startblock && $endblock ? 1 : 0;
                   4263: 
                   4264:   # caller just wants to know whether a block is active
                   4265:   if (!wantarray) { return $blocked; }
                   4266: 
                   4267:   # build a link to a popup window containing the details
                   4268:   my $querystring  = "?activity=$activity";
                   4269:   # $uname and $udom decide whose portfolio the user is trying to look at
                   4270:      $querystring .= "&amp;udom=$udom"      if $udom;
                   4271:      $querystring .= "&amp;uname=$uname"    if $uname;
                   4272: 
                   4273:   my $output .= <<'END_MYBLOCK';
1.854     kalberla 4274:     function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4275:         var options = "width=" + w + ",height=" + h + ",";
                   4276:         options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4277:         options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4278:         var newWin = window.open(url, wdwName, options);
                   4279:         newWin.focus();
                   4280:     }
1.890     droeschl 4281: END_MYBLOCK
1.854     kalberla 4282: 
1.890     droeschl 4283:   $output = Apache::lonhtmlcommon::scripttag($output);
                   4284:   
1.854     kalberla 4285:   my $popupUrl = "/adm/blockingstatus/$querystring";
1.890     droeschl 4286:   my $text = mt('Communication Blocked');
                   4287: 
1.867     kalberla 4288:   $output .= <<"END_BLOCK";
                   4289: <div class='LC_comblock'>
1.869     kalberla 4290:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 4291:   title='$text'>
                   4292:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 4293:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 4294:   title='$text'>$text</a>
1.867     kalberla 4295: </div>
                   4296: 
                   4297: END_BLOCK
1.474     raeburn  4298: 
1.854     kalberla 4299:   return ($blocked, $output);
                   4300: }
1.490     raeburn  4301: 
1.60      matthew  4302: ###############################################
                   4303: 
1.682     raeburn  4304: sub check_ip_acc {
                   4305:     my ($acc)=@_;
                   4306:     &Apache::lonxml::debug("acc is $acc");
                   4307:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   4308:         return 1;
                   4309:     }
                   4310:     my $allowed=0;
                   4311:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   4312: 
                   4313:     my $name;
                   4314:     foreach my $pattern (split(',',$acc)) {
                   4315:         $pattern =~ s/^\s*//;
                   4316:         $pattern =~ s/\s*$//;
                   4317:         if ($pattern =~ /\*$/) {
                   4318:             #35.8.*
                   4319:             $pattern=~s/\*//;
                   4320:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4321:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   4322:             #35.8.3.[34-56]
                   4323:             my $low=$2;
                   4324:             my $high=$3;
                   4325:             $pattern=$1;
                   4326:             if ($ip =~ /^\Q$pattern\E/) {
                   4327:                 my $last=(split(/\./,$ip))[3];
                   4328:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4329:             }
                   4330:         } elsif ($pattern =~ /^\*/) {
                   4331:             #*.msu.edu
                   4332:             $pattern=~s/\*//;
                   4333:             if (!defined($name)) {
                   4334:                 use Socket;
                   4335:                 my $netaddr=inet_aton($ip);
                   4336:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4337:             }
                   4338:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4339:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4340:             #127.0.0.1
                   4341:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4342:         } else {
                   4343:             #some.name.com
                   4344:             if (!defined($name)) {
                   4345:                 use Socket;
                   4346:                 my $netaddr=inet_aton($ip);
                   4347:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4348:             }
                   4349:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4350:         }
                   4351:         if ($allowed) { last; }
                   4352:     }
                   4353:     return $allowed;
                   4354: }
                   4355: 
                   4356: ###############################################
                   4357: 
1.60      matthew  4358: =pod
                   4359: 
1.112     bowersj2 4360: =head1 Domain Template Functions
                   4361: 
                   4362: =over 4
                   4363: 
                   4364: =item * &determinedomain()
1.60      matthew  4365: 
                   4366: Inputs: $domain (usually will be undef)
                   4367: 
1.63      www      4368: Returns: Determines which domain should be used for designs
1.60      matthew  4369: 
                   4370: =cut
1.54      www      4371: 
1.60      matthew  4372: ###############################################
1.63      www      4373: sub determinedomain {
                   4374:     my $domain=shift;
1.531     albertel 4375:     if (! $domain) {
1.60      matthew  4376:         # Determine domain if we have not been given one
1.893     raeburn  4377:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 4378:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4379:         if ($env{'request.role.domain'}) { 
                   4380:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4381:         }
                   4382:     }
1.63      www      4383:     return $domain;
                   4384: }
                   4385: ###############################################
1.517     raeburn  4386: 
1.518     albertel 4387: sub devalidate_domconfig_cache {
                   4388:     my ($udom)=@_;
                   4389:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4390: }
                   4391: 
                   4392: # ---------------------- Get domain configuration for a domain
                   4393: sub get_domainconf {
                   4394:     my ($udom) = @_;
                   4395:     my $cachetime=1800;
                   4396:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4397:     if (defined($cached)) { return %{$result}; }
                   4398: 
                   4399:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  4400: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  4401:     my (%designhash,%legacy);
1.518     albertel 4402:     if (keys(%domconfig) > 0) {
                   4403:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4404:             if (keys(%{$domconfig{'login'}})) {
                   4405:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4406:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946     raeburn  4407:                         if ($key eq 'loginvia') {
                   4408:                             if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013    raeburn  4409:                                 foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948     raeburn  4410:                                     if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
                   4411:                                         if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   4412:                                             my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   4413:                                             $designhash{$udom.'.login.loginvia'} = $server;
                   4414:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   4415: 
                   4416:                                                 $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   4417:                                             } else {
1.1013    raeburn  4418:                                                 $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948     raeburn  4419:                                             }
                   4420:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
                   4421:                                                 $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
                   4422:                                             }
1.946     raeburn  4423:                                         }
                   4424:                                     }
                   4425:                                 }
                   4426:                             }
                   4427:                         } else {
                   4428:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4429:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4430:                                     $domconfig{'login'}{$key}{$img};
                   4431:                             }
1.699     raeburn  4432:                         }
                   4433:                     } else {
                   4434:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4435:                     }
1.632     raeburn  4436:                 }
                   4437:             } else {
                   4438:                 $legacy{'login'} = 1;
1.518     albertel 4439:             }
1.632     raeburn  4440:         } else {
                   4441:             $legacy{'login'} = 1;
1.518     albertel 4442:         }
                   4443:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4444:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4445:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4446:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4447:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4448:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4449:                         }
1.518     albertel 4450:                     }
                   4451:                 }
1.632     raeburn  4452:             } else {
                   4453:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4454:             }
1.632     raeburn  4455:         } else {
                   4456:             $legacy{'rolecolors'} = 1;
1.518     albertel 4457:         }
1.948     raeburn  4458:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   4459:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   4460:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   4461:             }
                   4462:         }
1.632     raeburn  4463:         if (keys(%legacy) > 0) {
                   4464:             my %legacyhash = &get_legacy_domconf($udom);
                   4465:             foreach my $item (keys(%legacyhash)) {
                   4466:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4467:                     if ($legacy{'login'}) { 
                   4468:                         $designhash{$item} = $legacyhash{$item};
                   4469:                     }
                   4470:                 } else {
                   4471:                     if ($legacy{'rolecolors'}) {
                   4472:                         $designhash{$item} = $legacyhash{$item};
                   4473:                     }
1.518     albertel 4474:                 }
                   4475:             }
                   4476:         }
1.632     raeburn  4477:     } else {
                   4478:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4479:     }
                   4480:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4481: 				  $cachetime);
                   4482:     return %designhash;
                   4483: }
                   4484: 
1.632     raeburn  4485: sub get_legacy_domconf {
                   4486:     my ($udom) = @_;
                   4487:     my %legacyhash;
                   4488:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4489:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4490:     if (-e $designfile) {
                   4491:         if ( open (my $fh,"<$designfile") ) {
                   4492:             while (my $line = <$fh>) {
                   4493:                 next if ($line =~ /^\#/);
                   4494:                 chomp($line);
                   4495:                 my ($key,$val)=(split(/\=/,$line));
                   4496:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4497:             }
                   4498:             close($fh);
                   4499:         }
                   4500:     }
1.1026    raeburn  4501:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  4502:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4503:     }
                   4504:     return %legacyhash;
                   4505: }
                   4506: 
1.63      www      4507: =pod
                   4508: 
1.112     bowersj2 4509: =item * &domainlogo()
1.63      www      4510: 
                   4511: Inputs: $domain (usually will be undef)
                   4512: 
                   4513: Returns: A link to a domain logo, if the domain logo exists.
                   4514: If the domain logo does not exist, a description of the domain.
                   4515: 
                   4516: =cut
1.112     bowersj2 4517: 
1.63      www      4518: ###############################################
                   4519: sub domainlogo {
1.517     raeburn  4520:     my $domain = &determinedomain(shift);
1.518     albertel 4521:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4522:     # See if there is a logo
                   4523:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4524:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4525:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4526: 	    if ($imgsrc =~ m{^/res/}) {
                   4527: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4528: 		&Apache::lonnet::repcopy($local_name);
                   4529: 	    }
                   4530: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4531:         } 
                   4532:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4533:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4534:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4535:     } else {
1.60      matthew  4536:         return '';
1.59      www      4537:     }
                   4538: }
1.63      www      4539: ##############################################
                   4540: 
                   4541: =pod
                   4542: 
1.112     bowersj2 4543: =item * &designparm()
1.63      www      4544: 
                   4545: Inputs: $which parameter; $domain (usually will be undef)
                   4546: 
                   4547: Returns: value of designparamter $which
                   4548: 
                   4549: =cut
1.112     bowersj2 4550: 
1.397     albertel 4551: 
1.400     albertel 4552: ##############################################
1.397     albertel 4553: sub designparm {
                   4554:     my ($which,$domain)=@_;
                   4555:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4556:         return $env{'environment.color.'.$which};
1.96      www      4557:     }
1.63      www      4558:     $domain=&determinedomain($domain);
1.1016    raeburn  4559:     my %domdesign;
                   4560:     unless ($domain eq 'public') {
                   4561:         %domdesign = &get_domainconf($domain);
                   4562:     }
1.520     raeburn  4563:     my $output;
1.517     raeburn  4564:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4565:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4566:     } else {
1.520     raeburn  4567:         $output = $defaultdesign{$which};
                   4568:     }
                   4569:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4570:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4571:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4572:             if ($output =~ m{^/res/}) {
                   4573:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4574:                 &Apache::lonnet::repcopy($local_name);
                   4575:             }
1.520     raeburn  4576:             $output = &lonhttpdurl($output);
                   4577:         }
1.63      www      4578:     }
1.520     raeburn  4579:     return $output;
1.63      www      4580: }
1.59      www      4581: 
1.822     bisitz   4582: ##############################################
                   4583: =pod
                   4584: 
1.832     bisitz   4585: =item * &authorspace()
                   4586: 
1.1028    raeburn  4587: Inputs: $url (usually will be undef).
1.832     bisitz   4588: 
1.1028    raeburn  4589: Returns: Path to Construction Space containing the resource or 
                   4590:          directory being viewed (or for which action is being taken). 
                   4591:          If $url is provided, and begins /priv/<domain>/<uname>
                   4592:          the path will be that portion of the $context argument.
                   4593:          Otherwise the path will be for the author space of the current
                   4594:          user when the current role is author, or for that of the 
                   4595:          co-author/assistant co-author space when the current role 
                   4596:          is co-author or assistant co-author.
1.832     bisitz   4597: 
                   4598: =cut
                   4599: 
                   4600: sub authorspace {
1.1028    raeburn  4601:     my ($url) = @_;
                   4602:     if ($url ne '') {
                   4603:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   4604:            return $1;
                   4605:         }
                   4606:     }
1.832     bisitz   4607:     my $caname = '';
1.1024    www      4608:     my $cadom = '';
1.1028    raeburn  4609:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      4610:         ($cadom,$caname) =
1.832     bisitz   4611:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  4612:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   4613:         $caname = $env{'user.name'};
1.1024    www      4614:         $cadom = $env{'user.domain'};
1.832     bisitz   4615:     }
1.1028    raeburn  4616:     if (($caname ne '') && ($cadom ne '')) {
                   4617:         return "/priv/$cadom/$caname/";
                   4618:     }
                   4619:     return;
1.832     bisitz   4620: }
                   4621: 
                   4622: ##############################################
                   4623: =pod
                   4624: 
1.822     bisitz   4625: =item * &head_subbox()
                   4626: 
                   4627: Inputs: $content (contains HTML code with page functions, etc.)
                   4628: 
                   4629: Returns: HTML div with $content
                   4630:          To be included in page header
                   4631: 
                   4632: =cut
                   4633: 
                   4634: sub head_subbox {
                   4635:     my ($content)=@_;
                   4636:     my $output =
1.993     raeburn  4637:         '<div class="LC_head_subbox">'
1.822     bisitz   4638:        .$content
                   4639:        .'</div>'
                   4640: }
                   4641: 
                   4642: ##############################################
                   4643: =pod
                   4644: 
                   4645: =item * &CSTR_pageheader()
                   4646: 
1.1026    raeburn  4647: Input: (optional) filename from which breadcrumb trail is built.
                   4648:        In most cases no input as needed, as $env{'request.filename'}
                   4649:        is appropriate for use in building the breadcrumb trail.
1.822     bisitz   4650: 
                   4651: Returns: HTML div with CSTR path and recent box
                   4652:          To be included on Construction Space pages
                   4653: 
                   4654: =cut
                   4655: 
                   4656: sub CSTR_pageheader {
1.1026    raeburn  4657:     my ($trailfile) = @_;
                   4658:     if ($trailfile eq '') {
                   4659:         $trailfile = $env{'request.filename'};
                   4660:     }
                   4661: 
                   4662: # this is for resources; directories have customtitle, and crumbs
                   4663: # and select recent are created in lonpubdir.pm
                   4664: 
                   4665:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      4666:     my ($udom,$uname,$thisdisfn)=
1.1026    raeburn  4667:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)/(.*)$});
                   4668:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   4669:     $formaction =~ s{/+}{/}g;
1.822     bisitz   4670: 
                   4671:     my $parentpath = '';
                   4672:     my $lastitem = '';
                   4673:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4674:         $parentpath = $1;
                   4675:         $lastitem = $2;
                   4676:     } else {
                   4677:         $lastitem = $thisdisfn;
                   4678:     }
1.921     bisitz   4679: 
                   4680:     my $output =
1.822     bisitz   4681:          '<div>'
                   4682:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4683:         .'<b>'.&mt('Construction Space:').'</b> '
                   4684:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   4685:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024    www      4686:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921     bisitz   4687: 
                   4688:     if ($lastitem) {
                   4689:         $output .=
                   4690:              '<span class="LC_filename">'
                   4691:             .$lastitem
                   4692:             .'</span>';
                   4693:     }
                   4694:     $output .=
                   4695:          '<br />'
1.822     bisitz   4696:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4697:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4698:         .'</form>'
                   4699:         .&Apache::lonmenu::constspaceform()
                   4700:         .'</div>';
1.921     bisitz   4701: 
                   4702:     return $output;
1.822     bisitz   4703: }
                   4704: 
1.60      matthew  4705: ###############################################
                   4706: ###############################################
                   4707: 
                   4708: =pod
                   4709: 
1.112     bowersj2 4710: =back
                   4711: 
1.549     albertel 4712: =head1 HTML Helpers
1.112     bowersj2 4713: 
                   4714: =over 4
                   4715: 
                   4716: =item * &bodytag()
1.60      matthew  4717: 
                   4718: Returns a uniform header for LON-CAPA web pages.
                   4719: 
                   4720: Inputs: 
                   4721: 
1.112     bowersj2 4722: =over 4
                   4723: 
                   4724: =item * $title, A title to be displayed on the page.
                   4725: 
                   4726: =item * $function, the current role (can be undef).
                   4727: 
                   4728: =item * $addentries, extra parameters for the <body> tag.
                   4729: 
                   4730: =item * $bodyonly, if defined, only return the <body> tag.
                   4731: 
                   4732: =item * $domain, if defined, force a given domain.
                   4733: 
                   4734: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4735:             text interface only)
1.60      matthew  4736: 
1.814     bisitz   4737: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4738:                      navigational links
1.317     albertel 4739: 
1.338     albertel 4740: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4741: 
1.460     albertel 4742: =item * $args, optional argument valid values are
                   4743:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4744:             inherit_jsmath -> when creating popup window in a page,
                   4745:                               should it have jsmath forced on by the
                   4746:                               current page
1.460     albertel 4747: 
1.112     bowersj2 4748: =back
                   4749: 
1.60      matthew  4750: Returns: A uniform header for LON-CAPA web pages.  
                   4751: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4752: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4753: other decorations will be returned.
                   4754: 
                   4755: =cut
                   4756: 
1.54      www      4757: sub bodytag {
1.831     bisitz   4758:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962     droeschl 4759:         $no_nav_bar,$bgcolor,$args)=@_;
1.339     albertel 4760: 
1.954     raeburn  4761:     my $public;
                   4762:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   4763:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   4764:         $public = 1;
                   4765:     }
1.460     albertel 4766:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4767: 
1.183     matthew  4768:     $function = &get_users_function() if (!$function);
1.339     albertel 4769:     my $img =    &designparm($function.'.img',$domain);
                   4770:     my $font =   &designparm($function.'.font',$domain);
                   4771:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4772: 
1.803     bisitz   4773:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4774: 		   'bgcolor' => $pgbg,
1.339     albertel 4775: 		   'text'    => $font,
                   4776:                    'alink'   => &designparm($function.'.alink',$domain),
                   4777: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4778: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4779:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4780: 
1.63      www      4781:  # role and realm
1.378     raeburn  4782:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4783:     if ($role  eq 'ca') {
1.479     albertel 4784:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4785:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4786:     } 
1.55      www      4787: # realm
1.258     albertel 4788:     if ($env{'request.course.id'}) {
1.378     raeburn  4789:         if ($env{'request.role'} !~ /^cr/) {
                   4790:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4791:         }
1.898     raeburn  4792:         if ($env{'request.course.sec'}) {
                   4793:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   4794:         }   
1.359     albertel 4795: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4796:     } else {
                   4797:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4798:     }
1.433     albertel 4799: 
1.359     albertel 4800:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 4801: 
1.438     albertel 4802:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4803: 
1.101     www      4804: # construct main body tag
1.359     albertel 4805:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4806: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4807: 
1.530     albertel 4808:     if ($bodyonly) {
1.60      matthew  4809:         return $bodytag;
1.798     tempelho 4810:     } 
1.359     albertel 4811: 
1.410     albertel 4812:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954     raeburn  4813:     if ($public) {
1.433     albertel 4814: 	undef($role);
1.434     albertel 4815:     } else {
                   4816: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4817:     }
1.359     albertel 4818:     
1.762     bisitz   4819:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4820:     #
                   4821:     # Extra info if you are the DC
                   4822:     my $dc_info = '';
                   4823:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4824:                         $env{'course.'.$env{'request.course.id'}.
                   4825:                                  '.domain'}.'/'})) {
                   4826:         my $cid = $env{'request.course.id'};
1.917     raeburn  4827:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4828:         $dc_info =~ s/\s+$//;
1.359     albertel 4829:     }
                   4830: 
1.898     raeburn  4831:     $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853     droeschl 4832:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   4833: 
1.916     droeschl 4834:         if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') { 
                   4835:             return $bodytag; 
                   4836:         } 
1.903     droeschl 4837: 
                   4838:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   4839: 
                   4840:         #    if ($env{'request.state'} eq 'construct') {
                   4841:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4842:         #    }
                   4843: 
1.359     albertel 4844: 
                   4845: 
1.916     droeschl 4846:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917     raeburn  4847:              if ($dc_info) {
                   4848:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   4849:              }
1.916     droeschl 4850:              $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   4851:                 <em>$realm</em> $dc_info</div>|;
1.903     droeschl 4852:             return $bodytag;
                   4853:         }
1.894     droeschl 4854: 
1.927     raeburn  4855:         unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
                   4856:             $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
                   4857:         }
1.916     droeschl 4858: 
1.903     droeschl 4859:         $bodytag .= Apache::lonhtmlcommon::scripttag(
                   4860:             Apache::lonmenu::utilityfunctions(), 'start');
1.816     bisitz   4861: 
1.903     droeschl 4862:         $bodytag .= Apache::lonmenu::primary_menu();
1.852     droeschl 4863: 
1.917     raeburn  4864:         if ($dc_info) {
                   4865:             $dc_info = &dc_courseid_toggle($dc_info);
                   4866:         }
                   4867:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 4868: 
1.903     droeschl 4869:         #don't show menus for public users
1.954     raeburn  4870:         if (!$public){
1.903     droeschl 4871:             $bodytag .= Apache::lonmenu::secondary_menu();
                   4872:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  4873:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   4874:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 4875:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920     raeburn  4876:                                 $args->{'bread_crumbs'});
                   4877:             } elsif ($forcereg) { 
                   4878:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg);
                   4879:             }
1.903     droeschl 4880:         }else{
                   4881:             # this is to seperate menu from content when there's no secondary
                   4882:             # menu. Especially needed for public accessible ressources.
                   4883:             $bodytag .= '<hr style="clear:both" />';
                   4884:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  4885:         }
1.903     droeschl 4886: 
1.235     raeburn  4887:         return $bodytag;
1.182     matthew  4888: }
                   4889: 
1.917     raeburn  4890: sub dc_courseid_toggle {
                   4891:     my ($dc_info) = @_;
1.980     raeburn  4892:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.917     raeburn  4893:            '<a href="javascript:showCourseID();">'.
                   4894:            &mt('(More ...)').'</a></span>'.
                   4895:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   4896: }
                   4897: 
1.330     albertel 4898: sub make_attr_string {
                   4899:     my ($register,$attr_ref) = @_;
                   4900: 
                   4901:     if ($attr_ref && !ref($attr_ref)) {
                   4902: 	die("addentries Must be a hash ref ".
                   4903: 	    join(':',caller(1))." ".
                   4904: 	    join(':',caller(0))." ");
                   4905:     }
                   4906: 
                   4907:     if ($register) {
1.339     albertel 4908: 	my ($on_load,$on_unload);
                   4909: 	foreach my $key (keys(%{$attr_ref})) {
                   4910: 	    if      (lc($key) eq 'onload') {
                   4911: 		$on_load.=$attr_ref->{$key}.';';
                   4912: 		delete($attr_ref->{$key});
                   4913: 
                   4914: 	    } elsif (lc($key) eq 'onunload') {
                   4915: 		$on_unload.=$attr_ref->{$key}.';';
                   4916: 		delete($attr_ref->{$key});
                   4917: 	    }
                   4918: 	}
1.953     droeschl 4919: 	$attr_ref->{'onload'}  = $on_load;
                   4920: 	$attr_ref->{'onunload'}= $on_unload;
1.330     albertel 4921:     }
1.339     albertel 4922: 
1.330     albertel 4923:     my $attr_string;
                   4924:     foreach my $attr (keys(%$attr_ref)) {
                   4925: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4926:     }
                   4927:     return $attr_string;
                   4928: }
                   4929: 
                   4930: 
1.182     matthew  4931: ###############################################
1.251     albertel 4932: ###############################################
                   4933: 
                   4934: =pod
                   4935: 
                   4936: =item * &endbodytag()
                   4937: 
                   4938: Returns a uniform footer for LON-CAPA web pages.
                   4939: 
1.635     raeburn  4940: Inputs: 1 - optional reference to an args hash
                   4941: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4942: a 'Continue' link is not displayed if the page contains an
                   4943: internal redirect in the <head></head> section,
                   4944: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4945: 
                   4946: =cut
                   4947: 
                   4948: sub endbodytag {
1.635     raeburn  4949:     my ($args) = @_;
1.251     albertel 4950:     my $endbodytag='</body>';
1.269     albertel 4951:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4952:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4953:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4954: 	    $endbodytag=
                   4955: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4956: 	        &mt('Continue').'</a>'.
                   4957: 	        $endbodytag;
                   4958:         }
1.315     albertel 4959:     }
1.251     albertel 4960:     return $endbodytag;
                   4961: }
                   4962: 
1.352     albertel 4963: =pod
                   4964: 
                   4965: =item * &standard_css()
                   4966: 
                   4967: Returns a style sheet
                   4968: 
                   4969: Inputs: (all optional)
                   4970:             domain         -> force to color decorate a page for a specific
                   4971:                                domain
                   4972:             function       -> force usage of a specific rolish color scheme
                   4973:             bgcolor        -> override the default page bgcolor
                   4974: 
                   4975: =cut
                   4976: 
1.343     albertel 4977: sub standard_css {
1.345     albertel 4978:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4979:     $function  = &get_users_function() if (!$function);
                   4980:     my $img    = &designparm($function.'.img',   $domain);
                   4981:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4982:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4983:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4984: #second colour for later usage
1.345     albertel 4985:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4986:     my $pgbg_or_bgcolor =
                   4987: 	         $bgcolor ||
1.352     albertel 4988: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4989:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4990:     my $alink  = &designparm($function.'.alink', $domain);
                   4991:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4992:     my $link   = &designparm($function.'.link',  $domain);
                   4993: 
1.602     albertel 4994:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4995:     my $mono                 = 'monospace';
1.850     bisitz   4996:     my $data_table_head      = $sidebg;
                   4997:     my $data_table_light     = '#FAFAFA';
                   4998:     my $data_table_dark      = '#F0F0F0';
1.470     banghart 4999:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 5000:     my $data_table_highlight = '#FFFF00';
1.352     albertel 5001:     my $mail_new             = '#FFBB77';
                   5002:     my $mail_new_hover       = '#DD9955';
                   5003:     my $mail_read            = '#BBBB77';
                   5004:     my $mail_read_hover      = '#999944';
                   5005:     my $mail_replied         = '#AAAA88';
                   5006:     my $mail_replied_hover   = '#888855';
                   5007:     my $mail_other           = '#99BBBB';
                   5008:     my $mail_other_hover     = '#669999';
1.391     albertel 5009:     my $table_header         = '#DDDDDD';
1.489     raeburn  5010:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   5011:     my $lg_border_color      = '#C8C8C8';
1.952     onken    5012:     my $button_hover         = '#BF2317';
1.392     albertel 5013: 
1.608     albertel 5014:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   5015:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   5016:                                              : '0 3px 0 4px';
1.448     albertel 5017: 
1.523     albertel 5018: 
1.343     albertel 5019:     return <<END;
1.947     droeschl 5020: 
                   5021: /* needed for iframe to allow 100% height in FF */
                   5022: body, html { 
                   5023:     margin: 0;
                   5024:     padding: 0 0.5%;
                   5025:     height: 99%; /* to avoid scrollbars */
                   5026: }
                   5027: 
1.795     www      5028: body {
1.911     bisitz   5029:   font-family: $sans;
                   5030:   line-height:130%;
                   5031:   font-size:0.83em;
                   5032:   color:$font;
1.795     www      5033: }
                   5034: 
1.959     onken    5035: a:focus,
                   5036: a:focus img {
1.795     www      5037:   color: red;
                   5038: }
1.698     harmsja  5039: 
1.911     bisitz   5040: form, .inline {
                   5041:   display: inline;
1.795     www      5042: }
1.721     harmsja  5043: 
1.795     www      5044: .LC_right {
1.911     bisitz   5045:   text-align:right;
1.795     www      5046: }
                   5047: 
                   5048: .LC_middle {
1.911     bisitz   5049:   vertical-align:middle;
1.795     www      5050: }
1.721     harmsja  5051: 
1.911     bisitz   5052: .LC_400Box {
                   5053:   width:400px;
                   5054: }
1.721     harmsja  5055: 
1.947     droeschl 5056: .LC_iframecontainer {
                   5057:     width: 98%;
                   5058:     margin: 0;
                   5059:     position: fixed;
                   5060:     top: 8.5em;
                   5061:     bottom: 0;
                   5062: }
                   5063: 
                   5064: .LC_iframecontainer iframe{
                   5065:     border: none;
                   5066:     width: 100%;
                   5067:     height: 100%;
                   5068: }
                   5069: 
1.778     bisitz   5070: .LC_filename {
                   5071:   font-family: $mono;
                   5072:   white-space:pre;
1.921     bisitz   5073:   font-size: 120%;
1.778     bisitz   5074: }
                   5075: 
                   5076: .LC_fileicon {
                   5077:   border: none;
                   5078:   height: 1.3em;
                   5079:   vertical-align: text-bottom;
                   5080:   margin-right: 0.3em;
                   5081:   text-decoration:none;
                   5082: }
                   5083: 
1.1008    www      5084: .LC_setting {
                   5085:   text-decoration:underline;
                   5086: }
                   5087: 
1.350     albertel 5088: .LC_error {
                   5089:   color: red;
                   5090:   font-size: larger;
                   5091: }
1.795     www      5092: 
1.457     albertel 5093: .LC_warning,
                   5094: .LC_diff_removed {
1.733     bisitz   5095:   color: red;
1.394     albertel 5096: }
1.532     albertel 5097: 
                   5098: .LC_info,
1.457     albertel 5099: .LC_success,
                   5100: .LC_diff_added {
1.350     albertel 5101:   color: green;
                   5102: }
1.795     www      5103: 
1.802     bisitz   5104: div.LC_confirm_box {
                   5105:   background-color: #FAFAFA;
                   5106:   border: 1px solid $lg_border_color;
                   5107:   margin-right: 0;
                   5108:   padding: 5px;
                   5109: }
                   5110: 
                   5111: div.LC_confirm_box .LC_error img,
                   5112: div.LC_confirm_box .LC_success img {
                   5113:   vertical-align: middle;
                   5114: }
                   5115: 
1.440     albertel 5116: .LC_icon {
1.771     droeschl 5117:   border: none;
1.790     droeschl 5118:   vertical-align: middle;
1.771     droeschl 5119: }
                   5120: 
1.543     albertel 5121: .LC_docs_spacer {
                   5122:   width: 25px;
                   5123:   height: 1px;
1.771     droeschl 5124:   border: none;
1.543     albertel 5125: }
1.346     albertel 5126: 
1.532     albertel 5127: .LC_internal_info {
1.735     bisitz   5128:   color: #999999;
1.532     albertel 5129: }
                   5130: 
1.794     www      5131: .LC_discussion {
1.1050    www      5132:   background: $data_table_dark;
1.911     bisitz   5133:   border: 1px solid black;
                   5134:   margin: 2px;
1.794     www      5135: }
                   5136: 
                   5137: .LC_disc_action_left {
1.1050    www      5138:   background: $sidebg;
1.911     bisitz   5139:   text-align: left;
1.1050    www      5140:   padding: 4px;
                   5141:   margin: 2px;
1.794     www      5142: }
                   5143: 
                   5144: .LC_disc_action_right {
1.1050    www      5145:   background: $sidebg;
1.911     bisitz   5146:   text-align: right;
1.1050    www      5147:   padding: 4px;
                   5148:   margin: 2px;
1.794     www      5149: }
                   5150: 
                   5151: .LC_disc_new_item {
1.911     bisitz   5152:   background: white;
                   5153:   border: 2px solid red;
1.1050    www      5154:   margin: 4px;
                   5155:   padding: 4px;
1.794     www      5156: }
                   5157: 
                   5158: .LC_disc_old_item {
1.911     bisitz   5159:   background: white;
1.1050    www      5160:   margin: 4px;
                   5161:   padding: 4px;
1.794     www      5162: }
                   5163: 
1.458     albertel 5164: table.LC_pastsubmission {
                   5165:   border: 1px solid black;
                   5166:   margin: 2px;
                   5167: }
                   5168: 
1.924     bisitz   5169: table#LC_menubuttons {
1.345     albertel 5170:   width: 100%;
                   5171:   background: $pgbg;
1.392     albertel 5172:   border: 2px;
1.402     albertel 5173:   border-collapse: separate;
1.803     bisitz   5174:   padding: 0;
1.345     albertel 5175: }
1.392     albertel 5176: 
1.801     tempelho 5177: table#LC_title_bar a {
                   5178:   color: $fontmenu;
                   5179: }
1.836     bisitz   5180: 
1.807     droeschl 5181: table#LC_title_bar {
1.819     tempelho 5182:   clear: both;
1.836     bisitz   5183:   display: none;
1.807     droeschl 5184: }
                   5185: 
1.795     www      5186: table#LC_title_bar,
1.933     droeschl 5187: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 5188: table#LC_title_bar.LC_with_remote {
1.359     albertel 5189:   width: 100%;
1.392     albertel 5190:   border-color: $pgbg;
                   5191:   border-style: solid;
                   5192:   border-width: $border;
1.379     albertel 5193:   background: $pgbg;
1.801     tempelho 5194:   color: $fontmenu;
1.392     albertel 5195:   border-collapse: collapse;
1.803     bisitz   5196:   padding: 0;
1.819     tempelho 5197:   margin: 0;
1.359     albertel 5198: }
1.795     www      5199: 
1.933     droeschl 5200: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 5201:     margin: 0;
                   5202:     padding: 0;
1.933     droeschl 5203:     position: relative;
                   5204:     list-style: none;
1.913     droeschl 5205: }
1.933     droeschl 5206: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 5207:     display: inline;
                   5208: }
1.933     droeschl 5209: 
                   5210: .LC_breadcrumb_tools_navigation {
1.913     droeschl 5211:     padding: 0;
1.933     droeschl 5212:     margin: 0;
                   5213:     float: left;
1.913     droeschl 5214: }
1.933     droeschl 5215: .LC_breadcrumb_tools_tools {
                   5216:     padding: 0;
                   5217:     margin: 0;
1.913     droeschl 5218:     float: right;
                   5219: }
                   5220: 
1.359     albertel 5221: table#LC_title_bar td {
                   5222:   background: $tabbg;
                   5223: }
1.795     www      5224: 
1.911     bisitz   5225: table#LC_menubuttons img {
1.803     bisitz   5226:   border: none;
1.346     albertel 5227: }
1.795     www      5228: 
1.842     droeschl 5229: .LC_breadcrumbs_component {
1.911     bisitz   5230:   float: right;
                   5231:   margin: 0 1em;
1.357     albertel 5232: }
1.842     droeschl 5233: .LC_breadcrumbs_component img {
1.911     bisitz   5234:   vertical-align: middle;
1.777     tempelho 5235: }
1.795     www      5236: 
1.383     albertel 5237: td.LC_table_cell_checkbox {
                   5238:   text-align: center;
                   5239: }
1.795     www      5240: 
                   5241: .LC_fontsize_small {
1.911     bisitz   5242:   font-size: 70%;
1.705     tempelho 5243: }
                   5244: 
1.844     bisitz   5245: #LC_breadcrumbs {
1.911     bisitz   5246:   clear:both;
                   5247:   background: $sidebg;
                   5248:   border-bottom: 1px solid $lg_border_color;
                   5249:   line-height: 2.5em;
1.933     droeschl 5250:   overflow: hidden;
1.911     bisitz   5251:   margin: 0;
                   5252:   padding: 0;
1.995     raeburn  5253:   text-align: left;
1.819     tempelho 5254: }
1.862     bisitz   5255: 
1.993     raeburn  5256: .LC_head_subbox {
1.911     bisitz   5257:   clear:both;
                   5258:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 5259:   border: 1px solid $sidebg;
                   5260:   margin: 0 0 10px 0;      
1.966     bisitz   5261:   padding: 3px;
1.995     raeburn  5262:   text-align: left;
1.822     bisitz   5263: }
                   5264: 
1.795     www      5265: .LC_fontsize_medium {
1.911     bisitz   5266:   font-size: 85%;
1.705     tempelho 5267: }
                   5268: 
1.795     www      5269: .LC_fontsize_large {
1.911     bisitz   5270:   font-size: 120%;
1.705     tempelho 5271: }
                   5272: 
1.346     albertel 5273: .LC_menubuttons_inline_text {
                   5274:   color: $font;
1.698     harmsja  5275:   font-size: 90%;
1.701     harmsja  5276:   padding-left:3px;
1.346     albertel 5277: }
                   5278: 
1.934     droeschl 5279: .LC_menubuttons_inline_text img{
                   5280:   vertical-align: middle;
                   5281: }
                   5282: 
1.1051    www      5283: li.LC_menubuttons_inline_text img {
1.951     onken    5284:   cursor:pointer;
1.1002    droeschl 5285:   text-decoration: none;
1.951     onken    5286: }
                   5287: 
1.526     www      5288: .LC_menubuttons_link {
                   5289:   text-decoration: none;
                   5290: }
1.795     www      5291: 
1.522     albertel 5292: .LC_menubuttons_category {
1.521     www      5293:   color: $font;
1.526     www      5294:   background: $pgbg;
1.521     www      5295:   font-size: larger;
                   5296:   font-weight: bold;
                   5297: }
                   5298: 
1.346     albertel 5299: td.LC_menubuttons_text {
1.911     bisitz   5300:   color: $font;
1.346     albertel 5301: }
1.706     harmsja  5302: 
1.346     albertel 5303: .LC_current_location {
                   5304:   background: $tabbg;
                   5305: }
1.795     www      5306: 
1.938     bisitz   5307: table.LC_data_table {
1.347     albertel 5308:   border: 1px solid #000000;
1.402     albertel 5309:   border-collapse: separate;
1.426     albertel 5310:   border-spacing: 1px;
1.610     albertel 5311:   background: $pgbg;
1.347     albertel 5312: }
1.795     www      5313: 
1.422     albertel 5314: .LC_data_table_dense {
                   5315:   font-size: small;
                   5316: }
1.795     www      5317: 
1.507     raeburn  5318: table.LC_nested_outer {
                   5319:   border: 1px solid #000000;
1.589     raeburn  5320:   border-collapse: collapse;
1.803     bisitz   5321:   border-spacing: 0;
1.507     raeburn  5322:   width: 100%;
                   5323: }
1.795     www      5324: 
1.879     raeburn  5325: table.LC_innerpickbox,
1.507     raeburn  5326: table.LC_nested {
1.803     bisitz   5327:   border: none;
1.589     raeburn  5328:   border-collapse: collapse;
1.803     bisitz   5329:   border-spacing: 0;
1.507     raeburn  5330:   width: 100%;
                   5331: }
1.795     www      5332: 
1.911     bisitz   5333: table.LC_data_table tr th,
                   5334: table.LC_calendar tr th,
1.879     raeburn  5335: table.LC_prior_tries tr th,
                   5336: table.LC_innerpickbox tr th {
1.349     albertel 5337:   font-weight: bold;
                   5338:   background-color: $data_table_head;
1.801     tempelho 5339:   color:$fontmenu;
1.701     harmsja  5340:   font-size:90%;
1.347     albertel 5341: }
1.795     www      5342: 
1.879     raeburn  5343: table.LC_innerpickbox tr th,
                   5344: table.LC_innerpickbox tr td {
                   5345:   vertical-align: top;
                   5346: }
                   5347: 
1.711     raeburn  5348: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   5349:   background-color: #CCCCCC;
1.711     raeburn  5350:   font-weight: bold;
                   5351:   text-align: left;
                   5352: }
1.795     www      5353: 
1.912     bisitz   5354: table.LC_data_table tr.LC_odd_row > td {
                   5355:   background-color: $data_table_light;
                   5356:   padding: 2px;
                   5357:   vertical-align: top;
                   5358: }
                   5359: 
1.809     bisitz   5360: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 5361:   background-color: $data_table_light;
1.912     bisitz   5362:   vertical-align: top;
                   5363: }
                   5364: 
                   5365: table.LC_data_table tr.LC_even_row > td {
                   5366:   background-color: $data_table_dark;
1.425     albertel 5367:   padding: 2px;
1.900     bisitz   5368:   vertical-align: top;
1.347     albertel 5369: }
1.795     www      5370: 
1.809     bisitz   5371: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5372:   background-color: $data_table_dark;
1.900     bisitz   5373:   vertical-align: top;
1.347     albertel 5374: }
1.795     www      5375: 
1.425     albertel 5376: table.LC_data_table tr.LC_data_table_highlight td {
                   5377:   background-color: $data_table_darker;
                   5378: }
1.795     www      5379: 
1.639     raeburn  5380: table.LC_data_table tr td.LC_leftcol_header {
                   5381:   background-color: $data_table_head;
                   5382:   font-weight: bold;
                   5383: }
1.795     www      5384: 
1.451     albertel 5385: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5386: table.LC_nested tr.LC_empty_row td {
1.421     albertel 5387:   font-weight: bold;
                   5388:   font-style: italic;
                   5389:   text-align: center;
                   5390:   padding: 8px;
1.347     albertel 5391: }
1.795     www      5392: 
1.940     bisitz   5393: table.LC_data_table tr.LC_empty_row td {
                   5394:   background-color: $sidebg;
                   5395: }
                   5396: 
                   5397: table.LC_nested tr.LC_empty_row td {
                   5398:   background-color: #FFFFFF;
                   5399: }
                   5400: 
1.890     droeschl 5401: table.LC_caption {
                   5402: }
                   5403: 
1.507     raeburn  5404: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5405:   padding: 4ex
                   5406: }
1.795     www      5407: 
1.507     raeburn  5408: table.LC_nested_outer tr th {
                   5409:   font-weight: bold;
1.801     tempelho 5410:   color:$fontmenu;
1.507     raeburn  5411:   background-color: $data_table_head;
1.701     harmsja  5412:   font-size: small;
1.507     raeburn  5413:   border-bottom: 1px solid #000000;
                   5414: }
1.795     www      5415: 
1.507     raeburn  5416: table.LC_nested_outer tr td.LC_subheader {
                   5417:   background-color: $data_table_head;
                   5418:   font-weight: bold;
                   5419:   font-size: small;
                   5420:   border-bottom: 1px solid #000000;
                   5421:   text-align: right;
1.451     albertel 5422: }
1.795     www      5423: 
1.507     raeburn  5424: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5425:   background-color: #CCCCCC;
1.451     albertel 5426:   font-weight: bold;
                   5427:   font-size: small;
1.507     raeburn  5428:   text-align: center;
                   5429: }
1.795     www      5430: 
1.589     raeburn  5431: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5432: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5433:   text-align: left;
1.451     albertel 5434: }
1.795     www      5435: 
1.507     raeburn  5436: table.LC_nested td {
1.735     bisitz   5437:   background-color: #FFFFFF;
1.451     albertel 5438:   font-size: small;
1.507     raeburn  5439: }
1.795     www      5440: 
1.507     raeburn  5441: table.LC_nested_outer tr th.LC_right_item,
                   5442: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5443: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5444: table.LC_nested tr td.LC_right_item {
1.451     albertel 5445:   text-align: right;
                   5446: }
                   5447: 
1.507     raeburn  5448: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5449:   background-color: #EEEEEE;
1.451     albertel 5450: }
                   5451: 
1.473     raeburn  5452: table.LC_createuser {
                   5453: }
                   5454: 
                   5455: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5456:   font-size: small;
1.473     raeburn  5457: }
                   5458: 
                   5459: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5460:   background-color: #CCCCCC;
1.473     raeburn  5461:   font-weight: bold;
                   5462:   text-align: center;
                   5463: }
                   5464: 
1.349     albertel 5465: table.LC_calendar {
                   5466:   border: 1px solid #000000;
                   5467:   border-collapse: collapse;
1.917     raeburn  5468:   width: 98%;
1.349     albertel 5469: }
1.795     www      5470: 
1.349     albertel 5471: table.LC_calendar_pickdate {
                   5472:   font-size: xx-small;
                   5473: }
1.795     www      5474: 
1.349     albertel 5475: table.LC_calendar tr td {
                   5476:   border: 1px solid #000000;
                   5477:   vertical-align: top;
1.917     raeburn  5478:   width: 14%;
1.349     albertel 5479: }
1.795     www      5480: 
1.349     albertel 5481: table.LC_calendar tr td.LC_calendar_day_empty {
                   5482:   background-color: $data_table_dark;
                   5483: }
1.795     www      5484: 
1.779     bisitz   5485: table.LC_calendar tr td.LC_calendar_day_current {
                   5486:   background-color: $data_table_highlight;
1.777     tempelho 5487: }
1.795     www      5488: 
1.938     bisitz   5489: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 5490:   background-color: $mail_new;
                   5491: }
1.795     www      5492: 
1.938     bisitz   5493: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 5494:   background-color: $mail_new_hover;
                   5495: }
1.795     www      5496: 
1.938     bisitz   5497: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 5498:   background-color: $mail_read;
                   5499: }
1.795     www      5500: 
1.938     bisitz   5501: /*
                   5502: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 5503:   background-color: $mail_read_hover;
                   5504: }
1.938     bisitz   5505: */
1.795     www      5506: 
1.938     bisitz   5507: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 5508:   background-color: $mail_replied;
                   5509: }
1.795     www      5510: 
1.938     bisitz   5511: /*
                   5512: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 5513:   background-color: $mail_replied_hover;
                   5514: }
1.938     bisitz   5515: */
1.795     www      5516: 
1.938     bisitz   5517: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 5518:   background-color: $mail_other;
                   5519: }
1.795     www      5520: 
1.938     bisitz   5521: /*
                   5522: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 5523:   background-color: $mail_other_hover;
                   5524: }
1.938     bisitz   5525: */
1.494     raeburn  5526: 
1.777     tempelho 5527: table.LC_data_table tr > td.LC_browser_file,
                   5528: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5529:   background: #AAEE77;
1.389     albertel 5530: }
1.795     www      5531: 
1.777     tempelho 5532: table.LC_data_table tr > td.LC_browser_file_locked,
                   5533: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5534:   background: #FFAA99;
1.387     albertel 5535: }
1.795     www      5536: 
1.777     tempelho 5537: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5538:   background: #888888;
1.779     bisitz   5539: }
1.795     www      5540: 
1.777     tempelho 5541: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5542: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5543:   background: #F8F866;
1.777     tempelho 5544: }
1.795     www      5545: 
1.696     bisitz   5546: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5547:   background: #E0E8FF;
1.387     albertel 5548: }
1.696     bisitz   5549: 
1.707     bisitz   5550: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   5551:   /* background: #77FF77; */
1.707     bisitz   5552: }
1.795     www      5553: 
1.707     bisitz   5554: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   5555:   border-right: 8px solid #FFFF77;
1.707     bisitz   5556: }
1.795     www      5557: 
1.707     bisitz   5558: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   5559:   border-right: 8px solid #FFAA77;
1.707     bisitz   5560: }
1.795     www      5561: 
1.707     bisitz   5562: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   5563:   border-right: 8px solid #FF7777;
1.707     bisitz   5564: }
1.795     www      5565: 
1.707     bisitz   5566: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   5567:   border-right: 8px solid #AAFF77;
1.707     bisitz   5568: }
1.795     www      5569: 
1.707     bisitz   5570: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   5571:   border-right: 8px solid #11CC55;
1.707     bisitz   5572: }
                   5573: 
1.388     albertel 5574: span.LC_current_location {
1.701     harmsja  5575:   font-size:larger;
1.388     albertel 5576:   background: $pgbg;
                   5577: }
1.387     albertel 5578: 
1.1029    www      5579: span.LC_current_nav_location {
                   5580:   font-weight:bold;
                   5581:   background: $sidebg;
                   5582: }
                   5583: 
1.395     albertel 5584: span.LC_parm_menu_item {
                   5585:   font-size: larger;
                   5586: }
1.795     www      5587: 
1.395     albertel 5588: span.LC_parm_scope_all {
                   5589:   color: red;
                   5590: }
1.795     www      5591: 
1.395     albertel 5592: span.LC_parm_scope_folder {
                   5593:   color: green;
                   5594: }
1.795     www      5595: 
1.395     albertel 5596: span.LC_parm_scope_resource {
                   5597:   color: orange;
                   5598: }
1.795     www      5599: 
1.395     albertel 5600: span.LC_parm_part {
                   5601:   color: blue;
                   5602: }
1.795     www      5603: 
1.911     bisitz   5604: span.LC_parm_folder,
                   5605: span.LC_parm_symb {
1.395     albertel 5606:   font-size: x-small;
                   5607:   font-family: $mono;
                   5608:   color: #AAAAAA;
                   5609: }
                   5610: 
1.977     bisitz   5611: ul.LC_parm_parmlist li {
                   5612:   display: inline-block;
                   5613:   padding: 0.3em 0.8em;
                   5614:   vertical-align: top;
                   5615:   width: 150px;
                   5616:   border-top:1px solid $lg_border_color;
                   5617: }
                   5618: 
1.795     www      5619: td.LC_parm_overview_level_menu,
                   5620: td.LC_parm_overview_map_menu,
                   5621: td.LC_parm_overview_parm_selectors,
                   5622: td.LC_parm_overview_restrictions  {
1.396     albertel 5623:   border: 1px solid black;
                   5624:   border-collapse: collapse;
                   5625: }
1.795     www      5626: 
1.396     albertel 5627: table.LC_parm_overview_restrictions td {
                   5628:   border-width: 1px 4px 1px 4px;
                   5629:   border-style: solid;
                   5630:   border-color: $pgbg;
                   5631:   text-align: center;
                   5632: }
1.795     www      5633: 
1.396     albertel 5634: table.LC_parm_overview_restrictions th {
                   5635:   background: $tabbg;
                   5636:   border-width: 1px 4px 1px 4px;
                   5637:   border-style: solid;
                   5638:   border-color: $pgbg;
                   5639: }
1.795     www      5640: 
1.398     albertel 5641: table#LC_helpmenu {
1.803     bisitz   5642:   border: none;
1.398     albertel 5643:   height: 55px;
1.803     bisitz   5644:   border-spacing: 0;
1.398     albertel 5645: }
                   5646: 
                   5647: table#LC_helpmenu fieldset legend {
                   5648:   font-size: larger;
                   5649: }
1.795     www      5650: 
1.397     albertel 5651: table#LC_helpmenu_links {
                   5652:   width: 100%;
                   5653:   border: 1px solid black;
                   5654:   background: $pgbg;
1.803     bisitz   5655:   padding: 0;
1.397     albertel 5656:   border-spacing: 1px;
                   5657: }
1.795     www      5658: 
1.397     albertel 5659: table#LC_helpmenu_links tr td {
                   5660:   padding: 1px;
                   5661:   background: $tabbg;
1.399     albertel 5662:   text-align: center;
                   5663:   font-weight: bold;
1.397     albertel 5664: }
1.396     albertel 5665: 
1.795     www      5666: table#LC_helpmenu_links a:link,
                   5667: table#LC_helpmenu_links a:visited,
1.397     albertel 5668: table#LC_helpmenu_links a:active {
                   5669:   text-decoration: none;
                   5670:   color: $font;
                   5671: }
1.795     www      5672: 
1.397     albertel 5673: table#LC_helpmenu_links a:hover {
                   5674:   text-decoration: underline;
                   5675:   color: $vlink;
                   5676: }
1.396     albertel 5677: 
1.417     albertel 5678: .LC_chrt_popup_exists {
                   5679:   border: 1px solid #339933;
                   5680:   margin: -1px;
                   5681: }
1.795     www      5682: 
1.417     albertel 5683: .LC_chrt_popup_up {
                   5684:   border: 1px solid yellow;
                   5685:   margin: -1px;
                   5686: }
1.795     www      5687: 
1.417     albertel 5688: .LC_chrt_popup {
                   5689:   border: 1px solid #8888FF;
                   5690:   background: #CCCCFF;
                   5691: }
1.795     www      5692: 
1.421     albertel 5693: table.LC_pick_box {
                   5694:   border-collapse: separate;
                   5695:   background: white;
                   5696:   border: 1px solid black;
                   5697:   border-spacing: 1px;
                   5698: }
1.795     www      5699: 
1.421     albertel 5700: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5701:   background: $sidebg;
1.421     albertel 5702:   font-weight: bold;
1.900     bisitz   5703:   text-align: left;
1.740     bisitz   5704:   vertical-align: top;
1.421     albertel 5705:   width: 184px;
                   5706:   padding: 8px;
                   5707: }
1.795     www      5708: 
1.579     raeburn  5709: table.LC_pick_box td.LC_pick_box_value {
                   5710:   text-align: left;
                   5711:   padding: 8px;
                   5712: }
1.795     www      5713: 
1.579     raeburn  5714: table.LC_pick_box td.LC_pick_box_select {
                   5715:   text-align: left;
                   5716:   padding: 8px;
                   5717: }
1.795     www      5718: 
1.424     albertel 5719: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5720:   padding: 0;
1.421     albertel 5721:   height: 1px;
                   5722:   background: black;
                   5723: }
1.795     www      5724: 
1.421     albertel 5725: table.LC_pick_box td.LC_pick_box_submit {
                   5726:   text-align: right;
                   5727: }
1.795     www      5728: 
1.579     raeburn  5729: table.LC_pick_box td.LC_evenrow_value {
                   5730:   text-align: left;
                   5731:   padding: 8px;
                   5732:   background-color: $data_table_light;
                   5733: }
1.795     www      5734: 
1.579     raeburn  5735: table.LC_pick_box td.LC_oddrow_value {
                   5736:   text-align: left;
                   5737:   padding: 8px;
                   5738:   background-color: $data_table_light;
                   5739: }
1.795     www      5740: 
1.579     raeburn  5741: span.LC_helpform_receipt_cat {
                   5742:   font-weight: bold;
                   5743: }
1.795     www      5744: 
1.424     albertel 5745: table.LC_group_priv_box {
                   5746:   background: white;
                   5747:   border: 1px solid black;
                   5748:   border-spacing: 1px;
                   5749: }
1.795     www      5750: 
1.424     albertel 5751: table.LC_group_priv_box td.LC_pick_box_title {
                   5752:   background: $tabbg;
                   5753:   font-weight: bold;
                   5754:   text-align: right;
                   5755:   width: 184px;
                   5756: }
1.795     www      5757: 
1.424     albertel 5758: table.LC_group_priv_box td.LC_groups_fixed {
                   5759:   background: $data_table_light;
                   5760:   text-align: center;
                   5761: }
1.795     www      5762: 
1.424     albertel 5763: table.LC_group_priv_box td.LC_groups_optional {
                   5764:   background: $data_table_dark;
                   5765:   text-align: center;
                   5766: }
1.795     www      5767: 
1.424     albertel 5768: table.LC_group_priv_box td.LC_groups_functionality {
                   5769:   background: $data_table_darker;
                   5770:   text-align: center;
                   5771:   font-weight: bold;
                   5772: }
1.795     www      5773: 
1.424     albertel 5774: table.LC_group_priv td {
                   5775:   text-align: left;
1.803     bisitz   5776:   padding: 0;
1.424     albertel 5777: }
                   5778: 
                   5779: .LC_navbuttons {
                   5780:   margin: 2ex 0ex 2ex 0ex;
                   5781: }
1.795     www      5782: 
1.423     albertel 5783: .LC_topic_bar {
                   5784:   font-weight: bold;
                   5785:   background: $tabbg;
1.918     wenzelju 5786:   margin: 1em 0em 1em 2em;
1.805     bisitz   5787:   padding: 3px;
1.918     wenzelju 5788:   font-size: 1.2em;
1.423     albertel 5789: }
1.795     www      5790: 
1.423     albertel 5791: .LC_topic_bar span {
1.918     wenzelju 5792:   left: 0.5em;
                   5793:   position: absolute;
1.423     albertel 5794:   vertical-align: middle;
1.918     wenzelju 5795:   font-size: 1.2em;
1.423     albertel 5796: }
1.795     www      5797: 
1.423     albertel 5798: table.LC_course_group_status {
                   5799:   margin: 20px;
                   5800: }
1.795     www      5801: 
1.423     albertel 5802: table.LC_status_selector td {
                   5803:   vertical-align: top;
                   5804:   text-align: center;
1.424     albertel 5805:   padding: 4px;
                   5806: }
1.795     www      5807: 
1.599     albertel 5808: div.LC_feedback_link {
1.616     albertel 5809:   clear: both;
1.829     kalberla 5810:   background: $sidebg;
1.779     bisitz   5811:   width: 100%;
1.829     kalberla 5812:   padding-bottom: 10px;
                   5813:   border: 1px $tabbg solid;
1.833     kalberla 5814:   height: 22px;
                   5815:   line-height: 22px;
                   5816:   padding-top: 5px;
                   5817: }
                   5818: 
                   5819: div.LC_feedback_link img {
                   5820:   height: 22px;
1.867     kalberla 5821:   vertical-align:middle;
1.829     kalberla 5822: }
                   5823: 
1.911     bisitz   5824: div.LC_feedback_link a {
1.829     kalberla 5825:   text-decoration: none;
1.489     raeburn  5826: }
1.795     www      5827: 
1.867     kalberla 5828: div.LC_comblock {
1.911     bisitz   5829:   display:inline;
1.867     kalberla 5830:   color:$font;
                   5831:   font-size:90%;
                   5832: }
                   5833: 
                   5834: div.LC_feedback_link div.LC_comblock {
                   5835:   padding-left:5px;
                   5836: }
                   5837: 
                   5838: div.LC_feedback_link div.LC_comblock a {
                   5839:   color:$font;
                   5840: }
                   5841: 
1.489     raeburn  5842: span.LC_feedback_link {
1.858     bisitz   5843:   /* background: $feedback_link_bg; */
1.599     albertel 5844:   font-size: larger;
                   5845: }
1.795     www      5846: 
1.599     albertel 5847: span.LC_message_link {
1.858     bisitz   5848:   /* background: $feedback_link_bg; */
1.599     albertel 5849:   font-size: larger;
                   5850:   position: absolute;
                   5851:   right: 1em;
1.489     raeburn  5852: }
1.421     albertel 5853: 
1.515     albertel 5854: table.LC_prior_tries {
1.524     albertel 5855:   border: 1px solid #000000;
                   5856:   border-collapse: separate;
                   5857:   border-spacing: 1px;
1.515     albertel 5858: }
1.523     albertel 5859: 
1.515     albertel 5860: table.LC_prior_tries td {
1.524     albertel 5861:   padding: 2px;
1.515     albertel 5862: }
1.523     albertel 5863: 
                   5864: .LC_answer_correct {
1.795     www      5865:   background: lightgreen;
                   5866:   color: darkgreen;
                   5867:   padding: 6px;
1.523     albertel 5868: }
1.795     www      5869: 
1.523     albertel 5870: .LC_answer_charged_try {
1.797     www      5871:   background: #FFAAAA;
1.795     www      5872:   color: darkred;
                   5873:   padding: 6px;
1.523     albertel 5874: }
1.795     www      5875: 
1.779     bisitz   5876: .LC_answer_not_charged_try,
1.523     albertel 5877: .LC_answer_no_grade,
                   5878: .LC_answer_late {
1.795     www      5879:   background: lightyellow;
1.523     albertel 5880:   color: black;
1.795     www      5881:   padding: 6px;
1.523     albertel 5882: }
1.795     www      5883: 
1.523     albertel 5884: .LC_answer_previous {
1.795     www      5885:   background: lightblue;
                   5886:   color: darkblue;
                   5887:   padding: 6px;
1.523     albertel 5888: }
1.795     www      5889: 
1.779     bisitz   5890: .LC_answer_no_message {
1.777     tempelho 5891:   background: #FFFFFF;
                   5892:   color: black;
1.795     www      5893:   padding: 6px;
1.779     bisitz   5894: }
1.795     www      5895: 
1.779     bisitz   5896: .LC_answer_unknown {
                   5897:   background: orange;
                   5898:   color: black;
1.795     www      5899:   padding: 6px;
1.777     tempelho 5900: }
1.795     www      5901: 
1.529     albertel 5902: span.LC_prior_numerical,
                   5903: span.LC_prior_string,
                   5904: span.LC_prior_custom,
                   5905: span.LC_prior_reaction,
                   5906: span.LC_prior_math {
1.925     bisitz   5907:   font-family: $mono;
1.523     albertel 5908:   white-space: pre;
                   5909: }
                   5910: 
1.525     albertel 5911: span.LC_prior_string {
1.925     bisitz   5912:   font-family: $mono;
1.525     albertel 5913:   white-space: pre;
                   5914: }
                   5915: 
1.523     albertel 5916: table.LC_prior_option {
                   5917:   width: 100%;
                   5918:   border-collapse: collapse;
                   5919: }
1.795     www      5920: 
1.911     bisitz   5921: table.LC_prior_rank,
1.795     www      5922: table.LC_prior_match {
1.528     albertel 5923:   border-collapse: collapse;
                   5924: }
1.795     www      5925: 
1.528     albertel 5926: table.LC_prior_option tr td,
                   5927: table.LC_prior_rank tr td,
                   5928: table.LC_prior_match tr td {
1.524     albertel 5929:   border: 1px solid #000000;
1.515     albertel 5930: }
                   5931: 
1.855     bisitz   5932: .LC_nobreak {
1.544     albertel 5933:   white-space: nowrap;
1.519     raeburn  5934: }
                   5935: 
1.576     raeburn  5936: span.LC_cusr_emph {
                   5937:   font-style: italic;
                   5938: }
                   5939: 
1.633     raeburn  5940: span.LC_cusr_subheading {
                   5941:   font-weight: normal;
                   5942:   font-size: 85%;
                   5943: }
                   5944: 
1.861     bisitz   5945: div.LC_docs_entry_move {
1.859     bisitz   5946:   border: 1px solid #BBBBBB;
1.545     albertel 5947:   background: #DDDDDD;
1.861     bisitz   5948:   width: 22px;
1.859     bisitz   5949:   padding: 1px;
                   5950:   margin: 0;
1.545     albertel 5951: }
                   5952: 
1.861     bisitz   5953: table.LC_data_table tr > td.LC_docs_entry_commands,
                   5954: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 5955:   background: #DDDDDD;
                   5956:   font-size: x-small;
                   5957: }
1.795     www      5958: 
1.861     bisitz   5959: .LC_docs_entry_parameter {
                   5960:   white-space: nowrap;
                   5961: }
                   5962: 
1.544     albertel 5963: .LC_docs_copy {
1.545     albertel 5964:   color: #000099;
1.544     albertel 5965: }
1.795     www      5966: 
1.544     albertel 5967: .LC_docs_cut {
1.545     albertel 5968:   color: #550044;
1.544     albertel 5969: }
1.795     www      5970: 
1.544     albertel 5971: .LC_docs_rename {
1.545     albertel 5972:   color: #009900;
1.544     albertel 5973: }
1.795     www      5974: 
1.544     albertel 5975: .LC_docs_remove {
1.545     albertel 5976:   color: #990000;
                   5977: }
                   5978: 
1.547     albertel 5979: .LC_docs_reinit_warn,
                   5980: .LC_docs_ext_edit {
                   5981:   font-size: x-small;
                   5982: }
                   5983: 
1.545     albertel 5984: table.LC_docs_adddocs td,
                   5985: table.LC_docs_adddocs th {
                   5986:   border: 1px solid #BBBBBB;
                   5987:   padding: 4px;
                   5988:   background: #DDDDDD;
1.543     albertel 5989: }
                   5990: 
1.584     albertel 5991: table.LC_sty_begin {
                   5992:   background: #BBFFBB;
                   5993: }
1.795     www      5994: 
1.584     albertel 5995: table.LC_sty_end {
                   5996:   background: #FFBBBB;
                   5997: }
                   5998: 
1.589     raeburn  5999: table.LC_double_column {
1.803     bisitz   6000:   border-width: 0;
1.589     raeburn  6001:   border-collapse: collapse;
                   6002:   width: 100%;
                   6003:   padding: 2px;
                   6004: }
                   6005: 
                   6006: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  6007:   top: 2px;
1.589     raeburn  6008:   left: 2px;
                   6009:   width: 47%;
                   6010:   vertical-align: top;
                   6011: }
                   6012: 
                   6013: table.LC_double_column tr td.LC_right_col {
                   6014:   top: 2px;
1.779     bisitz   6015:   right: 2px;
1.589     raeburn  6016:   width: 47%;
                   6017:   vertical-align: top;
                   6018: }
                   6019: 
1.591     raeburn  6020: div.LC_left_float {
                   6021:   float: left;
                   6022:   padding-right: 5%;
1.597     albertel 6023:   padding-bottom: 4px;
1.591     raeburn  6024: }
                   6025: 
                   6026: div.LC_clear_float_header {
1.597     albertel 6027:   padding-bottom: 2px;
1.591     raeburn  6028: }
                   6029: 
                   6030: div.LC_clear_float_footer {
1.597     albertel 6031:   padding-top: 10px;
1.591     raeburn  6032:   clear: both;
                   6033: }
                   6034: 
1.597     albertel 6035: div.LC_grade_show_user {
1.941     bisitz   6036: /*  border-left: 5px solid $sidebg; */
                   6037:   border-top: 5px solid #000000;
                   6038:   margin: 50px 0 0 0;
1.936     bisitz   6039:   padding: 15px 0 5px 10px;
1.597     albertel 6040: }
1.795     www      6041: 
1.936     bisitz   6042: div.LC_grade_show_user_odd_row {
1.941     bisitz   6043: /*  border-left: 5px solid #000000; */
                   6044: }
                   6045: 
                   6046: div.LC_grade_show_user div.LC_Box {
                   6047:   margin-right: 50px;
1.597     albertel 6048: }
                   6049: 
                   6050: div.LC_grade_submissions,
                   6051: div.LC_grade_message_center,
1.936     bisitz   6052: div.LC_grade_info_links {
1.597     albertel 6053:   margin: 5px;
                   6054:   width: 99%;
                   6055:   background: #FFFFFF;
                   6056: }
1.795     www      6057: 
1.597     albertel 6058: div.LC_grade_submissions_header,
1.936     bisitz   6059: div.LC_grade_message_center_header {
1.705     tempelho 6060:   font-weight: bold;
                   6061:   font-size: large;
1.597     albertel 6062: }
1.795     www      6063: 
1.597     albertel 6064: div.LC_grade_submissions_body,
1.936     bisitz   6065: div.LC_grade_message_center_body {
1.597     albertel 6066:   border: 1px solid black;
                   6067:   width: 99%;
                   6068:   background: #FFFFFF;
                   6069: }
1.795     www      6070: 
1.613     albertel 6071: table.LC_scantron_action {
                   6072:   width: 100%;
                   6073: }
1.795     www      6074: 
1.613     albertel 6075: table.LC_scantron_action tr th {
1.698     harmsja  6076:   font-weight:bold;
                   6077:   font-style:normal;
1.613     albertel 6078: }
1.795     www      6079: 
1.779     bisitz   6080: .LC_edit_problem_header,
1.614     albertel 6081: div.LC_edit_problem_footer {
1.705     tempelho 6082:   font-weight: normal;
                   6083:   font-size:  medium;
1.602     albertel 6084:   margin: 2px;
1.600     albertel 6085: }
1.795     www      6086: 
1.600     albertel 6087: div.LC_edit_problem_header,
1.602     albertel 6088: div.LC_edit_problem_header div,
1.614     albertel 6089: div.LC_edit_problem_footer,
                   6090: div.LC_edit_problem_footer div,
1.602     albertel 6091: div.LC_edit_problem_editxml_header,
                   6092: div.LC_edit_problem_editxml_header div {
1.600     albertel 6093:   margin-top: 5px;
                   6094: }
1.795     www      6095: 
1.600     albertel 6096: div.LC_edit_problem_header_title {
1.705     tempelho 6097:   font-weight: bold;
                   6098:   font-size: larger;
1.602     albertel 6099:   background: $tabbg;
                   6100:   padding: 3px;
                   6101: }
1.795     www      6102: 
1.602     albertel 6103: table.LC_edit_problem_header_title {
                   6104:   width: 100%;
1.600     albertel 6105:   background: $tabbg;
1.602     albertel 6106: }
                   6107: 
                   6108: div.LC_edit_problem_discards {
                   6109:   float: left;
                   6110:   padding-bottom: 5px;
                   6111: }
1.795     www      6112: 
1.602     albertel 6113: div.LC_edit_problem_saves {
                   6114:   float: right;
                   6115:   padding-bottom: 5px;
1.600     albertel 6116: }
1.795     www      6117: 
1.911     bisitz   6118: img.stift {
1.803     bisitz   6119:   border-width: 0;
                   6120:   vertical-align: middle;
1.677     riegler  6121: }
1.680     riegler  6122: 
1.923     bisitz   6123: table td.LC_mainmenu_col_fieldset {
1.680     riegler  6124:   vertical-align: top;
1.777     tempelho 6125: }
1.795     www      6126: 
1.716     raeburn  6127: div.LC_createcourse {
1.911     bisitz   6128:   margin: 10px 10px 10px 10px;
1.716     raeburn  6129: }
                   6130: 
1.917     raeburn  6131: .LC_dccid {
                   6132:   margin: 0.2em 0 0 0;
                   6133:   padding: 0;
                   6134:   font-size: 90%;
                   6135:   display:none;
                   6136: }
                   6137: 
1.897     wenzelju 6138: ol.LC_primary_menu a:hover,
1.721     harmsja  6139: ol#LC_MenuBreadcrumbs a:hover,
                   6140: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 6141: ul#LC_secondary_menu a:hover,
1.721     harmsja  6142: .LC_FormSectionClearButton input:hover
1.795     www      6143: ul.LC_TabContent   li:hover a {
1.952     onken    6144:   color:$button_hover;
1.911     bisitz   6145:   text-decoration:none;
1.693     droeschl 6146: }
                   6147: 
1.779     bisitz   6148: h1 {
1.911     bisitz   6149:   padding: 0;
                   6150:   line-height:130%;
1.693     droeschl 6151: }
1.698     harmsja  6152: 
1.911     bisitz   6153: h2,
                   6154: h3,
                   6155: h4,
                   6156: h5,
                   6157: h6 {
                   6158:   margin: 5px 0 5px 0;
                   6159:   padding: 0;
                   6160:   line-height:130%;
1.693     droeschl 6161: }
1.795     www      6162: 
                   6163: .LC_hcell {
1.911     bisitz   6164:   padding:3px 15px 3px 15px;
                   6165:   margin: 0;
                   6166:   background-color:$tabbg;
                   6167:   color:$fontmenu;
                   6168:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 6169: }
1.795     www      6170: 
1.840     bisitz   6171: .LC_Box > .LC_hcell {
1.911     bisitz   6172:   margin: 0 -10px 10px -10px;
1.835     bisitz   6173: }
                   6174: 
1.721     harmsja  6175: .LC_noBorder {
1.911     bisitz   6176:   border: 0;
1.698     harmsja  6177: }
1.693     droeschl 6178: 
1.721     harmsja  6179: .LC_FormSectionClearButton input {
1.911     bisitz   6180:   background-color:transparent;
                   6181:   border: none;
                   6182:   cursor:pointer;
                   6183:   text-decoration:underline;
1.693     droeschl 6184: }
1.763     bisitz   6185: 
                   6186: .LC_help_open_topic {
1.911     bisitz   6187:   color: #FFFFFF;
                   6188:   background-color: #EEEEFF;
                   6189:   margin: 1px;
                   6190:   padding: 4px;
                   6191:   border: 1px solid #000033;
                   6192:   white-space: nowrap;
                   6193:   /* vertical-align: middle; */
1.759     neumanie 6194: }
1.693     droeschl 6195: 
1.911     bisitz   6196: dl,
                   6197: ul,
                   6198: div,
                   6199: fieldset {
                   6200:   margin: 10px 10px 10px 0;
                   6201:   /* overflow: hidden; */
1.693     droeschl 6202: }
1.795     www      6203: 
1.838     bisitz   6204: fieldset > legend {
1.911     bisitz   6205:   font-weight: bold;
                   6206:   padding: 0 5px 0 5px;
1.838     bisitz   6207: }
                   6208: 
1.813     bisitz   6209: #LC_nav_bar {
1.911     bisitz   6210:   float: left;
1.995     raeburn  6211:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   6212:   margin: 0 0 2px 0;
1.807     droeschl 6213: }
                   6214: 
1.916     droeschl 6215: #LC_realm {
                   6216:   margin: 0.2em 0 0 0;
                   6217:   padding: 0;
                   6218:   font-weight: bold;
                   6219:   text-align: center;
1.995     raeburn  6220:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 6221: }
                   6222: 
1.911     bisitz   6223: #LC_nav_bar em {
                   6224:   font-weight: bold;
                   6225:   font-style: normal;
1.807     droeschl 6226: }
                   6227: 
1.897     wenzelju 6228: ol.LC_primary_menu {
1.911     bisitz   6229:   float: right;
1.934     droeschl 6230:   margin: 0;
1.995     raeburn  6231:   background-color: $pgbg_or_bgcolor;
1.807     droeschl 6232: }
                   6233: 
1.852     droeschl 6234: ol#LC_PathBreadcrumbs {
1.911     bisitz   6235:   margin: 0;
1.693     droeschl 6236: }
                   6237: 
1.897     wenzelju 6238: ol.LC_primary_menu li {
1.911     bisitz   6239:   display: inline;
                   6240:   padding: 5px 5px 0 10px;
                   6241:   vertical-align: top;
1.693     droeschl 6242: }
                   6243: 
1.897     wenzelju 6244: ol.LC_primary_menu li img {
1.911     bisitz   6245:   vertical-align: bottom;
1.934     droeschl 6246:   height: 1.1em;
1.693     droeschl 6247: }
                   6248: 
1.897     wenzelju 6249: ol.LC_primary_menu a {
1.911     bisitz   6250:   color: RGB(80, 80, 80);
                   6251:   text-decoration: none;
1.693     droeschl 6252: }
1.795     www      6253: 
1.949     droeschl 6254: ol.LC_primary_menu a.LC_new_message {
                   6255:   font-weight:bold;
                   6256:   color: darkred;
                   6257: }
                   6258: 
1.975     raeburn  6259: ol.LC_docs_parameters {
                   6260:   margin-left: 0;
                   6261:   padding: 0;
                   6262:   list-style: none;
                   6263: }
                   6264: 
                   6265: ol.LC_docs_parameters li {
                   6266:   margin: 0;
                   6267:   padding-right: 20px;
                   6268:   display: inline;
                   6269: }
                   6270: 
1.976     raeburn  6271: ol.LC_docs_parameters li:before {
                   6272:   content: "\\002022 \\0020";
                   6273: }
                   6274: 
                   6275: li.LC_docs_parameters_title {
                   6276:   font-weight: bold;
                   6277: }
                   6278: 
                   6279: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   6280:   content: "";
                   6281: }
                   6282: 
1.897     wenzelju 6283: ul#LC_secondary_menu {
1.911     bisitz   6284:   clear: both;
                   6285:   color: $fontmenu;
                   6286:   background: $tabbg;
                   6287:   list-style: none;
                   6288:   padding: 0;
                   6289:   margin: 0;
                   6290:   width: 100%;
1.995     raeburn  6291:   text-align: left;
1.808     droeschl 6292: }
                   6293: 
1.897     wenzelju 6294: ul#LC_secondary_menu li {
1.911     bisitz   6295:   font-weight: bold;
                   6296:   line-height: 1.8em;
                   6297:   padding: 0 0.8em;
                   6298:   border-right: 1px solid black;
                   6299:   display: inline;
                   6300:   vertical-align: middle;
1.807     droeschl 6301: }
                   6302: 
1.847     tempelho 6303: ul.LC_TabContent {
1.911     bisitz   6304:   display:block;
                   6305:   background: $sidebg;
                   6306:   border-bottom: solid 1px $lg_border_color;
                   6307:   list-style:none;
1.1020    raeburn  6308:   margin: -1px -10px 0 -10px;
1.911     bisitz   6309:   padding: 0;
1.693     droeschl 6310: }
                   6311: 
1.795     www      6312: ul.LC_TabContent li,
                   6313: ul.LC_TabContentBigger li {
1.911     bisitz   6314:   float:left;
1.741     harmsja  6315: }
1.795     www      6316: 
1.897     wenzelju 6317: ul#LC_secondary_menu li a {
1.911     bisitz   6318:   color: $fontmenu;
                   6319:   text-decoration: none;
1.693     droeschl 6320: }
1.795     www      6321: 
1.721     harmsja  6322: ul.LC_TabContent {
1.952     onken    6323:   min-height:20px;
1.721     harmsja  6324: }
1.795     www      6325: 
                   6326: ul.LC_TabContent li {
1.911     bisitz   6327:   vertical-align:middle;
1.959     onken    6328:   padding: 0 16px 0 10px;
1.911     bisitz   6329:   background-color:$tabbg;
                   6330:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  6331:   border-left: solid 1px $font;
1.721     harmsja  6332: }
1.795     www      6333: 
1.847     tempelho 6334: ul.LC_TabContent .right {
1.911     bisitz   6335:   float:right;
1.847     tempelho 6336: }
                   6337: 
1.911     bisitz   6338: ul.LC_TabContent li a,
                   6339: ul.LC_TabContent li {
                   6340:   color:rgb(47,47,47);
                   6341:   text-decoration:none;
                   6342:   font-size:95%;
                   6343:   font-weight:bold;
1.952     onken    6344:   min-height:20px;
                   6345: }
                   6346: 
1.959     onken    6347: ul.LC_TabContent li a:hover,
                   6348: ul.LC_TabContent li a:focus {
1.952     onken    6349:   color: $button_hover;
1.959     onken    6350:   background:none;
                   6351:   outline:none;
1.952     onken    6352: }
                   6353: 
                   6354: ul.LC_TabContent li:hover {
                   6355:   color: $button_hover;
                   6356:   cursor:pointer;
1.721     harmsja  6357: }
1.795     www      6358: 
1.911     bisitz   6359: ul.LC_TabContent li.active {
1.952     onken    6360:   color: $font;
1.911     bisitz   6361:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    6362:   border-bottom:solid 1px #FFFFFF;
                   6363:   cursor: default;
1.744     ehlerst  6364: }
1.795     www      6365: 
1.959     onken    6366: ul.LC_TabContent li.active a {
                   6367:   color:$font;
                   6368:   background:#FFFFFF;
                   6369:   outline: none;
                   6370: }
1.1047    raeburn  6371: 
                   6372: ul.LC_TabContent li.goback {
                   6373:   float: left;
                   6374:   border-left: none;
                   6375: }
                   6376: 
1.870     tempelho 6377: #maincoursedoc {
1.911     bisitz   6378:   clear:both;
1.870     tempelho 6379: }
                   6380: 
                   6381: ul.LC_TabContentBigger {
1.911     bisitz   6382:   display:block;
                   6383:   list-style:none;
                   6384:   padding: 0;
1.870     tempelho 6385: }
                   6386: 
1.795     www      6387: ul.LC_TabContentBigger li {
1.911     bisitz   6388:   vertical-align:bottom;
                   6389:   height: 30px;
                   6390:   font-size:110%;
                   6391:   font-weight:bold;
                   6392:   color: #737373;
1.841     tempelho 6393: }
                   6394: 
1.957     onken    6395: ul.LC_TabContentBigger li.active {
                   6396:   position: relative;
                   6397:   top: 1px;
                   6398: }
                   6399: 
1.870     tempelho 6400: ul.LC_TabContentBigger li a {
1.911     bisitz   6401:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6402:   height: 30px;
                   6403:   line-height: 30px;
                   6404:   text-align: center;
                   6405:   display: block;
                   6406:   text-decoration: none;
1.958     onken    6407:   outline: none;  
1.741     harmsja  6408: }
1.795     www      6409: 
1.870     tempelho 6410: ul.LC_TabContentBigger li.active a {
1.911     bisitz   6411:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   6412:   color:$font;
1.744     ehlerst  6413: }
1.795     www      6414: 
1.870     tempelho 6415: ul.LC_TabContentBigger li b {
1.911     bisitz   6416:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6417:   display: block;
                   6418:   float: left;
                   6419:   padding: 0 30px;
1.957     onken    6420:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 6421: }
                   6422: 
1.956     onken    6423: ul.LC_TabContentBigger li:hover b {
                   6424:   color:$button_hover;
                   6425: }
                   6426: 
1.870     tempelho 6427: ul.LC_TabContentBigger li.active b {
1.911     bisitz   6428:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6429:   color:$font;
1.957     onken    6430:   border: 0;
1.741     harmsja  6431: }
1.693     droeschl 6432: 
1.870     tempelho 6433: 
1.862     bisitz   6434: ul.LC_CourseBreadcrumbs {
                   6435:   background: $sidebg;
1.1020    raeburn  6436:   height: 2em;
1.862     bisitz   6437:   padding-left: 10px;
1.1020    raeburn  6438:   margin: 0;
1.862     bisitz   6439:   list-style-position: inside;
                   6440: }
                   6441: 
1.911     bisitz   6442: ol#LC_MenuBreadcrumbs,
1.862     bisitz   6443: ol#LC_PathBreadcrumbs {
1.911     bisitz   6444:   padding-left: 10px;
                   6445:   margin: 0;
1.933     droeschl 6446:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 6447: }
                   6448: 
1.911     bisitz   6449: ol#LC_MenuBreadcrumbs li,
                   6450: ol#LC_PathBreadcrumbs li,
1.862     bisitz   6451: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   6452:   display: inline;
1.933     droeschl 6453:   white-space: normal;  
1.693     droeschl 6454: }
                   6455: 
1.823     bisitz   6456: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6457: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   6458:   text-decoration: none;
                   6459:   font-size:90%;
1.693     droeschl 6460: }
1.795     www      6461: 
1.969     droeschl 6462: ol#LC_MenuBreadcrumbs h1 {
                   6463:   display: inline;
                   6464:   font-size: 90%;
                   6465:   line-height: 2.5em;
                   6466:   margin: 0;
                   6467:   padding: 0;
                   6468: }
                   6469: 
1.795     www      6470: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   6471:   text-decoration:none;
                   6472:   font-size:100%;
                   6473:   font-weight:bold;
1.693     droeschl 6474: }
1.795     www      6475: 
1.840     bisitz   6476: .LC_Box {
1.911     bisitz   6477:   border: solid 1px $lg_border_color;
                   6478:   padding: 0 10px 10px 10px;
1.746     neumanie 6479: }
1.795     www      6480: 
1.1020    raeburn  6481: .LC_DocsBox {
                   6482:   border: solid 1px $lg_border_color;
                   6483:   padding: 0 0 10px 10px;
                   6484: }
                   6485: 
1.795     www      6486: .LC_AboutMe_Image {
1.911     bisitz   6487:   float:left;
                   6488:   margin-right:10px;
1.747     neumanie 6489: }
1.795     www      6490: 
                   6491: .LC_Clear_AboutMe_Image {
1.911     bisitz   6492:   clear:left;
1.747     neumanie 6493: }
1.795     www      6494: 
1.721     harmsja  6495: dl.LC_ListStyleClean dt {
1.911     bisitz   6496:   padding-right: 5px;
                   6497:   display: table-header-group;
1.693     droeschl 6498: }
                   6499: 
1.721     harmsja  6500: dl.LC_ListStyleClean dd {
1.911     bisitz   6501:   display: table-row;
1.693     droeschl 6502: }
                   6503: 
1.721     harmsja  6504: .LC_ListStyleClean,
                   6505: .LC_ListStyleSimple,
                   6506: .LC_ListStyleNormal,
1.795     www      6507: .LC_ListStyleSpecial {
1.911     bisitz   6508:   /* display:block; */
                   6509:   list-style-position: inside;
                   6510:   list-style-type: none;
                   6511:   overflow: hidden;
                   6512:   padding: 0;
1.693     droeschl 6513: }
                   6514: 
1.721     harmsja  6515: .LC_ListStyleSimple li,
                   6516: .LC_ListStyleSimple dd,
                   6517: .LC_ListStyleNormal li,
                   6518: .LC_ListStyleNormal dd,
                   6519: .LC_ListStyleSpecial li,
1.795     www      6520: .LC_ListStyleSpecial dd {
1.911     bisitz   6521:   margin: 0;
                   6522:   padding: 5px 5px 5px 10px;
                   6523:   clear: both;
1.693     droeschl 6524: }
                   6525: 
1.721     harmsja  6526: .LC_ListStyleClean li,
                   6527: .LC_ListStyleClean dd {
1.911     bisitz   6528:   padding-top: 0;
                   6529:   padding-bottom: 0;
1.693     droeschl 6530: }
                   6531: 
1.721     harmsja  6532: .LC_ListStyleSimple dd,
1.795     www      6533: .LC_ListStyleSimple li {
1.911     bisitz   6534:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6535: }
                   6536: 
1.721     harmsja  6537: .LC_ListStyleSpecial li,
                   6538: .LC_ListStyleSpecial dd {
1.911     bisitz   6539:   list-style-type: none;
                   6540:   background-color: RGB(220, 220, 220);
                   6541:   margin-bottom: 4px;
1.693     droeschl 6542: }
                   6543: 
1.721     harmsja  6544: table.LC_SimpleTable {
1.911     bisitz   6545:   margin:5px;
                   6546:   border:solid 1px $lg_border_color;
1.795     www      6547: }
1.693     droeschl 6548: 
1.721     harmsja  6549: table.LC_SimpleTable tr {
1.911     bisitz   6550:   padding: 0;
                   6551:   border:solid 1px $lg_border_color;
1.693     droeschl 6552: }
1.795     www      6553: 
                   6554: table.LC_SimpleTable thead {
1.911     bisitz   6555:   background:rgb(220,220,220);
1.693     droeschl 6556: }
                   6557: 
1.721     harmsja  6558: div.LC_columnSection {
1.911     bisitz   6559:   display: block;
                   6560:   clear: both;
                   6561:   overflow: hidden;
                   6562:   margin: 0;
1.693     droeschl 6563: }
                   6564: 
1.721     harmsja  6565: div.LC_columnSection>* {
1.911     bisitz   6566:   float: left;
                   6567:   margin: 10px 20px 10px 0;
                   6568:   overflow:hidden;
1.693     droeschl 6569: }
1.721     harmsja  6570: 
1.795     www      6571: table em {
1.911     bisitz   6572:   font-weight: bold;
                   6573:   font-style: normal;
1.748     schulted 6574: }
1.795     www      6575: 
1.779     bisitz   6576: table.LC_tableBrowseRes,
1.795     www      6577: table.LC_tableOfContent {
1.911     bisitz   6578:   border:none;
                   6579:   border-spacing: 1px;
                   6580:   padding: 3px;
                   6581:   background-color: #FFFFFF;
                   6582:   font-size: 90%;
1.753     droeschl 6583: }
1.789     droeschl 6584: 
1.911     bisitz   6585: table.LC_tableOfContent {
                   6586:   border-collapse: collapse;
1.789     droeschl 6587: }
                   6588: 
1.771     droeschl 6589: table.LC_tableBrowseRes a,
1.768     schulted 6590: table.LC_tableOfContent a {
1.911     bisitz   6591:   background-color: transparent;
                   6592:   text-decoration: none;
1.753     droeschl 6593: }
                   6594: 
1.795     www      6595: table.LC_tableOfContent img {
1.911     bisitz   6596:   border: none;
                   6597:   height: 1.3em;
                   6598:   vertical-align: text-bottom;
                   6599:   margin-right: 0.3em;
1.753     droeschl 6600: }
1.757     schulted 6601: 
1.795     www      6602: a#LC_content_toolbar_firsthomework {
1.911     bisitz   6603:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  6604: }
                   6605: 
1.795     www      6606: a#LC_content_toolbar_everything {
1.911     bisitz   6607:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  6608: }
                   6609: 
1.795     www      6610: a#LC_content_toolbar_uncompleted {
1.911     bisitz   6611:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  6612: }
                   6613: 
1.795     www      6614: #LC_content_toolbar_clearbubbles {
1.911     bisitz   6615:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  6616: }
                   6617: 
1.795     www      6618: a#LC_content_toolbar_changefolder {
1.911     bisitz   6619:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 6620: }
                   6621: 
1.795     www      6622: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   6623:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 6624: }
                   6625: 
1.1043    raeburn  6626: a#LC_content_toolbar_edittoplevel {
                   6627:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   6628: }
                   6629: 
1.795     www      6630: ul#LC_toolbar li a:hover {
1.911     bisitz   6631:   background-position: bottom center;
1.757     schulted 6632: }
                   6633: 
1.795     www      6634: ul#LC_toolbar {
1.911     bisitz   6635:   padding: 0;
                   6636:   margin: 2px;
                   6637:   list-style:none;
                   6638:   position:relative;
                   6639:   background-color:white;
1.757     schulted 6640: }
                   6641: 
1.795     www      6642: ul#LC_toolbar li {
1.911     bisitz   6643:   border:1px solid white;
                   6644:   padding: 0;
                   6645:   margin: 0;
                   6646:   float: left;
                   6647:   display:inline;
                   6648:   vertical-align:middle;
                   6649: }
1.757     schulted 6650: 
1.783     amueller 6651: 
1.795     www      6652: a.LC_toolbarItem {
1.911     bisitz   6653:   display:block;
                   6654:   padding: 0;
                   6655:   margin: 0;
                   6656:   height: 32px;
                   6657:   width: 32px;
                   6658:   color:white;
                   6659:   border: none;
                   6660:   background-repeat:no-repeat;
                   6661:   background-color:transparent;
1.757     schulted 6662: }
                   6663: 
1.915     droeschl 6664: ul.LC_funclist {
                   6665:     margin: 0;
                   6666:     padding: 0.5em 1em 0.5em 0;
                   6667: }
                   6668: 
1.933     droeschl 6669: ul.LC_funclist > li:first-child {
                   6670:     font-weight:bold; 
                   6671:     margin-left:0.8em;
                   6672: }
                   6673: 
1.915     droeschl 6674: ul.LC_funclist + ul.LC_funclist {
                   6675:     /* 
                   6676:        left border as a seperator if we have more than
                   6677:        one list 
                   6678:     */
                   6679:     border-left: 1px solid $sidebg;
                   6680:     /* 
                   6681:        this hides the left border behind the border of the 
                   6682:        outer box if element is wrapped to the next 'line' 
                   6683:     */
                   6684:     margin-left: -1px;
                   6685: }
                   6686: 
1.843     bisitz   6687: ul.LC_funclist li {
1.915     droeschl 6688:   display: inline;
1.782     bisitz   6689:   white-space: nowrap;
1.915     droeschl 6690:   margin: 0 0 0 25px;
                   6691:   line-height: 150%;
1.782     bisitz   6692: }
                   6693: 
1.974     wenzelju 6694: .LC_hidden {
                   6695:   display: none;
                   6696: }
                   6697: 
1.1030    www      6698: .LCmodal-overlay {
                   6699: 		position:fixed;
                   6700: 		top:0;
                   6701: 		right:0;
                   6702: 		bottom:0;
                   6703: 		left:0;
                   6704: 		height:100%;
                   6705: 		width:100%;
                   6706: 		margin:0;
                   6707: 		padding:0;
                   6708: 		background:#999;
                   6709: 		opacity:.75;
                   6710: 		filter: alpha(opacity=75);
                   6711: 		-moz-opacity: 0.75;
                   6712: 		z-index:101;
                   6713: }
                   6714: 
                   6715: * html .LCmodal-overlay {   
                   6716: 		position: absolute;
                   6717: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   6718: }
                   6719: 
                   6720: .LCmodal-window {
                   6721: 		position:fixed;
                   6722: 		top:50%;
                   6723: 		left:50%;
                   6724: 		margin:0;
                   6725: 		padding:0;
                   6726: 		z-index:102;
                   6727: 	}
                   6728: 
                   6729: * html .LCmodal-window {
                   6730: 		position:absolute;
                   6731: }
                   6732: 
                   6733: .LCclose-window {
                   6734: 		position:absolute;
                   6735: 		width:32px;
                   6736: 		height:32px;
                   6737: 		right:8px;
                   6738: 		top:8px;
                   6739: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   6740: 		text-indent:-99999px;
                   6741: 		overflow:hidden;
                   6742: 		cursor:pointer;
                   6743: }
                   6744: 
1.343     albertel 6745: END
                   6746: }
                   6747: 
1.306     albertel 6748: =pod
                   6749: 
                   6750: =item * &headtag()
                   6751: 
                   6752: Returns a uniform footer for LON-CAPA web pages.
                   6753: 
1.307     albertel 6754: Inputs: $title - optional title for the head
                   6755:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6756:         $args - optional arguments
1.319     albertel 6757:             force_register - if is true call registerurl so the remote is 
                   6758:                              informed
1.415     albertel 6759:             redirect       -> array ref of
                   6760:                                    1- seconds before redirect occurs
                   6761:                                    2- url to redirect to
                   6762:                                    3- whether the side effect should occur
1.315     albertel 6763:                            (side effect of setting 
                   6764:                                $env{'internal.head.redirect'} to the url 
                   6765:                                redirected too)
1.352     albertel 6766:             domain         -> force to color decorate a page for a specific
                   6767:                                domain
                   6768:             function       -> force usage of a specific rolish color scheme
                   6769:             bgcolor        -> override the default page bgcolor
1.460     albertel 6770:             no_auto_mt_title
                   6771:                            -> prevent &mt()ing the title arg
1.464     albertel 6772: 
1.306     albertel 6773: =cut
                   6774: 
                   6775: sub headtag {
1.313     albertel 6776:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6777:     
1.363     albertel 6778:     my $function = $args->{'function'} || &get_users_function();
                   6779:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6780:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6781:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6782: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6783: 		   #time(),
1.418     albertel 6784: 		   $env{'environment.color.timestamp'},
1.363     albertel 6785: 		   $function,$domain,$bgcolor);
                   6786: 
1.369     www      6787:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6788: 
1.308     albertel 6789:     my $result =
                   6790: 	'<head>'.
1.461     albertel 6791: 	&font_settings();
1.319     albertel 6792: 
1.461     albertel 6793:     if (!$args->{'frameset'}) {
                   6794: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6795:     }
1.962     droeschl 6796:     if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
                   6797:         $result .= Apache::lonxml::display_title();
1.319     albertel 6798:     }
1.436     albertel 6799:     if (!$args->{'no_nav_bar'} 
                   6800: 	&& !$args->{'only_body'}
                   6801: 	&& !$args->{'frameset'}) {
                   6802: 	$result .= &help_menu_js();
1.1032    www      6803:         $result.=&modal_window();
1.1038    www      6804:         $result.=&togglebox_script();
1.1034    www      6805:         $result.=&wishlist_window();
1.1041    www      6806:         $result.=&LCprogressbarUpdate_script();
1.1034    www      6807:     } else {
                   6808:         if ($args->{'add_modal'}) {
                   6809:            $result.=&modal_window();
                   6810:         }
                   6811:         if ($args->{'add_wishlist'}) {
                   6812:            $result.=&wishlist_window();
                   6813:         }
1.1038    www      6814:         if ($args->{'add_togglebox'}) {
                   6815:            $result.=&togglebox_script();
                   6816:         }
1.1041    www      6817:         if ($args->{'add_progressbar'}) {
                   6818:            $result.=&LCprogressbarUpdate_script();
                   6819:         }
1.436     albertel 6820:     }
1.314     albertel 6821:     if (ref($args->{'redirect'})) {
1.414     albertel 6822: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6823: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6824: 	if (!$inhibit_continue) {
                   6825: 	    $env{'internal.head.redirect'} = $url;
                   6826: 	}
1.313     albertel 6827: 	$result.=<<ADDMETA
                   6828: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6829: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6830: ADDMETA
                   6831:     }
1.306     albertel 6832:     if (!defined($title)) {
                   6833: 	$title = 'The LearningOnline Network with CAPA';
                   6834:     }
1.460     albertel 6835:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6836:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6837: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6838: 	.$head_extra;
1.962     droeschl 6839:     return $result.'</head>';
1.306     albertel 6840: }
                   6841: 
                   6842: =pod
                   6843: 
1.340     albertel 6844: =item * &font_settings()
                   6845: 
                   6846: Returns neccessary <meta> to set the proper encoding
                   6847: 
                   6848: Inputs: none
                   6849: 
                   6850: =cut
                   6851: 
                   6852: sub font_settings {
                   6853:     my $headerstring='';
1.647     www      6854:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6855: 	$headerstring.=
                   6856: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6857:     }
                   6858:     return $headerstring;
                   6859: }
                   6860: 
1.341     albertel 6861: =pod
                   6862: 
                   6863: =item * &xml_begin()
                   6864: 
                   6865: Returns the needed doctype and <html>
                   6866: 
                   6867: Inputs: none
                   6868: 
                   6869: =cut
                   6870: 
                   6871: sub xml_begin {
                   6872:     my $output='';
                   6873: 
                   6874:     if ($env{'browser.mathml'}) {
                   6875: 	$output='<?xml version="1.0"?>'
                   6876:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6877: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6878:             
                   6879: #	    .'<!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">] >'
                   6880: 	    .'<!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">'
                   6881:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6882: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6883:     } else {
1.849     bisitz   6884: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   6885:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 6886:     }
                   6887:     return $output;
                   6888: }
1.340     albertel 6889: 
                   6890: =pod
                   6891: 
1.306     albertel 6892: =item * &start_page()
                   6893: 
                   6894: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6895: 
1.648     raeburn  6896: Inputs:
                   6897: 
                   6898: =over 4
                   6899: 
                   6900: $title - optional title for the page
                   6901: 
                   6902: $head_extra - optional extra HTML to incude inside the <head>
                   6903: 
                   6904: $args - additional optional args supported are:
                   6905: 
                   6906: =over 8
                   6907: 
                   6908:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6909:                                     arg on
1.814     bisitz   6910:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6911:              add_entries    -> additional attributes to add to the  <body>
                   6912:              domain         -> force to color decorate a page for a 
1.317     albertel 6913:                                     specific domain
1.648     raeburn  6914:              function       -> force usage of a specific rolish color
1.317     albertel 6915:                                     scheme
1.648     raeburn  6916:              redirect       -> see &headtag()
                   6917:              bgcolor        -> override the default page bg color
                   6918:              js_ready       -> return a string ready for being used in 
1.317     albertel 6919:                                     a javascript writeln
1.648     raeburn  6920:              html_encode    -> return a string ready for being used in 
1.320     albertel 6921:                                     a html attribute
1.648     raeburn  6922:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6923:                                     $forcereg arg
1.648     raeburn  6924:              frameset       -> if true will start with a <frameset>
1.330     albertel 6925:                                     rather than <body>
1.648     raeburn  6926:              skip_phases    -> hash ref of 
1.338     albertel 6927:                                     head -> skip the <html><head> generation
                   6928:                                     body -> skip all <body> generation
1.648     raeburn  6929:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6930:              inherit_jsmath -> when creating popup window in a page,
                   6931:                                     should it have jsmath forced on by the
                   6932:                                     current page
1.867     kalberla 6933:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  6934:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 6935: 
1.648     raeburn  6936: =back
1.460     albertel 6937: 
1.648     raeburn  6938: =back
1.562     albertel 6939: 
1.306     albertel 6940: =cut
                   6941: 
                   6942: sub start_page {
1.309     albertel 6943:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6944:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 6945: 
1.315     albertel 6946:     $env{'internal.start_page'}++;
1.338     albertel 6947:     my $result;
1.964     droeschl 6948: 
1.338     albertel 6949:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030    www      6950:         $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338     albertel 6951:     }
                   6952:     
                   6953:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6954: 	if ($args->{'frameset'}) {
                   6955: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6956: 						$args->{'add_entries'});
                   6957: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   6958:         } else {
                   6959:             $result .=
                   6960:                 &bodytag($title, 
                   6961:                          $args->{'function'},       $args->{'add_entries'},
                   6962:                          $args->{'only_body'},      $args->{'domain'},
                   6963:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.962     droeschl 6964:                          $args->{'bgcolor'},        $args);
1.831     bisitz   6965:         }
1.330     albertel 6966:     }
1.338     albertel 6967: 
1.315     albertel 6968:     if ($args->{'js_ready'}) {
1.713     kaisler  6969: 		$result = &js_ready($result);
1.315     albertel 6970:     }
1.320     albertel 6971:     if ($args->{'html_encode'}) {
1.713     kaisler  6972: 		$result = &html_encode($result);
                   6973:     }
                   6974: 
1.813     bisitz   6975:     # Preparation for new and consistent functionlist at top of screen
                   6976:     # if ($args->{'functionlist'}) {
                   6977:     #            $result .= &build_functionlist();
                   6978:     #}
                   6979: 
1.964     droeschl 6980:     # Don't add anything more if only_body wanted or in const space
                   6981:     return $result if    $args->{'only_body'} 
                   6982:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   6983: 
                   6984:     #Breadcrumbs
1.758     kaisler  6985:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6986: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6987: 		#if any br links exists, add them to the breadcrumbs
                   6988: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6989: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6990: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6991: 			}
                   6992: 		}
                   6993: 
                   6994: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6995: 		if(exists($args->{'bread_crumbs_component'})){
                   6996: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   6997: 		}else{
                   6998: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   6999: 		}
1.320     albertel 7000:     }
1.315     albertel 7001:     return $result;
1.306     albertel 7002: }
                   7003: 
                   7004: sub end_page {
1.315     albertel 7005:     my ($args) = @_;
                   7006:     $env{'internal.end_page'}++;
1.330     albertel 7007:     my $result;
1.335     albertel 7008:     if ($args->{'discussion'}) {
                   7009: 	my ($target,$parser);
                   7010: 	if (ref($args->{'discussion'})) {
                   7011: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   7012: 				$args->{'discussion'}{'parser'});
                   7013: 	}
                   7014: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   7015:     }
1.330     albertel 7016:     if ($args->{'frameset'}) {
                   7017: 	$result .= '</frameset>';
                   7018:     } else {
1.635     raeburn  7019: 	$result .= &endbodytag($args);
1.330     albertel 7020:     }
                   7021:     $result .= "\n</html>";
                   7022: 
1.315     albertel 7023:     if ($args->{'js_ready'}) {
1.317     albertel 7024: 	$result = &js_ready($result);
1.315     albertel 7025:     }
1.335     albertel 7026: 
1.320     albertel 7027:     if ($args->{'html_encode'}) {
                   7028: 	$result = &html_encode($result);
                   7029:     }
1.335     albertel 7030: 
1.315     albertel 7031:     return $result;
                   7032: }
                   7033: 
1.1034    www      7034: sub wishlist_window {
                   7035:     return(<<'ENDWISHLIST');
1.1046    raeburn  7036: <script type="text/javascript">
1.1034    www      7037: // <![CDATA[
                   7038: // <!-- BEGIN LON-CAPA Internal
                   7039: function set_wishlistlink(title, path) {
                   7040:     if (!title) {
                   7041:         title = document.title;
                   7042:         title = title.replace(/^LON-CAPA /,'');
                   7043:     }
                   7044:     if (!path) {
                   7045:         path = location.pathname;
                   7046:     }
                   7047:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   7048:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   7049: }
                   7050: // END LON-CAPA Internal -->
                   7051: // ]]>
                   7052: </script>
                   7053: ENDWISHLIST
                   7054: }
                   7055: 
1.1030    www      7056: sub modal_window {
                   7057:     return(<<'ENDMODAL');
1.1046    raeburn  7058: <script type="text/javascript">
1.1030    www      7059: // <![CDATA[
                   7060: // <!-- BEGIN LON-CAPA Internal
                   7061: var modalWindow = {
                   7062: 	parent:"body",
                   7063: 	windowId:null,
                   7064: 	content:null,
                   7065: 	width:null,
                   7066: 	height:null,
                   7067: 	close:function()
                   7068: 	{
                   7069: 	        $(".LCmodal-window").remove();
                   7070: 	        $(".LCmodal-overlay").remove();
                   7071: 	},
                   7072: 	open:function()
                   7073: 	{
                   7074: 		var modal = "";
                   7075: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   7076: 		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;\">";
                   7077: 		modal += this.content;
                   7078: 		modal += "</div>";	
                   7079: 
                   7080: 		$(this.parent).append(modal);
                   7081: 
                   7082: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   7083: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   7084: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   7085: 	}
                   7086: };
1.1031    www      7087: 	var openMyModal = function(source,width,height,scrolling)
1.1030    www      7088: 	{
                   7089: 		modalWindow.windowId = "myModal";
                   7090: 		modalWindow.width = width;
                   7091: 		modalWindow.height = height;
1.1031    www      7092: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='true' src='" + source + "'>&lt/iframe>";
1.1030    www      7093: 		modalWindow.open();
                   7094: 	};	
                   7095: // END LON-CAPA Internal -->
                   7096: // ]]>
                   7097: </script>
                   7098: ENDMODAL
                   7099: }
                   7100: 
                   7101: sub modal_link {
1.1052    www      7102:     my ($link,$linktext,$width,$height,$target,$scrolling,$title)=@_;
1.1030    www      7103:     unless ($width) { $width=480; }
                   7104:     unless ($height) { $height=400; }
1.1031    www      7105:     unless ($scrolling) { $scrolling='yes'; }
1.1052    www      7106:     return '<a href="'.$link.'" target="'.$target.'" title="'.$title.'" onclick="openMyModal(\''.$link.'\','.$width.','.$height.',\''.$scrolling.'\'); return false;">'.
1.1031    www      7107:            $linktext.'</a>';
1.1030    www      7108: }
                   7109: 
1.1032    www      7110: sub modal_adhoc_script {
                   7111:     my ($funcname,$width,$height,$content)=@_;
                   7112:     return (<<ENDADHOC);
1.1046    raeburn  7113: <script type="text/javascript">
1.1032    www      7114: // <![CDATA[
                   7115:         var $funcname = function()
                   7116:         {
                   7117:                 modalWindow.windowId = "myModal";
                   7118:                 modalWindow.width = $width;
                   7119:                 modalWindow.height = $height;
                   7120:                 modalWindow.content = '$content';
                   7121:                 modalWindow.open();
                   7122:         };  
                   7123: // ]]>
                   7124: </script>
                   7125: ENDADHOC
                   7126: }
                   7127: 
1.1041    www      7128: sub modal_adhoc_inner {
                   7129:     my ($funcname,$width,$height,$content)=@_;
                   7130:     my $innerwidth=$width-20;
                   7131:     $content=&js_ready(
1.1042    www      7132:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1041    www      7133:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px').
                   7134:                     $content.
                   7135:                  &end_scrollbox().
                   7136:                &end_page()
                   7137:              );
                   7138:     return &modal_adhoc_script($funcname,$width,$height,$content);
                   7139: }
                   7140: 
                   7141: sub modal_adhoc_window {
                   7142:     my ($funcname,$width,$height,$content,$linktext)=@_;
                   7143:     return &modal_adhoc_inner($funcname,$width,$height,$content).
                   7144:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   7145: }
                   7146: 
                   7147: sub modal_adhoc_launch {
                   7148:     my ($funcname,$width,$height,$content)=@_;
                   7149:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   7150: <script type="text/javascript">
                   7151: // <![CDATA[
                   7152: $funcname();
                   7153: // ]]>
                   7154: </script>
                   7155: ENDLAUNCH
                   7156: }
                   7157: 
                   7158: sub modal_adhoc_close {
                   7159:     return (<<ENDCLOSE);
                   7160: <script type="text/javascript">
                   7161: // <![CDATA[
                   7162: modalWindow.close();
                   7163: // ]]>
                   7164: </script>
                   7165: ENDCLOSE
                   7166: }
                   7167: 
1.1038    www      7168: sub togglebox_script {
                   7169:    return(<<ENDTOGGLE);
                   7170: <script type="text/javascript"> 
                   7171: // <![CDATA[
                   7172: function LCtoggleDisplay(id,hidetext,showtext) {
                   7173:    link = document.getElementById(id + "link").childNodes[0];
                   7174:    with (document.getElementById(id).style) {
                   7175:       if (display == "none" ) {
                   7176:           display = "inline";
                   7177:           link.nodeValue = hidetext;
                   7178:         } else {
                   7179:           display = "none";
                   7180:           link.nodeValue = showtext;
                   7181:        }
                   7182:    }
                   7183: }
                   7184: // ]]>
                   7185: </script>
                   7186: ENDTOGGLE
                   7187: }
                   7188: 
1.1039    www      7189: sub start_togglebox {
                   7190:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   7191:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   7192:     unless ($showtext) { $showtext=&mt('show'); }
                   7193:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   7194:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   7195:     return &start_data_table().
                   7196:            &start_data_table_header_row().
                   7197:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   7198:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   7199:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   7200:            &end_data_table_header_row().
                   7201:            '<tr id="'.$id.'" style="display:none""><td>';
                   7202: }
                   7203: 
                   7204: sub end_togglebox {
                   7205:     return '</td></tr>'.&end_data_table();
                   7206: }
                   7207: 
1.1041    www      7208: sub LCprogressbar_script {
1.1045    www      7209:    my ($id)=@_;
1.1041    www      7210:    return(<<ENDPROGRESS);
                   7211: <script type="text/javascript">
                   7212: // <![CDATA[
1.1045    www      7213: \$('#progressbar$id').progressbar({
1.1041    www      7214:   value: 0,
                   7215:   change: function(event, ui) {
                   7216:     var newVal = \$(this).progressbar('option', 'value');
                   7217:     \$('.pblabel', this).text(LCprogressTxt);
                   7218:   }
                   7219: });
                   7220: // ]]>
                   7221: </script>
                   7222: ENDPROGRESS
                   7223: }
                   7224: 
                   7225: sub LCprogressbarUpdate_script {
                   7226:    return(<<ENDPROGRESSUPDATE);
                   7227: <style type="text/css">
                   7228: .ui-progressbar { position:relative; }
                   7229: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   7230: </style>
                   7231: <script type="text/javascript">
                   7232: // <![CDATA[
1.1045    www      7233: var LCprogressTxt='---';
                   7234: 
                   7235: function LCupdateProgress(percent,progresstext,id) {
1.1041    www      7236:    LCprogressTxt=progresstext;
1.1045    www      7237:    \$('#progressbar'+id).progressbar('value',percent);
1.1041    www      7238: }
                   7239: // ]]>
                   7240: </script>
                   7241: ENDPROGRESSUPDATE
                   7242: }
                   7243: 
1.1042    www      7244: my $LClastpercent;
1.1045    www      7245: my $LCidcnt;
                   7246: my $LCcurrentid;
1.1042    www      7247: 
1.1041    www      7248: sub LCprogressbar {
1.1042    www      7249:     my ($r)=(@_);
                   7250:     $LClastpercent=0;
1.1045    www      7251:     $LCidcnt++;
                   7252:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1041    www      7253:     my $starting=&mt('Starting');
                   7254:     my $content=(<<ENDPROGBAR);
                   7255: <p>
1.1045    www      7256:   <div id="progressbar$LCcurrentid">
1.1041    www      7257:     <span class="pblabel">$starting</span>
                   7258:   </div>
                   7259: </p>
                   7260: ENDPROGBAR
1.1045    www      7261:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041    www      7262: }
                   7263: 
                   7264: sub LCprogressbarUpdate {
1.1042    www      7265:     my ($r,$val,$text)=@_;
                   7266:     unless ($val) { 
                   7267:        if ($LClastpercent) {
                   7268:            $val=$LClastpercent;
                   7269:        } else {
                   7270:            $val=0;
                   7271:        }
                   7272:     }
1.1041    www      7273:     if ($val<0) { $val=0; }
                   7274:     if ($val>100) { $val=0; }
1.1042    www      7275:     $LClastpercent=$val;
1.1041    www      7276:     unless ($text) { $text=$val.'%'; }
                   7277:     $text=&js_ready($text);
1.1044    www      7278:     &r_print($r,<<ENDUPDATE);
1.1041    www      7279: <script type="text/javascript">
                   7280: // <![CDATA[
1.1045    www      7281: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041    www      7282: // ]]>
                   7283: </script>
                   7284: ENDUPDATE
1.1035    www      7285: }
                   7286: 
1.1042    www      7287: sub LCprogressbarClose {
                   7288:     my ($r)=@_;
                   7289:     $LClastpercent=0;
1.1044    www      7290:     &r_print($r,<<ENDCLOSE);
1.1042    www      7291: <script type="text/javascript">
                   7292: // <![CDATA[
1.1045    www      7293: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      7294: // ]]>
                   7295: </script>
                   7296: ENDCLOSE
1.1044    www      7297: }
                   7298: 
                   7299: sub r_print {
                   7300:     my ($r,$to_print)=@_;
                   7301:     if ($r) {
                   7302:       $r->print($to_print);
                   7303:       $r->rflush();
                   7304:     } else {
                   7305:       print($to_print);
                   7306:     }
1.1042    www      7307: }
                   7308: 
1.320     albertel 7309: sub html_encode {
                   7310:     my ($result) = @_;
                   7311: 
1.322     albertel 7312:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 7313:     
                   7314:     return $result;
                   7315: }
1.1044    www      7316: 
1.317     albertel 7317: sub js_ready {
                   7318:     my ($result) = @_;
                   7319: 
1.323     albertel 7320:     $result =~ s/[\n\r]/ /xmsg;
                   7321:     $result =~ s/\\/\\\\/xmsg;
                   7322:     $result =~ s/'/\\'/xmsg;
1.372     albertel 7323:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 7324:     
                   7325:     return $result;
                   7326: }
                   7327: 
1.315     albertel 7328: sub validate_page {
                   7329:     if (  exists($env{'internal.start_page'})
1.316     albertel 7330: 	  &&     $env{'internal.start_page'} > 1) {
                   7331: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 7332: 				 $env{'internal.start_page'}.' '.
1.316     albertel 7333: 				 $ENV{'request.filename'});
1.315     albertel 7334:     }
                   7335:     if (  exists($env{'internal.end_page'})
1.316     albertel 7336: 	  &&     $env{'internal.end_page'} > 1) {
                   7337: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 7338: 				 $env{'internal.end_page'}.' '.
1.316     albertel 7339: 				 $env{'request.filename'});
1.315     albertel 7340:     }
                   7341:     if (     exists($env{'internal.start_page'})
                   7342: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 7343: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   7344: 				 $env{'request.filename'});
1.315     albertel 7345:     }
                   7346:     if (   ! exists($env{'internal.start_page'})
                   7347: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 7348: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   7349: 				 $env{'request.filename'});
1.315     albertel 7350:     }
1.306     albertel 7351: }
1.315     albertel 7352: 
1.996     www      7353: 
                   7354: sub start_scrollbox {
1.1018    raeburn  7355:     my ($outerwidth,$width,$height,$id)=@_;
1.998     raeburn  7356:     unless ($outerwidth) { $outerwidth='520px'; }
                   7357:     unless ($width) { $width='500px'; }
                   7358:     unless ($height) { $height='200px'; }
1.1020    raeburn  7359:     my ($table_id,$div_id);
1.1018    raeburn  7360:     if ($id ne '') {
1.1020    raeburn  7361:         $table_id = " id='table_$id'";
                   7362:         $div_id = " id='div_$id'";
1.1018    raeburn  7363:     }
1.1020    raeburn  7364:     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      7365: }
                   7366: 
                   7367: sub end_scrollbox {
1.1036    www      7368:     return '</div></td></tr></table>';
1.996     www      7369: }
                   7370: 
1.318     albertel 7371: sub simple_error_page {
                   7372:     my ($r,$title,$msg) = @_;
                   7373:     my $page =
                   7374: 	&Apache::loncommon::start_page($title).
                   7375: 	&mt($msg).
                   7376: 	&Apache::loncommon::end_page();
                   7377:     if (ref($r)) {
                   7378: 	$r->print($page);
1.327     albertel 7379: 	return;
1.318     albertel 7380:     }
                   7381:     return $page;
                   7382: }
1.347     albertel 7383: 
                   7384: {
1.610     albertel 7385:     my @row_count;
1.961     onken    7386: 
                   7387:     sub start_data_table_count {
                   7388:         unshift(@row_count, 0);
                   7389:         return;
                   7390:     }
                   7391: 
                   7392:     sub end_data_table_count {
                   7393:         shift(@row_count);
                   7394:         return;
                   7395:     }
                   7396: 
1.347     albertel 7397:     sub start_data_table {
1.1018    raeburn  7398: 	my ($add_class,$id) = @_;
1.422     albertel 7399: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  7400:         my $table_id;
                   7401:         if (defined($id)) {
                   7402:             $table_id = ' id="'.$id.'"';
                   7403:         }
1.961     onken    7404: 	&start_data_table_count();
1.1018    raeburn  7405: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 7406:     }
                   7407: 
                   7408:     sub end_data_table {
1.961     onken    7409: 	&end_data_table_count();
1.389     albertel 7410: 	return '</table>'."\n";;
1.347     albertel 7411:     }
                   7412: 
                   7413:     sub start_data_table_row {
1.974     wenzelju 7414: 	my ($add_class, $id) = @_;
1.610     albertel 7415: 	$row_count[0]++;
                   7416: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   7417: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 7418:         $id = (' id="'.$id.'"') unless ($id eq '');
                   7419:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 7420:     }
1.471     banghart 7421:     
                   7422:     sub continue_data_table_row {
1.974     wenzelju 7423: 	my ($add_class, $id) = @_;
1.610     albertel 7424: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 7425: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   7426:         $id = (' id="'.$id.'"') unless ($id eq '');
                   7427:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 7428:     }
1.347     albertel 7429: 
                   7430:     sub end_data_table_row {
1.389     albertel 7431: 	return '</tr>'."\n";;
1.347     albertel 7432:     }
1.367     www      7433: 
1.421     albertel 7434:     sub start_data_table_empty_row {
1.707     bisitz   7435: #	$row_count[0]++;
1.421     albertel 7436: 	return  '<tr class="LC_empty_row" >'."\n";;
                   7437:     }
                   7438: 
                   7439:     sub end_data_table_empty_row {
                   7440: 	return '</tr>'."\n";;
                   7441:     }
                   7442: 
1.367     www      7443:     sub start_data_table_header_row {
1.389     albertel 7444: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      7445:     }
                   7446: 
                   7447:     sub end_data_table_header_row {
1.389     albertel 7448: 	return '</tr>'."\n";;
1.367     www      7449:     }
1.890     droeschl 7450: 
                   7451:     sub data_table_caption {
                   7452:         my $caption = shift;
                   7453:         return "<caption class=\"LC_caption\">$caption</caption>";
                   7454:     }
1.347     albertel 7455: }
                   7456: 
1.548     albertel 7457: =pod
                   7458: 
                   7459: =item * &inhibit_menu_check($arg)
                   7460: 
                   7461: Checks for a inhibitmenu state and generates output to preserve it
                   7462: 
                   7463: Inputs:         $arg - can be any of
                   7464:                      - undef - in which case the return value is a string 
                   7465:                                to add  into arguments list of a uri
                   7466:                      - 'input' - in which case the return value is a HTML
                   7467:                                  <form> <input> field of type hidden to
                   7468:                                  preserve the value
                   7469:                      - a url - in which case the return value is the url with
                   7470:                                the neccesary cgi args added to preserve the
                   7471:                                inhibitmenu state
                   7472:                      - a ref to a url - no return value, but the string is
                   7473:                                         updated to include the neccessary cgi
                   7474:                                         args to preserve the inhibitmenu state
                   7475: 
                   7476: =cut
                   7477: 
                   7478: sub inhibit_menu_check {
                   7479:     my ($arg) = @_;
                   7480:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   7481:     if ($arg eq 'input') {
                   7482: 	if ($env{'form.inhibitmenu'}) {
                   7483: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   7484: 	} else {
                   7485: 	    return
                   7486: 	}
                   7487:     }
                   7488:     if ($env{'form.inhibitmenu'}) {
                   7489: 	if (ref($arg)) {
                   7490: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7491: 	} elsif ($arg eq '') {
                   7492: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   7493: 	} else {
                   7494: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7495: 	}
                   7496:     }
                   7497:     if (!ref($arg)) {
                   7498: 	return $arg;
                   7499:     }
                   7500: }
                   7501: 
1.251     albertel 7502: ###############################################
1.182     matthew  7503: 
                   7504: =pod
                   7505: 
1.549     albertel 7506: =back
                   7507: 
                   7508: =head1 User Information Routines
                   7509: 
                   7510: =over 4
                   7511: 
1.405     albertel 7512: =item * &get_users_function()
1.182     matthew  7513: 
                   7514: Used by &bodytag to determine the current users primary role.
                   7515: Returns either 'student','coordinator','admin', or 'author'.
                   7516: 
                   7517: =cut
                   7518: 
                   7519: ###############################################
                   7520: sub get_users_function {
1.815     tempelho 7521:     my $function = 'norole';
1.818     tempelho 7522:     if ($env{'request.role'}=~/^(st)/) {
                   7523:         $function='student';
                   7524:     }
1.907     raeburn  7525:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  7526:         $function='coordinator';
                   7527:     }
1.258     albertel 7528:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  7529:         $function='admin';
                   7530:     }
1.826     bisitz   7531:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  7532:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  7533:         $function='author';
                   7534:     }
                   7535:     return $function;
1.54      www      7536: }
1.99      www      7537: 
                   7538: ###############################################
                   7539: 
1.233     raeburn  7540: =pod
                   7541: 
1.821     raeburn  7542: =item * &show_course()
                   7543: 
                   7544: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   7545: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   7546: 
                   7547: Inputs:
                   7548: None
                   7549: 
                   7550: Outputs:
                   7551: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   7552: 
                   7553: =cut
                   7554: 
                   7555: ###############################################
                   7556: sub show_course {
                   7557:     my $course = !$env{'user.adv'};
                   7558:     if (!$env{'user.adv'}) {
                   7559:         foreach my $env (keys(%env)) {
                   7560:             next if ($env !~ m/^user\.priv\./);
                   7561:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   7562:                 $course = 0;
                   7563:                 last;
                   7564:             }
                   7565:         }
                   7566:     }
                   7567:     return $course;
                   7568: }
                   7569: 
                   7570: ###############################################
                   7571: 
                   7572: =pod
                   7573: 
1.542     raeburn  7574: =item * &check_user_status()
1.274     raeburn  7575: 
                   7576: Determines current status of supplied role for a
                   7577: specific user. Roles can be active, previous or future.
                   7578: 
                   7579: Inputs: 
                   7580: user's domain, user's username, course's domain,
1.375     raeburn  7581: course's number, optional section ID.
1.274     raeburn  7582: 
                   7583: Outputs:
                   7584: role status: active, previous or future. 
                   7585: 
                   7586: =cut
                   7587: 
                   7588: sub check_user_status {
1.412     raeburn  7589:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.982     raeburn  7590:     my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
                   7591:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,$extra);
1.274     raeburn  7592:     my @uroles = keys %userinfo;
                   7593:     my $srchstr;
                   7594:     my $active_chk = 'none';
1.412     raeburn  7595:     my $now = time;
1.274     raeburn  7596:     if (@uroles > 0) {
1.908     raeburn  7597:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  7598:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   7599:         } else {
1.412     raeburn  7600:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   7601:         }
                   7602:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  7603:             my $role_end = 0;
                   7604:             my $role_start = 0;
                   7605:             $active_chk = 'active';
1.412     raeburn  7606:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   7607:                 $role_end = $1;
                   7608:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   7609:                     $role_start = $1;
1.274     raeburn  7610:                 }
                   7611:             }
                   7612:             if ($role_start > 0) {
1.412     raeburn  7613:                 if ($now < $role_start) {
1.274     raeburn  7614:                     $active_chk = 'future';
                   7615:                 }
                   7616:             }
                   7617:             if ($role_end > 0) {
1.412     raeburn  7618:                 if ($now > $role_end) {
1.274     raeburn  7619:                     $active_chk = 'previous';
                   7620:                 }
                   7621:             }
                   7622:         }
                   7623:     }
                   7624:     return $active_chk;
                   7625: }
                   7626: 
                   7627: ###############################################
                   7628: 
                   7629: =pod
                   7630: 
1.405     albertel 7631: =item * &get_sections()
1.233     raeburn  7632: 
                   7633: Determines all the sections for a course including
                   7634: sections with students and sections containing other roles.
1.419     raeburn  7635: Incoming parameters: 
                   7636: 
                   7637: 1. domain
                   7638: 2. course number 
                   7639: 3. reference to array containing roles for which sections should 
                   7640: be gathered (optional).
                   7641: 4. reference to array containing status types for which sections 
                   7642: should be gathered (optional).
                   7643: 
                   7644: If the third argument is undefined, sections are gathered for any role. 
                   7645: If the fourth argument is undefined, sections are gathered for any status.
                   7646: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  7647:  
1.374     raeburn  7648: Returns section hash (keys are section IDs, values are
                   7649: number of users in each section), subject to the
1.419     raeburn  7650: optional roles filter, optional status filter 
1.233     raeburn  7651: 
                   7652: =cut
                   7653: 
                   7654: ###############################################
                   7655: sub get_sections {
1.419     raeburn  7656:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 7657:     if (!defined($cdom) || !defined($cnum)) {
                   7658:         my $cid =  $env{'request.course.id'};
                   7659: 
                   7660: 	return if (!defined($cid));
                   7661: 
                   7662:         $cdom = $env{'course.'.$cid.'.domain'};
                   7663:         $cnum = $env{'course.'.$cid.'.num'};
                   7664:     }
                   7665: 
                   7666:     my %sectioncount;
1.419     raeburn  7667:     my $now = time;
1.240     albertel 7668: 
1.366     albertel 7669:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 7670: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 7671: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   7672: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  7673:         my $start_index = &Apache::loncoursedata::CL_START();
                   7674:         my $end_index = &Apache::loncoursedata::CL_END();
                   7675:         my $status;
1.366     albertel 7676: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  7677: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   7678: 				                     $data->[$status_index],
                   7679:                                                      $data->[$start_index],
                   7680:                                                      $data->[$end_index]);
                   7681:             if ($stu_status eq 'Active') {
                   7682:                 $status = 'active';
                   7683:             } elsif ($end < $now) {
                   7684:                 $status = 'previous';
                   7685:             } elsif ($start > $now) {
                   7686:                 $status = 'future';
                   7687:             } 
                   7688: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7689:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7690:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7691: 		    $sectioncount{$section}++;
                   7692:                 }
1.240     albertel 7693: 	    }
                   7694: 	}
                   7695:     }
                   7696:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7697:     foreach my $user (sort(keys(%courseroles))) {
                   7698: 	if ($user !~ /^(\w{2})/) { next; }
                   7699: 	my ($role) = ($user =~ /^(\w{2})/);
                   7700: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7701: 	my ($section,$status);
1.240     albertel 7702: 	if ($role eq 'cr' &&
                   7703: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7704: 	    $section=$1;
                   7705: 	}
                   7706: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7707: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7708:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7709:         if ($end == -1 && $start == -1) {
                   7710:             next; #deleted role
                   7711:         }
                   7712:         if (!defined($possible_status)) { 
                   7713:             $sectioncount{$section}++;
                   7714:         } else {
                   7715:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7716:                 $status = 'active';
                   7717:             } elsif ($end < $now) {
                   7718:                 $status = 'future';
                   7719:             } elsif ($start > $now) {
                   7720:                 $status = 'previous';
                   7721:             }
                   7722:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7723:                 $sectioncount{$section}++;
                   7724:             }
                   7725:         }
1.233     raeburn  7726:     }
1.366     albertel 7727:     return %sectioncount;
1.233     raeburn  7728: }
                   7729: 
1.274     raeburn  7730: ###############################################
1.294     raeburn  7731: 
                   7732: =pod
1.405     albertel 7733: 
                   7734: =item * &get_course_users()
                   7735: 
1.275     raeburn  7736: Retrieves usernames:domains for users in the specified course
                   7737: with specific role(s), and access status. 
                   7738: 
                   7739: Incoming parameters:
1.277     albertel 7740: 1. course domain
                   7741: 2. course number
                   7742: 3. access status: users must have - either active, 
1.275     raeburn  7743: previous, future, or all.
1.277     albertel 7744: 4. reference to array of permissible roles
1.288     raeburn  7745: 5. reference to array of section restrictions (optional)
                   7746: 6. reference to results object (hash of hashes).
                   7747: 7. reference to optional userdata hash
1.609     raeburn  7748: 8. reference to optional statushash
1.630     raeburn  7749: 9. flag if privileged users (except those set to unhide in
                   7750:    course settings) should be excluded    
1.609     raeburn  7751: Keys of top level results hash are roles.
1.275     raeburn  7752: Keys of inner hashes are username:domain, with 
                   7753: values set to access type.
1.288     raeburn  7754: Optional userdata hash returns an array with arguments in the 
                   7755: same order as loncoursedata::get_classlist() for student data.
                   7756: 
1.609     raeburn  7757: Optional statushash returns
                   7758: 
1.288     raeburn  7759: Entries for end, start, section and status are blank because
                   7760: of the possibility of multiple values for non-student roles.
                   7761: 
1.275     raeburn  7762: =cut
1.405     albertel 7763: 
1.275     raeburn  7764: ###############################################
1.405     albertel 7765: 
1.275     raeburn  7766: sub get_course_users {
1.630     raeburn  7767:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7768:     my %idx = ();
1.419     raeburn  7769:     my %seclists;
1.288     raeburn  7770: 
                   7771:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7772:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7773:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7774:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7775:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7776:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7777:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7778:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7779: 
1.290     albertel 7780:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7781:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7782:         my $now = time;
1.277     albertel 7783:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7784:             my $match = 0;
1.412     raeburn  7785:             my $secmatch = 0;
1.419     raeburn  7786:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7787:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7788:             if ($section eq '') {
                   7789:                 $section = 'none';
                   7790:             }
1.291     albertel 7791:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7792:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7793:                     $secmatch = 1;
                   7794:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7795:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7796:                         $secmatch = 1;
                   7797:                     }
                   7798:                 } else {  
1.419     raeburn  7799: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7800: 		        $secmatch = 1;
                   7801:                     }
1.290     albertel 7802: 		}
1.412     raeburn  7803:                 if (!$secmatch) {
                   7804:                     next;
                   7805:                 }
1.419     raeburn  7806:             }
1.275     raeburn  7807:             if (defined($$types{'active'})) {
1.288     raeburn  7808:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7809:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7810:                     $match = 1;
1.275     raeburn  7811:                 }
                   7812:             }
                   7813:             if (defined($$types{'previous'})) {
1.609     raeburn  7814:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7815:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7816:                     $match = 1;
1.275     raeburn  7817:                 }
                   7818:             }
                   7819:             if (defined($$types{'future'})) {
1.609     raeburn  7820:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7821:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7822:                     $match = 1;
1.275     raeburn  7823:                 }
                   7824:             }
1.609     raeburn  7825:             if ($match) {
                   7826:                 push(@{$seclists{$student}},$section);
                   7827:                 if (ref($userdata) eq 'HASH') {
                   7828:                     $$userdata{$student} = $$classlist{$student};
                   7829:                 }
                   7830:                 if (ref($statushash) eq 'HASH') {
                   7831:                     $statushash->{$student}{'st'}{$section} = $status;
                   7832:                 }
1.288     raeburn  7833:             }
1.275     raeburn  7834:         }
                   7835:     }
1.412     raeburn  7836:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7837:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7838:         my $now = time;
1.609     raeburn  7839:         my %displaystatus = ( previous => 'Expired',
                   7840:                               active   => 'Active',
                   7841:                               future   => 'Future',
                   7842:                             );
1.630     raeburn  7843:         my %nothide;
                   7844:         if ($hidepriv) {
                   7845:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7846:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7847:                 if ($user !~ /:/) {
                   7848:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7849:                 } else {
                   7850:                     $nothide{$user} = 1;
                   7851:                 }
                   7852:             }
                   7853:         }
1.439     raeburn  7854:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7855:             my $match = 0;
1.412     raeburn  7856:             my $secmatch = 0;
1.439     raeburn  7857:             my $status;
1.412     raeburn  7858:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7859:             $user =~ s/:$//;
1.439     raeburn  7860:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7861:             if ($end == -1 || $start == -1) {
                   7862:                 next;
                   7863:             }
                   7864:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7865:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7866:                 my ($uname,$udom) = split(/:/,$user);
                   7867:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7868:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7869:                         $secmatch = 1;
                   7870:                     } elsif ($usec eq '') {
1.420     albertel 7871:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7872:                             $secmatch = 1;
                   7873:                         }
                   7874:                     } else {
                   7875:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7876:                             $secmatch = 1;
                   7877:                         }
                   7878:                     }
                   7879:                     if (!$secmatch) {
                   7880:                         next;
                   7881:                     }
1.288     raeburn  7882:                 }
1.419     raeburn  7883:                 if ($usec eq '') {
                   7884:                     $usec = 'none';
                   7885:                 }
1.275     raeburn  7886:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7887:                     if ($hidepriv) {
                   7888:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7889:                             (!$nothide{$uname.':'.$udom})) {
                   7890:                             next;
                   7891:                         }
                   7892:                     }
1.503     raeburn  7893:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7894:                         $status = 'previous';
                   7895:                     } elsif ($start > $now) {
                   7896:                         $status = 'future';
                   7897:                     } else {
                   7898:                         $status = 'active';
                   7899:                     }
1.277     albertel 7900:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7901:                         if ($status eq $type) {
1.420     albertel 7902:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7903:                                 push(@{$$users{$role}{$user}},$type);
                   7904:                             }
1.288     raeburn  7905:                             $match = 1;
                   7906:                         }
                   7907:                     }
1.419     raeburn  7908:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7909:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7910: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7911:                         }
1.420     albertel 7912:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7913:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7914:                         }
1.609     raeburn  7915:                         if (ref($statushash) eq 'HASH') {
                   7916:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7917:                         }
1.275     raeburn  7918:                     }
                   7919:                 }
                   7920:             }
                   7921:         }
1.290     albertel 7922:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7923:             if ((defined($cdom)) && (defined($cnum))) {
                   7924:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7925:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7926:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7927:                     next if ($owner eq '');
                   7928:                     my ($ownername,$ownerdom);
                   7929:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7930:                         $ownername = $1;
                   7931:                         $ownerdom = $2;
                   7932:                     } else {
                   7933:                         $ownername = $owner;
                   7934:                         $ownerdom = $cdom;
                   7935:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7936:                     }
                   7937:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7938:                     if (defined($userdata) && 
1.609     raeburn  7939: 			!exists($$userdata{$owner})) {
                   7940: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7941:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7942:                             push(@{$seclists{$owner}},'none');
                   7943:                         }
                   7944:                         if (ref($statushash) eq 'HASH') {
                   7945:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7946:                         }
1.290     albertel 7947: 		    }
1.279     raeburn  7948:                 }
                   7949:             }
                   7950:         }
1.419     raeburn  7951:         foreach my $user (keys(%seclists)) {
                   7952:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7953:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7954:         }
1.275     raeburn  7955:     }
                   7956:     return;
                   7957: }
                   7958: 
1.288     raeburn  7959: sub get_user_info {
                   7960:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7961:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7962: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7963:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7964:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7965:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7966:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7967:     return;
                   7968: }
1.275     raeburn  7969: 
1.472     raeburn  7970: ###############################################
                   7971: 
                   7972: =pod
                   7973: 
                   7974: =item * &get_user_quota()
                   7975: 
                   7976: Retrieves quota assigned for storage of portfolio files for a user  
                   7977: 
                   7978: Incoming parameters:
                   7979: 1. user's username
                   7980: 2. user's domain
                   7981: 
                   7982: Returns:
1.536     raeburn  7983: 1. Disk quota (in Mb) assigned to student.
                   7984: 2. (Optional) Type of setting: custom or default
                   7985:    (individually assigned or default for user's 
                   7986:    institutional status).
                   7987: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7988:    or student - types as defined in localenroll::inst_usertypes 
                   7989:    for user's domain, which determines default quota for user.
                   7990: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7991: 
                   7992: If a value has been stored in the user's environment, 
1.536     raeburn  7993: it will return that, otherwise it returns the maximal default
                   7994: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7995: 
                   7996: =cut
                   7997: 
                   7998: ###############################################
                   7999: 
                   8000: 
                   8001: sub get_user_quota {
                   8002:     my ($uname,$udom) = @_;
1.536     raeburn  8003:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  8004:     if (!defined($udom)) {
                   8005:         $udom = $env{'user.domain'};
                   8006:     }
                   8007:     if (!defined($uname)) {
                   8008:         $uname = $env{'user.name'};
                   8009:     }
                   8010:     if (($udom eq '' || $uname eq '') ||
                   8011:         ($udom eq 'public') && ($uname eq 'public')) {
                   8012:         $quota = 0;
1.536     raeburn  8013:         $quotatype = 'default';
                   8014:         $defquota = 0; 
1.472     raeburn  8015:     } else {
1.536     raeburn  8016:         my $inststatus;
1.472     raeburn  8017:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   8018:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  8019:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  8020:         } else {
1.536     raeburn  8021:             my %userenv = 
                   8022:                 &Apache::lonnet::get('environment',['portfolioquota',
                   8023:                                      'inststatus'],$udom,$uname);
1.472     raeburn  8024:             my ($tmp) = keys(%userenv);
                   8025:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   8026:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  8027:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  8028:             } else {
                   8029:                 undef(%userenv);
                   8030:             }
                   8031:         }
1.536     raeburn  8032:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  8033:         if ($quota eq '') {
1.536     raeburn  8034:             $quota = $defquota;
                   8035:             $quotatype = 'default';
                   8036:         } else {
                   8037:             $quotatype = 'custom';
1.472     raeburn  8038:         }
                   8039:     }
1.536     raeburn  8040:     if (wantarray) {
                   8041:         return ($quota,$quotatype,$settingstatus,$defquota);
                   8042:     } else {
                   8043:         return $quota;
                   8044:     }
1.472     raeburn  8045: }
                   8046: 
                   8047: ###############################################
                   8048: 
                   8049: =pod
                   8050: 
                   8051: =item * &default_quota()
                   8052: 
1.536     raeburn  8053: Retrieves default quota assigned for storage of user portfolio files,
                   8054: given an (optional) user's institutional status.
1.472     raeburn  8055: 
                   8056: Incoming parameters:
                   8057: 1. domain
1.536     raeburn  8058: 2. (Optional) institutional status(es).  This is a : separated list of 
                   8059:    status types (e.g., faculty, staff, student etc.)
                   8060:    which apply to the user for whom the default is being retrieved.
                   8061:    If the institutional status string in undefined, the domain
                   8062:    default quota will be returned. 
1.472     raeburn  8063: 
                   8064: Returns:
                   8065: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  8066: 2. (Optional) institutional type which determined the value of the
                   8067:    default quota.
1.472     raeburn  8068: 
                   8069: If a value has been stored in the domain's configuration db,
                   8070: it will return that, otherwise it returns 20 (for backwards 
                   8071: compatibility with domains which have not set up a configuration
                   8072: db file; the original statically defined portfolio quota was 20 Mb). 
                   8073: 
1.536     raeburn  8074: If the user's status includes multiple types (e.g., staff and student),
                   8075: the largest default quota which applies to the user determines the
                   8076: default quota returned.
                   8077: 
1.780     raeburn  8078: =back
                   8079: 
1.472     raeburn  8080: =cut
                   8081: 
                   8082: ###############################################
                   8083: 
                   8084: 
                   8085: sub default_quota {
1.536     raeburn  8086:     my ($udom,$inststatus) = @_;
                   8087:     my ($defquota,$settingstatus);
                   8088:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  8089:                                             ['quotas'],$udom);
                   8090:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  8091:         if ($inststatus ne '') {
1.765     raeburn  8092:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  8093:             foreach my $item (@statuses) {
1.711     raeburn  8094:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   8095:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   8096:                         if ($defquota eq '') {
                   8097:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   8098:                             $settingstatus = $item;
                   8099:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   8100:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   8101:                             $settingstatus = $item;
                   8102:                         }
                   8103:                     }
                   8104:                 } else {
                   8105:                     if ($quotahash{'quotas'}{$item} ne '') {
                   8106:                         if ($defquota eq '') {
                   8107:                             $defquota = $quotahash{'quotas'}{$item};
                   8108:                             $settingstatus = $item;
                   8109:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   8110:                             $defquota = $quotahash{'quotas'}{$item};
                   8111:                             $settingstatus = $item;
                   8112:                         }
1.536     raeburn  8113:                     }
                   8114:                 }
                   8115:             }
                   8116:         }
                   8117:         if ($defquota eq '') {
1.711     raeburn  8118:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   8119:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   8120:             } else {
                   8121:                 $defquota = $quotahash{'quotas'}{'default'};
                   8122:             }
1.536     raeburn  8123:             $settingstatus = 'default';
                   8124:         }
                   8125:     } else {
                   8126:         $settingstatus = 'default';
                   8127:         $defquota = 20;
                   8128:     }
                   8129:     if (wantarray) {
                   8130:         return ($defquota,$settingstatus);
1.472     raeburn  8131:     } else {
1.536     raeburn  8132:         return $defquota;
1.472     raeburn  8133:     }
                   8134: }
                   8135: 
1.384     raeburn  8136: sub get_secgrprole_info {
                   8137:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   8138:     my %sections_count = &get_sections($cdom,$cnum);
                   8139:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   8140:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   8141:     my @groups = sort(keys(%curr_groups));
                   8142:     my $allroles = [];
                   8143:     my $rolehash;
                   8144:     my $accesshash = {
                   8145:                      active => 'Currently has access',
                   8146:                      future => 'Will have future access',
                   8147:                      previous => 'Previously had access',
                   8148:                   };
                   8149:     if ($needroles) {
                   8150:         $rolehash = {'all' => 'all'};
1.385     albertel 8151:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   8152: 	if (&Apache::lonnet::error(%user_roles)) {
                   8153: 	    undef(%user_roles);
                   8154: 	}
                   8155:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  8156:             my ($role)=split(/\:/,$item,2);
                   8157:             if ($role eq 'cr') { next; }
                   8158:             if ($role =~ /^cr/) {
                   8159:                 $$rolehash{$role} = (split('/',$role))[3];
                   8160:             } else {
                   8161:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   8162:             }
                   8163:         }
                   8164:         foreach my $key (sort(keys(%{$rolehash}))) {
                   8165:             push(@{$allroles},$key);
                   8166:         }
                   8167:         push (@{$allroles},'st');
                   8168:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   8169:     }
                   8170:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   8171: }
                   8172: 
1.555     raeburn  8173: sub user_picker {
1.994     raeburn  8174:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555     raeburn  8175:     my $currdom = $dom;
                   8176:     my %curr_selected = (
                   8177:                         srchin => 'dom',
1.580     raeburn  8178:                         srchby => 'lastname',
1.555     raeburn  8179:                       );
                   8180:     my $srchterm;
1.625     raeburn  8181:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  8182:         if ($srch->{'srchby'} ne '') {
                   8183:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   8184:         }
                   8185:         if ($srch->{'srchin'} ne '') {
                   8186:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   8187:         }
                   8188:         if ($srch->{'srchtype'} ne '') {
                   8189:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   8190:         }
                   8191:         if ($srch->{'srchdomain'} ne '') {
                   8192:             $currdom = $srch->{'srchdomain'};
                   8193:         }
                   8194:         $srchterm = $srch->{'srchterm'};
                   8195:     }
                   8196:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  8197:                     'usr'       => 'Search criteria',
1.563     raeburn  8198:                     'doma'      => 'Domain/institution to search',
1.558     albertel 8199:                     'uname'     => 'username',
                   8200:                     'lastname'  => 'last name',
1.555     raeburn  8201:                     'lastfirst' => 'last name, first name',
1.558     albertel 8202:                     'crs'       => 'in this course',
1.576     raeburn  8203:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 8204:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  8205:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 8206:                     'exact'     => 'is',
                   8207:                     'contains'  => 'contains',
1.569     raeburn  8208:                     'begins'    => 'begins with',
1.571     raeburn  8209:                     'youm'      => "You must include some text to search for.",
                   8210:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   8211:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   8212:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   8213:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   8214:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   8215:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   8216:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  8217:                                        );
1.563     raeburn  8218:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   8219:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  8220: 
                   8221:     my @srchins = ('crs','dom','alc','instd');
                   8222: 
                   8223:     foreach my $option (@srchins) {
                   8224:         # FIXME 'alc' option unavailable until 
                   8225:         #       loncreateuser::print_user_query_page()
                   8226:         #       has been completed.
                   8227:         next if ($option eq 'alc');
1.880     raeburn  8228:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  8229:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  8230:         if ($curr_selected{'srchin'} eq $option) {
                   8231:             $srchinsel .= ' 
                   8232:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8233:         } else {
                   8234:             $srchinsel .= '
                   8235:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8236:         }
1.555     raeburn  8237:     }
1.563     raeburn  8238:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  8239: 
                   8240:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  8241:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  8242:         if ($curr_selected{'srchby'} eq $option) {
                   8243:             $srchbysel .= '
                   8244:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8245:         } else {
                   8246:             $srchbysel .= '
                   8247:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8248:          }
                   8249:     }
                   8250:     $srchbysel .= "\n  </select>\n";
                   8251: 
                   8252:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  8253:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  8254:         if ($curr_selected{'srchtype'} eq $option) {
                   8255:             $srchtypesel .= '
                   8256:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8257:         } else {
                   8258:             $srchtypesel .= '
                   8259:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8260:         }
                   8261:     }
                   8262:     $srchtypesel .= "\n  </select>\n";
                   8263: 
1.558     albertel 8264:     my ($newuserscript,$new_user_create);
1.994     raeburn  8265:     my $context_dom = $env{'request.role.domain'};
                   8266:     if ($context eq 'requestcrs') {
                   8267:         if ($env{'form.coursedom'} ne '') { 
                   8268:             $context_dom = $env{'form.coursedom'};
                   8269:         }
                   8270:     }
1.556     raeburn  8271:     if ($forcenewuser) {
1.576     raeburn  8272:         if (ref($srch) eq 'HASH') {
1.994     raeburn  8273:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  8274:                 if ($cancreate) {
                   8275:                     $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>';
                   8276:                 } else {
1.799     bisitz   8277:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  8278:                     my %usertypetext = (
                   8279:                         official   => 'institutional',
                   8280:                         unofficial => 'non-institutional',
                   8281:                     );
1.799     bisitz   8282:                     $new_user_create = '<p class="LC_warning">'
                   8283:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   8284:                                       .' '
                   8285:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   8286:                                           ,'<a href="'.$helplink.'">','</a>')
                   8287:                                       .'</p><br />';
1.627     raeburn  8288:                 }
1.576     raeburn  8289:             }
                   8290:         }
                   8291: 
1.556     raeburn  8292:         $newuserscript = <<"ENDSCRIPT";
                   8293: 
1.570     raeburn  8294: function setSearch(createnew,callingForm) {
1.556     raeburn  8295:     if (createnew == 1) {
1.570     raeburn  8296:         for (var i=0; i<callingForm.srchby.length; i++) {
                   8297:             if (callingForm.srchby.options[i].value == 'uname') {
                   8298:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  8299:             }
                   8300:         }
1.570     raeburn  8301:         for (var i=0; i<callingForm.srchin.length; i++) {
                   8302:             if ( callingForm.srchin.options[i].value == 'dom') {
                   8303: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  8304:             }
                   8305:         }
1.570     raeburn  8306:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   8307:             if (callingForm.srchtype.options[i].value == 'exact') {
                   8308:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  8309:             }
                   8310:         }
1.570     raeburn  8311:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  8312:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  8313:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  8314:             }
                   8315:         }
                   8316:     }
                   8317: }
                   8318: ENDSCRIPT
1.558     albertel 8319: 
1.556     raeburn  8320:     }
                   8321: 
1.555     raeburn  8322:     my $output = <<"END_BLOCK";
1.556     raeburn  8323: <script type="text/javascript">
1.824     bisitz   8324: // <![CDATA[
1.570     raeburn  8325: function validateEntry(callingForm) {
1.558     albertel 8326: 
1.556     raeburn  8327:     var checkok = 1;
1.558     albertel 8328:     var srchin;
1.570     raeburn  8329:     for (var i=0; i<callingForm.srchin.length; i++) {
                   8330: 	if ( callingForm.srchin[i].checked ) {
                   8331: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 8332: 	}
                   8333:     }
                   8334: 
1.570     raeburn  8335:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   8336:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   8337:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   8338:     var srchterm =  callingForm.srchterm.value;
                   8339:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  8340:     var msg = "";
                   8341: 
                   8342:     if (srchterm == "") {
                   8343:         checkok = 0;
1.571     raeburn  8344:         msg += "$lt{'youm'}\\n";
1.556     raeburn  8345:     }
                   8346: 
1.569     raeburn  8347:     if (srchtype== 'begins') {
                   8348:         if (srchterm.length < 2) {
                   8349:             checkok = 0;
1.571     raeburn  8350:             msg += "$lt{'thte'}\\n";
1.569     raeburn  8351:         }
                   8352:     }
                   8353: 
1.556     raeburn  8354:     if (srchtype== 'contains') {
                   8355:         if (srchterm.length < 3) {
                   8356:             checkok = 0;
1.571     raeburn  8357:             msg += "$lt{'thet'}\\n";
1.556     raeburn  8358:         }
                   8359:     }
                   8360:     if (srchin == 'instd') {
                   8361:         if (srchdomain == '') {
                   8362:             checkok = 0;
1.571     raeburn  8363:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  8364:         }
                   8365:     }
                   8366:     if (srchin == 'dom') {
                   8367:         if (srchdomain == '') {
                   8368:             checkok = 0;
1.571     raeburn  8369:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  8370:         }
                   8371:     }
                   8372:     if (srchby == 'lastfirst') {
                   8373:         if (srchterm.indexOf(",") == -1) {
                   8374:             checkok = 0;
1.571     raeburn  8375:             msg += "$lt{'whus'}\\n";
1.556     raeburn  8376:         }
                   8377:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   8378:             checkok = 0;
1.571     raeburn  8379:             msg += "$lt{'whse'}\\n";
1.556     raeburn  8380:         }
                   8381:     }
                   8382:     if (checkok == 0) {
1.571     raeburn  8383:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  8384:         return;
                   8385:     }
                   8386:     if (checkok == 1) {
1.570     raeburn  8387:         callingForm.submit();
1.556     raeburn  8388:     }
                   8389: }
                   8390: 
                   8391: $newuserscript
                   8392: 
1.824     bisitz   8393: // ]]>
1.556     raeburn  8394: </script>
1.558     albertel 8395: 
                   8396: $new_user_create
                   8397: 
1.555     raeburn  8398: END_BLOCK
1.558     albertel 8399: 
1.876     raeburn  8400:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   8401:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   8402:                $domform.
                   8403:                &Apache::lonhtmlcommon::row_closure().
                   8404:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   8405:                $srchbysel.
                   8406:                $srchtypesel. 
                   8407:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   8408:                $srchinsel.
                   8409:                &Apache::lonhtmlcommon::row_closure(1). 
                   8410:                &Apache::lonhtmlcommon::end_pick_box().
                   8411:                '<br />';
1.555     raeburn  8412:     return $output;
                   8413: }
                   8414: 
1.612     raeburn  8415: sub user_rule_check {
1.615     raeburn  8416:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  8417:     my $response;
                   8418:     if (ref($usershash) eq 'HASH') {
                   8419:         foreach my $user (keys(%{$usershash})) {
                   8420:             my ($uname,$udom) = split(/:/,$user);
                   8421:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  8422:             my ($id,$newuser);
1.612     raeburn  8423:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  8424:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  8425:                 $id = $usershash->{$user}->{'id'};
                   8426:             }
                   8427:             my $inst_response;
                   8428:             if (ref($checks) eq 'HASH') {
                   8429:                 if (defined($checks->{'username'})) {
1.615     raeburn  8430:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  8431:                         &Apache::lonnet::get_instuser($udom,$uname);
                   8432:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  8433:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  8434:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   8435:                 }
1.615     raeburn  8436:             } else {
                   8437:                 ($inst_response,%{$inst_results->{$user}}) =
                   8438:                     &Apache::lonnet::get_instuser($udom,$uname);
                   8439:                 return;
1.612     raeburn  8440:             }
1.615     raeburn  8441:             if (!$got_rules->{$udom}) {
1.612     raeburn  8442:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   8443:                                                   ['usercreation'],$udom);
                   8444:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  8445:                     foreach my $item ('username','id') {
1.612     raeburn  8446:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   8447:                             $$curr_rules{$udom}{$item} = 
                   8448:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  8449:                         }
                   8450:                     }
                   8451:                 }
1.615     raeburn  8452:                 $got_rules->{$udom} = 1;  
1.585     raeburn  8453:             }
1.612     raeburn  8454:             foreach my $item (keys(%{$checks})) {
                   8455:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   8456:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   8457:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   8458:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   8459:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   8460:                                 if ($rule_check{$rule}) {
                   8461:                                     $$rulematch{$user}{$item} = $rule;
                   8462:                                     if ($inst_response eq 'ok') {
1.615     raeburn  8463:                                         if (ref($inst_results) eq 'HASH') {
                   8464:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   8465:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   8466:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   8467:                                                 }
1.612     raeburn  8468:                                             }
                   8469:                                         }
1.615     raeburn  8470:                                     }
                   8471:                                     last;
1.585     raeburn  8472:                                 }
                   8473:                             }
                   8474:                         }
                   8475:                     }
                   8476:                 }
                   8477:             }
                   8478:         }
                   8479:     }
1.612     raeburn  8480:     return;
                   8481: }
                   8482: 
                   8483: sub user_rule_formats {
                   8484:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   8485:     my %text = ( 
                   8486:                  'username' => 'Usernames',
                   8487:                  'id'       => 'IDs',
                   8488:                );
                   8489:     my $output;
                   8490:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   8491:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   8492:         if (@{$ruleorder} > 0) {
                   8493:             $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>';
                   8494:             foreach my $rule (@{$ruleorder}) {
                   8495:                 if (ref($curr_rules) eq 'ARRAY') {
                   8496:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   8497:                         if (ref($rules->{$rule}) eq 'HASH') {
                   8498:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   8499:                                         $rules->{$rule}{'desc'}.'</li>';
                   8500:                         }
                   8501:                     }
                   8502:                 }
                   8503:             }
                   8504:             $output .= '</ul>';
                   8505:         }
                   8506:     }
                   8507:     return $output;
                   8508: }
                   8509: 
                   8510: sub instrule_disallow_msg {
1.615     raeburn  8511:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  8512:     my $response;
                   8513:     my %text = (
                   8514:                   item   => 'username',
                   8515:                   items  => 'usernames',
                   8516:                   match  => 'matches',
                   8517:                   do     => 'does',
                   8518:                   action => 'a username',
                   8519:                   one    => 'one',
                   8520:                );
                   8521:     if ($count > 1) {
                   8522:         $text{'item'} = 'usernames';
                   8523:         $text{'match'} ='match';
                   8524:         $text{'do'} = 'do';
                   8525:         $text{'action'} = 'usernames',
                   8526:         $text{'one'} = 'ones';
                   8527:     }
                   8528:     if ($checkitem eq 'id') {
                   8529:         $text{'items'} = 'IDs';
                   8530:         $text{'item'} = 'ID';
                   8531:         $text{'action'} = 'an ID';
1.615     raeburn  8532:         if ($count > 1) {
                   8533:             $text{'item'} = 'IDs';
                   8534:             $text{'action'} = 'IDs';
                   8535:         }
1.612     raeburn  8536:     }
1.674     bisitz   8537:     $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  8538:     if ($mode eq 'upload') {
                   8539:         if ($checkitem eq 'username') {
                   8540:             $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'}.");
                   8541:         } elsif ($checkitem eq 'id') {
1.674     bisitz   8542:             $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  8543:         }
1.669     raeburn  8544:     } elsif ($mode eq 'selfcreate') {
                   8545:         if ($checkitem eq 'id') {
                   8546:             $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.");
                   8547:         }
1.615     raeburn  8548:     } else {
                   8549:         if ($checkitem eq 'username') {
                   8550:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   8551:         } elsif ($checkitem eq 'id') {
                   8552:             $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.");
                   8553:         }
1.612     raeburn  8554:     }
                   8555:     return $response;
1.585     raeburn  8556: }
                   8557: 
1.624     raeburn  8558: sub personal_data_fieldtitles {
                   8559:     my %fieldtitles = &Apache::lonlocal::texthash (
                   8560:                         id => 'Student/Employee ID',
                   8561:                         permanentemail => 'E-mail address',
                   8562:                         lastname => 'Last Name',
                   8563:                         firstname => 'First Name',
                   8564:                         middlename => 'Middle Name',
                   8565:                         generation => 'Generation',
                   8566:                         gen => 'Generation',
1.765     raeburn  8567:                         inststatus => 'Affiliation',
1.624     raeburn  8568:                    );
                   8569:     return %fieldtitles;
                   8570: }
                   8571: 
1.642     raeburn  8572: sub sorted_inst_types {
                   8573:     my ($dom) = @_;
                   8574:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   8575:     my $othertitle = &mt('All users');
                   8576:     if ($env{'request.course.id'}) {
1.668     raeburn  8577:         $othertitle  = &mt('Any users');
1.642     raeburn  8578:     }
                   8579:     my @types;
                   8580:     if (ref($order) eq 'ARRAY') {
                   8581:         @types = @{$order};
                   8582:     }
                   8583:     if (@types == 0) {
                   8584:         if (ref($usertypes) eq 'HASH') {
                   8585:             @types = sort(keys(%{$usertypes}));
                   8586:         }
                   8587:     }
                   8588:     if (keys(%{$usertypes}) > 0) {
                   8589:         $othertitle = &mt('Other users');
                   8590:     }
                   8591:     return ($othertitle,$usertypes,\@types);
                   8592: }
                   8593: 
1.645     raeburn  8594: sub get_institutional_codes {
                   8595:     my ($settings,$allcourses,$LC_code) = @_;
                   8596: # Get complete list of course sections to update
                   8597:     my @currsections = ();
                   8598:     my @currxlists = ();
                   8599:     my $coursecode = $$settings{'internal.coursecode'};
                   8600: 
                   8601:     if ($$settings{'internal.sectionnums'} ne '') {
                   8602:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   8603:     }
                   8604: 
                   8605:     if ($$settings{'internal.crosslistings'} ne '') {
                   8606:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   8607:     }
                   8608: 
                   8609:     if (@currxlists > 0) {
                   8610:         foreach (@currxlists) {
                   8611:             if (m/^([^:]+):(\w*)$/) {
                   8612:                 unless (grep/^$1$/,@{$allcourses}) {
                   8613:                     push @{$allcourses},$1;
                   8614:                     $$LC_code{$1} = $2;
                   8615:                 }
                   8616:             }
                   8617:         }
                   8618:     }
                   8619:  
                   8620:     if (@currsections > 0) {
                   8621:         foreach (@currsections) {
                   8622:             if (m/^(\w+):(\w*)$/) {
                   8623:                 my $sec = $coursecode.$1;
                   8624:                 my $lc_sec = $2;
                   8625:                 unless (grep/^$sec$/,@{$allcourses}) {
                   8626:                     push @{$allcourses},$sec;
                   8627:                     $$LC_code{$sec} = $lc_sec;
                   8628:                 }
                   8629:             }
                   8630:         }
                   8631:     }
                   8632:     return;
                   8633: }
                   8634: 
1.971     raeburn  8635: sub get_standard_codeitems {
                   8636:     return ('Year','Semester','Department','Number','Section');
                   8637: }
                   8638: 
1.112     bowersj2 8639: =pod
                   8640: 
1.780     raeburn  8641: =head1 Slot Helpers
                   8642: 
                   8643: =over 4
                   8644: 
                   8645: =item * sorted_slots()
                   8646: 
1.1040    raeburn  8647: Sorts an array of slot names in order of an optional sort key,
                   8648: default sort is by slot start time (earliest first). 
1.780     raeburn  8649: 
                   8650: Inputs:
                   8651: 
                   8652: =over 4
                   8653: 
                   8654: slotsarr  - Reference to array of unsorted slot names.
                   8655: 
                   8656: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   8657: 
1.1040    raeburn  8658: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   8659: 
1.549     albertel 8660: =back
                   8661: 
1.780     raeburn  8662: Returns:
                   8663: 
                   8664: =over 4
                   8665: 
1.1040    raeburn  8666: sorted   - An array of slot names sorted by a specified sort key 
                   8667:            (default sort key is start time of the slot).
1.780     raeburn  8668: 
                   8669: =back
                   8670: 
                   8671: =cut
                   8672: 
                   8673: 
                   8674: sub sorted_slots {
1.1040    raeburn  8675:     my ($slotsarr,$slots,$sortkey) = @_;
                   8676:     if ($sortkey eq '') {
                   8677:         $sortkey = 'starttime';
                   8678:     }
1.780     raeburn  8679:     my @sorted;
                   8680:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   8681:         @sorted =
                   8682:             sort {
                   8683:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  8684:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  8685:                      }
                   8686:                      if (ref($slots->{$a})) { return -1;}
                   8687:                      if (ref($slots->{$b})) { return 1;}
                   8688:                      return 0;
                   8689:                  } @{$slotsarr};
                   8690:     }
                   8691:     return @sorted;
                   8692: }
                   8693: 
1.1040    raeburn  8694: =pod
                   8695: 
                   8696: =item * get_future_slots()
                   8697: 
                   8698: Inputs:
                   8699: 
                   8700: =over 4
                   8701: 
                   8702: cnum - course number
                   8703: 
                   8704: cdom - course domain
                   8705: 
                   8706: now - current UNIX time
                   8707: 
                   8708: symb - optional symb
                   8709: 
                   8710: =back
                   8711: 
                   8712: Returns:
                   8713: 
                   8714: =over 4
                   8715: 
                   8716: sorted_reservable - ref to array of student_schedulable slots currently 
                   8717:                     reservable, ordered by end date of reservation period.
                   8718: 
                   8719: reservable_now - ref to hash of student_schedulable slots currently
                   8720:                  reservable.
                   8721: 
                   8722:     Keys in inner hash are:
                   8723:     (a) symb: either blank or symb to which slot use is restricted.
                   8724:     (b) endreserve: end date of reservation period. 
                   8725: 
                   8726: sorted_future - ref to array of student_schedulable slots reservable in
                   8727:                 the future, ordered by start date of reservation period.
                   8728: 
                   8729: future_reservable - ref to hash of student_schedulable slots reservable
                   8730:                     in the future.
                   8731: 
                   8732:     Keys in inner hash are:
                   8733:     (a) symb: either blank or symb to which slot use is restricted.
                   8734:     (b) startreserve:  start date of reservation period.
                   8735: 
                   8736: =back
                   8737: 
                   8738: =cut
                   8739: 
                   8740: sub get_future_slots {
                   8741:     my ($cnum,$cdom,$now,$symb) = @_;
                   8742:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   8743:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   8744:     foreach my $slot (keys(%slots)) {
                   8745:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   8746:         if ($symb) {
                   8747:             next if (($slots{$slot}->{'symb'} ne '') && 
                   8748:                      ($slots{$slot}->{'symb'} ne $symb));
                   8749:         }
                   8750:         if (($slots{$slot}->{'starttime'} > $now) &&
                   8751:             ($slots{$slot}->{'endtime'} > $now)) {
                   8752:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   8753:                 my $userallowed = 0;
                   8754:                 if ($slots{$slot}->{'allowedsections'}) {
                   8755:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   8756:                     if (!defined($env{'request.role.sec'})
                   8757:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   8758:                         $userallowed=1;
                   8759:                     } else {
                   8760:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   8761:                             $userallowed=1;
                   8762:                         }
                   8763:                     }
                   8764:                     unless ($userallowed) {
                   8765:                         if (defined($env{'request.course.groups'})) {
                   8766:                             my @groups = split(/:/,$env{'request.course.groups'});
                   8767:                             foreach my $group (@groups) {
                   8768:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   8769:                                     $userallowed=1;
                   8770:                                     last;
                   8771:                                 }
                   8772:                             }
                   8773:                         }
                   8774:                     }
                   8775:                 }
                   8776:                 if ($slots{$slot}->{'allowedusers'}) {
                   8777:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   8778:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   8779:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   8780:                         $userallowed = 1;
                   8781:                     }
                   8782:                 }
                   8783:                 next unless($userallowed);
                   8784:             }
                   8785:             my $startreserve = $slots{$slot}->{'startreserve'};
                   8786:             my $endreserve = $slots{$slot}->{'endreserve'};
                   8787:             my $symb = $slots{$slot}->{'symb'};
                   8788:             if (($startreserve < $now) &&
                   8789:                 (!$endreserve || $endreserve > $now)) {
                   8790:                 my $lastres = $endreserve;
                   8791:                 if (!$lastres) {
                   8792:                     $lastres = $slots{$slot}->{'starttime'};
                   8793:                 }
                   8794:                 $reservable_now{$slot} = {
                   8795:                                            symb       => $symb,
                   8796:                                            endreserve => $lastres
                   8797:                                          };
                   8798:             } elsif (($startreserve > $now) &&
                   8799:                      (!$endreserve || $endreserve > $startreserve)) {
                   8800:                 $future_reservable{$slot} = {
                   8801:                                               symb         => $symb,
                   8802:                                               startreserve => $startreserve
                   8803:                                             };
                   8804:             }
                   8805:         }
                   8806:     }
                   8807:     my @unsorted_reservable = keys(%reservable_now);
                   8808:     if (@unsorted_reservable > 0) {
                   8809:         @sorted_reservable = 
                   8810:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   8811:     }
                   8812:     my @unsorted_future = keys(%future_reservable);
                   8813:     if (@unsorted_future > 0) {
                   8814:         @sorted_future =
                   8815:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   8816:     }
                   8817:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   8818: }
1.780     raeburn  8819: 
                   8820: =pod
                   8821: 
1.1057  ! foxr     8822: =back
        !          8823: 
1.549     albertel 8824: =head1 HTTP Helpers
                   8825: 
                   8826: =over 4
                   8827: 
1.648     raeburn  8828: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 8829: 
1.258     albertel 8830: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8831: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8832: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8833: 
                   8834: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8835: $possible_names is an ref to an array of form element names.  As an example:
                   8836: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8837: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8838: 
                   8839: =cut
1.1       albertel 8840: 
1.6       albertel 8841: sub get_unprocessed_cgi {
1.25      albertel 8842:   my ($query,$possible_names)= @_;
1.26      matthew  8843:   # $Apache::lonxml::debug=1;
1.356     albertel 8844:   foreach my $pair (split(/&/,$query)) {
                   8845:     my ($name, $value) = split(/=/,$pair);
1.369     www      8846:     $name = &unescape($name);
1.25      albertel 8847:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8848:       $value =~ tr/+/ /;
                   8849:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8850:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8851:     }
1.16      harris41 8852:   }
1.6       albertel 8853: }
                   8854: 
1.112     bowersj2 8855: =pod
                   8856: 
1.648     raeburn  8857: =item * &cacheheader() 
1.112     bowersj2 8858: 
                   8859: returns cache-controlling header code
                   8860: 
                   8861: =cut
                   8862: 
1.7       albertel 8863: sub cacheheader {
1.258     albertel 8864:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8865:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8866:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8867:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8868:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8869:     return $output;
1.7       albertel 8870: }
                   8871: 
1.112     bowersj2 8872: =pod
                   8873: 
1.648     raeburn  8874: =item * &no_cache($r) 
1.112     bowersj2 8875: 
                   8876: specifies header code to not have cache
                   8877: 
                   8878: =cut
                   8879: 
1.9       albertel 8880: sub no_cache {
1.216     albertel 8881:     my ($r) = @_;
                   8882:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8883: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8884:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8885:     $r->no_cache(1);
                   8886:     $r->header_out("Expires" => $date);
                   8887:     $r->header_out("Pragma" => "no-cache");
1.123     www      8888: }
                   8889: 
                   8890: sub content_type {
1.181     albertel 8891:     my ($r,$type,$charset) = @_;
1.299     foxr     8892:     if ($r) {
                   8893: 	#  Note that printout.pl calls this with undef for $r.
                   8894: 	&no_cache($r);
                   8895:     }
1.258     albertel 8896:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8897:     unless ($charset) {
                   8898: 	$charset=&Apache::lonlocal::current_encoding;
                   8899:     }
                   8900:     if ($charset) { $type.='; charset='.$charset; }
                   8901:     if ($r) {
                   8902: 	$r->content_type($type);
                   8903:     } else {
                   8904: 	print("Content-type: $type\n\n");
                   8905:     }
1.9       albertel 8906: }
1.25      albertel 8907: 
1.112     bowersj2 8908: =pod
                   8909: 
1.648     raeburn  8910: =item * &add_to_env($name,$value) 
1.112     bowersj2 8911: 
1.258     albertel 8912: adds $name to the %env hash with value
1.112     bowersj2 8913: $value, if $name already exists, the entry is converted to an array
                   8914: reference and $value is added to the array.
                   8915: 
                   8916: =cut
                   8917: 
1.25      albertel 8918: sub add_to_env {
                   8919:   my ($name,$value)=@_;
1.258     albertel 8920:   if (defined($env{$name})) {
                   8921:     if (ref($env{$name})) {
1.25      albertel 8922:       #already have multiple values
1.258     albertel 8923:       push(@{ $env{$name} },$value);
1.25      albertel 8924:     } else {
                   8925:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8926:       my $first=$env{$name};
                   8927:       undef($env{$name});
                   8928:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8929:     }
                   8930:   } else {
1.258     albertel 8931:     $env{$name}=$value;
1.25      albertel 8932:   }
1.31      albertel 8933: }
1.149     albertel 8934: 
                   8935: =pod
                   8936: 
1.648     raeburn  8937: =item * &get_env_multiple($name) 
1.149     albertel 8938: 
1.258     albertel 8939: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8940: values may be defined and end up as an array ref.
                   8941: 
                   8942: returns an array of values
                   8943: 
                   8944: =cut
                   8945: 
                   8946: sub get_env_multiple {
                   8947:     my ($name) = @_;
                   8948:     my @values;
1.258     albertel 8949:     if (defined($env{$name})) {
1.149     albertel 8950:         # exists is it an array
1.258     albertel 8951:         if (ref($env{$name})) {
                   8952:             @values=@{ $env{$name} };
1.149     albertel 8953:         } else {
1.258     albertel 8954:             $values[0]=$env{$name};
1.149     albertel 8955:         }
                   8956:     }
                   8957:     return(@values);
                   8958: }
                   8959: 
1.660     raeburn  8960: sub ask_for_embedded_content {
                   8961:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.987     raeburn  8962:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges);
1.660     raeburn  8963:     my $num = 0;
1.987     raeburn  8964:     my $numremref = 0;
                   8965:     my $numinvalid = 0;
                   8966:     my $numpathchg = 0;
                   8967:     my $numexisting = 0;
                   8968:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath);
1.984     raeburn  8969:     if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   8970:         my $current_path='/';
                   8971:         if ($env{'form.currentpath'}) {
                   8972:             $current_path = $env{'form.currentpath'};
                   8973:         }
                   8974:         if ($actionurl eq '/adm/coursegrp_portfolio') {
                   8975:             $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8976:             $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
                   8977:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   8978:         } else {
                   8979:             $udom = $env{'user.domain'};
                   8980:             $uname = $env{'user.name'};
                   8981:             $url = '/userfiles/portfolio';
                   8982:         }
1.987     raeburn  8983:         $toplevel = $url.'/';
1.984     raeburn  8984:         $url .= $current_path;
                   8985:         $getpropath = 1;
1.987     raeburn  8986:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   8987:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      8988:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  8989:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  8990:         $toplevel = $url;
1.984     raeburn  8991:         if ($rest ne '') {
1.987     raeburn  8992:             $url .= $rest;
                   8993:         }
                   8994:     } elsif ($actionurl eq '/adm/coursedocs') {
                   8995:         if (ref($args) eq 'HASH') {
                   8996:            $url = $args->{'docs_url'};
                   8997:            $toplevel = $url;
                   8998:         }
                   8999:     }
                   9000:     my $now = time();
                   9001:     foreach my $embed_file (keys(%{$allfiles})) {
                   9002:         my $absolutepath;
                   9003:         if ($embed_file =~ m{^\w+://}) {
                   9004:             $newfiles{$embed_file} = 1;
                   9005:             $mapping{$embed_file} = $embed_file;
                   9006:         } else {
                   9007:             if ($embed_file =~ m{^/}) {
                   9008:                 $absolutepath = $embed_file;
                   9009:                 $embed_file =~ s{^(/+)}{};
                   9010:             }
                   9011:             if ($embed_file =~ m{/}) {
                   9012:                 my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
                   9013:                 $path = &check_for_traversal($path,$url,$toplevel);
                   9014:                 my $item = $fname;
                   9015:                 if ($path ne '') {
                   9016:                     $item = $path.'/'.$fname;
                   9017:                     $subdependencies{$path}{$fname} = 1;
                   9018:                 } else {
                   9019:                     $dependencies{$item} = 1;
                   9020:                 }
                   9021:                 if ($absolutepath) {
                   9022:                     $mapping{$item} = $absolutepath;
                   9023:                 } else {
                   9024:                     $mapping{$item} = $embed_file;
                   9025:                 }
                   9026:             } else {
                   9027:                 $dependencies{$embed_file} = 1;
                   9028:                 if ($absolutepath) {
                   9029:                     $mapping{$embed_file} = $absolutepath;
                   9030:                 } else {
                   9031:                     $mapping{$embed_file} = $embed_file;
                   9032:                 }
                   9033:             }
1.984     raeburn  9034:         }
                   9035:     }
                   9036:     foreach my $path (keys(%subdependencies)) {
                   9037:         my %currsubfile;
                   9038:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  9039:             my ($sublistref,$listerror) =
                   9040:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   9041:             if (ref($sublistref) eq 'ARRAY') {
                   9042:                 foreach my $line (@{$sublistref}) {
                   9043:                     my ($file_name,$rest) = split(/\&/,$line,2);
                   9044:                     $currsubfile{$file_name} = 1;
                   9045:                 }
1.984     raeburn  9046:             }
1.987     raeburn  9047:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  9048:             if (opendir(my $dir,$url.'/'.$path)) {
                   9049:                 my @subdir_list = grep(!/^\./,readdir($dir));
                   9050:                 map {$currsubfile{$_} = 1;} @subdir_list;
                   9051:             }
                   9052:         }
                   9053:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.987     raeburn  9054:             if ($currsubfile{$file}) {
                   9055:                 my $item = $path.'/'.$file;
                   9056:                 unless ($mapping{$item} eq $item) {
                   9057:                     $pathchanges{$item} = 1;
                   9058:                 }
                   9059:                 $existing{$item} = 1;
                   9060:                 $numexisting ++;
                   9061:             } else {
                   9062:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  9063:             }
                   9064:         }
                   9065:     }
1.987     raeburn  9066:     my %currfile;
1.984     raeburn  9067:     if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  9068:         my ($dirlistref,$listerror) =
                   9069:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   9070:         if (ref($dirlistref) eq 'ARRAY') {
                   9071:             foreach my $line (@{$dirlistref}) {
                   9072:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   9073:                 $currfile{$file_name} = 1;
                   9074:             }
1.984     raeburn  9075:         }
1.987     raeburn  9076:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  9077:         if (opendir(my $dir,$url)) {
1.987     raeburn  9078:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  9079:             map {$currfile{$_} = 1;} @dir_list;
                   9080:         }
                   9081:     }
                   9082:     foreach my $file (keys(%dependencies)) {
1.987     raeburn  9083:         if ($currfile{$file}) {
                   9084:             unless ($mapping{$file} eq $file) {
                   9085:                 $pathchanges{$file} = 1;
                   9086:             }
                   9087:             $existing{$file} = 1;
                   9088:             $numexisting ++;
                   9089:         } else {
1.984     raeburn  9090:             $newfiles{$file} = 1;
                   9091:         }
                   9092:     }
                   9093:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.660     raeburn  9094:         $upload_output .= &start_data_table_row().
1.987     raeburn  9095:                           '<td><span class="LC_filename">'.$embed_file.'</span>';
                   9096:         unless ($mapping{$embed_file} eq $embed_file) {
                   9097:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
                   9098:         }
                   9099:         $upload_output .= '</td><td>';
1.660     raeburn  9100:         if ($args->{'ignore_remote_references'}
                   9101:             && $embed_file =~ m{^\w+://}) {
                   9102:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987     raeburn  9103:             $numremref++;
1.660     raeburn  9104:         } elsif ($args->{'error_on_invalid_names'}
                   9105:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   9106: 
1.987     raeburn  9107:             $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
                   9108:             $numinvalid++;
1.660     raeburn  9109:         } else {
1.987     raeburn  9110:             $upload_output .= &embedded_file_element('upload_embedded',$num,
                   9111:                                                      $embed_file,\%mapping,
                   9112:                                                      $allfiles,$codebase);
                   9113:             $num++;
                   9114:         }
                   9115:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   9116:     }
                   9117:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
                   9118:         $upload_output .= &start_data_table_row().
                   9119:                           '<td><span class="LC_filename">'.$embed_file.'</span></td>'.
                   9120:                           '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
                   9121:                           &Apache::loncommon::end_data_table_row()."\n";
                   9122:     }
                   9123:     if ($upload_output) {
                   9124:         $upload_output = &start_data_table().
                   9125:                          $upload_output.
                   9126:                          &end_data_table()."\n";
                   9127:     }
                   9128:     my $applies = 0;
                   9129:     if ($numremref) {
                   9130:         $applies ++;
                   9131:     }
                   9132:     if ($numinvalid) {
                   9133:         $applies ++;
                   9134:     }
                   9135:     if ($numexisting) {
                   9136:         $applies ++;
                   9137:     }
                   9138:     if ($num) {
                   9139:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   9140:                   ' method="post" enctype="multipart/form-data">'."\n".
                   9141:                   $state.
                   9142:                   '<h3>'.&mt('Upload embedded files').
                   9143:                   ':</h3>'.$upload_output.'<br />'."\n".
                   9144:                   '<input type ="hidden" name="number_embedded_items" value="'.
                   9145:                   $num.'" />'."\n";
                   9146:         if ($actionurl eq '') {
                   9147:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   9148:         }
                   9149:     } elsif ($applies) {
                   9150:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   9151:         if ($applies > 1) {
                   9152:             $output .=  
                   9153:                 &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
                   9154:             if ($numremref) {
                   9155:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   9156:             }
                   9157:             if ($numinvalid) {
                   9158:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   9159:             }
                   9160:             if ($numexisting) {
                   9161:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   9162:             }
                   9163:             $output .= '</ul><br />';
                   9164:         } elsif ($numremref) {
                   9165:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   9166:         } elsif ($numinvalid) {
                   9167:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   9168:         } elsif ($numexisting) {
                   9169:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   9170:         }
                   9171:         $output .= $upload_output.'<br />';
                   9172:     }
                   9173:     my ($pathchange_output,$chgcount);
                   9174:     $chgcount = $num;
                   9175:     if (keys(%pathchanges) > 0) {
                   9176:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
                   9177:             if ($num) {
                   9178:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   9179:                                                   $embed_file,\%mapping,
                   9180:                                                   $allfiles,$codebase);
                   9181:             } else {
                   9182:                 $pathchange_output .= 
                   9183:                     &start_data_table_row().
                   9184:                     '<td><input type ="checkbox" name="namechange" value="'.
                   9185:                     $chgcount.'" checked="checked" /></td>'.
                   9186:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   9187:                     '<td>'.$embed_file.
                   9188:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
                   9189:                                            \%mapping,$allfiles,$codebase).
                   9190:                     '</td>'.&end_data_table_row();
1.660     raeburn  9191:             }
1.987     raeburn  9192:             $numpathchg ++;
                   9193:             $chgcount ++;
1.660     raeburn  9194:         }
                   9195:     }
1.984     raeburn  9196:     if ($num) {
1.987     raeburn  9197:         if ($numpathchg) {
                   9198:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   9199:                        $numpathchg.'" />'."\n";
                   9200:         }
                   9201:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   9202:             ($actionurl eq '/adm/imsimport')) {
                   9203:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   9204:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   9205:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
                   9206:         }
                   9207:         $output .=  '<input type ="submit" value="'.&mt('Upload Listed Files').'" />'."\n".
                   9208:                     &mt('(only files for which a location has been provided will be uploaded)').'</form>'."\n";
                   9209:     } elsif ($numpathchg) {
                   9210:         my %pathchange = ();
                   9211:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   9212:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   9213:             $output .= '<p>'.&mt('or').'</p>'; 
                   9214:         } 
                   9215:     }
                   9216:     return ($output,$num,$numpathchg);
                   9217: }
                   9218: 
                   9219: sub embedded_file_element {
                   9220:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase) = @_;
                   9221:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   9222:                    (ref($codebase) eq 'HASH'));
                   9223:     my $output;
                   9224:     if ($context eq 'upload_embedded') {
                   9225:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   9226:     }
                   9227:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   9228:                &escape($embed_file).'" />';
                   9229:     unless (($context eq 'upload_embedded') && 
                   9230:             ($mapping->{$embed_file} eq $embed_file)) {
                   9231:         $output .='
                   9232:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   9233:     }
                   9234:     my $attrib;
                   9235:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   9236:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   9237:     }
                   9238:     $output .=
                   9239:         "\n\t\t".
                   9240:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   9241:         $attrib.'" />';
                   9242:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   9243:         $output .=
                   9244:             "\n\t\t".
                   9245:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   9246:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  9247:     }
1.987     raeburn  9248:     return $output;
1.660     raeburn  9249: }
                   9250: 
1.661     raeburn  9251: sub upload_embedded {
                   9252:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  9253:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   9254:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  9255:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   9256:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   9257:         my $orig_uploaded_filename =
                   9258:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  9259:         foreach my $type ('orig','ref','attrib','codebase') {
                   9260:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   9261:                 $env{'form.embedded_'.$type.'_'.$i} =
                   9262:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   9263:             }
                   9264:         }
1.661     raeburn  9265:         my ($path,$fname) =
                   9266:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   9267:         # no path, whole string is fname
                   9268:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   9269:         $fname = &Apache::lonnet::clean_filename($fname);
                   9270:         # See if there is anything left
                   9271:         next if ($fname eq '');
                   9272: 
                   9273:         # Check if file already exists as a file or directory.
                   9274:         my ($state,$msg);
                   9275:         if ($context eq 'portfolio') {
                   9276:             my $port_path = $dirpath;
                   9277:             if ($group ne '') {
                   9278:                 $port_path = "groups/$group/$port_path";
                   9279:             }
1.987     raeburn  9280:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   9281:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  9282:                                               $dir_root,$port_path,$disk_quota,
                   9283:                                               $current_disk_usage,$uname,$udom);
                   9284:             if ($state eq 'will_exceed_quota'
1.984     raeburn  9285:                 || $state eq 'file_locked') {
1.661     raeburn  9286:                 $output .= $msg;
                   9287:                 next;
                   9288:             }
                   9289:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   9290:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   9291:             if ($state eq 'exists') {
                   9292:                 $output .= $msg;
                   9293:                 next;
                   9294:             }
                   9295:         }
                   9296:         # Check if extension is valid
                   9297:         if (($fname =~ /\.(\w+)$/) &&
                   9298:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987     raeburn  9299:             $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  9300:             next;
                   9301:         } elsif (($fname =~ /\.(\w+)$/) &&
                   9302:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  9303:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  9304:             next;
                   9305:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987     raeburn  9306:             $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  9307:             next;
                   9308:         }
                   9309: 
                   9310:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   9311:         if ($context eq 'portfolio') {
1.984     raeburn  9312:             my $result;
                   9313:             if ($state eq 'existingfile') {
                   9314:                 $result=
                   9315:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987     raeburn  9316:                                                     $dirpath.$env{'form.currentpath'}.$path);
1.661     raeburn  9317:             } else {
1.984     raeburn  9318:                 $result=
                   9319:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  9320:                                                     $dirpath.
                   9321:                                                     $env{'form.currentpath'}.$path);
1.984     raeburn  9322:                 if ($result !~ m|^/uploaded/|) {
                   9323:                     $output .= '<span class="LC_error">'
                   9324:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   9325:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   9326:                                .'</span><br />';
                   9327:                     next;
                   9328:                 } else {
1.987     raeburn  9329:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9330:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  9331:                 }
1.661     raeburn  9332:             }
1.987     raeburn  9333:         } elsif ($context eq 'coursedoc') {
                   9334:             my $result =
                   9335:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
                   9336:                                                 $dirpath.'/'.$path);
                   9337:             if ($result !~ m|^/uploaded/|) {
                   9338:                 $output .= '<span class="LC_error">'
                   9339:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   9340:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   9341:                            .'</span><br />';
                   9342:                     next;
                   9343:             } else {
                   9344:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9345:                            $path.$fname.'</span>').'<br />';
                   9346:             }
1.661     raeburn  9347:         } else {
                   9348: # Save the file
                   9349:             my $target = $env{'form.embedded_item_'.$i};
                   9350:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   9351:             my $dest = $fullpath.$fname;
                   9352:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  9353:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  9354:             my $count;
                   9355:             my $filepath = $dir_root;
1.1027    raeburn  9356:             foreach my $subdir (@parts) {
                   9357:                 $filepath .= "/$subdir";
                   9358:                 if (!-e $filepath) {
1.661     raeburn  9359:                     mkdir($filepath,0770);
                   9360:                 }
                   9361:             }
                   9362:             my $fh;
                   9363:             if (!open($fh,'>'.$dest)) {
                   9364:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   9365:                 $output .= '<span class="LC_error">'.
                   9366:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   9367:                            '</span><br />';
                   9368:             } else {
                   9369:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   9370:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   9371:                     $output .= '<span class="LC_error">'.
                   9372:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   9373:                               '</span><br />';
                   9374:                 } else {
1.987     raeburn  9375:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9376:                                $url.'</span>').'<br />';
                   9377:                     unless ($context eq 'testbank') {
                   9378:                         $footer .= &mt('View embedded file: [_1]',
                   9379:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   9380:                     }
                   9381:                 }
                   9382:                 close($fh);
                   9383:             }
                   9384:         }
                   9385:         if ($env{'form.embedded_ref_'.$i}) {
                   9386:             $pathchange{$i} = 1;
                   9387:         }
                   9388:     }
                   9389:     if ($output) {
                   9390:         $output = '<p>'.$output.'</p>';
                   9391:     }
                   9392:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   9393:     $returnflag = 'ok';
                   9394:     if (keys(%pathchange) > 0) {
                   9395:         if ($context eq 'portfolio') {
                   9396:             $output .= '<p>'.&mt('or').'</p>';
                   9397:         } elsif ($context eq 'testbank') {
1.988     raeburn  9398:             $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  9399:             $returnflag = 'modify_orightml';
                   9400:         }
                   9401:     }
                   9402:     return ($output.$footer,$returnflag);
                   9403: }
                   9404: 
                   9405: sub modify_html_form {
                   9406:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   9407:     my $end = 0;
                   9408:     my $modifyform;
                   9409:     if ($context eq 'upload_embedded') {
                   9410:         return unless (ref($pathchange) eq 'HASH');
                   9411:         if ($env{'form.number_embedded_items'}) {
                   9412:             $end += $env{'form.number_embedded_items'};
                   9413:         }
                   9414:         if ($env{'form.number_pathchange_items'}) {
                   9415:             $end += $env{'form.number_pathchange_items'};
                   9416:         }
                   9417:         if ($end) {
                   9418:             for (my $i=0; $i<$end; $i++) {
                   9419:                 if ($i < $env{'form.number_embedded_items'}) {
                   9420:                     next unless($pathchange->{$i});
                   9421:                 }
                   9422:                 $modifyform .=
                   9423:                     &start_data_table_row().
                   9424:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   9425:                     'checked="checked" /></td>'.
                   9426:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   9427:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   9428:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   9429:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   9430:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   9431:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   9432:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   9433:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   9434:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   9435:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   9436:                     &end_data_table_row();
                   9437:             } 
                   9438:         }
                   9439:     } else {
                   9440:         $modifyform = $pathchgtable;
                   9441:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   9442:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   9443:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   9444:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   9445:         }
                   9446:     }
                   9447:     if ($modifyform) {
                   9448:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   9449:                '<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".
                   9450:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   9451:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   9452:                '</ol></p>'."\n".'<p>'.
                   9453:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   9454:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   9455:                &start_data_table()."\n".
                   9456:                &start_data_table_header_row().
                   9457:                '<th>'.&mt('Change?').'</th>'.
                   9458:                '<th>'.&mt('Current reference').'</th>'.
                   9459:                '<th>'.&mt('Required reference').'</th>'.
                   9460:                &end_data_table_header_row()."\n".
                   9461:                $modifyform.
                   9462:                &end_data_table().'<br />'."\n".$hiddenstate.
                   9463:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   9464:                '</form>'."\n";
                   9465:     }
                   9466:     return;
                   9467: }
                   9468: 
                   9469: sub modify_html_refs {
                   9470:     my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
                   9471:     my $container;
                   9472:     if ($context eq 'portfolio') {
                   9473:         $container = $env{'form.container'};
                   9474:     } elsif ($context eq 'coursedoc') {
                   9475:         $container = $env{'form.primaryurl'};
                   9476:     } else {
1.1027    raeburn  9477:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  9478:     }
                   9479:     my (%allfiles,%codebase,$output,$content);
                   9480:     my @changes = &get_env_multiple('form.namechange');
                   9481:     return unless (@changes > 0);
                   9482:     if (($context eq 'portfolio') || ($context eq 'coursedoc')) {
                   9483:         return unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/});
                   9484:         $content = &Apache::lonnet::getfile($container);
                   9485:         return if ($content eq '-1');
                   9486:     } else {
                   9487:         return unless ($container =~ /^\Q$dir_root\E/); 
                   9488:         if (open(my $fh,"<$container")) {
                   9489:             $content = join('', <$fh>);
                   9490:             close($fh);
                   9491:         } else {
                   9492:             return;
                   9493:         }
                   9494:     }
                   9495:     my ($count,$codebasecount) = (0,0);
                   9496:     my $mm = new File::MMagic;
                   9497:     my $mime_type = $mm->checktype_contents($content);
                   9498:     if ($mime_type eq 'text/html') {
                   9499:         my $parse_result = 
                   9500:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   9501:                                                     \%codebase,\$content);
                   9502:         if ($parse_result eq 'ok') {
                   9503:             foreach my $i (@changes) {
                   9504:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   9505:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   9506:                 if ($allfiles{$ref}) {
                   9507:                     my $newname =  $orig;
                   9508:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  9509:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  9510:                     if ($attrib_regexp =~ /:/) {
                   9511:                         $attrib_regexp =~ s/\:/|/g;
                   9512:                     }
                   9513:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   9514:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   9515:                         $count += $numchg;
                   9516:                     }
                   9517:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  9518:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  9519:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   9520:                         $codebasecount ++;
                   9521:                     }
                   9522:                 }
                   9523:             }
                   9524:             if ($count || $codebasecount) {
                   9525:                 my $saveresult;
                   9526:                 if ($context eq 'portfolio' || $context eq 'coursedoc') {
                   9527:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   9528:                     if ($url eq $container) {
                   9529:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   9530:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   9531:                                             $count,'<span class="LC_filename">'.
                   9532:                                             $fname.'</span>').'</p>'; 
                   9533:                     } else {
                   9534:                          $output = '<p class="LC_error">'.
                   9535:                                    &mt('Error: update failed for: [_1].',
                   9536:                                    '<span class="LC_filename">'.
                   9537:                                    $container.'</span>').'</p>';
                   9538:                     }
                   9539:                 } else {
                   9540:                     if (open(my $fh,">$container")) {
                   9541:                         print $fh $content;
                   9542:                         close($fh);
                   9543:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   9544:                                   $count,'<span class="LC_filename">'.
                   9545:                                   $container.'</span>').'</p>';
1.661     raeburn  9546:                     } else {
1.987     raeburn  9547:                          $output = '<p class="LC_error">'.
                   9548:                                    &mt('Error: could not update [_1].',
                   9549:                                    '<span class="LC_filename">'.
                   9550:                                    $container.'</span>').'</p>';
1.661     raeburn  9551:                     }
                   9552:                 }
                   9553:             }
1.987     raeburn  9554:         } else {
                   9555:             &logthis('Failed to parse '.$container.
                   9556:                      ' to modify references: '.$parse_result);
1.661     raeburn  9557:         }
                   9558:     }
                   9559:     return $output;
                   9560: }
                   9561: 
                   9562: sub check_for_existing {
                   9563:     my ($path,$fname,$element) = @_;
                   9564:     my ($state,$msg);
                   9565:     if (-d $path.'/'.$fname) {
                   9566:         $state = 'exists';
                   9567:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   9568:     } elsif (-e $path.'/'.$fname) {
                   9569:         $state = 'exists';
                   9570:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   9571:     }
                   9572:     if ($state eq 'exists') {
                   9573:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   9574:     }
                   9575:     return ($state,$msg);
                   9576: }
                   9577: 
                   9578: sub check_for_upload {
                   9579:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   9580:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  9581:     my $filesize = length($env{'form.'.$element});
                   9582:     if (!$filesize) {
                   9583:         my $msg = '<span class="LC_error">'.
                   9584:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   9585:                       '<span class="LC_filename">'.$fname.'</span>',
                   9586:                       $filesize).'<br />'.
1.1007    raeburn  9587:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  9588:                   '</span>';
                   9589:         return ('zero_bytes',$msg);
                   9590:     }
                   9591:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  9592:     my $getpropath = 1;
1.1021    raeburn  9593:     my ($dirlistref,$listerror) =
                   9594:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  9595:     my $found_file = 0;
                   9596:     my $locked_file = 0;
1.991     raeburn  9597:     my @lockers;
                   9598:     my $navmap;
                   9599:     if ($env{'request.course.id'}) {
                   9600:         $navmap = Apache::lonnavmaps::navmap->new();
                   9601:     }
1.1021    raeburn  9602:     if (ref($dirlistref) eq 'ARRAY') {
                   9603:         foreach my $line (@{$dirlistref}) {
                   9604:             my ($file_name,$rest)=split(/\&/,$line,2);
                   9605:             if ($file_name eq $fname){
                   9606:                 $file_name = $path.$file_name;
                   9607:                 if ($group ne '') {
                   9608:                     $file_name = $group.$file_name;
                   9609:                 }
                   9610:                 $found_file = 1;
                   9611:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   9612:                     foreach my $lock (@lockers) {
                   9613:                         if (ref($lock) eq 'ARRAY') {
                   9614:                             my ($symb,$crsid) = @{$lock};
                   9615:                             if ($crsid eq $env{'request.course.id'}) {
                   9616:                                 if (ref($navmap)) {
                   9617:                                     my $res = $navmap->getBySymb($symb);
                   9618:                                     foreach my $part (@{$res->parts()}) { 
                   9619:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   9620:                                         unless (($slot_status == $res->RESERVED) ||
                   9621:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   9622:                                             $locked_file = 1;
                   9623:                                         }
1.991     raeburn  9624:                                     }
1.1021    raeburn  9625:                                 } else {
                   9626:                                     $locked_file = 1;
1.991     raeburn  9627:                                 }
                   9628:                             } else {
                   9629:                                 $locked_file = 1;
                   9630:                             }
                   9631:                         }
1.1021    raeburn  9632:                    }
                   9633:                 } else {
                   9634:                     my @info = split(/\&/,$rest);
                   9635:                     my $currsize = $info[6]/1000;
                   9636:                     if ($currsize < $filesize) {
                   9637:                         my $extra = $filesize - $currsize;
                   9638:                         if (($current_disk_usage + $extra) > $disk_quota) {
                   9639:                             my $msg = '<span class="LC_error">'.
                   9640:                                       &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.',
                   9641:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
                   9642:                                       '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   9643:                                                    $disk_quota,$current_disk_usage);
                   9644:                             return ('will_exceed_quota',$msg);
                   9645:                         }
1.984     raeburn  9646:                     }
                   9647:                 }
1.661     raeburn  9648:             }
                   9649:         }
                   9650:     }
                   9651:     if (($current_disk_usage + $filesize) > $disk_quota){
                   9652:         my $msg = '<span class="LC_error">'.
                   9653:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   9654:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   9655:         return ('will_exceed_quota',$msg);
                   9656:     } elsif ($found_file) {
                   9657:         if ($locked_file) {
                   9658:             my $msg = '<span class="LC_error">';
                   9659:             $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>');
                   9660:             $msg .= '</span><br />';
                   9661:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   9662:             return ('file_locked',$msg);
                   9663:         } else {
                   9664:             my $msg = '<span class="LC_error">';
1.984     raeburn  9665:             $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  9666:             $msg .= '</span>';
1.984     raeburn  9667:             return ('existingfile',$msg);
1.661     raeburn  9668:         }
                   9669:     }
                   9670: }
                   9671: 
1.987     raeburn  9672: sub check_for_traversal {
                   9673:     my ($path,$url,$toplevel) = @_;
                   9674:     my @parts=split(/\//,$path);
                   9675:     my $cleanpath;
                   9676:     my $fullpath = $url;
                   9677:     for (my $i=0;$i<@parts;$i++) {
                   9678:         next if ($parts[$i] eq '.');
                   9679:         if ($parts[$i] eq '..') {
                   9680:             $fullpath =~ s{([^/]+/)$}{};
                   9681:         } else {
                   9682:             $fullpath .= $parts[$i].'/';
                   9683:         }
                   9684:     }
                   9685:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   9686:         $cleanpath = $1;
                   9687:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   9688:         my $curr_toprel = $1;
                   9689:         my @parts = split(/\//,$curr_toprel);
                   9690:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   9691:         my @urlparts = split(/\//,$url_toprel);
                   9692:         my $doubledots;
                   9693:         my $startdiff = -1;
                   9694:         for (my $i=0; $i<@urlparts; $i++) {
                   9695:             if ($startdiff == -1) {
                   9696:                 unless ($urlparts[$i] eq $parts[$i]) {
                   9697:                     $startdiff = $i;
                   9698:                     $doubledots .= '../';
                   9699:                 }
                   9700:             } else {
                   9701:                 $doubledots .= '../';
                   9702:             }
                   9703:         }
                   9704:         if ($startdiff > -1) {
                   9705:             $cleanpath = $doubledots;
                   9706:             for (my $i=$startdiff; $i<@parts; $i++) {
                   9707:                 $cleanpath .= $parts[$i].'/';
                   9708:             }
                   9709:         }
                   9710:     }
                   9711:     $cleanpath =~ s{(/)$}{};
                   9712:     return $cleanpath;
                   9713: }
1.31      albertel 9714: 
1.1053    raeburn  9715: sub is_archive_file {
                   9716:     my ($mimetype) = @_;
                   9717:     if (($mimetype eq 'application/octet-stream') ||
                   9718:         ($mimetype eq 'application/x-stuffit') ||
                   9719:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   9720:         return 1;
                   9721:     }
                   9722:     return;
                   9723: }
                   9724: 
                   9725: sub decompress_form {
                   9726:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements) = @_;
                   9727:     my %lt = &Apache::lonlocal::texthash (
                   9728:         this => 'This file is an archive file.',
                   9729:         youm => 'You may wish to extract its contents.',
                   9730:         camt => 'Extraction of contents is recommended for Camtasia zip files.',
                   9731:         perm => 'Permanently remove archive file after extraction of contents?',
                   9732:         extr => 'Extract contents',
                   9733:         yes  => 'Yes',
                   9734:         no   => 'No',
                   9735:     );
                   9736:     my $output = '<p>'.$lt{'this'}.' '.$lt{'youm'}.'<br />';
                   9737:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
                   9738:         $output .= $lt{'camt'};
                   9739:     }
                   9740:     $output .= '</p>';
                   9741:     $output .= <<"START";
                   9742: <div id="uploadfileresult">
                   9743:   <form name="uploaded_decompress" action="$action" method="post">
                   9744:   <input type="hidden" name="archiveurl" value="$archiveurl" />
                   9745: START
                   9746:     if (ref($hiddenelements) eq 'HASH') {
                   9747:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   9748:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   9749:         }
                   9750:     }
                   9751:     $output .= <<"END";
                   9752: <span class="LC_nobreak">$lt{'perm'}&nbsp;
                   9753: <label><input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}</label>&nbsp;&nbsp;
                   9754: <label><input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label></span><br />
                   9755: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   9756: </form>
                   9757: $noextract
                   9758: </div>
                   9759: END
                   9760:     return $output;
                   9761: }
                   9762: 
                   9763: sub decompress_uploaded_file {
                   9764:     my ($file,$dir) = @_;
                   9765:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   9766:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   9767:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   9768:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   9769:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   9770:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   9771:     my $decompressed = $env{'cgi.decompressed'};
                   9772:     &Apache::lonnet::delenv('cgi.file');
                   9773:     &Apache::lonnet::delenv('cgi.dir');
                   9774:     &Apache::lonnet::delenv('cgi.decompressed');
                   9775:     return ($decompressed,$result);
                   9776: }
                   9777: 
1.1055    raeburn  9778: sub process_decompression {
                   9779:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
                   9780:     my ($dir,$error,$warning,$output);
                   9781:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
                   9782:         $error = &mt('File name not a supported archive file type.').
                   9783:                  '<br />'.&mt('File name should end with one of: [_1].',
                   9784:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   9785:     } else {
                   9786:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   9787:         if ($docuhome eq 'no_host') {
                   9788:             $error = &mt('Could not determine home server for course.');
                   9789:         } else {
                   9790:             my @ids=&Apache::lonnet::current_machine_ids();
                   9791:             my $currdir = "$dir_root/$destination";
                   9792:             my ($currdirlistref,$currlisterror) =
                   9793:                 &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   9794:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   9795:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   9796:                        "$dir_root/$destination";
                   9797:             } else {
                   9798:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   9799:                        "$dir_root/$docudom/$docuname/$destination";
                   9800:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   9801:                     $error = &mt('Archive file not found.');
                   9802:                 }
                   9803:             }
                   9804:             if ($dir eq '') {
                   9805:                 $error = &mt('Directory containing archive file unavailable.');
                   9806:             } elsif (!$error) {
                   9807:                 my ($decompressed,$display) = &decompress_uploaded_file($file,$dir);
                   9808:                 if ($decompressed eq 'ok') {
                   9809:                     $output = &mt('Files extracted successfully from archive.').'<br />';
                   9810:                     my ($warning,$result,@contents);
                   9811:                     my ($newdirlistref,$newlisterror) =
                   9812:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   9813:                                                  $docuname,1);
                   9814:                     my (%is_dir,%changes,@newitems);
                   9815:                     my $dirptr = 16384;
                   9816:                     if (ref($currdirlistref) eq 'ARRAY') {
                   9817:                         my @curritems;
                   9818:                         foreach my $dir_line (@{$currdirlistref}) {
                   9819:                             my ($item,$rest)=split(/\&/,$dir_line,2);
                   9820:                             unless ($item =~ /\.+$/) {
                   9821:                                 push(@curritems,$item);
                   9822:                             }
                   9823:                         }
                   9824:                         if (ref($newdirlistref) eq 'ARRAY') {
                   9825:                             foreach my $dir_line (@{$newdirlistref}) {
                   9826:                                 my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,4);
                   9827:                                 unless ($item =~ /^\.+$/) {
                   9828:                                     if ($dirptr&$testdir) {
                   9829:                                         $is_dir{$item} = 1;
                   9830:                                     }
                   9831:                                     push(@newitems,$item);
                   9832:                                 }
                   9833:                             }
                   9834:                             my @diffs = &compare_arrays(\@curritems,\@newitems);
                   9835:                             if (@diffs > 0) {
                   9836:                                foreach my $item (@diffs) {
                   9837:                                    $changes{$item} = 1;
                   9838:                                }
                   9839:                             }
                   9840:                         }
                   9841:                     } elsif (ref($newdirlistref) eq 'ARRAY') {
                   9842:                         foreach my $dir_line (@{$newdirlistref}) {
                   9843:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   9844:                             unless ($item =~ /\.+$/) {
                   9845:                                 push(@newitems,$item);
                   9846:                                 if ($dirptr&$testdir) {
                   9847:                                     $is_dir{$item} = 1;
                   9848:                                 }
                   9849:                                 $changes{$item} = 1;
                   9850:                             }
                   9851:                         }
                   9852:                     }
                   9853:                     if (keys(%changes) > 0) {
                   9854:                         foreach my $item (sort(@newitems)) {
                   9855:                             if ($changes{$item}) {
                   9856:                                 push(@contents,$item);
                   9857:                             }
                   9858:                         }
                   9859:                     }
                   9860:                     if (@contents > 0) {
1.1056    raeburn  9861:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  9862:                         my $wantform = 1;
                   9863:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   9864:                                                                 $currdir,\%is_dir,
                   9865:                                                                 \%children,\%parent,
1.1056    raeburn  9866:                                                                 \@contents,\%dirorder,
                   9867:                                                                 \%titles,$wantform);
1.1055    raeburn  9868:                         if ($datatable ne '') {
                   9869:                             $output .= &archive_options_form('decompressed',$datatable,
                   9870:                                                              $count,$hiddenelem);
1.1056    raeburn  9871:                             my $startcount = 4;
1.1055    raeburn  9872:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  9873:                                                            \%titles,\%children);
1.1055    raeburn  9874:                         }
                   9875:                     } else {
                   9876:                         $warning = &mt('No new items extracted from archive file.');
                   9877:                     }
                   9878:                 } else {
                   9879:                     $output = $display;
                   9880:                     $error = &mt('An error occurred during extraction from the archive file.');
                   9881:                 }
                   9882:             }
                   9883:         }
                   9884:     }
                   9885:     if ($error) {
                   9886:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   9887:                    $error.'</p>'."\n";
                   9888:     }
                   9889:     if ($warning) {
                   9890:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   9891:     }
                   9892:     return $output;
                   9893: }
                   9894: 
                   9895: sub get_extracted {
1.1056    raeburn  9896:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   9897:         $titles,$wantform) = @_;
1.1055    raeburn  9898:     my $count = 0;
                   9899:     my $depth = 0;
                   9900:     my $datatable;
1.1056    raeburn  9901:     my @hierarchy;
1.1055    raeburn  9902:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  9903:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   9904:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  9905:     foreach my $item (@{$contents}) {
                   9906:         $count ++;
1.1056    raeburn  9907:         @{$dirorder->{$count}} = @hierarchy;
                   9908:         $titles->{$count} = $item;
1.1055    raeburn  9909:         &archive_hierarchy($depth,$count,$parent,$children);
                   9910:         if ($wantform) {
                   9911:             $datatable .= &archive_row($is_dir->{$item},$item,
                   9912:                                        $currdir,$depth,$count);
                   9913:         }
                   9914:         if ($is_dir->{$item}) {
                   9915:             $depth ++;
1.1056    raeburn  9916:             push(@hierarchy,$count);
                   9917:             $parent->{$depth} = $count;
1.1055    raeburn  9918:             $datatable .=
                   9919:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  9920:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   9921:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  9922:             $depth --;
1.1056    raeburn  9923:             pop(@hierarchy);
1.1055    raeburn  9924:         }
                   9925:     }
                   9926:     return ($count,$datatable);
                   9927: }
                   9928: 
                   9929: sub recurse_extracted_archive {
1.1056    raeburn  9930:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   9931:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  9932:     my $result='';
1.1056    raeburn  9933:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   9934:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   9935:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  9936:         return $result;
                   9937:     }
                   9938:     my $dirptr = 16384;
                   9939:     my ($newdirlistref,$newlisterror) =
                   9940:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   9941:     if (ref($newdirlistref) eq 'ARRAY') {
                   9942:         foreach my $dir_line (@{$newdirlistref}) {
                   9943:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   9944:             unless ($item =~ /^\.+$/) {
                   9945:                 $$count ++;
1.1056    raeburn  9946:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   9947:                 $titles->{$$count} = $item;
1.1055    raeburn  9948:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  9949: 
1.1055    raeburn  9950:                 my $is_dir;
                   9951:                 if ($dirptr&$testdir) {
                   9952:                     $is_dir = 1;
                   9953:                 }
                   9954:                 if ($wantform) {
                   9955:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   9956:                 }
                   9957:                 if ($is_dir) {
                   9958:                     $$depth ++;
1.1056    raeburn  9959:                     push(@{$hierarchy},$$count);
                   9960:                     $parent->{$$depth} = $$count;
1.1055    raeburn  9961:                     $result .=
                   9962:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   9963:                                                    $docuname,$depth,$count,
1.1056    raeburn  9964:                                                    $hierarchy,$dirorder,$children,
                   9965:                                                    $parent,$titles,$wantform);
1.1055    raeburn  9966:                     $$depth --;
1.1056    raeburn  9967:                     pop(@{$hierarchy});
1.1055    raeburn  9968:                 }
                   9969:             }
                   9970:         }
                   9971:     }
                   9972:     return $result;
                   9973: }
                   9974: 
                   9975: sub archive_hierarchy {
                   9976:     my ($depth,$count,$parent,$children) =@_;
                   9977:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   9978:         if (exists($parent->{$depth})) {
                   9979:              $children->{$parent->{$depth}} .= $count.':';
                   9980:         }
                   9981:     }
                   9982:     return;
                   9983: }
                   9984: 
                   9985: sub archive_row {
                   9986:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   9987:     my ($name) = ($item =~ m{([^/]+)$});
                   9988:     my %choices = &Apache::lonlocal::texthash (
                   9989:                                        'display'    => 'Add as File',
                   9990:                                        'dependency' => 'Include as dependency',
                   9991:                                        'discard'    => 'Discard',
                   9992:                                       );
                   9993:     if ($is_dir) {
                   9994:         $choices{'display'} = &mt('Add as Folder'); 
                   9995:     }
1.1056    raeburn  9996:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   9997:     my $offset = 0;
1.1055    raeburn  9998:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  9999:         $offset ++;
1.1055    raeburn  10000:         $output .= '<td><span class="LC_nobreak">'.
                   10001:                    '<label><input type="radio" name="archive_'.$count.
                   10002:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   10003:         my $text = $choices{$action};
                   10004:         if ($is_dir) {
                   10005:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   10006:             if ($action eq 'display') {
                   10007:                 $text = &mt('Add as Folder');
                   10008:             }
1.1056    raeburn  10009:         } else {
                   10010:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   10011: 
                   10012:         }
                   10013:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   10014:         if ($action eq 'dependency') {
                   10015:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   10016:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   10017:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   10018:                        '<option value=""></option>'."\n".
                   10019:                        '</select>'."\n".
                   10020:                        '</div>';
1.1055    raeburn  10021:         }
1.1056    raeburn  10022:         $output .= '</td>';
1.1055    raeburn  10023:     }
                   10024:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   10025:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   10026:     for (my $i=0; $i<$depth; $i++) {
                   10027:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   10028:     }
                   10029:     if ($is_dir) {
                   10030:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   10031:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   10032:     } else {
                   10033:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   10034:     }
                   10035:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   10036:                &end_data_table_row();
                   10037:     return $output;
                   10038: }
                   10039: 
                   10040: sub archive_options_form {
                   10041:     my ($form,$output,$count,$hiddenelem) = @_;
                   10042:     return '<form name="'.$form.'" method="post" action="">'."\n".
                   10043:            '<input type="hidden" name="phase" value="decompress_cleanup" />'."\n".
                   10044:                     '<p>'.
                   10045:                     &mt('How should each item be incorporated in the course?').
                   10046:                     '</p>'.
                   10047:                     '<div class="LC_columnSection"><fieldset>'.
                   10048:                     '<legend>'.&mt('Content actions for all').'</legend>'.
                   10049:                     '<input type="button" value="'.&mt('Display in Contents').'" '.
                   10050:                     'onclick="javascript:checkAll(document.'.$form.",'display'".')" />'.
                   10051:                     '&nbsp;&nbsp;<input type="button" value="'.&mt('Include as dependency for a displayed item').'"'.
                   10052:                     ' onclick="javascript:checkAll(document.'.$form.",'dependency'".')" />'.
                   10053:                     '&nbsp;&nbsp;<input type="button" value="'.&mt('Discard').'"'.
                   10054:                     ' onclick="javascript:checkAll(document.'.$form.",'discard'".')" />'.
                   10055:                      '</fieldset></div>'.
                   10056:            &start_data_table()."\n".
                   10057:            $output."\n".
                   10058:            &end_data_table()."\n".
                   10059:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   10060:            $hiddenelem.
                   10061:            '<br /><input type="submit" name="archive_submit" value="'.&mt('Save').'" />'.
                   10062:            '</form>';
                   10063: }
                   10064: 
                   10065: sub archive_javascript {
1.1056    raeburn  10066:     my ($startcount,$numitems,$titles,$children) = @_;
                   10067:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1055    raeburn  10068:     my $scripttag = <<START;
                   10069: <script type="text/javascript">
                   10070: // <![CDATA[
                   10071: 
                   10072: function checkAll(form,prefix) {
                   10073:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   10074:     for (var i=0; i < form.elements.length; i++) {
                   10075:         var id = form.elements[i].id;
                   10076:         if ((id != '') && (id != undefined)) {
                   10077:             if (idstr.test(id)) {
                   10078:                 if (form.elements[i].type == 'radio') {
                   10079:                     form.elements[i].checked = true;
1.1056    raeburn  10080:                     var nostart = i-$startcount;
                   10081:                     var offset = nostart%6;
                   10082:                     var count = (nostart-offset)/6;    
                   10083:                     dependencyCheck(form,count,offset);
1.1055    raeburn  10084:                 }
                   10085:             }
                   10086:         }
                   10087:     }
                   10088: }
                   10089: 
                   10090: function propagateCheck(form,count) {
                   10091:     if (count > 0) {
1.1056    raeburn  10092:         var startelement = $startcount + ((count-1) * 6);
                   10093:         for (var j=1; j<5; j++) {
                   10094:             if (j != 3) {
                   10095:                 var item = startelement + j; 
                   10096:                 if (form.elements[item].type == 'radio') {
                   10097:                     if (form.elements[item].checked) {
                   10098:                         containerCheck(form,count,j);
                   10099:                         break;
                   10100:                     }
1.1055    raeburn  10101:                 }
                   10102:             }
                   10103:         }
                   10104:     }
                   10105: }
                   10106: 
                   10107: numitems = $numitems
1.1056    raeburn  10108: var titles = new Array(numitems);
                   10109: var parents = new Array(numitems);
1.1055    raeburn  10110: for (var i=0; i<numitems; i++) {
1.1056    raeburn  10111:     parents[i] = new Array;
1.1055    raeburn  10112: }
                   10113: 
                   10114: START
                   10115: 
1.1056    raeburn  10116:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   10117:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  10118:         for (my $i=0; $i<@contents; $i ++) {
                   10119:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   10120:         }
                   10121:     }
                   10122: 
1.1056    raeburn  10123:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   10124:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   10125:     }
                   10126: 
1.1055    raeburn  10127:     $scripttag .= <<END;
                   10128: 
                   10129: function containerCheck(form,count,offset) {
                   10130:     if (count > 0) {
1.1056    raeburn  10131:         dependencyCheck(form,count,offset);
                   10132:         var item = (offset+$startcount)+6*(count-1);
1.1055    raeburn  10133:         form.elements[item].checked = true;
                   10134:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   10135:             if (parents[count].length > 0) {
                   10136:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  10137:                     containerCheck(form,parents[count][j],offset);
                   10138:                 }
                   10139:             }
                   10140:         }
                   10141:     }
                   10142: }
                   10143: 
                   10144: function dependencyCheck(form,count,offset) {
                   10145:     if (count > 0) {
                   10146:         var chosen = (offset+$startcount)+6*(count-1);
                   10147:         var depitem = $startcount + ((count-1) * 6) + 3;
                   10148:         var currtype = form.elements[depitem].type;
                   10149:         if (form.elements[chosen].value == 'dependency') {
                   10150:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   10151:             form.elements[depitem].options.length = 0;
                   10152:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   10153:             for (var i=1; i<count; i++) {
                   10154:                 var startelement = $startcount + (i-1) * 6;
                   10155:                 for (var j=1; j<5; j++) {
                   10156:                     if (j != 3) {
                   10157:                         var item = startelement + j;
                   10158:                         if (form.elements[item].type == 'radio') {
                   10159:                             if (form.elements[item].checked) {
                   10160:                                 if (form.elements[item].value == 'display') {
                   10161:                                     var n = form.elements[depitem].options.length;
                   10162:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   10163:                                 }
                   10164:                             }
                   10165:                         }
                   10166:                     }
                   10167:                 }
                   10168:             }
                   10169:         } else {
                   10170:             document.getElementById('arc_depon_'+count).style.display='none';
                   10171:             form.elements[depitem].options.length = 0;
                   10172:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   10173:         }
                   10174:     }
                   10175: }
                   10176: 
                   10177: function propagateSelect(form,count,offset) {
                   10178:     if (count > 0) {
                   10179:         var item = (1+offset+$startcount)+6*(count-1);
                   10180:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   10181:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   10182:             if (parents[count].length > 0) {
                   10183:                 for (var j=0; j<parents[count].length; j++) {
                   10184:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  10185:                 }
                   10186:             }
                   10187:         }
                   10188:     }
                   10189: }
1.1056    raeburn  10190: 
                   10191: function containerSelect(form,count,offset,picked) {
                   10192:     if (count > 0) {
                   10193:         var item = (offset+$startcount)+6*(count-1);
                   10194:         if (form.elements[item].type == 'radio') {
                   10195:             if (form.elements[item].value == 'dependency') {
                   10196:                 if (form.elements[item+1].type == 'select-one') {
                   10197:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   10198:                         if (form.elements[item+1].options[i].value == picked) {
                   10199:                             form.elements[item+1].selectedIndex = i;
                   10200:                             break;
                   10201:                         }
                   10202:                     }
                   10203:                 }
                   10204:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   10205:                     if (parents[count].length > 0) {
                   10206:                         for (var j=0; j<parents[count].length; j++) {
                   10207:                             containerSelect(form,parents[count][j],offset,picked);
                   10208:                         }
                   10209:                     }
                   10210:                 }
                   10211:             }
                   10212:         }
                   10213:     }
                   10214: }
                   10215: 
1.1055    raeburn  10216: // ]]>
                   10217: </script>
                   10218: END
                   10219:     return $scripttag;
                   10220: }
                   10221: 
                   10222: sub process_extracted_files {
                   10223:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
                   10224:     my $numitems = $env{'form.archive_count'};
                   10225:     return unless ($numitems);
                   10226:     my @ids=&Apache::lonnet::current_machine_ids();
                   10227:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
                   10228:         %folders,%containers,%mapinner);
                   10229:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   10230:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   10231:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   10232:         $pathtocheck = "$dir_root/$destination";
                   10233:         $dir = $dir_root;
                   10234:         $ishome = 1;
                   10235:     } else {
                   10236:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   10237:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
                   10238:         $dir = "$dir_root/$docudom/$docuname";    
                   10239:     }
                   10240:     my $currdir = "$dir_root/$destination";
                   10241:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   10242:     if ($env{'form.folderpath'}) {
                   10243:         my @items = split('&',$env{'form.folderpath'});
                   10244:         $folders{'0'} = $items[-2];
                   10245:         $containers{'0'}='sequence';
                   10246:     } elsif ($env{'form.pagepath'}) {
                   10247:         my @items = split('&',$env{'form.pagepath'});
                   10248:         $folders{'0'} = $items[-2];
                   10249:         $containers{'0'}='page';
                   10250:     }
                   10251:     my @archdirs = &get_env_multiple('form.archive_directory');
                   10252:     if ($numitems) {
                   10253:         for (my $i=1; $i<=$numitems; $i++) {
                   10254:             my $path = $env{'form.archive_content_'.$i};
                   10255:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   10256:                 my $item = $1;
                   10257:                 $toplevelitems{$item} = $i;
                   10258:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   10259:                     $is_dir{$item} = 1;
                   10260:                 }
                   10261:             }
                   10262:         }
                   10263:     }
1.1056    raeburn  10264:     my ($output,%children,%parent,%titles,%dirorder);
1.1055    raeburn  10265:     if (keys(%toplevelitems) > 0) {
                   10266:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  10267:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   10268:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  10269:     }
1.1056    raeburn  10270:     my (%referrer,%orphaned,%todelete,%newdest,%newseqid);
1.1055    raeburn  10271:     if ($numitems) {
                   10272:         for (my $i=1; $i<=$numitems; $i++) {
                   10273:             my $path = $env{'form.archive_content_'.$i};
                   10274:             if ($path =~ /^\Q$pathtocheck\E/) {
                   10275:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   10276:                     if ($prefix ne '' && $path ne '') {
                   10277:                         if (-e $prefix.$path) {
                   10278:                             $todelete{$prefix.$path} = 1;
                   10279:                         }
                   10280:                     }
                   10281:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
                   10282:                     my ($title,$url,$outer);
                   10283:                     ($title) = ($path =~ m{/([^/]+)$});
                   10284:                     $outer = 0;
1.1056    raeburn  10285:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   10286:                         if (@{$dirorder{$i}} > 0) {
                   10287:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  10288:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   10289:                                     $outer = $item;
                   10290:                                     last;
                   10291:                                 }
                   10292:                             }
                   10293:                         }
                   10294:                     }
                   10295:                     my ($errtext,$fatal) = 
                   10296:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   10297:                                                '/'.$folders{$outer}.'.'.
                   10298:                                                $containers{$outer});
                   10299:                     next if ($fatal);
                   10300:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   10301:                         if ($context eq 'coursedocs') {
1.1056    raeburn  10302:                             $mapinner{$i} = time;
1.1055    raeburn  10303:                             $folders{$i} = 'default_'.$mapinner{$i};
                   10304:                             $containers{$i} = 'sequence';
                   10305:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   10306:                                       $folders{$i}.'.'.$containers{$i};
                   10307:                             my $newidx = &LONCAPA::map::getresidx();
                   10308:                             $LONCAPA::map::resources[$newidx]=
                   10309:                                 $title.':'.$url.':false:normal:res';
                   10310:                             push(@LONCAPA::map::order,$newidx);
                   10311:                             my ($outtext,$errtext) =
                   10312:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   10313:                                                         $docuname.'/'.$folders{$outer}.
                   10314:                                                         '.'.$containers{$outer},1);
1.1056    raeburn  10315:                             $newseqid{$i} = $newidx;
1.1055    raeburn  10316:                         }
                   10317:                     } else {
                   10318:                         if ($context eq 'coursedocs') {
                   10319:                             my $newidx=&LONCAPA::map::getresidx();
                   10320:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   10321:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   10322:                                       $title;
                   10323:                             if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   10324:                                 mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
                   10325:                             }
                   10326:                             if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   10327:                                 mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   10328:                             }
                   10329:                             if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   10330:                                 system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056    raeburn  10331:                                 $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1055    raeburn  10332:                             }
                   10333:                             $LONCAPA::map::resources[$newidx]=
                   10334:                                 $title.':'.$url.':false:normal:res';
                   10335:                             push(@LONCAPA::map::order, $newidx);
                   10336:                             my ($outtext,$errtext)=
                   10337:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   10338:                                                         $docuname.'/'.$folders{$outer}.
                   10339:                                                         '.'.$containers{$outer},1);
                   10340:                         }
                   10341:                     }
                   10342:                 } elsif ($env{'form.archive_'.$i} eq 'dependency') {
1.1056    raeburn  10343:                     my ($title) = ($path =~ m{/([^/]+)$});
                   10344:                     $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   10345:                     if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   10346:                         if (ref($dirorder{$i}) eq 'ARRAY') {
                   10347:                             my ($itemidx,$fullpath);
                   10348:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
                   10349:                                 if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   10350:                                     my $container = $dirorder{$referrer{$i}}->[-1];
                   10351:                                     for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
                   10352:                                         if ($dirorder{$i}->[$j] eq $container) {
                   10353:                                             $itemidx = $j;
                   10354:                                         }
                   10355:                                     }
                   10356:                                 }
                   10357:                             }
                   10358:                             if ($itemidx ne '') {
                   10359:                                 if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   10360:                                     if ($mapinner{$referrer{$i}}) {
                   10361:                                         $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   10362:                                         for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   10363:                                             if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   10364:                                                 unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   10365:                                                     $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   10366:                                                     if (!-e $fullpath) {
                   10367:                                                         mkdir($fullpath,0755);
                   10368:                                                     }
                   10369:                                                 }
                   10370:                                             } else {
                   10371:                                                 last;
                   10372:                                             }
                   10373:                                         }
                   10374:                                     }
                   10375:                                 } elsif ($newdest{$referrer{$i}}) {
                   10376:                                     $fullpath = $newdest{$referrer{$i}};
                   10377:                                     for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   10378:                                         if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   10379:                                             $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   10380:                                             last;
                   10381:                                         } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   10382:                                             unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   10383:                                                 $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   10384:                                                 if (!-e $fullpath) {
                   10385:                                                     mkdir($fullpath,0755);
                   10386:                                                 }
                   10387:                                             }
                   10388:                                         } else {
                   10389:                                             last;
                   10390:                                         }
                   10391:                                     }
                   10392:                                 }
                   10393:                                 if ($fullpath ne '') {
                   10394:                                     system("mv $prefix$path $fullpath/$title");
                   10395:                                 }
1.1055    raeburn  10396:                             }
                   10397:                         }
1.1056    raeburn  10398:                     } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   10399:                         $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
                   10400:                                         $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055    raeburn  10401:                     }
                   10402:                 }
                   10403:             } else {
                   10404:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />'; 
                   10405:             }
                   10406:         }
                   10407:         if (keys(%todelete)) {
                   10408:             foreach my $key (keys(%todelete)) {
                   10409:                 unlink($key);
                   10410:                 unless ($ishome) {
                   10411:                     #FIXME Need to notify homeserver to delete files.
                   10412:                 }
                   10413:             }
                   10414:         }
                   10415:     } else {
                   10416:         $warning = &mt('No items found in archive.');
                   10417:     }
                   10418:     if ($error) {
                   10419:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   10420:                    $error.'</p>'."\n";
                   10421:     }
                   10422:     if ($warning) {
                   10423:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   10424:     }
                   10425:     return $output;
                   10426: }
                   10427: 
1.41      ng       10428: =pod
1.45      matthew  10429: 
1.1015    raeburn  10430: =item * &get_turnedin_filepath()
                   10431: 
                   10432: Determines path in a user's portfolio file for storage of files uploaded
                   10433: to a specific essayresponse or dropbox item.
                   10434: 
                   10435: Inputs: 3 required + 1 optional.
                   10436: $symb is symb for resource, $uname and $udom are for current user (required).
                   10437: $caller is optional (can be "submission", if routine is called when storing
                   10438: an upoaded file when "Submit Answer" button was pressed).
                   10439: 
                   10440: Returns array containing $path and $multiresp. 
                   10441: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   10442: than one file upload item.  Callers of routine should append partid as a 
                   10443: subdirectory to $path in cases where $multiresp is 1.
                   10444: 
                   10445: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   10446: 
                   10447: =cut
                   10448: 
                   10449: sub get_turnedin_filepath {
                   10450:     my ($symb,$uname,$udom,$caller) = @_;
                   10451:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   10452:     my $turnindir;
                   10453:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   10454:     $turnindir = $userhash{'turnindir'};
                   10455:     my ($path,$multiresp);
                   10456:     if ($turnindir eq '') {
                   10457:         if ($caller eq 'submission') {
                   10458:             $turnindir = &mt('turned in');
                   10459:             $turnindir =~ s/\W+/_/g;
                   10460:             my %newhash = (
                   10461:                             'turnindir' => $turnindir,
                   10462:                           );
                   10463:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   10464:         }
                   10465:     }
                   10466:     if ($turnindir ne '') {
                   10467:         $path = '/'.$turnindir.'/';
                   10468:         my ($multipart,$turnin,@pathitems);
                   10469:         my $navmap = Apache::lonnavmaps::navmap->new();
                   10470:         if (defined($navmap)) {
                   10471:             my $mapres = $navmap->getResourceByUrl($map);
                   10472:             if (ref($mapres)) {
                   10473:                 my $pcslist = $mapres->map_hierarchy();
                   10474:                 if ($pcslist ne '') {
                   10475:                     foreach my $pc (split(/,/,$pcslist)) {
                   10476:                         my $res = $navmap->getByMapPc($pc);
                   10477:                         if (ref($res)) {
                   10478:                             my $title = $res->compTitle();
                   10479:                             $title =~ s/\W+/_/g;
                   10480:                             if ($title ne '') {
                   10481:                                 push(@pathitems,$title);
                   10482:                             }
                   10483:                         }
                   10484:                     }
                   10485:                 }
                   10486:                 my $maptitle = $mapres->compTitle();
                   10487:                 $maptitle =~ s/\W+/_/g;
                   10488:                 if ($maptitle ne '') {
                   10489:                     push(@pathitems,$maptitle);
                   10490:                 }
                   10491:                 unless ($env{'request.state'} eq 'construct') {
                   10492:                     my $res = $navmap->getBySymb($symb);
                   10493:                     if (ref($res)) {
                   10494:                         my $partlist = $res->parts();
                   10495:                         my $totaluploads = 0;
                   10496:                         if (ref($partlist) eq 'ARRAY') {
                   10497:                             foreach my $part (@{$partlist}) {
                   10498:                                 my @types = $res->responseType($part);
                   10499:                                 my @ids = $res->responseIds($part);
                   10500:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   10501:                                     if ($types[$i] eq 'essay') {
                   10502:                                         my $partid = $part.'_'.$ids[$i];
                   10503:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   10504:                                             $totaluploads ++;
                   10505:                                         }
                   10506:                                     }
                   10507:                                 }
                   10508:                             }
                   10509:                             if ($totaluploads > 1) {
                   10510:                                 $multiresp = 1;
                   10511:                             }
                   10512:                         }
                   10513:                     }
                   10514:                 }
                   10515:             } else {
                   10516:                 return;
                   10517:             }
                   10518:         } else {
                   10519:             return;
                   10520:         }
                   10521:         my $restitle=&Apache::lonnet::gettitle($symb);
                   10522:         $restitle =~ s/\W+/_/g;
                   10523:         if ($restitle eq '') {
                   10524:             $restitle = ($resurl =~ m{/[^/]+$});
                   10525:             if ($restitle eq '') {
                   10526:                 $restitle = time;
                   10527:             }
                   10528:         }
                   10529:         push(@pathitems,$restitle);
                   10530:         $path .= join('/',@pathitems);
                   10531:     }
                   10532:     return ($path,$multiresp);
                   10533: }
                   10534: 
                   10535: =pod
                   10536: 
1.464     albertel 10537: =back
1.41      ng       10538: 
1.112     bowersj2 10539: =head1 CSV Upload/Handling functions
1.38      albertel 10540: 
1.41      ng       10541: =over 4
                   10542: 
1.648     raeburn  10543: =item * &upfile_store($r)
1.41      ng       10544: 
                   10545: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 10546: needs $env{'form.upfile'}
1.41      ng       10547: returns $datatoken to be put into hidden field
                   10548: 
                   10549: =cut
1.31      albertel 10550: 
                   10551: sub upfile_store {
                   10552:     my $r=shift;
1.258     albertel 10553:     $env{'form.upfile'}=~s/\r/\n/gs;
                   10554:     $env{'form.upfile'}=~s/\f/\n/gs;
                   10555:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   10556:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 10557: 
1.258     albertel 10558:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   10559: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 10560:     {
1.158     raeburn  10561:         my $datafile = $r->dir_config('lonDaemons').
                   10562:                            '/tmp/'.$datatoken.'.tmp';
                   10563:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 10564:             print $fh $env{'form.upfile'};
1.158     raeburn  10565:             close($fh);
                   10566:         }
1.31      albertel 10567:     }
                   10568:     return $datatoken;
                   10569: }
                   10570: 
1.56      matthew  10571: =pod
                   10572: 
1.648     raeburn  10573: =item * &load_tmp_file($r)
1.41      ng       10574: 
                   10575: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 10576: needs $env{'form.datatoken'},
                   10577: sets $env{'form.upfile'} to the contents of the file
1.41      ng       10578: 
                   10579: =cut
1.31      albertel 10580: 
                   10581: sub load_tmp_file {
                   10582:     my $r=shift;
                   10583:     my @studentdata=();
                   10584:     {
1.158     raeburn  10585:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 10586:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  10587:         if ( open(my $fh,"<$studentfile") ) {
                   10588:             @studentdata=<$fh>;
                   10589:             close($fh);
                   10590:         }
1.31      albertel 10591:     }
1.258     albertel 10592:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 10593: }
                   10594: 
1.56      matthew  10595: =pod
                   10596: 
1.648     raeburn  10597: =item * &upfile_record_sep()
1.41      ng       10598: 
                   10599: Separate uploaded file into records
                   10600: returns array of records,
1.258     albertel 10601: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       10602: 
                   10603: =cut
1.31      albertel 10604: 
                   10605: sub upfile_record_sep {
1.258     albertel 10606:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 10607:     } else {
1.248     albertel 10608: 	my @records;
1.258     albertel 10609: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 10610: 	    if ($line=~/^\s*$/) { next; }
                   10611: 	    push(@records,$line);
                   10612: 	}
                   10613: 	return @records;
1.31      albertel 10614:     }
                   10615: }
                   10616: 
1.56      matthew  10617: =pod
                   10618: 
1.648     raeburn  10619: =item * &record_sep($record)
1.41      ng       10620: 
1.258     albertel 10621: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       10622: 
                   10623: =cut
                   10624: 
1.263     www      10625: sub takeleft {
                   10626:     my $index=shift;
                   10627:     return substr('0000'.$index,-4,4);
                   10628: }
                   10629: 
1.31      albertel 10630: sub record_sep {
                   10631:     my $record=shift;
                   10632:     my %components=();
1.258     albertel 10633:     if ($env{'form.upfiletype'} eq 'xml') {
                   10634:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 10635:         my $i=0;
1.356     albertel 10636:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 10637:             $field=~s/^(\"|\')//;
                   10638:             $field=~s/(\"|\')$//;
1.263     www      10639:             $components{&takeleft($i)}=$field;
1.31      albertel 10640:             $i++;
                   10641:         }
1.258     albertel 10642:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 10643:         my $i=0;
1.356     albertel 10644:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 10645:             $field=~s/^(\"|\')//;
                   10646:             $field=~s/(\"|\')$//;
1.263     www      10647:             $components{&takeleft($i)}=$field;
1.31      albertel 10648:             $i++;
                   10649:         }
                   10650:     } else {
1.561     www      10651:         my $separator=',';
1.480     banghart 10652:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      10653:             $separator=';';
1.480     banghart 10654:         }
1.31      albertel 10655:         my $i=0;
1.561     www      10656: # the character we are looking for to indicate the end of a quote or a record 
                   10657:         my $looking_for=$separator;
                   10658: # do not add the characters to the fields
                   10659:         my $ignore=0;
                   10660: # we just encountered a separator (or the beginning of the record)
                   10661:         my $just_found_separator=1;
                   10662: # store the field we are working on here
                   10663:         my $field='';
                   10664: # work our way through all characters in record
                   10665:         foreach my $character ($record=~/(.)/g) {
                   10666:             if ($character eq $looking_for) {
                   10667:                if ($character ne $separator) {
                   10668: # Found the end of a quote, again looking for separator
                   10669:                   $looking_for=$separator;
                   10670:                   $ignore=1;
                   10671:                } else {
                   10672: # Found a separator, store away what we got
                   10673:                   $components{&takeleft($i)}=$field;
                   10674: 	          $i++;
                   10675:                   $just_found_separator=1;
                   10676:                   $ignore=0;
                   10677:                   $field='';
                   10678:                }
                   10679:                next;
                   10680:             }
                   10681: # single or double quotation marks after a separator indicate beginning of a quote
                   10682: # we are now looking for the end of the quote and need to ignore separators
                   10683:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   10684:                $looking_for=$character;
                   10685:                next;
                   10686:             }
                   10687: # ignore would be true after we reached the end of a quote
                   10688:             if ($ignore) { next; }
                   10689:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   10690:             $field.=$character;
                   10691:             $just_found_separator=0; 
1.31      albertel 10692:         }
1.561     www      10693: # catch the very last entry, since we never encountered the separator
                   10694:         $components{&takeleft($i)}=$field;
1.31      albertel 10695:     }
                   10696:     return %components;
                   10697: }
                   10698: 
1.144     matthew  10699: ######################################################
                   10700: ######################################################
                   10701: 
1.56      matthew  10702: =pod
                   10703: 
1.648     raeburn  10704: =item * &upfile_select_html()
1.41      ng       10705: 
1.144     matthew  10706: Return HTML code to select a file from the users machine and specify 
                   10707: the file type.
1.41      ng       10708: 
                   10709: =cut
                   10710: 
1.144     matthew  10711: ######################################################
                   10712: ######################################################
1.31      albertel 10713: sub upfile_select_html {
1.144     matthew  10714:     my %Types = (
                   10715:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 10716:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  10717:                  space => &mt('Space separated'),
                   10718:                  tab   => &mt('Tabulator separated'),
                   10719: #                 xml   => &mt('HTML/XML'),
                   10720:                  );
                   10721:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  10722:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  10723:     foreach my $type (sort(keys(%Types))) {
                   10724:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   10725:     }
                   10726:     $Str .= "</select>\n";
                   10727:     return $Str;
1.31      albertel 10728: }
                   10729: 
1.301     albertel 10730: sub get_samples {
                   10731:     my ($records,$toget) = @_;
                   10732:     my @samples=({});
                   10733:     my $got=0;
                   10734:     foreach my $rec (@$records) {
                   10735: 	my %temp = &record_sep($rec);
                   10736: 	if (! grep(/\S/, values(%temp))) { next; }
                   10737: 	if (%temp) {
                   10738: 	    $samples[$got]=\%temp;
                   10739: 	    $got++;
                   10740: 	    if ($got == $toget) { last; }
                   10741: 	}
                   10742:     }
                   10743:     return \@samples;
                   10744: }
                   10745: 
1.144     matthew  10746: ######################################################
                   10747: ######################################################
                   10748: 
1.56      matthew  10749: =pod
                   10750: 
1.648     raeburn  10751: =item * &csv_print_samples($r,$records)
1.41      ng       10752: 
                   10753: Prints a table of sample values from each column uploaded $r is an
                   10754: Apache Request ref, $records is an arrayref from
                   10755: &Apache::loncommon::upfile_record_sep
                   10756: 
                   10757: =cut
                   10758: 
1.144     matthew  10759: ######################################################
                   10760: ######################################################
1.31      albertel 10761: sub csv_print_samples {
                   10762:     my ($r,$records) = @_;
1.662     bisitz   10763:     my $samples = &get_samples($records,5);
1.301     albertel 10764: 
1.594     raeburn  10765:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   10766:               &start_data_table_header_row());
1.356     albertel 10767:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   10768:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  10769:     $r->print(&end_data_table_header_row());
1.301     albertel 10770:     foreach my $hash (@$samples) {
1.594     raeburn  10771: 	$r->print(&start_data_table_row());
1.356     albertel 10772: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 10773: 	    $r->print('<td>');
1.356     albertel 10774: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 10775: 	    $r->print('</td>');
                   10776: 	}
1.594     raeburn  10777: 	$r->print(&end_data_table_row());
1.31      albertel 10778:     }
1.594     raeburn  10779:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 10780: }
                   10781: 
1.144     matthew  10782: ######################################################
                   10783: ######################################################
                   10784: 
1.56      matthew  10785: =pod
                   10786: 
1.648     raeburn  10787: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       10788: 
                   10789: Prints a table to create associations between values and table columns.
1.144     matthew  10790: 
1.41      ng       10791: $r is an Apache Request ref,
                   10792: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  10793: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       10794: 
                   10795: =cut
                   10796: 
1.144     matthew  10797: ######################################################
                   10798: ######################################################
1.31      albertel 10799: sub csv_print_select_table {
                   10800:     my ($r,$records,$d) = @_;
1.301     albertel 10801:     my $i=0;
                   10802:     my $samples = &get_samples($records,1);
1.144     matthew  10803:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  10804: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  10805:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  10806:               '<th>'.&mt('Column').'</th>'.
                   10807:               &end_data_table_header_row()."\n");
1.356     albertel 10808:     foreach my $array_ref (@$d) {
                   10809: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  10810: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 10811: 
1.875     bisitz   10812: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  10813: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 10814: 	$r->print('<option value="none"></option>');
1.356     albertel 10815: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   10816: 	    $r->print('<option value="'.$sample.'"'.
                   10817:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   10818:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 10819: 	}
1.594     raeburn  10820: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 10821: 	$i++;
                   10822:     }
1.594     raeburn  10823:     $r->print(&end_data_table());
1.31      albertel 10824:     $i--;
                   10825:     return $i;
                   10826: }
1.56      matthew  10827: 
1.144     matthew  10828: ######################################################
                   10829: ######################################################
                   10830: 
1.56      matthew  10831: =pod
1.31      albertel 10832: 
1.648     raeburn  10833: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       10834: 
                   10835: Prints a table of sample values from the upload and can make associate samples to internal names.
                   10836: 
                   10837: $r is an Apache Request ref,
                   10838: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   10839: $d is an array of 2 element arrays (internal name, displayed name)
                   10840: 
                   10841: =cut
                   10842: 
1.144     matthew  10843: ######################################################
                   10844: ######################################################
1.31      albertel 10845: sub csv_samples_select_table {
                   10846:     my ($r,$records,$d) = @_;
                   10847:     my $i=0;
1.144     matthew  10848:     #
1.662     bisitz   10849:     my $max_samples = 5;
                   10850:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  10851:     $r->print(&start_data_table().
                   10852:               &start_data_table_header_row().'<th>'.
                   10853:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   10854:               &end_data_table_header_row());
1.301     albertel 10855: 
                   10856:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  10857: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  10858: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 10859: 	foreach my $option (@$d) {
                   10860: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  10861: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 10862:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  10863:                       $display.'</option>');
1.31      albertel 10864: 	}
                   10865: 	$r->print('</select></td><td>');
1.662     bisitz   10866: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 10867: 	    if (defined($samples->[$line]{$key})) { 
                   10868: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   10869: 	    }
                   10870: 	}
1.594     raeburn  10871: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 10872: 	$i++;
                   10873:     }
1.594     raeburn  10874:     $r->print(&end_data_table());
1.31      albertel 10875:     $i--;
                   10876:     return($i);
1.115     matthew  10877: }
                   10878: 
1.144     matthew  10879: ######################################################
                   10880: ######################################################
                   10881: 
1.115     matthew  10882: =pod
                   10883: 
1.648     raeburn  10884: =item * &clean_excel_name($name)
1.115     matthew  10885: 
                   10886: Returns a replacement for $name which does not contain any illegal characters.
                   10887: 
                   10888: =cut
                   10889: 
1.144     matthew  10890: ######################################################
                   10891: ######################################################
1.115     matthew  10892: sub clean_excel_name {
                   10893:     my ($name) = @_;
                   10894:     $name =~ s/[:\*\?\/\\]//g;
                   10895:     if (length($name) > 31) {
                   10896:         $name = substr($name,0,31);
                   10897:     }
                   10898:     return $name;
1.25      albertel 10899: }
1.84      albertel 10900: 
1.85      albertel 10901: =pod
                   10902: 
1.648     raeburn  10903: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 10904: 
                   10905: Returns either 1 or undef
                   10906: 
                   10907: 1 if the part is to be hidden, undef if it is to be shown
                   10908: 
                   10909: Arguments are:
                   10910: 
                   10911: $id the id of the part to be checked
                   10912: $symb, optional the symb of the resource to check
                   10913: $udom, optional the domain of the user to check for
                   10914: $uname, optional the username of the user to check for
                   10915: 
                   10916: =cut
1.84      albertel 10917: 
                   10918: sub check_if_partid_hidden {
                   10919:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 10920:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 10921: 					 $symb,$udom,$uname);
1.141     albertel 10922:     my $truth=1;
                   10923:     #if the string starts with !, then the list is the list to show not hide
                   10924:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 10925:     my @hiddenlist=split(/,/,$hiddenparts);
                   10926:     foreach my $checkid (@hiddenlist) {
1.141     albertel 10927: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 10928:     }
1.141     albertel 10929:     return !$truth;
1.84      albertel 10930: }
1.127     matthew  10931: 
1.138     matthew  10932: 
                   10933: ############################################################
                   10934: ############################################################
                   10935: 
                   10936: =pod
                   10937: 
1.157     matthew  10938: =back 
                   10939: 
1.138     matthew  10940: =head1 cgi-bin script and graphing routines
                   10941: 
1.157     matthew  10942: =over 4
                   10943: 
1.648     raeburn  10944: =item * &get_cgi_id()
1.138     matthew  10945: 
                   10946: Inputs: none
                   10947: 
                   10948: Returns an id which can be used to pass environment variables
                   10949: to various cgi-bin scripts.  These environment variables will
                   10950: be removed from the users environment after a given time by
                   10951: the routine &Apache::lonnet::transfer_profile_to_env.
                   10952: 
                   10953: =cut
                   10954: 
                   10955: ############################################################
                   10956: ############################################################
1.152     albertel 10957: my $uniq=0;
1.136     matthew  10958: sub get_cgi_id {
1.154     albertel 10959:     $uniq=($uniq+1)%100000;
1.280     albertel 10960:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  10961: }
                   10962: 
1.127     matthew  10963: ############################################################
                   10964: ############################################################
                   10965: 
                   10966: =pod
                   10967: 
1.648     raeburn  10968: =item * &DrawBarGraph()
1.127     matthew  10969: 
1.138     matthew  10970: Facilitates the plotting of data in a (stacked) bar graph.
                   10971: Puts plot definition data into the users environment in order for 
                   10972: graph.png to plot it.  Returns an <img> tag for the plot.
                   10973: The bars on the plot are labeled '1','2',...,'n'.
                   10974: 
                   10975: Inputs:
                   10976: 
                   10977: =over 4
                   10978: 
                   10979: =item $Title: string, the title of the plot
                   10980: 
                   10981: =item $xlabel: string, text describing the X-axis of the plot
                   10982: 
                   10983: =item $ylabel: string, text describing the Y-axis of the plot
                   10984: 
                   10985: =item $Max: scalar, the maximum Y value to use in the plot
                   10986: If $Max is < any data point, the graph will not be rendered.
                   10987: 
1.140     matthew  10988: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  10989: they are plotted.  If undefined, default values will be used.
                   10990: 
1.178     matthew  10991: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   10992: 
1.138     matthew  10993: =item @Values: An array of array references.  Each array reference holds data
                   10994: to be plotted in a stacked bar chart.
                   10995: 
1.239     matthew  10996: =item If the final element of @Values is a hash reference the key/value
                   10997: pairs will be added to the graph definition.
                   10998: 
1.138     matthew  10999: =back
                   11000: 
                   11001: Returns:
                   11002: 
                   11003: An <img> tag which references graph.png and the appropriate identifying
                   11004: information for the plot.
                   11005: 
1.127     matthew  11006: =cut
                   11007: 
                   11008: ############################################################
                   11009: ############################################################
1.134     matthew  11010: sub DrawBarGraph {
1.178     matthew  11011:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  11012:     #
                   11013:     if (! defined($colors)) {
                   11014:         $colors = ['#33ff00', 
                   11015:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   11016:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   11017:                   ]; 
                   11018:     }
1.228     matthew  11019:     my $extra_settings = {};
                   11020:     if (ref($Values[-1]) eq 'HASH') {
                   11021:         $extra_settings = pop(@Values);
                   11022:     }
1.127     matthew  11023:     #
1.136     matthew  11024:     my $identifier = &get_cgi_id();
                   11025:     my $id = 'cgi.'.$identifier;        
1.129     matthew  11026:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  11027:         return '';
                   11028:     }
1.225     matthew  11029:     #
                   11030:     my @Labels;
                   11031:     if (defined($labels)) {
                   11032:         @Labels = @$labels;
                   11033:     } else {
                   11034:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   11035:             push (@Labels,$i+1);
                   11036:         }
                   11037:     }
                   11038:     #
1.129     matthew  11039:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  11040:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  11041:     my %ValuesHash;
                   11042:     my $NumSets=1;
                   11043:     foreach my $array (@Values) {
                   11044:         next if (! ref($array));
1.136     matthew  11045:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  11046:             join(',',@$array);
1.129     matthew  11047:     }
1.127     matthew  11048:     #
1.136     matthew  11049:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  11050:     if ($NumBars < 3) {
                   11051:         $width = 120+$NumBars*32;
1.220     matthew  11052:         $xskip = 1;
1.225     matthew  11053:         $bar_width = 30;
                   11054:     } elsif ($NumBars < 5) {
                   11055:         $width = 120+$NumBars*20;
                   11056:         $xskip = 1;
                   11057:         $bar_width = 20;
1.220     matthew  11058:     } elsif ($NumBars < 10) {
1.136     matthew  11059:         $width = 120+$NumBars*15;
                   11060:         $xskip = 1;
                   11061:         $bar_width = 15;
                   11062:     } elsif ($NumBars <= 25) {
                   11063:         $width = 120+$NumBars*11;
                   11064:         $xskip = 5;
                   11065:         $bar_width = 8;
                   11066:     } elsif ($NumBars <= 50) {
                   11067:         $width = 120+$NumBars*8;
                   11068:         $xskip = 5;
                   11069:         $bar_width = 4;
                   11070:     } else {
                   11071:         $width = 120+$NumBars*8;
                   11072:         $xskip = 5;
                   11073:         $bar_width = 4;
                   11074:     }
                   11075:     #
1.137     matthew  11076:     $Max = 1 if ($Max < 1);
                   11077:     if ( int($Max) < $Max ) {
                   11078:         $Max++;
                   11079:         $Max = int($Max);
                   11080:     }
1.127     matthew  11081:     $Title  = '' if (! defined($Title));
                   11082:     $xlabel = '' if (! defined($xlabel));
                   11083:     $ylabel = '' if (! defined($ylabel));
1.369     www      11084:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   11085:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   11086:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  11087:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  11088:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   11089:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   11090:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   11091:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   11092:     $ValuesHash{$id.'.height'}   = $height;
                   11093:     $ValuesHash{$id.'.width'}    = $width;
                   11094:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   11095:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   11096:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  11097:     #
1.228     matthew  11098:     # Deal with other parameters
                   11099:     while (my ($key,$value) = each(%$extra_settings)) {
                   11100:         $ValuesHash{$id.'.'.$key} = $value;
                   11101:     }
                   11102:     #
1.646     raeburn  11103:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  11104:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   11105: }
                   11106: 
                   11107: ############################################################
                   11108: ############################################################
                   11109: 
                   11110: =pod
                   11111: 
1.648     raeburn  11112: =item * &DrawXYGraph()
1.137     matthew  11113: 
1.138     matthew  11114: Facilitates the plotting of data in an XY graph.
                   11115: Puts plot definition data into the users environment in order for 
                   11116: graph.png to plot it.  Returns an <img> tag for the plot.
                   11117: 
                   11118: Inputs:
                   11119: 
                   11120: =over 4
                   11121: 
                   11122: =item $Title: string, the title of the plot
                   11123: 
                   11124: =item $xlabel: string, text describing the X-axis of the plot
                   11125: 
                   11126: =item $ylabel: string, text describing the Y-axis of the plot
                   11127: 
                   11128: =item $Max: scalar, the maximum Y value to use in the plot
                   11129: If $Max is < any data point, the graph will not be rendered.
                   11130: 
                   11131: =item $colors: Array ref containing the hex color codes for the data to be 
                   11132: plotted in.  If undefined, default values will be used.
                   11133: 
                   11134: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   11135: 
                   11136: =item $Ydata: Array ref containing Array refs.  
1.185     www      11137: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  11138: 
                   11139: =item %Values: hash indicating or overriding any default values which are 
                   11140: passed to graph.png.  
                   11141: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   11142: 
                   11143: =back
                   11144: 
                   11145: Returns:
                   11146: 
                   11147: An <img> tag which references graph.png and the appropriate identifying
                   11148: information for the plot.
                   11149: 
1.137     matthew  11150: =cut
                   11151: 
                   11152: ############################################################
                   11153: ############################################################
                   11154: sub DrawXYGraph {
                   11155:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   11156:     #
                   11157:     # Create the identifier for the graph
                   11158:     my $identifier = &get_cgi_id();
                   11159:     my $id = 'cgi.'.$identifier;
                   11160:     #
                   11161:     $Title  = '' if (! defined($Title));
                   11162:     $xlabel = '' if (! defined($xlabel));
                   11163:     $ylabel = '' if (! defined($ylabel));
                   11164:     my %ValuesHash = 
                   11165:         (
1.369     www      11166:          $id.'.title'  => &escape($Title),
                   11167:          $id.'.xlabel' => &escape($xlabel),
                   11168:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  11169:          $id.'.y_max_value'=> $Max,
                   11170:          $id.'.labels'     => join(',',@$Xlabels),
                   11171:          $id.'.PlotType'   => 'XY',
                   11172:          );
                   11173:     #
                   11174:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   11175:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   11176:     }
                   11177:     #
                   11178:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   11179:         return '';
                   11180:     }
                   11181:     my $NumSets=1;
1.138     matthew  11182:     foreach my $array (@{$Ydata}){
1.137     matthew  11183:         next if (! ref($array));
                   11184:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   11185:     }
1.138     matthew  11186:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  11187:     #
                   11188:     # Deal with other parameters
                   11189:     while (my ($key,$value) = each(%Values)) {
                   11190:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  11191:     }
                   11192:     #
1.646     raeburn  11193:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  11194:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   11195: }
                   11196: 
                   11197: ############################################################
                   11198: ############################################################
                   11199: 
                   11200: =pod
                   11201: 
1.648     raeburn  11202: =item * &DrawXYYGraph()
1.138     matthew  11203: 
                   11204: Facilitates the plotting of data in an XY graph with two Y axes.
                   11205: Puts plot definition data into the users environment in order for 
                   11206: graph.png to plot it.  Returns an <img> tag for the plot.
                   11207: 
                   11208: Inputs:
                   11209: 
                   11210: =over 4
                   11211: 
                   11212: =item $Title: string, the title of the plot
                   11213: 
                   11214: =item $xlabel: string, text describing the X-axis of the plot
                   11215: 
                   11216: =item $ylabel: string, text describing the Y-axis of the plot
                   11217: 
                   11218: =item $colors: Array ref containing the hex color codes for the data to be 
                   11219: plotted in.  If undefined, default values will be used.
                   11220: 
                   11221: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   11222: 
                   11223: =item $Ydata1: The first data set
                   11224: 
                   11225: =item $Min1: The minimum value of the left Y-axis
                   11226: 
                   11227: =item $Max1: The maximum value of the left Y-axis
                   11228: 
                   11229: =item $Ydata2: The second data set
                   11230: 
                   11231: =item $Min2: The minimum value of the right Y-axis
                   11232: 
                   11233: =item $Max2: The maximum value of the left Y-axis
                   11234: 
                   11235: =item %Values: hash indicating or overriding any default values which are 
                   11236: passed to graph.png.  
                   11237: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   11238: 
                   11239: =back
                   11240: 
                   11241: Returns:
                   11242: 
                   11243: An <img> tag which references graph.png and the appropriate identifying
                   11244: information for the plot.
1.136     matthew  11245: 
                   11246: =cut
                   11247: 
                   11248: ############################################################
                   11249: ############################################################
1.137     matthew  11250: sub DrawXYYGraph {
                   11251:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   11252:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  11253:     #
                   11254:     # Create the identifier for the graph
                   11255:     my $identifier = &get_cgi_id();
                   11256:     my $id = 'cgi.'.$identifier;
                   11257:     #
                   11258:     $Title  = '' if (! defined($Title));
                   11259:     $xlabel = '' if (! defined($xlabel));
                   11260:     $ylabel = '' if (! defined($ylabel));
                   11261:     my %ValuesHash = 
                   11262:         (
1.369     www      11263:          $id.'.title'  => &escape($Title),
                   11264:          $id.'.xlabel' => &escape($xlabel),
                   11265:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  11266:          $id.'.labels' => join(',',@$Xlabels),
                   11267:          $id.'.PlotType' => 'XY',
                   11268:          $id.'.NumSets' => 2,
1.137     matthew  11269:          $id.'.two_axes' => 1,
                   11270:          $id.'.y1_max_value' => $Max1,
                   11271:          $id.'.y1_min_value' => $Min1,
                   11272:          $id.'.y2_max_value' => $Max2,
                   11273:          $id.'.y2_min_value' => $Min2,
1.136     matthew  11274:          );
                   11275:     #
1.137     matthew  11276:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   11277:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   11278:     }
                   11279:     #
                   11280:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   11281:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  11282:         return '';
                   11283:     }
                   11284:     my $NumSets=1;
1.137     matthew  11285:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  11286:         next if (! ref($array));
                   11287:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  11288:     }
                   11289:     #
                   11290:     # Deal with other parameters
                   11291:     while (my ($key,$value) = each(%Values)) {
                   11292:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  11293:     }
                   11294:     #
1.646     raeburn  11295:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 11296:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  11297: }
                   11298: 
                   11299: ############################################################
                   11300: ############################################################
                   11301: 
                   11302: =pod
                   11303: 
1.157     matthew  11304: =back 
                   11305: 
1.139     matthew  11306: =head1 Statistics helper routines?  
                   11307: 
                   11308: Bad place for them but what the hell.
                   11309: 
1.157     matthew  11310: =over 4
                   11311: 
1.648     raeburn  11312: =item * &chartlink()
1.139     matthew  11313: 
                   11314: Returns a link to the chart for a specific student.  
                   11315: 
                   11316: Inputs:
                   11317: 
                   11318: =over 4
                   11319: 
                   11320: =item $linktext: The text of the link
                   11321: 
                   11322: =item $sname: The students username
                   11323: 
                   11324: =item $sdomain: The students domain
                   11325: 
                   11326: =back
                   11327: 
1.157     matthew  11328: =back
                   11329: 
1.139     matthew  11330: =cut
                   11331: 
                   11332: ############################################################
                   11333: ############################################################
                   11334: sub chartlink {
                   11335:     my ($linktext, $sname, $sdomain) = @_;
                   11336:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      11337:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 11338:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  11339:        '">'.$linktext.'</a>';
1.153     matthew  11340: }
                   11341: 
                   11342: #######################################################
                   11343: #######################################################
                   11344: 
                   11345: =pod
                   11346: 
                   11347: =head1 Course Environment Routines
1.157     matthew  11348: 
                   11349: =over 4
1.153     matthew  11350: 
1.648     raeburn  11351: =item * &restore_course_settings()
1.153     matthew  11352: 
1.648     raeburn  11353: =item * &store_course_settings()
1.153     matthew  11354: 
                   11355: Restores/Store indicated form parameters from the course environment.
                   11356: Will not overwrite existing values of the form parameters.
                   11357: 
                   11358: Inputs: 
                   11359: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   11360: 
                   11361: a hash ref describing the data to be stored.  For example:
                   11362:    
                   11363: %Save_Parameters = ('Status' => 'scalar',
                   11364:     'chartoutputmode' => 'scalar',
                   11365:     'chartoutputdata' => 'scalar',
                   11366:     'Section' => 'array',
1.373     raeburn  11367:     'Group' => 'array',
1.153     matthew  11368:     'StudentData' => 'array',
                   11369:     'Maps' => 'array');
                   11370: 
                   11371: Returns: both routines return nothing
                   11372: 
1.631     raeburn  11373: =back
                   11374: 
1.153     matthew  11375: =cut
                   11376: 
                   11377: #######################################################
                   11378: #######################################################
                   11379: sub store_course_settings {
1.496     albertel 11380:     return &store_settings($env{'request.course.id'},@_);
                   11381: }
                   11382: 
                   11383: sub store_settings {
1.153     matthew  11384:     # save to the environment
                   11385:     # appenv the same items, just to be safe
1.300     albertel 11386:     my $udom  = $env{'user.domain'};
                   11387:     my $uname = $env{'user.name'};
1.496     albertel 11388:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  11389:     my %SaveHash;
                   11390:     my %AppHash;
                   11391:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 11392:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 11393:         my $envname = 'environment.'.$basename;
1.258     albertel 11394:         if (exists($env{'form.'.$setting})) {
1.153     matthew  11395:             # Save this value away
                   11396:             if ($type eq 'scalar' &&
1.258     albertel 11397:                 (! exists($env{$envname}) || 
                   11398:                  $env{$envname} ne $env{'form.'.$setting})) {
                   11399:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   11400:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  11401:             } elsif ($type eq 'array') {
                   11402:                 my $stored_form;
1.258     albertel 11403:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  11404:                     $stored_form = join(',',
                   11405:                                         map {
1.369     www      11406:                                             &escape($_);
1.258     albertel 11407:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  11408:                 } else {
                   11409:                     $stored_form = 
1.369     www      11410:                         &escape($env{'form.'.$setting});
1.153     matthew  11411:                 }
                   11412:                 # Determine if the array contents are the same.
1.258     albertel 11413:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  11414:                     $SaveHash{$basename} = $stored_form;
                   11415:                     $AppHash{$envname}   = $stored_form;
                   11416:                 }
                   11417:             }
                   11418:         }
                   11419:     }
                   11420:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 11421:                                           $udom,$uname);
1.153     matthew  11422:     if ($put_result !~ /^(ok|delayed)/) {
                   11423:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   11424:                                  'got error:'.$put_result);
                   11425:     }
                   11426:     # Make sure these settings stick around in this session, too
1.646     raeburn  11427:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  11428:     return;
                   11429: }
                   11430: 
                   11431: sub restore_course_settings {
1.499     albertel 11432:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 11433: }
                   11434: 
                   11435: sub restore_settings {
                   11436:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  11437:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 11438:         next if (exists($env{'form.'.$setting}));
1.496     albertel 11439:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  11440:             '.'.$setting;
1.258     albertel 11441:         if (exists($env{$envname})) {
1.153     matthew  11442:             if ($type eq 'scalar') {
1.258     albertel 11443:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  11444:             } elsif ($type eq 'array') {
1.258     albertel 11445:                 $env{'form.'.$setting} = [ 
1.153     matthew  11446:                                            map { 
1.369     www      11447:                                                &unescape($_); 
1.258     albertel 11448:                                            } split(',',$env{$envname})
1.153     matthew  11449:                                            ];
                   11450:             }
                   11451:         }
                   11452:     }
1.127     matthew  11453: }
                   11454: 
1.618     raeburn  11455: #######################################################
                   11456: #######################################################
                   11457: 
                   11458: =pod
                   11459: 
                   11460: =head1 Domain E-mail Routines  
                   11461: 
                   11462: =over 4
                   11463: 
1.648     raeburn  11464: =item * &build_recipient_list()
1.618     raeburn  11465: 
1.884     raeburn  11466: Build recipient lists for five types of e-mail:
1.766     raeburn  11467: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  11468: (d) Help requests, (e) Course requests needing approval,  generated by
                   11469: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   11470: loncoursequeueadmin.pm respectively.
1.618     raeburn  11471: 
                   11472: Inputs:
1.619     raeburn  11473: defmail (scalar - email address of default recipient), 
1.618     raeburn  11474: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  11475: defdom (domain for which to retrieve configuration settings),
                   11476: origmail (scalar - email address of recipient from loncapa.conf, 
                   11477: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  11478: 
1.655     raeburn  11479: Returns: comma separated list of addresses to which to send e-mail.
                   11480: 
                   11481: =back
1.618     raeburn  11482: 
                   11483: =cut
                   11484: 
                   11485: ############################################################
                   11486: ############################################################
                   11487: sub build_recipient_list {
1.619     raeburn  11488:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  11489:     my @recipients;
                   11490:     my $otheremails;
                   11491:     my %domconfig =
                   11492:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   11493:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  11494:         if (exists($domconfig{'contacts'}{$mailing})) {
                   11495:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   11496:                 my @contacts = ('adminemail','supportemail');
                   11497:                 foreach my $item (@contacts) {
                   11498:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   11499:                         my $addr = $domconfig{'contacts'}{$item}; 
                   11500:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   11501:                             push(@recipients,$addr);
                   11502:                         }
1.619     raeburn  11503:                     }
1.766     raeburn  11504:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  11505:                 }
                   11506:             }
1.766     raeburn  11507:         } elsif ($origmail ne '') {
                   11508:             push(@recipients,$origmail);
1.618     raeburn  11509:         }
1.619     raeburn  11510:     } elsif ($origmail ne '') {
                   11511:         push(@recipients,$origmail);
1.618     raeburn  11512:     }
1.688     raeburn  11513:     if (defined($defmail)) {
                   11514:         if ($defmail ne '') {
                   11515:             push(@recipients,$defmail);
                   11516:         }
1.618     raeburn  11517:     }
                   11518:     if ($otheremails) {
1.619     raeburn  11519:         my @others;
                   11520:         if ($otheremails =~ /,/) {
                   11521:             @others = split(/,/,$otheremails);
1.618     raeburn  11522:         } else {
1.619     raeburn  11523:             push(@others,$otheremails);
                   11524:         }
                   11525:         foreach my $addr (@others) {
                   11526:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   11527:                 push(@recipients,$addr);
                   11528:             }
1.618     raeburn  11529:         }
                   11530:     }
1.619     raeburn  11531:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  11532:     return $recipientlist;
                   11533: }
                   11534: 
1.127     matthew  11535: ############################################################
                   11536: ############################################################
1.154     albertel 11537: 
1.655     raeburn  11538: =pod
                   11539: 
                   11540: =head1 Course Catalog Routines
                   11541: 
                   11542: =over 4
                   11543: 
                   11544: =item * &gather_categories()
                   11545: 
                   11546: Converts category definitions - keys of categories hash stored in  
                   11547: coursecategories in configuration.db on the primary library server in a 
                   11548: domain - to an array.  Also generates javascript and idx hash used to 
                   11549: generate Domain Coordinator interface for editing Course Categories.
                   11550: 
                   11551: Inputs:
1.663     raeburn  11552: 
1.655     raeburn  11553: categories (reference to hash of category definitions).
1.663     raeburn  11554: 
1.655     raeburn  11555: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   11556:       categories and subcategories).
1.663     raeburn  11557: 
1.655     raeburn  11558: idx (reference to hash of counters used in Domain Coordinator interface for 
                   11559:       editing Course Categories).
1.663     raeburn  11560: 
1.655     raeburn  11561: jsarray (reference to array of categories used to create Javascript arrays for
                   11562:          Domain Coordinator interface for editing Course Categories).
                   11563: 
                   11564: Returns: nothing
                   11565: 
                   11566: Side effects: populates cats, idx and jsarray. 
                   11567: 
                   11568: =cut
                   11569: 
                   11570: sub gather_categories {
                   11571:     my ($categories,$cats,$idx,$jsarray) = @_;
                   11572:     my %counters;
                   11573:     my $num = 0;
                   11574:     foreach my $item (keys(%{$categories})) {
                   11575:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   11576:         if ($container eq '' && $depth == 0) {
                   11577:             $cats->[$depth][$categories->{$item}] = $cat;
                   11578:         } else {
                   11579:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   11580:         }
                   11581:         my ($escitem,$tail) = split(/:/,$item,2);
                   11582:         if ($counters{$tail} eq '') {
                   11583:             $counters{$tail} = $num;
                   11584:             $num ++;
                   11585:         }
                   11586:         if (ref($idx) eq 'HASH') {
                   11587:             $idx->{$item} = $counters{$tail};
                   11588:         }
                   11589:         if (ref($jsarray) eq 'ARRAY') {
                   11590:             push(@{$jsarray->[$counters{$tail}]},$item);
                   11591:         }
                   11592:     }
                   11593:     return;
                   11594: }
                   11595: 
                   11596: =pod
                   11597: 
                   11598: =item * &extract_categories()
                   11599: 
                   11600: Used to generate breadcrumb trails for course categories.
                   11601: 
                   11602: Inputs:
1.663     raeburn  11603: 
1.655     raeburn  11604: categories (reference to hash of category definitions).
1.663     raeburn  11605: 
1.655     raeburn  11606: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   11607:       categories and subcategories).
1.663     raeburn  11608: 
1.655     raeburn  11609: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  11610: 
1.655     raeburn  11611: allitems (reference to hash - key is category key 
                   11612:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  11613: 
1.655     raeburn  11614: idx (reference to hash of counters used in Domain Coordinator interface for
                   11615:       editing Course Categories).
1.663     raeburn  11616: 
1.655     raeburn  11617: jsarray (reference to array of categories used to create Javascript arrays for
                   11618:          Domain Coordinator interface for editing Course Categories).
                   11619: 
1.665     raeburn  11620: subcats (reference to hash of arrays containing all subcategories within each 
                   11621:          category, -recursive)
                   11622: 
1.655     raeburn  11623: Returns: nothing
                   11624: 
                   11625: Side effects: populates trails and allitems hash references.
                   11626: 
                   11627: =cut
                   11628: 
                   11629: sub extract_categories {
1.665     raeburn  11630:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  11631:     if (ref($categories) eq 'HASH') {
                   11632:         &gather_categories($categories,$cats,$idx,$jsarray);
                   11633:         if (ref($cats->[0]) eq 'ARRAY') {
                   11634:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   11635:                 my $name = $cats->[0][$i];
                   11636:                 my $item = &escape($name).'::0';
                   11637:                 my $trailstr;
                   11638:                 if ($name eq 'instcode') {
                   11639:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  11640:                 } elsif ($name eq 'communities') {
                   11641:                     $trailstr = &mt('Communities');
1.655     raeburn  11642:                 } else {
                   11643:                     $trailstr = $name;
                   11644:                 }
                   11645:                 if ($allitems->{$item} eq '') {
                   11646:                     push(@{$trails},$trailstr);
                   11647:                     $allitems->{$item} = scalar(@{$trails})-1;
                   11648:                 }
                   11649:                 my @parents = ($name);
                   11650:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   11651:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   11652:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  11653:                         if (ref($subcats) eq 'HASH') {
                   11654:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   11655:                         }
                   11656:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   11657:                     }
                   11658:                 } else {
                   11659:                     if (ref($subcats) eq 'HASH') {
                   11660:                         $subcats->{$item} = [];
1.655     raeburn  11661:                     }
                   11662:                 }
                   11663:             }
                   11664:         }
                   11665:     }
                   11666:     return;
                   11667: }
                   11668: 
                   11669: =pod
                   11670: 
                   11671: =item *&recurse_categories()
                   11672: 
                   11673: Recursively used to generate breadcrumb trails for course categories.
                   11674: 
                   11675: Inputs:
1.663     raeburn  11676: 
1.655     raeburn  11677: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   11678:       categories and subcategories).
1.663     raeburn  11679: 
1.655     raeburn  11680: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  11681: 
                   11682: category (current course category, for which breadcrumb trail is being generated).
                   11683: 
                   11684: trails (reference to array of breadcrumb trails for each category).
                   11685: 
1.655     raeburn  11686: allitems (reference to hash - key is category key
                   11687:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  11688: 
1.655     raeburn  11689: parents (array containing containers directories for current category, 
                   11690:          back to top level). 
                   11691: 
                   11692: Returns: nothing
                   11693: 
                   11694: Side effects: populates trails and allitems hash references
                   11695: 
                   11696: =cut
                   11697: 
                   11698: sub recurse_categories {
1.665     raeburn  11699:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  11700:     my $shallower = $depth - 1;
                   11701:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   11702:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   11703:             my $name = $cats->[$depth]{$category}[$k];
                   11704:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   11705:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   11706:             if ($allitems->{$item} eq '') {
                   11707:                 push(@{$trails},$trailstr);
                   11708:                 $allitems->{$item} = scalar(@{$trails})-1;
                   11709:             }
                   11710:             my $deeper = $depth+1;
                   11711:             push(@{$parents},$category);
1.665     raeburn  11712:             if (ref($subcats) eq 'HASH') {
                   11713:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   11714:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   11715:                     my $higher;
                   11716:                     if ($j > 0) {
                   11717:                         $higher = &escape($parents->[$j]).':'.
                   11718:                                   &escape($parents->[$j-1]).':'.$j;
                   11719:                     } else {
                   11720:                         $higher = &escape($parents->[$j]).'::'.$j;
                   11721:                     }
                   11722:                     push(@{$subcats->{$higher}},$subcat);
                   11723:                 }
                   11724:             }
                   11725:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   11726:                                 $subcats);
1.655     raeburn  11727:             pop(@{$parents});
                   11728:         }
                   11729:     } else {
                   11730:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   11731:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   11732:         if ($allitems->{$item} eq '') {
                   11733:             push(@{$trails},$trailstr);
                   11734:             $allitems->{$item} = scalar(@{$trails})-1;
                   11735:         }
                   11736:     }
                   11737:     return;
                   11738: }
                   11739: 
1.663     raeburn  11740: =pod
                   11741: 
                   11742: =item *&assign_categories_table()
                   11743: 
                   11744: Create a datatable for display of hierarchical categories in a domain,
                   11745: with checkboxes to allow a course to be categorized. 
                   11746: 
                   11747: Inputs:
                   11748: 
                   11749: cathash - reference to hash of categories defined for the domain (from
                   11750:           configuration.db)
                   11751: 
                   11752: currcat - scalar with an & separated list of categories assigned to a course. 
                   11753: 
1.919     raeburn  11754: type    - scalar contains course type (Course or Community).
                   11755: 
1.663     raeburn  11756: Returns: $output (markup to be displayed) 
                   11757: 
                   11758: =cut
                   11759: 
                   11760: sub assign_categories_table {
1.919     raeburn  11761:     my ($cathash,$currcat,$type) = @_;
1.663     raeburn  11762:     my $output;
                   11763:     if (ref($cathash) eq 'HASH') {
                   11764:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   11765:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   11766:         $maxdepth = scalar(@cats);
                   11767:         if (@cats > 0) {
                   11768:             my $itemcount = 0;
                   11769:             if (ref($cats[0]) eq 'ARRAY') {
                   11770:                 my @currcategories;
                   11771:                 if ($currcat ne '') {
                   11772:                     @currcategories = split('&',$currcat);
                   11773:                 }
1.919     raeburn  11774:                 my $table;
1.663     raeburn  11775:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   11776:                     my $parent = $cats[0][$i];
1.919     raeburn  11777:                     next if ($parent eq 'instcode');
                   11778:                     if ($type eq 'Community') {
                   11779:                         next unless ($parent eq 'communities');
                   11780:                     } else {
                   11781:                         next if ($parent eq 'communities');
                   11782:                     }
1.663     raeburn  11783:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   11784:                     my $item = &escape($parent).'::0';
                   11785:                     my $checked = '';
                   11786:                     if (@currcategories > 0) {
                   11787:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   11788:                             $checked = ' checked="checked"';
1.663     raeburn  11789:                         }
                   11790:                     }
1.919     raeburn  11791:                     my $parent_title = $parent;
                   11792:                     if ($parent eq 'communities') {
                   11793:                         $parent_title = &mt('Communities');
                   11794:                     }
                   11795:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   11796:                               '<input type="checkbox" name="usecategory" value="'.
                   11797:                               $item.'"'.$checked.' />'.$parent_title.'</span>'.
                   11798:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  11799:                     my $depth = 1;
                   11800:                     push(@path,$parent);
1.919     raeburn  11801:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663     raeburn  11802:                     pop(@path);
1.919     raeburn  11803:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  11804:                     $itemcount ++;
                   11805:                 }
1.919     raeburn  11806:                 if ($itemcount) {
                   11807:                     $output = &Apache::loncommon::start_data_table().
                   11808:                               $table.
                   11809:                               &Apache::loncommon::end_data_table();
                   11810:                 }
1.663     raeburn  11811:             }
                   11812:         }
                   11813:     }
                   11814:     return $output;
                   11815: }
                   11816: 
                   11817: =pod
                   11818: 
                   11819: =item *&assign_category_rows()
                   11820: 
                   11821: Create a datatable row for display of nested categories in a domain,
                   11822: with checkboxes to allow a course to be categorized,called recursively.
                   11823: 
                   11824: Inputs:
                   11825: 
                   11826: itemcount - track row number for alternating colors
                   11827: 
                   11828: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   11829:       categories and subcategories.
                   11830: 
                   11831: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   11832: 
                   11833: parent - parent of current category item
                   11834: 
                   11835: path - Array containing all categories back up through the hierarchy from the
                   11836:        current category to the top level.
                   11837: 
                   11838: currcategories - reference to array of current categories assigned to the course
                   11839: 
                   11840: Returns: $output (markup to be displayed).
                   11841: 
                   11842: =cut
                   11843: 
                   11844: sub assign_category_rows {
                   11845:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   11846:     my ($text,$name,$item,$chgstr);
                   11847:     if (ref($cats) eq 'ARRAY') {
                   11848:         my $maxdepth = scalar(@{$cats});
                   11849:         if (ref($cats->[$depth]) eq 'HASH') {
                   11850:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   11851:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   11852:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   11853:                 $text .= '<td><table class="LC_datatable">';
                   11854:                 for (my $j=0; $j<$numchildren; $j++) {
                   11855:                     $name = $cats->[$depth]{$parent}[$j];
                   11856:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   11857:                     my $deeper = $depth+1;
                   11858:                     my $checked = '';
                   11859:                     if (ref($currcategories) eq 'ARRAY') {
                   11860:                         if (@{$currcategories} > 0) {
                   11861:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   11862:                                 $checked = ' checked="checked"';
1.663     raeburn  11863:                             }
                   11864:                         }
                   11865:                     }
1.664     raeburn  11866:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   11867:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  11868:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   11869:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   11870:                              '</td><td>';
1.663     raeburn  11871:                     if (ref($path) eq 'ARRAY') {
                   11872:                         push(@{$path},$name);
                   11873:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   11874:                         pop(@{$path});
                   11875:                     }
                   11876:                     $text .= '</td></tr>';
                   11877:                 }
                   11878:                 $text .= '</table></td>';
                   11879:             }
                   11880:         }
                   11881:     }
                   11882:     return $text;
                   11883: }
                   11884: 
1.655     raeburn  11885: ############################################################
                   11886: ############################################################
                   11887: 
                   11888: 
1.443     albertel 11889: sub commit_customrole {
1.664     raeburn  11890:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  11891:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 11892:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   11893:                          ($end?', ending '.localtime($end):'').': <b>'.
                   11894:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  11895:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 11896:                  '</b><br />';
                   11897:     return $output;
                   11898: }
                   11899: 
                   11900: sub commit_standardrole {
1.541     raeburn  11901:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   11902:     my ($output,$logmsg,$linefeed);
                   11903:     if ($context eq 'auto') {
                   11904:         $linefeed = "\n";
                   11905:     } else {
                   11906:         $linefeed = "<br />\n";
                   11907:     }  
1.443     albertel 11908:     if ($three eq 'st') {
1.541     raeburn  11909:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   11910:                                          $one,$two,$sec,$context);
                   11911:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  11912:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   11913:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 11914:         } else {
1.541     raeburn  11915:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 11916:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  11917:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   11918:             if ($context eq 'auto') {
                   11919:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   11920:             } else {
                   11921:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   11922:                &mt('Add to classlist').': <b>ok</b>';
                   11923:             }
                   11924:             $output .= $linefeed;
1.443     albertel 11925:         }
                   11926:     } else {
                   11927:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   11928:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  11929:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  11930:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  11931:         if ($context eq 'auto') {
                   11932:             $output .= $result.$linefeed;
                   11933:         } else {
                   11934:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   11935:         }
1.443     albertel 11936:     }
                   11937:     return $output;
                   11938: }
                   11939: 
                   11940: sub commit_studentrole {
1.541     raeburn  11941:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  11942:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  11943:     if ($context eq 'auto') {
                   11944:         $linefeed = "\n";
                   11945:     } else {
                   11946:         $linefeed = '<br />'."\n";
                   11947:     }
1.443     albertel 11948:     if (defined($one) && defined($two)) {
                   11949:         my $cid=$one.'_'.$two;
                   11950:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   11951:         my $secchange = 0;
                   11952:         my $expire_role_result;
                   11953:         my $modify_section_result;
1.628     raeburn  11954:         if ($oldsec ne '-1') { 
                   11955:             if ($oldsec ne $sec) {
1.443     albertel 11956:                 $secchange = 1;
1.628     raeburn  11957:                 my $now = time;
1.443     albertel 11958:                 my $uurl='/'.$cid;
                   11959:                 $uurl=~s/\_/\//g;
                   11960:                 if ($oldsec) {
                   11961:                     $uurl.='/'.$oldsec;
                   11962:                 }
1.626     raeburn  11963:                 $oldsecurl = $uurl;
1.628     raeburn  11964:                 $expire_role_result = 
1.652     raeburn  11965:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  11966:                 if ($env{'request.course.sec'} ne '') { 
                   11967:                     if ($expire_role_result eq 'refused') {
                   11968:                         my @roles = ('st');
                   11969:                         my @statuses = ('previous');
                   11970:                         my @roledoms = ($one);
                   11971:                         my $withsec = 1;
                   11972:                         my %roleshash = 
                   11973:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   11974:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   11975:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   11976:                             my ($oldstart,$oldend) = 
                   11977:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   11978:                             if ($oldend > 0 && $oldend <= $now) {
                   11979:                                 $expire_role_result = 'ok';
                   11980:                             }
                   11981:                         }
                   11982:                     }
                   11983:                 }
1.443     albertel 11984:                 $result = $expire_role_result;
                   11985:             }
                   11986:         }
                   11987:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  11988:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 11989:             if ($modify_section_result =~ /^ok/) {
                   11990:                 if ($secchange == 1) {
1.628     raeburn  11991:                     if ($sec eq '') {
                   11992:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   11993:                     } else {
                   11994:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   11995:                     }
1.443     albertel 11996:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  11997:                     if ($sec eq '') {
                   11998:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   11999:                     } else {
                   12000:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   12001:                     }
1.443     albertel 12002:                 } else {
1.628     raeburn  12003:                     if ($sec eq '') {
                   12004:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   12005:                     } else {
                   12006:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   12007:                     }
1.443     albertel 12008:                 }
                   12009:             } else {
1.628     raeburn  12010:                 if ($secchange) {       
                   12011:                     $$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;
                   12012:                 } else {
                   12013:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   12014:                 }
1.443     albertel 12015:             }
                   12016:             $result = $modify_section_result;
                   12017:         } elsif ($secchange == 1) {
1.628     raeburn  12018:             if ($oldsec eq '') {
                   12019:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   12020:             } else {
                   12021:                 $$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;
                   12022:             }
1.626     raeburn  12023:             if ($expire_role_result eq 'refused') {
                   12024:                 my $newsecurl = '/'.$cid;
                   12025:                 $newsecurl =~ s/\_/\//g;
                   12026:                 if ($sec ne '') {
                   12027:                     $newsecurl.='/'.$sec;
                   12028:                 }
                   12029:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   12030:                     if ($sec eq '') {
                   12031:                         $$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;
                   12032:                     } else {
                   12033:                         $$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;
                   12034:                     }
                   12035:                 }
                   12036:             }
1.443     albertel 12037:         }
                   12038:     } else {
1.626     raeburn  12039:         $$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 12040:         $result = "error: incomplete course id\n";
                   12041:     }
                   12042:     return $result;
                   12043: }
                   12044: 
                   12045: ############################################################
                   12046: ############################################################
                   12047: 
1.566     albertel 12048: sub check_clone {
1.578     raeburn  12049:     my ($args,$linefeed) = @_;
1.566     albertel 12050:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   12051:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   12052:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   12053:     my $clonemsg;
                   12054:     my $can_clone = 0;
1.944     raeburn  12055:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  12056:     if ($lctype ne 'community') {
                   12057:         $lctype = 'course';
                   12058:     }
1.566     albertel 12059:     if ($clonehome eq 'no_host') {
1.944     raeburn  12060:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  12061:             $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'});
                   12062:         } else {
                   12063:             $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'});
                   12064:         }     
1.566     albertel 12065:     } else {
                   12066: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  12067:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  12068:             if ($clonedesc{'type'} ne 'Community') {
                   12069:                  $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'});
                   12070:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   12071:             }
                   12072:         }
1.882     raeburn  12073: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   12074:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 12075: 	    $can_clone = 1;
                   12076: 	} else {
                   12077: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   12078: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   12079: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  12080:             if (grep(/^\*$/,@cloners)) {
                   12081:                 $can_clone = 1;
                   12082:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   12083:                 $can_clone = 1;
                   12084:             } else {
1.908     raeburn  12085:                 my $ccrole = 'cc';
1.944     raeburn  12086:                 if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  12087:                     $ccrole = 'co';
                   12088:                 }
1.578     raeburn  12089: 	        my %roleshash =
                   12090: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   12091: 					 $args->{'ccdomain'},
1.908     raeburn  12092:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  12093: 					 [$args->{'clonedomain'}]);
1.908     raeburn  12094: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942     raeburn  12095:                     $can_clone = 1;
                   12096:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
                   12097:                     $can_clone = 1;
                   12098:                 } else {
1.944     raeburn  12099:                     if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  12100:                         $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'});
                   12101:                     } else {
                   12102:                         $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'});
                   12103:                     }
1.578     raeburn  12104: 	        }
1.566     albertel 12105: 	    }
1.578     raeburn  12106:         }
1.566     albertel 12107:     }
                   12108:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   12109: }
                   12110: 
1.444     albertel 12111: sub construct_course {
1.885     raeburn  12112:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 12113:     my $outcome;
1.541     raeburn  12114:     my $linefeed =  '<br />'."\n";
                   12115:     if ($context eq 'auto') {
                   12116:         $linefeed = "\n";
                   12117:     }
1.566     albertel 12118: 
                   12119: #
                   12120: # Are we cloning?
                   12121: #
                   12122:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   12123:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  12124: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 12125: 	if ($context ne 'auto') {
1.578     raeburn  12126:             if ($clonemsg ne '') {
                   12127: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   12128:             }
1.566     albertel 12129: 	}
                   12130: 	$outcome .= $clonemsg.$linefeed;
                   12131: 
                   12132:         if (!$can_clone) {
                   12133: 	    return (0,$outcome);
                   12134: 	}
                   12135:     }
                   12136: 
1.444     albertel 12137: #
                   12138: # Open course
                   12139: #
                   12140:     my $crstype = lc($args->{'crstype'});
                   12141:     my %cenv=();
                   12142:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   12143:                                              $args->{'cdescr'},
                   12144:                                              $args->{'curl'},
                   12145:                                              $args->{'course_home'},
                   12146:                                              $args->{'nonstandard'},
                   12147:                                              $args->{'crscode'},
                   12148:                                              $args->{'ccuname'}.':'.
                   12149:                                              $args->{'ccdomain'},
1.882     raeburn  12150:                                              $args->{'crstype'},
1.885     raeburn  12151:                                              $cnum,$context,$category);
1.444     albertel 12152: 
                   12153:     # Note: The testing routines depend on this being output; see 
                   12154:     # Utils::Course. This needs to at least be output as a comment
                   12155:     # if anyone ever decides to not show this, and Utils::Course::new
                   12156:     # will need to be suitably modified.
1.541     raeburn  12157:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  12158:     if ($$courseid =~ /^error:/) {
                   12159:         return (0,$outcome);
                   12160:     }
                   12161: 
1.444     albertel 12162: #
                   12163: # Check if created correctly
                   12164: #
1.479     albertel 12165:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 12166:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  12167:     if ($crsuhome eq 'no_host') {
                   12168:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   12169:         return (0,$outcome);
                   12170:     }
1.541     raeburn  12171:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 12172: 
1.444     albertel 12173: #
1.566     albertel 12174: # Do the cloning
                   12175: #   
                   12176:     if ($can_clone && $cloneid) {
                   12177: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   12178: 	if ($context ne 'auto') {
                   12179: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   12180: 	}
                   12181: 	$outcome .= $clonemsg.$linefeed;
                   12182: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 12183: # Copy all files
1.637     www      12184: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 12185: # Restore URL
1.566     albertel 12186: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 12187: # Restore title
1.566     albertel 12188: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  12189: # Restore creation date, creator and creation context.
                   12190:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   12191:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   12192:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 12193: # Mark as cloned
1.566     albertel 12194: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      12195: # Need to clone grading mode
                   12196:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   12197:         $cenv{'grading'}=$newenv{'grading'};
                   12198: # Do not clone these environment entries
                   12199:         &Apache::lonnet::del('environment',
                   12200:                   ['default_enrollment_start_date',
                   12201:                    'default_enrollment_end_date',
                   12202:                    'question.email',
                   12203:                    'policy.email',
                   12204:                    'comment.email',
                   12205:                    'pch.users.denied',
1.725     raeburn  12206:                    'plc.users.denied',
                   12207:                    'hidefromcat',
                   12208:                    'categories'],
1.638     www      12209:                    $$crsudom,$$crsunum);
1.444     albertel 12210:     }
1.566     albertel 12211: 
1.444     albertel 12212: #
                   12213: # Set environment (will override cloned, if existing)
                   12214: #
                   12215:     my @sections = ();
                   12216:     my @xlists = ();
                   12217:     if ($args->{'crstype'}) {
                   12218:         $cenv{'type'}=$args->{'crstype'};
                   12219:     }
                   12220:     if ($args->{'crsid'}) {
                   12221:         $cenv{'courseid'}=$args->{'crsid'};
                   12222:     }
                   12223:     if ($args->{'crscode'}) {
                   12224:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   12225:     }
                   12226:     if ($args->{'crsquota'} ne '') {
                   12227:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   12228:     } else {
                   12229:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   12230:     }
                   12231:     if ($args->{'ccuname'}) {
                   12232:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   12233:                                         ':'.$args->{'ccdomain'};
                   12234:     } else {
                   12235:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   12236:     }
                   12237:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   12238:     if ($args->{'crssections'}) {
                   12239:         $cenv{'internal.sectionnums'} = '';
                   12240:         if ($args->{'crssections'} =~ m/,/) {
                   12241:             @sections = split/,/,$args->{'crssections'};
                   12242:         } else {
                   12243:             $sections[0] = $args->{'crssections'};
                   12244:         }
                   12245:         if (@sections > 0) {
                   12246:             foreach my $item (@sections) {
                   12247:                 my ($sec,$gp) = split/:/,$item;
                   12248:                 my $class = $args->{'crscode'}.$sec;
                   12249:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   12250:                 $cenv{'internal.sectionnums'} .= $item.',';
                   12251:                 unless ($addcheck eq 'ok') {
                   12252:                     push @badclasses, $class;
                   12253:                 }
                   12254:             }
                   12255:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   12256:         }
                   12257:     }
                   12258: # do not hide course coordinator from staff listing, 
                   12259: # even if privileged
                   12260:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   12261: # add crosslistings
                   12262:     if ($args->{'crsxlist'}) {
                   12263:         $cenv{'internal.crosslistings'}='';
                   12264:         if ($args->{'crsxlist'} =~ m/,/) {
                   12265:             @xlists = split/,/,$args->{'crsxlist'};
                   12266:         } else {
                   12267:             $xlists[0] = $args->{'crsxlist'};
                   12268:         }
                   12269:         if (@xlists > 0) {
                   12270:             foreach my $item (@xlists) {
                   12271:                 my ($xl,$gp) = split/:/,$item;
                   12272:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   12273:                 $cenv{'internal.crosslistings'} .= $item.',';
                   12274:                 unless ($addcheck eq 'ok') {
                   12275:                     push @badclasses, $xl;
                   12276:                 }
                   12277:             }
                   12278:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   12279:         }
                   12280:     }
                   12281:     if ($args->{'autoadds'}) {
                   12282:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   12283:     }
                   12284:     if ($args->{'autodrops'}) {
                   12285:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   12286:     }
                   12287: # check for notification of enrollment changes
                   12288:     my @notified = ();
                   12289:     if ($args->{'notify_owner'}) {
                   12290:         if ($args->{'ccuname'} ne '') {
                   12291:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   12292:         }
                   12293:     }
                   12294:     if ($args->{'notify_dc'}) {
                   12295:         if ($uname ne '') { 
1.630     raeburn  12296:             push(@notified,$uname.':'.$udom);
1.444     albertel 12297:         }
                   12298:     }
                   12299:     if (@notified > 0) {
                   12300:         my $notifylist;
                   12301:         if (@notified > 1) {
                   12302:             $notifylist = join(',',@notified);
                   12303:         } else {
                   12304:             $notifylist = $notified[0];
                   12305:         }
                   12306:         $cenv{'internal.notifylist'} = $notifylist;
                   12307:     }
                   12308:     if (@badclasses > 0) {
                   12309:         my %lt=&Apache::lonlocal::texthash(
                   12310:                 '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',
                   12311:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   12312:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   12313:         );
1.541     raeburn  12314:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   12315:                            ' ('.$lt{'adby'}.')';
                   12316:         if ($context eq 'auto') {
                   12317:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 12318:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  12319:             foreach my $item (@badclasses) {
                   12320:                 if ($context eq 'auto') {
                   12321:                     $outcome .= " - $item\n";
                   12322:                 } else {
                   12323:                     $outcome .= "<li>$item</li>\n";
                   12324:                 }
                   12325:             }
                   12326:             if ($context eq 'auto') {
                   12327:                 $outcome .= $linefeed;
                   12328:             } else {
1.566     albertel 12329:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  12330:             }
                   12331:         } 
1.444     albertel 12332:     }
                   12333:     if ($args->{'no_end_date'}) {
                   12334:         $args->{'endaccess'} = 0;
                   12335:     }
                   12336:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   12337:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   12338:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   12339:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   12340:     if ($args->{'showphotos'}) {
                   12341:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   12342:     }
                   12343:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   12344:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   12345:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   12346:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  12347:             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'); 
                   12348:             if ($context eq 'auto') {
                   12349:                 $outcome .= $krb_msg;
                   12350:             } else {
1.566     albertel 12351:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  12352:             }
                   12353:             $outcome .= $linefeed;
1.444     albertel 12354:         }
                   12355:     }
                   12356:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   12357:        if ($args->{'setpolicy'}) {
                   12358:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   12359:        }
                   12360:        if ($args->{'setcontent'}) {
                   12361:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   12362:        }
                   12363:     }
                   12364:     if ($args->{'reshome'}) {
                   12365: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   12366: 	$cenv{'reshome'}=~s/\/+$/\//;
                   12367:     }
                   12368: #
                   12369: # course has keyed access
                   12370: #
                   12371:     if ($args->{'setkeys'}) {
                   12372:        $cenv{'keyaccess'}='yes';
                   12373:     }
                   12374: # if specified, key authority is not course, but user
                   12375: # only active if keyaccess is yes
                   12376:     if ($args->{'keyauth'}) {
1.487     albertel 12377: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   12378: 	$user = &LONCAPA::clean_username($user);
                   12379: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     12380: 	if ($user ne '' && $domain ne '') {
1.487     albertel 12381: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 12382: 	}
                   12383:     }
                   12384: 
                   12385:     if ($args->{'disresdis'}) {
                   12386:         $cenv{'pch.roles.denied'}='st';
                   12387:     }
                   12388:     if ($args->{'disablechat'}) {
                   12389:         $cenv{'plc.roles.denied'}='st';
                   12390:     }
                   12391: 
                   12392:     # Record we've not yet viewed the Course Initialization Helper for this 
                   12393:     # course
                   12394:     $cenv{'course.helper.not.run'} = 1;
                   12395:     #
                   12396:     # Use new Randomseed
                   12397:     #
                   12398:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   12399:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   12400:     #
                   12401:     # The encryption code and receipt prefix for this course
                   12402:     #
                   12403:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   12404:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   12405:     #
                   12406:     # By default, use standard grading
                   12407:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   12408: 
1.541     raeburn  12409:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   12410:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 12411: #
                   12412: # Open all assignments
                   12413: #
                   12414:     if ($args->{'openall'}) {
                   12415:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   12416:        my %storecontent = ($storeunder         => time,
                   12417:                            $storeunder.'.type' => 'date_start');
                   12418:        
                   12419:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  12420:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 12421:    }
                   12422: #
                   12423: # Set first page
                   12424: #
                   12425:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   12426: 	    || ($cloneid)) {
1.445     albertel 12427: 	use LONCAPA::map;
1.444     albertel 12428: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 12429: 
                   12430: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   12431:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   12432: 
1.444     albertel 12433:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   12434:         my $title; my $url;
                   12435:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   12436: 	    $title=&mt('Syllabus');
1.444     albertel 12437:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   12438:         } else {
1.963     raeburn  12439:             $title=&mt('Table of Contents');
1.444     albertel 12440:             $url='/adm/navmaps';
                   12441:         }
1.445     albertel 12442: 
                   12443:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   12444: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   12445: 
                   12446: 	if ($errtext) { $fatal=2; }
1.541     raeburn  12447:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 12448:     }
1.566     albertel 12449: 
                   12450:     return (1,$outcome);
1.444     albertel 12451: }
                   12452: 
                   12453: ############################################################
                   12454: ############################################################
                   12455: 
1.953     droeschl 12456: #SD
                   12457: # only Community and Course, or anything else?
1.378     raeburn  12458: sub course_type {
                   12459:     my ($cid) = @_;
                   12460:     if (!defined($cid)) {
                   12461:         $cid = $env{'request.course.id'};
                   12462:     }
1.404     albertel 12463:     if (defined($env{'course.'.$cid.'.type'})) {
                   12464:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  12465:     } else {
                   12466:         return 'Course';
1.377     raeburn  12467:     }
                   12468: }
1.156     albertel 12469: 
1.406     raeburn  12470: sub group_term {
                   12471:     my $crstype = &course_type();
                   12472:     my %names = (
                   12473:                   'Course' => 'group',
1.865     raeburn  12474:                   'Community' => 'group',
1.406     raeburn  12475:                 );
                   12476:     return $names{$crstype};
                   12477: }
                   12478: 
1.902     raeburn  12479: sub course_types {
                   12480:     my @types = ('official','unofficial','community');
                   12481:     my %typename = (
                   12482:                          official   => 'Official course',
                   12483:                          unofficial => 'Unofficial course',
                   12484:                          community  => 'Community',
                   12485:                    );
                   12486:     return (\@types,\%typename);
                   12487: }
                   12488: 
1.156     albertel 12489: sub icon {
                   12490:     my ($file)=@_;
1.505     albertel 12491:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 12492:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 12493:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 12494:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   12495: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   12496: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   12497: 	            $curfext.".gif") {
                   12498: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   12499: 		$curfext.".gif";
                   12500: 	}
                   12501:     }
1.249     albertel 12502:     return &lonhttpdurl($iconname);
1.154     albertel 12503: } 
1.84      albertel 12504: 
1.575     albertel 12505: sub lonhttpdurl {
1.692     www      12506: #
                   12507: # Had been used for "small fry" static images on separate port 8080.
                   12508: # Modify here if lightweight http functionality desired again.
                   12509: # Currently eliminated due to increasing firewall issues.
                   12510: #
1.575     albertel 12511:     my ($url)=@_;
1.692     www      12512:     return $url;
1.215     albertel 12513: }
                   12514: 
1.213     albertel 12515: sub connection_aborted {
                   12516:     my ($r)=@_;
                   12517:     $r->print(" ");$r->rflush();
                   12518:     my $c = $r->connection;
                   12519:     return $c->aborted();
                   12520: }
                   12521: 
1.221     foxr     12522: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     12523: #    strings as 'strings'.
                   12524: sub escape_single {
1.221     foxr     12525:     my ($input) = @_;
1.223     albertel 12526:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     12527:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   12528:     return $input;
                   12529: }
1.223     albertel 12530: 
1.222     foxr     12531: #  Same as escape_single, but escape's "'s  This 
                   12532: #  can be used for  "strings"
                   12533: sub escape_double {
                   12534:     my ($input) = @_;
                   12535:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   12536:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   12537:     return $input;
                   12538: }
1.223     albertel 12539:  
1.222     foxr     12540: #   Escapes the last element of a full URL.
                   12541: sub escape_url {
                   12542:     my ($url)   = @_;
1.238     raeburn  12543:     my @urlslices = split(/\//, $url,-1);
1.369     www      12544:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 12545:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     12546: }
1.462     albertel 12547: 
1.820     raeburn  12548: sub compare_arrays {
                   12549:     my ($arrayref1,$arrayref2) = @_;
                   12550:     my (@difference,%count);
                   12551:     @difference = ();
                   12552:     %count = ();
                   12553:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   12554:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   12555:         foreach my $element (keys(%count)) {
                   12556:             if ($count{$element} == 1) {
                   12557:                 push(@difference,$element);
                   12558:             }
                   12559:         }
                   12560:     }
                   12561:     return @difference;
                   12562: }
                   12563: 
1.817     bisitz   12564: # -------------------------------------------------------- Initialize user login
1.462     albertel 12565: sub init_user_environment {
1.463     albertel 12566:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 12567:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   12568: 
                   12569:     my $public=($username eq 'public' && $domain eq 'public');
                   12570: 
                   12571: # See if old ID present, if so, remove
                   12572: 
                   12573:     my ($filename,$cookie,$userroles);
                   12574:     my $now=time;
                   12575: 
                   12576:     if ($public) {
                   12577: 	my $max_public=100;
                   12578: 	my $oldest;
                   12579: 	my $oldest_time=0;
                   12580: 	for(my $next=1;$next<=$max_public;$next++) {
                   12581: 	    if (-e $lonids."/publicuser_$next.id") {
                   12582: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   12583: 		if ($mtime<$oldest_time || !$oldest_time) {
                   12584: 		    $oldest_time=$mtime;
                   12585: 		    $oldest=$next;
                   12586: 		}
                   12587: 	    } else {
                   12588: 		$cookie="publicuser_$next";
                   12589: 		last;
                   12590: 	    }
                   12591: 	}
                   12592: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   12593:     } else {
1.463     albertel 12594: 	# if this isn't a robot, kill any existing non-robot sessions
                   12595: 	if (!$args->{'robot'}) {
                   12596: 	    opendir(DIR,$lonids);
                   12597: 	    while ($filename=readdir(DIR)) {
                   12598: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   12599: 		    unlink($lonids.'/'.$filename);
                   12600: 		}
1.462     albertel 12601: 	    }
1.463     albertel 12602: 	    closedir(DIR);
1.462     albertel 12603: 	}
                   12604: # Give them a new cookie
1.463     albertel 12605: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      12606: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 12607: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 12608:     
                   12609: # Initialize roles
                   12610: 
                   12611: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   12612:     }
                   12613: # ------------------------------------ Check browser type and MathML capability
                   12614: 
                   12615:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   12616:         $clientunicode,$clientos) = &decode_user_agent($r);
                   12617: 
                   12618: # ------------------------------------------------------------- Get environment
                   12619: 
                   12620:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   12621:     my ($tmp) = keys(%userenv);
                   12622:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   12623:     } else {
                   12624: 	undef(%userenv);
                   12625:     }
                   12626:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   12627: 	$form->{'interface'}=$userenv{'interface'};
                   12628:     }
                   12629:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   12630: 
                   12631: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   12632:     foreach my $option ('interface','localpath','localres') {
                   12633:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 12634:     }
                   12635: # --------------------------------------------------------- Write first profile
                   12636: 
                   12637:     {
                   12638: 	my %initial_env = 
                   12639: 	    ("user.name"          => $username,
                   12640: 	     "user.domain"        => $domain,
                   12641: 	     "user.home"          => $authhost,
                   12642: 	     "browser.type"       => $clientbrowser,
                   12643: 	     "browser.version"    => $clientversion,
                   12644: 	     "browser.mathml"     => $clientmathml,
                   12645: 	     "browser.unicode"    => $clientunicode,
                   12646: 	     "browser.os"         => $clientos,
                   12647: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   12648: 	     "request.course.fn"  => '',
                   12649: 	     "request.course.uri" => '',
                   12650: 	     "request.course.sec" => '',
                   12651: 	     "request.role"       => 'cm',
                   12652: 	     "request.role.adv"   => $env{'user.adv'},
                   12653: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   12654: 
                   12655:         if ($form->{'localpath'}) {
                   12656: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   12657: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   12658:         }
                   12659: 	
                   12660: 	if ($form->{'interface'}) {
                   12661: 	    $form->{'interface'}=~s/\W//gs;
                   12662: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   12663: 	    $env{'browser.interface'}=$form->{'interface'};
                   12664: 	}
                   12665: 
1.981     raeburn  12666:         my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016    raeburn  12667:         my %domdef;
                   12668:         unless ($domain eq 'public') {
                   12669:             %domdef = &Apache::lonnet::get_domain_defaults($domain);
                   12670:         }
1.980     raeburn  12671: 
1.724     raeburn  12672:         foreach my $tool ('aboutme','blog','portfolio') {
                   12673:             $userenv{'availabletools.'.$tool} = 
1.980     raeburn  12674:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   12675:                                                   undef,\%userenv,\%domdef,\%is_adv);
1.724     raeburn  12676:         }
                   12677: 
1.864     raeburn  12678:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  12679:             $userenv{'canrequest.'.$crstype} =
                   12680:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980     raeburn  12681:                                                   'reload','requestcourses',
                   12682:                                                   \%userenv,\%domdef,\%is_adv);
1.765     raeburn  12683:         }
                   12684: 
1.462     albertel 12685: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   12686: 	
                   12687: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   12688: 		 &GDBM_WRCREAT(),0640)) {
                   12689: 	    &_add_to_env(\%disk_env,\%initial_env);
                   12690: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   12691: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 12692: 	    if (ref($args->{'extra_env'})) {
                   12693: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   12694: 	    }
1.462     albertel 12695: 	    untie(%disk_env);
                   12696: 	} else {
1.705     tempelho 12697: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   12698: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 12699: 	    return 'error: '.$!;
                   12700: 	}
                   12701:     }
                   12702:     $env{'request.role'}='cm';
                   12703:     $env{'request.role.adv'}=$env{'user.adv'};
                   12704:     $env{'browser.type'}=$clientbrowser;
                   12705: 
                   12706:     return $cookie;
                   12707: 
                   12708: }
                   12709: 
                   12710: sub _add_to_env {
                   12711:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  12712:     if (ref($env_data) eq 'HASH') {
                   12713:         while (my ($key,$value) = each(%$env_data)) {
                   12714: 	    $idf->{$prefix.$key} = $value;
                   12715: 	    $env{$prefix.$key}   = $value;
                   12716:         }
1.462     albertel 12717:     }
                   12718: }
                   12719: 
1.685     tempelho 12720: # --- Get the symbolic name of a problem and the url
                   12721: sub get_symb {
                   12722:     my ($request,$silent) = @_;
1.726     raeburn  12723:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 12724:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   12725:     if ($symb eq '') {
                   12726:         if (!$silent) {
                   12727:             $request->print("Unable to handle ambiguous references:$url:.");
                   12728:             return ();
                   12729:         }
                   12730:     }
                   12731:     &Apache::lonenc::check_decrypt(\$symb);
                   12732:     return ($symb);
                   12733: }
                   12734: 
                   12735: # --------------------------------------------------------------Get annotation
                   12736: 
                   12737: sub get_annotation {
                   12738:     my ($symb,$enc) = @_;
                   12739: 
                   12740:     my $key = $symb;
                   12741:     if (!$enc) {
                   12742:         $key =
                   12743:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   12744:     }
                   12745:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   12746:     return $annotation{$key};
                   12747: }
                   12748: 
                   12749: sub clean_symb {
1.731     raeburn  12750:     my ($symb,$delete_enc) = @_;
1.685     tempelho 12751: 
                   12752:     &Apache::lonenc::check_decrypt(\$symb);
                   12753:     my $enc = $env{'request.enc'};
1.731     raeburn  12754:     if ($delete_enc) {
1.730     raeburn  12755:         delete($env{'request.enc'});
                   12756:     }
1.685     tempelho 12757: 
                   12758:     return ($symb,$enc);
                   12759: }
1.462     albertel 12760: 
1.990     raeburn  12761: sub build_release_hashes {
                   12762:     my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
                   12763:     return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
                   12764:                   (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
                   12765:                   (ref($randomizetry) eq 'HASH'));
                   12766:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   12767:         my ($item,$name,$value) = split(/:/,$key);
                   12768:         if ($item eq 'parameter') {
                   12769:             if (ref($checkparms->{$name}) eq 'ARRAY') {
                   12770:                 unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
                   12771:                     push(@{$checkparms->{$name}},$value);
                   12772:                 }
                   12773:             } else {
                   12774:                 push(@{$checkparms->{$name}},$value);
                   12775:             }
                   12776:         } elsif ($item eq 'resourcetag') {
                   12777:             if ($name eq 'responsetype') {
                   12778:                 $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
                   12779:             }
                   12780:         } elsif ($item eq 'course') {
                   12781:             if ($name eq 'crstype') {
                   12782:                 $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
                   12783:             }
                   12784:         }
                   12785:     }
                   12786:     ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
                   12787:     ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
                   12788:     return;
                   12789: }
                   12790: 
1.41      ng       12791: =pod
                   12792: 
                   12793: =back
                   12794: 
1.112     bowersj2 12795: =cut
1.41      ng       12796: 
1.112     bowersj2 12797: 1;
                   12798: __END__;
1.41      ng       12799: 

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