feat(plugin): Add FortiGuard threat map plugin
This commit is contained in:
1 parent
a9934f471e
commit
ca17552d3d
11 files changed
+6500
-20975
No files matched your search
@@ -0,0 +1,116 @@
|
||||
# GeoJSON Data Guide
|
||||
|
||||
WorldWideView supports visualizing external datasets and local static files by interpreting GeoJSON files. When using the built-in GeoJSON parser (for instance, via declarative configs, static plugins, or user-uploaded files), the data is automatically normalized into our internal `GeoEntity` format so it seamlessly displays on the globe and the UI's detail panels.
|
||||
|
||||
This guide outlines exactly what structures are supported, what isn't, and how you can map your data into the UI.
|
||||
|
||||
---
|
||||
|
||||
## What is Supported?
|
||||
|
||||
Our parser enforces a subset of the **RFC 7946** standard. To be successfully interpreted, your JSON file must meet the following criteria:
|
||||
|
||||
### 1. Root Level
|
||||
The root of your JSON document must be a `FeatureCollection`. It must contain a `features` array.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "FeatureCollection",
|
||||
"features": [ ... ]
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Supported Geometry: Points
|
||||
WorldWideView's declarative parser strictly supports **Point** geometries. Your coordinates must be a flat array of numbers: `[longitude, latitude]` or optionally `[longitude, latitude, altitude]`.
|
||||
|
||||
```json
|
||||
"geometry": {
|
||||
"type": "Point",
|
||||
"coordinates": [-83.74088, 42.27756, 150.0]
|
||||
}
|
||||
```
|
||||
*Note: Altitude (the 3rd coordinate) is optional. If omitted, the entity will be clamped to the ground.*
|
||||
|
||||
### 3. Properties and Metadata
|
||||
You can include any arbitrary metadata inside the `properties` object. The parser maps these properties to the UI using a `FieldMapping` configuration.
|
||||
|
||||
```json
|
||||
"properties": {
|
||||
"stream": "http://example.com/video.mjpg",
|
||||
"country": "United States",
|
||||
"is_static": false,
|
||||
"nested_data": {
|
||||
"speed": 45,
|
||||
"heading": 180
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Field Mapping
|
||||
When configuring your data source, you can define how your GeoJSON properties map to standard WorldWideView `GeoEntity` fields. This is done via dot-notation:
|
||||
|
||||
| GeoEntity Field | Description | Example Path |
|
||||
| --- | --- | --- |
|
||||
| `id` | Unique identifier | Automatically maps to `Feature.id` if present, otherwise uses array index. |
|
||||
| `heading` | Rotation angle (degrees) | `properties.nested_data.heading` |
|
||||
| `speed` | Speed value | `properties.nested_data.speed` |
|
||||
| `timestamp` | Time of the event (string or epoch) | `properties.last_updated` |
|
||||
| `label` | Primary text label shown on map | `properties.city` |
|
||||
| `properties` | Custom fields mapped to the UI panel | `properties.stream` |
|
||||
|
||||
Any property extracted via mapping will appear automatically in the Entity Info Card when a user clicks the point on the map.
|
||||
|
||||
---
|
||||
|
||||
## What is NOT Supported?
|
||||
|
||||
To ensure extreme performance (60 FPS with 10k+ entities) and a unified UI experience, the following GeoJSON structures are **not supported** by the automatic data parser:
|
||||
|
||||
### 1. Complex Geometries
|
||||
The declarative parser will fail to render the following geometry types:
|
||||
- `Polygon`
|
||||
- `MultiPolygon`
|
||||
- `LineString`
|
||||
- `MultiLineString`
|
||||
- `GeometryCollection`
|
||||
|
||||
*Why?* The automatic parser maps features to single point entities (billboards or 3D models). If you supply a `Polygon`, the parser will read the nested coordinate arrays (`[[lon, lat], ...]`) as invalid numbers, resulting in a silent failure (`NaN` clamping).
|
||||
|
||||
If you need to render borders, heatmaps, or route lines, you must build a **Code Bundle Plugin** and interact with the Cesium primitives (`PolygonHierarchy`, `PolylineCollection`) directly via the `renderEntity` API.
|
||||
|
||||
### 2. Top-Level Features
|
||||
A single isolated `Feature` object at the root of the document will not be parsed. The data must be wrapped in a `FeatureCollection`.
|
||||
|
||||
### 3. Non-Standard Coordinate Orders
|
||||
Cesium and GeoJSON strictly require `[longitude, latitude]`. If your system outputs `[latitude, longitude]`, you must transform the data before passing it to WorldWideView.
|
||||
|
||||
---
|
||||
|
||||
## Example: Perfect GeoJSON Structure
|
||||
|
||||
Here is a fully supported and optimized example demonstrating cameras mounted globally:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "FeatureCollection",
|
||||
"features": [
|
||||
{
|
||||
"type": "Feature",
|
||||
"id": "cam-001",
|
||||
"geometry": {
|
||||
"type": "Point",
|
||||
"coordinates": [-83.74088, 42.27756]
|
||||
},
|
||||
"properties": {
|
||||
"stream": "http://173.167.10.225:80/mjpg/video.mjpg",
|
||||
"country": "United States",
|
||||
"city": "Ann Arbor",
|
||||
"categories": ["traffic"],
|
||||
"is_static": false
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
By ensuring your data matches this structure, WorldWideView can effortlessly stream, render, and display your intelligence layers on the interactive 3D globe.
|
||||
+3
-3
@@ -3,7 +3,7 @@ import type { NextConfig } from "next";
|
||||
const nextConfig: NextConfig = {
|
||||
output: "standalone",
|
||||
serverExternalPackages: ["@prisma/client", "prisma"],
|
||||
transpilePackages: ["@worldwideview/wwv-plugin-sdk", "resium", "react-player", "satellite.js"],
|
||||
transpilePackages: ["@worldwideview/wwv-plugin-sdk", "resium", "react-player", "satellite.js", "@worldwideview/wwv-plugin-fortiguard"],
|
||||
allowedDevOrigins: process.env.ALLOWED_DEV_ORIGIN ? [process.env.ALLOWED_DEV_ORIGIN] : undefined,
|
||||
experimental: {
|
||||
memoryBasedWorkersCount: true,
|
||||
@@ -35,8 +35,8 @@ const nextConfig: NextConfig = {
|
||||
"connect-src 'self' http: https: ws: wss:",
|
||||
// HLS video streams from arbitrary camera sources
|
||||
"media-src 'self' blob: http: https:",
|
||||
// Embeddable video platforms for camera iframes
|
||||
"frame-src 'self' *.youtube.com *.youtube-nocookie.com *.twitch.tv *.vimeo.com *.webcamera.pl *.ivideon.com *.rtsp.me *.bnu.tv https://googleads.g.doubleclick.net https://tpc.googlesyndication.com https://ep2.adtrafficquality.google https://*.google.com",
|
||||
// Embeddable video platforms for camera iframes — needs to support arbitrary domains
|
||||
"frame-src 'self' http: https: blob:",
|
||||
"worker-src 'self' blob:",
|
||||
"frame-ancestors 'none'",
|
||||
].join("; "),
|
||||
|
||||
+2
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "worldwideview",
|
||||
"version": "2.5.6",
|
||||
"version": "2.6.0",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"packageManager": "[email protected]",
|
||||
@@ -31,6 +31,7 @@
|
||||
"@types/pg": "^8.20.0",
|
||||
"@vercel/analytics": "^1.6.1",
|
||||
"@worldwideview/wwv-plugin-sdk": "workspace:*",
|
||||
"@worldwideview/wwv-plugin-fortiguard": "workspace:*",
|
||||
"bcryptjs": "^3.0.3",
|
||||
"cesium": "^1.141.0",
|
||||
"cheerio": "^1.2.0",
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"name": "@worldwideview/wwv-plugin-fortiguard",
|
||||
"version": "1.0.0",
|
||||
"description": "FortiGuard live cyber threats plugin for WorldWideView",
|
||||
"main": "src/index.ts",
|
||||
"types": "src/index.ts",
|
||||
"scripts": {
|
||||
"build": "tsc"
|
||||
},
|
||||
"worldwideview": {
|
||||
"id": "fortiguard",
|
||||
"type": "data-layer",
|
||||
"format": "bundle",
|
||||
"category": "cyber",
|
||||
"icon": "ShieldAlert",
|
||||
"capabilities": ["data:own", "globe:overlay"]
|
||||
},
|
||||
"dependencies": {
|
||||
"@worldwideview/wwv-plugin-sdk": "workspace:*"
|
||||
},
|
||||
"devDependencies": {
|
||||
"typescript": "^5.0.0"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,93 @@
|
||||
import { WorldPlugin, PluginManifest, GeoEntity, CesiumEntityOptions, PluginContext, TimeRange, LayerConfig } from '@worldwideview/wwv-plugin-sdk';
|
||||
import pkg from '../package.json';
|
||||
|
||||
export interface FortiGuardThreat {
|
||||
id: string;
|
||||
vuln_name: string;
|
||||
severity: string;
|
||||
src_lat: number;
|
||||
src_long: number;
|
||||
dest_lat: number;
|
||||
dest_long: number;
|
||||
}
|
||||
|
||||
export const manifest: PluginManifest = {
|
||||
id: pkg.worldwideview.id,
|
||||
name: 'Cyber Threats (FortiGuard)',
|
||||
version: pkg.version,
|
||||
description: pkg.description,
|
||||
format: pkg.worldwideview.format as any,
|
||||
trust: 'verified',
|
||||
capabilities: pkg.worldwideview.capabilities as any,
|
||||
category: pkg.worldwideview.category as any,
|
||||
type: pkg.worldwideview.type as any
|
||||
};
|
||||
|
||||
export class FortiGuardPlugin implements WorldPlugin {
|
||||
id = pkg.worldwideview.id;
|
||||
name = 'Cyber Threats (FortiGuard)';
|
||||
description = pkg.description;
|
||||
icon = 'ShieldAlert';
|
||||
category = 'cyber' as any;
|
||||
version = pkg.version;
|
||||
|
||||
private context?: PluginContext;
|
||||
|
||||
async initialize(context: PluginContext): Promise<void> {
|
||||
console.log('FortiGuard Plugin Initialized');
|
||||
this.context = context;
|
||||
}
|
||||
|
||||
destroy(): void {
|
||||
this.context = undefined;
|
||||
}
|
||||
|
||||
async fetch(timeRange: TimeRange): Promise<GeoEntity[]> {
|
||||
if (!this.context) return [];
|
||||
|
||||
// Determine the base URL depending on if we are hitting the engine
|
||||
// Engine provides apiBaseUrl like http://localhost:5001 or cloud URL
|
||||
const baseUrl = this.context.apiBaseUrl.replace(/^ws/, 'http');
|
||||
const res = await fetch(`${baseUrl}/data/fortiguard`);
|
||||
if (!res.ok) throw new Error('Failed to fetch FortiGuard data');
|
||||
const threats: FortiGuardThreat[] = await res.json();
|
||||
|
||||
return threats.filter(t => t.dest_lat && t.dest_long).map(threat => ({
|
||||
id: `threat-${threat.id}-${Date.now()}`,
|
||||
pluginId: this.id,
|
||||
latitude: threat.dest_lat,
|
||||
longitude: threat.dest_long,
|
||||
timestamp: new Date(),
|
||||
properties: threat as any
|
||||
}));
|
||||
}
|
||||
|
||||
getPollingInterval(): number {
|
||||
return 60000; // Poll every 60 seconds
|
||||
}
|
||||
|
||||
getLayerConfig(): LayerConfig {
|
||||
return {
|
||||
color: '#ffaa00',
|
||||
clusterEnabled: true,
|
||||
clusterDistance: 50,
|
||||
maxEntities: 1000
|
||||
};
|
||||
}
|
||||
|
||||
renderEntity(entity: GeoEntity): CesiumEntityOptions {
|
||||
const data = entity.properties as unknown as FortiGuardThreat;
|
||||
|
||||
return {
|
||||
type: 'point',
|
||||
color: data.severity === 'Critical' ? '#ff0000' : '#ffaa00',
|
||||
size: 5,
|
||||
labelText: data.vuln_name
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
export default function createPlugin() {
|
||||
return new FortiGuardPlugin();
|
||||
}
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"extends": "../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "dist",
|
||||
"rootDir": "src"
|
||||
},
|
||||
"include": ["src"]
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
import type {
|
||||
WorldPlugin,
|
||||
PluginContext,
|
||||
TimeRange,
|
||||
GeoEntity,
|
||||
CesiumEntityOptions,
|
||||
LayerConfig
|
||||
} from "@worldwideview/wwv-plugin-sdk";
|
||||
import { manifest } from "./manifest";
|
||||
|
||||
export class NzTrafficCamerasPlugin implements WorldPlugin {
|
||||
id = manifest.id;
|
||||
name = manifest.name;
|
||||
description = manifest.description;
|
||||
icon = "Camera"; // Placeholder for generic camera icon
|
||||
category = "infrastructure" as const;
|
||||
version = manifest.version;
|
||||
|
||||
private context?: PluginContext;
|
||||
|
||||
async initialize(ctx: PluginContext): Promise<void> {
|
||||
this.context = ctx;
|
||||
}
|
||||
|
||||
destroy(): void {
|
||||
this.context = undefined;
|
||||
}
|
||||
|
||||
getPollingInterval(): number {
|
||||
return 0; // 0 means WebSocket only stream. Polling is disabled.
|
||||
}
|
||||
|
||||
async fetch(timeRange: TimeRange): Promise<GeoEntity[]> {
|
||||
// Return empty array. Data flows purely through WebSocket events emitted by the data engine.
|
||||
return [];
|
||||
}
|
||||
|
||||
getLayerConfig(): LayerConfig {
|
||||
return {
|
||||
color: "#FFA500", // Orange
|
||||
clusterEnabled: true,
|
||||
clusterDistance: 50
|
||||
};
|
||||
}
|
||||
|
||||
renderEntity(entity: GeoEntity): CesiumEntityOptions {
|
||||
// Ensure separation of billboard and point properties to prevent GPU clipping
|
||||
return {
|
||||
type: "billboard",
|
||||
color: "#FFA500",
|
||||
iconScale: 0.6
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
export default function createPlugin() {
|
||||
return new NzTrafficCamerasPlugin();
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { NzTrafficCamerasPlugin } from "../src/index";
|
||||
|
||||
describe("NzTrafficCamerasPlugin", () => {
|
||||
it("should initialize with correct metadata", () => {
|
||||
const plugin = new NzTrafficCamerasPlugin();
|
||||
expect(plugin.id).toBe("nz-traffic-cameras");
|
||||
expect(plugin.name).toBe("NZ Traffic Cameras");
|
||||
});
|
||||
});
|
||||
Generated
+695
-5
File diff suppressed because it is too large.
Load diff
+5482
-20966
File diff suppressed because it is too large.
Load diff
@@ -32,6 +32,7 @@ import { isDemo } from "@/core/edition";
|
||||
|
||||
import { injectHostGlobals } from "@/core/plugins/hostGlobals";
|
||||
import { initLogCatcher } from "@/lib/logCatcher";
|
||||
import FortiGuardPlugin from "@worldwideview/wwv-plugin-fortiguard";
|
||||
|
||||
const GlobeView = dynamic(() => import("@/core/globe/GlobeView"), {
|
||||
ssr: false,
|
||||
@@ -91,6 +92,14 @@ export function AppShell() {
|
||||
|
||||
await pluginManager.init();
|
||||
|
||||
const fortiGuardPlugin = new FortiGuardPlugin();
|
||||
await pluginManager.registerPlugin(fortiGuardPlugin);
|
||||
const enableFortiGuard = demoDefaultPlugins.has(fortiGuardPlugin.id);
|
||||
initLayer(fortiGuardPlugin.id, enableFortiGuard);
|
||||
if (enableFortiGuard) {
|
||||
await pluginManager.enablePlugin(fortiGuardPlugin.id);
|
||||
}
|
||||
|
||||
for (const plugin of pluginRegistry.getAll()) {
|
||||
await pluginManager.registerPlugin(plugin);
|
||||
const shouldEnable = demoDefaultPlugins.has(plugin.id);
|
||||
|
||||
Reference in new issue
Block a user