]> git.ipfire.org Git - thirdparty/bash.git/blobdiff - bashhist.c
Bash-4.3 patch 7
[thirdparty/bash.git] / bashhist.c
index 744c8fa012bd74b5d79d5e001b63d291fa1aee21..d4c62e7b793f9324e379a0ad5573e3e7671aacc3 100644 (file)
@@ -1,22 +1,22 @@
 /* bashhist.c -- bash interface to the GNU history library. */
 
-/* Copyright (C) 1993 Free Software Foundation, Inc.
+/* Copyright (C) 1993-2012 Free Software Foundation, Inc.
 
    This file is part of GNU Bash, the Bourne Again SHell.
 
-   Bash is free software; you can redistribute it and/or modify it under
-   the terms of the GNU General Public License as published by the Free
-   Software Foundation; either version 2, or (at your option) any later
-   version.
+   Bash is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
-   Bash is distributed in the hope that it will be useful, but WITHOUT ANY
-   WARRANTY; without even the implied warranty of MERCHANTABILITY or
-   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
-   for more details.
+   Bash is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
-   You should have received a copy of the GNU General Public License along
-   with Bash; see the file COPYING.  If not, write to the Free Software
-   Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
+   You should have received a copy of the GNU General Public License
+   along with Bash.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
 #include "config.h"
 
@@ -24,7 +24,7 @@
 
 #if defined (HAVE_UNISTD_H)
 #  ifdef _MINIX
-#    include <sys/types.h>
+ #    include <sys/types.h>
 #  endif
 #  include <unistd.h>
 #endif
 #include "posixstat.h"
 #include "filecntl.h"
 
+#include "bashintl.h"
+
+#if defined (SYSLOG_HISTORY)
+#  include <syslog.h>
+#endif
+
 #include "shell.h"
 #include "flags.h"
 #include "input.h"
 #include "parser.h"    /* for the struct dstack stuff. */
 #include "pathexp.h"   /* for the struct ignorevar stuff */
+#include "bashhist.h"  /* matching prototypes and declarations */
 #include "builtins/common.h"
 
 #include <readline/history.h>
-#include <glob/fnmatch.h>
+#include <glob/glob.h>
+#include <glob/strmatch.h>
 
 #if defined (READLINE)
 #  include "bashline.h"
+extern int rl_done, rl_dispatching;    /* should really include readline.h */
 #endif
 
 #if !defined (errno)
 extern int errno;
 #endif
 
-extern int glob_pattern_p ();
-
-static int histignore_item_func ();
+static int histignore_item_func __P((struct ign *));
+static int check_history_control __P((char *));
+static void hc_erasedups __P((char *));
+static void really_add_history __P((char *));
 
 static struct ignorevar histignore =
 {
@@ -64,7 +74,7 @@ static struct ignorevar histignore =
   (struct ign *)0,
   0,
   (char *)0,
-  (Function *)histignore_item_func,
+  (sh_iv_item_func_t *)histignore_item_func,
 };
 
 #define HIGN_EXPAND 0x01
@@ -74,8 +84,12 @@ static struct ignorevar histignore =
    list.  This is different than the user-controlled behaviour; this
    becomes zero when we read lines from a file, for example. */
 int remember_on_history = 1;
+int enable_history_list = 1;   /* value for `set -o history' */
 
-/* The number of lines that Bash has added to this history session. */
+/* The number of lines that Bash has added to this history session.  The
+   difference between the number of the top element in the history list
+   (offset from history_base) and the number of lines in the history file.
+   Appending this session's history to the history file resets this to 0. */
 int history_lines_this_session;
 
 /* The number of lines that Bash has read from the history file. */
@@ -87,8 +101,8 @@ int history_lines_in_file;
 int history_expansion_inhibited;
 #endif
 
-/* By default, every line is saved in the history individually.  I.e.,
-   if the user enters:
+/* With the old default, every line was saved in the history individually.
+   I.e., if the user enters:
        bash$ for i in a b c
        > do
        > echo $i
@@ -114,9 +128,16 @@ int history_expansion_inhibited;
        11  history
    The user can then recall the whole command all at once instead
    of just being able to recall one line at a time.
+
+   This is now enabled by default.
    */
 int command_oriented_history = 1;
 
