class TrafficRegistry in URLs queuer 8

Provides a database-driven traffic registry with URLs and tags.

Hierarchy

• class \Drupal\Core\DependencyInjection\ServiceProviderBase implements ServiceModifierInterface, ServiceProviderInterface
  • class \Drupal\purge_queuer_url\TrafficRegistry implements TrafficRegistryInterface

1 string reference to 'TrafficRegistry'

purge_queuer_url.services.yml in ./purge_queuer_url.services.yml

purge_queuer_url.services.yml

1 service uses TrafficRegistry

purge_queuer_url.registry in ./purge_queuer_url.services.yml

Drupal\purge_queuer_url\TrafficRegistry

File

src/TrafficRegistry.php, line 12

Namespace

Drupal\purge_queuer_url

class TrafficRegistry extends ServiceProviderBase implements TrafficRegistryInterface {

  /**
   * The active database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * Constructs a TrafficRegistry object.
   *
   * @param \Drupal\Core\Database\Connection $connection
   *   The active database connection.
   */
  public function __construct(Connection $connection) {
    $this->connection = $connection;
  }

  /**
   * {@inheritdoc}
   */
  public function add($url_or_path, array $tags) {
    if (!$this->connection
      ->schema()
      ->tableExists('purge_queuer_url')) {
      return;
    }
    if (empty($tags)) {
      throw new \LogicException('$tags cannot be empty!');
    }

    // Sometimes Drupal generates ridiculously long URLs that pass well over the
    // VARCHAR max length of 255, for example with the ?redirect parameters. We
    // dismiss these URLs here, as using bigger datatypes ain't worth the
    // trade-off and would make this module even more expensive to use.
    if (strlen($url_or_path) > 255) {
      return;
    }

    // Build a list of tag IDs by adding and or selecting them from the db.
    $tag_ids = ';' . implode(';', array_keys($this
      ->getTagIds($tags)));

    // Insert or update the URL with the shortened list of tag ids.
    $fields = [
      'url' => $url_or_path,
      'tag_ids' => $tag_ids,
    ];
    $this->connection
      ->merge('purge_queuer_url')
      ->insertFields($fields)
      ->updateFields($fields)
      ->key([
      'url' => $url_or_path,
    ])
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function remove($url_or_path) {
    if (!$this->connection
      ->schema()
      ->tableExists('purge_queuer_url')) {
      return;
    }
    if (empty(trim($url_or_path))) {
      return;
    }
    $this->connection
      ->delete('purge_queuer_url')
      ->condition('url', $url_or_path)
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function clear() {
    if ($this->connection
      ->schema()
      ->tableExists('purge_queuer_url')) {
      $this->connection
        ->delete('purge_queuer_url')
        ->execute();
    }
    if ($this->connection
      ->schema()
      ->tableExists('purge_queuer_url_tag')) {
      $this->connection
        ->delete('purge_queuer_url_tag')
        ->execute();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function countUrls() {
    if (!$this->connection
      ->schema()
      ->tableExists('purge_queuer_url')) {
      return 0;
    }
    return (int) $this->connection
      ->select('purge_queuer_url')
      ->fields(NULL, [
      'field',
    ])
      ->countQuery()
      ->execute()
      ->fetchField();
  }

  /**
   * {@inheritdoc}
   */
  public function getUrls(array $tags) {
    if (!$this->connection
      ->schema()
      ->tableExists('purge_queuer_url')) {
      return [];
    }
    if (empty($tags)) {
      throw new \LogicException('$tags cannot be empty!');
    }

    // Retrieve tag IDs but without adding new ones.
    $tag_ids = array_keys($this
      ->getTagIds($tags, FALSE));

    // Don't return any URLs when no tags actually exist.
    if (empty($tag_ids)) {
      return [];
    }

    // Build a OR condition with LIKES on tag_ids for every tag.
    $or = new Condition('OR');
    foreach ($tag_ids as $tag_id) {
      $syntax = '%;' . $this->connection
        ->escapeLike($tag_id) . '%';
      $or
        ->condition('tag_ids', $syntax, 'LIKE');
    }

    // Perform the query and fetch the URLs from its resultset.
    $urls = [];
    $results = $this->connection
      ->select('purge_queuer_url', 'u')
      ->fields('u', [
      'url',
    ])
      ->condition($or)
      ->execute();
    foreach ($results as $url) {
      $urls[] = $url->url;
    }
    return $urls;
  }

  /**
   * Retrieve database IDs for the given set of tags or add missing.
   *
   * @param string[] $tags
   *   Unassociative list of cache tags.
   * @param bool $add_missing
   *   Add tags that are missing to the database.
   *
   * @throws \LogicException
   *   Thrown when $tags is left empty.
   *
   * @return string[]
   *   Associative array with ID as key and the tag as value.
   */
  protected function getTagIds(array $tags, $add_missing = TRUE) {
    if (empty($tags)) {
      throw new \LogicException('$path cannot be empty!');
    }

    // Define the closure that queries existing tags from the database.
    $load_from_db = function (&$tags, &$ids) {
      $db_results = $this->connection
        ->select('purge_queuer_url_tag', 't')
        ->fields('t', [
        'tagid',
        'tag',
      ])
        ->condition('tag', $tags, 'IN')
        ->execute();
      foreach ($db_results as $tag) {
        $ids[intval($tag->tagid)] = $tag->tag;
        unset($tags[array_search($tag->tag, $tags)]);
      }
    };

    // First attempt to load everything from the database.
    $ids = [];
    $load_from_db($tags, $ids);

    // When given tags don't exist, they're left in $tags.
    // Missing tags are left in $tags, add them to the database if needed.
    if (count($tags) && $add_missing) {
      $q = $this->connection
        ->insert('purge_queuer_url_tag')
        ->fields([
        'tag',
      ]);
      foreach ($tags as $tag) {
        $q
          ->values([
          'tag' => $tag,
        ]);
      }
      $q
        ->execute();
      $load_from_db($tags, $ids);
    }
    return $ids;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ServiceProviderBase::alter	public	function	Modifies existing service definitions. Overrides ServiceModifierInterface::alter	5
ServiceProviderBase::register	public	function	Registers services to the container. Overrides ServiceProviderInterface::register	1
TrafficRegistry::$connection	protected	property	The active database connection.
TrafficRegistry::add	public	function	Register a new URL or path with its associated cache tags at the registry. Overrides TrafficRegistryInterface::add
TrafficRegistry::clear	public	function	Wipe out all gathered traffic information. Overrides TrafficRegistryInterface::clear
TrafficRegistry::countUrls	public	function	Count the number of URLs in the registry. Overrides TrafficRegistryInterface::countUrls
TrafficRegistry::getTagIds	protected	function	Retrieve database IDs for the given set of tags or add missing.
TrafficRegistry::getUrls	public	function	Collect URLs and paths associated with the given list of tags. Overrides TrafficRegistryInterface::getUrls
TrafficRegistry::remove	public	function	Remove a URL or path from the registry. Overrides TrafficRegistryInterface::remove
TrafficRegistry::__construct	public	function	Constructs a TrafficRegistry object.