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

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

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