"Update system"

Signed-off-by: Emmanuel Frimpong Asante <[email protected]>

.gitignore

@@ -1,3 +1,5 @@
 # created by virtualenv automatically
 .idea
+.env
+.git
 

app.py

@@ -1,3 +1,5 @@
+# app.py
+
 import os
 import tensorflow as tf
 from pymongo import MongoClient

auth/auth_controller.py

@@ -1,20 +1,13 @@
+# auth/auth_controller.py
+
 import bcrypt
 import jwt
 import datetime
-from pymongo import MongoClient
 from bson.objectid import ObjectId
 from flask import jsonify, request
 from functools import wraps
-from config.db import db
-
-# MongoDB setup (this should be moved to config/db.py and imported here)
-client = MongoClient("your_mongo_uri")  # Replace with your MongoDB URI
-db = client.poultry_farm  # Your database name
-users_collection = db.users  # Collection for storing user information
-
-# Secret key for JWT (move to config/settings.py and import here)
-SECRET_KEY = "your_secret_key"  # Replace with a secure secret key
-
+from config.db import users_collection  # Importing the users collection from the database config
+from config.settings import SECRET_KEY  # Import the secret key from settings
 
 # JWT decorator to protect routes
 def token_required(f):
@@ -28,10 +21,11 @@ def token_required(f):
         try:
             data = jwt.decode(token, SECRET_KEY, algorithms=["HS256"])
             current_user = users_collection.find_one({"_id": ObjectId(data["user_id"])})
-        except:
+        except jwt.ExpiredSignatureError:
+            return jsonify({'message': 'Token has expired!'}), 401
+        except jwt.InvalidTokenError:
             return jsonify({'message': 'Token is invalid!'}), 401
         return f(current_user, *args, **kwargs)
-
     return decorated
 
 
@@ -46,7 +40,7 @@ def register():
         return jsonify({"message": "User already exists"}), 400
 
     # Hash the password
