phpbbgallery\acpcleanup\acp\main_module

Complexity

Total Complexity

90

Size/Duplication

Total Lines	487
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	2
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
F	cleanup()	0	455	87
A	main()	0	18	3

<?php
/**
 * phpBB Gallery - ACP CleanUp Extension
 *
 * @package   phpbbgallery/acpcleanup
 * @author    nickvergessen
 * @author    satanasov
 * @author    Leinad4Mind
 * @copyright 2007-2012 nickvergessen, 2014- satanasov, 2018- Leinad4Mind
 * @license   GPL-2.0-only
 */

namespace phpbbgallery\acpcleanup\acp;

class main_module
{
	public string $u_action;

	public function main(string $id, string $mode): void

The parameter $id is not used and could be removed.

The parameter $mode is not used and could be removed.

	{
		global $auth, $cache, $config, $db, $template, $request, $user, $phpEx, $phpbb_root_path, $phpbb_ext_gallery;

		$user->add_lang_ext('phpbbgallery/core', array('gallery_acp', 'gallery'));
		$this->tpl_name = 'gallery_cleanup';

The property tpl_name does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

		add_form_key('acp_gallery');

The function add_form_key was not found. Maybe you did not declare it correctly or list all dependencies?

		$submit = $request->is_set_post('submit');

		if ($submit && !check_form_key('acp_gallery'))

The function check_form_key was not found. Maybe you did not declare it correctly or list all dependencies?

		{
			trigger_error($user->lang('FORM_INVALID') . adm_back_link($this->u_action), E_USER_WARNING);

The function adm_back_link was not found. Maybe you did not declare it correctly or list all dependencies?

		}

		$this->page_title = $user->lang['ACP_GALLERY_CLEANUP'];

The property page_title does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

		$this->cleanup($submit);
	}

