PostgreSQL Source Code  git master
filter.h File Reference
#include "lib/stringinfo.h"
Include dependency graph for filter.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  FilterStateData
 

Typedefs

typedef void(* exit_function) (int status)
 

Enumerations

enum  FilterCommandType { FILTER_COMMAND_TYPE_NONE , FILTER_COMMAND_TYPE_INCLUDE , FILTER_COMMAND_TYPE_EXCLUDE }
 
enum  FilterObjectType {
  FILTER_OBJECT_TYPE_NONE , FILTER_OBJECT_TYPE_TABLE_DATA , FILTER_OBJECT_TYPE_TABLE_DATA_AND_CHILDREN , FILTER_OBJECT_TYPE_DATABASE ,
  FILTER_OBJECT_TYPE_EXTENSION , FILTER_OBJECT_TYPE_FOREIGN_DATA , FILTER_OBJECT_TYPE_FUNCTION , FILTER_OBJECT_TYPE_INDEX ,
  FILTER_OBJECT_TYPE_SCHEMA , FILTER_OBJECT_TYPE_TABLE , FILTER_OBJECT_TYPE_TABLE_AND_CHILDREN , FILTER_OBJECT_TYPE_TRIGGER
}
 

Functions

const char * filter_object_type_name (FilterObjectType fot)
 
void filter_init (FilterStateData *fstate, const char *filename, exit_function f_exit)
 
void filter_free (FilterStateData *fstate)
 
