Imported Pingbacks can display or be toggled off. You can also display
comments but have adding new ones disabled. TODO: allow disabling comments on a per page basis.
This commit is contained in:
parent
563d7af096
commit
a52c1b2f6d
|
@ -1,4 +1,9 @@
|
||||||
# Grav Comments Plugin
|
# Grav Comments Plugin \[Fork\]
|
||||||
|
|
||||||
|
This plugin adds support for displaying pingbacks, toggling the display of pingbacks. I'm not yet sure how pingbacks work, so this may not include support for adding new pingbacks; if it won't take too much work I'll add more support for them.
|
||||||
|
|
||||||
|
The main goal of this fork is to add support for Akismet. Recaptcha guards from bots, but Akismet helps deal with actual spam content.
|
||||||
|
---
|
||||||
|
|
||||||
The **Comments Plugin** for [Grav](http://github.com/getgrav/grav) adds the ability to add comments to pages, and moderate them.
|
The **Comments Plugin** for [Grav](http://github.com/getgrav/grav) adds the ability to add comments to pages, and moderate them.
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
name: Comments
|
name: Comments
|
||||||
version: 1.2.7
|
version: 1.2.8
|
||||||
description: Adds a commenting functionality to your site
|
description: Adds a commenting functionality to your site
|
||||||
icon: comment
|
icon: comment
|
||||||
author:
|
author:
|
||||||
|
@ -29,3 +29,23 @@ form:
|
||||||
0: PLUGIN_ADMIN.DISABLED
|
0: PLUGIN_ADMIN.DISABLED
|
||||||
validate:
|
validate:
|
||||||
type: bool
|
type: bool
|
||||||
|
pingbacks:
|
||||||
|
type: toggle
|
||||||
|
label: Pingbacks
|
||||||
|
highlight: 1
|
||||||
|
default: 0
|
||||||
|
options:
|
||||||
|
1: PLUGIN_ADMIN.ENABLED
|
||||||
|
0: PLUGIN_ADMIN.DISABLED
|
||||||
|
validate:
|
||||||
|
type: bool
|
||||||
|
commenting:
|
||||||
|
type: toggle
|
||||||
|
label: Commenting
|
||||||
|
highlight: 1
|
||||||
|
default: 0
|
||||||
|
options:
|
||||||
|
1: PLUGIN_ADMIN.ENABLED
|
||||||
|
0: PLUGIN_ADMIN.DISABLED
|
||||||
|
validate:
|
||||||
|
type: bool
|
||||||
|
|
51
comments.php
51
comments.php
|
@ -1,6 +1,9 @@
|
||||||
<?php
|
<?php
|
||||||
namespace Grav\Plugin;
|
namespace Grav\Plugin;
|
||||||
|
|
||||||
|
use Grav\Common\Blueprint;
|
||||||
|
use Grav\Common\Blueprints;
|
||||||
|
use Grav\Common\BlueprintSchema;
|
||||||
use Grav\Common\Filesystem\Folder;
|
use Grav\Common\Filesystem\Folder;
|
||||||
use Grav\Common\GPM\GPM;
|
use Grav\Common\GPM\GPM;
|
||||||
use Grav\Common\Grav;
|
use Grav\Common\Grav;
|
||||||
|
@ -18,7 +21,11 @@ class CommentsPlugin extends Plugin
|
||||||
{
|
{
|
||||||
protected $route = 'comments';
|
protected $route = 'comments';
|
||||||
protected $enable = false;
|
protected $enable = false;
|
||||||
|
protected $commenting_enabled = false;
|
||||||
|
protected $pingbacks_enabled = false;
|
||||||
|
|
||||||
protected $comments_cache_id;
|
protected $comments_cache_id;
|
||||||
|
protected $pingbacks_cache_id;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return array
|
* @return array
|
||||||
|
@ -74,7 +81,10 @@ class CommentsPlugin extends Plugin
|
||||||
|
|
||||||
public function onTwigSiteVariables() {
|
public function onTwigSiteVariables() {
|
||||||
$this->grav['twig']->enable_comments_plugin = $this->enable;
|
$this->grav['twig']->enable_comments_plugin = $this->enable;
|
||||||
|
$this->grav['twig']->commenting_enabled = $this->commenting_enabled;
|
||||||
|
$this->grav['twig']->pingbacks_enabled = $this->pingbacks_enabled;
|
||||||
$this->grav['twig']->comments = $this->fetchComments();
|
$this->grav['twig']->comments = $this->fetchComments();
|
||||||
|
$this->grav['twig']->pingbacks = $this->fetchPingbacks();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -100,6 +110,13 @@ class CommentsPlugin extends Plugin
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#$blueprint = $this->getBlueprint();
|
||||||
|
#$this->commenting_enabled = $blueprint->get('form/fields/commenting', false, '/');
|
||||||
|
#$this->pingbacks_enabled = $blueprint->get('form/fields/pingbacks' , false, '/');
|
||||||
|
|
||||||
|
$this->commenting_enabled = $this->grav['config']->get('plugins.comments.commenting');
|
||||||
|
$this->pingbacks_enabled = $this->grav['config']->get('plugins.comments.pingbacks');
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -127,6 +144,8 @@ class CommentsPlugin extends Plugin
|
||||||
|
|
||||||
//init cache id
|
//init cache id
|
||||||
$this->comments_cache_id = md5('comments-data' . $cache->getKey() . '-' . $uri->url());
|
$this->comments_cache_id = md5('comments-data' . $cache->getKey() . '-' . $uri->url());
|
||||||
|
|
||||||
|
$this->pingbacks_cache_id = md5('pingbacks-data' . $cache->getKey() . '-' . $uri->url());
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -185,6 +204,10 @@ class CommentsPlugin extends Plugin
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (!$this->commenting_enabled) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
switch ($action) {
|
switch ($action) {
|
||||||
case 'addComment':
|
case 'addComment':
|
||||||
$post = isset($_POST['data']) ? $_POST['data'] : [];
|
$post = isset($_POST['data']) ? $_POST['data'] : [];
|
||||||
|
@ -195,6 +218,7 @@ class CommentsPlugin extends Plugin
|
||||||
$name = filter_var(urldecode($post['name']), FILTER_SANITIZE_STRING);
|
$name = filter_var(urldecode($post['name']), FILTER_SANITIZE_STRING);
|
||||||
$email = filter_var(urldecode($post['email']), FILTER_SANITIZE_STRING);
|
$email = filter_var(urldecode($post['email']), FILTER_SANITIZE_STRING);
|
||||||
$title = filter_var(urldecode($post['title']), FILTER_SANITIZE_STRING);
|
$title = filter_var(urldecode($post['title']), FILTER_SANITIZE_STRING);
|
||||||
|
$site = filter_var(urldecode($post['site']), FILTER_SANITIZE_STRING);
|
||||||
|
|
||||||
if (isset($this->grav['user'])) {
|
if (isset($this->grav['user'])) {
|
||||||
$user = $this->grav['user'];
|
$user = $this->grav['user'];
|
||||||
|
@ -220,7 +244,8 @@ class CommentsPlugin extends Plugin
|
||||||
'text' => $text,
|
'text' => $text,
|
||||||
'date' => date('D, d M Y H:i:s', time()),
|
'date' => date('D, d M Y H:i:s', time()),
|
||||||
'author' => $name,
|
'author' => $name,
|
||||||
'email' => $email
|
'email' => $email,
|
||||||
|
'site' => $site
|
||||||
];
|
];
|
||||||
} else {
|
} else {
|
||||||
$data = array(
|
$data = array(
|
||||||
|
@ -230,7 +255,8 @@ class CommentsPlugin extends Plugin
|
||||||
'text' => $text,
|
'text' => $text,
|
||||||
'date' => date('D, d M Y H:i:s', time()),
|
'date' => date('D, d M Y H:i:s', time()),
|
||||||
'author' => $name,
|
'author' => $name,
|
||||||
'email' => $email
|
'email' => $email,
|
||||||
|
'site' => $site
|
||||||
])
|
])
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
@ -239,6 +265,7 @@ class CommentsPlugin extends Plugin
|
||||||
|
|
||||||
//clear cache
|
//clear cache
|
||||||
$this->grav['cache']->delete($this->comments_cache_id);
|
$this->grav['cache']->delete($this->comments_cache_id);
|
||||||
|
$this->grav['cache']->delete($this->pingbacks_cache_id);
|
||||||
|
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
@ -353,6 +380,26 @@ class CommentsPlugin extends Plugin
|
||||||
return $comments;
|
return $comments;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return the pingbacks associated to the current route
|
||||||
|
*/
|
||||||
|
private function fetchPingbacks() {
|
||||||
|
$cache = $this->grav['cache'];
|
||||||
|
//search in cache
|
||||||
|
if ($pingbacks = $cache->fetch($this->pingbacks_cache_id)) {
|
||||||
|
return $pingbacks;
|
||||||
|
}
|
||||||
|
|
||||||
|
$lang = $this->grav['language']->getLanguage();
|
||||||
|
$filename = $lang ? '/' . $lang : '';
|
||||||
|
$filename .= $this->grav['uri']->path() . '.yaml';
|
||||||
|
|
||||||
|
$pingbacks = $this->getDataFromFilename($filename)['pingbacks'];
|
||||||
|
//save to cache if enabled
|
||||||
|
$cache->save($this->pingbacks_cache_id, $pingbacks);
|
||||||
|
return $pingbacks;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return the latest commented pages
|
* Return the latest commented pages
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -1,4 +1,6 @@
|
||||||
enabled: true
|
enabled: true
|
||||||
|
pingbacks: true
|
||||||
|
commenting: true
|
||||||
|
|
||||||
enable_on_routes:
|
enable_on_routes:
|
||||||
- '/blog'
|
- '/blog'
|
||||||
|
@ -6,7 +8,6 @@ enable_on_routes:
|
||||||
disable_on_routes:
|
disable_on_routes:
|
||||||
- /blog/blog-post-to-ignore
|
- /blog/blog-post-to-ignore
|
||||||
- /ignore-this-route
|
- /ignore-this-route
|
||||||
#- '/blog/daring-fireball-link'
|
|
||||||
|
|
||||||
form:
|
form:
|
||||||
name: comments
|
name: comments
|
||||||
|
@ -26,6 +27,13 @@ form:
|
||||||
validate:
|
validate:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
|
- name: blah
|
||||||
|
label: PLUGIN_COMMENTS.EMAIL_LABEL
|
||||||
|
placeholder: "https://leetnightshade.com"
|
||||||
|
type: text
|
||||||
|
validate:
|
||||||
|
required: false
|
||||||
|
|
||||||
- name: text
|
- name: text
|
||||||
label: PLUGIN_COMMENTS.MESSAGE_LABEL
|
label: PLUGIN_COMMENTS.MESSAGE_LABEL
|
||||||
placeholder: PLUGIN_COMMENTS.MESSAGE_PLACEHOLDER
|
placeholder: PLUGIN_COMMENTS.MESSAGE_PLACEHOLDER
|
||||||
|
@ -50,6 +58,9 @@ form:
|
||||||
type: hidden
|
type: hidden
|
||||||
evaluateDefault: grav.uri.path
|
evaluateDefault: grav.uri.path
|
||||||
|
|
||||||
|
- name: blockme
|
||||||
|
type: honeypot
|
||||||
|
|
||||||
# - name: g-recaptcha-response
|
# - name: g-recaptcha-response
|
||||||
# label: Captcha
|
# label: Captcha
|
||||||
# type: captcha
|
# type: captcha
|
||||||
|
|
|
@ -0,0 +1,148 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
require_once 'vendor/Akismet.class.php';
|
||||||
|
|
||||||
|
class HabariAkismet extends Plugin
|
||||||
|
{
|
||||||
|
const SERVER_AKISMET = 'rest.akismet.com';
|
||||||
|
const SERVER_TYPEPAD = 'api.antispam.typepad.com';
|
||||||
|
|
||||||
|
public function action_plugin_activation($file)
|
||||||
|
{
|
||||||
|
if (realpath($file) == __FILE__) {
|
||||||
|
Session::notice(_t('Please set your Akismet or TypePad AntiSpam API Key in the configuration.'));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function filter_plugin_config($actions, $plugin_id)
|
||||||
|
{
|
||||||
|
if ($plugin_id == $this->plugin_id()) {
|
||||||
|
$actions[] = _t('Configure');
|
||||||
|
}
|
||||||
|
|
||||||
|
return $actions;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function action_plugin_ui($plugin_id, $action)
|
||||||
|
{
|
||||||
|
if ($plugin_id == $this->plugin_id()) {
|
||||||
|
switch ($action) {
|
||||||
|
case _t('Configure'):
|
||||||
|
|
||||||
|
$form = new FormUI(strtolower(get_class($this)));
|
||||||
|
$form->append('select', 'provider', 'habariakismet__provider', _t('Service'));
|
||||||
|
$form->provider->options = array(
|
||||||
|
'Akismet' => 'Akismet',
|
||||||
|
'TypePad AntiSpam' => 'TypePad AntiSpam'
|
||||||
|
);
|
||||||
|
$api_key = $form->append('text', 'api_key', 'habariakismet__api_key', _t('API Key'));
|
||||||
|
$api_key->add_validator('validate_required');
|
||||||
|
$api_key->add_validator(array($this, 'validate_api_key'));
|
||||||
|
$form->append('submit', 'save', 'Save');
|
||||||
|
$form->out();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function validate_api_key($key, $control, $form)
|
||||||
|
{
|
||||||
|
$endpoint = ($form->provider->value == 'Akismet') ? self::SERVER_AKISMET : self::SERVER_TYPEPAD;
|
||||||
|
|
||||||
|
$a = new Akismet(Site::get_url('habari'), $key);
|
||||||
|
$a->setAkismetServer($endpoint);
|
||||||
|
|
||||||
|
if (!$a->isKeyValid()) {
|
||||||
|
return array(sprintf(_t('Sorry, the %s API key %s is <b>invalid</b>. Please check to make sure the key is entered correctly.'), $form->provider->value, $key));
|
||||||
|
}
|
||||||
|
|
||||||
|
return array();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function set_priorities()
|
||||||
|
{
|
||||||
|
return array(
|
||||||
|
'action_comment_insert_before' => 1
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function action_comment_insert_before(Comment $comment)
|
||||||
|
{
|
||||||
|
$api_key = Options::get('habariakismet__api_key');
|
||||||
|
$provider = Options::get('habariakismet__provider');
|
||||||
|
|
||||||
|
if ($api_key == null || $provider == null) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$endpoint = ($provider == 'Akismet') ? self::SERVER_AKISMET : self::SERVER_TYPEPAD;
|
||||||
|
|
||||||
|
$a = new Akismet(Site::get_url('habari'), $api_key);
|
||||||
|
$a->setAkismetServer($endpoint);
|
||||||
|
$a->setCommentAuthor($comment->name);
|
||||||
|
$a->setCommentAuthorEmail($comment->email);
|
||||||
|
$a->setCommentAuthorURL($comment->url);
|
||||||
|
$a->setCommentContent($comment->content);
|
||||||
|
$a->setPermalink($comment->post->permalink);
|
||||||
|
|
||||||
|
try {
|
||||||
|
$comment->status = ($a->isCommentSpam()) ? 'spam' : 'ham';
|
||||||
|
return;
|
||||||
|
} catch (Exception $e) {
|
||||||
|
EventLog::log($e->getMessage(), 'notice', 'comment', 'HabariAkismet');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function action_admin_moderate_comments($action, $comments, $handler)
|
||||||
|
{
|
||||||
|
$false_negatives = 0;
|
||||||
|
$false_positives = 0;
|
||||||
|
|
||||||
|
$provider = Options::get('habariakismet__provider');
|
||||||
|
$endpoint = ($provider == 'Akismet') ? self::SERVER_AKISMET : self::SERVER_TYPEPAD;
|
||||||
|
|
||||||
|
$a = new Akismet(Site::get_url('habari'), Options::get('habariakismet__api_key'));
|
||||||
|
$a->setAkismetServer($endpoint);
|
||||||
|
|
||||||
|
foreach ($comments as $comment) {
|
||||||
|
switch ($action) {
|
||||||
|
case 'spam':
|
||||||
|
if ($comment->status == Comment::STATUS_APPROVED || $comment->status == Comment::STATUS_UNAPPROVED) {
|
||||||
|
$a->setCommentAuthor($comment->name);
|
||||||
|
$a->setCommentAuthorEmail($comment->email);
|
||||||
|
$a->setCommentAuthorURL($comment->url);
|
||||||
|
$a->setCommentContent($comment->content);
|
||||||
|
|
||||||
|
$a->submitSpam();
|
||||||
|
|
||||||
|
$false_negatives++;
|
||||||
|
}
|
||||||
|
|
||||||
|
break;
|
||||||
|
case 'approved':
|
||||||
|
if ($comment->status == Comment::STATUS_SPAM) {
|
||||||
|
$a->setCommentAuthor($comment->name);
|
||||||
|
$a->setCommentAuthorEmail($comment->email);
|
||||||
|
$a->setCommentAuthorURL($comment->url);
|
||||||
|
$a->setCommentContent($comment->content);
|
||||||
|
|
||||||
|
$a->submitHam();
|
||||||
|
|
||||||
|
$false_positives++;
|
||||||
|
}
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($false_negatives) {
|
||||||
|
Session::notice(_t('Reported %d false negatives to %s.', array($false_negatives, $provider)));
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($false_positives) {
|
||||||
|
Session::notice(_t('Reported %d false positives to %s.', array($false_positives, $provider)));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
?>
|
|
@ -0,0 +1,10 @@
|
||||||
|
<?xml version="1.0" encoding="utf-8" ?>
|
||||||
|
<pluggable type="plugin" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://schemas.habariproject.org/Pluggable-1.3.xsd">
|
||||||
|
<name>Habari Akismet</name>
|
||||||
|
<license url="http://www.apache.org/licenses/LICENSE-2.0.html">Apache Software License 2.0</license>
|
||||||
|
<url>http://habariproject.org</url>
|
||||||
|
<author url="http://habariproject.org/">The Habari Community</author>
|
||||||
|
<version>0.2</version>
|
||||||
|
<guid>98bdb03a-a7e5-4c2a-a875-dcfe1d89f130</guid>
|
||||||
|
<description><![CDATA[Provides the Akismet and TypePad AntiSpam spam filter webservices to Habari comments.]]></description>
|
||||||
|
</pluggable>
|
|
@ -0,0 +1,392 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Akismet anti-comment spam service
|
||||||
|
*
|
||||||
|
* The class in this package allows use of the {@link http://akismet.com Akismet} anti-comment spam service in any PHP5 application.
|
||||||
|
*
|
||||||
|
* This service performs a number of checks on submitted data and returns whether or not the data is likely to be spam.
|
||||||
|
*
|
||||||
|
* Please note that in order to use this class, you must have a vaild {@link http://wordpress.com/api-keys/ WordPress API key}. They are free for non/small-profit types and getting one will only take a couple of minutes.
|
||||||
|
*
|
||||||
|
* For commercial use, please {@link http://akismet.com/commercial/ visit the Akismet commercial licensing page}.
|
||||||
|
*
|
||||||
|
* Please be aware that this class is PHP5 only. Attempts to run it under PHP4 will most likely fail.
|
||||||
|
*
|
||||||
|
* See the Akismet class documentation page linked to below for usage information.
|
||||||
|
*
|
||||||
|
* @package akismet
|
||||||
|
* @author Alex Potsides, {@link http://www.achingbrain.net http://www.achingbrain.net}
|
||||||
|
* @version 0.4
|
||||||
|
* @copyright Alex Potsides, {@link http://www.achingbrain.net http://www.achingbrain.net}
|
||||||
|
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The Akismet PHP5 Class
|
||||||
|
*
|
||||||
|
* This class takes the functionality from the Akismet WordPress plugin written by {@link http://photomatt.net/ Matt Mullenweg} and allows it to be integrated into any PHP5 application or website.
|
||||||
|
*
|
||||||
|
* The original plugin is {@link http://akismet.com/download/ available on the Akismet website}.
|
||||||
|
*
|
||||||
|
* <b>Usage:</b>
|
||||||
|
* <code>
|
||||||
|
* $akismet = new Akismet('http://www.example.com/blog/', 'aoeu1aoue');
|
||||||
|
* $akismet->setCommentAuthor($name);
|
||||||
|
* $akismet->setCommentAuthorEmail($email);
|
||||||
|
* $akismet->setCommentAuthorURL($url);
|
||||||
|
* $akismet->setCommentContent($comment);
|
||||||
|
* $akismet->setPermalink('http://www.example.com/blog/alex/someurl/');
|
||||||
|
* if($akismet->isCommentSpam())
|
||||||
|
* // store the comment but mark it as spam (in case of a mis-diagnosis)
|
||||||
|
* else
|
||||||
|
* // store the comment normally
|
||||||
|
* </code>
|
||||||
|
*
|
||||||
|
* Optionally you may wish to check if your WordPress API key is valid as in the example below.
|
||||||
|
*
|
||||||
|
* <code>
|
||||||
|
* $akismet = new Akismet('http://www.example.com/blog/', 'aoeu1aoue');
|
||||||
|
*
|
||||||
|
* if($akismet->isKeyValid()) {
|
||||||
|
* // api key is okay
|
||||||
|
* } else {
|
||||||
|
* // api key is invalid
|
||||||
|
* }
|
||||||
|
* </code>
|
||||||
|
*
|
||||||
|
* @package akismet
|
||||||
|
* @name Akismet
|
||||||
|
* @version 0.4
|
||||||
|
* @author Alex Potsides
|
||||||
|
* @link http://www.achingbrain.net/
|
||||||
|
*/
|
||||||
|
class Akismet
|
||||||
|
{
|
||||||
|
private $version = '0.4';
|
||||||
|
private $wordPressAPIKey;
|
||||||
|
private $blogURL;
|
||||||
|
private $comment;
|
||||||
|
private $apiPort;
|
||||||
|
private $akismetServer;
|
||||||
|
private $akismetVersion;
|
||||||
|
|
||||||
|
// This prevents some potentially sensitive information from being sent accross the wire.
|
||||||
|
private $ignore = array('HTTP_COOKIE',
|
||||||
|
'HTTP_X_FORWARDED_FOR',
|
||||||
|
'HTTP_X_FORWARDED_HOST',
|
||||||
|
'HTTP_MAX_FORWARDS',
|
||||||
|
'HTTP_X_FORWARDED_SERVER',
|
||||||
|
'REDIRECT_STATUS',
|
||||||
|
'SERVER_PORT',
|
||||||
|
'PATH',
|
||||||
|
'DOCUMENT_ROOT',
|
||||||
|
'SERVER_ADMIN',
|
||||||
|
'QUERY_STRING',
|
||||||
|
'PHP_SELF' );
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $blogURL The URL of your blog.
|
||||||
|
* @param string $wordPressAPIKey WordPress API key.
|
||||||
|
*/
|
||||||
|
public function __construct($blogURL, $wordPressAPIKey) {
|
||||||
|
$this->blogURL = $blogURL;
|
||||||
|
$this->wordPressAPIKey = $wordPressAPIKey;
|
||||||
|
|
||||||
|
// Set some default values
|
||||||
|
$this->apiPort = 80;
|
||||||
|
$this->akismetServer = 'rest.akismet.com';
|
||||||
|
$this->akismetVersion = '1.1';
|
||||||
|
|
||||||
|
// Start to populate the comment data
|
||||||
|
$this->comment['blog'] = $blogURL;
|
||||||
|
$this->comment['user_agent'] = $_SERVER['HTTP_USER_AGENT'];
|
||||||
|
|
||||||
|
if(isset($_SERVER['HTTP_REFERER'])) {
|
||||||
|
$this->comment['referrer'] = $_SERVER['HTTP_REFERER'];
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This is necessary if the server PHP5 is running on has been set up to run PHP4 and
|
||||||
|
* PHP5 concurently and is actually running through a separate proxy al a these instructions:
|
||||||
|
* http://www.schlitt.info/applications/blog/archives/83_How_to_run_PHP4_and_PHP_5_parallel.html
|
||||||
|
* and http://wiki.coggeshall.org/37.html
|
||||||
|
* Otherwise the user_ip appears as the IP address of the PHP4 server passing the requests to the
|
||||||
|
* PHP5 one...
|
||||||
|
*/
|
||||||
|
$this->comment['user_ip'] = $_SERVER['REMOTE_ADDR'] != getenv('SERVER_ADDR') ? $_SERVER['REMOTE_ADDR'] : getenv('HTTP_X_FORWARDED_FOR');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Makes a request to the Akismet service to see if the API key passed to the constructor is valid.
|
||||||
|
*
|
||||||
|
* Use this method if you suspect your API key is invalid.
|
||||||
|
*
|
||||||
|
* @return bool True is if the key is valid, false if not.
|
||||||
|
*/
|
||||||
|
public function isKeyValid() {
|
||||||
|
// Check to see if the key is valid
|
||||||
|
$response = $this->sendRequest('key=' . $this->wordPressAPIKey . '&blog=' . $this->blogURL, $this->akismetServer, '/' . $this->akismetVersion . '/verify-key');
|
||||||
|
return $response[1] == 'valid';
|
||||||
|
}
|
||||||
|
|
||||||
|
// makes a request to the Akismet service
|
||||||
|
private function sendRequest($request, $host, $path) {
|
||||||
|
$http_request = "POST " . $path . " HTTP/1.0\r\n";
|
||||||
|
$http_request .= "Host: " . $host . "\r\n";
|
||||||
|
$http_request .= "Content-Type: application/x-www-form-urlencoded; charset=utf-8\r\n";
|
||||||
|
$http_request .= "Content-Length: " . strlen($request) . "\r\n";
|
||||||
|
$http_request .= "User-Agent: Akismet PHP5 Class " . $this->version . " | Akismet/1.11\r\n";
|
||||||
|
$http_request .= "\r\n";
|
||||||
|
$http_request .= $request;
|
||||||
|
|
||||||
|
$socketWriteRead = new SocketWriteRead($host, $this->apiPort, $http_request);
|
||||||
|
$socketWriteRead->send();
|
||||||
|
|
||||||
|
return explode("\r\n\r\n", $socketWriteRead->getResponse(), 2);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Formats the data for transmission
|
||||||
|
private function getQueryString() {
|
||||||
|
foreach($_SERVER as $key => $value) {
|
||||||
|
if(!in_array($key, $this->ignore)) {
|
||||||
|
if($key == 'REMOTE_ADDR') {
|
||||||
|
$this->comment[$key] = $this->comment['user_ip'];
|
||||||
|
} else {
|
||||||
|
$this->comment[$key] = $value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$query_string = '';
|
||||||
|
|
||||||
|
foreach($this->comment as $key => $data) {
|
||||||
|
if(!is_array($data)) {
|
||||||
|
$query_string .= $key . '=' . urlencode(stripslashes($data)) . '&';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $query_string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Tests for spam.
|
||||||
|
*
|
||||||
|
* Uses the web service provided by {@link http://www.akismet.com Akismet} to see whether or not the submitted comment is spam. Returns a boolean value.
|
||||||
|
*
|
||||||
|
* @return bool True if the comment is spam, false if not
|
||||||
|
* @throws Will throw an exception if the API key passed to the constructor is invalid.
|
||||||
|
*/
|
||||||
|
public function isCommentSpam() {
|
||||||
|
$response = $this->sendRequest($this->getQueryString(), $this->wordPressAPIKey . '.' . $this->akismetServer, '/' . $this->akismetVersion . '/comment-check');
|
||||||
|
|
||||||
|
if($response[1] == 'invalid' && !$this->isKeyValid()) {
|
||||||
|
throw new exception('The Wordpress API key passed to the Akismet constructor is invalid. Please obtain a valid one from http://wordpress.com/api-keys/');
|
||||||
|
}
|
||||||
|
|
||||||
|
return ($response[1] == 'true');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Submit spam that is incorrectly tagged as ham.
|
||||||
|
*
|
||||||
|
* Using this function will make you a good citizen as it helps Akismet to learn from its mistakes. This will improve the service for everybody.
|
||||||
|
*/
|
||||||
|
public function submitSpam() {
|
||||||
|
$this->sendRequest($this->getQueryString(), $this->wordPressAPIKey . '.' . $this->akismetServer, '/' . $this->akismetVersion . '/submit-spam');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Submit ham that is incorrectly tagged as spam.
|
||||||
|
*
|
||||||
|
* Using this function will make you a good citizen as it helps Akismet to learn from its mistakes. This will improve the service for everybody.
|
||||||
|
*/
|
||||||
|
public function submitHam() {
|
||||||
|
$this->sendRequest($this->getQueryString(), $this->wordPressAPIKey . '.' . $this->akismetServer, '/' . $this->akismetVersion . '/submit-ham');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* To override the user IP address when submitting spam/ham later on
|
||||||
|
*
|
||||||
|
* @param string $userip An IP address. Optional.
|
||||||
|
*/
|
||||||
|
public function setUserIP($userip) {
|
||||||
|
$this->comment['user_ip'] = $userip;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* To override the referring page when submitting spam/ham later on
|
||||||
|
*
|
||||||
|
* @param string $referrer The referring page. Optional.
|
||||||
|
*/
|
||||||
|
public function setReferrer($referrer) {
|
||||||
|
$this->comment['referrer'] = $referrer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A permanent URL referencing the blog post the comment was submitted to.
|
||||||
|
*
|
||||||
|
* @param string $permalink The URL. Optional.
|
||||||
|
*/
|
||||||
|
public function setPermalink($permalink) {
|
||||||
|
$this->comment['permalink'] = $permalink;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The type of comment being submitted.
|
||||||
|
*
|
||||||
|
* May be blank, comment, trackback, pingback, or a made up value like "registration" or "wiki".
|
||||||
|
*/
|
||||||
|
public function setCommentType($commentType) {
|
||||||
|
$this->comment['comment_type'] = $commentType;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The name that the author submitted with the comment.
|
||||||
|
*/
|
||||||
|
public function setCommentAuthor($commentAuthor) {
|
||||||
|
$this->comment['comment_author'] = $commentAuthor;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The email address that the author submitted with the comment.
|
||||||
|
*
|
||||||
|
* The address is assumed to be valid.
|
||||||
|
*/
|
||||||
|
public function setCommentAuthorEmail($authorEmail) {
|
||||||
|
$this->comment['comment_author_email'] = $authorEmail;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The URL that the author submitted with the comment.
|
||||||
|
*/
|
||||||
|
public function setCommentAuthorURL($authorURL) {
|
||||||
|
$this->comment['comment_author_url'] = $authorURL;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The comment's body text.
|
||||||
|
*/
|
||||||
|
public function setCommentContent($commentBody) {
|
||||||
|
$this->comment['comment_content'] = $commentBody;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Defaults to 80
|
||||||
|
*/
|
||||||
|
public function setAPIPort($apiPort) {
|
||||||
|
$this->apiPort = $apiPort;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Defaults to rest.akismet.com
|
||||||
|
*/
|
||||||
|
public function setAkismetServer($akismetServer) {
|
||||||
|
$this->akismetServer = $akismetServer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Defaults to '1.1'
|
||||||
|
*/
|
||||||
|
public function setAkismetVersion($akismetVersion) {
|
||||||
|
$this->akismetVersion = $akismetVersion;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Utility class used by Akismet
|
||||||
|
*
|
||||||
|
* This class is used by Akismet to do the actual sending and receiving of data. It opens a connection to a remote host, sends some data and the reads the response and makes it available to the calling program.
|
||||||
|
*
|
||||||
|
* The code that makes up this class originates in the Akismet WordPress plugin, which is {@link http://akismet.com/download/ available on the Akismet website}.
|
||||||
|
*
|
||||||
|
* N.B. It is not necessary to call this class directly to use the Akismet class. This is included here mainly out of a sense of completeness.
|
||||||
|
*
|
||||||
|
* @package akismet
|
||||||
|
* @name SocketWriteRead
|
||||||
|
* @version 0.1
|
||||||
|
* @author Alex Potsides
|
||||||
|
* @link http://www.achingbrain.net/
|
||||||
|
*/
|
||||||
|
class SocketWriteRead {
|
||||||
|
private $host;
|
||||||
|
private $port;
|
||||||
|
private $request;
|
||||||
|
private $response;
|
||||||
|
private $responseLength;
|
||||||
|
private $errorNumber;
|
||||||
|
private $errorString;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $host The host to send/receive data.
|
||||||
|
* @param int $port The port on the remote host.
|
||||||
|
* @param string $request The data to send.
|
||||||
|
* @param int $responseLength The amount of data to read. Defaults to 1160 bytes.
|
||||||
|
*/
|
||||||
|
public function __construct($host, $port, $request, $responseLength = 1160) {
|
||||||
|
$this->host = $host;
|
||||||
|
$this->port = $port;
|
||||||
|
$this->request = $request;
|
||||||
|
$this->responseLength = $responseLength;
|
||||||
|
$this->errorNumber = 0;
|
||||||
|
$this->errorString = '';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sends the data to the remote host.
|
||||||
|
*
|
||||||
|
* @throws An exception is thrown if a connection cannot be made to the remote host.
|
||||||
|
*/
|
||||||
|
public function send() {
|
||||||
|
$this->response = '';
|
||||||
|
|
||||||
|
$fs = fsockopen($this->host, $this->port, $this->errorNumber, $this->errorString, 3);
|
||||||
|
|
||||||
|
if($this->errorNumber != 0) {
|
||||||
|
throw new Exception('Error connecting to host: ' . $this->host . ' Error number: ' . $this->errorNumber . ' Error message: ' . $this->errorString);
|
||||||
|
}
|
||||||
|
|
||||||
|
if($fs !== false) {
|
||||||
|
@fwrite($fs, $this->request);
|
||||||
|
|
||||||
|
while(!feof($fs)) {
|
||||||
|
$this->response .= fgets($fs, $this->responseLength);
|
||||||
|
}
|
||||||
|
|
||||||
|
fclose($fs);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the server response text
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getResponse() {
|
||||||
|
return $this->response;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the error number
|
||||||
|
*
|
||||||
|
* If there was no error, 0 will be returned.
|
||||||
|
*
|
||||||
|
* @return int
|
||||||
|
*/
|
||||||
|
public function getErrorNumner() {
|
||||||
|
return $this->errorNumber;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the error string
|
||||||
|
*
|
||||||
|
* If there was no error, an empty string will be returned.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getErrorString() {
|
||||||
|
return $this->errorString;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
?>
|
|
@ -24,6 +24,8 @@ en:
|
||||||
PLUGIN_COMMENTS:
|
PLUGIN_COMMENTS:
|
||||||
ADD_COMMENT: Add a comment
|
ADD_COMMENT: Add a comment
|
||||||
COMMENTS: Comments
|
COMMENTS: Comments
|
||||||
|
COMMENTS_NONE: There are no comments yet.
|
||||||
|
COMMENTS_PINGBACKS: Pingbacks
|
||||||
EMAIL_NOT_CONFIGURED: Email not configured
|
EMAIL_NOT_CONFIGURED: Email not configured
|
||||||
NEW_COMMENT_EMAIL_SUBJECT: 'New comment on %1$s'
|
NEW_COMMENT_EMAIL_SUBJECT: 'New comment on %1$s'
|
||||||
NEW_COMMENT_EMAIL_BODY: '<p>A new comment was made on %1$s by %3$s (%4$s).</p><p>Page: %2$s</p><p>Text: %5$s</p>'
|
NEW_COMMENT_EMAIL_BODY: '<p>A new comment was made on %1$s by %3$s (%4$s).</p><p>Page: %2$s</p><p>Text: %5$s</p>'
|
||||||
|
|
|
@ -1,6 +1,42 @@
|
||||||
{% if grav.twig.enable_comments_plugin %}
|
{% if grav.twig.enable_comments_plugin %}
|
||||||
{% set scope = scope ?: 'data.' %}
|
{% set scope = scope ?: 'data.' %}
|
||||||
|
|
||||||
|
{% if grav.twig.pingbacks_enabled %}
|
||||||
|
{% if grav.twig.pingbacks|length %}
|
||||||
|
{% set comments_visible = false %}
|
||||||
|
{% for pingback in grav.twig.pingbacks %}
|
||||||
|
{% if pingback.approved == "true" %}
|
||||||
|
{% set comments_visible = true %}
|
||||||
|
{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
|
||||||
|
{% if comments_visible %}
|
||||||
|
<h3>{{'PLUGIN_COMMENTS.COMMENTS_PINGBACKS'|t}}</h3>
|
||||||
|
|
||||||
|
<table>
|
||||||
|
{% for pingback in grav.twig.pingbacks %}
|
||||||
|
{% if pingback.approved == "true" %}
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
{{pingback.text}}
|
||||||
|
<br />
|
||||||
|
{{'PLUGIN_COMMENTS.WRITTEN_ON'|t}} {{pingback.date|e}} {{'PLUGIN_COMMENTS.BY'|t}}
|
||||||
|
{% if pingback.site %}
|
||||||
|
<a href="{{pingback.site}}">{{pingback.author}}</a>
|
||||||
|
{% else %}
|
||||||
|
{{pingback.author}}
|
||||||
|
{% endif %}
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
</table
|
||||||
|
{% endif %}
|
||||||
|
</table>
|
||||||
|
{% endif %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if grav.twig.commenting_enabled %}
|
||||||
<h3>{{'PLUGIN_COMMENTS.ADD_COMMENT'|t}}</h3>
|
<h3>{{'PLUGIN_COMMENTS.ADD_COMMENT'|t}}</h3>
|
||||||
|
|
||||||
<form name="{{ grav.config.plugins.comments.form.name }}"
|
<form name="{{ grav.config.plugins.comments.form.name }}"
|
||||||
|
@ -40,21 +76,39 @@
|
||||||
</form>
|
</form>
|
||||||
|
|
||||||
<div class="alert">{{ form.message }}</div>
|
<div class="alert">{{ form.message }}</div>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
{% if grav.twig.comments|length %}
|
{% if grav.twig.comments|length %}
|
||||||
|
|
||||||
<h3>{{'PLUGIN_COMMENTS.COMMENTS'|t}}</h3>
|
<h3>{{'PLUGIN_COMMENTS.COMMENTS'|t}}</h3>
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
{% for comment in grav.twig.comments|array_reverse %}
|
{% set comments_visible = false %}
|
||||||
|
{% for comment in grav.twig.comments %}
|
||||||
|
{% if comment.approved == "true" %}
|
||||||
|
{% set comments_visible = true %}
|
||||||
<tr>
|
<tr>
|
||||||
<td>
|
<td>
|
||||||
{{comment.text}}
|
{{comment.text}}
|
||||||
<br />
|
<br />
|
||||||
{{'PLUGIN_COMMENTS.WRITTEN_ON'|t}} {{comment.date|e}} {{'PLUGIN_COMMENTS.BY'|t}} {{comment.author}}
|
{{'PLUGIN_COMMENTS.WRITTEN_ON'|t}} {{comment.date|e}} {{'PLUGIN_COMMENTS.BY'|t}}
|
||||||
|
{% if comment.site %}
|
||||||
|
<a href="{{comment.site}}">{{comment.author}}</a>
|
||||||
|
{% else %}
|
||||||
|
{{comment.author}}
|
||||||
|
{% endif %}
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
{% endif %}
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
|
|
||||||
|
{% if not comments_visible %}
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
{{'PLUGIN_COMMENTS.COMMENTS_NONE'|t}}
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
{% endif %}
|
||||||
</table>
|
</table>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
Loading…
Reference in New Issue