Skip to content

refactor commentbox_props() into classmethod to allow better overriding #372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 8, 2022
Merged

refactor commentbox_props() into classmethod to allow better overriding #372

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
230 changes: 132 additions & 98 deletions django_comments_xtd/api/frontend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,110 +15,144 @@
XtdComment = get_comment_model()


def commentbox_props(obj, user, request=None):
class CommentBoxDriver(object):
"""
Returns a JSON object with the initial props for the CommentBox component.
Class that allows overriding methods like get_queryset()
for CommentBox props function.
"""
@classmethod
def get_queryset(cls, ctype, obj, request):
return XtdComment.objects.filter(
content_type=ctype,
object_pk=obj.pk,
site__pk=get_current_site_id(request),
is_public=True,
)

@classmethod
def _reverse(cls, *args, **kwargs):
"""
do not inject request to avoid http:// urls on https:// only sites
"""
return reverse(*args, **kwargs)

@classmethod
def get_props(cls, obj, user, request=None):
"""
Returns a JSON object with the initial props for
the CommentBox component.

The returned JSON object contains the following attributes::
{
comment_count: <int>, // Count of comments posted to the object.
allow_comments: <bool>, // Whether to allow comments to this post.
current_user: <str as "user_id:user_name">,
is_authenticated: <bool>, // Whether current_user is authenticated.
request_name: <bool>, // True when auth user has no actual name.
request_email_address: <bool>, // True when auth user has no email.
allow_flagging: false,
allow_feedback: false,
show_feedback: false,
can_moderate: <bool>, // Whether current_user can moderate.
polling_interval: 2000, // Check for new comments every 2 seconds.
feedback_url: <api-url-to-send-like/dislike-feedback>,
delete_url: <api-url-for-moderators-to-remove-comment>,
login_url: settings.LOGIN_URL,
reply_url: <api-url-to-reply-comments>,
flag_url: <api-url-to-suggest-comment-removal>,
list_url: <api-url-to-list-comments>,
count_url: <api-url-to-count-comments>,
send_url: <api-url-to-send-a-comment>,
preview_url: <api-url-to-preview-users-avatar>,
form: {
content_type: <value>,
object_pk: <value>,
timestamp: <value>,
security_hash: <value>
The returned JSON object contains the following attributes::
{
comment_count: <int>, // Count of comments posted
// to the object.
allow_comments: <bool>, // Whether to allow comments
// to this post.
current_user: <str as "user_id:user_name">,
is_authenticated: <bool>, // Whether current_user
// is authenticated.
request_name: <bool>, // True when auth user has
// no actual name.
request_email_address: <bool>, // True when auth user
// has no email.
allow_flagging: false,
allow_feedback: false,
show_feedback: false,
can_moderate: <bool>, // Whether current_user can moderate.
polling_interval: 2000, // Check for new comments
// every 2 seconds.
feedback_url: <api-url-to-send-like/dislike-feedback>,
delete_url: <api-url-for-moderators-to-remove-comment>,
login_url: settings.LOGIN_URL,
reply_url: <api-url-to-reply-comments>,
flag_url: <api-url-to-suggest-comment-removal>,
list_url: <api-url-to-list-comments>,
count_url: <api-url-to-count-comments>,
send_url: <api-url-to-send-a-comment>,
preview_url: <api-url-to-preview-users-avatar>,
form: {
content_type: <value>,
object_pk: <value>,
timestamp: <value>,
security_hash: <value>
},
login_url: <only_when_user_is_not_authenticated>,
like_url: <only_when_user_is_not_authenticated>,
dislike_url: <only_when_user_is_not_authenticated>,
html_id_suffix: <html_element_id_suffix>
}
"""

