+ <dl>

+ <dt><label for="enable_shadow_prune">{L_FORUM_PRUNE_SHADOW}{L_COLON}</label><br /><span>{L_FORUM_PRUNE_SHADOW_EXPLAIN}</span></dt>

+ <dd><label><input type="radio" class="radio" name="enable_shadow_prune" value="1"<!-- IF S_PRUNE_SHADOW_ENABLE --> id="enable_shadow_prune" checked="checked"<!-- ENDIF --> /> {L_YES}</label>

+ <label><input type="radio" class="radio" name="enable_shadow_prune" value="0"<!-- IF not S_PRUNE_SHADOW_ENABLE --> id="enable_shadow_prune" checked="checked"<!-- ENDIF --> /> {L_NO}</label></dd>

+ </dl>

+ <dl>

+ <dt><label for="prune_shadow_freq">{L_AUTO_PRUNE_FREQ}{L_COLON}</label><br /><span>{L_AUTO_PRUNE_FREQ_EXPLAIN}</span></dt>

+ <dd><input type="number" id="prune_shadow_freq" name="prune_shadow_freq" value="{PRUNE_FREQ}" maxlength="4" size="4" min="0" max="9999" /> {L_DAYS}</dd>

+ </dl>

+ <dl>

+ <dt><label for="prune_shadow_days">{L_AUTO_PRUNE_DAYS}{L_COLON}</label><br /><span>{L_AUTO_PRUNE_DAYS_EXPLAIN}</span></dt>

+ <dd><input type="number" id="prune_shadow_days" name="prune_shadow_days" value="{PRUNE_DAYS}" maxlength="4" size="4" min="0" max="9999" /> {L_DAYS}</dd>

+ </dl>

+ cron.task.core.prune_shadow_topics:

+ class: phpbb\cron\task\core\prune_shadow_topics

+ arguments:

+ - %core.root_path%

+ - %core.php_ext%

+ - @config

+ - @dbal.conn

+ - @log

+ calls:

+ - [set_name, [cron.task.core.prune_shadow_topics]]

+ tags:

+ - { name: cron.task }

+

+ 'enable_shadow_prune' => request_var('enable_shadow_prune', false),

+ 'prune_shadow_days' => request_var('prune_shadow_days', 7),

+ 'prune_shadow_freq' => request_var('prune_shadow_freq', 1),

+ 'enable_shadow_prune' => false,

+ 'prune_shadow_days' => 7,

+ 'prune_shadow_freq' => 1,

+ 'PRUNE_SHADOW_FREQ' => $forum_data['prune_shadow_freq'],

+ 'PRUNE_SHADOW_DAYS' => $forum_data['prune_shadow_days'],

+ 'S_PRUNE_SHADOW_ENABLE' => ($forum_data['enable_shadow_prune']) ? true : false,

+ if ($prune_mode == 'shadow')

+ {

+ $sql_and .= ' AND topic_status = ' . ITEM_MOVED . " AND topic_last_post_time < $prune_date";

+ }

+

+ "enable_shadow_prune": [

+ "BOOL",

+ 0

+ ],

+ "prune_shadow_days": [

+ "UINT",

+ 7

+ ],

+ "prune_shadow_freq": [

+ "UINT",

+ 1

+ ],

+ "prune_shadow_next": [

+ "INT:11",

+ 0

+ ],

+ 'LOG_PRUNE_SHADOW' => '<strong>Auto-pruned shadow topics</strong><br />» %s',

+ 'FORUM_PRUNE_SHADOW' => 'Enable auto-pruning of shadow topics',

+ 'FORUM_PRUNE_SHADOW_EXPLAIN' => 'Prunes the forum of shadow topics, set the frequency/age parameters below.',

+<?php

+/**

+*

+* @package phpBB3

+* @copyright (c) 2014 phpBB Group

+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2

+*

+*/

+

+namespace phpbb\cron\task\core;

+

