modules/platforms/python/dbapi/cpp_module/module.cpp

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 "module.h"
#include "py_connection.h"
#include "py_cursor.h"
#include "py_object.h"
#include "py_string.h"
#include "utils.h"
#include "ssl_config.h"

#include "ignite/protocol/protocol_context.h"

#include "ignite/common/detail/defer.h"
#include "ignite/common/detail/string_utils.h"

#include <Python.h>

namespace {

/**
 * Parse a string into the address and properly set the error if there is any.
 * @param item_str String item.
 * @return An end point if parsed successfully, and @c std::nullopt otherwise.
 */
[[nodiscard]] std::optional<ignite::end_point> parse_address_with_error_handling(const py_string &item_str) noexcept {
    try {
        return ignite::parse_single_address(item_str.get_data(), ignite::protocol::protocol_context::DEFAULT_TCP_PORT);
    } catch (const ignite::ignite_error& err) {
        PyErr_SetString(py_get_module_interface_error_class(), err.what());
    }
    return {};
}

PyObject* make_connection()
{
    py_object conn_class(py_get_module_class("Connection"));
    if (!conn_class)
        return nullptr;

    py_object args(PyTuple_New(0));
    py_object kwargs(Py_BuildValue("{}"));
    return PyObject_Call(conn_class.get(), args.get(), kwargs.get());
}

PyObject* make_connection(std::vector<ignite::end_point> addresses, const char* schema, const char* identity, const char* secret,
    int page_size, int timeout, double heartbeat_interval, bool autocommit, ssl_config &&ssl_cfg) {
    auto py_conn = make_py_connection(std::move(addresses), schema, identity, secret, page_size, timeout, heartbeat_interval,
        autocommit, std::move(ssl_cfg));

    if (!py_conn)
        return nullptr;

    auto conn_obj = make_connection();
    if (!conn_obj)
        return nullptr;

    if (PyObject_SetAttrString(conn_obj, "_py_connection", reinterpret_cast<PyObject *>(py_conn)))
        return nullptr;

    return conn_obj;
}

PyObject* pyignite_dbapi_connect(PyObject*, PyObject* args, PyObject* kwargs) {
    static char *kwlist[] = {
        const_cast<char*>("address"),
        const_cast<char*>("identity"),
        const_cast<char*>("secret"),
        const_cast<char*>("schema"),
        const_cast<char*>("timezone"),
        const_cast<char*>("timeout"),
        const_cast<char*>("heartbeat_interval"),
        const_cast<char*>("page_size"),
        const_cast<char*>("autocommit"),
        const_cast<char*>("use_ssl"),
        const_cast<char*>("ssl_keyfile"),
        const_cast<char*>("ssl_certfile"),
        const_cast<char*>("ssl_ca_certfile"),
        nullptr
    };

    PyObject *address = nullptr;
    const char *identity = nullptr;
    const char *secret = nullptr;
    const char *schema = nullptr;
    const char *timezone = nullptr;
    int timeout = 0;
    double heartbeat_interval = 30.0;
    int page_size = 0;
    int autocommit = 1;
    int use_ssl = 0;
    const char *ssl_keyfile = nullptr;
    const char *ssl_certfile = nullptr;
    const char *ssl_ca_certfile = nullptr;

    int parsed = PyArg_ParseTupleAndKeywords(args, kwargs, "O|$ssssidippsss", kwlist, &address, &identity, &secret, &schema,
        &timezone, &timeout, &heartbeat_interval, &page_size, &autocommit, &use_ssl, &ssl_keyfile, &ssl_certfile, &ssl_ca_certfile);

    if (!parsed)
        return nullptr;

    std::vector<ignite::end_point> addresses;
    if (PyList_Check(address)) {
        auto size = PyList_Size(address);
        for (Py_ssize_t idx = 0; idx < size; ++idx) {
            auto item = PyList_GetItem(address, idx);
            if (!PyUnicode_Check(item)) {
                PyErr_SetString(py_get_module_interface_error_class(),
                    "Only a string or a list of strings are allowed in 'address' parameter");

                return nullptr;
            }

            auto item_str = py_string::try_from_py_utf8(item);
            if (!item_str) {
                PyErr_SetString(py_get_module_interface_error_class(), "Can not convert address string to UTF-8");
                return nullptr;
            }

            auto addr = parse_address_with_error_handling(item_str);
            if (!addr) {
                return nullptr;
            }
            if (!addr->host.empty()) {
                addresses.push_back(*addr);
            }
        }
    } else if (PyUnicode_Check(address)) {
        auto item_str = py_string::try_from_py_utf8(address);
        if (!item_str) {
            PyErr_SetString(py_get_module_interface_error_class(), "Can not convert address string to UTF-8");
            return nullptr;
        }

        auto addr = parse_address_with_error_handling(item_str);
        if (!addr) {
            return nullptr;
        }
        if (!addr->host.empty()) {
            addresses.push_back(*addr);
        }
    } else {
        PyErr_SetString(py_get_module_interface_error_class(),
            "Only a string or a list of strings are allowed in 'address' parameter");
        return nullptr;
    }

    ssl_config ssl_cfg(use_ssl != 0, ssl_keyfile, ssl_certfile, ssl_ca_certfile);

    return make_connection(std::move(addresses), schema, identity, secret, page_size, timeout, heartbeat_interval, autocommit != 0, std::move(ssl_cfg));
}

PyMethodDef methods[] = {
    {"connect", PyCFunction(pyignite_dbapi_connect), METH_VARARGS | METH_KEYWORDS, nullptr},
    {nullptr, nullptr, 0, nullptr}       /* Sentinel */
};

PyModuleDef module_def = {
    PyModuleDef_HEAD_INIT,
    EXT_MODULE_NAME,
    nullptr,                /* m_doc */
    -1,                     /* m_size */
    methods,                /* m_methods */
    nullptr,                /* m_slots */
    nullptr,                /* m_traverse */
    nullptr,                /* m_clear */
    nullptr,                /* m_free */
};

} // anonymous namespace

PyMODINIT_FUNC PyInit__pyignite_dbapi_extension(void) { // NOLINT(*-reserved-identifier)
    PyObject *mod = PyModule_Create(&module_def);
    if (mod == nullptr)
        return nullptr;

    if (prepare_py_connection_type() || prepare_py_cursor_type())
        return nullptr;

    if (register_py_connection_type(mod) || register_py_cursor_type(mod))
        return nullptr;

    return mod;
}