class.videopress-cli.php — Jetpack – WP Security, Backup, Speed, & Growth 12.1.3

jetpack / modules / videopress / class.videopress-cli.php

jetpack / modules / videopress Last commit date

class.videopress-cli.php

190 lines

1	<?php // phpcs:ignore WordPress.Files.FileName
2	/**
3	* VideoPress CLI
4	*
5	* @package automattic/jetpack
6	*/
7
8	if ( defined( 'WP_CLI' ) && WP_CLI ) {
9
10	/**
11	* VideoPress command line utilities.
12	*/
13	class VideoPress_CLI extends WP_CLI_Command {
14	/**
15	* Import a VideoPress Video
16	*
17	* ## OPTIONS
18	*
19	* <guid>: Import the video with the specified guid
20	*
21	* ## EXAMPLES
22	*
23	* wp videopress import kUJmAcSf
24	*
25	* @param array $args CLI arguments.
26	*/
27	public function import( $args ) {
28	$guid = $args[0];
29	$attachment_id = create_local_media_library_for_videopress_guid( $guid );
30	if ( $attachment_id && ! is_wp_error( $attachment_id ) ) {
31	/* translators: %d: attachment id */
32	WP_CLI::success( sprintf( __( 'The video has been imported as Attachment ID %d', 'jetpack' ), $attachment_id ) );
33	} else {
34	WP_CLI::error( __( 'An error has been encountered.', 'jetpack' ) );
35	}
36	}
37
38	/**
39	* Manually runs the job to cleanup videos from the media library that failed during the upload process.
40	*
41	* ## EXAMPLES
42	*
43	* wp videopress cleanup_videos
44	*/
45	public function cleanup_videos() {
46	$num_cleaned = videopress_cleanup_media_library();
47
48	/* translators: %d: number of videos cleaned */
49	WP_CLI::success( sprintf( _n( 'Cleaned up %d video.', 'Cleaned up a total of %d videos.', $num_cleaned, 'jetpack' ), $num_cleaned ) );
50	}
51
52	/**
53	* List out all of the crons that can be run.
54	*
55	* ## EXAMPLES
56	*
57	* wp videopress list_crons
58	*/
59	public function list_crons() {
60
61	$scheduler = VideoPress_Scheduler::init();
62	$crons = $scheduler->get_crons();
63
64	$schedules = wp_get_schedules();
65
66	if ( count( $crons ) === 0 ) {
67	WP_CLI::success( __( 'Found no available cron jobs.', 'jetpack' ) );
68
69	} else {
70	/* translators: %d is the number of crons */
71	WP_CLI::success( sprintf( _n( 'Found %d available cron job.', 'Found %d available cron jobs.', count( $crons ), 'jetpack' ), count( $crons ) ) );
72	}
73
74	foreach ( $crons as $cron_name => $cron ) {
75	$interval = isset( $schedules[ $cron['interval'] ]['display'] ) ? $schedules[ $cron['interval'] ]['display'] : $cron['interval'];
76	$runs_next = $scheduler->check_cron( $cron_name );
77	$status = $runs_next ? sprintf( 'Scheduled - Runs Next at %s GMT', gmdate( 'Y-m-d H:i:s', $runs_next ) ) : 'Not Scheduled';
78
79	WP_CLI::log( 'Name: ' . $cron_name );
80	WP_CLI::log( 'Method: ' . $cron['method'] );
81	WP_CLI::log( 'Interval: ' . $interval );
82	WP_CLI::log( 'Status: ' . $status );
83	}
84	}
85
86	/**
87	* Checks for the current status of a cron job.
88	*
89	* ## OPTIONS
90	*
91	* <cron_name>: The name of the cron job to check
92	*
93	* ## EXAMPLES
94	*
95	* wp videopress cron_status cleanup
96	*
97	* @param array $args CLI args.
98	*/
99	public function cron_status( $args ) {
100
101	if ( ! isset( $args[0] ) ) {
102	return WP_CLI::error( __( 'You need to provide the name of the cronjob to schedule.', 'jetpack' ) );
103	}
104
105	$scheduler = VideoPress_Scheduler::init();
106
107	if ( ! $scheduler->is_cron_valid( $args[0] ) ) {
108	/* translators: name of a cron job */
109	WP_CLI::error( sprintf( __( 'There is no cron named %s.', 'jetpack' ), $args[0] ) );
110	}
111
112	$time = $scheduler->check_cron( $args[0] );
113
114	if ( ! $time ) {
115	WP_CLI::success( __( 'The cron is not scheduled to run.', 'jetpack' ) );
116
117	} else {
118	/* translators: date/time */
119	WP_CLI::success( sprintf( __( 'Cron will run at: %s GMT', 'jetpack' ), gmdate( 'Y-m-d H:i:s', $time ) ) );
120	}
121	}
122
123	/**
124	* Actives the given cron job
125	*
126	* ## OPTIONS
127	*
128	* <cron_name>: The name of the cron job to check
129	*
130	* ## EXAMPLES
131	*
132	* wp videopress activate_cron cleanup
133	*
134	* @param array $args CLI args.
135	*/
136	public function activate_cron( $args ) {
137
138	if ( ! isset( $args[0] ) ) {
139	WP_CLI::error( __( 'You need to provide the name of the cronjob to schedule.', 'jetpack' ) );
140	}
141
142	$scheduler = VideoPress_Scheduler::init();
143
144	if ( ! $scheduler->is_cron_valid( $args[0] ) ) {
145	/* translators: name of a cron job */
146	WP_CLI::error( sprintf( __( 'There is no cron named %s.', 'jetpack' ), $args[0] ) );
147	}
148
149	$scheduler->activate_cron( $args[0] );
150
151	/* translators: name of a cron job */
152	WP_CLI::success( sprintf( __( 'The cron named `%s` was scheduled.', 'jetpack' ), $args[0] ) );
153	}
154
155	/**
156	* Actives the given cron job
157	*
158	* ## OPTIONS
159	*
160	* <cron_name>: The name of the cron job to check
161	*
162	* ## EXAMPLES
163	*
164	* wp videopress deactivate_cron cleanup
165	*
166	* @param array $args CLI args.
167	*/
168	public function deactivate_cron( $args ) {
169
170	if ( ! isset( $args[0] ) ) {
171	WP_CLI::error( __( 'You need to provide the name of the cronjob to schedule.', 'jetpack' ) );
172	}
173
174	$scheduler = VideoPress_Scheduler::init();
175
176	if ( ! $scheduler->is_cron_valid( $args[0] ) ) {
177	/* translators: name of a cron job */
178	WP_CLI::error( sprintf( __( 'There is no cron named %s.', 'jetpack' ), $args[0] ) );
179	}
180
181	$scheduler->deactivate_cron( $args[0] );
182
183	/* translators: name of a cron job */
184	WP_CLI::success( sprintf( __( 'The cron named `%s` was removed from the schedule.', 'jetpack' ), $args[0] ) );
185	}
186	}
187
188	WP_CLI::add_command( 'videopress', 'VideoPress_CLI' );
189	}
190