#include <core/kicad_algo.h>
#include <json_common.h>
#include <algorithm>
#include <set>
#include <database/database_lib_settings.h>
#include <kiplatform/secrets.h>
#include <settings/json_settings_internals.h>
#include <settings/parameters.h>
#include <string_utils.h>
#include <wildcards_and_files_ext.h>
#include <wx/filename.h>

Functions
template<typename T>
static void	patchKey (nlohmann::json &aObj, const std::string &aKey, const T &aValue, const T &aParsed, bool aRequired)
	Writes aValue to aObj[aKey] only if it differs from aParsed, the value the raw key was read as.

static void	normalizeScalarParents (JSON_SETTINGS_INTERNALS &aInternals)
	Nested params cannot store into a non-object parent, so replace a malformed one before storing.

std::unique_ptr< DATABASE_LIB_SETTINGS >	LoadDatabaseLibSettingsReadOnly (const wxString &aPath, bool *aLoaded)
	Loads a database library settings file without allowing the load itself (e.g.

wxString	DefaultDatabaseLibFileName (const wxString &aLibName)

static wxString	passwordService (const DATABASE_SOURCE &aSource)

DATABASE_SECRET_LOOKUP	DefaultDatabaseSecretLookup ()
	The lookup used when none is injected, which must never prompt to unlock the keyring.

bool	IsNoPromptSecretLookup (const DATABASE_SECRET_LOOKUP &aLookup)

static bool	hasKeyringLogin (const DATABASE_SOURCE &aSource)

bool	GetDatabasePassword (const DATABASE_SOURCE &aSource, std::string &aPassword, const DATABASE_SECRET_LOOKUP &aLookup)
	DSN passwords that are not saved in the (often shared) library file live in the system keyring, keyed by DSN and user name so every library on the same login shares one entry.

void	ResolveDatabasePassword (DATABASE_SOURCE &aSource, const DATABASE_SECRET_LOOKUP &aLookup)
	Fills in the source password from the keyring, but only when the library file did not supply one.

bool	StoreDatabasePassword (const DATABASE_SOURCE &aSource, const std::string &aPassword)
	Stores the password for the source's DSN login in the system keyring, or removes the entry when the password is empty.

Variables
const int	dblibSchemaVersion = 1

static constexpr const char *	c_scalarParents [] = { "/source", "/cache" }
	Objects that hold scalar settings rather than library tables.

Function Documentation

◆ DefaultDatabaseLibFileName()

wxString DefaultDatabaseLibFileName ( const wxString & aLibName )

Returns: a file name without extension for a new settings file, derived from the library name the user typed, or a generic name when that leaves nothing usable

Definition at line 431 of file database_lib_settings.cpp.

References name, and ReplaceIllegalFileNameChars().

Referenced by DIALOG_DATABASE_LIB_SETTINGS::chooseSavePath().

◆ DefaultDatabaseSecretLookup()

DATABASE_SECRET_LOOKUP DefaultDatabaseSecretLookup ( )

The lookup used when none is injected, which must never prompt to unlock the keyring.

Definition at line 451 of file database_lib_settings.cpp.

References KIPLATFORM::SECRETS::GetSecretNoPrompt().

Referenced by GetDatabasePassword().

◆ GetDatabasePassword()

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

DSN passwords that are not saved in the (often shared) library file live in the system keyring, keyed by DSN and user name so every library on the same login shares one entry.

Parameters

aLookup replaces the system keyring when set, for tests.