PostgreSQL Source Code git master
Data Structures | Typedefs | Enumerations | Functions
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

enum 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

enum 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 60 of file filter.c.

61{
62 if (!fstate)
63 return;
64
65 free(fstate->linebuff.data);
66 fstate->linebuff.data = NULL;
67
68 if (fstate->fp && fstate->fp != stdin)
69 {
70 if (fclose(fstate->fp) != 0)
71 pg_log_error("could not close filter file \"%s\": %m", fstate->filename);
72
73 fstate->fp = NULL;
74 }
75}
#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
char * data
Definition: stringinfo.h:48

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 36 of file filter.c.

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

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 82 of file filter.c.

83{
84 switch (fot)
85 {
87 return "comment or empty line";
89 return "table data";
91 return "table data and children";
93 return "database";
95 return "extension";
97 return "foreign data";
99 return "function";
101 return "index";
103 return "schema";
105 return "table";
107 return "table and children";
109 return "trigger";
110 }
111
112 /* should never get here */
114}
#define pg_unreachable()
Definition: c.h:331

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 392 of file filter.c.

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

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(), and 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,
  ... 
)

AltStyle によって変換されたページ (->オリジナル) /