AIL-framework/bin/modules/Global.py

233 lines
8.1 KiB
Python
Raw Normal View History

2018-05-04 13:53:29 +02:00
#!/usr/bin/env python3
# -*-coding:UTF-8 -*
"""
The ZMQ_Feed_Q Module
=====================
This module is consuming the Redis-list created by the ZMQ_Feed_Q Module,
And save the item on disk to allow others modules to work on them.
..todo:: Be able to choose to delete or not the saved item after processing.
..note:: Module ZMQ_Something_Q and ZMQ_Something are closely bound, always put
the same Subscriber name in both of them.
Requirements
------------
*Need running Redis instances.
*Need the Mixer or the Importer Module running to be able to work properly.
"""
2021-04-28 15:24:33 +02:00
##################################
# Import External packages
##################################
import base64
import io
import gzip
import os
import sys
import time
from hashlib import md5
from uuid import uuid4
2021-04-28 15:24:33 +02:00
sys.path.append(os.environ['AIL_BIN'])
2021-04-28 15:24:33 +02:00
##################################
# Import Project packages
##################################
from modules.abstract_module import AbstractModule
2023-03-16 15:50:42 +01:00
from lib.ail_core import get_ail_uuid
from lib.ConfigLoader import ConfigLoader
from lib.data_retention_engine import update_obj_date
from lib.objects.Items import Item
# from lib import Statistics
2021-04-28 15:24:33 +02:00
class Global(AbstractModule):
"""
Global module for AIL framework
"""
2021-04-28 15:24:33 +02:00
def __init__(self):
super(Global, self).__init__()
self.processed_item = 0
self.time_last_stats = time.time()
config_loader = ConfigLoader()
# Get and sanitize ITEM DIRECTORY
# # TODO: rename PASTE => ITEM
self.ITEMS_FOLDER = os.path.join(os.environ['AIL_HOME'], config_loader.get_config_str("Directories", "pastes")) + '/'
self.ITEMS_FOLDER = os.path.join(os.path.realpath(self.ITEMS_FOLDER), '')
2018-04-20 10:42:19 +02:00
# Waiting time in seconds between to message processed
2021-04-28 15:24:33 +02:00
self.pending_seconds = 0.5
2018-04-20 10:42:19 +02:00
2021-04-28 15:24:33 +02:00
# Send module state to logs
2023-05-12 15:29:53 +02:00
self.logger.info(f"Module {self.module_name} initialized")
2021-04-28 15:24:33 +02:00
def computeNone(self):
difftime = time.time() - self.time_last_stats
2021-04-28 15:24:33 +02:00
if int(difftime) > 30:
to_print = f'Global; ; ; ;glob Processed {self.processed_item} item(s) in {difftime} s'
print(to_print)
2021-04-28 15:24:33 +02:00
self.time_last_stats = time.time()
self.processed_item = 0
2021-04-28 15:24:33 +02:00
def compute(self, message, r_result=False): # TODO move OBJ ID sanitization to importer
# Recovering the streamed message infos
if self.obj.type == 'item':
2024-03-13 14:39:31 +01:00
if message:
2018-11-02 16:07:27 +01:00
# Creating the full filepath
filename = os.path.join(self.ITEMS_FOLDER, self.obj.id)
filename = os.path.realpath(filename)
# Incorrect filename
if not os.path.commonprefix([filename, self.ITEMS_FOLDER]) == self.ITEMS_FOLDER:
self.logger.warning(f'Global; Path traversal detected {filename}')
print(f'Global; Path traversal detected {filename}')
else:
# Decode compressed base64
2024-03-13 14:39:31 +01:00
decoded = base64.standard_b64decode(message)
new_file_content = self.gunzip_bytes_obj(filename, decoded)
2021-04-28 15:24:33 +02:00
# TODO REWRITE ME
if new_file_content:
filename = self.check_filename(filename, new_file_content)
if filename:
new_obj_id = filename.replace(self.ITEMS_FOLDER, '', 1)
new_obj = Item(new_obj_id)
new_obj.sanitize_id()
self.set_obj(new_obj)
# create subdir
dirname = os.path.dirname(filename)
if not os.path.exists(dirname):
os.makedirs(dirname)
2021-04-28 15:24:33 +02:00
with open(filename, 'wb') as f:
f.write(decoded)
update_obj_date(self.obj.get_date(), 'item')
2021-04-28 15:24:33 +02:00
self.add_message_to_queue(obj=self.obj, queue='Item')
self.processed_item += 1
print(self.obj.id)
if r_result:
return self.obj.id
2021-04-28 15:24:33 +02:00
else:
self.logger.info(f"Empty Item: {message} not processed")
elif self.obj.type == 'message' or self.obj.type == 'ocr':
# TODO send to specific object queue => image, ...
self.add_message_to_queue(obj=self.obj, queue='Item')
elif self.obj.type == 'image':
self.add_message_to_queue(obj=self.obj, queue='Image', message=message)
self.add_message_to_queue(obj=self.obj, queue='Images', message=message)
else:
self.logger.critical(f"Empty obj: {self.obj} {message} not processed")
2021-04-28 15:24:33 +02:00
def check_filename(self, filename, new_file_content):
"""
Check if file is not a duplicated file
return the filename if new file, else None
"""
# check if file exist
if os.path.isfile(filename):
self.logger.info(f'File already exist {filename}')
print(f'File already exist {filename}')
2021-04-28 15:24:33 +02:00
# Check that file already exists but content differs
curr_file_content = self.gunzip_file(filename)
if curr_file_content:
# Compare file content with message content with MD5 checksums
curr_file_md5 = md5(curr_file_content).hexdigest()
new_file_md5 = md5(new_file_content).hexdigest()
if new_file_md5 != curr_file_md5:
2021-04-28 15:24:33 +02:00
# MD5 are not equals, verify filename
if filename.endswith('.gz'):
2021-04-28 15:24:33 +02:00
filename = f'{filename[:-3]}_{new_file_md5}.gz'
else:
2021-04-28 15:24:33 +02:00
filename = f'{filename}_{new_file_md5}'
2023-05-12 15:29:53 +02:00
self.logger.debug(f'new file to check: {filename}')
if os.path.isfile(filename):
2021-04-28 15:24:33 +02:00
# Ignore duplicate
2023-05-12 15:29:53 +02:00
self.logger.debug(f'ignore duplicated file {filename}')
print(f'ignore duplicated file {filename}')
2021-04-28 15:24:33 +02:00
filename = None
else:
2021-04-28 15:24:33 +02:00
# Ignore duplicate checksum equals
2023-05-12 15:29:53 +02:00
self.logger.debug(f'ignore duplicated file {filename}')
print(f'ignore duplicated file {filename}')
2021-04-28 15:24:33 +02:00
filename = None
2021-04-28 15:24:33 +02:00
else:
# File not unzipped
filename = None
2021-04-28 15:24:33 +02:00
return filename
def gunzip_file(self, filename):
"""
Unzip a file
publish stats if failure
"""
curr_file_content = None
2021-04-28 15:24:33 +02:00
try:
with gzip.open(filename, 'rb') as f:
curr_file_content = f.read()
except EOFError:
2023-05-12 15:29:53 +02:00
self.logger.warning(f'Global; Incomplete file: {filename}')
print(f'Global; Incomplete file: {filename}')
2021-04-28 15:24:33 +02:00
# save daily stats
# self.r_stats.zincrby('module:Global:incomplete_file', 1, datetime.datetime.now().strftime('%Y%m%d'))
# Statistics.
2021-04-28 15:24:33 +02:00
except OSError:
2023-05-12 15:29:53 +02:00
self.logger.warning(f'Global; Not a gzipped file: {filename}')
print(f'Global; Not a gzipped file: {filename}')
2021-04-28 15:24:33 +02:00
# save daily stats
# self.r_stats.zincrby('module:Global:invalid_file', 1, datetime.datetime.now().strftime('%Y%m%d'))
2018-04-20 10:42:19 +02:00
2021-04-28 15:24:33 +02:00
return curr_file_content
2018-11-02 16:07:27 +01:00
2022-08-19 16:53:31 +02:00
# # TODO: add stats incomplete_file/Not a gzipped file
def gunzip_bytes_obj(self, filename, bytes_obj):
2021-04-28 15:24:33 +02:00
gunzipped_bytes_obj = None
try:
in_ = io.BytesIO()
in_.write(bytes_obj)
in_.seek(0)
2021-04-28 15:24:33 +02:00
with gzip.GzipFile(fileobj=in_, mode='rb') as fo:
gunzipped_bytes_obj = fo.read()
except Exception as e:
2023-05-12 15:29:53 +02:00
self.logger.warning(f'Global; Invalid Gzip file: {filename}, {e}')
print(f'Global; Invalid Gzip file: {filename}, {e}')
2021-04-28 15:24:33 +02:00
return gunzipped_bytes_obj
def rreplace(self, s, old, new, occurrence):
li = s.rsplit(old, occurrence)
return new.join(li)
if __name__ == '__main__':
2021-04-28 15:24:33 +02:00
module = Global()
module.run()