fzx2 1.0.0__py3-none-any.whl

fzx2-1.0.0.dist-info/METADATA

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: fzx2
+Version: 1.0.0
+Summary: 507EX executable format version 2.0
+Author-email: Wyatt Brashear <admin@wyattb.dev>
+License: MIT
+Requires-Python: >=3.10
+Requires-Dist: flask~=3.1.2
+Requires-Dist: requests>=2.32.5
+Description-Content-Type: text/markdown
+
+# 507ex 2.0 (FZX2)
+## What is 507ex, and why is there a 2.0?
+A while back, I created a executable format called 507ex (507 Being my brand that I like to put things under). I made one
+mistake on the first time. I used AI in my code. That completely ruined my code. So I decided it was time to rewrite it.
+Introducing 507ex 2.0 (Abbreviated as FZX2).
+### What's New?
+- AI was not used to write code (yay)
+- Enhanced metadata that stores more information
+- Auto Dependency Manager. Uses a list embedded in the metadata to ensure the application has the correct dependencies.
+- All operations are accessible through one module.
+- CAR (Central Application Repository) now supports authentication.
+## CAR (Central Application Repository)
+CAR is a server system that allows seamless execution of applications from the command line.
+Example:
+~~~bash
+python3 fzx2.py exec http://127.0.0.1:5000/pull/955d7c5f-5b21-428f-94e4-8e13f1e7223c
+~~~
+Easy as that! All CAR operations are authenticated by a random "secret code" generated by the server.
+### Endpoint Documentation
+POST: /push. Push an executable to the server. Accepts form data in the following form: {'file_id': STR}, and accepts file data in this form: {'file': FILE}.
+Returns:
+```json
+{
+  "status": "success",
+  "secret_code": "secret_code",
+  "url": "request.url_root/pull/filename"
+}
+```
+POST: /pull/<file_id>. Pull an executable from the server. Accepts form data in the following form: {'secret_code': STR}
+Returns:
+The file requested or an error message. Files are sent using flask's send_from_directory function.
+### Running the server
+Source Code Method:
+~~~bash
+python3 fzx2.py start_server
+~~~
+Compiled Executable Method:
+~~~bash
+./fzx2 start_server
+~~~
+## Installation
+### Method 1 (Compiled Executable)
+1. Download the latest release from the releases page.
+2. Run the executable. (Recommended to be done in a terminal)
+### Method 2 (Source Code)
+1. Clone the Repository using `git clone https://github.com/WyattBrashear/507ex-utils2.git`
+2. Run: `pip install -r requirements.txt` in order to install the dependencies.
+3. Run the main script using `python3 fzx2.py`
+## CLI Usage
+`python3 fzx2.py <operation> <path>`
+All operations are listed below:
+1. exec: Executes an executable
+2. start_server: Starts the CAR server
+3. build: Builds an executable
+4. unpack: Unpacks an executable
+5. upload: Uploads an executable
+## 507ex's required files
+All directories that are going to be turned into a 507ex requires 2 files:
+1. runfile (contains the command to run the script)
+2. dependfile
+Dependfile is in this format
+~~~text
+!{name}|{command}
+!PLATFORM {platform}
+{dependencies}
+~~~
+## Demo Video
+https://drive.google.com/file/d/1QfDZL2Spc7WKqbfCU_m7xSnRLbJdnfNd/view?usp=sharing
+## AI Usage
+As per usual, I am against using AI in my code. All the code in this repository was human written. The instances of AI 
+usage was autocomplete and AI Assistant when I was stuck, pointing me in the right direction (fzx2.py).

fzx2-1.0.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+script/fzx2.py,sha256=3tTazvcqDiRoAEGaX7Aml72m5xUMUSYVT2t1C449luY,8217
+fzx2-1.0.0.dist-info/METADATA,sha256=NzalqP7Atu3gdTn_B10JwQ0_DOWnhXNYd8-KvAh_3ak,3251
+fzx2-1.0.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+fzx2-1.0.0.dist-info/entry_points.txt,sha256=E891uRz1tI50-cK3XnuBs2lQBBps07GsNomHnMW-O1o,42
+fzx2-1.0.0.dist-info/RECORD,,

fzx2-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

fzx2-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+fzx2 = script.fzx2:main

script/fzx2.py

