$always_authenticate = 1;
/**
- * log_app() - Writes logging info to a file.
+ * Writes logging info to a file.
*
+ * @since 2.2.0
* @uses $app_logging
* @package WordPress
* @subpackage Logging
if ( !function_exists('wp_set_current_user') ) :
/**
- * wp_set_current_user() - Sets the current WordPress User
- *
- * Pluggable function which is also found in pluggable.php.
- *
- * @see wp-includes/pluggable.php Documentation for this function.
- * @uses $current_user Global of current user to test whether $id is the same.
- *
- * @param int $id The user's ID
- * @param string $name Optional. The username of the user.
- * @return WP_User Current user's User object
+ * @ignore
*/
function wp_set_current_user($id, $name = '') {
global $current_user;
endif;
/**
- * wa_posts_where_include_drafts_filter() - Filter to add more post statuses
+ * Filter to add more post statuses.
*
- * @param string $where SQL statement to filter
- * @return string Filtered SQL statement with added post_status for where clause
+ * @since 2.2.0
+ *
+ * @param string $where SQL statement to filter.
+ * @return string Filtered SQL statement with added post_status for where clause.
*/
function wa_posts_where_include_drafts_filter($where) {
$where = str_replace("post_status = 'publish'","post_status = 'publish' OR post_status = 'future' OR post_status = 'draft' OR post_status = 'inherit'", $where);
add_filter('posts_where', 'wa_posts_where_include_drafts_filter');
/**
- * @internal
- * Left undocumented to work on later. If you want to finish, then please do so.
+ * WordPress AtomPub API implementation.
*
* @package WordPress
* @subpackage Publishing
+ * @since 2.2.0
*/
class AtomServer {
+ /**
+ * ATOM content type.
+ *
+ * @since 2.2.0
+ * @var string
+ */
var $ATOM_CONTENT_TYPE = 'application/atom+xml';
+
+ /**
+ * Categories ATOM content type.
+ *
+ * @since 2.2.0
+ * @var string
+ */
var $CATEGORIES_CONTENT_TYPE = 'application/atomcat+xml';
+
+ /**
+ * Service ATOM content type.
+ *
+ * @since 2.3.0
+ * @var string
+ */
var $SERVICE_CONTENT_TYPE = 'application/atomsvc+xml';
+ /**
+ * ATOM XML namespace.
+ *
+ * @since 2.3.0
+ * @var string
+ */
var $ATOM_NS = 'http://www.w3.org/2005/Atom';
+
+ /**
+ * ATOMPUB XML namespace.
+ *
+ * @since 2.3.0
+ * @var string
+ */
var $ATOMPUB_NS = 'http://www.w3.org/2007/app';
+ /**
+ * Entries path.
+ *
+ * @since 2.2.0
+ * @var string
+ */
var $ENTRIES_PATH = "posts";
+
+ /**
+ * Categories path.
+ *
+ * @since 2.2.0
+ * @var string
+ */
var $CATEGORIES_PATH = "categories";
+
+ /**
+ * Media path.
+ *
+ * @since 2.2.0
+ * @var string
+ */
var $MEDIA_PATH = "attachments";
+
+ /**
+ * Entry path.
+ *
+ * @since 2.2.0
+ * @var string
+ */
var $ENTRY_PATH = "post";
+
+ /**
+ * Service path.
+ *
+ * @since 2.2.0
+ * @var string
+ */
var $SERVICE_PATH = "service";
+
+ /**
+ * Media single path.
+ *
+ * @since 2.2.0
+ * @var string
+ */
var $MEDIA_SINGLE_PATH = "attachment";
+ /**
+ * ATOMPUB parameters.
+ *
+ * @since 2.2.0
+ * @var array
+ */
var $params = array();
+
+ /**
+ * Supported ATOMPUB media types.
+ *
+ * @since 2.3.0
+ * @var array
+ */
var $media_content_types = array('image/*','audio/*','video/*');
+
+ /**
+ * ATOMPUB content type(s).
+ *
+ * @since 2.2.0
+ * @var array
+ */
var $atom_content_types = array('application/atom+xml');
+ /**
+ * ATOMPUB methods.
+ *
+ * @since 2.2.0
+ * @var unknown_type
+ */
var $selectors = array();
- // support for head
+ /**
+ * Whether to do output.
+ *
+ * Support for head.
+ *
+ * @since 2.2.0
+ * @var bool
+ */
var $do_output = true;
+ /**
+ * PHP4 constructor - Sets up object properties.
+ *
+ * @since 2.2.0
+ * @return AtomServer
+ */
function AtomServer() {
$this->script_name = array_pop(explode('/',$_SERVER['SCRIPT_NAME']));
);
}
+ /**
+ * Handle ATOMPUB request.
+ *
+ * @since 2.2.0
+ */
function handle_request() {
global $always_authenticate;
if( !empty( $_SERVER['ORIG_PATH_INFO'] ) )
$path = $_SERVER['ORIG_PATH_INFO'];
else
- $path = $_SERVER['PATH_INFO'];
+ $path = $_SERVER['PATH_INFO'];
$method = $_SERVER['REQUEST_METHOD'];
$this->not_found();
}
+ /**
+ * Retrieve XML for ATOMPUB service.
+ *
+ * @since 2.2.0
+ */
function get_service() {
log_app('function','get_service()');
$this->output($service_doc, $this->SERVICE_CONTENT_TYPE);
}
+ /**
+ * Retrieve categories list in XML format.
+ *
+ * @since 2.2.0
+ */
function get_categories_xml() {
log_app('function','get_categories_xml()');
$this->output($output, $this->CATEGORIES_CONTENT_TYPE);
}
- /*
- * Create Post (No arguments)
+ /**
+ * Create new post.
+ *
+ * @since 2.2.0
*/
function create_post() {
global $blog_id, $user_ID;
$this->created($postID, $output);
}
+ /**
+ * Retrieve post.
+ *
+ * @since 2.2.0
+ *
+ * @param int $postID Post ID.
+ */
function get_post($postID) {
global $entry;
}
+ /**
+ * Update post.
+ *
+ * @since 2.2.0
+ *
+ * @param int $postID Post ID.
+ */
function put_post($postID) {
// checked for valid content-types (atom+xml)
// quick check and exit
$this->ok();
}
+ /**
+ * Remove post.
+ *
+ * @since 2.2.0
+ *
+ * @param int $postID Post ID.
+ */
function delete_post($postID) {
// check for not found
}
- function get_attachment($postID = NULL) {
+ /**
+ * Retrieve attachment.
+ *
+ * @since 2.2.0
+ *
+ * @param int $postID Optional. Post ID.
+ */
+ function get_attachment($postID = null) {
if( !current_user_can( 'upload_files' ) )
$this->auth_required( __( 'Sorry, you do not have permission to upload files.' ) );
}
}
+ /**
+ * Create new attachment.
+ *
+ * @since 2.2.0
+ */
function create_attachment() {
$type = $this->get_accepted_content_type();
$this->auth_required(__('You do not have permission to upload files.'));
$fp = fopen("php://input", "rb");
- $bits = NULL;
+ $bits = null;
while(!feof($fp)) {
$bits .= fread($fp, 4096);
}
log_app('function',"create_attachment($postID)");
}
+ /**
+ * Update attachment.
+ *
+ * @since 2.2.0
+ *
+ * @param int $postID Post ID.
+ */
function put_attachment($postID) {
// checked for valid content-types (atom+xml)
// quick check and exit
$this->ok();
}
+ /**
+ * Remove attachment.
+ *
+ * @since 2.2.0
+ *
+ * @param int $postID Post ID.
+ */
function delete_attachment($postID) {
log_app('function',"delete_attachment($postID). File '$location' deleted.");
$this->ok();
}
+ /**
+ * Retrieve attachment from post.
+ *
+ * @since 2.2.0
+ *
+ * @param int $postID Post ID.
+ */
function get_file($postID) {
// check for not found
exit;
}
+ /**
+ * Upload file to blog and add attachment to post.
+ *
+ * @since 2.2.0
+ *
+ * @param int $postID Post ID.
+ */
function put_file($postID) {
// first check if user can upload
$this->ok();
}
- function get_entries_url($page = NULL) {
+ /**
+ * Retrieve entries URL.
+ *
+ * @since 2.2.0
+ *
+ * @param int $page Page ID.
+ * @return string
+ */
+ function get_entries_url($page = null) {
if($GLOBALS['post_type'] == 'attachment') {
$path = $this->MEDIA_PATH;
} else {
return $url;
}
- function the_entries_url($page = NULL) {
+ /**
+ * Display entries URL.
+ *
+ * @since 2.2.0
+ *
+ * @param int $page Page ID.
+ */
+ function the_entries_url($page = null) {
echo $this->get_entries_url($page);
}
+ /**
+ * Retrieve categories URL.
+ *
+ * @since 2.2.0
+ *
+ * @param mixed $deprecated Optional, not used.
+ * @return string
+ */
function get_categories_url($deprecated = '') {
return $this->app_base . $this->CATEGORIES_PATH;
}
+ /**
+ * Display category URL.
+ *
+ * @since 2.2.0
+ */
function the_categories_url() {
echo $this->get_categories_url();
}
- function get_attachments_url($page = NULL) {
+ /**
+ * Retrieve attachment URL.
+ *
+ * @since 2.2.0
+ *
+ * @param int $page Page ID.
+ * @return string
+ */
+ function get_attachments_url($page = null) {
$url = $this->app_base . $this->MEDIA_PATH;
if(isset($page) && is_int($page)) {
$url .= "/$page";
return $url;
}
- function the_attachments_url($page = NULL) {
+ /**
+ * Display attachment URL.
+ *
+ * @since 2.2.0
+ *
+ * @param int $page Page ID.
+ */
+ function the_attachments_url($page = null) {
echo $this->get_attachments_url($page);
}
+ /**
+ * Retrieve service URL.
+ *
+ * @since 2.3.0
+ *
+ * @return string
+ */
function get_service_url() {
return $this->app_base . $this->SERVICE_PATH;
}
- function get_entry_url($postID = NULL) {
+ /**
+ * Retrieve entry URL.
+ *
+ * @since 2.7.0
+ *
+ * @param int $postID Post ID.
+ * @return string
+ */
+ function get_entry_url($postID = null) {
if(!isset($postID)) {
global $post;
$postID = (int) $post->ID;
return $url;
}
- function the_entry_url($postID = NULL) {
+ /**
+ * Display entry URL.
+ *
+ * @since 2.7.0
+ *
+ * @param int $postID Post ID.
+ */
+ function the_entry_url($postID = null) {
echo $this->get_entry_url($postID);
}
- function get_media_url($postID = NULL) {
+ /**
+ * Retrieve media URL.
+ *
+ * @since 2.2.0
+ *
+ * @param int $postID Post ID.
+ * @return string
+ */
+ function get_media_url($postID = null) {
if(!isset($postID)) {
global $post;
$postID = (int) $post->ID;
return $url;
}
- function the_media_url($postID = NULL) {
+ /**
+ * Display the media URL.
+ *
+ * @since 2.2.0
+ *
+ * @param int $postID Post ID.
+ */
+ function the_media_url($postID = null) {
echo $this->get_media_url($postID);
}
+ /**
+ * Set the current entry to post ID.
+ *
+ * @since 2.2.0
+ *
+ * @param int $postID Post ID.
+ */
function set_current_entry($postID) {
global $entry;
log_app('function',"set_current_entry($postID)");
return;
}
+ /**
+ * Display posts XML.
+ *
+ * @since 2.2.0
+ *
+ * @param int $page Optional. Page ID.
+ * @param string $post_type Optional, default is 'post'. Post Type.
+ */
function get_posts($page = 1, $post_type = 'post') {
log_app('function',"get_posts($page, '$post_type')");
$feed = $this->get_feed($page, $post_type);
$this->output($feed);
}
+ /**
+ * Display attachment XML.
+ *
+ * @since 2.2.0
+ *
+ * @param int $page Page ID.
+ * @param string $post_type Optional, default is 'attachment'. Post type.
+ */
function get_attachments($page = 1, $post_type = 'attachment') {
- log_app('function',"get_attachments($page, '$post_type')");
- $GLOBALS['post_type'] = $post_type;
- $feed = $this->get_feed($page, $post_type);
- $this->output($feed);
+ log_app('function',"get_attachments($page, '$post_type')");
+ $GLOBALS['post_type'] = $post_type;
+ $feed = $this->get_feed($page, $post_type);
+ $this->output($feed);
}
+ /**
+ * Retrieve feed XML.
+ *
+ * @since 2.2.0
+ *
+ * @param int $page Page ID.
+ * @param string $post_type Optional, default is post. Post type.
+ * @return string
+ */
function get_feed($page = 1, $post_type = 'post') {
global $post, $wp, $wp_query, $posts, $wpdb, $blog_id;
log_app('function',"get_feed($page, '$post_type')");
return $feed;
}
+ /**
+ * Display entry XML.
+ *
+ * @since 2.2.0
+ *
+ * @param int $postID Post ID.
+ * @param string $post_type Optional, default is post. Post type.
+ * @return string.
+ */
function get_entry($postID, $post_type = 'post') {
log_app('function',"get_entry($postID, '$post_type')");
ob_start();
return $entry;
}
+ /**
+ * Display post content XML.
+ *
+ * @since 2.3.0
+ */
function echo_entry() { ?>
<entry xmlns="<?php echo $this->ATOM_NS ?>"
xmlns:app="<?php echo $this->ATOMPUB_NS ?>" xml:lang="<?php echo get_option('rss_language'); ?>">
</entry>
<?php }
+ /**
+ * Set 'OK' (200) status header.
+ *
+ * @since 2.2.0
+ */
function ok() {
log_app('Status','200: OK');
header('Content-Type: text/plain');
exit;
}
+ /**
+ * Set 'No Content' (204) status header.
+ *
+ * @since 2.2.0
+ */
function no_content() {
log_app('Status','204: No Content');
header('Content-Type: text/plain');
exit;
}
+ /**
+ * Display 'Internal Server Error' (500) status header.
+ *
+ * @since 2.2.0
+ *
+ * @param string $msg Optional. Status string.
+ */
function internal_error($msg = 'Internal Server Error') {
log_app('Status','500: Server Error');
header('Content-Type: text/plain');
exit;
}
+ /**
+ * Set 'Bad Request' (400) status header.
+ *
+ * @since 2.2.0
+ */
function bad_request() {
log_app('Status','400: Bad Request');
header('Content-Type: text/plain');
exit;
}
+ /**
+ * Set 'Length Required' (411) status header.
+ *
+ * @since 2.2.0
+ */
function length_required() {
log_app('Status','411: Length Required');
header("HTTP/1.1 411 Length Required");
exit;
}
+ /**
+ * Set 'Unsupported Media Type' (415) status header.
+ *
+ * @since 2.2.0
+ */
function invalid_media() {
log_app('Status','415: Unsupported Media Type');
header("HTTP/1.1 415 Unsupported Media Type");
exit;
}
+ /**
+ * Set 'Forbidden' (403) status header.
+ *
+ * @since 2.6.0
+ */
function forbidden($reason='') {
log_app('Status','403: Forbidden');
header('Content-Type: text/plain');
exit;
}
+ /**
+ * Set 'Not Found' (404) status header.
+ *
+ * @since 2.2.0
+ */
function not_found() {
log_app('Status','404: Not Found');
header('Content-Type: text/plain');
exit;
}
+ /**
+ * Set 'Not Allowed' (405) status header.
+ *
+ * @since 2.2.0
+ */
function not_allowed($allow) {
log_app('Status','405: Not Allowed');
header('Allow: ' . join(',', $allow));
exit;
}
+ /**
+ * Display Redirect (302) content and set status headers.
+ *
+ * @since 2.3.0
+ */
function redirect($url) {
log_app('Status','302: Redirect');
}
-
+ /**
+ * Set 'Client Error' (400) status header.
+ *
+ * @since 2.2.0
+ */
function client_error($msg = 'Client Error') {
log_app('Status','400: Client Error');
header('Content-Type: text/plain');
exit;
}
+ /**
+ * Set created status headers (201).
+ *
+ * Sets the 'content-type', 'content-location', and 'location'.
+ *
+ * @since 2.2.0
+ */
function created($post_ID, $content, $post_type = 'post') {
log_app('created()::$post_ID',"$post_ID, $post_type");
$edit = $this->get_entry_url($post_ID);
exit;
}
+ /**
+ * Set 'Auth Required' (401) headers.
+ *
+ * @since 2.2.0
+ *
+ * @param string $msg Status header content and HTML content.
+ */
function auth_required($msg) {
log_app('Status','401: Auth Required');
nocache_headers();
header('WWW-Authenticate: Basic realm="WordPress Atom Protocol"');
header("HTTP/1.1 401 $msg");
- header('Status: ' . $msg);
+ header('Status: 401 ' . $msg);
header('Content-Type: text/html');
$content = <<<EOD
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
exit;
}
+ /**
+ * Display XML and set headers with content type.
+ *
+ * @since 2.2.0
+ *
+ * @param string $xml Display feed content.
+ * @param string $ctype Optional, default is 'atom+xml'. Feed content type.
+ */
function output($xml, $ctype = 'application/atom+xml') {
status_header('200');
$xml = '<?xml version="1.0" encoding="' . strtolower(get_option('blog_charset')) . '"?>'."\n".$xml;
exit;
}
+ /**
+ * Sanitize content for database usage.
+ *
+ * @since 2.2.0
+ *
+ * @param array $array Sanitize array and multi-dimension array.
+ */
function escape(&$array) {
global $wpdb;
}
}
- /*
- * Access credential through various methods and perform login
+ /**
+ * Access credential through various methods and perform login.
+ *
+ * @since 2.2.0
+ *
+ * @return bool
*/
function authenticate() {
log_app("authenticate()",print_r($_ENV, true));
if(isset($_SERVER['HTTP_AUTHORIZATION'])) {
list($_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW']) =
explode(':', base64_decode(substr($_SERVER['HTTP_AUTHORIZATION'], 6)));
+ } else if (isset($_SERVER['REDIRECT_REMOTE_USER'])) {
+ // Workaround for setups that do not forward HTTP_AUTHORIZATION
+ // See http://trac.wordpress.org/ticket/7361
+ list($_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW']) =
+ explode(':', base64_decode(substr($_SERVER['REDIRECT_REMOTE_USER'], 6)));
}
// If Basic Auth is working...
return false;
}
- function get_accepted_content_type($types = NULL) {
+ /**
+ * Retrieve accepted content types.
+ *
+ * @since 2.2.0
+ *
+ * @param array $types Optional. Content Types.
+ * @return string
+ */
+ function get_accepted_content_type($types = null) {
if(!isset($types)) {
$types = $this->media_content_types;
$this->invalid_media();
}
+ /**
+ * Process conditionals for posts.
+ *
+ * @since 2.2.0
+ */
function process_conditionals() {
if(empty($this->params)) return;
}
}
+ /**
+ * Convert RFC3339 time string to timestamp.
+ *
+ * @since 2.3.0
+ *
+ * @param string $str String to time.
+ * @return bool|int false if format is incorrect.
+ */
function rfc3339_str2time($str) {
- $match = false;
- if(!preg_match("/(\d{4}-\d{2}-\d{2})T(\d{2}\:\d{2}\:\d{2})\.?\d{0,3}(Z|[+-]+\d{2}\:\d{2})/", $str, $match))
+ $match = false;
+ if(!preg_match("/(\d{4}-\d{2}-\d{2})T(\d{2}\:\d{2}\:\d{2})\.?\d{0,3}(Z|[+-]+\d{2}\:\d{2})/", $str, $match))
return false;
- if($match[3] == 'Z')
+ if($match[3] == 'Z')
$match[3] == '+0000';
- return strtotime($match[1] . " " . $match[2] . " " . $match[3]);
+ return strtotime($match[1] . " " . $match[2] . " " . $match[3]);
}
+ /**
+ * Retrieve published time to display in XML.
+ *
+ * @since 2.3.0
+ *
+ * @param string $published Time string.
+ * @return string
+ */
function get_publish_time($published) {
- $pubtime = $this->rfc3339_str2time($published);
+ $pubtime = $this->rfc3339_str2time($published);
- if(!$pubtime) {
+ if(!$pubtime) {
return array(current_time('mysql'),current_time('mysql',1));
- } else {
+ } else {
return array(date("Y-m-d H:i:s", $pubtime), gmdate("Y-m-d H:i:s", $pubtime));
- }
+ }
}
}
+/**
+ * AtomServer
+ * @var AtomServer
+ * @global object $server
+ */
$server = new AtomServer();
$server->handle_request();