phizio / phix Goto Github PK

ТЗ на простой и удобный кеш-менеджер для asset-ов фреймворка phix

За основу взять не громоздкий minify а простой http://rakaz.nl/projects/combine/combine.phps

Логика его работы должна быть немного видоизменена:

• Подключение файла должно быть аналогичным - как и у других управляющих функций ядра фреймворка, т.е. в config.php

// Функции для управления подключаемыми стилями и скриптами
require_once(MC_ROOT . '/scripts/assets_cache.php');

• Включение и выключение режима конкатенации должно зависеть от настройки

$app['mode'] // 'debug' или 'production'

В режиме debug все ресурсы должны подключаться раздельно и из своих папок (как в исходной версии):

<link rel="stylesheet" href="/vendor/twbs/bootstrap/dist/css/bootstrap.min.css">
<link rel="stylesheet" href="/vendor/twbs/bootstrap/dist/css/bootstrap-theme.min.css">
<link rel="stylesheet" href="/vendor/components/font-awesome/css/font-awesome.min.css">
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=Open+Sans">
итп.

Т.е. $app['mode'] управляет только выводом внутри ф-ий css_resources() и js_resources(), либо они выдают имя сконкатенированного/зипованного кеша, либо как раньше - просто список ссылок на ресурсы. Это нужно для отладки. Т.к. иногда бывают ошибки в js - соответственно, их легче отловить, если консоль браузера тебе говорит

"ошибка в файле datatables.js, строка 554", чем если будет 
"ошибка в файле 150826_132044_fhee45jdd556da66g67f7d999a87.js.gz, строка 1"
(строка 1, т.к. все минимифицировано и переводов строк нет ни одного;)

Именно для этого нужно иметь возможность переключиться на обычный режим работы без кеширования и минимификации.
И проще всего это делать как раз тем флагом среды выполнения - 'debug' или 'production', т.к. он переключает еще ряд моих сервисных функций
вывода других ошибок итп.

• Алгоритм именования кеш-файлов следующий - массив ссылок на ресурсы объединяется в одну длинную текстовую переменную:
  'twbs/bootstrap/dist/css/bootstrap.min.css' . 'twbs/bootstrap/dist/css/bootstrap-theme.min.css' . '...
  Далее эта строка прогоняется через md5, в итоге имя файла будет более коротким. Кроме того, одинаковые по скрипто-стилевому составу страницы будут пользоваться общим md5-файлом, т.к. хеш у них получится одинаковый.
  Кроме хешированной составной части, в имени файла должна присутствовать временная метка релиза в формате, т.е. итоговый формат имени файла кэша:

yymmdd_hhmmss_hash
например: 150826_132044_fhee45jdd556da66g67f7d999a87.js.gz

• Т.к. при рендере страницы PHP не знает, какая временная метка была присвоена конкретному кэшу и не сможет найти файл, хранение соответствий будет
  осуществляться в сериализованном массиве $cache_table в файле cache_table.txt. Формат массива:

'twbs/bootstrap/dist/css/bootstrap.min.csscomponents/font-awesome/css/font-awesome.min.css' => '150826_132044_fhee45jdd556da66g67f7d999a87.js.gz'

т.е. в качестве ключа массива используется та переменная с объединенными ссылками на ресурсы.
Можно конечно хранить только md5-короткий вариант, и только таймстамповую часть:

'fhee45jdd556da66g67f7d999a87' => '150826_132044'

Но это приведет к тому, что при вызове любой страницы будет md5-титься длинная строка перечня ресурсов, а это пустая трата вычислительной мощности.
В конце концов, длина ключа массива в php не ограничена ничем, и сериализованный файл/массив cache_table не предназначен для ручной правки/чтения,
так что пусть хранятся с длинными ключами (первый вариант выше)

• Структура хранения относительно корня:

/tmp - там файл соответствия с сериализованным массивом 
/tmp/cache - там кеш-файлы

• При включенном режиме production подключенным файлом assets_cache.php должна составляться переменная
  'twbs/bootstrap/dist/css/bootstrap.min.csscomponents/font-awesome/css/font-awesome.min.css' с объединенными ссылками
  далее открываться файл cache_table и запрашиваться кеш-файл в соответствии с найденным ключом массива.
  Если кеш-файл существует, то функции css_resources() и js_resources() будут выводить одни единственные ссылки напрямую на кеш

<link rel="stylesheet" href="/tmp/cache/150826_132044_fhee45jdd556da66g67f7d999a87.js.gz">

Если кеш-файл в папке отсутствует, или не найдено соответствие в сериализованном массиве cache_table, то запускается конкатенация, gzip-овка,
создается новый кеш-файл, его имя сохраняется в сериализованный файл-массив cache_table - и опять же функции css_resources() и js_resources() выводят
ссылку на этот только что созданный кэш.