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	pattern	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
}

Нарешті, зареєструйте функцію в enforcer Casbin:

e.AddFunction("my_func", KeyMatchFunc)

Тепер ви можете використовувати функцію у своєму моделі CONF таким чином:

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