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.

{
    FILTER_COMMAND_TYPE_NONE,
    FILTER_COMMAND_TYPE_INCLUDE,
    FILTER_COMMAND_TYPE_EXCLUDE,
} FilterCommandType;

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.

{
    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,
} FilterObjectType;

Function Documentation

filter_free()

void filter_free

(

FilterStateData *

fstate

)

Definition at line 61 of file filter.c.

{
    if (!fstate)
        return;
 
    free(fstate->linebuff.data);
    fstate->linebuff.data = NULL;
 
    if (fstate->fp && fstate->fp != stdin)
    {
        if (fclose(fstate->fp) != 0)
            pg_log_error("could not close filter file \"%s\": %m", fstate->filename);
 
        fstate->fp = NULL;
    }
}

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.

{
    fstate->filename = filename;
    fstate->lineno = 0;
    fstate->exit_nicely = f_exit;
    initStringInfo(&fstate->linebuff);
 
    if (strcmp(filename, "-") != 0)
    {
        fstate->fp = fopen(filename, "r");
        if (!fstate->fp)
        {
            pg_log_error("could not open filter file \"%s\": %m", filename);
            fstate->exit_nicely(1);
        }
    }
    else
        fstate->fp = stdin;
}

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.

{
    switch (fot)
    {
        case FILTER_OBJECT_TYPE_NONE:
            return "comment or empty line";
        case FILTER_OBJECT_TYPE_TABLE_DATA:
            return "table data";
        case FILTER_OBJECT_TYPE_TABLE_DATA_AND_CHILDREN:
            return "table data and children";
        case FILTER_OBJECT_TYPE_DATABASE:
            return "database";
        case FILTER_OBJECT_TYPE_EXTENSION:
            return "extension";
        case FILTER_OBJECT_TYPE_FOREIGN_DATA:
            return "foreign data";
        case FILTER_OBJECT_TYPE_FUNCTION:
            return "function";
        case FILTER_OBJECT_TYPE_INDEX:
            return "index";
        case FILTER_OBJECT_TYPE_SCHEMA:
            return "schema";
        case FILTER_OBJECT_TYPE_TABLE:
            return "table";
        case FILTER_OBJECT_TYPE_TABLE_AND_CHILDREN:
            return "table and children";
        case FILTER_OBJECT_TYPE_TRIGGER:
            return "trigger";
    }
 
    /* should never get here */
    pg_unreachable();
}

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.

{
    if (pg_get_line_buf(fstate->fp, &fstate->linebuff))
    {
        const char *str = fstate->linebuff.data;
        const char *keyword;
        int         size;
        PQExpBufferData pattern;
 
        fstate->lineno++;
 
        /* Skip initial white spaces */
        while (isspace((unsigned char) *str))
            str++;
 
        /*
         * Skip empty lines or lines where the first non-whitespace character
         * is a hash indicating a comment.
         */
        if (*str != '\0' && *str != '#')
        {
            /*
             * First we expect sequence of two keywords, {include|exclude}
             * followed by the object type to operate on.
             */
            keyword = filter_get_keyword(&str, &size);
            if (!keyword)
            {
                pg_log_filter_error(fstate,
                                    _("no filter command found (expected \"include\" or \"exclude\")"));
                fstate->exit_nicely(1);
            }
 
            if (is_keyword_str("include", keyword, size))
                *comtype = FILTER_COMMAND_TYPE_INCLUDE;
            else if (is_keyword_str("exclude", keyword, size))
                *comtype = FILTER_COMMAND_TYPE_EXCLUDE;
            else
            {
                pg_log_filter_error(fstate,
                                    _("invalid filter command (expected \"include\" or \"exclude\")"));
                fstate->exit_nicely(1);
            }
 
            keyword = filter_get_keyword(&str, &size);
            if (!keyword)
            {
                pg_log_filter_error(fstate, _("missing filter object type"));
                fstate->exit_nicely(1);
            }
 
            if (!get_object_type(keyword, size, objtype))
            {
                pg_log_filter_error(fstate,
                                    _("unsupported filter object type: \"%.*s\""), size, keyword);
                fstate->exit_nicely(1);
            }
 
            initPQExpBuffer(&pattern);
 
            str = read_pattern(fstate, str, &pattern);
            *objname = pattern.data;
        }
        else
        {
            *objname = NULL;
            *comtype = FILTER_COMMAND_TYPE_NONE;
            *objtype = FILTER_OBJECT_TYPE_NONE;
        }
 
        return true;
    }
 
    if (ferror(fstate->fp))
    {
        pg_log_error("could not read from filter file \"%s\": %m", fstate->filename);
        fstate->exit_nicely(1);
    }
 
    return false;
}

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