dbconn.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2020 - 2025
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.
 
    See the COPYING file for more details.
*/
 
#ifdef HAVE_MYSQLPP
 
#include "server/common/dbconn.hpp"
 
#include "log.hpp"
#include "serialization/parser.hpp"
#include "serialization/string_utils.hpp"
#include "serialization/unicode.hpp"
#include "utils/general.hpp"
 
#include <type_traits>
 
static lg::log_domain log_sql_handler("sql_executor");
#define ERR_SQL LOG_STREAM(err, log_sql_handler)
#define WRN_SQL LOG_STREAM(warn, log_sql_handler)
#define LOG_SQL LOG_STREAM(info, log_sql_handler)
#define DBG_SQL LOG_STREAM(debug, log_sql_handler)
 
dbconn::dbconn(const config& c)
    : db_users_table_(c["db_users_table"].str())
    , db_banlist_table_(c["db_banlist_table"].str())
    , db_extra_table_(c["db_extra_table"].str())
    , db_game_info_table_(c["db_game_info_table"].str())
    , db_game_player_info_table_(c["db_game_player_info_table"].str())
    , db_game_content_info_table_(c["db_game_content_info_table"].str())
    , db_user_group_table_(c["db_user_group_table"].str())
    , db_tournament_query_(c["db_tournament_query"].str())
    , db_topics_table_(c["db_topics_table"].str())
    , db_addon_info_table_(c["db_addon_info_table"].str())
    , db_connection_history_table_(c["db_connection_history_table"].str())
    , db_addon_authors_table_(c["db_addon_authors_table"].str())
{
    try
    {
        account_ = mariadb::account::create(c["db_host"].str(), c["db_user"].str(), c["db_password"].str());
        account_->set_connect_option(mysql_option::MYSQL_SET_CHARSET_NAME, std::string("utf8mb4"));
        account_->set_schema(c["db_name"].str());
        // initialize the connection used to run synchronous queries.
        connection_ = create_connection();
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Failed to connect to the database!", e);
    }
}
 
void dbconn::log_sql_exception(const std::string& text, const mariadb::exception::base& e)
{
    ERR_SQL << text << '\n'
            << "what: " << e.what() << '\n'
            << "error id: " << e.error_id();
}
 
mariadb::connection_ref dbconn::create_connection()
{
    return mariadb::connection::create(account_);
}
 
//
// queries
//
int dbconn::async_test_query(int limit)
{
    std::string sql = "with recursive TEST(T) as "
                      "( "
                      "select 1 "
                      "union all "
                      "select T+1 from TEST where T < ? "
                      ") "
                      "select count(*) from TEST";
    int t = get_single_long(create_connection(), sql, { limit });
    return t;
}
 
std::string dbconn::get_uuid()
{
    try
    {
        return get_single_string(connection_, "SELECT UUID()", {});
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Could not retrieve a UUID!", e);
        return "";
    }
}
 
std::string dbconn::get_tournaments()
{
    if(db_tournament_query_ == "")
    {
        return "";
    }
 
    try
    {
        mariadb::result_set_ref rslt = select(connection_, db_tournament_query_, {});
        std::string text;
        while(rslt->next()) {
            text += "\n" + rslt->get_string("TEXT");
        }
        return text;
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Could not retrieve the tournaments!", e);
        return "";
    }
}
 
