+ * @param \phpbb\db\driver\driver_interface $db

+ public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\passwords\manager $passwords_manager, \phpbb\request\request $request, \phpbb\user $user, $phpbb_root_path, $php_ext)

+ * @param \phpbb\db\driver\driver_interface $db

+ public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\passwords\manager $passwords_manager, \phpbb\request\request $request, \phpbb\user $user, $phpbb_root_path, $php_ext)

+ * @param \phpbb\db\driver\driver_interface $db

+ public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\passwords\manager $passwords_manager, \phpbb\user $user)

+ * @var \phpbb\db\driver\driver_interface

+ * @param \phpbb\db\driver\driver_interface $db

+ public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\passwords\manager $passwords_manager, \phpbb\request\request_interface $request, \phpbb\user $user, $auth_provider_oauth_token_storage_table, $auth_provider_oauth_token_account_assoc, \phpbb\di\service_collection $service_providers, $users_table, $phpbb_root_path, $php_ext)

+ * @var \phpbb\db\driver\driver_interface

+ * @param \phpbb\db\driver\driver_interface $db

+ public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\user $user, $auth_provider_oauth_table)

+ 'avatar_path' => array('lang' => 'AVATAR_STORAGE_PATH', 'validate' => 'rpath', 'type' => 'text:20:255', 'explain' => true),

+ * @param \phpbb\db\driver\driver_interface $db Database connection

+ public function sql_save(\phpbb\db\driver\driver_interface $db, $query, $query_result, $ttl);

+ function sql_save(\phpbb\db\driver\driver_interface $db, $query, $query_result, $ttl)

+ function sql_save(\phpbb\db\driver\driver_interface $db, $query, $query_result, $ttl)

+ function sql_save(\phpbb\db\driver\driver_interface $db, $query, $query_result, $ttl)

+ * @var \phpbb\db\driver\driver_interface

+ * @param \phpbb\db\driver\driver_interface $db Database connection

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

+ * @var \phpbb\db\driver\driver_interface

+ * @param \phpbb\db\driver\driver_interface $db Database connection

+ public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\cache\driver\driver_interface $cache, $table)

+ * @var \phpbb\db\driver\driver_interface

+ * @param \phpbb\db\driver\driver_interface $db Database connection

+ public function __construct(\phpbb\db\driver\driver_interface $db, $table)

+<?php

+/**

+*

+* @package phpBB3

+* @copyright (c) 2014 phpBB Group

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

+*

+*/

+namespace phpbb\console\command\db;

+

+use Symfony\Component\Console\Input\InputInterface;

+use Symfony\Component\Console\Output\OutputInterface;

+

+class migrate extends \phpbb\console\command\command

+{

+ /** @var \phpbb\db\migrator */

+ protected $migrator;

+

+ /** @var \phpbb\extension\manager */

+ protected $extension_manager;

+

+ /** @var \phpbb\config\config */

+ protected $config;

+

+ /** @var \phpbb\cache\service */

+ protected $cache;

+

+ /** @var \phpbb\log\log */

+ protected $log;

+

+ /** @var \phpbb\user */

+ protected $user;

+

+ function __construct(\phpbb\db\migrator $migrator, \phpbb\extension\manager $extension_manager, \phpbb\config\config $config, \phpbb\cache\service $cache, \phpbb\log\log $log, \phpbb\user $user)

+ {

+ $this->migrator = $migrator;

+ $this->extension_manager = $extension_manager;

+ $this->config = $config;

+ $this->cache = $cache;

+ $this->log = $log;

+ $this->user = $user;

+ $this->user->add_lang(array('common', 'acp/common', 'install', 'migrator'));

+ parent::__construct();

+ }

+

+ protected function configure()

+ {

+ $this

+ ->setName('db:migrate')

+ ->setDescription('Updates the database by applying migrations.')

+ ;

+ }

+

+ protected function execute(InputInterface $input, OutputInterface $output)

+ {

+ $this->load_migrations();

+ $orig_version = $this->config['version'];

+ while (!$this->migrator->finished())

+ {

+ $migration_start_time = microtime(true);

+

+ try

+ {

+ $this->migrator->update();

+ }

+ catch (\phpbb\db\migration\exception $e)

+ {

+ $output->writeln('<error>' . $e->getLocalisedMessage($this->user) . '</error>');

+ $this->finalise_update();

+ return 1;

+ }

+

+ $migration_stop_time = microtime(true) - $migration_start_time;

+

+ $state = array_merge(

+ array(

+ 'migration_schema_done' => false,

+ 'migration_data_done' => false,

+ ),

+ $this->migrator->last_run_migration['state']

+ );

+

+ if (!empty($this->migrator->last_run_migration['effectively_installed']))

+ {

+ $msg = $this->user->lang('MIGRATION_EFFECTIVELY_INSTALLED', $this->migrator->last_run_migration['name']);

+ $output->writeln("<comment>$msg</comment>");

+ }

+ else if ($this->migrator->last_run_migration['task'] == 'process_data_step' && $state['migration_data_done'])

+ {

+ $msg = $this->user->lang('MIGRATION_DATA_DONE', $this->migrator->last_run_migration['name'], $migration_stop_time);

+ $output->writeln("<info>$msg</info>");

+ }

+ else if ($this->migrator->last_run_migration['task'] == 'process_data_step')

+ {

+ $output->writeln($this->user->lang('MIGRATION_DATA_IN_PROGRESS', $this->migrator->last_run_migration['name'], $migration_stop_time));

+ }

+ else if ($state['migration_schema_done'])

+ {

+ $msg = $this->user->lang('MIGRATION_SCHEMA_DONE', $this->migrator->last_run_migration['name'], $migration_stop_time);

+ $output->writeln("<info>$msg</info>");

+ }

+ }

+

+ if ($orig_version != $this->config['version'])

+ {

+ $this->log->add('admin', 'LOG_UPDATE_DATABASE', $orig_version, $this->config['version']);

+ }

+

+ $this->finalise_update();

+ $output->writeln($this->user->lang['DATABASE_UPDATE_COMPLETE']);

+ }

+

+ protected function load_migrations()

+ {

+ $migrations = $this->extension_manager

+ ->get_finder()

+ ->core_path('phpbb/db/migration/data/')

+ ->extension_directory('/migrations')

+ ->get_classes();

+ $this->migrator->set_migrations($migrations);

+ }

+

+ protected function finalise_update()

+ {

+ $this->cache->purge();

+ $this->config->increment('assets_version', 1);

+ }

+}

+ /** @var \phpbb\db\driver\driver_interface */

+ function __construct(\phpbb\db\driver\driver_interface $db)

+ * @var \phpbb\db\driver\driver_interface

+ * @param \phpbb\db\driver\driver_interface $db Database object

+ public function __construct(\phpbb\auth\auth $auth, \phpbb\db\driver\driver_interface $db, \phpbb\user $user, $phpbb_root_path, $php_ext, $forums_table, $posts_table, $topics_table, $users_table)

+ * @param $visibility int Element of {ITEM_APPROVED, ITEM_DELETED, ITEM_REAPPROVE}

+ * @param $reason string Reason why the visibility was changed.

+ * @return array Changed post data, empty array if an error occurred.

+ if (!in_array($visibility, array(ITEM_APPROVED, ITEM_DELETED, ITEM_REAPPROVE)))

+ if (in_array($visibility, array(ITEM_REAPPROVE, ITEM_DELETED)))

+ $field_alias = array(

+ ITEM_APPROVED => 'posts_approved',

+ ITEM_UNAPPROVED => 'posts_unapproved',

+ ITEM_DELETED => 'posts_softdeleted',

+ ITEM_REAPPROVE => 'posts_unapproved',

+ );

+ $cur_posts = array_fill_keys($field_alias, 0);

+

+ $cur_posts[$field_alias[(int) $post_visibility]] += $visibility_posts;

+ $recipient_field = $field_alias[$visibility];

+

+ foreach ($cur_posts as $field => $count)

+ // Decrease the count for the old statuses.

+ if ($count && $field != $recipient_field)

+ $sql_ary[$field] = " - $count";

+ // Add up the count from all statuses excluding the recipient status.

+ $count_increase = array_sum(array_diff($cur_posts, array($recipient_field)));

+

+ if ($count_increase)

+ $sql_ary[$recipient_field] = " + $count_increase";

