mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-01-19 07:08:09 +01:00
Code Issues Releases Wiki Activity

Merge pull request #5920 from mrgoldy/ticket/13867

Browse Source 
[ticket/13867] Manage new profile field types
This commit is contained in:
Marc Alexander 2020-05-14 17:44:06 +02:00
commit 1c3585f575
No known key found for this signature in database
GPG Key ID: 50E0D2423696F995
4 changed files with 647 additions and 221 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
phpBB/config/default/container/services_profilefield.yml
View File

@ -3,15 +3,20 @@ services:
class: phpbb\profilefields\manager class: phpbb\profilefields\manager
arguments: arguments:
- '@auth' - '@auth'
- '@config_text'
- '@dbal.conn' - '@dbal.conn'
- '@dbal.tools'
- '@dispatcher' - '@dispatcher'
- '@language'
- '@log'
- '@request' - '@request'
- '@template' - '@template'
- '@profilefields.type_collection' - '@profilefields.type_collection'
- '@user' - '@user'
- '%tables.profile_fields%' - '%tables.profile_fields%'
- '%tables.profile_fields_language%'
- '%tables.profile_fields_data%' - '%tables.profile_fields_data%'
- '%tables.profile_fields_options_language%'
- '%tables.profile_fields_language%'
profilefields.lang_helper: profilefields.lang_helper:
class: phpbb\profilefields\lang_helper class: phpbb\profilefields\lang_helper

652
phpBB/phpbb/profilefields/manager.php
View File

