etc_cache: cache trying hard to be smart

etc · 2019-11-14 10:01:48

Hi Julian

jakob wrote #320068:

How would I use reset / filter so that the cache is refreshed whenever an article with a date in the current year is saved?

Do you mean only the cache of the current year? It depends on the parameter used as “year”. Assuming it comes from URL month, you could construct cache blocks like (untested)

<txp:variable name="year" escape="trim">
    <txp:php>
        echo strftime('%Y');
    </txp:php>
</txp:variable>

<txp:evaluate query='<txp:page_url type="month" escape="integer" /> < <txp:variable name="year" />'>
    <txp:etc_cache id='year-<txp:page_url type="month" escape="integer" />' time="10000000000" ... />
<txp:else />
    <txp:etc_cache id='year-<txp:variable name="year" />' time ... />
<txp:evaluate>

Or – even better – when an article in the same year as the cached block is saved?

This looks tricky atm since there is no Year field in textpattern table. Will think of it.

Also useful would be able to additionally restrict the filter to articles saved in that year in a specific section.

You could try to set filter to

{"article_saved":{"Section":"my_section_name"}}

jakob · 2019-11-14 10:27:12

etc wrote #320073:

Hi Julian

Do you mean only the cache of the current year? It depends on the parameter used as “year”. Assuming it comes from URL month, you could construct cache blocks like (untested)

<txp:variable name="year" escape="trim">...

My first thought was:

when a new article is saved with a posted date of now(ish), the cache for the block for the current year is refreshed. A new article is saved more-or-less once a week.

Then I thought:

there might be (infrequent) situations where a past year is edited. One could just simply manually refresh the cache for that year. Or maybe make the reset filter refresh when “the article was posted in the same year as the cached block.

I already have some variables for the respective year / month that I use to name the blocks.

You could try to set filter to

{"article_saved":{"Section":"my_section_name"}}...

You mention in the plugin help that you can use SQL LIKE patterns. Would that mean you could do:

{"article_saved":{"Section":"my_section_name","Posted":"2019%"}}

or something similar. I’m not sure how you chain multiple filter criteria, so the above is just a guess. If one could plug the value of a variable into that Posted bit, I think we would be there…

etc · 2019-11-14 10:48:46

jakob wrote #320076:

You mention in the plugin help that you can use SQL LIKE patterns. Would that mean you could do:

{"article_saved":{"Section":"my_section_name","Posted":"2019%"}}...

or something similar. I’m not sure how you chain multiple filter criteria, so the above is just a guess. If one could plug the value of a variable into that Posted bit, I think we would be there…

Not in filter, unfortunately. You can chain multiple criteria as you put above, or even

{"article_saved":{"Section":["my_section_name", "another_section"],"Posted":"2019%"}}

but you need to provide exact values, so 2019% will not work for Posted. And we can not really plug a tag into filter because it is checked on the admin side.

etc · 2019-11-14 14:57:02

Actually, I’m wrong: filter fields are not those of textpattern table but these of article edit form, including year, month and so on. So you can set for each year a filter like

{"article_saved":{"Section":"my_section_name","year":"2019"}}

Here is the (presumably) full list:


    'ID',
    'Title',
    'Body',
    'Excerpt',
    'textile_excerpt',
    'Image',
    'textile_body',
    'Keywords',
    'description',
    'Status',
    'Posted',
    'Expires',
    'Section',
    'Category1',
    'Category2',
    'Annotate',
    'AnnotateInvite',
    'publish_now',
    'reset_time',
    'expire_now',
    'AuthorID',
    'sPosted',
    'LastModID',
    'sLastMod',
    'override_form',
    'from_view',
    'year',
    'month',
    'day',
    'hour',
    'minute',
    'second',
    'url_title',
    'exp_year',
    'exp_month',
    'exp_day',
    'exp_hour',
    'exp_minute',
    'exp_second',
    'sExpires'

jakob · 2019-11-16 08:38:52

etc wrote #320088:

Actually, I’m wrong: filter fields are not those of textpattern table but these of article edit form, including year, month and so on. So you can set for each year a filter like

{"article_saved":{"Section":"my_section_name","year":"2019"}}...

Thanks! That’s excellent to know. So, in this case we’re lucky that year, month and day are separate fields in the write pane.

I’m curious: I get why the txp:tag can’t be added to the filter field in the Extensions » etc_cache panel, but if it were possible to pass the filter as an attribute of the tag, like you can with reset, would the tag-in-tag variant work? My thinking was that the tag-as-attribute would be processed first and the results passed to etc_cache.

etc · 2019-11-16 09:43:47

jakob wrote #320095:

if it were possible to pass the filter as an attribute of the tag, like you can with reset, would the tag-in-tag variant work? My thinking was that the tag-as-attribute would be processed first and the results passed to etc_cache.