@@ -0,0 +1,208 @@
+import argparse
+import hashlib
+import json
+import os
+import random
+import shutil
+import subprocess
+import sys
+import uuid
+import zipfile
+from datetime import datetime
+
+import requests
+from flask import Flask, request, send_from_directory
+from werkzeug.utils import secure_filename
+
+
+app = Flask(__name__)
+@app.route('/push', methods=['POST'])
+def push():
+    print(os.getcwd())
+    filename = secure_filename(request.form.get('file_id'))
+    with open(os.path.join("storage", f"{filename}.507ex"), 'wb') as f:
+        f.write(request.files['file'].read())
+    with open(os.path.join("storage", f"{filename}.json"), 'w') as f:
+        secret_code = random.randint(100000, 999999)
+        data = {
+            'secret_code': hashlib.sha256(str(secret_code).encode()).hexdigest(),
+        }
+        json.dump(data, f)
+    return {
+        'status': 'success',
+        'secret_code': str(secret_code),
+        'url': f'{request.url_root}pull/{filename}'
+    }
+
+@app.route('/pull/<file_id>', methods=['POST'])
+def pull(file_id):
+    try:
+        with open(os.path.join("storage", f"{file_id}.json"), 'r') as json_file:
+            codefile = json.load(json_file)
+            secret_code = codefile['secret_code']
+    except FileNotFoundError:
+        return 'File not found', 404
+    if request.form.get('secret_code') == secret_code:
+        return send_from_directory('storage', f"{file_id}.507ex", as_attachment=True)
+    else:
+        return 'Invalid secret code', 401
+#Alright. Lets rewrite this format!
+def build(directory: str):
+    #Check for a runfile in the directory
+    if not os.path.exists(os.path.join(directory, 'runfile')):
+        raise FileNotFoundError('No Runfile Detected!')
+    depend_file = False
+    if os.path.exists(os.path.join(directory, 'dependfile')):
+        depend_file = True
+        with open(os.path.join(directory, 'dependfile'), 'r') as f:
+            dependencies = f.read()
+    shutil.make_archive(directory, 'zip', directory)
+    os.rename(f"{directory}.zip", os.path.join(f"{directory}.507ex"))
+    with open (os.path.join(f"{directory}.507ex"), 'rb') as f:
+        exec_contents = f.read()
+    #Calculate hash
+    hashfunc = hashlib.new('blake2s')
+    with open(os.path.join(f"{directory}.507ex"), 'rb') as f:
+        while chunk := f.read(8192):
+            hashfunc.update(chunk)
+        exec_hash = hashfunc.hexdigest()
+
+    with open(os.path.join(f"{directory}.507ex"), 'wb') as f:
+        f.write("FZX2".encode())
+        f.write("\n!507EX-METADATA".encode())
+        f.write(f"\n507ex-hash|{exec_hash}".encode())
+        f.write(f"\n507ex-hashmode|blake2s".encode())
+        f.write(f"\n507ex-id|{uuid.uuid4()}".encode())
+        #DTOC - Date/Time of Creation
+        f.write(f"\n507ex-dtoc|{datetime.now().now()}".encode())
+        f.write(f"\n507ex-depends|{depend_file}".encode())
+        f.write(f"\n!507EX-DEPENDENCIES\n{dependencies}".encode())
+        f.write("\n!507EX-END-META\n".encode())
+        f.write(exec_contents)
+    print(f"Successfully built {directory}.507ex")
+
+def execute(path: str):
+    print(path)
+    current_path = os.getcwd()
+    reading_depends = False
+    has_depends = False
+    dependency_platform = ''
+    fromcar = False
+    #CAR Server logic
+    if path.startswith("http://") or path.startswith("https://"):
+        r = requests.post(path, data={'secret_code': hashlib.sha256(str(input("Please enter the secret code: \n")).encode()).hexdigest()})
+        if r.status_code == 401:
+            print("Your Secret Code is invalid!")
+        with open("tmp.507ex", 'wb') as f:
+            f.write(r.content)
+        fromcar = True
+        path = "tmp.507ex"
+    with open(path, 'rb') as f:
+        if f.readline() != b'FZX2\n':
+            raise ValueError('Invalid Executable!')
+        line_counter = 0
+        for line in f:
+            if line.startswith(b'!507EX-END-META'):
+                break
+            if line.startswith(b'507ex-hash|'):
+                exec_hash = line.split(b'|')[1].decode().replace('\n', '')
+            if line.startswith(b'507ex-hashmode'):
+                exec_hashmode = line.split(b'|')[1].decode().replace('\n', '')
+            if line.startswith(b'507ex-id'):
+                exec_id = line.split(b'|')[1].decode().replace('\n', '')
+            if line.startswith(b'507ex-depends'):
+                if line.split(b'|')[1].decode() == 'True\n':
+                    if input("Executable has dependencies that it wants to install. Continue? (y/n)\n").lower() == 'y':
+                        has_depends = True
+                    else:
+                        raise ValueError('Aborted!')
+                else:
+                    has_depends = False
+            if reading_depends:
+                if line.startswith(b'!') and not line.startswith(b'!PLATFORM'):
+                    command = line.split(b'|')[1].decode().replace('\n', '')
+                if dependency_platform == sys.platform or dependency_platform == '*':
+                    arg = line.decode().replace('\n', '')
+                    subprocess.run(f"{command} {arg}", shell=True, check=False)
+                if line.startswith(b'!PLATFORM'):
+                    dependency_platform = line.decode().replace('\n', '').replace('!PLATFORM ', '')
+            if line.startswith(b'!507EX-DEPENDENCIES'):
+                if has_depends:
+                    reading_depends = True
+            line_counter += 1
+    os.makedirs(os.path.join(current_path, '.fzx2-runtime', exec_id), exist_ok=True)
+    #Hash the executable
+    line_counter +=2
+    with open(path, 'rb') as f:
+        lines = b''.join(f.readlines()[line_counter:])
+        file_hash = hashlib.new(exec_hashmode, lines).hexdigest()
+    pass_hashcheck = False
+    if file_hash == exec_hash:
+        pass_hashcheck = True
+    else:
+        raise ValueError('Hash Verification Failed. Executable may have been damaged.')
+    os.chdir(os.path.join(current_path, '.fzx2-runtime', exec_id))
+    with zipfile.ZipFile(os.path.join(current_path, path), 'r') as zippy:
+        zippy.extractall()
+    with open("runfile", 'r') as runfile:
+        runfile_contents = runfile.read()
+    try:
+        subprocess.run(runfile_contents, shell=True, check=False)
+    except:
+        print("Exiting 507ex enviornment...")
+    #cleanup
+    os.chdir('..')
+    shutil.rmtree(os.path.join(current_path, '.fzx2-runtime', exec_id))
+    if fromcar:
+        os.remove(os.path.join(current_path, "tmp.507ex"))
+
+def upload(path: str):
+    if not os.path.exists(path):
+        raise FileNotFoundError('File not found!')
+    url = input("Please enter the server address: \n")
+    with open(path, 'rb') as f:
+        for line in f:
+            if line.startswith(b'507ex-id|'):
+                exec_id = line.split(b'|')[1].decode()
+                break
+    with open(path, 'rb') as f:
+        r = requests.post(f"{url}/push", files={'file': f}, data={'file_id': exec_id})
+    json_data = r.json()
+    print('Upload Complete!')
+    print(f"Upload URL: {json_data['url']}")
+    print(f"Your Secret Code Is: {json_data['secret_code']}")
+def unpack(path: str):
+    os.mkdir(path)
+    os.chdir(path)
+    with zipfile.ZipFile(path, 'r') as zippy:
+        zippy.extractall()
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument('mode', choices=['build', 'upload', 'exec', 'unpack', 'start_server'],
+                        help='The operation to perform.')
+    parser.add_argument('path', help='The path to the Executable or folder')
+    args = parser.parse_args(sys.argv[1:])
+    if args.mode == 'build':
+        build(args.path)
+    if args.mode == 'exec':
+        try:
+            execute(args.path)
+        except KeyboardInterrupt:
+            print("Exiting 507ex enviornment...")
+            if os.path.exists("tmp.507ex"):
+                os.remove(f"tmp.507ex")
+        except Exception as e:
+            print(f"An error occured while executing the executable: {e}")
+    if args.mode == 'upload':
+        upload(args.path)
+    if args.mode == 'unpack':
+        unpack(args.path)
+    if args.mode == 'start_server':
+        try:
+            os.mkdir(os.path.join('.', 'storage'))
+        except FileExistsError:
+            pass
+        app.run()
+if __name__ == '__main__':
+    main()