+ * @param $visibility int Element of {ITEM_APPROVED, ITEM_DELETED, ITEM_REAPPROVE}

+ if (!in_array($visibility, array(ITEM_APPROVED, ITEM_DELETED, ITEM_REAPPROVE)))

+ // If we're soft deleting a topic we only mark approved posts as soft deleted.

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

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

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

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

+<?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;

+ }

+}

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

+ public function __construct($phpbb_root_path, $php_ext, \phpbb\auth\auth $auth, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, \phpbb\user $user)

+abstract class driver implements driver_interface

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ // If we are within a transaction we will not open another one, but enclose the current one to not loose data (preventing auto commit)

+ // If there was a previously opened transaction we do not commit yet...

+ // but count back the number of inner transactions

+ // Check if there is a transaction (no transaction can happen if

+ // there was an error, with a combined rollback and error returning enabled)

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+<?php

+/**

+*

+* @package dbal

+* @copyright (c) 2014 phpBB Group

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

+*

+*/

+

+namespace phpbb\db\driver;

+

+interface driver_interface

+{

+ /**

+ * Gets the exact number of rows in a specified table.

+ *

+ * @param string $table_name Table name

+ * @return string Exact number of rows in $table_name.

+ */

+ public function get_row_count($table_name);

+

+ /**

+ * Gets the estimated number of rows in a specified table.

+ *

+ * @param string $table_name Table name

+ * @return string Number of rows in $table_name.

+ * Prefixed with ~ if estimated (otherwise exact).

+ */

+ public function get_estimated_row_count($table_name);

+

+ /**

+ * Run LOWER() on DB column of type text (i.e. neither varchar nor char).

+ *

+ * @param string $column_name The column name to use

+ * @return string A SQL statement like "LOWER($column_name)"

+ */

+ public function sql_lower_text($column_name);

+

+ /**

+ * Display sql error page

+ *

+ * @param string $sql The SQL query causing the error

+ * @return mixed Returns the full error message, if $this->return_on_error

+ * is set, null otherwise

+ */

+ public function sql_error($sql = '');

+

+ /**

+ * Returns whether results of a query need to be buffered to run a

+ * transaction while iterating over them.

+ *

+ * @return bool Whether buffering is required.

+ */

+ public function sql_buffer_nested_transactions();

+

+ /**

+ * Run binary OR operator on DB column.

+ *

+ * @param string $column_name The column name to use

+ * @param int $bit The value to use for the OR operator,

+ * will be converted to (1 << $bit). Is used by options,

+ * using the number schema... 0, 1, 2...29

+ * @param string $compare Any custom SQL code after the check (e.g. "= 0")

+ * @return string A SQL statement like "$column | (1 << $bit) {$compare}"

+ */

+ public function sql_bit_or($column_name, $bit, $compare = '');

+

+ /**

+ * Version information about used database

+ *

+ * @param bool $raw Only return the fetched sql_server_version

+ * @param bool $use_cache Is it safe to retrieve the value from the cache

+ * @return string sql server version

+ */

+ public function sql_server_info($raw = false, $use_cache = true);

+

+ /**

+ * Return on error or display error message

+ *

+ * @param bool $fail Should we return on errors, or stop

+ * @return null

+ */

+ public function sql_return_on_error($fail = false);

+

+ /**

+ * Build sql statement from an array

+ *

+ * @param string $query Should be on of the following strings:

+ * INSERT, INSERT_SELECT, UPDATE, SELECT, DELETE

+ * @param array $assoc_ary Array with "column => value" pairs

+ * @return string A SQL statement like "c1 = 'a' AND c2 = 'b'"

+ */

+ public function sql_build_array($query, $assoc_ary = array());

+

+ /**

+ * Fetch all rows

+ *

+ * @param mixed $query_id Already executed query to get the rows from,

+ * if false, the last query will be used.

+ * @return mixed Nested array if the query had rows, false otherwise

+ */

+ public function sql_fetchrowset($query_id = false);

+

+ /**

+ * SQL Transaction

+ *

+ * @param string $status Should be one of the following strings:

+ * begin, commit, rollback

+ * @return mixed Buffered, seekable result handle, false on error

+ */

+ public function sql_transaction($status = 'begin');

+

+ /**

+ * Build a concatenated expression

+ *

+ * @param string $expr1 Base SQL expression where we append the second one

+ * @param string $expr2 SQL expression that is appended to the first expression

+ * @return string Concatenated string

+ */

+ public function sql_concatenate($expr1, $expr2);

+

+ /**

+ * Build a case expression

+ *

+ * Note: The two statements action_true and action_false must have the same

+ * data type (int, vchar, ...) in the database!

+ *

+ * @param string $condition The condition which must be true,

+ * to use action_true rather then action_else

+ * @param string $action_true SQL expression that is used, if the condition is true

+ * @param mixed $action_false SQL expression that is used, if the condition is false

+ * @return string CASE expression including the condition and statements

+ */

+ public function sql_case($condition, $action_true, $action_false = false);

+

+ /**

+ * Build sql statement from array for select and select distinct statements

+ *

+ * Possible query values: SELECT, SELECT_DISTINCT

+ *

+ * @param string $query Should be one of: SELECT, SELECT_DISTINCT

+ * @param array $array Array with the query data:

+ * SELECT A comma imploded list of columns to select

+ * FROM Array with "table => alias" pairs,

+ * (alias can also be an array)

+ * Optional: LEFT_JOIN Array of join entries:

+ * FROM Table that should be joined

+ * ON Condition for the join

+ * Optional: WHERE Where SQL statement

+ * Optional: GROUP_BY Group by SQL statement

+ * Optional: ORDER_BY Order by SQL statement

+ * @return string A SQL statement ready for execution

+ */

+ public function sql_build_query($query, $array);

+

+ /**

+ * Fetch field

+ * if rownum is false, the current row is used, else it is pointing to the row (zero-based)

+ *

+ * @param string $field Name of the column

+ * @param mixed $rownum Row number, if false the current row will be used

+ * and the row curser will point to the next row

+ * Note: $rownum is 0 based

+ * @param mixed $query_id Already executed query to get the rows from,

+ * if false, the last query will be used.

+ * @return mixed String value of the field in the selected row,

+ * false, if the row does not exist

+ */

+ public function sql_fetchfield($field, $rownum = false, $query_id = false);

+

+ /**

+ * Fetch current row

+ *

+ * @param mixed $query_id Already executed query to get the rows from,

+ * if false, the last query will be used.

+ * @return mixed Array with the current row,

+ * false, if the row does not exist

+ */

+ public function sql_fetchrow($query_id = false);

+

+ /**

+ * Returns SQL string to cast a string expression to an int.

+ *

+ * @param string $expression An expression evaluating to string

+ * @return string Expression returning an int

+ */

+ public function cast_expr_to_bigint($expression);

+

+ /**

+ * Get last inserted id after insert statement

+ *

+ * @return string Autoincrement value of the last inserted row

+ */

+ public function sql_nextid();

+

+ /**

+ * Add to query count

+ *

+ * @param bool $cached Is this query cached?

+ * @return null

+ */

+ public function sql_add_num_queries($cached = false);

+

+ /**

+ * Build LIMIT query

+ *

+ * @param string $query The SQL query to execute

+ * @param int $total The number of rows to select

+ * @param int $offset

+ * @param int $cache_ttl Either 0 to avoid caching or

+ * the time in seconds which the result shall be kept in cache

+ * @return mixed Buffered, seekable result handle, false on error

+ */

+ public function sql_query_limit($query, $total, $offset = 0, $cache_ttl = 0);

+

+ /**

+ * Base query method

+ *

+ * @param string $query The SQL query to execute

+ * @param int $cache_ttl Either 0 to avoid caching or

+ * the time in seconds which the result shall be kept in cache

+ * @return mixed Buffered, seekable result handle, false on error

+ */

+ public function sql_query($query = '', $cache_ttl = 0);

+

+ /**

+ * Returns SQL string to cast an integer expression to a string.

+ *

+ * @param string $expression An expression evaluating to int

+ * @return string Expression returning a string

+ */

+ public function cast_expr_to_string($expression);

+

+ /**

+ * Connect to server

+ *

+ * @param string $sqlserver Address of the database server

+ * @param string $sqluser User name of the SQL user

+ * @param string $sqlpassword Password of the SQL user

+ * @param string $database Name of the database

+ * @param mixed $port Port of the database server

+ * @param bool $persistency

+ * @param bool $new_link Should a new connection be established

+ * @return mixed Connection ID on success, string error message otherwise

+ */

+ public function sql_connect($sqlserver, $sqluser, $sqlpassword, $database, $port = false, $persistency = false, $new_link = false);

+

+ /**

+ * Run binary AND operator on DB column.

+ * Results in sql statement: "{$column_name} & (1 << {$bit}) {$compare}"

+ *

+ * @param string $column_name The column name to use

+ * @param int $bit The value to use for the AND operator,

+ * will be converted to (1 << $bit). Is used by

+ * options, using the number schema: 0, 1, 2...29

+ * @param string $compare Any custom SQL code after the check (for example "= 0")

+ * @return string A SQL statement like: "{$column} & (1 << {$bit}) {$compare}"

+ */

+ public function sql_bit_and($column_name, $bit, $compare = '');

+

+ /**

+ * Free sql result

+ *

+ * @param mixed $query_id Already executed query result,

+ * if false, the last query will be used.

+ * @return null

+ */

+ public function sql_freeresult($query_id = false);

+

+ /**

+ * Return number of sql queries and cached sql queries used

+ *

+ * @param bool $cached Should we return the number of cached or normal queries?

+ * @return int Number of queries that have been executed

+ */

+ public function sql_num_queries($cached = false);

+

+ /**

+ * Run more than one insert statement.

+ *

+ * @param string $table Table name to run the statements on

+ * @param array $sql_ary Multi-dimensional array holding the statement data

+ * @return bool false if no statements were executed.

+ */

+ public function sql_multi_insert($table, $sql_ary);

+

+ /**

+ * Return number of affected rows

+ *

+ * @return mixed Number of the affected rows by the last query

+ * false if no query has been run before

+ */

+ public function sql_affectedrows();

+

+ /**

+ * DBAL garbage collection, close SQL connection

+ *

+ * @return mixed False if no connection was opened before,

+ * Server response otherwise

+ */

+ public function sql_close();

+

+ /**

+ * Seek to given row number

+ *

+ * @param mixed $rownum Row number the curser should point to

+ * Note: $rownum is 0 based

+ * @param mixed $query_id ID of the query to set the row cursor on

+ * if false, the last query will be used.

+ * $query_id will then be set correctly

+ * @return bool False if something went wrong

+ */

+ public function sql_rowseek($rownum, &$query_id);

+

+ /**

+ * Escape string used in sql query

+ *

+ * @param string $msg String to be escaped

+ * @return string Escaped version of $msg

+ */

+ public function sql_escape($msg);

+

+ /**

+ * Correctly adjust LIKE expression for special characters

+ * Some DBMS are handling them in a different way

+ *

+ * @param string $expression The expression to use. Every wildcard is

+ * escaped, except $this->any_char and $this->one_char

+ * @return string A SQL statement like: "LIKE 'bertie_%'"

+ */

+ public function sql_like_expression($expression);

+

+ /**

+ * Explain queries

+ *

+ * @param string $mode Available modes: display, start, stop,

+ * add_select_row, fromcache, record_fromcache

+ * @param string $query The Query that should be explained

+ * @return mixed Either a full HTML page, boolean or null

+ */

+ public function sql_report($mode, $query = '');

+

+ /**

+ * Build IN or NOT IN sql comparison string, uses <> or = on single element

+ * arrays to improve comparison speed

+ *

+ * @param string $field Name of the sql column that shall be compared

+ * @param array $array Array of values that are (not) allowed

+ * @param bool $negate true for NOT IN (), false for IN ()

+ * @param bool $allow_empty_set If true, allow $array to be empty,

+ * this function will return 1=1 or 1=0 then.

+ * @return string A SQL statement like: "IN (1, 2, 3, 4)" or "= 1"

+ */

+ public function sql_in_set($field, $array, $negate = false, $allow_empty_set = false);

+}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ * {@inheritDoc}

