feat: Divi composer – short/full form to blocks with structure rules, presets and labels
Labels, background_color and preset ids go through the choke point (S13); ambiguous preset names fail with their ids (S13a); fullwidth + rows is an error. Carry-ins: control characters stripped before the marker check (S32), kind override may only tighten, reference alt texts dropped, color check via VariableRef::typeOf (S33). Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01At3V6SjwbMe6eMzVGW3Hs7
This commit is contained in:
Claude Opus 5.5
@@ -39,6 +39,9 @@ final class AttrWriter
|
||||
* path shape at any depth: module.advanced.html(.htmlBefore), module.decoration.attributes,
|
||||
* any free-form custom CSS path of any module (css, css.*, title.css.*, css.advanced.customCss).
|
||||
*/
|
||||
/** Text-family kinds from laxest to strictest (ruling S33a); url stands apart. */
|
||||
private const STRICTNESS = ['code' => 0, 'html' => 1, 'text' => 2];
|
||||
|
||||
private const BUILDER_ONLY = '/(^|\.)(decoration\.attributes|advanced\.html|advanced\.customCss|css)(\.|$)/';
|
||||
|
||||
public function __construct(
|
||||
@@ -92,8 +95,9 @@ final class AttrWriter
|
||||
* Cleans one value written to $path (used by the short form too). $subKey names the
|
||||
* sub-field of a composite path ("linkUrl" of button.innerContent) when $value is its
|
||||
* string alone. $kind ('html'|'code'|'url'|'text') replaces the catalog routing for every
|
||||
* string of $value: the short form passes its curated field kind (ShortformMap), so a
|
||||
* short-form url field is always a URL and icon-list-item text always plain text.
|
||||
* string of $value: the short form passes its curated field kind (ShortformMap), so
|
||||
* icon-list-item text is always plain text. It may only tighten (ruling S33a): code < html
|
||||
* < text; url only where the routing says url – a weaker or other-family kind is refused.
|
||||
*
|
||||
* @param 'html'|'code'|'url'|'text'|null $kind
|
||||
* @throws InvalidArgumentException
|
||||
@@ -198,7 +202,17 @@ final class AttrWriter
|
||||
throw new InvalidArgumentException('Wert ist kein gültiges UTF-8.');
|
||||
}
|
||||
|
||||
$kind ??= $this->kind($module, $path, $subName, $key);
|
||||
$routed = $this->kind($module, $path, $subName, $key);
|
||||
if ($kind !== null && ! self::tightens($kind, $routed)) {
|
||||
throw new InvalidArgumentException(sprintf(
|
||||
'Feldart "%s" ist für "%s" nicht zulässig (das Attribut verlangt "%s").',
|
||||
$kind,
|
||||
$path,
|
||||
$routed
|
||||
));
|
||||
}
|
||||
|
||||
$kind ??= $routed;
|
||||
if (VariableRef::contains($value)) {
|
||||
// The only way a reference is stored: whole, straight from canonical().
|
||||
return $this->placeholders->references()->canonical($value, $this->sanitizer, $kind === 'url');
|
||||
@@ -211,8 +225,10 @@ final class AttrWriter
|
||||
default => $this->sanitizer->text($value),
|
||||
};
|
||||
|
||||
// Ruling S28: sanitizers strip characters ("<x>", NUL, "%41") and can thereby build a
|
||||
// marker the raw check above never saw – so the final string is checked again.
|
||||
// Ruling S32: control characters (the WordPress sanitizers keep NUL & co.) go before the
|
||||
// check. Ruling S28: sanitizers strip characters ("<x>", NUL, "%41") and can thereby build
|
||||
// a marker the raw check above never saw – so the final string is checked again.
|
||||
$clean = VariableRef::withoutControls($clean);
|
||||
if (VariableRef::contains($clean)) {
|
||||
throw VariableRef::notAlone();
|
||||
}
|
||||
@@ -220,6 +236,21 @@ final class AttrWriter
|
||||
return $clean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether the kind override $kind is at least as strict as the routed kind (ruling S33a).
|
||||
* Strictness within the text family: code (raw for unfiltered_html) < html (kses) < text
|
||||
* (no markup). url (esc_url_raw) is a family of its own: it neither tightens nor is
|
||||
* tightened by the others, so only url → url passes.
|
||||
*/
|
||||
private static function tightens(string $kind, string $routed): bool
|
||||
{
|
||||
if ($kind === 'url' || $routed === 'url') {
|
||||
return $kind === $routed;
|
||||
}
|
||||
|
||||
return self::STRICTNESS[$kind] >= self::STRICTNESS[$routed];
|
||||
}
|
||||
|
||||
/**
|
||||
* Sanitizer for a string (rulings S3/S3a/S23/S24): the catalog kind of the path – or of the
|
||||
* sub-field for a composite path – decides. A string reached through a key below a path
|
||||
|
||||
@@ -0,0 +1,548 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace LIT\MCP\Integrations\Divi\Compose;
|
||||
|
||||
use InvalidArgumentException;
|
||||
use LIT\MCP\Integrations\Divi\BlockTree\AttrMap;
|
||||
use LIT\MCP\Integrations\Divi\BlockTree\Block;
|
||||
use LIT\MCP\Integrations\Divi\Design\DesignSystem;
|
||||
use LIT\MCP\Integrations\Divi\Schema\ModuleCatalog;
|
||||
use LIT\MCP\Integrations\Divi\Schema\ShortformMap;
|
||||
|
||||
/**
|
||||
* Builds new Divi blocks from node descriptions (spec §5.4): short form, full form ("attrs")
|
||||
* or both; sections with rows ("columns": "1_3,2_3") and modules; parent modules with
|
||||
* "items"; presets by name; automatic admin labels "<Abschnitt> – <Modul>" (spec §5.5).
|
||||
* Every error is collected with its input path; blocks are only usable when there are none.
|
||||
* Pure PHP.
|
||||
*
|
||||
* Divi saves bypass kses (D7): every client string reaches the attributes only through
|
||||
* ShortformWriter / AttrWriter::cleanValue() (the single choke point) – short-form fields,
|
||||
* full-form attrs, admin labels, background_color (ShortformWriter::color(), ruling S13) and
|
||||
* preset ids. A value that fails there is an error, never stored raw (S13). What Composer
|
||||
* writes itself is not client text: the builder version (checked in the constructor), block
|
||||
* names (catalog + StructureRules + Block::create), "fullwidth" and column flexTypes built
|
||||
* from digits. Design-system names that match several entries are errors listing the ids
|
||||
* (ruling S13a: colors/variables in Placeholders, presets here).
|
||||
*/
|
||||
final class Composer
|
||||
{
|
||||
private const COMMON = ['type', 'label', 'preset', 'attrs'];
|
||||
private const SECTION = ['section_type', 'background_color', 'rows', 'modules'];
|
||||
private const ROW = ['columns', 'modules'];
|
||||
|
||||
/** Keys of one lit-divi-update change ("id" names the node, read by the ability). */
|
||||
private const UPDATE = ['id', 'set', 'attrs', 'preset', 'label'];
|
||||
|
||||
/** Column fractions Divi's flex layout knows besides multiples of 1/24. */
|
||||
private const SPECIAL_WIDTHS = ['1_5', '2_5', '3_5', '4_5', '1_7', '1_9', '1_10', '1_11'];
|
||||
|
||||
/** ET_BUILDER_PRODUCT_VERSION, e.g. "5.2.1" – written into every new block. */
|
||||
private const VERSION = '/^[0-9][0-9A-Za-z.+-]*$/D';
|
||||
|
||||
private const LABEL_PATH = 'module.meta.adminLabel';
|
||||
|
||||
/** @var array<string, string> */
|
||||
private array $errors = [];
|
||||
|
||||
/** @var list<string> */
|
||||
private array $invalidPaths = [];
|
||||
|
||||
/** @throws InvalidArgumentException When $builderVersion is no version number. */
|
||||
public function __construct(
|
||||
private ModuleCatalog $catalog,
|
||||
private StructureRules $rules,
|
||||
private ShortformWriter $shortform,
|
||||
private AttrWriter $attrWriter,
|
||||
private DesignSystem $design,
|
||||
private string $builderVersion
|
||||
) {
|
||||
if (preg_match(self::VERSION, $builderVersion) !== 1) {
|
||||
throw new InvalidArgumentException(sprintf('"%s" is not a Divi builder version.', $builderVersion));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<array-key, mixed> $specs Node descriptions.
|
||||
* @param Block|null $parent Block the nodes go into (null = top level of the page).
|
||||
* @param string $field Input path of $specs for error keys, e.g. "nodes".
|
||||
* @param string $context Admin label of the surrounding section ("" if none).
|
||||
* @return array{blocks: list<Block>, errors: array<string, string>, invalid_paths: list<string>}
|
||||
*/
|
||||
public function compose(array $specs, ?Block $parent, string $field, string $context = ''): array
|
||||
{
|
||||
$this->errors = [];
|
||||
$this->invalidPaths = [];
|
||||
$blocks = [];
|
||||
foreach (array_values($specs) as $position => $spec) {
|
||||
$block = $this->node($spec, $parent, sprintf('%s[%d]', $field, $position), $context);
|
||||
if ($block !== null) {
|
||||
$blocks[] = $block;
|
||||
}
|
||||
}
|
||||
|
||||
return ['blocks' => $blocks, 'errors' => $this->errors, 'invalid_paths' => $this->invalidPaths];
|
||||
}
|
||||
|
||||
/**
|
||||
* Applies short-form fields ("set"), full-form attrs, preset and label to an existing block
|
||||
* (lit-divi-update); errors like compose(). The block itself is not changed – the caller
|
||||
* sets the returned attrs. "preset": null and "label": null remove them.
|
||||
*
|
||||
* @param array<array-key, mixed> $change id, set, attrs, preset, label
|
||||
* @return array{attrs: array<string, mixed>, errors: array<string, string>, invalid_paths: list<string>}
|
||||
*/
|
||||
public function update(Block $block, array $change, string $field): array
|
||||
{
|
||||
$this->errors = [];
|
||||
$this->invalidPaths = [];
|
||||
$attrs = $block->attrs();
|
||||
if (! $block->isDivi() || $block->isOpaque()) {
|
||||
$this->errors[$field . '.id'] = 'nur lesbar (globales Modul oder fremder Block)';
|
||||
|
||||
return ['attrs' => $attrs, 'errors' => $this->errors, 'invalid_paths' => []];
|
||||
}
|
||||
|
||||
$this->unknownKeys($change, self::UPDATE, $field);
|
||||
if (array_key_exists('set', $change)) {
|
||||
if (! is_array($change['set']) || $change['set'] === [] || array_is_list($change['set'])) {
|
||||
$this->errors[$field . '.set'] = 'Objekt mit Kurzform-Feldern erwartet';
|
||||
} else {
|
||||
$result = $this->shortform->apply($block->shortName(), $attrs, $change['set'], $field . '.set');
|
||||
$attrs = $result['attrs'];
|
||||
$this->errors += $result['errors'];
|
||||
}
|
||||
}
|
||||
|
||||
$attrs = $this->presetAndAttrs($block->name(), $attrs, $change, $field);
|
||||
if (array_key_exists('label', $change)) {
|
||||
$attrs = $change['label'] === null || $change['label'] === ''
|
||||
? AttrMap::remove($attrs, self::LABEL_PATH)
|
||||
: $this->label($block->name(), $attrs, $change['label'], $field . '.label');
|
||||
}
|
||||
|
||||
return ['attrs' => $attrs, 'errors' => $this->errors, 'invalid_paths' => $this->invalidPaths];
|
||||
}
|
||||
|
||||
/** Admin label for a new module: "<Abschnitt> – <Modultitel>" or the title alone. */
|
||||
public function autoLabel(string $name, string $context): string
|
||||
{
|
||||
$title = $this->catalog->title($name);
|
||||
|
||||
return $context === '' ? $title : $context . ' – ' . $title;
|
||||
}
|
||||
|
||||
private function node(mixed $spec, ?Block $parent, string $path, string $context): ?Block
|
||||
{
|
||||
if (! is_array($spec) || array_is_list($spec)) {
|
||||
$this->errors[$path] = 'Objekt mit "type" erwartet';
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
$type = $this->typeOf($spec, $parent);
|
||||
if ($type === null) {
|
||||
$this->errors[$path . '.type'] = 'type fehlt';
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
$violation = $this->rules->violation($parent, $type);
|
||||
if ($violation !== null) {
|
||||
$this->errors[$path . '.type'] = $violation;
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
return match ($type) {
|
||||
'divi/section' => $this->section($spec, $path),
|
||||
'divi/row' => $this->row($spec, $path, $context),
|
||||
default => $this->module($type, $spec, $path, $context),
|
||||
};
|
||||
}
|
||||
|
||||
/** @param array<array-key, mixed> $spec */
|
||||
private function typeOf(array $spec, ?Block $parent): ?string
|
||||
{
|
||||
if (is_string($spec['type'] ?? null) && trim($spec['type']) !== '') {
|
||||
return ModuleCatalog::normalize($spec['type']);
|
||||
}
|
||||
|
||||
if (array_key_exists('type', $spec)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$children = $parent === null ? [] : $this->catalog->childrenOf($parent->name());
|
||||
|
||||
return count($children) === 1 ? $children[0] : null;
|
||||
}
|
||||
|
||||
/** @param array<array-key, mixed> $spec */
|
||||
private function section(array $spec, string $path): Block
|
||||
{
|
||||
$this->unknownKeys($spec, array_merge(self::COMMON, self::SECTION), $path);
|
||||
$type = $spec['section_type'] ?? 'regular';
|
||||
$attrs = ['builderVersion' => $this->builderVersion];
|
||||
if ($type === 'fullwidth') {
|
||||
$attrs = AttrMap::set($attrs, 'module.advanced.type', ['desktop' => ['value' => 'fullwidth']]);
|
||||
} elseif ($type !== 'regular') {
|
||||
$this->errors[$path . '.section_type'] = 'regular oder fullwidth erwartet (specialty nur im Divi-Builder)';
|
||||
}
|
||||
|
||||
if (array_key_exists('background_color', $spec)) {
|
||||
$attrs = $this->backgroundColor($attrs, $spec['background_color'], $path . '.background_color');
|
||||
}
|
||||
|
||||
$attrs = $this->common('divi/section', $attrs, $spec, $path, null);
|
||||
$label = AttrMap::desktop($attrs, self::LABEL_PATH);
|
||||
$context = is_string($label) ? $label : '';
|
||||
$section = Block::create('divi/section', $attrs);
|
||||
|
||||
$hasRows = array_key_exists('rows', $spec);
|
||||
$hasModules = array_key_exists('modules', $spec);
|
||||
if ($type === 'fullwidth') {
|
||||
if ($hasRows) {
|
||||
$this->errors[$path . '.rows'] = 'ein Vollbreite-Abschnitt (section_type fullwidth) hat keine Zeilen; '
|
||||
. 'fullwidth-Module unter "modules" angeben';
|
||||
}
|
||||
$this->children($section, $spec['modules'] ?? [], $path . '.modules', $context);
|
||||
} elseif ($hasRows && $hasModules) {
|
||||
$this->errors[$path] = 'entweder rows oder modules angeben';
|
||||
} elseif ($hasModules) {
|
||||
$this->children($section, [['type' => 'row', 'modules' => $spec['modules']]], $path . '.modules', $context);
|
||||
} else {
|
||||
$this->children($section, $spec['rows'] ?? [], $path . '.rows', $context);
|
||||
}
|
||||
|
||||
return $section;
|
||||
}
|
||||
|
||||
/** @param array<array-key, mixed> $spec */
|
||||
private function row(array $spec, string $path, string $context): Block
|
||||
{
|
||||
$this->unknownKeys($spec, array_merge(self::COMMON, self::ROW), $path);
|
||||
$widths = $this->widths($spec['columns'] ?? '4_4', $path . '.columns');
|
||||
$label = $context === '' ? null : $context . ' – Zeile';
|
||||
$attrs = $this->common('divi/row', ['builderVersion' => $this->builderVersion], $spec, $path, $label);
|
||||
$row = Block::create('divi/row', $attrs);
|
||||
|
||||
$modules = $spec['modules'] ?? [];
|
||||
if (! is_array($modules) || ! array_is_list($modules)) {
|
||||
$this->errors[$path . '.modules'] = 'Liste erwartet (je Spalte eine Liste von Modulen)';
|
||||
$modules = [];
|
||||
}
|
||||
|
||||
// One column: a flat list of modules is accepted.
|
||||
$first = $modules[0] ?? null;
|
||||
if (count($widths) === 1 && is_array($first) && ! array_is_list($first)) {
|
||||
$modules = [$modules];
|
||||
}
|
||||
|
||||
if (count($modules) > count($widths)) {
|
||||
$this->errors[$path . '.modules'] = sprintf(
|
||||
'%d Spalten, aber %d Modul-Listen',
|
||||
count($widths),
|
||||
count($modules)
|
||||
);
|
||||
}
|
||||
|
||||
foreach ($widths as $position => $width) {
|
||||
$column = Block::create('divi/column', AttrMap::set(
|
||||
['builderVersion' => $this->builderVersion],
|
||||
'module.decoration.sizing',
|
||||
['desktop' => ['value' => ['flexType' => $width]]]
|
||||
));
|
||||
$row->insertChild($position, $column);
|
||||
$this->children($column, $modules[$position] ?? [], sprintf('%s.modules[%d]', $path, $position), $context);
|
||||
}
|
||||
|
||||
return $row;
|
||||
}
|
||||
|
||||
/** @param array<array-key, mixed> $spec */
|
||||
private function module(string $name, array $spec, string $path, string $context): Block
|
||||
{
|
||||
$short = ModuleCatalog::shortName($name);
|
||||
$fields = array_keys(ShortformMap::fields($short));
|
||||
$hasItems = $this->catalog->childrenOf($name) !== [];
|
||||
$allowed = array_merge(
|
||||
self::COMMON,
|
||||
$fields,
|
||||
$hasItems ? ['items'] : [],
|
||||
$name === 'divi/group' ? ['modules'] : []
|
||||
);
|
||||
$this->unknownKeys($spec, $allowed, $path);
|
||||
|
||||
// "type" and "label" of a node are its module type and admin label; the short-form fields
|
||||
// of the same name (contact-field type, social network label) go through lit-divi-update "set".
|
||||
$values = array_intersect_key($spec, array_flip(array_diff($fields, self::COMMON)));
|
||||
if ($name === 'divi/heading' && ! array_key_exists('level', $values)) {
|
||||
$values['level'] = 'h2';
|
||||
}
|
||||
|
||||
$attrs = ['builderVersion' => $this->builderVersion];
|
||||
if ($values !== []) {
|
||||
$result = $this->shortform->apply($short, $attrs, $values, $path);
|
||||
$attrs = $result['attrs'];
|
||||
$this->errors += $result['errors'];
|
||||
}
|
||||
|
||||
$block = Block::create($name, $this->common($name, $attrs, $spec, $path, $this->autoLabel($name, $context)));
|
||||
if ($hasItems) {
|
||||
$this->children($block, $spec['items'] ?? [], $path . '.items', $context);
|
||||
} elseif ($name === 'divi/group') {
|
||||
$this->children($block, $spec['modules'] ?? [], $path . '.modules', $context);
|
||||
}
|
||||
|
||||
return $block;
|
||||
}
|
||||
|
||||
/**
|
||||
* Preset, full-form attrs and admin label of a new block. The label is $spec's "label"
|
||||
* when given ("" = none), else $autoLabel.
|
||||
*
|
||||
* @param array<string, mixed> $attrs
|
||||
* @param array<array-key, mixed> $spec
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
private function common(string $name, array $attrs, array $spec, string $path, ?string $autoLabel): array
|
||||
{
|
||||
$attrs = $this->presetAndAttrs($name, $attrs, $spec, $path);
|
||||
$label = array_key_exists('label', $spec) && $spec['label'] !== null ? $spec['label'] : $autoLabel;
|
||||
if ($label === null || $label === '') {
|
||||
return $attrs;
|
||||
}
|
||||
|
||||
return $this->label($name, $attrs, $label, $path . '.label');
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, mixed> $attrs
|
||||
* @param array<array-key, mixed> $spec
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
private function presetAndAttrs(string $name, array $attrs, array $spec, string $path): array
|
||||
{
|
||||
if (array_key_exists('preset', $spec)) {
|
||||
$attrs = $this->preset($name, $attrs, $spec['preset'], $path . '.preset');
|
||||
}
|
||||
|
||||
if (! array_key_exists('attrs', $spec)) {
|
||||
return $attrs;
|
||||
}
|
||||
|
||||
if (! is_array($spec['attrs']) || array_is_list($spec['attrs'])) {
|
||||
$this->errors[$path . '.attrs'] = 'Objekt "Attributpfad": {Breakpoint: Wert} erwartet';
|
||||
|
||||
return $attrs;
|
||||
}
|
||||
|
||||
$result = $this->attrWriter->apply($name, $attrs, $spec['attrs'], $path . '.attrs');
|
||||
$this->errors += $result['errors'];
|
||||
array_push($this->invalidPaths, ...$result['invalid_paths']);
|
||||
|
||||
return $result['attrs'];
|
||||
}
|
||||
|
||||
/**
|
||||
* The admin label, cleaned as text at the choke point (ruling S13): a label that fails there,
|
||||
* or that still carries a reference, is an error and nothing is written.
|
||||
*
|
||||
* @param array<string, mixed> $attrs
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
private function label(string $name, array $attrs, mixed $label, string $path): array
|
||||
{
|
||||
if (! is_string($label)) {
|
||||
$this->errors[$path] = 'Text erwartet';
|
||||
|
||||
return $attrs;
|
||||
}
|
||||
|
||||
try {
|
||||
$clean = $this->attrWriter->cleanValue($name, self::LABEL_PATH, $label, null, 'text');
|
||||
} catch (InvalidArgumentException $e) {
|
||||
$this->errors[$path] = $e->getMessage();
|
||||
|
||||
return $attrs;
|
||||
}
|
||||
|
||||
if (! is_string($clean) || VariableRef::contains($clean)) {
|
||||
$this->errors[$path] = 'Beschriftung: nur Text, keine Divi-Verweise oder Platzhalter';
|
||||
|
||||
return $attrs;
|
||||
}
|
||||
|
||||
return $clean === '' ? $attrs : AttrMap::set($attrs, self::LABEL_PATH, ['desktop' => ['value' => $clean]]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, mixed> $attrs
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
private function preset(string $name, array $attrs, mixed $preset, string $path): array
|
||||
{
|
||||
if ($preset === null || $preset === '') {
|
||||
unset($attrs['modulePreset']);
|
||||
|
||||
return $attrs;
|
||||
}
|
||||
|
||||
$id = is_string($preset) ? $this->presetId($name, $preset, $path) : null;
|
||||
if ($id === null) {
|
||||
if (! isset($this->errors[$path])) {
|
||||
$names = $this->design->modulePresetNames($name);
|
||||
$this->errors[$path] = sprintf(
|
||||
'unbekanntes Preset; vorhanden für %s: %s',
|
||||
$name,
|
||||
$names === [] ? '(keine)' : implode(', ', $names)
|
||||
);
|
||||
}
|
||||
|
||||
return $attrs;
|
||||
}
|
||||
|
||||
// Design-system data, but still through the choke point: an id text() would change is refused.
|
||||
try {
|
||||
$clean = $this->attrWriter->cleanValue($name, 'modulePreset', $id, null, 'text');
|
||||
} catch (InvalidArgumentException $e) {
|
||||
$clean = null;
|
||||
}
|
||||
|
||||
if ($clean !== $id) {
|
||||
$this->errors[$path] = sprintf('Preset-ID "%s" ist ungültig', $id);
|
||||
|
||||
return $attrs;
|
||||
}
|
||||
|
||||
$attrs['modulePreset'] = [$id];
|
||||
|
||||
return $attrs;
|
||||
}
|
||||
|
||||
/**
|
||||
* Module preset id by id, else by name (case-insensitive); a name several presets of the
|
||||
* module share is an error listing their ids (ruling S13a). Null when unknown or ambiguous.
|
||||
*/
|
||||
private function presetId(string $name, string $preset, string $path): ?string
|
||||
{
|
||||
$wanted = trim($preset);
|
||||
$key = mb_strtolower($wanted);
|
||||
$ids = [];
|
||||
foreach ($this->design->presets() as $entry) {
|
||||
if ($entry['kind'] !== 'module' || $entry['module'] !== $name) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($entry['id'] === $wanted) {
|
||||
return $entry['id'];
|
||||
}
|
||||
|
||||
if (mb_strtolower($entry['name']) === $key) {
|
||||
$ids[] = $entry['id'];
|
||||
}
|
||||
}
|
||||
|
||||
if (count($ids) > 1) {
|
||||
$this->errors[$path] = sprintf(
|
||||
'Preset-Name "%s" ist mehrdeutig; bitte die ID angeben: %s.',
|
||||
$wanted,
|
||||
implode(', ', $ids)
|
||||
);
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
return $ids[0] ?? null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Ruling S13: the short-form color check (ShortformWriter::color()), never text().
|
||||
*
|
||||
* @param array<string, mixed> $attrs
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
private function backgroundColor(array $attrs, mixed $color, string $path): array
|
||||
{
|
||||
try {
|
||||
$clean = $this->shortform->color('divi/section', 'module.decoration.background', $color, 'color');
|
||||
} catch (InvalidArgumentException $e) {
|
||||
$this->errors[$path] = $e->getMessage();
|
||||
|
||||
return $attrs;
|
||||
}
|
||||
|
||||
return AttrMap::set($attrs, 'module.decoration.background', ['desktop' => ['value' => ['color' => $clean]]]);
|
||||
}
|
||||
|
||||
private function children(Block $parent, mixed $specs, string $path, string $context): void
|
||||
{
|
||||
if (! is_array($specs) || ($specs !== [] && ! array_is_list($specs))) {
|
||||
$this->errors[$path] = 'Liste erwartet';
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
foreach ($specs as $position => $spec) {
|
||||
$child = $this->node($spec, $parent, sprintf('%s[%d]', $path, $position), $context);
|
||||
if ($child !== null) {
|
||||
$parent->insertChild(PHP_INT_MAX, $child);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* "1_3,2_3" → flexTypes ["8_24", "16_24"]; the fractions must add up to one row.
|
||||
*
|
||||
* @return list<string>
|
||||
*/
|
||||
private function widths(mixed $columns, string $path): array
|
||||
{
|
||||
$parts = is_string($columns) ? array_map('trim', explode(',', $columns)) : [];
|
||||
$widths = [];
|
||||
$sum = 0.0;
|
||||
foreach ($parts as $part) {
|
||||
$valid = preg_match('/^(\d{1,2})_(\d{1,2})$/D', $part, $match) === 1
|
||||
&& (int) $match[1] >= 1
|
||||
&& (int) $match[1] <= (int) $match[2];
|
||||
if (! $valid) {
|
||||
$this->errors[$path] = 'Spaltenaufteilung wie "1_2,1_2" oder "1_3,2_3" erwartet';
|
||||
|
||||
return ['24_24'];
|
||||
}
|
||||
|
||||
[$numerator, $denominator] = [(int) $match[1], (int) $match[2]];
|
||||
if (24 % $denominator === 0) {
|
||||
$widths[] = ($numerator * 24 / $denominator) . '_24';
|
||||
} elseif (in_array($part, self::SPECIAL_WIDTHS, true)) {
|
||||
$widths[] = $part;
|
||||
} else {
|
||||
$this->errors[$path] = sprintf('Spaltenbreite %s gibt es in Divi nicht', $part);
|
||||
|
||||
return ['24_24'];
|
||||
}
|
||||
$sum += $numerator / $denominator;
|
||||
}
|
||||
|
||||
if ($widths === [] || abs($sum - 1.0) > 0.01) {
|
||||
$this->errors[$path] = 'die Spaltenbreiten müssen zusammen eine volle Zeile ergeben (z. B. "1_3,2_3")';
|
||||
|
||||
return ['24_24'];
|
||||
}
|
||||
|
||||
return $widths;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<array-key, mixed> $spec
|
||||
* @param list<string> $allowed
|
||||
*/
|
||||
private function unknownKeys(array $spec, array $allowed, string $path): void
|
||||
{
|
||||
foreach (array_diff(array_map('strval', array_keys($spec)), $allowed) as $key) {
|
||||
$this->errors[$path . '.' . $key] = 'unbekanntes Feld; erlaubt: ' . implode(', ', $allowed);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -25,9 +25,6 @@ final class ShortformWriter
|
||||
|
||||
private const COLOR_ERROR = 'Farbe erwartet, z. B. {{color:primary}} oder #1a1a1a';
|
||||
|
||||
/** Prefix of every color reference VariableRef::serialize() writes (fixed key order). */
|
||||
private const COLOR_REFERENCE = '$variable({"type":"color",';
|
||||
|
||||
/** Curated kind => sanitizer kind of AttrWriter::cleanValue(). */
|
||||
private const CLEAN_KIND = ['html' => 'html', 'code' => 'code', 'url' => 'url', 'text' => 'text'];
|
||||
|
||||
@@ -89,7 +86,7 @@ final class ShortformWriter
|
||||
$value = trim($this->placeholders->resolve($value));
|
||||
if (VariableRef::contains($value)) {
|
||||
$reference = $this->attrs->cleanValue($module, $path, $value, $subKey, 'text');
|
||||
if (! is_string($reference) || ! str_starts_with($reference, self::COLOR_REFERENCE)) {
|
||||
if (! is_string($reference) || VariableRef::typeOf($reference) !== 'color') {
|
||||
throw new InvalidArgumentException(self::COLOR_ERROR);
|
||||
}
|
||||
|
||||
@@ -166,14 +163,33 @@ final class ShortformWriter
|
||||
$attrs = AttrMap::set($attrs, $base . $idKey, (string) $id);
|
||||
}
|
||||
|
||||
if ($altKey !== null && $withAlt && $image['alt'] !== '') {
|
||||
$alt = $this->attrs->cleanValue($module, $path, $image['alt'], $altKey, 'text');
|
||||
$attrs = AttrMap::set($attrs, $base . $altKey, $alt);
|
||||
$alt = $altKey !== null && $withAlt ? $this->alt($module, $path, $image['alt'], $altKey) : '';
|
||||
if ($alt !== '') {
|
||||
$attrs = AttrMap::set($attrs, $base . (string) $altKey, $alt);
|
||||
}
|
||||
|
||||
return $attrs;
|
||||
}
|
||||
|
||||
/**
|
||||
* The attachment's alt text, cleaned as text – or '' (no alt) when it carries a reference,
|
||||
* whole or rebuilt by cleaning (ruling S33b): library data never becomes dynamic content.
|
||||
*/
|
||||
private function alt(string $module, string $path, string $alt, string $altKey): string
|
||||
{
|
||||
if ($alt === '' || VariableRef::contains($alt)) {
|
||||
return '';
|
||||
}
|
||||
|
||||
try {
|
||||
$clean = $this->attrs->cleanValue($module, $path, $alt, $altKey, 'text');
|
||||
} catch (InvalidArgumentException) {
|
||||
return '';
|
||||
}
|
||||
|
||||
return is_string($clean) ? $clean : '';
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, mixed> $spec
|
||||
* @throws InvalidArgumentException
|
||||
|
||||
@@ -0,0 +1,89 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace LIT\MCP\Integrations\Divi\Compose;
|
||||
|
||||
use LIT\MCP\Integrations\Divi\BlockTree\AttrMap;
|
||||
use LIT\MCP\Integrations\Divi\BlockTree\Block;
|
||||
use LIT\MCP\Integrations\Divi\Schema\ModuleCatalog;
|
||||
|
||||
/**
|
||||
* Which node may sit where (spec §5.4 "Struktur"): page → sections; regular section → rows;
|
||||
* fullwidth section → fullwidth modules; column/group → modules; parent module → its child
|
||||
* modules (catalog). Columns only come with their row; specialty sections and read-only
|
||||
* nodes (opaque, non-Divi) are not rebuilt. Pure PHP.
|
||||
*/
|
||||
final class StructureRules
|
||||
{
|
||||
private const COLUMNS = ['divi/column', 'divi/column-inner'];
|
||||
private const ROWS = ['divi/row', 'divi/row-inner'];
|
||||
private const FULLWIDTH = 'divi/fullwidth-';
|
||||
|
||||
public function __construct(private ModuleCatalog $catalog)
|
||||
{
|
||||
}
|
||||
|
||||
/** Null when $child may be placed into $parent (null = top level of the page), else the German reason. */
|
||||
public function violation(?Block $parent, string $child): ?string
|
||||
{
|
||||
if (! $this->catalog->has($child)) {
|
||||
return sprintf('unbekanntes Modul "%s" (siehe lit-divi-catalog)', $child);
|
||||
}
|
||||
|
||||
if ($parent === null) {
|
||||
return $child === 'divi/section' ? null : 'auf oberster Ebene sind nur Abschnitte (section) erlaubt';
|
||||
}
|
||||
|
||||
if (! $parent->isDivi() || $parent->isOpaque()) {
|
||||
return 'der Zielknoten ist nur lesbar (globales Modul oder fremder Block)';
|
||||
}
|
||||
|
||||
$parentName = $parent->name();
|
||||
if ($parentName === 'divi/section') {
|
||||
return $this->inSection($parent, $child);
|
||||
}
|
||||
|
||||
if (in_array($parentName, self::ROWS, true)) {
|
||||
return 'Spalten entstehen mit der Zeile ("columns"); eine neue Zeile mit der gewünschten Aufteilung '
|
||||
. 'einfügen';
|
||||
}
|
||||
|
||||
if (in_array($parentName, self::COLUMNS, true) || $parentName === 'divi/group') {
|
||||
return $this->isPlainModule($child) || $child === 'divi/group'
|
||||
? null
|
||||
: sprintf('%s passt nicht in eine Spalte', $child);
|
||||
}
|
||||
|
||||
$children = $this->catalog->childrenOf($parentName);
|
||||
if ($children === []) {
|
||||
return sprintf('%s kann keine Kind-Module enthalten', $parentName);
|
||||
}
|
||||
|
||||
return in_array($child, $children, true)
|
||||
? null
|
||||
: sprintf('%s erlaubt nur %s als Kind', $parentName, implode(', ', $children));
|
||||
}
|
||||
|
||||
/** A module that goes into a column: category "module", not a fullwidth module. */
|
||||
public function isPlainModule(string $name): bool
|
||||
{
|
||||
return $this->catalog->category($name) === 'module' && ! str_starts_with($name, self::FULLWIDTH);
|
||||
}
|
||||
|
||||
private function inSection(Block $section, string $child): ?string
|
||||
{
|
||||
$type = AttrMap::desktop($section->attrs(), 'module.advanced.type');
|
||||
if ($type === 'specialty') {
|
||||
return 'Spezialabschnitte (specialty) nur im Divi-Builder umbauen; Module in ihre Spalten einfügen';
|
||||
}
|
||||
|
||||
if ($type === 'fullwidth') {
|
||||
return str_starts_with($child, self::FULLWIDTH)
|
||||
? null
|
||||
: 'in einen Vollbreite-Abschnitt passen nur fullwidth-Module';
|
||||
}
|
||||
|
||||
return $child === 'divi/row' ? null : 'ein Abschnitt enthält Zeilen (row)';
|
||||
}
|
||||
}
|
||||
@@ -115,6 +115,36 @@ final class VariableRef
|
||||
return str_contains($value, self::MARKER);
|
||||
}
|
||||
|
||||
/**
|
||||
* Type ("color" or "content") of $value when it is exactly one reference whose payload
|
||||
* names that type; null otherwise. Reads the payload, never a string prefix (ruling S33c);
|
||||
* it does not validate the reference – that is canonical()'s job.
|
||||
*/
|
||||
public static function typeOf(string $value): ?string
|
||||
{
|
||||
if (preg_match(self::WHOLE, $value, $match) !== 1 || str_contains($match[1], ')$')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
try {
|
||||
$type = self::decode($match[1])['type'] ?? null;
|
||||
} catch (InvalidArgumentException) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return $type === 'color' || $type === 'content' ? $type : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes C0 control characters except tab, LF and CR, and DEL (ruling S32). The WordPress
|
||||
* sanitizers keep them (sanitize_text_field keeps NUL), and "$variable\0(" would otherwise
|
||||
* hide a marker from the final-string check that a later strip anywhere could rebuild.
|
||||
*/
|
||||
public static function withoutControls(string $value): string
|
||||
{
|
||||
return (string) preg_replace('/[\x00-\x08\x0B\x0C\x0E-\x1F\x7F]/', '', $value);
|
||||
}
|
||||
|
||||
/** @param array<string, mixed>|stdClass $settings */
|
||||
public static function serialize(string $type, string $name, array|stdClass $settings): string
|
||||
{
|
||||
@@ -336,7 +366,11 @@ final class VariableRef
|
||||
$clean = is_string($value) ? $sanitizer->text($value) : $value;
|
||||
}
|
||||
|
||||
// Ruling S28: sanitizing may rebuild a marker ("$variable<x>(" → "$variable(").
|
||||
// Ruling S28: sanitizing may rebuild a marker ("$variable<x>(" → "$variable("); control
|
||||
// characters go first so a NUL-split marker is rebuilt – and caught – here (S32).
|
||||
if (is_string($clean)) {
|
||||
$clean = self::withoutControls($clean);
|
||||
}
|
||||
if (is_string($clean) && (self::contains($clean) || str_contains($clean, ')$'))) {
|
||||
throw self::notAlone();
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user