#6222 [RFC 54] Internationalisation API changes

from collections import OrderedDict

from django.conf import settings
from rest_framework.authentication import SessionAuthentication

from wagtail.api.v2.views import PagesAPIViewSet

@@ -26,6 +27,7 @@

        'descendants',
        'parent',
        'ancestors',
        'translations',
    ]

    body_fields = PagesAPIViewSet.body_fields + [

@@ -47,6 +49,16 @@

        'has_children'
    ])

    @classmethod
    def get_detail_default_fields(cls, model):
        detail_default_fields = super().get_detail_default_fields(model)

        # When i18n is disabled, remove "translations" from default fields
        if not getattr(settings, 'WAGTAIL_I18N_ENABLED', False):
            detail_default_fields.remove('translations')

        return detail_default_fields

    def get_root_page(self):
        """
        Returns the page that is used when the `&child_of=root` filter is used.

@@ -1,5 +1,6 @@

from collections import OrderedDict

from django.conf import settings
from django.core.exceptions import FieldDoesNotExist
from django.http import Http404
from django.shortcuts import redirect

@@ -13,7 +14,9 @@

from wagtail.api import APIField
from wagtail.core.models import Page, Site

from .filters import ChildOfFilter, DescendantOfFilter, FieldsFilter, OrderingFilter, SearchFilter
from .filters import (
    ChildOfFilter, DescendantOfFilter, FieldsFilter, LocaleFilter, OrderingFilter, SearchFilter,
    TranslationOfFilter)
from .pagination import WagtailPagination
from .serializers import BaseSerializer, PageSerializer, get_serializer_class
from .utils import (

@@ -366,12 +369,16 @@

        ChildOfFilter,
        DescendantOfFilter,
        OrderingFilter,
        SearchFilter
        SearchFilter,
        TranslationOfFilter,
        LocaleFilter,
    ]
    known_query_parameters = BaseAPIViewSet.known_query_parameters.union([
        'type',
        'child_of',
        'descendant_of',
        'translation_of',
        'locale',
    ])
    body_fields = BaseAPIViewSet.body_fields + [
        'title',

@@ -384,6 +391,7 @@

        'search_description',
        'first_published_at',
        'parent',
        'locale',
    ]
    listing_default_fields = BaseAPIViewSet.listing_default_fields + [
        'title',

@@ -398,6 +406,26 @@

    name = 'pages'
    model = Page

    @classmethod
    def get_detail_default_fields(cls, model):
        detail_default_fields = super().get_detail_default_fields(model)

        # When i18n is disabled, remove "locale" from default fields
        if not getattr(settings, 'WAGTAIL_I18N_ENABLED', False):
            detail_default_fields.remove('locale')

        return detail_default_fields

    @classmethod
    def get_listing_default_fields(cls, model):
        listing_default_fields = super().get_listing_default_fields(model)

        # When i18n is enabled, add "locale" to default fields
        if getattr(settings, 'WAGTAIL_I18N_ENABLED', False):
            listing_default_fields.append('locale')

        return listing_default_fields

    def get_root_page(self):
        """
        Returns the page that is used when the `&child_of=root` filter is used.

@@ -417,7 +445,14 @@

        # Filter by site
        site = Site.find_for_request(self.request)
        if site:
            queryset = queryset.descendant_of(site.root_page, inclusive=True)
            base_queryset = queryset
            queryset = base_queryset.descendant_of(site.root_page, inclusive=True)

            # If internationalisation is enabled, include pages from other language trees
            if getattr(settings, 'WAGTAIL_I18N_ENABLED', False):
                for translation in site.root_page.get_translations():
                    queryset |= base_queryset.descendant_of(translation, inclusive=True)

        else:
            # No sites configured
            queryset = queryset.none()

@@ -109,9 +109,45 @@

