r3-v2/update_templates.php

#!/usr/bin/php
<?php

include "utils.php";

function getIndex($needle, $haystack) {

  $index = 0;

  foreach ($haystack as $value) {
    if (preg_match('/\b' . $needle . '\b/', $value)) {
      return $index;
    }
    $index++;
  }

  return false;
}

function loadSavedData($file) {

  $saveFile = $file . '.saved';

  echo "restoring file " . $saveFile . "\n";

  $sh = fopen($saveFile, "r");

  $saved = [];

  while (!feof($sh)) {

    $line = fgets($sh);

    array_push($saved, $line);

  }

  while ($saved[sizeof($saved) - 1] === false && sizeof($saved) > 0) {
    array_pop($saved);
  }

  fclose($sh);

  return $saved;
}

function restore($file, $tokens, $saved) {

  $fh = fopen($file, "r");

  $data = [];

  $restoreTokenPair = [];

  $restoreDepth = 0;

  while (!feof($fh)) {

    $line = fgets($fh);

    foreach ($tokens as $startToken => $endToken) {

      if (preg_match('/\b' . $startToken . '\b/', $line)) {
        $restoreDepth++;

        if ($restoreDepth === 1) {
          $restoreTokenPair[0] = $startToken;
          $restoreTokenPair[1] = $endToken;
        }

        break;
      }

      if (preg_match('/\b' . $endToken . '\b/', $line)) {
        $restoreDepth--;
        break;
      }

    }

    if ($restoreDepth === 1) {

      $startIndex = getIndex($restoreTokenPair[0], $saved);
      $endIndex = getIndex($restoreTokenPair[1], $saved);

      for ($i = $startIndex; $i <= $endIndex; $i++) {
        array_push($data, $saved[$i]);
      }

      /**
       * Seek to the end token in the file
       */
      while (!feof($fh) && !(preg_match('/\b' . $restoreTokenPair[1] . '\b/', $line))){
        $line = fgets($fh);
      }

      $restoreDepth--;

    } else {
      array_push($data, $line);
    }
  }

  fclose($fh);

  file_put_contents($file, $data);
}

//function install_method_templates($file)
//{
//  $fn = fopen($file, "r");
//
//  $saveLine = true;
//
//  $methods = [];
//
//  $saveMethod = false;
//
//  $lines = [];
//
////  $discoveredMethodTokens = [];
//
//  while (!feof($fn)) {
//
//    $line = fgets($fn);
//
//    /**
//     * if exiting an options definition block - stop saving that definition
//     */
//    if (preg_match('/\bSTATIC_METHODS_END\b/', $line)) {
//      $saveMethod = false;
//    }
////
////    $matches = [];
////    if (preg_match('/\bCUSTOM_.*?_METHOD_START\b/', $line, $matches)) {
////      $discoveredMethodTokens[$matches[0]] = preg_replace('/_START$/','_END',$matches[0]);
////    }
//
//    /**
//     * if exiting an method implementation block - save the line for later
//     */
//    if (preg_match('/\bSTATIC_METHODS_DEFINITION_END\b/', $line)) {
//      $saveLine = true;
//    }
//
//    /**
//     * Now save the line
//     */
//    if ($saveLine) {
//      array_push($lines, $line);
//    }
//
//    /**
//     * if entering an options implementation block - do not save the line for later
//     */
//    if (preg_match('/\bSTATIC_METHODS_DEFINITION_START\b/', $line)) {
//      $saveLine = false;
//    }
//
//    if ($saveMethod) {
//
//      $line = trim($line);
//
//      array_push($methods, $line);
//    }
//
//    /**
//     * If entering an options definition block - start saving that definition
//     */
//    if (preg_match('/\bSTATIC_METHODS_START\b/', $line)) {
//      $saveMethod = true;
//    }
//
//  }
//
//  fclose($fn);
//
//  file_put_contents($file, $lines);
//

function getTokens($type)
{
  $fn = fopen('src/templates/token.db', "r");

  $tokens = [];

  while (!feof($fn)) {

    $line = fgets($fn);

    $matches = [];
    if (preg_match('/^(' . $type . '.*$)/', $line, $matches)) {
      $tokens[$matches[1]] = [];
    }

  }

  fclose($fn);

  return $tokens;
}

//function get_method_tokens($file)
//{
//  $fn = fopen($file, "r");
//
//  $discoveredMethodTokens = [];
//
//  while (!feof($fn)) {
//
//    $line = fgets($fn);
//
//    $matches = [];
//    if (preg_match('/\bCUSTOM_.*?_METHOD_START\b/', $line, $matches)) {
//      $discoveredMethodTokens[$matches[0]] = preg_replace('/_START$/','_END',$matches[0]);
//    }
//
//  }
//
//  fclose($fn);
//
//  return $discoveredMethodTokens;
//
//}

