mirror of
https://github.com/haproxy/haproxy.git
synced 2026-02-12 23:33:14 -05:00
Add a new converter with the following prototype :
map(<map_file>[,<default_value>])
map_<match_type>(<map_file>[,<default_value>])
map_<match_type>_<output_type>(<map_file>[,<default_value>])
It searches the for input value from <map_file> using the <match_type>
matching method, and return the associated value converted to the type
<output_type>. If the input value cannot be found in the <map_file>,
the converter returns the <default_value>. If the <default_value> is
not set, the converter fails and acts as if no input value could be
fetched. If the <match_type> is not set, it defaults to "str".
Likewise, if the <output_type> is not set, it defaults to "str". For
convenience, the "map" keyword is an alias for "map_str" and maps a
string to another string. The following array contains contains the
list of all the map* converters.
+----+----------+---------+-------------+------------+
| `-_ out | | | |
| input `-_ | str | int | ip |
| / match `-_ | | | |
+---------------+---------+-------------+------------+
| str / str | map_str | map_str_int | map_str_ip |
| str / sub | map_sub | map_sub_int | map_sub_ip |
| str / dir | map_dir | map_dir_int | map_dir_ip |
| str / dom | map_dom | map_dom_int | map_dom_ip |
| str / end | map_end | map_end_int | map_end_ip |
| str / reg | map_reg | map_reg_int | map_reg_ip |
| int / int | map_int | map_int_int | map_int_ip |
| ip / ip | map_ip | map_ip_int | map_ip_ip |
+---------------+---------+-------------+------------+
The names are intentionally chosen to reflect the same match methods
as ACLs use.
68 lines
2.9 KiB
C
68 lines
2.9 KiB
C
/*
|
|
* include/types/map.h
|
|
* This file provides structures and types for MAPs.
|
|
*
|
|
* Copyright (C) 2000-2012 Willy Tarreau - w@1wt.eu
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation, version 2.1
|
|
* exclusively.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef _TYPES_MAP_H
|
|
#define _TYPES_MAP_H
|
|
|
|
#include <types/acl.h>
|
|
|
|
/* These structs contains a string representation of the map. These struct is
|
|
* sorted by file. Permit to hot-add and hot-remove entries.
|
|
*
|
|
* "maps" is the list head. This list cotains all the mao file name identifier.
|
|
*/
|
|
struct list maps = LIST_HEAD_INIT(maps); /* list of struct map_reference */
|
|
|
|
struct map_reference {
|
|
struct list list; /* used for listing */
|
|
char *reference; /* contain the unique identifier used as map identifier.
|
|
in many cases this identifier is the filename that contain
|
|
the patterns */
|
|
struct list entries; /* the list of all the entries of the map. This
|
|
is a list of "struct map_entry" */
|
|
struct list maps; /* the list of all maps associated with the file
|
|
name identifier. This is a list of struct map_descriptor */
|
|
};
|
|
|
|
struct map_entry {
|
|
struct list list; /* used for listing */
|
|
int line; /* The original line into the file. It is used for log reference.
|
|
If the line is '> 0', this entry is from the original load,
|
|
If the line is '< 0', this entry is modify by dynamux process (CLI) */
|
|
char *key; /* The string containing the key before conversion
|
|
and indexation */
|
|
char *value; /* The string containing the value */
|
|
};
|
|
|
|
struct sample_storage;
|
|
struct map_descriptor {
|
|
struct list list; /* used for listing */
|
|
struct map_reference *ref; /* the reference used for unindexed entries */
|
|
struct sample_conv *conv; /* original converter descriptor */
|
|
int (*parse)(const char *text, /* The function that can parse the output value */
|
|
struct sample_storage *smp);
|
|
struct pattern_expr pat; /* the pattern matching associated to the map */
|
|
char *default_value; /* a copy of default value. This copy is
|
|
useful if the type is str */
|
|
struct sample_storage *def; /* contain the default value */
|
|
};
|
|
|
|
#endif /* _TYPES_MAP_H */
|