diff --git a/src/Form/NodeRevisionDeleteAdminSettings.php b/src/Form/NodeRevisionDeleteAdminSettings.php index fbaf927..d237a9e 100644 --- a/src/Form/NodeRevisionDeleteAdminSettings.php +++ b/src/Form/NodeRevisionDeleteAdminSettings.php @@ -5,6 +5,7 @@ namespace Drupal\node_revision_delete\Form; use Drupal\Core\Form\ConfigFormBase; use Drupal\Core\Form\FormStateInterface; use Drupal\Core\Render\RendererInterface; +use Drupal\node_revision_delete\RevisionQuery; use Symfony\Component\DependencyInjection\ContainerInterface; use Drupal\Core\Url; use Drupal\Core\Entity\EntityTypeManagerInterface; @@ -42,9 +43,7 @@ class NodeRevisionDeleteAdminSettings extends ConfigFormBase { * {@inheritdoc} */ public static function create(ContainerInterface $container) { - return new static( - $container->get('renderer'), $container->get('entity_type.manager') - ); + return new static($container->get('renderer'), $container->get('entity_type.manager')); } /** @@ -123,7 +122,12 @@ class NodeRevisionDeleteAdminSettings extends ConfigFormBase { $when_to_delete = (bool) $when_to_delete_number ? _node_revision_delete_time_string('when_to_delete', $when_to_delete_number) : $this->t('Always delete'); // Number of candidates nodes to delete theirs revision. - $candidate_nodes = count(_node_revision_delete_candidates($content_type->id(), $minimum_revisions_to_keep, $minimum_age_to_delete_number, $when_to_delete_number)); + $minimum_age_to_delete_format = $this->getConvertibleTimeFormat('minimum_age_to_delete', $minimum_age_to_delete_number); + $rev_recency = is_numeric($minimum_age_to_delete_number) && intval($minimum_age_to_delete_number) > 0 ? new \DateTime($minimum_age_to_delete_format) : NULL; + $when_to_delete_format = $this->getConvertibleTimeFormat('when_to_delete', $when_to_delete_number); + $skip_nodes_more_recently_modified_than = is_numeric($when_to_delete_number) && intval($when_to_delete_number) > 0 ? new \DateTime($when_to_delete_format) : NULL; + $reqQuery = new RevisionQuery($content_type, $minimum_revisions_to_keep, $rev_recency, $skip_nodes_more_recently_modified_than); + $candidate_nodes = $reqQuery->countAffectedNodes(); // If we have candidates nodes then we will allow to run the batch job. if ($candidate_nodes && !$exists_candidates_nodes) { $exists_candidates_nodes = TRUE; @@ -295,12 +299,30 @@ class NodeRevisionDeleteAdminSettings extends ConfigFormBase { _node_revision_delete_update_time_max_number_config('when_to_delete', $when_to_delete_time_max_number); _node_revision_delete_update_time_max_number_config('minimum_age_to_delete', $minimum_age_to_delete_time_max_number); // Saving the configuration. - $this->config('node_revision_delete.settings') - ->set('node_revision_delete_cron', $form_state->getValue('node_revision_delete_cron')) - ->set('node_revision_delete_time', $form_state->getValue('node_revision_delete_time')) - ->set('node_revision_delete_when_to_delete_time', $node_revision_delete_when_to_delete_time) - ->set('node_revision_delete_minimum_age_to_delete_time', $node_revision_delete_minimum_age_to_delete_time) - ->save(); + $this->config('node_revision_delete.settings')->set('node_revision_delete_cron', $form_state->getValue('node_revision_delete_cron'))->set('node_revision_delete_time', $form_state->getValue('node_revision_delete_time'))->set('node_revision_delete_when_to_delete_time', $node_revision_delete_when_to_delete_time)->set('node_revision_delete_minimum_age_to_delete_time', $node_revision_delete_minimum_age_to_delete_time)->save(); + } + + /** + * Returns a formatted string in the form of X 'days|weeks|months|years' ago. + * + * The return value here is meant to be used to build a DateTime object. + * + * @param $config_key + * @param $interval_number + * + * @return string + * @throws \InvalidArgumentException + */ + protected function getConvertibleTimeFormat($config_key, $interval_number) { + // Geting the config. + $config = $this->config('node_revision_delete.settings'); + $config_name_time = $config->get('node_revision_delete_' . $config_key . '_time'); + + if (empty($config_name_time['time']) || !preg_match('/day[s]?|week[s]?|month[s]?|year[s]?/i', $config_name_time['time'])) { + throw new \InvalidArgumentException("Invalid or unknown value. We are expecting day,week,month or year"); + } + // Is singular or plural? + return sprintf('%s %s ago', $interval_number, $config_name_time['time']); } } diff --git a/src/RevisionQuery.php b/src/RevisionQuery.php new file mode 100644 index 0000000..80f6606 --- /dev/null +++ b/src/RevisionQuery.php @@ -0,0 +1,159 @@ +setType($content_type->id()); + $this->setMinRetainRev($revision_items_to_keep); + $this->setMinRetainAge($revision_history_to_retain); + $this->setInactivityAge($nodeInactivityAge); + + $this->nodeQuery = NodeWorkQuery::create() + ->setQuery($this->type, $this->minRev, $this->minRetainAge, $this->nodeInactivityAge); + } + + /** + * Sets the minimum age to retain for a revision. If NULL then the filter is not applied. + * + * This means that revisions older than the specified DateTime will be deleted. + * + * @param \DateTime|NULL $min_age_to_keep + * Revisions older than this date will be removed. A NULL means that this filter will not be applied. + * + * @return \Drupal\node_revision_delete\RevisionQueryInterface + */ + public function setMinRetainAge(DateTime $min_age_to_keep = NULL) { + $this->minRetainAge = $min_age_to_keep; + + return $this; + } + + public function setInactivityAge(DateTime $nodeInactivityAge = NULL) { + $this->nodeInactivityAge = $nodeInactivityAge; + + return $this; + } + + /** + * The Node type. + * + * @param string $content_type + * The node bundle. Ex. article,basic_page + * + * @return \Drupal\node_revision_delete\RevisionQuery + */ + public function setType($content_type) { + // @todo: should add type validation? If the bundle doesn't exist then no harm no foul. + $this->type = $content_type; + + return $this; + } + + /** + * Sets the minimum number of revisions for each node to retain. This value will always be equal to, or greater than 1. + * + * Invalid values are ignored. This function can be chained. + * + * @param int $minimum_revisions_to_keep + * The minimum number of revisions to keep for each node. + * + * @return \Drupal\node_revision_delete\RevisionQueryInterface + */ + public function setMinRetainRev($minimum_revisions_to_keep) { + if (is_numeric($minimum_revisions_to_keep) && $minimum_revisions_to_keep >= 1) { + $this->minRev = $minimum_revisions_to_keep; + } + + return $this; + } + + /** + * {@inheritdoc} + */ + public function countAffectedNodes() { + return $this->nodeQuery->count(); + } + + public function countRemovableRevisions() { + return $this->revQuery->count(); + } + + /** + * {@inheritdoc} + */ + public function fetchRemovableRevisions() { + // TODO: Implement fetchRemovable() method. + } + + + /** + * @param array $options + * + * @return \Drupal\Core\Database\Query\SelectInterface + */ + protected function query(array $options) { + /** @var \Drupal\Core\Database\Query\SelectInterface $query */ + $query = $this->connection->select('node', 'n'); + $query->addField('n', 'nid'); + $query->addField('r', 'vid'); + $query->addExpression('COUNT(n.nid)', 'num_revisions'); + $query->join('node_revision', 'r', 'n.nid=r.nid'); + $query->condition('n.type', $this->type); + //$query->groupBy('n.nid'); + + // couldn't use here havingCondition and couldn't use the num_revisions alias. May be an ORM issue. + $query->having('COUNT(n.nid) > :min_retain_revisions', [':min_retain_revisions' => $this->minRev]); + + return $query; + } + +} \ No newline at end of file diff --git a/src/RevisionQueryInterface.php b/src/RevisionQueryInterface.php new file mode 100644 index 0000000..6b1f997 --- /dev/null +++ b/src/RevisionQueryInterface.php @@ -0,0 +1,34 @@ +connection = \Drupal::service('database'); + } + + public static function create() { + return new static(); + } +} \ No newline at end of file diff --git a/src/WorkQuery/NodeWorkQuery.php b/src/WorkQuery/NodeWorkQuery.php new file mode 100644 index 0000000..ae970e2 --- /dev/null +++ b/src/WorkQuery/NodeWorkQuery.php @@ -0,0 +1,126 @@ + 3) + * ) trimmed + * ON trimmed.nid=rv.nid + * WHERE rv.revision_timestamp < 1511405964 + * + * {@inheritdoc} + */ + public function setQuery($type, $minimum_revisions_to_keep, DateTime $min_rev_age_to_keep = NULL, DateTime $min_node_inactivity_age = NULL) { + $subQuery = $this->countRevisionSubQuery($type, $minimum_revisions_to_keep, $min_node_inactivity_age); + // initially set the revision count query as the main query. It may become a subquery + $this->query = $subQuery; + + if ($min_rev_age_to_keep) { + $outerQuery = $this->connection->select('node_revision', 'rv'); + $outerQuery->fields('rv', ['nid', 'vid']); + $outerQuery->join($subQuery, 'trimmed', 'trimmed.nid=rv.nid'); + $outerQuery->condition('rv.revision_timestamp', $min_rev_age_to_keep->format('U'), '<'); + $outerQuery->groupBy('rv.nid'); + $this->query = $outerQuery; + } + + return $this; + } + + /** + * Marking as private. The table aliases in this query are defined in the main query. + * + * Note: This query operates on a node's CURRENT revision, which may not necessarily be a node's most recent revision. + * + * @return \Drupal\Core\Database\Query\SelectInterface + */ + private function currentRevisionTimeStampSubQuery() { + /** @var \Drupal\Core\Database\Query\SelectInterface $subQuery */ + $subQuery = $this->connection->select('node_revision', 'r2'); + $subQuery->addField('r2', 'revision_timestamp'); + $subQuery->where('r2.vid = n.vid'); + //$subQuery->orderBy('r2.revision_timestamp', 'DESC'); + //$subQuery->range(0, 1); + return $subQuery; + + } + + /** + * Constructs a query that returns all the nids and their current vid based on the bundle, and the minimum revision count. + * + * @param $type + * @param $minimum_revisions_to_keep + * @param \DateTime $min_node_inactivity_age + * + * @return \Drupal\Core\Database\Query\SelectInterface + */ + private function countRevisionSubQuery($type, $minimum_revisions_to_keep, DateTime $min_node_inactivity_age = NULL) { + /** @var \Drupal\Core\Database\Query\SelectInterface $query */ + $query = $this->connection->select('node', 'n'); + $query->addField('n', 'nid'); + //$query->addField('n', 'vid'); + $query->addExpression('COUNT(n.nid)', 'num_revisions'); + $query->join('node_revision', 'r', 'n.nid=r.nid'); + $query->condition('n.type', $type); + + if ($min_node_inactivity_age instanceof DateTime) { + // Construct a WHERE clause to filter out nodes more recent than the $min_rev_age_to_keep. Constructs a WHERE with a SELECT subquery on the CURRENT revision. + $query->condition($min_node_inactivity_age->format('U'), $this->currentRevisionTimeStampSubQuery(), '>'); + } + + $query->groupBy('n.nid'); + // couldn't use here havingCondition and couldn't use the num_revisions alias. + $query->having('COUNT(n.nid) > :min_retain_revisions', [':min_retain_revisions' => $minimum_revisions_to_keep]); + + return $query; + } + + /** + * {@inheritdoc} + */ + public function count() { + return $this->query->countQuery() + ->execute() + ->fetchField(); + } + + /** + * {@inheritdoc} + */ + public function fetchRecords() { + return $this->query->execute() + ->fetchAll(); + } +} diff --git a/src/WorkQuery/RevisionWorkQuery.php b/src/WorkQuery/RevisionWorkQuery.php new file mode 100644 index 0000000..e507cb0 --- /dev/null +++ b/src/WorkQuery/RevisionWorkQuery.php @@ -0,0 +1,34 @@ +