Style anpassungen für die Dokumentationsseite und die Produktseite. Hinzufügen eines Feeds für Produktaktualisierungen. Aktualisierung der Router- und Suchcontroller-Logik, um die neuen Seiten zu unterstützen. Anpassung der Admin-Einstellungen für die Dokumentationsseite.
This commit is contained in:
@@ -38,6 +38,22 @@ final class SettingsPage
|
||||
$settings['design_accent_color'] = self::sanitizeHexColor((string) ($input['design_accent_color'] ?? '#F59C00'), '#F59C00');
|
||||
$settings['design_radius'] = (string) max(0, min(32, (int) ($input['design_radius'] ?? 14)));
|
||||
$settings['custom_theme_css_url'] = esc_url_raw((string) ($input['custom_theme_css_url'] ?? ''));
|
||||
$settings['docs_home_intro_title'] = sanitize_text_field((string) ($input['docs_home_intro_title'] ?? $settings['docs_home_intro_title']));
|
||||
$settings['docs_home_intro_content'] = wp_kses_post((string) ($input['docs_home_intro_content'] ?? $settings['docs_home_intro_content']));
|
||||
$settings['product_updates_source'] = in_array(($input['product_updates_source'] ?? 'rss'), ['rss', 'rest'], true) ? (string) $input['product_updates_source'] : 'rss';
|
||||
$settings['product_updates_feed_url'] = esc_url_raw((string) ($input['product_updates_feed_url'] ?? ''));
|
||||
$settings['product_updates_feed_limit'] = (string) max(1, min(20, (int) ($input['product_updates_feed_limit'] ?? 5)));
|
||||
$settings['product_updates_feed_item_path'] = self::sanitizeXmlPath((string) ($input['product_updates_feed_item_path'] ?? 'channel/item'), 'channel/item');
|
||||
$settings['product_updates_feed_product_field'] = self::sanitizeXmlPath((string) ($input['product_updates_feed_product_field'] ?? 'title'), 'title');
|
||||
$settings['product_updates_feed_version_field'] = self::sanitizeXmlPath((string) ($input['product_updates_feed_version_field'] ?? 'category'), 'category');
|
||||
$settings['product_updates_feed_date_field'] = self::sanitizeXmlPath((string) ($input['product_updates_feed_date_field'] ?? 'pubDate'), 'pubDate');
|
||||
$settings['product_updates_feed_changelog_field'] = self::sanitizeXmlPath((string) ($input['product_updates_feed_changelog_field'] ?? 'description'), 'description');
|
||||
$settings['product_updates_rest_url'] = esc_url_raw((string) ($input['product_updates_rest_url'] ?? ''));
|
||||
$settings['product_updates_rest_list_path'] = self::sanitizePathList((string) ($input['product_updates_rest_list_path'] ?? 'content,data,items'), 'content,data,items');
|
||||
$settings['product_updates_rest_product_field'] = self::sanitizePathList((string) ($input['product_updates_rest_product_field'] ?? 'product.name,productName,name'), 'product.name,productName,name');
|
||||
$settings['product_updates_rest_version_field'] = self::sanitizePathList((string) ($input['product_updates_rest_version_field'] ?? 'version,versionName,name'), 'version,versionName,name');
|
||||
$settings['product_updates_rest_date_field'] = self::sanitizePathList((string) ($input['product_updates_rest_date_field'] ?? 'releaseDate,date,updatedAt,createdAt'), 'releaseDate,date,updatedAt,createdAt');
|
||||
$settings['product_updates_rest_changelog_field'] = self::sanitizePathList((string) ($input['product_updates_rest_changelog_field'] ?? 'changelog,changeLog,description,changes'), 'changelog,changeLog,description,changes');
|
||||
|
||||
Plugin::syncCronSchedule($settings);
|
||||
if (($old['docs_base_slug'] ?? 'docs') !== $settings['docs_base_slug']) {
|
||||
@@ -57,6 +73,11 @@ final class SettingsPage
|
||||
self::handleConnectionTest();
|
||||
}
|
||||
|
||||
$updatesTest = null;
|
||||
if (isset($_POST['kb_markdown_test_product_updates']) && check_admin_referer('kb_markdown_test_product_updates')) {
|
||||
$updatesTest = self::handleProductUpdatesTest();
|
||||
}
|
||||
|
||||
$settings = Plugin::settings();
|
||||
?>
|
||||
<div class="wrap">
|
||||
@@ -113,6 +134,116 @@ final class SettingsPage
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><?php esc_html_e('Dokumentations-Startseite', 'kb-markdown-importer'); ?></h2>
|
||||
<table class="form-table" role="presentation">
|
||||
<tr>
|
||||
<th scope="row"><label for="docs_home_intro_title"><?php esc_html_e('Anleitungs-Titel', 'kb-markdown-importer'); ?></label></th>
|
||||
<td><input class="regular-text" id="docs_home_intro_title" name="kb_markdown_importer_settings[docs_home_intro_title]" type="text" value="<?php echo esc_attr($settings['docs_home_intro_title']); ?>"></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th scope="row"><label for="docs_home_intro_content"><?php esc_html_e('Anleitungstext', 'kb-markdown-importer'); ?></label></th>
|
||||
<td>
|
||||
<?php
|
||||
wp_editor((string) $settings['docs_home_intro_content'], 'docs_home_intro_content', [
|
||||
'textarea_name' => 'kb_markdown_importer_settings[docs_home_intro_content]',
|
||||
'textarea_rows' => 7,
|
||||
'media_buttons' => false,
|
||||
'teeny' => true,
|
||||
]);
|
||||
?>
|
||||
<p class="description"><?php esc_html_e('Dieser Text erscheint oben auf der Dokumentations-Startseite.', 'kb-markdown-importer'); ?></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th scope="row"><label for="product_updates_source"><?php esc_html_e('Update-Quelle', 'kb-markdown-importer'); ?></label></th>
|
||||
<td>
|
||||
<select id="product_updates_source" name="kb_markdown_importer_settings[product_updates_source]">
|
||||
<option value="rss" <?php selected($settings['product_updates_source'], 'rss'); ?>><?php esc_html_e('RSS/XML', 'kb-markdown-importer'); ?></option>
|
||||
<option value="rest" <?php selected($settings['product_updates_source'], 'rest'); ?>><?php esc_html_e('REST/JSON', 'kb-markdown-importer'); ?></option>
|
||||
</select>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th scope="row"><label for="product_updates_feed_url"><?php esc_html_e('RSS/XML-Feed URL', 'kb-markdown-importer'); ?></label></th>
|
||||
<td>
|
||||
<input class="regular-text" id="product_updates_feed_url" name="kb_markdown_importer_settings[product_updates_feed_url]" type="url" value="<?php echo esc_attr($settings['product_updates_feed_url']); ?>" placeholder="https://example.com/updates.xml">
|
||||
<p class="description"><?php esc_html_e('RSS- oder XML-Feed mit den neuesten Produktupdates. Wird nur genutzt, wenn RSS/XML als Quelle ausgewählt ist.', 'kb-markdown-importer'); ?></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th scope="row"><label for="product_updates_rest_url"><?php esc_html_e('REST/JSON URL', 'kb-markdown-importer'); ?></label></th>
|
||||
<td>
|
||||
<input class="regular-text" id="product_updates_rest_url" name="kb_markdown_importer_settings[product_updates_rest_url]" type="url" value="<?php echo esc_attr($settings['product_updates_rest_url']); ?>" placeholder="https://example.com/api/product-versions">
|
||||
<p class="description"><?php esc_html_e('REST-Endpunkt mit JSON-Antwort. Wird nur genutzt, wenn REST/JSON als Quelle ausgewählt ist.', 'kb-markdown-importer'); ?></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th scope="row"><label for="product_updates_feed_limit"><?php esc_html_e('Anzahl Updates', 'kb-markdown-importer'); ?></label></th>
|
||||
<td><input id="product_updates_feed_limit" name="kb_markdown_importer_settings[product_updates_feed_limit]" type="number" min="1" max="20" value="<?php echo esc_attr($settings['product_updates_feed_limit']); ?>"></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th scope="row"><label for="product_updates_feed_item_path"><?php esc_html_e('Eintrag-Pfad', 'kb-markdown-importer'); ?></label></th>
|
||||
<td>
|
||||
<input class="regular-text" id="product_updates_feed_item_path" name="kb_markdown_importer_settings[product_updates_feed_item_path]" type="text" value="<?php echo esc_attr($settings['product_updates_feed_item_path']); ?>" placeholder="channel/item">
|
||||
<p class="description"><?php esc_html_e('Pfad zum wiederholten Feed-Eintrag, zum Beispiel channel/item.', 'kb-markdown-importer'); ?></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th scope="row"><label for="product_updates_rest_list_path"><?php esc_html_e('REST Listenpfad', 'kb-markdown-importer'); ?></label></th>
|
||||
<td>
|
||||
<input class="regular-text" id="product_updates_rest_list_path" name="kb_markdown_importer_settings[product_updates_rest_list_path]" type="text" value="<?php echo esc_attr($settings['product_updates_rest_list_path']); ?>" placeholder="content,data,items">
|
||||
<p class="description"><?php esc_html_e('Pfad zur Liste in der JSON-Antwort. Mehrere Alternativen mit Komma trennen. Leer lassen, wenn die Antwort direkt ein Array ist.', 'kb-markdown-importer'); ?></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th scope="row"><?php esc_html_e('XML-Felder', 'kb-markdown-importer'); ?></th>
|
||||
<td>
|
||||
<fieldset class="kb-feed-fields">
|
||||
<p>
|
||||
<label for="product_updates_feed_product_field"><?php esc_html_e('Produktname', 'kb-markdown-importer'); ?></label><br>
|
||||
<input class="regular-text" id="product_updates_feed_product_field" name="kb_markdown_importer_settings[product_updates_feed_product_field]" type="text" value="<?php echo esc_attr($settings['product_updates_feed_product_field']); ?>" placeholder="title">
|
||||
</p>
|
||||
<p>
|
||||
<label for="product_updates_feed_version_field"><?php esc_html_e('Version', 'kb-markdown-importer'); ?></label><br>
|
||||
<input class="regular-text" id="product_updates_feed_version_field" name="kb_markdown_importer_settings[product_updates_feed_version_field]" type="text" value="<?php echo esc_attr($settings['product_updates_feed_version_field']); ?>" placeholder="category">
|
||||
</p>
|
||||
<p>
|
||||
<label for="product_updates_feed_date_field"><?php esc_html_e('Datum', 'kb-markdown-importer'); ?></label><br>
|
||||
<input class="regular-text" id="product_updates_feed_date_field" name="kb_markdown_importer_settings[product_updates_feed_date_field]" type="text" value="<?php echo esc_attr($settings['product_updates_feed_date_field']); ?>" placeholder="pubDate">
|
||||
</p>
|
||||
<p>
|
||||
<label for="product_updates_feed_changelog_field"><?php esc_html_e('Changelog', 'kb-markdown-importer'); ?></label><br>
|
||||
<input class="regular-text" id="product_updates_feed_changelog_field" name="kb_markdown_importer_settings[product_updates_feed_changelog_field]" type="text" value="<?php echo esc_attr($settings['product_updates_feed_changelog_field']); ?>" placeholder="description">
|
||||
</p>
|
||||
</fieldset>
|
||||
<p class="description"><?php esc_html_e('Feldpfade relativ zum Eintrag, zum Beispiel product/name, version oder changelog. Namespaces wie dc:date werden unterstützt.', 'kb-markdown-importer'); ?></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th scope="row"><?php esc_html_e('REST-Felder', 'kb-markdown-importer'); ?></th>
|
||||
<td>
|
||||
<fieldset class="kb-rest-fields">
|
||||
<p>
|
||||
<label for="product_updates_rest_product_field"><?php esc_html_e('Produktname', 'kb-markdown-importer'); ?></label><br>
|
||||
<input class="regular-text" id="product_updates_rest_product_field" name="kb_markdown_importer_settings[product_updates_rest_product_field]" type="text" value="<?php echo esc_attr($settings['product_updates_rest_product_field']); ?>" placeholder="product.name,productName,name">
|
||||
</p>
|
||||
<p>
|
||||
<label for="product_updates_rest_version_field"><?php esc_html_e('Version', 'kb-markdown-importer'); ?></label><br>
|
||||
<input class="regular-text" id="product_updates_rest_version_field" name="kb_markdown_importer_settings[product_updates_rest_version_field]" type="text" value="<?php echo esc_attr($settings['product_updates_rest_version_field']); ?>" placeholder="version,versionName,name">
|
||||
</p>
|
||||
<p>
|
||||
<label for="product_updates_rest_date_field"><?php esc_html_e('Datum', 'kb-markdown-importer'); ?></label><br>
|
||||
<input class="regular-text" id="product_updates_rest_date_field" name="kb_markdown_importer_settings[product_updates_rest_date_field]" type="text" value="<?php echo esc_attr($settings['product_updates_rest_date_field']); ?>" placeholder="releaseDate,date,updatedAt,createdAt">
|
||||
</p>
|
||||
<p>
|
||||
<label for="product_updates_rest_changelog_field"><?php esc_html_e('Changelog', 'kb-markdown-importer'); ?></label><br>
|
||||
<input class="regular-text" id="product_updates_rest_changelog_field" name="kb_markdown_importer_settings[product_updates_rest_changelog_field]" type="text" value="<?php echo esc_attr($settings['product_updates_rest_changelog_field']); ?>" placeholder="changelog,changeLog,description,changes">
|
||||
</p>
|
||||
</fieldset>
|
||||
<p class="description"><?php esc_html_e('JSON-Feldpfade relativ zu einem Eintrag. Verschachtelte Felder mit Punkt oder Slash angeben, Alternativen mit Komma trennen.', 'kb-markdown-importer'); ?></p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><?php esc_html_e('Frontend Design', 'kb-markdown-importer'); ?></h2>
|
||||
<table class="form-table" role="presentation">
|
||||
<tr>
|
||||
@@ -154,6 +285,21 @@ final class SettingsPage
|
||||
<?php wp_nonce_field('kb_markdown_test_connection'); ?>
|
||||
<?php submit_button(__('Test GitLab Connection', 'kb-markdown-importer'), 'secondary', 'kb_markdown_test_connection'); ?>
|
||||
</form>
|
||||
<form method="post">
|
||||
<?php wp_nonce_field('kb_markdown_test_product_updates'); ?>
|
||||
<?php submit_button(__('Produktupdate-Quelle testen', 'kb-markdown-importer'), 'secondary', 'kb_markdown_test_product_updates'); ?>
|
||||
<p class="description"><?php esc_html_e('Der Test nutzt die gespeicherten Einstellungen der ausgewählten Update-Quelle. Bitte Änderungen vorher speichern.', 'kb-markdown-importer'); ?></p>
|
||||
</form>
|
||||
<?php if (is_array($updatesTest)) : ?>
|
||||
<div class="notice notice-<?php echo $updatesTest['ok'] ? 'success' : 'error'; ?>">
|
||||
<p><strong><?php echo esc_html($updatesTest['title']); ?></strong></p>
|
||||
<p><?php echo esc_html($updatesTest['message']); ?></p>
|
||||
</div>
|
||||
<?php if ('' !== $updatesTest['body']) : ?>
|
||||
<h2><?php esc_html_e('Antwort der Produktupdate-Quelle', 'kb-markdown-importer'); ?></h2>
|
||||
<textarea class="large-text code" rows="16" readonly><?php echo esc_textarea($updatesTest['body']); ?></textarea>
|
||||
<?php endif; ?>
|
||||
<?php endif; ?>
|
||||
</div>
|
||||
<?php
|
||||
}
|
||||
@@ -176,6 +322,78 @@ final class SettingsPage
|
||||
settings_errors('kb_markdown_importer');
|
||||
}
|
||||
|
||||
private static function handleProductUpdatesTest(): array
|
||||
{
|
||||
$settings = Plugin::settings();
|
||||
$source = (string) ($settings['product_updates_source'] ?? 'rss');
|
||||
$url = esc_url_raw((string) ('rest' === $source ? ($settings['product_updates_rest_url'] ?? '') : ($settings['product_updates_feed_url'] ?? '')));
|
||||
|
||||
if ('' === $url) {
|
||||
return [
|
||||
'ok' => false,
|
||||
'title' => __('Keine Produktupdate-Quelle konfiguriert.', 'kb-markdown-importer'),
|
||||
'message' => __('Bitte zuerst eine RSS/XML- oder REST/JSON-URL speichern.', 'kb-markdown-importer'),
|
||||
'body' => '',
|
||||
];
|
||||
}
|
||||
|
||||
$response = wp_remote_get($url, [
|
||||
'timeout' => 12,
|
||||
'redirection' => 3,
|
||||
'user-agent' => 'KB Markdown Importer/' . KB_MARKDOWN_IMPORTER_VERSION,
|
||||
]);
|
||||
|
||||
if (is_wp_error($response)) {
|
||||
return [
|
||||
'ok' => false,
|
||||
'title' => __('Produktupdate-Quelle nicht erreichbar.', 'kb-markdown-importer'),
|
||||
'message' => $response->get_error_message(),
|
||||
'body' => '',
|
||||
];
|
||||
}
|
||||
|
||||
$status = (int) wp_remote_retrieve_response_code($response);
|
||||
$contentType = (string) wp_remote_retrieve_header($response, 'content-type');
|
||||
$body = (string) wp_remote_retrieve_body($response);
|
||||
$excerpt = substr($body, 0, 12000);
|
||||
$validPayload = true;
|
||||
$payloadNote = '';
|
||||
|
||||
if ('rest' === $source) {
|
||||
json_decode($body, true);
|
||||
$validPayload = JSON_ERROR_NONE === json_last_error();
|
||||
if (! $validPayload) {
|
||||
$payloadNote = ' ' . sprintf(
|
||||
/* translators: %s: JSON parser error message. */
|
||||
__('Die Antwort ist kein gültiges JSON: %s', 'kb-markdown-importer'),
|
||||
json_last_error_msg()
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
$message = sprintf(
|
||||
/* translators: 1: source type, 2: HTTP status code, 3: content type. */
|
||||
__('Quelle: %1$s | HTTP-Status: %2$d | Content-Type: %3$s', 'kb-markdown-importer'),
|
||||
'rest' === $source ? 'REST/JSON' : 'RSS/XML',
|
||||
$status,
|
||||
$contentType ?: '-'
|
||||
);
|
||||
$message .= $payloadNote;
|
||||
|
||||
if (strlen($body) > strlen($excerpt)) {
|
||||
$message .= ' ' . __('Die Antwort wurde auf 12000 Zeichen gekürzt.', 'kb-markdown-importer');
|
||||
}
|
||||
|
||||
$ok = $status >= 200 && $status < 300 && $validPayload;
|
||||
|
||||
return [
|
||||
'ok' => $ok,
|
||||
'title' => $ok ? __('Produktupdate-Quelle erreichbar.', 'kb-markdown-importer') : __('Produktupdate-Quelle nicht nutzbar.', 'kb-markdown-importer'),
|
||||
'message' => $message,
|
||||
'body' => $excerpt,
|
||||
];
|
||||
}
|
||||
|
||||
private static function formatConnectionError(\WP_Error $error): string
|
||||
{
|
||||
$message = $error->get_error_message();
|
||||
@@ -206,4 +424,20 @@ final class SettingsPage
|
||||
|
||||
return preg_match('/^#[0-9a-fA-F]{6}$/', $value) ? strtoupper($value) : $fallback;
|
||||
}
|
||||
|
||||
private static function sanitizeXmlPath(string $value, string $fallback): string
|
||||
{
|
||||
$value = trim($value);
|
||||
$value = preg_replace('/[^A-Za-z0-9_:@.\/-]/', '', $value) ?: '';
|
||||
|
||||
return '' !== $value ? $value : $fallback;
|
||||
}
|
||||
|
||||
private static function sanitizePathList(string $value, string $fallback): string
|
||||
{
|
||||
$value = trim($value);
|
||||
$value = preg_replace('/[^A-Za-z0-9_:@.\/,-]/', '', $value) ?: '';
|
||||
|
||||
return '' !== $value ? $value : $fallback;
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user