Merge pull request #14 from andrey18106/dev

MediaDC v0.1.3

Author: bigcat88

.github/ISSUE_TEMPLATE/bug_report.md

@@ -23,6 +23,8 @@ If applicable, add screenshots to help explain your problem.
  - OS: [e.g. iOS]
  - Browser [e.g. chrome, safari]
  - Nextcloud version [e.g. 22]
+ - Database configuration (without sensitive information)
+ - Python version [e.g. 3.9.1]
  - MediaDC version [e.g. 0.1.0]
 
 **Smartphone (please complete the following information):**

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.1.3 - 2021-10-04]
+
+### Fixed
+
+- Now properly parse configs for database connect.
+
 ## [0.1.2 - 2021-09-30]
 
 ### Added

appinfo/info.xml

@@ -17,7 +17,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.2</version>
+	<version>0.1.3</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,6 +36,7 @@ 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" />
 	</dependencies>
 	<settings>

lib/Service/python/db/connectors.py

@@ -28,7 +28,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
-def create_connection(config: dict, provider: str, error_out: list):
+def create_connection(config: dict, provider: str, error_out: list = None):
     connection = None
     try:
         if provider == 'pymysql':
@@ -41,7 +41,8 @@ def create_connection(config: dict, provider: str, error_out: list):
                                              charset='utf8mb4')
             else:
                 port = int(config['dbport']) if len(config['dbport']) else 3306
