cw_tool.module

<?php
/**
 * @file
 *
 * Main CWTool module file.
 */

use CW\Factory\EntityControllerFactory;
use CW\Factory\UserControllerFactory;
use CW\Form\VariableFormGenerator;
use CW\Manager\VariableManager;
use CW\Model\EntityHandler;
use CW\Util\CronTimer;
use CW\Util\FormUtil;
use CW\Util\Functional;
use Pimple\Container;

require_once __DIR__ . '/vendor/autoload.php';

// Service names.
const CWTOOL_SERVICE_NODE_FACTORY = 'cw.node-controller.factory';
const CWTOOL_SERVICE_TAXONOMY_TERM_FACTORY = 'cw.taxonomy-term-controller.factory';
const CWTOOL_SERVICE_USER_FACTORY = 'cw.user-controller.factory';
const CWTOOL_SERVICE_FILE_FACTORY = 'cw.file-controller.factory';
const CWTOOL_SERVICE_IMAGE_FACTORY = 'cw.image-controller.factory';

const CWTOOL_SERVICE_VARIABLE_MANAGER = 'cw.variable-manager';
const CWTOOL_SERVICE_VARIABLE_ADAPTER = 'cw.variable-adapter';

const CWTOOL_SERVICE_LOGGER = 'cw.logger';
const CWTOOL_SERVICE_IDENTITY_MAP = 'cw.identity-map';
const CWTOOL_SERVICE_OBJECT_HANDLER = 'cw.object-handler.drupal';
const CWTOOL_SERVICE_BATCH_ENTITY_SAVER = 'cw.entity-batch-saver';
const CWTOOL_SERVICE_CRON_TIMER = 'cw.cron-timer';

const CWTOOL_SERVICE_DB_CACHE = 'cw.cache.db';
// Static cache falling back to database cache.
const CWTOOL_SERVICE_DOUBLE_CACHE = 'cw.cache.double';

/**
 * Dependency injection configuration.
 *
 * @return \Pimple\Container
 */
function cw_tool_get_container() {
  static $container;

  if (!empty($container)) {
    return $container;
  }

  $container = new Container();

  $container[CWTOOL_SERVICE_LOGGER] = function (Container $c) {
    return new \Drupal\PSR3\Logger\Watchdog();
  };

  $container[CWTOOL_SERVICE_IDENTITY_MAP] = function (Container $c) {
    return new \CW\Util\LocalProcessIdentityMap();
  };

  $container[CWTOOL_SERVICE_OBJECT_HANDLER] = function (Container $c) {
    return new \CW\Model\DrupalEntityHandler();
  };

  $container[CWTOOL_SERVICE_NODE_FACTORY] = function (Container $c) {
    return new EntityControllerFactory(
      $c[CWTOOL_SERVICE_IDENTITY_MAP],
      $c[CWTOOL_SERVICE_OBJECT_HANDLER],
      'CW\Controller\NodeController',
      'node',
      $c[CWTOOL_SERVICE_LOGGER]
    );
  };

  $container[CWTOOL_SERVICE_USER_FACTORY] = function (Container $c) {
    return new EntityControllerFactory(
      $c[CWTOOL_SERVICE_IDENTITY_MAP],
      $c[CWTOOL_SERVICE_OBJECT_HANDLER],
      'CW\Controller\UserController',
      'user',
      $c[CWTOOL_SERVICE_LOGGER]
    );
  };

  $container[CWTOOL_SERVICE_FILE_FACTORY] = function (Container $c) {
    return new EntityControllerFactory(
      $c[CWTOOL_SERVICE_IDENTITY_MAP],
      $c[CWTOOL_SERVICE_OBJECT_HANDLER],
      'CW\Controller\FileController',
      'file',
      $c[CWTOOL_SERVICE_LOGGER]
    );
  };

  $container[CWTOOL_SERVICE_IMAGE_FACTORY] = function (Container $c) {
    return new EntityControllerFactory(
      $c[CWTOOL_SERVICE_IDENTITY_MAP],
      $c[CWTOOL_SERVICE_OBJECT_HANDLER],
      'CW\Controller\ImageController',
      'file',
      $c[CWTOOL_SERVICE_LOGGER]
    );
  };

  $container[CWTOOL_SERVICE_TAXONOMY_TERM_FACTORY] = function (Container $c) {
    return new EntityControllerFactory(
      $c[CWTOOL_SERVICE_IDENTITY_MAP],
      $c[CWTOOL_SERVICE_OBJECT_HANDLER],
      'CW\Controller\TaxonomyTermController',
      'taxonomy_term',
      $c[CWTOOL_SERVICE_LOGGER]
    );
  };

  $container[CWTOOL_SERVICE_BATCH_ENTITY_SAVER] = function (Container $c) {
    return new CW\Util\EntityBatchSaver(
      $c[CWTOOL_SERVICE_IDENTITY_MAP],
      $c[CWTOOL_SERVICE_LOGGER]
    );
  };

  $container[CWTOOL_SERVICE_VARIABLE_MANAGER] = function (Container $c) {
    return new VariableManager($c[CWTOOL_SERVICE_LOGGER]);
  };

  $container[CWTOOL_SERVICE_VARIABLE_ADAPTER] = function (Container $c) {
    return new \CW\Adapter\DrupalVariableAdapter();
  };

  $container[CWTOOL_SERVICE_CRON_TIMER] = function (Container $c) {
    return new CronTimer($c[CWTOOL_SERVICE_VARIABLE_ADAPTER]);
  };

  $container[CWTOOL_SERVICE_DB_CACHE] = function (Container $c) {
    $cachePool = new \Drupal\PSRCache\CachePool();
    $cachePool->setCacheHandler(new \Drupal\PSRCache\Adaptor\DefaultDrupalCacheHandler());
    return $cachePool;
  };

  $container[CWTOOL_SERVICE_DOUBLE_CACHE] = function (Container $c) {
    return new \Drupal\PSRCache\StaticCacheProxy($c[CWTOOL_SERVICE_DB_CACHE]);
  };

  drupal_alter('cw_tool_service_container_definition', $container);

  return $container;
}