109	109		return serializer.to_representation(page.get_ancestors())
110	110
111	111
	112	+	class PageTranslationsField(Field):
	113	+	"""
	114	+	Serializes the page's translations.
	115	+
	116	+	Example:
	117	+	"translations": [
	118	+	{
	119	+	"id": 1,
	120	+	"meta": {
	121	+	"type": "home.HomePage",
	122	+	"detail_url": "/api/v1/pages/1/",
	123	+	"locale": "es"
	124	+	},
	125	+	"title": "Casa"
	126	+	},
	127	+	{
	128	+	"id": 2,
	129	+	"meta": {
	130	+	"type": "home.HomePage",
	131	+	"detail_url": "/api/v1/pages/2/",
	132	+	"locale": "fr"
	133	+	},
	134	+	"title": "Maison"
	135	+	}
	136	+	]
	137	+	"""
	138	+	def get_attribute(self, instance):
	139	+	return instance
	140	+
	141	+	def to_representation(self, page):
	142	+	serializer_class = get_serializer_class(Page, ['id', 'type', 'detail_url', 'html_url', 'locale', 'title', 'admin_display_title'], meta_fields=['type', 'detail_url', 'html_url', 'locale'], base=AdminPageSerializer)
	143	+	serializer = serializer_class(context=self.context, many=True)
	144	+	return serializer.to_representation(page.get_translations())
	145	+
	146	+
112	147		class AdminPageSerializer(PageSerializer):
113	148		status = PageStatusField(read_only=True)
114	149		children = PageChildrenField(read_only=True)
115	150		descendants = PageDescendantsField(read_only=True)
116	151		ancestors = PageAncestorsField(read_only=True)
	152	+	translations = PageTranslationsField(read_only=True)
117	153		admin_display_title = ReadOnlyField(source='get_admin_display_title')

@@ -1,9 +1,10 @@

from django.conf import settings
from django.db import models
from django.shortcuts import get_object_or_404
from rest_framework.filters import BaseFilterBackend
from taggit.managers import TaggableManager

from wagtail.core.models import Page
from wagtail.core.models import Locale, Page
from wagtail.search.backends import get_search_backend
from wagtail.search.backends.base import FilterFieldError, OrderByFieldError


@@ -18,6 +19,10 @@

        """
        fields = set(view.get_available_fields(queryset.model, db_fields_only=True))

        # Locale is a database field, but we provide a separate filter for it
        if 'locale' in fields:
            fields.remove('locale')

        for field_name, value in request.GET.items():
            if field_name in fields:
                try:

@@ -180,3 +185,52 @@

180	185		queryset = queryset.descendant_of(parent_page)
181	186
182	187		return queryset
	188	+
	189	+
	190	+	class TranslationOfFilter(BaseFilterBackend):
	191	+	"""
	192	+	Implements the ?translation_of filter which limits the set of pages to translations
	193	+	of a page.
	194	+	"""
	195	+	def filter_queryset(self, request, queryset, view):
	196	+	if 'translation_of' in request.GET:
	197	+	try:
	198	+	page_id = int(request.GET['translation_of'])
	199	+	if page_id < 0:
	200	+	raise ValueError()
	201	+
	202	+	page = view.get_base_queryset().get(id=page_id)
	203	+	except ValueError:
	204	+	if request.GET['translation_of'] == 'root':
	205	+	page = view.get_root_page()
	206	+	else:
	207	+	raise BadRequestError("translation_of must be a positive integer")
	208	+	except Page.DoesNotExist:
	209	+	raise BadRequestError("translation_of page doesn't exist")
	210	+
	211	+	_filtered_by_child_of = getattr(queryset, '_filtered_by_child_of', None)
	212	+
	213	+	queryset = queryset.translation_of(page)
	214	+
	215	+	if _filtered_by_child_of:
	216	+	queryset._filtered_by_child_of = _filtered_by_child_of
	217	+
	218	+	return queryset
	219	+
	220	+
	221	+	class LocaleFilter(BaseFilterBackend):
	222	+	"""
	223	+	Implements the ?locale filter which limits the set of pages to a
	224	+	particular locale.
	225	+	"""
	226	+	def filter_queryset(self, request, queryset, view):
	227	+	if 'locale' in request.GET:
	228	+	_filtered_by_child_of = getattr(queryset, '_filtered_by_child_of', None)
	229	+
	230	+	locale = get_object_or_404(Locale, language_code=request.GET['locale'])
	231	+	queryset = queryset.filter(locale=locale)
	232	+
	233	+	if _filtered_by_child_of:
	234	+	queryset._filtered_by_child_of = _filtered_by_child_of
	235	+
	236	+	return queryset

@@ -86,6 +86,17 @@

        return name


class PageLocaleField(Field):
    """
    Serializes the "locale" field for pages.
    """
    def get_attribute(self, instance):
        return instance

    def to_representation(self, page):
        return page.locale.language_code


class RelatedField(relations.RelatedField):
    """
    Serializes related objects (eg, foreign keys).

