use firefox headless

Author: ocefpaf

.github/CONTRIBUTING.md

@@ -60,7 +60,6 @@ First of all, thanks for your interest in contributing!
   4. Make change to your local copy of the folium repository
   5. Make sure the tests pass:
     * in the repository folder do `pip install -e .`  (needed for notebook tests)
-    * along with all the dependencies install `phantomjs` via `npm install -g phantomjs` or by downloading it from [here](http://phantomjs.org/download.html) and installing manually
     * run `python -m pytest tests`
     * resolve all errors
   6. Commit those changes

.travis.yml

@@ -2,6 +2,12 @@ language: minimal
 
 sudo: false
 
+env:
+  - MOZ_HEADLESS=1
+
+addons:
+  firefox: latest
+
 env:
   global:
     - secure: "gRT413onDOvwgiHpNXRsiqo+ZZSjwwBpjZryQ9h6IqYw6cTN9YVivYF15uTMD//mZyFeHRz+F/7/0EG2z+UYIBKbgktiNMbie/KizwRBnCThGpcch1VeizkBkPluWSQXndXM6STkHvn0eZBZBBh0QdTm1qaI0babUmgZuWhrX38="
@@ -31,8 +37,13 @@ before_install:
   - conda update conda
   - conda config --remove channels defaults --force
   - conda config --add channels conda-forge --force
-  - conda create --name TEST python=$PY phantomjs --file requirements.txt --file requirements-dev.txt
+  - conda create --name TEST python=$PY --file requirements.txt --file requirements-dev.txt
   - source activate TEST
+  # firefox headless driver
+  - wget https://github.com/mozilla/geckodriver/releases/download/v0.23.0/geckodriver-v0.23.0-linux64.tar.gz -O geckodriver.tar.gz
+  - mkdir geckodriver
+  - tar -xzf geckodriver.tar.gz -C geckodriver
+  - export PATH=$PATH:$PWD/geckodriver
 
   - if [[ "$PY" == "2.7" ]]; then
       conda install mock ;

folium/folium.py

@@ -7,19 +7,22 @@
 
 from __future__ import (absolute_import, division, print_function)
 
-import os
 import time
 import warnings
 
+from branca.colormap import StepColormap
 from branca.element import CssLink, Element, Figure, JavascriptLink, MacroElement
 from branca.utilities import _parse_size
 
 from folium.map import FitBounds
 from folium.raster_layers import TileLayer
-from folium.utilities import _validate_location
+from folium.utilities import _tmp_html, _validate_location
 
 from jinja2 import Environment, PackageLoader, Template
 
+import numpy as np
+
+
 ENV = Environment(loader=PackageLoader('folium', 'templates'))
 
 
@@ -203,10 +206,10 @@ class Map(MacroElement):
         zoomControl: {{this.zoom_control.__str__().lower()}},
         });
 {% if this.control_scale %}L.control.scale().addTo({{this.get_name()}});{% endif %}
-    
+
     {% if this.objects_to_stay_in_front %}
     function objects_in_front() {
-        {% for obj in this.objects_to_stay_in_front %}    
+        {% for obj in this.objects_to_stay_in_front %}
             {{ obj.get_name() }}.bringToFront();
         {% endfor %}
     };
@@ -291,35 +294,30 @@ def _repr_html_(self, **kwargs):
     def _to_png(self, delay=3):
         """Export the HTML to byte representation of a PNG image.
 
-        Uses Phantom JS to render the HTML and record a PNG. You may need to
+        Uses selenium to render the HTML and record a PNG. You may need to
         adjust the `delay` time keyword argument if maps render without data or tiles.
 
         Examples
         --------
         >>> map._to_png()
         >>> map._to_png(time=10)  # Wait 10 seconds between render and snapshot.
-        """
 
+        """
         if self._png_image is None:
-            import selenium.webdriver
+            from selenium import webdriver
+
+            options = webdriver.firefox.options.Options()
+            options.add_argument('--headless')
+            driver = webdriver.Firefox(options=options)
 
-            driver = selenium.webdriver.PhantomJS(
-                service_log_path=os.path.devnull
-            )
-            driver.get('about:blank')
             html = self.get_root().render()
-            html = html.replace('\'', '"').replace('"', '\\"')
-            html = html.replace('\n', '')
-            driver.execute_script('document.write(\"{}\")'.format(html))
-            driver.maximize_window()
-            # Ignore user map size.
-            # todo: fix this
-            # driver.execute_script("document.body.style.width = '100%';")  # noqa
-            # We should probably monitor if some element is present,
-            # but this is OK for now.
-            time.sleep(delay)
-            png = driver.get_screenshot_as_png()
-            driver.quit()
+            with _tmp_html(html) as tmp:
+                # We need the tempfile to avoid JS security issues.
+                driver.get('file:///{path}'.format(path=tmp.name))
+                driver.maximize_window()
+                time.sleep(delay)
+                png = driver.get_screenshot_as_png()
+                driver.quit()
             self._png_image = png
         return self._png_image
 

folium/utilities.py

@@ -7,6 +7,8 @@
 import os
 import struct
 import zlib
+from contextlib import contextmanager
+from tempfile import NamedTemporaryFile
 
 import numpy as np
 
@@ -112,7 +114,7 @@ def _is_url(url):
     """Check to see if `url` has a valid protocol."""
     try:
         return urlparse(url).scheme in _VALID_URLS
-    except:
+    except Exception:
         return False
 
 
@@ -356,3 +358,16 @@ def camelize(key):
     """
     return ''.join(x.capitalize() if i > 0 else x
                    for i, x in enumerate(key.split('_')))
+
+
+@contextmanager
+def _tmp_html(data):
+    tmp = None
+    try:
+        tmp = NamedTemporaryFile(suffix='.html', prefix='folium_')
+        tmp.write(data.encode('utf8'))
+        tmp.flush()
+        yield tmp
+    finally:
+        if tmp is not None:
+            tmp.close()