atomicshop 2.16.5__py3-none-any.whl → 2.16.6__py3-none-any.whl

atomicshop/__init__.py

@@ -1,4 +1,4 @@
 """Atomic Basic functions and classes to make developer life easier"""
 
 __author__ = "Den Kras"
-__version__ = '2.16.5'
+__version__ = '2.16.6'

atomicshop/archiver/zips.py

@@ -2,7 +2,7 @@ import os
 import time
 import zipfile
 from io import BytesIO
-from typing import Union
+from typing import Union, Literal
 
 from .. import filesystem
 from ..print_api import print_api
@@ -142,6 +142,67 @@ def get_file_list_from_zip(file_path: str) -> list:
         return zip_object.namelist()
 
 
+def archive_directory(
+        directory_path: str,
+        compression: Literal[
+            'store',
+            'deflate',
+            'bzip2',
+            'lzma'] = 'deflate',
+        include_root_directory: bool = True,
+        remove_original: bool = False
+) -> str:
+    """
+    Function archives the directory.
+    :param directory_path: string, full path to the directory.
+    :param compression: string, default is 'deflate'.
+        'store': No compression.
+        'deflate': Standard ZIP compression.
+        'bzip2': BZIP2 compression.
+            Provides better compression than Deflate but is typically slower. This method might not be supported by
+            all ZIP utilities.
+        'lzma': LZMA compression.
+            high compression ratios but is also slower compared to Deflate. This method is less commonly used and
+            may not be supported by all ZIP utilities.
+    :param include_root_directory: boolean, default is 'True'.
+        'True': The root directory will be included in the archive.
+        'False': The root directory will not be included in the archive.
+        True is usually the case in most archiving utilities.
+    :param remove_original: boolean, default is 'False'. If 'True', the original directory will be removed.
+    :return: string, full path to the archived file.
+    """
+
+    if compression == 'store':
+        compression_method = zipfile.ZIP_STORED
+    elif compression == 'deflate':
+        compression_method = zipfile.ZIP_DEFLATED
+    elif compression == 'bzip2':
+        compression_method = zipfile.ZIP_BZIP2
+    elif compression == 'lzma':
+        compression_method = zipfile.ZIP_LZMA
+    else:
+        raise ValueError(f"Unsupported compression method: {compression}")
+
+    archive_path: str = directory_path + '.zip'
+    with zipfile.ZipFile(archive_path, 'w', compression_method) as zip_object:
+        for root, _, files in os.walk(directory_path):
+            for file in files:
+                file_path = os.path.join(root, file)
+
+                # If including the root directory, use the relative path from the parent directory of the root
+                if include_root_directory:
+                    arcname = os.path.relpath(file_path, os.path.dirname(directory_path))
+                else:
+                    arcname = os.path.relpath(file_path, directory_path)
+
+                zip_object.write(file_path, arcname)
+
+    if remove_original:
+        filesystem.remove_directory(directory_path)
+
+    return archive_path
+
+
 # def search_file_in_zip(
 #         file_path: str = None,
 #         file_bytes: bytes = None,

atomicshop/mitm/engines/__parent/recorder___parent.py

@@ -2,7 +2,7 @@ import os
 from datetime import datetime
 
 from ...shared_functions import build_module_names, create_custom_logger, get_json
-from ...message import ClientMessage
+from ... import message, recs_files
 from ....urls import url_parser
 from .... import filesystem
 
@@ -13,8 +13,8 @@ class RecorderParent:
     # in the script these lines will not be called again, only the "init" function.
     logger = create_custom_logger()
 
-    def __init__(self, class_client_message: ClientMessage, record_path: str):
-        self.class_client_message: ClientMessage = class_client_message
+    def __init__(self, class_client_message: message.ClientMessage, record_path: str):
+        self.class_client_message: message.ClientMessage = class_client_message
         self.record_path: str = record_path
         self.file_extension: str = ".json"
         self.engine_name = None
