search

Addpixel / KirbyComments

[Kirby 2] File-based comments stored as subpages for the Kirby CMS.
MIT License
68 stars 4 forks source link
comments kirby kirby-plugin

readme

Kirby Comments

File-based comments stored as subpages.

Table of Contents

Features

Installation

The recommended installation process is using the Kirby CLI.

$ kirby plugin:install Addpixel/KirbyComments

Manual Installation

  1. Download the latest release as a zip-file.
  2. Decompress the zip file and rename the folder to comments.
  3. Move the folder comments into site/plugins.

When updating, simply delete the old comments folder and replace it with the new one.

Usage

Kirby Comments includes three snippets: comments-form, comments-list and comments.

A quick and easy installation could use the following code:

<div class="comments">
  <?php snippet('comments') ?>
</div>

You can also place the form and list separately:

<div class="comments-list">
  <?php snippet('comments-list') ?>
</div>
...
<div class="comments-form">
  <?php snippet('comments-form') ?>
</div>

You are by no means limited to the snippets shipped with Kirby Comments. For creating your own form or comments list I recommend having a look at the following sections:

Options

Options may be set by calling c::set('comments.OPTION_NAME', $value) in your site/config/config.php.

// Enable email notifications
c::set('comments.email.enabled', true);
c::set('comments.email.to', array('name@example.org'));
Name Type Default Description *
pages.comments.dirname string "comments" Name of the folder of a comments page. *
pages.comments.template string "comments" Name of the template and blueprint of a comments page. *
pages.comment.dirname string "comment" Name of the folder of a comment page. *
pages.comment.template string "comment" Name of the template and blueprint of a comment page. *
pages.comment.visible bool true Whether comment pages are visible (have an index-prefix). *
form.submit string "submit" POST name of the submit button.
form.preview string "preview" POST name of the preview button.
form.name string "name" POST name of the name field.
form.name.required bool true Whether the name field is required.
form.name.max-length integer 64 Maximum length of the value in the name field.
form.email string "email" POST name of the email address field.
form.email.required type false Whether the email address field is required.
form.email.max-length integer 64 Maximum length of the value in the email address field.
form.website string "website" POST name of the website field.
form.website.max-length integer 64 Maximum length of the value in the website field.
form.message string "message" POST name of the message field.
form.message.allowed_tags string "<p><br><a><em><strong><code><pre>" HTML tags that are allowed in a comment’s message.
form.message.htmlentities bool true Whether to apply htmlentities to a message. If true is called before markdown. *
form.message.smartypants bool true Whether to apply SmartyPants to comment messages. Requires the global smartypants option to be true.
form.message.max-length integer 1024 Maximum length of the value in the message field.
form.session_id string "session_id" POST name of the session ID field.
form.honeypot string "subject" POST name of the honeypot field.
honeypot.enabled bool true Whether the plugin should use a honeypot.
honeypot.human-value string "" Value of an empty honeypot field.
email.enabled bool false Whether the plugin should send email notifications.
email.to array(string) array() List of email addresses that receive email notifications.
email.subject string "New Comment on {{ page.title }}" Subject of an email notification.
email.undefined-value string "(not specified)" Text that is inserted for values that the comment’s author did not specify.
session.key string "comments" Key used to store the comments session.
custom-field array(array(string => string|bool|Closure)) array() Custom field definitions.

* Can not be changed after the first comment was published on the site.

Email Notifications

Kirby Comments can notify you about new comments. Set the email.enabled option to true and specify at least one recipient using the email.to option.

The email’s body and subject can contain placeholders which will be replaced with the corresponding value. Placeholders have a name, start with {{ and end with }}.

You’ve received a new comment on “{{ page.title }}” by {{ comment.user.name }}.
Name Description
comment.user.name Name of the commentator.
comment.user.email Email address of the commentator.
comment.user.website Website of the commentator.
comment.message Message of the comment.
page.title Title of the page the comment was posted on.
page.url URL of the page on which the comment was posted.

Custom Markup

As described in Usage, Kirby Comments ships with three snippets: comments-form, comments-list and comments. These make it easy to get started, as you don’t have to write your own form or comment list.

However, you are not limited to only using these three snippets. This section describes how you can write your own comments form and list.

