kigit_failure.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 KIGIT_FAILURE_H_
#define KIGIT_FAILURE_H_
 
#include <git/kicad_git_common.h>
#include <git/kigit_known_hosts.h>
#include <import_export.h>
 
#include <optional>
#include <vector>
 
#include <wx/string.h>
 

struct KIGIT_AUTH_ATTEMPT
{
    KIGIT_COMMON::GIT_CONN_TYPE connType = KIGIT_COMMON::GIT_CONN_TYPE::GIT_CONN_LOCAL;
    std::vector<wxString>       keysTried;          
    bool                        agentTried = false; 
};
 

enum class KIGIT_FAILURE
{
    AUTH_SSH_KEY_REJECTED,
    AUTH_NO_SSH_KEY,
    AUTH_HTTPS_REJECTED,
    KEY_LOAD_FAILED,
    HOST_KEY_UNKNOWN,
    HOST_KEY_CHANGED,
    HOST_KEY_UNVERIFIED, 
    KNOWN_HOSTS_UNREADABLE,
    SERVER_NOT_FOUND,
    HOST_UNREACHABLE,
    TLS_UNTRUSTED,
    PROXY,
    REPO_NOT_FOUND,
    SERVER_REFUSED, 
    PUSH_FORBIDDEN,
    PUSH_NOT_FAST_FORWARD,
    CANCELLED,
    OTHER
};
 

enum class KIGIT_OPERATION
{
    CONNECT,
    CLONE,
    FETCH,
    PUSH,
    SET_UP_REMOTE
};
 

struct KIGIT_FAILURE_CONTEXT
{
    KIGIT_OPERATION operation = KIGIT_OPERATION::CONNECT;
    wxString        remoteName; 
    wxString        url;        
    bool            authFailed = false; 
 
    std::optional<KIGIT::HOST_KEY_FAILURE> hostKey;        
    wxString                               hostKeyRefusal; 
    wxString                               pushRefusal;    
    wxString                               serverMessage;  
};
 
 
struct KIGIT_FAILURE_REPORT
{
    KIGIT_FAILURE kind = KIGIT_FAILURE::OTHER;
    wxString      summary; 
    wxString      details; 
};
 

struct KIGIT_OWNERSHIP_REFUSAL
{
    wxString summary;
    wxString trustCommand; 
};
 
 
namespace KIGIT
{

APIEXPORT KIGIT_FAILURE_REPORT DescribeGitFailure( const KIGIT_ERROR_INFO& aError, const KIGIT_AUTH_ATTEMPT& aAuth,
                                                   const KIGIT_FAILURE_CONTEXT& aContext );

APIEXPORT wxString UnexplainedFailure( KIGIT_OPERATION aOperation, const wxString& aUrl );

APIEXPORT bool IsCredentialFailure( KIGIT_FAILURE aKind );

constexpr size_t MAX_SERVER_TEXT = 4096;

APIEXPORT wxString DecodeServerText( const char* aData, size_t aLength );

APIEXPORT wxString StripEmbeddedUserinfo( const wxString& aText );

APIEXPORT wxString PrintableServerText( const wxString& aText );

APIEXPORT KIGIT_OWNERSHIP_REFUSAL DescribeOwnershipRefusal( const wxString& aStartDir, const wxString& aGitDir );
 
} // namespace KIGIT
 
#endif // KIGIT_FAILURE_H_