std::unique_ptr<simple_wml::document> dbconn::get_game_history(int player_id, int offset, std::string search_game_name, int search_content_type, std::string search_content)
{
    auto game_history_handler = [](const mariadb::result_set_ref& rslt) {
        config c;
 
        while(rslt->next())
        {
            config& child = c.add_child("game");
            child["game_name"] = rslt->get_string("GAME_NAME");
            child["game_start"] = rslt->get_date_time("START_TIME").str();
            child["scenario_name"] = rslt->get_string("SCENARIO_NAME");
            child["era_name"] = rslt->get_string("ERA_NAME");
            for(const auto& player_info : utils::split(rslt->get_string("PLAYERS")))
            {
                std::vector<std::string> info = utils::split(player_info, ':');
                config& pchild = child.add_child("player");
                if(info.size() == 2)
                {
                    pchild["name"] = info[0];
                    pchild["faction"] = info[1];
                }
                else
                {
                    ERR_SQL << "Expected player information to split into two fields, instead found the value `" << player_info << "`.";
                }
            }
            for(const std::string& mod : utils::split(rslt->get_string("MODIFICATION_NAMES")))
            {
                config& mchild = child.add_child("modification");
                mchild["name"] = mod;
            }
            child["replay_url"] = rslt->get_string("REPLAY_URL");
            child["version"] = rslt->get_string("VERSION");
        }
 
        return c;
    };
 
    try
    {
        // if no parameters populated, return an error
        if(player_id == 0 && search_game_name.empty() && search_content.empty())
        {
            ERR_SQL << "Skipping game history query due to lack of search parameters.";
            auto doc = std::make_unique<simple_wml::document>();
            doc->set_attr("error", "No search parameters provided.");
            return doc;
        }
 
        sql_parameters params;
 
        std::string game_history_query = "select "
"  game.GAME_NAME, "
"  game.START_TIME, "
"  GROUP_CONCAT(CONCAT(player.USER_NAME, ':', player.FACTION)) as PLAYERS, "
"  IFNULL(scenario.NAME, '') as SCENARIO_NAME, "
"  IFNULL(era.NAME, '') as ERA_NAME, "
"  IFNULL((select GROUP_CONCAT(distinct mods.NAME) from "+db_game_content_info_table_+" mods where mods.TYPE = 'modification' and mods.INSTANCE_UUID = game.INSTANCE_UUID and mods.GAME_ID = game.GAME_ID), '') as MODIFICATION_NAMES, "
"  case "
"  when game.PUBLIC = 1 and game.INSTANCE_VERSION != 'trunk' "
"  then concat('https://replays.wesnoth.org/', substring(game.INSTANCE_VERSION, 1, 4), '/', year(game.END_TIME), '/', lpad(month(game.END_TIME), 2, '0'), '/', lpad(day(game.END_TIME), 2, '0'), '/', game.REPLAY_NAME) "
"  when game.PUBLIC = 1 and game.INSTANCE_VERSION = 'trunk' "
"  then concat('https://replays.wesnoth.org/', game.INSTANCE_VERSION, '/', year(game.END_TIME), '/', lpad(month(game.END_TIME), 2, '0'), '/', lpad(day(game.END_TIME), 2, '0'), '/', game.REPLAY_NAME) "
"  else '' "
"  end as REPLAY_URL, "
"  case "
"  when game.INSTANCE_VERSION != 'trunk' "
"  then SUBSTRING(game.INSTANCE_VERSION, 1, 4) "
"  else 'trunk' "
"  end as VERSION "
"from "+db_game_player_info_table_+" player , "+db_game_content_info_table_+" scenario , "+db_game_content_info_table_+" era , "+db_game_info_table_+" game ";
    // modification id optional parameter
    if(search_content_type == 2 && !search_content.empty())
    {
        game_history_query += ", "+db_game_content_info_table_+" mods "
"  where mods.TYPE = 'modification' "
"  and mods.INSTANCE_UUID = game.INSTANCE_UUID "
"  and mods.GAME_ID = game.GAME_ID "
"  and mods.ID like ? ";
 
        utils::to_sql_wildcards(search_content, false);
        params.emplace_back(search_content);
    }
    else
    {
        // put the where clause with an always true condition here so I don't need to check again a couple lines down whether it needs "where" vs "and"
        game_history_query += "where true ";
    }
 
    game_history_query += "and exists "
"  ( "
"    select 1 "
"    from "+db_game_player_info_table_+" player1 "
"    where game.INSTANCE_UUID = player1.INSTANCE_UUID "
"      and game.GAME_ID = player1.GAME_ID ";
 
    if(player_id != 0)
    {
        game_history_query += " and player1.USER_ID = ? ";
        params.emplace_back(player_id);
    }
 
    game_history_query += "  ) "
"  and game.INSTANCE_UUID = player.INSTANCE_UUID "
"  and game.GAME_ID = player.GAME_ID "
"  and player.USER_ID != -1 "
"  and game.END_TIME is not NULL "
"  and scenario.TYPE = 'scenario' "
"  and scenario.INSTANCE_UUID = game.INSTANCE_UUID "
"  and scenario.GAME_ID = game.GAME_ID "
"  and era.TYPE = 'era' "
"  and era.INSTANCE_UUID = game.INSTANCE_UUID "
"  and era.GAME_ID = game.GAME_ID ";
    // game name optional paramenter
    if(!search_game_name.empty())
    {
        game_history_query += "and game.GAME_NAME like ? ";
 
        utils::to_sql_wildcards(search_game_name, false);
        params.emplace_back(search_game_name);
    }
 
    // scenario id optional parameter
    if(search_content_type == 0 && !search_content.empty())
    {
        game_history_query += "and scenario.ID like ? ";
 
        utils::to_sql_wildcards(search_content, false);
        params.emplace_back(search_content);
    }
 
    // era id optional parameter
    if(search_content_type == 1 && !search_content.empty())
    {
        game_history_query += "and era.ID like ? ";
 
        utils::to_sql_wildcards(search_content, false);
        params.emplace_back(search_content);
    }
 
    game_history_query += "group by game.INSTANCE_UUID, game.GAME_ID, SCENARIO_NAME, ERA_NAME "
"order by game.START_TIME desc "
"limit 11 offset ? ";
        params.emplace_back(offset);
 
        DBG_SQL << "before getting connection for game history query for player " << player_id;
 
        mariadb::connection_ref connection = create_connection();
 
        DBG_SQL << "game history query text for player " << player_id << ": " << game_history_query;
 
        config history = get_complex_results(connection, &game_history_handler, game_history_query, params);
 
        DBG_SQL << "after game history query for player " << player_id;
 
        auto doc = std::make_unique<simple_wml::document>();
 
        simple_wml::node& results_wml = doc->root().add_child("game_history_results");
 
        for(const auto& result : history.child_range("game"))
        {
            simple_wml::node& ghr = results_wml.add_child("game_history_result");
            ghr.set_attr_dup("game_name", result["game_name"].str().c_str());
            ghr.set_attr_dup("game_start", result["game_start"].str().c_str());
            ghr.set_attr_dup("scenario_name", result["scenario_name"].str().c_str());
            ghr.set_attr_dup("era_name", result["era_name"].str().c_str());
            ghr.set_attr_dup("replay_url", result["replay_url"].str().c_str());
            ghr.set_attr_dup("version", result["version"].str().c_str());
            for(const auto& player : result.child_range("player"))
            {
                simple_wml::node& p = ghr.add_child("player");
                p.set_attr_dup("name", player["name"].str().c_str());
                p.set_attr_dup("faction", player["faction"].str().c_str());
            }
            for(const auto& mod : result.child_range("modification"))
            {
                simple_wml::node& m = ghr.add_child("modification");
                m.set_attr_dup("name", mod["name"].str().c_str());
            }
        }
 
        DBG_SQL << "after parsing results of game history query for player " << player_id;
 
        return doc;
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Could not retrieve the game history for forum ID `"+std::to_string(player_id)+"`!", e);
        auto doc = std::make_unique<simple_wml::document>();
        doc->set_attr("error", "Error retrieving game history.");
        return doc;
    }
}
 
