plain.support 0.1.0__tar.gz

plain_support-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+.venv
+.env
+*.egg-info
+*.py[co]
+__pycache__
+*.DS_Store
+.coverage
+
+# Build files from publish
+plain*/dist/
+
+# Test apps
+plain*/tests/.plain

plain_support-0.1.0/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.4
+Name: plain.support
+Version: 0.1.0
+Summary: Basic support tools for Plain.
+Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
+Requires-Python: >=3.11
+Requires-Dist: plain-auth<1.0.0
+Requires-Dist: plain-models<1.0.0
+Requires-Dist: plain<1.0.0
+Description-Content-Type: text/markdown
+
+<!-- This file is compiled from plain-support/plain/support/README.md. Do not edit this file directly. -->
+
+# plain-support
+
+Captcha...
+
+## Security considerations
+
+Most support forms allow you to type in an email address. Be careful, because anybody can pretend to be anybody else at this point. Converations either need to continue over email (which confirms they have access to the email account), or include a verification step (emailing a code to the email address, for example).

plain_support-0.1.0/README.md

@@ -0,0 +1,9 @@
+<!-- This file is compiled from plain-support/plain/support/README.md. Do not edit this file directly. -->
+
+# plain-support
+
+Captcha...
+
+## Security considerations
+
+Most support forms allow you to type in an email address. Be careful, because anybody can pretend to be anybody else at this point. Converations either need to continue over email (which confirms they have access to the email account), or include a verification step (emailing a code to the email address, for example).

plain_support-0.1.0/plain/support/README.md

@@ -0,0 +1,7 @@
+# plain-support
+
+Captcha...
+
+## Security considerations
+
+Most support forms allow you to type in an email address. Be careful, because anybody can pretend to be anybody else at this point. Converations either need to continue over email (which confirms they have access to the email account), or include a verification step (emailing a code to the email address, for example).

plain_support-0.1.0/plain/support/assets/support/embed.js

@@ -0,0 +1,87 @@
+var container = document.createElement('div');
+document.currentScript.parentNode.insertBefore(container, document.currentScript);
+
+// Build the iframe url based on the script src
+// (replace the .js extension with /iframe/)
+var src = document.currentScript.src;
+var origin = new URL(src).origin;
+var iframeSrc = src.replace(/\.js$/, '/iframe/');
+
+var iframe = document.createElement('iframe');
+iframe.src = iframeSrc;
+iframe.width = "100%";
+iframe.height = "auto";
+iframe.style.border = "none";
+iframe.style.display = 'none';
+
+// Insert or select a loading div
+var loading;
+var loadingData = document.currentScript.getAttribute('data-loading');
+if (!loadingData) {
+    var svg = '<svg width="40px" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 200 200"><circle fill="none" stroke-opacity="1" stroke="#000000" stroke-width=".5" cx="100" cy="100" r="0"><animate attributeName="r" calcMode="spline" dur="1" values="1;80" keyTimes="0;1" keySplines="0 .2 .5 1" repeatCount="indefinite"></animate><animate attributeName="stroke-width" calcMode="spline" dur="1" values="0;25" keyTimes="0;1" keySplines="0 .2 .5 1" repeatCount="indefinite"></animate><animate attributeName="stroke-opacity" calcMode="spline" dur="1" values="1;0" keyTimes="0;1" keySplines="0 .2 .5 1" repeatCount="indefinite"></animate></circle></svg>';
+    loading = document.createElement('div');
+    loading.style.display = 'flex';
+    loading.style.justifyContent = 'center';
+    loading.innerHTML = svg;
+} else if (loadingData.startsWith("#")) {
+    loading = document.querySelector(loadingData);
+} else if (!loading) {
+    loading = document.createElement('div');
+    loading.textContent = loadingData;
+    loading.style.color = "black";
+}
+container.appendChild(loading);
+
+// Insert or select an error div
+var error;
+var errorData = document.currentScript.getAttribute('data-error');
+if (!errorData) {
+    error = document.createElement('div');
+    error.textContent = "There was an error. Please email us directly.";
+    error.style.color = "black";
+    error.style.display = 'none';
+} else if (errorData.startsWith("#")) {
+    error = document.querySelector(errorData);
+    error.style.display = 'none';
+} else {
+    error = document.createElement('div');
+    error.textContent = errorData;
+    error.style.color = "black";
+    error.style.display = 'none';
+}
+container.appendChild(error);
+
+// Keep track of whether the iframe has told us it is loaded
+var iframeLoaded = false;
+
+// Listen for postMessage events from the iframe
+window.addEventListener('message', (event) => {
+    if (event.origin !== origin) {
+        return;
+    }
+
+    if (event.data.type === 'setHeight') {
+        iframe.style.height = `${event.data.height}px`;
+    } else if (event.data.type === 'iframeLoaded') {
+        // The iframe has loaded, show it
+        iframe.style.display = 'block';
+        loading.style.display = 'none';
+
+        iframeLoaded = true;
+
+        error.style.display = 'none';
+        loading.style.display = 'none';
+        iframe.style.display = 'block';
+    }
+});
+
+container.appendChild(iframe);
+
+// If the iframe hasn't send a loaded message after 5 seconds, render an error emssage
+setTimeout(() => {
+    if (!iframeLoaded) {
+        error.style.display = 'block';
+        loading.style.display = 'none';
+        iframe.style.display = 'none';
+    }
+}, 5000);

