add interchangable object keys support

Author: PetrDlouhy

django_comments/forms.py

@@ -11,6 +11,7 @@
 from django.utils.translation import pgettext_lazy, ngettext, gettext, gettext_lazy as _
 
 from . import get_model
+from .utils import get_key_value
 
 COMMENT_MAX_LENGTH = getattr(settings, 'COMMENT_MAX_LENGTH', 3000)
 DEFAULT_COMMENTS_TIMEOUT = getattr(settings, 'COMMENTS_TIMEOUT', (2 * 60 * 60))  # 2h
@@ -65,7 +66,7 @@ def generate_security_data(self):
         timestamp = int(time.time())
         security_dict = {
             'content_type': str(self.target_object._meta),
-            'object_pk': str(self.target_object._get_pk_val()),
+            'object_pk': get_key_value(self.target_object),
             'timestamp': str(timestamp),
             'security_hash': self.initial_security_hash(timestamp),
         }
@@ -79,7 +80,7 @@ def initial_security_hash(self, timestamp):
 
         initial_security_dict = {
             'content_type': str(self.target_object._meta),
-            'object_pk': str(self.target_object._get_pk_val()),
+            'object_pk': get_key_value(self.target_object),
             'timestamp': str(timestamp),
         }
         return self.generate_security_hash(**initial_security_dict)
@@ -139,7 +140,7 @@ def get_comment_create_data(self, site_id=None):
         """
         return dict(
             content_type=ContentType.objects.get_for_model(self.target_object),
-            object_pk=force_str(self.target_object._get_pk_val()),
+            object_pk=get_key_value(self.target_object),
             user_name=self.cleaned_data["name"],
             user_email=self.cleaned_data["email"],
             user_url=self.cleaned_data["url"],

django_comments/utils.py

@@ -0,0 +1,31 @@
+from django.conf import settings
+from django.utils.encoding import force_str
+
+
+def get_key(model):
+    """
+    Get key of the model.
+
+    By default returns 'pk', but if COMMENTS_ID_OVERRIDES is defined,
+    returns the key defined by user.
+    """
+    COMMENTS_ID_OVERRIDES = getattr(settings, 'COMMENTS_ID_OVERRIDES', {})
+    class_identifier = f"{model._meta.app_label}.{model.__name__}"
+    if class_identifier in COMMENTS_ID_OVERRIDES:
+        return COMMENTS_ID_OVERRIDES[class_identifier]
+    else:
+        return 'pk'
+
+
+def get_key_value(target_object):
+    """
+    Get key of the model.
+
+    By default returns 'pk', but if COMMENTS_ID_OVERRIDES is defined,
+    returns the key defined by user.
+    """
+    key = get_key(target_object.__class__)
+    if key == 'pk':
+        return force_str(target_object._get_pk_val())
+    else:
+        return force_str(getattr(target_object, key))

django_comments/views/comments.py

@@ -12,6 +12,7 @@
 import django_comments
 from django_comments import signals
 from django_comments.views.utils import next_redirect, confirmation_view
+from django_comments.utils import get_key
 
 
 class CommentPostBadRequest(http.HttpResponseBadRequest):
@@ -51,7 +52,7 @@ def post_comment(request, next=None, using=None):
         return CommentPostBadRequest("Missing content_type or object_pk field.")
     try:
         model = apps.get_model(*ctype.split(".", 1))
-        target = model._default_manager.using(using).get(pk=object_pk)
+        target = model._default_manager.using(using).get(**{get_key(model): object_pk})
     except (LookupError, TypeError):
         return CommentPostBadRequest(
             "Invalid content_type value: %r" % escape(ctype))