Add basic info to application api

Author: lancepioch

app/Http/Controllers/Api/Application/PanelController.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Http\Controllers\Api\Application;
+
+use App\Http\Requests\Api\Application\GetPanelInfoRequest;
+use App\Transformers\Api\Application\PanelInfoTransformer;
+
+class PanelController extends ApplicationApiController
+{
+    /**
+     * Get panel statistics
+     *
+     * Returns panel information
+     *
+     * @return array<mixed>
+     */
+    public function __invoke(GetPanelInfoRequest $request): array
+    {
+        return $this->fractal->item(null)
+            ->transformWith($this->getTransformer(PanelInfoTransformer::class))
+            ->toArray();
+    }
+}

app/Http/Requests/Api/Application/GetPanelInfoRequest.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Http\Requests\Api\Application;
+
+use App\Services\Acl\Api\AdminAcl;
+
+class GetPanelInfoRequest extends ApplicationApiRequest
+{
+    protected ?string $resource = 'panel';
+
+    protected int $permission = AdminAcl::READ;
+
+    public function authorize(): bool
+    {
+        // Any valid application API key can access panel information
+        return $this->user() !== null;
+    }
+}

app/Transformers/Api/Application/PanelInfoTransformer.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace App\Transformers\Api\Application;
+
+use App\Services\Helpers\SoftwareVersionService;
+
+class PanelInfoTransformer extends BaseTransformer
+{
+    private SoftwareVersionService $versionService;
+
+    public function handle(SoftwareVersionService $versionService): void
+    {
+        $this->versionService = $versionService;
+    }
+
+    public function getResourceName(): string
+    {
+        return 'panel';
+    }
+
+    /**
+     * @param  null  $model
+     */
+    public function transform($model): array
+    {
+        $currentVersion = config('app.version', 'canary');
+
+        return [
+            'version' => $currentVersion,
+            'git_hash' => $this->getGitHash(),
+            'fqdn' => parse_url(config('app.url'), PHP_URL_HOST),
+            'url' => config('app.url'),
+            'timezone' => config('app.timezone'),
+            'latest_version' => $this->versionService->latestPanelVersion(),
+            'is_latest' => $this->versionService->isLatestPanel(),
+        ];
+    }
+
+    private function getGitHash(): ?string
+    {
+        if (file_exists(base_path('.git/HEAD'))) {
+            $head = explode(' ', file_get_contents(base_path('.git/HEAD')));
+            if (array_key_exists(1, $head)) {
+                $path = base_path('.git/' . trim($head[1]));
+                if (file_exists($path)) {
+                    return substr(file_get_contents($path), 0, 7);
+                }
+            }
+        }
+
+        return null;
+    }
+}

routes/api-application.php

@@ -173,6 +173,16 @@
     Route::delete('/{role:id}', [Application\Roles\RoleController::class, 'delete']);
 });
 
+/*
+|--------------------------------------------------------------------------
+| Panel Stats Controller Routes
+|--------------------------------------------------------------------------
+|
+| Endpoint: /api/application/panel
+|
+*/
+Route::get('/panel', Application\PanelController::class)->name('api.application.panel');
+
 /*
 |--------------------------------------------------------------------------
 | Plugin Controller Routes