Source code for tgbox.defaults

"""This module stores API defaults."""

import logging

from os import getenv
from enum import IntEnum
from pathlib import Path
try:
    from sys import _MEIPASS
except ImportError:
    _MEIPASS = None

from .version import VERSION

# Used to check minor protocol version for
# the available features in TGBOX
MINOR_VERSION = int(VERSION.split('.')[1])

__all__ = [
    'Limits',
    'UploadLimits',
    'Scrypt',
    'VERSION',
    'MINOR_VERSION',
    'VERBYTE',
    'DEF_TGBOX_NAME',
    'REMOTEBOX_PREFIX',
    'DEF_NO_FOLDER',
    'DEF_UNK_FOLDER',
    'PREFIX',
    'BOX_IMAGE_PATH',
    'WORDS_PATH',
    'FFMPEG',
    'ABSPATH',
    'DOWNLOAD_PATH',
    'PYINSTALLER_DATA'
]
logger = logging.getLogger(__name__)

# This will be True if we're inside the ReadTheDocs build
READTHEDOCS: bool = bool(getenv('READTHEDOCS'))



class Limits(IntEnum):
    """Default TGBOX API limits"""
    # We store metadata size in three bytes, but
    # by default it's size is limited to 1MB. You
    # can set it up to the 256^3-1, but to share
    # your files with other people they should have
    # a METADATA_MAX that >= than yours.
    METADATA_MAX: int=1000000
    # Max FILE_PATH length on Linux
    # is 4096 bytes (4KiB).
    FILE_PATH_MAX: int=4096




class UploadLimits(IntEnum):
    """Telegram filesize limits"""
    DEFAULT = 2000000000
    PREMIUM = 4000000000




class Scrypt(IntEnum):
    """Default Scrypt KDF configuration"""
    # See https://en.wikipedia.org/wiki/Scrypt for base info about Scrypt
    # -------------------------------------------------------------------
    # This salt affects basekeys, you can change it to protect your RemoteBox
    # from bruteforcing, but make sure to backup it. If you will lose your custom
    # salt, then recovery of your decryption key for TGBOX will be impossible.
    # Typically you won't need to change it, because if you use strong password
    # (or phrase generated by keys.Phrase) then it's already should be impossible
    # to brute force. Think of this as 2FA. Changed salt will not protect you if
    # you leaked your mainkey, but will protect you from passphrase leakage.
    SALT: int=0x37CE65C834C6EFE05DFAD02413C0950072A1FE3ED48A33368333848D9C782167
    # You can change any Scrypt params. Please note that by default resulted
    # key will be hashed with sha256, so BaseKey is always 32 bytes long.
    # This defaults is balanced to use 1GB of RAM on each Key make.
    DKLEN: int=32
    N:     int=2**20
    R:     int=8
    P:     int=1


# Path that will be used to save downloaded files.
DOWNLOAD_PATH: Path=Path('DownloadsTGBOX')

VERBYTE: bytes=b'\x01'

DEF_TGBOX_NAME:   str='TGBOX'
REMOTEBOX_PREFIX: str=f'{DEF_TGBOX_NAME}[{VERBYTE.hex()}]: '

DEF_NO_FOLDER:  Path=Path('NO_FOLDER')
DEF_UNK_FOLDER: Path=Path('UNKNOWN_FOLDER')

# Fast Sync can be used only when multiple Users share the
# same Box and all of them have access to the Admin Log. For
# Fast Sync, we add and remove caption for each uploaded
# file. Although unlikely on low/mid upload magnitudes,
# on big file amounts this can potentially cause throttle
# or even 429 Error. As mostly Users utilize Box without
# sharing, I guess it's a sane to make Fast Sync optional;
# however, you can enable it back at any time with the
# DecryptedLocalBox.defaults.change('FAST_SYNC_ENABLED', 1)
FAST_SYNC_ENABLED: bool=False

PREFIX: bytes=b'\x00TGBOX'

ABSPATH: Path = Path(_MEIPASS) if _MEIPASS is not None \
    else Path(__file__).parent

# Get path to "other" folder where we store
# words.txt and tgbox_logo.png files.
_other: Path = ABSPATH / 'other'

# We will use it in subprocess.call
FFMPEG = 'ffmpeg'

# You can add ffmpeg.exe to 'other' folder
# before build with PyInstaller on Windows or
# just if you want TGBOX to make file thumbnails
# or extract duration. It will be added to
# your resulted executable.
#
# https://www.ffmpeg.org/download.html#build-windows
#
for file in _other.iterdir():
    if file.name.startswith('ffmpeg'):
        logger.info(f'FFMPEG found in {str(_other)}, we will use it')
        FFMPEG = _other / file.name
        break

# By default, PyInstaller will not grab files
# from 'other' folder. To resolve this error
# you will need to manually add it to .spec file.
#
# See
#   '.spec file' example:
#        github.com/NotStatilko/tgbox-cli/blob/main/tgbox_cli.spec
#
#   'Installation' in TGBOX docs:
#       tgbox.readthedocs.io/en/latest/installation.html
#
PYINSTALLER_DATA: dict = {
    str(Path('other', i.name)): str(i)
    for i in _other.glob('*')
}
BOX_IMAGE_PATH: Path = _other / 'tgbox_logo.png'
WORDS_PATH: Path = _other / 'words.txt'