1 /* bashhist.c -- bash interface to the GNU history library. */
3 /* Copyright (C) 1993-2004 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 it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
12 Bash is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License along
18 with Bash; see the file COPYING. If not, write to the Free Software
19 Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
25 #if defined (HAVE_UNISTD_H)
27 # include <sys/types.h>
32 #include "bashtypes.h"
36 #include "posixstat.h"
44 #include "parser.h" /* for the struct dstack stuff. */
45 #include "pathexp.h" /* for the struct ignorevar stuff */
46 #include "bashhist.h" /* matching prototypes and declarations */
47 #include "builtins/common.h"
49 #include <readline/history.h>
50 #include <glob/glob.h>
51 #include <glob/strmatch.h>
53 #if defined (READLINE)
54 # include "bashline.h"
55 extern int rl_done, rl_dispatching; /* should really include readline.h */
62 static int histignore_item_func __P((struct ign *));
63 static int check_history_control __P((char *));
64 static void hc_erasedups __P((char *));
65 static void really_add_history __P((char *));
67 static struct ignorevar histignore =
73 (sh_iv_item_func_t *)histignore_item_func,
76 #define HIGN_EXPAND 0x01
78 /* Declarations of bash history variables. */
79 /* Non-zero means to remember lines typed to the shell on the history
80 list. This is different than the user-controlled behaviour; this
81 becomes zero when we read lines from a file, for example. */
82 int remember_on_history = 1;
84 /* The number of lines that Bash has added to this history session. The
85 difference between the number of the top element in the history list
86 (offset from history_base) and the number of lines in the history file.
87 Appending this session's history to the history file resets this to 0. */
88 int history_lines_this_session;
90 /* The number of lines that Bash has read from the history file. */
91 int history_lines_in_file;
93 #if defined (BANG_HISTORY)
94 /* Non-zero means do no history expansion on this line, regardless
95 of what history_expansion says. */
96 int history_expansion_inhibited;
99 /* With the old default, every line was saved in the history individually.
100 I.e., if the user enters:
105 Each line will be individually saved in the history.
112 If the variable command_oriented_history is set, multiple lines
113 which form one command will be saved as one history entry.
124 The user can then recall the whole command all at once instead
125 of just being able to recall one line at a time.
127 This is now enabled by default.
129 int command_oriented_history = 1;
131 /* Set to 1 if the first line of a possibly-multi-line command was saved
132 in the history list. Managed by maybe_add_history(), but global so
133 the history-manipluating builtins can see it. */
134 int current_command_first_line_saved = 0;
136 /* Non-zero means to store newlines in the history list when using
137 command_oriented_history rather than trying to use semicolons. */
140 /* Non-zero means to append the history to the history file at shell
141 exit, even if the history has been stifled. */
142 int force_append_history;
144 /* A nit for picking at history saving. Flags have the following values:
146 Value == 0 means save all lines parsed by the shell on the history.
147 Value & HC_IGNSPACE means save all lines that do not start with a space.
148 Value & HC_IGNDUPS means save all lines that do not match the last
150 Value & HC_ERASEDUPS means to remove all other matching lines from the
151 history list before saving the latest line. */
154 /* Set to 1 if the last command was added to the history list successfully
155 as a separate history entry; set to 0 if the line was ignored or added
156 to a previous entry as part of command-oriented-history processing. */
157 int hist_last_line_added;
159 #if defined (READLINE)
160 /* If non-zero, and readline is being used, the user is offered the
161 chance to re-edit a failed history expansion. */
162 int history_reediting;
164 /* If non-zero, and readline is being used, don't directly execute a
165 line with history substitution. Reload it into the editing buffer
166 instead and let the user further edit and confirm with a newline. */
169 #endif /* READLINE */
171 /* Non-zero means to not save function definitions in the history list. */
172 int dont_save_function_defs;
174 /* Variables declared in other files used here. */
175 extern int current_command_line_count;
177 extern struct dstack dstack;
179 static int bash_history_inhibit_expansion __P((char *, int));
180 #if defined (READLINE)
181 static void re_edit __P((char *));
183 static int history_expansion_p __P((char *));
184 static int shell_comment __P((char *));
185 static int should_expand __P((char *));
186 static HIST_ENTRY *last_history_entry __P((void));
187 static char *expand_histignore_pattern __P((char *));
188 static int history_should_ignore __P((char *));
190 /* Is the history expansion starting at string[i] one that should not
193 bash_history_inhibit_expansion (string, i)
197 /* The shell uses ! as a pattern negation character in globbing [...]
198 expressions, so let those pass without expansion. */
199 if (i > 0 && (string[i - 1] == '[') && member (']', string + i + 1))
201 /* The shell uses ! as the indirect expansion character, so let those
202 expansions pass as well. */
203 else if (i > 1 && string[i - 1] == '{' && string[i - 2] == '$' &&
204 member ('}', string + i + 1))
206 #if defined (EXTENDED_GLOB)
207 else if (extended_glob && i > 1 && string[i+1] == '(' && member (')', string + i + 2))
215 bash_initialize_history ()
217 history_quotes_inhibit_expansion = 1;
218 history_search_delimiter_chars = ";&()|<>";
219 history_inhibit_expansion_function = bash_history_inhibit_expansion;
220 sv_histchars ("histchars");
224 bash_history_reinit (interact)
227 #if defined (BANG_HISTORY)
228 history_expansion = interact != 0;
229 history_expansion_inhibited = 1;
231 remember_on_history = interact != 0;
232 history_inhibit_expansion_function = bash_history_inhibit_expansion;
236 bash_history_disable ()
238 remember_on_history = 0;
239 #if defined (BANG_HISTORY)
240 history_expansion_inhibited = 1;
245 bash_history_enable ()
247 remember_on_history = 1;
248 #if defined (BANG_HISTORY)
249 history_expansion_inhibited = 0;
251 history_inhibit_expansion_function = bash_history_inhibit_expansion;
252 sv_history_control ("HISTCONTROL");
253 sv_histignore ("HISTIGNORE");
256 /* Load the history list from the history file. */
263 /* Truncate history file for interactive shells which desire it.
264 Note that the history file is automatically truncated to the
265 size of HISTSIZE if the user does not explicitly set the size
267 set_if_not ("HISTFILESIZE", get_string_value ("HISTSIZE"));
268 sv_histsize ("HISTFILESIZE");
270 /* Read the history in HISTFILE into the history list. */
271 hf = get_string_value ("HISTFILE");
273 if (hf && *hf && stat (hf, &buf) == 0)
277 history_lines_in_file = where_history ();
281 #ifdef INCLUDE_UNUSED
282 /* Write the existing history out to the history file. */
289 hf = get_string_value ("HISTFILE");
290 if (hf && *hf && stat (hf, &buf) == 0)
292 /* Append only the lines that occurred this session to
296 if (history_lines_this_session < where_history () || force_append_history)
297 append_history (history_lines_this_session, hf);
301 sv_histsize ("HISTFILESIZE");
307 maybe_append_history (filename)
313 result = EXECUTION_SUCCESS;
314 if (history_lines_this_session && (history_lines_this_session < where_history ()))
316 /* If the filename was supplied, then create it if necessary. */
317 if (stat (filename, &buf) == -1 && errno == ENOENT)
319 fd = open (filename, O_WRONLY|O_CREAT, 0600);
322 builtin_error (_("%s: cannot create: %s"), filename, strerror (errno));
323 return (EXECUTION_FAILURE);
327 result = append_history (history_lines_this_session, filename);
328 history_lines_in_file += history_lines_this_session;
329 history_lines_this_session = 0;
334 /* If this is an interactive shell, then append the lines executed
335 this session to the history file. */
337 maybe_save_shell_history ()
344 if (history_lines_this_session)
346 hf = get_string_value ("HISTFILE");
350 /* If the file doesn't exist, then create it. */
351 if (stat (hf, &buf) == -1)
354 file = open (hf, O_CREAT | O_TRUNC | O_WRONLY, 0600);
359 /* Now actually append the lines if the history hasn't been
360 stifled. If the history has been stifled, rewrite the
363 if (history_lines_this_session <= where_history () || force_append_history)
365 result = append_history (history_lines_this_session, hf);
366 history_lines_in_file += history_lines_this_session;
370 result = write_history (hf);
371 history_lines_in_file = history_lines_this_session;
373 history_lines_this_session = 0;
375 sv_histsize ("HISTFILESIZE");
381 #if defined (READLINE)
382 /* Tell readline () that we have some text for it to edit. */
387 if (bash_input.type == st_stdin)
390 #endif /* READLINE */
392 /* Return 1 if this line needs history expansion. */
394 history_expansion_p (line)
399 for (s = line; *s; s++)
400 if (*s == history_expansion_char || *s == history_subst_char)
405 /* Do pre-processing on LINE. If PRINT_CHANGES is non-zero, then
406 print the results of expanding the line if there were any changes.
407 If there is an error, return NULL, otherwise the expanded line is
408 returned. If ADDIT is non-zero the line is added to the history
409 list after history expansion. ADDIT is just a suggestion;
410 REMEMBER_ON_HISTORY can veto, and does.
411 Right now this does history expansion. */
413 pre_process_line (line, print_changes, addit)
415 int print_changes, addit;
424 # if defined (BANG_HISTORY)
425 /* History expand the line. If this results in no errors, then
426 add that line to the history if ADDIT is non-zero. */
427 if (!history_expansion_inhibited && history_expansion && history_expansion_p (line))
429 expanded = history_expand (line, &history_value);
436 internal_error ("%s", history_value);
437 #if defined (READLINE)
438 else if (hist_verify == 0 || expanded == 2)
442 fprintf (stderr, "%s\n", history_value);
445 /* If there was an error, return NULL. */
446 if (expanded < 0 || expanded == 2) /* 2 == print only */
448 # if defined (READLINE)
449 if (expanded == 2 && rl_dispatching == 0 && *history_value)
451 if (expanded == 2 && *history_value)
452 # endif /* !READLINE */
453 maybe_add_history (history_value);
455 free (history_value);
457 # if defined (READLINE)
458 /* New hack. We can allow the user to edit the
459 failed history expansion. */
460 if (history_reediting && expanded < 0 && rl_done)
462 # endif /* READLINE */
463 return ((char *)NULL);
466 # if defined (READLINE)
467 if (hist_verify && expanded == 1)
469 re_edit (history_value);
470 return ((char *)NULL);
475 /* Let other expansions know that return_value can be free'ed,
476 and that a line has been added to the history list. Note
477 that we only add lines that have something in them. */
479 return_value = history_value;
481 # endif /* BANG_HISTORY */
483 if (addit && remember_on_history && *return_value)
484 maybe_add_history (return_value);
488 return_value = savestring (line);
491 return (return_value);
494 /* Return 1 if the first non-whitespace character in LINE is a `#', indicating
495 * that the line is a shell comment. */
502 for (p = line; p && *p && whitespace (*p); p++)
504 return (p && *p == '#');
507 #ifdef INCLUDE_UNUSED
508 /* Remove shell comments from LINE. A `#' and anything after it is a comment.
509 This isn't really useful yet, since it doesn't handle quoting. */
511 filter_comments (line)
516 for (p = line; p && *p && *p != '#'; p++)
524 /* Check LINE against what HISTCONTROL says to do. Returns 1 if the line
525 should be saved; 0 if it should be discarded. */
527 check_history_control (line)
533 if (history_control == 0)
536 /* ignorespace or ignoreboth */
537 if ((history_control & HC_IGNSPACE) && *line == ' ')
540 /* ignoredups or ignoreboth */
541 if (history_control & HC_IGNDUPS)
544 temp = previous_history ();
546 r = (temp == 0 || STREQ (temp->line, line) == 0);
557 /* Remove all entries matching LINE from the history list. Triggered when
558 HISTCONTROL includes `erasedups'. */
567 while (temp = previous_history ())
569 if (STREQ (temp->line, line))
571 r = where_history ();
578 /* Add LINE to the history list, handling possibly multi-line compound
579 commands. We note whether or not we save the first line of each command
580 (which is usually the entire command and history entry), and don't add
581 the second and subsequent lines of a multi-line compound command if we
582 didn't save the first line. We don't usually save shell comment lines in
583 compound commands in the history, because they could have the effect of
584 commenting out the rest of the command when the entire command is saved as
585 a single history entry (when COMMAND_ORIENTED_HISTORY is enabled). If
586 LITERAL_HISTORY is set, we're saving lines in the history with embedded
587 newlines, so it's OK to save comment lines. We also make sure to save
588 multiple-line quoted strings or other constructs. */
590 maybe_add_history (line)
593 hist_last_line_added = 0;
595 /* Don't use the value of history_control to affect the second
596 and subsequent lines of a multi-line command (old code did
597 this only when command_oriented_history is enabled). */
598 if (current_command_line_count > 1)
600 if (current_command_first_line_saved &&
601 (literal_history || dstack.delimiter_depth != 0 || shell_comment (line) == 0))
602 bash_add_history (line);
606 /* This is the first line of a (possible multi-line) command. Note whether
607 or not we should save the first line and remember it. */
608 current_command_first_line_saved = check_add_history (line, 0);
611 /* Just check LINE against HISTCONTROL and HISTIGNORE and add it to the
612 history if it's OK. Used by `history -s' as well as maybe_add_history().
613 Returns 1 if the line was saved in the history, 0 otherwise. */
615 check_add_history (line, force)
619 if (check_history_control (line) && history_should_ignore (line) == 0)
621 /* We're committed to saving the line. If the user has requested it,
622 remove other matching lines from the history. */
623 if (history_control & HC_ERASEDUPS)
628 really_add_history (line);
632 bash_add_history (line);
638 /* Add a line to the history list.
639 The variable COMMAND_ORIENTED_HISTORY controls the style of history
640 remembering; when non-zero, and LINE is not the first line of a
641 complete parser construct, append LINE to the last history line instead
642 of adding it as a new line. */
644 bash_add_history (line)
647 int add_it, offset, curlen;
648 HIST_ENTRY *current, *old;
649 char *chars_to_add, *new_line;
652 if (command_oriented_history && current_command_line_count > 1)
654 chars_to_add = literal_history ? "\n" : history_delimiting_chars ();
657 current = previous_history ();
661 /* If the previous line ended with an escaped newline (escaped
662 with backslash, but otherwise unquoted), then remove the quoted
663 newline, since that is what happens when the line is parsed. */
664 curlen = strlen (current->line);
666 if (dstack.delimiter_depth == 0 && current->line[curlen - 1] == '\\' &&
667 current->line[curlen - 2] != '\\')
669 current->line[curlen - 1] = '\0';
674 new_line = (char *)xmalloc (1
677 + strlen (chars_to_add));
678 sprintf (new_line, "%s%s%s", current->line, chars_to_add, line);
679 offset = where_history ();
680 old = replace_history_entry (offset, new_line, current->data);
684 free_history_entry (old);
691 really_add_history (line);
697 really_add_history (line)
700 hist_last_line_added = 1;
702 history_lines_this_session++;
709 return (get_string_value ("HISTSIZE") ? history_base + where_history () : 1);
718 for (p = s; p && *p; p++)
729 histignore_item_func (ign)
732 if (should_expand (ign->val))
733 ign->flags |= HIGN_EXPAND;
738 setup_history_ignore (varname)
741 setup_ignore_patterns (&histignore);
745 last_history_entry ()
750 he = previous_history ();
760 he = last_history_entry ();
762 return ((char *)NULL);
767 expand_histignore_pattern (pat)
773 phe = last_history_entry ();
775 if (phe == (HIST_ENTRY *)0)
776 return (savestring (pat));
778 ret = strcreplace (pat, '&', phe->line, 1);
783 /* Return 1 if we should not put LINE into the history according to the
784 patterns in HISTIGNORE. */
786 history_should_ignore (line)
789 register int i, match;
792 if (histignore.num_ignores == 0)
795 for (i = match = 0; i < histignore.num_ignores; i++)
797 if (histignore.ignores[i].flags & HIGN_EXPAND)
798 npat = expand_histignore_pattern (histignore.ignores[i].val);
800 npat = histignore.ignores[i].val;
802 match = strmatch (npat, line, FNMATCH_EXTFLAG) != FNM_NOMATCH;
804 if (histignore.ignores[i].flags & HIGN_EXPAND)