#include <git_commit_handler.h>

Inheritance diagram for GIT_COMMIT_HANDLER:

Public Types
enum class	GIT_STATUS { GIT_STATUS_UNTRACKED , GIT_STATUS_CURRENT , GIT_STATUS_MODIFIED , GIT_STATUS_ADDED , GIT_STATUS_DELETED , GIT_STATUS_BEHIND , GIT_STATUS_AHEAD , GIT_STATUS_CONFLICTED , GIT_STATUS_IGNORED , GIT_STATUS_LAST }

enum class	GIT_CONN_TYPE { GIT_CONN_HTTPS = 0 , GIT_CONN_SSH , GIT_CONN_LOCAL , GIT_CONN_LAST }

Public Member Functions
	GIT_COMMIT_HANDLER (git_repository *aRepo)

virtual	~GIT_COMMIT_HANDLER ()

CommitResult	PerformCommit (const std::vector< wxString > &aFiles, const wxString &aMessage, const wxString &aAuthorName, const wxString &aAuthorEmail)

CommitResult	PerformAmend (const std::vector< wxString > &aFiles, const wxString &aMessage, const wxString &aAuthorName, const wxString &aAuthorEmail)

wxString	GetErrorString () const

git_repository *	GetRepo () const

void	SetRepo (git_repository *aRepo)

wxString	GetCurrentBranchName () const

std::vector< wxString >	GetBranchNames () const

std::vector< wxString >	GetProjectDirs ()
	Return a vector of project files in the repository.

std::pair< std::set< wxString >, std::set< wxString > >	GetDifferentFiles () const
	Return a pair of sets of files that differ locally from the remote repository The first set is files that have been committed locally but not pushed The second set is files that have been committed remotely but not pulled.

wxString	GetUsername () const

wxString	GetPassword ()

GIT_CONN_TYPE	GetConnType () const

void	SetUsername (const wxString &aUsername)

void	SetPassword (const wxString &aPassword)

void	SetSSHKey (const wxString &aSSHKey)

unsigned &	TestedTypes ()

bool	HasLocalCommits () const

bool	HasPushAndPullRemote () const

void	UpdateCurrentBranchInfo ()

wxString	GetGitRootDirectory () const

wxString	GetRemotename () const

wxString	GetRemoteNameOrDefault () const
	Returns GetRemotename() when non-empty, otherwise "origin".