/**
 * @throws ErrorException
 */
function loadSaved($file, $tokens) {

  $saveFile = $file . '.saved';

  echo "loading file " . $saveFile . "\n";

  $loadedTokens = [];

  $fn = fopen($saveFile, "r");

  if (!$fn) {
    throw new ErrorException('Could not open save file: ' . $saveFile . "\n");
  }

  $currentTokenKey = null;

  while (!feof($fn)) {

    $line = fgets($fn);

    $tokenFound = false;

    foreach ($tokens as $key => $store) {
      if (preg_match('/\b' . $key . '\b/', $line))
      {
        if (array_key_exists($key, $loadedTokens)) {
          throw new ErrorException("TOKEN ALREADY EXISTS! : $key\n");
        }
        $tokenFound = true;
        $loadedTokens[$key] = [];
        $currentTokenKey = $key;
        break;
      }
    }

    if (!$tokenFound && $line != false) {
      array_push($loadedTokens[$currentTokenKey], $line);
    }

  }

  fclose($fn);

  return $loadedTokens;
}


function save($file, $tokens) {

  echo "saving file " . $file . "\n";

  $currentTokens = [];

  $fn = fopen($file, "r");

  while (!feof($fn)) {

    $line = fgets($fn);

    foreach ($tokens as $key => $store) {
      if (preg_match('/\b' . $key . '_END\b/', $line)) {
        array_pop($currentTokens);
        break;
      }
    }

    $size = sizeof($currentTokens);

    if ($size > 0) {
      array_push($tokens[$currentTokens[$size - 1]], $line);
    }

    foreach ($tokens as $key => $store) {
      if (preg_match('/\b' . $key . '_START\b/', $line)) {
        array_push($currentTokens, $key);
        break;
      }
    }

  }

  fclose($fn);

  $saveFile =$file . '.saved';

  $saved = [];

  $stores = [];

  foreach ($tokens as $key => $store) {
    if (sizeof($store) > 0) {
      $stores[$key] = $store;
      array_push($saved, $key . "\n");
      foreach ($store as $line) {
        array_push($saved, $line);
      }
    }
  }

  file_put_contents($saveFile, $saved);

  echo "saved file $saveFile\n";

  return [
    $saveFile,
    $stores
  ];
}

function deleteSavedFile($saveFile)
{
  if ($saveFile) {
    unlink($saveFile);
  } else {
    echo "saved file was null";
  }
}

function getWhitespace($contents, $token)
{
  $matches = [];

  if (preg_match('/^(\s*)\b' . $token . '\b/m', $contents, $matches)) {
    return [
      'white-space' => $matches[1],
      'inline-comment' => false
    ];
  } else {

    if (preg_match('/^(\s*)\/\/\b' . $token . '\b/m', $contents, $matches)) {
      return [
        'white-space' => $matches[1],
        'inline-comment' => true
      ];
    }

    return null;
  }
}

function updateSection($file, $token, $updates, $separator = "") {

  if (getType($updates) === 'array') {
    $updates = implode($separator, $updates);
  }

  if (strlen($updates) <= 0) {
    echo "No contents to be updated for token $token\n";
    return;
  }

  if (substr($updates, -1) !== "\n") {
    $updates .= "\n";
  }

  $contents = file_get_contents($file);

  $whiteSpaceObject = getWhitespace($contents, $token . '_END');

  if ($whiteSpaceObject === null) {
    /**
     * This file does not contain the token which requires an update - we can return here
     */
    echo "Skipping token $token because it was not found\n";
    return;
  }

  $endToken = $token . "_END";

  if ($whiteSpaceObject['inline-comment']) {
    $endToken = '//' . $endToken;
  }

  $whiteSpace = $whiteSpaceObject['white-space'];

  /**
   * If we already have whitespace in our updates at the start - we took care of
   * formatting from a template, otherwise - apply some whitespace to it
   */
//  if (!preg_match('/^(\s)+/', $updates)) {
//    $updates = $whiteSpace . $updates;
//  }

  $contents = preg_replace(
    '/\b' . $token . '_START\b.*?\b' . $token . '_END\b/s',
    $token . "_START\n" . $updates . $whiteSpace . $endToken,
    $contents
  );

  file_put_contents($file, $contents);
}

