coder_upgrade.module

<?php
/**
 * @file
 * Provides primary Backdrop hook implementations.
 *
 * Developer module that assists a contributed module with version upgrade from
 * the Drupal 7.x to Backdrop 1.x core API. The module creates new code files by
 * modifying existing code files in accordance with the core API changes. The
 * initial Backdrop version would be a straight port of features from the Drupal
 * version.
 *
 * For a list of core API changes that are handled by this module, see:
 * - https://api.backdropcms.org/change-records
 *
 * Copyright 2008-11 by Jim Berry ("solotandem", http://drupal.org/user/240748)
 */

/**
 * Defines an array used to insert blank lines into created code.
 */
define('CODER_UPGRADE_WHITESPACE', array('type' => T_WHITESPACE, 'value' => 1 ));

if (function_exists('t')) {
  // This code is being executed inside a process running Backdrop.
  module_load_include('inc', 'coder_upgrade', 'coder_upgrade');
}

/**
 * Implements hook_permission().
 */
function coder_upgrade_permission() {
  return array(
    'administer code conversions' => array(
      'title' => t('Administer code conversions'),
      'description' => t('Manage code conversion tasks for Coder Upgrade.'),
    ),
  );
}

/**
 * Implements hook_menu().
 */
function coder_upgrade_menu() {
  module_load_include('inc', 'coder_upgrade', 'includes/menu');
  return _coder_upgrade_menu();
}

/**
 * Implements hook_menu_alter().
 */
function coder_upgrade_menu_alter(&$items) {
  if (!module_exists('coder_review')) {
    // Remove the Coder menu item.
    unset($items['admin/config/development/coder']);
    // Promote the menu items defined by this module.
    $items['admin/config/development/coder-upgrade']['title'] = 'Coder Upgrade';
    $items['admin/config/development/coder-upgrade']['type'] = MENU_NORMAL_ITEM;
  }
}

/**
 * Implements hook_config_info().
 */
function coder_upgrade_config_info() {
  $prefixes['coder_upgrade.settings'] = array(
    'label' => t('Coder Upgrade settings'),
    'group' => t('Configuration'),
  );
  return $prefixes;
}

/**
 * Implements hook_autoload_info().
 */
function coder_upgrade_autoload_info() {
  return array(
    'PGPEditor' => 'grammar_parser/editor.inc',
    'PGPNode' => 'grammar_parser/list.inc',
    'PGPList' => 'grammar_parser/list.inc',
    'PGPBody' => 'grammar_parser/list.inc',
    'PGPExpression' => 'grammar_parser/list.inc',
    'PGPOperand' => 'grammar_parser/list.inc',
    'PGPString' => 'grammar_parser/list.inc',
    'PGPBase' => 'grammar_parser/object.inc',
    'PGPArray' => 'grammar_parser/object.inc',
    'PGPFunctionCall' => 'grammar_parser/object.inc',
    'PGPAssignment' => 'grammar_parser/object.inc',
    'PGPClass' => 'grammar_parser/object.inc',
    'PGPConditional' => 'grammar_parser/object.inc',
    'PGPFor' => 'grammar_parser/object.inc',
    'PGPForeach' => 'grammar_parser/object.inc',
    'PGPCase' => 'grammar_parser/object.inc',
    'PGPDeclare' => 'grammar_parser/object.inc',
    'PGPTryCatch' => 'grammar_parser/object.inc',
    'PGPListStatement' => 'grammar_parser/object.inc',
    'PGPNamespace' => 'grammar_parser/object.inc',
    'PGPUse' => 'grammar_parser/object.inc',
    'PGPParser' => 'grammar_parser/parser.inc',
    'PGPReader' => 'grammar_parser/reader.inc',
    'PGPWriter' => 'grammar_parser/writer.inc',
  );
}

/**
 * Implements hook_upgrade_upgrade_file_alter().
 */
function coder_upgrade_upgrade_file_alter(&$reader) {
  global $_coder_upgrade_module_name, $_coder_upgrade_filename;
  cdp("inside " . __FUNCTION__);
  $nodes = &$reader->getFunctions();
  $config_function_exists = FALSE;

  foreach ($nodes as &$node) {
    $item = &$node->data;
    $body = &$item->body;

    if (!empty($body) && $calls = $body->searchAll('PGPFunctionCall', 'name', 'value', 'config_get')) {
      $build_config_function = FALSE;
      foreach ($calls as &$call) {
        if ($call->printParameter(0) == "'" .$_coder_upgrade_module_name . ".settings'") {
          $build_config_function = TRUE;
          break;
        }
      }
      if ($build_config_function && (strpos($_coder_upgrade_filename, '.module') !== FALSE)) {
        $function = $_coder_upgrade_module_name . "_config_info";
        if (!$config_function_exists) {
          coder_upgrade_build_config_function($node, $reader);
          $config_function_exists = TRUE;
        }
      }
      if (count($calls) > 1) {
        $create_config = FALSE;
        // Create helper objects.
        $editor = PGPEditor::getInstance();
        // Insert config() call.
        $statement = $editor->textToStatements('$config = config(\''. $_coder_upgrade_module_name . '.settings\')');
        $body->insertFirst($statement->getElement(0));

        foreach ($calls as &$call) {
          if ($call->printParameter(0) == "'" .$_coder_upgrade_module_name . ".settings'") {
            $call->name['value'] = '$config->get';
            $call->deleteParameter();
          }
        }
      }
    }
    // Todo same for config_set, config_clear.
  }
}

function coder_upgrade_build_config_function($node, $reader) {
  global $_coder_upgrade_module_name, $_coder_upgrade_module_human_name;
  $editor = PGPEditor::getInstance();

  // Set values for the new hook function.
  $comment = array(
    'type' => T_DOC_COMMENT,
    'value' => "/**\n * Implements hook_config_info().\n */",
  );
  $name = $_coder_upgrade_module_name . '_config_info';

  // Create the new hook function.
  $function = new PGPClass($name);
  $function->comment = $comment;
  $function->type = T_FUNCTION;
  $function->parameters = new PGPList();

  $strings[] = '$prefixes[\'' . $_coder_upgrade_module_name . '.settings\'] = array(';
  $strings[] = "  'label' => t('{$_coder_upgrade_module_human_name} settings'),";
  $strings[] = "  'group' => t('Configuration'),";
  $strings[] = ');';
  $strings[] = 'return $prefixes;';

  $function->body = $editor->textToStatements(implode("\n", $strings));

  // Get the statement list the function node is part of.
  $container = &$node->container;

  // Insert the new function before the old function.
  $container->insertBefore($node, $function, 'function');
  // Insert a blank line.
  $container->insertBefore($node, CODER_UPGRADE_WHITESPACE, 'whitespace');
}