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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.829   ! kalberla    4: # $Id: loncommon.pm,v 1.828 2009/05/27 17:14:56 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.326     albertel 4277: =item * $customtitle, alternate text to use instead of $title
                   4278:                       in the title box that appears, this text
                   4279:                       is not auto translated like the $title is
1.309     albertel 4280: 
1.814     bisitz   4281: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4282:                      navigational links
1.317     albertel 4283: 
1.338     albertel 4284: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4285: 
1.361     albertel 4286: =item * $no_inline_link, if true and in remote mode, don't show the 
                   4287:          'Switch To Inline Menu' link
                   4288: 
1.460     albertel 4289: =item * $args, optional argument valid values are
                   4290:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4291:             inherit_jsmath -> when creating popup window in a page,
                   4292:                               should it have jsmath forced on by the
                   4293:                               current page
1.460     albertel 4294: 
1.112     bowersj2 4295: =back
                   4296: 
1.60      matthew  4297: Returns: A uniform header for LON-CAPA web pages.  
                   4298: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4299: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4300: other decorations will be returned.
                   4301: 
                   4302: =cut
                   4303: 
1.54      www      4304: sub bodytag {
1.309     albertel 4305:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.816     bisitz   4306:         $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339     albertel 4307: 
1.460     albertel 4308:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4309: 
1.183     matthew  4310:     $function = &get_users_function() if (!$function);
1.339     albertel 4311:     my $img =    &designparm($function.'.img',$domain);
                   4312:     my $font =   &designparm($function.'.font',$domain);
                   4313:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4314: 
1.803     bisitz   4315:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4316: 		   'bgcolor' => $pgbg,
1.339     albertel 4317: 		   'text'    => $font,
                   4318:                    'alink'   => &designparm($function.'.alink',$domain),
                   4319: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4320: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4321:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4322: 
1.63      www      4323:  # role and realm
1.378     raeburn  4324:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4325:     if ($role  eq 'ca') {
1.479     albertel 4326:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4327:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4328:     } 
1.55      www      4329: # realm
1.258     albertel 4330:     if ($env{'request.course.id'}) {
1.378     raeburn  4331:         if ($env{'request.role'} !~ /^cr/) {
                   4332:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4333:         }
1.359     albertel 4334: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4335:     } else {
                   4336:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4337:     }
1.433     albertel 4338: 
1.359     albertel 4339:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      4340: # Set messages
1.60      matthew  4341:     my $messages=&domainlogo($domain);
1.330     albertel 4342: 
1.438     albertel 4343:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4344: 
1.101     www      4345: # construct main body tag
1.359     albertel 4346:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4347: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4348: 
1.530     albertel 4349:     if ($bodyonly) {
1.60      matthew  4350:         return $bodytag;
1.798     tempelho 4351:     } 
1.359     albertel 4352: 
1.410     albertel 4353:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433     albertel 4354:     if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   4355: 	undef($role);
1.434     albertel 4356:     } else {
                   4357: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4358:     }
1.359     albertel 4359:     
                   4360:     my $roleinfo=(<<ENDROLE);
                   4361: <td class="LC_title_bar_who">
                   4362: <div class="LC_title_bar_name">
1.410     albertel 4363:     $name
1.361     albertel 4364:     &nbsp;
1.359     albertel 4365: </div>
                   4366: <div class="LC_title_bar_role">
1.361     albertel 4367: $role&nbsp;
1.359     albertel 4368: </div>
                   4369: <div class="LC_title_bar_realm">
1.361     albertel 4370: $realm&nbsp;
1.359     albertel 4371: </div>
1.206     albertel 4372: </td>
                   4373: ENDROLE
1.235     raeburn  4374: 
1.762     bisitz   4375:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4376:     if ($customtitle) {
                   4377:         $titleinfo = $customtitle;
                   4378:     }
                   4379:     #
                   4380:     # Extra info if you are the DC
                   4381:     my $dc_info = '';
                   4382:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4383:                         $env{'course.'.$env{'request.course.id'}.
                   4384:                                  '.domain'}.'/'})) {
                   4385:         my $cid = $env{'request.course.id'};
                   4386:         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4387:         $dc_info =~ s/\s+$//;
1.359     albertel 4388:         $dc_info = '('.$dc_info.')';
                   4389:     }
                   4390: 
1.644     www      4391:     if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359     albertel 4392:         # No Remote
1.258     albertel 4393: 	if ($env{'request.state'} eq 'construct') {
1.359     albertel 4394: 	    $forcereg=1;
                   4395: 	}
                   4396: 
1.822     bisitz   4397:     if (!$customtitle && $env{'request.state'} eq 'construct') {
                   4398:         $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4399:     }
1.359     albertel 4400: 
1.816     bisitz   4401:         my $titletable = '<table id="LC_title_bar">'
                   4402:                         ."<tr><td> $titleinfo $dc_info</td>".$roleinfo
                   4403:                         .'</tr></table>';
                   4404: 
1.814     bisitz   4405: 	if ($no_nav_bar) {
1.359     albertel 4406: 	    $bodytag .= $titletable;
                   4407: 	} else {
1.813     bisitz   4408:         $bodytag .= qq|<div id="LC_nav_bar">$name ($role)<br />
                   4409:             <em>$realm</em> $dc_info</div>|;
1.359     albertel 4410: 	    if ($env{'request.state'} eq 'construct') {
1.337     albertel 4411:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
                   4412: 							  $titletable);
1.272     raeburn  4413:             } else {
1.336     albertel 4414:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359     albertel 4415: 		    $titletable;
1.272     raeburn  4416:             }
1.235     raeburn  4417:         }
                   4418:         return $bodytag;
1.94      www      4419:     }
1.95      www      4420: 
1.93      www      4421: #
1.95      www      4422: # Top frame rendering, Remote is up
1.93      www      4423: #
1.359     albertel 4424: 
1.517     raeburn  4425:     my $imgsrc = $img;
                   4426:     if ($img =~ /^\/adm/) {
1.575     albertel 4427:         $imgsrc = &lonhttpdurl($img);
1.517     raeburn  4428:     }
                   4429:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359     albertel 4430: 
1.305     www      4431:     # Explicit link to get inline menu
1.361     albertel 4432:     my $menu= ($no_inline_link?''
                   4433: 	       :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245     matthew  4434:     #
1.94      www      4435:     return(<<ENDBODY);
1.60      matthew  4436: $bodytag
1.359     albertel 4437: <table id="LC_title_bar" class="LC_with_remote">
1.791     tempelho 4438: <tr><td>$upperleft</td>
                   4439:     <td>$messages&nbsp;</td>
1.54      www      4440: </tr>
1.359     albertel 4441: <tr><td>$titleinfo $dc_info $menu</td>
                   4442: $roleinfo
1.368     albertel 4443: </tr>
1.356     albertel 4444: </table>
1.54      www      4445: ENDBODY
1.182     matthew  4446: }
                   4447: 
1.330     albertel 4448: sub make_attr_string {
                   4449:     my ($register,$attr_ref) = @_;
                   4450: 
                   4451:     if ($attr_ref && !ref($attr_ref)) {
                   4452: 	die("addentries Must be a hash ref ".
                   4453: 	    join(':',caller(1))." ".
                   4454: 	    join(':',caller(0))." ");
                   4455:     }
                   4456: 
                   4457:     if ($register) {
1.339     albertel 4458: 	my ($on_load,$on_unload);
                   4459: 	foreach my $key (keys(%{$attr_ref})) {
                   4460: 	    if      (lc($key) eq 'onload') {
                   4461: 		$on_load.=$attr_ref->{$key}.';';
                   4462: 		delete($attr_ref->{$key});
                   4463: 
                   4464: 	    } elsif (lc($key) eq 'onunload') {
                   4465: 		$on_unload.=$attr_ref->{$key}.';';
                   4466: 		delete($attr_ref->{$key});
                   4467: 	    }
                   4468: 	}
                   4469: 	$attr_ref->{'onload'}  =
                   4470: 	    &Apache::lonmenu::loadevents().  $on_load;
                   4471: 	$attr_ref->{'onunload'}=
                   4472: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   4473:     }
                   4474: 
                   4475: # Accessibility font enhance
                   4476:     if ($env{'browser.fontenhance'} eq 'on') {
                   4477: 	my $style;
                   4478: 	foreach my $key (keys(%{$attr_ref})) {
                   4479: 	    if (lc($key) eq 'style') {
                   4480: 		$style.=$attr_ref->{$key}.';';
                   4481: 		delete($attr_ref->{$key});
                   4482: 	    }
                   4483: 	}
                   4484: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 4485:     }
1.339     albertel 4486: 
1.330     albertel 4487:     my $attr_string;
                   4488:     foreach my $attr (keys(%$attr_ref)) {
                   4489: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4490:     }
                   4491:     return $attr_string;
                   4492: }
                   4493: 
                   4494: 
1.182     matthew  4495: ###############################################
1.251     albertel 4496: ###############################################
                   4497: 
                   4498: =pod
                   4499: 
                   4500: =item * &endbodytag()
                   4501: 
                   4502: Returns a uniform footer for LON-CAPA web pages.
                   4503: 
1.635     raeburn  4504: Inputs: 1 - optional reference to an args hash
                   4505: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4506: a 'Continue' link is not displayed if the page contains an
                   4507: internal redirect in the <head></head> section,
                   4508: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4509: 
                   4510: =cut
                   4511: 
                   4512: sub endbodytag {
1.635     raeburn  4513:     my ($args) = @_;
1.251     albertel 4514:     my $endbodytag='</body>';
1.269     albertel 4515:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4516:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4517:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4518: 	    $endbodytag=
                   4519: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4520: 	        &mt('Continue').'</a>'.
                   4521: 	        $endbodytag;
                   4522:         }
1.315     albertel 4523:     }
1.251     albertel 4524:     return $endbodytag;
                   4525: }
                   4526: 
1.352     albertel 4527: =pod
                   4528: 
                   4529: =item * &standard_css()
                   4530: 
                   4531: Returns a style sheet
                   4532: 
                   4533: Inputs: (all optional)
                   4534:             domain         -> force to color decorate a page for a specific
                   4535:                                domain
                   4536:             function       -> force usage of a specific rolish color scheme
                   4537:             bgcolor        -> override the default page bgcolor
                   4538: 
                   4539: =cut
                   4540: 
1.343     albertel 4541: sub standard_css {
1.345     albertel 4542:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4543:     $function  = &get_users_function() if (!$function);
                   4544:     my $img    = &designparm($function.'.img',   $domain);
                   4545:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4546:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4547:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4548: #second colour for later usage
1.345     albertel 4549:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4550:     my $pgbg_or_bgcolor =
                   4551: 	         $bgcolor ||
1.352     albertel 4552: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4553:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4554:     my $alink  = &designparm($function.'.alink', $domain);
                   4555:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4556:     my $link   = &designparm($function.'.link',  $domain);
                   4557: 
1.704     muellerd 4558:     my $loginbg = &designparm('login.sidebg',$domain);
1.712     muellerd 4559:     my $bgcol = &designparm('login.bgcol',$domain);
                   4560:     my $textcol = &designparm('login.textcol',$domain);
1.704     muellerd 4561: 
1.602     albertel 4562:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4563:     my $mono                 = 'monospace';
1.352     albertel 4564:     my $data_table_head      = $tabbg;
                   4565:     my $data_table_light     = '#EEEEEE';
1.470     banghart 4566:     my $data_table_dark      = '#DDDDDD';
                   4567:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4568:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4569:     my $mail_new             = '#FFBB77';
                   4570:     my $mail_new_hover       = '#DD9955';
                   4571:     my $mail_read            = '#BBBB77';
                   4572:     my $mail_read_hover      = '#999944';
                   4573:     my $mail_replied         = '#AAAA88';
                   4574:     my $mail_replied_hover   = '#888855';
                   4575:     my $mail_other           = '#99BBBB';
                   4576:     my $mail_other_hover     = '#669999';
1.391     albertel 4577:     my $table_header         = '#DDDDDD';
1.489     raeburn  4578:     my $feedback_link_bg     = '#BBBBBB';
1.701     harmsja  4579:     my $lg_border_color	     = '#C8C8C8';
1.392     albertel 4580: 
1.608     albertel 4581:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.803     bisitz   4582: 		  $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   4583: 	                                                 : '0 3px 0 4px';
1.448     albertel 4584: 
1.523     albertel 4585: 
1.343     albertel 4586:     return <<END;
1.795     www      4587: body {
                   4588:    font-family: $sans;
                   4589:    line-height:130%;
                   4590:    font-size:0.83em;
                   4591:    color:$font;
                   4592: }
                   4593: 
                   4594: a:link, a:visited { 
                   4595:   font-size:100%; 
                   4596: }
                   4597: 
                   4598: a:focus { 
                   4599:   color: red;
                   4600:   background: yellow 
                   4601: }
1.698     harmsja  4602: 
1.795     www      4603: form, .inline { 
                   4604:    display: inline; 
                   4605: }
1.721     harmsja  4606: 
1.795     www      4607: .LC_right {
                   4608:    text-align:right;
                   4609: }
                   4610: 
                   4611: .LC_middle {
                   4612:    vertical-align:middle;
                   4613: }
1.721     harmsja  4614: 
                   4615: /* just for tests */
1.754     droeschl 4616: .LC_400Box {width:400px; }
1.721     harmsja  4617: /* end */
                   4618: 
1.778     bisitz   4619: .LC_filename {
                   4620:   font-family: $mono;
                   4621:   white-space:pre;
                   4622: }
                   4623: 
                   4624: .LC_fileicon {
                   4625:   border: none;
                   4626:   height: 1.3em;
                   4627:   vertical-align: text-bottom;
                   4628:   margin-right: 0.3em;
                   4629:   text-decoration:none;
                   4630: }
                   4631: 
1.350     albertel 4632: .LC_error {
                   4633:   color: red;
                   4634:   font-size: larger;
                   4635: }
1.795     www      4636: 
1.457     albertel 4637: .LC_warning,
                   4638: .LC_diff_removed {
1.733     bisitz   4639:   color: red;
1.394     albertel 4640: }
1.532     albertel 4641: 
                   4642: .LC_info,
1.457     albertel 4643: .LC_success,
                   4644: .LC_diff_added {
1.350     albertel 4645:   color: green;
                   4646: }
1.795     www      4647: 
1.802     bisitz   4648: div.LC_confirm_box {
                   4649:   background-color: #FAFAFA;
                   4650:   border: 1px solid $lg_border_color;
                   4651:   margin-right: 0;
                   4652:   padding: 5px;
                   4653: }
                   4654: 
                   4655: div.LC_confirm_box .LC_error img,
                   4656: div.LC_confirm_box .LC_success img {
                   4657:   vertical-align: middle;
                   4658: }
                   4659: 
1.440     albertel 4660: .LC_icon {
1.771     droeschl 4661:   border: none;
1.790     droeschl 4662:   vertical-align: middle;
1.771     droeschl 4663: }
                   4664: 
1.543     albertel 4665: .LC_docs_spacer {
                   4666:   width: 25px;
                   4667:   height: 1px;
1.771     droeschl 4668:   border: none;
1.543     albertel 4669: }
1.346     albertel 4670: 
1.532     albertel 4671: .LC_internal_info {
1.735     bisitz   4672:   color: #999999;
1.532     albertel 4673: }
                   4674: 
1.794     www      4675: .LC_discussion {
                   4676:    background: $tabbg;
                   4677:    border: 1px solid black;
                   4678:    margin: 2px;
                   4679: }
                   4680: 
                   4681: .LC_disc_action_links_bar {
                   4682:    background: $tabbg;
1.803     bisitz   4683:    border: none;
1.795     www      4684:    margin: 4px;
1.794     www      4685: }
                   4686: 
                   4687: .LC_disc_action_left {
                   4688:    text-align: left;
                   4689: }
                   4690: 
                   4691: .LC_disc_action_right {
                   4692:    text-align: right;
                   4693: }
                   4694: 
                   4695: .LC_disc_new_item {
                   4696:    background: white;
                   4697:    border: 2px solid red;
                   4698:    margin: 2px;
                   4699: }
                   4700: 
                   4701: .LC_disc_old_item {
                   4702:    background: white;
                   4703:    border: 1px solid black;
                   4704:    margin: 2px;
                   4705: }
                   4706: 
1.458     albertel 4707: table.LC_pastsubmission {
                   4708:   border: 1px solid black;
                   4709:   margin: 2px;
                   4710: }
                   4711: 
1.795     www      4712: table#LC_top_nav,
                   4713: table#LC_menubuttons,
                   4714: table#LC_nav_location {
1.345     albertel 4715:   width: 100%;
                   4716:   background: $pgbg;
1.392     albertel 4717:   border: 2px;
1.402     albertel 4718:   border-collapse: separate;
1.803     bisitz   4719:   padding: 0;
1.345     albertel 4720: }
1.392     albertel 4721: 
1.801     tempelho 4722: table#LC_title_bar a {
                   4723:   color: $fontmenu;
                   4724: }
1.808     droeschl 4725:     
1.807     droeschl 4726: table#LC_title_bar {
1.819     tempelho 4727:   clear: both;
1.807     droeschl 4728:   /*display: none;*/
                   4729: }
                   4730: 
1.795     www      4731: table#LC_title_bar,
                   4732: table.LC_breadcrumbs,
1.393     albertel 4733: table#LC_title_bar.LC_with_remote {
1.359     albertel 4734:   width: 100%;
1.392     albertel 4735:   border-color: $pgbg;
                   4736:   border-style: solid;
                   4737:   border-width: $border;
1.379     albertel 4738:   background: $pgbg;
1.801     tempelho 4739:   color: $fontmenu;
1.392     albertel 4740:   border-collapse: collapse;
1.803     bisitz   4741:   padding: 0;
1.819     tempelho 4742:   margin: 0;
1.359     albertel 4743: }
1.795     www      4744: 
1.409     albertel 4745: table.LC_docs_path {
                   4746:   width: 100%;
                   4747:   border: 0;
                   4748:   background: $pgbg;
                   4749:   border-collapse: collapse;
1.803     bisitz   4750:   padding: 0;
1.409     albertel 4751: }
                   4752: 
1.359     albertel 4753: table#LC_title_bar td {
                   4754:   background: $tabbg;
                   4755: }
1.795     www      4756: 
1.773     ehlerst  4757: table#LC_title_bar .LC_title_bar_who {
1.359     albertel 4758:   background: $tabbg;
1.801     tempelho 4759:   color: $fontmenu;
1.827     bisitz   4760:   font: small;
1.359     albertel 4761:   text-align: right;
1.803     bisitz   4762:   margin: 0;
1.773     ehlerst  4763: }
1.795     www      4764: 
1.819     tempelho 4765: table#LC_title_bar div.LC_title_bar_name {
1.803     bisitz   4766:   margin: 0;
1.773     ehlerst  4767: }
1.795     www      4768: 
1.819     tempelho 4769: table#LC_title_bar div.LC_title_bar_role {
1.803     bisitz   4770:   margin: 0;
1.773     ehlerst  4771: }
1.795     www      4772: 
1.819     tempelho 4773: table#LC_title_bar div.LC_title_bar_realm {
1.803     bisitz   4774:   margin: 0;
1.359     albertel 4775: }
1.795     www      4776: 
1.706     harmsja  4777: table#LC_menubuttons img{
1.803     bisitz   4778:   border: none;
1.346     albertel 4779: }
1.795     www      4780: 
1.345     albertel 4781: table#LC_top_nav td {
                   4782:   background: $tabbg;
1.803     bisitz   4783:   border: none;
1.407     albertel 4784:   font-size: small;
1.706     harmsja  4785:   vertical-align:top;
                   4786:   padding:2px 5px 2px 5px;
1.345     albertel 4787: }
1.795     www      4788: 
                   4789: table#LC_top_nav td a,
                   4790: div#LC_top_nav a {
1.345     albertel 4791:   color: $font;
                   4792: }
1.795     www      4793: 
1.364     albertel 4794: table#LC_top_nav td.LC_top_nav_logo {
                   4795:   background: $tabbg;
1.432     albertel 4796:   text-align: left;
1.408     albertel 4797:   white-space: nowrap;
1.432     albertel 4798:   width: 31px;
1.408     albertel 4799: }
1.795     www      4800: 
1.408     albertel 4801: table#LC_top_nav td.LC_top_nav_logo img {
1.803     bisitz   4802:   border: none;
1.408     albertel 4803:   vertical-align: bottom;
1.364     albertel 4804: }
1.795     www      4805: 
1.777     tempelho 4806: table#LC_top_nav td.LC_top_nav_exit,
1.779     bisitz   4807: table#LC_top_nav td.LC_top_nav_help {
1.777     tempelho 4808:   width: 2.0em;
                   4809: }
1.795     www      4810: 
1.442     albertel 4811: table#LC_top_nav td.LC_top_nav_login {
                   4812:   width: 4.0em;
                   4813:   text-align: center;
                   4814: }
1.795     www      4815: 
                   4816: table.LC_breadcrumbs td,
                   4817: table.LC_docs_path td  {
1.357     albertel 4818:   background: $tabbg;
1.801     tempelho 4819:   color: $fontmenu;
1.358     albertel 4820:   font-size: smaller;
1.357     albertel 4821: }
1.795     www      4822: 
1.777     tempelho 4823: table.LC_breadcrumbs td.LC_breadcrumbs_component,
                   4824: table.LC_docs_path td.LC_docs_path_component {
1.779     bisitz   4825:   background: $tabbg;
1.801     tempelho 4826:   color: $fontmenu;
1.779     bisitz   4827:   font-size: larger;
                   4828:   text-align: right;
1.777     tempelho 4829: }
1.795     www      4830: 
1.383     albertel 4831: td.LC_table_cell_checkbox {
                   4832:   text-align: center;
                   4833: }
1.795     www      4834: 
1.779     bisitz   4835: table#LC_mainmenu td.LC_mainmenu_column {
                   4836:     vertical-align: top;
1.777     tempelho 4837: }
1.522     albertel 4838: 
1.795     www      4839: .LC_fontsize_small {
1.705     tempelho 4840:  font-size: 70%;
                   4841: }
                   4842: 
1.819     tempelho 4843: #LC_head_subbox {
                   4844:  clear:both;
                   4845:  background: $sidebg;
1.822     bisitz   4846:  border-bottom: 1px solid $lg_border_color;
1.819     tempelho 4847:  height: 32px;
                   4848:  line-height: 32px; 
1.822     bisitz   4849:  margin: 0;
1.819     tempelho 4850:  padding: 0;
                   4851: }
                   4852: 
1.822     bisitz   4853: #LC_head_subbox2 { /* FIXME: replace by LC_head_subbox once lonhtmlcommon::breadcrumbs has been fixed */
                   4854:  clear:both;
                   4855:  background: #F8F8F8; /* $sidebg; */
                   4856:  border-bottom: 1px solid $lg_border_color;
                   4857:  margin: 0 0 10px 0;
                   4858:  padding: 5px;
                   4859: }
                   4860: 
1.795     www      4861: .LC_fontsize_medium {
1.705     tempelho 4862:  font-size: 85%;
                   4863: }
                   4864: 
1.795     www      4865: .LC_fontsize_large {
1.705     tempelho 4866:  font-size: 120%;
                   4867: }
                   4868: 
1.346     albertel 4869: .LC_menubuttons_inline_text {
                   4870:   color: $font;
1.698     harmsja  4871:   font-size: 90%;
1.701     harmsja  4872:   padding-left:3px;
1.346     albertel 4873: }
                   4874: 
1.526     www      4875: .LC_menubuttons_link {
                   4876:   text-decoration: none;
                   4877: }
1.795     www      4878: 
1.522     albertel 4879: .LC_menubuttons_category {
1.521     www      4880:   color: $font;
1.526     www      4881:   background: $pgbg;
1.521     www      4882:   font-size: larger;
                   4883:   font-weight: bold;
                   4884: }
                   4885: 
1.346     albertel 4886: td.LC_menubuttons_text {
1.779     bisitz   4887:  	color: $font;
1.346     albertel 4888: }
1.706     harmsja  4889: 
1.346     albertel 4890: .LC_current_location {
                   4891:   background: $tabbg;
                   4892: }
1.795     www      4893: 
1.346     albertel 4894: .LC_new_mail {
1.634     www      4895:   background: $tabbg;
1.346     albertel 4896:   font-weight: bold;
                   4897: }
1.347     albertel 4898: 
1.666     raeburn  4899: .LC_roleslog_note {
1.701     harmsja  4900:   font-size: small;
1.666     raeburn  4901: }
                   4902: 
1.715     raeburn  4903: .LC_mail_functions {
                   4904:     font-weight: bold;
                   4905: }
                   4906: 
1.795     www      4907: table.LC_data_table,
                   4908: table.LC_mail_list {
1.347     albertel 4909:   border: 1px solid #000000;
1.402     albertel 4910:   border-collapse: separate;
1.426     albertel 4911:   border-spacing: 1px;
1.610     albertel 4912:   background: $pgbg;
1.347     albertel 4913: }
1.795     www      4914: 
1.422     albertel 4915: .LC_data_table_dense {
                   4916:   font-size: small;
                   4917: }
1.795     www      4918: 
1.507     raeburn  4919: table.LC_nested_outer {
                   4920:   border: 1px solid #000000;
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: 
1.507     raeburn  4926: table.LC_nested {
1.803     bisitz   4927:   border: none;
1.589     raeburn  4928:   border-collapse: collapse;
1.803     bisitz   4929:   border-spacing: 0;
1.507     raeburn  4930:   width: 100%;
                   4931: }
1.795     www      4932: 
                   4933: table.LC_data_table tr th, 
                   4934: table.LC_calendar tr th, 
                   4935: table.LC_mail_list tr th,
1.523     albertel 4936: table.LC_prior_tries tr th {
1.349     albertel 4937:   font-weight: bold;
                   4938:   background-color: $data_table_head;
1.801     tempelho 4939:   color:$fontmenu;
1.701     harmsja  4940:   font-size:90%;
1.347     albertel 4941: }
1.795     www      4942: 
1.711     raeburn  4943: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   4944:   background-color: #CCCCCC;
1.711     raeburn  4945:   font-weight: bold;
                   4946:   text-align: left;
                   4947: }
1.795     www      4948: 
1.779     bisitz   4949: table.LC_data_table tr.LC_odd_row > td,
1.809     bisitz   4950: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 4951:   background-color: $data_table_light;
1.425     albertel 4952:   padding: 2px;
1.347     albertel 4953: }
1.795     www      4954: 
1.610     albertel 4955: table.LC_data_table tr.LC_even_row > td,
1.809     bisitz   4956: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 4957:   background-color: $data_table_dark;
1.709     bisitz   4958:   padding: 2px;
1.347     albertel 4959: }
1.795     www      4960: 
1.425     albertel 4961: table.LC_data_table tr.LC_data_table_highlight td {
                   4962:   background-color: $data_table_darker;
                   4963: }
1.795     www      4964: 
1.639     raeburn  4965: table.LC_data_table tr td.LC_leftcol_header {
                   4966:   background-color: $data_table_head;
                   4967:   font-weight: bold;
                   4968: }
1.795     www      4969: 
1.451     albertel 4970: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  4971: table.LC_nested tr.LC_empty_row td {
1.347     albertel 4972:   background-color: #FFFFFF;
1.421     albertel 4973:   font-weight: bold;
                   4974:   font-style: italic;
                   4975:   text-align: center;
                   4976:   padding: 8px;
1.347     albertel 4977: }
1.795     www      4978: 
1.507     raeburn  4979: table.LC_nested tr.LC_empty_row td {
1.465     albertel 4980:   padding: 4ex
                   4981: }
1.795     www      4982: 
1.507     raeburn  4983: table.LC_nested_outer tr th {
                   4984:   font-weight: bold;
1.801     tempelho 4985:   color:$fontmenu;
1.507     raeburn  4986:   background-color: $data_table_head;
1.701     harmsja  4987:   font-size: small;
1.507     raeburn  4988:   border-bottom: 1px solid #000000;
                   4989: }
