)
+ 'hard_break' => true, // Preserves line breaks
+ 'remove_nodes' => 'nav footer script style' // Extra safety layer
+ ]);
+
+ return $converter->convert($htmlToConvert);
+ }
+
+ public function getCapabilities(): array
+ {
+ return [
+ ProviderCapabilities::BASIC,
+ ProviderCapabilities::PICTURE,
+ ProviderCapabilities::DATASHEET,
+ ProviderCapabilities::PRICE,
+ ProviderCapabilities::PARAMETERS,
+ ];
+ }
+
+ private function callLLM(string $htmlContent, string $url, ?string $structuredData = null): array
+ {
+ $input = new MessageBag(
+ Message::forSystem($this->buildSystemPrompt()),
+ Message::ofUser("Extract part information from this webpage content:\n\nURL: $url\n\n$htmlContent")
+ );
+
+ if ($structuredData) {
+ $input->add(Message::ofUser("Following data was extracted using traditional methods, but might be incomplete or inaccurate.
+ Enrich it with the actual website data:\n\n".$structuredData));
+ }
+
+ try {
+ $aiPlatform = $this->AIPlatformRegistry->getPlatform($this->settings->platform ?? throw new \RuntimeException('No AI platform selected') );
+
+ //'openai/gpt-5-mini'
+ $result = $aiPlatform->invoke($this->settings->model ?? throw new \RuntimeException('No model selected'), $input, [
+ 'response_format' => [
+ 'type' => 'json_schema',
+ 'json_schema' => $this->jsonSchemaConverter->getJSONSchema(),
+ ]
+ ]);
+ } catch (\Throwable $e) {
+ throw new \RuntimeException('LLM invocation failed: '.$e->getMessage(), previous: $e);
+ }
+
+ return $result->getResult()->getContent();
+ }
+
+ private function buildSystemPrompt(): string
+ {
+ $tmp = <<<'PROMPT'
+You are an expert at extracting electronic component information from web pages. Extract structured data in JSON format, from markdown extracted from a product page.
+Focus on the main content of the page, such as product descriptions, specifications, and tables. Ignore navigation menus, footers, and sidebars.
+
+Rules:
+- manufacturing_status: Use "active", "obsolete", "nrfnd" (not recommended for new designs), "discontinued", or null
+- parameters: Extract technical specs like voltage, current, temperature, etc. and put them into the fields according to the JSON schema. Include units if available.
+- prices: Extract pricing tiers with minimum_quantity, price, and currency code
+- URLs must be absolute (include https://...)
+- If information is not found, use null
+- Try to avoid duplicating parameters, if the same parameter is mentioned multiple times, or if it is already used in another field.
+- Include only the 1 to 3 most relevant images, such as the main product image or important diagrams. Ignore decorative images, logos, or icons.
+- Extract GTIN / EAN if available, as it can be useful for matching parts across different sources, even if the part number is different.
+- Include detailed product description into notes field, as it can contain important information that doesn't fit into other fields, such as features, applications, or unique selling points.
+
+PROMPT;
+
+ if ($this->settings->outputLanguage === null) {
+ $tmp .= "\n\nProvide the response in the same language of the webpage.";
+ } else {
+ $tmp .= "\n\nThe response must be in ". Languages::getName($this->settings->outputLanguage, 'en') ." language. Translate texts if needed.";
+ }
+
+ if ($this->settings->additionalInstructions) {
+ $tmp .= "\n\nAdditional instructions:\n" . $this->settings->additionalInstructions;
+ }
+
+ return $tmp;
+ }
+
+}
diff --git a/src/Services/InfoProviderSystem/Providers/BatchInfoProviderInterface.php b/src/Services/InfoProviderSystem/Providers/BatchInfoProviderInterface.php
index 549f117a..cd918439 100644
--- a/src/Services/InfoProviderSystem/Providers/BatchInfoProviderInterface.php
+++ b/src/Services/InfoProviderSystem/Providers/BatchInfoProviderInterface.php
@@ -34,7 +34,8 @@ interface BatchInfoProviderInterface extends InfoProviderInterface
* Search for multiple keywords in a single batch operation and return the results, ordered by the keywords.
* This allows for a more efficient search compared to running multiple single searches.
* @param string[] $keywords
+ * @param array
$options An associative array of options which can be used to modify the search behavior. The supported options depend on the provider and should be documented in the provider's documentation.
* @return array An associative array where the key is the keyword and the value is the search results for that keyword
*/
- public function searchByKeywordsBatch(array $keywords): array;
+ public function searchByKeywordsBatch(array $keywords, array $options = []): array;
}
diff --git a/src/Services/InfoProviderSystem/Providers/BuerklinProvider.php b/src/Services/InfoProviderSystem/Providers/BuerklinProvider.php
index c2291107..ca6e26e1 100644
--- a/src/Services/InfoProviderSystem/Providers/BuerklinProvider.php
+++ b/src/Services/InfoProviderSystem/Providers/BuerklinProvider.php
@@ -120,7 +120,7 @@ class BuerklinProvider implements BatchInfoProviderInterface, URLHandlerInfoProv
];
}
- private function getProduct(string $code): array
+ private function getProduct(string $code, bool $use_cache = true): array
{
$code = strtoupper(trim($code));
if ($code === '') {
@@ -132,6 +132,11 @@ class BuerklinProvider implements BatchInfoProviderInterface, URLHandlerInfoProv
md5($code . '|' . $this->settings->language . '|' . $this->settings->currency)
);
+ if (!$use_cache) {
+ $this->partInfoCache->deleteItem($cacheKey);
+ unset($this->productCache[$cacheKey]);
+ }
+
if (isset($this->productCache[$cacheKey])) {
return $this->productCache[$cacheKey];
}
@@ -461,9 +466,11 @@ class BuerklinProvider implements BatchInfoProviderInterface, URLHandlerInfoProv
}
/**
+ * @param string $keyword
+ * @param array $options
* @return PartDetailDTO[]
*/
- public function searchByKeyword(string $keyword): array
+ public function searchByKeyword(string $keyword, array $options = []): array
{
$keyword = strtoupper(trim($keyword));
if ($keyword === '') {
@@ -486,17 +493,18 @@ class BuerklinProvider implements BatchInfoProviderInterface, URLHandlerInfoProv
// Fallback: try direct lookup by code
try {
- $product = $this->getProduct($keyword);
+ $product = $this->getProduct($keyword, use_cache: !($options[self::OPTION_NO_CACHE] ?? false));
return [$this->getPartDetail($product)];
} catch (\Throwable $e) {
return [];
}
}
- public function getDetails(string $id): PartDetailDTO
+ public function getDetails(string $id, array $options = []): PartDetailDTO
{
// Detail endpoint is /products/{code}/
- $response = $this->getProduct($id);
+ //By default use cache for details, but allow bypassing cache with option (e.g. for refresh)
+ $response = $this->getProduct($id, use_cache: !($options[self::OPTION_NO_CACHE] ?? false));
return $this->getPartDetail($response);
}
@@ -588,10 +596,11 @@ class BuerklinProvider implements BatchInfoProviderInterface, URLHandlerInfoProv
}
/**
- * @param string[] $keywords
+ * @param array $keywords
+ * @param array $options
* @return array
*/
- public function searchByKeywordsBatch(array $keywords): array
+ public function searchByKeywordsBatch(array $keywords, array $options = []): array
{
/** @var array $results */
$results = [];
@@ -643,27 +652,27 @@ class BuerklinProvider implements BatchInfoProviderInterface, URLHandlerInfoProv
public function getIDFromURL(string $url): ?string
{
- //Inputs:
- //https://www.buerklin.com/de/p/bkl-electronic/niedervoltsteckverbinder/072341-l/40F1332/
+ //Inputs:
+ //https://www.buerklin.com/de/p/bkl-electronic/niedervoltsteckverbinder/072341-l/40F1332/
//https://www.buerklin.com/de/p/40F1332/
//https://www.buerklin.com/en/p/bkl-electronic/dc-connectors/072341-l/40F1332/
//https://www.buerklin.com/en/p/40F1332/
//The ID is the last part after the manufacturer/category/mpn segment and before the final slash
//https://www.buerklin.com/de/p/bkl-electronic/niedervoltsteckverbinder/072341-l/40F1332/#download should also work
-
+
$path = parse_url($url, PHP_URL_PATH);
-
+
if (!$path) {
return null;
}
-
+
// Ensure it's actually a product URL
if (strpos($path, '/p/') === false) {
return null;
}
-
+
$id = basename(rtrim($path, '/'));
-
+
return $id !== '' && $id !== 'p' ? $id : null;
}
diff --git a/src/Services/InfoProviderSystem/Providers/CanopyProvider.php b/src/Services/InfoProviderSystem/Providers/CanopyProvider.php
index 18864a49..aee30d6b 100644
--- a/src/Services/InfoProviderSystem/Providers/CanopyProvider.php
+++ b/src/Services/InfoProviderSystem/Providers/CanopyProvider.php
@@ -111,7 +111,7 @@ class CanopyProvider implements InfoProviderInterface
return null;
}
- public function searchByKeyword(string $keyword): array
+ public function searchByKeyword(string $keyword, array $options = []): array
{
$response = $this->httpClient->request('GET', self::SEARCH_API_URL, [
'query' => [
@@ -177,15 +177,17 @@ class CanopyProvider implements InfoProviderInterface
return new PurchaseInfoDTO(self::DISTRIBUTOR_NAME, order_number: $asin, prices: $priceDtos, product_url: $this->productPageFromASIN($asin));
}
- public function getDetails(string $id): PartDetailDTO
+ public function getDetails(string $id, array $options = []): PartDetailDTO
{
//Check that the id is a valid ASIN (10 characters, letters and numbers)
if (!preg_match('/^[A-Z0-9]{10}$/', $id)) {
throw new \InvalidArgumentException("The id must be a valid ASIN (10 characters, letters and numbers)");
}
+ $do_not_cache = ($options[self::OPTION_NO_CACHE] ?? false) || $this->settings->alwaysGetDetails;
+
//Use cached details if available and the settings allow it, to avoid unnecessary API requests, since the search results already contain most of the details
- if(!$this->settings->alwaysGetDetails && ($cached = $this->getFromCache($id)) !== null) {
+ if(!$do_not_cache && ($cached = $this->getFromCache($id)) !== null) {
return $cached;
}
diff --git a/src/Services/InfoProviderSystem/Providers/ConradProvider.php b/src/Services/InfoProviderSystem/Providers/ConradProvider.php
index 39de1e23..2e6708be 100644
--- a/src/Services/InfoProviderSystem/Providers/ConradProvider.php
+++ b/src/Services/InfoProviderSystem/Providers/ConradProvider.php
@@ -88,7 +88,7 @@ readonly class ConradProvider implements InfoProviderInterface, URLHandlerInfoPr
return null;
}
- public function searchByKeyword(string $keyword): array
+ public function searchByKeyword(string $keyword, array $options = []): array
{
$url = $this->settings->shopID->getAPIRoot() . self::SEARCH_ENDPOINT . '/'
. $this->settings->shopID->getDomainEnd() . '/' . $this->settings->shopID->getLanguage()
@@ -279,7 +279,7 @@ readonly class ConradProvider implements InfoProviderInterface, URLHandlerInfoPr
);
}
- public function getDetails(string $id): PartDetailDTO
+ public function getDetails(string $id, array $options = []): PartDetailDTO
{
$productInfoURL = $this->settings->shopID->getAPIRoot() . '/product/1/service/' . $this->settings->shopID->getShopID()
. '/product/' . $id;
diff --git a/src/Services/InfoProviderSystem/Providers/DigikeyProvider.php b/src/Services/InfoProviderSystem/Providers/DigikeyProvider.php
index d7eb6e4f..e7a62aa4 100644
--- a/src/Services/InfoProviderSystem/Providers/DigikeyProvider.php
+++ b/src/Services/InfoProviderSystem/Providers/DigikeyProvider.php
@@ -106,7 +106,7 @@ class DigikeyProvider implements InfoProviderInterface
return $this->settings->clientId !== null && $this->settings->clientId !== '' && $this->authTokenManager->hasToken(self::OAUTH_APP_NAME);
}
- public function searchByKeyword(string $keyword): array
+ public function searchByKeyword(string $keyword, array $options = []): array
{
$request = [
'Keywords' => $keyword,
@@ -159,7 +159,7 @@ class DigikeyProvider implements InfoProviderInterface
return $result;
}
- public function getDetails(string $id): PartDetailDTO
+ public function getDetails(string $id, array $options = []): PartDetailDTO
{
try {
$response = $this->digikeyClient->request('GET', '/products/v4/search/' . urlencode($id) . '/productdetails', [
diff --git a/src/Services/InfoProviderSystem/Providers/Element14Provider.php b/src/Services/InfoProviderSystem/Providers/Element14Provider.php
index 9ae45728..1d9e092c 100644
--- a/src/Services/InfoProviderSystem/Providers/Element14Provider.php
+++ b/src/Services/InfoProviderSystem/Providers/Element14Provider.php
@@ -282,12 +282,12 @@ class Element14Provider implements InfoProviderInterface, URLHandlerInfoProvider
};
}
- public function searchByKeyword(string $keyword): array
+ public function searchByKeyword(string $keyword, array $options = []): array
{
return $this->queryByTerm('any:' . $keyword);
}
- public function getDetails(string $id): PartDetailDTO
+ public function getDetails(string $id, array $options = []): PartDetailDTO
{
$tmp = $this->queryByTerm('id:' . $id);
if (count($tmp) === 0) {
diff --git a/src/Services/InfoProviderSystem/Providers/EmptyProvider.php b/src/Services/InfoProviderSystem/Providers/EmptyProvider.php
index e0de9772..915a118c 100644
--- a/src/Services/InfoProviderSystem/Providers/EmptyProvider.php
+++ b/src/Services/InfoProviderSystem/Providers/EmptyProvider.php
@@ -54,7 +54,7 @@ class EmptyProvider implements InfoProviderInterface
return true;
}
- public function searchByKeyword(string $keyword): array
+ public function searchByKeyword(string $keyword, array $options = []): array
{
return [
@@ -69,7 +69,7 @@ class EmptyProvider implements InfoProviderInterface
];
}
- public function getDetails(string $id): PartDetailDTO
+ public function getDetails(string $id, array $options = []): PartDetailDTO
{
throw new \RuntimeException('No part details available');
}
diff --git a/src/Services/InfoProviderSystem/Providers/FixAndValidateUrlTrait.php b/src/Services/InfoProviderSystem/Providers/FixAndValidateUrlTrait.php
new file mode 100644
index 00000000..c9395a46
--- /dev/null
+++ b/src/Services/InfoProviderSystem/Providers/FixAndValidateUrlTrait.php
@@ -0,0 +1,58 @@
+.
+ */
+
+declare(strict_types=1);
+
+
+namespace App\Services\InfoProviderSystem\Providers;
+
+use App\Exceptions\ProviderIDNotSupportedException;
+
+trait FixAndValidateUrlTrait
+{
+ private function fixAndValidateURL(string $url): string
+ {
+ $originalUrl = $url;
+
+ //Add scheme if missing
+ if (!preg_match('/^https?:\/\//', $url)) {
+ //Remove any leading slashes
+ $url = ltrim($url, '/');
+
+ //If the URL starts with https:/ or http:/, add the missing slash
+ //Traefik removes the double slash as secruity measure, so we want to be forgiving and add it back if needed
+ //See https://github.com/Part-DB/Part-DB-server/issues/1296
+ if (preg_match('/^https?:\/[^\/]/', $url)) {
+ $url = preg_replace('/^(https?:)\/([^\/])/', '$1//$2', $url);
+ } else {
+ $url = 'https://'.$url;
+ }
+ }
+
+ //If this is not a valid URL with host, domain and path, throw an exception
+ if (filter_var($url, FILTER_VALIDATE_URL) === false ||
+ parse_url($url, PHP_URL_HOST) === null ||
+ parse_url($url, PHP_URL_PATH) === null) {
+ throw new ProviderIDNotSupportedException("The given ID is not a valid URL: ".$originalUrl);
+ }
+
+ return $url;
+ }
+}
diff --git a/src/Services/InfoProviderSystem/Providers/GenericWebProvider.php b/src/Services/InfoProviderSystem/Providers/GenericWebProvider.php
index bd6d30e6..06a9d4c1 100644
--- a/src/Services/InfoProviderSystem/Providers/GenericWebProvider.php
+++ b/src/Services/InfoProviderSystem/Providers/GenericWebProvider.php
@@ -25,6 +25,7 @@ namespace App\Services\InfoProviderSystem\Providers;
use App\Exceptions\ProviderIDNotSupportedException;
use App\Helpers\RandomizeUseragentHttpClient;
+use App\Services\InfoProviderSystem\CreateFromUrlHelper;
use App\Services\InfoProviderSystem\DTOs\ParameterDTO;
use App\Services\InfoProviderSystem\DTOs\PartDetailDTO;
use App\Services\InfoProviderSystem\DTOs\PriceDTO;
@@ -42,20 +43,24 @@ use Brick\Schema\Interfaces\Thing;
use Brick\Schema\SchemaReader;
use Brick\Schema\SchemaTypeList;
use Symfony\Component\DomCrawler\Crawler;
+use Symfony\Component\HttpClient\NoPrivateNetworkHttpClient;
use Symfony\Contracts\HttpClient\HttpClientInterface;
class GenericWebProvider implements InfoProviderInterface
{
+ use FixAndValidateUrlTrait;
+
public const DISTRIBUTOR_NAME = 'Website';
private readonly HttpClientInterface $httpClient;
public function __construct(HttpClientInterface $httpClient, private readonly GenericWebProviderSettings $settings,
- private readonly ProviderRegistry $providerRegistry, private readonly PartInfoRetriever $infoRetriever,
+ private readonly CreateFromUrlHelper $createFromUrlHelper,
)
{
- $this->httpClient = (new RandomizeUseragentHttpClient($httpClient))->withOptions(
+ //Use NoPrivateNetworkHttpClient to prevent SSRF vulnerabilities, and RandomizeUseragentHttpClient to make it harder for servers to block us
+ $this->httpClient = (new RandomizeUseragentHttpClient(new NoPrivateNetworkHttpClient($httpClient)))->withOptions(
[
'timeout' => 15,
]
@@ -83,19 +88,23 @@ class GenericWebProvider implements InfoProviderInterface
return $this->settings->enabled;
}
- public function searchByKeyword(string $keyword): array
+ public function searchByKeyword(string $keyword, array $options = []): array
{
$url = $this->fixAndValidateURL($keyword);
- //Before loading the page, try to delegate to another provider
- $delegatedPart = $this->delegateToOtherProvider($url);
- if ($delegatedPart !== null) {
- return [$delegatedPart];
+ if (!($options[self::OPTION_SKIP_DELEGATION] ?? false)) {
+ //Before loading the page, try to delegate to another provider
+ $delegatedPart = $this->createFromUrlHelper->delegateToOtherProvider($url, $this);
+ if ($delegatedPart !== null) {
+ return [$delegatedPart];
+ }
}
try {
+ $new_options = $options;
+ $new_options[self::OPTION_SKIP_DELEGATION] = true; //Skip delegation for the getDetails call to prevent infinite loops
return [
- $this->getDetails($keyword, false) //We already tried delegation
+ $this->getDetails($keyword, $new_options)
]; } catch (ProviderIDNotSupportedException $e) {
return [];
}
@@ -272,71 +281,16 @@ class GenericWebProvider implements InfoProviderInterface
return null;
}
- /**
- * Delegates the URL to another provider if possible, otherwise return null
- * @param string $url
- * @return SearchResultDTO|null
- */
- private function delegateToOtherProvider(string $url): ?SearchResultDTO
- {
- //Extract domain from url:
- $host = parse_url($url, PHP_URL_HOST);
- if ($host === false || $host === null) {
- return null;
- }
- $provider = $this->providerRegistry->getProviderHandlingDomain($host);
-
- if ($provider !== null && $provider->isActive() && $provider->getProviderKey() !== $this->getProviderKey()) {
- try {
- $id = $provider->getIDFromURL($url);
- if ($id !== null) {
- $results = $this->infoRetriever->searchByKeyword($id, [$provider]);
- if (count($results) > 0) {
- return $results[0];
- }
- }
- return null;
- } catch (ProviderIDNotSupportedException $e) {
- //Ignore and continue
- return null;
- }
- }
-
- return null;
- }
-
- private function fixAndValidateURL(string $url): string
- {
- $originalUrl = $url;
-
- //Add scheme if missing
- if (!preg_match('/^https?:\/\//', $url)) {
- //Remove any leading slashes
- $url = ltrim($url, '/');
-
- $url = 'https://'.$url;
- }
-
- //If this is not a valid URL with host, domain and path, throw an exception
- if (filter_var($url, FILTER_VALIDATE_URL) === false ||
- parse_url($url, PHP_URL_HOST) === null ||
- parse_url($url, PHP_URL_PATH) === null) {
- throw new ProviderIDNotSupportedException("The given ID is not a valid URL: ".$originalUrl);
- }
-
- return $url;
- }
-
- public function getDetails(string $id, bool $check_for_delegation = true): PartDetailDTO
+ public function getDetails(string $id, array $options = []): PartDetailDTO
{
$url = $this->fixAndValidateURL($id);
- if ($check_for_delegation) {
+ if (!($options[self::OPTION_SKIP_DELEGATION] ?? false)) {
//Before loading the page, try to delegate to another provider
- $delegatedPart = $this->delegateToOtherProvider($url);
+ $delegatedPart = $this->createFromUrlHelper->delegateToOtherProviderDetails($url, $this);
if ($delegatedPart !== null) {
- return $this->infoRetriever->getDetailsForSearchResult($delegatedPart);
+ return $delegatedPart;
}
}
diff --git a/src/Services/InfoProviderSystem/Providers/InfoProviderInterface.php b/src/Services/InfoProviderSystem/Providers/InfoProviderInterface.php
index 1f787559..a6e073a5 100644
--- a/src/Services/InfoProviderSystem/Providers/InfoProviderInterface.php
+++ b/src/Services/InfoProviderSystem/Providers/InfoProviderInterface.php
@@ -28,6 +28,8 @@ use App\Services\InfoProviderSystem\DTOs\SearchResultDTO;
interface InfoProviderInterface
{
+ public const OPTION_NO_CACHE = 'no_cache'; // if set to true, the provider should not use any cache and retrieve fresh data from the source
+ public const OPTION_SKIP_DELEGATION = 'skip_delegation'; // if set to true, the provider should not delegate the request to other providers, even if it supports delegation.
/**
* Get information about this provider
@@ -61,16 +63,18 @@ interface InfoProviderInterface
/**
* Searches for a keyword and returns a list of search results
* @param string $keyword The keyword to search for
+ * @param array $options An associative array of options for the search, which can be used to pass additional parameters to the provider (e.g. filters, pagination, etc.). The content of this array is provider specific and not defined by the interface
* @return SearchResultDTO[] A list of search results
*/
- public function searchByKeyword(string $keyword): array;
+ public function searchByKeyword(string $keyword, array $options = []): array;
/**
* Returns detailed information about the part with the given id
* @param string $id
+ * @param array $options An associative array of options for the search, which can be used to pass additional parameters to the provider (e.g. filters, pagination, etc.). The content of this array is provider specific and not defined by the interface
* @return PartDetailDTO
*/
- public function getDetails(string $id): PartDetailDTO;
+ public function getDetails(string $id, array $options = []): PartDetailDTO;
/**
* A list of capabilities this provider supports (which kind of data it can provide).
diff --git a/src/Services/InfoProviderSystem/Providers/LCSCProvider.php b/src/Services/InfoProviderSystem/Providers/LCSCProvider.php
index 1b807eff..5f251b43 100755
--- a/src/Services/InfoProviderSystem/Providers/LCSCProvider.php
+++ b/src/Services/InfoProviderSystem/Providers/LCSCProvider.php
@@ -349,17 +349,18 @@ class LCSCProvider implements BatchInfoProviderInterface, URLHandlerInfoProvider
return $result;
}
- public function searchByKeyword(string $keyword): array
+ public function searchByKeyword(string $keyword, array $options = []): array
{
return $this->queryByTerm($keyword, true); // Use lightweight mode for search
}
/**
* Batch search multiple keywords asynchronously (like JavaScript Promise.all)
- * @param array $keywords Array of keywords to search
+ * @param array $keywords
+ * @param array $options
* @return array Results indexed by keyword
*/
- public function searchByKeywordsBatch(array $keywords): array
+ public function searchByKeywordsBatch(array $keywords, array $options = []): array
{
if (empty($keywords)) {
return [];
@@ -396,6 +397,7 @@ class LCSCProvider implements BatchInfoProviderInterface, URLHandlerInfoProvider
// Now collect all results (like .then() in JavaScript)
foreach ($responses as $keyword => $response) {
try {
+ $keyword = (string) $keyword;
$arr = $response->toArray(); // This waits for the response
$results[$keyword] = $this->processSearchResponse($arr, $keyword);
} catch (\Exception $e) {
@@ -428,7 +430,7 @@ class LCSCProvider implements BatchInfoProviderInterface, URLHandlerInfoProvider
return $result;
}
- public function getDetails(string $id): PartDetailDTO
+ public function getDetails(string $id, array $options = []): PartDetailDTO
{
$tmp = $this->queryByTerm($id, false);
if (count($tmp) === 0) {
diff --git a/src/Services/InfoProviderSystem/Providers/MouserProvider.php b/src/Services/InfoProviderSystem/Providers/MouserProvider.php
index 3171c994..49ca2d50 100644
--- a/src/Services/InfoProviderSystem/Providers/MouserProvider.php
+++ b/src/Services/InfoProviderSystem/Providers/MouserProvider.php
@@ -76,7 +76,7 @@ class MouserProvider implements InfoProviderInterface
return $this->settings->apiKey !== '' && $this->settings->apiKey !== null;
}
- public function searchByKeyword(string $keyword): array
+ public function searchByKeyword(string $keyword, array $options = []): array
{
/*
SearchByKeywordRequest description:
@@ -144,7 +144,7 @@ class MouserProvider implements InfoProviderInterface
return $this->responseToDTOArray($response);
}
- public function getDetails(string $id): PartDetailDTO
+ public function getDetails(string $id, array $options = []): PartDetailDTO
{
/*
SearchByPartRequest description:
diff --git a/src/Services/InfoProviderSystem/Providers/OEMSecretsProvider.php b/src/Services/InfoProviderSystem/Providers/OEMSecretsProvider.php
index f7048a87..9764517b 100644
--- a/src/Services/InfoProviderSystem/Providers/OEMSecretsProvider.php
+++ b/src/Services/InfoProviderSystem/Providers/OEMSecretsProvider.php
@@ -278,12 +278,13 @@ class OEMSecretsProvider implements InfoProviderInterface
* and debugging with local JSON files. The results are processed, cached, and then sorted based
* on the keyword and specified criteria.
*
- * @param string $keyword The part number to search for
+ * @param string $keyword
+ * @param array $options
* @return array An array of processed product details, sorted by relevance and additional criteria.
*
* @throws \Exception If the JSON file used for debugging is not found or contains errors.
*/
- public function searchByKeyword(string $keyword): array
+ public function searchByKeyword(string $keyword, array $options = []): array
{
/*
oemsecrets Part Search API 3.0.1
@@ -414,14 +415,20 @@ class OEMSecretsProvider implements InfoProviderInterface
* found in the cache, they are returned. If not, an exception is thrown indicating that
* the details could not be found.
*
- * @param string $id The unique identifier of the provider or part.
+ * @param string $id
+ * @param array $options
* @return PartDetailDTO The detailed information about the part.
*
* @throws \Exception If no details are found for the given provider ID.
*/
- public function getDetails(string $id): PartDetailDTO
+ public function getDetails(string $id, array $options = []): PartDetailDTO
{
$cacheKey = $this->getCacheKey($id);
+
+ if ($options[self::OPTION_NO_CACHE] ?? false) {
+ $this->partInfoCache->deleteItem($cacheKey);
+ }
+
$cacheItem = $this->partInfoCache->getItem($cacheKey);
if ($cacheItem->isHit()) {
diff --git a/src/Services/InfoProviderSystem/Providers/OctopartProvider.php b/src/Services/InfoProviderSystem/Providers/OctopartProvider.php
index 1142f4ef..de404e18 100644
--- a/src/Services/InfoProviderSystem/Providers/OctopartProvider.php
+++ b/src/Services/InfoProviderSystem/Providers/OctopartProvider.php
@@ -326,7 +326,7 @@ class OctopartProvider implements InfoProviderInterface
);
}
- public function searchByKeyword(string $keyword): array
+ public function searchByKeyword(string $keyword, array $options = []): array
{
$graphQL = sprintf(<<<'GRAPHQL'
query partSearch($keyword: String, $limit: Int, $currency: String!, $country: String!, $authorizedOnly: Boolean!) {
@@ -367,11 +367,13 @@ class OctopartProvider implements InfoProviderInterface
return $tmp;
}
- public function getDetails(string $id): PartDetailDTO
+ public function getDetails(string $id, array $options = []): PartDetailDTO
{
+ $no_cache = $options[self::OPTION_NO_CACHE] ?? false;
+
//Check if we have the part cached
$cached = $this->getFromCache($id);
- if ($cached !== null) {
+ if (!$no_cache && $cached !== null) {
return $cached;
}
diff --git a/src/Services/InfoProviderSystem/Providers/PollinProvider.php b/src/Services/InfoProviderSystem/Providers/PollinProvider.php
index 6ac969d3..7acecc3a 100644
--- a/src/Services/InfoProviderSystem/Providers/PollinProvider.php
+++ b/src/Services/InfoProviderSystem/Providers/PollinProvider.php
@@ -66,7 +66,7 @@ class PollinProvider implements InfoProviderInterface, URLHandlerInfoProviderInt
return $this->settings->enabled;
}
- public function searchByKeyword(string $keyword): array
+ public function searchByKeyword(string $keyword, array $options = []): array
{
$response = $this->client->request('GET', 'https://www.pollin.de/search', [
'query' => [
@@ -110,7 +110,7 @@ class PollinProvider implements InfoProviderInterface, URLHandlerInfoProviderInt
};
}
- public function getDetails(string $id): PartDetailDTO
+ public function getDetails(string $id, array $options = []): PartDetailDTO
{
//Ensure that $id is numeric
if (!is_numeric($id)) {
diff --git a/src/Services/InfoProviderSystem/Providers/ProviderCapabilities.php b/src/Services/InfoProviderSystem/Providers/ProviderCapabilities.php
index 21fba53b..3a7d03e9 100644
--- a/src/Services/InfoProviderSystem/Providers/ProviderCapabilities.php
+++ b/src/Services/InfoProviderSystem/Providers/ProviderCapabilities.php
@@ -46,6 +46,9 @@ enum ProviderCapabilities
/** Provider can provide GTIN for a part */
case GTIN;
+ /** Provider can provide parameters/specifications for a part */
+ case PARAMETERS;
+
/**
* Get the order index for displaying capabilities in a stable order.
* @return int
@@ -59,6 +62,7 @@ enum ProviderCapabilities
self::PRICE => 4,
self::FOOTPRINT => 5,
self::GTIN => 6,
+ self::PARAMETERS => 7,
};
}
@@ -71,6 +75,7 @@ enum ProviderCapabilities
self::DATASHEET => 'datasheet',
self::PRICE => 'price',
self::GTIN => 'gtin',
+ self::PARAMETERS => 'parameters',
};
}
@@ -83,6 +88,7 @@ enum ProviderCapabilities
self::DATASHEET => 'fa-file-alt',
self::PRICE => 'fa-money-bill-wave',
self::GTIN => 'fa-barcode',
+ self::PARAMETERS => 'fa-list-ul',
};
}
}
diff --git a/src/Services/InfoProviderSystem/Providers/ReicheltProvider.php b/src/Services/InfoProviderSystem/Providers/ReicheltProvider.php
index 81f0a449..9dfb099f 100644
--- a/src/Services/InfoProviderSystem/Providers/ReicheltProvider.php
+++ b/src/Services/InfoProviderSystem/Providers/ReicheltProvider.php
@@ -69,7 +69,7 @@ class ReicheltProvider implements InfoProviderInterface
return $this->settings->enabled;
}
- public function searchByKeyword(string $keyword): array
+ public function searchByKeyword(string $keyword, array $options = []): array
{
$response = $this->client->request('GET', sprintf($this->getBaseURL() . '/shop/search/%s', $keyword));
$html = $response->getContent();
@@ -108,7 +108,7 @@ class ReicheltProvider implements InfoProviderInterface
return $results;
}
- public function getDetails(string $id): PartDetailDTO
+ public function getDetails(string $id, array $options = []): PartDetailDTO
{
//Check that the ID is a number
if (!is_numeric($id)) {
diff --git a/src/Services/InfoProviderSystem/Providers/TMEProvider.php b/src/Services/InfoProviderSystem/Providers/TMEProvider.php
index 938bc7b3..24ba0ea7 100644
--- a/src/Services/InfoProviderSystem/Providers/TMEProvider.php
+++ b/src/Services/InfoProviderSystem/Providers/TMEProvider.php
@@ -69,7 +69,7 @@ class TMEProvider implements InfoProviderInterface, URLHandlerInfoProviderInterf
return $this->tmeClient->isUsable();
}
- public function searchByKeyword(string $keyword): array
+ public function searchByKeyword(string $keyword, array $options = []): array
{
$response = $this->tmeClient->makeRequest('Products/Search', [
'Country' => $this->settings->country,
@@ -99,7 +99,7 @@ class TMEProvider implements InfoProviderInterface, URLHandlerInfoProviderInterf
return $result;
}
- public function getDetails(string $id): PartDetailDTO
+ public function getDetails(string $id, array $options = []): PartDetailDTO
{
$response = $this->tmeClient->makeRequest('Products/GetProducts', [
'Country' => $this->settings->country,
@@ -280,9 +280,13 @@ class TMEProvider implements InfoProviderInterface, URLHandlerInfoProviderInterf
{
//If a URL starts with // we assume that it is a relative URL and we add the protocol
if (str_starts_with($url, '//')) {
- return 'https:' . $url;
+ $url = 'https:' . $url;
}
+ //Encode bare % signs that are not already part of a valid percent-encoded sequence
+ //Fixes part numbers with % in them e.g. SMD0603-5K1-1%
+ $url = preg_replace('/%(?![0-9A-Fa-f]{2})/', '%25', $url);
+
return $url;
}
diff --git a/src/Services/InfoProviderSystem/Providers/TestProvider.php b/src/Services/InfoProviderSystem/Providers/TestProvider.php
index 8b78c95a..42927abd 100644
--- a/src/Services/InfoProviderSystem/Providers/TestProvider.php
+++ b/src/Services/InfoProviderSystem/Providers/TestProvider.php
@@ -55,7 +55,7 @@ class TestProvider implements InfoProviderInterface
return true;
}
- public function searchByKeyword(string $keyword): array
+ public function searchByKeyword(string $keyword, array $options = []): array
{
return [
new SearchResultDTO(provider_key: $this->getProviderKey(), provider_id: 'element1', name: 'Element 1', description: 'fd'),
@@ -72,7 +72,7 @@ class TestProvider implements InfoProviderInterface
];
}
- public function getDetails(string $id): PartDetailDTO
+ public function getDetails(string $id, array $options = []): PartDetailDTO
{
return new PartDetailDTO(
provider_key: $this->getProviderKey(),
@@ -92,4 +92,4 @@ class TestProvider implements InfoProviderInterface
]
);
}
-}
\ No newline at end of file
+}
diff --git a/src/Services/LabelSystem/BarcodeScanner/BarcodeScanHelper.php b/src/Services/LabelSystem/BarcodeScanner/BarcodeScanHelper.php
index 0bee33a1..7f65262a 100644
--- a/src/Services/LabelSystem/BarcodeScanner/BarcodeScanHelper.php
+++ b/src/Services/LabelSystem/BarcodeScanner/BarcodeScanHelper.php
@@ -105,6 +105,10 @@ final class BarcodeScanHelper
return new AmazonBarcodeScanResult($input);
}
+ if ($type === BarcodeSourceType::TME) {
+ return TMEBarcodeScanResult::parse($input);
+ }
+
//Null means auto and we try the different formats
$result = $this->parseInternalBarcode($input);
@@ -144,6 +148,11 @@ final class BarcodeScanHelper
return new AmazonBarcodeScanResult($input);
}
+ // Try TME barcode
+ if (TMEBarcodeScanResult::isTMEBarcode($input)) {
+ return TMEBarcodeScanResult::parse($input);
+ }
+
throw new InvalidArgumentException('Unknown barcode');
}
@@ -162,6 +171,7 @@ final class BarcodeScanHelper
return LCSCBarcodeScanResult::parse($input);
}
+
private function parseUserDefinedBarcode(string $input): ?LocalBarcodeScanResult
{
$lot_repo = $this->entityManager->getRepository(PartLot::class);
diff --git a/src/Services/LabelSystem/BarcodeScanner/BarcodeScanResultHandler.php b/src/Services/LabelSystem/BarcodeScanner/BarcodeScanResultHandler.php
index e24c7077..60a1136f 100644
--- a/src/Services/LabelSystem/BarcodeScanner/BarcodeScanResultHandler.php
+++ b/src/Services/LabelSystem/BarcodeScanner/BarcodeScanResultHandler.php
@@ -117,7 +117,8 @@ final readonly class BarcodeScanResultHandler
throw InfoProviderNotActiveException::fromProvider($provider);
}
- return $this->urlGenerator->generate('info_providers_create_part', ['providerKey' => $infos['providerKey'], 'providerId' => $infos['providerId']]);
+ //So far we can just copy over our provider info array to the URL parameters:
+ return $this->urlGenerator->generate('info_providers_create_part', $infos);
}
/**
@@ -146,7 +147,11 @@ final readonly class BarcodeScanResultHandler
if ($barcodeScan instanceof AmazonBarcodeScanResult) {
return $this->em->getRepository(Part::class)->getPartByProviderInfo($barcodeScan->asin)
- ?? $this->em->getRepository(Part::class)->getPartBySPN($barcodeScan->asin);
+ ?? $this->em->getRepository(Part::class)->getPartBySPN($barcodeScan->asin);
+ }
+
+ if ($barcodeScan instanceof TMEBarcodeScanResult) {
+ return $this->resolvePartFromTME($barcodeScan);
}
return null;
@@ -216,8 +221,8 @@ final readonly class BarcodeScanResultHandler
* Resolve LCSC barcode -> Part.
* Strategy:
* 1) Try providerReference.provider_id == pc (LCSC "Cxxxxxx") if you store it there
- * 2) Fallback to manufacturer_product_number == pm (MPN)
* Returns first match (consistent with EIGP114 logic)
+ * 2) Fallback to search across supplier part number (SPN)
*/
private function resolvePartFromLCSC(LCSCBarcodeScanResult $barcodeScan): ?Part
{
@@ -230,32 +235,64 @@ final readonly class BarcodeScanResultHandler
}
}
- // Fallback to MPN (pm)
- $pm = $barcodeScan->mpn; // e.g. RC0402FR-071ML
- if (!$pm) {
- return null;
- }
-
- return $this->em->getRepository(Part::class)->getPartByMPN($pm);
+ // fallback to search by SPN
+ return $this->em->getRepository(Part::class)->getPartBySPN($pc);
}
+ private function resolvePartFromTME(TMEBarcodeScanResult $barcodeScan): ?Part
+ {
+ $pn = $barcodeScan->tmePartNumber;
+ if ($pn) {
+ $part = $this->em->getRepository(Part::class)->getPartByProviderInfo($pn);
+ if ($part !== null) {
+ return $part;
+ }
+
+ //Try to find the part by SPN/SKU
+ $part = $this->em->getRepository(Part::class)->getPartBySPN($pn);
+ if ($part !== null) {
+ return $part;
+ }
+ }
+
+ // Fallback: search by MPN
+ return $this->em->getRepository(Part::class)->getPartByMPN($barcodeScan->mpn, $barcodeScan->manufacturer);
+ }
+
/**
* Tries to extract creation information for a part from the given barcode scan result. This can be used to
* automatically fill in the info provider reference of a part, when creating a new part based on the scan result.
* Returns null if no provider information could be extracted from the scan result, or if the scan result type is unknown and cannot be handled by this function.
* It is not necessarily checked that the provider is active, or that the result actually exists on the provider side.
* @param BarcodeScanResultInterface $scanResult
- * @return array{providerKey: string, providerId: string}|null
+ * @return array{providerKey: string, providerId: string, lotAmount?: float|int, lotName?: string, lotUserBarcode?: string}|null
* @throws InfoProviderNotActiveException If the scan result contains information for a provider which is currently not active in the system
*/
public function getCreateInfos(BarcodeScanResultInterface $scanResult): ?array
{
+ // TME
+ if ($scanResult instanceof TMEBarcodeScanResult) {
+ if ($scanResult->tmePartNumber === null) {
+ return null;
+ }
+ return [
+ 'providerKey' => 'tme',
+ 'providerId' => $scanResult->tmePartNumber,
+ 'lotAmount' => $scanResult->quantity,
+ 'lotName' => $scanResult->purchaseOrder,
+ 'lotUserBarcode' => $scanResult->rawInput,
+ ];
+ }
+
// LCSC
if ($scanResult instanceof LCSCBarcodeScanResult) {
return [
'providerKey' => 'lcsc',
'providerId' => $scanResult->lcscCode,
+ 'lotAmount' => $scanResult->quantity,
+ 'lotName' => $scanResult->orderNumber ?? $scanResult->pickBatchNumber,
+ 'lotUserBarcode' => $scanResult->rawInput,
];
}
@@ -276,7 +313,7 @@ final readonly class BarcodeScanResultHandler
/**
* @param EIGP114BarcodeScanResult $scanResult
- * @return array{providerKey: string, providerId: string}|null
+ * * @return array{providerKey: string, providerId: string, lotAmount?: float|int, lotName?: string, lotUserBarcode?: string}|null
*/
private function getCreationInfoForEIGP114(EIGP114BarcodeScanResult $scanResult): ?array
{
@@ -285,30 +322,36 @@ final readonly class BarcodeScanResultHandler
// Mouser: use supplierPartNumber -> search provider -> provider_id
if ($vendor === 'mouser' && $scanResult->supplierPartNumber !== null
) {
- // Search Mouser using the MPN
- $dtos = $this->infoRetriever->searchByKeyword(
- keyword: $scanResult->supplierPartNumber,
- providers: ["mouser"]
- );
+ // Search Mouser using the MPN
+ $dtos = $this->infoRetriever->searchByKeyword(
+ keyword: $scanResult->supplierPartNumber,
+ providers: ["mouser"]
+ );
- // If there are results, provider_id is MouserPartNumber (per MouserProvider.php)
- $best = $dtos[0] ?? null;
+ // If there are results, provider_id is MouserPartNumber (per MouserProvider.php)
+ $best = $dtos[0] ?? null;
- if ($best !== null) {
- return [
- 'providerKey' => 'mouser',
- 'providerId' => $best->provider_id,
- ];
- }
+ if ($best !== null) {
+ return [
+ 'providerKey' => 'mouser',
+ 'providerId' => $best->provider_id,
+ 'lotAmount' => $scanResult->quantity,
+ 'lotName' => $scanResult->customerPO,
+ 'lotUserBarcode' => $scanResult->rawInput,
+ ];
+ }
- return null;
+ return null;
}
- // Digi-Key: can use customerPartNumber or supplierPartNumber directly
+ // Digi-Key: supplierPartNumber directly
if ($vendor === 'digikey') {
return [
'providerKey' => 'digikey',
- 'providerId' => $scanResult->customerPartNumber ?? $scanResult->supplierPartNumber,
+ 'providerId' => $scanResult->supplierPartNumber ?? throw new \RuntimeException('Digikey barcode does not contain required supplier part number'),
+ 'lotAmount' => $scanResult->quantity,
+ 'lotName' => $scanResult->digikeyInvoiceNumber ?? $scanResult->digikeySalesOrderNumber ?? $scanResult->customerPO,
+ 'lotUserBarcode' => $scanResult->rawInput,
];
}
@@ -316,7 +359,10 @@ final readonly class BarcodeScanResultHandler
if ($vendor === 'element14') {
return [
'providerKey' => 'element14',
- 'providerId' => $scanResult->supplierPartNumber,
+ 'providerId' => $scanResult->supplierPartNumber ?? throw new \RuntimeException('Element14 barcode does not contain required supplier part number'),
+ 'lotAmount' => $scanResult->quantity,
+ 'lotName' => $scanResult->customerPO,
+ 'lotUserBarcode' => $scanResult->rawInput,
];
}
diff --git a/src/Services/LabelSystem/BarcodeScanner/BarcodeSourceType.php b/src/Services/LabelSystem/BarcodeScanner/BarcodeSourceType.php
index fb6eaa77..df991a8c 100644
--- a/src/Services/LabelSystem/BarcodeScanner/BarcodeSourceType.php
+++ b/src/Services/LabelSystem/BarcodeScanner/BarcodeSourceType.php
@@ -52,4 +52,7 @@ enum BarcodeSourceType: string
case LCSC = 'lcsc';
case AMAZON = 'amazon';
+
+ /** For TME (tme.eu) formatted QR codes */
+ case TME = 'tme';
}
diff --git a/src/Services/LabelSystem/BarcodeScanner/EIGP114BarcodeScanResult.php b/src/Services/LabelSystem/BarcodeScanner/EIGP114BarcodeScanResult.php
index 37c03f55..0ff74fd4 100644
--- a/src/Services/LabelSystem/BarcodeScanner/EIGP114BarcodeScanResult.php
+++ b/src/Services/LabelSystem/BarcodeScanner/EIGP114BarcodeScanResult.php
@@ -187,7 +187,7 @@ readonly class EIGP114BarcodeScanResult implements BarcodeScanResultInterface
*
* @param array $data The fields of the EIGP114 barcode, where the key is the field name and the value is the field content
*/
- public function __construct(public array $data)
+ public function __construct(public array $data, public readonly ?string $rawInput = null)
{
//IDs per EIGP 114.2018
$this->shipDate = $data['6D'] ?? null;
@@ -254,12 +254,16 @@ readonly class EIGP114BarcodeScanResult implements BarcodeScanResultInterface
*/
public static function isFormat06Code(string $input): bool
{
- //Code must begin with [)>06
- if(!str_starts_with($input, "[)>\u{1E}06\u{1D}")){
- return false;
+ //Code should begin with [)>06 as per the standard
+ if(!str_starts_with($input, "[)>\u{1E}06\u{1D}")
+ // some codes don't contain record separators
+ && !str_starts_with($input, "[)>06\u{1D}")
+ // This is found on old Mouser parts
+ && !str_starts_with($input, ">[)>06\u{1D}"))
+ {
+ return false;
}
-
- //Digikey does not put a trailer onto the barcode, so we just check for the header
+ //Digikey and Mouser don't put a trailer onto the barcode, so we just check for the header
return true;
}
@@ -271,6 +275,8 @@ readonly class EIGP114BarcodeScanResult implements BarcodeScanResultInterface
*/
public static function parseFormat06Code(string $input): self
{
+ $rawInput = $input;
+
//Ensure that the input is a valid format06 code
if (!self::isFormat06Code($input)) {
throw new \InvalidArgumentException("The given input is not a valid format06 code");
@@ -306,7 +312,7 @@ readonly class EIGP114BarcodeScanResult implements BarcodeScanResultInterface
$results[$key] = $fieldValue;
}
- return new self($results);
+ return new self($results, $rawInput);
}
public function getDecodedForInfoMode(): array
diff --git a/src/Services/LabelSystem/BarcodeScanner/TMEBarcodeScanResult.php b/src/Services/LabelSystem/BarcodeScanner/TMEBarcodeScanResult.php
new file mode 100644
index 00000000..5feb67c1
--- /dev/null
+++ b/src/Services/LabelSystem/BarcodeScanner/TMEBarcodeScanResult.php
@@ -0,0 +1,143 @@
+.
+ */
+
+declare(strict_types=1);
+
+namespace App\Services\LabelSystem\BarcodeScanner;
+
+use InvalidArgumentException;
+
+/**
+ * This class represents the content of a tme.eu barcode label.
+ * The format is space-separated KEY:VALUE tokens, e.g.:
+ * QTY:1000 PN:SMD0603-5K1-1% PO:32723349/7 MFR:ROYALOHM MPN:0603SAF5101T5E CoO:TH RoHS https://www.tme.eu/details/...
+ */
+readonly class TMEBarcodeScanResult implements BarcodeScanResultInterface
+{
+ /** @var int|null Quantity (QTY) */
+ public ?int $quantity;
+
+ /** @var string|null TME part number (PN) */
+ public ?string $tmePartNumber;
+
+ /** @var string|null Purchase order number (PO) */
+ public ?string $purchaseOrder;
+
+ /** @var string|null Manufacturer name (MFR) */
+ public ?string $manufacturer;
+
+ /** @var string|null Manufacturer part number (MPN) */
+ public ?string $mpn;
+
+ /** @var string|null Country of origin (CoO) */
+ public ?string $countryOfOrigin;
+
+ /** @var bool Whether the part is RoHS compliant */
+ public bool $rohs;
+
+ /** @var string|null The product URL */
+ public ?string $productUrl;
+
+ /**
+ * @param array $fields Parsed key-value fields (keys uppercased)
+ * @param string $rawInput Original barcode string
+ */
+ public function __construct(
+ public array $fields,
+ public string $rawInput,
+ ) {
+ $this->quantity = isset($this->fields['QTY']) ? (int) $this->fields['QTY'] : null;
+ $this->tmePartNumber = $this->fields['PN'] ?? null;
+ $this->purchaseOrder = $this->fields['PO'] ?? null;
+ $this->manufacturer = $this->fields['MFR'] ?? null;
+ $this->mpn = $this->fields['MPN'] ?? null;
+ $this->countryOfOrigin = $this->fields['COO'] ?? null;
+ $this->rohs = isset($this->fields['ROHS']);
+ $this->productUrl = $this->fields['URL'] ?? null;
+ }
+
+ public function getSourceType(): BarcodeSourceType
+ {
+ return BarcodeSourceType::TME;
+ }
+
+ public function getDecodedForInfoMode(): array
+ {
+ return [
+ 'Barcode type' => 'TME',
+ 'TME Part No. (PN)' => $this->tmePartNumber ?? '',
+ 'MPN' => $this->mpn ?? '',
+ 'Manufacturer (MFR)' => $this->manufacturer ?? '',
+ 'Qty' => $this->quantity !== null ? (string) $this->quantity : '',
+ 'Purchase Order (PO)' => $this->purchaseOrder ?? '',
+ 'Country of Origin (CoO)' => $this->countryOfOrigin ?? '',
+ 'RoHS' => $this->rohs ? 'Yes' : 'No',
+ 'URL' => $this->productUrl ?? '',
+ ];
+ }
+
+ /**
+ * Returns true if the input looks like a TME barcode label (contains tme.eu URL).
+ */
+ public static function isTMEBarcode(string $input): bool
+ {
+ return str_contains(strtolower($input), 'tme.eu');
+ }
+
+ /**
+ * Parse the TME barcode string into a TMEBarcodeScanResult.
+ */
+ public static function parse(string $input): self
+ {
+ $raw = trim($input);
+
+ if (!self::isTMEBarcode($raw)) {
+ throw new InvalidArgumentException('Not a TME barcode');
+ }
+
+ $fields = [];
+
+ // Split on whitespace; each token is either KEY:VALUE, a bare keyword, or the URL
+ $tokens = preg_split('/\s+/', $raw);
+ foreach ($tokens as $token) {
+ if ($token === '') {
+ continue;
+ }
+
+ // The TME URL
+ if (str_starts_with(strtolower($token), 'http')) {
+ $fields['URL'] = $token;
+ continue;
+ }
+
+ $colonPos = strpos($token, ':');
+ if ($colonPos !== false) {
+ $key = strtoupper(substr($token, 0, $colonPos));
+ $value = substr($token, $colonPos + 1);
+ $fields[$key] = $value;
+ } else {
+ // Bare keyword like "RoHS"
+ $fields[strtoupper($token)] = '';
+ }
+ }
+
+ return new self($fields, $raw);
+ }
+}
diff --git a/src/Services/LabelSystem/PlaceholderProviders/BarcodeProvider.php b/src/Services/LabelSystem/PlaceholderProviders/BarcodeProvider.php
index 400fef35..9719917a 100644
--- a/src/Services/LabelSystem/PlaceholderProviders/BarcodeProvider.php
+++ b/src/Services/LabelSystem/PlaceholderProviders/BarcodeProvider.php
@@ -114,10 +114,12 @@ final class BarcodeProvider implements PlaceholderProviderInterface
return 'IPN Barcode ERROR! : '.$e->getMessage();
}
}
-
-
-
-
return null;
}
+
+ public static function getDefaultPriority(): int
+ {
+ //This provider should be checked before all others, so that nothing is delegated for part lots
+ return 1000;
+ }
}
diff --git a/src/Services/ProjectSystem/ProjectBuildHelper.php b/src/Services/ProjectSystem/ProjectBuildHelper.php
index a541c29d..ee5b8c68 100644
--- a/src/Services/ProjectSystem/ProjectBuildHelper.php
+++ b/src/Services/ProjectSystem/ProjectBuildHelper.php
@@ -25,16 +25,22 @@ namespace App\Services\ProjectSystem;
use App\Entity\Parts\Part;
use App\Entity\ProjectSystem\Project;
use App\Entity\ProjectSystem\ProjectBOMEntry;
+use App\Entity\PriceInformations\Currency;
use App\Helpers\Projects\ProjectBuildRequest;
use App\Services\Parts\PartLotWithdrawAddHelper;
+use App\Services\Parts\PricedetailHelper;
+use Brick\Math\BigDecimal;
+use Brick\Math\RoundingMode;
/**
* @see \App\Tests\Services\ProjectSystem\ProjectBuildHelperTest
*/
final readonly class ProjectBuildHelper
{
- public function __construct(private PartLotWithdrawAddHelper $withdraw_add_helper)
- {
+ public function __construct(
+ private PartLotWithdrawAddHelper $withdraw_add_helper,
+ private PricedetailHelper $pricedetailHelper,
+ ) {
}
/**
@@ -168,4 +174,81 @@ final readonly class ProjectBuildHelper
$this->withdraw_add_helper->add($buildRequest->getBuildsPartLot(), $buildRequest->getNumberOfBuilds(), $message);
}
}
+
+ /**
+ * Calculates the total price to build the given project N times, taking bulk pricing into account.
+ * Returns null if no BOM entry has any pricing information.
+ */
+ public function calculateTotalBuildPrice(Project $project, int $number_of_builds = 1, ?Currency $currency = null): ?BigDecimal
+ {
+ $total = BigDecimal::zero();
+ $has_price = false;
+
+ foreach ($project->getBomEntries() as $entry) {
+ $unit_price = $this->getBomEntryUnitPrice($entry, $number_of_builds, $currency);
+ if ($unit_price === null) {
+ continue;
+ }
+ $has_price = true;
+ $total = $total->plus($unit_price->multipliedBy($entry->getQuantity())->multipliedBy($number_of_builds));
+ }
+
+ return $has_price ? $total : null;
+ }
+
+ /**
+ * Calculates the price to build one unit of the given project when ordering for N builds in total.
+ * Returns null if no BOM entry has any pricing information.
+ */
+ public function calculateUnitBuildPrice(Project $project, int $number_of_builds = 1, ?Currency $currency = null): ?BigDecimal
+ {
+ $total = $this->calculateTotalBuildPrice($project, $number_of_builds, $currency);
+ if ($total === null) {
+ return null;
+ }
+ return $total->dividedBy($number_of_builds, 10, RoundingMode::HALF_UP);
+ }
+
+ /**
+ * Returns the total build price rounded up to 2 decimal places, ready for display.
+ */
+ public function roundedTotalBuildPrice(Project $project, int $number_of_builds = 1, ?Currency $currency = null): ?BigDecimal
+ {
+ return $this->calculateTotalBuildPrice($project, $number_of_builds, $currency)
+ ?->toScale(2, RoundingMode::UP);
+ }
+
+ /**
+ * Returns the unit build price rounded up to 2 decimal places, ready for display.
+ */
+ public function roundedUnitBuildPrice(Project $project, int $number_of_builds = 1, ?Currency $currency = null): ?BigDecimal
+ {
+ return $this->calculateUnitBuildPrice($project, $number_of_builds, $currency)
+ ?->toScale(2, RoundingMode::UP);
+ }
+
+ /**
+ * Returns the effective unit price for a single piece of the given BOM entry,
+ * taking bulk pricing and minimum order amounts into account for N builds.
+ * Returns BigDecimal::zero() when no pricing data is available.
+ */
+ public function getEntryUnitPrice(ProjectBOMEntry $entry, int $number_of_builds = 1, ?Currency $currency = null): BigDecimal
+ {
+ return $this->getBomEntryUnitPrice($entry, $number_of_builds, $currency) ?? BigDecimal::zero();
+ }
+
+ /**
+ * Returns the effective unit price for a single piece of the given BOM entry,
+ * taking bulk pricing into account for N builds.
+ */
+ private function getBomEntryUnitPrice(ProjectBOMEntry $entry, int $number_of_builds, ?Currency $currency): ?BigDecimal
+ {
+ if ($entry->getPart() instanceof Part) {
+ $total_qty = $entry->getQuantity() * $number_of_builds;
+ $min_order = $this->pricedetailHelper->getMinOrderAmount($entry->getPart());
+ $effective_qty = ($min_order !== null) ? max($total_qty, $min_order) : $total_qty;
+ return $this->pricedetailHelper->calculateAvgPrice($entry->getPart(), $effective_qty, $currency);
+ }
+ return $entry->getPrice();
+ }
}
diff --git a/src/Services/System/BackupManager.php b/src/Services/System/BackupManager.php
index 4946bc24..621b58d7 100644
--- a/src/Services/System/BackupManager.php
+++ b/src/Services/System/BackupManager.php
@@ -327,14 +327,14 @@ readonly class BackupManager
*/
private function restoreDatabaseFromBackup(string $tempDir): void
{
+ // Get database connection params from Doctrine
+ $connection = $this->entityManager->getConnection();
+ $params = $connection->getParams();
+ $platform = $connection->getDatabasePlatform();
+
// Check for SQL dump (MySQL/PostgreSQL)
$sqlFile = $tempDir . '/database.sql';
if (file_exists($sqlFile)) {
- // Import SQL using mysql/psql command directly
- // First, get database connection params from Doctrine
- $connection = $this->entityManager->getConnection();
- $params = $connection->getParams();
- $platform = $connection->getDatabasePlatform();
if ($platform instanceof AbstractMySQLPlatform) {
// Use mysql command to import - need to use shell to handle input redirection
@@ -403,7 +403,8 @@ readonly class BackupManager
// Check for SQLite database file
$sqliteFile = $tempDir . '/var/app.db';
if (file_exists($sqliteFile)) {
- $targetDb = $this->projectDir . '/var/app.db';
+ // Use the actual configured SQLite path from Doctrine, not a hardcoded path
+ $targetDb = $params['path'] ?? $this->projectDir . '/var/app.db';
$this->filesystem->copy($sqliteFile, $targetDb, true);
return;
}
diff --git a/src/Services/System/GitVersionInfoProvider.php b/src/Services/System/GitVersionInfoProvider.php
index 01925ff8..927326e5 100644
--- a/src/Services/System/GitVersionInfoProvider.php
+++ b/src/Services/System/GitVersionInfoProvider.php
@@ -62,6 +62,9 @@ final readonly class GitVersionInfoProvider
{
if (is_file($this->getGitDirectory() . '/HEAD')) {
$git = file($this->getGitDirectory() . '/HEAD');
+ if ($git === false) {
+ return null;
+ }
$head = explode('/', $git[0], 3);
if (!isset($head[2])) {
diff --git a/src/Services/System/InstallationType.php b/src/Services/System/InstallationType.php
index 74479bb9..2631e644 100644
--- a/src/Services/System/InstallationType.php
+++ b/src/Services/System/InstallationType.php
@@ -46,7 +46,7 @@ enum InstallationType: string
{
return match ($this) {
self::GIT => true,
- self::DOCKER => false,
+ self::DOCKER => true,
// ZIP_RELEASE auto-update not yet implemented
self::ZIP_RELEASE => false,
self::UNKNOWN => false,
@@ -57,7 +57,7 @@ enum InstallationType: string
{
return match ($this) {
self::GIT => 'Run: php bin/console partdb:update',
- self::DOCKER => 'Pull the new Docker image and recreate the container: docker-compose pull && docker-compose up -d',
+ self::DOCKER => 'Configure Watchtower for one-click updates, or manually: docker-compose pull && docker-compose up -d',
self::ZIP_RELEASE => 'Download the new release ZIP from GitHub, extract it over your installation, and run: php bin/console doctrine:migrations:migrate && php bin/console cache:clear',
self::UNKNOWN => 'Unable to determine installation type. Please update manually.',
};
diff --git a/src/Services/System/UpdateAvailableFacade.php b/src/Services/System/UpdateAvailableFacade.php
index ac3a46c0..60f66036 100644
--- a/src/Services/System/UpdateAvailableFacade.php
+++ b/src/Services/System/UpdateAvailableFacade.php
@@ -105,6 +105,6 @@ class UpdateAvailableFacade
return $this->updateCache->get(self::CACHE_KEY, function (ItemInterface $item) {
$item->expiresAfter(self::CACHE_TTL);
return $this->updateChecker->getLatestVersion();
- });
+ }) ?? ['version' => '0.0.1', 'url' => 'update-checking-failed'];
}
}
diff --git a/src/Services/System/UpdateChecker.php b/src/Services/System/UpdateChecker.php
index fdb8d9dd..366e8d67 100644
--- a/src/Services/System/UpdateChecker.php
+++ b/src/Services/System/UpdateChecker.php
@@ -50,7 +50,8 @@ class UpdateChecker
private readonly InstallationTypeDetector $installationTypeDetector,
private readonly GitVersionInfoProvider $gitVersionInfoProvider,
#[Autowire(param: 'kernel.debug')] private readonly bool $is_dev_mode,
- #[Autowire(param: 'kernel.project_dir')] private readonly string $project_dir)
+ #[Autowire(param: 'kernel.project_dir')] private readonly string $project_dir,
+ private readonly ?WatchtowerClient $watchtowerClient = null)
{
}
@@ -284,8 +285,16 @@ class UpdateChecker
$updateBlockers[] = 'local_changes';
}
- if ($installInfo['type'] === InstallationType::DOCKER) {
- $updateBlockers[] = 'docker_installation';
+ // Docker installations require Watchtower for auto-update
+ $watchtowerConfigured = $this->watchtowerClient !== null && $this->watchtowerClient->isConfigured();
+ $watchtowerAvailable = $watchtowerConfigured && $this->watchtowerClient->isAvailable();
+
+ if ($installInfo['type'] === InstallationType::DOCKER && !$watchtowerConfigured) {
+ $canAutoUpdate = false;
+ $updateBlockers[] = 'docker_no_watchtower';
+ } elseif ($installInfo['type'] === InstallationType::DOCKER && !$watchtowerAvailable) {
+ $canAutoUpdate = false;
+ $updateBlockers[] = 'docker_watchtower_unreachable';
}
return [
@@ -301,6 +310,8 @@ class UpdateChecker
'can_auto_update' => $canAutoUpdate,
'update_blockers' => $updateBlockers,
'check_enabled' => $this->privacySettings->checkForUpdates,
+ 'watchtower_configured' => $watchtowerConfigured,
+ 'watchtower_available' => $watchtowerAvailable,
];
}
diff --git a/src/Services/System/UpdateExecutor.php b/src/Services/System/UpdateExecutor.php
index 2fe54173..ccc346d5 100644
--- a/src/Services/System/UpdateExecutor.php
+++ b/src/Services/System/UpdateExecutor.php
@@ -207,6 +207,79 @@ class UpdateExecutor
}
}
+ /**
+ * Reset PHP OPcache for the web server process.
+ *
+ * OPcache in PHP-FPM is separate from CLI. After updating code files,
+ * PHP-FPM may still serve stale cached bytecode, causing constructor
+ * mismatches and 500 errors. This method creates a temporary PHP script
+ * in the public directory, invokes it via HTTP to reset OPcache in the
+ * web server context, then removes the script.
+ *
+ * @return bool Whether OPcache was successfully reset
+ */
+ private function resetOpcache(): bool
+ {
+ $token = bin2hex(random_bytes(16));
+ $resetScript = $this->project_dir . '/public/_opcache_reset_' . $token . '.php';
+
+ try {
+ // Create a temporary PHP script that resets OPcache
+ $scriptContent = 'filesystem->dumpFile($resetScript, $scriptContent);
+
+ // Try to invoke it via HTTP on localhost
+ $urls = [
+ 'http://127.0.0.1/_opcache_reset_' . $token . '.php',
+ 'http://localhost/_opcache_reset_' . $token . '.php',
+ ];
+
+ $success = false;
+ foreach ($urls as $url) {
+ try {
+ $context = stream_context_create([
+ 'http' => [
+ 'timeout' => 5,
+ 'ignore_errors' => true,
+ ],
+ ]);
+
+ $response = @file_get_contents($url, false, $context);
+ if ($response === 'OK') {
+ $this->logger->info('OPcache reset via ' . $url);
+ $success = true;
+ break;
+ }
+ } catch (\Throwable $e) {
+ // Try next URL
+ continue;
+ }
+ }
+
+ if (!$success) {
+ $this->logger->info('OPcache reset via HTTP not available, trying CLI fallback');
+ // CLI opcache_reset() only affects CLI, but try anyway
+ if (function_exists('opcache_reset')) {
+ opcache_reset();
+ }
+ }
+
+ return $success;
+ } catch (\Throwable $e) {
+ $this->logger->warning('OPcache reset failed: ' . $e->getMessage());
+ return false;
+ } finally {
+ // Ensure the temp script is removed
+ if (file_exists($resetScript)) {
+ @unlink($resetScript);
+ }
+ }
+ }
+
/**
* Validate that we can perform an update.
*
@@ -226,6 +299,23 @@ class UpdateExecutor
);
}
+ // Docker installations are updated via Watchtower - skip Git/Composer/Yarn checks
+ if ($installType === InstallationType::DOCKER) {
+ // Only check if already locked
+ if ($this->isLocked()) {
+ $lockInfo = $this->getLockInfo();
+ $errors[] = sprintf(
+ 'An update is already in progress (started at %s).',
+ $lockInfo['started_at'] ?? 'unknown time'
+ );
+ }
+
+ return [
+ 'valid' => empty($errors),
+ 'errors' => $errors,
+ ];
+ }
+
// Check for Git installation
if ($installType === InstallationType::GIT) {
// Check if git is available
@@ -420,7 +510,7 @@ class UpdateExecutor
// Step 11: Clear cache
$stepStart = microtime(true);
$this->runCommand([
- 'php', 'bin/console', 'cache:clear',
+ 'php', 'bin/console', 'cache:pool:clear', '--all',
'--env=prod',
'--no-interaction',
], 'Clear cache', 120);
@@ -434,12 +524,20 @@ class UpdateExecutor
], 'Warmup cache', 120);
$log('cache_warmup', 'Warmed up application cache', true, microtime(true) - $stepStart);
- // Step 13: Disable maintenance mode
+ // Step 13: Reset OPcache (if available)
+ $stepStart = microtime(true);
+ $opcacheResult = $this->resetOpcache();
+ $log('opcache_reset', $opcacheResult
+ ? 'Reset PHP OPcache for web server'
+ : 'OPcache reset skipped (not available or not needed)',
+ true, microtime(true) - $stepStart);
+
+ // Step 14: Disable maintenance mode
$stepStart = microtime(true);
$this->disableMaintenanceMode();
$log('maintenance_off', 'Disabled maintenance mode', true, microtime(true) - $stepStart);
- // Step 14: Release lock
+ // Step 15: Release lock
$stepStart = microtime(true);
$this->releaseLock();
@@ -489,11 +587,14 @@ class UpdateExecutor
// Clear cache after rollback
$this->runCommand([
- 'php', 'bin/console', 'cache:clear',
+ 'php', 'bin/console', 'cache:pool:clear', '--all',
'--env=prod',
], 'Clear cache after rollback', 120);
$log('rollback_cache', 'Cleared cache after rollback', true);
+ // Reset OPcache after rollback
+ $this->resetOpcache();
+
} catch (\Exception $rollbackError) {
$log('rollback_failed', 'Rollback failed: ' . $rollbackError->getMessage(), false);
}
@@ -602,6 +703,33 @@ class UpdateExecutor
}
+ /**
+ * Delete a specific update log file.
+ */
+ public function deleteLog(string $filename): bool
+ {
+ // Validate filename pattern for security
+ if (!preg_match('/^update-[\w.\-]+\.log$/', $filename)) {
+ $this->logger->warning('Attempted to delete invalid log filename: ' . $filename);
+ return false;
+ }
+
+ $logPath = $this->project_dir . '/' . self::UPDATE_LOG_DIR . '/' . basename($filename);
+
+ if (!file_exists($logPath)) {
+ return false;
+ }
+
+ try {
+ $this->filesystem->remove($logPath);
+ $this->logger->info('Deleted update log: ' . $filename);
+ return true;
+ } catch (\Exception $e) {
+ $this->logger->error('Failed to delete update log: ' . $e->getMessage());
+ return false;
+ }
+ }
+
/**
* Restore from a backup file with maintenance mode and cache clearing.
*
@@ -682,12 +810,17 @@ class UpdateExecutor
$this->runCommand(['php', 'bin/console', 'cache:warmup'], 'Warm up cache');
$log('cache_warmup', 'Warmed up application cache', true, microtime(true) - $stepStart);
- // Step 6: Disable maintenance mode
+ // Step 6: Reset OPcache
+ $stepStart = microtime(true);
+ $this->resetOpcache();
+ $log('opcache_reset', 'Reset PHP OPcache', true, microtime(true) - $stepStart);
+
+ // Step 7: Disable maintenance mode
$stepStart = microtime(true);
$this->disableMaintenanceMode();
$log('maintenance_off', 'Disabled maintenance mode', true, microtime(true) - $stepStart);
- // Step 7: Release lock
+ // Step 8: Release lock
$this->releaseLock();
$totalDuration = microtime(true) - $startTime;
@@ -817,7 +950,7 @@ class UpdateExecutor
'create_backup' => $createBackup,
'started_at' => (new \DateTime())->format('c'),
'current_step' => 0,
- 'total_steps' => 14,
+ 'total_steps' => 15,
'step_name' => 'initializing',
'step_message' => 'Starting update process...',
'steps' => [],
@@ -890,7 +1023,7 @@ class UpdateExecutor
bool $createBackup = true,
?callable $onProgress = null
): array {
- $totalSteps = 12;
+ $totalSteps = 13;
$currentStep = 0;
$updateProgress = function (string $stepName, string $message, bool $success = true) use (&$currentStep, $totalSteps, $targetVersion, $createBackup): void {
diff --git a/src/Services/System/WatchtowerClient.php b/src/Services/System/WatchtowerClient.php
new file mode 100644
index 00000000..87cc06fd
--- /dev/null
+++ b/src/Services/System/WatchtowerClient.php
@@ -0,0 +1,125 @@
+.
+ */
+
+declare(strict_types=1);
+
+namespace App\Services\System;
+
+use Psr\Log\LoggerInterface;
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+
+/**
+ * HTTP client for communicating with the Watchtower container updater API.
+ * Used to trigger Docker container updates from the Part-DB UI.
+ *
+ * @see https://containrrr.dev/watchtower/
+ */
+readonly class WatchtowerClient
+{
+ public function __construct(
+ private HttpClientInterface $httpClient,
+ private LoggerInterface $logger,
+ #[Autowire(env: 'WATCHTOWER_API_URL')] private string $apiUrl,
+ #[Autowire(env: 'WATCHTOWER_API_TOKEN')] private string $apiToken,
+ ) {
+ }
+
+ /**
+ * Whether Watchtower integration is configured (URL and token are set).
+ */
+ public function isConfigured(): bool
+ {
+ return $this->apiUrl !== '' && $this->apiToken !== '';
+ }
+
+ /**
+ * Check if the Watchtower API is reachable.
+ * Makes a lightweight HTTP request with a short timeout.
+ */
+ public function isAvailable(): bool
+ {
+ if (!$this->isConfigured()) {
+ return false;
+ }
+
+ try {
+ $response = $this->httpClient->request('GET', $this->getUpdateEndpoint(), [
+ 'headers' => $this->getAuthHeaders(),
+ 'timeout' => 3,
+ ]);
+
+ // Any response means Watchtower is reachable
+ $statusCode = $response->getStatusCode();
+ return $statusCode < 500;
+ } catch (\Throwable $e) {
+ $this->logger->debug('Watchtower availability check failed: ' . $e->getMessage());
+ return false;
+ }
+ }
+
+ /**
+ * Trigger a container update via the Watchtower HTTP API.
+ * This is fire-and-forget: Watchtower will pull the new image and restart the container.
+ *
+ * @return bool True if Watchtower accepted the update request
+ */
+ public function triggerUpdate(): bool
+ {
+ if (!$this->isConfigured()) {
+ throw new \RuntimeException('Watchtower is not configured. Set WATCHTOWER_API_URL and WATCHTOWER_API_TOKEN.');
+ }
+
+ try {
+ $response = $this->httpClient->request('POST', $this->getUpdateEndpoint(), [
+ 'headers' => $this->getAuthHeaders(),
+ 'timeout' => 10,
+ ]);
+
+ $statusCode = $response->getStatusCode();
+
+ if ($statusCode >= 200 && $statusCode < 300) {
+ $this->logger->info('Watchtower update triggered successfully.');
+ return true;
+ }
+
+ $this->logger->error('Watchtower update request returned HTTP ' . $statusCode);
+ return false;
+ } catch (\Throwable $e) {
+ $this->logger->error('Failed to trigger Watchtower update: ' . $e->getMessage());
+ return false;
+ }
+ }
+
+ private function getUpdateEndpoint(): string
+ {
+ return rtrim($this->apiUrl, '/') . '/v1/update';
+ }
+
+ /**
+ * @return array
+ */
+ private function getAuthHeaders(): array
+ {
+ return [
+ 'Authorization' => 'Bearer ' . $this->apiToken,
+ ];
+ }
+}
diff --git a/src/Settings/AISettings/AISettings.php b/src/Settings/AISettings/AISettings.php
new file mode 100644
index 00000000..732eb597
--- /dev/null
+++ b/src/Settings/AISettings/AISettings.php
@@ -0,0 +1,43 @@
+.
+ */
+
+declare(strict_types=1);
+
+
+namespace App\Settings\AISettings;
+
+use App\Settings\SettingsIcon;
+use Jbtronics\SettingsBundle\Settings\EmbeddedSettings;
+use Jbtronics\SettingsBundle\Settings\Settings;
+use Jbtronics\SettingsBundle\Settings\SettingsTrait;
+use Symfony\Component\Translation\TranslatableMessage as TM;
+
+#[Settings(label: new TM("settings.ai"))]
+#[SettingsIcon("fa-brain")]
+class AISettings
+{
+ use SettingsTrait;
+
+ #[EmbeddedSettings]
+ public ?OpenRouterSettings $openRouter = null;
+
+ #[EmbeddedSettings]
+ public ?LMStudioSettings $lmstudio = null;
+}
diff --git a/src/Settings/AISettings/LMStudioSettings.php b/src/Settings/AISettings/LMStudioSettings.php
new file mode 100644
index 00000000..2bdad06e
--- /dev/null
+++ b/src/Settings/AISettings/LMStudioSettings.php
@@ -0,0 +1,53 @@
+.
+ */
+
+declare(strict_types=1);
+
+
+namespace App\Settings\AISettings;
+
+use App\Form\Type\APIKeyType;
+use App\Services\AI\AIPlatformSettingsInterface;
+use App\Settings\SettingsIcon;
+use Jbtronics\SettingsBundle\Metadata\EnvVarMode;
+use Jbtronics\SettingsBundle\Settings\Settings;
+use Jbtronics\SettingsBundle\Settings\SettingsParameter;
+use Jbtronics\SettingsBundle\Settings\SettingsTrait;
+use Symfony\Component\Form\Extension\Core\Type\UrlType;
+use Symfony\Component\Translation\StaticMessage;
+use Symfony\Component\Translation\TranslatableMessage as TM;
+
+#[Settings(name: 'ai_lmstudio', label: new TM("settings.ai.lmstudio"))]
+#[SettingsIcon("fa-robot")]
+class LMStudioSettings implements AIPlatformSettingsInterface
+{
+ use SettingsTrait;
+
+ #[SettingsParameter(label: new TM("settings.ai.lmstudio.hosturl"),
+ formType: UrlType::class,
+ formOptions: ["attr" => ["placeholder" => new StaticMessage("http://localhost:1234")]],
+ envVar: "AI_LMSTUDIO_HOSTURL", envVarMode: EnvVarMode::OVERWRITE)]
+ public ?string $hostURL = null;
+
+ public function isAIPlatformEnabled(): bool
+ {
+ return $this->hostURL !== null && $this->hostURL !== "";
+ }
+}
diff --git a/src/Settings/AISettings/OpenRouterSettings.php b/src/Settings/AISettings/OpenRouterSettings.php
new file mode 100644
index 00000000..e083513a
--- /dev/null
+++ b/src/Settings/AISettings/OpenRouterSettings.php
@@ -0,0 +1,50 @@
+.
+ */
+
+declare(strict_types=1);
+
+
+namespace App\Settings\AISettings;
+
+use App\Form\Type\APIKeyType;
+use App\Services\AI\AIPlatformSettingsInterface;
+use App\Settings\SettingsIcon;
+use Jbtronics\SettingsBundle\Metadata\EnvVarMode;
+use Jbtronics\SettingsBundle\Settings\Settings;
+use Jbtronics\SettingsBundle\Settings\SettingsParameter;
+use Jbtronics\SettingsBundle\Settings\SettingsTrait;
+use Symfony\Component\Translation\TranslatableMessage as TM;
+
+#[Settings(name: 'ai_openrouter', label: new TM("settings.ai.openrouter"), description: "settings.ai.openrouter.help")]
+#[SettingsIcon("fa-robot")]
+class OpenRouterSettings implements AIPlatformSettingsInterface
+{
+ use SettingsTrait;
+
+ #[SettingsParameter(label: new TM("settings.ips.element14.apiKey"),
+ formType: APIKeyType::class,
+ formOptions: ["help_html" => true], envVar: "AI_OPENROUTER_KEY", envVarMode: EnvVarMode::OVERWRITE)]
+ public ?string $apiKey = null;
+
+ public function isAIPlatformEnabled(): bool
+ {
+ return $this->apiKey !== null && $this->apiKey !== "";
+ }
+}
diff --git a/src/Settings/AppSettings.php b/src/Settings/AppSettings.php
index 14d9395e..085f7ffe 100644
--- a/src/Settings/AppSettings.php
+++ b/src/Settings/AppSettings.php
@@ -23,6 +23,7 @@ declare(strict_types=1);
namespace App\Settings;
+use App\Settings\AISettings\AISettings;
use App\Settings\BehaviorSettings\BehaviorSettings;
use App\Settings\InfoProviderSystem\InfoProviderSettings;
use App\Settings\MiscSettings\MiscSettings;
@@ -50,6 +51,9 @@ class AppSettings
#[EmbeddedSettings]
public ?SynonymSettings $synonyms = null;
+ #[EmbeddedSettings]
+ public ?AISettings $ai = null;
+
#[EmbeddedSettings()]
public ?MiscSettings $miscSettings = null;
diff --git a/src/Settings/BehaviorSettings/PartTableColumns.php b/src/Settings/BehaviorSettings/PartTableColumns.php
index 3b30e0a4..32f6100b 100644
--- a/src/Settings/BehaviorSettings/PartTableColumns.php
+++ b/src/Settings/BehaviorSettings/PartTableColumns.php
@@ -52,6 +52,8 @@ enum PartTableColumns : string implements TranslatableInterface
case TAGS = "tags";
case ATTACHMENTS = "attachments";
+ case SI_VALUE = "si_value";
+
case EDA_REFERENCE = "eda_reference";
case EDA_VALUE = "eda_value";
diff --git a/src/Settings/InfoProviderSystem/AIExtractorSettings.php b/src/Settings/InfoProviderSystem/AIExtractorSettings.php
new file mode 100644
index 00000000..af9753d9
--- /dev/null
+++ b/src/Settings/InfoProviderSystem/AIExtractorSettings.php
@@ -0,0 +1,78 @@
+.
+ */
+
+declare(strict_types=1);
+
+
+namespace App\Settings\InfoProviderSystem;
+
+use App\Form\Settings\AiModelsType;
+use App\Form\Settings\AiPlatformChoiceType;
+use App\Services\AI\AIPlatforms;
+use App\Settings\SettingsIcon;
+use Jbtronics\SettingsBundle\Metadata\EnvVarMode;
+use Jbtronics\SettingsBundle\Settings\Settings;
+use Jbtronics\SettingsBundle\Settings\SettingsParameter;
+use Jbtronics\SettingsBundle\Settings\SettingsTrait;
+use Symfony\AI\Platform\Capability;
+use Symfony\Component\Form\Extension\Core\Type\LanguageType;
+use Symfony\Component\Form\Extension\Core\Type\TextareaType;
+use Symfony\Component\Translation\StaticMessage;
+use Symfony\Component\Translation\TranslatableMessage as TM;
+use Symfony\Component\Validator\Constraints\Language;
+
+#[Settings(name: "ai_extractor", label: new TM("settings.ips.ai_extractor"), description: new TM("settings.ips.ai_extractor.description"))]
+#[SettingsIcon("fa-plug")]
+class AIExtractorSettings
+{
+ private const MODEL_SELECTOR_LABEL = 'ai_extractor';
+
+ use SettingsTrait;
+
+ #[SettingsParameter(label: new TM("settings.ips.ai_extractor.ai_platform"),
+ formType: AiPlatformChoiceType::class, formOptions: ['platform_selector_label' => self::MODEL_SELECTOR_LABEL],
+ )]
+ public ?AIPlatforms $platform = null;
+
+ #[SettingsParameter(label: new TM("settings.ips.ai_extractor.model"), description: new TM("settings.ips.ai_extractor.model.help"),
+ formType: AiModelsType::class, formOptions: [
+ 'platform_selector' => self::MODEL_SELECTOR_LABEL, 'filter_capability' => Capability::OUTPUT_STRUCTURED,
+ 'attr' => ['placeholder' => new StaticMessage('google/gemini-2.5-flash-lite')]
+ ],
+
+ )]
+ public ?string $model = null;
+
+ #[SettingsParameter(label: new TM("settings.ips.ai_extractor.max_content_length"),
+ description: new TM("settings.ips.ai_extractor.max_content_length.description"),
+ )]
+ public int $maxContentLength = 50000;
+
+ #[Language]
+ #[SettingsParameter(label: new TM("settings.ips.ai_extractor.output_language"), description: new TM("settings.ips.ai_extractor.output_language.description"),
+ formType: LanguageType::class,
+ )]
+ public ?string $outputLanguage = null;
+
+ #[SettingsParameter(label: new TM("settings.ips.ai_extractor.additional_instructions"), description: new TM("settings.ips.ai_extractor.additional_instructions.description"),
+ formType: TextareaType::class,
+ )]
+ public ?string $additionalInstructions = null;
+}
diff --git a/src/Settings/InfoProviderSystem/CanopySettings.php b/src/Settings/InfoProviderSystem/CanopySettings.php
index 0858871b..3c97a80e 100644
--- a/src/Settings/InfoProviderSystem/CanopySettings.php
+++ b/src/Settings/InfoProviderSystem/CanopySettings.php
@@ -72,7 +72,7 @@ class CanopySettings
/**
* @var string The domain used internally for the API requests. This is not necessarily the same as the domain shown to the user, which is determined by the keys of the ALLOWED_DOMAINS constant
*/
- #[SettingsParameter(label: new TM("settings.ips.tme.country"), formType: ChoiceType::class, formOptions: ["choices" => self::ALLOWED_DOMAINS])]
+ #[SettingsParameter(label: new TM("settings.ips.tme.country"), formType: ChoiceType::class, formOptions: ["choices" => self::ALLOWED_DOMAINS, 'translation_domain' => false])]
public string $domain = "DE";
/**
diff --git a/src/Settings/InfoProviderSystem/InfoProviderSettings.php b/src/Settings/InfoProviderSystem/InfoProviderSettings.php
index 248fcedc..3e2a27ef 100644
--- a/src/Settings/InfoProviderSystem/InfoProviderSettings.php
+++ b/src/Settings/InfoProviderSystem/InfoProviderSettings.php
@@ -40,6 +40,9 @@ class InfoProviderSettings
#[EmbeddedSettings]
public ?GenericWebProviderSettings $genericWebProvider = null;
+ #[EmbeddedSettings]
+ public ?AIExtractorSettings $aiExtractor = null;
+
#[EmbeddedSettings]
public ?DigikeySettings $digikey = null;
@@ -75,4 +78,5 @@ class InfoProviderSettings
#[EmbeddedSettings]
public ?CanopySettings $canopy = null;
+
}
diff --git a/src/Settings/MiscSettings/KiCadEDASettings.php b/src/Settings/MiscSettings/KiCadEDASettings.php
index cf31bd95..dd223007 100644
--- a/src/Settings/MiscSettings/KiCadEDASettings.php
+++ b/src/Settings/MiscSettings/KiCadEDASettings.php
@@ -62,4 +62,10 @@ class KiCadEDASettings
)]
public bool $defaultOrderdetailsVisibility = false;
+
+ #[SettingsParameter(
+ label: new TM("settings.misc.kicad_eda.use_custom_list"),
+ description: new TM("settings.misc.kicad_eda.use_custom_list.help"),
+ )]
+ public bool $useCustomList = false;
}
diff --git a/src/Twig/MiscExtension.php b/src/Twig/MiscExtension.php
index 390ad084..565d56f2 100644
--- a/src/Twig/MiscExtension.php
+++ b/src/Twig/MiscExtension.php
@@ -22,6 +22,7 @@ declare(strict_types=1);
*/
namespace App\Twig;
+use App\Services\InfoProviderSystem\CreateFromUrlHelper;
use Twig\Attribute\AsTwigFunction;
use App\Settings\SettingsIcon;
use Symfony\Component\HttpFoundation\Request;
@@ -34,7 +35,7 @@ use Twig\Extension\AbstractExtension;
final readonly class MiscExtension
{
- public function __construct(private EventCommentNeededHelper $eventCommentNeededHelper)
+ public function __construct(private EventCommentNeededHelper $eventCommentNeededHelper, private CreateFromUrlHelper $fromUrlHelper)
{
}
@@ -84,4 +85,14 @@ final readonly class MiscExtension
return $request->getBaseUrl().$request->getPathInfo().$qs;
}
+
+ /**
+ * Returns true if the from url provider is active, false otherwise.
+ * @return bool
+ */
+ #[AsTwigFunction(name: 'create_from_url_active')]
+ public function create_from_url_active(): bool
+ {
+ return $this->fromUrlHelper->canCreateFromUrl();
+ }
}
diff --git a/symfony.lock b/symfony.lock
index 68de2da7..f8f88675 100644
--- a/symfony.lock
+++ b/symfony.lock
@@ -375,6 +375,54 @@
"shivas/versioning-bundle": {
"version": "4.0.3"
},
+ "symfony/ai-bundle": {
+ "version": "0.8",
+ "recipe": {
+ "repo": "github.com/symfony/recipes",
+ "branch": "main",
+ "version": "0.1",
+ "ref": "2be6ccd77335c2631fdf12d1680649b072efb8ad"
+ },
+ "files": [
+ "config/packages/ai.yaml"
+ ]
+ },
+ "symfony/ai-generic-platform": {
+ "version": "0.8",
+ "recipe": {
+ "repo": "github.com/symfony/recipes",
+ "branch": "main",
+ "version": "0.1",
+ "ref": "f38913b87380322d4c40c302b41626e811516bc4"
+ },
+ "files": [
+ "config/packages/ai_generic_platform.yaml"
+ ]
+ },
+ "symfony/ai-lm-studio-platform": {
+ "version": "0.8",
+ "recipe": {
+ "repo": "github.com/symfony/recipes",
+ "branch": "main",
+ "version": "0.1",
+ "ref": "e35cced28f6559fc5effccb8f22597f309fedfdf"
+ },
+ "files": [
+ "config/packages/ai_lm_studio_platform.yaml"
+ ]
+ },
+ "symfony/ai-open-router-platform": {
+ "version": "0.8",
+ "recipe": {
+ "repo": "github.com/symfony/recipes",
+ "branch": "main",
+ "version": "0.1",
+ "ref": "c39a146c6ec3df8b874accf6ce1cccbda431a688"
+ },
+ "files": [
+ "config/packages/ai_open_router_platform.yaml"
+ ]
+ },
"symfony/apache-pack": {
"version": "1.0",
"recipe": {
@@ -393,12 +441,6 @@
"symfony/browser-kit": {
"version": "v4.2.3"
},
- "symfony/cache": {
- "version": "v4.2.3"
- },
- "symfony/cache-contracts": {
- "version": "v1.1.5"
- },
"symfony/config": {
"version": "v4.2.3"
},
diff --git a/templates/_navbar.html.twig b/templates/_navbar.html.twig
index 57331370..7719ab2b 100644
--- a/templates/_navbar.html.twig
+++ b/templates/_navbar.html.twig
@@ -52,7 +52,7 @@
{% trans %}info_providers.search.title{% endtrans %}
- {% if settings_instance('generic_web_provider').enabled %}
+ {% if create_from_url_active() %}
+
-
- {% for label, messages in app.flashes() %}
- {% for message in messages %}
- {{ include('_toast.html.twig', {
- 'label': label,
- 'message': message
- }) }}
- {% endfor %}
+ {% for label, messages in app.flashes() %}
+ {% for message in messages %}
+ {{ include('_toast.html.twig', {
+ 'label': label,
+ 'message': message
+ }) }}
{% endfor %}
-
+ {% endfor %}
{% endblock %}
-
-
{# Insert info about when the sidebar trees were updated last time, so the sidebar_tree_controller can decide if it needs to reload the tree #}
diff --git a/templates/admin/_delete_form.html.twig b/templates/admin/_delete_form.html.twig
index fd653256..5a1d5a1a 100644
--- a/templates/admin/_delete_form.html.twig
+++ b/templates/admin/_delete_form.html.twig
@@ -5,7 +5,7 @@