form = CommentSecurityForm(obj)
ctype = ContentType.objects.get_for_model(obj)
queryset = cls.get_queryset(ctype, obj, request)
ctype_slug = "%s-%s" % (ctype.app_label, ctype.model)
ctype_key = "%s.%s" % (ctype.app_label, ctype.model)
options = get_app_model_options(content_type=ctype_key)
d = {
"comment_count": queryset.count(),
"allow_comments": True,
"current_user": "0:Anonymous",
"request_name": False,
"request_email_address": False,
"is_authenticated": False,
"who_can_post": options['who_can_post'],
"allow_flagging": False,
"allow_feedback": False,
"show_feedback": False,
"can_moderate": False,
"polling_interval": 2000,
"feedback_url": cls._reverse("comments-xtd-api-feedback"),
"delete_url": cls._reverse("comments-delete", args=(0,)),
"reply_url": cls._reverse("comments-xtd-reply", kwargs={'cid': 0}),
"flag_url": cls._reverse("comments-flag", args=(0,)),
"list_url": cls._reverse('comments-xtd-api-list',
kwargs={'content_type': ctype_slug,
'object_pk': obj.id}),
"count_url": cls._reverse('comments-xtd-api-count',
kwargs={'content_type': ctype_slug,
'object_pk': obj.id}),
"send_url": cls._reverse("comments-xtd-api-create"),
"preview_url": cls._reverse("comments-xtd-api-preview"),
"form": {
"content_type": form['content_type'].value(),
"object_pk": form['object_pk'].value(),
"timestamp": form['timestamp'].value(),
"security_hash": form['security_hash'].value()
},
login_url: <only_when_user_is_not_authenticated>,
like_url: <only_when_user_is_not_authenticated>,
dislike_url: <only_when_user_is_not_authenticated>,
html_id_suffix: <html_element_id_suffix>
"default_followup": settings.COMMENTS_XTD_DEFAULT_FOLLOWUP,
"html_id_suffix": get_html_id_suffix(obj),
"max_thread_level": max_thread_level_for_content_type(ctype),
}
"""
try:
user_is_authenticated = user.is_authenticated()
except TypeError: # Django >= 1.11
user_is_authenticated = user.is_authenticated
if user and user_is_authenticated:
d['current_user'] = "%d:%s" % (
user.pk, settings.COMMENTS_XTD_API_USER_REPR(user))
d['is_authenticated'] = True
d['can_moderate'] = user.has_perm("django_comments.can_moderate")
d['request_name'] = (
True if not len(user.get_full_name()) else False
)
d['request_email_address'] = True if not user.email else False
else:
d['login_url'] = settings.LOGIN_URL
d['like_url'] = reverse("comments-xtd-like", args=(0,))
d['dislike_url'] = reverse("comments-xtd-dislike", args=(0,))

return d

def _reverse(*args, **kwargs):
"""do not inject request to avoid http:// urls on https:// only sites"""
return reverse(*args, **kwargs)

form = CommentSecurityForm(obj)
ctype = ContentType.objects.get_for_model(obj)
queryset = XtdComment.objects.filter(content_type=ctype,
object_pk=obj.pk,
site__pk=get_current_site_id(request),
is_public=True)
ctype_slug = "%s-%s" % (ctype.app_label, ctype.model)
ctype_key = "%s.%s" % (ctype.app_label, ctype.model)
options = get_app_model_options(content_type=ctype_key)
d = {
"comment_count": queryset.count(),
"allow_comments": True,
"current_user": "0:Anonymous",
"request_name": False,
"request_email_address": False,
"is_authenticated": False,
"who_can_post": options['who_can_post'],
"allow_flagging": False,
"allow_feedback": False,
"show_feedback": False,
"can_moderate": False,
"polling_interval": 2000,
"feedback_url": _reverse("comments-xtd-api-feedback"),
"delete_url": _reverse("comments-delete", args=(0,)),
"reply_url": _reverse("comments-xtd-reply", kwargs={'cid': 0}),
"flag_url": _reverse("comments-flag", args=(0,)),
"list_url": _reverse('comments-xtd-api-list',
kwargs={'content_type': ctype_slug,
'object_pk': obj.id}),
"count_url": _reverse('comments-xtd-api-count',
kwargs={'content_type': ctype_slug,
'object_pk': obj.id}),
"send_url": _reverse("comments-xtd-api-create"),
"preview_url": _reverse("comments-xtd-api-preview"),
"form": {
"content_type": form['content_type'].value(),
"object_pk": form['object_pk'].value(),
"timestamp": form['timestamp'].value(),
"security_hash": form['security_hash'].value()
},
"default_followup": settings.COMMENTS_XTD_DEFAULT_FOLLOWUP,
"html_id_suffix": get_html_id_suffix(obj),
"max_thread_level": max_thread_level_for_content_type(ctype),
}
try:
user_is_authenticated = user.is_authenticated()
except TypeError: # Django >= 1.11
user_is_authenticated = user.is_authenticated
if user and user_is_authenticated:
d['current_user'] = "%d:%s" % (
user.pk, settings.COMMENTS_XTD_API_USER_REPR(user))
d['is_authenticated'] = True
d['can_moderate'] = user.has_perm("django_comments.can_moderate")
d['request_name'] = True if not len(user.get_full_name()) else False
d['request_email_address'] = True if not user.email else False
else:
d['login_url'] = settings.LOGIN_URL
d['like_url'] = reverse("comments-xtd-like", args=(0,))
d['dislike_url'] = reverse("comments-xtd-dislike", args=(0,))

return d
def commentbox_props(obj, user, request=None):
"""
Returns a JSON object with the initial props for the CommentBox component.

This is transitional function left for backward compatibility
with applications that are using commentbox_props() function directly.
"""
return CommentBoxDriver.get_props(obj, user, request)


def commentbox_props_response(obj, user, request):
Expand Down