Site Audit 4.x

This issue is for planning & discussing about the new Site Audit 4.x version.

New Features

Site Audit Report Entity

1. Provides a Report Content entity & UI for saving and listing reports.
2. Site UUID and URIs are saved to allow tracking audits between environments.
3. Save reports regularly using cron.
4. Entity API integration allowing other modules to enhance functionality.
5. Attach fields to Report entities to build your own Audit Report database.
6. Other Entity API integrations like REST Endpoints, access control, etc.

Site Audit Send

1. Send audit reports to another site running the Site Audit Server module. Support for posting to any REST endpoint.
2. Send reports regularly with cron.
3. Send reports manually with a button.
4. PROPOSED: Send audit reports via email.
5. PROPOSED: Save audit reports to a file.

Site Audit Server

1. Receives site audit reports via REST endpoint.
2. Stores reports as local Report entities along site local report entities.
3. Standard EntityAPI hooks available to process reports as they come in with custom or contrib modules. For example, to populate a field or trigger another event.
4. Standard REST API features, allowing features like ability to use any authentication mechanism. Recommended using Key Auth → module for simplicity.

TODO

3. Move UI elements out of Site Audit Report Entity into submodule site_audit_ui. Low Priority. TBD if should block 4.0.0 release.
4. Create new project on drupal.org: site_audit_server. Move "Site Audit Remote Server" module, renaming it to "Site Audit Server".
5. Write up a README, hook_help, and documentation page for each module.

Support

Many thanks to Vardot → for sponsoring this new branch, and ThinkDrop → for developing it.

QUESTIONS

How to organize modules?

My feelings are:

1. Keep Entity API integrations in the main site_audit module.
2. Add Site Audit UI for the saving reports interface.
3. Create a separate project for Site Audit Server, since 99% of Site Audit enabled sites won't be servers.

Needs Input

Regarding Site Audit UI: Do we keep the Site Audit Report page in the main site_audit module, or move it to the Site Audit UI module? If moving to the UI module, is it ok to provide all UI from the one module? Permissions for each page could be granular.