tailvite.php

<?php

/**
 * @file
 * Contains a basic scaffolding script.
 */

if ($argc < 2 || in_array($argv[1], array('--help', '-help', '-h', '-?'))) {
  tailvite_drush_help('drush:tailvite');
  $command = tailvite_drush_command()['tailvite'];
  print(PHP_EOL . "Arguments" . PHP_EOL);
  foreach ($command['arguments'] as $argument => $argument_description) {
    print($argument . " => " . $argument_description . PHP_EOL);
  }
  print(PHP_EOL . "Options" . PHP_EOL);
  foreach ($command['options'] as $option => $option_description) {
    print($option . " => " . $option_description . PHP_EOL);
  }
  print(PHP_EOL . "Examples" . PHP_EOL);
  foreach ($command['examples'] as $example => $example_description) {
    print($example . " => " . $example_description . PHP_EOL);
  }
  exit;
}

drush_tailvite($argv[1]);

/**
 * Determine whether current OS is a Windows variant.
 */
function drush_is_windows($os = NULL) {
  return strtoupper(substr($os ?: PHP_OS, 0, 3)) === 'WIN';
}

/**
 * Makes sure the path has only path separators native for the current operating system
 */
function drush_normalize_path($path) {
  if (drush_is_windows()) {
    $path = str_replace('/', '\\', strtolower($path));
  }
  else {
    $path = str_replace('\\', '/', $path);
  }
  return trim($path);
}

/**
 * Replacement for dt function.
 */
function dt($text, $replacements = []) {
  if (!empty($replacements)) {
    foreach ($replacements as $find => $replace) {
      $text = str_replace($find, $replace, $text);
    }
  }
  print($text . PHP_EOL);
}

/**
 * Create a drush_get_options function.
 */
function drush_get_options() {
  global $argv;
  $options = [];

  foreach ($argv as $key => $arg) {
    if (strpos($arg, '=') !== FALSE) {
      dt('Error: Please do not use equal signs in your options.');
      exit;
    }
    switch ($arg) {
      case "-machine-name":
      case "--machine-name":
        $options['machine-name'] = $argv[$key + 1];
        break;
      case "-description":
      case "--description":
        $options['description'] = $argv[$key + 1];
        break;
      case "-path":
      case "--path":
        $options['path'] = $argv[$key + 1];
        break;
      case "-slim":
      case "--slim":
        $options['slim'] = TRUE;
        break;
    }
  }

  return $options;
}

/**
 * Replacement for drush_get_option().
 */
function drush_get_option($option) {
  $all_options_passed = drush_get_options();
  return (!empty($all_options_passed[$option])) ? $all_options_passed[$option] : FALSE;
}

/**
 * Internal function called by drush_copy_dir; do not use directly.
 */
function _drush_recursive_copy($src, $dest) {
  // all subdirectories and contents:
  if(is_dir($src)) {
    if (!drush_mkdir($dest, TRUE)) {
      return FALSE;
    }
    $dir_handle = opendir($src);
    while($file = readdir($dir_handle)) {
      if ($file != "." && $file != "..") {
        if (_drush_recursive_copy("$src/$file", "$dest/$file") !== TRUE) {
          return FALSE;
        }
      }
    }
    closedir($dir_handle);
  }
  elseif (is_link($src)) {
    symlink(readlink($src), $dest);
  }
  elseif (!copy($src, $dest)) {
    return FALSE;
  }

  // Preserve file modification time.
  // https://github.com/drush-ops/drush/pull/1146
  touch($dest, filemtime($src));

  // Preserve execute permission.
  if (!is_link($src) && !drush_is_windows()) {
    // Get execute bits of $src.
    $execperms = fileperms($src) & 0111;
    // Apply execute permissions if any.
    if ($execperms > 0) {
      $perms = fileperms($dest) | $execperms;
      chmod($dest, $perms);
    }
  }

  return TRUE;
}

