Index: wp-app.php =================================================================== --- wp-app.php (revision 8952) +++ wp-app.php (working copy) @@ -46,8 +46,9 @@ $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 @@ -67,16 +68,7 @@ if ( !function_exists('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; @@ -93,8 +85,10 @@ /** * 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); @@ -112,29 +106,142 @@ */ 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'])); @@ -169,6 +276,11 @@ ); } + /** + * Handle ATOMPUB request. + * + * @since 2.2.0 + */ function handle_request() { global $always_authenticate; @@ -226,6 +338,11 @@ $this->not_found(); } + /** + * Retrieve XML for ATOMPUB service. + * + * @since 2.2.0 + */ function get_service() { log_app('function','get_service()'); @@ -261,6 +378,11 @@ $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()'); @@ -284,8 +406,10 @@ $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; @@ -357,6 +481,13 @@ $this->created($postID, $output); } + /** + * Retrieve post. + * + * @since 2.2.0 + * + * @param int $postID Post ID. + */ function get_post($postID) { global $entry; @@ -370,6 +501,13 @@ } + /** + * 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 @@ -419,6 +557,13 @@ $this->ok(); } + /** + * Remove post. + * + * @since 2.2.0 + * + * @param int $postID Post ID. + */ function delete_post($postID) { // check for not found @@ -444,7 +589,14 @@ } - 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.' ) ); @@ -458,6 +610,11 @@ } } + /** + * Create new attachment. + * + * @since 2.2.0 + */ function create_attachment() { $type = $this->get_accepted_content_type(); @@ -466,7 +623,7 @@ $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); } @@ -512,6 +669,13 @@ 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 @@ -552,6 +716,13 @@ $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."); @@ -583,6 +754,13 @@ $this->ok(); } + /** + * Retrieve attachment from post. + * + * @since 2.2.0 + * + * @param int $postID Post ID. + */ function get_file($postID) { // check for not found @@ -614,6 +792,13 @@ 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 @@ -662,7 +847,15 @@ $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 { @@ -675,19 +868,47 @@ 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"; @@ -695,15 +916,37 @@ 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; @@ -715,11 +958,26 @@ 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; @@ -731,10 +989,24 @@ 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)"); @@ -752,19 +1024,44 @@ 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')"); @@ -822,6 +1119,15 @@ 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(); @@ -849,6 +1155,11 @@ return $entry; } + /** + * Display post content XML. + * + * @since 2.3.0 + */ function echo_entry() { ?> @@ -886,6 +1197,11 @@ get_entry_url($post_ID); @@ -1006,6 +1380,13 @@ 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(); @@ -1030,6 +1411,14 @@ 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 = ''."\n".$xml; @@ -1044,6 +1433,13 @@ exit; } + /** + * Sanitize content for database usage. + * + * @since 2.2.0 + * + * @param array $array Sanitize array and multi-dimension array. + */ function escape(&$array) { global $wpdb; @@ -1058,8 +1454,12 @@ } } - /* - * 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)); @@ -1085,7 +1485,15 @@ 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; @@ -1111,6 +1519,11 @@ $this->invalid_media(); } + /** + * Process conditionals for posts. + * + * @since 2.2.0 + */ function process_conditionals() { if(empty($this->params)) return; @@ -1154,31 +1567,52 @@ } } + /** + * 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();