how to allow url schemes in text-formatter

jdysya

The issue

I have read the docs in s9etextformatter docs, and I have modified the code related（I wanna support url like marginnote3app://xxx）:

<?php

/**
* @package   s9e\TextFormatter
* @copyright Copyright (c) 2010-2023 The s9e authors
* @license   http://www.opensource.org/licenses/mit-license.php The MIT License
*/
namespace s9e\TextFormatter\Configurator;

use RuntimeException;
use s9e\TextFormatter\Configurator\Collections\HostnameList;
use s9e\TextFormatter\Configurator\Collections\SchemeList;
use s9e\TextFormatter\Configurator\Helpers\ConfigHelper;

public function __construct()
	{
		$this->disallowedHosts = new HostnameList;
		$this->restrictedHosts = new HostnameList;

		$this->allowedSchemes   = new SchemeList;
		$this->allowedSchemes[] = 'http';
		$this->allowedSchemes[] = 'https';
		$this->allowedSchemes[] = 'marginnote3app';
	}

But I found that it worked when I edited it, but it didn't work when I saved it on the page.

clarkwinkelmann

jdysya anytime the formatter configuration changes, you must clear Flarum's cache. The preview and final renderer are cached in 2 different places so it's possible that it only works in one place if the cache has not been cleared. Usually formatting configuration is done by extension and enabling/disabling extensions will clear the cache. You can clear the cache manually from the admin panel or the command line.

Ideally, you would use the Extend\Formatter::configure extender in the root extend.php to modify TextFormatter configuration on your forum without risking your file edits to be reverted on extension and Flarum updates. There should be an example code for this particular task somewhere but I'm not sure if it was shared on this forum previously.

jdysya

clarkwinkelmann I have tried to clear the cache from the admin panel and run the command php flarum cache:clear,however, nothing happened，It was business as usual.

JoshyPHP

Judging by the BBCode extension and assuming the old extend syntax is still supported, you only need like 3 lines of code and a composer.json file.

use Flarum\Extend;
use s9e\TextFormatter\Configurator;

return (new Extend\Formatter)->configure(
	fn(Configurator $configurator) => $configurator->urlConfig->allowScheme('marginnote3app')
);

https://s9etextformatter.readthedocs.io/Filters/URL_features/Schemes/

jdysya

JoshyPHP I have add these code into the extend.php, the effect is the same as I did before, but your way is better. And now the issue is that the change does not take full effect (only works when editing the reply text, the preview view).

clarkwinkelmann

If you are testing by editing an existing post, note that you must change at least one character for Flarum to re-generate the formatted post. If the content is identical from before the edit Flarum skips that step.

It's best to always create new posts/discussions while testing formatter configuration changes.

EDIT: just to be extra sure this should be working, I tested JoshyPHP code on my test forum and it works as intended, both in previews and final posts. I had never seen the PHP arrow functions used in the context of Flarum before but assuming your PHP version supports them it's perfectly fine (seems to be from PHP 7.4 and up).

JoshyPHP

I don't know about that. If it works in preview, it should work everywhere. You'll need someone more familiar with Flarum's internals.

jdysya

clarkwinkelmann you must change at least one character for Flarum to re-generate the formatted post

Just as you said，it worked!