gethosts.php

#!/usr/bin/php
<?php

require 'gethosts.cfg.php';

function run($argv) {
  if (empty($argv[1])) {
    echo "No command found.\n\n";
    help();
    exit;
  }
  switch ($argv[1]) {
    case '--list':
    case '--host':
      $headers = loginHeaders();
      // Build a group hierarchy.
      $groupResource = 'taxonomy_term';
      $groups = get($headers, $groupResource, NULL);
      $groupHierarchy = buildGroupHierarchy($groups);
      // Pull the view that shows the list of Ansible-enabled servers from Drupal.
      $resource = 'views/server_list?display_id=services_1';
      $titleResource = $urlResource = $queryParam = NULL;
      if ($argv[1] == '--host' && $argv[2]) {
        $resource .= "&title=$argv[2]";
      }
      $servers = get($headers, $resource, NULL);
      // Get the websites too.
      // Ugh - wish I could use "Views Combined Filter" but it uses WS_CONCAT which makes it impossible to do exact "rquals" searches.
      if ($argv[1] == '--host' && $argv[2]) {
        $queryParam = $argv[2];
      }
      $titleResource = "views/website_list?display_id=services_1&title=$queryParam";
      $websites = get($headers, $titleResource, NULL);
      // Don't need a second query of the website list if we just got all websites.
      if ($queryParam) {
        $urlResource = "views/website_list?display_id=services_1&url=$queryParam";
        $websites = $websites + get($headers, $urlResource, NULL);
      }
      $inventory = buildServerList($servers, $websites);
      $inventory = json_encode(array_merge_recursive($inventory, $groupHierarchy));
      echo $inventory;
      break;

    case '--site-mappings':
      generateSiteMapping();
      break;

    default:
      echo "Unknown command.\n\n";
    case '--help':
      help();
  }
}

run($argv);

/**
 * Generates site mapping for bookmarklets to change between environments.  Not strictly Ansible but uses the inventory.
 */
function generateSiteMapping() {
  $headers = loginHeaders();
  $mapping = [];
  $titleResource = 'views/website_list?display_id=services_1';
  $websites = get($headers, $titleResource, NULL);
  // Because relationships are bidirectional, we only look at dev/test sites.
  foreach ($websites as $website) {
    // if (!str_contains($website['primary_url'], 'agbu')) {
    //   continue;
    // }
    // Don't get any localhosts besides your own.
    if ($website['env'] == 'Dev' && $website['server'] !== gethostname()) {
      continue;
    }
    if ($website['canonical_primary_url']) {
      $mapping[strtolower($website['env'])][$website['canonical_primary_url']] = $website['primary_url'];
      $mapping['live'][$website['primary_url']] = $website['canonical_primary_url'];
    }
  }
  // Dev and test sites aren't connected to each other directly, so we can use the mapping to generate them.
  foreach ($mapping['dev'] as $liveSite => $devSite) {
    if (!isset($mapping['test'][$liveSite])) {
      continue;
    }
    $mapping['test'][$devSite] = $mapping['test'][$liveSite];
    $mapping['dev'][$mapping['test'][$liveSite]] = $devSite;
  }
  $mappingJson = json_encode($mapping);
  echo $mappingJson;
}

/**
 * Creates the login headers necessary to access the Drupal data.
 */
function loginHeaders(): array {
      # Get password from the "pass" utility.
      exec('/usr/bin/pass ls megaphone/crm/restpassword', $password);
      $password = $password[0];
      return login($password);
}

/**
 * Accepts a taxonomy term list from Drupal Services.
 * Outputs a hierarchical array of children, suitable for merging into the taxonomy.
 */
function buildGroupHierarchy($groups) {
  $hierarchicalList = [];
  $groupTids = array_combine(array_column($groups, 'tid'), array_column($groups, 'name'));
  foreach ($groups as $group) {
    if ($groupTids[$group['parent']] ?? FALSE) {
      $hierarchicalList[$groupTids[$group['parent']]]['children'][] = $group['name'];
    }
  }
  // Websites are in their own hierarchy.
  $hierarchicalList['websites']['children'] = ['websites_dev', 'websites_test', 'websites_live'];
  return $hierarchicalList;
}

/**
 * Accepts an array from Drupal Services Views, outputs an Ansible-compatible host list.
 *
 * @param array $servers
 *   The array that holds all the server data.
 * @param array $websites
 *   The array that holds all the website data.
 *
 * @return string $inventory This is a JSON-encoded inventory file in the format Ansible expects.
 */
