Django - Tutorial 011. Hinzufügen von Kommentaren zur Site basierend auf Django

MaterializedPath, Django, Python

Als ich anfing, Kommentare auf der Site für Django zu implementieren, war ich überrascht, dass Django keine Module zum Implementieren von Kommentaren bereitstellt. Vielmehr stellte er es vorher zur Verfügung, es war das Modul django.contrib.comments , aber in Version 1.7 wurde es als veraltet deklariert und angeboten, es entweder selbst zu schneiden oder so etwas wie ** Disqus. * zu verwenden. * Gut , es scheint auch das Hervorheben der Codesyntax zu unterstützen, aber ... es gibt ein Highlight in den Artikeln, ein anderes in den Kommentaren - es wird hässlich.

Deshalb werden wir unser eigenes Fahrrad vorstellen und unsere Käfer fangen.

Um Kommentare zu implementieren, müssen Sie:

• Fügen Sie ein neues Modell hinzu, nennen wir es Kommentar;
• Fügen Sie eine Ansicht hinzu, die das Hinzufügen eines Kommentars behandelt;
• Fügen Sie ein Formular hinzu, um einen Kommentar einzugeben;
• Verwenden Sie den [Materialized Path]-Ansatz, um die Baumstruktur zu organisieren (https://evileg.com/ru/post/12/);

Kommentarmodell

Das Kommentarmodell enthält die folgenden Felder:

• path - enthält ein Array von ganzzahligen Werten, die den vollständigen Pfad zum Stammverzeichnis enthalten. Wie im Artikel Materialisierter Pfad beschrieben, sind dies die IDs aller übergeordneten Elemente;
• article \ _id - Fremdschlüssel für den Artikel, der den Kommentar enthält;
• author \ _id - Fremdschlüssel zum Autor des Kommentars;
• Inhalt - der Kommentar selbst;
• pub \ _date - Datum und Uhrzeit der Veröffentlichung des Kommentars;

Darüber hinaus gibt es Methoden get \ _offset () , die die Höhe des Kommentar-Offsets entlang der Pfadlänge bestimmen, und get \ _col () , die die Anzahl der Spalten in der Raster, das der Kommentar belegt, sowie die überschriebene Methode \ _ \ _ str \ _ \ _, die für die Anzeige eines Teils des Kommentarinhalts im Admin-Panel verantwortlich ist.

Die Verschiebung und die Anzahl der Spalten organisieren die baumartige Anzeige der Kommentare auf der Seite, aber die Verschiebung beträgt nicht mehr als 6 Spalten, da das Raster derzeit in 12 Spalten unterteilt ist.

class Comment(models.Model):
    class Meta:
        db_table = "comments"

    path = ArrayField(models.IntegerField())
    article_id = models.ForeignKey(Article)
    author_id = models.ForeignKey(User)
    content = models.TextField('Комментарий')
    pub_date = models.DateTimeField('Дата комментария', default=timezone.now)

    def __str__(self):
        return self.content[0:200]

    def get_offset(self):
        level = len(self.path) - 1
        if level > 5:
            level = 5
        return level

    def get_col(self):
        level = len(self.path) - 1
        if level > 5:
            level = 5
        return 12 - level

URLs.py-Datei

Der Kommentar wird mit einer POST-Anfrage an eine bestimmte Adresse an die Site gesendet, die in der Datei urls.py beschrieben werden muss

from django.conf.urls import url

from . import views

app_name = 'post'
urlpatterns = [
    url(r'^(?P<article_id>[0-9]+)/$', views.EArticleView.as_view(), name='article'),
    url(r'^comment/(?P<article_id>[0-9]+)/$', views.add_comment, name='add_comment'),
]

Wie ich in vielen Artikeln sagte, arbeite ich im Wissensmodul mit Artikeln und Abschnitten, aber diesmal habe ich die Artikel in ein separates Modul verschoben, um die URL der Artikel zu vereinheitlichen, damit sie nicht von der abhängig sind Abschnitte und Indexierung gehen nicht verloren, falls der Artikel in einen anderen Abschnitt verschoben wird. Daher geht jetzt die Arbeit mit dem Post -Modul. Dort wird auch ein Kommentar verschickt. Als Ergebnis wird ein Kommentar entlang des Pfads post / comment / 12 gesendet, wenn der Benutzer Artikel mit der ID = 12 kommentiert.

Kommentarformular

Das Kommentarformular wird in einer separaten Datei abgelegt forms.py.

Die Verarbeitung des Formulars und das Speichern des Kommentars erfolgt in der Ansicht, daher gibt es hier keine Speichermethode. Dieses Formular dient lediglich dazu, einen Kommentar einzugeben und an den Server zu senden.

from django import forms

from .models import Comment


class CommentForm(forms.Form):

    parent_comment = forms.IntegerField(
        widget=forms.HiddenInput,
        required=False
    )

    comment_area = forms.CharField(
        label="",
        widget=forms.Textarea
    )

Das Feld parent \ _comment ist sehr wichtig, da es die ID des übergeordneten Kommentars enthält, die automatisch ersetzt wird, wenn auf einen der Kommentare unter dem Artikel geantwortet wird. Der Benutzer wird es nicht ausfüllen und es wird ausgeblendet. Außerdem ist das Ausfüllen optional, da sich der Kommentar direkt auf den Artikel beziehen kann.

Nun, die Beziehung zu einem bestimmten Kommentar erfolgt über ein JavaScript-Skript.

Darstellung

Um einen Kommentar hinzuzufügen, beschränkte ich mich auf eine Methode ohne Präsentation, zumal der Dekorator @ login \ _required einfacher an eine Methode als an eine Ansicht angehängt werden kann.

Außerdem wurde die für die Anzeige des Artikels zuständige Ansicht geändert, da das Kommentarformular in den Kontext der jeweiligen Artikelseite eingebunden werden musste, wenn der Benutzer natürlich eingeloggt ist.

from django.views import View
from django.shortcuts import render_to_response, get_object_or_404, redirect
from django.contrib import auth
from django.http import Http404
from django.contrib.auth.decorators import login_required
from django.views.decorators.http import require_http_methods
from django.core.exceptions import ObjectDoesNotExist
from django.template.context_processors import csrf

from knowledge.models import Article, Comment
from knowledge.forms import CommentForm


class EArticleView(View):
    template_name = 'post/article.html'
    comment_form = CommentForm

    def get(self, request, *args, **kwargs):
        article = get_object_or_404(Article, id=self.kwargs['article_id'])
        context = {}
        context.update(csrf(request))
        user = auth.get_user(request)
        # Помещаем в контекст все комментарии, которые относятся к статье
        # попутно сортируя их по пути, ID автоинкрементируемые, поэтому
        # проблем с иерархией комментариев не должно возникать 
        context['comments'] = article.comment_set.all().order_by('path')
        context['next'] = article.get_absolute_url()
        # Будем добавлять форму только в том случае, если пользователь авторизован
        if user.is_authenticated:
            context['form'] = self.comment_form

        return render_to_response(template_name=self.template_name, context=context)

# Декораторы по которым, только авторизованный пользователь 
# может отправить комментарий и только с помощью POST запроса
@login_required
@require_http_methods(["POST"])
def add_comment(request, article_id):

    form = CommentForm(request.POST)
    article = get_object_or_404(Article, id=article_id)

    if form.is_valid():
        comment = Comment()
        comment.path = []
        comment.article_id = article
        comment.author_id = auth.get_user(request)
        comment.content = form.cleaned_data['comment_area']
        comment.save()

        # Django не позволяет увидеть ID комментария по мы не сохраним его, 
        # хотя PostgreSQL имеет такие средства в своём арсенале, но пока не будем
        # работать с сырыми SQL запросами, поэтому сформируем path после первого сохранения
        # и пересохраним комментарий 
        try:
            comment.path.extend(Comment.objects.get(id=form.cleaned_data['parent_comment']).path)
            comment.path.append(comment.id)
        except ObjectDoesNotExist:
            comment.path.append(comment.id)

        comment.save()

    return redirect(article.get_absolute_url())

Artikelvorlage mit Kommentar

Habe ich erwähnt, dass ich das Modul django-bootstrap3 für das Seitenlayout verwende? Seien Sie also nicht überrascht, wie diese Vorlage aufgebaut ist.

Kommentare sind normale Zeilen im Bootstrap Grid-System, und die Baumstruktur wird durch Verschieben der Spalten erreicht.

Es ist hier sehr wichtig, dass jede Zeile id = {{comment.id}} hat - Dies ist genau der Wert, der in das versteckte Formularfeld eingefügt wird, wenn der Benutzer nicht den Artikel kommentiert, sondern einige von die Kommentare.

Das Kommentarformular auf der Seite wird mit derselben ID mit JavaScript navigiert. Und das Formular wird mit der Funktion show \ _comments \ _form() platziert. Diese Funktion wird im Link-Handler "Antworten" für jeden Kommentar sowie im Link-Handler platziert, um nur einen Kommentar zu schreiben . Diese Funktion verwendet die jQuery-Bibliothek. Vergessen Sie also nicht, sie in Ihr Basis-Template aufzunehmen. Ich verbinde die verwendete Version mit Bootstrap.

{% extends 'home/base.html' %}
{% load bootstrap3 %}
{% block page %}
    <article>
        <h1>{{ article.article_title }}</h1>
        {{ article.article_content|safe }}
    </article>
    <h2>Комментарии</h2>
    {% for comment in comments %}
        <a name="comment-{{ comment.id }}"></a>
        <div class="row" id="{{ comment.id }}">
            <div class="col-md-{{ comment.get_col }} col-md-offset-{{ comment.get_offset }}">
                <div class="panel panel-default">
                    <div class="panel-heading">
                        <strong>{{ comment.author_id.get_full_name|default:comment.author_id.username }}</strong>&nbsp;&nbsp;
                        {{ comment.pub_date }}
                        <a href="#comment-{{ comment.id }}">#</a>
                    </div>
                    <div class="panel-body">
                        <div>{{ comment.content|safe }}</div>
                        {% if form %}<a class="btn btn-default btn-xs pull-right"
                                        onclick="return show_comments_form({{ comment.id }})">
                            {% bootstrap_icon "share-alt" %}&nbsp;&nbsp;Ответить</a>
                        {% endif %}
                    </div>
                </div>
            </div>
        </div>
    {% endfor %}
    {% if form %}
        <h3 id="write_comment"><a onclick="return show_comments_form('write_comment')">Написать комментарий</a></h3>
        <form id="comment_form" action="{% url 'post:add_comment' article.id %}" method="post">
        {% csrf_token %}
        {% bootstrap_form form %}
        {% buttons %}
            <button type="submit" class="btn btn-primary">{% bootstrap_icon "comment" %}&nbsp;&nbsp;Комментировать</button>
        {% endbuttons %}
        </form>
    {% else %}
        <div class="panel panel-warning">
            <div class="panel-heading">
                <h3 class="panel-title">Комментарии</h3>
            </div>
            <div class="panel-body">
                Только авторизованные пользователи могут оставлять комментарии.<br />
            </div>
        </div>
    {% endif %}
{% endblock %}

JavaScript zum Verschieben von Kommentaren auf der Seite

Nun, alles ist einfach zu blamieren. Wenn id = write \ _comment bedeutet dies, dass der Kommentar die erste Ebene hat und das versteckte Feld leer ist und das Formular unter die Aufschrift "Kommentar schreiben" verschoben wird. Andernfalls füllen wir in das versteckte Feld und platzieren Sie es unter dem Kommentar , unter dem wir die Antwort geben.

function show_comments_form(parent_comment_id)
{
    if (parent_comment_id == 'write_comment')
    {
        $("#id_parent_comment").val('')
    }
    else
    {
        $("#id_parent_comment").val(parent_comment_id);
    }
    $("#comment_form").insertAfter("#" + parent_comment_id);
}

Für Django empfehle ich Timeweb VDS-Server .