Make translation tools theme-aware

Author: ghalse

src/SimpleSAML/Command/UnusedTranslatableStringsCommand.php

@@ -55,6 +55,13 @@ protected function configure(): void
             InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
             'Which modules to perform this action on',
         );
+        $this->addOption(
+            'themes',
+            null,
+            InputOption::VALUE_NEGATABLE,
+            'Include/exclude templates from themes directories of modules (default --themes)',
+            true, /* safe default, so we don't lose translations */
+        );
     }
 
 
@@ -99,7 +106,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $phpScanner = new PhpScanner(...$translationDomains);
         $phpScanner->setFunctions(['trans' => 'gettext', 'noop' => 'gettext']);
 
-        $translationUtils = new Utils\Translate(Configuration::getInstance());
+        $translationUtils = new Utils\Translate(
+            Configuration::getInstance(),
+            $input->getOption('themes'),
+        );
         $twigTranslations = [];
         // Scan files in base
         foreach ($modules as $module) {

src/SimpleSAML/Command/UpdateTranslatableStringsCommand.php

@@ -63,6 +63,13 @@ protected function configure(): void
             InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
             'Which modules to perform this action on',
         );
+        $this->addOption(
+            'themes',
+            null,
+            InputOption::VALUE_NEGATABLE,
+            'Include/exclude templates from themes directories of modules (default --no-themes)',
+            false,
+        );
     }
 
     /**
@@ -127,7 +134,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $phpScanner = new PhpScanner(...$translationDomains);
         $phpScanner->setFunctions(['trans' => 'gettext', 'noop' => 'gettext']);
 
-        $translationUtils = new Utils\Translate(Configuration::getInstance());
+        $translationUtils = new Utils\Translate(
+            Configuration::getInstance(),
+            $input->getOption('themes'),
+        );
         $twigTranslations = [];
         // Scan files in base
         foreach ($modules as $module) {

src/SimpleSAML/Utils/Translate.php

@@ -6,11 +6,20 @@
 
 use Gettext\Scanner\PhpScanner;
 use SimpleSAML\Configuration;
+use SimpleSAML\Module;
 use SimpleSAML\XHTML\Template;
 use Symfony\Bridge\Twig\Translation\TwigExtractor;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Translation\MessageCatalogue;
 
+use array_merge;
+use explode;
+use in_array;
+use is_dir;
+use str_starts_with;
+use strlen;
+use substr;
+
 /**
  * @package SimpleSAMLphp
  */
@@ -45,19 +54,48 @@ public function getTranslationsFromPhp(string $module, PhpScanner $phpScanner):
     }
 
 
-    public function getTranslationsFromTwig(string $module): array
+    public function getTranslationsFromTwig(string $module, bool $includeThemes = false): array
     {
         $twigTranslations = [];
         $moduleDir = $this->baseDir . ($module === '' ? '' : 'modules/' . $module . '/');
         $moduleTemplateDir = $moduleDir . 'templates/';
+        $moduleThemeDir = $moduleDir . 'themes/';
+        $moduleDirs = [];
+        if (is_dir($moduleTemplateDir)) {
+            $moduleDirs[] = $moduleTemplateDir;
+        }
+        if ($includeThemes && is_dir($moduleThemeDir)) {
+            $moduleDirs[] = $moduleThemeDir;
+        }
 
         // Scan Twig-templates
         $finder = new Finder();
-        foreach ($finder->files()->in($moduleTemplateDir)->name('*.twig') as $file) {
-            $template = new Template(
-                $this->configuration,
-                ($module ? ($module . ':') : '') . $file->getRelativePathname(),
-            );
+        foreach ($finder->files()->in($moduleDirs)->name('*.twig') as $file) {
+            if (!($includeThemes && str_starts_with($file->getPathname(), $moduleThemeDir))) {
+                /* process templates */
+                $template = new Template(
+                    $this->configuration,
+                    ($module ? ($module . ':') : '') . $file->getRelativePathname(),
+                );
+            } else {
+                /* process themed templates from other modules */
+                list($theme, $themedModule) = explode(DIRECTORY_SEPARATOR, substr($file->getPath(), strlen($moduleThemeDir)), 2);
+                if ($themedModule !== 'default' && !Module::isModuleEnabled($themedModule)) {
+                    throw new Exception(
+                        'The module \'' . $themedModule . '\' (themed by \'' . $module . ':' . $theme . '\') is not enabled.'
+                    );
+                }
+                $template = new Template(
+                    Configuration::loadFromArray(
+                        array_merge(
+                            $this->configuration->toArray(),
+                            ['theme.use' => $module . ':' . $theme,],
+                        ),
+                    ),
+                    ($themedModule !== 'default' ? ($themedModule . ':') : '') .
+                    substr($file->getRelativePathname(), strlen($theme . DIRECTORY_SEPARATOR . $themedModule) + 1),
+                );
+            }
 
             $catalogue = new MessageCatalogue('en', []);
             $extractor = new TwigExtractor($template->getTwig());