Add support for premium extensions.

refs rob006-software/flarum-translations#306 refs #12
rob006-software · May 25, 2020 · 47bfb46 · 47bfb46
1 parent 6c34b9b
commit 47bfb46
Show file tree

Hide file tree

Showing 15 changed files with 326 additions and 168 deletions.
diff --git a/commands/ConfigController.php b/commands/ConfigController.php
@@ -15,6 +15,7 @@
 
 use app\components\ConsoleController;
 use app\components\extensions\ConfigGenerator;
+use app\models\RegularExtension;
 use app\models\Repository;
 use app\models\Translations;
 use Yii;
@@ -66,12 +67,13 @@ public function actionUpdate(array $projects = [], string $configFile = '@app/tr
 						Yii::warning("Unable to update {$component->getId()} extension.", __METHOD__);
 						continue;
 					}
-
-					$configGenerator->updateExtension($extension);
-					$this->commitRepository(
-						$translations->getRepository(),
-						"Update config for {$component->getId()}.\n\n{$extension->getTranslationTagsUrl()}"
-					);
+					if ($extension instanceof RegularExtension) {
+						$configGenerator->updateExtension($extension);
+						$this->commitRepository(
+							$translations->getRepository(),
+							"Update config for {$component->getId()}.\n\n{$extension->getTranslationTagsUrl()}"
+						);
+					}
 				}
 			}
 		}
@@ -86,6 +88,7 @@ private function getTranslations(string $configFile): Translations {
 			null,
 			require Yii::getAlias($configFile)
 		);