+/* Set to 1 if the first line of a possibly-multi-line command was saved
+   in the history list.  Managed by maybe_add_history(), but global so
+   the history-manipluating builtins can see it. */
+int current_command_first_line_saved = 0;
+
 /* Non-zero means to store newlines in the history list when using
    command_oriented_history rather than trying to use semicolons. */
 int literal_history;
@@ -125,10 +146,14 @@ int literal_history;
    exit, even if the history has been stifled. */
 int force_append_history;
 
-/* A nit for picking at history saving.
-   Value of 0 means save all lines parsed by the shell on the history.
-   Value of 1 means save all lines that do not start with a space.
-   Value of 2 means save all lines that do not match the last line saved. */
+/* A nit for picking at history saving.  Flags have the following values:
+
+   Value == 0 means save all lines parsed by the shell on the history.
+   Value & HC_IGNSPACE means save all lines that do not start with a space.
+   Value & HC_IGNDUPS means save all lines that do not match the last
+   line saved.
+   Value & HC_ERASEDUPS means to remove all other matching lines from the
+   history list before saving the latest line. */
 int history_control;
 
 /* Set to 1 if the last command was added to the history list successfully
@@ -136,6 +161,10 @@ int history_control;
    to a previous entry as part of command-oriented-history processing. */
 int hist_last_line_added;
 
+/* Set to 1 if builtins/history.def:push_history added the last history
+   entry. */
+int hist_last_line_pushed;
+
 #if defined (READLINE)
 /* If non-zero, and readline is being used, the user is offered the
    chance to re-edit a failed history expansion. */
@@ -148,18 +177,25 @@ int hist_verify;
 
 #endif /* READLINE */
 
+/* Non-zero means to not save function definitions in the history list. */
+int dont_save_function_defs;
+
 /* Variables declared in other files used here. */
-extern int interactive;
 extern int current_command_line_count;
 
 extern struct dstack dstack;
+extern int parser_state;
 
-extern char *extract_colon_unit ();
-extern char *history_delimiting_chars ();
-extern void maybe_add_history ();      /* forward declaration */
-extern void bash_add_history ();       /* forward declaration */
-
-static int history_should_ignore ();
+static int bash_history_inhibit_expansion __P((char *, int));
+#if defined (READLINE)
+static void re_edit __P((char *));
+#endif
+static int history_expansion_p __P((char *));
+static int shell_comment __P((char *));
+static int should_expand __P((char *));
+static HIST_ENTRY *last_history_entry __P((void));
+static char *expand_histignore_pattern __P((char *));
+static int history_should_ignore __P((char *));
 
 /* Is the history expansion starting at string[i] one that should not
    be expanded? */
@@ -177,6 +213,9 @@ bash_history_inhibit_expansion (string, i)
   else if (i > 1 && string[i - 1] == '{' && string[i - 2] == '$' &&
             member ('}', string + i + 1))
     return (1);
+  /* The shell uses $! as a defined parameter expansion. */
+  else if (i > 1 && string[i - 1] == '$' && string[i] == '!')
+    return (1);
 #if defined (EXTENDED_GLOB)
   else if (extended_glob && i > 1 && string[i+1] == '(' && member (')', string + i + 2))
     return (1);
@@ -191,6 +230,9 @@ bash_initialize_history ()
   history_quotes_inhibit_expansion = 1;
   history_search_delimiter_chars = ";&()|<>";
   history_inhibit_expansion_function = bash_history_inhibit_expansion;
+#if defined (BANG_HISTORY)
+  sv_histchars ("histchars");
+#endif
 }
 
 void
@@ -201,7 +243,7 @@ bash_history_reinit (interact)
   history_expansion = interact != 0;
   history_expansion_inhibited = 1;
 #endif
-  remember_on_history = interact != 0;
+  remember_on_history = enable_history_list = interact != 0;
   history_inhibit_expansion_function = bash_history_inhibit_expansion;
 }
 
