User Tools

Site Tools


JotCache usage

Purpose

JotCache was developed in last four years as advanced solution for page caching in Joomla framework. This solution replaces standard System-Cache plugin and it usually works along with enabled Global Cache Settings.

JotCache extension in version 5.x consists of three internal coupled parts :

  • JotCache system plugin - which is a core of entire solution performing reading/storing of cached pages, recognition of excluded URL as well as template module positions
  • JotCache component - allowing management of page cache and batch recache operations
  • Supporting plugins :
    • JotMarker system plugin - support plugin for exclusion of template module positions
    • Recache JotCache plugin - used for recaching of all already cached pages with latest available content
    • Crawler JotCache plugin - used for crawling on the site with recaching most of visited pages for given crawl depth (faster algorithm)
    • Crawler Extended JotCache plugin - used for crawling on the site with recaching all visited pages for given crawl depth

Number of JotCache plugins can be extended in the future with other recache batch processing plugins fullfilling predescribed development rules. JotCache is used for caching of frontend pages on the site with possibilities to include/exclude selected page URLs, exclude template positions (modules allocation) and bots/crawler requests from page cache. JotCache cache storage is possible to set for separate page caching based on browser type (common used browsers, phone, tablet) as well as on cookies performing specific control of page presentation during site visitor browsing.

Features of ver.5.0

Details of JotCache new features introduced in ver.5.0 are described on page New features in ver.5.0.

Page cache URL processing :

  • Requested frontend pages are included or excluded from caching based on plugin parameter URL Cache Selection
  • Two operational modes are available : Single site (default) / Multisite

Cache storage :

  • Unordered List ItemJotCache page storage is independent from selected Joomla Global Cache handler and allows to store cached pages to :
    • File system
    • Memcached server with two different PHP handlers :
      1. memcache
      2. memcached

Caching based on visitor browser type :

  • For each implemented browser type (Chrome, Firefox, IE, Safari, iPhone, iPad, Other phones, Other tablets) exists three basic possibilities for caching :
    1. Exclude
    2. Common cache
    3. Individual cache for given browser type
  • Cookies split allowing separate cache storage based on cookie name/value (and related module exclusion)

Management view :

  • Cache management view is JotCache central control panel for presentation of caching conditions, cached pages and access to management functions.
  • The cached data are presented with cached page titles and links, additional informations about cached page (browser type, language, URL query string, date/time of caching incl. indication of expired or no more stored items in cache storage) along with related component and its view parameter
  • In the management view is possible to perform selection and filtering of cached pages based on pane name or page URI (URL in case of multisite operation)
  • Possibility for site administrator and user with JotCache manager rights to clean the page cache only for selected pages.

Exclusion from caching :

  • Inclusion/exclusion of selected pages from page caching based on component, component view and URL query parameters.
  • Possibility to exclude bots (crawlers) requests from caching
  • Fast-changing dynamic modules on the cached web page can be refreshed with actual content during each visitor access. This feature of JotCache was completely redesigned for ver.4.1+. With this JotCache version for template position exclusion is enough only to select template positions from the list of enabled template positions on the site. All assigned template positions will be refreshed during each user access to cached web page.

Recache operations :

  • Batch recaching of frontend pages based on :
    • information stored in database from previous page caching activity
    • site crawling started with site homepage to other linked pages up to given depth level
  • Manual recache of marked files for users with JotCache recache rights (permission setting necessary). In this working mode authorized user can start on frontend pages the recache of viewed page and see immediatelly the results.
  • All recache operations are performed without disturbing of active users on the site. Long batch operations give indication about number of processed pages. It is also possible to stop recaching in any time after the start.
  • Batch recaching can be also processed as cron job with selected setting possibilities
  • Administrator JotCache Management view has indications about state of global cache, overall cache cleaning and JotCache plugin with fast access buttons to open related administrator pages.

Cache security :

  • Implemented strengthened security during cache activities

Cache cleaning (garbage collection) :

  • Plugin functions for more powerfull autoclean (garbage collection) activity.
  • Cleaning with cron job execution

Proof of JotCache operation :

  • Fast check of cache operation on live site without disturbing other users. For easier overview of cache mechanism on frontend pages administrator can mark his/her browser access with specific cookie allowing later to display marked page and excluded template positions / module content solely to administrator.
  • HTML content of each cached page for JotCache adjustment purposes (debug) with configuration parameter 'Show file hash' enabled

Browser (local) caching :

  • Possibility to select site URL requests which will force browser caching (locally on user side)