Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add crop command #236

Merged
merged 7 commits into from
Oct 28, 2020
Merged

feat: add crop command #236

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
52641e2
feat: add crop command
dinhtungdu Oct 19, 2020
006628b
refactor: better error reporting for crop command
dinhtungdu Oct 19, 2020
8b989e6
fix: better error code naming
dinhtungdu Oct 19, 2020
807b476
Update ClassifaiCommand.php
jeffpaul Oct 26, 2020
f68f047
Merge branch 'develop' into fix/176
jeffpaul Oct 26, 2020
25bb9c7
fix: keep current behavior of image command
dinhtungdu Oct 28, 2020
1e4a0be
Merge branch 'develop' into fix/176
jeffpaul Oct 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 109 additions & 6 deletions includes/Classifai/Command/ClassifaiCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use Classifai\Watson\Normalizer;
use Classifai\PostClassifier;
use Classifai\Providers\Azure\ComputerVision;
use Classifai\Providers\Azure\SmartCropping;

/**
* ClassifaiCommand is the command line interface of the ClassifAI plugin.
Expand Down Expand Up @@ -253,8 +254,9 @@ public function image( $args = [], $opts = [] ) {
$limit_total = min( $total, intval( $opts['limit'] ) );
}

$errors = [];
$message = "Classifying $limit_total images ...";
$errors = [];
$message = "Classifying $limit_total images ...";

$progress_bar = \WP_CLI\Utils\make_progress_bar( $message, $limit_total );

for ( $index = 0; $index < $limit_total; $index++ ) {
Expand All @@ -263,9 +265,7 @@ public function image( $args = [], $opts = [] ) {
$progress_bar->tick();

$current_meta = wp_get_attachment_metadata( $attachment_id );
\WP_CLI::line( 'Processing ' . $attachment_id );
$classifier->generate_image_alt_tags( $current_meta, $attachment_id );
$classifier->smart_crop_image( $current_meta, $attachment_id );
}

$progress_bar->finish();
Expand All @@ -280,6 +280,109 @@ public function image( $args = [], $opts = [] ) {
}
}

/**
* Batch crop image(s).
*
* ## Options
*
* [<attachment_ids>]
* : Comma delimited Attachment IDs to crop.
*
* [--limit=<limit>]
* : Limit classification to N attachments. Default 100.
*
* [--skip=<skip>]
* : Skip first N attachments. Default false.
*
* @param array $args Arguments.
* @param array $opts Options.
*/
public function crop( $args = [], $opts = [] ) {
$classifier = new ComputerVision( false );
$settings = $classifier->get_settings();
$smart_cropping = new SmartCropping( $settings );

if ( ! isset( $settings['enable_smart_cropping'] ) || '1' !== $settings['enable_smart_cropping'] ) {
dkotter marked this conversation as resolved.
Show resolved Hide resolved
\WP_CLI::error( 'Smart Cropping is disabled. Enable it in Image settings to use this command.' );
}

$default_opts = [
'limit' => false,
];

$opts = wp_parse_args( $opts, $default_opts );

if ( ! empty( $args[0] ) ) {
$attachment_ids = explode( ',', $args[0] );
} else {
$attachment_ids = $this->get_attachment_to_classify( array_merge( $opts, [ 'force' => true ] ) );
}

$total = count( $attachment_ids );

if ( empty( $total ) ) {
return \WP_CLI::log( 'No images to crop.' );
}

$limit_total = $total;
if ( $opts['limit'] ) {
$limit_total = min( $total, intval( $opts['limit'] ) );
}

$errors = [];
$message = "Cropping $limit_total images ...";

$progress_bar = \WP_CLI\Utils\make_progress_bar( $message, $limit_total );

for ( $index = 0; $index < $limit_total; $index++ ) {
$attachment_id = $attachment_ids[ $index ];

$progress_bar->tick();

$current_meta = wp_get_attachment_metadata( $attachment_id );

foreach ( $current_meta['sizes'] as $size => $size_data ) {
if ( ! $smart_cropping->should_crop( $size ) ) {
continue;
}

$data = [
'width' => $size_data['width'],
'height' => $size_data['height'],
];

$smart_thumbnail = $smart_cropping->get_cropped_thumbnail( $attachment_id, $data );

if ( is_wp_error( $smart_thumbnail ) ) {
$errors[ $attachment_id . ':' . $size_data['width'] . 'x' . $size_data['height'] ] = $smart_thumbnail;
}
}
}

$progress_bar->finish();

$total_errors = count( $errors );
$total_success = $total - $total_errors;

foreach ( $errors as $attachment_id => $error ) {
\WP_CLI::log(
sprintf(
'%1$s: %2$s (%3$s).',
$attachment_id,
$error->get_error_message(),
$error->get_error_code()
)
);
}

if ( $total_success > 0 ) {
\WP_CLI::success( "Cropped $total_success images, $total_errors errors." );
} else {
\WP_CLI::error( "Cropped $total_success images, $total_errors errors." );
}

}

