Skip to content

Multilingual Content (PoC) #6282

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.

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

Draft
wants to merge 20 commits into
base: 6.2
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
34c0e2d
Add database structure
Cyperghost May 6, 2025
8e06574
Add migration script
Cyperghost May 6, 2025
57648b1
Moving language values for content in the user ranks to the installat…
Cyperghost May 6, 2025
0c1511a
Load rank titles in `UserRankList`
Cyperghost May 6, 2025
c86cdf3
Implement eager cache for user ranks
Cyperghost May 6, 2025
aa1fe9d
Save user rank content through the form builder
Cyperghost May 6, 2025
cb21847
Implement `I18nFormDataProcessor` to handle values from a content table
Cyperghost May 6, 2025
8ad0570
Remove unnecessary backwards compatibility code
Cyperghost May 7, 2025
a649abd
Remove `rankTitle` property from `UserRank`
Cyperghost May 7, 2025
448aa14
Add a data processor to handle the value `none` for the CSS class name
Cyperghost May 7, 2025
8897a3a
Set `null` as monolingual `langaugeID`
Cyperghost May 8, 2025
0b56868
Prevent the execution of an additional (unnecessary) SQL query
Cyperghost May 8, 2025
0e84953
Update wcfsetup/install/files/acp/install_com.woltlab.wcf_step2.php
Cyperghost May 8, 2025
5444baf
Don't use transaction here
Cyperghost May 8, 2025
ac89843
Implement `getRank()` method in `UserRankCache` to simply get the use…
Cyperghost May 8, 2025
edfb753
Do not use `UNIQUE KEY`, as the value `null` can be included
Cyperghost May 8, 2025
0761068
Implement helper function to get the subquery for the column of the c…
Cyperghost May 9, 2025
e4bc9c4
Fix spelling for `$objectIDColumn`
Cyperghost May 9, 2025
4a8dad8
Use the langaugeID `null` as `0` array-key instead of an empty string
Cyperghost May 12, 2025
31156de
Use `null` instead of the default language id for monolingual content
Cyperghost May 12, 2025
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
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,12 @@

use wcf\system\database\table\column\IntDatabaseTableColumn;
use wcf\system\database\table\column\MediumtextDatabaseTableColumn;
use wcf\system\database\table\column\TextDatabaseTableColumn;
use wcf\system\database\table\column\TinyintDatabaseTableColumn;
use wcf\system\database\table\column\NotNullVarchar255DatabaseTableColumn;
use wcf\system\database\table\column\ObjectIdDatabaseTableColumn;
use wcf\system\database\table\DatabaseTable;
use wcf\system\database\table\index\DatabaseTableForeignKey;
use wcf\system\database\table\index\DatabaseTableIndex;
use wcf\system\database\table\index\DatabaseTablePrimaryIndex;
use wcf\system\database\table\PartialDatabaseTable;

return [
Expand Down Expand Up @@ -58,4 +61,30 @@
->columns([
IntDatabaseTableColumn::create('uploadTime'),
]),
DatabaseTable::create('wcf1_user_rank_content')
->columns([
ObjectIdDatabaseTableColumn::create('contentID'),
IntDatabaseTableColumn::create('rankID')
->notNull(),
IntDatabaseTableColumn::create('languageID'),
NotNullVarchar255DatabaseTableColumn::create('title'),
])
->indices([
DatabaseTablePrimaryIndex::create()
->columns(['contentID']),
DatabaseTableIndex::create('id')
->columns(['rankID', 'languageID']),
])
->foreignKeys([
DatabaseTableForeignKey::create()
->columns(['rankID'])
->referencedTable('wcf1_user_rank')
->referencedColumns(['rankID'])
->onDelete('CASCADE'),
DatabaseTableForeignKey::create()
->columns(['languageID'])
->referencedTable('wcf1_language')
->referencedColumns(['languageID'])
->onDelete('CASCADE'),
]),
];
35 changes: 24 additions & 11 deletions wcfsetup/install/files/acp/install_com.woltlab.wcf_step2.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use wcf\data\user\UserEditor;
use wcf\data\user\UserProfileAction;
use wcf\system\image\adapter\ImagickImageAdapter;
use wcf\system\language\LanguageFactory;
use wcf\system\WCF;

// set default landing page
Expand All @@ -24,22 +25,34 @@
]);

// install default user ranks
$sql = "INSERT INTO wcf1_user_rank_content
(rankID, languageID, title)
VALUES (?, ?, ?)";
$statement = WCF::getDB()->prepare($sql);

