From 45ee504dc5000ff62d071175320d39221b0b86b0 Mon Sep 17 00:00:00 2001
From: Rory Z <rory-z@outlook.com>
Date: Mon, 5 Jul 2021 15:11:58 +0800
Subject: [PATCH] chore(authz): rename ACL to AuthZ

---
 apps/emqx_authz/README.md                |  2 +-
 apps/emqx_authz/include/emqx_authz.hrl   | 12 ++++++------
 apps/emqx_authz/src/emqx_authz.erl       | 10 +++++-----
 apps/emqx_authz/src/emqx_authz_mongo.erl |  2 +-
 apps/emqx_authz/src/emqx_authz_mysql.erl |  2 +-
 apps/emqx_authz/src/emqx_authz_pgsql.erl |  2 +-
 apps/emqx_authz/src/emqx_authz_redis.erl |  2 +-
 7 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/apps/emqx_authz/README.md b/apps/emqx_authz/README.md
index de0d695ee..a8b4ca170 100644
--- a/apps/emqx_authz/README.md
+++ b/apps/emqx_authz/README.md
@@ -131,7 +131,7 @@ Sample data in the default configuration:
 HSET mqtt_acl:emqx '$SYS/#' subscribe
 ```
 
-A rule of Redis ACL defines `publish`, `subscribe`, or `all `information. All lists in the rule are **allow** lists.
+A rule of Redis AuthZ defines `publish`, `subscribe`, or `all `information. All lists in the rule are **allow** lists.
 
 #### Mongo
 
diff --git a/apps/emqx_authz/include/emqx_authz.hrl b/apps/emqx_authz/include/emqx_authz.hrl
index 9caf3d979..76aa20688 100644
--- a/apps/emqx_authz/include/emqx_authz.hrl
+++ b/apps/emqx_authz/include/emqx_authz.hrl
@@ -6,14 +6,14 @@
 -define(ALLOW_DENY(A), ((A =:= allow) orelse (A =:= deny))).
 -define(PUBSUB(A), ((A =:= subscribe) orelse (A =:= publish) orelse (A =:= all))).
 
--record(acl_metrics, {
-        allow = 'client.acl.allow',
-        deny = 'client.acl.deny',
-        ignore = 'client.acl.ignore'
+-record(authz_metrics, {
+        allow = 'client.authorize.allow',
+        deny = 'client.authorize.deny',
+        ignore = 'client.authorize.ignore'
     }).
 
 -define(METRICS(Type), tl(tuple_to_list(#Type{}))).
 -define(METRICS(Type, K), #Type{}#Type.K).
 
--define(ACL_METRICS, ?METRICS(acl_metrics)).
--define(ACL_METRICS(K), ?METRICS(acl_metrics, K)).
+-define(AUTHZ_METRICS, ?METRICS(authz_metrics)).
+-define(AUTHZ_METRICS(K), ?METRICS(authz_metrics, K)).
diff --git a/apps/emqx_authz/src/emqx_authz.erl b/apps/emqx_authz/src/emqx_authz.erl
index f673b3979..578f6d7cc 100644
--- a/apps/emqx_authz/src/emqx_authz.erl
+++ b/apps/emqx_authz/src/emqx_authz.erl
@@ -32,7 +32,7 @@
 
 -spec(register_metrics() -> ok).
 register_metrics() ->
-    lists:foreach(fun emqx_metrics:ensure/1, ?ACL_METRICS).
+    lists:foreach(fun emqx_metrics:ensure/1, ?AUTHZ_METRICS).
 
 init() ->
     ok = register_metrics(),
@@ -147,10 +147,10 @@ b2l(B) when is_list(B) -> B;
 b2l(B) when is_binary(B) -> binary_to_list(B).
 
 %%--------------------------------------------------------------------
-%% ACL callbacks
+%% AuthZ callbacks
 %%--------------------------------------------------------------------
 
-%% @doc Check ACL
+%% @doc Check AuthZ
 -spec(authorize(emqx_types:clientinfo(), emqx_types:all(), emqx_topic:topic(), emqx_permission_rule:acl_result(), rules())
       -> {stop, allow} | {ok, deny}).
 authorize(#{username := Username,
@@ -159,11 +159,11 @@ authorize(#{username := Username,
     case do_authorize(Client, PubSub, Topic, Rules) of
         {matched, allow} ->
             ?LOG(info, "Client succeeded authorization: Username: ~p, IP: ~p, Topic: ~p, Permission: allow", [Username, IpAddress, Topic]),
-            emqx_metrics:inc(?ACL_METRICS(allow)),
+            emqx_metrics:inc(?AUTHZ_METRICS(allow)),
             {stop, allow};
         {matched, deny} ->
             ?LOG(info, "Client failed authorization: Username: ~p, IP: ~p, Topic: ~p, Permission: deny", [Username, IpAddress, Topic]),
-            emqx_metrics:inc(?ACL_METRICS(deny)),
+            emqx_metrics:inc(?AUTHZ_METRICS(deny)),
             {stop, deny};
         nomatch ->
             ?LOG(info, "Client failed authorization: Username: ~p, IP: ~p, Topic: ~p, Reasion: ~p", [Username, IpAddress, Topic, "no-match rule"]),
diff --git a/apps/emqx_authz/src/emqx_authz_mongo.erl b/apps/emqx_authz/src/emqx_authz_mongo.erl
index bffb3f07b..04af8f1ec 100644
--- a/apps/emqx_authz/src/emqx_authz_mongo.erl
+++ b/apps/emqx_authz/src/emqx_authz_mongo.erl
@@ -20,7 +20,7 @@
 -include_lib("emqx/include/emqx.hrl").
 -include_lib("emqx/include/logger.hrl").
 
-%% ACL Callbacks
+%% AuthZ Callbacks
 -export([ authorize/4
         , description/0
         ]).
diff --git a/apps/emqx_authz/src/emqx_authz_mysql.erl b/apps/emqx_authz/src/emqx_authz_mysql.erl
index 672954841..4c769085d 100644
--- a/apps/emqx_authz/src/emqx_authz_mysql.erl
+++ b/apps/emqx_authz/src/emqx_authz_mysql.erl
@@ -20,7 +20,7 @@
 -include_lib("emqx/include/emqx.hrl").
 -include_lib("emqx/include/logger.hrl").
 
-%% ACL Callbacks
+%% AuthZ Callbacks
 -export([ description/0
         , parse_query/1
         , authorize/4
diff --git a/apps/emqx_authz/src/emqx_authz_pgsql.erl b/apps/emqx_authz/src/emqx_authz_pgsql.erl
index fa24c5f5e..d74db36b2 100644
--- a/apps/emqx_authz/src/emqx_authz_pgsql.erl
+++ b/apps/emqx_authz/src/emqx_authz_pgsql.erl
@@ -20,7 +20,7 @@
 -include_lib("emqx/include/emqx.hrl").
 -include_lib("emqx/include/logger.hrl").
 
-%% ACL Callbacks
+%% AuthZ Callbacks
 -export([ description/0
         , parse_query/1
         , authorize/4
diff --git a/apps/emqx_authz/src/emqx_authz_redis.erl b/apps/emqx_authz/src/emqx_authz_redis.erl
index dc80d959c..8d24b4534 100644
--- a/apps/emqx_authz/src/emqx_authz_redis.erl
+++ b/apps/emqx_authz/src/emqx_authz_redis.erl
@@ -20,7 +20,7 @@
 -include_lib("emqx/include/emqx.hrl").
 -include_lib("emqx/include/logger.hrl").
 
-%% ACL Callbacks
+%% AuthZ Callbacks
 -export([ authorize/4
         , description/0
         ]).