void pg_log_filter_error (FilterStateData *fstate, const char *fmt,...) pg_attribute_printf(2
 
void bool filter_read_item (FilterStateData *fstate, char **objname, FilterCommandType *comtype, FilterObjectType *objtype)
 

Typedef Documentation

◆ exit_function

typedef void(* exit_function) (int status)

Definition at line 20 of file filter.h.

Enumeration Type Documentation

◆ FilterCommandType

Enumerator
FILTER_COMMAND_TYPE_NONE 
FILTER_COMMAND_TYPE_INCLUDE 
FILTER_COMMAND_TYPE_EXCLUDE 

Definition at line 37 of file filter.h.

38 {
FilterCommandType
Definition: filter.h:38
@ FILTER_COMMAND_TYPE_NONE
Definition: filter.h:39
@ FILTER_COMMAND_TYPE_EXCLUDE
Definition: filter.h:41
@ FILTER_COMMAND_TYPE_INCLUDE
Definition: filter.h:40

◆ FilterObjectType

Enumerator
FILTER_OBJECT_TYPE_NONE 
FILTER_OBJECT_TYPE_TABLE_DATA 
FILTER_OBJECT_TYPE_TABLE_DATA_AND_CHILDREN 
FILTER_OBJECT_TYPE_DATABASE 
FILTER_OBJECT_TYPE_EXTENSION 
FILTER_OBJECT_TYPE_FOREIGN_DATA 
FILTER_OBJECT_TYPE_FUNCTION 
FILTER_OBJECT_TYPE_INDEX 
FILTER_OBJECT_TYPE_SCHEMA 
FILTER_OBJECT_TYPE_TABLE 
FILTER_OBJECT_TYPE_TABLE_AND_CHILDREN 
FILTER_OBJECT_TYPE_TRIGGER 

Definition at line 47 of file filter.h.

48 {
FilterObjectType
Definition: filter.h:48
@ FILTER_OBJECT_TYPE_TABLE_DATA_AND_CHILDREN
Definition: filter.h:51
@ FILTER_OBJECT_TYPE_SCHEMA
Definition: filter.h:57
@ FILTER_OBJECT_TYPE_INDEX
Definition: filter.h:56
@ FILTER_OBJECT_TYPE_TRIGGER
Definition: filter.h:60
@ FILTER_OBJECT_TYPE_FOREIGN_DATA
Definition: filter.h:54
@ FILTER_OBJECT_TYPE_DATABASE
Definition: filter.h:52
@ FILTER_OBJECT_TYPE_FUNCTION
Definition: filter.h:55
@ FILTER_OBJECT_TYPE_TABLE_DATA
Definition: filter.h:50
@ FILTER_OBJECT_TYPE_NONE
Definition: filter.h:49
@ FILTER_OBJECT_TYPE_TABLE_AND_CHILDREN
Definition: filter.h:59
@ FILTER_OBJECT_TYPE_EXTENSION
Definition: filter.h:53
@ FILTER_OBJECT_TYPE_TABLE
Definition: filter.h:58

Function Documentation

◆ filter_free()

void filter_free ( FilterStateData fstate)

Definition at line 61 of file filter.c.

62 {
63  if (!fstate)
64  return;
65 
66  free(fstate->linebuff.data);
67  fstate->linebuff.data = NULL;
68 
69  if (fstate->fp && fstate->fp != stdin)
70  {
71  if (fclose(fstate->fp) != 0)
72  pg_log_error("could not close filter file \"%s\": %m", fstate->filename);
73 
74  fstate->fp = NULL;
75  }
76 }
#define free(a)
Definition: header.h:65
#define pg_log_error(...)
Definition: logging.h:106
StringInfoData linebuff
Definition: filter.h:31
const char * filename
Definition: filter.h:28
FILE * fp
Definition: filter.h:27

References StringInfoData::data, FilterStateData::filename, FilterStateData::fp, free, FilterStateData::linebuff, and pg_log_error.

Referenced by read_dump_filters(), read_dumpall_filters(), and read_restore_filters().

◆ filter_init()

void filter_init ( FilterStateData fstate,
const char *  filename,
exit_function  f_exit 
)

Definition at line 37 of file filter.c.

38 {
39  fstate->filename = filename;
40  fstate->lineno = 0;
41  fstate->exit_nicely = f_exit;
42  initStringInfo(&fstate->linebuff);
43 
44  if (strcmp(filename, "-") != 0)
45  {
46  fstate->fp = fopen(filename, "r");
47  if (!fstate->fp)
48  {
49  pg_log_error("could not open filter file \"%s\": %m", filename);
50  fstate->exit_nicely(1);
51  }
52  }
53  else
54  fstate->fp = stdin;
55 }
static char * filename
Definition: pg_dumpall.c:121
void initStringInfo(StringInfo str)
Definition: stringinfo.c:59
exit_function exit_nicely
Definition: filter.h:29

References FilterStateData::exit_nicely, FilterStateData::filename, filename, FilterStateData::fp, initStringInfo(), FilterStateData::linebuff, FilterStateData::lineno, and pg_log_error.

Referenced by read_dump_filters(), read_dumpall_filters(), and read_restore_filters().

◆ filter_object_type_name()

const char* filter_object_type_name ( FilterObjectType  fot)

Definition at line 83 of file filter.c.

84 {
85  switch (fot)
86  {
88  return "comment or empty line";
90  return "table data";
92  return "table data and children";
94  return "database";
96  return "extension";
98  return "foreign data";
100  return "function";
102  return "index";
104  return "schema";
106  return "table";
108  return "table and children";
110  return "trigger";
111  }
112 
113  /* should never get here */
114  pg_unreachable();
115 }
#define pg_unreachable()
Definition: c.h:283

References FILTER_OBJECT_TYPE_DATABASE, FILTER_OBJECT_TYPE_EXTENSION, FILTER_OBJECT_TYPE_FOREIGN_DATA, FILTER_OBJECT_TYPE_FUNCTION, FILTER_OBJECT_TYPE_INDEX, FILTER_OBJECT_TYPE_NONE, FILTER_OBJECT_TYPE_SCHEMA, FILTER_OBJECT_TYPE_TABLE, FILTER_OBJECT_TYPE_TABLE_AND_CHILDREN, FILTER_OBJECT_TYPE_TABLE_DATA, FILTER_OBJECT_TYPE_TABLE_DATA_AND_CHILDREN, FILTER_OBJECT_TYPE_TRIGGER, and pg_unreachable.

Referenced by read_dump_filters(), read_dumpall_filters(), and read_restore_filters().

◆ filter_read_item()

void bool filter_read_item ( FilterStateData fstate,
char **  objname,
FilterCommandType comtype,
FilterObjectType objtype 
)

Definition at line 388 of file filter.c.

392 {
393  if (pg_get_line_buf(fstate->fp, &fstate->linebuff))
394  {
395  const char *str = fstate->linebuff.data;
396  const char *keyword;
397  int size;
398  PQExpBufferData pattern;
399 
400  fstate->lineno++;
401 
402  /* Skip initial white spaces */
403  while (isspace((unsigned char) *str))
404  str++;
405 
406  /*
407  * Skip empty lines or lines where the first non-whitespace character
408  * is a hash indicating a comment.
409  */
410  if (*str != '\0' && *str != '#')
411  {
412  /*
413  * First we expect sequence of two keywords, {include|exclude}
414  * followed by the object type to operate on.
415  */
416  keyword = filter_get_keyword(&str, &size);
417  if (!keyword)
418  {
419  pg_log_filter_error(fstate,
420  _("no filter command found (expected \"include\" or \"exclude\")"));
421  fstate->exit_nicely(1);
422  }
423 
424  if (is_keyword_str("include", keyword, size))
425  *comtype = FILTER_COMMAND_TYPE_INCLUDE;
426  else if (is_keyword_str("exclude", keyword, size))
427  *comtype = FILTER_COMMAND_TYPE_EXCLUDE;
428  else
429  {
430  pg_log_filter_error(fstate,
431  _("invalid filter command (expected \"include\" or \"exclude\")"));
432  fstate->exit_nicely(1);
433  }
434 
435  keyword = filter_get_keyword(&str, &size);
436  if (!keyword)
437  {
438  pg_log_filter_error(fstate, _("missing filter object type"));
439  fstate->exit_nicely(1);
440  }
441 
442  if (!get_object_type(keyword, size, objtype))
443  {
444  pg_log_filter_error(fstate,
445  _("unsupported filter object type: \"%.*s\""), size, keyword);
446  fstate->exit_nicely(1);
447  }
448 
449  initPQExpBuffer(&pattern);
450 
451  str = read_pattern(fstate, str, &pattern);
452  *objname = pattern.data;
453  }
454  else
455  {
456  *objname = NULL;
457  *comtype = FILTER_COMMAND_TYPE_NONE;
458  *objtype = FILTER_OBJECT_TYPE_NONE;
459  }
460 
461  return true;
462  }
463 
464  if (ferror(fstate->fp))
465  {
466  pg_log_error("could not read from filter file \"%s\": %m", fstate->filename);
467  fstate->exit_nicely(1);
468  }
469 
470  return false;
471 }
#define _(x)
Definition: elog.c:91
static bool get_object_type(const char *keyword, int size, FilterObjectType *objtype)
Definition: filter.c:123
#define is_keyword_str(cstr, str, bytes)
Definition: filter.c:23
void pg_log_filter_error(FilterStateData *fstate, const char *fmt,...)
Definition: filter.c:155
static const char * filter_get_keyword(const char **line, int *size)
Definition: filter.c:179
static const char * read_pattern(FilterStateData *fstate, const char *str, PQExpBuffer pattern)
Definition: filter.c:298
bool pg_get_line_buf(FILE *stream, StringInfo buf)
Definition: pg_get_line.c:95
void initPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:90
static pg_noinline void Size size
Definition: slab.c:607

References _, StringInfoData::data, PQExpBufferData::data, FilterStateData::exit_nicely, FilterStateData::filename, FILTER_COMMAND_TYPE_EXCLUDE, FILTER_COMMAND_TYPE_INCLUDE, FILTER_COMMAND_TYPE_NONE, filter_get_keyword(), FILTER_OBJECT_TYPE_NONE, FilterStateData::fp, get_object_type(), initPQExpBuffer(), is_keyword_str, FilterStateData::linebuff, FilterStateData::lineno, pg_get_line_buf(), pg_log_error, pg_log_filter_error(), read_pattern(), size, and generate_unaccent_rules::str.

Referenced by read_dump_filters(), read_dumpall_filters(), and read_restore_filters().

◆ pg_log_filter_error()

void pg_log_filter_error ( FilterStateData fstate,
const char *  fmt,
  ... 
)