mirror of
https://github.com/Part-DB/Part-DB-server.git
synced 2026-03-01 04:49:36 +00:00
ae7e31f0bd
Changes based on jbtronics' review of PR #1241: - Rename kicad_export -> eda_visibility (entities, forms, templates, translations, tests) with nullable bool for system default support - Merge two database migrations into one (Version20260211000000) - Rename createCachedJsonResponse -> createCacheableJsonResponse - Change bool $apiV2 -> int $apiVersion with version validation - EDA visibility field only shown for part parameters, not other entities - PopulateKicadCommand: check alternative names of footprints/categories - PopulateKicadCommand: support external JSON mapping file (--mapping-file) - Ship default mappings JSON at contrib/kicad-populate/default_mappings.json - Add system-wide defaultEdaVisibility setting in KiCadEDASettings - Add KiCad HTTP Library v2 spec link in controller docs
105 lines
No EOL
3.6 KiB
PHP
105 lines
No EOL
3.6 KiB
PHP
<?php
|
|
/*
|
|
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
|
|
*
|
|
* Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
|
|
namespace App\Controller;
|
|
|
|
use App\Entity\Parts\Category;
|
|
use App\Entity\Parts\Part;
|
|
use App\Services\EDA\KiCadHelper;
|
|
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
|
|
use Symfony\Component\HttpFoundation\JsonResponse;
|
|
use Symfony\Component\HttpFoundation\Request;
|
|
use Symfony\Component\HttpFoundation\Response;
|
|
use Symfony\Component\Routing\Attribute\Route;
|
|
|
|
/**
|
|
* @see \App\Tests\Controller\KiCadApiControllerTest
|
|
*/
|
|
#[Route('/kicad-api/v1')]
|
|
class KiCadApiController extends AbstractController
|
|
{
|
|
public function __construct(
|
|
private readonly KiCadHelper $kiCADHelper,
|
|
)
|
|
{
|
|
}
|
|
|
|
#[Route('/', name: 'kicad_api_root')]
|
|
public function root(): Response
|
|
{
|
|
$this->denyAccessUnlessGranted('HAS_ACCESS_PERMISSIONS');
|
|
|
|
//The API documentation says this can be either blank or the URL to the endpoints
|
|
return $this->json([
|
|
'categories' => '',
|
|
'parts' => '',
|
|
]);
|
|
}
|
|
|
|
#[Route('/categories.json', name: 'kicad_api_categories')]
|
|
public function categories(Request $request): Response
|
|
{
|
|
$this->denyAccessUnlessGranted('@categories.read');
|
|
|
|
$data = $this->kiCADHelper->getCategories();
|
|
return $this->createCacheableJsonResponse($request, $data, 300);
|
|
}
|
|
|
|
#[Route('/parts/category/{category}.json', name: 'kicad_api_category')]
|
|
public function categoryParts(Request $request, ?Category $category): Response
|
|
{
|
|
if ($category !== null) {
|
|
$this->denyAccessUnlessGranted('read', $category);
|
|
} else {
|
|
$this->denyAccessUnlessGranted('@categories.read');
|
|
}
|
|
$this->denyAccessUnlessGranted('@parts.read');
|
|
|
|
$minimal = $request->query->getBoolean('minimal', false);
|
|
$data = $this->kiCADHelper->getCategoryParts($category, $minimal);
|
|
return $this->createCacheableJsonResponse($request, $data, 300);
|
|
}
|
|
|
|
#[Route('/parts/{part}.json', name: 'kicad_api_part')]
|
|
public function partDetails(Request $request, Part $part): Response
|
|
{
|
|
$this->denyAccessUnlessGranted('read', $part);
|
|
|
|
$data = $this->kiCADHelper->getKiCADPart($part);
|
|
return $this->createCacheableJsonResponse($request, $data, 60);
|
|
}
|
|
|
|
/**
|
|
* Creates a JSON response with HTTP cache headers (ETag and Cache-Control).
|
|
* Returns 304 Not Modified if the client's ETag matches.
|
|
*/
|
|
private function createCacheableJsonResponse(Request $request, array $data, int $maxAge): Response
|
|
{
|
|
$response = new JsonResponse($data);
|
|
$response->setEtag(md5(json_encode($data)));
|
|
$response->headers->set('Cache-Control', 'private, max-age=' . $maxAge);
|
|
$response->isNotModified($request);
|
|
|
|
return $response;
|
|
}
|
|
} |