123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704 |
- <?php
- /**
- * @package Grav\Framework\Flex
- *
- * @copyright Copyright (C) 2015 - 2019 Trilby Media, LLC. All rights reserved.
- * @license MIT License; see LICENSE file for details.
- */
- namespace Grav\Framework\Flex;
- use Grav\Common\Debugger;
- use Grav\Common\File\CompiledYamlFile;
- use Grav\Common\Grav;
- use Grav\Common\Session;
- use Grav\Framework\Cache\CacheInterface;
- use Grav\Framework\Collection\CollectionInterface;
- use Grav\Framework\Flex\Interfaces\FlexCollectionInterface;
- use Grav\Framework\Flex\Interfaces\FlexIndexInterface;
- use Grav\Framework\Flex\Interfaces\FlexObjectInterface;
- use Grav\Framework\Flex\Interfaces\FlexStorageInterface;
- use Grav\Framework\Object\Interfaces\ObjectCollectionInterface;
- use Grav\Framework\Object\Interfaces\ObjectInterface;
- use Grav\Framework\Object\ObjectIndex;
- use Monolog\Logger;
- use Psr\SimpleCache\InvalidArgumentException;
- class FlexIndex extends ObjectIndex implements FlexCollectionInterface, FlexIndexInterface
- {
- /** @var FlexDirectory */
- private $_flexDirectory;
- /** @var string */
- private $_keyField;
- /** @var array */
- private $_indexKeys;
- /**
- * @param FlexDirectory $directory
- * @return static
- */
- public static function createFromStorage(FlexDirectory $directory)
- {
- return static::createFromArray(static::loadEntriesFromStorage($directory->getStorage()), $directory);
- }
- /**
- * {@inheritdoc}
- * @see FlexCollectionInterface::createFromArray()
- */
- public static function createFromArray(array $entries, FlexDirectory $directory, string $keyField = null)
- {
- $instance = new static($entries, $directory);
- $instance->setKeyField($keyField);
- return $instance;
- }
- /**
- * @param FlexStorageInterface $storage
- * @return array
- */
- public static function loadEntriesFromStorage(FlexStorageInterface $storage): array
- {
- return $storage->getExistingKeys();
- }
- /**
- * Initializes a new FlexIndex.
- *
- * @param array $entries
- * @param FlexDirectory|null $directory
- */
- public function __construct(array $entries = [], FlexDirectory $directory = null)
- {
- parent::__construct($entries);
- $this->_flexDirectory = $directory;
- $this->setKeyField(null);
- }
- /**
- * {@inheritdoc}
- * @see FlexCollectionInterface::search()
- */
- public function search(string $search, $properties = null, array $options = null)
- {
- return $this->__call('search', [$search, $properties, $options]);
- }
- /**
- * {@inheritdoc}
- * @see FlexCollectionInterface::sort()
- */
- public function sort(array $orderings)
- {
- return $this->orderBy($orderings);
- }
- /**
- * {@inheritdoc}
- * @see FlexCollectionInterface::filterBy()
- */
- public function filterBy(array $filters)
- {
- return $this->__call('filterBy', [$filters]);
- }
- /**
- * {@inheritdoc}
- * @see FlexCollectionInterface::getFlexType()
- */
- public function getFlexType(): string
- {
- return $this->_flexDirectory->getFlexType();
- }
- /**
- * {@inheritdoc}
- * @see FlexCollectionInterface::getFlexDirectory()
- */
- public function getFlexDirectory(): FlexDirectory
- {
- return $this->_flexDirectory;
- }
- /**
- * {@inheritdoc}
- * @see FlexCollectionInterface::getTimestamp()
- */
- public function getTimestamp(): int
- {
- $timestamps = $this->getTimestamps();
- return $timestamps ? max($timestamps) : time();
- }
- /**
- * {@inheritdoc}
- * @see FlexCollectionInterface::getCacheKey()
- */
- public function getCacheKey(): string
- {
- return $this->getTypePrefix() . $this->getFlexType() . '.' . sha1(json_encode($this->getKeys()) . $this->_keyField);
- }
- /**
- * {@inheritdoc}
- * @see FlexCollectionInterface::getCacheChecksum()
- */
- public function getCacheChecksum(): string
- {
- return sha1($this->getCacheKey() . json_encode($this->getTimestamps()));
- }
- /**
- * {@inheritdoc}
- * @see FlexCollectionInterface::getTimestamps()
- */
- public function getTimestamps(): array
- {
- return $this->getIndexMap('storage_timestamp');
- }
- /**
- * {@inheritdoc}
- * @see FlexCollectionInterface::getStorageKeys()
- */
- public function getStorageKeys(): array
- {
- return $this->getIndexMap('storage_key');
- }
- /**
- * {@inheritdoc}
- * @see FlexCollectionInterface::getFlexKeys()
- */
- public function getFlexKeys(): array
- {
- // Get storage keys for the objects.
- $keys = [];
- $type = $this->_flexDirectory->getFlexType() . '.obj:';
- foreach ($this->getEntries() as $key => $value) {
- $keys[$key] = $value['flex_key'] ?? $type . $value['storage_key'];
- }
- return $keys;
- }
- /**
- * {@inheritdoc}
- * @see FlexIndexInterface::withKeyField()
- */
- public function withKeyField(string $keyField = null)
- {
- $keyField = $keyField ?: 'key';
- if ($keyField === $this->getKeyField()) {
- return $this;
- }
- $type = $keyField === 'flex_key' ? $this->_flexDirectory->getFlexType() . '.obj:' : '';
- $entries = [];
- foreach ($this->getEntries() as $key => $value) {
- if (!isset($value['key'])) {
- $value['key'] = $key;
- }
- if (isset($value[$keyField])) {
- $entries[$value[$keyField]] = $value;
- } elseif ($keyField === 'flex_key') {
- $entries[$type . $value['storage_key']] = $value;
- }
- }
- return $this->createFrom($entries, $keyField);
- }
- /**
- * {@inheritdoc}
- * @see FlexCollectionInterface::getIndex()
- */
- public function getIndex()
- {
- return $this;
- }
- /**
- * {@inheritdoc}
- * @see FlexCollectionInterface::render()
- */
- public function render(string $layout = null, array $context = [])
- {
- return $this->__call('render', [$layout, $context]);
- }
- /**
- * @param bool $prefix
- * @return string
- * @deprecated 1.6 Use `->getFlexType()` instead.
- */
- public function getType($prefix = false)
- {
- user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.6, use ->getFlexType() method instead', E_USER_DEPRECATED);
- $type = $prefix ? $this->getTypePrefix() : '';
- return $type . $this->getFlexType();
- }
- /**
- * {@inheritdoc}
- * @see FlexIndexInterface::getFlexKeys()
- */
- public function getIndexMap(string $indexKey = null)
- {
- if (null === $indexKey) {
- return $this->getEntries();
- }
- // Get storage keys for the objects.
- $index = [];
- foreach ($this->getEntries() as $key => $value) {
- $index[$key] = $value[$indexKey] ?? null;
- }
- return $index;
- }
- /**
- * @return array
- */
- public function getMetaData(string $key): array
- {
- return $this->getEntries()[$key] ?? [];
- }
- /**
- * @return string
- */
- public function getKeyField() : string
- {
- return $this->_keyField ?? 'storage_key';
- }
- /**
- * @param string|null $namespace
- * @return CacheInterface
- */
- public function getCache(string $namespace = null)
- {
- return $this->_flexDirectory->getCache($namespace);
- }
- /**
- * @param array $orderings
- * @return FlexIndex|FlexCollection
- */
- public function orderBy(array $orderings)
- {
- if (!$orderings || !$this->count()) {
- return $this;
- }
- // Check if ordering needs to load the objects.
- if (array_diff_key($orderings, $this->getIndexKeys())) {
- return $this->__call('orderBy', [$orderings]);
- }
- // Ordering can be done by using index only.
- $previous = null;
- foreach (array_reverse($orderings) as $field => $ordering) {
- $field = (string)$field;
- if ($this->getKeyField() === $field) {
- $keys = $this->getKeys();
- $search = array_combine($keys, $keys) ?: [];
- } elseif ($field === 'flex_key') {
- $search = $this->getFlexKeys();
- } else {
- $search = $this->getIndexMap($field);
- }
- // Update current search to match the previous ordering.
- if (null !== $previous) {
- $search = array_replace($previous, $search);
- }
- // Order by current field.
- if ($ordering === 'DESC') {
- arsort($search, SORT_NATURAL);
- } else {
- asort($search, SORT_NATURAL);
- }
- $previous = $search;
- }
- return $this->createFrom(array_replace($previous, $this->getEntries()));
- }
- /**
- * {@inheritDoc}
- */
- public function call($method, array $arguments = [])
- {
- return $this->__call('call', [$method, $arguments]);
- }
- public function __call($name, $arguments)
- {
- /** @var Debugger $debugger */
- $debugger = Grav::instance()['debugger'];
- /** @var FlexCollection $className */
- $className = $this->_flexDirectory->getCollectionClass();
- $cachedMethods = $className::getCachedMethods();
- $flexType = $this->getFlexType();
- if (!empty($cachedMethods[$name])) {
- $type = $cachedMethods[$name];
- if ($type === 'session') {
- /** @var Session $session */
- $session = Grav::instance()['session'];
- $cacheKey = $session->getId() . $session->user->username;
- } else {
- $cacheKey = '';
- }
- $key = "{$flexType}.idx." . sha1($name . '.' . $cacheKey . json_encode($arguments) . $this->getCacheKey());
- $cache = $this->getCache('object');
- try {
- $result = $cache->get($key);
- // Make sure the keys aren't changed if the returned type is the same index type.
- if ($result instanceof self && $flexType === $result->getFlexType()) {
- $result = $result->withKeyField($this->getKeyField());
- }
- } catch (InvalidArgumentException $e) {
- /** @var Debugger $debugger */
- $debugger = Grav::instance()['debugger'];
- $debugger->addException($e);
- }
- if (!isset($result)) {
- $collection = $this->loadCollection();
- $result = $collection->{$name}(...$arguments);
- try {
- // If flex collection is returned, convert it back to flex index.
- if ($result instanceof FlexCollection) {
- $cached = $result->getFlexDirectory()->getIndex($result->getKeys(), $this->getKeyField());
- } else {
- $cached = $result;
- }
- $cache->set($key, $cached);
- } catch (InvalidArgumentException $e) {
- $debugger->addException($e);
- // TODO: log error.
- }
- }
- } else {
- $collection = $this->loadCollection();
- $result = $collection->{$name}(...$arguments);
- if (!isset($cachedMethods[$name])) {
- $class = \get_class($collection);
- $debugger->addMessage("Call '{$class}:{$name}()' isn't cached", 'debug');
- }
- }
- return $result;
- }
- /**
- * @return string
- */
- public function serialize()
- {
- return serialize(['type' => $this->getFlexType(), 'entries' => $this->getEntries()]);
- }
- /**
- * @param string $serialized
- */
- public function unserialize($serialized)
- {
- $data = unserialize($serialized, ['allowed_classes' => false]);
- $this->_flexDirectory = Grav::instance()['flex_objects']->getDirectory($data['type']);
- $this->setEntries($data['entries']);
- }
- /**
- * @param array $entries
- * @param string $keyField
- * @return static
- */
- protected function createFrom(array $entries, string $keyField = null)
- {
- $index = new static($entries, $this->_flexDirectory);
- $index->setKeyField($keyField ?? $this->_keyField);
- return $index;
- }
- /**
- * @param string|null $keyField
- */
- protected function setKeyField(string $keyField = null)
- {
- $this->_keyField = $keyField ?? 'storage_key';
- }
- protected function getIndexKeys()
- {
- if (null === $this->_indexKeys) {
- $entries = $this->getEntries();
- $first = reset($entries);
- if ($first) {
- $keys = array_keys($first);
- $keys = array_combine($keys, $keys) ?: [];
- } else {
- $keys = [];
- }
- $this->setIndexKeys($keys);
- }
- return $this->_indexKeys;
- }
- /**
- * @param array $indexKeys
- */
- protected function setIndexKeys(array $indexKeys)
- {
- // Add defaults.
- $indexKeys += [
- 'key' => 'key',
- 'storage_key' => 'storage_key',
- 'storage_timestamp' => 'storage_timestamp',
- 'flex_key' => 'flex_key'
- ];
- $this->_indexKeys = $indexKeys;
- }
- /**
- * @return string
- */
- protected function getTypePrefix()
- {
- return 'i.';
- }
- /**
- * @param string $key
- * @param mixed $value
- * @return ObjectInterface|null
- */
- protected function loadElement($key, $value): ?ObjectInterface
- {
- $objects = $this->_flexDirectory->loadObjects([$key => $value]);
- return $objects ? reset($objects): null;
- }
- /**
- * @param array|null $entries
- * @return ObjectInterface[]
- */
- protected function loadElements(array $entries = null): array
- {
- return $this->_flexDirectory->loadObjects($entries ?? $this->getEntries());
- }
- /**
- * @param array|null $entries
- * @return ObjectCollectionInterface
- */
- protected function loadCollection(array $entries = null): CollectionInterface
- {
- return $this->_flexDirectory->loadCollection($entries ?? $this->getEntries(), $this->_keyField);
- }
- /**
- * @param mixed $value
- * @return bool
- */
- protected function isAllowedElement($value): bool
- {
- return $value instanceof FlexObject;
- }
- /**
- * @param FlexObjectInterface $object
- * @return mixed
- */
- protected function getElementMeta($object)
- {
- return $object->getTimestamp();
- }
- /**
- * @param FlexStorageInterface $storage
- * @param array $index Saved index
- * @param array $entries Updated index
- * @return array Compiled list of entries
- */
- protected static function updateIndexFile(FlexStorageInterface $storage, array $index, array $entries): array
- {
- // Calculate removed objects.
- $removed = array_diff_key($index, $entries);
- // First get rid of all removed objects.
- if ($removed) {
- $index = array_diff_key($index, $removed);
- }
- if ($entries) {
- // Calculate difference between saved index and current data.
- foreach ($index as $key => $entry) {
- $storage_key = $entry['storage_key'] ?? null;
- if (isset($entries[$storage_key]) && $entries[$storage_key]['storage_timestamp'] === $entry['storage_timestamp']) {
- // Entry is up to date, no update needed.
- unset($entries[$storage_key]);
- }
- }
- if (empty($entries) && empty($removed)) {
- // No objects were added, updated or removed.
- return $index;
- }
- } elseif (!$removed) {
- // There are no objects and nothing was removed.
- return [];
- }
- // Index should be updated, lock the index file for saving.
- $indexFile = static::getIndexFile($storage);
- $indexFile->lock();
- // Read all the data rows into an array.
- $keys = array_fill_keys(array_keys($entries), null);
- $rows = $storage->readRows($keys);
- $keyField = $storage->getKeyField();
- // Go through all the updated objects and refresh their index data.
- $updated = $added = [];
- foreach ($rows as $key => $row) {
- if (null !== $row) {
- $entry = ['key' => $key] + $entries[$key];
- if ($keyField !== 'storage_key' && isset($row[$keyField])) {
- $entry['key'] = $row[$keyField];
- }
- static::updateIndexData($entry, $row);
- if (isset($row['__error'])) {
- $entry['__error'] = true;
- static::onException(new \RuntimeException(sprintf('Object failed to load: %s (%s)', $key, $row['__error'])));
- }
- if (isset($index[$key])) {
- // Update object in the index.
- $updated[$key] = $entry;
- } else {
- // Add object into the index.
- $added[$key] = $entry;
- }
- // Either way, update the entry.
- $index[$key] = $entry;
- } elseif (isset($index[$key])) {
- // Remove object from the index.
- $removed[$key] = $index[$key];
- unset($index[$key]);
- }
- }
- // Sort the index before saving it.
- ksort($index, SORT_NATURAL);
- static::onChanges($index, $added, $updated, $removed);
- $indexFile->save(['count' => \count($index), 'index' => $index]);
- $indexFile->unlock();
- return $index;
- }
- protected static function updateIndexData(array &$entry, array $data)
- {
- }
- protected static function loadEntriesFromIndex(FlexStorageInterface $storage)
- {
- $indexFile = static::getIndexFile($storage);
- $data = [];
- try {
- $data = (array)$indexFile->content();
- } catch (\Exception $e) {
- $e = new \RuntimeException(sprintf('Index failed to load: %s', $e->getMessage()), $e->getCode(), $e);
- static::onException($e);
- }
- return $data['index'] ?? [];
- }
- protected static function getIndexFile(FlexStorageInterface $storage)
- {
- // Load saved index file.
- $grav = Grav::instance();
- $locator = $grav['locator'];
- $filename = $locator->findResource($storage->getStoragePath() . '/index.yaml', true, true);
- return CompiledYamlFile::instance($filename);
- }
- protected static function onException(\Exception $e)
- {
- $grav = Grav::instance();
- /** @var Logger $logger */
- $logger = $grav['log'];
- $logger->addAlert($e->getMessage());
- /** @var Debugger $debugger */
- $debugger = $grav['debugger'];
- $debugger->addException($e);
- $debugger->addMessage($e, 'error');
- }
- protected static function onChanges(array $entries, array $added, array $updated, array $removed)
- {
- $message = sprintf('Index updated, %d objects (%d added, %d updated, %d removed).', \count($entries), \count($added), \count($updated), \count($removed));
- $grav = Grav::instance();
- /** @var Logger $logger */
- $logger = $grav['log'];
- $logger->addDebug($message);
- /** @var Debugger $debugger */
- $debugger = $grav['debugger'];
- $debugger->addMessage($message, 'debug');
- }
- public function __debugInfo()
- {
- return [
- 'type:private' => $this->getFlexType(),
- 'key:private' => $this->getKey(),
- 'entries_key:private' => $this->getKeyField(),
- 'entries:private' => $this->getEntries()
- ];
- }
- }
|