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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.822   ! bisitz      4: # $Id: loncommon.pm,v 1.821 2009/05/18 16:29:55 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.12      harris41  157: my %cprtag;
1.192     taceyjo1  158: my %scprtag;
1.351     www       159: my %fe; my %fd; my %fm;
1.41      ng        160: my %category_extensions;
1.12      harris41  161: 
1.46      matthew   162: # ---------------------------------------------- Thesaurus variables
1.144     matthew   163: #
                    164: # %Keywords:
                    165: #      A hash used by &keyword to determine if a word is considered a keyword.
                    166: # $thesaurus_db_file 
                    167: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   168: 
                    169: my %Keywords;
                    170: my $thesaurus_db_file;
                    171: 
1.144     matthew   172: #
                    173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    174: # thesaurus.tab, and filecategories.tab.
                    175: #
1.18      www       176: BEGIN {
1.46      matthew   177:     # Variable initialization
                    178:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    179:     #
1.22      www       180:     unless ($readit) {
1.12      harris41  181: # ------------------------------------------------------------------- languages
                    182:     {
1.158     raeburn   183:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    184:                                    '/language.tab';
                    185:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  186:             while (my $line = <$fh>) {
                    187:                 next if ($line=~/^\#/);
                    188:                 chomp($line);
                    189:                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158     raeburn   190:                 $language{$key}=$val.' - '.$enc;
                    191:                 if ($sup) {
                    192:                     $supported_language{$key}=$sup;
                    193:                 }
                    194:             }
                    195:             close($fh);
                    196:         }
1.12      harris41  197:     }
                    198: # ------------------------------------------------------------------ copyrights
                    199:     {
1.158     raeburn   200:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    201:                                   '/copyright.tab';
                    202:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  203:             while (my $line = <$fh>) {
                    204:                 next if ($line=~/^\#/);
                    205:                 chomp($line);
                    206:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   207:                 $cprtag{$key}=$val;
                    208:             }
                    209:             close($fh);
                    210:         }
1.12      harris41  211:     }
1.351     www       212: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  213:     {
                    214:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    215:                                   '/source_copyright.tab';
                    216:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  217:             while (my $line = <$fh>) {
                    218:                 next if ($line =~ /^\#/);
                    219:                 chomp($line);
                    220:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  221:                 $scprtag{$key}=$val;
                    222:             }
                    223:             close($fh);
                    224:         }
                    225:     }
1.63      www       226: 
1.517     raeburn   227: # -------------------------------------------------------------- default domain designs
1.63      www       228:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   229:     my $designfile = $designdir.'/default.tab';
                    230:     if ( open (my $fh,"<$designfile") ) {
                    231:         while (my $line = <$fh>) {
                    232:             next if ($line =~ /^\#/);
                    233:             chomp($line);
                    234:             my ($key,$val)=(split(/\=/,$line));
                    235:             if ($val) { $defaultdesign{$key}=$val; }
                    236:         }
                    237:         close($fh);
1.63      www       238:     }
                    239: 
1.15      harris41  240: # ------------------------------------------------------------- file categories
                    241:     {
1.158     raeburn   242:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    243:                                   '/filecategories.tab';
                    244:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  245: 	    while (my $line = <$fh>) {
                    246: 		next if ($line =~ /^\#/);
                    247: 		chomp($line);
                    248:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   249:                 push @{$category_extensions{lc($category)}},$extension;
                    250:             }
                    251:             close($fh);
                    252:         }
                    253: 
1.15      harris41  254:     }
1.12      harris41  255: # ------------------------------------------------------------------ file types
                    256:     {
1.158     raeburn   257:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    258:                '/filetypes.tab';
                    259:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  260:             while (my $line = <$fh>) {
                    261: 		next if ($line =~ /^\#/);
                    262: 		chomp($line);
                    263:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   264:                 if ($descr ne '') {
                    265:                     $fe{$ending}=lc($emb);
                    266:                     $fd{$ending}=$descr;
1.351     www       267:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   268:                 }
                    269:             }
                    270:             close($fh);
                    271:         }
1.12      harris41  272:     }
1.22      www       273:     &Apache::lonnet::logthis(
1.705     tempelho  274:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       275:     $readit=1;
1.46      matthew   276:     }  # end of unless($readit) 
1.32      matthew   277:     
                    278: }
1.112     bowersj2  279: 
1.42      matthew   280: ###############################################################
                    281: ##           HTML and Javascript Helper Functions            ##
                    282: ###############################################################
                    283: 
                    284: =pod 
                    285: 
1.112     bowersj2  286: =head1 HTML and Javascript Functions
1.42      matthew   287: 
1.112     bowersj2  288: =over 4
                    289: 
1.648     raeburn   290: =item * &browser_and_searcher_javascript()
1.112     bowersj2  291: 
                    292: X<browsing, javascript>X<searching, javascript>Returns a string
                    293: containing javascript with two functions, C<openbrowser> and
                    294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    295: tags.
1.42      matthew   296: 
1.648     raeburn   297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   298: 
                    299: inputs: formname, elementname, only, omit
                    300: 
                    301: formname and elementname indicate the name of the html form and name of
                    302: the element that the results of the browsing selection are to be placed in. 
                    303: 
                    304: Specifying 'only' will restrict the browser to displaying only files
1.185     www       305: with the given extension.  Can be a comma separated list.
1.42      matthew   306: 
                    307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       308: with the given extension.  Can be a comma separated list.
1.42      matthew   309: 
1.648     raeburn   310: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   311: 
                    312: Inputs: formname, elementname
                    313: 
                    314: formname and elementname specify the name of the html form and the name
                    315: of the element the selection from the search results will be placed in.
1.542     raeburn   316: 
1.42      matthew   317: =cut
                    318: 
                    319: sub browser_and_searcher_javascript {
1.199     albertel  320:     my ($mode)=@_;
                    321:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  322:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   323:     return <<END;
1.219     albertel  324: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   325:     var editbrowser = null;
1.135     albertel  326:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       327:         var url = '$resurl/?';
1.42      matthew   328:         if (editbrowser == null) {
                    329:             url += 'launch=1&';
                    330:         }
                    331:         url += 'catalogmode=interactive&';
1.199     albertel  332:         url += 'mode=$mode&';
1.611     albertel  333:         url += 'inhibitmenu=yes&';
1.42      matthew   334:         url += 'form=' + formname + '&';
                    335:         if (only != null) {
                    336:             url += 'only=' + only + '&';
1.217     albertel  337:         } else {
                    338:             url += 'only=&';
                    339: 	}
1.42      matthew   340:         if (omit != null) {
                    341:             url += 'omit=' + omit + '&';
1.217     albertel  342:         } else {
                    343:             url += 'omit=&';
                    344: 	}
1.135     albertel  345:         if (titleelement != null) {
                    346:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  347:         } else {
                    348: 	    url += 'titleelement=&';
                    349: 	}
1.42      matthew   350:         url += 'element=' + elementname + '';
                    351:         var title = 'Browser';
1.435     albertel  352:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   353:         options += ',width=700,height=600';
                    354:         editbrowser = open(url,title,options,'1');
                    355:         editbrowser.focus();
                    356:     }
                    357:     var editsearcher;
1.135     albertel  358:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   359:         var url = '/adm/searchcat?';
                    360:         if (editsearcher == null) {
                    361:             url += 'launch=1&';
                    362:         }
                    363:         url += 'catalogmode=interactive&';
1.199     albertel  364:         url += 'mode=$mode&';
1.42      matthew   365:         url += 'form=' + formname + '&';
1.135     albertel  366:         if (titleelement != null) {
                    367:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  368:         } else {
                    369: 	    url += 'titleelement=&';
                    370: 	}
1.42      matthew   371:         url += 'element=' + elementname + '';
                    372:         var title = 'Search';
1.435     albertel  373:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   374:         options += ',width=700,height=600';
                    375:         editsearcher = open(url,title,options,'1');
                    376:         editsearcher.focus();
                    377:     }
1.219     albertel  378: // END LON-CAPA Internal -->
1.42      matthew   379: END
1.170     www       380: }
                    381: 
                    382: sub lastresurl {
1.258     albertel  383:     if ($env{'environment.lastresurl'}) {
                    384: 	return $env{'environment.lastresurl'}
1.170     www       385:     } else {
                    386: 	return '/res';
                    387:     }
                    388: }
                    389: 
                    390: sub storeresurl {
                    391:     my $resurl=&Apache::lonnet::clutter(shift);
                    392:     unless ($resurl=~/^\/res/) { return 0; }
                    393:     $resurl=~s/\/$//;
                    394:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   395:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       396:     return 1;
1.42      matthew   397: }
                    398: 
1.74      www       399: sub studentbrowser_javascript {
1.111     www       400:    unless (
1.258     albertel  401:             (($env{'request.course.id'}) && 
1.302     albertel  402:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    403: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    404: 					  '/'.$env{'request.course.sec'})
                    405: 	      ))
1.258     albertel  406:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       407:           ) { return ''; }  
1.74      www       408:    return (<<'ENDSTDBRW');
1.776     bisitz    409: <script type="text/javascript" language="Javascript">
1.74      www       410:     var stdeditbrowser;
1.793     raeburn   411:     function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74      www       412:         var url = '/adm/pickstudent?';
                    413:         var filter;
1.558     albertel  414: 	if (!ignorefilter) {
                    415: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    416: 	}
1.74      www       417:         if (filter != null) {
                    418:            if (filter != '') {
                    419:                url += 'filter='+filter+'&';
                    420: 	   }
                    421:         }
                    422:         url += 'form=' + formname + '&unameelement='+uname+
                    423:                                     '&udomelement='+udom;
1.111     www       424: 	if (roleflag) { url+="&roles=1"; }
1.793     raeburn   425:         if (courseadvonly) { url+="&courseadvonly=1"; }
1.102     www       426:         var title = 'Student_Browser';
1.74      www       427:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    428:         options += ',width=700,height=600';
                    429:         stdeditbrowser = open(url,title,options,'1');
                    430:         stdeditbrowser.focus();
                    431:     }
                    432: </script>
                    433: ENDSTDBRW
                    434: }
1.42      matthew   435: 
1.74      www       436: sub selectstudent_link {
1.793     raeburn   437:    my ($form,$unameele,$udomele,$courseadvonly)=@_;
                    438:    my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258     albertel  439:    if ($env{'request.course.id'}) {  
1.302     albertel  440:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    441: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    442: 					'/'.$env{'request.course.sec'})) {
1.111     www       443: 	   return '';
                    444:        }
1.793     raeburn   445:        if ($courseadvonly)  {
                    446:            $callargs .= ",'',1,1";
                    447:        }
                    448:        return '<span class="LC_nobreak">'.
                    449:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    450:               &mt('Select User').'</a></span>';
1.74      www       451:    }
1.258     albertel  452:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793     raeburn   453:        $callargs .= ",1"; 
                    454:        return '<span class="LC_nobreak">'.
                    455:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    456:               &mt('Select User').'</a></span>';
1.111     www       457:    }
                    458:    return '';
1.91      www       459: }
                    460: 
1.653     raeburn   461: sub authorbrowser_javascript {
                    462:     return <<"ENDAUTHORBRW";
1.776     bisitz    463: <script type="text/javascript" language="JavaScript">
1.653     raeburn   464: var stdeditbrowser;
                    465: 
                    466: function openauthorbrowser(formname,udom) {
                    467:     var url = '/adm/pickauthor?';
                    468:     url += 'form='+formname+'&roledom='+udom;
                    469:     var title = 'Author_Browser';
                    470:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    471:     options += ',width=700,height=600';
                    472:     stdeditbrowser = open(url,title,options,'1');
                    473:     stdeditbrowser.focus();
                    474: }
                    475: 
                    476: </script>
                    477: ENDAUTHORBRW
                    478: }
                    479: 
1.91      www       480: sub coursebrowser_javascript {
1.468     raeburn   481:     my ($domainfilter,$sec_element,$formname)=@_;
1.377     raeburn   482:     my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');
1.468     raeburn   483:    my $output = '
1.776     bisitz    484: <script type="text/javascript" language="JavaScript">
1.468     raeburn   485:     var stdeditbrowser;'."\n";
                    486:    $output .= <<"ENDSTDBRW";
1.377     raeburn   487:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91      www       488:         var url = '/adm/pickcourse?';
1.468     raeburn   489:         var domainfilter = '';
                    490:         var formid = getFormIdByName(formname);
                    491:         if (formid > -1) {
                    492:             var domid = getIndexByName(formid,udom);
                    493:             if (domid > -1) {
                    494:                 if (document.forms[formid].elements[domid].type == 'select-one') {
                    495:                     domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    496:                 }
                    497:                 if (document.forms[formid].elements[domid].type == 'hidden') {
                    498:                     domainfilter=document.forms[formid].elements[domid].value;
                    499:                 }
                    500:             }
1.91      www       501:         }
1.128     albertel  502:         if (domainfilter != null) {
                    503:            if (domainfilter != '') {
                    504:                url += 'domainfilter='+domainfilter+'&';
                    505: 	   }
                    506:         }
1.91      www       507:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  508: 	                            '&cdomelement='+udom+
                    509:                                     '&cnameelement='+desc;
1.468     raeburn   510:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   511:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   512:                 url += '&roleelement='+extra_element;
                    513:                 if (domainfilter == null || domainfilter == '') {
                    514:                     url += '&domainfilter='+extra_element;
                    515:                 }
1.234     raeburn   516:             }
1.468     raeburn   517:             else {
                    518:                 if (formname == 'portform') {
                    519:                     url += '&setroles='+extra_element;
1.800     raeburn   520:                 } else {
                    521:                     if (formname == 'rules') {
                    522:                         url += '&fixeddom='+extra_element; 
                    523:                     }
1.468     raeburn   524:                 }
                    525:             }     
1.230     raeburn   526:         }
1.293     raeburn   527:         if (multflag !=null && multflag != '') {
                    528:             url += '&multiple='+multflag;
                    529:         }
1.377     raeburn   530:         if (crstype == 'Course/Group') {
                    531:             if (formname == 'cu') {
                    532:                 crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value; 
                    533:                 if (crstype == "") {
                    534:                     alert("$crs_or_grp_alert");
                    535:                     return;
                    536:                 }
                    537:             }
                    538:         }
                    539:         if (crstype !=null && crstype != '') {
                    540:             url += '&type='+crstype;
                    541:         }
1.102     www       542:         var title = 'Course_Browser';
1.91      www       543:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    544:         options += ',width=700,height=600';
                    545:         stdeditbrowser = open(url,title,options,'1');
                    546:         stdeditbrowser.focus();
                    547:     }
1.468     raeburn   548: 
                    549:     function getFormIdByName(formname) {
                    550:         for (var i=0;i<document.forms.length;i++) {
                    551:             if (document.forms[i].name == formname) {
                    552:                 return i;
                    553:             }
                    554:         }
                    555:         return -1; 
                    556:     }
                    557: 
                    558:     function getIndexByName(formid,item) {
                    559:         for (var i=0;i<document.forms[formid].elements.length;i++) {
                    560:             if (document.forms[formid].elements[i].name == item) {
                    561:                 return i;
                    562:             }
                    563:         }
                    564:         return -1;
                    565:     }
1.91      www       566: ENDSTDBRW
1.468     raeburn   567:     if ($sec_element ne '') {
                    568:         $output .= &setsec_javascript($sec_element,$formname);
                    569:     }
                    570:     $output .= '
                    571: </script>';
                    572:     return $output;
                    573: }
                    574: 
                    575: sub setsec_javascript {
                    576:     my ($sec_element,$formname) = @_;
                    577:     my $setsections = qq|
                    578: function setSect(sectionlist) {
1.629     raeburn   579:     var sectionsArray = new Array();
                    580:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    581:         sectionsArray = sectionlist.split(",");
                    582:     }
1.468     raeburn   583:     var numSections = sectionsArray.length;
                    584:     document.$formname.$sec_element.length = 0;
                    585:     if (numSections == 0) {
                    586:         document.$formname.$sec_element.multiple=false;
                    587:         document.$formname.$sec_element.size=1;
                    588:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    589:     } else {
                    590:         if (numSections == 1) {
                    591:             document.$formname.$sec_element.multiple=false;
                    592:             document.$formname.$sec_element.size=1;
                    593:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    594:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    595:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    596:         } else {
                    597:             for (var i=0; i<numSections; i++) {
                    598:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    599:             }
                    600:             document.$formname.$sec_element.multiple=true
                    601:             if (numSections < 3) {
                    602:                 document.$formname.$sec_element.size=numSections;
                    603:             } else {
                    604:                 document.$formname.$sec_element.size=3;
                    605:             }
                    606:             document.$formname.$sec_element.options[0].selected = false
                    607:         }
                    608:     }
1.91      www       609: }
1.468     raeburn   610: |;
                    611:     return $setsections;
                    612: }
                    613: 
1.91      www       614: 
                    615: sub selectcourse_link {
1.377     raeburn   616:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.787     bisitz    617:    return '<span class="LC_nobreak">'
                    618:          ."<a href='"
                    619:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    620:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
                    621:          .'","'.$multflag.'","'.$selecttype.'");'
                    622:          ."'>".&mt('Select Course').'</a>'
                    623:          .'</span>';
1.74      www       624: }
1.42      matthew   625: 
1.653     raeburn   626: sub selectauthor_link {
                    627:    my ($form,$udom)=@_;
                    628:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    629:           &mt('Select Author').'</a>';
                    630: }
                    631: 
1.273     raeburn   632: sub check_uncheck_jscript {
                    633:     my $jscript = <<"ENDSCRT";
                    634: function checkAll(field) {
                    635:     if (field.length > 0) {
                    636:         for (i = 0; i < field.length; i++) {
                    637:             field[i].checked = true ;
                    638:         }
                    639:     } else {
                    640:         field.checked = true
                    641:     }
                    642: }
                    643:  
                    644: function uncheckAll(field) {
                    645:     if (field.length > 0) {
                    646:         for (i = 0; i < field.length; i++) {
                    647:             field[i].checked = false ;
1.543     albertel  648:         }
                    649:     } else {
1.273     raeburn   650:         field.checked = false ;
                    651:     }
                    652: }
                    653: ENDSCRT
                    654:     return $jscript;
                    655: }
                    656: 
1.656     www       657: sub select_timezone {
1.659     raeburn   658:    my ($name,$selected,$onchange,$includeempty)=@_;
                    659:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    660:    if ($includeempty) {
                    661:        $output .= '<option value=""';
                    662:        if (($selected eq '') || ($selected eq 'local')) {
                    663:            $output .= ' selected="selected" ';
                    664:        }
                    665:        $output .= '> </option>';
                    666:    }
1.657     raeburn   667:    my @timezones = DateTime::TimeZone->all_names;
                    668:    foreach my $tzone (@timezones) {
                    669:        $output.= '<option value="'.$tzone.'"';
                    670:        if ($tzone eq $selected) {
                    671:            $output.=' selected="selected"';
                    672:        }
                    673:        $output.=">$tzone</option>\n";
1.656     www       674:    }
                    675:    $output.="</select>";
                    676:    return $output;
                    677: }
1.273     raeburn   678: 
1.687     raeburn   679: sub select_datelocale {
                    680:     my ($name,$selected,$onchange,$includeempty)=@_;
                    681:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    682:     if ($includeempty) {
                    683:         $output .= '<option value=""';
                    684:         if ($selected eq '') {
                    685:             $output .= ' selected="selected" ';
                    686:         }
                    687:         $output .= '> </option>';
                    688:     }
                    689:     my (@possibles,%locale_names);
                    690:     my @locales = DateTime::Locale::Catalog::Locales;
                    691:     foreach my $locale (@locales) {
                    692:         if (ref($locale) eq 'HASH') {
                    693:             my $id = $locale->{'id'};
                    694:             if ($id ne '') {
                    695:                 my $en_terr = $locale->{'en_territory'};
                    696:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   697:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   698:                 if (grep(/^en$/,@languages) || !@languages) {
                    699:                     if ($en_terr ne '') {
                    700:                         $locale_names{$id} = '('.$en_terr.')';
                    701:                     } elsif ($native_terr ne '') {
                    702:                         $locale_names{$id} = $native_terr;
                    703:                     }
                    704:                 } else {
                    705:                     if ($native_terr ne '') {
                    706:                         $locale_names{$id} = $native_terr.' ';
                    707:                     } elsif ($en_terr ne '') {
                    708:                         $locale_names{$id} = '('.$en_terr.')';
                    709:                     }
                    710:                 }
                    711:                 push (@possibles,$id);
                    712:             }
                    713:         }
                    714:     }
                    715:     foreach my $item (sort(@possibles)) {
                    716:         $output.= '<option value="'.$item.'"';
                    717:         if ($item eq $selected) {
                    718:             $output.=' selected="selected"';
                    719:         }
                    720:         $output.=">$item";
                    721:         if ($locale_names{$item} ne '') {
                    722:             $output.="  $locale_names{$item}</option>\n";
                    723:         }
                    724:         $output.="</option>\n";
                    725:     }
                    726:     $output.="</select>";
                    727:     return $output;
                    728: }
                    729: 
1.792     raeburn   730: sub select_language {
                    731:     my ($name,$selected,$includeempty) = @_;
                    732:     my %langchoices;
                    733:     if ($includeempty) {
                    734:         %langchoices = ('' => 'No language preference');
                    735:     }
                    736:     foreach my $id (&languageids()) {
                    737:         my $code = &supportedlanguagecode($id);
                    738:         if ($code) {
                    739:             $langchoices{$code} = &plainlanguagedescription($id);
                    740:         }
                    741:     }
                    742:     return &select_form($selected,$name,%langchoices);
                    743: }
                    744: 
1.42      matthew   745: =pod
1.36      matthew   746: 
1.648     raeburn   747: =item * &linked_select_forms(...)
1.36      matthew   748: 
                    749: linked_select_forms returns a string containing a <script></script> block
                    750: and html for two <select> menus.  The select menus will be linked in that
                    751: changing the value of the first menu will result in new values being placed
                    752: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn   753: order unless a defined order is provided.
1.36      matthew   754: 
                    755: linked_select_forms takes the following ordered inputs:
                    756: 
                    757: =over 4
                    758: 
1.112     bowersj2  759: =item * $formname, the name of the <form> tag
1.36      matthew   760: 
1.112     bowersj2  761: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   762: 
1.112     bowersj2  763: =item * $firstdefault, the default value for the first menu
1.36      matthew   764: 
1.112     bowersj2  765: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   766: 
1.112     bowersj2  767: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   768: 
1.112     bowersj2  769: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   770: 
1.609     raeburn   771: =item * $menuorder, the order of values in the first menu
                    772: 
1.41      ng        773: =back 
                    774: 
1.36      matthew   775: Below is an example of such a hash.  Only the 'text', 'default', and 
                    776: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    777: values for the first select menu.  The text that coincides with the 
1.41      ng        778: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   779: and text for the second menu are given in the hash pointed to by 
                    780: $menu{$choice1}->{'select2'}.  
                    781: 
1.112     bowersj2  782:  my %menu = ( A1 => { text =>"Choice A1" ,
                    783:                        default => "B3",
                    784:                        select2 => { 
                    785:                            B1 => "Choice B1",
                    786:                            B2 => "Choice B2",
                    787:                            B3 => "Choice B3",
                    788:                            B4 => "Choice B4"
1.609     raeburn   789:                            },
                    790:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2  791:                    },
                    792:                A2 => { text =>"Choice A2" ,
                    793:                        default => "C2",
                    794:                        select2 => { 
                    795:                            C1 => "Choice C1",
                    796:                            C2 => "Choice C2",
                    797:                            C3 => "Choice C3"
1.609     raeburn   798:                            },
                    799:                        order => ['C2','C1','C3'],
1.112     bowersj2  800:                    },
                    801:                A3 => { text =>"Choice A3" ,
                    802:                        default => "D6",
                    803:                        select2 => { 
                    804:                            D1 => "Choice D1",
                    805:                            D2 => "Choice D2",
                    806:                            D3 => "Choice D3",
                    807:                            D4 => "Choice D4",
                    808:                            D5 => "Choice D5",
                    809:                            D6 => "Choice D6",
                    810:                            D7 => "Choice D7"
1.609     raeburn   811:                            },
                    812:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2  813:                    }
                    814:                );
1.36      matthew   815: 
                    816: =cut
                    817: 
                    818: sub linked_select_forms {
                    819:     my ($formname,
                    820:         $middletext,
                    821:         $firstdefault,
                    822:         $firstselectname,
                    823:         $secondselectname, 
1.609     raeburn   824:         $hashref,
                    825:         $menuorder,
1.36      matthew   826:         ) = @_;
                    827:     my $second = "document.$formname.$secondselectname";
                    828:     my $first = "document.$formname.$firstselectname";
                    829:     # output the javascript to do the changing
                    830:     my $result = '';
1.776     bisitz    831:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.36      matthew   832:     $result.="var select2data = new Object();\n";
                    833:     $" = '","';
                    834:     my $debug = '';
                    835:     foreach my $s1 (sort(keys(%$hashref))) {
                    836:         $result.="select2data.d_$s1 = new Object();\n";        
                    837:         $result.="select2data.d_$s1.def = new String('".
                    838:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn   839:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew   840:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn   841:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                    842:             @s2values = @{$hashref->{$s1}->{'order'}};
                    843:         }
1.36      matthew   844:         $result.="\"@s2values\");\n";
                    845:         $result.="select2data.d_$s1.texts = new Array(";        
                    846:         my @s2texts;
                    847:         foreach my $value (@s2values) {
                    848:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                    849:         }
                    850:         $result.="\"@s2texts\");\n";
                    851:     }
                    852:     $"=' ';
                    853:     $result.= <<"END";
                    854: 
                    855: function select1_changed() {
                    856:     // Determine new choice
                    857:     var newvalue = "d_" + $first.value;
                    858:     // update select2
                    859:     var values     = select2data[newvalue].values;
                    860:     var texts      = select2data[newvalue].texts;
                    861:     var select2def = select2data[newvalue].def;
                    862:     var i;
                    863:     // out with the old
                    864:     for (i = 0; i < $second.options.length; i++) {
                    865:         $second.options[i] = null;
                    866:     }
                    867:     // in with the nuclear
                    868:     for (i=0;i<values.length; i++) {
                    869:         $second.options[i] = new Option(values[i]);
1.143     matthew   870:         $second.options[i].value = values[i];
1.36      matthew   871:         $second.options[i].text = texts[i];
                    872:         if (values[i] == select2def) {
                    873:             $second.options[i].selected = true;
                    874:         }
                    875:     }
                    876: }
                    877: </script>
                    878: END
                    879:     # output the initial values for the selection lists
                    880:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn   881:     my @order = sort(keys(%{$hashref}));
                    882:     if (ref($menuorder) eq 'ARRAY') {
                    883:         @order = @{$menuorder};
                    884:     }
                    885:     foreach my $value (@order) {
1.36      matthew   886:         $result.="    <option value=\"$value\" ";
1.253     albertel  887:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www       888:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew   889:     }
                    890:     $result .= "</select>\n";
                    891:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                    892:     $result .= $middletext;
                    893:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                    894:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn   895:     
                    896:     my @secondorder = sort(keys(%select2));
                    897:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                    898:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                    899:     }
                    900:     foreach my $value (@secondorder) {
1.36      matthew   901:         $result.="    <option value=\"$value\" ";        
1.253     albertel  902:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www       903:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew   904:     }
                    905:     $result .= "</select>\n";
                    906:     #    return $debug;
                    907:     return $result;
                    908: }   #  end of sub linked_select_forms {
                    909: 
1.45      matthew   910: =pod
1.44      bowersj2  911: 
1.648     raeburn   912: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44      bowersj2  913: 
1.112     bowersj2  914: Returns a string corresponding to an HTML link to the given help
                    915: $topic, where $topic corresponds to the name of a .tex file in
                    916: /home/httpd/html/adm/help/tex, with underscores replaced by
                    917: spaces. 
                    918: 
                    919: $text will optionally be linked to the same topic, allowing you to
                    920: link text in addition to the graphic. If you do not want to link
                    921: text, but wish to specify one of the later parameters, pass an
                    922: empty string. 
                    923: 
                    924: $stayOnPage is a value that will be interpreted as a boolean. If true,
                    925: the link will not open a new window. If false, the link will open
                    926: a new window using Javascript. (Default is false.) 
                    927: 
                    928: $width and $height are optional numerical parameters that will
                    929: override the width and height of the popped up window, which may
                    930: be useful for certain help topics with big pictures included. 
1.44      bowersj2  931: 
                    932: =cut
                    933: 
                    934: sub help_open_topic {
1.48      bowersj2  935:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
                    936:     $text = "" if (not defined $text);
1.44      bowersj2  937:     $stayOnPage = 0 if (not defined $stayOnPage);
                    938:     $width = 350 if (not defined $width);
                    939:     $height = 400 if (not defined $height);
                    940:     my $filename = $topic;
                    941:     $filename =~ s/ /_/g;
                    942: 
1.48      bowersj2  943:     my $template = "";
                    944:     my $link;
1.572     banghart  945:     
1.159     www       946:     $topic=~s/\W/\_/g;
1.44      bowersj2  947: 
1.572     banghart  948:     if (!$stayOnPage) {
1.72      bowersj2  949: 	$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  950:     } else {
1.48      bowersj2  951: 	$link = "/adm/help/${filename}.hlp";
                    952:     }
                    953: 
                    954:     # Add the text
1.755     neumanie  955:     if ($text ne "") {	
1.763     bisitz    956: 	$template.='<span class="LC_help_open_topic">'
                    957:                   .'<a target="_top" href="'.$link.'">'
                    958:                   .$text.'</a>';
1.48      bowersj2  959:     }
                    960: 
1.763     bisitz    961:     # (Always) Add the graphic
1.179     matthew   962:     my $title = &mt('Online Help');
1.667     raeburn   963:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763     bisitz    964:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                    965:               .'<img src="'.$helpicon.'" border="0"'
                    966:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783     amueller  967:               .' title="'.$title.'"' 
1.763     bisitz    968:               .' /></a>';
                    969:     if ($text ne "") {	
                    970:         $template.='</span>';
                    971:     }
1.44      bowersj2  972:     return $template;
                    973: 
1.106     bowersj2  974: }
                    975: 
                    976: # This is a quicky function for Latex cheatsheet editing, since it 
                    977: # appears in at least four places
                    978: sub helpLatexCheatsheet {
1.732     raeburn   979:     my ($topic,$text,$not_author) = @_;
                    980:     my $out;
1.106     bowersj2  981:     my $addOther = '';
1.732     raeburn   982:     if ($topic) {
1.763     bisitz    983: 	$addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
                    984: 							       undef, undef, 600).
                    985: 								   '</span> ';
                    986:     }
                    987:     $out = '<span>' # Start cheatsheet
                    988: 	  .$addOther
                    989:           .'<span>'
                    990: 	  .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
                    991: 					       undef,undef,600)
                    992: 	  .'</span> <span>'
                    993: 	  .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
                    994: 					       undef,undef,600)
                    995: 	  .'</span>';
1.732     raeburn   996:     unless ($not_author) {
1.763     bisitz    997:         $out .= ' <span>'
                    998: 	       .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
                    999: 	                                            undef,undef,600)
                   1000: 	       .'</span>';
1.732     raeburn  1001:     }
1.763     bisitz   1002:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1003:     return $out;
1.172     www      1004: }
                   1005: 
1.430     albertel 1006: sub general_help {
                   1007:     my $helptopic='Student_Intro';
                   1008:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1009: 	$helptopic='Authoring_Intro';
                   1010:     } elsif ($env{'request.role'}=~/^cc/) {
                   1011: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1012:     } elsif ($env{'request.role'}=~/^dc/) {
                   1013:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1014:     }
                   1015:     return $helptopic;
                   1016: }
                   1017: 
                   1018: sub update_help_link {
                   1019:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1020:     my $origurl = $ENV{'REQUEST_URI'};
                   1021:     $origurl=~s|^/~|/priv/|;
                   1022:     my $timestamp = time;
                   1023:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1024:         $$datum = &escape($$datum);
                   1025:     }
                   1026: 
                   1027:     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";
                   1028:     my $output .= <<"ENDOUTPUT";
                   1029: <script type="text/javascript">
                   1030: banner_link = '$banner_link';
                   1031: </script>
                   1032: ENDOUTPUT
                   1033:     return $output;
                   1034: }
                   1035: 
                   1036: # now just updates the help link and generates a blue icon
1.193     raeburn  1037: sub help_open_menu {
1.430     albertel 1038:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1039: 	= @_;    
1.430     albertel 1040:     $stayOnPage = 0 if (not defined $stayOnPage);
1.572     banghart 1041:     # only use pop-up help (stayOnPage == 0)
1.552     banghart 1042:     # if environment.remote is on (using remote control UI)
1.798     tempelho 1043:     if ($env{'environment.remote'} eq 'off' ) {
1.552     banghart 1044:         $stayOnPage=1;
1.430     albertel 1045:     }
                   1046:     my $output;
                   1047:     if ($component_help) {
                   1048: 	if (!$text) {
                   1049: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1050: 				       $width,$height);
                   1051: 	} else {
                   1052: 	    my $help_text;
                   1053: 	    $help_text=&unescape($topic);
                   1054: 	    $output='<table><tr><td>'.
                   1055: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1056: 				 $width,$height).'</td></tr></table>';
                   1057: 	}
                   1058:     }
                   1059:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1060:     return $output.$banner_link;
                   1061: }
                   1062: 
                   1063: sub top_nav_help {
                   1064:     my ($text) = @_;
1.436     albertel 1065:     $text = &mt($text);
1.572     banghart 1066:     my $stay_on_page = 
1.798     tempelho 1067: 	($env{'environment.remote'} eq 'off' );
1.572     banghart 1068:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1069: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1070:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1071: 
1.201     raeburn  1072:     my $title = &mt('Get help');
1.436     albertel 1073: 
                   1074:     return <<"END";
                   1075: $banner_link
                   1076:  <a href="$link" title="$title">$text</a>
                   1077: END
                   1078: }
                   1079: 
                   1080: sub help_menu_js {
                   1081:     my ($text) = @_;
                   1082: 
                   1083:     my $stayOnPage = 
1.798     tempelho 1084: 	($env{'environment.remote'} eq 'off' );
1.436     albertel 1085: 
                   1086:     my $width = 620;
                   1087:     my $height = 600;
1.430     albertel 1088:     my $helptopic=&general_help();
                   1089:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1090:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1091:     my $start_page =
                   1092:         &Apache::loncommon::start_page('Help Menu', undef,
                   1093: 				       {'frameset'    => 1,
                   1094: 					'js_ready'    => 1,
                   1095: 					'add_entries' => {
                   1096: 					    'border' => '0',
1.579     raeburn  1097: 					    'rows'   => "110,*",},});
1.331     albertel 1098:     my $end_page =
                   1099:         &Apache::loncommon::end_page({'frameset' => 1,
                   1100: 				      'js_ready' => 1,});
                   1101: 
1.436     albertel 1102:     my $template .= <<"ENDTEMPLATE";
                   1103: <script type="text/javascript">
1.253     albertel 1104: // <!-- BEGIN LON-CAPA Internal
                   1105: // <![CDATA[
1.430     albertel 1106: var banner_link = '';
1.243     raeburn  1107: function helpMenu(target) {
                   1108:     var caller = this;
                   1109:     if (target == 'open') {
                   1110:         var newWindow = null;
                   1111:         try {
1.262     albertel 1112:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1113:         }
                   1114:         catch(error) {
                   1115:             writeHelp(caller);
                   1116:             return;
                   1117:         }
                   1118:         if (newWindow) {
                   1119:             caller = newWindow;
                   1120:         }
1.193     raeburn  1121:     }
1.243     raeburn  1122:     writeHelp(caller);
                   1123:     return;
                   1124: }
                   1125: function writeHelp(caller) {
1.430     albertel 1126:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1127:     caller.document.close()
                   1128:     caller.focus()
1.193     raeburn  1129: }
1.253     albertel 1130: // ]]>
1.219     albertel 1131: // END LON-CAPA Internal -->
1.436     albertel 1132: </script>
1.193     raeburn  1133: ENDTEMPLATE
                   1134:     return $template;
                   1135: }
                   1136: 
1.172     www      1137: sub help_open_bug {
                   1138:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1139:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1140:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1141:     $text = "" if (not defined $text);
                   1142:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1143:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1144: 	$stayOnPage=1;
                   1145:     }
1.184     albertel 1146:     $width = 600 if (not defined $width);
                   1147:     $height = 600 if (not defined $height);
1.172     www      1148: 
                   1149:     $topic=~s/\W+/\+/g;
                   1150:     my $link='';
                   1151:     my $template='';
1.379     albertel 1152:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1153: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1154:     if (!$stayOnPage)
                   1155:     {
                   1156: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1157:     }
                   1158:     else
                   1159:     {
                   1160: 	$link = $url;
                   1161:     }
                   1162:     # Add the text
                   1163:     if ($text ne "")
                   1164:     {
                   1165: 	$template .= 
                   1166:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1167:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1168:     }
                   1169: 
                   1170:     # Add the graphic
1.179     matthew  1171:     my $title = &mt('Report a Bug');
1.215     albertel 1172:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1173:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1174:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1175: ENDTEMPLATE
                   1176:     if ($text ne '') { $template.='</td></tr></table>' };
                   1177:     return $template;
                   1178: 
                   1179: }
                   1180: 
                   1181: sub help_open_faq {
                   1182:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1183:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1184:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1185:     $text = "" if (not defined $text);
                   1186:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1187:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1188: 	$stayOnPage=1;
                   1189:     }
                   1190:     $width = 350 if (not defined $width);
                   1191:     $height = 400 if (not defined $height);
                   1192: 
                   1193:     $topic=~s/\W+/\+/g;
                   1194:     my $link='';
                   1195:     my $template='';
                   1196:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1197:     if (!$stayOnPage)
                   1198:     {
                   1199: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1200:     }
                   1201:     else
                   1202:     {
                   1203: 	$link = $url;
                   1204:     }
                   1205: 
                   1206:     # Add the text
                   1207:     if ($text ne "")
                   1208:     {
                   1209: 	$template .= 
1.173     www      1210:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1211:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1212:     }
                   1213: 
                   1214:     # Add the graphic
1.179     matthew  1215:     my $title = &mt('View the FAQ');
1.215     albertel 1216:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1217:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1218:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1219: ENDTEMPLATE
                   1220:     if ($text ne '') { $template.='</td></tr></table>' };
                   1221:     return $template;
                   1222: 
1.44      bowersj2 1223: }
1.37      matthew  1224: 
1.180     matthew  1225: ###############################################################
                   1226: ###############################################################
                   1227: 
1.45      matthew  1228: =pod
                   1229: 
1.648     raeburn  1230: =item * &change_content_javascript():
1.256     matthew  1231: 
                   1232: This and the next function allow you to create small sections of an
                   1233: otherwise static HTML page that you can update on the fly with
                   1234: Javascript, even in Netscape 4.
                   1235: 
                   1236: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1237: must be written to the HTML page once. It will prove the Javascript
                   1238: function "change(name, content)". Calling the change function with the
                   1239: name of the section 
                   1240: you want to update, matching the name passed to C<changable_area>, and
                   1241: the new content you want to put in there, will put the content into
                   1242: that area.
                   1243: 
                   1244: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1245: to contain room for the original contents. You need to "make space"
                   1246: for whatever changes you wish to make, and be B<sure> to check your
                   1247: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1248: it's adequate for updating a one-line status display, but little more.
                   1249: This script will set the space to 100% width, so you only need to
                   1250: worry about height in Netscape 4.
                   1251: 
                   1252: Modern browsers are much less limiting, and if you can commit to the
                   1253: user not using Netscape 4, this feature may be used freely with
                   1254: pretty much any HTML.
                   1255: 
                   1256: =cut
                   1257: 
                   1258: sub change_content_javascript {
                   1259:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1260:     if ($env{'browser.type'} eq 'netscape' &&
                   1261: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1262: 	return (<<NETSCAPE4);
                   1263: 	function change(name, content) {
                   1264: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1265: 	    doc.open();
                   1266: 	    doc.write(content);
                   1267: 	    doc.close();
                   1268: 	}
                   1269: NETSCAPE4
                   1270:     } else {
                   1271: 	# Otherwise, we need to use semi-standards-compliant code
                   1272: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1273: 	# is really scary, and every useful browser supports it
                   1274: 	return (<<DOMBASED);
                   1275: 	function change(name, content) {
                   1276: 	    element = document.getElementById(name);
                   1277: 	    element.innerHTML = content;
                   1278: 	}
                   1279: DOMBASED
                   1280:     }
                   1281: }
                   1282: 
                   1283: =pod
                   1284: 
1.648     raeburn  1285: =item * &changable_area($name,$origContent):
1.256     matthew  1286: 
                   1287: This provides a "changable area" that can be modified on the fly via
                   1288: the Javascript code provided in C<change_content_javascript>. $name is
                   1289: the name you will use to reference the area later; do not repeat the
                   1290: same name on a given HTML page more then once. $origContent is what
                   1291: the area will originally contain, which can be left blank.
                   1292: 
                   1293: =cut
                   1294: 
                   1295: sub changable_area {
                   1296:     my ($name, $origContent) = @_;
                   1297: 
1.258     albertel 1298:     if ($env{'browser.type'} eq 'netscape' &&
                   1299: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1300: 	# If this is netscape 4, we need to use the Layer tag
                   1301: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1302:     } else {
                   1303: 	return "<span id='$name'>$origContent</span>";
                   1304:     }
                   1305: }
                   1306: 
                   1307: =pod
                   1308: 
1.648     raeburn  1309: =item * &viewport_geometry_js 
1.590     raeburn  1310: 
                   1311: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1312: 
                   1313: =cut
                   1314: 
                   1315: 
                   1316: sub viewport_geometry_js { 
                   1317:     return <<"GEOMETRY";
                   1318: var Geometry = {};
                   1319: function init_geometry() {
                   1320:     if (Geometry.init) { return };
                   1321:     Geometry.init=1;
                   1322:     if (window.innerHeight) {
                   1323:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1324:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1325:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1326:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1327:     }
                   1328:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1329:         Geometry.getViewportHeight =
                   1330:             function() { return document.documentElement.clientHeight; };
                   1331:         Geometry.getViewportWidth =
                   1332:             function() { return document.documentElement.clientWidth; };
                   1333: 
                   1334:         Geometry.getHorizontalScroll =
                   1335:             function() { return document.documentElement.scrollLeft; };
                   1336:         Geometry.getVerticalScroll =
                   1337:             function() { return document.documentElement.scrollTop; };
                   1338:     }
                   1339:     else if (document.body.clientHeight) {
                   1340:         Geometry.getViewportHeight =
                   1341:             function() { return document.body.clientHeight; };
                   1342:         Geometry.getViewportWidth =
                   1343:             function() { return document.body.clientWidth; };
                   1344:         Geometry.getHorizontalScroll =
                   1345:             function() { return document.body.scrollLeft; };
                   1346:         Geometry.getVerticalScroll =
                   1347:             function() { return document.body.scrollTop; };
                   1348:     }
                   1349: }
                   1350: 
                   1351: GEOMETRY
                   1352: }
                   1353: 
                   1354: =pod
                   1355: 
1.648     raeburn  1356: =item * &viewport_size_js()
1.590     raeburn  1357: 
                   1358: 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. 
                   1359: 
                   1360: =cut
                   1361: 
                   1362: sub viewport_size_js {
                   1363:     my $geometry = &viewport_geometry_js();
                   1364:     return <<"DIMS";
                   1365: 
                   1366: $geometry
                   1367: 
                   1368: function getViewportDims(width,height) {
                   1369:     init_geometry();
                   1370:     width.value = Geometry.getViewportWidth();
                   1371:     height.value = Geometry.getViewportHeight();
                   1372:     return;
                   1373: }
                   1374: 
                   1375: DIMS
                   1376: }
                   1377: 
                   1378: =pod
                   1379: 
1.648     raeburn  1380: =item * &resize_textarea_js()
1.565     albertel 1381: 
                   1382: emits the needed javascript to resize a textarea to be as big as possible
                   1383: 
                   1384: creates a function resize_textrea that takes two IDs first should be
                   1385: the id of the element to resize, second should be the id of a div that
                   1386: surrounds everything that comes after the textarea, this routine needs
                   1387: to be attached to the <body> for the onload and onresize events.
                   1388: 
1.648     raeburn  1389: =back
1.565     albertel 1390: 
                   1391: =cut
                   1392: 
                   1393: sub resize_textarea_js {
1.590     raeburn  1394:     my $geometry = &viewport_geometry_js();
1.565     albertel 1395:     return <<"RESIZE";
                   1396:     <script type="text/javascript">
1.590     raeburn  1397: $geometry
1.565     albertel 1398: 
1.588     albertel 1399: function getX(element) {
                   1400:     var x = 0;
                   1401:     while (element) {
                   1402: 	x += element.offsetLeft;
                   1403: 	element = element.offsetParent;
                   1404:     }
                   1405:     return x;
                   1406: }
                   1407: function getY(element) {
                   1408:     var y = 0;
                   1409:     while (element) {
                   1410: 	y += element.offsetTop;
                   1411: 	element = element.offsetParent;
                   1412:     }
                   1413:     return y;
                   1414: }
                   1415: 
                   1416: 
1.565     albertel 1417: function resize_textarea(textarea_id,bottom_id) {
                   1418:     init_geometry();
                   1419:     var textarea        = document.getElementById(textarea_id);
                   1420:     //alert(textarea);
                   1421: 
1.588     albertel 1422:     var textarea_top    = getY(textarea);
1.565     albertel 1423:     var textarea_height = textarea.offsetHeight;
                   1424:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1425:     var bottom_top      = getY(bottom);
1.565     albertel 1426:     var bottom_height   = bottom.offsetHeight;
                   1427:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1428:     var fudge           = 23;
1.565     albertel 1429:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1430:     if (new_height < 300) {
                   1431: 	new_height = 300;
                   1432:     }
                   1433:     textarea.style.height=new_height+'px';
                   1434: }
                   1435: </script>
                   1436: RESIZE
                   1437: 
                   1438: }
                   1439: 
                   1440: =pod
                   1441: 
1.256     matthew  1442: =head1 Excel and CSV file utility routines
                   1443: 
                   1444: =over 4
                   1445: 
                   1446: =cut
                   1447: 
                   1448: ###############################################################
                   1449: ###############################################################
                   1450: 
                   1451: =pod
                   1452: 
1.648     raeburn  1453: =item * &csv_translate($text) 
1.37      matthew  1454: 
1.185     www      1455: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1456: format.
                   1457: 
                   1458: =cut
                   1459: 
1.180     matthew  1460: ###############################################################
                   1461: ###############################################################
1.37      matthew  1462: sub csv_translate {
                   1463:     my $text = shift;
                   1464:     $text =~ s/\"/\"\"/g;
1.209     albertel 1465:     $text =~ s/\n/ /g;
1.37      matthew  1466:     return $text;
                   1467: }
1.180     matthew  1468: 
                   1469: ###############################################################
                   1470: ###############################################################
                   1471: 
                   1472: =pod
                   1473: 
1.648     raeburn  1474: =item * &define_excel_formats()
1.180     matthew  1475: 
                   1476: Define some commonly used Excel cell formats.
                   1477: 
                   1478: Currently supported formats:
                   1479: 
                   1480: =over 4
                   1481: 
                   1482: =item header
                   1483: 
                   1484: =item bold
                   1485: 
                   1486: =item h1
                   1487: 
                   1488: =item h2
                   1489: 
                   1490: =item h3
                   1491: 
1.256     matthew  1492: =item h4
                   1493: 
                   1494: =item i
                   1495: 
1.180     matthew  1496: =item date
                   1497: 
                   1498: =back
                   1499: 
                   1500: Inputs: $workbook
                   1501: 
                   1502: Returns: $format, a hash reference.
                   1503: 
                   1504: =cut
                   1505: 
                   1506: ###############################################################
                   1507: ###############################################################
                   1508: sub define_excel_formats {
                   1509:     my ($workbook) = @_;
                   1510:     my $format;
                   1511:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1512:                                                 bottom    => 1,
                   1513:                                                 align     => 'center');
                   1514:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1515:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1516:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1517:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1518:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1519:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1520:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1521:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1522:     return $format;
                   1523: }
                   1524: 
                   1525: ###############################################################
                   1526: ###############################################################
1.113     bowersj2 1527: 
                   1528: =pod
                   1529: 
1.648     raeburn  1530: =item * &create_workbook()
1.255     matthew  1531: 
                   1532: Create an Excel worksheet.  If it fails, output message on the
                   1533: request object and return undefs.
                   1534: 
                   1535: Inputs: Apache request object
                   1536: 
                   1537: Returns (undef) on failure, 
                   1538:     Excel worksheet object, scalar with filename, and formats 
                   1539:     from &Apache::loncommon::define_excel_formats on success
                   1540: 
                   1541: =cut
                   1542: 
                   1543: ###############################################################
                   1544: ###############################################################
                   1545: sub create_workbook {
                   1546:     my ($r) = @_;
                   1547:         #
                   1548:     # Create the excel spreadsheet
                   1549:     my $filename = '/prtspool/'.
1.258     albertel 1550:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1551:         time.'_'.rand(1000000000).'.xls';
                   1552:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1553:     if (! defined($workbook)) {
                   1554:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                   1555:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                   1556:                             "This error has been logged.  ".
                   1557:                             "Please alert your LON-CAPA administrator").
                   1558:                   '</p>');
                   1559:         return (undef);
                   1560:     }
                   1561:     #
                   1562:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1563:     #
                   1564:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1565:     return ($workbook,$filename,$format);
                   1566: }
                   1567: 
                   1568: ###############################################################
                   1569: ###############################################################
                   1570: 
                   1571: =pod
                   1572: 
1.648     raeburn  1573: =item * &create_text_file()
1.113     bowersj2 1574: 
1.542     raeburn  1575: Create a file to write to and eventually make available to the user.
1.256     matthew  1576: If file creation fails, outputs an error message on the request object and 
                   1577: return undefs.
1.113     bowersj2 1578: 
1.256     matthew  1579: Inputs: Apache request object, and file suffix
1.113     bowersj2 1580: 
1.256     matthew  1581: Returns (undef) on failure, 
                   1582:     Filehandle and filename on success.
1.113     bowersj2 1583: 
                   1584: =cut
                   1585: 
1.256     matthew  1586: ###############################################################
                   1587: ###############################################################
                   1588: sub create_text_file {
                   1589:     my ($r,$suffix) = @_;
                   1590:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1591:     my $fh;
                   1592:     my $filename = '/prtspool/'.
1.258     albertel 1593:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1594:         time.'_'.rand(1000000000).'.'.$suffix;
                   1595:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1596:     if (! defined($fh)) {
                   1597:         $r->log_error("Couldn't open $filename for output $!");
1.683     bisitz   1598:         $r->print(&mt('Problems occurred in creating the output file. '
                   1599:                      .'This error has been logged. '
                   1600:                      .'Please alert your LON-CAPA administrator.'));
1.113     bowersj2 1601:     }
1.256     matthew  1602:     return ($fh,$filename)
1.113     bowersj2 1603: }
                   1604: 
                   1605: 
1.256     matthew  1606: =pod 
1.113     bowersj2 1607: 
                   1608: =back
                   1609: 
                   1610: =cut
1.37      matthew  1611: 
                   1612: ###############################################################
1.33      matthew  1613: ##        Home server <option> list generating code          ##
                   1614: ###############################################################
1.35      matthew  1615: 
1.169     www      1616: # ------------------------------------------
                   1617: 
                   1618: sub domain_select {
                   1619:     my ($name,$value,$multiple)=@_;
                   1620:     my %domains=map { 
1.514     albertel 1621: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1622:     } &Apache::lonnet::all_domains();
1.169     www      1623:     if ($multiple) {
                   1624: 	$domains{''}=&mt('Any domain');
1.550     albertel 1625: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1626: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1627:     } else {
1.550     albertel 1628: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169     www      1629: 	return &select_form($name,$value,%domains);
                   1630:     }
                   1631: }
                   1632: 
1.282     albertel 1633: #-------------------------------------------
                   1634: 
                   1635: =pod
                   1636: 
1.519     raeburn  1637: =head1 Routines for form select boxes
                   1638: 
                   1639: =over 4
                   1640: 
1.648     raeburn  1641: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1642: 
                   1643: Returns a string containing a <select> element int multiple mode
                   1644: 
                   1645: 
                   1646: Args:
                   1647:   $name - name of the <select> element
1.506     raeburn  1648:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1649:   $size - number of rows long the select element is
1.283     albertel 1650:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1651:           (shown text should already have been &mt())
1.506     raeburn  1652:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1653: 
1.282     albertel 1654: =cut
                   1655: 
                   1656: #-------------------------------------------
1.169     www      1657: sub multiple_select_form {
1.284     albertel 1658:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1659:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1660:     my $output='';
1.191     matthew  1661:     if (! defined($size)) {
                   1662:         $size = 4;
1.283     albertel 1663:         if (scalar(keys(%$hash))<4) {
                   1664:             $size = scalar(keys(%$hash));
1.191     matthew  1665:         }
                   1666:     }
1.734     bisitz   1667:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1668:     my @order;
1.506     raeburn  1669:     if (ref($order) eq 'ARRAY')  {
                   1670:         @order = @{$order};
                   1671:     } else {
                   1672:         @order = sort(keys(%$hash));
1.501     banghart 1673:     }
                   1674:     if (exists($$hash{'select_form_order'})) {
                   1675:         @order = @{$$hash{'select_form_order'}};
                   1676:     }
                   1677:         
1.284     albertel 1678:     foreach my $key (@order) {
1.356     albertel 1679:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1680:         $output.='selected="selected" ' if ($selected{$key});
                   1681:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1682:     }
                   1683:     $output.="</select>\n";
                   1684:     return $output;
                   1685: }
                   1686: 
1.88      www      1687: #-------------------------------------------
                   1688: 
                   1689: =pod
                   1690: 
1.648     raeburn  1691: =item * &select_form($defdom,$name,%hash)
1.88      www      1692: 
                   1693: Returns a string containing a <select name='$name' size='1'> form to 
                   1694: allow a user to select options from a hash option_name => displayed text.  
                   1695: See lonrights.pm for an example invocation and use.
                   1696: 
                   1697: =cut
                   1698: 
                   1699: #-------------------------------------------
                   1700: sub select_form {
                   1701:     my ($def,$name,%hash) = @_;
                   1702:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1703:     my @keys;
                   1704:     if (exists($hash{'select_form_order'})) {
                   1705: 	@keys=@{$hash{'select_form_order'}};
                   1706:     } else {
                   1707: 	@keys=sort(keys(%hash));
                   1708:     }
1.356     albertel 1709:     foreach my $key (@keys) {
                   1710:         $selectform.=
                   1711: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1712:             ($key eq $def ? 'selected="selected" ' : '').
                   1713:                 ">".&mt($hash{$key})."</option>\n";
1.88      www      1714:     }
                   1715:     $selectform.="</select>";
                   1716:     return $selectform;
                   1717: }
                   1718: 
1.475     www      1719: # For display filters
                   1720: 
                   1721: sub display_filter {
                   1722:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1723:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1724:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1725: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1726: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1727: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1728:            &mt('Filter [_1]',
1.477     www      1729: 	   &select_form($env{'form.displayfilter'},
                   1730: 			'displayfilter',
                   1731: 			('currentfolder' => 'Current folder/page',
                   1732: 			 'containing' => 'Containing phrase',
                   1733: 			 'none' => 'None'))).
1.714     bisitz   1734: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1735: }
                   1736: 
1.167     www      1737: sub gradeleveldescription {
                   1738:     my $gradelevel=shift;
                   1739:     my %gradelevels=(0 => 'Not specified',
                   1740: 		     1 => 'Grade 1',
                   1741: 		     2 => 'Grade 2',
                   1742: 		     3 => 'Grade 3',
                   1743: 		     4 => 'Grade 4',
                   1744: 		     5 => 'Grade 5',
                   1745: 		     6 => 'Grade 6',
                   1746: 		     7 => 'Grade 7',
                   1747: 		     8 => 'Grade 8',
                   1748: 		     9 => 'Grade 9',
                   1749: 		     10 => 'Grade 10',
                   1750: 		     11 => 'Grade 11',
                   1751: 		     12 => 'Grade 12',
                   1752: 		     13 => 'Grade 13',
                   1753: 		     14 => '100 Level',
                   1754: 		     15 => '200 Level',
                   1755: 		     16 => '300 Level',
                   1756: 		     17 => '400 Level',
                   1757: 		     18 => 'Graduate Level');
                   1758:     return &mt($gradelevels{$gradelevel});
                   1759: }
                   1760: 
1.163     www      1761: sub select_level_form {
                   1762:     my ($deflevel,$name)=@_;
                   1763:     unless ($deflevel) { $deflevel=0; }
1.167     www      1764:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1765:     for (my $i=0; $i<=18; $i++) {
                   1766:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1767:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1768:                 ">".&gradeleveldescription($i)."</option>\n";
                   1769:     }
                   1770:     $selectform.="</select>";
                   1771:     return $selectform;
1.163     www      1772: }
1.167     www      1773: 
1.35      matthew  1774: #-------------------------------------------
                   1775: 
1.45      matthew  1776: =pod
                   1777: 
1.743     raeburn  1778: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$autosubmit)
1.35      matthew  1779: 
                   1780: Returns a string containing a <select name='$name' size='1'> form to 
                   1781: allow a user to select the domain to preform an operation in.  
                   1782: See loncreateuser.pm for an example invocation and use.
                   1783: 
1.90      www      1784: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1785: selected");
                   1786: 
1.743     raeburn  1787: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   1788: 
                   1789: If the $autosubmit flag is set, the form containing the domain selector will be auto-submitted by an onchange action.  
1.563     raeburn  1790: 
1.35      matthew  1791: =cut
                   1792: 
                   1793: #-------------------------------------------
1.34      matthew  1794: sub select_dom_form {
1.743     raeburn  1795:     my ($defdom,$name,$includeempty,$showdomdesc,$autosubmit) = @_;
                   1796:     my $onchange;
                   1797:     if ($autosubmit) {
                   1798:         $onchange = ' onchange="this.form.submit()"';
                   1799:     }
1.550     albertel 1800:     my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90      www      1801:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  1802:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 1803:     foreach my $dom (@domains) {
                   1804:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  1805:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   1806:         if ($showdomdesc) {
                   1807:             if ($dom ne '') {
                   1808:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   1809:                 if ($domdesc ne '') {
                   1810:                     $selectdomain .= ' ('.$domdesc.')';
                   1811:                 }
                   1812:             } 
                   1813:         }
                   1814:         $selectdomain .= "</option>\n";
1.34      matthew  1815:     }
                   1816:     $selectdomain.="</select>";
                   1817:     return $selectdomain;
                   1818: }
                   1819: 
1.35      matthew  1820: #-------------------------------------------
                   1821: 
1.45      matthew  1822: =pod
                   1823: 
1.648     raeburn  1824: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  1825: 
1.586     raeburn  1826: input: 4 arguments (two required, two optional) - 
                   1827:     $domain - domain of new user
                   1828:     $name - name of form element
                   1829:     $default - Value of 'default' causes a default item to be first 
                   1830:                             option, and selected by default. 
                   1831:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   1832:                             if 1 server found, or default, if 0 found.
1.594     raeburn  1833: output: returns 2 items: 
1.586     raeburn  1834: (a) form element which contains either:
                   1835:    (i) <select name="$name">
                   1836:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   1837:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   1838:        </select>
                   1839:        form item if there are multiple library servers in $domain, or
                   1840:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   1841:        if there is only one library server in $domain.
                   1842: 
                   1843: (b) number of library servers found.
                   1844: 
                   1845: See loncreateuser.pm for example of use.
1.35      matthew  1846: 
                   1847: =cut
                   1848: 
                   1849: #-------------------------------------------
1.586     raeburn  1850: sub home_server_form_item {
                   1851:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 1852:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  1853:     my $result;
                   1854:     my $numlib = keys(%servers);
                   1855:     if ($numlib > 1) {
                   1856:         $result .= '<select name="'.$name.'" />'."\n";
                   1857:         if ($default) {
1.804     bisitz   1858:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  1859:                        '</option>'."\n";
                   1860:         }
                   1861:         foreach my $hostid (sort(keys(%servers))) {
                   1862:             $result.= '<option value="'.$hostid.'">'.
                   1863: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   1864:         }
                   1865:         $result .= '</select>'."\n";
                   1866:     } elsif ($numlib == 1) {
                   1867:         my $hostid;
                   1868:         foreach my $item (keys(%servers)) {
                   1869:             $hostid = $item;
                   1870:         }
                   1871:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   1872:                    $hostid.'" />';
                   1873:                    if (!$hide) {
                   1874:                        $result .= $hostid.' '.$servers{$hostid};
                   1875:                    }
                   1876:                    $result .= "\n";
                   1877:     } elsif ($default) {
                   1878:         $result .= '<input type="hidden" name="'.$name.
                   1879:                    '" value="default" />';
                   1880:                    if (!$hide) {
                   1881:                        $result .= &mt('default');
                   1882:                    }
                   1883:                    $result .= "\n";
1.33      matthew  1884:     }
1.586     raeburn  1885:     return ($result,$numlib);
1.33      matthew  1886: }
1.112     bowersj2 1887: 
                   1888: =pod
                   1889: 
1.534     albertel 1890: =back 
                   1891: 
1.112     bowersj2 1892: =cut
1.87      matthew  1893: 
                   1894: ###############################################################
1.112     bowersj2 1895: ##                  Decoding User Agent                      ##
1.87      matthew  1896: ###############################################################
                   1897: 
                   1898: =pod
                   1899: 
1.112     bowersj2 1900: =head1 Decoding the User Agent
                   1901: 
                   1902: =over 4
                   1903: 
                   1904: =item * &decode_user_agent()
1.87      matthew  1905: 
                   1906: Inputs: $r
                   1907: 
                   1908: Outputs:
                   1909: 
                   1910: =over 4
                   1911: 
1.112     bowersj2 1912: =item * $httpbrowser
1.87      matthew  1913: 
1.112     bowersj2 1914: =item * $clientbrowser
1.87      matthew  1915: 
1.112     bowersj2 1916: =item * $clientversion
1.87      matthew  1917: 
1.112     bowersj2 1918: =item * $clientmathml
1.87      matthew  1919: 
1.112     bowersj2 1920: =item * $clientunicode
1.87      matthew  1921: 
1.112     bowersj2 1922: =item * $clientos
1.87      matthew  1923: 
                   1924: =back
                   1925: 
1.157     matthew  1926: =back 
                   1927: 
1.87      matthew  1928: =cut
                   1929: 
                   1930: ###############################################################
                   1931: ###############################################################
                   1932: sub decode_user_agent {
1.247     albertel 1933:     my ($r)=@_;
1.87      matthew  1934:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   1935:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   1936:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 1937:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  1938:     my $clientbrowser='unknown';
                   1939:     my $clientversion='0';
                   1940:     my $clientmathml='';
                   1941:     my $clientunicode='0';
                   1942:     for (my $i=0;$i<=$#browsertype;$i++) {
                   1943:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   1944: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   1945: 	    $clientbrowser=$bname;
                   1946:             $httpbrowser=~/$vreg/i;
                   1947: 	    $clientversion=$1;
                   1948:             $clientmathml=($clientversion>=$minv);
                   1949:             $clientunicode=($clientversion>=$univ);
                   1950: 	}
                   1951:     }
                   1952:     my $clientos='unknown';
                   1953:     if (($httpbrowser=~/linux/i) ||
                   1954:         ($httpbrowser=~/unix/i) ||
                   1955:         ($httpbrowser=~/ux/i) ||
                   1956:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   1957:     if (($httpbrowser=~/vax/i) ||
                   1958:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   1959:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   1960:     if (($httpbrowser=~/mac/i) ||
                   1961:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   1962:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   1963:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   1964:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   1965:             $clientunicode,$clientos,);
                   1966: }
                   1967: 
1.32      matthew  1968: ###############################################################
                   1969: ##    Authentication changing form generation subroutines    ##
                   1970: ###############################################################
                   1971: ##
                   1972: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   1973: ## hash, and have reasonable default values.
                   1974: ##
                   1975: ##    formname = the name given in the <form> tag.
1.35      matthew  1976: #-------------------------------------------
                   1977: 
1.45      matthew  1978: =pod
                   1979: 
1.112     bowersj2 1980: =head1 Authentication Routines
                   1981: 
                   1982: =over 4
                   1983: 
1.648     raeburn  1984: =item * &authform_xxxxxx()
1.35      matthew  1985: 
                   1986: The authform_xxxxxx subroutines provide javascript and html forms which 
                   1987: handle some of the conveniences required for authentication forms.  
                   1988: This is not an optimal method, but it works.  
                   1989: 
                   1990: =over 4
                   1991: 
1.112     bowersj2 1992: =item * authform_header
1.35      matthew  1993: 
1.112     bowersj2 1994: =item * authform_authorwarning
1.35      matthew  1995: 
1.112     bowersj2 1996: =item * authform_nochange
1.35      matthew  1997: 
1.112     bowersj2 1998: =item * authform_kerberos
1.35      matthew  1999: 
1.112     bowersj2 2000: =item * authform_internal
1.35      matthew  2001: 
1.112     bowersj2 2002: =item * authform_filesystem
1.35      matthew  2003: 
                   2004: =back
                   2005: 
1.648     raeburn  2006: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2007: 
1.35      matthew  2008: =cut
                   2009: 
                   2010: #-------------------------------------------
1.32      matthew  2011: sub authform_header{  
                   2012:     my %in = (
                   2013:         formname => 'cu',
1.80      albertel 2014:         kerb_def_dom => '',
1.32      matthew  2015:         @_,
                   2016:     );
                   2017:     $in{'formname'} = 'document.' . $in{'formname'};
                   2018:     my $result='';
1.80      albertel 2019: 
                   2020: #---------------------------------------------- Code for upper case translation
                   2021:     my $Javascript_toUpperCase;
                   2022:     unless ($in{kerb_def_dom}) {
                   2023:         $Javascript_toUpperCase =<<"END";
                   2024:         switch (choice) {
                   2025:            case 'krb': currentform.elements[choicearg].value =
                   2026:                currentform.elements[choicearg].value.toUpperCase();
                   2027:                break;
                   2028:            default:
                   2029:         }
                   2030: END
                   2031:     } else {
                   2032:         $Javascript_toUpperCase = "";
                   2033:     }
                   2034: 
1.165     raeburn  2035:     my $radioval = "'nochange'";
1.591     raeburn  2036:     if (defined($in{'curr_authtype'})) {
                   2037:         if ($in{'curr_authtype'} ne '') {
                   2038:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2039:         }
1.174     matthew  2040:     }
1.165     raeburn  2041:     my $argfield = 'null';
1.591     raeburn  2042:     if (defined($in{'mode'})) {
1.165     raeburn  2043:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2044:             if (defined($in{'curr_autharg'})) {
                   2045:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2046:                     $argfield = "'$in{'curr_autharg'}'";
                   2047:                 }
                   2048:             }
                   2049:         }
                   2050:     }
                   2051: 
1.32      matthew  2052:     $result.=<<"END";
                   2053: var current = new Object();
1.165     raeburn  2054: current.radiovalue = $radioval;
                   2055: current.argfield = $argfield;
1.32      matthew  2056: 
                   2057: function changed_radio(choice,currentform) {
                   2058:     var choicearg = choice + 'arg';
                   2059:     // If a radio button in changed, we need to change the argfield
                   2060:     if (current.radiovalue != choice) {
                   2061:         current.radiovalue = choice;
                   2062:         if (current.argfield != null) {
                   2063:             currentform.elements[current.argfield].value = '';
                   2064:         }
                   2065:         if (choice == 'nochange') {
                   2066:             current.argfield = null;
                   2067:         } else {
                   2068:             current.argfield = choicearg;
                   2069:             switch(choice) {
                   2070:                 case 'krb': 
                   2071:                     currentform.elements[current.argfield].value = 
                   2072:                         "$in{'kerb_def_dom'}";
                   2073:                 break;
                   2074:               default:
                   2075:                 break;
                   2076:             }
                   2077:         }
                   2078:     }
                   2079:     return;
                   2080: }
1.22      www      2081: 
1.32      matthew  2082: function changed_text(choice,currentform) {
                   2083:     var choicearg = choice + 'arg';
                   2084:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2085:         $Javascript_toUpperCase
1.32      matthew  2086:         // clear old field
                   2087:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2088:             currentform.elements[current.argfield].value = '';
                   2089:         }
                   2090:         current.argfield = choicearg;
                   2091:     }
                   2092:     set_auth_radio_buttons(choice,currentform);
                   2093:     return;
1.20      www      2094: }
1.32      matthew  2095: 
                   2096: function set_auth_radio_buttons(newvalue,currentform) {
                   2097:     var i=0;
                   2098:     while (i < currentform.login.length) {
                   2099:         if (currentform.login[i].value == newvalue) { break; }
                   2100:         i++;
                   2101:     }
                   2102:     if (i == currentform.login.length) {
                   2103:         return;
                   2104:     }
                   2105:     current.radiovalue = newvalue;
                   2106:     currentform.login[i].checked = true;
                   2107:     return;
                   2108: }
                   2109: END
                   2110:     return $result;
                   2111: }
                   2112: 
                   2113: sub authform_authorwarning{
                   2114:     my $result='';
1.144     matthew  2115:     $result='<i>'.
                   2116:         &mt('As a general rule, only authors or co-authors should be '.
                   2117:             'filesystem authenticated '.
                   2118:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2119:     return $result;
                   2120: }
                   2121: 
                   2122: sub authform_nochange{  
                   2123:     my %in = (
                   2124:               formname => 'document.cu',
                   2125:               kerb_def_dom => 'MSU.EDU',
                   2126:               @_,
                   2127:           );
1.586     raeburn  2128:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2129:     my $result;
                   2130:     if (keys(%can_assign) == 0) {
                   2131:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2132:     } else {
                   2133:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2134:                   '<input type="radio" name="login" value="nochange" '.
                   2135:                   'checked="checked" onclick="'.
1.281     albertel 2136:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2137: 	    '</label>';
1.586     raeburn  2138:     }
1.32      matthew  2139:     return $result;
                   2140: }
                   2141: 
1.591     raeburn  2142: sub authform_kerberos {
1.32      matthew  2143:     my %in = (
                   2144:               formname => 'document.cu',
                   2145:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2146:               kerb_def_auth => 'krb4',
1.32      matthew  2147:               @_,
                   2148:               );
1.586     raeburn  2149:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2150:         $autharg,$jscall);
                   2151:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2152:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2153:        $check5 = ' checked="checked"';
1.80      albertel 2154:     } else {
1.772     bisitz   2155:        $check4 = ' checked="checked"';
1.80      albertel 2156:     }
1.165     raeburn  2157:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2158:     if (defined($in{'curr_authtype'})) {
                   2159:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2160:             $krbcheck = ' checked="checked"';
1.623     raeburn  2161:             if (defined($in{'mode'})) {
                   2162:                 if ($in{'mode'} eq 'modifyuser') {
                   2163:                     $krbcheck = '';
                   2164:                 }
                   2165:             }
1.591     raeburn  2166:             if (defined($in{'curr_kerb_ver'})) {
                   2167:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2168:                     $check5 = ' checked="checked"';
1.591     raeburn  2169:                     $check4 = '';
                   2170:                 } else {
1.772     bisitz   2171:                     $check4 = ' checked="checked"';
1.591     raeburn  2172:                     $check5 = '';
                   2173:                 }
1.586     raeburn  2174:             }
1.591     raeburn  2175:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2176:                 $krbarg = $in{'curr_autharg'};
                   2177:             }
1.586     raeburn  2178:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2179:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2180:                     $result = 
                   2181:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2182:         $in{'curr_autharg'},$krbver);
                   2183:                 } else {
                   2184:                     $result =
                   2185:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2186:                 }
                   2187:                 return $result; 
                   2188:             }
                   2189:         }
                   2190:     } else {
                   2191:         if ($authnum == 1) {
1.784     bisitz   2192:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2193:         }
                   2194:     }
1.586     raeburn  2195:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2196:         return;
1.587     raeburn  2197:     } elsif ($authtype eq '') {
1.591     raeburn  2198:         if (defined($in{'mode'})) {
1.587     raeburn  2199:             if ($in{'mode'} eq 'modifycourse') {
                   2200:                 if ($authnum == 1) {
1.784     bisitz   2201:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2202:                 }
                   2203:             }
                   2204:         }
1.586     raeburn  2205:     }
                   2206:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2207:     if ($authtype eq '') {
                   2208:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2209:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2210:                     $krbcheck.' />';
                   2211:     }
                   2212:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2213:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2214:          $in{'curr_authtype'} eq 'krb5') ||
                   2215:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2216:          $in{'curr_authtype'} eq 'krb4')) {
                   2217:         $result .= &mt
1.144     matthew  2218:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2219:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2220:          '<label>'.$authtype,
1.281     albertel 2221:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2222:              'value="'.$krbarg.'" '.
1.144     matthew  2223:              'onchange="'.$jscall.'" />',
1.281     albertel 2224:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2225:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2226: 	 '</label>');
1.586     raeburn  2227:     } elsif ($can_assign{'krb4'}) {
                   2228:         $result .= &mt
                   2229:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2230:          '[_3] Version 4 [_4]',
                   2231:          '<label>'.$authtype,
                   2232:          '</label><input type="text" size="10" name="krbarg" '.
                   2233:              'value="'.$krbarg.'" '.
                   2234:              'onchange="'.$jscall.'" />',
                   2235:          '<label><input type="hidden" name="krbver" value="4" />',
                   2236:          '</label>');
                   2237:     } elsif ($can_assign{'krb5'}) {
                   2238:         $result .= &mt
                   2239:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2240:          '[_3] Version 5 [_4]',
                   2241:          '<label>'.$authtype,
                   2242:          '</label><input type="text" size="10" name="krbarg" '.
                   2243:              'value="'.$krbarg.'" '.
                   2244:              'onchange="'.$jscall.'" />',
                   2245:          '<label><input type="hidden" name="krbver" value="5" />',
                   2246:          '</label>');
                   2247:     }
1.32      matthew  2248:     return $result;
                   2249: }
                   2250: 
                   2251: sub authform_internal{  
1.586     raeburn  2252:     my %in = (
1.32      matthew  2253:                 formname => 'document.cu',
                   2254:                 kerb_def_dom => 'MSU.EDU',
                   2255:                 @_,
                   2256:                 );
1.586     raeburn  2257:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2258:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2259:     if (defined($in{'curr_authtype'})) {
                   2260:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2261:             if ($can_assign{'int'}) {
1.772     bisitz   2262:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2263:                 if (defined($in{'mode'})) {
                   2264:                     if ($in{'mode'} eq 'modifyuser') {
                   2265:                         $intcheck = '';
                   2266:                     }
                   2267:                 }
1.591     raeburn  2268:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2269:                     $intarg = $in{'curr_autharg'};
                   2270:                 }
                   2271:             } else {
                   2272:                 $result = &mt('Currently internally authenticated.');
                   2273:                 return $result;
1.165     raeburn  2274:             }
                   2275:         }
1.586     raeburn  2276:     } else {
                   2277:         if ($authnum == 1) {
1.784     bisitz   2278:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2279:         }
                   2280:     }
                   2281:     if (!$can_assign{'int'}) {
                   2282:         return;
1.587     raeburn  2283:     } elsif ($authtype eq '') {
1.591     raeburn  2284:         if (defined($in{'mode'})) {
1.587     raeburn  2285:             if ($in{'mode'} eq 'modifycourse') {
                   2286:                 if ($authnum == 1) {
1.784     bisitz   2287:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2288:                 }
                   2289:             }
                   2290:         }
1.165     raeburn  2291:     }
1.586     raeburn  2292:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2293:     if ($authtype eq '') {
                   2294:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2295:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2296:     }
1.605     bisitz   2297:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2298:                $intarg.'" onchange="'.$jscall.'" />';
                   2299:     $result = &mt
1.144     matthew  2300:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2301:          '<label>'.$authtype,'</label>'.$autharg);
1.620     www      2302:     $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  2303:     return $result;
                   2304: }
                   2305: 
                   2306: sub authform_local{  
                   2307:     my %in = (
                   2308:               formname => 'document.cu',
                   2309:               kerb_def_dom => 'MSU.EDU',
                   2310:               @_,
                   2311:               );
1.586     raeburn  2312:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2313:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2314:     if (defined($in{'curr_authtype'})) {
                   2315:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2316:             if ($can_assign{'loc'}) {
1.772     bisitz   2317:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2318:                 if (defined($in{'mode'})) {
                   2319:                     if ($in{'mode'} eq 'modifyuser') {
                   2320:                         $loccheck = '';
                   2321:                     }
                   2322:                 }
1.591     raeburn  2323:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2324:                     $locarg = $in{'curr_autharg'};
                   2325:                 }
                   2326:             } else {
                   2327:                 $result = &mt('Currently using local (institutional) authentication.');
                   2328:                 return $result;
1.165     raeburn  2329:             }
                   2330:         }
1.586     raeburn  2331:     } else {
                   2332:         if ($authnum == 1) {
1.784     bisitz   2333:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2334:         }
                   2335:     }
                   2336:     if (!$can_assign{'loc'}) {
                   2337:         return;
1.587     raeburn  2338:     } elsif ($authtype eq '') {
1.591     raeburn  2339:         if (defined($in{'mode'})) {
1.587     raeburn  2340:             if ($in{'mode'} eq 'modifycourse') {
                   2341:                 if ($authnum == 1) {
1.784     bisitz   2342:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2343:                 }
                   2344:             }
                   2345:         }
1.165     raeburn  2346:     }
1.586     raeburn  2347:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2348:     if ($authtype eq '') {
                   2349:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2350:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2351:                     $jscall.'" />';
                   2352:     }
                   2353:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2354:                $locarg.'" onchange="'.$jscall.'" />';
                   2355:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2356:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2357:     return $result;
                   2358: }
                   2359: 
                   2360: sub authform_filesystem{  
                   2361:     my %in = (
                   2362:               formname => 'document.cu',
                   2363:               kerb_def_dom => 'MSU.EDU',
                   2364:               @_,
                   2365:               );
1.586     raeburn  2366:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2367:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2368:     if (defined($in{'curr_authtype'})) {
                   2369:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2370:             if ($can_assign{'fsys'}) {
1.772     bisitz   2371:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2372:                 if (defined($in{'mode'})) {
                   2373:                     if ($in{'mode'} eq 'modifyuser') {
                   2374:                         $fsyscheck = '';
                   2375:                     }
                   2376:                 }
1.586     raeburn  2377:             } else {
                   2378:                 $result = &mt('Currently Filesystem Authenticated.');
                   2379:                 return $result;
                   2380:             }           
                   2381:         }
                   2382:     } else {
                   2383:         if ($authnum == 1) {
1.784     bisitz   2384:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2385:         }
                   2386:     }
                   2387:     if (!$can_assign{'fsys'}) {
                   2388:         return;
1.587     raeburn  2389:     } elsif ($authtype eq '') {
1.591     raeburn  2390:         if (defined($in{'mode'})) {
1.587     raeburn  2391:             if ($in{'mode'} eq 'modifycourse') {
                   2392:                 if ($authnum == 1) {
1.784     bisitz   2393:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2394:                 }
                   2395:             }
                   2396:         }
1.586     raeburn  2397:     }
                   2398:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2399:     if ($authtype eq '') {
                   2400:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2401:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2402:                     $jscall.'" />';
                   2403:     }
                   2404:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2405:                ' onchange="'.$jscall.'" />';
                   2406:     $result = &mt
1.144     matthew  2407:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2408:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2409:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2410:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2411:                   'onchange="'.$jscall.'" />');
1.32      matthew  2412:     return $result;
                   2413: }
                   2414: 
1.586     raeburn  2415: sub get_assignable_auth {
                   2416:     my ($dom) = @_;
                   2417:     if ($dom eq '') {
                   2418:         $dom = $env{'request.role.domain'};
                   2419:     }
                   2420:     my %can_assign = (
                   2421:                           krb4 => 1,
                   2422:                           krb5 => 1,
                   2423:                           int  => 1,
                   2424:                           loc  => 1,
                   2425:                      );
                   2426:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2427:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2428:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2429:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2430:             my $context;
                   2431:             if ($env{'request.role'} =~ /^au/) {
                   2432:                 $context = 'author';
                   2433:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2434:                 $context = 'domain';
                   2435:             } elsif ($env{'request.course.id'}) {
                   2436:                 $context = 'course';
                   2437:             }
                   2438:             if ($context) {
                   2439:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2440:                    %can_assign = %{$authhash->{$context}}; 
                   2441:                 }
                   2442:             }
                   2443:         }
                   2444:     }
                   2445:     my $authnum = 0;
                   2446:     foreach my $key (keys(%can_assign)) {
                   2447:         if ($can_assign{$key}) {
                   2448:             $authnum ++;
                   2449:         }
                   2450:     }
                   2451:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2452:         $authnum --;
                   2453:     }
                   2454:     return ($authnum,%can_assign);
                   2455: }
                   2456: 
1.80      albertel 2457: ###############################################################
                   2458: ##    Get Kerberos Defaults for Domain                 ##
                   2459: ###############################################################
                   2460: ##
                   2461: ## Returns default kerberos version and an associated argument
                   2462: ## as listed in file domain.tab. If not listed, provides
                   2463: ## appropriate default domain and kerberos version.
                   2464: ##
                   2465: #-------------------------------------------
                   2466: 
                   2467: =pod
                   2468: 
1.648     raeburn  2469: =item * &get_kerberos_defaults()
1.80      albertel 2470: 
                   2471: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2472: version and domain. If not found, it defaults to version 4 and the 
                   2473: domain of the server.
1.80      albertel 2474: 
1.648     raeburn  2475: =over 4
                   2476: 
1.80      albertel 2477: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2478: 
1.648     raeburn  2479: =back
                   2480: 
                   2481: =back
                   2482: 
1.80      albertel 2483: =cut
                   2484: 
                   2485: #-------------------------------------------
                   2486: sub get_kerberos_defaults {
                   2487:     my $domain=shift;
1.641     raeburn  2488:     my ($krbdef,$krbdefdom);
                   2489:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2490:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2491:         $krbdef = $domdefaults{'auth_def'};
                   2492:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2493:     } else {
1.80      albertel 2494:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2495:         my $krbdefdom=$1;
                   2496:         $krbdefdom=~tr/a-z/A-Z/;
                   2497:         $krbdef = "krb4";
                   2498:     }
                   2499:     return ($krbdef,$krbdefdom);
                   2500: }
1.112     bowersj2 2501: 
1.32      matthew  2502: 
1.46      matthew  2503: ###############################################################
                   2504: ##                Thesaurus Functions                        ##
                   2505: ###############################################################
1.20      www      2506: 
1.46      matthew  2507: =pod
1.20      www      2508: 
1.112     bowersj2 2509: =head1 Thesaurus Functions
                   2510: 
                   2511: =over 4
                   2512: 
1.648     raeburn  2513: =item * &initialize_keywords()
1.46      matthew  2514: 
                   2515: Initializes the package variable %Keywords if it is empty.  Uses the
                   2516: package variable $thesaurus_db_file.
                   2517: 
                   2518: =cut
                   2519: 
                   2520: ###################################################
                   2521: 
                   2522: sub initialize_keywords {
                   2523:     return 1 if (scalar keys(%Keywords));
                   2524:     # If we are here, %Keywords is empty, so fill it up
                   2525:     #   Make sure the file we need exists...
                   2526:     if (! -e $thesaurus_db_file) {
                   2527:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2528:                                  " failed because it does not exist");
                   2529:         return 0;
                   2530:     }
                   2531:     #   Set up the hash as a database
                   2532:     my %thesaurus_db;
                   2533:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2534:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2535:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2536:                                  $thesaurus_db_file);
                   2537:         return 0;
                   2538:     } 
                   2539:     #  Get the average number of appearances of a word.
                   2540:     my $avecount = $thesaurus_db{'average.count'};
                   2541:     #  Put keywords (those that appear > average) into %Keywords
                   2542:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2543:         my ($count,undef) = split /:/,$data;
                   2544:         $Keywords{$word}++ if ($count > $avecount);
                   2545:     }
                   2546:     untie %thesaurus_db;
                   2547:     # Remove special values from %Keywords.
1.356     albertel 2548:     foreach my $value ('total.count','average.count') {
                   2549:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2550:   }
1.46      matthew  2551:     return 1;
                   2552: }
                   2553: 
                   2554: ###################################################
                   2555: 
                   2556: =pod
                   2557: 
1.648     raeburn  2558: =item * &keyword($word)
1.46      matthew  2559: 
                   2560: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2561: than the average number of times in the thesaurus database.  Calls 
                   2562: &initialize_keywords
                   2563: 
                   2564: =cut
                   2565: 
                   2566: ###################################################
1.20      www      2567: 
                   2568: sub keyword {
1.46      matthew  2569:     return if (!&initialize_keywords());
                   2570:     my $word=lc(shift());
                   2571:     $word=~s/\W//g;
                   2572:     return exists($Keywords{$word});
1.20      www      2573: }
1.46      matthew  2574: 
                   2575: ###############################################################
                   2576: 
                   2577: =pod 
1.20      www      2578: 
1.648     raeburn  2579: =item * &get_related_words()
1.46      matthew  2580: 
1.160     matthew  2581: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2582: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2583: will be returned.  The order of the words returned is determined by the
                   2584: database which holds them.
                   2585: 
                   2586: Uses global $thesaurus_db_file.
                   2587: 
                   2588: =cut
                   2589: 
                   2590: ###############################################################
                   2591: sub get_related_words {
                   2592:     my $keyword = shift;
                   2593:     my %thesaurus_db;
                   2594:     if (! -e $thesaurus_db_file) {
                   2595:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2596:                                  "failed because the file does not exist");
                   2597:         return ();
                   2598:     }
                   2599:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2600:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2601:         return ();
                   2602:     } 
                   2603:     my @Words=();
1.429     www      2604:     my $count=0;
1.46      matthew  2605:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2606: 	# The first element is the number of times
                   2607: 	# the word appears.  We do not need it now.
1.429     www      2608: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2609: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2610: 	my $threshold=$mostfrequentcount/10;
                   2611:         foreach my $possibleword (@RelatedWords) {
                   2612:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2613:             if ($wordcount>$threshold) {
                   2614: 		push(@Words,$word);
                   2615:                 $count++;
                   2616:                 if ($count>10) { last; }
                   2617: 	    }
1.20      www      2618:         }
                   2619:     }
1.46      matthew  2620:     untie %thesaurus_db;
                   2621:     return @Words;
1.14      harris41 2622: }
1.46      matthew  2623: 
1.112     bowersj2 2624: =pod
                   2625: 
                   2626: =back
                   2627: 
                   2628: =cut
1.61      www      2629: 
                   2630: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2631: =pod
                   2632: 
1.112     bowersj2 2633: =head1 User Name Functions
                   2634: 
                   2635: =over 4
                   2636: 
1.648     raeburn  2637: =item * &plainname($uname,$udom,$first)
1.81      albertel 2638: 
1.112     bowersj2 2639: Takes a users logon name and returns it as a string in
1.226     albertel 2640: "first middle last generation" form 
                   2641: if $first is set to 'lastname' then it returns it as
                   2642: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2643: 
                   2644: =cut
1.61      www      2645: 
1.295     www      2646: 
1.81      albertel 2647: ###############################################################
1.61      www      2648: sub plainname {
1.226     albertel 2649:     my ($uname,$udom,$first)=@_;
1.537     albertel 2650:     return if (!defined($uname) || !defined($udom));
1.295     www      2651:     my %names=&getnames($uname,$udom);
1.226     albertel 2652:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2653: 					  $names{'middlename'},
                   2654: 					  $names{'lastname'},
                   2655: 					  $names{'generation'},$first);
                   2656:     $name=~s/^\s+//;
1.62      www      2657:     $name=~s/\s+$//;
                   2658:     $name=~s/\s+/ /g;
1.353     albertel 2659:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2660:     return $name;
1.61      www      2661: }
1.66      www      2662: 
                   2663: # -------------------------------------------------------------------- Nickname
1.81      albertel 2664: =pod
                   2665: 
1.648     raeburn  2666: =item * &nickname($uname,$udom)
1.81      albertel 2667: 
                   2668: Gets a users name and returns it as a string as
                   2669: 
                   2670: "&quot;nickname&quot;"
1.66      www      2671: 
1.81      albertel 2672: if the user has a nickname or
                   2673: 
                   2674: "first middle last generation"
                   2675: 
                   2676: if the user does not
                   2677: 
                   2678: =cut
1.66      www      2679: 
                   2680: sub nickname {
                   2681:     my ($uname,$udom)=@_;
1.537     albertel 2682:     return if (!defined($uname) || !defined($udom));
1.295     www      2683:     my %names=&getnames($uname,$udom);
1.68      albertel 2684:     my $name=$names{'nickname'};
1.66      www      2685:     if ($name) {
                   2686:        $name='&quot;'.$name.'&quot;'; 
                   2687:     } else {
                   2688:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2689: 	     $names{'lastname'}.' '.$names{'generation'};
                   2690:        $name=~s/\s+$//;
                   2691:        $name=~s/\s+/ /g;
                   2692:     }
                   2693:     return $name;
                   2694: }
                   2695: 
1.295     www      2696: sub getnames {
                   2697:     my ($uname,$udom)=@_;
1.537     albertel 2698:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2699:     if ($udom eq 'public' && $uname eq 'public') {
                   2700: 	return ('lastname' => &mt('Public'));
                   2701:     }
1.295     www      2702:     my $id=$uname.':'.$udom;
                   2703:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2704:     if ($cached) {
                   2705: 	return %{$names};
                   2706:     } else {
                   2707: 	my %loadnames=&Apache::lonnet::get('environment',
                   2708:                     ['firstname','middlename','lastname','generation','nickname'],
                   2709: 					 $udom,$uname);
                   2710: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2711: 	return %loadnames;
                   2712:     }
                   2713: }
1.61      www      2714: 
1.542     raeburn  2715: # -------------------------------------------------------------------- getemails
1.648     raeburn  2716: 
1.542     raeburn  2717: =pod
                   2718: 
1.648     raeburn  2719: =item * &getemails($uname,$udom)
1.542     raeburn  2720: 
                   2721: Gets a user's email information and returns it as a hash with keys:
                   2722: notification, critnotification, permanentemail
                   2723: 
                   2724: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2725: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2726:  
1.648     raeburn  2727: 
1.542     raeburn  2728: =cut
                   2729: 
1.648     raeburn  2730: 
1.466     albertel 2731: sub getemails {
                   2732:     my ($uname,$udom)=@_;
                   2733:     if ($udom eq 'public' && $uname eq 'public') {
                   2734: 	return;
                   2735:     }
1.467     www      2736:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2737:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2738:     my $id=$uname.':'.$udom;
                   2739:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2740:     if ($cached) {
                   2741: 	return %{$names};
                   2742:     } else {
                   2743: 	my %loadnames=&Apache::lonnet::get('environment',
                   2744:                     			   ['notification','critnotification',
                   2745: 					    'permanentemail'],
                   2746: 					   $udom,$uname);
                   2747: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2748: 	return %loadnames;
                   2749:     }
                   2750: }
                   2751: 
1.551     albertel 2752: sub flush_email_cache {
                   2753:     my ($uname,$udom)=@_;
                   2754:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2755:     if (!$uname) { $uname=$env{'user.name'};   }
                   2756:     return if ($udom eq 'public' && $uname eq 'public');
                   2757:     my $id=$uname.':'.$udom;
                   2758:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2759: }
                   2760: 
1.728     raeburn  2761: # -------------------------------------------------------------------- getlangs
                   2762: 
                   2763: =pod
                   2764: 
                   2765: =item * &getlangs($uname,$udom)
                   2766: 
                   2767: Gets a user's language preference and returns it as a hash with key:
                   2768: language.
                   2769: 
                   2770: =cut
                   2771: 
                   2772: 
                   2773: sub getlangs {
                   2774:     my ($uname,$udom) = @_;
                   2775:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2776:     if (!$uname) { $uname=$env{'user.name'};   }
                   2777:     my $id=$uname.':'.$udom;
                   2778:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   2779:     if ($cached) {
                   2780:         return %{$langs};
                   2781:     } else {
                   2782:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   2783:                                            $udom,$uname);
                   2784:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   2785:         return %loadlangs;
                   2786:     }
                   2787: }
                   2788: 
                   2789: sub flush_langs_cache {
                   2790:     my ($uname,$udom)=@_;
                   2791:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2792:     if (!$uname) { $uname=$env{'user.name'};   }
                   2793:     return if ($udom eq 'public' && $uname eq 'public');
                   2794:     my $id=$uname.':'.$udom;
                   2795:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   2796: }
                   2797: 
1.61      www      2798: # ------------------------------------------------------------------ Screenname
1.81      albertel 2799: 
                   2800: =pod
                   2801: 
1.648     raeburn  2802: =item * &screenname($uname,$udom)
1.81      albertel 2803: 
                   2804: Gets a users screenname and returns it as a string
                   2805: 
                   2806: =cut
1.61      www      2807: 
                   2808: sub screenname {
                   2809:     my ($uname,$udom)=@_;
1.258     albertel 2810:     if ($uname eq $env{'user.name'} &&
                   2811: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2812:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2813:     return $names{'screenname'};
1.62      www      2814: }
                   2815: 
1.212     albertel 2816: 
1.802     bisitz   2817: # ------------------------------------------------------------- Confirm Wrapper
                   2818: =pod
                   2819: 
                   2820: =item confirmwrapper
                   2821: 
                   2822: Wrap messages about completion of operation in box
                   2823: 
                   2824: =cut
                   2825: 
                   2826: sub confirmwrapper {
                   2827:     my ($message)=@_;
                   2828:     if ($message) {
                   2829:         return "\n".'<div class="LC_confirm_box">'."\n"
                   2830:                .$message."\n"
                   2831:                .'</div>'."\n";
                   2832:     } else {
                   2833:         return $message;
                   2834:     }
                   2835: }
                   2836: 
1.62      www      2837: # ------------------------------------------------------------- Message Wrapper
                   2838: 
                   2839: sub messagewrapper {
1.369     www      2840:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      2841:     return 
1.441     albertel 2842:         '<a href="/adm/email?compose=individual&amp;'.
                   2843:         'recname='.$username.'&amp;recdom='.$domain.
                   2844: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  2845:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      2846: }
1.802     bisitz   2847: 
1.74      www      2848: # --------------------------------------------------------------- Notes Wrapper
                   2849: 
                   2850: sub noteswrapper {
                   2851:     my ($link,$un,$do)=@_;
                   2852:     return 
                   2853: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62      www      2854: }
1.802     bisitz   2855: 
1.62      www      2856: # ------------------------------------------------------------- Aboutme Wrapper
                   2857: 
                   2858: sub aboutmewrapper {
1.166     www      2859:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  2860:     if (!defined($username)  && !defined($domain)) {
                   2861:         return;
                   2862:     }
1.205     www      2863:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.756     weissno  2864: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      2865: }
                   2866: 
                   2867: # ------------------------------------------------------------ Syllabus Wrapper
                   2868: 
                   2869: sub syllabuswrapper {
1.707     bisitz   2870:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  2871:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      2872: }
1.14      harris41 2873: 
1.802     bisitz   2874: # -----------------------------------------------------------------------------
                   2875: 
1.208     matthew  2876: sub track_student_link {
1.268     albertel 2877:     my ($linktext,$sname,$sdom,$target,$start) = @_;
                   2878:     my $link ="/adm/trackstudent?";
1.208     matthew  2879:     my $title = 'View recent activity';
                   2880:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   2881:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 2882:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  2883:         $title .= ' of this student';
1.268     albertel 2884:     } 
1.208     matthew  2885:     if (defined($target) && $target !~ /^\s*$/) {
                   2886:         $target = qq{target="$target"};
                   2887:     } else {
                   2888:         $target = '';
                   2889:     }
1.268     albertel 2890:     if ($start) { $link.='&amp;start='.$start; }
1.554     albertel 2891:     $title = &mt($title);
                   2892:     $linktext = &mt($linktext);
1.448     albertel 2893:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   2894: 	&help_open_topic('View_recent_activity');
1.208     matthew  2895: }
                   2896: 
1.781     raeburn  2897: sub slot_reservations_link {
                   2898:     my ($linktext,$sname,$sdom,$target) = @_;
                   2899:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   2900:     my $title = 'View slot reservation history';
                   2901:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   2902:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   2903:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   2904:         $title .= ' of this student';
                   2905:     }
                   2906:     if (defined($target) && $target !~ /^\s*$/) {
                   2907:         $target = qq{target="$target"};
                   2908:     } else {
                   2909:         $target = '';
                   2910:     }
                   2911:     $title = &mt($title);
                   2912:     $linktext = &mt($linktext);
                   2913:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   2914: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   2915: 
                   2916: }
                   2917: 
1.508     www      2918: # ===================================================== Display a student photo
                   2919: 
                   2920: 
1.509     albertel 2921: sub student_image_tag {
1.508     www      2922:     my ($domain,$user)=@_;
                   2923:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   2924:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   2925: 	return '<img src="'.$imgsrc.'" align="right" />';
                   2926:     } else {
                   2927: 	return '';
                   2928:     }
                   2929: }
                   2930: 
1.112     bowersj2 2931: =pod
                   2932: 
                   2933: =back
                   2934: 
                   2935: =head1 Access .tab File Data
                   2936: 
                   2937: =over 4
                   2938: 
1.648     raeburn  2939: =item * &languageids() 
1.112     bowersj2 2940: 
                   2941: returns list of all language ids
                   2942: 
                   2943: =cut
                   2944: 
1.14      harris41 2945: sub languageids {
1.16      harris41 2946:     return sort(keys(%language));
1.14      harris41 2947: }
                   2948: 
1.112     bowersj2 2949: =pod
                   2950: 
1.648     raeburn  2951: =item * &languagedescription() 
1.112     bowersj2 2952: 
                   2953: returns description of a specified language id
                   2954: 
                   2955: =cut
                   2956: 
1.14      harris41 2957: sub languagedescription {
1.125     www      2958:     my $code=shift;
                   2959:     return  ($supported_language{$code}?'* ':'').
                   2960:             $language{$code}.
1.126     www      2961: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      2962: }
                   2963: 
                   2964: sub plainlanguagedescription {
                   2965:     my $code=shift;
                   2966:     return $language{$code};
                   2967: }
                   2968: 
                   2969: sub supportedlanguagecode {
                   2970:     my $code=shift;
                   2971:     return $supported_language{$code};
1.97      www      2972: }
                   2973: 
1.112     bowersj2 2974: =pod
                   2975: 
1.648     raeburn  2976: =item * &copyrightids() 
1.112     bowersj2 2977: 
                   2978: returns list of all copyrights
                   2979: 
                   2980: =cut
                   2981: 
                   2982: sub copyrightids {
                   2983:     return sort(keys(%cprtag));
                   2984: }
                   2985: 
                   2986: =pod
                   2987: 
1.648     raeburn  2988: =item * &copyrightdescription() 
1.112     bowersj2 2989: 
                   2990: returns description of a specified copyright id
                   2991: 
                   2992: =cut
                   2993: 
                   2994: sub copyrightdescription {
1.166     www      2995:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 2996: }
1.197     matthew  2997: 
                   2998: =pod
                   2999: 
1.648     raeburn  3000: =item * &source_copyrightids() 
1.192     taceyjo1 3001: 
                   3002: returns list of all source copyrights
                   3003: 
                   3004: =cut
                   3005: 
                   3006: sub source_copyrightids {
                   3007:     return sort(keys(%scprtag));
                   3008: }
                   3009: 
                   3010: =pod
                   3011: 
1.648     raeburn  3012: =item * &source_copyrightdescription() 
1.192     taceyjo1 3013: 
                   3014: returns description of a specified source copyright id
                   3015: 
                   3016: =cut
                   3017: 
                   3018: sub source_copyrightdescription {
                   3019:     return &mt($scprtag{shift(@_)});
                   3020: }
1.112     bowersj2 3021: 
                   3022: =pod
                   3023: 
1.648     raeburn  3024: =item * &filecategories() 
1.112     bowersj2 3025: 
                   3026: returns list of all file categories
                   3027: 
                   3028: =cut
                   3029: 
                   3030: sub filecategories {
                   3031:     return sort(keys(%category_extensions));
                   3032: }
                   3033: 
                   3034: =pod
                   3035: 
1.648     raeburn  3036: =item * &filecategorytypes() 
1.112     bowersj2 3037: 
                   3038: returns list of file types belonging to a given file
                   3039: category
                   3040: 
                   3041: =cut
                   3042: 
                   3043: sub filecategorytypes {
1.356     albertel 3044:     my ($cat) = @_;
                   3045:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3046: }
                   3047: 
                   3048: =pod
                   3049: 
1.648     raeburn  3050: =item * &fileembstyle() 
1.112     bowersj2 3051: 
                   3052: returns embedding style for a specified file type
                   3053: 
                   3054: =cut
                   3055: 
                   3056: sub fileembstyle {
                   3057:     return $fe{lc(shift(@_))};
1.169     www      3058: }
                   3059: 
1.351     www      3060: sub filemimetype {
                   3061:     return $fm{lc(shift(@_))};
                   3062: }
                   3063: 
1.169     www      3064: 
                   3065: sub filecategoryselect {
                   3066:     my ($name,$value)=@_;
1.189     matthew  3067:     return &select_form($value,$name,
1.169     www      3068: 			'' => &mt('Any category'),
                   3069: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 3070: }
                   3071: 
                   3072: =pod
                   3073: 
1.648     raeburn  3074: =item * &filedescription() 
1.112     bowersj2 3075: 
                   3076: returns description for a specified file type
                   3077: 
                   3078: =cut
                   3079: 
                   3080: sub filedescription {
1.188     matthew  3081:     my $file_description = $fd{lc(shift())};
                   3082:     $file_description =~ s:([\[\]]):~$1:g;
                   3083:     return &mt($file_description);
1.112     bowersj2 3084: }
                   3085: 
                   3086: =pod
                   3087: 
1.648     raeburn  3088: =item * &filedescriptionex() 
1.112     bowersj2 3089: 
                   3090: returns description for a specified file type with
                   3091: extra formatting
                   3092: 
                   3093: =cut
                   3094: 
                   3095: sub filedescriptionex {
                   3096:     my $ex=shift;
1.188     matthew  3097:     my $file_description = $fd{lc($ex)};
                   3098:     $file_description =~ s:([\[\]]):~$1:g;
                   3099:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3100: }
                   3101: 
                   3102: # End of .tab access
                   3103: =pod
                   3104: 
                   3105: =back
                   3106: 
                   3107: =cut
                   3108: 
                   3109: # ------------------------------------------------------------------ File Types
                   3110: sub fileextensions {
                   3111:     return sort(keys(%fe));
                   3112: }
                   3113: 
1.97      www      3114: # ----------------------------------------------------------- Display Languages
                   3115: # returns a hash with all desired display languages
                   3116: #
                   3117: 
                   3118: sub display_languages {
                   3119:     my %languages=();
1.695     raeburn  3120:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3121: 	$languages{$lang}=1;
1.97      www      3122:     }
                   3123:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3124:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3125: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3126: 	    $languages{$lang}=1;
1.97      www      3127:         }
                   3128:     }
                   3129:     return %languages;
1.14      harris41 3130: }
                   3131: 
1.582     albertel 3132: sub languages {
                   3133:     my ($possible_langs) = @_;
1.695     raeburn  3134:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3135:     if (!ref($possible_langs)) {
                   3136: 	if( wantarray ) {
                   3137: 	    return @preferred_langs;
                   3138: 	} else {
                   3139: 	    return $preferred_langs[0];
                   3140: 	}
                   3141:     }
                   3142:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3143:     my @preferred_possibilities;
                   3144:     foreach my $preferred_lang (@preferred_langs) {
                   3145: 	if (exists($possibilities{$preferred_lang})) {
                   3146: 	    push(@preferred_possibilities, $preferred_lang);
                   3147: 	}
                   3148:     }
                   3149:     if( wantarray ) {
                   3150: 	return @preferred_possibilities;
                   3151:     }
                   3152:     return $preferred_possibilities[0];
                   3153: }
                   3154: 
1.742     raeburn  3155: sub user_lang {
                   3156:     my ($touname,$toudom,$fromcid) = @_;
                   3157:     my @userlangs;
                   3158:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3159:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3160:                     $env{'course.'.$fromcid.'.languages'}));
                   3161:     } else {
                   3162:         my %langhash = &getlangs($touname,$toudom);
                   3163:         if ($langhash{'languages'} ne '') {
                   3164:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3165:         } else {
                   3166:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3167:             if ($domdefs{'lang_def'} ne '') {
                   3168:                 @userlangs = ($domdefs{'lang_def'});
                   3169:             }
                   3170:         }
                   3171:     }
                   3172:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3173:     my $user_lh = Apache::localize->get_handle(@languages);
                   3174:     return $user_lh;
                   3175: }
                   3176: 
                   3177: 
1.112     bowersj2 3178: ###############################################################
                   3179: ##               Student Answer Attempts                     ##
                   3180: ###############################################################
                   3181: 
                   3182: =pod
                   3183: 
                   3184: =head1 Alternate Problem Views
                   3185: 
                   3186: =over 4
                   3187: 
1.648     raeburn  3188: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3189:     $getattempt, $regexp, $gradesub)
                   3190: 
                   3191: Return string with previous attempt on problem. Arguments:
                   3192: 
                   3193: =over 4
                   3194: 
                   3195: =item * $symb: Problem, including path
                   3196: 
                   3197: =item * $username: username of the desired student
                   3198: 
                   3199: =item * $domain: domain of the desired student
1.14      harris41 3200: 
1.112     bowersj2 3201: =item * $course: Course ID
1.14      harris41 3202: 
1.112     bowersj2 3203: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3204:     something
1.14      harris41 3205: 
1.112     bowersj2 3206: =item * $regexp: if string matches this regexp, the string will be
                   3207:     sent to $gradesub
1.14      harris41 3208: 
1.112     bowersj2 3209: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3210: 
1.112     bowersj2 3211: =back
1.14      harris41 3212: 
1.112     bowersj2 3213: The output string is a table containing all desired attempts, if any.
1.16      harris41 3214: 
1.112     bowersj2 3215: =cut
1.1       albertel 3216: 
                   3217: sub get_previous_attempt {
1.43      ng       3218:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3219:   my $prevattempts='';
1.43      ng       3220:   no strict 'refs';
1.1       albertel 3221:   if ($symb) {
1.3       albertel 3222:     my (%returnhash)=
                   3223:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3224:     if ($returnhash{'version'}) {
                   3225:       my %lasthash=();
                   3226:       my $version;
                   3227:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3228:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3229: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3230:         }
1.1       albertel 3231:       }
1.596     albertel 3232:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3233:       $prevattempts.='<th>'.&mt('History').'</th>';
1.356     albertel 3234:       foreach my $key (sort(keys(%lasthash))) {
                   3235: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3236: 	if ($#parts > 0) {
1.31      albertel 3237: 	  my $data=$parts[-1];
                   3238: 	  pop(@parts);
1.596     albertel 3239: 	  $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.31      albertel 3240: 	} else {
1.41      ng       3241: 	  if ($#parts == 0) {
                   3242: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3243: 	  } else {
                   3244: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3245: 	  }
1.31      albertel 3246: 	}
1.16      harris41 3247:       }
1.596     albertel 3248:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3249:       if ($getattempt eq '') {
                   3250: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596     albertel 3251: 	  $prevattempts.=&start_data_table_row().
                   3252: 	      '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356     albertel 3253: 	    foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3254: 		my $value = &format_previous_attempt_value($key,
                   3255: 							   $returnhash{$version.':'.$key});
                   3256: 		$prevattempts.='<td>'.$value.'&nbsp;</td>';   
1.40      ng       3257: 	    }
1.596     albertel 3258: 	  $prevattempts.=&end_data_table_row();
1.40      ng       3259: 	 }
1.1       albertel 3260:       }
1.596     albertel 3261:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3262:       foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3263: 	my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356     albertel 3264: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       3265: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 3266:       }
1.596     albertel 3267:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3268:     } else {
1.596     albertel 3269:       $prevattempts=
                   3270: 	  &start_data_table().&start_data_table_row().
                   3271: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3272: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3273:     }
                   3274:   } else {
1.596     albertel 3275:     $prevattempts=
                   3276: 	  &start_data_table().&start_data_table_row().
                   3277: 	  '<td>'.&mt('No data.').'</td>'.
                   3278: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3279:   }
1.10      albertel 3280: }
                   3281: 
1.581     albertel 3282: sub format_previous_attempt_value {
                   3283:     my ($key,$value) = @_;
                   3284:     if ($key =~ /timestamp/) {
                   3285: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3286:     } elsif (ref($value) eq 'ARRAY') {
                   3287: 	$value = '('.join(', ', @{ $value }).')';
                   3288:     } else {
                   3289: 	$value = &unescape($value);
                   3290:     }
                   3291:     return $value;
                   3292: }
                   3293: 
                   3294: 
1.107     albertel 3295: sub relative_to_absolute {
                   3296:     my ($url,$output)=@_;
                   3297:     my $parser=HTML::TokeParser->new(\$output);
                   3298:     my $token;
                   3299:     my $thisdir=$url;
                   3300:     my @rlinks=();
                   3301:     while ($token=$parser->get_token) {
                   3302: 	if ($token->[0] eq 'S') {
                   3303: 	    if ($token->[1] eq 'a') {
                   3304: 		if ($token->[2]->{'href'}) {
                   3305: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3306: 		}
                   3307: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3308: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3309: 	    } elsif ($token->[1] eq 'base') {
                   3310: 		$thisdir=$token->[2]->{'href'};
                   3311: 	    }
                   3312: 	}
                   3313:     }
                   3314:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3315:     foreach my $link (@rlinks) {
1.726     raeburn  3316: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3317: 		($link=~/^\//) ||
                   3318: 		($link=~/^javascript:/i) ||
                   3319: 		($link=~/^mailto:/i) ||
                   3320: 		($link=~/^\#/)) {
                   3321: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3322: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3323: 	}
                   3324:     }
                   3325: # -------------------------------------------------- Deal with Applet codebases
                   3326:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3327:     return $output;
                   3328: }
                   3329: 
1.112     bowersj2 3330: =pod
                   3331: 
1.648     raeburn  3332: =item * &get_student_view()
1.112     bowersj2 3333: 
                   3334: show a snapshot of what student was looking at
                   3335: 
                   3336: =cut
                   3337: 
1.10      albertel 3338: sub get_student_view {
1.186     albertel 3339:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3340:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3341:   my (%form);
1.10      albertel 3342:   my @elements=('symb','courseid','domain','username');
                   3343:   foreach my $element (@elements) {
1.186     albertel 3344:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3345:   }
1.186     albertel 3346:   if (defined($moreenv)) {
                   3347:       %form=(%form,%{$moreenv});
                   3348:   }
1.236     albertel 3349:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3350:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3351:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3352:   $userview=~s/\<body[^\>]*\>//gi;
                   3353:   $userview=~s/\<\/body\>//gi;
                   3354:   $userview=~s/\<html\>//gi;
                   3355:   $userview=~s/\<\/html\>//gi;
                   3356:   $userview=~s/\<head\>//gi;
                   3357:   $userview=~s/\<\/head\>//gi;
                   3358:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3359:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3360:   if (wantarray) {
                   3361:      return ($userview,$response);
                   3362:   } else {
                   3363:      return $userview;
                   3364:   }
                   3365: }
                   3366: 
                   3367: sub get_student_view_with_retries {
                   3368:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3369: 
                   3370:     my $ok = 0;                 # True if we got a good response.
                   3371:     my $content;
                   3372:     my $response;
                   3373: 
                   3374:     # Try to get the student_view done. within the retries count:
                   3375:     
                   3376:     do {
                   3377:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3378:          $ok      = $response->is_success;
                   3379:          if (!$ok) {
                   3380:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3381:          }
                   3382:          $retries--;
                   3383:     } while (!$ok && ($retries > 0));
                   3384:     
                   3385:     if (!$ok) {
                   3386:        $content = '';          # On error return an empty content.
                   3387:     }
1.651     www      3388:     if (wantarray) {
                   3389:        return ($content, $response);
                   3390:     } else {
                   3391:        return $content;
                   3392:     }
1.11      albertel 3393: }
                   3394: 
1.112     bowersj2 3395: =pod
                   3396: 
1.648     raeburn  3397: =item * &get_student_answers() 
1.112     bowersj2 3398: 
                   3399: show a snapshot of how student was answering problem
                   3400: 
                   3401: =cut
                   3402: 
1.11      albertel 3403: sub get_student_answers {
1.100     sakharuk 3404:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3405:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3406:   my (%moreenv);
1.11      albertel 3407:   my @elements=('symb','courseid','domain','username');
                   3408:   foreach my $element (@elements) {
1.186     albertel 3409:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3410:   }
1.186     albertel 3411:   $moreenv{'grade_target'}='answer';
                   3412:   %moreenv=(%form,%moreenv);
1.497     raeburn  3413:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3414:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3415:   return $userview;
1.1       albertel 3416: }
1.116     albertel 3417: 
                   3418: =pod
                   3419: 
                   3420: =item * &submlink()
                   3421: 
1.242     albertel 3422: Inputs: $text $uname $udom $symb $target
1.116     albertel 3423: 
                   3424: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3425: 
                   3426: =cut
                   3427: 
                   3428: ###############################################
                   3429: sub submlink {
1.242     albertel 3430:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3431:     if (!($uname && $udom)) {
                   3432: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3433: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3434: 	if (!$symb) { $symb=$cursymb; }
                   3435:     }
1.254     matthew  3436:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3437:     $symb=&escape($symb);
1.242     albertel 3438:     if ($target) { $target="target=\"$target\""; }
                   3439:     return '<a href="/adm/grades?&command=submission&'.
                   3440: 	'symb='.$symb.'&student='.$uname.
                   3441: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   3442: }
                   3443: ##############################################
                   3444: 
                   3445: =pod
                   3446: 
                   3447: =item * &pgrdlink()
                   3448: 
                   3449: Inputs: $text $uname $udom $symb $target
                   3450: 
                   3451: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3452: 
                   3453: =cut
                   3454: 
                   3455: ###############################################
                   3456: sub pgrdlink {
                   3457:     my $link=&submlink(@_);
                   3458:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3459:     return $link;
                   3460: }
                   3461: ##############################################
                   3462: 
                   3463: =pod
                   3464: 
                   3465: =item * &pprmlink()
                   3466: 
                   3467: Inputs: $text $uname $udom $symb $target
                   3468: 
                   3469: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3470: student and a specific resource
1.242     albertel 3471: 
                   3472: =cut
                   3473: 
                   3474: ###############################################
                   3475: sub pprmlink {
                   3476:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3477:     if (!($uname && $udom)) {
                   3478: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3479: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3480: 	if (!$symb) { $symb=$cursymb; }
                   3481:     }
1.254     matthew  3482:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3483:     $symb=&escape($symb);
1.242     albertel 3484:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3485:     return '<a href="/adm/parmset?command=set&amp;'.
                   3486: 	'symb='.$symb.'&amp;uname='.$uname.
                   3487: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3488: }
                   3489: ##############################################
1.37      matthew  3490: 
1.112     bowersj2 3491: =pod
                   3492: 
                   3493: =back
                   3494: 
                   3495: =cut
                   3496: 
1.37      matthew  3497: ###############################################
1.51      www      3498: 
                   3499: 
                   3500: sub timehash {
1.687     raeburn  3501:     my ($thistime) = @_;
                   3502:     my $timezone = &Apache::lonlocal::gettimezone();
                   3503:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3504:                      ->set_time_zone($timezone);
                   3505:     my $wday = $dt->day_of_week();
                   3506:     if ($wday == 7) { $wday = 0; }
                   3507:     return ( 'second' => $dt->second(),
                   3508:              'minute' => $dt->minute(),
                   3509:              'hour'   => $dt->hour(),
                   3510:              'day'     => $dt->day_of_month(),
                   3511:              'month'   => $dt->month(),
                   3512:              'year'    => $dt->year(),
                   3513:              'weekday' => $wday,
                   3514:              'dayyear' => $dt->day_of_year(),
                   3515:              'dlsav'   => $dt->is_dst() );
1.51      www      3516: }
                   3517: 
1.370     www      3518: sub utc_string {
                   3519:     my ($date)=@_;
1.371     www      3520:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3521: }
                   3522: 
1.51      www      3523: sub maketime {
                   3524:     my %th=@_;
1.687     raeburn  3525:     my ($epoch_time,$timezone,$dt);
                   3526:     $timezone = &Apache::lonlocal::gettimezone();
                   3527:     eval {
                   3528:         $dt = DateTime->new( year   => $th{'year'},
                   3529:                              month  => $th{'month'},
                   3530:                              day    => $th{'day'},
                   3531:                              hour   => $th{'hour'},
                   3532:                              minute => $th{'minute'},
                   3533:                              second => $th{'second'},
                   3534:                              time_zone => $timezone,
                   3535:                          );
                   3536:     };
                   3537:     if (!$@) {
                   3538:         $epoch_time = $dt->epoch;
                   3539:         if ($epoch_time) {
                   3540:             return $epoch_time;
                   3541:         }
                   3542:     }
1.51      www      3543:     return POSIX::mktime(
                   3544:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3545:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3546: }
                   3547: 
                   3548: #########################################
1.51      www      3549: 
                   3550: sub findallcourses {
1.482     raeburn  3551:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3552:     my %roles;
                   3553:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3554:     my %courses;
1.51      www      3555:     my $now=time;
1.482     raeburn  3556:     if (!defined($uname)) {
                   3557:         $uname = $env{'user.name'};
                   3558:     }
                   3559:     if (!defined($udom)) {
                   3560:         $udom = $env{'user.domain'};
                   3561:     }
                   3562:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3563:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3564:         if (!%roles) {
                   3565:             %roles = (
                   3566:                        cc => 1,
                   3567:                        in => 1,
                   3568:                        ep => 1,
                   3569:                        ta => 1,
                   3570:                        cr => 1,
                   3571:                        st => 1,
                   3572:              );
                   3573:         }
                   3574:         foreach my $entry (keys(%roleshash)) {
                   3575:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3576:             if ($trole =~ /^cr/) { 
                   3577:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3578:             } else {
                   3579:                 next if (!exists($roles{$trole}));
                   3580:             }
                   3581:             if ($tend) {
                   3582:                 next if ($tend < $now);
                   3583:             }
                   3584:             if ($tstart) {
                   3585:                 next if ($tstart > $now);
                   3586:             }
                   3587:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3588:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3589:             if ($secpart eq '') {
                   3590:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3591:                 $sec = 'none';
                   3592:                 $realsec = '';
                   3593:             } else {
                   3594:                 $cnum = $cnumpart;
                   3595:                 ($sec,$role) = split(/_/,$secpart);
                   3596:                 $realsec = $sec;
1.490     raeburn  3597:             }
1.482     raeburn  3598:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3599:         }
                   3600:     } else {
                   3601:         foreach my $key (keys(%env)) {
1.483     albertel 3602: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3603:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3604: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3605: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3606: 	        next if (%roles && !exists($roles{$role}));
                   3607: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3608:                 my $active=1;
                   3609:                 if ($starttime) {
                   3610: 		    if ($now<$starttime) { $active=0; }
                   3611:                 }
                   3612:                 if ($endtime) {
                   3613:                     if ($now>$endtime) { $active=0; }
                   3614:                 }
                   3615:                 if ($active) {
                   3616:                     if ($sec eq '') {
                   3617:                         $sec = 'none';
                   3618:                     }
                   3619:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3620:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3621:                 }
                   3622:             }
1.51      www      3623:         }
                   3624:     }
1.474     raeburn  3625:     return %courses;
1.51      www      3626: }
1.37      matthew  3627: 
1.54      www      3628: ###############################################
1.474     raeburn  3629: 
                   3630: sub blockcheck {
1.482     raeburn  3631:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3632: 
                   3633:     if (!defined($udom)) {
                   3634:         $udom = $env{'user.domain'};
                   3635:     }
                   3636:     if (!defined($uname)) {
                   3637:         $uname = $env{'user.name'};
                   3638:     }
                   3639: 
                   3640:     # If uname and udom are for a course, check for blocks in the course.
                   3641: 
                   3642:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3643:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3644:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3645:         return ($startblock,$endblock);
                   3646:     }
1.474     raeburn  3647: 
1.502     raeburn  3648:     my $startblock = 0;
                   3649:     my $endblock = 0;
1.482     raeburn  3650:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3651: 
1.490     raeburn  3652:     # If uname is for a user, and activity is course-specific, i.e.,
                   3653:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3654: 
1.490     raeburn  3655:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3656:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3657:         foreach my $key (keys(%live_courses)) {
                   3658:             if ($key ne $env{'request.course.id'}) {
                   3659:                 delete($live_courses{$key});
                   3660:             }
                   3661:         }
                   3662:     }
                   3663: 
                   3664:     my $otheruser = 0;
                   3665:     my %own_courses;
                   3666:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3667:         # Resource belongs to user other than current user.
                   3668:         $otheruser = 1;
                   3669:         # Gather courses for current user
                   3670:         %own_courses = 
                   3671:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3672:     }
                   3673: 
                   3674:     # Gather active course roles - course coordinator, instructor, 
                   3675:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3676: 
                   3677:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3678:         my ($cdom,$cnum);
                   3679:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3680:             $cdom = $env{'course.'.$course.'.domain'};
                   3681:             $cnum = $env{'course.'.$course.'.num'};
                   3682:         } else {
1.490     raeburn  3683:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3684:         }
                   3685:         my $no_ownblock = 0;
                   3686:         my $no_userblock = 0;
1.533     raeburn  3687:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3688:             # Check if current user has 'evb' priv for this
                   3689:             if (defined($own_courses{$course})) {
                   3690:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3691:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3692:                     if ($sec ne 'none') {
                   3693:                         $checkrole .= '/'.$sec;
                   3694:                     }
                   3695:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3696:                         $no_ownblock = 1;
                   3697:                         last;
                   3698:                     }
                   3699:                 }
                   3700:             }
                   3701:             # if they have 'evb' priv and are currently not playing student
                   3702:             next if (($no_ownblock) &&
                   3703:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3704:         }
1.474     raeburn  3705:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3706:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3707:             if ($sec ne 'none') {
1.482     raeburn  3708:                 $checkrole .= '/'.$sec;
1.474     raeburn  3709:             }
1.490     raeburn  3710:             if ($otheruser) {
                   3711:                 # Resource belongs to user other than current user.
                   3712:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3713:                 my ($trole,$tdom,$tnum,$tsec);
                   3714:                 my $entry = $live_courses{$course}{$sec};
                   3715:                 if ($entry =~ /^cr/) {
                   3716:                     ($trole,$tdom,$tnum,$tsec) = 
                   3717:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3718:                 } else {
                   3719:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3720:                 }
                   3721:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3722:                 $area = '/'.$tdom.'/'.$tnum;
                   3723:                 $trest = $tnum;
                   3724:                 if ($tsec ne '') {
                   3725:                     $area .= '/'.$tsec;
                   3726:                     $trest .= '/'.$tsec;
                   3727:                 }
                   3728:                 $spec = $trole.'.'.$area;
                   3729:                 if ($trole =~ /^cr/) {
                   3730:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   3731:                                                       $tdom,$spec,$trest,$area);
                   3732:                 } else {
                   3733:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   3734:                                                        $tdom,$spec,$trest,$area);
                   3735:                 }
                   3736:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  3737:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   3738:                     if ($1) {
                   3739:                         $no_userblock = 1;
                   3740:                         last;
                   3741:                     }
                   3742:                 }
1.490     raeburn  3743:             } else {
                   3744:                 # Resource belongs to current user
                   3745:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  3746:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3747:                     $no_ownblock = 1;
                   3748:                     last;
                   3749:                 }
1.474     raeburn  3750:             }
                   3751:         }
                   3752:         # if they have the evb priv and are currently not playing student
1.482     raeburn  3753:         next if (($no_ownblock) &&
1.491     albertel 3754:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  3755:         next if ($no_userblock);
1.474     raeburn  3756: 
1.490     raeburn  3757:         # Retrieve blocking times and identity of blocker for course
                   3758:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  3759:         
                   3760:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   3761:         if (($start != 0) && 
                   3762:             (($startblock == 0) || ($startblock > $start))) {
                   3763:             $startblock = $start;
                   3764:         }
                   3765:         if (($end != 0)  &&
                   3766:             (($endblock == 0) || ($endblock < $end))) {
                   3767:             $endblock = $end;
                   3768:         }
1.490     raeburn  3769:     }
                   3770:     return ($startblock,$endblock);
                   3771: }
                   3772: 
                   3773: sub get_blocks {
                   3774:     my ($setters,$activity,$cdom,$cnum) = @_;
                   3775:     my $startblock = 0;
                   3776:     my $endblock = 0;
                   3777:     my $course = $cdom.'_'.$cnum;
                   3778:     $setters->{$course} = {};
                   3779:     $setters->{$course}{'staff'} = [];
                   3780:     $setters->{$course}{'times'} = [];
                   3781:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   3782:     foreach my $record (keys(%records)) {
                   3783:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   3784:         if ($start <= time && $end >= time) {
                   3785:             my ($staff_name,$staff_dom,$title,$blocks) =
                   3786:                 &parse_block_record($records{$record});
                   3787:             if ($blocks->{$activity} eq 'on') {
                   3788:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   3789:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 3790:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   3791:                     $startblock = $start;
1.490     raeburn  3792:                 }
1.491     albertel 3793:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   3794:                     $endblock = $end;
1.474     raeburn  3795:                 }
                   3796:             }
                   3797:         }
                   3798:     }
                   3799:     return ($startblock,$endblock);
                   3800: }
                   3801: 
                   3802: sub parse_block_record {
                   3803:     my ($record) = @_;
                   3804:     my ($setuname,$setudom,$title,$blocks);
                   3805:     if (ref($record) eq 'HASH') {
                   3806:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   3807:         $title = &unescape($record->{'event'});
                   3808:         $blocks = $record->{'blocks'};
                   3809:     } else {
                   3810:         my @data = split(/:/,$record,3);
                   3811:         if (scalar(@data) eq 2) {
                   3812:             $title = $data[1];
                   3813:             ($setuname,$setudom) = split(/@/,$data[0]);
                   3814:         } else {
                   3815:             ($setuname,$setudom,$title) = @data;
                   3816:         }
                   3817:         $blocks = { 'com' => 'on' };
                   3818:     }
                   3819:     return ($setuname,$setudom,$title,$blocks);
                   3820: }
                   3821: 
                   3822: sub build_block_table {
                   3823:     my ($startblock,$endblock,$setters) = @_;
                   3824:     my %lt = &Apache::lonlocal::texthash(
                   3825:         'cacb' => 'Currently active communication blocks',
                   3826:         'cour' => 'Course',
                   3827:         'dura' => 'Duration',
                   3828:         'blse' => 'Block set by'
                   3829:     );
                   3830:     my $output;
1.476     raeburn  3831:     $output = '<br />'.$lt{'cacb'}.':<br />';
1.474     raeburn  3832:     $output .= &start_data_table();
                   3833:     $output .= '
                   3834: <tr>
                   3835:  <th>'.$lt{'cour'}.'</th>
                   3836:  <th>'.$lt{'dura'}.'</th>
                   3837:  <th>'.$lt{'blse'}.'</th>
                   3838: </tr>
                   3839: ';
                   3840:     foreach my $course (keys(%{$setters})) {
                   3841:         my %courseinfo=&Apache::lonnet::coursedescription($course);
                   3842:         for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
                   3843:             my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490     raeburn  3844:             my $fullname = &plainname($uname,$udom);
                   3845:             if (defined($env{'user.name'}) && defined($env{'user.domain'})
                   3846:                 && $env{'user.name'} ne 'public' 
                   3847:                 && $env{'user.domain'} ne 'public') {
                   3848:                 $fullname = &aboutmewrapper($fullname,$uname,$udom);
                   3849:             }
1.474     raeburn  3850:             my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
                   3851:             $openblock = &Apache::lonlocal::locallocaltime($openblock);
                   3852:             $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
                   3853:             $output .= &Apache::loncommon::start_data_table_row().
                   3854:                        '<td>'.$courseinfo{'description'}.'</td>'.
                   3855:                        '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490     raeburn  3856:                        '<td>'.$fullname.'</td>'.
1.474     raeburn  3857:                         &Apache::loncommon::end_data_table_row();
                   3858:         }
                   3859:     }
                   3860:     $output .= &end_data_table();
                   3861: }
                   3862: 
1.490     raeburn  3863: sub blocking_status {
                   3864:     my ($activity,$uname,$udom) = @_;
                   3865:     my %setters;
                   3866:     my ($blocked,$output,$ownitem,$is_course);
                   3867:     my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
                   3868:     if ($startblock && $endblock) {
                   3869:         $blocked = 1;
                   3870:         if (wantarray) {
                   3871:             my $category;
                   3872:             if ($activity eq 'boards') {
                   3873:                 $category = 'Discussion posts in this course';
                   3874:             } elsif ($activity eq 'blogs') {
                   3875:                 $category = 'Blogs';
                   3876:             } elsif ($activity eq 'port') {
                   3877:                 if (defined($uname) && defined($udom)) {
                   3878:                     if ($uname eq $env{'user.name'} &&
                   3879:                         $udom eq $env{'user.domain'}) {
                   3880:                         $ownitem = 1;
                   3881:                     }
                   3882:                 }
                   3883:                 $is_course = &Apache::lonnet::is_course($udom,$uname);
                   3884:                 if ($ownitem) { 
                   3885:                     $category = 'Your portfolio files';  
                   3886:                 } elsif ($is_course) {
                   3887:                     my $coursedesc;
                   3888:                     foreach my $course (keys(%setters)) {
                   3889:                         my %courseinfo =
                   3890:                              &Apache::lonnet::coursedescription($course);
                   3891:                         $coursedesc = $courseinfo{'description'};
                   3892:                     }
1.764     weissno  3893:                     $category = "Group portfolio in the course '$coursedesc'";
1.490     raeburn  3894:                 } else {
                   3895:                     $category = 'Portfolio files belonging to ';
                   3896:                     if ($env{'user.name'} eq 'public' && 
                   3897:                         $env{'user.domain'} eq 'public') {
                   3898:                         $category .= &plainname($uname,$udom);
                   3899:                     } else {
                   3900:                         $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);  
                   3901:                     }
                   3902:                 }
                   3903:             } elsif ($activity eq 'groups') {
                   3904:                 $category = 'Groups in this course';
                   3905:             }
                   3906:             my $showstart = &Apache::lonlocal::locallocaltime($startblock);
                   3907:             my $showend = &Apache::lonlocal::locallocaltime($endblock);
                   3908:             $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
                   3909:             if (!($activity eq 'port' && !($ownitem) && !($is_course))) { 
                   3910:                 $output .= &build_block_table($startblock,$endblock,\%setters);
                   3911:             }
                   3912:         }
                   3913:     }
                   3914:     if (wantarray) {
                   3915:         return ($blocked,$output);
                   3916:     } else {
                   3917:         return $blocked;
                   3918:     }
                   3919: }
                   3920: 
1.60      matthew  3921: ###############################################
                   3922: 
1.682     raeburn  3923: sub check_ip_acc {
                   3924:     my ($acc)=@_;
                   3925:     &Apache::lonxml::debug("acc is $acc");
                   3926:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   3927:         return 1;
                   3928:     }
                   3929:     my $allowed=0;
                   3930:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   3931: 
                   3932:     my $name;
                   3933:     foreach my $pattern (split(',',$acc)) {
                   3934:         $pattern =~ s/^\s*//;
                   3935:         $pattern =~ s/\s*$//;
                   3936:         if ($pattern =~ /\*$/) {
                   3937:             #35.8.*
                   3938:             $pattern=~s/\*//;
                   3939:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   3940:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   3941:             #35.8.3.[34-56]
                   3942:             my $low=$2;
                   3943:             my $high=$3;
                   3944:             $pattern=$1;
                   3945:             if ($ip =~ /^\Q$pattern\E/) {
                   3946:                 my $last=(split(/\./,$ip))[3];
                   3947:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   3948:             }
                   3949:         } elsif ($pattern =~ /^\*/) {
                   3950:             #*.msu.edu
                   3951:             $pattern=~s/\*//;
                   3952:             if (!defined($name)) {
                   3953:                 use Socket;
                   3954:                 my $netaddr=inet_aton($ip);
                   3955:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   3956:             }
                   3957:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   3958:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   3959:             #127.0.0.1
                   3960:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   3961:         } else {
                   3962:             #some.name.com
                   3963:             if (!defined($name)) {
                   3964:                 use Socket;
                   3965:                 my $netaddr=inet_aton($ip);
                   3966:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   3967:             }
                   3968:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   3969:         }
                   3970:         if ($allowed) { last; }
                   3971:     }
                   3972:     return $allowed;
                   3973: }
                   3974: 
                   3975: ###############################################
                   3976: 
1.60      matthew  3977: =pod
                   3978: 
1.112     bowersj2 3979: =head1 Domain Template Functions
                   3980: 
                   3981: =over 4
                   3982: 
                   3983: =item * &determinedomain()
1.60      matthew  3984: 
                   3985: Inputs: $domain (usually will be undef)
                   3986: 
1.63      www      3987: Returns: Determines which domain should be used for designs
1.60      matthew  3988: 
                   3989: =cut
1.54      www      3990: 
1.60      matthew  3991: ###############################################
1.63      www      3992: sub determinedomain {
                   3993:     my $domain=shift;
1.531     albertel 3994:     if (! $domain) {
1.60      matthew  3995:         # Determine domain if we have not been given one
                   3996:         $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258     albertel 3997:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   3998:         if ($env{'request.role.domain'}) { 
                   3999:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4000:         }
                   4001:     }
1.63      www      4002:     return $domain;
                   4003: }
                   4004: ###############################################
1.517     raeburn  4005: 
1.518     albertel 4006: sub devalidate_domconfig_cache {
                   4007:     my ($udom)=@_;
                   4008:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4009: }
                   4010: 
                   4011: # ---------------------- Get domain configuration for a domain
                   4012: sub get_domainconf {
                   4013:     my ($udom) = @_;
                   4014:     my $cachetime=1800;
                   4015:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4016:     if (defined($cached)) { return %{$result}; }
                   4017: 
                   4018:     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   4019: 					     ['login','rolecolors'],$udom);
1.632     raeburn  4020:     my (%designhash,%legacy);
1.518     albertel 4021:     if (keys(%domconfig) > 0) {
                   4022:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4023:             if (keys(%{$domconfig{'login'}})) {
                   4024:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4025:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   4026:                         foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4027:                             $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4028:                                 $domconfig{'login'}{$key}{$img};
                   4029:                         }
                   4030:                     } else {
                   4031:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4032:                     }
1.632     raeburn  4033:                 }
                   4034:             } else {
                   4035:                 $legacy{'login'} = 1;
1.518     albertel 4036:             }
1.632     raeburn  4037:         } else {
                   4038:             $legacy{'login'} = 1;
1.518     albertel 4039:         }
                   4040:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4041:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4042:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4043:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4044:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4045:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4046:                         }
1.518     albertel 4047:                     }
                   4048:                 }
1.632     raeburn  4049:             } else {
                   4050:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4051:             }
1.632     raeburn  4052:         } else {
                   4053:             $legacy{'rolecolors'} = 1;
1.518     albertel 4054:         }
1.632     raeburn  4055:         if (keys(%legacy) > 0) {
                   4056:             my %legacyhash = &get_legacy_domconf($udom);
                   4057:             foreach my $item (keys(%legacyhash)) {
                   4058:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4059:                     if ($legacy{'login'}) { 
                   4060:                         $designhash{$item} = $legacyhash{$item};
                   4061:                     }
                   4062:                 } else {
                   4063:                     if ($legacy{'rolecolors'}) {
                   4064:                         $designhash{$item} = $legacyhash{$item};
                   4065:                     }
1.518     albertel 4066:                 }
                   4067:             }
                   4068:         }
1.632     raeburn  4069:     } else {
                   4070:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4071:     }
                   4072:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4073: 				  $cachetime);
                   4074:     return %designhash;
                   4075: }
                   4076: 
1.632     raeburn  4077: sub get_legacy_domconf {
                   4078:     my ($udom) = @_;
                   4079:     my %legacyhash;
                   4080:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4081:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4082:     if (-e $designfile) {
                   4083:         if ( open (my $fh,"<$designfile") ) {
                   4084:             while (my $line = <$fh>) {
                   4085:                 next if ($line =~ /^\#/);
                   4086:                 chomp($line);
                   4087:                 my ($key,$val)=(split(/\=/,$line));
                   4088:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4089:             }
                   4090:             close($fh);
                   4091:         }
                   4092:     }
                   4093:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   4094:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4095:     }
                   4096:     return %legacyhash;
                   4097: }
                   4098: 
1.63      www      4099: =pod
                   4100: 
1.112     bowersj2 4101: =item * &domainlogo()
1.63      www      4102: 
                   4103: Inputs: $domain (usually will be undef)
                   4104: 
                   4105: Returns: A link to a domain logo, if the domain logo exists.
                   4106: If the domain logo does not exist, a description of the domain.
                   4107: 
                   4108: =cut
1.112     bowersj2 4109: 
1.63      www      4110: ###############################################
                   4111: sub domainlogo {
1.517     raeburn  4112:     my $domain = &determinedomain(shift);
1.518     albertel 4113:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4114:     # See if there is a logo
                   4115:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4116:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4117:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4118: 	    if ($imgsrc =~ m{^/res/}) {
                   4119: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4120: 		&Apache::lonnet::repcopy($local_name);
                   4121: 	    }
                   4122: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4123:         } 
                   4124:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4125:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4126:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4127:     } else {
1.60      matthew  4128:         return '';
1.59      www      4129:     }
                   4130: }
1.63      www      4131: ##############################################
                   4132: 
                   4133: =pod
                   4134: 
1.112     bowersj2 4135: =item * &designparm()
1.63      www      4136: 
                   4137: Inputs: $which parameter; $domain (usually will be undef)
                   4138: 
                   4139: Returns: value of designparamter $which
                   4140: 
                   4141: =cut
1.112     bowersj2 4142: 
1.397     albertel 4143: 
1.400     albertel 4144: ##############################################
1.397     albertel 4145: sub designparm {
                   4146:     my ($which,$domain)=@_;
                   4147:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4148:         return $env{'environment.color.'.$which};
1.96      www      4149:     }
1.63      www      4150:     $domain=&determinedomain($domain);
1.518     albertel 4151:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  4152:     my $output;
1.517     raeburn  4153:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4154:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4155:     } else {
1.520     raeburn  4156:         $output = $defaultdesign{$which};
                   4157:     }
                   4158:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4159:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4160:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4161:             if ($output =~ m{^/res/}) {
                   4162:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4163:                 &Apache::lonnet::repcopy($local_name);
                   4164:             }
1.520     raeburn  4165:             $output = &lonhttpdurl($output);
                   4166:         }
1.63      www      4167:     }
1.520     raeburn  4168:     return $output;
1.63      www      4169: }
1.59      www      4170: 
1.822   ! bisitz   4171: ##############################################
        !          4172: =pod
        !          4173: 
        !          4174: =item * &head_subbox()
        !          4175: 
        !          4176: Inputs: $content (contains HTML code with page functions, etc.)
        !          4177: 
        !          4178: Returns: HTML div with $content
        !          4179:          To be included in page header
        !          4180: 
        !          4181: =cut
        !          4182: 
        !          4183: sub head_subbox {
        !          4184:     my ($content)=@_;
        !          4185:     my $output =
        !          4186:         '<div id="LC_head_subbox2">' #FIXME: solve conflicts with lonhtmlcommon:breadcrumbs LC_head_subbox
        !          4187:        .$content
        !          4188:        .'</div>'
        !          4189: }
        !          4190: 
        !          4191: ##############################################
        !          4192: =pod
        !          4193: 
        !          4194: =item * &CSTR_pageheader()
        !          4195: 
        !          4196: Inputs: ./.
        !          4197: 
        !          4198: Returns: HTML div with CSTR path and recent box
        !          4199:          To be included on Construction Space pages
        !          4200: 
        !          4201: =cut
        !          4202: 
        !          4203: sub CSTR_pageheader {
        !          4204:     # this is for resources; directories have customtitle, and crumbs
        !          4205:             # and select recent are created in lonpubdir.pm  
        !          4206:     my ($uname,$thisdisfn)=
        !          4207:         ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
        !          4208:     my $formaction='/priv/'.$uname.'/'.$thisdisfn;
        !          4209:     $formaction=~s/\/+/\//g;
        !          4210: 
        !          4211:     my $parentpath = '';
        !          4212:     my $lastitem = '';
        !          4213:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
        !          4214:         $parentpath = $1;
        !          4215:         $lastitem = $2;
        !          4216:     } else {
        !          4217:         $lastitem = $thisdisfn;
        !          4218:     }
        !          4219:     return
        !          4220:          '<div>'
        !          4221:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
        !          4222:         .'<b>'.&mt('Construction Space:').'</b> '
        !          4223:         .'<form name="dirs" method="post" action="'.$formaction
        !          4224:         .'" target="_top"><tt><b>' #FIXME lonpubdir: target="_parent"
        !          4225:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."$lastitem</b></tt><br />"
        !          4226:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
        !          4227:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
        !          4228:         .'</form>'
        !          4229:         .&Apache::lonmenu::constspaceform()
        !          4230:         .'</div>';
        !          4231: }
        !          4232: 
1.60      matthew  4233: ###############################################
                   4234: ###############################################
                   4235: 
                   4236: =pod
                   4237: 
1.112     bowersj2 4238: =back
                   4239: 
1.549     albertel 4240: =head1 HTML Helpers
1.112     bowersj2 4241: 
                   4242: =over 4
                   4243: 
                   4244: =item * &bodytag()
1.60      matthew  4245: 
                   4246: Returns a uniform header for LON-CAPA web pages.
                   4247: 
                   4248: Inputs: 
                   4249: 
1.112     bowersj2 4250: =over 4
                   4251: 
                   4252: =item * $title, A title to be displayed on the page.
                   4253: 
                   4254: =item * $function, the current role (can be undef).
                   4255: 
                   4256: =item * $addentries, extra parameters for the <body> tag.
                   4257: 
                   4258: =item * $bodyonly, if defined, only return the <body> tag.
                   4259: 
                   4260: =item * $domain, if defined, force a given domain.
                   4261: 
                   4262: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4263:             text interface only)
1.60      matthew  4264: 
1.326     albertel 4265: =item * $customtitle, alternate text to use instead of $title
                   4266:                       in the title box that appears, this text
                   4267:                       is not auto translated like the $title is
1.309     albertel 4268: 
1.814     bisitz   4269: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4270:                      navigational links
1.317     albertel 4271: 
1.338     albertel 4272: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4273: 
1.361     albertel 4274: =item * $no_inline_link, if true and in remote mode, don't show the 
                   4275:          'Switch To Inline Menu' link
                   4276: 
1.460     albertel 4277: =item * $args, optional argument valid values are
                   4278:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4279:             inherit_jsmath -> when creating popup window in a page,
                   4280:                               should it have jsmath forced on by the
                   4281:                               current page
1.460     albertel 4282: 
1.112     bowersj2 4283: =back
                   4284: 
1.60      matthew  4285: Returns: A uniform header for LON-CAPA web pages.  
                   4286: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4287: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4288: other decorations will be returned.
                   4289: 
                   4290: =cut
                   4291: 
1.54      www      4292: sub bodytag {
1.309     albertel 4293:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.816     bisitz   4294:         $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339     albertel 4295: 
1.460     albertel 4296:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4297: 
1.183     matthew  4298:     $function = &get_users_function() if (!$function);
1.339     albertel 4299:     my $img =    &designparm($function.'.img',$domain);
                   4300:     my $font =   &designparm($function.'.font',$domain);
                   4301:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4302: 
1.803     bisitz   4303:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4304: 		   'bgcolor' => $pgbg,
1.339     albertel 4305: 		   'text'    => $font,
                   4306:                    'alink'   => &designparm($function.'.alink',$domain),
                   4307: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4308: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4309:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4310: 
1.63      www      4311:  # role and realm
1.378     raeburn  4312:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4313:     if ($role  eq 'ca') {
1.479     albertel 4314:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4315:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4316:     } 
1.55      www      4317: # realm
1.258     albertel 4318:     if ($env{'request.course.id'}) {
1.378     raeburn  4319:         if ($env{'request.role'} !~ /^cr/) {
                   4320:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4321:         }
1.359     albertel 4322: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4323:     } else {
                   4324:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4325:     }
1.433     albertel 4326: 
1.359     albertel 4327:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      4328: # Set messages
1.60      matthew  4329:     my $messages=&domainlogo($domain);
1.330     albertel 4330: 
1.438     albertel 4331:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4332: 
1.101     www      4333: # construct main body tag
1.359     albertel 4334:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4335: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4336: 
1.530     albertel 4337:     if ($bodyonly) {
1.60      matthew  4338:         return $bodytag;
1.798     tempelho 4339:     } 
1.359     albertel 4340: 
1.410     albertel 4341:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433     albertel 4342:     if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   4343: 	undef($role);
1.434     albertel 4344:     } else {
                   4345: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4346:     }
1.359     albertel 4347:     
                   4348:     my $roleinfo=(<<ENDROLE);
                   4349: <td class="LC_title_bar_who">
                   4350: <div class="LC_title_bar_name">
1.410     albertel 4351:     $name
1.361     albertel 4352:     &nbsp;
1.359     albertel 4353: </div>
                   4354: <div class="LC_title_bar_role">
1.361     albertel 4355: $role&nbsp;
1.359     albertel 4356: </div>
                   4357: <div class="LC_title_bar_realm">
1.361     albertel 4358: $realm&nbsp;
1.359     albertel 4359: </div>
1.206     albertel 4360: </td>
                   4361: ENDROLE
1.235     raeburn  4362: 
1.762     bisitz   4363:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4364:     if ($customtitle) {
                   4365:         $titleinfo = $customtitle;
                   4366:     }
                   4367:     #
                   4368:     # Extra info if you are the DC
                   4369:     my $dc_info = '';
                   4370:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4371:                         $env{'course.'.$env{'request.course.id'}.
                   4372:                                  '.domain'}.'/'})) {
                   4373:         my $cid = $env{'request.course.id'};
                   4374:         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4375:         $dc_info =~ s/\s+$//;
1.359     albertel 4376:         $dc_info = '('.$dc_info.')';
                   4377:     }
                   4378: 
1.644     www      4379:     if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359     albertel 4380:         # No Remote
1.258     albertel 4381: 	if ($env{'request.state'} eq 'construct') {
1.359     albertel 4382: 	    $forcereg=1;
                   4383: 	}
                   4384: 
1.822   ! bisitz   4385:     if (!$customtitle && $env{'request.state'} eq 'construct') {
        !          4386:         $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
        !          4387:     }
1.359     albertel 4388: 
1.816     bisitz   4389:         my $titletable = '<table id="LC_title_bar">'
                   4390:                         ."<tr><td> $titleinfo $dc_info</td>".$roleinfo
                   4391:                         .'</tr></table>';
                   4392: 
1.814     bisitz   4393: 	if ($no_nav_bar) {
1.359     albertel 4394: 	    $bodytag .= $titletable;
                   4395: 	} else {
1.813     bisitz   4396:         $bodytag .= qq|<div id="LC_nav_bar">$name ($role)<br />
                   4397:             <em>$realm</em> $dc_info</div>|;
1.359     albertel 4398: 	    if ($env{'request.state'} eq 'construct') {
1.337     albertel 4399:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
                   4400: 							  $titletable);
1.272     raeburn  4401:             } else {
1.336     albertel 4402:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359     albertel 4403: 		    $titletable;
1.272     raeburn  4404:             }
1.235     raeburn  4405:         }
                   4406:         return $bodytag;
1.94      www      4407:     }
1.95      www      4408: 
1.93      www      4409: #
1.95      www      4410: # Top frame rendering, Remote is up
1.93      www      4411: #
1.359     albertel 4412: 
1.517     raeburn  4413:     my $imgsrc = $img;
                   4414:     if ($img =~ /^\/adm/) {
1.575     albertel 4415:         $imgsrc = &lonhttpdurl($img);
1.517     raeburn  4416:     }
                   4417:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359     albertel 4418: 
1.305     www      4419:     # Explicit link to get inline menu
1.361     albertel 4420:     my $menu= ($no_inline_link?''
                   4421: 	       :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245     matthew  4422:     #
1.94      www      4423:     return(<<ENDBODY);
1.60      matthew  4424: $bodytag
1.359     albertel 4425: <table id="LC_title_bar" class="LC_with_remote">
1.791     tempelho 4426: <tr><td>$upperleft</td>
                   4427:     <td>$messages&nbsp;</td>
1.54      www      4428: </tr>
1.359     albertel 4429: <tr><td>$titleinfo $dc_info $menu</td>
                   4430: $roleinfo
1.368     albertel 4431: </tr>
1.356     albertel 4432: </table>
1.54      www      4433: ENDBODY
1.182     matthew  4434: }
                   4435: 
1.330     albertel 4436: sub make_attr_string {
                   4437:     my ($register,$attr_ref) = @_;
                   4438: 
                   4439:     if ($attr_ref && !ref($attr_ref)) {
                   4440: 	die("addentries Must be a hash ref ".
                   4441: 	    join(':',caller(1))." ".
                   4442: 	    join(':',caller(0))." ");
                   4443:     }
                   4444: 
                   4445:     if ($register) {
1.339     albertel 4446: 	my ($on_load,$on_unload);
                   4447: 	foreach my $key (keys(%{$attr_ref})) {
                   4448: 	    if      (lc($key) eq 'onload') {
                   4449: 		$on_load.=$attr_ref->{$key}.';';
                   4450: 		delete($attr_ref->{$key});
                   4451: 
                   4452: 	    } elsif (lc($key) eq 'onunload') {
                   4453: 		$on_unload.=$attr_ref->{$key}.';';
                   4454: 		delete($attr_ref->{$key});
                   4455: 	    }
                   4456: 	}
                   4457: 	$attr_ref->{'onload'}  =
                   4458: 	    &Apache::lonmenu::loadevents().  $on_load;
                   4459: 	$attr_ref->{'onunload'}=
                   4460: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   4461:     }
                   4462: 
                   4463: # Accessibility font enhance
                   4464:     if ($env{'browser.fontenhance'} eq 'on') {
                   4465: 	my $style;
                   4466: 	foreach my $key (keys(%{$attr_ref})) {
                   4467: 	    if (lc($key) eq 'style') {
                   4468: 		$style.=$attr_ref->{$key}.';';
                   4469: 		delete($attr_ref->{$key});
                   4470: 	    }
                   4471: 	}
                   4472: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 4473:     }
1.339     albertel 4474: 
1.330     albertel 4475:     my $attr_string;
                   4476:     foreach my $attr (keys(%$attr_ref)) {
                   4477: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4478:     }
                   4479:     return $attr_string;
                   4480: }
                   4481: 
                   4482: 
1.182     matthew  4483: ###############################################
1.251     albertel 4484: ###############################################
                   4485: 
                   4486: =pod
                   4487: 
                   4488: =item * &endbodytag()
                   4489: 
                   4490: Returns a uniform footer for LON-CAPA web pages.
                   4491: 
1.635     raeburn  4492: Inputs: 1 - optional reference to an args hash
                   4493: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4494: a 'Continue' link is not displayed if the page contains an
                   4495: internal redirect in the <head></head> section,
                   4496: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4497: 
                   4498: =cut
                   4499: 
                   4500: sub endbodytag {
1.635     raeburn  4501:     my ($args) = @_;
1.251     albertel 4502:     my $endbodytag='</body>';
1.269     albertel 4503:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4504:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4505:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4506: 	    $endbodytag=
                   4507: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4508: 	        &mt('Continue').'</a>'.
                   4509: 	        $endbodytag;
                   4510:         }
1.315     albertel 4511:     }
1.251     albertel 4512:     return $endbodytag;
                   4513: }
                   4514: 
1.352     albertel 4515: =pod
                   4516: 
                   4517: =item * &standard_css()
                   4518: 
                   4519: Returns a style sheet
                   4520: 
                   4521: Inputs: (all optional)
                   4522:             domain         -> force to color decorate a page for a specific
                   4523:                                domain
                   4524:             function       -> force usage of a specific rolish color scheme
                   4525:             bgcolor        -> override the default page bgcolor
                   4526: 
                   4527: =cut
                   4528: 
1.343     albertel 4529: sub standard_css {
1.345     albertel 4530:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4531:     $function  = &get_users_function() if (!$function);
                   4532:     my $img    = &designparm($function.'.img',   $domain);
                   4533:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4534:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4535:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4536: #second colour for later usage
1.345     albertel 4537:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4538:     my $pgbg_or_bgcolor =
                   4539: 	         $bgcolor ||
1.352     albertel 4540: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4541:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4542:     my $alink  = &designparm($function.'.alink', $domain);
                   4543:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4544:     my $link   = &designparm($function.'.link',  $domain);
                   4545: 
1.704     muellerd 4546:     my $loginbg = &designparm('login.sidebg',$domain);
1.712     muellerd 4547:     my $bgcol = &designparm('login.bgcol',$domain);
                   4548:     my $textcol = &designparm('login.textcol',$domain);
1.704     muellerd 4549: 
1.602     albertel 4550:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4551:     my $mono                 = 'monospace';
1.352     albertel 4552:     my $data_table_head      = $tabbg;
                   4553:     my $data_table_light     = '#EEEEEE';
1.470     banghart 4554:     my $data_table_dark      = '#DDDDDD';
                   4555:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4556:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4557:     my $mail_new             = '#FFBB77';
                   4558:     my $mail_new_hover       = '#DD9955';
                   4559:     my $mail_read            = '#BBBB77';
                   4560:     my $mail_read_hover      = '#999944';
                   4561:     my $mail_replied         = '#AAAA88';
                   4562:     my $mail_replied_hover   = '#888855';
                   4563:     my $mail_other           = '#99BBBB';
                   4564:     my $mail_other_hover     = '#669999';
1.391     albertel 4565:     my $table_header         = '#DDDDDD';
1.489     raeburn  4566:     my $feedback_link_bg     = '#BBBBBB';
1.701     harmsja  4567:     my $lg_border_color	     = '#C8C8C8';
1.392     albertel 4568: 
1.608     albertel 4569:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.803     bisitz   4570: 		  $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   4571: 	                                                 : '0 3px 0 4px';
1.448     albertel 4572: 
1.523     albertel 4573: 
1.343     albertel 4574:     return <<END;
1.795     www      4575: body {
                   4576:    font-family: $sans;
                   4577:    line-height:130%;
                   4578:    font-size:0.83em;
                   4579:    color:$font;
                   4580: }
                   4581: 
                   4582: a:link, a:visited { 
                   4583:   font-size:100%; 
                   4584: }
                   4585: 
                   4586: a:focus { 
                   4587:   color: red;
                   4588:   background: yellow 
                   4589: }
1.698     harmsja  4590: 
1.795     www      4591: form, .inline { 
                   4592:    display: inline; 
                   4593: }
1.721     harmsja  4594: 
1.795     www      4595: .LC_right {
                   4596:    text-align:right;
                   4597: }
                   4598: 
                   4599: .LC_middle {
                   4600:    vertical-align:middle;
                   4601: }
1.721     harmsja  4602: 
                   4603: /* just for tests */
1.754     droeschl 4604: .LC_400Box {width:400px; }
1.721     harmsja  4605: /* end */
                   4606: 
1.778     bisitz   4607: .LC_filename {
                   4608:   font-family: $mono;
                   4609:   white-space:pre;
                   4610: }
                   4611: 
                   4612: .LC_fileicon {
                   4613:   border: none;
                   4614:   height: 1.3em;
                   4615:   vertical-align: text-bottom;
                   4616:   margin-right: 0.3em;
                   4617:   text-decoration:none;
                   4618: }
                   4619: 
1.350     albertel 4620: .LC_error {
                   4621:   color: red;
                   4622:   font-size: larger;
                   4623: }
1.795     www      4624: 
1.457     albertel 4625: .LC_warning,
                   4626: .LC_diff_removed {
1.733     bisitz   4627:   color: red;
1.394     albertel 4628: }
1.532     albertel 4629: 
                   4630: .LC_info,
1.457     albertel 4631: .LC_success,
                   4632: .LC_diff_added {
1.350     albertel 4633:   color: green;
                   4634: }
1.795     www      4635: 
1.802     bisitz   4636: div.LC_confirm_box {
                   4637:   background-color: #FAFAFA;
                   4638:   border: 1px solid $lg_border_color;
                   4639:   margin-right: 0;
                   4640:   padding: 5px;
                   4641: }
                   4642: 
                   4643: div.LC_confirm_box .LC_error img,
                   4644: div.LC_confirm_box .LC_success img {
                   4645:   vertical-align: middle;
                   4646: }
                   4647: 
1.440     albertel 4648: .LC_icon {
1.771     droeschl 4649:   border: none;
1.790     droeschl 4650:   vertical-align: middle;
1.771     droeschl 4651: }
                   4652: 
1.543     albertel 4653: .LC_docs_spacer {
                   4654:   width: 25px;
                   4655:   height: 1px;
1.771     droeschl 4656:   border: none;
1.543     albertel 4657: }
1.346     albertel 4658: 
1.532     albertel 4659: .LC_internal_info {
1.735     bisitz   4660:   color: #999999;
1.532     albertel 4661: }
                   4662: 
1.794     www      4663: .LC_discussion {
                   4664:    background: $tabbg;
                   4665:    border: 1px solid black;
                   4666:    margin: 2px;
                   4667: }
                   4668: 
                   4669: .LC_disc_action_links_bar {
                   4670:    background: $tabbg;
                   4671:    font-family: $sans;
1.803     bisitz   4672:    border: none;
1.795     www      4673:    margin: 4px;
1.794     www      4674: }
                   4675: 
                   4676: .LC_disc_action_left {
                   4677:    text-align: left;
                   4678: }
                   4679: 
                   4680: .LC_disc_action_right {
                   4681:    text-align: right;
                   4682: }
                   4683: 
                   4684: .LC_disc_new_item {
                   4685:    background: white;
                   4686:    border: 2px solid red;
                   4687:    margin: 2px;
                   4688: }
                   4689: 
                   4690: .LC_disc_old_item {
                   4691:    background: white;
                   4692:    border: 1px solid black;
                   4693:    margin: 2px;
                   4694: }
                   4695: 
1.458     albertel 4696: table.LC_pastsubmission {
                   4697:   border: 1px solid black;
                   4698:   margin: 2px;
                   4699: }
                   4700: 
1.795     www      4701: table#LC_top_nav,
                   4702: table#LC_menubuttons,
                   4703: table#LC_nav_location {
1.345     albertel 4704:   width: 100%;
                   4705:   background: $pgbg;
1.392     albertel 4706:   border: 2px;
1.402     albertel 4707:   border-collapse: separate;
1.803     bisitz   4708:   padding: 0;
1.345     albertel 4709: }
1.392     albertel 4710: 
1.801     tempelho 4711: table#LC_title_bar a {
                   4712:   color: $fontmenu;
                   4713: }
1.808     droeschl 4714:     
1.807     droeschl 4715: table#LC_title_bar {
1.819     tempelho 4716:   clear: both;
1.807     droeschl 4717:   /*display: none;*/
                   4718: }
                   4719: 
1.795     www      4720: table#LC_title_bar,
                   4721: table.LC_breadcrumbs,
1.393     albertel 4722: table#LC_title_bar.LC_with_remote {
1.359     albertel 4723:   width: 100%;
1.392     albertel 4724:   border-color: $pgbg;
                   4725:   border-style: solid;
                   4726:   border-width: $border;
1.379     albertel 4727:   background: $pgbg;
1.801     tempelho 4728:   color: $fontmenu;
1.379     albertel 4729:   font-family: $sans;
1.392     albertel 4730:   border-collapse: collapse;
1.803     bisitz   4731:   padding: 0;
1.819     tempelho 4732:   margin: 0;
1.359     albertel 4733: }
1.795     www      4734: 
1.409     albertel 4735: table.LC_docs_path {
                   4736:   width: 100%;
                   4737:   border: 0;
                   4738:   background: $pgbg;
                   4739:   font-family: $sans;
                   4740:   border-collapse: collapse;
1.803     bisitz   4741:   padding: 0;
1.409     albertel 4742: }
                   4743: 
1.359     albertel 4744: table#LC_title_bar td {
                   4745:   background: $tabbg;
                   4746: }
1.795     www      4747: 
1.773     ehlerst  4748: table#LC_title_bar .LC_title_bar_who {
1.359     albertel 4749:   background: $tabbg;
1.801     tempelho 4750:   color: $fontmenu;
1.427     albertel 4751:   font: small $sans;
1.359     albertel 4752:   text-align: right;
1.803     bisitz   4753:   margin: 0;
1.773     ehlerst  4754: }
1.795     www      4755: 
1.819     tempelho 4756: table#LC_title_bar div.LC_title_bar_name {
1.803     bisitz   4757:   margin: 0;
1.773     ehlerst  4758: }
1.795     www      4759: 
1.819     tempelho 4760: table#LC_title_bar div.LC_title_bar_role {
1.803     bisitz   4761:   margin: 0;
1.773     ehlerst  4762: }
1.795     www      4763: 
1.819     tempelho 4764: table#LC_title_bar div.LC_title_bar_realm {
1.803     bisitz   4765:   margin: 0;
1.359     albertel 4766: }
1.795     www      4767: 
1.469     banghart 4768: span.LC_metadata {
1.795     www      4769:   font-family: $sans;
1.469     banghart 4770: }
1.359     albertel 4771: 
1.706     harmsja  4772: table#LC_menubuttons img{
1.803     bisitz   4773:   border: none;
1.346     albertel 4774: }
1.795     www      4775: 
1.345     albertel 4776: table#LC_top_nav td {
                   4777:   background: $tabbg;
1.803     bisitz   4778:   border: none;
1.407     albertel 4779:   font-size: small;
1.706     harmsja  4780:   vertical-align:top;
                   4781:   padding:2px 5px 2px 5px;
1.345     albertel 4782: }
1.795     www      4783: 
                   4784: table#LC_top_nav td a,
                   4785: div#LC_top_nav a {
1.345     albertel 4786:   color: $font;
                   4787:   font-family: $sans;
                   4788: }
1.795     www      4789: 
1.364     albertel 4790: table#LC_top_nav td.LC_top_nav_logo {
                   4791:   background: $tabbg;
1.432     albertel 4792:   text-align: left;
1.408     albertel 4793:   white-space: nowrap;
1.432     albertel 4794:   width: 31px;
1.408     albertel 4795: }
1.795     www      4796: 
1.408     albertel 4797: table#LC_top_nav td.LC_top_nav_logo img {
1.803     bisitz   4798:   border: none;
1.408     albertel 4799:   vertical-align: bottom;
1.364     albertel 4800: }
1.795     www      4801: 
1.777     tempelho 4802: table#LC_top_nav td.LC_top_nav_exit,
1.779     bisitz   4803: table#LC_top_nav td.LC_top_nav_help {
1.777     tempelho 4804:   width: 2.0em;
                   4805: }
1.795     www      4806: 
1.442     albertel 4807: table#LC_top_nav td.LC_top_nav_login {
                   4808:   width: 4.0em;
                   4809:   text-align: center;
                   4810: }
1.795     www      4811: 
                   4812: table.LC_breadcrumbs td,
                   4813: table.LC_docs_path td  {
1.357     albertel 4814:   background: $tabbg;
1.801     tempelho 4815:   color: $fontmenu;
1.357     albertel 4816:   font-family: $sans;
1.358     albertel 4817:   font-size: smaller;
1.357     albertel 4818: }
1.795     www      4819: 
1.777     tempelho 4820: table.LC_breadcrumbs td.LC_breadcrumbs_component,
                   4821: table.LC_docs_path td.LC_docs_path_component {
1.779     bisitz   4822:   background: $tabbg;
1.801     tempelho 4823:   color: $fontmenu;
1.777     tempelho 4824:   font-family: $sans;
1.779     bisitz   4825:   font-size: larger;
                   4826:   text-align: right;
1.777     tempelho 4827: }
1.795     www      4828: 
1.383     albertel 4829: td.LC_table_cell_checkbox {
                   4830:   text-align: center;
                   4831: }
1.795     www      4832: 
1.779     bisitz   4833: table#LC_mainmenu td.LC_mainmenu_column {
                   4834:     vertical-align: top;
1.777     tempelho 4835: }
1.522     albertel 4836: 
1.795     www      4837: .LC_fontsize_small {
1.705     tempelho 4838:  font-size: 70%;
                   4839: }
                   4840: 
1.819     tempelho 4841: #LC_head_subbox {
                   4842:  clear:both;
                   4843:  background: $sidebg;
1.822   ! bisitz   4844:  border-bottom: 1px solid $lg_border_color;
1.819     tempelho 4845:  height: 32px;
                   4846:  line-height: 32px; 
1.822   ! bisitz   4847:  margin: 0;
1.819     tempelho 4848:  padding: 0;
                   4849: }
                   4850: 
1.822   ! bisitz   4851: #LC_head_subbox2 { /* FIXME: replace by LC_head_subbox once lonhtmlcommon::breadcrumbs has been fixed */
        !          4852:  clear:both;
        !          4853:  background: #F8F8F8; /* $sidebg; */
        !          4854:  border-bottom: 1px solid $lg_border_color;
        !          4855:  margin: 0 0 10px 0;
        !          4856:  padding: 5px;
        !          4857: }
        !          4858: 
1.795     www      4859: .LC_fontsize_medium {
1.705     tempelho 4860:  font-size: 85%;
                   4861: }
                   4862: 
1.795     www      4863: .LC_fontsize_large {
1.705     tempelho 4864:  font-size: 120%;
                   4865: }
                   4866: 
1.346     albertel 4867: .LC_menubuttons_inline_text {
                   4868:   color: $font;
                   4869:   font-family: $sans;
1.698     harmsja  4870:   font-size: 90%;
1.701     harmsja  4871:   padding-left:3px;
1.346     albertel 4872: }
                   4873: 
1.526     www      4874: .LC_menubuttons_link {
                   4875:   text-decoration: none;
                   4876: }
1.795     www      4877: 
1.522     albertel 4878: .LC_menubuttons_category {
1.521     www      4879:   color: $font;
1.526     www      4880:   background: $pgbg;
1.521     www      4881:   font-family: $sans;
                   4882:   font-size: larger;
                   4883:   font-weight: bold;
                   4884: }
                   4885: 
1.346     albertel 4886: td.LC_menubuttons_text {
1.779     bisitz   4887:  	color: $font;
1.346     albertel 4888: }
1.706     harmsja  4889: 
1.346     albertel 4890: .LC_current_location {
                   4891:   font-family: $sans;
                   4892:   background: $tabbg;
                   4893: }
1.795     www      4894: 
1.346     albertel 4895: .LC_new_mail {
                   4896:   font-family: $sans;
1.634     www      4897:   background: $tabbg;
1.346     albertel 4898:   font-weight: bold;
                   4899: }
1.347     albertel 4900: 
1.527     www      4901: .LC_preferences_labeltext {
                   4902:   font-family: $sans;
                   4903:   text-align: right;
                   4904: }
                   4905: 
1.666     raeburn  4906: .LC_roleslog_note {
1.701     harmsja  4907:   font-size: small;
1.666     raeburn  4908: }
                   4909: 
1.715     raeburn  4910: .LC_mail_functions {
                   4911:     font-weight: bold;
                   4912: }
                   4913: 
1.795     www      4914: table.LC_data_table,
                   4915: table.LC_mail_list {
1.347     albertel 4916:   border: 1px solid #000000;
1.402     albertel 4917:   border-collapse: separate;
1.426     albertel 4918:   border-spacing: 1px;
1.610     albertel 4919:   background: $pgbg;
1.347     albertel 4920: }
1.795     www      4921: 
1.422     albertel 4922: .LC_data_table_dense {
                   4923:   font-size: small;
                   4924: }
1.795     www      4925: 
1.507     raeburn  4926: table.LC_nested_outer {
                   4927:   border: 1px solid #000000;
1.589     raeburn  4928:   border-collapse: collapse;
1.803     bisitz   4929:   border-spacing: 0;
1.507     raeburn  4930:   width: 100%;
                   4931: }
1.795     www      4932: 
1.507     raeburn  4933: table.LC_nested {
1.803     bisitz   4934:   border: none;
1.589     raeburn  4935:   border-collapse: collapse;
1.803     bisitz   4936:   border-spacing: 0;
1.507     raeburn  4937:   width: 100%;
                   4938: }
1.795     www      4939: 
                   4940: table.LC_data_table tr th, 
                   4941: table.LC_calendar tr th, 
                   4942: table.LC_mail_list tr th,
1.523     albertel 4943: table.LC_prior_tries tr th {
1.349     albertel 4944:   font-weight: bold;
                   4945:   background-color: $data_table_head;
1.801     tempelho 4946:   color:$fontmenu;
1.701     harmsja  4947:   font-size:90%;
1.347     albertel 4948: }
1.795     www      4949: 
1.711     raeburn  4950: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   4951:   background-color: #CCCCCC;
1.711     raeburn  4952:   font-weight: bold;
                   4953:   text-align: left;
                   4954: }
1.795     www      4955: 
1.779     bisitz   4956: table.LC_data_table tr.LC_odd_row > td,
1.809     bisitz   4957: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 4958:   background-color: $data_table_light;
1.425     albertel 4959:   padding: 2px;
1.347     albertel 4960: }
1.795     www      4961: 
1.610     albertel 4962: table.LC_data_table tr.LC_even_row > td,
1.809     bisitz   4963: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 4964:   background-color: $data_table_dark;
1.709     bisitz   4965:   padding: 2px;
1.347     albertel 4966: }
1.795     www      4967: 
1.425     albertel 4968: table.LC_data_table tr.LC_data_table_highlight td {
                   4969:   background-color: $data_table_darker;
                   4970: }
1.795     www      4971: 
1.639     raeburn  4972: table.LC_data_table tr td.LC_leftcol_header {
                   4973:   background-color: $data_table_head;
                   4974:   font-weight: bold;
                   4975: }
1.795     www      4976: 
1.451     albertel 4977: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  4978: table.LC_nested tr.LC_empty_row td {
1.347     albertel 4979:   background-color: #FFFFFF;
1.421     albertel 4980:   font-weight: bold;
                   4981:   font-style: italic;
                   4982:   text-align: center;
                   4983:   padding: 8px;
1.347     albertel 4984: }
1.795     www      4985: 
1.507     raeburn  4986: table.LC_nested tr.LC_empty_row td {
1.465     albertel 4987:   padding: 4ex
                   4988: }
1.795     www      4989: 
1.507     raeburn  4990: table.LC_nested_outer tr th {
                   4991:   font-weight: bold;
1.801     tempelho 4992:   color:$fontmenu;
1.507     raeburn  4993:   background-color: $data_table_head;
1.701     harmsja  4994:   font-size: small;
1.507     raeburn  4995:   border-bottom: 1px solid #000000;
                   4996: }
1.795     www      4997: 
1.507     raeburn  4998: table.LC_nested_outer tr td.LC_subheader {
                   4999:   background-color: $data_table_head;
                   5000:   font-weight: bold;
                   5001:   font-size: small;
                   5002:   border-bottom: 1px solid #000000;
                   5003:   text-align: right;
1.451     albertel 5004: }
1.795     www      5005: 
1.507     raeburn  5006: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5007:   background-color: #CCCCCC;
1.451     albertel 5008:   font-weight: bold;
                   5009:   font-size: small;
1.507     raeburn  5010:   text-align: center;
                   5011: }
1.795     www      5012: 
1.589     raeburn  5013: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5014: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5015:   text-align: left;
1.451     albertel 5016: }
1.795     www      5017: 
1.507     raeburn  5018: table.LC_nested td {
1.735     bisitz   5019:   background-color: #FFFFFF;
1.451     albertel 5020:   font-size: small;
1.507     raeburn  5021: }
1.795     www      5022: 
1.507     raeburn  5023: table.LC_nested_outer tr th.LC_right_item,
                   5024: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5025: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5026: table.LC_nested tr td.LC_right_item {
1.451     albertel 5027:   text-align: right;
                   5028: }
                   5029: 
1.507     raeburn  5030: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5031:   background-color: #EEEEEE;
1.451     albertel 5032: }
                   5033: 
1.473     raeburn  5034: table.LC_createuser {
                   5035: }
                   5036: 
                   5037: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5038:   font-size: small;
1.473     raeburn  5039: }
                   5040: 
                   5041: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5042:   background-color: #CCCCCC;
1.473     raeburn  5043:   font-weight: bold;
                   5044:   text-align: center;
                   5045: }
                   5046: 
1.349     albertel 5047: table.LC_calendar {
                   5048:   border: 1px solid #000000;
                   5049:   border-collapse: collapse;
                   5050: }
1.795     www      5051: 
1.349     albertel 5052: table.LC_calendar_pickdate {
                   5053:   font-size: xx-small;
                   5054: }
1.795     www      5055: 
1.349     albertel 5056: table.LC_calendar tr td {
                   5057:   border: 1px solid #000000;
                   5058:   vertical-align: top;
                   5059: }
1.795     www      5060: 
1.349     albertel 5061: table.LC_calendar tr td.LC_calendar_day_empty {
                   5062:   background-color: $data_table_dark;
                   5063: }
1.795     www      5064: 
1.779     bisitz   5065: table.LC_calendar tr td.LC_calendar_day_current {
                   5066:   background-color: $data_table_highlight;
1.777     tempelho 5067: }
1.795     www      5068: 
1.349     albertel 5069: table.LC_mail_list tr.LC_mail_new {
                   5070:   background-color: $mail_new;
                   5071: }
1.795     www      5072: 
1.349     albertel 5073: table.LC_mail_list tr.LC_mail_new:hover {
                   5074:   background-color: $mail_new_hover;
                   5075: }
1.795     www      5076: 
                   5077: table.LC_mail_list tr.LC_mail_even {
1.777     tempelho 5078: }
1.795     www      5079: 
                   5080: table.LC_mail_list tr.LC_mail_odd {
1.777     tempelho 5081: }
1.795     www      5082: 
1.349     albertel 5083: table.LC_mail_list tr.LC_mail_read {
                   5084:   background-color: $mail_read;
                   5085: }
1.795     www      5086: 
1.349     albertel 5087: table.LC_mail_list tr.LC_mail_read:hover {
                   5088:   background-color: $mail_read_hover;
                   5089: }
1.795     www      5090: 
1.349     albertel 5091: table.LC_mail_list tr.LC_mail_replied {
                   5092:   background-color: $mail_replied;
                   5093: }
1.795     www      5094: 
1.349     albertel 5095: table.LC_mail_list tr.LC_mail_replied:hover {
                   5096:   background-color: $mail_replied_hover;
                   5097: }
1.795     www      5098: 
1.349     albertel 5099: table.LC_mail_list tr.LC_mail_other {
                   5100:   background-color: $mail_other;
                   5101: }
1.795     www      5102: 
1.349     albertel 5103: table.LC_mail_list tr.LC_mail_other:hover {
                   5104:   background-color: $mail_other_hover;
                   5105: }
1.494     raeburn  5106: 
1.777     tempelho 5107: table.LC_data_table tr > td.LC_browser_file,
                   5108: table.LC_data_table tr > td.LC_browser_file_published {
1.389     albertel 5109:   background: #CCFF88;
                   5110: }
1.795     www      5111: 
1.777     tempelho 5112: table.LC_data_table tr > td.LC_browser_file_locked,
                   5113: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5114:   background: #FFAA99;
1.387     albertel 5115: }
1.795     www      5116: 
1.777     tempelho 5117: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.779     bisitz   5118:   background: #AAAAAA;
                   5119: }
1.795     www      5120: 
1.777     tempelho 5121: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5122: table.LC_data_table tr > td.LC_browser_file_metamodified {
                   5123:   background: #FFFF77;
1.777     tempelho 5124: }
1.795     www      5125: 
1.696     bisitz   5126: table.LC_data_table tr.LC_browser_folder > td {
1.389     albertel 5127:   background: #CCCCFF;
1.387     albertel 5128: }
1.696     bisitz   5129: 
1.707     bisitz   5130: table.LC_data_table tr > td.LC_roles_is {
                   5131: /*  background: #77FF77; */
                   5132: }
1.795     www      5133: 
1.707     bisitz   5134: table.LC_data_table tr > td.LC_roles_future {
                   5135:   background: #FFFF77;
                   5136: }
1.795     www      5137: 
1.707     bisitz   5138: table.LC_data_table tr > td.LC_roles_will {
                   5139:   background: #FFAA77;
                   5140: }
1.795     www      5141: 
1.707     bisitz   5142: table.LC_data_table tr > td.LC_roles_expired {
                   5143:   background: #FF7777;
                   5144: }
1.795     www      5145: 
1.707     bisitz   5146: table.LC_data_table tr > td.LC_roles_will_not {
                   5147:   background: #AAFF77;
                   5148: }
1.795     www      5149: 
1.707     bisitz   5150: table.LC_data_table tr > td.LC_roles_selected {
                   5151:   background: #11CC55;
                   5152: }
                   5153: 
1.388     albertel 5154: span.LC_current_location {
1.701     harmsja  5155:   font-size:larger;
1.388     albertel 5156:   background: $pgbg;
                   5157: }
1.387     albertel 5158: 
1.395     albertel 5159: span.LC_parm_menu_item {
                   5160:   font-size: larger;
                   5161:   font-family: $sans;
                   5162: }
1.795     www      5163: 
1.395     albertel 5164: span.LC_parm_scope_all {
                   5165:   color: red;
                   5166: }
1.795     www      5167: 
1.395     albertel 5168: span.LC_parm_scope_folder {
                   5169:   color: green;
                   5170: }
1.795     www      5171: 
1.395     albertel 5172: span.LC_parm_scope_resource {
                   5173:   color: orange;
                   5174: }
1.795     www      5175: 
1.395     albertel 5176: span.LC_parm_part {
                   5177:   color: blue;
                   5178: }
1.795     www      5179: 
1.395     albertel 5180: span.LC_parm_folder, span.LC_parm_symb {
                   5181:   font-size: x-small;
                   5182:   font-family: $mono;
                   5183:   color: #AAAAAA;
                   5184: }
                   5185: 
1.795     www      5186: td.LC_parm_overview_level_menu,
                   5187: td.LC_parm_overview_map_menu,
                   5188: td.LC_parm_overview_parm_selectors,
                   5189: td.LC_parm_overview_restrictions  {
1.396     albertel 5190:   border: 1px solid black;
                   5191:   border-collapse: collapse;
                   5192: }
1.795     www      5193: 
1.396     albertel 5194: table.LC_parm_overview_restrictions td {
                   5195:   border-width: 1px 4px 1px 4px;
                   5196:   border-style: solid;
                   5197:   border-color: $pgbg;
                   5198:   text-align: center;
                   5199: }
1.795     www      5200: 
1.396     albertel 5201: table.LC_parm_overview_restrictions th {
                   5202:   background: $tabbg;
                   5203:   border-width: 1px 4px 1px 4px;
                   5204:   border-style: solid;
                   5205:   border-color: $pgbg;
                   5206: }
1.795     www      5207: 
1.398     albertel 5208: table#LC_helpmenu {
1.803     bisitz   5209:   border: none;
1.398     albertel 5210:   height: 55px;
1.803     bisitz   5211:   border-spacing: 0;
1.398     albertel 5212: }
                   5213: 
                   5214: table#LC_helpmenu fieldset legend {
                   5215:   font-size: larger;
                   5216:   font-weight: bold;
                   5217: }
1.795     www      5218: 
1.397     albertel 5219: table#LC_helpmenu_links {
                   5220:   width: 100%;
                   5221:   border: 1px solid black;
                   5222:   background: $pgbg;
1.803     bisitz   5223:   padding: 0;
1.397     albertel 5224:   border-spacing: 1px;
                   5225: }
1.795     www      5226: 
1.397     albertel 5227: table#LC_helpmenu_links tr td {
                   5228:   padding: 1px;
                   5229:   background: $tabbg;
1.399     albertel 5230:   text-align: center;
                   5231:   font-weight: bold;
1.397     albertel 5232: }
1.396     albertel 5233: 
1.795     www      5234: table#LC_helpmenu_links a:link,
                   5235: table#LC_helpmenu_links a:visited,
1.397     albertel 5236: table#LC_helpmenu_links a:active {
                   5237:   text-decoration: none;
                   5238:   color: $font;
                   5239: }
1.795     www      5240: 
1.397     albertel 5241: table#LC_helpmenu_links a:hover {
                   5242:   text-decoration: underline;
                   5243:   color: $vlink;
                   5244: }
1.396     albertel 5245: 
1.417     albertel 5246: .LC_chrt_popup_exists {
                   5247:   border: 1px solid #339933;
                   5248:   margin: -1px;
                   5249: }
1.795     www      5250: 
1.417     albertel 5251: .LC_chrt_popup_up {
                   5252:   border: 1px solid yellow;
                   5253:   margin: -1px;
                   5254: }
1.795     www      5255: 
1.417     albertel 5256: .LC_chrt_popup {
                   5257:   border: 1px solid #8888FF;
                   5258:   background: #CCCCFF;
                   5259: }
1.795     www      5260: 
1.421     albertel 5261: table.LC_pick_box {
                   5262:   border-collapse: separate;
                   5263:   background: white;
                   5264:   border: 1px solid black;
                   5265:   border-spacing: 1px;
                   5266: }
1.795     www      5267: 
1.421     albertel 5268: table.LC_pick_box td.LC_pick_box_title {
                   5269:   background: $tabbg;
                   5270:   font-weight: bold;
                   5271:   text-align: right;
1.740     bisitz   5272:   vertical-align: top;
1.421     albertel 5273:   width: 184px;
                   5274:   padding: 8px;
                   5275: }
1.795     www      5276: 
1.645     raeburn  5277: table.LC_pick_box td.LC_selfenroll_pick_box_title {
                   5278:   background: $tabbg;
                   5279:   font-weight: bold;
                   5280:   text-align: right;
                   5281:   width: 350px;
                   5282:   padding: 8px;
                   5283: }
                   5284: 
1.579     raeburn  5285: table.LC_pick_box td.LC_pick_box_value {
                   5286:   text-align: left;
                   5287:   padding: 8px;
                   5288: }
1.795     www      5289: 
1.579     raeburn  5290: table.LC_pick_box td.LC_pick_box_select {
                   5291:   text-align: left;
                   5292:   padding: 8px;
                   5293: }
1.795     www      5294: 
1.424     albertel 5295: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5296:   padding: 0;
1.421     albertel 5297:   height: 1px;
                   5298:   background: black;
                   5299: }
1.795     www      5300: 
1.421     albertel 5301: table.LC_pick_box td.LC_pick_box_submit {
                   5302:   text-align: right;
                   5303: }
1.795     www      5304: 
1.579     raeburn  5305: table.LC_pick_box td.LC_evenrow_value {
                   5306:   text-align: left;
                   5307:   padding: 8px;
                   5308:   background-color: $data_table_light;
                   5309: }
1.795     www      5310: 
1.579     raeburn  5311: table.LC_pick_box td.LC_oddrow_value {
                   5312:   text-align: left;
                   5313:   padding: 8px;
                   5314:   background-color: $data_table_light;
                   5315: }
1.795     www      5316: 
1.579     raeburn  5317: table.LC_helpform_receipt {
                   5318:   width: 620px;
                   5319:   border-collapse: separate;
                   5320:   background: white;
                   5321:   border: 1px solid black;
                   5322:   border-spacing: 1px;
                   5323: }
1.795     www      5324: 
1.579     raeburn  5325: table.LC_helpform_receipt td.LC_pick_box_title {
                   5326:   background: $tabbg;
                   5327:   font-weight: bold;
                   5328:   text-align: right;
                   5329:   width: 184px;
                   5330:   padding: 8px;
                   5331: }
1.795     www      5332: 
1.579     raeburn  5333: table.LC_helpform_receipt td.LC_evenrow_value {
                   5334:   text-align: left;
                   5335:   padding: 8px;
                   5336:   background-color: $data_table_light;
                   5337: }
1.795     www      5338: 
1.579     raeburn  5339: table.LC_helpform_receipt td.LC_oddrow_value {
                   5340:   text-align: left;
                   5341:   padding: 8px;
                   5342:   background-color: $data_table_light;
                   5343: }
1.795     www      5344: 
1.579     raeburn  5345: table.LC_helpform_receipt td.LC_pick_box_separator {
1.803     bisitz   5346:   padding: 0;
1.579     raeburn  5347:   height: 1px;
                   5348:   background: black;
                   5349: }
1.795     www      5350: 
1.579     raeburn  5351: span.LC_helpform_receipt_cat {
                   5352:   font-weight: bold;
                   5353: }
1.795     www      5354: 
1.424     albertel 5355: table.LC_group_priv_box {
                   5356:   background: white;
                   5357:   border: 1px solid black;
                   5358:   border-spacing: 1px;
                   5359: }
1.795     www      5360: 
1.424     albertel 5361: table.LC_group_priv_box td.LC_pick_box_title {
                   5362:   background: $tabbg;
                   5363:   font-weight: bold;
                   5364:   text-align: right;
                   5365:   width: 184px;
                   5366: }
1.795     www      5367: 
1.424     albertel 5368: table.LC_group_priv_box td.LC_groups_fixed {
                   5369:   background: $data_table_light;
                   5370:   text-align: center;
                   5371: }
1.795     www      5372: 
1.424     albertel 5373: table.LC_group_priv_box td.LC_groups_optional {
                   5374:   background: $data_table_dark;
                   5375:   text-align: center;
                   5376: }
1.795     www      5377: 
1.424     albertel 5378: table.LC_group_priv_box td.LC_groups_functionality {
                   5379:   background: $data_table_darker;
                   5380:   text-align: center;
                   5381:   font-weight: bold;
                   5382: }
1.795     www      5383: 
1.424     albertel 5384: table.LC_group_priv td {
                   5385:   text-align: left;
1.803     bisitz   5386:   padding: 0;
1.424     albertel 5387: }
                   5388: 
1.421     albertel 5389: table.LC_notify_front_page {
                   5390:   background: white;
                   5391:   border: 1px solid black;
                   5392:   padding: 8px;
                   5393: }
1.795     www      5394: 
1.421     albertel 5395: table.LC_notify_front_page td {
                   5396:   padding: 8px;
                   5397: }
1.795     www      5398: 
1.424     albertel 5399: .LC_navbuttons {
                   5400:   margin: 2ex 0ex 2ex 0ex;
                   5401: }
1.795     www      5402: 
1.423     albertel 5403: .LC_topic_bar {
                   5404:   font-family: $sans;
                   5405:   font-weight: bold;
                   5406:   width: 100%;
                   5407:   background: $tabbg;
                   5408:   vertical-align: middle;
                   5409:   margin: 2ex 0ex 2ex 0ex;
1.805     bisitz   5410:   padding: 3px;
1.423     albertel 5411: }
1.795     www      5412: 
1.423     albertel 5413: .LC_topic_bar span {
                   5414:   vertical-align: middle;
                   5415: }
1.795     www      5416: 
1.423     albertel 5417: .LC_topic_bar img {
                   5418:   vertical-align: bottom;
                   5419: }
1.795     www      5420: 
1.423     albertel 5421: table.LC_course_group_status {
                   5422:   margin: 20px;
                   5423: }
1.795     www      5424: 
1.423     albertel 5425: table.LC_status_selector td {
                   5426:   vertical-align: top;
                   5427:   text-align: center;
1.424     albertel 5428:   padding: 4px;
                   5429: }
1.795     www      5430: 
1.599     albertel 5431: div.LC_feedback_link {
1.616     albertel 5432:   clear: both;
1.599     albertel 5433:   background: white;
1.779     bisitz   5434:   width: 100%;
1.489     raeburn  5435: }
1.795     www      5436: 
1.489     raeburn  5437: span.LC_feedback_link {
1.599     albertel 5438:   background: $feedback_link_bg;
                   5439:   font-size: larger;
                   5440: }
1.795     www      5441: 
1.599     albertel 5442: span.LC_message_link {
                   5443:   background: $feedback_link_bg;
                   5444:   font-size: larger;
                   5445:   position: absolute;
                   5446:   right: 1em;
1.489     raeburn  5447: }
1.421     albertel 5448: 
1.515     albertel 5449: table.LC_prior_tries {
1.524     albertel 5450:   border: 1px solid #000000;
                   5451:   border-collapse: separate;
                   5452:   border-spacing: 1px;
1.515     albertel 5453: }
1.523     albertel 5454: 
1.515     albertel 5455: table.LC_prior_tries td {
1.524     albertel 5456:   padding: 2px;
1.515     albertel 5457: }
1.523     albertel 5458: 
                   5459: .LC_answer_correct {
1.795     www      5460:   background: lightgreen;
                   5461:   font-family: $sans;
                   5462:   color: darkgreen;
                   5463:   padding: 6px;
1.523     albertel 5464: }
1.795     www      5465: 
1.523     albertel 5466: .LC_answer_charged_try {
1.797     www      5467:   background: #FFAAAA;
1.795     www      5468:   font-family: $sans;
                   5469:   color: darkred;
                   5470:   padding: 6px;
1.523     albertel 5471: }
1.795     www      5472: 
1.779     bisitz   5473: .LC_answer_not_charged_try,
1.523     albertel 5474: .LC_answer_no_grade,
                   5475: .LC_answer_late {
1.795     www      5476:   background: lightyellow;
                   5477:   font-family: $sans;
1.523     albertel 5478:   color: black;
1.795     www      5479:   padding: 6px;
1.523     albertel 5480: }
1.795     www      5481: 
1.523     albertel 5482: .LC_answer_previous {
1.795     www      5483:   background: lightblue;
                   5484:   font-family: $sans;
                   5485:   color: darkblue;
                   5486:   padding: 6px;
1.523     albertel 5487: }
1.795     www      5488: 
1.779     bisitz   5489: .LC_answer_no_message {
1.777     tempelho 5490:   background: #FFFFFF;
1.795     www      5491:   font-family: $sans;
1.777     tempelho 5492:   color: black;
1.795     www      5493:   padding: 6px;
1.779     bisitz   5494: }
1.795     www      5495: 
1.779     bisitz   5496: .LC_answer_unknown {
                   5497:   background: orange;
1.795     www      5498:   font-family: $sans;
1.779     bisitz   5499:   color: black;
1.795     www      5500:   padding: 6px;
1.777     tempelho 5501: }
1.795     www      5502: 
1.529     albertel 5503: span.LC_prior_numerical,
                   5504: span.LC_prior_string,
                   5505: span.LC_prior_custom,
                   5506: span.LC_prior_reaction,
                   5507: span.LC_prior_math {
1.523     albertel 5508:   font-family: monospace;
                   5509:   white-space: pre;
                   5510: }
                   5511: 
1.525     albertel 5512: span.LC_prior_string {
                   5513:   font-family: monospace;
                   5514:   white-space: pre;
                   5515: }
                   5516: 
1.523     albertel 5517: table.LC_prior_option {
                   5518:   width: 100%;
                   5519:   border-collapse: collapse;
                   5520: }
1.795     www      5521: 
                   5522: table.LC_prior_rank, 
                   5523: table.LC_prior_match {
1.528     albertel 5524:   border-collapse: collapse;
                   5525: }
1.795     www      5526: 
1.528     albertel 5527: table.LC_prior_option tr td,
                   5528: table.LC_prior_rank tr td,
                   5529: table.LC_prior_match tr td {
1.524     albertel 5530:   border: 1px solid #000000;
1.515     albertel 5531: }
                   5532: 
1.770     droeschl 5533: td.LC_nobreak,
1.519     raeburn  5534: span.LC_nobreak {
1.544     albertel 5535:   white-space: nowrap;
1.519     raeburn  5536: }
                   5537: 
1.576     raeburn  5538: span.LC_cusr_emph {
                   5539:   font-style: italic;
                   5540: }
                   5541: 
1.633     raeburn  5542: span.LC_cusr_subheading {
                   5543:   font-weight: normal;
                   5544:   font-size: 85%;
                   5545: }
                   5546: 
1.545     albertel 5547: table.LC_docs_documents {
                   5548:   background: #BBBBBB;
1.803     bisitz   5549:   border-width: 0;
1.545     albertel 5550:   border-collapse: collapse;
                   5551: }
1.795     www      5552: 
1.777     tempelho 5553: table.LC_docs_documents td.LC_docs_document {
1.779     bisitz   5554:   border: 2px solid black;
                   5555:   padding: 4px;
1.777     tempelho 5556: }
1.795     www      5557: 
1.545     albertel 5558: .LC_docs_entry_move {
1.803     bisitz   5559:   border: none;
1.545     albertel 5560:   border-collapse: collapse;
1.544     albertel 5561: }
                   5562: 
1.545     albertel 5563: .LC_docs_entry_move td {
                   5564:   border: 2px solid #BBBBBB;
                   5565:   background: #DDDDDD;
                   5566: }
                   5567: 
                   5568: .LC_docs_editor td.LC_docs_entry_commands {
                   5569:   background: #DDDDDD;
                   5570:   font-size: x-small;
                   5571: }
1.795     www      5572: 
1.544     albertel 5573: .LC_docs_copy {
1.545     albertel 5574:   color: #000099;
1.544     albertel 5575: }
1.795     www      5576: 
1.544     albertel 5577: .LC_docs_cut {
1.545     albertel 5578:   color: #550044;
1.544     albertel 5579: }
1.795     www      5580: 
1.544     albertel 5581: .LC_docs_rename {
1.545     albertel 5582:   color: #009900;
1.544     albertel 5583: }
1.795     www      5584: 
1.544     albertel 5585: .LC_docs_remove {
1.545     albertel 5586:   color: #990000;
                   5587: }
                   5588: 
1.547     albertel 5589: .LC_docs_reinit_warn,
                   5590: .LC_docs_ext_edit {
                   5591:   font-size: x-small;
                   5592: }
                   5593: 
1.545     albertel 5594: .LC_docs_editor td.LC_docs_entry_title,
                   5595: .LC_docs_editor td.LC_docs_entry_icon {
                   5596:   background: #FFFFBB;
                   5597: }
1.795     www      5598: 
1.545     albertel 5599: .LC_docs_editor td.LC_docs_entry_parameter {
                   5600:   background: #BBBBFF;
                   5601:   font-size: x-small;
                   5602:   white-space: nowrap;
                   5603: }
                   5604: 
                   5605: table.LC_docs_adddocs td,
                   5606: table.LC_docs_adddocs th {
                   5607:   border: 1px solid #BBBBBB;
                   5608:   padding: 4px;
                   5609:   background: #DDDDDD;
1.543     albertel 5610: }
                   5611: 
1.584     albertel 5612: table.LC_sty_begin {
                   5613:   background: #BBFFBB;
                   5614: }
1.795     www      5615: 
1.584     albertel 5616: table.LC_sty_end {
                   5617:   background: #FFBBBB;
                   5618: }
                   5619: 
1.589     raeburn  5620: table.LC_double_column {
1.803     bisitz   5621:   border-width: 0;
1.589     raeburn  5622:   border-collapse: collapse;
                   5623:   width: 100%;
                   5624:   padding: 2px;
                   5625: }
                   5626: 
                   5627: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5628:   top: 2px;
1.589     raeburn  5629:   left: 2px;
                   5630:   width: 47%;
                   5631:   vertical-align: top;
                   5632: }
                   5633: 
                   5634: table.LC_double_column tr td.LC_right_col {
                   5635:   top: 2px;
1.779     bisitz   5636:   right: 2px;
1.589     raeburn  5637:   width: 47%;
                   5638:   vertical-align: top;
                   5639: }
                   5640: 
1.594     raeburn  5641: span.LC_role_level {
                   5642:   font-weight: bold;
                   5643: }
                   5644: 
1.591     raeburn  5645: div.LC_left_float {
                   5646:   float: left;
                   5647:   padding-right: 5%;
1.597     albertel 5648:   padding-bottom: 4px;
1.591     raeburn  5649: }
                   5650: 
                   5651: div.LC_clear_float_header {
1.597     albertel 5652:   padding-bottom: 2px;
1.591     raeburn  5653: }
                   5654: 
                   5655: div.LC_clear_float_footer {
1.597     albertel 5656:   padding-top: 10px;
1.591     raeburn  5657:   clear: both;
                   5658: }
                   5659: 
1.597     albertel 5660: div.LC_grade_show_user {
                   5661:   margin-top: 20px;
                   5662:   border: 1px solid black;
                   5663: }
1.795     www      5664: 
1.597     albertel 5665: div.LC_grade_user_name {
                   5666:   background: #DDDDEE;
                   5667:   border-bottom: 1px solid black;
1.705     tempelho 5668:   font-weight: bold;
                   5669:   font-size: large;
1.597     albertel 5670: }
1.795     www      5671: 
1.597     albertel 5672: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5673:   background: #DDEEDD;
                   5674: }
                   5675: 
                   5676: div.LC_grade_show_problem,
                   5677: div.LC_grade_submissions,
                   5678: div.LC_grade_message_center,
                   5679: div.LC_grade_info_links,
                   5680: div.LC_grade_assign {
                   5681:   margin: 5px;
                   5682:   width: 99%;
                   5683:   background: #FFFFFF;
                   5684: }
1.795     www      5685: 
1.597     albertel 5686: div.LC_grade_show_problem_header,
                   5687: div.LC_grade_submissions_header,
                   5688: div.LC_grade_message_center_header,
                   5689: div.LC_grade_assign_header {
1.705     tempelho 5690:   font-weight: bold;
                   5691:   font-size: large;
1.597     albertel 5692: }
1.795     www      5693: 
1.597     albertel 5694: div.LC_grade_show_problem_problem,
                   5695: div.LC_grade_submissions_body,
                   5696: div.LC_grade_message_center_body,
                   5697: div.LC_grade_assign_body {
                   5698:   border: 1px solid black;
                   5699:   width: 99%;
                   5700:   background: #FFFFFF;
                   5701: }
1.795     www      5702: 
1.598     albertel 5703: span.LC_grade_check_note {
1.705     tempelho 5704:   font-weight: normal;
                   5705:   font-size: medium;
1.598     albertel 5706:   display: inline;
                   5707:   position: absolute;
                   5708:   right: 1em;
                   5709: }
1.597     albertel 5710: 
1.613     albertel 5711: table.LC_scantron_action {
                   5712:   width: 100%;
                   5713: }
1.795     www      5714: 
1.613     albertel 5715: table.LC_scantron_action tr th {
1.698     harmsja  5716:   font-weight:bold;
                   5717:   font-style:normal;
1.613     albertel 5718: }
1.795     www      5719: 
1.779     bisitz   5720: .LC_edit_problem_header,
1.614     albertel 5721: div.LC_edit_problem_footer {
1.705     tempelho 5722:   font-weight: normal;
                   5723:   font-size:  medium;
1.602     albertel 5724:   margin: 2px;
1.600     albertel 5725: }
1.795     www      5726: 
1.600     albertel 5727: div.LC_edit_problem_header,
1.602     albertel 5728: div.LC_edit_problem_header div,
1.614     albertel 5729: div.LC_edit_problem_footer,
                   5730: div.LC_edit_problem_footer div,
1.602     albertel 5731: div.LC_edit_problem_editxml_header,
                   5732: div.LC_edit_problem_editxml_header div {
1.600     albertel 5733:   margin-top: 5px;
                   5734: }
1.795     www      5735: 
1.602     albertel 5736: div.LC_edit_problem_header_edit_row {
                   5737:   background: $tabbg;
                   5738:   padding: 3px;
                   5739:   margin-bottom: 5px;
                   5740: }
1.795     www      5741: 
1.600     albertel 5742: div.LC_edit_problem_header_title {
1.705     tempelho 5743:   font-weight: bold;
                   5744:   font-size: larger;
1.602     albertel 5745:   background: $tabbg;
                   5746:   padding: 3px;
                   5747: }
1.795     www      5748: 
1.602     albertel 5749: table.LC_edit_problem_header_title {
1.705     tempelho 5750:   font-size: larger;
                   5751:   font-weight:  bold;
1.602     albertel 5752:   width: 100%;
                   5753:   border-color: $pgbg;
                   5754:   border-style: solid;
                   5755:   border-width: $border;
1.600     albertel 5756:   background: $tabbg;
1.602     albertel 5757:   border-collapse: collapse;
1.803     bisitz   5758:   padding: 0;
1.602     albertel 5759: }
                   5760: 
                   5761: div.LC_edit_problem_discards {
                   5762:   float: left;
                   5763:   padding-bottom: 5px;
                   5764: }
1.795     www      5765: 
1.602     albertel 5766: div.LC_edit_problem_saves {
                   5767:   float: right;
                   5768:   padding-bottom: 5px;
1.600     albertel 5769: }
1.795     www      5770: 
1.600     albertel 5771: hr.LC_edit_problem_divide {
1.602     albertel 5772:   clear: both;
1.600     albertel 5773:   color: $tabbg;
                   5774:   background-color: $tabbg;
                   5775:   height: 3px;
1.803     bisitz   5776:   border: none;
1.600     albertel 5777: }
1.795     www      5778: 
1.679     riegler  5779: img.stift{
1.803     bisitz   5780:   border-width: 0;
                   5781:   vertical-align: middle;
1.677     riegler  5782: }
1.680     riegler  5783: 
1.681     riegler  5784: table#LC_mainmenu{
                   5785:  margin-top:10px;
                   5786:  width:80%;
                   5787: }
                   5788: 
1.680     riegler  5789: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
                   5790:   vertical-align: top;
                   5791:   width: 45%;
                   5792: }
1.795     www      5793: 
1.779     bisitz   5794: .LC_mainmenu_fieldset_category {
                   5795:   color: $font;
                   5796:   background: $pgbg;
                   5797:   font-family: $sans;
                   5798:   font-size: small;
                   5799:   font-weight: bold;
1.777     tempelho 5800: }
1.795     www      5801: 
1.716     raeburn  5802: div.LC_createcourse {
                   5803:     margin: 10px 10px 10px 10px;
                   5804: }
                   5805: 
1.693     droeschl 5806: /* ---- Remove when done ----
                   5807: # The following styles is part of the redesign of LON-CAPA and are
                   5808: # subject to change during this project.
                   5809: # Don't rely on their current functionality as they might be 
                   5810: # changed or removed.
                   5811: # --------------------------*/
                   5812: 
1.698     harmsja  5813: a:hover,
1.721     harmsja  5814: ol.LC_smallMenu a:hover,
                   5815: ol#LC_MenuBreadcrumbs a:hover,
                   5816: ol#LC_PathBreadcrumbs a:hover,
                   5817: ul#LC_TabMainMenuContent a:hover,
                   5818: .LC_FormSectionClearButton input:hover
1.795     www      5819: ul.LC_TabContent   li:hover a {
1.698     harmsja  5820: 	color:#BF2317;
                   5821:         text-decoration:none;
1.693     droeschl 5822: }
                   5823: 
1.779     bisitz   5824: h1 {
1.813     bisitz   5825: 	padding: 0;
1.693     droeschl 5826: 	line-height:130%;
                   5827: }
1.698     harmsja  5828: 
1.795     www      5829: h2,h3,h4,h5,h6 {
1.803     bisitz   5830: 	margin: 5px 0 5px 0;
                   5831: 	padding: 0;
1.721     harmsja  5832: 	line-height:130%;
1.693     droeschl 5833: }
1.795     www      5834: 
                   5835: .LC_hcell {
1.698     harmsja  5836:         padding:3px 15px 3px 15px;
1.803     bisitz   5837:         margin: 0;
1.703     harmsja  5838: 	background-color:$tabbg;
1.801     tempelho 5839: 	color:$fontmenu;
1.779     bisitz   5840: 	border-bottom:solid 1px $lg_border_color;
1.693     droeschl 5841: }
1.795     www      5842: 
1.721     harmsja  5843: .LC_noBorder {
1.803     bisitz   5844:         border: 0;
1.698     harmsja  5845: }
1.693     droeschl 5846: 
                   5847: 
1.698     harmsja  5848: /* Main Header with discription of Person, Course, etc. */
1.693     droeschl 5849: 
1.761     tempelho 5850: .LC_Right {
                   5851:         float: right;
1.803     bisitz   5852:         margin: 0;
                   5853:         padding: 0;
1.761     tempelho 5854: }
                   5855: 
1.721     harmsja  5856: .LC_FormSectionClearButton input {
1.779     bisitz   5857:         background-color:transparent;
1.803     bisitz   5858:         border: none;
1.698     harmsja  5859:         cursor:pointer;
                   5860:         text-decoration:underline;
1.693     droeschl 5861: }
1.763     bisitz   5862: 
                   5863: .LC_help_open_topic {
                   5864:         color: #FFFFFF;
                   5865:         background-color: #EEEEFF;
                   5866:         margin: 1px;
                   5867:         padding: 4px;
                   5868:         border: 1px solid #000033;
                   5869:         white-space: nowrap;
1.783     amueller 5870: /*		vertical-align: middle; */
1.759     neumanie 5871: }
1.693     droeschl 5872: 
1.698     harmsja  5873: dl,ul,div,fieldset {
1.803     bisitz   5874: 	margin: 10px 10px 10px 0;
1.806     bisitz   5875: /*	overflow: hidden; */
1.693     droeschl 5876: }
1.795     www      5877: 
1.813     bisitz   5878: #LC_nav_bar {
1.807     droeschl 5879:     float: left;
                   5880:     margin: 0;
                   5881: }
                   5882: 
1.813     bisitz   5883: #LC_nav_bar em{
1.807     droeschl 5884:     font-weight: bold;
                   5885:     font-style: normal;
                   5886: }
                   5887: 
                   5888: ol.LC_smallMenu {
                   5889:     float: right;
                   5890: }
                   5891: 
1.721     harmsja  5892: ol.LC_smallMenu, ol#LC_PathBreadcrumbs {
1.803     bisitz   5893: 	margin: 0;
1.693     droeschl 5894: }
                   5895: 
1.721     harmsja  5896: ol.LC_smallMenu li {
1.693     droeschl 5897: 	display: inline;
1.803     bisitz   5898: 	padding: 5px 5px 0 10px;
1.693     droeschl 5899: 	vertical-align: top;
                   5900: }
                   5901: 
1.721     harmsja  5902: ol.LC_smallMenu li img {
1.693     droeschl 5903: 	vertical-align: bottom;
                   5904: }
                   5905: 
1.721     harmsja  5906: ol.LC_smallMenu a {
1.693     droeschl 5907: 	font-size: 90%;
                   5908: 	color: RGB(80, 80, 80);
                   5909: 	text-decoration: none;
                   5910: }
1.795     www      5911: 
1.808     droeschl 5912: ul#LC_TabMainMenuContent {
1.807     droeschl 5913:     clear: both;
1.808     droeschl 5914:     color: $fontmenu;
                   5915:     background: $tabbg;
                   5916:     list-style: none;
                   5917:     padding: 0;
                   5918:     margin: 0;
                   5919:     float:left;
                   5920:     width: 100%;
                   5921: }
                   5922: 
                   5923: ul#LC_TabMainMenuContent li {
                   5924:     float: left;
                   5925:     font-weight: bold;
                   5926:     line-height: 1.8em;
                   5927:     padding: 0 0.8em; 
                   5928:     border-right: 1px solid black;
                   5929:     display: inline;
                   5930:     vertical-align: middle;
1.807     droeschl 5931: }
                   5932: 
1.795     www      5933: ul.LC_TabContent ,
1.741     harmsja  5934: ul.LC_TabContentBigger {
1.721     harmsja  5935: 	display:block;
                   5936: 	list-style:none;
1.803     bisitz   5937: 	margin: 0;
                   5938: 	padding: 0;
1.693     droeschl 5939: }
                   5940: 
1.795     www      5941: ul.LC_TabContent li,
                   5942: ul.LC_TabContentBigger li {
1.693     droeschl 5943: 	display: inline;
1.741     harmsja  5944: 	border-right: solid 1px $lg_border_color;
                   5945: 	float:left;
                   5946: 	line-height:140%;
                   5947: 	white-space:nowrap;
                   5948: }
1.795     www      5949: 
1.808     droeschl 5950: ul#LC_TabMainMenuContent li a {
                   5951:     color: $fontmenu;
1.693     droeschl 5952: 	text-decoration: none;
                   5953: }
1.795     www      5954: 
1.721     harmsja  5955: ul.LC_TabContent {
1.741     harmsja  5956: 	min-height:1.6em;
1.721     harmsja  5957: }
1.795     www      5958: 
                   5959: ul.LC_TabContent li {
1.741     harmsja  5960: 	vertical-align:middle;
1.803     bisitz   5961: 	padding: 0 10px 0 10px;
1.745     ehlerst  5962: 	background-color:$tabbg;
                   5963: 	border-bottom:solid 1px $lg_border_color;
1.721     harmsja  5964: }
1.795     www      5965: 
                   5966: ul.LC_TabContent li a, ul.LC_TabContent li {
1.721     harmsja  5967: 	color:rgb(47,47,47);
                   5968: 	text-decoration:none;
                   5969: 	font-size:95%;
                   5970: 	font-weight:bold;
1.761     tempelho 5971: 	padding-right: 16px;
1.721     harmsja  5972: }
1.795     www      5973: 
                   5974: ul.LC_TabContent li:hover, ul.LC_TabContent li.active {
1.761     tempelho 5975:         background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.745     ehlerst  5976: 	border-bottom:solid 1px #FFFFFF;
1.761     tempelho 5977: 	padding-right: 16px;
1.744     ehlerst  5978: }
1.795     www      5979: 
                   5980: ul.LC_TabContentBigger li {
1.741     harmsja  5981: 	vertical-align:bottom;
                   5982: 	border-top:solid 1px $lg_border_color;
                   5983: 	border-left:solid 1px $lg_border_color;
                   5984: 	padding:5px 10px 5px 10px;
                   5985: 	margin-left:2px;
                   5986: 	background:url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
                   5987: }
1.795     www      5988: 
                   5989: ul.LC_TabContentBigger li:hover, 
                   5990: ul.LC_TabContentBigger li.active {
1.744     ehlerst  5991: 	background:url(/adm/lonIcons/lightGreyBG.png) repeat-x right bottom;
                   5992: }
1.795     www      5993: 
                   5994: ul.LC_TabContentBigger li, 
                   5995: ul.LC_TabContentBigger li a {
1.741     harmsja  5996: 	font-size:110%;
                   5997: 	font-weight:bold;
                   5998: }
1.693     droeschl 5999: 
1.795     www      6000: ol#LC_MenuBreadcrumbs, 
                   6001: ol#LC_PathBreadcrumbs, 
                   6002: ul.LC_CourseBreadcrumbs {
1.693     droeschl 6003: 	padding-left: 10px;
1.819     tempelho 6004: 	margin: 0;
1.693     droeschl 6005: 	list-style-position: inside;
                   6006: }
                   6007: 
1.795     www      6008: ol#LC_MenuBreadcrumbs li, 
                   6009: ol#LC_PathBreadcrumbs li, 
                   6010: ul.LC_CourseBreadcrumbs li {
1.693     droeschl 6011: 	display: inline;
1.803     bisitz   6012: 	padding: 0 0 0 10px;
1.693     droeschl 6013: 	overflow:hidden;
                   6014: }
                   6015: 
1.783     amueller 6016: ol#LC_MenuBreadcrumbs li a, ul.LC_CourseBreadcrumbs li a {
1.693     droeschl 6017: 	text-decoration: none;
                   6018: 	font-size:90%;
                   6019: }
1.795     www      6020: 
                   6021: ol#LC_PathBreadcrumbs li a {
1.698     harmsja  6022: 	text-decoration:none;
                   6023: 	font-size:100%;
                   6024: 	font-weight:bold;
1.693     droeschl 6025: }
1.795     www      6026: 
                   6027: .LC_BoxPadding {
1.786     neumanie 6028: 	padding: 10px;
                   6029: }
1.795     www      6030: 
                   6031: .LC_ContentBoxSpecial {
1.701     harmsja  6032: 	border: solid 1px $lg_border_color;
1.746     neumanie 6033: }
1.795     www      6034: 
                   6035: .LC_ContentBoxSpecialContactInfo {
1.746     neumanie 6036: 	border: solid 1px $lg_border_color;
                   6037: 	max-width:25%;
                   6038: 	min-width:25%;
1.698     harmsja  6039: }
1.795     www      6040: 
                   6041: .LC_AboutMe_Image {
1.747     neumanie 6042: 	float:left;
                   6043: 	margin-right:10px;
                   6044: }
1.795     www      6045: 
                   6046: .LC_Clear_AboutMe_Image {
1.747     neumanie 6047: 	clear:left;
                   6048: }
1.795     www      6049: 
1.721     harmsja  6050: dl.LC_ListStyleClean dt {
1.693     droeschl 6051: 	padding-right: 5px;
                   6052: 	display: table-header-group;
                   6053: }
                   6054: 
1.721     harmsja  6055: dl.LC_ListStyleClean dd {
1.693     droeschl 6056: 	display: table-row;
                   6057: }
                   6058: 
1.721     harmsja  6059: .LC_ListStyleClean,
                   6060: .LC_ListStyleSimple,
                   6061: .LC_ListStyleNormal,
1.777     tempelho 6062: .LC_ListStyle_Border,
1.795     www      6063: .LC_ListStyleSpecial {
1.693     droeschl 6064: 	/*display:block;	*/
                   6065: 	list-style-position: inside;
                   6066: 	list-style-type: none;
                   6067: 	overflow: hidden;
1.803     bisitz   6068: 	padding: 0;
1.693     droeschl 6069: }
                   6070: 
1.721     harmsja  6071: .LC_ListStyleSimple li,
                   6072: .LC_ListStyleSimple dd,
                   6073: .LC_ListStyleNormal li,
                   6074: .LC_ListStyleNormal dd,
                   6075: .LC_ListStyleSpecial li,
1.795     www      6076: .LC_ListStyleSpecial dd {
1.803     bisitz   6077: 	margin: 0;
1.693     droeschl 6078: 	padding: 5px 5px 5px 10px;
                   6079: 	clear: both;
                   6080: }
                   6081: 
1.721     harmsja  6082: .LC_ListStyleClean li,
                   6083: .LC_ListStyleClean dd {
1.803     bisitz   6084: 	padding-top: 0;
                   6085: 	padding-bottom: 0;
1.693     droeschl 6086: }
                   6087: 
1.721     harmsja  6088: .LC_ListStyleSimple dd,
1.795     www      6089: .LC_ListStyleSimple li {
1.698     harmsja  6090: 	border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6091: }
                   6092: 
1.721     harmsja  6093: .LC_ListStyleSpecial li,
                   6094: .LC_ListStyleSpecial dd {
1.693     droeschl 6095: 	list-style-type: none;
                   6096: 	background-color: RGB(220, 220, 220);
                   6097: 	margin-bottom: 4px;
                   6098: }
                   6099: 
1.721     harmsja  6100: table.LC_SimpleTable {
1.698     harmsja  6101: 	margin:5px;
                   6102: 	border:solid 1px $lg_border_color;
1.795     www      6103: }
1.693     droeschl 6104: 
1.721     harmsja  6105: table.LC_SimpleTable tr {
1.803     bisitz   6106: 	padding: 0;
1.698     harmsja  6107: 	border:solid 1px $lg_border_color;
1.693     droeschl 6108: }
1.795     www      6109: 
                   6110: table.LC_SimpleTable thead {
1.698     harmsja  6111: 	 background:rgb(220,220,220);
1.693     droeschl 6112: }
                   6113: 
1.721     harmsja  6114: div.LC_columnSection {
1.693     droeschl 6115: 	display: block;
                   6116: 	clear: both;
                   6117: 	overflow: hidden;
1.803     bisitz   6118: 	margin: 0;
1.693     droeschl 6119: }
                   6120: 
1.721     harmsja  6121: div.LC_columnSection>* {
1.693     droeschl 6122: 	float: left;
1.803     bisitz   6123: 	margin: 10px 20px 10px 0;
1.747     neumanie 6124: 	overflow:hidden;
1.693     droeschl 6125: }
1.721     harmsja  6126: 
1.795     www      6127: .ContentBoxSpecialTemplate {
1.747     neumanie 6128:         border: solid 1px $lg_border_color;
1.719     ehlerst  6129: }
1.795     www      6130: 
1.719     ehlerst  6131: .ContentBoxTemplate {
                   6132:         padding:10px;
                   6133: }
                   6134: 
1.721     harmsja  6135: div.LC_columnSection > .ContentBoxTemplate,
1.795     www      6136: div.LC_columnSection > .ContentBoxSpecialTemplate {
1.719     ehlerst  6137:         width: 600px;
                   6138: }
1.753     droeschl 6139: 
1.795     www      6140: .clear {
1.720     ehlerst  6141: 	clear: both;
1.803     bisitz   6142: 	line-height: 0;
                   6143: 	font-size: 0;
                   6144: 	height: 0;
1.720     ehlerst  6145: }
1.693     droeschl 6146: 
1.694     tempelho 6147: .LC_loginpage_container {
                   6148: 	text-align:left;
                   6149: 	margin : 0 auto;
1.785     tempelho 6150: 	width:90%;
1.694     tempelho 6151: 	padding: 10px;
                   6152: 	height: auto;
1.712     muellerd 6153: 	background-color:#FFFFFF;
1.694     tempelho 6154: 	border:1px solid #CCCCCC;
                   6155: }
                   6156: 
                   6157: 
                   6158: .LC_loginpage_loginContainer {
                   6159: 	float:left;
1.712     muellerd 6160: 	width: 182px;
1.785     tempelho 6161: 	padding: 2px;
1.712     muellerd 6162: 	border:1px solid #CCCCCC;
                   6163: 	background-color:$loginbg;
1.694     tempelho 6164: }
                   6165: 
1.795     www      6166: .LC_loginpage_loginContainer h2 {
1.803     bisitz   6167: 	margin-top: 0;
1.712     muellerd 6168: 	display:block;
                   6169: 	background:$bgcol;
                   6170: 	color:$textcol;
                   6171: 	padding-left:5px;
                   6172: }
1.785     tempelho 6173: 
1.694     tempelho 6174: .LC_loginpage_loginInfo {
                   6175: 	float:left;
1.785     tempelho 6176: 	width:182px;
1.694     tempelho 6177: 	border:1px solid #CCCCCC;
1.785     tempelho 6178: 	padding:2px;
1.712     muellerd 6179: }
                   6180: 
1.694     tempelho 6181: .LC_loginpage_space {
1.754     droeschl 6182: 	clear: both;
                   6183: 	margin-bottom: 20px;
1.694     tempelho 6184: 	border-bottom: 1px solid #CCCCCC;
                   6185: }
                   6186: 
1.785     tempelho 6187: .LC_loginpage_floatLeft {
                   6188: 	float: left;
                   6189: 	width: 200px;
                   6190: 	margin: 0;
                   6191: }
                   6192: 
1.795     www      6193: table em {
1.754     droeschl 6194: 	font-weight: bold;
                   6195: 	font-style: normal;
1.748     schulted 6196: }
1.795     www      6197: 
1.779     bisitz   6198: table.LC_tableBrowseRes,
1.795     www      6199: table.LC_tableOfContent {
1.769     schulted 6200:         border:none;
                   6201: 	border-spacing: 1;
1.754     droeschl 6202: 	padding: 3px;
                   6203: 	background-color: #FFFFFF;
                   6204: 	font-size: 90%;
1.753     droeschl 6205: }
1.789     droeschl 6206: 
                   6207: table.LC_tableOfContent{
                   6208:     border-collapse: collapse;
                   6209: }
                   6210: 
1.771     droeschl 6211: table.LC_tableBrowseRes a,
1.768     schulted 6212: table.LC_tableOfContent a {
1.771     droeschl 6213:         background-color: transparent;
1.753     droeschl 6214: 	text-decoration: none;
                   6215: }
                   6216: 
1.771     droeschl 6217: table.LC_tableBrowseRes tr.LC_trOdd,
1.768     schulted 6218: table.LC_tableOfContent tr.LC_trOdd{
1.754     droeschl 6219: 	background-color: #EEEEEE;
1.753     droeschl 6220: }
                   6221: 
1.795     www      6222: table.LC_tableOfContent img {
1.753     droeschl 6223: 	border: none;
                   6224: 	height: 1.3em;
                   6225: 	vertical-align: text-bottom;
                   6226: 	margin-right: 0.3em;
                   6227: }
1.757     schulted 6228: 
1.795     www      6229: a#LC_content_toolbar_firsthomework {
1.774     ehlerst  6230: 	background-image:url(/res/adm/pages/open-first-problem.gif);
                   6231: }
                   6232: 
1.795     www      6233: a#LC_content_toolbar_launchnav {
1.774     ehlerst  6234: 	background-image:url(/res/adm/pages/start-navigation.gif);
                   6235: }
                   6236: 
1.795     www      6237: a#LC_content_toolbar_closenav {
1.774     ehlerst  6238: 	background-image:url(/res/adm/pages/close-navigation.gif);
                   6239: }
                   6240: 
1.795     www      6241: a#LC_content_toolbar_everything {
1.774     ehlerst  6242: 	background-image:url(/res/adm/pages/show-all.gif);
                   6243: }
                   6244: 
1.795     www      6245: a#LC_content_toolbar_uncompleted {
1.774     ehlerst  6246: 	background-image:url(/res/adm/pages/show-incomplete-problems.gif);
                   6247: }
                   6248: 
1.795     www      6249: #LC_content_toolbar_clearbubbles {
1.774     ehlerst  6250: 	background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
                   6251: }
                   6252: 
1.795     www      6253: a#LC_content_toolbar_changefolder {
1.757     schulted 6254: 	background : url(/res/adm/pages/close-all-folders.gif) top center ;
                   6255: }
                   6256: 
1.795     www      6257: a#LC_content_toolbar_changefolder_toggled {
1.757     schulted 6258: 	background-image:url(/res/adm/pages/open-all-folders.gif);
                   6259: }
                   6260: 
1.795     www      6261: ul#LC_toolbar li a:hover {
1.757     schulted 6262: 	background-position: bottom center;
                   6263: }
                   6264: 
1.795     www      6265: ul#LC_toolbar {
1.803     bisitz   6266: 	padding: 0;
1.757     schulted 6267: 	margin: 2px;
                   6268: 	list-style:none;
                   6269: 	position:relative;
                   6270: 	background-color:white;
                   6271: }
                   6272: 
1.795     www      6273: ul#LC_toolbar li {
1.757     schulted 6274: 	border:1px solid white;
1.803     bisitz   6275: 	padding: 0;
1.757     schulted 6276: 	margin: 0;
1.795     www      6277:         float: left;
1.767     droeschl 6278: 	display:inline;
1.757     schulted 6279: 	vertical-align:middle;
1.795     www      6280: } 
1.757     schulted 6281: 
1.783     amueller 6282: 
1.795     www      6283: a.LC_toolbarItem {
1.767     droeschl 6284: 	display:block;
1.803     bisitz   6285: 	padding: 0;
                   6286: 	margin: 0;
1.757     schulted 6287: 	height: 32px;
                   6288: 	width: 32px;
1.779     bisitz   6289: 	color:white;
1.803     bisitz   6290: 	border: none;
1.757     schulted 6291: 	background-repeat:no-repeat;
                   6292: 	background-color:transparent;
                   6293: }
                   6294: 
1.782     bisitz   6295: ul.LC_functionslist li {
                   6296:   float: left;
                   6297:   white-space: nowrap;
                   6298:   height: 35px; /* at least as high as heighest list item */
1.803     bisitz   6299:   margin: 0 15px 15px 10px;
1.782     bisitz   6300: }
                   6301: 
1.757     schulted 6302: 
1.343     albertel 6303: END
                   6304: }
                   6305: 
1.306     albertel 6306: =pod
                   6307: 
                   6308: =item * &headtag()
                   6309: 
                   6310: Returns a uniform footer for LON-CAPA web pages.
                   6311: 
1.307     albertel 6312: Inputs: $title - optional title for the head
                   6313:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6314:         $args - optional arguments
1.319     albertel 6315:             force_register - if is true call registerurl so the remote is 
                   6316:                              informed
1.415     albertel 6317:             redirect       -> array ref of
                   6318:                                    1- seconds before redirect occurs
                   6319:                                    2- url to redirect to
                   6320:                                    3- whether the side effect should occur
1.315     albertel 6321:                            (side effect of setting 
                   6322:                                $env{'internal.head.redirect'} to the url 
                   6323:                                redirected too)
1.352     albertel 6324:             domain         -> force to color decorate a page for a specific
                   6325:                                domain
                   6326:             function       -> force usage of a specific rolish color scheme
                   6327:             bgcolor        -> override the default page bgcolor
1.460     albertel 6328:             no_auto_mt_title
                   6329:                            -> prevent &mt()ing the title arg
1.464     albertel 6330: 
1.306     albertel 6331: =cut
                   6332: 
                   6333: sub headtag {
1.313     albertel 6334:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6335:     
1.363     albertel 6336:     my $function = $args->{'function'} || &get_users_function();
                   6337:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6338:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6339:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6340: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6341: 		   #time(),
1.418     albertel 6342: 		   $env{'environment.color.timestamp'},
1.363     albertel 6343: 		   $function,$domain,$bgcolor);
                   6344: 
1.369     www      6345:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6346: 
1.308     albertel 6347:     my $result =
                   6348: 	'<head>'.
1.461     albertel 6349: 	&font_settings();
1.319     albertel 6350: 
1.461     albertel 6351:     if (!$args->{'frameset'}) {
                   6352: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6353:     }
1.319     albertel 6354:     if ($args->{'force_register'}) {
                   6355: 	$result .= &Apache::lonmenu::registerurl(1);
                   6356:     }
1.436     albertel 6357:     if (!$args->{'no_nav_bar'} 
                   6358: 	&& !$args->{'only_body'}
                   6359: 	&& !$args->{'frameset'}) {
                   6360: 	$result .= &help_menu_js();
                   6361:     }
1.319     albertel 6362: 
1.314     albertel 6363:     if (ref($args->{'redirect'})) {
1.414     albertel 6364: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6365: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6366: 	if (!$inhibit_continue) {
                   6367: 	    $env{'internal.head.redirect'} = $url;
                   6368: 	}
1.313     albertel 6369: 	$result.=<<ADDMETA
                   6370: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6371: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6372: ADDMETA
                   6373:     }
1.306     albertel 6374:     if (!defined($title)) {
                   6375: 	$title = 'The LearningOnline Network with CAPA';
                   6376:     }
1.460     albertel 6377:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6378:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6379: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6380: 	.$head_extra;
1.306     albertel 6381:     return $result;
                   6382: }
                   6383: 
                   6384: =pod
                   6385: 
1.340     albertel 6386: =item * &font_settings()
                   6387: 
                   6388: Returns neccessary <meta> to set the proper encoding
                   6389: 
                   6390: Inputs: none
                   6391: 
                   6392: =cut
                   6393: 
                   6394: sub font_settings {
                   6395:     my $headerstring='';
1.647     www      6396:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6397: 	$headerstring.=
                   6398: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6399:     }
                   6400:     return $headerstring;
                   6401: }
                   6402: 
1.341     albertel 6403: =pod
                   6404: 
                   6405: =item * &xml_begin()
                   6406: 
                   6407: Returns the needed doctype and <html>
                   6408: 
                   6409: Inputs: none
                   6410: 
                   6411: =cut
                   6412: 
                   6413: sub xml_begin {
                   6414:     my $output='';
                   6415: 
1.592     albertel 6416:     if ($env{'internal.start_page'}==1) {
                   6417: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6418:     }
1.342     albertel 6419: 
1.341     albertel 6420:     if ($env{'browser.mathml'}) {
                   6421: 	$output='<?xml version="1.0"?>'
                   6422:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6423: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6424:             
                   6425: #	    .'<!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">] >'
                   6426: 	    .'<!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">'
                   6427:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6428: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6429:     } else {
                   6430: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
                   6431:     }
                   6432:     return $output;
                   6433: }
1.340     albertel 6434: 
                   6435: =pod
                   6436: 
1.306     albertel 6437: =item * &endheadtag()
                   6438: 
                   6439: Returns a uniform </head> for LON-CAPA web pages.
                   6440: 
                   6441: Inputs: none
                   6442: 
                   6443: =cut
                   6444: 
                   6445: sub endheadtag {
                   6446:     return '</head>';
                   6447: }
                   6448: 
                   6449: =pod
                   6450: 
                   6451: =item * &head()
                   6452: 
                   6453: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6454: 
1.648     raeburn  6455: Inputs:
                   6456: 
                   6457: =over 4
                   6458: 
                   6459: $title - optional title for the page
                   6460: 
                   6461: $head_extra - optional extra HTML to put inside the <head>
                   6462: 
                   6463: =back
1.405     albertel 6464: 
1.306     albertel 6465: =cut
                   6466: 
                   6467: sub head {
1.325     albertel 6468:     my ($title,$head_extra,$args) = @_;
                   6469:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6470: }
                   6471: 
                   6472: =pod
                   6473: 
                   6474: =item * &start_page()
                   6475: 
                   6476: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6477: 
1.648     raeburn  6478: Inputs:
                   6479: 
                   6480: =over 4
                   6481: 
                   6482: $title - optional title for the page
                   6483: 
                   6484: $head_extra - optional extra HTML to incude inside the <head>
                   6485: 
                   6486: $args - additional optional args supported are:
                   6487: 
                   6488: =over 8
                   6489: 
                   6490:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6491:                                     arg on
1.814     bisitz   6492:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6493:              add_entries    -> additional attributes to add to the  <body>
                   6494:              domain         -> force to color decorate a page for a 
1.317     albertel 6495:                                     specific domain
1.648     raeburn  6496:              function       -> force usage of a specific rolish color
1.317     albertel 6497:                                     scheme
1.648     raeburn  6498:              redirect       -> see &headtag()
                   6499:              bgcolor        -> override the default page bg color
                   6500:              js_ready       -> return a string ready for being used in 
1.317     albertel 6501:                                     a javascript writeln
1.648     raeburn  6502:              html_encode    -> return a string ready for being used in 
1.320     albertel 6503:                                     a html attribute
1.648     raeburn  6504:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6505:                                     $forcereg arg
1.648     raeburn  6506:              body_title     -> alternate text to use instead of $title
1.326     albertel 6507:                                     in the title box that appears, this text
                   6508:                                     is not auto translated like the $title is
1.648     raeburn  6509:              frameset       -> if true will start with a <frameset>
1.330     albertel 6510:                                     rather than <body>
1.648     raeburn  6511:              skip_phases    -> hash ref of 
1.338     albertel 6512:                                     head -> skip the <html><head> generation
                   6513:                                     body -> skip all <body> generation
1.648     raeburn  6514:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6515:                                     'Switch To Inline Menu' link
1.648     raeburn  6516:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6517:              inherit_jsmath -> when creating popup window in a page,
                   6518:                                     should it have jsmath forced on by the
                   6519:                                     current page
1.361     albertel 6520: 
1.648     raeburn  6521: =back
1.460     albertel 6522: 
1.648     raeburn  6523: =back
1.562     albertel 6524: 
1.306     albertel 6525: =cut
                   6526: 
                   6527: sub start_page {
1.309     albertel 6528:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6529:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6530:     my %head_args;
1.352     albertel 6531:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6532: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6533: 		     'no_auto_mt_title') {
1.319     albertel 6534: 	if (defined($args->{$arg})) {
1.324     raeburn  6535: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6536: 	}
1.313     albertel 6537:     }
1.319     albertel 6538: 
1.315     albertel 6539:     $env{'internal.start_page'}++;
1.338     albertel 6540:     my $result;
                   6541:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6542: 	$result.=
1.341     albertel 6543: 	    &xml_begin().
1.338     albertel 6544: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6545:     }
                   6546:     
                   6547:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6548: 	if ($args->{'frameset'}) {
                   6549: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6550: 						$args->{'add_entries'});
                   6551: 	    $result .= "\n<frameset $attr_string>\n";
                   6552: 	} else {
                   6553: 	    $result .=
                   6554: 		&bodytag($title, 
                   6555: 			 $args->{'function'},       $args->{'add_entries'},
                   6556: 			 $args->{'only_body'},      $args->{'domain'},
                   6557: 			 $args->{'force_register'}, $args->{'body_title'},
                   6558: 			 $args->{'no_nav_bar'},     $args->{'bgcolor'},
1.816     bisitz   6559: 			 $args->{'no_inline_link'},
1.460     albertel 6560: 			 $args);
1.338     albertel 6561: 	}
1.330     albertel 6562:     }
1.338     albertel 6563: 
1.315     albertel 6564:     if ($args->{'js_ready'}) {
1.713     kaisler  6565: 		$result = &js_ready($result);
1.315     albertel 6566:     }
1.320     albertel 6567:     if ($args->{'html_encode'}) {
1.713     kaisler  6568: 		$result = &html_encode($result);
                   6569:     }
                   6570: 
1.813     bisitz   6571:     # Preparation for new and consistent functionlist at top of screen
                   6572:     # if ($args->{'functionlist'}) {
                   6573:     #            $result .= &build_functionlist();
                   6574:     #}
                   6575: 
                   6576:     # Don't add anything more if only_body wanted
                   6577:     return $result if $args->{'only_body'};
                   6578: 
                   6579:     #Breadcrumbs
1.758     kaisler  6580:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6581: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6582: 		#if any br links exists, add them to the breadcrumbs
                   6583: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6584: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6585: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6586: 			}
                   6587: 		}
                   6588: 
                   6589: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6590: 		if(exists($args->{'bread_crumbs_component'})){
                   6591: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   6592: 		}else{
                   6593: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   6594: 		}
1.320     albertel 6595:     }
1.315     albertel 6596:     return $result;
1.306     albertel 6597: }
                   6598: 
1.330     albertel 6599: 
1.306     albertel 6600: =pod
                   6601: 
                   6602: =item * &head()
                   6603: 
                   6604: Returns a complete </body></html> section for LON-CAPA web pages.
                   6605: 
1.315     albertel 6606: Inputs:         $args - additional optional args supported are:
                   6607:                  js_ready     -> return a string ready for being used in 
                   6608:                                  a javascript writeln
1.320     albertel 6609:                  html_encode  -> return a string ready for being used in 
                   6610:                                  a html attribute
1.330     albertel 6611:                  frameset     -> if true will start with a <frameset>
                   6612:                                  rather than <body>
1.493     albertel 6613:                  dicsussion   -> if true will get discussion from
                   6614:                                   lonxml::xmlend
                   6615:                                  (you can pass the target and parser arguments
                   6616:                                   through optional 'target' and 'parser' args
                   6617:                                   to this routine)
1.306     albertel 6618: 
                   6619: =cut
                   6620: 
                   6621: sub end_page {
1.315     albertel 6622:     my ($args) = @_;
                   6623:     $env{'internal.end_page'}++;
1.330     albertel 6624:     my $result;
1.335     albertel 6625:     if ($args->{'discussion'}) {
                   6626: 	my ($target,$parser);
                   6627: 	if (ref($args->{'discussion'})) {
                   6628: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6629: 				$args->{'discussion'}{'parser'});
                   6630: 	}
                   6631: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6632:     }
                   6633: 
1.330     albertel 6634:     if ($args->{'frameset'}) {
                   6635: 	$result .= '</frameset>';
                   6636:     } else {
1.635     raeburn  6637: 	$result .= &endbodytag($args);
1.330     albertel 6638:     }
                   6639:     $result .= "\n</html>";
                   6640: 
1.315     albertel 6641:     if ($args->{'js_ready'}) {
1.317     albertel 6642: 	$result = &js_ready($result);
1.315     albertel 6643:     }
1.335     albertel 6644: 
1.320     albertel 6645:     if ($args->{'html_encode'}) {
                   6646: 	$result = &html_encode($result);
                   6647:     }
1.335     albertel 6648: 
1.315     albertel 6649:     return $result;
                   6650: }
                   6651: 
1.320     albertel 6652: sub html_encode {
                   6653:     my ($result) = @_;
                   6654: 
1.322     albertel 6655:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 6656:     
                   6657:     return $result;
                   6658: }
1.317     albertel 6659: sub js_ready {
                   6660:     my ($result) = @_;
                   6661: 
1.323     albertel 6662:     $result =~ s/[\n\r]/ /xmsg;
                   6663:     $result =~ s/\\/\\\\/xmsg;
                   6664:     $result =~ s/'/\\'/xmsg;
1.372     albertel 6665:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 6666:     
                   6667:     return $result;
                   6668: }
                   6669: 
1.315     albertel 6670: sub validate_page {
                   6671:     if (  exists($env{'internal.start_page'})
1.316     albertel 6672: 	  &&     $env{'internal.start_page'} > 1) {
                   6673: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 6674: 				 $env{'internal.start_page'}.' '.
1.316     albertel 6675: 				 $ENV{'request.filename'});
1.315     albertel 6676:     }
                   6677:     if (  exists($env{'internal.end_page'})
1.316     albertel 6678: 	  &&     $env{'internal.end_page'} > 1) {
                   6679: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 6680: 				 $env{'internal.end_page'}.' '.
1.316     albertel 6681: 				 $env{'request.filename'});
1.315     albertel 6682:     }
                   6683:     if (     exists($env{'internal.start_page'})
                   6684: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 6685: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   6686: 				 $env{'request.filename'});
1.315     albertel 6687:     }
                   6688:     if (   ! exists($env{'internal.start_page'})
                   6689: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 6690: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   6691: 				 $env{'request.filename'});
1.315     albertel 6692:     }
1.306     albertel 6693: }
1.315     albertel 6694: 
1.318     albertel 6695: sub simple_error_page {
                   6696:     my ($r,$title,$msg) = @_;
                   6697:     my $page =
                   6698: 	&Apache::loncommon::start_page($title).
                   6699: 	&mt($msg).
                   6700: 	&Apache::loncommon::end_page();
                   6701:     if (ref($r)) {
                   6702: 	$r->print($page);
1.327     albertel 6703: 	return;
1.318     albertel 6704:     }
                   6705:     return $page;
                   6706: }
1.347     albertel 6707: 
                   6708: {
1.610     albertel 6709:     my @row_count;
1.347     albertel 6710:     sub start_data_table {
1.422     albertel 6711: 	my ($add_class) = @_;
                   6712: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 6713: 	unshift(@row_count,0);
1.422     albertel 6714: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 6715:     }
                   6716: 
                   6717:     sub end_data_table {
1.610     albertel 6718: 	shift(@row_count);
1.389     albertel 6719: 	return '</table>'."\n";;
1.347     albertel 6720:     }
                   6721: 
                   6722:     sub start_data_table_row {
1.422     albertel 6723: 	my ($add_class) = @_;
1.610     albertel 6724: 	$row_count[0]++;
                   6725: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428     albertel 6726: 	$css_class = (join(' ',$css_class,$add_class));
1.422     albertel 6727: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 6728:     }
1.471     banghart 6729:     
                   6730:     sub continue_data_table_row {
                   6731: 	my ($add_class) = @_;
1.610     albertel 6732: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471     banghart 6733: 	$css_class = (join(' ',$css_class,$add_class));
                   6734: 	return  '<tr class="'.$css_class.'">'."\n";;
                   6735:     }
1.347     albertel 6736: 
                   6737:     sub end_data_table_row {
1.389     albertel 6738: 	return '</tr>'."\n";;
1.347     albertel 6739:     }
1.367     www      6740: 
1.421     albertel 6741:     sub start_data_table_empty_row {
1.707     bisitz   6742: #	$row_count[0]++;
1.421     albertel 6743: 	return  '<tr class="LC_empty_row" >'."\n";;
                   6744:     }
                   6745: 
                   6746:     sub end_data_table_empty_row {
                   6747: 	return '</tr>'."\n";;
                   6748:     }
                   6749: 
1.367     www      6750:     sub start_data_table_header_row {
1.389     albertel 6751: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      6752:     }
                   6753: 
                   6754:     sub end_data_table_header_row {
1.389     albertel 6755: 	return '</tr>'."\n";;
1.367     www      6756:     }
1.347     albertel 6757: }
                   6758: 
1.548     albertel 6759: =pod
                   6760: 
                   6761: =item * &inhibit_menu_check($arg)
                   6762: 
                   6763: Checks for a inhibitmenu state and generates output to preserve it
                   6764: 
                   6765: Inputs:         $arg - can be any of
                   6766:                      - undef - in which case the return value is a string 
                   6767:                                to add  into arguments list of a uri
                   6768:                      - 'input' - in which case the return value is a HTML
                   6769:                                  <form> <input> field of type hidden to
                   6770:                                  preserve the value
                   6771:                      - a url - in which case the return value is the url with
                   6772:                                the neccesary cgi args added to preserve the
                   6773:                                inhibitmenu state
                   6774:                      - a ref to a url - no return value, but the string is
                   6775:                                         updated to include the neccessary cgi
                   6776:                                         args to preserve the inhibitmenu state
                   6777: 
                   6778: =cut
                   6779: 
                   6780: sub inhibit_menu_check {
                   6781:     my ($arg) = @_;
                   6782:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6783:     if ($arg eq 'input') {
                   6784: 	if ($env{'form.inhibitmenu'}) {
                   6785: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   6786: 	} else {
                   6787: 	    return
                   6788: 	}
                   6789:     }
                   6790:     if ($env{'form.inhibitmenu'}) {
                   6791: 	if (ref($arg)) {
                   6792: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6793: 	} elsif ($arg eq '') {
                   6794: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   6795: 	} else {
                   6796: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6797: 	}
                   6798:     }
                   6799:     if (!ref($arg)) {
                   6800: 	return $arg;
                   6801:     }
                   6802: }
                   6803: 
1.251     albertel 6804: ###############################################
1.182     matthew  6805: 
                   6806: =pod
                   6807: 
1.549     albertel 6808: =back
                   6809: 
                   6810: =head1 User Information Routines
                   6811: 
                   6812: =over 4
                   6813: 
1.405     albertel 6814: =item * &get_users_function()
1.182     matthew  6815: 
                   6816: Used by &bodytag to determine the current users primary role.
                   6817: Returns either 'student','coordinator','admin', or 'author'.
                   6818: 
                   6819: =cut
                   6820: 
                   6821: ###############################################
                   6822: sub get_users_function {
1.815     tempelho 6823:     my $function = 'norole';
1.818     tempelho 6824:     if ($env{'request.role'}=~/^(st)/) {
                   6825:         $function='student';
                   6826:     }
1.258     albertel 6827:     if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182     matthew  6828:         $function='coordinator';
                   6829:     }
1.258     albertel 6830:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  6831:         $function='admin';
                   6832:     }
1.258     albertel 6833:     if (($env{'request.role'}=~/^(au|ca)/) ||
1.182     matthew  6834:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   6835:         $function='author';
                   6836:     }
                   6837:     return $function;
1.54      www      6838: }
1.99      www      6839: 
                   6840: ###############################################
                   6841: 
1.233     raeburn  6842: =pod
                   6843: 
1.821     raeburn  6844: =item * &show_course()
                   6845: 
                   6846: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   6847: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   6848: 
                   6849: Inputs:
                   6850: None
                   6851: 
                   6852: Outputs:
                   6853: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   6854: 
                   6855: =cut
                   6856: 
                   6857: ###############################################
                   6858: sub show_course {
                   6859:     my $course = !$env{'user.adv'};
                   6860:     if (!$env{'user.adv'}) {
                   6861:         foreach my $env (keys(%env)) {
                   6862:             next if ($env !~ m/^user\.priv\./);
                   6863:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   6864:                 $course = 0;
                   6865:                 last;
                   6866:             }
                   6867:         }
                   6868:     }
                   6869:     return $course;
                   6870: }
                   6871: 
                   6872: ###############################################
                   6873: 
                   6874: =pod
                   6875: 
1.542     raeburn  6876: =item * &check_user_status()
1.274     raeburn  6877: 
                   6878: Determines current status of supplied role for a
                   6879: specific user. Roles can be active, previous or future.
                   6880: 
                   6881: Inputs: 
                   6882: user's domain, user's username, course's domain,
1.375     raeburn  6883: course's number, optional section ID.
1.274     raeburn  6884: 
                   6885: Outputs:
                   6886: role status: active, previous or future. 
                   6887: 
                   6888: =cut
                   6889: 
                   6890: sub check_user_status {
1.412     raeburn  6891:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  6892:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   6893:     my @uroles = keys %userinfo;
                   6894:     my $srchstr;
                   6895:     my $active_chk = 'none';
1.412     raeburn  6896:     my $now = time;
1.274     raeburn  6897:     if (@uroles > 0) {
1.412     raeburn  6898:         if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  6899:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   6900:         } else {
1.412     raeburn  6901:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   6902:         }
                   6903:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  6904:             my $role_end = 0;
                   6905:             my $role_start = 0;
                   6906:             $active_chk = 'active';
1.412     raeburn  6907:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   6908:                 $role_end = $1;
                   6909:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   6910:                     $role_start = $1;
1.274     raeburn  6911:                 }
                   6912:             }
                   6913:             if ($role_start > 0) {
1.412     raeburn  6914:                 if ($now < $role_start) {
1.274     raeburn  6915:                     $active_chk = 'future';
                   6916:                 }
                   6917:             }
                   6918:             if ($role_end > 0) {
1.412     raeburn  6919:                 if ($now > $role_end) {
1.274     raeburn  6920:                     $active_chk = 'previous';
                   6921:                 }
                   6922:             }
                   6923:         }
                   6924:     }
                   6925:     return $active_chk;
                   6926: }
                   6927: 
                   6928: ###############################################
                   6929: 
                   6930: =pod
                   6931: 
1.405     albertel 6932: =item * &get_sections()
1.233     raeburn  6933: 
                   6934: Determines all the sections for a course including
                   6935: sections with students and sections containing other roles.
1.419     raeburn  6936: Incoming parameters: 
                   6937: 
                   6938: 1. domain
                   6939: 2. course number 
                   6940: 3. reference to array containing roles for which sections should 
                   6941: be gathered (optional).
                   6942: 4. reference to array containing status types for which sections 
                   6943: should be gathered (optional).
                   6944: 
                   6945: If the third argument is undefined, sections are gathered for any role. 
                   6946: If the fourth argument is undefined, sections are gathered for any status.
                   6947: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  6948:  
1.374     raeburn  6949: Returns section hash (keys are section IDs, values are
                   6950: number of users in each section), subject to the
1.419     raeburn  6951: optional roles filter, optional status filter 
1.233     raeburn  6952: 
                   6953: =cut
                   6954: 
                   6955: ###############################################
                   6956: sub get_sections {
1.419     raeburn  6957:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 6958:     if (!defined($cdom) || !defined($cnum)) {
                   6959:         my $cid =  $env{'request.course.id'};
                   6960: 
                   6961: 	return if (!defined($cid));
                   6962: 
                   6963:         $cdom = $env{'course.'.$cid.'.domain'};
                   6964:         $cnum = $env{'course.'.$cid.'.num'};
                   6965:     }
                   6966: 
                   6967:     my %sectioncount;
1.419     raeburn  6968:     my $now = time;
1.240     albertel 6969: 
1.366     albertel 6970:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 6971: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 6972: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   6973: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  6974:         my $start_index = &Apache::loncoursedata::CL_START();
                   6975:         my $end_index = &Apache::loncoursedata::CL_END();
                   6976:         my $status;
1.366     albertel 6977: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  6978: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   6979: 				                     $data->[$status_index],
                   6980:                                                      $data->[$start_index],
                   6981:                                                      $data->[$end_index]);
                   6982:             if ($stu_status eq 'Active') {
                   6983:                 $status = 'active';
                   6984:             } elsif ($end < $now) {
                   6985:                 $status = 'previous';
                   6986:             } elsif ($start > $now) {
                   6987:                 $status = 'future';
                   6988:             } 
                   6989: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   6990:                 if ((!defined($possible_status)) || (($status ne '') && 
                   6991:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   6992: 		    $sectioncount{$section}++;
                   6993:                 }
1.240     albertel 6994: 	    }
                   6995: 	}
                   6996:     }
                   6997:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   6998:     foreach my $user (sort(keys(%courseroles))) {
                   6999: 	if ($user !~ /^(\w{2})/) { next; }
                   7000: 	my ($role) = ($user =~ /^(\w{2})/);
                   7001: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7002: 	my ($section,$status);
1.240     albertel 7003: 	if ($role eq 'cr' &&
                   7004: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7005: 	    $section=$1;
                   7006: 	}
                   7007: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7008: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7009:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7010:         if ($end == -1 && $start == -1) {
                   7011:             next; #deleted role
                   7012:         }
                   7013:         if (!defined($possible_status)) { 
                   7014:             $sectioncount{$section}++;
                   7015:         } else {
                   7016:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7017:                 $status = 'active';
                   7018:             } elsif ($end < $now) {
                   7019:                 $status = 'future';
                   7020:             } elsif ($start > $now) {
                   7021:                 $status = 'previous';
                   7022:             }
                   7023:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7024:                 $sectioncount{$section}++;
                   7025:             }
                   7026:         }
1.233     raeburn  7027:     }
1.366     albertel 7028:     return %sectioncount;
1.233     raeburn  7029: }
                   7030: 
1.274     raeburn  7031: ###############################################
1.294     raeburn  7032: 
                   7033: =pod
1.405     albertel 7034: 
                   7035: =item * &get_course_users()
                   7036: 
1.275     raeburn  7037: Retrieves usernames:domains for users in the specified course
                   7038: with specific role(s), and access status. 
                   7039: 
                   7040: Incoming parameters:
1.277     albertel 7041: 1. course domain
                   7042: 2. course number
                   7043: 3. access status: users must have - either active, 
1.275     raeburn  7044: previous, future, or all.
1.277     albertel 7045: 4. reference to array of permissible roles
1.288     raeburn  7046: 5. reference to array of section restrictions (optional)
                   7047: 6. reference to results object (hash of hashes).
                   7048: 7. reference to optional userdata hash
1.609     raeburn  7049: 8. reference to optional statushash
1.630     raeburn  7050: 9. flag if privileged users (except those set to unhide in
                   7051:    course settings) should be excluded    
1.609     raeburn  7052: Keys of top level results hash are roles.
1.275     raeburn  7053: Keys of inner hashes are username:domain, with 
                   7054: values set to access type.
1.288     raeburn  7055: Optional userdata hash returns an array with arguments in the 
                   7056: same order as loncoursedata::get_classlist() for student data.
                   7057: 
1.609     raeburn  7058: Optional statushash returns
                   7059: 
1.288     raeburn  7060: Entries for end, start, section and status are blank because
                   7061: of the possibility of multiple values for non-student roles.
                   7062: 
1.275     raeburn  7063: =cut
1.405     albertel 7064: 
1.275     raeburn  7065: ###############################################
1.405     albertel 7066: 
1.275     raeburn  7067: sub get_course_users {
1.630     raeburn  7068:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7069:     my %idx = ();
1.419     raeburn  7070:     my %seclists;
1.288     raeburn  7071: 
                   7072:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7073:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7074:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7075:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7076:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7077:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7078:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7079:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7080: 
1.290     albertel 7081:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7082:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7083:         my $now = time;
1.277     albertel 7084:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7085:             my $match = 0;
1.412     raeburn  7086:             my $secmatch = 0;
1.419     raeburn  7087:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7088:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7089:             if ($section eq '') {
                   7090:                 $section = 'none';
                   7091:             }
1.291     albertel 7092:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7093:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7094:                     $secmatch = 1;
                   7095:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7096:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7097:                         $secmatch = 1;
                   7098:                     }
                   7099:                 } else {  
1.419     raeburn  7100: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7101: 		        $secmatch = 1;
                   7102:                     }
1.290     albertel 7103: 		}
1.412     raeburn  7104:                 if (!$secmatch) {
                   7105:                     next;
                   7106:                 }
1.419     raeburn  7107:             }
1.275     raeburn  7108:             if (defined($$types{'active'})) {
1.288     raeburn  7109:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7110:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7111:                     $match = 1;
1.275     raeburn  7112:                 }
                   7113:             }
                   7114:             if (defined($$types{'previous'})) {
1.609     raeburn  7115:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7116:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7117:                     $match = 1;
1.275     raeburn  7118:                 }
                   7119:             }
                   7120:             if (defined($$types{'future'})) {
1.609     raeburn  7121:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7122:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7123:                     $match = 1;
1.275     raeburn  7124:                 }
                   7125:             }
1.609     raeburn  7126:             if ($match) {
                   7127:                 push(@{$seclists{$student}},$section);
                   7128:                 if (ref($userdata) eq 'HASH') {
                   7129:                     $$userdata{$student} = $$classlist{$student};
                   7130:                 }
                   7131:                 if (ref($statushash) eq 'HASH') {
                   7132:                     $statushash->{$student}{'st'}{$section} = $status;
                   7133:                 }
1.288     raeburn  7134:             }
1.275     raeburn  7135:         }
                   7136:     }
1.412     raeburn  7137:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7138:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7139:         my $now = time;
1.609     raeburn  7140:         my %displaystatus = ( previous => 'Expired',
                   7141:                               active   => 'Active',
                   7142:                               future   => 'Future',
                   7143:                             );
1.630     raeburn  7144:         my %nothide;
                   7145:         if ($hidepriv) {
                   7146:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7147:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7148:                 if ($user !~ /:/) {
                   7149:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7150:                 } else {
                   7151:                     $nothide{$user} = 1;
                   7152:                 }
                   7153:             }
                   7154:         }
1.439     raeburn  7155:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7156:             my $match = 0;
1.412     raeburn  7157:             my $secmatch = 0;
1.439     raeburn  7158:             my $status;
1.412     raeburn  7159:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7160:             $user =~ s/:$//;
1.439     raeburn  7161:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7162:             if ($end == -1 || $start == -1) {
                   7163:                 next;
                   7164:             }
                   7165:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7166:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7167:                 my ($uname,$udom) = split(/:/,$user);
                   7168:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7169:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7170:                         $secmatch = 1;
                   7171:                     } elsif ($usec eq '') {
1.420     albertel 7172:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7173:                             $secmatch = 1;
                   7174:                         }
                   7175:                     } else {
                   7176:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7177:                             $secmatch = 1;
                   7178:                         }
                   7179:                     }
                   7180:                     if (!$secmatch) {
                   7181:                         next;
                   7182:                     }
1.288     raeburn  7183:                 }
1.419     raeburn  7184:                 if ($usec eq '') {
                   7185:                     $usec = 'none';
                   7186:                 }
1.275     raeburn  7187:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7188:                     if ($hidepriv) {
                   7189:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7190:                             (!$nothide{$uname.':'.$udom})) {
                   7191:                             next;
                   7192:                         }
                   7193:                     }
1.503     raeburn  7194:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7195:                         $status = 'previous';
                   7196:                     } elsif ($start > $now) {
                   7197:                         $status = 'future';
                   7198:                     } else {
                   7199:                         $status = 'active';
                   7200:                     }
1.277     albertel 7201:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7202:                         if ($status eq $type) {
1.420     albertel 7203:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7204:                                 push(@{$$users{$role}{$user}},$type);
                   7205:                             }
1.288     raeburn  7206:                             $match = 1;
                   7207:                         }
                   7208:                     }
1.419     raeburn  7209:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7210:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7211: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7212:                         }
1.420     albertel 7213:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7214:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7215:                         }
1.609     raeburn  7216:                         if (ref($statushash) eq 'HASH') {
                   7217:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7218:                         }
1.275     raeburn  7219:                     }
                   7220:                 }
                   7221:             }
                   7222:         }
1.290     albertel 7223:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7224:             if ((defined($cdom)) && (defined($cnum))) {
                   7225:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7226:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7227:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7228:                     next if ($owner eq '');
                   7229:                     my ($ownername,$ownerdom);
                   7230:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7231:                         $ownername = $1;
                   7232:                         $ownerdom = $2;
                   7233:                     } else {
                   7234:                         $ownername = $owner;
                   7235:                         $ownerdom = $cdom;
                   7236:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7237:                     }
                   7238:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7239:                     if (defined($userdata) && 
1.609     raeburn  7240: 			!exists($$userdata{$owner})) {
                   7241: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7242:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7243:                             push(@{$seclists{$owner}},'none');
                   7244:                         }
                   7245:                         if (ref($statushash) eq 'HASH') {
                   7246:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7247:                         }
1.290     albertel 7248: 		    }
1.279     raeburn  7249:                 }
                   7250:             }
                   7251:         }
1.419     raeburn  7252:         foreach my $user (keys(%seclists)) {
                   7253:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7254:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7255:         }
1.275     raeburn  7256:     }
                   7257:     return;
                   7258: }
                   7259: 
1.288     raeburn  7260: sub get_user_info {
                   7261:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7262:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7263: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7264:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7265:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7266:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7267:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7268:     return;
                   7269: }
1.275     raeburn  7270: 
1.472     raeburn  7271: ###############################################
                   7272: 
                   7273: =pod
                   7274: 
                   7275: =item * &get_user_quota()
                   7276: 
                   7277: Retrieves quota assigned for storage of portfolio files for a user  
                   7278: 
                   7279: Incoming parameters:
                   7280: 1. user's username
                   7281: 2. user's domain
                   7282: 
                   7283: Returns:
1.536     raeburn  7284: 1. Disk quota (in Mb) assigned to student.
                   7285: 2. (Optional) Type of setting: custom or default
                   7286:    (individually assigned or default for user's 
                   7287:    institutional status).
                   7288: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7289:    or student - types as defined in localenroll::inst_usertypes 
                   7290:    for user's domain, which determines default quota for user.
                   7291: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7292: 
                   7293: If a value has been stored in the user's environment, 
1.536     raeburn  7294: it will return that, otherwise it returns the maximal default
                   7295: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7296: 
                   7297: =cut
                   7298: 
                   7299: ###############################################
                   7300: 
                   7301: 
                   7302: sub get_user_quota {
                   7303:     my ($uname,$udom) = @_;
1.536     raeburn  7304:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7305:     if (!defined($udom)) {
                   7306:         $udom = $env{'user.domain'};
                   7307:     }
                   7308:     if (!defined($uname)) {
                   7309:         $uname = $env{'user.name'};
                   7310:     }
                   7311:     if (($udom eq '' || $uname eq '') ||
                   7312:         ($udom eq 'public') && ($uname eq 'public')) {
                   7313:         $quota = 0;
1.536     raeburn  7314:         $quotatype = 'default';
                   7315:         $defquota = 0; 
1.472     raeburn  7316:     } else {
1.536     raeburn  7317:         my $inststatus;
1.472     raeburn  7318:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7319:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7320:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7321:         } else {
1.536     raeburn  7322:             my %userenv = 
                   7323:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7324:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7325:             my ($tmp) = keys(%userenv);
                   7326:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7327:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7328:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7329:             } else {
                   7330:                 undef(%userenv);
                   7331:             }
                   7332:         }
1.536     raeburn  7333:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7334:         if ($quota eq '') {
1.536     raeburn  7335:             $quota = $defquota;
                   7336:             $quotatype = 'default';
                   7337:         } else {
                   7338:             $quotatype = 'custom';
1.472     raeburn  7339:         }
                   7340:     }
1.536     raeburn  7341:     if (wantarray) {
                   7342:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7343:     } else {
                   7344:         return $quota;
                   7345:     }
1.472     raeburn  7346: }
                   7347: 
                   7348: ###############################################
                   7349: 
                   7350: =pod
                   7351: 
                   7352: =item * &default_quota()
                   7353: 
1.536     raeburn  7354: Retrieves default quota assigned for storage of user portfolio files,
                   7355: given an (optional) user's institutional status.
1.472     raeburn  7356: 
                   7357: Incoming parameters:
                   7358: 1. domain
1.536     raeburn  7359: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7360:    status types (e.g., faculty, staff, student etc.)
                   7361:    which apply to the user for whom the default is being retrieved.
                   7362:    If the institutional status string in undefined, the domain
                   7363:    default quota will be returned. 
1.472     raeburn  7364: 
                   7365: Returns:
                   7366: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7367: 2. (Optional) institutional type which determined the value of the
                   7368:    default quota.
1.472     raeburn  7369: 
                   7370: If a value has been stored in the domain's configuration db,
                   7371: it will return that, otherwise it returns 20 (for backwards 
                   7372: compatibility with domains which have not set up a configuration
                   7373: db file; the original statically defined portfolio quota was 20 Mb). 
                   7374: 
1.536     raeburn  7375: If the user's status includes multiple types (e.g., staff and student),
                   7376: the largest default quota which applies to the user determines the
                   7377: default quota returned.
                   7378: 
1.780     raeburn  7379: =back
                   7380: 
1.472     raeburn  7381: =cut
                   7382: 
                   7383: ###############################################
                   7384: 
                   7385: 
                   7386: sub default_quota {
1.536     raeburn  7387:     my ($udom,$inststatus) = @_;
                   7388:     my ($defquota,$settingstatus);
                   7389:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7390:                                             ['quotas'],$udom);
                   7391:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7392:         if ($inststatus ne '') {
1.765     raeburn  7393:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7394:             foreach my $item (@statuses) {
1.711     raeburn  7395:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7396:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7397:                         if ($defquota eq '') {
                   7398:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7399:                             $settingstatus = $item;
                   7400:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7401:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7402:                             $settingstatus = $item;
                   7403:                         }
                   7404:                     }
                   7405:                 } else {
                   7406:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7407:                         if ($defquota eq '') {
                   7408:                             $defquota = $quotahash{'quotas'}{$item};
                   7409:                             $settingstatus = $item;
                   7410:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7411:                             $defquota = $quotahash{'quotas'}{$item};
                   7412:                             $settingstatus = $item;
                   7413:                         }
1.536     raeburn  7414:                     }
                   7415:                 }
                   7416:             }
                   7417:         }
                   7418:         if ($defquota eq '') {
1.711     raeburn  7419:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7420:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7421:             } else {
                   7422:                 $defquota = $quotahash{'quotas'}{'default'};
                   7423:             }
1.536     raeburn  7424:             $settingstatus = 'default';
                   7425:         }
                   7426:     } else {
                   7427:         $settingstatus = 'default';
                   7428:         $defquota = 20;
                   7429:     }
                   7430:     if (wantarray) {
                   7431:         return ($defquota,$settingstatus);
1.472     raeburn  7432:     } else {
1.536     raeburn  7433:         return $defquota;
1.472     raeburn  7434:     }
                   7435: }
                   7436: 
1.384     raeburn  7437: sub get_secgrprole_info {
                   7438:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7439:     my %sections_count = &get_sections($cdom,$cnum);
                   7440:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7441:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7442:     my @groups = sort(keys(%curr_groups));
                   7443:     my $allroles = [];
                   7444:     my $rolehash;
                   7445:     my $accesshash = {
                   7446:                      active => 'Currently has access',
                   7447:                      future => 'Will have future access',
                   7448:                      previous => 'Previously had access',
                   7449:                   };
                   7450:     if ($needroles) {
                   7451:         $rolehash = {'all' => 'all'};
1.385     albertel 7452:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7453: 	if (&Apache::lonnet::error(%user_roles)) {
                   7454: 	    undef(%user_roles);
                   7455: 	}
                   7456:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7457:             my ($role)=split(/\:/,$item,2);
                   7458:             if ($role eq 'cr') { next; }
                   7459:             if ($role =~ /^cr/) {
                   7460:                 $$rolehash{$role} = (split('/',$role))[3];
                   7461:             } else {
                   7462:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7463:             }
                   7464:         }
                   7465:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7466:             push(@{$allroles},$key);
                   7467:         }
                   7468:         push (@{$allroles},'st');
                   7469:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7470:     }
                   7471:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7472: }
                   7473: 
1.555     raeburn  7474: sub user_picker {
1.627     raeburn  7475:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7476:     my $currdom = $dom;
                   7477:     my %curr_selected = (
                   7478:                         srchin => 'dom',
1.580     raeburn  7479:                         srchby => 'lastname',
1.555     raeburn  7480:                       );
                   7481:     my $srchterm;
1.625     raeburn  7482:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7483:         if ($srch->{'srchby'} ne '') {
                   7484:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7485:         }
                   7486:         if ($srch->{'srchin'} ne '') {
                   7487:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7488:         }
                   7489:         if ($srch->{'srchtype'} ne '') {
                   7490:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7491:         }
                   7492:         if ($srch->{'srchdomain'} ne '') {
                   7493:             $currdom = $srch->{'srchdomain'};
                   7494:         }
                   7495:         $srchterm = $srch->{'srchterm'};
                   7496:     }
                   7497:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7498:                     'usr'       => 'Search criteria',
1.563     raeburn  7499:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7500:                     'uname'     => 'username',
                   7501:                     'lastname'  => 'last name',
1.555     raeburn  7502:                     'lastfirst' => 'last name, first name',
1.558     albertel 7503:                     'crs'       => 'in this course',
1.576     raeburn  7504:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7505:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7506:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7507:                     'exact'     => 'is',
                   7508:                     'contains'  => 'contains',
1.569     raeburn  7509:                     'begins'    => 'begins with',
1.571     raeburn  7510:                     'youm'      => "You must include some text to search for.",
                   7511:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7512:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7513:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7514:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7515:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7516:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7517:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7518:                                        );
1.563     raeburn  7519:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   7520:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  7521: 
                   7522:     my @srchins = ('crs','dom','alc','instd');
                   7523: 
                   7524:     foreach my $option (@srchins) {
                   7525:         # FIXME 'alc' option unavailable until 
                   7526:         #       loncreateuser::print_user_query_page()
                   7527:         #       has been completed.
                   7528:         next if ($option eq 'alc');
                   7529:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  7530:         if ($curr_selected{'srchin'} eq $option) {
                   7531:             $srchinsel .= ' 
                   7532:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7533:         } else {
                   7534:             $srchinsel .= '
                   7535:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7536:         }
1.555     raeburn  7537:     }
1.563     raeburn  7538:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7539: 
                   7540:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7541:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7542:         if ($curr_selected{'srchby'} eq $option) {
                   7543:             $srchbysel .= '
                   7544:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7545:         } else {
                   7546:             $srchbysel .= '
                   7547:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7548:          }
                   7549:     }
                   7550:     $srchbysel .= "\n  </select>\n";
                   7551: 
                   7552:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7553:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7554:         if ($curr_selected{'srchtype'} eq $option) {
                   7555:             $srchtypesel .= '
                   7556:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7557:         } else {
                   7558:             $srchtypesel .= '
                   7559:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7560:         }
                   7561:     }
                   7562:     $srchtypesel .= "\n  </select>\n";
                   7563: 
1.558     albertel 7564:     my ($newuserscript,$new_user_create);
1.556     raeburn  7565: 
                   7566:     if ($forcenewuser) {
1.576     raeburn  7567:         if (ref($srch) eq 'HASH') {
                   7568:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7569:                 if ($cancreate) {
                   7570:                     $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>';
                   7571:                 } else {
1.799     bisitz   7572:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7573:                     my %usertypetext = (
                   7574:                         official   => 'institutional',
                   7575:                         unofficial => 'non-institutional',
                   7576:                     );
1.799     bisitz   7577:                     $new_user_create = '<p class="LC_warning">'
                   7578:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   7579:                                       .' '
                   7580:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7581:                                           ,'<a href="'.$helplink.'">','</a>')
                   7582:                                       .'</p><br />';
1.627     raeburn  7583:                 }
1.576     raeburn  7584:             }
                   7585:         }
                   7586: 
1.556     raeburn  7587:         $newuserscript = <<"ENDSCRIPT";
                   7588: 
1.570     raeburn  7589: function setSearch(createnew,callingForm) {
1.556     raeburn  7590:     if (createnew == 1) {
1.570     raeburn  7591:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7592:             if (callingForm.srchby.options[i].value == 'uname') {
                   7593:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7594:             }
                   7595:         }
1.570     raeburn  7596:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7597:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7598: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7599:             }
                   7600:         }
1.570     raeburn  7601:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7602:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7603:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7604:             }
                   7605:         }
1.570     raeburn  7606:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7607:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7608:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7609:             }
                   7610:         }
                   7611:     }
                   7612: }
                   7613: ENDSCRIPT
1.558     albertel 7614: 
1.556     raeburn  7615:     }
                   7616: 
1.555     raeburn  7617:     my $output = <<"END_BLOCK";
1.556     raeburn  7618: <script type="text/javascript">
1.570     raeburn  7619: function validateEntry(callingForm) {
1.558     albertel 7620: 
1.556     raeburn  7621:     var checkok = 1;
1.558     albertel 7622:     var srchin;
1.570     raeburn  7623:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7624: 	if ( callingForm.srchin[i].checked ) {
                   7625: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7626: 	}
                   7627:     }
                   7628: 
1.570     raeburn  7629:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7630:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7631:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7632:     var srchterm =  callingForm.srchterm.value;
                   7633:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7634:     var msg = "";
                   7635: 
                   7636:     if (srchterm == "") {
                   7637:         checkok = 0;
1.571     raeburn  7638:         msg += "$lt{'youm'}\\n";
1.556     raeburn  7639:     }
                   7640: 
1.569     raeburn  7641:     if (srchtype== 'begins') {
                   7642:         if (srchterm.length < 2) {
                   7643:             checkok = 0;
1.571     raeburn  7644:             msg += "$lt{'thte'}\\n";
1.569     raeburn  7645:         }
                   7646:     }
                   7647: 
1.556     raeburn  7648:     if (srchtype== 'contains') {
                   7649:         if (srchterm.length < 3) {
                   7650:             checkok = 0;
1.571     raeburn  7651:             msg += "$lt{'thet'}\\n";
1.556     raeburn  7652:         }
                   7653:     }
                   7654:     if (srchin == 'instd') {
                   7655:         if (srchdomain == '') {
                   7656:             checkok = 0;
1.571     raeburn  7657:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  7658:         }
                   7659:     }
                   7660:     if (srchin == 'dom') {
                   7661:         if (srchdomain == '') {
                   7662:             checkok = 0;
1.571     raeburn  7663:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  7664:         }
                   7665:     }
                   7666:     if (srchby == 'lastfirst') {
                   7667:         if (srchterm.indexOf(",") == -1) {
                   7668:             checkok = 0;
1.571     raeburn  7669:             msg += "$lt{'whus'}\\n";
1.556     raeburn  7670:         }
                   7671:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   7672:             checkok = 0;
1.571     raeburn  7673:             msg += "$lt{'whse'}\\n";
1.556     raeburn  7674:         }
                   7675:     }
                   7676:     if (checkok == 0) {
1.571     raeburn  7677:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  7678:         return;
                   7679:     }
                   7680:     if (checkok == 1) {
1.570     raeburn  7681:         callingForm.submit();
1.556     raeburn  7682:     }
                   7683: }
                   7684: 
                   7685: $newuserscript
                   7686: 
                   7687: </script>
1.558     albertel 7688: 
                   7689: $new_user_create
                   7690: 
1.555     raeburn  7691: <table>
1.558     albertel 7692:  <tr>
1.573     raeburn  7693:   <td>$lt{'doma'}:</td>
                   7694:   <td>$domform</td>
                   7695:   </td>
                   7696:  </tr>
                   7697:  <tr>
                   7698:   <td>$lt{'usr'}:</td>
1.563     raeburn  7699:   <td>$srchbysel
                   7700:       $srchtypesel 
                   7701:       <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564     albertel 7702:       $srchinsel 
1.563     raeburn  7703:   </td>
                   7704:  </tr>
1.555     raeburn  7705: </table>
                   7706: <br />
                   7707: END_BLOCK
1.558     albertel 7708: 
1.555     raeburn  7709:     return $output;
                   7710: }
                   7711: 
1.612     raeburn  7712: sub user_rule_check {
1.615     raeburn  7713:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  7714:     my $response;
                   7715:     if (ref($usershash) eq 'HASH') {
                   7716:         foreach my $user (keys(%{$usershash})) {
                   7717:             my ($uname,$udom) = split(/:/,$user);
                   7718:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  7719:             my ($id,$newuser);
1.612     raeburn  7720:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  7721:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  7722:                 $id = $usershash->{$user}->{'id'};
                   7723:             }
                   7724:             my $inst_response;
                   7725:             if (ref($checks) eq 'HASH') {
                   7726:                 if (defined($checks->{'username'})) {
1.615     raeburn  7727:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  7728:                         &Apache::lonnet::get_instuser($udom,$uname);
                   7729:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  7730:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  7731:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   7732:                 }
1.615     raeburn  7733:             } else {
                   7734:                 ($inst_response,%{$inst_results->{$user}}) =
                   7735:                     &Apache::lonnet::get_instuser($udom,$uname);
                   7736:                 return;
1.612     raeburn  7737:             }
1.615     raeburn  7738:             if (!$got_rules->{$udom}) {
1.612     raeburn  7739:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   7740:                                                   ['usercreation'],$udom);
                   7741:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  7742:                     foreach my $item ('username','id') {
1.612     raeburn  7743:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   7744:                             $$curr_rules{$udom}{$item} = 
                   7745:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  7746:                         }
                   7747:                     }
                   7748:                 }
1.615     raeburn  7749:                 $got_rules->{$udom} = 1;  
1.585     raeburn  7750:             }
1.612     raeburn  7751:             foreach my $item (keys(%{$checks})) {
                   7752:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   7753:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   7754:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   7755:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   7756:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   7757:                                 if ($rule_check{$rule}) {
                   7758:                                     $$rulematch{$user}{$item} = $rule;
                   7759:                                     if ($inst_response eq 'ok') {
1.615     raeburn  7760:                                         if (ref($inst_results) eq 'HASH') {
                   7761:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   7762:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   7763:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   7764:                                                 }
1.612     raeburn  7765:                                             }
                   7766:                                         }
1.615     raeburn  7767:                                     }
                   7768:                                     last;
1.585     raeburn  7769:                                 }
                   7770:                             }
                   7771:                         }
                   7772:                     }
                   7773:                 }
                   7774:             }
                   7775:         }
                   7776:     }
1.612     raeburn  7777:     return;
                   7778: }
                   7779: 
                   7780: sub user_rule_formats {
                   7781:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   7782:     my %text = ( 
                   7783:                  'username' => 'Usernames',
                   7784:                  'id'       => 'IDs',
                   7785:                );
                   7786:     my $output;
                   7787:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   7788:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   7789:         if (@{$ruleorder} > 0) {
                   7790:             $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>';
                   7791:             foreach my $rule (@{$ruleorder}) {
                   7792:                 if (ref($curr_rules) eq 'ARRAY') {
                   7793:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   7794:                         if (ref($rules->{$rule}) eq 'HASH') {
                   7795:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   7796:                                         $rules->{$rule}{'desc'}.'</li>';
                   7797:                         }
                   7798:                     }
                   7799:                 }
                   7800:             }
                   7801:             $output .= '</ul>';
                   7802:         }
                   7803:     }
                   7804:     return $output;
                   7805: }
                   7806: 
                   7807: sub instrule_disallow_msg {
1.615     raeburn  7808:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  7809:     my $response;
                   7810:     my %text = (
                   7811:                   item   => 'username',
                   7812:                   items  => 'usernames',
                   7813:                   match  => 'matches',
                   7814:                   do     => 'does',
                   7815:                   action => 'a username',
                   7816:                   one    => 'one',
                   7817:                );
                   7818:     if ($count > 1) {
                   7819:         $text{'item'} = 'usernames';
                   7820:         $text{'match'} ='match';
                   7821:         $text{'do'} = 'do';
                   7822:         $text{'action'} = 'usernames',
                   7823:         $text{'one'} = 'ones';
                   7824:     }
                   7825:     if ($checkitem eq 'id') {
                   7826:         $text{'items'} = 'IDs';
                   7827:         $text{'item'} = 'ID';
                   7828:         $text{'action'} = 'an ID';
1.615     raeburn  7829:         if ($count > 1) {
                   7830:             $text{'item'} = 'IDs';
                   7831:             $text{'action'} = 'IDs';
                   7832:         }
1.612     raeburn  7833:     }
1.674     bisitz   7834:     $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  7835:     if ($mode eq 'upload') {
                   7836:         if ($checkitem eq 'username') {
                   7837:             $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'}.");
                   7838:         } elsif ($checkitem eq 'id') {
1.674     bisitz   7839:             $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  7840:         }
1.669     raeburn  7841:     } elsif ($mode eq 'selfcreate') {
                   7842:         if ($checkitem eq 'id') {
                   7843:             $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.");
                   7844:         }
1.615     raeburn  7845:     } else {
                   7846:         if ($checkitem eq 'username') {
                   7847:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   7848:         } elsif ($checkitem eq 'id') {
                   7849:             $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.");
                   7850:         }
1.612     raeburn  7851:     }
                   7852:     return $response;
1.585     raeburn  7853: }
                   7854: 
1.624     raeburn  7855: sub personal_data_fieldtitles {
                   7856:     my %fieldtitles = &Apache::lonlocal::texthash (
                   7857:                         id => 'Student/Employee ID',
                   7858:                         permanentemail => 'E-mail address',
                   7859:                         lastname => 'Last Name',
                   7860:                         firstname => 'First Name',
                   7861:                         middlename => 'Middle Name',
                   7862:                         generation => 'Generation',
                   7863:                         gen => 'Generation',
1.765     raeburn  7864:                         inststatus => 'Affiliation',
1.624     raeburn  7865:                    );
                   7866:     return %fieldtitles;
                   7867: }
                   7868: 
1.642     raeburn  7869: sub sorted_inst_types {
                   7870:     my ($dom) = @_;
                   7871:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   7872:     my $othertitle = &mt('All users');
                   7873:     if ($env{'request.course.id'}) {
1.668     raeburn  7874:         $othertitle  = &mt('Any users');
1.642     raeburn  7875:     }
                   7876:     my @types;
                   7877:     if (ref($order) eq 'ARRAY') {
                   7878:         @types = @{$order};
                   7879:     }
                   7880:     if (@types == 0) {
                   7881:         if (ref($usertypes) eq 'HASH') {
                   7882:             @types = sort(keys(%{$usertypes}));
                   7883:         }
                   7884:     }
                   7885:     if (keys(%{$usertypes}) > 0) {
                   7886:         $othertitle = &mt('Other users');
                   7887:     }
                   7888:     return ($othertitle,$usertypes,\@types);
                   7889: }
                   7890: 
1.645     raeburn  7891: sub get_institutional_codes {
                   7892:     my ($settings,$allcourses,$LC_code) = @_;
                   7893: # Get complete list of course sections to update
                   7894:     my @currsections = ();
                   7895:     my @currxlists = ();
                   7896:     my $coursecode = $$settings{'internal.coursecode'};
                   7897: 
                   7898:     if ($$settings{'internal.sectionnums'} ne '') {
                   7899:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   7900:     }
                   7901: 
                   7902:     if ($$settings{'internal.crosslistings'} ne '') {
                   7903:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   7904:     }
                   7905: 
                   7906:     if (@currxlists > 0) {
                   7907:         foreach (@currxlists) {
                   7908:             if (m/^([^:]+):(\w*)$/) {
                   7909:                 unless (grep/^$1$/,@{$allcourses}) {
                   7910:                     push @{$allcourses},$1;
                   7911:                     $$LC_code{$1} = $2;
                   7912:                 }
                   7913:             }
                   7914:         }
                   7915:     }
                   7916:  
                   7917:     if (@currsections > 0) {
                   7918:         foreach (@currsections) {
                   7919:             if (m/^(\w+):(\w*)$/) {
                   7920:                 my $sec = $coursecode.$1;
                   7921:                 my $lc_sec = $2;
                   7922:                 unless (grep/^$sec$/,@{$allcourses}) {
                   7923:                     push @{$allcourses},$sec;
                   7924:                     $$LC_code{$sec} = $lc_sec;
                   7925:                 }
                   7926:             }
                   7927:         }
                   7928:     }
                   7929:     return;
                   7930: }
                   7931: 
1.112     bowersj2 7932: =pod
                   7933: 
1.780     raeburn  7934: =head1 Slot Helpers
                   7935: 
                   7936: =over 4
                   7937: 
                   7938: =item * sorted_slots()
                   7939: 
                   7940: Sorts an array of slot names in order of slot start time (earliest first). 
                   7941: 
                   7942: Inputs:
                   7943: 
                   7944: =over 4
                   7945: 
                   7946: slotsarr  - Reference to array of unsorted slot names.
                   7947: 
                   7948: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   7949: 
1.549     albertel 7950: =back
                   7951: 
1.780     raeburn  7952: Returns:
                   7953: 
                   7954: =over 4
                   7955: 
                   7956: sorted   - An array of slot names sorted by the start time of the slot.
                   7957: 
                   7958: =back
                   7959: 
                   7960: =back
                   7961: 
                   7962: =cut
                   7963: 
                   7964: 
                   7965: sub sorted_slots {
                   7966:     my ($slotsarr,$slots) = @_;
                   7967:     my @sorted;
                   7968:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   7969:         @sorted =
                   7970:             sort {
                   7971:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   7972:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   7973:                      }
                   7974:                      if (ref($slots->{$a})) { return -1;}
                   7975:                      if (ref($slots->{$b})) { return 1;}
                   7976:                      return 0;
                   7977:                  } @{$slotsarr};
                   7978:     }
                   7979:     return @sorted;
                   7980: }
                   7981: 
                   7982: 
                   7983: =pod
                   7984: 
1.549     albertel 7985: =head1 HTTP Helpers
                   7986: 
                   7987: =over 4
                   7988: 
1.648     raeburn  7989: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 7990: 
1.258     albertel 7991: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 7992: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 7993: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 7994: 
                   7995: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   7996: $possible_names is an ref to an array of form element names.  As an example:
                   7997: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 7998: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 7999: 
                   8000: =cut
1.1       albertel 8001: 
1.6       albertel 8002: sub get_unprocessed_cgi {
1.25      albertel 8003:   my ($query,$possible_names)= @_;
1.26      matthew  8004:   # $Apache::lonxml::debug=1;
1.356     albertel 8005:   foreach my $pair (split(/&/,$query)) {
                   8006:     my ($name, $value) = split(/=/,$pair);
1.369     www      8007:     $name = &unescape($name);
1.25      albertel 8008:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8009:       $value =~ tr/+/ /;
                   8010:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8011:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8012:     }
1.16      harris41 8013:   }
1.6       albertel 8014: }
                   8015: 
1.112     bowersj2 8016: =pod
                   8017: 
1.648     raeburn  8018: =item * &cacheheader() 
1.112     bowersj2 8019: 
                   8020: returns cache-controlling header code
                   8021: 
                   8022: =cut
                   8023: 
1.7       albertel 8024: sub cacheheader {
1.258     albertel 8025:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8026:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8027:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8028:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8029:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8030:     return $output;
1.7       albertel 8031: }
                   8032: 
1.112     bowersj2 8033: =pod
                   8034: 
1.648     raeburn  8035: =item * &no_cache($r) 
1.112     bowersj2 8036: 
                   8037: specifies header code to not have cache
                   8038: 
                   8039: =cut
                   8040: 
1.9       albertel 8041: sub no_cache {
1.216     albertel 8042:     my ($r) = @_;
                   8043:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8044: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8045:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8046:     $r->no_cache(1);
                   8047:     $r->header_out("Expires" => $date);
                   8048:     $r->header_out("Pragma" => "no-cache");
1.123     www      8049: }
                   8050: 
                   8051: sub content_type {
1.181     albertel 8052:     my ($r,$type,$charset) = @_;
1.299     foxr     8053:     if ($r) {
                   8054: 	#  Note that printout.pl calls this with undef for $r.
                   8055: 	&no_cache($r);
                   8056:     }
1.258     albertel 8057:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8058:     unless ($charset) {
                   8059: 	$charset=&Apache::lonlocal::current_encoding;
                   8060:     }
                   8061:     if ($charset) { $type.='; charset='.$charset; }
                   8062:     if ($r) {
                   8063: 	$r->content_type($type);
                   8064:     } else {
                   8065: 	print("Content-type: $type\n\n");
                   8066:     }
1.9       albertel 8067: }
1.25      albertel 8068: 
1.112     bowersj2 8069: =pod
                   8070: 
1.648     raeburn  8071: =item * &add_to_env($name,$value) 
1.112     bowersj2 8072: 
1.258     albertel 8073: adds $name to the %env hash with value
1.112     bowersj2 8074: $value, if $name already exists, the entry is converted to an array
                   8075: reference and $value is added to the array.
                   8076: 
                   8077: =cut
                   8078: 
1.25      albertel 8079: sub add_to_env {
                   8080:   my ($name,$value)=@_;
1.258     albertel 8081:   if (defined($env{$name})) {
                   8082:     if (ref($env{$name})) {
1.25      albertel 8083:       #already have multiple values
1.258     albertel 8084:       push(@{ $env{$name} },$value);
1.25      albertel 8085:     } else {
                   8086:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8087:       my $first=$env{$name};
                   8088:       undef($env{$name});
                   8089:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8090:     }
                   8091:   } else {
1.258     albertel 8092:     $env{$name}=$value;
1.25      albertel 8093:   }
1.31      albertel 8094: }
1.149     albertel 8095: 
                   8096: =pod
                   8097: 
1.648     raeburn  8098: =item * &get_env_multiple($name) 
1.149     albertel 8099: 
1.258     albertel 8100: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8101: values may be defined and end up as an array ref.
                   8102: 
                   8103: returns an array of values
                   8104: 
                   8105: =cut
                   8106: 
                   8107: sub get_env_multiple {
                   8108:     my ($name) = @_;
                   8109:     my @values;
1.258     albertel 8110:     if (defined($env{$name})) {
1.149     albertel 8111:         # exists is it an array
1.258     albertel 8112:         if (ref($env{$name})) {
                   8113:             @values=@{ $env{$name} };
1.149     albertel 8114:         } else {
1.258     albertel 8115:             $values[0]=$env{$name};
1.149     albertel 8116:         }
                   8117:     }
                   8118:     return(@values);
                   8119: }
                   8120: 
1.660     raeburn  8121: sub ask_for_embedded_content {
                   8122:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8123:     my $upload_output = '
                   8124:    <form name="upload_embedded" action="'.$actionurl.'"
                   8125:                   method="post" enctype="multipart/form-data">';
                   8126:     $upload_output .= $state;
1.661     raeburn  8127:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8128: 
                   8129:     my $num = 0;
                   8130:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8131:         $upload_output .= &start_data_table_row().
                   8132:             '<td>'.$embed_file.'</td><td>';
                   8133:         if ($args->{'ignore_remote_references'}
                   8134:             && $embed_file =~ m{^\w+://}) {
                   8135:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8136:         } elsif ($args->{'error_on_invalid_names'}
                   8137:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8138: 
                   8139:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8140: 
                   8141:         } else {
                   8142:             $upload_output .='
1.661     raeburn  8143:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8144:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8145:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8146:             $upload_output .=
                   8147:                 "\n\t\t".
                   8148:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8149:                 $attrib.'" />';
                   8150:             if (exists($$codebase{$embed_file})) {
                   8151:                 $upload_output .=
                   8152:                     "\n\t\t".
                   8153:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8154:                     &escape($$codebase{$embed_file}).'" />';
                   8155:             }
                   8156:         }
                   8157:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8158:         $num++;
                   8159:     }
                   8160:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8161:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8162:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8163:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8164:    </form>';
                   8165:     return $upload_output;
                   8166: }
                   8167: 
1.661     raeburn  8168: sub upload_embedded {
                   8169:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8170:         $current_disk_usage) = @_;
                   8171:     my $output;
                   8172:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8173:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8174:         my $orig_uploaded_filename =
                   8175:             $env{'form.embedded_item_'.$i.'.filename'};
                   8176: 
                   8177:         $env{'form.embedded_orig_'.$i} =
                   8178:             &unescape($env{'form.embedded_orig_'.$i});
                   8179:         my ($path,$fname) =
                   8180:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8181:         # no path, whole string is fname
                   8182:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8183: 
                   8184:         $path = $env{'form.currentpath'}.$path;
                   8185:         $fname = &Apache::lonnet::clean_filename($fname);
                   8186:         # See if there is anything left
                   8187:         next if ($fname eq '');
                   8188: 
                   8189:         # Check if file already exists as a file or directory.
                   8190:         my ($state,$msg);
                   8191:         if ($context eq 'portfolio') {
                   8192:             my $port_path = $dirpath;
                   8193:             if ($group ne '') {
                   8194:                 $port_path = "groups/$group/$port_path";
                   8195:             }
                   8196:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8197:                                               $dir_root,$port_path,$disk_quota,
                   8198:                                               $current_disk_usage,$uname,$udom);
                   8199:             if ($state eq 'will_exceed_quota'
                   8200:                 || $state eq 'file_locked'
                   8201:                 || $state eq 'file_exists' ) {
                   8202:                 $output .= $msg;
                   8203:                 next;
                   8204:             }
                   8205:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8206:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8207:             if ($state eq 'exists') {
                   8208:                 $output .= $msg;
                   8209:                 next;
                   8210:             }
                   8211:         }
                   8212:         # Check if extension is valid
                   8213:         if (($fname =~ /\.(\w+)$/) &&
                   8214:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8215:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8216:             next;
                   8217:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8218:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8219:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8220:             next;
                   8221:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8222:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8223:             next;
                   8224:         }
                   8225: 
                   8226:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8227:         if ($context eq 'portfolio') {
                   8228:             my $result=
                   8229:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8230:                                                 $dirpath.$path);
                   8231:             if ($result !~ m|^/uploaded/|) {
                   8232:                 $output .= '<span class="LC_error">'
                   8233:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8234:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8235:                       .'</span><br />';
                   8236:                 next;
                   8237:             } else {
                   8238:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8239:                            $path.$fname.'</span>').'</p>';     
                   8240:             }
                   8241:         } else {
                   8242: # Save the file
                   8243:             my $target = $env{'form.embedded_item_'.$i};
                   8244:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8245:             my $dest = $fullpath.$fname;
                   8246:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8247:             my @parts=split(/\//,$fullpath);
                   8248:             my $count;
                   8249:             my $filepath = $dir_root;
                   8250:             for ($count=4;$count<=$#parts;$count++) {
                   8251:                 $filepath .= "/$parts[$count]";
                   8252:                 if ((-e $filepath)!=1) {
                   8253:                     mkdir($filepath,0770);
                   8254:                 }
                   8255:             }
                   8256:             my $fh;
                   8257:             if (!open($fh,'>'.$dest)) {
                   8258:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8259:                 $output .= '<span class="LC_error">'.
                   8260:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8261:                            '</span><br />';
                   8262:             } else {
                   8263:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8264:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8265:                     $output .= '<span class="LC_error">'.
                   8266:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8267:                               '</span><br />';
                   8268:                 } else {
                   8269:                     if ($context eq 'testbank') {
                   8270:                         $output .= &mt('Embedded file uploaded successfully:').
                   8271:                                    '&nbsp;<a href="'.$url.'">'.
                   8272:                                    $orig_uploaded_filename.'</a><br />';
                   8273:                     } else {
1.705     tempelho 8274:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8275:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8276:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8277:                     }
                   8278:                 }
                   8279:                 close($fh);
                   8280:             }
                   8281:         }
                   8282:     }
                   8283:     return $output;
                   8284: }
                   8285: 
                   8286: sub check_for_existing {
                   8287:     my ($path,$fname,$element) = @_;
                   8288:     my ($state,$msg);
                   8289:     if (-d $path.'/'.$fname) {
                   8290:         $state = 'exists';
                   8291:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8292:     } elsif (-e $path.'/'.$fname) {
                   8293:         $state = 'exists';
                   8294:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8295:     }
                   8296:     if ($state eq 'exists') {
                   8297:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8298:     }
                   8299:     return ($state,$msg);
                   8300: }
                   8301: 
                   8302: sub check_for_upload {
                   8303:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8304:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8305:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8306:     my $getpropath = 1;
                   8307:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8308:                                             $getpropath);
                   8309:     my $found_file = 0;
                   8310:     my $locked_file = 0;
                   8311:     foreach my $line (@dir_list) {
                   8312:         my ($file_name)=split(/\&/,$line,2);
                   8313:         if ($file_name eq $fname){
                   8314:             $file_name = $path.$file_name;
                   8315:             if ($group ne '') {
                   8316:                 $file_name = $group.$file_name;
                   8317:             }
                   8318:             $found_file = 1;
                   8319:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8320:                 $locked_file = 1;
                   8321:             }
                   8322:         }
                   8323:     }
                   8324:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8325:         my $msg = '<span class="LC_error">'.
                   8326:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8327:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8328:         return ('will_exceed_quota',$msg);
                   8329:     } elsif ($found_file) {
                   8330:         if ($locked_file) {
                   8331:             my $msg = '<span class="LC_error">';
                   8332:             $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>');
                   8333:             $msg .= '</span><br />';
                   8334:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8335:             return ('file_locked',$msg);
                   8336:         } else {
                   8337:             my $msg = '<span class="LC_error">';
                   8338:             $msg .= &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
                   8339:             $msg .= '</span>';
                   8340:             $msg .= '<br />';
                   8341:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8342:             return ('file_exists',$msg);
                   8343:         }
                   8344:     }
                   8345: }
                   8346: 
1.31      albertel 8347: 
1.41      ng       8348: =pod
1.45      matthew  8349: 
1.464     albertel 8350: =back
1.41      ng       8351: 
1.112     bowersj2 8352: =head1 CSV Upload/Handling functions
1.38      albertel 8353: 
1.41      ng       8354: =over 4
                   8355: 
1.648     raeburn  8356: =item * &upfile_store($r)
1.41      ng       8357: 
                   8358: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8359: needs $env{'form.upfile'}
1.41      ng       8360: returns $datatoken to be put into hidden field
                   8361: 
                   8362: =cut
1.31      albertel 8363: 
                   8364: sub upfile_store {
                   8365:     my $r=shift;
1.258     albertel 8366:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8367:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8368:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8369:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8370: 
1.258     albertel 8371:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8372: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8373:     {
1.158     raeburn  8374:         my $datafile = $r->dir_config('lonDaemons').
                   8375:                            '/tmp/'.$datatoken.'.tmp';
                   8376:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8377:             print $fh $env{'form.upfile'};
1.158     raeburn  8378:             close($fh);
                   8379:         }
1.31      albertel 8380:     }
                   8381:     return $datatoken;
                   8382: }
                   8383: 
1.56      matthew  8384: =pod
                   8385: 
1.648     raeburn  8386: =item * &load_tmp_file($r)
1.41      ng       8387: 
                   8388: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8389: needs $env{'form.datatoken'},
                   8390: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8391: 
                   8392: =cut
1.31      albertel 8393: 
                   8394: sub load_tmp_file {
                   8395:     my $r=shift;
                   8396:     my @studentdata=();
                   8397:     {
1.158     raeburn  8398:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8399:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8400:         if ( open(my $fh,"<$studentfile") ) {
                   8401:             @studentdata=<$fh>;
                   8402:             close($fh);
                   8403:         }
1.31      albertel 8404:     }
1.258     albertel 8405:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8406: }
                   8407: 
1.56      matthew  8408: =pod
                   8409: 
1.648     raeburn  8410: =item * &upfile_record_sep()
1.41      ng       8411: 
                   8412: Separate uploaded file into records
                   8413: returns array of records,
1.258     albertel 8414: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8415: 
                   8416: =cut
1.31      albertel 8417: 
                   8418: sub upfile_record_sep {
1.258     albertel 8419:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8420:     } else {
1.248     albertel 8421: 	my @records;
1.258     albertel 8422: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8423: 	    if ($line=~/^\s*$/) { next; }
                   8424: 	    push(@records,$line);
                   8425: 	}
                   8426: 	return @records;
1.31      albertel 8427:     }
                   8428: }
                   8429: 
1.56      matthew  8430: =pod
                   8431: 
1.648     raeburn  8432: =item * &record_sep($record)
1.41      ng       8433: 
1.258     albertel 8434: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8435: 
                   8436: =cut
                   8437: 
1.263     www      8438: sub takeleft {
                   8439:     my $index=shift;
                   8440:     return substr('0000'.$index,-4,4);
                   8441: }
                   8442: 
1.31      albertel 8443: sub record_sep {
                   8444:     my $record=shift;
                   8445:     my %components=();
1.258     albertel 8446:     if ($env{'form.upfiletype'} eq 'xml') {
                   8447:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8448:         my $i=0;
1.356     albertel 8449:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8450:             $field=~s/^(\"|\')//;
                   8451:             $field=~s/(\"|\')$//;
1.263     www      8452:             $components{&takeleft($i)}=$field;
1.31      albertel 8453:             $i++;
                   8454:         }
1.258     albertel 8455:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8456:         my $i=0;
1.356     albertel 8457:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8458:             $field=~s/^(\"|\')//;
                   8459:             $field=~s/(\"|\')$//;
1.263     www      8460:             $components{&takeleft($i)}=$field;
1.31      albertel 8461:             $i++;
                   8462:         }
                   8463:     } else {
1.561     www      8464:         my $separator=',';
1.480     banghart 8465:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8466:             $separator=';';
1.480     banghart 8467:         }
1.31      albertel 8468:         my $i=0;
1.561     www      8469: # the character we are looking for to indicate the end of a quote or a record 
                   8470:         my $looking_for=$separator;
                   8471: # do not add the characters to the fields
                   8472:         my $ignore=0;
                   8473: # we just encountered a separator (or the beginning of the record)
                   8474:         my $just_found_separator=1;
                   8475: # store the field we are working on here
                   8476:         my $field='';
                   8477: # work our way through all characters in record
                   8478:         foreach my $character ($record=~/(.)/g) {
                   8479:             if ($character eq $looking_for) {
                   8480:                if ($character ne $separator) {
                   8481: # Found the end of a quote, again looking for separator
                   8482:                   $looking_for=$separator;
                   8483:                   $ignore=1;
                   8484:                } else {
                   8485: # Found a separator, store away what we got
                   8486:                   $components{&takeleft($i)}=$field;
                   8487: 	          $i++;
                   8488:                   $just_found_separator=1;
                   8489:                   $ignore=0;
                   8490:                   $field='';
                   8491:                }
                   8492:                next;
                   8493:             }
                   8494: # single or double quotation marks after a separator indicate beginning of a quote
                   8495: # we are now looking for the end of the quote and need to ignore separators
                   8496:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8497:                $looking_for=$character;
                   8498:                next;
                   8499:             }
                   8500: # ignore would be true after we reached the end of a quote
                   8501:             if ($ignore) { next; }
                   8502:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8503:             $field.=$character;
                   8504:             $just_found_separator=0; 
1.31      albertel 8505:         }
1.561     www      8506: # catch the very last entry, since we never encountered the separator
                   8507:         $components{&takeleft($i)}=$field;
1.31      albertel 8508:     }
                   8509:     return %components;
                   8510: }
                   8511: 
1.144     matthew  8512: ######################################################
                   8513: ######################################################
                   8514: 
1.56      matthew  8515: =pod
                   8516: 
1.648     raeburn  8517: =item * &upfile_select_html()
1.41      ng       8518: 
1.144     matthew  8519: Return HTML code to select a file from the users machine and specify 
                   8520: the file type.
1.41      ng       8521: 
                   8522: =cut
                   8523: 
1.144     matthew  8524: ######################################################
                   8525: ######################################################
1.31      albertel 8526: sub upfile_select_html {
1.144     matthew  8527:     my %Types = (
                   8528:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8529:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8530:                  space => &mt('Space separated'),
                   8531:                  tab   => &mt('Tabulator separated'),
                   8532: #                 xml   => &mt('HTML/XML'),
                   8533:                  );
                   8534:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8535:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8536:     foreach my $type (sort(keys(%Types))) {
                   8537:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8538:     }
                   8539:     $Str .= "</select>\n";
                   8540:     return $Str;
1.31      albertel 8541: }
                   8542: 
1.301     albertel 8543: sub get_samples {
                   8544:     my ($records,$toget) = @_;
                   8545:     my @samples=({});
                   8546:     my $got=0;
                   8547:     foreach my $rec (@$records) {
                   8548: 	my %temp = &record_sep($rec);
                   8549: 	if (! grep(/\S/, values(%temp))) { next; }
                   8550: 	if (%temp) {
                   8551: 	    $samples[$got]=\%temp;
                   8552: 	    $got++;
                   8553: 	    if ($got == $toget) { last; }
                   8554: 	}
                   8555:     }
                   8556:     return \@samples;
                   8557: }
                   8558: 
1.144     matthew  8559: ######################################################
                   8560: ######################################################
                   8561: 
1.56      matthew  8562: =pod
                   8563: 
1.648     raeburn  8564: =item * &csv_print_samples($r,$records)
1.41      ng       8565: 
                   8566: Prints a table of sample values from each column uploaded $r is an
                   8567: Apache Request ref, $records is an arrayref from
                   8568: &Apache::loncommon::upfile_record_sep
                   8569: 
                   8570: =cut
                   8571: 
1.144     matthew  8572: ######################################################
                   8573: ######################################################
1.31      albertel 8574: sub csv_print_samples {
                   8575:     my ($r,$records) = @_;
1.662     bisitz   8576:     my $samples = &get_samples($records,5);
1.301     albertel 8577: 
1.594     raeburn  8578:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8579:               &start_data_table_header_row());
1.356     albertel 8580:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
                   8581:         $r->print('<th>'.&mt('Column&nbsp;[_1]',($sample+1)).'</th>'); }
1.594     raeburn  8582:     $r->print(&end_data_table_header_row());
1.301     albertel 8583:     foreach my $hash (@$samples) {
1.594     raeburn  8584: 	$r->print(&start_data_table_row());
1.356     albertel 8585: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8586: 	    $r->print('<td>');
1.356     albertel 8587: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8588: 	    $r->print('</td>');
                   8589: 	}
1.594     raeburn  8590: 	$r->print(&end_data_table_row());
1.31      albertel 8591:     }
1.594     raeburn  8592:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8593: }
                   8594: 
1.144     matthew  8595: ######################################################
                   8596: ######################################################
                   8597: 
1.56      matthew  8598: =pod
                   8599: 
1.648     raeburn  8600: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8601: 
                   8602: Prints a table to create associations between values and table columns.
1.144     matthew  8603: 
1.41      ng       8604: $r is an Apache Request ref,
                   8605: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8606: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8607: 
                   8608: =cut
                   8609: 
1.144     matthew  8610: ######################################################
                   8611: ######################################################
1.31      albertel 8612: sub csv_print_select_table {
                   8613:     my ($r,$records,$d) = @_;
1.301     albertel 8614:     my $i=0;
                   8615:     my $samples = &get_samples($records,1);
1.144     matthew  8616:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8617: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8618:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8619:               '<th>'.&mt('Column').'</th>'.
                   8620:               &end_data_table_header_row()."\n");
1.356     albertel 8621:     foreach my $array_ref (@$d) {
                   8622: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8623: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8624: 
                   8625: 	$r->print('<td><select name=f'.$i.
1.32      matthew  8626: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8627: 	$r->print('<option value="none"></option>');
1.356     albertel 8628: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8629: 	    $r->print('<option value="'.$sample.'"'.
                   8630:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8631:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8632: 	}
1.594     raeburn  8633: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8634: 	$i++;
                   8635:     }
1.594     raeburn  8636:     $r->print(&end_data_table());
1.31      albertel 8637:     $i--;
                   8638:     return $i;
                   8639: }
1.56      matthew  8640: 
1.144     matthew  8641: ######################################################
                   8642: ######################################################
                   8643: 
1.56      matthew  8644: =pod
1.31      albertel 8645: 
1.648     raeburn  8646: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       8647: 
                   8648: Prints a table of sample values from the upload and can make associate samples to internal names.
                   8649: 
                   8650: $r is an Apache Request ref,
                   8651: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   8652: $d is an array of 2 element arrays (internal name, displayed name)
                   8653: 
                   8654: =cut
                   8655: 
1.144     matthew  8656: ######################################################
                   8657: ######################################################
1.31      albertel 8658: sub csv_samples_select_table {
                   8659:     my ($r,$records,$d) = @_;
                   8660:     my $i=0;
1.144     matthew  8661:     #
1.662     bisitz   8662:     my $max_samples = 5;
                   8663:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  8664:     $r->print(&start_data_table().
                   8665:               &start_data_table_header_row().'<th>'.
                   8666:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   8667:               &end_data_table_header_row());
1.301     albertel 8668: 
                   8669:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  8670: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  8671: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 8672: 	foreach my $option (@$d) {
                   8673: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  8674: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 8675:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  8676:                       $display.'</option>');
1.31      albertel 8677: 	}
                   8678: 	$r->print('</select></td><td>');
1.662     bisitz   8679: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 8680: 	    if (defined($samples->[$line]{$key})) { 
                   8681: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   8682: 	    }
                   8683: 	}
1.594     raeburn  8684: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 8685: 	$i++;
                   8686:     }
1.594     raeburn  8687:     $r->print(&end_data_table());
1.31      albertel 8688:     $i--;
                   8689:     return($i);
1.115     matthew  8690: }
                   8691: 
1.144     matthew  8692: ######################################################
                   8693: ######################################################
                   8694: 
1.115     matthew  8695: =pod
                   8696: 
1.648     raeburn  8697: =item * &clean_excel_name($name)
1.115     matthew  8698: 
                   8699: Returns a replacement for $name which does not contain any illegal characters.
                   8700: 
                   8701: =cut
                   8702: 
1.144     matthew  8703: ######################################################
                   8704: ######################################################
1.115     matthew  8705: sub clean_excel_name {
                   8706:     my ($name) = @_;
                   8707:     $name =~ s/[:\*\?\/\\]//g;
                   8708:     if (length($name) > 31) {
                   8709:         $name = substr($name,0,31);
                   8710:     }
                   8711:     return $name;
1.25      albertel 8712: }
1.84      albertel 8713: 
1.85      albertel 8714: =pod
                   8715: 
1.648     raeburn  8716: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 8717: 
                   8718: Returns either 1 or undef
                   8719: 
                   8720: 1 if the part is to be hidden, undef if it is to be shown
                   8721: 
                   8722: Arguments are:
                   8723: 
                   8724: $id the id of the part to be checked
                   8725: $symb, optional the symb of the resource to check
                   8726: $udom, optional the domain of the user to check for
                   8727: $uname, optional the username of the user to check for
                   8728: 
                   8729: =cut
1.84      albertel 8730: 
                   8731: sub check_if_partid_hidden {
                   8732:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 8733:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 8734: 					 $symb,$udom,$uname);
1.141     albertel 8735:     my $truth=1;
                   8736:     #if the string starts with !, then the list is the list to show not hide
                   8737:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 8738:     my @hiddenlist=split(/,/,$hiddenparts);
                   8739:     foreach my $checkid (@hiddenlist) {
1.141     albertel 8740: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 8741:     }
1.141     albertel 8742:     return !$truth;
1.84      albertel 8743: }
1.127     matthew  8744: 
1.138     matthew  8745: 
                   8746: ############################################################
                   8747: ############################################################
                   8748: 
                   8749: =pod
                   8750: 
1.157     matthew  8751: =back 
                   8752: 
1.138     matthew  8753: =head1 cgi-bin script and graphing routines
                   8754: 
1.157     matthew  8755: =over 4
                   8756: 
1.648     raeburn  8757: =item * &get_cgi_id()
1.138     matthew  8758: 
                   8759: Inputs: none
                   8760: 
                   8761: Returns an id which can be used to pass environment variables
                   8762: to various cgi-bin scripts.  These environment variables will
                   8763: be removed from the users environment after a given time by
                   8764: the routine &Apache::lonnet::transfer_profile_to_env.
                   8765: 
                   8766: =cut
                   8767: 
                   8768: ############################################################
                   8769: ############################################################
1.152     albertel 8770: my $uniq=0;
1.136     matthew  8771: sub get_cgi_id {
1.154     albertel 8772:     $uniq=($uniq+1)%100000;
1.280     albertel 8773:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  8774: }
                   8775: 
1.127     matthew  8776: ############################################################
                   8777: ############################################################
                   8778: 
                   8779: =pod
                   8780: 
1.648     raeburn  8781: =item * &DrawBarGraph()
1.127     matthew  8782: 
1.138     matthew  8783: Facilitates the plotting of data in a (stacked) bar graph.
                   8784: Puts plot definition data into the users environment in order for 
                   8785: graph.png to plot it.  Returns an <img> tag for the plot.
                   8786: The bars on the plot are labeled '1','2',...,'n'.
                   8787: 
                   8788: Inputs:
                   8789: 
                   8790: =over 4
                   8791: 
                   8792: =item $Title: string, the title of the plot
                   8793: 
                   8794: =item $xlabel: string, text describing the X-axis of the plot
                   8795: 
                   8796: =item $ylabel: string, text describing the Y-axis of the plot
                   8797: 
                   8798: =item $Max: scalar, the maximum Y value to use in the plot
                   8799: If $Max is < any data point, the graph will not be rendered.
                   8800: 
1.140     matthew  8801: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  8802: they are plotted.  If undefined, default values will be used.
                   8803: 
1.178     matthew  8804: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   8805: 
1.138     matthew  8806: =item @Values: An array of array references.  Each array reference holds data
                   8807: to be plotted in a stacked bar chart.
                   8808: 
1.239     matthew  8809: =item If the final element of @Values is a hash reference the key/value
                   8810: pairs will be added to the graph definition.
                   8811: 
1.138     matthew  8812: =back
                   8813: 
                   8814: Returns:
                   8815: 
                   8816: An <img> tag which references graph.png and the appropriate identifying
                   8817: information for the plot.
                   8818: 
1.127     matthew  8819: =cut
                   8820: 
                   8821: ############################################################
                   8822: ############################################################
1.134     matthew  8823: sub DrawBarGraph {
1.178     matthew  8824:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  8825:     #
                   8826:     if (! defined($colors)) {
                   8827:         $colors = ['#33ff00', 
                   8828:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   8829:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   8830:                   ]; 
                   8831:     }
1.228     matthew  8832:     my $extra_settings = {};
                   8833:     if (ref($Values[-1]) eq 'HASH') {
                   8834:         $extra_settings = pop(@Values);
                   8835:     }
1.127     matthew  8836:     #
1.136     matthew  8837:     my $identifier = &get_cgi_id();
                   8838:     my $id = 'cgi.'.$identifier;        
1.129     matthew  8839:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  8840:         return '';
                   8841:     }
1.225     matthew  8842:     #
                   8843:     my @Labels;
                   8844:     if (defined($labels)) {
                   8845:         @Labels = @$labels;
                   8846:     } else {
                   8847:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   8848:             push (@Labels,$i+1);
                   8849:         }
                   8850:     }
                   8851:     #
1.129     matthew  8852:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  8853:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  8854:     my %ValuesHash;
                   8855:     my $NumSets=1;
                   8856:     foreach my $array (@Values) {
                   8857:         next if (! ref($array));
1.136     matthew  8858:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  8859:             join(',',@$array);
1.129     matthew  8860:     }
1.127     matthew  8861:     #
1.136     matthew  8862:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  8863:     if ($NumBars < 3) {
                   8864:         $width = 120+$NumBars*32;
1.220     matthew  8865:         $xskip = 1;
1.225     matthew  8866:         $bar_width = 30;
                   8867:     } elsif ($NumBars < 5) {
                   8868:         $width = 120+$NumBars*20;
                   8869:         $xskip = 1;
                   8870:         $bar_width = 20;
1.220     matthew  8871:     } elsif ($NumBars < 10) {
1.136     matthew  8872:         $width = 120+$NumBars*15;
                   8873:         $xskip = 1;
                   8874:         $bar_width = 15;
                   8875:     } elsif ($NumBars <= 25) {
                   8876:         $width = 120+$NumBars*11;
                   8877:         $xskip = 5;
                   8878:         $bar_width = 8;
                   8879:     } elsif ($NumBars <= 50) {
                   8880:         $width = 120+$NumBars*8;
                   8881:         $xskip = 5;
                   8882:         $bar_width = 4;
                   8883:     } else {
                   8884:         $width = 120+$NumBars*8;
                   8885:         $xskip = 5;
                   8886:         $bar_width = 4;
                   8887:     }
                   8888:     #
1.137     matthew  8889:     $Max = 1 if ($Max < 1);
                   8890:     if ( int($Max) < $Max ) {
                   8891:         $Max++;
                   8892:         $Max = int($Max);
                   8893:     }
1.127     matthew  8894:     $Title  = '' if (! defined($Title));
                   8895:     $xlabel = '' if (! defined($xlabel));
                   8896:     $ylabel = '' if (! defined($ylabel));
1.369     www      8897:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   8898:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   8899:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  8900:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  8901:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   8902:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   8903:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   8904:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8905:     $ValuesHash{$id.'.height'}   = $height;
                   8906:     $ValuesHash{$id.'.width'}    = $width;
                   8907:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   8908:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   8909:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  8910:     #
1.228     matthew  8911:     # Deal with other parameters
                   8912:     while (my ($key,$value) = each(%$extra_settings)) {
                   8913:         $ValuesHash{$id.'.'.$key} = $value;
                   8914:     }
                   8915:     #
1.646     raeburn  8916:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  8917:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   8918: }
                   8919: 
                   8920: ############################################################
                   8921: ############################################################
                   8922: 
                   8923: =pod
                   8924: 
1.648     raeburn  8925: =item * &DrawXYGraph()
1.137     matthew  8926: 
1.138     matthew  8927: Facilitates the plotting of data in an XY graph.
                   8928: Puts plot definition data into the users environment in order for 
                   8929: graph.png to plot it.  Returns an <img> tag for the plot.
                   8930: 
                   8931: Inputs:
                   8932: 
                   8933: =over 4
                   8934: 
                   8935: =item $Title: string, the title of the plot
                   8936: 
                   8937: =item $xlabel: string, text describing the X-axis of the plot
                   8938: 
                   8939: =item $ylabel: string, text describing the Y-axis of the plot
                   8940: 
                   8941: =item $Max: scalar, the maximum Y value to use in the plot
                   8942: If $Max is < any data point, the graph will not be rendered.
                   8943: 
                   8944: =item $colors: Array ref containing the hex color codes for the data to be 
                   8945: plotted in.  If undefined, default values will be used.
                   8946: 
                   8947: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   8948: 
                   8949: =item $Ydata: Array ref containing Array refs.  
1.185     www      8950: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  8951: 
                   8952: =item %Values: hash indicating or overriding any default values which are 
                   8953: passed to graph.png.  
                   8954: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   8955: 
                   8956: =back
                   8957: 
                   8958: Returns:
                   8959: 
                   8960: An <img> tag which references graph.png and the appropriate identifying
                   8961: information for the plot.
                   8962: 
1.137     matthew  8963: =cut
                   8964: 
                   8965: ############################################################
                   8966: ############################################################
                   8967: sub DrawXYGraph {
                   8968:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   8969:     #
                   8970:     # Create the identifier for the graph
                   8971:     my $identifier = &get_cgi_id();
                   8972:     my $id = 'cgi.'.$identifier;
                   8973:     #
                   8974:     $Title  = '' if (! defined($Title));
                   8975:     $xlabel = '' if (! defined($xlabel));
                   8976:     $ylabel = '' if (! defined($ylabel));
                   8977:     my %ValuesHash = 
                   8978:         (
1.369     www      8979:          $id.'.title'  => &escape($Title),
                   8980:          $id.'.xlabel' => &escape($xlabel),
                   8981:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  8982:          $id.'.y_max_value'=> $Max,
                   8983:          $id.'.labels'     => join(',',@$Xlabels),
                   8984:          $id.'.PlotType'   => 'XY',
                   8985:          );
                   8986:     #
                   8987:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   8988:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8989:     }
                   8990:     #
                   8991:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   8992:         return '';
                   8993:     }
                   8994:     my $NumSets=1;
1.138     matthew  8995:     foreach my $array (@{$Ydata}){
1.137     matthew  8996:         next if (! ref($array));
                   8997:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   8998:     }
1.138     matthew  8999:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  9000:     #
                   9001:     # Deal with other parameters
                   9002:     while (my ($key,$value) = each(%Values)) {
                   9003:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  9004:     }
                   9005:     #
1.646     raeburn  9006:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  9007:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9008: }
                   9009: 
                   9010: ############################################################
                   9011: ############################################################
                   9012: 
                   9013: =pod
                   9014: 
1.648     raeburn  9015: =item * &DrawXYYGraph()
1.138     matthew  9016: 
                   9017: Facilitates the plotting of data in an XY graph with two Y axes.
                   9018: Puts plot definition data into the users environment in order for 
                   9019: graph.png to plot it.  Returns an <img> tag for the plot.
                   9020: 
                   9021: Inputs:
                   9022: 
                   9023: =over 4
                   9024: 
                   9025: =item $Title: string, the title of the plot
                   9026: 
                   9027: =item $xlabel: string, text describing the X-axis of the plot
                   9028: 
                   9029: =item $ylabel: string, text describing the Y-axis of the plot
                   9030: 
                   9031: =item $colors: Array ref containing the hex color codes for the data to be 
                   9032: plotted in.  If undefined, default values will be used.
                   9033: 
                   9034: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9035: 
                   9036: =item $Ydata1: The first data set
                   9037: 
                   9038: =item $Min1: The minimum value of the left Y-axis
                   9039: 
                   9040: =item $Max1: The maximum value of the left Y-axis
                   9041: 
                   9042: =item $Ydata2: The second data set
                   9043: 
                   9044: =item $Min2: The minimum value of the right Y-axis
                   9045: 
                   9046: =item $Max2: The maximum value of the left Y-axis
                   9047: 
                   9048: =item %Values: hash indicating or overriding any default values which are 
                   9049: passed to graph.png.  
                   9050: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9051: 
                   9052: =back
                   9053: 
                   9054: Returns:
                   9055: 
                   9056: An <img> tag which references graph.png and the appropriate identifying
                   9057: information for the plot.
1.136     matthew  9058: 
                   9059: =cut
                   9060: 
                   9061: ############################################################
                   9062: ############################################################
1.137     matthew  9063: sub DrawXYYGraph {
                   9064:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9065:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9066:     #
                   9067:     # Create the identifier for the graph
                   9068:     my $identifier = &get_cgi_id();
                   9069:     my $id = 'cgi.'.$identifier;
                   9070:     #
                   9071:     $Title  = '' if (! defined($Title));
                   9072:     $xlabel = '' if (! defined($xlabel));
                   9073:     $ylabel = '' if (! defined($ylabel));
                   9074:     my %ValuesHash = 
                   9075:         (
1.369     www      9076:          $id.'.title'  => &escape($Title),
                   9077:          $id.'.xlabel' => &escape($xlabel),
                   9078:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9079:          $id.'.labels' => join(',',@$Xlabels),
                   9080:          $id.'.PlotType' => 'XY',
                   9081:          $id.'.NumSets' => 2,
1.137     matthew  9082:          $id.'.two_axes' => 1,
                   9083:          $id.'.y1_max_value' => $Max1,
                   9084:          $id.'.y1_min_value' => $Min1,
                   9085:          $id.'.y2_max_value' => $Max2,
                   9086:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9087:          );
                   9088:     #
1.137     matthew  9089:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9090:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9091:     }
                   9092:     #
                   9093:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9094:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9095:         return '';
                   9096:     }
                   9097:     my $NumSets=1;
1.137     matthew  9098:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9099:         next if (! ref($array));
                   9100:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9101:     }
                   9102:     #
                   9103:     # Deal with other parameters
                   9104:     while (my ($key,$value) = each(%Values)) {
                   9105:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9106:     }
                   9107:     #
1.646     raeburn  9108:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9109:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9110: }
                   9111: 
                   9112: ############################################################
                   9113: ############################################################
                   9114: 
                   9115: =pod
                   9116: 
1.157     matthew  9117: =back 
                   9118: 
1.139     matthew  9119: =head1 Statistics helper routines?  
                   9120: 
                   9121: Bad place for them but what the hell.
                   9122: 
1.157     matthew  9123: =over 4
                   9124: 
1.648     raeburn  9125: =item * &chartlink()
1.139     matthew  9126: 
                   9127: Returns a link to the chart for a specific student.  
                   9128: 
                   9129: Inputs:
                   9130: 
                   9131: =over 4
                   9132: 
                   9133: =item $linktext: The text of the link
                   9134: 
                   9135: =item $sname: The students username
                   9136: 
                   9137: =item $sdomain: The students domain
                   9138: 
                   9139: =back
                   9140: 
1.157     matthew  9141: =back
                   9142: 
1.139     matthew  9143: =cut
                   9144: 
                   9145: ############################################################
                   9146: ############################################################
                   9147: sub chartlink {
                   9148:     my ($linktext, $sname, $sdomain) = @_;
                   9149:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9150:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9151:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9152:        '">'.$linktext.'</a>';
1.153     matthew  9153: }
                   9154: 
                   9155: #######################################################
                   9156: #######################################################
                   9157: 
                   9158: =pod
                   9159: 
                   9160: =head1 Course Environment Routines
1.157     matthew  9161: 
                   9162: =over 4
1.153     matthew  9163: 
1.648     raeburn  9164: =item * &restore_course_settings()
1.153     matthew  9165: 
1.648     raeburn  9166: =item * &store_course_settings()
1.153     matthew  9167: 
                   9168: Restores/Store indicated form parameters from the course environment.
                   9169: Will not overwrite existing values of the form parameters.
                   9170: 
                   9171: Inputs: 
                   9172: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9173: 
                   9174: a hash ref describing the data to be stored.  For example:
                   9175:    
                   9176: %Save_Parameters = ('Status' => 'scalar',
                   9177:     'chartoutputmode' => 'scalar',
                   9178:     'chartoutputdata' => 'scalar',
                   9179:     'Section' => 'array',
1.373     raeburn  9180:     'Group' => 'array',
1.153     matthew  9181:     'StudentData' => 'array',
                   9182:     'Maps' => 'array');
                   9183: 
                   9184: Returns: both routines return nothing
                   9185: 
1.631     raeburn  9186: =back
                   9187: 
1.153     matthew  9188: =cut
                   9189: 
                   9190: #######################################################
                   9191: #######################################################
                   9192: sub store_course_settings {
1.496     albertel 9193:     return &store_settings($env{'request.course.id'},@_);
                   9194: }
                   9195: 
                   9196: sub store_settings {
1.153     matthew  9197:     # save to the environment
                   9198:     # appenv the same items, just to be safe
1.300     albertel 9199:     my $udom  = $env{'user.domain'};
                   9200:     my $uname = $env{'user.name'};
1.496     albertel 9201:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9202:     my %SaveHash;
                   9203:     my %AppHash;
                   9204:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9205:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9206:         my $envname = 'environment.'.$basename;
1.258     albertel 9207:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9208:             # Save this value away
                   9209:             if ($type eq 'scalar' &&
1.258     albertel 9210:                 (! exists($env{$envname}) || 
                   9211:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9212:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9213:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9214:             } elsif ($type eq 'array') {
                   9215:                 my $stored_form;
1.258     albertel 9216:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9217:                     $stored_form = join(',',
                   9218:                                         map {
1.369     www      9219:                                             &escape($_);
1.258     albertel 9220:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9221:                 } else {
                   9222:                     $stored_form = 
1.369     www      9223:                         &escape($env{'form.'.$setting});
1.153     matthew  9224:                 }
                   9225:                 # Determine if the array contents are the same.
1.258     albertel 9226:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9227:                     $SaveHash{$basename} = $stored_form;
                   9228:                     $AppHash{$envname}   = $stored_form;
                   9229:                 }
                   9230:             }
                   9231:         }
                   9232:     }
                   9233:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9234:                                           $udom,$uname);
1.153     matthew  9235:     if ($put_result !~ /^(ok|delayed)/) {
                   9236:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9237:                                  'got error:'.$put_result);
                   9238:     }
                   9239:     # Make sure these settings stick around in this session, too
1.646     raeburn  9240:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9241:     return;
                   9242: }
                   9243: 
                   9244: sub restore_course_settings {
1.499     albertel 9245:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9246: }
                   9247: 
                   9248: sub restore_settings {
                   9249:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9250:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9251:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9252:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9253:             '.'.$setting;
1.258     albertel 9254:         if (exists($env{$envname})) {
1.153     matthew  9255:             if ($type eq 'scalar') {
1.258     albertel 9256:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9257:             } elsif ($type eq 'array') {
1.258     albertel 9258:                 $env{'form.'.$setting} = [ 
1.153     matthew  9259:                                            map { 
1.369     www      9260:                                                &unescape($_); 
1.258     albertel 9261:                                            } split(',',$env{$envname})
1.153     matthew  9262:                                            ];
                   9263:             }
                   9264:         }
                   9265:     }
1.127     matthew  9266: }
                   9267: 
1.618     raeburn  9268: #######################################################
                   9269: #######################################################
                   9270: 
                   9271: =pod
                   9272: 
                   9273: =head1 Domain E-mail Routines  
                   9274: 
                   9275: =over 4
                   9276: 
1.648     raeburn  9277: =item * &build_recipient_list()
1.618     raeburn  9278: 
1.766     raeburn  9279: Build recipient lists for four types of e-mail:
                   9280: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
                   9281: (d) Help requests, generated by
                   9282: lonerrorhandler.pm, CHECKRPMS, loncron, and lonsupportreq.pm respectively.
1.618     raeburn  9283: 
                   9284: Inputs:
1.619     raeburn  9285: defmail (scalar - email address of default recipient), 
1.618     raeburn  9286: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9287: defdom (domain for which to retrieve configuration settings),
                   9288: origmail (scalar - email address of recipient from loncapa.conf, 
                   9289: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9290: 
1.655     raeburn  9291: Returns: comma separated list of addresses to which to send e-mail.
                   9292: 
                   9293: =back
1.618     raeburn  9294: 
                   9295: =cut
                   9296: 
                   9297: ############################################################
                   9298: ############################################################
                   9299: sub build_recipient_list {
1.619     raeburn  9300:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9301:     my @recipients;
                   9302:     my $otheremails;
                   9303:     my %domconfig =
                   9304:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9305:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9306:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9307:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9308:                 my @contacts = ('adminemail','supportemail');
                   9309:                 foreach my $item (@contacts) {
                   9310:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9311:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9312:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9313:                             push(@recipients,$addr);
                   9314:                         }
1.619     raeburn  9315:                     }
1.766     raeburn  9316:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9317:                 }
                   9318:             }
1.766     raeburn  9319:         } elsif ($origmail ne '') {
                   9320:             push(@recipients,$origmail);
1.618     raeburn  9321:         }
1.619     raeburn  9322:     } elsif ($origmail ne '') {
                   9323:         push(@recipients,$origmail);
1.618     raeburn  9324:     }
1.688     raeburn  9325:     if (defined($defmail)) {
                   9326:         if ($defmail ne '') {
                   9327:             push(@recipients,$defmail);
                   9328:         }
1.618     raeburn  9329:     }
                   9330:     if ($otheremails) {
1.619     raeburn  9331:         my @others;
                   9332:         if ($otheremails =~ /,/) {
                   9333:             @others = split(/,/,$otheremails);
1.618     raeburn  9334:         } else {
1.619     raeburn  9335:             push(@others,$otheremails);
                   9336:         }
                   9337:         foreach my $addr (@others) {
                   9338:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9339:                 push(@recipients,$addr);
                   9340:             }
1.618     raeburn  9341:         }
                   9342:     }
1.619     raeburn  9343:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9344:     return $recipientlist;
                   9345: }
                   9346: 
1.127     matthew  9347: ############################################################
                   9348: ############################################################
1.154     albertel 9349: 
1.655     raeburn  9350: =pod
                   9351: 
                   9352: =head1 Course Catalog Routines
                   9353: 
                   9354: =over 4
                   9355: 
                   9356: =item * &gather_categories()
                   9357: 
                   9358: Converts category definitions - keys of categories hash stored in  
                   9359: coursecategories in configuration.db on the primary library server in a 
                   9360: domain - to an array.  Also generates javascript and idx hash used to 
                   9361: generate Domain Coordinator interface for editing Course Categories.
                   9362: 
                   9363: Inputs:
1.663     raeburn  9364: 
1.655     raeburn  9365: categories (reference to hash of category definitions).
1.663     raeburn  9366: 
1.655     raeburn  9367: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9368:       categories and subcategories).
1.663     raeburn  9369: 
1.655     raeburn  9370: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9371:       editing Course Categories).
1.663     raeburn  9372: 
1.655     raeburn  9373: jsarray (reference to array of categories used to create Javascript arrays for
                   9374:          Domain Coordinator interface for editing Course Categories).
                   9375: 
                   9376: Returns: nothing
                   9377: 
                   9378: Side effects: populates cats, idx and jsarray. 
                   9379: 
                   9380: =cut
                   9381: 
                   9382: sub gather_categories {
                   9383:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9384:     my %counters;
                   9385:     my $num = 0;
                   9386:     foreach my $item (keys(%{$categories})) {
                   9387:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9388:         if ($container eq '' && $depth == 0) {
                   9389:             $cats->[$depth][$categories->{$item}] = $cat;
                   9390:         } else {
                   9391:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9392:         }
                   9393:         my ($escitem,$tail) = split(/:/,$item,2);
                   9394:         if ($counters{$tail} eq '') {
                   9395:             $counters{$tail} = $num;
                   9396:             $num ++;
                   9397:         }
                   9398:         if (ref($idx) eq 'HASH') {
                   9399:             $idx->{$item} = $counters{$tail};
                   9400:         }
                   9401:         if (ref($jsarray) eq 'ARRAY') {
                   9402:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9403:         }
                   9404:     }
                   9405:     return;
                   9406: }
                   9407: 
                   9408: =pod
                   9409: 
                   9410: =item * &extract_categories()
                   9411: 
                   9412: Used to generate breadcrumb trails for course categories.
                   9413: 
                   9414: Inputs:
1.663     raeburn  9415: 
1.655     raeburn  9416: categories (reference to hash of category definitions).
1.663     raeburn  9417: 
1.655     raeburn  9418: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9419:       categories and subcategories).
1.663     raeburn  9420: 
1.655     raeburn  9421: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9422: 
1.655     raeburn  9423: allitems (reference to hash - key is category key 
                   9424:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9425: 
1.655     raeburn  9426: idx (reference to hash of counters used in Domain Coordinator interface for
                   9427:       editing Course Categories).
1.663     raeburn  9428: 
1.655     raeburn  9429: jsarray (reference to array of categories used to create Javascript arrays for
                   9430:          Domain Coordinator interface for editing Course Categories).
                   9431: 
1.665     raeburn  9432: subcats (reference to hash of arrays containing all subcategories within each 
                   9433:          category, -recursive)
                   9434: 
1.655     raeburn  9435: Returns: nothing
                   9436: 
                   9437: Side effects: populates trails and allitems hash references.
                   9438: 
                   9439: =cut
                   9440: 
                   9441: sub extract_categories {
1.665     raeburn  9442:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9443:     if (ref($categories) eq 'HASH') {
                   9444:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9445:         if (ref($cats->[0]) eq 'ARRAY') {
                   9446:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9447:                 my $name = $cats->[0][$i];
                   9448:                 my $item = &escape($name).'::0';
                   9449:                 my $trailstr;
                   9450:                 if ($name eq 'instcode') {
                   9451:                     $trailstr = &mt('Official courses (with institutional codes)');
                   9452:                 } else {
                   9453:                     $trailstr = $name;
                   9454:                 }
                   9455:                 if ($allitems->{$item} eq '') {
                   9456:                     push(@{$trails},$trailstr);
                   9457:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9458:                 }
                   9459:                 my @parents = ($name);
                   9460:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9461:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9462:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9463:                         if (ref($subcats) eq 'HASH') {
                   9464:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9465:                         }
                   9466:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9467:                     }
                   9468:                 } else {
                   9469:                     if (ref($subcats) eq 'HASH') {
                   9470:                         $subcats->{$item} = [];
1.655     raeburn  9471:                     }
                   9472:                 }
                   9473:             }
                   9474:         }
                   9475:     }
                   9476:     return;
                   9477: }
                   9478: 
                   9479: =pod
                   9480: 
                   9481: =item *&recurse_categories()
                   9482: 
                   9483: Recursively used to generate breadcrumb trails for course categories.
                   9484: 
                   9485: Inputs:
1.663     raeburn  9486: 
1.655     raeburn  9487: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9488:       categories and subcategories).
1.663     raeburn  9489: 
1.655     raeburn  9490: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9491: 
                   9492: category (current course category, for which breadcrumb trail is being generated).
                   9493: 
                   9494: trails (reference to array of breadcrumb trails for each category).
                   9495: 
1.655     raeburn  9496: allitems (reference to hash - key is category key
                   9497:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9498: 
1.655     raeburn  9499: parents (array containing containers directories for current category, 
                   9500:          back to top level). 
                   9501: 
                   9502: Returns: nothing
                   9503: 
                   9504: Side effects: populates trails and allitems hash references
                   9505: 
                   9506: =cut
                   9507: 
                   9508: sub recurse_categories {
1.665     raeburn  9509:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9510:     my $shallower = $depth - 1;
                   9511:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9512:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9513:             my $name = $cats->[$depth]{$category}[$k];
                   9514:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9515:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9516:             if ($allitems->{$item} eq '') {
                   9517:                 push(@{$trails},$trailstr);
                   9518:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9519:             }
                   9520:             my $deeper = $depth+1;
                   9521:             push(@{$parents},$category);
1.665     raeburn  9522:             if (ref($subcats) eq 'HASH') {
                   9523:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9524:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9525:                     my $higher;
                   9526:                     if ($j > 0) {
                   9527:                         $higher = &escape($parents->[$j]).':'.
                   9528:                                   &escape($parents->[$j-1]).':'.$j;
                   9529:                     } else {
                   9530:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9531:                     }
                   9532:                     push(@{$subcats->{$higher}},$subcat);
                   9533:                 }
                   9534:             }
                   9535:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9536:                                 $subcats);
1.655     raeburn  9537:             pop(@{$parents});
                   9538:         }
                   9539:     } else {
                   9540:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9541:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9542:         if ($allitems->{$item} eq '') {
                   9543:             push(@{$trails},$trailstr);
                   9544:             $allitems->{$item} = scalar(@{$trails})-1;
                   9545:         }
                   9546:     }
                   9547:     return;
                   9548: }
                   9549: 
1.663     raeburn  9550: =pod
                   9551: 
                   9552: =item *&assign_categories_table()
                   9553: 
                   9554: Create a datatable for display of hierarchical categories in a domain,
                   9555: with checkboxes to allow a course to be categorized. 
                   9556: 
                   9557: Inputs:
                   9558: 
                   9559: cathash - reference to hash of categories defined for the domain (from
                   9560:           configuration.db)
                   9561: 
                   9562: currcat - scalar with an & separated list of categories assigned to a course. 
                   9563: 
                   9564: Returns: $output (markup to be displayed) 
                   9565: 
                   9566: =cut
                   9567: 
                   9568: sub assign_categories_table {
                   9569:     my ($cathash,$currcat) = @_;
                   9570:     my $output;
                   9571:     if (ref($cathash) eq 'HASH') {
                   9572:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9573:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9574:         $maxdepth = scalar(@cats);
                   9575:         if (@cats > 0) {
                   9576:             my $itemcount = 0;
                   9577:             if (ref($cats[0]) eq 'ARRAY') {
                   9578:                 $output = &Apache::loncommon::start_data_table();
                   9579:                 my @currcategories;
                   9580:                 if ($currcat ne '') {
                   9581:                     @currcategories = split('&',$currcat);
                   9582:                 }
                   9583:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9584:                     my $parent = $cats[0][$i];
                   9585:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9586:                     next if ($parent eq 'instcode');
                   9587:                     my $item = &escape($parent).'::0';
                   9588:                     my $checked = '';
                   9589:                     if (@currcategories > 0) {
                   9590:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9591:                             $checked = ' checked="checked"';
1.663     raeburn  9592:                         }
                   9593:                     }
1.675     raeburn  9594:                     $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9595:                                '<input type="checkbox" name="usecategory" value="'.
                   9596:                                $item.'"'.$checked.' />'.$parent.'</span>'.
                   9597:                                '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9598:                     my $depth = 1;
                   9599:                     push(@path,$parent);
                   9600:                     $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                   9601:                     pop(@path);
                   9602:                     $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                   9603:                     $itemcount ++;
                   9604:                 }
                   9605:                 $output .= &Apache::loncommon::end_data_table();
                   9606:             }
                   9607:         }
                   9608:     }
                   9609:     return $output;
                   9610: }
                   9611: 
                   9612: =pod
                   9613: 
                   9614: =item *&assign_category_rows()
                   9615: 
                   9616: Create a datatable row for display of nested categories in a domain,
                   9617: with checkboxes to allow a course to be categorized,called recursively.
                   9618: 
                   9619: Inputs:
                   9620: 
                   9621: itemcount - track row number for alternating colors
                   9622: 
                   9623: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   9624:       categories and subcategories.
                   9625: 
                   9626: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   9627: 
                   9628: parent - parent of current category item
                   9629: 
                   9630: path - Array containing all categories back up through the hierarchy from the
                   9631:        current category to the top level.
                   9632: 
                   9633: currcategories - reference to array of current categories assigned to the course
                   9634: 
                   9635: Returns: $output (markup to be displayed).
                   9636: 
                   9637: =cut
                   9638: 
                   9639: sub assign_category_rows {
                   9640:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   9641:     my ($text,$name,$item,$chgstr);
                   9642:     if (ref($cats) eq 'ARRAY') {
                   9643:         my $maxdepth = scalar(@{$cats});
                   9644:         if (ref($cats->[$depth]) eq 'HASH') {
                   9645:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   9646:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   9647:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9648:                 $text .= '<td><table class="LC_datatable">';
                   9649:                 for (my $j=0; $j<$numchildren; $j++) {
                   9650:                     $name = $cats->[$depth]{$parent}[$j];
                   9651:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   9652:                     my $deeper = $depth+1;
                   9653:                     my $checked = '';
                   9654:                     if (ref($currcategories) eq 'ARRAY') {
                   9655:                         if (@{$currcategories} > 0) {
                   9656:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   9657:                                 $checked = ' checked="checked"';
1.663     raeburn  9658:                             }
                   9659:                         }
                   9660:                     }
1.664     raeburn  9661:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   9662:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  9663:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   9664:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   9665:                              '</td><td>';
1.663     raeburn  9666:                     if (ref($path) eq 'ARRAY') {
                   9667:                         push(@{$path},$name);
                   9668:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   9669:                         pop(@{$path});
                   9670:                     }
                   9671:                     $text .= '</td></tr>';
                   9672:                 }
                   9673:                 $text .= '</table></td>';
                   9674:             }
                   9675:         }
                   9676:     }
                   9677:     return $text;
                   9678: }
                   9679: 
1.655     raeburn  9680: ############################################################
                   9681: ############################################################
                   9682: 
                   9683: 
1.443     albertel 9684: sub commit_customrole {
1.664     raeburn  9685:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  9686:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 9687:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   9688:                          ($end?', ending '.localtime($end):'').': <b>'.
                   9689:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  9690:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 9691:                  '</b><br />';
                   9692:     return $output;
                   9693: }
                   9694: 
                   9695: sub commit_standardrole {
1.541     raeburn  9696:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   9697:     my ($output,$logmsg,$linefeed);
                   9698:     if ($context eq 'auto') {
                   9699:         $linefeed = "\n";
                   9700:     } else {
                   9701:         $linefeed = "<br />\n";
                   9702:     }  
1.443     albertel 9703:     if ($three eq 'st') {
1.541     raeburn  9704:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   9705:                                          $one,$two,$sec,$context);
                   9706:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  9707:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   9708:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 9709:         } else {
1.541     raeburn  9710:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 9711:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9712:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   9713:             if ($context eq 'auto') {
                   9714:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   9715:             } else {
                   9716:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   9717:                &mt('Add to classlist').': <b>ok</b>';
                   9718:             }
                   9719:             $output .= $linefeed;
1.443     albertel 9720:         }
                   9721:     } else {
                   9722:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   9723:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9724:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  9725:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  9726:         if ($context eq 'auto') {
                   9727:             $output .= $result.$linefeed;
                   9728:         } else {
                   9729:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   9730:         }
1.443     albertel 9731:     }
                   9732:     return $output;
                   9733: }
                   9734: 
                   9735: sub commit_studentrole {
1.541     raeburn  9736:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  9737:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  9738:     if ($context eq 'auto') {
                   9739:         $linefeed = "\n";
                   9740:     } else {
                   9741:         $linefeed = '<br />'."\n";
                   9742:     }
1.443     albertel 9743:     if (defined($one) && defined($two)) {
                   9744:         my $cid=$one.'_'.$two;
                   9745:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   9746:         my $secchange = 0;
                   9747:         my $expire_role_result;
                   9748:         my $modify_section_result;
1.628     raeburn  9749:         if ($oldsec ne '-1') { 
                   9750:             if ($oldsec ne $sec) {
1.443     albertel 9751:                 $secchange = 1;
1.628     raeburn  9752:                 my $now = time;
1.443     albertel 9753:                 my $uurl='/'.$cid;
                   9754:                 $uurl=~s/\_/\//g;
                   9755:                 if ($oldsec) {
                   9756:                     $uurl.='/'.$oldsec;
                   9757:                 }
1.626     raeburn  9758:                 $oldsecurl = $uurl;
1.628     raeburn  9759:                 $expire_role_result = 
1.652     raeburn  9760:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  9761:                 if ($env{'request.course.sec'} ne '') { 
                   9762:                     if ($expire_role_result eq 'refused') {
                   9763:                         my @roles = ('st');
                   9764:                         my @statuses = ('previous');
                   9765:                         my @roledoms = ($one);
                   9766:                         my $withsec = 1;
                   9767:                         my %roleshash = 
                   9768:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   9769:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   9770:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   9771:                             my ($oldstart,$oldend) = 
                   9772:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   9773:                             if ($oldend > 0 && $oldend <= $now) {
                   9774:                                 $expire_role_result = 'ok';
                   9775:                             }
                   9776:                         }
                   9777:                     }
                   9778:                 }
1.443     albertel 9779:                 $result = $expire_role_result;
                   9780:             }
                   9781:         }
                   9782:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  9783:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 9784:             if ($modify_section_result =~ /^ok/) {
                   9785:                 if ($secchange == 1) {
1.628     raeburn  9786:                     if ($sec eq '') {
                   9787:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   9788:                     } else {
                   9789:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   9790:                     }
1.443     albertel 9791:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  9792:                     if ($sec eq '') {
                   9793:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   9794:                     } else {
                   9795:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9796:                     }
1.443     albertel 9797:                 } else {
1.628     raeburn  9798:                     if ($sec eq '') {
                   9799:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   9800:                     } else {
                   9801:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9802:                     }
1.443     albertel 9803:                 }
                   9804:             } else {
1.628     raeburn  9805:                 if ($secchange) {       
                   9806:                     $$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;
                   9807:                 } else {
                   9808:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   9809:                 }
1.443     albertel 9810:             }
                   9811:             $result = $modify_section_result;
                   9812:         } elsif ($secchange == 1) {
1.628     raeburn  9813:             if ($oldsec eq '') {
                   9814:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   9815:             } else {
                   9816:                 $$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;
                   9817:             }
1.626     raeburn  9818:             if ($expire_role_result eq 'refused') {
                   9819:                 my $newsecurl = '/'.$cid;
                   9820:                 $newsecurl =~ s/\_/\//g;
                   9821:                 if ($sec ne '') {
                   9822:                     $newsecurl.='/'.$sec;
                   9823:                 }
                   9824:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   9825:                     if ($sec eq '') {
                   9826:                         $$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;
                   9827:                     } else {
                   9828:                         $$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;
                   9829:                     }
                   9830:                 }
                   9831:             }
1.443     albertel 9832:         }
                   9833:     } else {
1.626     raeburn  9834:         $$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 9835:         $result = "error: incomplete course id\n";
                   9836:     }
                   9837:     return $result;
                   9838: }
                   9839: 
                   9840: ############################################################
                   9841: ############################################################
                   9842: 
1.566     albertel 9843: sub check_clone {
1.578     raeburn  9844:     my ($args,$linefeed) = @_;
1.566     albertel 9845:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   9846:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   9847:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   9848:     my $clonemsg;
                   9849:     my $can_clone = 0;
                   9850: 
                   9851:     if ($clonehome eq 'no_host') {
1.578     raeburn  9852:         $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'});     
1.566     albertel 9853:     } else {
                   9854: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568     albertel 9855: 	if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566     albertel 9856: 	    $can_clone = 1;
                   9857: 	} else {
                   9858: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   9859: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   9860: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  9861:             if (grep(/^\*$/,@cloners)) {
                   9862:                 $can_clone = 1;
                   9863:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   9864:                 $can_clone = 1;
                   9865:             } else {
                   9866: 	        my %roleshash =
                   9867: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   9868: 					 $args->{'ccdomain'},
                   9869:                                          'userroles',['active'],['cc'],
                   9870: 					 [$args->{'clonedomain'}]);
                   9871: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
                   9872: 		    $can_clone = 1;
                   9873: 	        } else {
                   9874:                     $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'});
                   9875: 	        }
1.566     albertel 9876: 	    }
1.578     raeburn  9877:         }
1.566     albertel 9878:     }
                   9879:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9880: }
                   9881: 
1.444     albertel 9882: sub construct_course {
1.541     raeburn  9883:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444     albertel 9884:     my $outcome;
1.541     raeburn  9885:     my $linefeed =  '<br />'."\n";
                   9886:     if ($context eq 'auto') {
                   9887:         $linefeed = "\n";
                   9888:     }
1.566     albertel 9889: 
                   9890: #
                   9891: # Are we cloning?
                   9892: #
                   9893:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9894:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  9895: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 9896: 	if ($context ne 'auto') {
1.578     raeburn  9897:             if ($clonemsg ne '') {
                   9898: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   9899:             }
1.566     albertel 9900: 	}
                   9901: 	$outcome .= $clonemsg.$linefeed;
                   9902: 
                   9903:         if (!$can_clone) {
                   9904: 	    return (0,$outcome);
                   9905: 	}
                   9906:     }
                   9907: 
1.444     albertel 9908: #
                   9909: # Open course
                   9910: #
                   9911:     my $crstype = lc($args->{'crstype'});
                   9912:     my %cenv=();
                   9913:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   9914:                                              $args->{'cdescr'},
                   9915:                                              $args->{'curl'},
                   9916:                                              $args->{'course_home'},
                   9917:                                              $args->{'nonstandard'},
                   9918:                                              $args->{'crscode'},
                   9919:                                              $args->{'ccuname'}.':'.
                   9920:                                              $args->{'ccdomain'},
                   9921:                                              $args->{'crstype'});
                   9922: 
                   9923:     # Note: The testing routines depend on this being output; see 
                   9924:     # Utils::Course. This needs to at least be output as a comment
                   9925:     # if anyone ever decides to not show this, and Utils::Course::new
                   9926:     # will need to be suitably modified.
1.541     raeburn  9927:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 9928: #
                   9929: # Check if created correctly
                   9930: #
1.479     albertel 9931:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 9932:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  9933:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 9934: 
1.444     albertel 9935: #
1.566     albertel 9936: # Do the cloning
                   9937: #   
                   9938:     if ($can_clone && $cloneid) {
                   9939: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   9940: 	if ($context ne 'auto') {
                   9941: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   9942: 	}
                   9943: 	$outcome .= $clonemsg.$linefeed;
                   9944: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 9945: # Copy all files
1.637     www      9946: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 9947: # Restore URL
1.566     albertel 9948: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 9949: # Restore title
1.566     albertel 9950: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 9951: # Mark as cloned
1.566     albertel 9952: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      9953: # Need to clone grading mode
                   9954:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   9955:         $cenv{'grading'}=$newenv{'grading'};
                   9956: # Do not clone these environment entries
                   9957:         &Apache::lonnet::del('environment',
                   9958:                   ['default_enrollment_start_date',
                   9959:                    'default_enrollment_end_date',
                   9960:                    'question.email',
                   9961:                    'policy.email',
                   9962:                    'comment.email',
                   9963:                    'pch.users.denied',
1.725     raeburn  9964:                    'plc.users.denied',
                   9965:                    'hidefromcat',
                   9966:                    'categories'],
1.638     www      9967:                    $$crsudom,$$crsunum);
1.444     albertel 9968:     }
1.566     albertel 9969: 
1.444     albertel 9970: #
                   9971: # Set environment (will override cloned, if existing)
                   9972: #
                   9973:     my @sections = ();
                   9974:     my @xlists = ();
                   9975:     if ($args->{'crstype'}) {
                   9976:         $cenv{'type'}=$args->{'crstype'};
                   9977:     }
                   9978:     if ($args->{'crsid'}) {
                   9979:         $cenv{'courseid'}=$args->{'crsid'};
                   9980:     }
                   9981:     if ($args->{'crscode'}) {
                   9982:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   9983:     }
                   9984:     if ($args->{'crsquota'} ne '') {
                   9985:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   9986:     } else {
                   9987:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   9988:     }
                   9989:     if ($args->{'ccuname'}) {
                   9990:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   9991:                                         ':'.$args->{'ccdomain'};
                   9992:     } else {
                   9993:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   9994:     }
                   9995:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   9996:     if ($args->{'crssections'}) {
                   9997:         $cenv{'internal.sectionnums'} = '';
                   9998:         if ($args->{'crssections'} =~ m/,/) {
                   9999:             @sections = split/,/,$args->{'crssections'};
                   10000:         } else {
                   10001:             $sections[0] = $args->{'crssections'};
                   10002:         }
                   10003:         if (@sections > 0) {
                   10004:             foreach my $item (@sections) {
                   10005:                 my ($sec,$gp) = split/:/,$item;
                   10006:                 my $class = $args->{'crscode'}.$sec;
                   10007:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   10008:                 $cenv{'internal.sectionnums'} .= $item.',';
                   10009:                 unless ($addcheck eq 'ok') {
                   10010:                     push @badclasses, $class;
                   10011:                 }
                   10012:             }
                   10013:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   10014:         }
                   10015:     }
                   10016: # do not hide course coordinator from staff listing, 
                   10017: # even if privileged
                   10018:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10019: # add crosslistings
                   10020:     if ($args->{'crsxlist'}) {
                   10021:         $cenv{'internal.crosslistings'}='';
                   10022:         if ($args->{'crsxlist'} =~ m/,/) {
                   10023:             @xlists = split/,/,$args->{'crsxlist'};
                   10024:         } else {
                   10025:             $xlists[0] = $args->{'crsxlist'};
                   10026:         }
                   10027:         if (@xlists > 0) {
                   10028:             foreach my $item (@xlists) {
                   10029:                 my ($xl,$gp) = split/:/,$item;
                   10030:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   10031:                 $cenv{'internal.crosslistings'} .= $item.',';
                   10032:                 unless ($addcheck eq 'ok') {
                   10033:                     push @badclasses, $xl;
                   10034:                 }
                   10035:             }
                   10036:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   10037:         }
                   10038:     }
                   10039:     if ($args->{'autoadds'}) {
                   10040:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   10041:     }
                   10042:     if ($args->{'autodrops'}) {
                   10043:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10044:     }
                   10045: # check for notification of enrollment changes
                   10046:     my @notified = ();
                   10047:     if ($args->{'notify_owner'}) {
                   10048:         if ($args->{'ccuname'} ne '') {
                   10049:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10050:         }
                   10051:     }
                   10052:     if ($args->{'notify_dc'}) {
                   10053:         if ($uname ne '') { 
1.630     raeburn  10054:             push(@notified,$uname.':'.$udom);
1.444     albertel 10055:         }
                   10056:     }
                   10057:     if (@notified > 0) {
                   10058:         my $notifylist;
                   10059:         if (@notified > 1) {
                   10060:             $notifylist = join(',',@notified);
                   10061:         } else {
                   10062:             $notifylist = $notified[0];
                   10063:         }
                   10064:         $cenv{'internal.notifylist'} = $notifylist;
                   10065:     }
                   10066:     if (@badclasses > 0) {
                   10067:         my %lt=&Apache::lonlocal::texthash(
                   10068:                 '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',
                   10069:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10070:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10071:         );
1.541     raeburn  10072:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10073:                            ' ('.$lt{'adby'}.')';
                   10074:         if ($context eq 'auto') {
                   10075:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10076:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10077:             foreach my $item (@badclasses) {
                   10078:                 if ($context eq 'auto') {
                   10079:                     $outcome .= " - $item\n";
                   10080:                 } else {
                   10081:                     $outcome .= "<li>$item</li>\n";
                   10082:                 }
                   10083:             }
                   10084:             if ($context eq 'auto') {
                   10085:                 $outcome .= $linefeed;
                   10086:             } else {
1.566     albertel 10087:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10088:             }
                   10089:         } 
1.444     albertel 10090:     }
                   10091:     if ($args->{'no_end_date'}) {
                   10092:         $args->{'endaccess'} = 0;
                   10093:     }
                   10094:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10095:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10096:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10097:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10098:     if ($args->{'showphotos'}) {
                   10099:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10100:     }
                   10101:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10102:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10103:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10104:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10105:             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'); 
                   10106:             if ($context eq 'auto') {
                   10107:                 $outcome .= $krb_msg;
                   10108:             } else {
1.566     albertel 10109:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10110:             }
                   10111:             $outcome .= $linefeed;
1.444     albertel 10112:         }
                   10113:     }
                   10114:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10115:        if ($args->{'setpolicy'}) {
                   10116:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10117:        }
                   10118:        if ($args->{'setcontent'}) {
                   10119:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10120:        }
                   10121:     }
                   10122:     if ($args->{'reshome'}) {
                   10123: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10124: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10125:     }
                   10126: #
                   10127: # course has keyed access
                   10128: #
                   10129:     if ($args->{'setkeys'}) {
                   10130:        $cenv{'keyaccess'}='yes';
                   10131:     }
                   10132: # if specified, key authority is not course, but user
                   10133: # only active if keyaccess is yes
                   10134:     if ($args->{'keyauth'}) {
1.487     albertel 10135: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10136: 	$user = &LONCAPA::clean_username($user);
                   10137: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10138: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10139: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10140: 	}
                   10141:     }
                   10142: 
                   10143:     if ($args->{'disresdis'}) {
                   10144:         $cenv{'pch.roles.denied'}='st';
                   10145:     }
                   10146:     if ($args->{'disablechat'}) {
                   10147:         $cenv{'plc.roles.denied'}='st';
                   10148:     }
                   10149: 
                   10150:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10151:     # course
                   10152:     $cenv{'course.helper.not.run'} = 1;
                   10153:     #
                   10154:     # Use new Randomseed
                   10155:     #
                   10156:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10157:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10158:     #
                   10159:     # The encryption code and receipt prefix for this course
                   10160:     #
                   10161:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10162:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10163:     #
                   10164:     # By default, use standard grading
                   10165:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10166: 
1.541     raeburn  10167:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10168:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10169: #
                   10170: # Open all assignments
                   10171: #
                   10172:     if ($args->{'openall'}) {
                   10173:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10174:        my %storecontent = ($storeunder         => time,
                   10175:                            $storeunder.'.type' => 'date_start');
                   10176:        
                   10177:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10178:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10179:    }
                   10180: #
                   10181: # Set first page
                   10182: #
                   10183:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10184: 	    || ($cloneid)) {
1.445     albertel 10185: 	use LONCAPA::map;
1.444     albertel 10186: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10187: 
                   10188: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10189:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10190: 
1.444     albertel 10191:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10192:         my $title; my $url;
                   10193:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10194: 	    $title=&mt('Syllabus');
1.444     albertel 10195:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10196:         } else {
1.690     bisitz   10197:             $title=&mt('Navigate Contents');
1.444     albertel 10198:             $url='/adm/navmaps';
                   10199:         }
1.445     albertel 10200: 
                   10201:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10202: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10203: 
                   10204: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10205:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10206:     }
1.566     albertel 10207: 
                   10208:     return (1,$outcome);
1.444     albertel 10209: }
                   10210: 
                   10211: ############################################################
                   10212: ############################################################
                   10213: 
1.378     raeburn  10214: sub course_type {
                   10215:     my ($cid) = @_;
                   10216:     if (!defined($cid)) {
                   10217:         $cid = $env{'request.course.id'};
                   10218:     }
1.404     albertel 10219:     if (defined($env{'course.'.$cid.'.type'})) {
                   10220:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10221:     } else {
                   10222:         return 'Course';
1.377     raeburn  10223:     }
                   10224: }
1.156     albertel 10225: 
1.406     raeburn  10226: sub group_term {
                   10227:     my $crstype = &course_type();
                   10228:     my %names = (
                   10229:                   'Course' => 'group',
                   10230:                   'Group' => 'team',
                   10231:                 );
                   10232:     return $names{$crstype};
                   10233: }
                   10234: 
1.156     albertel 10235: sub icon {
                   10236:     my ($file)=@_;
1.505     albertel 10237:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10238:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10239:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10240:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10241: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10242: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10243: 	            $curfext.".gif") {
                   10244: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10245: 		$curfext.".gif";
                   10246: 	}
                   10247:     }
1.249     albertel 10248:     return &lonhttpdurl($iconname);
1.154     albertel 10249: } 
1.84      albertel 10250: 
1.575     albertel 10251: sub lonhttpdurl {
1.692     www      10252: #
                   10253: # Had been used for "small fry" static images on separate port 8080.
                   10254: # Modify here if lightweight http functionality desired again.
                   10255: # Currently eliminated due to increasing firewall issues.
                   10256: #
1.575     albertel 10257:     my ($url)=@_;
1.692     www      10258:     return $url;
1.215     albertel 10259: }
                   10260: 
1.213     albertel 10261: sub connection_aborted {
                   10262:     my ($r)=@_;
                   10263:     $r->print(" ");$r->rflush();
                   10264:     my $c = $r->connection;
                   10265:     return $c->aborted();
                   10266: }
                   10267: 
1.221     foxr     10268: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10269: #    strings as 'strings'.
                   10270: sub escape_single {
1.221     foxr     10271:     my ($input) = @_;
1.223     albertel 10272:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10273:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10274:     return $input;
                   10275: }
1.223     albertel 10276: 
1.222     foxr     10277: #  Same as escape_single, but escape's "'s  This 
                   10278: #  can be used for  "strings"
                   10279: sub escape_double {
                   10280:     my ($input) = @_;
                   10281:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10282:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10283:     return $input;
                   10284: }
1.223     albertel 10285:  
1.222     foxr     10286: #   Escapes the last element of a full URL.
                   10287: sub escape_url {
                   10288:     my ($url)   = @_;
1.238     raeburn  10289:     my @urlslices = split(/\//, $url,-1);
1.369     www      10290:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10291:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10292: }
1.462     albertel 10293: 
1.820     raeburn  10294: sub compare_arrays {
                   10295:     my ($arrayref1,$arrayref2) = @_;
                   10296:     my (@difference,%count);
                   10297:     @difference = ();
                   10298:     %count = ();
                   10299:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10300:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10301:         foreach my $element (keys(%count)) {
                   10302:             if ($count{$element} == 1) {
                   10303:                 push(@difference,$element);
                   10304:             }
                   10305:         }
                   10306:     }
                   10307:     return @difference;
                   10308: }
                   10309: 
1.817     bisitz   10310: # -------------------------------------------------------- Initialize user login
1.462     albertel 10311: sub init_user_environment {
1.463     albertel 10312:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10313:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10314: 
                   10315:     my $public=($username eq 'public' && $domain eq 'public');
                   10316: 
                   10317: # See if old ID present, if so, remove
                   10318: 
                   10319:     my ($filename,$cookie,$userroles);
                   10320:     my $now=time;
                   10321: 
                   10322:     if ($public) {
                   10323: 	my $max_public=100;
                   10324: 	my $oldest;
                   10325: 	my $oldest_time=0;
                   10326: 	for(my $next=1;$next<=$max_public;$next++) {
                   10327: 	    if (-e $lonids."/publicuser_$next.id") {
                   10328: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10329: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10330: 		    $oldest_time=$mtime;
                   10331: 		    $oldest=$next;
                   10332: 		}
                   10333: 	    } else {
                   10334: 		$cookie="publicuser_$next";
                   10335: 		last;
                   10336: 	    }
                   10337: 	}
                   10338: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10339:     } else {
1.463     albertel 10340: 	# if this isn't a robot, kill any existing non-robot sessions
                   10341: 	if (!$args->{'robot'}) {
                   10342: 	    opendir(DIR,$lonids);
                   10343: 	    while ($filename=readdir(DIR)) {
                   10344: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10345: 		    unlink($lonids.'/'.$filename);
                   10346: 		}
1.462     albertel 10347: 	    }
1.463     albertel 10348: 	    closedir(DIR);
1.462     albertel 10349: 	}
                   10350: # Give them a new cookie
1.463     albertel 10351: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10352: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10353: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10354:     
                   10355: # Initialize roles
                   10356: 
                   10357: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10358:     }
                   10359: # ------------------------------------ Check browser type and MathML capability
                   10360: 
                   10361:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10362:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10363: 
                   10364: # ------------------------------------------------------------- Get environment
                   10365: 
                   10366:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10367:     my ($tmp) = keys(%userenv);
                   10368:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10369: 	# default remote control to off
                   10370: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   10371:     } else {
                   10372: 	undef(%userenv);
                   10373:     }
                   10374:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10375: 	$form->{'interface'}=$userenv{'interface'};
                   10376:     }
                   10377:     $env{'environment.remote'}=$userenv{'remote'};
                   10378:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10379: 
                   10380: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10381:     foreach my $option ('interface','localpath','localres') {
                   10382:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10383:     }
                   10384: # --------------------------------------------------------- Write first profile
                   10385: 
                   10386:     {
                   10387: 	my %initial_env = 
                   10388: 	    ("user.name"          => $username,
                   10389: 	     "user.domain"        => $domain,
                   10390: 	     "user.home"          => $authhost,
                   10391: 	     "browser.type"       => $clientbrowser,
                   10392: 	     "browser.version"    => $clientversion,
                   10393: 	     "browser.mathml"     => $clientmathml,
                   10394: 	     "browser.unicode"    => $clientunicode,
                   10395: 	     "browser.os"         => $clientos,
                   10396: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10397: 	     "request.course.fn"  => '',
                   10398: 	     "request.course.uri" => '',
                   10399: 	     "request.course.sec" => '',
                   10400: 	     "request.role"       => 'cm',
                   10401: 	     "request.role.adv"   => $env{'user.adv'},
                   10402: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10403: 
                   10404:         if ($form->{'localpath'}) {
                   10405: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10406: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10407:         }
                   10408: 	
                   10409: 	if ($public) {
                   10410: 	    $initial_env{"environment.remote"} = "off";
                   10411: 	}
                   10412: 	if ($form->{'interface'}) {
                   10413: 	    $form->{'interface'}=~s/\W//gs;
                   10414: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10415: 	    $env{'browser.interface'}=$form->{'interface'};
                   10416: 	}
                   10417: 
1.724     raeburn  10418:         foreach my $tool ('aboutme','blog','portfolio') {
                   10419:             $userenv{'availabletools.'.$tool} = 
                   10420:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10421:         }
                   10422: 
1.765     raeburn  10423:         foreach my $crstype ('official','unofficial') {
                   10424:             $userenv{'canrequest.'.$crstype} =
                   10425:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10426:                                                   'reload','requestcourses');
                   10427:         }
                   10428: 
1.462     albertel 10429: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10430: 	
                   10431: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10432: 		 &GDBM_WRCREAT(),0640)) {
                   10433: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10434: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10435: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10436: 	    if (ref($args->{'extra_env'})) {
                   10437: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10438: 	    }
1.462     albertel 10439: 	    untie(%disk_env);
                   10440: 	} else {
1.705     tempelho 10441: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10442: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10443: 	    return 'error: '.$!;
                   10444: 	}
                   10445:     }
                   10446:     $env{'request.role'}='cm';
                   10447:     $env{'request.role.adv'}=$env{'user.adv'};
                   10448:     $env{'browser.type'}=$clientbrowser;
                   10449: 
                   10450:     return $cookie;
                   10451: 
                   10452: }
                   10453: 
                   10454: sub _add_to_env {
                   10455:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10456:     if (ref($env_data) eq 'HASH') {
                   10457:         while (my ($key,$value) = each(%$env_data)) {
                   10458: 	    $idf->{$prefix.$key} = $value;
                   10459: 	    $env{$prefix.$key}   = $value;
                   10460:         }
1.462     albertel 10461:     }
                   10462: }
                   10463: 
1.685     tempelho 10464: # --- Get the symbolic name of a problem and the url
                   10465: sub get_symb {
                   10466:     my ($request,$silent) = @_;
1.726     raeburn  10467:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10468:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10469:     if ($symb eq '') {
                   10470:         if (!$silent) {
                   10471:             $request->print("Unable to handle ambiguous references:$url:.");
                   10472:             return ();
                   10473:         }
                   10474:     }
                   10475:     &Apache::lonenc::check_decrypt(\$symb);
                   10476:     return ($symb);
                   10477: }
                   10478: 
                   10479: # --------------------------------------------------------------Get annotation
                   10480: 
                   10481: sub get_annotation {
                   10482:     my ($symb,$enc) = @_;
                   10483: 
                   10484:     my $key = $symb;
                   10485:     if (!$enc) {
                   10486:         $key =
                   10487:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10488:     }
                   10489:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10490:     return $annotation{$key};
                   10491: }
                   10492: 
                   10493: sub clean_symb {
1.731     raeburn  10494:     my ($symb,$delete_enc) = @_;
1.685     tempelho 10495: 
                   10496:     &Apache::lonenc::check_decrypt(\$symb);
                   10497:     my $enc = $env{'request.enc'};
1.731     raeburn  10498:     if ($delete_enc) {
1.730     raeburn  10499:         delete($env{'request.enc'});
                   10500:     }
1.685     tempelho 10501: 
                   10502:     return ($symb,$enc);
                   10503: }
1.462     albertel 10504: 
1.41      ng       10505: =pod
                   10506: 
                   10507: =back
                   10508: 
1.112     bowersj2 10509: =cut
1.41      ng       10510: 
1.112     bowersj2 10511: 1;
                   10512: __END__;
1.41      ng       10513: 

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