Merge pull request #139 from EmperorYP7/config-binding

feat: Added python bindings for `casbin::Config`

Author: hsluoyz

CMakeLists.txt

@@ -32,7 +32,7 @@ endif()
 # Project definition.
 
 project(CasbinCPP
-    VERSION 1.36.0
+    VERSION 1.37.0
     DESCRIPTION "An authorization library that supports access control models like ACL, RBAC, ABAC in C/C++"
     HOMEPAGE_URL https://github.com/casbin/casbin-cpp
     LANGUAGES CXX C

bindings/python/CMakeLists.txt

@@ -18,7 +18,7 @@ set(SOURCES
     py_enforcer.cpp
     py_abac_data.cpp
     py_model.cpp
-)
+        py_config.cpp)
 
 set(HEADERS
     py_casbin.h

bindings/python/main.cpp

@@ -38,6 +38,7 @@ PYBIND11_MODULE(pycasbin, m) {
     bindPyCachedEnforcer(m);
     bindABACData(m);
     bindPyModel(m);
+    bindPyConfig(m);
 
     m.attr("__version__") = PY_CASBIN_VERSION;
 }

bindings/python/py_casbin.h

@@ -22,3 +22,4 @@ void bindPyEnforcer(py::module &m);
 void bindPyCachedEnforcer(py::module &m);
 void bindABACData(py::module &m);
 void bindPyModel(py::module &m);
+void bindPyConfig(py::module &m);

bindings/python/py_config.cpp

@@ -0,0 +1,50 @@
+/*
+* Copyright 2021 The casbin Authors. All Rights Reserved.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+#include <pybind11/pybind11.h>
+#include <pybind11/stl.h>
+#include <casbin/casbin.h>
+
+namespace py = pybind11;
+
+void bindPyConfig(py::module &m) {
+    py::class_<casbin::Config, std::shared_ptr<casbin::Config>>(m, "Config")
+        .def(py::init<>())
+        .def(py::init<const std::string&>())
+        .def_static("NewConfig", &casbin::Config::NewConfig, R"doc(
+           /**
+            * NewConfig create an empty configuration representation from file.
+            *
+            * @param confName the path of the model file.
+            * @return the constructor of Config.
+            */
+        )doc")
+        .def_static("NewConfigFromText", &casbin::Config::NewConfigFromText, R"doc(
+           /**
+            * newConfigFromText create an empty configuration representation from text.
+            *
+            * @param text the model text.
+            * @return the constructor of Config.
+            */
+        )doc")
+        .def("GetBool", &casbin::Config::GetBool)
+        .def("GetInt", &casbin::Config::GetInt)
+        .def("GetFloat", &casbin::Config::GetFloat)
+        .def("GetString", &casbin::Config::GetString)
+        .def("GetStrings", &casbin::Config::GetStrings)
+        .def("Set", &casbin::Config::Set)
+        .def("Get", &casbin::Config::Get);
+}

bindings/python/py_model.cpp

@@ -20,11 +20,17 @@
 
 #include "py_casbin.h"
 
