hiddifypanel 9.0.0.dev60__py3-none-any.whl → 9.0.0.dev61__py3-none-any.whl

hiddifypanel/VERSION

@@ -1 +1 @@
-9.0.0.dev60
+9.0.0.dev61

hiddifypanel/VERSION.py

@@ -1,3 +1,3 @@
-__version__='9.0.0.dev60'
+__version__='9.0.0.dev61'
 from datetime import datetime
-__release_date__= datetime.strptime('2024-01-21','%Y-%m-%d')
+__release_date__= datetime.strptime('2024-01-25','%Y-%m-%d')

hiddifypanel/base.py

@@ -12,6 +12,7 @@ from hiddifypanel.panel import hiddify
 from apiflask import APIFlask
 from werkzeug.middleware.proxy_fix import ProxyFix
 from hiddifypanel.models import *
+from hiddifypanel import hutils
 from hiddifypanel.panel.init_db import init_db
 from hiddifypanel.cache import redis_client
 
@@ -60,7 +61,7 @@ def create_app(cli=False, **config):
     Session(app)
 
     app.jinja_env.line_statement_prefix = '%'
-    app.jinja_env.filters['b64encode'] = hiddify.do_base_64
+    app.jinja_env.filters['b64encode'] = hutils.encode.do_base_64
     app.view_functions['admin.static'] = {}  # fix bug in apiflask
     app.is_cli = cli
     flask_bootstrap.Bootstrap4(app)
@@ -89,9 +90,9 @@ def create_app(cli=False, **config):
         # user profile, cookie, session, etc.
         from hiddifypanel.models import ConfigEnum, hconfig
         if "admin" in request.base_url:
-            g.locale = hconfig(ConfigEnum.admin_lang) or hconfig(ConfigEnum.lang) or 'fa'
+            g.locale = g.account.lang or hconfig(ConfigEnum.admin_lang) or 'fa'
         else:
-            g.locale = g.account.lang if isinstance(g.get('account'), User) and g.account.lang else hconfig(ConfigEnum.lang) or 'fa'
+            g.locale = g.account.lang or hconfig(ConfigEnum.lang) or 'fa'
         return g.locale
 
     from flask_wtf.csrf import CSRFProtect
@@ -119,7 +120,7 @@ def create_app(cli=False, **config):
 
     app.jinja_env.globals['get_locale'] = get_locale
     app.jinja_env.globals['version'] = hiddifypanel.__version__
-    app.jinja_env.globals['static_url_for'] = hiddify.static_url_for
+    app.jinja_env.globals['static_url_for'] = hutils.flask.static_url_for
 
     return app
 

hiddifypanel/hutils/__init__.py

@@ -1,3 +1,10 @@
 from . import ip
 from . import utils
-from . import auto_ip_selector
+from . import auto_ip_selector
+from . import json
+from . import auth
+from . import encode
+from . import random
+from . import convert
+from . import flask
+from . import github_issue

hiddifypanel/hutils/auth.py

