This repository has been archived on 2024-09-05. You can view files and clone it, but cannot push or open issues or pull requests.
shimmie2/ext/setup/main.php
Shish edb4ca5e74 [settings] postToSettings
Trying to keep the weird POST-formatting to a minimum, using real types where possible
2024-09-01 00:13:53 +01:00

495 lines
16 KiB
PHP

<?php
declare(strict_types=1);
namespace Shimmie2;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\{InputInterface,InputArgument};
use Symfony\Component\Console\Output\OutputInterface;
require_once "config.php";
/*
* Sent when the setup screen's 'set' button has been activated
*/
class ConfigSaveEvent extends Event
{
public Config $config;
/** @var array<string, null|string|int|boolean|array<string>> $values */
public array $values;
/**
* @param array<string, null|string|int|boolean|array<string>> $values
*/
public function __construct(Config $config, array $values)
{
parent::__construct();
$this->config = $config;
$this->values = $values;
}
/**
* Convert POST data to settings data, eg
*
* $_POST = [
* "_type_mynull" => "string",
* "_type_mystring" => "string",
* "_config_mystring" => "hello world!",
* "_type_myint" => "int",
* "_config_myint" => "42KB",
* ]
*
* becomes
*
* $config = [
* "mynull" => null,
* "mystring" => "hello world!",
* "myint" => 43008,
* ]
*
* @param array<string, string|string[]> $post
* @return array<string, null|string|int|boolean|array<string>>
*/
public static function postToSettings(array $post): array
{
$settings = [];
foreach ($post as $key => $type) {
if (str_starts_with($key, "_type_")) {
$key = str_replace("_type_", "", $key);
$value = $post["_config_$key"] ?? null;
if ($type === "string") {
$settings[$key] = $value;
} elseif ($type === "int") {
assert(is_string($value));
$settings[$key] = $value ? parse_shorthand_int($value) : null;
} elseif ($type === "bool") {
$settings[$key] = $value === "on";
} elseif ($type === "array") {
$settings[$key] = $value;
} else {
if (is_array($value)) {
$value = implode(", ", $value);
}
throw new InvalidInput("Invalid type '$value' for key '$key'");
}
}
}
return $settings;
}
}
/*
* Sent when the setup page is ready to be added to
*/
class SetupBuildingEvent extends Event
{
protected SetupTheme $theme;
public SetupPanel $panel;
public function __construct(SetupPanel $panel)
{
parent::__construct();
$this->panel = $panel;
}
}
class SetupPanel
{
/** @var SetupBlock[] */
public array $blocks = [];
public Config $config;
public function __construct(Config $config)
{
$this->config = $config;
}
public function create_new_block(string $title): SetupBlock
{
$block = new SetupBlock($title, $this->config);
$this->blocks[] = $block;
return $block;
}
}
class SetupBlock extends Block
{
public ?string $header;
public ?string $body;
public Config $config;
public function __construct(string $title, Config $config)
{
parent::__construct($title, "", "main", 50);
$this->config = $config;
}
public function add_label(string $text): void
{
$this->body .= $text;
}
public function start_table(): void
{
$this->body .= "<table class='form'>";
}
public function end_table(): void
{
$this->body .= "</table>";
}
public function start_table_row(): void
{
$this->body .= "<tr>";
}
public function end_table_row(): void
{
$this->body .= "</tr>";
}
public function start_table_head(): void
{
$this->body .= "<thead>";
}
public function end_table_head(): void
{
$this->body .= "</thead>";
}
public function add_table_header(string $content, int $colspan = 2): void
{
$this->start_table_head();
$this->start_table_row();
$this->add_table_header_cell($content, $colspan);
$this->end_table_row();
$this->end_table_head();
}
public function start_table_cell(int $colspan = 1): void
{
$this->body .= "<td colspan='$colspan'>";
}
public function end_table_cell(): void
{
$this->body .= "</td>";
}
public function add_table_cell(string $content, int $colspan = 1): void
{
$this->start_table_cell($colspan);
$this->body .= $content;
$this->end_table_cell();
}
public function start_table_header_cell(int $colspan = 1, string $align = 'right'): void
{
$this->body .= "<th colspan='$colspan' style='text-align: $align'>";
}
public function end_table_header_cell(): void
{
$this->body .= "</th>";
}
public function add_table_header_cell(string $content, int $colspan = 1): void
{
$this->start_table_header_cell($colspan);
$this->body .= $content;
$this->end_table_header_cell();
}
private function format_option(
string $name,
string $html,
?string $label,
bool $table_row,
bool $label_row = false
): void {
if ($table_row) {
$this->start_table_row();
}
if ($table_row) {
$this->start_table_header_cell($label_row ? 2 : 1, $label_row ? 'center' : 'right');
}
if (!is_null($label)) {
$this->body .= "<label for='{$name}'>{$label}</label>";
}
if ($table_row) {
$this->end_table_header_cell();
}
if ($table_row && $label_row) {
$this->end_table_row();
$this->start_table_row();
}
if ($table_row) {
$this->start_table_cell($label_row ? 2 : 1);
}
$this->body .= $html;
if ($table_row) {
$this->end_table_cell();
}
if ($table_row) {
$this->end_table_row();
}
}
public function add_text_option(string $name, ?string $label = null, bool $table_row = false): void
{
$val = html_escape($this->config->get_string($name));
$html = "<input type='text' id='{$name}' name='_config_{$name}' value='{$val}'>\n";
$html .= "<input type='hidden' name='_type_{$name}' value='string'>\n";
$this->format_option($name, $html, $label, $table_row);
}
public function add_longtext_option(string $name, ?string $label = null, bool $table_row = false): void
{
$val = html_escape($this->config->get_string($name));
$rows = max(3, min(10, count(explode("\n", $val))));
$html = "<textarea rows='$rows' id='$name' name='_config_$name'>$val</textarea>\n";
$html .= "<input type='hidden' name='_type_$name' value='string'>\n";
$this->format_option($name, $html, $label, $table_row, true);
}
public function add_bool_option(string $name, ?string $label = null, bool $table_row = false): void
{
$checked = $this->config->get_bool($name) ? " checked" : "";
$html = "";
if (!$table_row && !is_null($label)) {
$html .= "<label for='{$name}'>{$label}</label>";
}
$html .= "<input type='checkbox' id='$name' name='_config_$name'$checked>\n";
if ($table_row && !is_null($label)) {
$html .= "<label for='{$name}'>{$label}</label>";
}
$html .= "<input type='hidden' name='_type_$name' value='bool'>\n";
$this->format_option($name, $html, null, $table_row);
}
// public function add_hidden_option($name) {
// global $config;
// $val = $config->get_string($name);
// $this->body .= "<input type='hidden' id='$name' name='$name' value='$val'>";
// }
public function add_int_option(string $name, ?string $label = null, bool $table_row = false): void
{
$val = $this->config->get_int($name);
$html = "<input type='number' id='$name' name='_config_$name' value='$val' size='4' step='1' />\n";
$html .= "<input type='hidden' name='_type_$name' value='int' />\n";
$this->format_option($name, $html, $label, $table_row);
}
public function add_shorthand_int_option(string $name, ?string $label = null, bool $table_row = false): void
{
$val = to_shorthand_int($this->config->get_int($name, 0));
$html = "<input type='text' id='$name' name='_config_$name' value='$val' size='6'>\n";
$html .= "<input type='hidden' name='_type_$name' value='int'>\n";
$this->format_option($name, $html, $label, $table_row);
}
/**
* @param array<string,string|int> $options
*/
public function add_choice_option(string $name, array $options, ?string $label = null, bool $table_row = false): void
{
if (is_int(array_values($options)[0])) {
$current = $this->config->get_int($name);
} else {
$current = $this->config->get_string($name);
}
$html = "<select id='$name' name='_config_$name'>";
foreach ($options as $optname => $optval) {
if ($optval == $current) {
$selected = " selected";
} else {
$selected = "";
}
$html .= "<option value='$optval'$selected>$optname</option>\n";
}
$html .= "</select>";
$html .= "<input type='hidden' name='_type_$name' value='string'>\n";
$this->format_option($name, $html, $label, $table_row);
}
/**
* @param array<string,string> $options
*/
public function add_multichoice_option(string $name, array $options, ?string $label = null, bool $table_row = false): void
{
$current = $this->config->get_array($name, []);
$html = "<select id='$name' name='_config_{$name}[]' multiple size='5'>";
foreach ($options as $optname => $optval) {
if (in_array($optval, $current)) {
$selected = " selected";
} else {
$selected = "";
}
$html .= "<option value='$optval'$selected>$optname</option>\n";
}
$html .= "</select>";
$html .= "<input type='hidden' name='_type_$name' value='array'>\n";
$this->format_option($name, $html, $label, $table_row);
}
public function add_color_option(string $name, ?string $label = null, bool $table_row = false): void
{
$val = html_escape($this->config->get_string($name));
$html = "<input type='color' id='{$name}' name='_config_{$name}' value='{$val}'>\n";
$html .= "<input type='hidden' name='_type_{$name}' value='string'>\n";
$this->format_option($name, $html, $label, $table_row);
}
}
class Setup extends Extension
{
/** @var SetupTheme */
protected Themelet $theme;
public function onInitExt(InitExtEvent $event): void
{
global $config;
$config->set_default_string(SetupConfig::TITLE, "Shimmie");
$config->set_default_string(SetupConfig::FRONT_PAGE, "post/list");
$config->set_default_string(SetupConfig::MAIN_PAGE, "post/list");
$config->set_default_string(SetupConfig::THEME, "default");
$config->set_default_bool(SetupConfig::WORD_WRAP, true);
}
public function onPageRequest(PageRequestEvent $event): void
{
global $config, $page, $user;
if ($event->page_starts_with("nicedebug")) {
$page->set_mode(PageMode::DATA);
$page->set_data(\Safe\json_encode([
"args" => $event->args,
]));
}
if ($event->page_matches("nicetest")) {
$page->set_mode(PageMode::DATA);
$page->set_data("ok");
}
if ($event->page_matches("setup/advanced", method: "GET", permission: Permissions::CHANGE_SETTING)) {
$this->theme->display_advanced($page, $config->values);
} elseif ($event->page_matches("setup", method: "GET", permission: Permissions::CHANGE_SETTING)) {
$panel = new SetupPanel($config);
send_event(new SetupBuildingEvent($panel));
$this->theme->display_page($page, $panel);
} elseif ($event->page_matches("setup/save", method: "POST", permission: Permissions::CHANGE_SETTING)) {
send_event(new ConfigSaveEvent($config, ConfigSaveEvent::postToSettings($event->POST)));
$page->flash("Config saved");
$page->set_mode(PageMode::REDIRECT);
$page->set_redirect(make_link("setup"));
}
}
public function onSetupBuilding(SetupBuildingEvent $event): void
{
$themes = [];
foreach (\Safe\glob("themes/*") as $theme_dirname) {
$name = str_replace("themes/", "", $theme_dirname);
$human = str_replace("_", " ", $name);
// while phpstan-safe-rule isn't enabled, phpstan can't tell
// that \Safe\glob() returns string[]
// @phpstan-ignore-next-line
$human = ucwords($human);
$themes[$human] = $name;
}
$sb = $event->panel->create_new_block("General");
$sb->position = 0;
$sb->add_text_option(SetupConfig::TITLE, "Site title: ");
$sb->add_text_option(SetupConfig::FRONT_PAGE, "<br>Front page: ");
$sb->add_text_option(SetupConfig::MAIN_PAGE, "<br>Main page: ");
$sb->add_text_option("contact_link", "<br>Contact URL: ");
$sb->add_choice_option(SetupConfig::THEME, $themes, "<br>Theme: ");
//$sb->add_multichoice_option("testarray", array("a" => "b", "c" => "d"), "<br>Test Array: ");
$sb->add_bool_option(SetupConfig::NICE_URLS, "<br>Nice URLs: ");
$sb->add_label("<span id='nicetest'>(Javascript inactive, can't test!)</span>");
$sb = $event->panel->create_new_block("Remote API Integration");
$sb->add_label("<a href='https://akismet.com/'>Akismet</a>");
$sb->add_text_option("comment_wordpress_key", "<br>API key: ");
$sb->add_label("<br>&nbsp;<br><a href='https://www.google.com/recaptcha/admin'>ReCAPTCHA</a>");
$sb->add_text_option("api_recaptcha_privkey", "<br>Secret key: ");
$sb->add_text_option("api_recaptcha_pubkey", "<br>Site key: ");
}
public function onConfigSave(ConfigSaveEvent $event): void
{
$config = $event->config;
foreach ($event->values as $key => $value) {
match(true) {
is_null($value) => $config->delete($key),
is_string($value) => $config->set_string($key, $value),
is_int($value) => $config->set_int($key, $value),
is_bool($value) => $config->set_bool($key, $value),
is_array($value) => $config->set_array($key, $value),
};
}
log_warning("setup", "Configuration updated");
}
public function onCliGen(CliGenEvent $event): void
{
$event->app->register('config:get')
->addArgument('key', InputArgument::REQUIRED)
->setDescription('Get a config value')
->setCode(function (InputInterface $input, OutputInterface $output): int {
global $config;
$output->writeln($config->get_string($input->getArgument('key')));
return Command::SUCCESS;
});
$event->app->register('config:set')
->addArgument('key', InputArgument::REQUIRED)
->addArgument('value', InputArgument::REQUIRED)
->setDescription('Set a config value')
->setCode(function (InputInterface $input, OutputInterface $output): int {
global $cache, $config;
$config->set_string($input->getArgument('key'), $input->getArgument('value'));
$cache->delete("config");
return Command::SUCCESS;
});
}
public function onPageSubNavBuilding(PageSubNavBuildingEvent $event): void
{
global $user;
if ($event->parent === "system") {
if ($user->can(Permissions::CHANGE_SETTING)) {
$event->add_nav_link("setup", new Link('setup'), "Board Config", null, 0);
}
}
}
public function onUserBlockBuilding(UserBlockBuildingEvent $event): void
{
global $user;
if ($user->can(Permissions::CHANGE_SETTING)) {
$event->add_link("Board Config", make_link("setup"));
}
}
public function onParseLinkTemplate(ParseLinkTemplateEvent $event): void
{
global $config;
$event->replace('$base', $config->get_string('base_href'));
$event->replace('$title', $config->get_string(SetupConfig::TITLE));
}
}