/**
 * Implements hook_menu().
 */
function cw_tool_menu() {
  return array(
    // Admin section.
    'admin/config/application' => array(
      'title' => 'Application settings',
      'description' => 'Application settings.',
      'position' => 'left',
      'weight' => -10,
      'page callback' => 'system_admin_menu_block_page',
      'access arguments' => array('access administration pages'),
      'file' => 'system.admin.inc',
      'file path' => drupal_get_path('module', 'system'),
    ),

    // Variable settings page.
    'admin/config/application/variables' => array(
      'title' => 'Variables',
      'description' => 'Environment app variables.',
      'page callback' => 'drupal_get_form',
      'page arguments' => array('cw_tool_core_admin_settings_form'),
      'access arguments' => array('access administration pages'),
    ),
  );
}

function cw_tool_core_admin_settings_form($form) {
  /** @var VariableManager $variableManager */
  $variableManager = cw_tool_get_container()[CWTOOL_SERVICE_VARIABLE_MANAGER];
  $variableManager->collectAppVariables();
  $variablesForm = new VariableFormGenerator($variableManager);
  return $variablesForm->generateForm($form);
}

/**
 * @return CronTimer
 */
function cw_tool_cron_timer() {
  return cw_tool_get_container()[CWTOOL_SERVICE_CRON_TIMER];
}

/**
 * @return \CW\Adapter\VariableAdapter
 */
function cw_tool_variable_adapter() {
  return cw_tool_get_container()[CWTOOL_SERVICE_VARIABLE_ADAPTER];
}

/**
 * @return \Psr\Log\LoggerInterface
 */
function cw_tool_logger() {
  return cw_tool_get_container()[CWTOOL_SERVICE_LOGGER];
}

/**
 * @return EntityControllerFactory
 */
function cw_tool_file_factory() {
  return cw_tool_get_container()[CWTOOL_SERVICE_FILE_FACTORY];
}

/**
 * @return EntityControllerFactory
 */
function cw_tool_image_factory() {
  return cw_tool_get_container()[CWTOOL_SERVICE_IMAGE_FACTORY];
}

/**
 * @return EntityControllerFactory
 */
