database_lib_settings.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2022 Jon Evans <[email protected]>
 * 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_DATABASE_LIB_SETTINGS_H
#define KICAD_DATABASE_LIB_SETTINGS_H
 
#include <json_common.h>
#include <functional>
#include <settings/json_settings.h>
#include <wx/string.h>
 
#include <map>
#include <memory>
 
 
enum class DATABASE_SOURCE_TYPE
{
    ODBC,
    INVALID
};
 
 
struct KICOMMON_API DATABASE_SOURCE
{
    DATABASE_SOURCE_TYPE type;
    std::string          dsn;
    std::string          username;
    std::string          password;
    int                  timeout;
    std::string          connection_string;
};
 
 
struct KICOMMON_API DATABASE_FIELD_MAPPING
{
    std::string column;             
    std::string name;               
    wxString    name_wx;            
    bool        visible_on_add;     
    bool        visible_in_chooser; 
    bool        show_name;   
    bool        inherit_properties; 
    nlohmann::json source;          
 
    DATABASE_FIELD_MAPPING();
 
    explicit DATABASE_FIELD_MAPPING( const std::string& aColumn, const std::string& aName,
                                     bool aVisibleOnAdd, bool aVisibleInChooser, bool aShowName,
                                     bool aInheritProperties );
 
    void SetName( const std::string& aName );
};
 
 
struct KICOMMON_API MAPPABLE_SYMBOL_PROPERTIES
{
    std::string description;
    std::string footprint_filters;
    std::string keywords;
    std::string exclude_from_sim;
    std::string exclude_from_bom;
    std::string exclude_from_board;
 
    bool operator==( const MAPPABLE_SYMBOL_PROPERTIES& aOther ) const = default;
};
 

struct KICOMMON_API DATABASE_LIB_TABLE
{
    std::string name;              
    std::string table;             
    std::string key_col;           
    std::string symbols_col;       
    std::string footprints_col;    
    std::string pins_col;          
 
    MAPPABLE_SYMBOL_PROPERTIES properties;
    std::vector<DATABASE_FIELD_MAPPING> fields;
 
    nlohmann::json source;         
};
 
 
struct KICOMMON_API DATABASE_CACHE_SETTINGS
{
    int max_size;    
    int max_age;     
};
 

using DATABASE_SECRET_LOOKUP = std::function<bool( const wxString& aService, const wxString& aKey, wxString& aSecret )>;
 
class KICOMMON_API DATABASE_LIB_SETTINGS : public JSON_SETTINGS
{
public:
    DATABASE_LIB_SETTINGS( const std::string& aFilename );
 
    virtual ~DATABASE_LIB_SETTINGS() {}
 
    DATABASE_SOURCE m_Source{};
 
    std::vector<DATABASE_LIB_TABLE> m_Tables;
 
    DATABASE_CACHE_SETTINGS m_Cache{};
 
    bool m_GloballyUniqueKeys = false;
 
    std::string m_Name;
    std::string m_Description;

    void Load() override;

    bool Store() override;

    void ResolvePassword( const DATABASE_SECRET_LOOKUP& aLookup = nullptr );
 
protected:
    wxString getFileExt() const override;
 
private:
    static nlohmann::json tableToJson( const DATABASE_LIB_TABLE& aTable );
    static DATABASE_LIB_TABLE tableFromJson( const nlohmann::json& aEntry );
    static nlohmann::json fieldToJson( const DATABASE_FIELD_MAPPING& aField );
    static DATABASE_FIELD_MAPPING fieldFromJson( const nlohmann::json& aEntry );

    struct LOADED_SCALARS
    {
        std::string             name;
        std::string             description;
        DATABASE_SOURCE         source{};
        DATABASE_CACHE_SETTINGS cache{};
        bool                    globallyUniqueKeys = false;
    } m_loaded;
};
 

KICOMMON_API std::unique_ptr<DATABASE_LIB_SETTINGS> LoadDatabaseLibSettingsReadOnly( const wxString& aPath,
                                                                                     bool* aLoaded = nullptr );

KICOMMON_API wxString DefaultDatabaseLibFileName( const wxString& aLibName );

KICOMMON_API DATABASE_SECRET_LOOKUP DefaultDatabaseSecretLookup();

KICOMMON_API bool IsNoPromptSecretLookup( const DATABASE_SECRET_LOOKUP& aLookup );

KICOMMON_API bool GetDatabasePassword( const DATABASE_SOURCE& aSource, std::string& aPassword,
                                       const DATABASE_SECRET_LOOKUP& aLookup = nullptr );

KICOMMON_API void ResolveDatabasePassword( DATABASE_SOURCE& aSource,
                                           const DATABASE_SECRET_LOOKUP& aLookup = nullptr );

KICOMMON_API bool StoreDatabasePassword( const DATABASE_SOURCE& aSource, const std::string& aPassword );
 
#endif //KICAD_DATABASE_LIB_SETTINGS_H