Skip to content
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

Jump to bottom

Improve handling of translation downloads #73

Merged
merged 1 commit into from
Nov 1, 2023
Merged

Improve handling of translation downloads #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 14 additions & 4 deletions blocks/search_packages/controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@ class Controller extends BlockController
*/
public $allowedDownloadFor;

/**
* @var bool|int|string|null
*/
public $downloadsTokenProtected;

/**
* {@inheritdoc}
*
Expand Down Expand Up @@ -159,6 +164,7 @@ public function getBlockTypeDescription()

public function add()
{
$this->downloadsTokenProtected = true;
$this->edit();
}

Expand All @@ -170,6 +176,7 @@ public function edit()
$this->set('allowedDownloadFor', $this->allowedDownloadFor ?: self::ALLOWDOWNLOADFOR_NOBODY);
$this->set('allowedDownloadForList', $this->getDownloadAccessLevels());
$this->set('allowedDownloadFormats', $this->allowedDownloadFormats ? explode(',', $this->allowedDownloadFormats) : []);
$this->set('downloadsTokenProtected', !empty($this->downloadsTokenProtected));
$converters = [];
foreach ($this->app->make(TranslationsConverterProvider::class)->getRegisteredConverters() as $converter) {
if ($converter->canSerializeTranslations()) {
Expand Down Expand Up @@ -274,11 +281,13 @@ public function action_package(string $handle = '', string $version = ''): ?Resp
public function action_download_translations_file(string|int $packageVersionID = '', string $localeID = '', string $formatHandle = ''): ?Response
{
try {
$token = $this->app->make('token');
if (!is_numeric($packageVersionID) || !$token->validate("comtra-download-translations-{$packageVersionID}@{$localeID}.{$formatHandle}")) {
throw new UserMessageException($token->getErrorMessage());
if ($this->downloadsTokenProtected) {
$token = $this->app->make('token');
if (!$token->validate("comtra-download-translations-{$packageVersionID}@{$localeID}.{$formatHandle}")) {
throw new UserMessageException($token->getErrorMessage());
}
}
$packageVersion = $this->app->make(PackageVersionRepository::class)->find((int) $packageVersionID);
$packageVersion = is_numeric($packageVersionID) ? $this->app->make(PackageVersionRepository::class)->find((int) $packageVersionID) : null;
if ($packageVersion === null) {
throw new UserMessageException(t('Unable to find the specified package'));
}
Expand Down Expand Up @@ -353,6 +362,7 @@ protected function normalizeArgs(array $args)
}
$normalized['allowedDownloadFormats'] = implode(',', $allowedDownloadFormats);
$normalized['allowedDownloadFor'] = is_string($args['allowedDownloadFor'] ?? null) ? $args['allowedDownloadFor'] : '';
$normalized['downloadsTokenProtected'] = empty($args['downloadsTokenProtected']) ? 0 : 1;
if (!array_key_exists($normalized['allowedDownloadFor'], $this->getDownloadAccessLevels())) {
$error->add(t('Please specify who can download the translations'));
}
Expand Down
3 changes: 3 additions & 0 deletions blocks/search_packages/db.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
<field name="allowedDownloadFor" type="string" size="30">
<notnull/>
</field>
<field name="downloadsTokenProtected" type="boolean">
<notnull/>
</field>
</table>

</schema>
8 changes: 8 additions & 0 deletions blocks/search_packages/edit.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
* @var array $allowedDownloadForList
* @var string[] $allowedDownloadFormats
* @var CommunityTranslation\TranslationsConverter\ConverterInterface[] $downloadFormats
* @var bool $downloadsTokenProtected
*/

?>
Expand All @@ -29,6 +30,13 @@
<?= $form->select('allowedDownloadFor', $allowedDownloadForList, $allowedDownloadFor, ['required' => 'required']) ?>
</div>

<div class="mb-3">
<div class="form-check">
<?= $form->checkbox('downloadsTokenProtected', '1', $downloadsTokenProtected) ?>
<?= $form->label('downloadsTokenProtected', t('Protect downloads with a token')) ?>
</div>
</div>

<div class="mb-0 ct-allowed-formats"<?= ($allowedDownloadFor === $ALLOWDOWNLOADFOR_NOBODY) ? ' style="display: none"' : '' ?>>
<?= $form->label('allowedDownloadFormats', t('Allowed download formats')) ?>
<?php
Expand Down
20 changes: 17 additions & 3 deletions blocks/search_packages/view.package.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
* @var array $localeInfos
* @var bool $userIsLoggedIn
* @var string $onlineTranslationPath
* @var bool|int|string $downloadsTokenProtected
*/

// When there's a warning:
Expand Down Expand Up @@ -141,13 +142,26 @@
</div>
</td>
<td class="text-nowrap">
<span class="d-none d-sm-inline">
<div class="d-none d-sm-inline">
<?php
foreach ($localeInfo['downloadFormats'] as $adf) {
?><a class="btn btn-sm btn-secondary" href="<?= h($controller->getBlockActionURL('download_translations_file', $packageVersion->getID(), $locale->getID(), $adf->getHandle()) . '?' . $token->getParameter('comtra-download-translations-' . $packageVersion->getID() . '@' . $locale->getID() . '.' . $adf->getHandle())) ?>" title="<?= h(t('Download translations (%s)', $adf->getName())) ?>" style="white-space:nowrap"><i class="fa fa-cloud-download"></i> <?= h($adf->getFileExtension()) ?></a><?php
$downloadUrl = (string) $controller->getBlockActionURL('download_translations_file', $packageVersion->getID(), $locale->getID(), $adf->getHandle());
$title = t('Download translations (%s)', $adf->getName());
if ($downloadsTokenProtected) {
?>
<form method="POST" action="<?= h($downloadUrl) ?>" class="d-inline">
<?php $token->output('comtra-download-translations-' . $packageVersion->getID() . '@' . $locale->getID() . '.' . $adf->getHandle()) ?>
<button type="submit" class="btn btn-sm btn-secondary" title="<?= h($title) ?>" style="white-space:nowrap"><i class="fa fa-cloud-download"></i> <?= h($adf->getFileExtension()) ?></button>
</form>
<?php
} else {
?>
<a rel="nofollow" class="btn btn-sm btn-secondary" href="<?= h($downloadUrl) ?>" title="<?= h($title) ?>" style="white-space:nowrap"><i class="fa fa-cloud-download"></i> <?= h($adf->getFileExtension()) ?></a>
<?php
}
}
?>
</span>
</div>
<a class="btn btn-sm <?= $translateClass ?>" href="<?= h($translateLink) ?>"<?= $translateOnclick ?>><?= t('Translate') ?></a>
<?php
if ($localeInfo['totalStrings']) {
Expand Down