def compare_content_for_sorting_by_type_and_name(content1: Content,
content2: Content) -> int:
"""
:param content1:
:param content2:
:return: 1 if content1 > content2
-1 if content1 < content2
0 if content1 = content2
"""
if content1.type == content2.type:
if content1.get_label().lower() > content2.get_label().lower():
return 1
elif content1.get_label().lower() < content2.get_label().lower():
return -1
return 0
else:
# TODO - D.A. - 2014-12-02 - Manage Content Types Dynamically
content_type_order = [
ContentType.Folder,
ContentType.Page,
ContentType.Thread,
ContentType.File,
]
content_1_type_index = content_type_order.index(content1.type)
content_2_type_index = content_type_order.index(content2.type)
result = content_1_type_index - content_2_type_index
if result < 0:
return -1
elif result > 0:
return 1
else:
return 0
def _build_email_body_for_content(
self,
mako_template_filepath: str,
role: UserRoleInWorkspace,
content: Content,
actor: User
) -> str:
"""
Build an email body and return it as a string
:param mako_template_filepath: the absolute path to the mako template to be used for email body building
:param role: the role related to user to whom the email must be sent. The role is required (and not the user only) in order to show in the mail why the user receive the notification
:param content: the content item related to the notification
:param actor: the user at the origin of the action / notification (for example the one who wrote a comment
:param config: the global configuration
:return: the built email body as string. In case of multipart email, this method must be called one time for text and one time for html
"""
logger.debug(self, 'Building email content from MAKO template {}'.format(mako_template_filepath))
main_title = content.label
content_intro = ''
content_text = ''
call_to_action_text = ''
# TODO - G.M - 11-06-2018 - [emailTemplateURL] correct value for call_to_action_url # nopep8
call_to_action_url =''
# TODO - G.M - 11-06-2018 - [emailTemplateURL] correct value for status_icon_url # nopep8
status_icon_url = ''
# TODO - G.M - 11-06-2018 - [emailTemplateURL] correct value for workspace_url # nopep8
workspace_url = ''
# TODO - G.M - 11-06-2018 - [emailTemplateURL] correct value for logo_url # nopep8
logo_url = ''
action = content.get_last_action().id
if ActionDescription.COMMENT == action:
content_intro = l_('<span id="content-intro-username">{}</span> added a comment:').format(actor.display_name)
content_text = content.description
call_to_action_text = l_('Answer')
elif ActionDescription.CREATION == action:
# Default values (if not overriden)
content_text = content.description
call_to_action_text = l_('View online')
if ContentType.Thread == content.type:
call_to_action_text = l_('Answer')
content_intro = l_('<span id="content-intro-username">{}</span> started a thread entitled:').format(actor.display_name)
content_text = '<p id="content-body-intro">{}</p>'.format(content.label) + \
content.get_last_comment_from(actor).description
elif ContentType.File == content.type:
content_intro = l_('<span id="content-intro-username">{}</span> added a file entitled:').format(actor.display_name)
if content.description:
content_text = content.description
else:
content_text = '<span id="content-body-only-title">{}</span>'.format(content.label)
elif ContentType.Page == content.type:
content_intro = l_('<span id="content-intro-username">{}</span> added a page entitled:').format(actor.display_name)
content_text = '<span id="content-body-only-title">{}</span>'.format(content.label)
elif ActionDescription.REVISION == action:
content_text = content.description
call_to_action_text = l_('View online')
if ContentType.File == content.type:
content_intro = l_('<span id="content-intro-username">{}</span> uploaded a new revision.').format(actor.display_name)
content_text = ''
elif ContentType.Page == content.type:
content_intro = l_('<span id="content-intro-username">{}</span> updated this page.').format(actor.display_name)
previous_revision = content.get_previous_revision()
title_diff = ''
if previous_revision.label != content.label:
title_diff = htmldiff(previous_revision.label, content.label)
content_text = str(l_('<p id="content-body-intro">Here is an overview of the changes:</p>'))+ \
title_diff + \
htmldiff(previous_revision.description, content.description)
elif ContentType.Thread == content.type:
content_intro = l_('<span id="content-intro-username">{}</span> updated the thread description.').format(actor.display_name)
previous_revision = content.get_previous_revision()
title_diff = ''
if previous_revision.label != content.label:
title_diff = htmldiff(previous_revision.label, content.label)
content_text = str(l_('<p id="content-body-intro">Here is an overview of the changes:</p>'))+ \
title_diff + \
htmldiff(previous_revision.description, content.description)
elif ActionDescription.EDITION == action:
call_to_action_text = l_('View online')
if ContentType.File == content.type:
content_intro = l_('<span id="content-intro-username">{}</span> updated the file description.').format(actor.display_name)
content_text = '<p id="content-body-intro">{}</p>'.format(content.get_label()) + \
content.description
elif ActionDescription.STATUS_UPDATE == action:
call_to_action_text = l_('View online')
intro_user_msg = l_(
'<span id="content-intro-username">{}</span> '
'updated the following status:'
)
content_intro = intro_user_msg.format(actor.display_name)
intro_body_msg = '<p id="content-body-intro">{}: {}</p>'
content_text = intro_body_msg.format(
content.get_label(),
content.get_status().label,
)
if '' == content_intro and content_text == '':
# Skip notification, but it's not normal
logger.error(
self, 'A notification is being sent but no content. '
'Here are some debug informations: [content_id: {cid}]'
'[action: {act}][author: {actor}]'.format(
cid=content.content_id, act=action, actor=actor
)
)
raise ValueError('Unexpected empty notification')
context = {
'user': role.user,
'workspace': role.workspace,
'workspace_url': workspace_url,
'main_title': main_title,
'status_label': content.get_status().label,
'status_icon_url': status_icon_url,
'role_label': role.role_as_label(),
'content_intro': content_intro,
'content_text': content_text,
'call_to_action_text': call_to_action_text,
'call_to_action_url': call_to_action_url,
'logo_url': logo_url,
}
user = role.user
workspace = role.workspace
body_content = self._render_template(
mako_template_filepath=mako_template_filepath,
context=context,
)
return body_content