This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
devicehub-teal/ereuse_devicehub/resources/action/views/snapshot.py

193 lines
6.7 KiB
Python
Raw Normal View History

2021-05-10 09:47:56 +00:00
""" This is the view for Snapshots """
import json
2022-03-18 11:07:22 +00:00
import os
2021-05-10 09:47:56 +00:00
import shutil
from datetime import datetime
2022-06-13 15:35:01 +00:00
from uuid import UUID
2021-05-10 09:47:56 +00:00
2022-03-18 11:07:22 +00:00
from flask import current_app as app
from flask import g
2021-05-10 09:47:56 +00:00
from sqlalchemy.util import OrderedSet
from ereuse_devicehub.db import db
from ereuse_devicehub.resources.action.models import Snapshot
2022-03-18 11:07:22 +00:00
from ereuse_devicehub.resources.device.models import Computer
2022-04-08 09:12:17 +00:00
from ereuse_devicehub.resources.device.sync import Sync
2022-03-18 11:07:22 +00:00
from ereuse_devicehub.resources.enums import Severity, SnapshotSoftware
2021-05-10 09:47:56 +00:00
from ereuse_devicehub.resources.user.exceptions import InsufficientPermission
def save_json(req_json, tmp_snapshots, user, live=False):
"""
This function allow save a snapshot in json format un a TMP_SNAPSHOTS directory
The file need to be saved with one name format with the stamptime and uuid joins
"""
uuid = req_json.get('uuid', '')
now = datetime.now()
year = now.year
month = now.month
day = now.day
hour = now.hour
minutes = now.minute
name_file = f"{year}-{month}-{day}-{hour}-{minutes}_{user}_{uuid}.json"
path_dir_base = os.path.join(tmp_snapshots, user)
if live:
path_dir_base = tmp_snapshots
path_errors = os.path.join(path_dir_base, 'errors')
path_fixeds = os.path.join(path_dir_base, 'fixeds')
path_name = os.path.join(path_errors, name_file)
if not os.path.isdir(path_dir_base):
os.system(f'mkdir -p {path_errors}')
os.system(f'mkdir -p {path_fixeds}')
with open(path_name, 'w') as snapshot_file:
snapshot_file.write(json.dumps(req_json))
return path_name
def move_json(tmp_snapshots, path_name, user, live=False):
"""
This function move the json than it's correct
"""
path_dir_base = os.path.join(tmp_snapshots, user)
if live:
path_dir_base = tmp_snapshots
if os.path.isfile(path_name):
shutil.copy(path_name, path_dir_base)
os.remove(path_name)
2022-05-16 15:52:31 +00:00
class SnapshotMixin:
sync = Sync()
2021-05-10 09:47:56 +00:00
2022-04-08 09:12:17 +00:00
def build(self, snapshot_json=None): # noqa: C901
if not snapshot_json:
snapshot_json = self.snapshot_json
device = snapshot_json.pop('device') # type: Computer
2021-05-10 09:47:56 +00:00
components = None
2022-04-08 09:12:17 +00:00
if snapshot_json['software'] == (
2022-03-18 11:07:22 +00:00
SnapshotSoftware.Workbench or SnapshotSoftware.WorkbenchAndroid
):
2022-04-08 09:12:17 +00:00
components = snapshot_json.pop('components', None) # type: List[Component]
2021-05-10 09:47:56 +00:00
if isinstance(device, Computer) and device.hid:
device.add_mac_to_hid(components_snap=components)
2022-04-08 09:12:17 +00:00
snapshot = Snapshot(**snapshot_json)
2021-05-10 09:47:56 +00:00
# Remove new actions from devices so they don't interfere with sync
actions_device = set(e for e in device.actions_one)
device.actions_one.clear()
if components:
2022-03-18 11:07:22 +00:00
actions_components = tuple(
set(e for e in c.actions_one) for c in components
)
2021-05-10 09:47:56 +00:00
for component in components:
component.actions_one.clear()
assert not device.actions_one
assert all(not c.actions_one for c in components) if components else True
db_device, remove_actions = self.sync.run(device, components)
2021-05-10 09:47:56 +00:00
del device # Do not use device anymore
snapshot.device = db_device
snapshot.actions |= remove_actions | actions_device # Set actions to snapshot
# commit will change the order of the components by what
# the DB wants. Let's get a copy of the list so we preserve order
ordered_components = OrderedSet(x for x in snapshot.components)
# Add the new actions to the db-existing devices and components
db_device.actions_one |= actions_device
if components:
for component, actions in zip(ordered_components, actions_components):
component.actions_one |= actions
snapshot.actions |= actions
if snapshot.software == SnapshotSoftware.Workbench:
# Check ownership of (non-component) device to from current.user
if db_device.owner_id != g.user.id:
raise InsufficientPermission()
elif snapshot.software == SnapshotSoftware.WorkbenchAndroid:
pass # TODO try except to compute RateMobile
# Check if HID is null and add Severity:Warning to Snapshot
if snapshot.device.hid is None:
snapshot.severity = Severity.Warning
return snapshot
2022-06-13 15:35:01 +00:00
def get_uuid(self, debug):
2022-06-14 08:46:21 +00:00
if not debug or not isinstance(debug, dict):
2022-06-13 15:35:01 +00:00
self.errors(txt="There is not uuid")
return
hw_uuid = debug.get('lshw', {}).get('configuration', {}).get('uuid')
if not hw_uuid:
self.errors(txt="There is not uuid")
return
uuid = UUID(hw_uuid)
return UUID(bytes_le=uuid.bytes)
def errors(self, txt=None, severity=Severity.Error, snapshot=None, commit=False):
if not txt:
return
from ereuse_devicehub.parser.models import SnapshotsLog
error = SnapshotsLog(
description=txt,
snapshot_uuid=self.uuid,
severity=severity,
sid=self.sid,
version=self.version,
snapshot=snapshot,
)
error.save(commit=commit)
2022-05-16 15:52:31 +00:00
class SnapshotView(SnapshotMixin):
"""Performs a Snapshot.
See `Snapshot` section in docs for more info.
"""
# Note that if we set the device / components into the snapshot
# model object, when we flush them to the db we will flush
# snapshot, and we want to wait to flush snapshot at the end
def __init__(self, snapshot_json: dict, resource_def, schema):
2022-06-03 09:06:49 +00:00
self.schema = schema
self.resource_def = resource_def
self.tmp_snapshots = app.config['TMP_SNAPSHOTS']
self.path_snapshot = save_json(snapshot_json, self.tmp_snapshots, g.user.email)
2022-06-13 15:35:01 +00:00
self.version = snapshot_json.get('version')
self.uuid = snapshot_json.get('uuid')
self.sid = None
2022-06-14 08:46:21 +00:00
system_uuid = self.get_uuid(snapshot_json.pop('debug', None))
if system_uuid:
snapshot_json['device']['system_uuid'] = system_uuid
2022-06-13 15:35:01 +00:00
try:
self.snapshot_json = resource_def.schema.load(snapshot_json)
2022-06-03 09:06:49 +00:00
snapshot = self.build()
except Exception as err:
txt = "{}".format(err)
2022-06-13 15:35:01 +00:00
self.errors(txt=txt, commit=True)
raise err
2021-05-10 09:47:56 +00:00
db.session.add(snapshot)
2022-06-13 15:35:01 +00:00
self.errors(txt="Ok", severity=Severity.Info, snapshot=snapshot, commit=True)
2021-05-10 09:47:56 +00:00
db.session().final_flush()
self.response = self.schema.jsonify(snapshot) # transform it back
self.response.status_code = 201
2021-05-10 09:47:56 +00:00
db.session.commit()
move_json(self.tmp_snapshots, self.path_snapshot, g.user.email)
def post(self):
return self.response