[ticket/14257] Add cron tasks for reparsing text

PHPBB3-14257
author: Oliver Schramm <oliver.schramm97@gmail.com> 2015-10-24 19:59:51 +0200
committer: Oliver Schramm <oliver.schramm97@gmail.com> 2015-10-24 20:01:15 +0200
commit: 8376c6552a7860036640a5840f26dba239c20750 (patch)
tree: ae17d37709316b7bb4e4645d74bd98aa0e196ce5 /phpBB
parent: 5f85f19a5ea9f89a869c9fcb6391e48faa5cbd0c (diff)
download: forums-8376c6552a7860036640a5840f26dba239c20750.tar
forums-8376c6552a7860036640a5840f26dba239c20750.tar.gz
forums-8376c6552a7860036640a5840f26dba239c20750.tar.bz2
forums-8376c6552a7860036640a5840f26dba239c20750.tar.xz
forums-8376c6552a7860036640a5840f26dba239c20750.zip
3 files changed, 321 insertions, 0 deletions
diff --git a/phpBB/config/default/container/services_cron.yml b/phpBB/config/default/container/services_cron.yml
index c5b88df181..d05e4c1b1a 100644
--- a/phpBB/config/default/container/services_cron.yml
+++ b/phpBB/config/default/container/services_cron.yml
@@ -146,3 +146,120 @@ services:
             - [set_name, [cron.task.core.tidy_warnings]]
         tags:
             - { name: cron.task }
+
+    cron.task.text_reparser.contact_admin_info:
+        class: phpbb\cron\task\text_reparser\reparser
+        arguments:
+            - @config
+            - @config_text
+            - @text_reparser.lock
+            - @text_reparser_collection
+        calls:
+            - [set_name, [cron.task.text_reparser.contact_admin_info]]
+            - [set_reparser, [text_reparser.contact_admin_info]]
+        tags:
+            - { name: cron.task }
+
+    cron.task.text_reparser.forum_description:
+        class: phpbb\cron\task\text_reparser\reparser
+        arguments:
+            - @config
+            - @config_text
+            - @text_reparser.lock
+            - @text_reparser_collection
+        calls:
+            - [set_name, [cron.task.text_reparser.forum_description]]
+            - [set_reparser, [text_reparser.forum_description]]
+        tags:
+            - { name: cron.task }
+
+    cron.task.text_reparser.forum_rules:
+        class: phpbb\cron\task\text_reparser\reparser
+        arguments:
+            - @config
+            - @config_text
+            - @text_reparser.lock
+            - @text_reparser_collection
+        calls:
+            - [set_name, [cron.task.text_reparser.forum_rules]]
+            - [set_reparser, [text_reparser.forum_rules]]
+        tags:
+            - { name: cron.task }
+
+    cron.task.text_reparser.group_description:
+        class: phpbb\cron\task\text_reparser\reparser
+        arguments:
+            - @config
+            - @config_text
+            - @text_reparser.lock
+            - @text_reparser_collection
+        calls:
+            - [set_name, [cron.task.text_reparser.group_description]]
+            - [set_reparser, [text_reparser.group_description]]
+        tags:
+            - { name: cron.task }
+
+    cron.task.text_reparser.pm_text:
+        class: phpbb\cron\task\text_reparser\reparser
+        arguments:
+            - @config
+            - @config_text
+            - @text_reparser.lock
+            - @text_reparser_collection
+        calls:
+            - [set_name, [cron.task.text_reparser.pm_text]]
+            - [set_reparser, [text_reparser.pm_text]]
+        tags:
+            - { name: cron.task }
+
+    cron.task.text_reparser.poll_option:
+        class: phpbb\cron\task\text_reparser\reparser
+        arguments:
+            - @config
+            - @config_text
+            - @text_reparser.lock
+            - @text_reparser_collection
+        calls:
+            - [set_name, [cron.task.text_reparser.poll_option]]
+            - [set_reparser, [text_reparser.poll_option]]
+        tags:
+            - { name: cron.task }
+
+    cron.task.text_reparser.poll_title:
+        class: phpbb\cron\task\text_reparser\reparser
+        arguments:
+            - @config
+            - @config_text
+            - @text_reparser.lock
+            - @text_reparser_collection
+        calls:
+            - [set_name, [cron.task.text_reparser.poll_title]]
+            - [set_reparser, [text_reparser.poll_title]]
+        tags:
+            - { name: cron.task }
+
+    cron.task.text_reparser.post_text:
+        class: phpbb\cron\task\text_reparser\reparser
+        arguments:
+            - @config
+            - @config_text
+            - @text_reparser.lock
+            - @text_reparser_collection
+        calls:
+            - [set_name, [cron.task.text_reparser.post_text]]
+            - [set_reparser, [text_reparser.post_text]]
+        tags:
+            - { name: cron.task }
+
+    cron.task.text_reparser.user_signature:
+        class: phpbb\cron\task\text_reparser\reparser
+        arguments:
+            - @config
+            - @config_text
+            - @text_reparser.lock
+            - @text_reparser_collection
+        calls:
+            - [set_name, [cron.task.text_reparser.user_signature]]
+            - [set_reparser, [text_reparser.user_signature]]
+        tags:
+            - { name: cron.task }
diff --git a/phpBB/config/default/container/services_text_reparser.yml b/phpBB/config/default/container/services_text_reparser.yml
index 5d54e8dc82..db0aee03bc 100644
--- a/phpBB/config/default/container/services_text_reparser.yml
+++ b/phpBB/config/default/container/services_text_reparser.yml
@@ -1,4 +1,11 @@
 services:
+    text_reparser.lock:
+        class: phpbb\lock\db
+        arguments:
+            - reparse_lock
+            - @config
+            - @dbal.conn
+
     text_reparser_collection:
         class: phpbb\di\service_collection
         arguments:
diff --git a/phpBB/phpbb/cron/task/text_reparser/reparser.php b/phpBB/phpbb/cron/task/text_reparser/reparser.php
new file mode 100644
index 0000000000..334ce46c26
--- /dev/null
+++ b/phpBB/phpbb/cron/task/text_reparser/reparser.php
@@ -0,0 +1,197 @@
+<?php
+/**
+ *
+ * This file is part of the phpBB Forum Software package.
+ *
+ * @copyright (c) phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ * For full copyright and license information, please see
+ * the docs/CREDITS.txt file.
+ *
+ */
+
+namespace phpbb\cron\task\text_reparser;
+
+/**
+ * Reparse text cron task
+ */
+class reparser extends \phpbb\cron\task\base
+{
+	const MIN = 1;
+	const SIZE = 100;
+
+	/**
+	 * @var \phpbb\config\config
+	 */
+	protected $config;
+
+	/**
+	 * @var \phpbb\config\db_text
+	 */
+	protected $config_text;
+
+	/**
+	 * @var \phpbb\lock\db
+	 */
+	protected $reparse_lock;
+
+	/**
+	 * @var \phpbb\di\service_collection
+	 */
+	protected $reparsers;
+
+	/**
+	 * @var string
+	 */
+	protected $reparser_name;
+
+	/**
+	 * @var array
+	 */
+	protected $resume_data;
+
+	/**
+	 * Constructor
+	 *
+	 * @param \phpbb\config\config			$config
+	 * @param \phpbb\config\db_text			$config_text
+	 * @param \phpbb\lock\db				$reparse_lock
+	 * @param \phpbb\di\service_collection	$reparsers
+	 */
+	public function __construct(\phpbb\config\config $config, \phpbb\config\db_text $config_text, \phpbb\lock\db $reparse_lock, \phpbb\di\service_collection $reparsers)
+	{
+		$this->config = $config;
+		$this->config_text = $config_text;
+		$this->reparse_lock = $reparse_lock;
+		$this->reparsers = $reparsers;
+	}
+
+	/**
+	 * Sets the reparser for this cron task
+	 *
+	 * @param string	$reparser
+	 */
+	public function set_reparser($reparser)
+	{
+		if (isset($this->reparsers[$reparser]))
+		{
+			$this->reparser_name = preg_replace('(^text_reparser\\.)', '', $reparser);
+		}
+		else if (isset($this->reparsers['text_reparser.' . $reparser]))
+		{
+			$this->reparser_name = $reparser;
+		}
+
+		if ($this->resume_data === null)
+		{
+			$this->load_resume_data();
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function is_runnable()
+	{
+		if ($this->resume_data === null)
+		{
+			$this->load_resume_data();
+		}
+
+		if (empty($this->resume_data[$this->reparser_name]['range-max']) || $this->resume_data[$this->reparser_name]['range-max'] === $this->resume_data[$this->reparser_name]['range-min'])
+		{
+			return true;
+		}
+
+		return false;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function should_run()
+	{
+		if (!empty($this->config['reparse_lock']))
+		{
+			$last_run = explode(' ', $this->config['reparse_lock']);
+
+			if ($last_run[0] + 3600 >= time())
+			{
+				return false;
+			}
+		}
+
+		return true;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function run()
+	{
+		if ($this->reparse_lock->acquire())
+		{
+			if ($this->resume_data === null)
+			{
+				$this->load_resume_data();
+			}
+
+			/**
+			 * @var \phpbb\textreparser\reparser_interface $reparser
+			 */
+			$reparser = isset($this->reparsers[$this->reparser_name]) ? $this->reparsers[$this->reparser_name] : $this->reparsers['text_reparser.' . $this->reparser_name];
+
+			$min = !empty($this->resume_data[$this->reparser_name]['range-min']) ? $this->resume_data[$this->reparser_name]['range-min'] : self::MIN;
+			$current = !empty($this->resume_data[$this->reparser_name]['range-max']) ? $this->resume_data[$this->reparser_name]['range-max'] : $reparser->get_max_id();
+			$size = !empty($this->resume_data[$this->reparser_name]['range-size']) ? $this->resume_data[$this->reparser_name]['range-size'] : self::SIZE;
+
+			if ($current >= $min)
+			{
+				$start = max($min, $current + 1 - $size);
+				$end = max($min, $current);
+
+				$reparser->reparse_range($start, $end);
+
+				$this->update_resume_data($this->reparser_name, $min, $start - 1, $size);
+			}
+
+			$this->reparse_lock->release();
+		}
+	}
+
+	/**
+	 * Load the resume data from the database
+	 */
+	protected function load_resume_data()
+	{
+		$resume_data = $this->config_text->get('reparser_resume');
+		$this->resume_data = (empty($resume_data)) ? array() : unserialize($resume_data);
+	}
+
+	/**
+	 * Save the resume data to the database
+	 */
+	protected function save_resume_data()
+	{
+		$this->config_text->set('reparser_resume', serialize($this->resume_data));
+	}
+
+	/**
+	 * Save the resume data to the database
+	 *
+	 * @param string	$name		Reparser name
+	 * @param int		$min		Lowest record ID
+	 * @param int		$current	Current ID
+	 * @param int		$size		Number of records to process at a time
+	 */
+	protected function update_resume_data($name, $min, $current, $size)
+	{
+		$this->resume_data[$name] = array(
+			'range-min'  => $min,
+			'range-max'  => $current,
+			'range-size' => $size,
+		);
+		$this->save_resume_data();
+	}
+}
author	Oliver Schramm <oliver.schramm97@gmail.com>	2015-10-24 19:59:51 +0200
committer	Oliver Schramm <oliver.schramm97@gmail.com>	2015-10-24 20:01:15 +0200
commit	8376c6552a7860036640a5840f26dba239c20750 (patch)
tree	ae17d37709316b7bb4e4645d74bd98aa0e196ce5 /phpBB
parent	5f85f19a5ea9f89a869c9fcb6391e48faa5cbd0c (diff)
download	forums-8376c6552a7860036640a5840f26dba239c20750.tar forums-8376c6552a7860036640a5840f26dba239c20750.tar.gz forums-8376c6552a7860036640a5840f26dba239c20750.tar.bz2 forums-8376c6552a7860036640a5840f26dba239c20750.tar.xz forums-8376c6552a7860036640a5840f26dba239c20750.zip