-                connection = pymysql.connect(host=config['dbhost'],
+                host = config['dbhost'] if len(config['dbhost']) else "localhost"
+                connection = pymysql.connect(host=host,
                                              port=port,
                                              user=config['dbuser'],
                                              password=config['dbpassword'],
@@ -56,7 +57,8 @@ def create_connection(config: dict, provider: str, error_out: list):
                                            database=config['dbname'])
             else:
                 port = int(config['dbport']) if len(config['dbport']) else 5432
-                connection = dbapi.connect(host=config['dbhost'],
+                host = config['dbhost'] if len(config['dbhost']) else "localhost"
+                connection = dbapi.connect(host=host,
                                            port=port,
                                            user=config['dbuser'],
                                            password=config['dbpassword'],
@@ -81,3 +83,18 @@ def internal_handle_db_connect_exception(exception_info, error_out: list = None)
         time.sleep(0.5)
     else:
         raise exception_info from None
+
+
+def test_connection(config: dict, provider: str, print_errors: bool = False) -> bool:
+    errors_list = []
+    try:
+        connection = create_connection(config, provider, errors_list)
+        if connection is not None:
+            connection.close()
+            return True
+    except Exception as exception_info:
+        if print_errors:
+            print(exception_info)
+    if print_errors:
+        print(errors_list)
+    return False

lib/Service/python/db/manager.py

@@ -8,7 +8,7 @@
 import os
 import re
 from . import occ_cloud
-from .connectors import create_connection, internal_handle_db_connect_exception
+from .connectors import create_connection, internal_handle_db_connect_exception, test_connection
 
 
 # @copyright Copyright (c) 2021 Andrey Borysenko <[email protected]>
@@ -61,52 +61,111 @@ def init_cloud_config(map_schema: dict) -> bool:
     return result
 
 
-def detect_msql_socket(config: dict, _php_info: str) -> None:
-    global Warnings
-    socket_path = config['dbhost'].split(":")[-1]
-    if os.path.exists(socket_path):
-        config['usock'] = socket_path
+def get_basic_db_provider(dbtype: str) -> str:
+    if dbtype == 'mysql':
+        return 'pymysql'
+    if dbtype == 'pgsql':
+        return 'pg8000'
+    return ''
+
+
+def check_db_config(config: dict) -> None:
+    """Finding way to connect to database."""
+    if test_connection(config, get_basic_db_provider(config['dbtype'])):
         return
-    if not config['dbport'] and _php_info:
-        m_groups = re.search(r'pdo_mysql\.default_socket\s*=>\s*(.*)\s*=>\s*(.*)',
-                             _php_info, flags=re.MULTILINE + re.IGNORECASE)
-        if m_groups is None:
-            Warnings.append("Cant parse php info.")
+    # lets try without socket.
+    if config['usock']:
+        usock = config['usock']
+        config['usock'] = ''
+        if test_connection(config, get_basic_db_provider(config['dbtype'])):
             return
-        socket_path = m_groups.groups()[-1].strip()
-        if os.path.exists(socket_path):
-            config['usock'] = socket_path
+        config['usock'] = usock
 
 
-def detect_pgsql_socket(config: dict, _php_info: str) -> None:
-    socket_path = config['dbhost'].split(":")[-1]
-    if os.path.exists(socket_path):
-        config['usock'] = socket_path
+def postprocess_config(config: dict) -> None:
+    """Parses 'dbhost' value. Possible values: host:port, host:socket, host, socket, nil"""
+    global Warnings
+    host_port_socket = config['dbhost'].split(":", maxsplit=1)
+    if len(host_port_socket) > 1:
+        # when dbhost = host:port or host:socket
+        config['dbhost'] = host_port_socket[0]
+        if os.path.exists(host_port_socket[1]):
+            config['usock'] = host_port_socket[1]
+        elif host_port_socket[1].isdigit():
+            config['dbport'] = host_port_socket[1]
+        else:
+            Warnings.append("Unknown socket or port value.")
+    elif os.path.exists(config['dbhost']):
+        # when dbhost = socket
+        config['usock'] = config['dbhost']
+        config['dbhost'] = ''
+    if config['dbtype'] == 'pgsql':
+        # Don't know currently how to handle this situation properly. Using default port value for socket name.
+        if config['usock']:
+            config['usock'] += '.s.PGSQL.5432'
+
+
+def find_db_configuration() -> bool:
+    """Finding working way to connect to database, if will found global `Config` will be changed according to it."""
+    global Warnings, Config
+    # Trying what we parsed from cloud config.
+    if test_connection(Config, get_basic_db_provider(Config['dbtype'])):
+        return True
+    # Trying without socket.
+    if Config['usock']:
+        usock = Config['usock']
+        Config['usock'] = ''
+        if test_connection(Config, get_basic_db_provider(Config['dbtype'])):
+            return True
+        Config['usock'] = usock
+    if Config['dbtype'] == 'mysql':
+        # when no dbport or usock found in cloud config, trying php socket configuration.
+        php_ok, php_info = occ_cloud.php_call('-r', "phpinfo();")
+        if not php_ok:
+            Warnings.append("Cant get php info.")
+        else:
+            m_groups = re.search(r'pdo_mysql\.default_socket\s*=>\s*(.*)\s*=>\s*(.*)',
+                                 php_info, flags=re.MULTILINE + re.IGNORECASE)
+            if m_groups is None:
+                Warnings.append("Cant parse php info.")
+            else:
+                socket_path = m_groups.groups()[-1].strip()
+                if os.path.exists(socket_path):
+                    usock = Config['usock']
+                    Config['usock'] = socket_path
+                    if test_connection(Config, get_basic_db_provider(Config['dbtype'])):
+                        return True
+                    Config['usock'] = usock
+    # If we got here then all is not so good, as it can be. Last try with default host and port.
+    host = Config['dbhost']
+    port = Config['dbport']
+    Config['dbhost'] = ''
+    Config['dbport'] = ''
+    if test_connection(Config, get_basic_db_provider(Config['dbtype'])):
+        return True
+    Config['dbhost'] = host
+    Config['dbport'] = port
+    return False
 
 
 def init():
-    global Config, DatabaseProvider, Warnings
+    global Config, DatabaseProvider
     map_schema = {'datadir': 'datadirectory',
                   'dbname': 'dbname',
                   'dbtprefix': 'dbtableprefix',
                   'dbuser': 'dbuser',
                   'dbpassword': 'dbpassword',
                   'dbhost': 'dbhost',
-                  'dbport': 'dbport',
                   'dbtype': 'dbtype'}
     Config['usock'] = ''
+    Config['dbport'] = ''
     if not init_cloud_config(map_schema):
         return DbType.UNKNOWN
-    php_ok, php_info = occ_cloud.php_call('-r', "phpinfo();")
-    if not php_ok:
-        php_info = ''
-        Warnings.append("Cant get php info.")
+    postprocess_config(Config)
     if Config['dbtype'] == 'mysql':
-        detect_msql_socket(Config, php_info)
         DatabaseProvider = 'pymysql'
         return DbType.MYSQL
     if Config['dbtype'] == 'pgsql':
-        detect_pgsql_socket(Config, php_info)
         DatabaseProvider = 'pg8000'
         return DbType.PGSQL
     if Config['dbtype'] == 'oci':
@@ -238,6 +297,7 @@ def check_db() -> list:
         return Errors
     if not DatabaseProvider:
         return [f"Unsupported DB type:`{Config['dbtype']}`"]
+    find_db_configuration()
     ret = []
     success = False
     try:

lib/Service/python/install.py

@@ -354,6 +354,7 @@ def check() -> dict:
         if not ret['required']:
             log_error(*db.check_db())
             ret['errors'] = ErrorsContainer
+            ret['warnings'] = db.get_warnings()
     return ret
 
 

package-lock.json

@@ -1,7 +1,7 @@
 {
 	"name": "mediadc",
 	"description": "Collect photo and video duplicates to save your cloud storage",
-	"version": "0.1.2",
+	"version": "0.1.3",
 	"author": "Andrey Borysenko <[email protected]>",
 	"contributors": [
 		"Andrey Borysenko <[email protected]>",