@@ -41,7 +41,7 @@ class RecorderParent:
         # current date and time in object
         now = datetime.now()
         # Formatting the date and time and converting it to string object
-        day_time_format: str = now.strftime("%Y_%m_%d-%H_%M_%S_%f")
+        day_time_format: str = now.strftime(recs_files.REC_FILE_DATE_TIME_FORMAT)
 
         # Build the record path with file name
         self.build_record_path_to_engine()

atomicshop/mitm/initialize_mitm_server.py

@@ -1,6 +1,7 @@
 import os
 import threading
 import time
+import datetime
 
 import atomicshop   # Importing atomicshop package to get the version of the package.
 
@@ -13,7 +14,7 @@ from ..print_api import print_api
 
 from .initialize_engines import ModuleCategory
 from .connection_thread_worker import thread_worker_main
-from . import config_static
+from . import config_static, recs_files
 
 
 def exit_cleanup():
@@ -47,6 +48,9 @@ def initialize_mitm_server(config_file_path: str):
         filesystem.create_directory(
             config_static.Certificates.sni_server_certificate_from_server_socket_download_directory)
 
+    # Compress recordings of the previous days if there are any.
+    recs_files.recs_archiver_in_process(config_static.Recorder.recordings_path)
+
     # Create a logger that will log messages to file, Initiate System logger.
     logger_name = "system"
     system_logger = loggingw.create_logger(
@@ -317,6 +321,25 @@ def initialize_mitm_server(config_file_path: str):
             message = f"Unhandled Exception occurred in 'loop_for_incoming_sockets' function"
             print_api(message, error_type=True, color="red", logger=network_logger, traceback_string=True, oneline=True)
 
+        # Compress recordings each day in a separate process.
+        recs_archiver_thread = threading.Thread(target=_loop_at_midnight_recs_archive)
+        recs_archiver_thread.daemon = True
+        recs_archiver_thread.start()
+
         # This is needed for Keyboard Exception.
         while True:
             time.sleep(1)
+
+
+def _loop_at_midnight_recs_archive():
+    previous_date = datetime.datetime.now().strftime('%d')
+    while True:
+        # Get current time.
+        current_date = datetime.datetime.now().strftime('%d')
+        # If it's midnight, start the archiving process.
+        if current_date != previous_date:
+            recs_files.recs_archiver_in_process(config_static.Recorder.recordings_path)
+            # Update the previous date.
+            previous_date = current_date
+        # Sleep for 1 minute.
+        time.sleep(60)

atomicshop/mitm/recs_files.py

@@ -0,0 +1,61 @@
+import datetime
+import os
+import multiprocessing
+
+from ..wrappers.loggingw import reading
+from ..archiver import zips
+from .. import filesystem
+
+
+REC_FILE_DATE_TIME_FORMAT: str = "%Y_%m_%d-%H_%M_%S_%f"
+REC_FILE_DATE_FORMAT: str = REC_FILE_DATE_TIME_FORMAT.split('-')[0]
+
+
+def recs_archiver(recs_directory: str) -> list:
+    """
+    Find recs files in a directory for each day.
+    Each day of recordings will have separate archive.
+
+    :param recs_directory: The directory where recordings are stored.
+    """
+
+    today_date_string = datetime.datetime.now().strftime(REC_FILE_DATE_FORMAT)
+
+    all_recs_files = reading.get_logs_paths(
+        log_files_directory_path=recs_directory,
+        file_name_pattern='*.json',
+        date_format=REC_FILE_DATE_FORMAT
+    )
+
+    archive_directories: list = list()
+    for recs_file_dict in all_recs_files:
+        # We don't need to archive today's files.
+        if today_date_string == recs_file_dict['date_string']:
+            continue
+
+        target_directory_path: str = f"{recs_directory}{os.sep}{recs_file_dict['date_string']}"
+        if target_directory_path not in archive_directories:
+            archive_directories.append(target_directory_path)
+
+        filesystem.create_directory(target_directory_path)
+        filesystem.move_file(
+            recs_file_dict['file_path'], f'{target_directory_path}{os.sep}{recs_file_dict["file_name"]}')
+
+    # Archive directories.
+    archived_files: list = list()
+    for archive_directory in archive_directories:
+        archived_file: str = zips.archive_directory(
+            archive_directory, remove_original=True, include_root_directory=True)
+        archived_files.append(archived_file)
+
+    return archived_files
+
+
+def recs_archiver_in_process(recs_directory: str):
+    """
+    Archive recs files in a directory for each day in a separate process.
+    """
+
+    process = multiprocessing.Process(target=recs_archiver, args=(recs_directory,))
+    process.start()
+

{atomicshop-2.16.5.dist-info → atomicshop-2.16.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atomicshop
-Version: 2.16.5
+Version: 2.16.6
 Summary: Atomic functions and classes to make developer life easier
 Author: Denis Kras
 License: MIT License

{atomicshop-2.16.5.dist-info → atomicshop-2.16.6.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=brLGdMD_yQxk-vW-768SsqOYGdgi3tFIZn06CAea2jU,123
+atomicshop/__init__.py,sha256=NMVkLfOWWW1x6P0-ZbzZwEZakjOofspuaUcE3fKmzjk,123
 atomicshop/_basics_temp.py,sha256=6cu2dd6r2dLrd1BRNcVDKTHlsHs_26Gpw8QS6v32lQ0,3699
 atomicshop/_create_pdf_demo.py,sha256=Yi-PGZuMg0RKvQmLqVeLIZYadqEZwUm-4A9JxBl_vYA,3713
 atomicshop/_patch_import.py,sha256=ENp55sKVJ0e6-4lBvZnpz9PQCt3Otbur7F6aXDlyje4,6334
@@ -78,7 +78,7 @@ atomicshop/archiver/archiver.py,sha256=BomnK7zT-nQXA1z0i2R2aTv8eu88wPx7tf2HtOdbm
 atomicshop/archiver/search_in_archive.py,sha256=XAxa0QukkXZvPmKna8cpwBHLDEskRUtbgaW1eHvpn6w,10833
 atomicshop/archiver/sevenz_app_w.py,sha256=BWcJb4f7jZEiETDBKyNLE0f5YLFPQx6B91_ObEIXWf8,3007
 atomicshop/archiver/sevenzs.py,sha256=5i_C50-deC1Cz_GQdMGofV2jeMPbbGWAvih-QnA72cg,1370
-atomicshop/archiver/zips.py,sha256=k742K1bEDtc_4N44j_Waebi-uOkxxavqltvV6q-BLW4,14402
+atomicshop/archiver/zips.py,sha256=JrAirzB94SelKq5M2ZUYASwqSSTJ2sxacKBOYeJ8VRQ,16979
 atomicshop/basics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/basics/ansi_escape_codes.py,sha256=WtIkm-BjSZS5J5irDUdAMBNvdX-qXFZcTX98jcBMpJE,3140
 atomicshop/basics/argparse_template.py,sha256=horwgSf3MX1ZgRnYxtmmQuz9OU_vKrKggF65gmjlmfg,5836
@@ -126,8 +126,9 @@ atomicshop/mitm/config_toml_editor.py,sha256=2p1CMcktWRR_NW-SmyDwylu63ad5e0-w1QP
 atomicshop/mitm/connection_thread_worker.py,sha256=I5Oq6tSUIXAS6FYlflZzYDtC1rbIYdIKax_R1WsFjso,19093
 atomicshop/mitm/import_config.py,sha256=fvUESPMkpRvkL7HtMaUqQRPwPF0eHV5V6pwueg4DQkU,7881
 atomicshop/mitm/initialize_engines.py,sha256=YoSNksMdu4vHjr5xy77t9t5W74zyDZIdjIXrzd3eRXc,8204
-atomicshop/mitm/initialize_mitm_server.py,sha256=qP41_hgSa5Wd9WIwIugTqSmWxaL3S3Hh9OCQfcxUwqk,18367
+atomicshop/mitm/initialize_mitm_server.py,sha256=hwqVk6PMc2iDpl0bLwbUlPrxEmu7Ql75-WWCJxiKh1g,19320
 atomicshop/mitm/message.py,sha256=fHvYEyEx-FAXbIMrKMJ_ybBinezF6IFbPlwCqpRrF44,1768
+atomicshop/mitm/recs_files.py,sha256=O2nhK9awFAsglUjMlNfgHi-0PbJVGIKQxmEoUE00XUg,2030
 atomicshop/mitm/shared_functions.py,sha256=hplm98tz8pgJ4WHUVI9sf_oVqUM2KJ1Y2pD6EFSb8P0,1879
 atomicshop/mitm/statistic_analyzer.py,sha256=E0ba1PjsUEcmQUPPw2YH911lyWkbQb9OSAdgB3pihsY,24658
 atomicshop/mitm/engines/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -135,7 +136,7 @@ atomicshop/mitm/engines/create_module_template.py,sha256=tRjVSm1sD6FzML71Qbuwvit
 atomicshop/mitm/engines/create_module_template_example.py,sha256=X5xhvbV6-g9jU_bQVhf_crZmaH50LRWz3bS-faQ18ds,489
 atomicshop/mitm/engines/__parent/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/mitm/engines/__parent/parser___parent.py,sha256=sBvPlFMOCTdS-qgW9uTKvvJCFT5nNW9n3UyhaFcjAfg,1365
-atomicshop/mitm/engines/__parent/recorder___parent.py,sha256=OJb9McbueE4yfxxFsZ81JOU42rASj-1xC2A3nF70QkE,4637
+atomicshop/mitm/engines/__parent/recorder___parent.py,sha256=kIBfETIgRX40-MfoqrCao6dbbAubp2QC_j29B3EY7Do,4666
 atomicshop/mitm/engines/__parent/responder___parent.py,sha256=e2cdw3tuvNSXp4C2xKdrz-ytveFih1-OV_rpxhJ3zEM,12214
 atomicshop/mitm/engines/__reference_general/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/mitm/engines/__reference_general/parser___reference_general.py,sha256=QolWZKm8SiPxxSoyWY_UK7ODam7EUMAgVfOPFnXxODE,2987
@@ -304,8 +305,8 @@ atomicshop/wrappers/socketw/socket_server_tester.py,sha256=SdchUf9qrPk1Rrat0RzvM
 atomicshop/wrappers/socketw/socket_wrapper.py,sha256=g7f_8RkW80EZeQWNTqGYnfrQkgAI56T3SwWybq7ZsXg,28521
 atomicshop/wrappers/socketw/ssl_base.py,sha256=k4V3gwkbq10MvOH4btU4onLX2GNOsSfUAdcHmL1rpVE,2274
 atomicshop/wrappers/socketw/statistics_csv.py,sha256=Jc0D12crkKRaqoCRQ-2Mz1zm6n4UUx9dXakf-N2TYWA,3065
-atomicshop-2.16.5.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.16.5.dist-info/METADATA,sha256=fo-TPcQE7W_em3KC6uHgkVSXRZMFaqK3PVuWXQTILDI,10502
-atomicshop-2.16.5.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-atomicshop-2.16.5.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.16.5.dist-info/RECORD,,
+atomicshop-2.16.6.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-2.16.6.dist-info/METADATA,sha256=Wcm_aTmc3KMdMN4bkvvD3SRnCJbTopzIa8O7jCuAtUU,10502
+atomicshop-2.16.6.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+atomicshop-2.16.6.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-2.16.6.dist-info/RECORD,,