/**
 * Cross-platform compatible helper function to recursively create a directory tree.
 *
 * @param string $path
 *   Path to directory to create.
 * @param boolean $required
 *   If TRUE, then drush_mkdir will call drush_set_error on failure.
 *
 * Callers should *always* do their own error handling after calling drush_mkdir.
 * If $required is FALSE, then a different location should be selected, and a final
 * error message should be displayed if no usable locations can be found.
 * @see drush_directory_cache().
 * If $required is TRUE, then the execution of the current command should be
 * halted if the required directory cannot be created.
 */
function drush_mkdir($path, $required = TRUE) {
  if (!is_dir($path)) {
    if (drush_mkdir(dirname($path))) {
      if (@mkdir($path)) {
        return TRUE;
      }
      elseif (is_dir($path) && is_writable($path)) {
        // The directory was created by a concurrent process.
        return TRUE;
      }
      else {
        if (!$required) {
          return FALSE;
        }
        if (is_writable(dirname($path))) {
          return dt('Unable to create !dir.', array('!dir' => preg_replace('/\w+\/\.\.\//', '', $path)));
        }
        else {
          return dt('Unable to create !newdir in !dir. Please check directory permissions.', array('!newdir' => basename($path), '!dir' => realpath(dirname($path))));
        }
      }
    }
    return FALSE;
  }
  else {
    if (!is_writable($path)) {
      if (!$required) {
        return FALSE;
      }
      return dt('Directory !dir exists, but is not writable. Please check directory permissions.', array('!dir' => realpath($path)));
    }
    return TRUE;
  }
}

/**
 * Implements hook_drush_command().
 */
function tailvite_drush_command() {
  $items = array();

  $items['tailvite'] = array(
    'description' => 'Create a Tailvite-based theme.',
    'arguments' => array(
      'human_readable_name' => 'The name of your theme.',
    ),
    'options' => array(
      'machine-name' => 'The machine-readable name of your theme. This will be auto-generated from the human_readable_name if ommited.',
      'description' => 'The description of your theme',
      'path' => 'Supports three options contrib, custom, none.  Defaults to "custom".',
      'slim' => 'Only copy base files',
    ),
    'examples' => array(
      'php tailvite.php "My Awesome Theme"' => 'Creates a Tailvite theme called "My Awesome Theme", using the default options.',
      'php tailvite.php "My Awesome Theme" --machine-name mat' => 'Creates a tailvite theme called "My Awesome Theme" with the specific machine name "mat".',
    ),
  );

  return $items;
}

/**
 * Implements hook_drush_help().
 */
function tailvite_drush_help($section) {
  switch ($section) {
    case 'drush:tailvite':
      return dt('This command will create a Tailvite theme. See examples to get started.');
  }
}

/**
 * Implements drush_hook_COMMAND().
 */
function drush_tailvite($human_readable_name = NULL) {

  // If no $human_readable_name provided, abort.
  if (!$human_readable_name) {
    print(dt('Theme name missing. See help using \'drush help tailvite\'.'));
    return;
  }

  // Determine the machine name.
  $machine_name = drush_get_option('machine-name');
  if (!$machine_name) {
    $machine_name = $human_readable_name;
  }
  $machine_name = str_replace(' ', '_', strtolower($machine_name));
  $search = array(
    // Remove characters not valid in function names.
    '/[^a-z0-9_]/',
    // Functions must begin with an alpha character.
    '/^[^a-z]+/',
  );
  $machine_name = preg_replace($search, '', $machine_name);

  // Description of theme.
  $description = (drush_get_option('description')) ? trim(drush_get_option('description')) : 'Theme based on <a href="http://tailvite.info">tailvite</a>.';

  // Determine the path to the new theme.
  $theme_path = 'custom';
  if ($path = drush_get_option('path')) {
    switch (trim($path)) {
      case 'contrib':
        $theme_path = 'contrib';
        break;

      case 'none':
        $theme_path = '';
        break;

      case 'custom':
      default:
        $theme_path = 'custom';
        break;
    }
    $theme_path = trim($path);
  }

  // Create your new theme.
  $status = drush_tailvite_create($human_readable_name, $machine_name, $description, $theme_path);

  // Notify the user of failure.
  if ($status === FALSE) {
    print('Your theme was not successfully created.' . PHP_EOL);
    exit(1);
  }
}

