jprotect 0.1.0

Tool bao ve source code module Odoo theo huong an toan.

jProtect

Protect your Odoo module's business logic by extracting method bodies into compiled binaries (.so/.pyd) — the module still installs and runs normally on Odoo.

---

🔒 What It Does

jProtect takes an Odoo module and:

1. Keeps the public file intact — class definitions, fields, decorators, and _name/_inherit stay in place so Odoo registers the model normally.
2. Extracts method bodies into a hidden models/_protected/ package as standalone functions.
3. Replaces each method body with a thin delegation call to _protected.
4. Compiles _protected/ into .so/.pyd binaries (optional --compile flag).

The result: a module that looks and behaves exactly like the original — but the business logic is gone from the source files.

---

✨ Features

• 🔍 Dry-run mode — preview what will be protected before writing anything
• ⚙️ Selective protection — include/exclude files with glob patterns
• 🚀 Cython compilation — compile protected code to native binaries
• 🔄 super() rewriting — zero-arg super() is automatically rewritten to super(cls, self) so inheritance chains keep working
• 🛡️ Safe by default — skips dunders, @property, generators, __init__.py, migrations, and any pattern that could break Odoo

---

📦 Installation

Requires Python 3.10+. Cython is installed automatically.

pip install jprotect

When using --compile, a C compiler is also required:

• Linux: gcc + python3-dev
• Windows: MSVC Build Tools

---

🚀 Quick Start

Given a module at ./addons/sale_ext:

# Step 1 — Preview (no files written)
jprotect protect-module \
  --input ./addons/sale_ext \
  --output ./dist/dist/sale_ext \
  --dry-run

# Step 2 — Protect (extract logic, no compile)
jprotect protect-module \
  --input ./addons/sale_ext \
  --output ./dist/dist/sale_ext

# Step 3 — Protect + compile to binary
jprotect protect-module \
  --input ./addons/sale_ext \
  --output ./dist/dist/sale_ext \
  --compile

After running, jProtect generates a protection-manifest.json in the output directory listing every processed file.

---

🔍 How It Works

# ── Original file ────────────────────────────────────────────────
class SaleOrder(models.Model):
    _inherit = 'sale.order'

    def action_confirm(self):
        # your business logic here...
        return super().action_confirm()


# ── Public file after jProtect ───────────────────────────────────
from . import _protected

class SaleOrder(models.Model):
    _inherit = 'sale.order'

    def action_confirm(self):
        return _protected.sale_order.SaleOrder__action_confirm(self, SaleOrder)


# ── _protected/sale_order.py (or .so after --compile) ───────────
def SaleOrder__action_confirm(self, cls):
    # your business logic here...
    return super(cls, self).action_confirm()

Odoo sees the same class structure and registers the model exactly as before. The logic only lives inside the compiled binary.

---

⚙️ CLI Reference

jprotect protect-module --input <dir> --output <dir> [options]

Option	Description	Example
--input	Odoo module directory (must contain __manifest__.py)	--input ./addons/sale_ext
--output	Output directory	--output ./dist/dist/sale_ext
--mode	dist creates a copy (default); inplace modifies in place	--mode inplace
--dry-run	Scan and report only, no files written	--dry-run
--compile	Compile _protected/ to .so/.pyd	--compile
--include	Glob pattern for files to protect (repeatable, default: models/**/*.py)	--include "models/**/*.py" --include "utils/*.py"
--exclude	Glob pattern for files to exclude (repeatable)	--exclude "models/res_*.py"

---

🐳 Docker

Build once, run anywhere — useful for compiling binaries that match your Odoo server environment:

docker build -t jprotect .

docker run --rm \
  -v "$PWD/addons/sale_ext:/work/input:ro" \
  -v "$PWD/dist:/work/output" \
  jprotect protect-module \
    --input /work/input \
    --output /work/output/dist/sale_ext \
    --compile

---

⚠️ Important Notes

Binaries are environment-specific. A .so/.pyd file only runs on the exact Python version + OS + CPU architecture it was compiled on. You must build on an environment that matches your Odoo server.

Odoo Version	Python
16, 17, 18	3.10
14, 15	3.8

Always test on staging first. Install and upgrade the protected module on a staging Odoo database and run through the main flows before going to production.

---

🛡️ What Gets Protected

jProtect protects regular instance methods only. The following are intentionally left untouched:

Skipped	Reason
@staticmethod, @classmethod, @property	Different call semantics, cannot be safely delegated
Property setters/deleters (@x.setter, @x.deleter)	Setter return values are ignored by Python; wrapping changes semantics
Dunder methods (__init__, __str__, ...)	Called directly by Odoo/Python internals
Generator methods (contain yield)	Extracting a generator body breaks the iterator protocol
Methods with super() inside nested functions	super() without args relies on the declaring scope's __class__ cell
__init__.py, migrations/, controllers/	Breaking these would prevent Odoo from loading the module

---

🛠️ Development

Setup

git clone https://github.com/your-org/jprotect.git
cd jprotect

python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate

pip install -e ".[test]"

Run tests

pytest -q                          # all tests
pytest tests/unit/ -q              # unit tests only
pytest tests/integration/ -q       # integration tests only
pytest tests/unit/test_ast_transformer.py -v  # specific file

Project structure

src/jprotect/
├── cli/            # CLI entry point (argparse)
├── config/         # Config schema and loader
├── core/
│   ├── compile/    # Cython backend
│   ├── transform/  # Core AST transformation logic
│   │   ├── ast_transformer.py   # parse, extract, build delegation
│   │   └── transformer.py       # orchestrate transform over directory tree
│   ├── pipeline.py
│   └── ...
└── errors.py

tests/
├── unit/           # per-function tests with real source strings
└── integration/    # full pipeline tests on a fixture Odoo module

See docs/CODE_CONVENTIONS.md for coding conventions.

---

📄 License

PolyForm Noncommercial 1.0.0 — free for personal and noncommercial use. Commercial use requires a separate license from the author. See LICENSE.