1.795     www      4990: 
1.507     raeburn  4991: table.LC_nested_outer tr td.LC_subheader {
                   4992:   background-color: $data_table_head;
                   4993:   font-weight: bold;
                   4994:   font-size: small;
                   4995:   border-bottom: 1px solid #000000;
                   4996:   text-align: right;
1.451     albertel 4997: }
1.795     www      4998: 
1.507     raeburn  4999: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5000:   background-color: #CCCCCC;
1.451     albertel 5001:   font-weight: bold;
                   5002:   font-size: small;
1.507     raeburn  5003:   text-align: center;
                   5004: }
1.795     www      5005: 
1.589     raeburn  5006: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5007: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5008:   text-align: left;
1.451     albertel 5009: }
1.795     www      5010: 
1.507     raeburn  5011: table.LC_nested td {
1.735     bisitz   5012:   background-color: #FFFFFF;
1.451     albertel 5013:   font-size: small;
1.507     raeburn  5014: }
1.795     www      5015: 
1.507     raeburn  5016: table.LC_nested_outer tr th.LC_right_item,
                   5017: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5018: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5019: table.LC_nested tr td.LC_right_item {
1.451     albertel 5020:   text-align: right;
                   5021: }
                   5022: 
1.507     raeburn  5023: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5024:   background-color: #EEEEEE;
1.451     albertel 5025: }
                   5026: 
1.473     raeburn  5027: table.LC_createuser {
                   5028: }
                   5029: 
                   5030: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5031:   font-size: small;
1.473     raeburn  5032: }
                   5033: 
                   5034: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5035:   background-color: #CCCCCC;
1.473     raeburn  5036:   font-weight: bold;
                   5037:   text-align: center;
                   5038: }
                   5039: 
1.349     albertel 5040: table.LC_calendar {
                   5041:   border: 1px solid #000000;
                   5042:   border-collapse: collapse;
                   5043: }
1.795     www      5044: 
1.349     albertel 5045: table.LC_calendar_pickdate {
                   5046:   font-size: xx-small;
                   5047: }
1.795     www      5048: 
1.349     albertel 5049: table.LC_calendar tr td {
                   5050:   border: 1px solid #000000;
                   5051:   vertical-align: top;
                   5052: }
1.795     www      5053: 
1.349     albertel 5054: table.LC_calendar tr td.LC_calendar_day_empty {
                   5055:   background-color: $data_table_dark;
                   5056: }
1.795     www      5057: 
1.779     bisitz   5058: table.LC_calendar tr td.LC_calendar_day_current {
                   5059:   background-color: $data_table_highlight;
1.777     tempelho 5060: }
1.795     www      5061: 
1.349     albertel 5062: table.LC_mail_list tr.LC_mail_new {
                   5063:   background-color: $mail_new;
                   5064: }
1.795     www      5065: 
1.349     albertel 5066: table.LC_mail_list tr.LC_mail_new:hover {
                   5067:   background-color: $mail_new_hover;
                   5068: }
1.795     www      5069: 
                   5070: table.LC_mail_list tr.LC_mail_even {
1.777     tempelho 5071: }
1.795     www      5072: 
                   5073: table.LC_mail_list tr.LC_mail_odd {
1.777     tempelho 5074: }
1.795     www      5075: 
1.349     albertel 5076: table.LC_mail_list tr.LC_mail_read {
                   5077:   background-color: $mail_read;
                   5078: }
1.795     www      5079: 
1.349     albertel 5080: table.LC_mail_list tr.LC_mail_read:hover {
                   5081:   background-color: $mail_read_hover;
                   5082: }
1.795     www      5083: 
1.349     albertel 5084: table.LC_mail_list tr.LC_mail_replied {
                   5085:   background-color: $mail_replied;
                   5086: }
1.795     www      5087: 
1.349     albertel 5088: table.LC_mail_list tr.LC_mail_replied:hover {
                   5089:   background-color: $mail_replied_hover;
                   5090: }
1.795     www      5091: 
1.349     albertel 5092: table.LC_mail_list tr.LC_mail_other {
                   5093:   background-color: $mail_other;
                   5094: }
1.795     www      5095: 
1.349     albertel 5096: table.LC_mail_list tr.LC_mail_other:hover {
                   5097:   background-color: $mail_other_hover;
                   5098: }
1.494     raeburn  5099: 
1.777     tempelho 5100: table.LC_data_table tr > td.LC_browser_file,
                   5101: table.LC_data_table tr > td.LC_browser_file_published {
1.389     albertel 5102:   background: #CCFF88;
                   5103: }
1.795     www      5104: 
1.777     tempelho 5105: table.LC_data_table tr > td.LC_browser_file_locked,
                   5106: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5107:   background: #FFAA99;
1.387     albertel 5108: }
1.795     www      5109: 
1.777     tempelho 5110: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.779     bisitz   5111:   background: #AAAAAA;
                   5112: }
1.795     www      5113: 
1.777     tempelho 5114: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5115: table.LC_data_table tr > td.LC_browser_file_metamodified {
                   5116:   background: #FFFF77;
1.777     tempelho 5117: }
1.795     www      5118: 
1.696     bisitz   5119: table.LC_data_table tr.LC_browser_folder > td {
1.389     albertel 5120:   background: #CCCCFF;
1.387     albertel 5121: }
1.696     bisitz   5122: 
1.707     bisitz   5123: table.LC_data_table tr > td.LC_roles_is {
                   5124: /*  background: #77FF77; */
                   5125: }
1.795     www      5126: 
1.707     bisitz   5127: table.LC_data_table tr > td.LC_roles_future {
                   5128:   background: #FFFF77;
                   5129: }
1.795     www      5130: 
1.707     bisitz   5131: table.LC_data_table tr > td.LC_roles_will {
                   5132:   background: #FFAA77;
                   5133: }
1.795     www      5134: 
1.707     bisitz   5135: table.LC_data_table tr > td.LC_roles_expired {
                   5136:   background: #FF7777;
                   5137: }
1.795     www      5138: 
1.707     bisitz   5139: table.LC_data_table tr > td.LC_roles_will_not {
                   5140:   background: #AAFF77;
                   5141: }
1.795     www      5142: 
1.707     bisitz   5143: table.LC_data_table tr > td.LC_roles_selected {
                   5144:   background: #11CC55;
                   5145: }
                   5146: 
1.388     albertel 5147: span.LC_current_location {
1.701     harmsja  5148:   font-size:larger;
1.388     albertel 5149:   background: $pgbg;
                   5150: }
1.387     albertel 5151: 
1.395     albertel 5152: span.LC_parm_menu_item {
                   5153:   font-size: larger;
                   5154: }
1.795     www      5155: 
1.395     albertel 5156: span.LC_parm_scope_all {
                   5157:   color: red;
                   5158: }
1.795     www      5159: 
1.395     albertel 5160: span.LC_parm_scope_folder {
                   5161:   color: green;
                   5162: }
1.795     www      5163: 
1.395     albertel 5164: span.LC_parm_scope_resource {
                   5165:   color: orange;
                   5166: }
1.795     www      5167: 
1.395     albertel 5168: span.LC_parm_part {
                   5169:   color: blue;
                   5170: }
1.795     www      5171: 
1.395     albertel 5172: span.LC_parm_folder, span.LC_parm_symb {
                   5173:   font-size: x-small;
                   5174:   font-family: $mono;
                   5175:   color: #AAAAAA;
                   5176: }
                   5177: 
1.795     www      5178: td.LC_parm_overview_level_menu,
                   5179: td.LC_parm_overview_map_menu,
                   5180: td.LC_parm_overview_parm_selectors,
                   5181: td.LC_parm_overview_restrictions  {
1.396     albertel 5182:   border: 1px solid black;
                   5183:   border-collapse: collapse;
                   5184: }
1.795     www      5185: 
1.396     albertel 5186: table.LC_parm_overview_restrictions td {
                   5187:   border-width: 1px 4px 1px 4px;
                   5188:   border-style: solid;
                   5189:   border-color: $pgbg;
                   5190:   text-align: center;
                   5191: }
1.795     www      5192: 
1.396     albertel 5193: table.LC_parm_overview_restrictions th {
                   5194:   background: $tabbg;
                   5195:   border-width: 1px 4px 1px 4px;
                   5196:   border-style: solid;
                   5197:   border-color: $pgbg;
                   5198: }
1.795     www      5199: 
1.398     albertel 5200: table#LC_helpmenu {
1.803     bisitz   5201:   border: none;
1.398     albertel 5202:   height: 55px;
1.803     bisitz   5203:   border-spacing: 0;
1.398     albertel 5204: }
                   5205: 
                   5206: table#LC_helpmenu fieldset legend {
                   5207:   font-size: larger;
                   5208:   font-weight: bold;
                   5209: }
1.795     www      5210: 
1.397     albertel 5211: table#LC_helpmenu_links {
                   5212:   width: 100%;
                   5213:   border: 1px solid black;
                   5214:   background: $pgbg;
1.803     bisitz   5215:   padding: 0;
1.397     albertel 5216:   border-spacing: 1px;
                   5217: }
1.795     www      5218: 
1.397     albertel 5219: table#LC_helpmenu_links tr td {
                   5220:   padding: 1px;
                   5221:   background: $tabbg;
1.399     albertel 5222:   text-align: center;
                   5223:   font-weight: bold;
1.397     albertel 5224: }
1.396     albertel 5225: 
1.795     www      5226: table#LC_helpmenu_links a:link,
                   5227: table#LC_helpmenu_links a:visited,
1.397     albertel 5228: table#LC_helpmenu_links a:active {
                   5229:   text-decoration: none;
                   5230:   color: $font;
                   5231: }
1.795     www      5232: 
1.397     albertel 5233: table#LC_helpmenu_links a:hover {
                   5234:   text-decoration: underline;
                   5235:   color: $vlink;
                   5236: }
1.396     albertel 5237: 
1.417     albertel 5238: .LC_chrt_popup_exists {
                   5239:   border: 1px solid #339933;
                   5240:   margin: -1px;
                   5241: }
1.795     www      5242: 
1.417     albertel 5243: .LC_chrt_popup_up {
                   5244:   border: 1px solid yellow;
                   5245:   margin: -1px;
                   5246: }
1.795     www      5247: 
1.417     albertel 5248: .LC_chrt_popup {
                   5249:   border: 1px solid #8888FF;
                   5250:   background: #CCCCFF;
                   5251: }
1.795     www      5252: 
1.421     albertel 5253: table.LC_pick_box {
                   5254:   border-collapse: separate;
                   5255:   background: white;
                   5256:   border: 1px solid black;
                   5257:   border-spacing: 1px;
                   5258: }
1.795     www      5259: 
1.421     albertel 5260: table.LC_pick_box td.LC_pick_box_title {
                   5261:   background: $tabbg;
                   5262:   font-weight: bold;
                   5263:   text-align: right;
1.740     bisitz   5264:   vertical-align: top;
1.421     albertel 5265:   width: 184px;
                   5266:   padding: 8px;
                   5267: }
1.795     www      5268: 
1.645     raeburn  5269: table.LC_pick_box td.LC_selfenroll_pick_box_title {
                   5270:   background: $tabbg;
                   5271:   font-weight: bold;
                   5272:   text-align: right;
                   5273:   width: 350px;
                   5274:   padding: 8px;
                   5275: }
                   5276: 
1.579     raeburn  5277: table.LC_pick_box td.LC_pick_box_value {
                   5278:   text-align: left;
                   5279:   padding: 8px;
                   5280: }
1.795     www      5281: 
1.579     raeburn  5282: table.LC_pick_box td.LC_pick_box_select {
                   5283:   text-align: left;
                   5284:   padding: 8px;
                   5285: }
1.795     www      5286: 
1.424     albertel 5287: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5288:   padding: 0;
1.421     albertel 5289:   height: 1px;
                   5290:   background: black;
                   5291: }
1.795     www      5292: 
1.421     albertel 5293: table.LC_pick_box td.LC_pick_box_submit {
                   5294:   text-align: right;
                   5295: }
1.795     www      5296: 
1.579     raeburn  5297: table.LC_pick_box td.LC_evenrow_value {
                   5298:   text-align: left;
                   5299:   padding: 8px;
                   5300:   background-color: $data_table_light;
                   5301: }
1.795     www      5302: 
1.579     raeburn  5303: table.LC_pick_box td.LC_oddrow_value {
                   5304:   text-align: left;
                   5305:   padding: 8px;
                   5306:   background-color: $data_table_light;
                   5307: }
1.795     www      5308: 
1.579     raeburn  5309: table.LC_helpform_receipt {
                   5310:   width: 620px;
                   5311:   border-collapse: separate;
                   5312:   background: white;
                   5313:   border: 1px solid black;
                   5314:   border-spacing: 1px;
                   5315: }
1.795     www      5316: 
1.579     raeburn  5317: table.LC_helpform_receipt td.LC_pick_box_title {
                   5318:   background: $tabbg;
                   5319:   font-weight: bold;
                   5320:   text-align: right;
                   5321:   width: 184px;
                   5322:   padding: 8px;
                   5323: }
1.795     www      5324: 
1.579     raeburn  5325: table.LC_helpform_receipt td.LC_evenrow_value {
                   5326:   text-align: left;
                   5327:   padding: 8px;
                   5328:   background-color: $data_table_light;
                   5329: }
1.795     www      5330: 
1.579     raeburn  5331: table.LC_helpform_receipt td.LC_oddrow_value {
                   5332:   text-align: left;
                   5333:   padding: 8px;
                   5334:   background-color: $data_table_light;
                   5335: }
1.795     www      5336: 
1.579     raeburn  5337: table.LC_helpform_receipt td.LC_pick_box_separator {
1.803     bisitz   5338:   padding: 0;
1.579     raeburn  5339:   height: 1px;
                   5340:   background: black;
                   5341: }
1.795     www      5342: 
1.579     raeburn  5343: span.LC_helpform_receipt_cat {
                   5344:   font-weight: bold;
                   5345: }
1.795     www      5346: 
1.424     albertel 5347: table.LC_group_priv_box {
                   5348:   background: white;
                   5349:   border: 1px solid black;
                   5350:   border-spacing: 1px;
                   5351: }
1.795     www      5352: 
1.424     albertel 5353: table.LC_group_priv_box td.LC_pick_box_title {
                   5354:   background: $tabbg;
                   5355:   font-weight: bold;
                   5356:   text-align: right;
                   5357:   width: 184px;
                   5358: }
1.795     www      5359: 
1.424     albertel 5360: table.LC_group_priv_box td.LC_groups_fixed {
                   5361:   background: $data_table_light;
                   5362:   text-align: center;
                   5363: }
1.795     www      5364: 
1.424     albertel 5365: table.LC_group_priv_box td.LC_groups_optional {
                   5366:   background: $data_table_dark;
                   5367:   text-align: center;
                   5368: }
1.795     www      5369: 
1.424     albertel 5370: table.LC_group_priv_box td.LC_groups_functionality {
                   5371:   background: $data_table_darker;
                   5372:   text-align: center;
                   5373:   font-weight: bold;
                   5374: }
1.795     www      5375: 
1.424     albertel 5376: table.LC_group_priv td {
                   5377:   text-align: left;
1.803     bisitz   5378:   padding: 0;
1.424     albertel 5379: }
                   5380: 
1.421     albertel 5381: table.LC_notify_front_page {
                   5382:   background: white;
                   5383:   border: 1px solid black;
                   5384:   padding: 8px;
                   5385: }
1.795     www      5386: 
1.421     albertel 5387: table.LC_notify_front_page td {
                   5388:   padding: 8px;
                   5389: }
1.795     www      5390: 
1.424     albertel 5391: .LC_navbuttons {
                   5392:   margin: 2ex 0ex 2ex 0ex;
                   5393: }
1.795     www      5394: 
1.423     albertel 5395: .LC_topic_bar {
                   5396:   font-weight: bold;
                   5397:   width: 100%;
                   5398:   background: $tabbg;
                   5399:   vertical-align: middle;
                   5400:   margin: 2ex 0ex 2ex 0ex;
1.805     bisitz   5401:   padding: 3px;
1.423     albertel 5402: }
1.795     www      5403: 
1.423     albertel 5404: .LC_topic_bar span {
                   5405:   vertical-align: middle;
                   5406: }
1.795     www      5407: 
1.423     albertel 5408: .LC_topic_bar img {
                   5409:   vertical-align: bottom;
                   5410: }
1.795     www      5411: 
1.423     albertel 5412: table.LC_course_group_status {
                   5413:   margin: 20px;
                   5414: }
1.795     www      5415: 
1.423     albertel 5416: table.LC_status_selector td {
                   5417:   vertical-align: top;
                   5418:   text-align: center;
1.424     albertel 5419:   padding: 4px;
                   5420: }
1.795     www      5421: 
1.599     albertel 5422: div.LC_feedback_link {
1.616     albertel 5423:   clear: both;
1.829   ! kalberla 5424:   background: $sidebg;
1.779     bisitz   5425:   width: 100%;
1.829   ! kalberla 5426:   padding-bottom: 10px;
        !          5427:   border: 1px $tabbg solid;
        !          5428: }
        !          5429: 
        !          5430: div.LC_feedback_link a{
        !          5431:   text-decoration: none;
1.489     raeburn  5432: }
1.795     www      5433: 
1.489     raeburn  5434: span.LC_feedback_link {
1.829   ! kalberla 5435:   //background: $feedback_link_bg;
1.599     albertel 5436:   font-size: larger;
                   5437: }
1.795     www      5438: 
1.599     albertel 5439: span.LC_message_link {
1.829   ! kalberla 5440:   //background: $feedback_link_bg;
1.599     albertel 5441:   font-size: larger;
                   5442:   position: absolute;
                   5443:   right: 1em;
1.489     raeburn  5444: }
1.421     albertel 5445: 
1.515     albertel 5446: table.LC_prior_tries {
1.524     albertel 5447:   border: 1px solid #000000;
                   5448:   border-collapse: separate;
                   5449:   border-spacing: 1px;
1.515     albertel 5450: }
1.523     albertel 5451: 
1.515     albertel 5452: table.LC_prior_tries td {
1.524     albertel 5453:   padding: 2px;
1.515     albertel 5454: }
1.523     albertel 5455: 
                   5456: .LC_answer_correct {
1.795     www      5457:   background: lightgreen;
                   5458:   color: darkgreen;
                   5459:   padding: 6px;
1.523     albertel 5460: }
1.795     www      5461: 
1.523     albertel 5462: .LC_answer_charged_try {
1.797     www      5463:   background: #FFAAAA;
1.795     www      5464:   color: darkred;
                   5465:   padding: 6px;
1.523     albertel 5466: }
1.795     www      5467: 
1.779     bisitz   5468: .LC_answer_not_charged_try,
1.523     albertel 5469: .LC_answer_no_grade,
                   5470: .LC_answer_late {
1.795     www      5471:   background: lightyellow;
1.523     albertel 5472:   color: black;
1.795     www      5473:   padding: 6px;
1.523     albertel 5474: }
1.795     www      5475: 
1.523     albertel 5476: .LC_answer_previous {
1.795     www      5477:   background: lightblue;
                   5478:   color: darkblue;
                   5479:   padding: 6px;
1.523     albertel 5480: }
1.795     www      5481: 
1.779     bisitz   5482: .LC_answer_no_message {
1.777     tempelho 5483:   background: #FFFFFF;
                   5484:   color: black;
1.795     www      5485:   padding: 6px;
1.779     bisitz   5486: }
1.795     www      5487: 
1.779     bisitz   5488: .LC_answer_unknown {
                   5489:   background: orange;
                   5490:   color: black;
1.795     www      5491:   padding: 6px;
1.777     tempelho 5492: }
1.795     www      5493: 
1.529     albertel 5494: span.LC_prior_numerical,
                   5495: span.LC_prior_string,
                   5496: span.LC_prior_custom,
                   5497: span.LC_prior_reaction,
                   5498: span.LC_prior_math {
1.523     albertel 5499:   font-family: monospace;
                   5500:   white-space: pre;
                   5501: }
                   5502: 
1.525     albertel 5503: span.LC_prior_string {
                   5504:   font-family: monospace;
                   5505:   white-space: pre;
                   5506: }
                   5507: 
1.523     albertel 5508: table.LC_prior_option {
                   5509:   width: 100%;
                   5510:   border-collapse: collapse;
                   5511: }
1.795     www      5512: 
                   5513: table.LC_prior_rank, 
                   5514: table.LC_prior_match {
1.528     albertel 5515:   border-collapse: collapse;
                   5516: }
1.795     www      5517: 
1.528     albertel 5518: table.LC_prior_option tr td,
                   5519: table.LC_prior_rank tr td,
                   5520: table.LC_prior_match tr td {
1.524     albertel 5521:   border: 1px solid #000000;
1.515     albertel 5522: }
                   5523: 
1.770     droeschl 5524: td.LC_nobreak,
1.519     raeburn  5525: span.LC_nobreak {
1.544     albertel 5526:   white-space: nowrap;
1.519     raeburn  5527: }
                   5528: 
1.576     raeburn  5529: span.LC_cusr_emph {
                   5530:   font-style: italic;
                   5531: }
                   5532: 
1.633     raeburn  5533: span.LC_cusr_subheading {
                   5534:   font-weight: normal;
                   5535:   font-size: 85%;
                   5536: }
                   5537: 
1.545     albertel 5538: table.LC_docs_documents {
                   5539:   background: #BBBBBB;
1.803     bisitz   5540:   border-width: 0;
1.545     albertel 5541:   border-collapse: collapse;
                   5542: }
1.795     www      5543: 
1.777     tempelho 5544: table.LC_docs_documents td.LC_docs_document {
1.779     bisitz   5545:   border: 2px solid black;
                   5546:   padding: 4px;
1.777     tempelho 5547: }
1.795     www      5548: 
1.545     albertel 5549: .LC_docs_entry_move {
1.803     bisitz   5550:   border: none;
1.545     albertel 5551:   border-collapse: collapse;
1.544     albertel 5552: }
                   5553: 
1.545     albertel 5554: .LC_docs_entry_move td {
                   5555:   border: 2px solid #BBBBBB;
                   5556:   background: #DDDDDD;
                   5557: }
                   5558: 
                   5559: .LC_docs_editor td.LC_docs_entry_commands {
                   5560:   background: #DDDDDD;
                   5561:   font-size: x-small;
                   5562: }
1.795     www      5563: 
1.544     albertel 5564: .LC_docs_copy {
1.545     albertel 5565:   color: #000099;
1.544     albertel 5566: }
1.795     www      5567: 
1.544     albertel 5568: .LC_docs_cut {
1.545     albertel 5569:   color: #550044;
1.544     albertel 5570: }
1.795     www      5571: 
1.544     albertel 5572: .LC_docs_rename {
1.545     albertel 5573:   color: #009900;
1.544     albertel 5574: }
1.795     www      5575: 
1.544     albertel 5576: .LC_docs_remove {
1.545     albertel 5577:   color: #990000;
                   5578: }
                   5579: 
1.547     albertel 5580: .LC_docs_reinit_warn,
                   5581: .LC_docs_ext_edit {
                   5582:   font-size: x-small;
                   5583: }
                   5584: 
1.545     albertel 5585: .LC_docs_editor td.LC_docs_entry_title,
                   5586: .LC_docs_editor td.LC_docs_entry_icon {
                   5587:   background: #FFFFBB;
                   5588: }
1.795     www      5589: 
1.545     albertel 5590: .LC_docs_editor td.LC_docs_entry_parameter {
                   5591:   background: #BBBBFF;
                   5592:   font-size: x-small;
                   5593:   white-space: nowrap;
                   5594: }
                   5595: 
                   5596: table.LC_docs_adddocs td,
                   5597: table.LC_docs_adddocs th {
                   5598:   border: 1px solid #BBBBBB;
                   5599:   padding: 4px;
                   5600:   background: #DDDDDD;
1.543     albertel 5601: }
                   5602: 
1.584     albertel 5603: table.LC_sty_begin {
                   5604:   background: #BBFFBB;
                   5605: }
1.795     www      5606: 
1.584     albertel 5607: table.LC_sty_end {
                   5608:   background: #FFBBBB;
                   5609: }
                   5610: 
1.589     raeburn  5611: table.LC_double_column {
1.803     bisitz   5612:   border-width: 0;
1.589     raeburn  5613:   border-collapse: collapse;
                   5614:   width: 100%;
                   5615:   padding: 2px;
                   5616: }
                   5617: 
                   5618: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5619:   top: 2px;
1.589     raeburn  5620:   left: 2px;
                   5621:   width: 47%;
                   5622:   vertical-align: top;
                   5623: }
                   5624: 
                   5625: table.LC_double_column tr td.LC_right_col {
                   5626:   top: 2px;
1.779     bisitz   5627:   right: 2px;
1.589     raeburn  5628:   width: 47%;
                   5629:   vertical-align: top;
                   5630: }
                   5631: 
1.594     raeburn  5632: span.LC_role_level {
                   5633:   font-weight: bold;
                   5634: }
                   5635: 
1.591     raeburn  5636: div.LC_left_float {
                   5637:   float: left;
                   5638:   padding-right: 5%;
1.597     albertel 5639:   padding-bottom: 4px;
1.591     raeburn  5640: }
                   5641: 
                   5642: div.LC_clear_float_header {
1.597     albertel 5643:   padding-bottom: 2px;
1.591     raeburn  5644: }
                   5645: 
                   5646: div.LC_clear_float_footer {
1.597     albertel 5647:   padding-top: 10px;
1.591     raeburn  5648:   clear: both;
                   5649: }
                   5650: 
1.597     albertel 5651: div.LC_grade_show_user {
                   5652:   margin-top: 20px;
                   5653:   border: 1px solid black;
                   5654: }
1.795     www      5655: 
1.597     albertel 5656: div.LC_grade_user_name {
                   5657:   background: #DDDDEE;
                   5658:   border-bottom: 1px solid black;
1.705     tempelho 5659:   font-weight: bold;
                   5660:   font-size: large;
1.597     albertel 5661: }
1.795     www      5662: 
1.597     albertel 5663: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5664:   background: #DDEEDD;
                   5665: }
                   5666: 
                   5667: div.LC_grade_show_problem,
                   5668: div.LC_grade_submissions,
                   5669: div.LC_grade_message_center,
                   5670: div.LC_grade_info_links,
                   5671: div.LC_grade_assign {
                   5672:   margin: 5px;
                   5673:   width: 99%;
                   5674:   background: #FFFFFF;
                   5675: }
1.795     www      5676: 
1.597     albertel 5677: div.LC_grade_show_problem_header,
                   5678: div.LC_grade_submissions_header,
                   5679: div.LC_grade_message_center_header,
                   5680: div.LC_grade_assign_header {
1.705     tempelho 5681:   font-weight: bold;
                   5682:   font-size: large;
1.597     albertel 5683: }
1.795     www      5684: 
1.597     albertel 5685: div.LC_grade_show_problem_problem,
                   5686: div.LC_grade_submissions_body,
                   5687: div.LC_grade_message_center_body,
                   5688: div.LC_grade_assign_body {
                   5689:   border: 1px solid black;
                   5690:   width: 99%;
                   5691:   background: #FFFFFF;
                   5692: }
1.795     www      5693: 
1.598     albertel 5694: span.LC_grade_check_note {
1.705     tempelho 5695:   font-weight: normal;
                   5696:   font-size: medium;
1.598     albertel 5697:   display: inline;
                   5698:   position: absolute;
                   5699:   right: 1em;
                   5700: }
1.597     albertel 5701: 
1.613     albertel 5702: table.LC_scantron_action {
                   5703:   width: 100%;
                   5704: }
1.795     www      5705: 
1.613     albertel 5706: table.LC_scantron_action tr th {
1.698     harmsja  5707:   font-weight:bold;
                   5708:   font-style:normal;
1.613     albertel 5709: }
1.795     www      5710: 
1.779     bisitz   5711: .LC_edit_problem_header,
1.614     albertel 5712: div.LC_edit_problem_footer {
1.705     tempelho 5713:   font-weight: normal;
                   5714:   font-size:  medium;
1.602     albertel 5715:   margin: 2px;
1.600     albertel 5716: }
1.795     www      5717: 
1.600     albertel 5718: div.LC_edit_problem_header,
1.602     albertel 5719: div.LC_edit_problem_header div,
1.614     albertel 5720: div.LC_edit_problem_footer,
                   5721: div.LC_edit_problem_footer div,