/**
 * Create frontend theme.
 *
 * @param string $human_readable_name
 *   A string that will be used to represent the human readable name.
 * @param string $machine_name
 *   A string that will be used to name directories, files, and will be replaced
 *   in templates.
 * @param string $description
 *   A string that will be used as the theme description in the .info file.
 * @param string $theme_path_passed
 *   A string that will be translated into a base path for your new theme.
 *
 * @return boolean
 *   A boolean representing the success or failure of the function.
 */
function drush_tailvite_create($human_readable_name, $machine_name, $description, $theme_path_passed) {
  $theme_dir = substr(getcwd(), 0, strpos(getcwd(), 'themes') + 6);
  if (!empty($theme_path_passed)) {
    if ($theme_path_passed === 'none') {
      $theme_path = dirname(getcwd(), 1) . DIRECTORY_SEPARATOR . $machine_name;
    }
    else {
      $theme_path = $theme_dir . DIRECTORY_SEPARATOR . $theme_path_passed . DIRECTORY_SEPARATOR . $machine_name;

      // Phase: Validate theme dir with path is writeable.
      $theme_dir_status = _tailvite_validate_path($theme_dir . DIRECTORY_SEPARATOR . $theme_path_passed);
      if ($theme_dir_status !== TRUE) {
        return _tailvite_notify_fail('', 'Failed on Phase: Validate theme dir is writeable.');
      }
    }
  }
  else {
    $theme_path = $theme_dir . DIRECTORY_SEPARATOR . $machine_name;
  }

  // Phase: Validate theme path is writeable.
  $theme_path_status = _tailvite_validate_path($theme_path);
  if ($theme_path_status !== TRUE) {
    return _tailvite_notify_fail('', 'Failed on Phase: Validate theme path is writeable.');
  }

  // Phase: Verify there are not existing contents in the destination directory.
  $theme_path_empty_status = _tailvite_validate_path_is_empty($theme_path);
  if ($theme_path_empty_status !== TRUE) {
    return _tailvite_notify_fail('', 'Failed on Phase: Verify there are not existing contents in the destination directory.  Please either delete the contents or pick a different path by changing the machine name or using the \'--path\' option.  Use \'drush help tailvite\' for more information.');
  }

  // Phase: Make directories.
  $directories_to_make = _tailvite_get_directories_to_make();
  $directories_to_make_status = _tailvite_make_directories($directories_to_make, $theme_path);

  if ($directories_to_make_status !== TRUE) {
    return _tailvite_notify_fail('', 'Failed on Phase: Make directories.');
  }

  // Phase: Copy files.
  $files_to_copy = _tailvite_get_files_to_copy();
  $files_to_copy_status = _tailvite_copy_files($files_to_copy, $theme_path);

  if ($files_to_copy_status !== TRUE) {
    return _tailvite_notify_fail('', 'Failed on Phase: Copy files.');
  }

  // Phase: Alter files.
  $alterations = _tailvite_get_alterations($human_readable_name, $machine_name, $description);
  $files_to_alter = _tailvite_get_files_to_alter();
  $files_to_alter_status = _tailvite_alter_files($theme_path, $files_to_alter, $alterations);

  if ($files_to_alter_status !== TRUE) {
    return _tailvite_notify_fail('', 'Failed on Phase: Alter files.');
  }

  // Phase: Rename files.
  $files_to_rename = _tailvite_get_files_to_rename();
  $files_to_rename_status = _tailvite_rename_files($theme_path, $machine_name, $files_to_rename);

  if ($files_to_rename_status !== TRUE) {
    return _tailvite_notify_fail('', 'Failed on Phase: Rename files.');
  }

  // Phase 7: Return success message to the user.
  return _tailvite_notify_success($human_readable_name, $theme_path);
}

