1 /* bashhist.c -- bash interface to the GNU history library. */
3 /* Copyright (C) 1993-2009 Free Software Foundation, Inc.
5 This file is part of GNU Bash, the Bourne Again SHell.
7 Bash is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 Bash is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with Bash. If not, see <http://www.gnu.org/licenses/>.
25 #if defined (HAVE_UNISTD_H)
27 # include <sys/types.h>
32 #include "bashtypes.h"
36 #include "posixstat.h"
41 #if defined (SYSLOG_HISTORY)
48 #include "parser.h" /* for the struct dstack stuff. */
49 #include "pathexp.h" /* for the struct ignorevar stuff */
50 #include "bashhist.h" /* matching prototypes and declarations */
51 #include "builtins/common.h"
53 #include <readline/history.h>
54 #include <glob/glob.h>
55 #include <glob/strmatch.h>
57 #if defined (READLINE)
58 # include "bashline.h"
59 extern int rl_done, rl_dispatching; /* should really include readline.h */
66 static int histignore_item_func __P((struct ign *));
67 static int check_history_control __P((char *));
68 static void hc_erasedups __P((char *));
69 static void really_add_history __P((char *));
71 static struct ignorevar histignore =
77 (sh_iv_item_func_t *)histignore_item_func,
80 #define HIGN_EXPAND 0x01
82 /* Declarations of bash history variables. */
83 /* Non-zero means to remember lines typed to the shell on the history
84 list. This is different than the user-controlled behaviour; this
85 becomes zero when we read lines from a file, for example. */
86 int remember_on_history = 1;
87 int enable_history_list = 1; /* value for `set -o history' */
89 /* The number of lines that Bash has added to this history session. The
90 difference between the number of the top element in the history list
91 (offset from history_base) and the number of lines in the history file.
92 Appending this session's history to the history file resets this to 0. */
93 int history_lines_this_session;
95 /* The number of lines that Bash has read from the history file. */
96 int history_lines_in_file;
98 #if defined (BANG_HISTORY)
99 /* Non-zero means do no history expansion on this line, regardless
100 of what history_expansion says. */
101 int history_expansion_inhibited;
104 /* With the old default, every line was saved in the history individually.
105 I.e., if the user enters:
110 Each line will be individually saved in the history.
117 If the variable command_oriented_history is set, multiple lines
118 which form one command will be saved as one history entry.
129 The user can then recall the whole command all at once instead
130 of just being able to recall one line at a time.
132 This is now enabled by default.
134 int command_oriented_history = 1;
136 /* Set to 1 if the first line of a possibly-multi-line command was saved
137 in the history list. Managed by maybe_add_history(), but global so
138 the history-manipluating builtins can see it. */
139 int current_command_first_line_saved = 0;
141 /* Non-zero means to store newlines in the history list when using
142 command_oriented_history rather than trying to use semicolons. */
145 /* Non-zero means to append the history to the history file at shell
146 exit, even if the history has been stifled. */
147 int force_append_history;
149 /* A nit for picking at history saving. Flags have the following values:
151 Value == 0 means save all lines parsed by the shell on the history.
152 Value & HC_IGNSPACE means save all lines that do not start with a space.
153 Value & HC_IGNDUPS means save all lines that do not match the last
155 Value & HC_ERASEDUPS means to remove all other matching lines from the
156 history list before saving the latest line. */
159 /* Set to 1 if the last command was added to the history list successfully
160 as a separate history entry; set to 0 if the line was ignored or added
161 to a previous entry as part of command-oriented-history processing. */
162 int hist_last_line_added;
164 /* Set to 1 if builtins/history.def:push_history added the last history
166 int hist_last_line_pushed;
168 #if defined (READLINE)
169 /* If non-zero, and readline is being used, the user is offered the
170 chance to re-edit a failed history expansion. */
171 int history_reediting;
173 /* If non-zero, and readline is being used, don't directly execute a
174 line with history substitution. Reload it into the editing buffer
175 instead and let the user further edit and confirm with a newline. */
178 #endif /* READLINE */
180 /* Non-zero means to not save function definitions in the history list. */
181 int dont_save_function_defs;
183 /* Variables declared in other files used here. */
184 extern int current_command_line_count;
186 extern struct dstack dstack;
188 static int bash_history_inhibit_expansion __P((char *, int));
189 #if defined (READLINE)
190 static void re_edit __P((char *));
192 static int history_expansion_p __P((char *));
193 static int shell_comment __P((char *));
194 static int should_expand __P((char *));
195 static HIST_ENTRY *last_history_entry __P((void));
196 static char *expand_histignore_pattern __P((char *));
197 static int history_should_ignore __P((char *));
199 /* Is the history expansion starting at string[i] one that should not
202 bash_history_inhibit_expansion (string, i)
206 /* The shell uses ! as a pattern negation character in globbing [...]
207 expressions, so let those pass without expansion. */
208 if (i > 0 && (string[i - 1] == '[') && member (']', string + i + 1))
210 /* The shell uses ! as the indirect expansion character, so let those
211 expansions pass as well. */
212 else if (i > 1 && string[i - 1] == '{' && string[i - 2] == '$' &&
213 member ('}', string + i + 1))
215 #if defined (EXTENDED_GLOB)
216 else if (extended_glob && i > 1 && string[i+1] == '(' && member (')', string + i + 2))
224 bash_initialize_history ()
226 history_quotes_inhibit_expansion = 1;
227 history_search_delimiter_chars = ";&()|<>";
228 history_inhibit_expansion_function = bash_history_inhibit_expansion;
229 #if defined (BANG_HISTORY)
230 sv_histchars ("histchars");
235 bash_history_reinit (interact)
238 #if defined (BANG_HISTORY)
239 history_expansion = interact != 0;
240 history_expansion_inhibited = 1;
242 remember_on_history = enable_history_list = interact != 0;
243 history_inhibit_expansion_function = bash_history_inhibit_expansion;
247 bash_history_disable ()
249 remember_on_history = 0;
250 #if defined (BANG_HISTORY)
251 history_expansion_inhibited = 1;
256 bash_history_enable ()
258 remember_on_history = 1;
259 #if defined (BANG_HISTORY)
260 history_expansion_inhibited = 0;
262 history_inhibit_expansion_function = bash_history_inhibit_expansion;
263 sv_history_control ("HISTCONTROL");
264 sv_histignore ("HISTIGNORE");
267 /* Load the history list from the history file. */
273 /* Truncate history file for interactive shells which desire it.
274 Note that the history file is automatically truncated to the
275 size of HISTSIZE if the user does not explicitly set the size
277 set_if_not ("HISTSIZE", "500");
278 sv_histsize ("HISTSIZE");
280 set_if_not ("HISTFILESIZE", get_string_value ("HISTSIZE"));
281 sv_histsize ("HISTFILESIZE");
283 /* Read the history in HISTFILE into the history list. */
284 hf = get_string_value ("HISTFILE");
286 if (hf && *hf && file_exists (hf))
290 history_lines_in_file = where_history ();
295 bash_clear_history ()
298 history_lines_this_session = 0;
301 /* Delete and free the history list entry at offset I. */
303 bash_delete_histent (i)
308 discard = remove_history (i);
310 free_history_entry (discard);
311 history_lines_this_session--;
317 bash_delete_last_history ()
320 HIST_ENTRY **hlist, *histent;
323 hlist = history_list ();
327 for (i = 0; hlist[i]; i++)
331 /* History_get () takes a parameter that must be offset by history_base. */
332 histent = history_get (history_base + i); /* Don't free this */
336 r = bash_delete_histent (i);
338 if (where_history () > history_length)
339 history_set_pos (history_length);
344 #ifdef INCLUDE_UNUSED
345 /* Write the existing history out to the history file. */
351 hf = get_string_value ("HISTFILE");
352 if (hf && *hf && file_exists (hf))
354 /* Append only the lines that occurred this session to
358 if (history_lines_this_session < where_history () || force_append_history)
359 append_history (history_lines_this_session, hf);
362 sv_histsize ("HISTFILESIZE");
368 maybe_append_history (filename)
374 result = EXECUTION_SUCCESS;
375 if (history_lines_this_session && (history_lines_this_session < where_history ()))
377 /* If the filename was supplied, then create it if necessary. */
378 if (stat (filename, &buf) == -1 && errno == ENOENT)
380 fd = open (filename, O_WRONLY|O_CREAT, 0600);
383 builtin_error (_("%s: cannot create: %s"), filename, strerror (errno));
384 return (EXECUTION_FAILURE);
388 result = append_history (history_lines_this_session, filename);
389 history_lines_in_file += history_lines_this_session;
390 history_lines_this_session = 0;
395 /* If this is an interactive shell, then append the lines executed
396 this session to the history file. */
398 maybe_save_shell_history ()
404 if (history_lines_this_session)
406 hf = get_string_value ("HISTFILE");
410 /* If the file doesn't exist, then create it. */
411 if (file_exists (hf) == 0)
414 file = open (hf, O_CREAT | O_TRUNC | O_WRONLY, 0600);
419 /* Now actually append the lines if the history hasn't been
420 stifled. If the history has been stifled, rewrite the
423 if (history_lines_this_session <= where_history () || force_append_history)
425 result = append_history (history_lines_this_session, hf);
426 history_lines_in_file += history_lines_this_session;
430 result = write_history (hf);
431 history_lines_in_file = history_lines_this_session;
433 history_lines_this_session = 0;
435 sv_histsize ("HISTFILESIZE");
441 #if defined (READLINE)
442 /* Tell readline () that we have some text for it to edit. */
447 if (bash_input.type == st_stdin)
450 #endif /* READLINE */
452 /* Return 1 if this line needs history expansion. */
454 history_expansion_p (line)
459 for (s = line; *s; s++)
460 if (*s == history_expansion_char || *s == history_subst_char)
465 /* Do pre-processing on LINE. If PRINT_CHANGES is non-zero, then
466 print the results of expanding the line if there were any changes.
467 If there is an error, return NULL, otherwise the expanded line is
468 returned. If ADDIT is non-zero the line is added to the history
469 list after history expansion. ADDIT is just a suggestion;
470 REMEMBER_ON_HISTORY can veto, and does.
471 Right now this does history expansion. */
473 pre_process_line (line, print_changes, addit)
475 int print_changes, addit;
484 # if defined (BANG_HISTORY)
485 /* History expand the line. If this results in no errors, then
486 add that line to the history if ADDIT is non-zero. */
487 if (!history_expansion_inhibited && history_expansion && history_expansion_p (line))
489 expanded = history_expand (line, &history_value);
496 internal_error ("%s", history_value);
497 #if defined (READLINE)
498 else if (hist_verify == 0 || expanded == 2)
502 fprintf (stderr, "%s\n", history_value);
505 /* If there was an error, return NULL. */
506 if (expanded < 0 || expanded == 2) /* 2 == print only */
508 # if defined (READLINE)
509 if (expanded == 2 && rl_dispatching == 0 && *history_value)
511 if (expanded == 2 && *history_value)
512 # endif /* !READLINE */
513 maybe_add_history (history_value);
515 free (history_value);
517 # if defined (READLINE)
518 /* New hack. We can allow the user to edit the
519 failed history expansion. */
520 if (history_reediting && expanded < 0 && rl_done)
522 # endif /* READLINE */
523 return ((char *)NULL);
526 # if defined (READLINE)
527 if (hist_verify && expanded == 1)
529 re_edit (history_value);
530 return ((char *)NULL);
535 /* Let other expansions know that return_value can be free'ed,
536 and that a line has been added to the history list. Note
537 that we only add lines that have something in them. */
539 return_value = history_value;
541 # endif /* BANG_HISTORY */
543 if (addit && remember_on_history && *return_value)
544 maybe_add_history (return_value);
548 return_value = savestring (line);
551 return (return_value);
554 /* Return 1 if the first non-whitespace character in LINE is a `#', indicating
555 * that the line is a shell comment. */
562 for (p = line; p && *p && whitespace (*p); p++)
564 return (p && *p == '#');
567 #ifdef INCLUDE_UNUSED
568 /* Remove shell comments from LINE. A `#' and anything after it is a comment.
569 This isn't really useful yet, since it doesn't handle quoting. */
571 filter_comments (line)
576 for (p = line; p && *p && *p != '#'; p++)
584 /* Check LINE against what HISTCONTROL says to do. Returns 1 if the line
585 should be saved; 0 if it should be discarded. */
587 check_history_control (line)
593 if (history_control == 0)
596 /* ignorespace or ignoreboth */
597 if ((history_control & HC_IGNSPACE) && *line == ' ')
600 /* ignoredups or ignoreboth */
601 if (history_control & HC_IGNDUPS)
604 temp = previous_history ();
606 r = (temp == 0 || STREQ (temp->line, line) == 0);
617 /* Remove all entries matching LINE from the history list. Triggered when
618 HISTCONTROL includes `erasedups'. */
627 while (temp = previous_history ())
629 if (STREQ (temp->line, line))
631 r = where_history ();
638 /* Add LINE to the history list, handling possibly multi-line compound
639 commands. We note whether or not we save the first line of each command
640 (which is usually the entire command and history entry), and don't add
641 the second and subsequent lines of a multi-line compound command if we
642 didn't save the first line. We don't usually save shell comment lines in
643 compound commands in the history, because they could have the effect of
644 commenting out the rest of the command when the entire command is saved as
645 a single history entry (when COMMAND_ORIENTED_HISTORY is enabled). If
646 LITERAL_HISTORY is set, we're saving lines in the history with embedded
647 newlines, so it's OK to save comment lines. We also make sure to save
648 multiple-line quoted strings or other constructs. */
650 maybe_add_history (line)
653 hist_last_line_added = 0;
655 /* Don't use the value of history_control to affect the second
656 and subsequent lines of a multi-line command (old code did
657 this only when command_oriented_history is enabled). */
658 if (current_command_line_count > 1)
660 if (current_command_first_line_saved &&
661 (literal_history || dstack.delimiter_depth != 0 || shell_comment (line) == 0))
662 bash_add_history (line);
666 /* This is the first line of a (possible multi-line) command. Note whether
667 or not we should save the first line and remember it. */
668 current_command_first_line_saved = check_add_history (line, 0);
671 /* Just check LINE against HISTCONTROL and HISTIGNORE and add it to the
672 history if it's OK. Used by `history -s' as well as maybe_add_history().
673 Returns 1 if the line was saved in the history, 0 otherwise. */
675 check_add_history (line, force)
679 if (check_history_control (line) && history_should_ignore (line) == 0)
681 /* We're committed to saving the line. If the user has requested it,
682 remove other matching lines from the history. */
683 if (history_control & HC_ERASEDUPS)
688 really_add_history (line);
692 bash_add_history (line);
698 #if defined (SYSLOG_HISTORY)
699 #define SYSLOG_MAXLEN 600
702 bash_syslog_history (line)
705 char trunc[SYSLOG_MAXLEN];
707 if (strlen(line) < SYSLOG_MAXLEN)
708 syslog (SYSLOG_FACILITY|SYSLOG_LEVEL, "HISTORY: PID=%d UID=%d %s", getpid(), current_user.uid, line);
711 strncpy (trunc, line, SYSLOG_MAXLEN);
712 trunc[SYSLOG_MAXLEN - 1] = '\0';
713 syslog (SYSLOG_FACILITY|SYSLOG_LEVEL, "HISTORY (TRUNCATED): PID=%d UID=%d %s", getpid(), current_user.uid, trunc);
718 /* Add a line to the history list.
719 The variable COMMAND_ORIENTED_HISTORY controls the style of history
720 remembering; when non-zero, and LINE is not the first line of a
721 complete parser construct, append LINE to the last history line instead
722 of adding it as a new line. */
724 bash_add_history (line)
727 int add_it, offset, curlen;
728 HIST_ENTRY *current, *old;
729 char *chars_to_add, *new_line;
732 if (command_oriented_history && current_command_line_count > 1)
734 chars_to_add = literal_history ? "\n" : history_delimiting_chars ();
737 current = previous_history ();
741 /* If the previous line ended with an escaped newline (escaped
742 with backslash, but otherwise unquoted), then remove the quoted
743 newline, since that is what happens when the line is parsed. */
744 curlen = strlen (current->line);
746 if (dstack.delimiter_depth == 0 && current->line[curlen - 1] == '\\' &&
747 current->line[curlen - 2] != '\\')
749 current->line[curlen - 1] = '\0';
754 new_line = (char *)xmalloc (1
757 + strlen (chars_to_add));
758 sprintf (new_line, "%s%s%s", current->line, chars_to_add, line);
759 offset = where_history ();
760 old = replace_history_entry (offset, new_line, current->data);
764 free_history_entry (old);
771 really_add_history (line);
773 #if defined (SYSLOG_HISTORY)
774 bash_syslog_history (line);
781 really_add_history (line)
784 hist_last_line_added = 1;
785 hist_last_line_pushed = 0;
787 history_lines_this_session++;
794 return (remember_on_history ? history_base + where_history () : 1);
803 for (p = s; p && *p; p++)
814 histignore_item_func (ign)
817 if (should_expand (ign->val))
818 ign->flags |= HIGN_EXPAND;
823 setup_history_ignore (varname)
826 setup_ignore_patterns (&histignore);
830 last_history_entry ()
835 he = previous_history ();
845 he = last_history_entry ();
847 return ((char *)NULL);
852 expand_histignore_pattern (pat)
858 phe = last_history_entry ();
860 if (phe == (HIST_ENTRY *)0)
861 return (savestring (pat));
863 ret = strcreplace (pat, '&', phe->line, 1);
868 /* Return 1 if we should not put LINE into the history according to the
869 patterns in HISTIGNORE. */
871 history_should_ignore (line)
874 register int i, match;
877 if (histignore.num_ignores == 0)
880 for (i = match = 0; i < histignore.num_ignores; i++)
882 if (histignore.ignores[i].flags & HIGN_EXPAND)
883 npat = expand_histignore_pattern (histignore.ignores[i].val);
885 npat = histignore.ignores[i].val;
887 match = strmatch (npat, line, FNMATCH_EXTFLAG) != FNM_NOMATCH;
889 if (histignore.ignores[i].flags & HIGN_EXPAND)