1.602     albertel 5722: div.LC_edit_problem_editxml_header,
                   5723: div.LC_edit_problem_editxml_header div {
1.600     albertel 5724:   margin-top: 5px;
                   5725: }
1.795     www      5726: 
1.602     albertel 5727: div.LC_edit_problem_header_edit_row {
                   5728:   background: $tabbg;
                   5729:   padding: 3px;
                   5730:   margin-bottom: 5px;
                   5731: }
1.795     www      5732: 
1.600     albertel 5733: div.LC_edit_problem_header_title {
1.705     tempelho 5734:   font-weight: bold;
                   5735:   font-size: larger;
1.602     albertel 5736:   background: $tabbg;
                   5737:   padding: 3px;
                   5738: }
1.795     www      5739: 
1.602     albertel 5740: table.LC_edit_problem_header_title {
1.705     tempelho 5741:   font-size: larger;
                   5742:   font-weight:  bold;
1.602     albertel 5743:   width: 100%;
                   5744:   border-color: $pgbg;
                   5745:   border-style: solid;
                   5746:   border-width: $border;
1.600     albertel 5747:   background: $tabbg;
1.602     albertel 5748:   border-collapse: collapse;
1.803     bisitz   5749:   padding: 0;
1.602     albertel 5750: }
                   5751: 
                   5752: div.LC_edit_problem_discards {
                   5753:   float: left;
                   5754:   padding-bottom: 5px;
                   5755: }
1.795     www      5756: 
1.602     albertel 5757: div.LC_edit_problem_saves {
                   5758:   float: right;
                   5759:   padding-bottom: 5px;
1.600     albertel 5760: }
1.795     www      5761: 
1.600     albertel 5762: hr.LC_edit_problem_divide {
1.602     albertel 5763:   clear: both;
1.600     albertel 5764:   color: $tabbg;
                   5765:   background-color: $tabbg;
                   5766:   height: 3px;
1.803     bisitz   5767:   border: none;
1.600     albertel 5768: }
1.795     www      5769: 
1.679     riegler  5770: img.stift{
1.803     bisitz   5771:   border-width: 0;
                   5772:   vertical-align: middle;
1.677     riegler  5773: }
1.680     riegler  5774: 
1.681     riegler  5775: table#LC_mainmenu{
                   5776:  margin-top:10px;
                   5777:  width:80%;
                   5778: }
                   5779: 
1.680     riegler  5780: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
                   5781:   vertical-align: top;
                   5782:   width: 45%;
                   5783: }
1.795     www      5784: 
1.779     bisitz   5785: .LC_mainmenu_fieldset_category {
                   5786:   color: $font;
                   5787:   background: $pgbg;
                   5788:   font-size: small;
                   5789:   font-weight: bold;
1.777     tempelho 5790: }
1.795     www      5791: 
1.716     raeburn  5792: div.LC_createcourse {
                   5793:     margin: 10px 10px 10px 10px;
                   5794: }
                   5795: 
1.693     droeschl 5796: /* ---- Remove when done ----
                   5797: # The following styles is part of the redesign of LON-CAPA and are
                   5798: # subject to change during this project.
                   5799: # Don't rely on their current functionality as they might be 
                   5800: # changed or removed.
                   5801: # --------------------------*/
                   5802: 
1.698     harmsja  5803: a:hover,
1.721     harmsja  5804: ol.LC_smallMenu a:hover,
                   5805: ol#LC_MenuBreadcrumbs a:hover,
                   5806: ol#LC_PathBreadcrumbs a:hover,
                   5807: ul#LC_TabMainMenuContent a:hover,
                   5808: .LC_FormSectionClearButton input:hover
1.795     www      5809: ul.LC_TabContent   li:hover a {
1.698     harmsja  5810: 	color:#BF2317;
                   5811:         text-decoration:none;
1.693     droeschl 5812: }
                   5813: 
1.779     bisitz   5814: h1 {
1.813     bisitz   5815: 	padding: 0;
1.693     droeschl 5816: 	line-height:130%;
                   5817: }
1.698     harmsja  5818: 
1.795     www      5819: h2,h3,h4,h5,h6 {
1.803     bisitz   5820: 	margin: 5px 0 5px 0;
                   5821: 	padding: 0;
1.721     harmsja  5822: 	line-height:130%;
1.693     droeschl 5823: }
1.795     www      5824: 
                   5825: .LC_hcell {
1.698     harmsja  5826:         padding:3px 15px 3px 15px;
1.803     bisitz   5827:         margin: 0;
1.703     harmsja  5828: 	background-color:$tabbg;
1.801     tempelho 5829: 	color:$fontmenu;
1.779     bisitz   5830: 	border-bottom:solid 1px $lg_border_color;
1.693     droeschl 5831: }
1.795     www      5832: 
1.721     harmsja  5833: .LC_noBorder {
1.803     bisitz   5834:         border: 0;
1.698     harmsja  5835: }
1.693     droeschl 5836: 
                   5837: 
1.698     harmsja  5838: /* Main Header with discription of Person, Course, etc. */
1.693     droeschl 5839: 
1.761     tempelho 5840: .LC_Right {
                   5841:         float: right;
1.803     bisitz   5842:         margin: 0;
                   5843:         padding: 0;
1.761     tempelho 5844: }
                   5845: 
1.721     harmsja  5846: .LC_FormSectionClearButton input {
1.779     bisitz   5847:         background-color:transparent;
1.803     bisitz   5848:         border: none;
1.698     harmsja  5849:         cursor:pointer;
                   5850:         text-decoration:underline;
1.693     droeschl 5851: }
1.763     bisitz   5852: 
                   5853: .LC_help_open_topic {
                   5854:         color: #FFFFFF;
                   5855:         background-color: #EEEEFF;
                   5856:         margin: 1px;
                   5857:         padding: 4px;
                   5858:         border: 1px solid #000033;
                   5859:         white-space: nowrap;
1.783     amueller 5860: /*		vertical-align: middle; */
1.759     neumanie 5861: }
1.693     droeschl 5862: 
1.698     harmsja  5863: dl,ul,div,fieldset {
1.803     bisitz   5864: 	margin: 10px 10px 10px 0;
1.806     bisitz   5865: /*	overflow: hidden; */
1.693     droeschl 5866: }
1.795     www      5867: 
1.813     bisitz   5868: #LC_nav_bar {
1.807     droeschl 5869:     float: left;
                   5870:     margin: 0;
                   5871: }
                   5872: 
1.813     bisitz   5873: #LC_nav_bar em{
1.807     droeschl 5874:     font-weight: bold;
                   5875:     font-style: normal;
                   5876: }
                   5877: 
                   5878: ol.LC_smallMenu {
                   5879:     float: right;
                   5880: }
                   5881: 
1.721     harmsja  5882: ol.LC_smallMenu, ol#LC_PathBreadcrumbs {
1.803     bisitz   5883: 	margin: 0;
1.693     droeschl 5884: }
                   5885: 
1.721     harmsja  5886: ol.LC_smallMenu li {
1.693     droeschl 5887: 	display: inline;
1.803     bisitz   5888: 	padding: 5px 5px 0 10px;
1.693     droeschl 5889: 	vertical-align: top;
                   5890: }
                   5891: 
1.721     harmsja  5892: ol.LC_smallMenu li img {
1.693     droeschl 5893: 	vertical-align: bottom;
                   5894: }
                   5895: 
1.721     harmsja  5896: ol.LC_smallMenu a {
1.693     droeschl 5897: 	font-size: 90%;
                   5898: 	color: RGB(80, 80, 80);
                   5899: 	text-decoration: none;
                   5900: }
1.795     www      5901: 
1.808     droeschl 5902: ul#LC_TabMainMenuContent {
1.807     droeschl 5903:     clear: both;
1.808     droeschl 5904:     color: $fontmenu;
                   5905:     background: $tabbg;
                   5906:     list-style: none;
                   5907:     padding: 0;
                   5908:     margin: 0;
                   5909:     float:left;
                   5910:     width: 100%;
                   5911: }
                   5912: 
                   5913: ul#LC_TabMainMenuContent li {
                   5914:     float: left;
                   5915:     font-weight: bold;
                   5916:     line-height: 1.8em;
                   5917:     padding: 0 0.8em; 
                   5918:     border-right: 1px solid black;
                   5919:     display: inline;
                   5920:     vertical-align: middle;
1.807     droeschl 5921: }
                   5922: 
1.795     www      5923: ul.LC_TabContent ,
1.741     harmsja  5924: ul.LC_TabContentBigger {
1.721     harmsja  5925: 	display:block;
                   5926: 	list-style:none;
1.803     bisitz   5927: 	margin: 0;
                   5928: 	padding: 0;
1.693     droeschl 5929: }
                   5930: 
1.795     www      5931: ul.LC_TabContent li,
                   5932: ul.LC_TabContentBigger li {
1.693     droeschl 5933: 	display: inline;
1.741     harmsja  5934: 	border-right: solid 1px $lg_border_color;
                   5935: 	float:left;
                   5936: 	line-height:140%;
                   5937: 	white-space:nowrap;
                   5938: }
1.795     www      5939: 
1.808     droeschl 5940: ul#LC_TabMainMenuContent li a {
                   5941:     color: $fontmenu;
1.693     droeschl 5942: 	text-decoration: none;
                   5943: }
1.795     www      5944: 
1.721     harmsja  5945: ul.LC_TabContent {
1.741     harmsja  5946: 	min-height:1.6em;
1.721     harmsja  5947: }
1.795     www      5948: 
                   5949: ul.LC_TabContent li {
1.741     harmsja  5950: 	vertical-align:middle;
1.803     bisitz   5951: 	padding: 0 10px 0 10px;
1.745     ehlerst  5952: 	background-color:$tabbg;
                   5953: 	border-bottom:solid 1px $lg_border_color;
1.721     harmsja  5954: }
1.795     www      5955: 
                   5956: ul.LC_TabContent li a, ul.LC_TabContent li {
1.721     harmsja  5957: 	color:rgb(47,47,47);
                   5958: 	text-decoration:none;
                   5959: 	font-size:95%;
                   5960: 	font-weight:bold;
1.761     tempelho 5961: 	padding-right: 16px;
1.721     harmsja  5962: }
1.795     www      5963: 
                   5964: ul.LC_TabContent li:hover, ul.LC_TabContent li.active {
1.761     tempelho 5965:         background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.745     ehlerst  5966: 	border-bottom:solid 1px #FFFFFF;
1.761     tempelho 5967: 	padding-right: 16px;
1.744     ehlerst  5968: }
1.795     www      5969: 
                   5970: ul.LC_TabContentBigger li {
1.741     harmsja  5971: 	vertical-align:bottom;
                   5972: 	border-top:solid 1px $lg_border_color;
                   5973: 	border-left:solid 1px $lg_border_color;
                   5974: 	padding:5px 10px 5px 10px;
                   5975: 	margin-left:2px;
                   5976: 	background:url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
                   5977: }
1.795     www      5978: 
                   5979: ul.LC_TabContentBigger li:hover, 
                   5980: ul.LC_TabContentBigger li.active {
1.744     ehlerst  5981: 	background:url(/adm/lonIcons/lightGreyBG.png) repeat-x right bottom;
                   5982: }
1.795     www      5983: 
                   5984: ul.LC_TabContentBigger li, 
                   5985: ul.LC_TabContentBigger li a {
1.741     harmsja  5986: 	font-size:110%;
                   5987: 	font-weight:bold;
                   5988: }
1.693     droeschl 5989: 
1.795     www      5990: ol#LC_MenuBreadcrumbs, 
                   5991: ol#LC_PathBreadcrumbs, 
1.823     bisitz   5992: ul#LC_CourseBreadcrumbs {
1.693     droeschl 5993: 	padding-left: 10px;
1.819     tempelho 5994: 	margin: 0;
1.693     droeschl 5995: 	list-style-position: inside;
                   5996: }
                   5997: 
1.795     www      5998: ol#LC_MenuBreadcrumbs li, 
                   5999: ol#LC_PathBreadcrumbs li, 
1.823     bisitz   6000: ul#LC_CourseBreadcrumbs li {
1.693     droeschl 6001: 	display: inline;
1.803     bisitz   6002: 	padding: 0 0 0 10px;
1.693     droeschl 6003: 	overflow:hidden;
                   6004: }
                   6005: 
1.823     bisitz   6006: ol#LC_MenuBreadcrumbs li a,
                   6007: ul#LC_CourseBreadcrumbs li a {
1.693     droeschl 6008: 	text-decoration: none;
                   6009: 	font-size:90%;
                   6010: }
1.795     www      6011: 
                   6012: ol#LC_PathBreadcrumbs li a {
1.698     harmsja  6013: 	text-decoration:none;
                   6014: 	font-size:100%;
                   6015: 	font-weight:bold;
1.693     droeschl 6016: }
1.795     www      6017: 
                   6018: .LC_BoxPadding {
1.786     neumanie 6019: 	padding: 10px;
                   6020: }
1.795     www      6021: 
                   6022: .LC_ContentBoxSpecial {
1.701     harmsja  6023: 	border: solid 1px $lg_border_color;
1.746     neumanie 6024: }
1.795     www      6025: 
                   6026: .LC_ContentBoxSpecialContactInfo {
1.746     neumanie 6027: 	border: solid 1px $lg_border_color;
                   6028: 	max-width:25%;
                   6029: 	min-width:25%;
1.698     harmsja  6030: }
1.795     www      6031: 
                   6032: .LC_AboutMe_Image {
1.747     neumanie 6033: 	float:left;
                   6034: 	margin-right:10px;
                   6035: }
1.795     www      6036: 
                   6037: .LC_Clear_AboutMe_Image {
1.747     neumanie 6038: 	clear:left;
                   6039: }
1.795     www      6040: 
1.721     harmsja  6041: dl.LC_ListStyleClean dt {
1.693     droeschl 6042: 	padding-right: 5px;
                   6043: 	display: table-header-group;
                   6044: }
                   6045: 
1.721     harmsja  6046: dl.LC_ListStyleClean dd {
1.693     droeschl 6047: 	display: table-row;
                   6048: }
                   6049: 
1.721     harmsja  6050: .LC_ListStyleClean,
                   6051: .LC_ListStyleSimple,
                   6052: .LC_ListStyleNormal,
1.777     tempelho 6053: .LC_ListStyle_Border,
1.795     www      6054: .LC_ListStyleSpecial {
1.693     droeschl 6055: 	/*display:block;	*/
                   6056: 	list-style-position: inside;
                   6057: 	list-style-type: none;
                   6058: 	overflow: hidden;
1.803     bisitz   6059: 	padding: 0;
1.693     droeschl 6060: }
                   6061: 
1.721     harmsja  6062: .LC_ListStyleSimple li,
                   6063: .LC_ListStyleSimple dd,
                   6064: .LC_ListStyleNormal li,
                   6065: .LC_ListStyleNormal dd,
                   6066: .LC_ListStyleSpecial li,
1.795     www      6067: .LC_ListStyleSpecial dd {
1.803     bisitz   6068: 	margin: 0;
1.693     droeschl 6069: 	padding: 5px 5px 5px 10px;
                   6070: 	clear: both;
                   6071: }
                   6072: 
1.721     harmsja  6073: .LC_ListStyleClean li,
                   6074: .LC_ListStyleClean dd {
1.803     bisitz   6075: 	padding-top: 0;
                   6076: 	padding-bottom: 0;
1.693     droeschl 6077: }
                   6078: 
1.721     harmsja  6079: .LC_ListStyleSimple dd,
1.795     www      6080: .LC_ListStyleSimple li {
1.698     harmsja  6081: 	border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6082: }
                   6083: 
1.721     harmsja  6084: .LC_ListStyleSpecial li,
                   6085: .LC_ListStyleSpecial dd {
1.693     droeschl 6086: 	list-style-type: none;
                   6087: 	background-color: RGB(220, 220, 220);
                   6088: 	margin-bottom: 4px;
                   6089: }
                   6090: 
1.721     harmsja  6091: table.LC_SimpleTable {
1.698     harmsja  6092: 	margin:5px;
                   6093: 	border:solid 1px $lg_border_color;
1.795     www      6094: }
1.693     droeschl 6095: 
1.721     harmsja  6096: table.LC_SimpleTable tr {
1.803     bisitz   6097: 	padding: 0;
1.698     harmsja  6098: 	border:solid 1px $lg_border_color;
1.693     droeschl 6099: }
1.795     www      6100: 
                   6101: table.LC_SimpleTable thead {
1.698     harmsja  6102: 	 background:rgb(220,220,220);
1.693     droeschl 6103: }
                   6104: 
1.721     harmsja  6105: div.LC_columnSection {
1.693     droeschl 6106: 	display: block;
                   6107: 	clear: both;
                   6108: 	overflow: hidden;
1.803     bisitz   6109: 	margin: 0;
1.693     droeschl 6110: }
                   6111: 
1.721     harmsja  6112: div.LC_columnSection>* {
1.693     droeschl 6113: 	float: left;
1.803     bisitz   6114: 	margin: 10px 20px 10px 0;
1.747     neumanie 6115: 	overflow:hidden;
1.693     droeschl 6116: }
1.721     harmsja  6117: 
1.795     www      6118: .ContentBoxSpecialTemplate {
1.747     neumanie 6119:         border: solid 1px $lg_border_color;
1.719     ehlerst  6120: }
1.795     www      6121: 
1.719     ehlerst  6122: .ContentBoxTemplate {
                   6123:         padding:10px;
                   6124: }
                   6125: 
1.721     harmsja  6126: div.LC_columnSection > .ContentBoxTemplate,
1.795     www      6127: div.LC_columnSection > .ContentBoxSpecialTemplate {
1.719     ehlerst  6128:         width: 600px;
                   6129: }
1.753     droeschl 6130: 
1.795     www      6131: .clear {
1.720     ehlerst  6132: 	clear: both;
1.803     bisitz   6133: 	line-height: 0;
                   6134: 	font-size: 0;
                   6135: 	height: 0;
1.720     ehlerst  6136: }
1.693     droeschl 6137: 
1.694     tempelho 6138: .LC_loginpage_container {
                   6139: 	text-align:left;
                   6140: 	margin : 0 auto;
1.785     tempelho 6141: 	width:90%;
1.694     tempelho 6142: 	padding: 10px;
                   6143: 	height: auto;
1.712     muellerd 6144: 	background-color:#FFFFFF;
1.694     tempelho 6145: 	border:1px solid #CCCCCC;
                   6146: }
                   6147: 
                   6148: 
                   6149: .LC_loginpage_loginContainer {
                   6150: 	float:left;
1.712     muellerd 6151: 	width: 182px;
1.785     tempelho 6152: 	padding: 2px;
1.712     muellerd 6153: 	border:1px solid #CCCCCC;
                   6154: 	background-color:$loginbg;
1.694     tempelho 6155: }
                   6156: 
1.795     www      6157: .LC_loginpage_loginContainer h2 {
1.803     bisitz   6158: 	margin-top: 0;
1.712     muellerd 6159: 	display:block;
                   6160: 	background:$bgcol;
                   6161: 	color:$textcol;
                   6162: 	padding-left:5px;
                   6163: }
1.785     tempelho 6164: 
1.694     tempelho 6165: .LC_loginpage_loginInfo {
                   6166: 	float:left;
1.785     tempelho 6167: 	width:182px;
1.694     tempelho 6168: 	border:1px solid #CCCCCC;
1.785     tempelho 6169: 	padding:2px;
1.712     muellerd 6170: }
                   6171: 
1.694     tempelho 6172: .LC_loginpage_space {
1.754     droeschl 6173: 	clear: both;
                   6174: 	margin-bottom: 20px;
1.694     tempelho 6175: 	border-bottom: 1px solid #CCCCCC;
                   6176: }
                   6177: 
1.785     tempelho 6178: .LC_loginpage_floatLeft {
                   6179: 	float: left;
                   6180: 	width: 200px;
                   6181: 	margin: 0;
                   6182: }
                   6183: 
1.795     www      6184: table em {
1.754     droeschl 6185: 	font-weight: bold;
                   6186: 	font-style: normal;
1.748     schulted 6187: }
1.795     www      6188: 
1.779     bisitz   6189: table.LC_tableBrowseRes,
1.795     www      6190: table.LC_tableOfContent {
1.769     schulted 6191:         border:none;
                   6192: 	border-spacing: 1;
1.754     droeschl 6193: 	padding: 3px;
                   6194: 	background-color: #FFFFFF;
                   6195: 	font-size: 90%;
1.753     droeschl 6196: }
1.789     droeschl 6197: 
                   6198: table.LC_tableOfContent{
                   6199:     border-collapse: collapse;
                   6200: }
                   6201: 
1.771     droeschl 6202: table.LC_tableBrowseRes a,
1.768     schulted 6203: table.LC_tableOfContent a {
1.771     droeschl 6204:         background-color: transparent;
1.753     droeschl 6205: 	text-decoration: none;
                   6206: }
                   6207: 
1.771     droeschl 6208: table.LC_tableBrowseRes tr.LC_trOdd,
1.768     schulted 6209: table.LC_tableOfContent tr.LC_trOdd{
1.754     droeschl 6210: 	background-color: #EEEEEE;
1.753     droeschl 6211: }
                   6212: 
1.795     www      6213: table.LC_tableOfContent img {
1.753     droeschl 6214: 	border: none;
                   6215: 	height: 1.3em;
                   6216: 	vertical-align: text-bottom;
                   6217: 	margin-right: 0.3em;
                   6218: }
1.757     schulted 6219: 
1.795     www      6220: a#LC_content_toolbar_firsthomework {
1.774     ehlerst  6221: 	background-image:url(/res/adm/pages/open-first-problem.gif);
                   6222: }
                   6223: 
1.795     www      6224: a#LC_content_toolbar_launchnav {
1.774     ehlerst  6225: 	background-image:url(/res/adm/pages/start-navigation.gif);
                   6226: }
                   6227: 
1.795     www      6228: a#LC_content_toolbar_closenav {
1.774     ehlerst  6229: 	background-image:url(/res/adm/pages/close-navigation.gif);
                   6230: }
                   6231: 
1.795     www      6232: a#LC_content_toolbar_everything {
1.774     ehlerst  6233: 	background-image:url(/res/adm/pages/show-all.gif);
                   6234: }
                   6235: 
1.795     www      6236: a#LC_content_toolbar_uncompleted {
1.774     ehlerst  6237: 	background-image:url(/res/adm/pages/show-incomplete-problems.gif);
                   6238: }
                   6239: 
1.795     www      6240: #LC_content_toolbar_clearbubbles {
1.774     ehlerst  6241: 	background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
                   6242: }
                   6243: 
1.795     www      6244: a#LC_content_toolbar_changefolder {
1.757     schulted 6245: 	background : url(/res/adm/pages/close-all-folders.gif) top center ;
                   6246: }
                   6247: 
1.795     www      6248: a#LC_content_toolbar_changefolder_toggled {
1.757     schulted 6249: 	background-image:url(/res/adm/pages/open-all-folders.gif);
                   6250: }
                   6251: 
1.795     www      6252: ul#LC_toolbar li a:hover {
1.757     schulted 6253: 	background-position: bottom center;
                   6254: }
                   6255: 
1.795     www      6256: ul#LC_toolbar {
1.803     bisitz   6257: 	padding: 0;
1.757     schulted 6258: 	margin: 2px;
                   6259: 	list-style:none;
                   6260: 	position:relative;
                   6261: 	background-color:white;
                   6262: }
                   6263: 
1.795     www      6264: ul#LC_toolbar li {
1.757     schulted 6265: 	border:1px solid white;
1.803     bisitz   6266: 	padding: 0;
1.757     schulted 6267: 	margin: 0;
1.795     www      6268:         float: left;
1.767     droeschl 6269: 	display:inline;
1.757     schulted 6270: 	vertical-align:middle;
1.795     www      6271: } 
1.757     schulted 6272: 
1.783     amueller 6273: 
1.795     www      6274: a.LC_toolbarItem {
1.767     droeschl 6275: 	display:block;
1.803     bisitz   6276: 	padding: 0;
                   6277: 	margin: 0;
1.757     schulted 6278: 	height: 32px;
                   6279: 	width: 32px;
1.779     bisitz   6280: 	color:white;
1.803     bisitz   6281: 	border: none;
1.757     schulted 6282: 	background-repeat:no-repeat;
                   6283: 	background-color:transparent;
                   6284: }
                   6285: 
1.782     bisitz   6286: ul.LC_functionslist li {
                   6287:   float: left;
                   6288:   white-space: nowrap;
                   6289:   height: 35px; /* at least as high as heighest list item */
1.803     bisitz   6290:   margin: 0 15px 15px 10px;
1.782     bisitz   6291: }
                   6292: 
1.757     schulted 6293: 
1.343     albertel 6294: END
                   6295: }
                   6296: 
1.306     albertel 6297: =pod
                   6298: 
                   6299: =item * &headtag()
                   6300: 
                   6301: Returns a uniform footer for LON-CAPA web pages.
                   6302: 
1.307     albertel 6303: Inputs: $title - optional title for the head
                   6304:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6305:         $args - optional arguments
1.319     albertel 6306:             force_register - if is true call registerurl so the remote is 
                   6307:                              informed
1.415     albertel 6308:             redirect       -> array ref of
                   6309:                                    1- seconds before redirect occurs
                   6310:                                    2- url to redirect to
                   6311:                                    3- whether the side effect should occur
1.315     albertel 6312:                            (side effect of setting 
                   6313:                                $env{'internal.head.redirect'} to the url 
                   6314:                                redirected too)
1.352     albertel 6315:             domain         -> force to color decorate a page for a specific
                   6316:                                domain
                   6317:             function       -> force usage of a specific rolish color scheme
                   6318:             bgcolor        -> override the default page bgcolor
1.460     albertel 6319:             no_auto_mt_title
                   6320:                            -> prevent &mt()ing the title arg
1.464     albertel 6321: 
1.306     albertel 6322: =cut
                   6323: 
                   6324: sub headtag {
1.313     albertel 6325:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6326:     
1.363     albertel 6327:     my $function = $args->{'function'} || &get_users_function();
                   6328:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6329:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6330:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6331: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6332: 		   #time(),
1.418     albertel 6333: 		   $env{'environment.color.timestamp'},
1.363     albertel 6334: 		   $function,$domain,$bgcolor);
                   6335: 
1.369     www      6336:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6337: 
1.308     albertel 6338:     my $result =
                   6339: 	'<head>'.
1.461     albertel 6340: 	&font_settings();
1.319     albertel 6341: 
1.461     albertel 6342:     if (!$args->{'frameset'}) {
                   6343: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6344:     }
1.319     albertel 6345:     if ($args->{'force_register'}) {
                   6346: 	$result .= &Apache::lonmenu::registerurl(1);
                   6347:     }
1.436     albertel 6348:     if (!$args->{'no_nav_bar'} 
                   6349: 	&& !$args->{'only_body'}
                   6350: 	&& !$args->{'frameset'}) {
                   6351: 	$result .= &help_menu_js();
                   6352:     }
1.319     albertel 6353: 
1.314     albertel 6354:     if (ref($args->{'redirect'})) {
1.414     albertel 6355: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6356: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6357: 	if (!$inhibit_continue) {
                   6358: 	    $env{'internal.head.redirect'} = $url;
                   6359: 	}
1.313     albertel 6360: 	$result.=<<ADDMETA
                   6361: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6362: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6363: ADDMETA
                   6364:     }
1.306     albertel 6365:     if (!defined($title)) {
                   6366: 	$title = 'The LearningOnline Network with CAPA';
                   6367:     }
1.460     albertel 6368:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6369:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6370: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6371: 	.$head_extra;
1.306     albertel 6372:     return $result;
                   6373: }
                   6374: 
                   6375: =pod
                   6376: 