bool dbconn::user_exists(const std::string& name)
{
    try
    {
        return exists(connection_, "SELECT 1 FROM `"+db_users_table_+"` WHERE UPPER(username)=UPPER(?)", { name });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to check if user row for '"+name+"' exists!", e);
        return false;
    }
}
 
long dbconn::get_forum_id(const std::string& name)
{
    try
    {
        return get_single_long(connection_, "SELECT IFNULL((SELECT user_id FROM `"+db_users_table_+"` WHERE UPPER(username)=UPPER(?)), 0)", { name });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to get user_id for '"+name+"'!", e);
        return 0;
    }
}
 
bool dbconn::extra_row_exists(const std::string& name)
{
    try
    {
        return exists(connection_, "SELECT 1 FROM `"+db_extra_table_+"` WHERE UPPER(username)=UPPER(?)", { name });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to check if extra row for '"+name+"' exists!", e);
        return false;
    }
}
 
bool dbconn::is_user_in_groups(const std::string& name, const std::vector<int>& group_ids)
{
    std::vector<std::string> group_params;
 
    sql_parameters params;
    params.emplace_back(name);
    for(int group_id : group_ids) {
        group_params.emplace_back("?");
        params.emplace_back(group_id);
    }
 
    try
    {
        return exists(connection_, "SELECT 1 FROM `"+db_users_table_+"` u, `"+db_user_group_table_+"` ug WHERE UPPER(u.username)=UPPER(?) AND u.USER_ID = ug.USER_ID AND ug.GROUP_ID in ("+utils::join(group_params)+")",
        params);
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to check if the user '"+name+"' is in groups!", e);
        return false;
    }
}
 