@@ -0,0 +1,94 @@
+import base64
+from typing import Tuple, Any
+from uuid import UUID
+
+
+def is_uuid_valid(uuid, version):
+    try:
+        uuid_obj = UUID(uuid, version=version)
+    except ValueError:
+        return False
+    return str(uuid_obj) == uuid
+
+
+def get_uuid_from_url_path(path: str, section_index: int = 2) -> str | None:
+    """
+    Takes a URL path and extracts the UUID at the specified section index.
+
+    Args:
+        path (str): The URL path from which to extract the UUID.
+        section_index (int, optional): The index of the section in the URL path where the UUID is located. Defaults to 2, because in past the UUID was in the second section of path of url.
+
+    Returns:
+        str | None: The extracted UUID as a string if found, or None if not found.
+    """
+    s_index = 1
+    for section in path.lstrip('/').split('/'):
+        if is_uuid_valid(section, 4):
+            if s_index == section_index:
+                return section
+        s_index += 1
+    return None
+
+
+def get_apikey_from_auth_header(auth_header: str) -> str | None:
+    if auth_header.startswith('ApiKey'):
+        return auth_header.split('ApiKey ')[1].strip()
+    return None
+
+
+def parse_login_id(raw_id: str) -> Tuple[Any | None, str | None]:
+    """
+    Parses the given raw ID to extract the account type and ID.
+    Args:
+        raw_id (str): The raw ID to be parsed.
+    Returns:
+        Tuple[Any | None, str | None]: A tuple containing the account type and ID.
+            The account type is either AccountType.admin or AccountType.user
+            and the ID is a string. If the raw ID cannot be parsed, None is returned
+            for both the account type and ID.
+    """
+    splitted = raw_id.split('_')
+    if len(splitted) < 2:
+        return None, None
+    admin_or_user, id = splitted
+    from hiddifypanel.models.role import AccountType
+    account_type = AccountType.admin if admin_or_user == 'admin' else AccountType.user
+    if not id or not account_type:
+        return None, None
+    return account_type, id
+
+
+def add_basic_auth_to_url(url: str, username: str, password: str) -> str:
+    if 'https://' in url:
+        return url.replace('https://', f'https://{username}:{password}@')
+    elif 'http://' in url:
+        return url.replace('http://', f'http://{username}:{password}@')
+    else:
+        return url
+
+# region unused(never mentioned in codebase)
+
+
+# def is_uuid_in_url_path(path: str) -> bool:
+#     for section in path.split('/'):
+#         if is_uuid_valid(section, 4):
+#             return True
+#     return False
+
+
+# def get_basic_auth_from_auth_header(auth_header: str) -> str | None:
+#     if auth_header.startswith('Basic'):
+#         return auth_header.split('Basic ')[1].strip()
+#     return None
+
+
+# def parse_basic_auth_header(auth_header: str) -> tuple[str, str] | None:
+#     if not auth_header.startswith('Basic'):
+#         return None
+#     header_value = auth_header.split('Basic ')
+#     if len(header_value) < 2:
+#         return None
+#     username, password = map(lambda item: item.strip(), base64.urlsafe_b64decode(header_value[1].strip()).decode('utf-8').split(':'))
+#     return (username, password) if username and password else None
+# endregion

hiddifypanel/hutils/auto_ip_selector.py

@@ -128,7 +128,7 @@ def get_host_base_on_asn(ips, asn_short):
     valid_hosts = [ip for ip in ips if len(ip) > 5]
 
     if len(ips) % 2 != 0 or len(valid_hosts) == 0:
-        flash(_("Error! auto cdn ip can not be find, please contact admin."))
+        hutils.flask.flash(_("Error! auto cdn ip can not be find, please contact admin."))
         if len(valid_hosts) == 0:
             return
 

hiddifypanel/hutils/convert.py

@@ -0,0 +1,14 @@
+def is_int(input: str) -> bool:
+    try:
+        int(input)
+        return True
+    except:
+        return False
+
+
+def to_int(s: str) -> int:
+    '''Returns 0 if <s> is not a number'''
+    try:
+        return int(s)
+    except:
+        return 0

hiddifypanel/hutils/encode.py

@@ -0,0 +1,11 @@
+import urllib.parse
+import base64
+
+
+def url_encode(strr):
+    return urllib.parse.quote(strr)
+
+
+def do_base_64(str):
+    resp = base64.b64encode(f'{str}'.encode("utf-8"))
+    return resp.decode()

hiddifypanel/hutils/flask.py

@@ -0,0 +1,24 @@
+
+from flask import flash as flask_flash
+from flask import url_for, Markup  # type: ignore
+from flask_babelex import lazy_gettext as _
+
+
+def flash(message: str, category: str = "message"):
+    # print(message)
+    return flask_flash(Markup(message), category)
+
+
+def flash_config_success(restart_mode='', domain_changed=True):
+    if restart_mode:
+        url = url_for('admin.Actions:reinstall', complete_install=restart_mode == 'reinstall', domain_changed=domain_changed)
+        apply_btn = f"<a href='{url}' class='btn btn-primary form_post'>" + \
+            _("admin.config.apply_configs")+"</a>"
+        flash((_('config.validation-success', link=apply_btn)), 'success')  # type: ignore
+    else:
+        flash((_('config.validation-success-no-reset')), 'success')  # type: ignore
+
+
+def static_url_for(**values):
+    orig = url_for("static", **values)
+    return orig.split("user_secret")[0]

hiddifypanel/{panel/github_issue_generator.py → hutils/github_issue.py}