+ *

+<?php

+/**

+*

+* @package dbal

+* @copyright (c) 2014 phpBB Group

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

+*

+*/

+

+namespace phpbb\db\driver;

+

+/**

+* SQLite3 Database Abstraction Layer

+* Minimum Requirement: 3.6.15+

+* @package dbal

+*/

+class sqlite3 extends \phpbb\db\driver\driver

+{

+ /**

+ * @var string Stores errors during connection setup in case the driver is not available

+ */

+ protected $connect_error = '';

+

+ /**

+ * @var \SQLite3 The SQLite3 database object to operate against

+ */

+ protected $dbo = null;

+

+ /**

+ * {@inheritDoc}

+ */

+ public function sql_connect($sqlserver, $sqluser, $sqlpassword, $database, $port = false, $persistency = false, $new_link = false)

+ {

+ $this->persistency = false;

+ $this->user = $sqluser;

+ $this->server = $sqlserver . (($port) ? ':' . $port : '');

+ $this->dbname = $database;

+

+ if (!class_exists('SQLite3', false))

+ {

+ $this->connect_error = 'SQLite3 not found, is the extension installed?';

+ return $this->sql_error('');

+ }

+

+ try

+ {

+ $this->dbo = new \SQLite3($this->server, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE);

+ $this->db_connect_id = true;

+ }

+ catch (Exception $e)

+ {

+ return array('message' => $e->getMessage());

+ }

+

+ return true;

+ }

+

+ /**

+ * {@inheritDoc}

+ */

+ public function sql_server_info($raw = false, $use_cache = true)

+ {

+ global $cache;

+

+ if (!$use_cache || empty($cache) || ($this->sql_server_version = $cache->get('sqlite_version')) === false)

+ {

+ $version = \SQLite3::version();

+

+ $this->sql_server_version = $version['versionString'];

+

+ if (!empty($cache) && $use_cache)

+ {

+ $cache->put('sqlite_version', $this->sql_server_version);

+ }

+ }

+

+ return ($raw) ? $this->sql_server_version : 'SQLite ' . $this->sql_server_version;

+ }

+

+ /**

+ * SQL Transaction

+ *

+ * @param string $status Should be one of the following strings:

+ * begin, commit, rollback

+ * @return bool Success/failure of the transaction query

+ */

+ protected function _sql_transaction($status = 'begin')

+ {

+ switch ($status)

+ {

+ case 'begin':

+ return $this->dbo->exec('BEGIN IMMEDIATE');

+ break;

+

+ case 'commit':

+ return $this->dbo->exec('COMMIT');

+ break;

+

+ case 'rollback':

+ return $this->dbo->exec('ROLLBACK');

+ break;

+ }

+

+ return true;

+ }

+

+ /**

+ * {@inheritDoc}

+ */

+ public function sql_query($query = '', $cache_ttl = 0)

+ {

+ if ($query != '')

+ {

+ global $cache;

+

+ // EXPLAIN only in extra debug mode

+ if (defined('DEBUG'))

+ {

+ $this->sql_report('start', $query);

+ }

+

+ $this->last_query_text = $query;

+ $this->query_result = ($cache && $cache_ttl) ? $cache->sql_load($query) : false;

+ $this->sql_add_num_queries($this->query_result);

+

+ if ($this->query_result === false)

+ {

+ if (($this->query_result = @$this->dbo->query($query)) === false)

+ {

+ $this->sql_error($query);

+ }

+

+ if (defined('DEBUG'))

+ {

+ $this->sql_report('stop', $query);

+ }

+

+ if ($cache && $cache_ttl)

+ {

+ $this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);

+ }

+ }

+ else if (defined('DEBUG'))

+ {

+ $this->sql_report('fromcache', $query);

+ }

+ }

+ else

+ {

+ return false;

+ }

+

+ return $this->query_result;

+ }

+

+ /**

+ * Build LIMIT query

+ *

+ * @param string $query The SQL query to execute

+ * @param int $total The number of rows to select

+ * @param int $offset

+ * @param int $cache_ttl Either 0 to avoid caching or

+ * the time in seconds which the result shall be kept in cache

+ * @return mixed Buffered, seekable result handle, false on error

+ */

+ protected function _sql_query_limit($query, $total, $offset = 0, $cache_ttl = 0)

+ {

+ $this->query_result = false;

+

+ // if $total is set to 0 we do not want to limit the number of rows

+ if ($total == 0)

+ {

+ $total = -1;

+ }

+

+ $query .= "\n LIMIT " . ((!empty($offset)) ? $offset . ', ' . $total : $total);

+

+ return $this->sql_query($query, $cache_ttl);

+ }

