mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-02-24 20:13:22 +01:00
Code Issues Releases Wiki Activity

Merge remote-tracking branch 'remotes/bantu/ticket/10202' into develop

Browse Source 
# By Andreas Fischer
# Via Andreas Fischer
* remotes/bantu/ticket/10202:
  [ticket/10202] Rename method names _all() to _array().
  [ticket/10202] Add migration file for config_db_text.
  [ticket/10202] Upgrade TEXT to the bigger MTEXT.
  [ticket/10202] Improve method documentation.
  [ticket/10202] SQL escape the table name.
  [ticket/10202] Add $this->db->sql_freeresult($result) to SELECT queries.
  [ticket/10202] Define phpbb_config_db_text as a service.
  [ticket/10202] Add tests for phpbb_config_db_text.
  [ticket/10202] Adjust method names to guidelines.
  [ticket/10202] Add database schema for phpbb_config_db_text.
  [ticket/10202] Implementation of config options with arbitrary length values.
This commit is contained in:
Nathan Guse 2013-03-06 15:36:15 -06:00
commit 9ca15267fa
14 changed files with 428 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
phpBB/config/services.yml
View File

@ -58,6 +58,12 @@ services:
- @cache.driver
- %tables.config%
config_text:
class: phpbb_config_db_text
arguments:
- @dbal.conn
- %tables.config_text%
controller.helper:
class: phpbb_controller_helper
arguments:

1
phpBB/config/tables.yml
View File

@ -1,5 +1,6 @@
parameters:
tables.config: %core.table_prefix%config
tables.config_text: %core.table_prefix%config_text
tables.ext: %core.table_prefix%ext
tables.log: %core.table_prefix%log
tables.notification_types: %core.table_prefix%notification_types

8
phpBB/develop/create_schema_files.php
View File