1.340     albertel 6377: =item * &font_settings()
                   6378: 
                   6379: Returns neccessary <meta> to set the proper encoding
                   6380: 
                   6381: Inputs: none
                   6382: 
                   6383: =cut
                   6384: 
                   6385: sub font_settings {
                   6386:     my $headerstring='';
1.647     www      6387:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6388: 	$headerstring.=
                   6389: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6390:     }
                   6391:     return $headerstring;
                   6392: }
                   6393: 
1.341     albertel 6394: =pod
                   6395: 
                   6396: =item * &xml_begin()
                   6397: 
                   6398: Returns the needed doctype and <html>
                   6399: 
                   6400: Inputs: none
                   6401: 
                   6402: =cut
                   6403: 
                   6404: sub xml_begin {
                   6405:     my $output='';
                   6406: 
1.592     albertel 6407:     if ($env{'internal.start_page'}==1) {
                   6408: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6409:     }
1.342     albertel 6410: 
1.341     albertel 6411:     if ($env{'browser.mathml'}) {
                   6412: 	$output='<?xml version="1.0"?>'
                   6413:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6414: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6415:             
                   6416: #	    .'<!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">] >'
                   6417: 	    .'<!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">'
                   6418:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6419: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6420:     } else {
                   6421: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
                   6422:     }
                   6423:     return $output;
                   6424: }
1.340     albertel 6425: 
                   6426: =pod
                   6427: 
1.306     albertel 6428: =item * &endheadtag()
                   6429: 
                   6430: Returns a uniform </head> for LON-CAPA web pages.
                   6431: 
                   6432: Inputs: none
                   6433: 
                   6434: =cut
                   6435: 
                   6436: sub endheadtag {
                   6437:     return '</head>';
                   6438: }
                   6439: 
                   6440: =pod
                   6441: 
                   6442: =item * &head()
                   6443: 
                   6444: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6445: 
1.648     raeburn  6446: Inputs:
                   6447: 
                   6448: =over 4
                   6449: 
                   6450: $title - optional title for the page
                   6451: 
                   6452: $head_extra - optional extra HTML to put inside the <head>
                   6453: 
                   6454: =back
1.405     albertel 6455: 
1.306     albertel 6456: =cut
                   6457: 
                   6458: sub head {
1.325     albertel 6459:     my ($title,$head_extra,$args) = @_;
                   6460:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6461: }
                   6462: 
                   6463: =pod
                   6464: 
                   6465: =item * &start_page()
                   6466: 
                   6467: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6468: 
1.648     raeburn  6469: Inputs:
                   6470: 
                   6471: =over 4
                   6472: 
                   6473: $title - optional title for the page
                   6474: 
                   6475: $head_extra - optional extra HTML to incude inside the <head>
                   6476: 
                   6477: $args - additional optional args supported are:
                   6478: 
                   6479: =over 8
                   6480: 
                   6481:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6482:                                     arg on
1.814     bisitz   6483:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6484:              add_entries    -> additional attributes to add to the  <body>
                   6485:              domain         -> force to color decorate a page for a 
1.317     albertel 6486:                                     specific domain
1.648     raeburn  6487:              function       -> force usage of a specific rolish color
1.317     albertel 6488:                                     scheme
1.648     raeburn  6489:              redirect       -> see &headtag()
                   6490:              bgcolor        -> override the default page bg color
                   6491:              js_ready       -> return a string ready for being used in 
1.317     albertel 6492:                                     a javascript writeln
1.648     raeburn  6493:              html_encode    -> return a string ready for being used in 
1.320     albertel 6494:                                     a html attribute
1.648     raeburn  6495:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6496:                                     $forcereg arg
1.648     raeburn  6497:              body_title     -> alternate text to use instead of $title
1.326     albertel 6498:                                     in the title box that appears, this text
                   6499:                                     is not auto translated like the $title is
1.648     raeburn  6500:              frameset       -> if true will start with a <frameset>
1.330     albertel 6501:                                     rather than <body>
1.648     raeburn  6502:              skip_phases    -> hash ref of 
1.338     albertel 6503:                                     head -> skip the <html><head> generation
                   6504:                                     body -> skip all <body> generation
1.648     raeburn  6505:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6506:                                     'Switch To Inline Menu' link
1.648     raeburn  6507:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6508:              inherit_jsmath -> when creating popup window in a page,
                   6509:                                     should it have jsmath forced on by the
                   6510:                                     current page
1.361     albertel 6511: 
1.648     raeburn  6512: =back
1.460     albertel 6513: 
1.648     raeburn  6514: =back
1.562     albertel 6515: 
1.306     albertel 6516: =cut
                   6517: 
                   6518: sub start_page {
1.309     albertel 6519:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6520:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6521:     my %head_args;
1.352     albertel 6522:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6523: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6524: 		     'no_auto_mt_title') {
1.319     albertel 6525: 	if (defined($args->{$arg})) {
1.324     raeburn  6526: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6527: 	}
1.313     albertel 6528:     }
1.319     albertel 6529: 
1.315     albertel 6530:     $env{'internal.start_page'}++;
1.338     albertel 6531:     my $result;
                   6532:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6533: 	$result.=
1.341     albertel 6534: 	    &xml_begin().
1.338     albertel 6535: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6536:     }
                   6537:     
                   6538:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6539: 	if ($args->{'frameset'}) {
                   6540: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6541: 						$args->{'add_entries'});
                   6542: 	    $result .= "\n<frameset $attr_string>\n";
                   6543: 	} else {
                   6544: 	    $result .=
                   6545: 		&bodytag($title, 
                   6546: 			 $args->{'function'},       $args->{'add_entries'},
                   6547: 			 $args->{'only_body'},      $args->{'domain'},
                   6548: 			 $args->{'force_register'}, $args->{'body_title'},
                   6549: 			 $args->{'no_nav_bar'},     $args->{'bgcolor'},
1.816     bisitz   6550: 			 $args->{'no_inline_link'},
1.460     albertel 6551: 			 $args);
1.338     albertel 6552: 	}
1.330     albertel 6553:     }
1.338     albertel 6554: 
1.315     albertel 6555:     if ($args->{'js_ready'}) {
1.713     kaisler  6556: 		$result = &js_ready($result);
1.315     albertel 6557:     }
1.320     albertel 6558:     if ($args->{'html_encode'}) {
1.713     kaisler  6559: 		$result = &html_encode($result);
                   6560:     }
                   6561: 
1.813     bisitz   6562:     # Preparation for new and consistent functionlist at top of screen
                   6563:     # if ($args->{'functionlist'}) {
                   6564:     #            $result .= &build_functionlist();
                   6565:     #}
                   6566: 
                   6567:     # Don't add anything more if only_body wanted
                   6568:     return $result if $args->{'only_body'};
                   6569: 
                   6570:     #Breadcrumbs
1.758     kaisler  6571:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6572: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6573: 		#if any br links exists, add them to the breadcrumbs
                   6574: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6575: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6576: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6577: 			}
                   6578: 		}
                   6579: 
                   6580: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6581: 		if(exists($args->{'bread_crumbs_component'})){
                   6582: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   6583: 		}else{
                   6584: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   6585: 		}
1.320     albertel 6586:     }
1.315     albertel 6587:     return $result;
1.306     albertel 6588: }
                   6589: 
1.330     albertel 6590: 
1.306     albertel 6591: =pod
                   6592: 
                   6593: =item * &head()
                   6594: 
                   6595: Returns a complete </body></html> section for LON-CAPA web pages.
                   6596: 
1.315     albertel 6597: Inputs:         $args - additional optional args supported are:
                   6598:                  js_ready     -> return a string ready for being used in 
                   6599:                                  a javascript writeln
1.320     albertel 6600:                  html_encode  -> return a string ready for being used in 
                   6601:                                  a html attribute
1.330     albertel 6602:                  frameset     -> if true will start with a <frameset>
                   6603:                                  rather than <body>
1.493     albertel 6604:                  dicsussion   -> if true will get discussion from
                   6605:                                   lonxml::xmlend
                   6606:                                  (you can pass the target and parser arguments
                   6607:                                   through optional 'target' and 'parser' args
                   6608:                                   to this routine)
1.306     albertel 6609: 
                   6610: =cut
                   6611: 
                   6612: sub end_page {
1.315     albertel 6613:     my ($args) = @_;
                   6614:     $env{'internal.end_page'}++;
1.330     albertel 6615:     my $result;
1.335     albertel 6616:     if ($args->{'discussion'}) {
                   6617: 	my ($target,$parser);
                   6618: 	if (ref($args->{'discussion'})) {
                   6619: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6620: 				$args->{'discussion'}{'parser'});
                   6621: 	}
                   6622: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6623:     }
                   6624: 
1.330     albertel 6625:     if ($args->{'frameset'}) {
                   6626: 	$result .= '</frameset>';
                   6627:     } else {
1.635     raeburn  6628: 	$result .= &endbodytag($args);
1.330     albertel 6629:     }
                   6630:     $result .= "\n</html>";
                   6631: 
1.315     albertel 6632:     if ($args->{'js_ready'}) {
1.317     albertel 6633: 	$result = &js_ready($result);
1.315     albertel 6634:     }
1.335     albertel 6635: 
1.320     albertel 6636:     if ($args->{'html_encode'}) {
                   6637: 	$result = &html_encode($result);
                   6638:     }
1.335     albertel 6639: 
1.315     albertel 6640:     return $result;
                   6641: }
                   6642: 
1.320     albertel 6643: sub html_encode {
                   6644:     my ($result) = @_;
                   6645: 
1.322     albertel 6646:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 6647:     
                   6648:     return $result;
                   6649: }
1.317     albertel 6650: sub js_ready {
                   6651:     my ($result) = @_;
                   6652: 
1.323     albertel 6653:     $result =~ s/[\n\r]/ /xmsg;
                   6654:     $result =~ s/\\/\\\\/xmsg;
                   6655:     $result =~ s/'/\\'/xmsg;
1.372     albertel 6656:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 6657:     
                   6658:     return $result;
                   6659: }
                   6660: 
1.315     albertel 6661: sub validate_page {
                   6662:     if (  exists($env{'internal.start_page'})
1.316     albertel 6663: 	  &&     $env{'internal.start_page'} > 1) {
                   6664: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 6665: 				 $env{'internal.start_page'}.' '.
1.316     albertel 6666: 				 $ENV{'request.filename'});
1.315     albertel 6667:     }
                   6668:     if (  exists($env{'internal.end_page'})
1.316     albertel 6669: 	  &&     $env{'internal.end_page'} > 1) {
                   6670: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 6671: 				 $env{'internal.end_page'}.' '.
1.316     albertel 6672: 				 $env{'request.filename'});
1.315     albertel 6673:     }
                   6674:     if (     exists($env{'internal.start_page'})
                   6675: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 6676: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   6677: 				 $env{'request.filename'});
1.315     albertel 6678:     }
                   6679:     if (   ! exists($env{'internal.start_page'})
                   6680: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 6681: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   6682: 				 $env{'request.filename'});
1.315     albertel 6683:     }
1.306     albertel 6684: }
1.315     albertel 6685: 
1.318     albertel 6686: sub simple_error_page {
                   6687:     my ($r,$title,$msg) = @_;
                   6688:     my $page =
                   6689: 	&Apache::loncommon::start_page($title).
                   6690: 	&mt($msg).
                   6691: 	&Apache::loncommon::end_page();
                   6692:     if (ref($r)) {
                   6693: 	$r->print($page);
1.327     albertel 6694: 	return;
1.318     albertel 6695:     }
                   6696:     return $page;
                   6697: }
1.347     albertel 6698: 
                   6699: {
1.610     albertel 6700:     my @row_count;
1.347     albertel 6701:     sub start_data_table {
1.422     albertel 6702: 	my ($add_class) = @_;
                   6703: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 6704: 	unshift(@row_count,0);
1.422     albertel 6705: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 6706:     }
                   6707: 
                   6708:     sub end_data_table {
1.610     albertel 6709: 	shift(@row_count);
1.389     albertel 6710: 	return '</table>'."\n";;
1.347     albertel 6711:     }
                   6712: 
                   6713:     sub start_data_table_row {
1.422     albertel 6714: 	my ($add_class) = @_;
1.610     albertel 6715: 	$row_count[0]++;
                   6716: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428     albertel 6717: 	$css_class = (join(' ',$css_class,$add_class));
1.422     albertel 6718: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 6719:     }
1.471     banghart 6720:     
                   6721:     sub continue_data_table_row {
                   6722: 	my ($add_class) = @_;
1.610     albertel 6723: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471     banghart 6724: 	$css_class = (join(' ',$css_class,$add_class));
                   6725: 	return  '<tr class="'.$css_class.'">'."\n";;
                   6726:     }
1.347     albertel 6727: 
                   6728:     sub end_data_table_row {
1.389     albertel 6729: 	return '</tr>'."\n";;
1.347     albertel 6730:     }
1.367     www      6731: 
1.421     albertel 6732:     sub start_data_table_empty_row {
1.707     bisitz   6733: #	$row_count[0]++;
1.421     albertel 6734: 	return  '<tr class="LC_empty_row" >'."\n";;
                   6735:     }
                   6736: 
                   6737:     sub end_data_table_empty_row {
                   6738: 	return '</tr>'."\n";;
                   6739:     }
                   6740: 
1.367     www      6741:     sub start_data_table_header_row {
1.389     albertel 6742: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      6743:     }
                   6744: 
                   6745:     sub end_data_table_header_row {
1.389     albertel 6746: 	return '</tr>'."\n";;
1.367     www      6747:     }
1.347     albertel 6748: }
                   6749: 
1.548     albertel 6750: =pod
                   6751: 
                   6752: =item * &inhibit_menu_check($arg)
                   6753: 
                   6754: Checks for a inhibitmenu state and generates output to preserve it
                   6755: 
                   6756: Inputs:         $arg - can be any of
                   6757:                      - undef - in which case the return value is a string 
                   6758:                                to add  into arguments list of a uri
                   6759:                      - 'input' - in which case the return value is a HTML
                   6760:                                  <form> <input> field of type hidden to
                   6761:                                  preserve the value
                   6762:                      - a url - in which case the return value is the url with
                   6763:                                the neccesary cgi args added to preserve the
                   6764:                                inhibitmenu state
                   6765:                      - a ref to a url - no return value, but the string is
                   6766:                                         updated to include the neccessary cgi
                   6767:                                         args to preserve the inhibitmenu state
                   6768: 
                   6769: =cut
                   6770: 
                   6771: sub inhibit_menu_check {
                   6772:     my ($arg) = @_;
                   6773:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6774:     if ($arg eq 'input') {
                   6775: 	if ($env{'form.inhibitmenu'}) {
                   6776: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   6777: 	} else {
                   6778: 	    return
                   6779: 	}
                   6780:     }
                   6781:     if ($env{'form.inhibitmenu'}) {
                   6782: 	if (ref($arg)) {
                   6783: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6784: 	} elsif ($arg eq '') {
                   6785: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   6786: 	} else {
                   6787: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6788: 	}
                   6789:     }
                   6790:     if (!ref($arg)) {
                   6791: 	return $arg;
                   6792:     }
                   6793: }
                   6794: 
1.251     albertel 6795: ###############################################
1.182     matthew  6796: 
                   6797: =pod
                   6798: 
1.549     albertel 6799: =back
                   6800: 
                   6801: =head1 User Information Routines
                   6802: 
                   6803: =over 4
                   6804: 
1.405     albertel 6805: =item * &get_users_function()
1.182     matthew  6806: 
                   6807: Used by &bodytag to determine the current users primary role.
                   6808: Returns either 'student','coordinator','admin', or 'author'.
                   6809: 
                   6810: =cut
                   6811: 
                   6812: ###############################################
                   6813: sub get_users_function {
1.815     tempelho 6814:     my $function = 'norole';
1.818     tempelho 6815:     if ($env{'request.role'}=~/^(st)/) {
                   6816:         $function='student';
                   6817:     }
1.258     albertel 6818:     if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182     matthew  6819:         $function='coordinator';
                   6820:     }
1.258     albertel 6821:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  6822:         $function='admin';
                   6823:     }
1.826     bisitz   6824:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182     matthew  6825:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   6826:         $function='author';
                   6827:     }
                   6828:     return $function;
1.54      www      6829: }
1.99      www      6830: 
                   6831: ###############################################
                   6832: 
1.233     raeburn  6833: =pod
                   6834: 
1.821     raeburn  6835: =item * &show_course()
                   6836: 
                   6837: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   6838: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   6839: 
                   6840: Inputs:
                   6841: None
                   6842: 
                   6843: Outputs:
                   6844: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   6845: 
                   6846: =cut
                   6847: 
                   6848: ###############################################
                   6849: sub show_course {
                   6850:     my $course = !$env{'user.adv'};
                   6851:     if (!$env{'user.adv'}) {
                   6852:         foreach my $env (keys(%env)) {
                   6853:             next if ($env !~ m/^user\.priv\./);
                   6854:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   6855:                 $course = 0;
                   6856:                 last;
                   6857:             }
                   6858:         }
                   6859:     }
                   6860:     return $course;
                   6861: }
                   6862: 
                   6863: ###############################################
                   6864: 
                   6865: =pod
                   6866: 
1.542     raeburn  6867: =item * &check_user_status()
1.274     raeburn  6868: 
                   6869: Determines current status of supplied role for a
                   6870: specific user. Roles can be active, previous or future.
                   6871: 
                   6872: Inputs: 
                   6873: user's domain, user's username, course's domain,
1.375     raeburn  6874: course's number, optional section ID.
1.274     raeburn  6875: 
                   6876: Outputs:
                   6877: role status: active, previous or future. 
                   6878: 
                   6879: =cut
                   6880: 
                   6881: sub check_user_status {
1.412     raeburn  6882:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  6883:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   6884:     my @uroles = keys %userinfo;
                   6885:     my $srchstr;
                   6886:     my $active_chk = 'none';
1.412     raeburn  6887:     my $now = time;
1.274     raeburn  6888:     if (@uroles > 0) {
1.412     raeburn  6889:         if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  6890:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   6891:         } else {
1.412     raeburn  6892:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   6893:         }
                   6894:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  6895:             my $role_end = 0;
                   6896:             my $role_start = 0;
                   6897:             $active_chk = 'active';
1.412     raeburn  6898:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   6899:                 $role_end = $1;
                   6900:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   6901:                     $role_start = $1;
1.274     raeburn  6902:                 }
                   6903:             }
                   6904:             if ($role_start > 0) {
1.412     raeburn  6905:                 if ($now < $role_start) {
1.274     raeburn  6906:                     $active_chk = 'future';
                   6907:                 }
                   6908:             }
                   6909:             if ($role_end > 0) {
1.412     raeburn  6910:                 if ($now > $role_end) {
1.274     raeburn  6911:                     $active_chk = 'previous';
                   6912:                 }
                   6913:             }
                   6914:         }
                   6915:     }
                   6916:     return $active_chk;
                   6917: }
                   6918: 
                   6919: ###############################################
                   6920: 
                   6921: =pod
                   6922: 
1.405     albertel 6923: =item * &get_sections()
1.233     raeburn  6924: 
                   6925: Determines all the sections for a course including
                   6926: sections with students and sections containing other roles.
1.419     raeburn  6927: Incoming parameters: 
                   6928: 
                   6929: 1. domain
                   6930: 2. course number 
                   6931: 3. reference to array containing roles for which sections should 
                   6932: be gathered (optional).
                   6933: 4. reference to array containing status types for which sections 
                   6934: should be gathered (optional).
                   6935: 
                   6936: If the third argument is undefined, sections are gathered for any role. 
                   6937: If the fourth argument is undefined, sections are gathered for any status.
                   6938: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  6939:  
1.374     raeburn  6940: Returns section hash (keys are section IDs, values are
                   6941: number of users in each section), subject to the
1.419     raeburn  6942: optional roles filter, optional status filter 
1.233     raeburn  6943: 
                   6944: =cut
                   6945: 
                   6946: ###############################################
                   6947: sub get_sections {
1.419     raeburn  6948:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 6949:     if (!defined($cdom) || !defined($cnum)) {
                   6950:         my $cid =  $env{'request.course.id'};
                   6951: 
                   6952: 	return if (!defined($cid));
                   6953: 
                   6954:         $cdom = $env{'course.'.$cid.'.domain'};
                   6955:         $cnum = $env{'course.'.$cid.'.num'};
                   6956:     }
                   6957: 
                   6958:     my %sectioncount;
1.419     raeburn  6959:     my $now = time;
1.240     albertel 6960: 
1.366     albertel 6961:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 6962: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 6963: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   6964: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  6965:         my $start_index = &Apache::loncoursedata::CL_START();
                   6966:         my $end_index = &Apache::loncoursedata::CL_END();
                   6967:         my $status;
1.366     albertel 6968: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  6969: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   6970: 				                     $data->[$status_index],
                   6971:                                                      $data->[$start_index],
                   6972:                                                      $data->[$end_index]);
                   6973:             if ($stu_status eq 'Active') {
                   6974:                 $status = 'active';
                   6975:             } elsif ($end < $now) {
                   6976:                 $status = 'previous';
                   6977:             } elsif ($start > $now) {
                   6978:                 $status = 'future';
                   6979:             } 
                   6980: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   6981:                 if ((!defined($possible_status)) || (($status ne '') && 
                   6982:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   6983: 		    $sectioncount{$section}++;
                   6984:                 }
1.240     albertel 6985: 	    }
                   6986: 	}
                   6987:     }
                   6988:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   6989:     foreach my $user (sort(keys(%courseroles))) {
                   6990: 	if ($user !~ /^(\w{2})/) { next; }
                   6991: 	my ($role) = ($user =~ /^(\w{2})/);
                   6992: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  6993: 	my ($section,$status);
1.240     albertel 6994: 	if ($role eq 'cr' &&
                   6995: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   6996: 	    $section=$1;
                   6997: 	}
                   6998: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   6999: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7000:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7001:         if ($end == -1 && $start == -1) {
                   7002:             next; #deleted role
                   7003:         }
                   7004:         if (!defined($possible_status)) { 
                   7005:             $sectioncount{$section}++;
                   7006:         } else {
                   7007:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7008:                 $status = 'active';
                   7009:             } elsif ($end < $now) {
                   7010:                 $status = 'future';
                   7011:             } elsif ($start > $now) {
                   7012:                 $status = 'previous';
                   7013:             }
                   7014:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7015:                 $sectioncount{$section}++;
                   7016:             }
                   7017:         }
1.233     raeburn  7018:     }
1.366     albertel 7019:     return %sectioncount;
1.233     raeburn  7020: }
                   7021: 
1.274     raeburn  7022: ###############################################
1.294     raeburn  7023: 
                   7024: =pod
1.405     albertel 7025: 
                   7026: =item * &get_course_users()
                   7027: 
1.275     raeburn  7028: Retrieves usernames:domains for users in the specified course
                   7029: with specific role(s), and access status. 
                   7030: 
                   7031: Incoming parameters:
1.277     albertel 7032: 1. course domain
                   7033: 2. course number
                   7034: 3. access status: users must have - either active, 
1.275     raeburn  7035: previous, future, or all.
1.277     albertel 7036: 4. reference to array of permissible roles
1.288     raeburn  7037: 5. reference to array of section restrictions (optional)
                   7038: 6. reference to results object (hash of hashes).
                   7039: 7. reference to optional userdata hash
1.609     raeburn  7040: 8. reference to optional statushash
1.630     raeburn  7041: 9. flag if privileged users (except those set to unhide in
                   7042:    course settings) should be excluded    
1.609     raeburn  7043: Keys of top level results hash are roles.
1.275     raeburn  7044: Keys of inner hashes are username:domain, with 
                   7045: values set to access type.
1.288     raeburn  7046: Optional userdata hash returns an array with arguments in the 
                   7047: same order as loncoursedata::get_classlist() for student data.
                   7048: 
1.609     raeburn  7049: Optional statushash returns
                   7050: 
1.288     raeburn  7051: Entries for end, start, section and status are blank because
                   7052: of the possibility of multiple values for non-student roles.
                   7053: 
1.275     raeburn  7054: =cut
1.405     albertel 7055: 
1.275     raeburn  7056: ###############################################
1.405     albertel 7057: 
1.275     raeburn  7058: sub get_course_users {
1.630     raeburn  7059:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7060:     my %idx = ();
1.419     raeburn  7061:     my %seclists;
1.288     raeburn  7062: 
                   7063:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7064:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7065:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7066:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7067:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7068:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7069:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7070:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7071: 
1.290     albertel 7072:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7073:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7074:         my $now = time;
1.277     albertel 7075:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7076:             my $match = 0;
1.412     raeburn  7077:             my $secmatch = 0;
1.419     raeburn  7078:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7079:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7080:             if ($section eq '') {
                   7081:                 $section = 'none';
                   7082:             }
1.291     albertel 7083:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7084:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7085:                     $secmatch = 1;
                   7086:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7087:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7088:                         $secmatch = 1;
                   7089:                     }
                   7090:                 } else {  
1.419     raeburn  7091: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7092: 		        $secmatch = 1;
                   7093:                     }
1.290     albertel 7094: 		}
1.412     raeburn  7095:                 if (!$secmatch) {
                   7096:                     next;
                   7097:                 }
1.419     raeburn  7098:             }
1.275     raeburn  7099:             if (defined($$types{'active'})) {
1.288     raeburn  7100:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7101:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7102:                     $match = 1;
1.275     raeburn  7103:                 }
                   7104:             }
                   7105:             if (defined($$types{'previous'})) {
1.609     raeburn  7106:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7107:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7108:                     $match = 1;
1.275     raeburn  7109:                 }
                   7110:             }
                   7111:             if (defined($$types{'future'})) {
1.609     raeburn  7112:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7113:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7114:                     $match = 1;
1.275     raeburn  7115:                 }
                   7116:             }
1.609     raeburn  7117:             if ($match) {
                   7118:                 push(@{$seclists{$student}},$section);
                   7119:                 if (ref($userdata) eq 'HASH') {
                   7120:                     $$userdata{$student} = $$classlist{$student};
                   7121:                 }
                   7122:                 if (ref($statushash) eq 'HASH') {
                   7123:                     $statushash->{$student}{'st'}{$section} = $status;
                   7124:                 }
1.288     raeburn  7125:             }
1.275     raeburn  7126:         }
                   7127:     }
1.412     raeburn  7128:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7129:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7130:         my $now = time;
1.609     raeburn  7131:         my %displaystatus = ( previous => 'Expired',
                   7132:                               active   => 'Active',
                   7133:                               future   => 'Future',
                   7134:                             );
1.630     raeburn  7135:         my %nothide;
                   7136:         if ($hidepriv) {
                   7137:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7138:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7139:                 if ($user !~ /:/) {
                   7140:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7141:                 } else {
                   7142:                     $nothide{$user} = 1;
                   7143:                 }
                   7144:             }
                   7145:         }
1.439     raeburn  7146:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7147:             my $match = 0;
1.412     raeburn  7148:             my $secmatch = 0;
1.439     raeburn  7149:             my $status;
1.412     raeburn  7150:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7151:             $user =~ s/:$//;
1.439     raeburn  7152:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7153:             if ($end == -1 || $start == -1) {
                   7154:                 next;
                   7155:             }
                   7156:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7157:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7158:                 my ($uname,$udom) = split(/:/,$user);
                   7159:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7160:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7161:                         $secmatch = 1;
                   7162:                     } elsif ($usec eq '') {
1.420     albertel 7163:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7164:                             $secmatch = 1;
                   7165:                         }
                   7166:                     } else {
                   7167:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7168:                             $secmatch = 1;
                   7169:                         }
                   7170:                     }
                   7171:                     if (!$secmatch) {
                   7172:                         next;
                   7173:                     }
1.288     raeburn  7174:                 }
1.419     raeburn  7175:                 if ($usec eq '') {
                   7176:                     $usec = 'none';
                   7177:                 }
1.275     raeburn  7178:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7179:                     if ($hidepriv) {
                   7180:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7181:                             (!$nothide{$uname.':'.$udom})) {
                   7182:                             next;
                   7183:                         }
                   7184:                     }
