woocommerce/includes/wc-rest-functions.php

318 lines
9.3 KiB
PHP
Raw Normal View History

2016-03-01 22:41:59 +00:00
<?php
/**
2016-03-29 22:52:24 +00:00
* WooCommerce REST Functions
2016-03-01 22:41:59 +00:00
*
2016-03-29 22:52:24 +00:00
* Functions for REST specific things.
2016-03-01 22:41:59 +00:00
*
* @author WooThemes
* @category Core
* @package WooCommerce/Functions
* @version 2.6.0
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Parses and formats a MySQL datetime (Y-m-d H:i:s) for ISO8601/RFC3339.
*
* Requered WP 4.4 or later.
* See https://developer.wordpress.org/reference/functions/mysql_to_rfc3339/
*
2016-03-03 21:42:40 +00:00
* @since 2.6.0
* @param string $date
2016-03-01 22:41:59 +00:00
* @return string|null ISO8601/RFC3339 formatted datetime.
*/
function wc_rest_prepare_date_response( $date ) {
2016-03-01 22:41:59 +00:00
// Check if mysql_to_rfc3339 exists first!
if ( ! function_exists( 'mysql_to_rfc3339' ) ) {
return null;
}
// Return null if $date is empty/zeros.
if ( '0000-00-00 00:00:00' === $date ) {
2016-03-01 22:41:59 +00:00
return null;
}
// Return the formatted datetime.
return mysql_to_rfc3339( $date );
2016-03-01 22:41:59 +00:00
}
2016-03-03 21:42:40 +00:00
/**
* Returns image mime types users are allowed to upload via the API.
* @since 2.6.4
* @return array
*/
function wc_rest_allowed_image_mime_types() {
return apply_filters( 'woocommerce_rest_allowed_image_mime_types', array(
'jpg|jpeg|jpe' => 'image/jpeg',
'gif' => 'image/gif',
'png' => 'image/png',
'bmp' => 'image/bmp',
'tiff|tif' => 'image/tiff',
'ico' => 'image/x-icon',
) );
}
2016-03-03 21:42:40 +00:00
/**
* Upload image from URL.
*
* @since 2.6.0
* @param string $image_url
* @return array|WP_Error Attachment data or error message.
*/
2016-03-29 22:54:37 +00:00
function wc_rest_upload_image_from_url( $image_url ) {
$file_name = basename( current( explode( '?', $image_url ) ) );
$parsed_url = @parse_url( $image_url );
2016-03-03 21:42:40 +00:00
// Check parsed URL.
if ( ! $parsed_url || ! is_array( $parsed_url ) ) {
2016-04-05 19:58:18 +00:00
return new WP_Error( 'woocommerce_rest_invalid_image_url', sprintf( __( 'Invalid URL %s.', 'woocommerce' ), $image_url ), array( 'status' => 400 ) );
2016-03-03 21:42:40 +00:00
}
// Ensure url is valid.
2016-04-05 19:58:18 +00:00
$image_url = esc_url_raw( $image_url );
2016-03-03 21:42:40 +00:00
// Get the file.
$response = wp_safe_remote_get( $image_url, array(
'timeout' => 10
) );
2016-06-16 22:26:27 +00:00
if ( is_wp_error( $response ) ) {
2016-06-20 20:43:09 +00:00
return new WP_Error( 'woocommerce_rest_invalid_remote_image_url', sprintf( __( 'Error getting remote image %s.', 'woocommerce' ), $image_url ) . ' ' . sprintf( __( 'Error: %s.', 'woocommerce' ), $response->get_error_message() ), array( 'status' => 400 ) );
2016-06-16 22:26:27 +00:00
} elseif ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
2016-06-20 20:43:09 +00:00
return new WP_Error( 'woocommerce_rest_invalid_remote_image_url', sprintf( __( 'Error getting remote image %s.', 'woocommerce' ), $image_url ), array( 'status' => 400 ) );
2016-03-03 21:42:40 +00:00
}
// Ensure we have a file name and type.
$wp_filetype = wp_check_filetype( $file_name, wc_rest_allowed_image_mime_types() );
2016-03-03 21:42:40 +00:00
if ( ! $wp_filetype['type'] ) {
$headers = wp_remote_retrieve_headers( $response );
if ( isset( $headers['content-disposition'] ) && strstr( $headers['content-disposition'], 'filename=' ) ) {
$disposition = end( explode( 'filename=', $headers['content-disposition'] ) );
$disposition = sanitize_file_name( $disposition );
$file_name = $disposition;
} elseif ( isset( $headers['content-type'] ) && strstr( $headers['content-type'], 'image/' ) ) {
$file_name = 'image.' . str_replace( 'image/', '', $headers['content-type'] );
}
unset( $headers );
// Recheck filetype
$wp_filetype = wp_check_filetype( $file_name, wc_rest_allowed_image_mime_types() );
if ( ! $wp_filetype['type'] ) {
return new WP_Error( 'woocommerce_rest_invalid_image_type', __( 'Invalid image type.', 'woocommerce' ), array( 'status' => 400 ) );
}
2016-03-03 21:42:40 +00:00
}
// Upload the file.
$upload = wp_upload_bits( $file_name, '', wp_remote_retrieve_body( $response ) );
if ( $upload['error'] ) {
return new WP_Error( 'woocommerce_rest_image_upload_error', $upload['error'], array( 'status' => 400 ) );
}
// Get filesize.
$filesize = filesize( $upload['file'] );
if ( 0 == $filesize ) {
@unlink( $upload['file'] );
unset( $upload );
2016-04-05 19:58:18 +00:00
return new WP_Error( 'woocommerce_rest_image_upload_file_error', __( 'Zero size file downloaded.', 'woocommerce' ), array( 'status' => 400 ) );
2016-03-03 21:42:40 +00:00
}
do_action( 'woocommerce_rest_api_uploaded_image_from_url', $upload, $image_url );
return $upload;
}
/**
* Set uploaded image as attachment.
*
* @since 2.6.0
* @param array $upload Upload information from wp_upload_bits.
* @param int $id Post ID. Default to 0.
* @return int Attachment ID
*/
2016-03-29 22:54:37 +00:00
function wc_rest_set_uploaded_image_as_attachment( $upload, $id = 0 ) {
2016-03-03 21:42:40 +00:00
$info = wp_check_filetype( $upload['file'] );
$title = '';
$content = '';
2016-03-07 17:39:42 +00:00
if ( ! function_exists( 'wp_generate_attachment_metadata' ) ) {
include_once( ABSPATH . 'wp-admin/includes/image.php' );
}
if ( $image_meta = wp_read_image_metadata( $upload['file'] ) ) {
2016-03-03 21:42:40 +00:00
if ( trim( $image_meta['title'] ) && ! is_numeric( sanitize_title( $image_meta['title'] ) ) ) {
2016-07-19 17:24:11 +00:00
$title = wc_clean( $image_meta['title'] );
2016-03-03 21:42:40 +00:00
}
if ( trim( $image_meta['caption'] ) ) {
2016-07-19 17:24:11 +00:00
$content = wc_clean( $image_meta['caption'] );
2016-03-03 21:42:40 +00:00
}
}
$attachment = array(
'post_mime_type' => $info['type'],
'guid' => $upload['url'],
'post_parent' => $id,
'post_title' => $title,
2016-04-05 19:58:18 +00:00
'post_content' => $content,
2016-03-03 21:42:40 +00:00
);
$attachment_id = wp_insert_attachment( $attachment, $upload['file'], $id );
if ( ! is_wp_error( $attachment_id ) ) {
wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $upload['file'] ) );
}
return $attachment_id;
}
2016-03-10 02:19:36 +00:00
/**
* Validate reports request arguments.
*
* @since 2.6.0
* @param mixed $value
* @param WP_REST_Request $request
* @param string $param
* @return WP_Error|boolean
*/
2016-03-29 22:54:37 +00:00
function wc_rest_validate_reports_request_arg( $value, $request, $param ) {
2016-03-10 02:19:36 +00:00
$attributes = $request->get_attributes();
if ( ! isset( $attributes['args'][ $param ] ) || ! is_array( $attributes['args'][ $param ] ) ) {
return true;
}
$args = $attributes['args'][ $param ];
if ( 'string' === $args['type'] && ! is_string( $value ) ) {
return new WP_Error( 'woocommerce_rest_invalid_param', sprintf( __( '%1$s is not of type %2$s', 'woocommerce' ), $param, 'string' ) );
2016-03-10 02:19:36 +00:00
}
if ( 'date' === $args['format'] ) {
2016-03-10 02:19:36 +00:00
$regex = '#^\d{4}-\d{2}-\d{2}$#';
if ( ! preg_match( $regex, $value, $matches ) ) {
return new WP_Error( 'woocommerce_rest_invalid_date', __( 'The date you provided is invalid.', 'woocommerce' ) );
}
}
return true;
}
/**
* Encodes a value according to RFC 3986.
* Supports multidimensional arrays.
*
* @since 2.6.0
* @param string|array $value The value to encode.
* @return string|array Encoded values.
*/
function wc_rest_urlencode_rfc3986( $value ) {
if ( is_array( $value ) ) {
return array_map( 'wc_rest_urlencode_rfc3986', $value );
} else {
// Percent symbols (%) must be double-encoded.
return str_replace( '%', '%25', rawurlencode( rawurldecode( $value ) ) );
}
}
2016-03-30 14:17:16 +00:00
/**
* Check permissions of posts on REST API.
*
* @since 2.6.0
* @param string $post_type Post type.
* @param string $context Request context.
* @param int $object_id Post ID.
* @return bool
*/
function wc_rest_check_post_permissions( $post_type, $context = 'read', $object_id = 0 ) {
$contexts = array(
'read' => 'read_private_posts',
'create' => 'publish_posts',
'edit' => 'edit_post',
'delete' => 'delete_post',
'batch' => 'edit_others_posts',
2016-03-30 14:17:16 +00:00
);
if ( 'revision' === $post_type ) {
$permission = false;
} else {
$cap = $contexts[ $context ];
$post_type_object = get_post_type_object( $post_type );
$permission = current_user_can( $post_type_object->cap->$cap, $object_id );
}
2016-03-30 17:17:40 +00:00
return apply_filters( 'woocommerce_rest_check_permissions', $permission, $context, $object_id, $post_type );
2016-03-30 14:17:16 +00:00
}
2016-03-30 14:53:14 +00:00
/**
* Check permissions of users on REST API.
*
* @since 2.6.0
* @param string $context Request context.
* @param int $object_id Post ID.
* @return bool
*/
function wc_rest_check_user_permissions( $context = 'read', $object_id = 0 ) {
$contexts = array(
'read' => 'list_users',
'create' => 'edit_users',
'edit' => 'edit_users',
'delete' => 'delete_users',
'batch' => 'edit_users',
2016-03-30 14:53:14 +00:00
);
$permission = current_user_can( $contexts[ $context ], $object_id );
2016-03-30 17:17:40 +00:00
return apply_filters( 'woocommerce_rest_check_permissions', $permission, $context, $object_id, 'user' );
}
/**
* Check permissions of product terms on REST API.
*
* @since 2.6.0
* @param string $taxonomy Taxonomy.
* @param string $context Request context.
* @param int $object_id Post ID.
* @return bool
*/
function wc_rest_check_product_term_permissions( $taxonomy, $context = 'read', $object_id = 0 ) {
$contexts = array(
'read' => 'manage_terms',
'create' => 'edit_terms',
'edit' => 'edit_terms',
'delete' => 'delete_terms',
'batch' => 'edit_terms',
2016-03-30 17:17:40 +00:00
);
$cap = $contexts[ $context ];
$taxonomy_object = get_taxonomy( $taxonomy );
$permission = current_user_can( $taxonomy_object->cap->$cap, $object_id );
return apply_filters( 'woocommerce_rest_check_permissions', $permission, $context, $object_id, $taxonomy );
2016-03-30 14:53:14 +00:00
}
2016-03-30 17:33:33 +00:00
/**
* Check manager permissions on REST API.
*
* @since 2.6.0
* @param string $object Object.
* @param string $context Request context.
* @return bool
*/
function wc_rest_check_manager_permissions( $object, $context = 'read' ) {
$objects = array(
2016-03-30 17:49:22 +00:00
'reports' => 'view_woocommerce_reports',
'settings' => 'manage_woocommerce',
'attributes' => 'manage_product_terms',
2016-03-30 17:33:33 +00:00
);
$permission = current_user_can( $objects[ $object ] );
return apply_filters( 'woocommerce_rest_check_permissions', $permission, $context, 0, $object );
}