/**
* Prints the Basic Auth header based on credentials configured in
* the plugin.
Expand Down Expand Up @@ -391,12 +494,12 @@ private function get_attachment_to_classify( $opts = [] ) {
];
}

\WP_CLI::log( 'Fetching images to classify ...' );
\WP_CLI::log( 'Fetching images ...' );

$query = new \WP_Query( $query_params );
$images = $query->posts;

\WP_CLI::log( 'Fetching images to classify ... DONE (' . count( $images ) . ')' );
\WP_CLI::log( 'Fetching images ... DONE (' . count( $images ) . ')' );

return $images;
}
Expand Down
22 changes: 20 additions & 2 deletions includes/Classifai/Providers/Azure/SmartCropping.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,8 @@ public function generate_attachment_metadata( $metadata, $attachment_id ) {
];

$better_thumb_filename = $this->get_cropped_thumbnail( $attachment_id, $data );
if ( ! empty( $better_thumb_filename ) ) {

if ( ! empty( $better_thumb_filename ) && ! is_wp_error( $better_thumb_filename ) ) {
$metadata['sizes'][ $size ]['file'] = basename( $better_thumb_filename );
}
}
Expand Down Expand Up @@ -235,6 +236,11 @@ public function get_cropped_thumbnail( $attachment_id, $size_data ) {

$new_thumb_image = $this->request_cropped_thumbnail( $data );
set_transient( 'classifai_azure_computer_vision_smart_cropping_latest_response', $new_thumb_image, DAY_IN_SECONDS * 30 );

if ( is_wp_error( $new_thumb_image ) ) {
return $new_thumb_image;
}

if ( empty( $new_thumb_image ) ) {
return false;
}
Expand Down Expand Up @@ -334,10 +340,14 @@ public function request_cropped_thumbnail( $data ) {
*/
do_action( 'classifai_smart_cropping_after_request', $response, $url, $data );

$response_body = wp_remote_retrieve_body( $response );

if ( 200 === wp_remote_retrieve_response_code( $response ) ) {
return wp_remote_retrieve_body( $response );
return $response_body;
}

$response_json = json_decode( $response_body );

/**
* Fires when the generateThumbnail smart-cropping API response did not have a 200 status code.
*
Expand All @@ -350,6 +360,14 @@ public function request_cropped_thumbnail( $data ) {
*/
do_action( 'classifai_smart_cropping_unsuccessful_response', $response, $url, $data );

if ( ! empty( $response_json->code ) ) {
return new \WP_Error( $response_json->code, $response_json->message );
}

if ( ! empty( $response_json->errors ) ) {
return new \WP_Error( 'classifai_smart_cropping_api_validation_errors', implode( ' ', $response_json->errors->smartCropping ) );
}

return false;
}
}