[Intl] Add Timezones

symfony · fabpot · Apr 21, 2019 · Oct 1, 2018 · Apr 21, 2019 · 4bea1981ff115d65dc561d08dbb9197c99f07770
commit 4bea1981ff115d65dc561d08dbb9197c99f07770
diff --git a/src/Symfony/Component/Intl/CHANGELOG.md b/src/Symfony/Component/Intl/CHANGELOG.md
@@ -9,6 +9,7 @@ CHANGELOG
  * added `Languages` and `Scripts` in favor of `Intl::getLanguageBundle()`
  * added `Locales` in favor of `Intl::getLocaleBundle()`
  * added `Regions` in favor of `Intl::getRegionBundle()`
+ * added `Timezones`
 
 4.2.0
 -----

diff --git a/src/Symfony/Component/Intl/Data/Generator/TimezoneDataGenerator.php b/src/Symfony/Component/Intl/Data/Generator/TimezoneDataGenerator.php
@@ -0,0 +1,158 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Intl\Data\Generator;
+
+use Symfony\Component\Intl\Data\Bundle\Compiler\GenrbCompiler;
+use Symfony\Component\Intl\Data\Bundle\Reader\BundleReaderInterface;
+use Symfony\Component\Intl\Data\Util\ArrayAccessibleResourceBundle;
+use Symfony\Component\Intl\Data\Util\LocaleScanner;
+
+/**
+ * The rule for compiling the zone bundle.
+ *
+ * @author Roland Franssen <franssen.roland@gmail.com>
+ *
+ * @internal
+ */
+class TimezoneDataGenerator extends AbstractDataGenerator
+{
+    /**
+     * Collects all available zone codes.
+     *
+     * @var string[]
+     */
+    private $zoneCodes = [];
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function scanLocales(LocaleScanner $scanner, $sourceDir)
+    {
+        return $scanner->scanLocales($sourceDir.'/zone');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function compileTemporaryBundles(GenrbCompiler $compiler, $sourceDir, $tempDir)
+    {
+        $compiler->compile($sourceDir.'/zone', $tempDir);
+        $compiler->compile($sourceDir.'/misc/timezoneTypes.txt', $tempDir);
+        $compiler->compile($sourceDir.'/misc/metaZones.txt', $tempDir);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function preGenerate()
+    {
+        $this->zoneCodes = [];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function generateDataForLocale(BundleReaderInterface $reader, $tempDir, $displayLocale)
+    {
+        $localeBundle = $reader->read($tempDir, $displayLocale);
+
+        if (isset($localeBundle['zoneStrings']) && null !== $localeBundle['zoneStrings']) {
+            $data = [
+                'Version' => $localeBundle['Version'],
+                'Names' => self::generateZones(
+                    $reader->read($tempDir, 'timezoneTypes'),
+                    $reader->read($tempDir, 'metaZones'),
+                    $reader->read($tempDir, 'root'),
+                    $localeBundle
+                ),
+            ];
+
+            $this->zoneCodes = array_merge($this->zoneCodes, array_keys($data['Names']));
+
+            return $data;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function generateDataForRoot(BundleReaderInterface $reader, $tempDir)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function generateDataForMeta(BundleReaderInterface $reader, $tempDir)
+    {
+        $rootBundle = $reader->read($tempDir, 'root');
+
+        $this->zoneCodes = array_unique($this->zoneCodes);
+
+        sort($this->zoneCodes);
+
+        $data = [
+            'Version' => $rootBundle['Version'],
+            'Zones' => $this->zoneCodes,
+        ];
+
+        return $data;
+    }
+
+    private static function generateZones(ArrayAccessibleResourceBundle $typeBundle, ArrayAccessibleResourceBundle $metaBundle, ArrayAccessibleResourceBundle $rootBundle, ArrayAccessibleResourceBundle $localeBundle): array
+    {
+        $available = [];
+        foreach ($typeBundle['typeMap']['timezone'] as $zone => $_) {
+            if ('Etc:Unknown' === $zone || preg_match('~^Etc:GMT[-+]\d+$~', $zone)) {
+                continue;
+            }
+
+            $available[$zone] = true;
+        }
+
+        $metazones = [];
+        foreach ($metaBundle['metazoneInfo'] as $zone => $info) {
+            foreach ($info as $metazone) {
+                $metazones[$zone] = $metazone->get(0);
+            }
+        }
+
+        $zones = [];
+        foreach (array_keys($available) as $zone) {
+            // lg: long generic, e.g. "Central European Time"
+            // ls: long specific (not DST), e.g. "Central European Standard Time"
+            // ld: long DST, e.g. "Central European Summer Time"
+            // ec: example city, e.g. "Amsterdam"
+            $name = $localeBundle['zoneStrings'][$zone]['lg'] ?? $rootBundle['zoneStrings'][$zone]['lg'] ?? $localeBundle['zoneStrings'][$zone]['ls'] ?? $rootBundle['zoneStrings'][$zone]['ls'] ?? null;
+            $city = $localeBundle['zoneStrings'][$zone]['ec'] ?? $rootBundle['zoneStrings'][$zone]['ec'] ?? null;
+
+            if (null === $name && isset($metazones[$zone])) {
+                $meta = 'meta:'.$metazones[$zone];
+                $name = $localeBundle['zoneStrings'][$meta]['lg'] ?? $rootBundle['zoneStrings'][$meta]['lg'] ?? $localeBundle['zoneStrings'][$meta]['ls'] ?? $rootBundle['zoneStrings'][$meta]['ls'] ?? null;
+            }
+            if (null === $city && 0 !== strrpos($zone, 'Etc:') && false !== $i = strrpos($zone, ':')) {
+                $city = str_replace('_', ' ', substr($zone, $i + 1));
+            }
+            if (null === $name) {
+                continue;
+            }
+            if (null !== $city) {
+                $name .= ' ('.$city.')';
+            }
+
+            $id = str_replace(':', '/', $zone);
+            $zones[$id] = $name;
+        }
+
+        return $zones;
+    }
+}
diff --git a/src/Symfony/Component/Intl/Intl.php b/src/Symfony/Component/Intl/Intl.php
@@ -64,6 +64,11 @@ final class Intl
      */
     const REGION_DIR = 'regions';
 
+    /**
+     * The directory name of the zone data.
+     */
+    public const TIMEZONE_DIR = 'timezones';
+
     /**
      * @var ResourceBundle\CurrencyBundleInterface
      */

diff --git a/src/Symfony/Component/Intl/Resources/bin/update-data.php b/src/Symfony/Component/Intl/Resources/bin/update-data.php
@@ -20,6 +20,7 @@
 use Symfony\Component\Intl\Data\Generator\LocaleDataGenerator;
 use Symfony\Component\Intl\Data\Generator\RegionDataGenerator;
 use Symfony\Component\Intl\Data\Generator\ScriptDataGenerator;
+use Symfony\Component\Intl\Data\Generator\TimezoneDataGenerator;
 use Symfony\Component\Intl\Data\Provider\LanguageDataProvider;
 use Symfony\Component\Intl\Data\Provider\RegionDataProvider;
 use Symfony\Component\Intl\Data\Provider\ScriptDataProvider;
@@ -195,6 +196,7 @@
         $targetDir.'/'.Intl::LOCALE_DIR,
         $targetDir.'/'.Intl::REGION_DIR,
         $targetDir.'/'.Intl::SCRIPT_DIR,
+        $targetDir.'/'.Intl::TIMEZONE_DIR,
     ]);
 }
 
@@ -256,6 +258,11 @@
 //
 //$filesystem->remove($txtDir);
 
+echo "Generating zone data...\n";
+
+$generator = new TimezoneDataGenerator($compiler, Intl::TIMEZONE_DIR);
+$generator->generateData($config);
+
 echo "Resource bundle compilation complete.\n";
 
 $gitInfo = <<<GIT_INFO