[feature/avatars] Make avatars generic

Adding a cleaning function for data coming from the users/groups tables so drivers only deal with clean data (ideally). Refactored get_user_avatar() and get_group_avatar() to use an underlying get_avatar() function. PHPBB3-10018
2025-07-30 21:40:43 +02:00 · 2011-06-18 22:50:52 -07:00
parent d0bb14ded1
commit a06380c69a
6 changed files with 141 additions and 78 deletions
--- a/phpBB/includes/avatar/driver.php
+++ b/phpBB/includes/avatar/driver.php
@@ -44,6 +44,12 @@ abstract class phpbb_avatar_driver
 	* @type phpbb_cache_driver_interface
 	*/
 	protected $cache;
+
+	/**
+	* @TODO
+	*/
+	const FROM_USER = 0;
+	const FROM_GROUP = 1;
 	
 	/**
 	* This flag should be set to true if the avatar requires a nonstandard image
@@ -71,12 +77,12 @@ abstract class phpbb_avatar_driver
 	/**
 	* Get the avatar url and dimensions
 	*
-	* @param $ignore_config Whether this function should respect the users/board
-	*        configuration option, or should just render the avatar anyways.
-	*        Useful for the ACP.
+	* @param $ignore_config Whether this function should respect the users prefs
+	*        and board configuration configuration option, or should just render
+	*        the avatar anyways. Useful for the ACP.
 	* @return array Avatar data
 	*/
