comment_resource.inc in Services 6.3
Same filename and directory in other branches
Will define the comments resource for dealing with node comments
File
resources/comment_resource.incView source
<?php
/**
* @file
* Will define the comments resource for dealing with node comments
*/
function _comment_resource_definition() {
if (!module_exists('comment')) {
return array();
}
return array(
'comment' => array(
'operations' => array(
'create' => array(
'help' => 'Creates a comment',
'file' => array(
'type' => 'inc',
'module' => 'services',
'name' => 'resources/comment_resource',
),
'callback' => '_comment_resource_create',
'access callback' => '_comment_resource_access',
'access arguments' => array(
'create',
),
'access arguments append' => TRUE,
'args' => array(
array(
'name' => 'comment',
'type' => 'array',
'description' => 'The comment object',
'source' => 'data',
'optional' => FALSE,
),
),
),
'retrieve' => array(
'help' => 'Retrieves a comment',
'file' => array(
'type' => 'inc',
'module' => 'services',
'name' => 'resources/comment_resource',
),
'callback' => '_comment_resource_retrieve',
'access callback' => '_comment_resource_access',
'access arguments' => array(
'view',
),
'access arguments append' => TRUE,
'args' => array(
array(
'name' => 'cid',
'type' => 'int',
'description' => 'The cid of the comment to retrieve.',
'source' => array(
'path' => '0',
),
'optional' => FALSE,
),
),
),
'update' => array(
'help' => 'Updates a comment',
'file' => array(
'type' => 'inc',
'module' => 'services',
'name' => 'resources/comment_resource',
),
'callback' => '_comment_resource_update',
'access callback' => '_comment_resource_access',
'access arguments' => array(
'edit',
),
'access arguments append' => TRUE,
'args' => array(
array(
'name' => 'cid',
'optional' => FALSE,
'source' => array(
'path' => 0,
),
'type' => 'int',
'description' => 'The unique identifier for this comment.',
),
array(
'name' => 'data',
'type' => 'array',
'description' => 'The comment array with updated information',
'source' => 'data',
'optional' => FALSE,
),
),
),
'delete' => array(
'help' => 'Deletes a comment',
'file' => array(
'type' => 'inc',
'module' => 'services',
'name' => 'resources/comment_resource',
),
'callback' => '_comment_resource_delete',
'access callback' => '_comment_resource_access',
'access arguments' => array(
'edit',
),
'access arguments append' => TRUE,
'args' => array(
array(
'name' => 'cid',
'type' => 'int',
'description' => 'The id of the comment to delete',
'source' => array(
'path' => '0',
),
'optional' => FALSE,
),
),
),
'index' => array(
'file' => array(
'type' => 'inc',
'module' => 'services',
'name' => 'resources/comment_resource',
),
'callback' => '_comment_resource_index',
'args' => array(
array(
'name' => 'page',
'optional' => TRUE,
'type' => 'int',
'description' => 'The zero-based index of the page to get, defaults to 0.',
'default value' => 0,
'source' => array(
'param' => 'page',
),
),
array(
'name' => 'fields',
'optional' => TRUE,
'type' => 'string',
'description' => 'The fields to get.',
'default value' => '*',
'source' => array(
'param' => 'fields',
),
),
array(
'name' => 'parameters',
'optional' => TRUE,
'type' => 'array',
'description' => 'Parameters',
'default value' => array(),
'source' => array(
'param' => 'parameters',
),
),
array(
'name' => 'pagesize',
'optional' => TRUE,
'type' => 'int',
'description' => 'Number of records to get per page.',
'default value' => variable_get('services_comment_index_page_size', 20),
'source' => array(
'param' => 'pagesize',
),
),
),
'access callback' => '_comment_resource_access',
'access arguments' => array(
'view',
),
'access arguments append' => TRUE,
),
),
'actions' => array(
'countAll' => array(
'file' => array(
'type' => 'inc',
'module' => 'services',
'name' => 'resources/comment_resource',
),
'help' => t('This method returns the number of comments on a given node.'),
'access callback' => '_comment_resource_access',
'access arguments' => array(
'view',
),
'callback' => '_comment_resource_count_all',
'args' => array(
array(
'name' => 'nid',
'type' => 'int',
'description' => t('The node id to count all comments.'),
'source' => array(
'data' => 'nid',
),
'optional' => FALSE,
),
),
),
'countNew' => array(
'file' => array(
'type' => 'inc',
'module' => 'services',
'name' => 'resources/comment_resource',
),
'help' => t('This method returns the number of new comments on a given node since a given timestamp.'),
'access callback' => '_comment_resource_access',
'access arguments' => array(
'view',
),
'callback' => '_comment_resource_count_new',
'args' => array(
array(
'name' => 'nid',
'type' => 'int',
'description' => t('The node id to load comments for.'),
'source' => array(
'data' => 'nid',
),
'optional' => FALSE,
),
array(
'name' => 'since',
'type' => 'int',
'optional' => TRUE,
'description' => t('Timestamp to count from (defaults to time of last user acces to node).'),
'source' => array(
'data' => 'since',
),
'optional' => TRUE,
'default value' => 0,
),
),
),
),
),
);
}
/**
* Return an array of optionally paged cids baed on a set of criteria.
*
* An example request might look like
*
* http://domain/endpoint/comment?fields=cid,nid¶meters[nid]=7¶meters[uid]=2
*
* This would return an array of objects with only cid and nid defined, where
* nid = 7 and uid = 1.
*
* @param $page
* Page number of results to return (in pages of 20).
* @param $fields
* The fields you want returned.
* @param $parameters
* An array containing fields and values used to build a sql WHERE clause
* indicating items to retrieve.
* @param $page_size
* Integer number of items to be returned.
* @return
* An array of comment objects.
*
* @see _node_resource_index()
*/
function _comment_resource_index($page, $fields, $parameters, $page_size) {
// Limit to published nodes if user doesn't have 'administer nodes'
// permissions.
if (!user_access('administer comments')) {
$parameters['status'] = COMMENT_PUBLISHED;
}
$query = services_resource_build_index_query('comments', 'c.timestamp DESC', $page, $fields, $parameters, 'c', 'cid', $page_size, 'comment');
// Put together array of matching nodes to return.
$results = array();
while ($comments = db_fetch_object($query)) {
$results[] = $comments;
}
return services_resource_build_index_list($results, 'comments', 'cid');
}
/**
* Adds a new comment to a node and returns the cid.
*
* @param $comment
* An object as would be returned from comment_load().
* @return
* Unique identifier for the comment (cid) or errors if there was a problem.
*/
function _comment_resource_create($comment) {
// Adds backwards compatability with regression fixed in #1083242
$comment = _services_arg_value($comment, 'comment');
if (empty($comment['nid'])) {
return services_error(t('A nid must be provided'));
}
// Setup form_state
$form_state = array();
$form_state['values'] = $comment;
$form_state['values']['op'] = variable_get('services_comment_save_button_resource_create', t('Save'));
$comment_empty = array(
'nid' => $comment['nid'],
'cid' => NULL,
);
if (!empty($comment['pid'])) {
$comment_empty['pid'] = $comment['pid'];
}
$ret = drupal_execute('comment_form', $form_state, $comment_empty);
if ($errors = form_get_errors()) {
return services_error(implode(" ", $errors), 406, array(
'form_errors' => $errors,
));
}
// Load latest created comment.
$recent_comments = comment_get_recent(1);
$cid = $recent_comments[0]->cid;
return array(
'cid' => $cid,
'uri' => services_resource_uri(array(
'comment',
$cid,
)),
);
}
/**
* Returns a specified comment
*
* @param $cid
* Unique identifier for the specified comment
* @return
* The comment object
*/
function _comment_resource_retrieve($cid) {
return _comment_load($cid);
}
/**
* Updates a comment and returns the cid.
*
* @param $cid
* Unique identifier for this comment.
* @param $comment
* An object as would be returned from comment_load().
* @return
* Unique identifier for the comment (cid) or FALSE if there was a problem.
*/
function _comment_resource_update($cid, $comment) {
// Adds backwards compatability with regression fixed in #1083242
$comment = _services_arg_value($comment, 'data');
$comment['cid'] = $cid;
$old_comment = (array) _comment_load($cid);
if (empty($old_comment)) {
return services_error(t('Comment @cid not found', array(
'@cid' => $comment['cid'],
)), 404);
}
// Setup form_state.
$form_state = array();
$form_state['values'] = $comment;
$form_state['values']['op'] = variable_get('services_comment_save_button_resource_update', t('Save'));
$form_state['comment'] = $old_comment;
drupal_execute('comment_form', $form_state, $old_comment);
if ($errors = form_get_errors()) {
return services_error(implode(" ", $errors), 406, array(
'form_errors' => $errors,
));
}
return $cid;
}
/**
* Delete a comment.
*
* @param $cid
* Unique identifier of the comment to delete.
* @return
* True.
*/
function _comment_resource_delete($cid) {
// Load in the required includes for comment_delete.
module_load_include('inc', 'comment', 'comment.admin');
// The following is from comment_confirm_delete_submit in comment.admin.inc
$comment = _comment_load($cid);
if (empty($comment)) {
return services_error(t('There is no comment found with id @cid', array(
'@cid' => $cid,
)), 404);
}
// Delete comment and its replies.
_comment_delete_thread($comment);
_comment_update_node_statistics($comment->nid);
// Clear the cache so an anonymous user sees that his comment was deleted.
cache_clear_all();
return TRUE;
}
/**
* Returns the number of comments on a given node id.
*
* @param $nid
* Unique identifier for the specified node.
* @return
* Number of comments that node has.
*/
function _comment_resource_count_all($nid) {
return comment_num_all($nid);
}
/**
* Returns the number of new comments on a given node id since timestamp.
*
* @param $nid
* Unique identifier for the specified node.
* @param $since
* Timestamp to indicate what nodes are new. Defaults to time of last user acces to node.
* @return
* Number of comments that node has.
*/
function _comment_resource_count_new($nid, $since = 0) {
return comment_num_new($nid, $since);
}
/**
* Access check callback for comment controllers.
*/
function _comment_resource_access($op = 'view', $args = array()) {
// Add backwards compatability with regression fixed in #1083242
$args = _services_access_value($args, array(
'comment',
'data',
));
if ($op == 'view' && !isset($args[0])) {
return user_access('access comments');
}
if ($op == 'create') {
$comment = (object) $args[0];
}
else {
$comment = _comment_load($args[0]);
}
// If the submitted comment does not contain a nid, then return an error.
if (isset($comment->nid)) {
$node = node_load($comment->nid);
if ($op == 'create' && !$node->nid) {
return services_error(t('Node nid: @nid does not exist.', array(
'@nid' => $comment->nid,
)), 406);
}
}
if (user_access('administer comments')) {
return TRUE;
}
switch ($op) {
case 'view':
// Check if the user has access to comments
// and that the node has comments enabled.
return $comment->status == COMMENT_PUBLISHED && user_access('access comments');
case 'edit':
case 'delete':
// Check if the user may edit the comment, and has access to the input format
return comment_access('edit', $comment);
case 'create':
// Check if the user may post comments, and has access to the used format and
// check if the node has comments enabled, and that the user has access to the node
return user_access('post comments');
}
}Functions
Name |
Description |
|---|---|
| _comment_resource_access | Access check callback for comment controllers. |
| _comment_resource_count_all | Returns the number of comments on a given node id. |
| _comment_resource_count_new | Returns the number of new comments on a given node id since timestamp. |
| _comment_resource_create | Adds a new comment to a node and returns the cid. |
| _comment_resource_definition | @file Will define the comments resource for dealing with node comments |
| _comment_resource_delete | Delete a comment. |
| _comment_resource_index | Return an array of optionally paged cids baed on a set of criteria. |
| _comment_resource_retrieve | Returns a specified comment |
| _comment_resource_update | Updates a comment and returns the cid. |