@@ -231,19 +273,21 @@ void
 load_history ()
 {
   char *hf;
-  struct stat buf;
 
   /* Truncate history file for interactive shells which desire it.
      Note that the history file is automatically truncated to the
      size of HISTSIZE if the user does not explicitly set the size
      differently. */
+  set_if_not ("HISTSIZE", "500");
+  sv_histsize ("HISTSIZE");
+
   set_if_not ("HISTFILESIZE", get_string_value ("HISTSIZE"));
   sv_histsize ("HISTFILESIZE");
 
   /* Read the history in HISTFILE into the history list. */
   hf = get_string_value ("HISTFILE");
 
-  if (hf && *hf && stat (hf, &buf) == 0)
+  if (hf && *hf && file_exists (hf))
     {
       read_history (hf);
       using_history ();
@@ -251,26 +295,75 @@ load_history ()
     }
 }
 
+void
+bash_clear_history ()
+{
+  clear_history ();
+  history_lines_this_session = 0;
+}
+
+/* Delete and free the history list entry at offset I. */
+int
+bash_delete_histent (i)
+     int i;
+{
+  HIST_ENTRY *discard;
+
+  discard = remove_history (i);
+  if (discard)
+    free_history_entry (discard);
+  history_lines_this_session--;
+
+  return 1;
+}
+
+int
+bash_delete_last_history ()
+{
+  register int i;
+  HIST_ENTRY **hlist, *histent;
+  int r;
+
+  hlist = history_list ();
+  if (hlist == NULL)
+    return 0;
+
+  for (i = 0; hlist[i]; i++)
+    ;
+  i--;
+
+  /* History_get () takes a parameter that must be offset by history_base. */
+  histent = history_get (history_base + i);    /* Don't free this */
+  if (histent == NULL)
+    return 0;
+
+  r = bash_delete_histent (i);
+
+  if (where_history () > history_length)
+    history_set_pos (history_length);
+
+  return r;
+}
+
 #ifdef INCLUDE_UNUSED
 /* Write the existing history out to the history file. */
 void
 save_history ()
 {
   char *hf;
-  struct stat buf;
+  int r;
 
   hf = get_string_value ("HISTFILE");
-  if (hf && *hf && stat (hf, &buf) == 0)
+  if (hf && *hf && file_exists (hf))
     {
       /* Append only the lines that occurred this session to
         the history file. */
       using_history ();
 
-      if (history_lines_this_session < where_history () || force_append_history)
-       append_history (history_lines_this_session, hf);
+      if (history_lines_this_session <= where_history () || force_append_history)
+       r = append_history (history_lines_this_session, hf);
       else
-       write_history (hf);
-
+       r = write_history (hf);
       sv_histsize ("HISTFILESIZE");
     }
 }
@@ -284,15 +377,15 @@ maybe_append_history (filename)
   struct stat buf;
 
   result = EXECUTION_SUCCESS;