/**
 * Gets alterations (string replacements).
 *
 * This function supports both directories and individual files.  Alterations
 * happen in sequential order so you can replace something that was previously
 * replaced.
 *
 * @param string $human_readable_name
 *   A string representing the human readable name.
 * @param string $machine_name
 *   A string representing the machine name.
 * @param string $description
 *   A string representing the desired description.
 *
 * @return array
 *   An array with a key representing the string to be replaced and value
 *   representing the string to replace it with.
 */
function _tailvite_get_alterations($human_readable_name, $machine_name, $description) {
  return array(
    'tailvite' => $human_readable_name,
    'tailvite' => $machine_name,
    'Theme using Vite and component-driven development' => $description,
    'hidden: true' => '',
  );
}

/**
 * Returns an array of files and directories to make string replacements within.
 *
 * @return array
 *   A array representing files and directories to be altered.
 */
function _tailvite_get_files_to_alter() {
  // Slim files and directories declaration.
  $default_array = array(
    'tailvite.info.yml',
    'tailvite.theme',
    'tailvite.breakpoints.yml',
    'tailvite.libraries.yml',
  );
  // If we would like to have a bare copy we use is slim option.
  if (drush_get_option('slim') === TRUE) {
    return $default_array;
  }
  else {
    return array_merge($default_array, array(
      'components',
      'templates',
    ));
  }
}

/**
 * Get directories to make.
 *
 * @return array
 *   An array of directories to make.
 */
function _tailvite_get_directories_to_make() {
  // If we would like to have a bare copy we use is slim option.
  if (drush_get_option('slim') === TRUE) {
    return array(
      'components',
      'components/00-base',
      'components/00-base/global',
      'components/01-atoms',
      'components/02-molecules',
      'components/03-organisms',
      'components/04-templates',
      'components/05-pages',
      'images',
      'images/icons',
      'images/icons/src',
      'templates',
    );
  }
  else {
    return array();
  }
}

/**
 * Gets files to copy.
 *
 * This function supports both directories and individual files.
 *
 * The following directories/files will never be copied:
 * dist/
 * node_modules/
 * github.com/
 * composer.json
 * LICENSE
 * tailvite.php
 *
 * @return array
 *   An array of files to copy.
 */
function _tailvite_get_files_to_copy() {
  // Slim files and directories declaration.
  $default_array = array(
    '.browserslistrc',
    '.editorconfig',
    '.eslintignore',
    '.eslintrc.yml',
    '.gitignore',
    '.npmrc',
    'lint-staged.config.js',
    'package.json',
    'postcss.config.js',
    'prettier.config.js',
    'tailvite.breakpoints.yml',
    'tailvite.info.yml',
    'tailvite.libraries.yml',
    'tailvite.theme',
    'tailwind.config.js',
    'vite.config.js',
  );
  // If we would like to have a bare copy we use is slim option.
  if (drush_get_option('slim') === TRUE) {
    return array_merge($default_array, array(
      'components/style.scss',
    ));
  }
  else {
    return array_merge($default_array, array(
      'components',
      'images',
      'src',
      'templates',
      'README.md',
      'screenshot.png',
    ));
  }
}

/**
 * Get files to rename.
 *
 * @return array
 *   An array of files to rename.
 */
function _tailvite_get_files_to_rename() {
  // Slim files and directories declaration.
  $default_array = array(
    'tailvite.info.yml',
    'tailvite.theme',
    'tailvite.breakpoints.yml',
    'tailvite.libraries.yml',
  );
  // If we would like to have a bare copy we use is slim option.
  if (drush_get_option('slim') === TRUE) {
    return array_merge($default_array, array());
  }
  else {
    return array_merge($default_array, array());
  }
}