config dbconn::get_ban_info(const std::string& name, const std::string& ip)
{
    // selected ban_type value must be part of user_handler::BAN_TYPE
    auto ban_info_handler = [](const mariadb::result_set_ref& rslt) {
        config c;
 
        if(rslt->next()) {
            c["ban_type"] = rslt->get_signed32("ban_type");
            c["ban_end"] = rslt->get_signed32("ban_end");
            c["user_id"] = rslt->get_signed32("ban_userid");
            c["email"] = rslt->get_string("ban_email");
        }
 
        return c;
    };
 
    try
    {
        return get_complex_results(connection_, &ban_info_handler, "select ban_userid, ban_email, case when ban_ip != '' then 1 when ban_userid != 0 then 2 when ban_email != '' then 3 end as ban_type, ban_end from `"+db_banlist_table_+"` where (ban_ip = ? or ban_userid = (select user_id from `"+db_users_table_+"` where UPPER(username) = UPPER(?)) or UPPER(ban_email) = (select UPPER(user_email) from `"+db_users_table_+"` where UPPER(username) = UPPER(?))) AND ban_exclude = 0 AND (ban_end = 0 OR ban_end >= ?)",
            { ip, name, name, std::chrono::system_clock::to_time_t(std::chrono::system_clock::now()) });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Failed to check ban info for user '"+name+"' connecting from ip '"+ip+"'!", e);
        return {};
    }
}
 
std::string dbconn::get_user_string(const std::string& table, const std::string& column, const std::string& name)
{
    try
    {
        return get_single_string(connection_, "SELECT `"+column+"` from `"+table+"` WHERE UPPER(username)=UPPER(?)", { name });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to query column `"+column+"` from table `"+table+"` for user `"+name+"`", e);
        return "";
    }
}
int dbconn::get_user_int(const std::string& table, const std::string& column, const std::string& name)
{
    try
    {
        return static_cast<int>(get_single_long(connection_, "SELECT `"+column+"` from `"+table+"` WHERE UPPER(username)=UPPER(?)", { name }));
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to query column `"+column+"` from table `"+table+"` for user `"+name+"`", e);
        return 0;
    }
}
void dbconn::write_user_int(const std::string& column, const std::string& name, int value)
{
    try
    {
        if(!extra_row_exists(name))
        {
            modify(connection_, "INSERT INTO `"+db_extra_table_+"` VALUES(?,?,'0')", { name, value });
        }
        modify(connection_, "UPDATE `"+db_extra_table_+"` SET "+column+"=? WHERE UPPER(username)=UPPER(?)", { value, name });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to write `"+std::to_string(value)+"` to column `"+column+"` on table `"+db_extra_table_+"` for user `"+name+"`", e);
    }
}
 