Accessing the Kirby Comments API

All comments are handled by the $comments object. Kirby offers variables like $site and $page as an interface to its functionality. In the same way, Kirby Comments allows you to access its functionality using the $comments variable.

$comments = $page->comments();

File Structure

$page in the above code example is referring to the page containing the comments page. A typical file structure looks like this:

content/
└─ blog/
   └─ 1-hello-world/        <- $page
      ├─ post.txt
      └─ comments/          <- comments page
         ├─ comments.txt
         ├─ 1-comment-1/    <- comment page
         │  └─ comment.txt
         ├─ 2-comment-2/
         │  └─ comment.txt
         └─ 3-comment-3/
            └─ comment.txt

Comments are stored as subpages, grouped in a hidden directory called “comments” (option pages.comments.dirname). This page contains the individual comment pages. The name of a comment page can be split into three pieces:

Custom Markup: Processing Comments

Before listing comments or rendering a form you should call $comments->process(). This will handle new comments submitted using the form and report a success or error status.

$status = $comments->process();

You can read more about the comment’s status in the API documentation.

Custom Markup: Comments List

$comments implements PHP’s Iterator interface so that you can loop over every comment using a foreach loop.

<?php foreach ($comments as $comment): ?>
  <div class="comment">
    <h3>Comment by <?php echo $comment->name() ?></h3>
    <div class="message"><?php echo $comment->message() ?></div>
  </div>
<?php endforeach ?>

If you want to add a heading before the comments, you can also check whether there are any comments.

<?php if (!$comments->isEmpty()): ?>
  <h2>Comments</h2>

  <?php foreach ($comments as $comment): ?>
    ...
  <?php endforeach ?>
<?php endif ?>

For a list of all $comment methods have a look at the API Documentation.

Custom Markup: Comments Form

Your form must fulfill the following criteria:

A name field is required by default, but you can remove this constraint by adding c::set('comments.form.name.required', false); to your config.php.

The following minimal example fulfills all of the requirements above.

<form method="post" accept-charset="utf-8">
  <label for="name">Name</label>
  <input type="text" id="name" name="<?php echo $comments->nameName() ?>" value="<?php echo $comments->nameValue() ?>">

  <label for="message">Message</label>
  <textarea id="message" name="<?php echo $comments->messageName() ?>"><?php echo $comments->messageValue() ?></textarea>

  <input type="hidden" name="<?php echo $comments->sessionIdName() ?>" value="<?php echo $comments->sessionId() ?>">

  <input type="submit" name="<?php echo $comments->previewName() ?>" value="Preview">
  <?php if ($comments->isValidPreview()): ?>
    <input type="submit" name="<?php echo $comments->submitName() ?>" value="Submit">
  <?php endif ?>
</form>

Note: The session ID ensures that no duplicated comment is submitted to the page by refreshing the page after having submitted a comment and prevents cross-site request forgery.

For security reasons and to prevent spam, you should not render the form after a comment was submitted. For this, wrap your form in an if block checking $comments->isSuccessfulSubmission().

<?php if ($comments->isSuccessfulSubmission()): ?>
  <p>Thank you for your comment!</p>
<?php else: ?>
  <form ...>
    ...
  </form>
<?php endif ?>

Using a Honeypot

By default, Kirby Comments will look for a honeypot value. Generally, a honeypot is a trap that checks for bots trying to submit comments. In the case of Kirby Comments, you include a field and hide it with CSS (most bots don’t load and apply CSS). Humans will not see the field and therefore not fill it out. Bots on the other hand mostly only read the HTML source code and fill out every field the find with whatever data they think fits best.

To use the honeypot, include the following in your form:

<div class="hide-me">
  <input type="text" name="<?php echo $comments->honeypotName() ?>" value="<?php echo $comments->honeypotValue() ?>">
</div>

If you do not use a honeypot, disable it in your config.php using c::set('comments.honeypot.enabled', false);.

Kirby Comments will block any comment submission with a honeypot value other than an empty string. You can change that by setting the honeypot.human-value option to any string you like. You can also change the name of the field using the form.honeypot option.

Jumping to the Comment

