Loading core/core.services.yml +11 −0 Changes for core/core.services.yml: 11 added lines, 0 removed lines. Original line number Diff line number Diff line Loading @@ -41,6 +41,7 @@ parameters: exposedHeaders: false maxAge: false supportsCredentials: false tempstore.expire: 604800 services: # Simple cache contexts, directly derived from the request context. cache_context.ip: Loading Loading @@ -1650,3 +1651,13 @@ services: messenger: class: Drupal\Core\Messenger\Messenger arguments: ['@session.flash_bag', '@page_cache_kill_switch'] tempstore.private: class: Drupal\Core\TempStore\PrivateTempStoreFactory arguments: ['@keyvalue.expirable', '@lock', '@current_user', '@request_stack', '%tempstore.expire%'] tags: - { name: backend_overridable } tempstore.shared: class: Drupal\Core\TempStore\SharedTempStoreFactory arguments: ['@keyvalue.expirable', '@lock', '@request_stack', '%tempstore.expire%'] tags: - { name: backend_overridable } core/lib/Drupal/Core/Session/SessionManager.php +3 −2 Changes for core/lib/Drupal/Core/Session/SessionManager.php: 3 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -120,8 +120,9 @@ public function start() { if (empty($result)) { // Randomly generate a session identifier for this request. This is // necessary because \Drupal\user\SharedTempStoreFactory::get() wants to // know the future session ID of a lazily started session in advance. // necessary because \Drupal\Core\TempStore\SharedTempStoreFactory::get() // wants to know the future session ID of a lazily started session in // advance. // // @todo: With current versions of PHP there is little reason to generate // the session id from within application code. Consider using the Loading core/lib/Drupal/Core/TempStore/PrivateTempStore.php 0 → 100644 +213 −0 Changes for core/lib/Drupal/Core/TempStore/PrivateTempStore.php: 213 added lines, 0 removed lines. Original line number Diff line number Diff line <?php namespace Drupal\Core\TempStore; use Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface; use Drupal\Core\Lock\LockBackendInterface; use Drupal\Core\Session\AccountProxyInterface; use Symfony\Component\HttpFoundation\RequestStack; /** * Stores and retrieves temporary data for a given owner. * * A PrivateTempStore can be used to make temporary, non-cache data available * across requests. The data for the PrivateTempStore is stored in one * key/value collection. PrivateTempStore data expires automatically after a * given timeframe. * * The PrivateTempStore is different from a cache, because the data in it is not * yet saved permanently and so it cannot be rebuilt. Typically, the * PrivateTempStore might be used to store work in progress that is later saved * permanently elsewhere, e.g. autosave data, multistep forms, or in-progress * changes to complex configuration that are not ready to be saved. * * The PrivateTempStore differs from the SharedTempStore in that all keys are * ensured to be unique for a particular user and users can never share data. If * you want to be able to share data between users or use it for locking, use * \Drupal\Core\TempStore\SharedTempStore. */ class PrivateTempStore { /** * The key/value storage object used for this data. * * @var \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface */ protected $storage; /** * The lock object used for this data. * * @var \Drupal\Core\Lock\LockBackendInterface */ protected $lockBackend; /** * The current user. * * @var \Drupal\Core\Session\AccountProxyInterface */ protected $currentUser; /** * The request stack. * * @var \Symfony\Component\HttpFoundation\RequestStack */ protected $requestStack; /** * The time to live for items in seconds. * * By default, data is stored for one week (604800 seconds) before expiring. * * @var int */ protected $expire; /** * Constructs a new object for accessing data from a key/value store. * * @param \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface $storage * The key/value storage object used for this data. Each storage object * represents a particular collection of data and will contain any number * of key/value pairs. * @param \Drupal\Core\Lock\LockBackendInterface $lock_backend * The lock object used for this data. * @param \Drupal\Core\Session\AccountProxyInterface $current_user * The current user account. * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack * The request stack. * @param int $expire * The time to live for items, in seconds. */ public function __construct(KeyValueStoreExpirableInterface $storage, LockBackendInterface $lock_backend, AccountProxyInterface $current_user, RequestStack $request_stack, $expire = 604800) { $this->storage = $storage; $this->lockBackend = $lock_backend; $this->currentUser = $current_user; $this->requestStack = $request_stack; $this->expire = $expire; } /** * Retrieves a value from this PrivateTempStore for a given key. * * @param string $key * The key of the data to retrieve. * * @return mixed * The data associated with the key, or NULL if the key does not exist. */ public function get($key) { $key = $this->createkey($key); if (($object = $this->storage->get($key)) && ($object->owner == $this->getOwner())) { return $object->data; } } /** * Stores a particular key/value pair in this PrivateTempStore. * * @param string $key * The key of the data to store. * @param mixed $value * The data to store. * * @throws \Drupal\Core\TempStore\TempStoreException * Thrown when a lock for the backend storage could not be acquired. */ public function set($key, $value) { $key = $this->createkey($key); if (!$this->lockBackend->acquire($key)) { $this->lockBackend->wait($key); if (!$this->lockBackend->acquire($key)) { throw new TempStoreException("Couldn't acquire lock to update item '$key' in '{$this->storage->getCollectionName()}' temporary storage."); } } $value = (object) [ 'owner' => $this->getOwner(), 'data' => $value, 'updated' => (int) $this->requestStack->getMasterRequest()->server->get('REQUEST_TIME'), ]; $this->storage->setWithExpire($key, $value, $this->expire); $this->lockBackend->release($key); } /** * Returns the metadata associated with a particular key/value pair. * * @param string $key * The key of the data to store. * * @return mixed * An object with the owner and updated time if the key has a value, or * NULL otherwise. */ public function getMetadata($key) { $key = $this->createkey($key); // Fetch the key/value pair and its metadata. $object = $this->storage->get($key); if ($object) { // Don't keep the data itself in memory. unset($object->data); return $object; } } /** * Deletes data from the store for a given key and releases the lock on it. * * @param string $key * The key of the data to delete. * * @return bool * TRUE if the object was deleted or does not exist, FALSE if it exists but * is not owned by $this->owner. * * @throws \Drupal\Core\TempStore\TempStoreException * Thrown when a lock for the backend storage could not be acquired. */ public function delete($key) { $key = $this->createkey($key); if (!$object = $this->storage->get($key)) { return TRUE; } elseif ($object->owner != $this->getOwner()) { return FALSE; } if (!$this->lockBackend->acquire($key)) { $this->lockBackend->wait($key); if (!$this->lockBackend->acquire($key)) { throw new TempStoreException("Couldn't acquire lock to delete item '$key' from '{$this->storage->getCollectionName()}' temporary storage."); } } $this->storage->delete($key); $this->lockBackend->release($key); return TRUE; } /** * Ensures that the key is unique for a user. * * @param string $key * The key. * * @return string * The unique key for the user. */ protected function createkey($key) { return $this->getOwner() . ':' . $key; } /** * Gets the current owner based on the current user or the session ID. * * @return string * The owner. */ protected function getOwner() { return $this->currentUser->id() ?: $this->requestStack->getCurrentRequest()->getSession()->getId(); } } core/lib/Drupal/Core/TempStore/PrivateTempStoreFactory.php 0 → 100644 +88 −0 Changes for core/lib/Drupal/Core/TempStore/PrivateTempStoreFactory.php: 88 added lines, 0 removed lines. Original line number Diff line number Diff line <?php namespace Drupal\Core\TempStore; use Drupal\Core\KeyValueStore\KeyValueExpirableFactoryInterface; use Drupal\Core\Lock\LockBackendInterface; use Drupal\Core\Session\AccountProxyInterface; use Symfony\Component\HttpFoundation\RequestStack; /** * Creates a PrivateTempStore object for a given collection. */ class PrivateTempStoreFactory { /** * The storage factory creating the backend to store the data. * * @var \Drupal\Core\KeyValueStore\KeyValueExpirableFactoryInterface */ protected $storageFactory; /** * The lock object used for this data. * * @var \Drupal\Core\Lock\LockBackendInterface */ protected $lockBackend; /** * The current user. * * @var \Drupal\Core\Session\AccountProxyInterface */ protected $currentUser; /** * The request stack. * * @var \Symfony\Component\HttpFoundation\RequestStack */ protected $requestStack; /** * The time to live for items in seconds. * * @var int */ protected $expire; /** * Constructs a Drupal\Core\TempStore\PrivateTempStoreFactory object. * * @param \Drupal\Core\KeyValueStore\KeyValueExpirableFactoryInterface $storage_factory * The key/value store factory. * @param \Drupal\Core\Lock\LockBackendInterface $lock_backend * The lock object used for this data. * @param \Drupal\Core\Session\AccountProxyInterface $current_user * The current account. * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack * The request stack. * @param int $expire * The time to live for items, in seconds. */ public function __construct(KeyValueExpirableFactoryInterface $storage_factory, LockBackendInterface $lock_backend, AccountProxyInterface $current_user, RequestStack $request_stack, $expire = 604800) { $this->storageFactory = $storage_factory; $this->lockBackend = $lock_backend; $this->currentUser = $current_user; $this->requestStack = $request_stack; $this->expire = $expire; } /** * Creates a PrivateTempStore. * * @param string $collection * The collection name to use for this key/value store. This is typically * a shared namespace or module name, e.g. 'views', 'entity', etc. * * @return \Drupal\Core\TempStore\PrivateTempStore * An instance of the key/value store. */ public function get($collection) { // Store the data for this collection in the database. $storage = $this->storageFactory->get("tempstore.private.$collection"); return new PrivateTempStore($storage, $this->lockBackend, $this->currentUser, $this->requestStack, $this->expire); } } core/lib/Drupal/Core/TempStore/SharedTempStore.php 0 → 100644 +279 −0 Changes for core/lib/Drupal/Core/TempStore/SharedTempStore.php: 279 added lines, 0 removed lines. Original line number Diff line number Diff line <?php namespace Drupal\Core\TempStore; use Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface; use Drupal\Core\Lock\LockBackendInterface; use Symfony\Component\HttpFoundation\RequestStack; /** * Stores and retrieves temporary data for a given owner. * * A SharedTempStore can be used to make temporary, non-cache data available * across requests. The data for the SharedTempStore is stored in one key/value * collection. SharedTempStore data expires automatically after a given * timeframe. * * The SharedTempStore is different from a cache, because the data in it is not * yet saved permanently and so it cannot be rebuilt. Typically, the * SharedTempStore might be used to store work in progress that is later saved * permanently elsewhere, e.g. autosave data, multistep forms, or in-progress * changes to complex configuration that are not ready to be saved. * * Each SharedTempStore belongs to a particular owner (e.g. a user, session, or * process). Multiple owners may use the same key/value collection, and the * owner is stored along with the key/value pair. * * Every key is unique within the collection, so the SharedTempStore can check * whether a particular key is already set by a different owner. This is * useful for informing one owner that the data is already in use by another; * for example, to let one user know that another user is in the process of * editing certain data, or even to restrict other users from editing it at * the same time. It is the responsibility of the implementation to decide * when and whether one owner can use or update another owner's data. * * If you want to be able to ensure that the data belongs to the current user, * use \Drupal\Core\TempStore\PrivateTempStore. */ class SharedTempStore { /** * The key/value storage object used for this data. * * @var \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface */ protected $storage; /** * The lock object used for this data. * * @var \Drupal\Core\Lock\LockBackendInterface */ protected $lockBackend; /** * The request stack. * * @var \Symfony\Component\HttpFoundation\RequestStack */ protected $requestStack; /** * The owner key to store along with the data (e.g. a user or session ID). * * @var mixed */ protected $owner; /** * The time to live for items in seconds. * * By default, data is stored for one week (604800 seconds) before expiring. * * @var int */ protected $expire; /** * Constructs a new object for accessing data from a key/value store. * * @param \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface $storage * The key/value storage object used for this data. Each storage object * represents a particular collection of data and will contain any number * of key/value pairs. * @param \Drupal\Core\Lock\LockBackendInterface $lock_backend * The lock object used for this data. * @param mixed $owner * The owner key to store along with the data (e.g. a user or session ID). * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack * The request stack. * @param int $expire * The time to live for items, in seconds. */ public function __construct(KeyValueStoreExpirableInterface $storage, LockBackendInterface $lock_backend, $owner, RequestStack $request_stack, $expire = 604800) { $this->storage = $storage; $this->lockBackend = $lock_backend; $this->owner = $owner; $this->requestStack = $request_stack; $this->expire = $expire; } /** * Retrieves a value from this SharedTempStore for a given key. * * @param string $key * The key of the data to retrieve. * * @return mixed * The data associated with the key, or NULL if the key does not exist. */ public function get($key) { if ($object = $this->storage->get($key)) { return $object->data; } } /** * Retrieves a value from this SharedTempStore for a given key. * * Only returns the value if the value is owned by $this->owner. * * @param string $key * The key of the data to retrieve. * * @return mixed * The data associated with the key, or NULL if the key does not exist. */ public function getIfOwner($key) { if (($object = $this->storage->get($key)) && ($object->owner == $this->owner)) { return $object->data; } } /** * Stores a particular key/value pair only if the key doesn't already exist. * * @param string $key * The key of the data to check and store. * @param mixed $value * The data to store. * * @return bool * TRUE if the data was set, or FALSE if it already existed. */ public function setIfNotExists($key, $value) { $value = (object) [ 'owner' => $this->owner, 'data' => $value, 'updated' => (int) $this->requestStack->getMasterRequest()->server->get('REQUEST_TIME'), ]; return $this->storage->setWithExpireIfNotExists($key, $value, $this->expire); } /** * Stores a particular key/value pair in this SharedTempStore. * * Only stores the given key/value pair if it does not exist yet or is owned * by $this->owner. * * @param string $key * The key of the data to store. * @param mixed $value * The data to store. * * @return bool * TRUE if the data was set, or FALSE if it already exists and is not owned * by $this->user. * * @throws \Drupal\Core\TempStore\TempStoreException * Thrown when a lock for the backend storage could not be acquired. */ public function setIfOwner($key, $value) { if ($this->setIfNotExists($key, $value)) { return TRUE; } if (($object = $this->storage->get($key)) && ($object->owner == $this->owner)) { $this->set($key, $value); return TRUE; } return FALSE; } /** * Stores a particular key/value pair in this SharedTempStore. * * @param string $key * The key of the data to store. * @param mixed $value * The data to store. * * @throws \Drupal\Core\TempStore\TempStoreException * Thrown when a lock for the backend storage could not be acquired. */ public function set($key, $value) { if (!$this->lockBackend->acquire($key)) { $this->lockBackend->wait($key); if (!$this->lockBackend->acquire($key)) { throw new TempStoreException("Couldn't acquire lock to update item '$key' in '{$this->storage->getCollectionName()}' temporary storage."); } } $value = (object) [ 'owner' => $this->owner, 'data' => $value, 'updated' => (int) $this->requestStack->getMasterRequest()->server->get('REQUEST_TIME'), ]; $this->storage->setWithExpire($key, $value, $this->expire); $this->lockBackend->release($key); } /** * Returns the metadata associated with a particular key/value pair. * * @param string $key * The key of the data to store. * * @return mixed * An object with the owner and updated time if the key has a value, or * NULL otherwise. */ public function getMetadata($key) { // Fetch the key/value pair and its metadata. $object = $this->storage->get($key); if ($object) { // Don't keep the data itself in memory. unset($object->data); return $object; } } /** * Deletes data from the store for a given key and releases the lock on it. * * @param string $key * The key of the data to delete. * * @throws \Drupal\Core\TempStore\TempStoreException * Thrown when a lock for the backend storage could not be acquired. */ public function delete($key) { if (!$this->lockBackend->acquire($key)) { $this->lockBackend->wait($key); if (!$this->lockBackend->acquire($key)) { throw new TempStoreException("Couldn't acquire lock to delete item '$key' from {$this->storage->getCollectionName()} temporary storage."); } } $this->storage->delete($key); $this->lockBackend->release($key); } /** * Deletes data from the store for a given key and releases the lock on it. * * Only delete the given key if it is owned by $this->owner. * * @param string $key * The key of the data to delete. * * @return bool * TRUE if the object was deleted or does not exist, FALSE if it exists but * is not owned by $this->owner. * * @throws \Drupal\Core\TempStore\TempStoreException * Thrown when a lock for the backend storage could not be acquired. */ public function deleteIfOwner($key) { if (!$object = $this->storage->get($key)) { return TRUE; } elseif ($object->owner == $this->owner) { $this->delete($key); return TRUE; } return FALSE; } } Loading
core/core.services.yml +11 −0 Changes for core/core.services.yml: 11 added lines, 0 removed lines. Original line number Diff line number Diff line Loading @@ -41,6 +41,7 @@ parameters: exposedHeaders: false maxAge: false supportsCredentials: false tempstore.expire: 604800 services: # Simple cache contexts, directly derived from the request context. cache_context.ip: Loading Loading @@ -1650,3 +1651,13 @@ services: messenger: class: Drupal\Core\Messenger\Messenger arguments: ['@session.flash_bag', '@page_cache_kill_switch'] tempstore.private: class: Drupal\Core\TempStore\PrivateTempStoreFactory arguments: ['@keyvalue.expirable', '@lock', '@current_user', '@request_stack', '%tempstore.expire%'] tags: - { name: backend_overridable } tempstore.shared: class: Drupal\Core\TempStore\SharedTempStoreFactory arguments: ['@keyvalue.expirable', '@lock', '@request_stack', '%tempstore.expire%'] tags: - { name: backend_overridable }
core/lib/Drupal/Core/Session/SessionManager.php +3 −2 Changes for core/lib/Drupal/Core/Session/SessionManager.php: 3 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -120,8 +120,9 @@ public function start() { if (empty($result)) { // Randomly generate a session identifier for this request. This is // necessary because \Drupal\user\SharedTempStoreFactory::get() wants to // know the future session ID of a lazily started session in advance. // necessary because \Drupal\Core\TempStore\SharedTempStoreFactory::get() // wants to know the future session ID of a lazily started session in // advance. // // @todo: With current versions of PHP there is little reason to generate // the session id from within application code. Consider using the Loading
core/lib/Drupal/Core/TempStore/PrivateTempStore.php 0 → 100644 +213 −0 Changes for core/lib/Drupal/Core/TempStore/PrivateTempStore.php: 213 added lines, 0 removed lines. Original line number Diff line number Diff line <?php namespace Drupal\Core\TempStore; use Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface; use Drupal\Core\Lock\LockBackendInterface; use Drupal\Core\Session\AccountProxyInterface; use Symfony\Component\HttpFoundation\RequestStack; /** * Stores and retrieves temporary data for a given owner. * * A PrivateTempStore can be used to make temporary, non-cache data available * across requests. The data for the PrivateTempStore is stored in one * key/value collection. PrivateTempStore data expires automatically after a * given timeframe. * * The PrivateTempStore is different from a cache, because the data in it is not * yet saved permanently and so it cannot be rebuilt. Typically, the * PrivateTempStore might be used to store work in progress that is later saved * permanently elsewhere, e.g. autosave data, multistep forms, or in-progress * changes to complex configuration that are not ready to be saved. * * The PrivateTempStore differs from the SharedTempStore in that all keys are * ensured to be unique for a particular user and users can never share data. If * you want to be able to share data between users or use it for locking, use * \Drupal\Core\TempStore\SharedTempStore. */ class PrivateTempStore { /** * The key/value storage object used for this data. * * @var \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface */ protected $storage; /** * The lock object used for this data. * * @var \Drupal\Core\Lock\LockBackendInterface */ protected $lockBackend; /** * The current user. * * @var \Drupal\Core\Session\AccountProxyInterface */ protected $currentUser; /** * The request stack. * * @var \Symfony\Component\HttpFoundation\RequestStack */ protected $requestStack; /** * The time to live for items in seconds. * * By default, data is stored for one week (604800 seconds) before expiring. * * @var int */ protected $expire; /** * Constructs a new object for accessing data from a key/value store. * * @param \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface $storage * The key/value storage object used for this data. Each storage object * represents a particular collection of data and will contain any number * of key/value pairs. * @param \Drupal\Core\Lock\LockBackendInterface $lock_backend * The lock object used for this data. * @param \Drupal\Core\Session\AccountProxyInterface $current_user * The current user account. * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack * The request stack. * @param int $expire * The time to live for items, in seconds. */ public function __construct(KeyValueStoreExpirableInterface $storage, LockBackendInterface $lock_backend, AccountProxyInterface $current_user, RequestStack $request_stack, $expire = 604800) { $this->storage = $storage; $this->lockBackend = $lock_backend; $this->currentUser = $current_user; $this->requestStack = $request_stack; $this->expire = $expire; } /** * Retrieves a value from this PrivateTempStore for a given key. * * @param string $key * The key of the data to retrieve. * * @return mixed * The data associated with the key, or NULL if the key does not exist. */ public function get($key) { $key = $this->createkey($key); if (($object = $this->storage->get($key)) && ($object->owner == $this->getOwner())) { return $object->data; } } /** * Stores a particular key/value pair in this PrivateTempStore. * * @param string $key * The key of the data to store. * @param mixed $value * The data to store. * * @throws \Drupal\Core\TempStore\TempStoreException * Thrown when a lock for the backend storage could not be acquired. */ public function set($key, $value) { $key = $this->createkey($key); if (!$this->lockBackend->acquire($key)) { $this->lockBackend->wait($key); if (!$this->lockBackend->acquire($key)) { throw new TempStoreException("Couldn't acquire lock to update item '$key' in '{$this->storage->getCollectionName()}' temporary storage."); } } $value = (object) [ 'owner' => $this->getOwner(), 'data' => $value, 'updated' => (int) $this->requestStack->getMasterRequest()->server->get('REQUEST_TIME'), ]; $this->storage->setWithExpire($key, $value, $this->expire); $this->lockBackend->release($key); } /** * Returns the metadata associated with a particular key/value pair. * * @param string $key * The key of the data to store. * * @return mixed * An object with the owner and updated time if the key has a value, or * NULL otherwise. */ public function getMetadata($key) { $key = $this->createkey($key); // Fetch the key/value pair and its metadata. $object = $this->storage->get($key); if ($object) { // Don't keep the data itself in memory. unset($object->data); return $object; } } /** * Deletes data from the store for a given key and releases the lock on it. * * @param string $key * The key of the data to delete. * * @return bool * TRUE if the object was deleted or does not exist, FALSE if it exists but * is not owned by $this->owner. * * @throws \Drupal\Core\TempStore\TempStoreException * Thrown when a lock for the backend storage could not be acquired. */ public function delete($key) { $key = $this->createkey($key); if (!$object = $this->storage->get($key)) { return TRUE; } elseif ($object->owner != $this->getOwner()) { return FALSE; } if (!$this->lockBackend->acquire($key)) { $this->lockBackend->wait($key); if (!$this->lockBackend->acquire($key)) { throw new TempStoreException("Couldn't acquire lock to delete item '$key' from '{$this->storage->getCollectionName()}' temporary storage."); } } $this->storage->delete($key); $this->lockBackend->release($key); return TRUE; } /** * Ensures that the key is unique for a user. * * @param string $key * The key. * * @return string * The unique key for the user. */ protected function createkey($key) { return $this->getOwner() . ':' . $key; } /** * Gets the current owner based on the current user or the session ID. * * @return string * The owner. */ protected function getOwner() { return $this->currentUser->id() ?: $this->requestStack->getCurrentRequest()->getSession()->getId(); } }
core/lib/Drupal/Core/TempStore/PrivateTempStoreFactory.php 0 → 100644 +88 −0 Changes for core/lib/Drupal/Core/TempStore/PrivateTempStoreFactory.php: 88 added lines, 0 removed lines. Original line number Diff line number Diff line <?php namespace Drupal\Core\TempStore; use Drupal\Core\KeyValueStore\KeyValueExpirableFactoryInterface; use Drupal\Core\Lock\LockBackendInterface; use Drupal\Core\Session\AccountProxyInterface; use Symfony\Component\HttpFoundation\RequestStack; /** * Creates a PrivateTempStore object for a given collection. */ class PrivateTempStoreFactory { /** * The storage factory creating the backend to store the data. * * @var \Drupal\Core\KeyValueStore\KeyValueExpirableFactoryInterface */ protected $storageFactory; /** * The lock object used for this data. * * @var \Drupal\Core\Lock\LockBackendInterface */ protected $lockBackend; /** * The current user. * * @var \Drupal\Core\Session\AccountProxyInterface */ protected $currentUser; /** * The request stack. * * @var \Symfony\Component\HttpFoundation\RequestStack */ protected $requestStack; /** * The time to live for items in seconds. * * @var int */ protected $expire; /** * Constructs a Drupal\Core\TempStore\PrivateTempStoreFactory object. * * @param \Drupal\Core\KeyValueStore\KeyValueExpirableFactoryInterface $storage_factory * The key/value store factory. * @param \Drupal\Core\Lock\LockBackendInterface $lock_backend * The lock object used for this data. * @param \Drupal\Core\Session\AccountProxyInterface $current_user * The current account. * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack * The request stack. * @param int $expire * The time to live for items, in seconds. */ public function __construct(KeyValueExpirableFactoryInterface $storage_factory, LockBackendInterface $lock_backend, AccountProxyInterface $current_user, RequestStack $request_stack, $expire = 604800) { $this->storageFactory = $storage_factory; $this->lockBackend = $lock_backend; $this->currentUser = $current_user; $this->requestStack = $request_stack; $this->expire = $expire; } /** * Creates a PrivateTempStore. * * @param string $collection * The collection name to use for this key/value store. This is typically * a shared namespace or module name, e.g. 'views', 'entity', etc. * * @return \Drupal\Core\TempStore\PrivateTempStore * An instance of the key/value store. */ public function get($collection) { // Store the data for this collection in the database. $storage = $this->storageFactory->get("tempstore.private.$collection"); return new PrivateTempStore($storage, $this->lockBackend, $this->currentUser, $this->requestStack, $this->expire); } }
core/lib/Drupal/Core/TempStore/SharedTempStore.php 0 → 100644 +279 −0 Changes for core/lib/Drupal/Core/TempStore/SharedTempStore.php: 279 added lines, 0 removed lines. Original line number Diff line number Diff line <?php namespace Drupal\Core\TempStore; use Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface; use Drupal\Core\Lock\LockBackendInterface; use Symfony\Component\HttpFoundation\RequestStack; /** * Stores and retrieves temporary data for a given owner. * * A SharedTempStore can be used to make temporary, non-cache data available * across requests. The data for the SharedTempStore is stored in one key/value * collection. SharedTempStore data expires automatically after a given * timeframe. * * The SharedTempStore is different from a cache, because the data in it is not * yet saved permanently and so it cannot be rebuilt. Typically, the * SharedTempStore might be used to store work in progress that is later saved * permanently elsewhere, e.g. autosave data, multistep forms, or in-progress * changes to complex configuration that are not ready to be saved. * * Each SharedTempStore belongs to a particular owner (e.g. a user, session, or * process). Multiple owners may use the same key/value collection, and the * owner is stored along with the key/value pair. * * Every key is unique within the collection, so the SharedTempStore can check * whether a particular key is already set by a different owner. This is * useful for informing one owner that the data is already in use by another; * for example, to let one user know that another user is in the process of * editing certain data, or even to restrict other users from editing it at * the same time. It is the responsibility of the implementation to decide * when and whether one owner can use or update another owner's data. * * If you want to be able to ensure that the data belongs to the current user, * use \Drupal\Core\TempStore\PrivateTempStore. */ class SharedTempStore { /** * The key/value storage object used for this data. * * @var \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface */ protected $storage; /** * The lock object used for this data. * * @var \Drupal\Core\Lock\LockBackendInterface */ protected $lockBackend; /** * The request stack. * * @var \Symfony\Component\HttpFoundation\RequestStack */ protected $requestStack; /** * The owner key to store along with the data (e.g. a user or session ID). * * @var mixed */ protected $owner; /** * The time to live for items in seconds. * * By default, data is stored for one week (604800 seconds) before expiring. * * @var int */ protected $expire; /** * Constructs a new object for accessing data from a key/value store. * * @param \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface $storage * The key/value storage object used for this data. Each storage object * represents a particular collection of data and will contain any number * of key/value pairs. * @param \Drupal\Core\Lock\LockBackendInterface $lock_backend * The lock object used for this data. * @param mixed $owner * The owner key to store along with the data (e.g. a user or session ID). * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack * The request stack. * @param int $expire * The time to live for items, in seconds. */ public function __construct(KeyValueStoreExpirableInterface $storage, LockBackendInterface $lock_backend, $owner, RequestStack $request_stack, $expire = 604800) { $this->storage = $storage; $this->lockBackend = $lock_backend; $this->owner = $owner; $this->requestStack = $request_stack; $this->expire = $expire; } /** * Retrieves a value from this SharedTempStore for a given key. * * @param string $key * The key of the data to retrieve. * * @return mixed * The data associated with the key, or NULL if the key does not exist. */ public function get($key) { if ($object = $this->storage->get($key)) { return $object->data; } } /** * Retrieves a value from this SharedTempStore for a given key. * * Only returns the value if the value is owned by $this->owner. * * @param string $key * The key of the data to retrieve. * * @return mixed * The data associated with the key, or NULL if the key does not exist. */ public function getIfOwner($key) { if (($object = $this->storage->get($key)) && ($object->owner == $this->owner)) { return $object->data; } } /** * Stores a particular key/value pair only if the key doesn't already exist. * * @param string $key * The key of the data to check and store. * @param mixed $value * The data to store. * * @return bool * TRUE if the data was set, or FALSE if it already existed. */ public function setIfNotExists($key, $value) { $value = (object) [ 'owner' => $this->owner, 'data' => $value, 'updated' => (int) $this->requestStack->getMasterRequest()->server->get('REQUEST_TIME'), ]; return $this->storage->setWithExpireIfNotExists($key, $value, $this->expire); } /** * Stores a particular key/value pair in this SharedTempStore. * * Only stores the given key/value pair if it does not exist yet or is owned * by $this->owner. * * @param string $key * The key of the data to store. * @param mixed $value * The data to store. * * @return bool * TRUE if the data was set, or FALSE if it already exists and is not owned * by $this->user. * * @throws \Drupal\Core\TempStore\TempStoreException * Thrown when a lock for the backend storage could not be acquired. */ public function setIfOwner($key, $value) { if ($this->setIfNotExists($key, $value)) { return TRUE; } if (($object = $this->storage->get($key)) && ($object->owner == $this->owner)) { $this->set($key, $value); return TRUE; } return FALSE; } /** * Stores a particular key/value pair in this SharedTempStore. * * @param string $key * The key of the data to store. * @param mixed $value * The data to store. * * @throws \Drupal\Core\TempStore\TempStoreException * Thrown when a lock for the backend storage could not be acquired. */ public function set($key, $value) { if (!$this->lockBackend->acquire($key)) { $this->lockBackend->wait($key); if (!$this->lockBackend->acquire($key)) { throw new TempStoreException("Couldn't acquire lock to update item '$key' in '{$this->storage->getCollectionName()}' temporary storage."); } } $value = (object) [ 'owner' => $this->owner, 'data' => $value, 'updated' => (int) $this->requestStack->getMasterRequest()->server->get('REQUEST_TIME'), ]; $this->storage->setWithExpire($key, $value, $this->expire); $this->lockBackend->release($key); } /** * Returns the metadata associated with a particular key/value pair. * * @param string $key * The key of the data to store. * * @return mixed * An object with the owner and updated time if the key has a value, or * NULL otherwise. */ public function getMetadata($key) { // Fetch the key/value pair and its metadata. $object = $this->storage->get($key); if ($object) { // Don't keep the data itself in memory. unset($object->data); return $object; } } /** * Deletes data from the store for a given key and releases the lock on it. * * @param string $key * The key of the data to delete. * * @throws \Drupal\Core\TempStore\TempStoreException * Thrown when a lock for the backend storage could not be acquired. */ public function delete($key) { if (!$this->lockBackend->acquire($key)) { $this->lockBackend->wait($key); if (!$this->lockBackend->acquire($key)) { throw new TempStoreException("Couldn't acquire lock to delete item '$key' from {$this->storage->getCollectionName()} temporary storage."); } } $this->storage->delete($key); $this->lockBackend->release($key); } /** * Deletes data from the store for a given key and releases the lock on it. * * Only delete the given key if it is owned by $this->owner. * * @param string $key * The key of the data to delete. * * @return bool * TRUE if the object was deleted or does not exist, FALSE if it exists but * is not owned by $this->owner. * * @throws \Drupal\Core\TempStore\TempStoreException * Thrown when a lock for the backend storage could not be acquired. */ public function deleteIfOwner($key) { if (!$object = $this->storage->get($key)) { return TRUE; } elseif ($object->owner == $this->owner) { $this->delete($key); return TRUE; } return FALSE; } }