-	public function get_data($user_row, $ignore_config = false)
+	public function get_data($row, $ignore_config = false)
 	{
 		return array(
 			'src' => '',
@@ -89,12 +95,12 @@ abstract class phpbb_avatar_driver
 	* Returns custom html for displaying this avatar.
 	* Only called if $custom_html is true.
 	*
-	* @param $ignore_config Whether this function should respect the users/board
-	*        configuration option, or should just render the avatar anyways.
-	*        Useful for the ACP.
+	* @param $ignore_config Whether this function should respect the users prefs
+	*        and board configuration configuration option, or should just render
+	*        the avatar anyways. Useful for the ACP.
 	* @return string HTML
 	*/
-	public function get_custom_html($user_row, $ignore_config = false)
+	public function get_custom_html($row, $ignore_config = false)
 	{
 		return '';
 	}
@@ -102,7 +108,7 @@ abstract class phpbb_avatar_driver
 	/**
 	* @TODO
 	**/
-	public function prepare_form($template, $user_row, &$error, &$override_focus)
+	public function prepare_form($template, $row, &$error, &$override_focus)
 	{
 		return false;
 	}
@@ -110,7 +116,7 @@ abstract class phpbb_avatar_driver
 	/**
 	* @TODO
 	**/
-	public function process_form($template, $user_row, &$error)
+	public function process_form($template, $row, &$error)
 	{
 		return false;
 	}
@@ -118,8 +124,49 @@ abstract class phpbb_avatar_driver
 	/**
 	* @TODO
 	**/
-	public function delete($user_row)
+	public function delete($row)
 	{
 		return true;
 	}
+
+	/**
+	* @TODO
+	**/
+	public static function clean_row($row, $src = phpbb_avatar_driver::FROM_USER)
+	{
+		$return = array();
+		$prefix = false;
+		
+		if ($src == phpbb_avatar_driver::FROM_USER)
+		{
+			$prefix = 'user_';
+		}
+		else if ($src == phpbb_avatar_driver::FROM_GROUP)
+		{
+			$prefix = 'group_';
+		}
+
+		if ($prefix)
+		{
+			$len = strlen($prefix);
+			foreach ($row as $key => $val)
+			{
+				$sub = substr($key, 0, $len);
+				if ($sub == $prefix)
+				{
+					$return[substr($key, $len)] = $val;
+				}
+				else
+				{
+					$return[$key] = $val;
+				}
+			}
+		}
+		else
+		{
+			$return = $row;
+		}
+
+		return $return;
+	}
 }
--- a/phpBB/includes/avatar/driver/local.php
+++ b/phpBB/includes/avatar/driver/local.php
@@ -24,14 +24,14 @@ class phpbb_avatar_driver_local extends phpbb_avatar_driver
 	/**
 	* @inheritdoc
 	*/
-	public function get_data($user_row, $ignore_config = false)
+	public function get_data($row, $ignore_config = false)
 	{
 		if ($ignore_config || $this->config['allow_avatar_local'])
 		{
 			return array(
-				'src' => $this->phpbb_root_path . $this->config['avatar_gallery_path'] . '/' . $user_row['user_avatar'],
-				'width' => $user_row['user_avatar_width'],
-				'height' => $user_row['user_avatar_height'],
+				'src' => $this->phpbb_root_path . $this->config['avatar_gallery_path'] . '/' . $row['avatar'],
+				'width' => $row['avatar_width'],
+				'height' => $row['avatar_height'],
 			);
 		}
 		else
@@ -47,7 +47,7 @@ class phpbb_avatar_driver_local extends phpbb_avatar_driver
 	/**
 	* @inheritdoc
 	*/
-	public function prepare_form($template, $user_row, &$error)
+	public function prepare_form($template, $row, &$error)
 	{
 		$avatar_list = $this->get_avatar_list();
 		$category = request_var('av_local_cat', '');
@@ -83,7 +83,7 @@ class phpbb_avatar_driver_local extends phpbb_avatar_driver
 	/**
 	* @inheritdoc
 	*/
-	public function process_form($template, $user_row, &$error)
+	public function process_form($template, $row, &$error)
 	{
 		$avatar_list = $this->get_avatar_list();
 		$category = request_var('av_local_cat', '');
@@ -96,9 +96,9 @@ class phpbb_avatar_driver_local extends phpbb_avatar_driver
 		}

 		return array(
-			'user_avatar' => $category . '/' . $file,
-			'user_avatar_width' => $avatar_list[$category][urldecode($file)]['width'],
-			'user_avatar_height' => $avatar_list[$category][urldecode($file)]['height'],
+			'avatar' => $category . '/' . $file,
+			'avatar_width' => $avatar_list[$category][urldecode($file)]['width'],
+			'avatar_height' => $avatar_list[$category][urldecode($file)]['height'],
 		);
 	}

--- a/phpBB/includes/avatar/driver/remote.php
+++ b/phpBB/includes/avatar/driver/remote.php
@@ -24,14 +24,14 @@ class phpbb_avatar_driver_remote extends phpbb_avatar_driver
 	/**
 	* @inheritdoc
 	*/
-	public function get_data($user_row, $ignore_config = false)
+	public function get_data($row, $ignore_config = false)
 	{
 		if ($ignore_config || $this->config['allow_avatar_remote'])
 		{
 			return array(
-				'src' => $user_row['user_avatar'],
-				'width' => $user_row['user_avatar_width'],
-				'height' => $user_row['user_avatar_height'],
+				'src' => $row['avatar'],
+				'width' => $row['avatar_width'],
+				'height' => $row['avatar_height'],
 			);
 		}
 		else
@@ -47,12 +47,12 @@ class phpbb_avatar_driver_remote extends phpbb_avatar_driver
 	/**
 	* @inheritdoc
 	*/
-	public function prepare_form($template, $user_row, &$error)
+	public function prepare_form($template, $row, &$error)
 	{
 		$template->assign_vars(array(
-			'AV_REMOTE_WIDTH' => (($user_row['user_avatar_type'] == AVATAR_REMOTE || $user_row['user_avatar_type'] == 'remote') && $user_row['user_avatar_width']) ? $user_row['user_avatar_width'] : request_var('av_local_width', 0),
-			'AV_REMOTE_HEIGHT' => (($user_row['user_avatar_type'] == AVATAR_REMOTE || $user_row['user_avatar_type'] == 'remote') && $user_row['user_avatar_height']) ? $user_row['user_avatar_height'] : request_var('av_local_width', 0),
-			'AV_REMOTE_URL' => (($user_row['user_avatar_type'] == AVATAR_REMOTE || $user_row['user_avatar_type'] == 'remote') && $user_row['user_avatar']) ? $user_row['user_avatar'] : '',
+			'AV_REMOTE_WIDTH' => (($row['avatar_type'] == AVATAR_REMOTE || $row['avatar_type'] == 'remote') && $row['avatar_width']) ? $row['avatar_width'] : request_var('av_local_width', 0),
+			'AV_REMOTE_HEIGHT' => (($row['avatar_type'] == AVATAR_REMOTE || $row['avatar_type'] == 'remote') && $row['avatar_height']) ? $row['avatar_height'] : request_var('av_local_width', 0),
+			'AV_REMOTE_URL' => (($row['avatar_type'] == AVATAR_REMOTE || $row['avatar_type'] == 'remote') && $row['avatar']) ? $row['avatar'] : '',
 		));

 		return true;
@@ -61,7 +61,7 @@ class phpbb_avatar_driver_remote extends phpbb_avatar_driver
 	/**
 	* @inheritdoc
 	*/
-	public function process_form($template, $user_row, &$error)
+	public function process_form($template, $row, &$error)
 	{
 		$url = request_var('av_remote_url', '');
 		$width = request_var('av_remote_width', 0);
@@ -155,9 +155,9 @@ class phpbb_avatar_driver_remote extends phpbb_avatar_driver
 		}

 		return array(
-			'user_avatar' => $url,
-			'user_avatar_width' => $width,
-			'user_avatar_height' => $height,
+			'avatar' => $url,
+			'avatar_width' => $width,
+			'avatar_height' => $height,
 		);
 	}
 }
--- a/phpBB/includes/avatar/driver/upload.php
+++ b/phpBB/includes/avatar/driver/upload.php
@@ -24,14 +24,14 @@ class phpbb_avatar_driver_upload extends phpbb_avatar_driver
 	/**
 	* @inheritdoc
 	*/
-	public function get_data($user_row, $ignore_config = false)
+	public function get_data($row, $ignore_config = false)
 	{
 		if ($ignore_config || $this->config['allow_avatar_upload'])
 		{
 			return array(
-				'src' => $this->phpbb_root_path . 'download/file.' . $this->phpEx . '?avatar=' . $user_row['user_avatar'],
-				'width' => $user_row['user_avatar_width'],
-				'height' => $user_row['user_avatar_height'],
+				'src' => $this->phpbb_root_path . 'download/file.' . $this->phpEx . '?avatar=' . $row['avatar'],
+				'width' => $row['avatar_width'],
+				'height' => $row['avatar_height'],
 			);
 		}
 		else
@@ -47,7 +47,7 @@ class phpbb_avatar_driver_upload extends phpbb_avatar_driver
 	/**
 	* @inheritdoc
 	*/
-	public function prepare_form($template, $user_row, &$error)
+	public function prepare_form($template, $row, &$error)
 	{
 		if (!$this->can_upload())
 		{
@@ -65,7 +65,7 @@ class phpbb_avatar_driver_upload extends phpbb_avatar_driver
 	/**
 	* @inheritdoc
 	*/
-	public function process_form($template, $user_row, &$error)
+	public function process_form($template, $row, &$error)
 	{
 		if (!$this->can_upload())
 		{
@@ -88,7 +88,7 @@ class phpbb_avatar_driver_upload extends phpbb_avatar_driver
 		}

 		$prefix = $this->config['avatar_salt'] . '_';
-		$file->clean_filename('avatar', $prefix, $user_row['user_id']);
+		$file->clean_filename('avatar', $prefix, $row['id']);

 		$destination = $this->config['avatar_path'];

@@ -115,19 +115,19 @@ class phpbb_avatar_driver_upload extends phpbb_avatar_driver
 		}

 		return array(
-			'user_avatar' => $user_row['user_id'] . '_' . time() . '.' . $file->get('extension'),
-			'user_avatar_width' => $file->get('width'),
-			'user_avatar_height' => $file->get('height'),
+			'avatar' => $row['id'] . '_' . time() . '.' . $file->get('extension'),
+			'avatar_width' => $file->get('width'),
+			'avatar_height' => $file->get('height'),
 		);
 	}

 	/**
 	* @inheritdoc
 	*/
-	public function delete($user_row)
+	public function delete($row)
 	{
-		$ext = substr(strrchr($user_row['user_avatar'], '.'), 1);
-		$filename = $this->phpbb_root_path . $this->config['avatar_path'] . '/' . $this->config['avatar_salt'] . '_' . $user_row['user_id'] . '.' . $ext;
+		$ext = substr(strrchr($row['avatar'], '.'), 1);
+		$filename = $this->phpbb_root_path . $this->config['avatar_path'] . '/' . $this->config['avatar_salt'] . '_' . $row['id'] . '.' . $ext;

 		if (file_exists($filename))
 		{