void dbconn::insert_game_info(const std::string& uuid, int game_id, const std::string& version, const std::string& name, int reload, int observers, int is_public, int has_password)
{
    try
    {
        modify(connection_, "INSERT INTO `"+db_game_info_table_+"`(INSTANCE_UUID, GAME_ID, INSTANCE_VERSION, GAME_NAME, RELOAD, OBSERVERS, PUBLIC, PASSWORD) VALUES(?, ?, ?, ?, ?, ?, ?, ?)",
            { uuid, game_id, version, name, reload, observers, is_public, has_password });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Failed to insert game info row for UUID `"+uuid+"` and game ID `"+std::to_string(game_id)+"`", e);
    }
}
void dbconn::update_game_end(const std::string& uuid, int game_id, const std::string& replay_location)
{
    try
    {
        modify(connection_, "UPDATE `"+db_game_info_table_+"` SET END_TIME = CURRENT_TIMESTAMP, REPLAY_NAME = ? WHERE INSTANCE_UUID = ? AND GAME_ID = ?",
            { replay_location, uuid, game_id });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Failed to update the game end for game info row for UUID `"+uuid+"` and game ID `"+std::to_string(game_id)+"`", e);
    }
}
void dbconn::insert_game_player_info(const std::string& uuid, int game_id, const std::string& username, int side_number, int is_host, const std::string& faction, const std::string& version, const std::string& source, const std::string& current_user, const std::string& leaders)
{
    try
    {
        modify(connection_, "INSERT INTO `"+db_game_player_info_table_+"`(INSTANCE_UUID, GAME_ID, USER_ID, SIDE_NUMBER, IS_HOST, FACTION, CLIENT_VERSION, CLIENT_SOURCE, USER_NAME, LEADERS) VALUES(?, ?, IFNULL((SELECT user_id FROM `"+db_users_table_+"` WHERE upper(username) = upper(?)), -1), ?, ?, ?, ?, ?, ?, ?)",
            { uuid, game_id, username, side_number, is_host, faction, version, source, current_user, leaders });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Failed to insert game player info row for UUID `"+uuid+"` and game ID `"+std::to_string(game_id)+"`", e);
    }
}
unsigned long long dbconn::insert_game_content_info(const std::string& uuid, int game_id, const std::string& type, const std::string& name, const std::string& id, const std::string& addon_id, const std::string& addon_version)
{
    try
    {
        return modify(connection_, "INSERT INTO `"+db_game_content_info_table_+"`(INSTANCE_UUID, GAME_ID, TYPE, NAME, ID, ADDON_ID, ADDON_VERSION) VALUES(?, ?, ?, ?, ?, ?, ?)",
            { uuid, game_id, type, name, id, addon_id, addon_version });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Failed to insert game content info row for UUID `"+uuid+"` and game ID `"+std::to_string(game_id)+"`", e);
        return 0;
    }
}
void dbconn::set_oos_flag(const std::string& uuid, int game_id)
{
    try
    {
        modify(connection_, "UPDATE `"+db_game_info_table_+"` SET OOS = 1 WHERE INSTANCE_UUID = ? AND GAME_ID = ?",
            { uuid, game_id });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Failed to set the OOS flag for UUID `"+uuid+"` and game ID `"+std::to_string(game_id)+"`", e);
    }
}
 
bool dbconn::topic_id_exists(int topic_id) {
    try
    {
        return exists(connection_, "SELECT 1 FROM `"+db_topics_table_+"` WHERE TOPIC_ID = ?",
            { topic_id });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to check whether `"+std::to_string(topic_id)+"` exists.", e);
        return true;
    }
}
 
void dbconn::insert_addon_info(const std::string& instance_version, const std::string& id, const std::string& name, const std::string& type, const std::string& version, bool forum_auth, int topic_id, const std::string& uploader)
{
    try
    {
        modify(connection_, "INSERT INTO `"+db_addon_info_table_+"`(INSTANCE_VERSION, ADDON_ID, ADDON_NAME, TYPE, VERSION, FORUM_AUTH, FEEDBACK_TOPIC, UPLOADER) VALUES(?, ?, ?, ?, ?, ?, ?, ?)",
            { instance_version, id, name, type, version, forum_auth, topic_id, uploader });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to insert add-on info for add-on `"+id+"` for instance `"+instance_version+"`.", e);
    }
}
 
unsigned long long dbconn::insert_login(const std::string& username, const std::string& ip, const std::string& version)
{
    try
    {
        return modify_get_id(connection_, "INSERT INTO `"+db_connection_history_table_+"`(USER_NAME, IP, VERSION) values(lower(?), ?, ?)",
            { username, ip, version });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to insert login row user `"+username+"` and ip `"+ip+"`.", e);
        return 0;
    }
}
 