+		Yii::$app->extensionsRepository->setPremiumExtensions($translations->getPremiumExtensionsConfig());
 		if ($this->update) {
 			$output = $translations->getRepository()->update();
 			if ($this->verbose) {

diff --git a/commands/ExtensionsController.php b/commands/ExtensionsController.php
@@ -16,6 +16,7 @@
 use app\components\ConsoleController;
 use app\components\extensions\PullRequestGenerator;
 use app\models\ForkRepository;
+use app\models\RegularExtension;
 use app\models\Translations;
 use Yii;
 use const APP_ROOT;
@@ -79,6 +80,9 @@ public function actionDetectNew(int $limit = 2, string $configFile = '@app/trans
 			if (!$extension->hasTranslationSource()) {
 				unset($extensions[$index]);
 			}
+			if (!$extension instanceof RegularExtension) {
+				unset($extensions[$index]);
+			}
 		}
 
 		$repository = new ForkRepository(
@@ -99,6 +103,7 @@ private function getTranslations(string $configFile): Translations {
 			null,
 			require Yii::getAlias($configFile)
 		);
+		Yii::$app->extensionsRepository->setPremiumExtensions($translations->getPremiumExtensionsConfig());
 		if ($this->update) {
 			$output = $translations->getRepository()->update();
 			if ($this->verbose) {

diff --git a/commands/JanitorController.php b/commands/JanitorController.php
@@ -255,6 +255,7 @@ private function getTranslations(string $configFile): Translations {
 			null,
 			require Yii::getAlias($configFile)
 		);
+		Yii::$app->extensionsRepository->setPremiumExtensions($translations->getPremiumExtensionsConfig());
 		$translations->getRepository()->update();
 
 		return $translations;

diff --git a/commands/ReadmeController.php b/commands/ReadmeController.php
@@ -147,6 +147,7 @@ private function getTranslations(string $configFile): Translations {
 			null,
 			require Yii::getAlias($configFile)
 		);
+		Yii::$app->extensionsRepository->setPremiumExtensions($translations->getPremiumExtensionsConfig());
 		if ($this->update) {
 			$output = $translations->getRepository()->update();
 			if ($this->verbose) {

diff --git a/commands/ReleaseController.php b/commands/ReleaseController.php
@@ -78,6 +78,7 @@ private function getTranslations(string $configFile): Translations {
 			null,
 			require Yii::getAlias($configFile)
 		);
+		Yii::$app->extensionsRepository->setPremiumExtensions($translations->getPremiumExtensionsConfig());
 		if ($this->update) {
 			$output = $translations->getRepository()->update();
 			if ($this->verbose) {

diff --git a/commands/StatsController.php b/commands/StatsController.php
@@ -14,6 +14,7 @@
 namespace app\commands;
 
 use app\components\extensions\LanguageStatsGenerator;
+use app\models\RegularExtension;
 use app\models\Repository;
 use app\models\Translations;
 use Yii;
@@ -64,7 +65,7 @@ public function actionUpdate(array $languages = [], string $configFile = '@app/t
 				foreach ($translations->getProjects() as $project) {
 					foreach ($project->getExtensionsComponents() as $component) {
 						$extension = Yii::$app->extensionsRepository->getExtension($component->getId());
-						if ($extension !== null) {
+						if ($extension instanceof RegularExtension) {
 							$generator->addExtension($extension, !$component->isValidForLanguage($language));
 						}
 					}
@@ -97,6 +98,7 @@ private function getTranslations(string $configFile): Translations {
 			null,
 			require Yii::getAlias($configFile)
 		);
+		Yii::$app->extensionsRepository->setPremiumExtensions($translations->getPremiumExtensionsConfig());
 		if ($this->update) {
 			$output = $translations->getRepository()->update();
 			if ($this->verbose) {

diff --git a/commands/TranslationsController.php b/commands/TranslationsController.php
@@ -103,6 +103,7 @@ private function getTranslations(string $configFile): Translations {
 			null,
 			require Yii::getAlias($configFile)
 		);
+		Yii::$app->extensionsRepository->setPremiumExtensions($translations->getPremiumExtensionsConfig());
 		if ($this->update) {
 			$output = $translations->getRepository()->update();
 			if ($this->verbose) {

diff --git a/components/extensions/ConfigGenerator.php b/components/extensions/ConfigGenerator.php
@@ -14,6 +14,7 @@
 namespace app\components\extensions;
 
 use app\models\Extension;
+use app\models\RegularExtension;
 use Dont\DontCall;
 use Dont\DontCallStatic;
 use Dont\DontGet;
@@ -108,18 +109,20 @@ private function generateConfig(Extension $extension, $extensionConfig): string
 			$extensionConfig = [];
 		}
 
-		$extensionConfig['tag'] = $extension->getStableTranslationSourceUrl();
-		foreach ($extensionConfig as $key => $url) {
-			if (strncmp($key, 'tag:', 4) === 0) {
-				$extensionConfig[$key] = $extension->getStableTranslationSourceUrl([substr($key, 4)]);
+		if ($extension instanceof RegularExtension) {
+			$extensionConfig['tag'] = $extension->getStableTranslationSourceUrl();
+			foreach ($extensionConfig as $key => $url) {
+				if (strncmp($key, 'tag:', 4) === 0) {
+					$extensionConfig[$key] = $extension->getStableTranslationSourceUrl([substr($key, 4)]);
+				}
 			}
-		}
-		if (isset($extensionConfig['branch'])) {
-			$extensionConfig['branch'] = $extension->getTranslationSourceUrl();
-		}
-		foreach ($extensionConfig as $key => $url) {
-			if (strncmp($key, 'branch:', 7) === 0) {
-				$extensionConfig[$key] = $extension->getTranslationSourceUrl(substr($key, 4));
+			if (isset($extensionConfig['branch'])) {
+				$extensionConfig['branch'] = $extension->getTranslationSourceUrl();
+			}
+			foreach ($extensionConfig as $key => $url) {
+				if (strncmp($key, 'branch:', 7) === 0) {
+					$extensionConfig[$key] = $extension->getTranslationSourceUrl(substr($key, 4));
+				}
 			}
 		}
 

diff --git a/components/extensions/ExtensionsRepository.php b/components/extensions/ExtensionsRepository.php
@@ -19,6 +19,8 @@
 use app\components\extensions\exceptions\UnprocessableExtensionInterface;
 use app\models\Extension;
 use app\models\packagist\SearchResult;
+use app\models\PremiumExtension;
+use app\models\RegularExtension;
 use Composer\Semver\Semver;
 use Composer\Semver\VersionParser;
 use mindplay\readable;
@@ -50,6 +52,7 @@ final class ExtensionsRepository extends Component {
 
 	private $_extensions;
 	private $_client;
+	private $premiumExtensions = [];
 
 	/**
 	 * @param bool $useCache
@@ -94,6 +97,26 @@ public function getValidExtensions(array $supportedVersions, bool $useCache = tr
 		return $extensions;
 	}
 
+	// @todo I hope this is temporary solution - premium extensions config should be fetched directly from
+	//       https://extiverse.com/, but I don't know any public and stable API for this.
+	public function setPremiumExtensions(array $extensionsConfig): void {
+		$this->_extensions = null;
+		$this->premiumExtensions = [];
+		foreach ($extensionsConfig as $id => $extension) {
+			if (!$extension instanceof PremiumExtension) {
+				$extension = new PremiumExtension(
+					$id,
+					$extension['name'],
+					$extension['vendor'],
+					$extension['packageName'],
+					$extension['repositoryUrl']
+				);
+
+				$this->premiumExtensions[$id] = $extension;
+			}
+		}
+	}
+
 	private function getClient(): HttpClientInterface {
 		if ($this->_client === null) {
 			$this->_client = HttpClient::create();
@@ -108,10 +131,10 @@ private function fetchExtensions(): array {
 			'per_page' => 100,
 		]);
 
-		$extensions = [];
+		$extensions = $this->premiumExtensions;
 		foreach ($results as $result) {
 			assert($result instanceof SearchResult);
-			$extension = Extension::createFromPackagistSearchResult($result);
+			$extension = RegularExtension::createFromPackagistSearchResult($result);
 			if (
 				!isset($extensions[$extension->getId()])
 				// handle ID conflicts
@@ -124,7 +147,7 @@ private function fetchExtensions(): array {
 		return $extensions;
 	}
 
-	private function compareExtensions(Extension $a, Extension $b): int {
+	private function compareExtensions(RegularExtension $a, RegularExtension $b): int {
 		if ($b->isAbandoned()) {
 			return 1;
 		}

diff --git a/components/extensions/LanguageStatsGenerator.php b/components/extensions/LanguageStatsGenerator.php
@@ -16,7 +16,7 @@
 
 namespace app\components\extensions;
 
-use app\models\Extension;
+use app\models\RegularExtension;
 use app\models\Project;
 use Dont\DontCall;
 use Dont\DontCallStatic;
@@ -43,7 +43,7 @@ final class LanguageStatsGenerator {
 	use DontGet;
 	use DontSet;
 
-	/** @var Extension[] */
+	/** @var RegularExtension[] */
 	private $extensions = [];
 	/** @var bool */
 	private $disabledExtensions = [];
@@ -72,15 +72,15 @@ public function __construct(string $language, array $projects, string $sortingCr
 		}
 	}
 
-	public function addExtension(Extension $extension, bool $isDisabled): void {
+	public function addExtension(RegularExtension $extension, bool $isDisabled): void {
 		$this->extensions[] = $extension;
 		$this->stats[$extension->getId()] = $this->getStats($extension->getPackageName());
 		$this->disabledExtensions[$extension->getId()] = $isDisabled;
 	}
 
 	public function generate(): string {
 		$extensions = $this->extensions;
-		usort($extensions, function (Extension $a, Extension $b) {
+		usort($extensions, function (RegularExtension $a, RegularExtension $b) {
 			$result = $this->stats[$b->getId()][$this->sortingCriteria] <=> $this->stats[$a->getId()][$this->sortingCriteria];
 			if ($result === 0) {
 				$result = $this->stats[$b->getId()]['total'] <=> $this->stats[$a->getId()]['total'];
@@ -163,7 +163,7 @@ private function image(string $src, ?string $alt = null): string {
 		]);
 	}
 
-	private function stats(Extension $extension, string $statsType) : string {
+	private function stats(RegularExtension $extension, string $statsType) : string {
 		$badge = $this->statsChangeBadge($extension->getPackageName(), $statsType, $this->stats[$extension->getId()][$statsType]);
 		$statsUrl = "https://packagist.org/packages/{$extension->getPackageName()}/stats";
 

diff --git a/components/extensions/PullRequestGenerator.php b/components/extensions/PullRequestGenerator.php
@@ -14,7 +14,7 @@
 namespace app\components\extensions;
 
 use app\components\GithubApi;
-use app\models\Extension;
+use app\models\RegularExtension;
 use app\models\ForkRepository;
 use Dont\DontCall;
 use Dont\DontCallStatic;
@@ -46,7 +46,7 @@ public function __construct(ForkRepository $repository, ?GithubApi $githubApi =
 	}
 
 	/**
-	 * @param Extension[] $extensions
+	 * @param RegularExtension[] $extensions
 	 * @param int $limit
 	 */
 	public function generateForNewExtensions(array $extensions, int $limit): void {
@@ -77,7 +77,7 @@ public function generateForNewExtensions(array $extensions, int $limit): void {
 		}
 	}
 
-	private function updateBranch(string $branchName, Extension $extension): bool {
+	private function updateBranch(string $branchName, RegularExtension $extension): bool {
 		$this->repository->checkoutBranch($branchName);
 		$this->addExtensionToConfig($extension);
 		$this->repository->commit("Update config for {$extension->getPackageName()}.", $commited);
@@ -86,13 +86,13 @@ private function updateBranch(string $branchName, Extension $extension): bool {
 		return $commited;
 	}
 
-	private function addExtensionToConfig(Extension $extension): void {
+	private function addExtensionToConfig(RegularExtension $extension): void {
 		$filePath = $this->repository->getPath() . "/config/{$extension->getProjectId()}-project.php";
 		$generator = new ConfigGenerator($filePath);
 		$generator->updateExtension($extension);
 	}
 
-	private function openPullRequestForNewExtension(string $branchName, Extension $extension): void {
+	private function openPullRequestForNewExtension(string $branchName, RegularExtension $extension): void {
 		$this->githubApi->openPullRequest(
 			Yii::$app->params['translationsRepository'],
 			Yii::$app->params['translationsForkRepository'],
@@ -115,7 +115,7 @@ private function updatePullRequestForNewExtension(string $branchName): void {
 		);
 	}
 
-	private function generatePullRequestBadges(Extension $extension): string {
+	private function generatePullRequestBadges(RegularExtension $extension): string {
 		$name = $extension->getPackageName();
 
 		$output = <<<MD