From 49856e28c51f2fd3ec19cdf97291753526717539 Mon Sep 17 00:00:00 2001
From: Sandro Tosi <morph@debian.org>
Date: Mon, 25 Nov 2024 02:55:36 -0500
Subject: [PATCH] feat: layers: add a 20m range around portals, to aid Wayfarer
 submissions

Currently submitting a new portals that's closer than 20 meters to an existing
one, will not make it appear on the map even if accepted.

In order to facilitate the submission of new portals, let's draw a 20m range
around portals, making the un-shaded area available for new submissions.
---
 plugins/wayfarer-range.js | 88 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)
 create mode 100644 plugins/wayfarer-range.js

diff --git a/plugins/wayfarer-range.js b/plugins/wayfarer-range.js
new file mode 100644
index 000000000..2c6c1fa0a
--- /dev/null
+++ b/plugins/wayfarer-range.js
@@ -0,0 +1,88 @@
+// @author         morph
+// @name           Wayfarer portal submission range
+// @category       Layer
+// @version        0.1.0
+// @description    Add a 20m range around portals, to aid Wayfarer portals submissions
+
+/* exported setup, changelog --eslint */
+/* global L -- eslint */
+
+var changelog = [
+  {
+    version: '0.1.0',
+    changes: ['Initial release (code heavily based on zaprange)'],
+  },
+];
+
+// use own namespace for plugin
+window.plugin.wayfarerrange = function () {};
+window.plugin.wayfarerrange.wayfarerLayers = {};
+window.plugin.wayfarerrange.MIN_MAP_ZOOM = 16;
+
+window.plugin.wayfarerrange.portalAdded = function (data) {
+  data.portal.on('add', function () {
+    window.plugin.wayfarerrange.draw(this.options.guid, this.options.team);
+  });
+
+  data.portal.on('remove', function () {
+    window.plugin.wayfarerrange.remove(this.options.guid, this.options.team);
+  });
+};
+
+window.plugin.wayfarerrange.remove = function (guid) {
+  var previousLayer = window.plugin.wayfarerrange.wayfarerLayers[guid];
+  if (previousLayer) {
+    window.plugin.wayfarerrange.wayfarerCircleHolderGroup.removeLayer(previousLayer);
+    delete window.plugin.wayfarerrange.wayfarerLayers[guid];
+  }
+};
+
+window.plugin.wayfarerrange.draw = function (guid) {
+  var d = window.portals[guid];
+
+  var coo = d._latlng;
+  var latlng = new L.LatLng(coo.lat, coo.lng);
+  // https://leafletjs.com/reference.html#circle
+  var optCircle = { color: 'orange', opacity: 0.7, fillColor: 'orange', fillOpacity: 0.4, weight: 1, interactive: false, dashArray: [10, 6] };
+  // submitting a portal closer than 20m to another one, wont make it appear on the map
+  var range = 20;
+
+  var circle = new L.Circle(latlng, range, optCircle);
+
+  circle.addTo(window.plugin.wayfarerrange.wayfarerCircleHolderGroup);
+  window.plugin.wayfarerrange.wayfarerLayers[guid] = circle;
+};
+
+window.plugin.wayfarerrange.showOrHide = function () {
+  if (window.map.getZoom() >= window.plugin.wayfarerrange.MIN_MAP_ZOOM) {
+    // show the layer
+    if (!window.plugin.wayfarerrange.wayfarerLayerHolderGroup.hasLayer(window.plugin.wayfarerrange.wayfarerCircleHolderGroup)) {
+      window.plugin.wayfarerrange.wayfarerLayerHolderGroup.addLayer(window.plugin.wayfarerrange.wayfarerCircleHolderGroup);
+      $('.leaflet-control-layers-list span:contains("Wayfarer Range")').parent('label').removeClass('disabled').attr('title', '');
+    }
+  } else {
+    // hide the layer
+    if (window.plugin.wayfarerrange.wayfarerLayerHolderGroup.hasLayer(window.plugin.wayfarerrange.wayfarerCircleHolderGroup)) {
+      window.plugin.wayfarerrange.wayfarerLayerHolderGroup.removeLayer(window.plugin.wayfarerrange.wayfarerCircleHolderGroup);
+      $('.leaflet-control-layers-list span:contains("Wayfarer Range")').parent('label').addClass('disabled').attr('title', 'Zoom in to show those.');
+    }
+  }
+};
+
+var setup = function () {
+  // this layer is added to the layer chooser, to be toggled on/off
+  window.plugin.wayfarerrange.wayfarerLayerHolderGroup = new L.LayerGroup();
+
+  // this layer is added into the above layer, and removed from it when we zoom out too far
+  window.plugin.wayfarerrange.wayfarerCircleHolderGroup = new L.LayerGroup();
+
+  window.plugin.wayfarerrange.wayfarerLayerHolderGroup.addLayer(window.plugin.wayfarerrange.wayfarerCircleHolderGroup);
+
+  window.layerChooser.addOverlay(window.plugin.wayfarerrange.wayfarerLayerHolderGroup, 'Wayfarer range');
+
+  window.addHook('portalAdded', window.plugin.wayfarerrange.portalAdded);
+
+  window.map.on('zoomend', window.plugin.wayfarerrange.showOrHide);
+
+  window.plugin.wayfarerrange.showOrHide();
+};