Functions

Функции в сопоставителях

Вы даже можете указать функции в сопоставителе, чтобы сделать его более мощным. Вы можете использовать встроенные функции или указать свою собственную функцию. Встроенные функции сопоставления ключей имеют следующий формат:

bool function_name(string url, string pattern)

Они возвращают булево значение, указывающее, соответствует ли url pattern.

Поддерживаемые встроенные функции:

Функция	url	pattern	Пример
keyMatch	путь URL, например /alice_data/resource1	путь URL или шаблон *, например /alice_data/*	keymatch_model.conf/keymatch_policy.csv
keyMatch2	путь URL, например /alice_data/resource1	путь URL или шаблон :, например /alice_data/:resource	keymatch2_model.conf/keymatch2_policy.csv
keyMatch3	путь URL, например /alice_data/resource1	путь URL или шаблон {}, например /alice_data/{resource}	https://github.com/casbin/casbin/blob/277c1a2b85698272f764d71a94d2595a8d425915/util/builtin_operators_test.go#L171-L196
keyMatch4	путь URL, например /alice_data/123/book/123	путь URL или шаблон {}, например /alice_data/{id}/book/{id}	https://github.com/casbin/casbin/blob/277c1a2b85698272f764d71a94d2595a8d425915/util/builtin_operators_test.go#L208-L222
keyMatch5	путь URL, например /alice_data/123/?status=1	путь URL, шаблон {} или *, например /alice_data/{id}/*	https://github.com/casbin/casbin/blob/1cde2646d10ad1190c0d784c3a1c0e1ace1b5bc9/util/builtin_operators_test.go#L485-L526
regexMatch	любая строка	шаблон регулярного выражения	keymatch_model.conf/keymatch_policy.csv
ipMatch	IP-адрес, например 192.168.2.123	IP-адрес или CIDR, например 192.168.2.0/24	ipmatch_model.conf/ipmatch_policy.csv
globMatch	путь в стиле пути, например /alice_data/resource1	шаблон glob, например /alice_data/*	https://github.com/casbin/casbin/blob/277c1a2b85698272f764d71a94d2595a8d425915/util/builtin_operators_test.go#L426-L466

Для функций получения ключа они обычно принимают три параметра (за исключением keyGet):

bool function_name(string url, string pattern, string key_name)

Они вернут значение ключа key_name, если он соответствует шаблону, и вернут "", если ничего не найдено.

Например, KeyGet2("/resource1/action", "/:res/action", "res") вернет "resource1", а KeyGet3("/resource1_admin/action", "/{res}_admin/*", "res") вернет "resource1". Что касается KeyGet, который принимает два параметра, KeyGet("/resource1/action", "/*) вернет "resource1/action".

Функция	url	шаблон	key_name	пример
keyGet	URL-путь, например /proj/resource1	URL-путь или шаблон *, например /proj/*	\	keyget_model.conf/keymatch_policy.csv
keyGet2	URL-путь, например /proj/resource1	URL-путь или шаблон :, например /prooj/:resource	имя ключа, указанное в шаблоне	keyget2_model.conf/keymatch2_policy.csv
keyGet3	URL-путь, например /proj/res3_admin/	URL-путь или шаблон {} типа /proj/{resource}_admin/*	имя ключа, указанное в шаблоне	https://github.com/casbin/casbin/blob/7bd496f94f5a2739a392d333a9aaaa10ae397673/util/builtin_operators_test.go#L209-L247

Подробности о вышеуказанных функциях смотрите по адресу: https://github.com/casbin/casbin/blob/master/util/builtin_operators_test.go

Как добавить пользовательскую функцию

Сначала подготовьте вашу функцию. Она принимает несколько параметров и возвращает bool:

func KeyMatch(key1 string, key2 string) bool {
    i := strings.Index(key2, "*")
    if i == -1 {
        return key1 == key2
    }

    if len(key1) > i {
        return key1[:i] == key2[:i]
    }
    return key1 == key2[:i]
}

Затем оберните ее типами interface {}:

func KeyMatchFunc(args ...interface{}) (interface{}, error) {
    name1 := args[0].(string)
    name2 := args[1].(string)

    return (bool)(KeyMatch(name1, name2)), nil
}

Наконец, зарегистрируйте функцию в Casbin enforcer:

e.AddFunction("my_func", KeyMatchFunc)

Теперь вы можете использовать функцию в вашем модели CONF вот так:

[matchers]
m = r.sub == p.sub && my_func(r.obj, p.obj) && r.act == p.act