function cw_tool_taxonomy_term_factory() {
  return cw_tool_get_container()[CWTOOL_SERVICE_TAXONOMY_TERM_FACTORY];
}

/**
 * @return UserControllerFactory
 */
function cw_tool_user_factory() {
  return cw_tool_get_container()[CWTOOL_SERVICE_USER_FACTORY];
}

/**
 * @return EntityHandler
 */
function cw_tool_entity_handler() {
  return cw_tool_get_container()[CWTOOL_SERVICE_OBJECT_HANDLER];
}

/**
 * @return \Psr\Cache\CacheItemPoolInterface
 */
function cw_tool_db_cache() {
  return cw_tool_get_container()[CWTOOL_SERVICE_DB_CACHE];
}

/**
 * @return \Psr\Cache\CacheItemPoolInterface
 */
function cw_tool_double_cache() {
  return cw_tool_get_container()[CWTOOL_SERVICE_DOUBLE_CACHE];
}

/**
 * CWTool form validator proxy for registered validator.
 *
 * @param array $form
 * @param array $form_state
 */
function cw_tool_form_util_validate(&$form, &$form_state) {
  FormUtil::callHook(FormUtil::HOOK_VALIDATE, $form, $form_state);
}

function cw_tool_form_util_submit(&$form, &$form_state) {
  FormUtil::callHook(FormUtil::HOOK_SUBMIT, $form, $form_state);
}

function cw_tool_form_util_after_build($form, $form_state) {
  return FormUtil::callAfterBuildHook($form, $form_state);
}

/**
 * Adds the CWTool JS file to the page load.
 */
function cw_tool_include_js() {
  drupal_add_js(drupal_get_path('module', 'cw_tool') . '/javascript/cw_tool.js');
}

/**
 * Load the utility functions.
 */
function cw_tool_include_util() {
  require_once __DIR__ . '/includes/cw_tool.util.inc';
}

/**
 * Load the content helper functions.
 */
function cw_tool_include_content() {
  require_once __DIR__ . '/includes/cw_tool.content.inc';
}

/**
 * Implements hook_forms().
 */
function cw_tool_forms($form_id) {
  $forms = array();

  if (strpos($form_id, 'cw_tool_form') === 0) {
    $formClassName = str_replace('cw_tool_form:', '', $form_id);
    $forms[$form_id] = array(
      'callback' => 'cw_tool_generate_form',
      'callback arguments' => array($formClassName),
    );
  }

  return $forms;
}

/**
 * Central form hook for forms that are defined as CW\Form\FormBuilder classes.
 *
 * @param array $form
 * @param array $form_state
 * @param string $class
 * @return mixed
 */
function cw_tool_generate_form($form, &$form_state, $class) {
  $funcArgs = func_get_args();

  call_user_func_array(array($class, 'attachSubmitAndValidation'), array(&$form));

  $callArgs = array(&$form, &$form_state);
  Functional::walk($funcArgs[3], function ($item) use (&$callArgs) { array_push($callArgs, $item); });

  return call_user_func_array(array($class, 'build'), $callArgs);
}

/**
 * Implements hook_library().
 */
function cw_tool_library() {
  $libraries = [];

  $path = drupal_get_path('module', 'cw_tool');

  // Path JS plugin.
  $libraries['cwtool.path'] = [
    'title' => 'CWTool Path Javascript plugin.',
    'version' => VERSION,
    'js' => [
      $path . '/javascript/cw_tool.path.js' => ['group' => JS_LIBRARY],
    ],
  ];

  // Referrer JS plugin.
  $libraries['cwtool.referrer'] = [
    'title' => 'CWTool Referrer Javascript plugin.',
    'version' => VERSION,
    'js' => [
      $path . '/javascript/cw_tool.referrer.js' => ['group' => JS_LIBRARY],
    ],
    'dependencies' => [
      ['cw_tool', 'cwtool.path'],
    ],
  ];

  return $libraries;
}

/**
 * Check if the form ID is associated to the form class.
 *
 * @param string $class
 * @param string $form_id
 * @return bool
 */
function cw_tool_is_form_id_of_form_class($class, $form_id) {
  return strpos($form_id, $class) !== FALSE;
}