From 3fd731a5a22e99b649a7f9512c3291e752eedcba Mon Sep 17 00:00:00 2001
From: Adrian Schmutzler <freifunk@adrianschmutzler.de>
Date: Wed, 15 Nov 2017 20:33:31 +0100
Subject: [PATCH] Introduced orphaned state between offline and deletion

After 7 days of being offline, a router enters the orphaned
state with a grey icon. It is only deleted after a longer period
of 180 days.

Signed-off-by: Adrian Schmutzler <freifunk@adrianschmutzler.de>
---
 ffmap/mapnik/links_and_routers.xml   |  4 ++
 ffmap/routertools.py                 | 25 ++++++++--
 ffmap/stattools.py                   |  6 ++-
 ffmap/web/api.py                     |  1 +
 ffmap/web/filters.py                 |  1 +
 ffmap/web/static/img/router_grey.svg | 71 ++++++++++++++++++++++++++++
 ffmap/web/templates/statistics.html  |  2 +-
 scripts/calcglobalstats.py           |  1 +
 8 files changed, 104 insertions(+), 7 deletions(-)
 create mode 100644 ffmap/web/static/img/router_grey.svg

diff --git a/ffmap/mapnik/links_and_routers.xml b/ffmap/mapnik/links_and_routers.xml
index b97010d..4c4dfe3 100644
--- a/ffmap/mapnik/links_and_routers.xml
+++ b/ffmap/mapnik/links_and_routers.xml
@@ -17,6 +17,10 @@
 	  <Filter>([status] = 'unknown')</Filter>
 	  <PointSymbolizer file="static/img/router_yellow.svg" allow-overlap="true" />
 	</Rule>
+	<Rule>
+	  <Filter>([status] = 'orphaned')</Filter>
+	  <PointSymbolizer file="static/img/router_grey.svg" allow-overlap="true" />
+	</Rule>
   </Style>
   <Style name="color" filter-mode="first">
 	<Rule>
diff --git a/ffmap/routertools.py b/ffmap/routertools.py
index 72f02f0..6a84e1e 100644
--- a/ffmap/routertools.py
+++ b/ffmap/routertools.py
@@ -18,7 +18,8 @@ CONFIG = {
 	"vpn_netif_l2tp": "l2tp",
 	"vpn_netif_aux": "fffauxVPN",
 	"offline_threshold_minutes": 20,
-	"orphan_threshold_days": 120,
+	"orphan_threshold_days": 7,
+	"delete_threshold_days": 180,
 	"router_stat_days": 7,
 	"event_num_entries": 20,
 }
@@ -232,13 +233,15 @@ def import_nodewatcher_xml(mysql, mac, xml):
 				#events.append(event)
 
 def detect_offline_routers(mysql):
+	# Offline after X minutes (online -> offline)
+	
 	threshold=mysql.formatdt(utcnow() - datetime.timedelta(minutes=CONFIG["offline_threshold_minutes"]))
 	now=mysql.utcnow()
 	
 	result = mysql.fetchall("""
 		SELECT id
 		FROM router
-		WHERE last_contact < %s AND status <> 'offline'
+		WHERE last_contact < %s AND status <> 'offline' AND status <> 'orphaned'
 	""",(threshold,))
 	
 	rdata = []
@@ -252,12 +255,26 @@ def detect_offline_routers(mysql):
 	mysql.execute("""
 		UPDATE router
 		SET status = 'offline', clients = 0
-		WHERE last_contact < %s AND status <> 'offline'
+		WHERE last_contact < %s AND status <> 'offline' AND status <> 'orphaned'
+	""",(threshold,))
+	mysql.commit()
+
+def detect_orphaned_routers(mysql):
+	# Orphan after X days (offline -> orphaned)
+	
+	threshold=mysql.formatdt(utcnow() - datetime.timedelta(days=CONFIG["orphan_threshold_days"]))
+	
+	mysql.execute("""
+		UPDATE router
+		SET status = 'orphaned'
+		WHERE last_contact < %s AND status = 'offline'
 	""",(threshold,))
 	mysql.commit()
 
 def delete_orphaned_routers(mysql):