@@ -310,6 +321,7 @@


class PageSerializer(BaseSerializer):
    type = PageTypeField(read_only=True)
    locale = PageLocaleField(read_only=True)
    html_url = PageHtmlUrlField(read_only=True)
    parent = PageParentField(read_only=True)


Learn more Showing 44 files with coverage changes found.

client/src/components/Icon/Icon.js

Loading file...

client/src/components/Explorer/ExplorerPanel.js

Loading file...

client/src/components/Explorer/reducers/nodes.js

Loading file...

client/src/components/LoadingSpinner/LoadingSpinner.js

Loading file...

client/src/includes/initSubmenus.js

Loading file...

client/src/components/Draftail/blocks/ImageBlock.js

Loading file...

client/src/components/Draftail/decorators/TooltipEntity.js

Loading file...

client/src/api/admin.js

Loading file...

client/src/components/Explorer/Explorer.js

Loading file...

client/src/components/Explorer/reducers/explorer.js

Loading file...

client/src/config/wagtailConfig.js

Loading file...

client/src/api/client.js

Loading file...

wagtail/admin/static_src/wagtailadmin/js/page-editor.js

Loading file...

client/src/includes/initSkipLink.js

Loading file...

wagtail/admin/static_src/wagtailadmin/app/wagtailadmin.entry.js

Loading file...

client/src/components/Button/Button.js

Loading file...

client/src/components/Explorer/ExplorerToggle.js

Loading file...

client/src/utils/focus.js

Loading file...

client/src/components/Explorer/PageCount.js

Loading file...

client/src/components/Explorer/ExplorerItem.js

Loading file...

client/src/components/Draftail/decorators/Link.js

Loading file...

client/src/components/Explorer/index.js

Loading file...

client/src/components/Draftail/Tooltip/Tooltip.js

Loading file...

client/src/components/Draftail/DraftUtils.js

Loading file...

client/src/components/PublicationStatus/PublicationStatus.js

Loading file...

client/src/components/Draftail/index.js

Loading file...

client/src/utils/actions.js

Loading file...

client/src/components/Draftail/EditorFallback/EditorFallback.js

Loading file...

client/src/components/Draftail/decorators/Document.js

Loading file...

wagtail/admin/static_src/wagtailadmin/js/vendor/urlify.js

Loading file...

client/src/components/Explorer/ExplorerHeader.js

Loading file...

client/src/components/Draftail/blocks/MediaBlock.js

Loading file...

client/src/components/Portal/Portal.js

Loading file...

wagtail/admin/static_src/wagtailadmin/app/draftail.entry.js

Loading file...

client/src/components/Explorer/actions.js

Loading file...

client/src/components/UpgradeNotification/index.js

Loading file...

client/src/components/Draftail/sources/ModalWorkflowSource.js

Loading file...

client/src/components/Transition/Transition.js

Loading file...

client/src/utils/version.js