When submitting the form, the page will reload and your scroll position is lost. You can make the browser scroll automatically to the new comment by giving the new comment a unique ID and referencing it in the form’s action attribute.

<?php foreach ($comments as $comment): ?>
  <div id="comment-<?php echo $comment->id() ?>">
    ...
  </div>
<?php endforeach ?>

<form action="#comment-<?php echo $comments->nextCommentId() ?>" ...>
  ...
</form>

If you don’t want every comment to have an ID you can check for $comment->isPreview().

<?php foreach ($comments as $comment): ?>
  <div<? e($comment->isPreview(), ' id="preview-comment"') ?>>
    ...
  </div>
<?php endforeach ?>

<form action="#preview-comment" ...>
  ...
</form>

Custom Fields

Kirby Comments includes a name, email address, website address, and message field. Sometimes, however, you may want to associate additional information with a comment. Common use cases include fields for social-media usernames like a Twitter handle, hidden fields for implementing replies, or hidden fields for analytics (e.g. storing the user agent alongside the comment data).

You can find the complete custom fields documentation in the API reference.

Example: Twitter Handle

In this custom fields guide we will build a custom field for storing the Twitter handle of the comment author. We want this field to

Register Field

Custom fields are registered in your config.php. The simplest implementation of a custom fields takes only a name parameter.

c::set('comments.custom-fields', array(
  array('name' => 'twitter_handle')
));

This code already fulfills the first of our requirements, because custom fields are optional by default.

Sanitizing Values

Next, let’s ensure that the field starts with an at-sign. This can be achieved by adding a sanitize function. The sanitize function takes the value of the field and the page the comment was posted on. (We don’t need the page object in this example.)

c::set('comments.custom-fields', array(
  array(
    'name' => 'twitter_handle',
    'sanitize' => function ($value, $page) {
      $trimmed = trim($value);

      if ($trimmed[0] === '@') {
        return $trimmed;
      }
      return '@'.$trimmed;
    }
  )
));

We define sanitize to remove spaces from both side of the string (trim($value)), return the trimmed version if it already starts with an at-sign and otherwise add an @ before the trimmed value.

Validating Values

Lastly, we want to validate that the entered value does conform to Twitters username restrictions. Validating such specific patterns is a perfect scenario to use a regular expression.

c::set('comments.custom-fields', array(
  array(
    'name' => 'twitter_handle',
    'sanitize' => function ($value, $page) {
      $trimmed = trim($value);

      if ($trimmed[0] === '@') {
        return $trimmed;
      }
      return '@'.$trimmed;
    },
    'validate' => function ($value, $page) {
      return preg_match('/^\s*@?[A-Za-z0-9_]{1,15}\s*$/', $value) === 1;
    }
  )
));

validate, like sanitize receives a $value and a $page argument of which we only need the $value in this example. validate returns true if the regular expression matches and false otherwise.

Note that sanitize is only called if validate returns true. This way, you don’t have to validate values received by sanitize.

Our custom field is ready to be used! Add it to the comments <form> so that users can fill it out:

<?php $comments = $page->comments() ?>
<form ...>
...

<label for="twitter-field">Twitter Handle</label>
<input name="twitter_handle" value="<?php echo $comments->customFieldValue('twitter_handle') ?>" type="text" id="twitter-field">

...
</form>

Do you want to do more with custom fields? Have a look at the custom fields documentation in the API reference.

API Documentation

$comments : Comments implements Iterator, Countable

A Comments instance manages the comments of a specific Kirby page. This involves processing HTTP POST data for creating comment previews, submitting comments, storing comments as Kirby pages, reading those pages and reporting status.

$comments = $page->comments();

$comments->page() : Page

Kirby page on which the comments are posted.

$comments->process() : CommentsStatus

Processes comments based on the HTTP POST data of the HTTP request. This involves generating preview comments, storing published comments as Kirby pages, creating comments pages, validating user data and sending email notifications.

This method may be called multiple times during a single HTTP request but execute only once. On repeated calls, the current status object is returned.

$comments->isEmpty() : bool

true if no comment is managed by this Comments instance.

$comments->count() : integer

Number of comments managed by this Comments instance.

$comments->nextCommentId() : integer

