Diff for /loncom/interface/lonhtmlcommon.pm between versions 1.109 and 1.294

version 1.109, 2005/06/18 17:23:25 version 1.294, 2011/10/23 00:27:10
Line 60  use Time::Local; Line 60  use Time::Local;
 use Time::HiRes;  use Time::HiRes;
 use Apache::lonlocal;  use Apache::lonlocal;
 use Apache::lonnet;  use Apache::lonnet;
   use HTML::Entities();
   use LONCAPA;
   
   sub java_not_enabled {
      return "\n".'<span class="LC_error">'.
             &mt('The required Java applet could not be started. Please make sure to have Java installed and active in your browser.').
             "</span>\n";
   }
   
   sub coursepreflink {
      my ($text,$category)=@_;
      if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
         return '<a href="'.&HTML::Entities::encode("/adm/courseprefs?phase=display&actions=$category",'<>&"').'"><span class="LC_setting">'.$text.'</span></a>';
      } else {
         return '';
      }
   }
   
   sub raw_href_to_link {
      my ($message)=@_;
      $message=~s/(https?\:\/\/[^\s\'\"\<]+)([\s\<]|$)/<a href="$1"><tt>$1<\/tt><\/a>$2/gi;
      return $message;
   }
   
   sub entity_encode {
       my ($text)=@_;
       return &HTML::Entities::encode($text, '<>&"');
   }
   
   sub direct_parm_link {
       my ($linktext,$symb,$filter,$part,$target)=@_;
       $symb=&entity_encode($symb);
       $filter=&entity_encode($filter);
       $part=&entity_encode($part);
       if (($symb) && (&Apache::lonnet::allowed('opa')) && ($target ne 'tex')) {
          return "<a href='/adm/parmset?symb=$symb&filter=$filter&part=$part'><span class='LC_setting'>$linktext</span></a>";
       } else {
          return $linktext;
       }
   }
   ##############################################
   ##############################################
   
   =item confirm_success
   
   Successful completion of an operation message
   
   =cut
   
   sub confirm_success {
      my ($message,$failure)=@_;
      if ($failure) {
         return '<span class="LC_error" style="font-size: inherit;">'."\n"
               .'<img src="/adm/lonIcons/navmap.wrong.gif" alt="'.&mt('Error').'" /> '."\n"
               .$message."\n"
               .'</span>'."\n";
      } else {
         return '<span class="LC_success">'."\n"
               .'<img src="/adm/lonIcons/navmap.correct.gif" alt="'.&mt('OK').'" /> '."\n"
               .$message."\n"
               .'</span>'."\n";
      }
   }
   
   ##############################################
   ##############################################
   
   =pod
   
   =item dragmath_button
   
   Creates a button that launches a dragmath popup-window, in which an 
   expression can be edited and pasted as LaTeX into a specified textarea. 
   
     textarea - Name of the textarea to edit.
     helpicon - If true, show a help icon to the right of the button.
   
   =cut
   
   sub dragmath_button {
       my ($textarea,$helpicon) = @_;
       my $help_text; 
       if ($helpicon) {
           $help_text = &Apache::loncommon::help_open_topic('Authoring_Math_Editor',undef,undef,undef,undef,'mathhelpicon_'.$textarea);
       }
       my $buttontext=&mt('Edit Math');
       return <<ENDDRAGMATH;
                   <input type="button" value="$buttontext" onclick="javascript:mathedit('$textarea',document)" />$help_text
   ENDDRAGMATH
   }
   
   ##############################################
   
   =pod
   
   =item dragmath_js
   
   Javascript used to open pop-up window containing dragmath applet which 
   can be used to paste LaTeX into a textarea.
   =cut
   
   sub dragmath_js {
       my ($popup) = @_;
       return <<ENDDRAGMATHJS;
                   <script type="text/javascript">
                   // <![CDATA[
                     function mathedit(textarea, doc) {
                        targetEntry = textarea;
                        targetDoc   = doc;
                        newwin  = window.open("/adm/dragmath/applet/$popup.html","","width=565,height=500,resizable");
                     }
                   // ]]>
                   </script>
   
   ENDDRAGMATHJS
   }
   
   
 ##############################################  ##############################################
 ##############################################  ##############################################
Line 76  use Apache::lonnet; Line 193  use Apache::lonnet;
 sub authorbombs {  sub authorbombs {
     my $url=shift;      my $url=shift;
     $url=&Apache::lonnet::declutter($url);      $url=&Apache::lonnet::declutter($url);
     my ($udom,$uname)=($url=~/^(\w+)\/(\w+)\//);      my ($udom,$uname)=($url=~m{^($LONCAPA::domain_re)/($LONCAPA::username_re)/});
     my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);      my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);
     foreach (keys %bombs) {      foreach my $bomb (keys(%bombs)) {
  if ($_=~/^$udom\/$uname\//) {   if ($bomb =~ /^$udom\/$uname\//) {
     return '<a href="/adm/bombs/'.$url.      return '<a href="/adm/bombs/'.$url.
  '"><img src="'.&Apache::loncommon::lonhttpdurl('/adm/lonMisc/bomb.gif').'" border="0" /></a>'.   '"><img src="'.&Apache::loncommon::lonhttpdurl('/adm/lonMisc/bomb.gif').'" alt="'.&mt('Bomb').'" border="0" /></a>'.
  &Apache::loncommon::help_open_topic('About_Bombs');   &Apache::loncommon::help_open_topic('About_Bombs');
  }   }
     }      }
Line 93  sub authorbombs { Line 210  sub authorbombs {
   
 sub recent_filename {  sub recent_filename {
     my $area=shift;      my $area=shift;
     return 'nohist_recent_'.&Apache::lonnet::escape($area);      return 'nohist_recent_'.&escape($area);
 }  }
   
 sub store_recent {  sub store_recent {
     my ($area,$name,$value)=@_;      my ($area,$name,$value,$freeze)=@_;
     my $file=&recent_filename($area);      my $file=&recent_filename($area);
     my %recent=&Apache::lonnet::dump($file);      my %recent=&Apache::lonnet::dump($file);
     if (scalar(keys(%recent))>10) {      if (scalar(keys(%recent))>20) {
 # remove oldest value  # remove oldest value
  my $oldest=time;   my $oldest=time();
  my $delkey='';   my $delkey='';
  foreach (keys %recent) {   foreach my $item (keys(%recent)) {
     my $thistime=(split(/\&/,$recent{$_}))[0];      my $thistime=(split(/\&/,$recent{$item}))[0];
     if ($thistime<$oldest) {      if (($thistime ne "always_include") && ($thistime<$oldest)) {
  $oldest=$thistime;   $oldest=$thistime;
  $delkey=$_;   $delkey=$item;
     }      }
  }   }
  &Apache::lonnet::del($file,[$delkey]);   &Apache::lonnet::del($file,[$delkey]);
     }      }
 # store new value  # store new value
       my $timestamp;
       if ($freeze) {
           $timestamp = "always_include";
       } else {
           $timestamp = time();
       }   
     &Apache::lonnet::put($file,{ $name =>       &Apache::lonnet::put($file,{ $name => 
  time.'&'.&Apache::lonnet::escape($value) });   $timestamp.'&'.&escape($value) });
 }  }
   
 sub remove_recent {  sub remove_recent {
Line 130  sub select_recent { Line 253  sub select_recent {
     my $return="\n<select name='$fieldname'".      my $return="\n<select name='$fieldname'".
  ($event?" onchange='$event'":'').   ($event?" onchange='$event'":'').
  ">\n<option value=''>--- ".&mt('Recent')." ---</option>";   ">\n<option value=''>--- ".&mt('Recent')." ---</option>";
     foreach (sort keys %recent) {      foreach my $value (sort(keys(%recent))) {
  unless ($_=~/^error\:/) {   unless ($value =~/^error\:/) {
     my $escaped = &Apache::loncommon::escape_url($_);      my $escaped = &Apache::loncommon::escape_url($value);
       &Apache::loncommon::inhibit_menu_check(\$escaped);
               if ($area eq 'residx') {
                   next if ((!&Apache::lonnet::allowed('bre',$value)) && (!&Apache::lonnet::allowed('bro',$value)));
               }
     $return.="\n<option value='$escaped'>".      $return.="\n<option value='$escaped'>".
  &Apache::lonnet::unescape((split(/\&/,$recent{$_}))[1]).   &unescape((split(/\&/,$recent{$value}))[1]).
  '</option>';   '</option>';
  }   }
     }      }
Line 147  sub get_recent { Line 274  sub get_recent {
     my %recent=&Apache::lonnet::dump(&recent_filename($area));      my %recent=&Apache::lonnet::dump(&recent_filename($area));
   
 # Create hash with key as time and recent as value  # Create hash with key as time and recent as value
   # Begin filling return_hash with any 'always_include' option
     my %time_hash = ();      my %time_hash = ();
     foreach (keys %recent) {      my %return_hash = ();
         my $thistime=(split(/\&/,$recent{$_}))[0];      foreach my $item (keys(%recent)) {
         $time_hash{$thistime} = $_;          my ($thistime,$thisvalue)=(split(/\&/,$recent{$item}));
           if ($thistime eq 'always_include') {
               $return_hash{$item} = &unescape($thisvalue);
               $n--;
           } else {
               $time_hash{$thistime} = $item;
           }
     }      }
   
 # Sort by decreasing time and return key value pairs  # Sort by decreasing time and return key value pairs
     my %return_hash = ();  
     my $idx = 1;      my $idx = 1;
     foreach (reverse sort keys %time_hash) {      foreach my $item (reverse(sort(keys(%time_hash)))) {
        $return_hash{$time_hash{$_}} =         $return_hash{$time_hash{$item}} =
                   &Apache::lonnet::unescape((split(/\&/,$recent{$_}))[1]);                    &unescape((split(/\&/,$recent{$time_hash{$item}}))[1]);
        if ($n && ($idx++ >= $n)) {last;}         if ($n && ($idx++ >= $n)) {last;}
     }      }
   
     return %return_hash;      return %return_hash;
 }  }
   
   sub get_recent_frozen {
       my ($area) = @_;
       my %recent=&Apache::lonnet::dump(&recent_filename($area));
   
   # Create hash with all 'frozen' items
       my %return_hash = ();
       foreach my $item (keys(%recent)) {
           my ($thistime,$thisvalue)=(split(/\&/,$recent{$item}));
           if ($thistime eq 'always_include') {
               $return_hash{$item} = &unescape($thisvalue);
           }
       }
       return %return_hash;
   }
   
   
   
 =pod  =pod
Line 178  sub get_recent { Line 326  sub get_recent {
 sub textbox {  sub textbox {
     my ($name,$value,$size,$special) = @_;      my ($name,$value,$size,$special) = @_;
     $size = 40 if (! defined($size));      $size = 40 if (! defined($size));
       $value = &HTML::Entities::encode($value,'<>&"');
     my $Str = '<input type="text" name="'.$name.'" size="'.$size.'" '.      my $Str = '<input type="text" name="'.$name.'" size="'.$size.'" '.
         'value="'.$value.'" '.$special.' />';          'value="'.$value.'" '.$special.' />';
     return $Str;      return $Str;
Line 201  sub checkbox { Line 350  sub checkbox {
         $Str .= 'value="'.$value.'"';          $Str .= 'value="'.$value.'"';
     }       } 
     if ($checked) {      if ($checked) {
         $Str .= ' checked="1"';          $Str .= ' checked="checked"';
       }
       $Str .= ' />';
       return $Str;
   }
   
   
   =pod
   
   =item radiobutton
   
   =cut
   
   ##############################################
   ##############################################
   sub radio {
       my ($name,$checked,$value) = @_;
       my $Str = '<input type="radio" name="'.$name.'" ';
       if (defined($value)) {
           $Str .= 'value="'.$value.'"';
       } 
       if ($checked eq $value) {
           $Str .= ' checked="checked"';
     }      }
     $Str .= ' />';      $Str .= ' />';
     return $Str;      return $Str;
Line 231  dname_hour, dname_min, and dname_sec. Line 402  dname_hour, dname_min, and dname_sec.
   
 The current setting for this time parameter.  A unix format time  The current setting for this time parameter.  A unix format time
 (time in seconds since the beginning of Jan 1st, 1970, GMT.    (time in seconds since the beginning of Jan 1st, 1970, GMT.  
 An undefined value is taken to indicate the value is the current time.  An undefined value is taken to indicate the value is the current time
   unless it is requested to leave it empty. See $includeempty.
 Also, to be explicit, a value of 'now' also indicates the current time.  Also, to be explicit, a value of 'now' also indicates the current time.
   
 =item $special  =item $special
Line 241  the date_setter.  See lonparmset for exa Line 413  the date_setter.  See lonparmset for exa
   
 =item $includeempty   =item $includeempty 
   
   If it is set (true) and no date/time value is provided,
   the date/time fields are left empty.
   
 =item $state  =item $state
   
 Specifies the initial state of the form elements.  Either 'disabled' or empty.  Specifies the initial state of the form elements.  Either 'disabled' or empty.
Line 258  The method used to restrict user input w Line 433  The method used to restrict user input w
 ##############################################  ##############################################
 sub date_setter {  sub date_setter {
     my ($formname,$dname,$currentvalue,$special,$includeempty,$state,      my ($formname,$dname,$currentvalue,$special,$includeempty,$state,
         $no_hh_mm_ss,$defhour,$defmin,$defsec) = @_;          $no_hh_mm_ss,$defhour,$defmin,$defsec,$nolink) = @_;
     my $wasdefined=1;      my $now = time;
   
       my $tzname;
       my ($sec,$min,$hour,$mday,$month,$year) = ('', '', undef,''.''.'');
       #other potentially useful values:    wkday,yrday,is_daylight_savings
   
     if (! defined($state) || $state ne 'disabled') {      if (! defined($state) || $state ne 'disabled') {
         $state = '';          $state = '';
     }      }
     if (! defined($no_hh_mm_ss)) {      if (! defined($no_hh_mm_ss)) {
         $no_hh_mm_ss = 0;          $no_hh_mm_ss = 0;
     }      }
     if (! defined($currentvalue) || $currentvalue eq 'now') {      if ($currentvalue eq 'now') {
  unless ($includeempty) {          $currentvalue = $now;
     $currentvalue = time;  
     $wasdefined=0;  
  } else {  
     $currentvalue = 0;  
  }  
     }      }
     # other potentially useful values:     wkday,yrday,is_daylight_savings      
     my ($sec,$min,$hour,$mday,$month,$year)=('','',undef,'','','');      # Default value: Set empty date field to current time
       # unless empty inclusion is requested
       if ((!$includeempty) && (!$currentvalue)) {
           $currentvalue = $now;
       }
       # Do we have a date? Split it!
     if ($currentvalue) {      if ($currentvalue) {
  ($sec,$min,$hour,$mday,$month,$year,undef,undef,undef) =    ($tzname,$sec,$min,$hour,$mday,$month,$year) = &get_timedates($currentvalue);
     localtime($currentvalue);  
  $year += 1900;          #No values provided for hour, min, sec? Use default 0
     }          if (($defhour) || ($defmin) || ($defsec)) {
     unless ($wasdefined) {              $sec  = ($defsec  ? $defsec  : 0);
  $sec=($defsec?$defsec:0);              $min  = ($defmin  ? $defmin  : 0);
  $min=($defmin?$defmin:0);              $hour = ($defhour ? $defhour : 0);
         $hour=($defhour?$defhour:0);          }
     }      }
     my $result = "\n<!-- $dname date setting form -->\n";      my $result = "\n<!-- $dname date setting form -->\n";
     $result .= <<ENDJS;      $result .= <<ENDJS;
 <script language="Javascript">  <script type="text/javascript">
   // <![CDATA[
     function $dname\_checkday() {      function $dname\_checkday() {
         var day   = document.$formname.$dname\_day.value;          var day   = document.$formname.$dname\_day.value;
         var month = document.$formname.$dname\_month.value;          var month = document.$formname.$dname\_month.value;
Line 349  document.$formname.$dname\_year.value, Line 530  document.$formname.$dname\_year.value,
         }          }
   
     }      }
   // ]]>
 </script>  </script>
 ENDJS  ENDJS
     $result .= '  <nobr>';      $result .= '  <span class="LC_nobreak">';
     my $monthselector = qq{<select name="$dname\_month" $special $state onchange="javascript:$dname\_checkday()" >};      my $monthselector = qq{<select name="$dname\_month" $special $state onchange="javascript:$dname\_checkday()" >};
     # Month      # Month
     my @Months = qw/January February  March     April   May      June       my @Months = qw/January February  March     April   May      June 
Line 360  ENDJS Line 542  ENDJS
     unshift(@Months,'If you can read this an error occurred');      unshift(@Months,'If you can read this an error occurred');
     if ($includeempty) { $monthselector.="<option value=''></option>"; }      if ($includeempty) { $monthselector.="<option value=''></option>"; }
     for(my $m = 1;$m <=$#Months;$m++) {      for(my $m = 1;$m <=$#Months;$m++) {
         $monthselector .= qq{      <option value="$m" };          $monthselector .= qq{      <option value="$m"};
         $monthselector .= "selected " if ($m-1 eq $month);          $monthselector .= ' selected="selected"' if ($m-1 eq $month);
         $monthselector .= '> '.&mt($Months[$m]).' </option>';          $monthselector .= '> '.&mt($Months[$m]).' </option>'."\n";
     }      }
     $monthselector.= '  </select>';      $monthselector.= '  </select>';
     # Day      # Day
     my $dayselector = qq{<input type="text" name="$dname\_day" $state value="$mday" size="3" $special onchange="javascript:$dname\_checkday()" />};      my $dayselector = qq{<input type="text" name="$dname\_day" $state value="$mday" size="3" $special onchange="javascript:$dname\_checkday()" />};
     # Year      # Year
     my $yearselector = qq{<input type="year" name="$dname\_year" $state value="$year" size="5" $special onchange="javascript:$dname\_checkday()" />};      my $yearselector = qq{<input type="text" name="$dname\_year" $state value="$year" size="5" $special onchange="javascript:$dname\_checkday()" />};
     #      #
     my $hourselector = qq{<select name="$dname\_hour" $special $state >};      my $hourselector = qq{<select name="$dname\_hour" $special $state >};
     if ($includeempty) {       if ($includeempty) { 
         $hourselector.=qq{<option value=''></option>};          $hourselector.=qq{<option value=''></option>};
     }      }
     for (my $h = 0;$h<24;$h++) {      for (my $h = 0;$h<24;$h++) {
         $hourselector .= qq{<option value="$h" };          $hourselector .= qq{<option value="$h"};
         $hourselector .= "selected " if (defined($hour) && $hour == $h);          $hourselector .= ' selected="selected"' if (defined($hour) && $hour == $h);
         $hourselector .= ">";          $hourselector .= ">";
         my $timest='';          my $timest='';
         if ($h == 0) {          if ($h == 0) {
Line 394  ENDJS Line 576  ENDJS
     $hourselector .= "  </select>\n";      $hourselector .= "  </select>\n";
     my $minuteselector = qq{<input type="text" name="$dname\_minute" $special $state value="$min" size="3" />};      my $minuteselector = qq{<input type="text" name="$dname\_minute" $special $state value="$min" size="3" />};
     my $secondselector= qq{<input type="text" name="$dname\_second" $special $state value="$sec" size="3" />};      my $secondselector= qq{<input type="text" name="$dname\_second" $special $state value="$sec" size="3" />};
     my $cal_link = qq{<a href="javascript:$dname\_opencalendar()">};      my $cal_link;
       if (!$nolink) {
           $cal_link = qq{<a href="javascript:$dname\_opencalendar()">};
       }
     #      #
       my $tzone = ' '.$tzname.' ';
     if ($no_hh_mm_ss) {      if ($no_hh_mm_ss) {
         $result .= &mt('[_1] [_2] [_3] [_4]Select Date[_5]',          $result .= &mt('[_1] [_2] [_3] ',
                        $monthselector,$dayselector,$yearselector,                         $monthselector,$dayselector,$yearselector).
                        $cal_link,'</a>');                     $tzone;
           if (!$nolink) {
               $result .= &mt('[_1]Select Date[_2]',$cal_link,'</a>');
           }
     } else {      } else {
         $result .= &mt('[_1] [_2] [_3] [_4] [_5]m [_6]s [_7]Select Date[_8]',          $result .= &mt('[_1] [_2] [_3] [_4] [_5]m [_6]s ',
                        $monthselector,$dayselector,$yearselector,                        $monthselector,$dayselector,$yearselector,
                        $hourselector,$minuteselector,$secondselector,                        $hourselector,$minuteselector,$secondselector).
                        $cal_link,'</a>');                     $tzone;
           if (!$nolink) {
               $result .= &mt('[_1]Select Date[_2]',$cal_link,'</a>');
           }
     }      }
     $result .= "</nobr>\n<!-- end $dname date setting form -->\n";      $result .= "</span>\n<!-- end $dname date setting form -->\n";
     return $result;      return $result;
 }  }
   
   sub get_timedates {
       my ($epoch) = @_;
       my $dt = DateTime->from_epoch(epoch => $epoch)
                        ->set_time_zone(&Apache::lonlocal::gettimezone());
       my $tzname = $dt->time_zone_short_name();
       my $sec = $dt->second;
       my $min = $dt->minute;
       my $hour = $dt->hour;
       my $mday = $dt->day;
       my $month = $dt->month;
       if ($month) {
           $month --;
       }
       my $year = $dt->year;
       return ($tzname,$sec,$min,$hour,$mday,$month,$year);
   }
   
   sub build_url {
       my ($base, $fields)=@_;
       my $url;
       $url = $base.'?';
       foreach my $key (keys(%$fields)) {
           $url.=&escape($key).'='.&escape($$fields{$key}).'&amp;';
       }
       $url =~ s/&amp;$//;
       return $url;
   }
   
   
 ##############################################  ##############################################
 ##############################################  ##############################################
   
Line 425  Inputs: Line 646  Inputs:
   
 =item $dname  =item $dname
   
 The name passed to &datesetter, which prefixes the form elements.  The name passed to &date_setter, which prefixes the form elements.
   
 =item $defaulttime  =item $defaulttime
   
Line 478  sub get_date_from_form { Line 699  sub get_date_from_form {
     if (defined($env{'form.'.$dname.'_month'})) {      if (defined($env{'form.'.$dname.'_month'})) {
         my $tmpmonth = $env{'form.'.$dname.'_month'};          my $tmpmonth = $env{'form.'.$dname.'_month'};
         if (($tmpmonth =~ /^\d+$/) && ($tmpmonth > 0) && ($tmpmonth < 13)) {          if (($tmpmonth =~ /^\d+$/) && ($tmpmonth > 0) && ($tmpmonth < 13)) {
             $month = $tmpmonth - 1;              $month = $tmpmonth;
         }          }
     }      }
     if (defined($env{'form.'.$dname.'_year'})) {      if (defined($env{'form.'.$dname.'_year'})) {
         my $tmpyear = $env{'form.'.$dname.'_year'};          my $tmpyear = $env{'form.'.$dname.'_year'};
         if (($tmpyear =~ /^\d+$/) && ($tmpyear > 1900)) {          if (($tmpyear =~ /^\d+$/) && ($tmpyear >= 1970)) {
             $year = $tmpyear - 1900;              $year = $tmpyear;
         }          }
     }      }
     if (($year<70) || ($year>137)) { return undef; }      if (($year<1970) || ($year>2037)) { return undef; }
     if (defined($sec) && defined($min)   && defined($hour) &&      if (defined($sec) && defined($min)   && defined($hour) &&
         defined($day) && defined($month) && defined($year) &&          defined($day) && defined($month) && defined($year)) {
         eval(&timelocal($sec,$min,$hour,$day,$month,$year))) {          my $timezone = &Apache::lonlocal::gettimezone();
         return &timelocal($sec,$min,$hour,$day,$month,$year);          my $dt = DateTime->new( year   => $year,
                                   month  => $month,
                                   day    => $day,
                                   hour   => $hour,
                                   minute => $min,
                                   second => $sec,
                                   time_zone => $timezone,
                                 );
           my $epoch_time  = $dt->epoch;
           if ($epoch_time ne '') {
               return $epoch_time;
           } else {
               return undef;
           }
     } else {      } else {
         return undef;          return undef;
     }      }
Line 561  sub javascript_nothing { Line 795  sub javascript_nothing {
 ##############################################  ##############################################
 ##############################################  ##############################################
 sub javascript_docopen {  sub javascript_docopen {
       my ($mimetype) = @_;
       $mimetype ||= 'text/html';
     # safari does not understand document.open() and loads "text/html"      # safari does not understand document.open() and loads "text/html"
     my $nothing = "''";      my $nothing = "''";
     my $user_browser;      my $user_browser;
Line 574  sub javascript_docopen { Line 810  sub javascript_docopen {
     if ($user_browser eq 'safari' && $user_os =~ 'mac') {      if ($user_browser eq 'safari' && $user_os =~ 'mac') {
         $nothing = "document.clear()";          $nothing = "document.clear()";
     } else {      } else {
  $nothing = "document.open('text/html','replace')";   $nothing = "document.open('$mimetype','replace')";
     }      }
     return $nothing;      return $nothing;
 }  }
Line 611  Returns: a perl string as described. Line 847  Returns: a perl string as described.
 ##############################################  ##############################################
 ##############################################  ##############################################
 sub StatusOptions {  sub StatusOptions {
     my ($status, $formName,$size,$onchange)=@_;      my ($status, $formName,$size,$onchange,$mult)=@_;
     $size = 1 if (!defined($size));      $size = 1 if (!defined($size));
     if (! defined($status)) {      if (! defined($status)) {
         $status = 'Active';          $status = 'Active';
         $status = $env{'form.Status'} if (exists($env{'form.Status'}));          $status = $env{'form.Status'} if (exists($env{'form.Status'}));
     }      }
   
     my $OpSel1 = '';  
     my $OpSel2 = '';  
     my $OpSel3 = '';  
   
     if($status eq 'Any')         { $OpSel3 = ' selected'; }  
     elsif($status eq 'Expired' ) { $OpSel2 = ' selected'; }  
     else                         { $OpSel1 = ' selected'; }  
   
     my $Str = '';      my $Str = '';
     $Str .= '<select name="Status"';      $Str .= '<select name="Status"';
       if (defined($mult)){
           $Str .= ' multiple="multiple" ';
       }
     if(defined($formName) && $formName ne '' && ! defined($onchange)) {      if(defined($formName) && $formName ne '' && ! defined($onchange)) {
         $Str .= ' onchange="document.'.$formName.'.submit()"';          $Str .= ' onchange="document.'.$formName.'.submit()"';
     }      }
Line 636  sub StatusOptions { Line 867  sub StatusOptions {
     }      }
     $Str .= ' size="'.$size.'" ';      $Str .= ' size="'.$size.'" ';
     $Str .= '>'."\n";      $Str .= '>'."\n";
     $Str .= '<option value="Active" '.$OpSel1.'>'.      foreach my $type (['Active',  &mt('Currently Has Access')],
         &mt('Currently Enrolled').'</option>'."\n";        ['Future',  &mt('Will Have Future Access')],
     $Str .= '<option value="Expired" '.$OpSel2.'>'.        ['Expired', &mt('Previously Had Access')],
         &mt('Previously Enrolled').'</option>'."\n";        ['Any',     &mt('Any Access Status')]) {
     $Str .= '<option value="Any" '.$OpSel3.'>'.   my ($name,$label) = @$type;
         &mt('Any Enrollment Status').'</option>'."\n";   $Str .= '<option value="'.$name.'" ';
    if ($status eq $name) {
       $Str .= 'selected="selected" ';
    }
    $Str .= '>'.$label.'</option>'."\n";
       }
   
     $Str .= '</select>'."\n";      $Str .= '</select>'."\n";
 }  }
   
Line 712  Returns: none Line 949  Returns: none
   
 =item Increment_PrgWin  =item Increment_PrgWin
   
 Increment the count of items completed for the progress window by 1.    Increment the count of items completed for the progress window by $step or 1 if no step is provided.
   
 Inputs:  Inputs:
   
Line 725  Inputs: Line 962  Inputs:
 =item $extraInfo A description of the items being iterated over.  Typically  =item $extraInfo A description of the items being iterated over.  Typically
 'student'.  'student'.
   
   =item $step (optional) counter step. Will be set to default 1 if ommited. step must be greater than 0 or empty.
   
 =back  =back
   
 Returns: none  Returns: none
Line 769  sub Create_PrgWin { Line 1008  sub Create_PrgWin {
     $prog_state{'type'}=$type;      $prog_state{'type'}=$type;
     if ($type eq 'popup') {      if ($type eq 'popup') {
  $prog_state{'window'}='popwin';   $prog_state{'window'}='popwin';
  my $html=&Apache::lonxml::xmlbegin();   my $start_page =
       &Apache::loncommon::start_page($title,undef,
      {'only_body' => 1,
       'bgcolor'   => '#88DDFF',
       'js_ready'  => 1});
    my $end_page = &Apache::loncommon::end_page({'js_ready'  => 1});
   
  #the whole function called through timeout is due to issues   #the whole function called through timeout is due to issues
  #in mozilla Read BUG #2665 if you want to know the whole story   #in mozilla Read BUG #2665 if you want to know the whole story
  &r_print($r,'<script>'.   &r_print($r,&Apache::lonhtmlcommon::scripttag(
         "var popwin;          "var popwin;
          function openpopwin () {           function openpopwin () {
          popwin=open(\'\',\'popwin\',\'width=400,height=100\');".           popwin=open(\'\',\'popwin\',\'width=400,height=100\');".
         "popwin.document.writeln(\'".$html."<head><title>$title</title></head>".          "popwin.document.writeln(\'".$start_page.
       "<body bgcolor=\"#88DDFF\">".                "<h4>".&mt("$heading")."<\/h4>".
               "<h4>$heading</h4>".                "<form action=\"\" name=\"popremain\" method=\"post\">".
               "<form name=popremain>".  
               '<input type="text" size="'.$width.'" name="remaining" value="'.                '<input type="text" size="'.$width.'" name="remaining" value="'.
       &mt('Starting').'"></form>'.        &mt('Starting').'" /><\\/form>'.$end_page.
               "</body></html>\');".                "\');".
         "popwin.document.close();}".          "popwin.document.close();}".
         "\nwindow.setTimeout(openpopwin,0)</script>");          "\nwindow.setTimeout(openpopwin,0)"
       ));
  $prog_state{'formname'}='popremain';   $prog_state{'formname'}='popremain';
  $prog_state{'inputname'}="remaining";   $prog_state{'inputname'}="remaining";
     } elsif ($type eq 'inline') {      } elsif ($type eq 'inline') {
  $prog_state{'window'}='window';   $prog_state{'window'}='window';
  if (!$formname) {   if (!$formname) {
     $prog_state{'formname'}=&get_uniq_name();      $prog_state{'formname'}=&get_uniq_name();
     &r_print($r,'<form name="'.$prog_state{'formname'}.'">');      &r_print($r,'<form action="" name="'.$prog_state{'formname'}.'">');
  } else {   } else {
     $prog_state{'formname'}=$formname;      $prog_state{'formname'}=$formname;
  }   }
  if (!$inputname) {   if (!$inputname) {
     $prog_state{'inputname'}=&get_uniq_name();      $prog_state{'inputname'}=&get_uniq_name();
     &r_print($r,$heading.' <input type="text" name="'.$prog_state{'inputname'}.      &r_print($r,&mt("$heading [_1]",' <input type="text" name="'.$prog_state{'inputname'}.'" size="'.$width.'" />'));
      '" size="'.$width.'" />');  
  } else {   } else {
     $prog_state{'inputname'}=$inputname;      $prog_state{'inputname'}=$inputname;
           
Line 818  sub Create_PrgWin { Line 1062  sub Create_PrgWin {
 # update progress  # update progress
 sub Update_PrgWin {  sub Update_PrgWin {
     my ($r,$prog_state,$displayString)=@_;      my ($r,$prog_state,$displayString)=@_;
     &r_print($r,'<script>'.$$prog_state{'window'}.'.document.'.      &r_print($r,&Apache::lonhtmlcommon::scripttag(
      $$prog_state{'formname'}.'.'.          $$prog_state{'window'}.'.document.'.
      $$prog_state{'inputname'}.'.value="'.          $$prog_state{'formname'}.'.'.
      $displayString.'";</script>');          $$prog_state{'inputname'}.'.value="'.
           $displayString.'";'
       ));
     $$prog_state{'laststart'}=&Time::HiRes::time();      $$prog_state{'laststart'}=&Time::HiRes::time();
 }  }
   
 # increment progress state  # increment progress state
 sub Increment_PrgWin {  sub Increment_PrgWin {
     my ($r,$prog_state,$extraInfo)=@_;      my ($r,$prog_state,$extraInfo,$step)=@_;
     $$prog_state{'done'}++;      $step = $step > 0 ? $step : 1;
       $$prog_state{'done'} += $step;
   
       # Catch (max modulo step) <> 0
       my $current = $$prog_state{'done'};
       my $last = ($$prog_state{'max'} - $current);
       if ($last <= 0) {
           $last = 1;
           $current = $$prog_state{'max'};
       }
   
     my $time_est= (&Time::HiRes::time() - $$prog_state{'firststart'})/      my $time_est= (&Time::HiRes::time() - $$prog_state{'firststart'})/
         $$prog_state{'done'} *          $current * $last;
  ($$prog_state{'max'}-$$prog_state{'done'});  
     $time_est = int($time_est);      $time_est = int($time_est);
     #      #
     my $min = int($time_est/60);      my $min = int($time_est/60);
     my $sec = $time_est % 60;      my $sec = $time_est % 60;
     #   
     my $str;  
     if ($min == 0 && $sec > 1) {  
         $str = '[_2] seconds';  
     } elsif ($min == 1 && $sec > 1) {  
         $str = '1 minute [_2] seconds';  
     } elsif ($min == 1 && $sec < 2) {  
         $str = '1 minute';  
     } elsif ($min < 10 && $sec > 1) {  
         $str = '[_1] minutes, [_2] seconds';  
     } elsif ($min >= 10 || $sec < 2) {  
         $str = '[_1] minutes';  
     }  
     $time_est = &mt($str,$min,$sec);  
     #  
     my $lasttime = &Time::HiRes::time()-$$prog_state{'laststart'};      my $lasttime = &Time::HiRes::time()-$$prog_state{'laststart'};
     if ($lasttime > 9) {      if ($lasttime > 9) {
         $lasttime = int($lasttime);          $lasttime = int($lasttime);
Line 859  sub Increment_PrgWin { Line 1100  sub Increment_PrgWin {
     } else {      } else {
         $lasttime = sprintf("%3.2f",$lasttime);          $lasttime = sprintf("%3.2f",$lasttime);
     }      }
     if ($lasttime == 1) {  
         $lasttime = '('.$lasttime.' '.&mt('second for').' '.$extraInfo.')';      $sec = 0 if ($min >= 10); # Don't show seconds if remaining time >= 10 min.
     } else {      $sec = 1 if ( ($min == 0) && ($sec == 0) ); # Little cheating: pretend to have 1 second remaining instead of 0 to have something to display
         $lasttime = '('.$lasttime.' '.&mt('seconds for').' '.$extraInfo.')';  
     }      my $timeinfo =
     #          &mt('[_1]/[_2]:'
     my $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));             .' [quant,_3,minute,minutes,] [quant,_4,second ,seconds ,]remaining'
     my $user_os      = $env{'browser.os'}   if (exists($env{'browser.os'}));             .' ([quant,_5,second] for '.$extraInfo.')',
     if (! defined($user_browser) || ! defined($user_os)) {              $current,
         (undef,$user_browser,undef,undef,undef,$user_os) =               $$prog_state{'max'},
                            &Apache::loncommon::decode_user_agent();              $min,
     }              $sec,
     if ($user_browser eq 'explorer' && $user_os =~ 'mac') {              $lasttime);
         $lasttime = '';  
     }      &r_print($r,&Apache::lonhtmlcommon::scripttag(
     &r_print($r,'<script>'.$$prog_state{'window'}.'.document.'.          $$prog_state{'window'}.'.document.'.
      $$prog_state{'formname'}.'.'.          $$prog_state{'formname'}.'.'.
      $$prog_state{'inputname'}.'.value="'.          $$prog_state{'inputname'}.'.value="'.$timeinfo.'";'
      $$prog_state{'done'}.'/'.$$prog_state{'max'}.      ));
      ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'.'</script>');  
     $$prog_state{'laststart'}=&Time::HiRes::time();      $$prog_state{'laststart'}=&Time::HiRes::time();
 }  }
   
Line 886  sub Increment_PrgWin { Line 1126  sub Increment_PrgWin {
 sub Close_PrgWin {  sub Close_PrgWin {
     my ($r,$prog_state)=@_;      my ($r,$prog_state)=@_;
     if ($$prog_state{'type'} eq 'popup') {      if ($$prog_state{'type'} eq 'popup') {
  &r_print($r,'<script>popwin.close()</script>'."\n");          &r_print($r,&Apache::lonhtmlcommon::scripttag(
               'popwin.close()'
           ));
     } elsif ($$prog_state{'type'} eq 'inline') {      } elsif ($$prog_state{'type'} eq 'inline') {
  &Update_PrgWin($r,$prog_state,&mt('Done'));   &Update_PrgWin($r,$prog_state,&mt('Done'));
     }      }
Line 906  sub r_print { Line 1148  sub r_print {
 # ------------------------------------------------------- Puts directory header  # ------------------------------------------------------- Puts directory header
   
 sub crumbs {  sub crumbs {
     my ($uri,$target,$prefix,$form,$size,$noformat)=@_;      my ($uri,$target,$prefix,$form,$skiplast)=@_;
     if (! defined($size)) {  
         $size = '+2';  
     }  
     if ($target) {      if ($target) {
         $target = ' target="'.          $target = ' target="'.
                   &Apache::loncommon::escape_single($target).'"';                    &Apache::loncommon::escape_single($target).'"';
     }      }
     my $output='';      my $output='<span class="LC_filename">';
     unless ($noformat) { $output.='<br /><tt><b>'; }      $output.=$prefix.'/';
     $output.='<font size="'.$size.'">'.$prefix.'/';      if (($env{'user.adv'}) || ($env{'user.author'})) {
     if ($env{'user.adv'}) {          my $path=$prefix.'/';
  my $path=$prefix.'/';          foreach my $dir (split('/',$uri)) {
  foreach my $dir (split('/',$uri)) {  
             if (! $dir) { next; }              if (! $dir) { next; }
             $path .= $dir;              $path .= $dir;
     unless ($path eq $uri) { $path.='/'; }              if ($path eq $uri) {
             my $linkpath = &Apache::loncommon::escape_single($path);                  if ($skiplast) {
                       $output.=$dir;
                       last;
                   } 
               } else {
                   $path.='/'; 
               }
               my $href_path = &HTML::Entities::encode($path,'<>&"');
               &Apache::loncommon::inhibit_menu_check(\$href_path);
             if ($form) {              if ($form) {
  $linkpath=                  my $href = 'javascript:'.$form.".action='".$href_path."';".$form.'.submit();';
                     qq{javascript:$form.action='$linkpath';$form.submit();};                  $output.=qq{<a href="$href"$target>$dir</a>/};
               } else {
                   $output.=qq{<a href="$href_path"$target>$dir</a>/};
             }              }
     $output.=qq{<a href="$linkpath" $target>$dir</a>/};          }
  }  
     } else {      } else {
  $output.=$uri;          foreach my $dir (split('/',$uri)) {
               if (! $dir) { next; }
               $output.=$dir.'/';
           }
     }      }
     unless ($uri=~/\/$/) { $output=~s/\/$//; }      if ($uri !~ m|/$|) { $output=~s|/$||; }
     return $output.'</font>'.($noformat?'':'</b></tt><br />');      $output.='</span>';
   
       return $output;
 }  }
   
 # --------------------- A function that generates a window for the spellchecker  # --------------------- A function that generates a window for the spellchecker
   
 sub spellheader {  sub spellheader {
     my $html=&Apache::lonxml::xmlbegin();      my $start_page=
    &Apache::loncommon::start_page('Speller Suggestions',undef,
          {'only_body'   => 1,
    'js_ready'    => 1,
    'bgcolor'     => '#DDDDDD',
           'add_entries' => {
       'onload' => 
                                                  'document.forms.spellcheckform.submit()',
                                                }
           });
       my $end_page=
    &Apache::loncommon::end_page({'js_ready'  => 1}); 
   
     my $nothing=&javascript_nothing();      my $nothing=&javascript_nothing();
     return (<<ENDCHECK);      return (<<ENDCHECK);
 <script type="text/javascript">   <script type="text/javascript"> 
   // <![CDATA[
 //<!-- BEGIN LON-CAPA Internal  //<!-- BEGIN LON-CAPA Internal
 var checkwin;  var checkwin;
   
 function spellcheckerwindow() {  function spellcheckerwindow(string) {
       var esc_string = string.replace(/\"/g,'&quot;');
     checkwin=window.open($nothing,'spellcheckwin','height=320,width=280,resizable=yes,scrollbars=yes,location=no,menubar=no,toolbar=no');      checkwin=window.open($nothing,'spellcheckwin','height=320,width=280,resizable=yes,scrollbars=yes,location=no,menubar=no,toolbar=no');
     checkwin.document.writeln('$html<head></head><body bgcolor="#DDDDDD"><form name="spellcheckform" action="/adm/spellcheck" method="post"><input type="hidden" name="text" value="" /></form></body></html>');      checkwin.document.writeln('$start_page<form name="spellcheckform" action="/adm/spellcheck" method="post"><input type="hidden" name="text" value="'+esc_string+'" /><\\/form>$end_page');
     checkwin.document.close();      checkwin.document.close();
 }  }
 // END LON-CAPA Internal -->  // END LON-CAPA Internal -->
   // ]]>
 </script>  </script>
 ENDCHECK  ENDCHECK
 }  }
Line 963  sub spelllink { Line 1230  sub spelllink {
     my ($form,$field)=@_;      my ($form,$field)=@_;
     my $linktext=&mt('Check Spelling');      my $linktext=&mt('Check Spelling');
     return (<<ENDLINK);      return (<<ENDLINK);
 <a href="javascript:if (typeof(document.$form.onsubmit)!='undefined') { if (document.$form.onsubmit!=null) { document.$form.onsubmit();}};spellcheckerwindow();checkwin.document.forms.spellcheckform.text.value=this.document.forms.$form.$field.value;checkwin.document.forms.spellcheckform.submit();">$linktext</a>  <a href="javascript:if (typeof(document.$form.onsubmit)!='undefined') { if (document.$form.onsubmit!=null) { document.$form.onsubmit();}};spellcheckerwindow(this.document.forms.$form.$field.value);">$linktext</a>
 ENDLINK  ENDLINK
 }  }
   
 # ------------------------------------------------- Output headers for HTMLArea  # ------------------------------------------------- Output headers for CKEditor
   
 sub htmlareaheaders {  sub htmlareaheaders {
     if (&htmlareablocked()) { return ''; }   my $s="";
     unless (&htmlareabrowser()) { return ''; }   if (&htmlareabrowser()) {
     my $lang='en';   $s.=(<<ENDEDITOR);
     if (&mt('htmlarea_lang') ne 'htmlarea_lang') {  <script type="text/javascript" src="/ckeditor/ckeditor.js"></script>
  $lang=&mt('htmlarea_lang');  ENDEDITOR
     }   }
     return (<<ENDHEADERS);      $s.=(<<ENDJQUERY);
 <script type="text/javascript">  <script type="text/javascript" src="/adm/jQuery/js/jquery-1.6.2.min.js"></script>
 _editor_url='/htmlarea/';  <script type="text/javascript" src="/adm/jQuery/js/jquery-ui-1.8.16.custom.min.js"></script>
 _editor_lang='$lang';  <link rel="stylesheet" type="text/css" href="/adm/jQuery/css/smoothness/jquery-ui-1.8.16.custom.css" />
 </script>  ENDJQUERY
 <script type="text/javascript" src="/htmlarea/htmlarea.js"></script>   return $s;
 ENDHEADERS  
 }  
   
 # ------------------------------------------------- Activate additional buttons  
   
 sub htmlareaaddbuttons {  
     if (&htmlareablocked()) { return ''; }  
     unless (&htmlareabrowser()) { return ''; }  
     return (<<ENDADDBUTTON);  
     var config=new HTMLArea.Config();  
     config.registerButton('ed_math','LaTeX Inline',  
   '/htmlarea/images/ed_math.gif',false,  
     function(editor,id) {  
       editor.surroundHTML('&nbsp;<m>\$','\$</m>&nbsp;');  
     }  
   );  
     config.registerButton('ed_math_eqn','LaTeX Equation',  
   '/htmlarea/images/ed_math_eqn.gif',false,  
     function(editor,id) {  
       editor.surroundHTML(  
      '&nbsp;\\n<center><m>\\\\[','\\\\]</m></center>\\n&nbsp;');  
     }  
   );  
     config.toolbar.push(['ed_math','ed_math_eqn']);  
 ENDADDBUTTON  
 }  }
   
 # ----------------------------------------------------------------- Preferences  # ----------------------------------------------------------------- Preferences
   
 sub disablelink {  # ------------------------------------------------- lang to use in html editor
     my @fields=@_;  sub htmlarea_lang {
     if (defined($#fields)) {      my $lang='en';
  unless ($#fields>=0) { return ''; }      if (&mt('htmlarea_lang') ne 'htmlarea_lang') {
     }   $lang=&mt('htmlarea_lang');
     return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=off&returnurl=','<>&"').&Apache::lonnet::escape($ENV{'REQUEST_URI'}).'">'.&mt('Disable WYSIWYG Editor').'</a>';  
 }  
   
 sub enablelink {  
     my @fields=@_;  
     if (defined($#fields)) {  
  unless ($#fields>=0) { return ''; }  
     }      }
     return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=on&returnurl=','<>&"').&Apache::lonnet::escape($ENV{'REQUEST_URI'}).'">'.&mt('Enable WYSIWYG Editor').'</a>';      return $lang;
 }  }
   
 # ----------------------------------------- Script to activate only some fields  # ----------------------------------------- Script to activate only some fields
   
 sub htmlareaselectactive {  sub htmlareaselectactive {
     my @fields=@_;      my ($args) = @_; 
     unless (&htmlareabrowser()) { return ''; }      unless (&htmlareabrowser()) { return ''; }
     if (&htmlareablocked()) { return '<br />'.&enablelink(@fields); }      my $output='<script type="text/javascript" defer="defer">'."\n"
     my $output='<script type="text/javascript" defer="1">'.                .'// <![CDATA['."\n";
  &htmlareaaddbuttons();      my $lang = &htmlarea_lang();
     foreach(@fields) {      my $fullpage = 'false';
  $output.="\nHTMLArea.replace('$_',config);";      my ($dragmath_prefix,$dragmath_helpicon,$dragmath_whitespace);
       if (ref($args) eq 'HASH') {
           if (exists($args->{'lang'})) {
               if ($args->{'lang'} ne '') {
                   $lang = $args->{'lang'};
               }
           }
           if (exists($args->{'fullpage'})) { 
               if ($args->{'fullpage'} eq 'true') {
                   $fullpage = $args->{'fullpage'};
               }
           }
           if (exists($args->{'dragmath'})) {
               if ($args->{'dragmath'} ne '') {
                   $dragmath_prefix = $args->{'dragmath'};
                   $dragmath_helpicon=&Apache::loncommon::lonhttpdurl("/adm/help/help.png");
                   $dragmath_whitespace=&Apache::loncommon::lonhttpdurl("/adm/lonIcons/transparent1x1.gif");
               }
           }
       }
       $output.='
       
       function containsBlockHtml(id) {
    var re = $("#"+id).html().search(/(?:\&lt\;|\<)(br|h1|h2|h3|h4|h5|h6|p|ol|ul|table|pre|address|blockquote|center|div)[\s]*((?:[\/]*[\s]*(?:\&gt\;|\>)|(?:\&gt\;|\>)[\s\S]*(?:\&lt\;|\<)\/[\s]*\1[\s]*\(?:\&gt\;|\>))/im);
       return (re >= 0);
       }
       
       function startRichEditor(id) {
       CKEDITOR.replace(id, 
       {
       customConfig: "/ckeditor/loncapaconfig.js",
                           language : "'.$lang.'",
                           fullPage : '.$fullpage.',
       }
       );
       }
       
       function destroyRichEditor(id) {
       CKEDITOR.instances[id].destroy();
     }      }
     $output.="\nwindow.status='Activated Editfields';\n</script><br />".      
  &disablelink(@fields);      function editorHandler(event) {
       var rawid = $(this).attr("id");
       var id = new RegExp("LC_rt_(.*)").exec(rawid)[1];
       event.preventDefault();
       var rt_enabled  = $(this).hasClass("LC_enable_rt");
           if (rt_enabled) {
       startRichEditor(id);
    $("#LC_rt_"+id).html("<b>&laquo; Plain text</b>");
    $("#LC_rt_"+id).attr("title", "Disable rich text formatting and edit in plain text");
    $("#LC_rt_"+id).addClass("LC_disable_rt");
    $("#LC_rt_"+id).removeClass("LC_enable_rt");
       } else {
    destroyRichEditor(id);
    $("#LC_rt_"+id).html("<b>Rich formatting &raquo;</b>");
    $("#LC_rt_"+id).attr("title", "Enable rich text formatting (bold, italic, etc.)");
    $("#LC_rt_"+id).addClass("LC_enable_rt");
    $("#LC_rt_"+id).removeClass("LC_disable_rt");
    }';
       if ($dragmath_prefix ne '') {
           $output .= "\n                 var visible = '';
                                          if (rt_enabled) {
                                              visible = 'none';
                                          }
                                          editmath_visibility(id,visible);\n";
       }
       $output .= '
       }
       $(document).ready(function(){
    $(".LC_richAlwaysOn").each(function() {
    startRichEditor($(this).attr("id"));
    });
    $(".LC_richDetectHtml").each(function() {
    var id = $(this).attr("id");
                           var rt_enabled = containsBlockHtml(id);
    if(rt_enabled) {
    $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Disable rich text formatting and edit in plain text\" class=\"LC_disable_rt\"><b>&laquo; Plain text</b></a></div>");
    startRichEditor(id);
    $("#LC_rt_"+id).click(editorHandler);
    }
    else {
    $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Enable rich text formatting (bold, italic, etc.)\" class=\"LC_enable_rt\"><b>Rich formatting &raquo;</b></a></div>");
    $("#LC_rt_"+id).click(editorHandler);
    }';
       if ($dragmath_prefix ne '') {
           $output .= "\n                 var visible = '';
                                          if (rt_enabled) {
                                              visible = 'none';
                                          }
                                          editmath_visibility(id,visible);\n";
       }
       $output .= '
    });
    $(".LC_richDefaultOn").each(function() {
    var id = $(this).attr("id");
    $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Disable rich text formatting and edit in plain text\" class=\"LC_disable_rt\"><b>&laquo; Plain text</b></a></div>");
    startRichEditor(id);
    $("#LC_rt_"+id).click(editorHandler);
    });
    $(".LC_richDefaultOff").each(function() {
    var id = $(this).attr("id");
    $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Enable rich text formatting (bold, italic, etc.)\" class=\"LC_enable_rt\"><b>Rich formatting &raquo;</b></a></div>");
    $("#LC_rt_"+id).click(editorHandler);
    });
    });
   ';
       if ($dragmath_prefix ne '') {
           $output .= '
   
        function editmath_visibility(id,value) {
   
            if ((id == "") || (id == null)) {
                return;
            }
            var mathid = "'.$dragmath_prefix.'_"+id;
            mathele = document.getElementById(mathid);
            if (mathele == null) {
                return;
            }
            mathele.style.display = value;
            var mathhelpicon = "'.$dragmath_prefix.'helpicon'.'_"+id;
            mathhelpiconele = document.getElementById(mathhelpicon);
            if (mathhelpiconele == null) {
                return;
            }
            if (value == "none") {
                mathhelpiconele.src = "'.$dragmath_whitespace.'";
            } else {
                mathhelpiconele.src = "'.$dragmath_helpicon.'";
            }
        }
   ';
   
       }
       $output.="\nwindow.status='Activated Editfields';\n"
               .'// ]]>'."\n"
               .'</script>';
     return $output;      return $output;
 }  }
   
Line 1056  sub htmlareabrowser { Line 1424  sub htmlareabrowser {
     return 1;      return 1;
 }  }
   
   #
   # Should the "return to content" link be shown?
   #
   
   sub show_return_link {
   
       unless ($env{'request.course.id'}) { return 0; }
       if ($env{'request.noversionuri'}=~m{^/priv/} ||
           $env{'request.uri'}=~m{^/~}) { return 1; }
   
       if (($env{'request.noversionuri'} =~ m{^/adm/(viewclasslist|navmaps)($|\?)})
           || ($env{'request.noversionuri'} =~ m{^/adm/.*/aboutme($|\?)})) {
   
           return if ($env{'form.register'});
       }
       return (($env{'request.noversionuri'}=~m{^/(res|public)/} &&
                $env{'request.symb'} eq '')
               ||
               ($env{'request.noversionuri'}=~ m{^/cgi-bin/printout.pl})
               ||
               (($env{'request.noversionuri'}=~/^\/adm\//) &&
                ($env{'request.noversionuri'}!~/^\/adm\/wrapper\//) &&
                ($env{'request.noversionuri'}!~
                 m{^/adm/.*/(smppg|bulletinboard)($|\?)})
              ));
   }
   
   
 ############################################################  ############################################################
 ############################################################  ############################################################
   
Line 1064  sub htmlareabrowser { Line 1460  sub htmlareabrowser {
 =item breadcrumbs  =item breadcrumbs
   
 Compiles the previously registered breadcrumbs into an series of links.  Compiles the previously registered breadcrumbs into an series of links.
 FAQ and BUG links will be placed on the left side of the table if they  
 are defined for the last registered breadcrumb.    
 Additionally supports a 'component', which will be displayed on the  Additionally supports a 'component', which will be displayed on the
 right side of the table (without a link).  right side of the breadcrumbs enclosing div (without a link).
 A link to help for the component will be included if one is specified.  A link to help for the component will be included if one is specified.
   
 All inputs can be undef without problems.  All inputs can be undef without problems.
   
 Inputs: $color (the background color of the table returned),  Inputs: $component (the text on the right side of the breadcrumbs trail),
         $component (the large text on the right side of the table),  
         $component_help          $component_help
         $function (role to get colors from)  
         $domain   (domian of role)  
         $menulink (boolean, controls whether to include a link to /adm/menu)          $menulink (boolean, controls whether to include a link to /adm/menu)
           $helplink (if 'nohelp' don't include the orange help link)
           $css_class (optional name for the class to apply to the table for CSS)
           $no_mt (optional flag, 1 if &mt() is _not_ to be applied to $component
              when including the text on the right.
 Returns a string containing breadcrumbs for the current page.  Returns a string containing breadcrumbs for the current page.
   
 =item clear_breadcrumbs  =item clear_breadcrumbs
Line 1091  Pushes a breadcrumb on the stack of crum Line 1485  Pushes a breadcrumb on the stack of crum
   
 input: $breadcrumb, a hash reference.  The keys 'href','title', and 'text'  input: $breadcrumb, a hash reference.  The keys 'href','title', and 'text'
 are required.  If present the keys 'faq' and 'bug' will be used to provide  are required.  If present the keys 'faq' and 'bug' will be used to provide
 links to the FAQ and bug sites.  links to the FAQ and bug sites. If the key 'no_mt' is present the 'title' 
   and 'text' values won't be sent through &mt()
   
 returns: nothing      returns: nothing    
   
Line 1101  returns: nothing Line 1496  returns: nothing
 ############################################################  ############################################################
 {  {
     my @Crumbs;      my @Crumbs;
       my %tools = ();
           
     sub breadcrumbs {      sub breadcrumbs {
         my ($color,$component,$component_help,$function,$domain,$menulink,          my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt, $CourseBreadcrumbs) = @_;
     $helplink) = @_;  
         if (! defined($color)) {  
             if (! defined($function)) {  
                 $function = &Apache::loncommon::get_users_function();  
             }  
             $color = &Apache::loncommon::designparm($function.'.tabbg',  
                                                     $domain);  
         }  
         #  
         my $Str = "\n".  
             '<table width="100%" border="0" cellpadding="0" cellspacing="0">'.  
             '<tr><td bgcolor="'.$color.'">'.  
             '<font size="-1">';  
         #          #
           $css_class ||= 'LC_breadcrumbs';
   
         # Make the faq and bug data cascade          # Make the faq and bug data cascade
         my $faq = '';          my $faq  = '';
         my $bug = '';          my $bug  = '';
  my $help='';          my $help = '';
           # Crumb Symbol
           my $crumbsymbol = '&raquo;';
         # The last breadcrumb does not have a link, so handle it separately.          # The last breadcrumb does not have a link, so handle it separately.
         my $last = pop(@Crumbs);          my $last = pop(@Crumbs);
         #          #
         # The first one should be the course or a menu link          # The first one should be the course or a menu link
  if (!defined($menulink)) { $menulink=1; }          if (!defined($menulink)) { $menulink=1; }
         if ($menulink) {          if ($menulink) {
             my $description = 'Menu';              my $description = 'Menu';
             if (exists($env{'request.course.id'}) &&               my $no_mt_descr = 0;
                 $env{'request.course.id'} ne '') {              if ((exists($env{'request.course.id'})) && 
                   ($env{'request.course.id'} ne '') && 
                   ($env{'course.'.$env{'request.course.id'}.'.description'} ne '')) {
                 $description =                   $description = 
                     $env{'course.'.$env{'request.course.id'}.'.description'};                      $env{'course.'.$env{'request.course.id'}.'.description'};
                   $no_mt_descr = 1;
             }              }
             unshift(@Crumbs,{              $menulink =  {  href   =>'/adm/menu',
                     href   =>'/adm/menu',                              title  =>'Go to main menu',
                     title  =>'Go to main menu',                              target =>'_top',
                     target =>'_top',                              text   =>$description,
                     text   =>$description,                              no_mt  =>$no_mt_descr, };
                 });              if($last) {
         }                  #$last set, so we have some crumbs
         my $links .=                   unshift(@Crumbs,$menulink);
             join('-&gt;',              } else {
                  map {                  #only menulink crumb present
                      $faq = $_->{'faq'} if (exists($_->{'faq'}));                  $last = $menulink;
                      $bug = $_->{'bug'} if (exists($_->{'bug'}));              }
                      $help = $_->{'help'} if (exists($_->{'help'}));          }
                      my $result = '<a href="'.$_->{'href'}.'" ';          my $links;
                      if (defined($_->{'target'}) && $_->{'target'} ne '') {          if ((&show_return_link) && (!$CourseBreadcrumbs)) {
                          $result .= 'target="'.$_->{'target'}.'" ';             $links=&htmltag( 'a',"<img src='/res/adm/pages/reload.png' border='0' style='vertical-align:middle;' />",
                      }                              { href => '/adm/flip?postdata=return:',
                      $result .='title="'.&mt($_->{'title'}).'">'.                                title => &mt("Back to most recent content resource") });
                          &mt($_->{'text'}).'</a>';          }
                      $result;          $links.= join "", 
                      } @Crumbs               map {
                  );                   $faq  = $_->{'faq'}  if (exists($_->{'faq'}));
         $links .= '-&gt;' if ($links ne '');                   $bug  = $_->{'bug'}  if (exists($_->{'bug'}));
         $links .= '<b>'.&mt($last->{'text'}).'</b>';                   $help = $_->{'help'} if (exists($_->{'help'}));
         #  
                    my $result = $_->{no_mt} ? $_->{text} : &mt($_->{text});
   
                    if ($_->{href}){
                        $result = &htmltag( 'a', $result, 
                          { href   => $_->{href},
                            title  => $_->{no_mt} ? $_->{title} : &mt($_->{title}),
                            target => $_->{target}, });
                    }
   
                    $result = &htmltag( 'li', "$result $crumbsymbol");
                } @Crumbs;
   
           #should the last Element be translated?
   
           my $lasttext = $last->{'no_mt'} ? $last->{'text'} 
                        : mt( $last->{'text'} );
   
           # last breadcrumb is the first order heading of a page
           # for course breadcrumbs it's just bold
           $links .= &htmltag( 'li', htmltag($CourseBreadcrumbs ? 'b' : 'h1',
                   $lasttext), {title => $lasttext});
   
         my $icons = '';          my $icons = '';
         $faq = $last->{'faq'} if (exists($last->{'faq'}));          $faq  = $last->{'faq'}  if (exists($last->{'faq'}));
         $bug = $last->{'bug'} if (exists($last->{'bug'}));          $bug  = $last->{'bug'}  if (exists($last->{'bug'}));
         $help = $last->{'help'} if (exists($last->{'help'}));          $help = $last->{'help'} if (exists($last->{'help'}));
         $component_help=($component_help?$component_help:$help);          $component_help=($component_help?$component_help:$help);
 #        if ($faq ne '') {  #        if ($faq ne '') {
Line 1170  returns: nothing Line 1582  returns: nothing
 #        if ($bug ne '') {  #        if ($bug ne '') {
 #            $icons .= &Apache::loncommon::help_open_bug($bug);  #            $icons .= &Apache::loncommon::help_open_bug($bug);
 #        }  #        }
  if ($helplink ne 'nohelp') {          if ($faq ne '' || $component_help ne '' || $bug ne '') {
     $icons .= &Apache::loncommon::help_open_menu($color,$component,$component_help,$function,$faq,$bug);              $icons .= &Apache::loncommon::help_open_menu($component,
  }                                                           $component_help,
         if ($icons ne '') {                                                           $faq,$bug);
             $Str .= $icons.'&nbsp;';  
         }          }
         #          #
         $Str .= $links.'</font></td>';  
         #  
         if (defined($component)) {          unless ($CourseBreadcrumbs) {
             $Str .= '<td align="right" bgcolor="'.$color.'">'.              $links = &htmltag('ol',  $links, { id => "LC_MenuBreadcrumbs"   });
                 '<font size="+1">'.&mt($component).'</font></td>';          } else {
               $links = &htmltag('ul',  $links, { class => "LC_CourseBreadcrumbs" });
         }          }
         $Str .= '</tr></table>'."\n";  
         #          if ($component) {
               $links = &htmltag('span', 
                                ( $no_mt ? $component : mt($component) ).
                                ( $icons ? $icons : '' ),
                                { class => 'LC_breadcrumbs_component' } )
                                .$links;
           }
           
           &render_tools(\$links);
           $links = &htmltag('div', $links, 
                           { id => "LC_breadcrumbs" }) unless ($CourseBreadcrumbs) ;
           &render_advtools(\$links);
   
         # Return the @Crumbs stack to what we started with          # Return the @Crumbs stack to what we started with
         push(@Crumbs,$last);          push(@Crumbs,$last);
         shift(@Crumbs);          shift(@Crumbs);
         #          # Return the breadcrumb's line
         return $Str;          return "$links";
     }      }
   
     sub clear_breadcrumbs {      sub clear_breadcrumbs {
         undef(@Crumbs);          undef(@Crumbs);
           undef(%tools);
     }      }
   
     sub add_breadcrumb {      sub add_breadcrumb {
         push (@Crumbs,@_);          push(@Crumbs,@_);
       }
       
   =item add_breadcrumb_tool($category, $html)
   
   Adds $html to $category of the breadcrumb toolbar container.
   
   $html is usually a link to a page that invokes a function on the currently 
   displayed data (e.g. print when viewing a problem)
   
   Currently there are 3 possible values for $category: 
   
   =over 
   
   =item navigation 
   left of breadcrumbs line
   
   =item tools 
   right of breadcrumbs line
   
   =item advtools 
   advanced tools shown in a separate box below breadcrumbs line 
   
   =back
    
   returns: nothing
   
   =cut
   
       sub add_breadcrumb_tool {
           my ($category, @html) = @_;
           return unless @html;
           if (!keys(%tools)) { 
               %tools = ( navigation => [], tools => [], advtools => []);
           }
   
           #this cleans data received from lonmenu::innerregister
           @html = grep {defined $_ && $_ ne ''} @html;
           for (@html) { 
               s/align="(right|left)"//; 
   #            s/<span.*?\/span>// if $category ne 'advtools'; 
           } 
   
           push @{$tools{$category}}, @html;
       }
   
   =item clear_breadcrumb_tools()
   
   Clears the breadcrumb toolbar container.
   
   returns: nothing
   
   =cut
   
       sub clear_breadcrumb_tools {
           undef(%tools);
       }
   
   =item render_tools(\$breadcrumbs)
   
   Creates html for breadcrumb tools (categories navigation and tools) and inserts 
   \$breadcrumbs at the correct position.
   
   input: \$breadcrumbs - a reference to the string containing prepared 
   breadcrumbs.
   
   returns: nothing
   =cut
   
   #TODO might split this in separate functions for each category
       sub render_tools {
           my ($breadcrumbs) = @_;
           return unless (keys(%tools));
   
           my $navigation = list_from_array($tools{navigation}, 
                      { listattr => { class=>"LC_breadcrumb_tools_navigation" } });
           my $tools = list_from_array($tools{tools}, 
                      { listattr => { class=>"LC_breadcrumb_tools_tools" } });
           $$breadcrumbs = list_from_array([$navigation, $tools, $$breadcrumbs], 
                      { listattr => { class=>'LC_breadcrumb_tools_outerlist' } });
       }
   
   =item render_advtools(\$breadcrumbs)
   
   Creates html for advanced tools (category advtools) and inserts \$breadcrumbs 
   at the correct position.
   
   input: \$breadcrumbs - a reference to the string containing prepared 
   breadcrumbs (after render_tools call).
   
   returns: nothing
   =cut
   
       sub render_advtools {
           my ($breadcrumbs) = @_;
           return unless     (defined $tools{'advtools'}) 
                         and (scalar(@{$tools{'advtools'}}) > 0);
   
           $$breadcrumbs .= Apache::loncommon::head_subbox(
                               funclist_from_array($tools{'advtools'}) );
     }      }
   
 } # End of scope for @Crumbs  } # End of scope for @Crumbs
Line 1205  returns: nothing Line 1729  returns: nothing
 ############################################################  ############################################################
 ############################################################  ############################################################
   
   # Nested table routines.
   #
   # Routines to display form items in a multi-row table with 2 columns.
   # Uses nested tables to divide form elements into segments.
   # For examples of use see loncom/interface/lonnotify.pm 
   #
   # Can be used in following order: ...
   # &start_pick_box()
   # row1
   # row2
   # row3   ... etc.
   # &submit_row()
   # &end_pick_box()
   #
   # where row1, row 2 etc. are chosen from &role_select_row,&course_select_row,
   # &status_select_row and &email_default_row
   #
   # Can also be used in following order:
   #
   # &start_pick_box()
   # &row_title()
   # &row_closure()
   # &row_title()
   # &row_closure()  ... etc.
   # &submit_row()
   # &end_pick_box()
   #
   # In general a &submit_row() call should proceed the call to &end_pick_box(),
   # as this routine adds a button for form submission.
   # &submit_row() does not require a &row_closure after it.
   #  
   # &start_pick_box() creates a bounding table with 1-pixel wide black border.
   # rows should be placed between calls to &start_pick_box() and &end_pick_box.
   #
   # &row_title() adds a title in the left column for each segment.
   # &row_closure() closes a row with a 1-pixel wide black line.
   #
   # &role_select_row() provides a select box from which to choose 1 or more roles 
   # &course_select_row provides ways of picking groups of courses
   #    radio buttons: all, by category or by picking from a course picker pop-up
   #      note: by category option is only displayed if a domain has implemented 
   #                selection by year, semester, department, number etc.
   #
   # &status_select_row() provides a select box from which to choose 1 or more
   #  access types (current access, prior access, and future access)  
   #
   # &email_default_row() provides text boxes for default e-mail suffixes for
   #  different authentication types in a domain.
   #
   # &row_title() and &row_closure() are called internally by the &*_select_row
   # routines, but can also be called directly to start and end rows which have 
   # needs that are not accommodated by the *_select_row() routines.    
   
   { # Start: row_count block for pick_box
   my @row_count;
   
   sub start_pick_box {
       my ($css_class) = @_;
       if (defined($css_class)) {
    $css_class = 'class="'.$css_class.'"';
       } else {
    $css_class= 'class="LC_pick_box"';
       }
       unshift(@row_count,0);
       my $output = <<"END";
    <table $css_class>
   END
       return $output;
   }
   
   sub end_pick_box {
       shift(@row_count);
       my $output = <<"END";
          </table>
   END
       return $output;
   }
   
   sub row_headline {
       my $output = <<"END";
              <tr><td colspan="2">
   END
       return $output;
   }
   
   sub row_title {
       my ($title,$css_title_class,$css_value_class, $css_value_furtherAttributes) = @_;
       $row_count[0]++;
       my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
       $css_title_class ||= 'LC_pick_box_title';
       $css_title_class = 'class="'.$css_title_class.'"';
   
       $css_value_class ||= 'LC_pick_box_value';
   
       if ($title ne '') {
           $title .= ':';
       }
       my $output = <<"ENDONE";
              <tr class="LC_pick_box_row" $css_value_furtherAttributes> 
               <td $css_title_class>
          $title
               </td>
               <td class="$css_value_class $css_class">
   ENDONE
       return $output;
   }
   
   sub row_closure {
       my ($no_separator) =@_;
       my $output = <<"ENDTWO";
               </td>
              </tr>
   ENDTWO
       if (!$no_separator) {
           $output .= <<"ENDTWO";
              <tr>
               <td colspan="2" class="LC_pick_box_separator">
               </td>
              </tr>
   ENDTWO
       }
       return $output;
   }
   
   } # End: row_count block for pick_box
   
   sub role_select_row {
       my ($roles,$title,$css_class,$show_separate_custom,$cdom,$cnum) = @_;
       my $crstype = 'Course';
       if ($cdom ne '' && $cnum ne '') {
           $crstype = &Apache::loncommon::course_type($cdom.'_'.$cnum);
       }
       my $output;
       if (defined($title)) {
           $output = &row_title($title,$css_class);
       }
       $output .= qq|
                                     <select name="roles" multiple="multiple">\n|;
       foreach my $role (@$roles) {
           my $plrole;
           if ($role eq 'ow') {
               $plrole = &mt('Course Owner');
           } elsif ($role eq 'cr') {
               if ($show_separate_custom) {
                   if ($cdom ne '' && $cnum ne '') {
                       my %course_customroles = &course_custom_roles($cdom,$cnum);
                       foreach my $crrole (sort(keys(%course_customroles))) {
                           my ($plcrrole) = ($crrole =~ m|^cr/[^/]+/[^/]+/(.+)$|);
                           $output .= '  <option value="'.$crrole.'">'.$plcrrole.
                                      '</option>';
                       }
                   }
               } else {
                   $plrole = &mt('Custom Role');
               }
           } else {
               $plrole=&Apache::lonnet::plaintext($role,$crstype);
           }
           if (($role ne 'cr') || (!$show_separate_custom)) {
               $output .= '  <option value="'.$role.'">'.$plrole.'</option>';
           }
       }
       $output .= qq|                </select>\n|;
       if (defined($title)) {
           $output .= &row_closure();
       }
       return $output;
   }
   
   sub course_select_row {
       my ($title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles,
    $css_class,$crstype,$standardnames) = @_;
       my $output = &row_title($title,$css_class);
       $output .= &course_selection($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype,$standardnames);
       $output .= &row_closure();
       return $output;
   }
   
   sub course_selection {
       my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype,$standardnames) = @_;
       my $output = qq|
   <script type="text/javascript">
   // <![CDATA[
       function coursePick (formname) {
           for  (var i=0; i<formname.coursepick.length; i++) {
               if (formname.coursepick[i].value == 'category') {
                   courseSet('');
               }
               if (!formname.coursepick[i].checked) {
                   if (formname.coursepick[i].value == 'specific') {
                       formname.coursetotal.value = 0;
                       formname.courselist = '';
                   }
               }
           }
       }
       function setPick (formname) {
           for  (var i=0; i<formname.coursepick.length; i++) {
               if (formname.coursepick[i].value == 'category') {
                   formname.coursepick[i].checked = true;
               }
               formname.coursetotal.value = 0;
               formname.courselist = '';
           }
       }
   // ]]>
   </script>
       |;
   
       my ($allcrs,$pickspec);
       if ($crstype eq 'Community') {
           $allcrs = &mt('All communities');
           $pickspec = &mt('Pick specific communities:');
       } else {
           $allcrs = &mt('All courses');
           $pickspec = &mt('Pick specific course(s):');
       }
   
       my $courseform='<b>'.&Apache::loncommon::selectcourse_link
                        ($formname,'pickcourse','pickdomain','coursedesc','',1,$crstype).'</b>';
           $output .= '<input type="radio" name="coursepick" value="all" onclick="coursePick(this.form)" />'.$allcrs.'<br />';
       if ($totcodes > 0) {
           my $numtitles = @$codetitles;
           if ($numtitles > 0) {
               $output .= '<input type="radio" name="coursepick" value="category" onclick="coursePick(this.form);alert('."'".&mt('Choose categories, from left to right')."'".')" />'.&mt('Pick courses by category:').' <br />';
               $output .= '<table><tr><td>'.$$codetitles[0].'<br />'."\n".
                  '<select name="'.$standardnames->[0].
                  '" onChange="setPick(this.form);courseSet('."'$$codetitles[0]'".')">'."\n".
                  ' <option value="-1" />Select'."\n";
               my @items = ();
               my @longitems = ();
               if ($$idlist{$$codetitles[0]} =~ /","/) {
                   @items = split(/","/,$$idlist{$$codetitles[0]});
               } else {
                   $items[0] = $$idlist{$$codetitles[0]};
               }
               if (defined($$idlist_titles{$$codetitles[0]})) {
                   if ($$idlist_titles{$$codetitles[0]} =~ /","/) {
                       @longitems = split(/","/,$$idlist_titles{$$codetitles[0]});
                   } else {
                       $longitems[0] = $$idlist_titles{$$codetitles[0]};
                   }
                   for (my $i=0; $i<@longitems; $i++) {
                       if ($longitems[$i] eq '') {
                           $longitems[$i] = $items[$i];
                       }
                   }
               } else {
                   @longitems = @items;
               }
               for (my $i=0; $i<@items; $i++) {
                   $output .= ' <option value="'.$items[$i].'">'.$longitems[$i].'</option>';
               }
               $output .= '</select></td>';
               for (my $i=1; $i<$numtitles; $i++) {
                   $output .= '<td>'.$$codetitles[$i].'<br />'."\n".
                             '<select name="'.$standardnames->[$i].
                             '" onChange="courseSet('."'$$codetitles[$i]'".')">'."\n".
                             '<option value="-1">&lt;-Pick '.$$codetitles[$i-1].'</option>'."\n".
                             '</select>'."\n".
                             '</td>';
               }
               $output .= '</tr></table><br />';
           }
       }
       $output .= '<input type="radio" name="coursepick" value="specific" onclick="coursePick(this.form);opencrsbrowser('."'".$formname."','dccourse','dcdomain','coursedesc','','1','$crstype'".')" />'.$pickspec.' '.$courseform.'&nbsp;&nbsp;<input type="text" value="0" size="4" name="coursetotal" /><input type="hidden" name="courselist" value="" />selected.<br />'."\n";
       return $output;
   }
   
   sub status_select_row {
       my ($types,$title,$css_class) = @_;
       my $output; 
       if (defined($title)) {
           $output = &row_title($title,$css_class,'LC_pick_box_select');
       }
       $output .= qq|
                                       <select name="types" multiple="multiple">\n|;
       foreach my $status_type (sort(keys(%{$types}))) {
           $output .= '  <option value="'.$status_type.'">'.$$types{$status_type}.'</option>';
       }
       $output .= qq|                   </select>\n|; 
       if (defined($title)) {
           $output .= &row_closure();
       }
       return $output;
   }
   
   sub email_default_row {
       my ($authtypes,$title,$descrip,$css_class) = @_;
       my $output = &row_title($title,$css_class);
       $output .= $descrip.
    &Apache::loncommon::start_data_table().
    &Apache::loncommon::start_data_table_header_row().
    '<th>'.&mt('Authentication Method').'</th>'.
    '<th align="right">'.&mt('Username -> e-mail conversion').'</th>'."\n".
    &Apache::loncommon::end_data_table_header_row();
       my $rownum = 0;
       foreach my $auth (sort(keys(%{$authtypes}))) {
           my ($userentry,$size);
           if ($auth =~ /^krb/) {
               $userentry = '';
               $size = 25;
           } else {
               $userentry = 'username@';
               $size = 15;
           }
           $output .= &Apache::loncommon::start_data_table_row().
       '<td>  '.$$authtypes{$auth}.'</td>'.
       '<td align="right">'.$userentry.
       '<input type="text" name="'.$auth.'" size="'.$size.'" /></td>'.
       &Apache::loncommon::end_data_table_row();
       }
       $output .= &Apache::loncommon::end_data_table();
       $output .= &row_closure();
       return $output;
   }
   
   
   sub submit_row {
       my ($title,$cmd,$submit_text,$css_class) = @_;
       my $output = &row_title($title,$css_class,'LC_pick_box_submit');
       $output .= qq|
                <br />
                <input type="hidden" name="command" value="$cmd" />
                <input type="submit" value="$submit_text"/> &nbsp;
                <br /><br />
               \n|;
       return $output;
   }
   
   sub course_custom_roles {
       my ($cdom,$cnum) = @_;
       my %returnhash=();
       my %coursepersonnel=&Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
       foreach my $person (sort(keys(%coursepersonnel))) {
           my ($role) = ($person =~ /^([^:]+):/);
           my ($end,$start) = split(/:/,$coursepersonnel{$person});
           if ($end == -1 && $start == -1) {
               next;
           }
           if ($role =~ m|^cr/[^/]+/[^/]+/[^/]|) {
               $returnhash{$role} ++;
           }
       }
       return %returnhash;
   }
   
   
   sub resource_info_box {
      my ($symb,$onlyfolderflag)=@_;
      my $return='';
      if ($symb) {
          $return=&Apache::loncommon::start_data_table();
          my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb);
          my $folder=&Apache::lonnet::gettitle($map);
          $return.=&Apache::loncommon::start_data_table_row().
                       '<th>'.&mt('Folder:').'</th><td>'.$folder.'</td>'.
                       &Apache::loncommon::end_data_table_row();
          unless ($onlyfolderflag) {
             $return.=&Apache::loncommon::start_data_table_row().
                       '<th>'.&mt('Resource:').'</th><td>'.&Apache::lonnet::gettitle($symb).'</td>'.
                       &Apache::loncommon::end_data_table_row();
          }
          $return.=&Apache::loncommon::end_data_table();
       } else {
          $return='<p><span class="LC_error">'.&mt('No context provided.').'</span></p>';
       }
       return $return;
   
   }
   
   ##############################################
   ##############################################
   
   # topic_bar
   #
   # Generates a div containing an (optional) number with a white background followed by a 
   # title with a background color defined in the corresponding CSS: LC_topic_bar
   # Inputs:
   # 1. number to display.
   #    If input for number is empty only the title will be displayed. 
   # 2. title text to display.
   # Outputs - a scalar containing html mark-up for the div.
   
   sub topic_bar {
       my ($num,$title) = @_;
       my $number = '';
       if ($num ne '') {
           $number = '<span>'.$num.'</span>';
       }
       return '<div class="LC_topic_bar">'.$number.$title.'</div>';
   }
   
   ##############################################
   ##############################################
   # echo_form_input
   #
   # Generates html markup to add form elements from the referrer page
   # as hidden form elements (values encoded) in the new page.
   #
   # Intended to support two types of use 
   # (a) to allow backing up to earlier pages in a multi-page 
   # form submission process using a breadcrumb trail.
   #
   # (b) to allow the current page to be reloaded with form elements
   # set on previous page to remain unchanged.  An example would
   # be where the a page containing a dynamically-built table of data is 
   # is to be redisplayed, with only the sort order of the data changed. 
   #  
   # Inputs:
   # 1. Reference to array of form elements in the submitted form on 
   # the referrer page which are to be excluded from the echoed elements.
   #
   # 2. Reference to array of regular expressions, which if matched in the  
   # name of the form element n the referrer page will be omitted from echo. 
   #
   # Outputs: A scalar containing the html markup for the echoed form
   # elements (all as hidden elements, with values encoded). 
   
   
   sub echo_form_input {
       my ($excluded,$regexps) = @_;
       my $output = '';
       foreach my $key (keys(%env)) {
           if ($key =~ /^form\.(.+)$/) {
               my $name = $1;
               my $match = 0;
               if (ref($excluded) eq 'ARRAY') {    
                   next if (grep(/^\Q$name\E$/,@{$excluded}));
               }
               if (ref($regexps) eq 'ARRAY') {
                   if (@{$regexps} > 0) {
                       foreach my $regexp (@{$regexps}) {
                           if ($name =~ /$regexp/) {
                               $match = 1;
                               last;
                           }
                       }
                   }
               }
               next if ($match);
               if (ref($env{$key}) eq 'ARRAY') {
                   foreach my $value (@{$env{$key}}) {
                       $value = &HTML::Entities::encode($value,'<>&"');
                       $output .= '<input type="hidden" name="'.$name.
                                  '" value="'.$value.'" />'."\n";
                   }
               } else {
                   my $value = &HTML::Entities::encode($env{$key},'<>&"');
                   $output .= '<input type="hidden" name="'.$name.
                              '" value="'.$value.'" />'."\n";
               }
           }
       }
       return $output;
   }
   
   ##############################################
   ##############################################
   # set_form_elements
   #
   # Generates javascript to set form elements to values based on
   # corresponding values for the same form elements when the page was
   # previously submitted.
   #     
   # Last submission values are read from hidden form elements in referring 
   # page which have the same name, i.e., generated by &echo_form_input(). 
   #
   # Intended to be called by onload event.
   #
   # Inputs:
   # (a) Reference to hash of echoed form elements to be set.
   #
   # In the hash, keys are the form element names, and the values are the
   # element type (selectbox, radio, checkbox or text -for textbox, textarea or
   # hidden).
   #
   # (b) Optional reference to hash of stored elements to be set.
   #
   # If the page being displayed is a page which permits modification of
   # previously stored data, e.g., the first page in a multi-page submission,
   # then if stored is supplied, form elements will be set to the last stored
   # values.  If user supplied values are also available for the same elements
   # these will replace the stored values. 
   #        
   # Output:
   #  
   # javascript function - set_form_elements() which sets form elements,
   # expects an argument: formname - the name of the form according to 
   # the DOM, e.g., document.compose
   
   sub set_form_elements {
       my ($elements,$stored) = @_;
       my %values;
       my $output .= 'function setFormElements(courseForm) {
   ';
       if (defined($stored)) {
           foreach my $name (keys(%{$stored})) {
               if (exists($$elements{$name})) {
                   if (ref($$stored{$name}) eq 'ARRAY') {
                       $values{$name} = $$stored{$name};
                   } else {
                       @{$values{$name}} = ($$stored{$name});
                   }
               }
           }
       }
   
       foreach my $key (keys(%env)) {
           if ($key =~ /^form\.(.+)$/) {
               my $name = $1;
               if (exists($$elements{$name})) {
                   @{$values{$name}} = &Apache::loncommon::get_env_multiple($key);
               }
           }
       }
   
       foreach my $name (keys(%values)) {
           for (my $i=0; $i<@{$values{$name}}; $i++) {
               $values{$name}[$i] = &HTML::Entities::decode($values{$name}[$i],'<>&"');
               $values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g;
               $values{$name}[$i] =~ s/"/\\"/g;
           }
           if (($$elements{$name} eq 'text') || ($$elements{$name} eq 'hidden')) {
               my $numvalues = @{$values{$name}};
               if ($numvalues > 1) {
                   my $valuestring = join('","',@{$values{$name}});
                   $output .= qq|
     var textvalues = new Array ("$valuestring");
     var total = courseForm.elements['$name'].length;
     if (total > $numvalues) {
         total = $numvalues;
     }    
     for (var i=0; i<total; i++) {
         courseForm.elements['$name']\[i].value = textvalues[i];
     }
   |;
               } else {
                   $output .= qq|
     courseForm.elements['$name'].value = "$values{$name}[0]";
   |;
               }
           } else {
               $output .=  qq|
     var elementLength = courseForm.elements['$name'].length;
     if (elementLength==undefined) {
   |;
               foreach my $value (@{$values{$name}}) {
                   if ($$elements{$name} eq 'selectbox') {
                       $output .=  qq|
         if (courseForm.elements['$name'].options[0].value == "$value") {
             courseForm.elements['$name'].options[0].selected = true;
         }|;
                   } elsif (($$elements{$name} eq 'radio') ||
                            ($$elements{$name} eq 'checkbox')) {
                       $output .= qq|
         if (courseForm.elements['$name'].value == "$value") {
             courseForm.elements['$name'].checked = true;
         } else {
             courseForm.elements['$name'].checked = false;
         }|;
                   }
               }
               $output .= qq|
     }
     else {
         for (var i=0; i<courseForm.elements['$name'].length; i++) {
   |;
               if ($$elements{$name} eq 'selectbox') {
                   $output .=  qq|
             courseForm.elements['$name'].options[i].selected = false;|;
               } elsif (($$elements{$name} eq 'radio') || 
                        ($$elements{$name} eq 'checkbox')) {
                   $output .= qq|
             courseForm.elements['$name']\[i].checked = false;|; 
               }
               $output .= qq|
         }
         for (var j=0; j<courseForm.elements['$name'].length; j++) {
   |;
               foreach my $value (@{$values{$name}}) {
                   if ($$elements{$name} eq 'selectbox') {
                       $output .=  qq|
             if (courseForm.elements['$name'].options[j].value == "$value") {
                 courseForm.elements['$name'].options[j].selected = true;
             }|;
                   } elsif (($$elements{$name} eq 'radio') ||
                            ($$elements{$name} eq 'checkbox')) { 
                         $output .= qq|
             if (courseForm.elements['$name']\[j].value == "$value") {
                 courseForm.elements['$name']\[j].checked = true;
             }|;
                   }
               }
               $output .= qq|
         }
     }
   |;
           }
       }
       $output .= "
       return;
   }\n";
       return $output;
   }
   
   ##############################################
   ##############################################
   
   sub file_submissionchk_js {
       my ($turninpaths,$multiples) = @_;
       my $overwritewarn = &mt('File(s) you uploaded for your submission will overwrite existing file(s) submitted for this item').'\\n'.
                         &mt('Continue submission and overwrite the file(s)?');
       my $delfilewarn = &mt('You have indicated you wish to remove some files previously included in your submission.').'\\n'.
                         &mt('Continue submission with these files removed?');
       my ($turninpathtext,$multtext,$arrayindexofjs);
       if (ref($turninpaths) eq 'HASH') {
           foreach my $key (sort(keys(%{$turninpaths}))) {
               $turninpathtext .= "    if (prefix == '$key') {\n".
                                  "        return '$turninpaths->{$key}';\n".
                                  "    }\n";
           }
       }
       $turninpathtext .= "    return '';\n";
       if (ref($multiples) eq 'HASH') {
           foreach my $key (sort(keys(%{$multiples}))) {
               $multtext .= "    if (prefix == '$key') {\n".
                            "        return '$multiples->{$key}';\n".
                            "    }\n";
           }
       }
       $multtext .= "    return '';\n";
   
       $arrayindexofjs = &Apache::loncommon::javascript_array_indexof();
       return <<"ENDSCRIPT";
   <script type="text/javascript">
   // <![CDATA[
   
   function file_submission_check(formname,path,multiresp) {
       var elemnum = formname.elements.length;
       if (elemnum == 0) {
           return true;
       }
       var alloverwrites = [];
       var alldelconfirm = [];
       var result = [];
       var submitter;
       var subprefix;
       var allsub = getIndexByName(formname,'all_submit');
       if (allsub == -1) {
           var idx = getIndexByName(formname,'submitted');
           if (idx != -1) {
               var subval = String(formname.elements[idx].value);
               submitter = subval.replace(/^part_/,'');
               result = overwritten_check(formname,path,multiresp,submitter);
               alloverwrites.push.apply(alloverwrites,result['overwrite']);
               alldelconfirm.push.apply(alldelconfirm,result['delete']);
           }
       } else {
           if (formname.elements[allsub].type == 'submit') {
               var partsub = /^\\d+\\.\\d+_submit_.+\$/;
               var allprefixes = [];
               var allparts = [];
               for (var i=0; i<formname.elements.length; i++) {
                   if (formname.elements[i].type == 'submit') {
                       var elemname = formname.elements[i].name;
                       var subname = String(elemname);
                       var savesub = String(elemname);
                       if (partsub.test(subname)) {
                           var prefix = subname.replace(/_submit_.+\$/,'');
                           if (allprefixes.indexOf(prefix) == -1) {
                               allprefixes.push(prefix);
                               allparts[prefix] = [];
                           }
                           var part = savesub.replace(/^\\d+\\.\\d+_submit_/,'');
                           allparts[prefix].push(part);
                       }
                   }
               }
               for (var k=0; k<allprefixes.length; k++) {
                   var idx = getIndexByName(formname,allprefixes[k]+'_submitted');
                   if (idx > -1) {
                       if (formname.elements[idx].value != 'yes') {
                           submitterval = formname.elements[idx].value;
                           submitter = submitterval.replace(/^part_/,'');
                           subprefix = allprefixes[k];
                           result = overwritten_check(formname,path,multiresp,submitter,subprefix);
                           alloverwrites.push.apply(alloverwrites,result['overwrite']);
                           alldelconfirm.push.apply(alldelconfirm,result['delete']);
                           break;
                       }
                   }
               }
               if (submitter == '' || submitter == undefined) {
                   for (var m=0; m<allprefixes.length; m++) {
                       for (var n=0; n<allparts[allprefixes[m]].length; n++) {
                           var result = overwritten_check(formname,path,multiresp,allparts[allprefixes[m]][n],allprefixes[m]);
                           alloverwrites.push.apply(alloverwrites,result['overwrite']);
                           alldelconfirm.push.apply(alldelconfirm,result['delete']);
                       }
                   }
               }
           }
       }
       if (alloverwrites.length > 0) {
           if (!confirm("$overwritewarn")) {
               for (var n=0; n<alloverwrites.length; n++) {
                   formname.elements[alloverwrites[n]].value = "";
               }
               return false;
           }
       }
       if (alldelconfirm.length > 0) {
           if (!confirm("$delfilewarn")) {
               for (var p=0; p<alldelconfirm.length; p++) {
                   formname.elements[alldelconfirm[p]].checked = false;
               }
               return false;
           }
       }
       return true;
   }
   
   function getIndexByName(formname,item) {
       for (var i=0;i<formname.elements.length;i++) {
           if (formname.elements[i].name == item) {
               return i;
           }
       }
       return -1;
   }
   
   function overwritten_check(formname,path,multiresp,part,prefix) {
       var result = [];
       result['overwrite'] = [];
       result['delete'] = [];
       var elemnum = formname.elements.length;
       if (elemnum == 0) {
           return result;
       }
       var uploadstr;
       var deletestr;
       if ((prefix != undefined) && (prefix != '')) {
           var prepend = prefix+'_';
           uploadstr = new RegExp("^"+prepend+"HWFILE"+part+".+\$");
           deletestr = new RegExp("^"+prepend+"HWFILE"+part+".+_\\\\d+_delete\$");
           multiresp = check_for_multiples(prepend);
           path = check_for_turninpath(prepend);
       } else {
           uploadstr = new RegExp("^HWFILE"+part+".+\$");
           deletestr = new RegExp("^HWFILE"+part+".+_\\\\d+_delete\$");
       }
       var alluploads = [];
       var allchecked = [];
       var allskipdel = [];
       var fnametrim = /[^\\/\\\\]+\$/;
       for (var i=0; i<formname.elements.length; i++) {
           var id = formname.elements[i].id;
           if (id != '') {
               if (uploadstr.test(id)) {
                   if (formname.elements[i].type == 'file') {
                       alluploads.push(id);
                   } else {
                       if (deletestr.test(id)) {
                           if (formname.elements[i].type == 'checkbox') {
                               if (formname.elements[i].checked) {
                                   allchecked.push(id);
                               }
                           }
                       }
                   }
               }
           }
       }
       for (var j=0; j<alluploads.length; j++) {
           var delstr = new RegExp("^"+alluploads[j]+"_\\\\d+_delete\$");
           var delboxes = [];
           for (var k=0; k<formname.elements.length; k++) {
               var id = formname.elements[k].id;
               if ((id != '') && (id != undefined)) {
                   if (delstr.test(id)) {
                       if (formname.elements[k].type == 'checkbox') {
                           delboxes.push(id);
                       }
                   }
               }
           }
           if (delboxes.length > 0) {
               if ((formname.elements[alluploads[j]].value != undefined) &&
                   (formname.elements[alluploads[j]].value != '')) {
                   var filepath = formname.elements[alluploads[j]].value;
                   var newfilename = fnametrim.exec(filepath);
                   if (newfilename != null) {
                       var filename = String(newfilename);
                       var nospaces = filename.replace(/\\s+/g,'_');
                       var nospecials = nospaces.replace(/[^\\/\\w\\.\\-]/g,'');
                       var cleanfilename = nospecials.replace(/\\.(\\d+\\.)/g,"_\$1");
                       if (cleanfilename != '') {
                           var fullpath = path+"/"+cleanfilename;
                           if (multiresp == 1) {
                               var partid = String(alluploads[i]);
                               var subdir = partid.replace(/^\\d*.?\\d*_?HWFILE/,'');
                               if (subdir != "" && subdir != undefined) {
                                   fullpath = path+"/"+subdir+"/"+cleanfilename;
                               }
                           }
                           for (var m=0; m<delboxes.length; m++) {
                               if (fullpath == formname.elements[delboxes[m]].value) {
                                   if (formname.elements[delboxes[m]].checked) {
                                       allskipdel.push(delboxes[m]);
                                   } else {
                                       result['overwrite'].push(alluploads[j]);
                                   }
                                   break;
                               }
                           }
                       }
                   }
               }
           }
       }
       if (allchecked.length > 0) {
           if (allskipdel.length > 0) {
               for (var n=0; n<allchecked.length; n++) {
                   if (allskipdel.indexOf(allchecked[n]) == -1) {
                       result['delete'].push(allchecked[n]);
                   }
               }
           } else {
               result['delete'].push.apply(result['delete'],allchecked);
           }
       }
       return result;
   }
   
   function check_for_multiples(prefix) {
   $multtext
   }
   
   function check_for_turninpath(prefix) {
   $turninpathtext
   }
   
   // ]]>
   </script>
   
   $arrayindexofjs
   
   ENDSCRIPT
   }
   
   ##############################################
   ##############################################
   
   # javascript_valid_email
   #
   # Generates javascript to validate an e-mail address.
   # Returns a javascript function which accetps a form field as argumnent, and
   # returns false if field.value does not satisfy two regular expression matches
   # for a valid e-mail address.  Backwards compatible with old browsers without
   # support for javascript RegExp (just checks for @ in field.value in this case). 
   
   sub javascript_valid_email {
       my $scripttag .= <<'END';
   function validmail(field) {
       var str = field.value;
       if (window.RegExp) {
           var reg1str = "(@.*@)|(\\.\\.)|(@\\.)|(\\.@)|(^\\.)";
           var reg2str = "^.+\\@(\\[?)[a-zA-Z0-9\\-\\.]+\\.([a-zA-Z]{2,3}|[0-9]{1,3})(\\]?)$"; //"
           var reg1 = new RegExp(reg1str);
           var reg2 = new RegExp(reg2str);
           if (!reg1.test(str) && reg2.test(str)) {
               return true;
           }
           return false;
       }
       else
       {
           if(str.indexOf("@") >= 0) {
               return true;
           }
           return false;
       }
   }
   END
       return $scripttag;
   }
   
   
   # USAGE: htmltag(element, content, {attribute => value,...});
   #
   # EXAMPLES: 
   #  - htmltag('a', 'this is an anchor', {href  => 'www.example.com', 
   #                                       title => 'this is a title'})
   #
   #  - You might want to set up needed tags like: 
   #
   #     my $h3  = sub { return htmltag( "h3",  @_ ) };
   #
   #    ... and use them: $h3->("This is a headline")
   #
   #  - To set up a couple of tags, see sub inittags
   #
   # NOTES:
   # - Empty elements, such as <br/> are correctly terminated, 
   #   i.e. htmltag('br') returns <br/> 
   # - Empty attributes (title="") are filtered out.
   # - The function will not check for deprecated attributes.
   #
   # OUTPUT: content enclosed in xhtml conform tags
   sub htmltag{
       return
           qq|<$_[0]|
           . join( '', map { qq| $_="${$_[2]}{$_}"| if ${$_[2]}{$_} } keys %{ $_[2] } )
           . ($_[1] ? qq|>$_[1]</$_[0]>| : qq|/>|). "\n";
   };
   
   
   # USAGE: inittags(@tags);
   #
   # EXAMPLES:
   #  - my ($h1, $h2, $h3) = inittags( qw( h1 h2 h3 ) )
   #    $h1->("This is a headline") #Returns: <h1>This is a headline</h1>
   #
   # NOTES: See sub htmltag for further information.
   #
   # OUTPUT: List of subroutines. 
   sub inittags {
       my @tags = @_;
       return map { my $tag = $_;
                    sub { return htmltag( $tag, @_ ) }
                  } @tags;
   }
   
   
   # USAGE: scripttag(scriptcode, [start|end|both]);
   #
   # EXAMPLES: 
   #  - scripttag("alert('Hello World!')", 'both') 
   #    returns:
   #    <script type="text/javascript">
   #    // BEGIN LON-CAPA Internal
   #    alert(Hello World!')
   #    // END LON-CAPA Internal
   #    </script>
   #
   # NOTES:
   # - works currently only for javascripts
   #
   # OUTPUT: 
   # Scriptcode properly enclosed in <script> and CDATA tags (and LC
   # Internal markers if 2nd argument is given)
   sub scripttag {
       my ( $content, $marker ) = @_;
       return unless defined $content;
   
       my $begin = "\n// BEGIN LON-CAPA Internal\n";
       my $end   = "\n// END LON-CAPA Internal\n";
   
       if ($marker) {
           $content  = $begin . $content if $marker eq 'start' or $marker eq 'both';
           $content .= $end              if $marker eq 'end'   or $marker eq 'both';
       }
   
       $content = "\n// <![CDATA[\n$content\n// ]]>\n";
   
       return htmltag('script', $content, {type => 'text/javascript'});
   };
   
   
   =item list_from_array( \@array, { listattr =>{}, itemattr =>{} } )
   
   Constructs a XHTML list from \@array.
   
   input: 
   
   =over
   
   =item \@array 
   
   A reference to the array containing text that will be wrapped in <li></li> tags.
   
   =item { listattr => {}, itemattr =>{} } 
   
   Attributes for <ul> and <li> passed in as hash references. 
   See htmltag() for more details.
   
   =back
    
   returns: XHTML list as String. 
   
   =cut   
   
   # \@items, {listattr => { class => 'abc', id => 'xyx' }, itemattr => {class => 'abc', id => 'xyx'}}
   sub list_from_array {
       my ($items, $args) = @_;
       return unless (ref($items) eq 'ARRAY');
       return unless scalar @$items;
       my ($ul, $li) = inittags( qw(ul li) );
       my $listitems = join '', map { $li->($_, $args->{itemattr}) } @$items;
       return $ul->( $listitems, $args->{listattr} );
   }
   
   
   ##############################################
   ##############################################
   
   # generate_menu
   #
   # Generates html markup for a menu. 
   #
   # Inputs:
   # An array of following structure:
   #   ({ categorytitle => 'Categorytitle',
   # items => [
   #    {
   #           linktext    => 'Text to be displayed',
   # url        => 'URL the link is pointing to, i.e. /adm/site?action=dosomething',
   # permission  => 'Contains permissions as returned from lonnet::allowed(),
   #         must evaluate to true in order to activate the link',
   # icon        =>  'icon filename',
   # alttext    => 'alt text for the icon',
   # help    => 'Name of the corresponding helpfile',
   # linktitle   => 'Description of the link (used for title tag)'
   #    },
   #    ...
   # ]
   #   }, 
   #   ...
   #   )
   #
   # Outputs: A scalar containing the html markup for the menu.
   
   sub generate_menu {
       my @menu = @_;
       # subs for specific html elements
       my ($h3, $div, $ul, $li, $a, $img) = inittags( qw(h3 div ul li a img) ); 
       
       my @categories; # each element represents the entire markup for a category
      
       foreach my $category (@menu) {
           my @links;  # contains the links for the current $category
           foreach my $link (@{$$category{items}}) {
               next unless $$link{permission};
               
               # create the markup for the current $link and push it into @links.
               # each entry consists of an image and a text optionally followed 
               # by a help link.
               my $src;
               if ($$link{icon} ne '') {
                   $src = '/res/adm/pages/'.$$link{icon};
               }
               push(@links,$li->(
                           $a->(
                               $img->("", {
                                   class => "LC_noBorder LC_middle",
                                   src   => $src,
                                   alt   => mt(defined($$link{alttext}) ?
                                   $$link{alttext} : $$link{linktext})
                               }), {
                               href  => $$link{url},
                               title => mt($$link{linktitle})
                               }).
                           $a->(mt($$link{linktext}), {
                               href  => $$link{url},
                               title => mt($$link{linktitle}),
                               class => "LC_menubuttons_link"
                               }).
                            (defined($$link{help}) ? 
                            Apache::loncommon::help_open_topic($$link{help}) : ''),
                            {class => "LC_menubuttons_inline_text"}));
           }
   
           # wrap categorytitle in <h3>, concatenate with 
           # joined and in <ul> tags wrapped @links
           # and wrap everything in an enclosing <div> and push it into
           # @categories
           # such that each element looks like:
           # <div><h3>title</h3><ul><li>...</li>...</ul></div>
           # the category won't be added if there aren't any links
           push(@categories, 
               $div->($h3->(mt($$category{categorytitle}), {class=>"LC_hcell"}).
               $ul->(join('' ,@links),  {class =>"LC_ListStyleNormal" }),
               {class=>"LC_Box LC_400Box"})) if scalar(@links);
       }
   
       # wrap the joined @categories in another <div> (column layout)
       return $div->(join('', @categories), {class => "LC_columnSection"});
   }
   
   ##############################################
   ##############################################
   
   =pod
   
   =item &start_funclist
   
   Start list of available functions
   
   Typically used to offer a simple list of available functions
   at top or bottom of page.
   All available functions/actions for the current page
   should be included in this list.
   
   If the optional headline text is not provided, a default text will be used.
   
   
   Related routines:
   =over 4
   add_item_funclist
   end_funclist
   =back
   
   
   Inputs: (optional) headline text
   
   Returns: HTML code with function list start
   
   =cut
   
   ##############################################
   ##############################################
   
   sub start_funclist {
       my($legendtext)=@_;
       $legendtext=&mt('Functions') if !$legendtext;
       return '<ul class="LC_funclist"><li style="font-weight:bold; margin-left:0.8em;">'.$legendtext.'</li>'."\n";
   }
   
   
   ##############################################
   ##############################################
   
   =pod
   
   =item &add_item_funclist
   
   Adds an item to the list of available functions
   
   Related routines:
   =over 4
   start_funclist
   end_funclist
   =back
   
   Inputs: content item with text and link to function
   
   Returns: HTML code with list item for funclist
   
   =cut
   
   ##############################################
   ##############################################
   
   sub add_item_funclist {
       my($content) = @_;
       return '<li>'.$content.'</li>'."\n";
   }
   
   =pod
   
   =item &end_funclist
   
   End list of available functions
   
   Related routines:
   =over 4
   start_funclist
   add_item_funclist
   =back
   
   Inputs: ./.
   
   Returns: HTML code with function list end
   =cut
   
   sub end_funclist {
       return "</ul>\n";
   }
   
   =pod
   
   =item funclist_from_array( \@array, {legend => 'text for legend'} )
   
   Constructs a XHTML list from \@array with the first item being visually
   highlighted and set to the value of legend or 'Functions' if legend is
   empty. 
   
   =over
   
   =item \@array
   
   A reference to the array containing text that will be wrapped in <li></li> tags.
   
   =item { legend => 'text' }
   
   A string that's used as visually highlighted first item. 'Functions' is used if
   it's value evaluates to false.
   
   =back
    
   returns: XHTML list as string. 
   
   =back
   
   =cut  
   
   sub funclist_from_array {
       my ($items, $args) = @_;
       return unless(ref($items) eq 'ARRAY');
       $args->{legend} ||= mt('Functions');
       return list_from_array( [$args->{legend}, @$items], 
                  { listattr => {class => 'LC_funclist'} });
   }   
   
 1;  1;
   

Removed from v.1.109  
changed lines
  Added in v.1.294


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