void dbconn::update_logout(unsigned long long login_id)
{
    try
    {
        modify(connection_, "UPDATE `"+db_connection_history_table_+"` SET LOGOUT_TIME = CURRENT_TIMESTAMP WHERE LOGIN_ID = ?",
            { login_id });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to update login row `"+std::to_string(login_id)+"`.", e);
    }
}
 
void dbconn::get_users_for_ip(const std::string& ip, std::ostringstream* out)
{
    try
    {
        mariadb::result_set_ref rslt = select(connection_, "SELECT USER_NAME, IP, date_format(LOGIN_TIME, '%Y/%m/%d %h:%i:%s'), coalesce(date_format(LOGOUT_TIME, '%Y/%m/%d %h:%i:%s'), '(not set)') FROM `"+db_connection_history_table_+"` WHERE IP LIKE ? order by LOGIN_TIME",
            { ip });
 
        *out << "\nCount of results for ip: " << rslt->row_count();
 
        while(rslt->next())
        {
            *out << "\nFound user " << rslt->get_string(0) << " with ip " << rslt->get_string(1)
                 << ", logged in at " << rslt->get_string(2) << " and logged out at " << rslt->get_string(3);
        }
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to select rows for ip `"+ip+"`.", e);
    }
}
 
void dbconn::get_ips_for_user(const std::string& username, std::ostringstream* out)
{
    try
    {
        mariadb::result_set_ref rslt = select(connection_, "SELECT USER_NAME, IP, date_format(LOGIN_TIME, '%Y/%m/%d %h:%i:%s'), coalesce(date_format(LOGOUT_TIME, '%Y/%m/%d %h:%i:%s'), '(not set)') FROM `"+db_connection_history_table_+"` WHERE USER_NAME LIKE ? order by LOGIN_TIME",
            { utf8::lowercase(username) });
 
        *out << "\nCount of results for user: " << rslt->row_count();
 
        while(rslt->next())
        {
            *out << "\nFound user " << rslt->get_string(0) << " with ip " << rslt->get_string(1)
                 << ", logged in at " << rslt->get_string(2) << " and logged out at " << rslt->get_string(3);
        }
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to select rows for player `"+username+"`.", e);
    }
}
 
void dbconn::update_addon_download_count(const std::string& instance_version, const std::string& id, const std::string& version)
{
    try
    {
        modify(connection_, "UPDATE `"+db_addon_info_table_+"` SET DOWNLOAD_COUNT = DOWNLOAD_COUNT+1 WHERE INSTANCE_VERSION = ? AND ADDON_ID = ? AND VERSION = ?",
            { instance_version, id, version });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to update download count for add-on "+id+" with version "+version+".", e);
    }
}
 
bool dbconn::is_user_author(const std::string& instance_version, const std::string& id, const std::string& username, int is_primary) {
    try
    {
        return exists(connection_, "SELECT 1 FROM `"+db_addon_authors_table_+"` WHERE INSTANCE_VERSION = ? AND ADDON_ID = ? AND AUTHOR = ? AND IS_PRIMARY = ?",
            { instance_version, id, username, is_primary });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to check whether `"+username+"` is an author of "+id+" for version "+instance_version+".", e);
        return false;
    }
}
 
void dbconn::delete_addon_authors(const std::string& instance_version, const std::string& id) {
    try
    {
        modify(connection_, "DELETE FROM `"+db_addon_authors_table_+"` WHERE INSTANCE_VERSION = ? AND ADDON_ID = ?",
            { instance_version, id });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to delete addon authors for "+id+" and version "+instance_version+".", e);
    }
}
 
void dbconn::insert_addon_author(const std::string& instance_version, const std::string& id, const std::string& author, int is_primary) {
    try
    {
        modify(connection_, "INSERT INTO `"+db_addon_authors_table_+"`(INSTANCE_VERSION, ADDON_ID, AUTHOR, IS_PRIMARY) VALUES(?,?,?,?)",
            { instance_version, id, author, is_primary });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to delete addon authors for "+id+" and version "+instance_version+".", e);
    }
}
 
