Merge pull request #1196 from umap-project/dashboard

Dashboard

umap/static/umap/content.css

@@ -282,6 +282,29 @@ ul.umap-autocomplete {
 }
 
 
+/* **************************** */
+/*           Dashboard          */
+/* **************************** */
+table.maps {
+    width: 100%;
+}
+table.maps .map_fragment {
+    height: 100px;
+    width: 100%;
+    min-width: 200px;
+}
+table.maps tbody tr:nth-child(odd) {
+    background-color: #f4f4f4;
+}
+table.maps td {
+    text-align: center;
+}
+table.maps thead tr {
+    line-height: 2em;
+}
+
+
+
 /* **************************** */
 /*   Override Leaflet.Storage   */
 /* **************************** */

umap/static/umap/js/umap.controls.js

@@ -1019,6 +1019,39 @@ L.U.Map.include({
     this.ui.openPanel({ data: { html: container }, actions: actions })
   },
 
+  EXPORT_TYPES: {
+    geojson: {
+      formatter: function (map) {
+        return JSON.stringify(map.toGeoJSON(), null, 2)
+      },
+      ext: '.geojson',
+      filetype: 'application/json',
+    },
+    gpx: {
+      formatter: function (map) {
+        return togpx(map.toGeoJSON())
+      },
+      ext: '.gpx',
+      filetype: 'application/xml',
+    },
+    kml: {
+      formatter: function (map) {
+        return tokml(map.toGeoJSON())
+      },
+      ext: '.kml',
+      filetype: 'application/vnd.google-earth.kml+xml',
+    },
+    umap: {
+      name: L._('Full map data'),
+      formatter: function (map) {
+        return map.serialize()
+      },
+      ext: '.umap',
+      filetype: 'application/json',
+      selected: true,
+    },
+  },
+
   renderShareBox: function () {
     const container = L.DomUtil.create('div', 'umap-share')
     const embedTitle = L.DomUtil.add('h4', '', container, L._('Embed the map'))
@@ -1091,66 +1124,36 @@ L.U.Map.include({
       else exportCaveat.style.display = 'inherit'
     }
     L.DomEvent.on(typeInput, 'change', toggleCaveat)
-    const types = {
-      geojson: {
-        formatter: function (map) {
-          return JSON.stringify(map.toGeoJSON(), null, 2)
-        },
-        ext: '.geojson',
-        filetype: 'application/json',
-      },
-      gpx: {
-        formatter: function (map) {
-          return togpx(map.toGeoJSON())
-        },
-        ext: '.gpx',
-        filetype: 'application/xml',
-      },
-      kml: {
-        formatter: function (map) {
-          return tokml(map.toGeoJSON())
-        },
-        ext: '.kml',
-        filetype: 'application/vnd.google-earth.kml+xml',
-      },
-      umap: {
-        name: L._('Full map data'),
-        formatter: function (map) {
-          return map.serialize()
-        },
-        ext: '.umap',
-        filetype: 'application/json',
-        selected: true,
-      },
-    }
-    for (const key in types) {
-      if (types.hasOwnProperty(key)) {
+    for (const key in this.EXPORT_TYPES) {
+      if (this.EXPORT_TYPES.hasOwnProperty(key)) {
         option = L.DomUtil.create('option', '', typeInput)
         option.value = key
-        option.textContent = types[key].name || key
-        if (types[key].selected) option.selected = true
+        option.textContent = this.EXPORT_TYPES[key].name || key
+        if (this.EXPORT_TYPES[key].selected) option.selected = true
       }
     }
     toggleCaveat()
     const download = L.DomUtil.create('a', 'button', container)
     download.textContent = L._('Download data')
-    L.DomEvent.on(
-      download,
-      'click',
-      () => {
-        const type = types[typeInput.value]
-        const content = type.formatter(this)
-        let name = this.options.name || 'data'
-        name = name.replace(/[^a-z0-9]/gi, '_').toLowerCase()
-        download.download = name + type.ext
-        window.URL = window.URL || window.webkitURL
-        const blob = new Blob([content], { type: type.filetype })
-        download.href = window.URL.createObjectURL(blob)
-      },
-      this
-    )
+    L.DomEvent.on(download, 'click', () => this.download(typeInput.value), this)
     this.ui.openPanel({ data: { html: container } })
   },
+
+  download: function (mode) {
+    const type = this.EXPORT_TYPES[mode || 'umap']
+    const content = type.formatter(this)
+    let name = this.options.name || 'data'
+    name = name.replace(/[^a-z0-9]/gi, '_').toLowerCase()
+    window.URL = window.URL || window.webkitURL
+    const blob = new Blob([content], { type: type.filetype })
+    const el = document.createElement('a')
+    el.download = name + type.ext
+    el.href = window.URL.createObjectURL(blob)
+    el.style.display = 'none'
+    document.body.appendChild(el)
+    el.click()
+    document.body.removeChild(el)
+  },
 })
 
 L.U.TileLayerControl = L.Control.extend({

umap/static/umap/js/umap.js

@@ -91,12 +91,8 @@ L.U.Map.include({
 
     this.ui = new L.U.UI(this._container)
     this.xhr = new L.U.Xhr(this.ui)
-    this.xhr.on('dataloding', function (e) {
-      this.fire('dataloding', e)
-    })
-    this.xhr.on('datalaod', function (e) {
-      this.fire('datalaod', e)
-    })
+    this.xhr.on('dataloading',  (e) => this.fire('dataloading', e))
+    this.xhr.on('dataload', (e) => this.fire('dataload', e))
 
     this.initLoader()
     this.name = this.options.name
@@ -255,13 +251,16 @@ L.U.Map.include({
     }
     this.initShortcuts()
     this.onceDatalayersLoaded(function () {
-      if (this.options.onLoadPanel === 'databrowser') this.openBrowser()
+      if (L.Util.queryString('share')) this.renderShareBox()
+      else if (this.options.onLoadPanel === 'databrowser') this.openBrowser()
       else if (this.options.onLoadPanel === 'caption') this.displayCaption()
       else if (this.options.onLoadPanel === 'datafilters') this.openFilter()
     })
     this.onceDataLoaded(function () {
       const slug = L.Util.queryString('feature')
       if (slug && this.features_index[slug]) this.features_index[slug].view()
+      if (L.Util.queryString('edit')) this.enableEdit()
+      if (L.Util.queryString('download')) this.download()
     })
 
     window.onbeforeunload = (e) => {

umap/templates/umap/map_table.html

@@ -0,0 +1,41 @@
+{% load umap_tags umap_tags i18n %}
+<table class="maps">
+  {% if not is_ajax %}
+  <thead>
+    <tr>
+      <th>{% blocktrans %}Map{% endblocktrans %}</th>
+      <th>{% blocktrans %}Name{% endblocktrans %}</th>
+      <th>{% blocktrans %}Status{% endblocktrans %}</th>
+      <th>{% blocktrans %}Last save{% endblocktrans %}</th>
+      <th>{% blocktrans %}Owner{% endblocktrans %}</th>
+      <th>{% blocktrans %}Actions{% endblocktrans %}</th>
+    </tr>
+  </thead>
+  {% endif %}
+  <tbody>
+    {% for map_inst in maps %}
+      <tr>
+        <td>{% map_fragment map_inst prefix=prefix page=request.GET.p %}</td>
+        <td>
+          <a href="{{ map_inst.get_absolute_url }}">{{ map_inst.name }}</a>
+        </td>
+        <td>{{ map_inst.get_edit_status_display }}</td>
+        <td>{{ map_inst.modified_at }}</td>
+        <td>
+          <a href="{{ map_inst.owner.get_url }}">{{ map_inst.owner }}</a>
+        </td>
+        <td>
+          <a href="{{ map_inst.get_absolute_url }}?share">{% translate "Share" %}</a>
+          <a href="{{ map_inst.get_absolute_url }}?edit">{% translate "Edit" %}</a>
+          <a href="{{ map_inst.get_absolute_url }}?download">{% translate "Download" %}</a>
+        </td>
+      </tr>
+    {% endfor %}
+  </tbody>
+</table>
+{% if maps.has_next %}
+  <div class="col wide">
+    <a href="?{% paginate_querystring maps.next_page_number %}"
+       class="button more_button neutral">{% trans "More" %}</a>
+  </div>
+{% endif %}

umap/templates/umap/navigation.html

@@ -9,7 +9,7 @@
     <ul>
       {% if user.is_authenticated %}
         <li>
-          <a href="{{ user.get_url }}">{% trans "My maps" %} ({{ user }})</a>
+          <a href="{% url 'user_dashboard' %}">{% trans "My maps" %} ({{ user }})</a>
         </li>
         <li>
           <a href="{{ user.get_stars_url }}">{% trans "Starred maps" %}</a>

umap/templates/umap/search.html

@@ -4,7 +4,7 @@
   {% include "umap/search_bar.html" %}
   <div class="wrapper">
     <div class="map_list row">
-      {% if q %}
+      {% if request.GET.q %}
         {% if maps %}
           <h2>
             {% blocktranslate trimmed count counter=count %}

umap/templates/umap/search_bar.html

@@ -1,12 +1,14 @@
 {% load i18n %}
+{% url "search" as search_url %}
+{% trans "Search maps" as default_placeholder %}
 <div class="wrapper search_wrapper">
   <div class="row">
-    <form action="{% url "search" %}" method="get">
+    <form action="{% firstof action search_url %}" method="get">
       <div class="col two-third mwide">
         <input name="q"
                type="search"
-               placeholder="{% trans "Search maps" %}"
-               value="{{ q|default:"" }}" />
+               placeholder="{% firstof placeholder default_placeholder %}"
+               value="{{ request.GET.q|default:"" }}" />
       </div>
       <div class="col third mwide">
         <input type="submit" value="{% trans "Search" %}" class="neutral" />

umap/templates/umap/user_dashboard.html

@@ -0,0 +1,25 @@
+{% extends "umap/content.html" %}
+{% load i18n %}
+
+{% block head_title %}
+    {{ SITE_NAME }} - {% trans "My dashboard" %}
+{% endblock head_title %}
+
+{% block maincontent %}
+  {% trans "Search my maps" as placeholder %}
+  <div class="col wide">
+    <h2 class="section">{% trans "My dashboard" %}</h2>
+    {% include "umap/search_bar.html" with action=request.get_full_path placeholder=placeholder %}
+  </div>
+  <div class="wrapper">
+    <div class="row">
+      {% if maps %}
+        {% include "umap/map_table.html" %}
+      {% else %}
+        <div>
+          {% blocktrans %}You have no map yet.{% endblocktrans %} <a href="{% url 'map_new' %}">{% translate "Create a map" %}</a>
+        </div>
+      {% endif %}
+    </div>
+  </div>
+{% endblock maincontent %}

umap/tests/test_views.py

@@ -240,3 +240,22 @@ def test_change_user_slug(client, user, settings):
     settings.USER_URL_FIELD = "pk"
     response = client.get(reverse("home"))
     assert f"/en/user/{user.pk}/" in response.content.decode()
+
+
+@pytest.mark.django_db
+def test_user_dashboard_is_restricted_to_logged_in(client):
+    response = client.get(reverse("user_dashboard"))
+    assert response.status_code == 302
+    assert response["Location"] == "/en/login/?next=/en/me"
+
+
+@pytest.mark.django_db
+def test_user_dashboard_display_user_maps(client, map):
+    client.login(username=map.owner.username, password="123123")
+    response = client.get(reverse("user_dashboard"))
+    assert response.status_code == 200
+    body = response.content.decode()
+    assert map.name in body
+    assert f"{map.get_absolute_url()}?edit" in body
+    assert f"{map.get_absolute_url()}?share" in body
+    assert f"{map.get_absolute_url()}?download" in body

umap/urls.py

@@ -98,6 +98,11 @@ i18n_urls += decorated_patterns(
         views.ToggleMapStarStatus.as_view(),
         name="map_star",
     ),
+    re_path(
+        r"^me$",
+        views.user_dashboard,
+        name="user_dashboard",
+    ),
 )
 map_urls = [
     re_path(

umap/views.py

@@ -77,7 +77,7 @@ PRIVATE_IP = re.compile(
 ANONYMOUS_COOKIE_MAX_AGE = 60 * 60 * 24 * 30  # One month
 
 
-class PaginatorMixin(object):
+class PaginatorMixin:
     per_page = 5
 
     def paginate(self, qs, per_page=None):
@@ -94,9 +94,20 @@ class PaginatorMixin(object):
             qs = paginator.page(paginator.num_pages)
         return qs
 
+    def get_context_data(self, **kwargs):
+        kwargs.update({"is_ajax": is_ajax(self.request)})
+        return super().get_context_data(**kwargs)
+
+    def get_template_names(self):
+        """
+        Dispatch template according to the kind of request: ajax or normal.
+        """
+        if is_ajax(self.request):
+            return [self.list_template_name]
+        return super().get_template_names()
+
 
 class PublicMapsMixin(object):
-
     def get_public_maps(self):
         qs = Map.public
         if (
@@ -109,7 +120,7 @@ class PublicMapsMixin(object):
         return maps
 
 
-class Home(TemplateView, PublicMapsMixin, PaginatorMixin):
+class Home(PaginatorMixin, TemplateView, PublicMapsMixin):
     template_name = "umap/home.html"
     list_template_name = "umap/map_list.html"
 
@@ -142,15 +153,6 @@ class Home(TemplateView, PublicMapsMixin, PaginatorMixin):
             "showcase_map": showcase_map,
         }
 
-    def get_template_names(self):
-        """
-        Dispatch template according to the kind of request: ajax or normal.
-        """
-        if is_ajax(self.request):
-            return [self.list_template_name]
-        else:
-            return [self.template_name]
-
 
 home = Home.as_view()
 
@@ -162,7 +164,7 @@ class About(Home):
 about = About.as_view()
 
 
-class UserMaps(DetailView, PaginatorMixin):
+class UserMaps(PaginatorMixin, DetailView):
     model = User
     slug_url_kwarg = "identifier"
     slug_field = settings.USER_URL_FIELD
@@ -190,15 +192,6 @@ class UserMaps(DetailView, PaginatorMixin):
         kwargs.update({"maps": self.paginate(self.get_maps(), self.per_page)})
         return super().get_context_data(**kwargs)
 
-    def get_template_names(self):
-        """
-        Dispatch template according to the kind of request: ajax or normal.
-        """
-        if is_ajax(self.request):
-            return [self.list_template_name]
-        else:
-            return super(UserMaps, self).get_template_names()
-
 
 user_maps = UserMaps.as_view()
 
@@ -216,37 +209,34 @@ class UserStars(UserMaps):
 user_stars = UserStars.as_view()
 
 
-class Search(TemplateView, PublicMapsMixin, PaginatorMixin):
-    template_name = "umap/search.html"
-    list_template_name = "umap/map_list.html"
-
-    def get_context_data(self, **kwargs):
+class SearchMixin:
+    def get_search_queryset(self, **kwargs):
         q = self.request.GET.get("q")
-        qs_count = 0
-        results = []
         if q:
             vector = SearchVector("name", config=settings.UMAP_SEARCH_CONFIGURATION)
             query = SearchQuery(
                 q, config=settings.UMAP_SEARCH_CONFIGURATION, search_type="websearch"
             )
-            qs = Map.objects.annotate(search=vector).filter(search=query)
+            return Map.objects.annotate(search=vector).filter(search=query)
+
+
+class Search(PaginatorMixin, TemplateView, PublicMapsMixin, SearchMixin):
+    template_name = "umap/search.html"
+    list_template_name = "umap/map_list.html"
+
+    def get_context_data(self, **kwargs):
+        qs = self.get_search_queryset()
+        qs_count = 0
+        results = []
+        if qs is not None:
             qs = qs.filter(share_status=Map.PUBLIC).order_by("-modified_at")
             qs_count = qs.count()
             results = self.paginate(qs)
         else:
-            results = self.get_public_maps()[:settings.UMAP_MAPS_PER_SEARCH]
-        kwargs.update({"maps": results, "count": qs_count, "q": q})
+            results = self.get_public_maps()[: settings.UMAP_MAPS_PER_SEARCH]
+        kwargs.update({"maps": results, "count": qs_count})
         return kwargs
 
-    def get_template_names(self):
-        """
-        Dispatch template according to the kind of request: ajax or normal.
-        """
-        if is_ajax(self.request):
-            return [self.list_template_name]
-        else:
-            return super(Search, self).get_template_names()
-
     @property
     def per_page(self):
         return settings.UMAP_MAPS_PER_SEARCH
@@ -255,6 +245,29 @@ class Search(TemplateView, PublicMapsMixin, PaginatorMixin):
 search = Search.as_view()
 
 
+class UserDashboard(PaginatorMixin, DetailView, SearchMixin):
+    model = User
+    template_name = "umap/user_dashboard.html"
+    list_template_name = "umap/map_table.html"
+
+    def get_object(self):
+        return self.get_queryset().get(pk=self.request.user.pk)
+
+    def get_maps(self):
+        qs = self.get_search_queryset() or Map.objects.all()
+        qs = qs.filter(Q(owner=self.object) | Q(editors=self.object))
+        return qs.order_by("-modified_at")
+
+    def get_context_data(self, **kwargs):
+        kwargs.update(
+            {"maps": self.paginate(self.get_maps(), settings.UMAP_MAPS_PER_PAGE_OWNER)}
+        )
+        return super().get_context_data(**kwargs)
+
+
+user_dashboard = UserDashboard.as_view()
+
+
 class MapsShowCase(View):
     def get(self, *args, **kwargs):
         maps = Map.public.filter(center__distance_gt=(DEFAULT_CENTER, D(km=1)))
@@ -436,7 +449,7 @@ class MapDetailMixin:
             properties["user"] = {
                 "id": user.pk,
                 "name": str(user),
-                "url": user.get_url(),
+                "url": reverse("user_dashboard"),
             }
         map_settings = self.get_geojson()
         if "properties" not in map_settings: