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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.974   ! wenzelju    4: # $Id: loncommon.pm,v 1.973 2010/08/08 02:00:38 raeburn Exp $
1.10      albertel    5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
1.1       albertel   28: 
                     29: # Makes a table out of the previous attempts
1.2       albertel   30: # Inputs result_from_symbread, user, domain, course_id
1.16      harris41   31: # Reads in non-network-related .tab files
1.1       albertel   32: 
1.35      matthew    33: # POD header:
                     34: 
1.45      matthew    35: =pod
                     36: 
1.35      matthew    37: =head1 NAME
                     38: 
                     39: Apache::loncommon - pile of common routines
                     40: 
                     41: =head1 SYNOPSIS
                     42: 
1.112     bowersj2   43: Common routines for manipulating connections, student answers,
                     44:     domains, common Javascript fragments, etc.
1.35      matthew    45: 
1.112     bowersj2   46: =head1 OVERVIEW
1.35      matthew    47: 
1.112     bowersj2   48: A collection of commonly used subroutines that don't have a natural
                     49: home anywhere else. This collection helps remove
1.35      matthew    50: redundancy from other modules and increase efficiency of memory usage.
                     51: 
                     52: =cut 
                     53: 
                     54: # End of POD header
1.1       albertel   55: package Apache::loncommon;
                     56: 
                     57: use strict;
1.258     albertel   58: use Apache::lonnet;
1.46      matthew    59: use GDBM_File;
1.51      www        60: use POSIX qw(strftime mktime);
1.82      www        61: use Apache::lonmenu();
1.498     albertel   62: use Apache::lonenc();
1.117     www        63: use Apache::lonlocal;
1.685     tempelho   64: use Apache::lonnet();
1.139     matthew    65: use HTML::Entities;
1.334     albertel   66: use Apache::lonhtmlcommon();
                     67: use Apache::loncoursedata();
1.344     albertel   68: use Apache::lontexconvert();
1.444     albertel   69: use Apache::lonclonecourse();
1.479     albertel   70: use LONCAPA qw(:DEFAULT :match);
1.657     raeburn    71: use DateTime::TimeZone;
1.687     raeburn    72: use DateTime::Locale::Catalog;
1.117     www        73: 
1.517     raeburn    74: # ---------------------------------------------- Designs
                     75: use vars qw(%defaultdesign);
                     76: 
1.22      www        77: my $readit;
                     78: 
1.517     raeburn    79: 
1.157     matthew    80: ##
                     81: ## Global Variables
                     82: ##
1.46      matthew    83: 
1.643     foxr       84: 
                     85: # ----------------------------------------------- SSI with retries:
                     86: #
                     87: 
                     88: =pod
                     89: 
1.648     raeburn    90: =head1 Server Side include with retries:
1.643     foxr       91: 
                     92: =over 4
                     93: 
1.648     raeburn    94: =item * &ssi_with_retries(resource,retries form)
1.643     foxr       95: 
                     96: Performs an ssi with some number of retries.  Retries continue either
                     97: until the result is ok or until the retry count supplied by the
                     98: caller is exhausted.  
                     99: 
                    100: Inputs:
1.648     raeburn   101: 
                    102: =over 4
                    103: 
1.643     foxr      104: resource   - Identifies the resource to insert.
1.648     raeburn   105: 
1.643     foxr      106: retries    - Count of the number of retries allowed.
1.648     raeburn   107: 
1.643     foxr      108: form       - Hash that identifies the rendering options.
                    109: 
1.648     raeburn   110: =back
                    111: 
                    112: Returns:
                    113: 
                    114: =over 4
                    115: 
1.643     foxr      116: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   117: 
1.643     foxr      118: response   - The response from the last attempt (which may or may not have been successful.
                    119: 
1.648     raeburn   120: =back
                    121: 
                    122: =back
                    123: 
1.643     foxr      124: =cut
                    125: 
                    126: sub ssi_with_retries {
                    127:     my ($resource, $retries, %form) = @_;
                    128: 
                    129: 
                    130:     my $ok = 0;			# True if we got a good response.
                    131:     my $content;
                    132:     my $response;
                    133: 
                    134:     # Try to get the ssi done. within the retries count:
                    135: 
                    136:     do {
                    137: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    138: 	$ok      = $response->is_success;
1.650     www       139:         if (!$ok) {
                    140:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    141:         }
1.643     foxr      142: 	$retries--;
                    143:     } while (!$ok && ($retries > 0));
                    144: 
                    145:     if (!$ok) {
                    146: 	$content = '';		# On error return an empty content.
                    147:     }
                    148:     return ($content, $response);
                    149: 
                    150: }
                    151: 
                    152: 
                    153: 
1.20      www       154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  155: my %language;
1.124     www       156: my %supported_language;
1.12      harris41  157: my %cprtag;
1.192     taceyjo1  158: my %scprtag;
1.351     www       159: my %fe; my %fd; my %fm;
1.41      ng        160: my %category_extensions;
1.12      harris41  161: 
1.46      matthew   162: # ---------------------------------------------- Thesaurus variables
1.144     matthew   163: #
                    164: # %Keywords:
                    165: #      A hash used by &keyword to determine if a word is considered a keyword.
                    166: # $thesaurus_db_file 
                    167: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   168: 
                    169: my %Keywords;
                    170: my $thesaurus_db_file;
                    171: 
1.144     matthew   172: #
                    173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    174: # thesaurus.tab, and filecategories.tab.
                    175: #
1.18      www       176: BEGIN {
1.46      matthew   177:     # Variable initialization
                    178:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    179:     #
1.22      www       180:     unless ($readit) {
1.12      harris41  181: # ------------------------------------------------------------------- languages
                    182:     {
1.158     raeburn   183:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    184:                                    '/language.tab';
                    185:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  186:             while (my $line = <$fh>) {
                    187:                 next if ($line=~/^\#/);
                    188:                 chomp($line);
                    189:                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158     raeburn   190:                 $language{$key}=$val.' - '.$enc;
                    191:                 if ($sup) {
                    192:                     $supported_language{$key}=$sup;
                    193:                 }
                    194:             }
                    195:             close($fh);
                    196:         }
1.12      harris41  197:     }
                    198: # ------------------------------------------------------------------ copyrights
                    199:     {
1.158     raeburn   200:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    201:                                   '/copyright.tab';
                    202:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  203:             while (my $line = <$fh>) {
                    204:                 next if ($line=~/^\#/);
                    205:                 chomp($line);
                    206:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   207:                 $cprtag{$key}=$val;
                    208:             }
                    209:             close($fh);
                    210:         }
1.12      harris41  211:     }
1.351     www       212: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  213:     {
                    214:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    215:                                   '/source_copyright.tab';
                    216:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  217:             while (my $line = <$fh>) {
                    218:                 next if ($line =~ /^\#/);
                    219:                 chomp($line);
                    220:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  221:                 $scprtag{$key}=$val;
                    222:             }
                    223:             close($fh);
                    224:         }
                    225:     }
1.63      www       226: 
1.517     raeburn   227: # -------------------------------------------------------------- default domain designs
1.63      www       228:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   229:     my $designfile = $designdir.'/default.tab';
                    230:     if ( open (my $fh,"<$designfile") ) {
                    231:         while (my $line = <$fh>) {
                    232:             next if ($line =~ /^\#/);
                    233:             chomp($line);
                    234:             my ($key,$val)=(split(/\=/,$line));
                    235:             if ($val) { $defaultdesign{$key}=$val; }
                    236:         }
                    237:         close($fh);
1.63      www       238:     }
                    239: 
1.15      harris41  240: # ------------------------------------------------------------- file categories
                    241:     {
1.158     raeburn   242:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    243:                                   '/filecategories.tab';
                    244:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  245: 	    while (my $line = <$fh>) {
                    246: 		next if ($line =~ /^\#/);
                    247: 		chomp($line);
                    248:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   249:                 push @{$category_extensions{lc($category)}},$extension;
                    250:             }
                    251:             close($fh);
                    252:         }
                    253: 
1.15      harris41  254:     }
1.12      harris41  255: # ------------------------------------------------------------------ file types
                    256:     {
1.158     raeburn   257:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    258:                '/filetypes.tab';
                    259:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  260:             while (my $line = <$fh>) {
                    261: 		next if ($line =~ /^\#/);
                    262: 		chomp($line);
                    263:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   264:                 if ($descr ne '') {
                    265:                     $fe{$ending}=lc($emb);
                    266:                     $fd{$ending}=$descr;
1.351     www       267:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   268:                 }
                    269:             }
                    270:             close($fh);
                    271:         }
1.12      harris41  272:     }
1.22      www       273:     &Apache::lonnet::logthis(
1.705     tempelho  274:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       275:     $readit=1;
1.46      matthew   276:     }  # end of unless($readit) 
1.32      matthew   277:     
                    278: }
1.112     bowersj2  279: 
1.42      matthew   280: ###############################################################
                    281: ##           HTML and Javascript Helper Functions            ##
                    282: ###############################################################
                    283: 
                    284: =pod 
                    285: 
1.112     bowersj2  286: =head1 HTML and Javascript Functions
1.42      matthew   287: 
1.112     bowersj2  288: =over 4
                    289: 
1.648     raeburn   290: =item * &browser_and_searcher_javascript()
1.112     bowersj2  291: 
                    292: X<browsing, javascript>X<searching, javascript>Returns a string
                    293: containing javascript with two functions, C<openbrowser> and
                    294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    295: tags.
1.42      matthew   296: 
1.648     raeburn   297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   298: 
                    299: inputs: formname, elementname, only, omit
                    300: 
                    301: formname and elementname indicate the name of the html form and name of
                    302: the element that the results of the browsing selection are to be placed in. 
                    303: 
                    304: Specifying 'only' will restrict the browser to displaying only files
1.185     www       305: with the given extension.  Can be a comma separated list.
1.42      matthew   306: 
                    307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       308: with the given extension.  Can be a comma separated list.
1.42      matthew   309: 
1.648     raeburn   310: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   311: 
                    312: Inputs: formname, elementname
                    313: 
                    314: formname and elementname specify the name of the html form and the name
                    315: of the element the selection from the search results will be placed in.
1.542     raeburn   316: 
1.42      matthew   317: =cut
                    318: 
                    319: sub browser_and_searcher_javascript {
1.199     albertel  320:     my ($mode)=@_;
                    321:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  322:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   323:     return <<END;
1.219     albertel  324: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   325:     var editbrowser = null;
1.135     albertel  326:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       327:         var url = '$resurl/?';
1.42      matthew   328:         if (editbrowser == null) {
                    329:             url += 'launch=1&';
                    330:         }
                    331:         url += 'catalogmode=interactive&';
1.199     albertel  332:         url += 'mode=$mode&';
1.611     albertel  333:         url += 'inhibitmenu=yes&';
1.42      matthew   334:         url += 'form=' + formname + '&';
                    335:         if (only != null) {
                    336:             url += 'only=' + only + '&';
1.217     albertel  337:         } else {
                    338:             url += 'only=&';
                    339: 	}
1.42      matthew   340:         if (omit != null) {
                    341:             url += 'omit=' + omit + '&';
1.217     albertel  342:         } else {
                    343:             url += 'omit=&';
                    344: 	}
1.135     albertel  345:         if (titleelement != null) {
                    346:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  347:         } else {
                    348: 	    url += 'titleelement=&';
                    349: 	}
1.42      matthew   350:         url += 'element=' + elementname + '';
                    351:         var title = 'Browser';
1.435     albertel  352:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   353:         options += ',width=700,height=600';
                    354:         editbrowser = open(url,title,options,'1');
                    355:         editbrowser.focus();
                    356:     }
                    357:     var editsearcher;
1.135     albertel  358:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   359:         var url = '/adm/searchcat?';
                    360:         if (editsearcher == null) {
                    361:             url += 'launch=1&';
                    362:         }
                    363:         url += 'catalogmode=interactive&';
1.199     albertel  364:         url += 'mode=$mode&';
1.42      matthew   365:         url += 'form=' + formname + '&';
1.135     albertel  366:         if (titleelement != null) {
                    367:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  368:         } else {
                    369: 	    url += 'titleelement=&';
                    370: 	}
1.42      matthew   371:         url += 'element=' + elementname + '';
                    372:         var title = 'Search';
1.435     albertel  373:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   374:         options += ',width=700,height=600';
                    375:         editsearcher = open(url,title,options,'1');
                    376:         editsearcher.focus();
                    377:     }
1.219     albertel  378: // END LON-CAPA Internal -->
1.42      matthew   379: END
1.170     www       380: }
                    381: 
                    382: sub lastresurl {
1.258     albertel  383:     if ($env{'environment.lastresurl'}) {
                    384: 	return $env{'environment.lastresurl'}
1.170     www       385:     } else {
                    386: 	return '/res';
                    387:     }
                    388: }
                    389: 
                    390: sub storeresurl {
                    391:     my $resurl=&Apache::lonnet::clutter(shift);
                    392:     unless ($resurl=~/^\/res/) { return 0; }
                    393:     $resurl=~s/\/$//;
                    394:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   395:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       396:     return 1;
1.42      matthew   397: }
                    398: 
1.74      www       399: sub studentbrowser_javascript {
1.111     www       400:    unless (
1.258     albertel  401:             (($env{'request.course.id'}) && 
1.302     albertel  402:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    403: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    404: 					  '/'.$env{'request.course.sec'})
                    405: 	      ))
1.258     albertel  406:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       407:           ) { return ''; }  
1.74      www       408:    return (<<'ENDSTDBRW');
1.776     bisitz    409: <script type="text/javascript" language="Javascript">
1.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.909     raeburn   485:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932     raeburn   486:     my $wintitle = 'Course_Browser';
1.931     raeburn   487:     if ($crstype eq 'Community') {
1.932     raeburn   488:         $wintitle = 'Community_Browser';
1.909     raeburn   489:     }
1.876     raeburn   490:     my $id_functions = &javascript_index_functions();
                    491:     my $output = '
1.776     bisitz    492: <script type="text/javascript" language="JavaScript">
1.824     bisitz    493: // <![CDATA[
1.468     raeburn   494:     var stdeditbrowser;'."\n";
1.876     raeburn   495: 
                    496:     $output .= <<"ENDSTDBRW";
1.909     raeburn   497:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       498:         var url = '/adm/pickcourse?';
1.895     raeburn   499:         var formid = getFormIdByName(formname);
1.876     raeburn   500:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  501:         if (domainfilter != null) {
                    502:            if (domainfilter != '') {
                    503:                url += 'domainfilter='+domainfilter+'&';
                    504: 	   }
                    505:         }
1.91      www       506:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  507: 	                            '&cdomelement='+udom+
                    508:                                     '&cnameelement='+desc;
1.468     raeburn   509:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   510:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   511:                 url += '&roleelement='+extra_element;
                    512:                 if (domainfilter == null || domainfilter == '') {
                    513:                     url += '&domainfilter='+extra_element;
                    514:                 }
1.234     raeburn   515:             }
1.468     raeburn   516:             else {
                    517:                 if (formname == 'portform') {
                    518:                     url += '&setroles='+extra_element;
1.800     raeburn   519:                 } else {
                    520:                     if (formname == 'rules') {
                    521:                         url += '&fixeddom='+extra_element; 
                    522:                     }
1.468     raeburn   523:                 }
                    524:             }     
1.230     raeburn   525:         }
1.909     raeburn   526:         if (type != null && type != '') {
                    527:             url += '&type='+type;
                    528:         }
                    529:         if (type_elem != null && type_elem != '') {
                    530:             url += '&typeelement='+type_elem;
                    531:         }
1.872     raeburn   532:         if (formname == 'ccrs') {
                    533:             var ownername = document.forms[formid].ccuname.value;
                    534:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
                    535:             url += '&cloner='+ownername+':'+ownerdom;
                    536:         }
1.293     raeburn   537:         if (multflag !=null && multflag != '') {
                    538:             url += '&multiple='+multflag;
                    539:         }
1.909     raeburn   540:         var title = '$wintitle';
1.91      www       541:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    542:         options += ',width=700,height=600';
                    543:         stdeditbrowser = open(url,title,options,'1');
                    544:         stdeditbrowser.focus();
                    545:     }
1.876     raeburn   546: $id_functions
                    547: ENDSTDBRW
1.905     raeburn   548:     if (($sec_element ne '') || ($role_element ne '')) {
                    549:         $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876     raeburn   550:     }
                    551:     $output .= '
                    552: // ]]>
                    553: </script>';
                    554:     return $output;
                    555: }
                    556: 
                    557: sub javascript_index_functions {
                    558:     return <<"ENDJS";
                    559: 
                    560: function getFormIdByName(formname) {
                    561:     for (var i=0;i<document.forms.length;i++) {
                    562:         if (document.forms[i].name == formname) {
                    563:             return i;
                    564:         }
                    565:     }
                    566:     return -1;
                    567: }
                    568: 
                    569: function getIndexByName(formid,item) {
                    570:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    571:         if (document.forms[formid].elements[i].name == item) {
                    572:             return i;
                    573:         }
                    574:     }
                    575:     return -1;
                    576: }
1.468     raeburn   577: 
1.876     raeburn   578: function getDomainFromSelectbox(formname,udom) {
                    579:     var userdom;
                    580:     var formid = getFormIdByName(formname);
                    581:     if (formid > -1) {
                    582:         var domid = getIndexByName(formid,udom);
                    583:         if (domid > -1) {
                    584:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    585:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    586:             }
                    587:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    588:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   589:             }
                    590:         }
                    591:     }
1.876     raeburn   592:     return userdom;
                    593: }
                    594: 
                    595: ENDJS
1.468     raeburn   596: 
1.876     raeburn   597: }
                    598: 
                    599: sub userbrowser_javascript {
                    600:     my $id_functions = &javascript_index_functions();
                    601:     return <<"ENDUSERBRW";
                    602: 
1.888     raeburn   603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   604:     var url = '/adm/pickuser?';
                    605:     var userdom = getDomainFromSelectbox(formname,udom);
                    606:     if (userdom != null) {
                    607:        if (userdom != '') {
                    608:            url += 'srchdom='+userdom+'&';
                    609:        }
                    610:     }
                    611:     url += 'form=' + formname + '&unameelement='+uname+
                    612:                                 '&udomelement='+udom+
                    613:                                 '&ulastelement='+ulast+
                    614:                                 '&ufirstelement='+ufirst+
                    615:                                 '&uemailelement='+uemail+
1.881     raeburn   616:                                 '&hideudomelement='+hideudom+
                    617:                                 '&coursedom='+crsdom;
1.888     raeburn   618:     if ((caller != null) && (caller != undefined)) {
                    619:         url += '&caller='+caller;
                    620:     }
1.876     raeburn   621:     var title = 'User_Browser';
                    622:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    623:     options += ',width=700,height=600';
                    624:     var stdeditbrowser = open(url,title,options,'1');
                    625:     stdeditbrowser.focus();
                    626: }
                    627: 
1.888     raeburn   628: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   629:     var formid = getFormIdByName(formname);
                    630:     if (formid > -1) {
1.888     raeburn   631:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   632:         var domid = getIndexByName(formid,udom);
                    633:         var hidedomid = getIndexByName(formid,origdom);
                    634:         if (hidedomid > -1) {
                    635:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   636:             var unameval = document.forms[formid].elements[unameid].value;
                    637:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    638:                 if (domid > -1) {
                    639:                     var slct = document.forms[formid].elements[domid];
                    640:                     if (slct.type == 'select-one') {
                    641:                         var i;
                    642:                         for (i=0;i<slct.length;i++) {
                    643:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    644:                         }
                    645:                     }
                    646:                     if (slct.type == 'hidden') {
                    647:                         slct.value = fixeddom;
1.876     raeburn   648:                     }
                    649:                 }
1.468     raeburn   650:             }
                    651:         }
                    652:     }
1.876     raeburn   653:     return;
                    654: }
                    655: 
                    656: $id_functions
                    657: ENDUSERBRW
1.468     raeburn   658: }
                    659: 
                    660: sub setsec_javascript {
1.905     raeburn   661:     my ($sec_element,$formname,$role_element) = @_;
                    662:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    663:         $communityrolestr);
                    664:     if ($role_element ne '') {
                    665:         my @allroles = ('st','ta','ep','in','ad');
                    666:         foreach my $crstype ('Course','Community') {
                    667:             if ($crstype eq 'Community') {
                    668:                 foreach my $role (@allroles) {
                    669:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    670:                 }
                    671:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    672:             } else {
                    673:                 foreach my $role (@allroles) {
                    674:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    675:                 }
                    676:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    677:             }
                    678:         }
                    679:         $rolestr = '"'.join('","',@allroles).'"';
                    680:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    681:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    682:     }
1.468     raeburn   683:     my $setsections = qq|
                    684: function setSect(sectionlist) {
1.629     raeburn   685:     var sectionsArray = new Array();
                    686:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    687:         sectionsArray = sectionlist.split(",");
                    688:     }
1.468     raeburn   689:     var numSections = sectionsArray.length;
                    690:     document.$formname.$sec_element.length = 0;
                    691:     if (numSections == 0) {
                    692:         document.$formname.$sec_element.multiple=false;
                    693:         document.$formname.$sec_element.size=1;
                    694:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    695:     } else {
                    696:         if (numSections == 1) {
                    697:             document.$formname.$sec_element.multiple=false;
                    698:             document.$formname.$sec_element.size=1;
                    699:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    700:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    701:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    702:         } else {
                    703:             for (var i=0; i<numSections; i++) {
                    704:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    705:             }
                    706:             document.$formname.$sec_element.multiple=true
                    707:             if (numSections < 3) {
                    708:                 document.$formname.$sec_element.size=numSections;
                    709:             } else {
                    710:                 document.$formname.$sec_element.size=3;
                    711:             }
                    712:             document.$formname.$sec_element.options[0].selected = false
                    713:         }
                    714:     }
1.91      www       715: }
1.905     raeburn   716: 
                    717: function setRole(crstype) {
1.468     raeburn   718: |;
1.905     raeburn   719:     if ($role_element eq '') {
                    720:         $setsections .= '    return;
                    721: }
                    722: ';
                    723:     } else {
                    724:         $setsections .= qq|
                    725:     var elementLength = document.$formname.$role_element.length;
                    726:     var allroles = Array($rolestr);
                    727:     var courserolenames = Array($courserolestr);
                    728:     var communityrolenames = Array($communityrolestr);
                    729:     if (elementLength != undefined) {
                    730:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    731:             if (crstype == 'Course') {
                    732:                 return;
                    733:             } else {
                    734:                 allroles[5] = 'co';
                    735:                 for (var i=0; i<6; i++) {
                    736:                     document.$formname.$role_element.options[i].value = allroles[i];
                    737:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    738:                 }
                    739:             }
                    740:         } else {
                    741:             if (crstype == 'Community') {
                    742:                 return;
                    743:             } else {
                    744:                 allroles[5] = 'cc';
                    745:                 for (var i=0; i<6; i++) {
                    746:                     document.$formname.$role_element.options[i].value = allroles[i];
                    747:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    748:                 }
                    749:             }
                    750:         }
                    751:     }
                    752:     return;
                    753: }
                    754: |;
                    755:     }
1.468     raeburn   756:     return $setsections;
                    757: }
                    758: 
1.91      www       759: sub selectcourse_link {
1.909     raeburn   760:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    761:        $typeelement) = @_;
                    762:    my $type = $selecttype;
1.871     raeburn   763:    my $linktext = &mt('Select Course');
                    764:    if ($selecttype eq 'Community') {
1.909     raeburn   765:        $linktext = &mt('Select Community');
1.906     raeburn   766:    } elsif ($selecttype eq 'Course/Community') {
                    767:        $linktext = &mt('Select Course/Community');
1.909     raeburn   768:        $type = '';
1.871     raeburn   769:    }
1.787     bisitz    770:    return '<span class="LC_nobreak">'
                    771:          ."<a href='"
                    772:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    773:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   774:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   775:          ."'>".$linktext.'</a>'
1.787     bisitz    776:          .'</span>';
1.74      www       777: }
1.42      matthew   778: 
1.653     raeburn   779: sub selectauthor_link {
                    780:    my ($form,$udom)=@_;
                    781:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    782:           &mt('Select Author').'</a>';
                    783: }
                    784: 
1.876     raeburn   785: sub selectuser_link {
1.881     raeburn   786:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   787:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   788:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   789:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   790:            ');">'.$linktext.'</a>';
1.876     raeburn   791: }
                    792: 
1.273     raeburn   793: sub check_uncheck_jscript {
                    794:     my $jscript = <<"ENDSCRT";
                    795: function checkAll(field) {
                    796:     if (field.length > 0) {
                    797:         for (i = 0; i < field.length; i++) {
                    798:             field[i].checked = true ;
                    799:         }
                    800:     } else {
                    801:         field.checked = true
                    802:     }
                    803: }
                    804:  
                    805: function uncheckAll(field) {
                    806:     if (field.length > 0) {
                    807:         for (i = 0; i < field.length; i++) {
                    808:             field[i].checked = false ;
1.543     albertel  809:         }
                    810:     } else {
1.273     raeburn   811:         field.checked = false ;
                    812:     }
                    813: }
                    814: ENDSCRT
                    815:     return $jscript;
                    816: }
                    817: 
1.656     www       818: sub select_timezone {
1.659     raeburn   819:    my ($name,$selected,$onchange,$includeempty)=@_;
                    820:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    821:    if ($includeempty) {
                    822:        $output .= '<option value=""';
                    823:        if (($selected eq '') || ($selected eq 'local')) {
                    824:            $output .= ' selected="selected" ';
                    825:        }
                    826:        $output .= '> </option>';
                    827:    }
1.657     raeburn   828:    my @timezones = DateTime::TimeZone->all_names;
                    829:    foreach my $tzone (@timezones) {
                    830:        $output.= '<option value="'.$tzone.'"';
                    831:        if ($tzone eq $selected) {
                    832:            $output.=' selected="selected"';
                    833:        }
                    834:        $output.=">$tzone</option>\n";
1.656     www       835:    }
                    836:    $output.="</select>";
                    837:    return $output;
                    838: }
1.273     raeburn   839: 
1.687     raeburn   840: sub select_datelocale {
                    841:     my ($name,$selected,$onchange,$includeempty)=@_;
                    842:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    843:     if ($includeempty) {
                    844:         $output .= '<option value=""';
                    845:         if ($selected eq '') {
                    846:             $output .= ' selected="selected" ';
                    847:         }
                    848:         $output .= '> </option>';
                    849:     }
                    850:     my (@possibles,%locale_names);
                    851:     my @locales = DateTime::Locale::Catalog::Locales;
                    852:     foreach my $locale (@locales) {
                    853:         if (ref($locale) eq 'HASH') {
                    854:             my $id = $locale->{'id'};
                    855:             if ($id ne '') {
                    856:                 my $en_terr = $locale->{'en_territory'};
                    857:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   858:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   859:                 if (grep(/^en$/,@languages) || !@languages) {
                    860:                     if ($en_terr ne '') {
                    861:                         $locale_names{$id} = '('.$en_terr.')';
                    862:                     } elsif ($native_terr ne '') {
                    863:                         $locale_names{$id} = $native_terr;
                    864:                     }
                    865:                 } else {
                    866:                     if ($native_terr ne '') {
                    867:                         $locale_names{$id} = $native_terr.' ';
                    868:                     } elsif ($en_terr ne '') {
                    869:                         $locale_names{$id} = '('.$en_terr.')';
                    870:                     }
                    871:                 }
                    872:                 push (@possibles,$id);
                    873:             }
                    874:         }
                    875:     }
                    876:     foreach my $item (sort(@possibles)) {
                    877:         $output.= '<option value="'.$item.'"';
                    878:         if ($item eq $selected) {
                    879:             $output.=' selected="selected"';
                    880:         }
                    881:         $output.=">$item";
                    882:         if ($locale_names{$item} ne '') {
                    883:             $output.="  $locale_names{$item}</option>\n";
                    884:         }
                    885:         $output.="</option>\n";
                    886:     }
                    887:     $output.="</select>";
                    888:     return $output;
                    889: }
                    890: 
1.792     raeburn   891: sub select_language {
                    892:     my ($name,$selected,$includeempty) = @_;
                    893:     my %langchoices;
                    894:     if ($includeempty) {
                    895:         %langchoices = ('' => 'No language preference');
                    896:     }
                    897:     foreach my $id (&languageids()) {
                    898:         my $code = &supportedlanguagecode($id);
                    899:         if ($code) {
                    900:             $langchoices{$code} = &plainlanguagedescription($id);
                    901:         }
                    902:     }
1.970     raeburn   903:     return &select_form($selected,$name,\%langchoices);
1.792     raeburn   904: }
                    905: 
1.42      matthew   906: =pod
1.36      matthew   907: 
1.648     raeburn   908: =item * &linked_select_forms(...)
1.36      matthew   909: 
                    910: linked_select_forms returns a string containing a <script></script> block
                    911: and html for two <select> menus.  The select menus will be linked in that
                    912: changing the value of the first menu will result in new values being placed
                    913: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn   914: order unless a defined order is provided.
1.36      matthew   915: 
                    916: linked_select_forms takes the following ordered inputs:
                    917: 
                    918: =over 4
                    919: 
1.112     bowersj2  920: =item * $formname, the name of the <form> tag
1.36      matthew   921: 
1.112     bowersj2  922: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   923: 
1.112     bowersj2  924: =item * $firstdefault, the default value for the first menu
1.36      matthew   925: 
1.112     bowersj2  926: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   927: 
1.112     bowersj2  928: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   929: 
1.112     bowersj2  930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   931: 
1.609     raeburn   932: =item * $menuorder, the order of values in the first menu
                    933: 
1.41      ng        934: =back 
                    935: 
1.36      matthew   936: Below is an example of such a hash.  Only the 'text', 'default', and 
                    937: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    938: values for the first select menu.  The text that coincides with the 
1.41      ng        939: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   940: and text for the second menu are given in the hash pointed to by 
                    941: $menu{$choice1}->{'select2'}.  
                    942: 
1.112     bowersj2  943:  my %menu = ( A1 => { text =>"Choice A1" ,
                    944:                        default => "B3",
                    945:                        select2 => { 
                    946:                            B1 => "Choice B1",
                    947:                            B2 => "Choice B2",
                    948:                            B3 => "Choice B3",
                    949:                            B4 => "Choice B4"
1.609     raeburn   950:                            },
                    951:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2  952:                    },
                    953:                A2 => { text =>"Choice A2" ,
                    954:                        default => "C2",
                    955:                        select2 => { 
                    956:                            C1 => "Choice C1",
                    957:                            C2 => "Choice C2",
                    958:                            C3 => "Choice C3"
1.609     raeburn   959:                            },
                    960:                        order => ['C2','C1','C3'],
1.112     bowersj2  961:                    },
                    962:                A3 => { text =>"Choice A3" ,
                    963:                        default => "D6",
                    964:                        select2 => { 
                    965:                            D1 => "Choice D1",
                    966:                            D2 => "Choice D2",
                    967:                            D3 => "Choice D3",
                    968:                            D4 => "Choice D4",
                    969:                            D5 => "Choice D5",
                    970:                            D6 => "Choice D6",
                    971:                            D7 => "Choice D7"
1.609     raeburn   972:                            },
                    973:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2  974:                    }
                    975:                );
1.36      matthew   976: 
                    977: =cut
                    978: 
                    979: sub linked_select_forms {
                    980:     my ($formname,
                    981:         $middletext,
                    982:         $firstdefault,
                    983:         $firstselectname,
                    984:         $secondselectname, 
1.609     raeburn   985:         $hashref,
                    986:         $menuorder,
1.36      matthew   987:         ) = @_;
                    988:     my $second = "document.$formname.$secondselectname";
                    989:     my $first = "document.$formname.$firstselectname";
                    990:     # output the javascript to do the changing
                    991:     my $result = '';
1.776     bisitz    992:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz    993:     $result.="// <![CDATA[\n";
1.36      matthew   994:     $result.="var select2data = new Object();\n";
                    995:     $" = '","';
                    996:     my $debug = '';
                    997:     foreach my $s1 (sort(keys(%$hashref))) {
                    998:         $result.="select2data.d_$s1 = new Object();\n";        
                    999:         $result.="select2data.d_$s1.def = new String('".
                   1000:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn  1001:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew  1002:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1003:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1004:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1005:         }
1.36      matthew  1006:         $result.="\"@s2values\");\n";
                   1007:         $result.="select2data.d_$s1.texts = new Array(";        
                   1008:         my @s2texts;
                   1009:         foreach my $value (@s2values) {
                   1010:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                   1011:         }
                   1012:         $result.="\"@s2texts\");\n";
                   1013:     }
                   1014:     $"=' ';
                   1015:     $result.= <<"END";
                   1016: 
                   1017: function select1_changed() {
                   1018:     // Determine new choice
                   1019:     var newvalue = "d_" + $first.value;
                   1020:     // update select2
                   1021:     var values     = select2data[newvalue].values;
                   1022:     var texts      = select2data[newvalue].texts;
                   1023:     var select2def = select2data[newvalue].def;
                   1024:     var i;
                   1025:     // out with the old
                   1026:     for (i = 0; i < $second.options.length; i++) {
                   1027:         $second.options[i] = null;
                   1028:     }
                   1029:     // in with the nuclear
                   1030:     for (i=0;i<values.length; i++) {
                   1031:         $second.options[i] = new Option(values[i]);
1.143     matthew  1032:         $second.options[i].value = values[i];
1.36      matthew  1033:         $second.options[i].text = texts[i];
                   1034:         if (values[i] == select2def) {
                   1035:             $second.options[i].selected = true;
                   1036:         }
                   1037:     }
                   1038: }
1.824     bisitz   1039: // ]]>
1.36      matthew  1040: </script>
                   1041: END
                   1042:     # output the initial values for the selection lists
                   1043:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn  1044:     my @order = sort(keys(%{$hashref}));
                   1045:     if (ref($menuorder) eq 'ARRAY') {
                   1046:         @order = @{$menuorder};
                   1047:     }
                   1048:     foreach my $value (@order) {
1.36      matthew  1049:         $result.="    <option value=\"$value\" ";
1.253     albertel 1050:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1051:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1052:     }
                   1053:     $result .= "</select>\n";
                   1054:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1055:     $result .= $middletext;
                   1056:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                   1057:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1058:     
                   1059:     my @secondorder = sort(keys(%select2));
                   1060:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1061:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1062:     }
                   1063:     foreach my $value (@secondorder) {
1.36      matthew  1064:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1065:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1066:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1067:     }
                   1068:     $result .= "</select>\n";
                   1069:     #    return $debug;
                   1070:     return $result;
                   1071: }   #  end of sub linked_select_forms {
                   1072: 
1.45      matthew  1073: =pod
1.44      bowersj2 1074: 
1.973     raeburn  1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44      bowersj2 1076: 
1.112     bowersj2 1077: Returns a string corresponding to an HTML link to the given help
                   1078: $topic, where $topic corresponds to the name of a .tex file in
                   1079: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1080: spaces. 
                   1081: 
                   1082: $text will optionally be linked to the same topic, allowing you to
                   1083: link text in addition to the graphic. If you do not want to link
                   1084: text, but wish to specify one of the later parameters, pass an
                   1085: empty string. 
                   1086: 
                   1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1088: the link will not open a new window. If false, the link will open
                   1089: a new window using Javascript. (Default is false.) 
                   1090: 
                   1091: $width and $height are optional numerical parameters that will
                   1092: override the width and height of the popped up window, which may
1.973     raeburn  1093: be useful for certain help topics with big pictures included.
                   1094: 
                   1095: $imgid is the id of the img tag used for the help icon. This may be
                   1096: used in a javascript call to switch the image src.  See 
                   1097: lonhtmlcommon::htmlareaselectactive() for an example.
1.44      bowersj2 1098: 
                   1099: =cut
                   1100: 
                   1101: sub help_open_topic {
1.973     raeburn  1102:     my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48      bowersj2 1103:     $text = "" if (not defined $text);
1.44      bowersj2 1104:     $stayOnPage = 0 if (not defined $stayOnPage);
                   1105:     $width = 350 if (not defined $width);
                   1106:     $height = 400 if (not defined $height);
                   1107:     my $filename = $topic;
                   1108:     $filename =~ s/ /_/g;
                   1109: 
1.48      bowersj2 1110:     my $template = "";
                   1111:     my $link;
1.572     banghart 1112:     
1.159     www      1113:     $topic=~s/\W/\_/g;
1.44      bowersj2 1114: 
1.572     banghart 1115:     if (!$stayOnPage) {
1.72      bowersj2 1116: 	$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 1117:     } else {
1.48      bowersj2 1118: 	$link = "/adm/help/${filename}.hlp";
                   1119:     }
                   1120: 
                   1121:     # Add the text
1.755     neumanie 1122:     if ($text ne "") {	
1.763     bisitz   1123: 	$template.='<span class="LC_help_open_topic">'
                   1124:                   .'<a target="_top" href="'.$link.'">'
                   1125:                   .$text.'</a>';
1.48      bowersj2 1126:     }
                   1127: 
1.763     bisitz   1128:     # (Always) Add the graphic
1.179     matthew  1129:     my $title = &mt('Online Help');
1.667     raeburn  1130:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973     raeburn  1131:     if ($imgid ne '') {
                   1132:         $imgid = ' id="'.$imgid.'"';
                   1133:     }
1.763     bisitz   1134:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1135:               .'<img src="'.$helpicon.'" border="0"'
                   1136:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973     raeburn  1137:               .' title="'.$title.'" style="vertical-align:middle;"'.$imgid 
1.763     bisitz   1138:               .' /></a>';
                   1139:     if ($text ne "") {	
                   1140:         $template.='</span>';
                   1141:     }
1.44      bowersj2 1142:     return $template;
                   1143: 
1.106     bowersj2 1144: }
                   1145: 
                   1146: # This is a quicky function for Latex cheatsheet editing, since it 
                   1147: # appears in at least four places
                   1148: sub helpLatexCheatsheet {
1.732     raeburn  1149:     my ($topic,$text,$not_author) = @_;
                   1150:     my $out;
1.106     bowersj2 1151:     my $addOther = '';
1.732     raeburn  1152:     if ($topic) {
1.763     bisitz   1153: 	$addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
                   1154: 							       undef, undef, 600).
                   1155: 								   '</span> ';
                   1156:     }
                   1157:     $out = '<span>' # Start cheatsheet
                   1158: 	  .$addOther
                   1159:           .'<span>'
                   1160: 	  .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
                   1161: 					       undef,undef,600)
                   1162: 	  .'</span> <span>'
                   1163: 	  .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
                   1164: 					       undef,undef,600)
                   1165: 	  .'</span>';
1.732     raeburn  1166:     unless ($not_author) {
1.763     bisitz   1167:         $out .= ' <span>'
                   1168: 	       .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
                   1169: 	                                            undef,undef,600)
                   1170: 	       .'</span>';
1.732     raeburn  1171:     }
1.763     bisitz   1172:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1173:     return $out;
1.172     www      1174: }
                   1175: 
1.430     albertel 1176: sub general_help {
                   1177:     my $helptopic='Student_Intro';
                   1178:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1179: 	$helptopic='Authoring_Intro';
1.907     raeburn  1180:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1181: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1182:     } elsif ($env{'request.role'}=~/^dc/) {
                   1183:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1184:     }
                   1185:     return $helptopic;
                   1186: }
                   1187: 
                   1188: sub update_help_link {
                   1189:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1190:     my $origurl = $ENV{'REQUEST_URI'};
                   1191:     $origurl=~s|^/~|/priv/|;
                   1192:     my $timestamp = time;
                   1193:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1194:         $$datum = &escape($$datum);
                   1195:     }
                   1196: 
                   1197:     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";
                   1198:     my $output .= <<"ENDOUTPUT";
                   1199: <script type="text/javascript">
1.824     bisitz   1200: // <![CDATA[
1.430     albertel 1201: banner_link = '$banner_link';
1.824     bisitz   1202: // ]]>
1.430     albertel 1203: </script>
                   1204: ENDOUTPUT
                   1205:     return $output;
                   1206: }
                   1207: 
                   1208: # now just updates the help link and generates a blue icon
1.193     raeburn  1209: sub help_open_menu {
1.430     albertel 1210:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1211: 	= @_;    
1.949     droeschl 1212:     $stayOnPage = 1;
1.430     albertel 1213:     my $output;
                   1214:     if ($component_help) {
                   1215: 	if (!$text) {
                   1216: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1217: 				       $width,$height);
                   1218: 	} else {
                   1219: 	    my $help_text;
                   1220: 	    $help_text=&unescape($topic);
                   1221: 	    $output='<table><tr><td>'.
                   1222: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1223: 				 $width,$height).'</td></tr></table>';
                   1224: 	}
                   1225:     }
                   1226:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1227:     return $output.$banner_link;
                   1228: }
                   1229: 
                   1230: sub top_nav_help {
                   1231:     my ($text) = @_;
1.436     albertel 1232:     $text = &mt($text);
1.949     droeschl 1233:     my $stay_on_page = 1;
                   1234: 
1.572     banghart 1235:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1236: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1237:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1238: 
1.201     raeburn  1239:     my $title = &mt('Get help');
1.436     albertel 1240: 
                   1241:     return <<"END";
                   1242: $banner_link
                   1243:  <a href="$link" title="$title">$text</a>
                   1244: END
                   1245: }
                   1246: 
                   1247: sub help_menu_js {
                   1248:     my ($text) = @_;
1.949     droeschl 1249:     my $stayOnPage = 1;
1.436     albertel 1250:     my $width = 620;
                   1251:     my $height = 600;
1.430     albertel 1252:     my $helptopic=&general_help();
                   1253:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1254:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1255:     my $start_page =
                   1256:         &Apache::loncommon::start_page('Help Menu', undef,
                   1257: 				       {'frameset'    => 1,
                   1258: 					'js_ready'    => 1,
                   1259: 					'add_entries' => {
                   1260: 					    'border' => '0',
1.579     raeburn  1261: 					    'rows'   => "110,*",},});
1.331     albertel 1262:     my $end_page =
                   1263:         &Apache::loncommon::end_page({'frameset' => 1,
                   1264: 				      'js_ready' => 1,});
                   1265: 
1.436     albertel 1266:     my $template .= <<"ENDTEMPLATE";
                   1267: <script type="text/javascript">
1.877     bisitz   1268: // <![CDATA[
1.253     albertel 1269: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1270: var banner_link = '';
1.243     raeburn  1271: function helpMenu(target) {
                   1272:     var caller = this;
                   1273:     if (target == 'open') {
                   1274:         var newWindow = null;
                   1275:         try {
1.262     albertel 1276:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1277:         }
                   1278:         catch(error) {
                   1279:             writeHelp(caller);
                   1280:             return;
                   1281:         }
                   1282:         if (newWindow) {
                   1283:             caller = newWindow;
                   1284:         }
1.193     raeburn  1285:     }
1.243     raeburn  1286:     writeHelp(caller);
                   1287:     return;
                   1288: }
                   1289: function writeHelp(caller) {
1.430     albertel 1290:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1291:     caller.document.close()
                   1292:     caller.focus()
1.193     raeburn  1293: }
1.877     bisitz   1294: // END LON-CAPA Internal -->
1.253     albertel 1295: // ]]>
1.436     albertel 1296: </script>
1.193     raeburn  1297: ENDTEMPLATE
                   1298:     return $template;
                   1299: }
                   1300: 
1.172     www      1301: sub help_open_bug {
                   1302:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1303:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1304:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1305:     $text = "" if (not defined $text);
                   1306: 	$stayOnPage=1;
1.184     albertel 1307:     $width = 600 if (not defined $width);
                   1308:     $height = 600 if (not defined $height);
1.172     www      1309: 
                   1310:     $topic=~s/\W+/\+/g;
                   1311:     my $link='';
                   1312:     my $template='';
1.379     albertel 1313:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1314: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1315:     if (!$stayOnPage)
                   1316:     {
                   1317: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1318:     }
                   1319:     else
                   1320:     {
                   1321: 	$link = $url;
                   1322:     }
                   1323:     # Add the text
                   1324:     if ($text ne "")
                   1325:     {
                   1326: 	$template .= 
                   1327:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1328:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1329:     }
                   1330: 
                   1331:     # Add the graphic
1.179     matthew  1332:     my $title = &mt('Report a Bug');
1.215     albertel 1333:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1334:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1335:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1336: ENDTEMPLATE
                   1337:     if ($text ne '') { $template.='</td></tr></table>' };
                   1338:     return $template;
                   1339: 
                   1340: }
                   1341: 
                   1342: sub help_open_faq {
                   1343:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1344:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1345:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1346:     $text = "" if (not defined $text);
                   1347: 	$stayOnPage=1;
                   1348:     $width = 350 if (not defined $width);
                   1349:     $height = 400 if (not defined $height);
                   1350: 
                   1351:     $topic=~s/\W+/\+/g;
                   1352:     my $link='';
                   1353:     my $template='';
                   1354:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1355:     if (!$stayOnPage)
                   1356:     {
                   1357: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1358:     }
                   1359:     else
                   1360:     {
                   1361: 	$link = $url;
                   1362:     }
                   1363: 
                   1364:     # Add the text
                   1365:     if ($text ne "")
                   1366:     {
                   1367: 	$template .= 
1.173     www      1368:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1369:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1370:     }
                   1371: 
                   1372:     # Add the graphic
1.179     matthew  1373:     my $title = &mt('View the FAQ');
1.215     albertel 1374:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1375:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1376:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1377: ENDTEMPLATE
                   1378:     if ($text ne '') { $template.='</td></tr></table>' };
                   1379:     return $template;
                   1380: 
1.44      bowersj2 1381: }
1.37      matthew  1382: 
1.180     matthew  1383: ###############################################################
                   1384: ###############################################################
                   1385: 
1.45      matthew  1386: =pod
                   1387: 
1.648     raeburn  1388: =item * &change_content_javascript():
1.256     matthew  1389: 
                   1390: This and the next function allow you to create small sections of an
                   1391: otherwise static HTML page that you can update on the fly with
                   1392: Javascript, even in Netscape 4.
                   1393: 
                   1394: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1395: must be written to the HTML page once. It will prove the Javascript
                   1396: function "change(name, content)". Calling the change function with the
                   1397: name of the section 
                   1398: you want to update, matching the name passed to C<changable_area>, and
                   1399: the new content you want to put in there, will put the content into
                   1400: that area.
                   1401: 
                   1402: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1403: to contain room for the original contents. You need to "make space"
                   1404: for whatever changes you wish to make, and be B<sure> to check your
                   1405: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1406: it's adequate for updating a one-line status display, but little more.
                   1407: This script will set the space to 100% width, so you only need to
                   1408: worry about height in Netscape 4.
                   1409: 
                   1410: Modern browsers are much less limiting, and if you can commit to the
                   1411: user not using Netscape 4, this feature may be used freely with
                   1412: pretty much any HTML.
                   1413: 
                   1414: =cut
                   1415: 
                   1416: sub change_content_javascript {
                   1417:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1418:     if ($env{'browser.type'} eq 'netscape' &&
                   1419: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1420: 	return (<<NETSCAPE4);
                   1421: 	function change(name, content) {
                   1422: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1423: 	    doc.open();
                   1424: 	    doc.write(content);
                   1425: 	    doc.close();
                   1426: 	}
                   1427: NETSCAPE4
                   1428:     } else {
                   1429: 	# Otherwise, we need to use semi-standards-compliant code
                   1430: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1431: 	# is really scary, and every useful browser supports it
                   1432: 	return (<<DOMBASED);
                   1433: 	function change(name, content) {
                   1434: 	    element = document.getElementById(name);
                   1435: 	    element.innerHTML = content;
                   1436: 	}
                   1437: DOMBASED
                   1438:     }
                   1439: }
                   1440: 
                   1441: =pod
                   1442: 
1.648     raeburn  1443: =item * &changable_area($name,$origContent):
1.256     matthew  1444: 
                   1445: This provides a "changable area" that can be modified on the fly via
                   1446: the Javascript code provided in C<change_content_javascript>. $name is
                   1447: the name you will use to reference the area later; do not repeat the
                   1448: same name on a given HTML page more then once. $origContent is what
                   1449: the area will originally contain, which can be left blank.
                   1450: 
                   1451: =cut
                   1452: 
                   1453: sub changable_area {
                   1454:     my ($name, $origContent) = @_;
                   1455: 
1.258     albertel 1456:     if ($env{'browser.type'} eq 'netscape' &&
                   1457: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1458: 	# If this is netscape 4, we need to use the Layer tag
                   1459: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1460:     } else {
                   1461: 	return "<span id='$name'>$origContent</span>";
                   1462:     }
                   1463: }
                   1464: 
                   1465: =pod
                   1466: 
1.648     raeburn  1467: =item * &viewport_geometry_js 
1.590     raeburn  1468: 
                   1469: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1470: 
                   1471: =cut
                   1472: 
                   1473: 
                   1474: sub viewport_geometry_js { 
                   1475:     return <<"GEOMETRY";
                   1476: var Geometry = {};
                   1477: function init_geometry() {
                   1478:     if (Geometry.init) { return };
                   1479:     Geometry.init=1;
                   1480:     if (window.innerHeight) {
                   1481:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1482:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1483:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1484:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1485:     }
                   1486:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1487:         Geometry.getViewportHeight =
                   1488:             function() { return document.documentElement.clientHeight; };
                   1489:         Geometry.getViewportWidth =
                   1490:             function() { return document.documentElement.clientWidth; };
                   1491: 
                   1492:         Geometry.getHorizontalScroll =
                   1493:             function() { return document.documentElement.scrollLeft; };
                   1494:         Geometry.getVerticalScroll =
                   1495:             function() { return document.documentElement.scrollTop; };
                   1496:     }
                   1497:     else if (document.body.clientHeight) {
                   1498:         Geometry.getViewportHeight =
                   1499:             function() { return document.body.clientHeight; };
                   1500:         Geometry.getViewportWidth =
                   1501:             function() { return document.body.clientWidth; };
                   1502:         Geometry.getHorizontalScroll =
                   1503:             function() { return document.body.scrollLeft; };
                   1504:         Geometry.getVerticalScroll =
                   1505:             function() { return document.body.scrollTop; };
                   1506:     }
                   1507: }
                   1508: 
                   1509: GEOMETRY
                   1510: }
                   1511: 
                   1512: =pod
                   1513: 
1.648     raeburn  1514: =item * &viewport_size_js()
1.590     raeburn  1515: 
                   1516: 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. 
                   1517: 
                   1518: =cut
                   1519: 
                   1520: sub viewport_size_js {
                   1521:     my $geometry = &viewport_geometry_js();
                   1522:     return <<"DIMS";
                   1523: 
                   1524: $geometry
                   1525: 
                   1526: function getViewportDims(width,height) {
                   1527:     init_geometry();
                   1528:     width.value = Geometry.getViewportWidth();
                   1529:     height.value = Geometry.getViewportHeight();
                   1530:     return;
                   1531: }
                   1532: 
                   1533: DIMS
                   1534: }
                   1535: 
                   1536: =pod
                   1537: 
1.648     raeburn  1538: =item * &resize_textarea_js()
1.565     albertel 1539: 
                   1540: emits the needed javascript to resize a textarea to be as big as possible
                   1541: 
                   1542: creates a function resize_textrea that takes two IDs first should be
                   1543: the id of the element to resize, second should be the id of a div that
                   1544: surrounds everything that comes after the textarea, this routine needs
                   1545: to be attached to the <body> for the onload and onresize events.
                   1546: 
1.648     raeburn  1547: =back
1.565     albertel 1548: 
                   1549: =cut
                   1550: 
                   1551: sub resize_textarea_js {
1.590     raeburn  1552:     my $geometry = &viewport_geometry_js();
1.565     albertel 1553:     return <<"RESIZE";
                   1554:     <script type="text/javascript">
1.824     bisitz   1555: // <![CDATA[
1.590     raeburn  1556: $geometry
1.565     albertel 1557: 
1.588     albertel 1558: function getX(element) {
                   1559:     var x = 0;
                   1560:     while (element) {
                   1561: 	x += element.offsetLeft;
                   1562: 	element = element.offsetParent;
                   1563:     }
                   1564:     return x;
                   1565: }
                   1566: function getY(element) {
                   1567:     var y = 0;
                   1568:     while (element) {
                   1569: 	y += element.offsetTop;
                   1570: 	element = element.offsetParent;
                   1571:     }
                   1572:     return y;
                   1573: }
                   1574: 
                   1575: 
1.565     albertel 1576: function resize_textarea(textarea_id,bottom_id) {
                   1577:     init_geometry();
                   1578:     var textarea        = document.getElementById(textarea_id);
                   1579:     //alert(textarea);
                   1580: 
1.588     albertel 1581:     var textarea_top    = getY(textarea);
1.565     albertel 1582:     var textarea_height = textarea.offsetHeight;
                   1583:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1584:     var bottom_top      = getY(bottom);
1.565     albertel 1585:     var bottom_height   = bottom.offsetHeight;
                   1586:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1587:     var fudge           = 23;
1.565     albertel 1588:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1589:     if (new_height < 300) {
                   1590: 	new_height = 300;
                   1591:     }
                   1592:     textarea.style.height=new_height+'px';
                   1593: }
1.824     bisitz   1594: // ]]>
1.565     albertel 1595: </script>
                   1596: RESIZE
                   1597: 
                   1598: }
                   1599: 
                   1600: =pod
                   1601: 
1.256     matthew  1602: =head1 Excel and CSV file utility routines
                   1603: 
                   1604: =over 4
                   1605: 
                   1606: =cut
                   1607: 
                   1608: ###############################################################
                   1609: ###############################################################
                   1610: 
                   1611: =pod
                   1612: 
1.648     raeburn  1613: =item * &csv_translate($text) 
1.37      matthew  1614: 
1.185     www      1615: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1616: format.
                   1617: 
                   1618: =cut
                   1619: 
1.180     matthew  1620: ###############################################################
                   1621: ###############################################################
1.37      matthew  1622: sub csv_translate {
                   1623:     my $text = shift;
                   1624:     $text =~ s/\"/\"\"/g;
1.209     albertel 1625:     $text =~ s/\n/ /g;
1.37      matthew  1626:     return $text;
                   1627: }
1.180     matthew  1628: 
                   1629: ###############################################################
                   1630: ###############################################################
                   1631: 
                   1632: =pod
                   1633: 
1.648     raeburn  1634: =item * &define_excel_formats()
1.180     matthew  1635: 
                   1636: Define some commonly used Excel cell formats.
                   1637: 
                   1638: Currently supported formats:
                   1639: 
                   1640: =over 4
                   1641: 
                   1642: =item header
                   1643: 
                   1644: =item bold
                   1645: 
                   1646: =item h1
                   1647: 
                   1648: =item h2
                   1649: 
                   1650: =item h3
                   1651: 
1.256     matthew  1652: =item h4
                   1653: 
                   1654: =item i
                   1655: 
1.180     matthew  1656: =item date
                   1657: 
                   1658: =back
                   1659: 
                   1660: Inputs: $workbook
                   1661: 
                   1662: Returns: $format, a hash reference.
                   1663: 
                   1664: =cut
                   1665: 
                   1666: ###############################################################
                   1667: ###############################################################
                   1668: sub define_excel_formats {
                   1669:     my ($workbook) = @_;
                   1670:     my $format;
                   1671:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1672:                                                 bottom    => 1,
                   1673:                                                 align     => 'center');
                   1674:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1675:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1676:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1677:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1678:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1679:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1680:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1681:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1682:     return $format;
                   1683: }
                   1684: 
                   1685: ###############################################################
                   1686: ###############################################################
1.113     bowersj2 1687: 
                   1688: =pod
                   1689: 
1.648     raeburn  1690: =item * &create_workbook()
1.255     matthew  1691: 
                   1692: Create an Excel worksheet.  If it fails, output message on the
                   1693: request object and return undefs.
                   1694: 
                   1695: Inputs: Apache request object
                   1696: 
                   1697: Returns (undef) on failure, 
                   1698:     Excel worksheet object, scalar with filename, and formats 
                   1699:     from &Apache::loncommon::define_excel_formats on success
                   1700: 
                   1701: =cut
                   1702: 
                   1703: ###############################################################
                   1704: ###############################################################
                   1705: sub create_workbook {
                   1706:     my ($r) = @_;
                   1707:         #
                   1708:     # Create the excel spreadsheet
                   1709:     my $filename = '/prtspool/'.
1.258     albertel 1710:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1711:         time.'_'.rand(1000000000).'.xls';
                   1712:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1713:     if (! defined($workbook)) {
                   1714:         $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928     bisitz   1715:         $r->print(
                   1716:             '<p class="LC_error">'
                   1717:            .&mt('Problems occurred in creating the new Excel file.')
                   1718:            .' '.&mt('This error has been logged.')
                   1719:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   1720:            .'</p>'
                   1721:         );
1.255     matthew  1722:         return (undef);
                   1723:     }
                   1724:     #
                   1725:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1726:     #
                   1727:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1728:     return ($workbook,$filename,$format);
                   1729: }
                   1730: 
                   1731: ###############################################################
                   1732: ###############################################################
                   1733: 
                   1734: =pod
                   1735: 
1.648     raeburn  1736: =item * &create_text_file()
1.113     bowersj2 1737: 
1.542     raeburn  1738: Create a file to write to and eventually make available to the user.
1.256     matthew  1739: If file creation fails, outputs an error message on the request object and 
                   1740: return undefs.
1.113     bowersj2 1741: 
1.256     matthew  1742: Inputs: Apache request object, and file suffix
1.113     bowersj2 1743: 
1.256     matthew  1744: Returns (undef) on failure, 
                   1745:     Filehandle and filename on success.
1.113     bowersj2 1746: 
                   1747: =cut
                   1748: 
1.256     matthew  1749: ###############################################################
                   1750: ###############################################################
                   1751: sub create_text_file {
                   1752:     my ($r,$suffix) = @_;
                   1753:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1754:     my $fh;
                   1755:     my $filename = '/prtspool/'.
1.258     albertel 1756:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1757:         time.'_'.rand(1000000000).'.'.$suffix;
                   1758:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1759:     if (! defined($fh)) {
                   1760:         $r->log_error("Couldn't open $filename for output $!");
1.928     bisitz   1761:         $r->print(
                   1762:             '<p class="LC_error">'
                   1763:            .&mt('Problems occurred in creating the output file.')
                   1764:            .' '.&mt('This error has been logged.')
                   1765:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   1766:            .'</p>'
                   1767:         );
1.113     bowersj2 1768:     }
1.256     matthew  1769:     return ($fh,$filename)
1.113     bowersj2 1770: }
                   1771: 
                   1772: 
1.256     matthew  1773: =pod 
1.113     bowersj2 1774: 
                   1775: =back
                   1776: 
                   1777: =cut
1.37      matthew  1778: 
                   1779: ###############################################################
1.33      matthew  1780: ##        Home server <option> list generating code          ##
                   1781: ###############################################################
1.35      matthew  1782: 
1.169     www      1783: # ------------------------------------------
                   1784: 
                   1785: sub domain_select {
                   1786:     my ($name,$value,$multiple)=@_;
                   1787:     my %domains=map { 
1.514     albertel 1788: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1789:     } &Apache::lonnet::all_domains();
1.169     www      1790:     if ($multiple) {
                   1791: 	$domains{''}=&mt('Any domain');
1.550     albertel 1792: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1793: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1794:     } else {
1.550     albertel 1795: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970     raeburn  1796: 	return &select_form($name,$value,\%domains);
1.169     www      1797:     }
                   1798: }
                   1799: 
1.282     albertel 1800: #-------------------------------------------
                   1801: 
                   1802: =pod
                   1803: 
1.519     raeburn  1804: =head1 Routines for form select boxes
                   1805: 
                   1806: =over 4
                   1807: 
1.648     raeburn  1808: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1809: 
                   1810: Returns a string containing a <select> element int multiple mode
                   1811: 
                   1812: 
                   1813: Args:
                   1814:   $name - name of the <select> element
1.506     raeburn  1815:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1816:   $size - number of rows long the select element is
1.283     albertel 1817:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1818:           (shown text should already have been &mt())
1.506     raeburn  1819:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1820: 
1.282     albertel 1821: =cut
                   1822: 
                   1823: #-------------------------------------------
1.169     www      1824: sub multiple_select_form {
1.284     albertel 1825:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1826:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1827:     my $output='';
1.191     matthew  1828:     if (! defined($size)) {
                   1829:         $size = 4;
1.283     albertel 1830:         if (scalar(keys(%$hash))<4) {
                   1831:             $size = scalar(keys(%$hash));
1.191     matthew  1832:         }
                   1833:     }
1.734     bisitz   1834:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1835:     my @order;
1.506     raeburn  1836:     if (ref($order) eq 'ARRAY')  {
                   1837:         @order = @{$order};
                   1838:     } else {
                   1839:         @order = sort(keys(%$hash));
1.501     banghart 1840:     }
                   1841:     if (exists($$hash{'select_form_order'})) {
                   1842:         @order = @{$$hash{'select_form_order'}};
                   1843:     }
                   1844:         
1.284     albertel 1845:     foreach my $key (@order) {
1.356     albertel 1846:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1847:         $output.='selected="selected" ' if ($selected{$key});
                   1848:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1849:     }
                   1850:     $output.="</select>\n";
                   1851:     return $output;
                   1852: }
                   1853: 
1.88      www      1854: #-------------------------------------------
                   1855: 
                   1856: =pod
                   1857: 
1.970     raeburn  1858: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88      www      1859: 
                   1860: Returns a string containing a <select name='$name' size='1'> form to 
1.970     raeburn  1861: allow a user to select options from a ref to a hash containing:
                   1862: option_name => displayed text. An optional $onchange can include
                   1863: a javascript onchange item, e.g., onchange="this.form.submit();"  
                   1864: 
1.88      www      1865: See lonrights.pm for an example invocation and use.
                   1866: 
                   1867: =cut
                   1868: 
                   1869: #-------------------------------------------
                   1870: sub select_form {
1.970     raeburn  1871:     my ($def,$name,$hashref,$onchange) = @_;
                   1872:     return unless (ref($hashref) eq 'HASH');
                   1873:     if ($onchange) {
                   1874:         $onchange = ' onchange="'.$onchange.'"';
                   1875:     }
                   1876:     my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128     albertel 1877:     my @keys;
1.970     raeburn  1878:     if (exists($hashref->{'select_form_order'})) {
                   1879: 	@keys=@{$hashref->{'select_form_order'}};
1.128     albertel 1880:     } else {
1.970     raeburn  1881: 	@keys=sort(keys(%{$hashref}));
1.128     albertel 1882:     }
1.356     albertel 1883:     foreach my $key (@keys) {
                   1884:         $selectform.=
                   1885: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1886:             ($key eq $def ? 'selected="selected" ' : '').
1.970     raeburn  1887:                 ">".$hashref->{$key}."</option>\n";
1.88      www      1888:     }
                   1889:     $selectform.="</select>";
                   1890:     return $selectform;
                   1891: }
                   1892: 
1.475     www      1893: # For display filters
                   1894: 
                   1895: sub display_filter {
                   1896:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1897:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1898:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1899: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1900: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1901: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1902:            &mt('Filter [_1]',
1.477     www      1903: 	   &select_form($env{'form.displayfilter'},
                   1904: 			'displayfilter',
1.970     raeburn  1905: 			{'currentfolder' => 'Current folder/page',
1.477     www      1906: 			 'containing' => 'Containing phrase',
1.970     raeburn  1907: 			 'none' => 'None'})).
1.714     bisitz   1908: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1909: }
                   1910: 
1.167     www      1911: sub gradeleveldescription {
                   1912:     my $gradelevel=shift;
                   1913:     my %gradelevels=(0 => 'Not specified',
                   1914: 		     1 => 'Grade 1',
                   1915: 		     2 => 'Grade 2',
                   1916: 		     3 => 'Grade 3',
                   1917: 		     4 => 'Grade 4',
                   1918: 		     5 => 'Grade 5',
                   1919: 		     6 => 'Grade 6',
                   1920: 		     7 => 'Grade 7',
                   1921: 		     8 => 'Grade 8',
                   1922: 		     9 => 'Grade 9',
                   1923: 		     10 => 'Grade 10',
                   1924: 		     11 => 'Grade 11',
                   1925: 		     12 => 'Grade 12',
                   1926: 		     13 => 'Grade 13',
                   1927: 		     14 => '100 Level',
                   1928: 		     15 => '200 Level',
                   1929: 		     16 => '300 Level',
                   1930: 		     17 => '400 Level',
                   1931: 		     18 => 'Graduate Level');
                   1932:     return &mt($gradelevels{$gradelevel});
                   1933: }
                   1934: 
1.163     www      1935: sub select_level_form {
                   1936:     my ($deflevel,$name)=@_;
                   1937:     unless ($deflevel) { $deflevel=0; }
1.167     www      1938:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1939:     for (my $i=0; $i<=18; $i++) {
                   1940:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1941:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1942:                 ">".&gradeleveldescription($i)."</option>\n";
                   1943:     }
                   1944:     $selectform.="</select>";
                   1945:     return $selectform;
1.163     www      1946: }
1.167     www      1947: 
1.35      matthew  1948: #-------------------------------------------
                   1949: 
1.45      matthew  1950: =pod
                   1951: 
1.910     raeburn  1952: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35      matthew  1953: 
                   1954: Returns a string containing a <select name='$name' size='1'> form to 
                   1955: allow a user to select the domain to preform an operation in.  
                   1956: See loncreateuser.pm for an example invocation and use.
                   1957: 
1.90      www      1958: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1959: selected");
                   1960: 
1.743     raeburn  1961: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   1962: 
1.910     raeburn  1963: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
                   1964: 
                   1965: The optional $incdoms is a reference to an array of domains which will be the only available options. 
1.563     raeburn  1966: 
1.35      matthew  1967: =cut
                   1968: 
                   1969: #-------------------------------------------
1.34      matthew  1970: sub select_dom_form {
1.910     raeburn  1971:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872     raeburn  1972:     if ($onchange) {
1.874     raeburn  1973:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  1974:     }
1.910     raeburn  1975:     my @domains;
                   1976:     if (ref($incdoms) eq 'ARRAY') {
                   1977:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   1978:     } else {
                   1979:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   1980:     }
1.90      www      1981:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  1982:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 1983:     foreach my $dom (@domains) {
                   1984:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  1985:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   1986:         if ($showdomdesc) {
                   1987:             if ($dom ne '') {
                   1988:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   1989:                 if ($domdesc ne '') {
                   1990:                     $selectdomain .= ' ('.$domdesc.')';
                   1991:                 }
                   1992:             } 
                   1993:         }
                   1994:         $selectdomain .= "</option>\n";
1.34      matthew  1995:     }
                   1996:     $selectdomain.="</select>";
                   1997:     return $selectdomain;
                   1998: }
                   1999: 
1.35      matthew  2000: #-------------------------------------------
                   2001: 
1.45      matthew  2002: =pod
                   2003: 
1.648     raeburn  2004: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2005: 
1.586     raeburn  2006: input: 4 arguments (two required, two optional) - 
                   2007:     $domain - domain of new user
                   2008:     $name - name of form element
                   2009:     $default - Value of 'default' causes a default item to be first 
                   2010:                             option, and selected by default. 
                   2011:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2012:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2013: output: returns 2 items: 
1.586     raeburn  2014: (a) form element which contains either:
                   2015:    (i) <select name="$name">
                   2016:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2017:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2018:        </select>
                   2019:        form item if there are multiple library servers in $domain, or
                   2020:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2021:        if there is only one library server in $domain.
                   2022: 
                   2023: (b) number of library servers found.
                   2024: 
                   2025: See loncreateuser.pm for example of use.
1.35      matthew  2026: 
                   2027: =cut
                   2028: 
                   2029: #-------------------------------------------
1.586     raeburn  2030: sub home_server_form_item {
                   2031:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2032:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2033:     my $result;
                   2034:     my $numlib = keys(%servers);
                   2035:     if ($numlib > 1) {
                   2036:         $result .= '<select name="'.$name.'" />'."\n";
                   2037:         if ($default) {
1.804     bisitz   2038:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2039:                        '</option>'."\n";
                   2040:         }
                   2041:         foreach my $hostid (sort(keys(%servers))) {
                   2042:             $result.= '<option value="'.$hostid.'">'.
                   2043: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2044:         }
                   2045:         $result .= '</select>'."\n";
                   2046:     } elsif ($numlib == 1) {
                   2047:         my $hostid;
                   2048:         foreach my $item (keys(%servers)) {
                   2049:             $hostid = $item;
                   2050:         }
                   2051:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2052:                    $hostid.'" />';
                   2053:                    if (!$hide) {
                   2054:                        $result .= $hostid.' '.$servers{$hostid};
                   2055:                    }
                   2056:                    $result .= "\n";
                   2057:     } elsif ($default) {
                   2058:         $result .= '<input type="hidden" name="'.$name.
                   2059:                    '" value="default" />';
                   2060:                    if (!$hide) {
                   2061:                        $result .= &mt('default');
                   2062:                    }
                   2063:                    $result .= "\n";
1.33      matthew  2064:     }
1.586     raeburn  2065:     return ($result,$numlib);
1.33      matthew  2066: }
1.112     bowersj2 2067: 
                   2068: =pod
                   2069: 
1.534     albertel 2070: =back 
                   2071: 
1.112     bowersj2 2072: =cut
1.87      matthew  2073: 
                   2074: ###############################################################
1.112     bowersj2 2075: ##                  Decoding User Agent                      ##
1.87      matthew  2076: ###############################################################
                   2077: 
                   2078: =pod
                   2079: 
1.112     bowersj2 2080: =head1 Decoding the User Agent
                   2081: 
                   2082: =over 4
                   2083: 
                   2084: =item * &decode_user_agent()
1.87      matthew  2085: 
                   2086: Inputs: $r
                   2087: 
                   2088: Outputs:
                   2089: 
                   2090: =over 4
                   2091: 
1.112     bowersj2 2092: =item * $httpbrowser
1.87      matthew  2093: 
1.112     bowersj2 2094: =item * $clientbrowser
1.87      matthew  2095: 
1.112     bowersj2 2096: =item * $clientversion
1.87      matthew  2097: 
1.112     bowersj2 2098: =item * $clientmathml
1.87      matthew  2099: 
1.112     bowersj2 2100: =item * $clientunicode
1.87      matthew  2101: 
1.112     bowersj2 2102: =item * $clientos
1.87      matthew  2103: 
                   2104: =back
                   2105: 
1.157     matthew  2106: =back 
                   2107: 
1.87      matthew  2108: =cut
                   2109: 
                   2110: ###############################################################
                   2111: ###############################################################
                   2112: sub decode_user_agent {
1.247     albertel 2113:     my ($r)=@_;
1.87      matthew  2114:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2115:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2116:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2117:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2118:     my $clientbrowser='unknown';
                   2119:     my $clientversion='0';
                   2120:     my $clientmathml='';
                   2121:     my $clientunicode='0';
                   2122:     for (my $i=0;$i<=$#browsertype;$i++) {
                   2123:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   2124: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2125: 	    $clientbrowser=$bname;
                   2126:             $httpbrowser=~/$vreg/i;
                   2127: 	    $clientversion=$1;
                   2128:             $clientmathml=($clientversion>=$minv);
                   2129:             $clientunicode=($clientversion>=$univ);
                   2130: 	}
                   2131:     }
                   2132:     my $clientos='unknown';
                   2133:     if (($httpbrowser=~/linux/i) ||
                   2134:         ($httpbrowser=~/unix/i) ||
                   2135:         ($httpbrowser=~/ux/i) ||
                   2136:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2137:     if (($httpbrowser=~/vax/i) ||
                   2138:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2139:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2140:     if (($httpbrowser=~/mac/i) ||
                   2141:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   2142:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   2143:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   2144:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   2145:             $clientunicode,$clientos,);
                   2146: }
                   2147: 
1.32      matthew  2148: ###############################################################
                   2149: ##    Authentication changing form generation subroutines    ##
                   2150: ###############################################################
                   2151: ##
                   2152: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2153: ## hash, and have reasonable default values.
                   2154: ##
                   2155: ##    formname = the name given in the <form> tag.
1.35      matthew  2156: #-------------------------------------------
                   2157: 
1.45      matthew  2158: =pod
                   2159: 
1.112     bowersj2 2160: =head1 Authentication Routines
                   2161: 
                   2162: =over 4
                   2163: 
1.648     raeburn  2164: =item * &authform_xxxxxx()
1.35      matthew  2165: 
                   2166: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2167: handle some of the conveniences required for authentication forms.  
                   2168: This is not an optimal method, but it works.  
                   2169: 
                   2170: =over 4
                   2171: 
1.112     bowersj2 2172: =item * authform_header
1.35      matthew  2173: 
1.112     bowersj2 2174: =item * authform_authorwarning
1.35      matthew  2175: 
1.112     bowersj2 2176: =item * authform_nochange
1.35      matthew  2177: 
1.112     bowersj2 2178: =item * authform_kerberos
1.35      matthew  2179: 
1.112     bowersj2 2180: =item * authform_internal
1.35      matthew  2181: 
1.112     bowersj2 2182: =item * authform_filesystem
1.35      matthew  2183: 
                   2184: =back
                   2185: 
1.648     raeburn  2186: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2187: 
1.35      matthew  2188: =cut
                   2189: 
                   2190: #-------------------------------------------
1.32      matthew  2191: sub authform_header{  
                   2192:     my %in = (
                   2193:         formname => 'cu',
1.80      albertel 2194:         kerb_def_dom => '',
1.32      matthew  2195:         @_,
                   2196:     );
                   2197:     $in{'formname'} = 'document.' . $in{'formname'};
                   2198:     my $result='';
1.80      albertel 2199: 
                   2200: #---------------------------------------------- Code for upper case translation
                   2201:     my $Javascript_toUpperCase;
                   2202:     unless ($in{kerb_def_dom}) {
                   2203:         $Javascript_toUpperCase =<<"END";
                   2204:         switch (choice) {
                   2205:            case 'krb': currentform.elements[choicearg].value =
                   2206:                currentform.elements[choicearg].value.toUpperCase();
                   2207:                break;
                   2208:            default:
                   2209:         }
                   2210: END
                   2211:     } else {
                   2212:         $Javascript_toUpperCase = "";
                   2213:     }
                   2214: 
1.165     raeburn  2215:     my $radioval = "'nochange'";
1.591     raeburn  2216:     if (defined($in{'curr_authtype'})) {
                   2217:         if ($in{'curr_authtype'} ne '') {
                   2218:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2219:         }
1.174     matthew  2220:     }
1.165     raeburn  2221:     my $argfield = 'null';
1.591     raeburn  2222:     if (defined($in{'mode'})) {
1.165     raeburn  2223:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2224:             if (defined($in{'curr_autharg'})) {
                   2225:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2226:                     $argfield = "'$in{'curr_autharg'}'";
                   2227:                 }
                   2228:             }
                   2229:         }
                   2230:     }
                   2231: 
1.32      matthew  2232:     $result.=<<"END";
                   2233: var current = new Object();
1.165     raeburn  2234: current.radiovalue = $radioval;
                   2235: current.argfield = $argfield;
1.32      matthew  2236: 
                   2237: function changed_radio(choice,currentform) {
                   2238:     var choicearg = choice + 'arg';
                   2239:     // If a radio button in changed, we need to change the argfield
                   2240:     if (current.radiovalue != choice) {
                   2241:         current.radiovalue = choice;
                   2242:         if (current.argfield != null) {
                   2243:             currentform.elements[current.argfield].value = '';
                   2244:         }
                   2245:         if (choice == 'nochange') {
                   2246:             current.argfield = null;
                   2247:         } else {
                   2248:             current.argfield = choicearg;
                   2249:             switch(choice) {
                   2250:                 case 'krb': 
                   2251:                     currentform.elements[current.argfield].value = 
                   2252:                         "$in{'kerb_def_dom'}";
                   2253:                 break;
                   2254:               default:
                   2255:                 break;
                   2256:             }
                   2257:         }
                   2258:     }
                   2259:     return;
                   2260: }
1.22      www      2261: 
1.32      matthew  2262: function changed_text(choice,currentform) {
                   2263:     var choicearg = choice + 'arg';
                   2264:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2265:         $Javascript_toUpperCase
1.32      matthew  2266:         // clear old field
                   2267:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2268:             currentform.elements[current.argfield].value = '';
                   2269:         }
                   2270:         current.argfield = choicearg;
                   2271:     }
                   2272:     set_auth_radio_buttons(choice,currentform);
                   2273:     return;
1.20      www      2274: }
1.32      matthew  2275: 
                   2276: function set_auth_radio_buttons(newvalue,currentform) {
                   2277:     var i=0;
                   2278:     while (i < currentform.login.length) {
                   2279:         if (currentform.login[i].value == newvalue) { break; }
                   2280:         i++;
                   2281:     }
                   2282:     if (i == currentform.login.length) {
                   2283:         return;
                   2284:     }
                   2285:     current.radiovalue = newvalue;
                   2286:     currentform.login[i].checked = true;
                   2287:     return;
                   2288: }
                   2289: END
                   2290:     return $result;
                   2291: }
                   2292: 
                   2293: sub authform_authorwarning{
                   2294:     my $result='';
1.144     matthew  2295:     $result='<i>'.
                   2296:         &mt('As a general rule, only authors or co-authors should be '.
                   2297:             'filesystem authenticated '.
                   2298:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2299:     return $result;
                   2300: }
                   2301: 
                   2302: sub authform_nochange{  
                   2303:     my %in = (
                   2304:               formname => 'document.cu',
                   2305:               kerb_def_dom => 'MSU.EDU',
                   2306:               @_,
                   2307:           );
1.586     raeburn  2308:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2309:     my $result;
                   2310:     if (keys(%can_assign) == 0) {
                   2311:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2312:     } else {
                   2313:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2314:                   '<input type="radio" name="login" value="nochange" '.
                   2315:                   'checked="checked" onclick="'.
1.281     albertel 2316:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2317: 	    '</label>';
1.586     raeburn  2318:     }
1.32      matthew  2319:     return $result;
                   2320: }
                   2321: 
1.591     raeburn  2322: sub authform_kerberos {
1.32      matthew  2323:     my %in = (
                   2324:               formname => 'document.cu',
                   2325:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2326:               kerb_def_auth => 'krb4',
1.32      matthew  2327:               @_,
                   2328:               );
1.586     raeburn  2329:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2330:         $autharg,$jscall);
                   2331:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2332:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2333:        $check5 = ' checked="checked"';
1.80      albertel 2334:     } else {
1.772     bisitz   2335:        $check4 = ' checked="checked"';
1.80      albertel 2336:     }
1.165     raeburn  2337:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2338:     if (defined($in{'curr_authtype'})) {
                   2339:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2340:             $krbcheck = ' checked="checked"';
1.623     raeburn  2341:             if (defined($in{'mode'})) {
                   2342:                 if ($in{'mode'} eq 'modifyuser') {
                   2343:                     $krbcheck = '';
                   2344:                 }
                   2345:             }
1.591     raeburn  2346:             if (defined($in{'curr_kerb_ver'})) {
                   2347:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2348:                     $check5 = ' checked="checked"';
1.591     raeburn  2349:                     $check4 = '';
                   2350:                 } else {
1.772     bisitz   2351:                     $check4 = ' checked="checked"';
1.591     raeburn  2352:                     $check5 = '';
                   2353:                 }
1.586     raeburn  2354:             }
1.591     raeburn  2355:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2356:                 $krbarg = $in{'curr_autharg'};
                   2357:             }
1.586     raeburn  2358:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2359:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2360:                     $result = 
                   2361:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2362:         $in{'curr_autharg'},$krbver);
                   2363:                 } else {
                   2364:                     $result =
                   2365:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2366:                 }
                   2367:                 return $result; 
                   2368:             }
                   2369:         }
                   2370:     } else {
                   2371:         if ($authnum == 1) {
1.784     bisitz   2372:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2373:         }
                   2374:     }
1.586     raeburn  2375:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2376:         return;
1.587     raeburn  2377:     } elsif ($authtype eq '') {
1.591     raeburn  2378:         if (defined($in{'mode'})) {
1.587     raeburn  2379:             if ($in{'mode'} eq 'modifycourse') {
                   2380:                 if ($authnum == 1) {
1.784     bisitz   2381:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2382:                 }
                   2383:             }
                   2384:         }
1.586     raeburn  2385:     }
                   2386:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2387:     if ($authtype eq '') {
                   2388:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2389:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2390:                     $krbcheck.' />';
                   2391:     }
                   2392:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2393:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2394:          $in{'curr_authtype'} eq 'krb5') ||
                   2395:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2396:          $in{'curr_authtype'} eq 'krb4')) {
                   2397:         $result .= &mt
1.144     matthew  2398:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2399:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2400:          '<label>'.$authtype,
1.281     albertel 2401:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2402:              'value="'.$krbarg.'" '.
1.144     matthew  2403:              'onchange="'.$jscall.'" />',
1.281     albertel 2404:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2405:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2406: 	 '</label>');
1.586     raeburn  2407:     } elsif ($can_assign{'krb4'}) {
                   2408:         $result .= &mt
                   2409:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2410:          '[_3] Version 4 [_4]',
                   2411:          '<label>'.$authtype,
                   2412:          '</label><input type="text" size="10" name="krbarg" '.
                   2413:              'value="'.$krbarg.'" '.
                   2414:              'onchange="'.$jscall.'" />',
                   2415:          '<label><input type="hidden" name="krbver" value="4" />',
                   2416:          '</label>');
                   2417:     } elsif ($can_assign{'krb5'}) {
                   2418:         $result .= &mt
                   2419:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2420:          '[_3] Version 5 [_4]',
                   2421:          '<label>'.$authtype,
                   2422:          '</label><input type="text" size="10" name="krbarg" '.
                   2423:              'value="'.$krbarg.'" '.
                   2424:              'onchange="'.$jscall.'" />',
                   2425:          '<label><input type="hidden" name="krbver" value="5" />',
                   2426:          '</label>');
                   2427:     }
1.32      matthew  2428:     return $result;
                   2429: }
                   2430: 
                   2431: sub authform_internal{  
1.586     raeburn  2432:     my %in = (
1.32      matthew  2433:                 formname => 'document.cu',
                   2434:                 kerb_def_dom => 'MSU.EDU',
                   2435:                 @_,
                   2436:                 );
1.586     raeburn  2437:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2438:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2439:     if (defined($in{'curr_authtype'})) {
                   2440:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2441:             if ($can_assign{'int'}) {
1.772     bisitz   2442:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2443:                 if (defined($in{'mode'})) {
                   2444:                     if ($in{'mode'} eq 'modifyuser') {
                   2445:                         $intcheck = '';
                   2446:                     }
                   2447:                 }
1.591     raeburn  2448:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2449:                     $intarg = $in{'curr_autharg'};
                   2450:                 }
                   2451:             } else {
                   2452:                 $result = &mt('Currently internally authenticated.');
                   2453:                 return $result;
1.165     raeburn  2454:             }
                   2455:         }
1.586     raeburn  2456:     } else {
                   2457:         if ($authnum == 1) {
1.784     bisitz   2458:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2459:         }
                   2460:     }
                   2461:     if (!$can_assign{'int'}) {
                   2462:         return;
1.587     raeburn  2463:     } elsif ($authtype eq '') {
1.591     raeburn  2464:         if (defined($in{'mode'})) {
1.587     raeburn  2465:             if ($in{'mode'} eq 'modifycourse') {
                   2466:                 if ($authnum == 1) {
1.784     bisitz   2467:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2468:                 }
                   2469:             }
                   2470:         }
1.165     raeburn  2471:     }
1.586     raeburn  2472:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2473:     if ($authtype eq '') {
                   2474:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2475:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2476:     }
1.605     bisitz   2477:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2478:                $intarg.'" onchange="'.$jscall.'" />';
                   2479:     $result = &mt
1.144     matthew  2480:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2481:          '<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2482:     $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  2483:     return $result;
                   2484: }
                   2485: 
                   2486: sub authform_local{  
                   2487:     my %in = (
                   2488:               formname => 'document.cu',
                   2489:               kerb_def_dom => 'MSU.EDU',
                   2490:               @_,
                   2491:               );
1.586     raeburn  2492:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2493:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2494:     if (defined($in{'curr_authtype'})) {
                   2495:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2496:             if ($can_assign{'loc'}) {
1.772     bisitz   2497:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2498:                 if (defined($in{'mode'})) {
                   2499:                     if ($in{'mode'} eq 'modifyuser') {
                   2500:                         $loccheck = '';
                   2501:                     }
                   2502:                 }
1.591     raeburn  2503:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2504:                     $locarg = $in{'curr_autharg'};
                   2505:                 }
                   2506:             } else {
                   2507:                 $result = &mt('Currently using local (institutional) authentication.');
                   2508:                 return $result;
1.165     raeburn  2509:             }
                   2510:         }
1.586     raeburn  2511:     } else {
                   2512:         if ($authnum == 1) {
1.784     bisitz   2513:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2514:         }
                   2515:     }
                   2516:     if (!$can_assign{'loc'}) {
                   2517:         return;
1.587     raeburn  2518:     } elsif ($authtype eq '') {
1.591     raeburn  2519:         if (defined($in{'mode'})) {
1.587     raeburn  2520:             if ($in{'mode'} eq 'modifycourse') {
                   2521:                 if ($authnum == 1) {
1.784     bisitz   2522:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2523:                 }
                   2524:             }
                   2525:         }
1.165     raeburn  2526:     }
1.586     raeburn  2527:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2528:     if ($authtype eq '') {
                   2529:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2530:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2531:                     $jscall.'" />';
                   2532:     }
                   2533:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2534:                $locarg.'" onchange="'.$jscall.'" />';
                   2535:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2536:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2537:     return $result;
                   2538: }
                   2539: 
                   2540: sub authform_filesystem{  
                   2541:     my %in = (
                   2542:               formname => 'document.cu',
                   2543:               kerb_def_dom => 'MSU.EDU',
                   2544:               @_,
                   2545:               );
1.586     raeburn  2546:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2547:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2548:     if (defined($in{'curr_authtype'})) {
                   2549:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2550:             if ($can_assign{'fsys'}) {
1.772     bisitz   2551:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2552:                 if (defined($in{'mode'})) {
                   2553:                     if ($in{'mode'} eq 'modifyuser') {
                   2554:                         $fsyscheck = '';
                   2555:                     }
                   2556:                 }
1.586     raeburn  2557:             } else {
                   2558:                 $result = &mt('Currently Filesystem Authenticated.');
                   2559:                 return $result;
                   2560:             }           
                   2561:         }
                   2562:     } else {
                   2563:         if ($authnum == 1) {
1.784     bisitz   2564:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2565:         }
                   2566:     }
                   2567:     if (!$can_assign{'fsys'}) {
                   2568:         return;
1.587     raeburn  2569:     } elsif ($authtype eq '') {
1.591     raeburn  2570:         if (defined($in{'mode'})) {
1.587     raeburn  2571:             if ($in{'mode'} eq 'modifycourse') {
                   2572:                 if ($authnum == 1) {
1.784     bisitz   2573:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2574:                 }
                   2575:             }
                   2576:         }
1.586     raeburn  2577:     }
                   2578:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2579:     if ($authtype eq '') {
                   2580:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2581:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2582:                     $jscall.'" />';
                   2583:     }
                   2584:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2585:                ' onchange="'.$jscall.'" />';
                   2586:     $result = &mt
1.144     matthew  2587:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2588:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2589:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2590:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2591:                   'onchange="'.$jscall.'" />');
1.32      matthew  2592:     return $result;
                   2593: }
                   2594: 
1.586     raeburn  2595: sub get_assignable_auth {
                   2596:     my ($dom) = @_;
                   2597:     if ($dom eq '') {
                   2598:         $dom = $env{'request.role.domain'};
                   2599:     }
                   2600:     my %can_assign = (
                   2601:                           krb4 => 1,
                   2602:                           krb5 => 1,
                   2603:                           int  => 1,
                   2604:                           loc  => 1,
                   2605:                      );
                   2606:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2607:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2608:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2609:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2610:             my $context;
                   2611:             if ($env{'request.role'} =~ /^au/) {
                   2612:                 $context = 'author';
                   2613:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2614:                 $context = 'domain';
                   2615:             } elsif ($env{'request.course.id'}) {
                   2616:                 $context = 'course';
                   2617:             }
                   2618:             if ($context) {
                   2619:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2620:                    %can_assign = %{$authhash->{$context}}; 
                   2621:                 }
                   2622:             }
                   2623:         }
                   2624:     }
                   2625:     my $authnum = 0;
                   2626:     foreach my $key (keys(%can_assign)) {
                   2627:         if ($can_assign{$key}) {
                   2628:             $authnum ++;
                   2629:         }
                   2630:     }
                   2631:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2632:         $authnum --;
                   2633:     }
                   2634:     return ($authnum,%can_assign);
                   2635: }
                   2636: 
1.80      albertel 2637: ###############################################################
                   2638: ##    Get Kerberos Defaults for Domain                 ##
                   2639: ###############################################################
                   2640: ##
                   2641: ## Returns default kerberos version and an associated argument
                   2642: ## as listed in file domain.tab. If not listed, provides
                   2643: ## appropriate default domain and kerberos version.
                   2644: ##
                   2645: #-------------------------------------------
                   2646: 
                   2647: =pod
                   2648: 
1.648     raeburn  2649: =item * &get_kerberos_defaults()
1.80      albertel 2650: 
                   2651: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2652: version and domain. If not found, it defaults to version 4 and the 
                   2653: domain of the server.
1.80      albertel 2654: 
1.648     raeburn  2655: =over 4
                   2656: 
1.80      albertel 2657: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2658: 
1.648     raeburn  2659: =back
                   2660: 
                   2661: =back
                   2662: 
1.80      albertel 2663: =cut
                   2664: 
                   2665: #-------------------------------------------
                   2666: sub get_kerberos_defaults {
                   2667:     my $domain=shift;
1.641     raeburn  2668:     my ($krbdef,$krbdefdom);
                   2669:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2670:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2671:         $krbdef = $domdefaults{'auth_def'};
                   2672:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2673:     } else {
1.80      albertel 2674:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2675:         my $krbdefdom=$1;
                   2676:         $krbdefdom=~tr/a-z/A-Z/;
                   2677:         $krbdef = "krb4";
                   2678:     }
                   2679:     return ($krbdef,$krbdefdom);
                   2680: }
1.112     bowersj2 2681: 
1.32      matthew  2682: 
1.46      matthew  2683: ###############################################################
                   2684: ##                Thesaurus Functions                        ##
                   2685: ###############################################################
1.20      www      2686: 
1.46      matthew  2687: =pod
1.20      www      2688: 
1.112     bowersj2 2689: =head1 Thesaurus Functions
                   2690: 
                   2691: =over 4
                   2692: 
1.648     raeburn  2693: =item * &initialize_keywords()
1.46      matthew  2694: 
                   2695: Initializes the package variable %Keywords if it is empty.  Uses the
                   2696: package variable $thesaurus_db_file.
                   2697: 
                   2698: =cut
                   2699: 
                   2700: ###################################################
                   2701: 
                   2702: sub initialize_keywords {
                   2703:     return 1 if (scalar keys(%Keywords));
                   2704:     # If we are here, %Keywords is empty, so fill it up
                   2705:     #   Make sure the file we need exists...
                   2706:     if (! -e $thesaurus_db_file) {
                   2707:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2708:                                  " failed because it does not exist");
                   2709:         return 0;
                   2710:     }
                   2711:     #   Set up the hash as a database
                   2712:     my %thesaurus_db;
                   2713:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2714:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2715:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2716:                                  $thesaurus_db_file);
                   2717:         return 0;
                   2718:     } 
                   2719:     #  Get the average number of appearances of a word.
                   2720:     my $avecount = $thesaurus_db{'average.count'};
                   2721:     #  Put keywords (those that appear > average) into %Keywords
                   2722:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2723:         my ($count,undef) = split /:/,$data;
                   2724:         $Keywords{$word}++ if ($count > $avecount);
                   2725:     }
                   2726:     untie %thesaurus_db;
                   2727:     # Remove special values from %Keywords.
1.356     albertel 2728:     foreach my $value ('total.count','average.count') {
                   2729:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2730:   }
1.46      matthew  2731:     return 1;
                   2732: }
                   2733: 
                   2734: ###################################################
                   2735: 
                   2736: =pod
                   2737: 
1.648     raeburn  2738: =item * &keyword($word)
1.46      matthew  2739: 
                   2740: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2741: than the average number of times in the thesaurus database.  Calls 
                   2742: &initialize_keywords
                   2743: 
                   2744: =cut
                   2745: 
                   2746: ###################################################
1.20      www      2747: 
                   2748: sub keyword {
1.46      matthew  2749:     return if (!&initialize_keywords());
                   2750:     my $word=lc(shift());
                   2751:     $word=~s/\W//g;
                   2752:     return exists($Keywords{$word});
1.20      www      2753: }
1.46      matthew  2754: 
                   2755: ###############################################################
                   2756: 
                   2757: =pod 
1.20      www      2758: 
1.648     raeburn  2759: =item * &get_related_words()
1.46      matthew  2760: 
1.160     matthew  2761: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2762: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2763: will be returned.  The order of the words returned is determined by the
                   2764: database which holds them.
                   2765: 
                   2766: Uses global $thesaurus_db_file.
                   2767: 
                   2768: =cut
                   2769: 
                   2770: ###############################################################
                   2771: sub get_related_words {
                   2772:     my $keyword = shift;
                   2773:     my %thesaurus_db;
                   2774:     if (! -e $thesaurus_db_file) {
                   2775:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2776:                                  "failed because the file does not exist");
                   2777:         return ();
                   2778:     }
                   2779:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2780:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2781:         return ();
                   2782:     } 
                   2783:     my @Words=();
1.429     www      2784:     my $count=0;
1.46      matthew  2785:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2786: 	# The first element is the number of times
                   2787: 	# the word appears.  We do not need it now.
1.429     www      2788: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2789: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2790: 	my $threshold=$mostfrequentcount/10;
                   2791:         foreach my $possibleword (@RelatedWords) {
                   2792:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2793:             if ($wordcount>$threshold) {
                   2794: 		push(@Words,$word);
                   2795:                 $count++;
                   2796:                 if ($count>10) { last; }
                   2797: 	    }
1.20      www      2798:         }
                   2799:     }
1.46      matthew  2800:     untie %thesaurus_db;
                   2801:     return @Words;
1.14      harris41 2802: }
1.46      matthew  2803: 
1.112     bowersj2 2804: =pod
                   2805: 
                   2806: =back
                   2807: 
                   2808: =cut
1.61      www      2809: 
                   2810: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2811: =pod
                   2812: 
1.112     bowersj2 2813: =head1 User Name Functions
                   2814: 
                   2815: =over 4
                   2816: 
1.648     raeburn  2817: =item * &plainname($uname,$udom,$first)
1.81      albertel 2818: 
1.112     bowersj2 2819: Takes a users logon name and returns it as a string in
1.226     albertel 2820: "first middle last generation" form 
                   2821: if $first is set to 'lastname' then it returns it as
                   2822: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2823: 
                   2824: =cut
1.61      www      2825: 
1.295     www      2826: 
1.81      albertel 2827: ###############################################################
1.61      www      2828: sub plainname {
1.226     albertel 2829:     my ($uname,$udom,$first)=@_;
1.537     albertel 2830:     return if (!defined($uname) || !defined($udom));
1.295     www      2831:     my %names=&getnames($uname,$udom);
1.226     albertel 2832:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2833: 					  $names{'middlename'},
                   2834: 					  $names{'lastname'},
                   2835: 					  $names{'generation'},$first);
                   2836:     $name=~s/^\s+//;
1.62      www      2837:     $name=~s/\s+$//;
                   2838:     $name=~s/\s+/ /g;
1.353     albertel 2839:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2840:     return $name;
1.61      www      2841: }
1.66      www      2842: 
                   2843: # -------------------------------------------------------------------- Nickname
1.81      albertel 2844: =pod
                   2845: 
1.648     raeburn  2846: =item * &nickname($uname,$udom)
1.81      albertel 2847: 
                   2848: Gets a users name and returns it as a string as
                   2849: 
                   2850: "&quot;nickname&quot;"
1.66      www      2851: 
1.81      albertel 2852: if the user has a nickname or
                   2853: 
                   2854: "first middle last generation"
                   2855: 
                   2856: if the user does not
                   2857: 
                   2858: =cut
1.66      www      2859: 
                   2860: sub nickname {
                   2861:     my ($uname,$udom)=@_;
1.537     albertel 2862:     return if (!defined($uname) || !defined($udom));
1.295     www      2863:     my %names=&getnames($uname,$udom);
1.68      albertel 2864:     my $name=$names{'nickname'};
1.66      www      2865:     if ($name) {
                   2866:        $name='&quot;'.$name.'&quot;'; 
                   2867:     } else {
                   2868:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2869: 	     $names{'lastname'}.' '.$names{'generation'};
                   2870:        $name=~s/\s+$//;
                   2871:        $name=~s/\s+/ /g;
                   2872:     }
                   2873:     return $name;
                   2874: }
                   2875: 
1.295     www      2876: sub getnames {
                   2877:     my ($uname,$udom)=@_;
1.537     albertel 2878:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2879:     if ($udom eq 'public' && $uname eq 'public') {
                   2880: 	return ('lastname' => &mt('Public'));
                   2881:     }
1.295     www      2882:     my $id=$uname.':'.$udom;
                   2883:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2884:     if ($cached) {
                   2885: 	return %{$names};
                   2886:     } else {
                   2887: 	my %loadnames=&Apache::lonnet::get('environment',
                   2888:                     ['firstname','middlename','lastname','generation','nickname'],
                   2889: 					 $udom,$uname);
                   2890: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2891: 	return %loadnames;
                   2892:     }
                   2893: }
1.61      www      2894: 
1.542     raeburn  2895: # -------------------------------------------------------------------- getemails
1.648     raeburn  2896: 
1.542     raeburn  2897: =pod
                   2898: 
1.648     raeburn  2899: =item * &getemails($uname,$udom)
1.542     raeburn  2900: 
                   2901: Gets a user's email information and returns it as a hash with keys:
                   2902: notification, critnotification, permanentemail
                   2903: 
                   2904: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2905: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2906:  
1.648     raeburn  2907: 
1.542     raeburn  2908: =cut
                   2909: 
1.648     raeburn  2910: 
1.466     albertel 2911: sub getemails {
                   2912:     my ($uname,$udom)=@_;
                   2913:     if ($udom eq 'public' && $uname eq 'public') {
                   2914: 	return;
                   2915:     }
1.467     www      2916:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2917:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2918:     my $id=$uname.':'.$udom;
                   2919:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2920:     if ($cached) {
                   2921: 	return %{$names};
                   2922:     } else {
                   2923: 	my %loadnames=&Apache::lonnet::get('environment',
                   2924:                     			   ['notification','critnotification',
                   2925: 					    'permanentemail'],
                   2926: 					   $udom,$uname);
                   2927: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2928: 	return %loadnames;
                   2929:     }
                   2930: }
                   2931: 
1.551     albertel 2932: sub flush_email_cache {
                   2933:     my ($uname,$udom)=@_;
                   2934:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2935:     if (!$uname) { $uname=$env{'user.name'};   }
                   2936:     return if ($udom eq 'public' && $uname eq 'public');
                   2937:     my $id=$uname.':'.$udom;
                   2938:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2939: }
                   2940: 
1.728     raeburn  2941: # -------------------------------------------------------------------- getlangs
                   2942: 
                   2943: =pod
                   2944: 
                   2945: =item * &getlangs($uname,$udom)
                   2946: 
                   2947: Gets a user's language preference and returns it as a hash with key:
                   2948: language.
                   2949: 
                   2950: =cut
                   2951: 
                   2952: 
                   2953: sub getlangs {
                   2954:     my ($uname,$udom) = @_;
                   2955:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2956:     if (!$uname) { $uname=$env{'user.name'};   }
                   2957:     my $id=$uname.':'.$udom;
                   2958:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   2959:     if ($cached) {
                   2960:         return %{$langs};
                   2961:     } else {
                   2962:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   2963:                                            $udom,$uname);
                   2964:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   2965:         return %loadlangs;
                   2966:     }
                   2967: }
                   2968: 
                   2969: sub flush_langs_cache {
                   2970:     my ($uname,$udom)=@_;
                   2971:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2972:     if (!$uname) { $uname=$env{'user.name'};   }
                   2973:     return if ($udom eq 'public' && $uname eq 'public');
                   2974:     my $id=$uname.':'.$udom;
                   2975:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   2976: }
                   2977: 
1.61      www      2978: # ------------------------------------------------------------------ Screenname
1.81      albertel 2979: 
                   2980: =pod
                   2981: 
1.648     raeburn  2982: =item * &screenname($uname,$udom)
1.81      albertel 2983: 
                   2984: Gets a users screenname and returns it as a string
                   2985: 
                   2986: =cut
1.61      www      2987: 
                   2988: sub screenname {
                   2989:     my ($uname,$udom)=@_;
1.258     albertel 2990:     if ($uname eq $env{'user.name'} &&
                   2991: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2992:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2993:     return $names{'screenname'};
1.62      www      2994: }
                   2995: 
1.212     albertel 2996: 
1.802     bisitz   2997: # ------------------------------------------------------------- Confirm Wrapper
                   2998: =pod
                   2999: 
                   3000: =item confirmwrapper
                   3001: 
                   3002: Wrap messages about completion of operation in box
                   3003: 
                   3004: =cut
                   3005: 
                   3006: sub confirmwrapper {
                   3007:     my ($message)=@_;
                   3008:     if ($message) {
                   3009:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3010:                .$message."\n"
                   3011:                .'</div>'."\n";
                   3012:     } else {
                   3013:         return $message;
                   3014:     }
                   3015: }
                   3016: 
1.62      www      3017: # ------------------------------------------------------------- Message Wrapper
                   3018: 
                   3019: sub messagewrapper {
1.369     www      3020:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3021:     return 
1.441     albertel 3022:         '<a href="/adm/email?compose=individual&amp;'.
                   3023:         'recname='.$username.'&amp;recdom='.$domain.
                   3024: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3025:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3026: }
1.802     bisitz   3027: 
1.74      www      3028: # --------------------------------------------------------------- Notes Wrapper
                   3029: 
                   3030: sub noteswrapper {
                   3031:     my ($link,$un,$do)=@_;
                   3032:     return 
1.896     amueller 3033: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3034: }
1.802     bisitz   3035: 
1.62      www      3036: # ------------------------------------------------------------- Aboutme Wrapper
                   3037: 
                   3038: sub aboutmewrapper {
1.166     www      3039:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  3040:     if (!defined($username)  && !defined($domain)) {
                   3041:         return;
                   3042:     }
1.892     amueller 3043:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756     weissno  3044: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3045: }
                   3046: 
                   3047: # ------------------------------------------------------------ Syllabus Wrapper
                   3048: 
                   3049: sub syllabuswrapper {
1.707     bisitz   3050:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3051:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3052: }
1.14      harris41 3053: 
1.802     bisitz   3054: # -----------------------------------------------------------------------------
                   3055: 
1.208     matthew  3056: sub track_student_link {
1.887     raeburn  3057:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3058:     my $link ="/adm/trackstudent?";
1.208     matthew  3059:     my $title = 'View recent activity';
                   3060:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3061:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3062:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3063:         $title .= ' of this student';
1.268     albertel 3064:     } 
1.208     matthew  3065:     if (defined($target) && $target !~ /^\s*$/) {
                   3066:         $target = qq{target="$target"};
                   3067:     } else {
                   3068:         $target = '';
                   3069:     }
1.268     albertel 3070:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3071:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3072:     $title = &mt($title);
                   3073:     $linktext = &mt($linktext);
1.448     albertel 3074:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3075: 	&help_open_topic('View_recent_activity');
1.208     matthew  3076: }
                   3077: 
1.781     raeburn  3078: sub slot_reservations_link {
                   3079:     my ($linktext,$sname,$sdom,$target) = @_;
                   3080:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3081:     my $title = 'View slot reservation history';
                   3082:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3083:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3084:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3085:         $title .= ' of this student';
                   3086:     }
                   3087:     if (defined($target) && $target !~ /^\s*$/) {
                   3088:         $target = qq{target="$target"};
                   3089:     } else {
                   3090:         $target = '';
                   3091:     }
                   3092:     $title = &mt($title);
                   3093:     $linktext = &mt($linktext);
                   3094:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3095: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3096: 
                   3097: }
                   3098: 
1.508     www      3099: # ===================================================== Display a student photo
                   3100: 
                   3101: 
1.509     albertel 3102: sub student_image_tag {
1.508     www      3103:     my ($domain,$user)=@_;
                   3104:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3105:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3106: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3107:     } else {
                   3108: 	return '';
                   3109:     }
                   3110: }
                   3111: 
1.112     bowersj2 3112: =pod
                   3113: 
                   3114: =back
                   3115: 
                   3116: =head1 Access .tab File Data
                   3117: 
                   3118: =over 4
                   3119: 
1.648     raeburn  3120: =item * &languageids() 
1.112     bowersj2 3121: 
                   3122: returns list of all language ids
                   3123: 
                   3124: =cut
                   3125: 
1.14      harris41 3126: sub languageids {
1.16      harris41 3127:     return sort(keys(%language));
1.14      harris41 3128: }
                   3129: 
1.112     bowersj2 3130: =pod
                   3131: 
1.648     raeburn  3132: =item * &languagedescription() 
1.112     bowersj2 3133: 
                   3134: returns description of a specified language id
                   3135: 
                   3136: =cut
                   3137: 
1.14      harris41 3138: sub languagedescription {
1.125     www      3139:     my $code=shift;
                   3140:     return  ($supported_language{$code}?'* ':'').
                   3141:             $language{$code}.
1.126     www      3142: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3143: }
                   3144: 
                   3145: sub plainlanguagedescription {
                   3146:     my $code=shift;
                   3147:     return $language{$code};
                   3148: }
                   3149: 
                   3150: sub supportedlanguagecode {
                   3151:     my $code=shift;
                   3152:     return $supported_language{$code};
1.97      www      3153: }
                   3154: 
1.112     bowersj2 3155: =pod
                   3156: 
1.648     raeburn  3157: =item * &copyrightids() 
1.112     bowersj2 3158: 
                   3159: returns list of all copyrights
                   3160: 
                   3161: =cut
                   3162: 
                   3163: sub copyrightids {
                   3164:     return sort(keys(%cprtag));
                   3165: }
                   3166: 
                   3167: =pod
                   3168: 
1.648     raeburn  3169: =item * &copyrightdescription() 
1.112     bowersj2 3170: 
                   3171: returns description of a specified copyright id
                   3172: 
                   3173: =cut
                   3174: 
                   3175: sub copyrightdescription {
1.166     www      3176:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3177: }
1.197     matthew  3178: 
                   3179: =pod
                   3180: 
1.648     raeburn  3181: =item * &source_copyrightids() 
1.192     taceyjo1 3182: 
                   3183: returns list of all source copyrights
                   3184: 
                   3185: =cut
                   3186: 
                   3187: sub source_copyrightids {
                   3188:     return sort(keys(%scprtag));
                   3189: }
                   3190: 
                   3191: =pod
                   3192: 
1.648     raeburn  3193: =item * &source_copyrightdescription() 
1.192     taceyjo1 3194: 
                   3195: returns description of a specified source copyright id
                   3196: 
                   3197: =cut
                   3198: 
                   3199: sub source_copyrightdescription {
                   3200:     return &mt($scprtag{shift(@_)});
                   3201: }
1.112     bowersj2 3202: 
                   3203: =pod
                   3204: 
1.648     raeburn  3205: =item * &filecategories() 
1.112     bowersj2 3206: 
                   3207: returns list of all file categories
                   3208: 
                   3209: =cut
                   3210: 
                   3211: sub filecategories {
                   3212:     return sort(keys(%category_extensions));
                   3213: }
                   3214: 
                   3215: =pod
                   3216: 
1.648     raeburn  3217: =item * &filecategorytypes() 
1.112     bowersj2 3218: 
                   3219: returns list of file types belonging to a given file
                   3220: category
                   3221: 
                   3222: =cut
                   3223: 
                   3224: sub filecategorytypes {
1.356     albertel 3225:     my ($cat) = @_;
                   3226:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3227: }
                   3228: 
                   3229: =pod
                   3230: 
1.648     raeburn  3231: =item * &fileembstyle() 
1.112     bowersj2 3232: 
                   3233: returns embedding style for a specified file type
                   3234: 
                   3235: =cut
                   3236: 
                   3237: sub fileembstyle {
                   3238:     return $fe{lc(shift(@_))};
1.169     www      3239: }
                   3240: 
1.351     www      3241: sub filemimetype {
                   3242:     return $fm{lc(shift(@_))};
                   3243: }
                   3244: 
1.169     www      3245: 
                   3246: sub filecategoryselect {
                   3247:     my ($name,$value)=@_;
1.189     matthew  3248:     return &select_form($value,$name,
1.970     raeburn  3249:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112     bowersj2 3250: }
                   3251: 
                   3252: =pod
                   3253: 
1.648     raeburn  3254: =item * &filedescription() 
1.112     bowersj2 3255: 
                   3256: returns description for a specified file type
                   3257: 
                   3258: =cut
                   3259: 
                   3260: sub filedescription {
1.188     matthew  3261:     my $file_description = $fd{lc(shift())};
                   3262:     $file_description =~ s:([\[\]]):~$1:g;
                   3263:     return &mt($file_description);
1.112     bowersj2 3264: }
                   3265: 
                   3266: =pod
                   3267: 
1.648     raeburn  3268: =item * &filedescriptionex() 
1.112     bowersj2 3269: 
                   3270: returns description for a specified file type with
                   3271: extra formatting
                   3272: 
                   3273: =cut
                   3274: 
                   3275: sub filedescriptionex {
                   3276:     my $ex=shift;
1.188     matthew  3277:     my $file_description = $fd{lc($ex)};
                   3278:     $file_description =~ s:([\[\]]):~$1:g;
                   3279:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3280: }
                   3281: 
                   3282: # End of .tab access
                   3283: =pod
                   3284: 
                   3285: =back
                   3286: 
                   3287: =cut
                   3288: 
                   3289: # ------------------------------------------------------------------ File Types
                   3290: sub fileextensions {
                   3291:     return sort(keys(%fe));
                   3292: }
                   3293: 
1.97      www      3294: # ----------------------------------------------------------- Display Languages
                   3295: # returns a hash with all desired display languages
                   3296: #
                   3297: 
                   3298: sub display_languages {
                   3299:     my %languages=();
1.695     raeburn  3300:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3301: 	$languages{$lang}=1;
1.97      www      3302:     }
                   3303:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3304:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3305: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3306: 	    $languages{$lang}=1;
1.97      www      3307:         }
                   3308:     }
                   3309:     return %languages;
1.14      harris41 3310: }
                   3311: 
1.582     albertel 3312: sub languages {
                   3313:     my ($possible_langs) = @_;
1.695     raeburn  3314:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3315:     if (!ref($possible_langs)) {
                   3316: 	if( wantarray ) {
                   3317: 	    return @preferred_langs;
                   3318: 	} else {
                   3319: 	    return $preferred_langs[0];
                   3320: 	}
                   3321:     }
                   3322:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3323:     my @preferred_possibilities;
                   3324:     foreach my $preferred_lang (@preferred_langs) {
                   3325: 	if (exists($possibilities{$preferred_lang})) {
                   3326: 	    push(@preferred_possibilities, $preferred_lang);
                   3327: 	}
                   3328:     }
                   3329:     if( wantarray ) {
                   3330: 	return @preferred_possibilities;
                   3331:     }
                   3332:     return $preferred_possibilities[0];
                   3333: }
                   3334: 
1.742     raeburn  3335: sub user_lang {
                   3336:     my ($touname,$toudom,$fromcid) = @_;
                   3337:     my @userlangs;
                   3338:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3339:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3340:                     $env{'course.'.$fromcid.'.languages'}));
                   3341:     } else {
                   3342:         my %langhash = &getlangs($touname,$toudom);
                   3343:         if ($langhash{'languages'} ne '') {
                   3344:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3345:         } else {
                   3346:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3347:             if ($domdefs{'lang_def'} ne '') {
                   3348:                 @userlangs = ($domdefs{'lang_def'});
                   3349:             }
                   3350:         }
                   3351:     }
                   3352:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3353:     my $user_lh = Apache::localize->get_handle(@languages);
                   3354:     return $user_lh;
                   3355: }
                   3356: 
                   3357: 
1.112     bowersj2 3358: ###############################################################
                   3359: ##               Student Answer Attempts                     ##
                   3360: ###############################################################
                   3361: 
                   3362: =pod
                   3363: 
                   3364: =head1 Alternate Problem Views
                   3365: 
                   3366: =over 4
                   3367: 
1.648     raeburn  3368: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3369:     $getattempt, $regexp, $gradesub)
                   3370: 
                   3371: Return string with previous attempt on problem. Arguments:
                   3372: 
                   3373: =over 4
                   3374: 
                   3375: =item * $symb: Problem, including path
                   3376: 
                   3377: =item * $username: username of the desired student
                   3378: 
                   3379: =item * $domain: domain of the desired student
1.14      harris41 3380: 
1.112     bowersj2 3381: =item * $course: Course ID
1.14      harris41 3382: 
1.112     bowersj2 3383: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3384:     something
1.14      harris41 3385: 
1.112     bowersj2 3386: =item * $regexp: if string matches this regexp, the string will be
                   3387:     sent to $gradesub
1.14      harris41 3388: 
1.112     bowersj2 3389: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3390: 
1.112     bowersj2 3391: =back
1.14      harris41 3392: 
1.112     bowersj2 3393: The output string is a table containing all desired attempts, if any.
1.16      harris41 3394: 
1.112     bowersj2 3395: =cut
1.1       albertel 3396: 
                   3397: sub get_previous_attempt {
1.43      ng       3398:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3399:   my $prevattempts='';
1.43      ng       3400:   no strict 'refs';
1.1       albertel 3401:   if ($symb) {
1.3       albertel 3402:     my (%returnhash)=
                   3403:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3404:     if ($returnhash{'version'}) {
                   3405:       my %lasthash=();
                   3406:       my $version;
                   3407:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3408:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3409: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3410:         }
1.1       albertel 3411:       }
1.596     albertel 3412:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3413:       $prevattempts.='<th>'.&mt('History').'</th>';
1.945     raeburn  3414:       my %typeparts;
                   3415:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 3416:       foreach my $key (sort(keys(%lasthash))) {
                   3417: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3418: 	if ($#parts > 0) {
1.31      albertel 3419: 	  my $data=$parts[-1];
                   3420: 	  pop(@parts);
1.945     raeburn  3421:           if ($data eq 'type') {
                   3422:               unless ($showsurv) {
                   3423:                   my $id = join(',',@parts);
                   3424:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
                   3425:               }
                   3426:               delete($lasthash{$key});
                   3427:           } else {
                   3428: 	      $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
                   3429:           }
1.31      albertel 3430: 	} else {
1.41      ng       3431: 	  if ($#parts == 0) {
                   3432: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3433: 	  } else {
                   3434: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3435: 	  }
1.31      albertel 3436: 	}
1.16      harris41 3437:       }
1.596     albertel 3438:       $prevattempts.=&end_data_table_header_row();
1.945     raeburn  3439:       my %lasthidden;
1.40      ng       3440:       if ($getattempt eq '') {
                   3441: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945     raeburn  3442:             my @hidden;
                   3443:             if (%typeparts) {
                   3444:                 foreach my $id (keys(%typeparts)) {
                   3445:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
                   3446:                         push(@hidden,$id);
                   3447:                         $lasthidden{$id} = 1;
                   3448:                     } elsif ($lasthidden{$id}) {
                   3449:                         if (exists($returnhash{$version.':'.$id.'.award'})) {
                   3450:                             delete($lasthidden{$id});
                   3451:                         }
                   3452:                     }
                   3453:                 }
                   3454:             }
                   3455:             $prevattempts.=&start_data_table_row().
                   3456:                            '<td>'.&mt('Transaction [_1]',$version).'</td>';
                   3457:             if (@hidden) {
                   3458:                 foreach my $key (sort(keys(%lasthash))) {
                   3459:                     my $hide;
                   3460:                     foreach my $id (@hidden) {
                   3461:                         if ($key =~ /^\Q$id\E/) {
                   3462:                             $hide = 1;
                   3463:                             last;
                   3464:                         }
                   3465:                     }
                   3466:                     if ($hide) {
                   3467:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   3468:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   3469:                             my $value = &format_previous_attempt_value($key,
                   3470:                                              $returnhash{$version.':'.$key});
                   3471:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3472:                         } else {
                   3473:                             $prevattempts.='<td>&nbsp;</td>';
                   3474:                         }
                   3475:                     } else {
                   3476:                         if ($key =~ /\./) {
                   3477:                             my $value = &format_previous_attempt_value($key,
                   3478:                                               $returnhash{$version.':'.$key});
                   3479:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3480:                         } else {
                   3481:                             $prevattempts.='<td>&nbsp;</td>';
                   3482:                         }
                   3483:                     }
                   3484:                 }
                   3485:             } else {
                   3486: 	        foreach my $key (sort(keys(%lasthash))) {
                   3487: 		    my $value = &format_previous_attempt_value($key,
                   3488: 			            $returnhash{$version.':'.$key});
                   3489: 		    $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3490: 	        }
                   3491:             }
                   3492: 	    $prevattempts.=&end_data_table_row();
1.40      ng       3493: 	 }
1.1       albertel 3494:       }
1.945     raeburn  3495:       my @currhidden = keys(%lasthidden);
1.596     albertel 3496:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3497:       foreach my $key (sort(keys(%lasthash))) {
1.945     raeburn  3498:           if (%typeparts) {
                   3499:               my $hidden;
                   3500:               foreach my $id (@currhidden) {
                   3501:                   if ($key =~ /^\Q$id\E/) {
                   3502:                       $hidden = 1;
                   3503:                       last;
                   3504:                   }
                   3505:               }
                   3506:               if ($hidden) {
                   3507:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   3508:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   3509:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3510:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3511:                           $value = &$gradesub($value);
                   3512:                       }
                   3513:                       $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3514:                   } else {
                   3515:                       $prevattempts.='<td>&nbsp;</td>';
                   3516:                   }
                   3517:               } else {
                   3518:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3519:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3520:                       $value = &$gradesub($value);
                   3521:                   }
                   3522:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3523:               }
                   3524:           } else {
                   3525: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3526: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3527:                   $value = &$gradesub($value);
                   3528:               }
                   3529: 	      $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3530:           }
1.16      harris41 3531:       }
1.596     albertel 3532:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3533:     } else {
1.596     albertel 3534:       $prevattempts=
                   3535: 	  &start_data_table().&start_data_table_row().
                   3536: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3537: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3538:     }
                   3539:   } else {
1.596     albertel 3540:     $prevattempts=
                   3541: 	  &start_data_table().&start_data_table_row().
                   3542: 	  '<td>'.&mt('No data.').'</td>'.
                   3543: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3544:   }
1.10      albertel 3545: }
                   3546: 
1.581     albertel 3547: sub format_previous_attempt_value {
                   3548:     my ($key,$value) = @_;
                   3549:     if ($key =~ /timestamp/) {
                   3550: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3551:     } elsif (ref($value) eq 'ARRAY') {
                   3552: 	$value = '('.join(', ', @{ $value }).')';
                   3553:     } else {
                   3554: 	$value = &unescape($value);
                   3555:     }
                   3556:     return $value;
                   3557: }
                   3558: 
                   3559: 
1.107     albertel 3560: sub relative_to_absolute {
                   3561:     my ($url,$output)=@_;
                   3562:     my $parser=HTML::TokeParser->new(\$output);
                   3563:     my $token;
                   3564:     my $thisdir=$url;
                   3565:     my @rlinks=();
                   3566:     while ($token=$parser->get_token) {
                   3567: 	if ($token->[0] eq 'S') {
                   3568: 	    if ($token->[1] eq 'a') {
                   3569: 		if ($token->[2]->{'href'}) {
                   3570: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3571: 		}
                   3572: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3573: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3574: 	    } elsif ($token->[1] eq 'base') {
                   3575: 		$thisdir=$token->[2]->{'href'};
                   3576: 	    }
                   3577: 	}
                   3578:     }
                   3579:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3580:     foreach my $link (@rlinks) {
1.726     raeburn  3581: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3582: 		($link=~/^\//) ||
                   3583: 		($link=~/^javascript:/i) ||
                   3584: 		($link=~/^mailto:/i) ||
                   3585: 		($link=~/^\#/)) {
                   3586: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3587: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3588: 	}
                   3589:     }
                   3590: # -------------------------------------------------- Deal with Applet codebases
                   3591:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3592:     return $output;
                   3593: }
                   3594: 
1.112     bowersj2 3595: =pod
                   3596: 
1.648     raeburn  3597: =item * &get_student_view()
1.112     bowersj2 3598: 
                   3599: show a snapshot of what student was looking at
                   3600: 
                   3601: =cut
                   3602: 
1.10      albertel 3603: sub get_student_view {
1.186     albertel 3604:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3605:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3606:   my (%form);
1.10      albertel 3607:   my @elements=('symb','courseid','domain','username');
                   3608:   foreach my $element (@elements) {
1.186     albertel 3609:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3610:   }
1.186     albertel 3611:   if (defined($moreenv)) {
                   3612:       %form=(%form,%{$moreenv});
                   3613:   }
1.236     albertel 3614:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3615:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3616:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3617:   $userview=~s/\<body[^\>]*\>//gi;
                   3618:   $userview=~s/\<\/body\>//gi;
                   3619:   $userview=~s/\<html\>//gi;
                   3620:   $userview=~s/\<\/html\>//gi;
                   3621:   $userview=~s/\<head\>//gi;
                   3622:   $userview=~s/\<\/head\>//gi;
                   3623:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3624:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3625:   if (wantarray) {
                   3626:      return ($userview,$response);
                   3627:   } else {
                   3628:      return $userview;
                   3629:   }
                   3630: }
                   3631: 
                   3632: sub get_student_view_with_retries {
                   3633:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3634: 
                   3635:     my $ok = 0;                 # True if we got a good response.
                   3636:     my $content;
                   3637:     my $response;
                   3638: 
                   3639:     # Try to get the student_view done. within the retries count:
                   3640:     
                   3641:     do {
                   3642:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3643:          $ok      = $response->is_success;
                   3644:          if (!$ok) {
                   3645:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3646:          }
                   3647:          $retries--;
                   3648:     } while (!$ok && ($retries > 0));
                   3649:     
                   3650:     if (!$ok) {
                   3651:        $content = '';          # On error return an empty content.
                   3652:     }
1.651     www      3653:     if (wantarray) {
                   3654:        return ($content, $response);
                   3655:     } else {
                   3656:        return $content;
                   3657:     }
1.11      albertel 3658: }
                   3659: 
1.112     bowersj2 3660: =pod
                   3661: 
1.648     raeburn  3662: =item * &get_student_answers() 
1.112     bowersj2 3663: 
                   3664: show a snapshot of how student was answering problem
                   3665: 
                   3666: =cut
                   3667: 
1.11      albertel 3668: sub get_student_answers {
1.100     sakharuk 3669:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3670:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3671:   my (%moreenv);
1.11      albertel 3672:   my @elements=('symb','courseid','domain','username');
                   3673:   foreach my $element (@elements) {
1.186     albertel 3674:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3675:   }
1.186     albertel 3676:   $moreenv{'grade_target'}='answer';
                   3677:   %moreenv=(%form,%moreenv);
1.497     raeburn  3678:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3679:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3680:   return $userview;
1.1       albertel 3681: }
1.116     albertel 3682: 
                   3683: =pod
                   3684: 
                   3685: =item * &submlink()
                   3686: 
1.242     albertel 3687: Inputs: $text $uname $udom $symb $target
1.116     albertel 3688: 
                   3689: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3690: 
                   3691: =cut
                   3692: 
                   3693: ###############################################
                   3694: sub submlink {
1.242     albertel 3695:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3696:     if (!($uname && $udom)) {
                   3697: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3698: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3699: 	if (!$symb) { $symb=$cursymb; }
                   3700:     }
1.254     matthew  3701:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3702:     $symb=&escape($symb);
1.960     bisitz   3703:     if ($target) { $target=" target=\"$target\""; }
                   3704:     return
                   3705:         '<a href="/adm/grades?command=submission'.
                   3706:         '&amp;symb='.$symb.
                   3707:         '&amp;student='.$uname.
                   3708:         '&amp;userdom='.$udom.'"'.
                   3709:         $target.'>'.$text.'</a>';
1.242     albertel 3710: }
                   3711: ##############################################
                   3712: 
                   3713: =pod
                   3714: 
                   3715: =item * &pgrdlink()
                   3716: 
                   3717: Inputs: $text $uname $udom $symb $target
                   3718: 
                   3719: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3720: 
                   3721: =cut
                   3722: 
                   3723: ###############################################
                   3724: sub pgrdlink {
                   3725:     my $link=&submlink(@_);
                   3726:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3727:     return $link;
                   3728: }
                   3729: ##############################################
                   3730: 
                   3731: =pod
                   3732: 
                   3733: =item * &pprmlink()
                   3734: 
                   3735: Inputs: $text $uname $udom $symb $target
                   3736: 
                   3737: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3738: student and a specific resource
1.242     albertel 3739: 
                   3740: =cut
                   3741: 
                   3742: ###############################################
                   3743: sub pprmlink {
                   3744:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3745:     if (!($uname && $udom)) {
                   3746: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3747: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3748: 	if (!$symb) { $symb=$cursymb; }
                   3749:     }
1.254     matthew  3750:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3751:     $symb=&escape($symb);
1.242     albertel 3752:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3753:     return '<a href="/adm/parmset?command=set&amp;'.
                   3754: 	'symb='.$symb.'&amp;uname='.$uname.
                   3755: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3756: }
                   3757: ##############################################
1.37      matthew  3758: 
1.112     bowersj2 3759: =pod
                   3760: 
                   3761: =back
                   3762: 
                   3763: =cut
                   3764: 
1.37      matthew  3765: ###############################################
1.51      www      3766: 
                   3767: 
                   3768: sub timehash {
1.687     raeburn  3769:     my ($thistime) = @_;
                   3770:     my $timezone = &Apache::lonlocal::gettimezone();
                   3771:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3772:                      ->set_time_zone($timezone);
                   3773:     my $wday = $dt->day_of_week();
                   3774:     if ($wday == 7) { $wday = 0; }
                   3775:     return ( 'second' => $dt->second(),
                   3776:              'minute' => $dt->minute(),
                   3777:              'hour'   => $dt->hour(),
                   3778:              'day'     => $dt->day_of_month(),
                   3779:              'month'   => $dt->month(),
                   3780:              'year'    => $dt->year(),
                   3781:              'weekday' => $wday,
                   3782:              'dayyear' => $dt->day_of_year(),
                   3783:              'dlsav'   => $dt->is_dst() );
1.51      www      3784: }
                   3785: 
1.370     www      3786: sub utc_string {
                   3787:     my ($date)=@_;
1.371     www      3788:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3789: }
                   3790: 
1.51      www      3791: sub maketime {
                   3792:     my %th=@_;
1.687     raeburn  3793:     my ($epoch_time,$timezone,$dt);
                   3794:     $timezone = &Apache::lonlocal::gettimezone();
                   3795:     eval {
                   3796:         $dt = DateTime->new( year   => $th{'year'},
                   3797:                              month  => $th{'month'},
                   3798:                              day    => $th{'day'},
                   3799:                              hour   => $th{'hour'},
                   3800:                              minute => $th{'minute'},
                   3801:                              second => $th{'second'},
                   3802:                              time_zone => $timezone,
                   3803:                          );
                   3804:     };
                   3805:     if (!$@) {
                   3806:         $epoch_time = $dt->epoch;
                   3807:         if ($epoch_time) {
                   3808:             return $epoch_time;
                   3809:         }
                   3810:     }
1.51      www      3811:     return POSIX::mktime(
                   3812:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3813:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3814: }
                   3815: 
                   3816: #########################################
1.51      www      3817: 
                   3818: sub findallcourses {
1.482     raeburn  3819:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3820:     my %roles;
                   3821:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3822:     my %courses;
1.51      www      3823:     my $now=time;
1.482     raeburn  3824:     if (!defined($uname)) {
                   3825:         $uname = $env{'user.name'};
                   3826:     }
                   3827:     if (!defined($udom)) {
                   3828:         $udom = $env{'user.domain'};
                   3829:     }
                   3830:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3831:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3832:         if (!%roles) {
                   3833:             %roles = (
                   3834:                        cc => 1,
1.907     raeburn  3835:                        co => 1,
1.482     raeburn  3836:                        in => 1,
                   3837:                        ep => 1,
                   3838:                        ta => 1,
                   3839:                        cr => 1,
                   3840:                        st => 1,
                   3841:              );
                   3842:         }
                   3843:         foreach my $entry (keys(%roleshash)) {
                   3844:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3845:             if ($trole =~ /^cr/) { 
                   3846:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3847:             } else {
                   3848:                 next if (!exists($roles{$trole}));
                   3849:             }
                   3850:             if ($tend) {
                   3851:                 next if ($tend < $now);
                   3852:             }
                   3853:             if ($tstart) {
                   3854:                 next if ($tstart > $now);
                   3855:             }
                   3856:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3857:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3858:             if ($secpart eq '') {
                   3859:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3860:                 $sec = 'none';
                   3861:                 $realsec = '';
                   3862:             } else {
                   3863:                 $cnum = $cnumpart;
                   3864:                 ($sec,$role) = split(/_/,$secpart);
                   3865:                 $realsec = $sec;
1.490     raeburn  3866:             }
1.482     raeburn  3867:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3868:         }
                   3869:     } else {
                   3870:         foreach my $key (keys(%env)) {
1.483     albertel 3871: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3872:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3873: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3874: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3875: 	        next if (%roles && !exists($roles{$role}));
                   3876: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3877:                 my $active=1;
                   3878:                 if ($starttime) {
                   3879: 		    if ($now<$starttime) { $active=0; }
                   3880:                 }
                   3881:                 if ($endtime) {
                   3882:                     if ($now>$endtime) { $active=0; }
                   3883:                 }
                   3884:                 if ($active) {
                   3885:                     if ($sec eq '') {
                   3886:                         $sec = 'none';
                   3887:                     }
                   3888:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3889:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3890:                 }
                   3891:             }
1.51      www      3892:         }
                   3893:     }
1.474     raeburn  3894:     return %courses;
1.51      www      3895: }
1.37      matthew  3896: 
1.54      www      3897: ###############################################
1.474     raeburn  3898: 
                   3899: sub blockcheck {
1.482     raeburn  3900:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3901: 
                   3902:     if (!defined($udom)) {
                   3903:         $udom = $env{'user.domain'};
                   3904:     }
                   3905:     if (!defined($uname)) {
                   3906:         $uname = $env{'user.name'};
                   3907:     }
                   3908: 
                   3909:     # If uname and udom are for a course, check for blocks in the course.
                   3910: 
                   3911:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3912:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3913:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3914:         return ($startblock,$endblock);
                   3915:     }
1.474     raeburn  3916: 
1.502     raeburn  3917:     my $startblock = 0;
                   3918:     my $endblock = 0;
1.482     raeburn  3919:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3920: 
1.490     raeburn  3921:     # If uname is for a user, and activity is course-specific, i.e.,
                   3922:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3923: 
1.490     raeburn  3924:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3925:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3926:         foreach my $key (keys(%live_courses)) {
                   3927:             if ($key ne $env{'request.course.id'}) {
                   3928:                 delete($live_courses{$key});
                   3929:             }
                   3930:         }
                   3931:     }
                   3932: 
                   3933:     my $otheruser = 0;
                   3934:     my %own_courses;
                   3935:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3936:         # Resource belongs to user other than current user.
                   3937:         $otheruser = 1;
                   3938:         # Gather courses for current user
                   3939:         %own_courses = 
                   3940:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3941:     }
                   3942: 
                   3943:     # Gather active course roles - course coordinator, instructor, 
                   3944:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3945: 
                   3946:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3947:         my ($cdom,$cnum);
                   3948:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3949:             $cdom = $env{'course.'.$course.'.domain'};
                   3950:             $cnum = $env{'course.'.$course.'.num'};
                   3951:         } else {
1.490     raeburn  3952:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3953:         }
                   3954:         my $no_ownblock = 0;
                   3955:         my $no_userblock = 0;
1.533     raeburn  3956:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3957:             # Check if current user has 'evb' priv for this
                   3958:             if (defined($own_courses{$course})) {
                   3959:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3960:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3961:                     if ($sec ne 'none') {
                   3962:                         $checkrole .= '/'.$sec;
                   3963:                     }
                   3964:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3965:                         $no_ownblock = 1;
                   3966:                         last;
                   3967:                     }
                   3968:                 }
                   3969:             }
                   3970:             # if they have 'evb' priv and are currently not playing student
                   3971:             next if (($no_ownblock) &&
                   3972:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3973:         }
1.474     raeburn  3974:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3975:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3976:             if ($sec ne 'none') {
1.482     raeburn  3977:                 $checkrole .= '/'.$sec;
1.474     raeburn  3978:             }
1.490     raeburn  3979:             if ($otheruser) {
                   3980:                 # Resource belongs to user other than current user.
                   3981:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3982:                 my ($trole,$tdom,$tnum,$tsec);
                   3983:                 my $entry = $live_courses{$course}{$sec};
                   3984:                 if ($entry =~ /^cr/) {
                   3985:                     ($trole,$tdom,$tnum,$tsec) = 
                   3986:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3987:                 } else {
                   3988:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3989:                 }
                   3990:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3991:                 $area = '/'.$tdom.'/'.$tnum;
                   3992:                 $trest = $tnum;
                   3993:                 if ($tsec ne '') {
                   3994:                     $area .= '/'.$tsec;
                   3995:                     $trest .= '/'.$tsec;
                   3996:                 }
                   3997:                 $spec = $trole.'.'.$area;
                   3998:                 if ($trole =~ /^cr/) {
                   3999:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   4000:                                                       $tdom,$spec,$trest,$area);
                   4001:                 } else {
                   4002:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   4003:                                                        $tdom,$spec,$trest,$area);
                   4004:                 }
                   4005:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  4006:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   4007:                     if ($1) {
                   4008:                         $no_userblock = 1;
                   4009:                         last;
                   4010:                     }
                   4011:                 }
1.490     raeburn  4012:             } else {
                   4013:                 # Resource belongs to current user
                   4014:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  4015:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4016:                     $no_ownblock = 1;
                   4017:                     last;
                   4018:                 }
1.474     raeburn  4019:             }
                   4020:         }
                   4021:         # if they have the evb priv and are currently not playing student
1.482     raeburn  4022:         next if (($no_ownblock) &&
1.491     albertel 4023:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  4024:         next if ($no_userblock);
1.474     raeburn  4025: 
1.866     kalberla 4026:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  4027:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  4028:         
                   4029:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   4030:         if (($start != 0) && 
                   4031:             (($startblock == 0) || ($startblock > $start))) {
                   4032:             $startblock = $start;
                   4033:         }
                   4034:         if (($end != 0)  &&
                   4035:             (($endblock == 0) || ($endblock < $end))) {
                   4036:             $endblock = $end;
                   4037:         }
1.490     raeburn  4038:     }
                   4039:     return ($startblock,$endblock);
                   4040: }
                   4041: 
                   4042: sub get_blocks {
                   4043:     my ($setters,$activity,$cdom,$cnum) = @_;
                   4044:     my $startblock = 0;
                   4045:     my $endblock = 0;
                   4046:     my $course = $cdom.'_'.$cnum;
                   4047:     $setters->{$course} = {};
                   4048:     $setters->{$course}{'staff'} = [];
                   4049:     $setters->{$course}{'times'} = [];
                   4050:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   4051:     foreach my $record (keys(%records)) {
                   4052:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   4053:         if ($start <= time && $end >= time) {
                   4054:             my ($staff_name,$staff_dom,$title,$blocks) =
                   4055:                 &parse_block_record($records{$record});
                   4056:             if ($blocks->{$activity} eq 'on') {
                   4057:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   4058:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 4059:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   4060:                     $startblock = $start;
1.490     raeburn  4061:                 }
1.491     albertel 4062:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   4063:                     $endblock = $end;
1.474     raeburn  4064:                 }
                   4065:             }
                   4066:         }
                   4067:     }
                   4068:     return ($startblock,$endblock);
                   4069: }
                   4070: 
                   4071: sub parse_block_record {
                   4072:     my ($record) = @_;
                   4073:     my ($setuname,$setudom,$title,$blocks);
                   4074:     if (ref($record) eq 'HASH') {
                   4075:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   4076:         $title = &unescape($record->{'event'});
                   4077:         $blocks = $record->{'blocks'};
                   4078:     } else {
                   4079:         my @data = split(/:/,$record,3);
                   4080:         if (scalar(@data) eq 2) {
                   4081:             $title = $data[1];
                   4082:             ($setuname,$setudom) = split(/@/,$data[0]);
                   4083:         } else {
                   4084:             ($setuname,$setudom,$title) = @data;
                   4085:         }
                   4086:         $blocks = { 'com' => 'on' };
                   4087:     }
                   4088:     return ($setuname,$setudom,$title,$blocks);
                   4089: }
                   4090: 
1.854     kalberla 4091: sub blocking_status {
                   4092:   my ($activity,$uname,$udom) = @_;
1.867     kalberla 4093:   my %setters;
1.890     droeschl 4094: 
                   4095:   # check for active blocking
1.867     kalberla 4096:   my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854     kalberla 4097: 
1.890     droeschl 4098:   my $blocked = $startblock && $endblock ? 1 : 0;
                   4099: 
                   4100:   # caller just wants to know whether a block is active
                   4101:   if (!wantarray) { return $blocked; }
                   4102: 
                   4103:   # build a link to a popup window containing the details
                   4104:   my $querystring  = "?activity=$activity";
                   4105:   # $uname and $udom decide whose portfolio the user is trying to look at
                   4106:      $querystring .= "&amp;udom=$udom"      if $udom;
                   4107:      $querystring .= "&amp;uname=$uname"    if $uname;
                   4108: 
                   4109:   my $output .= <<'END_MYBLOCK';
1.854     kalberla 4110:     function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4111:         var options = "width=" + w + ",height=" + h + ",";
                   4112:         options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4113:         options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4114:         var newWin = window.open(url, wdwName, options);
                   4115:         newWin.focus();
                   4116:     }
1.890     droeschl 4117: END_MYBLOCK
1.854     kalberla 4118: 
1.890     droeschl 4119:   $output = Apache::lonhtmlcommon::scripttag($output);
                   4120:   
1.854     kalberla 4121:   my $popupUrl = "/adm/blockingstatus/$querystring";
1.890     droeschl 4122:   my $text = mt('Communication Blocked');
                   4123: 
1.867     kalberla 4124:   $output .= <<"END_BLOCK";
                   4125: <div class='LC_comblock'>
1.869     kalberla 4126:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 4127:   title='$text'>
                   4128:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 4129:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 4130:   title='$text'>$text</a>
1.867     kalberla 4131: </div>
                   4132: 
                   4133: END_BLOCK
1.474     raeburn  4134: 
1.854     kalberla 4135:   return ($blocked, $output);
                   4136: }
1.490     raeburn  4137: 
1.60      matthew  4138: ###############################################
                   4139: 
1.682     raeburn  4140: sub check_ip_acc {
                   4141:     my ($acc)=@_;
                   4142:     &Apache::lonxml::debug("acc is $acc");
                   4143:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   4144:         return 1;
                   4145:     }
                   4146:     my $allowed=0;
                   4147:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   4148: 
                   4149:     my $name;
                   4150:     foreach my $pattern (split(',',$acc)) {
                   4151:         $pattern =~ s/^\s*//;
                   4152:         $pattern =~ s/\s*$//;
                   4153:         if ($pattern =~ /\*$/) {
                   4154:             #35.8.*
                   4155:             $pattern=~s/\*//;
                   4156:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4157:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   4158:             #35.8.3.[34-56]
                   4159:             my $low=$2;
                   4160:             my $high=$3;
                   4161:             $pattern=$1;
                   4162:             if ($ip =~ /^\Q$pattern\E/) {
                   4163:                 my $last=(split(/\./,$ip))[3];
                   4164:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4165:             }
                   4166:         } elsif ($pattern =~ /^\*/) {
                   4167:             #*.msu.edu
                   4168:             $pattern=~s/\*//;
                   4169:             if (!defined($name)) {
                   4170:                 use Socket;
                   4171:                 my $netaddr=inet_aton($ip);
                   4172:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4173:             }
                   4174:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4175:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4176:             #127.0.0.1
                   4177:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4178:         } else {
                   4179:             #some.name.com
                   4180:             if (!defined($name)) {
                   4181:                 use Socket;
                   4182:                 my $netaddr=inet_aton($ip);
                   4183:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4184:             }
                   4185:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4186:         }
                   4187:         if ($allowed) { last; }
                   4188:     }
                   4189:     return $allowed;
                   4190: }
                   4191: 
                   4192: ###############################################
                   4193: 
1.60      matthew  4194: =pod
                   4195: 
1.112     bowersj2 4196: =head1 Domain Template Functions
                   4197: 
                   4198: =over 4
                   4199: 
                   4200: =item * &determinedomain()
1.60      matthew  4201: 
                   4202: Inputs: $domain (usually will be undef)
                   4203: 
1.63      www      4204: Returns: Determines which domain should be used for designs
1.60      matthew  4205: 
                   4206: =cut
1.54      www      4207: 
1.60      matthew  4208: ###############################################
1.63      www      4209: sub determinedomain {
                   4210:     my $domain=shift;
1.531     albertel 4211:     if (! $domain) {
1.60      matthew  4212:         # Determine domain if we have not been given one
1.893     raeburn  4213:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 4214:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4215:         if ($env{'request.role.domain'}) { 
                   4216:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4217:         }
                   4218:     }
1.63      www      4219:     return $domain;
                   4220: }
                   4221: ###############################################
1.517     raeburn  4222: 
1.518     albertel 4223: sub devalidate_domconfig_cache {
                   4224:     my ($udom)=@_;
                   4225:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4226: }
                   4227: 
                   4228: # ---------------------- Get domain configuration for a domain
                   4229: sub get_domainconf {
                   4230:     my ($udom) = @_;
                   4231:     my $cachetime=1800;
                   4232:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4233:     if (defined($cached)) { return %{$result}; }
                   4234: 
                   4235:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  4236: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  4237:     my (%designhash,%legacy);
1.518     albertel 4238:     if (keys(%domconfig) > 0) {
                   4239:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4240:             if (keys(%{$domconfig{'login'}})) {
                   4241:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4242:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946     raeburn  4243:                         if ($key eq 'loginvia') {
                   4244:                             if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
                   4245:                                 my @ids = &Apache::lonnet::current_machine_ids();
                   4246:                                 foreach my $hostname (@ids) {
1.948     raeburn  4247:                                     if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
                   4248:                                         if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   4249:                                             my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   4250:                                             $designhash{$udom.'.login.loginvia'} = $server;
                   4251:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   4252: 
                   4253:                                                 $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   4254:                                             } else {
                   4255:                                                  $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
                   4256:                                             }
                   4257:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
                   4258:                                                 $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
                   4259:                                             }
1.946     raeburn  4260:                                         }
                   4261:                                     }
                   4262:                                 }
                   4263:                             }
                   4264:                         } else {
                   4265:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4266:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4267:                                     $domconfig{'login'}{$key}{$img};
                   4268:                             }
1.699     raeburn  4269:                         }
                   4270:                     } else {
                   4271:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4272:                     }
1.632     raeburn  4273:                 }
                   4274:             } else {
                   4275:                 $legacy{'login'} = 1;
1.518     albertel 4276:             }
1.632     raeburn  4277:         } else {
                   4278:             $legacy{'login'} = 1;
1.518     albertel 4279:         }
                   4280:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4281:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4282:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4283:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4284:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4285:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4286:                         }
1.518     albertel 4287:                     }
                   4288:                 }
1.632     raeburn  4289:             } else {
                   4290:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4291:             }
1.632     raeburn  4292:         } else {
                   4293:             $legacy{'rolecolors'} = 1;
1.518     albertel 4294:         }
1.948     raeburn  4295:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   4296:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   4297:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   4298:             }
                   4299:         }
1.632     raeburn  4300:         if (keys(%legacy) > 0) {
                   4301:             my %legacyhash = &get_legacy_domconf($udom);
                   4302:             foreach my $item (keys(%legacyhash)) {
                   4303:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4304:                     if ($legacy{'login'}) { 
                   4305:                         $designhash{$item} = $legacyhash{$item};
                   4306:                     }
                   4307:                 } else {
                   4308:                     if ($legacy{'rolecolors'}) {
                   4309:                         $designhash{$item} = $legacyhash{$item};
                   4310:                     }
1.518     albertel 4311:                 }
                   4312:             }
                   4313:         }
1.632     raeburn  4314:     } else {
                   4315:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4316:     }
                   4317:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4318: 				  $cachetime);
                   4319:     return %designhash;
                   4320: }
                   4321: 
1.632     raeburn  4322: sub get_legacy_domconf {
                   4323:     my ($udom) = @_;
                   4324:     my %legacyhash;
                   4325:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4326:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4327:     if (-e $designfile) {
                   4328:         if ( open (my $fh,"<$designfile") ) {
                   4329:             while (my $line = <$fh>) {
                   4330:                 next if ($line =~ /^\#/);
                   4331:                 chomp($line);
                   4332:                 my ($key,$val)=(split(/\=/,$line));
                   4333:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4334:             }
                   4335:             close($fh);
                   4336:         }
                   4337:     }
                   4338:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   4339:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4340:     }
                   4341:     return %legacyhash;
                   4342: }
                   4343: 
1.63      www      4344: =pod
                   4345: 
1.112     bowersj2 4346: =item * &domainlogo()
1.63      www      4347: 
                   4348: Inputs: $domain (usually will be undef)
                   4349: 
                   4350: Returns: A link to a domain logo, if the domain logo exists.
                   4351: If the domain logo does not exist, a description of the domain.
                   4352: 
                   4353: =cut
1.112     bowersj2 4354: 
1.63      www      4355: ###############################################
                   4356: sub domainlogo {
1.517     raeburn  4357:     my $domain = &determinedomain(shift);
1.518     albertel 4358:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4359:     # See if there is a logo
                   4360:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4361:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4362:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4363: 	    if ($imgsrc =~ m{^/res/}) {
                   4364: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4365: 		&Apache::lonnet::repcopy($local_name);
                   4366: 	    }
                   4367: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4368:         } 
                   4369:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4370:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4371:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4372:     } else {
1.60      matthew  4373:         return '';
1.59      www      4374:     }
                   4375: }
1.63      www      4376: ##############################################
                   4377: 
                   4378: =pod
                   4379: 
1.112     bowersj2 4380: =item * &designparm()
1.63      www      4381: 
                   4382: Inputs: $which parameter; $domain (usually will be undef)
                   4383: 
                   4384: Returns: value of designparamter $which
                   4385: 
                   4386: =cut
1.112     bowersj2 4387: 
1.397     albertel 4388: 
1.400     albertel 4389: ##############################################
1.397     albertel 4390: sub designparm {
                   4391:     my ($which,$domain)=@_;
                   4392:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4393:         return $env{'environment.color.'.$which};
1.96      www      4394:     }
1.63      www      4395:     $domain=&determinedomain($domain);
1.518     albertel 4396:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  4397:     my $output;
1.517     raeburn  4398:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4399:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4400:     } else {
1.520     raeburn  4401:         $output = $defaultdesign{$which};
                   4402:     }
                   4403:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4404:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4405:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4406:             if ($output =~ m{^/res/}) {
                   4407:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4408:                 &Apache::lonnet::repcopy($local_name);
                   4409:             }
1.520     raeburn  4410:             $output = &lonhttpdurl($output);
                   4411:         }
1.63      www      4412:     }
1.520     raeburn  4413:     return $output;
1.63      www      4414: }
1.59      www      4415: 
1.822     bisitz   4416: ##############################################
                   4417: =pod
                   4418: 
1.832     bisitz   4419: =item * &authorspace()
                   4420: 
                   4421: Inputs: ./.
                   4422: 
                   4423: Returns: Path to the Construction Space of the current user's
                   4424:          accessed author space
                   4425:          The author space will be that of the current user
                   4426:          when accessing the own author space
                   4427:          and that of the co-author/assistent co-author
                   4428:          when accessing the co-author's/assistent co-author's
                   4429:          space
                   4430: 
                   4431: =cut
                   4432: 
                   4433: sub authorspace {
                   4434:     my $caname = '';
                   4435:     if ($env{'request.role'} =~ /^ca|^aa/) {
                   4436:         (undef,$caname) =
                   4437:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
                   4438:     } else {
                   4439:         $caname = $env{'user.name'};
                   4440:     }
                   4441:     return '/priv/'.$caname.'/';
                   4442: }
                   4443: 
                   4444: ##############################################
                   4445: =pod
                   4446: 
1.822     bisitz   4447: =item * &head_subbox()
                   4448: 
                   4449: Inputs: $content (contains HTML code with page functions, etc.)
                   4450: 
                   4451: Returns: HTML div with $content
                   4452:          To be included in page header
                   4453: 
                   4454: =cut
                   4455: 
                   4456: sub head_subbox {
                   4457:     my ($content)=@_;
                   4458:     my $output =
1.844     bisitz   4459:         '<div id="LC_head_subbox">'
1.822     bisitz   4460:        .$content
                   4461:        .'</div>'
                   4462: }
                   4463: 
                   4464: ##############################################
                   4465: =pod
                   4466: 
                   4467: =item * &CSTR_pageheader()
                   4468: 
                   4469: Inputs: ./.
                   4470: 
                   4471: Returns: HTML div with CSTR path and recent box
                   4472:          To be included on Construction Space pages
                   4473: 
                   4474: =cut
                   4475: 
                   4476: sub CSTR_pageheader {
                   4477:     # this is for resources; directories have customtitle, and crumbs
                   4478:             # and select recent are created in lonpubdir.pm  
                   4479:     my ($uname,$thisdisfn)=
                   4480:         ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
                   4481:     my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   4482:     $formaction=~s/\/+/\//g;
                   4483: 
                   4484:     my $parentpath = '';
                   4485:     my $lastitem = '';
                   4486:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4487:         $parentpath = $1;
                   4488:         $lastitem = $2;
                   4489:     } else {
                   4490:         $lastitem = $thisdisfn;
                   4491:     }
1.921     bisitz   4492: 
                   4493:     my $output =
1.822     bisitz   4494:          '<div>'
                   4495:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4496:         .'<b>'.&mt('Construction Space:').'</b> '
                   4497:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   4498:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
                   4499:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
                   4500: 
                   4501:     if ($lastitem) {
                   4502:         $output .=
                   4503:              '<span class="LC_filename">'
                   4504:             .$lastitem
                   4505:             .'</span>';
                   4506:     }
                   4507:     $output .=
                   4508:          '<br />'
1.822     bisitz   4509:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4510:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4511:         .'</form>'
                   4512:         .&Apache::lonmenu::constspaceform()
                   4513:         .'</div>';
1.921     bisitz   4514: 
                   4515:     return $output;
1.822     bisitz   4516: }
                   4517: 
1.60      matthew  4518: ###############################################
                   4519: ###############################################
                   4520: 
                   4521: =pod
                   4522: 
1.112     bowersj2 4523: =back
                   4524: 
1.549     albertel 4525: =head1 HTML Helpers
1.112     bowersj2 4526: 
                   4527: =over 4
                   4528: 
                   4529: =item * &bodytag()
1.60      matthew  4530: 
                   4531: Returns a uniform header for LON-CAPA web pages.
                   4532: 
                   4533: Inputs: 
                   4534: 
1.112     bowersj2 4535: =over 4
                   4536: 
                   4537: =item * $title, A title to be displayed on the page.
                   4538: 
                   4539: =item * $function, the current role (can be undef).
                   4540: 
                   4541: =item * $addentries, extra parameters for the <body> tag.
                   4542: 
                   4543: =item * $bodyonly, if defined, only return the <body> tag.
                   4544: 
                   4545: =item * $domain, if defined, force a given domain.
                   4546: 
                   4547: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4548:             text interface only)
1.60      matthew  4549: 
1.814     bisitz   4550: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4551:                      navigational links
1.317     albertel 4552: 
1.338     albertel 4553: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4554: 
1.460     albertel 4555: =item * $args, optional argument valid values are
                   4556:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4557:             inherit_jsmath -> when creating popup window in a page,
                   4558:                               should it have jsmath forced on by the
                   4559:                               current page
1.460     albertel 4560: 
1.112     bowersj2 4561: =back
                   4562: 
1.60      matthew  4563: Returns: A uniform header for LON-CAPA web pages.  
                   4564: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4565: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4566: other decorations will be returned.
                   4567: 
                   4568: =cut
                   4569: 
1.54      www      4570: sub bodytag {
1.831     bisitz   4571:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962     droeschl 4572:         $no_nav_bar,$bgcolor,$args)=@_;
1.339     albertel 4573: 
1.954     raeburn  4574:     my $public;
                   4575:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   4576:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   4577:         $public = 1;
                   4578:     }
1.460     albertel 4579:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4580: 
1.183     matthew  4581:     $function = &get_users_function() if (!$function);
1.339     albertel 4582:     my $img =    &designparm($function.'.img',$domain);
                   4583:     my $font =   &designparm($function.'.font',$domain);
                   4584:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4585: 
1.803     bisitz   4586:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4587: 		   'bgcolor' => $pgbg,
1.339     albertel 4588: 		   'text'    => $font,
                   4589:                    'alink'   => &designparm($function.'.alink',$domain),
                   4590: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4591: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4592:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4593: 
1.63      www      4594:  # role and realm
1.378     raeburn  4595:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4596:     if ($role  eq 'ca') {
1.479     albertel 4597:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4598:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4599:     } 
1.55      www      4600: # realm
1.258     albertel 4601:     if ($env{'request.course.id'}) {
1.378     raeburn  4602:         if ($env{'request.role'} !~ /^cr/) {
                   4603:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4604:         }
1.898     raeburn  4605:         if ($env{'request.course.sec'}) {
                   4606:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   4607:         }   
1.359     albertel 4608: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4609:     } else {
                   4610:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4611:     }
1.433     albertel 4612: 
1.359     albertel 4613:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 4614: 
1.438     albertel 4615:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4616: 
1.101     www      4617: # construct main body tag
1.359     albertel 4618:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4619: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4620: 
1.530     albertel 4621:     if ($bodyonly) {
1.60      matthew  4622:         return $bodytag;
1.798     tempelho 4623:     } 
1.359     albertel 4624: 
1.410     albertel 4625:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954     raeburn  4626:     if ($public) {
1.433     albertel 4627: 	undef($role);
1.434     albertel 4628:     } else {
                   4629: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4630:     }
1.359     albertel 4631:     
1.762     bisitz   4632:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4633:     #
                   4634:     # Extra info if you are the DC
                   4635:     my $dc_info = '';
                   4636:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4637:                         $env{'course.'.$env{'request.course.id'}.
                   4638:                                  '.domain'}.'/'})) {
                   4639:         my $cid = $env{'request.course.id'};
1.917     raeburn  4640:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4641:         $dc_info =~ s/\s+$//;
1.359     albertel 4642:     }
                   4643: 
1.898     raeburn  4644:     $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853     droeschl 4645:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   4646: 
1.916     droeschl 4647:         if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') { 
                   4648:             return $bodytag; 
                   4649:         } 
1.903     droeschl 4650: 
                   4651:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   4652: 
                   4653:         #    if ($env{'request.state'} eq 'construct') {
                   4654:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4655:         #    }
                   4656: 
1.359     albertel 4657: 
                   4658: 
1.916     droeschl 4659:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917     raeburn  4660:              if ($dc_info) {
                   4661:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   4662:              }
1.916     droeschl 4663:              $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   4664:                 <em>$realm</em> $dc_info</div>|;
1.903     droeschl 4665:             return $bodytag;
                   4666:         }
1.894     droeschl 4667: 
1.927     raeburn  4668:         unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
                   4669:             $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
                   4670:         }
1.916     droeschl 4671: 
1.903     droeschl 4672:         $bodytag .= Apache::lonhtmlcommon::scripttag(
                   4673:             Apache::lonmenu::utilityfunctions(), 'start');
1.816     bisitz   4674: 
1.903     droeschl 4675:         $bodytag .= Apache::lonmenu::primary_menu();
1.852     droeschl 4676: 
1.917     raeburn  4677:         if ($dc_info) {
                   4678:             $dc_info = &dc_courseid_toggle($dc_info);
                   4679:         }
                   4680:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 4681: 
1.903     droeschl 4682:         #don't show menus for public users
1.954     raeburn  4683:         if (!$public){
1.903     droeschl 4684:             $bodytag .= Apache::lonmenu::secondary_menu();
                   4685:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  4686:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   4687:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 4688:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920     raeburn  4689:                                 $args->{'bread_crumbs'});
                   4690:             } elsif ($forcereg) { 
                   4691:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg);
                   4692:             }
1.903     droeschl 4693:         }else{
                   4694:             # this is to seperate menu from content when there's no secondary
                   4695:             # menu. Especially needed for public accessible ressources.
                   4696:             $bodytag .= '<hr style="clear:both" />';
                   4697:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  4698:         }
1.903     droeschl 4699: 
1.235     raeburn  4700:         return $bodytag;
1.182     matthew  4701: }
                   4702: 
1.917     raeburn  4703: sub dc_courseid_toggle {
                   4704:     my ($dc_info) = @_;
                   4705:     return ' <span id="dccidtext" class="LC_cusr_subheading">'.
                   4706:            '<a href="javascript:showCourseID();">'.
                   4707:            &mt('(More ...)').'</a></span>'.
                   4708:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   4709: }
                   4710: 
1.330     albertel 4711: sub make_attr_string {
                   4712:     my ($register,$attr_ref) = @_;
                   4713: 
                   4714:     if ($attr_ref && !ref($attr_ref)) {
                   4715: 	die("addentries Must be a hash ref ".
                   4716: 	    join(':',caller(1))." ".
                   4717: 	    join(':',caller(0))." ");
                   4718:     }
                   4719: 
                   4720:     if ($register) {
1.339     albertel 4721: 	my ($on_load,$on_unload);
                   4722: 	foreach my $key (keys(%{$attr_ref})) {
                   4723: 	    if      (lc($key) eq 'onload') {
                   4724: 		$on_load.=$attr_ref->{$key}.';';
                   4725: 		delete($attr_ref->{$key});
                   4726: 
                   4727: 	    } elsif (lc($key) eq 'onunload') {
                   4728: 		$on_unload.=$attr_ref->{$key}.';';
                   4729: 		delete($attr_ref->{$key});
                   4730: 	    }
                   4731: 	}
1.953     droeschl 4732: 	$attr_ref->{'onload'}  = $on_load;
                   4733: 	$attr_ref->{'onunload'}= $on_unload;
1.330     albertel 4734:     }
1.339     albertel 4735: 
1.330     albertel 4736:     my $attr_string;
                   4737:     foreach my $attr (keys(%$attr_ref)) {
                   4738: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4739:     }
                   4740:     return $attr_string;
                   4741: }
                   4742: 
                   4743: 
1.182     matthew  4744: ###############################################
1.251     albertel 4745: ###############################################
                   4746: 
                   4747: =pod
                   4748: 
                   4749: =item * &endbodytag()
                   4750: 
                   4751: Returns a uniform footer for LON-CAPA web pages.
                   4752: 
1.635     raeburn  4753: Inputs: 1 - optional reference to an args hash
                   4754: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4755: a 'Continue' link is not displayed if the page contains an
                   4756: internal redirect in the <head></head> section,
                   4757: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4758: 
                   4759: =cut
                   4760: 
                   4761: sub endbodytag {
1.635     raeburn  4762:     my ($args) = @_;
1.251     albertel 4763:     my $endbodytag='</body>';
1.269     albertel 4764:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4765:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4766:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4767: 	    $endbodytag=
                   4768: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4769: 	        &mt('Continue').'</a>'.
                   4770: 	        $endbodytag;
                   4771:         }
1.315     albertel 4772:     }
1.251     albertel 4773:     return $endbodytag;
                   4774: }
                   4775: 
1.352     albertel 4776: =pod
                   4777: 
                   4778: =item * &standard_css()
                   4779: 
                   4780: Returns a style sheet
                   4781: 
                   4782: Inputs: (all optional)
                   4783:             domain         -> force to color decorate a page for a specific
                   4784:                                domain
                   4785:             function       -> force usage of a specific rolish color scheme
                   4786:             bgcolor        -> override the default page bgcolor
                   4787: 
                   4788: =cut
                   4789: 
1.343     albertel 4790: sub standard_css {
1.345     albertel 4791:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4792:     $function  = &get_users_function() if (!$function);
                   4793:     my $img    = &designparm($function.'.img',   $domain);
                   4794:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4795:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4796:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4797: #second colour for later usage
1.345     albertel 4798:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4799:     my $pgbg_or_bgcolor =
                   4800: 	         $bgcolor ||
1.352     albertel 4801: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4802:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4803:     my $alink  = &designparm($function.'.alink', $domain);
                   4804:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4805:     my $link   = &designparm($function.'.link',  $domain);
                   4806: 
1.602     albertel 4807:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4808:     my $mono                 = 'monospace';
1.850     bisitz   4809:     my $data_table_head      = $sidebg;
                   4810:     my $data_table_light     = '#FAFAFA';
                   4811:     my $data_table_dark      = '#F0F0F0';
1.470     banghart 4812:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4813:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4814:     my $mail_new             = '#FFBB77';
                   4815:     my $mail_new_hover       = '#DD9955';
                   4816:     my $mail_read            = '#BBBB77';
                   4817:     my $mail_read_hover      = '#999944';
                   4818:     my $mail_replied         = '#AAAA88';
                   4819:     my $mail_replied_hover   = '#888855';
                   4820:     my $mail_other           = '#99BBBB';
                   4821:     my $mail_other_hover     = '#669999';
1.391     albertel 4822:     my $table_header         = '#DDDDDD';
1.489     raeburn  4823:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   4824:     my $lg_border_color      = '#C8C8C8';
1.952     onken    4825:     my $button_hover         = '#BF2317';
1.392     albertel 4826: 
1.608     albertel 4827:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   4828:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   4829:                                              : '0 3px 0 4px';
1.448     albertel 4830: 
1.523     albertel 4831: 
1.343     albertel 4832:     return <<END;
1.947     droeschl 4833: 
                   4834: /* needed for iframe to allow 100% height in FF */
                   4835: body, html { 
                   4836:     margin: 0;
                   4837:     padding: 0 0.5%;
                   4838:     height: 99%; /* to avoid scrollbars */
                   4839: }
                   4840: 
1.795     www      4841: body {
1.911     bisitz   4842:   font-family: $sans;
                   4843:   line-height:130%;
                   4844:   font-size:0.83em;
                   4845:   color:$font;
1.795     www      4846: }
                   4847: 
1.959     onken    4848: a:focus,
                   4849: a:focus img {
1.795     www      4850:   color: red;
1.911     bisitz   4851:   background: yellow;
1.795     www      4852: }
1.698     harmsja  4853: 
1.911     bisitz   4854: form, .inline {
                   4855:   display: inline;
1.795     www      4856: }
1.721     harmsja  4857: 
1.795     www      4858: .LC_right {
1.911     bisitz   4859:   text-align:right;
1.795     www      4860: }
                   4861: 
                   4862: .LC_middle {
1.911     bisitz   4863:   vertical-align:middle;
1.795     www      4864: }
1.721     harmsja  4865: 
1.911     bisitz   4866: .LC_400Box {
                   4867:   width:400px;
                   4868: }
1.721     harmsja  4869: 
1.947     droeschl 4870: .LC_iframecontainer {
                   4871:     width: 98%;
                   4872:     margin: 0;
                   4873:     position: fixed;
                   4874:     top: 8.5em;
                   4875:     bottom: 0;
                   4876: }
                   4877: 
                   4878: .LC_iframecontainer iframe{
                   4879:     border: none;
                   4880:     width: 100%;
                   4881:     height: 100%;
                   4882: }
                   4883: 
1.778     bisitz   4884: .LC_filename {
                   4885:   font-family: $mono;
                   4886:   white-space:pre;
1.921     bisitz   4887:   font-size: 120%;
1.778     bisitz   4888: }
                   4889: 
                   4890: .LC_fileicon {
                   4891:   border: none;
                   4892:   height: 1.3em;
                   4893:   vertical-align: text-bottom;
                   4894:   margin-right: 0.3em;
                   4895:   text-decoration:none;
                   4896: }
                   4897: 
1.350     albertel 4898: .LC_error {
                   4899:   color: red;
                   4900:   font-size: larger;
                   4901: }
1.795     www      4902: 
1.457     albertel 4903: .LC_warning,
                   4904: .LC_diff_removed {
1.733     bisitz   4905:   color: red;
1.394     albertel 4906: }
1.532     albertel 4907: 
                   4908: .LC_info,
1.457     albertel 4909: .LC_success,
                   4910: .LC_diff_added {
1.350     albertel 4911:   color: green;
                   4912: }
1.795     www      4913: 
1.802     bisitz   4914: div.LC_confirm_box {
                   4915:   background-color: #FAFAFA;
                   4916:   border: 1px solid $lg_border_color;
                   4917:   margin-right: 0;
                   4918:   padding: 5px;
                   4919: }
                   4920: 
                   4921: div.LC_confirm_box .LC_error img,
                   4922: div.LC_confirm_box .LC_success img {
                   4923:   vertical-align: middle;
                   4924: }
                   4925: 
1.440     albertel 4926: .LC_icon {
1.771     droeschl 4927:   border: none;
1.790     droeschl 4928:   vertical-align: middle;
1.771     droeschl 4929: }
                   4930: 
1.543     albertel 4931: .LC_docs_spacer {
                   4932:   width: 25px;
                   4933:   height: 1px;
1.771     droeschl 4934:   border: none;
1.543     albertel 4935: }
1.346     albertel 4936: 
1.532     albertel 4937: .LC_internal_info {
1.735     bisitz   4938:   color: #999999;
1.532     albertel 4939: }
                   4940: 
1.794     www      4941: .LC_discussion {
1.911     bisitz   4942:   background: $tabbg;
                   4943:   border: 1px solid black;
                   4944:   margin: 2px;
1.794     www      4945: }
                   4946: 
                   4947: .LC_disc_action_links_bar {
1.911     bisitz   4948:   background: $tabbg;
                   4949:   border: none;
                   4950:   margin: 4px;
1.794     www      4951: }
                   4952: 
                   4953: .LC_disc_action_left {
1.911     bisitz   4954:   text-align: left;
1.794     www      4955: }
                   4956: 
                   4957: .LC_disc_action_right {
1.911     bisitz   4958:   text-align: right;
1.794     www      4959: }
                   4960: 
                   4961: .LC_disc_new_item {
1.911     bisitz   4962:   background: white;
                   4963:   border: 2px solid red;
                   4964:   margin: 2px;
1.794     www      4965: }
                   4966: 
                   4967: .LC_disc_old_item {
1.911     bisitz   4968:   background: white;
                   4969:   border: 1px solid black;
                   4970:   margin: 2px;
1.794     www      4971: }
                   4972: 
1.458     albertel 4973: table.LC_pastsubmission {
                   4974:   border: 1px solid black;
                   4975:   margin: 2px;
                   4976: }
                   4977: 
1.924     bisitz   4978: table#LC_menubuttons {
1.345     albertel 4979:   width: 100%;
                   4980:   background: $pgbg;
1.392     albertel 4981:   border: 2px;
1.402     albertel 4982:   border-collapse: separate;
1.803     bisitz   4983:   padding: 0;
1.345     albertel 4984: }
1.392     albertel 4985: 
1.801     tempelho 4986: table#LC_title_bar a {
                   4987:   color: $fontmenu;
                   4988: }
1.836     bisitz   4989: 
1.807     droeschl 4990: table#LC_title_bar {
1.819     tempelho 4991:   clear: both;
1.836     bisitz   4992:   display: none;
1.807     droeschl 4993: }
                   4994: 
1.795     www      4995: table#LC_title_bar,
1.933     droeschl 4996: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 4997: table#LC_title_bar.LC_with_remote {
1.359     albertel 4998:   width: 100%;
1.392     albertel 4999:   border-color: $pgbg;
                   5000:   border-style: solid;
                   5001:   border-width: $border;
1.379     albertel 5002:   background: $pgbg;
1.801     tempelho 5003:   color: $fontmenu;
1.392     albertel 5004:   border-collapse: collapse;
1.803     bisitz   5005:   padding: 0;
1.819     tempelho 5006:   margin: 0;
1.359     albertel 5007: }
1.795     www      5008: 
1.933     droeschl 5009: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 5010:     margin: 0;
                   5011:     padding: 0;
1.933     droeschl 5012:     position: relative;
                   5013:     list-style: none;
1.913     droeschl 5014: }
1.933     droeschl 5015: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 5016:     display: inline;
                   5017: }
1.933     droeschl 5018: 
                   5019: .LC_breadcrumb_tools_navigation {
1.913     droeschl 5020:     padding: 0;
1.933     droeschl 5021:     margin: 0;
                   5022:     float: left;
1.913     droeschl 5023: }
1.933     droeschl 5024: .LC_breadcrumb_tools_tools {
                   5025:     padding: 0;
                   5026:     margin: 0;
1.913     droeschl 5027:     float: right;
                   5028: }
                   5029: 
1.359     albertel 5030: table#LC_title_bar td {
                   5031:   background: $tabbg;
                   5032: }
1.795     www      5033: 
1.911     bisitz   5034: table#LC_menubuttons img {
1.803     bisitz   5035:   border: none;
1.346     albertel 5036: }
1.795     www      5037: 
1.842     droeschl 5038: .LC_breadcrumbs_component {
1.911     bisitz   5039:   float: right;
                   5040:   margin: 0 1em;
1.357     albertel 5041: }
1.842     droeschl 5042: .LC_breadcrumbs_component img {
1.911     bisitz   5043:   vertical-align: middle;
1.777     tempelho 5044: }
1.795     www      5045: 
1.383     albertel 5046: td.LC_table_cell_checkbox {
                   5047:   text-align: center;
                   5048: }
1.795     www      5049: 
                   5050: .LC_fontsize_small {
1.911     bisitz   5051:   font-size: 70%;
1.705     tempelho 5052: }
                   5053: 
1.844     bisitz   5054: #LC_breadcrumbs {
1.911     bisitz   5055:   clear:both;
                   5056:   background: $sidebg;
                   5057:   border-bottom: 1px solid $lg_border_color;
                   5058:   line-height: 2.5em;
1.933     droeschl 5059:   overflow: hidden;
1.911     bisitz   5060:   margin: 0;
                   5061:   padding: 0;
1.819     tempelho 5062: }
1.862     bisitz   5063: 
1.844     bisitz   5064: #LC_head_subbox {
1.911     bisitz   5065:   clear:both;
                   5066:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 5067:   border: 1px solid $sidebg;
                   5068:   margin: 0 0 10px 0;      
1.966     bisitz   5069:   padding: 3px;
1.822     bisitz   5070: }
                   5071: 
1.795     www      5072: .LC_fontsize_medium {
1.911     bisitz   5073:   font-size: 85%;
1.705     tempelho 5074: }
                   5075: 
1.795     www      5076: .LC_fontsize_large {
1.911     bisitz   5077:   font-size: 120%;
1.705     tempelho 5078: }
                   5079: 
1.346     albertel 5080: .LC_menubuttons_inline_text {
                   5081:   color: $font;
1.698     harmsja  5082:   font-size: 90%;
1.701     harmsja  5083:   padding-left:3px;
1.346     albertel 5084: }
                   5085: 
1.934     droeschl 5086: .LC_menubuttons_inline_text img{
                   5087:   vertical-align: middle;
                   5088: }
                   5089: 
1.951     onken    5090: li.LC_menubuttons_inline_text img,a {
                   5091:   cursor:pointer;
                   5092: }
                   5093: 
1.526     www      5094: .LC_menubuttons_link {
                   5095:   text-decoration: none;
                   5096: }
1.795     www      5097: 
1.522     albertel 5098: .LC_menubuttons_category {
1.521     www      5099:   color: $font;
1.526     www      5100:   background: $pgbg;
1.521     www      5101:   font-size: larger;
                   5102:   font-weight: bold;
                   5103: }
                   5104: 
1.346     albertel 5105: td.LC_menubuttons_text {
1.911     bisitz   5106:   color: $font;
1.346     albertel 5107: }
1.706     harmsja  5108: 
1.346     albertel 5109: .LC_current_location {
                   5110:   background: $tabbg;
                   5111: }
1.795     www      5112: 
1.938     bisitz   5113: table.LC_data_table {
1.347     albertel 5114:   border: 1px solid #000000;
1.402     albertel 5115:   border-collapse: separate;
1.426     albertel 5116:   border-spacing: 1px;
1.610     albertel 5117:   background: $pgbg;
1.347     albertel 5118: }
1.795     www      5119: 
1.422     albertel 5120: .LC_data_table_dense {
                   5121:   font-size: small;
                   5122: }
1.795     www      5123: 
1.507     raeburn  5124: table.LC_nested_outer {
                   5125:   border: 1px solid #000000;
1.589     raeburn  5126:   border-collapse: collapse;
1.803     bisitz   5127:   border-spacing: 0;
1.507     raeburn  5128:   width: 100%;
                   5129: }
1.795     www      5130: 
1.879     raeburn  5131: table.LC_innerpickbox,
1.507     raeburn  5132: table.LC_nested {
1.803     bisitz   5133:   border: none;
1.589     raeburn  5134:   border-collapse: collapse;
1.803     bisitz   5135:   border-spacing: 0;
1.507     raeburn  5136:   width: 100%;
                   5137: }
1.795     www      5138: 
1.930     faziophi 5139: .ui-accordion,
                   5140: .ui-accordion table.LC_data_table,
                   5141: .ui-accordion table.LC_nested_outer{
                   5142:   border: 0px;
                   5143:   border-spacing: 0px;
                   5144:   margin: 3px;
                   5145: }
                   5146: 
1.911     bisitz   5147: table.LC_data_table tr th,
                   5148: table.LC_calendar tr th,
1.879     raeburn  5149: table.LC_prior_tries tr th,
                   5150: table.LC_innerpickbox tr th {
1.349     albertel 5151:   font-weight: bold;
                   5152:   background-color: $data_table_head;
1.801     tempelho 5153:   color:$fontmenu;
1.701     harmsja  5154:   font-size:90%;
1.347     albertel 5155: }
1.795     www      5156: 
1.879     raeburn  5157: table.LC_innerpickbox tr th,
                   5158: table.LC_innerpickbox tr td {
                   5159:   vertical-align: top;
                   5160: }
                   5161: 
1.711     raeburn  5162: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   5163:   background-color: #CCCCCC;
1.711     raeburn  5164:   font-weight: bold;
                   5165:   text-align: left;
                   5166: }
1.795     www      5167: 
1.912     bisitz   5168: table.LC_data_table tr.LC_odd_row > td {
                   5169:   background-color: $data_table_light;
                   5170:   padding: 2px;
                   5171:   vertical-align: top;
                   5172: }
                   5173: 
1.809     bisitz   5174: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 5175:   background-color: $data_table_light;
1.912     bisitz   5176:   vertical-align: top;
                   5177: }
                   5178: 
                   5179: table.LC_data_table tr.LC_even_row > td {
                   5180:   background-color: $data_table_dark;
1.425     albertel 5181:   padding: 2px;
1.900     bisitz   5182:   vertical-align: top;
1.347     albertel 5183: }
1.795     www      5184: 
1.809     bisitz   5185: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5186:   background-color: $data_table_dark;
1.900     bisitz   5187:   vertical-align: top;
1.347     albertel 5188: }
1.795     www      5189: 
1.425     albertel 5190: table.LC_data_table tr.LC_data_table_highlight td {
                   5191:   background-color: $data_table_darker;
                   5192: }
1.795     www      5193: 
1.639     raeburn  5194: table.LC_data_table tr td.LC_leftcol_header {
                   5195:   background-color: $data_table_head;
                   5196:   font-weight: bold;
                   5197: }
1.795     www      5198: 
1.451     albertel 5199: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5200: table.LC_nested tr.LC_empty_row td {
1.421     albertel 5201:   font-weight: bold;
                   5202:   font-style: italic;
                   5203:   text-align: center;
                   5204:   padding: 8px;
1.347     albertel 5205: }
1.795     www      5206: 
1.940     bisitz   5207: table.LC_data_table tr.LC_empty_row td {
                   5208:   background-color: $sidebg;
                   5209: }
                   5210: 
                   5211: table.LC_nested tr.LC_empty_row td {
                   5212:   background-color: #FFFFFF;
                   5213: }
                   5214: 
1.890     droeschl 5215: table.LC_caption {
                   5216: }
                   5217: 
1.507     raeburn  5218: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5219:   padding: 4ex
                   5220: }
1.795     www      5221: 
1.507     raeburn  5222: table.LC_nested_outer tr th {
                   5223:   font-weight: bold;
1.801     tempelho 5224:   color:$fontmenu;
1.507     raeburn  5225:   background-color: $data_table_head;
1.701     harmsja  5226:   font-size: small;
1.507     raeburn  5227:   border-bottom: 1px solid #000000;
                   5228: }
1.795     www      5229: 
1.507     raeburn  5230: table.LC_nested_outer tr td.LC_subheader {
                   5231:   background-color: $data_table_head;
                   5232:   font-weight: bold;
                   5233:   font-size: small;
                   5234:   border-bottom: 1px solid #000000;
                   5235:   text-align: right;
1.451     albertel 5236: }
1.795     www      5237: 
1.507     raeburn  5238: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5239:   background-color: #CCCCCC;
1.451     albertel 5240:   font-weight: bold;
                   5241:   font-size: small;
1.507     raeburn  5242:   text-align: center;
                   5243: }
1.795     www      5244: 
1.589     raeburn  5245: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5246: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5247:   text-align: left;
1.451     albertel 5248: }
1.795     www      5249: 
1.507     raeburn  5250: table.LC_nested td {
1.735     bisitz   5251:   background-color: #FFFFFF;
1.451     albertel 5252:   font-size: small;
1.507     raeburn  5253: }
1.795     www      5254: 
1.507     raeburn  5255: table.LC_nested_outer tr th.LC_right_item,
                   5256: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5257: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5258: table.LC_nested tr td.LC_right_item {
1.451     albertel 5259:   text-align: right;
                   5260: }
                   5261: 
1.930     faziophi 5262: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
                   5263: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
                   5264:   text-align: right;
                   5265:   width: 40%;
                   5266:   padding-right:10px;
                   5267:   vertical-align: top;
                   5268:   padding: 5px;
                   5269: }
                   5270: 
                   5271: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5272: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
                   5273:   text-align: left;
                   5274:   width: 60%;
                   5275:   padding: 2px 4px;
                   5276: }
                   5277: 
1.507     raeburn  5278: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5279:   background-color: #EEEEEE;
1.451     albertel 5280: }
                   5281: 
1.473     raeburn  5282: table.LC_createuser {
                   5283: }
                   5284: 
                   5285: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5286:   font-size: small;
1.473     raeburn  5287: }
                   5288: 
                   5289: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5290:   background-color: #CCCCCC;
1.473     raeburn  5291:   font-weight: bold;
                   5292:   text-align: center;
                   5293: }
                   5294: 
1.349     albertel 5295: table.LC_calendar {
                   5296:   border: 1px solid #000000;
                   5297:   border-collapse: collapse;
1.917     raeburn  5298:   width: 98%;
1.349     albertel 5299: }
1.795     www      5300: 
1.349     albertel 5301: table.LC_calendar_pickdate {
                   5302:   font-size: xx-small;
                   5303: }
1.795     www      5304: 
1.349     albertel 5305: table.LC_calendar tr td {
                   5306:   border: 1px solid #000000;
                   5307:   vertical-align: top;
1.917     raeburn  5308:   width: 14%;
1.349     albertel 5309: }
1.795     www      5310: 
1.349     albertel 5311: table.LC_calendar tr td.LC_calendar_day_empty {
                   5312:   background-color: $data_table_dark;
                   5313: }
1.795     www      5314: 
1.779     bisitz   5315: table.LC_calendar tr td.LC_calendar_day_current {
                   5316:   background-color: $data_table_highlight;
1.777     tempelho 5317: }
1.795     www      5318: 
1.938     bisitz   5319: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 5320:   background-color: $mail_new;
                   5321: }
1.795     www      5322: 
1.938     bisitz   5323: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 5324:   background-color: $mail_new_hover;
                   5325: }
1.795     www      5326: 
1.938     bisitz   5327: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 5328:   background-color: $mail_read;
                   5329: }
1.795     www      5330: 
1.938     bisitz   5331: /*
                   5332: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 5333:   background-color: $mail_read_hover;
                   5334: }
1.938     bisitz   5335: */
1.795     www      5336: 
1.938     bisitz   5337: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 5338:   background-color: $mail_replied;
                   5339: }
1.795     www      5340: 
1.938     bisitz   5341: /*
                   5342: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 5343:   background-color: $mail_replied_hover;
                   5344: }
1.938     bisitz   5345: */
1.795     www      5346: 
1.938     bisitz   5347: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 5348:   background-color: $mail_other;
                   5349: }
1.795     www      5350: 
1.938     bisitz   5351: /*
                   5352: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 5353:   background-color: $mail_other_hover;
                   5354: }
1.938     bisitz   5355: */
1.494     raeburn  5356: 
1.777     tempelho 5357: table.LC_data_table tr > td.LC_browser_file,
                   5358: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5359:   background: #AAEE77;
1.389     albertel 5360: }
1.795     www      5361: 
1.777     tempelho 5362: table.LC_data_table tr > td.LC_browser_file_locked,
                   5363: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5364:   background: #FFAA99;
1.387     albertel 5365: }
1.795     www      5366: 
1.777     tempelho 5367: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5368:   background: #888888;
1.779     bisitz   5369: }
1.795     www      5370: 
1.777     tempelho 5371: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5372: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5373:   background: #F8F866;
1.777     tempelho 5374: }
1.795     www      5375: 
1.696     bisitz   5376: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5377:   background: #E0E8FF;
1.387     albertel 5378: }
1.696     bisitz   5379: 
1.707     bisitz   5380: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   5381:   /* background: #77FF77; */
1.707     bisitz   5382: }
1.795     www      5383: 
1.707     bisitz   5384: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   5385:   border-right: 8px solid #FFFF77;
1.707     bisitz   5386: }
1.795     www      5387: 
1.707     bisitz   5388: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   5389:   border-right: 8px solid #FFAA77;
1.707     bisitz   5390: }
1.795     www      5391: 
1.707     bisitz   5392: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   5393:   border-right: 8px solid #FF7777;
1.707     bisitz   5394: }
1.795     www      5395: 
1.707     bisitz   5396: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   5397:   border-right: 8px solid #AAFF77;
1.707     bisitz   5398: }
1.795     www      5399: 
1.707     bisitz   5400: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   5401:   border-right: 8px solid #11CC55;
1.707     bisitz   5402: }
                   5403: 
1.388     albertel 5404: span.LC_current_location {
1.701     harmsja  5405:   font-size:larger;
1.388     albertel 5406:   background: $pgbg;
                   5407: }
1.387     albertel 5408: 
1.395     albertel 5409: span.LC_parm_menu_item {
                   5410:   font-size: larger;
                   5411: }
1.795     www      5412: 
1.395     albertel 5413: span.LC_parm_scope_all {
                   5414:   color: red;
                   5415: }
1.795     www      5416: 
1.395     albertel 5417: span.LC_parm_scope_folder {
                   5418:   color: green;
                   5419: }
1.795     www      5420: 
1.395     albertel 5421: span.LC_parm_scope_resource {
                   5422:   color: orange;
                   5423: }
1.795     www      5424: 
1.395     albertel 5425: span.LC_parm_part {
                   5426:   color: blue;
                   5427: }
1.795     www      5428: 
1.911     bisitz   5429: span.LC_parm_folder,
                   5430: span.LC_parm_symb {
1.395     albertel 5431:   font-size: x-small;
                   5432:   font-family: $mono;
                   5433:   color: #AAAAAA;
                   5434: }
                   5435: 
1.795     www      5436: td.LC_parm_overview_level_menu,
                   5437: td.LC_parm_overview_map_menu,
                   5438: td.LC_parm_overview_parm_selectors,
                   5439: td.LC_parm_overview_restrictions  {
1.396     albertel 5440:   border: 1px solid black;
                   5441:   border-collapse: collapse;
                   5442: }
1.795     www      5443: 
1.396     albertel 5444: table.LC_parm_overview_restrictions td {
                   5445:   border-width: 1px 4px 1px 4px;
                   5446:   border-style: solid;
                   5447:   border-color: $pgbg;
                   5448:   text-align: center;
                   5449: }
1.795     www      5450: 
1.396     albertel 5451: table.LC_parm_overview_restrictions th {
                   5452:   background: $tabbg;
                   5453:   border-width: 1px 4px 1px 4px;
                   5454:   border-style: solid;
                   5455:   border-color: $pgbg;
                   5456: }
1.795     www      5457: 
1.398     albertel 5458: table#LC_helpmenu {
1.803     bisitz   5459:   border: none;
1.398     albertel 5460:   height: 55px;
1.803     bisitz   5461:   border-spacing: 0;
1.398     albertel 5462: }
                   5463: 
                   5464: table#LC_helpmenu fieldset legend {
                   5465:   font-size: larger;
                   5466: }
1.795     www      5467: 
1.397     albertel 5468: table#LC_helpmenu_links {
                   5469:   width: 100%;
                   5470:   border: 1px solid black;
                   5471:   background: $pgbg;
1.803     bisitz   5472:   padding: 0;
1.397     albertel 5473:   border-spacing: 1px;
                   5474: }
1.795     www      5475: 
1.397     albertel 5476: table#LC_helpmenu_links tr td {
                   5477:   padding: 1px;
                   5478:   background: $tabbg;
1.399     albertel 5479:   text-align: center;
                   5480:   font-weight: bold;
1.397     albertel 5481: }
1.396     albertel 5482: 
1.795     www      5483: table#LC_helpmenu_links a:link,
                   5484: table#LC_helpmenu_links a:visited,
1.397     albertel 5485: table#LC_helpmenu_links a:active {
                   5486:   text-decoration: none;
                   5487:   color: $font;
                   5488: }
1.795     www      5489: 
1.397     albertel 5490: table#LC_helpmenu_links a:hover {
                   5491:   text-decoration: underline;
                   5492:   color: $vlink;
                   5493: }
1.396     albertel 5494: 
1.417     albertel 5495: .LC_chrt_popup_exists {
                   5496:   border: 1px solid #339933;
                   5497:   margin: -1px;
                   5498: }
1.795     www      5499: 
1.417     albertel 5500: .LC_chrt_popup_up {
                   5501:   border: 1px solid yellow;
                   5502:   margin: -1px;
                   5503: }
1.795     www      5504: 
1.417     albertel 5505: .LC_chrt_popup {
                   5506:   border: 1px solid #8888FF;
                   5507:   background: #CCCCFF;
                   5508: }
1.795     www      5509: 
1.421     albertel 5510: table.LC_pick_box {
                   5511:   border-collapse: separate;
                   5512:   background: white;
                   5513:   border: 1px solid black;
                   5514:   border-spacing: 1px;
                   5515: }
1.795     www      5516: 
1.421     albertel 5517: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5518:   background: $sidebg;
1.421     albertel 5519:   font-weight: bold;
1.900     bisitz   5520:   text-align: left;
1.740     bisitz   5521:   vertical-align: top;
1.421     albertel 5522:   width: 184px;
                   5523:   padding: 8px;
                   5524: }
1.795     www      5525: 
1.579     raeburn  5526: table.LC_pick_box td.LC_pick_box_value {
                   5527:   text-align: left;
                   5528:   padding: 8px;
                   5529: }
1.795     www      5530: 
1.579     raeburn  5531: table.LC_pick_box td.LC_pick_box_select {
                   5532:   text-align: left;
                   5533:   padding: 8px;
                   5534: }
1.795     www      5535: 
1.424     albertel 5536: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5537:   padding: 0;
1.421     albertel 5538:   height: 1px;
                   5539:   background: black;
                   5540: }
1.795     www      5541: 
1.421     albertel 5542: table.LC_pick_box td.LC_pick_box_submit {
                   5543:   text-align: right;
                   5544: }
1.795     www      5545: 
1.579     raeburn  5546: table.LC_pick_box td.LC_evenrow_value {
                   5547:   text-align: left;
                   5548:   padding: 8px;
                   5549:   background-color: $data_table_light;
                   5550: }
1.795     www      5551: 
1.579     raeburn  5552: table.LC_pick_box td.LC_oddrow_value {
                   5553:   text-align: left;
                   5554:   padding: 8px;
                   5555:   background-color: $data_table_light;
                   5556: }
1.795     www      5557: 
1.579     raeburn  5558: span.LC_helpform_receipt_cat {
                   5559:   font-weight: bold;
                   5560: }
1.795     www      5561: 
1.424     albertel 5562: table.LC_group_priv_box {
                   5563:   background: white;
                   5564:   border: 1px solid black;
                   5565:   border-spacing: 1px;
                   5566: }
1.795     www      5567: 
1.424     albertel 5568: table.LC_group_priv_box td.LC_pick_box_title {
                   5569:   background: $tabbg;
                   5570:   font-weight: bold;
                   5571:   text-align: right;
                   5572:   width: 184px;
                   5573: }
1.795     www      5574: 
1.424     albertel 5575: table.LC_group_priv_box td.LC_groups_fixed {
                   5576:   background: $data_table_light;
                   5577:   text-align: center;
                   5578: }
1.795     www      5579: 
1.424     albertel 5580: table.LC_group_priv_box td.LC_groups_optional {
                   5581:   background: $data_table_dark;
                   5582:   text-align: center;
                   5583: }
1.795     www      5584: 
1.424     albertel 5585: table.LC_group_priv_box td.LC_groups_functionality {
                   5586:   background: $data_table_darker;
                   5587:   text-align: center;
                   5588:   font-weight: bold;
                   5589: }
1.795     www      5590: 
1.424     albertel 5591: table.LC_group_priv td {
                   5592:   text-align: left;
1.803     bisitz   5593:   padding: 0;
1.424     albertel 5594: }
                   5595: 
                   5596: .LC_navbuttons {
                   5597:   margin: 2ex 0ex 2ex 0ex;
                   5598: }
1.795     www      5599: 
1.423     albertel 5600: .LC_topic_bar {
                   5601:   font-weight: bold;
                   5602:   background: $tabbg;
1.918     wenzelju 5603:   margin: 1em 0em 1em 2em;
1.805     bisitz   5604:   padding: 3px;
1.918     wenzelju 5605:   font-size: 1.2em;
1.423     albertel 5606: }
1.795     www      5607: 
1.423     albertel 5608: .LC_topic_bar span {
1.918     wenzelju 5609:   left: 0.5em;
                   5610:   position: absolute;
1.423     albertel 5611:   vertical-align: middle;
1.918     wenzelju 5612:   font-size: 1.2em;
1.423     albertel 5613: }
1.795     www      5614: 
1.423     albertel 5615: table.LC_course_group_status {
                   5616:   margin: 20px;
                   5617: }
1.795     www      5618: 
1.423     albertel 5619: table.LC_status_selector td {
                   5620:   vertical-align: top;
                   5621:   text-align: center;
1.424     albertel 5622:   padding: 4px;
                   5623: }
1.795     www      5624: 
1.599     albertel 5625: div.LC_feedback_link {
1.616     albertel 5626:   clear: both;
1.829     kalberla 5627:   background: $sidebg;
1.779     bisitz   5628:   width: 100%;
1.829     kalberla 5629:   padding-bottom: 10px;
                   5630:   border: 1px $tabbg solid;
1.833     kalberla 5631:   height: 22px;
                   5632:   line-height: 22px;
                   5633:   padding-top: 5px;
                   5634: }
                   5635: 
                   5636: div.LC_feedback_link img {
                   5637:   height: 22px;
1.867     kalberla 5638:   vertical-align:middle;
1.829     kalberla 5639: }
                   5640: 
1.911     bisitz   5641: div.LC_feedback_link a {
1.829     kalberla 5642:   text-decoration: none;
1.489     raeburn  5643: }
1.795     www      5644: 
1.867     kalberla 5645: div.LC_comblock {
1.911     bisitz   5646:   display:inline;
1.867     kalberla 5647:   color:$font;
                   5648:   font-size:90%;
                   5649: }
                   5650: 
                   5651: div.LC_feedback_link div.LC_comblock {
                   5652:   padding-left:5px;
                   5653: }
                   5654: 
                   5655: div.LC_feedback_link div.LC_comblock a {
                   5656:   color:$font;
                   5657: }
                   5658: 
1.489     raeburn  5659: span.LC_feedback_link {
1.858     bisitz   5660:   /* background: $feedback_link_bg; */
1.599     albertel 5661:   font-size: larger;
                   5662: }
1.795     www      5663: 
1.599     albertel 5664: span.LC_message_link {
1.858     bisitz   5665:   /* background: $feedback_link_bg; */
1.599     albertel 5666:   font-size: larger;
                   5667:   position: absolute;
                   5668:   right: 1em;
1.489     raeburn  5669: }
1.421     albertel 5670: 
1.515     albertel 5671: table.LC_prior_tries {
1.524     albertel 5672:   border: 1px solid #000000;
                   5673:   border-collapse: separate;
                   5674:   border-spacing: 1px;
1.515     albertel 5675: }
1.523     albertel 5676: 
1.515     albertel 5677: table.LC_prior_tries td {
1.524     albertel 5678:   padding: 2px;
1.515     albertel 5679: }
1.523     albertel 5680: 
                   5681: .LC_answer_correct {
1.795     www      5682:   background: lightgreen;
                   5683:   color: darkgreen;
                   5684:   padding: 6px;
1.523     albertel 5685: }
1.795     www      5686: 
1.523     albertel 5687: .LC_answer_charged_try {
1.797     www      5688:   background: #FFAAAA;
1.795     www      5689:   color: darkred;
                   5690:   padding: 6px;
1.523     albertel 5691: }
1.795     www      5692: 
1.779     bisitz   5693: .LC_answer_not_charged_try,
1.523     albertel 5694: .LC_answer_no_grade,
                   5695: .LC_answer_late {
1.795     www      5696:   background: lightyellow;
1.523     albertel 5697:   color: black;
1.795     www      5698:   padding: 6px;
1.523     albertel 5699: }
1.795     www      5700: 
1.523     albertel 5701: .LC_answer_previous {
1.795     www      5702:   background: lightblue;
                   5703:   color: darkblue;
                   5704:   padding: 6px;
1.523     albertel 5705: }
1.795     www      5706: 
1.779     bisitz   5707: .LC_answer_no_message {
1.777     tempelho 5708:   background: #FFFFFF;
                   5709:   color: black;
1.795     www      5710:   padding: 6px;
1.779     bisitz   5711: }
1.795     www      5712: 
1.779     bisitz   5713: .LC_answer_unknown {
                   5714:   background: orange;
                   5715:   color: black;
1.795     www      5716:   padding: 6px;
1.777     tempelho 5717: }
1.795     www      5718: 
1.529     albertel 5719: span.LC_prior_numerical,
                   5720: span.LC_prior_string,
                   5721: span.LC_prior_custom,
                   5722: span.LC_prior_reaction,
                   5723: span.LC_prior_math {
1.925     bisitz   5724:   font-family: $mono;
1.523     albertel 5725:   white-space: pre;
                   5726: }
                   5727: 
1.525     albertel 5728: span.LC_prior_string {
1.925     bisitz   5729:   font-family: $mono;
1.525     albertel 5730:   white-space: pre;
                   5731: }
                   5732: 
1.523     albertel 5733: table.LC_prior_option {
                   5734:   width: 100%;
                   5735:   border-collapse: collapse;
                   5736: }
1.795     www      5737: 
1.911     bisitz   5738: table.LC_prior_rank,
1.795     www      5739: table.LC_prior_match {
1.528     albertel 5740:   border-collapse: collapse;
                   5741: }
1.795     www      5742: 
1.528     albertel 5743: table.LC_prior_option tr td,
                   5744: table.LC_prior_rank tr td,
                   5745: table.LC_prior_match tr td {
1.524     albertel 5746:   border: 1px solid #000000;
1.515     albertel 5747: }
                   5748: 
1.855     bisitz   5749: .LC_nobreak {
1.544     albertel 5750:   white-space: nowrap;
1.519     raeburn  5751: }
                   5752: 
1.576     raeburn  5753: span.LC_cusr_emph {
                   5754:   font-style: italic;
                   5755: }
                   5756: 
1.633     raeburn  5757: span.LC_cusr_subheading {
                   5758:   font-weight: normal;
                   5759:   font-size: 85%;
                   5760: }
                   5761: 
1.861     bisitz   5762: div.LC_docs_entry_move {
1.859     bisitz   5763:   border: 1px solid #BBBBBB;
1.545     albertel 5764:   background: #DDDDDD;
1.861     bisitz   5765:   width: 22px;
1.859     bisitz   5766:   padding: 1px;
                   5767:   margin: 0;
1.545     albertel 5768: }
                   5769: 
1.861     bisitz   5770: table.LC_data_table tr > td.LC_docs_entry_commands,
                   5771: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 5772:   background: #DDDDDD;
                   5773:   font-size: x-small;
                   5774: }
1.795     www      5775: 
1.861     bisitz   5776: .LC_docs_entry_parameter {
                   5777:   white-space: nowrap;
                   5778: }
                   5779: 
1.544     albertel 5780: .LC_docs_copy {
1.545     albertel 5781:   color: #000099;
1.544     albertel 5782: }
1.795     www      5783: 
1.544     albertel 5784: .LC_docs_cut {
1.545     albertel 5785:   color: #550044;
1.544     albertel 5786: }
1.795     www      5787: 
1.544     albertel 5788: .LC_docs_rename {
1.545     albertel 5789:   color: #009900;
1.544     albertel 5790: }
1.795     www      5791: 
1.544     albertel 5792: .LC_docs_remove {
1.545     albertel 5793:   color: #990000;
                   5794: }
                   5795: 
1.547     albertel 5796: .LC_docs_reinit_warn,
                   5797: .LC_docs_ext_edit {
                   5798:   font-size: x-small;
                   5799: }
                   5800: 
1.545     albertel 5801: table.LC_docs_adddocs td,
                   5802: table.LC_docs_adddocs th {
                   5803:   border: 1px solid #BBBBBB;
                   5804:   padding: 4px;
                   5805:   background: #DDDDDD;
1.543     albertel 5806: }
                   5807: 
1.584     albertel 5808: table.LC_sty_begin {
                   5809:   background: #BBFFBB;
                   5810: }
1.795     www      5811: 
1.584     albertel 5812: table.LC_sty_end {
                   5813:   background: #FFBBBB;
                   5814: }
                   5815: 
1.589     raeburn  5816: table.LC_double_column {
1.803     bisitz   5817:   border-width: 0;
1.589     raeburn  5818:   border-collapse: collapse;
                   5819:   width: 100%;
                   5820:   padding: 2px;
                   5821: }
                   5822: 
                   5823: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5824:   top: 2px;
1.589     raeburn  5825:   left: 2px;
                   5826:   width: 47%;
                   5827:   vertical-align: top;
                   5828: }
                   5829: 
                   5830: table.LC_double_column tr td.LC_right_col {
                   5831:   top: 2px;
1.779     bisitz   5832:   right: 2px;
1.589     raeburn  5833:   width: 47%;
                   5834:   vertical-align: top;
                   5835: }
                   5836: 
1.591     raeburn  5837: div.LC_left_float {
                   5838:   float: left;
                   5839:   padding-right: 5%;
1.597     albertel 5840:   padding-bottom: 4px;
1.591     raeburn  5841: }
                   5842: 
                   5843: div.LC_clear_float_header {
1.597     albertel 5844:   padding-bottom: 2px;
1.591     raeburn  5845: }
                   5846: 
                   5847: div.LC_clear_float_footer {
1.597     albertel 5848:   padding-top: 10px;
1.591     raeburn  5849:   clear: both;
                   5850: }
                   5851: 
1.597     albertel 5852: div.LC_grade_show_user {
1.941     bisitz   5853: /*  border-left: 5px solid $sidebg; */
                   5854:   border-top: 5px solid #000000;
                   5855:   margin: 50px 0 0 0;
1.936     bisitz   5856:   padding: 15px 0 5px 10px;
1.597     albertel 5857: }
1.795     www      5858: 
1.936     bisitz   5859: div.LC_grade_show_user_odd_row {
1.941     bisitz   5860: /*  border-left: 5px solid #000000; */
                   5861: }
                   5862: 
                   5863: div.LC_grade_show_user div.LC_Box {
                   5864:   margin-right: 50px;
1.597     albertel 5865: }
                   5866: 
                   5867: div.LC_grade_submissions,
                   5868: div.LC_grade_message_center,
1.936     bisitz   5869: div.LC_grade_info_links {
1.597     albertel 5870:   margin: 5px;
                   5871:   width: 99%;
                   5872:   background: #FFFFFF;
                   5873: }
1.795     www      5874: 
1.597     albertel 5875: div.LC_grade_submissions_header,
1.936     bisitz   5876: div.LC_grade_message_center_header {
1.705     tempelho 5877:   font-weight: bold;
                   5878:   font-size: large;
1.597     albertel 5879: }
1.795     www      5880: 
1.597     albertel 5881: div.LC_grade_submissions_body,
1.936     bisitz   5882: div.LC_grade_message_center_body {
1.597     albertel 5883:   border: 1px solid black;
                   5884:   width: 99%;
                   5885:   background: #FFFFFF;
                   5886: }
1.795     www      5887: 
1.613     albertel 5888: table.LC_scantron_action {
                   5889:   width: 100%;
                   5890: }
1.795     www      5891: 
1.613     albertel 5892: table.LC_scantron_action tr th {
1.698     harmsja  5893:   font-weight:bold;
                   5894:   font-style:normal;
1.613     albertel 5895: }
1.795     www      5896: 
1.779     bisitz   5897: .LC_edit_problem_header,
1.614     albertel 5898: div.LC_edit_problem_footer {
1.705     tempelho 5899:   font-weight: normal;
                   5900:   font-size:  medium;
1.602     albertel 5901:   margin: 2px;
1.600     albertel 5902: }
1.795     www      5903: 
1.600     albertel 5904: div.LC_edit_problem_header,
1.602     albertel 5905: div.LC_edit_problem_header div,
1.614     albertel 5906: div.LC_edit_problem_footer,
                   5907: div.LC_edit_problem_footer div,
1.602     albertel 5908: div.LC_edit_problem_editxml_header,
                   5909: div.LC_edit_problem_editxml_header div {
1.600     albertel 5910:   margin-top: 5px;
                   5911: }
1.795     www      5912: 
1.600     albertel 5913: div.LC_edit_problem_header_title {
1.705     tempelho 5914:   font-weight: bold;
                   5915:   font-size: larger;
1.602     albertel 5916:   background: $tabbg;
                   5917:   padding: 3px;
                   5918: }
1.795     www      5919: 
1.602     albertel 5920: table.LC_edit_problem_header_title {
                   5921:   width: 100%;
1.600     albertel 5922:   background: $tabbg;
1.602     albertel 5923: }
                   5924: 
                   5925: div.LC_edit_problem_discards {
                   5926:   float: left;
                   5927:   padding-bottom: 5px;
                   5928: }
1.795     www      5929: 
1.602     albertel 5930: div.LC_edit_problem_saves {
                   5931:   float: right;
                   5932:   padding-bottom: 5px;
1.600     albertel 5933: }
1.795     www      5934: 
1.911     bisitz   5935: img.stift {
1.803     bisitz   5936:   border-width: 0;
                   5937:   vertical-align: middle;
1.677     riegler  5938: }
1.680     riegler  5939: 
1.923     bisitz   5940: table td.LC_mainmenu_col_fieldset {
1.680     riegler  5941:   vertical-align: top;
1.777     tempelho 5942: }
1.795     www      5943: 
1.716     raeburn  5944: div.LC_createcourse {
1.911     bisitz   5945:   margin: 10px 10px 10px 10px;
1.716     raeburn  5946: }
                   5947: 
1.917     raeburn  5948: .LC_dccid {
                   5949:   margin: 0.2em 0 0 0;
                   5950:   padding: 0;
                   5951:   font-size: 90%;
                   5952:   display:none;
                   5953: }
                   5954: 
1.698     harmsja  5955: a:hover,
1.897     wenzelju 5956: ol.LC_primary_menu a:hover,
1.721     harmsja  5957: ol#LC_MenuBreadcrumbs a:hover,
                   5958: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 5959: ul#LC_secondary_menu a:hover,
1.721     harmsja  5960: .LC_FormSectionClearButton input:hover
1.795     www      5961: ul.LC_TabContent   li:hover a {
1.952     onken    5962:   color:$button_hover;
1.911     bisitz   5963:   text-decoration:none;
1.693     droeschl 5964: }
                   5965: 
1.779     bisitz   5966: h1 {
1.911     bisitz   5967:   padding: 0;
                   5968:   line-height:130%;
1.693     droeschl 5969: }
1.698     harmsja  5970: 
1.911     bisitz   5971: h2,
                   5972: h3,
                   5973: h4,
                   5974: h5,
                   5975: h6 {
                   5976:   margin: 5px 0 5px 0;
                   5977:   padding: 0;
                   5978:   line-height:130%;
1.693     droeschl 5979: }
1.795     www      5980: 
                   5981: .LC_hcell {
1.911     bisitz   5982:   padding:3px 15px 3px 15px;
                   5983:   margin: 0;
                   5984:   background-color:$tabbg;
                   5985:   color:$fontmenu;
                   5986:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 5987: }
1.795     www      5988: 
1.840     bisitz   5989: .LC_Box > .LC_hcell {
1.911     bisitz   5990:   margin: 0 -10px 10px -10px;
1.835     bisitz   5991: }
                   5992: 
1.721     harmsja  5993: .LC_noBorder {
1.911     bisitz   5994:   border: 0;
1.698     harmsja  5995: }
1.693     droeschl 5996: 
1.721     harmsja  5997: .LC_FormSectionClearButton input {
1.911     bisitz   5998:   background-color:transparent;
                   5999:   border: none;
                   6000:   cursor:pointer;
                   6001:   text-decoration:underline;
1.693     droeschl 6002: }
1.763     bisitz   6003: 
                   6004: .LC_help_open_topic {
1.911     bisitz   6005:   color: #FFFFFF;
                   6006:   background-color: #EEEEFF;
                   6007:   margin: 1px;
                   6008:   padding: 4px;
                   6009:   border: 1px solid #000033;
                   6010:   white-space: nowrap;
                   6011:   /* vertical-align: middle; */
1.759     neumanie 6012: }
1.693     droeschl 6013: 
1.911     bisitz   6014: dl,
                   6015: ul,
                   6016: div,
                   6017: fieldset {
                   6018:   margin: 10px 10px 10px 0;
                   6019:   /* overflow: hidden; */
1.693     droeschl 6020: }
1.795     www      6021: 
1.838     bisitz   6022: fieldset > legend {
1.911     bisitz   6023:   font-weight: bold;
                   6024:   padding: 0 5px 0 5px;
1.838     bisitz   6025: }
                   6026: 
1.813     bisitz   6027: #LC_nav_bar {
1.911     bisitz   6028:   float: left;
1.966     bisitz   6029:   margin: 0 0 2px 0;
1.807     droeschl 6030: }
                   6031: 
1.916     droeschl 6032: #LC_realm {
                   6033:   margin: 0.2em 0 0 0;
                   6034:   padding: 0;
                   6035:   font-weight: bold;
                   6036:   text-align: center;
                   6037: }
                   6038: 
1.911     bisitz   6039: #LC_nav_bar em {
                   6040:   font-weight: bold;
                   6041:   font-style: normal;
1.807     droeschl 6042: }
                   6043: 
1.965     bisitz   6044: /* Preliminary fix to hide nav_bar inside bookmarks window */
                   6045: #LC_bookmarks #LC_nav_bar {
                   6046:   display:none;
                   6047: }
                   6048: 
1.897     wenzelju 6049: ol.LC_primary_menu {
1.911     bisitz   6050:   float: right;
1.934     droeschl 6051:   margin: 0;
1.807     droeschl 6052: }
                   6053: 
1.852     droeschl 6054: ol#LC_PathBreadcrumbs {
1.911     bisitz   6055:   margin: 0;
1.693     droeschl 6056: }
                   6057: 
1.897     wenzelju 6058: ol.LC_primary_menu li {
1.911     bisitz   6059:   display: inline;
                   6060:   padding: 5px 5px 0 10px;
                   6061:   vertical-align: top;
1.693     droeschl 6062: }
                   6063: 
1.897     wenzelju 6064: ol.LC_primary_menu li img {
1.911     bisitz   6065:   vertical-align: bottom;
1.934     droeschl 6066:   height: 1.1em;
1.693     droeschl 6067: }
                   6068: 
1.897     wenzelju 6069: ol.LC_primary_menu a {
1.911     bisitz   6070:   color: RGB(80, 80, 80);
                   6071:   text-decoration: none;
1.693     droeschl 6072: }
1.795     www      6073: 
1.949     droeschl 6074: ol.LC_primary_menu a.LC_new_message {
                   6075:   font-weight:bold;
                   6076:   color: darkred;
                   6077: }
                   6078: 
1.897     wenzelju 6079: ul#LC_secondary_menu {
1.911     bisitz   6080:   clear: both;
                   6081:   color: $fontmenu;
                   6082:   background: $tabbg;
                   6083:   list-style: none;
                   6084:   padding: 0;
                   6085:   margin: 0;
                   6086:   width: 100%;
1.808     droeschl 6087: }
                   6088: 
1.897     wenzelju 6089: ul#LC_secondary_menu li {
1.911     bisitz   6090:   font-weight: bold;
                   6091:   line-height: 1.8em;
                   6092:   padding: 0 0.8em;
                   6093:   border-right: 1px solid black;
                   6094:   display: inline;
                   6095:   vertical-align: middle;
1.807     droeschl 6096: }
                   6097: 
1.847     tempelho 6098: ul.LC_TabContent {
1.911     bisitz   6099:   display:block;
                   6100:   background: $sidebg;
                   6101:   border-bottom: solid 1px $lg_border_color;
                   6102:   list-style:none;
                   6103:   margin: 0 -10px;
                   6104:   padding: 0;
1.693     droeschl 6105: }
                   6106: 
1.795     www      6107: ul.LC_TabContent li,
                   6108: ul.LC_TabContentBigger li {
1.911     bisitz   6109:   float:left;
1.741     harmsja  6110: }
1.795     www      6111: 
1.897     wenzelju 6112: ul#LC_secondary_menu li a {
1.911     bisitz   6113:   color: $fontmenu;
                   6114:   text-decoration: none;
1.693     droeschl 6115: }
1.795     www      6116: 
1.721     harmsja  6117: ul.LC_TabContent {
1.952     onken    6118:   min-height:20px;
1.721     harmsja  6119: }
1.795     www      6120: 
                   6121: ul.LC_TabContent li {
1.911     bisitz   6122:   vertical-align:middle;
1.959     onken    6123:   padding: 0 16px 0 10px;
1.911     bisitz   6124:   background-color:$tabbg;
                   6125:   border-bottom:solid 1px $lg_border_color;
1.952     onken    6126:   border-right: solid 1px $font;
1.721     harmsja  6127: }
1.795     www      6128: 
1.847     tempelho 6129: ul.LC_TabContent .right {
1.911     bisitz   6130:   float:right;
1.847     tempelho 6131: }
                   6132: 
1.911     bisitz   6133: ul.LC_TabContent li a,
                   6134: ul.LC_TabContent li {
                   6135:   color:rgb(47,47,47);
                   6136:   text-decoration:none;
                   6137:   font-size:95%;
                   6138:   font-weight:bold;
1.952     onken    6139:   min-height:20px;
                   6140: }
                   6141: 
1.959     onken    6142: ul.LC_TabContent li a:hover,
                   6143: ul.LC_TabContent li a:focus {
1.952     onken    6144:   color: $button_hover;
1.959     onken    6145:   background:none;
                   6146:   outline:none;
1.952     onken    6147: }
                   6148: 
                   6149: ul.LC_TabContent li:hover {
                   6150:   color: $button_hover;
                   6151:   cursor:pointer;
1.721     harmsja  6152: }
1.795     www      6153: 
1.911     bisitz   6154: ul.LC_TabContent li.active {
1.952     onken    6155:   color: $font;
1.911     bisitz   6156:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    6157:   border-bottom:solid 1px #FFFFFF;
                   6158:   cursor: default;
1.744     ehlerst  6159: }
1.795     www      6160: 
1.959     onken    6161: ul.LC_TabContent li.active a {
                   6162:   color:$font;
                   6163:   background:#FFFFFF;
                   6164:   outline: none;
                   6165: }
1.870     tempelho 6166: #maincoursedoc {
1.911     bisitz   6167:   clear:both;
1.870     tempelho 6168: }
                   6169: 
                   6170: ul.LC_TabContentBigger {
1.911     bisitz   6171:   display:block;
                   6172:   list-style:none;
                   6173:   padding: 0;
1.870     tempelho 6174: }
                   6175: 
1.795     www      6176: ul.LC_TabContentBigger li {
1.911     bisitz   6177:   vertical-align:bottom;
                   6178:   height: 30px;
                   6179:   font-size:110%;
                   6180:   font-weight:bold;
                   6181:   color: #737373;
1.841     tempelho 6182: }
                   6183: 
1.957     onken    6184: ul.LC_TabContentBigger li.active {
                   6185:   position: relative;
                   6186:   top: 1px;
                   6187: }
                   6188: 
1.870     tempelho 6189: ul.LC_TabContentBigger li a {
1.911     bisitz   6190:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6191:   height: 30px;
                   6192:   line-height: 30px;
                   6193:   text-align: center;
                   6194:   display: block;
                   6195:   text-decoration: none;
1.958     onken    6196:   outline: none;  
1.741     harmsja  6197: }
1.795     www      6198: 
1.870     tempelho 6199: ul.LC_TabContentBigger li.active a {
1.911     bisitz   6200:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   6201:   color:$font;
1.744     ehlerst  6202: }
1.795     www      6203: 
1.870     tempelho 6204: ul.LC_TabContentBigger li b {
1.911     bisitz   6205:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6206:   display: block;
                   6207:   float: left;
                   6208:   padding: 0 30px;
1.957     onken    6209:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 6210: }
                   6211: 
1.956     onken    6212: ul.LC_TabContentBigger li:hover b {
                   6213:   color:$button_hover;
                   6214: }
                   6215: 
1.870     tempelho 6216: ul.LC_TabContentBigger li.active b {
1.911     bisitz   6217:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6218:   color:$font;
1.957     onken    6219:   border: 0;
1.956     onken    6220:   cursor:default;
1.741     harmsja  6221: }
1.693     droeschl 6222: 
1.870     tempelho 6223: 
1.862     bisitz   6224: ul.LC_CourseBreadcrumbs {
                   6225:   background: $sidebg;
                   6226:   line-height: 32px;
                   6227:   padding-left: 10px;
                   6228:   margin: 0 0 10px 0;
                   6229:   list-style-position: inside;
                   6230: 
                   6231: }
                   6232: 
1.911     bisitz   6233: ol#LC_MenuBreadcrumbs,
1.862     bisitz   6234: ol#LC_PathBreadcrumbs {
1.911     bisitz   6235:   padding-left: 10px;
                   6236:   margin: 0;
1.933     droeschl 6237:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 6238: }
                   6239: 
1.911     bisitz   6240: ol#LC_MenuBreadcrumbs li,
                   6241: ol#LC_PathBreadcrumbs li,
1.862     bisitz   6242: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   6243:   display: inline;
1.933     droeschl 6244:   white-space: normal;  
1.693     droeschl 6245: }
                   6246: 
1.823     bisitz   6247: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6248: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   6249:   text-decoration: none;
                   6250:   font-size:90%;
1.693     droeschl 6251: }
1.795     www      6252: 
1.969     droeschl 6253: ol#LC_MenuBreadcrumbs h1 {
                   6254:   display: inline;
                   6255:   font-size: 90%;
                   6256:   line-height: 2.5em;
                   6257:   margin: 0;
                   6258:   padding: 0;
                   6259: }
                   6260: 
1.795     www      6261: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   6262:   text-decoration:none;
                   6263:   font-size:100%;
                   6264:   font-weight:bold;
1.693     droeschl 6265: }
1.795     www      6266: 
1.840     bisitz   6267: .LC_Box {
1.911     bisitz   6268:   border: solid 1px $lg_border_color;
                   6269:   padding: 0 10px 10px 10px;
1.746     neumanie 6270: }
1.795     www      6271: 
                   6272: .LC_AboutMe_Image {
1.911     bisitz   6273:   float:left;
                   6274:   margin-right:10px;
1.747     neumanie 6275: }
1.795     www      6276: 
                   6277: .LC_Clear_AboutMe_Image {
1.911     bisitz   6278:   clear:left;
1.747     neumanie 6279: }
1.795     www      6280: 
1.721     harmsja  6281: dl.LC_ListStyleClean dt {
1.911     bisitz   6282:   padding-right: 5px;
                   6283:   display: table-header-group;
1.693     droeschl 6284: }
                   6285: 
1.721     harmsja  6286: dl.LC_ListStyleClean dd {
1.911     bisitz   6287:   display: table-row;
1.693     droeschl 6288: }
                   6289: 
1.721     harmsja  6290: .LC_ListStyleClean,
                   6291: .LC_ListStyleSimple,
                   6292: .LC_ListStyleNormal,
1.795     www      6293: .LC_ListStyleSpecial {
1.911     bisitz   6294:   /* display:block; */
                   6295:   list-style-position: inside;
                   6296:   list-style-type: none;
                   6297:   overflow: hidden;
                   6298:   padding: 0;
1.693     droeschl 6299: }
                   6300: 
1.721     harmsja  6301: .LC_ListStyleSimple li,
                   6302: .LC_ListStyleSimple dd,
                   6303: .LC_ListStyleNormal li,
                   6304: .LC_ListStyleNormal dd,
                   6305: .LC_ListStyleSpecial li,
1.795     www      6306: .LC_ListStyleSpecial dd {
1.911     bisitz   6307:   margin: 0;
                   6308:   padding: 5px 5px 5px 10px;
                   6309:   clear: both;
1.693     droeschl 6310: }
                   6311: 
1.721     harmsja  6312: .LC_ListStyleClean li,
                   6313: .LC_ListStyleClean dd {
1.911     bisitz   6314:   padding-top: 0;
                   6315:   padding-bottom: 0;
1.693     droeschl 6316: }
                   6317: 
1.721     harmsja  6318: .LC_ListStyleSimple dd,
1.795     www      6319: .LC_ListStyleSimple li {
1.911     bisitz   6320:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6321: }
                   6322: 
1.721     harmsja  6323: .LC_ListStyleSpecial li,
                   6324: .LC_ListStyleSpecial dd {
1.911     bisitz   6325:   list-style-type: none;
                   6326:   background-color: RGB(220, 220, 220);
                   6327:   margin-bottom: 4px;
1.693     droeschl 6328: }
                   6329: 
1.721     harmsja  6330: table.LC_SimpleTable {
1.911     bisitz   6331:   margin:5px;
                   6332:   border:solid 1px $lg_border_color;
1.795     www      6333: }
1.693     droeschl 6334: 
1.721     harmsja  6335: table.LC_SimpleTable tr {
1.911     bisitz   6336:   padding: 0;
                   6337:   border:solid 1px $lg_border_color;
1.693     droeschl 6338: }
1.795     www      6339: 
                   6340: table.LC_SimpleTable thead {
1.911     bisitz   6341:   background:rgb(220,220,220);
1.693     droeschl 6342: }
                   6343: 
1.721     harmsja  6344: div.LC_columnSection {
1.911     bisitz   6345:   display: block;
                   6346:   clear: both;
                   6347:   overflow: hidden;
                   6348:   margin: 0;
1.693     droeschl 6349: }
                   6350: 
1.721     harmsja  6351: div.LC_columnSection>* {
1.911     bisitz   6352:   float: left;
                   6353:   margin: 10px 20px 10px 0;
                   6354:   overflow:hidden;
1.693     droeschl 6355: }
1.721     harmsja  6356: 
1.795     www      6357: table em {
1.911     bisitz   6358:   font-weight: bold;
                   6359:   font-style: normal;
1.748     schulted 6360: }
1.795     www      6361: 
1.779     bisitz   6362: table.LC_tableBrowseRes,
1.795     www      6363: table.LC_tableOfContent {
1.911     bisitz   6364:   border:none;
                   6365:   border-spacing: 1px;
                   6366:   padding: 3px;
                   6367:   background-color: #FFFFFF;
                   6368:   font-size: 90%;
1.753     droeschl 6369: }
1.789     droeschl 6370: 
1.911     bisitz   6371: table.LC_tableOfContent {
                   6372:   border-collapse: collapse;
1.789     droeschl 6373: }
                   6374: 
1.771     droeschl 6375: table.LC_tableBrowseRes a,
1.768     schulted 6376: table.LC_tableOfContent a {
1.911     bisitz   6377:   background-color: transparent;
                   6378:   text-decoration: none;
1.753     droeschl 6379: }
                   6380: 
1.795     www      6381: table.LC_tableOfContent img {
1.911     bisitz   6382:   border: none;
                   6383:   height: 1.3em;
                   6384:   vertical-align: text-bottom;
                   6385:   margin-right: 0.3em;
1.753     droeschl 6386: }
1.757     schulted 6387: 
1.795     www      6388: a#LC_content_toolbar_firsthomework {
1.911     bisitz   6389:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  6390: }
                   6391: 
1.795     www      6392: a#LC_content_toolbar_everything {
1.911     bisitz   6393:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  6394: }
                   6395: 
1.795     www      6396: a#LC_content_toolbar_uncompleted {
1.911     bisitz   6397:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  6398: }
                   6399: 
1.795     www      6400: #LC_content_toolbar_clearbubbles {
1.911     bisitz   6401:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  6402: }
                   6403: 
1.795     www      6404: a#LC_content_toolbar_changefolder {
1.911     bisitz   6405:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 6406: }
                   6407: 
1.795     www      6408: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   6409:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 6410: }
                   6411: 
1.795     www      6412: ul#LC_toolbar li a:hover {
1.911     bisitz   6413:   background-position: bottom center;
1.757     schulted 6414: }
                   6415: 
1.795     www      6416: ul#LC_toolbar {
1.911     bisitz   6417:   padding: 0;
                   6418:   margin: 2px;
                   6419:   list-style:none;
                   6420:   position:relative;
                   6421:   background-color:white;
1.757     schulted 6422: }
                   6423: 
1.795     www      6424: ul#LC_toolbar li {
1.911     bisitz   6425:   border:1px solid white;
                   6426:   padding: 0;
                   6427:   margin: 0;
                   6428:   float: left;
                   6429:   display:inline;
                   6430:   vertical-align:middle;
                   6431: }
1.757     schulted 6432: 
1.783     amueller 6433: 
1.795     www      6434: a.LC_toolbarItem {
1.911     bisitz   6435:   display:block;
                   6436:   padding: 0;
                   6437:   margin: 0;
                   6438:   height: 32px;
                   6439:   width: 32px;
                   6440:   color:white;
                   6441:   border: none;
                   6442:   background-repeat:no-repeat;
                   6443:   background-color:transparent;
1.757     schulted 6444: }
                   6445: 
1.915     droeschl 6446: ul.LC_funclist {
                   6447:     margin: 0;
                   6448:     padding: 0.5em 1em 0.5em 0;
                   6449: }
                   6450: 
1.933     droeschl 6451: ul.LC_funclist > li:first-child {
                   6452:     font-weight:bold; 
                   6453:     margin-left:0.8em;
                   6454: }
                   6455: 
1.915     droeschl 6456: ul.LC_funclist + ul.LC_funclist {
                   6457:     /* 
                   6458:        left border as a seperator if we have more than
                   6459:        one list 
                   6460:     */
                   6461:     border-left: 1px solid $sidebg;
                   6462:     /* 
                   6463:        this hides the left border behind the border of the 
                   6464:        outer box if element is wrapped to the next 'line' 
                   6465:     */
                   6466:     margin-left: -1px;
                   6467: }
                   6468: 
1.843     bisitz   6469: ul.LC_funclist li {
1.915     droeschl 6470:   display: inline;
1.782     bisitz   6471:   white-space: nowrap;
1.915     droeschl 6472:   margin: 0 0 0 25px;
                   6473:   line-height: 150%;
1.782     bisitz   6474: }
                   6475: 
1.930     faziophi 6476: .ui-accordion .LC_advanced_toggle {
                   6477:   float: right;
                   6478:   font-size: 90%;
                   6479:   padding: 0px 4px
                   6480: }
1.757     schulted 6481: 
1.974   ! wenzelju 6482: .LC_hidden {
        !          6483:   display: none;
        !          6484: }
        !          6485: 
1.343     albertel 6486: END
                   6487: }
                   6488: 
1.306     albertel 6489: =pod
                   6490: 
                   6491: =item * &headtag()
                   6492: 
                   6493: Returns a uniform footer for LON-CAPA web pages.
                   6494: 
1.307     albertel 6495: Inputs: $title - optional title for the head
                   6496:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6497:         $args - optional arguments
1.319     albertel 6498:             force_register - if is true call registerurl so the remote is 
                   6499:                              informed
1.415     albertel 6500:             redirect       -> array ref of
                   6501:                                    1- seconds before redirect occurs
                   6502:                                    2- url to redirect to
                   6503:                                    3- whether the side effect should occur
1.315     albertel 6504:                            (side effect of setting 
                   6505:                                $env{'internal.head.redirect'} to the url 
                   6506:                                redirected too)
1.352     albertel 6507:             domain         -> force to color decorate a page for a specific
                   6508:                                domain
                   6509:             function       -> force usage of a specific rolish color scheme
                   6510:             bgcolor        -> override the default page bgcolor
1.460     albertel 6511:             no_auto_mt_title
                   6512:                            -> prevent &mt()ing the title arg
1.464     albertel 6513: 
1.306     albertel 6514: =cut
                   6515: 
                   6516: sub headtag {
1.313     albertel 6517:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6518:     
1.363     albertel 6519:     my $function = $args->{'function'} || &get_users_function();
                   6520:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6521:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6522:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6523: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6524: 		   #time(),
1.418     albertel 6525: 		   $env{'environment.color.timestamp'},
1.363     albertel 6526: 		   $function,$domain,$bgcolor);
                   6527: 
1.369     www      6528:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6529: 
1.308     albertel 6530:     my $result =
                   6531: 	'<head>'.
1.461     albertel 6532: 	&font_settings();
1.319     albertel 6533: 
1.461     albertel 6534:     if (!$args->{'frameset'}) {
                   6535: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6536:     }
1.962     droeschl 6537:     if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
                   6538:         $result .= Apache::lonxml::display_title();
1.319     albertel 6539:     }
1.436     albertel 6540:     if (!$args->{'no_nav_bar'} 
                   6541: 	&& !$args->{'only_body'}
                   6542: 	&& !$args->{'frameset'}) {
                   6543: 	$result .= &help_menu_js();
                   6544:     }
1.319     albertel 6545: 
1.314     albertel 6546:     if (ref($args->{'redirect'})) {
1.414     albertel 6547: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6548: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6549: 	if (!$inhibit_continue) {
                   6550: 	    $env{'internal.head.redirect'} = $url;
                   6551: 	}
1.313     albertel 6552: 	$result.=<<ADDMETA
                   6553: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6554: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6555: ADDMETA
                   6556:     }
1.306     albertel 6557:     if (!defined($title)) {
                   6558: 	$title = 'The LearningOnline Network with CAPA';
                   6559:     }
1.460     albertel 6560:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6561:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6562: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6563: 	.$head_extra;
1.962     droeschl 6564:     return $result.'</head>';
1.306     albertel 6565: }
                   6566: 
                   6567: =pod
                   6568: 
1.340     albertel 6569: =item * &font_settings()
                   6570: 
                   6571: Returns neccessary <meta> to set the proper encoding
                   6572: 
                   6573: Inputs: none
                   6574: 
                   6575: =cut
                   6576: 
                   6577: sub font_settings {
                   6578:     my $headerstring='';
1.647     www      6579:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6580: 	$headerstring.=
                   6581: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6582:     }
                   6583:     return $headerstring;
                   6584: }
                   6585: 
1.341     albertel 6586: =pod
                   6587: 
                   6588: =item * &xml_begin()
                   6589: 
                   6590: Returns the needed doctype and <html>
                   6591: 
                   6592: Inputs: none
                   6593: 
                   6594: =cut
                   6595: 
                   6596: sub xml_begin {
                   6597:     my $output='';
                   6598: 
                   6599:     if ($env{'browser.mathml'}) {
                   6600: 	$output='<?xml version="1.0"?>'
                   6601:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6602: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6603:             
                   6604: #	    .'<!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">] >'
                   6605: 	    .'<!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">'
                   6606:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6607: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6608:     } else {
1.849     bisitz   6609: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   6610:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 6611:     }
                   6612:     return $output;
                   6613: }
1.340     albertel 6614: 
                   6615: =pod
                   6616: 
1.306     albertel 6617: =item * &start_page()
                   6618: 
                   6619: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6620: 
1.648     raeburn  6621: Inputs:
                   6622: 
                   6623: =over 4
                   6624: 
                   6625: $title - optional title for the page
                   6626: 
                   6627: $head_extra - optional extra HTML to incude inside the <head>
                   6628: 
                   6629: $args - additional optional args supported are:
                   6630: 
                   6631: =over 8
                   6632: 
                   6633:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6634:                                     arg on
1.814     bisitz   6635:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6636:              add_entries    -> additional attributes to add to the  <body>
                   6637:              domain         -> force to color decorate a page for a 
1.317     albertel 6638:                                     specific domain
1.648     raeburn  6639:              function       -> force usage of a specific rolish color
1.317     albertel 6640:                                     scheme
1.648     raeburn  6641:              redirect       -> see &headtag()
                   6642:              bgcolor        -> override the default page bg color
                   6643:              js_ready       -> return a string ready for being used in 
1.317     albertel 6644:                                     a javascript writeln
1.648     raeburn  6645:              html_encode    -> return a string ready for being used in 
1.320     albertel 6646:                                     a html attribute
1.648     raeburn  6647:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6648:                                     $forcereg arg
1.648     raeburn  6649:              frameset       -> if true will start with a <frameset>
1.330     albertel 6650:                                     rather than <body>
1.648     raeburn  6651:              skip_phases    -> hash ref of 
1.338     albertel 6652:                                     head -> skip the <html><head> generation
                   6653:                                     body -> skip all <body> generation
1.648     raeburn  6654:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6655:              inherit_jsmath -> when creating popup window in a page,
                   6656:                                     should it have jsmath forced on by the
                   6657:                                     current page
1.867     kalberla 6658:              bread_crumbs ->             Array containing breadcrumbs
                   6659:              bread_crumbs_components ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 6660: 
1.648     raeburn  6661: =back
1.460     albertel 6662: 
1.648     raeburn  6663: =back
1.562     albertel 6664: 
1.306     albertel 6665: =cut
                   6666: 
                   6667: sub start_page {
1.309     albertel 6668:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6669:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.964     droeschl 6670: #SD
                   6671: #I don't see why we copy certain elements of %$args to %head_args
                   6672: #head args is passed to headtag() and this routine only reads those
                   6673: #keys that are needed. There doesn't happen any writes or any processing
                   6674: #of other keys.
                   6675: #proposal: just pass $args to headtag instead of \%head_args and delete 
                   6676: #marked lines
                   6677: #<- MARK
1.313     albertel 6678:     my %head_args;
1.352     albertel 6679:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6680: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6681: 		     'no_auto_mt_title') {
1.319     albertel 6682: 	if (defined($args->{$arg})) {
1.324     raeburn  6683: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6684: 	}
1.313     albertel 6685:     }
1.964     droeschl 6686: #MARK ->
1.319     albertel 6687: 
1.315     albertel 6688:     $env{'internal.start_page'}++;
1.338     albertel 6689:     my $result;
1.964     droeschl 6690: 
1.338     albertel 6691:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.964     droeschl 6692:         $result .= 
                   6693:                   &xml_begin() . &headtag($title,$head_extra,\%head_args);
                   6694: #replace prev line by
                   6695: #                 &xml_begin() . &headtag($title, $head_extra, $args);
1.338     albertel 6696:     }
                   6697:     
                   6698:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6699: 	if ($args->{'frameset'}) {
                   6700: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6701: 						$args->{'add_entries'});
                   6702: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   6703:         } else {
                   6704:             $result .=
                   6705:                 &bodytag($title, 
                   6706:                          $args->{'function'},       $args->{'add_entries'},
                   6707:                          $args->{'only_body'},      $args->{'domain'},
                   6708:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.962     droeschl 6709:                          $args->{'bgcolor'},        $args);
1.831     bisitz   6710:         }
1.330     albertel 6711:     }
1.338     albertel 6712: 
1.315     albertel 6713:     if ($args->{'js_ready'}) {
1.713     kaisler  6714: 		$result = &js_ready($result);
1.315     albertel 6715:     }
1.320     albertel 6716:     if ($args->{'html_encode'}) {
1.713     kaisler  6717: 		$result = &html_encode($result);
                   6718:     }
                   6719: 
1.813     bisitz   6720:     # Preparation for new and consistent functionlist at top of screen
                   6721:     # if ($args->{'functionlist'}) {
                   6722:     #            $result .= &build_functionlist();
                   6723:     #}
                   6724: 
1.964     droeschl 6725:     # Don't add anything more if only_body wanted or in const space
                   6726:     return $result if    $args->{'only_body'} 
                   6727:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   6728: 
                   6729:     #Breadcrumbs
1.758     kaisler  6730:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6731: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6732: 		#if any br links exists, add them to the breadcrumbs
                   6733: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6734: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6735: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6736: 			}
                   6737: 		}
                   6738: 
                   6739: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6740: 		if(exists($args->{'bread_crumbs_component'})){
                   6741: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   6742: 		}else{
                   6743: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   6744: 		}
1.320     albertel 6745:     }
1.315     albertel 6746:     return $result;
1.306     albertel 6747: }
                   6748: 
                   6749: sub end_page {
1.315     albertel 6750:     my ($args) = @_;
                   6751:     $env{'internal.end_page'}++;
1.330     albertel 6752:     my $result;
1.335     albertel 6753:     if ($args->{'discussion'}) {
                   6754: 	my ($target,$parser);
                   6755: 	if (ref($args->{'discussion'})) {
                   6756: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6757: 				$args->{'discussion'}{'parser'});
                   6758: 	}
                   6759: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6760:     }
                   6761: 
1.330     albertel 6762:     if ($args->{'frameset'}) {
                   6763: 	$result .= '</frameset>';
                   6764:     } else {
1.635     raeburn  6765: 	$result .= &endbodytag($args);
1.330     albertel 6766:     }
                   6767:     $result .= "\n</html>";
                   6768: 
1.315     albertel 6769:     if ($args->{'js_ready'}) {
1.317     albertel 6770: 	$result = &js_ready($result);
1.315     albertel 6771:     }
1.335     albertel 6772: 
1.320     albertel 6773:     if ($args->{'html_encode'}) {
                   6774: 	$result = &html_encode($result);
                   6775:     }
1.335     albertel 6776: 
1.315     albertel 6777:     return $result;
                   6778: }
                   6779: 
1.320     albertel 6780: sub html_encode {
                   6781:     my ($result) = @_;
                   6782: 
1.322     albertel 6783:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 6784:     
                   6785:     return $result;
                   6786: }
1.317     albertel 6787: sub js_ready {
                   6788:     my ($result) = @_;
                   6789: 
1.323     albertel 6790:     $result =~ s/[\n\r]/ /xmsg;
                   6791:     $result =~ s/\\/\\\\/xmsg;
                   6792:     $result =~ s/'/\\'/xmsg;
1.372     albertel 6793:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 6794:     
                   6795:     return $result;
                   6796: }
                   6797: 
1.315     albertel 6798: sub validate_page {
                   6799:     if (  exists($env{'internal.start_page'})
1.316     albertel 6800: 	  &&     $env{'internal.start_page'} > 1) {
                   6801: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 6802: 				 $env{'internal.start_page'}.' '.
1.316     albertel 6803: 				 $ENV{'request.filename'});
1.315     albertel 6804:     }
                   6805:     if (  exists($env{'internal.end_page'})
1.316     albertel 6806: 	  &&     $env{'internal.end_page'} > 1) {
                   6807: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 6808: 				 $env{'internal.end_page'}.' '.
1.316     albertel 6809: 				 $env{'request.filename'});
1.315     albertel 6810:     }
                   6811:     if (     exists($env{'internal.start_page'})
                   6812: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 6813: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   6814: 				 $env{'request.filename'});
1.315     albertel 6815:     }
                   6816:     if (   ! exists($env{'internal.start_page'})
                   6817: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 6818: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   6819: 				 $env{'request.filename'});
1.315     albertel 6820:     }
1.306     albertel 6821: }
1.315     albertel 6822: 
1.318     albertel 6823: sub simple_error_page {
                   6824:     my ($r,$title,$msg) = @_;
                   6825:     my $page =
                   6826: 	&Apache::loncommon::start_page($title).
                   6827: 	&mt($msg).
                   6828: 	&Apache::loncommon::end_page();
                   6829:     if (ref($r)) {
                   6830: 	$r->print($page);
1.327     albertel 6831: 	return;
1.318     albertel 6832:     }
                   6833:     return $page;
                   6834: }
1.347     albertel 6835: 
                   6836: {
1.610     albertel 6837:     my @row_count;
1.961     onken    6838: 
                   6839:     sub start_data_table_count {
                   6840:         unshift(@row_count, 0);
                   6841:         return;
                   6842:     }
                   6843: 
                   6844:     sub end_data_table_count {
                   6845:         shift(@row_count);
                   6846:         return;
                   6847:     }
                   6848: 
1.347     albertel 6849:     sub start_data_table {
1.422     albertel 6850: 	my ($add_class) = @_;
                   6851: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.961     onken    6852: 	&start_data_table_count();
1.422     albertel 6853: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 6854:     }
                   6855: 
                   6856:     sub end_data_table {
1.961     onken    6857: 	&end_data_table_count();
1.389     albertel 6858: 	return '</table>'."\n";;
1.347     albertel 6859:     }
                   6860: 
                   6861:     sub start_data_table_row {
1.974   ! wenzelju 6862: 	my ($add_class, $id) = @_;
1.610     albertel 6863: 	$row_count[0]++;
                   6864: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   6865: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974   ! wenzelju 6866:         $id = (' id="'.$id.'"') unless ($id eq '');
        !          6867:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 6868:     }
1.471     banghart 6869:     
                   6870:     sub continue_data_table_row {
1.974   ! wenzelju 6871: 	my ($add_class, $id) = @_;
1.610     albertel 6872: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974   ! wenzelju 6873: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
        !          6874:         $id = (' id="'.$id.'"') unless ($id eq '');
        !          6875:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 6876:     }
1.347     albertel 6877: 
                   6878:     sub end_data_table_row {
1.389     albertel 6879: 	return '</tr>'."\n";;
1.347     albertel 6880:     }
1.367     www      6881: 
1.421     albertel 6882:     sub start_data_table_empty_row {
1.707     bisitz   6883: #	$row_count[0]++;
1.421     albertel 6884: 	return  '<tr class="LC_empty_row" >'."\n";;
                   6885:     }
                   6886: 
                   6887:     sub end_data_table_empty_row {
                   6888: 	return '</tr>'."\n";;
                   6889:     }
                   6890: 
1.367     www      6891:     sub start_data_table_header_row {
1.389     albertel 6892: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      6893:     }
                   6894: 
                   6895:     sub end_data_table_header_row {
1.389     albertel 6896: 	return '</tr>'."\n";;
1.367     www      6897:     }
1.890     droeschl 6898: 
                   6899:     sub data_table_caption {
                   6900:         my $caption = shift;
                   6901:         return "<caption class=\"LC_caption\">$caption</caption>";
                   6902:     }
1.347     albertel 6903: }
                   6904: 
1.548     albertel 6905: =pod
                   6906: 
                   6907: =item * &inhibit_menu_check($arg)
                   6908: 
                   6909: Checks for a inhibitmenu state and generates output to preserve it
                   6910: 
                   6911: Inputs:         $arg - can be any of
                   6912:                      - undef - in which case the return value is a string 
                   6913:                                to add  into arguments list of a uri
                   6914:                      - 'input' - in which case the return value is a HTML
                   6915:                                  <form> <input> field of type hidden to
                   6916:                                  preserve the value
                   6917:                      - a url - in which case the return value is the url with
                   6918:                                the neccesary cgi args added to preserve the
                   6919:                                inhibitmenu state
                   6920:                      - a ref to a url - no return value, but the string is
                   6921:                                         updated to include the neccessary cgi
                   6922:                                         args to preserve the inhibitmenu state
                   6923: 
                   6924: =cut
                   6925: 
                   6926: sub inhibit_menu_check {
                   6927:     my ($arg) = @_;
                   6928:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6929:     if ($arg eq 'input') {
                   6930: 	if ($env{'form.inhibitmenu'}) {
                   6931: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   6932: 	} else {
                   6933: 	    return
                   6934: 	}
                   6935:     }
                   6936:     if ($env{'form.inhibitmenu'}) {
                   6937: 	if (ref($arg)) {
                   6938: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6939: 	} elsif ($arg eq '') {
                   6940: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   6941: 	} else {
                   6942: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6943: 	}
                   6944:     }
                   6945:     if (!ref($arg)) {
                   6946: 	return $arg;
                   6947:     }
                   6948: }
                   6949: 
1.251     albertel 6950: ###############################################
1.182     matthew  6951: 
                   6952: =pod
                   6953: 
1.549     albertel 6954: =back
                   6955: 
                   6956: =head1 User Information Routines
                   6957: 
                   6958: =over 4
                   6959: 
1.405     albertel 6960: =item * &get_users_function()
1.182     matthew  6961: 
                   6962: Used by &bodytag to determine the current users primary role.
                   6963: Returns either 'student','coordinator','admin', or 'author'.
                   6964: 
                   6965: =cut
                   6966: 
                   6967: ###############################################
                   6968: sub get_users_function {
1.815     tempelho 6969:     my $function = 'norole';
1.818     tempelho 6970:     if ($env{'request.role'}=~/^(st)/) {
                   6971:         $function='student';
                   6972:     }
1.907     raeburn  6973:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  6974:         $function='coordinator';
                   6975:     }
1.258     albertel 6976:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  6977:         $function='admin';
                   6978:     }
1.826     bisitz   6979:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182     matthew  6980:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   6981:         $function='author';
                   6982:     }
                   6983:     return $function;
1.54      www      6984: }
1.99      www      6985: 
                   6986: ###############################################
                   6987: 
1.233     raeburn  6988: =pod
                   6989: 
1.821     raeburn  6990: =item * &show_course()
                   6991: 
                   6992: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   6993: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   6994: 
                   6995: Inputs:
                   6996: None
                   6997: 
                   6998: Outputs:
                   6999: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   7000: 
                   7001: =cut
                   7002: 
                   7003: ###############################################
                   7004: sub show_course {
                   7005:     my $course = !$env{'user.adv'};
                   7006:     if (!$env{'user.adv'}) {
                   7007:         foreach my $env (keys(%env)) {
                   7008:             next if ($env !~ m/^user\.priv\./);
                   7009:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   7010:                 $course = 0;
                   7011:                 last;
                   7012:             }
                   7013:         }
                   7014:     }
                   7015:     return $course;
                   7016: }
                   7017: 
                   7018: ###############################################
                   7019: 
                   7020: =pod
                   7021: 
1.542     raeburn  7022: =item * &check_user_status()
1.274     raeburn  7023: 
                   7024: Determines current status of supplied role for a
                   7025: specific user. Roles can be active, previous or future.
                   7026: 
                   7027: Inputs: 
                   7028: user's domain, user's username, course's domain,
1.375     raeburn  7029: course's number, optional section ID.
1.274     raeburn  7030: 
                   7031: Outputs:
                   7032: role status: active, previous or future. 
                   7033: 
                   7034: =cut
                   7035: 
                   7036: sub check_user_status {
1.412     raeburn  7037:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  7038:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   7039:     my @uroles = keys %userinfo;
                   7040:     my $srchstr;
                   7041:     my $active_chk = 'none';
1.412     raeburn  7042:     my $now = time;
1.274     raeburn  7043:     if (@uroles > 0) {
1.908     raeburn  7044:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  7045:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   7046:         } else {
1.412     raeburn  7047:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   7048:         }
                   7049:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  7050:             my $role_end = 0;
                   7051:             my $role_start = 0;
                   7052:             $active_chk = 'active';
1.412     raeburn  7053:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   7054:                 $role_end = $1;
                   7055:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   7056:                     $role_start = $1;
1.274     raeburn  7057:                 }
                   7058:             }
                   7059:             if ($role_start > 0) {
1.412     raeburn  7060:                 if ($now < $role_start) {
1.274     raeburn  7061:                     $active_chk = 'future';
                   7062:                 }
                   7063:             }
                   7064:             if ($role_end > 0) {
1.412     raeburn  7065:                 if ($now > $role_end) {
1.274     raeburn  7066:                     $active_chk = 'previous';
                   7067:                 }
                   7068:             }
                   7069:         }
                   7070:     }
                   7071:     return $active_chk;
                   7072: }
                   7073: 
                   7074: ###############################################
                   7075: 
                   7076: =pod
                   7077: 
1.405     albertel 7078: =item * &get_sections()
1.233     raeburn  7079: 
                   7080: Determines all the sections for a course including
                   7081: sections with students and sections containing other roles.
1.419     raeburn  7082: Incoming parameters: 
                   7083: 
                   7084: 1. domain
                   7085: 2. course number 
                   7086: 3. reference to array containing roles for which sections should 
                   7087: be gathered (optional).
                   7088: 4. reference to array containing status types for which sections 
                   7089: should be gathered (optional).
                   7090: 
                   7091: If the third argument is undefined, sections are gathered for any role. 
                   7092: If the fourth argument is undefined, sections are gathered for any status.
                   7093: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  7094:  
1.374     raeburn  7095: Returns section hash (keys are section IDs, values are
                   7096: number of users in each section), subject to the
1.419     raeburn  7097: optional roles filter, optional status filter 
1.233     raeburn  7098: 
                   7099: =cut
                   7100: 
                   7101: ###############################################
                   7102: sub get_sections {
1.419     raeburn  7103:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 7104:     if (!defined($cdom) || !defined($cnum)) {
                   7105:         my $cid =  $env{'request.course.id'};
                   7106: 
                   7107: 	return if (!defined($cid));
                   7108: 
                   7109:         $cdom = $env{'course.'.$cid.'.domain'};
                   7110:         $cnum = $env{'course.'.$cid.'.num'};
                   7111:     }
                   7112: 
                   7113:     my %sectioncount;
1.419     raeburn  7114:     my $now = time;
1.240     albertel 7115: 
1.366     albertel 7116:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 7117: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 7118: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   7119: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  7120:         my $start_index = &Apache::loncoursedata::CL_START();
                   7121:         my $end_index = &Apache::loncoursedata::CL_END();
                   7122:         my $status;
1.366     albertel 7123: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  7124: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   7125: 				                     $data->[$status_index],
                   7126:                                                      $data->[$start_index],
                   7127:                                                      $data->[$end_index]);
                   7128:             if ($stu_status eq 'Active') {
                   7129:                 $status = 'active';
                   7130:             } elsif ($end < $now) {
                   7131:                 $status = 'previous';
                   7132:             } elsif ($start > $now) {
                   7133:                 $status = 'future';
                   7134:             } 
                   7135: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7136:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7137:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7138: 		    $sectioncount{$section}++;
                   7139:                 }
1.240     albertel 7140: 	    }
                   7141: 	}
                   7142:     }
                   7143:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7144:     foreach my $user (sort(keys(%courseroles))) {
                   7145: 	if ($user !~ /^(\w{2})/) { next; }
                   7146: 	my ($role) = ($user =~ /^(\w{2})/);
                   7147: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7148: 	my ($section,$status);
1.240     albertel 7149: 	if ($role eq 'cr' &&
                   7150: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7151: 	    $section=$1;
                   7152: 	}
                   7153: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7154: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7155:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7156:         if ($end == -1 && $start == -1) {
                   7157:             next; #deleted role
                   7158:         }
                   7159:         if (!defined($possible_status)) { 
                   7160:             $sectioncount{$section}++;
                   7161:         } else {
                   7162:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7163:                 $status = 'active';
                   7164:             } elsif ($end < $now) {
                   7165:                 $status = 'future';
                   7166:             } elsif ($start > $now) {
                   7167:                 $status = 'previous';
                   7168:             }
                   7169:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7170:                 $sectioncount{$section}++;
                   7171:             }
                   7172:         }
1.233     raeburn  7173:     }
1.366     albertel 7174:     return %sectioncount;
1.233     raeburn  7175: }
                   7176: 
1.274     raeburn  7177: ###############################################
1.294     raeburn  7178: 
                   7179: =pod
1.405     albertel 7180: 
                   7181: =item * &get_course_users()
                   7182: 
1.275     raeburn  7183: Retrieves usernames:domains for users in the specified course
                   7184: with specific role(s), and access status. 
                   7185: 
                   7186: Incoming parameters:
1.277     albertel 7187: 1. course domain
                   7188: 2. course number
                   7189: 3. access status: users must have - either active, 
1.275     raeburn  7190: previous, future, or all.
1.277     albertel 7191: 4. reference to array of permissible roles
1.288     raeburn  7192: 5. reference to array of section restrictions (optional)
                   7193: 6. reference to results object (hash of hashes).
                   7194: 7. reference to optional userdata hash
1.609     raeburn  7195: 8. reference to optional statushash
1.630     raeburn  7196: 9. flag if privileged users (except those set to unhide in
                   7197:    course settings) should be excluded    
1.609     raeburn  7198: Keys of top level results hash are roles.
1.275     raeburn  7199: Keys of inner hashes are username:domain, with 
                   7200: values set to access type.
1.288     raeburn  7201: Optional userdata hash returns an array with arguments in the 
                   7202: same order as loncoursedata::get_classlist() for student data.
                   7203: 
1.609     raeburn  7204: Optional statushash returns
                   7205: 
1.288     raeburn  7206: Entries for end, start, section and status are blank because
                   7207: of the possibility of multiple values for non-student roles.
                   7208: 
1.275     raeburn  7209: =cut
1.405     albertel 7210: 
1.275     raeburn  7211: ###############################################
1.405     albertel 7212: 
1.275     raeburn  7213: sub get_course_users {
1.630     raeburn  7214:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7215:     my %idx = ();
1.419     raeburn  7216:     my %seclists;
1.288     raeburn  7217: 
                   7218:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7219:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7220:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7221:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7222:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7223:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7224:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7225:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7226: 
1.290     albertel 7227:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7228:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7229:         my $now = time;
1.277     albertel 7230:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7231:             my $match = 0;
1.412     raeburn  7232:             my $secmatch = 0;
1.419     raeburn  7233:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7234:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7235:             if ($section eq '') {
                   7236:                 $section = 'none';
                   7237:             }
1.291     albertel 7238:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7239:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7240:                     $secmatch = 1;
                   7241:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7242:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7243:                         $secmatch = 1;
                   7244:                     }
                   7245:                 } else {  
1.419     raeburn  7246: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7247: 		        $secmatch = 1;
                   7248:                     }
1.290     albertel 7249: 		}
1.412     raeburn  7250:                 if (!$secmatch) {
                   7251:                     next;
                   7252:                 }
1.419     raeburn  7253:             }
1.275     raeburn  7254:             if (defined($$types{'active'})) {
1.288     raeburn  7255:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7256:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7257:                     $match = 1;
1.275     raeburn  7258:                 }
                   7259:             }
                   7260:             if (defined($$types{'previous'})) {
1.609     raeburn  7261:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7262:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7263:                     $match = 1;
1.275     raeburn  7264:                 }
                   7265:             }
                   7266:             if (defined($$types{'future'})) {
1.609     raeburn  7267:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7268:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7269:                     $match = 1;
1.275     raeburn  7270:                 }
                   7271:             }
1.609     raeburn  7272:             if ($match) {
                   7273:                 push(@{$seclists{$student}},$section);
                   7274:                 if (ref($userdata) eq 'HASH') {
                   7275:                     $$userdata{$student} = $$classlist{$student};
                   7276:                 }
                   7277:                 if (ref($statushash) eq 'HASH') {
                   7278:                     $statushash->{$student}{'st'}{$section} = $status;
                   7279:                 }
1.288     raeburn  7280:             }
1.275     raeburn  7281:         }
                   7282:     }
1.412     raeburn  7283:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7284:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7285:         my $now = time;
1.609     raeburn  7286:         my %displaystatus = ( previous => 'Expired',
                   7287:                               active   => 'Active',
                   7288:                               future   => 'Future',
                   7289:                             );
1.630     raeburn  7290:         my %nothide;
                   7291:         if ($hidepriv) {
                   7292:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7293:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7294:                 if ($user !~ /:/) {
                   7295:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7296:                 } else {
                   7297:                     $nothide{$user} = 1;
                   7298:                 }
                   7299:             }
                   7300:         }
1.439     raeburn  7301:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7302:             my $match = 0;
1.412     raeburn  7303:             my $secmatch = 0;
1.439     raeburn  7304:             my $status;
1.412     raeburn  7305:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7306:             $user =~ s/:$//;
1.439     raeburn  7307:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7308:             if ($end == -1 || $start == -1) {
                   7309:                 next;
                   7310:             }
                   7311:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7312:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7313:                 my ($uname,$udom) = split(/:/,$user);
                   7314:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7315:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7316:                         $secmatch = 1;
                   7317:                     } elsif ($usec eq '') {
1.420     albertel 7318:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7319:                             $secmatch = 1;
                   7320:                         }
                   7321:                     } else {
                   7322:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7323:                             $secmatch = 1;
                   7324:                         }
                   7325:                     }
                   7326:                     if (!$secmatch) {
                   7327:                         next;
                   7328:                     }
1.288     raeburn  7329:                 }
1.419     raeburn  7330:                 if ($usec eq '') {
                   7331:                     $usec = 'none';
                   7332:                 }
1.275     raeburn  7333:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7334:                     if ($hidepriv) {
                   7335:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7336:                             (!$nothide{$uname.':'.$udom})) {
                   7337:                             next;
                   7338:                         }
                   7339:                     }
1.503     raeburn  7340:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7341:                         $status = 'previous';
                   7342:                     } elsif ($start > $now) {
                   7343:                         $status = 'future';
                   7344:                     } else {
                   7345:                         $status = 'active';
                   7346:                     }
1.277     albertel 7347:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7348:                         if ($status eq $type) {
1.420     albertel 7349:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7350:                                 push(@{$$users{$role}{$user}},$type);
                   7351:                             }
1.288     raeburn  7352:                             $match = 1;
                   7353:                         }
                   7354:                     }
1.419     raeburn  7355:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7356:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7357: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7358:                         }
1.420     albertel 7359:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7360:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7361:                         }
1.609     raeburn  7362:                         if (ref($statushash) eq 'HASH') {
                   7363:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7364:                         }
1.275     raeburn  7365:                     }
                   7366:                 }
                   7367:             }
                   7368:         }
1.290     albertel 7369:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7370:             if ((defined($cdom)) && (defined($cnum))) {
                   7371:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7372:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7373:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7374:                     next if ($owner eq '');
                   7375:                     my ($ownername,$ownerdom);
                   7376:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7377:                         $ownername = $1;
                   7378:                         $ownerdom = $2;
                   7379:                     } else {
                   7380:                         $ownername = $owner;
                   7381:                         $ownerdom = $cdom;
                   7382:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7383:                     }
                   7384:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7385:                     if (defined($userdata) && 
1.609     raeburn  7386: 			!exists($$userdata{$owner})) {
                   7387: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7388:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7389:                             push(@{$seclists{$owner}},'none');
                   7390:                         }
                   7391:                         if (ref($statushash) eq 'HASH') {
                   7392:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7393:                         }
1.290     albertel 7394: 		    }
1.279     raeburn  7395:                 }
                   7396:             }
                   7397:         }
1.419     raeburn  7398:         foreach my $user (keys(%seclists)) {
                   7399:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7400:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7401:         }
1.275     raeburn  7402:     }
                   7403:     return;
                   7404: }
                   7405: 
1.288     raeburn  7406: sub get_user_info {
                   7407:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7408:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7409: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7410:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7411:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7412:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7413:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7414:     return;
                   7415: }
1.275     raeburn  7416: 
1.472     raeburn  7417: ###############################################
                   7418: 
                   7419: =pod
                   7420: 
                   7421: =item * &get_user_quota()
                   7422: 
                   7423: Retrieves quota assigned for storage of portfolio files for a user  
                   7424: 
                   7425: Incoming parameters:
                   7426: 1. user's username
                   7427: 2. user's domain
                   7428: 
                   7429: Returns:
1.536     raeburn  7430: 1. Disk quota (in Mb) assigned to student.
                   7431: 2. (Optional) Type of setting: custom or default
                   7432:    (individually assigned or default for user's 
                   7433:    institutional status).
                   7434: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7435:    or student - types as defined in localenroll::inst_usertypes 
                   7436:    for user's domain, which determines default quota for user.
                   7437: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7438: 
                   7439: If a value has been stored in the user's environment, 
1.536     raeburn  7440: it will return that, otherwise it returns the maximal default
                   7441: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7442: 
                   7443: =cut
                   7444: 
                   7445: ###############################################
                   7446: 
                   7447: 
                   7448: sub get_user_quota {
                   7449:     my ($uname,$udom) = @_;
1.536     raeburn  7450:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7451:     if (!defined($udom)) {
                   7452:         $udom = $env{'user.domain'};
                   7453:     }
                   7454:     if (!defined($uname)) {
                   7455:         $uname = $env{'user.name'};
                   7456:     }
                   7457:     if (($udom eq '' || $uname eq '') ||
                   7458:         ($udom eq 'public') && ($uname eq 'public')) {
                   7459:         $quota = 0;
1.536     raeburn  7460:         $quotatype = 'default';
                   7461:         $defquota = 0; 
1.472     raeburn  7462:     } else {
1.536     raeburn  7463:         my $inststatus;
1.472     raeburn  7464:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7465:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7466:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7467:         } else {
1.536     raeburn  7468:             my %userenv = 
                   7469:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7470:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7471:             my ($tmp) = keys(%userenv);
                   7472:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7473:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7474:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7475:             } else {
                   7476:                 undef(%userenv);
                   7477:             }
                   7478:         }
1.536     raeburn  7479:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7480:         if ($quota eq '') {
1.536     raeburn  7481:             $quota = $defquota;
                   7482:             $quotatype = 'default';
                   7483:         } else {
                   7484:             $quotatype = 'custom';
1.472     raeburn  7485:         }
                   7486:     }
1.536     raeburn  7487:     if (wantarray) {
                   7488:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7489:     } else {
                   7490:         return $quota;
                   7491:     }
1.472     raeburn  7492: }
                   7493: 
                   7494: ###############################################
                   7495: 
                   7496: =pod
                   7497: 
                   7498: =item * &default_quota()
                   7499: 
1.536     raeburn  7500: Retrieves default quota assigned for storage of user portfolio files,
                   7501: given an (optional) user's institutional status.
1.472     raeburn  7502: 
                   7503: Incoming parameters:
                   7504: 1. domain
1.536     raeburn  7505: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7506:    status types (e.g., faculty, staff, student etc.)
                   7507:    which apply to the user for whom the default is being retrieved.
                   7508:    If the institutional status string in undefined, the domain
                   7509:    default quota will be returned. 
1.472     raeburn  7510: 
                   7511: Returns:
                   7512: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7513: 2. (Optional) institutional type which determined the value of the
                   7514:    default quota.
1.472     raeburn  7515: 
                   7516: If a value has been stored in the domain's configuration db,
                   7517: it will return that, otherwise it returns 20 (for backwards 
                   7518: compatibility with domains which have not set up a configuration
                   7519: db file; the original statically defined portfolio quota was 20 Mb). 
                   7520: 
1.536     raeburn  7521: If the user's status includes multiple types (e.g., staff and student),
                   7522: the largest default quota which applies to the user determines the
                   7523: default quota returned.
                   7524: 
1.780     raeburn  7525: =back
                   7526: 
1.472     raeburn  7527: =cut
                   7528: 
                   7529: ###############################################
                   7530: 
                   7531: 
                   7532: sub default_quota {
1.536     raeburn  7533:     my ($udom,$inststatus) = @_;
                   7534:     my ($defquota,$settingstatus);
                   7535:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7536:                                             ['quotas'],$udom);
                   7537:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7538:         if ($inststatus ne '') {
1.765     raeburn  7539:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7540:             foreach my $item (@statuses) {
1.711     raeburn  7541:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7542:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7543:                         if ($defquota eq '') {
                   7544:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7545:                             $settingstatus = $item;
                   7546:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7547:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7548:                             $settingstatus = $item;
                   7549:                         }
                   7550:                     }
                   7551:                 } else {
                   7552:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7553:                         if ($defquota eq '') {
                   7554:                             $defquota = $quotahash{'quotas'}{$item};
                   7555:                             $settingstatus = $item;
                   7556:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7557:                             $defquota = $quotahash{'quotas'}{$item};
                   7558:                             $settingstatus = $item;
                   7559:                         }
1.536     raeburn  7560:                     }
                   7561:                 }
                   7562:             }
                   7563:         }
                   7564:         if ($defquota eq '') {
1.711     raeburn  7565:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7566:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7567:             } else {
                   7568:                 $defquota = $quotahash{'quotas'}{'default'};
                   7569:             }
1.536     raeburn  7570:             $settingstatus = 'default';
                   7571:         }
                   7572:     } else {
                   7573:         $settingstatus = 'default';
                   7574:         $defquota = 20;
                   7575:     }
                   7576:     if (wantarray) {
                   7577:         return ($defquota,$settingstatus);
1.472     raeburn  7578:     } else {
1.536     raeburn  7579:         return $defquota;
1.472     raeburn  7580:     }
                   7581: }
                   7582: 
1.384     raeburn  7583: sub get_secgrprole_info {
                   7584:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7585:     my %sections_count = &get_sections($cdom,$cnum);
                   7586:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7587:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7588:     my @groups = sort(keys(%curr_groups));
                   7589:     my $allroles = [];
                   7590:     my $rolehash;
                   7591:     my $accesshash = {
                   7592:                      active => 'Currently has access',
                   7593:                      future => 'Will have future access',
                   7594:                      previous => 'Previously had access',
                   7595:                   };
                   7596:     if ($needroles) {
                   7597:         $rolehash = {'all' => 'all'};
1.385     albertel 7598:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7599: 	if (&Apache::lonnet::error(%user_roles)) {
                   7600: 	    undef(%user_roles);
                   7601: 	}
                   7602:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7603:             my ($role)=split(/\:/,$item,2);
                   7604:             if ($role eq 'cr') { next; }
                   7605:             if ($role =~ /^cr/) {
                   7606:                 $$rolehash{$role} = (split('/',$role))[3];
                   7607:             } else {
                   7608:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7609:             }
                   7610:         }
                   7611:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7612:             push(@{$allroles},$key);
                   7613:         }
                   7614:         push (@{$allroles},'st');
                   7615:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7616:     }
                   7617:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7618: }
                   7619: 
1.555     raeburn  7620: sub user_picker {
1.627     raeburn  7621:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7622:     my $currdom = $dom;
                   7623:     my %curr_selected = (
                   7624:                         srchin => 'dom',
1.580     raeburn  7625:                         srchby => 'lastname',
1.555     raeburn  7626:                       );
                   7627:     my $srchterm;
1.625     raeburn  7628:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7629:         if ($srch->{'srchby'} ne '') {
                   7630:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7631:         }
                   7632:         if ($srch->{'srchin'} ne '') {
                   7633:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7634:         }
                   7635:         if ($srch->{'srchtype'} ne '') {
                   7636:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7637:         }
                   7638:         if ($srch->{'srchdomain'} ne '') {
                   7639:             $currdom = $srch->{'srchdomain'};
                   7640:         }
                   7641:         $srchterm = $srch->{'srchterm'};
                   7642:     }
                   7643:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7644:                     'usr'       => 'Search criteria',
1.563     raeburn  7645:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7646:                     'uname'     => 'username',
                   7647:                     'lastname'  => 'last name',
1.555     raeburn  7648:                     'lastfirst' => 'last name, first name',
1.558     albertel 7649:                     'crs'       => 'in this course',
1.576     raeburn  7650:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7651:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7652:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7653:                     'exact'     => 'is',
                   7654:                     'contains'  => 'contains',
1.569     raeburn  7655:                     'begins'    => 'begins with',
1.571     raeburn  7656:                     'youm'      => "You must include some text to search for.",
                   7657:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7658:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7659:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7660:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7661:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7662:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7663:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7664:                                        );
1.563     raeburn  7665:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   7666:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  7667: 
                   7668:     my @srchins = ('crs','dom','alc','instd');
                   7669: 
                   7670:     foreach my $option (@srchins) {
                   7671:         # FIXME 'alc' option unavailable until 
                   7672:         #       loncreateuser::print_user_query_page()
                   7673:         #       has been completed.
                   7674:         next if ($option eq 'alc');
1.880     raeburn  7675:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  7676:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  7677:         if ($curr_selected{'srchin'} eq $option) {
                   7678:             $srchinsel .= ' 
                   7679:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7680:         } else {
                   7681:             $srchinsel .= '
                   7682:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7683:         }
1.555     raeburn  7684:     }
1.563     raeburn  7685:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7686: 
                   7687:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7688:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7689:         if ($curr_selected{'srchby'} eq $option) {
                   7690:             $srchbysel .= '
                   7691:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7692:         } else {
                   7693:             $srchbysel .= '
                   7694:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7695:          }
                   7696:     }
                   7697:     $srchbysel .= "\n  </select>\n";
                   7698: 
                   7699:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7700:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7701:         if ($curr_selected{'srchtype'} eq $option) {
                   7702:             $srchtypesel .= '
                   7703:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7704:         } else {
                   7705:             $srchtypesel .= '
                   7706:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7707:         }
                   7708:     }
                   7709:     $srchtypesel .= "\n  </select>\n";
                   7710: 
1.558     albertel 7711:     my ($newuserscript,$new_user_create);
1.556     raeburn  7712: 
                   7713:     if ($forcenewuser) {
1.576     raeburn  7714:         if (ref($srch) eq 'HASH') {
                   7715:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7716:                 if ($cancreate) {
                   7717:                     $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>';
                   7718:                 } else {
1.799     bisitz   7719:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7720:                     my %usertypetext = (
                   7721:                         official   => 'institutional',
                   7722:                         unofficial => 'non-institutional',
                   7723:                     );
1.799     bisitz   7724:                     $new_user_create = '<p class="LC_warning">'
                   7725:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   7726:                                       .' '
                   7727:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7728:                                           ,'<a href="'.$helplink.'">','</a>')
                   7729:                                       .'</p><br />';
1.627     raeburn  7730:                 }
1.576     raeburn  7731:             }
                   7732:         }
                   7733: 
1.556     raeburn  7734:         $newuserscript = <<"ENDSCRIPT";
                   7735: 
1.570     raeburn  7736: function setSearch(createnew,callingForm) {
1.556     raeburn  7737:     if (createnew == 1) {
1.570     raeburn  7738:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7739:             if (callingForm.srchby.options[i].value == 'uname') {
                   7740:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7741:             }
                   7742:         }
1.570     raeburn  7743:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7744:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7745: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7746:             }
                   7747:         }
1.570     raeburn  7748:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7749:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7750:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7751:             }
                   7752:         }
1.570     raeburn  7753:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7754:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7755:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7756:             }
                   7757:         }
                   7758:     }
                   7759: }
                   7760: ENDSCRIPT
1.558     albertel 7761: 
1.556     raeburn  7762:     }
                   7763: 
1.555     raeburn  7764:     my $output = <<"END_BLOCK";
1.556     raeburn  7765: <script type="text/javascript">
1.824     bisitz   7766: // <![CDATA[
1.570     raeburn  7767: function validateEntry(callingForm) {
1.558     albertel 7768: 
1.556     raeburn  7769:     var checkok = 1;
1.558     albertel 7770:     var srchin;
1.570     raeburn  7771:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7772: 	if ( callingForm.srchin[i].checked ) {
                   7773: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7774: 	}
                   7775:     }
                   7776: 
1.570     raeburn  7777:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7778:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7779:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7780:     var srchterm =  callingForm.srchterm.value;
                   7781:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7782:     var msg = "";
                   7783: 
                   7784:     if (srchterm == "") {
                   7785:         checkok = 0;
1.571     raeburn  7786:         msg += "$lt{'youm'}\\n";
1.556     raeburn  7787:     }
                   7788: 
1.569     raeburn  7789:     if (srchtype== 'begins') {
                   7790:         if (srchterm.length < 2) {
                   7791:             checkok = 0;
1.571     raeburn  7792:             msg += "$lt{'thte'}\\n";
1.569     raeburn  7793:         }
                   7794:     }
                   7795: 
1.556     raeburn  7796:     if (srchtype== 'contains') {
                   7797:         if (srchterm.length < 3) {
                   7798:             checkok = 0;
1.571     raeburn  7799:             msg += "$lt{'thet'}\\n";
1.556     raeburn  7800:         }
                   7801:     }
                   7802:     if (srchin == 'instd') {
                   7803:         if (srchdomain == '') {
                   7804:             checkok = 0;
1.571     raeburn  7805:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  7806:         }
                   7807:     }
                   7808:     if (srchin == 'dom') {
                   7809:         if (srchdomain == '') {
                   7810:             checkok = 0;
1.571     raeburn  7811:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  7812:         }
                   7813:     }
                   7814:     if (srchby == 'lastfirst') {
                   7815:         if (srchterm.indexOf(",") == -1) {
                   7816:             checkok = 0;
1.571     raeburn  7817:             msg += "$lt{'whus'}\\n";
1.556     raeburn  7818:         }
                   7819:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   7820:             checkok = 0;
1.571     raeburn  7821:             msg += "$lt{'whse'}\\n";
1.556     raeburn  7822:         }
                   7823:     }
                   7824:     if (checkok == 0) {
1.571     raeburn  7825:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  7826:         return;
                   7827:     }
                   7828:     if (checkok == 1) {
1.570     raeburn  7829:         callingForm.submit();
1.556     raeburn  7830:     }
                   7831: }
                   7832: 
                   7833: $newuserscript
                   7834: 
1.824     bisitz   7835: // ]]>
1.556     raeburn  7836: </script>
1.558     albertel 7837: 
                   7838: $new_user_create
                   7839: 
1.555     raeburn  7840: END_BLOCK
1.558     albertel 7841: 
1.876     raeburn  7842:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   7843:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   7844:                $domform.
                   7845:                &Apache::lonhtmlcommon::row_closure().
                   7846:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   7847:                $srchbysel.
                   7848:                $srchtypesel. 
                   7849:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   7850:                $srchinsel.
                   7851:                &Apache::lonhtmlcommon::row_closure(1). 
                   7852:                &Apache::lonhtmlcommon::end_pick_box().
                   7853:                '<br />';
1.555     raeburn  7854:     return $output;
                   7855: }
                   7856: 
1.612     raeburn  7857: sub user_rule_check {
1.615     raeburn  7858:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  7859:     my $response;
                   7860:     if (ref($usershash) eq 'HASH') {
                   7861:         foreach my $user (keys(%{$usershash})) {
                   7862:             my ($uname,$udom) = split(/:/,$user);
                   7863:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  7864:             my ($id,$newuser);
1.612     raeburn  7865:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  7866:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  7867:                 $id = $usershash->{$user}->{'id'};
                   7868:             }
                   7869:             my $inst_response;
                   7870:             if (ref($checks) eq 'HASH') {
                   7871:                 if (defined($checks->{'username'})) {
1.615     raeburn  7872:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  7873:                         &Apache::lonnet::get_instuser($udom,$uname);
                   7874:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  7875:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  7876:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   7877:                 }
1.615     raeburn  7878:             } else {
                   7879:                 ($inst_response,%{$inst_results->{$user}}) =
                   7880:                     &Apache::lonnet::get_instuser($udom,$uname);
                   7881:                 return;
1.612     raeburn  7882:             }
1.615     raeburn  7883:             if (!$got_rules->{$udom}) {
1.612     raeburn  7884:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   7885:                                                   ['usercreation'],$udom);
                   7886:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  7887:                     foreach my $item ('username','id') {
1.612     raeburn  7888:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   7889:                             $$curr_rules{$udom}{$item} = 
                   7890:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  7891:                         }
                   7892:                     }
                   7893:                 }
1.615     raeburn  7894:                 $got_rules->{$udom} = 1;  
1.585     raeburn  7895:             }
1.612     raeburn  7896:             foreach my $item (keys(%{$checks})) {
                   7897:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   7898:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   7899:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   7900:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   7901:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   7902:                                 if ($rule_check{$rule}) {
                   7903:                                     $$rulematch{$user}{$item} = $rule;
                   7904:                                     if ($inst_response eq 'ok') {
1.615     raeburn  7905:                                         if (ref($inst_results) eq 'HASH') {
                   7906:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   7907:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   7908:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   7909:                                                 }
1.612     raeburn  7910:                                             }
                   7911:                                         }
1.615     raeburn  7912:                                     }
                   7913:                                     last;
1.585     raeburn  7914:                                 }
                   7915:                             }
                   7916:                         }
                   7917:                     }
                   7918:                 }
                   7919:             }
                   7920:         }
                   7921:     }
1.612     raeburn  7922:     return;
                   7923: }
                   7924: 
                   7925: sub user_rule_formats {
                   7926:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   7927:     my %text = ( 
                   7928:                  'username' => 'Usernames',
                   7929:                  'id'       => 'IDs',
                   7930:                );
                   7931:     my $output;
                   7932:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   7933:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   7934:         if (@{$ruleorder} > 0) {
                   7935:             $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>';
                   7936:             foreach my $rule (@{$ruleorder}) {
                   7937:                 if (ref($curr_rules) eq 'ARRAY') {
                   7938:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   7939:                         if (ref($rules->{$rule}) eq 'HASH') {
                   7940:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   7941:                                         $rules->{$rule}{'desc'}.'</li>';
                   7942:                         }
                   7943:                     }
                   7944:                 }
                   7945:             }
                   7946:             $output .= '</ul>';
                   7947:         }
                   7948:     }
                   7949:     return $output;
                   7950: }
                   7951: 
                   7952: sub instrule_disallow_msg {
1.615     raeburn  7953:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  7954:     my $response;
                   7955:     my %text = (
                   7956:                   item   => 'username',
                   7957:                   items  => 'usernames',
                   7958:                   match  => 'matches',
                   7959:                   do     => 'does',
                   7960:                   action => 'a username',
                   7961:                   one    => 'one',
                   7962:                );
                   7963:     if ($count > 1) {
                   7964:         $text{'item'} = 'usernames';
                   7965:         $text{'match'} ='match';
                   7966:         $text{'do'} = 'do';
                   7967:         $text{'action'} = 'usernames',
                   7968:         $text{'one'} = 'ones';
                   7969:     }
                   7970:     if ($checkitem eq 'id') {
                   7971:         $text{'items'} = 'IDs';
                   7972:         $text{'item'} = 'ID';
                   7973:         $text{'action'} = 'an ID';
1.615     raeburn  7974:         if ($count > 1) {
                   7975:             $text{'item'} = 'IDs';
                   7976:             $text{'action'} = 'IDs';
                   7977:         }
1.612     raeburn  7978:     }
1.674     bisitz   7979:     $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  7980:     if ($mode eq 'upload') {
                   7981:         if ($checkitem eq 'username') {
                   7982:             $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'}.");
                   7983:         } elsif ($checkitem eq 'id') {
1.674     bisitz   7984:             $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  7985:         }
1.669     raeburn  7986:     } elsif ($mode eq 'selfcreate') {
                   7987:         if ($checkitem eq 'id') {
                   7988:             $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.");
                   7989:         }
1.615     raeburn  7990:     } else {
                   7991:         if ($checkitem eq 'username') {
                   7992:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   7993:         } elsif ($checkitem eq 'id') {
                   7994:             $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.");
                   7995:         }
1.612     raeburn  7996:     }
                   7997:     return $response;
1.585     raeburn  7998: }
                   7999: 
1.624     raeburn  8000: sub personal_data_fieldtitles {
                   8001:     my %fieldtitles = &Apache::lonlocal::texthash (
                   8002:                         id => 'Student/Employee ID',
                   8003:                         permanentemail => 'E-mail address',
                   8004:                         lastname => 'Last Name',
                   8005:                         firstname => 'First Name',
                   8006:                         middlename => 'Middle Name',
                   8007:                         generation => 'Generation',
                   8008:                         gen => 'Generation',
1.765     raeburn  8009:                         inststatus => 'Affiliation',
1.624     raeburn  8010:                    );
                   8011:     return %fieldtitles;
                   8012: }
                   8013: 
1.642     raeburn  8014: sub sorted_inst_types {
                   8015:     my ($dom) = @_;
                   8016:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   8017:     my $othertitle = &mt('All users');
                   8018:     if ($env{'request.course.id'}) {
1.668     raeburn  8019:         $othertitle  = &mt('Any users');
1.642     raeburn  8020:     }
                   8021:     my @types;
                   8022:     if (ref($order) eq 'ARRAY') {
                   8023:         @types = @{$order};
                   8024:     }
                   8025:     if (@types == 0) {
                   8026:         if (ref($usertypes) eq 'HASH') {
                   8027:             @types = sort(keys(%{$usertypes}));
                   8028:         }
                   8029:     }
                   8030:     if (keys(%{$usertypes}) > 0) {
                   8031:         $othertitle = &mt('Other users');
                   8032:     }
                   8033:     return ($othertitle,$usertypes,\@types);
                   8034: }
                   8035: 
1.645     raeburn  8036: sub get_institutional_codes {
                   8037:     my ($settings,$allcourses,$LC_code) = @_;
                   8038: # Get complete list of course sections to update
                   8039:     my @currsections = ();
                   8040:     my @currxlists = ();
                   8041:     my $coursecode = $$settings{'internal.coursecode'};
                   8042: 
                   8043:     if ($$settings{'internal.sectionnums'} ne '') {
                   8044:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   8045:     }
                   8046: 
                   8047:     if ($$settings{'internal.crosslistings'} ne '') {
                   8048:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   8049:     }
                   8050: 
                   8051:     if (@currxlists > 0) {
                   8052:         foreach (@currxlists) {
                   8053:             if (m/^([^:]+):(\w*)$/) {
                   8054:                 unless (grep/^$1$/,@{$allcourses}) {
                   8055:                     push @{$allcourses},$1;
                   8056:                     $$LC_code{$1} = $2;
                   8057:                 }
                   8058:             }
                   8059:         }
                   8060:     }
                   8061:  
                   8062:     if (@currsections > 0) {
                   8063:         foreach (@currsections) {
                   8064:             if (m/^(\w+):(\w*)$/) {
                   8065:                 my $sec = $coursecode.$1;
                   8066:                 my $lc_sec = $2;
                   8067:                 unless (grep/^$sec$/,@{$allcourses}) {
                   8068:                     push @{$allcourses},$sec;
                   8069:                     $$LC_code{$sec} = $lc_sec;
                   8070:                 }
                   8071:             }
                   8072:         }
                   8073:     }
                   8074:     return;
                   8075: }
                   8076: 
1.971     raeburn  8077: sub get_standard_codeitems {
                   8078:     return ('Year','Semester','Department','Number','Section');
                   8079: }
                   8080: 
1.112     bowersj2 8081: =pod
                   8082: 
1.780     raeburn  8083: =head1 Slot Helpers
                   8084: 
                   8085: =over 4
                   8086: 
                   8087: =item * sorted_slots()
                   8088: 
                   8089: Sorts an array of slot names in order of slot start time (earliest first). 
                   8090: 
                   8091: Inputs:
                   8092: 
                   8093: =over 4
                   8094: 
                   8095: slotsarr  - Reference to array of unsorted slot names.
                   8096: 
                   8097: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   8098: 
1.549     albertel 8099: =back
                   8100: 
1.780     raeburn  8101: Returns:
                   8102: 
                   8103: =over 4
                   8104: 
                   8105: sorted   - An array of slot names sorted by the start time of the slot.
                   8106: 
                   8107: =back
                   8108: 
                   8109: =back
                   8110: 
                   8111: =cut
                   8112: 
                   8113: 
                   8114: sub sorted_slots {
                   8115:     my ($slotsarr,$slots) = @_;
                   8116:     my @sorted;
                   8117:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   8118:         @sorted =
                   8119:             sort {
                   8120:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   8121:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   8122:                      }
                   8123:                      if (ref($slots->{$a})) { return -1;}
                   8124:                      if (ref($slots->{$b})) { return 1;}
                   8125:                      return 0;
                   8126:                  } @{$slotsarr};
                   8127:     }
                   8128:     return @sorted;
                   8129: }
                   8130: 
                   8131: 
                   8132: =pod
                   8133: 
1.549     albertel 8134: =head1 HTTP Helpers
                   8135: 
                   8136: =over 4
                   8137: 
1.648     raeburn  8138: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 8139: 
1.258     albertel 8140: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8141: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8142: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8143: 
                   8144: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8145: $possible_names is an ref to an array of form element names.  As an example:
                   8146: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8147: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8148: 
                   8149: =cut
1.1       albertel 8150: 
1.6       albertel 8151: sub get_unprocessed_cgi {
1.25      albertel 8152:   my ($query,$possible_names)= @_;
1.26      matthew  8153:   # $Apache::lonxml::debug=1;
1.356     albertel 8154:   foreach my $pair (split(/&/,$query)) {
                   8155:     my ($name, $value) = split(/=/,$pair);
1.369     www      8156:     $name = &unescape($name);
1.25      albertel 8157:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8158:       $value =~ tr/+/ /;
                   8159:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8160:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8161:     }
1.16      harris41 8162:   }
1.6       albertel 8163: }
                   8164: 
1.112     bowersj2 8165: =pod
                   8166: 
1.648     raeburn  8167: =item * &cacheheader() 
1.112     bowersj2 8168: 
                   8169: returns cache-controlling header code
                   8170: 
                   8171: =cut
                   8172: 
1.7       albertel 8173: sub cacheheader {
1.258     albertel 8174:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8175:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8176:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8177:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8178:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8179:     return $output;
1.7       albertel 8180: }
                   8181: 
1.112     bowersj2 8182: =pod
                   8183: 
1.648     raeburn  8184: =item * &no_cache($r) 
1.112     bowersj2 8185: 
                   8186: specifies header code to not have cache
                   8187: 
                   8188: =cut
                   8189: 
1.9       albertel 8190: sub no_cache {
1.216     albertel 8191:     my ($r) = @_;
                   8192:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8193: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8194:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8195:     $r->no_cache(1);
                   8196:     $r->header_out("Expires" => $date);
                   8197:     $r->header_out("Pragma" => "no-cache");
1.123     www      8198: }
                   8199: 
                   8200: sub content_type {
1.181     albertel 8201:     my ($r,$type,$charset) = @_;
1.299     foxr     8202:     if ($r) {
                   8203: 	#  Note that printout.pl calls this with undef for $r.
                   8204: 	&no_cache($r);
                   8205:     }
1.258     albertel 8206:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8207:     unless ($charset) {
                   8208: 	$charset=&Apache::lonlocal::current_encoding;
                   8209:     }
                   8210:     if ($charset) { $type.='; charset='.$charset; }
                   8211:     if ($r) {
                   8212: 	$r->content_type($type);
                   8213:     } else {
                   8214: 	print("Content-type: $type\n\n");
                   8215:     }
1.9       albertel 8216: }
1.25      albertel 8217: 
1.112     bowersj2 8218: =pod
                   8219: 
1.648     raeburn  8220: =item * &add_to_env($name,$value) 
1.112     bowersj2 8221: 
1.258     albertel 8222: adds $name to the %env hash with value
1.112     bowersj2 8223: $value, if $name already exists, the entry is converted to an array
                   8224: reference and $value is added to the array.
                   8225: 
                   8226: =cut
                   8227: 
1.25      albertel 8228: sub add_to_env {
                   8229:   my ($name,$value)=@_;
1.258     albertel 8230:   if (defined($env{$name})) {
                   8231:     if (ref($env{$name})) {
1.25      albertel 8232:       #already have multiple values
1.258     albertel 8233:       push(@{ $env{$name} },$value);
1.25      albertel 8234:     } else {
                   8235:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8236:       my $first=$env{$name};
                   8237:       undef($env{$name});
                   8238:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8239:     }
                   8240:   } else {
1.258     albertel 8241:     $env{$name}=$value;
1.25      albertel 8242:   }
1.31      albertel 8243: }
1.149     albertel 8244: 
                   8245: =pod
                   8246: 
1.648     raeburn  8247: =item * &get_env_multiple($name) 
1.149     albertel 8248: 
1.258     albertel 8249: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8250: values may be defined and end up as an array ref.
                   8251: 
                   8252: returns an array of values
                   8253: 
                   8254: =cut
                   8255: 
                   8256: sub get_env_multiple {
                   8257:     my ($name) = @_;
                   8258:     my @values;
1.258     albertel 8259:     if (defined($env{$name})) {
1.149     albertel 8260:         # exists is it an array
1.258     albertel 8261:         if (ref($env{$name})) {
                   8262:             @values=@{ $env{$name} };
1.149     albertel 8263:         } else {
1.258     albertel 8264:             $values[0]=$env{$name};
1.149     albertel 8265:         }
                   8266:     }
                   8267:     return(@values);
                   8268: }
                   8269: 
1.660     raeburn  8270: sub ask_for_embedded_content {
                   8271:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8272:     my $upload_output = '
                   8273:    <form name="upload_embedded" action="'.$actionurl.'"
                   8274:                   method="post" enctype="multipart/form-data">';
                   8275:     $upload_output .= $state;
1.661     raeburn  8276:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8277: 
                   8278:     my $num = 0;
                   8279:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8280:         $upload_output .= &start_data_table_row().
                   8281:             '<td>'.$embed_file.'</td><td>';
                   8282:         if ($args->{'ignore_remote_references'}
                   8283:             && $embed_file =~ m{^\w+://}) {
                   8284:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8285:         } elsif ($args->{'error_on_invalid_names'}
                   8286:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8287: 
                   8288:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8289: 
                   8290:         } else {
                   8291:             $upload_output .='
1.661     raeburn  8292:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8293:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8294:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8295:             $upload_output .=
                   8296:                 "\n\t\t".
                   8297:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8298:                 $attrib.'" />';
                   8299:             if (exists($$codebase{$embed_file})) {
                   8300:                 $upload_output .=
                   8301:                     "\n\t\t".
                   8302:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8303:                     &escape($$codebase{$embed_file}).'" />';
                   8304:             }
                   8305:         }
                   8306:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8307:         $num++;
                   8308:     }
                   8309:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8310:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8311:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8312:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8313:    </form>';
                   8314:     return $upload_output;
                   8315: }
                   8316: 
1.661     raeburn  8317: sub upload_embedded {
                   8318:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8319:         $current_disk_usage) = @_;
                   8320:     my $output;
                   8321:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8322:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8323:         my $orig_uploaded_filename =
                   8324:             $env{'form.embedded_item_'.$i.'.filename'};
                   8325: 
                   8326:         $env{'form.embedded_orig_'.$i} =
                   8327:             &unescape($env{'form.embedded_orig_'.$i});
                   8328:         my ($path,$fname) =
                   8329:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8330:         # no path, whole string is fname
                   8331:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8332: 
                   8333:         $path = $env{'form.currentpath'}.$path;
                   8334:         $fname = &Apache::lonnet::clean_filename($fname);
                   8335:         # See if there is anything left
                   8336:         next if ($fname eq '');
                   8337: 
                   8338:         # Check if file already exists as a file or directory.
                   8339:         my ($state,$msg);
                   8340:         if ($context eq 'portfolio') {
                   8341:             my $port_path = $dirpath;
                   8342:             if ($group ne '') {
                   8343:                 $port_path = "groups/$group/$port_path";
                   8344:             }
                   8345:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8346:                                               $dir_root,$port_path,$disk_quota,
                   8347:                                               $current_disk_usage,$uname,$udom);
                   8348:             if ($state eq 'will_exceed_quota'
                   8349:                 || $state eq 'file_locked'
                   8350:                 || $state eq 'file_exists' ) {
                   8351:                 $output .= $msg;
                   8352:                 next;
                   8353:             }
                   8354:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8355:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8356:             if ($state eq 'exists') {
                   8357:                 $output .= $msg;
                   8358:                 next;
                   8359:             }
                   8360:         }
                   8361:         # Check if extension is valid
                   8362:         if (($fname =~ /\.(\w+)$/) &&
                   8363:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8364:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8365:             next;
                   8366:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8367:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8368:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8369:             next;
                   8370:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8371:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8372:             next;
                   8373:         }
                   8374: 
                   8375:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8376:         if ($context eq 'portfolio') {
                   8377:             my $result=
                   8378:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8379:                                                 $dirpath.$path);
                   8380:             if ($result !~ m|^/uploaded/|) {
                   8381:                 $output .= '<span class="LC_error">'
                   8382:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8383:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8384:                       .'</span><br />';
                   8385:                 next;
                   8386:             } else {
                   8387:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8388:                            $path.$fname.'</span>').'</p>';     
                   8389:             }
                   8390:         } else {
                   8391: # Save the file
                   8392:             my $target = $env{'form.embedded_item_'.$i};
                   8393:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8394:             my $dest = $fullpath.$fname;
                   8395:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8396:             my @parts=split(/\//,$fullpath);
                   8397:             my $count;
                   8398:             my $filepath = $dir_root;
                   8399:             for ($count=4;$count<=$#parts;$count++) {
                   8400:                 $filepath .= "/$parts[$count]";
                   8401:                 if ((-e $filepath)!=1) {
                   8402:                     mkdir($filepath,0770);
                   8403:                 }
                   8404:             }
                   8405:             my $fh;
                   8406:             if (!open($fh,'>'.$dest)) {
                   8407:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8408:                 $output .= '<span class="LC_error">'.
                   8409:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8410:                            '</span><br />';
                   8411:             } else {
                   8412:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8413:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8414:                     $output .= '<span class="LC_error">'.
                   8415:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8416:                               '</span><br />';
                   8417:                 } else {
                   8418:                     if ($context eq 'testbank') {
                   8419:                         $output .= &mt('Embedded file uploaded successfully:').
                   8420:                                    '&nbsp;<a href="'.$url.'">'.
                   8421:                                    $orig_uploaded_filename.'</a><br />';
                   8422:                     } else {
1.705     tempelho 8423:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8424:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8425:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8426:                     }
                   8427:                 }
                   8428:                 close($fh);
                   8429:             }
                   8430:         }
                   8431:     }
                   8432:     return $output;
                   8433: }
                   8434: 
                   8435: sub check_for_existing {
                   8436:     my ($path,$fname,$element) = @_;
                   8437:     my ($state,$msg);
                   8438:     if (-d $path.'/'.$fname) {
                   8439:         $state = 'exists';
                   8440:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8441:     } elsif (-e $path.'/'.$fname) {
                   8442:         $state = 'exists';
                   8443:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8444:     }
                   8445:     if ($state eq 'exists') {
                   8446:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8447:     }
                   8448:     return ($state,$msg);
                   8449: }
                   8450: 
                   8451: sub check_for_upload {
                   8452:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8453:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8454:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8455:     my $getpropath = 1;
                   8456:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8457:                                             $getpropath);
                   8458:     my $found_file = 0;
                   8459:     my $locked_file = 0;
                   8460:     foreach my $line (@dir_list) {
                   8461:         my ($file_name)=split(/\&/,$line,2);
                   8462:         if ($file_name eq $fname){
                   8463:             $file_name = $path.$file_name;
                   8464:             if ($group ne '') {
                   8465:                 $file_name = $group.$file_name;
                   8466:             }
                   8467:             $found_file = 1;
                   8468:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8469:                 $locked_file = 1;
                   8470:             }
                   8471:         }
                   8472:     }
                   8473:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8474:         my $msg = '<span class="LC_error">'.
                   8475:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8476:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8477:         return ('will_exceed_quota',$msg);
                   8478:     } elsif ($found_file) {
                   8479:         if ($locked_file) {
                   8480:             my $msg = '<span class="LC_error">';
                   8481:             $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>');
                   8482:             $msg .= '</span><br />';
                   8483:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8484:             return ('file_locked',$msg);
                   8485:         } else {
                   8486:             my $msg = '<span class="LC_error">';
                   8487:             $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'});
                   8488:             $msg .= '</span>';
                   8489:             $msg .= '<br />';
                   8490:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8491:             return ('file_exists',$msg);
                   8492:         }
                   8493:     }
                   8494: }
                   8495: 
1.31      albertel 8496: 
1.41      ng       8497: =pod
1.45      matthew  8498: 
1.464     albertel 8499: =back
1.41      ng       8500: 
1.112     bowersj2 8501: =head1 CSV Upload/Handling functions
1.38      albertel 8502: 
1.41      ng       8503: =over 4
                   8504: 
1.648     raeburn  8505: =item * &upfile_store($r)
1.41      ng       8506: 
                   8507: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8508: needs $env{'form.upfile'}
1.41      ng       8509: returns $datatoken to be put into hidden field
                   8510: 
                   8511: =cut
1.31      albertel 8512: 
                   8513: sub upfile_store {
                   8514:     my $r=shift;
1.258     albertel 8515:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8516:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8517:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8518:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8519: 
1.258     albertel 8520:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8521: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8522:     {
1.158     raeburn  8523:         my $datafile = $r->dir_config('lonDaemons').
                   8524:                            '/tmp/'.$datatoken.'.tmp';
                   8525:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8526:             print $fh $env{'form.upfile'};
1.158     raeburn  8527:             close($fh);
                   8528:         }
1.31      albertel 8529:     }
                   8530:     return $datatoken;
                   8531: }
                   8532: 
1.56      matthew  8533: =pod
                   8534: 
1.648     raeburn  8535: =item * &load_tmp_file($r)
1.41      ng       8536: 
                   8537: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8538: needs $env{'form.datatoken'},
                   8539: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8540: 
                   8541: =cut
1.31      albertel 8542: 
                   8543: sub load_tmp_file {
                   8544:     my $r=shift;
                   8545:     my @studentdata=();
                   8546:     {
1.158     raeburn  8547:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8548:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8549:         if ( open(my $fh,"<$studentfile") ) {
                   8550:             @studentdata=<$fh>;
                   8551:             close($fh);
                   8552:         }
1.31      albertel 8553:     }
1.258     albertel 8554:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8555: }
                   8556: 
1.56      matthew  8557: =pod
                   8558: 
1.648     raeburn  8559: =item * &upfile_record_sep()
1.41      ng       8560: 
                   8561: Separate uploaded file into records
                   8562: returns array of records,
1.258     albertel 8563: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8564: 
                   8565: =cut
1.31      albertel 8566: 
                   8567: sub upfile_record_sep {
1.258     albertel 8568:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8569:     } else {
1.248     albertel 8570: 	my @records;
1.258     albertel 8571: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8572: 	    if ($line=~/^\s*$/) { next; }
                   8573: 	    push(@records,$line);
                   8574: 	}
                   8575: 	return @records;
1.31      albertel 8576:     }
                   8577: }
                   8578: 
1.56      matthew  8579: =pod
                   8580: 
1.648     raeburn  8581: =item * &record_sep($record)
1.41      ng       8582: 
1.258     albertel 8583: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8584: 
                   8585: =cut
                   8586: 
1.263     www      8587: sub takeleft {
                   8588:     my $index=shift;
                   8589:     return substr('0000'.$index,-4,4);
                   8590: }
                   8591: 
1.31      albertel 8592: sub record_sep {
                   8593:     my $record=shift;
                   8594:     my %components=();
1.258     albertel 8595:     if ($env{'form.upfiletype'} eq 'xml') {
                   8596:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8597:         my $i=0;
1.356     albertel 8598:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8599:             $field=~s/^(\"|\')//;
                   8600:             $field=~s/(\"|\')$//;
1.263     www      8601:             $components{&takeleft($i)}=$field;
1.31      albertel 8602:             $i++;
                   8603:         }
1.258     albertel 8604:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8605:         my $i=0;
1.356     albertel 8606:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8607:             $field=~s/^(\"|\')//;
                   8608:             $field=~s/(\"|\')$//;
1.263     www      8609:             $components{&takeleft($i)}=$field;
1.31      albertel 8610:             $i++;
                   8611:         }
                   8612:     } else {
1.561     www      8613:         my $separator=',';
1.480     banghart 8614:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8615:             $separator=';';
1.480     banghart 8616:         }
1.31      albertel 8617:         my $i=0;
1.561     www      8618: # the character we are looking for to indicate the end of a quote or a record 
                   8619:         my $looking_for=$separator;
                   8620: # do not add the characters to the fields
                   8621:         my $ignore=0;
                   8622: # we just encountered a separator (or the beginning of the record)
                   8623:         my $just_found_separator=1;
                   8624: # store the field we are working on here
                   8625:         my $field='';
                   8626: # work our way through all characters in record
                   8627:         foreach my $character ($record=~/(.)/g) {
                   8628:             if ($character eq $looking_for) {
                   8629:                if ($character ne $separator) {
                   8630: # Found the end of a quote, again looking for separator
                   8631:                   $looking_for=$separator;
                   8632:                   $ignore=1;
                   8633:                } else {
                   8634: # Found a separator, store away what we got
                   8635:                   $components{&takeleft($i)}=$field;
                   8636: 	          $i++;
                   8637:                   $just_found_separator=1;
                   8638:                   $ignore=0;
                   8639:                   $field='';
                   8640:                }
                   8641:                next;
                   8642:             }
                   8643: # single or double quotation marks after a separator indicate beginning of a quote
                   8644: # we are now looking for the end of the quote and need to ignore separators
                   8645:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8646:                $looking_for=$character;
                   8647:                next;
                   8648:             }
                   8649: # ignore would be true after we reached the end of a quote
                   8650:             if ($ignore) { next; }
                   8651:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8652:             $field.=$character;
                   8653:             $just_found_separator=0; 
1.31      albertel 8654:         }
1.561     www      8655: # catch the very last entry, since we never encountered the separator
                   8656:         $components{&takeleft($i)}=$field;
1.31      albertel 8657:     }
                   8658:     return %components;
                   8659: }
                   8660: 
1.144     matthew  8661: ######################################################
                   8662: ######################################################
                   8663: 
1.56      matthew  8664: =pod
                   8665: 
1.648     raeburn  8666: =item * &upfile_select_html()
1.41      ng       8667: 
1.144     matthew  8668: Return HTML code to select a file from the users machine and specify 
                   8669: the file type.
1.41      ng       8670: 
                   8671: =cut
                   8672: 
1.144     matthew  8673: ######################################################
                   8674: ######################################################
1.31      albertel 8675: sub upfile_select_html {
1.144     matthew  8676:     my %Types = (
                   8677:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8678:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8679:                  space => &mt('Space separated'),
                   8680:                  tab   => &mt('Tabulator separated'),
                   8681: #                 xml   => &mt('HTML/XML'),
                   8682:                  );
                   8683:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8684:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8685:     foreach my $type (sort(keys(%Types))) {
                   8686:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8687:     }
                   8688:     $Str .= "</select>\n";
                   8689:     return $Str;
1.31      albertel 8690: }
                   8691: 
1.301     albertel 8692: sub get_samples {
                   8693:     my ($records,$toget) = @_;
                   8694:     my @samples=({});
                   8695:     my $got=0;
                   8696:     foreach my $rec (@$records) {
                   8697: 	my %temp = &record_sep($rec);
                   8698: 	if (! grep(/\S/, values(%temp))) { next; }
                   8699: 	if (%temp) {
                   8700: 	    $samples[$got]=\%temp;
                   8701: 	    $got++;
                   8702: 	    if ($got == $toget) { last; }
                   8703: 	}
                   8704:     }
                   8705:     return \@samples;
                   8706: }
                   8707: 
1.144     matthew  8708: ######################################################
                   8709: ######################################################
                   8710: 
1.56      matthew  8711: =pod
                   8712: 
1.648     raeburn  8713: =item * &csv_print_samples($r,$records)
1.41      ng       8714: 
                   8715: Prints a table of sample values from each column uploaded $r is an
                   8716: Apache Request ref, $records is an arrayref from
                   8717: &Apache::loncommon::upfile_record_sep
                   8718: 
                   8719: =cut
                   8720: 
1.144     matthew  8721: ######################################################
                   8722: ######################################################
1.31      albertel 8723: sub csv_print_samples {
                   8724:     my ($r,$records) = @_;
1.662     bisitz   8725:     my $samples = &get_samples($records,5);
1.301     albertel 8726: 
1.594     raeburn  8727:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8728:               &start_data_table_header_row());
1.356     albertel 8729:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   8730:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  8731:     $r->print(&end_data_table_header_row());
1.301     albertel 8732:     foreach my $hash (@$samples) {
1.594     raeburn  8733: 	$r->print(&start_data_table_row());
1.356     albertel 8734: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8735: 	    $r->print('<td>');
1.356     albertel 8736: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8737: 	    $r->print('</td>');
                   8738: 	}
1.594     raeburn  8739: 	$r->print(&end_data_table_row());
1.31      albertel 8740:     }
1.594     raeburn  8741:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8742: }
                   8743: 
1.144     matthew  8744: ######################################################
                   8745: ######################################################
                   8746: 
1.56      matthew  8747: =pod
                   8748: 
1.648     raeburn  8749: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8750: 
                   8751: Prints a table to create associations between values and table columns.
1.144     matthew  8752: 
1.41      ng       8753: $r is an Apache Request ref,
                   8754: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8755: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8756: 
                   8757: =cut
                   8758: 
1.144     matthew  8759: ######################################################
                   8760: ######################################################
1.31      albertel 8761: sub csv_print_select_table {
                   8762:     my ($r,$records,$d) = @_;
1.301     albertel 8763:     my $i=0;
                   8764:     my $samples = &get_samples($records,1);
1.144     matthew  8765:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8766: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8767:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8768:               '<th>'.&mt('Column').'</th>'.
                   8769:               &end_data_table_header_row()."\n");
1.356     albertel 8770:     foreach my $array_ref (@$d) {
                   8771: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8772: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8773: 
1.875     bisitz   8774: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  8775: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8776: 	$r->print('<option value="none"></option>');
1.356     albertel 8777: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8778: 	    $r->print('<option value="'.$sample.'"'.
                   8779:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8780:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8781: 	}
1.594     raeburn  8782: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8783: 	$i++;
                   8784:     }
1.594     raeburn  8785:     $r->print(&end_data_table());
1.31      albertel 8786:     $i--;
                   8787:     return $i;
                   8788: }
1.56      matthew  8789: 
1.144     matthew  8790: ######################################################
                   8791: ######################################################
                   8792: 
1.56      matthew  8793: =pod
1.31      albertel 8794: 
1.648     raeburn  8795: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       8796: 
                   8797: Prints a table of sample values from the upload and can make associate samples to internal names.
                   8798: 
                   8799: $r is an Apache Request ref,
                   8800: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   8801: $d is an array of 2 element arrays (internal name, displayed name)
                   8802: 
                   8803: =cut
                   8804: 
1.144     matthew  8805: ######################################################
                   8806: ######################################################
1.31      albertel 8807: sub csv_samples_select_table {
                   8808:     my ($r,$records,$d) = @_;
                   8809:     my $i=0;
1.144     matthew  8810:     #
1.662     bisitz   8811:     my $max_samples = 5;
                   8812:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  8813:     $r->print(&start_data_table().
                   8814:               &start_data_table_header_row().'<th>'.
                   8815:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   8816:               &end_data_table_header_row());
1.301     albertel 8817: 
                   8818:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  8819: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  8820: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 8821: 	foreach my $option (@$d) {
                   8822: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  8823: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 8824:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  8825:                       $display.'</option>');
1.31      albertel 8826: 	}
                   8827: 	$r->print('</select></td><td>');
1.662     bisitz   8828: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 8829: 	    if (defined($samples->[$line]{$key})) { 
                   8830: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   8831: 	    }
                   8832: 	}
1.594     raeburn  8833: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 8834: 	$i++;
                   8835:     }
1.594     raeburn  8836:     $r->print(&end_data_table());
1.31      albertel 8837:     $i--;
                   8838:     return($i);
1.115     matthew  8839: }
                   8840: 
1.144     matthew  8841: ######################################################
                   8842: ######################################################
                   8843: 
1.115     matthew  8844: =pod
                   8845: 
1.648     raeburn  8846: =item * &clean_excel_name($name)
1.115     matthew  8847: 
                   8848: Returns a replacement for $name which does not contain any illegal characters.
                   8849: 
                   8850: =cut
                   8851: 
1.144     matthew  8852: ######################################################
                   8853: ######################################################
1.115     matthew  8854: sub clean_excel_name {
                   8855:     my ($name) = @_;
                   8856:     $name =~ s/[:\*\?\/\\]//g;
                   8857:     if (length($name) > 31) {
                   8858:         $name = substr($name,0,31);
                   8859:     }
                   8860:     return $name;
1.25      albertel 8861: }
1.84      albertel 8862: 
1.85      albertel 8863: =pod
                   8864: 
1.648     raeburn  8865: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 8866: 
                   8867: Returns either 1 or undef
                   8868: 
                   8869: 1 if the part is to be hidden, undef if it is to be shown
                   8870: 
                   8871: Arguments are:
                   8872: 
                   8873: $id the id of the part to be checked
                   8874: $symb, optional the symb of the resource to check
                   8875: $udom, optional the domain of the user to check for
                   8876: $uname, optional the username of the user to check for
                   8877: 
                   8878: =cut
1.84      albertel 8879: 
                   8880: sub check_if_partid_hidden {
                   8881:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 8882:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 8883: 					 $symb,$udom,$uname);
1.141     albertel 8884:     my $truth=1;
                   8885:     #if the string starts with !, then the list is the list to show not hide
                   8886:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 8887:     my @hiddenlist=split(/,/,$hiddenparts);
                   8888:     foreach my $checkid (@hiddenlist) {
1.141     albertel 8889: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 8890:     }
1.141     albertel 8891:     return !$truth;
1.84      albertel 8892: }
1.127     matthew  8893: 
1.138     matthew  8894: 
                   8895: ############################################################
                   8896: ############################################################
                   8897: 
                   8898: =pod
                   8899: 
1.157     matthew  8900: =back 
                   8901: 
1.138     matthew  8902: =head1 cgi-bin script and graphing routines
                   8903: 
1.157     matthew  8904: =over 4
                   8905: 
1.648     raeburn  8906: =item * &get_cgi_id()
1.138     matthew  8907: 
                   8908: Inputs: none
                   8909: 
                   8910: Returns an id which can be used to pass environment variables
                   8911: to various cgi-bin scripts.  These environment variables will
                   8912: be removed from the users environment after a given time by
                   8913: the routine &Apache::lonnet::transfer_profile_to_env.
                   8914: 
                   8915: =cut
                   8916: 
                   8917: ############################################################
                   8918: ############################################################
1.152     albertel 8919: my $uniq=0;
1.136     matthew  8920: sub get_cgi_id {
1.154     albertel 8921:     $uniq=($uniq+1)%100000;
1.280     albertel 8922:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  8923: }
                   8924: 
1.127     matthew  8925: ############################################################
                   8926: ############################################################
                   8927: 
                   8928: =pod
                   8929: 
1.648     raeburn  8930: =item * &DrawBarGraph()
1.127     matthew  8931: 
1.138     matthew  8932: Facilitates the plotting of data in a (stacked) bar graph.
                   8933: Puts plot definition data into the users environment in order for 
                   8934: graph.png to plot it.  Returns an <img> tag for the plot.
                   8935: The bars on the plot are labeled '1','2',...,'n'.
                   8936: 
                   8937: Inputs:
                   8938: 
                   8939: =over 4
                   8940: 
                   8941: =item $Title: string, the title of the plot
                   8942: 
                   8943: =item $xlabel: string, text describing the X-axis of the plot
                   8944: 
                   8945: =item $ylabel: string, text describing the Y-axis of the plot
                   8946: 
                   8947: =item $Max: scalar, the maximum Y value to use in the plot
                   8948: If $Max is < any data point, the graph will not be rendered.
                   8949: 
1.140     matthew  8950: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  8951: they are plotted.  If undefined, default values will be used.
                   8952: 
1.178     matthew  8953: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   8954: 
1.138     matthew  8955: =item @Values: An array of array references.  Each array reference holds data
                   8956: to be plotted in a stacked bar chart.
                   8957: 
1.239     matthew  8958: =item If the final element of @Values is a hash reference the key/value
                   8959: pairs will be added to the graph definition.
                   8960: 
1.138     matthew  8961: =back
                   8962: 
                   8963: Returns:
                   8964: 
                   8965: An <img> tag which references graph.png and the appropriate identifying
                   8966: information for the plot.
                   8967: 
1.127     matthew  8968: =cut
                   8969: 
                   8970: ############################################################
                   8971: ############################################################
1.134     matthew  8972: sub DrawBarGraph {
1.178     matthew  8973:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  8974:     #
                   8975:     if (! defined($colors)) {
                   8976:         $colors = ['#33ff00', 
                   8977:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   8978:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   8979:                   ]; 
                   8980:     }
1.228     matthew  8981:     my $extra_settings = {};
                   8982:     if (ref($Values[-1]) eq 'HASH') {
                   8983:         $extra_settings = pop(@Values);
                   8984:     }
1.127     matthew  8985:     #
1.136     matthew  8986:     my $identifier = &get_cgi_id();
                   8987:     my $id = 'cgi.'.$identifier;        
1.129     matthew  8988:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  8989:         return '';
                   8990:     }
1.225     matthew  8991:     #
                   8992:     my @Labels;
                   8993:     if (defined($labels)) {
                   8994:         @Labels = @$labels;
                   8995:     } else {
                   8996:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   8997:             push (@Labels,$i+1);
                   8998:         }
                   8999:     }
                   9000:     #
1.129     matthew  9001:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  9002:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  9003:     my %ValuesHash;
                   9004:     my $NumSets=1;
                   9005:     foreach my $array (@Values) {
                   9006:         next if (! ref($array));
1.136     matthew  9007:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  9008:             join(',',@$array);
1.129     matthew  9009:     }
1.127     matthew  9010:     #
1.136     matthew  9011:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  9012:     if ($NumBars < 3) {
                   9013:         $width = 120+$NumBars*32;
1.220     matthew  9014:         $xskip = 1;
1.225     matthew  9015:         $bar_width = 30;
                   9016:     } elsif ($NumBars < 5) {
                   9017:         $width = 120+$NumBars*20;
                   9018:         $xskip = 1;
                   9019:         $bar_width = 20;
1.220     matthew  9020:     } elsif ($NumBars < 10) {
1.136     matthew  9021:         $width = 120+$NumBars*15;
                   9022:         $xskip = 1;
                   9023:         $bar_width = 15;
                   9024:     } elsif ($NumBars <= 25) {
                   9025:         $width = 120+$NumBars*11;
                   9026:         $xskip = 5;
                   9027:         $bar_width = 8;
                   9028:     } elsif ($NumBars <= 50) {
                   9029:         $width = 120+$NumBars*8;
                   9030:         $xskip = 5;
                   9031:         $bar_width = 4;
                   9032:     } else {
                   9033:         $width = 120+$NumBars*8;
                   9034:         $xskip = 5;
                   9035:         $bar_width = 4;
                   9036:     }
                   9037:     #
1.137     matthew  9038:     $Max = 1 if ($Max < 1);
                   9039:     if ( int($Max) < $Max ) {
                   9040:         $Max++;
                   9041:         $Max = int($Max);
                   9042:     }
1.127     matthew  9043:     $Title  = '' if (! defined($Title));
                   9044:     $xlabel = '' if (! defined($xlabel));
                   9045:     $ylabel = '' if (! defined($ylabel));
1.369     www      9046:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   9047:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   9048:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  9049:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  9050:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   9051:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   9052:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   9053:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9054:     $ValuesHash{$id.'.height'}   = $height;
                   9055:     $ValuesHash{$id.'.width'}    = $width;
                   9056:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   9057:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   9058:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  9059:     #
1.228     matthew  9060:     # Deal with other parameters
                   9061:     while (my ($key,$value) = each(%$extra_settings)) {
                   9062:         $ValuesHash{$id.'.'.$key} = $value;
                   9063:     }
                   9064:     #
1.646     raeburn  9065:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  9066:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9067: }
                   9068: 
                   9069: ############################################################
                   9070: ############################################################
                   9071: 
                   9072: =pod
                   9073: 
1.648     raeburn  9074: =item * &DrawXYGraph()
1.137     matthew  9075: 
1.138     matthew  9076: Facilitates the plotting of data in an XY graph.
                   9077: Puts plot definition data into the users environment in order for 
                   9078: graph.png to plot it.  Returns an <img> tag for the plot.
                   9079: 
                   9080: Inputs:
                   9081: 
                   9082: =over 4
                   9083: 
                   9084: =item $Title: string, the title of the plot
                   9085: 
                   9086: =item $xlabel: string, text describing the X-axis of the plot
                   9087: 
                   9088: =item $ylabel: string, text describing the Y-axis of the plot
                   9089: 
                   9090: =item $Max: scalar, the maximum Y value to use in the plot
                   9091: If $Max is < any data point, the graph will not be rendered.
                   9092: 
                   9093: =item $colors: Array ref containing the hex color codes for the data to be 
                   9094: plotted in.  If undefined, default values will be used.
                   9095: 
                   9096: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9097: 
                   9098: =item $Ydata: Array ref containing Array refs.  
1.185     www      9099: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  9100: 
                   9101: =item %Values: hash indicating or overriding any default values which are 
                   9102: passed to graph.png.  
                   9103: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9104: 
                   9105: =back
                   9106: 
                   9107: Returns:
                   9108: 
                   9109: An <img> tag which references graph.png and the appropriate identifying
                   9110: information for the plot.
                   9111: 
1.137     matthew  9112: =cut
                   9113: 
                   9114: ############################################################
                   9115: ############################################################
                   9116: sub DrawXYGraph {
                   9117:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   9118:     #
                   9119:     # Create the identifier for the graph
                   9120:     my $identifier = &get_cgi_id();
                   9121:     my $id = 'cgi.'.$identifier;
                   9122:     #
                   9123:     $Title  = '' if (! defined($Title));
                   9124:     $xlabel = '' if (! defined($xlabel));
                   9125:     $ylabel = '' if (! defined($ylabel));
                   9126:     my %ValuesHash = 
                   9127:         (
1.369     www      9128:          $id.'.title'  => &escape($Title),
                   9129:          $id.'.xlabel' => &escape($xlabel),
                   9130:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  9131:          $id.'.y_max_value'=> $Max,
                   9132:          $id.'.labels'     => join(',',@$Xlabels),
                   9133:          $id.'.PlotType'   => 'XY',
                   9134:          );
                   9135:     #
                   9136:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9137:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9138:     }
                   9139:     #
                   9140:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   9141:         return '';
                   9142:     }
                   9143:     my $NumSets=1;
1.138     matthew  9144:     foreach my $array (@{$Ydata}){
1.137     matthew  9145:         next if (! ref($array));
                   9146:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   9147:     }
1.138     matthew  9148:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  9149:     #
                   9150:     # Deal with other parameters
                   9151:     while (my ($key,$value) = each(%Values)) {
                   9152:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  9153:     }
                   9154:     #
1.646     raeburn  9155:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  9156:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9157: }
                   9158: 
                   9159: ############################################################
                   9160: ############################################################
                   9161: 
                   9162: =pod
                   9163: 
1.648     raeburn  9164: =item * &DrawXYYGraph()
1.138     matthew  9165: 
                   9166: Facilitates the plotting of data in an XY graph with two Y axes.
                   9167: Puts plot definition data into the users environment in order for 
                   9168: graph.png to plot it.  Returns an <img> tag for the plot.
                   9169: 
                   9170: Inputs:
                   9171: 
                   9172: =over 4
                   9173: 
                   9174: =item $Title: string, the title of the plot
                   9175: 
                   9176: =item $xlabel: string, text describing the X-axis of the plot
                   9177: 
                   9178: =item $ylabel: string, text describing the Y-axis of the plot
                   9179: 
                   9180: =item $colors: Array ref containing the hex color codes for the data to be 
                   9181: plotted in.  If undefined, default values will be used.
                   9182: 
                   9183: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9184: 
                   9185: =item $Ydata1: The first data set
                   9186: 
                   9187: =item $Min1: The minimum value of the left Y-axis
                   9188: 
                   9189: =item $Max1: The maximum value of the left Y-axis
                   9190: 
                   9191: =item $Ydata2: The second data set
                   9192: 
                   9193: =item $Min2: The minimum value of the right Y-axis
                   9194: 
                   9195: =item $Max2: The maximum value of the left Y-axis
                   9196: 
                   9197: =item %Values: hash indicating or overriding any default values which are 
                   9198: passed to graph.png.  
                   9199: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9200: 
                   9201: =back
                   9202: 
                   9203: Returns:
                   9204: 
                   9205: An <img> tag which references graph.png and the appropriate identifying
                   9206: information for the plot.
1.136     matthew  9207: 
                   9208: =cut
                   9209: 
                   9210: ############################################################
                   9211: ############################################################
1.137     matthew  9212: sub DrawXYYGraph {
                   9213:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9214:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9215:     #
                   9216:     # Create the identifier for the graph
                   9217:     my $identifier = &get_cgi_id();
                   9218:     my $id = 'cgi.'.$identifier;
                   9219:     #
                   9220:     $Title  = '' if (! defined($Title));
                   9221:     $xlabel = '' if (! defined($xlabel));
                   9222:     $ylabel = '' if (! defined($ylabel));
                   9223:     my %ValuesHash = 
                   9224:         (
1.369     www      9225:          $id.'.title'  => &escape($Title),
                   9226:          $id.'.xlabel' => &escape($xlabel),
                   9227:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9228:          $id.'.labels' => join(',',@$Xlabels),
                   9229:          $id.'.PlotType' => 'XY',
                   9230:          $id.'.NumSets' => 2,
1.137     matthew  9231:          $id.'.two_axes' => 1,
                   9232:          $id.'.y1_max_value' => $Max1,
                   9233:          $id.'.y1_min_value' => $Min1,
                   9234:          $id.'.y2_max_value' => $Max2,
                   9235:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9236:          );
                   9237:     #
1.137     matthew  9238:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9239:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9240:     }
                   9241:     #
                   9242:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9243:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9244:         return '';
                   9245:     }
                   9246:     my $NumSets=1;
1.137     matthew  9247:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9248:         next if (! ref($array));
                   9249:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9250:     }
                   9251:     #
                   9252:     # Deal with other parameters
                   9253:     while (my ($key,$value) = each(%Values)) {
                   9254:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9255:     }
                   9256:     #
1.646     raeburn  9257:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9258:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9259: }
                   9260: 
                   9261: ############################################################
                   9262: ############################################################
                   9263: 
                   9264: =pod
                   9265: 
1.157     matthew  9266: =back 
                   9267: 
1.139     matthew  9268: =head1 Statistics helper routines?  
                   9269: 
                   9270: Bad place for them but what the hell.
                   9271: 
1.157     matthew  9272: =over 4
                   9273: 
1.648     raeburn  9274: =item * &chartlink()
1.139     matthew  9275: 
                   9276: Returns a link to the chart for a specific student.  
                   9277: 
                   9278: Inputs:
                   9279: 
                   9280: =over 4
                   9281: 
                   9282: =item $linktext: The text of the link
                   9283: 
                   9284: =item $sname: The students username
                   9285: 
                   9286: =item $sdomain: The students domain
                   9287: 
                   9288: =back
                   9289: 
1.157     matthew  9290: =back
                   9291: 
1.139     matthew  9292: =cut
                   9293: 
                   9294: ############################################################
                   9295: ############################################################
                   9296: sub chartlink {
                   9297:     my ($linktext, $sname, $sdomain) = @_;
                   9298:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9299:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9300:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9301:        '">'.$linktext.'</a>';
1.153     matthew  9302: }
                   9303: 
                   9304: #######################################################
                   9305: #######################################################
                   9306: 
                   9307: =pod
                   9308: 
                   9309: =head1 Course Environment Routines
1.157     matthew  9310: 
                   9311: =over 4
1.153     matthew  9312: 
1.648     raeburn  9313: =item * &restore_course_settings()
1.153     matthew  9314: 
1.648     raeburn  9315: =item * &store_course_settings()
1.153     matthew  9316: 
                   9317: Restores/Store indicated form parameters from the course environment.
                   9318: Will not overwrite existing values of the form parameters.
                   9319: 
                   9320: Inputs: 
                   9321: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9322: 
                   9323: a hash ref describing the data to be stored.  For example:
                   9324:    
                   9325: %Save_Parameters = ('Status' => 'scalar',
                   9326:     'chartoutputmode' => 'scalar',
                   9327:     'chartoutputdata' => 'scalar',
                   9328:     'Section' => 'array',
1.373     raeburn  9329:     'Group' => 'array',
1.153     matthew  9330:     'StudentData' => 'array',
                   9331:     'Maps' => 'array');
                   9332: 
                   9333: Returns: both routines return nothing
                   9334: 
1.631     raeburn  9335: =back
                   9336: 
1.153     matthew  9337: =cut
                   9338: 
                   9339: #######################################################
                   9340: #######################################################
                   9341: sub store_course_settings {
1.496     albertel 9342:     return &store_settings($env{'request.course.id'},@_);
                   9343: }
                   9344: 
                   9345: sub store_settings {
1.153     matthew  9346:     # save to the environment
                   9347:     # appenv the same items, just to be safe
1.300     albertel 9348:     my $udom  = $env{'user.domain'};
                   9349:     my $uname = $env{'user.name'};
1.496     albertel 9350:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9351:     my %SaveHash;
                   9352:     my %AppHash;
                   9353:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9354:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9355:         my $envname = 'environment.'.$basename;
1.258     albertel 9356:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9357:             # Save this value away
                   9358:             if ($type eq 'scalar' &&
1.258     albertel 9359:                 (! exists($env{$envname}) || 
                   9360:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9361:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9362:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9363:             } elsif ($type eq 'array') {
                   9364:                 my $stored_form;
1.258     albertel 9365:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9366:                     $stored_form = join(',',
                   9367:                                         map {
1.369     www      9368:                                             &escape($_);
1.258     albertel 9369:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9370:                 } else {
                   9371:                     $stored_form = 
1.369     www      9372:                         &escape($env{'form.'.$setting});
1.153     matthew  9373:                 }
                   9374:                 # Determine if the array contents are the same.
1.258     albertel 9375:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9376:                     $SaveHash{$basename} = $stored_form;
                   9377:                     $AppHash{$envname}   = $stored_form;
                   9378:                 }
                   9379:             }
                   9380:         }
                   9381:     }
                   9382:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9383:                                           $udom,$uname);
1.153     matthew  9384:     if ($put_result !~ /^(ok|delayed)/) {
                   9385:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9386:                                  'got error:'.$put_result);
                   9387:     }
                   9388:     # Make sure these settings stick around in this session, too
1.646     raeburn  9389:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9390:     return;
                   9391: }
                   9392: 
                   9393: sub restore_course_settings {
1.499     albertel 9394:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9395: }
                   9396: 
                   9397: sub restore_settings {
                   9398:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9399:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9400:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9401:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9402:             '.'.$setting;
1.258     albertel 9403:         if (exists($env{$envname})) {
1.153     matthew  9404:             if ($type eq 'scalar') {
1.258     albertel 9405:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9406:             } elsif ($type eq 'array') {
1.258     albertel 9407:                 $env{'form.'.$setting} = [ 
1.153     matthew  9408:                                            map { 
1.369     www      9409:                                                &unescape($_); 
1.258     albertel 9410:                                            } split(',',$env{$envname})
1.153     matthew  9411:                                            ];
                   9412:             }
                   9413:         }
                   9414:     }
1.127     matthew  9415: }
                   9416: 
1.618     raeburn  9417: #######################################################
                   9418: #######################################################
                   9419: 
                   9420: =pod
                   9421: 
                   9422: =head1 Domain E-mail Routines  
                   9423: 
                   9424: =over 4
                   9425: 
1.648     raeburn  9426: =item * &build_recipient_list()
1.618     raeburn  9427: 
1.884     raeburn  9428: Build recipient lists for five types of e-mail:
1.766     raeburn  9429: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  9430: (d) Help requests, (e) Course requests needing approval,  generated by
                   9431: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   9432: loncoursequeueadmin.pm respectively.
1.618     raeburn  9433: 
                   9434: Inputs:
1.619     raeburn  9435: defmail (scalar - email address of default recipient), 
1.618     raeburn  9436: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9437: defdom (domain for which to retrieve configuration settings),
                   9438: origmail (scalar - email address of recipient from loncapa.conf, 
                   9439: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9440: 
1.655     raeburn  9441: Returns: comma separated list of addresses to which to send e-mail.
                   9442: 
                   9443: =back
1.618     raeburn  9444: 
                   9445: =cut
                   9446: 
                   9447: ############################################################
                   9448: ############################################################
                   9449: sub build_recipient_list {
1.619     raeburn  9450:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9451:     my @recipients;
                   9452:     my $otheremails;
                   9453:     my %domconfig =
                   9454:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9455:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9456:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9457:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9458:                 my @contacts = ('adminemail','supportemail');
                   9459:                 foreach my $item (@contacts) {
                   9460:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9461:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9462:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9463:                             push(@recipients,$addr);
                   9464:                         }
1.619     raeburn  9465:                     }
1.766     raeburn  9466:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9467:                 }
                   9468:             }
1.766     raeburn  9469:         } elsif ($origmail ne '') {
                   9470:             push(@recipients,$origmail);
1.618     raeburn  9471:         }
1.619     raeburn  9472:     } elsif ($origmail ne '') {
                   9473:         push(@recipients,$origmail);
1.618     raeburn  9474:     }
1.688     raeburn  9475:     if (defined($defmail)) {
                   9476:         if ($defmail ne '') {
                   9477:             push(@recipients,$defmail);
                   9478:         }
1.618     raeburn  9479:     }
                   9480:     if ($otheremails) {
1.619     raeburn  9481:         my @others;
                   9482:         if ($otheremails =~ /,/) {
                   9483:             @others = split(/,/,$otheremails);
1.618     raeburn  9484:         } else {
1.619     raeburn  9485:             push(@others,$otheremails);
                   9486:         }
                   9487:         foreach my $addr (@others) {
                   9488:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9489:                 push(@recipients,$addr);
                   9490:             }
1.618     raeburn  9491:         }
                   9492:     }
1.619     raeburn  9493:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9494:     return $recipientlist;
                   9495: }
                   9496: 
1.127     matthew  9497: ############################################################
                   9498: ############################################################
1.154     albertel 9499: 
1.655     raeburn  9500: =pod
                   9501: 
                   9502: =head1 Course Catalog Routines
                   9503: 
                   9504: =over 4
                   9505: 
                   9506: =item * &gather_categories()
                   9507: 
                   9508: Converts category definitions - keys of categories hash stored in  
                   9509: coursecategories in configuration.db on the primary library server in a 
                   9510: domain - to an array.  Also generates javascript and idx hash used to 
                   9511: generate Domain Coordinator interface for editing Course Categories.
                   9512: 
                   9513: Inputs:
1.663     raeburn  9514: 
1.655     raeburn  9515: categories (reference to hash of category definitions).
1.663     raeburn  9516: 
1.655     raeburn  9517: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9518:       categories and subcategories).
1.663     raeburn  9519: 
1.655     raeburn  9520: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9521:       editing Course Categories).
1.663     raeburn  9522: 
1.655     raeburn  9523: jsarray (reference to array of categories used to create Javascript arrays for
                   9524:          Domain Coordinator interface for editing Course Categories).
                   9525: 
                   9526: Returns: nothing
                   9527: 
                   9528: Side effects: populates cats, idx and jsarray. 
                   9529: 
                   9530: =cut
                   9531: 
                   9532: sub gather_categories {
                   9533:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9534:     my %counters;
                   9535:     my $num = 0;
                   9536:     foreach my $item (keys(%{$categories})) {
                   9537:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9538:         if ($container eq '' && $depth == 0) {
                   9539:             $cats->[$depth][$categories->{$item}] = $cat;
                   9540:         } else {
                   9541:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9542:         }
                   9543:         my ($escitem,$tail) = split(/:/,$item,2);
                   9544:         if ($counters{$tail} eq '') {
                   9545:             $counters{$tail} = $num;
                   9546:             $num ++;
                   9547:         }
                   9548:         if (ref($idx) eq 'HASH') {
                   9549:             $idx->{$item} = $counters{$tail};
                   9550:         }
                   9551:         if (ref($jsarray) eq 'ARRAY') {
                   9552:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9553:         }
                   9554:     }
                   9555:     return;
                   9556: }
                   9557: 
                   9558: =pod
                   9559: 
                   9560: =item * &extract_categories()
                   9561: 
                   9562: Used to generate breadcrumb trails for course categories.
                   9563: 
                   9564: Inputs:
1.663     raeburn  9565: 
1.655     raeburn  9566: categories (reference to hash of category definitions).
1.663     raeburn  9567: 
1.655     raeburn  9568: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9569:       categories and subcategories).
1.663     raeburn  9570: 
1.655     raeburn  9571: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9572: 
1.655     raeburn  9573: allitems (reference to hash - key is category key 
                   9574:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9575: 
1.655     raeburn  9576: idx (reference to hash of counters used in Domain Coordinator interface for
                   9577:       editing Course Categories).
1.663     raeburn  9578: 
1.655     raeburn  9579: jsarray (reference to array of categories used to create Javascript arrays for
                   9580:          Domain Coordinator interface for editing Course Categories).
                   9581: 
1.665     raeburn  9582: subcats (reference to hash of arrays containing all subcategories within each 
                   9583:          category, -recursive)
                   9584: 
1.655     raeburn  9585: Returns: nothing
                   9586: 
                   9587: Side effects: populates trails and allitems hash references.
                   9588: 
                   9589: =cut
                   9590: 
                   9591: sub extract_categories {
1.665     raeburn  9592:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9593:     if (ref($categories) eq 'HASH') {
                   9594:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9595:         if (ref($cats->[0]) eq 'ARRAY') {
                   9596:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9597:                 my $name = $cats->[0][$i];
                   9598:                 my $item = &escape($name).'::0';
                   9599:                 my $trailstr;
                   9600:                 if ($name eq 'instcode') {
                   9601:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  9602:                 } elsif ($name eq 'communities') {
                   9603:                     $trailstr = &mt('Communities');
1.655     raeburn  9604:                 } else {
                   9605:                     $trailstr = $name;
                   9606:                 }
                   9607:                 if ($allitems->{$item} eq '') {
                   9608:                     push(@{$trails},$trailstr);
                   9609:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9610:                 }
                   9611:                 my @parents = ($name);
                   9612:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9613:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9614:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9615:                         if (ref($subcats) eq 'HASH') {
                   9616:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9617:                         }
                   9618:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9619:                     }
                   9620:                 } else {
                   9621:                     if (ref($subcats) eq 'HASH') {
                   9622:                         $subcats->{$item} = [];
1.655     raeburn  9623:                     }
                   9624:                 }
                   9625:             }
                   9626:         }
                   9627:     }
                   9628:     return;
                   9629: }
                   9630: 
                   9631: =pod
                   9632: 
                   9633: =item *&recurse_categories()
                   9634: 
                   9635: Recursively used to generate breadcrumb trails for course categories.
                   9636: 
                   9637: Inputs:
1.663     raeburn  9638: 
1.655     raeburn  9639: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9640:       categories and subcategories).
1.663     raeburn  9641: 
1.655     raeburn  9642: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9643: 
                   9644: category (current course category, for which breadcrumb trail is being generated).
                   9645: 
                   9646: trails (reference to array of breadcrumb trails for each category).
                   9647: 
1.655     raeburn  9648: allitems (reference to hash - key is category key
                   9649:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9650: 
1.655     raeburn  9651: parents (array containing containers directories for current category, 
                   9652:          back to top level). 
                   9653: 
                   9654: Returns: nothing
                   9655: 
                   9656: Side effects: populates trails and allitems hash references
                   9657: 
                   9658: =cut
                   9659: 
                   9660: sub recurse_categories {
1.665     raeburn  9661:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9662:     my $shallower = $depth - 1;
                   9663:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9664:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9665:             my $name = $cats->[$depth]{$category}[$k];
                   9666:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9667:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9668:             if ($allitems->{$item} eq '') {
                   9669:                 push(@{$trails},$trailstr);
                   9670:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9671:             }
                   9672:             my $deeper = $depth+1;
                   9673:             push(@{$parents},$category);
1.665     raeburn  9674:             if (ref($subcats) eq 'HASH') {
                   9675:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9676:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9677:                     my $higher;
                   9678:                     if ($j > 0) {
                   9679:                         $higher = &escape($parents->[$j]).':'.
                   9680:                                   &escape($parents->[$j-1]).':'.$j;
                   9681:                     } else {
                   9682:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9683:                     }
                   9684:                     push(@{$subcats->{$higher}},$subcat);
                   9685:                 }
                   9686:             }
                   9687:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9688:                                 $subcats);
1.655     raeburn  9689:             pop(@{$parents});
                   9690:         }
                   9691:     } else {
                   9692:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9693:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9694:         if ($allitems->{$item} eq '') {
                   9695:             push(@{$trails},$trailstr);
                   9696:             $allitems->{$item} = scalar(@{$trails})-1;
                   9697:         }
                   9698:     }
                   9699:     return;
                   9700: }
                   9701: 
1.663     raeburn  9702: =pod
                   9703: 
                   9704: =item *&assign_categories_table()
                   9705: 
                   9706: Create a datatable for display of hierarchical categories in a domain,
                   9707: with checkboxes to allow a course to be categorized. 
                   9708: 
                   9709: Inputs:
                   9710: 
                   9711: cathash - reference to hash of categories defined for the domain (from
                   9712:           configuration.db)
                   9713: 
                   9714: currcat - scalar with an & separated list of categories assigned to a course. 
                   9715: 
1.919     raeburn  9716: type    - scalar contains course type (Course or Community).
                   9717: 
1.663     raeburn  9718: Returns: $output (markup to be displayed) 
                   9719: 
                   9720: =cut
                   9721: 
                   9722: sub assign_categories_table {
1.919     raeburn  9723:     my ($cathash,$currcat,$type) = @_;
1.663     raeburn  9724:     my $output;
                   9725:     if (ref($cathash) eq 'HASH') {
                   9726:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9727:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9728:         $maxdepth = scalar(@cats);
                   9729:         if (@cats > 0) {
                   9730:             my $itemcount = 0;
                   9731:             if (ref($cats[0]) eq 'ARRAY') {
                   9732:                 my @currcategories;
                   9733:                 if ($currcat ne '') {
                   9734:                     @currcategories = split('&',$currcat);
                   9735:                 }
1.919     raeburn  9736:                 my $table;
1.663     raeburn  9737:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9738:                     my $parent = $cats[0][$i];
1.919     raeburn  9739:                     next if ($parent eq 'instcode');
                   9740:                     if ($type eq 'Community') {
                   9741:                         next unless ($parent eq 'communities');
                   9742:                     } else {
                   9743:                         next if ($parent eq 'communities');
                   9744:                     }
1.663     raeburn  9745:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9746:                     my $item = &escape($parent).'::0';
                   9747:                     my $checked = '';
                   9748:                     if (@currcategories > 0) {
                   9749:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9750:                             $checked = ' checked="checked"';
1.663     raeburn  9751:                         }
                   9752:                     }
1.919     raeburn  9753:                     my $parent_title = $parent;
                   9754:                     if ($parent eq 'communities') {
                   9755:                         $parent_title = &mt('Communities');
                   9756:                     }
                   9757:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9758:                               '<input type="checkbox" name="usecategory" value="'.
                   9759:                               $item.'"'.$checked.' />'.$parent_title.'</span>'.
                   9760:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9761:                     my $depth = 1;
                   9762:                     push(@path,$parent);
1.919     raeburn  9763:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663     raeburn  9764:                     pop(@path);
1.919     raeburn  9765:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  9766:                     $itemcount ++;
                   9767:                 }
1.919     raeburn  9768:                 if ($itemcount) {
                   9769:                     $output = &Apache::loncommon::start_data_table().
                   9770:                               $table.
                   9771:                               &Apache::loncommon::end_data_table();
                   9772:                 }
1.663     raeburn  9773:             }
                   9774:         }
                   9775:     }
                   9776:     return $output;
                   9777: }
                   9778: 
                   9779: =pod
                   9780: 
                   9781: =item *&assign_category_rows()
                   9782: 
                   9783: Create a datatable row for display of nested categories in a domain,
                   9784: with checkboxes to allow a course to be categorized,called recursively.
                   9785: 
                   9786: Inputs:
                   9787: 
                   9788: itemcount - track row number for alternating colors
                   9789: 
                   9790: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   9791:       categories and subcategories.
                   9792: 
                   9793: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   9794: 
                   9795: parent - parent of current category item
                   9796: 
                   9797: path - Array containing all categories back up through the hierarchy from the
                   9798:        current category to the top level.
                   9799: 
                   9800: currcategories - reference to array of current categories assigned to the course
                   9801: 
                   9802: Returns: $output (markup to be displayed).
                   9803: 
                   9804: =cut
                   9805: 
                   9806: sub assign_category_rows {
                   9807:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   9808:     my ($text,$name,$item,$chgstr);
                   9809:     if (ref($cats) eq 'ARRAY') {
                   9810:         my $maxdepth = scalar(@{$cats});
                   9811:         if (ref($cats->[$depth]) eq 'HASH') {
                   9812:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   9813:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   9814:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9815:                 $text .= '<td><table class="LC_datatable">';
                   9816:                 for (my $j=0; $j<$numchildren; $j++) {
                   9817:                     $name = $cats->[$depth]{$parent}[$j];
                   9818:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   9819:                     my $deeper = $depth+1;
                   9820:                     my $checked = '';
                   9821:                     if (ref($currcategories) eq 'ARRAY') {
                   9822:                         if (@{$currcategories} > 0) {
                   9823:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   9824:                                 $checked = ' checked="checked"';
1.663     raeburn  9825:                             }
                   9826:                         }
                   9827:                     }
1.664     raeburn  9828:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   9829:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  9830:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   9831:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   9832:                              '</td><td>';
1.663     raeburn  9833:                     if (ref($path) eq 'ARRAY') {
                   9834:                         push(@{$path},$name);
                   9835:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   9836:                         pop(@{$path});
                   9837:                     }
                   9838:                     $text .= '</td></tr>';
                   9839:                 }
                   9840:                 $text .= '</table></td>';
                   9841:             }
                   9842:         }
                   9843:     }
                   9844:     return $text;
                   9845: }
                   9846: 
1.655     raeburn  9847: ############################################################
                   9848: ############################################################
                   9849: 
                   9850: 
1.443     albertel 9851: sub commit_customrole {
1.664     raeburn  9852:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  9853:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 9854:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   9855:                          ($end?', ending '.localtime($end):'').': <b>'.
                   9856:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  9857:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 9858:                  '</b><br />';
                   9859:     return $output;
                   9860: }
                   9861: 
                   9862: sub commit_standardrole {
1.541     raeburn  9863:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   9864:     my ($output,$logmsg,$linefeed);
                   9865:     if ($context eq 'auto') {
                   9866:         $linefeed = "\n";
                   9867:     } else {
                   9868:         $linefeed = "<br />\n";
                   9869:     }  
1.443     albertel 9870:     if ($three eq 'st') {
1.541     raeburn  9871:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   9872:                                          $one,$two,$sec,$context);
                   9873:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  9874:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   9875:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 9876:         } else {
1.541     raeburn  9877:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 9878:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9879:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   9880:             if ($context eq 'auto') {
                   9881:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   9882:             } else {
                   9883:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   9884:                &mt('Add to classlist').': <b>ok</b>';
                   9885:             }
                   9886:             $output .= $linefeed;
1.443     albertel 9887:         }
                   9888:     } else {
                   9889:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   9890:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9891:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  9892:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  9893:         if ($context eq 'auto') {
                   9894:             $output .= $result.$linefeed;
                   9895:         } else {
                   9896:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   9897:         }
1.443     albertel 9898:     }
                   9899:     return $output;
                   9900: }
                   9901: 
                   9902: sub commit_studentrole {
1.541     raeburn  9903:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  9904:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  9905:     if ($context eq 'auto') {
                   9906:         $linefeed = "\n";
                   9907:     } else {
                   9908:         $linefeed = '<br />'."\n";
                   9909:     }
1.443     albertel 9910:     if (defined($one) && defined($two)) {
                   9911:         my $cid=$one.'_'.$two;
                   9912:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   9913:         my $secchange = 0;
                   9914:         my $expire_role_result;
                   9915:         my $modify_section_result;
1.628     raeburn  9916:         if ($oldsec ne '-1') { 
                   9917:             if ($oldsec ne $sec) {
1.443     albertel 9918:                 $secchange = 1;
1.628     raeburn  9919:                 my $now = time;
1.443     albertel 9920:                 my $uurl='/'.$cid;
                   9921:                 $uurl=~s/\_/\//g;
                   9922:                 if ($oldsec) {
                   9923:                     $uurl.='/'.$oldsec;
                   9924:                 }
1.626     raeburn  9925:                 $oldsecurl = $uurl;
1.628     raeburn  9926:                 $expire_role_result = 
1.652     raeburn  9927:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  9928:                 if ($env{'request.course.sec'} ne '') { 
                   9929:                     if ($expire_role_result eq 'refused') {
                   9930:                         my @roles = ('st');
                   9931:                         my @statuses = ('previous');
                   9932:                         my @roledoms = ($one);
                   9933:                         my $withsec = 1;
                   9934:                         my %roleshash = 
                   9935:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   9936:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   9937:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   9938:                             my ($oldstart,$oldend) = 
                   9939:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   9940:                             if ($oldend > 0 && $oldend <= $now) {
                   9941:                                 $expire_role_result = 'ok';
                   9942:                             }
                   9943:                         }
                   9944:                     }
                   9945:                 }
1.443     albertel 9946:                 $result = $expire_role_result;
                   9947:             }
                   9948:         }
                   9949:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  9950:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 9951:             if ($modify_section_result =~ /^ok/) {
                   9952:                 if ($secchange == 1) {
1.628     raeburn  9953:                     if ($sec eq '') {
                   9954:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   9955:                     } else {
                   9956:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   9957:                     }
1.443     albertel 9958:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  9959:                     if ($sec eq '') {
                   9960:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   9961:                     } else {
                   9962:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9963:                     }
1.443     albertel 9964:                 } else {
1.628     raeburn  9965:                     if ($sec eq '') {
                   9966:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   9967:                     } else {
                   9968:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9969:                     }
1.443     albertel 9970:                 }
                   9971:             } else {
1.628     raeburn  9972:                 if ($secchange) {       
                   9973:                     $$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;
                   9974:                 } else {
                   9975:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   9976:                 }
1.443     albertel 9977:             }
                   9978:             $result = $modify_section_result;
                   9979:         } elsif ($secchange == 1) {
1.628     raeburn  9980:             if ($oldsec eq '') {
                   9981:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   9982:             } else {
                   9983:                 $$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;
                   9984:             }
1.626     raeburn  9985:             if ($expire_role_result eq 'refused') {
                   9986:                 my $newsecurl = '/'.$cid;
                   9987:                 $newsecurl =~ s/\_/\//g;
                   9988:                 if ($sec ne '') {
                   9989:                     $newsecurl.='/'.$sec;
                   9990:                 }
                   9991:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   9992:                     if ($sec eq '') {
                   9993:                         $$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;
                   9994:                     } else {
                   9995:                         $$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;
                   9996:                     }
                   9997:                 }
                   9998:             }
1.443     albertel 9999:         }
                   10000:     } else {
1.626     raeburn  10001:         $$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 10002:         $result = "error: incomplete course id\n";
                   10003:     }
                   10004:     return $result;
                   10005: }
                   10006: 
                   10007: ############################################################
                   10008: ############################################################
                   10009: 
1.566     albertel 10010: sub check_clone {
1.578     raeburn  10011:     my ($args,$linefeed) = @_;
1.566     albertel 10012:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   10013:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   10014:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   10015:     my $clonemsg;
                   10016:     my $can_clone = 0;
1.944     raeburn  10017:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  10018:     if ($lctype ne 'community') {
                   10019:         $lctype = 'course';
                   10020:     }
1.566     albertel 10021:     if ($clonehome eq 'no_host') {
1.944     raeburn  10022:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10023:             $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
                   10024:         } else {
                   10025:             $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'});
                   10026:         }     
1.566     albertel 10027:     } else {
                   10028: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  10029:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10030:             if ($clonedesc{'type'} ne 'Community') {
                   10031:                  $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
                   10032:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10033:             }
                   10034:         }
1.882     raeburn  10035: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   10036:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 10037: 	    $can_clone = 1;
                   10038: 	} else {
                   10039: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   10040: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   10041: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  10042:             if (grep(/^\*$/,@cloners)) {
                   10043:                 $can_clone = 1;
                   10044:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   10045:                 $can_clone = 1;
                   10046:             } else {
1.908     raeburn  10047:                 my $ccrole = 'cc';
1.944     raeburn  10048:                 if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10049:                     $ccrole = 'co';
                   10050:                 }
1.578     raeburn  10051: 	        my %roleshash =
                   10052: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   10053: 					 $args->{'ccdomain'},
1.908     raeburn  10054:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  10055: 					 [$args->{'clonedomain'}]);
1.908     raeburn  10056: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942     raeburn  10057:                     $can_clone = 1;
                   10058:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
                   10059:                     $can_clone = 1;
                   10060:                 } else {
1.944     raeburn  10061:                     if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10062:                         $clonemsg = &mt('No new community created.').$linefeed.&mt('The new community could not be cloned from the existing community because the new community owner ([_1]) does not have cloning rights in the existing community ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
                   10063:                     } else {
                   10064:                         $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'});
                   10065:                     }
1.578     raeburn  10066: 	        }
1.566     albertel 10067: 	    }
1.578     raeburn  10068:         }
1.566     albertel 10069:     }
                   10070:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10071: }
                   10072: 
1.444     albertel 10073: sub construct_course {
1.885     raeburn  10074:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 10075:     my $outcome;
1.541     raeburn  10076:     my $linefeed =  '<br />'."\n";
                   10077:     if ($context eq 'auto') {
                   10078:         $linefeed = "\n";
                   10079:     }
1.566     albertel 10080: 
                   10081: #
                   10082: # Are we cloning?
                   10083: #
                   10084:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10085:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  10086: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 10087: 	if ($context ne 'auto') {
1.578     raeburn  10088:             if ($clonemsg ne '') {
                   10089: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   10090:             }
1.566     albertel 10091: 	}
                   10092: 	$outcome .= $clonemsg.$linefeed;
                   10093: 
                   10094:         if (!$can_clone) {
                   10095: 	    return (0,$outcome);
                   10096: 	}
                   10097:     }
                   10098: 
1.444     albertel 10099: #
                   10100: # Open course
                   10101: #
                   10102:     my $crstype = lc($args->{'crstype'});
                   10103:     my %cenv=();
                   10104:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   10105:                                              $args->{'cdescr'},
                   10106:                                              $args->{'curl'},
                   10107:                                              $args->{'course_home'},
                   10108:                                              $args->{'nonstandard'},
                   10109:                                              $args->{'crscode'},
                   10110:                                              $args->{'ccuname'}.':'.
                   10111:                                              $args->{'ccdomain'},
1.882     raeburn  10112:                                              $args->{'crstype'},
1.885     raeburn  10113:                                              $cnum,$context,$category);
1.444     albertel 10114: 
                   10115:     # Note: The testing routines depend on this being output; see 
                   10116:     # Utils::Course. This needs to at least be output as a comment
                   10117:     # if anyone ever decides to not show this, and Utils::Course::new
                   10118:     # will need to be suitably modified.
1.541     raeburn  10119:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  10120:     if ($$courseid =~ /^error:/) {
                   10121:         return (0,$outcome);
                   10122:     }
                   10123: 
1.444     albertel 10124: #
                   10125: # Check if created correctly
                   10126: #
1.479     albertel 10127:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 10128:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  10129:     if ($crsuhome eq 'no_host') {
                   10130:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   10131:         return (0,$outcome);
                   10132:     }
1.541     raeburn  10133:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 10134: 
1.444     albertel 10135: #
1.566     albertel 10136: # Do the cloning
                   10137: #   
                   10138:     if ($can_clone && $cloneid) {
                   10139: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   10140: 	if ($context ne 'auto') {
                   10141: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   10142: 	}
                   10143: 	$outcome .= $clonemsg.$linefeed;
                   10144: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 10145: # Copy all files
1.637     www      10146: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 10147: # Restore URL
1.566     albertel 10148: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 10149: # Restore title
1.566     albertel 10150: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  10151: # Restore creation date, creator and creation context.
                   10152:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   10153:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   10154:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 10155: # Mark as cloned
1.566     albertel 10156: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      10157: # Need to clone grading mode
                   10158:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   10159:         $cenv{'grading'}=$newenv{'grading'};
                   10160: # Do not clone these environment entries
                   10161:         &Apache::lonnet::del('environment',
                   10162:                   ['default_enrollment_start_date',
                   10163:                    'default_enrollment_end_date',
                   10164:                    'question.email',
                   10165:                    'policy.email',
                   10166:                    'comment.email',
                   10167:                    'pch.users.denied',
1.725     raeburn  10168:                    'plc.users.denied',
                   10169:                    'hidefromcat',
                   10170:                    'categories'],
1.638     www      10171:                    $$crsudom,$$crsunum);
1.444     albertel 10172:     }
1.566     albertel 10173: 
1.444     albertel 10174: #
                   10175: # Set environment (will override cloned, if existing)
                   10176: #
                   10177:     my @sections = ();
                   10178:     my @xlists = ();
                   10179:     if ($args->{'crstype'}) {
                   10180:         $cenv{'type'}=$args->{'crstype'};
                   10181:     }
                   10182:     if ($args->{'crsid'}) {
                   10183:         $cenv{'courseid'}=$args->{'crsid'};
                   10184:     }
                   10185:     if ($args->{'crscode'}) {
                   10186:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   10187:     }
                   10188:     if ($args->{'crsquota'} ne '') {
                   10189:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   10190:     } else {
                   10191:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   10192:     }
                   10193:     if ($args->{'ccuname'}) {
                   10194:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   10195:                                         ':'.$args->{'ccdomain'};
                   10196:     } else {
                   10197:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   10198:     }
                   10199:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   10200:     if ($args->{'crssections'}) {
                   10201:         $cenv{'internal.sectionnums'} = '';
                   10202:         if ($args->{'crssections'} =~ m/,/) {
                   10203:             @sections = split/,/,$args->{'crssections'};
                   10204:         } else {
                   10205:             $sections[0] = $args->{'crssections'};
                   10206:         }
                   10207:         if (@sections > 0) {
                   10208:             foreach my $item (@sections) {
                   10209:                 my ($sec,$gp) = split/:/,$item;
                   10210:                 my $class = $args->{'crscode'}.$sec;
                   10211:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   10212:                 $cenv{'internal.sectionnums'} .= $item.',';
                   10213:                 unless ($addcheck eq 'ok') {
                   10214:                     push @badclasses, $class;
                   10215:                 }
                   10216:             }
                   10217:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   10218:         }
                   10219:     }
                   10220: # do not hide course coordinator from staff listing, 
                   10221: # even if privileged
                   10222:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10223: # add crosslistings
                   10224:     if ($args->{'crsxlist'}) {
                   10225:         $cenv{'internal.crosslistings'}='';
                   10226:         if ($args->{'crsxlist'} =~ m/,/) {
                   10227:             @xlists = split/,/,$args->{'crsxlist'};
                   10228:         } else {
                   10229:             $xlists[0] = $args->{'crsxlist'};
                   10230:         }
                   10231:         if (@xlists > 0) {
                   10232:             foreach my $item (@xlists) {
                   10233:                 my ($xl,$gp) = split/:/,$item;
                   10234:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   10235:                 $cenv{'internal.crosslistings'} .= $item.',';
                   10236:                 unless ($addcheck eq 'ok') {
                   10237:                     push @badclasses, $xl;
                   10238:                 }
                   10239:             }
                   10240:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   10241:         }
                   10242:     }
                   10243:     if ($args->{'autoadds'}) {
                   10244:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   10245:     }
                   10246:     if ($args->{'autodrops'}) {
                   10247:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10248:     }
                   10249: # check for notification of enrollment changes
                   10250:     my @notified = ();
                   10251:     if ($args->{'notify_owner'}) {
                   10252:         if ($args->{'ccuname'} ne '') {
                   10253:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10254:         }
                   10255:     }
                   10256:     if ($args->{'notify_dc'}) {
                   10257:         if ($uname ne '') { 
1.630     raeburn  10258:             push(@notified,$uname.':'.$udom);
1.444     albertel 10259:         }
                   10260:     }
                   10261:     if (@notified > 0) {
                   10262:         my $notifylist;
                   10263:         if (@notified > 1) {
                   10264:             $notifylist = join(',',@notified);
                   10265:         } else {
                   10266:             $notifylist = $notified[0];
                   10267:         }
                   10268:         $cenv{'internal.notifylist'} = $notifylist;
                   10269:     }
                   10270:     if (@badclasses > 0) {
                   10271:         my %lt=&Apache::lonlocal::texthash(
                   10272:                 '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',
                   10273:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10274:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10275:         );
1.541     raeburn  10276:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10277:                            ' ('.$lt{'adby'}.')';
                   10278:         if ($context eq 'auto') {
                   10279:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10280:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10281:             foreach my $item (@badclasses) {
                   10282:                 if ($context eq 'auto') {
                   10283:                     $outcome .= " - $item\n";
                   10284:                 } else {
                   10285:                     $outcome .= "<li>$item</li>\n";
                   10286:                 }
                   10287:             }
                   10288:             if ($context eq 'auto') {
                   10289:                 $outcome .= $linefeed;
                   10290:             } else {
1.566     albertel 10291:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10292:             }
                   10293:         } 
1.444     albertel 10294:     }
                   10295:     if ($args->{'no_end_date'}) {
                   10296:         $args->{'endaccess'} = 0;
                   10297:     }
                   10298:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10299:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10300:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10301:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10302:     if ($args->{'showphotos'}) {
                   10303:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10304:     }
                   10305:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10306:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10307:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10308:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10309:             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'); 
                   10310:             if ($context eq 'auto') {
                   10311:                 $outcome .= $krb_msg;
                   10312:             } else {
1.566     albertel 10313:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10314:             }
                   10315:             $outcome .= $linefeed;
1.444     albertel 10316:         }
                   10317:     }
                   10318:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10319:        if ($args->{'setpolicy'}) {
                   10320:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10321:        }
                   10322:        if ($args->{'setcontent'}) {
                   10323:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10324:        }
                   10325:     }
                   10326:     if ($args->{'reshome'}) {
                   10327: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10328: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10329:     }
                   10330: #
                   10331: # course has keyed access
                   10332: #
                   10333:     if ($args->{'setkeys'}) {
                   10334:        $cenv{'keyaccess'}='yes';
                   10335:     }
                   10336: # if specified, key authority is not course, but user
                   10337: # only active if keyaccess is yes
                   10338:     if ($args->{'keyauth'}) {
1.487     albertel 10339: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10340: 	$user = &LONCAPA::clean_username($user);
                   10341: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10342: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10343: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10344: 	}
                   10345:     }
                   10346: 
                   10347:     if ($args->{'disresdis'}) {
                   10348:         $cenv{'pch.roles.denied'}='st';
                   10349:     }
                   10350:     if ($args->{'disablechat'}) {
                   10351:         $cenv{'plc.roles.denied'}='st';
                   10352:     }
                   10353: 
                   10354:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10355:     # course
                   10356:     $cenv{'course.helper.not.run'} = 1;
                   10357:     #
                   10358:     # Use new Randomseed
                   10359:     #
                   10360:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10361:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10362:     #
                   10363:     # The encryption code and receipt prefix for this course
                   10364:     #
                   10365:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10366:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10367:     #
                   10368:     # By default, use standard grading
                   10369:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10370: 
1.541     raeburn  10371:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10372:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10373: #
                   10374: # Open all assignments
                   10375: #
                   10376:     if ($args->{'openall'}) {
                   10377:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10378:        my %storecontent = ($storeunder         => time,
                   10379:                            $storeunder.'.type' => 'date_start');
                   10380:        
                   10381:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10382:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10383:    }
                   10384: #
                   10385: # Set first page
                   10386: #
                   10387:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10388: 	    || ($cloneid)) {
1.445     albertel 10389: 	use LONCAPA::map;
1.444     albertel 10390: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10391: 
                   10392: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10393:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10394: 
1.444     albertel 10395:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10396:         my $title; my $url;
                   10397:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10398: 	    $title=&mt('Syllabus');
1.444     albertel 10399:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10400:         } else {
1.963     raeburn  10401:             $title=&mt('Table of Contents');
1.444     albertel 10402:             $url='/adm/navmaps';
                   10403:         }
1.445     albertel 10404: 
                   10405:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10406: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10407: 
                   10408: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10409:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10410:     }
1.566     albertel 10411: 
                   10412:     return (1,$outcome);
1.444     albertel 10413: }
                   10414: 
                   10415: ############################################################
                   10416: ############################################################
                   10417: 
1.953     droeschl 10418: #SD
                   10419: # only Community and Course, or anything else?
1.378     raeburn  10420: sub course_type {
                   10421:     my ($cid) = @_;
                   10422:     if (!defined($cid)) {
                   10423:         $cid = $env{'request.course.id'};
                   10424:     }
1.404     albertel 10425:     if (defined($env{'course.'.$cid.'.type'})) {
                   10426:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10427:     } else {
                   10428:         return 'Course';
1.377     raeburn  10429:     }
                   10430: }
1.156     albertel 10431: 
1.406     raeburn  10432: sub group_term {
                   10433:     my $crstype = &course_type();
                   10434:     my %names = (
                   10435:                   'Course' => 'group',
1.865     raeburn  10436:                   'Community' => 'group',
1.406     raeburn  10437:                 );
                   10438:     return $names{$crstype};
                   10439: }
                   10440: 
1.902     raeburn  10441: sub course_types {
                   10442:     my @types = ('official','unofficial','community');
                   10443:     my %typename = (
                   10444:                          official   => 'Official course',
                   10445:                          unofficial => 'Unofficial course',
                   10446:                          community  => 'Community',
                   10447:                    );
                   10448:     return (\@types,\%typename);
                   10449: }
                   10450: 
1.156     albertel 10451: sub icon {
                   10452:     my ($file)=@_;
1.505     albertel 10453:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10454:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10455:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10456:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10457: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10458: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10459: 	            $curfext.".gif") {
                   10460: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10461: 		$curfext.".gif";
                   10462: 	}
                   10463:     }
1.249     albertel 10464:     return &lonhttpdurl($iconname);
1.154     albertel 10465: } 
1.84      albertel 10466: 
1.575     albertel 10467: sub lonhttpdurl {
1.692     www      10468: #
                   10469: # Had been used for "small fry" static images on separate port 8080.
                   10470: # Modify here if lightweight http functionality desired again.
                   10471: # Currently eliminated due to increasing firewall issues.
                   10472: #
1.575     albertel 10473:     my ($url)=@_;
1.692     www      10474:     return $url;
1.215     albertel 10475: }
                   10476: 
1.213     albertel 10477: sub connection_aborted {
                   10478:     my ($r)=@_;
                   10479:     $r->print(" ");$r->rflush();
                   10480:     my $c = $r->connection;
                   10481:     return $c->aborted();
                   10482: }
                   10483: 
1.221     foxr     10484: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10485: #    strings as 'strings'.
                   10486: sub escape_single {
1.221     foxr     10487:     my ($input) = @_;
1.223     albertel 10488:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10489:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10490:     return $input;
                   10491: }
1.223     albertel 10492: 
1.222     foxr     10493: #  Same as escape_single, but escape's "'s  This 
                   10494: #  can be used for  "strings"
                   10495: sub escape_double {
                   10496:     my ($input) = @_;
                   10497:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10498:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10499:     return $input;
                   10500: }
1.223     albertel 10501:  
1.222     foxr     10502: #   Escapes the last element of a full URL.
                   10503: sub escape_url {
                   10504:     my ($url)   = @_;
1.238     raeburn  10505:     my @urlslices = split(/\//, $url,-1);
1.369     www      10506:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10507:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10508: }
1.462     albertel 10509: 
1.820     raeburn  10510: sub compare_arrays {
                   10511:     my ($arrayref1,$arrayref2) = @_;
                   10512:     my (@difference,%count);
                   10513:     @difference = ();
                   10514:     %count = ();
                   10515:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10516:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10517:         foreach my $element (keys(%count)) {
                   10518:             if ($count{$element} == 1) {
                   10519:                 push(@difference,$element);
                   10520:             }
                   10521:         }
                   10522:     }
                   10523:     return @difference;
                   10524: }
                   10525: 
1.817     bisitz   10526: # -------------------------------------------------------- Initialize user login
1.462     albertel 10527: sub init_user_environment {
1.463     albertel 10528:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10529:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10530: 
                   10531:     my $public=($username eq 'public' && $domain eq 'public');
                   10532: 
                   10533: # See if old ID present, if so, remove
                   10534: 
                   10535:     my ($filename,$cookie,$userroles);
                   10536:     my $now=time;
                   10537: 
                   10538:     if ($public) {
                   10539: 	my $max_public=100;
                   10540: 	my $oldest;
                   10541: 	my $oldest_time=0;
                   10542: 	for(my $next=1;$next<=$max_public;$next++) {
                   10543: 	    if (-e $lonids."/publicuser_$next.id") {
                   10544: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10545: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10546: 		    $oldest_time=$mtime;
                   10547: 		    $oldest=$next;
                   10548: 		}
                   10549: 	    } else {
                   10550: 		$cookie="publicuser_$next";
                   10551: 		last;
                   10552: 	    }
                   10553: 	}
                   10554: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10555:     } else {
1.463     albertel 10556: 	# if this isn't a robot, kill any existing non-robot sessions
                   10557: 	if (!$args->{'robot'}) {
                   10558: 	    opendir(DIR,$lonids);
                   10559: 	    while ($filename=readdir(DIR)) {
                   10560: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10561: 		    unlink($lonids.'/'.$filename);
                   10562: 		}
1.462     albertel 10563: 	    }
1.463     albertel 10564: 	    closedir(DIR);
1.462     albertel 10565: 	}
                   10566: # Give them a new cookie
1.463     albertel 10567: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10568: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10569: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10570:     
                   10571: # Initialize roles
                   10572: 
                   10573: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10574:     }
                   10575: # ------------------------------------ Check browser type and MathML capability
                   10576: 
                   10577:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10578:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10579: 
                   10580: # ------------------------------------------------------------- Get environment
                   10581: 
                   10582:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10583:     my ($tmp) = keys(%userenv);
                   10584:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10585:     } else {
                   10586: 	undef(%userenv);
                   10587:     }
                   10588:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10589: 	$form->{'interface'}=$userenv{'interface'};
                   10590:     }
                   10591:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10592: 
                   10593: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10594:     foreach my $option ('interface','localpath','localres') {
                   10595:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10596:     }
                   10597: # --------------------------------------------------------- Write first profile
                   10598: 
                   10599:     {
                   10600: 	my %initial_env = 
                   10601: 	    ("user.name"          => $username,
                   10602: 	     "user.domain"        => $domain,
                   10603: 	     "user.home"          => $authhost,
                   10604: 	     "browser.type"       => $clientbrowser,
                   10605: 	     "browser.version"    => $clientversion,
                   10606: 	     "browser.mathml"     => $clientmathml,
                   10607: 	     "browser.unicode"    => $clientunicode,
                   10608: 	     "browser.os"         => $clientos,
                   10609: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10610: 	     "request.course.fn"  => '',
                   10611: 	     "request.course.uri" => '',
                   10612: 	     "request.course.sec" => '',
                   10613: 	     "request.role"       => 'cm',
                   10614: 	     "request.role.adv"   => $env{'user.adv'},
                   10615: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10616: 
                   10617:         if ($form->{'localpath'}) {
                   10618: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10619: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10620:         }
                   10621: 	
                   10622: 	if ($form->{'interface'}) {
                   10623: 	    $form->{'interface'}=~s/\W//gs;
                   10624: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10625: 	    $env{'browser.interface'}=$form->{'interface'};
                   10626: 	}
                   10627: 
1.724     raeburn  10628:         foreach my $tool ('aboutme','blog','portfolio') {
                   10629:             $userenv{'availabletools.'.$tool} = 
                   10630:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10631:         }
                   10632: 
1.864     raeburn  10633:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  10634:             $userenv{'canrequest.'.$crstype} =
                   10635:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10636:                                                   'reload','requestcourses');
                   10637:         }
                   10638: 
1.462     albertel 10639: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10640: 	
                   10641: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10642: 		 &GDBM_WRCREAT(),0640)) {
                   10643: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10644: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10645: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10646: 	    if (ref($args->{'extra_env'})) {
                   10647: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10648: 	    }
1.462     albertel 10649: 	    untie(%disk_env);
                   10650: 	} else {
1.705     tempelho 10651: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10652: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10653: 	    return 'error: '.$!;
                   10654: 	}
                   10655:     }
                   10656:     $env{'request.role'}='cm';
                   10657:     $env{'request.role.adv'}=$env{'user.adv'};
                   10658:     $env{'browser.type'}=$clientbrowser;
                   10659: 
                   10660:     return $cookie;
                   10661: 
                   10662: }
                   10663: 
                   10664: sub _add_to_env {
                   10665:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10666:     if (ref($env_data) eq 'HASH') {
                   10667:         while (my ($key,$value) = each(%$env_data)) {
                   10668: 	    $idf->{$prefix.$key} = $value;
                   10669: 	    $env{$prefix.$key}   = $value;
                   10670:         }
1.462     albertel 10671:     }
                   10672: }
                   10673: 
1.685     tempelho 10674: # --- Get the symbolic name of a problem and the url
                   10675: sub get_symb {
                   10676:     my ($request,$silent) = @_;
1.726     raeburn  10677:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10678:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10679:     if ($symb eq '') {
                   10680:         if (!$silent) {
                   10681:             $request->print("Unable to handle ambiguous references:$url:.");
                   10682:             return ();
                   10683:         }
                   10684:     }
                   10685:     &Apache::lonenc::check_decrypt(\$symb);
                   10686:     return ($symb);
                   10687: }
                   10688: 
                   10689: # --------------------------------------------------------------Get annotation
                   10690: 
                   10691: sub get_annotation {
                   10692:     my ($symb,$enc) = @_;
                   10693: 
                   10694:     my $key = $symb;
                   10695:     if (!$enc) {
                   10696:         $key =
                   10697:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10698:     }
                   10699:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10700:     return $annotation{$key};
                   10701: }
                   10702: 
                   10703: sub clean_symb {
1.731     raeburn  10704:     my ($symb,$delete_enc) = @_;
1.685     tempelho 10705: 
                   10706:     &Apache::lonenc::check_decrypt(\$symb);
                   10707:     my $enc = $env{'request.enc'};
1.731     raeburn  10708:     if ($delete_enc) {
1.730     raeburn  10709:         delete($env{'request.enc'});
                   10710:     }
1.685     tempelho 10711: 
                   10712:     return ($symb,$enc);
                   10713: }
1.462     albertel 10714: 
1.41      ng       10715: =pod
                   10716: 
                   10717: =back
                   10718: 
1.112     bowersj2 10719: =cut
1.41      ng       10720: 
1.112     bowersj2 10721: 1;
                   10722: __END__;
1.41      ng       10723: 

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