/**
 * Alter strings within files.
 *
 * @param string $theme_path
 *   A string representing the destination theme path.
 * @param array $files_to_alter
 *   An array representing the files that will be altered.
 * @param array $alterations
 *   An array of alteration that will be processed in sequential order on all
 *   files, this means that you can replace previous replacements.
 * @param boolean $absolute
 *   A boolean representing if the files to alter are represented as relative
 *   or absolute paths.
 *
 * @return boolean
 *   A boolean representing the success or failure of the function.
 */
function _tailvite_alter_files($theme_path, array $files_to_alter = array(), array $alterations = array(), $absolute = FALSE, int $depth = 0) {
  if (empty($files_to_alter) || empty($alterations)) {
    return TRUE;
  }
  foreach ($files_to_alter as $file_to_replace) {
    if ($absolute === TRUE) {
      $file_type = filetype(realpath($file_to_replace));
      $file_path = $file_to_replace;
    }
    else {
      $file_type = filetype($theme_path . DIRECTORY_SEPARATOR . $file_to_replace);
      $file_path = $theme_path . DIRECTORY_SEPARATOR . $file_to_replace;
    }

    if ($file_type === 'dir') {
      $files = scandir($file_path);
      $files = array_splice($files, 2);
      foreach ($files as $file) {
        $processed_file = [$file_path . DIRECTORY_SEPARATOR . $file];
        $alter_status = _tailvite_alter_files($theme_path, $processed_file, $alterations, TRUE, $depth + 1);
        if ($alter_status === FALSE) {
          return FALSE;
        }
      }
    }
    elseif ($file_type === 'file') {
      $string_replace_status = _tailvite_file_str_replace($file_path, array_keys($alterations), $alterations);
      if ($string_replace_status === FALSE) {
        return FALSE;
      }
    }
  }

  // If we make it here return success.
  return TRUE;
}

/**
 * Make directories.
 *
 * @param array $directories
 *   An array of directories (strings) to make.
 * @param string $destination_path
 *   A string representing the destination path.
 *
 * @return boolean
 *   A boolean representing the success or failure of the function.
 */
function _tailvite_make_directories(array $directories = array(), string $destination_path = '') {

  // Check for invalid settings and return an error.
  if (empty($destination_path)) {
    _tailvite_notify_fail('', "Invalid parameter passed to _tailvite_make_directories().");
    return FALSE;
  }

  // The $directories parameter can be empty and valid, return success.
  if (empty($directories)) {
    return TRUE;
  }

  // Copy desired files.
  foreach ($directories as $directory_to_make) {
    $directory_path = drush_normalize_path($destination_path . DIRECTORY_SEPARATOR . $directory_to_make);

    // Check if path is or can be writeable and exists, if not, return FALSE.
    if (!_tailvite_validate_path($directory_path)) {
      return FALSE;
    }
  }

  // If there were not issues return success.
  return TRUE;
}

/**
 * Copy files.
 *
 * @param array $files
 *   An array of files (strings) to copy.
 * @param string $destination_path
 *   A string representing the destination path.
 *
 * @return boolean
 *   A boolean representing the success or failure of the function.
 */
function _tailvite_copy_files(array $files = array(), string $destination_path = '') {

  // Check for invalid settings and return an error.
  if (empty($destination_path)) {
    return _tailvite_notify_fail('', "Invalid parameter passed to _tailvite_copy_files().");
  }

  // The $files parameter can be empty and valid, return success.
  if (empty($files)) {
    return TRUE;
  }

  // Copy desired files.
  foreach ($files as $files_to_copy) {
    $status = _drush_recursive_copy(__DIR__ . DIRECTORY_SEPARATOR . $files_to_copy, $destination_path . DIRECTORY_SEPARATOR . $files_to_copy);

    // Check if copy succeeded, if not, return FALSE.
    if (!$status) {
      return FALSE;
    }
  }

  // Return success.
  return TRUE;
}

