1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
|
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2023 Andre F. K. Iwers <iwers11@gmail.com>
* 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/>.
*/
#include <wx/log.h>
#include <fmt/core.h>
#include <wx/translation.h>
#include <ctime>
#include <boost/algorithm/string.hpp>
#include <json_common.h>
#include <wx/base64.h>
#include <kicad_curl/kicad_curl_easy.h>
#include <curl/curl.h>
#include <http_lib/http_lib_connection.h>
const char* const traceHTTPLib = "KICAD_HTTP_LIB";
HTTP_LIB_CONNECTION::HTTP_LIB_CONNECTION( const HTTP_LIB_SOURCE& aSource, bool aTestConnectionNow )
{
m_source = aSource;
if( aTestConnectionNow )
{
ValidateHTTPLibraryEndpoints();
}
}
HTTP_LIB_CONNECTION::~HTTP_LIB_CONNECTION()
{
// Do nothing
}
bool HTTP_LIB_CONNECTION::ValidateHTTPLibraryEndpoints()
{
m_endpointValid = false;
std::string res = "";
std::unique_ptr<KICAD_CURL_EASY> curl = createCurlEasyObject();
curl->SetURL( m_source.root_url );
try
{
curl->Perform();
res = curl->GetBuffer();
if( !checkServerResponse( curl ) )
return false;
if( res.length() == 0 )
{
m_lastError += wxString::Format( _( "KiCad received an empty response!" ) + "\n" );
}
else
{
nlohmann::json response = nlohmann::json::parse( res );
// Check that the endpoints exist, if not fail.
if( !response.at( http_endpoint_categories ).empty()
&& !response.at( http_endpoint_parts ).empty() )
{
m_endpointValid = true;
}
}
}
catch( const std::exception& e )
{
m_lastError += wxString::Format( _( "Error: %s" ) + "\n" + _( "API Response: %s" ) + "\n",
e.what(), res );
wxLogTrace( traceHTTPLib,
wxT( "ValidateHTTPLibraryEndpoints: Exception occurred while testing the API "
"connection: %s" ),
m_lastError );
m_endpointValid = false;
}
if( m_endpointValid )
{
syncCategories();
}
return m_endpointValid;
}
bool HTTP_LIB_CONNECTION::IsValidEndpoint() const
{
return m_endpointValid;
}
bool HTTP_LIB_CONNECTION::syncCategories()
{
if( !IsValidEndpoint() )
{
wxLogTrace( traceHTTPLib, wxT( "syncCategories: without valid connection!" ) );
return false;
}
std::string res = "";
std::unique_ptr<KICAD_CURL_EASY> curl = createCurlEasyObject();
curl->SetURL( m_source.root_url + http_endpoint_categories + ".json" );
try
{
curl->Perform();
res = curl->GetBuffer();
if( !checkServerResponse( curl ) )
{
return false;
}
nlohmann::json response = nlohmann::json::parse( res );
// collect the categories in vector
for( const auto& item : response.items() )
{
HTTP_LIB_CATEGORY category;
auto& value = item.value();
category.id = value["id"].get<std::string>();
category.name = value["name"].get<std::string>();
if( value.contains( "description" ) )
{
category.description = value["description"].get<std::string>();
m_categoryDescriptions[category.name] = category.description;
}
m_categories.push_back( category );
}
}
catch( const std::exception& e )
{
m_lastError += wxString::Format( _( "Error: %s" ) + "\n" + _( "API Response: %s" ) + "\n",
e.what(), res );
wxLogTrace( traceHTTPLib,
wxT( "syncCategories: Exception occurred while syncing categories: %s" ),
m_lastError );
m_categories.clear();
return false;
}
return true;
}
bool HTTP_LIB_CONNECTION::SelectOne( const std::string& aPartID, HTTP_LIB_PART& aFetchedPart )
{
if( !IsValidEndpoint() )
{
wxLogTrace( traceHTTPLib, wxT( "SelectOne: without valid connection!" ) );
return false;
}
// Check if there is already a part in our cache, if not fetch it
if( m_cachedParts.find( aPartID ) != m_cachedParts.end() )
{
// check if it's outdated, if so re-fetch
if( std::difftime( std::time( nullptr ), m_cachedParts[aPartID].lastCached )
< m_source.timeout_parts )
{
aFetchedPart = m_cachedParts[aPartID];
return true;
}
}
std::string res = "";
std::unique_ptr<KICAD_CURL_EASY> curl = createCurlEasyObject();
std::string url = m_source.root_url + fmt::format( "{}/{}.json", http_endpoint_parts, aPartID );
curl->SetURL( url );
try
{
curl->Perform();
res = curl->GetBuffer();
if( !checkServerResponse( curl ) )
{
return false;
}
nlohmann::ordered_json response = nlohmann::ordered_json::parse( res );
std::string key = "";
std::string value = "";
// the id used to identify the part, the name is needed to show a human-readable
// part description to the user inside the symbol chooser dialog
aFetchedPart.id = response.at( "id" );
// get a timestamp for caching
aFetchedPart.lastCached = std::time( nullptr );
// API might not want to return an optional name.
if( response.contains( "name" ) )
{
aFetchedPart.name = response.at( "name" );
}
else
{
aFetchedPart.name = aFetchedPart.id;
}
aFetchedPart.symbolIdStr = response.at( "symbolIdStr" );
// initially assume no exclusion
std::string exclude;
if( response.contains( "exclude_from_bom" ) )
{
// if key value doesn't exists default to false
exclude = response.at( "exclude_from_bom" );
aFetchedPart.exclude_from_bom = boolFromString( exclude, false );
}
// initially assume no exclusion
if( response.contains( "exclude_from_board" ) )
{
// if key value doesn't exists default to false
exclude = response.at( "exclude_from_board" );
aFetchedPart.exclude_from_board = boolFromString( exclude, false );
}
// initially assume no exclusion
if( response.contains( "exclude_from_sim" ) )
{
// if key value doesn't exists default to false
exclude = response.at( "exclude_from_sim" );
aFetchedPart.exclude_from_sim = boolFromString( exclude, false );
}
// remove previously loaded fields
aFetchedPart.fields.clear();
// Extract available fields
for( const auto& field : response.at( "fields" ).items() )
{
bool visible = true;
// name of the field
key = field.key();
// this is a dict
auto& properties = field.value();
value = properties.at( "value" );
// check if user wants to display field in schematic
if( properties.contains( "visible" ) )
{
std::string vis = properties.at( "visible" );
visible = boolFromString( vis, true );
}
// Add field to fields list
aFetchedPart.fields.push_back(
std::make_pair( key, std::make_tuple( value, visible ) ) );
}
}
catch( const std::exception& e )
{
m_lastError += wxString::Format( _( "Error: %s" ) + "\n" + _( "API Response: %s" ) + "\n",
e.what(), res );
wxLogTrace( traceHTTPLib,
wxT( "SelectOne: Exception occurred while retrieving part from REST API: %s" ),
m_lastError );
return false;
}
m_cachedParts[aFetchedPart.id] = aFetchedPart;
return true;
}
bool HTTP_LIB_CONNECTION::SelectAll( const HTTP_LIB_CATEGORY& aCategory,
std::vector<HTTP_LIB_PART>& aParts )
{
if( !IsValidEndpoint() )
{
wxLogTrace( traceHTTPLib, wxT( "SelectAll: without valid connection!" ) );
return false;
}
std::string res = "";
std::unique_ptr<KICAD_CURL_EASY> curl = createCurlEasyObject();
curl->SetURL( m_source.root_url
+ fmt::format( "{}/category/{}.json", http_endpoint_parts, aCategory.id ) );
try
{
curl->Perform();
res = curl->GetBuffer();
nlohmann::json response = nlohmann::json::parse( res );
for( nlohmann::json& item : response )
{
//PART result;
HTTP_LIB_PART part;
part.id = item.at( "id" );
if( item.contains( "description" ) )
{
// At this point we don't display anything so just set it to false
part.fields.push_back( std::make_pair(
"description", std::make_tuple( item.at( "description" ), false ) ) );
}
// API might not want to return an optional name.
if( item.contains( "name" ) )
{
part.name = item.at( "name" );
}
else
{
part.name = part.id;
}
// add to cache
m_cache[part.name] = std::make_tuple( part.id, aCategory.id );
aParts.emplace_back( std::move( part ) );
}
}
catch( const std::exception& e )
{
m_lastError += wxString::Format( _( "Error: %s" ) + "\n" + _( "API Response: %s" ) + "\n",
e.what(), res );
wxLogTrace( traceHTTPLib, wxT( "Exception occurred while syncing parts from REST API: %s" ),
m_lastError );
return false;
}
return true;
}
bool HTTP_LIB_CONNECTION::checkServerResponse( std::unique_ptr<KICAD_CURL_EASY>& aCurl )
{
int statusCode = aCurl->GetResponseStatusCode();
if( statusCode != 200 )
{
m_lastError += wxString::Format( _( "API responded with error code: %s" ) + "\n",
httpErrorCodeDescription( statusCode ) );
return false;
}
return true;
}
bool HTTP_LIB_CONNECTION::boolFromString( const std::any& aVal, bool aDefaultValue )
{
try
{
wxString strval( std::any_cast<std::string>( aVal ).c_str(), wxConvUTF8 );
if( strval.IsEmpty() )
return aDefaultValue;
strval.MakeLower();
for( const auto& trueVal : { wxS( "true" ), wxS( "yes" ), wxS( "y" ), wxS( "1" ) } )
{
if( strval.Matches( trueVal ) )
return true;
}
for( const auto& falseVal : { wxS( "false" ), wxS( "no" ), wxS( "n" ), wxS( "0" ) } )
{
if( strval.Matches( falseVal ) )
return false;
}
}
catch( const std::bad_any_cast& )
{
}
return aDefaultValue;
}
wxString HTTP_LIB_CONNECTION::httpErrorCodeDescription( uint16_t aHttpCode )
{
auto codeDescription =
[]( uint16_t aCode ) -> wxString
{
switch( aCode )
{
case 100: return wxS( "Continue" );
case 101: return wxS( "Switching Protocols" );
case 102: return wxS( "Processing" );
case 103: return wxS( "Early Hints" );
case 200: return wxS( "OK" );
case 201: return wxS( "Created" );
case 203: return wxS( "Non-Authoritative Information" );
case 204: return wxS( "No Content" );
case 205: return wxS( "Reset Content" );
case 206: return wxS( "Partial Content" );
case 207: return wxS( "Multi-Status" );
case 208: return wxS( "Already Reported" );
case 226: return wxS( "IM Used" );
case 300: return wxS( "Multiple Choices" );
case 301: return wxS( "Moved Permanently" );
case 302: return wxS( "Found" );
case 303: return wxS( "See Other" );
case 304: return wxS( "Not Modified" );
case 305: return wxS( "Use Proxy (Deprecated)" );
case 306: return wxS( "Unused" );
case 307: return wxS( "Temporary Redirect" );
case 308: return wxS( "Permanent Redirect" );
case 400: return wxS( "Bad Request" );
case 401: return wxS( "Unauthorized" );
case 402: return wxS( "Payment Required (Experimental)" );
case 403: return wxS( "Forbidden" );
case 404: return wxS( "Not Found" );
case 405: return wxS( "Method Not Allowed" );
case 406: return wxS( "Not Acceptable" );
case 407: return wxS( "Proxy Authentication Required" );
case 408: return wxS( "Request Timeout" );
case 409: return wxS( "Conflict" );
case 410: return wxS( "Gone" );
case 411: return wxS( "Length Required" );
case 412: return wxS( "Payload Too Large" );
case 414: return wxS( "URI Too Long" );
case 415: return wxS( "Unsupported Media Type" );
case 416: return wxS( "Range Not Satisfiable" );
case 417: return wxS( "Expectation Failed" );
case 418: return wxS( "I'm a teapot" );
case 421: return wxS( "Misdirected Request" );
case 422: return wxS( "Unprocessable Content" );
case 423: return wxS( "Locked" );
case 424: return wxS( "Failed Dependency" );
case 425: return wxS( "Too Early (Experimental)" );
case 426: return wxS( "Upgrade Required" );
case 428: return wxS( "Precondition Required" );
case 429: return wxS( "Too Many Requests" );
case 431: return wxS( "Request Header Fields Too Large" );
case 451: return wxS( "Unavailable For Legal Reasons" );
case 500: return wxS( "Internal Server Error" );
case 501: return wxS( "Not Implemented" );
case 502: return wxS( "Bad Gateway" );
case 503: return wxS( "Service Unavailable" );
case 504: return wxS( "Gateway Timeout" );
case 505: return wxS( "HTTP Version Not Supported" );
case 506: return wxS( "Variant Also Negotiates" );
case 507: return wxS( "Insufficient Storage" );
case 508: return wxS( "Loop Detected" );
case 510: return wxS( "Not Extended" );
case 511: return wxS( "Network Authentication Required" );
default: return wxS( "Unknown" );
}
};
return wxString::Format( wxS( "%d: %s" ), aHttpCode, codeDescription( aHttpCode ) );
}
|