plain_support-0.1.0/plain/support/assets/support/iframe.js

@@ -0,0 +1,28 @@
+document.addEventListener('DOMContentLoaded', () => {
+    function sendHeight(height) {
+        window.parent.postMessage({ type: 'setHeight', height: height }, "*");
+    }
+
+    let lastHeight = 0;
+
+    function calculateAndSendHeight() {
+        const height = document.documentElement.scrollHeight;
+        if (height !== lastHeight) {
+            lastHeight = height;
+            sendHeight(height);
+        }
+    }
+
+    // Observe DOM changes
+    const observer = new MutationObserver(calculateAndSendHeight);
+    observer.observe(document.body, { childList: true, subtree: true });
+
+    // Recalculate height on window resize
+    window.addEventListener('resize', calculateAndSendHeight);
+
+    // Send initial height
+    calculateAndSendHeight();
+
+    // Tell the embed.js that we loaded the iframe successfully (no other good way to do this)
+    window.parent.postMessage({ type: 'iframeLoaded' }, '*');
+});

plain_support-0.1.0/plain/support/config.py

@@ -0,0 +1,6 @@
+from plain.packages import PackageConfig
+
+
+class Config(PackageConfig):
+    name = "plain.support"
+    label = "plainsupport"

plain_support-0.1.0/plain/support/default_settings.py

@@ -0,0 +1,4 @@
+SUPPORT_FORMS = {
+    "default": "plain.support.forms.SupportForm",
+}
+SUPPORT_EMAIL: str

plain_support-0.1.0/plain/support/forms.py

@@ -0,0 +1,66 @@
+from plain.auth import get_user_model
+from plain.mail import TemplateEmail
+from plain.models.forms import ModelForm
+from plain.runtime import settings
+
+from .models import SupportFormEntry
+
+
+class SupportForm(ModelForm):
+    """
+    The form is the customization point for users.
+    So any behavior modifications should be possible here.
+    """
+
+    class Meta:
+        model = SupportFormEntry
+        fields = ["name", "email", "message"]
+
+    def __init__(self, user, form_slug, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.user = user  # User provided directly by authed request
+        self.form_slug = form_slug
+        if self.user:
+            self.fields["email"].initial = user.email
+
+    def find_user(self):
+        # If the user isn't logged in (typical in an iframe, depending on session cookie settings),
+        # we can still try to look them up by email
+        # to associate the entry with them.
+        #
+        # Note that since they aren't logged in, this doesn't necessarily
+        # confirm that this wasn't an impersonation attempt.
+        # Subsequent conversations over email will confirm that they have access to the email.
+        email = self.cleaned_data.get("email")
+        if not email:
+            return None
+        UserModel = get_user_model()
+        try:
+            return UserModel.objects.get(email=email)
+        except UserModel.DoesNotExist:
+            return
+
+    def save(self, commit=True):
+        instance = super().save(commit=False)
+        instance.user = self.user or self.find_user()
+        instance.form_slug = self.form_slug
+        if commit:
+            instance.save()
+        return instance
+
+    def notify(self, instance):
+        """
+        Notify the support team of a new support form entry.
+
+        Sends an immediate email by default.
+        """
+        email = TemplateEmail(
+            template="support_form_entry",
+            subject=f"Support request from {instance.name}",
+            to=[settings.SUPPORT_EMAIL],
+            reply_to=[instance.email],
+            context={
+                "support_form_entry": instance,
+            },
+        )
+        email.send()

plain_support-0.1.0/plain/support/migrations/0001_initial.py

@@ -0,0 +1,43 @@
+# Generated by Plain 0.15.0 on 2025-01-07 18:45
+
+import uuid
+
+import plain.models.deletion
+from plain import models
+from plain.models import migrations
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        ("users", "0001_reset"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="SupportFormEntry",
+            fields=[
+                ("id", models.BigAutoField(auto_created=True, primary_key=True)),
+                (
+                    "uuid",
+                    models.UUIDField(default=uuid.uuid4, editable=False, unique=True),
+                ),
+                ("name", models.CharField(max_length=255)),
+                ("email", models.EmailField(max_length=254)),
+                ("message", models.TextField()),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("form_slug", models.CharField(max_length=255)),
+                (
+                    "user",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=plain.models.deletion.SET_NULL,
+                        related_name="support_form_entries",
+                        to="users.user",
+                    ),
+                ),
+            ],
+        ),
+    ]