/**
 * Rename files.
 *
 * @param string $theme_path
 *   A string representing the destination theme path.
 * @param string $machine_name
 *   A string that will be used in file names.
 * @param array $files_to_rename
 *   An array that represents the files to be processed.  The array is expected
 *   to be provided as an indexed array of relative files paths.
 *
 * @return boolean
 *   A boolean representing success or failure of the rename.
 */
function _tailvite_rename_files($theme_path, $machine_name, array $files_to_rename = array()) {
  foreach ($files_to_rename as $file_to_rename_path) {
    $file_original_path = $theme_path . DIRECTORY_SEPARATOR . $file_to_rename_path;
    $file_new_path = $theme_path . DIRECTORY_SEPARATOR . str_replace('tailvite', $machine_name, $file_to_rename_path);
    rename($file_original_path, drush_normalize_path($file_new_path));
  }
  return TRUE;
}

/**
 * Replace strings in a file.
 *
 * @param string $file_path
 *   A string representing the original file path to have replacements
 *   performed on.
 * @param array $find
 *   An array representing the search for values in the replacement process.
 * @param array $replace
 *   An array that will replace the $find strings.
 *
 * @return boolean
 *   A boolean representing success or failure of the replacement.
 */
function _tailvite_file_str_replace($file_path, array $find, array $replace) {
  $file_path = drush_normalize_path($file_path);
  $file_contents = file_get_contents($file_path);
  $file_contents = str_replace($find, $replace, $file_contents);
  file_put_contents($file_path, $file_contents);
  return TRUE;
}

/**
 * Validate that a path is writeable, creating the directory if necessary.
 *
 * @param string $path
 *   A string representing the path to verify exists and is writeable.
 *
 * @return boolean
 *   A boolean representing success or failure.
 */
function _tailvite_validate_path($path) {
  // Check for succees, if not, log the error and return FALSE.
  if (file_exists($path) === FALSE) {
    $return = mkdir($path);
  }
  else {
    $return = TRUE;
  }

  if ($return === FALSE) {
    _tailvite_notify_fail($path);
  }

  return $return;
}

/**
 * Validate that a path is empty.
 *
 * @param string $path
 *   A string representing the path to verify is empty.
 *
 * @return boolean
 *   A boolean representing if the path is empty or not.
 */
function _tailvite_validate_path_is_empty($path) {

  if (!is_readable($path)) {
    return FALSE;
  }

  return (count(scandir($path)) === 2);
}

/**
 * Notifies the user of failure.
 *
 * @param string $path
 *   An optional string representing the path that failed.  This function can
 *   be used to just send a message to the user without path replacements.
 * @param string $message
 *   An optional string to replace the default message.
 *
 * @return boolean
 *   Always return false in the case we use this function as a return value.
 */
function _tailvite_notify_fail($path = '', $message = '') {

  // Set a default message for the most common error.
  if (empty($message)) {
    // Notify user of the path write error.
    $message = 'There was an error writing to "!path".  This is normally due to permissions on one of the base directories or "!path" directory not allowing the web server to write data.  You can use the "chmod" command to implement either a temporary or permanent fix for this.';
  }

  // Set the path if one was passed.
  if (!empty($path) && is_string($path)) {
    $message = dt($message, array(
      '!path' => $path,
    ));
  }

  print($message);

  // We return false here to represent failure.
  return FALSE;
}

/**
 * Notifies the user of success.
 *
 * @param string $human_readable_name
 *   A string that will be returned to the user as their theme name.
 * @param string $theme_path
 *   A string that will show where to find their new theme.
 *
 * @return boolean
 *   Always TRUE in the case we want to use this function as a return value.
 */
function _tailvite_notify_success($human_readable_name, $theme_path) {
  // Notify user of the newly created theme.
  $message = 'Successfully created the tailvite theme "!name" created in: !path, you can now run \'npm install\' to install.';

  $message = dt($message, array(
    '!name' => $human_readable_name,
    '!path' => $theme_path,
  ));

  print($message);

  // We return true here to represent success.
  return TRUE;
}