masterzydra / bio-manager

A web-based ERP system specifically adapted to the needs of managing certified organic land.

Hi there 👋

• 📫 How to reach me: davidhein.de or techbasics.de
• 🧰 I like to automate repetitive tasks as far as possible

Interests
PHP (Magento2, Laravel)   -   CI/CD (Docker, Kubernetes, Azure Pipelines, GitHub Actions)   -   Software Architecture

Completed projects
✅ Created my own programming language
✅ Created my own PHP framework
👷 Creating my own PHP interpreter

Latest articles on Techbasics.de

• Ubuntu - WireGuard installieren und einrichten
• Docker

bio-manager's Issues

Fixed pricing in invoice

In the current version the price per unit is statically saved in showInvoice.php.

Prevent delete and edit operations of used entries

Supplier, etc. can be deleted even if they are assigned to a delivery note, etc.
This should not be possible.

=> Add a check if "object" is used.

Idea: BaseModel calls function "allow[Delete|Edit]" if it is implemented. In this function the checks can be implemented for each entity.

• Implement logic in base model to call "allow" function and prevent action if return value is false
• Implement "allow" functions
  • Delivery note
  • Plot
  • Invoice
  • Product
  • Price
  • Supplier
  • Recipient
• Add message box if entity cannot be edited based on "allowEdit" e.g. for invoice, delivery note

Show only payments for delivery notes, which are in an selected invoice

The user can choose an invoice and see the payments for this specific invoice.

Validation: If a product is assigned to a delivery note and there is no price for this year

Show warning/error?

Verify with JS in frontend if IBAN is valid

https://www.hettwer-beratung.de/sepa-spezialwissen/sepa-kontoverbindungsdaten/iban-pr%C3%BCfziffer-berechnung/

Change hashing algorithm

Use more secure hashing algorithm.

Check if bcrypt exists in PHP.

Add support for SQLite

Support SQLite as DB driver

SQLite syntax for creating tables differs from MySQL/MariaDB.

Tasks:

• Creating tables (#61)
• Add ResultInterface
• Add wrapper for SQLite3 PHP class
• Allow chaining for CreateTableBlueprint functions
• Rewrite migrations with CreateTableBlueprint
• Change make:migration command to use CreateTableBlueprint
• Test all views with production data
• Update documentation

Use Gateway design pattern to encapsulate database queries

Class to get all fields and methods like findById, ...

find (id) : RecordSet
findWithLastName(String) : RecordSet
update (id, lastname, firstname, numberOfDependents)
insert (lastname, firstname, numberOfDependents)
delete (id)

---

Add wrapper around the database module, so that the forms themselves do only use the objects e.g. supplier, invoice, delivery note ...
These classes contain the logic to select, update, insert or delete entries.
The classes handle the SQL queries (prepared statements) and additional permission handling.

---

Permission layer / component:
Idea is to create a component or layer that handles all permissions. So a central configuration for permissions is required.
This component could be made configurable via a form, so every admin can configure permissions as required.
This component has to contain a list of areas (invoice, delivery note, ...) with a set of operations (add, edit, delete, view, ...) for each permission group (admin, maintainer, auditor, ...).
Idea:

• Form to create groups and manage the users in that group.
• In the permission configurator each group gets areas with permissions assigned.
• A user can be in multiple groups.
• The default for a new group is the denial of all areas. If the requirement is that every user can see the delivery notes, a default group with that permission needs to be created and every user added to it.

---

Directory structure:

modules/
   dataObjects/
      deliveryNote.php
      supplier.php
      product.php
      ...

---

Abstract class / interface DataObject
All classes are inherited from this. -> The RecordSet (Array) can contain this objects and can be used for all of them.

Add statistic to get the payments for the suppliers

(Like in the responding excel sheet)

Goal is to further automate the necessary documents.

Separate application and framework code

• Move models User, Role, Setting in Framework folder
• Store app version number in a constant in the application folder

Revise and extend doc

Add more details about:

• the application code
• the framework
• the installation of the system
• How to run the docker image

Update GitHub Actions dependencies

build
Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: vlaurin/[email protected]. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.

UI Update

• Icons: Instead of using text e.g. "edit" an pen icon could be used.
• Better way than boxes?

Upgrade to work with PHP 8.1

• TCPDF

Version 2 - Router, Namespaces and new directory structure

Router example: https://steampixel.de/einfaches-und-elegantes-url-routing-mit-php/

Do a complete rebuild with a Laravel like architecture

The framework is fundamentally working. Now all previous logic must be rewritten:

• Readd entities (plot, supplier, etc.)
• PDF generation
  • wrapper for TCPDF
    • Uncaught error no. 2 in /var/www/html/ext/TCPDF/tcpdf_autoconfig.php:96 - Message file_exists(): open_basedir restriction in effect. File(/usr/share/doc/php-tcpdf/examples/images/) is not within the allowed path(s): (/var/www/html:/dev/stdout:/tmp)
  • Invoice
    • Add link to index table
    • Use currencyUnit setting
  • Active suppliers
  • Supplier payouts
  • Volume distribution
• Missing forms:
  • Edit imprint settings
  • Edit invoice settings
• Show massUnit in delivery note form
• Permission checks

With release of v2.0.0:

• Remove branch "refactor"

Show recommendations for plot subdistrict

https://www.geeksforgeeks.org/how-to-display-suggestions-for-input-field-in-html/

Statistic for price development

Table and chart

Formatting table content

Show booleans as "Yes"/"No" instead of 1/0. Align number right in cell.

• Add logic to table generator function

Fix files using new logic:

• deliveryNote.php
• evalDeliveryNote_OpenVolumeDistribution.php
• overviewForm.php
• pricing.php
• showMyDeliveryNote.php

After that

• Delete formatTableCellRight.js

Unique entries

Check if entry is unique before adding it to table.

• user
• supplier
• setting
• product
• pricing
• plot
• invoice (not necessary)
• deliveryNote (not necessary)

Use namespaces

Namespaces are used only inside the system folder for now.
The classes in the Module folder need to be moved to the system folder.

Add function to remove leading spaces on the beginning of each line

Function name: removeLeadingLineSpaces
Useful e.g. PDF rendering so that the HTML and PHP can contain indentations without influencing the rendered result

Changes in render method required:
After getting the rendered HTML, pass it to "removeLeadingLineSpaces" and return result

Show only payments for delivery notes, which are in an invoice

Add statistics to Wiki

Statistics are missing in Wiki Berechtigung.

Schema builder for migrations

This schema builder class should make support for other DB systems easier.

The class generates the SQL depending on the current database connection configuration.

Syntax:

$table = new CreateTableBlueprint();
$table->id();
$table->string('name', 255);
$table->build(); // Return SQL

Encapsulation of logic to create PDF for more flexible use

Files:
modules/invoice.php
showInvoice.php

Only show form in edit page if an entry was found

Currently an empty form will be shown if no data was found for the given id.

Crop volume distribution

Check if a SQLi or XSS could be executed with this form

Fix PSR12 errors and warnings

• Class name "..." is not in PascalCase format
• Visibility must be declared on method "..."
• Visibility must be declared on method "__construct"
• Line exceeds 120 characters
• Parenthesis placement

Simplify user creation on installation

V1: If no user exists in the database, link a form to create a user (see init DB Connection).

V2: First user should be created by a seeder in the migration after creating the user table

Add statistics / finance area

Add an new area for statistics and for finances.

New functions:
The data can be shown in a table and in a diagram (usually line diagram) (https://github.com/chartjs/Chart.js).

• Revenue per year (DE: Umsatz)
• Payouts per year (DE: Auszahlungen)
• Profit per year (DE: Gewinn)

Add sum of amount to crop volume distribution

The amount is needed for the control of the certification authority

Small improvements for version 2

v2.0.1

• Address output in recipients table: Use comma as separator between street and postal code
• Date output in tables: Format with new format function Format::date() to "dd.mm.yyyy"
• Volume distribution: Only show plots in plotSelect, that belong to the supplier of the delivery note
• Translation method "__()": add optional args for placeholders. Basicly add "sprintf" if optional args are passed

More functionality for invoices

• Deleting an invoice
• Editing an invoice
  • Mark invoice as paid

Use secure string function to prevent XSS and HTML special characters

• about.php
• addDeliveryNote.php
• addInvoice.php
• addPlot.php
• addPricing.php
• addProduct.php
• addRecipient.php
• addSetting.php
• addSupplier.php
• addUser.php
• changePwd.php
• changeUserPwd.php
• deleteDeliveryNote.php
• deleteInvoice.php
• deletePlot.php
• deletePricing.php
• deleteProduct.php
• deleteRecipient.php
• deleteSetting.php
• deleteSupplier.php
• deleteUser.php
• deliveryNote.php
• developerOptions.php
• editCropVolumeDistribution.php
• editDeliveryNote.php
• editImpressum.php
• editInvoice.php
• editInvoiceData.php
• editPlot.php
• editPricing.php
• editProduct.php
• editRecipient.php
• editSetting.php
• editSupplier.php
• editUser.php
• evalDeliveryNote_OpenVolumeDistribution.php
• impressum.php
• index.php
• invoice.php
• login.php
• logout.php
• plot.php
• pricing.php
• product.php
• recipient.php
• setting.php
• showInvoice.php
• showMyDeliveryNote.php
• supplier.php
• user.php

./install:

• addAdminUser.php

./modules:

• Mysql.php
• Mysql_BioManager.php
• Mysql_preparedStatement.php
• Mysql_preparedStatement_BioManager.php
• cache.php
• dataTable.php
• dataTable_BioManager.php
• footer.php
• formHelper.php
• header.php
• header_everyone.php
• header_user.php
• invoice.php
• permissionCheck.php
• selectBox.php
• selectBox_BioManager.php
• stringSecurityHelper.php
• tableGenerator.php

./templates:

• deleteForm.php
• form.php
• overviewForm.php

Dev-Tool: Show SQL queries

Re-add developer feature to show the executed SQL queries

Move new statistics from developer area to statistic area

• Statistik - Offene Verteilungen
• Statistik - Verteilungsübersicht

Dev Tools: Add possibility to set dev mode for current user

e.g. by storing it in session

Crop volume distribution NaN if one field is empty

In the crop volume distribution the calculated sum is NaN if one file is an empty string.

Idea:
Add check if string == "" and set to "0"

Default sort order

Add property of type array that can be used to define the default sort order.
So that the table views, selects, ... are sorted that way.

• Extend BaseModel to support default sort orders
  If not other order is given via QueryBuilder, use default.
• Add default order to entities
  • DeliveryNote: year DESC, nr DESC
  • Invoice: year DESC, nr DESC
  • Plot: nr ASC
  • Price
  • Product
  • Recipient
  • Setting: name ASC
  • Supplier: name ASC
  • User: username ASC
  • VolumeDistribution
• Remove "custom" sort orders from tables views, selects, ...

Wiki in Doc folder

Move Wiki content into a doc folder so that it is directly in the source code

Add activity log

Add logging of user activities in file (one file per day).
After a defined time the old log files will be deleted.

Content of an entry:

• Time stamp
• Username
• Module (Plot, Invoice, ...)
• Action (Edit, Add, Delete, ...)

As administrator there is a block in the administrator area where the files are listed and can be viewed.

Write guides to setup the system and how to set the env up

• For developers
• Move developer guide to doc folder
• For admins with screenshots, ...

Queues and Crons

https://www.honeybadger.io/blog/laravel-queues-deep-dive/

Unique entries when editing

Check if entry is unique before saving changes to table.

• user
• supplier
• setting (not necessary)
• product
• pricing
• plot
• deliveryNote (not necessary)
• invoice (With creation of edit page)

Re-Add check to find all deliveries with missing volumue distribution

• Write query
• Create frontend

Replace all calls of table generation with new generator

Use new table generator in all pages to generate table.
The advantage is the expected simpler realization of an overview template.

• deliveryNote.php
• evalDeliveryNote_OpenVolumeDistribution.php
• invoice.php
• plot.php
• pricing.php
• product.php
• recipient.php
• setting.php
• showMyDeliveryNote.php
• supplier.php
• user.php

/templates

• overviewForm.php

Use prepared statements for every query

Add dockerfile and build pipeline

• Add the Dockerfile
• Add GitHub workflow
• Check if/how GitHub can be used as container registry

Put line diagram into component for easier reusability

Statistic for amount development