1.503     raeburn  7185:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7186:                         $status = 'previous';
                   7187:                     } elsif ($start > $now) {
                   7188:                         $status = 'future';
                   7189:                     } else {
                   7190:                         $status = 'active';
                   7191:                     }
1.277     albertel 7192:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7193:                         if ($status eq $type) {
1.420     albertel 7194:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7195:                                 push(@{$$users{$role}{$user}},$type);
                   7196:                             }
1.288     raeburn  7197:                             $match = 1;
                   7198:                         }
                   7199:                     }
1.419     raeburn  7200:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7201:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7202: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7203:                         }
1.420     albertel 7204:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7205:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7206:                         }
1.609     raeburn  7207:                         if (ref($statushash) eq 'HASH') {
                   7208:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7209:                         }
1.275     raeburn  7210:                     }
                   7211:                 }
                   7212:             }
                   7213:         }
1.290     albertel 7214:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7215:             if ((defined($cdom)) && (defined($cnum))) {
                   7216:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7217:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7218:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7219:                     next if ($owner eq '');
                   7220:                     my ($ownername,$ownerdom);
                   7221:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7222:                         $ownername = $1;
                   7223:                         $ownerdom = $2;
                   7224:                     } else {
                   7225:                         $ownername = $owner;
                   7226:                         $ownerdom = $cdom;
                   7227:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7228:                     }
                   7229:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7230:                     if (defined($userdata) && 
1.609     raeburn  7231: 			!exists($$userdata{$owner})) {
                   7232: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7233:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7234:                             push(@{$seclists{$owner}},'none');
                   7235:                         }
                   7236:                         if (ref($statushash) eq 'HASH') {
                   7237:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7238:                         }
1.290     albertel 7239: 		    }
1.279     raeburn  7240:                 }
                   7241:             }
                   7242:         }
1.419     raeburn  7243:         foreach my $user (keys(%seclists)) {
                   7244:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7245:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7246:         }
1.275     raeburn  7247:     }
                   7248:     return;
                   7249: }
                   7250: 
1.288     raeburn  7251: sub get_user_info {
                   7252:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7253:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7254: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7255:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7256:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7257:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7258:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7259:     return;
                   7260: }
1.275     raeburn  7261: 
1.472     raeburn  7262: ###############################################
                   7263: 
                   7264: =pod
                   7265: 
                   7266: =item * &get_user_quota()
                   7267: 
                   7268: Retrieves quota assigned for storage of portfolio files for a user  
                   7269: 
                   7270: Incoming parameters:
                   7271: 1. user's username
                   7272: 2. user's domain
                   7273: 
                   7274: Returns:
1.536     raeburn  7275: 1. Disk quota (in Mb) assigned to student.
                   7276: 2. (Optional) Type of setting: custom or default
                   7277:    (individually assigned or default for user's 
                   7278:    institutional status).
                   7279: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7280:    or student - types as defined in localenroll::inst_usertypes 
                   7281:    for user's domain, which determines default quota for user.
                   7282: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7283: 
                   7284: If a value has been stored in the user's environment, 
1.536     raeburn  7285: it will return that, otherwise it returns the maximal default
                   7286: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7287: 
                   7288: =cut
                   7289: 
                   7290: ###############################################
                   7291: 
                   7292: 
                   7293: sub get_user_quota {
                   7294:     my ($uname,$udom) = @_;
1.536     raeburn  7295:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7296:     if (!defined($udom)) {
                   7297:         $udom = $env{'user.domain'};
                   7298:     }
                   7299:     if (!defined($uname)) {
                   7300:         $uname = $env{'user.name'};
                   7301:     }
                   7302:     if (($udom eq '' || $uname eq '') ||
                   7303:         ($udom eq 'public') && ($uname eq 'public')) {
                   7304:         $quota = 0;
1.536     raeburn  7305:         $quotatype = 'default';
                   7306:         $defquota = 0; 
1.472     raeburn  7307:     } else {
1.536     raeburn  7308:         my $inststatus;
1.472     raeburn  7309:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7310:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7311:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7312:         } else {
1.536     raeburn  7313:             my %userenv = 
                   7314:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7315:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7316:             my ($tmp) = keys(%userenv);
                   7317:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7318:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7319:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7320:             } else {
                   7321:                 undef(%userenv);
                   7322:             }
                   7323:         }
1.536     raeburn  7324:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7325:         if ($quota eq '') {
1.536     raeburn  7326:             $quota = $defquota;
                   7327:             $quotatype = 'default';
                   7328:         } else {
                   7329:             $quotatype = 'custom';
1.472     raeburn  7330:         }
                   7331:     }
1.536     raeburn  7332:     if (wantarray) {
                   7333:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7334:     } else {
                   7335:         return $quota;
                   7336:     }
1.472     raeburn  7337: }
                   7338: 
                   7339: ###############################################
                   7340: 
                   7341: =pod
                   7342: 
                   7343: =item * &default_quota()
                   7344: 
1.536     raeburn  7345: Retrieves default quota assigned for storage of user portfolio files,
                   7346: given an (optional) user's institutional status.
1.472     raeburn  7347: 
                   7348: Incoming parameters:
                   7349: 1. domain
1.536     raeburn  7350: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7351:    status types (e.g., faculty, staff, student etc.)
                   7352:    which apply to the user for whom the default is being retrieved.
                   7353:    If the institutional status string in undefined, the domain
                   7354:    default quota will be returned. 
1.472     raeburn  7355: 
                   7356: Returns:
                   7357: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7358: 2. (Optional) institutional type which determined the value of the
                   7359:    default quota.
1.472     raeburn  7360: 
                   7361: If a value has been stored in the domain's configuration db,
                   7362: it will return that, otherwise it returns 20 (for backwards 
                   7363: compatibility with domains which have not set up a configuration
                   7364: db file; the original statically defined portfolio quota was 20 Mb). 
                   7365: 
1.536     raeburn  7366: If the user's status includes multiple types (e.g., staff and student),
                   7367: the largest default quota which applies to the user determines the
                   7368: default quota returned.
                   7369: 
1.780     raeburn  7370: =back
                   7371: 
1.472     raeburn  7372: =cut
                   7373: 
                   7374: ###############################################
                   7375: 
                   7376: 
                   7377: sub default_quota {
1.536     raeburn  7378:     my ($udom,$inststatus) = @_;
                   7379:     my ($defquota,$settingstatus);
                   7380:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7381:                                             ['quotas'],$udom);
                   7382:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7383:         if ($inststatus ne '') {
1.765     raeburn  7384:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7385:             foreach my $item (@statuses) {
1.711     raeburn  7386:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7387:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7388:                         if ($defquota eq '') {
                   7389:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7390:                             $settingstatus = $item;
                   7391:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7392:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7393:                             $settingstatus = $item;
                   7394:                         }
                   7395:                     }
                   7396:                 } else {
                   7397:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7398:                         if ($defquota eq '') {
                   7399:                             $defquota = $quotahash{'quotas'}{$item};
                   7400:                             $settingstatus = $item;
                   7401:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7402:                             $defquota = $quotahash{'quotas'}{$item};
                   7403:                             $settingstatus = $item;
                   7404:                         }
1.536     raeburn  7405:                     }
                   7406:                 }
                   7407:             }
                   7408:         }
                   7409:         if ($defquota eq '') {
1.711     raeburn  7410:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7411:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7412:             } else {
                   7413:                 $defquota = $quotahash{'quotas'}{'default'};
                   7414:             }
1.536     raeburn  7415:             $settingstatus = 'default';
                   7416:         }
                   7417:     } else {
                   7418:         $settingstatus = 'default';
                   7419:         $defquota = 20;
                   7420:     }
                   7421:     if (wantarray) {
                   7422:         return ($defquota,$settingstatus);
1.472     raeburn  7423:     } else {
1.536     raeburn  7424:         return $defquota;
1.472     raeburn  7425:     }
                   7426: }
                   7427: 
1.384     raeburn  7428: sub get_secgrprole_info {
                   7429:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7430:     my %sections_count = &get_sections($cdom,$cnum);
                   7431:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7432:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7433:     my @groups = sort(keys(%curr_groups));
                   7434:     my $allroles = [];
                   7435:     my $rolehash;
                   7436:     my $accesshash = {
                   7437:                      active => 'Currently has access',
                   7438:                      future => 'Will have future access',
                   7439:                      previous => 'Previously had access',
                   7440:                   };
                   7441:     if ($needroles) {
                   7442:         $rolehash = {'all' => 'all'};
1.385     albertel 7443:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7444: 	if (&Apache::lonnet::error(%user_roles)) {
                   7445: 	    undef(%user_roles);
                   7446: 	}
                   7447:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7448:             my ($role)=split(/\:/,$item,2);
                   7449:             if ($role eq 'cr') { next; }
                   7450:             if ($role =~ /^cr/) {
                   7451:                 $$rolehash{$role} = (split('/',$role))[3];
                   7452:             } else {
                   7453:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7454:             }
                   7455:         }
                   7456:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7457:             push(@{$allroles},$key);
                   7458:         }
                   7459:         push (@{$allroles},'st');
                   7460:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7461:     }
                   7462:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7463: }
                   7464: 
1.555     raeburn  7465: sub user_picker {
1.627     raeburn  7466:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7467:     my $currdom = $dom;
                   7468:     my %curr_selected = (
                   7469:                         srchin => 'dom',
1.580     raeburn  7470:                         srchby => 'lastname',
1.555     raeburn  7471:                       );
                   7472:     my $srchterm;
1.625     raeburn  7473:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7474:         if ($srch->{'srchby'} ne '') {
                   7475:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7476:         }
                   7477:         if ($srch->{'srchin'} ne '') {
                   7478:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7479:         }
                   7480:         if ($srch->{'srchtype'} ne '') {
                   7481:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7482:         }
                   7483:         if ($srch->{'srchdomain'} ne '') {
                   7484:             $currdom = $srch->{'srchdomain'};
                   7485:         }
                   7486:         $srchterm = $srch->{'srchterm'};
                   7487:     }
                   7488:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7489:                     'usr'       => 'Search criteria',
1.563     raeburn  7490:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7491:                     'uname'     => 'username',
                   7492:                     'lastname'  => 'last name',
1.555     raeburn  7493:                     'lastfirst' => 'last name, first name',
1.558     albertel 7494:                     'crs'       => 'in this course',
1.576     raeburn  7495:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7496:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7497:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7498:                     'exact'     => 'is',
                   7499:                     'contains'  => 'contains',
1.569     raeburn  7500:                     'begins'    => 'begins with',
1.571     raeburn  7501:                     'youm'      => "You must include some text to search for.",
                   7502:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7503:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7504:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7505:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7506:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7507:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7508:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7509:                                        );
1.563     raeburn  7510:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   7511:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  7512: 
                   7513:     my @srchins = ('crs','dom','alc','instd');
                   7514: 
                   7515:     foreach my $option (@srchins) {
                   7516:         # FIXME 'alc' option unavailable until 
                   7517:         #       loncreateuser::print_user_query_page()
                   7518:         #       has been completed.
                   7519:         next if ($option eq 'alc');
                   7520:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  7521:         if ($curr_selected{'srchin'} eq $option) {
                   7522:             $srchinsel .= ' 
                   7523:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7524:         } else {
                   7525:             $srchinsel .= '
                   7526:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7527:         }
1.555     raeburn  7528:     }
1.563     raeburn  7529:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7530: 
                   7531:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7532:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7533:         if ($curr_selected{'srchby'} eq $option) {
                   7534:             $srchbysel .= '
                   7535:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7536:         } else {
                   7537:             $srchbysel .= '
                   7538:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7539:          }
                   7540:     }
                   7541:     $srchbysel .= "\n  </select>\n";
                   7542: 
                   7543:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7544:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7545:         if ($curr_selected{'srchtype'} eq $option) {
                   7546:             $srchtypesel .= '
                   7547:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7548:         } else {
                   7549:             $srchtypesel .= '
                   7550:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7551:         }
                   7552:     }
                   7553:     $srchtypesel .= "\n  </select>\n";
                   7554: 
1.558     albertel 7555:     my ($newuserscript,$new_user_create);
1.556     raeburn  7556: 
                   7557:     if ($forcenewuser) {
1.576     raeburn  7558:         if (ref($srch) eq 'HASH') {
                   7559:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7560:                 if ($cancreate) {
                   7561:                     $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>';
                   7562:                 } else {
1.799     bisitz   7563:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7564:                     my %usertypetext = (
                   7565:                         official   => 'institutional',
                   7566:                         unofficial => 'non-institutional',
                   7567:                     );
1.799     bisitz   7568:                     $new_user_create = '<p class="LC_warning">'
                   7569:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   7570:                                       .' '
                   7571:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7572:                                           ,'<a href="'.$helplink.'">','</a>')
                   7573:                                       .'</p><br />';
1.627     raeburn  7574:                 }
1.576     raeburn  7575:             }
                   7576:         }
                   7577: 
1.556     raeburn  7578:         $newuserscript = <<"ENDSCRIPT";
                   7579: 
1.570     raeburn  7580: function setSearch(createnew,callingForm) {
1.556     raeburn  7581:     if (createnew == 1) {
1.570     raeburn  7582:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7583:             if (callingForm.srchby.options[i].value == 'uname') {
                   7584:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7585:             }
                   7586:         }
1.570     raeburn  7587:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7588:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7589: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7590:             }
                   7591:         }
1.570     raeburn  7592:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7593:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7594:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7595:             }
                   7596:         }
1.570     raeburn  7597:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7598:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7599:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7600:             }
                   7601:         }
                   7602:     }
                   7603: }
                   7604: ENDSCRIPT
1.558     albertel 7605: 
1.556     raeburn  7606:     }
                   7607: 
1.555     raeburn  7608:     my $output = <<"END_BLOCK";
1.556     raeburn  7609: <script type="text/javascript">
1.824     bisitz   7610: // <![CDATA[
1.570     raeburn  7611: function validateEntry(callingForm) {
1.558     albertel 7612: 
1.556     raeburn  7613:     var checkok = 1;
1.558     albertel 7614:     var srchin;
1.570     raeburn  7615:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7616: 	if ( callingForm.srchin[i].checked ) {
                   7617: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7618: 	}
                   7619:     }
                   7620: 
1.570     raeburn  7621:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7622:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7623:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7624:     var srchterm =  callingForm.srchterm.value;
                   7625:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7626:     var msg = "";
                   7627: 
                   7628:     if (srchterm == "") {
                   7629:         checkok = 0;
1.571     raeburn  7630:         msg += "$lt{'youm'}\\n";
1.556     raeburn  7631:     }
                   7632: 
1.569     raeburn  7633:     if (srchtype== 'begins') {
                   7634:         if (srchterm.length < 2) {
                   7635:             checkok = 0;
1.571     raeburn  7636:             msg += "$lt{'thte'}\\n";
1.569     raeburn  7637:         }
                   7638:     }
                   7639: 
1.556     raeburn  7640:     if (srchtype== 'contains') {
                   7641:         if (srchterm.length < 3) {
                   7642:             checkok = 0;
1.571     raeburn  7643:             msg += "$lt{'thet'}\\n";
1.556     raeburn  7644:         }
                   7645:     }
                   7646:     if (srchin == 'instd') {
                   7647:         if (srchdomain == '') {
                   7648:             checkok = 0;
1.571     raeburn  7649:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  7650:         }
                   7651:     }
                   7652:     if (srchin == 'dom') {
                   7653:         if (srchdomain == '') {
                   7654:             checkok = 0;
1.571     raeburn  7655:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  7656:         }
                   7657:     }
                   7658:     if (srchby == 'lastfirst') {
                   7659:         if (srchterm.indexOf(",") == -1) {
                   7660:             checkok = 0;
1.571     raeburn  7661:             msg += "$lt{'whus'}\\n";
1.556     raeburn  7662:         }
                   7663:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   7664:             checkok = 0;
1.571     raeburn  7665:             msg += "$lt{'whse'}\\n";
1.556     raeburn  7666:         }
                   7667:     }
                   7668:     if (checkok == 0) {
1.571     raeburn  7669:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  7670:         return;
                   7671:     }
                   7672:     if (checkok == 1) {
1.570     raeburn  7673:         callingForm.submit();
1.556     raeburn  7674:     }
                   7675: }
                   7676: 
                   7677: $newuserscript
                   7678: 
1.824     bisitz   7679: // ]]>
1.556     raeburn  7680: </script>
1.558     albertel 7681: 
                   7682: $new_user_create
                   7683: 
1.555     raeburn  7684: <table>
1.558     albertel 7685:  <tr>
1.573     raeburn  7686:   <td>$lt{'doma'}:</td>
                   7687:   <td>$domform</td>
                   7688:   </td>
                   7689:  </tr>
                   7690:  <tr>
                   7691:   <td>$lt{'usr'}:</td>
1.563     raeburn  7692:   <td>$srchbysel
                   7693:       $srchtypesel 
                   7694:       <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564     albertel 7695:       $srchinsel 
1.563     raeburn  7696:   </td>
                   7697:  </tr>
1.555     raeburn  7698: </table>
                   7699: <br />
                   7700: END_BLOCK
1.558     albertel 7701: 
1.555     raeburn  7702:     return $output;
                   7703: }
                   7704: 
1.612     raeburn  7705: sub user_rule_check {
1.615     raeburn  7706:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  7707:     my $response;
                   7708:     if (ref($usershash) eq 'HASH') {
                   7709:         foreach my $user (keys(%{$usershash})) {
                   7710:             my ($uname,$udom) = split(/:/,$user);
                   7711:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  7712:             my ($id,$newuser);
1.612     raeburn  7713:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  7714:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  7715:                 $id = $usershash->{$user}->{'id'};
                   7716:             }
                   7717:             my $inst_response;
                   7718:             if (ref($checks) eq 'HASH') {
                   7719:                 if (defined($checks->{'username'})) {
1.615     raeburn  7720:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  7721:                         &Apache::lonnet::get_instuser($udom,$uname);
                   7722:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  7723:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  7724:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   7725:                 }
1.615     raeburn  7726:             } else {
                   7727:                 ($inst_response,%{$inst_results->{$user}}) =
                   7728:                     &Apache::lonnet::get_instuser($udom,$uname);
                   7729:                 return;
1.612     raeburn  7730:             }
1.615     raeburn  7731:             if (!$got_rules->{$udom}) {
1.612     raeburn  7732:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   7733:                                                   ['usercreation'],$udom);
                   7734:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  7735:                     foreach my $item ('username','id') {
1.612     raeburn  7736:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   7737:                             $$curr_rules{$udom}{$item} = 
                   7738:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  7739:                         }
                   7740:                     }
                   7741:                 }
1.615     raeburn  7742:                 $got_rules->{$udom} = 1;  
1.585     raeburn  7743:             }
1.612     raeburn  7744:             foreach my $item (keys(%{$checks})) {
                   7745:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   7746:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   7747:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   7748:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   7749:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   7750:                                 if ($rule_check{$rule}) {
                   7751:                                     $$rulematch{$user}{$item} = $rule;
                   7752:                                     if ($inst_response eq 'ok') {
1.615     raeburn  7753:                                         if (ref($inst_results) eq 'HASH') {
                   7754:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   7755:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   7756:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   7757:                                                 }
1.612     raeburn  7758:                                             }
                   7759:                                         }
1.615     raeburn  7760:                                     }
                   7761:                                     last;
1.585     raeburn  7762:                                 }
                   7763:                             }
                   7764:                         }
                   7765:                     }
                   7766:                 }
                   7767:             }
                   7768:         }
                   7769:     }
1.612     raeburn  7770:     return;
                   7771: }
                   7772: 
                   7773: sub user_rule_formats {
                   7774:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   7775:     my %text = ( 
                   7776:                  'username' => 'Usernames',
                   7777:                  'id'       => 'IDs',
                   7778:                );
                   7779:     my $output;
                   7780:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   7781:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   7782:         if (@{$ruleorder} > 0) {
                   7783:             $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>';
                   7784:             foreach my $rule (@{$ruleorder}) {
                   7785:                 if (ref($curr_rules) eq 'ARRAY') {
                   7786:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   7787:                         if (ref($rules->{$rule}) eq 'HASH') {
                   7788:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   7789:                                         $rules->{$rule}{'desc'}.'</li>';
                   7790:                         }
                   7791:                     }
                   7792:                 }
                   7793:             }
                   7794:             $output .= '</ul>';
                   7795:         }
                   7796:     }
                   7797:     return $output;
                   7798: }
                   7799: 
                   7800: sub instrule_disallow_msg {
1.615     raeburn  7801:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  7802:     my $response;
                   7803:     my %text = (
                   7804:                   item   => 'username',
                   7805:                   items  => 'usernames',
                   7806:                   match  => 'matches',
                   7807:                   do     => 'does',
                   7808:                   action => 'a username',
                   7809:                   one    => 'one',
                   7810:                );
                   7811:     if ($count > 1) {
                   7812:         $text{'item'} = 'usernames';
                   7813:         $text{'match'} ='match';
                   7814:         $text{'do'} = 'do';
                   7815:         $text{'action'} = 'usernames',
                   7816:         $text{'one'} = 'ones';
                   7817:     }
                   7818:     if ($checkitem eq 'id') {
                   7819:         $text{'items'} = 'IDs';
                   7820:         $text{'item'} = 'ID';
                   7821:         $text{'action'} = 'an ID';
1.615     raeburn  7822:         if ($count > 1) {
                   7823:             $text{'item'} = 'IDs';
                   7824:             $text{'action'} = 'IDs';
                   7825:         }
1.612     raeburn  7826:     }
1.674     bisitz   7827:     $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  7828:     if ($mode eq 'upload') {
                   7829:         if ($checkitem eq 'username') {
                   7830:             $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'}.");
                   7831:         } elsif ($checkitem eq 'id') {
1.674     bisitz   7832:             $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  7833:         }
1.669     raeburn  7834:     } elsif ($mode eq 'selfcreate') {
                   7835:         if ($checkitem eq 'id') {
                   7836:             $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.");
                   7837:         }
1.615     raeburn  7838:     } else {
                   7839:         if ($checkitem eq 'username') {
                   7840:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   7841:         } elsif ($checkitem eq 'id') {
                   7842:             $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.");
                   7843:         }
1.612     raeburn  7844:     }
                   7845:     return $response;
1.585     raeburn  7846: }
                   7847: 
1.624     raeburn  7848: sub personal_data_fieldtitles {
                   7849:     my %fieldtitles = &Apache::lonlocal::texthash (
                   7850:                         id => 'Student/Employee ID',
                   7851:                         permanentemail => 'E-mail address',
                   7852:                         lastname => 'Last Name',
                   7853:                         firstname => 'First Name',
                   7854:                         middlename => 'Middle Name',
                   7855:                         generation => 'Generation',
                   7856:                         gen => 'Generation',
1.765     raeburn  7857:                         inststatus => 'Affiliation',
1.624     raeburn  7858:                    );
                   7859:     return %fieldtitles;
                   7860: }
                   7861: 
1.642     raeburn  7862: sub sorted_inst_types {
                   7863:     my ($dom) = @_;
                   7864:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   7865:     my $othertitle = &mt('All users');
                   7866:     if ($env{'request.course.id'}) {
1.668     raeburn  7867:         $othertitle  = &mt('Any users');
1.642     raeburn  7868:     }
                   7869:     my @types;
                   7870:     if (ref($order) eq 'ARRAY') {
                   7871:         @types = @{$order};
                   7872:     }
                   7873:     if (@types == 0) {
                   7874:         if (ref($usertypes) eq 'HASH') {
                   7875:             @types = sort(keys(%{$usertypes}));
                   7876:         }
                   7877:     }
                   7878:     if (keys(%{$usertypes}) > 0) {
                   7879:         $othertitle = &mt('Other users');
                   7880:     }
                   7881:     return ($othertitle,$usertypes,\@types);
                   7882: }
                   7883: 
1.645     raeburn  7884: sub get_institutional_codes {
                   7885:     my ($settings,$allcourses,$LC_code) = @_;
                   7886: # Get complete list of course sections to update
                   7887:     my @currsections = ();
                   7888:     my @currxlists = ();
                   7889:     my $coursecode = $$settings{'internal.coursecode'};
                   7890: 
                   7891:     if ($$settings{'internal.sectionnums'} ne '') {
                   7892:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   7893:     }
                   7894: 
                   7895:     if ($$settings{'internal.crosslistings'} ne '') {
                   7896:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   7897:     }
                   7898: 
                   7899:     if (@currxlists > 0) {
                   7900:         foreach (@currxlists) {
                   7901:             if (m/^([^:]+):(\w*)$/) {
                   7902:                 unless (grep/^$1$/,@{$allcourses}) {
                   7903:                     push @{$allcourses},$1;
                   7904:                     $$LC_code{$1} = $2;
                   7905:                 }
                   7906:             }
                   7907:         }
                   7908:     }
                   7909:  
                   7910:     if (@currsections > 0) {
                   7911:         foreach (@currsections) {
                   7912:             if (m/^(\w+):(\w*)$/) {
                   7913:                 my $sec = $coursecode.$1;
                   7914:                 my $lc_sec = $2;
                   7915:                 unless (grep/^$sec$/,@{$allcourses}) {
                   7916:                     push @{$allcourses},$sec;
                   7917:                     $$LC_code{$sec} = $lc_sec;
                   7918:                 }
                   7919:             }
                   7920:         }
                   7921:     }
                   7922:     return;
                   7923: }
                   7924: 
1.112     bowersj2 7925: =pod
                   7926: 
1.780     raeburn  7927: =head1 Slot Helpers
                   7928: 
                   7929: =over 4
                   7930: 
                   7931: =item * sorted_slots()
                   7932: 
                   7933: Sorts an array of slot names in order of slot start time (earliest first). 
                   7934: 
                   7935: Inputs:
                   7936: 
                   7937: =over 4
                   7938: 
                   7939: slotsarr  - Reference to array of unsorted slot names.
                   7940: 
                   7941: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   7942: 
1.549     albertel 7943: =back
                   7944: 
1.780     raeburn  7945: Returns:
                   7946: 
                   7947: =over 4
                   7948: 
                   7949: sorted   - An array of slot names sorted by the start time of the slot.
                   7950: 
                   7951: =back
                   7952: 
                   7953: =back
                   7954: 
                   7955: =cut
                   7956: 
                   7957: 
                   7958: sub sorted_slots {
                   7959:     my ($slotsarr,$slots) = @_;
                   7960:     my @sorted;
                   7961:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   7962:         @sorted =
                   7963:             sort {
                   7964:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   7965:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   7966:                      }
                   7967:                      if (ref($slots->{$a})) { return -1;}
                   7968:                      if (ref($slots->{$b})) { return 1;}
                   7969:                      return 0;
                   7970:                  } @{$slotsarr};
                   7971:     }
                   7972:     return @sorted;
                   7973: }
                   7974: 
                   7975: 
                   7976: =pod
                   7977: 
1.549     albertel 7978: =head1 HTTP Helpers
                   7979: 
                   7980: =over 4
                   7981: 
1.648     raeburn  7982: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 7983: 
1.258     albertel 7984: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 7985: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 7986: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 7987: 
                   7988: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   7989: $possible_names is an ref to an array of form element names.  As an example:
                   7990: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 7991: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 7992: 
                   7993: =cut
1.1       albertel 7994: 
1.6       albertel 7995: sub get_unprocessed_cgi {
1.25      albertel 7996:   my ($query,$possible_names)= @_;
1.26      matthew  7997:   # $Apache::lonxml::debug=1;
1.356     albertel 7998:   foreach my $pair (split(/&/,$query)) {
                   7999:     my ($name, $value) = split(/=/,$pair);
1.369     www      8000:     $name = &unescape($name);
1.25      albertel 8001:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8002:       $value =~ tr/+/ /;
                   8003:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8004:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8005:     }
1.16      harris41 8006:   }
1.6       albertel 8007: }
                   8008: 
1.112     bowersj2 8009: =pod
                   8010: 
1.648     raeburn  8011: =item * &cacheheader() 
1.112     bowersj2 8012: 
                   8013: returns cache-controlling header code
                   8014: 
                   8015: =cut
                   8016: 