+

+ /**

+ * {@inheritDoc}

+ */

+ public function sql_affectedrows()

+ {

+ return ($this->db_connect_id) ? $this->dbo->changes() : false;

+ }

+

+ /**

+ * {@inheritDoc}

+ */

+ public function sql_fetchrow($query_id = false)

+ {

+ global $cache;

+

+ if ($query_id === false)

+ {

+ $query_id = $this->query_result;

+ }

+

+ if ($cache && !is_object($query_id) && $cache->sql_exists($query_id))

+ {

+ return $cache->sql_fetchrow($query_id);

+ }

+

+ return is_object($query_id) ? $query_id->fetchArray(SQLITE3_ASSOC) : false;

+ }

+

+ /**

+ * {@inheritDoc}

+ */

+ public function sql_nextid()

+ {

+ return ($this->db_connect_id) ? $this->dbo->lastInsertRowID() : false;

+ }

+

+ /**

+ * {@inheritDoc}

+ */

+ public function sql_freeresult($query_id = false)

+ {

+ global $cache;

+

+ if ($query_id === false)

+ {

+ $query_id = $this->query_result;

+ }

+

+ if ($cache && !is_object($query_id) && $cache->sql_exists($query_id))

+ {

+ return $cache->sql_freeresult($query_id);

+ }

+

+ if ($query_id)

+ {

+ return @$query_id->finalize();

+ }

+ }

+

+ /**

+ * {@inheritDoc}

+ */

+ public function sql_escape($msg)

+ {

+ return \SQLite3::escapeString($msg);

+ }

+

+ /**

+ * {@inheritDoc}

+ *

+ * For SQLite an underscore is a not-known character...

+ */

+ public function sql_like_expression($expression)

+ {

+ // Unlike LIKE, GLOB is case sensitive (unfortunatly). SQLite users need to live with it!

+ // We only catch * and ? here, not the character map possible on file globbing.

+ $expression = str_replace(array(chr(0) . '_', chr(0) . '%'), array(chr(0) . '?', chr(0) . '*'), $expression);

+

+ $expression = str_replace(array('?', '*'), array("\?", "\*"), $expression);

+ $expression = str_replace(array(chr(0) . "\?", chr(0) . "\*"), array('?', '*'), $expression);

+

+ return 'GLOB \'' . $this->sql_escape($expression) . '\'';

+ }

+

+ /**

+ * return sql error array

+ *

+ * @return array

+ */

+ protected function _sql_error()

+ {

+ if (class_exists('SQLite3', false))

+ {

+ $error = array(

+ 'message' => $this->dbo->lastErrorMsg(),

+ 'code' => $this->dbo->lastErrorCode(),

+ );

+ }

+ else

+ {

+ $error = array(

+ 'message' => $this->connect_error,

+ 'code' => '',

+ );

+ }

+

+ return $error;

+ }

+

+ /**

+ * Build db-specific query data

+ *

+ * @param string $stage Available stages: FROM, WHERE

+ * @param mixed $data A string containing the CROSS JOIN query or an array of WHERE clauses

+ *

+ * @return string The db-specific query fragment

+ */

+ protected function _sql_custom_build($stage, $data)

+ {

+ return $data;

+ }

+

+ /**

+ * Close sql connection

+ *

+ * @return bool False if failure

+ */

+ protected function _sql_close()

+ {

+ return $this->dbo->close();

+ }

+

+ /**

+ * Build db-specific report

+ *

+ * @param string $mode Available modes: display, start, stop,

+ * add_select_row, fromcache, record_fromcache

+ * @param string $query The Query that should be explained

+ * @return mixed Either a full HTML page, boolean or null

+ */

+ protected function _sql_report($mode, $query = '')

+ {

+ switch ($mode)

+ {

+ case 'start':

+

+ $explain_query = $query;

+ if (preg_match('/UPDATE ([a-z0-9_]+).*?WHERE(.*)/s', $query, $m))

+ {

+ $explain_query = 'SELECT * FROM ' . $m[1] . ' WHERE ' . $m[2];

+ }

+ else if (preg_match('/DELETE FROM ([a-z0-9_]+).*?WHERE(.*)/s', $query, $m))

+ {

+ $explain_query = 'SELECT * FROM ' . $m[1] . ' WHERE ' . $m[2];

+ }

+

+ if (preg_match('/^SELECT/', $explain_query))

+ {

+ $html_table = false;

+

+ if ($result = $this->dbo->query("EXPLAIN QUERY PLAN $explain_query"))

+ {

+ while ($row = $result->fetchArray(SQLITE3_ASSOC))

+ {

+ $html_table = $this->sql_report('add_select_row', $query, $html_table, $row);

+ }

+ }

+

+ if ($html_table)

+ {

+ $this->html_hold .= '</table>';

+ }

+ }

+

+ break;

+

+ case 'fromcache':

+ $endtime = explode(' ', microtime());

+ $endtime = $endtime[0] + $endtime[1];

+

+ $result = $this->dbo->query($query);

+ while ($void = $result->fetchArray(SQLITE3_ASSOC))

+ {

+ // Take the time spent on parsing rows into account

+ }

+

+ $splittime = explode(' ', microtime());

+ $splittime = $splittime[0] + $splittime[1];

+

+ $this->sql_report('record_fromcache', $query, $endtime, $splittime);

+

+ break;

+ }

+ }

+}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

+<?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 auth_provider_oauth2 extends \phpbb\db\migration\migration

+{

+ static public function depends_on()

+ {

+ return array(

+ '\phpbb\db\migration\data\v310\auth_provider_oauth',

+ );

+ }

+

+ public function update_data()

+ {

+ return array(

+ array('custom', array(

+ array($this, 'update_auth_link_module_auth'),

+ )),

+ );

+ }

+

+ public function update_auth_link_module_auth()

+ {

+ $sql = 'UPDATE ' . MODULES_TABLE . "

+ SET module_auth = 'authmethod_oauth'

+ WHERE module_class = 'ucp'

+ AND module_basename = 'ucp_auth_link'

+ AND module_mode = 'auth_link'

+ AND module_auth = ''";

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

+ }

+}

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

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

+<?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 board_contact_name extends \phpbb\db\migration\migration

+{

+ public function effectively_installed()

+ {

+ return isset($this->config['board_contact_name']);

+ }

+

+ static public function depends_on()

+ {

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

+ }

+

+ public function update_data()

+ {

+ return array(

+ array('config.add', array('board_contact_name', '')),

+ );

+ }

+}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

+<?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',

+ ),

+ ),

+ );

+ }

+}

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

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

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

+ if (!$start)

+ {

+ // Preserve the forum_posts value for link forums as it represents redirects.

+ $sql = 'UPDATE ' . $this->table_prefix . 'forums

+ SET forum_posts_approved = forum_posts

+ WHERE forum_type = ' . FORUM_LINK;

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

+ }

+

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

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

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

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

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

+ public function update_timezones($start)

+ $start = (int) $start;

+ $limit = 500;

+ $converted = 0;

+

+ $update_blocks = array();

+ $sql = 'SELECT user_id, user_timezone, user_dst

+ FROM ' . $this->table_prefix . 'users

+ ORDER BY user_id ASC';

+ $result = $this->db->sql_query_limit($sql, $limit, $start);

+ $converted++;

+

+ // In case this is somehow run twice on a row.

+ // Otherwise it would just end up as UTC on the second run

+ if (is_numeric($row['user_timezone']))

+ {

+ $update_blocks[$row['user_timezone'] . ':' . $row['user_dst']][] = (int) $row['user_id'];

+ }

+ }

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

+

+ // Update blocks of users who share the same timezone/dst

+ foreach ($update_blocks as $timezone => $user_ids)

+ {

+ $timezone = explode(':', $timezone);

+ $converted_timezone = $this->convert_phpbb30_timezone($timezone[0], $timezone[1]);

+

+ SET user_timezone = '" . $this->db->sql_escape($converted_timezone) . "'

+ WHERE " . $this->db->sql_in_set('user_id', $user_ids);

+

+ if ($converted == $limit)

+ {

+ // There are still more to convert

+ return $start + $limit;

+ }

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

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

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

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

+ /** @var \phpbb\db\driver\driver_interface */

+ * @param \phpbb\db\driver\driver_interface $db

+ public function __construct(\phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, \phpbb\db\tools $db_tools, $phpbb_root_path, $php_ext, $table_prefix)

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

+ /** @var \phpbb\db\driver\driver_interface */

+ /** @var array */

+ protected $dependencies = array();

+

+ public function __construct(array $class_names, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, \phpbb\db\tools $db_tools, $phpbb_root_path, $php_ext, $table_prefix)

+ $check_dependencies = true;

+

+ else if ($check_dependencies)

+ {

+ $this->dependencies = array_merge($this->dependencies, $open_dependencies);

+ }

+ }