foreach ([
[4, 0, 'wcf.user.rank.administrator', 'blue'],
[5, 0, 'wcf.user.rank.moderator', 'blue'],
[3, 0, 'wcf.user.rank.user0', ''],
[3, 300, 'wcf.user.rank.user1', ''],
[3, 900, 'wcf.user.rank.user2', ''],
[3, 3000, 'wcf.user.rank.user3', ''],
[3, 9000, 'wcf.user.rank.user4', ''],
[3, 15000, 'wcf.user.rank.user5', ''],
] as [$groupID, $requiredPoints, $rankTitle, $cssClassName]) {
UserRankEditor::create([
[4, 0, ['de' => 'Administrator', 'en' => 'Administrator'], 'blue'],
[5, 0, ['de' => 'Moderator', 'en' => 'Moderator'], 'blue'],
[3, 0, ['de' => 'Anfänger', 'en' => 'Beginner'], ''],
[3, 300, ['de' => 'Schüler', 'en' => 'Student'], ''],
[3, 900, ['de' => 'Fortgeschrittener', 'en' => 'Intermediate'], ''],
[3, 3000, ['de' => 'Profi', 'en' => 'Professional'], ''],
[3, 9000, ['de' => 'Meister', 'en' => 'Master'], ''],
[3, 15000, ['de' => 'Erleuchteter', 'en' => 'Enlightened'], ''],
] as [$groupID, $requiredPoints, $rankTitles, $cssClassName]) {
$userRank = UserRankEditor::create([
'groupID' => $groupID,
'requiredPoints' => $requiredPoints,
'rankTitle' => $rankTitle,
'cssClassName' => $cssClassName,
]);

foreach (LanguageFactory::getInstance()->getLanguages() as $language) {
$statement->execute([
$userRank->rankID,
$language->languageID,
$rankTitles[$language->languageCode],
]);
}
}

// update administrator user rank and user online marking
Expand Down
47 changes: 47 additions & 0 deletions wcfsetup/install/files/acp/update_com.woltlab.wcf_6.2_userRank.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?php

use wcf\system\database\util\PreparedStatementConditionBuilder;
use wcf\system\language\LanguageFactory;
use wcf\system\WCF;

$sql = "SELECT rankID, rankTitle
FROM wcf1_user_rank";
$statement = WCF::getDB()->prepare($sql);
$statement->execute();
$titles = $statement->fetchMap('rankID', 'rankTitle');

$sql = "INSERT INTO wcf1_user_rank_content
(rankID, languageID, title)
VALUES (?, ?, ?)";
$statement = WCF::getDB()->prepare($sql);

$languageItems = [];
foreach ($titles as $rankID => $title) {
if (\preg_match('~^wcf\.user\.rank\.\w+$~', $title, $matches)) {
$languageItems[] = $title;

foreach (LanguageFactory::getInstance()->getLanguages() as $language) {
$statement->execute([
$rankID,
$language->languageID,
$language->get($title),
]);
}
} else {
$statement->execute([
$rankID,
null,
$title,
]);
}
}

if ($languageItems !== []) {
$conditionBuilder = new PreparedStatementConditionBuilder();
$conditionBuilder->add('languageItem IN (?)', [$languageItems]);

$sql = "DELETE FROM wcf1_language_item
{$conditionBuilder}";
$statement = WCF::getDB()->prepare($sql);
$statement->execute($conditionBuilder->getParameters());
}
27 changes: 26 additions & 1 deletion wcfsetup/install/files/lib/acp/form/UserRankAddForm.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use wcf\form\AbstractFormBuilderForm;
use wcf\system\form\builder\container\FormContainer;
use wcf\system\form\builder\data\processor\CustomFormDataProcessor;
use wcf\system\form\builder\data\processor\I18nFormDataProcessor;
use wcf\system\form\builder\field\BadgeColorFormField;
use wcf\system\form\builder\field\BooleanFormField;
use wcf\system\form\builder\field\IntegerFormField;
Expand Down Expand Up @@ -66,7 +67,6 @@ public function createForm()
TextFormField::create('rankTitle')
->label('wcf.acp.user.rank.title')
->i18n()
->languageItemPattern('wcf.user.rank.\w+')
->required(),
BadgeColorFormField::create('cssClassName')
->label('wcf.acp.user.rank.cssClassName')
Expand Down Expand Up @@ -126,6 +126,12 @@ protected function finalizeForm()
parent::finalizeForm();

$this->form->getDataHandler()
->addProcessor(
new I18nFormDataProcessor(
'wcf1_user_rank_content',
['rankTitle' => 'title']
)
)
->addProcessor(
new CustomFormDataProcessor(
'requiredGenderProcessor',
Expand All @@ -139,6 +145,25 @@ function (IFormDocument $document, array $data, IStorableObject $object) {

$data['requiredGender'] = $data['requiredGender'] ?: null;

return $data;
}
)
)
->addProcessor(
new CustomFormDataProcessor(
'cssClassNameDataProcessor',
static function (IFormDocument $document, array $parameters) {
if (isset($parameters['data']['cssClassName']) && $parameters['data']['cssClassName'] === 'none') {
$parameters['data']['cssClassName'] = '';
}

return $parameters;
},
static function (IFormDocument $document, array $data, IStorableObject $object) {
\assert($object instanceof UserRank);

$data['cssClassName'] = $data['cssClassName'] ?: 'none';

return $data;
}
)
Expand Down
33 changes: 32 additions & 1 deletion wcfsetup/install/files/lib/acp/form/UserRankEditForm.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@

namespace wcf\acp\form;

use wcf\acp\page\UserRankListPage;
use CuyZ\Valinor\Mapper\MappingError;
use wcf\acp\page\UserRankListPage;
use wcf\data\IStorableObject;
use wcf\data\user\rank\UserRank;
use wcf\http\Helper;
use wcf\system\exception\IllegalLinkException;
use wcf\system\form\builder\data\processor\CustomFormDataProcessor;
use wcf\system\form\builder\IFormDocument;
use wcf\system\interaction\admin\UserRankInteractions;
use wcf\system\interaction\StandaloneInteractionContextMenuView;
use wcf\system\request\LinkHandler;
Expand Down Expand Up @@ -58,6 +61,34 @@ public function readParameters()
}
}