You are right, though JSON is not very practical in txp attributes (nested quotes etc). The main concern with this is what to do when filter changes? Ignore it until cached block expiration? Refresh the block if filter is different from the previous value? Both approaches have their drawbacks.

etc · 2021-02-11 23:11:10

I’m thinking of enhancing etc_cache with some static site generation abilities. Currently these take a form of a very basic but amazing plugin (independent of etc_cache). FOR TESTING ONLY!

To use it (after install/enable step) you need to append the following to your site .htaccess right after RewriteRule ^(.+) - [PT,L]:

    RewriteCond %{REQUEST_METHOD} =GET
    RewriteCond %{QUERY_STRING} ^$
    RewriteCond %{DOCUMENT_ROOT}/path/to/site/cache/$1 -f [OR]
    RewriteCond %{DOCUMENT_ROOT}/path/to/site/cache/$1index.html -f
    RewriteRule ^(.*) cache/$1 [PT,L]

Replace path/to/site here with the public site path from the document root.

On clean URL access it will create corresponding directories/files under cache directory of your site. On next accesses static files will be served from disk, so txp will not even be launched. When the site is updated, the whole cache directory will be deleted and the caching process will start anew. URLs with ? queries are not cached, so search etc should work ok.

Enjoy!

# Name: etc_static v0.1 
# Type: Admin/Public/AJAX plugin
# Static cache
# Author: Oleg Loukianov
# URL: https://github.com/bloatware/
# Recommended load order: 5

# .....................................................................
# This is a plugin for Textpattern CMS - http://textpattern.com/
# To install: textpattern > admin > plugins
# Paste the following text into the 'Install plugin' box:
# .....................................................................

YToxMTp7czo0OiJuYW1lIjtzOjEwOiJldGNfc3RhdGljIjtzOjY6ImF1dGhvciI7czoxNDoi
T2xlZyBMb3VraWFub3YiO3M6MTA6ImF1dGhvcl91cmkiO3M6Mjk6Imh0dHBzOi8vZ2l0aHVi
LmNvbS9ibG9hdHdhcmUvIjtzOjc6InZlcnNpb24iO3M6MzoiMC4xIjtzOjExOiJkZXNjcmlw
dGlvbiI7czoxMjoiU3RhdGljIGNhY2hlIjtzOjQ6ImNvZGUiO3M6MTE2ODoiLyogIC8vIC0t
LSBBcHBlbmQgdG8gLmh0YWNjZXNzIHJpZ2h0IGFmdGVyIFJld3JpdGVSdWxlIF4oLispIC0g
W1BULExdIC0tLSAvLw0KICAgIFJld3JpdGVDb25kICV7UkVRVUVTVF9NRVRIT0R9ID1HRVQN
CiAgICBSZXdyaXRlQ29uZCAle1FVRVJZX1NUUklOR30gXiQNCiAgICBSZXdyaXRlQ29uZCAl
e0RPQ1VNRU5UX1JPT1R9L3BhdGgvdG8vc2l0ZS9jYWNoZS8kMSAtZiBbT1JdDQogICAgUmV3
cml0ZUNvbmQgJXtET0NVTUVOVF9ST09UfS9wYXRoL3RvL3NpdGUvY2FjaGUvJDFpbmRleC5o
dG1sIC1mDQogICAgUmV3cml0ZVJ1bGUgXiguKikgY2FjaGUvJDEgW1BULExdDQoqLw0KDQpy
ZWdpc3Rlcl9jYWxsYmFjayhmdW5jdGlvbigpIHsNCiAgXFR4cDo6Z2V0KCdcVGV4dHBhdHRl
cm5cQWRtaW5cVG9vbHMnKS0+cmVtb3ZlRmlsZXMoJy4uJywgJ2NhY2hlJyk7DQp9LCAnc2l0
ZS51cGRhdGUnKTsNCg0KcmVnaXN0ZXJfY2FsbGJhY2soZnVuY3Rpb24oKXsNCiAgZ2xvYmFs
ICRwcmV0ZXh0Ow0KDQogIGlmICghZW1wdHkoJF9QT1NUKSB8fA0KICAgIHN0cnBvcygkcHJl
dGV4dFsncmVxJ10sICc/JykgIT09IGZhbHNlIHx8DQogICAgc3RycG9zKCRwcmV0ZXh0Wydy
ZXEnXSwgJy9pbmRleC5waHAnKSA9PT0gMA0KICApIHJldHVybjsNCg0KICBvYl9zdGFydCgp
Ow0KDQogIHJlZ2lzdGVyX2NhbGxiYWNrKGZ1bmN0aW9uKCl7DQogICAgZ2xvYmFsICRwcmV0
ZXh0Ow0KICAgICRjYWNoZSA9ICdjYWNoZS8nOw0KICAgICRkaXIgPSBleHBsb2RlKCcvJywg
bHRyaW0oJHByZXRleHRbJ3JlcSddLCAnLycpKTsNCiAgICBmb3JlYWNoICgkZGlyIGFzICYk
cCkgew0KICAgICAgJHAgPSAkcCAhPT0gJycgPyBzYW5pdGl6ZUZvckZpbGUoJHApIDogJ2lu
ZGV4Lmh0bWwnOw0KICAgIH0NCiAgICANCiAgICB1bnNldCgkcCk7DQogICAgJGZpbGUgPSBh
cnJheV9wb3AoJGRpcik7DQogICAgJGRpciA9ICRjYWNoZS5pbXBsb2RlKCcvJywgJGRpcik7
DQogICAgaWYgKCFpc19kaXIoJGRpcikpIG1rZGlyKCRkaXIsIDA3NzcsIHRydWUpOw0KICAg
ICRvdXQgPSBvYl9nZXRfY2xlYW4oKTsNCiAgICBmaWxlX3B1dF9jb250ZW50cygkZGlyLicv
Jy4kZmlsZSwgJG91dCk7DQogICAgZWNobyAkb3V0Ow0KICB9LCAndGV4dHBhdHRlcm5fZW5k
Jyk7DQp9LCAndGV4dHBhdHRlcm4nKTsNCiI7czo0OiJ0eXBlIjtzOjE6IjUiO3M6NToib3Jk
ZXIiO3M6MToiNSI7czo1OiJmbGFncyI7czoxOiIwIjtzOjQ6ImhlbHAiO3M6MDoiIjtzOjM6
Im1kNSI7czozMjoiYjJmYTMzOTc2MmUwMDA3MGQ1YjM3N2U3MjU0ODM5OWUiO30=