+

+ // Only run this check after the first run

+ if ($check_dependencies)

+ {

+ $this->check_dependencies();

+ $check_dependencies = false;

+

+ /**

+ * Check if one of the migrations files' dependencies can't be resolved

+ * by the supplied list of migrations

+ *

+ * @throws UnexpectedValueException If a dependency can't be resolved

+ */

+ protected function check_dependencies()

+ {

+ // Strip duplicate values from array

+ $this->dependencies = array_unique($this->dependencies);

+

+ foreach ($this->dependencies as $dependency)

+ {

+ if (!in_array($dependency, $this->class_names))

+ {

+ throw new \UnexpectedValueException("Unable to resolve the dependency '$dependency'");

+ }

+ }

+ }

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

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

+ /** @var \phpbb\db\driver\driver_interface */

+ * @param \phpbb\db\driver\driver_interface $db

+ public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\cache\service $cache, \phpbb\user $user, $phpbb_root_path, $php_ext, $modules_table)

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

+ /** @var \phpbb\db\driver\driver_interface */

+ * @param \phpbb\db\driver\driver_interface $db

+ public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\cache\service $cache, \phpbb\auth\auth $auth, $phpbb_root_path, $php_ext)

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

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

+ /** @var \phpbb\db\driver\driver_interface */

+ public function __construct(\phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, \phpbb\db\tools $db_tools, $migrations_table, $phpbb_root_path, $php_ext, $table_prefix, $tools, \phpbb\db\migration\helper $helper)

+ if ($reverse)

+ {

+ return false;

+ }

+ else

+ {

+ return array(

+ $parameters[0],

+ array($last_result),

+ );

+ }

+ /** @var \phpbb\db\driver\driver_interface */

+ * @param \phpbb\db\driver\driver_interface $db

+ public function __construct(\phpbb\db\driver\driver_interface $db, $table_name, $max_buffered_rows = 500)

+ * Is the used MS SQL Server a SQL Server 2000?

+ * @var bool

+ */

+ protected $is_sql_server_2000;

+

+ /**

+ 'sqlite3' => array(

+ 'INT:' => 'INT(%d)',

+ 'BINT' => 'BIGINT(20)',

+ 'UINT' => 'INTEGER UNSIGNED',

+ 'UINT:' => 'INTEGER UNSIGNED',

+ 'TINT:' => 'TINYINT(%d)',

+ 'USINT' => 'INTEGER UNSIGNED',

+ 'BOOL' => 'INTEGER UNSIGNED',

+ 'VCHAR' => 'VARCHAR(255)',

+ 'VCHAR:' => 'VARCHAR(%d)',

+ 'CHAR:' => 'CHAR(%d)',

+ 'XSTEXT' => 'TEXT(65535)',

+ 'STEXT' => 'TEXT(65535)',

+ 'TEXT' => 'TEXT(65535)',

+ 'MTEXT' => 'MEDIUMTEXT(16777215)',

+ 'XSTEXT_UNI'=> 'TEXT(65535)',

+ 'STEXT_UNI' => 'TEXT(65535)',

+ 'TEXT_UNI' => 'TEXT(65535)',

+ 'MTEXT_UNI' => 'MEDIUMTEXT(16777215)',

+ 'TIMESTAMP' => 'INTEGER UNSIGNED', //'int(11) UNSIGNED',

+ 'DECIMAL' => 'DECIMAL(5,2)',

+ 'DECIMAL:' => 'DECIMAL(%d,2)',

+ 'PDECIMAL' => 'DECIMAL(6,3)',

+ 'PDECIMAL:' => 'DECIMAL(%d,3)',

+ 'VCHAR_UNI' => 'VARCHAR(255)',

+ 'VCHAR_UNI:'=> 'VARCHAR(%d)',

+ 'VCHAR_CI' => 'VARCHAR(255)',

+ 'VARBINARY' => 'BLOB',

+ ),

+

+ var $supported_dbms = array('firebird', 'mssql', 'mssqlnative', 'mysql_40', 'mysql_41', 'oracle', 'postgres', 'sqlite', 'sqlite3');

+ * @param \phpbb\db\driver\driver_interface $db Database connection

+ public function __construct(\phpbb\db\driver\driver_interface $db, $return_statements = false)

+ case 'sqlite3':

+ $sql = 'SELECT name

+ FROM sqlite_master

+ WHERE type = "table"

+ AND name <> "sqlite_sequence"';

+ break;

+

+ case 'sqlite3':

+ case 'sqlite3':

+ if (($this->db->sql_layer == 'sqlite' || $this->db->sql_layer == 'sqlite3') && $this->return_statements)

+ // Add unique indexes?

+ case 'sqlite3':

+ case 'sqlite3':

+ case 'sqlite3':

+ * Check if a specified index exists in table. Does not return PRIMARY KEY indexes.

+ case 'sqlite3':

+ if (($this->sql_layer == 'sqlite' || $this->sql_layer == 'sqlite3') && !$row['unique'])

+ case 'sqlite3':

+ case 'sqlite3':

+

+ if ($this->sql_layer === 'sqlite3')

+ {

+ $sql .= ' AUTOINCREMENT';

+ }

+ $recreate_queries = $this->sqlite_get_recreate_table_queries($table_name);

+ if (empty($recreate_queries))

+ break;

+ }

+ $statements[] = 'begin';

+ $sql_create_table = array_shift($recreate_queries);

+ // Create a backup table and populate it, destroy the existing one

+ $statements[] = preg_replace('#CREATE\s+TABLE\s+"?' . $table_name . '"?#i', 'CREATE TEMPORARY TABLE ' . $table_name . '_temp', $sql_create_table);

+ $statements[] = 'INSERT INTO ' . $table_name . '_temp SELECT * FROM ' . $table_name;

+ $statements[] = 'DROP TABLE ' . $table_name;

+ preg_match('#\((.*)\)#s', $sql_create_table, $matches);

+ $new_table_cols = trim($matches[1]);

+ $old_table_cols = preg_split('/,(?![\s\w]+\))/m', $new_table_cols);

+ $column_list = array();

+ foreach ($old_table_cols as $declaration)

+ {

+ $entities = preg_split('#\s+#', trim($declaration));

+ if ($entities[0] == 'PRIMARY')

+ continue;

+ $column_list[] = $entities[0];

+ }

+ $columns = implode(',', $column_list);

+ $new_table_cols = $column_name . ' ' . $column_data['column_type_sql'] . ',' . $new_table_cols;

+ // create a new table and fill it up. destroy the temp one

+ $statements[] = 'CREATE TABLE ' . $table_name . ' (' . $new_table_cols . ');';

+ $statements = array_merge($statements, $recreate_queries);

+ $statements[] = 'INSERT INTO ' . $table_name . ' (' . $columns . ') SELECT ' . $columns . ' FROM ' . $table_name . '_temp;';

+ $statements[] = 'DROP TABLE ' . $table_name . '_temp';

+

+ $statements[] = 'commit';

+ break;

+

+ case 'sqlite3':

+ if ($inline && $this->return_statements)

+ return $column_name . ' ' . $column_data['column_type_sql'];

+

+ $statements[] = 'ALTER TABLE ' . $table_name . ' ADD ' . $column_name . ' ' . $column_data['column_type_sql'];

+ // We need the data here

+ $old_return_statements = $this->return_statements;

+ $this->return_statements = true;

+ $indexes = $this->mssql_get_existing_indexes($table_name, $column_name);

+ // Drop any indexes

+ $recreate_indexes = array();

+ if (!empty($indexes))

+ {

+ foreach ($indexes as $index_name => $index_data)

+ $result = $this->sql_index_drop($table_name, $index_name);

+ $statements = array_merge($statements, $result);

+ if (sizeof($index_data) > 1)

+ {

+ // Remove this column from the index and recreate it

+ $recreate_indexes[$index_name] = array_diff($index_data, array($column_name));

+ }

+ // Drop default value constraint

+ $result = $this->mssql_get_drop_default_constraints_queries($table_name, $column_name);

+ $statements = array_merge($statements, $result);

+

+ // Remove the column

+

+ if (!empty($recreate_indexes))

+ {

+ // Recreate indexes after we removed the column

+ foreach ($recreate_indexes as $index_name => $index_data)

+ {

+ $result = $this->sql_create_index($table_name, $index_name, $index_data);

+ $statements = array_merge($statements, $result);

+ }

+ }

+

+ $this->return_statements = $old_return_statements;

+ case 'sqlite3':

+ $recreate_queries = $this->sqlite_get_recreate_table_queries($table_name, $column_name);

+ if (empty($recreate_queries))

+ break;

+ }

+ $statements[] = 'begin';

+ $sql_create_table = array_shift($recreate_queries);

+ // Create a backup table and populate it, destroy the existing one

+ $statements[] = preg_replace('#CREATE\s+TABLE\s+"?' . $table_name . '"?#i', 'CREATE TEMPORARY TABLE ' . $table_name . '_temp', $sql_create_table);

+ $statements[] = 'INSERT INTO ' . $table_name . '_temp SELECT * FROM ' . $table_name;

+ $statements[] = 'DROP TABLE ' . $table_name;

+ preg_match('#\((.*)\)#s', $sql_create_table, $matches);

+ $new_table_cols = trim($matches[1]);

+ $old_table_cols = preg_split('/,(?![\s\w]+\))/m', $new_table_cols);

+ $column_list = array();

+ foreach ($old_table_cols as $declaration)

+ {

+ $entities = preg_split('#\s+#', trim($declaration));

+ if ($entities[0] == 'PRIMARY' || $entities[0] === $column_name)

+ continue;

+ $column_list[] = $entities[0];

+ }

+ $columns = implode(',', $column_list);

+ $new_table_cols = trim(preg_replace('/' . $column_name . '[^,]+(?:,|$)/m', '', $new_table_cols));

+ if (substr($new_table_cols, -1) === ',')

+ // Remove the comma from the last entry again

+ $new_table_cols = substr($new_table_cols, 0, -1);

+

+ // create a new table and fill it up. destroy the temp one

+ $statements[] = 'CREATE TABLE ' . $table_name . ' (' . $new_table_cols . ');';

+ $statements = array_merge($statements, $recreate_queries);

+

+ $statements[] = 'INSERT INTO ' . $table_name . ' (' . $columns . ') SELECT ' . $columns . ' FROM ' . $table_name . '_temp;';

+ $statements[] = 'DROP TABLE ' . $table_name . '_temp';

+

+ $statements[] = 'commit';

+ case 'sqlite3':

+ case 'sqlite3':

+ $recreate_queries = $this->sqlite_get_recreate_table_queries($table_name);

+ if (empty($recreate_queries))

+ $sql_create_table = array_shift($recreate_queries);

+

+ $statements[] = preg_replace('#CREATE\s+TABLE\s+"?' . $table_name . '"?#i', 'CREATE TEMPORARY TABLE ' . $table_name . '_temp', $sql_create_table);

+ preg_match('#\((.*)\)#s', $sql_create_table, $matches);

+ $statements = array_merge($statements, $recreate_queries);

+

+ case 'sqlite3':

+ case 'sqlite3':

+ case 'sqlite3':

+ case 'sqlite3':

+ // We need the data here

+ $old_return_statements = $this->return_statements;

+ $this->return_statements = true;

+

+ $indexes = $this->mssql_get_existing_indexes($table_name, $column_name);

+

+ // Drop any indexes

+ if (!empty($indexes))

+ {

+ foreach ($indexes as $index_name => $index_data)

+ {

+ $result = $this->sql_index_drop($table_name, $index_name);

+ $statements = array_merge($statements, $result);

+ }

+ }

+

+ // Drop default value constraint

+ $result = $this->mssql_get_drop_default_constraints_queries($table_name, $column_name);

+ $statements = array_merge($statements, $result);

+

+ // Change the column

+ // Add new default value constraint

+ $statements[] = 'ALTER TABLE [' . $table_name . '] ADD CONSTRAINT [DF_' . $table_name . '_' . $column_name . '_1] ' . $this->db->sql_escape($column_data['default']) . ' FOR [' . $column_name . ']';

+ }

+ if (!empty($indexes))

+ {

+ // Recreate indexes after we changed the column

+ foreach ($indexes as $index_name => $index_data)

+ $result = $this->sql_create_index($table_name, $index_name, $index_data);

+ $statements = array_merge($statements, $result);

+

+ $this->return_statements = $old_return_statements;

+ case 'sqlite3':

+ $recreate_queries = $this->sqlite_get_recreate_table_queries($table_name);

+ if (empty($recreate_queries))

+ $sql_create_table = array_shift($recreate_queries);

+

+ $statements[] = preg_replace('#CREATE\s+TABLE\s+"?' . $table_name . '"?#i', 'CREATE TEMPORARY TABLE ' . $table_name . '_temp', $sql_create_table);

+ preg_match('#\((.*)\)#s', $sql_create_table, $matches);

+ // Create a new table and fill it up. destroy the temp one

+ $statements = array_merge($statements, $recreate_queries);

+

+

+ /**

+ * Get queries to drop the default constraints of a column

+ *

+ * We need to drop the default constraints of a column,

+ * before being able to change their type or deleting them.

+ *

+ * @param string $table_name

+ * @param string $column_name

+ * @return array Array with SQL statements

+ */

