[SHARE-511][Feature] Store user favicons as a blob (#565)

* Store user favicons in database

* Move provider favicons to their app root

* Allow loading favicons in robot migrations

* Generate all robot favicon migrations

* Fix migration dependencies

* 404 on missing favicon, not 500

* Change favicon path in graphql endpoint

* Change harvester favicon location in docs

* Add favicon url to /sources endpoint

* Fix requirements typo

* Add favicon migrations for disabled harvesters

* Reorder docs a little

* Responding to review

* Update migrations

* Add missing favicons

* Add forgotten import

* Resolve multiple leaf migrations

* Fix some favicon migrations

* Require GET at favicon endpoint, and don't 500.

Author: aaxelb

api/serializers.py

@@ -125,11 +125,14 @@ def get_token(self, obj):
     def is_superuser(self, obj):
         return obj.is_superuser
 
+    def get_favicon(self, obj):
+        return obj.favicon.url if obj.favicon else None
+
     class Meta:
         model = models.ShareUser
         fields = (
             'username', 'first_name', 'last_name', 'email', 'date_joined', 'last_login',
-            'is_active', 'gravatar', 'locale', 'time_zone'
+            'is_active', 'gravatar', 'locale', 'time_zone', 'favicon'
         )
 
 
@@ -146,7 +149,7 @@ def provider_name(self, obj):
 
     class Meta:
         model = models.ShareUser
-        fields = ('home_page', 'long_title', 'date_joined', 'gravatar')
+        fields = ('home_page', 'long_title', 'date_joined', 'gravatar', 'favicon')
 
 
 class SiteBannerSerializer(ShareModelSerializer):

api/views/share.py

@@ -5,13 +5,15 @@
 from rest_framework_json_api import serializers
 
 from django import http
+from django.views.decorators.http import require_GET
 from django.views.generic.base import RedirectView
 from django.shortcuts import get_object_or_404
 
 from api.filters import ShareObjectFilterSet
 from api import serializers as api_serializers
 
 from share.util import IDObfuscator, InvalidID
+from share.models import ShareUser
 
 
 class VersionsViewSet(viewsets.ReadOnlyModelViewSet):
@@ -107,6 +109,16 @@ def get(self, request, *args, **kwargs):
         return Response(ser.data)
 
 
+@require_GET
+def user_favicon_view(request, username):
+    user = get_object_or_404(ShareUser, username=username)
+    if not user.favicon:
+        raise http.Http404('Favicon for user {} does not exist'.format(user.username))
+    response = http.FileResponse(user.favicon)
+    response['Content-Type'] = 'image/x-icon'
+    return response
+
+
 class HttpSmartResponseRedirect(http.HttpResponseRedirect):
     status_code = 307
 

docs/harvesters_and_normalizers.rst

@@ -149,12 +149,12 @@ Adding a new provider
     - See :ref:`Best practices for writing a non-OAI Harvester <writing-harvesters>`
 - Writing the normalizer
     - See :ref:`Best practices for writing a non-OAI Normalizer <writing-normalizers>`
-- Adding the migration
-    - Finally, run ``./manage.py makeprovidermigrations`` in the terminal
-    - Include only the relevant migration in the PR
 - Adding a provider's favicon
     - visit ``www.domain.com/favicon.ico`` and download the ``favicon.ico`` file
-    - place ``favicon.ico`` in ``providers/domain/provider_name/static/domain.provider_name/img/``
+    - place ``favicon.ico`` in the ``providers/`` specific folder
+- Adding the migration
+    - Finally, run ``./manage.py makeprovidermigrations`` in the terminal
+    - Include only the relevant migrations in the PR
 
 .. _OAI-PMH: http://www.openarchives.org/OAI/openarchivesprotocol.html
 

project/urls.py

@@ -22,7 +22,7 @@
 
 from osf_oauth2_adapter import views as osf_oauth2_adapter_views
 
-from api.views import APIVersionRedirectView
+from api.views import APIVersionRedirectView, user_favicon_view
 
 urlpatterns = [
     url(r'^admin/', admin.site.urls),
@@ -38,7 +38,8 @@
     url(r'^favicon.ico$', RedirectView.as_view(
         url=staticfiles_storage.url('favicon.ico'),
         permanent=False
-    ), name="favicon"),
+    ), name='favicon'),
+    url(r'^favicons/(?P<username>[^/]+).ico$', user_favicon_view, name='user_favicon'),
 ]
 
 if settings.DEBUG:

…ers/au/uow/static/au.uow/img/favicon.ico providers/au/uow/favicon.icoproviders/au/uow/static/au.uow/img/favicon.ico renamed to providers/au/uow/favicon.ico providers/au/uow/static/au.uow/img/favicon.ico renamed to providers/au/uow/favicon.ico

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.9.7 on 2017-02-01 21:23
+from __future__ import unicode_literals
+
+from django.db import migrations
+import share.robot
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('au.uow', '0001_initial'),
+        ('share', '0018_store_favicons'),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            code=share.robot.RobotFaviconMigration('au.uow'),
+        ),
+    ]

providers/au/uow/migrations/0002_favicon.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.9.7 on 2017-02-01 21:23
+from __future__ import unicode_literals
+
+from django.db import migrations
+import share.robot
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('be.ghent', '0001_initial'),
+        ('share', '0018_store_favicons'),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            code=share.robot.RobotFaviconMigration('be.ghent'),
+        ),
+    ]

…be/ghent/static/be.ghent/img/favicon.ico providers/be/ghent/favicon.icoproviders/be/ghent/static/be.ghent/img/favicon.ico renamed to providers/be/ghent/favicon.ico providers/be/ghent/static/be.ghent/img/favicon.ico renamed to providers/be/ghent/favicon.ico

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.9.7 on 2017-02-01 21:23
+from __future__ import unicode_literals
+
+from django.db import migrations
+import share.robot
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('br.pcurio', '0001_initial'),
+        ('share', '0018_store_favicons'),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            code=share.robot.RobotFaviconMigration('br.pcurio'),
+        ),
+    ]