Merge pull request #340 from Leinad4Mind/master

Refactor Enabling/Disabling/Purging Logic + Update Code

Author: satanasov

acpcleanup/acp/main_info.php

@@ -12,21 +12,29 @@
 
 namespace phpbbgallery\acpcleanup\acp;
 
+/**
+ * ACP Module Info class
+ */
 class main_info
 {
-	function module()
+	/**
+	 * Returns module information
+	 *
+	 * @return array Module information
+	 */
+	public function module(): array
 	{
-		return array(
-			'filename'	=> 'main_module',
-			'title'		=> 'PHPBB_GALLERY',
-			'version'	=> '1.0.0',
-			'modes'		=> array(
-				'cleanup'			=> array(
-					'title' => 'ACP_GALLERY_CLEANUP',
-					'auth' => 'acl_a_gallery_cleanup && ext_phpbbgallery/acpcleanup',
-					'cat' => array('PHPBB_GALLERY')
-				),
-			),
-		);
+		return [
+				'filename' => '\phpbbgallery\acpcleanup\acp\main_module',
+				'title'    => 'PHPBB_GALLERY',
+				'version' => '1.0.0',
+				'modes'    => [
+					'cleanup' => [
+						'title' => 'ACP_GALLERY_CLEANUP',
+						'auth'  => 'acl_a_gallery_cleanup && ext_phpbbgallery/acpcleanup',
+						'cat'   => ['PHPBB_GALLERY'],
+					],
+				],
+		];
 	}
 }

acpcleanup/acp/main_module.php

