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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.1048  ! foxr        4: # $Id: loncommon.pm,v 1.1047 2011/12/25 20:41:53 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: 
                   1751: =cut
                   1752: 
                   1753: ###############################################################
                   1754: ###############################################################
                   1755: sub define_excel_formats {
                   1756:     my ($workbook) = @_;
                   1757:     my $format;
                   1758:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1759:                                                 bottom    => 1,
                   1760:                                                 align     => 'center');
                   1761:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1762:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1763:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1764:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1765:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1766:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1767:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1768:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1769:     return $format;
                   1770: }
                   1771: 
                   1772: ###############################################################
                   1773: ###############################################################
1.113     bowersj2 1774: 
                   1775: =pod
                   1776: 
1.648     raeburn  1777: =item * &create_workbook()
1.255     matthew  1778: 
                   1779: Create an Excel worksheet.  If it fails, output message on the
                   1780: request object and return undefs.
                   1781: 
                   1782: Inputs: Apache request object
                   1783: 
                   1784: Returns (undef) on failure, 
                   1785:     Excel worksheet object, scalar with filename, and formats 
                   1786:     from &Apache::loncommon::define_excel_formats on success
                   1787: 
                   1788: =cut
                   1789: 
                   1790: ###############################################################
                   1791: ###############################################################
                   1792: sub create_workbook {
                   1793:     my ($r) = @_;
                   1794:         #
                   1795:     # Create the excel spreadsheet
                   1796:     my $filename = '/prtspool/'.
1.258     albertel 1797:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1798:         time.'_'.rand(1000000000).'.xls';
                   1799:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1800:     if (! defined($workbook)) {
                   1801:         $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928     bisitz   1802:         $r->print(
                   1803:             '<p class="LC_error">'
                   1804:            .&mt('Problems occurred in creating the new Excel file.')
                   1805:            .' '.&mt('This error has been logged.')
                   1806:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   1807:            .'</p>'
                   1808:         );
1.255     matthew  1809:         return (undef);
                   1810:     }
                   1811:     #
1.1014    foxr     1812:     $workbook->set_tempdir(LONCAPA::tempdir());
1.255     matthew  1813:     #
                   1814:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1815:     return ($workbook,$filename,$format);
                   1816: }
                   1817: 
                   1818: ###############################################################
                   1819: ###############################################################
                   1820: 
                   1821: =pod
                   1822: 
1.648     raeburn  1823: =item * &create_text_file()
1.113     bowersj2 1824: 
1.542     raeburn  1825: Create a file to write to and eventually make available to the user.
1.256     matthew  1826: If file creation fails, outputs an error message on the request object and 
                   1827: return undefs.
1.113     bowersj2 1828: 
1.256     matthew  1829: Inputs: Apache request object, and file suffix
1.113     bowersj2 1830: 
1.256     matthew  1831: Returns (undef) on failure, 
                   1832:     Filehandle and filename on success.
1.113     bowersj2 1833: 
                   1834: =cut
                   1835: 
1.256     matthew  1836: ###############################################################
                   1837: ###############################################################
                   1838: sub create_text_file {
                   1839:     my ($r,$suffix) = @_;
                   1840:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1841:     my $fh;
                   1842:     my $filename = '/prtspool/'.
1.258     albertel 1843:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1844:         time.'_'.rand(1000000000).'.'.$suffix;
                   1845:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1846:     if (! defined($fh)) {
                   1847:         $r->log_error("Couldn't open $filename for output $!");
1.928     bisitz   1848:         $r->print(
                   1849:             '<p class="LC_error">'
                   1850:            .&mt('Problems occurred in creating the output file.')
                   1851:            .' '.&mt('This error has been logged.')
                   1852:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   1853:            .'</p>'
                   1854:         );
1.113     bowersj2 1855:     }
1.256     matthew  1856:     return ($fh,$filename)
1.113     bowersj2 1857: }
                   1858: 
                   1859: 
1.256     matthew  1860: =pod 
1.113     bowersj2 1861: 
                   1862: =back
                   1863: 
                   1864: =cut
1.37      matthew  1865: 
                   1866: ###############################################################
1.33      matthew  1867: ##        Home server <option> list generating code          ##
                   1868: ###############################################################
1.35      matthew  1869: 
1.169     www      1870: # ------------------------------------------
                   1871: 
                   1872: sub domain_select {
                   1873:     my ($name,$value,$multiple)=@_;
                   1874:     my %domains=map { 
1.514     albertel 1875: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1876:     } &Apache::lonnet::all_domains();
1.169     www      1877:     if ($multiple) {
                   1878: 	$domains{''}=&mt('Any domain');
1.550     albertel 1879: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1880: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1881:     } else {
1.550     albertel 1882: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970     raeburn  1883: 	return &select_form($name,$value,\%domains);
1.169     www      1884:     }
                   1885: }
                   1886: 
1.282     albertel 1887: #-------------------------------------------
                   1888: 
                   1889: =pod
                   1890: 
1.519     raeburn  1891: =head1 Routines for form select boxes
                   1892: 
                   1893: =over 4
                   1894: 
1.648     raeburn  1895: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1896: 
                   1897: Returns a string containing a <select> element int multiple mode
                   1898: 
                   1899: 
                   1900: Args:
                   1901:   $name - name of the <select> element
1.506     raeburn  1902:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1903:   $size - number of rows long the select element is
1.283     albertel 1904:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1905:           (shown text should already have been &mt())
1.506     raeburn  1906:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1907: 
1.282     albertel 1908: =cut
                   1909: 
                   1910: #-------------------------------------------
1.169     www      1911: sub multiple_select_form {
1.284     albertel 1912:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1913:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1914:     my $output='';
1.191     matthew  1915:     if (! defined($size)) {
                   1916:         $size = 4;
1.283     albertel 1917:         if (scalar(keys(%$hash))<4) {
                   1918:             $size = scalar(keys(%$hash));
1.191     matthew  1919:         }
                   1920:     }
1.734     bisitz   1921:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1922:     my @order;
1.506     raeburn  1923:     if (ref($order) eq 'ARRAY')  {
                   1924:         @order = @{$order};
                   1925:     } else {
                   1926:         @order = sort(keys(%$hash));
1.501     banghart 1927:     }
                   1928:     if (exists($$hash{'select_form_order'})) {
                   1929:         @order = @{$$hash{'select_form_order'}};
                   1930:     }
                   1931:         
1.284     albertel 1932:     foreach my $key (@order) {
1.356     albertel 1933:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1934:         $output.='selected="selected" ' if ($selected{$key});
                   1935:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1936:     }
                   1937:     $output.="</select>\n";
                   1938:     return $output;
                   1939: }
                   1940: 
1.88      www      1941: #-------------------------------------------
                   1942: 
                   1943: =pod
                   1944: 
1.970     raeburn  1945: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88      www      1946: 
                   1947: Returns a string containing a <select name='$name' size='1'> form to 
1.970     raeburn  1948: allow a user to select options from a ref to a hash containing:
                   1949: option_name => displayed text. An optional $onchange can include
                   1950: a javascript onchange item, e.g., onchange="this.form.submit();"  
                   1951: 
1.88      www      1952: See lonrights.pm for an example invocation and use.
                   1953: 
                   1954: =cut
                   1955: 
                   1956: #-------------------------------------------
                   1957: sub select_form {
1.970     raeburn  1958:     my ($def,$name,$hashref,$onchange) = @_;
                   1959:     return unless (ref($hashref) eq 'HASH');
                   1960:     if ($onchange) {
                   1961:         $onchange = ' onchange="'.$onchange.'"';
                   1962:     }
                   1963:     my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128     albertel 1964:     my @keys;
1.970     raeburn  1965:     if (exists($hashref->{'select_form_order'})) {
                   1966: 	@keys=@{$hashref->{'select_form_order'}};
1.128     albertel 1967:     } else {
1.970     raeburn  1968: 	@keys=sort(keys(%{$hashref}));
1.128     albertel 1969:     }
1.356     albertel 1970:     foreach my $key (@keys) {
                   1971:         $selectform.=
                   1972: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1973:             ($key eq $def ? 'selected="selected" ' : '').
1.970     raeburn  1974:                 ">".$hashref->{$key}."</option>\n";
1.88      www      1975:     }
                   1976:     $selectform.="</select>";
                   1977:     return $selectform;
                   1978: }
                   1979: 
1.475     www      1980: # For display filters
                   1981: 
                   1982: sub display_filter {
                   1983:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1984:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1985:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1986: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1987: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1988: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1989:            &mt('Filter [_1]',
1.477     www      1990: 	   &select_form($env{'form.displayfilter'},
                   1991: 			'displayfilter',
1.970     raeburn  1992: 			{'currentfolder' => 'Current folder/page',
1.477     www      1993: 			 'containing' => 'Containing phrase',
1.970     raeburn  1994: 			 'none' => 'None'})).
1.714     bisitz   1995: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1996: }
                   1997: 
1.167     www      1998: sub gradeleveldescription {
                   1999:     my $gradelevel=shift;
                   2000:     my %gradelevels=(0 => 'Not specified',
                   2001: 		     1 => 'Grade 1',
                   2002: 		     2 => 'Grade 2',
                   2003: 		     3 => 'Grade 3',
                   2004: 		     4 => 'Grade 4',
                   2005: 		     5 => 'Grade 5',
                   2006: 		     6 => 'Grade 6',
                   2007: 		     7 => 'Grade 7',
                   2008: 		     8 => 'Grade 8',
                   2009: 		     9 => 'Grade 9',
                   2010: 		     10 => 'Grade 10',
                   2011: 		     11 => 'Grade 11',
                   2012: 		     12 => 'Grade 12',
                   2013: 		     13 => 'Grade 13',
                   2014: 		     14 => '100 Level',
                   2015: 		     15 => '200 Level',
                   2016: 		     16 => '300 Level',
                   2017: 		     17 => '400 Level',
                   2018: 		     18 => 'Graduate Level');
                   2019:     return &mt($gradelevels{$gradelevel});
                   2020: }
                   2021: 
1.163     www      2022: sub select_level_form {
                   2023:     my ($deflevel,$name)=@_;
                   2024:     unless ($deflevel) { $deflevel=0; }
1.167     www      2025:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   2026:     for (my $i=0; $i<=18; $i++) {
                   2027:         $selectform.="<option value=\"$i\" ".
1.253     albertel 2028:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      2029:                 ">".&gradeleveldescription($i)."</option>\n";
                   2030:     }
                   2031:     $selectform.="</select>";
                   2032:     return $selectform;
1.163     www      2033: }
1.167     www      2034: 
1.35      matthew  2035: #-------------------------------------------
                   2036: 
1.45      matthew  2037: =pod
                   2038: 
1.910     raeburn  2039: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35      matthew  2040: 
                   2041: Returns a string containing a <select name='$name' size='1'> form to 
                   2042: allow a user to select the domain to preform an operation in.  
                   2043: See loncreateuser.pm for an example invocation and use.
                   2044: 
1.90      www      2045: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   2046: selected");
                   2047: 
1.743     raeburn  2048: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   2049: 
1.910     raeburn  2050: 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.
                   2051: 
                   2052: The optional $incdoms is a reference to an array of domains which will be the only available options. 
1.563     raeburn  2053: 
1.35      matthew  2054: =cut
                   2055: 
                   2056: #-------------------------------------------
1.34      matthew  2057: sub select_dom_form {
1.910     raeburn  2058:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872     raeburn  2059:     if ($onchange) {
1.874     raeburn  2060:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  2061:     }
1.910     raeburn  2062:     my @domains;
                   2063:     if (ref($incdoms) eq 'ARRAY') {
                   2064:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   2065:     } else {
                   2066:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   2067:     }
1.90      www      2068:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  2069:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 2070:     foreach my $dom (@domains) {
                   2071:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  2072:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   2073:         if ($showdomdesc) {
                   2074:             if ($dom ne '') {
                   2075:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   2076:                 if ($domdesc ne '') {
                   2077:                     $selectdomain .= ' ('.$domdesc.')';
                   2078:                 }
                   2079:             } 
                   2080:         }
                   2081:         $selectdomain .= "</option>\n";
1.34      matthew  2082:     }
                   2083:     $selectdomain.="</select>";
                   2084:     return $selectdomain;
                   2085: }
                   2086: 
1.35      matthew  2087: #-------------------------------------------
                   2088: 
1.45      matthew  2089: =pod
                   2090: 
1.648     raeburn  2091: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2092: 
1.586     raeburn  2093: input: 4 arguments (two required, two optional) - 
                   2094:     $domain - domain of new user
                   2095:     $name - name of form element
                   2096:     $default - Value of 'default' causes a default item to be first 
                   2097:                             option, and selected by default. 
                   2098:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2099:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2100: output: returns 2 items: 
1.586     raeburn  2101: (a) form element which contains either:
                   2102:    (i) <select name="$name">
                   2103:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2104:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2105:        </select>
                   2106:        form item if there are multiple library servers in $domain, or
                   2107:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2108:        if there is only one library server in $domain.
                   2109: 
                   2110: (b) number of library servers found.
                   2111: 
                   2112: See loncreateuser.pm for example of use.
1.35      matthew  2113: 
                   2114: =cut
                   2115: 
                   2116: #-------------------------------------------
1.586     raeburn  2117: sub home_server_form_item {
                   2118:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2119:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2120:     my $result;
                   2121:     my $numlib = keys(%servers);
                   2122:     if ($numlib > 1) {
                   2123:         $result .= '<select name="'.$name.'" />'."\n";
                   2124:         if ($default) {
1.804     bisitz   2125:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2126:                        '</option>'."\n";
                   2127:         }
                   2128:         foreach my $hostid (sort(keys(%servers))) {
                   2129:             $result.= '<option value="'.$hostid.'">'.
                   2130: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2131:         }
                   2132:         $result .= '</select>'."\n";
                   2133:     } elsif ($numlib == 1) {
                   2134:         my $hostid;
                   2135:         foreach my $item (keys(%servers)) {
                   2136:             $hostid = $item;
                   2137:         }
                   2138:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2139:                    $hostid.'" />';
                   2140:                    if (!$hide) {
                   2141:                        $result .= $hostid.' '.$servers{$hostid};
                   2142:                    }
                   2143:                    $result .= "\n";
                   2144:     } elsif ($default) {
                   2145:         $result .= '<input type="hidden" name="'.$name.
                   2146:                    '" value="default" />';
                   2147:                    if (!$hide) {
                   2148:                        $result .= &mt('default');
                   2149:                    }
                   2150:                    $result .= "\n";
1.33      matthew  2151:     }
1.586     raeburn  2152:     return ($result,$numlib);
1.33      matthew  2153: }
1.112     bowersj2 2154: 
                   2155: =pod
                   2156: 
1.534     albertel 2157: =back 
                   2158: 
1.112     bowersj2 2159: =cut
1.87      matthew  2160: 
                   2161: ###############################################################
1.112     bowersj2 2162: ##                  Decoding User Agent                      ##
1.87      matthew  2163: ###############################################################
                   2164: 
                   2165: =pod
                   2166: 
1.112     bowersj2 2167: =head1 Decoding the User Agent
                   2168: 
                   2169: =over 4
                   2170: 
                   2171: =item * &decode_user_agent()
1.87      matthew  2172: 
                   2173: Inputs: $r
                   2174: 
                   2175: Outputs:
                   2176: 
                   2177: =over 4
                   2178: 
1.112     bowersj2 2179: =item * $httpbrowser
1.87      matthew  2180: 
1.112     bowersj2 2181: =item * $clientbrowser
1.87      matthew  2182: 
1.112     bowersj2 2183: =item * $clientversion
1.87      matthew  2184: 
1.112     bowersj2 2185: =item * $clientmathml
1.87      matthew  2186: 
1.112     bowersj2 2187: =item * $clientunicode
1.87      matthew  2188: 
1.112     bowersj2 2189: =item * $clientos
1.87      matthew  2190: 
                   2191: =back
                   2192: 
1.157     matthew  2193: =back 
                   2194: 
1.87      matthew  2195: =cut
                   2196: 
                   2197: ###############################################################
                   2198: ###############################################################
                   2199: sub decode_user_agent {
1.247     albertel 2200:     my ($r)=@_;
1.87      matthew  2201:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2202:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2203:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2204:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2205:     my $clientbrowser='unknown';
                   2206:     my $clientversion='0';
                   2207:     my $clientmathml='';
                   2208:     my $clientunicode='0';
                   2209:     for (my $i=0;$i<=$#browsertype;$i++) {
                   2210:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   2211: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2212: 	    $clientbrowser=$bname;
                   2213:             $httpbrowser=~/$vreg/i;
                   2214: 	    $clientversion=$1;
                   2215:             $clientmathml=($clientversion>=$minv);
                   2216:             $clientunicode=($clientversion>=$univ);
                   2217: 	}
                   2218:     }
                   2219:     my $clientos='unknown';
                   2220:     if (($httpbrowser=~/linux/i) ||
                   2221:         ($httpbrowser=~/unix/i) ||
                   2222:         ($httpbrowser=~/ux/i) ||
                   2223:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2224:     if (($httpbrowser=~/vax/i) ||
                   2225:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2226:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2227:     if (($httpbrowser=~/mac/i) ||
                   2228:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   2229:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   2230:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   2231:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   2232:             $clientunicode,$clientos,);
                   2233: }
                   2234: 
1.32      matthew  2235: ###############################################################
                   2236: ##    Authentication changing form generation subroutines    ##
                   2237: ###############################################################
                   2238: ##
                   2239: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2240: ## hash, and have reasonable default values.
                   2241: ##
                   2242: ##    formname = the name given in the <form> tag.
1.35      matthew  2243: #-------------------------------------------
                   2244: 
1.45      matthew  2245: =pod
                   2246: 
1.112     bowersj2 2247: =head1 Authentication Routines
                   2248: 
                   2249: =over 4
                   2250: 
1.648     raeburn  2251: =item * &authform_xxxxxx()
1.35      matthew  2252: 
                   2253: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2254: handle some of the conveniences required for authentication forms.  
                   2255: This is not an optimal method, but it works.  
                   2256: 
                   2257: =over 4
                   2258: 
1.112     bowersj2 2259: =item * authform_header
1.35      matthew  2260: 
1.112     bowersj2 2261: =item * authform_authorwarning
1.35      matthew  2262: 
1.112     bowersj2 2263: =item * authform_nochange
1.35      matthew  2264: 
1.112     bowersj2 2265: =item * authform_kerberos
1.35      matthew  2266: 
1.112     bowersj2 2267: =item * authform_internal
1.35      matthew  2268: 
1.112     bowersj2 2269: =item * authform_filesystem
1.35      matthew  2270: 
                   2271: =back
                   2272: 
1.648     raeburn  2273: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2274: 
1.35      matthew  2275: =cut
                   2276: 
                   2277: #-------------------------------------------
1.32      matthew  2278: sub authform_header{  
                   2279:     my %in = (
                   2280:         formname => 'cu',
1.80      albertel 2281:         kerb_def_dom => '',
1.32      matthew  2282:         @_,
                   2283:     );
                   2284:     $in{'formname'} = 'document.' . $in{'formname'};
                   2285:     my $result='';
1.80      albertel 2286: 
                   2287: #---------------------------------------------- Code for upper case translation
                   2288:     my $Javascript_toUpperCase;
                   2289:     unless ($in{kerb_def_dom}) {
                   2290:         $Javascript_toUpperCase =<<"END";
                   2291:         switch (choice) {
                   2292:            case 'krb': currentform.elements[choicearg].value =
                   2293:                currentform.elements[choicearg].value.toUpperCase();
                   2294:                break;
                   2295:            default:
                   2296:         }
                   2297: END
                   2298:     } else {
                   2299:         $Javascript_toUpperCase = "";
                   2300:     }
                   2301: 
1.165     raeburn  2302:     my $radioval = "'nochange'";
1.591     raeburn  2303:     if (defined($in{'curr_authtype'})) {
                   2304:         if ($in{'curr_authtype'} ne '') {
                   2305:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2306:         }
1.174     matthew  2307:     }
1.165     raeburn  2308:     my $argfield = 'null';
1.591     raeburn  2309:     if (defined($in{'mode'})) {
1.165     raeburn  2310:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2311:             if (defined($in{'curr_autharg'})) {
                   2312:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2313:                     $argfield = "'$in{'curr_autharg'}'";
                   2314:                 }
                   2315:             }
                   2316:         }
                   2317:     }
                   2318: 
1.32      matthew  2319:     $result.=<<"END";
                   2320: var current = new Object();
1.165     raeburn  2321: current.radiovalue = $radioval;
                   2322: current.argfield = $argfield;
1.32      matthew  2323: 
                   2324: function changed_radio(choice,currentform) {
                   2325:     var choicearg = choice + 'arg';
                   2326:     // If a radio button in changed, we need to change the argfield
                   2327:     if (current.radiovalue != choice) {
                   2328:         current.radiovalue = choice;
                   2329:         if (current.argfield != null) {
                   2330:             currentform.elements[current.argfield].value = '';
                   2331:         }
                   2332:         if (choice == 'nochange') {
                   2333:             current.argfield = null;
                   2334:         } else {
                   2335:             current.argfield = choicearg;
                   2336:             switch(choice) {
                   2337:                 case 'krb': 
                   2338:                     currentform.elements[current.argfield].value = 
                   2339:                         "$in{'kerb_def_dom'}";
                   2340:                 break;
                   2341:               default:
                   2342:                 break;
                   2343:             }
                   2344:         }
                   2345:     }
                   2346:     return;
                   2347: }
1.22      www      2348: 
1.32      matthew  2349: function changed_text(choice,currentform) {
                   2350:     var choicearg = choice + 'arg';
                   2351:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2352:         $Javascript_toUpperCase
1.32      matthew  2353:         // clear old field
                   2354:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2355:             currentform.elements[current.argfield].value = '';
                   2356:         }
                   2357:         current.argfield = choicearg;
                   2358:     }
                   2359:     set_auth_radio_buttons(choice,currentform);
                   2360:     return;
1.20      www      2361: }
1.32      matthew  2362: 
                   2363: function set_auth_radio_buttons(newvalue,currentform) {
1.986     raeburn  2364:     var numauthchoices = currentform.login.length;
                   2365:     if (typeof numauthchoices  == "undefined") {
                   2366:         return;
                   2367:     } 
1.32      matthew  2368:     var i=0;
1.986     raeburn  2369:     while (i < numauthchoices) {
1.32      matthew  2370:         if (currentform.login[i].value == newvalue) { break; }
                   2371:         i++;
                   2372:     }
1.986     raeburn  2373:     if (i == numauthchoices) {
1.32      matthew  2374:         return;
                   2375:     }
                   2376:     current.radiovalue = newvalue;
                   2377:     currentform.login[i].checked = true;
                   2378:     return;
                   2379: }
                   2380: END
                   2381:     return $result;
                   2382: }
                   2383: 
                   2384: sub authform_authorwarning{
                   2385:     my $result='';
1.144     matthew  2386:     $result='<i>'.
                   2387:         &mt('As a general rule, only authors or co-authors should be '.
                   2388:             'filesystem authenticated '.
                   2389:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2390:     return $result;
                   2391: }
                   2392: 
                   2393: sub authform_nochange{  
                   2394:     my %in = (
                   2395:               formname => 'document.cu',
                   2396:               kerb_def_dom => 'MSU.EDU',
                   2397:               @_,
                   2398:           );
1.586     raeburn  2399:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2400:     my $result;
                   2401:     if (keys(%can_assign) == 0) {
                   2402:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2403:     } else {
                   2404:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2405:                   '<input type="radio" name="login" value="nochange" '.
                   2406:                   'checked="checked" onclick="'.
1.281     albertel 2407:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2408: 	    '</label>';
1.586     raeburn  2409:     }
1.32      matthew  2410:     return $result;
                   2411: }
                   2412: 
1.591     raeburn  2413: sub authform_kerberos {
1.32      matthew  2414:     my %in = (
                   2415:               formname => 'document.cu',
                   2416:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2417:               kerb_def_auth => 'krb4',
1.32      matthew  2418:               @_,
                   2419:               );
1.586     raeburn  2420:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2421:         $autharg,$jscall);
                   2422:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2423:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2424:        $check5 = ' checked="checked"';
1.80      albertel 2425:     } else {
1.772     bisitz   2426:        $check4 = ' checked="checked"';
1.80      albertel 2427:     }
1.165     raeburn  2428:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2429:     if (defined($in{'curr_authtype'})) {
                   2430:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2431:             $krbcheck = ' checked="checked"';
1.623     raeburn  2432:             if (defined($in{'mode'})) {
                   2433:                 if ($in{'mode'} eq 'modifyuser') {
                   2434:                     $krbcheck = '';
                   2435:                 }
                   2436:             }
1.591     raeburn  2437:             if (defined($in{'curr_kerb_ver'})) {
                   2438:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2439:                     $check5 = ' checked="checked"';
1.591     raeburn  2440:                     $check4 = '';
                   2441:                 } else {
1.772     bisitz   2442:                     $check4 = ' checked="checked"';
1.591     raeburn  2443:                     $check5 = '';
                   2444:                 }
1.586     raeburn  2445:             }
1.591     raeburn  2446:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2447:                 $krbarg = $in{'curr_autharg'};
                   2448:             }
1.586     raeburn  2449:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2450:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2451:                     $result = 
                   2452:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2453:         $in{'curr_autharg'},$krbver);
                   2454:                 } else {
                   2455:                     $result =
                   2456:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2457:                 }
                   2458:                 return $result; 
                   2459:             }
                   2460:         }
                   2461:     } else {
                   2462:         if ($authnum == 1) {
1.784     bisitz   2463:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2464:         }
                   2465:     }
1.586     raeburn  2466:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2467:         return;
1.587     raeburn  2468:     } elsif ($authtype eq '') {
1.591     raeburn  2469:         if (defined($in{'mode'})) {
1.587     raeburn  2470:             if ($in{'mode'} eq 'modifycourse') {
                   2471:                 if ($authnum == 1) {
1.784     bisitz   2472:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2473:                 }
                   2474:             }
                   2475:         }
1.586     raeburn  2476:     }
                   2477:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2478:     if ($authtype eq '') {
                   2479:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2480:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2481:                     $krbcheck.' />';
                   2482:     }
                   2483:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2484:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2485:          $in{'curr_authtype'} eq 'krb5') ||
                   2486:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2487:          $in{'curr_authtype'} eq 'krb4')) {
                   2488:         $result .= &mt
1.144     matthew  2489:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2490:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2491:          '<label>'.$authtype,
1.281     albertel 2492:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2493:              'value="'.$krbarg.'" '.
1.144     matthew  2494:              'onchange="'.$jscall.'" />',
1.281     albertel 2495:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2496:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2497: 	 '</label>');
1.586     raeburn  2498:     } elsif ($can_assign{'krb4'}) {
                   2499:         $result .= &mt
                   2500:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2501:          '[_3] Version 4 [_4]',
                   2502:          '<label>'.$authtype,
                   2503:          '</label><input type="text" size="10" name="krbarg" '.
                   2504:              'value="'.$krbarg.'" '.
                   2505:              'onchange="'.$jscall.'" />',
                   2506:          '<label><input type="hidden" name="krbver" value="4" />',
                   2507:          '</label>');
                   2508:     } elsif ($can_assign{'krb5'}) {
                   2509:         $result .= &mt
                   2510:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2511:          '[_3] Version 5 [_4]',
                   2512:          '<label>'.$authtype,
                   2513:          '</label><input type="text" size="10" name="krbarg" '.
                   2514:              'value="'.$krbarg.'" '.
                   2515:              'onchange="'.$jscall.'" />',
                   2516:          '<label><input type="hidden" name="krbver" value="5" />',
                   2517:          '</label>');
                   2518:     }
1.32      matthew  2519:     return $result;
                   2520: }
                   2521: 
                   2522: sub authform_internal{  
1.586     raeburn  2523:     my %in = (
1.32      matthew  2524:                 formname => 'document.cu',
                   2525:                 kerb_def_dom => 'MSU.EDU',
                   2526:                 @_,
                   2527:                 );
1.586     raeburn  2528:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2529:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2530:     if (defined($in{'curr_authtype'})) {
                   2531:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2532:             if ($can_assign{'int'}) {
1.772     bisitz   2533:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2534:                 if (defined($in{'mode'})) {
                   2535:                     if ($in{'mode'} eq 'modifyuser') {
                   2536:                         $intcheck = '';
                   2537:                     }
                   2538:                 }
1.591     raeburn  2539:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2540:                     $intarg = $in{'curr_autharg'};
                   2541:                 }
                   2542:             } else {
                   2543:                 $result = &mt('Currently internally authenticated.');
                   2544:                 return $result;
1.165     raeburn  2545:             }
                   2546:         }
1.586     raeburn  2547:     } else {
                   2548:         if ($authnum == 1) {
1.784     bisitz   2549:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2550:         }
                   2551:     }
                   2552:     if (!$can_assign{'int'}) {
                   2553:         return;
1.587     raeburn  2554:     } elsif ($authtype eq '') {
1.591     raeburn  2555:         if (defined($in{'mode'})) {
1.587     raeburn  2556:             if ($in{'mode'} eq 'modifycourse') {
                   2557:                 if ($authnum == 1) {
1.784     bisitz   2558:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2559:                 }
                   2560:             }
                   2561:         }
1.165     raeburn  2562:     }
1.586     raeburn  2563:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2564:     if ($authtype eq '') {
                   2565:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2566:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2567:     }
1.605     bisitz   2568:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2569:                $intarg.'" onchange="'.$jscall.'" />';
                   2570:     $result = &mt
1.144     matthew  2571:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2572:          '<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2573:     $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  2574:     return $result;
                   2575: }
                   2576: 
                   2577: sub authform_local{  
                   2578:     my %in = (
                   2579:               formname => 'document.cu',
                   2580:               kerb_def_dom => 'MSU.EDU',
                   2581:               @_,
                   2582:               );
1.586     raeburn  2583:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2584:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2585:     if (defined($in{'curr_authtype'})) {
                   2586:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2587:             if ($can_assign{'loc'}) {
1.772     bisitz   2588:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2589:                 if (defined($in{'mode'})) {
                   2590:                     if ($in{'mode'} eq 'modifyuser') {
                   2591:                         $loccheck = '';
                   2592:                     }
                   2593:                 }
1.591     raeburn  2594:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2595:                     $locarg = $in{'curr_autharg'};
                   2596:                 }
                   2597:             } else {
                   2598:                 $result = &mt('Currently using local (institutional) authentication.');
                   2599:                 return $result;
1.165     raeburn  2600:             }
                   2601:         }
1.586     raeburn  2602:     } else {
                   2603:         if ($authnum == 1) {
1.784     bisitz   2604:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2605:         }
                   2606:     }
                   2607:     if (!$can_assign{'loc'}) {
                   2608:         return;
1.587     raeburn  2609:     } elsif ($authtype eq '') {
1.591     raeburn  2610:         if (defined($in{'mode'})) {
1.587     raeburn  2611:             if ($in{'mode'} eq 'modifycourse') {
                   2612:                 if ($authnum == 1) {
1.784     bisitz   2613:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2614:                 }
                   2615:             }
                   2616:         }
1.165     raeburn  2617:     }
1.586     raeburn  2618:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2619:     if ($authtype eq '') {
                   2620:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2621:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2622:                     $jscall.'" />';
                   2623:     }
                   2624:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2625:                $locarg.'" onchange="'.$jscall.'" />';
                   2626:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2627:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2628:     return $result;
                   2629: }
                   2630: 
                   2631: sub authform_filesystem{  
                   2632:     my %in = (
                   2633:               formname => 'document.cu',
                   2634:               kerb_def_dom => 'MSU.EDU',
                   2635:               @_,
                   2636:               );
1.586     raeburn  2637:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2638:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2639:     if (defined($in{'curr_authtype'})) {
                   2640:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2641:             if ($can_assign{'fsys'}) {
1.772     bisitz   2642:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2643:                 if (defined($in{'mode'})) {
                   2644:                     if ($in{'mode'} eq 'modifyuser') {
                   2645:                         $fsyscheck = '';
                   2646:                     }
                   2647:                 }
1.586     raeburn  2648:             } else {
                   2649:                 $result = &mt('Currently Filesystem Authenticated.');
                   2650:                 return $result;
                   2651:             }           
                   2652:         }
                   2653:     } else {
                   2654:         if ($authnum == 1) {
1.784     bisitz   2655:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2656:         }
                   2657:     }
                   2658:     if (!$can_assign{'fsys'}) {
                   2659:         return;
1.587     raeburn  2660:     } elsif ($authtype eq '') {
1.591     raeburn  2661:         if (defined($in{'mode'})) {
1.587     raeburn  2662:             if ($in{'mode'} eq 'modifycourse') {
                   2663:                 if ($authnum == 1) {
1.784     bisitz   2664:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2665:                 }
                   2666:             }
                   2667:         }
1.586     raeburn  2668:     }
                   2669:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2670:     if ($authtype eq '') {
                   2671:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2672:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2673:                     $jscall.'" />';
                   2674:     }
                   2675:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2676:                ' onchange="'.$jscall.'" />';
                   2677:     $result = &mt
1.144     matthew  2678:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2679:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2680:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2681:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2682:                   'onchange="'.$jscall.'" />');
1.32      matthew  2683:     return $result;
                   2684: }
                   2685: 
1.586     raeburn  2686: sub get_assignable_auth {
                   2687:     my ($dom) = @_;
                   2688:     if ($dom eq '') {
                   2689:         $dom = $env{'request.role.domain'};
                   2690:     }
                   2691:     my %can_assign = (
                   2692:                           krb4 => 1,
                   2693:                           krb5 => 1,
                   2694:                           int  => 1,
                   2695:                           loc  => 1,
                   2696:                      );
                   2697:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2698:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2699:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2700:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2701:             my $context;
                   2702:             if ($env{'request.role'} =~ /^au/) {
                   2703:                 $context = 'author';
                   2704:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2705:                 $context = 'domain';
                   2706:             } elsif ($env{'request.course.id'}) {
                   2707:                 $context = 'course';
                   2708:             }
                   2709:             if ($context) {
                   2710:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2711:                    %can_assign = %{$authhash->{$context}}; 
                   2712:                 }
                   2713:             }
                   2714:         }
                   2715:     }
                   2716:     my $authnum = 0;
                   2717:     foreach my $key (keys(%can_assign)) {
                   2718:         if ($can_assign{$key}) {
                   2719:             $authnum ++;
                   2720:         }
                   2721:     }
                   2722:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2723:         $authnum --;
                   2724:     }
                   2725:     return ($authnum,%can_assign);
                   2726: }
                   2727: 
1.80      albertel 2728: ###############################################################
                   2729: ##    Get Kerberos Defaults for Domain                 ##
                   2730: ###############################################################
                   2731: ##
                   2732: ## Returns default kerberos version and an associated argument
                   2733: ## as listed in file domain.tab. If not listed, provides
                   2734: ## appropriate default domain and kerberos version.
                   2735: ##
                   2736: #-------------------------------------------
                   2737: 
                   2738: =pod
                   2739: 
1.648     raeburn  2740: =item * &get_kerberos_defaults()
1.80      albertel 2741: 
                   2742: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2743: version and domain. If not found, it defaults to version 4 and the 
                   2744: domain of the server.
1.80      albertel 2745: 
1.648     raeburn  2746: =over 4
                   2747: 
1.80      albertel 2748: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2749: 
1.648     raeburn  2750: =back
                   2751: 
                   2752: =back
                   2753: 
1.80      albertel 2754: =cut
                   2755: 
                   2756: #-------------------------------------------
                   2757: sub get_kerberos_defaults {
                   2758:     my $domain=shift;
1.641     raeburn  2759:     my ($krbdef,$krbdefdom);
                   2760:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2761:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2762:         $krbdef = $domdefaults{'auth_def'};
                   2763:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2764:     } else {
1.80      albertel 2765:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2766:         my $krbdefdom=$1;
                   2767:         $krbdefdom=~tr/a-z/A-Z/;
                   2768:         $krbdef = "krb4";
                   2769:     }
                   2770:     return ($krbdef,$krbdefdom);
                   2771: }
1.112     bowersj2 2772: 
1.32      matthew  2773: 
1.46      matthew  2774: ###############################################################
                   2775: ##                Thesaurus Functions                        ##
                   2776: ###############################################################
1.20      www      2777: 
1.46      matthew  2778: =pod
1.20      www      2779: 
1.112     bowersj2 2780: =head1 Thesaurus Functions
                   2781: 
                   2782: =over 4
                   2783: 
1.648     raeburn  2784: =item * &initialize_keywords()
1.46      matthew  2785: 
                   2786: Initializes the package variable %Keywords if it is empty.  Uses the
                   2787: package variable $thesaurus_db_file.
                   2788: 
                   2789: =cut
                   2790: 
                   2791: ###################################################
                   2792: 
                   2793: sub initialize_keywords {
                   2794:     return 1 if (scalar keys(%Keywords));
                   2795:     # If we are here, %Keywords is empty, so fill it up
                   2796:     #   Make sure the file we need exists...
                   2797:     if (! -e $thesaurus_db_file) {
                   2798:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2799:                                  " failed because it does not exist");
                   2800:         return 0;
                   2801:     }
                   2802:     #   Set up the hash as a database
                   2803:     my %thesaurus_db;
                   2804:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2805:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2806:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2807:                                  $thesaurus_db_file);
                   2808:         return 0;
                   2809:     } 
                   2810:     #  Get the average number of appearances of a word.
                   2811:     my $avecount = $thesaurus_db{'average.count'};
                   2812:     #  Put keywords (those that appear > average) into %Keywords
                   2813:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2814:         my ($count,undef) = split /:/,$data;
                   2815:         $Keywords{$word}++ if ($count > $avecount);
                   2816:     }
                   2817:     untie %thesaurus_db;
                   2818:     # Remove special values from %Keywords.
1.356     albertel 2819:     foreach my $value ('total.count','average.count') {
                   2820:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2821:   }
1.46      matthew  2822:     return 1;
                   2823: }
                   2824: 
                   2825: ###################################################
                   2826: 
                   2827: =pod
                   2828: 
1.648     raeburn  2829: =item * &keyword($word)
1.46      matthew  2830: 
                   2831: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2832: than the average number of times in the thesaurus database.  Calls 
                   2833: &initialize_keywords
                   2834: 
                   2835: =cut
                   2836: 
                   2837: ###################################################
1.20      www      2838: 
                   2839: sub keyword {
1.46      matthew  2840:     return if (!&initialize_keywords());
                   2841:     my $word=lc(shift());
                   2842:     $word=~s/\W//g;
                   2843:     return exists($Keywords{$word});
1.20      www      2844: }
1.46      matthew  2845: 
                   2846: ###############################################################
                   2847: 
                   2848: =pod 
1.20      www      2849: 
1.648     raeburn  2850: =item * &get_related_words()
1.46      matthew  2851: 
1.160     matthew  2852: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2853: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2854: will be returned.  The order of the words returned is determined by the
                   2855: database which holds them.
                   2856: 
                   2857: Uses global $thesaurus_db_file.
                   2858: 
                   2859: =cut
                   2860: 
                   2861: ###############################################################
                   2862: sub get_related_words {
                   2863:     my $keyword = shift;
                   2864:     my %thesaurus_db;
                   2865:     if (! -e $thesaurus_db_file) {
                   2866:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2867:                                  "failed because the file does not exist");
                   2868:         return ();
                   2869:     }
                   2870:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2871:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2872:         return ();
                   2873:     } 
                   2874:     my @Words=();
1.429     www      2875:     my $count=0;
1.46      matthew  2876:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2877: 	# The first element is the number of times
                   2878: 	# the word appears.  We do not need it now.
1.429     www      2879: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2880: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2881: 	my $threshold=$mostfrequentcount/10;
                   2882:         foreach my $possibleword (@RelatedWords) {
                   2883:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2884:             if ($wordcount>$threshold) {
                   2885: 		push(@Words,$word);
                   2886:                 $count++;
                   2887:                 if ($count>10) { last; }
                   2888: 	    }
1.20      www      2889:         }
                   2890:     }
1.46      matthew  2891:     untie %thesaurus_db;
                   2892:     return @Words;
1.14      harris41 2893: }
1.46      matthew  2894: 
1.112     bowersj2 2895: =pod
                   2896: 
                   2897: =back
                   2898: 
                   2899: =cut
1.61      www      2900: 
                   2901: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2902: =pod
                   2903: 
1.112     bowersj2 2904: =head1 User Name Functions
                   2905: 
                   2906: =over 4
                   2907: 
1.648     raeburn  2908: =item * &plainname($uname,$udom,$first)
1.81      albertel 2909: 
1.112     bowersj2 2910: Takes a users logon name and returns it as a string in
1.226     albertel 2911: "first middle last generation" form 
                   2912: if $first is set to 'lastname' then it returns it as
                   2913: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2914: 
                   2915: =cut
1.61      www      2916: 
1.295     www      2917: 
1.81      albertel 2918: ###############################################################
1.61      www      2919: sub plainname {
1.226     albertel 2920:     my ($uname,$udom,$first)=@_;
1.537     albertel 2921:     return if (!defined($uname) || !defined($udom));
1.295     www      2922:     my %names=&getnames($uname,$udom);
1.226     albertel 2923:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2924: 					  $names{'middlename'},
                   2925: 					  $names{'lastname'},
                   2926: 					  $names{'generation'},$first);
                   2927:     $name=~s/^\s+//;
1.62      www      2928:     $name=~s/\s+$//;
                   2929:     $name=~s/\s+/ /g;
1.353     albertel 2930:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2931:     return $name;
1.61      www      2932: }
1.66      www      2933: 
                   2934: # -------------------------------------------------------------------- Nickname
1.81      albertel 2935: =pod
                   2936: 
1.648     raeburn  2937: =item * &nickname($uname,$udom)
1.81      albertel 2938: 
                   2939: Gets a users name and returns it as a string as
                   2940: 
                   2941: "&quot;nickname&quot;"
1.66      www      2942: 
1.81      albertel 2943: if the user has a nickname or
                   2944: 
                   2945: "first middle last generation"
                   2946: 
                   2947: if the user does not
                   2948: 
                   2949: =cut
1.66      www      2950: 
                   2951: sub nickname {
                   2952:     my ($uname,$udom)=@_;
1.537     albertel 2953:     return if (!defined($uname) || !defined($udom));
1.295     www      2954:     my %names=&getnames($uname,$udom);
1.68      albertel 2955:     my $name=$names{'nickname'};
1.66      www      2956:     if ($name) {
                   2957:        $name='&quot;'.$name.'&quot;'; 
                   2958:     } else {
                   2959:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2960: 	     $names{'lastname'}.' '.$names{'generation'};
                   2961:        $name=~s/\s+$//;
                   2962:        $name=~s/\s+/ /g;
                   2963:     }
                   2964:     return $name;
                   2965: }
                   2966: 
1.295     www      2967: sub getnames {
                   2968:     my ($uname,$udom)=@_;
1.537     albertel 2969:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2970:     if ($udom eq 'public' && $uname eq 'public') {
                   2971: 	return ('lastname' => &mt('Public'));
                   2972:     }
1.295     www      2973:     my $id=$uname.':'.$udom;
                   2974:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2975:     if ($cached) {
                   2976: 	return %{$names};
                   2977:     } else {
                   2978: 	my %loadnames=&Apache::lonnet::get('environment',
                   2979:                     ['firstname','middlename','lastname','generation','nickname'],
                   2980: 					 $udom,$uname);
                   2981: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2982: 	return %loadnames;
                   2983:     }
                   2984: }
1.61      www      2985: 
1.542     raeburn  2986: # -------------------------------------------------------------------- getemails
1.648     raeburn  2987: 
1.542     raeburn  2988: =pod
                   2989: 
1.648     raeburn  2990: =item * &getemails($uname,$udom)
1.542     raeburn  2991: 
                   2992: Gets a user's email information and returns it as a hash with keys:
                   2993: notification, critnotification, permanentemail
                   2994: 
                   2995: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2996: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2997:  
1.648     raeburn  2998: 
1.542     raeburn  2999: =cut
                   3000: 
1.648     raeburn  3001: 
1.466     albertel 3002: sub getemails {
                   3003:     my ($uname,$udom)=@_;
                   3004:     if ($udom eq 'public' && $uname eq 'public') {
                   3005: 	return;
                   3006:     }
1.467     www      3007:     if (!$udom) { $udom=$env{'user.domain'}; }
                   3008:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 3009:     my $id=$uname.':'.$udom;
                   3010:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   3011:     if ($cached) {
                   3012: 	return %{$names};
                   3013:     } else {
                   3014: 	my %loadnames=&Apache::lonnet::get('environment',
                   3015:                     			   ['notification','critnotification',
                   3016: 					    'permanentemail'],
                   3017: 					   $udom,$uname);
                   3018: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   3019: 	return %loadnames;
                   3020:     }
                   3021: }
                   3022: 
1.551     albertel 3023: sub flush_email_cache {
                   3024:     my ($uname,$udom)=@_;
                   3025:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3026:     if (!$uname) { $uname=$env{'user.name'};   }
                   3027:     return if ($udom eq 'public' && $uname eq 'public');
                   3028:     my $id=$uname.':'.$udom;
                   3029:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   3030: }
                   3031: 
1.728     raeburn  3032: # -------------------------------------------------------------------- getlangs
                   3033: 
                   3034: =pod
                   3035: 
                   3036: =item * &getlangs($uname,$udom)
                   3037: 
                   3038: Gets a user's language preference and returns it as a hash with key:
                   3039: language.
                   3040: 
                   3041: =cut
                   3042: 
                   3043: 
                   3044: sub getlangs {
                   3045:     my ($uname,$udom) = @_;
                   3046:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3047:     if (!$uname) { $uname=$env{'user.name'};   }
                   3048:     my $id=$uname.':'.$udom;
                   3049:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   3050:     if ($cached) {
                   3051:         return %{$langs};
                   3052:     } else {
                   3053:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   3054:                                            $udom,$uname);
                   3055:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   3056:         return %loadlangs;
                   3057:     }
                   3058: }
                   3059: 
                   3060: sub flush_langs_cache {
                   3061:     my ($uname,$udom)=@_;
                   3062:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3063:     if (!$uname) { $uname=$env{'user.name'};   }
                   3064:     return if ($udom eq 'public' && $uname eq 'public');
                   3065:     my $id=$uname.':'.$udom;
                   3066:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   3067: }
                   3068: 
1.61      www      3069: # ------------------------------------------------------------------ Screenname
1.81      albertel 3070: 
                   3071: =pod
                   3072: 
1.648     raeburn  3073: =item * &screenname($uname,$udom)
1.81      albertel 3074: 
                   3075: Gets a users screenname and returns it as a string
                   3076: 
                   3077: =cut
1.61      www      3078: 
                   3079: sub screenname {
                   3080:     my ($uname,$udom)=@_;
1.258     albertel 3081:     if ($uname eq $env{'user.name'} &&
                   3082: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 3083:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 3084:     return $names{'screenname'};
1.62      www      3085: }
                   3086: 
1.212     albertel 3087: 
1.802     bisitz   3088: # ------------------------------------------------------------- Confirm Wrapper
                   3089: =pod
                   3090: 
                   3091: =item confirmwrapper
                   3092: 
                   3093: Wrap messages about completion of operation in box
                   3094: 
                   3095: =cut
                   3096: 
                   3097: sub confirmwrapper {
                   3098:     my ($message)=@_;
                   3099:     if ($message) {
                   3100:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3101:                .$message."\n"
                   3102:                .'</div>'."\n";
                   3103:     } else {
                   3104:         return $message;
                   3105:     }
                   3106: }
                   3107: 
1.62      www      3108: # ------------------------------------------------------------- Message Wrapper
                   3109: 
                   3110: sub messagewrapper {
1.369     www      3111:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3112:     return 
1.441     albertel 3113:         '<a href="/adm/email?compose=individual&amp;'.
                   3114:         'recname='.$username.'&amp;recdom='.$domain.
                   3115: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3116:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3117: }
1.802     bisitz   3118: 
1.74      www      3119: # --------------------------------------------------------------- Notes Wrapper
                   3120: 
                   3121: sub noteswrapper {
                   3122:     my ($link,$un,$do)=@_;
                   3123:     return 
1.896     amueller 3124: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3125: }
1.802     bisitz   3126: 
1.62      www      3127: # ------------------------------------------------------------- Aboutme Wrapper
                   3128: 
                   3129: sub aboutmewrapper {
1.166     www      3130:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  3131:     if (!defined($username)  && !defined($domain)) {
                   3132:         return;
                   3133:     }
1.892     amueller 3134:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756     weissno  3135: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3136: }
                   3137: 
                   3138: # ------------------------------------------------------------ Syllabus Wrapper
                   3139: 
                   3140: sub syllabuswrapper {
1.707     bisitz   3141:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3142:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3143: }
1.14      harris41 3144: 
1.802     bisitz   3145: # -----------------------------------------------------------------------------
                   3146: 
1.208     matthew  3147: sub track_student_link {
1.887     raeburn  3148:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3149:     my $link ="/adm/trackstudent?";
1.208     matthew  3150:     my $title = 'View recent activity';
                   3151:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3152:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3153:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3154:         $title .= ' of this student';
1.268     albertel 3155:     } 
1.208     matthew  3156:     if (defined($target) && $target !~ /^\s*$/) {
                   3157:         $target = qq{target="$target"};
                   3158:     } else {
                   3159:         $target = '';
                   3160:     }
1.268     albertel 3161:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3162:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3163:     $title = &mt($title);
                   3164:     $linktext = &mt($linktext);
1.448     albertel 3165:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3166: 	&help_open_topic('View_recent_activity');
1.208     matthew  3167: }
                   3168: 
1.781     raeburn  3169: sub slot_reservations_link {
                   3170:     my ($linktext,$sname,$sdom,$target) = @_;
                   3171:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3172:     my $title = 'View slot reservation history';
                   3173:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3174:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3175:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3176:         $title .= ' of this student';
                   3177:     }
                   3178:     if (defined($target) && $target !~ /^\s*$/) {
                   3179:         $target = qq{target="$target"};
                   3180:     } else {
                   3181:         $target = '';
                   3182:     }
                   3183:     $title = &mt($title);
                   3184:     $linktext = &mt($linktext);
                   3185:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3186: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3187: 
                   3188: }
                   3189: 
1.508     www      3190: # ===================================================== Display a student photo
                   3191: 
                   3192: 
1.509     albertel 3193: sub student_image_tag {
1.508     www      3194:     my ($domain,$user)=@_;
                   3195:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3196:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3197: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3198:     } else {
                   3199: 	return '';
                   3200:     }
                   3201: }
                   3202: 
1.112     bowersj2 3203: =pod
                   3204: 
                   3205: =back
                   3206: 
                   3207: =head1 Access .tab File Data
                   3208: 
                   3209: =over 4
                   3210: 
1.648     raeburn  3211: =item * &languageids() 
1.112     bowersj2 3212: 
                   3213: returns list of all language ids
                   3214: 
                   3215: =cut
                   3216: 
1.14      harris41 3217: sub languageids {
1.16      harris41 3218:     return sort(keys(%language));
1.14      harris41 3219: }
                   3220: 
1.112     bowersj2 3221: =pod
                   3222: 
1.648     raeburn  3223: =item * &languagedescription() 
1.112     bowersj2 3224: 
                   3225: returns description of a specified language id
                   3226: 
                   3227: =cut
                   3228: 
1.14      harris41 3229: sub languagedescription {
1.125     www      3230:     my $code=shift;
                   3231:     return  ($supported_language{$code}?'* ':'').
                   3232:             $language{$code}.
1.126     www      3233: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3234: }
                   3235: 
1.1048  ! foxr     3236: =pod
        !          3237: 
        !          3238: =item * &plainlanguagedescription
        !          3239: 
        !          3240: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
        !          3241: and the language character encoding (e.g. ISO) separated by a ' - ' string.
        !          3242: 
        !          3243: =cut
        !          3244: 
1.145     www      3245: sub plainlanguagedescription {
                   3246:     my $code=shift;
                   3247:     return $language{$code};
                   3248: }
                   3249: 
1.1048  ! foxr     3250: =pod
        !          3251: 
        !          3252: =item * &supportedlanguagecode
        !          3253: 
        !          3254: Returns the supported language code (e.g. sptutf maps to pt) given a language
        !          3255: code.
        !          3256: 
        !          3257: =cut
        !          3258: 
1.145     www      3259: sub supportedlanguagecode {
                   3260:     my $code=shift;
                   3261:     return $supported_language{$code};
1.97      www      3262: }
                   3263: 
1.112     bowersj2 3264: =pod
                   3265: 
1.1048  ! foxr     3266: =item * &latexlanguage()
        !          3267: 
        !          3268: Given a language key code returns the correspondnig language to use
        !          3269: to select the correct hyphenation on LaTeX printouts.  This is undef if there
        !          3270: is no supported hyphenation for the language code.
        !          3271: 
        !          3272: =cut
        !          3273: 
        !          3274: sub latexlanguage {
        !          3275:     my $code = shift;
        !          3276:     return $latex_language{$code};
        !          3277: }
        !          3278: 
        !          3279: =pod
        !          3280: 
        !          3281: =item * &latexhyphenation()
        !          3282: 
        !          3283: Same as above but what's supplied is the language as it might be stored
        !          3284: in the metadata.
        !          3285: 
        !          3286: =cut
        !          3287: 
        !          3288: sub latexhyphenation {
        !          3289:     my $key = shift;
        !          3290:     return $latex_language_bykey{$key};
        !          3291: }
        !          3292: 
        !          3293: =pod
        !          3294: 
1.648     raeburn  3295: =item * &copyrightids() 
1.112     bowersj2 3296: 
                   3297: returns list of all copyrights
                   3298: 
                   3299: =cut
                   3300: 
                   3301: sub copyrightids {
                   3302:     return sort(keys(%cprtag));
                   3303: }
                   3304: 
                   3305: =pod
                   3306: 
1.648     raeburn  3307: =item * &copyrightdescription() 
1.112     bowersj2 3308: 
                   3309: returns description of a specified copyright id
                   3310: 
                   3311: =cut
                   3312: 
                   3313: sub copyrightdescription {
1.166     www      3314:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3315: }
1.197     matthew  3316: 
                   3317: =pod
                   3318: 
1.648     raeburn  3319: =item * &source_copyrightids() 
1.192     taceyjo1 3320: 
                   3321: returns list of all source copyrights
                   3322: 
                   3323: =cut
                   3324: 
                   3325: sub source_copyrightids {
                   3326:     return sort(keys(%scprtag));
                   3327: }
                   3328: 
                   3329: =pod
                   3330: 
1.648     raeburn  3331: =item * &source_copyrightdescription() 
1.192     taceyjo1 3332: 
                   3333: returns description of a specified source copyright id
                   3334: 
                   3335: =cut
                   3336: 
                   3337: sub source_copyrightdescription {
                   3338:     return &mt($scprtag{shift(@_)});
                   3339: }
1.112     bowersj2 3340: 
                   3341: =pod
                   3342: 
1.648     raeburn  3343: =item * &filecategories() 
1.112     bowersj2 3344: 
                   3345: returns list of all file categories
                   3346: 
                   3347: =cut
                   3348: 
                   3349: sub filecategories {
                   3350:     return sort(keys(%category_extensions));
                   3351: }
                   3352: 
                   3353: =pod
                   3354: 
1.648     raeburn  3355: =item * &filecategorytypes() 
1.112     bowersj2 3356: 
                   3357: returns list of file types belonging to a given file
                   3358: category
                   3359: 
                   3360: =cut
                   3361: 
                   3362: sub filecategorytypes {
1.356     albertel 3363:     my ($cat) = @_;
                   3364:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3365: }
                   3366: 
                   3367: =pod
                   3368: 
1.648     raeburn  3369: =item * &fileembstyle() 
1.112     bowersj2 3370: 
                   3371: returns embedding style for a specified file type
                   3372: 
                   3373: =cut
                   3374: 
                   3375: sub fileembstyle {
                   3376:     return $fe{lc(shift(@_))};
1.169     www      3377: }
                   3378: 
1.351     www      3379: sub filemimetype {
                   3380:     return $fm{lc(shift(@_))};
                   3381: }
                   3382: 
1.169     www      3383: 
                   3384: sub filecategoryselect {
                   3385:     my ($name,$value)=@_;
1.189     matthew  3386:     return &select_form($value,$name,
1.970     raeburn  3387:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112     bowersj2 3388: }
                   3389: 
                   3390: =pod
                   3391: 
1.648     raeburn  3392: =item * &filedescription() 
1.112     bowersj2 3393: 
                   3394: returns description for a specified file type
                   3395: 
                   3396: =cut
                   3397: 
                   3398: sub filedescription {
1.188     matthew  3399:     my $file_description = $fd{lc(shift())};
                   3400:     $file_description =~ s:([\[\]]):~$1:g;
                   3401:     return &mt($file_description);
1.112     bowersj2 3402: }
                   3403: 
                   3404: =pod
                   3405: 
1.648     raeburn  3406: =item * &filedescriptionex() 
1.112     bowersj2 3407: 
                   3408: returns description for a specified file type with
                   3409: extra formatting
                   3410: 
                   3411: =cut
                   3412: 
                   3413: sub filedescriptionex {
                   3414:     my $ex=shift;
1.188     matthew  3415:     my $file_description = $fd{lc($ex)};
                   3416:     $file_description =~ s:([\[\]]):~$1:g;
                   3417:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3418: }
                   3419: 
                   3420: # End of .tab access
                   3421: =pod
                   3422: 
                   3423: =back
                   3424: 
                   3425: =cut
                   3426: 
                   3427: # ------------------------------------------------------------------ File Types
                   3428: sub fileextensions {
                   3429:     return sort(keys(%fe));
                   3430: }
                   3431: 
1.97      www      3432: # ----------------------------------------------------------- Display Languages
                   3433: # returns a hash with all desired display languages
                   3434: #
                   3435: 
                   3436: sub display_languages {
                   3437:     my %languages=();
1.695     raeburn  3438:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3439: 	$languages{$lang}=1;
1.97      www      3440:     }
                   3441:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3442:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3443: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3444: 	    $languages{$lang}=1;
1.97      www      3445:         }
                   3446:     }
                   3447:     return %languages;
1.14      harris41 3448: }
                   3449: 
1.582     albertel 3450: sub languages {
                   3451:     my ($possible_langs) = @_;
1.695     raeburn  3452:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3453:     if (!ref($possible_langs)) {
                   3454: 	if( wantarray ) {
                   3455: 	    return @preferred_langs;
                   3456: 	} else {
                   3457: 	    return $preferred_langs[0];
                   3458: 	}
                   3459:     }
                   3460:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3461:     my @preferred_possibilities;
                   3462:     foreach my $preferred_lang (@preferred_langs) {
                   3463: 	if (exists($possibilities{$preferred_lang})) {
                   3464: 	    push(@preferred_possibilities, $preferred_lang);
                   3465: 	}
                   3466:     }
                   3467:     if( wantarray ) {
                   3468: 	return @preferred_possibilities;
                   3469:     }
                   3470:     return $preferred_possibilities[0];
                   3471: }
                   3472: 
1.742     raeburn  3473: sub user_lang {
                   3474:     my ($touname,$toudom,$fromcid) = @_;
                   3475:     my @userlangs;
                   3476:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3477:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3478:                     $env{'course.'.$fromcid.'.languages'}));
                   3479:     } else {
                   3480:         my %langhash = &getlangs($touname,$toudom);
                   3481:         if ($langhash{'languages'} ne '') {
                   3482:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3483:         } else {
                   3484:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3485:             if ($domdefs{'lang_def'} ne '') {
                   3486:                 @userlangs = ($domdefs{'lang_def'});
                   3487:             }
                   3488:         }
                   3489:     }
                   3490:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3491:     my $user_lh = Apache::localize->get_handle(@languages);
                   3492:     return $user_lh;
                   3493: }
                   3494: 
                   3495: 
1.112     bowersj2 3496: ###############################################################
                   3497: ##               Student Answer Attempts                     ##
                   3498: ###############################################################
                   3499: 
                   3500: =pod
                   3501: 
                   3502: =head1 Alternate Problem Views
                   3503: 
                   3504: =over 4
                   3505: 
1.648     raeburn  3506: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3507:     $getattempt, $regexp, $gradesub)
                   3508: 
                   3509: Return string with previous attempt on problem. Arguments:
                   3510: 
                   3511: =over 4
                   3512: 
                   3513: =item * $symb: Problem, including path
                   3514: 
                   3515: =item * $username: username of the desired student
                   3516: 
                   3517: =item * $domain: domain of the desired student
1.14      harris41 3518: 
1.112     bowersj2 3519: =item * $course: Course ID
1.14      harris41 3520: 
1.112     bowersj2 3521: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3522:     something
1.14      harris41 3523: 
1.112     bowersj2 3524: =item * $regexp: if string matches this regexp, the string will be
                   3525:     sent to $gradesub
1.14      harris41 3526: 
1.112     bowersj2 3527: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3528: 
1.112     bowersj2 3529: =back
1.14      harris41 3530: 
1.112     bowersj2 3531: The output string is a table containing all desired attempts, if any.
1.16      harris41 3532: 
1.112     bowersj2 3533: =cut
1.1       albertel 3534: 
                   3535: sub get_previous_attempt {
1.43      ng       3536:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3537:   my $prevattempts='';
1.43      ng       3538:   no strict 'refs';
1.1       albertel 3539:   if ($symb) {
1.3       albertel 3540:     my (%returnhash)=
                   3541:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3542:     if ($returnhash{'version'}) {
                   3543:       my %lasthash=();
                   3544:       my $version;
                   3545:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3546:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3547: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3548:         }
1.1       albertel 3549:       }
1.596     albertel 3550:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3551:       $prevattempts.='<th>'.&mt('History').'</th>';
1.978     raeburn  3552:       my (%typeparts,%lasthidden);
1.945     raeburn  3553:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 3554:       foreach my $key (sort(keys(%lasthash))) {
                   3555: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3556: 	if ($#parts > 0) {
1.31      albertel 3557: 	  my $data=$parts[-1];
1.989     raeburn  3558:           next if ($data eq 'foilorder');
1.31      albertel 3559: 	  pop(@parts);
1.1010    www      3560:           $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.945     raeburn  3561:           if ($data eq 'type') {
                   3562:               unless ($showsurv) {
                   3563:                   my $id = join(',',@parts);
                   3564:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978     raeburn  3565:                   if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                   3566:                       $lasthidden{$ign.'.'.$id} = 1;
                   3567:                   }
1.945     raeburn  3568:               }
1.1010    www      3569:           } 
1.31      albertel 3570: 	} else {
1.41      ng       3571: 	  if ($#parts == 0) {
                   3572: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3573: 	  } else {
                   3574: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3575: 	  }
1.31      albertel 3576: 	}
1.16      harris41 3577:       }
1.596     albertel 3578:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3579:       if ($getattempt eq '') {
                   3580: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945     raeburn  3581:             my @hidden;
                   3582:             if (%typeparts) {
                   3583:                 foreach my $id (keys(%typeparts)) {
                   3584:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
                   3585:                         push(@hidden,$id);
                   3586:                     }
                   3587:                 }
                   3588:             }
                   3589:             $prevattempts.=&start_data_table_row().
                   3590:                            '<td>'.&mt('Transaction [_1]',$version).'</td>';
                   3591:             if (@hidden) {
                   3592:                 foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  3593:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  3594:                     my $hide;
                   3595:                     foreach my $id (@hidden) {
                   3596:                         if ($key =~ /^\Q$id\E/) {
                   3597:                             $hide = 1;
                   3598:                             last;
                   3599:                         }
                   3600:                     }
                   3601:                     if ($hide) {
                   3602:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   3603:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   3604:                             my $value = &format_previous_attempt_value($key,
                   3605:                                              $returnhash{$version.':'.$key});
                   3606:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3607:                         } else {
                   3608:                             $prevattempts.='<td>&nbsp;</td>';
                   3609:                         }
                   3610:                     } else {
                   3611:                         if ($key =~ /\./) {
                   3612:                             my $value = &format_previous_attempt_value($key,
                   3613:                                               $returnhash{$version.':'.$key});
                   3614:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3615:                         } else {
                   3616:                             $prevattempts.='<td>&nbsp;</td>';
                   3617:                         }
                   3618:                     }
                   3619:                 }
                   3620:             } else {
                   3621: 	        foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  3622:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  3623: 		    my $value = &format_previous_attempt_value($key,
                   3624: 			            $returnhash{$version.':'.$key});
                   3625: 		    $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3626: 	        }
                   3627:             }
                   3628: 	    $prevattempts.=&end_data_table_row();
1.40      ng       3629: 	 }
1.1       albertel 3630:       }
1.945     raeburn  3631:       my @currhidden = keys(%lasthidden);
1.596     albertel 3632:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3633:       foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  3634:           next if ($key =~ /\.foilorder$/);
1.945     raeburn  3635:           if (%typeparts) {
                   3636:               my $hidden;
                   3637:               foreach my $id (@currhidden) {
                   3638:                   if ($key =~ /^\Q$id\E/) {
                   3639:                       $hidden = 1;
                   3640:                       last;
                   3641:                   }
                   3642:               }
                   3643:               if ($hidden) {
                   3644:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   3645:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   3646:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3647:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3648:                           $value = &$gradesub($value);
                   3649:                       }
                   3650:                       $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3651:                   } else {
                   3652:                       $prevattempts.='<td>&nbsp;</td>';
                   3653:                   }
                   3654:               } else {
                   3655:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3656:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3657:                       $value = &$gradesub($value);
                   3658:                   }
                   3659:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3660:               }
                   3661:           } else {
                   3662: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3663: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3664:                   $value = &$gradesub($value);
                   3665:               }
                   3666: 	      $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3667:           }
1.16      harris41 3668:       }
1.596     albertel 3669:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3670:     } else {
1.596     albertel 3671:       $prevattempts=
                   3672: 	  &start_data_table().&start_data_table_row().
                   3673: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3674: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3675:     }
                   3676:   } else {
1.596     albertel 3677:     $prevattempts=
                   3678: 	  &start_data_table().&start_data_table_row().
                   3679: 	  '<td>'.&mt('No data.').'</td>'.
                   3680: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3681:   }
1.10      albertel 3682: }
                   3683: 
1.581     albertel 3684: sub format_previous_attempt_value {
                   3685:     my ($key,$value) = @_;
1.1011    www      3686:     if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581     albertel 3687: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3688:     } elsif (ref($value) eq 'ARRAY') {
                   3689: 	$value = '('.join(', ', @{ $value }).')';
1.988     raeburn  3690:     } elsif ($key =~ /answerstring$/) {
                   3691:         my %answers = &Apache::lonnet::str2hash($value);
                   3692:         my @anskeys = sort(keys(%answers));
                   3693:         if (@anskeys == 1) {
                   3694:             my $answer = $answers{$anskeys[0]};
1.1001    raeburn  3695:             if ($answer =~ m{\0}) {
                   3696:                 $answer =~ s{\0}{,}g;
1.988     raeburn  3697:             }
                   3698:             my $tag_internal_answer_name = 'INTERNAL';
                   3699:             if ($anskeys[0] eq $tag_internal_answer_name) {
                   3700:                 $value = $answer; 
                   3701:             } else {
                   3702:                 $value = $anskeys[0].'='.$answer;
                   3703:             }
                   3704:         } else {
                   3705:             foreach my $ans (@anskeys) {
                   3706:                 my $answer = $answers{$ans};
1.1001    raeburn  3707:                 if ($answer =~ m{\0}) {
                   3708:                     $answer =~ s{\0}{,}g;
1.988     raeburn  3709:                 }
                   3710:                 $value .=  $ans.'='.$answer.'<br />';;
                   3711:             } 
                   3712:         }
1.581     albertel 3713:     } else {
                   3714: 	$value = &unescape($value);
                   3715:     }
                   3716:     return $value;
                   3717: }
                   3718: 
                   3719: 
1.107     albertel 3720: sub relative_to_absolute {
                   3721:     my ($url,$output)=@_;
                   3722:     my $parser=HTML::TokeParser->new(\$output);
                   3723:     my $token;
                   3724:     my $thisdir=$url;
                   3725:     my @rlinks=();
                   3726:     while ($token=$parser->get_token) {
                   3727: 	if ($token->[0] eq 'S') {
                   3728: 	    if ($token->[1] eq 'a') {
                   3729: 		if ($token->[2]->{'href'}) {
                   3730: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3731: 		}
                   3732: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3733: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3734: 	    } elsif ($token->[1] eq 'base') {
                   3735: 		$thisdir=$token->[2]->{'href'};
                   3736: 	    }
                   3737: 	}
                   3738:     }
                   3739:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3740:     foreach my $link (@rlinks) {
1.726     raeburn  3741: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3742: 		($link=~/^\//) ||
                   3743: 		($link=~/^javascript:/i) ||
                   3744: 		($link=~/^mailto:/i) ||
                   3745: 		($link=~/^\#/)) {
                   3746: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3747: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3748: 	}
                   3749:     }
                   3750: # -------------------------------------------------- Deal with Applet codebases
                   3751:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3752:     return $output;
                   3753: }
                   3754: 
1.112     bowersj2 3755: =pod
                   3756: 
1.648     raeburn  3757: =item * &get_student_view()
1.112     bowersj2 3758: 
                   3759: show a snapshot of what student was looking at
                   3760: 
                   3761: =cut
                   3762: 
1.10      albertel 3763: sub get_student_view {
1.186     albertel 3764:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3765:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3766:   my (%form);
1.10      albertel 3767:   my @elements=('symb','courseid','domain','username');
                   3768:   foreach my $element (@elements) {
1.186     albertel 3769:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3770:   }
1.186     albertel 3771:   if (defined($moreenv)) {
                   3772:       %form=(%form,%{$moreenv});
                   3773:   }
1.236     albertel 3774:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3775:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3776:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3777:   $userview=~s/\<body[^\>]*\>//gi;
                   3778:   $userview=~s/\<\/body\>//gi;
                   3779:   $userview=~s/\<html\>//gi;
                   3780:   $userview=~s/\<\/html\>//gi;
                   3781:   $userview=~s/\<head\>//gi;
                   3782:   $userview=~s/\<\/head\>//gi;
                   3783:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3784:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3785:   if (wantarray) {
                   3786:      return ($userview,$response);
                   3787:   } else {
                   3788:      return $userview;
                   3789:   }
                   3790: }
                   3791: 
                   3792: sub get_student_view_with_retries {
                   3793:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3794: 
                   3795:     my $ok = 0;                 # True if we got a good response.
                   3796:     my $content;
                   3797:     my $response;
                   3798: 
                   3799:     # Try to get the student_view done. within the retries count:
                   3800:     
                   3801:     do {
                   3802:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3803:          $ok      = $response->is_success;
                   3804:          if (!$ok) {
                   3805:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3806:          }
                   3807:          $retries--;
                   3808:     } while (!$ok && ($retries > 0));
                   3809:     
                   3810:     if (!$ok) {
                   3811:        $content = '';          # On error return an empty content.
                   3812:     }
1.651     www      3813:     if (wantarray) {
                   3814:        return ($content, $response);
                   3815:     } else {
                   3816:        return $content;
                   3817:     }
1.11      albertel 3818: }
                   3819: 
1.112     bowersj2 3820: =pod
                   3821: 
1.648     raeburn  3822: =item * &get_student_answers() 
1.112     bowersj2 3823: 
                   3824: show a snapshot of how student was answering problem
                   3825: 
                   3826: =cut
                   3827: 
1.11      albertel 3828: sub get_student_answers {
1.100     sakharuk 3829:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3830:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3831:   my (%moreenv);
1.11      albertel 3832:   my @elements=('symb','courseid','domain','username');
                   3833:   foreach my $element (@elements) {
1.186     albertel 3834:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3835:   }
1.186     albertel 3836:   $moreenv{'grade_target'}='answer';
                   3837:   %moreenv=(%form,%moreenv);
1.497     raeburn  3838:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3839:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3840:   return $userview;
1.1       albertel 3841: }
1.116     albertel 3842: 
                   3843: =pod
                   3844: 
                   3845: =item * &submlink()
                   3846: 
1.242     albertel 3847: Inputs: $text $uname $udom $symb $target
1.116     albertel 3848: 
                   3849: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3850: 
                   3851: =cut
                   3852: 
                   3853: ###############################################
                   3854: sub submlink {
1.242     albertel 3855:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3856:     if (!($uname && $udom)) {
                   3857: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3858: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3859: 	if (!$symb) { $symb=$cursymb; }
                   3860:     }
1.254     matthew  3861:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3862:     $symb=&escape($symb);
1.960     bisitz   3863:     if ($target) { $target=" target=\"$target\""; }
                   3864:     return
                   3865:         '<a href="/adm/grades?command=submission'.
                   3866:         '&amp;symb='.$symb.
                   3867:         '&amp;student='.$uname.
                   3868:         '&amp;userdom='.$udom.'"'.
                   3869:         $target.'>'.$text.'</a>';
1.242     albertel 3870: }
                   3871: ##############################################
                   3872: 
                   3873: =pod
                   3874: 
                   3875: =item * &pgrdlink()
                   3876: 
                   3877: Inputs: $text $uname $udom $symb $target
                   3878: 
                   3879: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3880: 
                   3881: =cut
                   3882: 
                   3883: ###############################################
                   3884: sub pgrdlink {
                   3885:     my $link=&submlink(@_);
                   3886:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3887:     return $link;
                   3888: }
                   3889: ##############################################
                   3890: 
                   3891: =pod
                   3892: 
                   3893: =item * &pprmlink()
                   3894: 
                   3895: Inputs: $text $uname $udom $symb $target
                   3896: 
                   3897: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3898: student and a specific resource
1.242     albertel 3899: 
                   3900: =cut
                   3901: 
                   3902: ###############################################
                   3903: sub pprmlink {
                   3904:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3905:     if (!($uname && $udom)) {
                   3906: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3907: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3908: 	if (!$symb) { $symb=$cursymb; }
                   3909:     }
1.254     matthew  3910:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3911:     $symb=&escape($symb);
1.242     albertel 3912:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3913:     return '<a href="/adm/parmset?command=set&amp;'.
                   3914: 	'symb='.$symb.'&amp;uname='.$uname.
                   3915: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3916: }
                   3917: ##############################################
1.37      matthew  3918: 
1.112     bowersj2 3919: =pod
                   3920: 
                   3921: =back
                   3922: 
                   3923: =cut
                   3924: 
1.37      matthew  3925: ###############################################
1.51      www      3926: 
                   3927: 
                   3928: sub timehash {
1.687     raeburn  3929:     my ($thistime) = @_;
                   3930:     my $timezone = &Apache::lonlocal::gettimezone();
                   3931:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3932:                      ->set_time_zone($timezone);
                   3933:     my $wday = $dt->day_of_week();
                   3934:     if ($wday == 7) { $wday = 0; }
                   3935:     return ( 'second' => $dt->second(),
                   3936:              'minute' => $dt->minute(),
                   3937:              'hour'   => $dt->hour(),
                   3938:              'day'     => $dt->day_of_month(),
                   3939:              'month'   => $dt->month(),
                   3940:              'year'    => $dt->year(),
                   3941:              'weekday' => $wday,
                   3942:              'dayyear' => $dt->day_of_year(),
                   3943:              'dlsav'   => $dt->is_dst() );
1.51      www      3944: }
                   3945: 
1.370     www      3946: sub utc_string {
                   3947:     my ($date)=@_;
1.371     www      3948:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3949: }
                   3950: 
1.51      www      3951: sub maketime {
                   3952:     my %th=@_;
1.687     raeburn  3953:     my ($epoch_time,$timezone,$dt);
                   3954:     $timezone = &Apache::lonlocal::gettimezone();
                   3955:     eval {
                   3956:         $dt = DateTime->new( year   => $th{'year'},
                   3957:                              month  => $th{'month'},
                   3958:                              day    => $th{'day'},
                   3959:                              hour   => $th{'hour'},
                   3960:                              minute => $th{'minute'},
                   3961:                              second => $th{'second'},
                   3962:                              time_zone => $timezone,
                   3963:                          );
                   3964:     };
                   3965:     if (!$@) {
                   3966:         $epoch_time = $dt->epoch;
                   3967:         if ($epoch_time) {
                   3968:             return $epoch_time;
                   3969:         }
                   3970:     }
1.51      www      3971:     return POSIX::mktime(
                   3972:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3973:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3974: }
                   3975: 
                   3976: #########################################
1.51      www      3977: 
                   3978: sub findallcourses {
1.482     raeburn  3979:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3980:     my %roles;
                   3981:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3982:     my %courses;
1.51      www      3983:     my $now=time;
1.482     raeburn  3984:     if (!defined($uname)) {
                   3985:         $uname = $env{'user.name'};
                   3986:     }
                   3987:     if (!defined($udom)) {
                   3988:         $udom = $env{'user.domain'};
                   3989:     }
                   3990:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.982     raeburn  3991:         my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
                   3992:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,
                   3993:                                               $extra);
1.482     raeburn  3994:         if (!%roles) {
                   3995:             %roles = (
                   3996:                        cc => 1,
1.907     raeburn  3997:                        co => 1,
1.482     raeburn  3998:                        in => 1,
                   3999:                        ep => 1,
                   4000:                        ta => 1,
                   4001:                        cr => 1,
                   4002:                        st => 1,
                   4003:              );
                   4004:         }
                   4005:         foreach my $entry (keys(%roleshash)) {
                   4006:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   4007:             if ($trole =~ /^cr/) { 
                   4008:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   4009:             } else {
                   4010:                 next if (!exists($roles{$trole}));
                   4011:             }
                   4012:             if ($tend) {
                   4013:                 next if ($tend < $now);
                   4014:             }
                   4015:             if ($tstart) {
                   4016:                 next if ($tstart > $now);
                   4017:             }
                   4018:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   4019:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   4020:             if ($secpart eq '') {
                   4021:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   4022:                 $sec = 'none';
                   4023:                 $realsec = '';
                   4024:             } else {
                   4025:                 $cnum = $cnumpart;
                   4026:                 ($sec,$role) = split(/_/,$secpart);
                   4027:                 $realsec = $sec;
1.490     raeburn  4028:             }
1.482     raeburn  4029:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   4030:         }
                   4031:     } else {
                   4032:         foreach my $key (keys(%env)) {
1.483     albertel 4033: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   4034:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  4035: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   4036: 	        next if ($role eq 'ca' || $role eq 'aa');
                   4037: 	        next if (%roles && !exists($roles{$role}));
                   4038: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   4039:                 my $active=1;
                   4040:                 if ($starttime) {
                   4041: 		    if ($now<$starttime) { $active=0; }
                   4042:                 }
                   4043:                 if ($endtime) {
                   4044:                     if ($now>$endtime) { $active=0; }
                   4045:                 }
                   4046:                 if ($active) {
                   4047:                     if ($sec eq '') {
                   4048:                         $sec = 'none';
                   4049:                     }
                   4050:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   4051:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  4052:                 }
                   4053:             }
1.51      www      4054:         }
                   4055:     }
1.474     raeburn  4056:     return %courses;
1.51      www      4057: }
1.37      matthew  4058: 
1.54      www      4059: ###############################################
1.474     raeburn  4060: 
                   4061: sub blockcheck {
1.482     raeburn  4062:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  4063: 
                   4064:     if (!defined($udom)) {
                   4065:         $udom = $env{'user.domain'};
                   4066:     }
                   4067:     if (!defined($uname)) {
                   4068:         $uname = $env{'user.name'};
                   4069:     }
                   4070: 
                   4071:     # If uname and udom are for a course, check for blocks in the course.
                   4072: 
                   4073:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   4074:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  4075:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  4076:         return ($startblock,$endblock);
                   4077:     }
1.474     raeburn  4078: 
1.502     raeburn  4079:     my $startblock = 0;
                   4080:     my $endblock = 0;
1.482     raeburn  4081:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  4082: 
1.490     raeburn  4083:     # If uname is for a user, and activity is course-specific, i.e.,
                   4084:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  4085: 
1.490     raeburn  4086:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   4087:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   4088:         foreach my $key (keys(%live_courses)) {
                   4089:             if ($key ne $env{'request.course.id'}) {
                   4090:                 delete($live_courses{$key});
                   4091:             }
                   4092:         }
                   4093:     }
                   4094: 
                   4095:     my $otheruser = 0;
                   4096:     my %own_courses;
                   4097:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   4098:         # Resource belongs to user other than current user.
                   4099:         $otheruser = 1;
                   4100:         # Gather courses for current user
                   4101:         %own_courses = 
                   4102:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   4103:     }
                   4104: 
                   4105:     # Gather active course roles - course coordinator, instructor, 
                   4106:     # exam proctor, ta, student, or custom role.
1.474     raeburn  4107: 
                   4108:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  4109:         my ($cdom,$cnum);
                   4110:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   4111:             $cdom = $env{'course.'.$course.'.domain'};
                   4112:             $cnum = $env{'course.'.$course.'.num'};
                   4113:         } else {
1.490     raeburn  4114:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  4115:         }
                   4116:         my $no_ownblock = 0;
                   4117:         my $no_userblock = 0;
1.533     raeburn  4118:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  4119:             # Check if current user has 'evb' priv for this
                   4120:             if (defined($own_courses{$course})) {
                   4121:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   4122:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   4123:                     if ($sec ne 'none') {
                   4124:                         $checkrole .= '/'.$sec;
                   4125:                     }
                   4126:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4127:                         $no_ownblock = 1;
                   4128:                         last;
                   4129:                     }
                   4130:                 }
                   4131:             }
                   4132:             # if they have 'evb' priv and are currently not playing student
                   4133:             next if (($no_ownblock) &&
                   4134:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   4135:         }
1.474     raeburn  4136:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  4137:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  4138:             if ($sec ne 'none') {
1.482     raeburn  4139:                 $checkrole .= '/'.$sec;
1.474     raeburn  4140:             }
1.490     raeburn  4141:             if ($otheruser) {
                   4142:                 # Resource belongs to user other than current user.
                   4143:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  4144:                 my ($trole,$tdom,$tnum,$tsec);
                   4145:                 my $entry = $live_courses{$course}{$sec};
                   4146:                 if ($entry =~ /^cr/) {
                   4147:                     ($trole,$tdom,$tnum,$tsec) = 
                   4148:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   4149:                 } else {
                   4150:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   4151:                 }
                   4152:                 my ($spec,$area,$trest,%allroles,%userroles);
                   4153:                 $area = '/'.$tdom.'/'.$tnum;
                   4154:                 $trest = $tnum;
                   4155:                 if ($tsec ne '') {
                   4156:                     $area .= '/'.$tsec;
                   4157:                     $trest .= '/'.$tsec;
                   4158:                 }
                   4159:                 $spec = $trole.'.'.$area;
                   4160:                 if ($trole =~ /^cr/) {
                   4161:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   4162:                                                       $tdom,$spec,$trest,$area);
                   4163:                 } else {
                   4164:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   4165:                                                        $tdom,$spec,$trest,$area);
                   4166:                 }
                   4167:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  4168:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   4169:                     if ($1) {
                   4170:                         $no_userblock = 1;
                   4171:                         last;
                   4172:                     }
                   4173:                 }
1.490     raeburn  4174:             } else {
                   4175:                 # Resource belongs to current user
                   4176:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  4177:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4178:                     $no_ownblock = 1;
                   4179:                     last;
                   4180:                 }
1.474     raeburn  4181:             }
                   4182:         }
                   4183:         # if they have the evb priv and are currently not playing student
1.482     raeburn  4184:         next if (($no_ownblock) &&
1.491     albertel 4185:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  4186:         next if ($no_userblock);
1.474     raeburn  4187: 
1.866     kalberla 4188:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  4189:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  4190:         
                   4191:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   4192:         if (($start != 0) && 
                   4193:             (($startblock == 0) || ($startblock > $start))) {
                   4194:             $startblock = $start;
                   4195:         }
                   4196:         if (($end != 0)  &&
                   4197:             (($endblock == 0) || ($endblock < $end))) {
                   4198:             $endblock = $end;
                   4199:         }
1.490     raeburn  4200:     }
                   4201:     return ($startblock,$endblock);
                   4202: }
                   4203: 
                   4204: sub get_blocks {
                   4205:     my ($setters,$activity,$cdom,$cnum) = @_;
                   4206:     my $startblock = 0;
                   4207:     my $endblock = 0;
                   4208:     my $course = $cdom.'_'.$cnum;
                   4209:     $setters->{$course} = {};
                   4210:     $setters->{$course}{'staff'} = [];
                   4211:     $setters->{$course}{'times'} = [];
                   4212:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   4213:     foreach my $record (keys(%records)) {
                   4214:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   4215:         if ($start <= time && $end >= time) {
                   4216:             my ($staff_name,$staff_dom,$title,$blocks) =
                   4217:                 &parse_block_record($records{$record});
                   4218:             if ($blocks->{$activity} eq 'on') {
                   4219:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   4220:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 4221:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   4222:                     $startblock = $start;
1.490     raeburn  4223:                 }
1.491     albertel 4224:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   4225:                     $endblock = $end;
1.474     raeburn  4226:                 }
                   4227:             }
                   4228:         }
                   4229:     }
                   4230:     return ($startblock,$endblock);
                   4231: }
                   4232: 
                   4233: sub parse_block_record {
                   4234:     my ($record) = @_;
                   4235:     my ($setuname,$setudom,$title,$blocks);
                   4236:     if (ref($record) eq 'HASH') {
                   4237:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   4238:         $title = &unescape($record->{'event'});
                   4239:         $blocks = $record->{'blocks'};
                   4240:     } else {
                   4241:         my @data = split(/:/,$record,3);
                   4242:         if (scalar(@data) eq 2) {
                   4243:             $title = $data[1];
                   4244:             ($setuname,$setudom) = split(/@/,$data[0]);
                   4245:         } else {
                   4246:             ($setuname,$setudom,$title) = @data;
                   4247:         }
                   4248:         $blocks = { 'com' => 'on' };
                   4249:     }
                   4250:     return ($setuname,$setudom,$title,$blocks);
                   4251: }
                   4252: 
1.854     kalberla 4253: sub blocking_status {
                   4254:   my ($activity,$uname,$udom) = @_;
1.867     kalberla 4255:   my %setters;
1.890     droeschl 4256: 
                   4257:   # check for active blocking
1.867     kalberla 4258:   my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854     kalberla 4259: 
1.890     droeschl 4260:   my $blocked = $startblock && $endblock ? 1 : 0;
                   4261: 
                   4262:   # caller just wants to know whether a block is active
                   4263:   if (!wantarray) { return $blocked; }
                   4264: 
                   4265:   # build a link to a popup window containing the details
                   4266:   my $querystring  = "?activity=$activity";
                   4267:   # $uname and $udom decide whose portfolio the user is trying to look at
                   4268:      $querystring .= "&amp;udom=$udom"      if $udom;
                   4269:      $querystring .= "&amp;uname=$uname"    if $uname;
                   4270: 
                   4271:   my $output .= <<'END_MYBLOCK';
1.854     kalberla 4272:     function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4273:         var options = "width=" + w + ",height=" + h + ",";
                   4274:         options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4275:         options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4276:         var newWin = window.open(url, wdwName, options);
                   4277:         newWin.focus();
                   4278:     }
1.890     droeschl 4279: END_MYBLOCK
1.854     kalberla 4280: 
1.890     droeschl 4281:   $output = Apache::lonhtmlcommon::scripttag($output);
                   4282:   
1.854     kalberla 4283:   my $popupUrl = "/adm/blockingstatus/$querystring";
1.890     droeschl 4284:   my $text = mt('Communication Blocked');
                   4285: 
1.867     kalberla 4286:   $output .= <<"END_BLOCK";
                   4287: <div class='LC_comblock'>
1.869     kalberla 4288:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 4289:   title='$text'>
                   4290:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 4291:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 4292:   title='$text'>$text</a>
1.867     kalberla 4293: </div>
                   4294: 
                   4295: END_BLOCK
1.474     raeburn  4296: 
1.854     kalberla 4297:   return ($blocked, $output);
                   4298: }
1.490     raeburn  4299: 
1.60      matthew  4300: ###############################################
                   4301: 
1.682     raeburn  4302: sub check_ip_acc {
                   4303:     my ($acc)=@_;
                   4304:     &Apache::lonxml::debug("acc is $acc");
                   4305:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   4306:         return 1;
                   4307:     }
                   4308:     my $allowed=0;
                   4309:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   4310: 
                   4311:     my $name;
                   4312:     foreach my $pattern (split(',',$acc)) {
                   4313:         $pattern =~ s/^\s*//;
                   4314:         $pattern =~ s/\s*$//;
                   4315:         if ($pattern =~ /\*$/) {
                   4316:             #35.8.*
                   4317:             $pattern=~s/\*//;
                   4318:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4319:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   4320:             #35.8.3.[34-56]
                   4321:             my $low=$2;
                   4322:             my $high=$3;
                   4323:             $pattern=$1;
                   4324:             if ($ip =~ /^\Q$pattern\E/) {
                   4325:                 my $last=(split(/\./,$ip))[3];
                   4326:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4327:             }
                   4328:         } elsif ($pattern =~ /^\*/) {
                   4329:             #*.msu.edu
                   4330:             $pattern=~s/\*//;
                   4331:             if (!defined($name)) {
                   4332:                 use Socket;
                   4333:                 my $netaddr=inet_aton($ip);
                   4334:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4335:             }
                   4336:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4337:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4338:             #127.0.0.1
                   4339:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4340:         } else {
                   4341:             #some.name.com
                   4342:             if (!defined($name)) {
                   4343:                 use Socket;
                   4344:                 my $netaddr=inet_aton($ip);
                   4345:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4346:             }
                   4347:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4348:         }
                   4349:         if ($allowed) { last; }
                   4350:     }
                   4351:     return $allowed;
                   4352: }
                   4353: 
                   4354: ###############################################
                   4355: 
1.60      matthew  4356: =pod
                   4357: 
1.112     bowersj2 4358: =head1 Domain Template Functions
                   4359: 
                   4360: =over 4
                   4361: 
                   4362: =item * &determinedomain()
1.60      matthew  4363: 
                   4364: Inputs: $domain (usually will be undef)
                   4365: 
1.63      www      4366: Returns: Determines which domain should be used for designs
1.60      matthew  4367: 
                   4368: =cut
1.54      www      4369: 
1.60      matthew  4370: ###############################################
1.63      www      4371: sub determinedomain {
                   4372:     my $domain=shift;
1.531     albertel 4373:     if (! $domain) {
1.60      matthew  4374:         # Determine domain if we have not been given one
1.893     raeburn  4375:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 4376:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4377:         if ($env{'request.role.domain'}) { 
                   4378:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4379:         }
                   4380:     }
1.63      www      4381:     return $domain;
                   4382: }
                   4383: ###############################################
1.517     raeburn  4384: 
1.518     albertel 4385: sub devalidate_domconfig_cache {
                   4386:     my ($udom)=@_;
                   4387:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4388: }
                   4389: 
                   4390: # ---------------------- Get domain configuration for a domain
                   4391: sub get_domainconf {
                   4392:     my ($udom) = @_;
                   4393:     my $cachetime=1800;
                   4394:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4395:     if (defined($cached)) { return %{$result}; }
                   4396: 
                   4397:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  4398: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  4399:     my (%designhash,%legacy);
1.518     albertel 4400:     if (keys(%domconfig) > 0) {
                   4401:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4402:             if (keys(%{$domconfig{'login'}})) {
                   4403:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4404:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946     raeburn  4405:                         if ($key eq 'loginvia') {
                   4406:                             if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013    raeburn  4407:                                 foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948     raeburn  4408:                                     if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
                   4409:                                         if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   4410:                                             my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   4411:                                             $designhash{$udom.'.login.loginvia'} = $server;
                   4412:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   4413: 
                   4414:                                                 $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   4415:                                             } else {
1.1013    raeburn  4416:                                                 $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948     raeburn  4417:                                             }
                   4418:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
                   4419:                                                 $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
                   4420:                                             }
1.946     raeburn  4421:                                         }
                   4422:                                     }
                   4423:                                 }
                   4424:                             }
                   4425:                         } else {
                   4426:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4427:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4428:                                     $domconfig{'login'}{$key}{$img};
                   4429:                             }
1.699     raeburn  4430:                         }
                   4431:                     } else {
                   4432:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4433:                     }
1.632     raeburn  4434:                 }
                   4435:             } else {
                   4436:                 $legacy{'login'} = 1;
1.518     albertel 4437:             }
1.632     raeburn  4438:         } else {
                   4439:             $legacy{'login'} = 1;
1.518     albertel 4440:         }
                   4441:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4442:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4443:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4444:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4445:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4446:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4447:                         }
1.518     albertel 4448:                     }
                   4449:                 }
1.632     raeburn  4450:             } else {
                   4451:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4452:             }
1.632     raeburn  4453:         } else {
                   4454:             $legacy{'rolecolors'} = 1;
1.518     albertel 4455:         }
1.948     raeburn  4456:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   4457:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   4458:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   4459:             }
                   4460:         }
1.632     raeburn  4461:         if (keys(%legacy) > 0) {
                   4462:             my %legacyhash = &get_legacy_domconf($udom);
                   4463:             foreach my $item (keys(%legacyhash)) {
                   4464:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4465:                     if ($legacy{'login'}) { 
                   4466:                         $designhash{$item} = $legacyhash{$item};
                   4467:                     }
                   4468:                 } else {
                   4469:                     if ($legacy{'rolecolors'}) {
                   4470:                         $designhash{$item} = $legacyhash{$item};
                   4471:                     }
1.518     albertel 4472:                 }
                   4473:             }
                   4474:         }
1.632     raeburn  4475:     } else {
                   4476:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4477:     }
                   4478:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4479: 				  $cachetime);
                   4480:     return %designhash;
                   4481: }
                   4482: 
1.632     raeburn  4483: sub get_legacy_domconf {
                   4484:     my ($udom) = @_;
                   4485:     my %legacyhash;
                   4486:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4487:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4488:     if (-e $designfile) {
                   4489:         if ( open (my $fh,"<$designfile") ) {
                   4490:             while (my $line = <$fh>) {
                   4491:                 next if ($line =~ /^\#/);
                   4492:                 chomp($line);
                   4493:                 my ($key,$val)=(split(/\=/,$line));
                   4494:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4495:             }
                   4496:             close($fh);
                   4497:         }
                   4498:     }
1.1026    raeburn  4499:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  4500:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4501:     }
                   4502:     return %legacyhash;
                   4503: }
                   4504: 
1.63      www      4505: =pod
                   4506: 
1.112     bowersj2 4507: =item * &domainlogo()
1.63      www      4508: 
                   4509: Inputs: $domain (usually will be undef)
                   4510: 
                   4511: Returns: A link to a domain logo, if the domain logo exists.
                   4512: If the domain logo does not exist, a description of the domain.
                   4513: 
                   4514: =cut
1.112     bowersj2 4515: 
1.63      www      4516: ###############################################
                   4517: sub domainlogo {
1.517     raeburn  4518:     my $domain = &determinedomain(shift);
1.518     albertel 4519:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4520:     # See if there is a logo
                   4521:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4522:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4523:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4524: 	    if ($imgsrc =~ m{^/res/}) {
                   4525: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4526: 		&Apache::lonnet::repcopy($local_name);
                   4527: 	    }
                   4528: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4529:         } 
                   4530:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4531:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4532:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4533:     } else {
1.60      matthew  4534:         return '';
1.59      www      4535:     }
                   4536: }
1.63      www      4537: ##############################################
                   4538: 
                   4539: =pod
                   4540: 
1.112     bowersj2 4541: =item * &designparm()
1.63      www      4542: 
                   4543: Inputs: $which parameter; $domain (usually will be undef)
                   4544: 
                   4545: Returns: value of designparamter $which
                   4546: 
                   4547: =cut
1.112     bowersj2 4548: 
1.397     albertel 4549: 
1.400     albertel 4550: ##############################################
1.397     albertel 4551: sub designparm {
                   4552:     my ($which,$domain)=@_;
                   4553:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4554:         return $env{'environment.color.'.$which};
1.96      www      4555:     }
1.63      www      4556:     $domain=&determinedomain($domain);
1.1016    raeburn  4557:     my %domdesign;
                   4558:     unless ($domain eq 'public') {
                   4559:         %domdesign = &get_domainconf($domain);
                   4560:     }
1.520     raeburn  4561:     my $output;
1.517     raeburn  4562:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4563:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4564:     } else {
1.520     raeburn  4565:         $output = $defaultdesign{$which};
                   4566:     }
                   4567:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4568:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4569:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4570:             if ($output =~ m{^/res/}) {
                   4571:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4572:                 &Apache::lonnet::repcopy($local_name);
                   4573:             }
1.520     raeburn  4574:             $output = &lonhttpdurl($output);
                   4575:         }
1.63      www      4576:     }
1.520     raeburn  4577:     return $output;
1.63      www      4578: }
1.59      www      4579: 
1.822     bisitz   4580: ##############################################
                   4581: =pod
                   4582: 
1.832     bisitz   4583: =item * &authorspace()
                   4584: 
1.1028    raeburn  4585: Inputs: $url (usually will be undef).
1.832     bisitz   4586: 
1.1028    raeburn  4587: Returns: Path to Construction Space containing the resource or 
                   4588:          directory being viewed (or for which action is being taken). 
                   4589:          If $url is provided, and begins /priv/<domain>/<uname>
                   4590:          the path will be that portion of the $context argument.
                   4591:          Otherwise the path will be for the author space of the current
                   4592:          user when the current role is author, or for that of the 
                   4593:          co-author/assistant co-author space when the current role 
                   4594:          is co-author or assistant co-author.
1.832     bisitz   4595: 
                   4596: =cut
                   4597: 
                   4598: sub authorspace {
1.1028    raeburn  4599:     my ($url) = @_;
                   4600:     if ($url ne '') {
                   4601:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   4602:            return $1;
                   4603:         }
                   4604:     }
1.832     bisitz   4605:     my $caname = '';
1.1024    www      4606:     my $cadom = '';
1.1028    raeburn  4607:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      4608:         ($cadom,$caname) =
1.832     bisitz   4609:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  4610:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   4611:         $caname = $env{'user.name'};
1.1024    www      4612:         $cadom = $env{'user.domain'};
1.832     bisitz   4613:     }
1.1028    raeburn  4614:     if (($caname ne '') && ($cadom ne '')) {
                   4615:         return "/priv/$cadom/$caname/";
                   4616:     }
                   4617:     return;
1.832     bisitz   4618: }
                   4619: 
                   4620: ##############################################
                   4621: =pod
                   4622: 
1.822     bisitz   4623: =item * &head_subbox()
                   4624: 
                   4625: Inputs: $content (contains HTML code with page functions, etc.)
                   4626: 
                   4627: Returns: HTML div with $content
                   4628:          To be included in page header
                   4629: 
                   4630: =cut
                   4631: 
                   4632: sub head_subbox {
                   4633:     my ($content)=@_;
                   4634:     my $output =
1.993     raeburn  4635:         '<div class="LC_head_subbox">'
1.822     bisitz   4636:        .$content
                   4637:        .'</div>'
                   4638: }
                   4639: 
                   4640: ##############################################
                   4641: =pod
                   4642: 
                   4643: =item * &CSTR_pageheader()
                   4644: 
1.1026    raeburn  4645: Input: (optional) filename from which breadcrumb trail is built.
                   4646:        In most cases no input as needed, as $env{'request.filename'}
                   4647:        is appropriate for use in building the breadcrumb trail.
1.822     bisitz   4648: 
                   4649: Returns: HTML div with CSTR path and recent box
                   4650:          To be included on Construction Space pages
                   4651: 
                   4652: =cut
                   4653: 
                   4654: sub CSTR_pageheader {
1.1026    raeburn  4655:     my ($trailfile) = @_;
                   4656:     if ($trailfile eq '') {
                   4657:         $trailfile = $env{'request.filename'};
                   4658:     }
                   4659: 
                   4660: # this is for resources; directories have customtitle, and crumbs
                   4661: # and select recent are created in lonpubdir.pm
                   4662: 
                   4663:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      4664:     my ($udom,$uname,$thisdisfn)=
1.1026    raeburn  4665:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)/(.*)$});
                   4666:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   4667:     $formaction =~ s{/+}{/}g;
1.822     bisitz   4668: 
                   4669:     my $parentpath = '';
                   4670:     my $lastitem = '';
                   4671:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4672:         $parentpath = $1;
                   4673:         $lastitem = $2;
                   4674:     } else {
                   4675:         $lastitem = $thisdisfn;
                   4676:     }
1.921     bisitz   4677: 
                   4678:     my $output =
1.822     bisitz   4679:          '<div>'
                   4680:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4681:         .'<b>'.&mt('Construction Space:').'</b> '
                   4682:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   4683:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024    www      4684:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921     bisitz   4685: 
                   4686:     if ($lastitem) {
                   4687:         $output .=
                   4688:              '<span class="LC_filename">'
                   4689:             .$lastitem
                   4690:             .'</span>';
                   4691:     }
                   4692:     $output .=
                   4693:          '<br />'
1.822     bisitz   4694:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4695:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4696:         .'</form>'
                   4697:         .&Apache::lonmenu::constspaceform()
                   4698:         .'</div>';
1.921     bisitz   4699: 
                   4700:     return $output;
1.822     bisitz   4701: }
                   4702: 
1.60      matthew  4703: ###############################################
                   4704: ###############################################
                   4705: 
                   4706: =pod
                   4707: 
1.112     bowersj2 4708: =back
                   4709: 
1.549     albertel 4710: =head1 HTML Helpers
1.112     bowersj2 4711: 
                   4712: =over 4
                   4713: 
                   4714: =item * &bodytag()
1.60      matthew  4715: 
                   4716: Returns a uniform header for LON-CAPA web pages.
                   4717: 
                   4718: Inputs: 
                   4719: 
1.112     bowersj2 4720: =over 4
                   4721: 
                   4722: =item * $title, A title to be displayed on the page.
                   4723: 
                   4724: =item * $function, the current role (can be undef).
                   4725: 
                   4726: =item * $addentries, extra parameters for the <body> tag.
                   4727: 
                   4728: =item * $bodyonly, if defined, only return the <body> tag.
                   4729: 
                   4730: =item * $domain, if defined, force a given domain.
                   4731: 
                   4732: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4733:             text interface only)
1.60      matthew  4734: 
1.814     bisitz   4735: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4736:                      navigational links
1.317     albertel 4737: 
1.338     albertel 4738: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4739: 
1.460     albertel 4740: =item * $args, optional argument valid values are
                   4741:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4742:             inherit_jsmath -> when creating popup window in a page,
                   4743:                               should it have jsmath forced on by the
                   4744:                               current page
1.460     albertel 4745: 
1.112     bowersj2 4746: =back
                   4747: 
1.60      matthew  4748: Returns: A uniform header for LON-CAPA web pages.  
                   4749: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4750: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4751: other decorations will be returned.
                   4752: 
                   4753: =cut
                   4754: 
1.54      www      4755: sub bodytag {
1.831     bisitz   4756:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962     droeschl 4757:         $no_nav_bar,$bgcolor,$args)=@_;
1.339     albertel 4758: 
1.954     raeburn  4759:     my $public;
                   4760:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   4761:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   4762:         $public = 1;
                   4763:     }
1.460     albertel 4764:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4765: 
1.183     matthew  4766:     $function = &get_users_function() if (!$function);
1.339     albertel 4767:     my $img =    &designparm($function.'.img',$domain);
                   4768:     my $font =   &designparm($function.'.font',$domain);
                   4769:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4770: 
1.803     bisitz   4771:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4772: 		   'bgcolor' => $pgbg,
1.339     albertel 4773: 		   'text'    => $font,
                   4774:                    'alink'   => &designparm($function.'.alink',$domain),
                   4775: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4776: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4777:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4778: 
1.63      www      4779:  # role and realm
1.378     raeburn  4780:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4781:     if ($role  eq 'ca') {
1.479     albertel 4782:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4783:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4784:     } 
1.55      www      4785: # realm
1.258     albertel 4786:     if ($env{'request.course.id'}) {
1.378     raeburn  4787:         if ($env{'request.role'} !~ /^cr/) {
                   4788:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4789:         }
1.898     raeburn  4790:         if ($env{'request.course.sec'}) {
                   4791:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   4792:         }   
1.359     albertel 4793: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4794:     } else {
                   4795:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4796:     }
1.433     albertel 4797: 
1.359     albertel 4798:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 4799: 
1.438     albertel 4800:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4801: 
1.101     www      4802: # construct main body tag
1.359     albertel 4803:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4804: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4805: 
1.530     albertel 4806:     if ($bodyonly) {
1.60      matthew  4807:         return $bodytag;
1.798     tempelho 4808:     } 
1.359     albertel 4809: 
1.410     albertel 4810:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954     raeburn  4811:     if ($public) {
1.433     albertel 4812: 	undef($role);
1.434     albertel 4813:     } else {
                   4814: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4815:     }
1.359     albertel 4816:     
1.762     bisitz   4817:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4818:     #
                   4819:     # Extra info if you are the DC
                   4820:     my $dc_info = '';
                   4821:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4822:                         $env{'course.'.$env{'request.course.id'}.
                   4823:                                  '.domain'}.'/'})) {
                   4824:         my $cid = $env{'request.course.id'};
1.917     raeburn  4825:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4826:         $dc_info =~ s/\s+$//;
1.359     albertel 4827:     }
                   4828: 
1.898     raeburn  4829:     $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853     droeschl 4830:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   4831: 
1.916     droeschl 4832:         if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') { 
                   4833:             return $bodytag; 
                   4834:         } 
1.903     droeschl 4835: 
                   4836:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   4837: 
                   4838:         #    if ($env{'request.state'} eq 'construct') {
                   4839:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4840:         #    }
                   4841: 
1.359     albertel 4842: 
                   4843: 
1.916     droeschl 4844:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917     raeburn  4845:              if ($dc_info) {
                   4846:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   4847:              }
1.916     droeschl 4848:              $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   4849:                 <em>$realm</em> $dc_info</div>|;
1.903     droeschl 4850:             return $bodytag;
                   4851:         }
1.894     droeschl 4852: 
1.927     raeburn  4853:         unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
                   4854:             $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
                   4855:         }
1.916     droeschl 4856: 
1.903     droeschl 4857:         $bodytag .= Apache::lonhtmlcommon::scripttag(
                   4858:             Apache::lonmenu::utilityfunctions(), 'start');
1.816     bisitz   4859: 
1.903     droeschl 4860:         $bodytag .= Apache::lonmenu::primary_menu();
1.852     droeschl 4861: 
1.917     raeburn  4862:         if ($dc_info) {
                   4863:             $dc_info = &dc_courseid_toggle($dc_info);
                   4864:         }
                   4865:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 4866: 
1.903     droeschl 4867:         #don't show menus for public users
1.954     raeburn  4868:         if (!$public){
1.903     droeschl 4869:             $bodytag .= Apache::lonmenu::secondary_menu();
                   4870:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  4871:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   4872:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 4873:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920     raeburn  4874:                                 $args->{'bread_crumbs'});
                   4875:             } elsif ($forcereg) { 
                   4876:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg);
                   4877:             }
1.903     droeschl 4878:         }else{
                   4879:             # this is to seperate menu from content when there's no secondary
                   4880:             # menu. Especially needed for public accessible ressources.
                   4881:             $bodytag .= '<hr style="clear:both" />';
                   4882:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  4883:         }
1.903     droeschl 4884: 
1.235     raeburn  4885:         return $bodytag;
1.182     matthew  4886: }
                   4887: 
1.917     raeburn  4888: sub dc_courseid_toggle {
                   4889:     my ($dc_info) = @_;
1.980     raeburn  4890:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.917     raeburn  4891:            '<a href="javascript:showCourseID();">'.
                   4892:            &mt('(More ...)').'</a></span>'.
                   4893:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   4894: }
                   4895: 
1.330     albertel 4896: sub make_attr_string {
                   4897:     my ($register,$attr_ref) = @_;
                   4898: 
                   4899:     if ($attr_ref && !ref($attr_ref)) {
                   4900: 	die("addentries Must be a hash ref ".
                   4901: 	    join(':',caller(1))." ".
                   4902: 	    join(':',caller(0))." ");
                   4903:     }
                   4904: 
                   4905:     if ($register) {
1.339     albertel 4906: 	my ($on_load,$on_unload);
                   4907: 	foreach my $key (keys(%{$attr_ref})) {
                   4908: 	    if      (lc($key) eq 'onload') {
                   4909: 		$on_load.=$attr_ref->{$key}.';';
                   4910: 		delete($attr_ref->{$key});
                   4911: 
                   4912: 	    } elsif (lc($key) eq 'onunload') {
                   4913: 		$on_unload.=$attr_ref->{$key}.';';
                   4914: 		delete($attr_ref->{$key});
                   4915: 	    }
                   4916: 	}
1.953     droeschl 4917: 	$attr_ref->{'onload'}  = $on_load;
                   4918: 	$attr_ref->{'onunload'}= $on_unload;
1.330     albertel 4919:     }
1.339     albertel 4920: 
1.330     albertel 4921:     my $attr_string;
                   4922:     foreach my $attr (keys(%$attr_ref)) {
                   4923: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4924:     }
                   4925:     return $attr_string;
                   4926: }
                   4927: 
                   4928: 
1.182     matthew  4929: ###############################################
1.251     albertel 4930: ###############################################
                   4931: 
                   4932: =pod
                   4933: 
                   4934: =item * &endbodytag()
                   4935: 
                   4936: Returns a uniform footer for LON-CAPA web pages.
                   4937: 
1.635     raeburn  4938: Inputs: 1 - optional reference to an args hash
                   4939: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4940: a 'Continue' link is not displayed if the page contains an
                   4941: internal redirect in the <head></head> section,
                   4942: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4943: 
                   4944: =cut
                   4945: 
                   4946: sub endbodytag {
1.635     raeburn  4947:     my ($args) = @_;
1.251     albertel 4948:     my $endbodytag='</body>';
1.269     albertel 4949:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4950:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4951:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4952: 	    $endbodytag=
                   4953: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4954: 	        &mt('Continue').'</a>'.
                   4955: 	        $endbodytag;
                   4956:         }
1.315     albertel 4957:     }
1.251     albertel 4958:     return $endbodytag;
                   4959: }
                   4960: 
1.352     albertel 4961: =pod
                   4962: 
                   4963: =item * &standard_css()
                   4964: 
                   4965: Returns a style sheet
                   4966: 
                   4967: Inputs: (all optional)
                   4968:             domain         -> force to color decorate a page for a specific
                   4969:                                domain
                   4970:             function       -> force usage of a specific rolish color scheme
                   4971:             bgcolor        -> override the default page bgcolor
                   4972: 
                   4973: =cut
                   4974: 
1.343     albertel 4975: sub standard_css {
1.345     albertel 4976:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4977:     $function  = &get_users_function() if (!$function);
                   4978:     my $img    = &designparm($function.'.img',   $domain);
                   4979:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4980:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4981:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4982: #second colour for later usage
1.345     albertel 4983:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4984:     my $pgbg_or_bgcolor =
                   4985: 	         $bgcolor ||
1.352     albertel 4986: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4987:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4988:     my $alink  = &designparm($function.'.alink', $domain);
                   4989:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4990:     my $link   = &designparm($function.'.link',  $domain);
                   4991: 
1.602     albertel 4992:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4993:     my $mono                 = 'monospace';
1.850     bisitz   4994:     my $data_table_head      = $sidebg;
                   4995:     my $data_table_light     = '#FAFAFA';
                   4996:     my $data_table_dark      = '#F0F0F0';
1.470     banghart 4997:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4998:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4999:     my $mail_new             = '#FFBB77';
                   5000:     my $mail_new_hover       = '#DD9955';
                   5001:     my $mail_read            = '#BBBB77';
                   5002:     my $mail_read_hover      = '#999944';
                   5003:     my $mail_replied         = '#AAAA88';
                   5004:     my $mail_replied_hover   = '#888855';
                   5005:     my $mail_other           = '#99BBBB';
                   5006:     my $mail_other_hover     = '#669999';
1.391     albertel 5007:     my $table_header         = '#DDDDDD';
1.489     raeburn  5008:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   5009:     my $lg_border_color      = '#C8C8C8';
1.952     onken    5010:     my $button_hover         = '#BF2317';
1.392     albertel 5011: 
1.608     albertel 5012:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   5013:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   5014:                                              : '0 3px 0 4px';
1.448     albertel 5015: 
1.523     albertel 5016: 
1.343     albertel 5017:     return <<END;
1.947     droeschl 5018: 
                   5019: /* needed for iframe to allow 100% height in FF */
                   5020: body, html { 
                   5021:     margin: 0;
                   5022:     padding: 0 0.5%;
                   5023:     height: 99%; /* to avoid scrollbars */
                   5024: }
                   5025: 
1.795     www      5026: body {
1.911     bisitz   5027:   font-family: $sans;
                   5028:   line-height:130%;
                   5029:   font-size:0.83em;
                   5030:   color:$font;
1.795     www      5031: }
                   5032: 
1.959     onken    5033: a:focus,
                   5034: a:focus img {
1.795     www      5035:   color: red;
1.911     bisitz   5036:   background: yellow;
1.795     www      5037: }
1.698     harmsja  5038: 
1.911     bisitz   5039: form, .inline {
                   5040:   display: inline;
1.795     www      5041: }
1.721     harmsja  5042: 
1.795     www      5043: .LC_right {
1.911     bisitz   5044:   text-align:right;
1.795     www      5045: }
                   5046: 
                   5047: .LC_middle {
1.911     bisitz   5048:   vertical-align:middle;
1.795     www      5049: }
1.721     harmsja  5050: 
1.911     bisitz   5051: .LC_400Box {
                   5052:   width:400px;
                   5053: }
1.721     harmsja  5054: 
1.947     droeschl 5055: .LC_iframecontainer {
                   5056:     width: 98%;
                   5057:     margin: 0;
                   5058:     position: fixed;
                   5059:     top: 8.5em;
                   5060:     bottom: 0;
                   5061: }
                   5062: 
                   5063: .LC_iframecontainer iframe{
                   5064:     border: none;
                   5065:     width: 100%;
                   5066:     height: 100%;
                   5067: }
                   5068: 
1.778     bisitz   5069: .LC_filename {
                   5070:   font-family: $mono;
                   5071:   white-space:pre;
1.921     bisitz   5072:   font-size: 120%;
1.778     bisitz   5073: }
                   5074: 
                   5075: .LC_fileicon {
                   5076:   border: none;
                   5077:   height: 1.3em;
                   5078:   vertical-align: text-bottom;
                   5079:   margin-right: 0.3em;
                   5080:   text-decoration:none;
                   5081: }
                   5082: 
1.1008    www      5083: .LC_setting {
                   5084:   text-decoration:underline;
                   5085: }
                   5086: 
1.350     albertel 5087: .LC_error {
                   5088:   color: red;
                   5089:   font-size: larger;
                   5090: }
1.795     www      5091: 
1.457     albertel 5092: .LC_warning,
                   5093: .LC_diff_removed {
1.733     bisitz   5094:   color: red;
1.394     albertel 5095: }
1.532     albertel 5096: 
                   5097: .LC_info,
1.457     albertel 5098: .LC_success,
                   5099: .LC_diff_added {
1.350     albertel 5100:   color: green;
                   5101: }
1.795     www      5102: 
1.802     bisitz   5103: div.LC_confirm_box {
                   5104:   background-color: #FAFAFA;
                   5105:   border: 1px solid $lg_border_color;
                   5106:   margin-right: 0;
                   5107:   padding: 5px;
                   5108: }
                   5109: 
                   5110: div.LC_confirm_box .LC_error img,
                   5111: div.LC_confirm_box .LC_success img {
                   5112:   vertical-align: middle;
                   5113: }
                   5114: 
1.440     albertel 5115: .LC_icon {
1.771     droeschl 5116:   border: none;
1.790     droeschl 5117:   vertical-align: middle;
1.771     droeschl 5118: }
                   5119: 
1.543     albertel 5120: .LC_docs_spacer {
                   5121:   width: 25px;
                   5122:   height: 1px;
1.771     droeschl 5123:   border: none;
1.543     albertel 5124: }
1.346     albertel 5125: 
1.532     albertel 5126: .LC_internal_info {
1.735     bisitz   5127:   color: #999999;
1.532     albertel 5128: }
                   5129: 
1.794     www      5130: .LC_discussion {
1.911     bisitz   5131:   background: $tabbg;
                   5132:   border: 1px solid black;
                   5133:   margin: 2px;
1.794     www      5134: }
                   5135: 
                   5136: .LC_disc_action_links_bar {
1.911     bisitz   5137:   background: $tabbg;
                   5138:   border: none;
                   5139:   margin: 4px;
1.794     www      5140: }
                   5141: 
                   5142: .LC_disc_action_left {
1.911     bisitz   5143:   text-align: left;
1.794     www      5144: }
                   5145: 
                   5146: .LC_disc_action_right {
1.911     bisitz   5147:   text-align: right;
1.794     www      5148: }
                   5149: 
                   5150: .LC_disc_new_item {
1.911     bisitz   5151:   background: white;
                   5152:   border: 2px solid red;
                   5153:   margin: 2px;
1.794     www      5154: }
                   5155: 
                   5156: .LC_disc_old_item {
1.911     bisitz   5157:   background: white;
                   5158:   border: 1px solid black;
                   5159:   margin: 2px;
1.794     www      5160: }
                   5161: 
1.458     albertel 5162: table.LC_pastsubmission {
                   5163:   border: 1px solid black;
                   5164:   margin: 2px;
                   5165: }
                   5166: 
1.924     bisitz   5167: table#LC_menubuttons {
1.345     albertel 5168:   width: 100%;
                   5169:   background: $pgbg;
1.392     albertel 5170:   border: 2px;
1.402     albertel 5171:   border-collapse: separate;
1.803     bisitz   5172:   padding: 0;
1.345     albertel 5173: }
1.392     albertel 5174: 
1.801     tempelho 5175: table#LC_title_bar a {
                   5176:   color: $fontmenu;
                   5177: }
1.836     bisitz   5178: 
1.807     droeschl 5179: table#LC_title_bar {
1.819     tempelho 5180:   clear: both;
1.836     bisitz   5181:   display: none;
1.807     droeschl 5182: }
                   5183: 
1.795     www      5184: table#LC_title_bar,
1.933     droeschl 5185: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 5186: table#LC_title_bar.LC_with_remote {
1.359     albertel 5187:   width: 100%;
1.392     albertel 5188:   border-color: $pgbg;
                   5189:   border-style: solid;
                   5190:   border-width: $border;
1.379     albertel 5191:   background: $pgbg;
1.801     tempelho 5192:   color: $fontmenu;
1.392     albertel 5193:   border-collapse: collapse;
1.803     bisitz   5194:   padding: 0;
1.819     tempelho 5195:   margin: 0;
1.359     albertel 5196: }
1.795     www      5197: 
1.933     droeschl 5198: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 5199:     margin: 0;
                   5200:     padding: 0;
1.933     droeschl 5201:     position: relative;
                   5202:     list-style: none;
1.913     droeschl 5203: }
1.933     droeschl 5204: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 5205:     display: inline;
                   5206: }
1.933     droeschl 5207: 
                   5208: .LC_breadcrumb_tools_navigation {
1.913     droeschl 5209:     padding: 0;
1.933     droeschl 5210:     margin: 0;
                   5211:     float: left;
1.913     droeschl 5212: }
1.933     droeschl 5213: .LC_breadcrumb_tools_tools {
                   5214:     padding: 0;
                   5215:     margin: 0;
1.913     droeschl 5216:     float: right;
                   5217: }
                   5218: 
1.359     albertel 5219: table#LC_title_bar td {
                   5220:   background: $tabbg;
                   5221: }
1.795     www      5222: 
1.911     bisitz   5223: table#LC_menubuttons img {
1.803     bisitz   5224:   border: none;
1.346     albertel 5225: }
1.795     www      5226: 
1.842     droeschl 5227: .LC_breadcrumbs_component {
1.911     bisitz   5228:   float: right;
                   5229:   margin: 0 1em;
1.357     albertel 5230: }
1.842     droeschl 5231: .LC_breadcrumbs_component img {
1.911     bisitz   5232:   vertical-align: middle;
1.777     tempelho 5233: }
1.795     www      5234: 
1.383     albertel 5235: td.LC_table_cell_checkbox {
                   5236:   text-align: center;
                   5237: }
1.795     www      5238: 
                   5239: .LC_fontsize_small {
1.911     bisitz   5240:   font-size: 70%;
1.705     tempelho 5241: }
                   5242: 
1.844     bisitz   5243: #LC_breadcrumbs {
1.911     bisitz   5244:   clear:both;
                   5245:   background: $sidebg;
                   5246:   border-bottom: 1px solid $lg_border_color;
                   5247:   line-height: 2.5em;
1.933     droeschl 5248:   overflow: hidden;
1.911     bisitz   5249:   margin: 0;
                   5250:   padding: 0;
1.995     raeburn  5251:   text-align: left;
1.819     tempelho 5252: }
1.862     bisitz   5253: 
1.993     raeburn  5254: .LC_head_subbox {
1.911     bisitz   5255:   clear:both;
                   5256:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 5257:   border: 1px solid $sidebg;
                   5258:   margin: 0 0 10px 0;      
1.966     bisitz   5259:   padding: 3px;
1.995     raeburn  5260:   text-align: left;
1.822     bisitz   5261: }
                   5262: 
1.795     www      5263: .LC_fontsize_medium {
1.911     bisitz   5264:   font-size: 85%;
1.705     tempelho 5265: }
                   5266: 
1.795     www      5267: .LC_fontsize_large {
1.911     bisitz   5268:   font-size: 120%;
1.705     tempelho 5269: }
                   5270: 
1.346     albertel 5271: .LC_menubuttons_inline_text {
                   5272:   color: $font;
1.698     harmsja  5273:   font-size: 90%;
1.701     harmsja  5274:   padding-left:3px;
1.346     albertel 5275: }
                   5276: 
1.934     droeschl 5277: .LC_menubuttons_inline_text img{
                   5278:   vertical-align: middle;
                   5279: }
                   5280: 
1.951     onken    5281: li.LC_menubuttons_inline_text img,a {
                   5282:   cursor:pointer;
1.1002    droeschl 5283:   text-decoration: none;
1.951     onken    5284: }
                   5285: 
1.526     www      5286: .LC_menubuttons_link {
                   5287:   text-decoration: none;
                   5288: }
1.795     www      5289: 
1.522     albertel 5290: .LC_menubuttons_category {
1.521     www      5291:   color: $font;
1.526     www      5292:   background: $pgbg;
1.521     www      5293:   font-size: larger;
                   5294:   font-weight: bold;
                   5295: }
                   5296: 
1.346     albertel 5297: td.LC_menubuttons_text {
1.911     bisitz   5298:   color: $font;
1.346     albertel 5299: }
1.706     harmsja  5300: 
1.346     albertel 5301: .LC_current_location {
                   5302:   background: $tabbg;
                   5303: }
1.795     www      5304: 
1.938     bisitz   5305: table.LC_data_table {
1.347     albertel 5306:   border: 1px solid #000000;
1.402     albertel 5307:   border-collapse: separate;
1.426     albertel 5308:   border-spacing: 1px;
1.610     albertel 5309:   background: $pgbg;
1.347     albertel 5310: }
1.795     www      5311: 
1.422     albertel 5312: .LC_data_table_dense {
                   5313:   font-size: small;
                   5314: }
1.795     www      5315: 
1.507     raeburn  5316: table.LC_nested_outer {
                   5317:   border: 1px solid #000000;
1.589     raeburn  5318:   border-collapse: collapse;
1.803     bisitz   5319:   border-spacing: 0;
1.507     raeburn  5320:   width: 100%;
                   5321: }
1.795     www      5322: 
1.879     raeburn  5323: table.LC_innerpickbox,
1.507     raeburn  5324: table.LC_nested {
1.803     bisitz   5325:   border: none;
1.589     raeburn  5326:   border-collapse: collapse;
1.803     bisitz   5327:   border-spacing: 0;
1.507     raeburn  5328:   width: 100%;
                   5329: }
1.795     www      5330: 
1.911     bisitz   5331: table.LC_data_table tr th,
                   5332: table.LC_calendar tr th,
1.879     raeburn  5333: table.LC_prior_tries tr th,
                   5334: table.LC_innerpickbox tr th {
1.349     albertel 5335:   font-weight: bold;
                   5336:   background-color: $data_table_head;
1.801     tempelho 5337:   color:$fontmenu;
1.701     harmsja  5338:   font-size:90%;
1.347     albertel 5339: }
1.795     www      5340: 
1.879     raeburn  5341: table.LC_innerpickbox tr th,
                   5342: table.LC_innerpickbox tr td {
                   5343:   vertical-align: top;
                   5344: }
                   5345: 
1.711     raeburn  5346: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   5347:   background-color: #CCCCCC;
1.711     raeburn  5348:   font-weight: bold;
                   5349:   text-align: left;
                   5350: }
1.795     www      5351: 
1.912     bisitz   5352: table.LC_data_table tr.LC_odd_row > td {
                   5353:   background-color: $data_table_light;
                   5354:   padding: 2px;
                   5355:   vertical-align: top;
                   5356: }
                   5357: 
1.809     bisitz   5358: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 5359:   background-color: $data_table_light;
1.912     bisitz   5360:   vertical-align: top;
                   5361: }
                   5362: 
                   5363: table.LC_data_table tr.LC_even_row > td {
                   5364:   background-color: $data_table_dark;
1.425     albertel 5365:   padding: 2px;
1.900     bisitz   5366:   vertical-align: top;
1.347     albertel 5367: }
1.795     www      5368: 
1.809     bisitz   5369: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5370:   background-color: $data_table_dark;
1.900     bisitz   5371:   vertical-align: top;
1.347     albertel 5372: }
1.795     www      5373: 
1.425     albertel 5374: table.LC_data_table tr.LC_data_table_highlight td {
                   5375:   background-color: $data_table_darker;
                   5376: }
1.795     www      5377: 
1.639     raeburn  5378: table.LC_data_table tr td.LC_leftcol_header {
                   5379:   background-color: $data_table_head;
                   5380:   font-weight: bold;
                   5381: }
1.795     www      5382: 
1.451     albertel 5383: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5384: table.LC_nested tr.LC_empty_row td {
1.421     albertel 5385:   font-weight: bold;
                   5386:   font-style: italic;
                   5387:   text-align: center;
                   5388:   padding: 8px;
1.347     albertel 5389: }
1.795     www      5390: 
1.940     bisitz   5391: table.LC_data_table tr.LC_empty_row td {
                   5392:   background-color: $sidebg;
                   5393: }
                   5394: 
                   5395: table.LC_nested tr.LC_empty_row td {
                   5396:   background-color: #FFFFFF;
                   5397: }
                   5398: 
1.890     droeschl 5399: table.LC_caption {
                   5400: }
                   5401: 
1.507     raeburn  5402: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5403:   padding: 4ex
                   5404: }
1.795     www      5405: 
1.507     raeburn  5406: table.LC_nested_outer tr th {
                   5407:   font-weight: bold;
1.801     tempelho 5408:   color:$fontmenu;
1.507     raeburn  5409:   background-color: $data_table_head;
1.701     harmsja  5410:   font-size: small;
1.507     raeburn  5411:   border-bottom: 1px solid #000000;
                   5412: }
1.795     www      5413: 
1.507     raeburn  5414: table.LC_nested_outer tr td.LC_subheader {
                   5415:   background-color: $data_table_head;
                   5416:   font-weight: bold;
                   5417:   font-size: small;
                   5418:   border-bottom: 1px solid #000000;
                   5419:   text-align: right;
1.451     albertel 5420: }
1.795     www      5421: 
1.507     raeburn  5422: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5423:   background-color: #CCCCCC;
1.451     albertel 5424:   font-weight: bold;
                   5425:   font-size: small;
1.507     raeburn  5426:   text-align: center;
                   5427: }
1.795     www      5428: 
1.589     raeburn  5429: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5430: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5431:   text-align: left;
1.451     albertel 5432: }
1.795     www      5433: 
1.507     raeburn  5434: table.LC_nested td {
1.735     bisitz   5435:   background-color: #FFFFFF;
1.451     albertel 5436:   font-size: small;
1.507     raeburn  5437: }
1.795     www      5438: 
1.507     raeburn  5439: table.LC_nested_outer tr th.LC_right_item,
                   5440: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5441: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5442: table.LC_nested tr td.LC_right_item {
1.451     albertel 5443:   text-align: right;
                   5444: }
                   5445: 
1.507     raeburn  5446: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5447:   background-color: #EEEEEE;
1.451     albertel 5448: }
                   5449: 
1.473     raeburn  5450: table.LC_createuser {
                   5451: }
                   5452: 
                   5453: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5454:   font-size: small;
1.473     raeburn  5455: }
                   5456: 
                   5457: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5458:   background-color: #CCCCCC;
1.473     raeburn  5459:   font-weight: bold;
                   5460:   text-align: center;
                   5461: }
                   5462: 
1.349     albertel 5463: table.LC_calendar {
                   5464:   border: 1px solid #000000;
                   5465:   border-collapse: collapse;
1.917     raeburn  5466:   width: 98%;
1.349     albertel 5467: }
1.795     www      5468: 
1.349     albertel 5469: table.LC_calendar_pickdate {
                   5470:   font-size: xx-small;
                   5471: }
1.795     www      5472: 
1.349     albertel 5473: table.LC_calendar tr td {
                   5474:   border: 1px solid #000000;
                   5475:   vertical-align: top;
1.917     raeburn  5476:   width: 14%;
1.349     albertel 5477: }
1.795     www      5478: 
1.349     albertel 5479: table.LC_calendar tr td.LC_calendar_day_empty {
                   5480:   background-color: $data_table_dark;
                   5481: }
1.795     www      5482: 
1.779     bisitz   5483: table.LC_calendar tr td.LC_calendar_day_current {
                   5484:   background-color: $data_table_highlight;
1.777     tempelho 5485: }
1.795     www      5486: 
1.938     bisitz   5487: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 5488:   background-color: $mail_new;
                   5489: }
1.795     www      5490: 
1.938     bisitz   5491: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 5492:   background-color: $mail_new_hover;
                   5493: }
1.795     www      5494: 
1.938     bisitz   5495: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 5496:   background-color: $mail_read;
                   5497: }
1.795     www      5498: 
1.938     bisitz   5499: /*
                   5500: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 5501:   background-color: $mail_read_hover;
                   5502: }
1.938     bisitz   5503: */
1.795     www      5504: 
1.938     bisitz   5505: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 5506:   background-color: $mail_replied;
                   5507: }
1.795     www      5508: 
1.938     bisitz   5509: /*
                   5510: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 5511:   background-color: $mail_replied_hover;
                   5512: }
1.938     bisitz   5513: */
1.795     www      5514: 
1.938     bisitz   5515: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 5516:   background-color: $mail_other;
                   5517: }
1.795     www      5518: 
1.938     bisitz   5519: /*
                   5520: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 5521:   background-color: $mail_other_hover;
                   5522: }
1.938     bisitz   5523: */
1.494     raeburn  5524: 
1.777     tempelho 5525: table.LC_data_table tr > td.LC_browser_file,
                   5526: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5527:   background: #AAEE77;
1.389     albertel 5528: }
1.795     www      5529: 
1.777     tempelho 5530: table.LC_data_table tr > td.LC_browser_file_locked,
                   5531: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5532:   background: #FFAA99;
1.387     albertel 5533: }
1.795     www      5534: 
1.777     tempelho 5535: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5536:   background: #888888;
1.779     bisitz   5537: }
1.795     www      5538: 
1.777     tempelho 5539: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5540: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5541:   background: #F8F866;
1.777     tempelho 5542: }
1.795     www      5543: 
1.696     bisitz   5544: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5545:   background: #E0E8FF;
1.387     albertel 5546: }
1.696     bisitz   5547: 
1.707     bisitz   5548: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   5549:   /* background: #77FF77; */
1.707     bisitz   5550: }
1.795     www      5551: 
1.707     bisitz   5552: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   5553:   border-right: 8px solid #FFFF77;
1.707     bisitz   5554: }
1.795     www      5555: 
1.707     bisitz   5556: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   5557:   border-right: 8px solid #FFAA77;
1.707     bisitz   5558: }
1.795     www      5559: 
1.707     bisitz   5560: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   5561:   border-right: 8px solid #FF7777;
1.707     bisitz   5562: }
1.795     www      5563: 
1.707     bisitz   5564: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   5565:   border-right: 8px solid #AAFF77;
1.707     bisitz   5566: }
1.795     www      5567: 
1.707     bisitz   5568: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   5569:   border-right: 8px solid #11CC55;
1.707     bisitz   5570: }
                   5571: 
1.388     albertel 5572: span.LC_current_location {
1.701     harmsja  5573:   font-size:larger;
1.388     albertel 5574:   background: $pgbg;
                   5575: }
1.387     albertel 5576: 
1.1029    www      5577: span.LC_current_nav_location {
                   5578:   font-weight:bold;
                   5579:   background: $sidebg;
                   5580: }
                   5581: 
1.395     albertel 5582: span.LC_parm_menu_item {
                   5583:   font-size: larger;
                   5584: }
1.795     www      5585: 
1.395     albertel 5586: span.LC_parm_scope_all {
                   5587:   color: red;
                   5588: }
1.795     www      5589: 
1.395     albertel 5590: span.LC_parm_scope_folder {
                   5591:   color: green;
                   5592: }
1.795     www      5593: 
1.395     albertel 5594: span.LC_parm_scope_resource {
                   5595:   color: orange;
                   5596: }
1.795     www      5597: 
1.395     albertel 5598: span.LC_parm_part {
                   5599:   color: blue;
                   5600: }
1.795     www      5601: 
1.911     bisitz   5602: span.LC_parm_folder,
                   5603: span.LC_parm_symb {
1.395     albertel 5604:   font-size: x-small;
                   5605:   font-family: $mono;
                   5606:   color: #AAAAAA;
                   5607: }
                   5608: 
1.977     bisitz   5609: ul.LC_parm_parmlist li {
                   5610:   display: inline-block;
                   5611:   padding: 0.3em 0.8em;
                   5612:   vertical-align: top;
                   5613:   width: 150px;
                   5614:   border-top:1px solid $lg_border_color;
                   5615: }
                   5616: 
1.795     www      5617: td.LC_parm_overview_level_menu,
                   5618: td.LC_parm_overview_map_menu,
                   5619: td.LC_parm_overview_parm_selectors,
                   5620: td.LC_parm_overview_restrictions  {
1.396     albertel 5621:   border: 1px solid black;
                   5622:   border-collapse: collapse;
                   5623: }
1.795     www      5624: 
1.396     albertel 5625: table.LC_parm_overview_restrictions td {
                   5626:   border-width: 1px 4px 1px 4px;
                   5627:   border-style: solid;
                   5628:   border-color: $pgbg;
                   5629:   text-align: center;
                   5630: }
1.795     www      5631: 
1.396     albertel 5632: table.LC_parm_overview_restrictions th {
                   5633:   background: $tabbg;
                   5634:   border-width: 1px 4px 1px 4px;
                   5635:   border-style: solid;
                   5636:   border-color: $pgbg;
                   5637: }
1.795     www      5638: 
1.398     albertel 5639: table#LC_helpmenu {
1.803     bisitz   5640:   border: none;
1.398     albertel 5641:   height: 55px;
1.803     bisitz   5642:   border-spacing: 0;
1.398     albertel 5643: }
                   5644: 
                   5645: table#LC_helpmenu fieldset legend {
                   5646:   font-size: larger;
                   5647: }
1.795     www      5648: 
1.397     albertel 5649: table#LC_helpmenu_links {
                   5650:   width: 100%;
                   5651:   border: 1px solid black;
                   5652:   background: $pgbg;
1.803     bisitz   5653:   padding: 0;
1.397     albertel 5654:   border-spacing: 1px;
                   5655: }
1.795     www      5656: 
1.397     albertel 5657: table#LC_helpmenu_links tr td {
                   5658:   padding: 1px;
                   5659:   background: $tabbg;
1.399     albertel 5660:   text-align: center;
                   5661:   font-weight: bold;
1.397     albertel 5662: }
1.396     albertel 5663: 
1.795     www      5664: table#LC_helpmenu_links a:link,
                   5665: table#LC_helpmenu_links a:visited,
1.397     albertel 5666: table#LC_helpmenu_links a:active {
                   5667:   text-decoration: none;
                   5668:   color: $font;
                   5669: }
1.795     www      5670: 
1.397     albertel 5671: table#LC_helpmenu_links a:hover {
                   5672:   text-decoration: underline;
                   5673:   color: $vlink;
                   5674: }
1.396     albertel 5675: 
1.417     albertel 5676: .LC_chrt_popup_exists {
                   5677:   border: 1px solid #339933;
                   5678:   margin: -1px;
                   5679: }
1.795     www      5680: 
1.417     albertel 5681: .LC_chrt_popup_up {
                   5682:   border: 1px solid yellow;
                   5683:   margin: -1px;
                   5684: }
1.795     www      5685: 
1.417     albertel 5686: .LC_chrt_popup {
                   5687:   border: 1px solid #8888FF;
                   5688:   background: #CCCCFF;
                   5689: }
1.795     www      5690: 
1.421     albertel 5691: table.LC_pick_box {
                   5692:   border-collapse: separate;
                   5693:   background: white;
                   5694:   border: 1px solid black;
                   5695:   border-spacing: 1px;
                   5696: }
1.795     www      5697: 
1.421     albertel 5698: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5699:   background: $sidebg;
1.421     albertel 5700:   font-weight: bold;
1.900     bisitz   5701:   text-align: left;
1.740     bisitz   5702:   vertical-align: top;
1.421     albertel 5703:   width: 184px;
                   5704:   padding: 8px;
                   5705: }
1.795     www      5706: 
1.579     raeburn  5707: table.LC_pick_box td.LC_pick_box_value {
                   5708:   text-align: left;
                   5709:   padding: 8px;
                   5710: }
1.795     www      5711: 
1.579     raeburn  5712: table.LC_pick_box td.LC_pick_box_select {
                   5713:   text-align: left;
                   5714:   padding: 8px;
                   5715: }
1.795     www      5716: 
1.424     albertel 5717: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5718:   padding: 0;
1.421     albertel 5719:   height: 1px;
                   5720:   background: black;
                   5721: }
1.795     www      5722: 
1.421     albertel 5723: table.LC_pick_box td.LC_pick_box_submit {
                   5724:   text-align: right;
                   5725: }
1.795     www      5726: 
1.579     raeburn  5727: table.LC_pick_box td.LC_evenrow_value {
                   5728:   text-align: left;
                   5729:   padding: 8px;
                   5730:   background-color: $data_table_light;
                   5731: }
1.795     www      5732: 
1.579     raeburn  5733: table.LC_pick_box td.LC_oddrow_value {
                   5734:   text-align: left;
                   5735:   padding: 8px;
                   5736:   background-color: $data_table_light;
                   5737: }
1.795     www      5738: 
1.579     raeburn  5739: span.LC_helpform_receipt_cat {
                   5740:   font-weight: bold;
                   5741: }
1.795     www      5742: 
1.424     albertel 5743: table.LC_group_priv_box {
                   5744:   background: white;
                   5745:   border: 1px solid black;
                   5746:   border-spacing: 1px;
                   5747: }
1.795     www      5748: 
1.424     albertel 5749: table.LC_group_priv_box td.LC_pick_box_title {
                   5750:   background: $tabbg;
                   5751:   font-weight: bold;
                   5752:   text-align: right;
                   5753:   width: 184px;
                   5754: }
1.795     www      5755: 
1.424     albertel 5756: table.LC_group_priv_box td.LC_groups_fixed {
                   5757:   background: $data_table_light;
                   5758:   text-align: center;
                   5759: }
1.795     www      5760: 
1.424     albertel 5761: table.LC_group_priv_box td.LC_groups_optional {
                   5762:   background: $data_table_dark;
                   5763:   text-align: center;
                   5764: }
1.795     www      5765: 
1.424     albertel 5766: table.LC_group_priv_box td.LC_groups_functionality {
                   5767:   background: $data_table_darker;
                   5768:   text-align: center;
                   5769:   font-weight: bold;
                   5770: }
1.795     www      5771: 
1.424     albertel 5772: table.LC_group_priv td {
                   5773:   text-align: left;
1.803     bisitz   5774:   padding: 0;
1.424     albertel 5775: }
                   5776: 
                   5777: .LC_navbuttons {
                   5778:   margin: 2ex 0ex 2ex 0ex;
                   5779: }
1.795     www      5780: 
1.423     albertel 5781: .LC_topic_bar {
                   5782:   font-weight: bold;
                   5783:   background: $tabbg;
1.918     wenzelju 5784:   margin: 1em 0em 1em 2em;
1.805     bisitz   5785:   padding: 3px;
1.918     wenzelju 5786:   font-size: 1.2em;
1.423     albertel 5787: }
1.795     www      5788: 
1.423     albertel 5789: .LC_topic_bar span {
1.918     wenzelju 5790:   left: 0.5em;
                   5791:   position: absolute;
1.423     albertel 5792:   vertical-align: middle;
1.918     wenzelju 5793:   font-size: 1.2em;
1.423     albertel 5794: }
1.795     www      5795: 
1.423     albertel 5796: table.LC_course_group_status {
                   5797:   margin: 20px;
                   5798: }
1.795     www      5799: 
1.423     albertel 5800: table.LC_status_selector td {
                   5801:   vertical-align: top;
                   5802:   text-align: center;
1.424     albertel 5803:   padding: 4px;
                   5804: }
1.795     www      5805: 
1.599     albertel 5806: div.LC_feedback_link {
1.616     albertel 5807:   clear: both;
1.829     kalberla 5808:   background: $sidebg;
1.779     bisitz   5809:   width: 100%;
1.829     kalberla 5810:   padding-bottom: 10px;
                   5811:   border: 1px $tabbg solid;
1.833     kalberla 5812:   height: 22px;
                   5813:   line-height: 22px;
                   5814:   padding-top: 5px;
                   5815: }
                   5816: 
                   5817: div.LC_feedback_link img {
                   5818:   height: 22px;
1.867     kalberla 5819:   vertical-align:middle;
1.829     kalberla 5820: }
                   5821: 
1.911     bisitz   5822: div.LC_feedback_link a {
1.829     kalberla 5823:   text-decoration: none;
1.489     raeburn  5824: }
1.795     www      5825: 
1.867     kalberla 5826: div.LC_comblock {
1.911     bisitz   5827:   display:inline;
1.867     kalberla 5828:   color:$font;
                   5829:   font-size:90%;
                   5830: }
                   5831: 
                   5832: div.LC_feedback_link div.LC_comblock {
                   5833:   padding-left:5px;
                   5834: }
                   5835: 
                   5836: div.LC_feedback_link div.LC_comblock a {
                   5837:   color:$font;
                   5838: }
                   5839: 
1.489     raeburn  5840: span.LC_feedback_link {
1.858     bisitz   5841:   /* background: $feedback_link_bg; */
1.599     albertel 5842:   font-size: larger;
                   5843: }
1.795     www      5844: 
1.599     albertel 5845: span.LC_message_link {
1.858     bisitz   5846:   /* background: $feedback_link_bg; */
1.599     albertel 5847:   font-size: larger;
                   5848:   position: absolute;
                   5849:   right: 1em;
1.489     raeburn  5850: }
1.421     albertel 5851: 
1.515     albertel 5852: table.LC_prior_tries {
1.524     albertel 5853:   border: 1px solid #000000;
                   5854:   border-collapse: separate;
                   5855:   border-spacing: 1px;
1.515     albertel 5856: }
1.523     albertel 5857: 
1.515     albertel 5858: table.LC_prior_tries td {
1.524     albertel 5859:   padding: 2px;
1.515     albertel 5860: }
1.523     albertel 5861: 
                   5862: .LC_answer_correct {
1.795     www      5863:   background: lightgreen;
                   5864:   color: darkgreen;
                   5865:   padding: 6px;
1.523     albertel 5866: }
1.795     www      5867: 
1.523     albertel 5868: .LC_answer_charged_try {
1.797     www      5869:   background: #FFAAAA;
1.795     www      5870:   color: darkred;
                   5871:   padding: 6px;
1.523     albertel 5872: }
1.795     www      5873: 
1.779     bisitz   5874: .LC_answer_not_charged_try,
1.523     albertel 5875: .LC_answer_no_grade,
                   5876: .LC_answer_late {
1.795     www      5877:   background: lightyellow;
1.523     albertel 5878:   color: black;
1.795     www      5879:   padding: 6px;
1.523     albertel 5880: }
1.795     www      5881: 
1.523     albertel 5882: .LC_answer_previous {
1.795     www      5883:   background: lightblue;
                   5884:   color: darkblue;
                   5885:   padding: 6px;
1.523     albertel 5886: }
1.795     www      5887: 
1.779     bisitz   5888: .LC_answer_no_message {
1.777     tempelho 5889:   background: #FFFFFF;
                   5890:   color: black;
1.795     www      5891:   padding: 6px;
1.779     bisitz   5892: }
1.795     www      5893: 
1.779     bisitz   5894: .LC_answer_unknown {
                   5895:   background: orange;
                   5896:   color: black;
1.795     www      5897:   padding: 6px;
1.777     tempelho 5898: }
1.795     www      5899: 
1.529     albertel 5900: span.LC_prior_numerical,
                   5901: span.LC_prior_string,
                   5902: span.LC_prior_custom,
                   5903: span.LC_prior_reaction,
                   5904: span.LC_prior_math {
1.925     bisitz   5905:   font-family: $mono;
1.523     albertel 5906:   white-space: pre;
                   5907: }
                   5908: 
1.525     albertel 5909: span.LC_prior_string {
1.925     bisitz   5910:   font-family: $mono;
1.525     albertel 5911:   white-space: pre;
                   5912: }
                   5913: 
1.523     albertel 5914: table.LC_prior_option {
                   5915:   width: 100%;
                   5916:   border-collapse: collapse;
                   5917: }
1.795     www      5918: 
1.911     bisitz   5919: table.LC_prior_rank,
1.795     www      5920: table.LC_prior_match {
1.528     albertel 5921:   border-collapse: collapse;
                   5922: }
1.795     www      5923: 
1.528     albertel 5924: table.LC_prior_option tr td,
                   5925: table.LC_prior_rank tr td,
                   5926: table.LC_prior_match tr td {
1.524     albertel 5927:   border: 1px solid #000000;
1.515     albertel 5928: }
                   5929: 
1.855     bisitz   5930: .LC_nobreak {
1.544     albertel 5931:   white-space: nowrap;
1.519     raeburn  5932: }
                   5933: 
1.576     raeburn  5934: span.LC_cusr_emph {
                   5935:   font-style: italic;
                   5936: }
                   5937: 
1.633     raeburn  5938: span.LC_cusr_subheading {
                   5939:   font-weight: normal;
                   5940:   font-size: 85%;
                   5941: }
                   5942: 
1.861     bisitz   5943: div.LC_docs_entry_move {
1.859     bisitz   5944:   border: 1px solid #BBBBBB;
1.545     albertel 5945:   background: #DDDDDD;
1.861     bisitz   5946:   width: 22px;
1.859     bisitz   5947:   padding: 1px;
                   5948:   margin: 0;
1.545     albertel 5949: }
                   5950: 
1.861     bisitz   5951: table.LC_data_table tr > td.LC_docs_entry_commands,
                   5952: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 5953:   background: #DDDDDD;
                   5954:   font-size: x-small;
                   5955: }
1.795     www      5956: 
1.861     bisitz   5957: .LC_docs_entry_parameter {
                   5958:   white-space: nowrap;
                   5959: }
                   5960: 
1.544     albertel 5961: .LC_docs_copy {
1.545     albertel 5962:   color: #000099;
1.544     albertel 5963: }
1.795     www      5964: 
1.544     albertel 5965: .LC_docs_cut {
1.545     albertel 5966:   color: #550044;
1.544     albertel 5967: }
1.795     www      5968: 
1.544     albertel 5969: .LC_docs_rename {
1.545     albertel 5970:   color: #009900;
1.544     albertel 5971: }
1.795     www      5972: 
1.544     albertel 5973: .LC_docs_remove {
1.545     albertel 5974:   color: #990000;
                   5975: }
                   5976: 
1.547     albertel 5977: .LC_docs_reinit_warn,
                   5978: .LC_docs_ext_edit {
                   5979:   font-size: x-small;
                   5980: }
                   5981: 
1.545     albertel 5982: table.LC_docs_adddocs td,
                   5983: table.LC_docs_adddocs th {
                   5984:   border: 1px solid #BBBBBB;
                   5985:   padding: 4px;
                   5986:   background: #DDDDDD;
1.543     albertel 5987: }
                   5988: 
1.584     albertel 5989: table.LC_sty_begin {
                   5990:   background: #BBFFBB;
                   5991: }
1.795     www      5992: 
1.584     albertel 5993: table.LC_sty_end {
                   5994:   background: #FFBBBB;
                   5995: }
                   5996: 
1.589     raeburn  5997: table.LC_double_column {
1.803     bisitz   5998:   border-width: 0;
1.589     raeburn  5999:   border-collapse: collapse;
                   6000:   width: 100%;
                   6001:   padding: 2px;
                   6002: }
                   6003: 
                   6004: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  6005:   top: 2px;
1.589     raeburn  6006:   left: 2px;
                   6007:   width: 47%;
                   6008:   vertical-align: top;
                   6009: }
                   6010: 
                   6011: table.LC_double_column tr td.LC_right_col {
                   6012:   top: 2px;
1.779     bisitz   6013:   right: 2px;
1.589     raeburn  6014:   width: 47%;
                   6015:   vertical-align: top;
                   6016: }
                   6017: 
1.591     raeburn  6018: div.LC_left_float {
                   6019:   float: left;
                   6020:   padding-right: 5%;
1.597     albertel 6021:   padding-bottom: 4px;
1.591     raeburn  6022: }
                   6023: 
                   6024: div.LC_clear_float_header {
1.597     albertel 6025:   padding-bottom: 2px;
1.591     raeburn  6026: }
                   6027: 
                   6028: div.LC_clear_float_footer {
1.597     albertel 6029:   padding-top: 10px;
1.591     raeburn  6030:   clear: both;
                   6031: }
                   6032: 
1.597     albertel 6033: div.LC_grade_show_user {
1.941     bisitz   6034: /*  border-left: 5px solid $sidebg; */
                   6035:   border-top: 5px solid #000000;
                   6036:   margin: 50px 0 0 0;
1.936     bisitz   6037:   padding: 15px 0 5px 10px;
1.597     albertel 6038: }
1.795     www      6039: 
1.936     bisitz   6040: div.LC_grade_show_user_odd_row {
1.941     bisitz   6041: /*  border-left: 5px solid #000000; */
                   6042: }
                   6043: 
                   6044: div.LC_grade_show_user div.LC_Box {
                   6045:   margin-right: 50px;
1.597     albertel 6046: }
                   6047: 
                   6048: div.LC_grade_submissions,
                   6049: div.LC_grade_message_center,
1.936     bisitz   6050: div.LC_grade_info_links {
1.597     albertel 6051:   margin: 5px;
                   6052:   width: 99%;
                   6053:   background: #FFFFFF;
                   6054: }
1.795     www      6055: 
1.597     albertel 6056: div.LC_grade_submissions_header,
1.936     bisitz   6057: div.LC_grade_message_center_header {
1.705     tempelho 6058:   font-weight: bold;
                   6059:   font-size: large;
1.597     albertel 6060: }
1.795     www      6061: 
1.597     albertel 6062: div.LC_grade_submissions_body,
1.936     bisitz   6063: div.LC_grade_message_center_body {
1.597     albertel 6064:   border: 1px solid black;
                   6065:   width: 99%;
                   6066:   background: #FFFFFF;
                   6067: }
1.795     www      6068: 
1.613     albertel 6069: table.LC_scantron_action {
                   6070:   width: 100%;
                   6071: }
1.795     www      6072: 
1.613     albertel 6073: table.LC_scantron_action tr th {
1.698     harmsja  6074:   font-weight:bold;
                   6075:   font-style:normal;
1.613     albertel 6076: }
1.795     www      6077: 
1.779     bisitz   6078: .LC_edit_problem_header,
1.614     albertel 6079: div.LC_edit_problem_footer {
1.705     tempelho 6080:   font-weight: normal;
                   6081:   font-size:  medium;
1.602     albertel 6082:   margin: 2px;
1.600     albertel 6083: }
1.795     www      6084: 
1.600     albertel 6085: div.LC_edit_problem_header,
1.602     albertel 6086: div.LC_edit_problem_header div,
1.614     albertel 6087: div.LC_edit_problem_footer,
                   6088: div.LC_edit_problem_footer div,
1.602     albertel 6089: div.LC_edit_problem_editxml_header,
                   6090: div.LC_edit_problem_editxml_header div {
1.600     albertel 6091:   margin-top: 5px;
                   6092: }
1.795     www      6093: 
1.600     albertel 6094: div.LC_edit_problem_header_title {
1.705     tempelho 6095:   font-weight: bold;
                   6096:   font-size: larger;
1.602     albertel 6097:   background: $tabbg;
                   6098:   padding: 3px;
                   6099: }
1.795     www      6100: 
1.602     albertel 6101: table.LC_edit_problem_header_title {
                   6102:   width: 100%;
1.600     albertel 6103:   background: $tabbg;
1.602     albertel 6104: }
                   6105: 
                   6106: div.LC_edit_problem_discards {
                   6107:   float: left;
                   6108:   padding-bottom: 5px;
                   6109: }
1.795     www      6110: 
1.602     albertel 6111: div.LC_edit_problem_saves {
                   6112:   float: right;
                   6113:   padding-bottom: 5px;
1.600     albertel 6114: }
1.795     www      6115: 
1.911     bisitz   6116: img.stift {
1.803     bisitz   6117:   border-width: 0;
                   6118:   vertical-align: middle;
1.677     riegler  6119: }
1.680     riegler  6120: 
1.923     bisitz   6121: table td.LC_mainmenu_col_fieldset {
1.680     riegler  6122:   vertical-align: top;
1.777     tempelho 6123: }
1.795     www      6124: 
1.716     raeburn  6125: div.LC_createcourse {
1.911     bisitz   6126:   margin: 10px 10px 10px 10px;
1.716     raeburn  6127: }
                   6128: 
1.917     raeburn  6129: .LC_dccid {
                   6130:   margin: 0.2em 0 0 0;
                   6131:   padding: 0;
                   6132:   font-size: 90%;
                   6133:   display:none;
                   6134: }
                   6135: 
1.698     harmsja  6136: a:hover,
1.897     wenzelju 6137: ol.LC_primary_menu a:hover,
1.721     harmsja  6138: ol#LC_MenuBreadcrumbs a:hover,
                   6139: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 6140: ul#LC_secondary_menu a:hover,
1.721     harmsja  6141: .LC_FormSectionClearButton input:hover
1.795     www      6142: ul.LC_TabContent   li:hover a {
1.952     onken    6143:   color:$button_hover;
1.911     bisitz   6144:   text-decoration:none;
1.693     droeschl 6145: }
                   6146: 
1.779     bisitz   6147: h1 {
1.911     bisitz   6148:   padding: 0;
                   6149:   line-height:130%;
1.693     droeschl 6150: }
1.698     harmsja  6151: 
1.911     bisitz   6152: h2,
                   6153: h3,
                   6154: h4,
                   6155: h5,
                   6156: h6 {
                   6157:   margin: 5px 0 5px 0;
                   6158:   padding: 0;
                   6159:   line-height:130%;
1.693     droeschl 6160: }
1.795     www      6161: 
                   6162: .LC_hcell {
1.911     bisitz   6163:   padding:3px 15px 3px 15px;
                   6164:   margin: 0;
                   6165:   background-color:$tabbg;
                   6166:   color:$fontmenu;
                   6167:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 6168: }
1.795     www      6169: 
1.840     bisitz   6170: .LC_Box > .LC_hcell {
1.911     bisitz   6171:   margin: 0 -10px 10px -10px;
1.835     bisitz   6172: }
                   6173: 
1.721     harmsja  6174: .LC_noBorder {
1.911     bisitz   6175:   border: 0;
1.698     harmsja  6176: }
1.693     droeschl 6177: 
1.721     harmsja  6178: .LC_FormSectionClearButton input {
1.911     bisitz   6179:   background-color:transparent;
                   6180:   border: none;
                   6181:   cursor:pointer;
                   6182:   text-decoration:underline;
1.693     droeschl 6183: }
1.763     bisitz   6184: 
                   6185: .LC_help_open_topic {
1.911     bisitz   6186:   color: #FFFFFF;
                   6187:   background-color: #EEEEFF;
                   6188:   margin: 1px;
                   6189:   padding: 4px;
                   6190:   border: 1px solid #000033;
                   6191:   white-space: nowrap;
                   6192:   /* vertical-align: middle; */
1.759     neumanie 6193: }
1.693     droeschl 6194: 
1.911     bisitz   6195: dl,
                   6196: ul,
                   6197: div,
                   6198: fieldset {
                   6199:   margin: 10px 10px 10px 0;
                   6200:   /* overflow: hidden; */
1.693     droeschl 6201: }
1.795     www      6202: 
1.838     bisitz   6203: fieldset > legend {
1.911     bisitz   6204:   font-weight: bold;
                   6205:   padding: 0 5px 0 5px;
1.838     bisitz   6206: }
                   6207: 
1.813     bisitz   6208: #LC_nav_bar {
1.911     bisitz   6209:   float: left;
1.995     raeburn  6210:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   6211:   margin: 0 0 2px 0;
1.807     droeschl 6212: }
                   6213: 
1.916     droeschl 6214: #LC_realm {
                   6215:   margin: 0.2em 0 0 0;
                   6216:   padding: 0;
                   6217:   font-weight: bold;
                   6218:   text-align: center;
1.995     raeburn  6219:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 6220: }
                   6221: 
1.911     bisitz   6222: #LC_nav_bar em {
                   6223:   font-weight: bold;
                   6224:   font-style: normal;
1.807     droeschl 6225: }
                   6226: 
1.897     wenzelju 6227: ol.LC_primary_menu {
1.911     bisitz   6228:   float: right;
1.934     droeschl 6229:   margin: 0;
1.995     raeburn  6230:   background-color: $pgbg_or_bgcolor;
1.807     droeschl 6231: }
                   6232: 
1.852     droeschl 6233: ol#LC_PathBreadcrumbs {
1.911     bisitz   6234:   margin: 0;
1.693     droeschl 6235: }
                   6236: 
1.897     wenzelju 6237: ol.LC_primary_menu li {
1.911     bisitz   6238:   display: inline;
                   6239:   padding: 5px 5px 0 10px;
                   6240:   vertical-align: top;
1.693     droeschl 6241: }
                   6242: 
1.897     wenzelju 6243: ol.LC_primary_menu li img {
1.911     bisitz   6244:   vertical-align: bottom;
1.934     droeschl 6245:   height: 1.1em;
1.693     droeschl 6246: }
                   6247: 
1.897     wenzelju 6248: ol.LC_primary_menu a {
1.911     bisitz   6249:   color: RGB(80, 80, 80);
                   6250:   text-decoration: none;
1.693     droeschl 6251: }
1.795     www      6252: 
1.949     droeschl 6253: ol.LC_primary_menu a.LC_new_message {
                   6254:   font-weight:bold;
                   6255:   color: darkred;
                   6256: }
                   6257: 
1.975     raeburn  6258: ol.LC_docs_parameters {
                   6259:   margin-left: 0;
                   6260:   padding: 0;
                   6261:   list-style: none;
                   6262: }
                   6263: 
                   6264: ol.LC_docs_parameters li {
                   6265:   margin: 0;
                   6266:   padding-right: 20px;
                   6267:   display: inline;
                   6268: }
                   6269: 
1.976     raeburn  6270: ol.LC_docs_parameters li:before {
                   6271:   content: "\\002022 \\0020";
                   6272: }
                   6273: 
                   6274: li.LC_docs_parameters_title {
                   6275:   font-weight: bold;
                   6276: }
                   6277: 
                   6278: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   6279:   content: "";
                   6280: }
                   6281: 
1.897     wenzelju 6282: ul#LC_secondary_menu {
1.911     bisitz   6283:   clear: both;
                   6284:   color: $fontmenu;
                   6285:   background: $tabbg;
                   6286:   list-style: none;
                   6287:   padding: 0;
                   6288:   margin: 0;
                   6289:   width: 100%;
1.995     raeburn  6290:   text-align: left;
1.808     droeschl 6291: }
                   6292: 
1.897     wenzelju 6293: ul#LC_secondary_menu li {
1.911     bisitz   6294:   font-weight: bold;
                   6295:   line-height: 1.8em;
                   6296:   padding: 0 0.8em;
                   6297:   border-right: 1px solid black;
                   6298:   display: inline;
                   6299:   vertical-align: middle;
1.807     droeschl 6300: }
                   6301: 
1.847     tempelho 6302: ul.LC_TabContent {
1.911     bisitz   6303:   display:block;
                   6304:   background: $sidebg;
                   6305:   border-bottom: solid 1px $lg_border_color;
                   6306:   list-style:none;
1.1020    raeburn  6307:   margin: -1px -10px 0 -10px;
1.911     bisitz   6308:   padding: 0;
1.693     droeschl 6309: }
                   6310: 
1.795     www      6311: ul.LC_TabContent li,
                   6312: ul.LC_TabContentBigger li {
1.911     bisitz   6313:   float:left;
1.741     harmsja  6314: }
1.795     www      6315: 
1.897     wenzelju 6316: ul#LC_secondary_menu li a {
1.911     bisitz   6317:   color: $fontmenu;
                   6318:   text-decoration: none;
1.693     droeschl 6319: }
1.795     www      6320: 
1.721     harmsja  6321: ul.LC_TabContent {
1.952     onken    6322:   min-height:20px;
1.721     harmsja  6323: }
1.795     www      6324: 
                   6325: ul.LC_TabContent li {
1.911     bisitz   6326:   vertical-align:middle;
1.959     onken    6327:   padding: 0 16px 0 10px;
1.911     bisitz   6328:   background-color:$tabbg;
                   6329:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  6330:   border-left: solid 1px $font;
1.721     harmsja  6331: }
1.795     www      6332: 
1.847     tempelho 6333: ul.LC_TabContent .right {
1.911     bisitz   6334:   float:right;
1.847     tempelho 6335: }
                   6336: 
1.911     bisitz   6337: ul.LC_TabContent li a,
                   6338: ul.LC_TabContent li {
                   6339:   color:rgb(47,47,47);
                   6340:   text-decoration:none;
                   6341:   font-size:95%;
                   6342:   font-weight:bold;
1.952     onken    6343:   min-height:20px;
                   6344: }
                   6345: 
1.959     onken    6346: ul.LC_TabContent li a:hover,
                   6347: ul.LC_TabContent li a:focus {
1.952     onken    6348:   color: $button_hover;
1.959     onken    6349:   background:none;
                   6350:   outline:none;
1.952     onken    6351: }
                   6352: 
                   6353: ul.LC_TabContent li:hover {
                   6354:   color: $button_hover;
                   6355:   cursor:pointer;
1.721     harmsja  6356: }
1.795     www      6357: 
1.911     bisitz   6358: ul.LC_TabContent li.active {
1.952     onken    6359:   color: $font;
1.911     bisitz   6360:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    6361:   border-bottom:solid 1px #FFFFFF;
                   6362:   cursor: default;
1.744     ehlerst  6363: }
1.795     www      6364: 
1.959     onken    6365: ul.LC_TabContent li.active a {
                   6366:   color:$font;
                   6367:   background:#FFFFFF;
                   6368:   outline: none;
                   6369: }
1.1047    raeburn  6370: 
                   6371: ul.LC_TabContent li.goback {
                   6372:   float: left;
                   6373:   border-left: none;
                   6374: }
                   6375: 
1.870     tempelho 6376: #maincoursedoc {
1.911     bisitz   6377:   clear:both;
1.870     tempelho 6378: }
                   6379: 
                   6380: ul.LC_TabContentBigger {
1.911     bisitz   6381:   display:block;
                   6382:   list-style:none;
                   6383:   padding: 0;
1.870     tempelho 6384: }
                   6385: 
1.795     www      6386: ul.LC_TabContentBigger li {
1.911     bisitz   6387:   vertical-align:bottom;
                   6388:   height: 30px;
                   6389:   font-size:110%;
                   6390:   font-weight:bold;
                   6391:   color: #737373;
1.841     tempelho 6392: }
                   6393: 
1.957     onken    6394: ul.LC_TabContentBigger li.active {
                   6395:   position: relative;
                   6396:   top: 1px;
                   6397: }
                   6398: 
1.870     tempelho 6399: ul.LC_TabContentBigger li a {
1.911     bisitz   6400:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6401:   height: 30px;
                   6402:   line-height: 30px;
                   6403:   text-align: center;
                   6404:   display: block;
                   6405:   text-decoration: none;
1.958     onken    6406:   outline: none;  
1.741     harmsja  6407: }
1.795     www      6408: 
1.870     tempelho 6409: ul.LC_TabContentBigger li.active a {
1.911     bisitz   6410:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   6411:   color:$font;
1.744     ehlerst  6412: }
1.795     www      6413: 
1.870     tempelho 6414: ul.LC_TabContentBigger li b {
1.911     bisitz   6415:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6416:   display: block;
                   6417:   float: left;
                   6418:   padding: 0 30px;
1.957     onken    6419:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 6420: }
                   6421: 
1.956     onken    6422: ul.LC_TabContentBigger li:hover b {
                   6423:   color:$button_hover;
                   6424: }
                   6425: 
1.870     tempelho 6426: ul.LC_TabContentBigger li.active b {
1.911     bisitz   6427:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6428:   color:$font;
1.957     onken    6429:   border: 0;
1.741     harmsja  6430: }
1.693     droeschl 6431: 
1.870     tempelho 6432: 
1.862     bisitz   6433: ul.LC_CourseBreadcrumbs {
                   6434:   background: $sidebg;
1.1020    raeburn  6435:   height: 2em;
1.862     bisitz   6436:   padding-left: 10px;
1.1020    raeburn  6437:   margin: 0;
1.862     bisitz   6438:   list-style-position: inside;
                   6439: }
                   6440: 
1.911     bisitz   6441: ol#LC_MenuBreadcrumbs,
1.862     bisitz   6442: ol#LC_PathBreadcrumbs {
1.911     bisitz   6443:   padding-left: 10px;
                   6444:   margin: 0;
1.933     droeschl 6445:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 6446: }
                   6447: 
1.911     bisitz   6448: ol#LC_MenuBreadcrumbs li,
                   6449: ol#LC_PathBreadcrumbs li,
1.862     bisitz   6450: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   6451:   display: inline;
1.933     droeschl 6452:   white-space: normal;  
1.693     droeschl 6453: }
                   6454: 
1.823     bisitz   6455: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6456: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   6457:   text-decoration: none;
                   6458:   font-size:90%;
1.693     droeschl 6459: }
1.795     www      6460: 
1.969     droeschl 6461: ol#LC_MenuBreadcrumbs h1 {
                   6462:   display: inline;
                   6463:   font-size: 90%;
                   6464:   line-height: 2.5em;
                   6465:   margin: 0;
                   6466:   padding: 0;
                   6467: }
                   6468: 
1.795     www      6469: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   6470:   text-decoration:none;
                   6471:   font-size:100%;
                   6472:   font-weight:bold;
1.693     droeschl 6473: }
1.795     www      6474: 
1.840     bisitz   6475: .LC_Box {
1.911     bisitz   6476:   border: solid 1px $lg_border_color;
                   6477:   padding: 0 10px 10px 10px;
1.746     neumanie 6478: }
1.795     www      6479: 
1.1020    raeburn  6480: .LC_DocsBox {
                   6481:   border: solid 1px $lg_border_color;
                   6482:   padding: 0 0 10px 10px;
                   6483: }
                   6484: 
1.795     www      6485: .LC_AboutMe_Image {
1.911     bisitz   6486:   float:left;
                   6487:   margin-right:10px;
1.747     neumanie 6488: }
1.795     www      6489: 
                   6490: .LC_Clear_AboutMe_Image {
1.911     bisitz   6491:   clear:left;
1.747     neumanie 6492: }
1.795     www      6493: 
1.721     harmsja  6494: dl.LC_ListStyleClean dt {
1.911     bisitz   6495:   padding-right: 5px;
                   6496:   display: table-header-group;
1.693     droeschl 6497: }
                   6498: 
1.721     harmsja  6499: dl.LC_ListStyleClean dd {
1.911     bisitz   6500:   display: table-row;
1.693     droeschl 6501: }
                   6502: 
1.721     harmsja  6503: .LC_ListStyleClean,
                   6504: .LC_ListStyleSimple,
                   6505: .LC_ListStyleNormal,
1.795     www      6506: .LC_ListStyleSpecial {
1.911     bisitz   6507:   /* display:block; */
                   6508:   list-style-position: inside;
                   6509:   list-style-type: none;
                   6510:   overflow: hidden;
                   6511:   padding: 0;
1.693     droeschl 6512: }
                   6513: 
1.721     harmsja  6514: .LC_ListStyleSimple li,
                   6515: .LC_ListStyleSimple dd,
                   6516: .LC_ListStyleNormal li,
                   6517: .LC_ListStyleNormal dd,
                   6518: .LC_ListStyleSpecial li,
1.795     www      6519: .LC_ListStyleSpecial dd {
1.911     bisitz   6520:   margin: 0;
                   6521:   padding: 5px 5px 5px 10px;
                   6522:   clear: both;
1.693     droeschl 6523: }
                   6524: 
1.721     harmsja  6525: .LC_ListStyleClean li,
                   6526: .LC_ListStyleClean dd {
1.911     bisitz   6527:   padding-top: 0;
                   6528:   padding-bottom: 0;
1.693     droeschl 6529: }
                   6530: 
1.721     harmsja  6531: .LC_ListStyleSimple dd,
1.795     www      6532: .LC_ListStyleSimple li {
1.911     bisitz   6533:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6534: }
                   6535: 
1.721     harmsja  6536: .LC_ListStyleSpecial li,
                   6537: .LC_ListStyleSpecial dd {
1.911     bisitz   6538:   list-style-type: none;
                   6539:   background-color: RGB(220, 220, 220);
                   6540:   margin-bottom: 4px;
1.693     droeschl 6541: }
                   6542: 
1.721     harmsja  6543: table.LC_SimpleTable {
1.911     bisitz   6544:   margin:5px;
                   6545:   border:solid 1px $lg_border_color;
1.795     www      6546: }
1.693     droeschl 6547: 
1.721     harmsja  6548: table.LC_SimpleTable tr {
1.911     bisitz   6549:   padding: 0;
                   6550:   border:solid 1px $lg_border_color;
1.693     droeschl 6551: }
1.795     www      6552: 
                   6553: table.LC_SimpleTable thead {
1.911     bisitz   6554:   background:rgb(220,220,220);
1.693     droeschl 6555: }
                   6556: 
1.721     harmsja  6557: div.LC_columnSection {
1.911     bisitz   6558:   display: block;
                   6559:   clear: both;
                   6560:   overflow: hidden;
                   6561:   margin: 0;
1.693     droeschl 6562: }
                   6563: 
1.721     harmsja  6564: div.LC_columnSection>* {
1.911     bisitz   6565:   float: left;
                   6566:   margin: 10px 20px 10px 0;
                   6567:   overflow:hidden;
1.693     droeschl 6568: }
1.721     harmsja  6569: 
1.795     www      6570: table em {
1.911     bisitz   6571:   font-weight: bold;
                   6572:   font-style: normal;
1.748     schulted 6573: }
1.795     www      6574: 
1.779     bisitz   6575: table.LC_tableBrowseRes,
1.795     www      6576: table.LC_tableOfContent {
1.911     bisitz   6577:   border:none;
                   6578:   border-spacing: 1px;
                   6579:   padding: 3px;
                   6580:   background-color: #FFFFFF;
                   6581:   font-size: 90%;
1.753     droeschl 6582: }
1.789     droeschl 6583: 
1.911     bisitz   6584: table.LC_tableOfContent {
                   6585:   border-collapse: collapse;
1.789     droeschl 6586: }
                   6587: 
1.771     droeschl 6588: table.LC_tableBrowseRes a,
1.768     schulted 6589: table.LC_tableOfContent a {
1.911     bisitz   6590:   background-color: transparent;
                   6591:   text-decoration: none;
1.753     droeschl 6592: }
                   6593: 
1.795     www      6594: table.LC_tableOfContent img {
1.911     bisitz   6595:   border: none;
                   6596:   height: 1.3em;
                   6597:   vertical-align: text-bottom;
                   6598:   margin-right: 0.3em;
1.753     droeschl 6599: }
1.757     schulted 6600: 
1.795     www      6601: a#LC_content_toolbar_firsthomework {
1.911     bisitz   6602:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  6603: }
                   6604: 
1.795     www      6605: a#LC_content_toolbar_everything {
1.911     bisitz   6606:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  6607: }
                   6608: 
1.795     www      6609: a#LC_content_toolbar_uncompleted {
1.911     bisitz   6610:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  6611: }
                   6612: 
1.795     www      6613: #LC_content_toolbar_clearbubbles {
1.911     bisitz   6614:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  6615: }
                   6616: 
1.795     www      6617: a#LC_content_toolbar_changefolder {
1.911     bisitz   6618:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 6619: }
                   6620: 
1.795     www      6621: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   6622:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 6623: }
                   6624: 
1.1043    raeburn  6625: a#LC_content_toolbar_edittoplevel {
                   6626:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   6627: }
                   6628: 
1.795     www      6629: ul#LC_toolbar li a:hover {
1.911     bisitz   6630:   background-position: bottom center;
1.757     schulted 6631: }
                   6632: 
1.795     www      6633: ul#LC_toolbar {
1.911     bisitz   6634:   padding: 0;
                   6635:   margin: 2px;
                   6636:   list-style:none;
                   6637:   position:relative;
                   6638:   background-color:white;
1.757     schulted 6639: }
                   6640: 
1.795     www      6641: ul#LC_toolbar li {
1.911     bisitz   6642:   border:1px solid white;
                   6643:   padding: 0;
                   6644:   margin: 0;
                   6645:   float: left;
                   6646:   display:inline;
                   6647:   vertical-align:middle;
                   6648: }
1.757     schulted 6649: 
1.783     amueller 6650: 
1.795     www      6651: a.LC_toolbarItem {
1.911     bisitz   6652:   display:block;
                   6653:   padding: 0;
                   6654:   margin: 0;
                   6655:   height: 32px;
                   6656:   width: 32px;
                   6657:   color:white;
                   6658:   border: none;
                   6659:   background-repeat:no-repeat;
                   6660:   background-color:transparent;
1.757     schulted 6661: }
                   6662: 
1.915     droeschl 6663: ul.LC_funclist {
                   6664:     margin: 0;
                   6665:     padding: 0.5em 1em 0.5em 0;
                   6666: }
                   6667: 
1.933     droeschl 6668: ul.LC_funclist > li:first-child {
                   6669:     font-weight:bold; 
                   6670:     margin-left:0.8em;
                   6671: }
                   6672: 
1.915     droeschl 6673: ul.LC_funclist + ul.LC_funclist {
                   6674:     /* 
                   6675:        left border as a seperator if we have more than
                   6676:        one list 
                   6677:     */
                   6678:     border-left: 1px solid $sidebg;
                   6679:     /* 
                   6680:        this hides the left border behind the border of the 
                   6681:        outer box if element is wrapped to the next 'line' 
                   6682:     */
                   6683:     margin-left: -1px;
                   6684: }
                   6685: 
1.843     bisitz   6686: ul.LC_funclist li {
1.915     droeschl 6687:   display: inline;
1.782     bisitz   6688:   white-space: nowrap;
1.915     droeschl 6689:   margin: 0 0 0 25px;
                   6690:   line-height: 150%;
1.782     bisitz   6691: }
                   6692: 
1.974     wenzelju 6693: .LC_hidden {
                   6694:   display: none;
                   6695: }
                   6696: 
1.1030    www      6697: .LCmodal-overlay {
                   6698: 		position:fixed;
                   6699: 		top:0;
                   6700: 		right:0;
                   6701: 		bottom:0;
                   6702: 		left:0;
                   6703: 		height:100%;
                   6704: 		width:100%;
                   6705: 		margin:0;
                   6706: 		padding:0;
                   6707: 		background:#999;
                   6708: 		opacity:.75;
                   6709: 		filter: alpha(opacity=75);
                   6710: 		-moz-opacity: 0.75;
                   6711: 		z-index:101;
                   6712: }
                   6713: 
                   6714: * html .LCmodal-overlay {   
                   6715: 		position: absolute;
                   6716: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   6717: }
                   6718: 
                   6719: .LCmodal-window {
                   6720: 		position:fixed;
                   6721: 		top:50%;
                   6722: 		left:50%;
                   6723: 		margin:0;
                   6724: 		padding:0;
                   6725: 		z-index:102;
                   6726: 	}
                   6727: 
                   6728: * html .LCmodal-window {
                   6729: 		position:absolute;
                   6730: }
                   6731: 
                   6732: .LCclose-window {
                   6733: 		position:absolute;
                   6734: 		width:32px;
                   6735: 		height:32px;
                   6736: 		right:8px;
                   6737: 		top:8px;
                   6738: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   6739: 		text-indent:-99999px;
                   6740: 		overflow:hidden;
                   6741: 		cursor:pointer;
                   6742: }
                   6743: 
1.343     albertel 6744: END
                   6745: }
                   6746: 
1.306     albertel 6747: =pod
                   6748: 
                   6749: =item * &headtag()
                   6750: 
                   6751: Returns a uniform footer for LON-CAPA web pages.
                   6752: 
1.307     albertel 6753: Inputs: $title - optional title for the head
                   6754:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6755:         $args - optional arguments
1.319     albertel 6756:             force_register - if is true call registerurl so the remote is 
                   6757:                              informed
1.415     albertel 6758:             redirect       -> array ref of
                   6759:                                    1- seconds before redirect occurs
                   6760:                                    2- url to redirect to
                   6761:                                    3- whether the side effect should occur
1.315     albertel 6762:                            (side effect of setting 
                   6763:                                $env{'internal.head.redirect'} to the url 
                   6764:                                redirected too)
1.352     albertel 6765:             domain         -> force to color decorate a page for a specific
                   6766:                                domain
                   6767:             function       -> force usage of a specific rolish color scheme
                   6768:             bgcolor        -> override the default page bgcolor
1.460     albertel 6769:             no_auto_mt_title
                   6770:                            -> prevent &mt()ing the title arg
1.464     albertel 6771: 
1.306     albertel 6772: =cut
                   6773: 
                   6774: sub headtag {
1.313     albertel 6775:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6776:     
1.363     albertel 6777:     my $function = $args->{'function'} || &get_users_function();
                   6778:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6779:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6780:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6781: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6782: 		   #time(),
1.418     albertel 6783: 		   $env{'environment.color.timestamp'},
1.363     albertel 6784: 		   $function,$domain,$bgcolor);
                   6785: 
1.369     www      6786:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6787: 
1.308     albertel 6788:     my $result =
                   6789: 	'<head>'.
1.461     albertel 6790: 	&font_settings();
1.319     albertel 6791: 
1.461     albertel 6792:     if (!$args->{'frameset'}) {
                   6793: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6794:     }
1.962     droeschl 6795:     if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
                   6796:         $result .= Apache::lonxml::display_title();
1.319     albertel 6797:     }
1.436     albertel 6798:     if (!$args->{'no_nav_bar'} 
                   6799: 	&& !$args->{'only_body'}
                   6800: 	&& !$args->{'frameset'}) {
                   6801: 	$result .= &help_menu_js();
1.1032    www      6802:         $result.=&modal_window();
1.1038    www      6803:         $result.=&togglebox_script();
1.1034    www      6804:         $result.=&wishlist_window();
1.1041    www      6805:         $result.=&LCprogressbarUpdate_script();
1.1034    www      6806:     } else {
                   6807:         if ($args->{'add_modal'}) {
                   6808:            $result.=&modal_window();
                   6809:         }
                   6810:         if ($args->{'add_wishlist'}) {
                   6811:            $result.=&wishlist_window();
                   6812:         }
1.1038    www      6813:         if ($args->{'add_togglebox'}) {
                   6814:            $result.=&togglebox_script();
                   6815:         }
1.1041    www      6816:         if ($args->{'add_progressbar'}) {
                   6817:            $result.=&LCprogressbarUpdate_script();
                   6818:         }
1.436     albertel 6819:     }
1.314     albertel 6820:     if (ref($args->{'redirect'})) {
1.414     albertel 6821: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6822: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6823: 	if (!$inhibit_continue) {
                   6824: 	    $env{'internal.head.redirect'} = $url;
                   6825: 	}
1.313     albertel 6826: 	$result.=<<ADDMETA
                   6827: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6828: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6829: ADDMETA
                   6830:     }
1.306     albertel 6831:     if (!defined($title)) {
                   6832: 	$title = 'The LearningOnline Network with CAPA';
                   6833:     }
1.460     albertel 6834:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6835:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6836: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6837: 	.$head_extra;
1.962     droeschl 6838:     return $result.'</head>';
1.306     albertel 6839: }
                   6840: 
                   6841: =pod
                   6842: 
1.340     albertel 6843: =item * &font_settings()
                   6844: 
                   6845: Returns neccessary <meta> to set the proper encoding
                   6846: 
                   6847: Inputs: none
                   6848: 
                   6849: =cut
                   6850: 
                   6851: sub font_settings {
                   6852:     my $headerstring='';
1.647     www      6853:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6854: 	$headerstring.=
                   6855: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6856:     }
                   6857:     return $headerstring;
                   6858: }
                   6859: 
1.341     albertel 6860: =pod
                   6861: 
                   6862: =item * &xml_begin()
                   6863: 
                   6864: Returns the needed doctype and <html>
                   6865: 
                   6866: Inputs: none
                   6867: 
                   6868: =cut
                   6869: 
                   6870: sub xml_begin {
                   6871:     my $output='';
                   6872: 
                   6873:     if ($env{'browser.mathml'}) {
                   6874: 	$output='<?xml version="1.0"?>'
                   6875:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6876: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6877:             
                   6878: #	    .'<!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">] >'
                   6879: 	    .'<!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">'
                   6880:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6881: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6882:     } else {
1.849     bisitz   6883: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   6884:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 6885:     }
                   6886:     return $output;
                   6887: }
1.340     albertel 6888: 
                   6889: =pod
                   6890: 
1.306     albertel 6891: =item * &start_page()
                   6892: 
                   6893: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6894: 
1.648     raeburn  6895: Inputs:
                   6896: 
                   6897: =over 4
                   6898: 
                   6899: $title - optional title for the page
                   6900: 
                   6901: $head_extra - optional extra HTML to incude inside the <head>
                   6902: 
                   6903: $args - additional optional args supported are:
                   6904: 
                   6905: =over 8
                   6906: 
                   6907:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6908:                                     arg on
1.814     bisitz   6909:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6910:              add_entries    -> additional attributes to add to the  <body>
                   6911:              domain         -> force to color decorate a page for a 
1.317     albertel 6912:                                     specific domain
1.648     raeburn  6913:              function       -> force usage of a specific rolish color
1.317     albertel 6914:                                     scheme
1.648     raeburn  6915:              redirect       -> see &headtag()
                   6916:              bgcolor        -> override the default page bg color
                   6917:              js_ready       -> return a string ready for being used in 
1.317     albertel 6918:                                     a javascript writeln
1.648     raeburn  6919:              html_encode    -> return a string ready for being used in 
1.320     albertel 6920:                                     a html attribute
1.648     raeburn  6921:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6922:                                     $forcereg arg
1.648     raeburn  6923:              frameset       -> if true will start with a <frameset>
1.330     albertel 6924:                                     rather than <body>
1.648     raeburn  6925:              skip_phases    -> hash ref of 
1.338     albertel 6926:                                     head -> skip the <html><head> generation
                   6927:                                     body -> skip all <body> generation
1.648     raeburn  6928:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6929:              inherit_jsmath -> when creating popup window in a page,
                   6930:                                     should it have jsmath forced on by the
                   6931:                                     current page
1.867     kalberla 6932:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  6933:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 6934: 
1.648     raeburn  6935: =back
1.460     albertel 6936: 
1.648     raeburn  6937: =back
1.562     albertel 6938: 
1.306     albertel 6939: =cut
                   6940: 
                   6941: sub start_page {
1.309     albertel 6942:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6943:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 6944: 
1.315     albertel 6945:     $env{'internal.start_page'}++;
1.338     albertel 6946:     my $result;
1.964     droeschl 6947: 
1.338     albertel 6948:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030    www      6949:         $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338     albertel 6950:     }
                   6951:     
                   6952:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6953: 	if ($args->{'frameset'}) {
                   6954: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6955: 						$args->{'add_entries'});
                   6956: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   6957:         } else {
                   6958:             $result .=
                   6959:                 &bodytag($title, 
                   6960:                          $args->{'function'},       $args->{'add_entries'},
                   6961:                          $args->{'only_body'},      $args->{'domain'},
                   6962:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.962     droeschl 6963:                          $args->{'bgcolor'},        $args);
1.831     bisitz   6964:         }
1.330     albertel 6965:     }
1.338     albertel 6966: 
1.315     albertel 6967:     if ($args->{'js_ready'}) {
1.713     kaisler  6968: 		$result = &js_ready($result);
1.315     albertel 6969:     }
1.320     albertel 6970:     if ($args->{'html_encode'}) {
1.713     kaisler  6971: 		$result = &html_encode($result);
                   6972:     }
                   6973: 
1.813     bisitz   6974:     # Preparation for new and consistent functionlist at top of screen
                   6975:     # if ($args->{'functionlist'}) {
                   6976:     #            $result .= &build_functionlist();
                   6977:     #}
                   6978: 
1.964     droeschl 6979:     # Don't add anything more if only_body wanted or in const space
                   6980:     return $result if    $args->{'only_body'} 
                   6981:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   6982: 
                   6983:     #Breadcrumbs
1.758     kaisler  6984:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6985: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6986: 		#if any br links exists, add them to the breadcrumbs
                   6987: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6988: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6989: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6990: 			}
                   6991: 		}
                   6992: 
                   6993: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6994: 		if(exists($args->{'bread_crumbs_component'})){
                   6995: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   6996: 		}else{
                   6997: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   6998: 		}
1.320     albertel 6999:     }
1.315     albertel 7000:     return $result;
1.306     albertel 7001: }
                   7002: 
                   7003: sub end_page {
1.315     albertel 7004:     my ($args) = @_;
                   7005:     $env{'internal.end_page'}++;
1.330     albertel 7006:     my $result;
1.335     albertel 7007:     if ($args->{'discussion'}) {
                   7008: 	my ($target,$parser);
                   7009: 	if (ref($args->{'discussion'})) {
                   7010: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   7011: 				$args->{'discussion'}{'parser'});
                   7012: 	}
                   7013: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   7014:     }
1.330     albertel 7015:     if ($args->{'frameset'}) {
                   7016: 	$result .= '</frameset>';
                   7017:     } else {
1.635     raeburn  7018: 	$result .= &endbodytag($args);
1.330     albertel 7019:     }
                   7020:     $result .= "\n</html>";
                   7021: 
1.315     albertel 7022:     if ($args->{'js_ready'}) {
1.317     albertel 7023: 	$result = &js_ready($result);
1.315     albertel 7024:     }
1.335     albertel 7025: 
1.320     albertel 7026:     if ($args->{'html_encode'}) {
                   7027: 	$result = &html_encode($result);
                   7028:     }
1.335     albertel 7029: 
1.315     albertel 7030:     return $result;
                   7031: }
                   7032: 
1.1034    www      7033: sub wishlist_window {
                   7034:     return(<<'ENDWISHLIST');
1.1046    raeburn  7035: <script type="text/javascript">
1.1034    www      7036: // <![CDATA[
                   7037: // <!-- BEGIN LON-CAPA Internal
                   7038: function set_wishlistlink(title, path) {
                   7039:     if (!title) {
                   7040:         title = document.title;
                   7041:         title = title.replace(/^LON-CAPA /,'');
                   7042:     }
                   7043:     if (!path) {
                   7044:         path = location.pathname;
                   7045:     }
                   7046:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   7047:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   7048: }
                   7049: // END LON-CAPA Internal -->
                   7050: // ]]>
                   7051: </script>
                   7052: ENDWISHLIST
                   7053: }
                   7054: 
1.1030    www      7055: sub modal_window {
                   7056:     return(<<'ENDMODAL');
1.1046    raeburn  7057: <script type="text/javascript">
1.1030    www      7058: // <![CDATA[
                   7059: // <!-- BEGIN LON-CAPA Internal
                   7060: var modalWindow = {
                   7061: 	parent:"body",
                   7062: 	windowId:null,
                   7063: 	content:null,
                   7064: 	width:null,
                   7065: 	height:null,
                   7066: 	close:function()
                   7067: 	{
                   7068: 	        $(".LCmodal-window").remove();
                   7069: 	        $(".LCmodal-overlay").remove();
                   7070: 	},
                   7071: 	open:function()
                   7072: 	{
                   7073: 		var modal = "";
                   7074: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   7075: 		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;\">";
                   7076: 		modal += this.content;
                   7077: 		modal += "</div>";	
                   7078: 
                   7079: 		$(this.parent).append(modal);
                   7080: 
                   7081: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   7082: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   7083: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   7084: 	}
                   7085: };
1.1031    www      7086: 	var openMyModal = function(source,width,height,scrolling)
1.1030    www      7087: 	{
                   7088: 		modalWindow.windowId = "myModal";
                   7089: 		modalWindow.width = width;
                   7090: 		modalWindow.height = height;
1.1031    www      7091: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='true' src='" + source + "'>&lt/iframe>";
1.1030    www      7092: 		modalWindow.open();
                   7093: 	};	
                   7094: // END LON-CAPA Internal -->
                   7095: // ]]>
                   7096: </script>
                   7097: ENDMODAL
                   7098: }
                   7099: 
                   7100: sub modal_link {
1.1031    www      7101:     my ($link,$linktext,$width,$height,$target,$scrolling)=@_;
1.1030    www      7102:     unless ($width) { $width=480; }
                   7103:     unless ($height) { $height=400; }
1.1031    www      7104:     unless ($scrolling) { $scrolling='yes'; }
                   7105:     return '<a href="'.$link.'" target="'.$target.'" onclick="openMyModal(\''.$link.'\','.$width.','.$height.',\''.$scrolling.'\'); return false;">'.
                   7106:            $linktext.'</a>';
1.1030    www      7107: }
                   7108: 
1.1032    www      7109: sub modal_adhoc_script {
                   7110:     my ($funcname,$width,$height,$content)=@_;
                   7111:     return (<<ENDADHOC);
1.1046    raeburn  7112: <script type="text/javascript">
1.1032    www      7113: // <![CDATA[
                   7114:         var $funcname = function()
                   7115:         {
                   7116:                 modalWindow.windowId = "myModal";
                   7117:                 modalWindow.width = $width;
                   7118:                 modalWindow.height = $height;
                   7119:                 modalWindow.content = '$content';
                   7120:                 modalWindow.open();
                   7121:         };  
                   7122: // ]]>
                   7123: </script>
                   7124: ENDADHOC
                   7125: }
                   7126: 
1.1041    www      7127: sub modal_adhoc_inner {
                   7128:     my ($funcname,$width,$height,$content)=@_;
                   7129:     my $innerwidth=$width-20;
                   7130:     $content=&js_ready(
1.1042    www      7131:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1041    www      7132:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px').
                   7133:                     $content.
                   7134:                  &end_scrollbox().
                   7135:                &end_page()
                   7136:              );
                   7137:     return &modal_adhoc_script($funcname,$width,$height,$content);
                   7138: }
                   7139: 
                   7140: sub modal_adhoc_window {
                   7141:     my ($funcname,$width,$height,$content,$linktext)=@_;
                   7142:     return &modal_adhoc_inner($funcname,$width,$height,$content).
                   7143:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   7144: }
                   7145: 
                   7146: sub modal_adhoc_launch {
                   7147:     my ($funcname,$width,$height,$content)=@_;
                   7148:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   7149: <script type="text/javascript">
                   7150: // <![CDATA[
                   7151: $funcname();
                   7152: // ]]>
                   7153: </script>
                   7154: ENDLAUNCH
                   7155: }
                   7156: 
                   7157: sub modal_adhoc_close {
                   7158:     return (<<ENDCLOSE);
                   7159: <script type="text/javascript">
                   7160: // <![CDATA[
                   7161: modalWindow.close();
                   7162: // ]]>
                   7163: </script>
                   7164: ENDCLOSE
                   7165: }
                   7166: 
1.1038    www      7167: sub togglebox_script {
                   7168:    return(<<ENDTOGGLE);
                   7169: <script type="text/javascript"> 
                   7170: // <![CDATA[
                   7171: function LCtoggleDisplay(id,hidetext,showtext) {
                   7172:    link = document.getElementById(id + "link").childNodes[0];
                   7173:    with (document.getElementById(id).style) {
                   7174:       if (display == "none" ) {
                   7175:           display = "inline";
                   7176:           link.nodeValue = hidetext;
                   7177:         } else {
                   7178:           display = "none";
                   7179:           link.nodeValue = showtext;
                   7180:        }
                   7181:    }
                   7182: }
                   7183: // ]]>
                   7184: </script>
                   7185: ENDTOGGLE
                   7186: }
                   7187: 
1.1039    www      7188: sub start_togglebox {
                   7189:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   7190:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   7191:     unless ($showtext) { $showtext=&mt('show'); }
                   7192:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   7193:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   7194:     return &start_data_table().
                   7195:            &start_data_table_header_row().
                   7196:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   7197:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   7198:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   7199:            &end_data_table_header_row().
                   7200:            '<tr id="'.$id.'" style="display:none""><td>';
                   7201: }
                   7202: 
                   7203: sub end_togglebox {
                   7204:     return '</td></tr>'.&end_data_table();
                   7205: }
                   7206: 
1.1041    www      7207: sub LCprogressbar_script {
1.1045    www      7208:    my ($id)=@_;
1.1041    www      7209:    return(<<ENDPROGRESS);
                   7210: <script type="text/javascript">
                   7211: // <![CDATA[
1.1045    www      7212: \$('#progressbar$id').progressbar({
1.1041    www      7213:   value: 0,
                   7214:   change: function(event, ui) {
                   7215:     var newVal = \$(this).progressbar('option', 'value');
                   7216:     \$('.pblabel', this).text(LCprogressTxt);
                   7217:   }
                   7218: });
                   7219: // ]]>
                   7220: </script>
                   7221: ENDPROGRESS
                   7222: }
                   7223: 
                   7224: sub LCprogressbarUpdate_script {
                   7225:    return(<<ENDPROGRESSUPDATE);
                   7226: <style type="text/css">
                   7227: .ui-progressbar { position:relative; }
                   7228: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   7229: </style>
                   7230: <script type="text/javascript">
                   7231: // <![CDATA[
1.1045    www      7232: var LCprogressTxt='---';
                   7233: 
                   7234: function LCupdateProgress(percent,progresstext,id) {
1.1041    www      7235:    LCprogressTxt=progresstext;
1.1045    www      7236:    \$('#progressbar'+id).progressbar('value',percent);
1.1041    www      7237: }
                   7238: // ]]>
                   7239: </script>
                   7240: ENDPROGRESSUPDATE
                   7241: }
                   7242: 
1.1042    www      7243: my $LClastpercent;
1.1045    www      7244: my $LCidcnt;
                   7245: my $LCcurrentid;
1.1042    www      7246: 
1.1041    www      7247: sub LCprogressbar {
1.1042    www      7248:     my ($r)=(@_);
                   7249:     $LClastpercent=0;
1.1045    www      7250:     $LCidcnt++;
                   7251:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1041    www      7252:     my $starting=&mt('Starting');
                   7253:     my $content=(<<ENDPROGBAR);
                   7254: <p>
1.1045    www      7255:   <div id="progressbar$LCcurrentid">
1.1041    www      7256:     <span class="pblabel">$starting</span>
                   7257:   </div>
                   7258: </p>
                   7259: ENDPROGBAR
1.1045    www      7260:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041    www      7261: }
                   7262: 
                   7263: sub LCprogressbarUpdate {
1.1042    www      7264:     my ($r,$val,$text)=@_;
                   7265:     unless ($val) { 
                   7266:        if ($LClastpercent) {
                   7267:            $val=$LClastpercent;
                   7268:        } else {
                   7269:            $val=0;
                   7270:        }
                   7271:     }
1.1041    www      7272:     if ($val<0) { $val=0; }
                   7273:     if ($val>100) { $val=0; }
1.1042    www      7274:     $LClastpercent=$val;
1.1041    www      7275:     unless ($text) { $text=$val.'%'; }
                   7276:     $text=&js_ready($text);
1.1044    www      7277:     &r_print($r,<<ENDUPDATE);
1.1041    www      7278: <script type="text/javascript">
                   7279: // <![CDATA[
1.1045    www      7280: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041    www      7281: // ]]>
                   7282: </script>
                   7283: ENDUPDATE
1.1035    www      7284: }
                   7285: 
1.1042    www      7286: sub LCprogressbarClose {
                   7287:     my ($r)=@_;
                   7288:     $LClastpercent=0;
1.1044    www      7289:     &r_print($r,<<ENDCLOSE);
1.1042    www      7290: <script type="text/javascript">
                   7291: // <![CDATA[
1.1045    www      7292: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      7293: // ]]>
                   7294: </script>
                   7295: ENDCLOSE
1.1044    www      7296: }
                   7297: 
                   7298: sub r_print {
                   7299:     my ($r,$to_print)=@_;
                   7300:     if ($r) {
                   7301:       $r->print($to_print);
                   7302:       $r->rflush();
                   7303:     } else {
                   7304:       print($to_print);
                   7305:     }
1.1042    www      7306: }
                   7307: 
1.320     albertel 7308: sub html_encode {
                   7309:     my ($result) = @_;
                   7310: 
1.322     albertel 7311:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 7312:     
                   7313:     return $result;
                   7314: }
1.1044    www      7315: 
1.317     albertel 7316: sub js_ready {
                   7317:     my ($result) = @_;
                   7318: 
1.323     albertel 7319:     $result =~ s/[\n\r]/ /xmsg;
                   7320:     $result =~ s/\\/\\\\/xmsg;
                   7321:     $result =~ s/'/\\'/xmsg;
1.372     albertel 7322:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 7323:     
                   7324:     return $result;
                   7325: }
                   7326: 
1.315     albertel 7327: sub validate_page {
                   7328:     if (  exists($env{'internal.start_page'})
1.316     albertel 7329: 	  &&     $env{'internal.start_page'} > 1) {
                   7330: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 7331: 				 $env{'internal.start_page'}.' '.
1.316     albertel 7332: 				 $ENV{'request.filename'});
1.315     albertel 7333:     }
                   7334:     if (  exists($env{'internal.end_page'})
1.316     albertel 7335: 	  &&     $env{'internal.end_page'} > 1) {
                   7336: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 7337: 				 $env{'internal.end_page'}.' '.
1.316     albertel 7338: 				 $env{'request.filename'});
1.315     albertel 7339:     }
                   7340:     if (     exists($env{'internal.start_page'})
                   7341: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 7342: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   7343: 				 $env{'request.filename'});
1.315     albertel 7344:     }
                   7345:     if (   ! exists($env{'internal.start_page'})
                   7346: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 7347: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   7348: 				 $env{'request.filename'});
1.315     albertel 7349:     }
1.306     albertel 7350: }
1.315     albertel 7351: 
1.996     www      7352: 
                   7353: sub start_scrollbox {
1.1018    raeburn  7354:     my ($outerwidth,$width,$height,$id)=@_;
1.998     raeburn  7355:     unless ($outerwidth) { $outerwidth='520px'; }
                   7356:     unless ($width) { $width='500px'; }
                   7357:     unless ($height) { $height='200px'; }
1.1020    raeburn  7358:     my ($table_id,$div_id);
1.1018    raeburn  7359:     if ($id ne '') {
1.1020    raeburn  7360:         $table_id = " id='table_$id'";
                   7361:         $div_id = " id='div_$id'";
1.1018    raeburn  7362:     }
1.1020    raeburn  7363:     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      7364: }
                   7365: 
                   7366: sub end_scrollbox {
1.1036    www      7367:     return '</div></td></tr></table>';
1.996     www      7368: }
                   7369: 
1.318     albertel 7370: sub simple_error_page {
                   7371:     my ($r,$title,$msg) = @_;
                   7372:     my $page =
                   7373: 	&Apache::loncommon::start_page($title).
                   7374: 	&mt($msg).
                   7375: 	&Apache::loncommon::end_page();
                   7376:     if (ref($r)) {
                   7377: 	$r->print($page);
1.327     albertel 7378: 	return;
1.318     albertel 7379:     }
                   7380:     return $page;
                   7381: }
1.347     albertel 7382: 
                   7383: {
1.610     albertel 7384:     my @row_count;
1.961     onken    7385: 
                   7386:     sub start_data_table_count {
                   7387:         unshift(@row_count, 0);
                   7388:         return;
                   7389:     }
                   7390: 
                   7391:     sub end_data_table_count {
                   7392:         shift(@row_count);
                   7393:         return;
                   7394:     }
                   7395: 
1.347     albertel 7396:     sub start_data_table {
1.1018    raeburn  7397: 	my ($add_class,$id) = @_;
1.422     albertel 7398: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  7399:         my $table_id;
                   7400:         if (defined($id)) {
                   7401:             $table_id = ' id="'.$id.'"';
                   7402:         }
1.961     onken    7403: 	&start_data_table_count();
1.1018    raeburn  7404: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 7405:     }
                   7406: 
                   7407:     sub end_data_table {
1.961     onken    7408: 	&end_data_table_count();
1.389     albertel 7409: 	return '</table>'."\n";;
1.347     albertel 7410:     }
                   7411: 
                   7412:     sub start_data_table_row {
1.974     wenzelju 7413: 	my ($add_class, $id) = @_;
1.610     albertel 7414: 	$row_count[0]++;
                   7415: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   7416: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 7417:         $id = (' id="'.$id.'"') unless ($id eq '');
                   7418:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 7419:     }
1.471     banghart 7420:     
                   7421:     sub continue_data_table_row {
1.974     wenzelju 7422: 	my ($add_class, $id) = @_;
1.610     albertel 7423: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 7424: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   7425:         $id = (' id="'.$id.'"') unless ($id eq '');
                   7426:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 7427:     }
1.347     albertel 7428: 
                   7429:     sub end_data_table_row {
1.389     albertel 7430: 	return '</tr>'."\n";;
1.347     albertel 7431:     }
1.367     www      7432: 
1.421     albertel 7433:     sub start_data_table_empty_row {
1.707     bisitz   7434: #	$row_count[0]++;
1.421     albertel 7435: 	return  '<tr class="LC_empty_row" >'."\n";;
                   7436:     }
                   7437: 
                   7438:     sub end_data_table_empty_row {
                   7439: 	return '</tr>'."\n";;
                   7440:     }
                   7441: 
1.367     www      7442:     sub start_data_table_header_row {
1.389     albertel 7443: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      7444:     }
                   7445: 
                   7446:     sub end_data_table_header_row {
1.389     albertel 7447: 	return '</tr>'."\n";;
1.367     www      7448:     }
1.890     droeschl 7449: 
                   7450:     sub data_table_caption {
                   7451:         my $caption = shift;
                   7452:         return "<caption class=\"LC_caption\">$caption</caption>";
                   7453:     }
1.347     albertel 7454: }
                   7455: 
1.548     albertel 7456: =pod
                   7457: 
                   7458: =item * &inhibit_menu_check($arg)
                   7459: 
                   7460: Checks for a inhibitmenu state and generates output to preserve it
                   7461: 
                   7462: Inputs:         $arg - can be any of
                   7463:                      - undef - in which case the return value is a string 
                   7464:                                to add  into arguments list of a uri
                   7465:                      - 'input' - in which case the return value is a HTML
                   7466:                                  <form> <input> field of type hidden to
                   7467:                                  preserve the value
                   7468:                      - a url - in which case the return value is the url with
                   7469:                                the neccesary cgi args added to preserve the
                   7470:                                inhibitmenu state
                   7471:                      - a ref to a url - no return value, but the string is
                   7472:                                         updated to include the neccessary cgi
                   7473:                                         args to preserve the inhibitmenu state
                   7474: 
                   7475: =cut
                   7476: 
                   7477: sub inhibit_menu_check {
                   7478:     my ($arg) = @_;
                   7479:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   7480:     if ($arg eq 'input') {
                   7481: 	if ($env{'form.inhibitmenu'}) {
                   7482: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   7483: 	} else {
                   7484: 	    return
                   7485: 	}
                   7486:     }
                   7487:     if ($env{'form.inhibitmenu'}) {
                   7488: 	if (ref($arg)) {
                   7489: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7490: 	} elsif ($arg eq '') {
                   7491: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   7492: 	} else {
                   7493: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7494: 	}
                   7495:     }
                   7496:     if (!ref($arg)) {
                   7497: 	return $arg;
                   7498:     }
                   7499: }
                   7500: 
1.251     albertel 7501: ###############################################
1.182     matthew  7502: 
                   7503: =pod
                   7504: 
1.549     albertel 7505: =back
                   7506: 
                   7507: =head1 User Information Routines
                   7508: 
                   7509: =over 4
                   7510: 
1.405     albertel 7511: =item * &get_users_function()
1.182     matthew  7512: 
                   7513: Used by &bodytag to determine the current users primary role.
                   7514: Returns either 'student','coordinator','admin', or 'author'.
                   7515: 
                   7516: =cut
                   7517: 
                   7518: ###############################################
                   7519: sub get_users_function {
1.815     tempelho 7520:     my $function = 'norole';
1.818     tempelho 7521:     if ($env{'request.role'}=~/^(st)/) {
                   7522:         $function='student';
                   7523:     }
1.907     raeburn  7524:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  7525:         $function='coordinator';
                   7526:     }
1.258     albertel 7527:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  7528:         $function='admin';
                   7529:     }
1.826     bisitz   7530:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  7531:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  7532:         $function='author';
                   7533:     }
                   7534:     return $function;
1.54      www      7535: }
1.99      www      7536: 
                   7537: ###############################################
                   7538: 
1.233     raeburn  7539: =pod
                   7540: 
1.821     raeburn  7541: =item * &show_course()
                   7542: 
                   7543: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   7544: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   7545: 
                   7546: Inputs:
                   7547: None
                   7548: 
                   7549: Outputs:
                   7550: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   7551: 
                   7552: =cut
                   7553: 
                   7554: ###############################################
                   7555: sub show_course {
                   7556:     my $course = !$env{'user.adv'};
                   7557:     if (!$env{'user.adv'}) {
                   7558:         foreach my $env (keys(%env)) {
                   7559:             next if ($env !~ m/^user\.priv\./);
                   7560:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   7561:                 $course = 0;
                   7562:                 last;
                   7563:             }
                   7564:         }
                   7565:     }
                   7566:     return $course;
                   7567: }
                   7568: 
                   7569: ###############################################
                   7570: 
                   7571: =pod
                   7572: 
1.542     raeburn  7573: =item * &check_user_status()
1.274     raeburn  7574: 
                   7575: Determines current status of supplied role for a
                   7576: specific user. Roles can be active, previous or future.
                   7577: 
                   7578: Inputs: 
                   7579: user's domain, user's username, course's domain,
1.375     raeburn  7580: course's number, optional section ID.
1.274     raeburn  7581: 
                   7582: Outputs:
                   7583: role status: active, previous or future. 
                   7584: 
                   7585: =cut
                   7586: 
                   7587: sub check_user_status {
1.412     raeburn  7588:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.982     raeburn  7589:     my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
                   7590:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,$extra);
1.274     raeburn  7591:     my @uroles = keys %userinfo;
                   7592:     my $srchstr;
                   7593:     my $active_chk = 'none';
1.412     raeburn  7594:     my $now = time;
1.274     raeburn  7595:     if (@uroles > 0) {
1.908     raeburn  7596:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  7597:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   7598:         } else {
1.412     raeburn  7599:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   7600:         }
                   7601:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  7602:             my $role_end = 0;
                   7603:             my $role_start = 0;
                   7604:             $active_chk = 'active';
1.412     raeburn  7605:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   7606:                 $role_end = $1;
                   7607:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   7608:                     $role_start = $1;
1.274     raeburn  7609:                 }
                   7610:             }
                   7611:             if ($role_start > 0) {
1.412     raeburn  7612:                 if ($now < $role_start) {
1.274     raeburn  7613:                     $active_chk = 'future';
                   7614:                 }
                   7615:             }
                   7616:             if ($role_end > 0) {
1.412     raeburn  7617:                 if ($now > $role_end) {
1.274     raeburn  7618:                     $active_chk = 'previous';
                   7619:                 }
                   7620:             }
                   7621:         }
                   7622:     }
                   7623:     return $active_chk;
                   7624: }
                   7625: 
                   7626: ###############################################
                   7627: 
                   7628: =pod
                   7629: 
1.405     albertel 7630: =item * &get_sections()
1.233     raeburn  7631: 
                   7632: Determines all the sections for a course including
                   7633: sections with students and sections containing other roles.
1.419     raeburn  7634: Incoming parameters: 
                   7635: 
                   7636: 1. domain
                   7637: 2. course number 
                   7638: 3. reference to array containing roles for which sections should 
                   7639: be gathered (optional).
                   7640: 4. reference to array containing status types for which sections 
                   7641: should be gathered (optional).
                   7642: 
                   7643: If the third argument is undefined, sections are gathered for any role. 
                   7644: If the fourth argument is undefined, sections are gathered for any status.
                   7645: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  7646:  
1.374     raeburn  7647: Returns section hash (keys are section IDs, values are
                   7648: number of users in each section), subject to the
1.419     raeburn  7649: optional roles filter, optional status filter 
1.233     raeburn  7650: 
                   7651: =cut
                   7652: 
                   7653: ###############################################
                   7654: sub get_sections {
1.419     raeburn  7655:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 7656:     if (!defined($cdom) || !defined($cnum)) {
                   7657:         my $cid =  $env{'request.course.id'};
                   7658: 
                   7659: 	return if (!defined($cid));
                   7660: 
                   7661:         $cdom = $env{'course.'.$cid.'.domain'};
                   7662:         $cnum = $env{'course.'.$cid.'.num'};
                   7663:     }
                   7664: 
                   7665:     my %sectioncount;
1.419     raeburn  7666:     my $now = time;
1.240     albertel 7667: 
1.366     albertel 7668:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 7669: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 7670: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   7671: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  7672:         my $start_index = &Apache::loncoursedata::CL_START();
                   7673:         my $end_index = &Apache::loncoursedata::CL_END();
                   7674:         my $status;
1.366     albertel 7675: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  7676: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   7677: 				                     $data->[$status_index],
                   7678:                                                      $data->[$start_index],
                   7679:                                                      $data->[$end_index]);
                   7680:             if ($stu_status eq 'Active') {
                   7681:                 $status = 'active';
                   7682:             } elsif ($end < $now) {
                   7683:                 $status = 'previous';
                   7684:             } elsif ($start > $now) {
                   7685:                 $status = 'future';
                   7686:             } 
                   7687: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7688:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7689:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7690: 		    $sectioncount{$section}++;
                   7691:                 }
1.240     albertel 7692: 	    }
                   7693: 	}
                   7694:     }
                   7695:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7696:     foreach my $user (sort(keys(%courseroles))) {
                   7697: 	if ($user !~ /^(\w{2})/) { next; }
                   7698: 	my ($role) = ($user =~ /^(\w{2})/);
                   7699: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7700: 	my ($section,$status);
1.240     albertel 7701: 	if ($role eq 'cr' &&
                   7702: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7703: 	    $section=$1;
                   7704: 	}
                   7705: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7706: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7707:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7708:         if ($end == -1 && $start == -1) {
                   7709:             next; #deleted role
                   7710:         }
                   7711:         if (!defined($possible_status)) { 
                   7712:             $sectioncount{$section}++;
                   7713:         } else {
                   7714:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7715:                 $status = 'active';
                   7716:             } elsif ($end < $now) {
                   7717:                 $status = 'future';
                   7718:             } elsif ($start > $now) {
                   7719:                 $status = 'previous';
                   7720:             }
                   7721:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7722:                 $sectioncount{$section}++;
                   7723:             }
                   7724:         }
1.233     raeburn  7725:     }
1.366     albertel 7726:     return %sectioncount;
1.233     raeburn  7727: }
                   7728: 
1.274     raeburn  7729: ###############################################
1.294     raeburn  7730: 
                   7731: =pod
1.405     albertel 7732: 
                   7733: =item * &get_course_users()
                   7734: 
1.275     raeburn  7735: Retrieves usernames:domains for users in the specified course
                   7736: with specific role(s), and access status. 
                   7737: 
                   7738: Incoming parameters:
1.277     albertel 7739: 1. course domain
                   7740: 2. course number
                   7741: 3. access status: users must have - either active, 
1.275     raeburn  7742: previous, future, or all.
1.277     albertel 7743: 4. reference to array of permissible roles
1.288     raeburn  7744: 5. reference to array of section restrictions (optional)
                   7745: 6. reference to results object (hash of hashes).
                   7746: 7. reference to optional userdata hash
1.609     raeburn  7747: 8. reference to optional statushash
1.630     raeburn  7748: 9. flag if privileged users (except those set to unhide in
                   7749:    course settings) should be excluded    
1.609     raeburn  7750: Keys of top level results hash are roles.
1.275     raeburn  7751: Keys of inner hashes are username:domain, with 
                   7752: values set to access type.
1.288     raeburn  7753: Optional userdata hash returns an array with arguments in the 
                   7754: same order as loncoursedata::get_classlist() for student data.
                   7755: 
1.609     raeburn  7756: Optional statushash returns
                   7757: 
1.288     raeburn  7758: Entries for end, start, section and status are blank because
                   7759: of the possibility of multiple values for non-student roles.
                   7760: 
1.275     raeburn  7761: =cut
1.405     albertel 7762: 
1.275     raeburn  7763: ###############################################
1.405     albertel 7764: 
1.275     raeburn  7765: sub get_course_users {
1.630     raeburn  7766:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7767:     my %idx = ();
1.419     raeburn  7768:     my %seclists;
1.288     raeburn  7769: 
                   7770:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7771:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7772:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7773:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7774:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7775:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7776:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7777:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7778: 
1.290     albertel 7779:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7780:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7781:         my $now = time;
1.277     albertel 7782:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7783:             my $match = 0;
1.412     raeburn  7784:             my $secmatch = 0;
1.419     raeburn  7785:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7786:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7787:             if ($section eq '') {
                   7788:                 $section = 'none';
                   7789:             }
1.291     albertel 7790:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7791:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7792:                     $secmatch = 1;
                   7793:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7794:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7795:                         $secmatch = 1;
                   7796:                     }
                   7797:                 } else {  
1.419     raeburn  7798: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7799: 		        $secmatch = 1;
                   7800:                     }
1.290     albertel 7801: 		}
1.412     raeburn  7802:                 if (!$secmatch) {
                   7803:                     next;
                   7804:                 }
1.419     raeburn  7805:             }
1.275     raeburn  7806:             if (defined($$types{'active'})) {
1.288     raeburn  7807:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7808:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7809:                     $match = 1;
1.275     raeburn  7810:                 }
                   7811:             }
                   7812:             if (defined($$types{'previous'})) {
1.609     raeburn  7813:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7814:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7815:                     $match = 1;
1.275     raeburn  7816:                 }
                   7817:             }
                   7818:             if (defined($$types{'future'})) {
1.609     raeburn  7819:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7820:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7821:                     $match = 1;
1.275     raeburn  7822:                 }
                   7823:             }
1.609     raeburn  7824:             if ($match) {
                   7825:                 push(@{$seclists{$student}},$section);
                   7826:                 if (ref($userdata) eq 'HASH') {
                   7827:                     $$userdata{$student} = $$classlist{$student};
                   7828:                 }
                   7829:                 if (ref($statushash) eq 'HASH') {
                   7830:                     $statushash->{$student}{'st'}{$section} = $status;
                   7831:                 }
1.288     raeburn  7832:             }
1.275     raeburn  7833:         }
                   7834:     }
1.412     raeburn  7835:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7836:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7837:         my $now = time;
1.609     raeburn  7838:         my %displaystatus = ( previous => 'Expired',
                   7839:                               active   => 'Active',
                   7840:                               future   => 'Future',
                   7841:                             );
1.630     raeburn  7842:         my %nothide;
                   7843:         if ($hidepriv) {
                   7844:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7845:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7846:                 if ($user !~ /:/) {
                   7847:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7848:                 } else {
                   7849:                     $nothide{$user} = 1;
                   7850:                 }
                   7851:             }
                   7852:         }
1.439     raeburn  7853:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7854:             my $match = 0;
1.412     raeburn  7855:             my $secmatch = 0;
1.439     raeburn  7856:             my $status;
1.412     raeburn  7857:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7858:             $user =~ s/:$//;
1.439     raeburn  7859:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7860:             if ($end == -1 || $start == -1) {
                   7861:                 next;
                   7862:             }
                   7863:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7864:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7865:                 my ($uname,$udom) = split(/:/,$user);
                   7866:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7867:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7868:                         $secmatch = 1;
                   7869:                     } elsif ($usec eq '') {
1.420     albertel 7870:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7871:                             $secmatch = 1;
                   7872:                         }
                   7873:                     } else {
                   7874:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7875:                             $secmatch = 1;
                   7876:                         }
                   7877:                     }
                   7878:                     if (!$secmatch) {
                   7879:                         next;
                   7880:                     }
1.288     raeburn  7881:                 }
1.419     raeburn  7882:                 if ($usec eq '') {
                   7883:                     $usec = 'none';
                   7884:                 }
1.275     raeburn  7885:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7886:                     if ($hidepriv) {
                   7887:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7888:                             (!$nothide{$uname.':'.$udom})) {
                   7889:                             next;
                   7890:                         }
                   7891:                     }
1.503     raeburn  7892:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7893:                         $status = 'previous';
                   7894:                     } elsif ($start > $now) {
                   7895:                         $status = 'future';
                   7896:                     } else {
                   7897:                         $status = 'active';
                   7898:                     }
1.277     albertel 7899:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7900:                         if ($status eq $type) {
1.420     albertel 7901:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7902:                                 push(@{$$users{$role}{$user}},$type);
                   7903:                             }
1.288     raeburn  7904:                             $match = 1;
                   7905:                         }
                   7906:                     }
1.419     raeburn  7907:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7908:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7909: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7910:                         }
1.420     albertel 7911:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7912:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7913:                         }
1.609     raeburn  7914:                         if (ref($statushash) eq 'HASH') {
                   7915:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7916:                         }
1.275     raeburn  7917:                     }
                   7918:                 }
                   7919:             }
                   7920:         }
1.290     albertel 7921:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7922:             if ((defined($cdom)) && (defined($cnum))) {
                   7923:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7924:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7925:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7926:                     next if ($owner eq '');
                   7927:                     my ($ownername,$ownerdom);
                   7928:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7929:                         $ownername = $1;
                   7930:                         $ownerdom = $2;
                   7931:                     } else {
                   7932:                         $ownername = $owner;
                   7933:                         $ownerdom = $cdom;
                   7934:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7935:                     }
                   7936:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7937:                     if (defined($userdata) && 
1.609     raeburn  7938: 			!exists($$userdata{$owner})) {
                   7939: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7940:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7941:                             push(@{$seclists{$owner}},'none');
                   7942:                         }
                   7943:                         if (ref($statushash) eq 'HASH') {
                   7944:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7945:                         }
1.290     albertel 7946: 		    }
1.279     raeburn  7947:                 }
                   7948:             }
                   7949:         }
1.419     raeburn  7950:         foreach my $user (keys(%seclists)) {
                   7951:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7952:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7953:         }
1.275     raeburn  7954:     }
                   7955:     return;
                   7956: }
                   7957: 
1.288     raeburn  7958: sub get_user_info {
                   7959:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7960:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7961: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7962:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7963:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7964:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7965:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7966:     return;
                   7967: }
1.275     raeburn  7968: 
1.472     raeburn  7969: ###############################################
                   7970: 
                   7971: =pod
                   7972: 
                   7973: =item * &get_user_quota()
                   7974: 
                   7975: Retrieves quota assigned for storage of portfolio files for a user  
                   7976: 
                   7977: Incoming parameters:
                   7978: 1. user's username
                   7979: 2. user's domain
                   7980: 
                   7981: Returns:
1.536     raeburn  7982: 1. Disk quota (in Mb) assigned to student.
                   7983: 2. (Optional) Type of setting: custom or default
                   7984:    (individually assigned or default for user's 
                   7985:    institutional status).
                   7986: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7987:    or student - types as defined in localenroll::inst_usertypes 
                   7988:    for user's domain, which determines default quota for user.
                   7989: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7990: 
                   7991: If a value has been stored in the user's environment, 
1.536     raeburn  7992: it will return that, otherwise it returns the maximal default
                   7993: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7994: 
                   7995: =cut
                   7996: 
                   7997: ###############################################
                   7998: 
                   7999: 
                   8000: sub get_user_quota {
                   8001:     my ($uname,$udom) = @_;
1.536     raeburn  8002:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  8003:     if (!defined($udom)) {
                   8004:         $udom = $env{'user.domain'};
                   8005:     }
                   8006:     if (!defined($uname)) {
                   8007:         $uname = $env{'user.name'};
                   8008:     }
                   8009:     if (($udom eq '' || $uname eq '') ||
                   8010:         ($udom eq 'public') && ($uname eq 'public')) {
                   8011:         $quota = 0;
1.536     raeburn  8012:         $quotatype = 'default';
                   8013:         $defquota = 0; 
1.472     raeburn  8014:     } else {
1.536     raeburn  8015:         my $inststatus;
1.472     raeburn  8016:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   8017:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  8018:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  8019:         } else {
1.536     raeburn  8020:             my %userenv = 
                   8021:                 &Apache::lonnet::get('environment',['portfolioquota',
                   8022:                                      'inststatus'],$udom,$uname);
1.472     raeburn  8023:             my ($tmp) = keys(%userenv);
                   8024:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   8025:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  8026:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  8027:             } else {
                   8028:                 undef(%userenv);
                   8029:             }
                   8030:         }
1.536     raeburn  8031:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  8032:         if ($quota eq '') {
1.536     raeburn  8033:             $quota = $defquota;
                   8034:             $quotatype = 'default';
                   8035:         } else {
                   8036:             $quotatype = 'custom';
1.472     raeburn  8037:         }
                   8038:     }
1.536     raeburn  8039:     if (wantarray) {
                   8040:         return ($quota,$quotatype,$settingstatus,$defquota);
                   8041:     } else {
                   8042:         return $quota;
                   8043:     }
1.472     raeburn  8044: }
                   8045: 
                   8046: ###############################################
                   8047: 
                   8048: =pod
                   8049: 
                   8050: =item * &default_quota()
                   8051: 
1.536     raeburn  8052: Retrieves default quota assigned for storage of user portfolio files,
                   8053: given an (optional) user's institutional status.
1.472     raeburn  8054: 
                   8055: Incoming parameters:
                   8056: 1. domain
1.536     raeburn  8057: 2. (Optional) institutional status(es).  This is a : separated list of 
                   8058:    status types (e.g., faculty, staff, student etc.)
                   8059:    which apply to the user for whom the default is being retrieved.
                   8060:    If the institutional status string in undefined, the domain
                   8061:    default quota will be returned. 
1.472     raeburn  8062: 
                   8063: Returns:
                   8064: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  8065: 2. (Optional) institutional type which determined the value of the
                   8066:    default quota.
1.472     raeburn  8067: 
                   8068: If a value has been stored in the domain's configuration db,
                   8069: it will return that, otherwise it returns 20 (for backwards 
                   8070: compatibility with domains which have not set up a configuration
                   8071: db file; the original statically defined portfolio quota was 20 Mb). 
                   8072: 
1.536     raeburn  8073: If the user's status includes multiple types (e.g., staff and student),
                   8074: the largest default quota which applies to the user determines the
                   8075: default quota returned.
                   8076: 
1.780     raeburn  8077: =back
                   8078: 
1.472     raeburn  8079: =cut
                   8080: 
                   8081: ###############################################
                   8082: 
                   8083: 
                   8084: sub default_quota {
1.536     raeburn  8085:     my ($udom,$inststatus) = @_;
                   8086:     my ($defquota,$settingstatus);
                   8087:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  8088:                                             ['quotas'],$udom);
                   8089:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  8090:         if ($inststatus ne '') {
1.765     raeburn  8091:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  8092:             foreach my $item (@statuses) {
1.711     raeburn  8093:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   8094:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   8095:                         if ($defquota eq '') {
                   8096:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   8097:                             $settingstatus = $item;
                   8098:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   8099:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   8100:                             $settingstatus = $item;
                   8101:                         }
                   8102:                     }
                   8103:                 } else {
                   8104:                     if ($quotahash{'quotas'}{$item} ne '') {
                   8105:                         if ($defquota eq '') {
                   8106:                             $defquota = $quotahash{'quotas'}{$item};
                   8107:                             $settingstatus = $item;
                   8108:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   8109:                             $defquota = $quotahash{'quotas'}{$item};
                   8110:                             $settingstatus = $item;
                   8111:                         }
1.536     raeburn  8112:                     }
                   8113:                 }
                   8114:             }
                   8115:         }
                   8116:         if ($defquota eq '') {
1.711     raeburn  8117:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   8118:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   8119:             } else {
                   8120:                 $defquota = $quotahash{'quotas'}{'default'};
                   8121:             }
1.536     raeburn  8122:             $settingstatus = 'default';
                   8123:         }
                   8124:     } else {
                   8125:         $settingstatus = 'default';
                   8126:         $defquota = 20;
                   8127:     }
                   8128:     if (wantarray) {
                   8129:         return ($defquota,$settingstatus);
1.472     raeburn  8130:     } else {
1.536     raeburn  8131:         return $defquota;
1.472     raeburn  8132:     }
                   8133: }
                   8134: 
1.384     raeburn  8135: sub get_secgrprole_info {
                   8136:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   8137:     my %sections_count = &get_sections($cdom,$cnum);
                   8138:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   8139:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   8140:     my @groups = sort(keys(%curr_groups));
                   8141:     my $allroles = [];
                   8142:     my $rolehash;
                   8143:     my $accesshash = {
                   8144:                      active => 'Currently has access',
                   8145:                      future => 'Will have future access',
                   8146:                      previous => 'Previously had access',
                   8147:                   };
                   8148:     if ($needroles) {
                   8149:         $rolehash = {'all' => 'all'};
1.385     albertel 8150:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   8151: 	if (&Apache::lonnet::error(%user_roles)) {
                   8152: 	    undef(%user_roles);
                   8153: 	}
                   8154:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  8155:             my ($role)=split(/\:/,$item,2);
                   8156:             if ($role eq 'cr') { next; }
                   8157:             if ($role =~ /^cr/) {
                   8158:                 $$rolehash{$role} = (split('/',$role))[3];
                   8159:             } else {
                   8160:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   8161:             }
                   8162:         }
                   8163:         foreach my $key (sort(keys(%{$rolehash}))) {
                   8164:             push(@{$allroles},$key);
                   8165:         }
                   8166:         push (@{$allroles},'st');
                   8167:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   8168:     }
                   8169:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   8170: }
                   8171: 
1.555     raeburn  8172: sub user_picker {
1.994     raeburn  8173:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555     raeburn  8174:     my $currdom = $dom;
                   8175:     my %curr_selected = (
                   8176:                         srchin => 'dom',
1.580     raeburn  8177:                         srchby => 'lastname',
1.555     raeburn  8178:                       );
                   8179:     my $srchterm;
1.625     raeburn  8180:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  8181:         if ($srch->{'srchby'} ne '') {
                   8182:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   8183:         }
                   8184:         if ($srch->{'srchin'} ne '') {
                   8185:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   8186:         }
                   8187:         if ($srch->{'srchtype'} ne '') {
                   8188:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   8189:         }
                   8190:         if ($srch->{'srchdomain'} ne '') {
                   8191:             $currdom = $srch->{'srchdomain'};
                   8192:         }
                   8193:         $srchterm = $srch->{'srchterm'};
                   8194:     }
                   8195:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  8196:                     'usr'       => 'Search criteria',
1.563     raeburn  8197:                     'doma'      => 'Domain/institution to search',
1.558     albertel 8198:                     'uname'     => 'username',
                   8199:                     'lastname'  => 'last name',
1.555     raeburn  8200:                     'lastfirst' => 'last name, first name',
1.558     albertel 8201:                     'crs'       => 'in this course',
1.576     raeburn  8202:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 8203:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  8204:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 8205:                     'exact'     => 'is',
                   8206:                     'contains'  => 'contains',
1.569     raeburn  8207:                     'begins'    => 'begins with',
1.571     raeburn  8208:                     'youm'      => "You must include some text to search for.",
                   8209:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   8210:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   8211:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   8212:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   8213:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   8214:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   8215:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  8216:                                        );
1.563     raeburn  8217:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   8218:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  8219: 
                   8220:     my @srchins = ('crs','dom','alc','instd');
                   8221: 
                   8222:     foreach my $option (@srchins) {
                   8223:         # FIXME 'alc' option unavailable until 
                   8224:         #       loncreateuser::print_user_query_page()
                   8225:         #       has been completed.
                   8226:         next if ($option eq 'alc');
1.880     raeburn  8227:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  8228:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  8229:         if ($curr_selected{'srchin'} eq $option) {
                   8230:             $srchinsel .= ' 
                   8231:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8232:         } else {
                   8233:             $srchinsel .= '
                   8234:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8235:         }
1.555     raeburn  8236:     }
1.563     raeburn  8237:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  8238: 
                   8239:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  8240:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  8241:         if ($curr_selected{'srchby'} eq $option) {
                   8242:             $srchbysel .= '
                   8243:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8244:         } else {
                   8245:             $srchbysel .= '
                   8246:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8247:          }
                   8248:     }
                   8249:     $srchbysel .= "\n  </select>\n";
                   8250: 
                   8251:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  8252:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  8253:         if ($curr_selected{'srchtype'} eq $option) {
                   8254:             $srchtypesel .= '
                   8255:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8256:         } else {
                   8257:             $srchtypesel .= '
                   8258:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8259:         }
                   8260:     }
                   8261:     $srchtypesel .= "\n  </select>\n";
                   8262: 
1.558     albertel 8263:     my ($newuserscript,$new_user_create);
1.994     raeburn  8264:     my $context_dom = $env{'request.role.domain'};
                   8265:     if ($context eq 'requestcrs') {
                   8266:         if ($env{'form.coursedom'} ne '') { 
                   8267:             $context_dom = $env{'form.coursedom'};
                   8268:         }
                   8269:     }
1.556     raeburn  8270:     if ($forcenewuser) {
1.576     raeburn  8271:         if (ref($srch) eq 'HASH') {
1.994     raeburn  8272:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  8273:                 if ($cancreate) {
                   8274:                     $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>';
                   8275:                 } else {
1.799     bisitz   8276:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  8277:                     my %usertypetext = (
                   8278:                         official   => 'institutional',
                   8279:                         unofficial => 'non-institutional',
                   8280:                     );
1.799     bisitz   8281:                     $new_user_create = '<p class="LC_warning">'
                   8282:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   8283:                                       .' '
                   8284:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   8285:                                           ,'<a href="'.$helplink.'">','</a>')
                   8286:                                       .'</p><br />';
1.627     raeburn  8287:                 }
1.576     raeburn  8288:             }
                   8289:         }
                   8290: 
1.556     raeburn  8291:         $newuserscript = <<"ENDSCRIPT";
                   8292: 
1.570     raeburn  8293: function setSearch(createnew,callingForm) {
1.556     raeburn  8294:     if (createnew == 1) {
1.570     raeburn  8295:         for (var i=0; i<callingForm.srchby.length; i++) {
                   8296:             if (callingForm.srchby.options[i].value == 'uname') {
                   8297:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  8298:             }
                   8299:         }
1.570     raeburn  8300:         for (var i=0; i<callingForm.srchin.length; i++) {
                   8301:             if ( callingForm.srchin.options[i].value == 'dom') {
                   8302: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  8303:             }
                   8304:         }
1.570     raeburn  8305:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   8306:             if (callingForm.srchtype.options[i].value == 'exact') {
                   8307:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  8308:             }
                   8309:         }
1.570     raeburn  8310:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  8311:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  8312:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  8313:             }
                   8314:         }
                   8315:     }
                   8316: }
                   8317: ENDSCRIPT
1.558     albertel 8318: 
1.556     raeburn  8319:     }
                   8320: 
1.555     raeburn  8321:     my $output = <<"END_BLOCK";
1.556     raeburn  8322: <script type="text/javascript">
1.824     bisitz   8323: // <![CDATA[
1.570     raeburn  8324: function validateEntry(callingForm) {
1.558     albertel 8325: 
1.556     raeburn  8326:     var checkok = 1;
1.558     albertel 8327:     var srchin;
1.570     raeburn  8328:     for (var i=0; i<callingForm.srchin.length; i++) {
                   8329: 	if ( callingForm.srchin[i].checked ) {
                   8330: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 8331: 	}
                   8332:     }
                   8333: 
1.570     raeburn  8334:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   8335:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   8336:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   8337:     var srchterm =  callingForm.srchterm.value;
                   8338:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  8339:     var msg = "";
                   8340: 
                   8341:     if (srchterm == "") {
                   8342:         checkok = 0;
1.571     raeburn  8343:         msg += "$lt{'youm'}\\n";
1.556     raeburn  8344:     }
                   8345: 
1.569     raeburn  8346:     if (srchtype== 'begins') {
                   8347:         if (srchterm.length < 2) {
                   8348:             checkok = 0;
1.571     raeburn  8349:             msg += "$lt{'thte'}\\n";
1.569     raeburn  8350:         }
                   8351:     }
                   8352: 
1.556     raeburn  8353:     if (srchtype== 'contains') {
                   8354:         if (srchterm.length < 3) {
                   8355:             checkok = 0;
1.571     raeburn  8356:             msg += "$lt{'thet'}\\n";
1.556     raeburn  8357:         }
                   8358:     }
                   8359:     if (srchin == 'instd') {
                   8360:         if (srchdomain == '') {
                   8361:             checkok = 0;
1.571     raeburn  8362:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  8363:         }
                   8364:     }
                   8365:     if (srchin == 'dom') {
                   8366:         if (srchdomain == '') {
                   8367:             checkok = 0;
1.571     raeburn  8368:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  8369:         }
                   8370:     }
                   8371:     if (srchby == 'lastfirst') {
                   8372:         if (srchterm.indexOf(",") == -1) {
                   8373:             checkok = 0;
1.571     raeburn  8374:             msg += "$lt{'whus'}\\n";
1.556     raeburn  8375:         }
                   8376:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   8377:             checkok = 0;
1.571     raeburn  8378:             msg += "$lt{'whse'}\\n";
1.556     raeburn  8379:         }
                   8380:     }
                   8381:     if (checkok == 0) {
1.571     raeburn  8382:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  8383:         return;
                   8384:     }
                   8385:     if (checkok == 1) {
1.570     raeburn  8386:         callingForm.submit();
1.556     raeburn  8387:     }
                   8388: }
                   8389: 
                   8390: $newuserscript
                   8391: 
1.824     bisitz   8392: // ]]>
1.556     raeburn  8393: </script>
1.558     albertel 8394: 
                   8395: $new_user_create
                   8396: 
1.555     raeburn  8397: END_BLOCK
1.558     albertel 8398: 
1.876     raeburn  8399:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   8400:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   8401:                $domform.
                   8402:                &Apache::lonhtmlcommon::row_closure().
                   8403:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   8404:                $srchbysel.
                   8405:                $srchtypesel. 
                   8406:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   8407:                $srchinsel.
                   8408:                &Apache::lonhtmlcommon::row_closure(1). 
                   8409:                &Apache::lonhtmlcommon::end_pick_box().
                   8410:                '<br />';
1.555     raeburn  8411:     return $output;
                   8412: }
                   8413: 
1.612     raeburn  8414: sub user_rule_check {
1.615     raeburn  8415:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  8416:     my $response;
                   8417:     if (ref($usershash) eq 'HASH') {
                   8418:         foreach my $user (keys(%{$usershash})) {
                   8419:             my ($uname,$udom) = split(/:/,$user);
                   8420:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  8421:             my ($id,$newuser);
1.612     raeburn  8422:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  8423:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  8424:                 $id = $usershash->{$user}->{'id'};
                   8425:             }
                   8426:             my $inst_response;
                   8427:             if (ref($checks) eq 'HASH') {
                   8428:                 if (defined($checks->{'username'})) {
1.615     raeburn  8429:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  8430:                         &Apache::lonnet::get_instuser($udom,$uname);
                   8431:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  8432:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  8433:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   8434:                 }
1.615     raeburn  8435:             } else {
                   8436:                 ($inst_response,%{$inst_results->{$user}}) =
                   8437:                     &Apache::lonnet::get_instuser($udom,$uname);
                   8438:                 return;
1.612     raeburn  8439:             }
1.615     raeburn  8440:             if (!$got_rules->{$udom}) {
1.612     raeburn  8441:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   8442:                                                   ['usercreation'],$udom);
                   8443:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  8444:                     foreach my $item ('username','id') {
1.612     raeburn  8445:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   8446:                             $$curr_rules{$udom}{$item} = 
                   8447:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  8448:                         }
                   8449:                     }
                   8450:                 }
1.615     raeburn  8451:                 $got_rules->{$udom} = 1;  
1.585     raeburn  8452:             }
1.612     raeburn  8453:             foreach my $item (keys(%{$checks})) {
                   8454:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   8455:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   8456:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   8457:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   8458:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   8459:                                 if ($rule_check{$rule}) {
                   8460:                                     $$rulematch{$user}{$item} = $rule;
                   8461:                                     if ($inst_response eq 'ok') {
1.615     raeburn  8462:                                         if (ref($inst_results) eq 'HASH') {
                   8463:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   8464:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   8465:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   8466:                                                 }
1.612     raeburn  8467:                                             }
                   8468:                                         }
1.615     raeburn  8469:                                     }
                   8470:                                     last;
1.585     raeburn  8471:                                 }
                   8472:                             }
                   8473:                         }
                   8474:                     }
                   8475:                 }
                   8476:             }
                   8477:         }
                   8478:     }
1.612     raeburn  8479:     return;
                   8480: }
                   8481: 
                   8482: sub user_rule_formats {
                   8483:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   8484:     my %text = ( 
                   8485:                  'username' => 'Usernames',
                   8486:                  'id'       => 'IDs',
                   8487:                );
                   8488:     my $output;
                   8489:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   8490:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   8491:         if (@{$ruleorder} > 0) {
                   8492:             $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>';
                   8493:             foreach my $rule (@{$ruleorder}) {
                   8494:                 if (ref($curr_rules) eq 'ARRAY') {
                   8495:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   8496:                         if (ref($rules->{$rule}) eq 'HASH') {
                   8497:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   8498:                                         $rules->{$rule}{'desc'}.'</li>';
                   8499:                         }
                   8500:                     }
                   8501:                 }
                   8502:             }
                   8503:             $output .= '</ul>';
                   8504:         }
                   8505:     }
                   8506:     return $output;
                   8507: }
                   8508: 
                   8509: sub instrule_disallow_msg {
1.615     raeburn  8510:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  8511:     my $response;
                   8512:     my %text = (
                   8513:                   item   => 'username',
                   8514:                   items  => 'usernames',
                   8515:                   match  => 'matches',
                   8516:                   do     => 'does',
                   8517:                   action => 'a username',
                   8518:                   one    => 'one',
                   8519:                );
                   8520:     if ($count > 1) {
                   8521:         $text{'item'} = 'usernames';
                   8522:         $text{'match'} ='match';
                   8523:         $text{'do'} = 'do';
                   8524:         $text{'action'} = 'usernames',
                   8525:         $text{'one'} = 'ones';
                   8526:     }
                   8527:     if ($checkitem eq 'id') {
                   8528:         $text{'items'} = 'IDs';
                   8529:         $text{'item'} = 'ID';
                   8530:         $text{'action'} = 'an ID';
1.615     raeburn  8531:         if ($count > 1) {
                   8532:             $text{'item'} = 'IDs';
                   8533:             $text{'action'} = 'IDs';
                   8534:         }
1.612     raeburn  8535:     }
1.674     bisitz   8536:     $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  8537:     if ($mode eq 'upload') {
                   8538:         if ($checkitem eq 'username') {
                   8539:             $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'}.");
                   8540:         } elsif ($checkitem eq 'id') {
1.674     bisitz   8541:             $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  8542:         }
1.669     raeburn  8543:     } elsif ($mode eq 'selfcreate') {
                   8544:         if ($checkitem eq 'id') {
                   8545:             $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.");
                   8546:         }
1.615     raeburn  8547:     } else {
                   8548:         if ($checkitem eq 'username') {
                   8549:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   8550:         } elsif ($checkitem eq 'id') {
                   8551:             $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.");
                   8552:         }
1.612     raeburn  8553:     }
                   8554:     return $response;
1.585     raeburn  8555: }
                   8556: 
1.624     raeburn  8557: sub personal_data_fieldtitles {
                   8558:     my %fieldtitles = &Apache::lonlocal::texthash (
                   8559:                         id => 'Student/Employee ID',
                   8560:                         permanentemail => 'E-mail address',
                   8561:                         lastname => 'Last Name',
                   8562:                         firstname => 'First Name',
                   8563:                         middlename => 'Middle Name',
                   8564:                         generation => 'Generation',
                   8565:                         gen => 'Generation',
1.765     raeburn  8566:                         inststatus => 'Affiliation',
1.624     raeburn  8567:                    );
                   8568:     return %fieldtitles;
                   8569: }
                   8570: 
1.642     raeburn  8571: sub sorted_inst_types {
                   8572:     my ($dom) = @_;
                   8573:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   8574:     my $othertitle = &mt('All users');
                   8575:     if ($env{'request.course.id'}) {
1.668     raeburn  8576:         $othertitle  = &mt('Any users');
1.642     raeburn  8577:     }
                   8578:     my @types;
                   8579:     if (ref($order) eq 'ARRAY') {
                   8580:         @types = @{$order};
                   8581:     }
                   8582:     if (@types == 0) {
                   8583:         if (ref($usertypes) eq 'HASH') {
                   8584:             @types = sort(keys(%{$usertypes}));
                   8585:         }
                   8586:     }
                   8587:     if (keys(%{$usertypes}) > 0) {
                   8588:         $othertitle = &mt('Other users');
                   8589:     }
                   8590:     return ($othertitle,$usertypes,\@types);
                   8591: }
                   8592: 
1.645     raeburn  8593: sub get_institutional_codes {
                   8594:     my ($settings,$allcourses,$LC_code) = @_;
                   8595: # Get complete list of course sections to update
                   8596:     my @currsections = ();
                   8597:     my @currxlists = ();
                   8598:     my $coursecode = $$settings{'internal.coursecode'};
                   8599: 
                   8600:     if ($$settings{'internal.sectionnums'} ne '') {
                   8601:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   8602:     }
                   8603: 
                   8604:     if ($$settings{'internal.crosslistings'} ne '') {
                   8605:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   8606:     }
                   8607: 
                   8608:     if (@currxlists > 0) {
                   8609:         foreach (@currxlists) {
                   8610:             if (m/^([^:]+):(\w*)$/) {
                   8611:                 unless (grep/^$1$/,@{$allcourses}) {
                   8612:                     push @{$allcourses},$1;
                   8613:                     $$LC_code{$1} = $2;
                   8614:                 }
                   8615:             }
                   8616:         }
                   8617:     }
                   8618:  
                   8619:     if (@currsections > 0) {
                   8620:         foreach (@currsections) {
                   8621:             if (m/^(\w+):(\w*)$/) {
                   8622:                 my $sec = $coursecode.$1;
                   8623:                 my $lc_sec = $2;
                   8624:                 unless (grep/^$sec$/,@{$allcourses}) {
                   8625:                     push @{$allcourses},$sec;
                   8626:                     $$LC_code{$sec} = $lc_sec;
                   8627:                 }
                   8628:             }
                   8629:         }
                   8630:     }
                   8631:     return;
                   8632: }
                   8633: 
1.971     raeburn  8634: sub get_standard_codeitems {
                   8635:     return ('Year','Semester','Department','Number','Section');
                   8636: }
                   8637: 
1.112     bowersj2 8638: =pod
                   8639: 
1.780     raeburn  8640: =head1 Slot Helpers
                   8641: 
                   8642: =over 4
                   8643: 
                   8644: =item * sorted_slots()
                   8645: 
1.1040    raeburn  8646: Sorts an array of slot names in order of an optional sort key,
                   8647: default sort is by slot start time (earliest first). 
1.780     raeburn  8648: 
                   8649: Inputs:
                   8650: 
                   8651: =over 4
                   8652: 
                   8653: slotsarr  - Reference to array of unsorted slot names.
                   8654: 
                   8655: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   8656: 
1.1040    raeburn  8657: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   8658: 
1.549     albertel 8659: =back
                   8660: 
1.780     raeburn  8661: Returns:
                   8662: 
                   8663: =over 4
                   8664: 
1.1040    raeburn  8665: sorted   - An array of slot names sorted by a specified sort key 
                   8666:            (default sort key is start time of the slot).
1.780     raeburn  8667: 
                   8668: =back
                   8669: 
                   8670: =cut
                   8671: 
                   8672: 
                   8673: sub sorted_slots {
1.1040    raeburn  8674:     my ($slotsarr,$slots,$sortkey) = @_;
                   8675:     if ($sortkey eq '') {
                   8676:         $sortkey = 'starttime';
                   8677:     }
1.780     raeburn  8678:     my @sorted;
                   8679:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   8680:         @sorted =
                   8681:             sort {
                   8682:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  8683:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  8684:                      }
                   8685:                      if (ref($slots->{$a})) { return -1;}
                   8686:                      if (ref($slots->{$b})) { return 1;}
                   8687:                      return 0;
                   8688:                  } @{$slotsarr};
                   8689:     }
                   8690:     return @sorted;
                   8691: }
                   8692: 
1.1040    raeburn  8693: =pod
                   8694: 
                   8695: =item * get_future_slots()
                   8696: 
                   8697: Inputs:
                   8698: 
                   8699: =over 4
                   8700: 
                   8701: cnum - course number
                   8702: 
                   8703: cdom - course domain
                   8704: 
                   8705: now - current UNIX time
                   8706: 
                   8707: symb - optional symb
                   8708: 
                   8709: =back
                   8710: 
                   8711: Returns:
                   8712: 
                   8713: =over 4
                   8714: 
                   8715: sorted_reservable - ref to array of student_schedulable slots currently 
                   8716:                     reservable, ordered by end date of reservation period.
                   8717: 
                   8718: reservable_now - ref to hash of student_schedulable slots currently
                   8719:                  reservable.
                   8720: 
                   8721:     Keys in inner hash are:
                   8722:     (a) symb: either blank or symb to which slot use is restricted.
                   8723:     (b) endreserve: end date of reservation period. 
                   8724: 
                   8725: sorted_future - ref to array of student_schedulable slots reservable in
                   8726:                 the future, ordered by start date of reservation period.
                   8727: 
                   8728: future_reservable - ref to hash of student_schedulable slots reservable
                   8729:                     in the future.
                   8730: 
                   8731:     Keys in inner hash are:
                   8732:     (a) symb: either blank or symb to which slot use is restricted.
                   8733:     (b) startreserve:  start date of reservation period.
                   8734: 
                   8735: =back
                   8736: 
                   8737: =cut
                   8738: 
                   8739: sub get_future_slots {
                   8740:     my ($cnum,$cdom,$now,$symb) = @_;
                   8741:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   8742:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   8743:     foreach my $slot (keys(%slots)) {
                   8744:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   8745:         if ($symb) {
                   8746:             next if (($slots{$slot}->{'symb'} ne '') && 
                   8747:                      ($slots{$slot}->{'symb'} ne $symb));
                   8748:         }
                   8749:         if (($slots{$slot}->{'starttime'} > $now) &&
                   8750:             ($slots{$slot}->{'endtime'} > $now)) {
                   8751:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   8752:                 my $userallowed = 0;
                   8753:                 if ($slots{$slot}->{'allowedsections'}) {
                   8754:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   8755:                     if (!defined($env{'request.role.sec'})
                   8756:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   8757:                         $userallowed=1;
                   8758:                     } else {
                   8759:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   8760:                             $userallowed=1;
                   8761:                         }
                   8762:                     }
                   8763:                     unless ($userallowed) {
                   8764:                         if (defined($env{'request.course.groups'})) {
                   8765:                             my @groups = split(/:/,$env{'request.course.groups'});
                   8766:                             foreach my $group (@groups) {
                   8767:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   8768:                                     $userallowed=1;
                   8769:                                     last;
                   8770:                                 }
                   8771:                             }
                   8772:                         }
                   8773:                     }
                   8774:                 }
                   8775:                 if ($slots{$slot}->{'allowedusers'}) {
                   8776:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   8777:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   8778:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   8779:                         $userallowed = 1;
                   8780:                     }
                   8781:                 }
                   8782:                 next unless($userallowed);
                   8783:             }
                   8784:             my $startreserve = $slots{$slot}->{'startreserve'};
                   8785:             my $endreserve = $slots{$slot}->{'endreserve'};
                   8786:             my $symb = $slots{$slot}->{'symb'};
                   8787:             if (($startreserve < $now) &&
                   8788:                 (!$endreserve || $endreserve > $now)) {
                   8789:                 my $lastres = $endreserve;
                   8790:                 if (!$lastres) {
                   8791:                     $lastres = $slots{$slot}->{'starttime'};
                   8792:                 }
                   8793:                 $reservable_now{$slot} = {
                   8794:                                            symb       => $symb,
                   8795:                                            endreserve => $lastres
                   8796:                                          };
                   8797:             } elsif (($startreserve > $now) &&
                   8798:                      (!$endreserve || $endreserve > $startreserve)) {
                   8799:                 $future_reservable{$slot} = {
                   8800:                                               symb         => $symb,
                   8801:                                               startreserve => $startreserve
                   8802:                                             };
                   8803:             }
                   8804:         }
                   8805:     }
                   8806:     my @unsorted_reservable = keys(%reservable_now);
                   8807:     if (@unsorted_reservable > 0) {
                   8808:         @sorted_reservable = 
                   8809:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   8810:     }
                   8811:     my @unsorted_future = keys(%future_reservable);
                   8812:     if (@unsorted_future > 0) {
                   8813:         @sorted_future =
                   8814:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   8815:     }
                   8816:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   8817: }
1.780     raeburn  8818: 
                   8819: =pod
                   8820: 
1.549     albertel 8821: =head1 HTTP Helpers
                   8822: 
                   8823: =over 4
                   8824: 
1.648     raeburn  8825: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 8826: 
1.258     albertel 8827: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8828: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8829: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8830: 
                   8831: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8832: $possible_names is an ref to an array of form element names.  As an example:
                   8833: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8834: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8835: 
                   8836: =cut
1.1       albertel 8837: 
1.6       albertel 8838: sub get_unprocessed_cgi {
1.25      albertel 8839:   my ($query,$possible_names)= @_;
1.26      matthew  8840:   # $Apache::lonxml::debug=1;
1.356     albertel 8841:   foreach my $pair (split(/&/,$query)) {
                   8842:     my ($name, $value) = split(/=/,$pair);
1.369     www      8843:     $name = &unescape($name);
1.25      albertel 8844:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8845:       $value =~ tr/+/ /;
                   8846:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8847:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8848:     }
1.16      harris41 8849:   }
1.6       albertel 8850: }
                   8851: 
1.112     bowersj2 8852: =pod
                   8853: 
1.648     raeburn  8854: =item * &cacheheader() 
1.112     bowersj2 8855: 
                   8856: returns cache-controlling header code
                   8857: 
                   8858: =cut
                   8859: 
1.7       albertel 8860: sub cacheheader {
1.258     albertel 8861:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8862:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8863:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8864:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8865:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8866:     return $output;
1.7       albertel 8867: }
                   8868: 
1.112     bowersj2 8869: =pod
                   8870: 
1.648     raeburn  8871: =item * &no_cache($r) 
1.112     bowersj2 8872: 
                   8873: specifies header code to not have cache
                   8874: 
                   8875: =cut
                   8876: 
1.9       albertel 8877: sub no_cache {
1.216     albertel 8878:     my ($r) = @_;
                   8879:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8880: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8881:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8882:     $r->no_cache(1);
                   8883:     $r->header_out("Expires" => $date);
                   8884:     $r->header_out("Pragma" => "no-cache");
1.123     www      8885: }
                   8886: 
                   8887: sub content_type {
1.181     albertel 8888:     my ($r,$type,$charset) = @_;
1.299     foxr     8889:     if ($r) {
                   8890: 	#  Note that printout.pl calls this with undef for $r.
                   8891: 	&no_cache($r);
                   8892:     }
1.258     albertel 8893:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8894:     unless ($charset) {
                   8895: 	$charset=&Apache::lonlocal::current_encoding;
                   8896:     }
                   8897:     if ($charset) { $type.='; charset='.$charset; }
                   8898:     if ($r) {
                   8899: 	$r->content_type($type);
                   8900:     } else {
                   8901: 	print("Content-type: $type\n\n");
                   8902:     }
1.9       albertel 8903: }
1.25      albertel 8904: 
1.112     bowersj2 8905: =pod
                   8906: 
1.648     raeburn  8907: =item * &add_to_env($name,$value) 
1.112     bowersj2 8908: 
1.258     albertel 8909: adds $name to the %env hash with value
1.112     bowersj2 8910: $value, if $name already exists, the entry is converted to an array
                   8911: reference and $value is added to the array.
                   8912: 
                   8913: =cut
                   8914: 
1.25      albertel 8915: sub add_to_env {
                   8916:   my ($name,$value)=@_;
1.258     albertel 8917:   if (defined($env{$name})) {
                   8918:     if (ref($env{$name})) {
1.25      albertel 8919:       #already have multiple values
1.258     albertel 8920:       push(@{ $env{$name} },$value);
1.25      albertel 8921:     } else {
                   8922:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8923:       my $first=$env{$name};
                   8924:       undef($env{$name});
                   8925:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8926:     }
                   8927:   } else {
1.258     albertel 8928:     $env{$name}=$value;
1.25      albertel 8929:   }
1.31      albertel 8930: }
1.149     albertel 8931: 
                   8932: =pod
                   8933: 
1.648     raeburn  8934: =item * &get_env_multiple($name) 
1.149     albertel 8935: 
1.258     albertel 8936: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8937: values may be defined and end up as an array ref.
                   8938: 
                   8939: returns an array of values
                   8940: 
                   8941: =cut
                   8942: 
                   8943: sub get_env_multiple {
                   8944:     my ($name) = @_;
                   8945:     my @values;
1.258     albertel 8946:     if (defined($env{$name})) {
1.149     albertel 8947:         # exists is it an array
1.258     albertel 8948:         if (ref($env{$name})) {
                   8949:             @values=@{ $env{$name} };
1.149     albertel 8950:         } else {
1.258     albertel 8951:             $values[0]=$env{$name};
1.149     albertel 8952:         }
                   8953:     }
                   8954:     return(@values);
                   8955: }
                   8956: 
1.660     raeburn  8957: sub ask_for_embedded_content {
                   8958:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.987     raeburn  8959:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges);
1.660     raeburn  8960:     my $num = 0;
1.987     raeburn  8961:     my $numremref = 0;
                   8962:     my $numinvalid = 0;
                   8963:     my $numpathchg = 0;
                   8964:     my $numexisting = 0;
                   8965:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath);
1.984     raeburn  8966:     if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   8967:         my $current_path='/';
                   8968:         if ($env{'form.currentpath'}) {
                   8969:             $current_path = $env{'form.currentpath'};
                   8970:         }
                   8971:         if ($actionurl eq '/adm/coursegrp_portfolio') {
                   8972:             $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8973:             $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
                   8974:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   8975:         } else {
                   8976:             $udom = $env{'user.domain'};
                   8977:             $uname = $env{'user.name'};
                   8978:             $url = '/userfiles/portfolio';
                   8979:         }
1.987     raeburn  8980:         $toplevel = $url.'/';
1.984     raeburn  8981:         $url .= $current_path;
                   8982:         $getpropath = 1;
1.987     raeburn  8983:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   8984:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      8985:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  8986:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  8987:         $toplevel = $url;
1.984     raeburn  8988:         if ($rest ne '') {
1.987     raeburn  8989:             $url .= $rest;
                   8990:         }
                   8991:     } elsif ($actionurl eq '/adm/coursedocs') {
                   8992:         if (ref($args) eq 'HASH') {
                   8993:            $url = $args->{'docs_url'};
                   8994:            $toplevel = $url;
                   8995:         }
                   8996:     }
                   8997:     my $now = time();
                   8998:     foreach my $embed_file (keys(%{$allfiles})) {
                   8999:         my $absolutepath;
                   9000:         if ($embed_file =~ m{^\w+://}) {
                   9001:             $newfiles{$embed_file} = 1;
                   9002:             $mapping{$embed_file} = $embed_file;
                   9003:         } else {
                   9004:             if ($embed_file =~ m{^/}) {
                   9005:                 $absolutepath = $embed_file;
                   9006:                 $embed_file =~ s{^(/+)}{};
                   9007:             }
                   9008:             if ($embed_file =~ m{/}) {
                   9009:                 my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
                   9010:                 $path = &check_for_traversal($path,$url,$toplevel);
                   9011:                 my $item = $fname;
                   9012:                 if ($path ne '') {
                   9013:                     $item = $path.'/'.$fname;
                   9014:                     $subdependencies{$path}{$fname} = 1;
                   9015:                 } else {
                   9016:                     $dependencies{$item} = 1;
                   9017:                 }
                   9018:                 if ($absolutepath) {
                   9019:                     $mapping{$item} = $absolutepath;
                   9020:                 } else {
                   9021:                     $mapping{$item} = $embed_file;
                   9022:                 }
                   9023:             } else {
                   9024:                 $dependencies{$embed_file} = 1;
                   9025:                 if ($absolutepath) {
                   9026:                     $mapping{$embed_file} = $absolutepath;
                   9027:                 } else {
                   9028:                     $mapping{$embed_file} = $embed_file;
                   9029:                 }
                   9030:             }
1.984     raeburn  9031:         }
                   9032:     }
                   9033:     foreach my $path (keys(%subdependencies)) {
                   9034:         my %currsubfile;
                   9035:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  9036:             my ($sublistref,$listerror) =
                   9037:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   9038:             if (ref($sublistref) eq 'ARRAY') {
                   9039:                 foreach my $line (@{$sublistref}) {
                   9040:                     my ($file_name,$rest) = split(/\&/,$line,2);
                   9041:                     $currsubfile{$file_name} = 1;
                   9042:                 }
1.984     raeburn  9043:             }
1.987     raeburn  9044:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  9045:             if (opendir(my $dir,$url.'/'.$path)) {
                   9046:                 my @subdir_list = grep(!/^\./,readdir($dir));
                   9047:                 map {$currsubfile{$_} = 1;} @subdir_list;
                   9048:             }
                   9049:         }
                   9050:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.987     raeburn  9051:             if ($currsubfile{$file}) {
                   9052:                 my $item = $path.'/'.$file;
                   9053:                 unless ($mapping{$item} eq $item) {
                   9054:                     $pathchanges{$item} = 1;
                   9055:                 }
                   9056:                 $existing{$item} = 1;
                   9057:                 $numexisting ++;
                   9058:             } else {
                   9059:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  9060:             }
                   9061:         }
                   9062:     }
1.987     raeburn  9063:     my %currfile;
1.984     raeburn  9064:     if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  9065:         my ($dirlistref,$listerror) =
                   9066:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   9067:         if (ref($dirlistref) eq 'ARRAY') {
                   9068:             foreach my $line (@{$dirlistref}) {
                   9069:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   9070:                 $currfile{$file_name} = 1;
                   9071:             }
1.984     raeburn  9072:         }
1.987     raeburn  9073:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  9074:         if (opendir(my $dir,$url)) {
1.987     raeburn  9075:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  9076:             map {$currfile{$_} = 1;} @dir_list;
                   9077:         }
                   9078:     }
                   9079:     foreach my $file (keys(%dependencies)) {
1.987     raeburn  9080:         if ($currfile{$file}) {
                   9081:             unless ($mapping{$file} eq $file) {
                   9082:                 $pathchanges{$file} = 1;
                   9083:             }
                   9084:             $existing{$file} = 1;
                   9085:             $numexisting ++;
                   9086:         } else {
1.984     raeburn  9087:             $newfiles{$file} = 1;
                   9088:         }
                   9089:     }
                   9090:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.660     raeburn  9091:         $upload_output .= &start_data_table_row().
1.987     raeburn  9092:                           '<td><span class="LC_filename">'.$embed_file.'</span>';
                   9093:         unless ($mapping{$embed_file} eq $embed_file) {
                   9094:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
                   9095:         }
                   9096:         $upload_output .= '</td><td>';
1.660     raeburn  9097:         if ($args->{'ignore_remote_references'}
                   9098:             && $embed_file =~ m{^\w+://}) {
                   9099:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987     raeburn  9100:             $numremref++;
1.660     raeburn  9101:         } elsif ($args->{'error_on_invalid_names'}
                   9102:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   9103: 
1.987     raeburn  9104:             $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
                   9105:             $numinvalid++;
1.660     raeburn  9106:         } else {
1.987     raeburn  9107:             $upload_output .= &embedded_file_element('upload_embedded',$num,
                   9108:                                                      $embed_file,\%mapping,
                   9109:                                                      $allfiles,$codebase);
                   9110:             $num++;
                   9111:         }
                   9112:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   9113:     }
                   9114:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
                   9115:         $upload_output .= &start_data_table_row().
                   9116:                           '<td><span class="LC_filename">'.$embed_file.'</span></td>'.
                   9117:                           '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
                   9118:                           &Apache::loncommon::end_data_table_row()."\n";
                   9119:     }
                   9120:     if ($upload_output) {
                   9121:         $upload_output = &start_data_table().
                   9122:                          $upload_output.
                   9123:                          &end_data_table()."\n";
                   9124:     }
                   9125:     my $applies = 0;
                   9126:     if ($numremref) {
                   9127:         $applies ++;
                   9128:     }
                   9129:     if ($numinvalid) {
                   9130:         $applies ++;
                   9131:     }
                   9132:     if ($numexisting) {
                   9133:         $applies ++;
                   9134:     }
                   9135:     if ($num) {
                   9136:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   9137:                   ' method="post" enctype="multipart/form-data">'."\n".
                   9138:                   $state.
                   9139:                   '<h3>'.&mt('Upload embedded files').
                   9140:                   ':</h3>'.$upload_output.'<br />'."\n".
                   9141:                   '<input type ="hidden" name="number_embedded_items" value="'.
                   9142:                   $num.'" />'."\n";
                   9143:         if ($actionurl eq '') {
                   9144:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   9145:         }
                   9146:     } elsif ($applies) {
                   9147:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   9148:         if ($applies > 1) {
                   9149:             $output .=  
                   9150:                 &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
                   9151:             if ($numremref) {
                   9152:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   9153:             }
                   9154:             if ($numinvalid) {
                   9155:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   9156:             }
                   9157:             if ($numexisting) {
                   9158:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   9159:             }
                   9160:             $output .= '</ul><br />';
                   9161:         } elsif ($numremref) {
                   9162:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   9163:         } elsif ($numinvalid) {
                   9164:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   9165:         } elsif ($numexisting) {
                   9166:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   9167:         }
                   9168:         $output .= $upload_output.'<br />';
                   9169:     }
                   9170:     my ($pathchange_output,$chgcount);
                   9171:     $chgcount = $num;
                   9172:     if (keys(%pathchanges) > 0) {
                   9173:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
                   9174:             if ($num) {
                   9175:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   9176:                                                   $embed_file,\%mapping,
                   9177:                                                   $allfiles,$codebase);
                   9178:             } else {
                   9179:                 $pathchange_output .= 
                   9180:                     &start_data_table_row().
                   9181:                     '<td><input type ="checkbox" name="namechange" value="'.
                   9182:                     $chgcount.'" checked="checked" /></td>'.
                   9183:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   9184:                     '<td>'.$embed_file.
                   9185:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
                   9186:                                            \%mapping,$allfiles,$codebase).
                   9187:                     '</td>'.&end_data_table_row();
1.660     raeburn  9188:             }
1.987     raeburn  9189:             $numpathchg ++;
                   9190:             $chgcount ++;
1.660     raeburn  9191:         }
                   9192:     }
1.984     raeburn  9193:     if ($num) {
1.987     raeburn  9194:         if ($numpathchg) {
                   9195:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   9196:                        $numpathchg.'" />'."\n";
                   9197:         }
                   9198:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   9199:             ($actionurl eq '/adm/imsimport')) {
                   9200:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   9201:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   9202:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
                   9203:         }
                   9204:         $output .=  '<input type ="submit" value="'.&mt('Upload Listed Files').'" />'."\n".
                   9205:                     &mt('(only files for which a location has been provided will be uploaded)').'</form>'."\n";
                   9206:     } elsif ($numpathchg) {
                   9207:         my %pathchange = ();
                   9208:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   9209:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   9210:             $output .= '<p>'.&mt('or').'</p>'; 
                   9211:         } 
                   9212:     }
                   9213:     return ($output,$num,$numpathchg);
                   9214: }
                   9215: 
                   9216: sub embedded_file_element {
                   9217:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase) = @_;
                   9218:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   9219:                    (ref($codebase) eq 'HASH'));
                   9220:     my $output;
                   9221:     if ($context eq 'upload_embedded') {
                   9222:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   9223:     }
                   9224:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   9225:                &escape($embed_file).'" />';
                   9226:     unless (($context eq 'upload_embedded') && 
                   9227:             ($mapping->{$embed_file} eq $embed_file)) {
                   9228:         $output .='
                   9229:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   9230:     }
                   9231:     my $attrib;
                   9232:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   9233:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   9234:     }
                   9235:     $output .=
                   9236:         "\n\t\t".
                   9237:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   9238:         $attrib.'" />';
                   9239:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   9240:         $output .=
                   9241:             "\n\t\t".
                   9242:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   9243:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  9244:     }
1.987     raeburn  9245:     return $output;
1.660     raeburn  9246: }
                   9247: 
1.661     raeburn  9248: sub upload_embedded {
                   9249:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  9250:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   9251:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  9252:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   9253:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   9254:         my $orig_uploaded_filename =
                   9255:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  9256:         foreach my $type ('orig','ref','attrib','codebase') {
                   9257:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   9258:                 $env{'form.embedded_'.$type.'_'.$i} =
                   9259:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   9260:             }
                   9261:         }
1.661     raeburn  9262:         my ($path,$fname) =
                   9263:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   9264:         # no path, whole string is fname
                   9265:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   9266:         $fname = &Apache::lonnet::clean_filename($fname);
                   9267:         # See if there is anything left
                   9268:         next if ($fname eq '');
                   9269: 
                   9270:         # Check if file already exists as a file or directory.
                   9271:         my ($state,$msg);
                   9272:         if ($context eq 'portfolio') {
                   9273:             my $port_path = $dirpath;
                   9274:             if ($group ne '') {
                   9275:                 $port_path = "groups/$group/$port_path";
                   9276:             }
1.987     raeburn  9277:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   9278:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  9279:                                               $dir_root,$port_path,$disk_quota,
                   9280:                                               $current_disk_usage,$uname,$udom);
                   9281:             if ($state eq 'will_exceed_quota'
1.984     raeburn  9282:                 || $state eq 'file_locked') {
1.661     raeburn  9283:                 $output .= $msg;
                   9284:                 next;
                   9285:             }
                   9286:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   9287:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   9288:             if ($state eq 'exists') {
                   9289:                 $output .= $msg;
                   9290:                 next;
                   9291:             }
                   9292:         }
                   9293:         # Check if extension is valid
                   9294:         if (($fname =~ /\.(\w+)$/) &&
                   9295:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987     raeburn  9296:             $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  9297:             next;
                   9298:         } elsif (($fname =~ /\.(\w+)$/) &&
                   9299:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  9300:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  9301:             next;
                   9302:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987     raeburn  9303:             $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  9304:             next;
                   9305:         }
                   9306: 
                   9307:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   9308:         if ($context eq 'portfolio') {
1.984     raeburn  9309:             my $result;
                   9310:             if ($state eq 'existingfile') {
                   9311:                 $result=
                   9312:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987     raeburn  9313:                                                     $dirpath.$env{'form.currentpath'}.$path);
1.661     raeburn  9314:             } else {
1.984     raeburn  9315:                 $result=
                   9316:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  9317:                                                     $dirpath.
                   9318:                                                     $env{'form.currentpath'}.$path);
1.984     raeburn  9319:                 if ($result !~ m|^/uploaded/|) {
                   9320:                     $output .= '<span class="LC_error">'
                   9321:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   9322:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   9323:                                .'</span><br />';
                   9324:                     next;
                   9325:                 } else {
1.987     raeburn  9326:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9327:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  9328:                 }
1.661     raeburn  9329:             }
1.987     raeburn  9330:         } elsif ($context eq 'coursedoc') {
                   9331:             my $result =
                   9332:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
                   9333:                                                 $dirpath.'/'.$path);
                   9334:             if ($result !~ m|^/uploaded/|) {
                   9335:                 $output .= '<span class="LC_error">'
                   9336:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   9337:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   9338:                            .'</span><br />';
                   9339:                     next;
                   9340:             } else {
                   9341:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9342:                            $path.$fname.'</span>').'<br />';
                   9343:             }
1.661     raeburn  9344:         } else {
                   9345: # Save the file
                   9346:             my $target = $env{'form.embedded_item_'.$i};
                   9347:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   9348:             my $dest = $fullpath.$fname;
                   9349:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  9350:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  9351:             my $count;
                   9352:             my $filepath = $dir_root;
1.1027    raeburn  9353:             foreach my $subdir (@parts) {
                   9354:                 $filepath .= "/$subdir";
                   9355:                 if (!-e $filepath) {
1.661     raeburn  9356:                     mkdir($filepath,0770);
                   9357:                 }
                   9358:             }
                   9359:             my $fh;
                   9360:             if (!open($fh,'>'.$dest)) {
                   9361:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   9362:                 $output .= '<span class="LC_error">'.
                   9363:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   9364:                            '</span><br />';
                   9365:             } else {
                   9366:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   9367:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   9368:                     $output .= '<span class="LC_error">'.
                   9369:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   9370:                               '</span><br />';
                   9371:                 } else {
1.987     raeburn  9372:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9373:                                $url.'</span>').'<br />';
                   9374:                     unless ($context eq 'testbank') {
                   9375:                         $footer .= &mt('View embedded file: [_1]',
                   9376:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   9377:                     }
                   9378:                 }
                   9379:                 close($fh);
                   9380:             }
                   9381:         }
                   9382:         if ($env{'form.embedded_ref_'.$i}) {
                   9383:             $pathchange{$i} = 1;
                   9384:         }
                   9385:     }
                   9386:     if ($output) {
                   9387:         $output = '<p>'.$output.'</p>';
                   9388:     }
                   9389:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   9390:     $returnflag = 'ok';
                   9391:     if (keys(%pathchange) > 0) {
                   9392:         if ($context eq 'portfolio') {
                   9393:             $output .= '<p>'.&mt('or').'</p>';
                   9394:         } elsif ($context eq 'testbank') {
1.988     raeburn  9395:             $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  9396:             $returnflag = 'modify_orightml';
                   9397:         }
                   9398:     }
                   9399:     return ($output.$footer,$returnflag);
                   9400: }
                   9401: 
                   9402: sub modify_html_form {
                   9403:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   9404:     my $end = 0;
                   9405:     my $modifyform;
                   9406:     if ($context eq 'upload_embedded') {
                   9407:         return unless (ref($pathchange) eq 'HASH');
                   9408:         if ($env{'form.number_embedded_items'}) {
                   9409:             $end += $env{'form.number_embedded_items'};
                   9410:         }
                   9411:         if ($env{'form.number_pathchange_items'}) {
                   9412:             $end += $env{'form.number_pathchange_items'};
                   9413:         }
                   9414:         if ($end) {
                   9415:             for (my $i=0; $i<$end; $i++) {
                   9416:                 if ($i < $env{'form.number_embedded_items'}) {
                   9417:                     next unless($pathchange->{$i});
                   9418:                 }
                   9419:                 $modifyform .=
                   9420:                     &start_data_table_row().
                   9421:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   9422:                     'checked="checked" /></td>'.
                   9423:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   9424:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   9425:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   9426:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   9427:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   9428:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   9429:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   9430:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   9431:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   9432:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   9433:                     &end_data_table_row();
                   9434:             } 
                   9435:         }
                   9436:     } else {
                   9437:         $modifyform = $pathchgtable;
                   9438:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   9439:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   9440:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   9441:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   9442:         }
                   9443:     }
                   9444:     if ($modifyform) {
                   9445:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   9446:                '<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".
                   9447:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   9448:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   9449:                '</ol></p>'."\n".'<p>'.
                   9450:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   9451:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   9452:                &start_data_table()."\n".
                   9453:                &start_data_table_header_row().
                   9454:                '<th>'.&mt('Change?').'</th>'.
                   9455:                '<th>'.&mt('Current reference').'</th>'.
                   9456:                '<th>'.&mt('Required reference').'</th>'.
                   9457:                &end_data_table_header_row()."\n".
                   9458:                $modifyform.
                   9459:                &end_data_table().'<br />'."\n".$hiddenstate.
                   9460:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   9461:                '</form>'."\n";
                   9462:     }
                   9463:     return;
                   9464: }
                   9465: 
                   9466: sub modify_html_refs {
                   9467:     my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
                   9468:     my $container;
                   9469:     if ($context eq 'portfolio') {
                   9470:         $container = $env{'form.container'};
                   9471:     } elsif ($context eq 'coursedoc') {
                   9472:         $container = $env{'form.primaryurl'};
                   9473:     } else {
1.1027    raeburn  9474:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  9475:     }
                   9476:     my (%allfiles,%codebase,$output,$content);
                   9477:     my @changes = &get_env_multiple('form.namechange');
                   9478:     return unless (@changes > 0);
                   9479:     if (($context eq 'portfolio') || ($context eq 'coursedoc')) {
                   9480:         return unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/});
                   9481:         $content = &Apache::lonnet::getfile($container);
                   9482:         return if ($content eq '-1');
                   9483:     } else {
                   9484:         return unless ($container =~ /^\Q$dir_root\E/); 
                   9485:         if (open(my $fh,"<$container")) {
                   9486:             $content = join('', <$fh>);
                   9487:             close($fh);
                   9488:         } else {
                   9489:             return;
                   9490:         }
                   9491:     }
                   9492:     my ($count,$codebasecount) = (0,0);
                   9493:     my $mm = new File::MMagic;
                   9494:     my $mime_type = $mm->checktype_contents($content);
                   9495:     if ($mime_type eq 'text/html') {
                   9496:         my $parse_result = 
                   9497:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   9498:                                                     \%codebase,\$content);
                   9499:         if ($parse_result eq 'ok') {
                   9500:             foreach my $i (@changes) {
                   9501:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   9502:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   9503:                 if ($allfiles{$ref}) {
                   9504:                     my $newname =  $orig;
                   9505:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  9506:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  9507:                     if ($attrib_regexp =~ /:/) {
                   9508:                         $attrib_regexp =~ s/\:/|/g;
                   9509:                     }
                   9510:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   9511:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   9512:                         $count += $numchg;
                   9513:                     }
                   9514:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  9515:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  9516:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   9517:                         $codebasecount ++;
                   9518:                     }
                   9519:                 }
                   9520:             }
                   9521:             if ($count || $codebasecount) {
                   9522:                 my $saveresult;
                   9523:                 if ($context eq 'portfolio' || $context eq 'coursedoc') {
                   9524:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   9525:                     if ($url eq $container) {
                   9526:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   9527:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   9528:                                             $count,'<span class="LC_filename">'.
                   9529:                                             $fname.'</span>').'</p>'; 
                   9530:                     } else {
                   9531:                          $output = '<p class="LC_error">'.
                   9532:                                    &mt('Error: update failed for: [_1].',
                   9533:                                    '<span class="LC_filename">'.
                   9534:                                    $container.'</span>').'</p>';
                   9535:                     }
                   9536:                 } else {
                   9537:                     if (open(my $fh,">$container")) {
                   9538:                         print $fh $content;
                   9539:                         close($fh);
                   9540:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   9541:                                   $count,'<span class="LC_filename">'.
                   9542:                                   $container.'</span>').'</p>';
1.661     raeburn  9543:                     } else {
1.987     raeburn  9544:                          $output = '<p class="LC_error">'.
                   9545:                                    &mt('Error: could not update [_1].',
                   9546:                                    '<span class="LC_filename">'.
                   9547:                                    $container.'</span>').'</p>';
1.661     raeburn  9548:                     }
                   9549:                 }
                   9550:             }
1.987     raeburn  9551:         } else {
                   9552:             &logthis('Failed to parse '.$container.
                   9553:                      ' to modify references: '.$parse_result);
1.661     raeburn  9554:         }
                   9555:     }
                   9556:     return $output;
                   9557: }
                   9558: 
                   9559: sub check_for_existing {
                   9560:     my ($path,$fname,$element) = @_;
                   9561:     my ($state,$msg);
                   9562:     if (-d $path.'/'.$fname) {
                   9563:         $state = 'exists';
                   9564:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   9565:     } elsif (-e $path.'/'.$fname) {
                   9566:         $state = 'exists';
                   9567:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   9568:     }
                   9569:     if ($state eq 'exists') {
                   9570:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   9571:     }
                   9572:     return ($state,$msg);
                   9573: }
                   9574: 
                   9575: sub check_for_upload {
                   9576:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   9577:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  9578:     my $filesize = length($env{'form.'.$element});
                   9579:     if (!$filesize) {
                   9580:         my $msg = '<span class="LC_error">'.
                   9581:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   9582:                       '<span class="LC_filename">'.$fname.'</span>',
                   9583:                       $filesize).'<br />'.
1.1007    raeburn  9584:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  9585:                   '</span>';
                   9586:         return ('zero_bytes',$msg);
                   9587:     }
                   9588:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  9589:     my $getpropath = 1;
1.1021    raeburn  9590:     my ($dirlistref,$listerror) =
                   9591:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  9592:     my $found_file = 0;
                   9593:     my $locked_file = 0;
1.991     raeburn  9594:     my @lockers;
                   9595:     my $navmap;
                   9596:     if ($env{'request.course.id'}) {
                   9597:         $navmap = Apache::lonnavmaps::navmap->new();
                   9598:     }
1.1021    raeburn  9599:     if (ref($dirlistref) eq 'ARRAY') {
                   9600:         foreach my $line (@{$dirlistref}) {
                   9601:             my ($file_name,$rest)=split(/\&/,$line,2);
                   9602:             if ($file_name eq $fname){
                   9603:                 $file_name = $path.$file_name;
                   9604:                 if ($group ne '') {
                   9605:                     $file_name = $group.$file_name;
                   9606:                 }
                   9607:                 $found_file = 1;
                   9608:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   9609:                     foreach my $lock (@lockers) {
                   9610:                         if (ref($lock) eq 'ARRAY') {
                   9611:                             my ($symb,$crsid) = @{$lock};
                   9612:                             if ($crsid eq $env{'request.course.id'}) {
                   9613:                                 if (ref($navmap)) {
                   9614:                                     my $res = $navmap->getBySymb($symb);
                   9615:                                     foreach my $part (@{$res->parts()}) { 
                   9616:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   9617:                                         unless (($slot_status == $res->RESERVED) ||
                   9618:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   9619:                                             $locked_file = 1;
                   9620:                                         }
1.991     raeburn  9621:                                     }
1.1021    raeburn  9622:                                 } else {
                   9623:                                     $locked_file = 1;
1.991     raeburn  9624:                                 }
                   9625:                             } else {
                   9626:                                 $locked_file = 1;
                   9627:                             }
                   9628:                         }
1.1021    raeburn  9629:                    }
                   9630:                 } else {
                   9631:                     my @info = split(/\&/,$rest);
                   9632:                     my $currsize = $info[6]/1000;
                   9633:                     if ($currsize < $filesize) {
                   9634:                         my $extra = $filesize - $currsize;
                   9635:                         if (($current_disk_usage + $extra) > $disk_quota) {
                   9636:                             my $msg = '<span class="LC_error">'.
                   9637:                                       &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.',
                   9638:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
                   9639:                                       '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   9640:                                                    $disk_quota,$current_disk_usage);
                   9641:                             return ('will_exceed_quota',$msg);
                   9642:                         }
1.984     raeburn  9643:                     }
                   9644:                 }
1.661     raeburn  9645:             }
                   9646:         }
                   9647:     }
                   9648:     if (($current_disk_usage + $filesize) > $disk_quota){
                   9649:         my $msg = '<span class="LC_error">'.
                   9650:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   9651:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   9652:         return ('will_exceed_quota',$msg);
                   9653:     } elsif ($found_file) {
                   9654:         if ($locked_file) {
                   9655:             my $msg = '<span class="LC_error">';
                   9656:             $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>');
                   9657:             $msg .= '</span><br />';
                   9658:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   9659:             return ('file_locked',$msg);
                   9660:         } else {
                   9661:             my $msg = '<span class="LC_error">';
1.984     raeburn  9662:             $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  9663:             $msg .= '</span>';
1.984     raeburn  9664:             return ('existingfile',$msg);
1.661     raeburn  9665:         }
                   9666:     }
                   9667: }
                   9668: 
1.987     raeburn  9669: sub check_for_traversal {
                   9670:     my ($path,$url,$toplevel) = @_;
                   9671:     my @parts=split(/\//,$path);
                   9672:     my $cleanpath;
                   9673:     my $fullpath = $url;
                   9674:     for (my $i=0;$i<@parts;$i++) {
                   9675:         next if ($parts[$i] eq '.');
                   9676:         if ($parts[$i] eq '..') {
                   9677:             $fullpath =~ s{([^/]+/)$}{};
                   9678:         } else {
                   9679:             $fullpath .= $parts[$i].'/';
                   9680:         }
                   9681:     }
                   9682:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   9683:         $cleanpath = $1;
                   9684:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   9685:         my $curr_toprel = $1;
                   9686:         my @parts = split(/\//,$curr_toprel);
                   9687:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   9688:         my @urlparts = split(/\//,$url_toprel);
                   9689:         my $doubledots;
                   9690:         my $startdiff = -1;
                   9691:         for (my $i=0; $i<@urlparts; $i++) {
                   9692:             if ($startdiff == -1) {
                   9693:                 unless ($urlparts[$i] eq $parts[$i]) {
                   9694:                     $startdiff = $i;
                   9695:                     $doubledots .= '../';
                   9696:                 }
                   9697:             } else {
                   9698:                 $doubledots .= '../';
                   9699:             }
                   9700:         }
                   9701:         if ($startdiff > -1) {
                   9702:             $cleanpath = $doubledots;
                   9703:             for (my $i=$startdiff; $i<@parts; $i++) {
                   9704:                 $cleanpath .= $parts[$i].'/';
                   9705:             }
                   9706:         }
                   9707:     }
                   9708:     $cleanpath =~ s{(/)$}{};
                   9709:     return $cleanpath;
                   9710: }
1.31      albertel 9711: 
1.41      ng       9712: =pod
1.45      matthew  9713: 
1.1015    raeburn  9714: =item * &get_turnedin_filepath()
                   9715: 
                   9716: Determines path in a user's portfolio file for storage of files uploaded
                   9717: to a specific essayresponse or dropbox item.
                   9718: 
                   9719: Inputs: 3 required + 1 optional.
                   9720: $symb is symb for resource, $uname and $udom are for current user (required).
                   9721: $caller is optional (can be "submission", if routine is called when storing
                   9722: an upoaded file when "Submit Answer" button was pressed).
                   9723: 
                   9724: Returns array containing $path and $multiresp. 
                   9725: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   9726: than one file upload item.  Callers of routine should append partid as a 
                   9727: subdirectory to $path in cases where $multiresp is 1.
                   9728: 
                   9729: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   9730: 
                   9731: =cut
                   9732: 
                   9733: sub get_turnedin_filepath {
                   9734:     my ($symb,$uname,$udom,$caller) = @_;
                   9735:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   9736:     my $turnindir;
                   9737:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   9738:     $turnindir = $userhash{'turnindir'};
                   9739:     my ($path,$multiresp);
                   9740:     if ($turnindir eq '') {
                   9741:         if ($caller eq 'submission') {
                   9742:             $turnindir = &mt('turned in');
                   9743:             $turnindir =~ s/\W+/_/g;
                   9744:             my %newhash = (
                   9745:                             'turnindir' => $turnindir,
                   9746:                           );
                   9747:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   9748:         }
                   9749:     }
                   9750:     if ($turnindir ne '') {
                   9751:         $path = '/'.$turnindir.'/';
                   9752:         my ($multipart,$turnin,@pathitems);
                   9753:         my $navmap = Apache::lonnavmaps::navmap->new();
                   9754:         if (defined($navmap)) {
                   9755:             my $mapres = $navmap->getResourceByUrl($map);
                   9756:             if (ref($mapres)) {
                   9757:                 my $pcslist = $mapres->map_hierarchy();
                   9758:                 if ($pcslist ne '') {
                   9759:                     foreach my $pc (split(/,/,$pcslist)) {
                   9760:                         my $res = $navmap->getByMapPc($pc);
                   9761:                         if (ref($res)) {
                   9762:                             my $title = $res->compTitle();
                   9763:                             $title =~ s/\W+/_/g;
                   9764:                             if ($title ne '') {
                   9765:                                 push(@pathitems,$title);
                   9766:                             }
                   9767:                         }
                   9768:                     }
                   9769:                 }
                   9770:                 my $maptitle = $mapres->compTitle();
                   9771:                 $maptitle =~ s/\W+/_/g;
                   9772:                 if ($maptitle ne '') {
                   9773:                     push(@pathitems,$maptitle);
                   9774:                 }
                   9775:                 unless ($env{'request.state'} eq 'construct') {
                   9776:                     my $res = $navmap->getBySymb($symb);
                   9777:                     if (ref($res)) {
                   9778:                         my $partlist = $res->parts();
                   9779:                         my $totaluploads = 0;
                   9780:                         if (ref($partlist) eq 'ARRAY') {
                   9781:                             foreach my $part (@{$partlist}) {
                   9782:                                 my @types = $res->responseType($part);
                   9783:                                 my @ids = $res->responseIds($part);
                   9784:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   9785:                                     if ($types[$i] eq 'essay') {
                   9786:                                         my $partid = $part.'_'.$ids[$i];
                   9787:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   9788:                                             $totaluploads ++;
                   9789:                                         }
                   9790:                                     }
                   9791:                                 }
                   9792:                             }
                   9793:                             if ($totaluploads > 1) {
                   9794:                                 $multiresp = 1;
                   9795:                             }
                   9796:                         }
                   9797:                     }
                   9798:                 }
                   9799:             } else {
                   9800:                 return;
                   9801:             }
                   9802:         } else {
                   9803:             return;
                   9804:         }
                   9805:         my $restitle=&Apache::lonnet::gettitle($symb);
                   9806:         $restitle =~ s/\W+/_/g;
                   9807:         if ($restitle eq '') {
                   9808:             $restitle = ($resurl =~ m{/[^/]+$});
                   9809:             if ($restitle eq '') {
                   9810:                 $restitle = time;
                   9811:             }
                   9812:         }
                   9813:         push(@pathitems,$restitle);
                   9814:         $path .= join('/',@pathitems);
                   9815:     }
                   9816:     return ($path,$multiresp);
                   9817: }
                   9818: 
                   9819: =pod
                   9820: 
1.464     albertel 9821: =back
1.41      ng       9822: 
1.112     bowersj2 9823: =head1 CSV Upload/Handling functions
1.38      albertel 9824: 
1.41      ng       9825: =over 4
                   9826: 
1.648     raeburn  9827: =item * &upfile_store($r)
1.41      ng       9828: 
                   9829: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 9830: needs $env{'form.upfile'}
1.41      ng       9831: returns $datatoken to be put into hidden field
                   9832: 
                   9833: =cut
1.31      albertel 9834: 
                   9835: sub upfile_store {
                   9836:     my $r=shift;
1.258     albertel 9837:     $env{'form.upfile'}=~s/\r/\n/gs;
                   9838:     $env{'form.upfile'}=~s/\f/\n/gs;
                   9839:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   9840:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 9841: 
1.258     albertel 9842:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   9843: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 9844:     {
1.158     raeburn  9845:         my $datafile = $r->dir_config('lonDaemons').
                   9846:                            '/tmp/'.$datatoken.'.tmp';
                   9847:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 9848:             print $fh $env{'form.upfile'};
1.158     raeburn  9849:             close($fh);
                   9850:         }
1.31      albertel 9851:     }
                   9852:     return $datatoken;
                   9853: }
                   9854: 
1.56      matthew  9855: =pod
                   9856: 
1.648     raeburn  9857: =item * &load_tmp_file($r)
1.41      ng       9858: 
                   9859: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 9860: needs $env{'form.datatoken'},
                   9861: sets $env{'form.upfile'} to the contents of the file
1.41      ng       9862: 
                   9863: =cut
1.31      albertel 9864: 
                   9865: sub load_tmp_file {
                   9866:     my $r=shift;
                   9867:     my @studentdata=();
                   9868:     {
1.158     raeburn  9869:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 9870:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  9871:         if ( open(my $fh,"<$studentfile") ) {
                   9872:             @studentdata=<$fh>;
                   9873:             close($fh);
                   9874:         }
1.31      albertel 9875:     }
1.258     albertel 9876:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 9877: }
                   9878: 
1.56      matthew  9879: =pod
                   9880: 
1.648     raeburn  9881: =item * &upfile_record_sep()
1.41      ng       9882: 
                   9883: Separate uploaded file into records
                   9884: returns array of records,
1.258     albertel 9885: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       9886: 
                   9887: =cut
1.31      albertel 9888: 
                   9889: sub upfile_record_sep {
1.258     albertel 9890:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 9891:     } else {
1.248     albertel 9892: 	my @records;
1.258     albertel 9893: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 9894: 	    if ($line=~/^\s*$/) { next; }
                   9895: 	    push(@records,$line);
                   9896: 	}
                   9897: 	return @records;
1.31      albertel 9898:     }
                   9899: }
                   9900: 
1.56      matthew  9901: =pod
                   9902: 
1.648     raeburn  9903: =item * &record_sep($record)
1.41      ng       9904: 
1.258     albertel 9905: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       9906: 
                   9907: =cut
                   9908: 
1.263     www      9909: sub takeleft {
                   9910:     my $index=shift;
                   9911:     return substr('0000'.$index,-4,4);
                   9912: }
                   9913: 
1.31      albertel 9914: sub record_sep {
                   9915:     my $record=shift;
                   9916:     my %components=();
1.258     albertel 9917:     if ($env{'form.upfiletype'} eq 'xml') {
                   9918:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 9919:         my $i=0;
1.356     albertel 9920:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 9921:             $field=~s/^(\"|\')//;
                   9922:             $field=~s/(\"|\')$//;
1.263     www      9923:             $components{&takeleft($i)}=$field;
1.31      albertel 9924:             $i++;
                   9925:         }
1.258     albertel 9926:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 9927:         my $i=0;
1.356     albertel 9928:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 9929:             $field=~s/^(\"|\')//;
                   9930:             $field=~s/(\"|\')$//;
1.263     www      9931:             $components{&takeleft($i)}=$field;
1.31      albertel 9932:             $i++;
                   9933:         }
                   9934:     } else {
1.561     www      9935:         my $separator=',';
1.480     banghart 9936:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      9937:             $separator=';';
1.480     banghart 9938:         }
1.31      albertel 9939:         my $i=0;
1.561     www      9940: # the character we are looking for to indicate the end of a quote or a record 
                   9941:         my $looking_for=$separator;
                   9942: # do not add the characters to the fields
                   9943:         my $ignore=0;
                   9944: # we just encountered a separator (or the beginning of the record)
                   9945:         my $just_found_separator=1;
                   9946: # store the field we are working on here
                   9947:         my $field='';
                   9948: # work our way through all characters in record
                   9949:         foreach my $character ($record=~/(.)/g) {
                   9950:             if ($character eq $looking_for) {
                   9951:                if ($character ne $separator) {
                   9952: # Found the end of a quote, again looking for separator
                   9953:                   $looking_for=$separator;
                   9954:                   $ignore=1;
                   9955:                } else {
                   9956: # Found a separator, store away what we got
                   9957:                   $components{&takeleft($i)}=$field;
                   9958: 	          $i++;
                   9959:                   $just_found_separator=1;
                   9960:                   $ignore=0;
                   9961:                   $field='';
                   9962:                }
                   9963:                next;
                   9964:             }
                   9965: # single or double quotation marks after a separator indicate beginning of a quote
                   9966: # we are now looking for the end of the quote and need to ignore separators
                   9967:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   9968:                $looking_for=$character;
                   9969:                next;
                   9970:             }
                   9971: # ignore would be true after we reached the end of a quote
                   9972:             if ($ignore) { next; }
                   9973:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   9974:             $field.=$character;
                   9975:             $just_found_separator=0; 
1.31      albertel 9976:         }
1.561     www      9977: # catch the very last entry, since we never encountered the separator
                   9978:         $components{&takeleft($i)}=$field;
1.31      albertel 9979:     }
                   9980:     return %components;
                   9981: }
                   9982: 
1.144     matthew  9983: ######################################################
                   9984: ######################################################
                   9985: 
1.56      matthew  9986: =pod
                   9987: 
1.648     raeburn  9988: =item * &upfile_select_html()
1.41      ng       9989: 
1.144     matthew  9990: Return HTML code to select a file from the users machine and specify 
                   9991: the file type.
1.41      ng       9992: 
                   9993: =cut
                   9994: 
1.144     matthew  9995: ######################################################
                   9996: ######################################################
1.31      albertel 9997: sub upfile_select_html {
1.144     matthew  9998:     my %Types = (
                   9999:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 10000:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  10001:                  space => &mt('Space separated'),
                   10002:                  tab   => &mt('Tabulator separated'),
                   10003: #                 xml   => &mt('HTML/XML'),
                   10004:                  );
                   10005:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  10006:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  10007:     foreach my $type (sort(keys(%Types))) {
                   10008:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   10009:     }
                   10010:     $Str .= "</select>\n";
                   10011:     return $Str;
1.31      albertel 10012: }
                   10013: 
1.301     albertel 10014: sub get_samples {
                   10015:     my ($records,$toget) = @_;
                   10016:     my @samples=({});
                   10017:     my $got=0;
                   10018:     foreach my $rec (@$records) {
                   10019: 	my %temp = &record_sep($rec);
                   10020: 	if (! grep(/\S/, values(%temp))) { next; }
                   10021: 	if (%temp) {
                   10022: 	    $samples[$got]=\%temp;
                   10023: 	    $got++;
                   10024: 	    if ($got == $toget) { last; }
                   10025: 	}
                   10026:     }
                   10027:     return \@samples;
                   10028: }
                   10029: 
1.144     matthew  10030: ######################################################
                   10031: ######################################################
                   10032: 
1.56      matthew  10033: =pod
                   10034: 
1.648     raeburn  10035: =item * &csv_print_samples($r,$records)
1.41      ng       10036: 
                   10037: Prints a table of sample values from each column uploaded $r is an
                   10038: Apache Request ref, $records is an arrayref from
                   10039: &Apache::loncommon::upfile_record_sep
                   10040: 
                   10041: =cut
                   10042: 
1.144     matthew  10043: ######################################################
                   10044: ######################################################
1.31      albertel 10045: sub csv_print_samples {
                   10046:     my ($r,$records) = @_;
1.662     bisitz   10047:     my $samples = &get_samples($records,5);
1.301     albertel 10048: 
1.594     raeburn  10049:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   10050:               &start_data_table_header_row());
1.356     albertel 10051:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   10052:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  10053:     $r->print(&end_data_table_header_row());
1.301     albertel 10054:     foreach my $hash (@$samples) {
1.594     raeburn  10055: 	$r->print(&start_data_table_row());
1.356     albertel 10056: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 10057: 	    $r->print('<td>');
1.356     albertel 10058: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 10059: 	    $r->print('</td>');
                   10060: 	}
1.594     raeburn  10061: 	$r->print(&end_data_table_row());
1.31      albertel 10062:     }
1.594     raeburn  10063:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 10064: }
                   10065: 
1.144     matthew  10066: ######################################################
                   10067: ######################################################
                   10068: 
1.56      matthew  10069: =pod
                   10070: 
1.648     raeburn  10071: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       10072: 
                   10073: Prints a table to create associations between values and table columns.
1.144     matthew  10074: 
1.41      ng       10075: $r is an Apache Request ref,
                   10076: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  10077: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       10078: 
                   10079: =cut
                   10080: 
1.144     matthew  10081: ######################################################
                   10082: ######################################################
1.31      albertel 10083: sub csv_print_select_table {
                   10084:     my ($r,$records,$d) = @_;
1.301     albertel 10085:     my $i=0;
                   10086:     my $samples = &get_samples($records,1);
1.144     matthew  10087:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  10088: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  10089:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  10090:               '<th>'.&mt('Column').'</th>'.
                   10091:               &end_data_table_header_row()."\n");
1.356     albertel 10092:     foreach my $array_ref (@$d) {
                   10093: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  10094: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 10095: 
1.875     bisitz   10096: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  10097: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 10098: 	$r->print('<option value="none"></option>');
1.356     albertel 10099: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   10100: 	    $r->print('<option value="'.$sample.'"'.
                   10101:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   10102:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 10103: 	}
1.594     raeburn  10104: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 10105: 	$i++;
                   10106:     }
1.594     raeburn  10107:     $r->print(&end_data_table());
1.31      albertel 10108:     $i--;
                   10109:     return $i;
                   10110: }
1.56      matthew  10111: 
1.144     matthew  10112: ######################################################
                   10113: ######################################################
                   10114: 
1.56      matthew  10115: =pod
1.31      albertel 10116: 
1.648     raeburn  10117: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       10118: 
                   10119: Prints a table of sample values from the upload and can make associate samples to internal names.
                   10120: 
                   10121: $r is an Apache Request ref,
                   10122: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   10123: $d is an array of 2 element arrays (internal name, displayed name)
                   10124: 
                   10125: =cut
                   10126: 
1.144     matthew  10127: ######################################################
                   10128: ######################################################
1.31      albertel 10129: sub csv_samples_select_table {
                   10130:     my ($r,$records,$d) = @_;
                   10131:     my $i=0;
1.144     matthew  10132:     #
1.662     bisitz   10133:     my $max_samples = 5;
                   10134:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  10135:     $r->print(&start_data_table().
                   10136:               &start_data_table_header_row().'<th>'.
                   10137:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   10138:               &end_data_table_header_row());
1.301     albertel 10139: 
                   10140:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  10141: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  10142: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 10143: 	foreach my $option (@$d) {
                   10144: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  10145: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 10146:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  10147:                       $display.'</option>');
1.31      albertel 10148: 	}
                   10149: 	$r->print('</select></td><td>');
1.662     bisitz   10150: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 10151: 	    if (defined($samples->[$line]{$key})) { 
                   10152: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   10153: 	    }
                   10154: 	}
1.594     raeburn  10155: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 10156: 	$i++;
                   10157:     }
1.594     raeburn  10158:     $r->print(&end_data_table());
1.31      albertel 10159:     $i--;
                   10160:     return($i);
1.115     matthew  10161: }
                   10162: 
1.144     matthew  10163: ######################################################
                   10164: ######################################################
                   10165: 
1.115     matthew  10166: =pod
                   10167: 
1.648     raeburn  10168: =item * &clean_excel_name($name)
1.115     matthew  10169: 
                   10170: Returns a replacement for $name which does not contain any illegal characters.
                   10171: 
                   10172: =cut
                   10173: 
1.144     matthew  10174: ######################################################
                   10175: ######################################################
1.115     matthew  10176: sub clean_excel_name {
                   10177:     my ($name) = @_;
                   10178:     $name =~ s/[:\*\?\/\\]//g;
                   10179:     if (length($name) > 31) {
                   10180:         $name = substr($name,0,31);
                   10181:     }
                   10182:     return $name;
1.25      albertel 10183: }
1.84      albertel 10184: 
1.85      albertel 10185: =pod
                   10186: 
1.648     raeburn  10187: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 10188: 
                   10189: Returns either 1 or undef
                   10190: 
                   10191: 1 if the part is to be hidden, undef if it is to be shown
                   10192: 
                   10193: Arguments are:
                   10194: 
                   10195: $id the id of the part to be checked
                   10196: $symb, optional the symb of the resource to check
                   10197: $udom, optional the domain of the user to check for
                   10198: $uname, optional the username of the user to check for
                   10199: 
                   10200: =cut
1.84      albertel 10201: 
                   10202: sub check_if_partid_hidden {
                   10203:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 10204:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 10205: 					 $symb,$udom,$uname);
1.141     albertel 10206:     my $truth=1;
                   10207:     #if the string starts with !, then the list is the list to show not hide
                   10208:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 10209:     my @hiddenlist=split(/,/,$hiddenparts);
                   10210:     foreach my $checkid (@hiddenlist) {
1.141     albertel 10211: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 10212:     }
1.141     albertel 10213:     return !$truth;
1.84      albertel 10214: }
1.127     matthew  10215: 
1.138     matthew  10216: 
                   10217: ############################################################
                   10218: ############################################################
                   10219: 
                   10220: =pod
                   10221: 
1.157     matthew  10222: =back 
                   10223: 
1.138     matthew  10224: =head1 cgi-bin script and graphing routines
                   10225: 
1.157     matthew  10226: =over 4
                   10227: 
1.648     raeburn  10228: =item * &get_cgi_id()
1.138     matthew  10229: 
                   10230: Inputs: none
                   10231: 
                   10232: Returns an id which can be used to pass environment variables
                   10233: to various cgi-bin scripts.  These environment variables will
                   10234: be removed from the users environment after a given time by
                   10235: the routine &Apache::lonnet::transfer_profile_to_env.
                   10236: 
                   10237: =cut
                   10238: 
                   10239: ############################################################
                   10240: ############################################################
1.152     albertel 10241: my $uniq=0;
1.136     matthew  10242: sub get_cgi_id {
1.154     albertel 10243:     $uniq=($uniq+1)%100000;
1.280     albertel 10244:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  10245: }
                   10246: 
1.127     matthew  10247: ############################################################
                   10248: ############################################################
                   10249: 
                   10250: =pod
                   10251: 
1.648     raeburn  10252: =item * &DrawBarGraph()
1.127     matthew  10253: 
1.138     matthew  10254: Facilitates the plotting of data in a (stacked) bar graph.
                   10255: Puts plot definition data into the users environment in order for 
                   10256: graph.png to plot it.  Returns an <img> tag for the plot.
                   10257: The bars on the plot are labeled '1','2',...,'n'.
                   10258: 
                   10259: Inputs:
                   10260: 
                   10261: =over 4
                   10262: 
                   10263: =item $Title: string, the title of the plot
                   10264: 
                   10265: =item $xlabel: string, text describing the X-axis of the plot
                   10266: 
                   10267: =item $ylabel: string, text describing the Y-axis of the plot
                   10268: 
                   10269: =item $Max: scalar, the maximum Y value to use in the plot
                   10270: If $Max is < any data point, the graph will not be rendered.
                   10271: 
1.140     matthew  10272: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  10273: they are plotted.  If undefined, default values will be used.
                   10274: 
1.178     matthew  10275: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   10276: 
1.138     matthew  10277: =item @Values: An array of array references.  Each array reference holds data
                   10278: to be plotted in a stacked bar chart.
                   10279: 
1.239     matthew  10280: =item If the final element of @Values is a hash reference the key/value
                   10281: pairs will be added to the graph definition.
                   10282: 
1.138     matthew  10283: =back
                   10284: 
                   10285: Returns:
                   10286: 
                   10287: An <img> tag which references graph.png and the appropriate identifying
                   10288: information for the plot.
                   10289: 
1.127     matthew  10290: =cut
                   10291: 
                   10292: ############################################################
                   10293: ############################################################
1.134     matthew  10294: sub DrawBarGraph {
1.178     matthew  10295:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  10296:     #
                   10297:     if (! defined($colors)) {
                   10298:         $colors = ['#33ff00', 
                   10299:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   10300:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   10301:                   ]; 
                   10302:     }
1.228     matthew  10303:     my $extra_settings = {};
                   10304:     if (ref($Values[-1]) eq 'HASH') {
                   10305:         $extra_settings = pop(@Values);
                   10306:     }
1.127     matthew  10307:     #
1.136     matthew  10308:     my $identifier = &get_cgi_id();
                   10309:     my $id = 'cgi.'.$identifier;        
1.129     matthew  10310:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  10311:         return '';
                   10312:     }
1.225     matthew  10313:     #
                   10314:     my @Labels;
                   10315:     if (defined($labels)) {
                   10316:         @Labels = @$labels;
                   10317:     } else {
                   10318:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   10319:             push (@Labels,$i+1);
                   10320:         }
                   10321:     }
                   10322:     #
1.129     matthew  10323:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  10324:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  10325:     my %ValuesHash;
                   10326:     my $NumSets=1;
                   10327:     foreach my $array (@Values) {
                   10328:         next if (! ref($array));
1.136     matthew  10329:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  10330:             join(',',@$array);
1.129     matthew  10331:     }
1.127     matthew  10332:     #
1.136     matthew  10333:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  10334:     if ($NumBars < 3) {
                   10335:         $width = 120+$NumBars*32;
1.220     matthew  10336:         $xskip = 1;
1.225     matthew  10337:         $bar_width = 30;
                   10338:     } elsif ($NumBars < 5) {
                   10339:         $width = 120+$NumBars*20;
                   10340:         $xskip = 1;
                   10341:         $bar_width = 20;
1.220     matthew  10342:     } elsif ($NumBars < 10) {
1.136     matthew  10343:         $width = 120+$NumBars*15;
                   10344:         $xskip = 1;
                   10345:         $bar_width = 15;
                   10346:     } elsif ($NumBars <= 25) {
                   10347:         $width = 120+$NumBars*11;
                   10348:         $xskip = 5;
                   10349:         $bar_width = 8;
                   10350:     } elsif ($NumBars <= 50) {
                   10351:         $width = 120+$NumBars*8;
                   10352:         $xskip = 5;
                   10353:         $bar_width = 4;
                   10354:     } else {
                   10355:         $width = 120+$NumBars*8;
                   10356:         $xskip = 5;
                   10357:         $bar_width = 4;
                   10358:     }
                   10359:     #
1.137     matthew  10360:     $Max = 1 if ($Max < 1);
                   10361:     if ( int($Max) < $Max ) {
                   10362:         $Max++;
                   10363:         $Max = int($Max);
                   10364:     }
1.127     matthew  10365:     $Title  = '' if (! defined($Title));
                   10366:     $xlabel = '' if (! defined($xlabel));
                   10367:     $ylabel = '' if (! defined($ylabel));
1.369     www      10368:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   10369:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   10370:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  10371:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  10372:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   10373:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   10374:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   10375:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   10376:     $ValuesHash{$id.'.height'}   = $height;
                   10377:     $ValuesHash{$id.'.width'}    = $width;
                   10378:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   10379:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   10380:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  10381:     #
1.228     matthew  10382:     # Deal with other parameters
                   10383:     while (my ($key,$value) = each(%$extra_settings)) {
                   10384:         $ValuesHash{$id.'.'.$key} = $value;
                   10385:     }
                   10386:     #
1.646     raeburn  10387:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  10388:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   10389: }
                   10390: 
                   10391: ############################################################
                   10392: ############################################################
                   10393: 
                   10394: =pod
                   10395: 
1.648     raeburn  10396: =item * &DrawXYGraph()
1.137     matthew  10397: 
1.138     matthew  10398: Facilitates the plotting of data in an XY graph.
                   10399: Puts plot definition data into the users environment in order for 
                   10400: graph.png to plot it.  Returns an <img> tag for the plot.
                   10401: 
                   10402: Inputs:
                   10403: 
                   10404: =over 4
                   10405: 
                   10406: =item $Title: string, the title of the plot
                   10407: 
                   10408: =item $xlabel: string, text describing the X-axis of the plot
                   10409: 
                   10410: =item $ylabel: string, text describing the Y-axis of the plot
                   10411: 
                   10412: =item $Max: scalar, the maximum Y value to use in the plot
                   10413: If $Max is < any data point, the graph will not be rendered.
                   10414: 
                   10415: =item $colors: Array ref containing the hex color codes for the data to be 
                   10416: plotted in.  If undefined, default values will be used.
                   10417: 
                   10418: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   10419: 
                   10420: =item $Ydata: Array ref containing Array refs.  
1.185     www      10421: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  10422: 
                   10423: =item %Values: hash indicating or overriding any default values which are 
                   10424: passed to graph.png.  
                   10425: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   10426: 
                   10427: =back
                   10428: 
                   10429: Returns:
                   10430: 
                   10431: An <img> tag which references graph.png and the appropriate identifying
                   10432: information for the plot.
                   10433: 
1.137     matthew  10434: =cut
                   10435: 
                   10436: ############################################################
                   10437: ############################################################
                   10438: sub DrawXYGraph {
                   10439:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   10440:     #
                   10441:     # Create the identifier for the graph
                   10442:     my $identifier = &get_cgi_id();
                   10443:     my $id = 'cgi.'.$identifier;
                   10444:     #
                   10445:     $Title  = '' if (! defined($Title));
                   10446:     $xlabel = '' if (! defined($xlabel));
                   10447:     $ylabel = '' if (! defined($ylabel));
                   10448:     my %ValuesHash = 
                   10449:         (
1.369     www      10450:          $id.'.title'  => &escape($Title),
                   10451:          $id.'.xlabel' => &escape($xlabel),
                   10452:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  10453:          $id.'.y_max_value'=> $Max,
                   10454:          $id.'.labels'     => join(',',@$Xlabels),
                   10455:          $id.'.PlotType'   => 'XY',
                   10456:          );
                   10457:     #
                   10458:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   10459:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   10460:     }
                   10461:     #
                   10462:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   10463:         return '';
                   10464:     }
                   10465:     my $NumSets=1;
1.138     matthew  10466:     foreach my $array (@{$Ydata}){
1.137     matthew  10467:         next if (! ref($array));
                   10468:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   10469:     }
1.138     matthew  10470:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  10471:     #
                   10472:     # Deal with other parameters
                   10473:     while (my ($key,$value) = each(%Values)) {
                   10474:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  10475:     }
                   10476:     #
1.646     raeburn  10477:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  10478:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   10479: }
                   10480: 
                   10481: ############################################################
                   10482: ############################################################
                   10483: 
                   10484: =pod
                   10485: 
1.648     raeburn  10486: =item * &DrawXYYGraph()
1.138     matthew  10487: 
                   10488: Facilitates the plotting of data in an XY graph with two Y axes.
                   10489: Puts plot definition data into the users environment in order for 
                   10490: graph.png to plot it.  Returns an <img> tag for the plot.
                   10491: 
                   10492: Inputs:
                   10493: 
                   10494: =over 4
                   10495: 
                   10496: =item $Title: string, the title of the plot
                   10497: 
                   10498: =item $xlabel: string, text describing the X-axis of the plot
                   10499: 
                   10500: =item $ylabel: string, text describing the Y-axis of the plot
                   10501: 
                   10502: =item $colors: Array ref containing the hex color codes for the data to be 
                   10503: plotted in.  If undefined, default values will be used.
                   10504: 
                   10505: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   10506: 
                   10507: =item $Ydata1: The first data set
                   10508: 
                   10509: =item $Min1: The minimum value of the left Y-axis
                   10510: 
                   10511: =item $Max1: The maximum value of the left Y-axis
                   10512: 
                   10513: =item $Ydata2: The second data set
                   10514: 
                   10515: =item $Min2: The minimum value of the right Y-axis
                   10516: 
                   10517: =item $Max2: The maximum value of the left Y-axis
                   10518: 
                   10519: =item %Values: hash indicating or overriding any default values which are 
                   10520: passed to graph.png.  
                   10521: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   10522: 
                   10523: =back
                   10524: 
                   10525: Returns:
                   10526: 
                   10527: An <img> tag which references graph.png and the appropriate identifying
                   10528: information for the plot.
1.136     matthew  10529: 
                   10530: =cut
                   10531: 
                   10532: ############################################################
                   10533: ############################################################
1.137     matthew  10534: sub DrawXYYGraph {
                   10535:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   10536:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  10537:     #
                   10538:     # Create the identifier for the graph
                   10539:     my $identifier = &get_cgi_id();
                   10540:     my $id = 'cgi.'.$identifier;
                   10541:     #
                   10542:     $Title  = '' if (! defined($Title));
                   10543:     $xlabel = '' if (! defined($xlabel));
                   10544:     $ylabel = '' if (! defined($ylabel));
                   10545:     my %ValuesHash = 
                   10546:         (
1.369     www      10547:          $id.'.title'  => &escape($Title),
                   10548:          $id.'.xlabel' => &escape($xlabel),
                   10549:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  10550:          $id.'.labels' => join(',',@$Xlabels),
                   10551:          $id.'.PlotType' => 'XY',
                   10552:          $id.'.NumSets' => 2,
1.137     matthew  10553:          $id.'.two_axes' => 1,
                   10554:          $id.'.y1_max_value' => $Max1,
                   10555:          $id.'.y1_min_value' => $Min1,
                   10556:          $id.'.y2_max_value' => $Max2,
                   10557:          $id.'.y2_min_value' => $Min2,
1.136     matthew  10558:          );
                   10559:     #
1.137     matthew  10560:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   10561:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   10562:     }
                   10563:     #
                   10564:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   10565:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  10566:         return '';
                   10567:     }
                   10568:     my $NumSets=1;
1.137     matthew  10569:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  10570:         next if (! ref($array));
                   10571:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  10572:     }
                   10573:     #
                   10574:     # Deal with other parameters
                   10575:     while (my ($key,$value) = each(%Values)) {
                   10576:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  10577:     }
                   10578:     #
1.646     raeburn  10579:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 10580:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  10581: }
                   10582: 
                   10583: ############################################################
                   10584: ############################################################
                   10585: 
                   10586: =pod
                   10587: 
1.157     matthew  10588: =back 
                   10589: 
1.139     matthew  10590: =head1 Statistics helper routines?  
                   10591: 
                   10592: Bad place for them but what the hell.
                   10593: 
1.157     matthew  10594: =over 4
                   10595: 
1.648     raeburn  10596: =item * &chartlink()
1.139     matthew  10597: 
                   10598: Returns a link to the chart for a specific student.  
                   10599: 
                   10600: Inputs:
                   10601: 
                   10602: =over 4
                   10603: 
                   10604: =item $linktext: The text of the link
                   10605: 
                   10606: =item $sname: The students username
                   10607: 
                   10608: =item $sdomain: The students domain
                   10609: 
                   10610: =back
                   10611: 
1.157     matthew  10612: =back
                   10613: 
1.139     matthew  10614: =cut
                   10615: 
                   10616: ############################################################
                   10617: ############################################################
                   10618: sub chartlink {
                   10619:     my ($linktext, $sname, $sdomain) = @_;
                   10620:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      10621:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 10622:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  10623:        '">'.$linktext.'</a>';
1.153     matthew  10624: }
                   10625: 
                   10626: #######################################################
                   10627: #######################################################
                   10628: 
                   10629: =pod
                   10630: 
                   10631: =head1 Course Environment Routines
1.157     matthew  10632: 
                   10633: =over 4
1.153     matthew  10634: 
1.648     raeburn  10635: =item * &restore_course_settings()
1.153     matthew  10636: 
1.648     raeburn  10637: =item * &store_course_settings()
1.153     matthew  10638: 
                   10639: Restores/Store indicated form parameters from the course environment.
                   10640: Will not overwrite existing values of the form parameters.
                   10641: 
                   10642: Inputs: 
                   10643: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   10644: 
                   10645: a hash ref describing the data to be stored.  For example:
                   10646:    
                   10647: %Save_Parameters = ('Status' => 'scalar',
                   10648:     'chartoutputmode' => 'scalar',
                   10649:     'chartoutputdata' => 'scalar',
                   10650:     'Section' => 'array',
1.373     raeburn  10651:     'Group' => 'array',
1.153     matthew  10652:     'StudentData' => 'array',
                   10653:     'Maps' => 'array');
                   10654: 
                   10655: Returns: both routines return nothing
                   10656: 
1.631     raeburn  10657: =back
                   10658: 
1.153     matthew  10659: =cut
                   10660: 
                   10661: #######################################################
                   10662: #######################################################
                   10663: sub store_course_settings {
1.496     albertel 10664:     return &store_settings($env{'request.course.id'},@_);
                   10665: }
                   10666: 
                   10667: sub store_settings {
1.153     matthew  10668:     # save to the environment
                   10669:     # appenv the same items, just to be safe
1.300     albertel 10670:     my $udom  = $env{'user.domain'};
                   10671:     my $uname = $env{'user.name'};
1.496     albertel 10672:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  10673:     my %SaveHash;
                   10674:     my %AppHash;
                   10675:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 10676:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 10677:         my $envname = 'environment.'.$basename;
1.258     albertel 10678:         if (exists($env{'form.'.$setting})) {
1.153     matthew  10679:             # Save this value away
                   10680:             if ($type eq 'scalar' &&
1.258     albertel 10681:                 (! exists($env{$envname}) || 
                   10682:                  $env{$envname} ne $env{'form.'.$setting})) {
                   10683:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   10684:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  10685:             } elsif ($type eq 'array') {
                   10686:                 my $stored_form;
1.258     albertel 10687:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  10688:                     $stored_form = join(',',
                   10689:                                         map {
1.369     www      10690:                                             &escape($_);
1.258     albertel 10691:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  10692:                 } else {
                   10693:                     $stored_form = 
1.369     www      10694:                         &escape($env{'form.'.$setting});
1.153     matthew  10695:                 }
                   10696:                 # Determine if the array contents are the same.
1.258     albertel 10697:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  10698:                     $SaveHash{$basename} = $stored_form;
                   10699:                     $AppHash{$envname}   = $stored_form;
                   10700:                 }
                   10701:             }
                   10702:         }
                   10703:     }
                   10704:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 10705:                                           $udom,$uname);
1.153     matthew  10706:     if ($put_result !~ /^(ok|delayed)/) {
                   10707:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   10708:                                  'got error:'.$put_result);
                   10709:     }
                   10710:     # Make sure these settings stick around in this session, too
1.646     raeburn  10711:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  10712:     return;
                   10713: }
                   10714: 
                   10715: sub restore_course_settings {
1.499     albertel 10716:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 10717: }
                   10718: 
                   10719: sub restore_settings {
                   10720:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  10721:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 10722:         next if (exists($env{'form.'.$setting}));
1.496     albertel 10723:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  10724:             '.'.$setting;
1.258     albertel 10725:         if (exists($env{$envname})) {
1.153     matthew  10726:             if ($type eq 'scalar') {
1.258     albertel 10727:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  10728:             } elsif ($type eq 'array') {
1.258     albertel 10729:                 $env{'form.'.$setting} = [ 
1.153     matthew  10730:                                            map { 
1.369     www      10731:                                                &unescape($_); 
1.258     albertel 10732:                                            } split(',',$env{$envname})
1.153     matthew  10733:                                            ];
                   10734:             }
                   10735:         }
                   10736:     }
1.127     matthew  10737: }
                   10738: 
1.618     raeburn  10739: #######################################################
                   10740: #######################################################
                   10741: 
                   10742: =pod
                   10743: 
                   10744: =head1 Domain E-mail Routines  
                   10745: 
                   10746: =over 4
                   10747: 
1.648     raeburn  10748: =item * &build_recipient_list()
1.618     raeburn  10749: 
1.884     raeburn  10750: Build recipient lists for five types of e-mail:
1.766     raeburn  10751: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  10752: (d) Help requests, (e) Course requests needing approval,  generated by
                   10753: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   10754: loncoursequeueadmin.pm respectively.
1.618     raeburn  10755: 
                   10756: Inputs:
1.619     raeburn  10757: defmail (scalar - email address of default recipient), 
1.618     raeburn  10758: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  10759: defdom (domain for which to retrieve configuration settings),
                   10760: origmail (scalar - email address of recipient from loncapa.conf, 
                   10761: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  10762: 
1.655     raeburn  10763: Returns: comma separated list of addresses to which to send e-mail.
                   10764: 
                   10765: =back
1.618     raeburn  10766: 
                   10767: =cut
                   10768: 
                   10769: ############################################################
                   10770: ############################################################
                   10771: sub build_recipient_list {
1.619     raeburn  10772:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  10773:     my @recipients;
                   10774:     my $otheremails;
                   10775:     my %domconfig =
                   10776:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   10777:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  10778:         if (exists($domconfig{'contacts'}{$mailing})) {
                   10779:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   10780:                 my @contacts = ('adminemail','supportemail');
                   10781:                 foreach my $item (@contacts) {
                   10782:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   10783:                         my $addr = $domconfig{'contacts'}{$item}; 
                   10784:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   10785:                             push(@recipients,$addr);
                   10786:                         }
1.619     raeburn  10787:                     }
1.766     raeburn  10788:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  10789:                 }
                   10790:             }
1.766     raeburn  10791:         } elsif ($origmail ne '') {
                   10792:             push(@recipients,$origmail);
1.618     raeburn  10793:         }
1.619     raeburn  10794:     } elsif ($origmail ne '') {
                   10795:         push(@recipients,$origmail);
1.618     raeburn  10796:     }
1.688     raeburn  10797:     if (defined($defmail)) {
                   10798:         if ($defmail ne '') {
                   10799:             push(@recipients,$defmail);
                   10800:         }
1.618     raeburn  10801:     }
                   10802:     if ($otheremails) {
1.619     raeburn  10803:         my @others;
                   10804:         if ($otheremails =~ /,/) {
                   10805:             @others = split(/,/,$otheremails);
1.618     raeburn  10806:         } else {
1.619     raeburn  10807:             push(@others,$otheremails);
                   10808:         }
                   10809:         foreach my $addr (@others) {
                   10810:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   10811:                 push(@recipients,$addr);
                   10812:             }
1.618     raeburn  10813:         }
                   10814:     }
1.619     raeburn  10815:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  10816:     return $recipientlist;
                   10817: }
                   10818: 
1.127     matthew  10819: ############################################################
                   10820: ############################################################
1.154     albertel 10821: 
1.655     raeburn  10822: =pod
                   10823: 
                   10824: =head1 Course Catalog Routines
                   10825: 
                   10826: =over 4
                   10827: 
                   10828: =item * &gather_categories()
                   10829: 
                   10830: Converts category definitions - keys of categories hash stored in  
                   10831: coursecategories in configuration.db on the primary library server in a 
                   10832: domain - to an array.  Also generates javascript and idx hash used to 
                   10833: generate Domain Coordinator interface for editing Course Categories.
                   10834: 
                   10835: Inputs:
1.663     raeburn  10836: 
1.655     raeburn  10837: categories (reference to hash of category definitions).
1.663     raeburn  10838: 
1.655     raeburn  10839: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   10840:       categories and subcategories).
1.663     raeburn  10841: 
1.655     raeburn  10842: idx (reference to hash of counters used in Domain Coordinator interface for 
                   10843:       editing Course Categories).
1.663     raeburn  10844: 
1.655     raeburn  10845: jsarray (reference to array of categories used to create Javascript arrays for
                   10846:          Domain Coordinator interface for editing Course Categories).
                   10847: 
                   10848: Returns: nothing
                   10849: 
                   10850: Side effects: populates cats, idx and jsarray. 
                   10851: 
                   10852: =cut
                   10853: 
                   10854: sub gather_categories {
                   10855:     my ($categories,$cats,$idx,$jsarray) = @_;
                   10856:     my %counters;
                   10857:     my $num = 0;
                   10858:     foreach my $item (keys(%{$categories})) {
                   10859:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   10860:         if ($container eq '' && $depth == 0) {
                   10861:             $cats->[$depth][$categories->{$item}] = $cat;
                   10862:         } else {
                   10863:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   10864:         }
                   10865:         my ($escitem,$tail) = split(/:/,$item,2);
                   10866:         if ($counters{$tail} eq '') {
                   10867:             $counters{$tail} = $num;
                   10868:             $num ++;
                   10869:         }
                   10870:         if (ref($idx) eq 'HASH') {
                   10871:             $idx->{$item} = $counters{$tail};
                   10872:         }
                   10873:         if (ref($jsarray) eq 'ARRAY') {
                   10874:             push(@{$jsarray->[$counters{$tail}]},$item);
                   10875:         }
                   10876:     }
                   10877:     return;
                   10878: }
                   10879: 
                   10880: =pod
                   10881: 
                   10882: =item * &extract_categories()
                   10883: 
                   10884: Used to generate breadcrumb trails for course categories.
                   10885: 
                   10886: Inputs:
1.663     raeburn  10887: 
1.655     raeburn  10888: categories (reference to hash of category definitions).
1.663     raeburn  10889: 
1.655     raeburn  10890: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   10891:       categories and subcategories).
1.663     raeburn  10892: 
1.655     raeburn  10893: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  10894: 
1.655     raeburn  10895: allitems (reference to hash - key is category key 
                   10896:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  10897: 
1.655     raeburn  10898: idx (reference to hash of counters used in Domain Coordinator interface for
                   10899:       editing Course Categories).
1.663     raeburn  10900: 
1.655     raeburn  10901: jsarray (reference to array of categories used to create Javascript arrays for
                   10902:          Domain Coordinator interface for editing Course Categories).
                   10903: 
1.665     raeburn  10904: subcats (reference to hash of arrays containing all subcategories within each 
                   10905:          category, -recursive)
                   10906: 
1.655     raeburn  10907: Returns: nothing
                   10908: 
                   10909: Side effects: populates trails and allitems hash references.
                   10910: 
                   10911: =cut
                   10912: 
                   10913: sub extract_categories {
1.665     raeburn  10914:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  10915:     if (ref($categories) eq 'HASH') {
                   10916:         &gather_categories($categories,$cats,$idx,$jsarray);
                   10917:         if (ref($cats->[0]) eq 'ARRAY') {
                   10918:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   10919:                 my $name = $cats->[0][$i];
                   10920:                 my $item = &escape($name).'::0';
                   10921:                 my $trailstr;
                   10922:                 if ($name eq 'instcode') {
                   10923:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  10924:                 } elsif ($name eq 'communities') {
                   10925:                     $trailstr = &mt('Communities');
1.655     raeburn  10926:                 } else {
                   10927:                     $trailstr = $name;
                   10928:                 }
                   10929:                 if ($allitems->{$item} eq '') {
                   10930:                     push(@{$trails},$trailstr);
                   10931:                     $allitems->{$item} = scalar(@{$trails})-1;
                   10932:                 }
                   10933:                 my @parents = ($name);
                   10934:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   10935:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   10936:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  10937:                         if (ref($subcats) eq 'HASH') {
                   10938:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   10939:                         }
                   10940:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   10941:                     }
                   10942:                 } else {
                   10943:                     if (ref($subcats) eq 'HASH') {
                   10944:                         $subcats->{$item} = [];
1.655     raeburn  10945:                     }
                   10946:                 }
                   10947:             }
                   10948:         }
                   10949:     }
                   10950:     return;
                   10951: }
                   10952: 
                   10953: =pod
                   10954: 
                   10955: =item *&recurse_categories()
                   10956: 
                   10957: Recursively used to generate breadcrumb trails for course categories.
                   10958: 
                   10959: Inputs:
1.663     raeburn  10960: 
1.655     raeburn  10961: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   10962:       categories and subcategories).
1.663     raeburn  10963: 
1.655     raeburn  10964: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  10965: 
                   10966: category (current course category, for which breadcrumb trail is being generated).
                   10967: 
                   10968: trails (reference to array of breadcrumb trails for each category).
                   10969: 
1.655     raeburn  10970: allitems (reference to hash - key is category key
                   10971:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  10972: 
1.655     raeburn  10973: parents (array containing containers directories for current category, 
                   10974:          back to top level). 
                   10975: 
                   10976: Returns: nothing
                   10977: 
                   10978: Side effects: populates trails and allitems hash references
                   10979: 
                   10980: =cut
                   10981: 
                   10982: sub recurse_categories {
1.665     raeburn  10983:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  10984:     my $shallower = $depth - 1;
                   10985:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   10986:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   10987:             my $name = $cats->[$depth]{$category}[$k];
                   10988:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   10989:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   10990:             if ($allitems->{$item} eq '') {
                   10991:                 push(@{$trails},$trailstr);
                   10992:                 $allitems->{$item} = scalar(@{$trails})-1;
                   10993:             }
                   10994:             my $deeper = $depth+1;
                   10995:             push(@{$parents},$category);
1.665     raeburn  10996:             if (ref($subcats) eq 'HASH') {
                   10997:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   10998:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   10999:                     my $higher;
                   11000:                     if ($j > 0) {
                   11001:                         $higher = &escape($parents->[$j]).':'.
                   11002:                                   &escape($parents->[$j-1]).':'.$j;
                   11003:                     } else {
                   11004:                         $higher = &escape($parents->[$j]).'::'.$j;
                   11005:                     }
                   11006:                     push(@{$subcats->{$higher}},$subcat);
                   11007:                 }
                   11008:             }
                   11009:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   11010:                                 $subcats);
1.655     raeburn  11011:             pop(@{$parents});
                   11012:         }
                   11013:     } else {
                   11014:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   11015:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   11016:         if ($allitems->{$item} eq '') {
                   11017:             push(@{$trails},$trailstr);
                   11018:             $allitems->{$item} = scalar(@{$trails})-1;
                   11019:         }
                   11020:     }
                   11021:     return;
                   11022: }
                   11023: 
1.663     raeburn  11024: =pod
                   11025: 
                   11026: =item *&assign_categories_table()
                   11027: 
                   11028: Create a datatable for display of hierarchical categories in a domain,
                   11029: with checkboxes to allow a course to be categorized. 
                   11030: 
                   11031: Inputs:
                   11032: 
                   11033: cathash - reference to hash of categories defined for the domain (from
                   11034:           configuration.db)
                   11035: 
                   11036: currcat - scalar with an & separated list of categories assigned to a course. 
                   11037: 
1.919     raeburn  11038: type    - scalar contains course type (Course or Community).
                   11039: 
1.663     raeburn  11040: Returns: $output (markup to be displayed) 
                   11041: 
                   11042: =cut
                   11043: 
                   11044: sub assign_categories_table {
1.919     raeburn  11045:     my ($cathash,$currcat,$type) = @_;
1.663     raeburn  11046:     my $output;
                   11047:     if (ref($cathash) eq 'HASH') {
                   11048:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   11049:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   11050:         $maxdepth = scalar(@cats);
                   11051:         if (@cats > 0) {
                   11052:             my $itemcount = 0;
                   11053:             if (ref($cats[0]) eq 'ARRAY') {
                   11054:                 my @currcategories;
                   11055:                 if ($currcat ne '') {
                   11056:                     @currcategories = split('&',$currcat);
                   11057:                 }
1.919     raeburn  11058:                 my $table;
1.663     raeburn  11059:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   11060:                     my $parent = $cats[0][$i];
1.919     raeburn  11061:                     next if ($parent eq 'instcode');
                   11062:                     if ($type eq 'Community') {
                   11063:                         next unless ($parent eq 'communities');
                   11064:                     } else {
                   11065:                         next if ($parent eq 'communities');
                   11066:                     }
1.663     raeburn  11067:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   11068:                     my $item = &escape($parent).'::0';
                   11069:                     my $checked = '';
                   11070:                     if (@currcategories > 0) {
                   11071:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   11072:                             $checked = ' checked="checked"';
1.663     raeburn  11073:                         }
                   11074:                     }
1.919     raeburn  11075:                     my $parent_title = $parent;
                   11076:                     if ($parent eq 'communities') {
                   11077:                         $parent_title = &mt('Communities');
                   11078:                     }
                   11079:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   11080:                               '<input type="checkbox" name="usecategory" value="'.
                   11081:                               $item.'"'.$checked.' />'.$parent_title.'</span>'.
                   11082:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  11083:                     my $depth = 1;
                   11084:                     push(@path,$parent);
1.919     raeburn  11085:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663     raeburn  11086:                     pop(@path);
1.919     raeburn  11087:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  11088:                     $itemcount ++;
                   11089:                 }
1.919     raeburn  11090:                 if ($itemcount) {
                   11091:                     $output = &Apache::loncommon::start_data_table().
                   11092:                               $table.
                   11093:                               &Apache::loncommon::end_data_table();
                   11094:                 }
1.663     raeburn  11095:             }
                   11096:         }
                   11097:     }
                   11098:     return $output;
                   11099: }
                   11100: 
                   11101: =pod
                   11102: 
                   11103: =item *&assign_category_rows()
                   11104: 
                   11105: Create a datatable row for display of nested categories in a domain,
                   11106: with checkboxes to allow a course to be categorized,called recursively.
                   11107: 
                   11108: Inputs:
                   11109: 
                   11110: itemcount - track row number for alternating colors
                   11111: 
                   11112: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   11113:       categories and subcategories.
                   11114: 
                   11115: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   11116: 
                   11117: parent - parent of current category item
                   11118: 
                   11119: path - Array containing all categories back up through the hierarchy from the
                   11120:        current category to the top level.
                   11121: 
                   11122: currcategories - reference to array of current categories assigned to the course
                   11123: 
                   11124: Returns: $output (markup to be displayed).
                   11125: 
                   11126: =cut
                   11127: 
                   11128: sub assign_category_rows {
                   11129:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   11130:     my ($text,$name,$item,$chgstr);
                   11131:     if (ref($cats) eq 'ARRAY') {
                   11132:         my $maxdepth = scalar(@{$cats});
                   11133:         if (ref($cats->[$depth]) eq 'HASH') {
                   11134:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   11135:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   11136:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   11137:                 $text .= '<td><table class="LC_datatable">';
                   11138:                 for (my $j=0; $j<$numchildren; $j++) {
                   11139:                     $name = $cats->[$depth]{$parent}[$j];
                   11140:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   11141:                     my $deeper = $depth+1;
                   11142:                     my $checked = '';
                   11143:                     if (ref($currcategories) eq 'ARRAY') {
                   11144:                         if (@{$currcategories} > 0) {
                   11145:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   11146:                                 $checked = ' checked="checked"';
1.663     raeburn  11147:                             }
                   11148:                         }
                   11149:                     }
1.664     raeburn  11150:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   11151:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  11152:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   11153:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   11154:                              '</td><td>';
1.663     raeburn  11155:                     if (ref($path) eq 'ARRAY') {
                   11156:                         push(@{$path},$name);
                   11157:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   11158:                         pop(@{$path});
                   11159:                     }
                   11160:                     $text .= '</td></tr>';
                   11161:                 }
                   11162:                 $text .= '</table></td>';
                   11163:             }
                   11164:         }
                   11165:     }
                   11166:     return $text;
                   11167: }
                   11168: 
1.655     raeburn  11169: ############################################################
                   11170: ############################################################
                   11171: 
                   11172: 
1.443     albertel 11173: sub commit_customrole {
1.664     raeburn  11174:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  11175:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 11176:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   11177:                          ($end?', ending '.localtime($end):'').': <b>'.
                   11178:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  11179:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 11180:                  '</b><br />';
                   11181:     return $output;
                   11182: }
                   11183: 
                   11184: sub commit_standardrole {
1.541     raeburn  11185:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   11186:     my ($output,$logmsg,$linefeed);
                   11187:     if ($context eq 'auto') {
                   11188:         $linefeed = "\n";
                   11189:     } else {
                   11190:         $linefeed = "<br />\n";
                   11191:     }  
1.443     albertel 11192:     if ($three eq 'st') {
1.541     raeburn  11193:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   11194:                                          $one,$two,$sec,$context);
                   11195:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  11196:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   11197:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 11198:         } else {
1.541     raeburn  11199:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 11200:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  11201:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   11202:             if ($context eq 'auto') {
                   11203:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   11204:             } else {
                   11205:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   11206:                &mt('Add to classlist').': <b>ok</b>';
                   11207:             }
                   11208:             $output .= $linefeed;
1.443     albertel 11209:         }
                   11210:     } else {
                   11211:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   11212:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  11213:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  11214:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  11215:         if ($context eq 'auto') {
                   11216:             $output .= $result.$linefeed;
                   11217:         } else {
                   11218:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   11219:         }
1.443     albertel 11220:     }
                   11221:     return $output;
                   11222: }
                   11223: 
                   11224: sub commit_studentrole {
1.541     raeburn  11225:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  11226:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  11227:     if ($context eq 'auto') {
                   11228:         $linefeed = "\n";
                   11229:     } else {
                   11230:         $linefeed = '<br />'."\n";
                   11231:     }
1.443     albertel 11232:     if (defined($one) && defined($two)) {
                   11233:         my $cid=$one.'_'.$two;
                   11234:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   11235:         my $secchange = 0;
                   11236:         my $expire_role_result;
                   11237:         my $modify_section_result;
1.628     raeburn  11238:         if ($oldsec ne '-1') { 
                   11239:             if ($oldsec ne $sec) {
1.443     albertel 11240:                 $secchange = 1;
1.628     raeburn  11241:                 my $now = time;
1.443     albertel 11242:                 my $uurl='/'.$cid;
                   11243:                 $uurl=~s/\_/\//g;
                   11244:                 if ($oldsec) {
                   11245:                     $uurl.='/'.$oldsec;
                   11246:                 }
1.626     raeburn  11247:                 $oldsecurl = $uurl;
1.628     raeburn  11248:                 $expire_role_result = 
1.652     raeburn  11249:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  11250:                 if ($env{'request.course.sec'} ne '') { 
                   11251:                     if ($expire_role_result eq 'refused') {
                   11252:                         my @roles = ('st');
                   11253:                         my @statuses = ('previous');
                   11254:                         my @roledoms = ($one);
                   11255:                         my $withsec = 1;
                   11256:                         my %roleshash = 
                   11257:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   11258:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   11259:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   11260:                             my ($oldstart,$oldend) = 
                   11261:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   11262:                             if ($oldend > 0 && $oldend <= $now) {
                   11263:                                 $expire_role_result = 'ok';
                   11264:                             }
                   11265:                         }
                   11266:                     }
                   11267:                 }
1.443     albertel 11268:                 $result = $expire_role_result;
                   11269:             }
                   11270:         }
                   11271:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  11272:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 11273:             if ($modify_section_result =~ /^ok/) {
                   11274:                 if ($secchange == 1) {
1.628     raeburn  11275:                     if ($sec eq '') {
                   11276:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   11277:                     } else {
                   11278:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   11279:                     }
1.443     albertel 11280:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  11281:                     if ($sec eq '') {
                   11282:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   11283:                     } else {
                   11284:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   11285:                     }
1.443     albertel 11286:                 } else {
1.628     raeburn  11287:                     if ($sec eq '') {
                   11288:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   11289:                     } else {
                   11290:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   11291:                     }
1.443     albertel 11292:                 }
                   11293:             } else {
1.628     raeburn  11294:                 if ($secchange) {       
                   11295:                     $$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;
                   11296:                 } else {
                   11297:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   11298:                 }
1.443     albertel 11299:             }
                   11300:             $result = $modify_section_result;
                   11301:         } elsif ($secchange == 1) {
1.628     raeburn  11302:             if ($oldsec eq '') {
                   11303:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   11304:             } else {
                   11305:                 $$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;
                   11306:             }
1.626     raeburn  11307:             if ($expire_role_result eq 'refused') {
                   11308:                 my $newsecurl = '/'.$cid;
                   11309:                 $newsecurl =~ s/\_/\//g;
                   11310:                 if ($sec ne '') {
                   11311:                     $newsecurl.='/'.$sec;
                   11312:                 }
                   11313:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   11314:                     if ($sec eq '') {
                   11315:                         $$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;
                   11316:                     } else {
                   11317:                         $$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;
                   11318:                     }
                   11319:                 }
                   11320:             }
1.443     albertel 11321:         }
                   11322:     } else {
1.626     raeburn  11323:         $$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 11324:         $result = "error: incomplete course id\n";
                   11325:     }
                   11326:     return $result;
                   11327: }
                   11328: 
                   11329: ############################################################
                   11330: ############################################################
                   11331: 
1.566     albertel 11332: sub check_clone {
1.578     raeburn  11333:     my ($args,$linefeed) = @_;
1.566     albertel 11334:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   11335:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   11336:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   11337:     my $clonemsg;
                   11338:     my $can_clone = 0;
1.944     raeburn  11339:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  11340:     if ($lctype ne 'community') {
                   11341:         $lctype = 'course';
                   11342:     }
1.566     albertel 11343:     if ($clonehome eq 'no_host') {
1.944     raeburn  11344:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  11345:             $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'});
                   11346:         } else {
                   11347:             $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'});
                   11348:         }     
1.566     albertel 11349:     } else {
                   11350: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  11351:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  11352:             if ($clonedesc{'type'} ne 'Community') {
                   11353:                  $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'});
                   11354:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   11355:             }
                   11356:         }
1.882     raeburn  11357: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   11358:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 11359: 	    $can_clone = 1;
                   11360: 	} else {
                   11361: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   11362: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   11363: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  11364:             if (grep(/^\*$/,@cloners)) {
                   11365:                 $can_clone = 1;
                   11366:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   11367:                 $can_clone = 1;
                   11368:             } else {
1.908     raeburn  11369:                 my $ccrole = 'cc';
1.944     raeburn  11370:                 if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  11371:                     $ccrole = 'co';
                   11372:                 }
1.578     raeburn  11373: 	        my %roleshash =
                   11374: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   11375: 					 $args->{'ccdomain'},
1.908     raeburn  11376:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  11377: 					 [$args->{'clonedomain'}]);
1.908     raeburn  11378: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942     raeburn  11379:                     $can_clone = 1;
                   11380:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
                   11381:                     $can_clone = 1;
                   11382:                 } else {
1.944     raeburn  11383:                     if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  11384:                         $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'});
                   11385:                     } else {
                   11386:                         $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'});
                   11387:                     }
1.578     raeburn  11388: 	        }
1.566     albertel 11389: 	    }
1.578     raeburn  11390:         }
1.566     albertel 11391:     }
                   11392:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   11393: }
                   11394: 
1.444     albertel 11395: sub construct_course {
1.885     raeburn  11396:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 11397:     my $outcome;
1.541     raeburn  11398:     my $linefeed =  '<br />'."\n";
                   11399:     if ($context eq 'auto') {
                   11400:         $linefeed = "\n";
                   11401:     }
1.566     albertel 11402: 
                   11403: #
                   11404: # Are we cloning?
                   11405: #
                   11406:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   11407:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  11408: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 11409: 	if ($context ne 'auto') {
1.578     raeburn  11410:             if ($clonemsg ne '') {
                   11411: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   11412:             }
1.566     albertel 11413: 	}
                   11414: 	$outcome .= $clonemsg.$linefeed;
                   11415: 
                   11416:         if (!$can_clone) {
                   11417: 	    return (0,$outcome);
                   11418: 	}
                   11419:     }
                   11420: 
1.444     albertel 11421: #
                   11422: # Open course
                   11423: #
                   11424:     my $crstype = lc($args->{'crstype'});
                   11425:     my %cenv=();
                   11426:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   11427:                                              $args->{'cdescr'},
                   11428:                                              $args->{'curl'},
                   11429:                                              $args->{'course_home'},
                   11430:                                              $args->{'nonstandard'},
                   11431:                                              $args->{'crscode'},
                   11432:                                              $args->{'ccuname'}.':'.
                   11433:                                              $args->{'ccdomain'},
1.882     raeburn  11434:                                              $args->{'crstype'},
1.885     raeburn  11435:                                              $cnum,$context,$category);
1.444     albertel 11436: 
                   11437:     # Note: The testing routines depend on this being output; see 
                   11438:     # Utils::Course. This needs to at least be output as a comment
                   11439:     # if anyone ever decides to not show this, and Utils::Course::new
                   11440:     # will need to be suitably modified.
1.541     raeburn  11441:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  11442:     if ($$courseid =~ /^error:/) {
                   11443:         return (0,$outcome);
                   11444:     }
                   11445: 
1.444     albertel 11446: #
                   11447: # Check if created correctly
                   11448: #
1.479     albertel 11449:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 11450:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  11451:     if ($crsuhome eq 'no_host') {
                   11452:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   11453:         return (0,$outcome);
                   11454:     }
1.541     raeburn  11455:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 11456: 
1.444     albertel 11457: #
1.566     albertel 11458: # Do the cloning
                   11459: #   
                   11460:     if ($can_clone && $cloneid) {
                   11461: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   11462: 	if ($context ne 'auto') {
                   11463: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   11464: 	}
                   11465: 	$outcome .= $clonemsg.$linefeed;
                   11466: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 11467: # Copy all files
1.637     www      11468: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 11469: # Restore URL
1.566     albertel 11470: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 11471: # Restore title
1.566     albertel 11472: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  11473: # Restore creation date, creator and creation context.
                   11474:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   11475:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   11476:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 11477: # Mark as cloned
1.566     albertel 11478: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      11479: # Need to clone grading mode
                   11480:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   11481:         $cenv{'grading'}=$newenv{'grading'};
                   11482: # Do not clone these environment entries
                   11483:         &Apache::lonnet::del('environment',
                   11484:                   ['default_enrollment_start_date',
                   11485:                    'default_enrollment_end_date',
                   11486:                    'question.email',
                   11487:                    'policy.email',
                   11488:                    'comment.email',
                   11489:                    'pch.users.denied',
1.725     raeburn  11490:                    'plc.users.denied',
                   11491:                    'hidefromcat',
                   11492:                    'categories'],
1.638     www      11493:                    $$crsudom,$$crsunum);
1.444     albertel 11494:     }
1.566     albertel 11495: 
1.444     albertel 11496: #
                   11497: # Set environment (will override cloned, if existing)
                   11498: #
                   11499:     my @sections = ();
                   11500:     my @xlists = ();
                   11501:     if ($args->{'crstype'}) {
                   11502:         $cenv{'type'}=$args->{'crstype'};
                   11503:     }
                   11504:     if ($args->{'crsid'}) {
                   11505:         $cenv{'courseid'}=$args->{'crsid'};
                   11506:     }
                   11507:     if ($args->{'crscode'}) {
                   11508:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   11509:     }
                   11510:     if ($args->{'crsquota'} ne '') {
                   11511:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   11512:     } else {
                   11513:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   11514:     }
                   11515:     if ($args->{'ccuname'}) {
                   11516:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   11517:                                         ':'.$args->{'ccdomain'};
                   11518:     } else {
                   11519:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   11520:     }
                   11521:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   11522:     if ($args->{'crssections'}) {
                   11523:         $cenv{'internal.sectionnums'} = '';
                   11524:         if ($args->{'crssections'} =~ m/,/) {
                   11525:             @sections = split/,/,$args->{'crssections'};
                   11526:         } else {
                   11527:             $sections[0] = $args->{'crssections'};
                   11528:         }
                   11529:         if (@sections > 0) {
                   11530:             foreach my $item (@sections) {
                   11531:                 my ($sec,$gp) = split/:/,$item;
                   11532:                 my $class = $args->{'crscode'}.$sec;
                   11533:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   11534:                 $cenv{'internal.sectionnums'} .= $item.',';
                   11535:                 unless ($addcheck eq 'ok') {
                   11536:                     push @badclasses, $class;
                   11537:                 }
                   11538:             }
                   11539:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   11540:         }
                   11541:     }
                   11542: # do not hide course coordinator from staff listing, 
                   11543: # even if privileged
                   11544:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   11545: # add crosslistings
                   11546:     if ($args->{'crsxlist'}) {
                   11547:         $cenv{'internal.crosslistings'}='';
                   11548:         if ($args->{'crsxlist'} =~ m/,/) {
                   11549:             @xlists = split/,/,$args->{'crsxlist'};
                   11550:         } else {
                   11551:             $xlists[0] = $args->{'crsxlist'};
                   11552:         }
                   11553:         if (@xlists > 0) {
                   11554:             foreach my $item (@xlists) {
                   11555:                 my ($xl,$gp) = split/:/,$item;
                   11556:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   11557:                 $cenv{'internal.crosslistings'} .= $item.',';
                   11558:                 unless ($addcheck eq 'ok') {
                   11559:                     push @badclasses, $xl;
                   11560:                 }
                   11561:             }
                   11562:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   11563:         }
                   11564:     }
                   11565:     if ($args->{'autoadds'}) {
                   11566:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   11567:     }
                   11568:     if ($args->{'autodrops'}) {
                   11569:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   11570:     }
                   11571: # check for notification of enrollment changes
                   11572:     my @notified = ();
                   11573:     if ($args->{'notify_owner'}) {
                   11574:         if ($args->{'ccuname'} ne '') {
                   11575:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   11576:         }
                   11577:     }
                   11578:     if ($args->{'notify_dc'}) {
                   11579:         if ($uname ne '') { 
1.630     raeburn  11580:             push(@notified,$uname.':'.$udom);
1.444     albertel 11581:         }
                   11582:     }
                   11583:     if (@notified > 0) {
                   11584:         my $notifylist;
                   11585:         if (@notified > 1) {
                   11586:             $notifylist = join(',',@notified);
                   11587:         } else {
                   11588:             $notifylist = $notified[0];
                   11589:         }
                   11590:         $cenv{'internal.notifylist'} = $notifylist;
                   11591:     }
                   11592:     if (@badclasses > 0) {
                   11593:         my %lt=&Apache::lonlocal::texthash(
                   11594:                 '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',
                   11595:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   11596:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   11597:         );
1.541     raeburn  11598:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   11599:                            ' ('.$lt{'adby'}.')';
                   11600:         if ($context eq 'auto') {
                   11601:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 11602:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  11603:             foreach my $item (@badclasses) {
                   11604:                 if ($context eq 'auto') {
                   11605:                     $outcome .= " - $item\n";
                   11606:                 } else {
                   11607:                     $outcome .= "<li>$item</li>\n";
                   11608:                 }
                   11609:             }
                   11610:             if ($context eq 'auto') {
                   11611:                 $outcome .= $linefeed;
                   11612:             } else {
1.566     albertel 11613:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  11614:             }
                   11615:         } 
1.444     albertel 11616:     }
                   11617:     if ($args->{'no_end_date'}) {
                   11618:         $args->{'endaccess'} = 0;
                   11619:     }
                   11620:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   11621:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   11622:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   11623:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   11624:     if ($args->{'showphotos'}) {
                   11625:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   11626:     }
                   11627:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   11628:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   11629:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   11630:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  11631:             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'); 
                   11632:             if ($context eq 'auto') {
                   11633:                 $outcome .= $krb_msg;
                   11634:             } else {
1.566     albertel 11635:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  11636:             }
                   11637:             $outcome .= $linefeed;
1.444     albertel 11638:         }
                   11639:     }
                   11640:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   11641:        if ($args->{'setpolicy'}) {
                   11642:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   11643:        }
                   11644:        if ($args->{'setcontent'}) {
                   11645:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   11646:        }
                   11647:     }
                   11648:     if ($args->{'reshome'}) {
                   11649: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   11650: 	$cenv{'reshome'}=~s/\/+$/\//;
                   11651:     }
                   11652: #
                   11653: # course has keyed access
                   11654: #
                   11655:     if ($args->{'setkeys'}) {
                   11656:        $cenv{'keyaccess'}='yes';
                   11657:     }
                   11658: # if specified, key authority is not course, but user
                   11659: # only active if keyaccess is yes
                   11660:     if ($args->{'keyauth'}) {
1.487     albertel 11661: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   11662: 	$user = &LONCAPA::clean_username($user);
                   11663: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     11664: 	if ($user ne '' && $domain ne '') {
1.487     albertel 11665: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 11666: 	}
                   11667:     }
                   11668: 
                   11669:     if ($args->{'disresdis'}) {
                   11670:         $cenv{'pch.roles.denied'}='st';
                   11671:     }
                   11672:     if ($args->{'disablechat'}) {
                   11673:         $cenv{'plc.roles.denied'}='st';
                   11674:     }
                   11675: 
                   11676:     # Record we've not yet viewed the Course Initialization Helper for this 
                   11677:     # course
                   11678:     $cenv{'course.helper.not.run'} = 1;
                   11679:     #
                   11680:     # Use new Randomseed
                   11681:     #
                   11682:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   11683:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   11684:     #
                   11685:     # The encryption code and receipt prefix for this course
                   11686:     #
                   11687:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   11688:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   11689:     #
                   11690:     # By default, use standard grading
                   11691:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   11692: 
1.541     raeburn  11693:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   11694:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 11695: #
                   11696: # Open all assignments
                   11697: #
                   11698:     if ($args->{'openall'}) {
                   11699:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   11700:        my %storecontent = ($storeunder         => time,
                   11701:                            $storeunder.'.type' => 'date_start');
                   11702:        
                   11703:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  11704:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 11705:    }
                   11706: #
                   11707: # Set first page
                   11708: #
                   11709:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   11710: 	    || ($cloneid)) {
1.445     albertel 11711: 	use LONCAPA::map;
1.444     albertel 11712: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 11713: 
                   11714: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   11715:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   11716: 
1.444     albertel 11717:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   11718:         my $title; my $url;
                   11719:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   11720: 	    $title=&mt('Syllabus');
1.444     albertel 11721:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   11722:         } else {
1.963     raeburn  11723:             $title=&mt('Table of Contents');
1.444     albertel 11724:             $url='/adm/navmaps';
                   11725:         }
1.445     albertel 11726: 
                   11727:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   11728: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   11729: 
                   11730: 	if ($errtext) { $fatal=2; }
1.541     raeburn  11731:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 11732:     }
1.566     albertel 11733: 
                   11734:     return (1,$outcome);
1.444     albertel 11735: }
                   11736: 
                   11737: ############################################################
                   11738: ############################################################
                   11739: 
1.953     droeschl 11740: #SD
                   11741: # only Community and Course, or anything else?
1.378     raeburn  11742: sub course_type {
                   11743:     my ($cid) = @_;
                   11744:     if (!defined($cid)) {
                   11745:         $cid = $env{'request.course.id'};
                   11746:     }
1.404     albertel 11747:     if (defined($env{'course.'.$cid.'.type'})) {
                   11748:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  11749:     } else {
                   11750:         return 'Course';
1.377     raeburn  11751:     }
                   11752: }
1.156     albertel 11753: 
1.406     raeburn  11754: sub group_term {
                   11755:     my $crstype = &course_type();
                   11756:     my %names = (
                   11757:                   'Course' => 'group',
1.865     raeburn  11758:                   'Community' => 'group',
1.406     raeburn  11759:                 );
                   11760:     return $names{$crstype};
                   11761: }
                   11762: 
1.902     raeburn  11763: sub course_types {
                   11764:     my @types = ('official','unofficial','community');
                   11765:     my %typename = (
                   11766:                          official   => 'Official course',
                   11767:                          unofficial => 'Unofficial course',
                   11768:                          community  => 'Community',
                   11769:                    );
                   11770:     return (\@types,\%typename);
                   11771: }
                   11772: 
1.156     albertel 11773: sub icon {
                   11774:     my ($file)=@_;
1.505     albertel 11775:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 11776:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 11777:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 11778:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   11779: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   11780: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   11781: 	            $curfext.".gif") {
                   11782: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   11783: 		$curfext.".gif";
                   11784: 	}
                   11785:     }
1.249     albertel 11786:     return &lonhttpdurl($iconname);
1.154     albertel 11787: } 
1.84      albertel 11788: 
1.575     albertel 11789: sub lonhttpdurl {
1.692     www      11790: #
                   11791: # Had been used for "small fry" static images on separate port 8080.
                   11792: # Modify here if lightweight http functionality desired again.
                   11793: # Currently eliminated due to increasing firewall issues.
                   11794: #
1.575     albertel 11795:     my ($url)=@_;
1.692     www      11796:     return $url;
1.215     albertel 11797: }
                   11798: 
1.213     albertel 11799: sub connection_aborted {
                   11800:     my ($r)=@_;
                   11801:     $r->print(" ");$r->rflush();
                   11802:     my $c = $r->connection;
                   11803:     return $c->aborted();
                   11804: }
                   11805: 
1.221     foxr     11806: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     11807: #    strings as 'strings'.
                   11808: sub escape_single {
1.221     foxr     11809:     my ($input) = @_;
1.223     albertel 11810:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     11811:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   11812:     return $input;
                   11813: }
1.223     albertel 11814: 
1.222     foxr     11815: #  Same as escape_single, but escape's "'s  This 
                   11816: #  can be used for  "strings"
                   11817: sub escape_double {
                   11818:     my ($input) = @_;
                   11819:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   11820:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   11821:     return $input;
                   11822: }
1.223     albertel 11823:  
1.222     foxr     11824: #   Escapes the last element of a full URL.
                   11825: sub escape_url {
                   11826:     my ($url)   = @_;
1.238     raeburn  11827:     my @urlslices = split(/\//, $url,-1);
1.369     www      11828:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 11829:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     11830: }
1.462     albertel 11831: 
1.820     raeburn  11832: sub compare_arrays {
                   11833:     my ($arrayref1,$arrayref2) = @_;
                   11834:     my (@difference,%count);
                   11835:     @difference = ();
                   11836:     %count = ();
                   11837:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   11838:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   11839:         foreach my $element (keys(%count)) {
                   11840:             if ($count{$element} == 1) {
                   11841:                 push(@difference,$element);
                   11842:             }
                   11843:         }
                   11844:     }
                   11845:     return @difference;
                   11846: }
                   11847: 
1.817     bisitz   11848: # -------------------------------------------------------- Initialize user login
1.462     albertel 11849: sub init_user_environment {
1.463     albertel 11850:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 11851:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   11852: 
                   11853:     my $public=($username eq 'public' && $domain eq 'public');
                   11854: 
                   11855: # See if old ID present, if so, remove
                   11856: 
                   11857:     my ($filename,$cookie,$userroles);
                   11858:     my $now=time;
                   11859: 
                   11860:     if ($public) {
                   11861: 	my $max_public=100;
                   11862: 	my $oldest;
                   11863: 	my $oldest_time=0;
                   11864: 	for(my $next=1;$next<=$max_public;$next++) {
                   11865: 	    if (-e $lonids."/publicuser_$next.id") {
                   11866: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   11867: 		if ($mtime<$oldest_time || !$oldest_time) {
                   11868: 		    $oldest_time=$mtime;
                   11869: 		    $oldest=$next;
                   11870: 		}
                   11871: 	    } else {
                   11872: 		$cookie="publicuser_$next";
                   11873: 		last;
                   11874: 	    }
                   11875: 	}
                   11876: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   11877:     } else {
1.463     albertel 11878: 	# if this isn't a robot, kill any existing non-robot sessions
                   11879: 	if (!$args->{'robot'}) {
                   11880: 	    opendir(DIR,$lonids);
                   11881: 	    while ($filename=readdir(DIR)) {
                   11882: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   11883: 		    unlink($lonids.'/'.$filename);
                   11884: 		}
1.462     albertel 11885: 	    }
1.463     albertel 11886: 	    closedir(DIR);
1.462     albertel 11887: 	}
                   11888: # Give them a new cookie
1.463     albertel 11889: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      11890: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 11891: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 11892:     
                   11893: # Initialize roles
                   11894: 
                   11895: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   11896:     }
                   11897: # ------------------------------------ Check browser type and MathML capability
                   11898: 
                   11899:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   11900:         $clientunicode,$clientos) = &decode_user_agent($r);
                   11901: 
                   11902: # ------------------------------------------------------------- Get environment
                   11903: 
                   11904:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   11905:     my ($tmp) = keys(%userenv);
                   11906:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   11907:     } else {
                   11908: 	undef(%userenv);
                   11909:     }
                   11910:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   11911: 	$form->{'interface'}=$userenv{'interface'};
                   11912:     }
                   11913:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   11914: 
                   11915: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   11916:     foreach my $option ('interface','localpath','localres') {
                   11917:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 11918:     }
                   11919: # --------------------------------------------------------- Write first profile
                   11920: 
                   11921:     {
                   11922: 	my %initial_env = 
                   11923: 	    ("user.name"          => $username,
                   11924: 	     "user.domain"        => $domain,
                   11925: 	     "user.home"          => $authhost,
                   11926: 	     "browser.type"       => $clientbrowser,
                   11927: 	     "browser.version"    => $clientversion,
                   11928: 	     "browser.mathml"     => $clientmathml,
                   11929: 	     "browser.unicode"    => $clientunicode,
                   11930: 	     "browser.os"         => $clientos,
                   11931: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   11932: 	     "request.course.fn"  => '',
                   11933: 	     "request.course.uri" => '',
                   11934: 	     "request.course.sec" => '',
                   11935: 	     "request.role"       => 'cm',
                   11936: 	     "request.role.adv"   => $env{'user.adv'},
                   11937: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   11938: 
                   11939:         if ($form->{'localpath'}) {
                   11940: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   11941: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   11942:         }
                   11943: 	
                   11944: 	if ($form->{'interface'}) {
                   11945: 	    $form->{'interface'}=~s/\W//gs;
                   11946: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   11947: 	    $env{'browser.interface'}=$form->{'interface'};
                   11948: 	}
                   11949: 
1.981     raeburn  11950:         my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016    raeburn  11951:         my %domdef;
                   11952:         unless ($domain eq 'public') {
                   11953:             %domdef = &Apache::lonnet::get_domain_defaults($domain);
                   11954:         }
1.980     raeburn  11955: 
1.724     raeburn  11956:         foreach my $tool ('aboutme','blog','portfolio') {
                   11957:             $userenv{'availabletools.'.$tool} = 
1.980     raeburn  11958:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   11959:                                                   undef,\%userenv,\%domdef,\%is_adv);
1.724     raeburn  11960:         }
                   11961: 
1.864     raeburn  11962:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  11963:             $userenv{'canrequest.'.$crstype} =
                   11964:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980     raeburn  11965:                                                   'reload','requestcourses',
                   11966:                                                   \%userenv,\%domdef,\%is_adv);
1.765     raeburn  11967:         }
                   11968: 
1.462     albertel 11969: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   11970: 	
                   11971: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   11972: 		 &GDBM_WRCREAT(),0640)) {
                   11973: 	    &_add_to_env(\%disk_env,\%initial_env);
                   11974: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   11975: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 11976: 	    if (ref($args->{'extra_env'})) {
                   11977: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   11978: 	    }
1.462     albertel 11979: 	    untie(%disk_env);
                   11980: 	} else {
1.705     tempelho 11981: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   11982: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 11983: 	    return 'error: '.$!;
                   11984: 	}
                   11985:     }
                   11986:     $env{'request.role'}='cm';
                   11987:     $env{'request.role.adv'}=$env{'user.adv'};
                   11988:     $env{'browser.type'}=$clientbrowser;
                   11989: 
                   11990:     return $cookie;
                   11991: 
                   11992: }
                   11993: 
                   11994: sub _add_to_env {
                   11995:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  11996:     if (ref($env_data) eq 'HASH') {
                   11997:         while (my ($key,$value) = each(%$env_data)) {
                   11998: 	    $idf->{$prefix.$key} = $value;
                   11999: 	    $env{$prefix.$key}   = $value;
                   12000:         }
1.462     albertel 12001:     }
                   12002: }
                   12003: 
1.685     tempelho 12004: # --- Get the symbolic name of a problem and the url
                   12005: sub get_symb {
                   12006:     my ($request,$silent) = @_;
1.726     raeburn  12007:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 12008:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   12009:     if ($symb eq '') {
                   12010:         if (!$silent) {
                   12011:             $request->print("Unable to handle ambiguous references:$url:.");
                   12012:             return ();
                   12013:         }
                   12014:     }
                   12015:     &Apache::lonenc::check_decrypt(\$symb);
                   12016:     return ($symb);
                   12017: }
                   12018: 
                   12019: # --------------------------------------------------------------Get annotation
                   12020: 
                   12021: sub get_annotation {
                   12022:     my ($symb,$enc) = @_;
                   12023: 
                   12024:     my $key = $symb;
                   12025:     if (!$enc) {
                   12026:         $key =
                   12027:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   12028:     }
                   12029:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   12030:     return $annotation{$key};
                   12031: }
                   12032: 
                   12033: sub clean_symb {
1.731     raeburn  12034:     my ($symb,$delete_enc) = @_;
1.685     tempelho 12035: 
                   12036:     &Apache::lonenc::check_decrypt(\$symb);
                   12037:     my $enc = $env{'request.enc'};
1.731     raeburn  12038:     if ($delete_enc) {
1.730     raeburn  12039:         delete($env{'request.enc'});
                   12040:     }
1.685     tempelho 12041: 
                   12042:     return ($symb,$enc);
                   12043: }
1.462     albertel 12044: 
1.990     raeburn  12045: sub build_release_hashes {
                   12046:     my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
                   12047:     return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
                   12048:                   (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
                   12049:                   (ref($randomizetry) eq 'HASH'));
                   12050:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   12051:         my ($item,$name,$value) = split(/:/,$key);
                   12052:         if ($item eq 'parameter') {
                   12053:             if (ref($checkparms->{$name}) eq 'ARRAY') {
                   12054:                 unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
                   12055:                     push(@{$checkparms->{$name}},$value);
                   12056:                 }
                   12057:             } else {
                   12058:                 push(@{$checkparms->{$name}},$value);
                   12059:             }
                   12060:         } elsif ($item eq 'resourcetag') {
                   12061:             if ($name eq 'responsetype') {
                   12062:                 $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
                   12063:             }
                   12064:         } elsif ($item eq 'course') {
                   12065:             if ($name eq 'crstype') {
                   12066:                 $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
                   12067:             }
                   12068:         }
                   12069:     }
                   12070:     ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
                   12071:     ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
                   12072:     return;
                   12073: }
                   12074: 
1.41      ng       12075: =pod
                   12076: 
                   12077: =back
                   12078: 
1.112     bowersj2 12079: =cut
1.41      ng       12080: 
1.112     bowersj2 12081: 1;
                   12082: __END__;
1.41      ng       12083: 

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