@ -998,6 +998,14 @@ function get_schema_struct()
),
);
$schema_data['phpbb_config_text'] = array(
'COLUMNS' => array(
'config_name' => array('VCHAR', ''),
'config_value' => array('MTEXT', ''),
),
'PRIMARY_KEY' => 'config_name',
);
$schema_data['phpbb_confirm'] = array(
'COLUMNS' => array(
'confirm_id' => array('CHAR:32', ''),

163
phpBB/includes/config/db_text.php Normal file
View File

@ -0,0 +1,163 @@
<?php
/**
*
* @package phpBB3
* @copyright (c) 2013 phpBB Group
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
*
*/
/**
* @ignore
*/
if (!defined('IN_PHPBB'))
{
exit;
}
/**
* Manages configuration options with an arbitrary length value stored in a TEXT
* column. In constrast to class phpbb_config_db, values are never cached and
* prefetched, but every get operation sends a query to the database.
*
* @package phpBB3
*/
class phpbb_config_db_text
{
/**
* Database connection
* @var phpbb_db_driver
*/
protected $db;
/**
* Name of the database table used.
* @var string
*/
protected $table;
/**
* @param phpbb_db_driver $db Database connection
* @param string $table Table name
*/
public function __construct(phpbb_db_driver $db, $table)
{
$this->db = $db;
$this->table = $this->db->sql_escape($table);
}
/**
* Sets the configuration option with the name $key to $value.
*
* @param string $key The configuration option's name
* @param string $value New configuration value
*
* @return null
*/
public function set($key, $value)
{
$this->set_array(array($key => $value));
}
/**
* Gets the configuration value for the name $key.
*
* @param string $key The configuration option's name
*
* @return string|null String result on success
* null if there is no such option
*/
public function get($key)
{
$map = $this->get_array(array($key));
return isset($map[$key]) ? $map[$key] : null;
}
/**
* Removes the configuration option with the name $key.
*
* @param string $key The configuration option's name
*
* @return null
*/
public function delete($key)
{
$this->delete_array(array($key));
}
/**
* Mass set configuration options: Receives an associative array,
* treats array keys as configuration option names and associated
* array values as their configuration option values.
*
* @param array $map Map from configuration names to values
*
* @return null
*/
public function set_array(array $map)
{
$this->db->sql_transaction('begin');
foreach ($map as $key => $value)
{
$sql = 'UPDATE ' . $this->table . "
SET config_value = '" . $this->db->sql_escape($value) . "'
WHERE config_name = '" . $this->db->sql_escape($key) . "'";
$result = $this->db->sql_query($sql);
if (!$this->db->sql_affectedrows($result))
{
$sql = 'INSERT INTO ' . $this->table . ' ' . $this->db->sql_build_array('INSERT', array(
'config_name' => $key,
'config_value' => $value,
));
$this->db->sql_query($sql);
}
}
$this->db->sql_transaction('commit');
}
/**
* Mass get configuration options: Receives a set of configuration
* option names and returns the result as a key => value map where
* array keys are configuration option names and array values are
* associated config option values.
*
* @param array $keys Set of configuration option names
*
* @return array Map from configuration names to values
*/
public function get_array(array $keys)
{
$sql = 'SELECT *
FROM ' . $this->table . '
WHERE ' . $this->db->sql_in_set('config_name', $keys, false, true);
$result = $this->db->sql_query($sql);
$map = array();
while ($row = $this->db->sql_fetchrow($result))
{
$map[$row['config_name']] = $row['config_value'];
}
$this->db->sql_freeresult($result);
return $map;
}
/**
* Mass delete configuration options.
*
* @param array $keys Set of configuration option names
*
* @return null
*/
public function delete_array(array $keys)
{
$sql = 'DELETE
FROM ' . $this->table . '
WHERE ' . $this->db->sql_in_set('config_name', $keys, false, true);
$result = $this->db->sql_query($sql);
}
}

45
phpBB/includes/db/migration/data/310/config_db_text.php Normal file
View File

@ -0,0 +1,45 @@
<?php
/**
*
* @package migration
* @copyright (c) 2013 phpBB Group
* @license http://opensource.org/licenses/gpl-license.php GNU Public License v2
*
*/
class phpbb_db_migration_data_310_config_db_text extends phpbb_db_migration
{
public function effectively_installed()
{
return $this->db_tools->sql_table_exists($this->table_prefix . 'config_text');
}
static public function depends_on()
{
return array('phpbb_db_migration_data_30x_3_0_11');
}
public function update_schema()
{
return array(
'add_tables' => array(
$this->table_prefix . 'config_text' => array(
'COLUMNS' => array(
'config_name' => array('VCHAR', ''),
'config_value' => array('MTEXT', ''),
),
'PRIMARY_KEY' => 'config_name',
),
),
);
}
public function revert_schema()
{
return array(
'drop_tables' => array(
$this->table_prefix . 'config_text',
),
);
}
}

9
phpBB/install/schemas/firebird_schema.sql
View File

@ -222,6 +222,15 @@ ALTER TABLE phpbb_config ADD PRIMARY KEY (config_name);;
CREATE INDEX phpbb_config_is_dynamic ON phpbb_config(is_dynamic);;
# Table: 'phpbb_config_text'
CREATE TABLE phpbb_config_text (
config_name VARCHAR(255) CHARACTER SET NONE DEFAULT '' NOT NULL,
config_value BLOB SUB_TYPE TEXT CHARACTER SET NONE DEFAULT '' NOT NULL
);;
ALTER TABLE phpbb_config_text ADD PRIMARY KEY (config_name);;
# Table: 'phpbb_confirm'
CREATE TABLE phpbb_confirm (
confirm_id CHAR(32) CHARACTER SET NONE DEFAULT '' NOT NULL,

17
phpBB/install/schemas/mssql_schema.sql
View File

@ -293,6 +293,23 @@ CREATE INDEX [is_dynamic] ON [phpbb_config]([is_dynamic]) ON [PRIMARY]
GO
/*
Table: 'phpbb_config_text'
*/
CREATE TABLE [phpbb_config_text] (
[config_name] [varchar] (255) DEFAULT ('') NOT NULL ,
[config_value] [text] DEFAULT ('') NOT NULL
) ON [PRIMARY] TEXTIMAGE_ON [PRIMARY]
GO
ALTER TABLE [phpbb_config_text] WITH NOCHECK ADD
CONSTRAINT [PK_phpbb_config_text] PRIMARY KEY CLUSTERED
(
[config_name]
) ON [PRIMARY]
GO
/*
Table: 'phpbb_confirm'
*/

8
phpBB/install/schemas/mysql_40_schema.sql
View File

@ -157,6 +157,14 @@ CREATE TABLE phpbb_config (
);
# Table: 'phpbb_config_text'
CREATE TABLE phpbb_config_text (
config_name varbinary(255) DEFAULT '' NOT NULL,
config_value mediumblob NOT NULL,
PRIMARY KEY (config_name)
);
# Table: 'phpbb_confirm'
CREATE TABLE phpbb_confirm (
confirm_id binary(32) DEFAULT '' NOT NULL,

8
phpBB/install/schemas/mysql_41_schema.sql
View File

@ -157,6 +157,14 @@ CREATE TABLE phpbb_config (
) CHARACTER SET `utf8` COLLATE `utf8_bin`;
# Table: 'phpbb_config_text'
CREATE TABLE phpbb_config_text (
config_name varchar(255) DEFAULT '' NOT NULL,
config_value mediumtext NOT NULL,
PRIMARY KEY (config_name)
) CHARACTER SET `utf8` COLLATE `utf8_bin`;
# Table: 'phpbb_confirm'
CREATE TABLE phpbb_confirm (
confirm_id char(32) DEFAULT '' NOT NULL,

11
phpBB/install/schemas/oracle_schema.sql
View File

@ -331,6 +331,17 @@ CREATE TABLE phpbb_config (
CREATE INDEX phpbb_config_is_dynamic ON phpbb_config (is_dynamic)
/
/*
Table: 'phpbb_config_text'
*/
CREATE TABLE phpbb_config_text (
config_name varchar2(255) DEFAULT '' ,
config_value clob DEFAULT '' ,
CONSTRAINT pk_phpbb_config_text PRIMARY KEY (config_name)
)
/
/*
Table: 'phpbb_confirm'
*/

10
phpBB/install/schemas/postgres_schema.sql
View File

@ -269,6 +269,16 @@ CREATE TABLE phpbb_config (
CREATE INDEX phpbb_config_is_dynamic ON phpbb_config (is_dynamic);
/*
Table: 'phpbb_config_text'
*/
CREATE TABLE phpbb_config_text (
config_name varchar(255) DEFAULT '' NOT NULL,
config_value TEXT DEFAULT '' NOT NULL,
PRIMARY KEY (config_name)
);
/*
Table: 'phpbb_confirm'
*/

8
phpBB/install/schemas/sqlite_schema.sql
View File

@ -154,6 +154,14 @@ CREATE TABLE phpbb_config (
CREATE INDEX phpbb_config_is_dynamic ON phpbb_config (is_dynamic);
# Table: 'phpbb_config_text'
CREATE TABLE phpbb_config_text (
config_name varchar(255) NOT NULL DEFAULT '',
config_value mediumtext(16777215) NOT NULL DEFAULT '',
PRIMARY KEY (config_name)
);
# Table: 'phpbb_confirm'
CREATE TABLE phpbb_confirm (
confirm_id char(32) NOT NULL DEFAULT '',

115
tests/config/db_text_test.php Normal file
View File

@ -0,0 +1,115 @@
<?php
/**
*
* @package testing
* @copyright (c) 2013 phpBB Group
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
*
*/
class phpbb_config_db_text_test extends phpbb_database_test_case
{
private $db;
private $config_text;
public function getDataSet()
{
return $this->createXMLDataSet(dirname(__FILE__) . '/fixtures/config_text.xml');
}
public function setUp()
{
parent::setUp();
$this->db = $this->new_dbal();
$this->config_text = new phpbb_config_db_text($this->db, 'phpbb_config_text');
}
public function test_get()
{
$this->assertSame('23', $this->config_text->get('foo'));
$this->assertSame('string-de-ding', $this->config_text->get('meh'));
}
public function test_get_nonexisting()
{
$this->assertNull($this->config_text->get('noooooo'));
}
public function test_set_new_get()
{
$this->config_text->set('barz', 'phpbb');
$this->assertSame('phpbb', $this->config_text->get('barz'));
}
public function test_set_replace_get()
{
$this->config_text->set('foo', '24');
$this->assertSame('24', $this->config_text->get('foo'));
}
public function test_set_get_long_string()
{
$expected = str_repeat('ABC', 10000);
$this->config_text->set('long', $expected);
$this->assertSame($expected, $this->config_text->get('long'));
}
public function test_delete_get()
{
$this->config_text->delete('foo');
$this->assertNull($this->config_text->get('foo'));
$this->assertSame('42', $this->config_text->get('bar'));
$this->assertSame('string-de-ding', $this->config_text->get('meh'));
}
public function test_get_array_empty()
{
$this->assertEmpty($this->config_text->get_array(array('key1', 'key2')));
}
public function test_get_array_subset()
{
$expected = array(
'bar' => '42',
'foo' => '23',
);
$actual = $this->config_text->get_array(array_keys($expected));
ksort($actual);
$this->assertSame($expected, $actual);
}
public function test_set_array_get_array_subset()
{
$set_array_param = array(
// New entry
'baby' => 'phpBB',
// Entry update
'bar' => '64',
);
$this->config_text->set_array($set_array_param);
$expected = array_merge($set_array_param, array(
'foo' => '23',
));
$actual = $this->config_text->get_array(array_keys($expected));
ksort($actual);
$this->assertSame($expected, $actual);
}
public function test_delete_array_get_remaining()
{
$this->config_text->delete_array(array('foo', 'bar'));
$this->assertNull($this->config_text->get('bar'));
$this->assertNull($this->config_text->get('foo'));
$this->assertSame('string-de-ding', $this->config_text->get('meh'));
}
}

19
tests/config/fixtures/config_text.xml Normal file
View File

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<dataset>
<table name="phpbb_config_text">
<column>config_name</column>
<column>config_value</column>
<row>
<value>foo</value>
<value>23</value>
</row>
<row>
<value>bar</value>
<value>42</value>
</row>
<row>
<value>meh</value>
<value>string-de-ding</value>
</row>
</table>
</dataset>