-
Notifications
You must be signed in to change notification settings - Fork 25
/
deploy.php
916 lines (785 loc) · 24.3 KB
/
deploy.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
<?php
if ( ! defined( 'WP_CLI' ) ) return;
require 'helpers.php';
require 'runner.php';
use \WP_Deploy_Command\Helpers as Util;
use \WP_Deploy_Command\Command_Runner as Runner;
/**
* __Current Version__: 1.1.0-beta
*
* Deploys the local WordPress database or the uploads, plugins, or themes directories.
*
* The tool requires defining a set of constants in your wp-config.php file.
* The constants should be prefixed with the environment handle which you will use as the first paramater for your desired subcommand. An example configuration for a "dev" environment:
*
* ```php
* <?php
* define( 'DEV_URL', 'the-remote-website-url.com' );
* define( 'DEV_WP_PATH', '/path/to/the/wp/dir/on/the/server' );
* define( 'DEV_HOST', 'ssh_hosr' );
* define( 'DEV_USER', 'ssh_user' );
* define( 'DEV_PORT', 'ssh_port' );
* define( 'DEV_PATH', '/path/to/a/writable/dir/on/the/server' );
* define( 'DEV_UPLOADS_PATH', '/path/to/the/remote/uploads/directory' );
* define( 'DEV_DB_HOST', 'the_remote_db_host' );
* define( 'DEV_DB_NAME', 'the_remote_db_name' );
* define( 'DEV_DB_USER', 'the_remote_db_user' );
* define( 'DEV_DB_PASSWORD', 'the_remote_db_password' );
* define( 'DEV_POST_HOOK', 'echo "something to be executed when the command
* finishes"' );
* ```
*
* => `wp deploy push dev ...`
*
* Not all commands / subcommands require all constants to be defined. To test what
* a subcommand requires, execute it with a non-existing environment handle. e.g.
* `wp deploy dump johndoe`.
*
* You can define as many constant groups as deployment eviroments you wish to have.
*
* __Examples__
*
* # Deploy the local db to the staging environment
* wp deploy push staging --what=db
*
* # Pull both the production database and uploads
* wp deploy pull production --what=db && wp deploy pull production --what=uploads
*
* # Dump the local db with the siteurl replaced
* wp deploy dump andrew
*
* ### Configuration
*
* In order to be able to use the deploy command, you need to define certain
* constants in your `wp-config.php` file.
*
* #### Configuration Dependecies
*
* Subcommands depend on different constants in order to work.
* Here's the dependency list:
*
* * __`wp deploy push`__: In order to push to your server, you need to define the
* ssh credentials, and a path to a writable directory on the server. _These
* constants are needed whatever the arguments passed to the `push` subcommand_:
* * `%%ENV%%_USER`
* * `%%ENV%%_HOST`
* * `%%ENV%%_PATH`
*
* * __`wp deploy push %%env%% --what=db`__: In order to deploy the database to your
* server, you need to define the url of your WordPress website, the path to
* the WordPress code on your server, and the credentials to the database on
* the server:
* * `%%ENV%%_URL`
* * `%%ENV%%_WP_PATH`
* * `%%ENV%%_DB_HOST`
* * `%%ENV%%_DB_NAME`
* * `%%ENV%%_DB_USER`
* * `%%ENV%%_DB_PASSWORD`
*
* * __`wp deploy push %%env%% --what=uploads`__: In order to push the uploads directory,
* you need to define the path to the uploads directory on your server:
* * `%%ENV%%_UPLOADS_PATH`
*
* __`wp deploy pull`__: In order to pull to your server, you need to define the
* sh credentials constants. _These constants are needed whatever the arguments
* assed to the `pull` subcommand_:
* * `%%ENV%%_USER`
* * `%%ENV%%_HOST`
*
* * __`wp deploy pull %%env%% --what=db`__: In order to pull the database to from your
* server, you need to define the url of your remote WordPress website, the
* path to the WordPress code on your server, and the credentials to the
* database on the server:
* * `%%ENV%%_PATH`
* * `%%ENV%%_URL`
* * `%%ENV%%_WP_PATH`
* * `%%ENV%%_DB_HOST`
* * `%%ENV%%_DB_NAME`
* * `%%ENV%%_DB_USER`
* * `%%ENV%%_DB_PASSWORD`
*
* * __`wp deploy push %%env%% --what=uploads`__: As in the `push` command's case, in
* order to pull the remote server uploads, we need their path on the server.
* * `%%ENV%%_UPLOADS_PATH`
*
* * __`wp dump %%env%%`__: This subcommand only requires the path to the target
* WordPress path and its URL.
*
* #### `%%ENV%%_POST_HOOK`
*
* You can __optionally__ define a constant with bash code which is called at the
* end of the subcommand execution.
*
* You can refer to environment variables using placeholders. Some of the
* available environment variables are:
* * `env`: The environment handle
* * `command`: The subcommand (Currently `push`, `pull`, or `dump`).
* * `what`: The what argument value for the `push` or `pull` subcommand.
* * `wd`: The path to the working directory for the deploy command. This is
* the directory where the database is pulled, and other temporary files are
* created.
* * `timestamp`: The date formatted with "Y_m_d-H_i"
* * `tmp_path`: The path to the temporary files directory used by the deploy
* tool.
* * `bk_path`: The path to the backups directory used by the deploy tool.
* * `local_uploads`: The path to the local WordPress instance uploads
* directory.
* * `ssh`: The ssh server handle in the `user@host` format.
*
*
* __Example__
*
* Here's an example of a `DEV_POST_HOOK` that posts a message to a hipchat
* room after a `pull` or a `push` is performed using the HipChat REST API
* (https://github.com/hipchat/hipchat-cli).
* For pushes, it also clears the cache.
*
* ```php
* <?php
* $hipchat_message = "http://%%url%%"
* . "\njeandoe has successfully %%command%%ed %%what%%";
* $command = "if [[ '%%command%%' != 'dump' ]]; then "
* . "echo '$hipchat_message' | %%abspath%%/hipchat-cli/hipchat_room_message -t 1245678 -r 123456 -f 'WP-Cli Deploy';"
* . "fi;"
* . "if [[ '%%command%%' == 'push' ]]; then "
* . "curl -Ss http://example.com/clear_cache.php?token=12385328523;"
* . "fi;";
* define( 'DEV_POST_HOOK', $command );
* ```
*
*/
class WP_Deploy_Command extends WP_CLI_Command {
/**
* TODO 1.1.0:
* Update paths in messages to be relative to wordpress dir.
* Fix the missing path directory at push issue.
* Update doc.
* Add dry run
* Test excludes. Need to be separated by :
*/
/** The config holder. */
private static $config;
private static $env;
private static $default_verbosity;
private static $runner;
private static $config_dependencies;
public function __construct() {
if ( defined( 'WP_DEPLOY_DEBUG' ) && WP_DEPLOY_DEBUG ) {
ini_set( 'error_reporting', E_ALL & ~E_STRICT );
ini_set( 'display_errors', 'STDERR' );
}
self::$default_verbosity = 1;
/** Define the constants dependencies. */
self::$config_dependencies = array(
'push' => array(
'global' => array(
'user',
'host',
'path',
),
'db' => array(
'url',
'wp_path',
'db_host',
'db_name',
'db_user',
'db_password',
),
'uploads' => array( 'uploads_path' ),
'themes' => array( 'themes_path' ),
'plugins' => array( 'plugins_path' )
),
'pull' => array(
'global' => array(
'user',
'host',
),
'db' => array(
'path',
'url',
'wp_path',
'db_host',
'db_name',
'db_user',
'db_password',
),
'uploads' => array( 'uploads_path' ),
'themes' => array( 'themes_path' ),
'plugins' => array( 'plugins_path' )
),
'dump' => array(
'wp_path',
'url'
),
'optional' => array(
'port',
'post_hook',
'excludes'
)
);
/**
* Depending paths need to be under the
* paths they depend on.
*/
self::$config = array(
'env' => '%%env%%',
/** Constants which refer to remote. */
'host' => '%%host%%',
'user' => '%%user%%',
'path' => '%%path%%',
'url' => '%%url%%',
'wp' => '%%wp_path%%',
'uploads' => '%%uploads_path%%',
'themes' => '%%themes_path%%',
'plugins' => '%%plugins_path%%',
'db_host' => '%%db_host%%',
'db_name' => '%%db_name%%',
'db_user' => '%%db_user%%',
'db_password' => '%%db_password%%',
/** Optional */
'port' => '%%port%%',
'post_hook' => '%%post_hook%%',
'safe_mode' => '%%safe_mode%%', /** TODO */
'excludes' => '%%excludes%%',
/** Helpers which refer to local. */
'command' => '%%command%%',
'what' => '%%what%%',
'abspath' => '%%abspath%%',
'wd' => '%%abspath%%/%%env%%_%%hash%%',
'timestamp' => '%%pretty_date%%',
'tmp_path' => '%%wd%%/tmp',
'bk_path' => '%%wd%%/bk',
'tmp' => '%%tmp_path%%/%%rand%%',
'local_hostname' => '%%hostname%%',
'ssh' => '%%user%%@%%host%%',
'local_uploads' => '%%local_uploads%%',
'local_themes' => '%%local_themes%%',
'local_plugins' => '%%local_plugins%%',
'siteurl' => '%%siteurl%%',
);
}
/**
* Displays information about the current version of the deploy command.
*
* ## EXAMPLE
*
* wp deploy info
*/
public function info( $args, $assoc_args ) {
WP_CLI::line( 'WP-Cli Deploy Command: https://github.com/c10b10/wp-cli-deploy' );
WP_CLI::line( 'Supported subcommands: push, pull, dump' );
WP_CLI::line( 'Version: 1.1.0-alpha' );
WP_CLI::line( 'Author: Alex Ciobica / @ciobi' );
WP_CLI::line( 'Run "wp help deploy" for the documentation' );
}
/**
* Pushes the local database and / or uploads from local to remote.
*
* ## OPTIONS
*
* <environment>
* : The handle of of the environment. This is the prefix of the constants
* defined in wp-config.
*
* `--what`=<what>
* : What needs to be deployed on the server. Valid options are:
* db: pushes the database to the remote server
* uploads: pushes the uploads to the remote server
*
* [`--v`=<verbosity>]
* : Verbosity level. Default 1. 0 is highest and 2 is lowest.
*
* ## EXAMPLE
*
* # Push the database and the uploads for to "staging" environment.
* # You must have STAGING_* constants defined for this to work.
*
* wp deploy push staging --what=db,uploads
*
* @synopsis <environment> --what=<what> [--v=<v>]
*/
public function push( $args, $assoc_args ) {
$args = self::sanitize_args( __FUNCTION__, $args, $assoc_args );
if ( isset( $args->error ) ) {
WP_Cli::line( $args->error );
return false;
}
call_user_func( __CLASS__ . "::push_" . self::$config->what );
self::run_post_hook();
self::wow();
}
/**
* Pulls the database and / or uploads from remote to local. After pulling
* the uploads, they need to copied to the correct location.
*
* <environment>
* : The name of the environment. This is the prefix of the constants defined in
* wp-config.
*
* `--what`=<what>
* : What needs to be pulled. Valid options are:
* db: pushes the database to the remote server
* uploads: pushes the uploads to the remote server
*
* [`--v`=<verbosity>]
* : Verbosity level. Default 1. 0 is highest and 2 is lowest.
*
* ## EXAMPLES
*
* # Pulls database and uploads folder
* wp deploy pull staging --what=db,uploads
*
* # Pull the remote db without prior local backup
* wp deploy pull staging --what=db --backup=false
*
* @synopsis <environment> --what=<what> [--cleanup] [--backup=<backup>] [--v=<v>]
*/
public function pull( $args, $assoc_args ) {
$args = self::sanitize_args( __FUNCTION__, $args, $assoc_args );
if ( isset( $args->error ) ) {
WP_Cli::line( $args->error );
return false;
}
call_user_func( __CLASS__ . "::pull_" . self::$config->what );
self::run_post_hook();
self::wow();
}
/**
* Dumps the local database and / or uploads from local to remote. The
* database will be prepared for upload to the specified environment.
*
* ## OPTIONS
*
* <environment>
* : The name of the environment. This is the prefix of the constants
* defined in wp-config.php.
*
* [`--v`=<v>]
* : Verbosity level. Default 1. 0 is highest and 2 is lowest.
*
* ## EXAMPLE
*
* # Dumps database for to "staging" environment.
* wp deploy dump staging
*
* @synopsis <environment> [--file=<file>] [--v=<v>]
*/
public function dump( $args, $assoc_args ) {
$args = self::sanitize_args( __FUNCTION__, $args, $assoc_args );
if ( isset( $args->error ) ) {
WP_Cli::line( $args->error );
return false;
}
self::dump_db();
self::run_post_hook();
self::wow();
}
/** Pushes the database to the server. */
private function push_db() {
$c = self::$config;
$dump_file = self::dump_db( array(
'wd' => $c->tmp_path,
'name' => basename( $c->tmp ),
) );
$server_file = "{$c->local_hostname}_{$c->env}.sql";
$runner = self::$runner;
$runner->add(
Util::get_rsync(
$dump_file,
"$c->ssh:$c->path/$server_file",
$c->port
),
"Uploaded the database file to '$c->path/$server_file' on the server.",
'Failed to upload the database to the server'
);
/** Removing the dump file after upload. */
$runner->add( "rm -f $dump_file" );
$runner->add(
"ssh $c->ssh -p $c->port 'cd $c->path;"
. " mysql --user=$c->db_user --password=" . escapeshellarg( $c->db_password ) ." --host=$c->db_host"
. " $c->db_name < $server_file'",
'Deployed the database on server.',
'Failed deploying the db on server.'
);
$runner->run();
}
/** Pushes the uploads to the server. */
private function push_uploads() {
$c = self::$config;
$runner = self::$runner;
/** TODO safe mode */
$path = isset( $c->safe_mode ) ? $c->path : $c->uploads;
$runner->add(
Util::get_rsync(
// When pushing safe, we push the dir, hence no trailing slash
"$c->local_uploads/",
"$c->ssh:$path",
$c->port,
true,
true,
$c->excludes
),
"Synced local uploads to '$path' on '$c->host'.",
'Failed to upload the database to the server'
);
$runner->run();
}
/** Pushes the themes to the server. */
private function push_themes() {
$c = self::$config;
$runner = self::$runner;
/** TODO safe mode */
$path = isset( $c->safe_mode ) ? $c->path : $c->themes;
$runner->add(
Util::get_rsync(
// When pushing safe, we push the dir, hence no trailing slash
"$c->local_themes/",
"$c->ssh:$path",
$c->port,
true,
true,
"$c->excludes"
),
"Synced local themes to '$path' on '$c->host'.",
'Failed to upload the database to the server'
);
$runner->run();
}
/** Pushes the plugins to the server. */
private function push_plugins() {
$c = self::$config;
$runner = self::$runner;
/** TODO safe mode */
$path = isset( $c->safe_mode ) ? $c->path : $c->plugins;
$runner->add(
Util::get_rsync(
// When pushing safe, we push the dir, hence no trailing slash
"$c->local_plugins/",
"$c->ssh:$path",
$c->port,
true,
true,
"$c->excludes"
),
"Synced local plugins to '$path' on '$c->host'.",
'Failed to upload the database to the server'
);
$runner->run();
}
/** Pulls the database from the server. */
private function pull_db() {
$c = self::$config;
$server_file = "{$c->env}_{$c->timestamp}.sql";
$runner = self::$runner;
$runner->add(
"ssh $c->ssh -p $c->port 'mkdir -p $c->path; cd $c->path;"
. " mysqldump --user=$c->db_user --password=" . escapeshellarg( $c->db_password ) . " --host=$c->db_host"
. " --single-transaction"
. " --add-drop-table $c->db_name > $server_file'",
"Dumped the remote database to '$c->path/$server_file' on the server.",
'Failed dumping the remote database.'
);
$runner->add(
Util::get_rsync(
"$c->ssh:$c->path/$server_file",
"$c->wd/$server_file",
$c->port,
false, false // No delete or compression
),
"Copied the database from the server to '$c->wd/$server_file'."
);
$runner->add(
"ssh $c->ssh -p $c->port 'cd $c->path; rm -f $server_file'",
'Deleted the server dump.'
);
/** TODO Finalize safe mode. */
$runner->add(
! isset( $c->safe_mode ),
"wp db export $c->bk_path/$c->timestamp.sql",
"Backed up local database to '$c->bk_path/$c->timestamp.sql'"
);
$runner->add(
"wp db import $c->wd/$server_file",
'Imported the remote database.'
);
$runner->add(
( $c->siteurl != $c->url ),
"wp search-replace --all-tables $c->url $c->siteurl",
"Replaced '$c->url' with '$c->siteurl' on the imported database."
);
$runner->add(
( $c->abspath != $c->wp ),
"wp search-replace --all-tables $c->wp $c->abspath",
"Replaced '$c->wp' with '$c->abspath' on local database."
);
$runner->run();
}
/** Pulls the uploads from the server. */
private static function pull_uploads() {
$c = self::$config;
$runner = self::$runner;
/** TODO Finalize safe mode. */
$runner->add(
isset( $c->safe_mode ),
"cp -rf $c->local_uploads $c->bk_path/uploads_$c->timestamp",
'Backed up local uploads.'
);
$runner->add(
Util::get_rsync(
"$c->ssh:$c->uploads/",
$c->local_uploads,
$c->port,
true,
true,
$c->excludes
),
"Pulled the '$c->env' uploads locally."
);
$runner->run();
}
/** Pulls the themes from the server. */
private static function pull_themes() {
$c = self::$config;
$runner = self::$runner;
/** TODO Finalize safe mode. */
$runner->add(
isset( $c->safe_mode ),
"cp -rf $c->local_themes $c->bk_path/themes_$c->timestamp",
'Backed up local themes.'
);
$runner->add(
Util::get_rsync(
"$c->ssh:$c->themes/",
$c->local_themes,
$c->port,
true,
true,
$c->excludes
),
"Pulled the '$c->env' themes locally."
);
$runner->run();
}
/** Pulls the plugins from the server. */
private static function pull_plugins() {
$c = self::$config;
$runner = self::$runner;
/** TODO Finalize safe mode. */
$runner->add(
isset( $c->safe_mode ),
"cp -rf $c->local_plugins $c->bk_path/plugins_$c->timestamp",
'Backed up local plugins.'
);
$runner->add(
Util::get_rsync(
"$c->ssh:$c->plugins/",
$c->local_plugins,
$c->port,
true,
true,
$c->excludes
),
"Pulled the '$c->env' plugins locally."
);
$runner->run();
}
/** Dumps the local database after performing search-replace. */
private static function dump_db( $args = array() ) {
$c = self::$config;
$args = wp_parse_args( $args, array(
'name' => "{$c->env}_{$c->timestamp}",
'wd' => $c->wd
) );
$path = "{$args['wd']}/{$args['name']}.sql";
$runner = self::$runner;
$runner->add(
( $c->abspath != $c->wp ) || ( $c->url != $c->siteurl ),
"wp db export $c->tmp",
"Exported a local backup of the database to '$c->tmp'."
);
$runner->add(
( $c->siteurl != $c->url ),
"wp search-replace --all-tables $c->siteurl $c->url",
"Replaced '$c->siteurl' with '$c->url' in local database."
);
$runner->add(
( $c->abspath != $c->wp ),
"wp search-replace --all-tables $c->abspath $c->wp",
"Replaced '$c->abspath' with with '$c->wp' in local database."
);
$runner->add(
"wp db export $path",
"Dumped the database to '$path'."
);
$runner->add(
( $c->abspath != $c->wp ) || ( $c->url != $c->siteurl ),
"wp db import $c->tmp",
'Imported the local backup.'
);
$runner->add(
( $c->abspath != $c->wp ) || ( $c->url != $c->siteurl ),
"rm -f $c->tmp",
'Cleaned up.'
);
$runner->run();
return $path;
}
/** Sanitizes the arguments, and sets the configuration. */
private static function sanitize_args( $command, $args, $assoc_args = null ) {
self::$env = $args[0];
/** If what is available, it needs to refer to an existing method. */
$what = '';
if ( isset( $assoc_args['what'] ) ) {
$what = $assoc_args['what'];
if ( ! method_exists( __CLASS__, "{$command}_{$what}" ) ) {
WP_Cli::error( "Using unknown '$what' parameter for --what argument." );
}
}
/**
* Eeeek! So ugly.
* TODO. Fix this.
*/
$verbosity = self::$default_verbosity;
if ( isset( $assoc_args['v'] ) && in_array( $assoc_args['v'], range( 0, 2 ) ) )
$verbosity = $assoc_args['v'];
self::$runner = new Runner( $verbosity );
/** Get the environmental and set the tool config. */
$constants = self::validate_config( $command, $what, self::$env );
self::$config = self::expand( self::$config, $constants, $command, $what );
/** Create paths. */
Runner::get_result( 'mkdir -p ' . self::$config->tmp_path . ';' );
Runner::get_result( 'mkdir -p ' . self::$config->bk_path . ';' );
return self::$config;
}
/** Determines the verbosity level: 1, 2, or 3 */
private static function get_verbosity( $string, $default ) {
$number = count_chars_unicode( $string, 'v' );
if ( $number )
return min( $number, 2 );
return $default;
}
/**
* Verifies that all required constants are defined.
* Constants must be of the form: "%ENV%_%NAME%"
*/
private static function validate_config( $command, $what, $env ) {
/** Get the required contstants from the dependency array. */
$deps = self::$config_dependencies;
$required = $deps[$command];
if ( ! empty( $what ) ) {
$required = array_unique( array_merge(
$deps[$command][$what],
$deps[$command]['global']
) );
}
/** Get all definable constants. */
$all_const = array();
foreach( $deps as $comm_deps ) {
foreach ( $comm_deps as $item ) {
$const = is_array( $item ) ? $item : array( $item );
$all_const = array_merge( $all_const, $const );
}
}
$all_const = array_unique( $all_const );
$get_const = function ( $const ) use ( $env ) {
return strtoupper( $env . '_' . $const );
};
$errors = array();
$constants = array();
foreach ( $all_const as $short_name ) {
/** The constants template */
$constant = $get_const( $short_name );
if ( in_array( $short_name, $required ) && ! defined( $constant ) ) {
$errors[] = "Required constant $constant is not defined.";
} elseif ( defined( $constant ) ) {
$constants[$short_name] = constant( $constant );
}
}
if ( count( $errors ) ) {
foreach ( $errors as $error ) {
WP_Cli::line( "$error" );
}
WP_Cli::error( "The missing constants are required in order to run this subcommand.\nType `wp help deploy` for more information." );
}
/** Add the optional constants. */
foreach ( $deps['optional'] as $optional ) {
$const = $get_const( $optional );
if ( defined( $const ) )
$constants[$optional] = constant( $const );
}
return $constants;
}
/** Replaces the placeholders in the paths with actual data. */
private static function expand( $config, $constants, $command, $what ) {
$data = array(
'env' => self::$env,
'command' => $command,
'what' => $what,
'excludes' => ( isset( $constants['excludes'] ) && is_string( $constants['excludes'] ) ? $constants['excludes'] : false ),
'port' => ( isset( $constants['port'] ) ? $constants['port'] : '22' ),
'hash' => Util::get_hash(),
'abspath' => untrailingslashit( ABSPATH ),
'pretty_date' => date( 'Y_m_d-H_i' ),
'rand' => substr( sha1( time() ), 0, 8 ),
'hostname' => Runner::get_result( "hostname" ),
'local_uploads' => call_user_func( function() {
$uploads_dir = wp_upload_dir();
return untrailingslashit( Runner::get_result(
"cd {$uploads_dir['basedir']}; pwd -P;"
) );
} ),
'local_themes' => call_user_func( function() {
$themes_dir = get_theme_root();
return untrailingslashit( Runner::get_result(
"cd {$themes_dir}; pwd -P;"
) );
} ),
'local_plugins' => call_user_func( function() {
$plugins_dir = WP_PLUGIN_DIR; // TODO: get the plugin directory in a better manner
return untrailingslashit( Runner::get_result(
"cd {$plugins_dir}; pwd -P;"
) );
} ),
'siteurl' => untrailingslashit( Util::trim_url(
get_option( 'siteurl' ),
true
) ),
'object' => (object) array_map( 'untrailingslashit', $constants ),
);
foreach ( $config as &$item ) {
$item = Util::unplaceholdit( $item, array_merge(
/** This ensures we can have dependecies. */
$config,
$data
) );
}
if ( isset( $constants['post_hook'] ) ) {
$config['post_hook'] = Util::unplaceholdit( $config['post_hook'], array_merge( $config, $data ) );
}
/** Remove unset config items (constants). */
$config = array_filter( $config, function ( $item ) {
return strpos( $item, '%%' ) === false;
} );
/** Return the config in object form. */
return (object) $config;
}
public function run_post_hook() {
if ( isset( self::$config->post_hook ) ) {
$result = Runner::get_result( self::$config->post_hook );
if ( ! empty( $result ) ) {
var_dump( $result );
}
WP_Cli::line( "Ran post hook." );
}
}
private static function wow() {
$doge = array( 'wow', 'many', 'such', 'so' );
$words = array( 'finish', 'done', 'end', 'deploy' );
WP_CLI::line('');
WP_Cli::success(
$doge[array_rand( $doge, 1 )] . ' ' .
$words[array_rand( $words, 1 )] . '!'
);
}
}
WP_CLI::add_command( 'deploy', 'WP_Deploy_Command' );