-    hashed_password = bcrypt.hashpw(data['password'].encode('utf-8'), bcrypt.gensalt())
+    hashed_password = bcrypt.hashpw(data['password'].encode('utf-8'), bcrypt.gensalt()).decode('utf-8')
 
     # Create user document
     new_user = {
@@ -73,7 +67,7 @@ def login():
         return jsonify({"message": "User not found"}), 404
 
     # Verify password
-    if bcrypt.checkpw(data['password'].encode('utf-8'), user['password']):
+    if bcrypt.checkpw(data['password'].encode('utf-8'), user['password'].encode('utf-8')):
         # Create JWT token
         token = jwt.encode({
             'user_id': str(user['_id']),
@@ -85,7 +79,7 @@ def login():
         return jsonify({"message": "Invalid password"}), 401
 
 
-# Get user info (example of a protected route)
+# Get user info (protected route)
 @token_required
 def get_user_info(current_user):
     user_info = {

auth/auth_routes.py

@@ -1,11 +1,14 @@
+# auth/schemas/auth_routes.py
+
 from flask import Blueprint
 from .auth_controller import register, login, get_user_info, update_user_info, delete_user
+from flask import jsonify
 
 # Create a Blueprint for auth-related routes
 auth_bp = Blueprint('auth', __name__)
 
-
 # Define the routes
+
 @auth_bp.route('/register', methods=['POST'])
 def register_user():
     """
@@ -16,6 +19,9 @@ def register_user():
         "password": "password123",
         "role": "user"  # Optional, default is "user"
     }
+    Returns:
+        - Success message and user ID if successful (201 Created)
+        - Error message if user already exists or invalid request (400 Bad Request)
     """
     return register()
 
@@ -29,6 +35,9 @@ def login_user():
         "username": "user1",
         "password": "password123"
     }
+    Returns:
+        - JWT token if login is successful (200 OK)
+        - Error message if credentials are incorrect or user not found (401 Unauthorized / 404 Not Found)
     """
     return login()
 
@@ -38,6 +47,9 @@ def get_user_details():
     """
     Route for getting the authenticated user's information.
     Requires the JWT token in the `x-access-token` header.
+    Returns:
+        - User information such as username, role, and creation date (200 OK)
+        - Error message if the token is missing or invalid (401 Unauthorized)
     """
     return get_user_info()
 
@@ -54,6 +66,9 @@ def update_user():
         "role": "manager"  # Optional, can be "user" or "manager"
     }
     Requires the JWT token in the `x-access-token` header.
+    Returns:
+        - Success message if update is successful (200 OK)
+        - Error message if the user is not found or permission is denied (403 Forbidden / 404 Not Found)
     """
     return update_user_info()
 
@@ -68,5 +83,8 @@ def remove_user():
         "user_id": "the user's MongoDB ObjectId"
     }
     Requires the JWT token in the `x-access-token` header.
+    Returns:
+        - Success message if deletion is successful (200 OK)
+        - Error message if the user is not found or permission is denied (403 Forbidden / 404 Not Found)
     """
     return delete_user()

auth/schemas/user_schema.py

@@ -1,10 +1,9 @@
-from pymongo import MongoClient
-from bson.objectid import ObjectId
+# auth/schemas/user_schemas.py
 
-# MongoDB connection (move to config/db.py and import here if needed)
-client = MongoClient("your_mongo_uri")  # Replace with your MongoDB URI
-db = client.poultry_farm  # Your database name
-users_collection = db.users  # Collection for users
+from bson.objectid import ObjectId
+import datetime
+from config.db import users_collection  # Import the users collection from config/db
+import bcrypt
 
 
 # Define the User Schema
@@ -18,7 +17,7 @@ class User:
         :param role: String, user role (either 'user' or 'manager'), default is 'user'
         """
         self.username = username
-        self.password = password
+        self.password = password  # Password should be hashed
         self.role = role
         self.created_at = datetime.datetime.utcnow()  # Store account creation time
 
@@ -29,7 +28,7 @@ class User:
         """
         return {
             "username": self.username,
-            "password": self.password,  # Password should be hashed before storing
+            "password": self.password,  # Ensure the password is hashed
             "role": self.role,
             "created_at": self.created_at
         }
@@ -37,15 +36,27 @@ class User:
 
 # CRUD Operations for User Schema
 
-def create_user(username, hashed_password, role="user"):
+def hash_password(password):
+    """
+    Hashes a plain-text password using bcrypt.
+
+    :param password: String, plain-text password
+    :return: Hashed password
+    """
+    hashed_password = bcrypt.hashpw(password.encode('utf-8'), bcrypt.gensalt())
+    return hashed_password.decode('utf-8')
+
+
+def create_user(username, plain_password, role="user"):
     """
     Create a new user in the MongoDB collection.
 
     :param username: String, the username for the user
-    :param hashed_password: String, the hashed password of the user
+    :param plain_password: String, the plain-text password of the user (will be hashed)
     :param role: String, role of the user (either 'user' or 'manager'), default is 'user'
     :return: Inserted user's ID (MongoDB ObjectId)
     """
+    hashed_password = hash_password(plain_password)
     user = User(username=username, password=hashed_password, role=role)
     user_id = users_collection.insert_one(user.to_dict()).inserted_id
     return str(user_id)
@@ -97,13 +108,12 @@ def delete_user(user_id):
     return result.deleted_count > 0
 
 
-# Example function to create a sample user
-if __name__ == "__main__":
-    # Hash a sample password (this should be done with bcrypt before passing into this function)
-    sample_username = "sample_user"
-    sample_hashed_password = "hashed_password_here"  # Use bcrypt to hash passwords
-    sample_role = "user"
+def check_password(plain_password, hashed_password):
+    """
+    Check if a plain-text password matches a hashed password.
 
-    # Insert a sample user into the database
-    user_id = create_user(sample_username, sample_hashed_password, sample_role)
-    print(f"User created with ID: {user_id}")
+    :param plain_password: String, plain-text password
+    :param hashed_password: String, hashed password stored in the database
+    :return: Boolean, True if passwords match, False otherwise
+    """
+    return bcrypt.checkpw(plain_password.encode('utf-8'), hashed_password.encode('utf-8'))

config/db.py

@@ -1,15 +1,15 @@
+# config/db.py
+
 from pymongo import MongoClient
 import os
-
-# Load environment variables (if using environment files like .env)
 from dotenv import load_dotenv
 
-# Load the .env file (ensure that it's present in the project root)
+# Load environment variables from a .env file
 load_dotenv()
 
-# MongoDB URI (retrieved from environment variables)
-MONGO_URI = os.getenv("MONGO_URI", "mongodb://localhost:27017")  # Default fallback URI for local MongoDB
-DB_NAME = os.getenv("DB_NAME", "poultry_farm")  # Default database name if not specified in environment
+# MongoDB URI and Database name (retrieved from environment variables)
+MONGO_URI = os.getenv("MONGO_URI", "mongodb://localhost:27017")  # Fallback to local MongoDB if not set
+DB_NAME = os.getenv("DB_NAME", "poultry_farm")  # Fallback database name if not set
 
 # Initialize MongoDB client
 client = MongoClient(MONGO_URI)
@@ -31,16 +31,3 @@ try:
     print(f"Connected to MongoDB database: {DB_NAME}")
 except Exception as e:
     print(f"Error connecting to MongoDB: {e}")
-
-# Example usage of collections
-if __name__ == "__main__":
-    # Insert a test document into the users collection
-    test_user = {
-        "username": "admin",
-        "password": "hashed_password",  # In practice, you would hash the password using bcrypt
-        "role": "manager",
-        "created_at": datetime.datetime.utcnow()
-    }
-
-    result = users_collection.insert_one(test_user)
-    print(f"Inserted test user with ID: {result.inserted_id}")

config/settings.py

@@ -1,11 +1,13 @@
+# config/settings.py
+
 import os
 from dotenv import load_dotenv
 
 # Load environment variables from .env file
 load_dotenv()
 
-# Secret Key for JWT encoding/decoding
-SECRET_KEY = os.getenv("SECRET_KEY", "your_default_secret_key")  # Replace with a strong default or pull from .env
+# Secret key for JWT encoding/decoding
+SECRET_KEY = os.getenv("SECRET_KEY", "your_secret_key")  # Use an environment variable for security
 
 # MongoDB connection settings
 MONGO_URI = os.getenv("MONGO_URI", "mongodb://localhost:27017")  # Default to local MongoDB if not set
@@ -22,7 +24,7 @@ EMAIL_USE_TLS = bool(os.getenv("EMAIL_USE_TLS", True))
 EMAIL_HOST_USER = os.getenv("EMAIL_HOST_USER", "[email protected]")
 EMAIL_HOST_PASSWORD = os.getenv("EMAIL_HOST_PASSWORD", "your_email_password")
 
-# Logging settings (if any log levels or formats are configured)
+# Logging settings
 LOG_LEVEL = os.getenv("LOG_LEVEL", "INFO")  # Log level: DEBUG, INFO, WARNING, ERROR, CRITICAL
 
 # Example external APIs (if required for additional services)
@@ -31,5 +33,7 @@ EXTERNAL_API_KEY = os.getenv("EXTERNAL_API_KEY", "your_default_api_key")
 # Path settings (if needed for file uploads or storage)
 UPLOAD_FOLDER = os.getenv("UPLOAD_FOLDER", "/path/to/uploads")
 
-# Define any other global settings here
+# Global pagination settings for APIs
 PAGINATION_LIMIT = int(os.getenv("PAGINATION_LIMIT", 10))  # Default pagination limit for listing endpoints
+
+# Other potential global settings can be added here as needed

controllers/data_logging.py

@@ -1,12 +1,13 @@
+# controllers/data_logging.py
+
 from flask import request, jsonify
 from models.schemas.log_schema import create_log
 from models.schemas.health_schema import create_health_record
 from models.schemas.inventory_schema import create_inventory_item, update_inventory_item
 from models.schemas.usage_schema import create_usage_record
-import datetime
 
 
-# Log an action performed by the user (general logging)
+# Log a general user action (e.g., a user performs an action in the system)
 def log_user_action(user_id, message, level="INFO", metadata=None):
     """
     Logs a general user action.
@@ -18,14 +19,14 @@ def log_user_action(user_id, message, level="INFO", metadata=None):
     :return: JSON response indicating success or failure.
     """
     try:
-        ip_address = request.remote_addr  # Get the IP address from the request
+        ip_address = request.remote_addr  # Get the user's IP address from the request
         log_id = create_log(level, message, metadata, ip_address, user_id)
         return jsonify({"message": "Action logged successfully", "log_id": log_id}), 201
     except Exception as e:
         return jsonify({"error": str(e)}), 500
 
 
-# Log a health record for a poultry
+# Log a health record for a poultry bird
 def log_health_record(user_id, poultry_id, disease_name, status, recommendation, image_path=None):
     """
     Logs a health record for a poultry bird.
@@ -40,7 +41,7 @@ def log_health_record(user_id, poultry_id, disease_name, status, recommendation,
     """
     try:
         record_id = create_health_record(user_id, poultry_id, disease_name, status, recommendation, image_path)
-        # Log the action
+        # Log the health record creation action
         log_message = f"Health record created for poultry ID {poultry_id} - Disease: {disease_name}"
         log_user_action(user_id, log_message, "INFO")
         return jsonify({"message": "Health record logged successfully", "record_id": record_id}), 201
@@ -48,7 +49,7 @@ def log_health_record(user_id, poultry_id, disease_name, status, recommendation,
         return jsonify({"error": str(e)}), 500
 
 
-# Log an inventory addition
+# Log an addition to the inventory
 def log_inventory_addition(user_id, item_name, category, quantity, unit, description=None):
     """
     Logs an inventory addition (e.g., adding feed, medicine).
@@ -63,7 +64,7 @@ def log_inventory_addition(user_id, item_name, category, quantity, unit, descrip
     """
     try:
         item_id = create_inventory_item(item_name, category, quantity, unit, user_id, description=description)
-        # Log the action
+        # Log the inventory addition action
         log_message = f"Inventory item added: {item_name}, Quantity: {quantity} {unit}"
         log_user_action(user_id, log_message, "INFO")
         return jsonify({"message": "Inventory item logged successfully", "item_id": item_id}), 201
@@ -71,7 +72,7 @@ def log_inventory_addition(user_id, item_name, category, quantity, unit, descrip
         return jsonify({"error": str(e)}), 500
 
 
-# Log an inventory update (e.g., usage or adjustments)
+# Log updates to an inventory item (e.g., usage or quantity adjustment)
 def log_inventory_update(user_id, item_id, updated_fields):
     """
     Logs an update to an inventory item (e.g., when quantity is used).
@@ -84,7 +85,7 @@ def log_inventory_update(user_id, item_id, updated_fields):
     try:
         update_success = update_inventory_item(item_id, updated_fields)
         if update_success:
-            # Log the action
+            # Log the inventory update action
             log_message = f"Inventory item updated: {item_id} - {updated_fields}"
             log_user_action(user_id, log_message, "INFO")
             return jsonify({"message": "Inventory item updated successfully"}), 200
@@ -94,7 +95,7 @@ def log_inventory_update(user_id, item_id, updated_fields):
         return jsonify({"error": str(e)}), 500
 
 
-# Log assistant usage
+# Log assistant usage by a user
 def log_assistant_usage(user_id, manager_id, interaction_type, metadata=None):
     """
     Logs the usage of the assistant by a user.
@@ -107,7 +108,7 @@ def log_assistant_usage(user_id, manager_id, interaction_type, metadata=None):
     """
     try:
         usage_record_id = create_usage_record(user_id, manager_id, interaction_type, metadata)
-        # Log the action
+        # Log the assistant usage action
         log_message = f"Assistant interaction logged: {interaction_type} by user {user_id}"
         log_user_action(user_id, log_message, "INFO", metadata)
         return jsonify({"message": "Assistant usage logged successfully", "usage_record_id": usage_record_id}), 201

controllers/health_management.py

@@ -1,3 +1,5 @@
+# controllers/health_management.py
+
 from flask import request, jsonify
 from models.schemas.health_schema import create_health_record, get_health_record_by_id, get_health_records_by_user
 from services.disease_detection import detect_disease

controllers/inventory.py

@@ -1,3 +1,5 @@
+# controllers/inventory.py
+
 from flask import request, jsonify
 from models.schemas.inventory_schema import create_inventory_item, update_inventory_item, get_inventory_item_by_id, \
     get_all_inventory_items

controllers/usage_tracking.py

@@ -1,3 +1,5 @@
+# controllers/usage_tracking.py
+
 from flask import request, jsonify
 from models.schemas.usage_schema import create_usage_record, get_usage_by_user, get_usage_by_manager, \
     get_usage_by_interaction_type

data/logs/daily_logs.py

@@ -1,3 +1,5 @@
+# data/logs/daily_logs.py
+
 from pymongo import MongoClient
 from bson.objectid import ObjectId
 import datetime

data/logs/user_usage.py

@@ -1,3 +1,5 @@
+# data/logs/user_usage.py
+
 from pymongo import MongoClient
 from bson.objectid import ObjectId
 import datetime

models/schemas/health_schema.py

@@ -1,3 +1,5 @@
+# models/schemas/health_schema.py
+
 from pymongo import MongoClient
 from bson.objectid import ObjectId
 import datetime

models/schemas/inventory_schema.py

@@ -1,3 +1,6 @@
+# models/schemas/inventory_schema.py
+
+
 from pymongo import MongoClient
 from bson.objectid import ObjectId
 import datetime

models/schemas/log_schema.py

@@ -1,3 +1,6 @@
+# models/schemas/log_schema.py
+
+
 from pymongo import MongoClient, IndexModel, ASCENDING
 from bson.objectid import ObjectId
 import datetime

models/schemas/usage_schema.py

@@ -1,3 +1,6 @@
+# models/schemas/usage_schema.py
+
+
 from pymongo import MongoClient
 from bson.objectid import ObjectId
 import datetime

requirements.txt

@@ -16,6 +16,7 @@ opencv-python
 flask
 pymongo
 bson
+bcrypt
 
 # Gradio Interface for the Chatbot
 gradio

routes/api.py

@@ -1,3 +1,5 @@
+# routes/api.py
+
 from flask import Blueprint, jsonify, request
 from controllers.health_management import detect_and_log_disease, get_health_record, get_health_records_for_user
 from controllers.inventory import add_inventory_item, update_inventory_item_by_id, get_inventory_by_id, \

routes/data_logging_routes.py

@@ -1,3 +1,6 @@
+# routes/data_logging_routes.py
+
+
 from flask import Blueprint, request, jsonify
 from controllers.data_logging import log_user_action, log_health_record, log_inventory_addition, log_inventory_update, \
     log_assistant_usage

routes/health_routes.py

@@ -1,3 +1,5 @@
+# routes/health_routes.py
+
 from flask import Blueprint, request, jsonify
 from controllers.health_management import detect_and_log_disease, get_health_record, get_health_records_for_user
 

routes/inventory_routes.py

@@ -1,3 +1,6 @@
+# routes/inventory_routes.py
+
+
 from flask import Blueprint, request, jsonify
 from controllers.inventory import add_inventory_item, update_inventory_item_by_id, get_inventory_by_id, \
     get_all_inventory

routes/usage_routes.py

@@ -1,3 +1,5 @@
+# routes/usage_routes.py
+
 from flask import Blueprint, request, jsonify
 from controllers.usage_tracking import log_usage, get_usage_for_user, get_usage_for_manager, get_usage_by_type
 

services/disease_detection.py

@@ -1,3 +1,5 @@
+# services/disease_detection.py
+
 import cv2
 import numpy as np
 from keras.models import load_model

services/gradio_interface.py

@@ -1,3 +1,6 @@
+# services/gradio_interface.py
+
+
 import gradio as gr
 from services.disease_detection import PoultryFarmBot
 from services.llama_service import llama2_response

services/inventory_manager.py

@@ -1,3 +1,6 @@
+# services/inventory_manager.py
+
+
 from pymongo import MongoClient
 from bson.objectid import ObjectId
 import datetime

services/llama_service.py

@@ -1,3 +1,6 @@
+# services/llama_service.py
+
+
 from transformers import AutoModelForCausalLM, AutoTokenizer
 
 # Load Llama 3.2 model and tokenizer for text generation

services/report_generator.py

@@ -1,3 +1,6 @@
+# services/report_generator.py
+
+
 from pymongo import MongoClient
 from bson.objectid import ObjectId
 import pandas as pd

services/usage_tracker.py

@@ -1,3 +1,5 @@
+# services/usage_tracker.py
+
 from pymongo import MongoClient
 from bson.objectid import ObjectId
 import datetime