-  if (history_lines_this_session && (history_lines_this_session < where_history ()))
+  if (history_lines_this_session && (history_lines_this_session <= where_history ()))
     {
       /* If the filename was supplied, then create it if necessary. */
       if (stat (filename, &buf) == -1 && errno == ENOENT)
        {
-         fd = open (filename, O_WRONLY|O_CREAT, 0666);
+         fd = open (filename, O_WRONLY|O_CREAT, 0600);
          if (fd < 0)
            {
-             builtin_error ("%s: cannot create: %s", filename, strerror (errno));
+             builtin_error (_("%s: cannot create: %s"), filename, strerror (errno));
              return (EXECUTION_FAILURE);
            }
          close (fd);
@@ -311,7 +404,6 @@ maybe_save_shell_history ()
 {
   int result;
   char *hf;
-  struct stat buf;
 
   result = 0;
   if (history_lines_this_session)
@@ -321,10 +413,10 @@ maybe_save_shell_history ()
       if (hf && *hf)
        {
          /* If the file doesn't exist, then create it. */
-         if (stat (hf, &buf) == -1)
+         if (file_exists (hf) == 0)
            {
              int file;
-             file = open (hf, O_CREAT | O_TRUNC | O_WRONLY, 0666);
+             file = open (hf, O_CREAT | O_TRUNC | O_WRONLY, 0600);
              if (file != -1)
                close (file);
            }
@@ -408,7 +500,7 @@ pre_process_line (line, print_changes, addit)
              if (expanded < 0)
                internal_error ("%s", history_value);
 #if defined (READLINE)
-             else if (hist_verify == 0)
+             else if (hist_verify == 0 || expanded == 2)
 #else
              else
 #endif
@@ -418,12 +510,19 @@ pre_process_line (line, print_changes, addit)
          /* If there was an error, return NULL. */
          if (expanded < 0 || expanded == 2)    /* 2 == print only */
            {
+#    if defined (READLINE)
+             if (expanded == 2 && rl_dispatching == 0 && *history_value)
+#    else            
+             if (expanded == 2 && *history_value)
+#    endif /* !READLINE */
+               maybe_add_history (history_value);
+
              free (history_value);
 
 #    if defined (READLINE)
              /* New hack.  We can allow the user to edit the
                 failed history expansion. */
-             if (history_reediting && expanded < 0)
+             if (history_reediting && expanded < 0 && rl_done)
                re_edit (line);
 #    endif /* READLINE */
              return ((char *)NULL);
@@ -457,57 +556,173 @@ pre_process_line (line, print_changes, addit)
   return (return_value);
 }
 
-/* Add LINE to the history list depending on the value of HISTORY_CONTROL. */
-void
-maybe_add_history (line)
+/* Return 1 if the first non-whitespace character in LINE is a `#', indicating
+ * that the line is a shell comment. */
+static int
+shell_comment (line)
+     char *line;
+{
+  char *p;
+
+  for (p = line; p && *p && whitespace (*p); p++)
+    ;
+  return (p && *p == '#');
+}
+
+#ifdef INCLUDE_UNUSED
+/* Remove shell comments from LINE.  A `#' and anything after it is a comment.
+   This isn't really useful yet, since it doesn't handle quoting. */
+static char *
+filter_comments (line)
+     char *line;
+{
+  char *p;
+
+  for (p = line; p && *p && *p != '#'; p++)
+    ;
+  if (p && *p == '#')
+    *p = '\0';
+  return (line);
+}
+#endif
+
+/* Check LINE against what HISTCONTROL says to do.  Returns 1 if the line
+   should be saved; 0 if it should be discarded. */
+static int
+check_history_control (line)
+     char *line;
+{
+  HIST_ENTRY *temp;
+  int r;
+
+  if (history_control == 0)
+    return 1;
+
+  /* ignorespace or ignoreboth */
+  if ((history_control & HC_IGNSPACE) && *line == ' ')
+    return 0;
+
+  /* ignoredups or ignoreboth */
+  if (history_control & HC_IGNDUPS)
+    {
+      using_history ();
+      temp = previous_history ();
+
+      r = (temp == 0 || STREQ (temp->line, line) == 0);
+
+      using_history ();
+
+      if (r == 0)
+       return r;
+    }
+
+  return 1;
+}
+
+/* Remove all entries matching LINE from the history list.  Triggered when
+   HISTCONTROL includes `erasedups'. */
+static void
+hc_erasedups (line)
      char *line;
 {
-  int should_add;
   HIST_ENTRY *temp;
+  int r;
 
-  should_add = hist_last_line_added = 0;
+  using_history ();
+  while (temp = previous_history ())
+    {
+      if (STREQ (temp->line, line))
+       {
+         r = where_history ();
+         remove_history (r);
+       }
+    }
+  using_history ();
+}
+
+/* Add LINE to the history list, handling possibly multi-line compound
+   commands.  We note whether or not we save the first line of each command
+   (which is usually the entire command and history entry), and don't add
+   the second and subsequent lines of a multi-line compound command if we
+   didn't save the first line.  We don't usually save shell comment lines in
+   compound commands in the history, because they could have the effect of
+   commenting out the rest of the command when the entire command is saved as
+   a single history entry (when COMMAND_ORIENTED_HISTORY is enabled).  If
+   LITERAL_HISTORY is set, we're saving lines in the history with embedded
+   newlines, so it's OK to save comment lines.  If we're collecting the body
+   of a here-document, we should act as if literal_history is enabled, because
+   we want to save the entire contents of the here-document as it was
+   entered.  We also make sure to save multiple-line quoted strings or other
+   constructs. */
+void
+maybe_add_history (line)
+     char *line;
+{
+  hist_last_line_added = 0;
 
   /* Don't use the value of history_control to affect the second
      and subsequent lines of a multi-line command (old code did
      this only when command_oriented_history is enabled). */
-#if 0
-  if (command_oriented_history && current_command_line_count > 1)
-#else
   if (current_command_line_count > 1)
-#endif
     {
-      bash_add_history (line);
+      if (current_command_first_line_saved &&
+         ((parser_state & PST_HEREDOC) || literal_history || dstack.delimiter_depth != 0 || shell_comment (line) == 0))
+       bash_add_history (line);
       return;
     }
 
-  switch (history_control)
+  /* This is the first line of a (possible multi-line) command.  Note whether
+     or not we should save the first line and remember it. */
+  current_command_first_line_saved = check_add_history (line, 0);
+}
+
+/* Just check LINE against HISTCONTROL and HISTIGNORE and add it to the
+   history if it's OK.  Used by `history -s' as well as maybe_add_history().
+   Returns 1 if the line was saved in the history, 0 otherwise. */
+int
+check_add_history (line, force)
+     char *line;
+     int force;
+{
+  if (check_history_control (line) && history_should_ignore (line) == 0)
     {
-    case 0:
-      should_add = 1;
-      break;
-    case 1:
-      if (*line != ' ')
-       should_add = 1;
-      break;
-    case 3:
-      if (*line == ' ')
-       break;
-      /* FALLTHROUGH if case == 3 (`ignoreboth') */
-    case 2:
-      using_history ();
-      temp = previous_history ();
+      /* We're committed to saving the line.  If the user has requested it,
+        remove other matching lines from the history. */
+      if (history_control & HC_ERASEDUPS)
+       hc_erasedups (line);
+        
+      if (force)
+       {
+         really_add_history (line);
+         using_history ();
+       }
+      else
+       bash_add_history (line);
+      return 1;
+    }
+  return 0;
+}
 
-      if (temp == 0 || STREQ (temp->line, line) == 0)
-       should_add = 1;
+#if defined (SYSLOG_HISTORY)
+#define SYSLOG_MAXLEN 600
 
-      using_history ();
-      break;
-    }
+void
+bash_syslog_history (line)
+     const char *line;
+{
+  char trunc[SYSLOG_MAXLEN];
 
-  if (should_add && history_should_ignore (line) == 0)
-    bash_add_history (line);
+  if (strlen(line) < SYSLOG_MAXLEN)
+    syslog (SYSLOG_FACILITY|SYSLOG_LEVEL, "HISTORY: PID=%d UID=%d %s", getpid(), current_user.uid, line);
+  else
+    {
+      strncpy (trunc, line, SYSLOG_MAXLEN);
+      trunc[SYSLOG_MAXLEN - 1] = '\0';
+      syslog (SYSLOG_FACILITY|SYSLOG_LEVEL, "HISTORY (TRUNCATED): PID=%d UID=%d %s", getpid(), current_user.uid, trunc);
+    }
 }
-
+#endif
+       
 /* Add a line to the history list.
    The variable COMMAND_ORIENTED_HISTORY controls the style of history
    remembering;  when non-zero, and LINE is not the first line of a
@@ -524,7 +739,17 @@ bash_add_history (line)
   add_it = 1;
   if (command_oriented_history && current_command_line_count > 1)
     {
-      chars_to_add = literal_history ? "\n" : history_delimiting_chars ();
+      /* The second and subsequent lines of a here document have the trailing
+        newline preserved.  We don't want to add extra newlines here, but we
+        do want to add one after the first line (which is the command that
+        contains the here-doc specifier).  parse.y:history_delimiting_chars()
+        does the right thing to take care of this for us.  We don't want to
+        add extra newlines if the user chooses to enable literal_history,
+        so we have to duplicate some of what that function does here. */
+      if ((parser_state & PST_HEREDOC) && literal_history && current_command_line_count > 2 && line[strlen (line) - 1] == '\n')
+       chars_to_add = "";
+      else
+       chars_to_add = literal_history ? "\n" : history_delimiting_chars (line);
 
       using_history ();
       current = previous_history ();
@@ -544,38 +769,54 @@ bash_add_history (line)
              chars_to_add = "";
            }
 
-         new_line = (char *) xmalloc (1
-                                      + curlen
-                                      + strlen (line)
-                                      + strlen (chars_to_add));
+         /* If we're not in some kind of quoted construct, the current history
+            entry ends with a newline, and we're going to add a semicolon,
+            don't.  In some cases, it results in a syntax error (e.g., before
+            a close brace), and it should not be needed. */
+         if (dstack.delimiter_depth == 0 && current->line[curlen - 1] == '\n' && *chars_to_add == ';')
+           chars_to_add++;
+
+         new_line = (char *)xmalloc (1
+                                     + curlen
+                                     + strlen (line)
+                                     + strlen (chars_to_add));
          sprintf (new_line, "%s%s%s", current->line, chars_to_add, line);
          offset = where_history ();
          old = replace_history_entry (offset, new_line, current->data);
          free (new_line);
 
          if (old)
-           {
-             FREE (old->line);
-             free (old);
-           }
+           free_history_entry (old);
+
          add_it = 0;
        }
     }
 
   if (add_it)
