Manage upstream externals

[johnd0e]

Currently we have separate sub-directory with all upstream 'externals' (+ separate images subdirectory)

Most of them described in ATTRIBUTION.md. Some of them have version info inside, but most of them not. Some of them are even modified for iitc special needs, but in order to know details we have to dig though unclear commit history.

It's a pain to maintain and update these sources.

So I propose:

• [x] Update all 'externals' to current version

Then:

• [x] To document somewhere (for each 'external'):
  • version
  • url to upstream
  • add some comments
    • purpose, and where in iitc it is used
    • why was this component chosen
• [x] When updating write verbose commit message, incl. url / version info / hash.
• [x] If the source was modified, then we should:
  • add original unmodified
  • apply modification(s) as a separate commit(s), with verbose messages explaining purpose of changes
  • in case of heavy modification: keep separate branch, or make a fork of original repo (could be hosted in https://github.com/IITC-CE/).
• [x] Find a way to avoid source modification
  • extend the component in some official way (if possible)
  • monkey-patch at run-time
  • push changes to upstream (via PR) And in general:
• [x] Avoid in IITC/plugins own code inline including of 3rd-party code (and images). Use @@INCLUDExxx-macros instead.

Related links:

• Remove customizations of third-party code library #1165
• Which Directory for Reusable Code? #1185

[johnd0e]

Here will be the list of all externals, where we should specify:

• current version (clear checkbox if it's below upstream)
• bold if the source was modified from upstream (specify exact mods)

(WIP)

jQuery-related components:

• [ ] jQuery (jquery-3.3.1.min.js) © JS Foundation: [MIT]
• jQuery UI (jquery-ui-1.12.1.min.js) © JS Foundation:[MIT]
• [ ] [2b253c5] jquery-qrcode (jquery.qrcode.min.js) © Jerome Etienne: [MIT]
• [x] [74613a8 mod] jquery-taphold (taphold.js) © Rich Adams: [CC BY 3.0] Mod: touchcancel support (added later to upstream too) jQuery: fixed deprecated functions (https://github.com/IITC-CE/jquery-taphold/commit/a85050a7744d780809e8f007f6dc43065cdece9c)
• [ ] [~1.2.0 Mod] Spectrum colorpicker (.js/.css) © Brian Grinstead: [MIT] jQuery: fixed deprecated functions (McBen a43f785504a73794f3deb85d9e1028a25d9132c4) (fixed in recent upstream too)

Leaflet-related components:

• [x] [1.4.0] Leaflet © Vladimir Agafonkin, CloudMade: [LICENCE]
• [ ] [33ea262 + mod] Leaflet.draw © Jon West, Jacob Toye, and Leaflet: [MIT]
• Shramov leaflet-plugins © Pavel Shramov, Bruno Bergot: [MIT]
  • [ ] [44935a9] Bing.js
  • [ ] [c91e49c] Yandex.js
  • [ ] [3d2d4b0] KML.js
• [ ] [b68a264 + 1641fd5] toGeoJSON (togeojson.js) © Mapbox: [BSD-2-Clause]
• [ ] [04c6d46 + mod] Leaflet.FileLayer (leaflet.filelayer.js) © Makina Corpus: [MIT]
• [x] [0.8.0] Leaflet.GridLayer.GoogleMutant (Leaflet.GoogleMutant.js) © Iván Sánchez Ortega: [LICENCE]
• [ ] [v3.4.0 + 78d77aa + 1973792] Leaflet.MiniMap (Control.MiniMap.js) © Norkart AS: [BSD-2-Clause]
• https://github.com/kartena © Kartena AB
  • [ ] [7b54411] Leaflet.Pancontrol (L.Control.Pan .js/.css/images): [BSD-2-Clause]
  • [ ] [0ca1aba] Leaflet.zoomslider (L.Control.Zoomslider .js/.css): [BSD-2-Clause]
• [mod] Leaflet.Geodesic (L.Geodesic.js) © Kevin Brasier: [BSD-2-Clause]
• [v0.2.6 + 1973792] Overlapping Marker Spiderfier (oms.min.js) © George MacKerron: [MIT]
• [7f807ae + 9077c24] LatLng_Bearings.js [www] © Greg Allensworth: [No licence]

Other:

• [ ] [6717ce2] autolink-js © Bryan Woods: [MIT]
• [ ] [f828670 + ea46405] delaunay.js © Jay LaPorte: [CC0 1.0] Modded (minor refactoring needed during update).
• [3acd55a] load.js © Chris O'Hara: [MIT]
• [5e20625 + 42ed656 + 6f8fbe6] s2-geometry-javascript (s2geometry.js) © Jon Atkins: [LICENSE: same as IITC]

[johnd0e]

So I've figured out exact versions of externals (as long as required modification), and now we can begin to update most of them (excl. Leaflet.draw, leaflet.filelayer.js, togeojson.js).

Some things still need to be clarified:

• Do we really need 522ef34f: https://github.com/IITC-CE/ingress-intel-total-conversion/pull/78#issuecomment-462323839? Update: #122

• Leaflet.Geodesic has an alternative: (https://github.com/henrythasler/Leaflet.Geodesic) (Leaflet.Geodesic.js) © Henry Thasler: [GPL-3.0]

• s2geometry.js has more advanced fork: s2geometry.js © Jon Atkins, AJ ONeal: [ISC] Moved to https://git.daplie.com/Daplie/s2-geometry.js/ (failed to connect)

• Yandex.js is extremely laggy fixed. Consider trying https://github.com/kostjerry/leaflet-yandex instead

• Bing.js is extremely blurry enableRetina fixed.

• ~Shramov leaflet-plugins: files leaflet.filelayer.js, togeojson.js are not present in upstream, need to search out their sources.~ There is an error in ATTRIBUTION.md, that files are not by Shramov

• toGeoJSON (togeojson.js) © Mapbox: [BSD-2-Clause] This repo is now developed at https://github.com/tmcw/togeojson: there is no major features added yet. But it is ES2015+.

• delaunay.js upstream is updated to more fast version, but it's still not fastest available, see performance comparison here. We should consider switch to https://github.com/mapbox/delaunator, it has pretty the same api, with minor differences.

  ``` // https://unpkg.com/delaunator@3.0.2/delaunator.js var triangles = tidyLinks.Delaunator.from(locations.map(function (latlng) { var point = map.project(latlng, tidyLinks.PROJECT_ZOOM); return [point.x,point.y]; })).triangles; ```

• alternative to oms.js: https://github.com/robertleeplummerjr/Leaflet.spiderfy/ see https://github.com/jawj/OverlappingMarkerSpiderfier-Leaflet/pull/30, https://github.com/jawj/OverlappingMarkerSpiderfier-Leaflet/pull/31

• load.js is used only in basemap-yandex.user.js and sync.user.js, in form of load(yandexApiJs).thenRun(callback);, so I suppose it can be replaced with jQuery.getScript(). BTW, there is also jQuery.loadScript

• autolink.js is used in single place: (and I don't feel it's necessary): https://github.com/IITC-CE/ingress-intel-total-conversion/blob/d77562b91a5b1e0bf170b4257eb33316a0b9daa3/code/chat.js#L334

• jquery.qrcode.min.js is used in single place too: https://github.com/IITC-CE/ingress-intel-total-conversion/blob/d77562b91a5b1e0bf170b4257eb33316a0b9daa3/code/utils_misc.js#L207 Perhaps it should be better to have it as plugin. The codebase is rather old. Alternatives: https://www.nayuki.io/page/qr-code-generator-library#javascript, https://www.cssscript.com/tag/qr-code/

• LatLng_Bearings.js can be replaced by gmaps geometry library function spherical.computeHeading.

  P.S.

L.Control.Pan.css and L.Control.Zoomslider.css was slightly modified, so after update we need to verify if it is still needed.

https://github.com/iitc-project/ingress-intel-total-conversion/pull/99/:

-.leaflet-control-zoom {
+.leaflet-bar {

+/*
+  override the scale bar and push it over
+*/
+.leaflet-control-scale {
+  left: 63px !important;
+}

https://github.com/iitc-project/ingress-intel-total-conversion/pull/283:

 .leaflet-control-zoomslider-slider {
+       background-color: #fff;
+       border-bottom: 1px solid #ccc;