Merge pull request #26 from andrey18106/dev

MediaDC v0.1.7

.github/ISSUE_TEMPLATE/bug_report.md

@@ -20,7 +20,8 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
+ - OS [e.g. iOS]
+ - CPU (architecture)
  - Browser [e.g. chrome, safari]
  - Nextcloud version [e.g. 22]
  - Database configuration (without sensitive information)
@@ -29,7 +30,7 @@ If applicable, add screenshots to help explain your problem.
 
 **Smartphone (please complete the following information):**
  - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
+ - OS: [e.g. iOS 8.1]
  - Browser [e.g. stock browser, safari]
  - Nextcloud version [e.g. 22]
  - MediaDC version [e.g. 0.1.0]

.github/workflows/static-analysis.yml

@@ -2,7 +2,7 @@ name: Static analysis
 
 on:
   pull_request:
-    branches: [main, test, dev]
+    branches: [main, dev]
     types: [opened, reopened, edited]
   push:
     branches: [dev]
@@ -37,7 +37,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-versions: [7.4, 8.0]
+        php-versions: [7.3, 7.4, 8.0]
     steps:
     - uses: actions/checkout@v2
 

CHANGELOG.md

@@ -2,6 +2,22 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.1.7 - 2021-10-30]
+
+### Added
+
+- Added php `exec` function availability check
+
+### Changed
+
+- Changed missed PHP version requirement from 7.4 to 7.3
+- Moved MediaDC admin settings from Groupware tab to separate Administrator menu item
+- Changed server errors messages and moved them to the Congiguration page
+
+### Fixed
+
+- Fixed Python version validation fails
+
 ## [0.1.6 - 2021-10-22]
 
 ### Added

README.md

