EntityScript™

# -*- coding: utf-8 -*-
"""
COPYRIGHT (C) 2020-2023 NEW ENTITY OPERATIONS INC. ALL RIGHTS RESERVED
INSTANCE: core_navigator
MODIFIED: 2023/05/25
OVERVIEW:

core_navigator lets you connect your interface into various parts of the
underlying machine through an 'actions' and 'data types' model.

This sub-system is fully functional in version 0.0.9, but in 0.0.8 it is still
in conceptual mode.

Navigator is not a system level tool, but a tree navigation interface for
interacting with node-specific data

To access tree-based structures containing either 'actions' or 'data types'
some methods are provided, while others are referred to the implementation
languages standard library

Usage:

'actions' are routines that are defined by a programatic extension here.
This has to be a call.

'data types' are exact values of various data types that can be inserted
seamlessly into defined contextal methods. Such as cleaning bookmarks, that
exist in a bookmark specific format and can be traversed according to a desired
outcome operation

Something like personal media would be considered 'machine material'
according to the IPDVC Standard, and that material can be accessed through
the navigation interface.

IPDVC Standard Allowed Navigation Types:
1.) Tree navigation, generic
2.) Parser:
    provided - Bookmarks Sanitizer

All pass objects are not implemented by default and must be setup to meet your
desired objectsives
"""
__version__ = "0.0.8"
__author__ = "Ryan McKenna"
__copyright__ = "Copyright (C) 2023 New Entity Operations Inc."
__credits__ = [
 "Ryan McKenna",
 "New Entity Operations Inc.", "New Entity Operations, LLC"]
__email__ = "Operator@NewEntityOperations.com"
__license__ = "New Entity License"
__maintainer__ = "Ryan McKenna"
__status__ = "Production"

## MODE.debug_navigator
from MODE.debug_navigator import DEBUG_NAVIGATOR
## MODE.debug_steps
from MODE.debug_steps import DEBUG_STEPS

## Imports: Custom
from core_middlelayer import (directory_core_SLUG, directory_master_SLUG)

#*****************************************#
# START: STEP 2: Create a ficticious NODE #
#*****************************************#
DEBUG_STEPS.step_2(MODE="START")
# Establish Full Directory Paths: This should be your base directory
path_TRINE = directory_master_SLUG+directory_core_SLUG
DEBUG_NAVIGATOR.verify_ficticious_anchored_path(PATH=path_TRINE)
DEBUG_STEPS.step_2(MODE="STOP")
#*****************************************#
# START: STOP 2: Create a ficticious NODE #
#*****************************************#

## Establish your position
class Position:
 """
 A Position is a universal virtual anchor object
 """
 start_location = path_TRINE
 current_location = [] # This will be whereever you're navigating to

## Establish Directory Class behavior
class DirNodeAccessCount:
 """
 A counter for each 'read', 'write' and 'scan' of a Node
 """
 def verify_node_access_count(inspection_object):
  pass

class DirNodeAlter:
 """
 Alter DirNodeKeyX with attributes Axn
 """
 def switch_node_context(x, y):
  pass

class DirNodeCreator:
 """
 Create a Dir in DirNodeKeyX
 """
 def generate_file(NODE, KEY):
  pass

class DirNodeDeleter:
 """
 Delete DirNodeKeyX from DirNodeKeyY
 """
 def destroy_node(NODE):
  pass

class DirNodeDepth:
 """
 From the index-root, how many layers deep is the Node nested?
 """
 def evaluate_node_depth(evaluation_object):
  pass

class DirNodeKey:
 """
 The true node-key of the directory
 """
 def evaluate_node_truekey(evaluation_object):
  pass

class DirNodeMover:
 """
 Move a Dir from DirNodeKeyX to DirNodeKeyY
 """
 def switch_node_context(x, y):
  pass

class DirNodeName:
 """
 The string that defines the 'DirNodeKey'
 """
 def discover_node_name(discovery_object):
  pass

class DirNodeType:
 """
 From the preset list of Node directory types, the node is...
 CORE, MEDIA, DATA, VIRTUAL, ENTITY
 """
 def discover_node_type(discovery_object):
  pass

## Establish File class Behavior
class FileAccessCount:
 """
 File access counter can either be 'on' or 'off'
 and can either be 'summarized' or 'not_summarized'
 """
 def verify_file_access_count(inspection_object):
  pass

class FileAlterNode:
 """
 Alter the node of the file from FileInNodeX, to FileInNodeY
 """
 def switch_node_context(x, y):
  pass

class FileCreateStandard:
 """
 Create a file of type X in DirNodeKey, with default of DirNodeKeyX
 """
 def generate_file(NODE, KEY):
  pass

class FileDateAccessed:
 """
 Determine when a file was accessed
 """
 def evaluate_last_file_access(evaluation_object):
  pass

class FileDateModified:
 """
 A file was modified last on date X
 """
 def evaluate_last_file_modification(evaluation_object):
  pass

class FileGroup:
 """
 The file has a natural abstract group of *
 """
 def evaluate_file(file):
  pass

class FileHashTypes:
 """
 Evaluate for certain hashing criteria
 MD5, Sha1, Sha256, and Sha512 are supported
 """
 def HTypeMD5(instance_hash_object):
  pass

 def HTypeSha1(instance_hash_object):
  pass

 def HTypeSha256(instance_hash_object):
  pass

 def HTypeSha512(instance_hash_object):
  pass

class FileINode:
 """
 The file resides in NodeX
 """
 def generate_inode(desired_node_location="FREE"):
  pass

class FileMIMEType:
 """
 the file has a mime type of
 """
 def discover_mime_type(discovery_object):
  pass

class FileOwner:
 """
 The file is owned by the natural abstraction owner *
 """
 def discover_file_owner(discovery_object):
  pass

class FilePermissions:
 """
 The file has natural abstract permissions of *
 """
 def discover_file_permissions(discovery_object):
  pass

class FileSize:
 """
 The file has a natural base 1024 size of *
 """
 def discover_file_size(discovery_object):
  pass

class FileTrueKey:
 """
 The true index-key of the file
 """
 def evaluate_file_truekey(evaluation_object):
  pass

class FileType:
 """
 The file has a type of *
 """
 def discover_file_type(discovery_object):
  pass