@@ -1,27 +1,32 @@
-from json import dumps
-
 try:
-    from urllib import urlencode, unquote
-    from urlparse import urlparse, parse_qsl, ParseResult
+    from urllib import urlencode, unquote  # type: ignore
+    from urlparse import urlparse, parse_qsl, ParseResult  # type: ignore
 except ImportError:
     # Python 3 fallback
     from urllib.parse import (
         urlencode, unquote, urlparse, parse_qsl, ParseResult
     )
+import webbrowser
+from sys import version as python_version
+from platform import platform
+from json import dumps
+from flask import g, request, render_template
 
+import hiddifypanel
+from hiddifypanel.models.config import hconfig
+from hiddifypanel.models.config_enum import ConfigEnum
 
-import webbrowser
 
-class IssueUrl:
+class __IssueUrl:
     def __init__(self, options):
-        
+
         repoUrl = None
-        
+
         self.opts = options
 
         if "repoUrl" in self.opts:
             repoUrl = self.opts["repoUrl"]
-            
+
             try:
                 del self.opts["user"]
                 del self.opts["repo"]
@@ -29,7 +34,7 @@ class IssueUrl:
                 pass
 
         elif "user" in self.opts and "repo" in options:
-            
+
             try:
                 del self.opts["repoUrl"]
             except:
@@ -89,7 +94,7 @@ class IssueUrl:
         return new_url
 
     def get_url(self):
-        
+
         url = self.url
 
         for type in self.types:
@@ -107,10 +112,95 @@ class IssueUrl:
                 value = ",".join(map(str, value))
                 self.opts[type] = value
 
-            
         self.url = self.add_url_params(url, self.opts)
-        
+
         return self.url
 
     def opn(self):
-        webbrowser.open(self.get_url(), 1)
+        webbrowser.open(self.get_url(), 1)
+
+# region private functions
+
+
+def __generate_github_issue_link(title, issue_body):
+    opts = {
+        "user": 'hiddify',
+        "repo": 'Hiddify-Manager',
+        "title": title,
+        "body": issue_body,
+    }
+    issue_link = str(__IssueUrl(opts).get_url())
+    return issue_link
+
+
+def __github_issue_details():
+    details = {
+        'hiddify_version': f'{hiddifypanel.__version__}',
+        'python_version': f'{python_version}',
+        'os_details': f'{platform()}',
+        'user_agent': request.user_agent
+    }
+    return details
+
+
+def __remove_sensetive_data_from_github_issue_link(issue_link):
+    if g.account.uuid:
+        issue_link.replace(f'{g.account.uuid}', '*******************')
+
+    issue_link.replace(request.host, '**********')
+    issue_link.replace(hconfig(ConfigEnum.proxy_path), '**********')
+    issue_link.replace(hconfig(ConfigEnum.proxy_path_admin), '**********')
+    issue_link.replace(hconfig(ConfigEnum.proxy_path_client), '**********')
+
+
+def __remove_unrelated_traceback_details(stacktrace: str):
+    lines = stacktrace.splitlines()
+    if len(lines) < 1:
+        return ""
+
+    output = ''
+    skip_next_line = False
+    for i, line in enumerate(lines):
+        if i == 0:
+            output += line + '\n'
+            continue
+        if skip_next_line == True:
+            skip_next_line = False
+            continue
+        if line.strip().startswith('File'):
+            if 'hiddify' in line.lower():
+                output += line + '\n'
+                if len(lines) > i+1:
+                    output += lines[i + 1] + '\n'
+            skip_next_line = True
+
+    return output
+
+# endregion
+
+
+def generate_github_issue_link_for_500_error(error, traceback, remove_sensetive_data=True, remove_unrelated_traceback_datails=True):
+
+    if remove_unrelated_traceback_datails:
+        traceback = __remove_unrelated_traceback_details(traceback)
+
+    issue_details = __github_issue_details()
+
+    issue_body = render_template('github_issue_body.j2', issue_details=issue_details, error=error, traceback=traceback)
+
+    # Create github issue link
+    issue_link = __generate_github_issue_link(f"Internal server error: {error.name if hasattr(error,'name') and error.name != None and error.name else 'Unknown'}", issue_body)
+
+    if remove_sensetive_data:
+        __remove_sensetive_data_from_github_issue_link(issue_link)
+
+    return issue_link
+
+
+def generate_github_issue_link_for_admin_sidebar():
+
+    issue_body = render_template('github_issue_body.j2', issue_details=__github_issue_details())
+
+    # Create github issue link
+    issue_link = __generate_github_issue_link('Please fill the title properly', issue_body)
+    return issue_link

