CRM-20148 Fix WP-CLI installer #110

agh1 · 2017-02-21T15:56:32Z

This pull request looks insane because of the style changes that I ran first because my editor was blowing up with PHP_CodeSniffer errors: wp-cli/civicrm.php was in neither CiviCRM/Drupal style nor WordPress style. This puts it in WordPress style.

The real business in here comes in 5612d6f, with a couple additional things in 72202de, so it would probably be easier to browse through those.

The result works with the following two commands:

wp civicrm install --dbhost=localhost --dbname=XXXX --dbpass=XXXX --dbuser=XXXX --site_url=example.com when CiviCRM is extracted in place and already activated in WordPress, and
wp civicrm install --dbhost=localhost --dbname=XXXX --dbpass=XXXX --dbuser=XXXX --site_url=example.com --zipfile=/path/to/civicrm-4.7.16-wordpress.zip --require=/somewhere/else/wp-cli/civicrm.php when CiviCRM is not present but the WP-CLI file is at /somewhere/else/wp-cli/civicrm.php.

However, I have only run this on plain vanilla WordPress installs.

It would be nice to have @kcristiano's feedback to make sure it's consistent with setups I'm not aware of and with work he's doing to improve the installation process in WordPress.

CRM-20148: WP-CLI installer won't run if it can be run

It's not happy with the variable name `$crmPath`, but it shouldn't be touched since it's a global used elsewhere in CiviCRM. It also doesn't like silencing errors on running the `wp plugin activate civicrm` command.

…te in place

…unusual

kcristiano · 2017-02-21T20:52:44Z

@agh1 Thanks for working on this.

I'll do the testing, to confirm the workflow.

I install WP,wp-cli and the civicrm wp-cli script. I tell wp-cli to include the civicrm script and run the install?

I ask as the bundled version won't work until the plugin is activated.

agh1 · 2017-02-21T21:29:01Z

There are two scenarios to work through. Both start with WP and WP-CLI installed.

In the first, download CiviCRM manually, extract it into the plugins directory, and activate the CiviCRM plugin, but don't run the installer. Then try the first command above. WP-CLI should have the CiviCRM commands because the plugin is enabled.

In the second, CiviCRM should not be in your site at all. Somewhere else on your machine you'll need the CiviCRM zip file (specified with --zipfile) and the wp-cli/civicrm.php file (specified with --require).

The problem was that the command looked for the folder with wp-cli/civicrm.php in trying to figure out where to install CiviCRM, and then said, "Holy shit, there's a folder here--we've got to quit!"

