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"
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;
83 int enable_history_list
= 1; /* value for `set -o history' */
85 /* The number of lines that Bash has added to this history session. The
86 difference between the number of the top element in the history list
87 (offset from history_base) and the number of lines in the history file.
88 Appending this session's history to the history file resets this to 0. */
89 int history_lines_this_session
;
91 /* The number of lines that Bash has read from the history file. */
92 int history_lines_in_file
;
94 #if defined (BANG_HISTORY)
95 /* Non-zero means do no history expansion on this line, regardless
96 of what history_expansion says. */
97 int history_expansion_inhibited
;
100 /* With the old default, every line was saved in the history individually.
101 I.e., if the user enters:
106 Each line will be individually saved in the history.
113 If the variable command_oriented_history is set, multiple lines
114 which form one command will be saved as one history entry.
125 The user can then recall the whole command all at once instead
126 of just being able to recall one line at a time.
128 This is now enabled by default.
130 int command_oriented_history
= 1;
132 /* Set to 1 if the first line of a possibly-multi-line command was saved
133 in the history list. Managed by maybe_add_history(), but global so
134 the history-manipluating builtins can see it. */
135 int current_command_first_line_saved
= 0;
137 /* Non-zero means to store newlines in the history list when using
138 command_oriented_history rather than trying to use semicolons. */
141 /* Non-zero means to append the history to the history file at shell
142 exit, even if the history has been stifled. */
143 int force_append_history
;
145 /* A nit for picking at history saving. Flags have the following values:
147 Value == 0 means save all lines parsed by the shell on the history.
148 Value & HC_IGNSPACE means save all lines that do not start with a space.
149 Value & HC_IGNDUPS means save all lines that do not match the last
151 Value & HC_ERASEDUPS means to remove all other matching lines from the
152 history list before saving the latest line. */
155 /* Set to 1 if the last command was added to the history list successfully
156 as a separate history entry; set to 0 if the line was ignored or added
157 to a previous entry as part of command-oriented-history processing. */
158 int hist_last_line_added
;
160 /* Set to 1 if builtins/history.def:push_history added the last history
162 int hist_last_line_pushed
;
164 #if defined (READLINE)
165 /* If non-zero, and readline is being used, the user is offered the
166 chance to re-edit a failed history expansion. */
167 int history_reediting
;
169 /* If non-zero, and readline is being used, don't directly execute a
170 line with history substitution. Reload it into the editing buffer
171 instead and let the user further edit and confirm with a newline. */
174 #endif /* READLINE */
176 /* Non-zero means to not save function definitions in the history list. */
177 int dont_save_function_defs
;
179 /* Variables declared in other files used here. */
180 extern int current_command_line_count
;
182 extern struct dstack dstack
;
184 static int bash_history_inhibit_expansion
__P((char *, int));
185 #if defined (READLINE)
186 static void re_edit
__P((char *));
188 static int history_expansion_p
__P((char *));
189 static int shell_comment
__P((char *));
190 static int should_expand
__P((char *));
191 static HIST_ENTRY
*last_history_entry
__P((void));
192 static char *expand_histignore_pattern
__P((char *));
193 static int history_should_ignore
__P((char *));
195 /* Is the history expansion starting at string[i] one that should not
198 bash_history_inhibit_expansion (string
, i
)
202 /* The shell uses ! as a pattern negation character in globbing [...]
203 expressions, so let those pass without expansion. */
204 if (i
> 0 && (string
[i
- 1] == '[') && member (']', string
+ i
+ 1))
206 /* The shell uses ! as the indirect expansion character, so let those
207 expansions pass as well. */
208 else if (i
> 1 && string
[i
- 1] == '{' && string
[i
- 2] == '$' &&
209 member ('}', string
+ i
+ 1))
211 #if defined (EXTENDED_GLOB)
212 else if (extended_glob
&& i
> 1 && string
[i
+1] == '(' && member (')', string
+ i
+ 2))
220 bash_initialize_history ()
222 history_quotes_inhibit_expansion
= 1;
223 history_search_delimiter_chars
= ";&()|<>";
224 history_inhibit_expansion_function
= bash_history_inhibit_expansion
;
225 #if defined (BANG_HISTORY)
226 sv_histchars ("histchars");
231 bash_history_reinit (interact
)
234 #if defined (BANG_HISTORY)
235 history_expansion
= interact
!= 0;
236 history_expansion_inhibited
= 1;
238 remember_on_history
= enable_history_list
= interact
!= 0;
239 history_inhibit_expansion_function
= bash_history_inhibit_expansion
;
243 bash_history_disable ()
245 remember_on_history
= 0;
246 #if defined (BANG_HISTORY)
247 history_expansion_inhibited
= 1;
252 bash_history_enable ()
254 remember_on_history
= 1;
255 #if defined (BANG_HISTORY)
256 history_expansion_inhibited
= 0;
258 history_inhibit_expansion_function
= bash_history_inhibit_expansion
;
259 sv_history_control ("HISTCONTROL");
260 sv_histignore ("HISTIGNORE");
263 /* Load the history list from the history file. */
269 /* Truncate history file for interactive shells which desire it.
270 Note that the history file is automatically truncated to the
271 size of HISTSIZE if the user does not explicitly set the size
273 set_if_not ("HISTSIZE", "500");
274 sv_histsize ("HISTSIZE");
276 set_if_not ("HISTFILESIZE", get_string_value ("HISTSIZE"));
277 sv_histsize ("HISTFILESIZE");
279 /* Read the history in HISTFILE into the history list. */
280 hf
= get_string_value ("HISTFILE");
282 if (hf
&& *hf
&& file_exists (hf
))
286 history_lines_in_file
= where_history ();
291 bash_clear_history ()
294 history_lines_this_session
= 0;
297 /* Delete and free the history list entry at offset I. */
299 bash_delete_histent (i
)
304 discard
= remove_history (i
);
306 free_history_entry (discard
);
307 history_lines_this_session
--;
313 bash_delete_last_history ()
316 HIST_ENTRY
**hlist
, *histent
;
319 hlist
= history_list ();
323 for (i
= 0; hlist
[i
]; i
++)
327 /* History_get () takes a parameter that must be offset by history_base. */
328 histent
= history_get (history_base
+ i
); /* Don't free this */
332 r
= bash_delete_histent (i
);
334 if (where_history () > history_length
)
335 history_set_pos (history_length
);
340 #ifdef INCLUDE_UNUSED
341 /* Write the existing history out to the history file. */
347 hf
= get_string_value ("HISTFILE");
348 if (hf
&& *hf
&& file_exists (hf
))
350 /* Append only the lines that occurred this session to
354 if (history_lines_this_session
< where_history () || force_append_history
)
355 append_history (history_lines_this_session
, hf
);
359 sv_histsize ("HISTFILESIZE");
365 maybe_append_history (filename
)
371 result
= EXECUTION_SUCCESS
;
372 if (history_lines_this_session
&& (history_lines_this_session
< where_history ()))
374 /* If the filename was supplied, then create it if necessary. */
375 if (stat (filename
, &buf
) == -1 && errno
== ENOENT
)
377 fd
= open (filename
, O_WRONLY
|O_CREAT
, 0600);
380 builtin_error (_("%s: cannot create: %s"), filename
, strerror (errno
));
381 return (EXECUTION_FAILURE
);
385 result
= append_history (history_lines_this_session
, filename
);
386 history_lines_in_file
+= history_lines_this_session
;
387 history_lines_this_session
= 0;
392 /* If this is an interactive shell, then append the lines executed
393 this session to the history file. */
395 maybe_save_shell_history ()
401 if (history_lines_this_session
)
403 hf
= get_string_value ("HISTFILE");
407 /* If the file doesn't exist, then create it. */
408 if (file_exists (hf
) == 0)
411 file
= open (hf
, O_CREAT
| O_TRUNC
| O_WRONLY
, 0600);
416 /* Now actually append the lines if the history hasn't been
417 stifled. If the history has been stifled, rewrite the
420 if (history_lines_this_session
<= where_history () || force_append_history
)
422 result
= append_history (history_lines_this_session
, hf
);
423 history_lines_in_file
+= history_lines_this_session
;
427 result
= write_history (hf
);
428 history_lines_in_file
= history_lines_this_session
;
430 history_lines_this_session
= 0;
432 sv_histsize ("HISTFILESIZE");
438 #if defined (READLINE)
439 /* Tell readline () that we have some text for it to edit. */
444 if (bash_input
.type
== st_stdin
)
447 #endif /* READLINE */
449 /* Return 1 if this line needs history expansion. */
451 history_expansion_p (line
)
456 for (s
= line
; *s
; s
++)
457 if (*s
== history_expansion_char
|| *s
== history_subst_char
)
462 /* Do pre-processing on LINE. If PRINT_CHANGES is non-zero, then
463 print the results of expanding the line if there were any changes.
464 If there is an error, return NULL, otherwise the expanded line is
465 returned. If ADDIT is non-zero the line is added to the history
466 list after history expansion. ADDIT is just a suggestion;
467 REMEMBER_ON_HISTORY can veto, and does.
468 Right now this does history expansion. */
470 pre_process_line (line
, print_changes
, addit
)
472 int print_changes
, addit
;
481 # if defined (BANG_HISTORY)
482 /* History expand the line. If this results in no errors, then
483 add that line to the history if ADDIT is non-zero. */
484 if (!history_expansion_inhibited
&& history_expansion
&& history_expansion_p (line
))
486 expanded
= history_expand (line
, &history_value
);
493 internal_error ("%s", history_value
);
494 #if defined (READLINE)
495 else if (hist_verify
== 0 || expanded
== 2)
499 fprintf (stderr
, "%s\n", history_value
);
502 /* If there was an error, return NULL. */
503 if (expanded
< 0 || expanded
== 2) /* 2 == print only */
505 # if defined (READLINE)
506 if (expanded
== 2 && rl_dispatching
== 0 && *history_value
)
508 if (expanded
== 2 && *history_value
)
509 # endif /* !READLINE */
510 maybe_add_history (history_value
);
512 free (history_value
);
514 # if defined (READLINE)
515 /* New hack. We can allow the user to edit the
516 failed history expansion. */
517 if (history_reediting
&& expanded
< 0 && rl_done
)
519 # endif /* READLINE */
520 return ((char *)NULL
);
523 # if defined (READLINE)
524 if (hist_verify
&& expanded
== 1)
526 re_edit (history_value
);
527 return ((char *)NULL
);
532 /* Let other expansions know that return_value can be free'ed,
533 and that a line has been added to the history list. Note
534 that we only add lines that have something in them. */
536 return_value
= history_value
;
538 # endif /* BANG_HISTORY */
540 if (addit
&& remember_on_history
&& *return_value
)
541 maybe_add_history (return_value
);
545 return_value
= savestring (line
);
548 return (return_value
);
551 /* Return 1 if the first non-whitespace character in LINE is a `#', indicating
552 * that the line is a shell comment. */
559 for (p
= line
; p
&& *p
&& whitespace (*p
); p
++)
561 return (p
&& *p
== '#');
564 #ifdef INCLUDE_UNUSED
565 /* Remove shell comments from LINE. A `#' and anything after it is a comment.
566 This isn't really useful yet, since it doesn't handle quoting. */
568 filter_comments (line
)
573 for (p
= line
; p
&& *p
&& *p
!= '#'; p
++)
581 /* Check LINE against what HISTCONTROL says to do. Returns 1 if the line
582 should be saved; 0 if it should be discarded. */
584 check_history_control (line
)
590 if (history_control
== 0)
593 /* ignorespace or ignoreboth */
594 if ((history_control
& HC_IGNSPACE
) && *line
== ' ')
597 /* ignoredups or ignoreboth */
598 if (history_control
& HC_IGNDUPS
)
601 temp
= previous_history ();
603 r
= (temp
== 0 || STREQ (temp
->line
, line
) == 0);
614 /* Remove all entries matching LINE from the history list. Triggered when
615 HISTCONTROL includes `erasedups'. */
624 while (temp
= previous_history ())
626 if (STREQ (temp
->line
, line
))
628 r
= where_history ();
635 /* Add LINE to the history list, handling possibly multi-line compound
636 commands. We note whether or not we save the first line of each command
637 (which is usually the entire command and history entry), and don't add
638 the second and subsequent lines of a multi-line compound command if we
639 didn't save the first line. We don't usually save shell comment lines in
640 compound commands in the history, because they could have the effect of
641 commenting out the rest of the command when the entire command is saved as
642 a single history entry (when COMMAND_ORIENTED_HISTORY is enabled). If
643 LITERAL_HISTORY is set, we're saving lines in the history with embedded
644 newlines, so it's OK to save comment lines. We also make sure to save
645 multiple-line quoted strings or other constructs. */
647 maybe_add_history (line
)
650 hist_last_line_added
= 0;
652 /* Don't use the value of history_control to affect the second
653 and subsequent lines of a multi-line command (old code did
654 this only when command_oriented_history is enabled). */
655 if (current_command_line_count
> 1)
657 if (current_command_first_line_saved
&&
658 (literal_history
|| dstack
.delimiter_depth
!= 0 || shell_comment (line
) == 0))
659 bash_add_history (line
);
663 /* This is the first line of a (possible multi-line) command. Note whether
664 or not we should save the first line and remember it. */
665 current_command_first_line_saved
= check_add_history (line
, 0);
668 /* Just check LINE against HISTCONTROL and HISTIGNORE and add it to the
669 history if it's OK. Used by `history -s' as well as maybe_add_history().
670 Returns 1 if the line was saved in the history, 0 otherwise. */
672 check_add_history (line
, force
)
676 if (check_history_control (line
) && history_should_ignore (line
) == 0)
678 /* We're committed to saving the line. If the user has requested it,
679 remove other matching lines from the history. */
680 if (history_control
& HC_ERASEDUPS
)
685 really_add_history (line
);
689 bash_add_history (line
);
695 /* Add a line to the history list.
696 The variable COMMAND_ORIENTED_HISTORY controls the style of history
697 remembering; when non-zero, and LINE is not the first line of a
698 complete parser construct, append LINE to the last history line instead
699 of adding it as a new line. */
701 bash_add_history (line
)
704 int add_it
, offset
, curlen
;
705 HIST_ENTRY
*current
, *old
;
706 char *chars_to_add
, *new_line
;
709 if (command_oriented_history
&& current_command_line_count
> 1)
711 chars_to_add
= literal_history
? "\n" : history_delimiting_chars ();
714 current
= previous_history ();
718 /* If the previous line ended with an escaped newline (escaped
719 with backslash, but otherwise unquoted), then remove the quoted
720 newline, since that is what happens when the line is parsed. */
721 curlen
= strlen (current
->line
);
723 if (dstack
.delimiter_depth
== 0 && current
->line
[curlen
- 1] == '\\' &&
724 current
->line
[curlen
- 2] != '\\')
726 current
->line
[curlen
- 1] = '\0';
731 new_line
= (char *)xmalloc (1
734 + strlen (chars_to_add
));
735 sprintf (new_line
, "%s%s%s", current
->line
, chars_to_add
, line
);
736 offset
= where_history ();
737 old
= replace_history_entry (offset
, new_line
, current
->data
);
741 free_history_entry (old
);
748 really_add_history (line
);
754 really_add_history (line
)
757 hist_last_line_added
= 1;
758 hist_last_line_pushed
= 0;
760 history_lines_this_session
++;
767 return (remember_on_history
? history_base
+ where_history () : 1);
776 for (p
= s
; p
&& *p
; p
++)
787 histignore_item_func (ign
)
790 if (should_expand (ign
->val
))
791 ign
->flags
|= HIGN_EXPAND
;
796 setup_history_ignore (varname
)
799 setup_ignore_patterns (&histignore
);
803 last_history_entry ()
808 he
= previous_history ();
818 he
= last_history_entry ();
820 return ((char *)NULL
);
825 expand_histignore_pattern (pat
)
831 phe
= last_history_entry ();
833 if (phe
== (HIST_ENTRY
*)0)
834 return (savestring (pat
));
836 ret
= strcreplace (pat
, '&', phe
->line
, 1);
841 /* Return 1 if we should not put LINE into the history according to the
842 patterns in HISTIGNORE. */
844 history_should_ignore (line
)
847 register int i
, match
;
850 if (histignore
.num_ignores
== 0)
853 for (i
= match
= 0; i
< histignore
.num_ignores
; i
++)
855 if (histignore
.ignores
[i
].flags
& HIGN_EXPAND
)
856 npat
= expand_histignore_pattern (histignore
.ignores
[i
].val
);
858 npat
= histignore
.ignores
[i
].val
;
860 match
= strmatch (npat
, line
, FNMATCH_EXTFLAG
) != FNM_NOMATCH
;
862 if (histignore
.ignores
[i
].flags
& HIGN_EXPAND
)