The ID of the preview comment in case of a preview; the ID of the next, as of yet unwritten, comment otherwise. IDs start at 1 and increment on a per-page basis by 1.

$comments->isSuccessfulSubmission() : bool

true if the user has submitted a comment and no errors occurred.

$comments->value($name : string, $default="" : string) : string

Returns the HTML-escaped value of the HTTP POST data with the name $name.

When a user submits a form, the page is reloaded and all fields in the form are cleared. In order to keep the text that the user has typed into the fields, you have to set the value attribute of all input fields to the value which was transmitted by the forms request.

This method helps you in doing so by returning $default if the form was not submitted, or an HTML-escaped version of the value posted by the user.

<input ... value="<?php echo $comments->value($comments->emailName()) ?>">

$comments->nameValue($default="" : string) : string

Convenience method for accessing $this->value() for the name field.

$comments->emailValue($default="" : string) : string

Convenience method for accessing $this->value() for the email field.

$comments->websiteValue($default="" : string) : string

Convenience method for accessing $this->value() for the website field.

$comments->messageValue($default="" : string) : string

Convenience method for accessing $this->value() for the message field.

$comments->customFieldValue($field_name : string, $default="" : string) : string

Convenience method for accessing $this->value() for custom fields.

$comments->honeypotValue($default="" : string) : string

Convenience method for accessing $this->value() for the honeypot field.

$comments->submitName() : string

HTTP POST name of the submit button. Used as the key for the HTTP POST data and as the value of the HTML input name attribute. The value is defined by the form.submit option.

$comments->previewName() : string

HTTP POST name of the preview button. Used as the key for the HTTP POST data and as the value of the HTML input name attribute. The value is defined by the form.preview option.

$comments->nameName() : string

HTTP POST name of the name field. Used as the key for the HTTP POST data and as the value of the HTML input name attribute. The value is defined by the form.name option.

$comments->requiresName() : bool

true if a comment author has to provide an email address. Corresponding option: form.name.required.

$comments->nameMaxLength() : integer

Maximum allowed number of characters in the comment’s name field. Corresponding option: form.name.max-length.

$comments->emailName() : string

HTTP POST name of the email field. Used as the key for the HTTP POST data and as the value of the HTML input name attribute. The value is defined by the form.email option.

$comments->requiresEmailAddress() : bool

true if a comment author has to provide an email address. Corresponding option: form.name.required.

$comments->emailMaxLength() : integer

Maximum allowed number of characters in the comment’s email field. Corresponding option: form.email.max-length.

$comments->websiteName() : string

HTTP POST name of the website field. Used as the key for the HTTP POST data and as the value of the HTML input name attribute. The value is defined by the form.website option.

$comments->websiteMaxLength() : integer

Maximum allowed number of characters in the comment’s website field. Corresponding option: form.website.max-length.

$comments->messageName() : string

HTTP POST name of the message field. Used as the key for the HTTP POST data and as the value of the HTML input name attribute. The value is defined by the form.message option.

$comments->messageMaxLength() : integer

Maximum allowed number of characters in the comment’s message field. Corresponding option: form.message.max-length.

$comments->customFieldName($field_name : string) : string|null

HTTP POST name of a custom field. Used as the key for the HTTP POST data and as the value of the HTML input name attribute. null if no custom field with the name $field_name exists.

$comments->honeypotName() : string

HTTP POST name of the honeypot field. Used as the key for the HTTP POST data and as the value of the HTML input name attribute. The value is defined by the form.honeypot option.

$comments->isUsingHoneypot() : bool

true if the honeypot mechanism is enabled. Corresponding option: honeypot.enabled.

$comments->sessionIdName() : string

HTTP POST name of the session ID field. Used as the key for the HTTP POST data and as the value of the HTML input name attribute. The value is defined by the form.session_id option.

$comments->sessionId() : string

ID of the current comments session.

$comments->isValidPreview() : bool

true if the current request is a preview and the preview is valid.

$comments->toArray() : Comment[]

Returns the comments managed by this Comments instance sorted in chronological order.

$comments->nestByField($reference_field : string|null, $anchor_field=null : string|null, $compare_stringvalue=true : bool) : NestedComment[]

Nests comments based on a reference-to-anchor relationship.