@ -1,109 +1,139 @@
<?php <?php
/** /**
* *
* This file is part of the phpBB Forum Software package. * This file is part of the phpBB Forum Software package.
* *
* @copyright (c) phpBB Limited <https://www.phpbb.com> * @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0) * @license GNU General Public License, version 2 (GPL-2.0)
* *
* For full copyright and license information, please see * For full copyright and license information, please see
* the docs/CREDITS.txt file. * the docs/CREDITS.txt file.
* *
*/ */
namespace phpbb\profilefields; namespace phpbb\profilefields;
/** /**
* Custom Profile Fields * Custom Profile Fields (CPF) manager.
*/ */
class manager class manager
{ {
/** /** @var \phpbb\auth\auth */
* Auth object
* @var \phpbb\auth\auth
*/
protected $auth; protected $auth;
/** /** @var \phpbb\config\db_text */
* Database object protected $config_text;
* @var \phpbb\db\driver\driver_interface
*/ /** @var \phpbb\db\driver\driver_interface */
protected $db; protected $db;
/** /** @var \phpbb\db\tools\tools */
* Event dispatcher object protected $db_tools;
* @var \phpbb\event\dispatcher_interface
*/ /** @var \phpbb\event\dispatcher_interface */
protected $dispatcher; protected $dispatcher;
/** /** @var \phpbb\language\language */
* Request object protected $language;
* @var \phpbb\request\request
*/ /** @var \phpbb\log\log */
protected $log;
/** @var \phpbb\request\request */
protected $request; protected $request;
/** /** @var \phpbb\template\template */
* Template object
* @var \phpbb\template\template
*/
protected $template; protected $template;
/** /** @var \phpbb\di\service_collection */
* Service Collection object
* @var \phpbb\di\service_collection
*/
protected $type_collection; protected $type_collection;
/** /** @var \phpbb\user */
* User object
* @var \phpbb\user
*/
protected $user; protected $user;
/** @var string Profile fields table */
protected $fields_table; protected $fields_table;
protected $fields_language_table; /** @var string Profile fields data table */
protected $fields_data_table; protected $fields_data_table;
protected $profile_cache = array(); /** @var string Profile fields data (options) table */
protected $fields_data_lang_table;
/** @var string Profile fields language table */
protected $fields_lang_table;
/** @var array Users custom profile fields cache */
protected $profile_cache = [];
/** /**
* Construct * Construct
* *
* @param \phpbb\auth\auth $auth Auth object * @param \phpbb\auth\auth $auth Auth object
* @param \phpbb\db\driver\driver_interface $db Database object * @param \phpbb\config\db_text $config_text Config_text object
* @param \phpbb\event\dispatcher_interface $dispatcher Event dispatcher object * @param \phpbb\db\driver\driver_interface $db Database object
* @param \phpbb\request\request $request Request object * @param \phpbb\db\tools\tools $db_tools Database tools object
* @param \phpbb\template\template $template Template object * @param \phpbb\event\dispatcher_interface $dispatcher Event dispatcher object
* @param \phpbb\di\service_collection $type_collection * @param \phpbb\language\language $language Language object
* @param \phpbb\user $user User object * @param \phpbb\log\log $log Log object
* @param string $fields_table * @param \phpbb\request\request $request Request object
* @param string $fields_language_table * @param \phpbb\template\template $template Template object
* @param string $fields_data_table * @param \phpbb\di\service_collection $type_collection CPF Type collection
*/ * @param \phpbb\user $user User object
public function __construct(\phpbb\auth\auth $auth, \phpbb\db\driver\driver_interface $db, \phpbb\event\dispatcher_interface $dispatcher, \phpbb\request\request $request, \phpbb\template\template $template, \phpbb\di\service_collection $type_collection, \phpbb\user $user, $fields_table, $fields_language_table, $fields_data_table) * @param string $fields_table CPF Table
* @param string $fields_data_table CPF Data table
* @param string $fields_data_lang_table CPF Data language table
* @param string $fields_lang_table CPF Language table
*/
public function __construct(
\phpbb\auth\auth $auth,
\phpbb\config\db_text $config_text,
\phpbb\db\driver\driver_interface $db,
\phpbb\db\tools\tools $db_tools,
\phpbb\event\dispatcher_interface $dispatcher,
\phpbb\language\language $language,
\phpbb\log\log $log,
\phpbb\request\request $request,
\phpbb\template\template $template,
\phpbb\di\service_collection $type_collection,
\phpbb\user $user,
$fields_table,
$fields_data_table,
$fields_data_lang_table,
$fields_lang_table
)
{ {
$this->auth = $auth; $this->auth = $auth;
$this->db = $db; $this->config_text = $config_text;
$this->dispatcher = $dispatcher; $this->db = $db;
$this->request = $request; $this->db_tools = $db_tools;
$this->template = $template; $this->dispatcher = $dispatcher;
$this->type_collection = $type_collection; $this->language = $language;
$this->user = $user; $this->log = $log;
$this->request = $request;
$this->template = $template;
$this->type_collection = $type_collection;
$this->user = $user;
$this->fields_table = $fields_table; $this->fields_table = $fields_table;
$this->fields_language_table = $fields_language_table; $this->fields_data_table = $fields_data_table;
$this->fields_data_table = $fields_data_table; $this->fields_data_lang_table = $fields_data_lang_table;
$this->fields_lang_table = $fields_lang_table;
} }
/** /**
* Assign editable fields to template, mode can be profile (for profile change) or register (for registration) * Assign editable fields to template.
* Called by ucp_profile and ucp_register *
*/ * Called by ucp_profile and ucp_register.
*
* @param string $mode The mode (profile|register)
* @param int $lang_id The language identifier
* @return void
*/
public function generate_profile_fields($mode, $lang_id) public function generate_profile_fields($mode, $lang_id)
{ {
$sql_where = ''; $sql_where = '';
switch ($mode) switch ($mode)
{ {
case 'register': case 'register':
@ -120,54 +150,57 @@ class manager
break; break;
default: default:
trigger_error('Wrong profile mode specified', E_USER_ERROR); trigger_error('NO_MODE', E_USER_ERROR);
break; break;
} }
$sql = 'SELECT l.*, f.* $sql = 'SELECT l.*, f.*
FROM ' . $this->fields_language_table . ' l, ' . $this->fields_table . " f FROM ' . $this->fields_lang_table . ' l,
WHERE f.field_active = 1 ' . $this->fields_table . ' f
$sql_where WHERE l.field_id = f.field_id
AND l.lang_id = " . (int) $lang_id . ' AND f.field_active = 1
AND l.field_id = f.field_id AND l.lang_id = ' . (int) $lang_id
ORDER BY f.field_order'; . $sql_where . '
ORDER BY f.field_order ASC';
$result = $this->db->sql_query($sql); $result = $this->db->sql_query($sql);
while ($row = $this->db->sql_fetchrow($result)) while ($row = $this->db->sql_fetchrow($result))
{ {
// Return templated field /** @var \phpbb\profilefields\type\type_interface $profile_field */
$profile_field = $this->type_collection[$row['field_type']]; $profile_field = $this->type_collection[$row['field_type']];
$tpl_snippet = $profile_field->process_field_row('change', $row);
$this->template->assign_block_vars('profile_fields', array( $this->template->assign_block_vars('profile_fields', [
'LANG_NAME' => $this->user->lang($row['lang_name']), 'FIELD' => $profile_field->process_field_row('change', $row),
'LANG_EXPLAIN' => $this->user->lang($row['lang_explain']),
'FIELD' => $tpl_snippet,
'FIELD_ID' => $profile_field->get_field_ident($row), 'FIELD_ID' => $profile_field->get_field_ident($row),
'S_REQUIRED' => ($row['field_required']) ? true : false, 'LANG_NAME' => $this->language->lang($row['lang_name']),
)); 'LANG_EXPLAIN' => $this->language->lang($row['lang_explain']),
'S_REQUIRED' => (bool) $row['field_required'],
]);
} }
$this->db->sql_freeresult($result); $this->db->sql_freeresult($result);
} }
/** /**
* Build profile cache, used for display * Build profile cache, used for display.
*/ *
* @return void
*/
protected function build_cache() protected function build_cache()
{ {
$this->profile_cache = array(); $this->profile_cache = [];
// Display hidden/no_view fields for admin/moderator // Display hidden/no_view fields for admin/moderator
$sql = 'SELECT l.*, f.* $sql_where = !$this->auth->acl_gets('a_', 'm_') && !$this->auth->acl_getf_global('m_') ? ' AND f.field_hide = 0' : '';
FROM ' . $this->fields_language_table . ' l, ' . $this->fields_table . ' f
WHERE l.lang_id = ' . $this->user->get_iso_lang_id() . '
AND f.field_active = 1 ' .
((!$this->auth->acl_gets('a_', 'm_') && !$this->auth->acl_getf_global('m_')) ? ' AND f.field_hide = 0 ' : '') . '
AND f.field_no_view = 0
AND l.field_id = f.field_id
ORDER BY f.field_order';
$result = $this->db->sql_query($sql);
$sql = 'SELECT l.*, f.*
FROM ' . $this->fields_lang_table . ' l,
' . $this->fields_table . ' f
WHERE l.field_id = f.field_id
AND f.field_active = 1
AND f.field_no_view = 0
AND l.lang_id = ' . $this->user->get_iso_lang_id()
. $sql_where . '
ORDER BY f.field_order ASC';
$result = $this->db->sql_query($sql);
while ($row = $this->db->sql_fetchrow($result)) while ($row = $this->db->sql_fetchrow($result))
{ {
$this->profile_cache[$row['field_ident']] = $row; $this->profile_cache[$row['field_ident']] = $row;
@ -176,11 +209,17 @@ class manager
} }
/** /**
* Submit profile field for validation * Submit profile field for validation.
*/ *
* @param string $mode The mode (profile|register)
* @param int $lang_id The language identifier
* @param array $cp_data Custom profile field data
* @param array $cp_error Custom profile field errors
*/
public function submit_cp_field($mode, $lang_id, &$cp_data, &$cp_error) public function submit_cp_field($mode, $lang_id, &$cp_data, &$cp_error)
{ {
$sql_where = ''; $sql_where = '';
switch ($mode) switch ($mode)
{ {
case 'register': case 'register':
@ -197,21 +236,22 @@ class manager
break; break;
default: default:
trigger_error('Wrong profile mode specified', E_USER_ERROR); trigger_error('NO_MODE', E_USER_ERROR);
break; break;
} }
$sql = 'SELECT l.*, f.* $sql = 'SELECT l.*, f.*
FROM ' . $this->fields_language_table . ' l, ' . $this->fields_table . ' f FROM ' . $this->fields_lang_table . ' l,
WHERE l.lang_id = ' . (int) $lang_id . " ' . $this->fields_table . ' f
WHERE l.field_id = f.field_id
AND f.field_active = 1 AND f.field_active = 1
$sql_where AND l.lang_id = ' . (int) $lang_id
AND l.field_id = f.field_id . $sql_where . '
ORDER BY f.field_order"; ORDER BY f.field_order';
$result = $this->db->sql_query($sql); $result = $this->db->sql_query($sql);
while ($row = $this->db->sql_fetchrow($result)) while ($row = $this->db->sql_fetchrow($result))
{ {
/** @var \phpbb\profilefields\type\type_interface $profile_field */
$profile_field = $this->type_collection[$row['field_type']]; $profile_field = $this->type_collection[$row['field_type']];
$cp_data['pf_' . $row['field_ident']] = $profile_field->get_profile_field($row); $cp_data['pf_' . $row['field_ident']] = $profile_field->get_profile_field($row);
$check_value = $cp_data['pf_' . $row['field_ident']]; $check_value = $cp_data['pf_' . $row['field_ident']];
@ -226,11 +266,14 @@ class manager
} }
/** /**
* Update profile field data directly * Update profile field data directly.
*/ *
* @param int $user_id The user identifier
* @param array $cp_data Custom profile field data
*/
public function update_profile_field_data($user_id, $cp_data) public function update_profile_field_data($user_id, $cp_data)
{ {
if (!count($cp_data)) if (empty($cp_data))
{ {
return; return;
} }
@ -245,25 +288,26 @@ class manager
$cp_data = $this->build_insert_sql_array($cp_data); $cp_data = $this->build_insert_sql_array($cp_data);
$cp_data['user_id'] = (int) $user_id; $cp_data['user_id'] = (int) $user_id;
$sql = 'INSERT INTO ' . $this->fields_data_table . ' ' . $this->db->sql_build_array('INSERT', $cp_data); $sql = 'INSERT INTO ' . $this->fields_data_table . $this->db->sql_build_array('INSERT', $cp_data);
$this->db->sql_query($sql); $this->db->sql_query($sql);
} }
} }
/** /**
* Generate the template arrays in order to display the column names * Generate the template arrays in order to display the column names.
* *
* @param string $restrict_option Restrict the published fields to a certain profile field option * @param string $restrict_option Restrict the published fields to a certain profile field option
* @return array Returns an array with the template variables type, name and explain for the fields to display * @return array Returns an array with the template variables type,
*/ * name and explain for the fields to display
*/
public function generate_profile_fields_template_headlines($restrict_option = '') public function generate_profile_fields_template_headlines($restrict_option = '')
{ {
if (!count($this->profile_cache)) if (empty($this->profile_cache))
{ {
$this->build_cache(); $this->build_cache();
} }
$tpl_fields = array(); $tpl_fields = [];
// Go through the fields in correct order // Go through the fields in correct order
foreach ($this->profile_cache as $field_ident => $field_data) foreach ($this->profile_cache as $field_ident => $field_data)
@ -273,32 +317,29 @@ class manager
continue; continue;
} }
/** @var \phpbb\profilefields\type\type_interface $profile_field */
$profile_field = $this->type_collection[$field_data['field_type']]; $profile_field = $this->type_collection[$field_data['field_type']];
$tpl_fields[] = array( $tpl_fields[] = [
'PROFILE_FIELD_IDENT' => $field_ident, 'PROFILE_FIELD_IDENT' => $field_ident,
'PROFILE_FIELD_TYPE' => $field_data['field_type'], 'PROFILE_FIELD_TYPE' => $field_data['field_type'],
'PROFILE_FIELD_NAME' => $profile_field->get_field_name($field_data['lang_name']), 'PROFILE_FIELD_NAME' => $profile_field->get_field_name($field_data['lang_name']),
'PROFILE_FIELD_EXPLAIN' => $this->user->lang($field_data['lang_explain']), 'PROFILE_FIELD_EXPLAIN' => $this->language->lang($field_data['lang_explain']),
); ];
} }
$profile_cache = $this->profile_cache; $profile_cache = $this->profile_cache;
/** /**
* Event to modify template headlines of the generated profile fields * Event to modify template headlines of the generated profile fields
* *
* @event core.generate_profile_fields_template_headlines * @event core.generate_profile_fields_template_headlines
* @var string restrict_option Restrict the published fields to a certain profile field option * @var string restrict_option Restrict the published fields to a certain profile field option
* @var array tpl_fields Array with template data fields * @var array tpl_fields Array with template data fields
* @var array profile_cache A copy of the profile cache to make additional checks * @var array profile_cache A copy of the profile cache to make additional checks
* @since 3.1.6-RC1 * @since 3.1.6-RC1
*/ */
$vars = array( $vars = ['restrict_option', 'tpl_fields', 'profile_cache'];
'restrict_option',
'tpl_fields',
'profile_cache',
);
extract($this->dispatcher->trigger_event('core.generate_profile_fields_template_headlines', compact($vars))); extract($this->dispatcher->trigger_event('core.generate_profile_fields_template_headlines', compact($vars)));
unset($profile_cache); unset($profile_cache);
@ -306,52 +347,46 @@ class manager
} }
/** /**
* Grab the user specific profile fields data * Grab the user specific profile fields data.
* *
* @param int|array $user_ids Single user id or an array of ids * @param int|array $user_ids Single user id or an array of ids
* @return array Users profile fields data * @return array Users profile fields data
*/ */
public function grab_profile_fields_data($user_ids = 0) public function grab_profile_fields_data($user_ids = 0)
{ {
if (!is_array($user_ids)) if (empty($this->profile_cache))
{
$user_ids = array($user_ids);
}
if (!count($this->profile_cache))
{ {
$this->build_cache(); $this->build_cache();
} }
if (!count($user_ids)) if (empty($user_ids))
{ {
return array(); return [];
} }
$user_ids = (array) $user_ids;
$sql = 'SELECT * $sql = 'SELECT *
FROM ' . $this->fields_data_table . ' FROM ' . $this->fields_data_table . '
WHERE ' . $this->db->sql_in_set('user_id', array_map('intval', $user_ids)); WHERE ' . $this->db->sql_in_set('user_id', array_map('intval', $user_ids));
$result = $this->db->sql_query($sql); $result = $this->db->sql_query($sql);
$rowset = $this->db->sql_fetchrowset($result);
$field_data = array();
while ($row = $this->db->sql_fetchrow($result))
{
$field_data[$row['user_id']] = $row;
}
$this->db->sql_freeresult($result); $this->db->sql_freeresult($result);
$field_data = array_column($rowset, null, 'user_id');
/** /**
* Event to modify profile fields data retrieved from the database * Event to modify profile fields data retrieved from the database
* *
* @event core.grab_profile_fields_data * @event core.grab_profile_fields_data
* @var array user_ids Single user id or an array of ids * @var array user_ids Single user id or an array of ids
* @var array field_data Array with profile fields data * @var array field_data Array with profile fields data
* @since 3.1.0-b3 * @since 3.1.0-b3
*/ */
$vars = array('user_ids', 'field_data'); $vars = ['user_ids', 'field_data'];
extract($this->dispatcher->trigger_event('core.grab_profile_fields_data', compact($vars))); extract($this->dispatcher->trigger_event('core.grab_profile_fields_data', compact($vars)));
$user_fields = array(); $user_fields = [];
// Go through the fields in correct order // Go through the fields in correct order
foreach (array_keys($this->profile_cache) as $used_ident) foreach (array_keys($this->profile_cache) as $used_ident)
@ -376,34 +411,39 @@ class manager
} }
/** /**
* Assign the user's profile fields data to the template * Generate the user's profile fields data for the template.
* *
* @param array $profile_row Array with users profile field data * @param array $profile_row Array with users profile field data
* @param bool $use_contact_fields Should we display contact fields as such? * @param bool $use_contact_fields Should we display contact fields as such?
* This requires special treatments (links should not be parsed in the values, and more) * This requires special treatments:
* @return array * (links should not be parsed in the values, and more)
*/ * @return array The user's profile fields data
*/
public function generate_profile_fields_template_data($profile_row, $use_contact_fields = true) public function generate_profile_fields_template_data($profile_row, $use_contact_fields = true)
{ {
// $profile_row == $user_fields[$row['user_id']]; // $profile_row == $user_fields[$row['user_id']];
$tpl_fields = array(); $tpl_fields = [
$tpl_fields['row'] = $tpl_fields['blockrow'] = array(); 'row' => [],
'blockrow' => [],
];
/** /**
* Event to modify data of the generated profile fields, before the template assignment loop * Event to modify data of the generated profile fields, before the template assignment loop
* *
* @event core.generate_profile_fields_template_data_before * @event core.generate_profile_fields_template_data_before
* @var array profile_row Array with users profile field data * @var array profile_row Array with users profile field data
* @var array tpl_fields Array with template data fields * @var array tpl_fields Array with template data fields
* @var bool use_contact_fields Should we display contact fields as such? * @var bool use_contact_fields Should we display contact fields as such?
* @since 3.1.0-b3 * @since 3.1.0-b3
*/ */
$vars = array('profile_row', 'tpl_fields', 'use_contact_fields'); $vars = ['profile_row', 'tpl_fields', 'use_contact_fields'];
extract($this->dispatcher->trigger_event('core.generate_profile_fields_template_data_before', compact($vars))); extract($this->dispatcher->trigger_event('core.generate_profile_fields_template_data_before', compact($vars)));
foreach ($profile_row as $ident => $ident_ary) foreach ($profile_row as $ident => $ident_ary)
{ {
/** @var \phpbb\profilefields\type\type_interface $profile_field */
$profile_field = $this->type_collection[$ident_ary['data']['field_type']]; $profile_field = $this->type_collection[$ident_ary['data']['field_type']];
$value = $profile_field->get_profile_value($ident_ary['value'], $ident_ary['data']); $value = $profile_field->get_profile_value($ident_ary['value'], $ident_ary['data']);
$value_raw = $profile_field->get_profile_value_raw($ident_ary['value'], $ident_ary['data']); $value_raw = $profile_field->get_profile_value_raw($ident_ary['value'], $ident_ary['data']);
@ -412,91 +452,263 @@ class manager
continue; continue;
} }
$field_desc = $contact_url = ''; $field_desc = '';
$contact_url = '';
$ident_upper = strtoupper($ident);
if ($use_contact_fields && $ident_ary['data']['field_is_contact']) if ($use_contact_fields && $ident_ary['data']['field_is_contact'])
{ {
$value = $profile_field->get_profile_contact_value($ident_ary['value'], $ident_ary['data']); $value = $profile_field->get_profile_contact_value($ident_ary['value'], $ident_ary['data']);
$field_desc = $this->user->lang($ident_ary['data']['field_contact_desc']); $field_desc = $this->language->lang($ident_ary['data']['field_contact_desc']);
if (strpos($field_desc, '%s') !== false) if (strpos($field_desc, '%s') !== false)
{ {
$field_desc = sprintf($field_desc, $value); $field_desc = sprintf($field_desc, $value);
} }
$contact_url = '';
if (strpos($ident_ary['data']['field_contact_url'], '%s') !== false) if (strpos($ident_ary['data']['field_contact_url'], '%s') !== false)
{ {
$contact_url = sprintf($ident_ary['data']['field_contact_url'], $value); $contact_url = sprintf($ident_ary['data']['field_contact_url'], $value);
} }
} }
$tpl_fields['row'] += array( $tpl_fields['row'] += [
'PROFILE_' . strtoupper($ident) . '_IDENT' => $ident, "PROFILE_{$ident_upper}_IDENT" => $ident,
'PROFILE_' . strtoupper($ident) . '_VALUE' => $value, "PROFILE_{$ident_upper}_VALUE" => $value,
'PROFILE_' . strtoupper($ident) . '_VALUE_RAW' => $value_raw, "PROFILE_{$ident_upper}_VALUE_RAW" => $value_raw,
'PROFILE_' . strtoupper($ident) . '_CONTACT' => $contact_url, "PROFILE_{$ident_upper}_CONTACT" => $contact_url,
'PROFILE_' . strtoupper($ident) . '_DESC' => $field_desc, "PROFILE_{$ident_upper}_DESC" => $field_desc,
'PROFILE_' . strtoupper($ident) . '_TYPE' => $ident_ary['data']['field_type'], "PROFILE_{$ident_upper}_TYPE" => $ident_ary['data']['field_type'],
'PROFILE_' . strtoupper($ident) . '_NAME' => $this->user->lang($ident_ary['data']['lang_name']), "PROFILE_{$ident_upper}_NAME" => $this->language->lang($ident_ary['data']['lang_name']),
'PROFILE_' . strtoupper($ident) . '_EXPLAIN' => $this->user->lang($ident_ary['data']['lang_explain']), "PROFILE_{$ident_upper}_EXPLAIN" => $this->language->lang($ident_ary['data']['lang_explain']),
'S_PROFILE_' . strtoupper($ident) . '_CONTACT' => $ident_ary['data']['field_is_contact'], "S_PROFILE_{$ident_upper}_CONTACT" => $ident_ary['data']['field_is_contact'],
'S_PROFILE_' . strtoupper($ident) => true, "S_PROFILE_{$ident_upper}" => true,
); ];
$tpl_fields['blockrow'][] = array( $tpl_fields['blockrow'][] = [
'PROFILE_FIELD_IDENT' => $ident, 'PROFILE_FIELD_IDENT' => $ident,
'PROFILE_FIELD_VALUE' => $value, 'PROFILE_FIELD_VALUE' => $value,
'PROFILE_FIELD_VALUE_RAW' => $value_raw, 'PROFILE_FIELD_VALUE_RAW' => $value_raw,
'PROFILE_FIELD_CONTACT' => $contact_url, 'PROFILE_FIELD_CONTACT' => $contact_url,
'PROFILE_FIELD_DESC' => $field_desc, 'PROFILE_FIELD_DESC' => $field_desc,
'PROFILE_FIELD_TYPE' => $ident_ary['data']['field_type'], 'PROFILE_FIELD_TYPE' => $ident_ary['data']['field_type'],
'PROFILE_FIELD_NAME' => $this->user->lang($ident_ary['data']['lang_name']), 'PROFILE_FIELD_NAME' => $this->language->lang($ident_ary['data']['lang_name']),
'PROFILE_FIELD_EXPLAIN' => $this->user->lang($ident_ary['data']['lang_explain']), 'PROFILE_FIELD_EXPLAIN' => $this->language->lang($ident_ary['data']['lang_explain']),
'S_PROFILE_CONTACT' => $ident_ary['data']['field_is_contact'], 'S_PROFILE_CONTACT' => $ident_ary['data']['field_is_contact'],
'S_PROFILE_' . strtoupper($ident) => true, "S_PROFILE_{$ident_upper}" => true,
); ];
} }
/** /**
* Event to modify template data of the generated profile fields * Event to modify template data of the generated profile fields
* *
* @event core.generate_profile_fields_template_data * @event core.generate_profile_fields_template_data
* @var array profile_row Array with users profile field data * @var array profile_row Array with users profile field data
* @var array tpl_fields Array with template data fields * @var array tpl_fields Array with template data fields
* @var bool use_contact_fields Should we display contact fields as such? * @var bool use_contact_fields Should we display contact fields as such?
* @since 3.1.0-b3 * @since 3.1.0-b3
*/ */
$vars = array('profile_row', 'tpl_fields', 'use_contact_fields'); $vars = ['profile_row', 'tpl_fields', 'use_contact_fields'];
extract($this->dispatcher->trigger_event('core.generate_profile_fields_template_data', compact($vars))); extract($this->dispatcher->trigger_event('core.generate_profile_fields_template_data', compact($vars)));
return $tpl_fields; return $tpl_fields;
} }
/** /**
* Build Array for user insertion into custom profile fields table * Build array for the custom profile fields table.
*/ *
* @param array $cp_data Custom profile field data
* @return array Custom profile field data for SQL usage
*/
public function build_insert_sql_array($cp_data) public function build_insert_sql_array($cp_data)
{ {
$sql_not_in = array(); $prefix = 'pf_';
$length = strlen($prefix);
$not_in = [];
foreach ($cp_data as $key => $null) foreach ($cp_data as $key => $null)
{ {
$sql_not_in[] = (strncmp($key, 'pf_', 3) === 0) ? substr($key, 3) : $key; $not_in[] = strncmp($key, $prefix, $length) === 0 ? substr($key, $length) : $key;
} }
$sql = 'SELECT f.field_type, f.field_ident, f.field_default_value, l.lang_default_value $sql = 'SELECT f.field_type, f.field_ident, f.field_default_value, l.lang_default_value
FROM ' . $this->fields_language_table . ' l, ' . $this->fields_table . ' f FROM ' . $this->fields_lang_table . ' l,
WHERE l.lang_id = ' . $this->user->get_iso_lang_id() . ' ' . $this->fields_table . ' f
' . ((count($sql_not_in)) ? ' AND ' . $this->db->sql_in_set('f.field_ident', $sql_not_in, true) : '') . ' WHERE l.field_id = f.field_id
AND l.field_id = f.field_id'; AND l.lang_id = ' . $this->user->get_iso_lang_id() .
(!empty($not_in) ? ' AND ' . $this->db->sql_in_set('f.field_ident', $not_in, true) : '');
$result = $this->db->sql_query($sql); $result = $this->db->sql_query($sql);
while ($row = $this->db->sql_fetchrow($result)) while ($row = $this->db->sql_fetchrow($result))
{ {
/** @var \phpbb\profilefields\type\type_interface $profile_field */
$profile_field = $this->type_collection[$row['field_type']]; $profile_field = $this->type_collection[$row['field_type']];
$cp_data['pf_' . $row['field_ident']] = $profile_field->get_default_field_value($row); $cp_data[$prefix . $row['field_ident']] = $profile_field->get_default_field_value($row);
} }
$this->db->sql_freeresult($result); $this->db->sql_freeresult($result);
return $cp_data; return $cp_data;
} }
/**
* Disable all profile fields of a certain type.
*
* This should be called when an extension which has profile field types is disabled
* so that all those profile fields are hidden and do not cause errors.
*
* @param string $type_name Type identifier of the profile fields
*/
public function disable_profilefields($type_name)
{
// Get the list of active profile fields of this type
$profile_fields = $this->list_profilefields($type_name, true);
// If no profile fields affected, then nothing to do
if (empty($profile_fields))
{
return;
}
// Update the affected profile fields to "inactive"
$sql = 'UPDATE ' . $this->fields_table . '
SET field_active = 0
WHERE field_active = 1
AND ' . $this->db->sql_in_set('field_id', array_keys($profile_fields));
$this->db->sql_query($sql);
// Save modified information into a config_text field to recover on enable
$this->config_text->set($type_name . '.saved', json_encode($profile_fields));
// Log activity
foreach ($profile_fields as $field_ident)
{
$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_PROFILE_FIELD_DEACTIVATE', time(), [$field_ident]);
}
}
/**
* Purge all profile fields of a certain type.
*
* This should be called when an extension which has profile field types is purged
* so that all those profile fields are removed.
*
* @param string $type_name Type identifier of the profile fields
*/
public function purge_profilefields($type_name)
{
// Remove the information saved on disable in a config_text field, not needed any longer
$this->config_text->delete($type_name . '.saved');
// Get the list of all profile fields of this type
$profile_fields = $this->list_profilefields($type_name);
// If no profile fields exist, then nothing to do
if (empty($profile_fields))
{
return;
}
$this->db->sql_transaction('begin');
// Delete entries from all profile field definition tables
$where = $this->db->sql_in_set('field_id', array_keys($profile_fields));
$this->db->sql_query('DELETE FROM ' . $this->fields_table . ' WHERE ' . $where);
$this->db->sql_query('DELETE FROM ' . $this->fields_data_lang_table . ' WHERE ' . $where);
$this->db->sql_query('DELETE FROM ' . $this->fields_lang_table . ' WHERE ' . $where);
// Drop columns from the Profile Fields data table
foreach ($profile_fields as $field_ident)
{
$this->db_tools->sql_column_remove($this->fields_data_table, 'pf_' . $field_ident);
}
// Reset the order of the remaining fields
$order = 0;
$sql = 'SELECT *
FROM ' . $this->fields_table . '
ORDER BY field_order';
$result = $this->db->sql_query($sql);
while ($row = $this->db->sql_fetchrow($result))
{
$order++;
if ($row['field_order'] != $order)
{
$sql = 'UPDATE ' . $this->fields_table . "
SET field_order = $order
WHERE field_id = {$row['field_id']}";
$this->db->sql_query($sql);
}
}
$this->db->sql_freeresult($result);
$this->db->sql_transaction('commit');
// Log activity
foreach ($profile_fields as $field_ident)
{
$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_PROFILE_FIELD_REMOVED', time(), [$field_ident]);
}
}
/**
* Enable the profile fields of a certain type.
*
* This should be called when an extension which has profile field types that was disabled is re-enabled
* so that all those profile fields that were disabled are enabled again.
*
* @param string $type_name Type identifier of the profile fields
*/
public function enable_profilefields($type_name)
{
// Read the modified information saved on disable from a config_text field to recover values
$profile_fields = $this->config_text->get($type_name . '.saved');
// If nothing saved, then nothing to do
if (empty($profile_fields))
{
return;
}
$profile_fields = (array) json_decode($profile_fields, true);
// Restore the affected profile fields to "active"
$sql = 'UPDATE ' . $this->fields_table . '
SET field_active = 1
WHERE field_active = 0
AND ' . $this->db->sql_in_set('field_id', array_keys($profile_fields));
$this->db->sql_query($sql);
// Remove the information saved in the config_text field, not needed any longer
$this->config_text->delete($type_name . '.saved');
// Log activity
foreach ($profile_fields as $field_ident)
{
$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_PROFILE_FIELD_ACTIVATE', time(), [$field_ident]);
}
}
/**
* Get list of profile fields of a certain type, if any
*
* @param string $type_name Type identifier of the profile fields
* @param bool $active True to limit output to active profile fields, false for all
* @return array Array with profile field ids as keys and idents as values
*/
private function list_profilefields($type_name, $active = false)
{
// Get list of profile fields affected by this operation, if any
$sql = 'SELECT field_id, field_ident
FROM ' . $this->fields_table . "
WHERE field_type = '" . $this->db->sql_escape($type_name) . "'" .
($active ? ' AND field_active = 1' : '');
$result = $this->db->sql_query($sql);
$rowset = $this->db->sql_fetchrowset($result);
$this->db->sql_freeresult($result);
return array_column($rowset, 'field_ident', 'field_id');
}
} }