+void PyLoadModelFromConfig(casbin::Model* model, std::shared_ptr<casbin::Config> config) {
+    model->LoadModelFromConfig(config);
+}
+
 void bindPyModel(py::module &m) {
     py::class_<casbin::Model, std::shared_ptr<casbin::Model>>(m, "Model")
         .def(py::init<>())
         .def(py::init<const std::string &>())
 
+        .def_readonly_static("required_sections", &casbin::Model::required_sections)
+
         .def("HasSection", &casbin::Model::HasSection)
         .def("AddDef", &casbin::Model::AddDef, "AddDef adds an assertion to the model.")
         .def("LoadModel", &casbin::Model::LoadModel, "LoadModel loads the model from model CONF file.")

casbin/CMakeLists.txt

@@ -13,65 +13,65 @@
 #  limitations under the License.
 
 set(CASBIN_SOURCE
-        abac_data.cpp
-        enforcer.cpp
-        enforcer_cached.cpp
-        enforcer_synced.cpp
-        internal_api.cpp
-        logger.cpp
-        management_api.cpp
-        pch.cpp
-        rbac_api.cpp
-        rbac_api_with_domains.cpp
-        config/config.cpp
-        duktape/duktape.cpp
-        effect/default_effector.cpp
-        ip_parser/exception/parser_exception.cpp
-        ip_parser/parser/allFF.cpp
-        ip_parser/parser/CIDRMask.cpp
-        ip_parser/parser/dtoi.cpp
-        ip_parser/parser/equal.cpp
-        ip_parser/parser/IP.cpp
-        ip_parser/parser/IPNet.cpp
-        ip_parser/parser/IPv4.cpp
-        ip_parser/parser/parseCIDR.cpp
-        ip_parser/parser/parseIP.cpp
-        ip_parser/parser/parseIPv4.cpp
-        ip_parser/parser/parseIPv6.cpp
-        ip_parser/parser/Print.cpp
-        ip_parser/parser/xtoi.cpp
-        model/assertion.cpp
-        model/function.cpp
-        model/model.cpp
-        model/scope_config.cpp
-        persist/file_adapter/batch_file_adapter.cpp
-        persist/file_adapter/file_adapter.cpp
-        persist/file_adapter/filtered_file_adapter.cpp
-        persist/adapter.cpp
-        persist/default_watcher.cpp
-        persist/default_watcher_ex.cpp
-        rbac/default_role_manager.cpp
-        util/array_equals.cpp
-        util/array_remove_duplicates.cpp
-        util/array_to_string.cpp
-        util/built_in_functions.cpp
-        util/ends_with.cpp
-        util/escape_assertion.cpp
-        util/find_all_occurences.cpp
-        util/is_instance_of.cpp
-        util/join.cpp
-        util/join_slice.cpp
-        util/remove_comments.cpp
-        util/set_subtract.cpp
-        util/split.cpp
-        util/ticker.cpp
-        util/trim.cpp
-        )
+    abac_data.cpp
+    enforcer.cpp
+    enforcer_cached.cpp
+    enforcer_synced.cpp
+    internal_api.cpp
+    logger.cpp
+    management_api.cpp
+    pch.cpp
+    rbac_api.cpp
+    rbac_api_with_domains.cpp
+    config/config.cpp
+    duktape/duktape.cpp
+    effect/default_effector.cpp
+    ip_parser/exception/parser_exception.cpp
+    ip_parser/parser/allFF.cpp
+    ip_parser/parser/CIDRMask.cpp
+    ip_parser/parser/dtoi.cpp
+    ip_parser/parser/equal.cpp
+    ip_parser/parser/IP.cpp
+    ip_parser/parser/IPNet.cpp
+    ip_parser/parser/IPv4.cpp
+    ip_parser/parser/parseCIDR.cpp
+    ip_parser/parser/parseIP.cpp
+    ip_parser/parser/parseIPv4.cpp
+    ip_parser/parser/parseIPv6.cpp
+    ip_parser/parser/Print.cpp
+    ip_parser/parser/xtoi.cpp
+    model/assertion.cpp
+    model/function.cpp
+    model/model.cpp
+    model/scope_config.cpp
+    persist/file_adapter/batch_file_adapter.cpp
+    persist/file_adapter/file_adapter.cpp
+    persist/file_adapter/filtered_file_adapter.cpp
+    persist/adapter.cpp
+    persist/default_watcher.cpp
+    persist/default_watcher_ex.cpp
+    rbac/default_role_manager.cpp
+    util/array_equals.cpp
+    util/array_remove_duplicates.cpp
+    util/array_to_string.cpp
+    util/built_in_functions.cpp
+    util/ends_with.cpp
+    util/escape_assertion.cpp
+    util/find_all_occurences.cpp
+    util/is_instance_of.cpp
+    util/join.cpp
+    util/join_slice.cpp
+    util/remove_comments.cpp
+    util/set_subtract.cpp
+    util/split.cpp
+    util/ticker.cpp
+    util/trim.cpp
+)
 
 # Setting to C++ standard to C++17
 set(CMAKE_CXX_STANDARD 17)
 
-add_library(casbin ${CASBIN_SOURCE})
+add_library(casbin STATIC ${CASBIN_SOURCE})
 target_include_directories(casbin PUBLIC ${CMAKE_SOURCE_DIR}/casbin)
 
 target_precompile_headers(casbin PUBLIC "pch.h")
@@ -89,12 +89,13 @@ elseif(UNIX)
     )
 endif()
 
-install(TARGETS casbin EXPORT CasbinTargets
-        LIBRARY DESTINATION lib
-        ARCHIVE DESTINATION lib
-        RUNTIME DESTINATION bin
-        INCLUDES DESTINATION include
-        )
+install(
+    TARGETS casbin EXPORT CasbinTargets
+    LIBRARY DESTINATION lib
+    ARCHIVE DESTINATION lib
+    RUNTIME DESTINATION bin
+    INCLUDES DESTINATION include
+)
 
 install(
     DIRECTORY ${CMAKE_SOURCE_DIR}/include/casbin

casbin/config/config.cpp

@@ -114,6 +114,13 @@ std::shared_ptr<Config> Config::NewConfigFromText(const std::string& text) {
     return c;
 }
 
+Config::Config() {
+}
+
+Config::Config(const std::string& conf_name) {
+    this->Parse(conf_name);
+}
+
 bool Config::GetBool(std::string_view key) {
     return Get(key).compare("true")==0;
 }

casbin/config/config.h

@@ -64,6 +64,10 @@ class Config : public ConfigInterface {
 
         bool GetBool(std::string_view key);
 
+        Config();
+
+        Config(const std::string& conf_name);
+
         int GetInt(std::string_view key);
 
         float GetFloat(std::string_view key);

casbin/model/model.cpp

@@ -39,7 +39,7 @@ std::unordered_map<std::string, std::string> Model::section_name_map = {
 
 std::vector<std::string> Model::required_sections{"r","p","e","m"};
 
-void Model::LoadModelFromConfig(std::shared_ptr<ConfigInterface> cfg) {
+void Model::LoadModelFromConfig(std::shared_ptr<Config>& cfg) {
     for (auto [section_name, _] : section_name_map)
         LoadSection(this ,cfg, section_name);