remote_provider_utils.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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef REMOTE_PROVIDER_UTILS_H
#define REMOTE_PROVIDER_UTILS_H
 
#include <vector>
 
#include <json_schema_validator.h>
#include <kicommon.h>
#include <wx/string.h>
 

KICOMMON_API wxString UrlEncode( const wxString& aValue );

KICOMMON_API wxString RemoteProviderJsonString( const nlohmann::json& aObject, const char* aKey );

KICOMMON_API bool IsLoopbackHost( const wxString& aHost );

KICOMMON_API bool ValidateRemoteUrlSecurity( const wxString& aUrl, bool aAllowInsecureLocalhost,
                                             wxString& aError, const wxString& aLabel );

KICOMMON_API wxString NormalizedUrlOrigin( const wxString& aUrl );
 

class KICOMMON_API COLLECTING_JSON_ERROR_HANDLER : public nlohmann::json_schema::error_handler
{
public:
    void error( const nlohmann::json::json_pointer& aPointer, const nlohmann::json& aInstance,
                const std::string& aMessage ) override;
 
    bool     HasErrors() const { return !m_errors.empty(); }
    wxString FirstError() const;
 
private:
    std::vector<wxString> m_errors;
};
 
#endif // REMOTE_PROVIDER_UTILS_H