hiddifypanel/hutils/json.py

@@ -0,0 +1,24 @@
+from datetime import datetime
+
+
+def date_to_json(d):
+    return d.strftime("%Y-%m-%d") if d else None
+
+
+def json_to_date(date_str):
+    try:
+        return datetime.strptime(date_str, '%Y-%m-%d')
+    except:
+        return date_str
+
+
+def time_to_json(d):
+
+    return d.strftime("%Y-%m-%d %H:%M:%S") if d else None
+
+
+def json_to_time(time_str):
+    try:
+        return datetime.strptime(time_str, "%Y-%m-%d %H:%M:%S")
+    except:
+        return time_str

hiddifypanel/hutils/random.py

@@ -0,0 +1,19 @@
+import random
+import string
+
+
+def get_random_string(min_=10, max_=30):
+    # With combination of lower and upper case
+    length = random.randint(min_, max_)
+    characters = string.ascii_letters + string.digits
+    result_str = ''.join(random.choice(characters) for i in range(length))
+    return result_str
+
+
+def get_random_password(length: int = 16) -> str:
+    '''Retunrns a random password with fixed length'''
+    characters = string.ascii_letters + string.digits  # + '-'
+    while True:
+        passwd = ''.join(random.choice(characters) for i in range(length))
+        if (any(c.islower() for c in passwd) and any(c.isupper() for c in passwd) and sum(c.isdigit() for c in passwd) > 1):
+            return passwd

hiddifypanel/hutils/utils.py

@@ -3,14 +3,10 @@ from typing import Any, Tuple
 from urllib.parse import urlparse
 from uuid import UUID
 from flask_babelex import lazy_gettext as _
-from datetime import datetime
-from flask import url_for, Markup
-from flask import flash as flask_flash
 import re
 import requests
 
 import string
-import random
 import os
 import sys
 
@@ -20,29 +16,10 @@ from hiddifypanel.cache import cache
 to_gig_d = 1000*1000*1000
 
 
-def url_encode(strr):
-    import urllib.parse
-    return urllib.parse.quote(strr)
-
-
-def is_uuid_valid(uuid, version):
-    try:
-        uuid_obj = UUID(uuid, version=version)
-    except ValueError:
-        return False
-    return str(uuid_obj) == uuid
-
-
 def error(str):
-
     print(str, file=sys.stderr)
 
 
-def static_url_for(**values):
-    orig = url_for("static", **values)
-    return orig.split("user_secret")[0]
-
-
 @cache.cache(ttl=60000)
 def get_latest_release_url(repo):
     latest_url = requests.get(f'{repo}/releases/latest').url.strip()
@@ -67,12 +44,6 @@ def get_latest_release_version(repo_name):
     return None
 
 
-def do_base_64(str):
-    import base64
-    resp = base64.b64encode(f'{str}'.encode("utf-8"))
-    return resp.decode()
-
-
 def get_folder_size(folder_path):
     total_size = 0
     try:
@@ -88,23 +59,6 @@ def get_folder_size(folder_path):
     return total_size
 
 
-def get_random_string(min_=10, max_=30):
-    # With combination of lower and upper case
-    length = random.randint(min_, max_)
-    characters = string.ascii_letters + string.digits
-    result_str = ''.join(random.choice(characters) for i in range(length))
-    return result_str
-
-
-def get_random_password(length: int = 16) -> str:
-    '''Retunrns a random password with fixed length'''
-    characters = string.ascii_letters + string.digits  # + '-'
-    while True:
-        passwd = ''.join(random.choice(characters) for i in range(length))
-        if (any(c.islower() for c in passwd) and any(c.isupper() for c in passwd) and sum(c.isdigit() for c in passwd) > 1):
-            return passwd
-
-
 def is_assci_alphanumeric(str):
     for c in str:
         if c not in string.ascii_letters + string.digits:
@@ -112,134 +66,11 @@ def is_assci_alphanumeric(str):
     return True
 
 
