From dd1470358dc350dbbb8b626e8cf4705f9769e3e6 Mon Sep 17 00:00:00 2001 From: Jesse Stippel Date: Thu, 31 Jan 2019 17:24:05 +0100 Subject: [PATCH 1/5] improved profile handling --- src/collective/sidebar/__init__.py | 12 +++++ src/collective/sidebar/browser/sidebar.py | 44 +++++++++++++++++-- .../sidebar/browser/templates/sidebar.pt | 4 +- src/collective/sidebar/directives.py | 32 ++++++++++++++ src/collective/sidebar/utils.py | 21 +++++++++ 5 files changed, 108 insertions(+), 5 deletions(-) create mode 100644 src/collective/sidebar/directives.py diff --git a/src/collective/sidebar/__init__.py b/src/collective/sidebar/__init__.py index 546c892..9b79e0c 100644 --- a/src/collective/sidebar/__init__.py +++ b/src/collective/sidebar/__init__.py @@ -3,6 +3,18 @@ from collective.sidebar.patches import apply_portrait_patch from zope.i18nmessageid import MessageFactory +import zope.deferredimport + +# Patch Profile-Scale apply_portrait_patch() + +# Translation Domain _ = MessageFactory('collective.sidebar') + +# Deferred Imports +zope.deferredimport.defineFrom( + 'collective.sidebar.directives', + 'user_avatar', + 'AVATAR_KEY', +) diff --git a/src/collective/sidebar/browser/sidebar.py b/src/collective/sidebar/browser/sidebar.py index eb74606..58659f4 100644 --- a/src/collective/sidebar/browser/sidebar.py +++ b/src/collective/sidebar/browser/sidebar.py @@ -1,6 +1,7 @@ # -*- coding: utf-8 -*- from collective.sidebar import _ +from collective.sidebar.directives import AVATAR_KEY from collective.sidebar.utils import crop from collective.sidebar.utils import get_translated from collective.sidebar.utils import get_user @@ -17,6 +18,7 @@ from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile from zope.component import getMultiAdapter from zope.component import queryMultiAdapter +from zope.dottedname.resolve import resolve import pkg_resources @@ -56,15 +58,51 @@ def get_static_links(self): return sidebar_links def get_user_data(self): + # Set Defaults user = get_user() + portal_url = self.get_portal_url() mtool = api.portal.get_tool('portal_membership') + dxtool = api.portal.get_tool('portal_types') + # Get Default Portrait portrait = mtool.getPersonalPortrait(id=user[1]) + # Set Default User-Variables user_info = mtool.getMemberInfo(user[1]) - portal_url = self.get_portal_url() + user_avatar = portrait.absolute_url() + user_url = portal_url + '/@@personal-information' + # When Custom Member-Creation is Active + if mtool.memberareaCreationFlag: + # Get Avatar-Field + user_dx = dxtool.get(mtool.memberarea_type) + custom_schema = user_dx.schema + if custom_schema: + user_dx_iface = resolve(custom_schema) + avatar_fields = user_dx_iface.queryTaggedValue(AVATAR_KEY) + if avatar_fields: + for iface, field, active in avatar_fields: + if active: + images_view = api.content.get_view( + 'images', + self.context, + self.request, + ) + scale = images_view.scale( + user_dx_iface.get(field), + width=256, + height=256, + direction='down', + ) + user_avatar = scale.url + # Set User-Profile URL + user_url = '{0}/{1}/{2}'.format( + portal_url, + mtool.membersfolder_id, + user_info.get('username', ''), + ) + # Concatenate the Data Together data = { 'user_info': user_info, - 'portrait': portrait.absolute_url(), - 'user_url': portal_url + '/@@personal-information', + 'user_avatar': user_avatar, + 'user_url': user_url, } return data diff --git a/src/collective/sidebar/browser/templates/sidebar.pt b/src/collective/sidebar/browser/templates/sidebar.pt index d65aa79..4783c08 100644 --- a/src/collective/sidebar/browser/templates/sidebar.pt +++ b/src/collective/sidebar/browser/templates/sidebar.pt @@ -20,12 +20,12 @@
-
+
diff --git a/src/collective/sidebar/directives.py b/src/collective/sidebar/directives.py new file mode 100644 index 0000000..38e08be --- /dev/null +++ b/src/collective/sidebar/directives.py @@ -0,0 +1,32 @@ +# -*- coding: utf-8 -*- + +from plone.supermodel.directives import MetadataListDirective +from zope.interface import Interface +from zope.interface.interfaces import IInterface + + +AVATAR_KEY = u'collective.sidebar.avatar' + + +class user_avatar(MetadataListDirective): + """ + Directive used to mark a field as the profile image provider. + """ + + key = AVATAR_KEY + value = True + + def factory(self, *args): + """ + The user_avatar directive accepts as arguments one or more + fieldnames (string) of fields which should be used. + """ + if not args: + raise TypeError( + 'The user_avatar directive expects at least one argument.' + ) + form_interface = Interface + if IInterface.providedBy(args[0]): + form_interface = args[0] + args = args[1:] + return [(form_interface, field, self.value) for field in args] diff --git a/src/collective/sidebar/utils.py b/src/collective/sidebar/utils.py index 9c37ccf..74973ed 100644 --- a/src/collective/sidebar/utils.py +++ b/src/collective/sidebar/utils.py @@ -1,7 +1,9 @@ # -*- coding: utf-8 -*- from collective.sidebar import _ +from collective.sidebar.directives import AVATAR_KEY from plone import api +from zope import schema from zope.i18n import translate @@ -55,3 +57,22 @@ def get_user(): user_id = user.id user_dir = '/users/{0}'.format(user_id) return user, user_id, user_dir + + +def user_avatar(iface, field_name): + """ + Mark a field in the existing interface as the avatar image provider. + """ + if schema.getFields(iface).get(field_name) is None: + dottedname = '.'.join((iface.__module__, iface.__name__)) + raise AttributeError( + '{0} has no field "{1}"'.format( + dottedname, + field_name + ) + ) + store = iface.queryTaggedValue(AVATAR_KEY) + if store is None: + store = [] + store.append((iface, field_name, 'true')) + iface.setTaggedValue(AVATAR_KEY, store) From 74eac9d301dc1165e3877501d52dbe0515a6ff39 Mon Sep 17 00:00:00 2001 From: Jesse Stippel Date: Thu, 31 Jan 2019 18:10:08 +0100 Subject: [PATCH 2/5] get profile view --- src/collective/sidebar/browser/sidebar.py | 30 ++++++++++++----------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/src/collective/sidebar/browser/sidebar.py b/src/collective/sidebar/browser/sidebar.py index 58659f4..326e63e 100644 --- a/src/collective/sidebar/browser/sidebar.py +++ b/src/collective/sidebar/browser/sidebar.py @@ -60,6 +60,7 @@ def get_static_links(self): def get_user_data(self): # Set Defaults user = get_user() + portal = api.portal.get() portal_url = self.get_portal_url() mtool = api.portal.get_tool('portal_membership') dxtool = api.portal.get_tool('portal_types') @@ -77,21 +78,22 @@ def get_user_data(self): if custom_schema: user_dx_iface = resolve(custom_schema) avatar_fields = user_dx_iface.queryTaggedValue(AVATAR_KEY) + avatar_field = None if avatar_fields: - for iface, field, active in avatar_fields: - if active: - images_view = api.content.get_view( - 'images', - self.context, - self.request, - ) - scale = images_view.scale( - user_dx_iface.get(field), - width=256, - height=256, - direction='down', - ) - user_avatar = scale.url + avatar_field = avatar_fields[0][1] + if avatar_field: + user = api.content.find( + portal_type=mtool.memberarea_type, + context=portal.get(mtool.membersfolder_id), + id=user_info.get('username', ''), + )[0] + images_view = api.content.get_view( + 'images', user, self.request + ) + scale = images_view.scale( + avatar_field, width=256, height=256, direction='down' + ) + user_avatar = scale.url # Set User-Profile URL user_url = '{0}/{1}/{2}'.format( portal_url, From c6c0209d2375068422bd3cfbe72a8b9554dff106 Mon Sep 17 00:00:00 2001 From: Jesse Stippel Date: Thu, 31 Jan 2019 18:12:23 +0100 Subject: [PATCH 3/5] wake object --- src/collective/sidebar/browser/sidebar.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/collective/sidebar/browser/sidebar.py b/src/collective/sidebar/browser/sidebar.py index 326e63e..204a1de 100644 --- a/src/collective/sidebar/browser/sidebar.py +++ b/src/collective/sidebar/browser/sidebar.py @@ -88,7 +88,7 @@ def get_user_data(self): id=user_info.get('username', ''), )[0] images_view = api.content.get_view( - 'images', user, self.request + 'images', user.getObject(), self.request ) scale = images_view.scale( avatar_field, width=256, height=256, direction='down' From a12f9cdd883717f2d71d679e473a2ce01aa7c1e8 Mon Sep 17 00:00:00 2001 From: Jesse Stippel Date: Thu, 31 Jan 2019 18:33:35 +0100 Subject: [PATCH 4/5] update method documentation --- src/collective/sidebar/browser/sidebar.py | 37 +++++++++++++++++------ 1 file changed, 27 insertions(+), 10 deletions(-) diff --git a/src/collective/sidebar/browser/sidebar.py b/src/collective/sidebar/browser/sidebar.py index 204a1de..cc4fd23 100644 --- a/src/collective/sidebar/browser/sidebar.py +++ b/src/collective/sidebar/browser/sidebar.py @@ -58,6 +58,14 @@ def get_static_links(self): return sidebar_links def get_user_data(self): + """ + Returns member data for the currently logged-in user. + Can also return custom member object data when toggling the, + memberareaCreationFlag option in the ZMI. + Note: + Custom avatar images are only used when marking a field with + the user_avatar directive in the Content-Type schema. + """ # Set Defaults user = get_user() portal = api.portal.get() @@ -72,28 +80,37 @@ def get_user_data(self): user_url = portal_url + '/@@personal-information' # When Custom Member-Creation is Active if mtool.memberareaCreationFlag: - # Get Avatar-Field + # Get Dexterity Type user_dx = dxtool.get(mtool.memberarea_type) custom_schema = user_dx.schema if custom_schema: + # Get Dexterity-Schema Interface user_dx_iface = resolve(custom_schema) + # Get Marked-Fields from Metadata avatar_fields = user_dx_iface.queryTaggedValue(AVATAR_KEY) avatar_field = None if avatar_fields: avatar_field = avatar_fields[0][1] if avatar_field: - user = api.content.find( + # Get User-View and Fetch Image + users = api.content.find( portal_type=mtool.memberarea_type, context=portal.get(mtool.membersfolder_id), - id=user_info.get('username', ''), - )[0] - images_view = api.content.get_view( - 'images', user.getObject(), self.request - ) - scale = images_view.scale( - avatar_field, width=256, height=256, direction='down' + id=user[1], ) - user_avatar = scale.url + if users: + images_view = api.content.get_view( + 'images', + users[0].getObject(), + self.request, + ) + scale = images_view.scale( + avatar_field, + width=256, + height=256, + direction='down', + ) + user_avatar = scale.url # Set User-Profile URL user_url = '{0}/{1}/{2}'.format( portal_url, From 7a14a0979fee8eddd444f678ff654a855c09e617 Mon Sep 17 00:00:00 2001 From: Stefan Arnold Date: Tue, 8 Oct 2019 09:08:20 +0200 Subject: [PATCH 5/5] fixed merge conflicts and removed unused method --- src/collective/sidebar/utils.py | 31 ------------------------------- 1 file changed, 31 deletions(-) diff --git a/src/collective/sidebar/utils.py b/src/collective/sidebar/utils.py index 02159a9..ab652e9 100644 --- a/src/collective/sidebar/utils.py +++ b/src/collective/sidebar/utils.py @@ -1,39 +1,8 @@ # -*- coding: utf-8 -*- -from collective.sidebar import _ from collective.sidebar.directives import AVATAR_KEY from plone import api from zope import schema -from zope.i18n import translate - - -def get_translated(text, context, domain='plone', multi_domain=False): - """ - Useful for multi-domain translations. - e.g. Fetching Plone default translations. - """ - if context: - request = context.request - language_id = request.response.headers.get('content-language', None) - if language_id: - translated = translate( - text, - domain=domain, - target_language=language_id, - ) - if multi_domain: - if translated != text: - return translated - package_domain = _._domain - package_translated = translate( - text, - domain=package_domain, - target_language=language_id, - ) - if package_translated != text: - return package_translated - return translated - return text def crop(text, max_char_length):