aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/cron/task
diff options
context:
space:
mode:
authorOliver Schramm <oliver.schramm97@gmail.com>2015-10-24 19:59:51 +0200
committerOliver Schramm <oliver.schramm97@gmail.com>2015-10-24 20:01:15 +0200
commit8376c6552a7860036640a5840f26dba239c20750 (patch)
treeae17d37709316b7bb4e4645d74bd98aa0e196ce5 /phpBB/phpbb/cron/task
parent5f85f19a5ea9f89a869c9fcb6391e48faa5cbd0c (diff)
downloadforums-8376c6552a7860036640a5840f26dba239c20750.tar
forums-8376c6552a7860036640a5840f26dba239c20750.tar.gz
forums-8376c6552a7860036640a5840f26dba239c20750.tar.bz2
forums-8376c6552a7860036640a5840f26dba239c20750.tar.xz
forums-8376c6552a7860036640a5840f26dba239c20750.zip
[ticket/14257] Add cron tasks for reparsing text
PHPBB3-14257
Diffstat (limited to 'phpBB/phpbb/cron/task')
-rw-r--r--phpBB/phpbb/cron/task/text_reparser/reparser.php197
1 files changed, 197 insertions, 0 deletions
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();
+ }
+}