31
tests/profilefields/fixtures/manager.xml Normal file
View File

@ -0,0 +1,31 @@
<?xml version="1.0" encoding="UTF-8" ?>
<dataset>
<table name="phpbb_profile_fields">
<column>field_id</column>
<column>field_ident</column>
<column>field_active</column>
<column>field_type</column>
<column>field_order</column>
<row>
<value>1</value>
<value>pf_1</value>
<value>1</value>
<value>foo_bar_type</value>
<value>1</value>
</row>
<row>
<value>2</value>
<value>pf_2</value>
<value>1</value>
<value>foo_bar_type</value>
<value>2</value>
</row>
<row>
<value>3</value>
<value>pf_3</value>
<value>1</value>
<value>other_type</value>
<value>3</value>
</row>
</table>
</dataset>

178
tests/profilefields/manager_test.php Normal file
View File

@ -0,0 +1,178 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
class manager_test extends phpbb_database_test_case
{
/** @var \phpbb\config\db_text */
protected $config_text;
/** @var \phpbb\db\driver\driver_interface */
protected $db;
/** @var \phpbb\db\tools\tools */
protected $db_tools;
/** @var \phpbb\log\log_interface */
protected $log;
/** @var \phpbb\profilefields\manager */
protected $manager;
/** @var string Table prefix */
protected $table_prefix;
/**
* {@inheritdoc}
*/
public function getDataSet()
{
return $this->createXMLDataSet(dirname(__FILE__).'/fixtures/manager.xml');
}
public function setUp()
{
parent::setUp();
global $phpbb_root_path, $phpEx, $table_prefix;
$this->db = $this->new_dbal();
$this->db_tools = $this->getMock('\phpbb\db\tools\tools', [], [$this->db]);
$this->config_text = new \phpbb\config\db_text($this->db, $table_prefix . 'config_text');
$this->table_prefix = $table_prefix;
$container = new phpbb_mock_container_builder();
$dispatcher = new phpbb_mock_event_dispatcher();
$request = $this->getMock('\phpbb\request\request');
$template = $this->getMock('\phpbb\template\template');
$auth = new \phpbb\auth\auth();
$language = new \phpbb\language\language(new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx));
$collection = new \phpbb\di\service_collection($container);
$user = new \phpbb\user($language, '\phpbb\datetime');
$this->log = new \phpbb\log\log($this->db, $user, $auth, $dispatcher, $phpbb_root_path, 'adm/', $phpEx, $table_prefix . 'log');
$this->manager = new \phpbb\profilefields\manager(
$auth,
$this->config_text,
$this->db,
$this->db_tools,
$dispatcher,
$language,
$this->log,
$request,
$template,
$collection,
$user,
$table_prefix . 'profile_fields',
$table_prefix . 'profile_fields_data',
$table_prefix . 'profile_fields_lang',
$table_prefix . 'profile_lang'
);
}
public function test_disable_profilefields()
{
// Disable the profile field type
$this->manager->disable_profilefields('foo_bar_type');
$sql = 'SELECT field_id, field_ident
FROM ' . $this->table_prefix . "profile_fields
WHERE field_active = 1
AND field_type = 'foo_bar_type'";
$this->assertSqlResultEquals([], $sql, 'All profile fields should be disabled');
// Test that the config entry exists
$saved = $this->config_text->get('foo_bar_type.saved');
$saved = (array) json_decode($saved, true);
$this->assertEquals([
1 => 'pf_1',
2 => 'pf_2',
], $saved, 'All disable profile fields should be saved');
}
public function test_enable_profilefields()
{
// Enable the profile field type
$this->manager->enable_profilefields('foo_bar_type');
$sql = 'SELECT field_id
FROM ' . $this->table_prefix . "profile_fields
WHERE field_active = 1
AND field_type = 'foo_bar_type'
ORDER BY field_id ASC";
$this->assertSqlResultEquals([
['field_id' => '1'],
['field_id' => '2'],
], $sql, 'All profile fields should be enabled');
// Test that the config entry was removed
$saved = $this->config_text->get('foo_bar_type.saved');
$this->assertEquals($saved, null, 'All disable profile fields should be removed');
}
public function test_purge_profilefields()
{
$this->db_tools
->expects($this->exactly(2))
->method('sql_column_remove')
->with(
$this->table_prefix . 'profile_fields_data',
$this->stringStartsWith('pf_')
);
// Get the field identifiers
$sql = 'SELECT field_id
FROM ' . $this->table_prefix . "profile_fields
WHERE field_type = 'foo_bar_type'";
$result = $this->db->sql_query($sql);
$rowset = $this->db->sql_fetchrowset($result);
$this->db->sql_freeresult($result);
$field_ids = array_map('intval', array_column($rowset, 'field_id'));
// Purge the profile field type
$this->manager->purge_profilefields('foo_bar_type');
// Test all the profile field tables
$sql = 'SELECT field_id
FROM ' . $this->table_prefix . "profile_fields
WHERE field_type = 'foo_bar_type'";
$this->assertSqlResultEquals([], $sql, 'All profile fields should be removed');
$sql = 'SELECT field_id
FROM ' . $this->table_prefix . "profile_fields_lang
WHERE field_type = 'foo_bar_type'";
$this->assertSqlResultEquals([], $sql, 'All profile fields lang should be removed');
$sql = 'SELECT lang_name
FROM ' . $this->table_prefix . 'profile_lang
WHERE ' . $this->db->sql_in_set('field_id', $field_ids);
$this->assertSqlResultEquals([], $sql, 'All profile fields lang should be removed');
$sql = 'SELECT field_id, field_order
FROM ' . $this->table_prefix . 'profile_fields
ORDER BY field_id ASC';
$this->assertSqlResultEquals([
[
'field_id' => '3',
'field_order' => '1'
]
], $sql, 'Profile fields order should be recalculated, starting by 1');
// Test that the config entry was removed
$saved = $this->config_text->get('foo_bar_type.saved');
$this->assertEquals($saved, null, 'All disable profile fields should be removed');
}
}