+ protected function mssql_get_drop_default_constraints_queries($table_name, $column_name)

+ {

+ $statements = array();

+ if ($this->mssql_is_sql_server_2000())

+ {

+ // http://msdn.microsoft.com/en-us/library/aa175912%28v=sql.80%29.aspx

+ // Deprecated in SQL Server 2005

+ $sql = "SELECT so.name AS def_name

+ FROM sysobjects so

+ JOIN sysconstraints sc ON so.id = sc.constid

+ WHERE object_name(so.parent_obj) = '{$table_name}'

+ AND so.xtype = 'D'

+ AND sc.colid = (SELECT colid FROM syscolumns

+ WHERE id = object_id('{$table_name}')

+ AND name = '{$column_name}')";

+ }

+ else

+ {

+ $sql = "SELECT dobj.name AS def_name

+ FROM sys.columns col

+ LEFT OUTER JOIN sys.objects dobj ON (dobj.object_id = col.default_object_id AND dobj.type = 'D')

+ WHERE col.object_id = object_id('{$table_name}')

+ AND col.name = '{$column_name}'

+ AND dobj.name IS NOT NULL";

+ }

+

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

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

+ {

+ $statements[] = 'ALTER TABLE [' . $table_name . '] DROP CONSTRAINT [' . $row['def_name'] . ']';

+ }

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

+

+ return $statements;

+ }

+

+ /**

+ * Get a list with existing indexes for the column

+ *

+ * @param string $table_name

+ * @param string $column_name

+ * @return array Array with Index name => columns

+ */

+ protected function mssql_get_existing_indexes($table_name, $column_name)