bool dbconn::do_any_authors_exist(const std::string& instance_version, const std::string& id) {
    try
    {
        return exists(connection_, "SELECT 1 FROM `"+db_addon_authors_table_+"` WHERE INSTANCE_VERSION = ? AND ADDON_ID = ?",
            { instance_version, id });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Unable to check whether authors exist for "+id+" for version "+instance_version+".", e);
        return true;
    }
}
 
config dbconn::get_addon_downloads_info(const std::string& instance_version, const std::string& id) {
    auto addon_downloads_handler = [](const mariadb::result_set_ref& rslt) {
        config c;
 
        while(rslt->next()) {
            config& child = c.add_child("download_info");
            child["name"] = rslt->get_string("ADDON_NAME");
            child["version"] = rslt->get_string("VERSION");
            child["uploaded"] = rslt->get_date_time("UPLOADED_ON").str();
            child["downloads"] = rslt->get_unsigned32("DOWNLOAD_COUNT");
        }
 
        return c;
    };
 
    try
    {
        return get_complex_results(connection_, &addon_downloads_handler, "select ADDON_NAME, VERSION, UPLOADED_ON, DOWNLOAD_COUNT from "+db_addon_info_table_+" where INSTANCE_VERSION = ? and ADDON_ID = ? order by ADDON_NAME, UPLOADED_ON",
            { instance_version, id });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Failed to get addon download info!", e);
        return {};
    }
}
 
config dbconn::get_forum_auth_usage(const std::string& instance_version) {
    auto forum_auth_usage_handler = [](const mariadb::result_set_ref& rslt) {
        config c;
 
        if(rslt->next()) {
            c["all_count"] = rslt->get_signed64("ALL_COUNT");
            c["forum_auth_count"] = rslt->get_signed64("FORUM_AUTH_COUNT");
        } else {
            throw mariadb::exception::base("Count query somehow returned no rows!");
        }
 
        return c;
    };
 
    try
    {
        return get_complex_results(connection_, &forum_auth_usage_handler, "select (select count(distinct ADDON_ID) from "+db_addon_info_table_+" where INSTANCE_VERSION = ?) as ALL_COUNT, "
            "(select count(distinct ADDON_ID) from "+db_addon_info_table_+" where INSTANCE_VERSION = ? and FORUM_AUTH = 1) as FORUM_AUTH_COUNT from dual",
            { instance_version, instance_version });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Failed to get forum_auth usage!", e);
        return {};
    }
}
 
config dbconn::get_addon_admins(int site_admin_group, int forum_admin_group) {
    auto addon_admin_handler = [](const mariadb::result_set_ref& rslt) {
        config c;
 
        while(rslt->next()) {
            config& child = c.add_child("admin");
            child["username"] = rslt->get_string("USERNAME");
        }
 
        return c;
    };
 
    try
    {
        return get_complex_results(connection_, &addon_admin_handler, "SELECT u.USERNAME FROM `"+db_users_table_+"` u, `"+db_user_group_table_+"` ug WHERE u.USER_ID = ug.USER_ID AND ug.GROUP_ID in (?, ?)",
            { site_admin_group, forum_admin_group });
    }
    catch(const mariadb::exception::base& e)
    {
        log_sql_exception("Failed to get addon admins for groups '"+std::to_string(site_admin_group)+"' and '"+std::to_string(forum_admin_group)+"'!", e);
        return {};
    }
}
 