plain_support-0.1.0/plain/support/migrations/0002_alter_supportformentry_options.py

@@ -0,0 +1,16 @@
+# Generated by Plain 0.15.0 on 2025-01-07 21:37
+
+from plain.models import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("plainsupport", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="supportformentry",
+            options={"ordering": ["-created_at"]},
+        ),
+    ]

plain_support-0.1.0/plain/support/models.py

@@ -0,0 +1,25 @@
+import uuid
+
+from plain import models
+from plain.runtime import settings
+
+
+class SupportFormEntry(models.Model):
+    uuid = models.UUIDField(default=uuid.uuid4, editable=False, unique=True)
+    user = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=models.SET_NULL,
+        related_name="support_form_entries",
+        null=True,
+        blank=True,
+    )
+    name = models.CharField(max_length=255)
+    email = models.EmailField()
+    message = models.TextField()
+    created_at = models.DateTimeField(auto_now_add=True)
+    form_slug = models.CharField(max_length=255)
+    # referrer? source? session?
+    # extra_data
+
+    class Meta:
+        ordering = ["-created_at"]

plain_support-0.1.0/plain/support/staff.py

@@ -0,0 +1,20 @@
+from plain.staff.views import (
+    StaffModelDetailView,
+    StaffModelListView,
+    StaffModelViewset,
+    register_viewset,
+)
+
+from .models import SupportFormEntry
+
+
+@register_viewset
+class PageviewStaff(StaffModelViewset):
+    class ListView(StaffModelListView):
+        model = SupportFormEntry
+        nav_section = "Support"
+        title = "Form entries"
+        fields = ["user", "email", "name", "form_slug", "created_at"]
+
+    class DetailView(StaffModelDetailView):
+        model = SupportFormEntry

plain_support-0.1.0/plain/support/templates/mail/support_form_entry.html

@@ -0,0 +1 @@
+<div style="white-space: pre-line;">{{ support_form_entry.message }}</div>

plain_support-0.1.0/plain/support/templates/support/forms/default.html

@@ -0,0 +1,37 @@
+<div class="flex justify-center p-2">
+    <form class="max-w-2xl w-full" method="post" action="{{ form_action }}">
+        {{ csrf_input }}
+        <div class="flex space-x-4">
+            <div class="flex-1 space-y-1">
+                <label class="font-medium" for="{{ form.name.html_id }}">Name</label>
+                <input
+                    id="{{ form.name.html_id }}"
+                    class="block w-full rounded-sm text-black border-gray-300 border"
+                    required
+                    type="text"
+                    name="{{ form.name.html_name }}"
+                    value="{{ form.name.value() or '' }}">
+            </div>
+            <div class="flex-1 space-y-1">
+                <label class="font-medium" for="{{ form.email.html_id }}">Email</label>
+                <input
+                    id="{{ form.email.html_id }}"
+                    class="block w-full rounded-sm text-black border-gray-300 border"
+                    required
+                    type="email"
+                    name="{{ form.email.html_name }}"
+                    value="{{ form.email.value() or '' }}">
+            </div>
+        </div>
+        <div class="mt-4 space-y-1">
+            <label class="font-medium" for="{{ form.message.html_id }}">Message</label>
+            <textarea
+                id="{{ form.message.html_id }}"
+                class="block w-full text-black rounded-sm border-gray-300 border"
+                rows="10"
+                required
+                name="{{ form.message.html_name }}">{{ form.message.value() or '' }}</textarea>
+        </div>
+        <button class="mt-8 text-lg text-white block text-center bg-black hover:bg-black/80 w-full py-2 px-3 rounded-sm" type="submit">Submit</button>
+    </form>
+</div>

