How guardianproject/haven works
Project type and purpose
• This is a native Android application (“Haven”) for physical‐space intrusion detection.
• It turns a phone into a multi-sensor monitoring device (motion, sound, light, power) that logs events locally and dispatches alerts via SMS, Signal, or a Tor‐exposed web server.
File structure
• Top-level build: Gradle (build.gradle, settings.gradle, gradle/).
• App code under src/main/java/org/havenapp/main:
• sensors/ (modules for accelerometer, microphone, camera, light, power)
• database/ + dao/ + model/ (Room database, converters, DAOs, asynchronous tasks)
• service/ (MonitorService, background jobs, SignalExecutorTask, WebServer)
• ui/ + resources/ (Activities, Fragments, adapters, layouts, drawables)
• resources/ (IResourceManager + ResourceManager)
• utils, preference manager, application initializer (HavenApp.java)
• Integration/config: AndroidManifest.xml, fastlane/ (CI & deployment), schemas/ (Room DB schemas), docs/, art/, tools/.
Key insights from README
• Sensors trigger events stored locally on a Room DB.
• A long‐running background service monitors sensors continuously.
• Notifications: SMS via platform API, Signal via libsignal‐service‐java.
• Remote access: bundled NanoHTTPd WebServer exposed as Tor Onion Service (Orbot).
• UI: configuration screens, event log, live preview, share overlay.
Main components
a. Sensor Subsystem
• Individual sensor classes (AccelerometerMonitor, AmbientLightMonitor, etc.)
• Media modules for camera/mic (AudioRecorderTask, VideoEncoder, ImageCodec)
b. Core Monitoring & Service Layer
• MonitorService (Android Service)
• HavenJobCreator + JobScheduler for periodic tasks (RemoveDeletedFilesJob)
• SignalExecutorTask for encrypted notifications
• WebServer (NanoHTTPd) for HTTP interface
c. Data Layer
• Room Database (HavenEventDB) + DAOs (EventDAO, EventTriggerDAO)
• Async tasks for CRUD operations
d. Notification & External Integrations
• SMS Manager (Android API)
• Signal‐service Java library
• Orbot/Tor for Onion Service
e. UI Layer
• Activities/Fragments (ListActivity, MonitorActivity, SettingsActivity, various ConfigureActivities)
• Adapters/ViewHolders for event list & media
• Custom AppIntro (PPAppIntro)
f. Configuration & Utilities
• PreferenceManager, Utils, ResourceManager
• Application subclass (HavenApp) for startup wiring
Relationships and interactions
• Sensors feed raw data → MonitorService.
• MonitorService applies threshold logic → when triggered:
• Insert event record into Room DB via DAO (async).
• Dispatch notifications:
– SMS via Android Telephony API
– Signal via libsignal integration (SignalExecutorTask)
• Write media files to local storage.
– WebServer hot-links logs & media files for remote access.
• UI layer reads from Room DB (via DAOs) to show event history and live preview.
• Settings UI writes to SharedPreferences via PreferenceManager.
• Tor/Orbot sits alongside WebServer, forwarding HTTP requests to the app’s local port.
Architectural patterns & principles
• Layered architecture (UI → Service → Data)
• Separation of concerns (sensors vs. storage vs. notification vs. UI)
• Use of Android components: Services for background work, JobScheduler for tasks, Activities for UI
• Asynchronous operations for I/O (AsyncTasks, Kotlin coroutines where used)
• Dependency inversion via ResourceManager and interfaces (IResourceManager)