sqlite_backend.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 3 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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef KICAD_SQLITE_BACKEND_H
#define KICAD_SQLITE_BACKEND_H
 
#include <atomic>
#include <chrono>
#include <functional>
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
#include <database/database_backend.h>
 
#include "db_worker_thread.h"
 
struct SQLITE_DB;
 

class SQLITE_BACKEND : public DATABASE_BACKEND
{
public:
    SQLITE_BACKEND( std::string aPath, int aTimeoutSeconds );
 
    ~SQLITE_BACKEND() override;
 
    bool Connect() override;
 
    void Disconnect() override;
 
    bool IsConnected() const override { return m_connected; }
 
    bool ListTables( std::vector<std::string>& aTables ) override;
 
    std::optional<DB_TABLE_INFO> DescribeTable( const std::string& aTable ) override;
 
 
    bool ReadTable( const DB_TABLE_INFO& aTable, const std::vector<std::string>& aColumns, size_t aMaxRows,
                    std::vector<std::string>& aLabels, const DB_ROW_SINK& aSink ) override;
 
    std::string GetLastError() const override { return m_lastError; }
 
    DB_FAILURE GetLastFailure() const override { return m_lastFailure; }

    static std::string FileUri( const std::string& aPath, bool aWindowsPath );

    static bool IsUncPath( const std::string& aPath );

    static bool IsNetworkPath( const std::string& aPath );

    static bool IsRemoteFuseMount( const std::string& aMountInfo, const std::string& aPath );
 
private:
    std::chrono::milliseconds callerBound() const;

    template <typename R>
    std::optional<R> runOnWorker( std::function<R( DB_JOB_CONTEXT& )> aJob, const DB_ROW_SINK* aSink );

    void dropConnection();
 
    void fail( DB_FAILURE aFailure, std::string aError );

    void failCall( DB_FAILURE aFailure, std::string aMessage );

    bool requireConnection();
 
    std::string m_path;
    int         m_timeout;
 
    std::unique_ptr<DB_WORKER_THREAD> m_worker;
    std::shared_ptr<SQLITE_DB>        m_db;
 
    std::atomic<bool> m_connected{ false };
 
    std::string m_lastError;
    DB_FAILURE  m_lastFailure = DB_FAILURE::UNKNOWN;
};
 
#endif // KICAD_SQLITE_BACKEND_H