-    {
-      hist_last_line_added = 1;
-      add_history (line);
-      history_lines_this_session++;
-    }
+    really_add_history (line);
+
+#if defined (SYSLOG_HISTORY)
+  bash_syslog_history (line);
+#endif
+
   using_history ();
 }
 
+static void
+really_add_history (line)
+     char *line;
+{
+  hist_last_line_added = 1;
+  hist_last_line_pushed = 0;
+  add_history (line);
+  history_lines_this_session++;
+}
+
 int
 history_number ()
 {
   using_history ();
-  return (get_string_value ("HISTSIZE") ? history_base + where_history () : 1);
+  return (remember_on_history ? history_base + where_history () : 1);
 }
 
 static int
@@ -637,51 +878,15 @@ expand_histignore_pattern (pat)
      char *pat;
 {
   HIST_ENTRY *phe;
-  char *ret, *p, *r, *t;
-  int len, rlen, ind, tlen;
+  char *ret;
 
   phe = last_history_entry ();
 
   if (phe == (HIST_ENTRY *)0)
     return (savestring (pat));
 
-  len = strlen (phe->line);
-  rlen = len + strlen (pat) + 2;
-  ret = xmalloc (rlen);
-
-  for (p = pat, r = ret; p && *p; )
-    {
-      if (*p == '&')
-       {
-         ind = r - ret;
-         if (glob_pattern_p (phe->line) || strchr (phe->line, '\\'))
-           {
-             t = quote_globbing_chars (phe->line);
-             tlen = strlen (t);
-             RESIZE_MALLOCED_BUFFER (ret, ind, tlen, rlen, rlen);
-             r = ret + ind;    /* in case reallocated */
-             strcpy (r, t);
-             r += tlen;
-             free (t);
-           }
-         else
-           {
-             tlen = strlen (phe->line);
-             RESIZE_MALLOCED_BUFFER (ret, ind, tlen, rlen, rlen);
-             r = ret + ind;    /* in case reallocated */
-             strcpy (r, phe->line);
-             r += len;
-           }
-         p++;
-         continue;
-       }
-
-      if (*p == '\\' && p[1] == '&')
-       p++;
+  ret = strcreplace (pat, '&', phe->line, 1);
 
-      *r++ = *p++;
-    }
-  *r = '\0';
   return ret;
 }
 
@@ -704,7 +909,7 @@ history_should_ignore (line)
       else
        npat = histignore.ignores[i].val;
 
-      match = fnmatch (npat, line, FNMATCH_EXTFLAG) != FNM_NOMATCH;
+      match = strmatch (npat, line, FNMATCH_EXTFLAG) != FNM_NOMATCH;
 
       if (histignore.ignores[i].flags & HIGN_EXPAND)
        free (npat);