@@ -14,28 +14,42 @@
 
 class main_module
 {
-	var $u_action;
+	public string $u_action;
 
-	function main($id, $mode)
+	public function main(string $id, string $mode): void
 	{
-		global $auth, $cache, $config, $db, $template, $user, $phpEx, $phpbb_root_path, $phpbb_ext_gallery;
+		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'));
-		//$user->add_lang_ext('phpbbgallery/acpcleanup', 'cleanup');
 		$this->tpl_name = 'gallery_cleanup';
+
 		add_form_key('acp_gallery');
 
+		$submit = $request->is_set_post('submit');
+
+		if ($submit && !check_form_key('acp_gallery'))
+		{
+			trigger_error($user->lang('FORM_INVALID') . adm_back_link($this->u_action), E_USER_WARNING);
+		}
+
 		$this->page_title = $user->lang['ACP_GALLERY_CLEANUP'];
-		$this->cleanup();
+		$this->cleanup($submit);
 	}
 
-	function cleanup()
+	/**
+	 * 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 = (isset($_POST['delete'])) ? true : false;
-		$prune = (isset($_POST['prune'])) ? true : false;
-		$submit = (isset($_POST['submit'])) ? true : false;
+		$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);

acpcleanup/adm/style/gallery_cleanup.html

@@ -147,21 +147,10 @@ <h1>{ACP_GALLERY_TITLE}</h1>
 
 		<p class="submit-buttons">
 			<input class="button1" type="submit" name="prune" value="{L_PRUNE}" />
+			{S_FORM_TOKEN}
 		</p>
 	</fieldset>
 	<!-- ENDIF -->
-	<p>{S_FORM_TOKEN}</p>
 </form>
 
-<!--
-	I request you retain the full copyright notice below including the link to www.flying-bits.org.
-	This not only gives respect to the large amount of time given freely by the developer
-	but also helps build interest, traffic and use of phpBB Gallery. If you (honestly) cannot retain
-	the full copyright I ask you at least leave in place the "Powered by phpBB Gallery" line, with
-	"phpBB Gallery" linked to www.flying-bits.org. If you refuse to include even this then support on my
-	forums may be affected.
-
-	phpBB Gallery, nickvergessen : 2009
-	Powered by phpBB Gallery (http://www.flying-bits.org/) &copy; 2007, 2009 nickvergessen (http://www.flying-bits.org/)
-//-->
 <!-- INCLUDE overall_footer.html -->

acpcleanup/composer.json

@@ -26,12 +26,12 @@
 		}
 	],
 	"require": {
-		"php": ">=5.3"
+		"php": ">=7.1"
 	},
 	"extra": {
 		"display-name": "phpBB Gallery Add-on: ACP Cleanup",
 		"soft-require": {
-			"phpbb/phpbb": ">=3.1.0-RC2,<3.3.0@dev"
+			"phpbb/phpbb": ">=3.2.0,<4.0.0@dev"
 		}
 	},
 	"version-check": {

acpcleanup/config/services.yml

@@ -1,6 +1,6 @@
 parameters:
-    tables.phpbbgallery.albums: '%core.table_prefix%gallery_albums'
-    tables.phpbbgallery.images: '%core.table_prefix%gallery_images'
+    phpbbgallery.tables.gallery_albums: '%core.table_prefix%gallery_albums'
+    phpbbgallery.tables.gallery_images: '%core.table_prefix%gallery_images'
 
 services:
     phpbbgallery.acpcleanup.cleanup:
@@ -16,5 +16,5 @@ services:
             - '@phpbbgallery.core.config'
             - '@phpbbgallery.core.log'
             - '@phpbbgallery.core.moderate'
-            - '%tables.phpbbgallery.albums%'
-            - '%tables.phpbbgallery.images%'
+            - '%phpbbgallery.tables.gallery_albums%'
+            - '%phpbbgallery.tables.gallery_images%'

acpcleanup/ext.php

@@ -8,12 +8,59 @@
  * @license   GPL-2.0-only
  */
 
-// this file is not really needed, when empty it can be omitted
-// however you can override the default methods and add custom
-// installation logic
-
 namespace phpbbgallery\acpcleanup;
 
 class ext extends \phpbb\extension\base
 {
+	/**
+	 * Check whether or not the extension can be enabled.
+	 * Checks dependencies and requirements.
+	 *
+	 * @return bool
+	 */
+	public function is_enableable()
+	{
+		$manager = $this->container->get('ext.manager');
+		$user = $this->container->get('user');
+
+		$core_ext = 'phpbbgallery/core';
+
+		// Check if core is installed (enabled or disabled)
+		$is_enabled = $manager->is_enabled($core_ext);
+		$is_disabled = $manager->is_disabled($core_ext);
+
+		if (!$is_enabled && !$is_disabled)
+		{
+			// Core not installed at all
+			$user->add_lang_ext('phpbbgallery/acpcleanup', 'info_acp_gallery_cleanup');
+			trigger_error($user->lang('GALLERY_CORE_NOT_FOUND'), E_USER_WARNING);
+			return false;
+		}
+
+		if ($is_disabled)
+		{
+			// Core installed but disabled — enable it automatically
+			$manager->enable($core_ext);
+		}
+
+		// If here, core is either enabled or just enabled now
+		return true;
+	}
+
+	/**
+	 * Perform additional tasks on extension enable
+	 *
+	 * @param mixed $old_state State returned by previous call of this method
+	 * @return mixed Returns false after last step, otherwise temporary state
+	 */
+	public function enable_step($old_state)
+	{
+		if (empty($old_state))
+		{
+			$this->container->get('user')->add_lang_ext('phpbbgallery/acpcleanup', 'info_acp_gallery_cleanup');
+			$this->container->get('template')->assign_var('L_EXTENSION_ENABLE_SUCCESS', $this->container->get('user')->lang['EXTENSION_ENABLE_SUCCESS']);
+		}
+
+		return parent::enable_step($old_state);
+	}
 }

exif/language/en/index copy.htm acpcleanup/language/bg/index.htmexif/language/en/index copy.htm renamed to acpcleanup/language/bg/index.htm

@@ -21,10 +21,10 @@
 
 if (empty($lang) || !is_array($lang))
 {
-	$lang = array();
+	$lang = [];
 }
 
-$lang = array_merge($lang, array(
+$lang = array_merge($lang, [
 	'ACP_GALLERY_CLEANUP'			=> 'Почистване на галерия',
 	'ACP_GALLERY_CLEANUP_EXPLAIN'	=> 'Тук можете да изтриете малко останки.',
 
@@ -78,4 +78,7 @@
 	'MOVE_TO_USER'		=> 'Премести при потребител',
 	'MOVE_TO_USER_EXP'	=> 'Изображенията и коментарите ще бъдат преместеи като такива на посочения потребител. Ако не посочите потребител - Гост е зададен по-подразбиране',
 	'CLEAN_USER_NOT_FOUND'	=> 'Желаният от вас потребител не е открит!',
-));
+
+	'GALLERY_CORE_NOT_FOUND'		=> 'Първо трябва да бъде инсталирано и активирано разширението phpBB Gallery Core.',
+	'EXTENSION_ENABLE_SUCCESS'		=> 'Разширението е активирано успешно.',
+]);

acpcleanup/language/bg/info_acp_gallery_cleanup.php

@@ -21,10 +21,10 @@
 
 if (empty($lang) || !is_array($lang))
 {
-	$lang = array();
+	$lang = [];
 }
 
-$lang = array_merge($lang, array(
+$lang = array_merge($lang, [
 	'ACP_GALLERY_CLEANUP'			=> 'Galerie bereinigen',
 
 	'ACP_GALLERY_CLEANUP_EXPLAIN'	=> 'Hier kannst Du einige Reste löschen.',
@@ -79,4 +79,7 @@
 	'MOVE_TO_USER'				=> 'Wechseln zu Benutzer',
 	'MOVE_TO_USER_EXP'			=> 'Bilder und Kommentare werden als diejenigen des Benutzers verschoben werden, die Du definiert hast. Wenn Keine ausgewählt wird - wird Gast verwendet.',
 	'CLEAN_USER_NOT_FOUND'		=> 'Der von Ihnen ausgewählte Benutzer existiert nicht!',
-));
+
+	'GALLERY_CORE_NOT_FOUND'		=> 'Die phpBB Gallery Core-Erweiterung muss zuerst installiert und aktiviert werden.',
+	'EXTENSION_ENABLE_SUCCESS'		=> 'Die Erweiterung wurde erfolgreich aktiviert.',
+]);