logIO("I", $HTTP_RAW_POST_DATA);
/**
- * @internal
- * Left undocumented to work on later. If you want to finish, then please do so.
+ * WordPress XMLRPC server implementation.
+ *
+ * Implements compatability for Blogger API, MetaWeblog API, MovableType, and
+ * pingback. Additional WordPress API for managing comments, pages, posts,
+ * options, etc.
+ *
+ * Since WordPress 2.6.0, WordPress XMLRPC server can be disabled in the
+ * administration panels.
*
* @package WordPress
* @subpackage Publishing
+ * @since 1.5.0
*/
class wp_xmlrpc_server extends IXR_Server {
+ /**
+ * Register all of the XMLRPC methods that XMLRPC server understands.
+ *
+ * PHP4 constructor and sets up server and method property. Passes XMLRPC
+ * methods through the 'xmlrpc_methods' filter to allow plugins to extend
+ * or replace XMLRPC methods.
+ *
+ * @since 1.5.0
+ *
+ * @return wp_xmlrpc_server
+ */
function wp_xmlrpc_server() {
$this->methods = array(
// WordPress API
'wp.getPageList' => 'this:wp_getPageList',
'wp.getAuthors' => 'this:wp_getAuthors',
'wp.getCategories' => 'this:mw_getCategories', // Alias
+ 'wp.getTags' => 'this:wp_getTags',
'wp.newCategory' => 'this:wp_newCategory',
'wp.deleteCategory' => 'this:wp_deleteCategory',
'wp.suggestCategories' => 'this:wp_suggestCategories',
'wp.getPageTemplates' => 'this:wp_getPageTemplates',
'wp.getOptions' => 'this:wp_getOptions',
'wp.setOptions' => 'this:wp_setOptions',
+ 'wp.getComment' => 'this:wp_getComment',
+ 'wp.getComments' => 'this:wp_getComments',
+ 'wp.deleteComment' => 'this:wp_deleteComment',
+ 'wp.editComment' => 'this:wp_editComment',
+ 'wp.newComment' => 'this:wp_newComment',
+ 'wp.getCommentStatusList' => 'this:wp_getCommentStatusList',
// Blogger API
'blogger.getUsersBlogs' => 'this:blogger_getUsersBlogs',
$this->IXR_Server($this->methods);
}
+ /**
+ * Test XMLRPC API by saying, "Hello!" to client.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method Parameters.
+ * @return string
+ */
function sayHello($args) {
return 'Hello!';
}
+ /**
+ * Test XMLRPC API by adding two numbers for client.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method Parameters.
+ * @return int
+ */
function addTwoNumbers($args) {
$number1 = $args[0];
$number2 = $args[1];
return $number1 + $number2;
}
+ /**
+ * Check user's credentials.
+ *
+ * @since 1.5.0
+ *
+ * @param string $user_login User's username.
+ * @param string $user_pass User's password.
+ * @return bool Whether authentication passed.
+ */
function login_pass_ok($user_login, $user_pass) {
if ( !get_option( 'enable_xmlrpc' ) ) {
$this->error = new IXR_Error( 405, sprintf( __( 'XML-RPC services are disabled on this blog. An admin user can enable them at %s'), admin_url('options-writing.php') ) );
return true;
}
+ /**
+ * Sanitize string or array of strings for database.
+ *
+ * @since 1.5.2
+ *
+ * @param string|array $array Sanitize single string or array of strings.
+ * @return string|array Type matches $array and sanitized for the database.
+ */
function escape(&$array) {
global $wpdb;
}
}
+ /**
+ * Retrieve custom fields for post.
+ *
+ * @since 2.5.0
+ *
+ * @param int $post_id Post ID.
+ * @return array Custom fields, if exist.
+ */
function get_custom_fields($post_id) {
$post_id = (int) $post_id;
return $custom_fields;
}
+ /**
+ * Set custom fields for post.
+ *
+ * @since 2.5.0
+ *
+ * @param int $post_id Post ID.
+ * @param array $fields Custom fields.
+ */
function set_custom_fields($post_id, $fields) {
$post_id = (int) $post_id;
}
}
+ /**
+ * Setup blog options property.
+ *
+ * Passes property through 'xmlrpc_blog_options' filter.
+ *
+ * @since 2.6.0
+ */
function initialise_blog_option_info( ) {
global $wp_version;
}
/**
- * WordPress XML-RPC API
- * wp_getUsersBlogs
+ * Retrieve the blogs of the user.
+ *
+ * @since 2.6.0
+ *
+ * @param array $args Method parameters.
+ * @return array
*/
function wp_getUsersBlogs( $args ) {
// If this isn't on WPMU then just use blogger_getUsersBlogs
foreach( $blogs as $blog ) {
// Don't include blogs that aren't hosted at this site
- if( $blog->site_id != 1 )
+ if( $blog->site_id != $current_site->id )
continue;
$blog_id = $blog->userblog_id;
'blogName' => get_option( 'blogname' ),
'xmlrpc' => get_option( 'home' ) . '/xmlrpc.php'
);
+
+ restore_current_blog( );
}
return $struct;
}
/**
- * WordPress XML-RPC API
- * wp_getPage
+ * Retrieve page.
+ *
+ * @since 2.2.0
+ *
+ * @param array $args Method parameters.
+ * @return array
*/
function wp_getPage($args) {
$this->escape($args);
}
/**
- * WordPress XML-RPC API
- * wp_getPages
+ * Retrieve Pages.
+ *
+ * @since 2.2.0
+ *
+ * @param array $args Method parameters.
+ * @return array
*/
function wp_getPages($args) {
$this->escape($args);
$blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
+ $num_pages = (int) $args[3];
if(!$this->login_pass_ok($username, $password)) {
return($this->error);
do_action('xmlrpc_call', 'wp.getPages');
- // Lookup info on pages.
- $pages = get_pages();
+ $page_limit = 10;
+ if( isset( $num_pages ) ) {
+ $page_limit = $num_pages;
+ }
+
+ $pages = get_posts( "post_type=page&post_status=all&numberposts={$page_limit}" );
$num_pages = count($pages);
// If we have pages, put together their info.
}
/**
- * WordPress XML-RPC API
- * wp_newPage
+ * Create new page.
+ *
+ * @since 2.2.0
+ *
+ * @param array $args Method parameters.
+ * @return unknown
*/
function wp_newPage($args) {
// Items not escaped here will be escaped in newPost.
}
/**
- * WordPress XML-RPC API
- * wp_deletePage
+ * Delete page.
+ *
+ * @since 2.2.0
+ *
+ * @param array $args Method parameters.
+ * @return bool True, if success.
*/
function wp_deletePage($args) {
$this->escape($args);
}
/**
- * WordPress XML-RPC API
- * wp_editPage
+ * Edit page.
+ *
+ * @since 2.2.0
+ *
+ * @param array $args Method parameters.
+ * @return unknown
*/
function wp_editPage($args) {
// Items not escaped here will be escaped in editPost.
}
/**
- * WordPress XML-RPC API
- * wp_getPageList
+ * Retrieve page list.
+ *
+ * @since 2.2.0
+ *
+ * @param array $args Method parameters.
+ * @return unknown
*/
function wp_getPageList($args) {
global $wpdb;
}
/**
- * WordPress XML-RPC API
- * wp_getAuthors
+ * Retrieve authors list.
+ *
+ * @since 2.2.0
+ *
+ * @param array $args Method parameters.
+ * @return array
*/
function wp_getAuthors($args) {
set_current_user(0, $username);
if(!current_user_can("edit_posts")) {
return(new IXR_Error(401, __("Sorry, you can not edit posts on this blog.")));
- }
+ }
do_action('xmlrpc_call', 'wp.getAuthors');
}
/**
- * WordPress XML-RPC API
- * wp_newCategory
+ * Get list of all tags
+ *
+ * @since 2.7
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
+ function wp_getTags( $args ) {
+ $this->escape( $args );
+
+ $blog_id = (int) $args[0];
+ $username = $args[1];
+ $password = $args[2];
+
+ if( !$this->login_pass_ok( $username, $password ) ) {
+ return $this->error;
+ }
+
+ set_current_user( 0, $username );
+ if( !current_user_can( 'edit_posts' ) ) {
+ return new IXR_Error( 401, __( 'Sorry, you must be able to edit posts on this blog in order to view tags.' ) );
+ }
+
+ do_action( 'xmlrpc_call', 'wp.getKeywords' );
+
+ $tags = array( );
+
+ if( $all_tags = get_tags( ) ) {
+ foreach( (array) $all_tags as $tag ) {
+ $struct['tag_id'] = $tag->term_id;
+ $struct['name'] = $tag->name;
+ $struct['count'] = $tag->count;
+ $struct['slug'] = $tag->slug;
+ $struct['html_url'] = wp_specialchars( get_tag_link( $tag->term_id ) );
+ $struct['rss_url'] = wp_specialchars( get_tag_feed_link( $tag->term_id ) );
+
+ $tags[] = $struct;
+ }
+ }
+
+ return $tags;
+ }
+
+ /**
+ * Create new category.
+ *
+ * @since 2.2.0
+ *
+ * @param array $args Method parameters.
+ * @return int Category ID.
*/
function wp_newCategory($args) {
$this->escape($args);
}
/**
- * WordPress XML-RPC API
- * wp_deleteCategory
+ * Remove category.
+ *
+ * @since 2.5.0
+ *
+ * @param array $args Method parameters.
+ * @return mixed See {@link wp_delete_category()} for return info.
*/
function wp_deleteCategory($args) {
$this->escape($args);
return wp_delete_category( $category_id );
}
-
/**
- * WordPress XML-RPC API
- * wp_suggestCategories
+ * Retrieve category list.
+ *
+ * @since 2.2.0
+ *
+ * @param array $args Method parameters.
+ * @return array
*/
function wp_suggestCategories($args) {
$this->escape($args);
return($category_suggestions);
}
+ /**
+ * Retrieve comment.
+ *
+ * @since 2.7.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
+ function wp_getComment($args) {
+ $this->escape($args);
+
+ $blog_id = (int) $args[0];
+ $username = $args[1];
+ $password = $args[2];
+ $comment_id = (int) $args[3];
+
+ if ( !$this->login_pass_ok( $username, $password ) )
+ return $this->error;
+
+ set_current_user( 0, $username );
+ if ( !current_user_can( 'moderate_comments' ) )
+ return new IXR_Error( 403, __( 'You are not allowed to moderate comments on this blog.' ) );
+
+ do_action('xmlrpc_call', 'wp.getComment');
+
+ if ( ! $comment = get_comment($comment_id) )
+ return new IXR_Error( 404, __( 'Invalid comment ID.' ) );
+
+ // Format page date.
+ $comment_date = mysql2date("Ymd\TH:i:s", $comment->comment_date);
+ $comment_date_gmt = mysql2date("Ymd\TH:i:s", $comment->comment_date_gmt);
+
+ if ( 0 == $comment->comment_approved )
+ $comment_status = 'hold';
+ else if ( 'spam' == $comment->comment_approved )
+ $comment_status = 'spam';
+ else if ( 1 == $comment->comment_approved )
+ $comment_status = 'approve';
+ else
+ $comment_status = $comment->comment_approved;
+
+ $link = get_comment_link($comment);
+
+ $comment_struct = array(
+ "date_created_gmt" => new IXR_Date($comment_date_gmt),
+ "user_id" => $comment->user_id,
+ "comment_id" => $comment->comment_ID,
+ "parent" => $comment->comment_parent,
+ "status" => $comment_status,
+ "content" => $comment->comment_content,
+ "link" => $link,
+ "post_id" => $comment->comment_post_ID,
+ "post_title" => get_the_title($comment->comment_post_ID),
+ "author" => $comment->comment_author,
+ "author_url" => $comment->comment_author_url,
+ "author_email" => $comment->comment_author_email,
+ "author_ip" => $comment->comment_author_IP,
+ "type" => $comment->comment_type,
+ );
+
+ return $comment_struct;
+ }
+
+ /**
+ * Retrieve comments.
+ *
+ * @since 2.7.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
+ function wp_getComments($args) {
+ $this->escape($args);
+
+ $blog_id = (int) $args[0];
+ $username = $args[1];
+ $password = $args[2];
+ $struct = $args[3];
+
+ if ( !$this->login_pass_ok($username, $password) )
+ return($this->error);
+
+ set_current_user( 0, $username );
+ if ( !current_user_can( 'moderate_comments' ) )
+ return new IXR_Error( 401, __( 'Sorry, you can not edit comments.' ) );
+
+ do_action('xmlrpc_call', 'wp.getComments');
+
+ if ( isset($struct['status']) )
+ $status = $struct['status'];
+ else
+ $status = '';
+
+ $post_id = '';
+ if ( isset($struct['post_id']) )
+ $post_id = absint($struct['post_id']);
+
+ $offset = 0;
+ if ( isset($struct['offset']) )
+ $offset = absint($struct['offset']);
+
+ $number = 10;
+ if ( isset($struct['number']) )
+ $number = absint($struct['number']);
+
+ $comments = get_comments( array('status' => $status, 'post_id' => $post_id, 'offset' => $offset, 'number' => $number ) );
+ $num_comments = count($comments);
+
+ if ( ! $num_comments )
+ return array();
+
+ $comments_struct = array();
+
+ for ( $i = 0; $i < $num_comments; $i++ ) {
+ $comment = wp_xmlrpc_server::wp_getComment(array(
+ $blog_id, $username, $password, $comments[$i]->comment_ID,
+ ));
+ $comments_struct[] = $comment;
+ }
+
+ return $comments_struct;
+ }
+
+ /**
+ * Remove comment.
+ *
+ * @since 2.7.0
+ *
+ * @param array $args Method parameters.
+ * @return mixed {@link wp_delete_comment()}
+ */
+ function wp_deleteComment($args) {
+ $this->escape($args);
+
+ $blog_id = (int) $args[0];
+ $username = $args[1];
+ $password = $args[2];
+ $comment_ID = (int) $args[3];
+
+ if ( !$this->login_pass_ok( $username, $password ) )
+ return $this->error;
+
+ set_current_user( 0, $username );
+ if ( !current_user_can( 'moderate_comments' ) )
+ return new IXR_Error( 403, __( 'You are not allowed to moderate comments on this blog.' ) );
+
+ do_action('xmlrpc_call', 'wp.deleteComment');
+
+ if ( ! get_comment($comment_ID) )
+ return new IXR_Error( 404, __( 'Invalid comment ID.' ) );
+
+ return wp_delete_comment($comment_ID);
+ }
+
+ /**
+ * Edit comment.
+ *
+ * @since 2.7.0
+ *
+ * @param array $args Method parameters.
+ * @return bool True, on success.
+ */
+ function wp_editComment($args) {
+ $this->escape($args);
+
+ $blog_id = (int) $args[0];
+ $username = $args[1];
+ $password = $args[2];
+ $comment_ID = (int) $args[3];
+ $content_struct = $args[4];
+
+ if ( !$this->login_pass_ok( $username, $password ) )
+ return $this->error;
+
+ set_current_user( 0, $username );
+ if ( !current_user_can( 'moderate_comments' ) )
+ return new IXR_Error( 403, __( 'You are not allowed to moderate comments on this blog.' ) );
+
+ do_action('xmlrpc_call', 'wp.editComment');
+
+ if ( ! get_comment($comment_ID) )
+ return new IXR_Error( 404, __( 'Invalid comment ID.' ) );
+
+ if ( isset($content_struct['status']) ) {
+ $statuses = get_comment_statuses();
+ $statuses = array_keys($statuses);
+
+ if ( ! in_array($content_struct['status'], $statuses) )
+ return new IXR_Error( 401, __( 'Invalid comment status.' ) );
+ $comment_approved = $content_struct['status'];
+ }
+
+ // Do some timestamp voodoo
+ if ( !empty( $content_struct['date_created_gmt'] ) ) {
+ $dateCreated = str_replace( 'Z', '', $content_struct['date_created_gmt']->getIso() ) . 'Z'; // We know this is supposed to be GMT, so we're going to slap that Z on there by force
+ $comment_date = get_date_from_gmt(iso8601_to_datetime($dateCreated));
+ $comment_date_gmt = iso8601_to_datetime($dateCreated, GMT);
+ }
+
+ if ( isset($content_struct['content']) )
+ $comment_content = $content_struct['content'];
+
+ if ( isset($content_struct['author']) )
+ $comment_author = $content_struct['author'];
+
+ if ( isset($content_struct['author_url']) )
+ $comment_author_url = $content_struct['author_url'];
+
+ if ( isset($content_struct['author_email']) )
+ $comment_author_email = $content_struct['author_email'];
+
+ // We've got all the data -- post it:
+ $comment = compact('comment_ID', 'comment_content', 'comment_approved', 'comment_date', 'comment_date_gmt', 'comment_author', 'comment_author_email', 'comment_author_url');
+
+ $result = wp_update_comment($comment);
+ if ( is_wp_error( $result ) )
+ return new IXR_Error(500, $result->get_error_message());
+
+ if ( !$result )
+ return new IXR_Error(500, __('Sorry, the comment could not be edited. Something wrong happened.'));
+
+ return true;
+ }
+
+ /**
+ * Create new comment.
+ *
+ * @since 2.7.0
+ *
+ * @param array $args Method parameters.
+ * @return mixed {@link wp_new_comment()}
+ */
+ function wp_newComment($args) {
+ global $wpdb;
+
+ $this->escape($args);
+
+ $blog_id = (int) $args[0];
+ $username = $args[1];
+ $password = $args[2];
+ $post = $args[3];
+ $content_struct = $args[4];
+
+ $allow_anon = apply_filters('xmlrpc_allow_anonymous_comments', false);
+
+ if ( !$this->login_pass_ok( $username, $password ) ) {
+ $logged_in = false;
+ if ( $allow_anon && get_option('comment_registration') )
+ return new IXR_Error( 403, __( 'You must be registered to comment' ) );
+ else if ( !$allow_anon )
+ return $this->error;
+ } else {
+ $logged_in = true;
+ set_current_user( 0, $username );
+ }
+
+ if ( is_numeric($post) )
+ $post_id = absint($post);
+ else
+ $post_id = url_to_postid($post);
+
+ if ( ! $post_id )
+ return new IXR_Error( 404, __( 'Invalid post ID.' ) );
+
+ if ( ! get_post($post_id) )
+ return new IXR_Error( 404, __( 'Invalid post ID.' ) );
+
+ $comment['comment_post_ID'] = $post_id;
+
+ if ( $logged_in ) {
+ $user = wp_get_current_user();
+ $comment['comment_author'] = $wpdb->escape( $user->display_name );
+ $comment['comment_author_email'] = $wpdb->escape( $user->user_email );
+ $comment['comment_author_url'] = $wpdb->escape( $user->user_url );
+ $comment['user_ID'] = $user->ID;
+ } else {
+ $comment['comment_author'] = '';
+ if ( isset($content_struct['author']) )
+ $comment['comment_author'] = $content_struct['author'];
+
+ $comment['comment_author_email'] = '';
+ if ( isset($content_struct['author_email']) )
+ $comment['comment_author_email'] = $content_struct['author_email'];
+
+ $comment['comment_author_url'] = '';
+ if ( isset($content_struct['author_url']) )
+ $comment['comment_author_url'] = $content_struct['author_url'];
+
+ $comment['user_ID'] = 0;
+
+ if ( get_option('require_name_email') ) {
+ if ( 6 > strlen($comment['comment_author_email']) || '' == $comment['comment_author'] )
+ return new IXR_Error( 403, __( 'Comment author name and email are required' ) );
+ elseif ( !is_email($comment['comment_author_email']) )
+ return new IXR_Error( 403, __( 'A valid email address is required' ) );
+ }
+ }
+
+ $comment['comment_parent'] = isset($content_struct['comment_parent']) ? absint($content_struct['comment_parent']) : 0;
+
+ $comment['comment_content'] = $content_struct['content'];
+
+ do_action('xmlrpc_call', 'wp.newComment');
+
+ return wp_new_comment($comment);
+ }
+
+ /**
+ * Retrieve all of the comment status.
+ *
+ * @since 2.7.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
+ function wp_getCommentStatusList($args) {
+ $this->escape( $args );
+
+ $blog_id = (int) $args[0];
+ $username = $args[1];
+ $password = $args[2];
+
+ if ( !$this->login_pass_ok( $username, $password ) )
+ return $this->error;
+
+ set_current_user( 0, $username );
+ if ( !current_user_can( 'moderate_comments' ) )
+ return new IXR_Error( 403, __( 'You are not allowed access to details about this blog.' ) );
+
+ do_action('xmlrpc_call', 'wp.getCommentStatusList');
+
+ return get_comment_statuses( );
+ }
+
+ /**
+ * Retrieve comment count.
+ *
+ * @since 2.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function wp_getCommentCount( $args ) {
$this->escape($args);
);
}
-
+ /**
+ * Retrieve post statuses.
+ *
+ * @since 2.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function wp_getPostStatusList( $args ) {
$this->escape( $args );
return get_post_statuses( );
}
-
+ /**
+ * Retrieve page statuses.
+ *
+ * @since 2.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function wp_getPageStatusList( $args ) {
$this->escape( $args );
return get_page_statuses( );
}
+ /**
+ * Retrieve page templates.
+ *
+ * @since 2.6.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function wp_getPageTemplates( $args ) {
$this->escape( $args );
return $templates;
}
+ /**
+ * Retrieve blog options.
+ *
+ * @since 2.6.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function wp_getOptions( $args ) {
$this->escape( $args );
return $this->_getOptions($options);
}
+ /**
+ * Retrieve blog options value from list.
+ *
+ * @since 2.6.0
+ *
+ * @param array $options Options to retrieve.
+ * @return array
+ */
function _getOptions($options)
{
$data = array( );
return $data;
}
+ /**
+ * Update blog options.
+ *
+ * @since 2.6.0
+ *
+ * @param array $args Method parameters.
+ * @return unknown
+ */
function wp_setOptions( $args ) {
$this->escape( $args );
return $this->_getOptions($option_names);
}
- /* Blogger API functions
+ /* Blogger API functions.
* specs on http://plant.blogger.com/api and http://groups.yahoo.com/group/bloggerDev/
*/
-
- /* blogger.getUsersBlogs will make more sense once we support multiple blogs */
+ /**
+ * Retrieve blogs that user owns.
+ *
+ * Will make more sense once we support multiple blogs.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function blogger_getUsersBlogs($args) {
$this->escape($args);
return array($struct);
}
-
- /* blogger.getUsersInfo gives your client some info about you, so you don't have to */
+ /**
+ * Retrieve user's data.
+ *
+ * Gives your client some info about you, so you don't have to.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function blogger_getUserInfo($args) {
$this->escape($args);
return $struct;
}
-
- /* blogger.getPost ...gets a post */
+ /**
+ * Retrieve post.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function blogger_getPost($args) {
$this->escape($args);
return $struct;
}
-
- /* blogger.getRecentPosts ...gets recent posts */
+ /**
+ * Retrieve list of recent posts.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function blogger_getRecentPosts($args) {
$this->escape($args);
return $recent_posts;
}
-
- /* blogger.getTemplate returns your blog_filename */
+ /**
+ * Retrieve blog_filename content.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return string
+ */
function blogger_getTemplate($args) {
$this->escape($args);
- $blog_ID = (int) $args[1];
- $user_login = $args[2];
- $user_pass = $args[3];
- $template = $args[4]; /* could be 'main' or 'archiveIndex', but we don't use it */
+ $blog_ID = (int) $args[1];
+ $user_login = $args[2];
+ $user_pass = $args[3];
+ $template = $args[4]; /* could be 'main' or 'archiveIndex', but we don't use it */
- if (!$this->login_pass_ok($user_login, $user_pass)) {
- return $this->error;
- }
+ if (!$this->login_pass_ok($user_login, $user_pass)) {
+ return $this->error;
+ }
- do_action('xmlrpc_call', 'blogger.getTemplate');
+ do_action('xmlrpc_call', 'blogger.getTemplate');
- set_current_user(0, $user_login);
- if ( !current_user_can('edit_themes') ) {
- return new IXR_Error(401, __('Sorry, this user can not edit the template.'));
- }
+ set_current_user(0, $user_login);
+ if ( !current_user_can('edit_themes') ) {
+ return new IXR_Error(401, __('Sorry, this user can not edit the template.'));
+ }
- /* warning: here we make the assumption that the blog's URL is on the same server */
- $filename = get_option('home') . '/';
- $filename = preg_replace('#https?://.+?/#', $_SERVER['DOCUMENT_ROOT'].'/', $filename);
+ /* warning: here we make the assumption that the blog's URL is on the same server */
+ $filename = get_option('home') . '/';
+ $filename = preg_replace('#https?://.+?/#', $_SERVER['DOCUMENT_ROOT'].'/', $filename);
- $f = fopen($filename, 'r');
- $content = fread($f, filesize($filename));
- fclose($f);
+ $f = fopen($filename, 'r');
+ $content = fread($f, filesize($filename));
+ fclose($f);
- /* so it is actually editable with a windows/mac client */
- // FIXME: (or delete me) do we really want to cater to bad clients at the expense of good ones by BEEPing up their line breaks? commented. $content = str_replace("\n", "\r\n", $content);
+ /* so it is actually editable with a windows/mac client */
+ // FIXME: (or delete me) do we really want to cater to bad clients at the expense of good ones by BEEPing up their line breaks? commented. $content = str_replace("\n", "\r\n", $content);
- return $content;
+ return $content;
}
-
- /* blogger.setTemplate updates the content of blog_filename */
+ /**
+ * Updates the content of blog_filename.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return bool True when done.
+ */
function blogger_setTemplate($args) {
$this->escape($args);
return true;
}
-
- /* blogger.newPost ...creates a new post */
+ /**
+ * Create new post.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return int
+ */
function blogger_newPost($args) {
$this->escape($args);
return $post_ID;
}
- /* blogger.editPost ...edits a post */
+ /**
+ * Edit a post.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return bool true when done.
+ */
function blogger_editPost($args) {
$this->escape($args);
$actual_post = wp_get_single_post($post_ID,ARRAY_A);
- if (!$actual_post) {
+ if (!$actual_post || $actual_post['post_type'] != 'post') {
return new IXR_Error(404, __('Sorry, no such post.'));
}
return true;
}
-
- /* blogger.deletePost ...deletes a post */
+ /**
+ * Remove a post.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return bool True when post is deleted.
+ */
function blogger_deletePost($args) {
$this->escape($args);
$actual_post = wp_get_single_post($post_ID,ARRAY_A);
- if (!$actual_post) {
+ if (!$actual_post || $actual_post['post_type'] != 'post') {
return new IXR_Error(404, __('Sorry, no such post.'));
}
return true;
}
-
-
/* MetaWeblog API functions
* specs on wherever Dave Winer wants them to be
*/
- /* metaweblog.newPost creates a post */
+ /**
+ * Create a new post.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return int
+ */
function mw_newPost($args) {
$this->escape($args);
$this->set_custom_fields($post_ID, $content_struct['custom_fields']);
}
- // Handle enclosures
- $enclosure = $content_struct['enclosure'];
- if( is_array( $enclosure ) && isset( $enclosure['url'] ) && isset( $enclosure['length'] ) && isset( $enclosure['type'] ) ) {
+ // Handle enclosures
+ $enclosure = $content_struct['enclosure'];
+ if( is_array( $enclosure ) && isset( $enclosure['url'] ) && isset( $enclosure['length'] ) && isset( $enclosure['type'] ) ) {
add_post_meta( $post_ID, 'enclosure', $enclosure['url'] . "\n" . $enclosure['length'] . "\n" . $enclosure['type'] );
- }
+ }
$this->attach_uploads( $post_ID, $post_content );
return strval($post_ID);
}
+ /**
+ * Attach upload to a post.
+ *
+ * @since 2.1.0
+ *
+ * @param int $post_ID Post ID.
+ * @param string $post_content Post Content for attachment.
+ */
function attach_uploads( $post_ID, $post_content ) {
global $wpdb;
}
}
- /* metaweblog.editPost ...edits a post */
+ /**
+ * Edit a post.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return bool True on success.
+ */
function mw_editPost($args) {
$this->escape($args);
$this->set_custom_fields($post_ID, $content_struct['custom_fields']);
}
- // Handle enclosures
- $enclosure = $content_struct['enclosure'];
- if( is_array( $enclosure ) && isset( $enclosure['url'] ) && isset( $enclosure['length'] ) && isset( $enclosure['type'] ) ) {
+ // Handle enclosures
+ $enclosure = $content_struct['enclosure'];
+ if( is_array( $enclosure ) && isset( $enclosure['url'] ) && isset( $enclosure['length'] ) && isset( $enclosure['type'] ) ) {
add_post_meta( $post_ID, 'enclosure', $enclosure['url'] . "\n" . $enclosure['length'] . "\n" . $enclosure['type'] );
- }
+ }
$this->attach_uploads( $ID, $post_content );
return true;
}
-
- /* metaweblog.getPost ...returns a post */
+ /**
+ * Retrieve post.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function mw_getPost($args) {
$this->escape($args);
$postdata['post_status'] = 'publish';
}
+ $enclosure = array();
+ foreach ( (array) get_post_custom($post_ID) as $key => $val) {
+ if ($key == 'enclosure') {
+ foreach ( (array) $val as $enc ) {
+ $encdata = split("\n", $enc);
+ $enclosure['url'] = trim(htmlspecialchars($encdata[0]));
+ $enclosure['length'] = trim($encdata[1]);
+ $enclosure['type'] = trim($encdata[2]);
+ break 2;
+ }
+ }
+ }
+
$resp = array(
'dateCreated' => new IXR_Date($post_date),
'userid' => $postdata['post_author'],
'custom_fields' => $this->get_custom_fields($post_ID)
);
+ if (!empty($enclosure)) $resp['enclosure'] = $enclosure;
+
return $resp;
} else {
return new IXR_Error(404, __('Sorry, no such post.'));
}
}
-
- /* metaweblog.getRecentPosts ...returns recent posts */
+ /**
+ * Retrieve list of recent posts.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function mw_getRecentPosts($args) {
$this->escape($args);
$posts_list = wp_get_recent_posts($num_posts);
if (!$posts_list) {
- $this->error = new IXR_Error(500, __('Either there are no posts, or something went wrong.'));
- return $this->error;
+ return array( );
}
set_current_user( 0, $user_login );
'title' => $entry['post_title'],
'link' => $link,
'permaLink' => $link,
-// commented out because no other tool seems to use this
-// 'content' => $entry['post_content'],
+ // commented out because no other tool seems to use this
+ // 'content' => $entry['post_content'],
'categories' => $categories,
'mt_excerpt' => $entry['post_excerpt'],
'mt_text_more' => $post['extended'],
return $recent_posts;
}
-
- /* metaweblog.getCategories ...returns the list of categories on a given blog */
+ /**
+ * Retrieve the list of categories on a given blog.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function mw_getCategories($args) {
$this->escape($args);
$struct['categoryId'] = $cat->term_id;
$struct['parentId'] = $cat->parent;
$struct['description'] = $cat->name;
+ $struct['categoryDescription'] = $cat->description;
$struct['categoryName'] = $cat->name;
$struct['htmlUrl'] = wp_specialchars(get_category_link($cat->term_id));
- $struct['rssUrl'] = wp_specialchars(get_category_rss_link(false, $cat->term_id, $cat->name));
+ $struct['rssUrl'] = wp_specialchars(get_category_feed_link($cat->term_id, 'rss2'));
$categories_struct[] = $struct;
}
return $categories_struct;
}
-
- /* metaweblog.newMediaObject uploads a file, following your settings */
+ /**
+ * Uploads a file, following your settings.
+ *
+ * Adapted from a patch by Johann Richard.
+ *
+ * @link http://mycvs.org/archives/2004/06/30/file-upload-to-wordpress-in-ecto/
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function mw_newMediaObject($args) {
- // adapted from a patch by Johann Richard
- // http://mycvs.org/archives/2004/06/30/file-upload-to-wordpress-in-ecto/
-
global $wpdb;
$blog_ID = (int) $args[0];
return apply_filters( 'wp_handle_upload', array( 'file' => $name, 'url' => $upload[ 'url' ], 'type' => $type ) );
}
-
/* MovableType API functions
* specs on http://www.movabletype.org/docs/mtmanual_programmatic.html
*/
- /* mt.getRecentPostTitles ...returns recent posts' titles */
+ /**
+ * Retrieve the post titles of recent posts.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function mt_getRecentPostTitles($args) {
$this->escape($args);
return $recent_posts;
}
-
- /* mt.getCategoryList ...returns the list of categories on a given blog */
+ /**
+ * Retrieve list of all categories on blog.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function mt_getCategoryList($args) {
$this->escape($args);
return $categories_struct;
}
-
- /* mt.getPostCategories ...returns a post's categories */
+ /**
+ * Retrieve post categories.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function mt_getPostCategories($args) {
$this->escape($args);
return $categories;
}
-
- /* mt.setPostCategories ...sets a post's categories */
+ /**
+ * Sets categories for a post.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return bool True on success.
+ */
function mt_setPostCategories($args) {
$this->escape($args);
return true;
}
-
- /* mt.supportedMethods ...returns an array of methods supported by this server */
+ /**
+ * Retrieve an array of methods supported by this server.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function mt_supportedMethods($args) {
do_action('xmlrpc_call', 'mt.supportedMethods');
return $supported_methods;
}
-
- /* mt.supportedTextFilters ...returns an empty array because we don't
- support per-post text filters yet */
+ /**
+ * Retrieve an empty array because we don't support per-post text filters.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ */
function mt_supportedTextFilters($args) {
do_action('xmlrpc_call', 'mt.supportedTextFilters');
return apply_filters('xmlrpc_text_filters', array());
}
-
- /* mt.getTrackbackPings ...returns trackbacks sent to a given post */
+ /**
+ * Retrieve trackbacks sent to a given post.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return mixed
+ */
function mt_getTrackbackPings($args) {
global $wpdb;
return $trackback_pings;
}
-
- /* mt.publishPost ...sets a post's publish status to 'publish' */
+ /**
+ * Sets a post's publish status to 'publish'.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return int
+ */
function mt_publishPost($args) {
$this->escape($args);
return $result;
}
-
-
/* PingBack functions
* specs on www.hixie.ch/specs/pingback/pingback
*/
- /* pingback.ping gets a pingback and registers it */
+ /**
+ * Retrieves a pingback and registers it.
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function pingback_ping($args) {
global $wpdb;
return new IXR_Error(0, __('The source URL and the target URL cannot both point to the same resource.'));
// Check if pings are on
- if ( 'closed' == $post->ping_status )
+ if ( !pings_open($post) )
return new IXR_Error(33, __('The specified target URL cannot be used as a target. It either doesn\'t exist, or it is not a pingback-enabled resource.'));
// Let's check that the remote site didn't already pingback this entry
return sprintf(__('Pingback from %1$s to %2$s registered. Keep the web talking! :-)'), $pagelinkedfrom, $pagelinkedto);
}
-
- /* pingback.extensions.getPingbacks returns an array of URLs
- that pingbacked the given URL
- specs on http://www.aquarionics.com/misc/archives/blogite/0198.html */
+ /**
+ * Retrieve array of URLs that pingbacked the given URL.
+ *
+ * Specs on http://www.aquarionics.com/misc/archives/blogite/0198.html
+ *
+ * @since 1.5.0
+ *
+ * @param array $args Method parameters.
+ * @return array
+ */
function pingback_extensions_getPingbacks($args) {
global $wpdb;
}
}
-
$wp_xmlrpc_server = new wp_xmlrpc_server();
?>