plain_support-0.1.0/plain/support/templates/support/iframe.html

@@ -0,0 +1,13 @@
+<html>
+    <head>
+        {% tailwind_css %}
+        <script src="{{ asset('support/iframe.js') }}"></script>
+    </head>
+    <body>
+        {% if success %}
+            {% include success_template_name %}
+        {% else %}
+            {% include form_template_name %}
+        {% endif %}
+    </body>
+</html>

plain_support-0.1.0/plain/support/templates/support/page.html

@@ -0,0 +1,11 @@
+{% extends "base.html" %}
+
+{% block content %}
+
+{% if success %}
+    {% include success_template_name %}
+{% else %}
+    {% include form_template_name %}
+{% endif %}
+
+{% endblock %}

plain_support-0.1.0/plain/support/templates/support/success/default.html

@@ -0,0 +1 @@
+<div class="text-center">Your message has been sent.</div>

plain_support-0.1.0/plain/support/urls.py

@@ -0,0 +1,12 @@
+from plain.urls import path
+
+from . import views
+
+default_namespace = "support"
+
+
+urlpatterns = [
+    path("form/<slug:form_slug>.js", views.SupportFormJSView),
+    path("form/<slug:form_slug>/iframe/", views.SupportIFrameView, name="iframe"),
+    path("form/<slug:form_slug>/", views.SupportFormView, name="form"),
+]

plain_support-0.1.0/plain/support/views.py

@@ -0,0 +1,59 @@
+from plain.assets.urls import get_asset_url
+from plain.http import ResponseRedirect
+from plain.runtime import settings
+from plain.utils.module_loading import import_string
+from plain.views import FormView, View
+from plain.views.csrf import CsrfExemptViewMixin
+
+
+class SupportFormView(FormView):
+    template_name = "support/page.html"
+
+    def get_form(self):
+        form_slug = self.url_kwargs["form_slug"]
+        form_class = import_string(settings.SUPPORT_FORMS[form_slug])
+        return form_class(**self.get_form_kwargs())
+
+    def get_template_context(self):
+        context = super().get_template_context()
+        form_slug = self.url_kwargs["form_slug"]
+        context["form_action"] = self.request.build_absolute_uri()
+        context["form_template_name"] = f"support/forms/{form_slug}.html"
+        context["success_template_name"] = f"support/success/{form_slug}.html"
+        context["success"] = self.request.GET.get("success") == "true"
+        return context
+
+    def get_form_kwargs(self):
+        kwargs = super().get_form_kwargs()
+        kwargs["user"] = self.request.user
+        kwargs["form_slug"] = self.url_kwargs["form_slug"]
+        return kwargs
+
+    def form_valid(self, form):
+        entry = form.save()
+        form.notify(entry)
+        return super().form_valid(form)
+
+    def get_success_url(self, form):
+        # Redirect to the same view and template so we
+        # don't have to create two additional views for iframe and non-iframe.
+        return "?success=true"
+
+
+class SupportIFrameView(CsrfExemptViewMixin, SupportFormView):
+    template_name = "support/iframe.html"
+
+    def get_response(self):
+        response = super().get_response()
+
+        # X-Frame-Options are typically in DEFAULT_RESPONSE_HEADERS,
+        # which will know to drop the header completely if an empty string.
+        # We can't del/pop it because DEFAULT_RESPONSE_HEADERS may add it back.
+        response.headers["X-Frame-Options"] = ""
+
+        return response
+
+
+class SupportFormJSView(View):
+    def get(self):
+        return ResponseRedirect(get_asset_url("support/embed.js"))

plain_support-0.1.0/pyproject.toml

@@ -0,0 +1,19 @@
+[project]
+name = "plain.support"
+version = "0.1.0"
+description = "Basic support tools for Plain."
+authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "plain<1.0.0",
+    "plain.models<1.0.0",
+    "plain.auth<1.0.0",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["plain"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"