1.7       albertel 8017: sub cacheheader {
1.258     albertel 8018:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8019:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8020:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8021:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8022:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8023:     return $output;
1.7       albertel 8024: }
                   8025: 
1.112     bowersj2 8026: =pod
                   8027: 
1.648     raeburn  8028: =item * &no_cache($r) 
1.112     bowersj2 8029: 
                   8030: specifies header code to not have cache
                   8031: 
                   8032: =cut
                   8033: 
1.9       albertel 8034: sub no_cache {
1.216     albertel 8035:     my ($r) = @_;
                   8036:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8037: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8038:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8039:     $r->no_cache(1);
                   8040:     $r->header_out("Expires" => $date);
                   8041:     $r->header_out("Pragma" => "no-cache");
1.123     www      8042: }
                   8043: 
                   8044: sub content_type {
1.181     albertel 8045:     my ($r,$type,$charset) = @_;
1.299     foxr     8046:     if ($r) {
                   8047: 	#  Note that printout.pl calls this with undef for $r.
                   8048: 	&no_cache($r);
                   8049:     }
1.258     albertel 8050:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8051:     unless ($charset) {
                   8052: 	$charset=&Apache::lonlocal::current_encoding;
                   8053:     }
                   8054:     if ($charset) { $type.='; charset='.$charset; }
                   8055:     if ($r) {
                   8056: 	$r->content_type($type);
                   8057:     } else {
                   8058: 	print("Content-type: $type\n\n");
                   8059:     }
1.9       albertel 8060: }
1.25      albertel 8061: 
1.112     bowersj2 8062: =pod
                   8063: 
1.648     raeburn  8064: =item * &add_to_env($name,$value) 
1.112     bowersj2 8065: 
1.258     albertel 8066: adds $name to the %env hash with value
1.112     bowersj2 8067: $value, if $name already exists, the entry is converted to an array
                   8068: reference and $value is added to the array.
                   8069: 
                   8070: =cut
                   8071: 
1.25      albertel 8072: sub add_to_env {
                   8073:   my ($name,$value)=@_;
1.258     albertel 8074:   if (defined($env{$name})) {
                   8075:     if (ref($env{$name})) {
1.25      albertel 8076:       #already have multiple values
1.258     albertel 8077:       push(@{ $env{$name} },$value);
1.25      albertel 8078:     } else {
                   8079:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8080:       my $first=$env{$name};
                   8081:       undef($env{$name});
                   8082:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8083:     }
                   8084:   } else {
1.258     albertel 8085:     $env{$name}=$value;
1.25      albertel 8086:   }
1.31      albertel 8087: }
1.149     albertel 8088: 
                   8089: =pod
                   8090: 
1.648     raeburn  8091: =item * &get_env_multiple($name) 
1.149     albertel 8092: 
1.258     albertel 8093: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8094: values may be defined and end up as an array ref.
                   8095: 
                   8096: returns an array of values
                   8097: 
                   8098: =cut
                   8099: 
                   8100: sub get_env_multiple {
                   8101:     my ($name) = @_;
                   8102:     my @values;
1.258     albertel 8103:     if (defined($env{$name})) {
1.149     albertel 8104:         # exists is it an array
1.258     albertel 8105:         if (ref($env{$name})) {
                   8106:             @values=@{ $env{$name} };
1.149     albertel 8107:         } else {
1.258     albertel 8108:             $values[0]=$env{$name};
1.149     albertel 8109:         }
                   8110:     }
                   8111:     return(@values);
                   8112: }
                   8113: 
1.660     raeburn  8114: sub ask_for_embedded_content {
                   8115:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8116:     my $upload_output = '
                   8117:    <form name="upload_embedded" action="'.$actionurl.'"
                   8118:                   method="post" enctype="multipart/form-data">';
                   8119:     $upload_output .= $state;
1.661     raeburn  8120:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8121: 
                   8122:     my $num = 0;
                   8123:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8124:         $upload_output .= &start_data_table_row().
                   8125:             '<td>'.$embed_file.'</td><td>';
                   8126:         if ($args->{'ignore_remote_references'}
                   8127:             && $embed_file =~ m{^\w+://}) {
                   8128:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8129:         } elsif ($args->{'error_on_invalid_names'}
                   8130:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8131: 
                   8132:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8133: 
                   8134:         } else {
                   8135:             $upload_output .='
1.661     raeburn  8136:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8137:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8138:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8139:             $upload_output .=
                   8140:                 "\n\t\t".
                   8141:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8142:                 $attrib.'" />';
                   8143:             if (exists($$codebase{$embed_file})) {
                   8144:                 $upload_output .=
                   8145:                     "\n\t\t".
                   8146:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8147:                     &escape($$codebase{$embed_file}).'" />';
                   8148:             }
                   8149:         }
                   8150:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8151:         $num++;
                   8152:     }
                   8153:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8154:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8155:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8156:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8157:    </form>';
                   8158:     return $upload_output;
                   8159: }
                   8160: 
1.661     raeburn  8161: sub upload_embedded {
                   8162:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8163:         $current_disk_usage) = @_;
                   8164:     my $output;
                   8165:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8166:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8167:         my $orig_uploaded_filename =
                   8168:             $env{'form.embedded_item_'.$i.'.filename'};
                   8169: 
                   8170:         $env{'form.embedded_orig_'.$i} =
                   8171:             &unescape($env{'form.embedded_orig_'.$i});
                   8172:         my ($path,$fname) =
                   8173:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8174:         # no path, whole string is fname
                   8175:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8176: 
                   8177:         $path = $env{'form.currentpath'}.$path;
                   8178:         $fname = &Apache::lonnet::clean_filename($fname);
                   8179:         # See if there is anything left
                   8180:         next if ($fname eq '');
                   8181: 
                   8182:         # Check if file already exists as a file or directory.
                   8183:         my ($state,$msg);
                   8184:         if ($context eq 'portfolio') {
                   8185:             my $port_path = $dirpath;
                   8186:             if ($group ne '') {
                   8187:                 $port_path = "groups/$group/$port_path";
                   8188:             }
                   8189:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8190:                                               $dir_root,$port_path,$disk_quota,
                   8191:                                               $current_disk_usage,$uname,$udom);
                   8192:             if ($state eq 'will_exceed_quota'
                   8193:                 || $state eq 'file_locked'
                   8194:                 || $state eq 'file_exists' ) {
                   8195:                 $output .= $msg;
                   8196:                 next;
                   8197:             }
                   8198:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8199:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8200:             if ($state eq 'exists') {
                   8201:                 $output .= $msg;
                   8202:                 next;
                   8203:             }
                   8204:         }
                   8205:         # Check if extension is valid
                   8206:         if (($fname =~ /\.(\w+)$/) &&
                   8207:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8208:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8209:             next;
                   8210:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8211:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8212:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8213:             next;
                   8214:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8215:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8216:             next;
                   8217:         }
                   8218: 
                   8219:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8220:         if ($context eq 'portfolio') {
                   8221:             my $result=
                   8222:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8223:                                                 $dirpath.$path);
                   8224:             if ($result !~ m|^/uploaded/|) {
                   8225:                 $output .= '<span class="LC_error">'
                   8226:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8227:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8228:                       .'</span><br />';
                   8229:                 next;
                   8230:             } else {
                   8231:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8232:                            $path.$fname.'</span>').'</p>';     
                   8233:             }
                   8234:         } else {
                   8235: # Save the file
                   8236:             my $target = $env{'form.embedded_item_'.$i};
                   8237:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8238:             my $dest = $fullpath.$fname;
                   8239:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8240:             my @parts=split(/\//,$fullpath);
                   8241:             my $count;
                   8242:             my $filepath = $dir_root;
                   8243:             for ($count=4;$count<=$#parts;$count++) {
                   8244:                 $filepath .= "/$parts[$count]";
                   8245:                 if ((-e $filepath)!=1) {
                   8246:                     mkdir($filepath,0770);
                   8247:                 }
                   8248:             }
                   8249:             my $fh;
                   8250:             if (!open($fh,'>'.$dest)) {
                   8251:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8252:                 $output .= '<span class="LC_error">'.
                   8253:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8254:                            '</span><br />';
                   8255:             } else {
                   8256:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8257:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8258:                     $output .= '<span class="LC_error">'.
                   8259:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8260:                               '</span><br />';
                   8261:                 } else {
                   8262:                     if ($context eq 'testbank') {
                   8263:                         $output .= &mt('Embedded file uploaded successfully:').
                   8264:                                    '&nbsp;<a href="'.$url.'">'.
                   8265:                                    $orig_uploaded_filename.'</a><br />';
                   8266:                     } else {
1.705     tempelho 8267:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8268:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8269:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8270:                     }
                   8271:                 }
                   8272:                 close($fh);
                   8273:             }
                   8274:         }
                   8275:     }
                   8276:     return $output;
                   8277: }
                   8278: 
                   8279: sub check_for_existing {
                   8280:     my ($path,$fname,$element) = @_;
                   8281:     my ($state,$msg);
                   8282:     if (-d $path.'/'.$fname) {
                   8283:         $state = 'exists';
                   8284:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8285:     } elsif (-e $path.'/'.$fname) {
                   8286:         $state = 'exists';
                   8287:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8288:     }
                   8289:     if ($state eq 'exists') {
                   8290:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8291:     }
                   8292:     return ($state,$msg);
                   8293: }
                   8294: 
                   8295: sub check_for_upload {
                   8296:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8297:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8298:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8299:     my $getpropath = 1;
                   8300:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8301:                                             $getpropath);
                   8302:     my $found_file = 0;
                   8303:     my $locked_file = 0;
                   8304:     foreach my $line (@dir_list) {
                   8305:         my ($file_name)=split(/\&/,$line,2);
                   8306:         if ($file_name eq $fname){
                   8307:             $file_name = $path.$file_name;
                   8308:             if ($group ne '') {
                   8309:                 $file_name = $group.$file_name;
                   8310:             }
                   8311:             $found_file = 1;
                   8312:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8313:                 $locked_file = 1;
                   8314:             }
                   8315:         }
                   8316:     }
                   8317:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8318:         my $msg = '<span class="LC_error">'.
                   8319:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8320:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8321:         return ('will_exceed_quota',$msg);
                   8322:     } elsif ($found_file) {
                   8323:         if ($locked_file) {
                   8324:             my $msg = '<span class="LC_error">';
                   8325:             $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>');
                   8326:             $msg .= '</span><br />';
                   8327:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8328:             return ('file_locked',$msg);
                   8329:         } else {
                   8330:             my $msg = '<span class="LC_error">';
                   8331:             $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'});
                   8332:             $msg .= '</span>';
                   8333:             $msg .= '<br />';
                   8334:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8335:             return ('file_exists',$msg);
                   8336:         }
                   8337:     }
                   8338: }
                   8339: 
1.31      albertel 8340: 
1.41      ng       8341: =pod
1.45      matthew  8342: 
1.464     albertel 8343: =back
1.41      ng       8344: 
1.112     bowersj2 8345: =head1 CSV Upload/Handling functions
1.38      albertel 8346: 
1.41      ng       8347: =over 4
                   8348: 
1.648     raeburn  8349: =item * &upfile_store($r)
1.41      ng       8350: 
                   8351: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8352: needs $env{'form.upfile'}
1.41      ng       8353: returns $datatoken to be put into hidden field
                   8354: 
                   8355: =cut
1.31      albertel 8356: 
                   8357: sub upfile_store {
                   8358:     my $r=shift;
1.258     albertel 8359:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8360:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8361:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8362:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8363: 
1.258     albertel 8364:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8365: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8366:     {
1.158     raeburn  8367:         my $datafile = $r->dir_config('lonDaemons').
                   8368:                            '/tmp/'.$datatoken.'.tmp';
                   8369:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8370:             print $fh $env{'form.upfile'};
1.158     raeburn  8371:             close($fh);
                   8372:         }
1.31      albertel 8373:     }
                   8374:     return $datatoken;
                   8375: }
                   8376: 
1.56      matthew  8377: =pod
                   8378: 
1.648     raeburn  8379: =item * &load_tmp_file($r)
1.41      ng       8380: 
                   8381: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8382: needs $env{'form.datatoken'},
                   8383: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8384: 
                   8385: =cut
1.31      albertel 8386: 
                   8387: sub load_tmp_file {
                   8388:     my $r=shift;
                   8389:     my @studentdata=();
                   8390:     {
1.158     raeburn  8391:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8392:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8393:         if ( open(my $fh,"<$studentfile") ) {
                   8394:             @studentdata=<$fh>;
                   8395:             close($fh);
                   8396:         }
1.31      albertel 8397:     }
1.258     albertel 8398:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8399: }
                   8400: 
1.56      matthew  8401: =pod
                   8402: 
1.648     raeburn  8403: =item * &upfile_record_sep()
1.41      ng       8404: 
                   8405: Separate uploaded file into records
                   8406: returns array of records,
1.258     albertel 8407: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8408: 
                   8409: =cut
1.31      albertel 8410: 
                   8411: sub upfile_record_sep {
1.258     albertel 8412:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8413:     } else {
1.248     albertel 8414: 	my @records;
1.258     albertel 8415: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8416: 	    if ($line=~/^\s*$/) { next; }
                   8417: 	    push(@records,$line);
                   8418: 	}
                   8419: 	return @records;
1.31      albertel 8420:     }
                   8421: }
                   8422: 
1.56      matthew  8423: =pod
                   8424: 
1.648     raeburn  8425: =item * &record_sep($record)
1.41      ng       8426: 
1.258     albertel 8427: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8428: 
                   8429: =cut
                   8430: 
1.263     www      8431: sub takeleft {
                   8432:     my $index=shift;
                   8433:     return substr('0000'.$index,-4,4);
                   8434: }
                   8435: 
1.31      albertel 8436: sub record_sep {
                   8437:     my $record=shift;
                   8438:     my %components=();
1.258     albertel 8439:     if ($env{'form.upfiletype'} eq 'xml') {
                   8440:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8441:         my $i=0;
1.356     albertel 8442:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8443:             $field=~s/^(\"|\')//;
                   8444:             $field=~s/(\"|\')$//;
1.263     www      8445:             $components{&takeleft($i)}=$field;
1.31      albertel 8446:             $i++;
                   8447:         }
1.258     albertel 8448:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8449:         my $i=0;
1.356     albertel 8450:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8451:             $field=~s/^(\"|\')//;
                   8452:             $field=~s/(\"|\')$//;
1.263     www      8453:             $components{&takeleft($i)}=$field;
1.31      albertel 8454:             $i++;
                   8455:         }
                   8456:     } else {
1.561     www      8457:         my $separator=',';
1.480     banghart 8458:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8459:             $separator=';';
1.480     banghart 8460:         }
1.31      albertel 8461:         my $i=0;
1.561     www      8462: # the character we are looking for to indicate the end of a quote or a record 
                   8463:         my $looking_for=$separator;
                   8464: # do not add the characters to the fields
                   8465:         my $ignore=0;
                   8466: # we just encountered a separator (or the beginning of the record)
                   8467:         my $just_found_separator=1;
                   8468: # store the field we are working on here
                   8469:         my $field='';
                   8470: # work our way through all characters in record
                   8471:         foreach my $character ($record=~/(.)/g) {
                   8472:             if ($character eq $looking_for) {
                   8473:                if ($character ne $separator) {
                   8474: # Found the end of a quote, again looking for separator
                   8475:                   $looking_for=$separator;
                   8476:                   $ignore=1;
                   8477:                } else {
                   8478: # Found a separator, store away what we got
                   8479:                   $components{&takeleft($i)}=$field;
                   8480: 	          $i++;
                   8481:                   $just_found_separator=1;
                   8482:                   $ignore=0;
                   8483:                   $field='';
                   8484:                }
                   8485:                next;
                   8486:             }
                   8487: # single or double quotation marks after a separator indicate beginning of a quote
                   8488: # we are now looking for the end of the quote and need to ignore separators
                   8489:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8490:                $looking_for=$character;
                   8491:                next;
                   8492:             }
                   8493: # ignore would be true after we reached the end of a quote
                   8494:             if ($ignore) { next; }
                   8495:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8496:             $field.=$character;
                   8497:             $just_found_separator=0; 
1.31      albertel 8498:         }
1.561     www      8499: # catch the very last entry, since we never encountered the separator
                   8500:         $components{&takeleft($i)}=$field;
1.31      albertel 8501:     }
                   8502:     return %components;
                   8503: }
                   8504: 
1.144     matthew  8505: ######################################################
                   8506: ######################################################
                   8507: 
1.56      matthew  8508: =pod
                   8509: 
1.648     raeburn  8510: =item * &upfile_select_html()
1.41      ng       8511: 
1.144     matthew  8512: Return HTML code to select a file from the users machine and specify 
                   8513: the file type.
1.41      ng       8514: 
                   8515: =cut
                   8516: 
1.144     matthew  8517: ######################################################
                   8518: ######################################################
1.31      albertel 8519: sub upfile_select_html {
1.144     matthew  8520:     my %Types = (
                   8521:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8522:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8523:                  space => &mt('Space separated'),
                   8524:                  tab   => &mt('Tabulator separated'),
                   8525: #                 xml   => &mt('HTML/XML'),
                   8526:                  );
                   8527:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8528:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8529:     foreach my $type (sort(keys(%Types))) {
                   8530:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8531:     }
                   8532:     $Str .= "</select>\n";
                   8533:     return $Str;
1.31      albertel 8534: }
                   8535: 
1.301     albertel 8536: sub get_samples {
                   8537:     my ($records,$toget) = @_;
                   8538:     my @samples=({});
                   8539:     my $got=0;
                   8540:     foreach my $rec (@$records) {
                   8541: 	my %temp = &record_sep($rec);
                   8542: 	if (! grep(/\S/, values(%temp))) { next; }
                   8543: 	if (%temp) {
                   8544: 	    $samples[$got]=\%temp;
                   8545: 	    $got++;
                   8546: 	    if ($got == $toget) { last; }
                   8547: 	}
                   8548:     }
                   8549:     return \@samples;
                   8550: }
                   8551: 
1.144     matthew  8552: ######################################################
                   8553: ######################################################
                   8554: 
1.56      matthew  8555: =pod
                   8556: 
1.648     raeburn  8557: =item * &csv_print_samples($r,$records)
1.41      ng       8558: 
                   8559: Prints a table of sample values from each column uploaded $r is an
                   8560: Apache Request ref, $records is an arrayref from
                   8561: &Apache::loncommon::upfile_record_sep
                   8562: 
                   8563: =cut
                   8564: 
1.144     matthew  8565: ######################################################
                   8566: ######################################################
1.31      albertel 8567: sub csv_print_samples {
                   8568:     my ($r,$records) = @_;
1.662     bisitz   8569:     my $samples = &get_samples($records,5);
1.301     albertel 8570: 
1.594     raeburn  8571:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8572:               &start_data_table_header_row());
1.356     albertel 8573:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
                   8574:         $r->print('<th>'.&mt('Column&nbsp;[_1]',($sample+1)).'</th>'); }
1.594     raeburn  8575:     $r->print(&end_data_table_header_row());
1.301     albertel 8576:     foreach my $hash (@$samples) {
1.594     raeburn  8577: 	$r->print(&start_data_table_row());
1.356     albertel 8578: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8579: 	    $r->print('<td>');
1.356     albertel 8580: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8581: 	    $r->print('</td>');
                   8582: 	}
1.594     raeburn  8583: 	$r->print(&end_data_table_row());
1.31      albertel 8584:     }
1.594     raeburn  8585:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8586: }
                   8587: 
1.144     matthew  8588: ######################################################
                   8589: ######################################################
                   8590: 
1.56      matthew  8591: =pod
                   8592: 
1.648     raeburn  8593: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8594: 
                   8595: Prints a table to create associations between values and table columns.
1.144     matthew  8596: 
1.41      ng       8597: $r is an Apache Request ref,
                   8598: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8599: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8600: 
                   8601: =cut
                   8602: 
1.144     matthew  8603: ######################################################
                   8604: ######################################################
1.31      albertel 8605: sub csv_print_select_table {
                   8606:     my ($r,$records,$d) = @_;
1.301     albertel 8607:     my $i=0;
                   8608:     my $samples = &get_samples($records,1);
1.144     matthew  8609:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8610: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8611:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8612:               '<th>'.&mt('Column').'</th>'.
                   8613:               &end_data_table_header_row()."\n");
1.356     albertel 8614:     foreach my $array_ref (@$d) {
                   8615: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8616: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8617: 
                   8618: 	$r->print('<td><select name=f'.$i.
1.32      matthew  8619: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8620: 	$r->print('<option value="none"></option>');
1.356     albertel 8621: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8622: 	    $r->print('<option value="'.$sample.'"'.
                   8623:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8624:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8625: 	}
1.594     raeburn  8626: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8627: 	$i++;
                   8628:     }
1.594     raeburn  8629:     $r->print(&end_data_table());
1.31      albertel 8630:     $i--;
                   8631:     return $i;
                   8632: }
1.56      matthew  8633: 
1.144     matthew  8634: ######################################################
                   8635: ######################################################
                   8636: 
1.56      matthew  8637: =pod
1.31      albertel 8638: 
1.648     raeburn  8639: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       8640: 
                   8641: Prints a table of sample values from the upload and can make associate samples to internal names.
                   8642: 
                   8643: $r is an Apache Request ref,
                   8644: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   8645: $d is an array of 2 element arrays (internal name, displayed name)
                   8646: 
                   8647: =cut
                   8648: 
1.144     matthew  8649: ######################################################
                   8650: ######################################################
1.31      albertel 8651: sub csv_samples_select_table {
                   8652:     my ($r,$records,$d) = @_;
                   8653:     my $i=0;
1.144     matthew  8654:     #
1.662     bisitz   8655:     my $max_samples = 5;
                   8656:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  8657:     $r->print(&start_data_table().
                   8658:               &start_data_table_header_row().'<th>'.
                   8659:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   8660:               &end_data_table_header_row());
1.301     albertel 8661: 
                   8662:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  8663: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  8664: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 8665: 	foreach my $option (@$d) {
                   8666: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  8667: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 8668:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  8669:                       $display.'</option>');
1.31      albertel 8670: 	}
                   8671: 	$r->print('</select></td><td>');
1.662     bisitz   8672: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 8673: 	    if (defined($samples->[$line]{$key})) { 
                   8674: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   8675: 	    }
                   8676: 	}
1.594     raeburn  8677: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 8678: 	$i++;
                   8679:     }
1.594     raeburn  8680:     $r->print(&end_data_table());
1.31      albertel 8681:     $i--;
                   8682:     return($i);
1.115     matthew  8683: }
                   8684: 
1.144     matthew  8685: ######################################################
                   8686: ######################################################
                   8687: 
1.115     matthew  8688: =pod
                   8689: 
1.648     raeburn  8690: =item * &clean_excel_name($name)
1.115     matthew  8691: 
                   8692: Returns a replacement for $name which does not contain any illegal characters.
                   8693: 
                   8694: =cut
                   8695: 
1.144     matthew  8696: ######################################################
                   8697: ######################################################
1.115     matthew  8698: sub clean_excel_name {
                   8699:     my ($name) = @_;
                   8700:     $name =~ s/[:\*\?\/\\]//g;
                   8701:     if (length($name) > 31) {
                   8702:         $name = substr($name,0,31);
                   8703:     }
                   8704:     return $name;
1.25      albertel 8705: }
1.84      albertel 8706: 
1.85      albertel 8707: =pod
                   8708: 
1.648     raeburn  8709: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 8710: 
                   8711: Returns either 1 or undef
                   8712: 
                   8713: 1 if the part is to be hidden, undef if it is to be shown
                   8714: 
                   8715: Arguments are:
                   8716: 
                   8717: $id the id of the part to be checked
                   8718: $symb, optional the symb of the resource to check
                   8719: $udom, optional the domain of the user to check for
                   8720: $uname, optional the username of the user to check for
                   8721: 
                   8722: =cut
1.84      albertel 8723: 
                   8724: sub check_if_partid_hidden {
                   8725:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 8726:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 8727: 					 $symb,$udom,$uname);
1.141     albertel 8728:     my $truth=1;
                   8729:     #if the string starts with !, then the list is the list to show not hide
                   8730:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 8731:     my @hiddenlist=split(/,/,$hiddenparts);
                   8732:     foreach my $checkid (@hiddenlist) {
1.141     albertel 8733: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 8734:     }
1.141     albertel 8735:     return !$truth;
1.84      albertel 8736: }
1.127     matthew  8737: 
1.138     matthew  8738: 
                   8739: ############################################################
                   8740: ############################################################
                   8741: 
                   8742: =pod
                   8743: 
1.157     matthew  8744: =back 
                   8745: 
1.138     matthew  8746: =head1 cgi-bin script and graphing routines
                   8747: 
1.157     matthew  8748: =over 4
                   8749: 
1.648     raeburn  8750: =item * &get_cgi_id()
1.138     matthew  8751: 
                   8752: Inputs: none
                   8753: 
                   8754: Returns an id which can be used to pass environment variables
                   8755: to various cgi-bin scripts.  These environment variables will
                   8756: be removed from the users environment after a given time by
                   8757: the routine &Apache::lonnet::transfer_profile_to_env.
                   8758: 
                   8759: =cut
                   8760: 
                   8761: ############################################################
                   8762: ############################################################
1.152     albertel 8763: my $uniq=0;
1.136     matthew  8764: sub get_cgi_id {
1.154     albertel 8765:     $uniq=($uniq+1)%100000;
1.280     albertel 8766:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  8767: }
                   8768: 
1.127     matthew  8769: ############################################################
                   8770: ############################################################
                   8771: 
                   8772: =pod
                   8773: 
1.648     raeburn  8774: =item * &DrawBarGraph()
1.127     matthew  8775: 
1.138     matthew  8776: Facilitates the plotting of data in a (stacked) bar graph.
                   8777: Puts plot definition data into the users environment in order for 
                   8778: graph.png to plot it.  Returns an <img> tag for the plot.
                   8779: The bars on the plot are labeled '1','2',...,'n'.
                   8780: 
                   8781: Inputs:
                   8782: 
                   8783: =over 4
                   8784: 
                   8785: =item $Title: string, the title of the plot
                   8786: 
                   8787: =item $xlabel: string, text describing the X-axis of the plot
                   8788: 
                   8789: =item $ylabel: string, text describing the Y-axis of the plot
                   8790: 
                   8791: =item $Max: scalar, the maximum Y value to use in the plot
                   8792: If $Max is < any data point, the graph will not be rendered.
                   8793: 
1.140     matthew  8794: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  8795: they are plotted.  If undefined, default values will be used.
                   8796: 
1.178     matthew  8797: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   8798: 
1.138     matthew  8799: =item @Values: An array of array references.  Each array reference holds data
                   8800: to be plotted in a stacked bar chart.
                   8801: 
1.239     matthew  8802: =item If the final element of @Values is a hash reference the key/value
                   8803: pairs will be added to the graph definition.
                   8804: 
1.138     matthew  8805: =back
                   8806: 
                   8807: Returns:
                   8808: 
                   8809: An <img> tag which references graph.png and the appropriate identifying
                   8810: information for the plot.
                   8811: 
1.127     matthew  8812: =cut
                   8813: 
                   8814: ############################################################
                   8815: ############################################################
1.134     matthew  8816: sub DrawBarGraph {
1.178     matthew  8817:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  8818:     #
                   8819:     if (! defined($colors)) {
                   8820:         $colors = ['#33ff00', 
                   8821:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   8822:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   8823:                   ]; 
                   8824:     }
1.228     matthew  8825:     my $extra_settings = {};
                   8826:     if (ref($Values[-1]) eq 'HASH') {
                   8827:         $extra_settings = pop(@Values);
                   8828:     }
1.127     matthew  8829:     #
1.136     matthew  8830:     my $identifier = &get_cgi_id();
                   8831:     my $id = 'cgi.'.$identifier;        
1.129     matthew  8832:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  8833:         return '';
                   8834:     }
