Textreparser documentation?

Discussion forum for Extension Writers regarding Extension Development.
User avatar
Ger
Registered User
Posts: 2108
Joined: Wed Jan 02, 2008 7:35 pm
Location: 192.168.1.100
Contact:

Re: Textreparser documentation?

Post by Ger »

JoshyPHP wrote: Tue Jun 12, 2018 3:23 am I don't know whether the CLI uses a lock and I hope not. I don't know why a lock exists.
This made me wonder, since I have seen the lock. It seems to be used only in the cron task: https://github.com/phpbb/phpbb-core/blo ... er.php#L72

I've corrected this in above post. Also, David63 was so kind to send me some textual improvements, those are also incorporated in above post.

Since almost anyone participating in this topic wrote that he doesn't know all the technical bits, I took a look at Github. It seems that Elsensee has written most of the text reparser code.
Elsensee wrote: Gentile poke
@Elsensee: would you be so kind to tell us if we've got the explanation here right?
My extensions:
Simple CMS, Feed post bot, Avatar Resize, Modbreak, Magic OGP, Live topic update, Modern Quote, Quoted Where (GDPR) and Autoresponder.
Newest: FAQ manager for 3.2

Like my work? Buy me a coffee to keep it coming. :ugeek:

-Don't PM me for support-
User avatar
3Di
I've Been Banned!
Posts: 17538
Joined: Mon Apr 04, 2005 11:09 pm
Location: I'm with Ukraine 🇺🇦
Name: Marco
Contact:

Re: Textreparser documentation?

Post by 3Di »

It's all about CLi it seems, why not to add what the documentation says about the normal behaviour of an update 3.1/3.2?
phpBB 3.2 has a New Text Reparser class which will convert all posts, PMs, signatures, etc. to the new format shortly after updating to 3.2 (this is handled mostly by incremental cron jobs).
https://area51.phpbb.com/docs/dev/3.2.x ... ode-engine
When a board is updated from 3.1 to 3.2, the reparser is called into service in two ways. First, migrations are used to reparse some of the smaller database items (forum descriptions, for example). Second, cron tasks are used to incrementally reparse the larger database items (posts & PMs).
https://area51.phpbb.com/docs/dev/3.2.x ... t-reparser

Which explains a bit about the lock thinghy too.

Missing details about ansi and the meaning of it, also.
🆓 Free support for our extensions also provided here: phpBB Studio
🚀 Looking for a specific feature or alternative option? We will rock you!
Please PM me only to request paid works. Thx. Buy me a coffee -> Image
My development's activity º PhpStorm's proud user º Extensions, Scripts, MOD porting, Update/Upgrades
User avatar
Ger
Registered User
Posts: 2108
Joined: Wed Jan 02, 2008 7:35 pm
Location: 192.168.1.100
Contact:

Re: Textreparser documentation?

Post by Ger »

Thanks, incorporated as well.
My extensions:
Simple CMS, Feed post bot, Avatar Resize, Modbreak, Magic OGP, Live topic update, Modern Quote, Quoted Where (GDPR) and Autoresponder.
Newest: FAQ manager for 3.2

Like my work? Buy me a coffee to keep it coming. :ugeek:

-Don't PM me for support-
User avatar
3Di
I've Been Banned!
Posts: 17538
Joined: Mon Apr 04, 2005 11:09 pm
Location: I'm with Ukraine 🇺🇦
Name: Marco
Contact:

Re: Textreparser documentation?

Post by 3Di »

Looks good to me.
Just remove those backticks from the update SQL query, please.
🆓 Free support for our extensions also provided here: phpBB Studio
🚀 Looking for a specific feature or alternative option? We will rock you!
Please PM me only to request paid works. Thx. Buy me a coffee -> Image
My development's activity º PhpStorm's proud user º Extensions, Scripts, MOD porting, Update/Upgrades
User avatar
Ger
Registered User
Posts: 2108
Joined: Wed Jan 02, 2008 7:35 pm
Location: 192.168.1.100
Contact:

Re: Textreparser documentation?

Post by Ger »

3Di wrote: Wed Jun 13, 2018 2:57 am remove those backticks from the update SQL query, please.
Why?
My extensions:
Simple CMS, Feed post bot, Avatar Resize, Modbreak, Magic OGP, Live topic update, Modern Quote, Quoted Where (GDPR) and Autoresponder.
Newest: FAQ manager for 3.2

Like my work? Buy me a coffee to keep it coming. :ugeek:

-Don't PM me for support-
User avatar
3Di
I've Been Banned!
Posts: 17538
Joined: Mon Apr 04, 2005 11:09 pm
Location: I'm with Ukraine 🇺🇦
Name: Marco
Contact:

Re: Textreparser documentation?

Post by 3Di »

I am not quite sure that query will work on every supported DB since doesn't seems to be ANSI SQL, I can't test that though.
Backticks can stay on MySql, yes.

As for more details on CLI commands, please read: https://area51.phpbb.com/docs/dev/3.2.x/cli/index.html
🆓 Free support for our extensions also provided here: phpBB Studio
🚀 Looking for a specific feature or alternative option? We will rock you!
Please PM me only to request paid works. Thx. Buy me a coffee -> Image
My development's activity º PhpStorm's proud user º Extensions, Scripts, MOD porting, Update/Upgrades
User avatar
Ger
Registered User
Posts: 2108
Joined: Wed Jan 02, 2008 7:35 pm
Location: 192.168.1.100
Contact:

Re: Textreparser documentation?

Post by Ger »

Mentioned above and also incorporated some suggestions from the team
My extensions:
Simple CMS, Feed post bot, Avatar Resize, Modbreak, Magic OGP, Live topic update, Modern Quote, Quoted Where (GDPR) and Autoresponder.
Newest: FAQ manager for 3.2

Like my work? Buy me a coffee to keep it coming. :ugeek:

-Don't PM me for support-
User avatar
3Di
I've Been Banned!
Posts: 17538
Joined: Mon Apr 04, 2005 11:09 pm
Location: I'm with Ukraine 🇺🇦
Name: Marco
Contact:

Re: Textreparser documentation?

Post by 3Di »

Ger wrote: Fri Jun 08, 2018 2:48 pm
You can also run in safe-mode, ignoring any extensions you might have:

Code: Select all

php bin/phpbbcli.php --safe-mode reparser:reparse  --ansi
safe-mode also ignores the cache if I correctly recall?
Ger wrote: Fri Jun 08, 2018 2:48 pm Suggestions from 3Di[
Extra opening square brace appended to my nickname. :P :)

Side note: --ansi supports 'ANSI' control character sequences for terminals on Unix-like operating systems and Windows.

It does emulate a known terminal (for those of us old dogs) https://en.wikipedia.org/wiki/List_of_t ... _emulators
.. there were also vt-100, vt102, etc.. once upon a time.
🆓 Free support for our extensions also provided here: phpBB Studio
🚀 Looking for a specific feature or alternative option? We will rock you!
Please PM me only to request paid works. Thx. Buy me a coffee -> Image
My development's activity º PhpStorm's proud user º Extensions, Scripts, MOD porting, Update/Upgrades
User avatar
Ger
Registered User
Posts: 2108
Joined: Wed Jan 02, 2008 7:35 pm
Location: 192.168.1.100
Contact:

Re: Textreparser documentation?

Post by Ger »

Yeah, I don't intent to write extensive documentation about the CLI. The purpose of this doc is to have documentation about the Text Reparser. That needs some short explanation about the Textformatter and the CLI, but those have their own place for documentation. If you think the CLI documentation is incomplete or faulty, I think you should contribute to that specific documentation.
My extensions:
Simple CMS, Feed post bot, Avatar Resize, Modbreak, Magic OGP, Live topic update, Modern Quote, Quoted Where (GDPR) and Autoresponder.
Newest: FAQ manager for 3.2

Like my work? Buy me a coffee to keep it coming. :ugeek:

-Don't PM me for support-
User avatar
MattF
Extensions Development Coordinator
Extensions Development Coordinator
Posts: 5859
Joined: Sat Jan 17, 2009 9:37 am
Location: Los Angeles, CA
Name: Matt Friedman

Re: Textreparser documentation?

Post by MattF »

Ger wrote: Fri Jun 08, 2018 2:48 pm Right, I now have this:
https://github.com/GerB/quotedwhere/blo ... hp#L50-L55
Are you able to submit an article for this to the knowledgebase here: https://www.phpbb.com/support/docs/en/3.2/kb/
Formerly known as VSEMy ExtensionsPlease do not PM me for support.
User avatar
Ger
Registered User
Posts: 2108
Joined: Wed Jan 02, 2008 7:35 pm
Location: 192.168.1.100
Contact:

Re: Textreparser documentation?

Post by Ger »

Nope, don't have permission for that. But I have pm discussion about it through JimA with some team members about it. Should go to the KB soon.
My extensions:
Simple CMS, Feed post bot, Avatar Resize, Modbreak, Magic OGP, Live topic update, Modern Quote, Quoted Where (GDPR) and Autoresponder.
Newest: FAQ manager for 3.2

Like my work? Buy me a coffee to keep it coming. :ugeek:

-Don't PM me for support-
User avatar
JimA
Former Team Member
Posts: 7833
Joined: Thu Jul 31, 2008 5:54 am
Location: The Netherlands
Name: Jim Mossing Holsteyn
Contact:

Re: Textreparser documentation?

Post by JimA »

Ger wrote: Wed Jun 27, 2018 4:38 pm Nope, don't have permission for that. But I have pm discussion about it through JimA with some team members about it. Should go to the KB soon.
This has been posted now. Thanks to everybody contributing, and especially Ger for writing the article itself. :)
Knowledge Base - phpBB 3.2+ Text Reparser
Jim Mossing Holsteyn - Former Community Team Leader
Knowledge Base | Documentation | Board rules

If you're having any questions about the rules/customs of this website, feel free to drop me a PM.
User avatar
Ger
Registered User
Posts: 2108
Joined: Wed Jan 02, 2008 7:35 pm
Location: 192.168.1.100
Contact:

Re: Textreparser documentation?

Post by Ger »

Great, thanks!
My extensions:
Simple CMS, Feed post bot, Avatar Resize, Modbreak, Magic OGP, Live topic update, Modern Quote, Quoted Where (GDPR) and Autoresponder.
Newest: FAQ manager for 3.2

Like my work? Buy me a coffee to keep it coming. :ugeek:

-Don't PM me for support-
Post Reply

Return to “Extension Writers Discussion”