function generateInitOptions($file, $tokens)
{
  $token = 'CUSTOM_OPTIONS';
  $store = getTokenStore($token, $tokens);

  if (sizeof($store) <= 0) {
    return;
  }

  echo "Will be building options for $token\n";

  $header = file_get_contents('src/templates/generate_custom_options_init_header.template');
  $template = file_get_contents('src/templates/generate_custom_options_init.template');

  $updates = $header;

  foreach ($store as $item) {
    $item = trim($item);
    $key_value = preg_split('/=/', $item);
    if ($key_value === false) {
      continue;
    }
    $key = $key_value[0];
    $value = $key_value[1];
    $updated = str_replace('KEY', $key, $template);
    $updated = str_replace('VALUE', $value, $updated);
    $updates .= $updated;
  }

  updateSection($file, 'GENERATE_OPTIONS_INIT' , $updates);
}

function getTokenStore($tokenName, $tokens)
{
  if (array_key_exists($tokenName, $tokens)) {
    return $tokens[$tokenName];
  }
  return [];
}

function getInstanceMappings($tokens)
{
  $instanceMappings = [];

  foreach (getTokenStore('CUSTOM_INSTANCE_OPTIONS_MAPPING', $tokens) as $mapping) {

    $mapping = trim($mapping);

    $key_value = preg_split('/=/', $mapping);

    if ($key_value === false) {
      continue;
    }

    $key = $key_value[0];
    $value = $key_value[1];

    $instanceMappings[$key] = $value;
  }

  return $instanceMappings;
}

function isExcluded($key, $tokens)
{

  if (array_key_exists('CUSTOM_EXCLUDED_FROM_INSTANCE_OPTIONS', $tokens)) {

    $excluded = [];

    foreach ($tokens['CUSTOM_EXCLUDED_FROM_INSTANCE_OPTIONS'] as $exclude) {
      array_push($excluded, trim($exclude));
    }

    if (in_array($key, $excluded)) {
      return true;
    }

  }

  return false;
}

function doInstanceUpdate($template, $tokens, $asArray =  false)
{
  $token = 'CUSTOM_OPTIONS';
  $store = getTokenStore($token, $tokens);

  if (sizeof($store) <= 0) {
    return null;
  }

  $instanceMappings = getInstanceMappings($tokens);

  $updates = '';

  if ($asArray) {
    $updates = [];
  }

  foreach ($store as $item) {

    $item = trim($item);

    $key_value = preg_split('/=/', $item);

    if ($key_value === false) {
      continue;
    }

    $key = $key_value[0];
    $value = $key_value[0];

    if (array_key_exists($key, $instanceMappings)) {
      $value = $instanceMappings[$key];
    }

    if (isExcluded($key, $tokens)){
      continue;
    }

    $updated = str_replace('INSTANCE_KEY', $value, $template);
    $updated = str_replace('KEY', $key, $updated);
    if ($asArray) {
      array_push($updates, $updated);
    } else {
      $updates .= $updated;
    }
  }

  return $updates;
}

function generateCreateInstanceOptions($file, $tokens)
{
  $template = file_get_contents('src/templates/generate_create_instance_options.template');

  $updates = doInstanceUpdate($template, $tokens, true);

  if ($updates) {
    echo "Updating create instance options\n";
    updateSection($file, 'GENERATE_CREATE_INSTANCE_OPTIONS', $updates, ",\n");
  } else {
    echo "No create instance options found to generate\n";
  }
}

/**
 * Process updateInstance options
 */
function generateUpdateInstanceOptions($file, $tokens)
{
  $template = file_get_contents('src/templates/generate_update_instance_options.template');

  $updates = doInstanceUpdate($template, $tokens);

  if ($updates) {
    echo "Updating update instance options\n";
    updateSection($file, 'GENERATE_UPDATE_INSTANCE_OPTIONS', $updates);
  } else {
    echo "No update instance options found to generate\n";
  }
}

/**
 * Process updateFromInstance options
 */
function generateUpdateFromInstanceOptions($file, $tokens)
{
  $template = file_get_contents('src/templates/generate_update_from_instance_options.template');

  $updates = doInstanceUpdate($template, $tokens);

  if ($updates) {
    echo "Updating update from instance options\n";
    updateSection($file, 'GENERATE_UPDATE_FROM_INSTANCE_OPTIONS', $updates);
  } else {
    echo "No update from instance options found to generate\n";
  }
}