+/**

+* Prune one forum of its shadow topics cron task.

+*

+* It is intended to be used when cron is invoked via web.

+* This task can decide whether it should be run using data obtained by viewforum

+* code, without making additional database queries.

+*

+* @package phpBB3

+*/

+class prune_shadow_topics extends \phpbb\cron\task\base implements \phpbb\cron\task\parametrized

+{

+ protected $phpbb_root_path;

+ protected $php_ext;

+ protected $config;

+ protected $db;

+ protected $log;

+

+ /**

+ * If $forum_data is given, it is assumed to contain necessary information

+ * about a single forum that is to be pruned.

+ *

+ * If $forum_data is not given, forum id will be retrieved via request_var

+ * and a database query will be performed to load the necessary information

+ * about the forum.

+ */

+ protected $forum_data;

+

+ /**

+ * Constructor.

+ *

+ * @param string $phpbb_root_path The root path

+ * @param string $php_ext The PHP extension

+ * @param \phpbb\config\config $config The config

+ * @param \phpbb\db\driver\driver $db The db connection

+ * @param \phpbb\log\log $log The phpBB log system

+ */

+ public function __construct($phpbb_root_path, $php_ext, \phpbb\config\config $config, \phpbb\db\driver\driver $db, \phpbb\log\log $log)

+ {

+ $this->phpbb_root_path = $phpbb_root_path;

+ $this->php_ext = $php_ext;

+ $this->config = $config;

+ $this->db = $db;

+ $this->log = $log;

+ }

+

+ /**

+ * Manually set forum data.

+ *

+ * @param array $forum_data Information about a forum to be pruned.

+ */

+ public function set_forum_data($forum_data)

+ {

+ $this->forum_data = $forum_data;

+ }

+

+ /**

+ * Runs this cron task.

+ *

+ * @return null

+ */

+ public function run()

+ {

+ if (!function_exists('auto_prune'))

+ {

+ include($this->phpbb_root_path . 'includes/functions_admin.' . $this->php_ext);

+ }

+

+ if ($this->forum_data['prune_shadow_days'])

+ {

+ $this->auto_prune_shadow_topics($this->forum_data['forum_id'], 'shadow', $this->forum_data['forum_flags'], $this->forum_data['prune_shadow_days'], $this->forum_data['prune_shadow_freq']);

+ }

+ }

+

+ /**

+ * Returns whether this cron task can run, given current board configuration.

+ *

+ * This cron task will not run when system cron is utilised, as in

+ * such cases prune_all_forums task would run instead.

+ *

+ * Additionally, this task must be given the forum data, either via

+ * the constructor or parse_parameters method.

+ *

+ * @return bool

+ */

+ public function is_runnable()

+ {

+ return !$this->config['use_system_cron'] && $this->forum_data;

+ }

+

+ /**

+ * Returns whether this cron task should run now, because enough time

+ * has passed since it was last run.

+ *

+ * Forum pruning interval is specified in the forum data.

+ *

+ * @return bool

+ */

+ public function should_run()

+ {

+ return $this->forum_data['enable_shadow_prune'] && $this->forum_data['prune_shadow_next'] < time();

+ }

+

+ /**

+ * Returns parameters of this cron task as an array.

+ * The array has one key, f, whose value is id of the forum to be pruned.

+ *

+ * @return array

+ */

+ public function get_parameters()

+ {

+ return array('f' => $this->forum_data['forum_id']);

+ }

+

+ /**

+ * Parses parameters found in $request, which is an instance of

+ * \phpbb\request\request_interface.

+ *

+ * It is expected to have a key f whose value is id of the forum to be pruned.

+ *

+ * @param \phpbb\request\request_interface $request Request object.

+ *

+ * @return null

+ */

+ public function parse_parameters(\phpbb\request\request_interface $request)

+ {

+ $this->forum_data = null;

+ if ($request->is_set('f'))

+ {

+ $forum_id = $request->variable('f', 0);

+

+ $sql = 'SELECT forum_id, prune_shadow_next, enable_shadow_prune, prune_shadow_days, forum_flags, prune_shadow_freq

+ FROM ' . FORUMS_TABLE . "

+ WHERE forum_id = $forum_id";

+ $result = $this->db->sql_query($sql);

+ $row = $this->db->sql_fetchrow($result);

+ $this->db->sql_freeresult($result);

+

+ if ($row)

+ {

+ $this->forum_data = $row;

+ }

+ }

+ }

+

+ /**

+ * Automatically prune shadow topics

+ * Based on fuunction auto_prune()

+ * @param int $forum_id Forum ID of forum that should be pruned

+ * @param string $prune_mode Prune mode

+ * @param int $prune_flags Prune flags

+ * @param int $prune_freq Prune frequency

+ * @return null

+ */

+ protected function auto_prune_shadow_topics($forum_id, $prune_mode, $prune_flags, $prune_days, $prune_freq)

+ {

+ $sql = 'SELECT forum_name

+ FROM ' . FORUMS_TABLE . "

+ WHERE forum_id = $forum_id";

+ $result = $this->db->sql_query($sql, 3600);

+ $row = $this->db->sql_fetchrow($result);

+ $this->db->sql_freeresult($result);

+

+ if ($row)

+ {

+ $prune_date = time() - ($prune_days * 86400);

+ $next_prune = time() + ($prune_freq * 86400);

+

+ prune($forum_id, $prune_mode, $prune_date, $prune_flags, true);

+

+ $sql = 'UPDATE ' . FORUMS_TABLE . "

+ SET prune_shadow_next = $next_prune

+ WHERE forum_id = $forum_id";

+ $this->db->sql_query($sql);

+

+ $this->log->add('admin', 'LOG_PRUNE_SHADOW', $row['forum_name']);

+ }

+

+ return;

+ }

+}

