UpdateFetcher.cpp

Go to the documentation of this file.

/*
 * This file is part of the TrinityCore Project. See AUTHORS file for Copyright information
 *
 * 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; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#include "UpdateFetcher.h"
#include "CryptoHash.h"
#include "DBUpdater.h"
#include "Field.h"
#include "Log.h"
#include "QueryResult.h"
#include "Util.h"
#include <boost/filesystem/directory.hpp>
#include <boost/filesystem/operations.hpp>
#include <fstream>
#include <sstream>
 
using namespace boost::filesystem;
 
struct UpdateFetcher::DirectoryEntry
{
    DirectoryEntry(Path const& path_, State state_) : path(path_), state(state_) { }
 
    Path const path;
    State const state;
};
 
UpdateFetcher::UpdateFetcher(Path const& sourceDirectory,
    std::function<void(std::string const&)> const& apply,
    std::function<void(Path const& path)> const& applyFile,
    std::function<QueryResult(std::string const&)> const& retrieve) :
        _sourceDirectory(std::make_unique<Path>(sourceDirectory)), _apply(apply), _applyFile(applyFile),
        _retrieve(retrieve)
{
}
 
UpdateFetcher::~UpdateFetcher() = default;
 
UpdateFetcher::LocaleFileStorage UpdateFetcher::GetFileList() const
{
    LocaleFileStorage files;
    DirectoryStorage directories = ReceiveIncludedDirectories();
    for (auto const& entry : directories)
        FillFileListRecursively(entry.path, files, entry.state, 1);
 
    return files;
}
 
void UpdateFetcher::FillFileListRecursively(Path const& path, LocaleFileStorage& storage, State const state, uint32 const depth) const
{
    static uint32 const MAX_DEPTH = 10;
    static directory_iterator const end;
 
    for (directory_iterator itr(path); itr != end; ++itr)
    {
        if (is_directory(itr->path()))
        {
            if (depth < MAX_DEPTH)
                FillFileListRecursively(itr->path(), storage, state, depth + 1);
        }
        else if (itr->path().extension() == ".sql")
        {
            TC_LOG_TRACE("sql.updates", "Added locale file \"{}\".", itr->path().filename().generic_string());
 
            LocaleFileEntry const entry = { itr->path(), state };
 
            // Check for doubled filenames
            // Because elements are only compared by their filenames, this is ok
            if (storage.contains(entry))
            {
                TC_LOG_FATAL("sql.updates", "Duplicate filename \"{}\" occurred. Because updates are ordered " \
                    "by their filenames, every name needs to be unique!", itr->path().generic_string());
 
                throw UpdateException("Updating failed, see the log for details.");
            }
 
            storage.insert(entry);
        }
    }
}
 
UpdateFetcher::DirectoryStorage UpdateFetcher::ReceiveIncludedDirectories() const
{
    DirectoryStorage directories;
 
    QueryResult const result = _retrieve("SELECT `path`, `state` FROM `updates_include`");
    if (!result)
        return directories;
 
    do
    {
        Field* fields = result->Fetch();
 
        std::string path = fields[0].GetString();
        if (path.starts_with("$"))
            path = _sourceDirectory->generic_string() + path.substr(1);
 
        Path const p(path);
 
        if (!is_directory(p))
        {
            TC_LOG_WARN("sql.updates", "DBUpdater: Given update include directory \"{}\" does not exist, skipped!", p.generic_string());
            continue;
        }
 
        DirectoryEntry const entry = { p, AppliedFileEntry::StateConvert(fields[1].GetStringView()) };
        directories.push_back(entry);
 
        TC_LOG_TRACE("sql.updates", "Added applied file \"{}\" from remote.", p.filename().generic_string());
 
    } while (result->NextRow());
 
    return directories;
}
 
UpdateFetcher::AppliedFileStorage UpdateFetcher::ReceiveAppliedFiles() const
{
    AppliedFileStorage map;
 
    QueryResult result = _retrieve("SELECT `name`, `hash`, `state`, UNIX_TIMESTAMP(`timestamp`) FROM `updates` ORDER BY `name` ASC");
    if (!result)
        return map;
 
    do
    {
        Field* fields = result->Fetch();
 
        AppliedFileEntry const entry = { fields[0].GetString(), fields[1].GetString(),
            AppliedFileEntry::StateConvert(fields[2].GetStringView()), fields[3].GetUInt64() };
 
        map.insert(std::make_pair(entry.name, entry));
    }
    while (result->NextRow());
 
    return map;
}
 
std::string UpdateFetcher::ReadSQLUpdate(boost::filesystem::path const& file) const
{
    std::ifstream in(file.c_str());
    if (!in.is_open())
    {
        TC_LOG_FATAL("sql.updates", "Failed to open the sql update \"{}\" for reading! "
                     "Stopping the server to keep the database integrity, "
                     "try to identify and solve the issue or disable the database updater.",
                     file.generic_string());
 
        throw UpdateException("Opening the sql update failed!");
    }
 
    auto update = [&in]  {
        std::ostringstream ss;
        ss << in.rdbuf();
        return ss.str();
    }();
 
    in.close();
    return update;
}
 
UpdateResult UpdateFetcher::Update(bool const redundancyChecks,
                                   bool const allowRehash,
                                   bool const archivedRedundancy,
                                   int32 const cleanDeadReferencesMaxCount) const
{
    LocaleFileStorage const available = GetFileList();
    AppliedFileStorage applied = ReceiveAppliedFiles();
 
    size_t countRecentUpdates = 0;
    size_t countArchivedUpdates = 0;
 
    // Count updates
    for (auto const& [_, appliedFile] : applied)
        if (appliedFile.state == RELEASED)
            ++countRecentUpdates;
        else
            ++countArchivedUpdates;
 
    // Fill hash to name cache
    HashToFileNameStorage hashToName;
    for (auto const& [name, appliedFile] : applied)
        hashToName.try_emplace(appliedFile.hash, name);
 
    size_t importedUpdates = 0;
 
    for (auto const& availableQuery : available)
    {
        std::string availableQueryFilename = availableQuery.first.filename().string();
 
        TC_LOG_DEBUG("sql.updates", "Checking update \"{}\"...", availableQueryFilename);
 
        AppliedFileStorage::const_iterator iter = applied.find(availableQueryFilename);
        if (iter != applied.end())
        {
            // If redundancy is disabled, skip it, because the update is already applied.
            if (!redundancyChecks)
            {
                TC_LOG_DEBUG("sql.updates", ">> Update is already applied, skipping redundancy checks.");
                applied.erase(iter);
                continue;
            }
 
            // If the update is in an archived directory and is marked as archived in our database, skip redundancy checks (archived updates never change).
            if (!archivedRedundancy && (iter->second.state == ARCHIVED) && (availableQuery.second == ARCHIVED))
            {
                TC_LOG_DEBUG("sql.updates", ">> Update is archived and marked as archived in database, skipping redundancy checks.");
                applied.erase(iter);
                continue;
            }
        }
 
        // Calculate a Sha1 hash based on query content.
        std::string const hash = ByteArrayToHexStr(Trinity::Crypto::SHA1::GetDigestOf(ReadSQLUpdate(availableQuery.first)));
 
        UpdateMode mode = MODE_APPLY;
 
        // Update is not in our applied list
        if (iter == applied.end())
        {
            // Catch renames (different filename, but same hash)
            HashToFileNameStorage::const_iterator const hashIter = hashToName.find(hash);
            if (hashIter != hashToName.end())
            {
                // Check if the original file was removed. If not, we've got a problem.
                LocaleFileStorage::const_iterator localeIter = available.find(hashIter->second);
 
                // Conflict!
                if (localeIter != available.end())
                {
                    TC_LOG_WARN("sql.updates", ">> It seems like the update \"{}\" \'{}\' was renamed, but the old file is still there! "
                        "Treating it as a new file! (It is probably an unmodified copy of the file \"{}\")",
                            availableQueryFilename, hash.substr(0, 7),
                                localeIter->first.filename().string());
                }
                // It is safe to treat the file as renamed here
                else
                {
                    TC_LOG_INFO("sql.updates", ">> Renaming update \"{}\" to \"{}\" \'{}\'.",
                        hashIter->second, availableQueryFilename, hash.substr(0, 7));
 
                    RenameEntry(hashIter->second, availableQueryFilename);
                    applied.erase(hashIter->second);
                    continue;
                }
            }
            // Apply the update if it was never seen before.
            else
            {
                TC_LOG_INFO("sql.updates", ">> Applying update \"{}\" \'{}\'...",
                    availableQueryFilename, hash.substr(0, 7));
            }
        }
        // Rehash the update entry if it exists in our database with an empty hash.
        else if (allowRehash && iter->second.hash.empty())
        {
            mode = MODE_REHASH;
 
            TC_LOG_INFO("sql.updates", ">> Re-hashing update \"{}\" \'{}\'...", availableQueryFilename,
                hash.substr(0, 7));
        }
        else
        {
            // If the hash of the files differs from the one stored in our database, reapply the update (because it changed).
            if (iter->second.hash != hash)
            {
                TC_LOG_INFO("sql.updates", ">> Reapplying update \"{}\" \'{}\' -> \'{}\' (it changed)...", availableQueryFilename,
                    iter->second.hash.substr(0, 7), hash.substr(0, 7));
            }
            else
            {
                // If the file wasn't changed and just moved, update its state (if necessary).
                if (iter->second.state != availableQuery.second)
                {
                    TC_LOG_DEBUG("sql.updates", ">> Updating the state of \"{}\" to \'{}\'...",
                        availableQueryFilename, AppliedFileEntry::StateConvert(availableQuery.second));
 
                    UpdateState(availableQueryFilename, availableQuery.second);
                }
 
                TC_LOG_DEBUG("sql.updates", ">> Update is already applied and matches the hash \'{}\'.", hash.substr(0, 7));
 
                applied.erase(iter);
                continue;
            }
        }
 
        uint32 speed = 0;
        AppliedFileEntry const file = { availableQueryFilename, hash, availableQuery.second, 0 };
 
        switch (mode)
        {
            case MODE_APPLY:
                speed = Apply(availableQuery.first);
                [[fallthrough]];
            case MODE_REHASH:
                UpdateEntry(file, speed);
                break;
        }
 
        if (iter != applied.end())
            applied.erase(iter);
 
        if (mode == MODE_APPLY)
            ++importedUpdates;
    }
 
    // Cleanup up orphaned entries (if enabled)
    if (!applied.empty())
    {
        bool const doCleanup = (cleanDeadReferencesMaxCount < 0) || (applied.size() <= static_cast<size_t>(cleanDeadReferencesMaxCount));
 
        for (auto const& entry : applied)
        {
            TC_LOG_WARN("sql.updates", ">> The file \'{}\' was applied to the database, but is missing in" \
                " your update directory now!", entry.first);
 
            if (doCleanup)
                TC_LOG_INFO("sql.updates", "Deleting orphaned entry \'{}\'...", entry.first);
        }
 
        if (doCleanup)
            CleanUp(applied);
        else
        {
            TC_LOG_ERROR("sql.updates", "Cleanup is disabled! There were {} dirty files applied to your database, " \
                "but they are now missing in your source directory!", applied.size());
        }
    }
 
    return UpdateResult(importedUpdates, countRecentUpdates, countArchivedUpdates);
}
 
uint32 UpdateFetcher::Apply(Path const& path) const
{
    using Time = std::chrono::high_resolution_clock;
 
    // Benchmark query speed
    auto const begin = Time::now();
 
    // Update database
    _applyFile(path);
 
    // Return the time it took the query to apply
    return uint32(std::chrono::duration_cast<std::chrono::milliseconds>(Time::now() - begin).count());
}
 
void UpdateFetcher::UpdateEntry(AppliedFileEntry const& entry, uint32 const speed) const
{
    std::string const update = Trinity::StringFormat(R"(REPLACE INTO `updates` (`name`, `hash`, `state`, `speed`) VALUES ("{}", "{}", '{}', {}))",
        entry.name, entry.hash, entry.GetStateAsString(), speed);
 
    // Update database
    _apply(update);
}
 
void UpdateFetcher::RenameEntry(std::string const& from, std::string const& to) const
{
    // Delete the target if it exists
    {
        std::string const update = "DELETE FROM `updates` WHERE `name`=\"" + to + "\"";
 
        // Update database
        _apply(update);
    }
 
    // Rename
    {
        std::string const update = "UPDATE `updates` SET `name`=\"" + to + "\" WHERE `name`=\"" + from + "\"";
 
        // Update database
        _apply(update);
    }
}
 
void UpdateFetcher::CleanUp(AppliedFileStorage const& storage) const
{
    if (storage.empty())
        return;
 
    std::stringstream update;
    size_t remaining = storage.size();
 
    update << "DELETE FROM `updates` WHERE `name` IN(";
 
    for (auto const& entry : storage)
    {
        update << "\"" << entry.first << "\"";
        if ((--remaining) > 0)
            update << ", ";
    }
 
    update << ")";
 
    // Update database
    _apply(update.str());
}
 
void UpdateFetcher::UpdateState(std::string const& name, State const state) const
{
    std::string const update = Trinity::StringFormat(R"(UPDATE `updates` SET `state`='{}' WHERE `name`="{}")", AppliedFileEntry::StateConvert(state), name);
 
    // Update database
    _apply(update);
}
 
std::string UpdateFetcher::PathCompare::MakeComparisonObject(LocaleFileEntry const& arg)
{
    return arg.first.filename().string();
}