The anchor must be unique for every comment while zero or more references may point to the same anchor. A comment is added as a child if its reference matches the anchor of another comment. A comment may not reference its own anchor. If the reference of a comment does not match any anchor it is placed at the top level.

If $reference_field or $anchor_field are null, the comment’s ID is used instead.

By default, the string value of the reference and the anchor are compared. Set $compare_stringvalue to false to compare the original values.

$comment : Comment

A Comment object stores information about the comment author, the comment’s message, and metadata like the publication date and the comment ID.

Additionally, it provides methods for accessing its values in unescaped and escaped form for rendering templates.

<?php foreach ($comments as $comment): ?>
  ...
<?php endforeach ?>

$comment->id() : integer

Unique identifier of the comment. The first comment on a page has an ID of 1, incrementing by 1 per page.

$comment->name() : string

HTML escaped name of the comment author. "" if no name was specified.

$comment->rawName() : string|null

Unescaped name of the comment author. null if no name was specified. May contain unescaped HTML code; use with caution!

$comment->email() : string

HTML escaped email address of the comment author. "" if no email address was specified.

$comment->rawEmail() : string|null

Unescaped email address on the comment author. null if no email address was specified. May contain unescaped HTML code; use with caution!

$comment->website() : string

HTML escaped website address of the comment author. "" if no website address was specified.

$comment->rawWebsite() : string

Unescaped website address of the comment author. null if no website address was specified. May contain unescaped HTML code; use with caution!

$comment->message() : string

Formatted message which is processed using Markdown and optionally SmartyPants. Only HTML tags allowed by the form.message.allowed_tags option are kept. HTML tags and HTML entities included in the message are escaped before applying the Markdown formatter.

$comment->rawMessage() : string

Unprocessed message. May contain unescaped HTML/Markdown code; use with caution!

$comment->customFields() : CommentsField[]

List of custom fields.

$comment->customField($fieldName : string) : mixed|null

Unescaped value of the custom field with the name $fieldName. null if no custom field with the name $fieldName exists.

$comment->date($format="Y-m-d" : string) : string

Formatted date and/or time of the publication of the comment. The value of $format must match a pattern for PHP’s DateTime::format method.

$comment->datetime() : DateTime

Date and time of the publication of the comment.

$comment->page() : Page

Page on which the comment was posted or if the comment is in preview mode, the page on which the comment is previewed.

$comment->isPreview() : bool

true if the comment is in preview mode and not stored as Kirby page.

$comment->isLinkable() : bool

true if the website address of the comment author is not null.

$nested : NestedComment extends Comment

An augmentation of the standard Comment class which support nesting. Nested comments are constructed from a standard comment and are assigned to a parent comment by calling $parent->addChild($child).

Nest comments using $comments->nestByField(). You can also design your own nesting algorithm using this class to store children and parent information.

$nested->parent() : NestedComment

Parent comment in the nested structure. null if the comment is nested on the top level.

$nested->children() : NestedComment[]

List of comments nested directly underneath this comment.

$nested->hasChildren() : bool

true if the comment has nested children.

$nested->addChild($child : NestedComment)

Adds a comment to the children list and sets this comment as its parent.

$status : CommentsStatus

A status describes the state of an object after an operation and can either be a success status or an error status. While only one success code (status code 0) exists, multiple errors codes (split into multiple domains) help to describe the exact nature of the problem.

$status = $comments->process();

$status->getCode() : integer

Status code indicating the type of status. Have a look at the documentation for a complete table of status codes and their meaning.

Domain Code Description
Success 0 Success.
System 100 Expected comment ID of type integer.
System 101 Expected comment ID of value greater than 0.
System 102 Could not construct Comment from page.
Developer 200 Could not create comments page.
Developer 201 Could not create comment page.
Developer 202 Could not read email template file.
Developer 203 Could not send email notification about new comment.
Developer 204 Custom field without name attribute.
User 300 The current session is invalid.
User 301 The name field is required. (Only when requiring name.)
User 302 The name is too long.
User 303 The email address field is required. (Only when requiring email address.)
User 304 The email address must be valid. (Only when requiring email address or not empty.)
User 305 The email address is too long.
User 306 The website address field must not contain JavaScript code.
User 307 The website address is too long.
User 308 The message field is required.
User 309 The message is too long.
User 310 The comment must be written by a human being.
User 311 Invalid custom field.
User 312 The custom field is required.
User 313 The custom field is too long.
Custom 4xx Custom exceptions.