+ {

+ $existing_indexes = array();

+ if ($this->mssql_is_sql_server_2000())

+ {

+ // http://msdn.microsoft.com/en-us/library/aa175912%28v=sql.80%29.aspx

+ // Deprecated in SQL Server 2005

+ $sql = "SELECT DISTINCT ix.name AS phpbb_index_name

+ FROM sysindexes ix

+ INNER JOIN sysindexkeys ixc

+ ON ixc.id = ix.id

+ AND ixc.indid = ix.indid

+ INNER JOIN syscolumns cols

+ ON cols.colid = ixc.colid

+ AND cols.id = ix.id

+ WHERE ix.id = object_id('{$table_name}')

+ AND cols.name = '{$column_name}'";

+ }

+ else

+ {

+ $sql = "SELECT DISTINCT ix.name AS phpbb_index_name

+ FROM sys.indexes ix

+ INNER JOIN sys.index_columns ixc

+ ON ixc.object_id = ix.object_id

+ AND ixc.index_id = ix.index_id

+ INNER JOIN sys.columns cols

+ ON cols.column_id = ixc.column_id

+ AND cols.object_id = ix.object_id

+ WHERE ix.object_id = object_id('{$table_name}')

+ AND cols.name = '{$column_name}'";

+ }

+

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

+ $existing_indexes = array();

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

+ {

+ $existing_indexes[$row['phpbb_index_name']] = array();

+ }

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

+

+ if (empty($existing_indexes))

+ {

+ return array();

+ }

+

+ if ($this->mssql_is_sql_server_2000())

+ {

+ $sql = "SELECT DISTINCT ix.name AS phpbb_index_name, cols.name AS phpbb_column_name

+ FROM sysindexes ix

+ INNER JOIN sysindexkeys ixc

+ ON ixc.id = ix.id

+ AND ixc.indid = ix.indid

+ INNER JOIN syscolumns cols

+ ON cols.colid = ixc.colid

+ AND cols.id = ix.id

+ WHERE ix.id = object_id('{$table_name}')

+ AND " . $this->db->sql_in_set('ix.name', array_keys($existing_indexes));

+ }

+ else

+ {

+ $sql = "SELECT DISTINCT ix.name AS phpbb_index_name, cols.name AS phpbb_column_name

+ FROM sys.indexes ix

+ INNER JOIN sys.index_columns ixc

+ ON ixc.object_id = ix.object_id

+ AND ixc.index_id = ix.index_id

+ INNER JOIN sys.columns cols

+ ON cols.column_id = ixc.column_id

+ AND cols.object_id = ix.object_id

+ WHERE ix.object_id = object_id('{$table_name}')

+ AND " . $this->db->sql_in_set('ix.name', array_keys($existing_indexes));

+ }

+

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

+

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

+ {

+ $existing_indexes[$row['phpbb_index_name']][] = $row['phpbb_column_name'];

+ }

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

+

+ return $existing_indexes;

+ }

+

+ /**

+ * Is the used MS SQL Server a SQL Server 2000?

+ *

+ * @return bool

+ */

+ protected function mssql_is_sql_server_2000()

+ {

+ if ($this->is_sql_server_2000 === null)

+ {

+ $sql = "SELECT CAST(SERVERPROPERTY('productversion') AS VARCHAR(25)) AS mssql_version";

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

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

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

+ $this->is_sql_server_2000 = $properties['mssql_version'][0] == '8';

+ }

+

+ return $this->is_sql_server_2000;

+ }

+

+ /**

+ * Returns the Queries which are required to recreate a table including indexes

+ *

+ * @param string $table_name

+ * @param string $remove_column When we drop a column, we remove the column

+ * from all indexes. If the index has no other

+ * column, we drop it completly.

+ * @return array

+ */

+ protected function sqlite_get_recreate_table_queries($table_name, $remove_column = '')

+ {

+ $queries = array();

+

+ $sql = "SELECT sql

+ FROM sqlite_master

+ WHERE type = 'table'

+ AND name = '{$table_name}'";

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

+ $sql_create_table = $this->db->sql_fetchfield('sql');

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

+

+ if (!$sql_create_table)

+ {

+ return array();

+ }

+ $queries[] = $sql_create_table;

+

+ $sql = "SELECT sql

+ FROM sqlite_master

+ WHERE type = 'index'

+ AND tbl_name = '{$table_name}'";

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

+ while ($sql_create_index = $this->db->sql_fetchfield('sql'))

+ {

+ if ($remove_column)

+ {

+ $match = array();

+ preg_match('#(?:[\w ]+)\((.*)\)#', $sql_create_index, $match);

+ if (!isset($match[1]))

+ {

+ continue;

+ }

+

+ // Find and remove $remove_column from the index

+ $columns = explode(', ', $match[1]);

+ $found_column = array_search($remove_column, $columns);

+ if ($found_column !== false)

+ {

+ unset($columns[$found_column]);

+

+ // If the column list is not empty add the index to the list

+ if (!empty($columns))

+ {

+ $queries[] = str_replace($match[1], implode(', ', $columns), $sql_create_index);

+ }

+ }

+ else

+ {

+ $queries[] = $sql_create_index;

+ }

+ }

+ else

+ {

+ $queries[] = $sql_create_index;

+ }

+ }

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

+

+ return $queries;

+ }

+<?php

+/**

+*

+* @package phpBB3

+* @copyright (c) 2014 phpBB Group

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

+*

+*/

+

+namespace phpbb\event;

+

+/**

+* Class md_exporter

+* Crawls through a markdown file and grabs all events

+*

+* @package phpbb\event

+*/

+class md_exporter