1.225     matthew  8835:     #
                   8836:     my @Labels;
                   8837:     if (defined($labels)) {
                   8838:         @Labels = @$labels;
                   8839:     } else {
                   8840:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   8841:             push (@Labels,$i+1);
                   8842:         }
                   8843:     }
                   8844:     #
1.129     matthew  8845:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  8846:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  8847:     my %ValuesHash;
                   8848:     my $NumSets=1;
                   8849:     foreach my $array (@Values) {
                   8850:         next if (! ref($array));
1.136     matthew  8851:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  8852:             join(',',@$array);
1.129     matthew  8853:     }
1.127     matthew  8854:     #
1.136     matthew  8855:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  8856:     if ($NumBars < 3) {
                   8857:         $width = 120+$NumBars*32;
1.220     matthew  8858:         $xskip = 1;
1.225     matthew  8859:         $bar_width = 30;
                   8860:     } elsif ($NumBars < 5) {
                   8861:         $width = 120+$NumBars*20;
                   8862:         $xskip = 1;
                   8863:         $bar_width = 20;
1.220     matthew  8864:     } elsif ($NumBars < 10) {
1.136     matthew  8865:         $width = 120+$NumBars*15;
                   8866:         $xskip = 1;
                   8867:         $bar_width = 15;
                   8868:     } elsif ($NumBars <= 25) {
                   8869:         $width = 120+$NumBars*11;
                   8870:         $xskip = 5;
                   8871:         $bar_width = 8;
                   8872:     } elsif ($NumBars <= 50) {
                   8873:         $width = 120+$NumBars*8;
                   8874:         $xskip = 5;
                   8875:         $bar_width = 4;
                   8876:     } else {
                   8877:         $width = 120+$NumBars*8;
                   8878:         $xskip = 5;
                   8879:         $bar_width = 4;
                   8880:     }
                   8881:     #
1.137     matthew  8882:     $Max = 1 if ($Max < 1);
                   8883:     if ( int($Max) < $Max ) {
                   8884:         $Max++;
                   8885:         $Max = int($Max);
                   8886:     }
1.127     matthew  8887:     $Title  = '' if (! defined($Title));
                   8888:     $xlabel = '' if (! defined($xlabel));
                   8889:     $ylabel = '' if (! defined($ylabel));
1.369     www      8890:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   8891:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   8892:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  8893:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  8894:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   8895:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   8896:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   8897:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8898:     $ValuesHash{$id.'.height'}   = $height;
                   8899:     $ValuesHash{$id.'.width'}    = $width;
                   8900:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   8901:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   8902:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  8903:     #
1.228     matthew  8904:     # Deal with other parameters
                   8905:     while (my ($key,$value) = each(%$extra_settings)) {
                   8906:         $ValuesHash{$id.'.'.$key} = $value;
                   8907:     }
                   8908:     #
1.646     raeburn  8909:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  8910:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   8911: }
                   8912: 
                   8913: ############################################################
                   8914: ############################################################
                   8915: 
                   8916: =pod
                   8917: 
1.648     raeburn  8918: =item * &DrawXYGraph()
1.137     matthew  8919: 
1.138     matthew  8920: Facilitates the plotting of data in an XY graph.
                   8921: Puts plot definition data into the users environment in order for 
                   8922: graph.png to plot it.  Returns an <img> tag for the plot.
                   8923: 
                   8924: Inputs:
                   8925: 
                   8926: =over 4
                   8927: 
                   8928: =item $Title: string, the title of the plot
                   8929: 
                   8930: =item $xlabel: string, text describing the X-axis of the plot
                   8931: 
                   8932: =item $ylabel: string, text describing the Y-axis of the plot
                   8933: 
                   8934: =item $Max: scalar, the maximum Y value to use in the plot
                   8935: If $Max is < any data point, the graph will not be rendered.
                   8936: 
                   8937: =item $colors: Array ref containing the hex color codes for the data to be 
                   8938: plotted in.  If undefined, default values will be used.
                   8939: 
                   8940: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   8941: 
                   8942: =item $Ydata: Array ref containing Array refs.  
1.185     www      8943: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  8944: 
                   8945: =item %Values: hash indicating or overriding any default values which are 
                   8946: passed to graph.png.  
                   8947: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   8948: 
                   8949: =back
                   8950: 
                   8951: Returns:
                   8952: 
                   8953: An <img> tag which references graph.png and the appropriate identifying
                   8954: information for the plot.
                   8955: 
1.137     matthew  8956: =cut
                   8957: 
                   8958: ############################################################
                   8959: ############################################################
                   8960: sub DrawXYGraph {
                   8961:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   8962:     #
                   8963:     # Create the identifier for the graph
                   8964:     my $identifier = &get_cgi_id();
                   8965:     my $id = 'cgi.'.$identifier;
                   8966:     #
                   8967:     $Title  = '' if (! defined($Title));
                   8968:     $xlabel = '' if (! defined($xlabel));
                   8969:     $ylabel = '' if (! defined($ylabel));
                   8970:     my %ValuesHash = 
                   8971:         (
1.369     www      8972:          $id.'.title'  => &escape($Title),
                   8973:          $id.'.xlabel' => &escape($xlabel),
                   8974:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  8975:          $id.'.y_max_value'=> $Max,
                   8976:          $id.'.labels'     => join(',',@$Xlabels),
                   8977:          $id.'.PlotType'   => 'XY',
                   8978:          );
                   8979:     #
                   8980:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   8981:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8982:     }
                   8983:     #
                   8984:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   8985:         return '';
                   8986:     }
                   8987:     my $NumSets=1;
1.138     matthew  8988:     foreach my $array (@{$Ydata}){
1.137     matthew  8989:         next if (! ref($array));
                   8990:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   8991:     }
1.138     matthew  8992:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  8993:     #
                   8994:     # Deal with other parameters
                   8995:     while (my ($key,$value) = each(%Values)) {
                   8996:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  8997:     }
                   8998:     #
1.646     raeburn  8999:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  9000:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9001: }
                   9002: 
                   9003: ############################################################
                   9004: ############################################################
                   9005: 
                   9006: =pod
                   9007: 
1.648     raeburn  9008: =item * &DrawXYYGraph()
1.138     matthew  9009: 
                   9010: Facilitates the plotting of data in an XY graph with two Y axes.
                   9011: Puts plot definition data into the users environment in order for 
                   9012: graph.png to plot it.  Returns an <img> tag for the plot.
                   9013: 
                   9014: Inputs:
                   9015: 
                   9016: =over 4
                   9017: 
                   9018: =item $Title: string, the title of the plot
                   9019: 
                   9020: =item $xlabel: string, text describing the X-axis of the plot
                   9021: 
                   9022: =item $ylabel: string, text describing the Y-axis of the plot
                   9023: 
                   9024: =item $colors: Array ref containing the hex color codes for the data to be 
                   9025: plotted in.  If undefined, default values will be used.
                   9026: 
                   9027: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9028: 
                   9029: =item $Ydata1: The first data set
                   9030: 
                   9031: =item $Min1: The minimum value of the left Y-axis
                   9032: 
                   9033: =item $Max1: The maximum value of the left Y-axis
                   9034: 
                   9035: =item $Ydata2: The second data set
                   9036: 
                   9037: =item $Min2: The minimum value of the right Y-axis
                   9038: 
                   9039: =item $Max2: The maximum value of the left Y-axis
                   9040: 
                   9041: =item %Values: hash indicating or overriding any default values which are 
                   9042: passed to graph.png.  
                   9043: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9044: 
                   9045: =back
                   9046: 
                   9047: Returns:
                   9048: 
                   9049: An <img> tag which references graph.png and the appropriate identifying
                   9050: information for the plot.
1.136     matthew  9051: 
                   9052: =cut
                   9053: 
                   9054: ############################################################
                   9055: ############################################################
1.137     matthew  9056: sub DrawXYYGraph {
                   9057:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9058:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9059:     #
                   9060:     # Create the identifier for the graph
                   9061:     my $identifier = &get_cgi_id();
                   9062:     my $id = 'cgi.'.$identifier;
                   9063:     #
                   9064:     $Title  = '' if (! defined($Title));
                   9065:     $xlabel = '' if (! defined($xlabel));
                   9066:     $ylabel = '' if (! defined($ylabel));
                   9067:     my %ValuesHash = 
                   9068:         (
1.369     www      9069:          $id.'.title'  => &escape($Title),
                   9070:          $id.'.xlabel' => &escape($xlabel),
                   9071:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9072:          $id.'.labels' => join(',',@$Xlabels),
                   9073:          $id.'.PlotType' => 'XY',
                   9074:          $id.'.NumSets' => 2,
1.137     matthew  9075:          $id.'.two_axes' => 1,
                   9076:          $id.'.y1_max_value' => $Max1,
                   9077:          $id.'.y1_min_value' => $Min1,
                   9078:          $id.'.y2_max_value' => $Max2,
                   9079:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9080:          );
                   9081:     #
1.137     matthew  9082:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9083:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9084:     }
                   9085:     #
                   9086:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9087:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9088:         return '';
                   9089:     }
                   9090:     my $NumSets=1;
1.137     matthew  9091:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9092:         next if (! ref($array));
                   9093:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9094:     }
                   9095:     #
                   9096:     # Deal with other parameters
                   9097:     while (my ($key,$value) = each(%Values)) {
                   9098:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9099:     }
                   9100:     #
1.646     raeburn  9101:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9102:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9103: }
                   9104: 
                   9105: ############################################################
                   9106: ############################################################
                   9107: 
                   9108: =pod
                   9109: 
1.157     matthew  9110: =back 
                   9111: 
1.139     matthew  9112: =head1 Statistics helper routines?  
                   9113: 
                   9114: Bad place for them but what the hell.
                   9115: 
1.157     matthew  9116: =over 4
                   9117: 
1.648     raeburn  9118: =item * &chartlink()
1.139     matthew  9119: 
                   9120: Returns a link to the chart for a specific student.  
                   9121: 
                   9122: Inputs:
                   9123: 
                   9124: =over 4
                   9125: 
                   9126: =item $linktext: The text of the link
                   9127: 
                   9128: =item $sname: The students username
                   9129: 
                   9130: =item $sdomain: The students domain
                   9131: 
                   9132: =back
                   9133: 
1.157     matthew  9134: =back
                   9135: 
1.139     matthew  9136: =cut
                   9137: 
                   9138: ############################################################
                   9139: ############################################################
                   9140: sub chartlink {
                   9141:     my ($linktext, $sname, $sdomain) = @_;
                   9142:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9143:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9144:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9145:        '">'.$linktext.'</a>';
1.153     matthew  9146: }
                   9147: 
                   9148: #######################################################
                   9149: #######################################################
                   9150: 
                   9151: =pod
                   9152: 
                   9153: =head1 Course Environment Routines
1.157     matthew  9154: 
                   9155: =over 4
1.153     matthew  9156: 
1.648     raeburn  9157: =item * &restore_course_settings()
1.153     matthew  9158: 
1.648     raeburn  9159: =item * &store_course_settings()
1.153     matthew  9160: 
                   9161: Restores/Store indicated form parameters from the course environment.
                   9162: Will not overwrite existing values of the form parameters.
                   9163: 
                   9164: Inputs: 
                   9165: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9166: 
                   9167: a hash ref describing the data to be stored.  For example:
                   9168:    
                   9169: %Save_Parameters = ('Status' => 'scalar',
                   9170:     'chartoutputmode' => 'scalar',
                   9171:     'chartoutputdata' => 'scalar',
                   9172:     'Section' => 'array',
1.373     raeburn  9173:     'Group' => 'array',
1.153     matthew  9174:     'StudentData' => 'array',
                   9175:     'Maps' => 'array');
                   9176: 
                   9177: Returns: both routines return nothing
                   9178: 
1.631     raeburn  9179: =back
                   9180: 
1.153     matthew  9181: =cut
                   9182: 
                   9183: #######################################################
                   9184: #######################################################
                   9185: sub store_course_settings {
1.496     albertel 9186:     return &store_settings($env{'request.course.id'},@_);
                   9187: }
                   9188: 
                   9189: sub store_settings {
1.153     matthew  9190:     # save to the environment
                   9191:     # appenv the same items, just to be safe
1.300     albertel 9192:     my $udom  = $env{'user.domain'};
                   9193:     my $uname = $env{'user.name'};
1.496     albertel 9194:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9195:     my %SaveHash;
                   9196:     my %AppHash;
                   9197:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9198:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9199:         my $envname = 'environment.'.$basename;
1.258     albertel 9200:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9201:             # Save this value away
                   9202:             if ($type eq 'scalar' &&
1.258     albertel 9203:                 (! exists($env{$envname}) || 
                   9204:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9205:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9206:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9207:             } elsif ($type eq 'array') {
                   9208:                 my $stored_form;
1.258     albertel 9209:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9210:                     $stored_form = join(',',
                   9211:                                         map {
1.369     www      9212:                                             &escape($_);
1.258     albertel 9213:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9214:                 } else {
                   9215:                     $stored_form = 
1.369     www      9216:                         &escape($env{'form.'.$setting});
1.153     matthew  9217:                 }
                   9218:                 # Determine if the array contents are the same.
1.258     albertel 9219:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9220:                     $SaveHash{$basename} = $stored_form;
                   9221:                     $AppHash{$envname}   = $stored_form;
                   9222:                 }
                   9223:             }
                   9224:         }
                   9225:     }
                   9226:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9227:                                           $udom,$uname);
1.153     matthew  9228:     if ($put_result !~ /^(ok|delayed)/) {
                   9229:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9230:                                  'got error:'.$put_result);
                   9231:     }
                   9232:     # Make sure these settings stick around in this session, too
1.646     raeburn  9233:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9234:     return;
                   9235: }
                   9236: 
                   9237: sub restore_course_settings {
1.499     albertel 9238:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9239: }
                   9240: 
                   9241: sub restore_settings {
                   9242:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9243:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9244:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9245:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9246:             '.'.$setting;
1.258     albertel 9247:         if (exists($env{$envname})) {
1.153     matthew  9248:             if ($type eq 'scalar') {
1.258     albertel 9249:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9250:             } elsif ($type eq 'array') {
1.258     albertel 9251:                 $env{'form.'.$setting} = [ 
1.153     matthew  9252:                                            map { 
1.369     www      9253:                                                &unescape($_); 
1.258     albertel 9254:                                            } split(',',$env{$envname})
1.153     matthew  9255:                                            ];
                   9256:             }
                   9257:         }
                   9258:     }
1.127     matthew  9259: }
                   9260: 
1.618     raeburn  9261: #######################################################
                   9262: #######################################################
                   9263: 
                   9264: =pod
                   9265: 
                   9266: =head1 Domain E-mail Routines  
                   9267: 
                   9268: =over 4
                   9269: 
1.648     raeburn  9270: =item * &build_recipient_list()
1.618     raeburn  9271: 
1.766     raeburn  9272: Build recipient lists for four types of e-mail:
                   9273: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
                   9274: (d) Help requests, generated by
                   9275: lonerrorhandler.pm, CHECKRPMS, loncron, and lonsupportreq.pm respectively.
1.618     raeburn  9276: 
                   9277: Inputs:
1.619     raeburn  9278: defmail (scalar - email address of default recipient), 
1.618     raeburn  9279: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9280: defdom (domain for which to retrieve configuration settings),
                   9281: origmail (scalar - email address of recipient from loncapa.conf, 
                   9282: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9283: 
1.655     raeburn  9284: Returns: comma separated list of addresses to which to send e-mail.
                   9285: 
                   9286: =back
1.618     raeburn  9287: 
                   9288: =cut
                   9289: 
                   9290: ############################################################
                   9291: ############################################################
                   9292: sub build_recipient_list {
1.619     raeburn  9293:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9294:     my @recipients;
                   9295:     my $otheremails;
                   9296:     my %domconfig =
                   9297:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9298:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9299:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9300:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9301:                 my @contacts = ('adminemail','supportemail');
                   9302:                 foreach my $item (@contacts) {
                   9303:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9304:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9305:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9306:                             push(@recipients,$addr);
                   9307:                         }
1.619     raeburn  9308:                     }
1.766     raeburn  9309:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9310:                 }
                   9311:             }
1.766     raeburn  9312:         } elsif ($origmail ne '') {
                   9313:             push(@recipients,$origmail);
1.618     raeburn  9314:         }
1.619     raeburn  9315:     } elsif ($origmail ne '') {
                   9316:         push(@recipients,$origmail);
1.618     raeburn  9317:     }
1.688     raeburn  9318:     if (defined($defmail)) {
                   9319:         if ($defmail ne '') {
                   9320:             push(@recipients,$defmail);
                   9321:         }
1.618     raeburn  9322:     }
                   9323:     if ($otheremails) {
1.619     raeburn  9324:         my @others;
                   9325:         if ($otheremails =~ /,/) {
                   9326:             @others = split(/,/,$otheremails);
1.618     raeburn  9327:         } else {
1.619     raeburn  9328:             push(@others,$otheremails);
                   9329:         }
                   9330:         foreach my $addr (@others) {
                   9331:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9332:                 push(@recipients,$addr);
                   9333:             }
1.618     raeburn  9334:         }
                   9335:     }
1.619     raeburn  9336:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9337:     return $recipientlist;
                   9338: }
                   9339: 
1.127     matthew  9340: ############################################################
                   9341: ############################################################
1.154     albertel 9342: 
1.655     raeburn  9343: =pod
                   9344: 
                   9345: =head1 Course Catalog Routines
                   9346: 
                   9347: =over 4
                   9348: 
                   9349: =item * &gather_categories()
                   9350: 
                   9351: Converts category definitions - keys of categories hash stored in  
                   9352: coursecategories in configuration.db on the primary library server in a 
                   9353: domain - to an array.  Also generates javascript and idx hash used to 
                   9354: generate Domain Coordinator interface for editing Course Categories.
                   9355: 
                   9356: Inputs:
1.663     raeburn  9357: 
1.655     raeburn  9358: categories (reference to hash of category definitions).
1.663     raeburn  9359: 
1.655     raeburn  9360: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9361:       categories and subcategories).
1.663     raeburn  9362: 
1.655     raeburn  9363: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9364:       editing Course Categories).
1.663     raeburn  9365: 
1.655     raeburn  9366: jsarray (reference to array of categories used to create Javascript arrays for
                   9367:          Domain Coordinator interface for editing Course Categories).
                   9368: 
                   9369: Returns: nothing
                   9370: 
                   9371: Side effects: populates cats, idx and jsarray. 
                   9372: 
                   9373: =cut
                   9374: 
                   9375: sub gather_categories {
                   9376:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9377:     my %counters;
                   9378:     my $num = 0;
                   9379:     foreach my $item (keys(%{$categories})) {
                   9380:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9381:         if ($container eq '' && $depth == 0) {
                   9382:             $cats->[$depth][$categories->{$item}] = $cat;
                   9383:         } else {
                   9384:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9385:         }
                   9386:         my ($escitem,$tail) = split(/:/,$item,2);
                   9387:         if ($counters{$tail} eq '') {
                   9388:             $counters{$tail} = $num;
                   9389:             $num ++;
                   9390:         }
                   9391:         if (ref($idx) eq 'HASH') {
                   9392:             $idx->{$item} = $counters{$tail};
                   9393:         }
                   9394:         if (ref($jsarray) eq 'ARRAY') {
                   9395:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9396:         }
                   9397:     }
                   9398:     return;
                   9399: }
                   9400: 
                   9401: =pod
                   9402: 
                   9403: =item * &extract_categories()
                   9404: 
                   9405: Used to generate breadcrumb trails for course categories.
                   9406: 
                   9407: Inputs:
1.663     raeburn  9408: 
1.655     raeburn  9409: categories (reference to hash of category definitions).
1.663     raeburn  9410: 
1.655     raeburn  9411: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9412:       categories and subcategories).
1.663     raeburn  9413: 
1.655     raeburn  9414: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9415: 
1.655     raeburn  9416: allitems (reference to hash - key is category key 
                   9417:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9418: 
1.655     raeburn  9419: idx (reference to hash of counters used in Domain Coordinator interface for
                   9420:       editing Course Categories).
1.663     raeburn  9421: 
1.655     raeburn  9422: jsarray (reference to array of categories used to create Javascript arrays for
                   9423:          Domain Coordinator interface for editing Course Categories).
                   9424: 
1.665     raeburn  9425: subcats (reference to hash of arrays containing all subcategories within each 
                   9426:          category, -recursive)
                   9427: 
1.655     raeburn  9428: Returns: nothing
                   9429: 
                   9430: Side effects: populates trails and allitems hash references.
                   9431: 
                   9432: =cut
                   9433: 
                   9434: sub extract_categories {
1.665     raeburn  9435:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9436:     if (ref($categories) eq 'HASH') {
                   9437:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9438:         if (ref($cats->[0]) eq 'ARRAY') {
                   9439:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9440:                 my $name = $cats->[0][$i];
                   9441:                 my $item = &escape($name).'::0';
                   9442:                 my $trailstr;
                   9443:                 if ($name eq 'instcode') {
                   9444:                     $trailstr = &mt('Official courses (with institutional codes)');
                   9445:                 } else {
                   9446:                     $trailstr = $name;
                   9447:                 }
                   9448:                 if ($allitems->{$item} eq '') {
                   9449:                     push(@{$trails},$trailstr);
                   9450:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9451:                 }
                   9452:                 my @parents = ($name);
                   9453:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9454:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9455:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9456:                         if (ref($subcats) eq 'HASH') {
                   9457:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9458:                         }
                   9459:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9460:                     }
                   9461:                 } else {
                   9462:                     if (ref($subcats) eq 'HASH') {
                   9463:                         $subcats->{$item} = [];
1.655     raeburn  9464:                     }
                   9465:                 }
                   9466:             }
                   9467:         }
                   9468:     }
                   9469:     return;
                   9470: }
                   9471: 
                   9472: =pod
                   9473: 
                   9474: =item *&recurse_categories()
                   9475: 
                   9476: Recursively used to generate breadcrumb trails for course categories.
                   9477: 
                   9478: Inputs:
1.663     raeburn  9479: 
1.655     raeburn  9480: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9481:       categories and subcategories).
1.663     raeburn  9482: 
1.655     raeburn  9483: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9484: 
                   9485: category (current course category, for which breadcrumb trail is being generated).
                   9486: 
                   9487: trails (reference to array of breadcrumb trails for each category).
                   9488: 
1.655     raeburn  9489: allitems (reference to hash - key is category key
                   9490:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9491: 
1.655     raeburn  9492: parents (array containing containers directories for current category, 
                   9493:          back to top level). 
                   9494: 
                   9495: Returns: nothing
                   9496: 
                   9497: Side effects: populates trails and allitems hash references
                   9498: 
                   9499: =cut
                   9500: 
                   9501: sub recurse_categories {
1.665     raeburn  9502:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9503:     my $shallower = $depth - 1;
                   9504:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9505:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9506:             my $name = $cats->[$depth]{$category}[$k];
                   9507:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9508:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9509:             if ($allitems->{$item} eq '') {
                   9510:                 push(@{$trails},$trailstr);
                   9511:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9512:             }
                   9513:             my $deeper = $depth+1;
                   9514:             push(@{$parents},$category);
1.665     raeburn  9515:             if (ref($subcats) eq 'HASH') {
                   9516:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9517:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9518:                     my $higher;
                   9519:                     if ($j > 0) {
                   9520:                         $higher = &escape($parents->[$j]).':'.
                   9521:                                   &escape($parents->[$j-1]).':'.$j;
                   9522:                     } else {
                   9523:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9524:                     }
                   9525:                     push(@{$subcats->{$higher}},$subcat);
                   9526:                 }
                   9527:             }
                   9528:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9529:                                 $subcats);
1.655     raeburn  9530:             pop(@{$parents});
                   9531:         }
                   9532:     } else {
                   9533:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9534:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9535:         if ($allitems->{$item} eq '') {
                   9536:             push(@{$trails},$trailstr);
                   9537:             $allitems->{$item} = scalar(@{$trails})-1;
                   9538:         }
                   9539:     }
                   9540:     return;
                   9541: }
                   9542: 
1.663     raeburn  9543: =pod
                   9544: 
                   9545: =item *&assign_categories_table()
                   9546: 
                   9547: Create a datatable for display of hierarchical categories in a domain,
                   9548: with checkboxes to allow a course to be categorized. 
                   9549: 
                   9550: Inputs:
                   9551: 
                   9552: cathash - reference to hash of categories defined for the domain (from
                   9553:           configuration.db)
                   9554: 
                   9555: currcat - scalar with an & separated list of categories assigned to a course. 
                   9556: 
                   9557: Returns: $output (markup to be displayed) 
                   9558: 
                   9559: =cut
                   9560: 
                   9561: sub assign_categories_table {
                   9562:     my ($cathash,$currcat) = @_;
                   9563:     my $output;
                   9564:     if (ref($cathash) eq 'HASH') {
                   9565:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9566:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9567:         $maxdepth = scalar(@cats);
                   9568:         if (@cats > 0) {
                   9569:             my $itemcount = 0;
                   9570:             if (ref($cats[0]) eq 'ARRAY') {
                   9571:                 $output = &Apache::loncommon::start_data_table();
                   9572:                 my @currcategories;
                   9573:                 if ($currcat ne '') {
                   9574:                     @currcategories = split('&',$currcat);
                   9575:                 }
                   9576:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9577:                     my $parent = $cats[0][$i];
                   9578:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9579:                     next if ($parent eq 'instcode');
                   9580:                     my $item = &escape($parent).'::0';
                   9581:                     my $checked = '';
                   9582:                     if (@currcategories > 0) {
                   9583:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9584:                             $checked = ' checked="checked"';
1.663     raeburn  9585:                         }
                   9586:                     }
1.675     raeburn  9587:                     $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9588:                                '<input type="checkbox" name="usecategory" value="'.
                   9589:                                $item.'"'.$checked.' />'.$parent.'</span>'.
                   9590:                                '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9591:                     my $depth = 1;
                   9592:                     push(@path,$parent);
                   9593:                     $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                   9594:                     pop(@path);
                   9595:                     $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                   9596:                     $itemcount ++;
                   9597:                 }
                   9598:                 $output .= &Apache::loncommon::end_data_table();
                   9599:             }
                   9600:         }
                   9601:     }
                   9602:     return $output;
                   9603: }
                   9604: 
                   9605: =pod
                   9606: 
                   9607: =item *&assign_category_rows()
                   9608: 
                   9609: Create a datatable row for display of nested categories in a domain,
                   9610: with checkboxes to allow a course to be categorized,called recursively.
                   9611: 
                   9612: Inputs:
                   9613: 
                   9614: itemcount - track row number for alternating colors
                   9615: 
                   9616: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   9617:       categories and subcategories.
                   9618: 
                   9619: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   9620: 
                   9621: parent - parent of current category item
                   9622: 
                   9623: path - Array containing all categories back up through the hierarchy from the
                   9624:        current category to the top level.
                   9625: 
                   9626: currcategories - reference to array of current categories assigned to the course
                   9627: 
                   9628: Returns: $output (markup to be displayed).
                   9629: 
                   9630: =cut
                   9631: 
                   9632: sub assign_category_rows {
                   9633:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   9634:     my ($text,$name,$item,$chgstr);
                   9635:     if (ref($cats) eq 'ARRAY') {
                   9636:         my $maxdepth = scalar(@{$cats});
                   9637:         if (ref($cats->[$depth]) eq 'HASH') {
                   9638:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   9639:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   9640:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9641:                 $text .= '<td><table class="LC_datatable">';
                   9642:                 for (my $j=0; $j<$numchildren; $j++) {
                   9643:                     $name = $cats->[$depth]{$parent}[$j];
                   9644:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   9645:                     my $deeper = $depth+1;
                   9646:                     my $checked = '';
                   9647:                     if (ref($currcategories) eq 'ARRAY') {
                   9648:                         if (@{$currcategories} > 0) {
                   9649:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   9650:                                 $checked = ' checked="checked"';
1.663     raeburn  9651:                             }
                   9652:                         }
                   9653:                     }
1.664     raeburn  9654:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   9655:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  9656:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   9657:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   9658:                              '</td><td>';
1.663     raeburn  9659:                     if (ref($path) eq 'ARRAY') {
                   9660:                         push(@{$path},$name);
                   9661:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   9662:                         pop(@{$path});
                   9663:                     }
                   9664:                     $text .= '</td></tr>';
                   9665:                 }
                   9666:                 $text .= '</table></td>';
                   9667:             }
                   9668:         }
                   9669:     }
                   9670:     return $text;
                   9671: }
                   9672: 