@@ -3,6 +3,9 @@
 ![build](https://github.com/andrey18106/mediadc/actions/workflows/create-release-draft.yml/badge.svg)
 ![static-analysis](https://github.com/andrey18106/mediadc/actions/workflows/static-analysis.yml/badge.svg)
 
+[![Github All Releases](https://img.shields.io/github/downloads/andrey18106/mediadc/total.svg)](https://github.com/andrey18106/mediadc/releases)
+
+
 **📸📹 Collect photo and video duplicates to save your cloud storage space**
 
 ![Home page](/screenshots/task-managment.png)

appinfo/info.xml

@@ -6,6 +6,9 @@
 	<summary>Nextcloud Media Duplicate Collector application</summary>
 	<description>
 	<![CDATA[
+
+**Python 3.6.8 or higher required**
+
 This app allows to find duplicate or similar 📸📹 photos and videos
 * **Many image formats supported** Jpeg, png, tiff, bmp, gif, heic/hif, cr2 and others.
 * **Large amount of supported video  formats** All that is supported by ffmpeg.
@@ -17,7 +20,7 @@ This app allows to find duplicate or similar 📸📹 photos and videos
 Quick start guide and further information in our [Wiki](https://github.com/andrey18106/mediadc/wiki).
 	]]>
 	</description>
-	<version>0.1.6</version>
+	<version>0.1.7</version>
 	<licence>agpl</licence>
 	<author mail="[email protected]" homepage="https://github.com/andrey18106">Andrey Borysenko</author>
 	<author mail="[email protected]" homepage="https://github.com/bigcat88">Alexander Piskun</author>
@@ -36,11 +39,11 @@ Quick start guide and further information in our [Wiki](https://github.com/andre
 	<screenshot>https://raw.githubusercontent.com/andrey18106/mediadc/main/screenshots/admin-config.png</screenshot>
 	<dependencies>
 		<nextcloud min-version="21" max-version="22" />
-		<php min-version="7.4" />
-		<python min-version="3.6.8" />
+		<php min-version="7.3" />
 	</dependencies>
 	<settings>
 		<admin>OCA\MediaDC\Settings\AdminSettings</admin>
+		<admin-section>OCA\MediaDC\Settings\AdminSection</admin-section>
 	</settings>
 	<repair-steps>
 		<install>

appinfo/routes.php

@@ -1,6 +1,7 @@
 <?php
 /**
  * @copyright 2021 Andrey Borysenko <[email protected]>
+ * 
  * @copyright 2021 Alexander Piskun <[email protected]>
  *
  * @author Andrey Borysenko <[email protected]>

js/mediadc-main.js.LICENSE.txt

@@ -41,7 +41,7 @@
  */
 
 /*!
-  * vue-router v3.5.2
+  * vue-router v3.5.3
   * (c) 2021 Evan You
   * @license MIT
   */

lib/Service/PythonService.php

@@ -31,8 +31,10 @@
 use OCA\MediaDC\AppInfo\Application;
 use OCA\MediaDC\Db\Setting;
 use OCA\MediaDC\Db\SettingMapper;
-use OCA\MediaDC\Exception\PythonNotValidException;
+
 use OCP\IConfig;
+use Psr\Log\LoggerInterface;
+use bantu\IniGetWrapper\IniGetWrapper;
 
 
 class PythonService {
@@ -46,16 +48,17 @@ class PythonService {
 	/** @var IConfig */
 	private $config;
 
-	public function __construct(SettingMapper $settingMapper, IConfig $config)
+	/** @var LoggerInterface */
+	private $logger;
+
+	public function __construct(SettingMapper $settingMapper, IConfig $config, LoggerInterface $logger)
 	{
 		$this->config = $config;
+		$this->logger = $logger;
 		/** @var Setting */
 		$pythonCommand = $settingMapper->findByName('python_command');
 		$this->pythonCommand = $pythonCommand->getValue();
 		$this->cwd = $this->getCustomAppsDirectory() . Application::APP_ID . '/lib/Service/python';
-		if (!$this->isPythonCompatible()) {
-			throw new PythonNotValidException("Python version is lower then 3.6.8 or not available");
-		}
 	}
 
 	/**
@@ -119,38 +122,62 @@ static function scriptEnvsCallback($key, $value) {
 		return "$key=\"$value\" ";
 	}
 
+	/**
+	 * Check server requirements
+	 * 
+	 * @return array check results with errors list
+	 */
+	private function checkDepsRequirements() {
+		$errors = [];
+		if (!$this->isFunctionEnabled('exec')) {
+			array_push($errors, '`exec` PHP function is not available.');
+		}
+		if (!$this->isPythonCompatible()) {
+			array_push($errors, 'Python version is lower then 3.6.8 or not available');
+		}
+		return ['success' => count($errors) === 0, 'errors' => $errors];
+	}
+
 	/**
 	 * @param string @listName
 	 * 
 	 * @return array installation results list
 	 */
 	public function installDependencies($listName = '') {
-		try {
-			$pythonResult = $this->run('/install.py', [
-				'--install' => $listName === '' ? 'required optional' : $listName,
-			], false, ['PHP_PATH' => $this->getPhpInterpreter()]);
-			return $this->parsePythonOutput($pythonResult);
-		} catch (\Exception $e) {
-			return [
-				'success' => false,
-				'message' => 'Some error while running the Python script',
-			];
+		$depsCheck = $this->checkDepsRequirements();
+		if ($depsCheck['success']) {
+			try {
+				$pythonResult = $this->run('/install.py', [
+					'--install' => $listName === '' ? 'required optional' : $listName,
+				], false, ['PHP_PATH' => $this->getPhpInterpreter()]);
+				return $this->parsePythonOutput($pythonResult);
+			} catch (\Exception $e) {
+				return [
+					'success' => false,
+					'message' => 'Some error while running the Python script',
+				];
+			}
 		}
+		return $depsCheck;
 	}
 
 	/**
 	 * @return array list of uninstalled Python packages
 	 */
 	public function checkInstallation() {
-		try {
-			$pythonResult = $this->run('/install.py', ['--check' => ''], false, ['PHP_PATH' => $this->getPhpInterpreter()]);
-			return $this->parsePythonOutput($pythonResult);
-		} catch (\Exception $e) {
-			return [
-				'success' => false,
-				'message' => 'Some error while running the Python script',
-			];
+		$depsCheck = $this->checkDepsRequirements();
+		if ($depsCheck['success']) {
+			try {
+				$pythonResult = $this->run('/install.py', ['--check' => ''], false, ['PHP_PATH' => $this->getPhpInterpreter()]);
+				return $this->parsePythonOutput($pythonResult);
+			} catch (\Exception $e) {
+				return [
+					'success' => false,
+					'message' => 'Some error while running the Python script',
+				];
+			}
 		}
+		return $depsCheck;
 	}
 
 	/**
@@ -159,15 +186,19 @@ public function checkInstallation() {
 	 * @return array installed packages list after deleting
 	 */
 	public function deleteDependencies($packagesList = []) {
-		try {
-			$pythonResult = $this->run('/install.py', ['--delete' => join(" ", $packagesList)], false, ['PHP_PATH' => $this->getPhpInterpreter()]);
-			return $this->parsePythonOutput($pythonResult);
-		} catch (\Exception $e) {
-			return [
-				'success' => false,
-				'message' => 'Some error while running the Python script',
-			];
+		$depsCheck = $this->checkDepsRequirements();
+		if ($depsCheck['success']) {
+			try {
+				$pythonResult = $this->run('/install.py', ['--delete' => join(" ", $packagesList)], false, ['PHP_PATH' => $this->getPhpInterpreter()]);
+				return $this->parsePythonOutput($pythonResult);
+			} catch (\Exception $e) {
+				return [
+					'success' => false,
+					'message' => 'Some error while running the Python script',
+				];
+			}
 		}
+		return $depsCheck;
 	}
 
 	/**
@@ -176,27 +207,31 @@ public function deleteDependencies($packagesList = []) {
 	 * @return array installed packages list after deleting
 	 */
 	public function updateDependencies($packagesList = []) {
-		try {
-			$pythonResult = $this->run('/install.py', ['--update' => join(" ", $packagesList)], false, ['PHP_PATH' => $this->getPhpInterpreter()]);
-			return $this->parsePythonOutput($pythonResult);
-		} catch (\Exception $e) {
-			return [
-				'success' => false,
-				'message' => 'Some error while running the Python script',
-			];
+		$depsCheck = $this->checkDepsRequirements();
+		if ($depsCheck['success']) {
+			try {
+				$pythonResult = $this->run('/install.py', ['--update' => join(" ", $packagesList)], false, ['PHP_PATH' => $this->getPhpInterpreter()]);
+				return $this->parsePythonOutput($pythonResult);
+			} catch (\Exception $e) {
+				return [
+					'success' => false,
+					'message' => 'Some error while running the Python script',
+				];
+			}
 		}
+		return $depsCheck;
 	}
 
 	/**
 	 * @return string|null
 	 */
 	public function getPythonVersion() {
-		exec($this->pythonCommand . ' --version', $output);
-		if (preg_match_all("/\d{1}\.\d{1,2}(\.\d{1,2}){0,1}/s", $output[0], $matches)) {
-			return $matches[0][0];
-		} else {
-			return null;
+		exec($this->pythonCommand . ' --version', $output, $result_code);
+		if ($result_code === 0 && isset($output[0]) && preg_match_all("/\d{1}\.\d{1,2}(\.\d{1,2}){0,1}/s", $output[0], $matches)) {
+			return isset($matches[0][0]) ? $matches[0][0] : null;
 		}
+		$this->logger->error('[' . self::class . '] Command executed with error result_code: ' . $result_code);
+		return null;
 	}
 
 	/**
@@ -345,4 +380,30 @@ private function getCustomAppsDirectory() {
 		return getcwd() . '/apps/';
 	}
 
+	/**
+	 * Check if a php function available
+	 * 
+	 * @param string $function_name
+	 * 
+	 * @return bool
+	 */
+	private function isFunctionEnabled($function_name) {
+		if (!function_exists($function_name)) {
+			return false;
+		}
+		/** @var IniGetWrapper $ini */
+		$ini = \OC::$server->get(IniGetWrapper::class);
+		$disabled = explode(',', $ini->get('disable_functions') ?: '');
+		$disabled = array_map('trim', $disabled);
+		if (in_array($function_name, $disabled)) {
+			return false;
+		}
+		$disabled = explode(',', $ini->get('suhosin.executor.func.blacklist') ?: '');
+		$disabled = array_map('trim', $disabled);
+		if (in_array($function_name, $disabled)) {
+			return false;
+		}
+		return true;
+	}
+
 }

lib/Exception/PythonNotValidException.php → lib/Settings/AdminSection.php

@@ -26,10 +26,43 @@
  *
  */
 
-namespace OCA\MediaDC\Exception;
+namespace OCA\MediaDC\Settings;
 
-use Exception;
+use OC\URLGenerator;
+use OCA\MediaDC\AppInfo\Application;
+use OCP\IL10N;
+use OCP\Settings\IIconSection;
 
 
-class PythonNotValidException extends Exception {
+class AdminSection implements IIconSection {
+
+	/** @var IL10N */
+	private $l;
+
+	/** @var UrlGenerator */
+	private $urlGenerator;
+
+	public function __construct(IL10N $l, URLGenerator $urlGenerator)
+	{
+		$this->l = $l;
+		$this->urlGenerator = $urlGenerator;
+	}
+
+	public function getId() {
+		return Application::APP_ID;
+	}
+
+	public function getName() {
+		return $this->l->t('MediaDC');
+	}
+
+	public function getPriority()
+	{
+		return 50;
+	}
+
+	public function getIcon() {
+		return $this->urlGenerator->imagePath(Application::APP_ID, 'settings.svg');
+	}
+
 }