You can either show the user the default message ($status->getMessage()) or provide your own status descriptions by checking the code in a switch statement.

$status->getMessage() : string

Message of the exception that caused this status if $this->exception is not null; string describing the status code as such otherwise.

$status->getException() : Exception

Exception that has caused the status. null if the status is not based upon an exception.

$status->isUserError() : bool

true if the status is in the User or Custom domain.

$status->isSuccess() : bool

true if the status is in the Success domain.

$status->isError() : bool

true if the status is not in the Success domain.

$type : CommentsFieldType

Defines the name, title, HTTP POST name, properties of custom fields, and provides validation and sanitization mechanisms. Custom fields are constructed from an associative array and placed in your config.php.

c::set('comments.custom-fields', array(
  array(
    'name' => 'my_custom_field',
    'title' => 'My Custom Field',
    'http-post-name' => 'my_custom_field',
    'required' => true,
    'max-length' => 32,
    'validate' => function ($value, $page) {
      ...
    },
    'sanitize' => function ($value, $page) {
      ...
    }
  )
));

name : string

(required) Name of the field type. Must be usable as a YAML object key.

title : string

(optional, defaults to name) Title of the field type. Describes the field type with one or two words.

http-post-name : string

(optional, defaults to name) Name used to identify fields of this type over HTTP POST.

required : bool

(optional, defaults to false) true if the value of fields of this type may not be an empty string or missing from the HTTP POST data.

max-length : integer

(optional, defaults to 128) Maximum allowed number of characters in the field.

validate : Closure ($value : string, $page : Page) : bool

(optional, defaults to null) Validates the value of a field of this type. This closure receives the field’s value as its first argument. Returns true for valid values, throws exceptions with a code in the range of 400–499 for known validation errors and returns false for unknown validation errors. Note that this closure is called after Kirby Comments’s validation (which checks required and max-length).

If null, a return value of true is assumed.

sanitize : Closure ($value : string, $page, Page) : mixed|null

(optional, defaults to null) Sanitizes the value of a field of this type. This closure receives the field’s value as its first argument and must return a value. Note that this closure is called after Kirby Comments’s validation and after validate.

If null, a return value of $value is assumed.

Hooks

Hooks allow to alter the behavior of Kirby Comments by running custom code at specific events. Hooks are defined in Kirby’s config.php and use the comments.hooks. prefix.

decide-block-comment($comments : Comments, $comment : Comment) : bool

Blocks the creation of a comment for a return value of true. Blocking a comment causes:

This hook is invoked after a comment is created from the HTTP POST data. This happens during preview mode and when submitting a comment.

Example: Blocking URLs
c::set('comments.hooks.decide-block-comment', function ($comments, $comment) {
  if (strpos($comment->rawWebsite(), 'http://www.5z8.info') !== false) {
    return true;
  }
  return false;
});
Example: Blocking URLs With Custom Error Message
c::set('comments.hooks.decide-block-comment', function ($comments, $comment) {
  if (strpos($comment->rawWebsite(), 'http://www.5z8.info') !== false) {
    throw new Exception('5z8.info links are not allowed.', 400);
  }
  return false;
});

did-create-comments-page($comments : Comments, $commentsPage: Page)

This hook is invoked after a comments page has been created.

did-preview-comment($comments : Comments, $comment : Comment)

This hook is invoked after a comment preview has been successfully generated.

did-save-comment($comments : Comments, $comment : Comment, $commentPage : Page)

This hook is invoked after a comment has been saved as file.

decide-comments-page-title($page : Page) : string

Returns the title of the comments page which will be created as subpage of $page.

Default
function ($page) {
  return 'Comments for “' . $page->title() . '”';
}

get-content-page-title($page : Page) : string

Returns the title of a content page. Most pages use the title field to store the title of the page, but some pages may use a different field as title and should return that instead.

Default
function ($page) {
  return $page->title();
}