#[\Override]
protected function finalizeForm()
{
parent::finalizeForm();

// The `DeleteInteraction` in `UserRankInteractions` outputs the title and would otherwise execute an additional SQL query.
$this->form->getDataHandler()
->addProcessor(
new CustomFormDataProcessor(
'setRankTitlesFormDataProcessor',
null,
static function (IFormDocument $document, array $data, IStorableObject $object) {
\assert($object instanceof UserRank);

if (\is_array($data['rankTitle'])) {
foreach ($data['rankTitle'] as $languageID => $rankTitle) {
$object->setRankTitle($languageID, $rankTitle);
}
} else {
$object->setRankTitle(null, $data['rankTitle']);
}

return $data;
}
)
);
}

/**
* @inheritDoc
*/
Expand Down
6 changes: 3 additions & 3 deletions wcfsetup/install/files/lib/data/user/UserProfile.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
use wcf\data\user\option\ViewableUserOption;
use wcf\data\user\rank\UserRank;
use wcf\system\cache\builder\UserGroupPermissionCacheBuilder;
use wcf\system\cache\builder\UserRankCacheBuilder;
use wcf\system\cache\eager\UserRankCache;
use wcf\system\cache\runtime\FileRuntimeCache;
use wcf\system\cache\runtime\UserProfileRuntimeCache;
use wcf\system\database\util\PreparedStatementConditionBuilder;
Expand Down Expand Up @@ -923,7 +923,7 @@ public function getUserTitle()
return $this->userTitle;
}
if ($this->getRank() && $this->getRank()->showTitle()) {
return WCF::getLanguage()->get($this->getRank()->rankTitle);
return $this->getRank()->getTitle();
}

return '';
Expand All @@ -939,7 +939,7 @@ public function getRank(): ?UserRank
return null;
}

return UserRankCacheBuilder::getInstance()->getRank($this->rankID);
return (new UserRankCache())->getRank($this->rankID);
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
* @since 6.0
*
* @extends I18nDatabaseObjectList<UserRank>
*
* @deprecated 6.2 use `UserRankList` instead
*/
class I18nUserRankList extends I18nDatabaseObjectList
{
Expand Down
49 changes: 47 additions & 2 deletions wcfsetup/install/files/lib/data/user/rank/UserRank.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
use wcf\data\DatabaseObject;
use wcf\data\ITitledObject;
use wcf\system\form\builder\field\UploadFormField;
use wcf\system\language\LanguageFactory;
use wcf\system\WCF;
use wcf\util\StringUtil;

Expand All @@ -18,7 +19,6 @@
* @property-read int $rankID unique id of the user rank
* @property-read int $groupID id of the user group to which the user rank belongs
* @property-read int $requiredPoints minimum number of user activity points required for a user to get the user rank
* @property-read string $rankTitle title of the user rank or name of the language item which contains the rank
* @property-read string $cssClassName css class name used when displaying the user rank
* @property-read string $rankImage (WCF relative) path to the image displayed next to the rank or empty if no rank image exists
* @property-read int $repeatImage number of times the rank image is displayed
Expand All @@ -29,6 +29,13 @@ class UserRank extends DatabaseObject implements ITitledObject
{
public const RANK_IMAGE_DIR = 'images/rank/';

/**
* @var array<int, string>
*
* @since 6.2
*/
protected array $titles;

/**
* Returns the image of this user rank.
*
Expand All @@ -54,7 +61,45 @@ public function getImage()
*/
public function getTitle(): string
{
return WCF::getLanguage()->get($this->rankTitle);
$this->loadTitles();

return $this->titles[WCF::getLanguage()->languageID]
?? $this->titles[LanguageFactory::getInstance()->getDefaultLanguageID()]
?? \reset($this->titles);
}

/**
* @since 6.2
*/
protected function loadTitles(): void
{
if (isset($this->titles)) {
return;
}

$sql = "SELECT languageID, title
FROM wcf1_user_rank_content
WHERE rankID = ?";

$statement = WCF::getDB()->prepare($sql);
$statement->execute([$this->rankID]);

$this->titles = [];
while ($row = $statement->fetchArray()) {
$this->titles[$row['languageID'] ?: 0] = $row['title'];
}
}

/**
* @since 6.2
*/
public function setRankTitle(?int $languageID, string $title): void
{
if (!isset($this->titles)) {
$this->titles = [];
}

$this->titles[$languageID ?: 0] = $title;
}

/**
Expand Down
Loading