function buildServerList($servers, $websites) {
  $inventory = [];
  foreach ($servers as $server) {
    // Pull in all field values as Ansible variables.
    foreach ($server as $key => $value) {
      if (!is_null($value)) {
        $key = str_replace(' ', '_', $key);
        $inventory['_meta']['hostvars'][$server['fqdn']][$key] = $value;
      }
      // Handle non-standard SSH ports.
      if ($server['security_ssh_port'] != 22) {
        $inventory['_meta']['hostvars'][$server['fqdn']]['ansible_port'] = $server['security_ssh_port'];
      }
    }
    // Put servers in groups.
    $groups = explode(', ', $server['group']);
    foreach ($groups as $group) {
      // Don't create a "blank" group.
      if (!$group) {
        continue;
      }
      // Don't get any localhosts besides your own.
      if ($group == 'localhosts' && $server['hostname'] !== gethostname()) {
        $ignoredServers[$server['hostname']] = TRUE;
        continue 2;
      }
      $inventory[$group]['hosts'][] = $server['fqdn'];
    }
  }
  // Websites go in their own group.
  if ($websites) {
    foreach ($websites as $website) {
      // Ignore localhost sites not on this localhost.
      if ($ignoredServers[$website['server']] ?? FALSE) {
        continue;
      }

      $inventory['_meta']['hostvars'][$website['bare_url']] = $website;
      // Put sites in groups per the "website_groups" field.
      $websiteGroups = explode(', ', $website['website_groups']) ?? NULL;
      foreach ($websiteGroups as $websiteGroup) {
        if ($websiteGroup) {
          $inventory[$websiteGroup][] = $website['bare_url'];
        }
      }
      // Put sites in groups based on environment.
      $envGroup = 'websites_' . strtolower($website['env']);
      $inventory[$envGroup][] = $website['bare_url'];
      // Also create maintenance groups.
      $maintenanceArray = [
        'maintenance_drupal' => 'Drupal',
        'maintenance_backdrop' => 'Backdrop',
        'maintenance_wp' => 'WordPress',
      ];
      foreach ($maintenanceArray as $group => $descriptor) {
        if (strpos($website['contract_type'], $descriptor . ' Maintenance') !== FALSE && $website['cms'] == $descriptor) {
          $inventory[$group][] = $website['bare_url'];
        }
      }
      // Drupal8 hack, sigh. Fix when D7 is no more.
      if (strpos($website['contract_type'], 'Drupal Maintenance') !== FALSE && $website['cms'] === 'Drupal8') {
        $inventory['maintenance_drupal8'][] = $website['bare_url'];
      }
      if (strpos($website['contract_type'], 'Civi Maintenance') !== false && $website['civicrm'] === 'Yes') {
        $inventory['maintenance_civi'][] = $website['bare_url'];
      }
      // Also put website data in the metadata of their respective server for building Icinga templates.}
      $parentServer = $inventory['_meta']['hostvars'][$website['server']] ?? NULL;
      if ($parentServer) {
        $inventory['_meta']['hostvars'][$website['server']]['sites'][$website['bare_url']] = $website;
      }
    }
  }
  return $inventory;
}

function post($curlHeaders, $operation, $postFields = NULL) {
  $curlHeaders[] = 'Content-Type: application/json';
  $curlHeaders[] = 'Accept: application/json';
  $curlOptions = [
    CURLOPT_HTTPHEADER => $curlHeaders,
    CURLOPT_RETURNTRANSFER => TRUE,
    CURLOPT_POST => 1,
    CURLOPT_URL => ENDPOINT . $operation,
    CURLOPT_POSTFIELDS => $postFields ? json_encode($postFields) : NULL,
  ];
  $curl = curl_init();
  curl_setopt_array($curl, $curlOptions);
  $result = curl_exec($curl);
  curl_close($curl);
  return json_decode($result);
}

function get($curlHeaders, $operation, $body = NULL) {
  $curlHeaders[] = 'Accept: application/json';
  $curlOptions = [
    CURLOPT_HTTPHEADER => $curlHeaders,
    CURLOPT_RETURNTRANSFER => TRUE,
    CURLOPT_URL => ENDPOINT . $operation,
  ];
  $curl = curl_init();
  curl_setopt_array($curl, $curlOptions);
  $result = curl_exec($curl);
  curl_close($curl);
  return json_decode($result, TRUE);
}

/**
 * Handle login (including getting a CSRF header)
 * @return array $headers The necessary headers to perform further POST/GET actions.
 */
function login($password) {
  $creds = [
    'username' => USERNAME,
    'password' => $password,
  ];

  $result = post(NULL, 'user/login.json', $creds);
  $headers[] = "Cookie: $result->session_name=$result->sessid";
  return $headers;
}

function help() {
  echo "Usage:\n";
  echo " --help               This message\n";
  echo " --list               Show all hosts\n";
  echo " --host <hostname>    Show a single host specified by <hostname>";
}