Loading file...

wagtail/admin/static_src/wagtailadmin/js/vendor/jquery-3.5.1.min.js

Loading file...

client/src/components/Draftail/blocks/EmbedBlock.js

Loading file...

Changes in wagtail/contrib/frontend_cache/utils.py

-1

→

Loading file...

Changes in wagtail/core/blocks/stream_block.py

-1

-5

→

Loading file...

Changes in wagtail/admin/compare.py

-1

→

+122

Loading file...

90.70% 100.00% +0.56%

Implement `meta.translations` field in Admin API

kaedroho

#6222 9544fd5

CI Passed

Hiding 4 contexual commits

-41 Files

-839

-618

-22

-199

Pull Request Base Commit

90.13% ø ø

Limit page-editor input changes to non-submit inputs (#6397)

zerolab

55d82d6

CI Passed

Files		•	•	•	Coverage
wagtail	-56	+109	-17	-148	^0.65% 90.70%
Project Totals (393 files)	24,665	22,370	694	1,601	90.70%

398	406		name = 'pages'
399	407		model = Page
400	408
	409	+	@classmethod
	410	+	def get_detail_default_fields(cls, model):
	411	+	detail_default_fields = super().get_detail_default_fields(model)
	412	+
	413	+	# When i18n is disabled, remove "locale" from default fields
	414	+	if not getattr(settings, 'WAGTAIL_I18N_ENABLED', False):
	415	+	detail_default_fields.remove('locale')
	416	+
	417	+	return detail_default_fields
	418	+
	419	+	@classmethod
	420	+	def get_listing_default_fields(cls, model):
	421	+	listing_default_fields = super().get_listing_default_fields(model)
	422	+
	423	+	# When i18n is enabled, add "locale" to default fields
	424	+	if getattr(settings, 'WAGTAIL_I18N_ENABLED', False):
	425	+	listing_default_fields.append('locale')
	426	+
	427	+	return listing_default_fields
	428	+
401	429		def get_root_page(self):
402	430		"""
403	431		Returns the page that is used when the `&child_of=root` filter is used.

417	445		# Filter by site
418	446		site = Site.find_for_request(self.request)
419	447		if site:
420		-	queryset = queryset.descendant_of(site.root_page, inclusive=True)
	448	+	base_queryset = queryset
	449	+	queryset = base_queryset.descendant_of(site.root_page, inclusive=True)
	450	+
	451	+	# If internationalisation is enabled, include pages from other language trees
	452	+	if getattr(settings, 'WAGTAIL_I18N_ENABLED', False):
	453	+	for translation in site.root_page.get_translations():
	454	+	queryset \|= base_queryset.descendant_of(translation, inclusive=True)
	455	+
421	456		else:
422	457		# No sites configured
423	458		queryset = queryset.none()

310	321
311	322		class PageSerializer(BaseSerializer):
312	323		type = PageTypeField(read_only=True)
	324	+	locale = PageLocaleField(read_only=True)
313	325		html_url = PageHtmlUrlField(read_only=True)
314	326		parent = PageParentField(read_only=True)
315	327

Navigation	Overlay
`t` Navigate files	`h` Toggle hits
`y` Change url to tip of branch	`m` Toggle misses
`b / v` Jump to prev/next hit line	`p` Toggle partial
`z / x` Jump to prev/next missed or partial line	`1..9` Toggle flags
`shift + o` Open current page in GitHub	`a` Toggle all on
`/ or ?` Show keyboard shortcuts dialog	`c` Toggle context lines or commits

#6222 [RFC 54] Internationalisation API changes

Flags

Show failed CI and contexual commits `c`

5 Commits

1	1		from collections import OrderedDict
2	2
	3	+	from django.conf import settings
3	4		from rest_framework.authentication import SessionAuthentication
4	5
5	6		from wagtail.api.v2.views import PagesAPIViewSet

26	27		'descendants',
27	28		'parent',
28	29		'ancestors',
	30	+	'translations',
29	31		]
30	32
31	33		body_fields = PagesAPIViewSet.body_fields + [

47	49		'has_children'
48	50		])
49	51
	52	+	@classmethod
	53	+	def get_detail_default_fields(cls, model):
	54	+	detail_default_fields = super().get_detail_default_fields(model)
	55	+
	56	+	# When i18n is disabled, remove "translations" from default fields
	57	+	if not getattr(settings, 'WAGTAIL_I18N_ENABLED', False):
	58	+	detail_default_fields.remove('translations')
	59	+
	60	+	return detail_default_fields
	61	+
50	62		def get_root_page(self):
51	63		"""
52	64		Returns the page that is used when the `&child_of=root` filter is used.

1	1		from collections import OrderedDict
2	2
	3	+	from django.conf import settings
3	4		from django.core.exceptions import FieldDoesNotExist
4	5		from django.http import Http404
5	6		from django.shortcuts import redirect

13	14		from wagtail.api import APIField
14	15		from wagtail.core.models import Page, Site
15	16
16		-	from .filters import ChildOfFilter, DescendantOfFilter, FieldsFilter, OrderingFilter, SearchFilter
	17	+	from .filters import (
	18	+	ChildOfFilter, DescendantOfFilter, FieldsFilter, LocaleFilter, OrderingFilter, SearchFilter,
	19	+	TranslationOfFilter)
17	20		from .pagination import WagtailPagination
18	21		from .serializers import BaseSerializer, PageSerializer, get_serializer_class
19	22		from .utils import (

366	369		ChildOfFilter,
367	370		DescendantOfFilter,
368	371		OrderingFilter,
369		-	SearchFilter
	372	+	SearchFilter,
	373	+	TranslationOfFilter,
	374	+	LocaleFilter,
370	375		]
371	376		known_query_parameters = BaseAPIViewSet.known_query_parameters.union([
372	377		'type',
373	378		'child_of',
374	379		'descendant_of',
	380	+	'translation_of',
	381	+	'locale',
375	382		])
376	383		body_fields = BaseAPIViewSet.body_fields + [
377	384		'title',

384	391		'search_description',
385	392		'first_published_at',
386	393		'parent',
	394	+	'locale',
387	395		]
388	396		listing_default_fields = BaseAPIViewSet.listing_default_fields + [
389	397		'title',

1	1		from django.conf import settings
2	2		from django.db import models
	3	+	from django.shortcuts import get_object_or_404
3	4		from rest_framework.filters import BaseFilterBackend
4	5		from taggit.managers import TaggableManager
5	6
6		-	from wagtail.core.models import Page
	7	+	from wagtail.core.models import Locale, Page
7	8		from wagtail.search.backends import get_search_backend
8	9		from wagtail.search.backends.base import FilterFieldError, OrderByFieldError
9	10

18	19		"""
19	20		fields = set(view.get_available_fields(queryset.model, db_fields_only=True))
20	21
	22	+	# Locale is a database field, but we provide a separate filter for it
	23	+	if 'locale' in fields:
	24	+	fields.remove('locale')
	25	+
21	26		for field_name, value in request.GET.items():
22	27		if field_name in fields:
23	28		try:

86	86		return name
87	87
88	88
	89	+	class PageLocaleField(Field):
	90	+	"""
	91	+	Serializes the "locale" field for pages.
	92	+	"""
	93	+	def get_attribute(self, instance):
	94	+	return instance
	95	+
	96	+	def to_representation(self, page):
	97	+	return page.locale.language_code
	98	+
	99	+
89	100		class RelatedField(relations.RelatedField):
90	101		"""
91	102		Serializes related objects (eg, foreign keys).

#6222 [RFC 54] Internationalisation API changes

Flags

Show failed CI and contexual commits c 5 Commits

Show failed CI and contexual commits `c`

5 Commits