SyncTrayzor/server/version_check.php

<?php

/**
 * Version upgrade path manager for SyncTrayzor
 * 
 * Clients request this with their current version, arch, and variant (portable, etc)
 * and this gives them a version to upgrade to (if any), along with the method of
 * upgrading to it (manual navigation to Github release page, automatic silent upgrade,
 * etc). 
 * 
 * $versions is a record of all of the current releases, which we might want to upgrade
 * people to. It has the structure:
 * [
 *    version => [
 *       variant => [
 *          'url' => [
 *             arch => 'url',
 *             ...
 *          ],
 *       ],
 *       ...
 *       'release_notes' => release_notes,
 *    ],
 *    ...
 * ]
 *
 * version: version string e.g. '1.2.3'
 * variant: e.g. 'portable', 'installed'. Matched against the variant provided by the
 *          client, or '*' can be used to specify a default.
 * arch:    e.g. 'x86', 'x64'. Matched against the arch provided by the client, or '*'
 *          can used to specify a default.
 * release_notes: Release notes to display to the user.
 * 
 * $upgrades is a map of old_version => new_version, and specifies the formatter to
 * use to communicate with old_version. It also allows various overrides to be
 * specified (e.g. release notes)
 * It has the structure:
 * [
 *    old_version => ['to' => new_version, 'formatter' => formatter_version, 'overrides' => [overrides]],
 *    ...
 * ]
 *
 * old_version: version being upgraded from
 * new_version: version to upgrade to
 * formatter_version: formatter version to use (in $response_formatters)
 * overrides: optional overrides, used by the formatter
 */

set_error_handler('error_handler');
date_default_timezone_set('UTC');
header('Content-Type: application/json');

function error_handler($severity, $message, $filename, $lineno)
{
   throw new ErrorException($message, 0, $severity, $filename, $lineno);
}

function get_with_wildcard($src, $value, $default = null)
{
   if (isset($src[$value]))
      return $src[$value];
   if (isset($src['*']))
      return $src['*'];
   return $default;
}

$versions = [
   '1.1.28' => [
      'base_url' => 'https://github.com/canton7/SyncTrayzor/releases/download',
      'installed' => [
         'direct_download_url' => [
            'x64' => "{base_url}/v{version}/SyncTrayzorSetup-x64.exe",
            'x86' => "{base_url}/v{version}/SyncTrayzorSetup-x86.exe",
         ],
      ],
      'portable' => [
         'direct_download_url' => [
            'x64' => "{base_url}/v{version}/SyncTrayzorPortable-x64.zip",
            'x86' => "{base_url}/v{version}/SyncTrayzorPortable-x86.zip",
         ],
      ],     
      'sha1sum_download_url' => "{base_url}/v{version}/sha1sum.txt.asc",
      'sha512sum_download_url' => "{base_url}/v{version}/sha512sum.txt.asc",
      'release_page_url' => 'https://github.com/canton7/SyncTrayzor/releases/tag/v{version}',
      'release_notes' => "Add a workaround for an Intel Xe graphics driver bug which causes Syncthing's UI to appear blank.\n\nIf you are not affected by this, you do not need to upgrade.",
   ],
   '1.1.21' => [
      'base_url' => 'https://synctrayzor.antonymale.co.uk/download',
      'installed' => [
         'direct_download_url' => [
            'x64' => "{base_url}/v{version}/SyncTrayzorSetup-x64.exe",
            'x86' => "{base_url}/v{version}/SyncTrayzorSetup-x86.exe",
         ],
      ],
      'portable' => [
         'direct_download_url' => [
            'x64' => "{base_url}/v{version}/SyncTrayzorPortable-x64.zip",
            'x86' => "{base_url}/v{version}/SyncTrayzorPortable-x86.zip",
         ],
      ],     
      'sha1sum_download_url' => "{base_url}/v{version}/sha1sum.txt.asc",
      'sha512sum_download_url' => "{base_url}/v{version}/sha512sum.txt.asc",
      'release_page_url' => 'https://github.com/canton7/SyncTrayzor/releases/tag/v{version}',
      'release_notes' => "!!!!!\nYou must upgrade to v1.1.21 now, otherwise auto-upgrades will stop working!\n!!!!!\n\nFurther upgrades will be available once you have upgraded to v1.1.21.",
   ]
];

$upgrades = [
   '1.1.27' => ['to' => 'latest', 'formatter' => '5'],
   '1.1.26' => ['to' => 'latest', 'formatter' => '5'],
   '1.1.25' => ['to' => 'latest', 'formatter' => '5'],
   '1.1.24' => ['to' => 'latest', 'formatter' => '5'],
   '1.1.23' => ['to' => 'latest', 'formatter' => '5'],
   '1.1.22' => ['to' => 'latest', 'formatter' => '5'],
   '1.1.21' => ['to' => 'latest', 'formatter' => '5'],
   '1.1.20' => ['to' => 'latest', 'formatter' => '5'],
   // Github start supporting tls3 only, and versions prior to 1.1.20 didn't support this. 1.1.20 and 1.1.21 are hosted on my server. 1.1.20 can download
   // directly from github, but versions prior have to use my server. 
   '1.1.19' => ['to' => '1.1.21', 'formatter' => '5'],
   '1.1.18' => ['to' => '1.1.21', 'formatter' => '5'],
   '1.1.17' => ['to' => '1.1.21', 'formatter' => '5'],
   '1.1.16' => ['to' => '1.1.21', 'formatter' => '5'],
   '1.1.15' => ['to' => '1.1.21', 'formatter' => '5'],
   '1.1.14' => ['to' => '1.1.21', 'formatter' => '5'],
   '1.1.13' => ['to' => '1.1.21', 'formatter' => '5'],
   '1.1.12' => ['to' => '1.1.21', 'formatter' => '5'],
   '1.1.11' => ['to' => '1.1.21', 'formatter' => '5'],
   '1.1.10' => ['to' => '1.1.21', 'formatter' => '5'],
   '1.1.9' => ['to' => '1.1.21', 'formatter' => '5'],
   '1.1.8' => ['to' => '1.1.21', 'formatter' => '5'],
   '1.1.7' => ['to' => '1.1.21', 'formatter' => '4'],
   '1.1.6' => ['to' => '1.1.21', 'formatter' => '4'],
   '1.1.5' => ['to' => '1.1.21', 'formatter' => '4'],
   '1.1.4' => ['to' => '1.1.21', 'formatter' => '4'],
   '1.1.3' => ['to' => '1.1.21', 'formatter' => '4'],
   '1.1.2' => ['to' => '1.1.21', 'formatter' => '4'],
   '1.1.1' => ['to' => '1.1.21', 'formatter' => '3'],
   '1.1.0' => ['to' => '1.1.21', 'formatter' => '3'],
   '1.0.32' => ['to' => '1.1.21', 'formatter' => '3'],
   '1.0.31' => ['to' => '1.1.21', 'formatter' => '3'],
   '1.0.30' => ['to' => '1.1.21', 'formatter' => '3'],
   '1.0.29' => ['to' => '1.1.21', 'formatter' => '3'],
   '1.0.28' => ['to' => '1.1.21', 'formatter' => '3'],
   '1.0.27' => ['to' => '1.1.21', 'formatter' => '3'],
   '1.0.26' => ['to' => '1.1.21', 'formatter' => '3'],
   '1.0.25' => ['to' => '1.1.21', 'formatter' => '3'],
   '1.0.24' => ['to' => '1.1.21', 'formatter' => '3'],
   '1.0.23' => ['to' => '1.1.21', 'formatter' => '3'],
   '1.0.22' => ['to' => '1.1.21', 'formatter' => '2'],
   '1.0.21' => ['to' => '1.1.21', 'formatter' => '2'],
   '1.0.20' => ['to' => '1.1.21', 'formatter' => '2'],
   // 1.0.19 was never actually released, so no need to represent it
   '1.0.18' => ['to' => '1.1.21', 'formatter' => '2'],
   '1.0.17' => ['to' => '1.1.21', 'formatter' => '2'],
   '1.0.16' => ['to' => '1.1.21', 'formatter' => '2'],
   '1.0.15' => ['to' => '1.1.21', 'formatter' => '2'],
   '1.0.14' => ['to' => '1.1.21', 'formatter' => '2'],
   '1.0.13' => ['to' => '1.1.21', 'formatter' => '1'],
   '1.0.12' => ['to' => '1.1.21', 'formatter' => '1'],
];

$response_formatters = [
   // 1.0.12 and 1.0.13 shouldn't download installers directly, as they doesn't know how to run them properly
   '1' => function($arch, $variant, $to_version, $to_version_info, $overrides)
   {
      $data = [
         'version' => $to_version,
         'direct_download_url' => null,
         'release_page_url' => $to_version_info['release_page_url'],
         'release_notes' => isset($overrides['release_notes']) ? $overrides['release_notes'] : $to_version_info['release_notes'],
      ];

      return $data;
   },
   // Prior to sha1sum_download_url
   '2' => function($arch, $variant, $to_version, $to_version_info, $overrides)
   {
      $variant_info = isset($overrides[$variant]) ? get_with_wildcard($overrides, $variant) : get_with_wildcard($to_version_info, $variant);

      $data = [
         'version' => $to_version,
         'release_page_url' => $to_version_info['release_page_url'],
         'release_notes' => isset($overrides['release_notes']) ? $overrides['release_notes'] : $to_version_info['release_notes'],
      ];

      if ($variant == 'installed')
      {
         $data['direct_download_url'] = get_with_wildcard($variant_info['direct_download_url'], $arch);
      }

      return $data;
   },
   // Portable versions don't know how to handle directl downloads (or it's broken...)
   '3' => function($arch, $variant, $to_version, $to_version_info, $overrides)
   {
      $variant_info = isset($overrides[$variant]) ? get_with_wildcard($overrides, $variant) : get_with_wildcard($to_version_info, $variant);

      $data = [
         'version' => $to_version,
         'release_page_url' => $to_version_info['release_page_url'],
         'release_notes' => isset($overrides['release_notes']) ? $overrides['release_notes'] : $to_version_info['release_notes'],
      ];

      if ($variant == 'installed')
      {
         $data['direct_download_url'] = get_with_wildcard($variant_info['direct_download_url'], $arch);
         $data['sha1sum_download_url'] =  $to_version_info['sha1sum_download_url'];
      }

      return $data;
   },
   '4' => function($arch, $variant, $to_version, $to_version_info, $overrides)
   {
      $variant_info = isset($overrides[$variant]) ? get_with_wildcard($overrides, $variant) : get_with_wildcard($to_version_info, $variant);

      $data = [
         'version' => $to_version,
         'direct_download_url' => get_with_wildcard($variant_info['direct_download_url'], $arch),
         'sha1sum_download_url' => $to_version_info['sha1sum_download_url'],
         'release_page_url' => $to_version_info['release_page_url'],
         'release_notes' => isset($overrides['release_notes']) ? $overrides['release_notes'] : $to_version_info['release_notes'],
      ];

      return $data;
   },
   // Learnt about sha512sum
   '5' => function($arch, $variant, $to_version, $to_version_info, $overrides)
   {
      $variant_info = isset($overrides[$variant]) ? get_with_wildcard($overrides, $variant) : get_with_wildcard($to_version_info, $variant);

      $data = [
         'version' => $to_version,
         'direct_download_url' => get_with_wildcard($variant_info['direct_download_url'], $arch),
         'sha512sum_download_url' => $to_version_info['sha512sum_download_url'],
         'release_page_url' => $to_version_info['release_page_url'],
         'release_notes' => isset($overrides['release_notes']) ? $overrides['release_notes'] : $to_version_info['release_notes'],
      ];

      return $data;
   },
];

$error = null;
$loggable_error = null;
$data = null;

try
{
   $version = isset($_GET['version']) ? $_GET['version'] : null;
   $arch = isset($_GET['arch']) ? $_GET['arch'] : null;
   $variant = isset($_GET['variant']) ? $_GET['variant'] : null;


   if (empty($version) || empty($arch) || empty($variant))
   {
      $error = ['code' => 1, 'message' => 'version, arch, or variant not specified'];
   }
   else if (isset($upgrades[$version]))
   {
      $to_version = $upgrades[$version]['to'];
      if ($to_version == 'latest')
         $to_version = array_keys($versions)[0];

      $formatter = $response_formatters[$upgrades[$version]['formatter']];
      $overrides = isset($upgrades[$version]['overrides']) ? $upgrades[$version]['overrides'] : [];

      $base_url = isset($overrides['base_url']) ? $overrides['base_url'] : $versions[$to_version]['base_url'];

      array_walk_recursive($versions[$to_version], function(&$value, $key) use ($to_version, $base_url) {
         $value = str_replace('{version}', $to_version, $value);
         $value = str_replace('{base_url}', $base_url, $value);
      });
      $to_version_info = $versions[$to_version];

      $data = $formatter($arch, $variant, $to_version, $to_version_info, $overrides);
   }
}
catch (Exception $e)
{
   $error = ['code' => 2, 'message' => 'Unhandled error. Please try again later'];
   $loggable_error = $e->getMessage() . "\n" . $e->getTraceAsString();
}

$rsp = [];
if ($data != null)
   $rsp['data'] = $data;
if ($error != null)
   $rsp['error'] = $error;

$output = json_encode($rsp, JSON_UNESCAPED_SLASHES | JSON_FORCE_OBJECT);

$date = date('c');

$fp = fopen('log.txt', 'a+');
flock($fp, LOCK_EX);
fputcsv($fp, [$date, $_SERVER['REMOTE_ADDR'], $version, $arch, $variant, $data == null ? "N" : "Y", $loggable_error]);
fclose($fp);

echo $output;