Merge pull request #52 from RGBOARD/image-processing

Image Processing and Preview

Author: irsaris

README.md

@@ -1,3 +1,5 @@
+#### Running the Backend
+
 To run app.py:
 
 1. Create a virtual environment:
@@ -51,14 +53,34 @@ To run app.py:
 
 5. If you are on vscode, remember to set the python interpreter to the created environment's python version.
 
-6. After python env is ready, create the database in the root folder /backend: 
+6. After python env is ready, database must be created in the root folder (```/backend```): 
     ```sh
     python utilities/create.py 
     ```
 
-Now cd into the frontend:
-1. ```cd view```
-2. ```⁠npm install```
-3. ⁠Make sure the /backend is running in another terminal using: ```python app.py``` or ```flask run```
-4. ⁠Run frontend: ```npm run dev```
+7. Run the server (in its own terminal):
+    ```sh
+    python app.py
+    ```
+
+#### Running the Web App (Frontend)
+
+1. Navigate to the frontend directory (in its own terminal):
+   ```sh
+   cd view
+   ```
+
+2. Install dependencies:
+   ```sh
+   npm install
+   ```
+   
+3. Run the development server:
+   ```sh
+   npm run dev
+   ```
+
+#### After Sign Up and Log in
+1. **Without credentials file:** Open your database application and check the `VerificationCode` table to find the code associated with the newly created account.
 
+2. **With credentials file:** You should receive an email containing the verification code.

app.py

@@ -114,52 +114,64 @@ def handleUserById(user_id):
 
 
 # Design-----------------------------------------------------------------------------------------------------------
-
 @app.route("/design", methods=['POST'])
 @jwt_required()
 def upload_design():
     handler = Design(email=get_jwt_identity())
-    return handler.add_new_design(title=request.form.get('title'), files=request.files)
+    return handler.add_new_design(
+        title=request.form.get('title'), 
+        pixel_data=request.form.get('pixel_data')
+    )
+
+
+@app.route("/design/<int:design_id>/image", methods=['PUT'])
+@jwt_required()
+def update_design_image(design_id):
+    handler = Design(email=get_jwt_identity())
+    return handler.update_design_image(
+        design_id=design_id, 
+        pixel_data=request.form.get('pixel_data')
+    )
+
 
 @app.route("/design/<int:design_id>", methods=['GET'])
 @jwt_required()
 def get_design():
     handler = Design(email=get_jwt_identity())
     return handler.get_design(design_id=request.form.get('design_id'))
 
+
 @app.route("/design/<int:design_id>/title", methods=['PUT'])
 @jwt_required()
 def update_design_title():
     handler = Design(email=get_jwt_identity())
     return handler.update_design_title(design_id=request.form.get('design_id'), title=request.form.get('title'))
 
-@app.route("/design/<int:design_id>/image", methods=['PUT'])
-@jwt_required()
-def update_design_image():
-    handler = Design(email=get_jwt_identity())
-    return handler.update_design_image(design_id=request.form.get('design_id'), image=request.files.get('image'))
 
 @app.route("/design/<int:design_id>/approval", methods=['PUT'])
 @jwt_required()
 def update_design_approval(design_id):
     data = request.get_json()
     approval = data.get('approval')
-
     handler = Design(email=get_jwt_identity())
     return handler.update_design_approval(design_id=design_id, approval=approval)
+
+
 @app.route("/design/<int:design_id>/status", methods=['PUT'])
 @jwt_required()
 def update_design_status():
     handler = Design(email=get_jwt_identity())
     return handler.update_design_status(design_id=request.form.get('design_id'), status=request.form.get('status'))
 
+
 @app.route("/design/approved", methods=['GET'])
 @jwt_required()
 def get_approved_designs():
     handler = Design(email=get_jwt_identity())
     approved = handler.getApprovedDesigns()
     return jsonify(approved), 200
 
+
 #AdminAction-----------------------------------------------------------------------------------------------------------
 @app.route("/admin_action", methods=['GET', 'POST'])
 def handleAdminAction():
