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

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

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