From 9d32a512dc2a276a47c1436344e53376c3cf2b30 Mon Sep 17 00:00:00 2001
From: Erik Stein <erik@classlibrary.net>
Date: Tue, 2 Apr 2019 11:06:37 +0200
Subject: [PATCH] Added ObjectPluginBase class.

---
 content_plugins/base.py | 61 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)

diff --git a/content_plugins/base.py b/content_plugins/base.py
index 2830bfd..f8ba81e 100644
--- a/content_plugins/base.py
+++ b/content_plugins/base.py
@@ -1,4 +1,6 @@
+import os
 import re
+
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from django.db import models
@@ -182,6 +184,65 @@ class SectionBase(StyleMixin, FilesystemTemplateRendererPlugin):
         return context
 
 
+class ObjectPluginBase(FilesystemTemplateRendererPlugin):
+    fk_fieldname = None
+    regions = None
+
+    class Meta:
+        abstract = True
+
+    def __str__(self):
+        return str(getattr(self, self.fk_fieldname, ""))
+
+    @property
+    def object(self):
+        assert self.fk_fieldname, "fk_fieldname not set."
+        return getattr(self, self.fk_fieldname)
+
+    def get_type_slug(self):
+        type = getattr(self.object, 'type', None)
+        if type:
+            return getattr(type, 'internal_slug', "")
+        return ""
+
+    def get_template_names(self):
+        """"
+        _<fk_fieldname>_<object.type>/_<style>.html
+        _<fk_fieldname>_<object.type>.html
+        _<fk_fieldname>/_<style>.html
+        _<fk_fieldname>.html
+        """
+        assert self.fk_fieldname, "fk_fieldname not set."
+
+        template_names = []
+        type_slug = self.get_type_slug()
+
+        if getattr(self, 'template_name', False):
+            base_template_name = os.path.splitext(self.template_name)[0]
+        else:
+            base_template_name = "plugins/_{}".format(self.fk_fieldname)
+
+        if type_slug:
+            template_names.append(self.prefixed_path(
+                "{}_{}.html".format(
+                    base_template_name, type_slug
+                )
+            ))
+        template_names.append(
+            self.prefixed_path("{}.html".format(base_template_name)))
+        return template_names
+
+    @classmethod
+    def admin_inline(cls):
+        assert cls.fk_fieldname, "fk_fieldname not set."
+
+        inline = super().admin_inline()
+        if not inline.raw_id_fields:
+            inline.raw_id_fields = []
+        inline.raw_id_fields += [cls.fk_fieldname]
+        return inline
+
+
 # ImageBase can't live here because image managment is different from project to project
 # class ImageBase(StyleMixin, BasePlugin):
 #     image = models.ForeignKey(Image, on_delete=models.PROTECT)