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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.831   ! bisitz      4: # $Id: loncommon.pm,v 1.830 2009/05/28 12:39:23 bisitz 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.824     bisitz    410: // <![CDATA[
1.74      www       411:     var stdeditbrowser;
1.793     raeburn   412:     function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74      www       413:         var url = '/adm/pickstudent?';
                    414:         var filter;
1.558     albertel  415: 	if (!ignorefilter) {
                    416: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    417: 	}
1.74      www       418:         if (filter != null) {
                    419:            if (filter != '') {
                    420:                url += 'filter='+filter+'&';
                    421: 	   }
                    422:         }
                    423:         url += 'form=' + formname + '&unameelement='+uname+
                    424:                                     '&udomelement='+udom;
1.111     www       425: 	if (roleflag) { url+="&roles=1"; }
1.793     raeburn   426:         if (courseadvonly) { url+="&courseadvonly=1"; }
1.102     www       427:         var title = 'Student_Browser';
1.74      www       428:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    429:         options += ',width=700,height=600';
                    430:         stdeditbrowser = open(url,title,options,'1');
                    431:         stdeditbrowser.focus();
                    432:     }
1.824     bisitz    433: // ]]>
1.74      www       434: </script>
                    435: ENDSTDBRW
                    436: }
1.42      matthew   437: 
1.74      www       438: sub selectstudent_link {
1.793     raeburn   439:    my ($form,$unameele,$udomele,$courseadvonly)=@_;
                    440:    my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258     albertel  441:    if ($env{'request.course.id'}) {  
1.302     albertel  442:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    443: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    444: 					'/'.$env{'request.course.sec'})) {
1.111     www       445: 	   return '';
                    446:        }
1.793     raeburn   447:        if ($courseadvonly)  {
                    448:            $callargs .= ",'',1,1";
                    449:        }
                    450:        return '<span class="LC_nobreak">'.
                    451:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    452:               &mt('Select User').'</a></span>';
1.74      www       453:    }
1.258     albertel  454:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793     raeburn   455:        $callargs .= ",1"; 
                    456:        return '<span class="LC_nobreak">'.
                    457:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    458:               &mt('Select User').'</a></span>';
1.111     www       459:    }
                    460:    return '';
1.91      www       461: }
                    462: 
1.653     raeburn   463: sub authorbrowser_javascript {
                    464:     return <<"ENDAUTHORBRW";
1.776     bisitz    465: <script type="text/javascript" language="JavaScript">
1.824     bisitz    466: // <![CDATA[
1.653     raeburn   467: var stdeditbrowser;
                    468: 
                    469: function openauthorbrowser(formname,udom) {
                    470:     var url = '/adm/pickauthor?';
                    471:     url += 'form='+formname+'&roledom='+udom;
                    472:     var title = 'Author_Browser';
                    473:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    474:     options += ',width=700,height=600';
                    475:     stdeditbrowser = open(url,title,options,'1');
                    476:     stdeditbrowser.focus();
                    477: }
                    478: 
1.824     bisitz    479: // ]]>
1.653     raeburn   480: </script>
                    481: ENDAUTHORBRW
                    482: }
                    483: 
1.91      www       484: sub coursebrowser_javascript {
1.468     raeburn   485:     my ($domainfilter,$sec_element,$formname)=@_;
1.377     raeburn   486:     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   487:    my $output = '
1.776     bisitz    488: <script type="text/javascript" language="JavaScript">
1.824     bisitz    489: // <![CDATA[
1.468     raeburn   490:     var stdeditbrowser;'."\n";
                    491:    $output .= <<"ENDSTDBRW";
1.377     raeburn   492:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91      www       493:         var url = '/adm/pickcourse?';
1.468     raeburn   494:         var domainfilter = '';
                    495:         var formid = getFormIdByName(formname);
                    496:         if (formid > -1) {
                    497:             var domid = getIndexByName(formid,udom);
                    498:             if (domid > -1) {
                    499:                 if (document.forms[formid].elements[domid].type == 'select-one') {
                    500:                     domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    501:                 }
                    502:                 if (document.forms[formid].elements[domid].type == 'hidden') {
                    503:                     domainfilter=document.forms[formid].elements[domid].value;
                    504:                 }
                    505:             }
1.91      www       506:         }
1.128     albertel  507:         if (domainfilter != null) {
                    508:            if (domainfilter != '') {
                    509:                url += 'domainfilter='+domainfilter+'&';
                    510: 	   }
                    511:         }
1.91      www       512:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  513: 	                            '&cdomelement='+udom+
                    514:                                     '&cnameelement='+desc;
1.468     raeburn   515:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   516:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   517:                 url += '&roleelement='+extra_element;
                    518:                 if (domainfilter == null || domainfilter == '') {
                    519:                     url += '&domainfilter='+extra_element;
                    520:                 }
1.234     raeburn   521:             }
1.468     raeburn   522:             else {
                    523:                 if (formname == 'portform') {
                    524:                     url += '&setroles='+extra_element;
1.800     raeburn   525:                 } else {
                    526:                     if (formname == 'rules') {
                    527:                         url += '&fixeddom='+extra_element; 
                    528:                     }
1.468     raeburn   529:                 }
                    530:             }     
1.230     raeburn   531:         }
1.293     raeburn   532:         if (multflag !=null && multflag != '') {
                    533:             url += '&multiple='+multflag;
                    534:         }
1.377     raeburn   535:         if (crstype == 'Course/Group') {
                    536:             if (formname == 'cu') {
                    537:                 crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value; 
                    538:                 if (crstype == "") {
                    539:                     alert("$crs_or_grp_alert");
                    540:                     return;
                    541:                 }
                    542:             }
                    543:         }
                    544:         if (crstype !=null && crstype != '') {
                    545:             url += '&type='+crstype;
                    546:         }
1.102     www       547:         var title = 'Course_Browser';
1.91      www       548:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    549:         options += ',width=700,height=600';
                    550:         stdeditbrowser = open(url,title,options,'1');
                    551:         stdeditbrowser.focus();
                    552:     }
1.468     raeburn   553: 
                    554:     function getFormIdByName(formname) {
                    555:         for (var i=0;i<document.forms.length;i++) {
                    556:             if (document.forms[i].name == formname) {
                    557:                 return i;
                    558:             }
                    559:         }
                    560:         return -1; 
                    561:     }
                    562: 
                    563:     function getIndexByName(formid,item) {
                    564:         for (var i=0;i<document.forms[formid].elements.length;i++) {
                    565:             if (document.forms[formid].elements[i].name == item) {
                    566:                 return i;
                    567:             }
                    568:         }
                    569:         return -1;
                    570:     }
1.91      www       571: ENDSTDBRW
1.468     raeburn   572:     if ($sec_element ne '') {
                    573:         $output .= &setsec_javascript($sec_element,$formname);
                    574:     }
                    575:     $output .= '
1.824     bisitz    576: // ]]>
1.468     raeburn   577: </script>';
                    578:     return $output;
                    579: }
                    580: 
                    581: sub setsec_javascript {
                    582:     my ($sec_element,$formname) = @_;
                    583:     my $setsections = qq|
                    584: function setSect(sectionlist) {
1.629     raeburn   585:     var sectionsArray = new Array();
                    586:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    587:         sectionsArray = sectionlist.split(",");
                    588:     }
1.468     raeburn   589:     var numSections = sectionsArray.length;
                    590:     document.$formname.$sec_element.length = 0;
                    591:     if (numSections == 0) {
                    592:         document.$formname.$sec_element.multiple=false;
                    593:         document.$formname.$sec_element.size=1;
                    594:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    595:     } else {
                    596:         if (numSections == 1) {
                    597:             document.$formname.$sec_element.multiple=false;
                    598:             document.$formname.$sec_element.size=1;
                    599:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    600:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    601:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    602:         } else {
                    603:             for (var i=0; i<numSections; i++) {
                    604:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    605:             }
                    606:             document.$formname.$sec_element.multiple=true
                    607:             if (numSections < 3) {
                    608:                 document.$formname.$sec_element.size=numSections;
                    609:             } else {
                    610:                 document.$formname.$sec_element.size=3;
                    611:             }
                    612:             document.$formname.$sec_element.options[0].selected = false
                    613:         }
                    614:     }
1.91      www       615: }
1.468     raeburn   616: |;
                    617:     return $setsections;
                    618: }
                    619: 
1.91      www       620: 
                    621: sub selectcourse_link {
1.377     raeburn   622:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.787     bisitz    623:    return '<span class="LC_nobreak">'
                    624:          ."<a href='"
                    625:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    626:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
                    627:          .'","'.$multflag.'","'.$selecttype.'");'
                    628:          ."'>".&mt('Select Course').'</a>'
                    629:          .'</span>';
1.74      www       630: }
1.42      matthew   631: 
1.653     raeburn   632: sub selectauthor_link {
                    633:    my ($form,$udom)=@_;
                    634:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    635:           &mt('Select Author').'</a>';
                    636: }
                    637: 
1.273     raeburn   638: sub check_uncheck_jscript {
                    639:     my $jscript = <<"ENDSCRT";
                    640: function checkAll(field) {
                    641:     if (field.length > 0) {
                    642:         for (i = 0; i < field.length; i++) {
                    643:             field[i].checked = true ;
                    644:         }
                    645:     } else {
                    646:         field.checked = true
                    647:     }
                    648: }
                    649:  
                    650: function uncheckAll(field) {
                    651:     if (field.length > 0) {
                    652:         for (i = 0; i < field.length; i++) {
                    653:             field[i].checked = false ;
1.543     albertel  654:         }
                    655:     } else {
1.273     raeburn   656:         field.checked = false ;
                    657:     }
                    658: }
                    659: ENDSCRT
                    660:     return $jscript;
                    661: }
                    662: 
1.656     www       663: sub select_timezone {
1.659     raeburn   664:    my ($name,$selected,$onchange,$includeempty)=@_;
                    665:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    666:    if ($includeempty) {
                    667:        $output .= '<option value=""';
                    668:        if (($selected eq '') || ($selected eq 'local')) {
                    669:            $output .= ' selected="selected" ';
                    670:        }
                    671:        $output .= '> </option>';
                    672:    }
1.657     raeburn   673:    my @timezones = DateTime::TimeZone->all_names;
                    674:    foreach my $tzone (@timezones) {
                    675:        $output.= '<option value="'.$tzone.'"';
                    676:        if ($tzone eq $selected) {
                    677:            $output.=' selected="selected"';
                    678:        }
                    679:        $output.=">$tzone</option>\n";
1.656     www       680:    }
                    681:    $output.="</select>";
                    682:    return $output;
                    683: }
1.273     raeburn   684: 
1.687     raeburn   685: sub select_datelocale {
                    686:     my ($name,$selected,$onchange,$includeempty)=@_;
                    687:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    688:     if ($includeempty) {
                    689:         $output .= '<option value=""';
                    690:         if ($selected eq '') {
                    691:             $output .= ' selected="selected" ';
                    692:         }
                    693:         $output .= '> </option>';
                    694:     }
                    695:     my (@possibles,%locale_names);
                    696:     my @locales = DateTime::Locale::Catalog::Locales;
                    697:     foreach my $locale (@locales) {
                    698:         if (ref($locale) eq 'HASH') {
                    699:             my $id = $locale->{'id'};
                    700:             if ($id ne '') {
                    701:                 my $en_terr = $locale->{'en_territory'};
                    702:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   703:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   704:                 if (grep(/^en$/,@languages) || !@languages) {
                    705:                     if ($en_terr ne '') {
                    706:                         $locale_names{$id} = '('.$en_terr.')';
                    707:                     } elsif ($native_terr ne '') {
                    708:                         $locale_names{$id} = $native_terr;
                    709:                     }
                    710:                 } else {
                    711:                     if ($native_terr ne '') {
                    712:                         $locale_names{$id} = $native_terr.' ';
                    713:                     } elsif ($en_terr ne '') {
                    714:                         $locale_names{$id} = '('.$en_terr.')';
                    715:                     }
                    716:                 }
                    717:                 push (@possibles,$id);
                    718:             }
                    719:         }
                    720:     }
                    721:     foreach my $item (sort(@possibles)) {
                    722:         $output.= '<option value="'.$item.'"';
                    723:         if ($item eq $selected) {
                    724:             $output.=' selected="selected"';
                    725:         }
                    726:         $output.=">$item";
                    727:         if ($locale_names{$item} ne '') {
                    728:             $output.="  $locale_names{$item}</option>\n";
                    729:         }
                    730:         $output.="</option>\n";
                    731:     }
                    732:     $output.="</select>";
                    733:     return $output;
                    734: }
                    735: 
1.792     raeburn   736: sub select_language {
                    737:     my ($name,$selected,$includeempty) = @_;
                    738:     my %langchoices;
                    739:     if ($includeempty) {
                    740:         %langchoices = ('' => 'No language preference');
                    741:     }
                    742:     foreach my $id (&languageids()) {
                    743:         my $code = &supportedlanguagecode($id);
                    744:         if ($code) {
                    745:             $langchoices{$code} = &plainlanguagedescription($id);
                    746:         }
                    747:     }
                    748:     return &select_form($selected,$name,%langchoices);
                    749: }
                    750: 
1.42      matthew   751: =pod
1.36      matthew   752: 
1.648     raeburn   753: =item * &linked_select_forms(...)
1.36      matthew   754: 
                    755: linked_select_forms returns a string containing a <script></script> block
                    756: and html for two <select> menus.  The select menus will be linked in that
                    757: changing the value of the first menu will result in new values being placed
                    758: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn   759: order unless a defined order is provided.
1.36      matthew   760: 
                    761: linked_select_forms takes the following ordered inputs:
                    762: 
                    763: =over 4
                    764: 
1.112     bowersj2  765: =item * $formname, the name of the <form> tag
1.36      matthew   766: 
1.112     bowersj2  767: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   768: 
1.112     bowersj2  769: =item * $firstdefault, the default value for the first menu
1.36      matthew   770: 
1.112     bowersj2  771: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   772: 
1.112     bowersj2  773: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   774: 
1.112     bowersj2  775: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   776: 
1.609     raeburn   777: =item * $menuorder, the order of values in the first menu
                    778: 
1.41      ng        779: =back 
                    780: 
1.36      matthew   781: Below is an example of such a hash.  Only the 'text', 'default', and 
                    782: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    783: values for the first select menu.  The text that coincides with the 
1.41      ng        784: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   785: and text for the second menu are given in the hash pointed to by 
                    786: $menu{$choice1}->{'select2'}.  
                    787: 
1.112     bowersj2  788:  my %menu = ( A1 => { text =>"Choice A1" ,
                    789:                        default => "B3",
                    790:                        select2 => { 
                    791:                            B1 => "Choice B1",
                    792:                            B2 => "Choice B2",
                    793:                            B3 => "Choice B3",
                    794:                            B4 => "Choice B4"
1.609     raeburn   795:                            },
                    796:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2  797:                    },
                    798:                A2 => { text =>"Choice A2" ,
                    799:                        default => "C2",
                    800:                        select2 => { 
                    801:                            C1 => "Choice C1",
                    802:                            C2 => "Choice C2",
                    803:                            C3 => "Choice C3"
1.609     raeburn   804:                            },
                    805:                        order => ['C2','C1','C3'],
1.112     bowersj2  806:                    },
                    807:                A3 => { text =>"Choice A3" ,
                    808:                        default => "D6",
                    809:                        select2 => { 
                    810:                            D1 => "Choice D1",
                    811:                            D2 => "Choice D2",
                    812:                            D3 => "Choice D3",
                    813:                            D4 => "Choice D4",
                    814:                            D5 => "Choice D5",
                    815:                            D6 => "Choice D6",
                    816:                            D7 => "Choice D7"
1.609     raeburn   817:                            },
                    818:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2  819:                    }
                    820:                );
1.36      matthew   821: 
                    822: =cut
                    823: 
                    824: sub linked_select_forms {
                    825:     my ($formname,
                    826:         $middletext,
                    827:         $firstdefault,
                    828:         $firstselectname,
                    829:         $secondselectname, 
1.609     raeburn   830:         $hashref,
                    831:         $menuorder,
1.36      matthew   832:         ) = @_;
                    833:     my $second = "document.$formname.$secondselectname";
                    834:     my $first = "document.$formname.$firstselectname";
                    835:     # output the javascript to do the changing
                    836:     my $result = '';
1.776     bisitz    837:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz    838:     $result.="// <![CDATA[\n";
1.36      matthew   839:     $result.="var select2data = new Object();\n";
                    840:     $" = '","';
                    841:     my $debug = '';
                    842:     foreach my $s1 (sort(keys(%$hashref))) {
                    843:         $result.="select2data.d_$s1 = new Object();\n";        
                    844:         $result.="select2data.d_$s1.def = new String('".
                    845:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn   846:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew   847:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn   848:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                    849:             @s2values = @{$hashref->{$s1}->{'order'}};
                    850:         }
1.36      matthew   851:         $result.="\"@s2values\");\n";
                    852:         $result.="select2data.d_$s1.texts = new Array(";        
                    853:         my @s2texts;
                    854:         foreach my $value (@s2values) {
                    855:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                    856:         }
                    857:         $result.="\"@s2texts\");\n";
                    858:     }
                    859:     $"=' ';
                    860:     $result.= <<"END";
                    861: 
                    862: function select1_changed() {
                    863:     // Determine new choice
                    864:     var newvalue = "d_" + $first.value;
                    865:     // update select2
                    866:     var values     = select2data[newvalue].values;
                    867:     var texts      = select2data[newvalue].texts;
                    868:     var select2def = select2data[newvalue].def;
                    869:     var i;
                    870:     // out with the old
                    871:     for (i = 0; i < $second.options.length; i++) {
                    872:         $second.options[i] = null;
                    873:     }
                    874:     // in with the nuclear
                    875:     for (i=0;i<values.length; i++) {
                    876:         $second.options[i] = new Option(values[i]);
1.143     matthew   877:         $second.options[i].value = values[i];
1.36      matthew   878:         $second.options[i].text = texts[i];
                    879:         if (values[i] == select2def) {
                    880:             $second.options[i].selected = true;
                    881:         }
                    882:     }
                    883: }
1.824     bisitz    884: // ]]>
1.36      matthew   885: </script>
                    886: END
                    887:     # output the initial values for the selection lists
                    888:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn   889:     my @order = sort(keys(%{$hashref}));
                    890:     if (ref($menuorder) eq 'ARRAY') {
                    891:         @order = @{$menuorder};
                    892:     }
                    893:     foreach my $value (@order) {
1.36      matthew   894:         $result.="    <option value=\"$value\" ";
1.253     albertel  895:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www       896:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew   897:     }
                    898:     $result .= "</select>\n";
                    899:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                    900:     $result .= $middletext;
                    901:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                    902:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn   903:     
                    904:     my @secondorder = sort(keys(%select2));
                    905:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                    906:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                    907:     }
                    908:     foreach my $value (@secondorder) {
1.36      matthew   909:         $result.="    <option value=\"$value\" ";        
1.253     albertel  910:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www       911:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew   912:     }
                    913:     $result .= "</select>\n";
                    914:     #    return $debug;
                    915:     return $result;
                    916: }   #  end of sub linked_select_forms {
                    917: 
1.45      matthew   918: =pod
1.44      bowersj2  919: 
1.648     raeburn   920: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44      bowersj2  921: 
1.112     bowersj2  922: Returns a string corresponding to an HTML link to the given help
                    923: $topic, where $topic corresponds to the name of a .tex file in
                    924: /home/httpd/html/adm/help/tex, with underscores replaced by
                    925: spaces. 
                    926: 
                    927: $text will optionally be linked to the same topic, allowing you to
                    928: link text in addition to the graphic. If you do not want to link
                    929: text, but wish to specify one of the later parameters, pass an
                    930: empty string. 
                    931: 
                    932: $stayOnPage is a value that will be interpreted as a boolean. If true,
                    933: the link will not open a new window. If false, the link will open
                    934: a new window using Javascript. (Default is false.) 
                    935: 
                    936: $width and $height are optional numerical parameters that will
                    937: override the width and height of the popped up window, which may
                    938: be useful for certain help topics with big pictures included. 
1.44      bowersj2  939: 
                    940: =cut
                    941: 
                    942: sub help_open_topic {
1.48      bowersj2  943:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
                    944:     $text = "" if (not defined $text);
1.44      bowersj2  945:     $stayOnPage = 0 if (not defined $stayOnPage);
                    946:     $width = 350 if (not defined $width);
                    947:     $height = 400 if (not defined $height);
                    948:     my $filename = $topic;
                    949:     $filename =~ s/ /_/g;
                    950: 
1.48      bowersj2  951:     my $template = "";
                    952:     my $link;
1.572     banghart  953:     
1.159     www       954:     $topic=~s/\W/\_/g;
1.44      bowersj2  955: 
1.572     banghart  956:     if (!$stayOnPage) {
1.72      bowersj2  957: 	$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  958:     } else {
1.48      bowersj2  959: 	$link = "/adm/help/${filename}.hlp";
                    960:     }
                    961: 
                    962:     # Add the text
1.755     neumanie  963:     if ($text ne "") {	
1.763     bisitz    964: 	$template.='<span class="LC_help_open_topic">'
                    965:                   .'<a target="_top" href="'.$link.'">'
                    966:                   .$text.'</a>';
1.48      bowersj2  967:     }
                    968: 
1.763     bisitz    969:     # (Always) Add the graphic
1.179     matthew   970:     my $title = &mt('Online Help');
1.667     raeburn   971:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763     bisitz    972:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                    973:               .'<img src="'.$helpicon.'" border="0"'
                    974:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783     amueller  975:               .' title="'.$title.'"' 
1.763     bisitz    976:               .' /></a>';
                    977:     if ($text ne "") {	
                    978:         $template.='</span>';
                    979:     }
1.44      bowersj2  980:     return $template;
                    981: 
1.106     bowersj2  982: }
                    983: 
                    984: # This is a quicky function for Latex cheatsheet editing, since it 
                    985: # appears in at least four places
                    986: sub helpLatexCheatsheet {
1.732     raeburn   987:     my ($topic,$text,$not_author) = @_;
                    988:     my $out;
1.106     bowersj2  989:     my $addOther = '';
1.732     raeburn   990:     if ($topic) {
1.763     bisitz    991: 	$addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
                    992: 							       undef, undef, 600).
                    993: 								   '</span> ';
                    994:     }
                    995:     $out = '<span>' # Start cheatsheet
                    996: 	  .$addOther
                    997:           .'<span>'
                    998: 	  .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
                    999: 					       undef,undef,600)
                   1000: 	  .'</span> <span>'
                   1001: 	  .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
                   1002: 					       undef,undef,600)
                   1003: 	  .'</span>';
1.732     raeburn  1004:     unless ($not_author) {
1.763     bisitz   1005:         $out .= ' <span>'
                   1006: 	       .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
                   1007: 	                                            undef,undef,600)
                   1008: 	       .'</span>';
1.732     raeburn  1009:     }
1.763     bisitz   1010:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1011:     return $out;
1.172     www      1012: }
                   1013: 
1.430     albertel 1014: sub general_help {
                   1015:     my $helptopic='Student_Intro';
                   1016:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1017: 	$helptopic='Authoring_Intro';
                   1018:     } elsif ($env{'request.role'}=~/^cc/) {
                   1019: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1020:     } elsif ($env{'request.role'}=~/^dc/) {
                   1021:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1022:     }
                   1023:     return $helptopic;
                   1024: }
                   1025: 
                   1026: sub update_help_link {
                   1027:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1028:     my $origurl = $ENV{'REQUEST_URI'};
                   1029:     $origurl=~s|^/~|/priv/|;
                   1030:     my $timestamp = time;
                   1031:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1032:         $$datum = &escape($$datum);
                   1033:     }
                   1034: 
                   1035:     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";
                   1036:     my $output .= <<"ENDOUTPUT";
                   1037: <script type="text/javascript">
1.824     bisitz   1038: // <![CDATA[
1.430     albertel 1039: banner_link = '$banner_link';
1.824     bisitz   1040: // ]]>
1.430     albertel 1041: </script>
                   1042: ENDOUTPUT
                   1043:     return $output;
                   1044: }
                   1045: 
                   1046: # now just updates the help link and generates a blue icon
1.193     raeburn  1047: sub help_open_menu {
1.430     albertel 1048:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1049: 	= @_;    
1.430     albertel 1050:     $stayOnPage = 0 if (not defined $stayOnPage);
1.572     banghart 1051:     # only use pop-up help (stayOnPage == 0)
1.552     banghart 1052:     # if environment.remote is on (using remote control UI)
1.798     tempelho 1053:     if ($env{'environment.remote'} eq 'off' ) {
1.552     banghart 1054:         $stayOnPage=1;
1.430     albertel 1055:     }
                   1056:     my $output;
                   1057:     if ($component_help) {
                   1058: 	if (!$text) {
                   1059: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1060: 				       $width,$height);
                   1061: 	} else {
                   1062: 	    my $help_text;
                   1063: 	    $help_text=&unescape($topic);
                   1064: 	    $output='<table><tr><td>'.
                   1065: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1066: 				 $width,$height).'</td></tr></table>';
                   1067: 	}
                   1068:     }
                   1069:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1070:     return $output.$banner_link;
                   1071: }
                   1072: 
                   1073: sub top_nav_help {
                   1074:     my ($text) = @_;
1.436     albertel 1075:     $text = &mt($text);
1.572     banghart 1076:     my $stay_on_page = 
1.798     tempelho 1077: 	($env{'environment.remote'} eq 'off' );
1.572     banghart 1078:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1079: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1080:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1081: 
1.201     raeburn  1082:     my $title = &mt('Get help');
1.436     albertel 1083: 
                   1084:     return <<"END";
                   1085: $banner_link
                   1086:  <a href="$link" title="$title">$text</a>
                   1087: END
                   1088: }
                   1089: 
                   1090: sub help_menu_js {
                   1091:     my ($text) = @_;
                   1092: 
                   1093:     my $stayOnPage = 
1.798     tempelho 1094: 	($env{'environment.remote'} eq 'off' );
1.436     albertel 1095: 
                   1096:     my $width = 620;
                   1097:     my $height = 600;
1.430     albertel 1098:     my $helptopic=&general_help();
                   1099:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1100:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1101:     my $start_page =
                   1102:         &Apache::loncommon::start_page('Help Menu', undef,
                   1103: 				       {'frameset'    => 1,
                   1104: 					'js_ready'    => 1,
                   1105: 					'add_entries' => {
                   1106: 					    'border' => '0',
1.579     raeburn  1107: 					    'rows'   => "110,*",},});
1.331     albertel 1108:     my $end_page =
                   1109:         &Apache::loncommon::end_page({'frameset' => 1,
                   1110: 				      'js_ready' => 1,});
                   1111: 
1.436     albertel 1112:     my $template .= <<"ENDTEMPLATE";
                   1113: <script type="text/javascript">
1.253     albertel 1114: // <!-- BEGIN LON-CAPA Internal
                   1115: // <![CDATA[
1.430     albertel 1116: var banner_link = '';
1.243     raeburn  1117: function helpMenu(target) {
                   1118:     var caller = this;
                   1119:     if (target == 'open') {
                   1120:         var newWindow = null;
                   1121:         try {
1.262     albertel 1122:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1123:         }
                   1124:         catch(error) {
                   1125:             writeHelp(caller);
                   1126:             return;
                   1127:         }
                   1128:         if (newWindow) {
                   1129:             caller = newWindow;
                   1130:         }
1.193     raeburn  1131:     }
1.243     raeburn  1132:     writeHelp(caller);
                   1133:     return;
                   1134: }
                   1135: function writeHelp(caller) {
1.430     albertel 1136:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1137:     caller.document.close()
                   1138:     caller.focus()
1.193     raeburn  1139: }
1.253     albertel 1140: // ]]>
1.219     albertel 1141: // END LON-CAPA Internal -->
1.436     albertel 1142: </script>
1.193     raeburn  1143: ENDTEMPLATE
                   1144:     return $template;
                   1145: }
                   1146: 
1.172     www      1147: sub help_open_bug {
                   1148:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1149:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1150:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1151:     $text = "" if (not defined $text);
                   1152:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1153:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1154: 	$stayOnPage=1;
                   1155:     }
1.184     albertel 1156:     $width = 600 if (not defined $width);
                   1157:     $height = 600 if (not defined $height);
1.172     www      1158: 
                   1159:     $topic=~s/\W+/\+/g;
                   1160:     my $link='';
                   1161:     my $template='';
1.379     albertel 1162:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1163: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1164:     if (!$stayOnPage)
                   1165:     {
                   1166: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1167:     }
                   1168:     else
                   1169:     {
                   1170: 	$link = $url;
                   1171:     }
                   1172:     # Add the text
                   1173:     if ($text ne "")
                   1174:     {
                   1175: 	$template .= 
                   1176:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1177:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1178:     }
                   1179: 
                   1180:     # Add the graphic
1.179     matthew  1181:     my $title = &mt('Report a Bug');
1.215     albertel 1182:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1183:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1184:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1185: ENDTEMPLATE
                   1186:     if ($text ne '') { $template.='</td></tr></table>' };
                   1187:     return $template;
                   1188: 
                   1189: }
                   1190: 
                   1191: sub help_open_faq {
                   1192:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1193:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1194:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1195:     $text = "" if (not defined $text);
                   1196:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1197:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1198: 	$stayOnPage=1;
                   1199:     }
                   1200:     $width = 350 if (not defined $width);
                   1201:     $height = 400 if (not defined $height);
                   1202: 
                   1203:     $topic=~s/\W+/\+/g;
                   1204:     my $link='';
                   1205:     my $template='';
                   1206:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1207:     if (!$stayOnPage)
                   1208:     {
                   1209: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1210:     }
                   1211:     else
                   1212:     {
                   1213: 	$link = $url;
                   1214:     }
                   1215: 
                   1216:     # Add the text
                   1217:     if ($text ne "")
                   1218:     {
                   1219: 	$template .= 
1.173     www      1220:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1221:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1222:     }
                   1223: 
                   1224:     # Add the graphic
1.179     matthew  1225:     my $title = &mt('View the FAQ');
1.215     albertel 1226:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1227:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1228:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1229: ENDTEMPLATE
                   1230:     if ($text ne '') { $template.='</td></tr></table>' };
                   1231:     return $template;
                   1232: 
1.44      bowersj2 1233: }
1.37      matthew  1234: 
1.180     matthew  1235: ###############################################################
                   1236: ###############################################################
                   1237: 
1.45      matthew  1238: =pod
                   1239: 
1.648     raeburn  1240: =item * &change_content_javascript():
1.256     matthew  1241: 
                   1242: This and the next function allow you to create small sections of an
                   1243: otherwise static HTML page that you can update on the fly with
                   1244: Javascript, even in Netscape 4.
                   1245: 
                   1246: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1247: must be written to the HTML page once. It will prove the Javascript
                   1248: function "change(name, content)". Calling the change function with the
                   1249: name of the section 
                   1250: you want to update, matching the name passed to C<changable_area>, and
                   1251: the new content you want to put in there, will put the content into
                   1252: that area.
                   1253: 
                   1254: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1255: to contain room for the original contents. You need to "make space"
                   1256: for whatever changes you wish to make, and be B<sure> to check your
                   1257: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1258: it's adequate for updating a one-line status display, but little more.
                   1259: This script will set the space to 100% width, so you only need to
                   1260: worry about height in Netscape 4.
                   1261: 
                   1262: Modern browsers are much less limiting, and if you can commit to the
                   1263: user not using Netscape 4, this feature may be used freely with
                   1264: pretty much any HTML.
                   1265: 
                   1266: =cut
                   1267: 
                   1268: sub change_content_javascript {
                   1269:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1270:     if ($env{'browser.type'} eq 'netscape' &&
                   1271: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1272: 	return (<<NETSCAPE4);
                   1273: 	function change(name, content) {
                   1274: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1275: 	    doc.open();
                   1276: 	    doc.write(content);
                   1277: 	    doc.close();
                   1278: 	}
                   1279: NETSCAPE4
                   1280:     } else {
                   1281: 	# Otherwise, we need to use semi-standards-compliant code
                   1282: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1283: 	# is really scary, and every useful browser supports it
                   1284: 	return (<<DOMBASED);
                   1285: 	function change(name, content) {
                   1286: 	    element = document.getElementById(name);
                   1287: 	    element.innerHTML = content;
                   1288: 	}
                   1289: DOMBASED
                   1290:     }
                   1291: }
                   1292: 
                   1293: =pod
                   1294: 
1.648     raeburn  1295: =item * &changable_area($name,$origContent):
1.256     matthew  1296: 
                   1297: This provides a "changable area" that can be modified on the fly via
                   1298: the Javascript code provided in C<change_content_javascript>. $name is
                   1299: the name you will use to reference the area later; do not repeat the
                   1300: same name on a given HTML page more then once. $origContent is what
                   1301: the area will originally contain, which can be left blank.
                   1302: 
                   1303: =cut
                   1304: 
                   1305: sub changable_area {
                   1306:     my ($name, $origContent) = @_;
                   1307: 
1.258     albertel 1308:     if ($env{'browser.type'} eq 'netscape' &&
                   1309: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1310: 	# If this is netscape 4, we need to use the Layer tag
                   1311: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1312:     } else {
                   1313: 	return "<span id='$name'>$origContent</span>";
                   1314:     }
                   1315: }
                   1316: 
                   1317: =pod
                   1318: 
1.648     raeburn  1319: =item * &viewport_geometry_js 
1.590     raeburn  1320: 
                   1321: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1322: 
                   1323: =cut
                   1324: 
                   1325: 
                   1326: sub viewport_geometry_js { 
                   1327:     return <<"GEOMETRY";
                   1328: var Geometry = {};
                   1329: function init_geometry() {
                   1330:     if (Geometry.init) { return };
                   1331:     Geometry.init=1;
                   1332:     if (window.innerHeight) {
                   1333:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1334:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1335:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1336:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1337:     }
                   1338:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1339:         Geometry.getViewportHeight =
                   1340:             function() { return document.documentElement.clientHeight; };
                   1341:         Geometry.getViewportWidth =
                   1342:             function() { return document.documentElement.clientWidth; };
                   1343: 
                   1344:         Geometry.getHorizontalScroll =
                   1345:             function() { return document.documentElement.scrollLeft; };
                   1346:         Geometry.getVerticalScroll =
                   1347:             function() { return document.documentElement.scrollTop; };
                   1348:     }
                   1349:     else if (document.body.clientHeight) {
                   1350:         Geometry.getViewportHeight =
                   1351:             function() { return document.body.clientHeight; };
                   1352:         Geometry.getViewportWidth =
                   1353:             function() { return document.body.clientWidth; };
                   1354:         Geometry.getHorizontalScroll =
                   1355:             function() { return document.body.scrollLeft; };
                   1356:         Geometry.getVerticalScroll =
                   1357:             function() { return document.body.scrollTop; };
                   1358:     }
                   1359: }
                   1360: 
                   1361: GEOMETRY
                   1362: }
                   1363: 
                   1364: =pod
                   1365: 
1.648     raeburn  1366: =item * &viewport_size_js()
1.590     raeburn  1367: 
                   1368: 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. 
                   1369: 
                   1370: =cut
                   1371: 
                   1372: sub viewport_size_js {
                   1373:     my $geometry = &viewport_geometry_js();
                   1374:     return <<"DIMS";
                   1375: 
                   1376: $geometry
                   1377: 
                   1378: function getViewportDims(width,height) {
                   1379:     init_geometry();
                   1380:     width.value = Geometry.getViewportWidth();
                   1381:     height.value = Geometry.getViewportHeight();
                   1382:     return;
                   1383: }
                   1384: 
                   1385: DIMS
                   1386: }
                   1387: 
                   1388: =pod
                   1389: 
1.648     raeburn  1390: =item * &resize_textarea_js()
1.565     albertel 1391: 
                   1392: emits the needed javascript to resize a textarea to be as big as possible
                   1393: 
                   1394: creates a function resize_textrea that takes two IDs first should be
                   1395: the id of the element to resize, second should be the id of a div that
                   1396: surrounds everything that comes after the textarea, this routine needs
                   1397: to be attached to the <body> for the onload and onresize events.
                   1398: 
1.648     raeburn  1399: =back
1.565     albertel 1400: 
                   1401: =cut
                   1402: 
                   1403: sub resize_textarea_js {
1.590     raeburn  1404:     my $geometry = &viewport_geometry_js();
1.565     albertel 1405:     return <<"RESIZE";
                   1406:     <script type="text/javascript">
1.824     bisitz   1407: // <![CDATA[
1.590     raeburn  1408: $geometry
1.565     albertel 1409: 
1.588     albertel 1410: function getX(element) {
                   1411:     var x = 0;
                   1412:     while (element) {
                   1413: 	x += element.offsetLeft;
                   1414: 	element = element.offsetParent;
                   1415:     }
                   1416:     return x;
                   1417: }
                   1418: function getY(element) {
                   1419:     var y = 0;
                   1420:     while (element) {
                   1421: 	y += element.offsetTop;
                   1422: 	element = element.offsetParent;
                   1423:     }
                   1424:     return y;
                   1425: }
                   1426: 
                   1427: 
1.565     albertel 1428: function resize_textarea(textarea_id,bottom_id) {
                   1429:     init_geometry();
                   1430:     var textarea        = document.getElementById(textarea_id);
                   1431:     //alert(textarea);
                   1432: 
1.588     albertel 1433:     var textarea_top    = getY(textarea);
1.565     albertel 1434:     var textarea_height = textarea.offsetHeight;
                   1435:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1436:     var bottom_top      = getY(bottom);
1.565     albertel 1437:     var bottom_height   = bottom.offsetHeight;
                   1438:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1439:     var fudge           = 23;
1.565     albertel 1440:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1441:     if (new_height < 300) {
                   1442: 	new_height = 300;
                   1443:     }
                   1444:     textarea.style.height=new_height+'px';
                   1445: }
1.824     bisitz   1446: // ]]>
1.565     albertel 1447: </script>
                   1448: RESIZE
                   1449: 
                   1450: }
                   1451: 
                   1452: =pod
                   1453: 
1.256     matthew  1454: =head1 Excel and CSV file utility routines
                   1455: 
                   1456: =over 4
                   1457: 
                   1458: =cut
                   1459: 
                   1460: ###############################################################
                   1461: ###############################################################
                   1462: 
                   1463: =pod
                   1464: 
1.648     raeburn  1465: =item * &csv_translate($text) 
1.37      matthew  1466: 
1.185     www      1467: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1468: format.
                   1469: 
                   1470: =cut
                   1471: 
1.180     matthew  1472: ###############################################################
                   1473: ###############################################################
1.37      matthew  1474: sub csv_translate {
                   1475:     my $text = shift;
                   1476:     $text =~ s/\"/\"\"/g;
1.209     albertel 1477:     $text =~ s/\n/ /g;
1.37      matthew  1478:     return $text;
                   1479: }
1.180     matthew  1480: 
                   1481: ###############################################################
                   1482: ###############################################################
                   1483: 
                   1484: =pod
                   1485: 
1.648     raeburn  1486: =item * &define_excel_formats()
1.180     matthew  1487: 
                   1488: Define some commonly used Excel cell formats.
                   1489: 
                   1490: Currently supported formats:
                   1491: 
                   1492: =over 4
                   1493: 
                   1494: =item header
                   1495: 
                   1496: =item bold
                   1497: 
                   1498: =item h1
                   1499: 
                   1500: =item h2
                   1501: 
                   1502: =item h3
                   1503: 
1.256     matthew  1504: =item h4
                   1505: 
                   1506: =item i
                   1507: 
1.180     matthew  1508: =item date
                   1509: 
                   1510: =back
                   1511: 
                   1512: Inputs: $workbook
                   1513: 
                   1514: Returns: $format, a hash reference.
                   1515: 
                   1516: =cut
                   1517: 
                   1518: ###############################################################
                   1519: ###############################################################
                   1520: sub define_excel_formats {
                   1521:     my ($workbook) = @_;
                   1522:     my $format;
                   1523:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1524:                                                 bottom    => 1,
                   1525:                                                 align     => 'center');
                   1526:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1527:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1528:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1529:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1530:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1531:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1532:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1533:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1534:     return $format;
                   1535: }
                   1536: 
                   1537: ###############################################################
                   1538: ###############################################################
1.113     bowersj2 1539: 
                   1540: =pod
                   1541: 
1.648     raeburn  1542: =item * &create_workbook()
1.255     matthew  1543: 
                   1544: Create an Excel worksheet.  If it fails, output message on the
                   1545: request object and return undefs.
                   1546: 
                   1547: Inputs: Apache request object
                   1548: 
                   1549: Returns (undef) on failure, 
                   1550:     Excel worksheet object, scalar with filename, and formats 
                   1551:     from &Apache::loncommon::define_excel_formats on success
                   1552: 
                   1553: =cut
                   1554: 
                   1555: ###############################################################
                   1556: ###############################################################
                   1557: sub create_workbook {
                   1558:     my ($r) = @_;
                   1559:         #
                   1560:     # Create the excel spreadsheet
                   1561:     my $filename = '/prtspool/'.
1.258     albertel 1562:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1563:         time.'_'.rand(1000000000).'.xls';
                   1564:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1565:     if (! defined($workbook)) {
                   1566:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                   1567:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                   1568:                             "This error has been logged.  ".
                   1569:                             "Please alert your LON-CAPA administrator").
                   1570:                   '</p>');
                   1571:         return (undef);
                   1572:     }
                   1573:     #
                   1574:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1575:     #
                   1576:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1577:     return ($workbook,$filename,$format);
                   1578: }
                   1579: 
                   1580: ###############################################################
                   1581: ###############################################################
                   1582: 
                   1583: =pod
                   1584: 
1.648     raeburn  1585: =item * &create_text_file()
1.113     bowersj2 1586: 
1.542     raeburn  1587: Create a file to write to and eventually make available to the user.
1.256     matthew  1588: If file creation fails, outputs an error message on the request object and 
                   1589: return undefs.
1.113     bowersj2 1590: 
1.256     matthew  1591: Inputs: Apache request object, and file suffix
1.113     bowersj2 1592: 
1.256     matthew  1593: Returns (undef) on failure, 
                   1594:     Filehandle and filename on success.
1.113     bowersj2 1595: 
                   1596: =cut
                   1597: 
1.256     matthew  1598: ###############################################################
                   1599: ###############################################################
                   1600: sub create_text_file {
                   1601:     my ($r,$suffix) = @_;
                   1602:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1603:     my $fh;
                   1604:     my $filename = '/prtspool/'.
1.258     albertel 1605:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1606:         time.'_'.rand(1000000000).'.'.$suffix;
                   1607:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1608:     if (! defined($fh)) {
                   1609:         $r->log_error("Couldn't open $filename for output $!");
1.683     bisitz   1610:         $r->print(&mt('Problems occurred in creating the output file. '
                   1611:                      .'This error has been logged. '
                   1612:                      .'Please alert your LON-CAPA administrator.'));
1.113     bowersj2 1613:     }
1.256     matthew  1614:     return ($fh,$filename)
1.113     bowersj2 1615: }
                   1616: 
                   1617: 
1.256     matthew  1618: =pod 
1.113     bowersj2 1619: 
                   1620: =back
                   1621: 
                   1622: =cut
1.37      matthew  1623: 
                   1624: ###############################################################
1.33      matthew  1625: ##        Home server <option> list generating code          ##
                   1626: ###############################################################
1.35      matthew  1627: 
1.169     www      1628: # ------------------------------------------
                   1629: 
                   1630: sub domain_select {
                   1631:     my ($name,$value,$multiple)=@_;
                   1632:     my %domains=map { 
1.514     albertel 1633: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1634:     } &Apache::lonnet::all_domains();
1.169     www      1635:     if ($multiple) {
                   1636: 	$domains{''}=&mt('Any domain');
1.550     albertel 1637: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1638: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1639:     } else {
1.550     albertel 1640: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169     www      1641: 	return &select_form($name,$value,%domains);
                   1642:     }
                   1643: }
                   1644: 
1.282     albertel 1645: #-------------------------------------------
                   1646: 
                   1647: =pod
                   1648: 
1.519     raeburn  1649: =head1 Routines for form select boxes
                   1650: 
                   1651: =over 4
                   1652: 
1.648     raeburn  1653: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1654: 
                   1655: Returns a string containing a <select> element int multiple mode
                   1656: 
                   1657: 
                   1658: Args:
                   1659:   $name - name of the <select> element
1.506     raeburn  1660:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1661:   $size - number of rows long the select element is
1.283     albertel 1662:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1663:           (shown text should already have been &mt())
1.506     raeburn  1664:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1665: 
1.282     albertel 1666: =cut
                   1667: 
                   1668: #-------------------------------------------
1.169     www      1669: sub multiple_select_form {
1.284     albertel 1670:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1671:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1672:     my $output='';
1.191     matthew  1673:     if (! defined($size)) {
                   1674:         $size = 4;
1.283     albertel 1675:         if (scalar(keys(%$hash))<4) {
                   1676:             $size = scalar(keys(%$hash));
1.191     matthew  1677:         }
                   1678:     }
1.734     bisitz   1679:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1680:     my @order;
1.506     raeburn  1681:     if (ref($order) eq 'ARRAY')  {
                   1682:         @order = @{$order};
                   1683:     } else {
                   1684:         @order = sort(keys(%$hash));
1.501     banghart 1685:     }
                   1686:     if (exists($$hash{'select_form_order'})) {
                   1687:         @order = @{$$hash{'select_form_order'}};
                   1688:     }
                   1689:         
1.284     albertel 1690:     foreach my $key (@order) {
1.356     albertel 1691:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1692:         $output.='selected="selected" ' if ($selected{$key});
                   1693:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1694:     }
                   1695:     $output.="</select>\n";
                   1696:     return $output;
                   1697: }
                   1698: 
1.88      www      1699: #-------------------------------------------
                   1700: 
                   1701: =pod
                   1702: 
1.648     raeburn  1703: =item * &select_form($defdom,$name,%hash)
1.88      www      1704: 
                   1705: Returns a string containing a <select name='$name' size='1'> form to 
                   1706: allow a user to select options from a hash option_name => displayed text.  
                   1707: See lonrights.pm for an example invocation and use.
                   1708: 
                   1709: =cut
                   1710: 
                   1711: #-------------------------------------------
                   1712: sub select_form {
                   1713:     my ($def,$name,%hash) = @_;
                   1714:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1715:     my @keys;
                   1716:     if (exists($hash{'select_form_order'})) {
                   1717: 	@keys=@{$hash{'select_form_order'}};
                   1718:     } else {
                   1719: 	@keys=sort(keys(%hash));
                   1720:     }
1.356     albertel 1721:     foreach my $key (@keys) {
                   1722:         $selectform.=
                   1723: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1724:             ($key eq $def ? 'selected="selected" ' : '').
                   1725:                 ">".&mt($hash{$key})."</option>\n";
1.88      www      1726:     }
                   1727:     $selectform.="</select>";
                   1728:     return $selectform;
                   1729: }
                   1730: 
1.475     www      1731: # For display filters
                   1732: 
                   1733: sub display_filter {
                   1734:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1735:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1736:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1737: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1738: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1739: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1740:            &mt('Filter [_1]',
1.477     www      1741: 	   &select_form($env{'form.displayfilter'},
                   1742: 			'displayfilter',
                   1743: 			('currentfolder' => 'Current folder/page',
                   1744: 			 'containing' => 'Containing phrase',
                   1745: 			 'none' => 'None'))).
1.714     bisitz   1746: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1747: }
                   1748: 
1.167     www      1749: sub gradeleveldescription {
                   1750:     my $gradelevel=shift;
                   1751:     my %gradelevels=(0 => 'Not specified',
                   1752: 		     1 => 'Grade 1',
                   1753: 		     2 => 'Grade 2',
                   1754: 		     3 => 'Grade 3',
                   1755: 		     4 => 'Grade 4',
                   1756: 		     5 => 'Grade 5',
                   1757: 		     6 => 'Grade 6',
                   1758: 		     7 => 'Grade 7',
                   1759: 		     8 => 'Grade 8',
                   1760: 		     9 => 'Grade 9',
                   1761: 		     10 => 'Grade 10',
                   1762: 		     11 => 'Grade 11',
                   1763: 		     12 => 'Grade 12',
                   1764: 		     13 => 'Grade 13',
                   1765: 		     14 => '100 Level',
                   1766: 		     15 => '200 Level',
                   1767: 		     16 => '300 Level',
                   1768: 		     17 => '400 Level',
                   1769: 		     18 => 'Graduate Level');
                   1770:     return &mt($gradelevels{$gradelevel});
                   1771: }
                   1772: 
1.163     www      1773: sub select_level_form {
                   1774:     my ($deflevel,$name)=@_;
                   1775:     unless ($deflevel) { $deflevel=0; }
1.167     www      1776:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1777:     for (my $i=0; $i<=18; $i++) {
                   1778:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1779:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1780:                 ">".&gradeleveldescription($i)."</option>\n";
                   1781:     }
                   1782:     $selectform.="</select>";
                   1783:     return $selectform;
1.163     www      1784: }
1.167     www      1785: 
1.35      matthew  1786: #-------------------------------------------
                   1787: 
1.45      matthew  1788: =pod
                   1789: 
1.743     raeburn  1790: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$autosubmit)
1.35      matthew  1791: 
                   1792: Returns a string containing a <select name='$name' size='1'> form to 
                   1793: allow a user to select the domain to preform an operation in.  
                   1794: See loncreateuser.pm for an example invocation and use.
                   1795: 
1.90      www      1796: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1797: selected");
                   1798: 
1.743     raeburn  1799: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   1800: 
                   1801: If the $autosubmit flag is set, the form containing the domain selector will be auto-submitted by an onchange action.  
1.563     raeburn  1802: 
1.35      matthew  1803: =cut
                   1804: 
                   1805: #-------------------------------------------
1.34      matthew  1806: sub select_dom_form {
1.743     raeburn  1807:     my ($defdom,$name,$includeempty,$showdomdesc,$autosubmit) = @_;
                   1808:     my $onchange;
                   1809:     if ($autosubmit) {
                   1810:         $onchange = ' onchange="this.form.submit()"';
                   1811:     }
1.550     albertel 1812:     my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90      www      1813:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  1814:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 1815:     foreach my $dom (@domains) {
                   1816:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  1817:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   1818:         if ($showdomdesc) {
                   1819:             if ($dom ne '') {
                   1820:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   1821:                 if ($domdesc ne '') {
                   1822:                     $selectdomain .= ' ('.$domdesc.')';
                   1823:                 }
                   1824:             } 
                   1825:         }
                   1826:         $selectdomain .= "</option>\n";
1.34      matthew  1827:     }
                   1828:     $selectdomain.="</select>";
                   1829:     return $selectdomain;
                   1830: }
                   1831: 
1.35      matthew  1832: #-------------------------------------------
                   1833: 
1.45      matthew  1834: =pod
                   1835: 
1.648     raeburn  1836: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  1837: 
1.586     raeburn  1838: input: 4 arguments (two required, two optional) - 
                   1839:     $domain - domain of new user
                   1840:     $name - name of form element
                   1841:     $default - Value of 'default' causes a default item to be first 
                   1842:                             option, and selected by default. 
                   1843:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   1844:                             if 1 server found, or default, if 0 found.
1.594     raeburn  1845: output: returns 2 items: 
1.586     raeburn  1846: (a) form element which contains either:
                   1847:    (i) <select name="$name">
                   1848:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   1849:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   1850:        </select>
                   1851:        form item if there are multiple library servers in $domain, or
                   1852:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   1853:        if there is only one library server in $domain.
                   1854: 
                   1855: (b) number of library servers found.
                   1856: 
                   1857: See loncreateuser.pm for example of use.
1.35      matthew  1858: 
                   1859: =cut
                   1860: 
                   1861: #-------------------------------------------
1.586     raeburn  1862: sub home_server_form_item {
                   1863:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 1864:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  1865:     my $result;
                   1866:     my $numlib = keys(%servers);
                   1867:     if ($numlib > 1) {
                   1868:         $result .= '<select name="'.$name.'" />'."\n";
                   1869:         if ($default) {
1.804     bisitz   1870:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  1871:                        '</option>'."\n";
                   1872:         }
                   1873:         foreach my $hostid (sort(keys(%servers))) {
                   1874:             $result.= '<option value="'.$hostid.'">'.
                   1875: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   1876:         }
                   1877:         $result .= '</select>'."\n";
                   1878:     } elsif ($numlib == 1) {
                   1879:         my $hostid;
                   1880:         foreach my $item (keys(%servers)) {
                   1881:             $hostid = $item;
                   1882:         }
                   1883:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   1884:                    $hostid.'" />';
                   1885:                    if (!$hide) {
                   1886:                        $result .= $hostid.' '.$servers{$hostid};
                   1887:                    }
                   1888:                    $result .= "\n";
                   1889:     } elsif ($default) {
                   1890:         $result .= '<input type="hidden" name="'.$name.
                   1891:                    '" value="default" />';
                   1892:                    if (!$hide) {
                   1893:                        $result .= &mt('default');
                   1894:                    }
                   1895:                    $result .= "\n";
1.33      matthew  1896:     }
1.586     raeburn  1897:     return ($result,$numlib);
1.33      matthew  1898: }
1.112     bowersj2 1899: 
                   1900: =pod
                   1901: 
1.534     albertel 1902: =back 
                   1903: 
1.112     bowersj2 1904: =cut
1.87      matthew  1905: 
                   1906: ###############################################################
1.112     bowersj2 1907: ##                  Decoding User Agent                      ##
1.87      matthew  1908: ###############################################################
                   1909: 
                   1910: =pod
                   1911: 
1.112     bowersj2 1912: =head1 Decoding the User Agent
                   1913: 
                   1914: =over 4
                   1915: 
                   1916: =item * &decode_user_agent()
1.87      matthew  1917: 
                   1918: Inputs: $r
                   1919: 
                   1920: Outputs:
                   1921: 
                   1922: =over 4
                   1923: 
1.112     bowersj2 1924: =item * $httpbrowser
1.87      matthew  1925: 
1.112     bowersj2 1926: =item * $clientbrowser
1.87      matthew  1927: 
1.112     bowersj2 1928: =item * $clientversion
1.87      matthew  1929: 
1.112     bowersj2 1930: =item * $clientmathml
1.87      matthew  1931: 
1.112     bowersj2 1932: =item * $clientunicode
1.87      matthew  1933: 
1.112     bowersj2 1934: =item * $clientos
1.87      matthew  1935: 
                   1936: =back
                   1937: 
1.157     matthew  1938: =back 
                   1939: 
1.87      matthew  1940: =cut
                   1941: 
                   1942: ###############################################################
                   1943: ###############################################################
                   1944: sub decode_user_agent {
1.247     albertel 1945:     my ($r)=@_;
1.87      matthew  1946:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   1947:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   1948:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 1949:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  1950:     my $clientbrowser='unknown';
                   1951:     my $clientversion='0';
                   1952:     my $clientmathml='';
                   1953:     my $clientunicode='0';
                   1954:     for (my $i=0;$i<=$#browsertype;$i++) {
                   1955:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   1956: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   1957: 	    $clientbrowser=$bname;
                   1958:             $httpbrowser=~/$vreg/i;
                   1959: 	    $clientversion=$1;
                   1960:             $clientmathml=($clientversion>=$minv);
                   1961:             $clientunicode=($clientversion>=$univ);
                   1962: 	}
                   1963:     }
                   1964:     my $clientos='unknown';
                   1965:     if (($httpbrowser=~/linux/i) ||
                   1966:         ($httpbrowser=~/unix/i) ||
                   1967:         ($httpbrowser=~/ux/i) ||
                   1968:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   1969:     if (($httpbrowser=~/vax/i) ||
                   1970:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   1971:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   1972:     if (($httpbrowser=~/mac/i) ||
                   1973:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   1974:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   1975:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   1976:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   1977:             $clientunicode,$clientos,);
                   1978: }
                   1979: 
1.32      matthew  1980: ###############################################################
                   1981: ##    Authentication changing form generation subroutines    ##
                   1982: ###############################################################
                   1983: ##
                   1984: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   1985: ## hash, and have reasonable default values.
                   1986: ##
                   1987: ##    formname = the name given in the <form> tag.
1.35      matthew  1988: #-------------------------------------------
                   1989: 
1.45      matthew  1990: =pod
                   1991: 
1.112     bowersj2 1992: =head1 Authentication Routines
                   1993: 
                   1994: =over 4
                   1995: 
1.648     raeburn  1996: =item * &authform_xxxxxx()
1.35      matthew  1997: 
                   1998: The authform_xxxxxx subroutines provide javascript and html forms which 
                   1999: handle some of the conveniences required for authentication forms.  
                   2000: This is not an optimal method, but it works.  
                   2001: 
                   2002: =over 4
                   2003: 
1.112     bowersj2 2004: =item * authform_header
1.35      matthew  2005: 
1.112     bowersj2 2006: =item * authform_authorwarning
1.35      matthew  2007: 
1.112     bowersj2 2008: =item * authform_nochange
1.35      matthew  2009: 
1.112     bowersj2 2010: =item * authform_kerberos
1.35      matthew  2011: 
1.112     bowersj2 2012: =item * authform_internal
1.35      matthew  2013: 
1.112     bowersj2 2014: =item * authform_filesystem
1.35      matthew  2015: 
                   2016: =back
                   2017: 
1.648     raeburn  2018: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2019: 
1.35      matthew  2020: =cut
                   2021: 
                   2022: #-------------------------------------------
1.32      matthew  2023: sub authform_header{  
                   2024:     my %in = (
                   2025:         formname => 'cu',
1.80      albertel 2026:         kerb_def_dom => '',
1.32      matthew  2027:         @_,
                   2028:     );
                   2029:     $in{'formname'} = 'document.' . $in{'formname'};
                   2030:     my $result='';
1.80      albertel 2031: 
                   2032: #---------------------------------------------- Code for upper case translation
                   2033:     my $Javascript_toUpperCase;
                   2034:     unless ($in{kerb_def_dom}) {
                   2035:         $Javascript_toUpperCase =<<"END";
                   2036:         switch (choice) {
                   2037:            case 'krb': currentform.elements[choicearg].value =
                   2038:                currentform.elements[choicearg].value.toUpperCase();
                   2039:                break;
                   2040:            default:
                   2041:         }
                   2042: END
                   2043:     } else {
                   2044:         $Javascript_toUpperCase = "";
                   2045:     }
                   2046: 
1.165     raeburn  2047:     my $radioval = "'nochange'";
1.591     raeburn  2048:     if (defined($in{'curr_authtype'})) {
                   2049:         if ($in{'curr_authtype'} ne '') {
                   2050:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2051:         }
1.174     matthew  2052:     }
1.165     raeburn  2053:     my $argfield = 'null';
1.591     raeburn  2054:     if (defined($in{'mode'})) {
1.165     raeburn  2055:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2056:             if (defined($in{'curr_autharg'})) {
                   2057:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2058:                     $argfield = "'$in{'curr_autharg'}'";
                   2059:                 }
                   2060:             }
                   2061:         }
                   2062:     }
                   2063: 
1.32      matthew  2064:     $result.=<<"END";
                   2065: var current = new Object();
1.165     raeburn  2066: current.radiovalue = $radioval;
                   2067: current.argfield = $argfield;
1.32      matthew  2068: 
                   2069: function changed_radio(choice,currentform) {
                   2070:     var choicearg = choice + 'arg';
                   2071:     // If a radio button in changed, we need to change the argfield
                   2072:     if (current.radiovalue != choice) {
                   2073:         current.radiovalue = choice;
                   2074:         if (current.argfield != null) {
                   2075:             currentform.elements[current.argfield].value = '';
                   2076:         }
                   2077:         if (choice == 'nochange') {
                   2078:             current.argfield = null;
                   2079:         } else {
                   2080:             current.argfield = choicearg;
                   2081:             switch(choice) {
                   2082:                 case 'krb': 
                   2083:                     currentform.elements[current.argfield].value = 
                   2084:                         "$in{'kerb_def_dom'}";
                   2085:                 break;
                   2086:               default:
                   2087:                 break;
                   2088:             }
                   2089:         }
                   2090:     }
                   2091:     return;
                   2092: }
1.22      www      2093: 
1.32      matthew  2094: function changed_text(choice,currentform) {
                   2095:     var choicearg = choice + 'arg';
                   2096:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2097:         $Javascript_toUpperCase
1.32      matthew  2098:         // clear old field
                   2099:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2100:             currentform.elements[current.argfield].value = '';
                   2101:         }
                   2102:         current.argfield = choicearg;
                   2103:     }
                   2104:     set_auth_radio_buttons(choice,currentform);
                   2105:     return;
1.20      www      2106: }
1.32      matthew  2107: 
                   2108: function set_auth_radio_buttons(newvalue,currentform) {
                   2109:     var i=0;
                   2110:     while (i < currentform.login.length) {
                   2111:         if (currentform.login[i].value == newvalue) { break; }
                   2112:         i++;
                   2113:     }
                   2114:     if (i == currentform.login.length) {
                   2115:         return;
                   2116:     }
                   2117:     current.radiovalue = newvalue;
                   2118:     currentform.login[i].checked = true;
                   2119:     return;
                   2120: }
                   2121: END
                   2122:     return $result;
                   2123: }
                   2124: 
                   2125: sub authform_authorwarning{
                   2126:     my $result='';
1.144     matthew  2127:     $result='<i>'.
                   2128:         &mt('As a general rule, only authors or co-authors should be '.
                   2129:             'filesystem authenticated '.
                   2130:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2131:     return $result;
                   2132: }
                   2133: 
                   2134: sub authform_nochange{  
                   2135:     my %in = (
                   2136:               formname => 'document.cu',
                   2137:               kerb_def_dom => 'MSU.EDU',
                   2138:               @_,
                   2139:           );
1.586     raeburn  2140:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2141:     my $result;
                   2142:     if (keys(%can_assign) == 0) {
                   2143:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2144:     } else {
                   2145:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2146:                   '<input type="radio" name="login" value="nochange" '.
                   2147:                   'checked="checked" onclick="'.
1.281     albertel 2148:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2149: 	    '</label>';
1.586     raeburn  2150:     }
1.32      matthew  2151:     return $result;
                   2152: }
                   2153: 
1.591     raeburn  2154: sub authform_kerberos {
1.32      matthew  2155:     my %in = (
                   2156:               formname => 'document.cu',
                   2157:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2158:               kerb_def_auth => 'krb4',
1.32      matthew  2159:               @_,
                   2160:               );
1.586     raeburn  2161:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2162:         $autharg,$jscall);
                   2163:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2164:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2165:        $check5 = ' checked="checked"';
1.80      albertel 2166:     } else {
1.772     bisitz   2167:        $check4 = ' checked="checked"';
1.80      albertel 2168:     }
1.165     raeburn  2169:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2170:     if (defined($in{'curr_authtype'})) {
                   2171:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2172:             $krbcheck = ' checked="checked"';
1.623     raeburn  2173:             if (defined($in{'mode'})) {
                   2174:                 if ($in{'mode'} eq 'modifyuser') {
                   2175:                     $krbcheck = '';
                   2176:                 }
                   2177:             }
1.591     raeburn  2178:             if (defined($in{'curr_kerb_ver'})) {
                   2179:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2180:                     $check5 = ' checked="checked"';
1.591     raeburn  2181:                     $check4 = '';
                   2182:                 } else {
1.772     bisitz   2183:                     $check4 = ' checked="checked"';
1.591     raeburn  2184:                     $check5 = '';
                   2185:                 }
1.586     raeburn  2186:             }
1.591     raeburn  2187:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2188:                 $krbarg = $in{'curr_autharg'};
                   2189:             }
1.586     raeburn  2190:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2191:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2192:                     $result = 
                   2193:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2194:         $in{'curr_autharg'},$krbver);
                   2195:                 } else {
                   2196:                     $result =
                   2197:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2198:                 }
                   2199:                 return $result; 
                   2200:             }
                   2201:         }
                   2202:     } else {
                   2203:         if ($authnum == 1) {
1.784     bisitz   2204:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2205:         }
                   2206:     }
1.586     raeburn  2207:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2208:         return;
1.587     raeburn  2209:     } elsif ($authtype eq '') {
1.591     raeburn  2210:         if (defined($in{'mode'})) {
1.587     raeburn  2211:             if ($in{'mode'} eq 'modifycourse') {
                   2212:                 if ($authnum == 1) {
1.784     bisitz   2213:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2214:                 }
                   2215:             }
                   2216:         }
1.586     raeburn  2217:     }
                   2218:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2219:     if ($authtype eq '') {
                   2220:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2221:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2222:                     $krbcheck.' />';
                   2223:     }
                   2224:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2225:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2226:          $in{'curr_authtype'} eq 'krb5') ||
                   2227:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2228:          $in{'curr_authtype'} eq 'krb4')) {
                   2229:         $result .= &mt
1.144     matthew  2230:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2231:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2232:          '<label>'.$authtype,
1.281     albertel 2233:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2234:              'value="'.$krbarg.'" '.
1.144     matthew  2235:              'onchange="'.$jscall.'" />',
1.281     albertel 2236:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2237:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2238: 	 '</label>');
1.586     raeburn  2239:     } elsif ($can_assign{'krb4'}) {
                   2240:         $result .= &mt
                   2241:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2242:          '[_3] Version 4 [_4]',
                   2243:          '<label>'.$authtype,
                   2244:          '</label><input type="text" size="10" name="krbarg" '.
                   2245:              'value="'.$krbarg.'" '.
                   2246:              'onchange="'.$jscall.'" />',
                   2247:          '<label><input type="hidden" name="krbver" value="4" />',
                   2248:          '</label>');
                   2249:     } elsif ($can_assign{'krb5'}) {
                   2250:         $result .= &mt
                   2251:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2252:          '[_3] Version 5 [_4]',
                   2253:          '<label>'.$authtype,
                   2254:          '</label><input type="text" size="10" name="krbarg" '.
                   2255:              'value="'.$krbarg.'" '.
                   2256:              'onchange="'.$jscall.'" />',
                   2257:          '<label><input type="hidden" name="krbver" value="5" />',
                   2258:          '</label>');
                   2259:     }
1.32      matthew  2260:     return $result;
                   2261: }
                   2262: 
                   2263: sub authform_internal{  
1.586     raeburn  2264:     my %in = (
1.32      matthew  2265:                 formname => 'document.cu',
                   2266:                 kerb_def_dom => 'MSU.EDU',
                   2267:                 @_,
                   2268:                 );
1.586     raeburn  2269:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2270:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2271:     if (defined($in{'curr_authtype'})) {
                   2272:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2273:             if ($can_assign{'int'}) {
1.772     bisitz   2274:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2275:                 if (defined($in{'mode'})) {
                   2276:                     if ($in{'mode'} eq 'modifyuser') {
                   2277:                         $intcheck = '';
                   2278:                     }
                   2279:                 }
1.591     raeburn  2280:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2281:                     $intarg = $in{'curr_autharg'};
                   2282:                 }
                   2283:             } else {
                   2284:                 $result = &mt('Currently internally authenticated.');
                   2285:                 return $result;
1.165     raeburn  2286:             }
                   2287:         }
1.586     raeburn  2288:     } else {
                   2289:         if ($authnum == 1) {
1.784     bisitz   2290:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2291:         }
                   2292:     }
                   2293:     if (!$can_assign{'int'}) {
                   2294:         return;
1.587     raeburn  2295:     } elsif ($authtype eq '') {
1.591     raeburn  2296:         if (defined($in{'mode'})) {
1.587     raeburn  2297:             if ($in{'mode'} eq 'modifycourse') {
                   2298:                 if ($authnum == 1) {
1.784     bisitz   2299:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2300:                 }
                   2301:             }
                   2302:         }
1.165     raeburn  2303:     }
1.586     raeburn  2304:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2305:     if ($authtype eq '') {
                   2306:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2307:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2308:     }
1.605     bisitz   2309:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2310:                $intarg.'" onchange="'.$jscall.'" />';
                   2311:     $result = &mt
1.144     matthew  2312:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2313:          '<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2314:     $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  2315:     return $result;
                   2316: }
                   2317: 
                   2318: sub authform_local{  
                   2319:     my %in = (
                   2320:               formname => 'document.cu',
                   2321:               kerb_def_dom => 'MSU.EDU',
                   2322:               @_,
                   2323:               );
1.586     raeburn  2324:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2325:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2326:     if (defined($in{'curr_authtype'})) {
                   2327:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2328:             if ($can_assign{'loc'}) {
1.772     bisitz   2329:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2330:                 if (defined($in{'mode'})) {
                   2331:                     if ($in{'mode'} eq 'modifyuser') {
                   2332:                         $loccheck = '';
                   2333:                     }
                   2334:                 }
1.591     raeburn  2335:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2336:                     $locarg = $in{'curr_autharg'};
                   2337:                 }
                   2338:             } else {
                   2339:                 $result = &mt('Currently using local (institutional) authentication.');
                   2340:                 return $result;
1.165     raeburn  2341:             }
                   2342:         }
1.586     raeburn  2343:     } else {
                   2344:         if ($authnum == 1) {
1.784     bisitz   2345:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2346:         }
                   2347:     }
                   2348:     if (!$can_assign{'loc'}) {
                   2349:         return;
1.587     raeburn  2350:     } elsif ($authtype eq '') {
1.591     raeburn  2351:         if (defined($in{'mode'})) {
1.587     raeburn  2352:             if ($in{'mode'} eq 'modifycourse') {
                   2353:                 if ($authnum == 1) {
1.784     bisitz   2354:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2355:                 }
                   2356:             }
                   2357:         }
1.165     raeburn  2358:     }
1.586     raeburn  2359:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2360:     if ($authtype eq '') {
                   2361:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2362:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2363:                     $jscall.'" />';
                   2364:     }
                   2365:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2366:                $locarg.'" onchange="'.$jscall.'" />';
                   2367:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2368:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2369:     return $result;
                   2370: }
                   2371: 
                   2372: sub authform_filesystem{  
                   2373:     my %in = (
                   2374:               formname => 'document.cu',
                   2375:               kerb_def_dom => 'MSU.EDU',
                   2376:               @_,
                   2377:               );
1.586     raeburn  2378:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2379:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2380:     if (defined($in{'curr_authtype'})) {
                   2381:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2382:             if ($can_assign{'fsys'}) {
1.772     bisitz   2383:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2384:                 if (defined($in{'mode'})) {
                   2385:                     if ($in{'mode'} eq 'modifyuser') {
                   2386:                         $fsyscheck = '';
                   2387:                     }
                   2388:                 }
1.586     raeburn  2389:             } else {
                   2390:                 $result = &mt('Currently Filesystem Authenticated.');
                   2391:                 return $result;
                   2392:             }           
                   2393:         }
                   2394:     } else {
                   2395:         if ($authnum == 1) {
1.784     bisitz   2396:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2397:         }
                   2398:     }
                   2399:     if (!$can_assign{'fsys'}) {
                   2400:         return;
1.587     raeburn  2401:     } elsif ($authtype eq '') {
1.591     raeburn  2402:         if (defined($in{'mode'})) {
1.587     raeburn  2403:             if ($in{'mode'} eq 'modifycourse') {
                   2404:                 if ($authnum == 1) {
1.784     bisitz   2405:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2406:                 }
                   2407:             }
                   2408:         }
1.586     raeburn  2409:     }
                   2410:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2411:     if ($authtype eq '') {
                   2412:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2413:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2414:                     $jscall.'" />';
                   2415:     }
                   2416:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2417:                ' onchange="'.$jscall.'" />';
                   2418:     $result = &mt
1.144     matthew  2419:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2420:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2421:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2422:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2423:                   'onchange="'.$jscall.'" />');
1.32      matthew  2424:     return $result;
                   2425: }
                   2426: 
1.586     raeburn  2427: sub get_assignable_auth {
                   2428:     my ($dom) = @_;
                   2429:     if ($dom eq '') {
                   2430:         $dom = $env{'request.role.domain'};
                   2431:     }
                   2432:     my %can_assign = (
                   2433:                           krb4 => 1,
                   2434:                           krb5 => 1,
                   2435:                           int  => 1,
                   2436:                           loc  => 1,
                   2437:                      );
                   2438:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2439:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2440:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2441:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2442:             my $context;
                   2443:             if ($env{'request.role'} =~ /^au/) {
                   2444:                 $context = 'author';
                   2445:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2446:                 $context = 'domain';
                   2447:             } elsif ($env{'request.course.id'}) {
                   2448:                 $context = 'course';
                   2449:             }
                   2450:             if ($context) {
                   2451:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2452:                    %can_assign = %{$authhash->{$context}}; 
                   2453:                 }
                   2454:             }
                   2455:         }
                   2456:     }
                   2457:     my $authnum = 0;
                   2458:     foreach my $key (keys(%can_assign)) {
                   2459:         if ($can_assign{$key}) {
                   2460:             $authnum ++;
                   2461:         }
                   2462:     }
                   2463:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2464:         $authnum --;
                   2465:     }
                   2466:     return ($authnum,%can_assign);
                   2467: }
                   2468: 
1.80      albertel 2469: ###############################################################
                   2470: ##    Get Kerberos Defaults for Domain                 ##
                   2471: ###############################################################
                   2472: ##
                   2473: ## Returns default kerberos version and an associated argument
                   2474: ## as listed in file domain.tab. If not listed, provides
                   2475: ## appropriate default domain and kerberos version.
                   2476: ##
                   2477: #-------------------------------------------
                   2478: 
                   2479: =pod
                   2480: 
1.648     raeburn  2481: =item * &get_kerberos_defaults()
1.80      albertel 2482: 
                   2483: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2484: version and domain. If not found, it defaults to version 4 and the 
                   2485: domain of the server.
1.80      albertel 2486: 
1.648     raeburn  2487: =over 4
                   2488: 
1.80      albertel 2489: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2490: 
1.648     raeburn  2491: =back
                   2492: 
                   2493: =back
                   2494: 
1.80      albertel 2495: =cut
                   2496: 
                   2497: #-------------------------------------------
                   2498: sub get_kerberos_defaults {
                   2499:     my $domain=shift;
1.641     raeburn  2500:     my ($krbdef,$krbdefdom);
                   2501:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2502:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2503:         $krbdef = $domdefaults{'auth_def'};
                   2504:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2505:     } else {
1.80      albertel 2506:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2507:         my $krbdefdom=$1;
                   2508:         $krbdefdom=~tr/a-z/A-Z/;
                   2509:         $krbdef = "krb4";
                   2510:     }
                   2511:     return ($krbdef,$krbdefdom);
                   2512: }
1.112     bowersj2 2513: 
1.32      matthew  2514: 
1.46      matthew  2515: ###############################################################
                   2516: ##                Thesaurus Functions                        ##
                   2517: ###############################################################
1.20      www      2518: 
1.46      matthew  2519: =pod
1.20      www      2520: 
1.112     bowersj2 2521: =head1 Thesaurus Functions
                   2522: 
                   2523: =over 4
                   2524: 
1.648     raeburn  2525: =item * &initialize_keywords()
1.46      matthew  2526: 
                   2527: Initializes the package variable %Keywords if it is empty.  Uses the
                   2528: package variable $thesaurus_db_file.
                   2529: 
                   2530: =cut
                   2531: 
                   2532: ###################################################
                   2533: 
                   2534: sub initialize_keywords {
                   2535:     return 1 if (scalar keys(%Keywords));
                   2536:     # If we are here, %Keywords is empty, so fill it up
                   2537:     #   Make sure the file we need exists...
                   2538:     if (! -e $thesaurus_db_file) {
                   2539:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2540:                                  " failed because it does not exist");
                   2541:         return 0;
                   2542:     }
                   2543:     #   Set up the hash as a database
                   2544:     my %thesaurus_db;
                   2545:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2546:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2547:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2548:                                  $thesaurus_db_file);
                   2549:         return 0;
                   2550:     } 
                   2551:     #  Get the average number of appearances of a word.
                   2552:     my $avecount = $thesaurus_db{'average.count'};
                   2553:     #  Put keywords (those that appear > average) into %Keywords
                   2554:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2555:         my ($count,undef) = split /:/,$data;
                   2556:         $Keywords{$word}++ if ($count > $avecount);
                   2557:     }
                   2558:     untie %thesaurus_db;
                   2559:     # Remove special values from %Keywords.
1.356     albertel 2560:     foreach my $value ('total.count','average.count') {
                   2561:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2562:   }
1.46      matthew  2563:     return 1;
                   2564: }
                   2565: 
                   2566: ###################################################
                   2567: 
                   2568: =pod
                   2569: 
1.648     raeburn  2570: =item * &keyword($word)
1.46      matthew  2571: 
                   2572: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2573: than the average number of times in the thesaurus database.  Calls 
                   2574: &initialize_keywords
                   2575: 
                   2576: =cut
                   2577: 
                   2578: ###################################################
1.20      www      2579: 
                   2580: sub keyword {
1.46      matthew  2581:     return if (!&initialize_keywords());
                   2582:     my $word=lc(shift());
                   2583:     $word=~s/\W//g;
                   2584:     return exists($Keywords{$word});
1.20      www      2585: }
1.46      matthew  2586: 
                   2587: ###############################################################
                   2588: 
                   2589: =pod 
1.20      www      2590: 
1.648     raeburn  2591: =item * &get_related_words()
1.46      matthew  2592: 
1.160     matthew  2593: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2594: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2595: will be returned.  The order of the words returned is determined by the
                   2596: database which holds them.
                   2597: 
                   2598: Uses global $thesaurus_db_file.
                   2599: 
                   2600: =cut
                   2601: 
                   2602: ###############################################################
                   2603: sub get_related_words {
                   2604:     my $keyword = shift;
                   2605:     my %thesaurus_db;
                   2606:     if (! -e $thesaurus_db_file) {
                   2607:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2608:                                  "failed because the file does not exist");
                   2609:         return ();
                   2610:     }
                   2611:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2612:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2613:         return ();
                   2614:     } 
                   2615:     my @Words=();
1.429     www      2616:     my $count=0;
1.46      matthew  2617:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2618: 	# The first element is the number of times
                   2619: 	# the word appears.  We do not need it now.
1.429     www      2620: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2621: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2622: 	my $threshold=$mostfrequentcount/10;
                   2623:         foreach my $possibleword (@RelatedWords) {
                   2624:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2625:             if ($wordcount>$threshold) {
                   2626: 		push(@Words,$word);
                   2627:                 $count++;
                   2628:                 if ($count>10) { last; }
                   2629: 	    }
1.20      www      2630:         }
                   2631:     }
1.46      matthew  2632:     untie %thesaurus_db;
                   2633:     return @Words;
1.14      harris41 2634: }
1.46      matthew  2635: 
1.112     bowersj2 2636: =pod
                   2637: 
                   2638: =back
                   2639: 
                   2640: =cut
1.61      www      2641: 
                   2642: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2643: =pod
                   2644: 
1.112     bowersj2 2645: =head1 User Name Functions
                   2646: 
                   2647: =over 4
                   2648: 
1.648     raeburn  2649: =item * &plainname($uname,$udom,$first)
1.81      albertel 2650: 
1.112     bowersj2 2651: Takes a users logon name and returns it as a string in
1.226     albertel 2652: "first middle last generation" form 
                   2653: if $first is set to 'lastname' then it returns it as
                   2654: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2655: 
                   2656: =cut
1.61      www      2657: 
1.295     www      2658: 
1.81      albertel 2659: ###############################################################
1.61      www      2660: sub plainname {
1.226     albertel 2661:     my ($uname,$udom,$first)=@_;
1.537     albertel 2662:     return if (!defined($uname) || !defined($udom));
1.295     www      2663:     my %names=&getnames($uname,$udom);
1.226     albertel 2664:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2665: 					  $names{'middlename'},
                   2666: 					  $names{'lastname'},
                   2667: 					  $names{'generation'},$first);
                   2668:     $name=~s/^\s+//;
1.62      www      2669:     $name=~s/\s+$//;
                   2670:     $name=~s/\s+/ /g;
1.353     albertel 2671:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2672:     return $name;
1.61      www      2673: }
1.66      www      2674: 
                   2675: # -------------------------------------------------------------------- Nickname
1.81      albertel 2676: =pod
                   2677: 
1.648     raeburn  2678: =item * &nickname($uname,$udom)
1.81      albertel 2679: 
                   2680: Gets a users name and returns it as a string as
                   2681: 
                   2682: "&quot;nickname&quot;"
1.66      www      2683: 
1.81      albertel 2684: if the user has a nickname or
                   2685: 
                   2686: "first middle last generation"
                   2687: 
                   2688: if the user does not
                   2689: 
                   2690: =cut
1.66      www      2691: 
                   2692: sub nickname {
                   2693:     my ($uname,$udom)=@_;
1.537     albertel 2694:     return if (!defined($uname) || !defined($udom));
1.295     www      2695:     my %names=&getnames($uname,$udom);
1.68      albertel 2696:     my $name=$names{'nickname'};
1.66      www      2697:     if ($name) {
                   2698:        $name='&quot;'.$name.'&quot;'; 
                   2699:     } else {
                   2700:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2701: 	     $names{'lastname'}.' '.$names{'generation'};
                   2702:        $name=~s/\s+$//;
                   2703:        $name=~s/\s+/ /g;
                   2704:     }
                   2705:     return $name;
                   2706: }
                   2707: 
1.295     www      2708: sub getnames {
                   2709:     my ($uname,$udom)=@_;
1.537     albertel 2710:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2711:     if ($udom eq 'public' && $uname eq 'public') {
                   2712: 	return ('lastname' => &mt('Public'));
                   2713:     }
1.295     www      2714:     my $id=$uname.':'.$udom;
                   2715:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2716:     if ($cached) {
                   2717: 	return %{$names};
                   2718:     } else {
                   2719: 	my %loadnames=&Apache::lonnet::get('environment',
                   2720:                     ['firstname','middlename','lastname','generation','nickname'],
                   2721: 					 $udom,$uname);
                   2722: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2723: 	return %loadnames;
                   2724:     }
                   2725: }
1.61      www      2726: 
1.542     raeburn  2727: # -------------------------------------------------------------------- getemails
1.648     raeburn  2728: 
1.542     raeburn  2729: =pod
                   2730: 
1.648     raeburn  2731: =item * &getemails($uname,$udom)
1.542     raeburn  2732: 
                   2733: Gets a user's email information and returns it as a hash with keys:
                   2734: notification, critnotification, permanentemail
                   2735: 
                   2736: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2737: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2738:  
1.648     raeburn  2739: 
1.542     raeburn  2740: =cut
                   2741: 
1.648     raeburn  2742: 
1.466     albertel 2743: sub getemails {
                   2744:     my ($uname,$udom)=@_;
                   2745:     if ($udom eq 'public' && $uname eq 'public') {
                   2746: 	return;
                   2747:     }
1.467     www      2748:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2749:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2750:     my $id=$uname.':'.$udom;
                   2751:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2752:     if ($cached) {
                   2753: 	return %{$names};
                   2754:     } else {
                   2755: 	my %loadnames=&Apache::lonnet::get('environment',
                   2756:                     			   ['notification','critnotification',
                   2757: 					    'permanentemail'],
                   2758: 					   $udom,$uname);
                   2759: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2760: 	return %loadnames;
                   2761:     }
                   2762: }
                   2763: 
1.551     albertel 2764: sub flush_email_cache {
                   2765:     my ($uname,$udom)=@_;
                   2766:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2767:     if (!$uname) { $uname=$env{'user.name'};   }
                   2768:     return if ($udom eq 'public' && $uname eq 'public');
                   2769:     my $id=$uname.':'.$udom;
                   2770:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2771: }
                   2772: 
1.728     raeburn  2773: # -------------------------------------------------------------------- getlangs
                   2774: 
                   2775: =pod
                   2776: 
                   2777: =item * &getlangs($uname,$udom)
                   2778: 
                   2779: Gets a user's language preference and returns it as a hash with key:
                   2780: language.
                   2781: 
                   2782: =cut
                   2783: 
                   2784: 
                   2785: sub getlangs {
                   2786:     my ($uname,$udom) = @_;
                   2787:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2788:     if (!$uname) { $uname=$env{'user.name'};   }
                   2789:     my $id=$uname.':'.$udom;
                   2790:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   2791:     if ($cached) {
                   2792:         return %{$langs};
                   2793:     } else {
                   2794:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   2795:                                            $udom,$uname);
                   2796:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   2797:         return %loadlangs;
                   2798:     }
                   2799: }
                   2800: 
                   2801: sub flush_langs_cache {
                   2802:     my ($uname,$udom)=@_;
                   2803:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2804:     if (!$uname) { $uname=$env{'user.name'};   }
                   2805:     return if ($udom eq 'public' && $uname eq 'public');
                   2806:     my $id=$uname.':'.$udom;
                   2807:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   2808: }
                   2809: 
1.61      www      2810: # ------------------------------------------------------------------ Screenname
1.81      albertel 2811: 
                   2812: =pod
                   2813: 
1.648     raeburn  2814: =item * &screenname($uname,$udom)
1.81      albertel 2815: 
                   2816: Gets a users screenname and returns it as a string
                   2817: 
                   2818: =cut
1.61      www      2819: 
                   2820: sub screenname {
                   2821:     my ($uname,$udom)=@_;
1.258     albertel 2822:     if ($uname eq $env{'user.name'} &&
                   2823: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2824:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2825:     return $names{'screenname'};
1.62      www      2826: }
                   2827: 
1.212     albertel 2828: 
1.802     bisitz   2829: # ------------------------------------------------------------- Confirm Wrapper
                   2830: =pod
                   2831: 
                   2832: =item confirmwrapper
                   2833: 
                   2834: Wrap messages about completion of operation in box
                   2835: 
                   2836: =cut
                   2837: 
                   2838: sub confirmwrapper {
                   2839:     my ($message)=@_;
                   2840:     if ($message) {
                   2841:         return "\n".'<div class="LC_confirm_box">'."\n"
                   2842:                .$message."\n"
                   2843:                .'</div>'."\n";
                   2844:     } else {
                   2845:         return $message;
                   2846:     }
                   2847: }
                   2848: 
1.62      www      2849: # ------------------------------------------------------------- Message Wrapper
                   2850: 
                   2851: sub messagewrapper {
1.369     www      2852:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      2853:     return 
1.441     albertel 2854:         '<a href="/adm/email?compose=individual&amp;'.
                   2855:         'recname='.$username.'&amp;recdom='.$domain.
                   2856: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  2857:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      2858: }
1.802     bisitz   2859: 
1.74      www      2860: # --------------------------------------------------------------- Notes Wrapper
                   2861: 
                   2862: sub noteswrapper {
                   2863:     my ($link,$un,$do)=@_;
                   2864:     return 
                   2865: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62      www      2866: }
1.802     bisitz   2867: 
1.62      www      2868: # ------------------------------------------------------------- Aboutme Wrapper
                   2869: 
                   2870: sub aboutmewrapper {
1.166     www      2871:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  2872:     if (!defined($username)  && !defined($domain)) {
                   2873:         return;
                   2874:     }
1.205     www      2875:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.756     weissno  2876: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      2877: }
                   2878: 
                   2879: # ------------------------------------------------------------ Syllabus Wrapper
                   2880: 
                   2881: sub syllabuswrapper {
1.707     bisitz   2882:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  2883:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      2884: }
1.14      harris41 2885: 
1.802     bisitz   2886: # -----------------------------------------------------------------------------
                   2887: 
1.208     matthew  2888: sub track_student_link {
1.268     albertel 2889:     my ($linktext,$sname,$sdom,$target,$start) = @_;
                   2890:     my $link ="/adm/trackstudent?";
1.208     matthew  2891:     my $title = 'View recent activity';
                   2892:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   2893:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 2894:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  2895:         $title .= ' of this student';
1.268     albertel 2896:     } 
1.208     matthew  2897:     if (defined($target) && $target !~ /^\s*$/) {
                   2898:         $target = qq{target="$target"};
                   2899:     } else {
                   2900:         $target = '';
                   2901:     }
1.268     albertel 2902:     if ($start) { $link.='&amp;start='.$start; }
1.554     albertel 2903:     $title = &mt($title);
                   2904:     $linktext = &mt($linktext);
1.448     albertel 2905:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   2906: 	&help_open_topic('View_recent_activity');
1.208     matthew  2907: }
                   2908: 
1.781     raeburn  2909: sub slot_reservations_link {
                   2910:     my ($linktext,$sname,$sdom,$target) = @_;
                   2911:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   2912:     my $title = 'View slot reservation history';
                   2913:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   2914:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   2915:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   2916:         $title .= ' of this student';
                   2917:     }
                   2918:     if (defined($target) && $target !~ /^\s*$/) {
                   2919:         $target = qq{target="$target"};
                   2920:     } else {
                   2921:         $target = '';
                   2922:     }
                   2923:     $title = &mt($title);
                   2924:     $linktext = &mt($linktext);
                   2925:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   2926: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   2927: 
                   2928: }
                   2929: 
1.508     www      2930: # ===================================================== Display a student photo
                   2931: 
                   2932: 
1.509     albertel 2933: sub student_image_tag {
1.508     www      2934:     my ($domain,$user)=@_;
                   2935:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   2936:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   2937: 	return '<img src="'.$imgsrc.'" align="right" />';
                   2938:     } else {
                   2939: 	return '';
                   2940:     }
                   2941: }
                   2942: 
1.112     bowersj2 2943: =pod
                   2944: 
                   2945: =back
                   2946: 
                   2947: =head1 Access .tab File Data
                   2948: 
                   2949: =over 4
                   2950: 
1.648     raeburn  2951: =item * &languageids() 
1.112     bowersj2 2952: 
                   2953: returns list of all language ids
                   2954: 
                   2955: =cut
                   2956: 
1.14      harris41 2957: sub languageids {
1.16      harris41 2958:     return sort(keys(%language));
1.14      harris41 2959: }
                   2960: 
1.112     bowersj2 2961: =pod
                   2962: 
1.648     raeburn  2963: =item * &languagedescription() 
1.112     bowersj2 2964: 
                   2965: returns description of a specified language id
                   2966: 
                   2967: =cut
                   2968: 
1.14      harris41 2969: sub languagedescription {
1.125     www      2970:     my $code=shift;
                   2971:     return  ($supported_language{$code}?'* ':'').
                   2972:             $language{$code}.
1.126     www      2973: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      2974: }
                   2975: 
                   2976: sub plainlanguagedescription {
                   2977:     my $code=shift;
                   2978:     return $language{$code};
                   2979: }
                   2980: 
                   2981: sub supportedlanguagecode {
                   2982:     my $code=shift;
                   2983:     return $supported_language{$code};
1.97      www      2984: }
                   2985: 
1.112     bowersj2 2986: =pod
                   2987: 
1.648     raeburn  2988: =item * &copyrightids() 
1.112     bowersj2 2989: 
                   2990: returns list of all copyrights
                   2991: 
                   2992: =cut
                   2993: 
                   2994: sub copyrightids {
                   2995:     return sort(keys(%cprtag));
                   2996: }
                   2997: 
                   2998: =pod
                   2999: 
1.648     raeburn  3000: =item * &copyrightdescription() 
1.112     bowersj2 3001: 
                   3002: returns description of a specified copyright id
                   3003: 
                   3004: =cut
                   3005: 
                   3006: sub copyrightdescription {
1.166     www      3007:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3008: }
1.197     matthew  3009: 
                   3010: =pod
                   3011: 
1.648     raeburn  3012: =item * &source_copyrightids() 
1.192     taceyjo1 3013: 
                   3014: returns list of all source copyrights
                   3015: 
                   3016: =cut
                   3017: 
                   3018: sub source_copyrightids {
                   3019:     return sort(keys(%scprtag));
                   3020: }
                   3021: 
                   3022: =pod
                   3023: 
1.648     raeburn  3024: =item * &source_copyrightdescription() 
1.192     taceyjo1 3025: 
                   3026: returns description of a specified source copyright id
                   3027: 
                   3028: =cut
                   3029: 
                   3030: sub source_copyrightdescription {
                   3031:     return &mt($scprtag{shift(@_)});
                   3032: }
1.112     bowersj2 3033: 
                   3034: =pod
                   3035: 
1.648     raeburn  3036: =item * &filecategories() 
1.112     bowersj2 3037: 
                   3038: returns list of all file categories
                   3039: 
                   3040: =cut
                   3041: 
                   3042: sub filecategories {
                   3043:     return sort(keys(%category_extensions));
                   3044: }
                   3045: 
                   3046: =pod
                   3047: 
1.648     raeburn  3048: =item * &filecategorytypes() 
1.112     bowersj2 3049: 
                   3050: returns list of file types belonging to a given file
                   3051: category
                   3052: 
                   3053: =cut
                   3054: 
                   3055: sub filecategorytypes {
1.356     albertel 3056:     my ($cat) = @_;
                   3057:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3058: }
                   3059: 
                   3060: =pod
                   3061: 
1.648     raeburn  3062: =item * &fileembstyle() 
1.112     bowersj2 3063: 
                   3064: returns embedding style for a specified file type
                   3065: 
                   3066: =cut
                   3067: 
                   3068: sub fileembstyle {
                   3069:     return $fe{lc(shift(@_))};
1.169     www      3070: }
                   3071: 
1.351     www      3072: sub filemimetype {
                   3073:     return $fm{lc(shift(@_))};
                   3074: }
                   3075: 
1.169     www      3076: 
                   3077: sub filecategoryselect {
                   3078:     my ($name,$value)=@_;
1.189     matthew  3079:     return &select_form($value,$name,
1.169     www      3080: 			'' => &mt('Any category'),
                   3081: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 3082: }
                   3083: 
                   3084: =pod
                   3085: 
1.648     raeburn  3086: =item * &filedescription() 
1.112     bowersj2 3087: 
                   3088: returns description for a specified file type
                   3089: 
                   3090: =cut
                   3091: 
                   3092: sub filedescription {
1.188     matthew  3093:     my $file_description = $fd{lc(shift())};
                   3094:     $file_description =~ s:([\[\]]):~$1:g;
                   3095:     return &mt($file_description);
1.112     bowersj2 3096: }
                   3097: 
                   3098: =pod
                   3099: 
1.648     raeburn  3100: =item * &filedescriptionex() 
1.112     bowersj2 3101: 
                   3102: returns description for a specified file type with
                   3103: extra formatting
                   3104: 
                   3105: =cut
                   3106: 
                   3107: sub filedescriptionex {
                   3108:     my $ex=shift;
1.188     matthew  3109:     my $file_description = $fd{lc($ex)};
                   3110:     $file_description =~ s:([\[\]]):~$1:g;
                   3111:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3112: }
                   3113: 
                   3114: # End of .tab access
                   3115: =pod
                   3116: 
                   3117: =back
                   3118: 
                   3119: =cut
                   3120: 
                   3121: # ------------------------------------------------------------------ File Types
                   3122: sub fileextensions {
                   3123:     return sort(keys(%fe));
                   3124: }
                   3125: 
1.97      www      3126: # ----------------------------------------------------------- Display Languages
                   3127: # returns a hash with all desired display languages
                   3128: #
                   3129: 
                   3130: sub display_languages {
                   3131:     my %languages=();
1.695     raeburn  3132:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3133: 	$languages{$lang}=1;
1.97      www      3134:     }
                   3135:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3136:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3137: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3138: 	    $languages{$lang}=1;
1.97      www      3139:         }
                   3140:     }
                   3141:     return %languages;
1.14      harris41 3142: }
                   3143: 
1.582     albertel 3144: sub languages {
                   3145:     my ($possible_langs) = @_;
1.695     raeburn  3146:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3147:     if (!ref($possible_langs)) {
                   3148: 	if( wantarray ) {
                   3149: 	    return @preferred_langs;
                   3150: 	} else {
                   3151: 	    return $preferred_langs[0];
                   3152: 	}
                   3153:     }
                   3154:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3155:     my @preferred_possibilities;
                   3156:     foreach my $preferred_lang (@preferred_langs) {
                   3157: 	if (exists($possibilities{$preferred_lang})) {
                   3158: 	    push(@preferred_possibilities, $preferred_lang);
                   3159: 	}
                   3160:     }
                   3161:     if( wantarray ) {
                   3162: 	return @preferred_possibilities;
                   3163:     }
                   3164:     return $preferred_possibilities[0];
                   3165: }
                   3166: 
1.742     raeburn  3167: sub user_lang {
                   3168:     my ($touname,$toudom,$fromcid) = @_;
                   3169:     my @userlangs;
                   3170:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3171:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3172:                     $env{'course.'.$fromcid.'.languages'}));
                   3173:     } else {
                   3174:         my %langhash = &getlangs($touname,$toudom);
                   3175:         if ($langhash{'languages'} ne '') {
                   3176:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3177:         } else {
                   3178:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3179:             if ($domdefs{'lang_def'} ne '') {
                   3180:                 @userlangs = ($domdefs{'lang_def'});
                   3181:             }
                   3182:         }
                   3183:     }
                   3184:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3185:     my $user_lh = Apache::localize->get_handle(@languages);
                   3186:     return $user_lh;
                   3187: }
                   3188: 
                   3189: 
1.112     bowersj2 3190: ###############################################################
                   3191: ##               Student Answer Attempts                     ##
                   3192: ###############################################################
                   3193: 
                   3194: =pod
                   3195: 
                   3196: =head1 Alternate Problem Views
                   3197: 
                   3198: =over 4
                   3199: 
1.648     raeburn  3200: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3201:     $getattempt, $regexp, $gradesub)
                   3202: 
                   3203: Return string with previous attempt on problem. Arguments:
                   3204: 
                   3205: =over 4
                   3206: 
                   3207: =item * $symb: Problem, including path
                   3208: 
                   3209: =item * $username: username of the desired student
                   3210: 
                   3211: =item * $domain: domain of the desired student
1.14      harris41 3212: 
1.112     bowersj2 3213: =item * $course: Course ID
1.14      harris41 3214: 
1.112     bowersj2 3215: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3216:     something
1.14      harris41 3217: 
1.112     bowersj2 3218: =item * $regexp: if string matches this regexp, the string will be
                   3219:     sent to $gradesub
1.14      harris41 3220: 
1.112     bowersj2 3221: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3222: 
1.112     bowersj2 3223: =back
1.14      harris41 3224: 
1.112     bowersj2 3225: The output string is a table containing all desired attempts, if any.
1.16      harris41 3226: 
1.112     bowersj2 3227: =cut
1.1       albertel 3228: 
                   3229: sub get_previous_attempt {
1.43      ng       3230:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3231:   my $prevattempts='';
1.43      ng       3232:   no strict 'refs';
1.1       albertel 3233:   if ($symb) {
1.3       albertel 3234:     my (%returnhash)=
                   3235:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3236:     if ($returnhash{'version'}) {
                   3237:       my %lasthash=();
                   3238:       my $version;
                   3239:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3240:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3241: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3242:         }
1.1       albertel 3243:       }
1.596     albertel 3244:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3245:       $prevattempts.='<th>'.&mt('History').'</th>';
1.356     albertel 3246:       foreach my $key (sort(keys(%lasthash))) {
                   3247: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3248: 	if ($#parts > 0) {
1.31      albertel 3249: 	  my $data=$parts[-1];
                   3250: 	  pop(@parts);
1.596     albertel 3251: 	  $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.31      albertel 3252: 	} else {
1.41      ng       3253: 	  if ($#parts == 0) {
                   3254: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3255: 	  } else {
                   3256: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3257: 	  }
1.31      albertel 3258: 	}
1.16      harris41 3259:       }
1.596     albertel 3260:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3261:       if ($getattempt eq '') {
                   3262: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596     albertel 3263: 	  $prevattempts.=&start_data_table_row().
                   3264: 	      '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356     albertel 3265: 	    foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3266: 		my $value = &format_previous_attempt_value($key,
                   3267: 							   $returnhash{$version.':'.$key});
                   3268: 		$prevattempts.='<td>'.$value.'&nbsp;</td>';   
1.40      ng       3269: 	    }
1.596     albertel 3270: 	  $prevattempts.=&end_data_table_row();
1.40      ng       3271: 	 }
1.1       albertel 3272:       }
1.596     albertel 3273:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3274:       foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3275: 	my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356     albertel 3276: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       3277: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 3278:       }
1.596     albertel 3279:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3280:     } else {
1.596     albertel 3281:       $prevattempts=
                   3282: 	  &start_data_table().&start_data_table_row().
                   3283: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3284: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3285:     }
                   3286:   } else {
1.596     albertel 3287:     $prevattempts=
                   3288: 	  &start_data_table().&start_data_table_row().
                   3289: 	  '<td>'.&mt('No data.').'</td>'.
                   3290: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3291:   }
1.10      albertel 3292: }
                   3293: 
1.581     albertel 3294: sub format_previous_attempt_value {
                   3295:     my ($key,$value) = @_;
                   3296:     if ($key =~ /timestamp/) {
                   3297: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3298:     } elsif (ref($value) eq 'ARRAY') {
                   3299: 	$value = '('.join(', ', @{ $value }).')';
                   3300:     } else {
                   3301: 	$value = &unescape($value);
                   3302:     }
                   3303:     return $value;
                   3304: }
                   3305: 
                   3306: 
1.107     albertel 3307: sub relative_to_absolute {
                   3308:     my ($url,$output)=@_;
                   3309:     my $parser=HTML::TokeParser->new(\$output);
                   3310:     my $token;
                   3311:     my $thisdir=$url;
                   3312:     my @rlinks=();
                   3313:     while ($token=$parser->get_token) {
                   3314: 	if ($token->[0] eq 'S') {
                   3315: 	    if ($token->[1] eq 'a') {
                   3316: 		if ($token->[2]->{'href'}) {
                   3317: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3318: 		}
                   3319: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3320: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3321: 	    } elsif ($token->[1] eq 'base') {
                   3322: 		$thisdir=$token->[2]->{'href'};
                   3323: 	    }
                   3324: 	}
                   3325:     }
                   3326:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3327:     foreach my $link (@rlinks) {
1.726     raeburn  3328: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3329: 		($link=~/^\//) ||
                   3330: 		($link=~/^javascript:/i) ||
                   3331: 		($link=~/^mailto:/i) ||
                   3332: 		($link=~/^\#/)) {
                   3333: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3334: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3335: 	}
                   3336:     }
                   3337: # -------------------------------------------------- Deal with Applet codebases
                   3338:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3339:     return $output;
                   3340: }
                   3341: 
1.112     bowersj2 3342: =pod
                   3343: 
1.648     raeburn  3344: =item * &get_student_view()
1.112     bowersj2 3345: 
                   3346: show a snapshot of what student was looking at
                   3347: 
                   3348: =cut
                   3349: 
1.10      albertel 3350: sub get_student_view {
1.186     albertel 3351:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3352:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3353:   my (%form);
1.10      albertel 3354:   my @elements=('symb','courseid','domain','username');
                   3355:   foreach my $element (@elements) {
1.186     albertel 3356:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3357:   }
1.186     albertel 3358:   if (defined($moreenv)) {
                   3359:       %form=(%form,%{$moreenv});
                   3360:   }
1.236     albertel 3361:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3362:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3363:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3364:   $userview=~s/\<body[^\>]*\>//gi;
                   3365:   $userview=~s/\<\/body\>//gi;
                   3366:   $userview=~s/\<html\>//gi;
                   3367:   $userview=~s/\<\/html\>//gi;
                   3368:   $userview=~s/\<head\>//gi;
                   3369:   $userview=~s/\<\/head\>//gi;
                   3370:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3371:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3372:   if (wantarray) {
                   3373:      return ($userview,$response);
                   3374:   } else {
                   3375:      return $userview;
                   3376:   }
                   3377: }
                   3378: 
                   3379: sub get_student_view_with_retries {
                   3380:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3381: 
                   3382:     my $ok = 0;                 # True if we got a good response.
                   3383:     my $content;
                   3384:     my $response;
                   3385: 
                   3386:     # Try to get the student_view done. within the retries count:
                   3387:     
                   3388:     do {
                   3389:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3390:          $ok      = $response->is_success;
                   3391:          if (!$ok) {
                   3392:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3393:          }
                   3394:          $retries--;
                   3395:     } while (!$ok && ($retries > 0));
                   3396:     
                   3397:     if (!$ok) {
                   3398:        $content = '';          # On error return an empty content.
                   3399:     }
1.651     www      3400:     if (wantarray) {
                   3401:        return ($content, $response);
                   3402:     } else {
                   3403:        return $content;
                   3404:     }
1.11      albertel 3405: }
                   3406: 
1.112     bowersj2 3407: =pod
                   3408: 
1.648     raeburn  3409: =item * &get_student_answers() 
1.112     bowersj2 3410: 
                   3411: show a snapshot of how student was answering problem
                   3412: 
                   3413: =cut
                   3414: 
1.11      albertel 3415: sub get_student_answers {
1.100     sakharuk 3416:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3417:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3418:   my (%moreenv);
1.11      albertel 3419:   my @elements=('symb','courseid','domain','username');
                   3420:   foreach my $element (@elements) {
1.186     albertel 3421:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3422:   }
1.186     albertel 3423:   $moreenv{'grade_target'}='answer';
                   3424:   %moreenv=(%form,%moreenv);
1.497     raeburn  3425:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3426:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3427:   return $userview;
1.1       albertel 3428: }
1.116     albertel 3429: 
                   3430: =pod
                   3431: 
                   3432: =item * &submlink()
                   3433: 
1.242     albertel 3434: Inputs: $text $uname $udom $symb $target
1.116     albertel 3435: 
                   3436: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3437: 
                   3438: =cut
                   3439: 
                   3440: ###############################################
                   3441: sub submlink {
1.242     albertel 3442:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3443:     if (!($uname && $udom)) {
                   3444: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3445: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3446: 	if (!$symb) { $symb=$cursymb; }
                   3447:     }
1.254     matthew  3448:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3449:     $symb=&escape($symb);
1.242     albertel 3450:     if ($target) { $target="target=\"$target\""; }
                   3451:     return '<a href="/adm/grades?&command=submission&'.
                   3452: 	'symb='.$symb.'&student='.$uname.
                   3453: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   3454: }
                   3455: ##############################################
                   3456: 
                   3457: =pod
                   3458: 
                   3459: =item * &pgrdlink()
                   3460: 
                   3461: Inputs: $text $uname $udom $symb $target
                   3462: 
                   3463: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3464: 
                   3465: =cut
                   3466: 
                   3467: ###############################################
                   3468: sub pgrdlink {
                   3469:     my $link=&submlink(@_);
                   3470:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3471:     return $link;
                   3472: }
                   3473: ##############################################
                   3474: 
                   3475: =pod
                   3476: 
                   3477: =item * &pprmlink()
                   3478: 
                   3479: Inputs: $text $uname $udom $symb $target
                   3480: 
                   3481: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3482: student and a specific resource
1.242     albertel 3483: 
                   3484: =cut
                   3485: 
                   3486: ###############################################
                   3487: sub pprmlink {
                   3488:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3489:     if (!($uname && $udom)) {
                   3490: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3491: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3492: 	if (!$symb) { $symb=$cursymb; }
                   3493:     }
1.254     matthew  3494:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3495:     $symb=&escape($symb);
1.242     albertel 3496:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3497:     return '<a href="/adm/parmset?command=set&amp;'.
                   3498: 	'symb='.$symb.'&amp;uname='.$uname.
                   3499: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3500: }
                   3501: ##############################################
1.37      matthew  3502: 
1.112     bowersj2 3503: =pod
                   3504: 
                   3505: =back
                   3506: 
                   3507: =cut
                   3508: 
1.37      matthew  3509: ###############################################
1.51      www      3510: 
                   3511: 
                   3512: sub timehash {
1.687     raeburn  3513:     my ($thistime) = @_;
                   3514:     my $timezone = &Apache::lonlocal::gettimezone();
                   3515:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3516:                      ->set_time_zone($timezone);
                   3517:     my $wday = $dt->day_of_week();
                   3518:     if ($wday == 7) { $wday = 0; }
                   3519:     return ( 'second' => $dt->second(),
                   3520:              'minute' => $dt->minute(),
                   3521:              'hour'   => $dt->hour(),
                   3522:              'day'     => $dt->day_of_month(),
                   3523:              'month'   => $dt->month(),
                   3524:              'year'    => $dt->year(),
                   3525:              'weekday' => $wday,
                   3526:              'dayyear' => $dt->day_of_year(),
                   3527:              'dlsav'   => $dt->is_dst() );
1.51      www      3528: }
                   3529: 
1.370     www      3530: sub utc_string {
                   3531:     my ($date)=@_;
1.371     www      3532:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3533: }
                   3534: 
1.51      www      3535: sub maketime {
                   3536:     my %th=@_;
1.687     raeburn  3537:     my ($epoch_time,$timezone,$dt);
                   3538:     $timezone = &Apache::lonlocal::gettimezone();
                   3539:     eval {
                   3540:         $dt = DateTime->new( year   => $th{'year'},
                   3541:                              month  => $th{'month'},
                   3542:                              day    => $th{'day'},
                   3543:                              hour   => $th{'hour'},
                   3544:                              minute => $th{'minute'},
                   3545:                              second => $th{'second'},
                   3546:                              time_zone => $timezone,
                   3547:                          );
                   3548:     };
                   3549:     if (!$@) {
                   3550:         $epoch_time = $dt->epoch;
                   3551:         if ($epoch_time) {
                   3552:             return $epoch_time;
                   3553:         }
                   3554:     }
1.51      www      3555:     return POSIX::mktime(
                   3556:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3557:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3558: }
                   3559: 
                   3560: #########################################
1.51      www      3561: 
                   3562: sub findallcourses {
1.482     raeburn  3563:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3564:     my %roles;
                   3565:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3566:     my %courses;
1.51      www      3567:     my $now=time;
1.482     raeburn  3568:     if (!defined($uname)) {
                   3569:         $uname = $env{'user.name'};
                   3570:     }
                   3571:     if (!defined($udom)) {
                   3572:         $udom = $env{'user.domain'};
                   3573:     }
                   3574:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3575:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3576:         if (!%roles) {
                   3577:             %roles = (
                   3578:                        cc => 1,
                   3579:                        in => 1,
                   3580:                        ep => 1,
                   3581:                        ta => 1,
                   3582:                        cr => 1,
                   3583:                        st => 1,
                   3584:              );
                   3585:         }
                   3586:         foreach my $entry (keys(%roleshash)) {
                   3587:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3588:             if ($trole =~ /^cr/) { 
                   3589:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3590:             } else {
                   3591:                 next if (!exists($roles{$trole}));
                   3592:             }
                   3593:             if ($tend) {
                   3594:                 next if ($tend < $now);
                   3595:             }
                   3596:             if ($tstart) {
                   3597:                 next if ($tstart > $now);
                   3598:             }
                   3599:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3600:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3601:             if ($secpart eq '') {
                   3602:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3603:                 $sec = 'none';
                   3604:                 $realsec = '';
                   3605:             } else {
                   3606:                 $cnum = $cnumpart;
                   3607:                 ($sec,$role) = split(/_/,$secpart);
                   3608:                 $realsec = $sec;
1.490     raeburn  3609:             }
1.482     raeburn  3610:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3611:         }
                   3612:     } else {
                   3613:         foreach my $key (keys(%env)) {
1.483     albertel 3614: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3615:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3616: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3617: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3618: 	        next if (%roles && !exists($roles{$role}));
                   3619: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3620:                 my $active=1;
                   3621:                 if ($starttime) {
                   3622: 		    if ($now<$starttime) { $active=0; }
                   3623:                 }
                   3624:                 if ($endtime) {
                   3625:                     if ($now>$endtime) { $active=0; }
                   3626:                 }
                   3627:                 if ($active) {
                   3628:                     if ($sec eq '') {
                   3629:                         $sec = 'none';
                   3630:                     }
                   3631:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3632:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3633:                 }
                   3634:             }
1.51      www      3635:         }
                   3636:     }
1.474     raeburn  3637:     return %courses;
1.51      www      3638: }
1.37      matthew  3639: 
1.54      www      3640: ###############################################
1.474     raeburn  3641: 
                   3642: sub blockcheck {
1.482     raeburn  3643:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3644: 
                   3645:     if (!defined($udom)) {
                   3646:         $udom = $env{'user.domain'};
                   3647:     }
                   3648:     if (!defined($uname)) {
                   3649:         $uname = $env{'user.name'};
                   3650:     }
                   3651: 
                   3652:     # If uname and udom are for a course, check for blocks in the course.
                   3653: 
                   3654:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3655:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3656:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3657:         return ($startblock,$endblock);
                   3658:     }
1.474     raeburn  3659: 
1.502     raeburn  3660:     my $startblock = 0;
                   3661:     my $endblock = 0;
1.482     raeburn  3662:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3663: 
1.490     raeburn  3664:     # If uname is for a user, and activity is course-specific, i.e.,
                   3665:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3666: 
1.490     raeburn  3667:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3668:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3669:         foreach my $key (keys(%live_courses)) {
                   3670:             if ($key ne $env{'request.course.id'}) {
                   3671:                 delete($live_courses{$key});
                   3672:             }
                   3673:         }
                   3674:     }
                   3675: 
                   3676:     my $otheruser = 0;
                   3677:     my %own_courses;
                   3678:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3679:         # Resource belongs to user other than current user.
                   3680:         $otheruser = 1;
                   3681:         # Gather courses for current user
                   3682:         %own_courses = 
                   3683:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3684:     }
                   3685: 
                   3686:     # Gather active course roles - course coordinator, instructor, 
                   3687:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3688: 
                   3689:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3690:         my ($cdom,$cnum);
                   3691:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3692:             $cdom = $env{'course.'.$course.'.domain'};
                   3693:             $cnum = $env{'course.'.$course.'.num'};
                   3694:         } else {
1.490     raeburn  3695:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3696:         }
                   3697:         my $no_ownblock = 0;
                   3698:         my $no_userblock = 0;
1.533     raeburn  3699:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3700:             # Check if current user has 'evb' priv for this
                   3701:             if (defined($own_courses{$course})) {
                   3702:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3703:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3704:                     if ($sec ne 'none') {
                   3705:                         $checkrole .= '/'.$sec;
                   3706:                     }
                   3707:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3708:                         $no_ownblock = 1;
                   3709:                         last;
                   3710:                     }
                   3711:                 }
                   3712:             }
                   3713:             # if they have 'evb' priv and are currently not playing student
                   3714:             next if (($no_ownblock) &&
                   3715:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3716:         }
1.474     raeburn  3717:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3718:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3719:             if ($sec ne 'none') {
1.482     raeburn  3720:                 $checkrole .= '/'.$sec;
1.474     raeburn  3721:             }
1.490     raeburn  3722:             if ($otheruser) {
                   3723:                 # Resource belongs to user other than current user.
                   3724:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3725:                 my ($trole,$tdom,$tnum,$tsec);
                   3726:                 my $entry = $live_courses{$course}{$sec};
                   3727:                 if ($entry =~ /^cr/) {
                   3728:                     ($trole,$tdom,$tnum,$tsec) = 
                   3729:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3730:                 } else {
                   3731:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3732:                 }
                   3733:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3734:                 $area = '/'.$tdom.'/'.$tnum;
                   3735:                 $trest = $tnum;
                   3736:                 if ($tsec ne '') {
                   3737:                     $area .= '/'.$tsec;
                   3738:                     $trest .= '/'.$tsec;
                   3739:                 }
                   3740:                 $spec = $trole.'.'.$area;
                   3741:                 if ($trole =~ /^cr/) {
                   3742:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   3743:                                                       $tdom,$spec,$trest,$area);
                   3744:                 } else {
                   3745:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   3746:                                                        $tdom,$spec,$trest,$area);
                   3747:                 }
                   3748:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  3749:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   3750:                     if ($1) {
                   3751:                         $no_userblock = 1;
                   3752:                         last;
                   3753:                     }
                   3754:                 }
1.490     raeburn  3755:             } else {
                   3756:                 # Resource belongs to current user
                   3757:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  3758:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3759:                     $no_ownblock = 1;
                   3760:                     last;
                   3761:                 }
1.474     raeburn  3762:             }
                   3763:         }
                   3764:         # if they have the evb priv and are currently not playing student
1.482     raeburn  3765:         next if (($no_ownblock) &&
1.491     albertel 3766:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  3767:         next if ($no_userblock);
1.474     raeburn  3768: 
1.490     raeburn  3769:         # Retrieve blocking times and identity of blocker for course
                   3770:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  3771:         
                   3772:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   3773:         if (($start != 0) && 
                   3774:             (($startblock == 0) || ($startblock > $start))) {
                   3775:             $startblock = $start;
                   3776:         }
                   3777:         if (($end != 0)  &&
                   3778:             (($endblock == 0) || ($endblock < $end))) {
                   3779:             $endblock = $end;
                   3780:         }
1.490     raeburn  3781:     }
                   3782:     return ($startblock,$endblock);
                   3783: }
                   3784: 
                   3785: sub get_blocks {
                   3786:     my ($setters,$activity,$cdom,$cnum) = @_;
                   3787:     my $startblock = 0;
                   3788:     my $endblock = 0;
                   3789:     my $course = $cdom.'_'.$cnum;
                   3790:     $setters->{$course} = {};
                   3791:     $setters->{$course}{'staff'} = [];
                   3792:     $setters->{$course}{'times'} = [];
                   3793:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   3794:     foreach my $record (keys(%records)) {
                   3795:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   3796:         if ($start <= time && $end >= time) {
                   3797:             my ($staff_name,$staff_dom,$title,$blocks) =
                   3798:                 &parse_block_record($records{$record});
                   3799:             if ($blocks->{$activity} eq 'on') {
                   3800:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   3801:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 3802:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   3803:                     $startblock = $start;
1.490     raeburn  3804:                 }
1.491     albertel 3805:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   3806:                     $endblock = $end;
1.474     raeburn  3807:                 }
                   3808:             }
                   3809:         }
                   3810:     }
                   3811:     return ($startblock,$endblock);
                   3812: }
                   3813: 
                   3814: sub parse_block_record {
                   3815:     my ($record) = @_;
                   3816:     my ($setuname,$setudom,$title,$blocks);
                   3817:     if (ref($record) eq 'HASH') {
                   3818:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   3819:         $title = &unescape($record->{'event'});
                   3820:         $blocks = $record->{'blocks'};
                   3821:     } else {
                   3822:         my @data = split(/:/,$record,3);
                   3823:         if (scalar(@data) eq 2) {
                   3824:             $title = $data[1];
                   3825:             ($setuname,$setudom) = split(/@/,$data[0]);
                   3826:         } else {
                   3827:             ($setuname,$setudom,$title) = @data;
                   3828:         }
                   3829:         $blocks = { 'com' => 'on' };
                   3830:     }
                   3831:     return ($setuname,$setudom,$title,$blocks);
                   3832: }
                   3833: 
                   3834: sub build_block_table {
                   3835:     my ($startblock,$endblock,$setters) = @_;
                   3836:     my %lt = &Apache::lonlocal::texthash(
                   3837:         'cacb' => 'Currently active communication blocks',
                   3838:         'cour' => 'Course',
                   3839:         'dura' => 'Duration',
                   3840:         'blse' => 'Block set by'
                   3841:     );
                   3842:     my $output;
1.476     raeburn  3843:     $output = '<br />'.$lt{'cacb'}.':<br />';
1.474     raeburn  3844:     $output .= &start_data_table();
                   3845:     $output .= '
                   3846: <tr>
                   3847:  <th>'.$lt{'cour'}.'</th>
                   3848:  <th>'.$lt{'dura'}.'</th>
                   3849:  <th>'.$lt{'blse'}.'</th>
                   3850: </tr>
                   3851: ';
                   3852:     foreach my $course (keys(%{$setters})) {
                   3853:         my %courseinfo=&Apache::lonnet::coursedescription($course);
                   3854:         for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
                   3855:             my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490     raeburn  3856:             my $fullname = &plainname($uname,$udom);
                   3857:             if (defined($env{'user.name'}) && defined($env{'user.domain'})
                   3858:                 && $env{'user.name'} ne 'public' 
                   3859:                 && $env{'user.domain'} ne 'public') {
                   3860:                 $fullname = &aboutmewrapper($fullname,$uname,$udom);
                   3861:             }
1.474     raeburn  3862:             my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
                   3863:             $openblock = &Apache::lonlocal::locallocaltime($openblock);
                   3864:             $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
                   3865:             $output .= &Apache::loncommon::start_data_table_row().
                   3866:                        '<td>'.$courseinfo{'description'}.'</td>'.
                   3867:                        '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490     raeburn  3868:                        '<td>'.$fullname.'</td>'.
1.474     raeburn  3869:                         &Apache::loncommon::end_data_table_row();
                   3870:         }
                   3871:     }
                   3872:     $output .= &end_data_table();
                   3873: }
                   3874: 
1.490     raeburn  3875: sub blocking_status {
                   3876:     my ($activity,$uname,$udom) = @_;
                   3877:     my %setters;
                   3878:     my ($blocked,$output,$ownitem,$is_course);
                   3879:     my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
                   3880:     if ($startblock && $endblock) {
                   3881:         $blocked = 1;
                   3882:         if (wantarray) {
                   3883:             my $category;
                   3884:             if ($activity eq 'boards') {
                   3885:                 $category = 'Discussion posts in this course';
                   3886:             } elsif ($activity eq 'blogs') {
                   3887:                 $category = 'Blogs';
                   3888:             } elsif ($activity eq 'port') {
                   3889:                 if (defined($uname) && defined($udom)) {
                   3890:                     if ($uname eq $env{'user.name'} &&
                   3891:                         $udom eq $env{'user.domain'}) {
                   3892:                         $ownitem = 1;
                   3893:                     }
                   3894:                 }
                   3895:                 $is_course = &Apache::lonnet::is_course($udom,$uname);
                   3896:                 if ($ownitem) { 
                   3897:                     $category = 'Your portfolio files';  
                   3898:                 } elsif ($is_course) {
                   3899:                     my $coursedesc;
                   3900:                     foreach my $course (keys(%setters)) {
                   3901:                         my %courseinfo =
                   3902:                              &Apache::lonnet::coursedescription($course);
                   3903:                         $coursedesc = $courseinfo{'description'};
                   3904:                     }
1.764     weissno  3905:                     $category = "Group portfolio in the course '$coursedesc'";
1.490     raeburn  3906:                 } else {
                   3907:                     $category = 'Portfolio files belonging to ';
                   3908:                     if ($env{'user.name'} eq 'public' && 
                   3909:                         $env{'user.domain'} eq 'public') {
                   3910:                         $category .= &plainname($uname,$udom);
                   3911:                     } else {
                   3912:                         $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);  
                   3913:                     }
                   3914:                 }
                   3915:             } elsif ($activity eq 'groups') {
                   3916:                 $category = 'Groups in this course';
                   3917:             }
                   3918:             my $showstart = &Apache::lonlocal::locallocaltime($startblock);
                   3919:             my $showend = &Apache::lonlocal::locallocaltime($endblock);
                   3920:             $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
                   3921:             if (!($activity eq 'port' && !($ownitem) && !($is_course))) { 
                   3922:                 $output .= &build_block_table($startblock,$endblock,\%setters);
                   3923:             }
                   3924:         }
                   3925:     }
                   3926:     if (wantarray) {
                   3927:         return ($blocked,$output);
                   3928:     } else {
                   3929:         return $blocked;
                   3930:     }
                   3931: }
                   3932: 
1.60      matthew  3933: ###############################################
                   3934: 
1.682     raeburn  3935: sub check_ip_acc {
                   3936:     my ($acc)=@_;
                   3937:     &Apache::lonxml::debug("acc is $acc");
                   3938:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   3939:         return 1;
                   3940:     }
                   3941:     my $allowed=0;
                   3942:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   3943: 
                   3944:     my $name;
                   3945:     foreach my $pattern (split(',',$acc)) {
                   3946:         $pattern =~ s/^\s*//;
                   3947:         $pattern =~ s/\s*$//;
                   3948:         if ($pattern =~ /\*$/) {
                   3949:             #35.8.*
                   3950:             $pattern=~s/\*//;
                   3951:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   3952:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   3953:             #35.8.3.[34-56]
                   3954:             my $low=$2;
                   3955:             my $high=$3;
                   3956:             $pattern=$1;
                   3957:             if ($ip =~ /^\Q$pattern\E/) {
                   3958:                 my $last=(split(/\./,$ip))[3];
                   3959:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   3960:             }
                   3961:         } elsif ($pattern =~ /^\*/) {
                   3962:             #*.msu.edu
                   3963:             $pattern=~s/\*//;
                   3964:             if (!defined($name)) {
                   3965:                 use Socket;
                   3966:                 my $netaddr=inet_aton($ip);
                   3967:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   3968:             }
                   3969:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   3970:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   3971:             #127.0.0.1
                   3972:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   3973:         } else {
                   3974:             #some.name.com
                   3975:             if (!defined($name)) {
                   3976:                 use Socket;
                   3977:                 my $netaddr=inet_aton($ip);
                   3978:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   3979:             }
                   3980:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   3981:         }
                   3982:         if ($allowed) { last; }
                   3983:     }
                   3984:     return $allowed;
                   3985: }
                   3986: 
                   3987: ###############################################
                   3988: 
1.60      matthew  3989: =pod
                   3990: 
1.112     bowersj2 3991: =head1 Domain Template Functions
                   3992: 
                   3993: =over 4
                   3994: 
                   3995: =item * &determinedomain()
1.60      matthew  3996: 
                   3997: Inputs: $domain (usually will be undef)
                   3998: 
1.63      www      3999: Returns: Determines which domain should be used for designs
1.60      matthew  4000: 
                   4001: =cut
1.54      www      4002: 
1.60      matthew  4003: ###############################################
1.63      www      4004: sub determinedomain {
                   4005:     my $domain=shift;
1.531     albertel 4006:     if (! $domain) {
1.60      matthew  4007:         # Determine domain if we have not been given one
                   4008:         $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258     albertel 4009:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4010:         if ($env{'request.role.domain'}) { 
                   4011:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4012:         }
                   4013:     }
1.63      www      4014:     return $domain;
                   4015: }
                   4016: ###############################################
1.517     raeburn  4017: 
1.518     albertel 4018: sub devalidate_domconfig_cache {
                   4019:     my ($udom)=@_;
                   4020:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4021: }
                   4022: 
                   4023: # ---------------------- Get domain configuration for a domain
                   4024: sub get_domainconf {
                   4025:     my ($udom) = @_;
                   4026:     my $cachetime=1800;
                   4027:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4028:     if (defined($cached)) { return %{$result}; }
                   4029: 
                   4030:     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   4031: 					     ['login','rolecolors'],$udom);
1.632     raeburn  4032:     my (%designhash,%legacy);
1.518     albertel 4033:     if (keys(%domconfig) > 0) {
                   4034:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4035:             if (keys(%{$domconfig{'login'}})) {
                   4036:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4037:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   4038:                         foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4039:                             $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4040:                                 $domconfig{'login'}{$key}{$img};
                   4041:                         }
                   4042:                     } else {
                   4043:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4044:                     }
1.632     raeburn  4045:                 }
                   4046:             } else {
                   4047:                 $legacy{'login'} = 1;
1.518     albertel 4048:             }
1.632     raeburn  4049:         } else {
                   4050:             $legacy{'login'} = 1;
1.518     albertel 4051:         }
                   4052:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4053:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4054:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4055:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4056:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4057:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4058:                         }
1.518     albertel 4059:                     }
                   4060:                 }
1.632     raeburn  4061:             } else {
                   4062:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4063:             }
1.632     raeburn  4064:         } else {
                   4065:             $legacy{'rolecolors'} = 1;
1.518     albertel 4066:         }
1.632     raeburn  4067:         if (keys(%legacy) > 0) {
                   4068:             my %legacyhash = &get_legacy_domconf($udom);
                   4069:             foreach my $item (keys(%legacyhash)) {
                   4070:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4071:                     if ($legacy{'login'}) { 
                   4072:                         $designhash{$item} = $legacyhash{$item};
                   4073:                     }
                   4074:                 } else {
                   4075:                     if ($legacy{'rolecolors'}) {
                   4076:                         $designhash{$item} = $legacyhash{$item};
                   4077:                     }
1.518     albertel 4078:                 }
                   4079:             }
                   4080:         }
1.632     raeburn  4081:     } else {
                   4082:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4083:     }
                   4084:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4085: 				  $cachetime);
                   4086:     return %designhash;
                   4087: }
                   4088: 
1.632     raeburn  4089: sub get_legacy_domconf {
                   4090:     my ($udom) = @_;
                   4091:     my %legacyhash;
                   4092:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4093:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4094:     if (-e $designfile) {
                   4095:         if ( open (my $fh,"<$designfile") ) {
                   4096:             while (my $line = <$fh>) {
                   4097:                 next if ($line =~ /^\#/);
                   4098:                 chomp($line);
                   4099:                 my ($key,$val)=(split(/\=/,$line));
                   4100:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4101:             }
                   4102:             close($fh);
                   4103:         }
                   4104:     }
                   4105:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   4106:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4107:     }
                   4108:     return %legacyhash;
                   4109: }
                   4110: 
1.63      www      4111: =pod
                   4112: 
1.112     bowersj2 4113: =item * &domainlogo()
1.63      www      4114: 
                   4115: Inputs: $domain (usually will be undef)
                   4116: 
                   4117: Returns: A link to a domain logo, if the domain logo exists.
                   4118: If the domain logo does not exist, a description of the domain.
                   4119: 
                   4120: =cut
1.112     bowersj2 4121: 
1.63      www      4122: ###############################################
                   4123: sub domainlogo {
1.517     raeburn  4124:     my $domain = &determinedomain(shift);
1.518     albertel 4125:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4126:     # See if there is a logo
                   4127:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4128:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4129:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4130: 	    if ($imgsrc =~ m{^/res/}) {
                   4131: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4132: 		&Apache::lonnet::repcopy($local_name);
                   4133: 	    }
                   4134: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4135:         } 
                   4136:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4137:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4138:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4139:     } else {
1.60      matthew  4140:         return '';
1.59      www      4141:     }
                   4142: }
1.63      www      4143: ##############################################
                   4144: 
                   4145: =pod
                   4146: 
1.112     bowersj2 4147: =item * &designparm()
1.63      www      4148: 
                   4149: Inputs: $which parameter; $domain (usually will be undef)
                   4150: 
                   4151: Returns: value of designparamter $which
                   4152: 
                   4153: =cut
1.112     bowersj2 4154: 
1.397     albertel 4155: 
1.400     albertel 4156: ##############################################
1.397     albertel 4157: sub designparm {
                   4158:     my ($which,$domain)=@_;
                   4159:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4160:         return $env{'environment.color.'.$which};
1.96      www      4161:     }
1.63      www      4162:     $domain=&determinedomain($domain);
1.518     albertel 4163:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  4164:     my $output;
1.517     raeburn  4165:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4166:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4167:     } else {
1.520     raeburn  4168:         $output = $defaultdesign{$which};
                   4169:     }
                   4170:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4171:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4172:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4173:             if ($output =~ m{^/res/}) {
                   4174:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4175:                 &Apache::lonnet::repcopy($local_name);
                   4176:             }
1.520     raeburn  4177:             $output = &lonhttpdurl($output);
                   4178:         }
1.63      www      4179:     }
1.520     raeburn  4180:     return $output;
1.63      www      4181: }
1.59      www      4182: 
1.822     bisitz   4183: ##############################################
                   4184: =pod
                   4185: 
                   4186: =item * &head_subbox()
                   4187: 
                   4188: Inputs: $content (contains HTML code with page functions, etc.)
                   4189: 
                   4190: Returns: HTML div with $content
                   4191:          To be included in page header
                   4192: 
                   4193: =cut
                   4194: 
                   4195: sub head_subbox {
                   4196:     my ($content)=@_;
                   4197:     my $output =
                   4198:         '<div id="LC_head_subbox2">' #FIXME: solve conflicts with lonhtmlcommon:breadcrumbs LC_head_subbox
                   4199:        .$content
                   4200:        .'</div>'
                   4201: }
                   4202: 
                   4203: ##############################################
                   4204: =pod
                   4205: 
                   4206: =item * &CSTR_pageheader()
                   4207: 
                   4208: Inputs: ./.
                   4209: 
                   4210: Returns: HTML div with CSTR path and recent box
                   4211:          To be included on Construction Space pages
                   4212: 
                   4213: =cut
                   4214: 
                   4215: sub CSTR_pageheader {
                   4216:     # this is for resources; directories have customtitle, and crumbs
                   4217:             # and select recent are created in lonpubdir.pm  
                   4218:     my ($uname,$thisdisfn)=
                   4219:         ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
                   4220:     my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   4221:     $formaction=~s/\/+/\//g;
                   4222: 
                   4223:     my $parentpath = '';
                   4224:     my $lastitem = '';
                   4225:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4226:         $parentpath = $1;
                   4227:         $lastitem = $2;
                   4228:     } else {
                   4229:         $lastitem = $thisdisfn;
                   4230:     }
                   4231:     return
                   4232:          '<div>'
                   4233:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4234:         .'<b>'.&mt('Construction Space:').'</b> '
                   4235:         .'<form name="dirs" method="post" action="'.$formaction
                   4236:         .'" target="_top"><tt><b>' #FIXME lonpubdir: target="_parent"
                   4237:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."$lastitem</b></tt><br />"
                   4238:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4239:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4240:         .'</form>'
                   4241:         .&Apache::lonmenu::constspaceform()
                   4242:         .'</div>';
                   4243: }
                   4244: 
1.60      matthew  4245: ###############################################
                   4246: ###############################################
                   4247: 
                   4248: =pod
                   4249: 
1.112     bowersj2 4250: =back
                   4251: 
1.549     albertel 4252: =head1 HTML Helpers
1.112     bowersj2 4253: 
                   4254: =over 4
                   4255: 
                   4256: =item * &bodytag()
1.60      matthew  4257: 
                   4258: Returns a uniform header for LON-CAPA web pages.
                   4259: 
                   4260: Inputs: 
                   4261: 
1.112     bowersj2 4262: =over 4
                   4263: 
                   4264: =item * $title, A title to be displayed on the page.
                   4265: 
                   4266: =item * $function, the current role (can be undef).
                   4267: 
                   4268: =item * $addentries, extra parameters for the <body> tag.
                   4269: 
                   4270: =item * $bodyonly, if defined, only return the <body> tag.
                   4271: 
                   4272: =item * $domain, if defined, force a given domain.
                   4273: 
                   4274: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4275:             text interface only)
1.60      matthew  4276: 
1.814     bisitz   4277: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4278:                      navigational links
1.317     albertel 4279: 
1.338     albertel 4280: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4281: 
1.361     albertel 4282: =item * $no_inline_link, if true and in remote mode, don't show the 
                   4283:          'Switch To Inline Menu' link
                   4284: 
1.460     albertel 4285: =item * $args, optional argument valid values are
                   4286:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4287:             inherit_jsmath -> when creating popup window in a page,
                   4288:                               should it have jsmath forced on by the
                   4289:                               current page
1.460     albertel 4290: 
1.112     bowersj2 4291: =back
                   4292: 
1.60      matthew  4293: Returns: A uniform header for LON-CAPA web pages.  
                   4294: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4295: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4296: other decorations will be returned.
                   4297: 
                   4298: =cut
                   4299: 
1.54      www      4300: sub bodytag {
1.831   ! bisitz   4301:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816     bisitz   4302:         $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339     albertel 4303: 
1.460     albertel 4304:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4305: 
1.183     matthew  4306:     $function = &get_users_function() if (!$function);
1.339     albertel 4307:     my $img =    &designparm($function.'.img',$domain);
                   4308:     my $font =   &designparm($function.'.font',$domain);
                   4309:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4310: 
1.803     bisitz   4311:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4312: 		   'bgcolor' => $pgbg,
1.339     albertel 4313: 		   'text'    => $font,
                   4314:                    'alink'   => &designparm($function.'.alink',$domain),
                   4315: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4316: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4317:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4318: 
1.63      www      4319:  # role and realm
1.378     raeburn  4320:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4321:     if ($role  eq 'ca') {
1.479     albertel 4322:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4323:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4324:     } 
1.55      www      4325: # realm
1.258     albertel 4326:     if ($env{'request.course.id'}) {
1.378     raeburn  4327:         if ($env{'request.role'} !~ /^cr/) {
                   4328:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4329:         }
1.359     albertel 4330: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4331:     } else {
                   4332:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4333:     }
1.433     albertel 4334: 
1.359     albertel 4335:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      4336: # Set messages
1.60      matthew  4337:     my $messages=&domainlogo($domain);
1.330     albertel 4338: 
1.438     albertel 4339:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4340: 
1.101     www      4341: # construct main body tag
1.359     albertel 4342:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4343: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4344: 
1.530     albertel 4345:     if ($bodyonly) {
1.60      matthew  4346:         return $bodytag;
1.798     tempelho 4347:     } 
1.359     albertel 4348: 
1.410     albertel 4349:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433     albertel 4350:     if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   4351: 	undef($role);
1.434     albertel 4352:     } else {
                   4353: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4354:     }
1.359     albertel 4355:     
                   4356:     my $roleinfo=(<<ENDROLE);
                   4357: <td class="LC_title_bar_who">
                   4358: <div class="LC_title_bar_name">
1.410     albertel 4359:     $name
1.361     albertel 4360:     &nbsp;
1.359     albertel 4361: </div>
                   4362: <div class="LC_title_bar_role">
1.361     albertel 4363: $role&nbsp;
1.359     albertel 4364: </div>
                   4365: <div class="LC_title_bar_realm">
1.361     albertel 4366: $realm&nbsp;
1.359     albertel 4367: </div>
1.206     albertel 4368: </td>
                   4369: ENDROLE
1.235     raeburn  4370: 
1.762     bisitz   4371:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4372:     #
                   4373:     # Extra info if you are the DC
                   4374:     my $dc_info = '';
                   4375:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4376:                         $env{'course.'.$env{'request.course.id'}.
                   4377:                                  '.domain'}.'/'})) {
                   4378:         my $cid = $env{'request.course.id'};
                   4379:         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4380:         $dc_info =~ s/\s+$//;
1.359     albertel 4381:         $dc_info = '('.$dc_info.')';
                   4382:     }
                   4383: 
1.644     www      4384:     if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359     albertel 4385:         # No Remote
1.258     albertel 4386: 	if ($env{'request.state'} eq 'construct') {
1.359     albertel 4387: 	    $forcereg=1;
                   4388: 	}
                   4389: 
1.831   ! bisitz   4390:     if ($env{'request.state'} eq 'construct') {
1.822     bisitz   4391:         $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4392:     }
1.359     albertel 4393: 
1.816     bisitz   4394:         my $titletable = '<table id="LC_title_bar">'
                   4395:                         ."<tr><td> $titleinfo $dc_info</td>".$roleinfo
                   4396:                         .'</tr></table>';
                   4397: 
1.814     bisitz   4398: 	if ($no_nav_bar) {
1.359     albertel 4399: 	    $bodytag .= $titletable;
                   4400: 	} else {
1.813     bisitz   4401:         $bodytag .= qq|<div id="LC_nav_bar">$name ($role)<br />
                   4402:             <em>$realm</em> $dc_info</div>|;
1.359     albertel 4403: 	    if ($env{'request.state'} eq 'construct') {
1.337     albertel 4404:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
                   4405: 							  $titletable);
1.272     raeburn  4406:             } else {
1.336     albertel 4407:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359     albertel 4408: 		    $titletable;
1.272     raeburn  4409:             }
1.235     raeburn  4410:         }
                   4411:         return $bodytag;
1.94      www      4412:     }
1.95      www      4413: 
1.93      www      4414: #
1.95      www      4415: # Top frame rendering, Remote is up
1.93      www      4416: #
1.359     albertel 4417: 
1.517     raeburn  4418:     my $imgsrc = $img;
                   4419:     if ($img =~ /^\/adm/) {
1.575     albertel 4420:         $imgsrc = &lonhttpdurl($img);
1.517     raeburn  4421:     }
                   4422:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359     albertel 4423: 
1.305     www      4424:     # Explicit link to get inline menu
1.361     albertel 4425:     my $menu= ($no_inline_link?''
                   4426: 	       :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245     matthew  4427:     #
1.94      www      4428:     return(<<ENDBODY);
1.60      matthew  4429: $bodytag
1.359     albertel 4430: <table id="LC_title_bar" class="LC_with_remote">
1.791     tempelho 4431: <tr><td>$upperleft</td>
                   4432:     <td>$messages&nbsp;</td>
1.54      www      4433: </tr>
1.359     albertel 4434: <tr><td>$titleinfo $dc_info $menu</td>
                   4435: $roleinfo
1.368     albertel 4436: </tr>
1.356     albertel 4437: </table>
1.54      www      4438: ENDBODY
1.182     matthew  4439: }
                   4440: 
1.330     albertel 4441: sub make_attr_string {
                   4442:     my ($register,$attr_ref) = @_;
                   4443: 
                   4444:     if ($attr_ref && !ref($attr_ref)) {
                   4445: 	die("addentries Must be a hash ref ".
                   4446: 	    join(':',caller(1))." ".
                   4447: 	    join(':',caller(0))." ");
                   4448:     }
                   4449: 
                   4450:     if ($register) {
1.339     albertel 4451: 	my ($on_load,$on_unload);
                   4452: 	foreach my $key (keys(%{$attr_ref})) {
                   4453: 	    if      (lc($key) eq 'onload') {
                   4454: 		$on_load.=$attr_ref->{$key}.';';
                   4455: 		delete($attr_ref->{$key});
                   4456: 
                   4457: 	    } elsif (lc($key) eq 'onunload') {
                   4458: 		$on_unload.=$attr_ref->{$key}.';';
                   4459: 		delete($attr_ref->{$key});
                   4460: 	    }
                   4461: 	}
                   4462: 	$attr_ref->{'onload'}  =
                   4463: 	    &Apache::lonmenu::loadevents().  $on_load;
                   4464: 	$attr_ref->{'onunload'}=
                   4465: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   4466:     }
                   4467: 
                   4468: # Accessibility font enhance
                   4469:     if ($env{'browser.fontenhance'} eq 'on') {
                   4470: 	my $style;
                   4471: 	foreach my $key (keys(%{$attr_ref})) {
                   4472: 	    if (lc($key) eq 'style') {
                   4473: 		$style.=$attr_ref->{$key}.';';
                   4474: 		delete($attr_ref->{$key});
                   4475: 	    }
                   4476: 	}
                   4477: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 4478:     }
1.339     albertel 4479: 
1.330     albertel 4480:     my $attr_string;
                   4481:     foreach my $attr (keys(%$attr_ref)) {
                   4482: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4483:     }
                   4484:     return $attr_string;
                   4485: }
                   4486: 
                   4487: 
1.182     matthew  4488: ###############################################
1.251     albertel 4489: ###############################################
                   4490: 
                   4491: =pod
                   4492: 
                   4493: =item * &endbodytag()
                   4494: 
                   4495: Returns a uniform footer for LON-CAPA web pages.
                   4496: 
1.635     raeburn  4497: Inputs: 1 - optional reference to an args hash
                   4498: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4499: a 'Continue' link is not displayed if the page contains an
                   4500: internal redirect in the <head></head> section,
                   4501: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4502: 
                   4503: =cut
                   4504: 
                   4505: sub endbodytag {
1.635     raeburn  4506:     my ($args) = @_;
1.251     albertel 4507:     my $endbodytag='</body>';
1.269     albertel 4508:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4509:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4510:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4511: 	    $endbodytag=
                   4512: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4513: 	        &mt('Continue').'</a>'.
                   4514: 	        $endbodytag;
                   4515:         }
1.315     albertel 4516:     }
1.251     albertel 4517:     return $endbodytag;
                   4518: }
                   4519: 
1.352     albertel 4520: =pod
                   4521: 
                   4522: =item * &standard_css()
                   4523: 
                   4524: Returns a style sheet
                   4525: 
                   4526: Inputs: (all optional)
                   4527:             domain         -> force to color decorate a page for a specific
                   4528:                                domain
                   4529:             function       -> force usage of a specific rolish color scheme
                   4530:             bgcolor        -> override the default page bgcolor
                   4531: 
                   4532: =cut
                   4533: 
1.343     albertel 4534: sub standard_css {
1.345     albertel 4535:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4536:     $function  = &get_users_function() if (!$function);
                   4537:     my $img    = &designparm($function.'.img',   $domain);
                   4538:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4539:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4540:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4541: #second colour for later usage
1.345     albertel 4542:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4543:     my $pgbg_or_bgcolor =
                   4544: 	         $bgcolor ||
1.352     albertel 4545: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4546:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4547:     my $alink  = &designparm($function.'.alink', $domain);
                   4548:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4549:     my $link   = &designparm($function.'.link',  $domain);
                   4550: 
1.704     muellerd 4551:     my $loginbg = &designparm('login.sidebg',$domain);
1.712     muellerd 4552:     my $bgcol = &designparm('login.bgcol',$domain);
                   4553:     my $textcol = &designparm('login.textcol',$domain);
1.704     muellerd 4554: 
1.602     albertel 4555:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4556:     my $mono                 = 'monospace';
1.352     albertel 4557:     my $data_table_head      = $tabbg;
                   4558:     my $data_table_light     = '#EEEEEE';
1.470     banghart 4559:     my $data_table_dark      = '#DDDDDD';
                   4560:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4561:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4562:     my $mail_new             = '#FFBB77';
                   4563:     my $mail_new_hover       = '#DD9955';
                   4564:     my $mail_read            = '#BBBB77';
                   4565:     my $mail_read_hover      = '#999944';
                   4566:     my $mail_replied         = '#AAAA88';
                   4567:     my $mail_replied_hover   = '#888855';
                   4568:     my $mail_other           = '#99BBBB';
                   4569:     my $mail_other_hover     = '#669999';
1.391     albertel 4570:     my $table_header         = '#DDDDDD';
1.489     raeburn  4571:     my $feedback_link_bg     = '#BBBBBB';
1.701     harmsja  4572:     my $lg_border_color	     = '#C8C8C8';
1.392     albertel 4573: 
1.608     albertel 4574:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.803     bisitz   4575: 		  $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   4576: 	                                                 : '0 3px 0 4px';
1.448     albertel 4577: 
1.523     albertel 4578: 
1.343     albertel 4579:     return <<END;
1.795     www      4580: body {
                   4581:    font-family: $sans;
                   4582:    line-height:130%;
                   4583:    font-size:0.83em;
                   4584:    color:$font;
                   4585: }
                   4586: 
                   4587: a:link, a:visited { 
                   4588:   font-size:100%; 
                   4589: }
                   4590: 
                   4591: a:focus { 
                   4592:   color: red;
                   4593:   background: yellow 
                   4594: }
1.698     harmsja  4595: 
1.795     www      4596: form, .inline { 
                   4597:    display: inline; 
                   4598: }
1.721     harmsja  4599: 
1.795     www      4600: .LC_right {
                   4601:    text-align:right;
                   4602: }
                   4603: 
                   4604: .LC_middle {
                   4605:    vertical-align:middle;
                   4606: }
1.721     harmsja  4607: 
                   4608: /* just for tests */
1.754     droeschl 4609: .LC_400Box {width:400px; }
1.721     harmsja  4610: /* end */
                   4611: 
1.778     bisitz   4612: .LC_filename {
                   4613:   font-family: $mono;
                   4614:   white-space:pre;
                   4615: }
                   4616: 
                   4617: .LC_fileicon {
                   4618:   border: none;
                   4619:   height: 1.3em;
                   4620:   vertical-align: text-bottom;
                   4621:   margin-right: 0.3em;
                   4622:   text-decoration:none;
                   4623: }
                   4624: 
1.350     albertel 4625: .LC_error {
                   4626:   color: red;
                   4627:   font-size: larger;
                   4628: }
1.795     www      4629: 
1.457     albertel 4630: .LC_warning,
                   4631: .LC_diff_removed {
1.733     bisitz   4632:   color: red;
1.394     albertel 4633: }
1.532     albertel 4634: 
                   4635: .LC_info,
1.457     albertel 4636: .LC_success,
                   4637: .LC_diff_added {
1.350     albertel 4638:   color: green;
                   4639: }
1.795     www      4640: 
1.802     bisitz   4641: div.LC_confirm_box {
                   4642:   background-color: #FAFAFA;
                   4643:   border: 1px solid $lg_border_color;
                   4644:   margin-right: 0;
                   4645:   padding: 5px;
                   4646: }
                   4647: 
                   4648: div.LC_confirm_box .LC_error img,
                   4649: div.LC_confirm_box .LC_success img {
                   4650:   vertical-align: middle;
                   4651: }
                   4652: 
1.440     albertel 4653: .LC_icon {
1.771     droeschl 4654:   border: none;
1.790     droeschl 4655:   vertical-align: middle;
1.771     droeschl 4656: }
                   4657: 
1.543     albertel 4658: .LC_docs_spacer {
                   4659:   width: 25px;
                   4660:   height: 1px;
1.771     droeschl 4661:   border: none;
1.543     albertel 4662: }
1.346     albertel 4663: 
1.532     albertel 4664: .LC_internal_info {
1.735     bisitz   4665:   color: #999999;
1.532     albertel 4666: }
                   4667: 
1.794     www      4668: .LC_discussion {
                   4669:    background: $tabbg;
                   4670:    border: 1px solid black;
                   4671:    margin: 2px;
                   4672: }
                   4673: 
                   4674: .LC_disc_action_links_bar {
                   4675:    background: $tabbg;
1.803     bisitz   4676:    border: none;
1.795     www      4677:    margin: 4px;
1.794     www      4678: }
                   4679: 
                   4680: .LC_disc_action_left {
                   4681:    text-align: left;
                   4682: }
                   4683: 
                   4684: .LC_disc_action_right {
                   4685:    text-align: right;
                   4686: }
                   4687: 
                   4688: .LC_disc_new_item {
                   4689:    background: white;
                   4690:    border: 2px solid red;
                   4691:    margin: 2px;
                   4692: }
                   4693: 
                   4694: .LC_disc_old_item {
                   4695:    background: white;
                   4696:    border: 1px solid black;
                   4697:    margin: 2px;
                   4698: }
                   4699: 
1.458     albertel 4700: table.LC_pastsubmission {
                   4701:   border: 1px solid black;
                   4702:   margin: 2px;
                   4703: }
                   4704: 
1.795     www      4705: table#LC_top_nav,
                   4706: table#LC_menubuttons,
                   4707: table#LC_nav_location {
1.345     albertel 4708:   width: 100%;
                   4709:   background: $pgbg;
1.392     albertel 4710:   border: 2px;
1.402     albertel 4711:   border-collapse: separate;
1.803     bisitz   4712:   padding: 0;
1.345     albertel 4713: }
1.392     albertel 4714: 
1.801     tempelho 4715: table#LC_title_bar a {
                   4716:   color: $fontmenu;
                   4717: }
1.808     droeschl 4718:     
1.807     droeschl 4719: table#LC_title_bar {
1.819     tempelho 4720:   clear: both;
1.807     droeschl 4721:   /*display: none;*/
                   4722: }
                   4723: 
1.795     www      4724: table#LC_title_bar,
                   4725: table.LC_breadcrumbs,
1.393     albertel 4726: table#LC_title_bar.LC_with_remote {
1.359     albertel 4727:   width: 100%;
1.392     albertel 4728:   border-color: $pgbg;
                   4729:   border-style: solid;
                   4730:   border-width: $border;
1.379     albertel 4731:   background: $pgbg;
1.801     tempelho 4732:   color: $fontmenu;
1.392     albertel 4733:   border-collapse: collapse;
1.803     bisitz   4734:   padding: 0;
1.819     tempelho 4735:   margin: 0;
1.359     albertel 4736: }
1.795     www      4737: 
1.409     albertel 4738: table.LC_docs_path {
                   4739:   width: 100%;
                   4740:   border: 0;
                   4741:   background: $pgbg;
                   4742:   border-collapse: collapse;
1.803     bisitz   4743:   padding: 0;
1.409     albertel 4744: }
                   4745: 
1.359     albertel 4746: table#LC_title_bar td {
                   4747:   background: $tabbg;
                   4748: }
1.795     www      4749: 
1.773     ehlerst  4750: table#LC_title_bar .LC_title_bar_who {
1.359     albertel 4751:   background: $tabbg;
1.801     tempelho 4752:   color: $fontmenu;
1.827     bisitz   4753:   font: small;
1.359     albertel 4754:   text-align: right;
1.803     bisitz   4755:   margin: 0;
1.773     ehlerst  4756: }
1.795     www      4757: 
1.819     tempelho 4758: table#LC_title_bar div.LC_title_bar_name {
1.803     bisitz   4759:   margin: 0;
1.773     ehlerst  4760: }
1.795     www      4761: 
1.819     tempelho 4762: table#LC_title_bar div.LC_title_bar_role {
1.803     bisitz   4763:   margin: 0;
1.773     ehlerst  4764: }
1.795     www      4765: 
1.819     tempelho 4766: table#LC_title_bar div.LC_title_bar_realm {
1.803     bisitz   4767:   margin: 0;
1.359     albertel 4768: }
1.795     www      4769: 
1.706     harmsja  4770: table#LC_menubuttons img{
1.803     bisitz   4771:   border: none;
1.346     albertel 4772: }
1.795     www      4773: 
1.345     albertel 4774: table#LC_top_nav td {
                   4775:   background: $tabbg;
1.803     bisitz   4776:   border: none;
1.407     albertel 4777:   font-size: small;
1.706     harmsja  4778:   vertical-align:top;
                   4779:   padding:2px 5px 2px 5px;
1.345     albertel 4780: }
1.795     www      4781: 
                   4782: table#LC_top_nav td a,
                   4783: div#LC_top_nav a {
1.345     albertel 4784:   color: $font;
                   4785: }
1.795     www      4786: 
1.364     albertel 4787: table#LC_top_nav td.LC_top_nav_logo {
                   4788:   background: $tabbg;
1.432     albertel 4789:   text-align: left;
1.408     albertel 4790:   white-space: nowrap;
1.432     albertel 4791:   width: 31px;
1.408     albertel 4792: }
1.795     www      4793: 
1.408     albertel 4794: table#LC_top_nav td.LC_top_nav_logo img {
1.803     bisitz   4795:   border: none;
1.408     albertel 4796:   vertical-align: bottom;
1.364     albertel 4797: }
1.795     www      4798: 
1.777     tempelho 4799: table#LC_top_nav td.LC_top_nav_exit,
1.779     bisitz   4800: table#LC_top_nav td.LC_top_nav_help {
1.777     tempelho 4801:   width: 2.0em;
                   4802: }
1.795     www      4803: 
1.442     albertel 4804: table#LC_top_nav td.LC_top_nav_login {
                   4805:   width: 4.0em;
                   4806:   text-align: center;
                   4807: }
1.795     www      4808: 
                   4809: table.LC_breadcrumbs td,
                   4810: table.LC_docs_path td  {
1.357     albertel 4811:   background: $tabbg;
1.801     tempelho 4812:   color: $fontmenu;
1.358     albertel 4813:   font-size: smaller;
1.357     albertel 4814: }
1.795     www      4815: 
1.777     tempelho 4816: table.LC_breadcrumbs td.LC_breadcrumbs_component,
                   4817: table.LC_docs_path td.LC_docs_path_component {
1.779     bisitz   4818:   background: $tabbg;
1.801     tempelho 4819:   color: $fontmenu;
1.779     bisitz   4820:   font-size: larger;
                   4821:   text-align: right;
1.777     tempelho 4822: }
1.795     www      4823: 
1.383     albertel 4824: td.LC_table_cell_checkbox {
                   4825:   text-align: center;
                   4826: }
1.795     www      4827: 
1.779     bisitz   4828: table#LC_mainmenu td.LC_mainmenu_column {
                   4829:     vertical-align: top;
1.777     tempelho 4830: }
1.522     albertel 4831: 
1.795     www      4832: .LC_fontsize_small {
1.705     tempelho 4833:  font-size: 70%;
                   4834: }
                   4835: 
1.819     tempelho 4836: #LC_head_subbox {
                   4837:  clear:both;
                   4838:  background: $sidebg;
1.822     bisitz   4839:  border-bottom: 1px solid $lg_border_color;
1.819     tempelho 4840:  height: 32px;
                   4841:  line-height: 32px; 
1.822     bisitz   4842:  margin: 0;
1.819     tempelho 4843:  padding: 0;
                   4844: }
                   4845: 
1.822     bisitz   4846: #LC_head_subbox2 { /* FIXME: replace by LC_head_subbox once lonhtmlcommon::breadcrumbs has been fixed */
                   4847:  clear:both;
                   4848:  background: #F8F8F8; /* $sidebg; */
                   4849:  border-bottom: 1px solid $lg_border_color;
                   4850:  margin: 0 0 10px 0;
                   4851:  padding: 5px;
                   4852: }
                   4853: 
1.795     www      4854: .LC_fontsize_medium {
1.705     tempelho 4855:  font-size: 85%;
                   4856: }
                   4857: 
1.795     www      4858: .LC_fontsize_large {
1.705     tempelho 4859:  font-size: 120%;
                   4860: }
                   4861: 
1.346     albertel 4862: .LC_menubuttons_inline_text {
                   4863:   color: $font;
1.698     harmsja  4864:   font-size: 90%;
1.701     harmsja  4865:   padding-left:3px;
1.346     albertel 4866: }
                   4867: 
1.526     www      4868: .LC_menubuttons_link {
                   4869:   text-decoration: none;
                   4870: }
1.795     www      4871: 
1.522     albertel 4872: .LC_menubuttons_category {
1.521     www      4873:   color: $font;
1.526     www      4874:   background: $pgbg;
1.521     www      4875:   font-size: larger;
                   4876:   font-weight: bold;
                   4877: }
                   4878: 
1.346     albertel 4879: td.LC_menubuttons_text {
1.779     bisitz   4880:  	color: $font;
1.346     albertel 4881: }
1.706     harmsja  4882: 
1.346     albertel 4883: .LC_current_location {
                   4884:   background: $tabbg;
                   4885: }
1.795     www      4886: 
1.346     albertel 4887: .LC_new_mail {
1.634     www      4888:   background: $tabbg;
1.346     albertel 4889:   font-weight: bold;
                   4890: }
1.347     albertel 4891: 
1.666     raeburn  4892: .LC_roleslog_note {
1.701     harmsja  4893:   font-size: small;
1.666     raeburn  4894: }
                   4895: 
1.715     raeburn  4896: .LC_mail_functions {
                   4897:     font-weight: bold;
                   4898: }
                   4899: 
1.795     www      4900: table.LC_data_table,
                   4901: table.LC_mail_list {
1.347     albertel 4902:   border: 1px solid #000000;
1.402     albertel 4903:   border-collapse: separate;
1.426     albertel 4904:   border-spacing: 1px;
1.610     albertel 4905:   background: $pgbg;
1.347     albertel 4906: }
1.795     www      4907: 
1.422     albertel 4908: .LC_data_table_dense {
                   4909:   font-size: small;
                   4910: }
1.795     www      4911: 
1.507     raeburn  4912: table.LC_nested_outer {
                   4913:   border: 1px solid #000000;
1.589     raeburn  4914:   border-collapse: collapse;
1.803     bisitz   4915:   border-spacing: 0;
1.507     raeburn  4916:   width: 100%;
                   4917: }
1.795     www      4918: 
1.507     raeburn  4919: table.LC_nested {
1.803     bisitz   4920:   border: none;
1.589     raeburn  4921:   border-collapse: collapse;
1.803     bisitz   4922:   border-spacing: 0;
1.507     raeburn  4923:   width: 100%;
                   4924: }
1.795     www      4925: 
                   4926: table.LC_data_table tr th, 
                   4927: table.LC_calendar tr th, 
                   4928: table.LC_mail_list tr th,
1.523     albertel 4929: table.LC_prior_tries tr th {
1.349     albertel 4930:   font-weight: bold;
                   4931:   background-color: $data_table_head;
1.801     tempelho 4932:   color:$fontmenu;
1.701     harmsja  4933:   font-size:90%;
1.347     albertel 4934: }
1.795     www      4935: 
1.711     raeburn  4936: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   4937:   background-color: #CCCCCC;
1.711     raeburn  4938:   font-weight: bold;
                   4939:   text-align: left;
                   4940: }
1.795     www      4941: 
1.779     bisitz   4942: table.LC_data_table tr.LC_odd_row > td,
1.809     bisitz   4943: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 4944:   background-color: $data_table_light;
1.425     albertel 4945:   padding: 2px;
1.347     albertel 4946: }
1.795     www      4947: 
1.610     albertel 4948: table.LC_data_table tr.LC_even_row > td,
1.809     bisitz   4949: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 4950:   background-color: $data_table_dark;
1.709     bisitz   4951:   padding: 2px;
1.347     albertel 4952: }
1.795     www      4953: 
1.425     albertel 4954: table.LC_data_table tr.LC_data_table_highlight td {
                   4955:   background-color: $data_table_darker;
                   4956: }
1.795     www      4957: 
1.639     raeburn  4958: table.LC_data_table tr td.LC_leftcol_header {
                   4959:   background-color: $data_table_head;
                   4960:   font-weight: bold;
                   4961: }
1.795     www      4962: 
1.451     albertel 4963: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  4964: table.LC_nested tr.LC_empty_row td {
1.347     albertel 4965:   background-color: #FFFFFF;
1.421     albertel 4966:   font-weight: bold;
                   4967:   font-style: italic;
                   4968:   text-align: center;
                   4969:   padding: 8px;
1.347     albertel 4970: }
1.795     www      4971: 
1.507     raeburn  4972: table.LC_nested tr.LC_empty_row td {
1.465     albertel 4973:   padding: 4ex
                   4974: }
1.795     www      4975: 
1.507     raeburn  4976: table.LC_nested_outer tr th {
                   4977:   font-weight: bold;
1.801     tempelho 4978:   color:$fontmenu;
1.507     raeburn  4979:   background-color: $data_table_head;
1.701     harmsja  4980:   font-size: small;
1.507     raeburn  4981:   border-bottom: 1px solid #000000;
                   4982: }
1.795     www      4983: 
1.507     raeburn  4984: table.LC_nested_outer tr td.LC_subheader {
                   4985:   background-color: $data_table_head;
                   4986:   font-weight: bold;
                   4987:   font-size: small;
                   4988:   border-bottom: 1px solid #000000;
                   4989:   text-align: right;
1.451     albertel 4990: }
1.795     www      4991: 
1.507     raeburn  4992: table.LC_nested tr.LC_info_row td {
1.735     bisitz   4993:   background-color: #CCCCCC;
1.451     albertel 4994:   font-weight: bold;
                   4995:   font-size: small;
1.507     raeburn  4996:   text-align: center;
                   4997: }
1.795     www      4998: 
1.589     raeburn  4999: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5000: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5001:   text-align: left;
1.451     albertel 5002: }
1.795     www      5003: 
1.507     raeburn  5004: table.LC_nested td {
1.735     bisitz   5005:   background-color: #FFFFFF;
1.451     albertel 5006:   font-size: small;
1.507     raeburn  5007: }
1.795     www      5008: 
1.507     raeburn  5009: table.LC_nested_outer tr th.LC_right_item,
                   5010: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5011: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5012: table.LC_nested tr td.LC_right_item {
1.451     albertel 5013:   text-align: right;
                   5014: }
                   5015: 
1.507     raeburn  5016: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5017:   background-color: #EEEEEE;
1.451     albertel 5018: }
                   5019: 
1.473     raeburn  5020: table.LC_createuser {
                   5021: }
                   5022: 
                   5023: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5024:   font-size: small;
1.473     raeburn  5025: }
                   5026: 
                   5027: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5028:   background-color: #CCCCCC;
1.473     raeburn  5029:   font-weight: bold;
                   5030:   text-align: center;
                   5031: }
                   5032: 
1.349     albertel 5033: table.LC_calendar {
                   5034:   border: 1px solid #000000;
                   5035:   border-collapse: collapse;
                   5036: }
1.795     www      5037: 
1.349     albertel 5038: table.LC_calendar_pickdate {
                   5039:   font-size: xx-small;
                   5040: }
1.795     www      5041: 
1.349     albertel 5042: table.LC_calendar tr td {
                   5043:   border: 1px solid #000000;
                   5044:   vertical-align: top;
                   5045: }
1.795     www      5046: 
1.349     albertel 5047: table.LC_calendar tr td.LC_calendar_day_empty {
                   5048:   background-color: $data_table_dark;
                   5049: }
1.795     www      5050: 
1.779     bisitz   5051: table.LC_calendar tr td.LC_calendar_day_current {
                   5052:   background-color: $data_table_highlight;
1.777     tempelho 5053: }
1.795     www      5054: 
1.349     albertel 5055: table.LC_mail_list tr.LC_mail_new {
                   5056:   background-color: $mail_new;
                   5057: }
1.795     www      5058: 
1.349     albertel 5059: table.LC_mail_list tr.LC_mail_new:hover {
                   5060:   background-color: $mail_new_hover;
                   5061: }
1.795     www      5062: 
                   5063: table.LC_mail_list tr.LC_mail_even {
1.777     tempelho 5064: }
1.795     www      5065: 
                   5066: table.LC_mail_list tr.LC_mail_odd {
1.777     tempelho 5067: }
1.795     www      5068: 
1.349     albertel 5069: table.LC_mail_list tr.LC_mail_read {
                   5070:   background-color: $mail_read;
                   5071: }
1.795     www      5072: 
1.349     albertel 5073: table.LC_mail_list tr.LC_mail_read:hover {
                   5074:   background-color: $mail_read_hover;
                   5075: }
1.795     www      5076: 
1.349     albertel 5077: table.LC_mail_list tr.LC_mail_replied {
                   5078:   background-color: $mail_replied;
                   5079: }
1.795     www      5080: 
1.349     albertel 5081: table.LC_mail_list tr.LC_mail_replied:hover {
                   5082:   background-color: $mail_replied_hover;
                   5083: }
1.795     www      5084: 
1.349     albertel 5085: table.LC_mail_list tr.LC_mail_other {
                   5086:   background-color: $mail_other;
                   5087: }
1.795     www      5088: 
1.349     albertel 5089: table.LC_mail_list tr.LC_mail_other:hover {
                   5090:   background-color: $mail_other_hover;
                   5091: }
1.494     raeburn  5092: 
1.777     tempelho 5093: table.LC_data_table tr > td.LC_browser_file,
                   5094: table.LC_data_table tr > td.LC_browser_file_published {
1.389     albertel 5095:   background: #CCFF88;
                   5096: }
1.795     www      5097: 
1.777     tempelho 5098: table.LC_data_table tr > td.LC_browser_file_locked,
                   5099: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5100:   background: #FFAA99;
1.387     albertel 5101: }
1.795     www      5102: 
1.777     tempelho 5103: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.779     bisitz   5104:   background: #AAAAAA;
                   5105: }
1.795     www      5106: 
1.777     tempelho 5107: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5108: table.LC_data_table tr > td.LC_browser_file_metamodified {
                   5109:   background: #FFFF77;
1.777     tempelho 5110: }
1.795     www      5111: 
1.696     bisitz   5112: table.LC_data_table tr.LC_browser_folder > td {
1.389     albertel 5113:   background: #CCCCFF;
1.387     albertel 5114: }
1.696     bisitz   5115: 
1.707     bisitz   5116: table.LC_data_table tr > td.LC_roles_is {
                   5117: /*  background: #77FF77; */
                   5118: }
1.795     www      5119: 
1.707     bisitz   5120: table.LC_data_table tr > td.LC_roles_future {
                   5121:   background: #FFFF77;
                   5122: }
1.795     www      5123: 
1.707     bisitz   5124: table.LC_data_table tr > td.LC_roles_will {
                   5125:   background: #FFAA77;
                   5126: }
1.795     www      5127: 
1.707     bisitz   5128: table.LC_data_table tr > td.LC_roles_expired {
                   5129:   background: #FF7777;
                   5130: }
1.795     www      5131: 
1.707     bisitz   5132: table.LC_data_table tr > td.LC_roles_will_not {
                   5133:   background: #AAFF77;
                   5134: }
1.795     www      5135: 
1.707     bisitz   5136: table.LC_data_table tr > td.LC_roles_selected {
                   5137:   background: #11CC55;
                   5138: }
                   5139: 
1.388     albertel 5140: span.LC_current_location {
1.701     harmsja  5141:   font-size:larger;
1.388     albertel 5142:   background: $pgbg;
                   5143: }
1.387     albertel 5144: 
1.395     albertel 5145: span.LC_parm_menu_item {
                   5146:   font-size: larger;
                   5147: }
1.795     www      5148: 
1.395     albertel 5149: span.LC_parm_scope_all {
                   5150:   color: red;
                   5151: }
1.795     www      5152: 
1.395     albertel 5153: span.LC_parm_scope_folder {
                   5154:   color: green;
                   5155: }
1.795     www      5156: 
1.395     albertel 5157: span.LC_parm_scope_resource {
                   5158:   color: orange;
                   5159: }
1.795     www      5160: 
1.395     albertel 5161: span.LC_parm_part {
                   5162:   color: blue;
                   5163: }
1.795     www      5164: 
1.395     albertel 5165: span.LC_parm_folder, span.LC_parm_symb {
                   5166:   font-size: x-small;
                   5167:   font-family: $mono;
                   5168:   color: #AAAAAA;
                   5169: }
                   5170: 
1.795     www      5171: td.LC_parm_overview_level_menu,
                   5172: td.LC_parm_overview_map_menu,
                   5173: td.LC_parm_overview_parm_selectors,
                   5174: td.LC_parm_overview_restrictions  {
1.396     albertel 5175:   border: 1px solid black;
                   5176:   border-collapse: collapse;
                   5177: }
1.795     www      5178: 
1.396     albertel 5179: table.LC_parm_overview_restrictions td {
                   5180:   border-width: 1px 4px 1px 4px;
                   5181:   border-style: solid;
                   5182:   border-color: $pgbg;
                   5183:   text-align: center;
                   5184: }
1.795     www      5185: 
1.396     albertel 5186: table.LC_parm_overview_restrictions th {
                   5187:   background: $tabbg;
                   5188:   border-width: 1px 4px 1px 4px;
                   5189:   border-style: solid;
                   5190:   border-color: $pgbg;
                   5191: }
1.795     www      5192: 
1.398     albertel 5193: table#LC_helpmenu {
1.803     bisitz   5194:   border: none;
1.398     albertel 5195:   height: 55px;
1.803     bisitz   5196:   border-spacing: 0;
1.398     albertel 5197: }
                   5198: 
                   5199: table#LC_helpmenu fieldset legend {
                   5200:   font-size: larger;
                   5201:   font-weight: bold;
                   5202: }
1.795     www      5203: 
1.397     albertel 5204: table#LC_helpmenu_links {
                   5205:   width: 100%;
                   5206:   border: 1px solid black;
                   5207:   background: $pgbg;
1.803     bisitz   5208:   padding: 0;
1.397     albertel 5209:   border-spacing: 1px;
                   5210: }
1.795     www      5211: 
1.397     albertel 5212: table#LC_helpmenu_links tr td {
                   5213:   padding: 1px;
                   5214:   background: $tabbg;
1.399     albertel 5215:   text-align: center;
                   5216:   font-weight: bold;
1.397     albertel 5217: }
1.396     albertel 5218: 
1.795     www      5219: table#LC_helpmenu_links a:link,
                   5220: table#LC_helpmenu_links a:visited,
1.397     albertel 5221: table#LC_helpmenu_links a:active {
                   5222:   text-decoration: none;
                   5223:   color: $font;
                   5224: }
1.795     www      5225: 
1.397     albertel 5226: table#LC_helpmenu_links a:hover {
                   5227:   text-decoration: underline;
                   5228:   color: $vlink;
                   5229: }
1.396     albertel 5230: 
1.417     albertel 5231: .LC_chrt_popup_exists {
                   5232:   border: 1px solid #339933;
                   5233:   margin: -1px;
                   5234: }
1.795     www      5235: 
1.417     albertel 5236: .LC_chrt_popup_up {
                   5237:   border: 1px solid yellow;
                   5238:   margin: -1px;
                   5239: }
1.795     www      5240: 
1.417     albertel 5241: .LC_chrt_popup {
                   5242:   border: 1px solid #8888FF;
                   5243:   background: #CCCCFF;
                   5244: }
1.795     www      5245: 
1.421     albertel 5246: table.LC_pick_box {
                   5247:   border-collapse: separate;
                   5248:   background: white;
                   5249:   border: 1px solid black;
                   5250:   border-spacing: 1px;
                   5251: }
1.795     www      5252: 
1.421     albertel 5253: table.LC_pick_box td.LC_pick_box_title {
                   5254:   background: $tabbg;
                   5255:   font-weight: bold;
                   5256:   text-align: right;
1.740     bisitz   5257:   vertical-align: top;
1.421     albertel 5258:   width: 184px;
                   5259:   padding: 8px;
                   5260: }
1.795     www      5261: 
1.645     raeburn  5262: table.LC_pick_box td.LC_selfenroll_pick_box_title {
                   5263:   background: $tabbg;
                   5264:   font-weight: bold;
                   5265:   text-align: right;
                   5266:   width: 350px;
                   5267:   padding: 8px;
                   5268: }
                   5269: 
1.579     raeburn  5270: table.LC_pick_box td.LC_pick_box_value {
                   5271:   text-align: left;
                   5272:   padding: 8px;
                   5273: }
1.795     www      5274: 
1.579     raeburn  5275: table.LC_pick_box td.LC_pick_box_select {
                   5276:   text-align: left;
                   5277:   padding: 8px;
                   5278: }
1.795     www      5279: 
1.424     albertel 5280: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5281:   padding: 0;
1.421     albertel 5282:   height: 1px;
                   5283:   background: black;
                   5284: }
1.795     www      5285: 
1.421     albertel 5286: table.LC_pick_box td.LC_pick_box_submit {
                   5287:   text-align: right;
                   5288: }
1.795     www      5289: 
1.579     raeburn  5290: table.LC_pick_box td.LC_evenrow_value {
                   5291:   text-align: left;
                   5292:   padding: 8px;
                   5293:   background-color: $data_table_light;
                   5294: }
1.795     www      5295: 
1.579     raeburn  5296: table.LC_pick_box td.LC_oddrow_value {
                   5297:   text-align: left;
                   5298:   padding: 8px;
                   5299:   background-color: $data_table_light;
                   5300: }
1.795     www      5301: 
1.579     raeburn  5302: table.LC_helpform_receipt {
                   5303:   width: 620px;
                   5304:   border-collapse: separate;
                   5305:   background: white;
                   5306:   border: 1px solid black;
                   5307:   border-spacing: 1px;
                   5308: }
1.795     www      5309: 
1.579     raeburn  5310: table.LC_helpform_receipt td.LC_pick_box_title {
                   5311:   background: $tabbg;
                   5312:   font-weight: bold;
                   5313:   text-align: right;
                   5314:   width: 184px;
                   5315:   padding: 8px;
                   5316: }
1.795     www      5317: 
1.579     raeburn  5318: table.LC_helpform_receipt td.LC_evenrow_value {
                   5319:   text-align: left;
                   5320:   padding: 8px;
                   5321:   background-color: $data_table_light;
                   5322: }
1.795     www      5323: 
1.579     raeburn  5324: table.LC_helpform_receipt td.LC_oddrow_value {
                   5325:   text-align: left;
                   5326:   padding: 8px;
                   5327:   background-color: $data_table_light;
                   5328: }
1.795     www      5329: 
1.579     raeburn  5330: table.LC_helpform_receipt td.LC_pick_box_separator {
1.803     bisitz   5331:   padding: 0;
1.579     raeburn  5332:   height: 1px;
                   5333:   background: black;
                   5334: }
1.795     www      5335: 
1.579     raeburn  5336: span.LC_helpform_receipt_cat {
                   5337:   font-weight: bold;
                   5338: }
1.795     www      5339: 
1.424     albertel 5340: table.LC_group_priv_box {
                   5341:   background: white;
                   5342:   border: 1px solid black;
                   5343:   border-spacing: 1px;
                   5344: }
1.795     www      5345: 
1.424     albertel 5346: table.LC_group_priv_box td.LC_pick_box_title {
                   5347:   background: $tabbg;
                   5348:   font-weight: bold;
                   5349:   text-align: right;
                   5350:   width: 184px;
                   5351: }
1.795     www      5352: 
1.424     albertel 5353: table.LC_group_priv_box td.LC_groups_fixed {
                   5354:   background: $data_table_light;
                   5355:   text-align: center;
                   5356: }
1.795     www      5357: 
1.424     albertel 5358: table.LC_group_priv_box td.LC_groups_optional {
                   5359:   background: $data_table_dark;
                   5360:   text-align: center;
                   5361: }
1.795     www      5362: 
1.424     albertel 5363: table.LC_group_priv_box td.LC_groups_functionality {
                   5364:   background: $data_table_darker;
                   5365:   text-align: center;
                   5366:   font-weight: bold;
                   5367: }
1.795     www      5368: 
1.424     albertel 5369: table.LC_group_priv td {
                   5370:   text-align: left;
1.803     bisitz   5371:   padding: 0;
1.424     albertel 5372: }
                   5373: 
1.421     albertel 5374: table.LC_notify_front_page {
                   5375:   background: white;
                   5376:   border: 1px solid black;
                   5377:   padding: 8px;
                   5378: }
1.795     www      5379: 
1.421     albertel 5380: table.LC_notify_front_page td {
                   5381:   padding: 8px;
                   5382: }
1.795     www      5383: 
1.424     albertel 5384: .LC_navbuttons {
                   5385:   margin: 2ex 0ex 2ex 0ex;
                   5386: }
1.795     www      5387: 
1.423     albertel 5388: .LC_topic_bar {
                   5389:   font-weight: bold;
                   5390:   width: 100%;
                   5391:   background: $tabbg;
                   5392:   vertical-align: middle;
                   5393:   margin: 2ex 0ex 2ex 0ex;
1.805     bisitz   5394:   padding: 3px;
1.423     albertel 5395: }
1.795     www      5396: 
1.423     albertel 5397: .LC_topic_bar span {
                   5398:   vertical-align: middle;
                   5399: }
1.795     www      5400: 
1.423     albertel 5401: .LC_topic_bar img {
                   5402:   vertical-align: bottom;
                   5403: }
1.795     www      5404: 
1.423     albertel 5405: table.LC_course_group_status {
                   5406:   margin: 20px;
                   5407: }
1.795     www      5408: 
1.423     albertel 5409: table.LC_status_selector td {
                   5410:   vertical-align: top;
                   5411:   text-align: center;
1.424     albertel 5412:   padding: 4px;
                   5413: }
1.795     www      5414: 
1.599     albertel 5415: div.LC_feedback_link {
1.616     albertel 5416:   clear: both;
1.829     kalberla 5417:   background: $sidebg;
1.779     bisitz   5418:   width: 100%;
1.829     kalberla 5419:   padding-bottom: 10px;
                   5420:   border: 1px $tabbg solid;
                   5421: }
                   5422: 
                   5423: div.LC_feedback_link a{
                   5424:   text-decoration: none;
1.489     raeburn  5425: }
1.795     www      5426: 
1.489     raeburn  5427: span.LC_feedback_link {
1.829     kalberla 5428:   //background: $feedback_link_bg;
1.599     albertel 5429:   font-size: larger;
                   5430: }
1.795     www      5431: 
1.599     albertel 5432: span.LC_message_link {
1.829     kalberla 5433:   //background: $feedback_link_bg;
1.599     albertel 5434:   font-size: larger;
                   5435:   position: absolute;
                   5436:   right: 1em;
1.489     raeburn  5437: }
1.421     albertel 5438: 
1.515     albertel 5439: table.LC_prior_tries {
1.524     albertel 5440:   border: 1px solid #000000;
                   5441:   border-collapse: separate;
                   5442:   border-spacing: 1px;
1.515     albertel 5443: }
1.523     albertel 5444: 
1.515     albertel 5445: table.LC_prior_tries td {
1.524     albertel 5446:   padding: 2px;
1.515     albertel 5447: }
1.523     albertel 5448: 
                   5449: .LC_answer_correct {
1.795     www      5450:   background: lightgreen;
                   5451:   color: darkgreen;
                   5452:   padding: 6px;
1.523     albertel 5453: }
1.795     www      5454: 
1.523     albertel 5455: .LC_answer_charged_try {
1.797     www      5456:   background: #FFAAAA;
1.795     www      5457:   color: darkred;
                   5458:   padding: 6px;
1.523     albertel 5459: }
1.795     www      5460: 
1.779     bisitz   5461: .LC_answer_not_charged_try,
1.523     albertel 5462: .LC_answer_no_grade,
                   5463: .LC_answer_late {
1.795     www      5464:   background: lightyellow;
1.523     albertel 5465:   color: black;
1.795     www      5466:   padding: 6px;
1.523     albertel 5467: }
1.795     www      5468: 
1.523     albertel 5469: .LC_answer_previous {
1.795     www      5470:   background: lightblue;
                   5471:   color: darkblue;
                   5472:   padding: 6px;
1.523     albertel 5473: }
1.795     www      5474: 
1.779     bisitz   5475: .LC_answer_no_message {
1.777     tempelho 5476:   background: #FFFFFF;
                   5477:   color: black;
1.795     www      5478:   padding: 6px;
1.779     bisitz   5479: }
1.795     www      5480: 
1.779     bisitz   5481: .LC_answer_unknown {
                   5482:   background: orange;
                   5483:   color: black;
1.795     www      5484:   padding: 6px;
1.777     tempelho 5485: }
1.795     www      5486: 
1.529     albertel 5487: span.LC_prior_numerical,
                   5488: span.LC_prior_string,
                   5489: span.LC_prior_custom,
                   5490: span.LC_prior_reaction,
                   5491: span.LC_prior_math {
1.523     albertel 5492:   font-family: monospace;
                   5493:   white-space: pre;
                   5494: }
                   5495: 
1.525     albertel 5496: span.LC_prior_string {
                   5497:   font-family: monospace;
                   5498:   white-space: pre;
                   5499: }
                   5500: 
1.523     albertel 5501: table.LC_prior_option {
                   5502:   width: 100%;
                   5503:   border-collapse: collapse;
                   5504: }
1.795     www      5505: 
                   5506: table.LC_prior_rank, 
                   5507: table.LC_prior_match {
1.528     albertel 5508:   border-collapse: collapse;
                   5509: }
1.795     www      5510: 
1.528     albertel 5511: table.LC_prior_option tr td,
                   5512: table.LC_prior_rank tr td,
                   5513: table.LC_prior_match tr td {
1.524     albertel 5514:   border: 1px solid #000000;
1.515     albertel 5515: }
                   5516: 
1.770     droeschl 5517: td.LC_nobreak,
1.519     raeburn  5518: span.LC_nobreak {
1.544     albertel 5519:   white-space: nowrap;
1.519     raeburn  5520: }
                   5521: 
1.576     raeburn  5522: span.LC_cusr_emph {
                   5523:   font-style: italic;
                   5524: }
                   5525: 
1.633     raeburn  5526: span.LC_cusr_subheading {
                   5527:   font-weight: normal;
                   5528:   font-size: 85%;
                   5529: }
                   5530: 
1.545     albertel 5531: table.LC_docs_documents {
                   5532:   background: #BBBBBB;
1.803     bisitz   5533:   border-width: 0;
1.545     albertel 5534:   border-collapse: collapse;
                   5535: }
1.795     www      5536: 
1.777     tempelho 5537: table.LC_docs_documents td.LC_docs_document {
1.779     bisitz   5538:   border: 2px solid black;
                   5539:   padding: 4px;
1.777     tempelho 5540: }
1.795     www      5541: 
1.545     albertel 5542: .LC_docs_entry_move {
1.803     bisitz   5543:   border: none;
1.545     albertel 5544:   border-collapse: collapse;
1.544     albertel 5545: }
                   5546: 
1.545     albertel 5547: .LC_docs_entry_move td {
                   5548:   border: 2px solid #BBBBBB;
                   5549:   background: #DDDDDD;
                   5550: }
                   5551: 
                   5552: .LC_docs_editor td.LC_docs_entry_commands {
                   5553:   background: #DDDDDD;
                   5554:   font-size: x-small;
                   5555: }
1.795     www      5556: 
1.544     albertel 5557: .LC_docs_copy {
1.545     albertel 5558:   color: #000099;
1.544     albertel 5559: }
1.795     www      5560: 
1.544     albertel 5561: .LC_docs_cut {
1.545     albertel 5562:   color: #550044;
1.544     albertel 5563: }
1.795     www      5564: 
1.544     albertel 5565: .LC_docs_rename {
1.545     albertel 5566:   color: #009900;
1.544     albertel 5567: }
1.795     www      5568: 
1.544     albertel 5569: .LC_docs_remove {
1.545     albertel 5570:   color: #990000;
                   5571: }
                   5572: 
1.547     albertel 5573: .LC_docs_reinit_warn,
                   5574: .LC_docs_ext_edit {
                   5575:   font-size: x-small;
                   5576: }
                   5577: 
1.545     albertel 5578: .LC_docs_editor td.LC_docs_entry_title,
                   5579: .LC_docs_editor td.LC_docs_entry_icon {
                   5580:   background: #FFFFBB;
                   5581: }
1.795     www      5582: 
1.545     albertel 5583: .LC_docs_editor td.LC_docs_entry_parameter {
                   5584:   background: #BBBBFF;
                   5585:   font-size: x-small;
                   5586:   white-space: nowrap;
                   5587: }
                   5588: 
                   5589: table.LC_docs_adddocs td,
                   5590: table.LC_docs_adddocs th {
                   5591:   border: 1px solid #BBBBBB;
                   5592:   padding: 4px;
                   5593:   background: #DDDDDD;
1.543     albertel 5594: }
                   5595: 
1.584     albertel 5596: table.LC_sty_begin {
                   5597:   background: #BBFFBB;
                   5598: }
1.795     www      5599: 
1.584     albertel 5600: table.LC_sty_end {
                   5601:   background: #FFBBBB;
                   5602: }
                   5603: 
1.589     raeburn  5604: table.LC_double_column {
1.803     bisitz   5605:   border-width: 0;
1.589     raeburn  5606:   border-collapse: collapse;
                   5607:   width: 100%;
                   5608:   padding: 2px;
                   5609: }
                   5610: 
                   5611: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5612:   top: 2px;
1.589     raeburn  5613:   left: 2px;
                   5614:   width: 47%;
                   5615:   vertical-align: top;
                   5616: }
                   5617: 
                   5618: table.LC_double_column tr td.LC_right_col {
                   5619:   top: 2px;
1.779     bisitz   5620:   right: 2px;
1.589     raeburn  5621:   width: 47%;
                   5622:   vertical-align: top;
                   5623: }
                   5624: 
1.594     raeburn  5625: span.LC_role_level {
                   5626:   font-weight: bold;
                   5627: }
                   5628: 
1.591     raeburn  5629: div.LC_left_float {
                   5630:   float: left;
                   5631:   padding-right: 5%;
1.597     albertel 5632:   padding-bottom: 4px;
1.591     raeburn  5633: }
                   5634: 
                   5635: div.LC_clear_float_header {
1.597     albertel 5636:   padding-bottom: 2px;
1.591     raeburn  5637: }
                   5638: 
                   5639: div.LC_clear_float_footer {
1.597     albertel 5640:   padding-top: 10px;
1.591     raeburn  5641:   clear: both;
                   5642: }
                   5643: 
1.597     albertel 5644: div.LC_grade_show_user {
                   5645:   margin-top: 20px;
                   5646:   border: 1px solid black;
                   5647: }
1.795     www      5648: 
1.597     albertel 5649: div.LC_grade_user_name {
                   5650:   background: #DDDDEE;
                   5651:   border-bottom: 1px solid black;
1.705     tempelho 5652:   font-weight: bold;
                   5653:   font-size: large;
1.597     albertel 5654: }
1.795     www      5655: 
1.597     albertel 5656: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5657:   background: #DDEEDD;
                   5658: }
                   5659: 
                   5660: div.LC_grade_show_problem,
                   5661: div.LC_grade_submissions,
                   5662: div.LC_grade_message_center,
                   5663: div.LC_grade_info_links,
                   5664: div.LC_grade_assign {
                   5665:   margin: 5px;
                   5666:   width: 99%;
                   5667:   background: #FFFFFF;
                   5668: }
1.795     www      5669: 
1.597     albertel 5670: div.LC_grade_show_problem_header,
                   5671: div.LC_grade_submissions_header,
                   5672: div.LC_grade_message_center_header,
                   5673: div.LC_grade_assign_header {
1.705     tempelho 5674:   font-weight: bold;
                   5675:   font-size: large;
1.597     albertel 5676: }
1.795     www      5677: 
1.597     albertel 5678: div.LC_grade_show_problem_problem,
                   5679: div.LC_grade_submissions_body,
                   5680: div.LC_grade_message_center_body,
                   5681: div.LC_grade_assign_body {
                   5682:   border: 1px solid black;
                   5683:   width: 99%;
                   5684:   background: #FFFFFF;
                   5685: }
1.795     www      5686: 
1.598     albertel 5687: span.LC_grade_check_note {
1.705     tempelho 5688:   font-weight: normal;
                   5689:   font-size: medium;
1.598     albertel 5690:   display: inline;
                   5691:   position: absolute;
                   5692:   right: 1em;
                   5693: }
1.597     albertel 5694: 
1.613     albertel 5695: table.LC_scantron_action {
                   5696:   width: 100%;
                   5697: }
1.795     www      5698: 
1.613     albertel 5699: table.LC_scantron_action tr th {
1.698     harmsja  5700:   font-weight:bold;
                   5701:   font-style:normal;
1.613     albertel 5702: }
1.795     www      5703: 
1.779     bisitz   5704: .LC_edit_problem_header,
1.614     albertel 5705: div.LC_edit_problem_footer {
1.705     tempelho 5706:   font-weight: normal;
                   5707:   font-size:  medium;
1.602     albertel 5708:   margin: 2px;
1.600     albertel 5709: }
1.795     www      5710: 
1.600     albertel 5711: div.LC_edit_problem_header,
1.602     albertel 5712: div.LC_edit_problem_header div,
1.614     albertel 5713: div.LC_edit_problem_footer,
                   5714: div.LC_edit_problem_footer div,
1.602     albertel 5715: div.LC_edit_problem_editxml_header,
                   5716: div.LC_edit_problem_editxml_header div {
1.600     albertel 5717:   margin-top: 5px;
                   5718: }
1.795     www      5719: 
1.600     albertel 5720: div.LC_edit_problem_header_title {
1.705     tempelho 5721:   font-weight: bold;
                   5722:   font-size: larger;
1.602     albertel 5723:   background: $tabbg;
                   5724:   padding: 3px;
                   5725: }
1.795     www      5726: 
1.602     albertel 5727: table.LC_edit_problem_header_title {
1.705     tempelho 5728:   font-size: larger;
                   5729:   font-weight:  bold;
1.602     albertel 5730:   width: 100%;
                   5731:   border-color: $pgbg;
                   5732:   border-style: solid;
                   5733:   border-width: $border;
1.600     albertel 5734:   background: $tabbg;
1.602     albertel 5735:   border-collapse: collapse;
1.803     bisitz   5736:   padding: 0;
1.602     albertel 5737: }
                   5738: 
                   5739: div.LC_edit_problem_discards {
                   5740:   float: left;
                   5741:   padding-bottom: 5px;
                   5742: }
1.795     www      5743: 
1.602     albertel 5744: div.LC_edit_problem_saves {
                   5745:   float: right;
                   5746:   padding-bottom: 5px;
1.600     albertel 5747: }
1.795     www      5748: 
1.600     albertel 5749: hr.LC_edit_problem_divide {
1.602     albertel 5750:   clear: both;
1.600     albertel 5751:   color: $tabbg;
                   5752:   background-color: $tabbg;
                   5753:   height: 3px;
1.803     bisitz   5754:   border: none;
1.600     albertel 5755: }
1.795     www      5756: 
1.679     riegler  5757: img.stift{
1.803     bisitz   5758:   border-width: 0;
                   5759:   vertical-align: middle;
1.677     riegler  5760: }
1.680     riegler  5761: 
1.681     riegler  5762: table#LC_mainmenu{
                   5763:  margin-top:10px;
                   5764:  width:80%;
                   5765: }
                   5766: 
1.680     riegler  5767: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
                   5768:   vertical-align: top;
                   5769:   width: 45%;
                   5770: }
1.795     www      5771: 
1.779     bisitz   5772: .LC_mainmenu_fieldset_category {
                   5773:   color: $font;
                   5774:   background: $pgbg;
                   5775:   font-size: small;
                   5776:   font-weight: bold;
1.777     tempelho 5777: }
1.795     www      5778: 
1.716     raeburn  5779: div.LC_createcourse {
                   5780:     margin: 10px 10px 10px 10px;
                   5781: }
                   5782: 
1.693     droeschl 5783: /* ---- Remove when done ----
                   5784: # The following styles is part of the redesign of LON-CAPA and are
                   5785: # subject to change during this project.
                   5786: # Don't rely on their current functionality as they might be 
                   5787: # changed or removed.
                   5788: # --------------------------*/
                   5789: 
1.698     harmsja  5790: a:hover,
1.721     harmsja  5791: ol.LC_smallMenu a:hover,
                   5792: ol#LC_MenuBreadcrumbs a:hover,
                   5793: ol#LC_PathBreadcrumbs a:hover,
                   5794: ul#LC_TabMainMenuContent a:hover,
                   5795: .LC_FormSectionClearButton input:hover
1.795     www      5796: ul.LC_TabContent   li:hover a {
1.698     harmsja  5797: 	color:#BF2317;
                   5798:         text-decoration:none;
1.693     droeschl 5799: }
                   5800: 
1.779     bisitz   5801: h1 {
1.813     bisitz   5802: 	padding: 0;
1.693     droeschl 5803: 	line-height:130%;
                   5804: }
1.698     harmsja  5805: 
1.795     www      5806: h2,h3,h4,h5,h6 {
1.803     bisitz   5807: 	margin: 5px 0 5px 0;
                   5808: 	padding: 0;
1.721     harmsja  5809: 	line-height:130%;
1.693     droeschl 5810: }
1.795     www      5811: 
                   5812: .LC_hcell {
1.698     harmsja  5813:         padding:3px 15px 3px 15px;
1.803     bisitz   5814:         margin: 0;
1.703     harmsja  5815: 	background-color:$tabbg;
1.801     tempelho 5816: 	color:$fontmenu;
1.779     bisitz   5817: 	border-bottom:solid 1px $lg_border_color;
1.693     droeschl 5818: }
1.795     www      5819: 
1.721     harmsja  5820: .LC_noBorder {
1.803     bisitz   5821:         border: 0;
1.698     harmsja  5822: }
1.693     droeschl 5823: 
                   5824: 
1.698     harmsja  5825: /* Main Header with discription of Person, Course, etc. */
1.693     droeschl 5826: 
1.761     tempelho 5827: .LC_Right {
                   5828:         float: right;
1.803     bisitz   5829:         margin: 0;
                   5830:         padding: 0;
1.761     tempelho 5831: }
                   5832: 
1.721     harmsja  5833: .LC_FormSectionClearButton input {
1.779     bisitz   5834:         background-color:transparent;
1.803     bisitz   5835:         border: none;
1.698     harmsja  5836:         cursor:pointer;
                   5837:         text-decoration:underline;
1.693     droeschl 5838: }
1.763     bisitz   5839: 
                   5840: .LC_help_open_topic {
                   5841:         color: #FFFFFF;
                   5842:         background-color: #EEEEFF;
                   5843:         margin: 1px;
                   5844:         padding: 4px;
                   5845:         border: 1px solid #000033;
                   5846:         white-space: nowrap;
1.783     amueller 5847: /*		vertical-align: middle; */
1.759     neumanie 5848: }
1.693     droeschl 5849: 
1.698     harmsja  5850: dl,ul,div,fieldset {
1.803     bisitz   5851: 	margin: 10px 10px 10px 0;
1.806     bisitz   5852: /*	overflow: hidden; */
1.693     droeschl 5853: }
1.795     www      5854: 
1.813     bisitz   5855: #LC_nav_bar {
1.807     droeschl 5856:     float: left;
                   5857:     margin: 0;
                   5858: }
                   5859: 
1.813     bisitz   5860: #LC_nav_bar em{
1.807     droeschl 5861:     font-weight: bold;
                   5862:     font-style: normal;
                   5863: }
                   5864: 
                   5865: ol.LC_smallMenu {
                   5866:     float: right;
                   5867: }
                   5868: 
1.721     harmsja  5869: ol.LC_smallMenu, ol#LC_PathBreadcrumbs {
1.803     bisitz   5870: 	margin: 0;
1.693     droeschl 5871: }
                   5872: 
1.721     harmsja  5873: ol.LC_smallMenu li {
1.693     droeschl 5874: 	display: inline;
1.803     bisitz   5875: 	padding: 5px 5px 0 10px;
1.693     droeschl 5876: 	vertical-align: top;
                   5877: }
                   5878: 
1.721     harmsja  5879: ol.LC_smallMenu li img {
1.693     droeschl 5880: 	vertical-align: bottom;
                   5881: }
                   5882: 
1.721     harmsja  5883: ol.LC_smallMenu a {
1.693     droeschl 5884: 	font-size: 90%;
                   5885: 	color: RGB(80, 80, 80);
                   5886: 	text-decoration: none;
                   5887: }
1.795     www      5888: 
1.808     droeschl 5889: ul#LC_TabMainMenuContent {
1.807     droeschl 5890:     clear: both;
1.808     droeschl 5891:     color: $fontmenu;
                   5892:     background: $tabbg;
                   5893:     list-style: none;
                   5894:     padding: 0;
                   5895:     margin: 0;
                   5896:     float:left;
                   5897:     width: 100%;
                   5898: }
                   5899: 
                   5900: ul#LC_TabMainMenuContent li {
                   5901:     float: left;
                   5902:     font-weight: bold;
                   5903:     line-height: 1.8em;
                   5904:     padding: 0 0.8em; 
                   5905:     border-right: 1px solid black;
                   5906:     display: inline;
                   5907:     vertical-align: middle;
1.807     droeschl 5908: }
                   5909: 
1.795     www      5910: ul.LC_TabContent ,
1.741     harmsja  5911: ul.LC_TabContentBigger {
1.721     harmsja  5912: 	display:block;
                   5913: 	list-style:none;
1.803     bisitz   5914: 	margin: 0;
                   5915: 	padding: 0;
1.693     droeschl 5916: }
                   5917: 
1.795     www      5918: ul.LC_TabContent li,
                   5919: ul.LC_TabContentBigger li {
1.693     droeschl 5920: 	display: inline;
1.741     harmsja  5921: 	border-right: solid 1px $lg_border_color;
                   5922: 	float:left;
                   5923: 	line-height:140%;
                   5924: 	white-space:nowrap;
                   5925: }
1.795     www      5926: 
1.808     droeschl 5927: ul#LC_TabMainMenuContent li a {
                   5928:     color: $fontmenu;
1.693     droeschl 5929: 	text-decoration: none;
                   5930: }
1.795     www      5931: 
1.721     harmsja  5932: ul.LC_TabContent {
1.741     harmsja  5933: 	min-height:1.6em;
1.721     harmsja  5934: }
1.795     www      5935: 
                   5936: ul.LC_TabContent li {
1.741     harmsja  5937: 	vertical-align:middle;
1.803     bisitz   5938: 	padding: 0 10px 0 10px;
1.745     ehlerst  5939: 	background-color:$tabbg;
                   5940: 	border-bottom:solid 1px $lg_border_color;
1.721     harmsja  5941: }
1.795     www      5942: 
                   5943: ul.LC_TabContent li a, ul.LC_TabContent li {
1.721     harmsja  5944: 	color:rgb(47,47,47);
                   5945: 	text-decoration:none;
                   5946: 	font-size:95%;
                   5947: 	font-weight:bold;
1.761     tempelho 5948: 	padding-right: 16px;
1.721     harmsja  5949: }
1.795     www      5950: 
                   5951: ul.LC_TabContent li:hover, ul.LC_TabContent li.active {
1.761     tempelho 5952:         background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.745     ehlerst  5953: 	border-bottom:solid 1px #FFFFFF;
1.761     tempelho 5954: 	padding-right: 16px;
1.744     ehlerst  5955: }
1.795     www      5956: 
                   5957: ul.LC_TabContentBigger li {
1.741     harmsja  5958: 	vertical-align:bottom;
                   5959: 	border-top:solid 1px $lg_border_color;
                   5960: 	border-left:solid 1px $lg_border_color;
                   5961: 	padding:5px 10px 5px 10px;
                   5962: 	margin-left:2px;
                   5963: 	background:url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
                   5964: }
1.795     www      5965: 
                   5966: ul.LC_TabContentBigger li:hover, 
                   5967: ul.LC_TabContentBigger li.active {
1.744     ehlerst  5968: 	background:url(/adm/lonIcons/lightGreyBG.png) repeat-x right bottom;
                   5969: }
1.795     www      5970: 
                   5971: ul.LC_TabContentBigger li, 
                   5972: ul.LC_TabContentBigger li a {
1.741     harmsja  5973: 	font-size:110%;
                   5974: 	font-weight:bold;
                   5975: }
1.693     droeschl 5976: 
1.795     www      5977: ol#LC_MenuBreadcrumbs, 
                   5978: ol#LC_PathBreadcrumbs, 
1.823     bisitz   5979: ul#LC_CourseBreadcrumbs {
1.693     droeschl 5980: 	padding-left: 10px;
1.819     tempelho 5981: 	margin: 0;
1.693     droeschl 5982: 	list-style-position: inside;
                   5983: }
                   5984: 
1.795     www      5985: ol#LC_MenuBreadcrumbs li, 
                   5986: ol#LC_PathBreadcrumbs li, 
1.823     bisitz   5987: ul#LC_CourseBreadcrumbs li {
1.693     droeschl 5988: 	display: inline;
1.803     bisitz   5989: 	padding: 0 0 0 10px;
1.693     droeschl 5990: 	overflow:hidden;
                   5991: }
                   5992: 
1.823     bisitz   5993: ol#LC_MenuBreadcrumbs li a,
                   5994: ul#LC_CourseBreadcrumbs li a {
1.693     droeschl 5995: 	text-decoration: none;
                   5996: 	font-size:90%;
                   5997: }
1.795     www      5998: 
                   5999: ol#LC_PathBreadcrumbs li a {
1.698     harmsja  6000: 	text-decoration:none;
                   6001: 	font-size:100%;
                   6002: 	font-weight:bold;
1.693     droeschl 6003: }
1.795     www      6004: 
                   6005: .LC_BoxPadding {
1.786     neumanie 6006: 	padding: 10px;
                   6007: }
1.795     www      6008: 
                   6009: .LC_ContentBoxSpecial {
1.701     harmsja  6010: 	border: solid 1px $lg_border_color;
1.746     neumanie 6011: }
1.795     www      6012: 
                   6013: .LC_ContentBoxSpecialContactInfo {
1.746     neumanie 6014: 	border: solid 1px $lg_border_color;
                   6015: 	max-width:25%;
                   6016: 	min-width:25%;
1.698     harmsja  6017: }
1.795     www      6018: 
                   6019: .LC_AboutMe_Image {
1.747     neumanie 6020: 	float:left;
                   6021: 	margin-right:10px;
                   6022: }
1.795     www      6023: 
                   6024: .LC_Clear_AboutMe_Image {
1.747     neumanie 6025: 	clear:left;
                   6026: }
1.795     www      6027: 
1.721     harmsja  6028: dl.LC_ListStyleClean dt {
1.693     droeschl 6029: 	padding-right: 5px;
                   6030: 	display: table-header-group;
                   6031: }
                   6032: 
1.721     harmsja  6033: dl.LC_ListStyleClean dd {
1.693     droeschl 6034: 	display: table-row;
                   6035: }
                   6036: 
1.721     harmsja  6037: .LC_ListStyleClean,
                   6038: .LC_ListStyleSimple,
                   6039: .LC_ListStyleNormal,
1.777     tempelho 6040: .LC_ListStyle_Border,
1.795     www      6041: .LC_ListStyleSpecial {
1.693     droeschl 6042: 	/*display:block;	*/
                   6043: 	list-style-position: inside;
                   6044: 	list-style-type: none;
                   6045: 	overflow: hidden;
1.803     bisitz   6046: 	padding: 0;
1.693     droeschl 6047: }
                   6048: 
1.721     harmsja  6049: .LC_ListStyleSimple li,
                   6050: .LC_ListStyleSimple dd,
                   6051: .LC_ListStyleNormal li,
                   6052: .LC_ListStyleNormal dd,
                   6053: .LC_ListStyleSpecial li,
1.795     www      6054: .LC_ListStyleSpecial dd {
1.803     bisitz   6055: 	margin: 0;
1.693     droeschl 6056: 	padding: 5px 5px 5px 10px;
                   6057: 	clear: both;
                   6058: }
                   6059: 
1.721     harmsja  6060: .LC_ListStyleClean li,
                   6061: .LC_ListStyleClean dd {
1.803     bisitz   6062: 	padding-top: 0;
                   6063: 	padding-bottom: 0;
1.693     droeschl 6064: }
                   6065: 
1.721     harmsja  6066: .LC_ListStyleSimple dd,
1.795     www      6067: .LC_ListStyleSimple li {
1.698     harmsja  6068: 	border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6069: }
                   6070: 
1.721     harmsja  6071: .LC_ListStyleSpecial li,
                   6072: .LC_ListStyleSpecial dd {
1.693     droeschl 6073: 	list-style-type: none;
                   6074: 	background-color: RGB(220, 220, 220);
                   6075: 	margin-bottom: 4px;
                   6076: }
                   6077: 
1.721     harmsja  6078: table.LC_SimpleTable {
1.698     harmsja  6079: 	margin:5px;
                   6080: 	border:solid 1px $lg_border_color;
1.795     www      6081: }
1.693     droeschl 6082: 
1.721     harmsja  6083: table.LC_SimpleTable tr {
1.803     bisitz   6084: 	padding: 0;
1.698     harmsja  6085: 	border:solid 1px $lg_border_color;
1.693     droeschl 6086: }
1.795     www      6087: 
                   6088: table.LC_SimpleTable thead {
1.698     harmsja  6089: 	 background:rgb(220,220,220);
1.693     droeschl 6090: }
                   6091: 
1.721     harmsja  6092: div.LC_columnSection {
1.693     droeschl 6093: 	display: block;
                   6094: 	clear: both;
                   6095: 	overflow: hidden;
1.803     bisitz   6096: 	margin: 0;
1.693     droeschl 6097: }
                   6098: 
1.721     harmsja  6099: div.LC_columnSection>* {
1.693     droeschl 6100: 	float: left;
1.803     bisitz   6101: 	margin: 10px 20px 10px 0;
1.747     neumanie 6102: 	overflow:hidden;
1.693     droeschl 6103: }
1.721     harmsja  6104: 
1.795     www      6105: .ContentBoxSpecialTemplate {
1.747     neumanie 6106:         border: solid 1px $lg_border_color;
1.719     ehlerst  6107: }
1.795     www      6108: 
1.719     ehlerst  6109: .ContentBoxTemplate {
                   6110:         padding:10px;
                   6111: }
                   6112: 
1.721     harmsja  6113: div.LC_columnSection > .ContentBoxTemplate,
1.795     www      6114: div.LC_columnSection > .ContentBoxSpecialTemplate {
1.719     ehlerst  6115:         width: 600px;
                   6116: }
1.753     droeschl 6117: 
1.795     www      6118: .clear {
1.720     ehlerst  6119: 	clear: both;
1.803     bisitz   6120: 	line-height: 0;
                   6121: 	font-size: 0;
                   6122: 	height: 0;
1.720     ehlerst  6123: }
1.693     droeschl 6124: 
1.694     tempelho 6125: .LC_loginpage_container {
                   6126: 	text-align:left;
                   6127: 	margin : 0 auto;
1.785     tempelho 6128: 	width:90%;
1.694     tempelho 6129: 	padding: 10px;
                   6130: 	height: auto;
1.712     muellerd 6131: 	background-color:#FFFFFF;
1.694     tempelho 6132: 	border:1px solid #CCCCCC;
                   6133: }
                   6134: 
                   6135: 
                   6136: .LC_loginpage_loginContainer {
                   6137: 	float:left;
1.712     muellerd 6138: 	width: 182px;
1.785     tempelho 6139: 	padding: 2px;
1.712     muellerd 6140: 	border:1px solid #CCCCCC;
                   6141: 	background-color:$loginbg;
1.694     tempelho 6142: }
                   6143: 
1.795     www      6144: .LC_loginpage_loginContainer h2 {
1.803     bisitz   6145: 	margin-top: 0;
1.712     muellerd 6146: 	display:block;
                   6147: 	background:$bgcol;
                   6148: 	color:$textcol;
                   6149: 	padding-left:5px;
                   6150: }
1.785     tempelho 6151: 
1.694     tempelho 6152: .LC_loginpage_loginInfo {
                   6153: 	float:left;
1.785     tempelho 6154: 	width:182px;
1.694     tempelho 6155: 	border:1px solid #CCCCCC;
1.785     tempelho 6156: 	padding:2px;
1.712     muellerd 6157: }
                   6158: 
1.694     tempelho 6159: .LC_loginpage_space {
1.754     droeschl 6160: 	clear: both;
                   6161: 	margin-bottom: 20px;
1.694     tempelho 6162: 	border-bottom: 1px solid #CCCCCC;
                   6163: }
                   6164: 
1.785     tempelho 6165: .LC_loginpage_floatLeft {
                   6166: 	float: left;
                   6167: 	width: 200px;
                   6168: 	margin: 0;
                   6169: }
                   6170: 
1.795     www      6171: table em {
1.754     droeschl 6172: 	font-weight: bold;
                   6173: 	font-style: normal;
1.748     schulted 6174: }
1.795     www      6175: 
1.779     bisitz   6176: table.LC_tableBrowseRes,
1.795     www      6177: table.LC_tableOfContent {
1.769     schulted 6178:         border:none;
                   6179: 	border-spacing: 1;
1.754     droeschl 6180: 	padding: 3px;
                   6181: 	background-color: #FFFFFF;
                   6182: 	font-size: 90%;
1.753     droeschl 6183: }
1.789     droeschl 6184: 
                   6185: table.LC_tableOfContent{
                   6186:     border-collapse: collapse;
                   6187: }
                   6188: 
1.771     droeschl 6189: table.LC_tableBrowseRes a,
1.768     schulted 6190: table.LC_tableOfContent a {
1.771     droeschl 6191:         background-color: transparent;
1.753     droeschl 6192: 	text-decoration: none;
                   6193: }
                   6194: 
1.771     droeschl 6195: table.LC_tableBrowseRes tr.LC_trOdd,
1.768     schulted 6196: table.LC_tableOfContent tr.LC_trOdd{
1.754     droeschl 6197: 	background-color: #EEEEEE;
1.753     droeschl 6198: }
                   6199: 
1.795     www      6200: table.LC_tableOfContent img {
1.753     droeschl 6201: 	border: none;
                   6202: 	height: 1.3em;
                   6203: 	vertical-align: text-bottom;
                   6204: 	margin-right: 0.3em;
                   6205: }
1.757     schulted 6206: 
1.795     www      6207: a#LC_content_toolbar_firsthomework {
1.774     ehlerst  6208: 	background-image:url(/res/adm/pages/open-first-problem.gif);
                   6209: }
                   6210: 
1.795     www      6211: a#LC_content_toolbar_launchnav {
1.774     ehlerst  6212: 	background-image:url(/res/adm/pages/start-navigation.gif);
                   6213: }
                   6214: 
1.795     www      6215: a#LC_content_toolbar_closenav {
1.774     ehlerst  6216: 	background-image:url(/res/adm/pages/close-navigation.gif);
                   6217: }
                   6218: 
1.795     www      6219: a#LC_content_toolbar_everything {
1.774     ehlerst  6220: 	background-image:url(/res/adm/pages/show-all.gif);
                   6221: }
                   6222: 
1.795     www      6223: a#LC_content_toolbar_uncompleted {
1.774     ehlerst  6224: 	background-image:url(/res/adm/pages/show-incomplete-problems.gif);
                   6225: }
                   6226: 
1.795     www      6227: #LC_content_toolbar_clearbubbles {
1.774     ehlerst  6228: 	background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
                   6229: }
                   6230: 
1.795     www      6231: a#LC_content_toolbar_changefolder {
1.757     schulted 6232: 	background : url(/res/adm/pages/close-all-folders.gif) top center ;
                   6233: }
                   6234: 
1.795     www      6235: a#LC_content_toolbar_changefolder_toggled {
1.757     schulted 6236: 	background-image:url(/res/adm/pages/open-all-folders.gif);
                   6237: }
                   6238: 
1.795     www      6239: ul#LC_toolbar li a:hover {
1.757     schulted 6240: 	background-position: bottom center;
                   6241: }
                   6242: 
1.795     www      6243: ul#LC_toolbar {
1.803     bisitz   6244: 	padding: 0;
1.757     schulted 6245: 	margin: 2px;
                   6246: 	list-style:none;
                   6247: 	position:relative;
                   6248: 	background-color:white;
                   6249: }
                   6250: 
1.795     www      6251: ul#LC_toolbar li {
1.757     schulted 6252: 	border:1px solid white;
1.803     bisitz   6253: 	padding: 0;
1.757     schulted 6254: 	margin: 0;
1.795     www      6255:         float: left;
1.767     droeschl 6256: 	display:inline;
1.757     schulted 6257: 	vertical-align:middle;
1.795     www      6258: } 
1.757     schulted 6259: 
1.783     amueller 6260: 
1.795     www      6261: a.LC_toolbarItem {
1.767     droeschl 6262: 	display:block;
1.803     bisitz   6263: 	padding: 0;
                   6264: 	margin: 0;
1.757     schulted 6265: 	height: 32px;
                   6266: 	width: 32px;
1.779     bisitz   6267: 	color:white;
1.803     bisitz   6268: 	border: none;
1.757     schulted 6269: 	background-repeat:no-repeat;
                   6270: 	background-color:transparent;
                   6271: }
                   6272: 
1.782     bisitz   6273: ul.LC_functionslist li {
                   6274:   float: left;
                   6275:   white-space: nowrap;
                   6276:   height: 35px; /* at least as high as heighest list item */
1.803     bisitz   6277:   margin: 0 15px 15px 10px;
1.782     bisitz   6278: }
                   6279: 
1.757     schulted 6280: 
1.343     albertel 6281: END
                   6282: }
                   6283: 
1.306     albertel 6284: =pod
                   6285: 
                   6286: =item * &headtag()
                   6287: 
                   6288: Returns a uniform footer for LON-CAPA web pages.
                   6289: 
1.307     albertel 6290: Inputs: $title - optional title for the head
                   6291:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6292:         $args - optional arguments
1.319     albertel 6293:             force_register - if is true call registerurl so the remote is 
                   6294:                              informed
1.415     albertel 6295:             redirect       -> array ref of
                   6296:                                    1- seconds before redirect occurs
                   6297:                                    2- url to redirect to
                   6298:                                    3- whether the side effect should occur
1.315     albertel 6299:                            (side effect of setting 
                   6300:                                $env{'internal.head.redirect'} to the url 
                   6301:                                redirected too)
1.352     albertel 6302:             domain         -> force to color decorate a page for a specific
                   6303:                                domain
                   6304:             function       -> force usage of a specific rolish color scheme
                   6305:             bgcolor        -> override the default page bgcolor
1.460     albertel 6306:             no_auto_mt_title
                   6307:                            -> prevent &mt()ing the title arg
1.464     albertel 6308: 
1.306     albertel 6309: =cut
                   6310: 
                   6311: sub headtag {
1.313     albertel 6312:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6313:     
1.363     albertel 6314:     my $function = $args->{'function'} || &get_users_function();
                   6315:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6316:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6317:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6318: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6319: 		   #time(),
1.418     albertel 6320: 		   $env{'environment.color.timestamp'},
1.363     albertel 6321: 		   $function,$domain,$bgcolor);
                   6322: 
1.369     www      6323:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6324: 
1.308     albertel 6325:     my $result =
                   6326: 	'<head>'.
1.461     albertel 6327: 	&font_settings();
1.319     albertel 6328: 
1.461     albertel 6329:     if (!$args->{'frameset'}) {
                   6330: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6331:     }
1.319     albertel 6332:     if ($args->{'force_register'}) {
                   6333: 	$result .= &Apache::lonmenu::registerurl(1);
                   6334:     }
1.436     albertel 6335:     if (!$args->{'no_nav_bar'} 
                   6336: 	&& !$args->{'only_body'}
                   6337: 	&& !$args->{'frameset'}) {
                   6338: 	$result .= &help_menu_js();
                   6339:     }
1.319     albertel 6340: 
1.314     albertel 6341:     if (ref($args->{'redirect'})) {
1.414     albertel 6342: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6343: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6344: 	if (!$inhibit_continue) {
                   6345: 	    $env{'internal.head.redirect'} = $url;
                   6346: 	}
1.313     albertel 6347: 	$result.=<<ADDMETA
                   6348: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6349: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6350: ADDMETA
                   6351:     }
1.306     albertel 6352:     if (!defined($title)) {
                   6353: 	$title = 'The LearningOnline Network with CAPA';
                   6354:     }
1.460     albertel 6355:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6356:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6357: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6358: 	.$head_extra;
1.306     albertel 6359:     return $result;
                   6360: }
                   6361: 
                   6362: =pod
                   6363: 
1.340     albertel 6364: =item * &font_settings()
                   6365: 
                   6366: Returns neccessary <meta> to set the proper encoding
                   6367: 
                   6368: Inputs: none
                   6369: 
                   6370: =cut
                   6371: 
                   6372: sub font_settings {
                   6373:     my $headerstring='';
1.647     www      6374:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6375: 	$headerstring.=
                   6376: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6377:     }
                   6378:     return $headerstring;
                   6379: }
                   6380: 
1.341     albertel 6381: =pod
                   6382: 
                   6383: =item * &xml_begin()
                   6384: 
                   6385: Returns the needed doctype and <html>
                   6386: 
                   6387: Inputs: none
                   6388: 
                   6389: =cut
                   6390: 
                   6391: sub xml_begin {
                   6392:     my $output='';
                   6393: 
1.592     albertel 6394:     if ($env{'internal.start_page'}==1) {
                   6395: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6396:     }
1.342     albertel 6397: 
1.341     albertel 6398:     if ($env{'browser.mathml'}) {
                   6399: 	$output='<?xml version="1.0"?>'
                   6400:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6401: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6402:             
                   6403: #	    .'<!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">] >'
                   6404: 	    .'<!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">'
                   6405:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6406: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6407:     } else {
                   6408: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
                   6409:     }
                   6410:     return $output;
                   6411: }
1.340     albertel 6412: 
                   6413: =pod
                   6414: 
1.306     albertel 6415: =item * &endheadtag()
                   6416: 
                   6417: Returns a uniform </head> for LON-CAPA web pages.
                   6418: 
                   6419: Inputs: none
                   6420: 
                   6421: =cut
                   6422: 
                   6423: sub endheadtag {
                   6424:     return '</head>';
                   6425: }
                   6426: 
                   6427: =pod
                   6428: 
                   6429: =item * &head()
                   6430: 
                   6431: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6432: 
1.648     raeburn  6433: Inputs:
                   6434: 
                   6435: =over 4
                   6436: 
                   6437: $title - optional title for the page
                   6438: 
                   6439: $head_extra - optional extra HTML to put inside the <head>
                   6440: 
                   6441: =back
1.405     albertel 6442: 
1.306     albertel 6443: =cut
                   6444: 
                   6445: sub head {
1.325     albertel 6446:     my ($title,$head_extra,$args) = @_;
                   6447:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6448: }
                   6449: 
                   6450: =pod
                   6451: 
                   6452: =item * &start_page()
                   6453: 
                   6454: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6455: 
1.648     raeburn  6456: Inputs:
                   6457: 
                   6458: =over 4
                   6459: 
                   6460: $title - optional title for the page
                   6461: 
                   6462: $head_extra - optional extra HTML to incude inside the <head>
                   6463: 
                   6464: $args - additional optional args supported are:
                   6465: 
                   6466: =over 8
                   6467: 
                   6468:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6469:                                     arg on
1.814     bisitz   6470:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6471:              add_entries    -> additional attributes to add to the  <body>
                   6472:              domain         -> force to color decorate a page for a 
1.317     albertel 6473:                                     specific domain
1.648     raeburn  6474:              function       -> force usage of a specific rolish color
1.317     albertel 6475:                                     scheme
1.648     raeburn  6476:              redirect       -> see &headtag()
                   6477:              bgcolor        -> override the default page bg color
                   6478:              js_ready       -> return a string ready for being used in 
1.317     albertel 6479:                                     a javascript writeln
1.648     raeburn  6480:              html_encode    -> return a string ready for being used in 
1.320     albertel 6481:                                     a html attribute
1.648     raeburn  6482:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6483:                                     $forcereg arg
1.648     raeburn  6484:              frameset       -> if true will start with a <frameset>
1.330     albertel 6485:                                     rather than <body>
1.648     raeburn  6486:              skip_phases    -> hash ref of 
1.338     albertel 6487:                                     head -> skip the <html><head> generation
                   6488:                                     body -> skip all <body> generation
1.648     raeburn  6489:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6490:                                     'Switch To Inline Menu' link
1.648     raeburn  6491:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6492:              inherit_jsmath -> when creating popup window in a page,
                   6493:                                     should it have jsmath forced on by the
                   6494:                                     current page
1.361     albertel 6495: 
1.648     raeburn  6496: =back
1.460     albertel 6497: 
1.648     raeburn  6498: =back
1.562     albertel 6499: 
1.306     albertel 6500: =cut
                   6501: 
                   6502: sub start_page {
1.309     albertel 6503:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6504:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6505:     my %head_args;
1.352     albertel 6506:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6507: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6508: 		     'no_auto_mt_title') {
1.319     albertel 6509: 	if (defined($args->{$arg})) {
1.324     raeburn  6510: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6511: 	}
1.313     albertel 6512:     }
1.319     albertel 6513: 
1.315     albertel 6514:     $env{'internal.start_page'}++;
1.338     albertel 6515:     my $result;
                   6516:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6517: 	$result.=
1.341     albertel 6518: 	    &xml_begin().
1.338     albertel 6519: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6520:     }
                   6521:     
                   6522:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6523: 	if ($args->{'frameset'}) {
                   6524: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6525: 						$args->{'add_entries'});
                   6526: 	    $result .= "\n<frameset $attr_string>\n";
1.831   ! bisitz   6527:         } else {
        !          6528:             $result .=
        !          6529:                 &bodytag($title, 
        !          6530:                          $args->{'function'},       $args->{'add_entries'},
        !          6531:                          $args->{'only_body'},      $args->{'domain'},
        !          6532:                          $args->{'force_register'}, $args->{'no_nav_bar'},
        !          6533:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
        !          6534:                          $args);
        !          6535:         }
1.330     albertel 6536:     }
1.338     albertel 6537: 
1.315     albertel 6538:     if ($args->{'js_ready'}) {
1.713     kaisler  6539: 		$result = &js_ready($result);
1.315     albertel 6540:     }
1.320     albertel 6541:     if ($args->{'html_encode'}) {
1.713     kaisler  6542: 		$result = &html_encode($result);
                   6543:     }
                   6544: 
1.813     bisitz   6545:     # Preparation for new and consistent functionlist at top of screen
                   6546:     # if ($args->{'functionlist'}) {
                   6547:     #            $result .= &build_functionlist();
                   6548:     #}
                   6549: 
                   6550:     # Don't add anything more if only_body wanted
                   6551:     return $result if $args->{'only_body'};
                   6552: 
                   6553:     #Breadcrumbs
1.758     kaisler  6554:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6555: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6556: 		#if any br links exists, add them to the breadcrumbs
                   6557: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6558: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6559: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6560: 			}
                   6561: 		}
                   6562: 
                   6563: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6564: 		if(exists($args->{'bread_crumbs_component'})){
                   6565: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   6566: 		}else{
                   6567: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   6568: 		}
1.320     albertel 6569:     }
1.315     albertel 6570:     return $result;
1.306     albertel 6571: }
                   6572: 
1.330     albertel 6573: 
1.306     albertel 6574: =pod
                   6575: 
                   6576: =item * &head()
                   6577: 
                   6578: Returns a complete </body></html> section for LON-CAPA web pages.
                   6579: 
1.315     albertel 6580: Inputs:         $args - additional optional args supported are:
                   6581:                  js_ready     -> return a string ready for being used in 
                   6582:                                  a javascript writeln
1.320     albertel 6583:                  html_encode  -> return a string ready for being used in 
                   6584:                                  a html attribute
1.330     albertel 6585:                  frameset     -> if true will start with a <frameset>
                   6586:                                  rather than <body>
1.493     albertel 6587:                  dicsussion   -> if true will get discussion from
                   6588:                                   lonxml::xmlend
                   6589:                                  (you can pass the target and parser arguments
                   6590:                                   through optional 'target' and 'parser' args
                   6591:                                   to this routine)
1.306     albertel 6592: 
                   6593: =cut
                   6594: 
                   6595: sub end_page {
1.315     albertel 6596:     my ($args) = @_;
                   6597:     $env{'internal.end_page'}++;
1.330     albertel 6598:     my $result;
1.335     albertel 6599:     if ($args->{'discussion'}) {
                   6600: 	my ($target,$parser);
                   6601: 	if (ref($args->{'discussion'})) {
                   6602: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6603: 				$args->{'discussion'}{'parser'});
                   6604: 	}
                   6605: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6606:     }
                   6607: 
1.330     albertel 6608:     if ($args->{'frameset'}) {
                   6609: 	$result .= '</frameset>';
                   6610:     } else {
1.635     raeburn  6611: 	$result .= &endbodytag($args);
1.330     albertel 6612:     }
                   6613:     $result .= "\n</html>";
                   6614: 
1.315     albertel 6615:     if ($args->{'js_ready'}) {
1.317     albertel 6616: 	$result = &js_ready($result);
1.315     albertel 6617:     }
1.335     albertel 6618: 
1.320     albertel 6619:     if ($args->{'html_encode'}) {
                   6620: 	$result = &html_encode($result);
                   6621:     }
1.335     albertel 6622: 
1.315     albertel 6623:     return $result;
                   6624: }
                   6625: 
1.320     albertel 6626: sub html_encode {
                   6627:     my ($result) = @_;
                   6628: 
1.322     albertel 6629:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 6630:     
                   6631:     return $result;
                   6632: }
1.317     albertel 6633: sub js_ready {
                   6634:     my ($result) = @_;
                   6635: 
1.323     albertel 6636:     $result =~ s/[\n\r]/ /xmsg;
                   6637:     $result =~ s/\\/\\\\/xmsg;
                   6638:     $result =~ s/'/\\'/xmsg;
1.372     albertel 6639:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 6640:     
                   6641:     return $result;
                   6642: }
                   6643: 
1.315     albertel 6644: sub validate_page {
                   6645:     if (  exists($env{'internal.start_page'})
1.316     albertel 6646: 	  &&     $env{'internal.start_page'} > 1) {
                   6647: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 6648: 				 $env{'internal.start_page'}.' '.
1.316     albertel 6649: 				 $ENV{'request.filename'});
1.315     albertel 6650:     }
                   6651:     if (  exists($env{'internal.end_page'})
1.316     albertel 6652: 	  &&     $env{'internal.end_page'} > 1) {
                   6653: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 6654: 				 $env{'internal.end_page'}.' '.
1.316     albertel 6655: 				 $env{'request.filename'});
1.315     albertel 6656:     }
                   6657:     if (     exists($env{'internal.start_page'})
                   6658: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 6659: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   6660: 				 $env{'request.filename'});
1.315     albertel 6661:     }
                   6662:     if (   ! exists($env{'internal.start_page'})
                   6663: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 6664: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   6665: 				 $env{'request.filename'});
1.315     albertel 6666:     }
1.306     albertel 6667: }
1.315     albertel 6668: 
1.318     albertel 6669: sub simple_error_page {
                   6670:     my ($r,$title,$msg) = @_;
                   6671:     my $page =
                   6672: 	&Apache::loncommon::start_page($title).
                   6673: 	&mt($msg).
                   6674: 	&Apache::loncommon::end_page();
                   6675:     if (ref($r)) {
                   6676: 	$r->print($page);
1.327     albertel 6677: 	return;
1.318     albertel 6678:     }
                   6679:     return $page;
                   6680: }
1.347     albertel 6681: 
                   6682: {
1.610     albertel 6683:     my @row_count;
1.347     albertel 6684:     sub start_data_table {
1.422     albertel 6685: 	my ($add_class) = @_;
                   6686: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 6687: 	unshift(@row_count,0);
1.422     albertel 6688: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 6689:     }
                   6690: 
                   6691:     sub end_data_table {
1.610     albertel 6692: 	shift(@row_count);
1.389     albertel 6693: 	return '</table>'."\n";;
1.347     albertel 6694:     }
                   6695: 
                   6696:     sub start_data_table_row {
1.422     albertel 6697: 	my ($add_class) = @_;
1.610     albertel 6698: 	$row_count[0]++;
                   6699: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428     albertel 6700: 	$css_class = (join(' ',$css_class,$add_class));
1.422     albertel 6701: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 6702:     }
1.471     banghart 6703:     
                   6704:     sub continue_data_table_row {
                   6705: 	my ($add_class) = @_;
1.610     albertel 6706: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471     banghart 6707: 	$css_class = (join(' ',$css_class,$add_class));
                   6708: 	return  '<tr class="'.$css_class.'">'."\n";;
                   6709:     }
1.347     albertel 6710: 
                   6711:     sub end_data_table_row {
1.389     albertel 6712: 	return '</tr>'."\n";;
1.347     albertel 6713:     }
1.367     www      6714: 
1.421     albertel 6715:     sub start_data_table_empty_row {
1.707     bisitz   6716: #	$row_count[0]++;
1.421     albertel 6717: 	return  '<tr class="LC_empty_row" >'."\n";;
                   6718:     }
                   6719: 
                   6720:     sub end_data_table_empty_row {
                   6721: 	return '</tr>'."\n";;
                   6722:     }
                   6723: 
1.367     www      6724:     sub start_data_table_header_row {
1.389     albertel 6725: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      6726:     }
                   6727: 
                   6728:     sub end_data_table_header_row {
1.389     albertel 6729: 	return '</tr>'."\n";;
1.367     www      6730:     }
1.347     albertel 6731: }
                   6732: 
1.548     albertel 6733: =pod
                   6734: 
                   6735: =item * &inhibit_menu_check($arg)
                   6736: 
                   6737: Checks for a inhibitmenu state and generates output to preserve it
                   6738: 
                   6739: Inputs:         $arg - can be any of
                   6740:                      - undef - in which case the return value is a string 
                   6741:                                to add  into arguments list of a uri
                   6742:                      - 'input' - in which case the return value is a HTML
                   6743:                                  <form> <input> field of type hidden to
                   6744:                                  preserve the value
                   6745:                      - a url - in which case the return value is the url with
                   6746:                                the neccesary cgi args added to preserve the
                   6747:                                inhibitmenu state
                   6748:                      - a ref to a url - no return value, but the string is
                   6749:                                         updated to include the neccessary cgi
                   6750:                                         args to preserve the inhibitmenu state
                   6751: 
                   6752: =cut
                   6753: 
                   6754: sub inhibit_menu_check {
                   6755:     my ($arg) = @_;
                   6756:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6757:     if ($arg eq 'input') {
                   6758: 	if ($env{'form.inhibitmenu'}) {
                   6759: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   6760: 	} else {
                   6761: 	    return
                   6762: 	}
                   6763:     }
                   6764:     if ($env{'form.inhibitmenu'}) {
                   6765: 	if (ref($arg)) {
                   6766: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6767: 	} elsif ($arg eq '') {
                   6768: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   6769: 	} else {
                   6770: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6771: 	}
                   6772:     }
                   6773:     if (!ref($arg)) {
                   6774: 	return $arg;
                   6775:     }
                   6776: }
                   6777: 
1.251     albertel 6778: ###############################################
1.182     matthew  6779: 
                   6780: =pod
                   6781: 
1.549     albertel 6782: =back
                   6783: 
                   6784: =head1 User Information Routines
                   6785: 
                   6786: =over 4
                   6787: 
1.405     albertel 6788: =item * &get_users_function()
1.182     matthew  6789: 
                   6790: Used by &bodytag to determine the current users primary role.
                   6791: Returns either 'student','coordinator','admin', or 'author'.
                   6792: 
                   6793: =cut
                   6794: 
                   6795: ###############################################
                   6796: sub get_users_function {
1.815     tempelho 6797:     my $function = 'norole';
1.818     tempelho 6798:     if ($env{'request.role'}=~/^(st)/) {
                   6799:         $function='student';
                   6800:     }
1.258     albertel 6801:     if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182     matthew  6802:         $function='coordinator';
                   6803:     }
1.258     albertel 6804:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  6805:         $function='admin';
                   6806:     }
1.826     bisitz   6807:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182     matthew  6808:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   6809:         $function='author';
                   6810:     }
                   6811:     return $function;
1.54      www      6812: }
1.99      www      6813: 
                   6814: ###############################################
                   6815: 
1.233     raeburn  6816: =pod
                   6817: 
1.821     raeburn  6818: =item * &show_course()
                   6819: 
                   6820: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   6821: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   6822: 
                   6823: Inputs:
                   6824: None
                   6825: 
                   6826: Outputs:
                   6827: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   6828: 
                   6829: =cut
                   6830: 
                   6831: ###############################################
                   6832: sub show_course {
                   6833:     my $course = !$env{'user.adv'};
                   6834:     if (!$env{'user.adv'}) {
                   6835:         foreach my $env (keys(%env)) {
                   6836:             next if ($env !~ m/^user\.priv\./);
                   6837:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   6838:                 $course = 0;
                   6839:                 last;
                   6840:             }
                   6841:         }
                   6842:     }
                   6843:     return $course;
                   6844: }
                   6845: 
                   6846: ###############################################
                   6847: 
                   6848: =pod
                   6849: 
1.542     raeburn  6850: =item * &check_user_status()
1.274     raeburn  6851: 
                   6852: Determines current status of supplied role for a
                   6853: specific user. Roles can be active, previous or future.
                   6854: 
                   6855: Inputs: 
                   6856: user's domain, user's username, course's domain,
1.375     raeburn  6857: course's number, optional section ID.
1.274     raeburn  6858: 
                   6859: Outputs:
                   6860: role status: active, previous or future. 
                   6861: 
                   6862: =cut
                   6863: 
                   6864: sub check_user_status {
1.412     raeburn  6865:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  6866:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   6867:     my @uroles = keys %userinfo;
                   6868:     my $srchstr;
                   6869:     my $active_chk = 'none';
1.412     raeburn  6870:     my $now = time;
1.274     raeburn  6871:     if (@uroles > 0) {
1.412     raeburn  6872:         if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  6873:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   6874:         } else {
1.412     raeburn  6875:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   6876:         }
                   6877:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  6878:             my $role_end = 0;
                   6879:             my $role_start = 0;
                   6880:             $active_chk = 'active';
1.412     raeburn  6881:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   6882:                 $role_end = $1;
                   6883:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   6884:                     $role_start = $1;
1.274     raeburn  6885:                 }
                   6886:             }
                   6887:             if ($role_start > 0) {
1.412     raeburn  6888:                 if ($now < $role_start) {
1.274     raeburn  6889:                     $active_chk = 'future';
                   6890:                 }
                   6891:             }
                   6892:             if ($role_end > 0) {
1.412     raeburn  6893:                 if ($now > $role_end) {
1.274     raeburn  6894:                     $active_chk = 'previous';
                   6895:                 }
                   6896:             }
                   6897:         }
                   6898:     }
                   6899:     return $active_chk;
                   6900: }
                   6901: 
                   6902: ###############################################
                   6903: 
                   6904: =pod
                   6905: 
1.405     albertel 6906: =item * &get_sections()
1.233     raeburn  6907: 
                   6908: Determines all the sections for a course including
                   6909: sections with students and sections containing other roles.
1.419     raeburn  6910: Incoming parameters: 
                   6911: 
                   6912: 1. domain
                   6913: 2. course number 
                   6914: 3. reference to array containing roles for which sections should 
                   6915: be gathered (optional).
                   6916: 4. reference to array containing status types for which sections 
                   6917: should be gathered (optional).
                   6918: 
                   6919: If the third argument is undefined, sections are gathered for any role. 
                   6920: If the fourth argument is undefined, sections are gathered for any status.
                   6921: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  6922:  
1.374     raeburn  6923: Returns section hash (keys are section IDs, values are
                   6924: number of users in each section), subject to the
1.419     raeburn  6925: optional roles filter, optional status filter 
1.233     raeburn  6926: 
                   6927: =cut
                   6928: 
                   6929: ###############################################
                   6930: sub get_sections {
1.419     raeburn  6931:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 6932:     if (!defined($cdom) || !defined($cnum)) {
                   6933:         my $cid =  $env{'request.course.id'};
                   6934: 
                   6935: 	return if (!defined($cid));
                   6936: 
                   6937:         $cdom = $env{'course.'.$cid.'.domain'};
                   6938:         $cnum = $env{'course.'.$cid.'.num'};
                   6939:     }
                   6940: 
                   6941:     my %sectioncount;
1.419     raeburn  6942:     my $now = time;
1.240     albertel 6943: 
1.366     albertel 6944:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 6945: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 6946: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   6947: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  6948:         my $start_index = &Apache::loncoursedata::CL_START();
                   6949:         my $end_index = &Apache::loncoursedata::CL_END();
                   6950:         my $status;
1.366     albertel 6951: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  6952: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   6953: 				                     $data->[$status_index],
                   6954:                                                      $data->[$start_index],
                   6955:                                                      $data->[$end_index]);
                   6956:             if ($stu_status eq 'Active') {
                   6957:                 $status = 'active';
                   6958:             } elsif ($end < $now) {
                   6959:                 $status = 'previous';
                   6960:             } elsif ($start > $now) {
                   6961:                 $status = 'future';
                   6962:             } 
                   6963: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   6964:                 if ((!defined($possible_status)) || (($status ne '') && 
                   6965:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   6966: 		    $sectioncount{$section}++;
                   6967:                 }
1.240     albertel 6968: 	    }
                   6969: 	}
                   6970:     }
                   6971:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   6972:     foreach my $user (sort(keys(%courseroles))) {
                   6973: 	if ($user !~ /^(\w{2})/) { next; }
                   6974: 	my ($role) = ($user =~ /^(\w{2})/);
                   6975: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  6976: 	my ($section,$status);
1.240     albertel 6977: 	if ($role eq 'cr' &&
                   6978: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   6979: 	    $section=$1;
                   6980: 	}
                   6981: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   6982: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  6983:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   6984:         if ($end == -1 && $start == -1) {
                   6985:             next; #deleted role
                   6986:         }
                   6987:         if (!defined($possible_status)) { 
                   6988:             $sectioncount{$section}++;
                   6989:         } else {
                   6990:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   6991:                 $status = 'active';
                   6992:             } elsif ($end < $now) {
                   6993:                 $status = 'future';
                   6994:             } elsif ($start > $now) {
                   6995:                 $status = 'previous';
                   6996:             }
                   6997:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   6998:                 $sectioncount{$section}++;
                   6999:             }
                   7000:         }
1.233     raeburn  7001:     }
1.366     albertel 7002:     return %sectioncount;
1.233     raeburn  7003: }
                   7004: 
1.274     raeburn  7005: ###############################################
1.294     raeburn  7006: 
                   7007: =pod
1.405     albertel 7008: 
                   7009: =item * &get_course_users()
                   7010: 
1.275     raeburn  7011: Retrieves usernames:domains for users in the specified course
                   7012: with specific role(s), and access status. 
                   7013: 
                   7014: Incoming parameters:
1.277     albertel 7015: 1. course domain
                   7016: 2. course number
                   7017: 3. access status: users must have - either active, 
1.275     raeburn  7018: previous, future, or all.
1.277     albertel 7019: 4. reference to array of permissible roles
1.288     raeburn  7020: 5. reference to array of section restrictions (optional)
                   7021: 6. reference to results object (hash of hashes).
                   7022: 7. reference to optional userdata hash
1.609     raeburn  7023: 8. reference to optional statushash
1.630     raeburn  7024: 9. flag if privileged users (except those set to unhide in
                   7025:    course settings) should be excluded    
1.609     raeburn  7026: Keys of top level results hash are roles.
1.275     raeburn  7027: Keys of inner hashes are username:domain, with 
                   7028: values set to access type.
1.288     raeburn  7029: Optional userdata hash returns an array with arguments in the 
                   7030: same order as loncoursedata::get_classlist() for student data.
                   7031: 
1.609     raeburn  7032: Optional statushash returns
                   7033: 
1.288     raeburn  7034: Entries for end, start, section and status are blank because
                   7035: of the possibility of multiple values for non-student roles.
                   7036: 
1.275     raeburn  7037: =cut
1.405     albertel 7038: 
1.275     raeburn  7039: ###############################################
1.405     albertel 7040: 
1.275     raeburn  7041: sub get_course_users {
1.630     raeburn  7042:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7043:     my %idx = ();
1.419     raeburn  7044:     my %seclists;
1.288     raeburn  7045: 
                   7046:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7047:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7048:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7049:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7050:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7051:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7052:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7053:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7054: 
1.290     albertel 7055:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7056:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7057:         my $now = time;
1.277     albertel 7058:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7059:             my $match = 0;
1.412     raeburn  7060:             my $secmatch = 0;
1.419     raeburn  7061:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7062:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7063:             if ($section eq '') {
                   7064:                 $section = 'none';
                   7065:             }
1.291     albertel 7066:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7067:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7068:                     $secmatch = 1;
                   7069:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7070:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7071:                         $secmatch = 1;
                   7072:                     }
                   7073:                 } else {  
1.419     raeburn  7074: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7075: 		        $secmatch = 1;
                   7076:                     }
1.290     albertel 7077: 		}
1.412     raeburn  7078:                 if (!$secmatch) {
                   7079:                     next;
                   7080:                 }
1.419     raeburn  7081:             }
1.275     raeburn  7082:             if (defined($$types{'active'})) {
1.288     raeburn  7083:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7084:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7085:                     $match = 1;
1.275     raeburn  7086:                 }
                   7087:             }
                   7088:             if (defined($$types{'previous'})) {
1.609     raeburn  7089:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7090:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7091:                     $match = 1;
1.275     raeburn  7092:                 }
                   7093:             }
                   7094:             if (defined($$types{'future'})) {
1.609     raeburn  7095:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7096:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7097:                     $match = 1;
1.275     raeburn  7098:                 }
                   7099:             }
1.609     raeburn  7100:             if ($match) {
                   7101:                 push(@{$seclists{$student}},$section);
                   7102:                 if (ref($userdata) eq 'HASH') {
                   7103:                     $$userdata{$student} = $$classlist{$student};
                   7104:                 }
                   7105:                 if (ref($statushash) eq 'HASH') {
                   7106:                     $statushash->{$student}{'st'}{$section} = $status;
                   7107:                 }
1.288     raeburn  7108:             }
1.275     raeburn  7109:         }
                   7110:     }
1.412     raeburn  7111:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7112:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7113:         my $now = time;
1.609     raeburn  7114:         my %displaystatus = ( previous => 'Expired',
                   7115:                               active   => 'Active',
                   7116:                               future   => 'Future',
                   7117:                             );
1.630     raeburn  7118:         my %nothide;
                   7119:         if ($hidepriv) {
                   7120:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7121:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7122:                 if ($user !~ /:/) {
                   7123:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7124:                 } else {
                   7125:                     $nothide{$user} = 1;
                   7126:                 }
                   7127:             }
                   7128:         }
1.439     raeburn  7129:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7130:             my $match = 0;
1.412     raeburn  7131:             my $secmatch = 0;
1.439     raeburn  7132:             my $status;
1.412     raeburn  7133:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7134:             $user =~ s/:$//;
1.439     raeburn  7135:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7136:             if ($end == -1 || $start == -1) {
                   7137:                 next;
                   7138:             }
                   7139:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7140:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7141:                 my ($uname,$udom) = split(/:/,$user);
                   7142:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7143:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7144:                         $secmatch = 1;
                   7145:                     } elsif ($usec eq '') {
1.420     albertel 7146:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7147:                             $secmatch = 1;
                   7148:                         }
                   7149:                     } else {
                   7150:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7151:                             $secmatch = 1;
                   7152:                         }
                   7153:                     }
                   7154:                     if (!$secmatch) {
                   7155:                         next;
                   7156:                     }
1.288     raeburn  7157:                 }
1.419     raeburn  7158:                 if ($usec eq '') {
                   7159:                     $usec = 'none';
                   7160:                 }
1.275     raeburn  7161:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7162:                     if ($hidepriv) {
                   7163:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7164:                             (!$nothide{$uname.':'.$udom})) {
                   7165:                             next;
                   7166:                         }
                   7167:                     }
1.503     raeburn  7168:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7169:                         $status = 'previous';
                   7170:                     } elsif ($start > $now) {
                   7171:                         $status = 'future';
                   7172:                     } else {
                   7173:                         $status = 'active';
                   7174:                     }
1.277     albertel 7175:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7176:                         if ($status eq $type) {
1.420     albertel 7177:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7178:                                 push(@{$$users{$role}{$user}},$type);
                   7179:                             }
1.288     raeburn  7180:                             $match = 1;
                   7181:                         }
                   7182:                     }
1.419     raeburn  7183:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7184:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7185: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7186:                         }
1.420     albertel 7187:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7188:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7189:                         }
1.609     raeburn  7190:                         if (ref($statushash) eq 'HASH') {
                   7191:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7192:                         }
1.275     raeburn  7193:                     }
                   7194:                 }
                   7195:             }
                   7196:         }
1.290     albertel 7197:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7198:             if ((defined($cdom)) && (defined($cnum))) {
                   7199:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7200:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7201:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7202:                     next if ($owner eq '');
                   7203:                     my ($ownername,$ownerdom);
                   7204:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7205:                         $ownername = $1;
                   7206:                         $ownerdom = $2;
                   7207:                     } else {
                   7208:                         $ownername = $owner;
                   7209:                         $ownerdom = $cdom;
                   7210:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7211:                     }
                   7212:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7213:                     if (defined($userdata) && 
1.609     raeburn  7214: 			!exists($$userdata{$owner})) {
                   7215: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7216:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7217:                             push(@{$seclists{$owner}},'none');
                   7218:                         }
                   7219:                         if (ref($statushash) eq 'HASH') {
                   7220:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7221:                         }
1.290     albertel 7222: 		    }
1.279     raeburn  7223:                 }
                   7224:             }
                   7225:         }
1.419     raeburn  7226:         foreach my $user (keys(%seclists)) {
                   7227:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7228:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7229:         }
1.275     raeburn  7230:     }
                   7231:     return;
                   7232: }
                   7233: 
1.288     raeburn  7234: sub get_user_info {
                   7235:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7236:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7237: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7238:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7239:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7240:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7241:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7242:     return;
                   7243: }
1.275     raeburn  7244: 
1.472     raeburn  7245: ###############################################
                   7246: 
                   7247: =pod
                   7248: 
                   7249: =item * &get_user_quota()
                   7250: 
                   7251: Retrieves quota assigned for storage of portfolio files for a user  
                   7252: 
                   7253: Incoming parameters:
                   7254: 1. user's username
                   7255: 2. user's domain
                   7256: 
                   7257: Returns:
1.536     raeburn  7258: 1. Disk quota (in Mb) assigned to student.
                   7259: 2. (Optional) Type of setting: custom or default
                   7260:    (individually assigned or default for user's 
                   7261:    institutional status).
                   7262: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7263:    or student - types as defined in localenroll::inst_usertypes 
                   7264:    for user's domain, which determines default quota for user.
                   7265: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7266: 
                   7267: If a value has been stored in the user's environment, 
1.536     raeburn  7268: it will return that, otherwise it returns the maximal default
                   7269: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7270: 
                   7271: =cut
                   7272: 
                   7273: ###############################################
                   7274: 
                   7275: 
                   7276: sub get_user_quota {
                   7277:     my ($uname,$udom) = @_;
1.536     raeburn  7278:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7279:     if (!defined($udom)) {
                   7280:         $udom = $env{'user.domain'};
                   7281:     }
                   7282:     if (!defined($uname)) {
                   7283:         $uname = $env{'user.name'};
                   7284:     }
                   7285:     if (($udom eq '' || $uname eq '') ||
                   7286:         ($udom eq 'public') && ($uname eq 'public')) {
                   7287:         $quota = 0;
1.536     raeburn  7288:         $quotatype = 'default';
                   7289:         $defquota = 0; 
1.472     raeburn  7290:     } else {
1.536     raeburn  7291:         my $inststatus;
1.472     raeburn  7292:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7293:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7294:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7295:         } else {
1.536     raeburn  7296:             my %userenv = 
                   7297:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7298:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7299:             my ($tmp) = keys(%userenv);
                   7300:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7301:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7302:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7303:             } else {
                   7304:                 undef(%userenv);
                   7305:             }
                   7306:         }
1.536     raeburn  7307:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7308:         if ($quota eq '') {
1.536     raeburn  7309:             $quota = $defquota;
                   7310:             $quotatype = 'default';
                   7311:         } else {
                   7312:             $quotatype = 'custom';
1.472     raeburn  7313:         }
                   7314:     }
1.536     raeburn  7315:     if (wantarray) {
                   7316:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7317:     } else {
                   7318:         return $quota;
                   7319:     }
1.472     raeburn  7320: }
                   7321: 
                   7322: ###############################################
                   7323: 
                   7324: =pod
                   7325: 
                   7326: =item * &default_quota()
                   7327: 
1.536     raeburn  7328: Retrieves default quota assigned for storage of user portfolio files,
                   7329: given an (optional) user's institutional status.
1.472     raeburn  7330: 
                   7331: Incoming parameters:
                   7332: 1. domain
1.536     raeburn  7333: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7334:    status types (e.g., faculty, staff, student etc.)
                   7335:    which apply to the user for whom the default is being retrieved.
                   7336:    If the institutional status string in undefined, the domain
                   7337:    default quota will be returned. 
1.472     raeburn  7338: 
                   7339: Returns:
                   7340: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7341: 2. (Optional) institutional type which determined the value of the
                   7342:    default quota.
1.472     raeburn  7343: 
                   7344: If a value has been stored in the domain's configuration db,
                   7345: it will return that, otherwise it returns 20 (for backwards 
                   7346: compatibility with domains which have not set up a configuration
                   7347: db file; the original statically defined portfolio quota was 20 Mb). 
                   7348: 
1.536     raeburn  7349: If the user's status includes multiple types (e.g., staff and student),
                   7350: the largest default quota which applies to the user determines the
                   7351: default quota returned.
                   7352: 
1.780     raeburn  7353: =back
                   7354: 
1.472     raeburn  7355: =cut
                   7356: 
                   7357: ###############################################
                   7358: 
                   7359: 
                   7360: sub default_quota {
1.536     raeburn  7361:     my ($udom,$inststatus) = @_;
                   7362:     my ($defquota,$settingstatus);
                   7363:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7364:                                             ['quotas'],$udom);
                   7365:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7366:         if ($inststatus ne '') {
1.765     raeburn  7367:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7368:             foreach my $item (@statuses) {
1.711     raeburn  7369:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7370:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7371:                         if ($defquota eq '') {
                   7372:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7373:                             $settingstatus = $item;
                   7374:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7375:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7376:                             $settingstatus = $item;
                   7377:                         }
                   7378:                     }
                   7379:                 } else {
                   7380:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7381:                         if ($defquota eq '') {
                   7382:                             $defquota = $quotahash{'quotas'}{$item};
                   7383:                             $settingstatus = $item;
                   7384:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7385:                             $defquota = $quotahash{'quotas'}{$item};
                   7386:                             $settingstatus = $item;
                   7387:                         }
1.536     raeburn  7388:                     }
                   7389:                 }
                   7390:             }
                   7391:         }
                   7392:         if ($defquota eq '') {
1.711     raeburn  7393:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7394:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7395:             } else {
                   7396:                 $defquota = $quotahash{'quotas'}{'default'};
                   7397:             }
1.536     raeburn  7398:             $settingstatus = 'default';
                   7399:         }
                   7400:     } else {
                   7401:         $settingstatus = 'default';
                   7402:         $defquota = 20;
                   7403:     }
                   7404:     if (wantarray) {
                   7405:         return ($defquota,$settingstatus);
1.472     raeburn  7406:     } else {
1.536     raeburn  7407:         return $defquota;
1.472     raeburn  7408:     }
                   7409: }
                   7410: 
1.384     raeburn  7411: sub get_secgrprole_info {
                   7412:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7413:     my %sections_count = &get_sections($cdom,$cnum);
                   7414:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7415:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7416:     my @groups = sort(keys(%curr_groups));
                   7417:     my $allroles = [];
                   7418:     my $rolehash;
                   7419:     my $accesshash = {
                   7420:                      active => 'Currently has access',
                   7421:                      future => 'Will have future access',
                   7422:                      previous => 'Previously had access',
                   7423:                   };
                   7424:     if ($needroles) {
                   7425:         $rolehash = {'all' => 'all'};
1.385     albertel 7426:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7427: 	if (&Apache::lonnet::error(%user_roles)) {
                   7428: 	    undef(%user_roles);
                   7429: 	}
                   7430:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7431:             my ($role)=split(/\:/,$item,2);
                   7432:             if ($role eq 'cr') { next; }
                   7433:             if ($role =~ /^cr/) {
                   7434:                 $$rolehash{$role} = (split('/',$role))[3];
                   7435:             } else {
                   7436:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7437:             }
                   7438:         }
                   7439:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7440:             push(@{$allroles},$key);
                   7441:         }
                   7442:         push (@{$allroles},'st');
                   7443:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7444:     }
                   7445:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7446: }
                   7447: 
1.555     raeburn  7448: sub user_picker {
1.627     raeburn  7449:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7450:     my $currdom = $dom;
                   7451:     my %curr_selected = (
                   7452:                         srchin => 'dom',
1.580     raeburn  7453:                         srchby => 'lastname',
1.555     raeburn  7454:                       );
                   7455:     my $srchterm;
1.625     raeburn  7456:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7457:         if ($srch->{'srchby'} ne '') {
                   7458:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7459:         }
                   7460:         if ($srch->{'srchin'} ne '') {
                   7461:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7462:         }
                   7463:         if ($srch->{'srchtype'} ne '') {
                   7464:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7465:         }
                   7466:         if ($srch->{'srchdomain'} ne '') {
                   7467:             $currdom = $srch->{'srchdomain'};
                   7468:         }
                   7469:         $srchterm = $srch->{'srchterm'};
                   7470:     }
                   7471:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7472:                     'usr'       => 'Search criteria',
1.563     raeburn  7473:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7474:                     'uname'     => 'username',
                   7475:                     'lastname'  => 'last name',
1.555     raeburn  7476:                     'lastfirst' => 'last name, first name',
1.558     albertel 7477:                     'crs'       => 'in this course',
1.576     raeburn  7478:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7479:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7480:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7481:                     'exact'     => 'is',
                   7482:                     'contains'  => 'contains',
1.569     raeburn  7483:                     'begins'    => 'begins with',
1.571     raeburn  7484:                     'youm'      => "You must include some text to search for.",
                   7485:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7486:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7487:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7488:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7489:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7490:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7491:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7492:                                        );
1.563     raeburn  7493:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   7494:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  7495: 
                   7496:     my @srchins = ('crs','dom','alc','instd');
                   7497: 
                   7498:     foreach my $option (@srchins) {
                   7499:         # FIXME 'alc' option unavailable until 
                   7500:         #       loncreateuser::print_user_query_page()
                   7501:         #       has been completed.
                   7502:         next if ($option eq 'alc');
                   7503:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  7504:         if ($curr_selected{'srchin'} eq $option) {
                   7505:             $srchinsel .= ' 
                   7506:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7507:         } else {
                   7508:             $srchinsel .= '
                   7509:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7510:         }
1.555     raeburn  7511:     }
1.563     raeburn  7512:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7513: 
                   7514:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7515:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7516:         if ($curr_selected{'srchby'} eq $option) {
                   7517:             $srchbysel .= '
                   7518:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7519:         } else {
                   7520:             $srchbysel .= '
                   7521:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7522:          }
                   7523:     }
                   7524:     $srchbysel .= "\n  </select>\n";
                   7525: 
                   7526:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7527:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7528:         if ($curr_selected{'srchtype'} eq $option) {
                   7529:             $srchtypesel .= '
                   7530:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7531:         } else {
                   7532:             $srchtypesel .= '
                   7533:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7534:         }
                   7535:     }
                   7536:     $srchtypesel .= "\n  </select>\n";
                   7537: 
1.558     albertel 7538:     my ($newuserscript,$new_user_create);
1.556     raeburn  7539: 
                   7540:     if ($forcenewuser) {
1.576     raeburn  7541:         if (ref($srch) eq 'HASH') {
                   7542:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7543:                 if ($cancreate) {
                   7544:                     $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>';
                   7545:                 } else {
1.799     bisitz   7546:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7547:                     my %usertypetext = (
                   7548:                         official   => 'institutional',
                   7549:                         unofficial => 'non-institutional',
                   7550:                     );
1.799     bisitz   7551:                     $new_user_create = '<p class="LC_warning">'
                   7552:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   7553:                                       .' '
                   7554:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7555:                                           ,'<a href="'.$helplink.'">','</a>')
                   7556:                                       .'</p><br />';
1.627     raeburn  7557:                 }
1.576     raeburn  7558:             }
                   7559:         }
                   7560: 
1.556     raeburn  7561:         $newuserscript = <<"ENDSCRIPT";
                   7562: 
1.570     raeburn  7563: function setSearch(createnew,callingForm) {
1.556     raeburn  7564:     if (createnew == 1) {
1.570     raeburn  7565:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7566:             if (callingForm.srchby.options[i].value == 'uname') {
                   7567:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7568:             }
                   7569:         }
1.570     raeburn  7570:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7571:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7572: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7573:             }
                   7574:         }
1.570     raeburn  7575:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7576:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7577:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7578:             }
                   7579:         }
1.570     raeburn  7580:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7581:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7582:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7583:             }
                   7584:         }
                   7585:     }
                   7586: }
                   7587: ENDSCRIPT
1.558     albertel 7588: 
1.556     raeburn  7589:     }
                   7590: 
1.555     raeburn  7591:     my $output = <<"END_BLOCK";
1.556     raeburn  7592: <script type="text/javascript">
1.824     bisitz   7593: // <![CDATA[
1.570     raeburn  7594: function validateEntry(callingForm) {
1.558     albertel 7595: 
1.556     raeburn  7596:     var checkok = 1;
1.558     albertel 7597:     var srchin;
1.570     raeburn  7598:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7599: 	if ( callingForm.srchin[i].checked ) {
                   7600: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7601: 	}
                   7602:     }
                   7603: 
1.570     raeburn  7604:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7605:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7606:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7607:     var srchterm =  callingForm.srchterm.value;
                   7608:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7609:     var msg = "";
                   7610: 
                   7611:     if (srchterm == "") {
                   7612:         checkok = 0;
1.571     raeburn  7613:         msg += "$lt{'youm'}\\n";
1.556     raeburn  7614:     }
                   7615: 
1.569     raeburn  7616:     if (srchtype== 'begins') {
                   7617:         if (srchterm.length < 2) {
                   7618:             checkok = 0;
1.571     raeburn  7619:             msg += "$lt{'thte'}\\n";
1.569     raeburn  7620:         }
                   7621:     }
                   7622: 
1.556     raeburn  7623:     if (srchtype== 'contains') {
                   7624:         if (srchterm.length < 3) {
                   7625:             checkok = 0;
1.571     raeburn  7626:             msg += "$lt{'thet'}\\n";
1.556     raeburn  7627:         }
                   7628:     }
                   7629:     if (srchin == 'instd') {
                   7630:         if (srchdomain == '') {
                   7631:             checkok = 0;
1.571     raeburn  7632:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  7633:         }
                   7634:     }
                   7635:     if (srchin == 'dom') {
                   7636:         if (srchdomain == '') {
                   7637:             checkok = 0;
1.571     raeburn  7638:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  7639:         }
                   7640:     }
                   7641:     if (srchby == 'lastfirst') {
                   7642:         if (srchterm.indexOf(",") == -1) {
                   7643:             checkok = 0;
1.571     raeburn  7644:             msg += "$lt{'whus'}\\n";
1.556     raeburn  7645:         }
                   7646:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   7647:             checkok = 0;
1.571     raeburn  7648:             msg += "$lt{'whse'}\\n";
1.556     raeburn  7649:         }
                   7650:     }
                   7651:     if (checkok == 0) {
1.571     raeburn  7652:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  7653:         return;
                   7654:     }
                   7655:     if (checkok == 1) {
1.570     raeburn  7656:         callingForm.submit();
1.556     raeburn  7657:     }
                   7658: }
                   7659: 
                   7660: $newuserscript
                   7661: 
1.824     bisitz   7662: // ]]>
1.556     raeburn  7663: </script>
1.558     albertel 7664: 
                   7665: $new_user_create
                   7666: 
1.555     raeburn  7667: <table>
1.558     albertel 7668:  <tr>
1.573     raeburn  7669:   <td>$lt{'doma'}:</td>
                   7670:   <td>$domform</td>
                   7671:   </td>
                   7672:  </tr>
                   7673:  <tr>
                   7674:   <td>$lt{'usr'}:</td>
1.563     raeburn  7675:   <td>$srchbysel
                   7676:       $srchtypesel 
                   7677:       <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564     albertel 7678:       $srchinsel 
1.563     raeburn  7679:   </td>
                   7680:  </tr>
1.555     raeburn  7681: </table>
                   7682: <br />
                   7683: END_BLOCK
1.558     albertel 7684: 
1.555     raeburn  7685:     return $output;
                   7686: }
                   7687: 
1.612     raeburn  7688: sub user_rule_check {
1.615     raeburn  7689:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  7690:     my $response;
                   7691:     if (ref($usershash) eq 'HASH') {
                   7692:         foreach my $user (keys(%{$usershash})) {
                   7693:             my ($uname,$udom) = split(/:/,$user);
                   7694:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  7695:             my ($id,$newuser);
1.612     raeburn  7696:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  7697:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  7698:                 $id = $usershash->{$user}->{'id'};
                   7699:             }
                   7700:             my $inst_response;
                   7701:             if (ref($checks) eq 'HASH') {
                   7702:                 if (defined($checks->{'username'})) {
1.615     raeburn  7703:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  7704:                         &Apache::lonnet::get_instuser($udom,$uname);
                   7705:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  7706:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  7707:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   7708:                 }
1.615     raeburn  7709:             } else {
                   7710:                 ($inst_response,%{$inst_results->{$user}}) =
                   7711:                     &Apache::lonnet::get_instuser($udom,$uname);
                   7712:                 return;
1.612     raeburn  7713:             }
1.615     raeburn  7714:             if (!$got_rules->{$udom}) {
1.612     raeburn  7715:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   7716:                                                   ['usercreation'],$udom);
                   7717:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  7718:                     foreach my $item ('username','id') {
1.612     raeburn  7719:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   7720:                             $$curr_rules{$udom}{$item} = 
                   7721:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  7722:                         }
                   7723:                     }
                   7724:                 }
1.615     raeburn  7725:                 $got_rules->{$udom} = 1;  
1.585     raeburn  7726:             }
1.612     raeburn  7727:             foreach my $item (keys(%{$checks})) {
                   7728:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   7729:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   7730:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   7731:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   7732:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   7733:                                 if ($rule_check{$rule}) {
                   7734:                                     $$rulematch{$user}{$item} = $rule;
                   7735:                                     if ($inst_response eq 'ok') {
1.615     raeburn  7736:                                         if (ref($inst_results) eq 'HASH') {
                   7737:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   7738:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   7739:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   7740:                                                 }
1.612     raeburn  7741:                                             }
                   7742:                                         }
1.615     raeburn  7743:                                     }
                   7744:                                     last;
1.585     raeburn  7745:                                 }
                   7746:                             }
                   7747:                         }
                   7748:                     }
                   7749:                 }
                   7750:             }
                   7751:         }
                   7752:     }
1.612     raeburn  7753:     return;
                   7754: }
                   7755: 
                   7756: sub user_rule_formats {
                   7757:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   7758:     my %text = ( 
                   7759:                  'username' => 'Usernames',
                   7760:                  'id'       => 'IDs',
                   7761:                );
                   7762:     my $output;
                   7763:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   7764:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   7765:         if (@{$ruleorder} > 0) {
                   7766:             $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>';
                   7767:             foreach my $rule (@{$ruleorder}) {
                   7768:                 if (ref($curr_rules) eq 'ARRAY') {
                   7769:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   7770:                         if (ref($rules->{$rule}) eq 'HASH') {
                   7771:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   7772:                                         $rules->{$rule}{'desc'}.'</li>';
                   7773:                         }
                   7774:                     }
                   7775:                 }
                   7776:             }
                   7777:             $output .= '</ul>';
                   7778:         }
                   7779:     }
                   7780:     return $output;
                   7781: }
                   7782: 
                   7783: sub instrule_disallow_msg {
1.615     raeburn  7784:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  7785:     my $response;
                   7786:     my %text = (
                   7787:                   item   => 'username',
                   7788:                   items  => 'usernames',
                   7789:                   match  => 'matches',
                   7790:                   do     => 'does',
                   7791:                   action => 'a username',
                   7792:                   one    => 'one',
                   7793:                );
                   7794:     if ($count > 1) {
                   7795:         $text{'item'} = 'usernames';
                   7796:         $text{'match'} ='match';
                   7797:         $text{'do'} = 'do';
                   7798:         $text{'action'} = 'usernames',
                   7799:         $text{'one'} = 'ones';
                   7800:     }
                   7801:     if ($checkitem eq 'id') {
                   7802:         $text{'items'} = 'IDs';
                   7803:         $text{'item'} = 'ID';
                   7804:         $text{'action'} = 'an ID';
1.615     raeburn  7805:         if ($count > 1) {
                   7806:             $text{'item'} = 'IDs';
                   7807:             $text{'action'} = 'IDs';
                   7808:         }
1.612     raeburn  7809:     }
1.674     bisitz   7810:     $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  7811:     if ($mode eq 'upload') {
                   7812:         if ($checkitem eq 'username') {
                   7813:             $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'}.");
                   7814:         } elsif ($checkitem eq 'id') {
1.674     bisitz   7815:             $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  7816:         }
1.669     raeburn  7817:     } elsif ($mode eq 'selfcreate') {
                   7818:         if ($checkitem eq 'id') {
                   7819:             $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.");
                   7820:         }
1.615     raeburn  7821:     } else {
                   7822:         if ($checkitem eq 'username') {
                   7823:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   7824:         } elsif ($checkitem eq 'id') {
                   7825:             $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.");
                   7826:         }
1.612     raeburn  7827:     }
                   7828:     return $response;
1.585     raeburn  7829: }
                   7830: 
1.624     raeburn  7831: sub personal_data_fieldtitles {
                   7832:     my %fieldtitles = &Apache::lonlocal::texthash (
                   7833:                         id => 'Student/Employee ID',
                   7834:                         permanentemail => 'E-mail address',
                   7835:                         lastname => 'Last Name',
                   7836:                         firstname => 'First Name',
                   7837:                         middlename => 'Middle Name',
                   7838:                         generation => 'Generation',
                   7839:                         gen => 'Generation',
1.765     raeburn  7840:                         inststatus => 'Affiliation',
1.624     raeburn  7841:                    );
                   7842:     return %fieldtitles;
                   7843: }
                   7844: 
1.642     raeburn  7845: sub sorted_inst_types {
                   7846:     my ($dom) = @_;
                   7847:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   7848:     my $othertitle = &mt('All users');
                   7849:     if ($env{'request.course.id'}) {
1.668     raeburn  7850:         $othertitle  = &mt('Any users');
1.642     raeburn  7851:     }
                   7852:     my @types;
                   7853:     if (ref($order) eq 'ARRAY') {
                   7854:         @types = @{$order};
                   7855:     }
                   7856:     if (@types == 0) {
                   7857:         if (ref($usertypes) eq 'HASH') {
                   7858:             @types = sort(keys(%{$usertypes}));
                   7859:         }
                   7860:     }
                   7861:     if (keys(%{$usertypes}) > 0) {
                   7862:         $othertitle = &mt('Other users');
                   7863:     }
                   7864:     return ($othertitle,$usertypes,\@types);
                   7865: }
                   7866: 
1.645     raeburn  7867: sub get_institutional_codes {
                   7868:     my ($settings,$allcourses,$LC_code) = @_;
                   7869: # Get complete list of course sections to update
                   7870:     my @currsections = ();
                   7871:     my @currxlists = ();
                   7872:     my $coursecode = $$settings{'internal.coursecode'};
                   7873: 
                   7874:     if ($$settings{'internal.sectionnums'} ne '') {
                   7875:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   7876:     }
                   7877: 
                   7878:     if ($$settings{'internal.crosslistings'} ne '') {
                   7879:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   7880:     }
                   7881: 
                   7882:     if (@currxlists > 0) {
                   7883:         foreach (@currxlists) {
                   7884:             if (m/^([^:]+):(\w*)$/) {
                   7885:                 unless (grep/^$1$/,@{$allcourses}) {
                   7886:                     push @{$allcourses},$1;
                   7887:                     $$LC_code{$1} = $2;
                   7888:                 }
                   7889:             }
                   7890:         }
                   7891:     }
                   7892:  
                   7893:     if (@currsections > 0) {
                   7894:         foreach (@currsections) {
                   7895:             if (m/^(\w+):(\w*)$/) {
                   7896:                 my $sec = $coursecode.$1;
                   7897:                 my $lc_sec = $2;
                   7898:                 unless (grep/^$sec$/,@{$allcourses}) {
                   7899:                     push @{$allcourses},$sec;
                   7900:                     $$LC_code{$sec} = $lc_sec;
                   7901:                 }
                   7902:             }
                   7903:         }
                   7904:     }
                   7905:     return;
                   7906: }
                   7907: 
1.112     bowersj2 7908: =pod
                   7909: 
1.780     raeburn  7910: =head1 Slot Helpers
                   7911: 
                   7912: =over 4
                   7913: 
                   7914: =item * sorted_slots()
                   7915: 
                   7916: Sorts an array of slot names in order of slot start time (earliest first). 
                   7917: 
                   7918: Inputs:
                   7919: 
                   7920: =over 4
                   7921: 
                   7922: slotsarr  - Reference to array of unsorted slot names.
                   7923: 
                   7924: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   7925: 
1.549     albertel 7926: =back
                   7927: 
1.780     raeburn  7928: Returns:
                   7929: 
                   7930: =over 4
                   7931: 
                   7932: sorted   - An array of slot names sorted by the start time of the slot.
                   7933: 
                   7934: =back
                   7935: 
                   7936: =back
                   7937: 
                   7938: =cut
                   7939: 
                   7940: 
                   7941: sub sorted_slots {
                   7942:     my ($slotsarr,$slots) = @_;
                   7943:     my @sorted;
                   7944:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   7945:         @sorted =
                   7946:             sort {
                   7947:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   7948:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   7949:                      }
                   7950:                      if (ref($slots->{$a})) { return -1;}
                   7951:                      if (ref($slots->{$b})) { return 1;}
                   7952:                      return 0;
                   7953:                  } @{$slotsarr};
                   7954:     }
                   7955:     return @sorted;
                   7956: }
                   7957: 
                   7958: 
                   7959: =pod
                   7960: 
1.549     albertel 7961: =head1 HTTP Helpers
                   7962: 
                   7963: =over 4
                   7964: 
1.648     raeburn  7965: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 7966: 
1.258     albertel 7967: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 7968: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 7969: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 7970: 
                   7971: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   7972: $possible_names is an ref to an array of form element names.  As an example:
                   7973: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 7974: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 7975: 
                   7976: =cut
1.1       albertel 7977: 
1.6       albertel 7978: sub get_unprocessed_cgi {
1.25      albertel 7979:   my ($query,$possible_names)= @_;
1.26      matthew  7980:   # $Apache::lonxml::debug=1;
1.356     albertel 7981:   foreach my $pair (split(/&/,$query)) {
                   7982:     my ($name, $value) = split(/=/,$pair);
1.369     www      7983:     $name = &unescape($name);
1.25      albertel 7984:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   7985:       $value =~ tr/+/ /;
                   7986:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 7987:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 7988:     }
1.16      harris41 7989:   }
1.6       albertel 7990: }
                   7991: 
1.112     bowersj2 7992: =pod
                   7993: 
1.648     raeburn  7994: =item * &cacheheader() 
1.112     bowersj2 7995: 
                   7996: returns cache-controlling header code
                   7997: 
                   7998: =cut
                   7999: 
1.7       albertel 8000: sub cacheheader {
1.258     albertel 8001:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8002:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8003:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8004:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8005:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8006:     return $output;
1.7       albertel 8007: }
                   8008: 
1.112     bowersj2 8009: =pod
                   8010: 
1.648     raeburn  8011: =item * &no_cache($r) 
1.112     bowersj2 8012: 
                   8013: specifies header code to not have cache
                   8014: 
                   8015: =cut
                   8016: 
1.9       albertel 8017: sub no_cache {
1.216     albertel 8018:     my ($r) = @_;
                   8019:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8020: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8021:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8022:     $r->no_cache(1);
                   8023:     $r->header_out("Expires" => $date);
                   8024:     $r->header_out("Pragma" => "no-cache");
1.123     www      8025: }
                   8026: 
                   8027: sub content_type {
1.181     albertel 8028:     my ($r,$type,$charset) = @_;
1.299     foxr     8029:     if ($r) {
                   8030: 	#  Note that printout.pl calls this with undef for $r.
                   8031: 	&no_cache($r);
                   8032:     }
1.258     albertel 8033:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8034:     unless ($charset) {
                   8035: 	$charset=&Apache::lonlocal::current_encoding;
                   8036:     }
                   8037:     if ($charset) { $type.='; charset='.$charset; }
                   8038:     if ($r) {
                   8039: 	$r->content_type($type);
                   8040:     } else {
                   8041: 	print("Content-type: $type\n\n");
                   8042:     }
1.9       albertel 8043: }
1.25      albertel 8044: 
1.112     bowersj2 8045: =pod
                   8046: 
1.648     raeburn  8047: =item * &add_to_env($name,$value) 
1.112     bowersj2 8048: 
1.258     albertel 8049: adds $name to the %env hash with value
1.112     bowersj2 8050: $value, if $name already exists, the entry is converted to an array
                   8051: reference and $value is added to the array.
                   8052: 
                   8053: =cut
                   8054: 
1.25      albertel 8055: sub add_to_env {
                   8056:   my ($name,$value)=@_;
1.258     albertel 8057:   if (defined($env{$name})) {
                   8058:     if (ref($env{$name})) {
1.25      albertel 8059:       #already have multiple values
1.258     albertel 8060:       push(@{ $env{$name} },$value);
1.25      albertel 8061:     } else {
                   8062:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8063:       my $first=$env{$name};
                   8064:       undef($env{$name});
                   8065:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8066:     }
                   8067:   } else {
1.258     albertel 8068:     $env{$name}=$value;
1.25      albertel 8069:   }
1.31      albertel 8070: }
1.149     albertel 8071: 
                   8072: =pod
                   8073: 
1.648     raeburn  8074: =item * &get_env_multiple($name) 
1.149     albertel 8075: 
1.258     albertel 8076: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8077: values may be defined and end up as an array ref.
                   8078: 
                   8079: returns an array of values
                   8080: 
                   8081: =cut
                   8082: 
                   8083: sub get_env_multiple {
                   8084:     my ($name) = @_;
                   8085:     my @values;
1.258     albertel 8086:     if (defined($env{$name})) {
1.149     albertel 8087:         # exists is it an array
1.258     albertel 8088:         if (ref($env{$name})) {
                   8089:             @values=@{ $env{$name} };
1.149     albertel 8090:         } else {
1.258     albertel 8091:             $values[0]=$env{$name};
1.149     albertel 8092:         }
                   8093:     }
                   8094:     return(@values);
                   8095: }
                   8096: 
1.660     raeburn  8097: sub ask_for_embedded_content {
                   8098:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8099:     my $upload_output = '
                   8100:    <form name="upload_embedded" action="'.$actionurl.'"
                   8101:                   method="post" enctype="multipart/form-data">';
                   8102:     $upload_output .= $state;
1.661     raeburn  8103:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8104: 
                   8105:     my $num = 0;
                   8106:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8107:         $upload_output .= &start_data_table_row().
                   8108:             '<td>'.$embed_file.'</td><td>';
                   8109:         if ($args->{'ignore_remote_references'}
                   8110:             && $embed_file =~ m{^\w+://}) {
                   8111:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8112:         } elsif ($args->{'error_on_invalid_names'}
                   8113:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8114: 
                   8115:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8116: 
                   8117:         } else {
                   8118:             $upload_output .='
1.661     raeburn  8119:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8120:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8121:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8122:             $upload_output .=
                   8123:                 "\n\t\t".
                   8124:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8125:                 $attrib.'" />';
                   8126:             if (exists($$codebase{$embed_file})) {
                   8127:                 $upload_output .=
                   8128:                     "\n\t\t".
                   8129:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8130:                     &escape($$codebase{$embed_file}).'" />';
                   8131:             }
                   8132:         }
                   8133:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8134:         $num++;
                   8135:     }
                   8136:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8137:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8138:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8139:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8140:    </form>';
                   8141:     return $upload_output;
                   8142: }
                   8143: 
1.661     raeburn  8144: sub upload_embedded {
                   8145:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8146:         $current_disk_usage) = @_;
                   8147:     my $output;
                   8148:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8149:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8150:         my $orig_uploaded_filename =
                   8151:             $env{'form.embedded_item_'.$i.'.filename'};
                   8152: 
                   8153:         $env{'form.embedded_orig_'.$i} =
                   8154:             &unescape($env{'form.embedded_orig_'.$i});
                   8155:         my ($path,$fname) =
                   8156:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8157:         # no path, whole string is fname
                   8158:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8159: 
                   8160:         $path = $env{'form.currentpath'}.$path;
                   8161:         $fname = &Apache::lonnet::clean_filename($fname);
                   8162:         # See if there is anything left
                   8163:         next if ($fname eq '');
                   8164: 
                   8165:         # Check if file already exists as a file or directory.
                   8166:         my ($state,$msg);
                   8167:         if ($context eq 'portfolio') {
                   8168:             my $port_path = $dirpath;
                   8169:             if ($group ne '') {
                   8170:                 $port_path = "groups/$group/$port_path";
                   8171:             }
                   8172:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8173:                                               $dir_root,$port_path,$disk_quota,
                   8174:                                               $current_disk_usage,$uname,$udom);
                   8175:             if ($state eq 'will_exceed_quota'
                   8176:                 || $state eq 'file_locked'
                   8177:                 || $state eq 'file_exists' ) {
                   8178:                 $output .= $msg;
                   8179:                 next;
                   8180:             }
                   8181:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8182:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8183:             if ($state eq 'exists') {
                   8184:                 $output .= $msg;
                   8185:                 next;
                   8186:             }
                   8187:         }
                   8188:         # Check if extension is valid
                   8189:         if (($fname =~ /\.(\w+)$/) &&
                   8190:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8191:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8192:             next;
                   8193:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8194:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8195:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8196:             next;
                   8197:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8198:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8199:             next;
                   8200:         }
                   8201: 
                   8202:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8203:         if ($context eq 'portfolio') {
                   8204:             my $result=
                   8205:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8206:                                                 $dirpath.$path);
                   8207:             if ($result !~ m|^/uploaded/|) {
                   8208:                 $output .= '<span class="LC_error">'
                   8209:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8210:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8211:                       .'</span><br />';
                   8212:                 next;
                   8213:             } else {
                   8214:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8215:                            $path.$fname.'</span>').'</p>';     
                   8216:             }
                   8217:         } else {
                   8218: # Save the file
                   8219:             my $target = $env{'form.embedded_item_'.$i};
                   8220:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8221:             my $dest = $fullpath.$fname;
                   8222:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8223:             my @parts=split(/\//,$fullpath);
                   8224:             my $count;
                   8225:             my $filepath = $dir_root;
                   8226:             for ($count=4;$count<=$#parts;$count++) {
                   8227:                 $filepath .= "/$parts[$count]";
                   8228:                 if ((-e $filepath)!=1) {
                   8229:                     mkdir($filepath,0770);
                   8230:                 }
                   8231:             }
                   8232:             my $fh;
                   8233:             if (!open($fh,'>'.$dest)) {
                   8234:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8235:                 $output .= '<span class="LC_error">'.
                   8236:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8237:                            '</span><br />';
                   8238:             } else {
                   8239:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8240:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8241:                     $output .= '<span class="LC_error">'.
                   8242:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8243:                               '</span><br />';
                   8244:                 } else {
                   8245:                     if ($context eq 'testbank') {
                   8246:                         $output .= &mt('Embedded file uploaded successfully:').
                   8247:                                    '&nbsp;<a href="'.$url.'">'.
                   8248:                                    $orig_uploaded_filename.'</a><br />';
                   8249:                     } else {
1.705     tempelho 8250:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8251:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8252:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8253:                     }
                   8254:                 }
                   8255:                 close($fh);
                   8256:             }
                   8257:         }
                   8258:     }
                   8259:     return $output;
                   8260: }
                   8261: 
                   8262: sub check_for_existing {
                   8263:     my ($path,$fname,$element) = @_;
                   8264:     my ($state,$msg);
                   8265:     if (-d $path.'/'.$fname) {
                   8266:         $state = 'exists';
                   8267:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8268:     } elsif (-e $path.'/'.$fname) {
                   8269:         $state = 'exists';
                   8270:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8271:     }
                   8272:     if ($state eq 'exists') {
                   8273:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8274:     }
                   8275:     return ($state,$msg);
                   8276: }
                   8277: 
                   8278: sub check_for_upload {
                   8279:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8280:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8281:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8282:     my $getpropath = 1;
                   8283:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8284:                                             $getpropath);
                   8285:     my $found_file = 0;
                   8286:     my $locked_file = 0;
                   8287:     foreach my $line (@dir_list) {
                   8288:         my ($file_name)=split(/\&/,$line,2);
                   8289:         if ($file_name eq $fname){
                   8290:             $file_name = $path.$file_name;
                   8291:             if ($group ne '') {
                   8292:                 $file_name = $group.$file_name;
                   8293:             }
                   8294:             $found_file = 1;
                   8295:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8296:                 $locked_file = 1;
                   8297:             }
                   8298:         }
                   8299:     }
                   8300:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8301:         my $msg = '<span class="LC_error">'.
                   8302:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8303:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8304:         return ('will_exceed_quota',$msg);
                   8305:     } elsif ($found_file) {
                   8306:         if ($locked_file) {
                   8307:             my $msg = '<span class="LC_error">';
                   8308:             $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>');
                   8309:             $msg .= '</span><br />';
                   8310:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8311:             return ('file_locked',$msg);
                   8312:         } else {
                   8313:             my $msg = '<span class="LC_error">';
                   8314:             $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'});
                   8315:             $msg .= '</span>';
                   8316:             $msg .= '<br />';
                   8317:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8318:             return ('file_exists',$msg);
                   8319:         }
                   8320:     }
                   8321: }
                   8322: 
1.31      albertel 8323: 
1.41      ng       8324: =pod
1.45      matthew  8325: 
1.464     albertel 8326: =back
1.41      ng       8327: 
1.112     bowersj2 8328: =head1 CSV Upload/Handling functions
1.38      albertel 8329: 
1.41      ng       8330: =over 4
                   8331: 
1.648     raeburn  8332: =item * &upfile_store($r)
1.41      ng       8333: 
                   8334: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8335: needs $env{'form.upfile'}
1.41      ng       8336: returns $datatoken to be put into hidden field
                   8337: 
                   8338: =cut
1.31      albertel 8339: 
                   8340: sub upfile_store {
                   8341:     my $r=shift;
1.258     albertel 8342:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8343:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8344:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8345:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8346: 
1.258     albertel 8347:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8348: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8349:     {
1.158     raeburn  8350:         my $datafile = $r->dir_config('lonDaemons').
                   8351:                            '/tmp/'.$datatoken.'.tmp';
                   8352:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8353:             print $fh $env{'form.upfile'};
1.158     raeburn  8354:             close($fh);
                   8355:         }
1.31      albertel 8356:     }
                   8357:     return $datatoken;
                   8358: }
                   8359: 
1.56      matthew  8360: =pod
                   8361: 
1.648     raeburn  8362: =item * &load_tmp_file($r)
1.41      ng       8363: 
                   8364: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8365: needs $env{'form.datatoken'},
                   8366: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8367: 
                   8368: =cut
1.31      albertel 8369: 
                   8370: sub load_tmp_file {
                   8371:     my $r=shift;
                   8372:     my @studentdata=();
                   8373:     {
1.158     raeburn  8374:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8375:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8376:         if ( open(my $fh,"<$studentfile") ) {
                   8377:             @studentdata=<$fh>;
                   8378:             close($fh);
                   8379:         }
1.31      albertel 8380:     }
1.258     albertel 8381:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8382: }
                   8383: 
1.56      matthew  8384: =pod
                   8385: 
1.648     raeburn  8386: =item * &upfile_record_sep()
1.41      ng       8387: 
                   8388: Separate uploaded file into records
                   8389: returns array of records,
1.258     albertel 8390: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8391: 
                   8392: =cut
1.31      albertel 8393: 
                   8394: sub upfile_record_sep {
1.258     albertel 8395:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8396:     } else {
1.248     albertel 8397: 	my @records;
1.258     albertel 8398: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8399: 	    if ($line=~/^\s*$/) { next; }
                   8400: 	    push(@records,$line);
                   8401: 	}
                   8402: 	return @records;
1.31      albertel 8403:     }
                   8404: }
                   8405: 
1.56      matthew  8406: =pod
                   8407: 
1.648     raeburn  8408: =item * &record_sep($record)
1.41      ng       8409: 
1.258     albertel 8410: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8411: 
                   8412: =cut
                   8413: 
1.263     www      8414: sub takeleft {
                   8415:     my $index=shift;
                   8416:     return substr('0000'.$index,-4,4);
                   8417: }
                   8418: 
1.31      albertel 8419: sub record_sep {
                   8420:     my $record=shift;
                   8421:     my %components=();
1.258     albertel 8422:     if ($env{'form.upfiletype'} eq 'xml') {
                   8423:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8424:         my $i=0;
1.356     albertel 8425:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8426:             $field=~s/^(\"|\')//;
                   8427:             $field=~s/(\"|\')$//;
1.263     www      8428:             $components{&takeleft($i)}=$field;
1.31      albertel 8429:             $i++;
                   8430:         }
1.258     albertel 8431:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8432:         my $i=0;
1.356     albertel 8433:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8434:             $field=~s/^(\"|\')//;
                   8435:             $field=~s/(\"|\')$//;
1.263     www      8436:             $components{&takeleft($i)}=$field;
1.31      albertel 8437:             $i++;
                   8438:         }
                   8439:     } else {
1.561     www      8440:         my $separator=',';
1.480     banghart 8441:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8442:             $separator=';';
1.480     banghart 8443:         }
1.31      albertel 8444:         my $i=0;
1.561     www      8445: # the character we are looking for to indicate the end of a quote or a record 
                   8446:         my $looking_for=$separator;
                   8447: # do not add the characters to the fields
                   8448:         my $ignore=0;
                   8449: # we just encountered a separator (or the beginning of the record)
                   8450:         my $just_found_separator=1;
                   8451: # store the field we are working on here
                   8452:         my $field='';
                   8453: # work our way through all characters in record
                   8454:         foreach my $character ($record=~/(.)/g) {
                   8455:             if ($character eq $looking_for) {
                   8456:                if ($character ne $separator) {
                   8457: # Found the end of a quote, again looking for separator
                   8458:                   $looking_for=$separator;
                   8459:                   $ignore=1;
                   8460:                } else {
                   8461: # Found a separator, store away what we got
                   8462:                   $components{&takeleft($i)}=$field;
                   8463: 	          $i++;
                   8464:                   $just_found_separator=1;
                   8465:                   $ignore=0;
                   8466:                   $field='';
                   8467:                }
                   8468:                next;
                   8469:             }
                   8470: # single or double quotation marks after a separator indicate beginning of a quote
                   8471: # we are now looking for the end of the quote and need to ignore separators
                   8472:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8473:                $looking_for=$character;
                   8474:                next;
                   8475:             }
                   8476: # ignore would be true after we reached the end of a quote
                   8477:             if ($ignore) { next; }
                   8478:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8479:             $field.=$character;
                   8480:             $just_found_separator=0; 
1.31      albertel 8481:         }
1.561     www      8482: # catch the very last entry, since we never encountered the separator
                   8483:         $components{&takeleft($i)}=$field;
1.31      albertel 8484:     }
                   8485:     return %components;
                   8486: }
                   8487: 
1.144     matthew  8488: ######################################################
                   8489: ######################################################
                   8490: 
1.56      matthew  8491: =pod
                   8492: 
1.648     raeburn  8493: =item * &upfile_select_html()
1.41      ng       8494: 
1.144     matthew  8495: Return HTML code to select a file from the users machine and specify 
                   8496: the file type.
1.41      ng       8497: 
                   8498: =cut
                   8499: 
1.144     matthew  8500: ######################################################
                   8501: ######################################################
1.31      albertel 8502: sub upfile_select_html {
1.144     matthew  8503:     my %Types = (
                   8504:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8505:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8506:                  space => &mt('Space separated'),
                   8507:                  tab   => &mt('Tabulator separated'),
                   8508: #                 xml   => &mt('HTML/XML'),
                   8509:                  );
                   8510:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8511:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8512:     foreach my $type (sort(keys(%Types))) {
                   8513:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8514:     }
                   8515:     $Str .= "</select>\n";
                   8516:     return $Str;
1.31      albertel 8517: }
                   8518: 
1.301     albertel 8519: sub get_samples {
                   8520:     my ($records,$toget) = @_;
                   8521:     my @samples=({});
                   8522:     my $got=0;
                   8523:     foreach my $rec (@$records) {
                   8524: 	my %temp = &record_sep($rec);
                   8525: 	if (! grep(/\S/, values(%temp))) { next; }
                   8526: 	if (%temp) {
                   8527: 	    $samples[$got]=\%temp;
                   8528: 	    $got++;
                   8529: 	    if ($got == $toget) { last; }
                   8530: 	}
                   8531:     }
                   8532:     return \@samples;
                   8533: }
                   8534: 
1.144     matthew  8535: ######################################################
                   8536: ######################################################
                   8537: 
1.56      matthew  8538: =pod
                   8539: 
1.648     raeburn  8540: =item * &csv_print_samples($r,$records)
1.41      ng       8541: 
                   8542: Prints a table of sample values from each column uploaded $r is an
                   8543: Apache Request ref, $records is an arrayref from
                   8544: &Apache::loncommon::upfile_record_sep
                   8545: 
                   8546: =cut
                   8547: 
1.144     matthew  8548: ######################################################
                   8549: ######################################################
1.31      albertel 8550: sub csv_print_samples {
                   8551:     my ($r,$records) = @_;
1.662     bisitz   8552:     my $samples = &get_samples($records,5);
1.301     albertel 8553: 
1.594     raeburn  8554:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8555:               &start_data_table_header_row());
1.356     albertel 8556:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
                   8557:         $r->print('<th>'.&mt('Column&nbsp;[_1]',($sample+1)).'</th>'); }
1.594     raeburn  8558:     $r->print(&end_data_table_header_row());
1.301     albertel 8559:     foreach my $hash (@$samples) {
1.594     raeburn  8560: 	$r->print(&start_data_table_row());
1.356     albertel 8561: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8562: 	    $r->print('<td>');
1.356     albertel 8563: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8564: 	    $r->print('</td>');
                   8565: 	}
1.594     raeburn  8566: 	$r->print(&end_data_table_row());
1.31      albertel 8567:     }
1.594     raeburn  8568:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8569: }
                   8570: 
1.144     matthew  8571: ######################################################
                   8572: ######################################################
                   8573: 
1.56      matthew  8574: =pod
                   8575: 
1.648     raeburn  8576: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8577: 
                   8578: Prints a table to create associations between values and table columns.
1.144     matthew  8579: 
1.41      ng       8580: $r is an Apache Request ref,
                   8581: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8582: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8583: 
                   8584: =cut
                   8585: 
1.144     matthew  8586: ######################################################
                   8587: ######################################################
1.31      albertel 8588: sub csv_print_select_table {
                   8589:     my ($r,$records,$d) = @_;
1.301     albertel 8590:     my $i=0;
                   8591:     my $samples = &get_samples($records,1);
1.144     matthew  8592:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8593: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8594:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8595:               '<th>'.&mt('Column').'</th>'.
                   8596:               &end_data_table_header_row()."\n");
1.356     albertel 8597:     foreach my $array_ref (@$d) {
                   8598: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8599: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8600: 
                   8601: 	$r->print('<td><select name=f'.$i.
1.32      matthew  8602: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8603: 	$r->print('<option value="none"></option>');
1.356     albertel 8604: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8605: 	    $r->print('<option value="'.$sample.'"'.
                   8606:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8607:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8608: 	}
1.594     raeburn  8609: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8610: 	$i++;
                   8611:     }
1.594     raeburn  8612:     $r->print(&end_data_table());
1.31      albertel 8613:     $i--;
                   8614:     return $i;
                   8615: }
1.56      matthew  8616: 
1.144     matthew  8617: ######################################################
                   8618: ######################################################
                   8619: 
1.56      matthew  8620: =pod
1.31      albertel 8621: 
1.648     raeburn  8622: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       8623: 
                   8624: Prints a table of sample values from the upload and can make associate samples to internal names.
                   8625: 
                   8626: $r is an Apache Request ref,
                   8627: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   8628: $d is an array of 2 element arrays (internal name, displayed name)
                   8629: 
                   8630: =cut
                   8631: 
1.144     matthew  8632: ######################################################
                   8633: ######################################################
1.31      albertel 8634: sub csv_samples_select_table {
                   8635:     my ($r,$records,$d) = @_;
                   8636:     my $i=0;
1.144     matthew  8637:     #
1.662     bisitz   8638:     my $max_samples = 5;
                   8639:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  8640:     $r->print(&start_data_table().
                   8641:               &start_data_table_header_row().'<th>'.
                   8642:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   8643:               &end_data_table_header_row());
1.301     albertel 8644: 
                   8645:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  8646: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  8647: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 8648: 	foreach my $option (@$d) {
                   8649: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  8650: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 8651:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  8652:                       $display.'</option>');
1.31      albertel 8653: 	}
                   8654: 	$r->print('</select></td><td>');
1.662     bisitz   8655: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 8656: 	    if (defined($samples->[$line]{$key})) { 
                   8657: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   8658: 	    }
                   8659: 	}
1.594     raeburn  8660: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 8661: 	$i++;
                   8662:     }
1.594     raeburn  8663:     $r->print(&end_data_table());
1.31      albertel 8664:     $i--;
                   8665:     return($i);
1.115     matthew  8666: }
                   8667: 
1.144     matthew  8668: ######################################################
                   8669: ######################################################
                   8670: 
1.115     matthew  8671: =pod
                   8672: 
1.648     raeburn  8673: =item * &clean_excel_name($name)
1.115     matthew  8674: 
                   8675: Returns a replacement for $name which does not contain any illegal characters.
                   8676: 
                   8677: =cut
                   8678: 
1.144     matthew  8679: ######################################################
                   8680: ######################################################
1.115     matthew  8681: sub clean_excel_name {
                   8682:     my ($name) = @_;
                   8683:     $name =~ s/[:\*\?\/\\]//g;
                   8684:     if (length($name) > 31) {
                   8685:         $name = substr($name,0,31);
                   8686:     }
                   8687:     return $name;
1.25      albertel 8688: }
1.84      albertel 8689: 
1.85      albertel 8690: =pod
                   8691: 
1.648     raeburn  8692: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 8693: 
                   8694: Returns either 1 or undef
                   8695: 
                   8696: 1 if the part is to be hidden, undef if it is to be shown
                   8697: 
                   8698: Arguments are:
                   8699: 
                   8700: $id the id of the part to be checked
                   8701: $symb, optional the symb of the resource to check
                   8702: $udom, optional the domain of the user to check for
                   8703: $uname, optional the username of the user to check for
                   8704: 
                   8705: =cut
1.84      albertel 8706: 
                   8707: sub check_if_partid_hidden {
                   8708:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 8709:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 8710: 					 $symb,$udom,$uname);
1.141     albertel 8711:     my $truth=1;
                   8712:     #if the string starts with !, then the list is the list to show not hide
                   8713:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 8714:     my @hiddenlist=split(/,/,$hiddenparts);
                   8715:     foreach my $checkid (@hiddenlist) {
1.141     albertel 8716: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 8717:     }
1.141     albertel 8718:     return !$truth;
1.84      albertel 8719: }
1.127     matthew  8720: 
1.138     matthew  8721: 
                   8722: ############################################################
                   8723: ############################################################
                   8724: 
                   8725: =pod
                   8726: 
1.157     matthew  8727: =back 
                   8728: 
1.138     matthew  8729: =head1 cgi-bin script and graphing routines
                   8730: 
1.157     matthew  8731: =over 4
                   8732: 
1.648     raeburn  8733: =item * &get_cgi_id()
1.138     matthew  8734: 
                   8735: Inputs: none
                   8736: 
                   8737: Returns an id which can be used to pass environment variables
                   8738: to various cgi-bin scripts.  These environment variables will
                   8739: be removed from the users environment after a given time by
                   8740: the routine &Apache::lonnet::transfer_profile_to_env.
                   8741: 
                   8742: =cut
                   8743: 
                   8744: ############################################################
                   8745: ############################################################
1.152     albertel 8746: my $uniq=0;
1.136     matthew  8747: sub get_cgi_id {
1.154     albertel 8748:     $uniq=($uniq+1)%100000;
1.280     albertel 8749:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  8750: }
                   8751: 
1.127     matthew  8752: ############################################################
                   8753: ############################################################
                   8754: 
                   8755: =pod
                   8756: 
1.648     raeburn  8757: =item * &DrawBarGraph()
1.127     matthew  8758: 
1.138     matthew  8759: Facilitates the plotting of data in a (stacked) bar graph.
                   8760: Puts plot definition data into the users environment in order for 
                   8761: graph.png to plot it.  Returns an <img> tag for the plot.
                   8762: The bars on the plot are labeled '1','2',...,'n'.
                   8763: 
                   8764: Inputs:
                   8765: 
                   8766: =over 4
                   8767: 
                   8768: =item $Title: string, the title of the plot
                   8769: 
                   8770: =item $xlabel: string, text describing the X-axis of the plot
                   8771: 
                   8772: =item $ylabel: string, text describing the Y-axis of the plot
                   8773: 
                   8774: =item $Max: scalar, the maximum Y value to use in the plot
                   8775: If $Max is < any data point, the graph will not be rendered.
                   8776: 
1.140     matthew  8777: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  8778: they are plotted.  If undefined, default values will be used.
                   8779: 
1.178     matthew  8780: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   8781: 
1.138     matthew  8782: =item @Values: An array of array references.  Each array reference holds data
                   8783: to be plotted in a stacked bar chart.
                   8784: 
1.239     matthew  8785: =item If the final element of @Values is a hash reference the key/value
                   8786: pairs will be added to the graph definition.
                   8787: 
1.138     matthew  8788: =back
                   8789: 
                   8790: Returns:
                   8791: 
                   8792: An <img> tag which references graph.png and the appropriate identifying
                   8793: information for the plot.
                   8794: 
1.127     matthew  8795: =cut
                   8796: 
                   8797: ############################################################
                   8798: ############################################################
1.134     matthew  8799: sub DrawBarGraph {
1.178     matthew  8800:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  8801:     #
                   8802:     if (! defined($colors)) {
                   8803:         $colors = ['#33ff00', 
                   8804:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   8805:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   8806:                   ]; 
                   8807:     }
1.228     matthew  8808:     my $extra_settings = {};
                   8809:     if (ref($Values[-1]) eq 'HASH') {
                   8810:         $extra_settings = pop(@Values);
                   8811:     }
1.127     matthew  8812:     #
1.136     matthew  8813:     my $identifier = &get_cgi_id();
                   8814:     my $id = 'cgi.'.$identifier;        
1.129     matthew  8815:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  8816:         return '';
                   8817:     }
1.225     matthew  8818:     #
                   8819:     my @Labels;
                   8820:     if (defined($labels)) {
                   8821:         @Labels = @$labels;
                   8822:     } else {
                   8823:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   8824:             push (@Labels,$i+1);
                   8825:         }
                   8826:     }
                   8827:     #
1.129     matthew  8828:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  8829:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  8830:     my %ValuesHash;
                   8831:     my $NumSets=1;
                   8832:     foreach my $array (@Values) {
                   8833:         next if (! ref($array));
1.136     matthew  8834:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  8835:             join(',',@$array);
1.129     matthew  8836:     }
1.127     matthew  8837:     #
1.136     matthew  8838:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  8839:     if ($NumBars < 3) {
                   8840:         $width = 120+$NumBars*32;
1.220     matthew  8841:         $xskip = 1;
1.225     matthew  8842:         $bar_width = 30;
                   8843:     } elsif ($NumBars < 5) {
                   8844:         $width = 120+$NumBars*20;
                   8845:         $xskip = 1;
                   8846:         $bar_width = 20;
1.220     matthew  8847:     } elsif ($NumBars < 10) {
1.136     matthew  8848:         $width = 120+$NumBars*15;
                   8849:         $xskip = 1;
                   8850:         $bar_width = 15;
                   8851:     } elsif ($NumBars <= 25) {
                   8852:         $width = 120+$NumBars*11;
                   8853:         $xskip = 5;
                   8854:         $bar_width = 8;
                   8855:     } elsif ($NumBars <= 50) {
                   8856:         $width = 120+$NumBars*8;
                   8857:         $xskip = 5;
                   8858:         $bar_width = 4;
                   8859:     } else {
                   8860:         $width = 120+$NumBars*8;
                   8861:         $xskip = 5;
                   8862:         $bar_width = 4;
                   8863:     }
                   8864:     #
1.137     matthew  8865:     $Max = 1 if ($Max < 1);
                   8866:     if ( int($Max) < $Max ) {
                   8867:         $Max++;
                   8868:         $Max = int($Max);
                   8869:     }
1.127     matthew  8870:     $Title  = '' if (! defined($Title));
                   8871:     $xlabel = '' if (! defined($xlabel));
                   8872:     $ylabel = '' if (! defined($ylabel));
1.369     www      8873:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   8874:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   8875:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  8876:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  8877:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   8878:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   8879:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   8880:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8881:     $ValuesHash{$id.'.height'}   = $height;
                   8882:     $ValuesHash{$id.'.width'}    = $width;
                   8883:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   8884:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   8885:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  8886:     #
1.228     matthew  8887:     # Deal with other parameters
                   8888:     while (my ($key,$value) = each(%$extra_settings)) {
                   8889:         $ValuesHash{$id.'.'.$key} = $value;
                   8890:     }
                   8891:     #
1.646     raeburn  8892:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  8893:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   8894: }
                   8895: 
                   8896: ############################################################
                   8897: ############################################################
                   8898: 
                   8899: =pod
                   8900: 
1.648     raeburn  8901: =item * &DrawXYGraph()
1.137     matthew  8902: 
1.138     matthew  8903: Facilitates the plotting of data in an XY graph.
                   8904: Puts plot definition data into the users environment in order for 
                   8905: graph.png to plot it.  Returns an <img> tag for the plot.
                   8906: 
                   8907: Inputs:
                   8908: 
                   8909: =over 4
                   8910: 
                   8911: =item $Title: string, the title of the plot
                   8912: 
                   8913: =item $xlabel: string, text describing the X-axis of the plot
                   8914: 
                   8915: =item $ylabel: string, text describing the Y-axis of the plot
                   8916: 
                   8917: =item $Max: scalar, the maximum Y value to use in the plot
                   8918: If $Max is < any data point, the graph will not be rendered.
                   8919: 
                   8920: =item $colors: Array ref containing the hex color codes for the data to be 
                   8921: plotted in.  If undefined, default values will be used.
                   8922: 
                   8923: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   8924: 
                   8925: =item $Ydata: Array ref containing Array refs.  
1.185     www      8926: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  8927: 
                   8928: =item %Values: hash indicating or overriding any default values which are 
                   8929: passed to graph.png.  
                   8930: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   8931: 
                   8932: =back
                   8933: 
                   8934: Returns:
                   8935: 
                   8936: An <img> tag which references graph.png and the appropriate identifying
                   8937: information for the plot.
                   8938: 
1.137     matthew  8939: =cut
                   8940: 
                   8941: ############################################################
                   8942: ############################################################
                   8943: sub DrawXYGraph {
                   8944:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   8945:     #
                   8946:     # Create the identifier for the graph
                   8947:     my $identifier = &get_cgi_id();
                   8948:     my $id = 'cgi.'.$identifier;
                   8949:     #
                   8950:     $Title  = '' if (! defined($Title));
                   8951:     $xlabel = '' if (! defined($xlabel));
                   8952:     $ylabel = '' if (! defined($ylabel));
                   8953:     my %ValuesHash = 
                   8954:         (
1.369     www      8955:          $id.'.title'  => &escape($Title),
                   8956:          $id.'.xlabel' => &escape($xlabel),
                   8957:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  8958:          $id.'.y_max_value'=> $Max,
                   8959:          $id.'.labels'     => join(',',@$Xlabels),
                   8960:          $id.'.PlotType'   => 'XY',
                   8961:          );
                   8962:     #
                   8963:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   8964:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8965:     }
                   8966:     #
                   8967:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   8968:         return '';
                   8969:     }
                   8970:     my $NumSets=1;
1.138     matthew  8971:     foreach my $array (@{$Ydata}){
1.137     matthew  8972:         next if (! ref($array));
                   8973:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   8974:     }
1.138     matthew  8975:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  8976:     #
                   8977:     # Deal with other parameters
                   8978:     while (my ($key,$value) = each(%Values)) {
                   8979:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  8980:     }
                   8981:     #
1.646     raeburn  8982:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  8983:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   8984: }
                   8985: 
                   8986: ############################################################
                   8987: ############################################################
                   8988: 
                   8989: =pod
                   8990: 
1.648     raeburn  8991: =item * &DrawXYYGraph()
1.138     matthew  8992: 
                   8993: Facilitates the plotting of data in an XY graph with two Y axes.
                   8994: Puts plot definition data into the users environment in order for 
                   8995: graph.png to plot it.  Returns an <img> tag for the plot.
                   8996: 
                   8997: Inputs:
                   8998: 
                   8999: =over 4
                   9000: 
                   9001: =item $Title: string, the title of the plot
                   9002: 
                   9003: =item $xlabel: string, text describing the X-axis of the plot
                   9004: 
                   9005: =item $ylabel: string, text describing the Y-axis of the plot
                   9006: 
                   9007: =item $colors: Array ref containing the hex color codes for the data to be 
                   9008: plotted in.  If undefined, default values will be used.
                   9009: 
                   9010: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9011: 
                   9012: =item $Ydata1: The first data set
                   9013: 
                   9014: =item $Min1: The minimum value of the left Y-axis
                   9015: 
                   9016: =item $Max1: The maximum value of the left Y-axis
                   9017: 
                   9018: =item $Ydata2: The second data set
                   9019: 
                   9020: =item $Min2: The minimum value of the right Y-axis
                   9021: 
                   9022: =item $Max2: The maximum value of the left Y-axis
                   9023: 
                   9024: =item %Values: hash indicating or overriding any default values which are 
                   9025: passed to graph.png.  
                   9026: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9027: 
                   9028: =back
                   9029: 
                   9030: Returns:
                   9031: 
                   9032: An <img> tag which references graph.png and the appropriate identifying
                   9033: information for the plot.
1.136     matthew  9034: 
                   9035: =cut
                   9036: 
                   9037: ############################################################
                   9038: ############################################################
1.137     matthew  9039: sub DrawXYYGraph {
                   9040:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9041:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9042:     #
                   9043:     # Create the identifier for the graph
                   9044:     my $identifier = &get_cgi_id();
                   9045:     my $id = 'cgi.'.$identifier;
                   9046:     #
                   9047:     $Title  = '' if (! defined($Title));
                   9048:     $xlabel = '' if (! defined($xlabel));
                   9049:     $ylabel = '' if (! defined($ylabel));
                   9050:     my %ValuesHash = 
                   9051:         (
1.369     www      9052:          $id.'.title'  => &escape($Title),
                   9053:          $id.'.xlabel' => &escape($xlabel),
                   9054:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9055:          $id.'.labels' => join(',',@$Xlabels),
                   9056:          $id.'.PlotType' => 'XY',
                   9057:          $id.'.NumSets' => 2,
1.137     matthew  9058:          $id.'.two_axes' => 1,
                   9059:          $id.'.y1_max_value' => $Max1,
                   9060:          $id.'.y1_min_value' => $Min1,
                   9061:          $id.'.y2_max_value' => $Max2,
                   9062:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9063:          );
                   9064:     #
1.137     matthew  9065:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9066:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9067:     }
                   9068:     #
                   9069:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9070:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9071:         return '';
                   9072:     }
                   9073:     my $NumSets=1;
1.137     matthew  9074:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9075:         next if (! ref($array));
                   9076:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9077:     }
                   9078:     #
                   9079:     # Deal with other parameters
                   9080:     while (my ($key,$value) = each(%Values)) {
                   9081:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9082:     }
                   9083:     #
1.646     raeburn  9084:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9085:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9086: }
                   9087: 
                   9088: ############################################################
                   9089: ############################################################
                   9090: 
                   9091: =pod
                   9092: 
1.157     matthew  9093: =back 
                   9094: 
1.139     matthew  9095: =head1 Statistics helper routines?  
                   9096: 
                   9097: Bad place for them but what the hell.
                   9098: 
1.157     matthew  9099: =over 4
                   9100: 
1.648     raeburn  9101: =item * &chartlink()
1.139     matthew  9102: 
                   9103: Returns a link to the chart for a specific student.  
                   9104: 
                   9105: Inputs:
                   9106: 
                   9107: =over 4
                   9108: 
                   9109: =item $linktext: The text of the link
                   9110: 
                   9111: =item $sname: The students username
                   9112: 
                   9113: =item $sdomain: The students domain
                   9114: 
                   9115: =back
                   9116: 
1.157     matthew  9117: =back
                   9118: 
1.139     matthew  9119: =cut
                   9120: 
                   9121: ############################################################
                   9122: ############################################################
                   9123: sub chartlink {
                   9124:     my ($linktext, $sname, $sdomain) = @_;
                   9125:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9126:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9127:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9128:        '">'.$linktext.'</a>';
1.153     matthew  9129: }
                   9130: 
                   9131: #######################################################
                   9132: #######################################################
                   9133: 
                   9134: =pod
                   9135: 
                   9136: =head1 Course Environment Routines
1.157     matthew  9137: 
                   9138: =over 4
1.153     matthew  9139: 
1.648     raeburn  9140: =item * &restore_course_settings()
1.153     matthew  9141: 
1.648     raeburn  9142: =item * &store_course_settings()
1.153     matthew  9143: 
                   9144: Restores/Store indicated form parameters from the course environment.
                   9145: Will not overwrite existing values of the form parameters.
                   9146: 
                   9147: Inputs: 
                   9148: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9149: 
                   9150: a hash ref describing the data to be stored.  For example:
                   9151:    
                   9152: %Save_Parameters = ('Status' => 'scalar',
                   9153:     'chartoutputmode' => 'scalar',
                   9154:     'chartoutputdata' => 'scalar',
                   9155:     'Section' => 'array',
1.373     raeburn  9156:     'Group' => 'array',
1.153     matthew  9157:     'StudentData' => 'array',
                   9158:     'Maps' => 'array');
                   9159: 
                   9160: Returns: both routines return nothing
                   9161: 
1.631     raeburn  9162: =back
                   9163: 
1.153     matthew  9164: =cut
                   9165: 
                   9166: #######################################################
                   9167: #######################################################
                   9168: sub store_course_settings {
1.496     albertel 9169:     return &store_settings($env{'request.course.id'},@_);
                   9170: }
                   9171: 
                   9172: sub store_settings {
1.153     matthew  9173:     # save to the environment
                   9174:     # appenv the same items, just to be safe
1.300     albertel 9175:     my $udom  = $env{'user.domain'};
                   9176:     my $uname = $env{'user.name'};
1.496     albertel 9177:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9178:     my %SaveHash;
                   9179:     my %AppHash;
                   9180:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9181:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9182:         my $envname = 'environment.'.$basename;
1.258     albertel 9183:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9184:             # Save this value away
                   9185:             if ($type eq 'scalar' &&
1.258     albertel 9186:                 (! exists($env{$envname}) || 
                   9187:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9188:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9189:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9190:             } elsif ($type eq 'array') {
                   9191:                 my $stored_form;
1.258     albertel 9192:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9193:                     $stored_form = join(',',
                   9194:                                         map {
1.369     www      9195:                                             &escape($_);
1.258     albertel 9196:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9197:                 } else {
                   9198:                     $stored_form = 
1.369     www      9199:                         &escape($env{'form.'.$setting});
1.153     matthew  9200:                 }
                   9201:                 # Determine if the array contents are the same.
1.258     albertel 9202:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9203:                     $SaveHash{$basename} = $stored_form;
                   9204:                     $AppHash{$envname}   = $stored_form;
                   9205:                 }
                   9206:             }
                   9207:         }
                   9208:     }
                   9209:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9210:                                           $udom,$uname);
1.153     matthew  9211:     if ($put_result !~ /^(ok|delayed)/) {
                   9212:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9213:                                  'got error:'.$put_result);
                   9214:     }
                   9215:     # Make sure these settings stick around in this session, too
1.646     raeburn  9216:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9217:     return;
                   9218: }
                   9219: 
                   9220: sub restore_course_settings {
1.499     albertel 9221:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9222: }
                   9223: 
                   9224: sub restore_settings {
                   9225:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9226:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9227:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9228:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9229:             '.'.$setting;
1.258     albertel 9230:         if (exists($env{$envname})) {
1.153     matthew  9231:             if ($type eq 'scalar') {
1.258     albertel 9232:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9233:             } elsif ($type eq 'array') {
1.258     albertel 9234:                 $env{'form.'.$setting} = [ 
1.153     matthew  9235:                                            map { 
1.369     www      9236:                                                &unescape($_); 
1.258     albertel 9237:                                            } split(',',$env{$envname})
1.153     matthew  9238:                                            ];
                   9239:             }
                   9240:         }
                   9241:     }
1.127     matthew  9242: }
                   9243: 
1.618     raeburn  9244: #######################################################
                   9245: #######################################################
                   9246: 
                   9247: =pod
                   9248: 
                   9249: =head1 Domain E-mail Routines  
                   9250: 
                   9251: =over 4
                   9252: 
1.648     raeburn  9253: =item * &build_recipient_list()
1.618     raeburn  9254: 
1.766     raeburn  9255: Build recipient lists for four types of e-mail:
                   9256: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
                   9257: (d) Help requests, generated by
                   9258: lonerrorhandler.pm, CHECKRPMS, loncron, and lonsupportreq.pm respectively.
1.618     raeburn  9259: 
                   9260: Inputs:
1.619     raeburn  9261: defmail (scalar - email address of default recipient), 
1.618     raeburn  9262: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9263: defdom (domain for which to retrieve configuration settings),
                   9264: origmail (scalar - email address of recipient from loncapa.conf, 
                   9265: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9266: 
1.655     raeburn  9267: Returns: comma separated list of addresses to which to send e-mail.
                   9268: 
                   9269: =back
1.618     raeburn  9270: 
                   9271: =cut
                   9272: 
                   9273: ############################################################
                   9274: ############################################################
                   9275: sub build_recipient_list {
1.619     raeburn  9276:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9277:     my @recipients;
                   9278:     my $otheremails;
                   9279:     my %domconfig =
                   9280:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9281:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9282:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9283:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9284:                 my @contacts = ('adminemail','supportemail');
                   9285:                 foreach my $item (@contacts) {
                   9286:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9287:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9288:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9289:                             push(@recipients,$addr);
                   9290:                         }
1.619     raeburn  9291:                     }
1.766     raeburn  9292:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9293:                 }
                   9294:             }
1.766     raeburn  9295:         } elsif ($origmail ne '') {
                   9296:             push(@recipients,$origmail);
1.618     raeburn  9297:         }
1.619     raeburn  9298:     } elsif ($origmail ne '') {
                   9299:         push(@recipients,$origmail);
1.618     raeburn  9300:     }
1.688     raeburn  9301:     if (defined($defmail)) {
                   9302:         if ($defmail ne '') {
                   9303:             push(@recipients,$defmail);
                   9304:         }
1.618     raeburn  9305:     }
                   9306:     if ($otheremails) {
1.619     raeburn  9307:         my @others;
                   9308:         if ($otheremails =~ /,/) {
                   9309:             @others = split(/,/,$otheremails);
1.618     raeburn  9310:         } else {
1.619     raeburn  9311:             push(@others,$otheremails);
                   9312:         }
                   9313:         foreach my $addr (@others) {
                   9314:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9315:                 push(@recipients,$addr);
                   9316:             }
1.618     raeburn  9317:         }
                   9318:     }
1.619     raeburn  9319:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9320:     return $recipientlist;
                   9321: }
                   9322: 
1.127     matthew  9323: ############################################################
                   9324: ############################################################
1.154     albertel 9325: 
1.655     raeburn  9326: =pod
                   9327: 
                   9328: =head1 Course Catalog Routines
                   9329: 
                   9330: =over 4
                   9331: 
                   9332: =item * &gather_categories()
                   9333: 
                   9334: Converts category definitions - keys of categories hash stored in  
                   9335: coursecategories in configuration.db on the primary library server in a 
                   9336: domain - to an array.  Also generates javascript and idx hash used to 
                   9337: generate Domain Coordinator interface for editing Course Categories.
                   9338: 
                   9339: Inputs:
1.663     raeburn  9340: 
1.655     raeburn  9341: categories (reference to hash of category definitions).
1.663     raeburn  9342: 
1.655     raeburn  9343: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9344:       categories and subcategories).
1.663     raeburn  9345: 
1.655     raeburn  9346: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9347:       editing Course Categories).
1.663     raeburn  9348: 
1.655     raeburn  9349: jsarray (reference to array of categories used to create Javascript arrays for
                   9350:          Domain Coordinator interface for editing Course Categories).
                   9351: 
                   9352: Returns: nothing
                   9353: 
                   9354: Side effects: populates cats, idx and jsarray. 
                   9355: 
                   9356: =cut
                   9357: 
                   9358: sub gather_categories {
                   9359:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9360:     my %counters;
                   9361:     my $num = 0;
                   9362:     foreach my $item (keys(%{$categories})) {
                   9363:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9364:         if ($container eq '' && $depth == 0) {
                   9365:             $cats->[$depth][$categories->{$item}] = $cat;
                   9366:         } else {
                   9367:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9368:         }
                   9369:         my ($escitem,$tail) = split(/:/,$item,2);
                   9370:         if ($counters{$tail} eq '') {
                   9371:             $counters{$tail} = $num;
                   9372:             $num ++;
                   9373:         }
                   9374:         if (ref($idx) eq 'HASH') {
                   9375:             $idx->{$item} = $counters{$tail};
                   9376:         }
                   9377:         if (ref($jsarray) eq 'ARRAY') {
                   9378:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9379:         }
                   9380:     }
                   9381:     return;
                   9382: }
                   9383: 
                   9384: =pod
                   9385: 
                   9386: =item * &extract_categories()
                   9387: 
                   9388: Used to generate breadcrumb trails for course categories.
                   9389: 
                   9390: Inputs:
1.663     raeburn  9391: 
1.655     raeburn  9392: categories (reference to hash of category definitions).
1.663     raeburn  9393: 
1.655     raeburn  9394: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9395:       categories and subcategories).
1.663     raeburn  9396: 
1.655     raeburn  9397: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9398: 
1.655     raeburn  9399: allitems (reference to hash - key is category key 
                   9400:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9401: 
1.655     raeburn  9402: idx (reference to hash of counters used in Domain Coordinator interface for
                   9403:       editing Course Categories).
1.663     raeburn  9404: 
1.655     raeburn  9405: jsarray (reference to array of categories used to create Javascript arrays for
                   9406:          Domain Coordinator interface for editing Course Categories).
                   9407: 
1.665     raeburn  9408: subcats (reference to hash of arrays containing all subcategories within each 
                   9409:          category, -recursive)
                   9410: 
1.655     raeburn  9411: Returns: nothing
                   9412: 
                   9413: Side effects: populates trails and allitems hash references.
                   9414: 
                   9415: =cut
                   9416: 
                   9417: sub extract_categories {
1.665     raeburn  9418:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9419:     if (ref($categories) eq 'HASH') {
                   9420:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9421:         if (ref($cats->[0]) eq 'ARRAY') {
                   9422:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9423:                 my $name = $cats->[0][$i];
                   9424:                 my $item = &escape($name).'::0';
                   9425:                 my $trailstr;
                   9426:                 if ($name eq 'instcode') {
                   9427:                     $trailstr = &mt('Official courses (with institutional codes)');
                   9428:                 } else {
                   9429:                     $trailstr = $name;
                   9430:                 }
                   9431:                 if ($allitems->{$item} eq '') {
                   9432:                     push(@{$trails},$trailstr);
                   9433:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9434:                 }
                   9435:                 my @parents = ($name);
                   9436:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9437:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9438:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9439:                         if (ref($subcats) eq 'HASH') {
                   9440:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9441:                         }
                   9442:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9443:                     }
                   9444:                 } else {
                   9445:                     if (ref($subcats) eq 'HASH') {
                   9446:                         $subcats->{$item} = [];
1.655     raeburn  9447:                     }
                   9448:                 }
                   9449:             }
                   9450:         }
                   9451:     }
                   9452:     return;
                   9453: }
                   9454: 
                   9455: =pod
                   9456: 
                   9457: =item *&recurse_categories()
                   9458: 
                   9459: Recursively used to generate breadcrumb trails for course categories.
                   9460: 
                   9461: Inputs:
1.663     raeburn  9462: 
1.655     raeburn  9463: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9464:       categories and subcategories).
1.663     raeburn  9465: 
1.655     raeburn  9466: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9467: 
                   9468: category (current course category, for which breadcrumb trail is being generated).
                   9469: 
                   9470: trails (reference to array of breadcrumb trails for each category).
                   9471: 
1.655     raeburn  9472: allitems (reference to hash - key is category key
                   9473:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9474: 
1.655     raeburn  9475: parents (array containing containers directories for current category, 
                   9476:          back to top level). 
                   9477: 
                   9478: Returns: nothing
                   9479: 
                   9480: Side effects: populates trails and allitems hash references
                   9481: 
                   9482: =cut
                   9483: 
                   9484: sub recurse_categories {
1.665     raeburn  9485:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9486:     my $shallower = $depth - 1;
                   9487:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9488:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9489:             my $name = $cats->[$depth]{$category}[$k];
                   9490:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9491:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9492:             if ($allitems->{$item} eq '') {
                   9493:                 push(@{$trails},$trailstr);
                   9494:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9495:             }
                   9496:             my $deeper = $depth+1;
                   9497:             push(@{$parents},$category);
1.665     raeburn  9498:             if (ref($subcats) eq 'HASH') {
                   9499:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9500:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9501:                     my $higher;
                   9502:                     if ($j > 0) {
                   9503:                         $higher = &escape($parents->[$j]).':'.
                   9504:                                   &escape($parents->[$j-1]).':'.$j;
                   9505:                     } else {
                   9506:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9507:                     }
                   9508:                     push(@{$subcats->{$higher}},$subcat);
                   9509:                 }
                   9510:             }
                   9511:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9512:                                 $subcats);
1.655     raeburn  9513:             pop(@{$parents});
                   9514:         }
                   9515:     } else {
                   9516:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9517:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9518:         if ($allitems->{$item} eq '') {
                   9519:             push(@{$trails},$trailstr);
                   9520:             $allitems->{$item} = scalar(@{$trails})-1;
                   9521:         }
                   9522:     }
                   9523:     return;
                   9524: }
                   9525: 
1.663     raeburn  9526: =pod
                   9527: 
                   9528: =item *&assign_categories_table()
                   9529: 
                   9530: Create a datatable for display of hierarchical categories in a domain,
                   9531: with checkboxes to allow a course to be categorized. 
                   9532: 
                   9533: Inputs:
                   9534: 
                   9535: cathash - reference to hash of categories defined for the domain (from
                   9536:           configuration.db)
                   9537: 
                   9538: currcat - scalar with an & separated list of categories assigned to a course. 
                   9539: 
                   9540: Returns: $output (markup to be displayed) 
                   9541: 
                   9542: =cut
                   9543: 
                   9544: sub assign_categories_table {
                   9545:     my ($cathash,$currcat) = @_;
                   9546:     my $output;
                   9547:     if (ref($cathash) eq 'HASH') {
                   9548:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9549:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9550:         $maxdepth = scalar(@cats);
                   9551:         if (@cats > 0) {
                   9552:             my $itemcount = 0;
                   9553:             if (ref($cats[0]) eq 'ARRAY') {
                   9554:                 $output = &Apache::loncommon::start_data_table();
                   9555:                 my @currcategories;
                   9556:                 if ($currcat ne '') {
                   9557:                     @currcategories = split('&',$currcat);
                   9558:                 }
                   9559:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9560:                     my $parent = $cats[0][$i];
                   9561:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9562:                     next if ($parent eq 'instcode');
                   9563:                     my $item = &escape($parent).'::0';
                   9564:                     my $checked = '';
                   9565:                     if (@currcategories > 0) {
                   9566:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9567:                             $checked = ' checked="checked"';
1.663     raeburn  9568:                         }
                   9569:                     }
1.675     raeburn  9570:                     $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9571:                                '<input type="checkbox" name="usecategory" value="'.
                   9572:                                $item.'"'.$checked.' />'.$parent.'</span>'.
                   9573:                                '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9574:                     my $depth = 1;
                   9575:                     push(@path,$parent);
                   9576:                     $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                   9577:                     pop(@path);
                   9578:                     $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                   9579:                     $itemcount ++;
                   9580:                 }
                   9581:                 $output .= &Apache::loncommon::end_data_table();
                   9582:             }
                   9583:         }
                   9584:     }
                   9585:     return $output;
                   9586: }
                   9587: 
                   9588: =pod
                   9589: 
                   9590: =item *&assign_category_rows()
                   9591: 
                   9592: Create a datatable row for display of nested categories in a domain,
                   9593: with checkboxes to allow a course to be categorized,called recursively.
                   9594: 
                   9595: Inputs:
                   9596: 
                   9597: itemcount - track row number for alternating colors
                   9598: 
                   9599: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   9600:       categories and subcategories.
                   9601: 
                   9602: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   9603: 
                   9604: parent - parent of current category item
                   9605: 
                   9606: path - Array containing all categories back up through the hierarchy from the
                   9607:        current category to the top level.
                   9608: 
                   9609: currcategories - reference to array of current categories assigned to the course
                   9610: 
                   9611: Returns: $output (markup to be displayed).
                   9612: 
                   9613: =cut
                   9614: 
                   9615: sub assign_category_rows {
                   9616:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   9617:     my ($text,$name,$item,$chgstr);
                   9618:     if (ref($cats) eq 'ARRAY') {
                   9619:         my $maxdepth = scalar(@{$cats});
                   9620:         if (ref($cats->[$depth]) eq 'HASH') {
                   9621:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   9622:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   9623:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9624:                 $text .= '<td><table class="LC_datatable">';
                   9625:                 for (my $j=0; $j<$numchildren; $j++) {
                   9626:                     $name = $cats->[$depth]{$parent}[$j];
                   9627:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   9628:                     my $deeper = $depth+1;
                   9629:                     my $checked = '';
                   9630:                     if (ref($currcategories) eq 'ARRAY') {
                   9631:                         if (@{$currcategories} > 0) {
                   9632:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   9633:                                 $checked = ' checked="checked"';
1.663     raeburn  9634:                             }
                   9635:                         }
                   9636:                     }
1.664     raeburn  9637:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   9638:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  9639:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   9640:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   9641:                              '</td><td>';
1.663     raeburn  9642:                     if (ref($path) eq 'ARRAY') {
                   9643:                         push(@{$path},$name);
                   9644:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   9645:                         pop(@{$path});
                   9646:                     }
                   9647:                     $text .= '</td></tr>';
                   9648:                 }
                   9649:                 $text .= '</table></td>';
                   9650:             }
                   9651:         }
                   9652:     }
                   9653:     return $text;
                   9654: }
                   9655: 
1.655     raeburn  9656: ############################################################
                   9657: ############################################################
                   9658: 
                   9659: 
1.443     albertel 9660: sub commit_customrole {
1.664     raeburn  9661:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  9662:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 9663:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   9664:                          ($end?', ending '.localtime($end):'').': <b>'.
                   9665:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  9666:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 9667:                  '</b><br />';
                   9668:     return $output;
                   9669: }
                   9670: 
                   9671: sub commit_standardrole {
1.541     raeburn  9672:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   9673:     my ($output,$logmsg,$linefeed);
                   9674:     if ($context eq 'auto') {
                   9675:         $linefeed = "\n";
                   9676:     } else {
                   9677:         $linefeed = "<br />\n";
                   9678:     }  
1.443     albertel 9679:     if ($three eq 'st') {
1.541     raeburn  9680:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   9681:                                          $one,$two,$sec,$context);
                   9682:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  9683:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   9684:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 9685:         } else {
1.541     raeburn  9686:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 9687:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9688:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   9689:             if ($context eq 'auto') {
                   9690:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   9691:             } else {
                   9692:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   9693:                &mt('Add to classlist').': <b>ok</b>';
                   9694:             }
                   9695:             $output .= $linefeed;
1.443     albertel 9696:         }
                   9697:     } else {
                   9698:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   9699:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9700:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  9701:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  9702:         if ($context eq 'auto') {
                   9703:             $output .= $result.$linefeed;
                   9704:         } else {
                   9705:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   9706:         }
1.443     albertel 9707:     }
                   9708:     return $output;
                   9709: }
                   9710: 
                   9711: sub commit_studentrole {
1.541     raeburn  9712:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  9713:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  9714:     if ($context eq 'auto') {
                   9715:         $linefeed = "\n";
                   9716:     } else {
                   9717:         $linefeed = '<br />'."\n";
                   9718:     }
1.443     albertel 9719:     if (defined($one) && defined($two)) {
                   9720:         my $cid=$one.'_'.$two;
                   9721:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   9722:         my $secchange = 0;
                   9723:         my $expire_role_result;
                   9724:         my $modify_section_result;
1.628     raeburn  9725:         if ($oldsec ne '-1') { 
                   9726:             if ($oldsec ne $sec) {
1.443     albertel 9727:                 $secchange = 1;
1.628     raeburn  9728:                 my $now = time;
1.443     albertel 9729:                 my $uurl='/'.$cid;
                   9730:                 $uurl=~s/\_/\//g;
                   9731:                 if ($oldsec) {
                   9732:                     $uurl.='/'.$oldsec;
                   9733:                 }
1.626     raeburn  9734:                 $oldsecurl = $uurl;
1.628     raeburn  9735:                 $expire_role_result = 
1.652     raeburn  9736:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  9737:                 if ($env{'request.course.sec'} ne '') { 
                   9738:                     if ($expire_role_result eq 'refused') {
                   9739:                         my @roles = ('st');
                   9740:                         my @statuses = ('previous');
                   9741:                         my @roledoms = ($one);
                   9742:                         my $withsec = 1;
                   9743:                         my %roleshash = 
                   9744:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   9745:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   9746:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   9747:                             my ($oldstart,$oldend) = 
                   9748:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   9749:                             if ($oldend > 0 && $oldend <= $now) {
                   9750:                                 $expire_role_result = 'ok';
                   9751:                             }
                   9752:                         }
                   9753:                     }
                   9754:                 }
1.443     albertel 9755:                 $result = $expire_role_result;
                   9756:             }
                   9757:         }
                   9758:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  9759:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 9760:             if ($modify_section_result =~ /^ok/) {
                   9761:                 if ($secchange == 1) {
1.628     raeburn  9762:                     if ($sec eq '') {
                   9763:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   9764:                     } else {
                   9765:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   9766:                     }
1.443     albertel 9767:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  9768:                     if ($sec eq '') {
                   9769:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   9770:                     } else {
                   9771:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9772:                     }
1.443     albertel 9773:                 } else {
1.628     raeburn  9774:                     if ($sec eq '') {
                   9775:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   9776:                     } else {
                   9777:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9778:                     }
1.443     albertel 9779:                 }
                   9780:             } else {
1.628     raeburn  9781:                 if ($secchange) {       
                   9782:                     $$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;
                   9783:                 } else {
                   9784:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   9785:                 }
1.443     albertel 9786:             }
                   9787:             $result = $modify_section_result;
                   9788:         } elsif ($secchange == 1) {
1.628     raeburn  9789:             if ($oldsec eq '') {
                   9790:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   9791:             } else {
                   9792:                 $$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;
                   9793:             }
1.626     raeburn  9794:             if ($expire_role_result eq 'refused') {
                   9795:                 my $newsecurl = '/'.$cid;
                   9796:                 $newsecurl =~ s/\_/\//g;
                   9797:                 if ($sec ne '') {
                   9798:                     $newsecurl.='/'.$sec;
                   9799:                 }
                   9800:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   9801:                     if ($sec eq '') {
                   9802:                         $$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;
                   9803:                     } else {
                   9804:                         $$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;
                   9805:                     }
                   9806:                 }
                   9807:             }
1.443     albertel 9808:         }
                   9809:     } else {
1.626     raeburn  9810:         $$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 9811:         $result = "error: incomplete course id\n";
                   9812:     }
                   9813:     return $result;
                   9814: }
                   9815: 
                   9816: ############################################################
                   9817: ############################################################
                   9818: 
1.566     albertel 9819: sub check_clone {
1.578     raeburn  9820:     my ($args,$linefeed) = @_;
1.566     albertel 9821:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   9822:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   9823:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   9824:     my $clonemsg;
                   9825:     my $can_clone = 0;
                   9826: 
                   9827:     if ($clonehome eq 'no_host') {
1.578     raeburn  9828:         $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 9829:     } else {
                   9830: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568     albertel 9831: 	if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566     albertel 9832: 	    $can_clone = 1;
                   9833: 	} else {
                   9834: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   9835: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   9836: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  9837:             if (grep(/^\*$/,@cloners)) {
                   9838:                 $can_clone = 1;
                   9839:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   9840:                 $can_clone = 1;
                   9841:             } else {
                   9842: 	        my %roleshash =
                   9843: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   9844: 					 $args->{'ccdomain'},
                   9845:                                          'userroles',['active'],['cc'],
                   9846: 					 [$args->{'clonedomain'}]);
                   9847: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
                   9848: 		    $can_clone = 1;
                   9849: 	        } else {
                   9850:                     $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'});
                   9851: 	        }
1.566     albertel 9852: 	    }
1.578     raeburn  9853:         }
1.566     albertel 9854:     }
                   9855:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9856: }
                   9857: 
1.444     albertel 9858: sub construct_course {
1.541     raeburn  9859:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444     albertel 9860:     my $outcome;
1.541     raeburn  9861:     my $linefeed =  '<br />'."\n";
                   9862:     if ($context eq 'auto') {
                   9863:         $linefeed = "\n";
                   9864:     }
1.566     albertel 9865: 
                   9866: #
                   9867: # Are we cloning?
                   9868: #
                   9869:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9870:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  9871: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 9872: 	if ($context ne 'auto') {
1.578     raeburn  9873:             if ($clonemsg ne '') {
                   9874: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   9875:             }
1.566     albertel 9876: 	}
                   9877: 	$outcome .= $clonemsg.$linefeed;
                   9878: 
                   9879:         if (!$can_clone) {
                   9880: 	    return (0,$outcome);
                   9881: 	}
                   9882:     }
                   9883: 
1.444     albertel 9884: #
                   9885: # Open course
                   9886: #
                   9887:     my $crstype = lc($args->{'crstype'});
                   9888:     my %cenv=();
                   9889:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   9890:                                              $args->{'cdescr'},
                   9891:                                              $args->{'curl'},
                   9892:                                              $args->{'course_home'},
                   9893:                                              $args->{'nonstandard'},
                   9894:                                              $args->{'crscode'},
                   9895:                                              $args->{'ccuname'}.':'.
                   9896:                                              $args->{'ccdomain'},
                   9897:                                              $args->{'crstype'});
                   9898: 
                   9899:     # Note: The testing routines depend on this being output; see 
                   9900:     # Utils::Course. This needs to at least be output as a comment
                   9901:     # if anyone ever decides to not show this, and Utils::Course::new
                   9902:     # will need to be suitably modified.
1.541     raeburn  9903:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 9904: #
                   9905: # Check if created correctly
                   9906: #
1.479     albertel 9907:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 9908:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  9909:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 9910: 
1.444     albertel 9911: #
1.566     albertel 9912: # Do the cloning
                   9913: #   
                   9914:     if ($can_clone && $cloneid) {
                   9915: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   9916: 	if ($context ne 'auto') {
                   9917: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   9918: 	}
                   9919: 	$outcome .= $clonemsg.$linefeed;
                   9920: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 9921: # Copy all files
1.637     www      9922: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 9923: # Restore URL
1.566     albertel 9924: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 9925: # Restore title
1.566     albertel 9926: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 9927: # Mark as cloned
1.566     albertel 9928: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      9929: # Need to clone grading mode
                   9930:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   9931:         $cenv{'grading'}=$newenv{'grading'};
                   9932: # Do not clone these environment entries
                   9933:         &Apache::lonnet::del('environment',
                   9934:                   ['default_enrollment_start_date',
                   9935:                    'default_enrollment_end_date',
                   9936:                    'question.email',
                   9937:                    'policy.email',
                   9938:                    'comment.email',
                   9939:                    'pch.users.denied',
1.725     raeburn  9940:                    'plc.users.denied',
                   9941:                    'hidefromcat',
                   9942:                    'categories'],
1.638     www      9943:                    $$crsudom,$$crsunum);
1.444     albertel 9944:     }
1.566     albertel 9945: 
1.444     albertel 9946: #
                   9947: # Set environment (will override cloned, if existing)
                   9948: #
                   9949:     my @sections = ();
                   9950:     my @xlists = ();
                   9951:     if ($args->{'crstype'}) {
                   9952:         $cenv{'type'}=$args->{'crstype'};
                   9953:     }
                   9954:     if ($args->{'crsid'}) {
                   9955:         $cenv{'courseid'}=$args->{'crsid'};
                   9956:     }
                   9957:     if ($args->{'crscode'}) {
                   9958:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   9959:     }
                   9960:     if ($args->{'crsquota'} ne '') {
                   9961:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   9962:     } else {
                   9963:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   9964:     }
                   9965:     if ($args->{'ccuname'}) {
                   9966:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   9967:                                         ':'.$args->{'ccdomain'};
                   9968:     } else {
                   9969:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   9970:     }
                   9971:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   9972:     if ($args->{'crssections'}) {
                   9973:         $cenv{'internal.sectionnums'} = '';
                   9974:         if ($args->{'crssections'} =~ m/,/) {
                   9975:             @sections = split/,/,$args->{'crssections'};
                   9976:         } else {
                   9977:             $sections[0] = $args->{'crssections'};
                   9978:         }
                   9979:         if (@sections > 0) {
                   9980:             foreach my $item (@sections) {
                   9981:                 my ($sec,$gp) = split/:/,$item;
                   9982:                 my $class = $args->{'crscode'}.$sec;
                   9983:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   9984:                 $cenv{'internal.sectionnums'} .= $item.',';
                   9985:                 unless ($addcheck eq 'ok') {
                   9986:                     push @badclasses, $class;
                   9987:                 }
                   9988:             }
                   9989:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   9990:         }
                   9991:     }
                   9992: # do not hide course coordinator from staff listing, 
                   9993: # even if privileged
                   9994:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   9995: # add crosslistings
                   9996:     if ($args->{'crsxlist'}) {
                   9997:         $cenv{'internal.crosslistings'}='';
                   9998:         if ($args->{'crsxlist'} =~ m/,/) {
                   9999:             @xlists = split/,/,$args->{'crsxlist'};
                   10000:         } else {
                   10001:             $xlists[0] = $args->{'crsxlist'};
                   10002:         }
                   10003:         if (@xlists > 0) {
                   10004:             foreach my $item (@xlists) {
                   10005:                 my ($xl,$gp) = split/:/,$item;
                   10006:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   10007:                 $cenv{'internal.crosslistings'} .= $item.',';
                   10008:                 unless ($addcheck eq 'ok') {
                   10009:                     push @badclasses, $xl;
                   10010:                 }
                   10011:             }
                   10012:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   10013:         }
                   10014:     }
                   10015:     if ($args->{'autoadds'}) {
                   10016:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   10017:     }
                   10018:     if ($args->{'autodrops'}) {
                   10019:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10020:     }
                   10021: # check for notification of enrollment changes
                   10022:     my @notified = ();
                   10023:     if ($args->{'notify_owner'}) {
                   10024:         if ($args->{'ccuname'} ne '') {
                   10025:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10026:         }
                   10027:     }
                   10028:     if ($args->{'notify_dc'}) {
                   10029:         if ($uname ne '') { 
1.630     raeburn  10030:             push(@notified,$uname.':'.$udom);
1.444     albertel 10031:         }
                   10032:     }
                   10033:     if (@notified > 0) {
                   10034:         my $notifylist;
                   10035:         if (@notified > 1) {
                   10036:             $notifylist = join(',',@notified);
                   10037:         } else {
                   10038:             $notifylist = $notified[0];
                   10039:         }
                   10040:         $cenv{'internal.notifylist'} = $notifylist;
                   10041:     }
                   10042:     if (@badclasses > 0) {
                   10043:         my %lt=&Apache::lonlocal::texthash(
                   10044:                 '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',
                   10045:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10046:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10047:         );
1.541     raeburn  10048:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10049:                            ' ('.$lt{'adby'}.')';
                   10050:         if ($context eq 'auto') {
                   10051:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10052:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10053:             foreach my $item (@badclasses) {
                   10054:                 if ($context eq 'auto') {
                   10055:                     $outcome .= " - $item\n";
                   10056:                 } else {
                   10057:                     $outcome .= "<li>$item</li>\n";
                   10058:                 }
                   10059:             }
                   10060:             if ($context eq 'auto') {
                   10061:                 $outcome .= $linefeed;
                   10062:             } else {
1.566     albertel 10063:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10064:             }
                   10065:         } 
1.444     albertel 10066:     }
                   10067:     if ($args->{'no_end_date'}) {
                   10068:         $args->{'endaccess'} = 0;
                   10069:     }
                   10070:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10071:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10072:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10073:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10074:     if ($args->{'showphotos'}) {
                   10075:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10076:     }
                   10077:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10078:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10079:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10080:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10081:             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'); 
                   10082:             if ($context eq 'auto') {
                   10083:                 $outcome .= $krb_msg;
                   10084:             } else {
1.566     albertel 10085:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10086:             }
                   10087:             $outcome .= $linefeed;
1.444     albertel 10088:         }
                   10089:     }
                   10090:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10091:        if ($args->{'setpolicy'}) {
                   10092:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10093:        }
                   10094:        if ($args->{'setcontent'}) {
                   10095:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10096:        }
                   10097:     }
                   10098:     if ($args->{'reshome'}) {
                   10099: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10100: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10101:     }
                   10102: #
                   10103: # course has keyed access
                   10104: #
                   10105:     if ($args->{'setkeys'}) {
                   10106:        $cenv{'keyaccess'}='yes';
                   10107:     }
                   10108: # if specified, key authority is not course, but user
                   10109: # only active if keyaccess is yes
                   10110:     if ($args->{'keyauth'}) {
1.487     albertel 10111: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10112: 	$user = &LONCAPA::clean_username($user);
                   10113: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10114: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10115: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10116: 	}
                   10117:     }
                   10118: 
                   10119:     if ($args->{'disresdis'}) {
                   10120:         $cenv{'pch.roles.denied'}='st';
                   10121:     }
                   10122:     if ($args->{'disablechat'}) {
                   10123:         $cenv{'plc.roles.denied'}='st';
                   10124:     }
                   10125: 
                   10126:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10127:     # course
                   10128:     $cenv{'course.helper.not.run'} = 1;
                   10129:     #
                   10130:     # Use new Randomseed
                   10131:     #
                   10132:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10133:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10134:     #
                   10135:     # The encryption code and receipt prefix for this course
                   10136:     #
                   10137:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10138:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10139:     #
                   10140:     # By default, use standard grading
                   10141:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10142: 
1.541     raeburn  10143:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10144:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10145: #
                   10146: # Open all assignments
                   10147: #
                   10148:     if ($args->{'openall'}) {
                   10149:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10150:        my %storecontent = ($storeunder         => time,
                   10151:                            $storeunder.'.type' => 'date_start');
                   10152:        
                   10153:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10154:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10155:    }
                   10156: #
                   10157: # Set first page
                   10158: #
                   10159:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10160: 	    || ($cloneid)) {
1.445     albertel 10161: 	use LONCAPA::map;
1.444     albertel 10162: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10163: 
                   10164: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10165:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10166: 
1.444     albertel 10167:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10168:         my $title; my $url;
                   10169:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10170: 	    $title=&mt('Syllabus');
1.444     albertel 10171:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10172:         } else {
1.690     bisitz   10173:             $title=&mt('Navigate Contents');
1.444     albertel 10174:             $url='/adm/navmaps';
                   10175:         }
1.445     albertel 10176: 
                   10177:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10178: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10179: 
                   10180: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10181:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10182:     }
1.566     albertel 10183: 
                   10184:     return (1,$outcome);
1.444     albertel 10185: }
                   10186: 
                   10187: ############################################################
                   10188: ############################################################
                   10189: 
1.378     raeburn  10190: sub course_type {
                   10191:     my ($cid) = @_;
                   10192:     if (!defined($cid)) {
                   10193:         $cid = $env{'request.course.id'};
                   10194:     }
1.404     albertel 10195:     if (defined($env{'course.'.$cid.'.type'})) {
                   10196:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10197:     } else {
                   10198:         return 'Course';
1.377     raeburn  10199:     }
                   10200: }
1.156     albertel 10201: 
1.406     raeburn  10202: sub group_term {
                   10203:     my $crstype = &course_type();
                   10204:     my %names = (
                   10205:                   'Course' => 'group',
                   10206:                   'Group' => 'team',
                   10207:                 );
                   10208:     return $names{$crstype};
                   10209: }
                   10210: 
1.156     albertel 10211: sub icon {
                   10212:     my ($file)=@_;
1.505     albertel 10213:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10214:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10215:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10216:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10217: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10218: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10219: 	            $curfext.".gif") {
                   10220: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10221: 		$curfext.".gif";
                   10222: 	}
                   10223:     }
1.249     albertel 10224:     return &lonhttpdurl($iconname);
1.154     albertel 10225: } 
1.84      albertel 10226: 
1.575     albertel 10227: sub lonhttpdurl {
1.692     www      10228: #
                   10229: # Had been used for "small fry" static images on separate port 8080.
                   10230: # Modify here if lightweight http functionality desired again.
                   10231: # Currently eliminated due to increasing firewall issues.
                   10232: #
1.575     albertel 10233:     my ($url)=@_;
1.692     www      10234:     return $url;
1.215     albertel 10235: }
                   10236: 
1.213     albertel 10237: sub connection_aborted {
                   10238:     my ($r)=@_;
                   10239:     $r->print(" ");$r->rflush();
                   10240:     my $c = $r->connection;
                   10241:     return $c->aborted();
                   10242: }
                   10243: 
1.221     foxr     10244: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10245: #    strings as 'strings'.
                   10246: sub escape_single {
1.221     foxr     10247:     my ($input) = @_;
1.223     albertel 10248:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10249:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10250:     return $input;
                   10251: }
1.223     albertel 10252: 
1.222     foxr     10253: #  Same as escape_single, but escape's "'s  This 
                   10254: #  can be used for  "strings"
                   10255: sub escape_double {
                   10256:     my ($input) = @_;
                   10257:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10258:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10259:     return $input;
                   10260: }
1.223     albertel 10261:  
1.222     foxr     10262: #   Escapes the last element of a full URL.
                   10263: sub escape_url {
                   10264:     my ($url)   = @_;
1.238     raeburn  10265:     my @urlslices = split(/\//, $url,-1);
1.369     www      10266:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10267:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10268: }
1.462     albertel 10269: 
1.820     raeburn  10270: sub compare_arrays {
                   10271:     my ($arrayref1,$arrayref2) = @_;
                   10272:     my (@difference,%count);
                   10273:     @difference = ();
                   10274:     %count = ();
                   10275:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10276:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10277:         foreach my $element (keys(%count)) {
                   10278:             if ($count{$element} == 1) {
                   10279:                 push(@difference,$element);
                   10280:             }
                   10281:         }
                   10282:     }
                   10283:     return @difference;
                   10284: }
                   10285: 
1.817     bisitz   10286: # -------------------------------------------------------- Initialize user login
1.462     albertel 10287: sub init_user_environment {
1.463     albertel 10288:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10289:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10290: 
                   10291:     my $public=($username eq 'public' && $domain eq 'public');
                   10292: 
                   10293: # See if old ID present, if so, remove
                   10294: 
                   10295:     my ($filename,$cookie,$userroles);
                   10296:     my $now=time;
                   10297: 
                   10298:     if ($public) {
                   10299: 	my $max_public=100;
                   10300: 	my $oldest;
                   10301: 	my $oldest_time=0;
                   10302: 	for(my $next=1;$next<=$max_public;$next++) {
                   10303: 	    if (-e $lonids."/publicuser_$next.id") {
                   10304: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10305: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10306: 		    $oldest_time=$mtime;
                   10307: 		    $oldest=$next;
                   10308: 		}
                   10309: 	    } else {
                   10310: 		$cookie="publicuser_$next";
                   10311: 		last;
                   10312: 	    }
                   10313: 	}
                   10314: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10315:     } else {
1.463     albertel 10316: 	# if this isn't a robot, kill any existing non-robot sessions
                   10317: 	if (!$args->{'robot'}) {
                   10318: 	    opendir(DIR,$lonids);
                   10319: 	    while ($filename=readdir(DIR)) {
                   10320: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10321: 		    unlink($lonids.'/'.$filename);
                   10322: 		}
1.462     albertel 10323: 	    }
1.463     albertel 10324: 	    closedir(DIR);
1.462     albertel 10325: 	}
                   10326: # Give them a new cookie
1.463     albertel 10327: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10328: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10329: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10330:     
                   10331: # Initialize roles
                   10332: 
                   10333: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10334:     }
                   10335: # ------------------------------------ Check browser type and MathML capability
                   10336: 
                   10337:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10338:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10339: 
                   10340: # ------------------------------------------------------------- Get environment
                   10341: 
                   10342:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10343:     my ($tmp) = keys(%userenv);
                   10344:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10345: 	# default remote control to off
                   10346: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   10347:     } else {
                   10348: 	undef(%userenv);
                   10349:     }
                   10350:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10351: 	$form->{'interface'}=$userenv{'interface'};
                   10352:     }
                   10353:     $env{'environment.remote'}=$userenv{'remote'};
                   10354:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10355: 
                   10356: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10357:     foreach my $option ('interface','localpath','localres') {
                   10358:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10359:     }
                   10360: # --------------------------------------------------------- Write first profile
                   10361: 
                   10362:     {
                   10363: 	my %initial_env = 
                   10364: 	    ("user.name"          => $username,
                   10365: 	     "user.domain"        => $domain,
                   10366: 	     "user.home"          => $authhost,
                   10367: 	     "browser.type"       => $clientbrowser,
                   10368: 	     "browser.version"    => $clientversion,
                   10369: 	     "browser.mathml"     => $clientmathml,
                   10370: 	     "browser.unicode"    => $clientunicode,
                   10371: 	     "browser.os"         => $clientos,
                   10372: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10373: 	     "request.course.fn"  => '',
                   10374: 	     "request.course.uri" => '',
                   10375: 	     "request.course.sec" => '',
                   10376: 	     "request.role"       => 'cm',
                   10377: 	     "request.role.adv"   => $env{'user.adv'},
                   10378: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10379: 
                   10380:         if ($form->{'localpath'}) {
                   10381: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10382: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10383:         }
                   10384: 	
                   10385: 	if ($public) {
                   10386: 	    $initial_env{"environment.remote"} = "off";
                   10387: 	}
                   10388: 	if ($form->{'interface'}) {
                   10389: 	    $form->{'interface'}=~s/\W//gs;
                   10390: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10391: 	    $env{'browser.interface'}=$form->{'interface'};
                   10392: 	}
                   10393: 
1.724     raeburn  10394:         foreach my $tool ('aboutme','blog','portfolio') {
                   10395:             $userenv{'availabletools.'.$tool} = 
                   10396:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10397:         }
                   10398: 
1.765     raeburn  10399:         foreach my $crstype ('official','unofficial') {
                   10400:             $userenv{'canrequest.'.$crstype} =
                   10401:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10402:                                                   'reload','requestcourses');
                   10403:         }
                   10404: 
1.462     albertel 10405: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10406: 	
                   10407: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10408: 		 &GDBM_WRCREAT(),0640)) {
                   10409: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10410: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10411: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10412: 	    if (ref($args->{'extra_env'})) {
                   10413: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10414: 	    }
1.462     albertel 10415: 	    untie(%disk_env);
                   10416: 	} else {
1.705     tempelho 10417: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10418: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10419: 	    return 'error: '.$!;
                   10420: 	}
                   10421:     }
                   10422:     $env{'request.role'}='cm';
                   10423:     $env{'request.role.adv'}=$env{'user.adv'};
                   10424:     $env{'browser.type'}=$clientbrowser;
                   10425: 
                   10426:     return $cookie;
                   10427: 
                   10428: }
                   10429: 
                   10430: sub _add_to_env {
                   10431:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10432:     if (ref($env_data) eq 'HASH') {
                   10433:         while (my ($key,$value) = each(%$env_data)) {
                   10434: 	    $idf->{$prefix.$key} = $value;
                   10435: 	    $env{$prefix.$key}   = $value;
                   10436:         }
1.462     albertel 10437:     }
                   10438: }
                   10439: 
1.685     tempelho 10440: # --- Get the symbolic name of a problem and the url
                   10441: sub get_symb {
                   10442:     my ($request,$silent) = @_;
1.726     raeburn  10443:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10444:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10445:     if ($symb eq '') {
                   10446:         if (!$silent) {
                   10447:             $request->print("Unable to handle ambiguous references:$url:.");
                   10448:             return ();
                   10449:         }
                   10450:     }
                   10451:     &Apache::lonenc::check_decrypt(\$symb);
                   10452:     return ($symb);
                   10453: }
                   10454: 
                   10455: # --------------------------------------------------------------Get annotation
                   10456: 
                   10457: sub get_annotation {
                   10458:     my ($symb,$enc) = @_;
                   10459: 
                   10460:     my $key = $symb;
                   10461:     if (!$enc) {
                   10462:         $key =
                   10463:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10464:     }
                   10465:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10466:     return $annotation{$key};
                   10467: }
                   10468: 
                   10469: sub clean_symb {
1.731     raeburn  10470:     my ($symb,$delete_enc) = @_;
1.685     tempelho 10471: 
                   10472:     &Apache::lonenc::check_decrypt(\$symb);
                   10473:     my $enc = $env{'request.enc'};
1.731     raeburn  10474:     if ($delete_enc) {
1.730     raeburn  10475:         delete($env{'request.enc'});
                   10476:     }
1.685     tempelho 10477: 
                   10478:     return ($symb,$enc);
                   10479: }
1.462     albertel 10480: 
1.41      ng       10481: =pod
                   10482: 
                   10483: =back
                   10484: 
1.112     bowersj2 10485: =cut
1.41      ng       10486: 
1.112     bowersj2 10487: 1;
                   10488: __END__;
1.41      ng       10489: 

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