From 96268655d2c2490634182a29a74b4a81eedc4cac Mon Sep 17 00:00:00 2001 From: Solo Date: Thu, 16 Aug 2018 17:05:54 +0800 Subject: [PATCH 1/4] Prepare Paperless for new front end - enable CORS for localhost calls - add Filter to allow API calls that can select Documents without any tag --- requirements.txt | 1 + src/documents/filters.py | 3 ++- src/paperless/settings.py | 5 +++++ 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 0c46e4f8d..81dcbb6d5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,6 +5,7 @@ chardet==3.0.4 coverage==4.5.1 coveralls==1.3.0 dateparser==0.7.0 +django-cors-headers=2.4.0 django-crispy-forms==1.7.2 django-extensions==2.0.7 django-filter==1.1.0 diff --git a/src/documents/filters.py b/src/documents/filters.py index c3c60ccc7..e58ecf862 100644 --- a/src/documents/filters.py +++ b/src/documents/filters.py @@ -1,4 +1,4 @@ -from django_filters.rest_framework import CharFilter, FilterSet +from django_filters.rest_framework import CharFilter, FilterSet, BooleanFilter from .models import Correspondent, Document, Tag @@ -46,6 +46,7 @@ class DocumentFilterSet(FilterSet): correspondent__slug = CharFilter(name="correspondent__slug", **CHAR_KWARGS) tags__name = CharFilter(name="tags__name", **CHAR_KWARGS) tags__slug = CharFilter(name="tags__slug", **CHAR_KWARGS) + tags__empty = BooleanFilter(name='tags', lookup_expr='isnull', distinct=True) class Meta(object): model = Document diff --git a/src/paperless/settings.py b/src/paperless/settings.py index 91d2d2651..ed79adade 100644 --- a/src/paperless/settings.py +++ b/src/paperless/settings.py @@ -61,6 +61,7 @@ INSTALLED_APPS = [ "django.contrib.messages", "django.contrib.staticfiles", + "corsheaders", "django_extensions", "documents.apps.DocumentsConfig", @@ -84,6 +85,7 @@ if os.getenv("PAPERLESS_INSTALLED_APPS"): MIDDLEWARE_CLASSES = [ 'django.middleware.security.SecurityMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', + 'corsheaders.middleware.CorsMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', @@ -92,6 +94,9 @@ MIDDLEWARE_CLASSES = [ 'django.middleware.clickjacking.XFrameOptionsMiddleware', ] +# We allow CORS from localhosts +CORS_ORIGIN_REGEX_WHITELIST = (r'^(https?:\/\/)?localhost(:[0-9]{4})?$', ) + # If auth is disabled, we just use our "bypass" authentication middleware if bool(os.getenv("PAPERLESS_DISABLE_LOGIN", "false").lower() in ("yes", "y", "1", "t", "true")): _index = MIDDLEWARE_CLASSES.index("django.contrib.auth.middleware.AuthenticationMiddleware") From 1bb80548d20042d3fb347a3b533728111a8d46dd Mon Sep 17 00:00:00 2001 From: Solo Date: Thu, 16 Aug 2018 21:29:03 +0800 Subject: [PATCH 2/4] Refs feedback: - fix requirements.txt - change static CORS regex into configurable tuple list --- paperless.conf.example | 5 +++++ requirements.txt | 2 +- src/paperless/settings.py | 8 ++++++-- 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/paperless.conf.example b/paperless.conf.example index 3d90b2915..8aa33216f 100644 --- a/paperless.conf.example +++ b/paperless.conf.example @@ -89,6 +89,11 @@ PAPERLESS_EMAIL_SECRET="" # as is "example.com,www.example.com", but NOT " example.com" or "example.com," #PAPERLESS_ALLOWED_HOSTS="example.com,www.example.com" +# If you decide to use Paperless APIs in an ajax calls, you need to add your +# servers to the allowed hosts that can do CORS calls. By default Paperless allows +# calls from localhost:8080. The same rules as above how the list should look like. +#PAPERLESS_CORS_ALLOWED_HOSTS="localhost:8080,example.com,localhost:8000" + # To host paperless under a subpath url like example.com/paperless you set # this value to /paperless. No trailing slash! # diff --git a/requirements.txt b/requirements.txt index 81dcbb6d5..125a89ac7 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,7 +5,7 @@ chardet==3.0.4 coverage==4.5.1 coveralls==1.3.0 dateparser==0.7.0 -django-cors-headers=2.4.0 +django-cors-headers==2.4.0 django-crispy-forms==1.7.2 django-extensions==2.0.7 django-filter==1.1.0 diff --git a/src/paperless/settings.py b/src/paperless/settings.py index ed79adade..cd157c180 100644 --- a/src/paperless/settings.py +++ b/src/paperless/settings.py @@ -94,8 +94,12 @@ MIDDLEWARE_CLASSES = [ 'django.middleware.clickjacking.XFrameOptionsMiddleware', ] -# We allow CORS from localhosts -CORS_ORIGIN_REGEX_WHITELIST = (r'^(https?:\/\/)?localhost(:[0-9]{4})?$', ) +# We allow CORS from localhost:8080 +CORS_ORIGIN_WHITELIST = ("localhost:8080") +_allowed_cors_hosts = os.getenv("PAPERLESS_CORS_ALLOWED_HOSTS") +if _allowed_cors_hosts: + CORS_ORIGIN_WHITELIST = tuple(_allowed_cors_hosts.split(",")) + # If auth is disabled, we just use our "bypass" authentication middleware if bool(os.getenv("PAPERLESS_DISABLE_LOGIN", "false").lower() in ("yes", "y", "1", "t", "true")): From 4e5ee24618364a630783b5ad3c8e623f97653c17 Mon Sep 17 00:00:00 2001 From: Solo Date: Thu, 16 Aug 2018 21:48:45 +0800 Subject: [PATCH 3/4] Refs Travis - fix for 80 chars limit --- src/documents/filters.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/documents/filters.py b/src/documents/filters.py index e58ecf862..2ed7f29db 100644 --- a/src/documents/filters.py +++ b/src/documents/filters.py @@ -46,7 +46,9 @@ class DocumentFilterSet(FilterSet): correspondent__slug = CharFilter(name="correspondent__slug", **CHAR_KWARGS) tags__name = CharFilter(name="tags__name", **CHAR_KWARGS) tags__slug = CharFilter(name="tags__slug", **CHAR_KWARGS) - tags__empty = BooleanFilter(name='tags', lookup_expr='isnull', distinct=True) + tags__empty = BooleanFilter(name='tags', + lookup_expr='isnull', + distinct=True) class Meta(object): model = Document From 70608f7e31d8ff018251c3a8118603b4c959c6ec Mon Sep 17 00:00:00 2001 From: Solo Date: Fri, 17 Aug 2018 11:48:39 +0800 Subject: [PATCH 4/4] Refs feedback - replace multiline logic with single line --- src/paperless/settings.py | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/src/paperless/settings.py b/src/paperless/settings.py index cd157c180..e40af01d1 100644 --- a/src/paperless/settings.py +++ b/src/paperless/settings.py @@ -95,11 +95,7 @@ MIDDLEWARE_CLASSES = [ ] # We allow CORS from localhost:8080 -CORS_ORIGIN_WHITELIST = ("localhost:8080") -_allowed_cors_hosts = os.getenv("PAPERLESS_CORS_ALLOWED_HOSTS") -if _allowed_cors_hosts: - CORS_ORIGIN_WHITELIST = tuple(_allowed_cors_hosts.split(",")) - +CORS_ORIGIN_WHITELIST = tuple(os.getenv("PAPERLESS_CORS_ALLOWED_HOSTS", "localhost:8080").split(",")) # If auth is disabled, we just use our "bypass" authentication middleware if bool(os.getenv("PAPERLESS_DISABLE_LOGIN", "false").lower() in ("yes", "y", "1", "t", "true")):