| {{ tag.name }} |
- {{ getColor(tag.colour).name }} |
+ {{tag.color}} |
{{ getMatching(tag) }} |
{{ tag.document_count }} |
diff --git a/src-ui/src/app/components/manage/tag-list/tag-list.component.ts b/src-ui/src/app/components/manage/tag-list/tag-list.component.ts
index f9d0678ab..7ea379f64 100644
--- a/src-ui/src/app/components/manage/tag-list/tag-list.component.ts
+++ b/src-ui/src/app/components/manage/tag-list/tag-list.component.ts
@@ -1,7 +1,7 @@
import { Component } from '@angular/core';
import { NgbModal } from '@ng-bootstrap/ng-bootstrap';
import { FILTER_HAS_TAG } from 'src/app/data/filter-rule-type';
-import { TAG_COLOURS, PaperlessTag } from 'src/app/data/paperless-tag';
+import { PaperlessTag } from 'src/app/data/paperless-tag';
import { DocumentListViewService } from 'src/app/services/document-list-view.service';
import { TagService } from 'src/app/services/rest/tag.service';
import { ToastService } from 'src/app/services/toast.service';
@@ -22,10 +22,6 @@ export class TagListComponent extends GenericListComponent {
super(tagService, modalService, TagEditDialogComponent, toastService)
}
- getColor(id) {
- return TAG_COLOURS.find(c => c.id == id)
- }
-
getDeleteMessage(object: PaperlessTag) {
return $localize`Do you really want to delete the tag "${object.name}"?`
}
diff --git a/src-ui/src/app/data/paperless-tag.ts b/src-ui/src/app/data/paperless-tag.ts
index 45ef8a613..a999666c4 100644
--- a/src-ui/src/app/data/paperless-tag.ts
+++ b/src-ui/src/app/data/paperless-tag.ts
@@ -1,26 +1,10 @@
-import { MatchingModel } from './matching-model';
-import { ObjectWithId } from './object-with-id';
-
-
-export const TAG_COLOURS = [
- {id: 1, value: "#a6cee3", name: $localize`Light blue`, textColor: "#000000"},
- {id: 2, value: "#1f78b4", name: $localize`Blue`, textColor: "#ffffff"},
- {id: 3, value: "#b2df8a", name: $localize`Light green`, textColor: "#000000"},
- {id: 4, value: "#33a02c", name: $localize`Green`, textColor: "#ffffff"},
- {id: 5, value: "#fb9a99", name: $localize`Light red`, textColor: "#000000"},
- {id: 6, value: "#e31a1c", name: $localize`Red `, textColor: "#ffffff"},
- {id: 7, value: "#fdbf6f", name: $localize`Light orange`, textColor: "#000000"},
- {id: 8, value: "#ff7f00", name: $localize`Orange`, textColor: "#000000"},
- {id: 9, value: "#cab2d6", name: $localize`Light violet`, textColor: "#000000"},
- {id: 10, value: "#6a3d9a", name: $localize`Violet`, textColor: "#ffffff"},
- {id: 11, value: "#b15928", name: $localize`Brown`, textColor: "#ffffff"},
- {id: 12, value: "#000000", name: $localize`Black`, textColor: "#ffffff"},
- {id: 13, value: "#cccccc", name: $localize`Light grey`, textColor: "#000000"}
-]
+import { MatchingModel } from "./matching-model";
export interface PaperlessTag extends MatchingModel {
- colour?: number
+ color?: string
+
+ text_color?: string
is_inbox_tag?: boolean
diff --git a/src-ui/src/app/utils/color.ts b/src-ui/src/app/utils/color.ts
new file mode 100644
index 000000000..bcfdef088
--- /dev/null
+++ b/src-ui/src/app/utils/color.ts
@@ -0,0 +1,12 @@
+
+ function componentToHex(c) {
+ var hex = c.toString(16);
+ return hex.length == 1 ? "0" + hex : hex;
+ }
+
+ export function randomColor() {
+ let r = Math.floor(Math.random() * 150) + 50
+ let g = Math.floor(Math.random() * 150) + 50
+ let b = Math.floor(Math.random() * 150) + 50
+ return `#${componentToHex(r)}${componentToHex(g)}${componentToHex(b)}`
+ }
\ No newline at end of file
diff --git a/src-ui/src/environments/environment.prod.ts b/src-ui/src/environments/environment.prod.ts
index 50cf6d954..2d07ac31c 100644
--- a/src-ui/src/environments/environment.prod.ts
+++ b/src-ui/src/environments/environment.prod.ts
@@ -1,7 +1,7 @@
export const environment = {
production: true,
apiBaseUrl: "/api/",
- apiVersion: "1",
+ apiVersion: "2",
appTitle: "Paperless-ng",
version: "1.2.1",
webSocketHost: window.location.host,
diff --git a/src-ui/src/environments/environment.ts b/src-ui/src/environments/environment.ts
index b0ac843d5..3d981b677 100644
--- a/src-ui/src/environments/environment.ts
+++ b/src-ui/src/environments/environment.ts
@@ -5,7 +5,7 @@
export const environment = {
production: false,
apiBaseUrl: "http://localhost:8000/api/",
- apiVersion: "1",
+ apiVersion: "2",
appTitle: "Paperless-ng",
version: "DEVELOPMENT",
webSocketHost: "localhost:8000",
diff --git a/src/documents/admin.py b/src/documents/admin.py
index aee45b49d..c8c16d791 100755
--- a/src/documents/admin.py
+++ b/src/documents/admin.py
@@ -19,12 +19,12 @@ class TagAdmin(admin.ModelAdmin):
list_display = (
"name",
- "colour",
+ "color",
"match",
"matching_algorithm"
)
- list_filter = ("colour", "matching_algorithm")
- list_editable = ("colour", "match", "matching_algorithm")
+ list_filter = ("color", "matching_algorithm")
+ list_editable = ("color", "match", "matching_algorithm")
class DocumentTypeAdmin(admin.ModelAdmin):
diff --git a/src/documents/migrations/1013_migrate_tag_colour.py b/src/documents/migrations/1013_migrate_tag_colour.py
new file mode 100644
index 000000000..323ff2bfb
--- /dev/null
+++ b/src/documents/migrations/1013_migrate_tag_colour.py
@@ -0,0 +1,70 @@
+# Generated by Django 3.1.4 on 2020-12-02 21:43
+
+from django.db import migrations, models
+
+COLOURS_OLD = {
+ 1: "#a6cee3",
+ 2: "#1f78b4",
+ 3: "#b2df8a",
+ 4: "#33a02c",
+ 5: "#fb9a99",
+ 6: "#e31a1c",
+ 7: "#fdbf6f",
+ 8: "#ff7f00",
+ 9: "#cab2d6",
+ 10: "#6a3d9a",
+ 11: "#b15928",
+ 12: "#000000",
+ 13: "#cccccc",
+}
+
+
+def forward(apps, schema_editor):
+ Tag = apps.get_model('documents', 'Tag')
+
+ for tag in Tag.objects.all():
+ colour_old_id = tag.colour_old
+ rgb = COLOURS_OLD[colour_old_id]
+ tag.color = rgb
+ tag.save()
+
+
+def reverse(apps, schema_editor):
+ Tag = apps.get_model('documents', 'Tag')
+
+ def _get_colour_id(rdb):
+ for idx, rdbx in COLOURS_OLD.items():
+ if rdbx == rdb:
+ return idx
+ # Return colour 1 if we can't match anything
+ return 1
+
+ for tag in Tag.objects.all():
+ colour_id = _get_colour_id(tag.color)
+ tag.colour_old = colour_id
+ tag.save()
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('documents', '1012_fix_archive_files'),
+ ]
+
+ operations = [
+ migrations.RenameField(
+ model_name='tag',
+ old_name='colour',
+ new_name='colour_old',
+ ),
+ migrations.AddField(
+ model_name='tag',
+ name='color',
+ field=models.CharField(default='#a6cee3', max_length=7, verbose_name='color'),
+ ),
+ migrations.RunPython(forward, reverse),
+ migrations.RemoveField(
+ model_name='tag',
+ name='colour_old',
+ )
+ ]
diff --git a/src/documents/models.py b/src/documents/models.py
index 1b94b3cc9..3d81efea4 100755
--- a/src/documents/models.py
+++ b/src/documents/models.py
@@ -77,25 +77,11 @@ class Correspondent(MatchingModel):
class Tag(MatchingModel):
- COLOURS = (
- (1, "#a6cee3"),
- (2, "#1f78b4"),
- (3, "#b2df8a"),
- (4, "#33a02c"),
- (5, "#fb9a99"),
- (6, "#e31a1c"),
- (7, "#fdbf6f"),
- (8, "#ff7f00"),
- (9, "#cab2d6"),
- (10, "#6a3d9a"),
- (11, "#b15928"),
- (12, "#000000"),
- (13, "#cccccc")
- )
-
- colour = models.PositiveIntegerField(
+ color = models.CharField(
_("color"),
- choices=COLOURS, default=1)
+ max_length=7,
+ default="#a6cee3"
+ )
is_inbox_tag = models.BooleanField(
_("is inbox tag"),
diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py
index adda7117e..6ebf4c541 100644
--- a/src/documents/serialisers.py
+++ b/src/documents/serialisers.py
@@ -1,6 +1,7 @@
import re
import magic
+import math
from django.utils.text import slugify
from rest_framework import serializers
from rest_framework.fields import SerializerMethodField
@@ -88,7 +89,40 @@ class DocumentTypeSerializer(MatchingModelSerializer):
)
-class TagSerializer(MatchingModelSerializer):
+class ColorField(serializers.Field):
+
+ COLOURS = (
+ (1, "#a6cee3"),
+ (2, "#1f78b4"),
+ (3, "#b2df8a"),
+ (4, "#33a02c"),
+ (5, "#fb9a99"),
+ (6, "#e31a1c"),
+ (7, "#fdbf6f"),
+ (8, "#ff7f00"),
+ (9, "#cab2d6"),
+ (10, "#6a3d9a"),
+ (11, "#b15928"),
+ (12, "#000000"),
+ (13, "#cccccc")
+ )
+
+ def to_internal_value(self, data):
+ for id, color in self.COLOURS:
+ if id == data:
+ return color
+ raise serializers.ValidationError()
+
+ def to_representation(self, value):
+ for id, color in self.COLOURS:
+ if color == value:
+ return id
+ return 1
+
+
+class TagSerializerVersion1(MatchingModelSerializer):
+
+ colour = ColorField(source='color', default="#a6cee3")
class Meta:
model = Tag
@@ -105,6 +139,45 @@ class TagSerializer(MatchingModelSerializer):
)
+class TagSerializer(MatchingModelSerializer):
+
+ def get_text_color(self, obj):
+ try:
+ h = obj.color.lstrip('#')
+ rgb = tuple(int(h[i:i + 2], 16)/256 for i in (0, 2, 4))
+ luminance = math.sqrt(
+ 0.299 * math.pow(rgb[0], 2) +
+ 0.587 * math.pow(rgb[1], 2) +
+ 0.114 * math.pow(rgb[2], 2)
+ )
+ return "#ffffff" if luminance < 0.53 else "#000000"
+ except ValueError:
+ return "#000000"
+
+ text_color = serializers.SerializerMethodField()
+
+ class Meta:
+ model = Tag
+ fields = (
+ "id",
+ "slug",
+ "name",
+ "color",
+ "text_color",
+ "match",
+ "matching_algorithm",
+ "is_insensitive",
+ "is_inbox_tag",
+ "document_count"
+ )
+
+ def validate_color(self, color):
+ regex = r"#[0-9a-fA-F]{6}"
+ if not re.match(regex, color):
+ raise serializers.ValidationError(_("Invalid color."))
+ return color
+
+
class CorrespondentField(serializers.PrimaryKeyRelatedField):
def get_queryset(self):
return Correspondent.objects.all()
diff --git a/src/documents/tests/test_api.py b/src/documents/tests/test_api.py
index cbd10ac71..9a4788135 100644
--- a/src/documents/tests/test_api.py
+++ b/src/documents/tests/test_api.py
@@ -807,6 +807,69 @@ class TestDocumentApi(DirectoriesMixin, APITestCase):
}, format='json')
self.assertEqual(response.status_code, 201, endpoint)
+ def test_tag_color_default(self):
+ response = self.client.post("/api/tags/", {
+ "name": "tag"
+ }, format="json")
+ self.assertEqual(response.status_code, 201)
+ self.assertEqual(Tag.objects.get(id=response.data['id']).color, "#a6cee3")
+ self.assertEqual(self.client.get(f"/api/tags/{response.data['id']}/", format="json").data['colour'], 1)
+
+ def test_tag_color(self):
+ response = self.client.post("/api/tags/", {
+ "name": "tag",
+ "colour": 3
+ }, format="json")
+ self.assertEqual(response.status_code, 201)
+ self.assertEqual(Tag.objects.get(id=response.data['id']).color, "#b2df8a")
+ self.assertEqual(self.client.get(f"/api/tags/{response.data['id']}/", format="json").data['colour'], 3)
+
+ def test_tag_color_invalid(self):
+ response = self.client.post("/api/tags/", {
+ "name": "tag",
+ "colour": 34
+ }, format="json")
+ self.assertEqual(response.status_code, 400)
+
+ def test_tag_color_custom(self):
+ tag = Tag.objects.create(name="test", color="#abcdef")
+ self.assertEqual(self.client.get(f"/api/tags/{tag.id}/", format="json").data['colour'], 1)
+
+
+class TestDocumentApiV2(DirectoriesMixin, APITestCase):
+
+ def setUp(self):
+ super(TestDocumentApiV2, self).setUp()
+
+ self.user = User.objects.create_superuser(username="temp_admin")
+
+ self.client.force_login(user=self.user)
+ self.client.defaults['HTTP_ACCEPT'] = 'application/json; version=2'
+
+ def test_tag_validate_color(self):
+ self.assertEqual(self.client.post("/api/tags/", {"name": "test", "color": "#12fFaA"}, format="json").status_code, 201)
+
+ self.assertEqual(self.client.post("/api/tags/", {"name": "test1", "color": "abcdef"}, format="json").status_code, 400)
+ self.assertEqual(self.client.post("/api/tags/", {"name": "test2", "color": "#abcdfg"}, format="json").status_code, 400)
+ self.assertEqual(self.client.post("/api/tags/", {"name": "test3", "color": "#asd"}, format="json").status_code, 400)
+ self.assertEqual(self.client.post("/api/tags/", {"name": "test4", "color": "#12121212"}, format="json").status_code, 400)
+
+ def test_tag_text_color(self):
+ t = Tag.objects.create(name="tag1", color="#000000")
+ self.assertEqual(self.client.get(f"/api/tags/{t.id}/", format="json").data['text_color'], "#ffffff")
+
+ t.color = "#ffffff"
+ t.save()
+ self.assertEqual(self.client.get(f"/api/tags/{t.id}/", format="json").data['text_color'], "#000000")
+
+ t.color = "asdf"
+ t.save()
+ self.assertEqual(self.client.get(f"/api/tags/{t.id}/", format="json").data['text_color'], "#000000")
+
+ t.color = "123"
+ t.save()
+ self.assertEqual(self.client.get(f"/api/tags/{t.id}/", format="json").data['text_color'], "#000000")
+
class TestBulkEdit(DirectoriesMixin, APITestCase):
diff --git a/src/documents/views.py b/src/documents/views.py
index 978a464ee..a3f495d50 100755
--- a/src/documents/views.py
+++ b/src/documents/views.py
@@ -50,6 +50,7 @@ from .parsers import get_parser_class_for_mime_type
from .serialisers import (
CorrespondentSerializer,
DocumentSerializer,
+ TagSerializerVersion1,
TagSerializer,
DocumentTypeSerializer,
PostDocumentSerializer,
@@ -119,7 +120,12 @@ class TagViewSet(ModelViewSet):
queryset = Tag.objects.annotate(
document_count=Count('documents')).order_by(Lower('name'))
- serializer_class = TagSerializer
+ def get_serializer_class(self):
+ if int(self.request.version) == 1:
+ return TagSerializerVersion1
+ else:
+ return TagSerializer
+
pagination_class = StandardPagination
permission_classes = (IsAuthenticated,)
filter_backends = (DjangoFilterBackend, OrderingFilter)
|