function doMethodUpdate($template, $tokens, $token)
{
  $store = getTokenStore($token, $tokens);

  if (sizeof($store) <= 0) {
    return null;
  }

  $updates = '';

  foreach ($store as $item) {

    $item = trim($item);

    $methodName = $item;

    $matches = [];
    $result = preg_match('/^(.*?)\(/', $item, $matches);

    if ($result !== false && sizeof($matches) >= 2) {
      $methodName = $matches[1];
    }

    $args = '';
    $result = preg_match('/\((.*)\)/', $item, $matches);

    if ($result !== false && sizeof($matches) >= 2) {
      $args = $matches[1];
    }

    $updated = str_replace('METHOD_ARGS', $args, $template);
    $updated = str_replace('METHOD_NAME_UPPERCASE', strtoupper($methodName), $updated);
    $updated = str_replace('METHOD_NAME', $methodName, $updated);
    $updates .= $updated;
  }

  return $updates;
}

function generateStaticMethods($file, $tokens)
{
  $token = 'CUSTOM_STATIC_METHODS';

  $template = file_get_contents('src/templates/generate_static_methods.template');

  $updates = doMethodUpdate($template, $tokens, $token);

  if ($updates) {
    echo "Updating static methods\n";
    updateSection($file, 'GENERATE_STATIC_METHODS', $updates);
  } else {
    echo "No static methods found to generate\n";
  }

}

function generateMethods($file, $tokens)
{
  $token = 'CUSTOM_METHODS';

  $template = file_get_contents('src/templates/generate_methods.template');

  $updates = doMethodUpdate($template, $tokens, $token);

  if ($updates) {
    echo "Updating methods\n";
    updateSection($file, 'GENERATE_METHODS', $updates);
  } else {
    echo "No methods found to generate\n";
  }

}

global $files;

foreach ($files as $file) {

  $saveFile = null;

  if ($argv[2] == 'save') {

    $tokens = getTokens('CUSTOM');

    $result = save($file, $tokens);

    exit(0);

  } else if ($argv[2] == 'restore') {

    $restoreTokens = getTokens('CUSTOM');

    $restoreTokenKeys = array_keys($restoreTokens);

    $tokens = loadSaved($file, $restoreTokens);

    foreach ($tokens as $token => $store) {
      if (in_array($token, $restoreTokenKeys)) {
        updateSection($file, $token, $store);
      }
    }

    generateInitOptions($file, $tokens);

    generateCreateInstanceOptions($file, $tokens);

    generateUpdateInstanceOptions($file, $tokens);

    generateUpdateFromInstanceOptions($file, $tokens);

    generateMethods($file, $tokens);

    generateStaticMethods($file, $tokens);

    echo `r3 update-token-db`;

    $restoreTokens = getTokens('CUSTOM');

    $restoreTokenKeys = array_keys($restoreTokens);

    $tokens = loadSaved($file, $restoreTokens);

    foreach ($tokens as $token => $store) {
      if (in_array($token, $restoreTokenKeys)) {
        updateSection($file, $token, $store);
      }
    }

    exit(0);

//    restore($file, $tokens, $saved);
//
//    /**
//     * At this point - we restored the headers but the method definitions are not installed
//     * We can't restore them until we have expanded what those definitions are
//     * i.e. -
//     * 1. we need to update_methods.php (to define the placeholders)
//     * 2. then we meed to restore those methods from saved[]
//     */
//    $methodTokens = install_method_templates($file);
//
//    restore($file, $methodTokens, $saved);
//
//    echo "Restored file " . $file;

//    deleteSavedFile($saveFile);

  } else if ($argv[2] == 'update-methods') {

    $restoreTokens = getTokens('CUSTOM');

    $restoreTokenKeys = array_keys($restoreTokens);

    $tokens = loadSaved($file, $restoreTokens);

    foreach ($tokens as $token => $store) {
      if (in_array($token, $restoreTokenKeys)) {
        updateSection($file, $token, $store, "\n ");
      }
    }

    generateMethods($file, $tokens);

    generateStaticMethods($file, $tokens);

    echo `r3 update-token-db`;

  } else if ($argv[2] == 'update-options') {

    $tokens = getTokens('CUSTOM');

    $result = save($file, $tokens);

    $saveFile = $result[0];
    $tokens = $result[1];

    try {
      generateInitOptions($file, $tokens);

      generateCreateInstanceOptions($file, $tokens);

      generateUpdateInstanceOptions($file, $tokens);

      generateUpdateFromInstanceOptions($file, $tokens);

      generateMethods($file, $tokens);

      generateStaticMethods($file, $tokens);

      echo `r3 update-token-db`;

//      unlink($saveFile);
    } catch (Exception $e) {
      print_r($e);
      echo "An error occurred and the custom data is saved at $saveFile\n";
      echo "Please restore it manually...\n";
    }

  }

}

exit(0);

?>