@@ -250,6 +262,8 @@ def get_queue_paginated():
 
     except Exception as e:
         return jsonify({'error': str(e)}), 500
+    
+    
 @app.route("/queue_item", methods=['GET', 'POST'])
 def handleQueueItem():
     if request.method == 'GET':

controller/design.py

@@ -1,5 +1,5 @@
+import json
 from flask import jsonify, request
-import base64
 from controller.user import User
 from model.design import DesignDAO
 
@@ -9,7 +9,7 @@ def serialize_design(t):
         'design_id': t[0],
         'user_id': t[1],
         'title': t[2],
-        'image': base64.b64encode(t[3]).decode('utf-8') if t[3] else None,
+        'pixel_data': t[3],
         'is_approved': t[4],
         'status': t[5],
         'created_at': t[6],
@@ -32,21 +32,25 @@ def __init__(self, email=None):
         if email:
             self.user = User(email=email)
 
-    def add_new_design(self, title=None, files=None):
-        if 'image' not in files:
-            return jsonify(error="No image file provided"), 400
+    def add_new_design(self, title=None, pixel_data=None):
+        if not pixel_data:
+            return jsonify(error="No pixel data provided"), 400
 
-        image_file = files['image']
-        if not image_file:
-            return jsonify(error="No image file provided"), 400
+        try:
+            # Parse the JSON to validate it, but store as string
+            json.loads(pixel_data)
+        except json.JSONDecodeError:
+            return jsonify(error="Invalid pixel data format"), 400
+        
+        if not title:
+            title = "Untitled Design"
 
         user_id = self.user.get_user_id()
         if user_id is None:
             return jsonify(error='User not found'), 404
-
-        image = image_file.read()
+        
         dao = DesignDAO()
-        new_id = dao.add_new_design(user_id, title, image)
+        new_id = dao.add_new_design(user_id, title, pixel_data)
 
         if isinstance(new_id, int) and new_id > 0:
             return jsonify(message="Design created", design_id=new_id), 201
@@ -100,9 +104,19 @@ def update_design_title(self, design_id, title):
         else:
             return jsonify(error="Unathorized."), 403
 
-    def update_design_image(self, design_id, image):
+    def update_design_image(self, design_id, pixel_data=None):
         if design_id is None:
             return jsonify(error="No id provided."), 400
+            
+        if not pixel_data:
+            return jsonify(error="No pixel data provided"), 400
+            
+        # Validate pixel_data is valid JSON
+        try:
+            # Parse the JSON to validate it, but store as string
+            json.loads(pixel_data)
+        except json.JSONDecodeError:
+            return jsonify(error="Invalid pixel data format"), 400
 
         user_id = self.user.get_user_id()
         if user_id is None:
@@ -112,21 +126,11 @@ def update_design_image(self, design_id, image):
         design_user_id = design_dao.get_user_id(design_id)
 
         if design_user_id == user_id or self.user.is_admin():
-
-            # TODO: Check that the user hasn't exceed capacity limits
-            ## Nothing stops the user from uploading a gamzillion bytes.
-            ## Sum up all images of the user in the system and make sure
-            ## it doesn't exceed some size, like 1MB of total images.
-
-            # TODO: Image Processing and Constraints
-            ## Transform the image to fit the board and return it to the user
-            ## once we get a 201. The view should show and ask if they like it.
-
-            response = design_dao.update_design_image(design_id, image)
+            response = design_dao.update_design_image(design_id, pixel_data)
             if response == 0:
-                return jsonify(message="Title updated."), 200
+                return jsonify(message="Design updated."), 200
             else:
-                return jsonify(error="Couldn't update title"), 500
+                return jsonify(error="Couldn't update design"), 500
         else:
             return jsonify(error="Unauthorized."), 403
 

controller/queue_item.py

@@ -1,11 +1,8 @@
 from flask import jsonify
-import base64
 from controller.user import User
-
 from model.queue_item import QueueItemDAO
 
 
