'Comments',
'summary' => 'Manage comments in your site outside of the page editor.',
'version' => 6,
'author' => 'Ryan Cramer',
'icon' => 'comments',
'requires' => 'FieldtypeComments',
'permission' => 'comments-manager',
'permissions' => array(
'comments-manager' => 'Use the comments manager',
),
'page' => array(
'name' => 'comments',
'parent' => 'setup',
'title' => 'Comments',
),
'nav' => array(
array(
'url' => '?go=approved',
'label' => __('Approved', __FILE__),
),
array(
'url' => '?go=pending',
'label' => __('Pending', __FILE__),
),
array(
'url' => '?go=spam',
'label' => __('Spam', __FILE__),
),
array(
'url' => '?go=all',
'label' => __('All', __FILE__),
)
)
);
}
/**
* Statuses and names that a Comment can have
*
*/
protected $statuses = array();
/**
* Translated statuses
*
*/
protected $statusTranslations = array();
/**
* Number of comments to show per page
*
*/
protected $limit = 10;
/**
* Headline for masthead
*
*/
protected $headline = '';
/**
* Initialize the comments manager and define the statuses
*
*/
public function init() {
$this->wire('modules')->get('FieldtypeComments');
parent::init();
$this->statuses = array(
Comment::statusApproved => 'approved',
Comment::statusPending => 'pending',
Comment::statusSpam => 'spam',
Comment::statusDelete => 'delete'
);
$this->statusTranslations = array(
Comment::statusApproved => $this->_('Approved'),
Comment::statusPending => $this->_('Pending'),
Comment::statusSpam => $this->_('Spam'),
Comment::statusDelete => $this->_('Delete')
);
}
/**
* Ask the user to select which comments field they want to manage
*
* Or, redirect to the comments field if there is only 1.
*
* @return string
*
*/
public function ___execute() {
$this->checkInstall();
// locate all the FieldtypeComments fields
$fields = array();
foreach($this->fields as $field) {
if($field->type instanceof FieldtypeComments) $fields[] = $field;
}
$count = count($fields);
if(!$count) {
$error = $this->_('There are no comments fields installed');
$this->error($error);
return "$error
";
}
$go = $this->wire('sanitizer')->pageName($this->wire('input')->get('go'));
if($count == 1 || $go) {
$field = reset($fields);
$to = 'all';
if($go && in_array($go, $this->statuses)) $to = $go;
$this->wire('session')->redirect("./list/$field->name/$to/");
return '';
}
$out = "" . $this->_('Please select a comments field') . "
";
return $out;
}
/**
* Execute the comments list
*
* @return string
*
*/
public function ___executeList() {
if(wireClassExists("CommentStars")) {
$cssFile = $this->wire('config')->urls->FieldtypeComments . 'comments.css';
$jsFile = $this->wire('config')->urls->FieldtypeComments . 'comments.js';
$this->wire('config')->styles->add($cssFile);
$this->wire('config')->scripts->add($jsFile);
CommentStars::setDefault('star', "");
}
$session = $this->wire('session');
$name = $this->sanitizer->fieldName($this->input->urlSegment2);
if(!$name) return $this->error($this->_('No comments field specified in URL'));
$field = $this->fields->get($name);
if(!$field || !$field->type instanceof FieldtypeComments) return $this->error($this->_('Unrecognized field'));
$status = $this->input->urlSegment3;
if(empty($status) || ($status != 'all' && !in_array($status, $this->statuses))) {
$session->redirect($this->wire('page')->url . "list/$field->name/all/");
}
$headline = ucfirst($status);
$this->breadcrumb('../', $field->getLabel());
$limit = (int) $this->wire('input')->get('limit');
if($limit) {
$session->setFor($this, 'limit', $limit);
$session->redirect('./');
} else {
$limit = (int) $session->getFor($this, 'limit');
if(!$limit) $limit = (int) $this->limit;
}
$sort = $this->wire('sanitizer')->name($this->wire('input')->get('sort'));
if($sort) {
$session->setFor($this, 'sort', $sort);
$session->redirect('./');
} else {
$sort = $session->getFor($this, 'sort');
if(!$sort) $sort = '-created';
}
$start = ($this->input->pageNum-1) * $limit;
$selector = "start=$start, limit=$limit, sort=$sort";
$filterOut = '';
$filterLabels = array(
'id' => $this->_('ID'),
'parent_id' => $this->_('Replies to'),
);
if($status != 'all') {
$selector .= ", status=" . array_search($status, $this->statuses);
}
foreach(array('cite', 'email', 'ip', 'id', 'parent_id') as $key) {
$value = $this->input->get->$key;
if(is_null($value)) continue;
if($key == 'id' || $key == 'parent_id') $value = (int) $value;
$this->input->whitelist($key, $this->sanitizer->text($value));
$value = $this->sanitizer->selectorValue($value);
$selector .= ", $key=$value";
//$this->message(ucfirst($key) . ": " . htmlentities($value, ENT_QUOTES, "UTF-8") . " (" . $this->_('remove filter') . ")", Notice::allowMarkup);
$filterLabel = isset($filterLabels[$key]) ? $filterLabels[$key] : ucfirst($key);
$filterOut .= $this->wire('sanitizer')->entities(", $filterLabel: $value");
}
/** @var FieldtypeComments $fieldtype */
$fieldtype = $field->type;
$comments = $fieldtype->find($field, $selector);
if($this->wire('input')->post('processComments')) $this->processComments($comments, $field);
if($filterOut) {
$this->breadcrumb('./', $headline);
$headline = trim($filterOut, ", ");
}
$this->headline = $headline;
return $this->renderComments($comments);
}
/**
* Process changes to posted comments
*
* @param CommentArray $comments
* @param Field $field
*
*/
protected function processComments(CommentArray $comments, Field $field) {
$numDeleted = 0;
$numChanged = 0;
foreach($comments as $comment) {
$properties = array();
$text = $this->input->post("CommentText{$comment->id}");
if(!is_null($text) && $text != $comment->text) {
$comment->text = $text; // cleans it
$properties['text'] = $comment->text;
$numChanged++;
}
if($field->useVotes) {
foreach(array("upvotes", "downvotes") as $name) {
$votes = (int) $this->input->post("Comment" . ucfirst($name) . $comment->id);
if($votes != $comment->$name) {
$comment->set($name, $votes);
$properties[$name] = $comment->$name;
$numChanged++;
}
}
}
if($field->useStars) {
$stars = (int) $this->input->post("CommentStars$comment->id");
if($stars != $comment->stars) {
$comment->set('stars', $stars);
$properties['stars'] = $comment->stars;
$numChanged++;
}
}
$_status = $this->input->post("CommentStatus{$comment->id}");
$status = (int) $_status;
if($status === Comment::statusDelete) {
if($field->type->deleteComment($comment->getPage(), $field, $comment)) {
$this->message(sprintf($this->_('Deleted comment #%d'), $comment->id));
$numDeleted++;
}
continue;
}
if($_status !== null && $status !== (int) $comment->status && array_key_exists($status, $this->statuses)) {
$comment->status = $status;
$numChanged++;
$properties['status'] = $comment->status;
}
if(count($properties)) {
$field->type->updateComment($comment->getPage(), $field, $comment, $properties);
$this->message(sprintf($this->_('Updated comment #%d'), $comment->id) . " (" . implode(', ', array_keys($properties)) . ")");
}
}
if($numDeleted || $numChanged) {
$pageNum = $this->input->pageNum > 1 ? 'page' . $this->input->pageNum : '';
$this->session->redirect('./' . $pageNum . $this->getQueryString());
}
}
/**
* Render the markup for a single comment
*
* @param Comment $comment
* @return string
*
*/
protected function renderComment(Comment $comment) {
$type = '';
$numChildren = 0;
if($comment->getField()->depth > 0) {
$children = $comment->children();
$numChildren = count($children);
}
foreach($this->statusTranslations as $status => $label) {
$checked = $comment->status == $status ? " checked='checked'" : '';
if($status == Comment::statusDelete && $numChildren) continue;
$type .=
" ";
}
$cite = htmlentities($comment->cite, ENT_QUOTES, "UTF-8");
$email = htmlentities($comment->email, ENT_QUOTES, "UTF-8");
$website = htmlentities($comment->website, ENT_QUOTES, "UTF-8");
$ip = htmlentities($comment->ip, ENT_QUOTES, "UTF-8");
$date = wireDate($this->_('Y/m/d g:i a'), $comment->created) . " "; // comment date format
$date .= "" . wireDate('relative', $comment->created) . "";
$text = htmlentities($comment->get('text'), ENT_QUOTES, "UTF-8");
$text = str_replace('\r', ' ', $text);
$text = preg_replace('/\r?(\n)/', '\r', $text);
$text = str_replace('\r\r', "
\n
\n", $text);
$text = str_replace('\r', "
\n", $text);
$page = $comment->getPage();
if($page->editable()) {
$text =
"";
}
$out =
"";
$parentOut = '';
$parent = $comment->parent();
if($parent) {
$parentLink = $this->wire('sanitizer')->entities($parent->cite) . " #$parent->id";
$parentOut =
"";
}
$childrenOut = '';
if($numChildren) {
$childrenLink = " " .
sprintf($this->_n('%d reply', '%d replies', $numChildren), $numChildren) . "";
$childrenOut = "";
}
$out =
"";
$page->of(false);
return $out;
}
/**
* Render the comments list header
*
* @param int $limit
* @param bool $useVotes
* @param bool $useStars
* @return string
*
*/
protected function renderCommentsHeader($limit, $useVotes, $useStars) {
$setStatusLabel = $this->_('Set status:');
$perPageLabel = $this->_('per page');
$pagerLimitOut = "
";
$pagerLimitOut = str_replace("