To make the first use case work (installing a site that's already in place), I basically removed the check of whether the CiviCRM folder exists. For the second use case (unzip and install), I made the command not assume that the plugin path is where the script is.

kcristiano · 2017-02-21T22:32:55Z

Thanks, I am so used to using the 'yml' config files I didn't see the 'require' command line switch.

Apache 2.4, php 5.6.30 MySQL 5.7 running on a mac.

I am having trouble with the script. The extract works
wp cv install --dbhost=localhost --dbname=cvcli --dbpass=wp --dbuser=wp --site_url=https://cvcli.test --zipfile=~/Downloads/civicrm-4.7.16-wordpress.zip --require=/srv/www/cvcli/wp-content/uploads/wpcli/civicrm.php Extracting zip archive ... Success: Archive unpacked.

But then nothing. CiviCRM is in the proper place wp-content/plugins/civicrm but the install does not kick off.

If I run again:
wp cv install --dbhost=localhost --dbname=cvcli --dbpass=wp --dbuser=wp --site_url=https://cvcli.test --require=/srv/www/cvcli/wp-content/uploads/wpcli/civicrm.php Success: Using installer files found on the site.

The plugin is neither activated nor installed.

If I add activate_plugin( $crmPath . '/civicrm.php' ); at line 363 then the plugin is activated, but the installer does not launch.

Not sure why it's failing for me. Can you share details of your setup?

agh1 · 2017-02-27T17:14:01Z

Strange. I just tried it somewhere new just in case. Here's the complete procedure I used:

Starting with a working Wordpress site on Ubuntu 16.04 with PHP 7 and MariaDB 5.5, I used wget https://github.com/agh1/civicrm-wordpress/raw/84e5e53349b3349d3fb52c5bed4dffad25416e32/wp-cli/civicrm.php to download the wp-cli/civicrm.php file to /srv/www/installtest/civicrm.php, and I downloaded the regular CiviCRM zip file to /srv/www/installtest/civicrm-4.7.16-wordpress.zip. I went inside the site and did sudo -su www-data in order to act as www-data so as not to create files with weird owners. I then ran the following:
wp civicrm install --dbhost=localhost --dbname=installtest --dbpass=MYPASSWORD --dbuser=MYUSER --site_url=installtest.aghstrategies.com --zipfile=/srv/www/installtest/civicrm-4.7.16-wordpress.zip --require=/srv/www/installtest/civicrm.php

I was using the same database and credentials as the WordPress site. There were no civicrm_... tables, and there were no CiviCRM files in the site at all to begin with.

The response was

Extracting zip archive ...
Success: Archive unpacked.
Loading CiviCRM database structure ..
Loading CiviCRM database with required data ..
Success: CiviCRM database loaded successfully.
Generating civicrm settings file ..
Success: Settings file generated: /srv/www/installtest/public_html/wp-content/uploads/civicrm/civicrm.settings.php
Plugin 'civicrm' activated.
Success: Activated 1 of 1 plugins.
Success: CiviCRM installed.

Going into WordPress, the site is working like normal.

kcristiano · 2017-02-28T12:59:25Z

wp-cli/civicrm.php

+			# create files dirs
+			$upload_dir      = wp_upload_dir();
+			$settings_dir     = $upload_dir['basedir'] . DIRECTORY_SEPARATOR . 'civicrm' . DIRECTORY_SEPARATOR;
+			civicrm_setup( "$settings_dir" );


This creates a directory structure of wp-content/uploads/civicrm/civicrm/

I would change to:

$userFilesDir = $upload_dir['basedir'] . DIRECTORY_SEPARATOR; civicrm_setup( "$userFilesDir" );

We also get a wp-content/uploads/civicrm/files/ directory structure that does not happen in a normal install. While that will work, we should track that down to make the install consistent.

kcristiano · 2017-02-28T13:00:50Z

@agh1 Thanks for the feedback. I tested again both on an Ubuntu 16.04 server and locally on a LAMP stack on a Mac.

If the site is http://installtest.dev the install works fine. If the site is https://installtest.dev the install fails.

In addition line 380 civicrm_setup( "$settings_dir" ); creates a directory structure of wp-content/uploads/civicrm/civicrm/

I would change to:

$userFilesDir     = $upload_dir['basedir'] . DIRECTORY_SEPARATOR;
civicrm_setup( "$userFilesDir" );

We also get a wp-content/uploads/civicrm/files/ directory structure that does not happen in a normal install. While that will work, we should track that down to make the install consistent.

kcristiano · 2017-02-28T20:03:03Z

wp-cli/civicrm.php

+			}
+			$params = array(
+				'crmRoot'            => $crmPath . '/',
+				'templateCompileDir' => "{$settings_dir}files/civicrm/templates_c",


'templateCompileDir' => "{$settings_dir}templates_c",

Appears to be proper setting for 4.7

kcristiano · 2017-02-28T20:04:19Z

@agh1 so I missed the --ssl=on flag. Works on Ubuntu, still failing on my local Mac install.

I think that this is working to the point we should merge. Previous installer failed hard, this works. @totten @colemanw

kcristiano · 2017-02-28T20:09:13Z

@agh1 can you look at the changes suggested and if you agree add to your branch?

agh1 · 2017-04-07T18:08:13Z

At long last I just incorporated the changes @kcristiano suggested, and I tested it with the following two scenarios, both starting with a just-installed WordPress site and no CiviCRM:

Install from activated plugin

wget http://download.civicrm.org/civicrm-4.7.18-wordpress.zip -O /tmp/civicrm-4.7.18-wordpress.zip
unzip /tmp/civicrm-4.7.18-wordpress.zip -d wp-content/plugins/
wp plugin activate civicrm
wp civicrm install --dbhost=localhost --dbname=XXXX --dbpass=XXXX --dbuser=XXXX --site_url=example.com

Install from zipfile and `wp-cli/civicrm.php`

wget http://download.civicrm.org/civicrm-4.7.18-wordpress.zip -O /tmp/civicrm-4.7.18-wordpress.zip
wget https://raw.githubusercontent.com/agh1/civicrm-wordpress/chicken-egg-install/wp-cli/civicrm.php -O ~/wp-cli-civicrm.php
wp civicrm install --dbhost=localhost --dbname=XXXX --dbpass=XXXX --dbuser=XXXX --site_url=example.com --zipfile=/tmp/civicrm-4.7.18-wordpress.zip --require=~/wp-cli-civicrm.php

kcristiano · 2017-04-07T18:22:01Z

Thanks @agh1 I'll run a test as soon as I can and would like to see this in the May release

kcristiano · 2017-04-19T13:56:21Z

Retested and works perfectly.

totten · 2017-04-20T18:56:22Z

If @agh1 and @kcristiano like it, then that'll work for me. ;)

The entity and action were also being parsed as an invalid parameter. This was fixed by shifting the args array after parsing them. An unassigned $format variable was being referenced inside of the default case for the switch statement if the --in option was neither args nor json. This was fixed by assigning $format to the output of getOption rather than switching on getOption directly. The parameter matching regex had spaces added to it in pull request civicrm#110 that caused arguments of the format foo=bar to not be matched correctly, so no parameters were actually being passed to the underlying api method. The spaces were removed from the regex and the parsing worked. Two other regex matches had spaces added to them by pull request civicrm#110 that I have not touched, but they seem suspect.

agh1 added 3 commits February 21, 2017 10:34

NFC: made phpcs WordPress-Core filter (mostly) happy with wp-cli

5bb23fc

It's not happy with the variable name `$crmPath`, but it shouldn't be touched since it's a global used elsewhere in CiviCRM. It also doesn't like silencing errors on running the `wp plugin activate civicrm` command.

CRM-20148 WP-CLI: allow for install using zipfile or just enabling si…

5612d6f

…te in place

CRM-20148 WP-CLI: DB_DSN_MODE should be auto; also fix path slashes

72202de

civicrm-builder added the master label Feb 21, 2017

CRM-20148 WP-CLI: extract zipfile even if destination is somewhere …

84e5e53

…unusual

agh1 changed the title ~~Fix WP-CLI installer~~ CRM-20148 Fix WP-CLI installer Feb 21, 2017

kcristiano reviewed Feb 28, 2017

View reviewed changes

agh1 added 2 commits April 7, 2017 10:54

CRM-20148 WP-CLI installer: fixed paths per @kcristiano suggestion

3d4211f

CRM-20148 WP-CLI install: use paths that were already constructed

4e62e17

totten merged commit 63009a7 into civicrm:master Apr 20, 2017

jonesinator mentioned this pull request Aug 31, 2017

Fix parameter parsing in wp-cli civicrm api. #114

Merged

totten mentioned this pull request Sep 11, 2017

CRM-21166: WP-CLI commands fail due to whitespace in regex Remove wh… #115

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CRM-20148 Fix WP-CLI installer #110

CRM-20148 Fix WP-CLI installer #110

agh1 commented Feb 21, 2017 •

edited by civicrm-builder

Loading

kcristiano commented Feb 21, 2017

agh1 commented Feb 21, 2017

kcristiano commented Feb 21, 2017

agh1 commented Feb 27, 2017 •

edited

Loading

kcristiano Feb 28, 2017

kcristiano commented Feb 28, 2017

kcristiano Feb 28, 2017

kcristiano commented Feb 28, 2017

kcristiano commented Feb 28, 2017

agh1 commented Apr 7, 2017 •

edited

Loading

kcristiano commented Apr 7, 2017

kcristiano commented Apr 19, 2017

totten commented Apr 20, 2017

CRM-20148 Fix WP-CLI installer #110

CRM-20148 Fix WP-CLI installer #110

Conversation

agh1 commented Feb 21, 2017 • edited by civicrm-builder Loading

kcristiano commented Feb 21, 2017

agh1 commented Feb 21, 2017

kcristiano commented Feb 21, 2017

agh1 commented Feb 27, 2017 • edited Loading

kcristiano Feb 28, 2017

Choose a reason for hiding this comment

kcristiano commented Feb 28, 2017

kcristiano Feb 28, 2017

Choose a reason for hiding this comment

kcristiano commented Feb 28, 2017

kcristiano commented Feb 28, 2017

agh1 commented Apr 7, 2017 • edited Loading

Install from activated plugin

Install from zipfile and wp-cli/civicrm.php

kcristiano commented Apr 7, 2017

kcristiano commented Apr 19, 2017

totten commented Apr 20, 2017

agh1 commented Feb 21, 2017 •

edited by civicrm-builder

Loading

agh1 commented Feb 27, 2017 •

edited

Loading

agh1 commented Apr 7, 2017 •

edited

Loading

Install from zipfile and `wp-cli/civicrm.php`