Skip to content

Updated Commons DAM example to work - User-agent is missing #3028

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adriendupuis merged 3 commits into from
Jan 30, 2026
Merged

Updated Commons DAM example to work - User-agent is missing #3028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b4f1bd
Added user-agent header in requests to Commons DAM
vidarl Jan 30, 2026
1a53b54
Fixed author line in view template for Commons DAM
vidarl Jan 30, 2026
9b51247
PHP & JS CS Fixes
vidarl Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions code_samples/back_office/images/src/Connector/Dam/Handler/WikimediaCommonsHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

class WikimediaCommonsHandler implements HandlerInterface
{
private const USER_AGENT = 'Ibexa DXP Commons Dam Connector';

@vidarl vidarl Jan 30, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe you want to inject Product name somehow . Wasn't sure if that worked in code snippets so hardcoded "Ibexa DXP"...


public function search(Query $query, int $offset = 0, int $limit = 20): AssetSearchResult
{
$searchUrl = 'https://commons.wikimedia.org/w/api.php?action=query&list=search&format=json&srnamespace=6'
Expand All @@ -22,7 +24,16 @@ public function search(Query $query, int $offset = 0, int $limit = 20): AssetSea
. '&srlimit=' . $limit
;

$jsonResponse = file_get_contents($searchUrl);
$opts = [
'http' => [
'method' => 'GET',
'header' => [
'User-Agent: ' . self::USER_AGENT,
],
],
];

$jsonResponse = file_get_contents($searchUrl, false, stream_context_create($opts));
if ($jsonResponse === false) {
return new AssetSearchResult(0, new AssetCollection([]));
}
Expand Down Expand Up @@ -50,7 +61,16 @@ public function fetchAsset(string $id): Asset
. '&titles=File%3a' . urlencode($id)
;

$jsonResponse = file_get_contents($metadataUrl);
$opts = [
'http' => [
'method' => 'GET',
'header' => [
'User-Agent: ' . self::USER_AGENT,
],
],
];

$jsonResponse = file_get_contents($metadataUrl, false, stream_context_create($opts));
if ($jsonResponse === false) {
throw new \RuntimeException('Couldn\'t retrieve asset metadata');
}
Expand Down
2 changes: 1 addition & 1 deletion code_samples/back_office/images/templates/themes/standard/commons_asset_view.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
{{ parent() }}
<div>
<a href="{{ asset.assetMetadata.page_url }}">Image</a>
{% if asset.assetMetadata.author %} by {{ asset.assetMetadata.author }}{% endif %}
{% if asset.assetMetadata.author %} by {{ asset.assetMetadata.author|striptags }}{% endif %}

@vidarl vidarl Jan 30, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we trust that the URL coming from Commons cannot contain bad things. This will display the author as link:

Suggested change
{% if asset.assetMetadata.author %} by {{ asset.assetMetadata.author|striptags }}{% endif %}
{% if asset.assetMetadata.author %} by {{ asset.assetMetadata.author|raw }}{% endif %}

@mnocon mnocon Jan 30, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a 3rd party site so we can never be 100% sure - and this template is just an example, this will be easy to modify.

I'd keep it as it (striptags instead of raw), better safe than sorry

@adriendupuis adriendupuis Jan 30, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://commons.wikimedia.org/wiki/Commons:Reusing_content_outside_Wikimedia and https://commons.wikimedia.org/wiki/Commons:Credit_line#Credit_lines_required_by_license doesn't seem to specifically require a link on the author, I guess the link to the image page is enough. To strip the author link shouldn't be an legal issue. In short, I'm OK with this change.

{% if asset.assetMetadata.license and asset.assetMetadata.license_url %}
under <a href="{{ asset.assetMetadata.license_url }}">{{ asset.assetMetadata.license }}</a>
{% endif %}.
Expand Down