-
 class QueueItem:
         def __init__(self, email=None):
             self.email = email
@@ -100,7 +97,7 @@ def getScheduledDesigns(self):
                     "display_order": row[5],
                     "scheduled": row[6],
                     "scheduled_at": row[7],
-                    "image": base64.b64encode(row[8]).decode('utf-8') if row[9] else None,
+                    "pixel_data": row[8],
                     "is_approved": row[9],
                     "design_created_at": row[10],
                     "design_updated_at": row[11]
@@ -124,7 +121,7 @@ def get_all_items_paginated(self, page, page_size):
                             "scheduled": item["scheduled"],
                             "scheduled_at": item["scheduled_at"],
                             "is_approved": item["is_approved"],
-                            "image": base64.b64encode(item["image"]).decode("utf-8"),
+                            "pixel_data": item["pixel_data"],
                             "title": item["title"]
                         })
 

controller/setting.py

@@ -1,7 +1,5 @@
 import json
-
 import flask
-
 from google_auth_oauthlib.flow import Flow
 
 

controller/user.py

@@ -3,7 +3,7 @@
 import json
 import random
 from datetime import datetime, timedelta, timezone
-from flask import jsonify, request
+from flask import jsonify
 from flask_jwt_extended import create_access_token
 
 import base64

model/design.py

@@ -38,11 +38,11 @@ def get_user_id(self, design_id: int):
         finally:
             cursor.close()
 
-    def add_new_design(self, user_id, title, image):
+    def add_new_design(self, user_id, title, pixel_data):
         cursor = self.conn.cursor()
-        query = "INSERT INTO design (user_id, title, image) VALUES (?, ?, ?);"
+        query = "INSERT INTO design (user_id, title, pixel_data) VALUES (?, ?, ?);"
         try:
-            cursor.execute(query, (user_id, title, image))
+            cursor.execute(query, (user_id, title, pixel_data))
             self.conn.commit()
             new_id = cursor.lastrowid
             return new_id
@@ -68,13 +68,13 @@ def update_design_title(self, design_id: int, title: str):
             cursor.close()
             return status
 
-    def update_design_image(self, design_id: int, image):
+    def update_design_image(self, design_id: int, pixel_data):
         status = 1
         cursor = self.conn.cursor()
-        query = "UPDATE design SET image = ?, updated_at = CURRENT_TIMESTAMP WHERE design_id = ?"
+        query = "UPDATE design SET pixel_data = ?, updated_at = CURRENT_TIMESTAMP WHERE design_id = ?"
 
         try:
-            cursor.execute(query, (image, design_id))
+            cursor.execute(query, (pixel_data, design_id))
             self.conn.commit()
             status = 0
         except sqlite3.Error:

model/queue_item.py

@@ -116,7 +116,7 @@ def getScheduledDesigns(self):
                    q.display_order,
                    q.scheduled,
                    q.scheduled_at,
-                   d.image,
+                   d.pixel_data,
                    d.is_approved,
                    d.created_at,
                    d.updated_at
@@ -148,7 +148,7 @@ def get_all_items_paginated(self, page, page_size):
                    q.display_order,
                    q.scheduled,                  
                    q.scheduled_at,
-                   d.image,
+                   d.pixel_data,
                    d.title,
                    d.is_approved
             FROM queue_item q

utilities/create.py

@@ -1,6 +1,6 @@
 import sqlite3
 
-con = sqlite3.connect('../data.db')
+con = sqlite3.connect('data.db')
 cur = con.cursor()
 
 cur.execute("""
@@ -34,7 +34,7 @@
         design_id   INTEGER PRIMARY KEY AUTOINCREMENT,
         user_id     INTEGER  NOT NULL,
         title       TEXT     NOT NULL,
-        image       BLOB     NOT NULL,
+        pixel_data   TEXT     NOT NULL, -- Changed to pixel_data since conversion is client-side
         is_approved BOOLEAN  NOT NULL DEFAULT 1,
         status      BOOLEAN  NOT NULL DEFAULT 0,
         created_at  DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,