+<?php

+/**

+*

+* @package migration

+* @copyright (c) 2014 phpBB Group

+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2

+*

+*/

+

+namespace phpbb\db\migration\data\v310;

+

+class prune_shadow_topics extends \phpbb\db\migration\migration

+{

+ static public function depends_on()

+ {

+ return array('\phpbb\db\migration\data\v310\dev');

+ }

+

+ public function update_schema()

+ {

+ return array(

+ 'add_columns' => array(

+ $this->table_prefix . 'forums' => array(

+ 'enable_shadow_prune' => array('BOOL', 0),

+ 'prune_shadow_days' => array('UINT', 7),

+ 'prune_shadow_freq' => array('UINT', 1),

+ 'prune_shadow_next' => array('INT:11', 0),

+ ),

+ ),

+ );

+ }

+

+ public function revert_schema()

+ {

+ return array(

+ 'drop_columns' => array(

+ $this->table_prefix . 'forums' => array(

+ 'enable_shadow_prune',

+ 'prune_shadow_days',

+ 'prune_shadow_freq',

+ 'prune_shadow_next',

+ ),

+ ),

+ );

+ }

+}

+ else

+ {

+ // See if we should prune the shadow topics instead

+ $task = $cron->find_task('cron.task.core.prune_shadow_topics');

+ $task->set_forum_data($forum_data);

+

+ if ($task->is_ready())

+ {

+ $url = $task->get_url();

+ $template->assign_var('RUN_CRON_TASK', '<img src="' . $url . '" width="1" height="1" alt="cron" />');

+ }

+ }

+<?php

+/**

+*

+* @package testing

+* @copyright (c) 2014 phpBB Group

+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2

+*

+*/

+

+/**

+* @group functional

+*/

+class phpbb_functional_prune_shadow_topic_test extends phpbb_functional_test_case