Pat64 · 2021-02-12 06:42:37

I’m loving it! 👍

Tested on a local server (MAMP PC) without any damages. My flat JavaScript resources work fine, too.
Is there a real performance gain with your plugin, Oleg?
May I can use it, today, within an in production website? 😜

Last edited by Pat64 (2021-02-12 06:45:19)

philwareham · 2021-02-12 06:56:12

Sounds great, will test later. Can you choose what pages are cached?

Reminds me of rah_cache which showed promise. Maybe some bits in that code which could be of use?

Pat64 · 2021-02-12 07:26:45

@Phil:

Currently, what I observe, all pages are in cache!

etc · 2021-02-12 07:53:55

Pat64 wrote #328791:

Is there a real performance gain with your plugin, Oleg?

philwareham wrote #328792:

Reminds me of rah_cache which showed promise. Maybe some bits in that code which could be of use?

Great bits in Jukka’s code, will certainly steal something. But the delivery mechanism is not the same: while rah_cache serves cached files via txp (like etc_cache does), etc_static delegates this to apache server. So no php processing is required at all to serve cached files and the performance gain can be important.

Can you choose what pages are cached?

It’s planned, as well as the cache management.

May I can use it, today, within an in production website? 😜

Saw this bold writing? :-) It would be prudent to wait a week or so, please help me testing meanwhile.

Edit: for an average page on my laptop I get 100ms -> 5ms gain.

Pat64 · 2021-02-12 08:02:59

… No. I prefer never to read anything in bold writing.

Textpattern CMS

Textpattern CMS support forum

#13 2019-11-14 10:01:48

Re: etc_cache: cache trying hard to be smart

jakob wrote #320068:

#14 2019-11-14 10:27:12

Re: etc_cache: cache trying hard to be smart

etc wrote #320073:

#15 2019-11-14 10:48:46

Re: etc_cache: cache trying hard to be smart

jakob wrote #320076:

#16 2019-11-14 14:57:02

Re: etc_cache: cache trying hard to be smart

#17 2019-11-16 08:38:52

Re: etc_cache: cache trying hard to be smart

etc wrote #320088:

#18 2019-11-16 09:43:47

Re: etc_cache: cache trying hard to be smart

jakob wrote #320095:

#19 2021-02-11 23:11:10

Re: etc_cache: cache trying hard to be smart

#20 2021-02-12 06:42:37

Re: etc_cache: cache trying hard to be smart

#21 2021-02-12 06:56:12

Re: etc_cache: cache trying hard to be smart

#22 2021-02-12 07:26:45

Re: etc_cache: cache trying hard to be smart

#23 2021-02-12 07:53:55

Re: etc_cache: cache trying hard to be smart

Pat64 wrote #328791:

philwareham wrote #328792:

#24 2021-02-12 08:02:59

Re: etc_cache: cache trying hard to be smart

Board footer