-	threshold=mysql.formatdt(utcnow() - datetime.timedelta(days=CONFIG["orphan_threshold_days"]))
+	# Deleted after X days (orphaned -> deletion)
+	
+	threshold=mysql.formatdt(utcnow() - datetime.timedelta(days=CONFIG["delete_threshold_days"]))
 	
 	mysql.execute("""
 		DELETE r, e, i, nb, net FROM router AS r
diff --git a/ffmap/stattools.py b/ffmap/stattools.py
index b96c566..e5c5427 100644
--- a/ffmap/stattools.py
+++ b/ffmap/stattools.py
@@ -26,18 +26,20 @@ def total_clients(mysql,selecthood=None):
 
 def router_status(mysql,selecthood=None):
 	if selecthood:
-		return mysql.fetchdict("""
+		tmp = mysql.fetchdict("""
 			SELECT status, COUNT(id) AS count
 			FROM router
 			WHERE hood = %s
 			GROUP BY status
 		""",(selecthood,),"status","count")
 	else:
-		return mysql.fetchdict("""
+		tmp = mysql.fetchdict("""
 			SELECT status, COUNT(id) AS count
 			FROM router
 			GROUP BY status
 		""",(),"status","count")
+	tmp["sum"] = sum(tmp.values())
+	return tmp
 
 def total_clients_hood(mysql):
 	return mysql.fetchdict("""
diff --git a/ffmap/web/api.py b/ffmap/web/api.py
index 0a3d7e5..10c48af 100755
--- a/ffmap/web/api.py
+++ b/ffmap/web/api.py
@@ -95,6 +95,7 @@ def alfred():
 				mysql.commit()
 				r.headers['X-API-STATUS'] = "ALFRED data imported"
 				#detect_offline_routers(mysql)
+				#detect_orphaned_routers(mysql)
 				#delete_orphaned_routers(mysql)
 				#delete_old_stats(mysql)
 				#record_global_stats(mysql)
diff --git a/ffmap/web/filters.py b/ffmap/web/filters.py
index 051d4de..07cb0f4 100644
--- a/ffmap/web/filters.py
+++ b/ffmap/web/filters.py
@@ -143,6 +143,7 @@ def status2css(status):
 		"created": "primary",
 		"netmon": "primary",
 		"update": "primary",
+		"orphaned": "default",
 	}
 	return "label label-%s" % status_map.get(status, "default")
 
diff --git a/ffmap/web/static/img/router_grey.svg b/ffmap/web/static/img/router_grey.svg
new file mode 100644
index 0000000..95ff4e3
--- /dev/null
+++ b/ffmap/web/static/img/router_grey.svg
@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="14"
+   height="14"
+   viewBox="0 0 14 14"
+   id="svg4142"
+   version="1.1"
+   inkscape:version="0.91 r13725"
+   sodipodi:docname="router_grey.svg">
+  <defs
+     id="defs4144" />
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="22.627417"
+     inkscape:cx="3.7021802"
+     inkscape:cy="7.5625001"
+     inkscape:document-units="px"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     units="px"
+     inkscape:window-width="1436"
+     inkscape:window-height="858"
+     inkscape:window-x="0"
+     inkscape:window-y="19"
+     inkscape:window-maximized="1"
+     width="14in" />
+  <metadata
+     id="metadata4147">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title />
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="Ebene 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(0,-1038.3621)">
+    <circle
+       style="fill:#999999;fill-opacity:1"
+       id="path4690"
+       cx="7"
+       cy="1045.3621"
+       r="6.6121397" />
+    <circle
+       style="fill:#000000;fill-opacity:1"
+       id="path4134"
+       cx="7"
+       cy="1045.3621"
+       r="2.0780513" />
+  </g>
+</svg>
diff --git a/ffmap/web/templates/statistics.html b/ffmap/web/templates/statistics.html
index 82bd3ff..2cfa2de 100644
--- a/ffmap/web/templates/statistics.html
+++ b/ffmap/web/templates/statistics.html
@@ -77,7 +77,7 @@
 							<td class="success">{{ router_status.online or 0 }}</td>
 							<td class="danger">{{ router_status.offline or 0 }}</td>
 							<td class="warning">{{ router_status.unknown or 0 }}</td>
-							<td class="active">{{ (router_status.online or 0) + (router_status.offline or 0) + (router_status.unknown or 0) }}</td>
+							<td class="active">{{ router_status.sum or 0 }}</td>
 							<td class="info">{{ clients }}</td>
 							<td class="stats"><a href="{{ url_for('global_statistics') }}">Global</a></td> 
 						</tr>
diff --git a/scripts/calcglobalstats.py b/scripts/calcglobalstats.py
index 4d34ec7..9b49ac1 100755
--- a/scripts/calcglobalstats.py
+++ b/scripts/calcglobalstats.py
@@ -16,6 +16,7 @@ start_time = time.time()
 
 mysql = FreifunkMySQL()
 detect_offline_routers(mysql)
+detect_orphaned_routers(mysql)
 delete_orphaned_routers(mysql)
 #delete_old_stats(mysql) # Only execute once daily, takes 2 minutes
 record_global_stats(mysql)