+{

+ protected $data = array();

+ protected $post;

+

+ public function test_setup_forums()

+ {

+ $this->login();

+ $this->admin_login();

+

+ $crawler = self::request('GET', "adm/index.php?i=acp_forums&mode=manage&sid={$this->sid}");

+ $form = $crawler->selectButton('addforum')->form(array(

+ 'forum_name' => 'Prune Shadow',

+ ));

+ $crawler = self::submit($form);

+ $form = $crawler->selectButton('update')->form(array(

+ 'forum_perm_from' => 2,

+ 'enable_shadow_prune' => true,

+ 'prune_shadow_freq' => 1,

+ 'prune_shadow_days' => 1,

+ ));

+ $crawler = self::submit($form);

+ }

+

+ public function test_create_post()

+ {

+ $this->login();

+ $this->load_ids(array(

+ 'forums' => array(

+ 'Prune Shadow',

+ ),

+ ));

+

+ $this->assert_forum_details($this->data['forums']['Prune Shadow'], array(

+ 'forum_posts_approved' => 0,

+ 'forum_posts_unapproved' => 0,

+ 'forum_posts_softdeleted' => 0,

+ 'forum_topics_approved' => 0,

+ 'forum_topics_unapproved' => 0,

+ 'forum_topics_softdeleted' => 0,

+ 'forum_last_post_id' => 0,

+ ), 'initial comparison');

+

+ // Test creating topic

+ $this->post = $this->create_topic($this->data['forums']['Prune Shadow'], 'Prune Shadow #1', 'This is a test topic posted by the testing framework.');

+ $crawler = self::request('GET', "viewtopic.php?t={$this->post['topic_id']}&sid={$this->sid}");

+

+ $this->assertContains('Prune Shadow #1', $crawler->filter('html')->text());

+ $this->data['topics']['Prune Shadow #1'] = (int) $post['topic_id'];

+ $this->data['posts']['Prune Shadow #1'] = (int) $this->get_parameter_from_link($crawler->filter('.post')->selectLink($this->lang('POST', '', ''))->link()->getUri(), 'p');

+

+ $this->assert_forum_details($this->data['forums']['Prune Shadow'], array(

+ 'forum_posts_approved' => 1,

+ 'forum_posts_unapproved' => 0,

+ 'forum_posts_softdeleted' => 0,

+ 'forum_topics_approved' => 1,

+ 'forum_topics_unapproved' => 0,

+ 'forum_topics_softdeleted' => 0,

+ 'forum_last_post_id' => $this->data['posts']['Prune Shadow #1'],

+ ), 'after creating topic #1');

+

+ // Test creating a reply

+ $post2 = $this->create_post($this->data['forums']['Prune Shadow'], $this->post['topic_id'], 'Re: Prune Shadow #1-#2', 'This is a test post posted by the testing framework.');

+ $crawler = self::request('GET', "viewtopic.php?t={$post2['topic_id']}&sid={$this->sid}");

+

+ $this->assertContains('Re: Prune Shadow #1-#2', $crawler->filter('html')->text());

+ $this->data['posts']['Re: Prune Shadow #1-#2'] = (int) $this->get_parameter_from_link($crawler->filter('.post')->eq(1)->selectLink($this->lang('POST', '', ''))->link()->getUri(), 'p');

+

+ $this->assert_forum_details($this->data['forums']['Prune Shadow'], array(

+ 'forum_posts_approved' => 2,

+ 'forum_posts_unapproved' => 0,

+ 'forum_posts_softdeleted' => 0,

+ 'forum_topics_approved' => 1,

+ 'forum_topics_unapproved' => 0,

+ 'forum_topics_softdeleted' => 0,

+ 'forum_last_post_id' => $this->data['posts']['Re: Prune Shadow #1-#2'],

+ ), 'after replying');

+ }

+

+ public function test_move_topic()

+ {

+ $this->login();

+ $this->load_ids(array(

+ 'forums' => array(

+ 'Prune Shadow',

+ ),

+ 'topics' => array(

+ 'Prune Shadow #1',

+ ),

+ ));

+

+ $crawler = self::request('GET', "mcp.php?f={$this->data['forums']['Prune Shadow']}&i=main&action=move&mode=forum_view&start=0&topic_id_list[]={$this->data['topics']['Prune Shadow #1']}&sid={$this->sid}");

+ $form = $crawler->selectButton('confirm')->form(array(

+ 'to_forum_id' => 2,

+ 'move_leave_shadow' => true,

+ ));

+ $crawler = self::submit($form);

+

+ $this->assert_forum_details($this->data['forums']['Prune Shadow'], array(

+ 'forum_posts_approved' => 0,

+ 'forum_posts_unapproved' => 0,

+ 'forum_posts_softdeleted' => 0,

+ 'forum_topics_approved' => 1,

+ 'forum_topics_unapproved' => 0,

+ 'forum_topics_softdeleted' => 0,

+ ), 'after moving');

+

+ $this->db = $this->get_db();

+ // Date topic 3 days back

+ $sql = 'UPDATE phpbb_topics

+ SET topic_last_post_time = ' . (time() - 60*60*24*3) . '

+ WHERE topic_id = ' . ($this->data['topics']['Prune Shadow #1'] + 1);

+ $result = $this->db->sql_query($sql);

+

+ $crawler = self::request('GET', "viewforum.php?f={$this->data['forums']['Prune Shadow']}&sid={$this->sid}");

+ $cron_link = $crawler->filter('img')->last()->attr('src');

+ $crawler = self::request('GET', $cron_link . "&sid={$this->sid}", array(), false);

+

+ $this->assert_forum_details($this->data['forums']['Prune Shadow'], array(

+ 'forum_posts_approved' => 0,

+ 'forum_posts_unapproved' => 0,

+ 'forum_posts_softdeleted' => 0,

+ 'forum_topics_approved' => 0,

+ 'forum_topics_unapproved' => 0,

+ 'forum_topics_softdeleted' => 0,

+ ), 'after the cron job');

+ }

+

+ public function assert_forum_details($forum_id, $details, $additional_error_message = '')

+ {

+ $this->db = $this->get_db();

+

+ $sql = 'SELECT ' . implode(', ', array_keys($details)) . '

+ FROM phpbb_forums

+ WHERE forum_id = ' . (int) $forum_id;

+ $result = $this->db->sql_query($sql);

+ $data = $this->db->sql_fetchrow($result);

+ $this->db->sql_freeresult($result);

+

+ $this->assertEquals($details, $data, "Forum {$forum_id} does not match expected {$additional_error_message}");

+ }

+

+ public function load_ids($data)

+ {

+ $this->db = $this->get_db();

+

+ if (!empty($data['forums']))

+ {

+ $sql = 'SELECT *

+ FROM phpbb_forums

+ WHERE ' . $this->db->sql_in_set('forum_name', $data['forums']);

+ $result = $this->db->sql_query($sql);

+ while ($row = $this->db->sql_fetchrow($result))

+ {

+ if (in_array($row['forum_name'], $data['forums']))

+ {

+ $this->data['forums'][$row['forum_name']] = (int) $row['forum_id'];

+ }

+ }

+ $this->db->sql_freeresult($result);

+ }

+

+ if (!empty($data['topics']))

+ {

+ $sql = 'SELECT *

+ FROM phpbb_topics

+ WHERE ' . $this->db->sql_in_set('topic_title', $data['topics']);

+ $result = $this->db->sql_query($sql);

+ while ($row = $this->db->sql_fetchrow($result))

+ {

+ if (in_array($row['topic_title'], $data['topics']))

+ {

+ $this->data['topics'][$row['topic_title']] = (int) $row['topic_id'];

+ }

+ }

+ $this->db->sql_freeresult($result);

+ }

+

+ if (!empty($data['posts']))

+ {

+ $sql = 'SELECT *

+ FROM phpbb_posts

+ WHERE ' . $this->db->sql_in_set('post_subject', $data['posts']);

+ $result = $this->db->sql_query($sql);

+ while ($row = $this->db->sql_fetchrow($result))

+ {

+ if (in_array($row['post_subject'], $data['posts']))

+ {

+ $this->data['posts'][$row['post_subject']] = (int) $row['post_id'];

+ }

+ }

+ $this->db->sql_freeresult($result);

+ }

+ }

+}