//
// handle complex query results
//
template <typename F>
config dbconn::get_complex_results(const mariadb::connection_ref& connection, F* handler, const std::string& sql, const sql_parameters& params)
{
    mariadb::result_set_ref rslt = select(connection, sql, params);
    config c = (*handler)(rslt);
    return c;
}
//
// handle single values
//
std::string dbconn::get_single_string(const mariadb::connection_ref& connection, const std::string& sql, const sql_parameters& params)
{
    mariadb::result_set_ref rslt = select(connection, sql, params);
    if(rslt->next())
    {
        return rslt->get_string(0);
    }
    else
    {
        throw mariadb::exception::base("No string value found in the database!");
    }
}
long dbconn::get_single_long(const mariadb::connection_ref& connection, const std::string& sql, const sql_parameters& params)
{
    mariadb::result_set_ref rslt = select(connection, sql, params);
    if(rslt->next())
    {
        // mariadbpp checks for strict integral equivalence, but we don't care
        // so check the type beforehand, call the associated getter, and let it silently get upcast to a long if needed
        // subselects also apparently return a decimal
        switch(rslt->column_type(0))
        {
            case mariadb::value::type::decimal:
                return static_cast<long>(rslt->get_decimal(0).float32());
            case mariadb::value::type::unsigned8:
            case mariadb::value::type::signed8:
                return rslt->get_signed8(0);
            case mariadb::value::type::unsigned16:
            case mariadb::value::type::signed16:
                return rslt->get_signed16(0);
            case mariadb::value::type::unsigned32:
            case mariadb::value::type::signed32:
                return rslt->get_signed32(0);
            case mariadb::value::type::unsigned64:
            case mariadb::value::type::signed64:
                return rslt->get_signed64(0);
            default:
                throw mariadb::exception::base("Value retrieved was not a long!");
        }
    }
    else
    {
        throw mariadb::exception::base("No long value found in the database!");
    }
}
bool dbconn::exists(const mariadb::connection_ref& connection, const std::string& sql, const sql_parameters& params)
{
    mariadb::result_set_ref rslt = select(connection, sql, params);
    return rslt->next();
}
 
//
// select or modify values
//
mariadb::result_set_ref dbconn::select(const mariadb::connection_ref& connection, const std::string& sql, const sql_parameters& params)
{
    try
    {
        mariadb::statement_ref stmt = query(connection, sql, params);
        mariadb::result_set_ref rslt = mariadb::result_set_ref(stmt->query());
        return rslt;
    }
    catch(const mariadb::exception::base& e)
    {
        ERR_SQL << "SQL query failed for query: `"+sql+"`";
        throw e;
    }
}
unsigned long long dbconn::modify(const mariadb::connection_ref& connection, const std::string& sql, const sql_parameters& params)
{
    try
    {
        mariadb::statement_ref stmt = query(connection, sql, params);
        unsigned long long count = stmt->execute();
        return count;
    }
    catch(const mariadb::exception::base& e)
    {
        ERR_SQL << "SQL query failed for query: `"+sql+"`";
        throw e;
    }
}
unsigned long long dbconn::modify_get_id(const mariadb::connection_ref& connection, const std::string& sql, const sql_parameters& params)
{
    try
    {
        mariadb::statement_ref stmt = query(connection, sql, params);
        unsigned long long count = stmt->insert();
        return count;
    }
    catch(const mariadb::exception::base& e)
    {
        ERR_SQL << "SQL query failed for query: `"+sql+"`";
        throw e;
    }
}
 
mariadb::statement_ref dbconn::query(const mariadb::connection_ref& connection, const std::string& sql, const sql_parameters& params)
{
    mariadb::statement_ref stmt = connection->create_statement(sql);
 
    unsigned i = 0;
    for(const auto& param : params)
    {
        std::visit([&i, &stmt](const auto& p) {
            using T = std::remove_cv_t<std::remove_reference_t<decltype(p)>>;
            if constexpr (std::is_same_v<T, bool>) {
                stmt->set_boolean(i, p);
            } else if constexpr (std::is_same_v<T, int>) {
                stmt->set_signed32(i, p);
            } else if constexpr (std::is_same_v<T, long>) {
                stmt->set_signed64(i, p);
            } else if constexpr (std::is_same_v<T, unsigned long long>) {
                stmt->set_signed64(i, p);
            } else if constexpr (std::is_same_v<T, std::string>) {
                stmt->set_string(i, p);
            } else if constexpr (std::is_same_v<T, const char*>) {
                stmt->set_string(i, p);
            } else {
                static_assert(utils::dependent_false_v<T>, "Unsupported parameter type in SQL query");
            }
        }, param);
        i++;
    }
 
    return stmt;
}
 
#endif //HAVE_MYSQLPP