-def date_to_json(d):
-    return d.strftime("%Y-%m-%d") if d else None
-
-
-def json_to_date(date_str):
-    try:
-        return datetime.strptime(date_str, '%Y-%m-%d')
-    except:
-        return date_str
-
-
-def time_to_json(d):
-
-    return d.strftime("%Y-%m-%d %H:%M:%S") if d else None
-
-
-def json_to_time(time_str):
-    try:
-        return datetime.strptime(time_str, "%Y-%m-%d %H:%M:%S")
-    except:
-        return time_str
-
-
-def flash(message, category):
-    # print(message)
-    return flask_flash(Markup(message), category)
-
-
 def get_proxy_path_from_url(url: str) -> str | None:
     url_path = urlparse(url).path
     proxy_path = url_path.lstrip('/').split('/')[0] or None
     return proxy_path
 
 
-def is_uuid_in_url_path(path: str) -> bool:
-    for section in path.split('/'):
-        if is_uuid_valid(section, 4):
-            return True
-    return False
-
-
-def get_uuid_from_url_path(path: str, section_index: int = 2) -> str | None:
-    """
-    Takes a URL path and extracts the UUID at the specified section index.
-
-    Args:
-        path (str): The URL path from which to extract the UUID.
-        section_index (int, optional): The index of the section in the URL path where the UUID is located. Defaults to 2, because in past the UUID was in the second section of path of url.
-
-    Returns:
-        str | None: The extracted UUID as a string if found, or None if not found.
-    """
-    s_index = 1
-    for section in path.lstrip('/').split('/'):
-        if is_uuid_valid(section, 4):
-            if s_index == section_index:
-                return section
-        s_index += 1
-    return None
-
-
-def get_apikey_from_auth_header(auth_header: str) -> str | None:
-    if auth_header.startswith('ApiKey'):
-        return auth_header.split('ApiKey ')[1].strip()
-    return None
-
-
-def get_basic_auth_from_auth_header(auth_header: str) -> str | None:
-    if auth_header.startswith('Basic'):
-        return auth_header.split('Basic ')[1].strip()
-    return None
-
-
-def parse_basic_auth_header(auth_header: str) -> tuple[str, str] | None:
-    if not auth_header.startswith('Basic'):
-        return None
-    header_value = auth_header.split('Basic ')
-    if len(header_value) < 2:
-        return None
-    username, password = map(lambda item: item.strip(), base64.urlsafe_b64decode(header_value[1].strip()).decode('utf-8').split(':'))
-    return (username, password) if username and password else None
-
-
-def parse_login_id(raw_id) -> Tuple[Any | None, str | None]:
-    """
-    Parses the given raw ID to extract the account type and ID.
-    Args:
-        raw_id (str): The raw ID to be parsed.
-    Returns:
-        Tuple[Any | None, str | None]: A tuple containing the account type and ID.
-            The account type is either AccountType.admin or AccountType.user
-            and the ID is a string. If the raw ID cannot be parsed, None is returned
-            for both the account type and ID.
-    """
-    splitted = raw_id.split('_')
-    if len(splitted) < 2:
-        return None, None
-    admin_or_user, id = splitted
-    from hiddifypanel.models.role import AccountType
-    account_type = AccountType.admin if admin_or_user == 'admin' else AccountType.user
-    if not id or not account_type:
-        return None, None
-    return account_type, id
-
-
-def add_basic_auth_to_url(url: str, username: str, password: str) -> str:
-    if 'https://' in url:
-        return url.replace('https://', f'https://{username}:{password}@')
-    elif 'http://' in url:
-        return url.replace('http://', f'http://{username}:{password}@')
-    else:
-        return url
-
-
-def convert_to_int(s: str) -> int:
-    try:
-        return int(s)
-    except:
-        return 0
-
-
 def is_out_of_range_port(port: int) -> bool:
     return port < 1 or port > 65535
-
-
-def is_int(input: str) -> bool:
-    try:
-        int(input)
-        return True
-    except:
-        return False

hiddifypanel/models/__init__.py

@@ -10,3 +10,4 @@ from .admin import AdminUser, AdminMode
 from .child import Child
 from .usage import DailyUsage
 from .base_account import BaseAccount
+# from .report import Report, ReportDetail