civicrm.php

<?php

/*
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC. All rights reserved.                        |
 |                                                                    |
 | This work is published under the GNU AGPLv3 license with some      |
 | permitted exceptions and without any warranty. For full license    |
 | and copyright information, see https://civicrm.org/licensing       |
 +--------------------------------------------------------------------+
 */
if ( ! defined( 'CIVICRM_WPCLI_LOADED' ) ) {
  define( 'CIVICRM_WPCLI_LOADED', 1 );

  /**
   * WP-CLI port of drush-civicrm integration
   * andyw@circle, 08/03/2014
   *
   * Distributed under the GNU Affero General Public License, version 3
   * http://www.gnu.org/licenses/agpl-3.0.html
   */

  class CiviCRM_Command extends WP_CLI_Command {

    private $args, $assoc_args;

    /**
     * WP-CLI integration with CiviCRM.
     *
     * wp civicrm api
     * ===============
     * Command for accessing CiviCRM APIs. Syntax is identical to drush cvap.
     *
     * wp civicrm cache-clear
     * ===============
     * Command for accessing clearing cache.  Equivilant of running civicrm/admin/setting/updateConfigBackend&reset=1
     *
     * wp civicrm enable-debug
     * ===============
     * Command for to turn debug on.
     *
     * wp civicrm disable-debug
     * ===============
     * Command for to turn debug off.
     *
     * wp civicrm member-records
     * ===============
     * Run the CiviMember UpdateMembershipRecord cron ( civicrm member-records ).
     *
     * wp civicrm process-mail-queue
     * ===============
     * Process pending CiviMail mailing jobs.
     * Example:
     * wp civicrm process-mail-queue -u admin
     *
     * wp civicrm rest
     * ===============
     * Rest interface for accessing CiviCRM APIs. It can return xml or json formatted data.
     *
     * wp civicrm restore
     * ==================
     * Restore CiviCRM codebase and database back from the specified backup directory
     *
     * wp civicrm sql-conf
     * ===================
     * Show civicrm database connection details.
     *
     * wp civicrm sql-connect
     * ======================
     * A string which connects to the civicrm database.
     *
     * wp civicrm sql-cli
     * ==================
     * Quickly enter the mysql command line.
     *
     * wp civicrm sql-dump
     * ===================
     * Prints the whole CiviCRM database to STDOUT or save to a file.
     *
     * wp civicrm sql-query
     * ====================
     * Usage: wp civicrm sql-query <query> <options>...
     * <query> is a SQL statement, which can alternatively be passed via STDIN. Any additional arguments are passed to the mysql command directly.";
     *
     * wp civicrm update-cfg
     * =====================
     * Update config_backend to correct config settings, especially when the CiviCRM site has been cloned / migrated.
     *
     * wp civicrm upgrade
     * ==================
     * Take backups, replace CiviCRM codebase with new specified tarfile and upgrade database by executing the CiviCRM upgrade process - civicrm/upgrade?reset=1. Use civicrm-restore to revert to previous state in case anything goes wrong.
     *
     * wp civicrm upgrade-db
     * =====================
     * Run civicrm/upgrade?reset=1 just as a web browser would.
     *
     * wp civicrm install
     * ===============
     * Command for to install CiviCRM.  The install command requires that you have downloaded a tarball or zip file first.
     * Options:
     * --dbhost            MySQL host for your WordPress/CiviCRM database. Defaults to localhost.
     * --dbname            MySQL database name of your WordPress/CiviCRM database.
     * --dbpass            MySQL password for your WordPress/CiviCRM database.
     * --dbuser            MySQL username for your WordPress/CiviCRM database.
     * --lang              Default language to use for installation.
     * --langtarfile       Path to your l10n tar.gz file.
     * --site_url          Base Url for your WordPress/CiviCRM website without http ( e.g. mysite.com )
     * --ssl               Using ssl for your WordPress/CiviCRM website if set to on ( e.g. --ssl=on )
     * --tarfile           Path to your CiviCRM tar.gz file.
     *
     */

    public function __invoke( $args, $assoc_args ) {

      $this->args       = $args;
      $this->assoc_args = $assoc_args;

      # define command router
      $command_router = array(
        'api'                => 'api',
        'cache-clear'        => 'cacheClear',
        'enable-debug'       => 'enableDebug',
        'disable-debug'      => 'disableDebug',
        'install'            => 'install',
        'member-records'     => 'memberRecords',
        'process-mail-queue' => 'processMailQueue',
        'rest'               => 'rest',
        'restore'            => 'restore',
        'sql-cli'            => 'sqlCLI',
        'sql-conf'           => 'sqlConf',
        'sql-connect'        => 'sqlConnect',
        'sql-dump'           => 'sqlDump',
        'sql-query'          => 'sqlQuery',
        'update-cfg'         => 'updateConfig',
        'upgrade'            => 'upgrade',
        'upgrade-db'         => 'upgradeDB',
       );

      # get command
      $command = array_shift( $args );

      # check for existence of Civi ( except for command 'install' )
      if ( ! function_exists( 'civicrm_initialize' ) and 'install' != $command ) {
        return WP_CLI::error( 'Unable to find CiviCRM install.' );
      }

      # check existence of router entry / handler method
      if ( ! isset( $command_router[ $command ] ) or ! method_exists( $this, $command_router[ $command ] ) ) {
        return WP_CLI::error( "Unrecognized command - '$command'" );
      }

      # run command
      return $this->{$command_router[ $command ]}();

    }

    /**
     * Implementation of command 'api'
     */
    private function api() {

      $defaults = array( 'version' => 3 );

      array_shift( $this->args );
      list( $entity, $action ) = explode( '.', $this->args[0] );
      array_shift( $this->args );

      # parse $params
      $format = $this->getOption( 'in', 'args' );
      switch ( $format ) {

        # input params supplied via args ..
        case 'args':
          $params = $defaults;
          foreach ( $this->args as $arg ) {
            preg_match( '/^([^=]+)=(.*)$/', $arg, $matches );
            $params[ $matches[1] ] = $matches[2];
          }
          break;

        # input params supplied via json ..
        case 'json':
          $json   = stream_get_contents( STDIN );
          $params = ( empty( $json ) ? $defaults : array_merge( $defaults, json_decode( $json, true ) ) );
          break;

        default:
          WP_CLI::error( 'Unknown format: ' . $format );
          break;
      }

      civicrm_initialize();

      // CRM-18062: Set CiviCRM timezone if any
      $wp_base_timezone = date_default_timezone_get();
      $wp_user_timezone = $this->getOption( 'timezone', get_option( 'timezone_string' ) );
      if ( $wp_user_timezone ) {
        date_default_timezone_set( $wp_user_timezone );
        CRM_Core_Config::singleton()->userSystem->setMySQLTimeZone();
      }