Changeset d1c4782 in OpenWorkouts-current

Timestamp:

Jan 21, 2019, 10:43:20 AM (5 years ago)

Author:

borja <borja@…>

Branches:

current, feature/docs, master

Children:

be40b02

Parents:

ceae158

Message:

Show a capture of the workout map, as an image, in the dashboard:

• Added a view to render the tracking map of a workout full screen

• Added a small shell script that uses chrome to grabs a screenshot of the full screen map view of a workout, then uses imagemagick convert to crop/resize it and finally saves it in a given location

• Added a static/maps directory to store maps captures

• Added static/maps to the boring/ignore file

• Added a tool in utilities.py to call the shell script that captures the screenshot of the map

• Added a method to the Workout model, that returns the static path to the workout map capture (valid to use with request.static_url()). If there is no capture yet, call the tool to make one

• Added code to dashboard.pt to show the capture of the map

• Added a new parameter to te ow maps js code, allowing us to hide/show the zoom controls of the map when building a new one

Files:

• .boring (modified) (1 diff)
• bin/screenshot_map (added)
• ow/models/workout.py (modified) (3 diffs)
• ow/static/css/main.css (modified) (1 diff)
• ow/static/js/ow.js (modified) (2 diffs)
• ow/static/media/img/no_map.png (added)
• ow/templates/dashboard.pt (modified) (1 diff)
• ow/templates/workout-map.pt (added)
• ow/templates/workout.pt (modified) (1 diff)
• ow/utilities.py (modified) (3 diffs)
• ow/views/workout.py (modified) (1 diff)

.boring

@@ -138 +138 @@
 ow.egg-info/*
 ow/static/components
+ow/static/maps

ow/models/workout.py

@@ -1 @@
-
+import os
 from datetime import datetime, timedelta, timezone
 from decimal import Decimal
@@ -12 +12 @@
     copy_blob,
     create_blob,
-    mps_to_kmph
+    mps_to_kmph,
+    save_map_screenshot
 )
 
@@ -419 +420 @@
     def has_fit(self):
         return self.fit_file is not None
+
+    @property
+    def map_screenshot(self):
+        """
+        Return the static path to the screenshot image of the map for
+        this workout (works only for workouts with gps tracking)
+        """
+        if not self.has_gpx:
+            return None
+
+        current_path = os.path.abspath(os.path.dirname(__file__))
+        screenshot_path = os.path.join(
+            current_path, '../static/maps',
+            str(self.owner.uid), str(self.workout_id)) + '.png'
+
+        if not os.path.exists(screenshot_path):
+            # screenshot does not exist, generate it
+            save_map_screenshot(self)
+
+        # the value returned is relative to the static files served
+        # by the app, so we can use request.static_url() with it
+        static_path = os.path.join('static/maps', str(self.owner.uid),
+                                   str(self.workout_id))
+        return 'ow:' + static_path + '.png'

ow/static/css/main.css

@@ -752 +752 @@
 }
 
+.workout-map img {
+    width: 100%;
+}
+
 .owo-del a:hover {
     color:red

ow/static/js/ow.js

@@ -25 +25 @@
     var shadow = spec.shadow;
     var elevation = spec.elevation;
+    var zoom_control = spec.zoom_control;
 
     // OpenStreetMap urls and references
-    var openstreetmap_url = 'http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png'
-    var openstreetmap_attr = 'Map data &copy; <a href="http://www.osm.org">OpenStreetMap</a>'
+    var openstreetmap_url = 'http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png';
+    var openstreetmap_attr = 'Map data &copy; <a href="http://www.osm.org">OpenStreetMap</a>';
 
     // Some constants reused through the code
@@ -38 +39 @@
     var create_map = function create_map(latitude, longitude, zoom) {
         /* Create a Leaflet map, set center point and add tiles */
-        map = L.map(map_id, {preferCanvas: true});
+        map = L.map(map_id, {zoomControl: zoom_control});
         map.setView([latitude, longitude], zoom);
         var tile_layer = L.tileLayer(openstreetmap_url, {

ow/templates/dashboard.pt

@@ -90 +90 @@
             <div class="workout-intro" tal:content="workout.notes"></div>
 
+            <div class="workout-map" tal:condition="workout.has_gpx">
+                <a href="" tal:attributes="href request.resource_url(workout)">
+                    <img src="" tal:attributes="src request.static_url(workout.map_screenshot);
+                              alt workout.title; title workout.title">
+                </a>
+            </div>
+
             <ul class="workout-options">
               <li class="owo-edit"><a href="" i18n:translate="" tal:attributes="href request.resource_url(workout, 'edit')"><span>edit</span></a></li>

ow/templates/workout.pt

@@ -160 +160 @@
          end_icon: '${request.static_url('ow:static/components/leaflet-gpx/pin-icon-end.png')}',
          shadow: '${request.static_url('ow:static/components/leaflet-gpx/pin-shadow.png')}',
-         elevation: true
+         elevation: true,
+         zoom_control: true
      });
      workout_map.render();

ow/utilities.py

@@ -1 +1 @@
 import re
+import os
+import logging
+import subprocess
 from datetime import datetime
 from decimal import Decimal
@@ -7 +10 @@
 from xml.dom import minidom
 from ZODB.blob import Blob
+
+log = logging.getLogger(__name__)
 
 
@@ -184 +189 @@
         open_blob.write(data)
     return blob
+
+
+def save_map_screenshot(workout):
+    if workout.has_gpx:
+        current_path = os.path.abspath(os.path.dirname(__file__))
+        tool_path = os.path.join(current_path, '../bin/screenshot_map')
+
+        screenshots_path = os.path.join(
+            current_path, 'static/maps', str(workout.owner.uid))
+        if not os.path.exists(screenshots_path):
+            os.makedirs(screenshots_path)
+
+        screenshot_path = os.path.join(
+            screenshots_path, str(workout.workout_id))
+        screenshot_path += '.png'
+
+        subprocess.run(
+            [tool_path, str(workout.owner.uid), str(workout.workout_id),
+             screenshot_path], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+
+        return True
+
+    return False

ow/views/workout.py

@@ -214 +214 @@
         content_disposition='attachment; filename="%s"' % gpx_slug,
         body_file=context.tracking_file.open())
+
+
+@view_config(
+    context=Workout,
+    name='map',
+    renderer='ow:templates/workout-map.pt')
+def workout_map(context, request):
+    """
+    Render a page that has only a map with tracking info
+    """
+    start_point = {}
+    if context.has_gpx:
+        with context.tracking_file.open() as gpx_file:
+            gpx_contents = gpx_file.read()
+            gpx_contents = gpx_contents.decode('utf-8')
+            gpx = gpxpy.parse(gpx_contents)
+            if gpx.tracks:
+                track = gpx.tracks[0]
+                center_point = track.get_center()
+                start_point = {'latitude': center_point.latitude,
+                               'longitude': center_point.longitude,
+                               'elevation': center_point.elevation}
+    return {'start_point': start_point}