1.655     raeburn  9673: ############################################################
                   9674: ############################################################
                   9675: 
                   9676: 
1.443     albertel 9677: sub commit_customrole {
1.664     raeburn  9678:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  9679:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 9680:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   9681:                          ($end?', ending '.localtime($end):'').': <b>'.
                   9682:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  9683:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 9684:                  '</b><br />';
                   9685:     return $output;
                   9686: }
                   9687: 
                   9688: sub commit_standardrole {
1.541     raeburn  9689:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   9690:     my ($output,$logmsg,$linefeed);
                   9691:     if ($context eq 'auto') {
                   9692:         $linefeed = "\n";
                   9693:     } else {
                   9694:         $linefeed = "<br />\n";
                   9695:     }  
1.443     albertel 9696:     if ($three eq 'st') {
1.541     raeburn  9697:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   9698:                                          $one,$two,$sec,$context);
                   9699:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  9700:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   9701:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 9702:         } else {
1.541     raeburn  9703:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 9704:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9705:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   9706:             if ($context eq 'auto') {
                   9707:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   9708:             } else {
                   9709:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   9710:                &mt('Add to classlist').': <b>ok</b>';
                   9711:             }
                   9712:             $output .= $linefeed;
1.443     albertel 9713:         }
                   9714:     } else {
                   9715:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   9716:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9717:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  9718:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  9719:         if ($context eq 'auto') {
                   9720:             $output .= $result.$linefeed;
                   9721:         } else {
                   9722:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   9723:         }
1.443     albertel 9724:     }
                   9725:     return $output;
                   9726: }
                   9727: 
                   9728: sub commit_studentrole {
1.541     raeburn  9729:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  9730:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  9731:     if ($context eq 'auto') {
                   9732:         $linefeed = "\n";
                   9733:     } else {
                   9734:         $linefeed = '<br />'."\n";
                   9735:     }
1.443     albertel 9736:     if (defined($one) && defined($two)) {
                   9737:         my $cid=$one.'_'.$two;
                   9738:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   9739:         my $secchange = 0;
                   9740:         my $expire_role_result;
                   9741:         my $modify_section_result;
1.628     raeburn  9742:         if ($oldsec ne '-1') { 
                   9743:             if ($oldsec ne $sec) {
1.443     albertel 9744:                 $secchange = 1;
1.628     raeburn  9745:                 my $now = time;
1.443     albertel 9746:                 my $uurl='/'.$cid;
                   9747:                 $uurl=~s/\_/\//g;
                   9748:                 if ($oldsec) {
                   9749:                     $uurl.='/'.$oldsec;
                   9750:                 }
1.626     raeburn  9751:                 $oldsecurl = $uurl;
1.628     raeburn  9752:                 $expire_role_result = 
1.652     raeburn  9753:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  9754:                 if ($env{'request.course.sec'} ne '') { 
                   9755:                     if ($expire_role_result eq 'refused') {
                   9756:                         my @roles = ('st');
                   9757:                         my @statuses = ('previous');
                   9758:                         my @roledoms = ($one);
                   9759:                         my $withsec = 1;
                   9760:                         my %roleshash = 
                   9761:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   9762:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   9763:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   9764:                             my ($oldstart,$oldend) = 
                   9765:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   9766:                             if ($oldend > 0 && $oldend <= $now) {
                   9767:                                 $expire_role_result = 'ok';
                   9768:                             }
                   9769:                         }
                   9770:                     }
                   9771:                 }
1.443     albertel 9772:                 $result = $expire_role_result;
                   9773:             }
                   9774:         }
                   9775:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  9776:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 9777:             if ($modify_section_result =~ /^ok/) {
                   9778:                 if ($secchange == 1) {
1.628     raeburn  9779:                     if ($sec eq '') {
                   9780:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   9781:                     } else {
                   9782:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   9783:                     }
1.443     albertel 9784:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  9785:                     if ($sec eq '') {
                   9786:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   9787:                     } else {
                   9788:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9789:                     }
1.443     albertel 9790:                 } else {
1.628     raeburn  9791:                     if ($sec eq '') {
                   9792:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   9793:                     } else {
                   9794:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9795:                     }
1.443     albertel 9796:                 }
                   9797:             } else {
1.628     raeburn  9798:                 if ($secchange) {       
                   9799:                     $$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;
                   9800:                 } else {
                   9801:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   9802:                 }
1.443     albertel 9803:             }
                   9804:             $result = $modify_section_result;
                   9805:         } elsif ($secchange == 1) {
1.628     raeburn  9806:             if ($oldsec eq '') {
                   9807:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   9808:             } else {
                   9809:                 $$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;
                   9810:             }
1.626     raeburn  9811:             if ($expire_role_result eq 'refused') {
                   9812:                 my $newsecurl = '/'.$cid;
                   9813:                 $newsecurl =~ s/\_/\//g;
                   9814:                 if ($sec ne '') {
                   9815:                     $newsecurl.='/'.$sec;
                   9816:                 }
                   9817:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   9818:                     if ($sec eq '') {
                   9819:                         $$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;
                   9820:                     } else {
                   9821:                         $$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;
                   9822:                     }
                   9823:                 }
                   9824:             }
1.443     albertel 9825:         }
                   9826:     } else {
1.626     raeburn  9827:         $$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 9828:         $result = "error: incomplete course id\n";
                   9829:     }
                   9830:     return $result;
                   9831: }
                   9832: 
                   9833: ############################################################
                   9834: ############################################################
                   9835: 
1.566     albertel 9836: sub check_clone {
1.578     raeburn  9837:     my ($args,$linefeed) = @_;
1.566     albertel 9838:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   9839:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   9840:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   9841:     my $clonemsg;
                   9842:     my $can_clone = 0;
                   9843: 
                   9844:     if ($clonehome eq 'no_host') {
1.578     raeburn  9845:         $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 9846:     } else {
                   9847: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568     albertel 9848: 	if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566     albertel 9849: 	    $can_clone = 1;
                   9850: 	} else {
                   9851: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   9852: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   9853: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  9854:             if (grep(/^\*$/,@cloners)) {
                   9855:                 $can_clone = 1;
                   9856:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   9857:                 $can_clone = 1;
                   9858:             } else {
                   9859: 	        my %roleshash =
                   9860: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   9861: 					 $args->{'ccdomain'},
                   9862:                                          'userroles',['active'],['cc'],
                   9863: 					 [$args->{'clonedomain'}]);
                   9864: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
                   9865: 		    $can_clone = 1;
                   9866: 	        } else {
                   9867:                     $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'});
                   9868: 	        }
1.566     albertel 9869: 	    }
1.578     raeburn  9870:         }
1.566     albertel 9871:     }
                   9872:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9873: }
                   9874: 
1.444     albertel 9875: sub construct_course {
1.541     raeburn  9876:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444     albertel 9877:     my $outcome;
1.541     raeburn  9878:     my $linefeed =  '<br />'."\n";
                   9879:     if ($context eq 'auto') {
                   9880:         $linefeed = "\n";
                   9881:     }
1.566     albertel 9882: 
                   9883: #
                   9884: # Are we cloning?
                   9885: #
                   9886:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9887:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  9888: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 9889: 	if ($context ne 'auto') {
1.578     raeburn  9890:             if ($clonemsg ne '') {
                   9891: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   9892:             }
1.566     albertel 9893: 	}
                   9894: 	$outcome .= $clonemsg.$linefeed;
                   9895: 
                   9896:         if (!$can_clone) {
                   9897: 	    return (0,$outcome);
                   9898: 	}
                   9899:     }
                   9900: 
1.444     albertel 9901: #
                   9902: # Open course
                   9903: #
                   9904:     my $crstype = lc($args->{'crstype'});
                   9905:     my %cenv=();
                   9906:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   9907:                                              $args->{'cdescr'},
                   9908:                                              $args->{'curl'},
                   9909:                                              $args->{'course_home'},
                   9910:                                              $args->{'nonstandard'},
                   9911:                                              $args->{'crscode'},
                   9912:                                              $args->{'ccuname'}.':'.
                   9913:                                              $args->{'ccdomain'},
                   9914:                                              $args->{'crstype'});
                   9915: 
                   9916:     # Note: The testing routines depend on this being output; see 
                   9917:     # Utils::Course. This needs to at least be output as a comment
                   9918:     # if anyone ever decides to not show this, and Utils::Course::new
                   9919:     # will need to be suitably modified.
1.541     raeburn  9920:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 9921: #
                   9922: # Check if created correctly
                   9923: #
1.479     albertel 9924:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 9925:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  9926:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 9927: 
1.444     albertel 9928: #
1.566     albertel 9929: # Do the cloning
                   9930: #   
                   9931:     if ($can_clone && $cloneid) {
                   9932: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   9933: 	if ($context ne 'auto') {
                   9934: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   9935: 	}
                   9936: 	$outcome .= $clonemsg.$linefeed;
                   9937: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 9938: # Copy all files
1.637     www      9939: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 9940: # Restore URL
1.566     albertel 9941: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 9942: # Restore title
1.566     albertel 9943: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 9944: # Mark as cloned
1.566     albertel 9945: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      9946: # Need to clone grading mode
                   9947:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   9948:         $cenv{'grading'}=$newenv{'grading'};
                   9949: # Do not clone these environment entries
                   9950:         &Apache::lonnet::del('environment',
                   9951:                   ['default_enrollment_start_date',
                   9952:                    'default_enrollment_end_date',
                   9953:                    'question.email',
                   9954:                    'policy.email',
                   9955:                    'comment.email',
                   9956:                    'pch.users.denied',
1.725     raeburn  9957:                    'plc.users.denied',
                   9958:                    'hidefromcat',
                   9959:                    'categories'],
1.638     www      9960:                    $$crsudom,$$crsunum);
1.444     albertel 9961:     }
1.566     albertel 9962: 
1.444     albertel 9963: #
                   9964: # Set environment (will override cloned, if existing)
                   9965: #
                   9966:     my @sections = ();
                   9967:     my @xlists = ();
                   9968:     if ($args->{'crstype'}) {
                   9969:         $cenv{'type'}=$args->{'crstype'};
                   9970:     }
                   9971:     if ($args->{'crsid'}) {
                   9972:         $cenv{'courseid'}=$args->{'crsid'};
                   9973:     }
                   9974:     if ($args->{'crscode'}) {
                   9975:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   9976:     }
                   9977:     if ($args->{'crsquota'} ne '') {
                   9978:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   9979:     } else {
                   9980:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   9981:     }
                   9982:     if ($args->{'ccuname'}) {
                   9983:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   9984:                                         ':'.$args->{'ccdomain'};
                   9985:     } else {
                   9986:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   9987:     }
                   9988:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   9989:     if ($args->{'crssections'}) {
                   9990:         $cenv{'internal.sectionnums'} = '';
                   9991:         if ($args->{'crssections'} =~ m/,/) {
                   9992:             @sections = split/,/,$args->{'crssections'};
                   9993:         } else {
                   9994:             $sections[0] = $args->{'crssections'};
                   9995:         }
                   9996:         if (@sections > 0) {
                   9997:             foreach my $item (@sections) {
                   9998:                 my ($sec,$gp) = split/:/,$item;
                   9999:                 my $class = $args->{'crscode'}.$sec;
                   10000:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   10001:                 $cenv{'internal.sectionnums'} .= $item.',';
                   10002:                 unless ($addcheck eq 'ok') {
                   10003:                     push @badclasses, $class;
                   10004:                 }
                   10005:             }
                   10006:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   10007:         }
                   10008:     }
                   10009: # do not hide course coordinator from staff listing, 
                   10010: # even if privileged
                   10011:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10012: # add crosslistings
                   10013:     if ($args->{'crsxlist'}) {
                   10014:         $cenv{'internal.crosslistings'}='';
                   10015:         if ($args->{'crsxlist'} =~ m/,/) {
                   10016:             @xlists = split/,/,$args->{'crsxlist'};
                   10017:         } else {
                   10018:             $xlists[0] = $args->{'crsxlist'};
                   10019:         }
                   10020:         if (@xlists > 0) {
                   10021:             foreach my $item (@xlists) {
                   10022:                 my ($xl,$gp) = split/:/,$item;
                   10023:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   10024:                 $cenv{'internal.crosslistings'} .= $item.',';
                   10025:                 unless ($addcheck eq 'ok') {
                   10026:                     push @badclasses, $xl;
                   10027:                 }
                   10028:             }
                   10029:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   10030:         }
                   10031:     }
                   10032:     if ($args->{'autoadds'}) {
                   10033:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   10034:     }
                   10035:     if ($args->{'autodrops'}) {
                   10036:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10037:     }
                   10038: # check for notification of enrollment changes
                   10039:     my @notified = ();
                   10040:     if ($args->{'notify_owner'}) {
                   10041:         if ($args->{'ccuname'} ne '') {
                   10042:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10043:         }
                   10044:     }
                   10045:     if ($args->{'notify_dc'}) {
                   10046:         if ($uname ne '') { 
1.630     raeburn  10047:             push(@notified,$uname.':'.$udom);
1.444     albertel 10048:         }
                   10049:     }
                   10050:     if (@notified > 0) {
                   10051:         my $notifylist;
                   10052:         if (@notified > 1) {
                   10053:             $notifylist = join(',',@notified);
                   10054:         } else {
                   10055:             $notifylist = $notified[0];
                   10056:         }
                   10057:         $cenv{'internal.notifylist'} = $notifylist;
                   10058:     }
                   10059:     if (@badclasses > 0) {
                   10060:         my %lt=&Apache::lonlocal::texthash(
                   10061:                 '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',
                   10062:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10063:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10064:         );
1.541     raeburn  10065:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10066:                            ' ('.$lt{'adby'}.')';
                   10067:         if ($context eq 'auto') {
                   10068:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10069:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10070:             foreach my $item (@badclasses) {
                   10071:                 if ($context eq 'auto') {
                   10072:                     $outcome .= " - $item\n";
                   10073:                 } else {
                   10074:                     $outcome .= "<li>$item</li>\n";
                   10075:                 }
                   10076:             }
                   10077:             if ($context eq 'auto') {
                   10078:                 $outcome .= $linefeed;
                   10079:             } else {
1.566     albertel 10080:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10081:             }
                   10082:         } 
1.444     albertel 10083:     }
                   10084:     if ($args->{'no_end_date'}) {
                   10085:         $args->{'endaccess'} = 0;
                   10086:     }
                   10087:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10088:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10089:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10090:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10091:     if ($args->{'showphotos'}) {
                   10092:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10093:     }
                   10094:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10095:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10096:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10097:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10098:             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'); 
                   10099:             if ($context eq 'auto') {
                   10100:                 $outcome .= $krb_msg;
                   10101:             } else {
1.566     albertel 10102:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10103:             }
                   10104:             $outcome .= $linefeed;
1.444     albertel 10105:         }
                   10106:     }
                   10107:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10108:        if ($args->{'setpolicy'}) {
                   10109:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10110:        }
                   10111:        if ($args->{'setcontent'}) {
                   10112:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10113:        }
                   10114:     }
                   10115:     if ($args->{'reshome'}) {
                   10116: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10117: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10118:     }
                   10119: #
                   10120: # course has keyed access
                   10121: #
                   10122:     if ($args->{'setkeys'}) {
                   10123:        $cenv{'keyaccess'}='yes';
                   10124:     }
                   10125: # if specified, key authority is not course, but user
                   10126: # only active if keyaccess is yes
                   10127:     if ($args->{'keyauth'}) {
1.487     albertel 10128: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10129: 	$user = &LONCAPA::clean_username($user);
                   10130: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10131: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10132: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10133: 	}
                   10134:     }
                   10135: 
                   10136:     if ($args->{'disresdis'}) {
                   10137:         $cenv{'pch.roles.denied'}='st';
                   10138:     }
                   10139:     if ($args->{'disablechat'}) {
                   10140:         $cenv{'plc.roles.denied'}='st';
                   10141:     }
                   10142: 
                   10143:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10144:     # course
                   10145:     $cenv{'course.helper.not.run'} = 1;
                   10146:     #
                   10147:     # Use new Randomseed
                   10148:     #
                   10149:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10150:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10151:     #
                   10152:     # The encryption code and receipt prefix for this course
                   10153:     #
                   10154:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10155:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10156:     #
                   10157:     # By default, use standard grading
                   10158:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10159: 
1.541     raeburn  10160:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10161:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10162: #
                   10163: # Open all assignments
                   10164: #
                   10165:     if ($args->{'openall'}) {
                   10166:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10167:        my %storecontent = ($storeunder         => time,
                   10168:                            $storeunder.'.type' => 'date_start');
                   10169:        
                   10170:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10171:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10172:    }
                   10173: #
                   10174: # Set first page
                   10175: #
                   10176:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10177: 	    || ($cloneid)) {
1.445     albertel 10178: 	use LONCAPA::map;
1.444     albertel 10179: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10180: 
                   10181: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10182:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10183: 
1.444     albertel 10184:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10185:         my $title; my $url;
                   10186:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10187: 	    $title=&mt('Syllabus');
1.444     albertel 10188:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10189:         } else {
1.690     bisitz   10190:             $title=&mt('Navigate Contents');
1.444     albertel 10191:             $url='/adm/navmaps';
                   10192:         }
1.445     albertel 10193: 
                   10194:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10195: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10196: 
                   10197: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10198:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10199:     }
1.566     albertel 10200: 
                   10201:     return (1,$outcome);
1.444     albertel 10202: }
                   10203: 
                   10204: ############################################################
                   10205: ############################################################
                   10206: 
1.378     raeburn  10207: sub course_type {
                   10208:     my ($cid) = @_;
                   10209:     if (!defined($cid)) {
                   10210:         $cid = $env{'request.course.id'};
                   10211:     }
1.404     albertel 10212:     if (defined($env{'course.'.$cid.'.type'})) {
                   10213:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10214:     } else {
                   10215:         return 'Course';
1.377     raeburn  10216:     }
                   10217: }
1.156     albertel 10218: 
1.406     raeburn  10219: sub group_term {
                   10220:     my $crstype = &course_type();
                   10221:     my %names = (
                   10222:                   'Course' => 'group',
                   10223:                   'Group' => 'team',
                   10224:                 );
                   10225:     return $names{$crstype};
                   10226: }
                   10227: 
1.156     albertel 10228: sub icon {
                   10229:     my ($file)=@_;
1.505     albertel 10230:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10231:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10232:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10233:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10234: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10235: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10236: 	            $curfext.".gif") {
                   10237: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10238: 		$curfext.".gif";
                   10239: 	}
                   10240:     }
1.249     albertel 10241:     return &lonhttpdurl($iconname);
1.154     albertel 10242: } 
1.84      albertel 10243: 
1.575     albertel 10244: sub lonhttpdurl {
1.692     www      10245: #
                   10246: # Had been used for "small fry" static images on separate port 8080.
                   10247: # Modify here if lightweight http functionality desired again.
                   10248: # Currently eliminated due to increasing firewall issues.
                   10249: #
1.575     albertel 10250:     my ($url)=@_;
1.692     www      10251:     return $url;
1.215     albertel 10252: }
                   10253: 
1.213     albertel 10254: sub connection_aborted {
                   10255:     my ($r)=@_;
                   10256:     $r->print(" ");$r->rflush();
                   10257:     my $c = $r->connection;
                   10258:     return $c->aborted();
                   10259: }
                   10260: 
1.221     foxr     10261: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10262: #    strings as 'strings'.
                   10263: sub escape_single {
1.221     foxr     10264:     my ($input) = @_;
1.223     albertel 10265:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10266:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10267:     return $input;
                   10268: }
1.223     albertel 10269: 
1.222     foxr     10270: #  Same as escape_single, but escape's "'s  This 
                   10271: #  can be used for  "strings"
                   10272: sub escape_double {
                   10273:     my ($input) = @_;
                   10274:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10275:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10276:     return $input;
                   10277: }
1.223     albertel 10278:  
1.222     foxr     10279: #   Escapes the last element of a full URL.
                   10280: sub escape_url {
                   10281:     my ($url)   = @_;
1.238     raeburn  10282:     my @urlslices = split(/\//, $url,-1);
1.369     www      10283:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10284:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10285: }
1.462     albertel 10286: 
1.820     raeburn  10287: sub compare_arrays {
                   10288:     my ($arrayref1,$arrayref2) = @_;
                   10289:     my (@difference,%count);
                   10290:     @difference = ();
                   10291:     %count = ();
                   10292:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10293:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10294:         foreach my $element (keys(%count)) {
                   10295:             if ($count{$element} == 1) {
                   10296:                 push(@difference,$element);
                   10297:             }
                   10298:         }
                   10299:     }
                   10300:     return @difference;
                   10301: }
                   10302: 
1.817     bisitz   10303: # -------------------------------------------------------- Initialize user login
1.462     albertel 10304: sub init_user_environment {
1.463     albertel 10305:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10306:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10307: 
                   10308:     my $public=($username eq 'public' && $domain eq 'public');
                   10309: 
                   10310: # See if old ID present, if so, remove
                   10311: 
                   10312:     my ($filename,$cookie,$userroles);
                   10313:     my $now=time;
                   10314: 
                   10315:     if ($public) {
                   10316: 	my $max_public=100;
                   10317: 	my $oldest;
                   10318: 	my $oldest_time=0;
                   10319: 	for(my $next=1;$next<=$max_public;$next++) {
                   10320: 	    if (-e $lonids."/publicuser_$next.id") {
                   10321: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10322: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10323: 		    $oldest_time=$mtime;
                   10324: 		    $oldest=$next;
                   10325: 		}
                   10326: 	    } else {
                   10327: 		$cookie="publicuser_$next";
                   10328: 		last;
                   10329: 	    }
                   10330: 	}
                   10331: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10332:     } else {
1.463     albertel 10333: 	# if this isn't a robot, kill any existing non-robot sessions
                   10334: 	if (!$args->{'robot'}) {
                   10335: 	    opendir(DIR,$lonids);
                   10336: 	    while ($filename=readdir(DIR)) {
                   10337: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10338: 		    unlink($lonids.'/'.$filename);
                   10339: 		}
1.462     albertel 10340: 	    }
1.463     albertel 10341: 	    closedir(DIR);
1.462     albertel 10342: 	}
                   10343: # Give them a new cookie
1.463     albertel 10344: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10345: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10346: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10347:     
                   10348: # Initialize roles
                   10349: 
                   10350: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10351:     }
                   10352: # ------------------------------------ Check browser type and MathML capability
                   10353: 
                   10354:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10355:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10356: 
                   10357: # ------------------------------------------------------------- Get environment
                   10358: 
                   10359:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10360:     my ($tmp) = keys(%userenv);
                   10361:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10362: 	# default remote control to off
                   10363: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   10364:     } else {
                   10365: 	undef(%userenv);
                   10366:     }
                   10367:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10368: 	$form->{'interface'}=$userenv{'interface'};
                   10369:     }
                   10370:     $env{'environment.remote'}=$userenv{'remote'};
                   10371:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10372: 
                   10373: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10374:     foreach my $option ('interface','localpath','localres') {
                   10375:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10376:     }
                   10377: # --------------------------------------------------------- Write first profile
                   10378: 
                   10379:     {
                   10380: 	my %initial_env = 
                   10381: 	    ("user.name"          => $username,
                   10382: 	     "user.domain"        => $domain,
                   10383: 	     "user.home"          => $authhost,
                   10384: 	     "browser.type"       => $clientbrowser,
                   10385: 	     "browser.version"    => $clientversion,
                   10386: 	     "browser.mathml"     => $clientmathml,
                   10387: 	     "browser.unicode"    => $clientunicode,
                   10388: 	     "browser.os"         => $clientos,
                   10389: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10390: 	     "request.course.fn"  => '',
                   10391: 	     "request.course.uri" => '',
                   10392: 	     "request.course.sec" => '',
                   10393: 	     "request.role"       => 'cm',
                   10394: 	     "request.role.adv"   => $env{'user.adv'},
                   10395: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10396: 
                   10397:         if ($form->{'localpath'}) {
                   10398: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10399: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10400:         }
                   10401: 	
                   10402: 	if ($public) {
                   10403: 	    $initial_env{"environment.remote"} = "off";
                   10404: 	}
                   10405: 	if ($form->{'interface'}) {
                   10406: 	    $form->{'interface'}=~s/\W//gs;
                   10407: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10408: 	    $env{'browser.interface'}=$form->{'interface'};
                   10409: 	}
                   10410: 
1.724     raeburn  10411:         foreach my $tool ('aboutme','blog','portfolio') {
                   10412:             $userenv{'availabletools.'.$tool} = 
                   10413:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10414:         }
                   10415: 
1.765     raeburn  10416:         foreach my $crstype ('official','unofficial') {
                   10417:             $userenv{'canrequest.'.$crstype} =
                   10418:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10419:                                                   'reload','requestcourses');
                   10420:         }
                   10421: 
1.462     albertel 10422: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10423: 	
                   10424: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10425: 		 &GDBM_WRCREAT(),0640)) {
                   10426: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10427: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10428: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10429: 	    if (ref($args->{'extra_env'})) {
                   10430: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10431: 	    }
1.462     albertel 10432: 	    untie(%disk_env);
                   10433: 	} else {
1.705     tempelho 10434: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10435: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10436: 	    return 'error: '.$!;
                   10437: 	}
                   10438:     }
                   10439:     $env{'request.role'}='cm';
                   10440:     $env{'request.role.adv'}=$env{'user.adv'};
                   10441:     $env{'browser.type'}=$clientbrowser;
                   10442: 
                   10443:     return $cookie;
                   10444: 
                   10445: }
                   10446: 
                   10447: sub _add_to_env {
                   10448:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10449:     if (ref($env_data) eq 'HASH') {
                   10450:         while (my ($key,$value) = each(%$env_data)) {
                   10451: 	    $idf->{$prefix.$key} = $value;
                   10452: 	    $env{$prefix.$key}   = $value;
                   10453:         }
1.462     albertel 10454:     }
                   10455: }
                   10456: 
1.685     tempelho 10457: # --- Get the symbolic name of a problem and the url
                   10458: sub get_symb {
                   10459:     my ($request,$silent) = @_;
1.726     raeburn  10460:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10461:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10462:     if ($symb eq '') {
                   10463:         if (!$silent) {
                   10464:             $request->print("Unable to handle ambiguous references:$url:.");
                   10465:             return ();
                   10466:         }
                   10467:     }
                   10468:     &Apache::lonenc::check_decrypt(\$symb);
                   10469:     return ($symb);
                   10470: }
                   10471: 
                   10472: # --------------------------------------------------------------Get annotation
                   10473: 
                   10474: sub get_annotation {
                   10475:     my ($symb,$enc) = @_;
                   10476: 
                   10477:     my $key = $symb;
                   10478:     if (!$enc) {
                   10479:         $key =
                   10480:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10481:     }
                   10482:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10483:     return $annotation{$key};
                   10484: }
                   10485: 
                   10486: sub clean_symb {
1.731     raeburn  10487:     my ($symb,$delete_enc) = @_;
1.685     tempelho 10488: 
                   10489:     &Apache::lonenc::check_decrypt(\$symb);
                   10490:     my $enc = $env{'request.enc'};
1.731     raeburn  10491:     if ($delete_enc) {
1.730     raeburn  10492:         delete($env{'request.enc'});
                   10493:     }
1.685     tempelho 10494: 
                   10495:     return ($symb,$enc);
                   10496: }
1.462     albertel 10497: 
1.41      ng       10498: =pod
                   10499: 
                   10500: =back
                   10501: 
1.112     bowersj2 10502: =cut
1.41      ng       10503: 
1.112     bowersj2 10504: 1;
                   10505: __END__;
1.41      ng       10506: 

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