+{

+ /** @var string Path where we look for files*/

+ protected $path;

+

+ /** @var string phpBB Root Path */

+ protected $root_path;

+

+ /** @var string */

+ protected $filter;

+

+ /** @var string */

+ protected $current_event;

+

+ /** @var array */

+ protected $events;

+

+ /**

+ * @param string $phpbb_root_path

+ * @param mixed $extension String 'vendor/ext' to filter, null for phpBB core

+ */

+ public function __construct($phpbb_root_path, $extension = null)

+ {

+ $this->root_path = $phpbb_root_path;

+ $this->path = $this->root_path;

+ if ($extension)

+ {

+ $this->path .= 'ext/' . $extension . '/';

+ }

+

+ $this->events = array();

+ $this->events_by_file = array();

+ $this->filter = $this->current_event = '';

+ }

+

+ /**

+ * Get the list of all events

+ *

+ * @return array Array with events: name => details

+ */

+ public function get_events()

+ {

+ return $this->events;

+ }

+

+ /**

+ * @param string $md_file Relative from phpBB root

+ * @return int Number of events found

+ * @throws \LogicException

+ */

+ public function crawl_phpbb_directory_adm($md_file)

+ {

+ $this->crawl_eventsmd($md_file, 'adm');

+

+ $file_list = $this->get_recursive_file_list($this->path . 'adm/style/');

+ foreach ($file_list as $file)

+ {

+ $file_name = 'adm/style/' . $file;

+ $this->validate_events_from_file($file_name, $this->crawl_file_for_events($file_name));

+ }

+

+ return sizeof($this->events);

+ }

+

+ /**

+ * @param string $md_file Relative from phpBB root

+ * @return int Number of events found

+ * @throws \LogicException

+ */

+ public function crawl_phpbb_directory_styles($md_file)

+ {

+ $this->crawl_eventsmd($md_file, 'styles');

+

+ $styles = array('prosilver', 'subsilver2');

+ foreach ($styles as $style)

+ {

+ $file_list = $this->get_recursive_file_list(

+ $this->path . 'styles/' . $style . '/template/'

+ );

+

+ foreach ($file_list as $file)

+ {

+ $file_name = 'styles/' . $style . '/template/' . $file;

+ $this->validate_events_from_file($file_name, $this->crawl_file_for_events($file_name));

+ }

+ }

+

+ return sizeof($this->events);

+ }

+

+ /**

+ * @param string $md_file Relative from phpBB root

+ * @param string $filter Should be 'styles' or 'adm'

+ * @return int Number of events found

+ * @throws \LogicException

+ */

+ public function crawl_eventsmd($md_file, $filter)

+ {

+ if (!file_exists($this->path . $md_file))

+ {

+ throw new \LogicException("The event docs file '{$md_file}' could not be found");

+ }

+

+ $file_content = file_get_contents($this->path . $md_file);

+ $this->filter = $filter;

+

+ $events = explode("\n\n", $file_content);

+ foreach ($events as $event)

+ {

+ // Last row of the file

+ if (strpos($event, "\n===\n") === false)

+ {

+ continue;

+ }

+

+ list($event_name, $details) = explode("\n===\n", $event, 2);

+ $this->validate_event_name($event_name);

+ $this->current_event = $event_name;

+

+ if (isset($this->events[$this->current_event]))

+ {

+ throw new \LogicException("The event '{$this->current_event}' is defined multiple times");

+ }

+

+ if (($this->filter == 'adm' && strpos($this->current_event, 'acp_') !== 0)

+ || ($this->filter == 'styles' && strpos($this->current_event, 'acp_') === 0))

+ {

+ continue;

+ }

+

+ list($file_details, $details) = explode("\n* Since: ", $details, 2);

+ list($since, $description) = explode("\n* Purpose: ", $details, 2);

+

+ $files = $this->validate_file_list($file_details);

+ $since = $this->validate_since($since);

+

+ $this->events[$event_name] = array(

+ 'event' => $this->current_event,

+ 'files' => $files,

+ 'since' => $since,

+ 'description' => $description,

+ );

+ }

+

+ return sizeof($this->events);

+ }

+

+ /**

+ * Format the php events as a wiki table

+ * @return string Number of events found

+ */

+ public function export_events_for_wiki()

+ {

+ if ($this->filter === 'adm')

+ {

+ $wiki_page = '= ACP Template Events =' . "\n";

+ $wiki_page .= '{| class="zebra sortable" cellspacing="0" cellpadding="5"' . "\n";

+ $wiki_page .= '! Identifier !! Placement !! Added in Release !! Explanation' . "\n";

+ }

+ else

+ {

+ $wiki_page = '= Template Events =' . "\n";

+ $wiki_page .= '{| class="zebra sortable" cellspacing="0" cellpadding="5"' . "\n";

+ $wiki_page .= '! Identifier !! Prosilver Placement (If applicable) !! Subsilver Placement (If applicable) !! Added in Release !! Explanation' . "\n";

+ }

+

+ foreach ($this->events as $event_name => $event)

+ {

+ $wiki_page .= "|- id=\"{$event_name}\"\n";

+ $wiki_page .= "| [[#{$event_name}|{$event_name}]] || ";

+

+ if ($this->filter === 'adm')

+ {

+ $wiki_page .= implode(', ', $event['files']['adm']);

+ }

+ else

+ {

+ $wiki_page .= implode(', ', $event['files']['prosilver']) . ' || ' . implode(', ', $event['files']['subsilver2']);

+ }

+

+ $wiki_page .= " || {$event['since']} || " . str_replace("\n", ' ', $event['description']) . "\n";

+ }

+ $wiki_page .= '|}' . "\n";

+

+ return $wiki_page;

+ }

+

+ /**

+ * Validates a template event name

+ *

+ * @param $event_name

+ * @return null

+ * @throws \LogicException

+ */

+ public function validate_event_name($event_name)

+ {

+ if (!preg_match('#^([a-z][a-z0-9]*(?:_[a-z][a-z0-9]*)+)$#', $event_name))

+ {

+ throw new \LogicException("Invalid event name '{$event_name}'");

+ }

+ }

+

+ /**

+ * Validate "Since" Information

+ *

+ * @param string $since

+ * @return string

+ * @throws \LogicException

+ */

+ public function validate_since($since)

+ {

+ if (!preg_match('#^\d+\.\d+\.\d+(?:-(?:a|b|rc|pl)\d+)?$#', $since))

+ {

+ throw new \LogicException("Invalid since information found for event '{$this->current_event}'");

+ }

+

+ return $since;

+ }

+

+ /**

+ * Validate the files list

+ *

+ * @param string $file_details

+ * @return array

+ * @throws \LogicException

+ */

+ public function validate_file_list($file_details)

+ {

+ $files_list = array(

+ 'prosilver' => array(),

+ 'subsilver2' => array(),

+ 'adm' => array(),

+ );

+

+ // Multi file list

+ if (strpos($file_details, "* Locations:\n + ") === 0)

+ {

+ $file_details = substr($file_details, strlen("* Locations:\n + "));

+ $files = explode("\n + ", $file_details);

+ foreach ($files as $file)

+ {

+ if (!file_exists($this->path . $file) || substr($file, -5) !== '.html')

+ {

+ throw new \LogicException("Invalid file '{$file}' not found for event '{$this->current_event}'", 1);

+ }

+

+ if (($this->filter !== 'adm') && strpos($file, 'styles/prosilver/template/') === 0)

+ {

+ $files_list['prosilver'][] = substr($file, strlen('styles/prosilver/template/'));

+ }

+ else if (($this->filter !== 'adm') && strpos($file, 'styles/subsilver2/template/') === 0)

+ {

+ $files_list['subsilver2'][] = substr($file, strlen('styles/subsilver2/template/'));

+ }

+ else if (($this->filter === 'adm') && strpos($file, 'adm/style/') === 0)

+ {

+ $files_list['adm'][] = substr($file, strlen('adm/style/'));

+ }

+ else

+ {

+ throw new \LogicException("Invalid file '{$file}' not found for event '{$this->current_event}'", 2);

+ }

+

+ $this->events_by_file[$file][] = $this->current_event;

+ }

+ }

+ else if ($this->filter == 'adm')

+ {

+ $file = substr($file_details, strlen('* Location: '));

+ if (!file_exists($this->path . $file) || substr($file, -5) !== '.html')

+ {

+ throw new \LogicException("Invalid file '{$file}' not found for event '{$this->current_event}'", 1);

+ }

+

+ $files_list['adm'][] = substr($file, strlen('adm/style/'));

+

+ $this->events_by_file[$file][] = $this->current_event;

+ }

+ else

+ {

+ throw new \LogicException("Invalid file list found for event '{$this->current_event}'", 2);

+ }

+

+ return $files_list;

+ }

+

+ /**

+ * Get all template events in a template file

+ *

+ * @param string $file

+ * @return array

+ * @throws \LogicException

+ */

+ public function crawl_file_for_events($file)

+ {

+ if (!file_exists($this->path . $file))

+ {

+ throw new \LogicException("File '{$file}' does not exist", 1);

+ }

+

+ $event_list = array();

+ $file_content = file_get_contents($this->path . $file);

+

+ $events = explode('<!-- EVENT ', $file_content);

+ // Remove the code before the first event

+ array_shift($events);

+ foreach ($events as $event)

+ {

+ $event = explode(' -->', $event, 2);

+ $event_list[] = array_shift($event);

+ }

+

+ return $event_list;

+ }

+

+ /**

+ * Validates whether all events from $file are in the md file and vice-versa

+ *

+ * @param string $file

+ * @param array $events

+ * @return true

+ * @throws \LogicException

+ */

+ public function validate_events_from_file($file, array $events)

+ {

+ if (empty($this->events_by_file[$file]) && empty($events))

+ {

+ return true;

+ }

+ else if (empty($this->events_by_file[$file]))

+ {

+ $event_list = implode("', '", $events);

+ throw new \LogicException("File '{$file}' should not contain events, but contains: "

+ . "'{$event_list}'", 1);

+ }

+ else if (empty($events))

+ {

+ $event_list = implode("', '", $this->events_by_file[$file]);

+ throw new \LogicException("File '{$file}' contains no events, but should contain: "

+ . "'{$event_list}'", 1);

+ }

+

+ $missing_events_from_file = array();

+ foreach ($this->events_by_file[$file] as $event)

+ {

+ if (!in_array($event, $events))

+ {

+ $missing_events_from_file[] = $event;

+ }

+ }

+

+ if (!empty($missing_events_from_file))

+ {

+ $event_list = implode("', '", $missing_events_from_file);

+ throw new \LogicException("File '{$file}' does not contain events: '{$event_list}'", 2);

+ }

+

+ $missing_events_from_md = array();

+ foreach ($events as $event)

+ {

+ if (!in_array($event, $this->events_by_file[$file]))

+ {

+ $missing_events_from_md[] = $event;

+ }

+ }

+

+ if (!empty($missing_events_from_md))

+ {

+ $event_list = implode("', '", $missing_events_from_md);

+ throw new \LogicException("File '{$file}' contains additional events: '{$event_list}'", 3);

+ }

+

+ return true;

+ }

+

+ /**

+ * Returns a list of files in $dir

+ *

+ * Works recursive with any depth

+ *

+ * @param string $dir Directory to go through

+ * @return array List of files (including directories)

+ */

+ public function get_recursive_file_list($dir)

+ {

+ try

+ {

+ $iterator = new \RecursiveIteratorIterator(

+ new \phpbb\recursive_dot_prefix_filter_iterator(

+ new \RecursiveDirectoryIterator(

+ $dir,

+ \FilesystemIterator::SKIP_DOTS

+ )

+ ),

+ \RecursiveIteratorIterator::SELF_FIRST

+ );

+ }

+ catch (\Exception $e)

+ {

+ return array();

+ }

+

+ $files = array();

+ foreach ($iterator as $file_info)

+ {

+ /** @var \RecursiveDirectoryIterator $file_info */

+ if ($file_info->isDir())

+ {

+ continue;

+ }

+

+ $relative_path = $iterator->getInnerIterator()->getSubPathname();

+

+ if (substr($relative_path, -5) == '.html')

+ {

+ $files[] = str_replace(DIRECTORY_SEPARATOR, '/', $relative_path);

+ }

+ }

+

+ return $files;

+ }

+}