	/**
	 * Cleanup gallery files and database entries
	 *
	 * @param array $missing_entries Files to clean
	 * @param bool $move_to_import Whether to move files to import dir
	 * @return array Messages about cleanup results
	 * @throws \RuntimeException On file operation errors
	 */
	public function cleanup(bool $submit = false): void
	{
		global $auth, $cache, $db, $template, $user, $phpbb_ext_gallery, $table_prefix, $phpbb_container, $request;

		$delete = $request->is_set_post('delete');
		$prune = $request->is_set_post('prune');

		$missing_sources = $request->variable('source', array(0));
		$missing_entries = $request->variable('entry', array(''), true);
		$missing_authors = $request->variable('author', array(0), true);
		$missing_comments = $request->variable('comment', array(0), true);
		$missing_personals = $request->variable('personal', array(0), true);
		$personals_bad = $request->variable('personal_bad', array(0), true);
		$prune_pattern = $request->variable('prune_pattern', array('' => ''), true);

		$move_to_import = $request->variable('move_to_import', 0);
		$new_author = $request->variable('new_author', '');

		$gallery_album = $phpbb_container->get('phpbbgallery.core.album');
		$core_cleanup = $phpbb_container->get('phpbbgallery.acpcleanup.cleanup');
		$gallery_auth = $phpbb_container->get('phpbbgallery.core.auth');
		$gallery_config = $phpbb_container->get('phpbbgallery.core.config');
		$gallery_url = $phpbb_container->get('phpbbgallery.core.url');

		// Lets detect if ACP Import exists (find if directory is with RW access)
		$acp_import_installed = false;
		$acp_import_dir = $gallery_url->path('import');
		if (file_exists($acp_import_dir) && is_writable($acp_import_dir))
		{
			$acp_import_installed = true;
		}
		if ($prune && empty($prune_pattern))
		{
			$prune_pattern['image_album_id'] = implode(',', $request->variable('prune_album_ids', array(0)));
			if (isset($_POST['prune_username_check']))
			{
				$usernames = $request->variable('prune_usernames', '', true);
				$usernames = explode("\n", $usernames);
				$prune_pattern['image_user_id'] = array();
				if (!empty($usernames))
				{
					if (!function_exists('user_get_id_name'))
					{
						$gallery_url->_include('functions_user', 'phpbb');
					}
					user_get_id_name($user_ids, $usernames);

The variable $user_ids does not exist. Did you maybe mean $user_id?

					$prune_pattern['image_user_id'] = $user_ids;
				}
				if (isset($_POST['prune_anonymous']))
				{
					$prune_pattern['image_user_id'][] = ANONYMOUS;

The constant phpbbgallery\acpcleanup\acp\ANONYMOUS was not found. Maybe you did not declare it correctly or list all dependencies?

				}
				$prune_pattern['image_user_id'] = implode(',', $prune_pattern['image_user_id']);
			}
			if (isset($_POST['prune_time_check']))
			{
				$prune_time = explode('-', $request->variable('prune_time', ''));

				if (sizeof($prune_time) == 3)
				{
					$prune_pattern['image_time'] = @gmmktime(0, 0, 0, (int) $prune_time[1], (int) $prune_time[2], (int) $prune_time[0]);
				}
			}
			if (isset($_POST['prune_comments_check']))
			{
				$prune_pattern['image_comments'] = $request->variable('prune_comments', 0);
			}
			if (isset($_POST['prune_ratings_check']))
			{
				$prune_pattern['image_rates'] = $request->variable('prune_ratings', 0);
			}
			if (isset($_POST['prune_rating_avg_check']))
			{
				$prune_pattern['image_rate_avg'] = (int) ($request->variable('prune_rating_avg', 0.0) * 100);
			}
		}

		$s_hidden_fields = build_hidden_fields(array(

The function build_hidden_fields was not found. Maybe you did not declare it correctly or list all dependencies?

			'source'		=> $missing_sources,
			'entry'			=> $missing_entries,
			'author'		=> $missing_authors,
			'comment'		=> $missing_comments,
			'personal'		=> $missing_personals,
			'personal_bad'	=> $personals_bad,
			'prune_pattern'	=> $prune_pattern,
			'move_to_import'	=> $move_to_import,
		));

		if ($submit)
		{
			$user_id = 1;
			if ($new_author)
			{
				$user_id = 0;
				if (!function_exists('user_get_id_name'))
				{
					$gallery_url->_include('functions_user', 'phpbb');
				}
				user_get_id_name($user_id, $new_author);
				if (is_array($user_id) && !empty($user_id))

The condition is_array($user_id) is always false.

				{
					$user_id = $user_id[0];
				}
				if (!$user_id)
				{
					trigger_error($user->lang('CLEAN_USER_NOT_FOUND', $new_author) . adm_back_link($this->u_action), E_USER_WARNING);

The function adm_back_link was not found. Maybe you did not declare it correctly or list all dependencies?

				}
			}
			if ($missing_authors)
			{
				$sql = 'UPDATE ' . $table_prefix . 'gallery_images
					SET image_user_id = ' . $user_id . ",
						image_user_colour = ''
					WHERE " . $db->sql_in_set('image_id', $missing_authors);
				$db->sql_query($sql);
			}
			if ($missing_comments)
			{
				$sql = 'UPDATE ' . $table_prefix . 'gallery_comments
					SET comment_user_id = ' . $user_id . ",
						comment_user_colour = ''
					WHERE " . $db->sql_in_set('comment_id', $missing_comments);
				$db->sql_query($sql);
			}
			trigger_error($user->lang['CLEAN_CHANGED'] . adm_back_link($this->u_action));
		}

		if (confirm_box(true))

The function confirm_box was not found. Maybe you did not declare it correctly or list all dependencies?

		{
			$message = array();
			if ($missing_entries)
			{
				if ($acp_import_installed && $move_to_import)
				{
					foreach ($missing_entries as $entry)
					{
						copy($gallery_url->path('upload') . '/' . $entry, $gallery_url->path('import') . '/' . $entry);
					}
				}
				$message[] = $core_cleanup->delete_files($missing_entries);
			}
			if ($missing_sources)
			{
				$message[] = $core_cleanup->delete_images($missing_sources);
			}
			if ($missing_authors)
			{
				$message[] = $core_cleanup->delete_author_images($missing_entries);
			}
			if ($missing_comments)
			{
				$message[] = $core_cleanup->delete_author_comments($missing_comments);
			}
			if ($missing_personals || $personals_bad)
			{
				$message = array_merge($message, $core_cleanup->delete_pegas($personals_bad, $missing_personals));

				// Only do this, when we changed something about the albums
				$cache->destroy('_albums');
				$gallery_auth->set_user_permissions('all', '');
			}
			if ($prune_pattern)
			{
				$message[] = $core_cleanup->prune($prune_pattern);
			}

			if (empty($message))
			{
				trigger_error($user->lang['CLEAN_NO_ACTION'] . adm_back_link($this->u_action), E_USER_WARNING);
			}

			// Make sure the overall image & comment count is correct...
			$sql = 'SELECT COUNT(image_id) AS num_images, SUM(image_comments) AS num_comments
				FROM ' . $table_prefix . 'gallery_images
				WHERE image_status <> ' . (int) \phpbbgallery\core\block::STATUS_UNAPPROVED;
			$result = $db->sql_query($sql);
			$row = $db->sql_fetchrow($result);
			$db->sql_freeresult($result);

			$gallery_config->set('num_images', $row['num_images']);
			$gallery_config->set('num_comments', (int) $row['num_comments']);

			$cache->destroy('sql', $table_prefix . 'gallery_albums');
			$cache->destroy('sql', $table_prefix . 'gallery_comments');
			$cache->destroy('sql', $table_prefix . 'gallery_images');
			$cache->destroy('sql', $table_prefix . 'gallery_rates');
			$cache->destroy('sql', $table_prefix . 'gallery_reports');
			$cache->destroy('sql', $table_prefix . 'gallery_watch');

			$message_string = '';
			foreach ($message as $lang_key)
			{
				$message_string .= (($message_string) ? '<br />' : '') . $user->lang[$lang_key];
			}

			trigger_error($message_string . adm_back_link($this->u_action));
		}
		else if ($delete || $prune || (isset($_POST['cancel'])))
		{
			if (isset($_POST['cancel']))
			{
				trigger_error($user->lang['CLEAN_GALLERY_ABORT'] . adm_back_link($this->u_action), E_USER_WARNING);
			}
			else
			{
				$clean_gallery_confirm = $user->lang['CONFIRM_CLEAN'];
				if ($missing_sources)
				{
					$clean_gallery_confirm = $user->lang['CONFIRM_CLEAN_SOURCES'] . '<br />' . $clean_gallery_confirm;
				}
				if ($missing_entries)
				{
					$clean_gallery_confirm = $user->lang['CONFIRM_CLEAN_ENTRIES'] . '<br />' . $clean_gallery_confirm;
				}
				if ($missing_authors)
				{
					$core_cleanup->delete_author_images($missing_authors);
					$clean_gallery_confirm = $user->lang['CONFIRM_CLEAN_AUTHORS'] . '<br />' . $clean_gallery_confirm;
				}
				if ($missing_comments)
				{
					$clean_gallery_confirm = $user->lang['CONFIRM_CLEAN_COMMENTS'] . '<br />' . $clean_gallery_confirm;
				}
				if ($personals_bad || $missing_personals)
				{
					$sql = 'SELECT album_name, album_user_id
						FROM ' . $table_prefix . 'gallery_albums
						WHERE ' . $db->sql_in_set('album_user_id', array_merge($missing_personals, $personals_bad));
					$result = $db->sql_query($sql);
					while ($row = $db->sql_fetchrow($result))
					{
						if (in_array($row['album_user_id'], $personals_bad))
						{
							$personals_bad_names[] = $row['album_name'];
						}
						else
						{
							$missing_personals_names[] = $row['album_name'];
						}
					}
					$db->sql_freeresult($result);
				}
				if ($missing_personals)
				{
					$clean_gallery_confirm = $user->lang('CONFIRM_CLEAN_PERSONALS', implode(', ', $missing_personals_names)) . '<br />' . $clean_gallery_confirm;

The variable $missing_personals_names does not seem to be defined for all execution paths leading up to this point.

				}
				if ($personals_bad)
				{
					$clean_gallery_confirm = $user->lang('CONFIRM_CLEAN_PERSONALS_BAD', implode(', ', $personals_bad_names)) . '<br />' . $clean_gallery_confirm;

The variable $personals_bad_names does not seem to be defined for all execution paths leading up to this point.

				}
				if ($prune && empty($prune_pattern))
				{
					trigger_error($user->lang['CLEAN_PRUNE_NO_PATTERN'] . adm_back_link($this->u_action), E_USER_WARNING);
				}
				else if ($prune && $prune_pattern)
				{
					$clean_gallery_confirm = $user->lang('CONFIRM_PRUNE', $core_cleanup->lang_prune_pattern($prune_pattern)) . '<br />' . $clean_gallery_confirm;
				}
				confirm_box(false, $clean_gallery_confirm, $s_hidden_fields);
			}
		}

		$requested_source = array();
		$sql_array = array(
			'SELECT'		=> 'i.image_id, i.image_name, i.image_filemissing, i.image_filename, i.image_username, u.user_id',
			'FROM'			=> array($table_prefix . 'gallery_images' => 'i'),

			'LEFT_JOIN'		=> array(
				array(
					'FROM'		=> array(USERS_TABLE => 'u'),

The constant phpbbgallery\acpcleanup\acp\USERS_TABLE was not found. Maybe you did not declare it correctly or list all dependencies?

					'ON'		=> 'u.user_id = i.image_user_id',
				),
			),
		);
		$sql = $db->sql_build_query('SELECT', $sql_array);
		$result = $db->sql_query($sql);
		while ($row = $db->sql_fetchrow($result))
		{
			if ($row['image_filemissing'])
			{
				$template->assign_block_vars('sourcerow', array(
					'IMAGE_ID'		=> $row['image_id'],
					'IMAGE_NAME'	=> $row['image_name'],
				));
			}
			if (!$row['user_id'])
			{
				$template->assign_block_vars('authorrow', array(
					'IMAGE_ID'		=> $row['image_id'],
					'AUTHOR_NAME'	=> $row['image_username'],
				));
			}
			$requested_source[] = $row['image_filename'];
		}
		$db->sql_freeresult($result);

		$check_mode = $request->variable('check_mode', '');
		if ($check_mode == 'source')
		{
			$source_missing = array();

			// Reset the status: a image might have been viewed without file but the file is back
			$sql = 'UPDATE ' . $table_prefix . 'gallery_images
				SET image_filemissing = 0';
			$db->sql_query($sql);

			$sql = 'SELECT image_id, image_filename, image_filemissing
				FROM ' . $table_prefix . 'gallery_images';
			$result = $db->sql_query($sql);
			while ($row = $db->sql_fetchrow($result))
			{
				if (!file_exists($gallery_url->path('upload') . $row['image_filename']))
				{
					$source_missing[] = $row['image_id'];
				}
			}
			$db->sql_freeresult($result);

			if ($source_missing)
			{
				$sql = 'UPDATE ' . $table_prefix . "gallery_images
					SET image_filemissing = 1
					WHERE " . $db->sql_in_set('image_id', $source_missing);
				$db->sql_query($sql);
			}
		}

		if ($check_mode == 'entry')
		{
			$directory = $gallery_url->path('upload');
			$handle = opendir($directory);
			while ($file = readdir($handle))
			{
				if (!is_dir($directory . $file) &&
				 ((substr(strtolower($file), '-5') == '.webp') || (substr(strtolower($file), '-4') == '.png') || (substr(strtolower($file), '-4') == '.gif') || (substr(strtolower($file), '-4') == '.jpg') || (substr(strtolower($file), '-5') == '.jpeg')) &&
				 ((substr(strtolower($file), '-8') <> '_wm.webp') && (substr(strtolower($file), '-7') <> '_wm.png') && (substr(strtolower($file), '-7') <> '_wm.gif') && (substr(strtolower($file), '-7') <> '_wm.jpg') && (substr(strtolower($file), '-8') <> '_wm.jpeg'))
				 && !in_array($file, $requested_source)
				)
				{
					if ((strpos($file, 'image_not_exist') !== false) || (strpos($file, 'not_authorised') !== false) || (strpos($file, 'no_hotlinking') !== false))
					{
						continue;
					}

					$template->assign_block_vars('entryrow', array(
						'FILE_NAME'				=> utf8_encode($file),
					));
				}
			}
			closedir($handle);
		}

		$sql_array = array(
			'SELECT'		=> 'c.comment_id, c.comment_image_id, c.comment_username, u.user_id',
			'FROM'			=> array($table_prefix . 'gallery_comments' => 'c'),

			'LEFT_JOIN'		=> array(
				array(
					'FROM'		=> array(USERS_TABLE => 'u'),
					'ON'		=> 'u.user_id = c.comment_user_id',
				),
			),
		);
		$sql = $db->sql_build_query('SELECT', $sql_array);
		$result = $db->sql_query($sql);
		while ($row = $db->sql_fetchrow($result))
		{
			if (!$row['user_id'])
			{
				$template->assign_block_vars('commentrow', array(
					'COMMENT_ID'	=> $row['comment_id'],
					'IMAGE_ID'		=> $row['comment_image_id'],
					'AUTHOR_NAME'	=> $row['comment_username'],
				));
			}
		}
		$db->sql_freeresult($result);

		$sql_array = array(
			'SELECT'		=> 'a.album_id, a.album_user_id, a.album_name, u.user_id, a.album_images_real',
			'FROM'			=> array($table_prefix . 'gallery_albums' => 'a'),

			'LEFT_JOIN'		=> array(
				array(
					'FROM'		=> array(USERS_TABLE => 'u'),
					'ON'		=> 'u.user_id = a.album_user_id',
				),
			),

			'WHERE'			=> 'a.album_user_id <> ' . (int) \phpbbgallery\core\block::PUBLIC_ALBUM . ' AND a.parent_id = 0',
		);
		$sql = $db->sql_build_query('SELECT', $sql_array);
		$result = $db->sql_query($sql);
		$personalrow = $personal_bad_row = array();
		while ($row = $db->sql_fetchrow($result))
		{
			$album = array(
				'user_id'		=> $row['album_user_id'],
				'album_id'		=> $row['album_id'],
				'album_name'	=> $row['album_name'],
				'images'		=> $row['album_images_real'],
			);
			if (!$row['user_id'])
			{
				$personalrow[$row['album_user_id']] = $album;
			}
			$personal_bad_row[$row['album_user_id']] = $album;
		}
		$db->sql_freeresult($result);

		$sql = 'SELECT ga.album_user_id, ga.album_images_real
			FROM ' . $table_prefix . 'gallery_albums ga
			WHERE ga.album_user_id <> ' . (int) \phpbbgallery\core\block::PUBLIC_ALBUM . '
				AND ga.parent_id <> 0';
		$result = $db->sql_query($sql);
		while ($row = $db->sql_fetchrow($result))
		{
			if (isset($personalrow[$row['album_user_id']]))
			{
				$personalrow[$row['album_user_id']]['images'] = $personalrow[$row['album_user_id']]['images'] + $row['album_images_real'];
			}
			$personal_bad_row[$row['album_user_id']]['images'] = $personal_bad_row[$row['album_user_id']]['images'] + $row['album_images_real'];
		}
		$db->sql_freeresult($result);

		foreach ($personalrow as $key => $row)
		{
			$template->assign_block_vars('personalrow', array(
				'USER_ID'		=> $row['user_id'],
				'ALBUM_ID'		=> $row['album_id'],
				'AUTHOR_NAME'	=> $row['album_name'],
			));
		}
		foreach ($personal_bad_row as $key => $row)
		{
			$template->assign_block_vars('personal_bad_row', array(
				'USER_ID'		=> $row['user_id'],
				'ALBUM_ID'		=> $row['album_id'],
				'AUTHOR_NAME'	=> $row['album_name'],
				'IMAGES'		=> $row['images'],
			));
		}

		$template->assign_vars(array(
			'S_GALLERY_MANAGE_RESTS'		=> true,
			'ACP_GALLERY_TITLE'				=> $user->lang['ACP_GALLERY_CLEANUP'],
			'ACP_GALLERY_TITLE_EXPLAIN'		=> $user->lang['ACP_GALLERY_CLEANUP_EXPLAIN'],
			'ACP_IMPORT_INSTALLED'	=> $acp_import_installed,
			'CHECK_SOURCE'			=> $this->u_action . '&amp;check_mode=source',
			'CHECK_ENTRY'			=> $this->u_action . '&amp;check_mode=entry',

			'U_FIND_USERNAME'		=> $gallery_url->append_sid('phpbb', 'memberlist', 'mode=searchuser&amp;form=acp_gallery&amp;field=prune_usernames'),
			'S_SELECT_ALBUM'		=> $gallery_album->get_albumbox(false, '', false, false, false, (int) \phpbbgallery\core\block::PUBLIC_ALBUM, (int) \phpbbgallery\core\block::TYPE_UPLOAD),

			'S_FOUNDER'				=> ($user->data['user_type'] == USER_FOUNDER) ? true : false,

The constant phpbbgallery\acpcleanup\acp\USER_FOUNDER was not found. Maybe you did not declare it correctly or list all dependencies?

		));
	}
}