Fix RSI v1.0.2

Signed-off-by: Dark❶ <dark-1@users.noreply.github.com>
Dark1z · Feb 5, 2021 · 7b57302 · 7b57302
1 parent eeb6711
commit 7b57302
Show file tree

Hide file tree

Showing 14 changed files with 181 additions and 137 deletions.
diff --git a/.github/workflows/actions.yml b/.github/workflows/actions.yml
@@ -1,58 +1,87 @@
 name: Actions CI
+
+env:
+    EXTNAME: dark1/reducesearchindex   # Your extension vendor/package name
+    SNIFF: 1                           # Run code sniffer on your code? 1 or 0
+    IMAGE_ICC: 1                       # Run icc profile sniffer on your images? 1 or 0
+    EPV: 1                             # Run EPV (Extension Pre Validator) on your code? 1 or 0
+    EXECUTABLE_FILES: 1                # Run check for executable files? 1 or 0
+    PHPBB_BRANCH: 3.3.x                # The phpBB branch to run tests on
+
 on:
-  push:
-    branches:
-    - master
-  pull_request:
-    branches:
-    - master
+    push:
+        branches:        # Run tests when commits are pushed to these branches in your repo
+            - master
+    pull_request:        # Run tests when pull requests are made on these branches in your repo
+        branches:
+            - master
 
 jobs:
-  check:
-    name: Check
-    if: (!contains(github.event.head_commit.message, '[ci skip]') && !contains(github.event.head_commit.message, '[skip ci]'))
-    runs-on: ubuntu-latest
-    env:
-        PHPBB_BRANCH: 3.3.x                 # phpBB Branch
-        EXTNAME: dark1/reducesearchindex    # CHANGE name of the extension HERE
-        SNIFF: 1                            # Should we run code sniffer on your code?
-        EPV: 1                              # Should we run EPV (Extension Pre Validator) on your code?
-
-    steps:
-
-    - name: Actions Checkout
-      uses: actions/checkout@v1
-
-    - name: Actions Setup - Copy to Temp Location
-      run: |
-          mkdir --parents ../tmp
-          cp -R . ../tmp
-
-    - name: Actions Setup - Clone phpBB
-      run: |
-          git clone --depth=1 git://github.com/phpbb/phpbb.git phpBB3 --branch=$PHPBB_BRANCH
-
-    - name: Actions Setup - Composer Install/Remove/Require
-      run: |
-          cd phpBB3/phpBB
-          composer install --no-interaction --no-progress --no-suggest --ignore-platform-reqs
-          composer remove sami/sami --no-interaction --no-progress --ignore-platform-reqs --dev
-          composer require phpbb/epv:dev-master --no-interaction --no-progress --no-suggest --ignore-platform-reqs --dev
-          cd ../../
-
-    - name: Actions Setup - Copy from Temp Location
-      run: |
-          mkdir --parents phpBB3/phpBB/ext/$EXTNAME/$EXTNAME
-          cp -R ../tmp/* phpBB3/phpBB/ext/$EXTNAME/$EXTNAME
-
-    - name: Actions Test - Code Sniffer
-      run: |
-          cd phpBB3
-          sh -c "if [ '$SNIFF' != '0' ]; then phpBB/vendor/bin/phpcs -s --extensions=php --standard=build/code_sniffer/ruleset-php-extensions.xml "--ignore=*/$EXTNAME/tests/*" "--ignore=*/$EXTNAME/vendor/*" "phpBB/ext/$EXTNAME"; fi"
-          cd ../
-
-    - name: Actions Test - EPV (Extension Pre Validator)
-      run: |
-          cd phpBB3
-          sh -c "if [ '$EPV' != '0' ]; then phpBB/vendor/bin/EPV.php run --dir='phpBB/ext/$EXTNAME' --debug; fi"
-          cd ../
+    # START Basic Checks Job (EPV, code sniffer, images check, etc.)
+    basic-checks:
+        if: (!contains(github.event.head_commit.message, '[ci skip]') && !contains(github.event.head_commit.message, '[skip ci]'))
+        runs-on: ubuntu-18.04
+        strategy:
+            matrix:
+                include:
+                    - php: '7.1'
+                      db: "none"
+                      NOTESTS: 1
+
+        name: PHP ${{ matrix.php }} - ${{ matrix.db }}
+
+        steps:
+            - name: Checkout phpBB
+              uses: actions/checkout@v2
+              with:
+                  repository: phpbb/phpbb
+                  ref: ${{ env.PHPBB_BRANCH }}
+                  path: phpBB3
+
+            - name: Checkout extension
+              uses: actions/checkout@v2
+              with:
+                  path: phpBB3/phpBB/ext/${{ env.EXTNAME }}/${{ env.EXTNAME }}
+
+            - name: Setup PHP
+              uses: shivammathur/setup-php@v2
+              with:
+                  php-version: ${{ matrix.php }}
+                  extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, mysqli, sqlite, pdo_sqlite, intl, gd, exif, iconv, sqlsrv, pdo_sqlsrv, ldap
+                  coverage: none
+
+            - name: Setup environment for phpBB
+              env:
+                  DB: ${{ matrix.db }}
+                  PHP_VERSION: ${{ matrix.php }}
+                  NOTESTS: '1'
+              run: .github/setup-phpbb.sh $DB $PHP_VERSION $NOTESTS
+              working-directory: ./phpBB3
+
+            - name: Setup EPV
+              if: ${{ env.EPV != 0 }}
+              run: composer require phpbb/epv:dev-master --dev --no-interaction --ignore-platform-reqs
+              working-directory: ./phpBB3/phpBB
+
+            - name: Run code sniffer
+              if: ${{ env.SNIFF != 0 }}
+              env:
+                  NOTESTS: '1'
+              run: .github/ext-sniff.sh $EXTNAME/$EXTNAME $NOTESTS
+              working-directory: ./phpBB3
+
+            - name: Check image ICC profiles
+              if: ${{ env.IMAGE_ICC != 0 }}
+              run: .github/check-image-icc-profiles.sh
+              working-directory: ./phpBB3
+
+            - name: Check executable files
+              if: ${{ env.EXECUTABLE_FILES != 0 }}
+              run: .github/ext-check-executable-files.sh ./ $EXTNAME/$EXTNAME
+              working-directory: ./phpBB3
+
+            - name: Run EPV
+              if: ${{ env.EPV != 0 }}
+              run: phpBB/vendor/bin/EPV.php run --dir="phpBB/ext/$EXTNAME/" --debug
+              working-directory: ./phpBB3
+    # END Basic Checks Job
diff --git a/README.md b/README.md
@@ -4,9 +4,8 @@ This Extension Lets Admin to control **phpBB Native Fulltext** Search Index .
 
 
 #### Status Badge for Reduce Search Index [RSI] on phpBB v3.3.x :   
-![Travis-CI](https://img.shields.io/badge/Travis-CI-8000FF.svg) : [![Build Status](https://travis-ci.com/dark-1/reducesearchindex.svg?branch=master)](https://travis-ci.com/dark-1/reducesearchindex)   
-![Scrutinizer-CI](https://img.shields.io/badge/Scrutinizer-CI-8000FF.svg) : [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/dark-1/reducesearchindex/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/dark-1/reducesearchindex/?branch=master) [![Build Status](https://scrutinizer-ci.com/g/dark-1/reducesearchindex/badges/build.png?b=master)](https://scrutinizer-ci.com/g/dark-1/reducesearchindex/build-status/master)   
 ![Actions-CI](https://img.shields.io/badge/Actions-CI-8000FF.svg) : [![Actions Status](https://github.com/dark-1/reducesearchindex/workflows/Actions%20CI/badge.svg)](https://github.com/dark-1/reducesearchindex/actions?workflow=Actions%20CI)   
+![Scrutinizer-CI](https://img.shields.io/badge/Scrutinizer-CI-8000FF.svg) : [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/dark-1/reducesearchindex/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/dark-1/reducesearchindex/?branch=master) [![Build Status](https://scrutinizer-ci.com/g/dark-1/reducesearchindex/badges/build.png?b=master)](https://scrutinizer-ci.com/g/dark-1/reducesearchindex/build-status/master)   
 ![Shields.IO](https://img.shields.io/badge/Shields-IO-8000FF.svg?style=flat-square) : [![GitHub release](https://img.shields.io/github/release/dark-1/reducesearchindex.svg?style=flat-square) ![license](https://img.shields.io/github/license/dark-1/reducesearchindex.svg?style=flat-square)](https://github.com/dark-1/reducesearchindex)   
 
 

diff --git a/acp/main_module.php b/acp/main_module.php
@@ -34,7 +34,7 @@ public function main($id, $mode)
 		$mode = strtolower($mode);
 
 		// check for valid Mode
-		if (class_exists('dark1\reducesearchindex\controller\acp_' . $mode))
+		if ($phpbb_container->has('dark1.reducesearchindex.controller.acp.' . $mode))
 		{
 			// Get ACP controller for Mode
 			$acp_controller = $phpbb_container->get('dark1.reducesearchindex.controller.acp.' . $mode);

diff --git a/controller/acp_base.php b/controller/acp_base.php
@@ -24,19 +24,19 @@
  */
 class acp_base
 {
-	/** @var \phpbb\language\language */
+	/** @var language */
 	protected $language;
 
-	/** @var \phpbb\log\log */
+	/** @var log */
 	protected $log;
 
-	/** @var \phpbb\request\request */
+	/** @var request */
 	protected $request;
 
-	/** @var \phpbb\template\template */
+	/** @var template */
 	protected $template;
 
-	/** @var \phpbb\user */
+	/** @var user */
 	protected $user;
 
 	/** @var string The module ID */
@@ -51,11 +51,11 @@ class acp_base
 	/**
 	 * Constructor.
 	 *
-	 * @param \phpbb\language\language				$language		Language object
-	 * @param \phpbb\log\log						$log			Log object
-	 * @param \phpbb\request\request				$request		Request object
-	 * @param \phpbb\template\template				$template		Template object
-	 * @param \phpbb\user							$user			User object
+	 * @param language		$language		Language object
+	 * @param log			$log			Log object
+	 * @param request		$request		Request object
+	 * @param template		$template		Template object
+	 * @param user			$user			User object
 	 */
 	public function __construct(language $language, log $log, request $request, template $template, user $user)
 	{

diff --git a/controller/acp_cron.php b/controller/acp_cron.php
@@ -27,29 +27,29 @@
  */
 class acp_cron extends acp_base
 {
-	/** @var \phpbb\config\config */
+	/** @var config */
 	protected $config;
 
-	/** @var \phpbb\cron\manager */
+	/** @var cron_manager */
 	protected $cron_manager;
 
 	/**
 	 * Constructor.
 	 *
-	 * @param \phpbb\language\language				$language		Language object
-	 * @param \phpbb\log\log						$log			Log object
-	 * @param \phpbb\request\request				$request		Request object
-	 * @param \phpbb\template\template				$template		Template object
-	 * @param \phpbb\user							$user			User object
-	 * @param \phpbb\config\config					$config			Config object
-	 * @param \phpbb\cron\manager					$cron_manager	Cron manager
+	 * @param language			$language		Language object
+	 * @param log				$log			Log object
+	 * @param request			$request		Request object
+	 * @param template			$template		Template object
+	 * @param user				$user			User object
+	 * @param config			$config			Config object
+	 * @param cron_manager		$cron_manager	Cron manager
 	 */
 	public function __construct(language $language, log $log, request $request, template $template, user $user, config $config, cron_manager $cron_manager)
 	{
 		parent::__construct($language, $log, $request, $template, $user);
 
-		$this->config		= $config;
-		$this->cron_manager	= $cron_manager;
+		$this->config			= $config;
+		$this->cron_manager		= $cron_manager;
 	}
 
 	/**

diff --git a/controller/acp_forum.php b/controller/acp_forum.php
@@ -27,27 +27,27 @@
  */
 class acp_forum extends acp_base
 {
-	/** @var \phpbb\db\driver\driver_interface */
+	/** @var db_driver */
 	protected $db;
 
-	/** @var \phpbb\cache\driver\driver_interface */
+	/** @var cache_driver */
 	protected $cache;
 
-	/** @var \dark1\reducesearchindex\core\forum_map_rsi */
+	/** @var forum_map_rsi */
 	protected $forum_map_rsi;
 
 	/**
 	 * Constructor.
 	 *
-	 * @param \phpbb\config\config							$config			Config object
-	 * @param \phpbb\language\language						$language		Language object
-	 * @param \phpbb\log\log								$log			Log object
-	 * @param \phpbb\request\request						$request		Request object
-	 * @param \phpbb\template\template						$template		Template object
-	 * @param \phpbb\user									$user			User object
-	 * @param \phpbb\db\driver\driver_interface				$db				Database object
-	 * @param \phpbb\cache\driver\driver_interface			$cache			Cache object
-	 * @param \dark1\reducesearchindex\core\forum_map_rsi	$forum_map_rsi	Forum Map RSI
+	 * @param config			$config			Config object
+	 * @param language			$language		Language object
+	 * @param log				$log			Log object
+	 * @param request			$request		Request object
+	 * @param template			$template		Template object
+	 * @param user				$user			User object
+	 * @param db_driver			$db				Database object
+	 * @param cache_driver		$cache			Cache object
+	 * @param forum_map_rsi		$forum_map_rsi	Forum Map RSI
 	 */
 	public function __construct(language $language, log $log, request $request, template $template, user $user, db_driver $db, cache_driver $cache, forum_map_rsi $forum_map_rsi)
 	{

diff --git a/controller/acp_main.php b/controller/acp_main.php
@@ -26,24 +26,24 @@
  */
 class acp_main extends acp_base
 {
-	/** @var \phpbb\config\config */
+	/** @var config */
 	protected $config;
 
 	/**
 	 * Constructor.
 	 *
-	 * @param \phpbb\language\language				$language		Language object
-	 * @param \phpbb\log\log						$log			Log object
-	 * @param \phpbb\request\request				$request		Request object
-	 * @param \phpbb\template\template				$template		Template object
-	 * @param \phpbb\user							$user			User object
-	 * @param \phpbb\config\config					$config			Config object
+	 * @param language		$language	Language object
+	 * @param log			$log		Log object
+	 * @param request		$request	Request object
+	 * @param template		$template	Template object
+	 * @param user			$user		User object
+	 * @param config		$config		Config object
 	 */
 	public function __construct(language $language, log $log, request $request, template $template, user $user, config $config)
 	{
 		parent::__construct($language, $log, $request, $template, $user);
 
-		$this->config		= $config;
+		$this->config	= $config;
 	}
 
 	/**

diff --git a/core/forum_map.php b/core/forum_map.php
@@ -29,7 +29,7 @@ abstract class forum_map
 	/** @var string Default Padding Symbol */
 	const PADDING_SYMBOL	= '&nbsp; &#8627; &nbsp;';
 
-	/** @var \phpbb\db\driver\driver_interface */
+	/** @var db_driver */
 	protected $db;
 
 	/** @var int Latest Right ID*/
@@ -56,7 +56,7 @@ abstract class forum_map
 	/**
 	 * Constructor.
 	 *
-	 * @param \phpbb\db\driver\driver_interface		$db		Database object
+	 * @param db_driver		$db		Database object
 	 */
 	public function __construct(db_driver $db)
 	{