wxString	GetUpstreamShorthand () const
	Returns the upstream shorthand for the current branch (e.g.

void	SetProjectDir (const wxString &aProjectDir)
	Set the project directory path, preserving any symlinks in the path.

wxString	GetProjectDir () const
	Get the project directory path.

void	ResetNextKey ()

wxString	GetNextPublicKey ()

void	SetRemote (const wxString &aRemote)

const wxString &	GetRemote () const

int	HandleSSHKeyAuthentication (git_cred **aOut, const wxString &aUsername)

int	HandlePlaintextAuthentication (git_cred **aOut, const wxString &aUsername)

int	HandleSSHAgentAuthentication (git_cred **aOut, const wxString &aUsername)

bool	IsCancelled () const

void	SetCancelled (bool aCancel)

bool	WasAuthFailure () const

void	ClearAuthFailure ()

void	SetAuthFailure ()

Static Public Member Functions
static wxString	GetLastGitError ()

Protected Attributes
git_repository *	m_repo

wxString	m_projectDir

GIT_CONN_TYPE	m_connType

wxString	m_remote

wxString	m_hostname

wxString	m_username

wxString	m_password

unsigned	m_testedTypes

bool	m_authFailed = false

std::mutex	m_gitActionMutex

Private Member Functions
void	AddErrorString (const wxString &aErrorString)

void	updatePublicKeys ()

void	updateConnectionType ()

Private Attributes
wxString	m_errorString

std::vector< wxString >	m_publicKeys

int	m_nextPublicKey

bool	m_secretFetched

std::atomic< bool >	m_cancel

Static Private Attributes
static const unsigned	KIGIT_CREDENTIAL_SSH_AGENT = 1 << sizeof( m_testedTypes - 1 )

Friends
class	LIBGIT_BACKEND

Detailed Description

Definition at line 36 of file git_commit_handler.h.

Member Enumeration Documentation

◆ GIT_CONN_TYPE

enum class KIGIT_COMMON::GIT_CONN_TYPE

stronginherited

Enumerator
GIT_CONN_HTTPS
GIT_CONN_SSH
GIT_CONN_LOCAL
GIT_CONN_LAST

Definition at line 84 of file kicad_git_common.h.

◆ GIT_STATUS

enum class KIGIT_COMMON::GIT_STATUS

stronginherited

Enumerator
GIT_STATUS_UNTRACKED
GIT_STATUS_CURRENT
GIT_STATUS_MODIFIED
GIT_STATUS_ADDED
GIT_STATUS_DELETED
GIT_STATUS_BEHIND
GIT_STATUS_AHEAD
GIT_STATUS_CONFLICTED
GIT_STATUS_IGNORED
GIT_STATUS_LAST

Definition at line 70 of file kicad_git_common.h.

Constructor & Destructor Documentation

◆ GIT_COMMIT_HANDLER()

GIT_COMMIT_HANDLER::GIT_COMMIT_HANDLER ( git_repository * aRepo )

Definition at line 23 of file git_commit_handler.cpp.

References KIGIT_COMMON::KIGIT_COMMON().

◆ ~GIT_COMMIT_HANDLER()

GIT_COMMIT_HANDLER::~GIT_COMMIT_HANDLER ( )

virtual

Definition at line 28 of file git_commit_handler.cpp.

Member Function Documentation

◆ AddErrorString()

void GIT_COMMIT_HANDLER::AddErrorString ( const wxString & aErrorString )

private

Definition at line 55 of file git_commit_handler.cpp.

References m_errorString.

Referenced by LIBGIT_BACKEND::Amend(), LIBGIT_BACKEND::Commit(), and LIBGIT_BACKEND.

◆ ClearAuthFailure()

void KIGIT_COMMON::ClearAuthFailure ( )

inlineinherited

Definition at line 185 of file kicad_git_common.h.

References m_authFailed.

Referenced by PROJECT_TREE_PANE::onGitFetch(), PROJECT_TREE_PANE::onGitInitializeProject(), PROJECT_TREE_PANE::onGitPullProject(), PROJECT_TREE_PANE::onGitPushProject(), and promptForGitCredentials().

◆ GetBranchNames()

std::vector< wxString > KIGIT_COMMON::GetBranchNames ( ) const

inherited

Definition at line 177 of file kicad_git_common.cpp.

References m_repo, and traceGit.

◆ GetConnType()

KIGIT_COMMON::GIT_CONN_TYPE KIGIT_COMMON::GetConnType ( ) const

inherited

Definition at line 792 of file kicad_git_common.cpp.

References GetRemotename(), GIT_CONN_HTTPS, GIT_CONN_LOCAL, GIT_CONN_SSH, and m_remote.

Referenced by promptForGitCredentials().

◆ GetCurrentBranchName()

wxString KIGIT_COMMON::GetCurrentBranchName ( ) const

inherited

Definition at line 126 of file kicad_git_common.cpp.

References m_repo, and traceGit.

Referenced by TEXT_EVAL_VCS::GetBranch(), PROJECT_TREE_PANE::onGitPullProject(), and PROJECT_TREE_PANE::onGitPushProject().

◆ GetDifferentFiles()

std::pair< std::set< wxString >, std::set< wxString > > KIGIT_COMMON::GetDifferentFiles ( ) const

inherited

Return a pair of sets of files that differ locally from the remote repository The first set is files that have been committed locally but not pushed The second set is files that have been committed remotely but not pulled.

Definition at line 308 of file kicad_git_common.cpp.

References KIGIT::CollectDiffDeltas(), GetLastGitError(), IsCancelled(), m_repo, and traceGit.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ GetErrorString()

wxString GIT_COMMIT_HANDLER::GetErrorString ( ) const

Definition at line 49 of file git_commit_handler.cpp.

References m_errorString.

Referenced by BOOST_AUTO_TEST_CASE(), PROJECT_TREE_PANE::onGitAmendCommit(), and PROJECT_TREE_PANE::onGitCommit().

◆ GetGitRootDirectory()

wxString KIGIT_COMMON::GetGitRootDirectory ( ) const

inherited

Definition at line 677 of file kicad_git_common.cpp.

References m_repo, and path.

Referenced by BOOST_AUTO_TEST_CASE().

◆ GetLastGitError()

static wxString KIGIT_COMMON::GetLastGitError ( )

inlinestaticinherited

Definition at line 164 of file kicad_git_common.h.

◆ GetNextPublicKey()

wxString KIGIT_COMMON::GetNextPublicKey ( )

inlineinherited

Definition at line 140 of file kicad_git_common.h.

References m_nextPublicKey, and m_publicKeys.

Referenced by HandleSSHKeyAuthentication().

◆ GetPassword()

wxString KIGIT_COMMON::GetPassword ( )

inherited

Definition at line 158 of file kicad_git_common.cpp.

References KIPLATFORM::SECRETS::GetSecret(), GIT_CONN_LOCAL, m_connType, m_password, m_remote, m_secretFetched, and m_username.

Referenced by HandlePlaintextAuthentication(), and HandleSSHKeyAuthentication().

◆ GetProjectDir()

wxString KIGIT_COMMON::GetProjectDir ( ) const

inherited

Get the project directory path.

If a symlink-preserving path was set via SetProjectDir(), returns that path. Otherwise falls back to git_repository_workdir().

Definition at line 73 of file kicad_git_common.cpp.

References m_projectDir, and m_repo.

◆ GetProjectDirs()

std::vector< wxString > KIGIT_COMMON::GetProjectDirs ( )

inherited

Return a vector of project files in the repository.

Sorted by the depth of the project file in the directory tree

Returns: std::vector<wxString> of project files

Definition at line 240 of file kicad_git_common.cpp.

References GetLastGitError(), m_repo, and traceGit.

◆ GetRemote()

const wxString & KIGIT_COMMON::GetRemote ( ) const

inlineinherited

Definition at line 156 of file kicad_git_common.h.

References m_remote.

Referenced by promptForGitCredentials().

◆ GetRemotename()

wxString KIGIT_COMMON::GetRemotename ( ) const

inherited

Definition at line 579 of file kicad_git_common.cpp.

References GetLastGitError(), m_repo, and traceGit.

Referenced by GetConnType(), GetRemoteNameOrDefault(), and UpdateCurrentBranchInfo().

◆ GetRemoteNameOrDefault()

wxString KIGIT_COMMON::GetRemoteNameOrDefault ( ) const

inherited

Returns GetRemotename() when non-empty, otherwise "origin".

Centralizes the fallback policy used by push/pull/fetch paths.

Definition at line 568 of file kicad_git_common.cpp.

References GetRemotename().

Referenced by GetUpstreamShorthand(), HasPushAndPullRemote(), lookup_upstream_ref(), PROJECT_TREE_PANE::onGitFetch(), LIBGIT_BACKEND::PerformFetch(), LIBGIT_BACKEND::PerformPull(), and LIBGIT_BACKEND::Push().

◆ GetRepo()

git_repository * KIGIT_COMMON::GetRepo ( ) const

inherited

Definition at line 67 of file kicad_git_common.cpp.

References m_repo.

Referenced by LIBGIT_BACKEND::AddToIndex(), LIBGIT_BACKEND::Amend(), LIBGIT_BACKEND::Commit(), PROJECT_TREE_PANE::onGitRemoteSettings(), LIBGIT_BACKEND::PerformAddToIndex(), LIBGIT_BACKEND::PerformRemoveFromIndex(), and LIBGIT_BACKEND::RemoveFromIndex().

◆ GetUpstreamShorthand()

wxString KIGIT_COMMON::GetUpstreamShorthand ( ) const

inherited

Returns the upstream shorthand for the current branch (e.g.

"origin/master"), or an empty string when there is no current branch.

Definition at line 90 of file kicad_git_common.cpp.

References GetRemoteNameOrDefault(), and m_repo.

Referenced by BOOST_AUTO_TEST_CASE(), PROJECT_TREE_PANE::onGitPullProject(), and PROJECT_TREE_PANE::onGitPushProject().

◆ GetUsername()

wxString KIGIT_COMMON::GetUsername ( ) const

inlineinherited

Definition at line 92 of file kicad_git_common.h.

References m_username.

Referenced by promptForGitCredentials().

◆ HandlePlaintextAuthentication()

int KIGIT_COMMON::HandlePlaintextAuthentication	(	git_cred **	aOut,
		const wxString &	aUsername )

inherited

Definition at line 921 of file kicad_git_common.cpp.

References GetPassword(), and m_testedTypes.

Referenced by credentials_cb().

◆ HandleSSHAgentAuthentication()

int KIGIT_COMMON::HandleSSHAgentAuthentication	(	git_cred **	aOut,
		const wxString &	aUsername )

inherited

Definition at line 932 of file kicad_git_common.cpp.

References GetLastGitError(), KIGIT_CREDENTIAL_SSH_AGENT, m_testedTypes, and traceGit.

Referenced by HandleSSHKeyAuthentication().

◆ HandleSSHKeyAuthentication()

int KIGIT_COMMON::HandleSSHKeyAuthentication	(	git_cred **	aOut,
		const wxString &	aUsername )

inherited

Definition at line 885 of file kicad_git_common.cpp.

References GetLastGitError(), GetNextPublicKey(), GetPassword(), HandleSSHAgentAuthentication(), KIGIT_CREDENTIAL_SSH_AGENT, m_testedTypes, and traceGit.

Referenced by credentials_cb().

◆ HasLocalCommits()

bool KIGIT_COMMON::HasLocalCommits ( ) const

inherited

Definition at line 452 of file kicad_git_common.cpp.

References GetLastGitError(), m_repo, and traceGit.

Referenced by PROJECT_TREE_PANE::onRight().

◆ HasPushAndPullRemote()

bool KIGIT_COMMON::HasPushAndPullRemote ( ) const

inherited

Definition at line 513 of file kicad_git_common.cpp.

References GetRemoteNameOrDefault(), m_repo, and traceGit.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and PROJECT_TREE_PANE::onRight().

◆ IsCancelled()

bool KIGIT_COMMON::IsCancelled ( ) const

inlineinherited

Definition at line 174 of file kicad_git_common.h.

References m_cancel.

Referenced by GetDifferentFiles(), PROJECT_TREE_PANE::gitStatusTimerHandler(), PROJECT_TREE_PANE::onGitSyncTimer(), progress_cb(), and transfer_progress_cb().

◆ PerformAmend()

CommitResult GIT_COMMIT_HANDLER::PerformAmend	(	const std::vector< wxString > &	aFiles,
		const wxString &	aMessage,
		const wxString &	aAuthorName,
		const wxString &	aAuthorEmail )

Definition at line 42 of file git_commit_handler.cpp.

References GIT_BACKEND::Amend(), and GetGitBackend().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and PROJECT_TREE_PANE::onGitAmendCommit().

◆ PerformCommit()

CommitResult GIT_COMMIT_HANDLER::PerformCommit	(	const std::vector< wxString > &	aFiles,
		const wxString &	aMessage,
		const wxString &	aAuthorName,
		const wxString &	aAuthorEmail )