coolify/bootstrap/helpers/shared.php

525 lines
16 KiB
PHP
Raw Normal View History

2023-05-24 14:26:50 +02:00
<?php
2023-10-20 14:51:01 +02:00
use App\Models\Application;
2023-06-12 12:00:01 +02:00
use App\Models\InstanceSettings;
2023-09-28 10:53:00 +02:00
use App\Models\Server;
2023-10-20 14:51:01 +02:00
use App\Models\Service;
use App\Models\StandaloneMariadb;
2023-10-20 14:51:01 +02:00
use App\Models\StandaloneMongodb;
use App\Models\StandaloneMysql;
2023-10-20 14:51:01 +02:00
use App\Models\StandalonePostgresql;
use App\Models\StandaloneRedis;
use App\Models\Team;
2023-09-14 18:22:08 +02:00
use App\Models\User;
2023-09-06 14:31:38 +02:00
use App\Notifications\Channels\DiscordChannel;
use App\Notifications\Channels\EmailChannel;
use App\Notifications\Channels\TelegramChannel;
use App\Notifications\Internal\GeneralNotification;
use DanHarrin\LivewireRateLimiting\Exceptions\TooManyRequestsException;
2023-05-24 14:26:50 +02:00
use Illuminate\Database\QueryException;
use Illuminate\Mail\Message;
use Illuminate\Notifications\Messages\MailMessage;
2023-09-27 12:45:53 +02:00
use Illuminate\Support\Collection;
2023-09-15 11:19:36 +02:00
use Illuminate\Support\Facades\Cache;
2023-10-04 14:40:26 +02:00
use Illuminate\Support\Facades\File;
2023-05-24 14:26:50 +02:00
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Mail;
2023-05-24 14:26:50 +02:00
use Illuminate\Support\Facades\Route;
use Illuminate\Support\Str;
2023-09-27 12:45:53 +02:00
use Illuminate\Support\Stringable;
use Poliander\Cron\CronExpression;
use Visus\Cuid2\Cuid2;
2023-08-22 17:44:49 +02:00
use phpseclib3\Crypt\RSA;
use Spatie\Url\Url;
2023-05-24 14:26:50 +02:00
2023-09-21 17:48:31 +02:00
function base_configuration_dir(): string
{
return '/data/coolify';
}
function application_configuration_dir(): string
{
2023-09-21 17:48:31 +02:00
return base_configuration_dir() . "/applications";
}
function service_configuration_dir(): string
{
return base_configuration_dir() . "/services";
}
function database_configuration_dir(): string
{
2023-09-21 17:48:31 +02:00
return base_configuration_dir() . "/databases";
}
2023-09-07 13:23:34 +02:00
function database_proxy_dir($uuid): string
{
2023-09-21 17:48:31 +02:00
return base_configuration_dir() . "/databases/$uuid/proxy";
2023-09-07 13:23:34 +02:00
}
function backup_dir(): string
{
2023-09-21 17:48:31 +02:00
return base_configuration_dir() . "/backups";
}
function generate_readme_file(string $name, string $updated_at): string
{
return "Resource name: $name\nLatest Deployment Date: $updated_at";
}
2023-08-22 17:44:49 +02:00
function isInstanceAdmin()
2023-08-14 16:56:13 +02:00
{
2023-08-22 17:44:49 +02:00
return auth()?->user()?->isInstanceAdmin() ?? false;
2023-08-14 16:56:13 +02:00
}
2023-08-22 17:44:49 +02:00
function currentTeam()
{
return auth()?->user()?->currentTeam() ?? null;
}
function showBoarding(): bool
{
2023-08-27 15:44:36 +02:00
return currentTeam()->show_boarding ?? false;
2023-08-22 17:44:49 +02:00
}
2023-09-08 18:33:26 +02:00
function refreshSession(?Team $team = null): void
2023-08-22 17:44:49 +02:00
{
2023-09-08 18:33:26 +02:00
if (!$team) {
2023-09-15 17:30:26 +02:00
if (auth()->user()?->currentTeam()) {
2023-09-15 11:28:44 +02:00
$team = Team::find(auth()->user()->currentTeam()->id);
} else {
$team = User::find(auth()->user()->id)->teams->first();
}
2023-09-08 18:33:26 +02:00
}
Cache::forget('team:' . auth()->user()->id);
Cache::remember('team:' . auth()->user()->id, 3600, function () use ($team) {
2023-09-08 18:33:26 +02:00
return $team;
});
2023-08-30 16:01:38 +02:00
session(['currentTeam' => $team]);
2023-08-22 17:44:49 +02:00
}
function handleError(?Throwable $error = null, ?Livewire\Component $livewire = null, ?string $customErrorMessage = null)
{
ray('handleError');
2023-09-22 08:52:07 +02:00
ray($error);
if ($error instanceof Throwable) {
$message = $error->getMessage();
} else {
$message = null;
}
if ($customErrorMessage) {
$message = $customErrorMessage . ' ' . $message;
}
if ($error instanceof TooManyRequestsException) {
if (isset($livewire)) {
return $livewire->emit('error', "Too many requests. Please try again in {$error->secondsUntilAvailable} seconds.");
}
return "Too many requests. Please try again in {$error->secondsUntilAvailable} seconds.";
}
if (isset($livewire)) {
2023-09-25 15:48:43 +02:00
return $livewire->emit('error', $message);
}
2023-09-22 08:52:07 +02:00
throw new RuntimeException($message);
}
function general_error_handler(Throwable $err, Livewire\Component $that = null, $isJson = false, $customErrorMessage = null): mixed
2023-05-24 14:26:50 +02:00
{
try {
2023-08-29 15:51:30 +02:00
ray($err);
ray('ERROR OCCURRED: ' . $err->getMessage());
2023-06-09 15:55:21 +02:00
if ($err instanceof QueryException) {
if ($err->errorInfo[0] === '23505') {
throw new Exception($customErrorMessage ?? 'Duplicate entry found.', '23505');
2023-06-09 15:55:21 +02:00
} else if (count($err->errorInfo) === 4) {
throw new Exception($customErrorMessage ?? $err->errorInfo[3]);
2023-05-24 14:26:50 +02:00
} else {
throw new Exception($customErrorMessage ?? $err->errorInfo[2]);
2023-05-24 14:26:50 +02:00
}
} elseif ($err instanceof TooManyRequestsException) {
2023-08-15 14:27:45 +02:00
throw new Exception($customErrorMessage ?? "Too many requests. Please try again in {$err->secondsUntilAvailable} seconds.");
} else {
2023-08-29 15:51:30 +02:00
if ($err->getMessage() === 'This action is unauthorized.') {
2023-08-31 15:00:59 +02:00
return redirect()->route('dashboard')->with('error', $customErrorMessage ?? $err->getMessage());
2023-08-29 15:51:30 +02:00
}
throw new Exception($customErrorMessage ?? $err->getMessage());
2023-05-24 14:26:50 +02:00
}
} catch (\Throwable $e) {
2023-05-24 14:26:50 +02:00
if ($that) {
2023-09-11 17:36:30 +02:00
return $that->emit('error', $customErrorMessage ?? $e->getMessage());
2023-05-24 14:26:50 +02:00
} elseif ($isJson) {
return response()->json([
2023-09-11 17:36:30 +02:00
'code' => $e->getCode(),
'error' => $e->getMessage(),
2023-05-24 14:26:50 +02:00
]);
} else {
2023-06-09 15:55:21 +02:00
ray($customErrorMessage);
2023-09-11 17:36:30 +02:00
ray($e);
return $customErrorMessage ?? $e->getMessage();
2023-05-24 14:26:50 +02:00
}
}
}
function get_route_parameters(): array
2023-05-24 14:26:50 +02:00
{
return Route::current()->parameters();
}
function get_latest_version_of_coolify(): string
2023-05-24 14:26:50 +02:00
{
2023-06-19 15:43:53 +02:00
try {
$response = Http::get('https://cdn.coollabs.io/coolify/versions.json');
$versions = $response->json();
return data_get($versions, 'coolify.v4.version');
} catch (\Throwable $e) {
2023-09-11 17:36:30 +02:00
//throw $e;
ray($e->getMessage());
2023-06-19 15:43:53 +02:00
return '0.0.0';
}
2023-05-24 14:26:50 +02:00
}
2023-09-19 15:51:13 +02:00
function generate_random_name(?string $cuid = null): string
2023-05-24 14:26:50 +02:00
{
$generator = new \Nubs\RandomNameGenerator\All(
[
new \Nubs\RandomNameGenerator\Alliteration(),
]
);
2023-09-19 15:51:13 +02:00
if (is_null($cuid)) {
$cuid = new Cuid2(7);
}
return Str::kebab("{$generator->getName()}-$cuid");
2023-05-24 14:26:50 +02:00
}
2023-08-22 17:44:49 +02:00
function generateSSHKey()
{
$key = RSA::createKey();
return [
'private' => $key->toString('PKCS1'),
2023-08-31 15:00:59 +02:00
'public' => $key->getPublicKey()->toString('OpenSSH', ['comment' => 'coolify-generated-ssh-key'])
2023-08-22 17:44:49 +02:00
];
}
2023-08-31 15:00:59 +02:00
function formatPrivateKey(string $privateKey)
{
2023-08-22 17:44:49 +02:00
$privateKey = trim($privateKey);
if (!str_ends_with($privateKey, "\n")) {
$privateKey .= "\n";
}
return $privateKey;
}
2023-09-19 15:51:13 +02:00
function generate_application_name(string $git_repository, string $git_branch, ?string $cuid = null): string
2023-05-24 15:47:04 +02:00
{
2023-09-19 15:51:13 +02:00
if (is_null($cuid)) {
$cuid = new Cuid2(7);
}
return Str::kebab("$git_repository:$git_branch-$cuid");
2023-05-24 15:47:04 +02:00
}
2023-06-12 12:00:01 +02:00
function is_transactional_emails_active(): bool
2023-06-12 12:00:01 +02:00
{
2023-08-31 15:00:59 +02:00
return isEmailEnabled(InstanceSettings::get());
2023-06-12 12:00:01 +02:00
}
2023-06-12 16:39:48 +02:00
2023-08-31 15:00:59 +02:00
function set_transanctional_email_settings(InstanceSettings | null $settings = null): string|null
2023-06-12 16:39:48 +02:00
{
2023-08-15 14:11:38 +02:00
if (!$settings) {
$settings = InstanceSettings::get();
}
2023-09-02 13:39:44 +02:00
config()->set('mail.from.address', data_get($settings, 'smtp_from_address'));
config()->set('mail.from.name', data_get($settings, 'smtp_from_name'));
2023-08-31 15:00:59 +02:00
if (data_get($settings, 'resend_enabled')) {
config()->set('mail.default', 'resend');
config()->set('resend.api_key', data_get($settings, 'resend_api_key'));
return 'resend';
}
2023-08-31 15:00:59 +02:00
if (data_get($settings, 'smtp_enabled')) {
config()->set('mail.default', 'smtp');
config()->set('mail.mailers.smtp', [
"transport" => "smtp",
"host" => data_get($settings, 'smtp_host'),
"port" => data_get($settings, 'smtp_port'),
"encryption" => data_get($settings, 'smtp_encryption'),
"username" => data_get($settings, 'smtp_username'),
"password" => data_get($settings, 'smtp_password'),
"timeout" => data_get($settings, 'smtp_timeout'),
"local_domain" => null,
]);
return 'smtp';
}
return null;
2023-06-12 16:39:48 +02:00
}
function base_ip(): string
2023-06-16 13:37:02 +02:00
{
if (isDev()) {
return "localhost";
2023-07-28 13:40:47 +02:00
}
2023-06-16 13:35:35 +02:00
$settings = InstanceSettings::get();
if ($settings->public_ipv4) {
return "$settings->public_ipv4";
}
if ($settings->public_ipv6) {
return "$settings->public_ipv6";
}
return "localhost";
2023-06-16 13:35:35 +02:00
}
2023-09-24 17:39:12 +02:00
function getFqdnWithoutPort(String $fqdn)
2023-09-24 12:10:36 +02:00
{
$url = Url::fromString($fqdn);
$host = $url->getHost();
$scheme = $url->getScheme();
2023-09-24 17:39:12 +02:00
$path = $url->getPath();
return "$scheme://$host$path";
}
/**
* If fqdn is set, return it, otherwise return public ip.
*/
function base_url(bool $withPort = true): string
2023-06-13 15:01:11 +02:00
{
$settings = InstanceSettings::get();
if ($settings->fqdn) {
return $settings->fqdn;
}
2023-06-14 09:05:13 +02:00
$port = config('app.port');
if ($settings->public_ipv4) {
2023-06-16 11:01:27 +02:00
if ($withPort) {
if (isDev()) {
return "http://localhost:$port";
2023-06-16 11:01:27 +02:00
}
return "http://$settings->public_ipv4:$port";
2023-06-16 11:01:27 +02:00
}
if (isDev()) {
2023-06-16 11:01:27 +02:00
return "http://localhost";
}
return "http://$settings->public_ipv4";
2023-06-14 09:05:13 +02:00
}
if ($settings->public_ipv6) {
2023-06-16 11:01:27 +02:00
if ($withPort) {
return "http://$settings->public_ipv6:$port";
2023-06-16 11:01:27 +02:00
}
return "http://$settings->public_ipv6";
2023-06-14 09:05:13 +02:00
}
return url('/');
2023-06-13 15:01:11 +02:00
}
2023-06-16 11:01:27 +02:00
function isDev(): bool
2023-06-16 11:01:27 +02:00
{
return config('app.env') === 'local';
}
2023-08-31 09:56:37 +02:00
function isCloud(): bool
2023-07-13 15:07:42 +02:00
{
2023-07-14 12:09:56 +02:00
return !config('coolify.self_hosted');
}
function validate_cron_expression($expression_to_validate): bool
{
$isValid = false;
$expression = new CronExpression($expression_to_validate);
$isValid = $expression->isValid();
if (isset(VALID_CRON_STRINGS[$expression_to_validate])) {
$isValid = true;
}
return $isValid;
}
function send_internal_notification(string $message): void
{
try {
$baseUrl = config('app.name');
$team = Team::find(0);
2023-09-06 14:31:38 +02:00
$team->notify(new GeneralNotification("👀 {$baseUrl}: " . $message));
ray("👀 {$baseUrl}: " . $message);
2023-09-11 17:36:30 +02:00
} catch (\Throwable $e) {
ray($e->getMessage());
}
}
2023-09-12 14:51:35 +02:00
function send_user_an_email(MailMessage $mail, string $email, ?string $cc = null): void
{
$settings = InstanceSettings::get();
2023-08-31 15:00:59 +02:00
$type = set_transanctional_email_settings($settings);
if (!$type) {
throw new Exception('No email settings found.');
}
2023-09-12 14:51:35 +02:00
if ($cc) {
Mail::send(
[],
[],
fn (Message $message) => $message
->to($email)
2023-09-14 18:41:21 +02:00
->replyTo($email)
2023-09-12 14:51:35 +02:00
->cc($cc)
->subject($mail->subject)
->html((string) $mail->render())
);
} else {
Mail::send(
[],
[],
fn (Message $message) => $message
->to($email)
->subject($mail->subject)
->html((string) $mail->render())
);
}
2023-08-31 15:00:59 +02:00
}
function isTestEmailEnabled($notifiable)
{
2023-10-06 10:47:48 +02:00
if (data_get($notifiable, 'use_instance_email_settings') && isInstanceAdmin()) {
return true;
} else if (data_get($notifiable, 'smtp_enabled') || data_get($notifiable, 'resend_enabled') && auth()->user()->isAdminFromSession()) {
return true;
}
return false;
}
2023-08-31 15:00:59 +02:00
function isEmailEnabled($notifiable)
{
return data_get($notifiable, 'smtp_enabled') || data_get($notifiable, 'resend_enabled') || data_get($notifiable, 'use_instance_email_settings');
}
2023-09-06 14:31:38 +02:00
function setNotificationChannels($notifiable, $event)
{
$channels = [];
$isEmailEnabled = isEmailEnabled($notifiable);
$isDiscordEnabled = data_get($notifiable, 'discord_enabled');
$isTelegramEnabled = data_get($notifiable, 'telegram_enabled');
$isSubscribedToEmailEvent = data_get($notifiable, "smtp_notifications_$event");
2023-09-06 14:31:38 +02:00
$isSubscribedToDiscordEvent = data_get($notifiable, "discord_notifications_$event");
$isSubscribedToTelegramEvent = data_get($notifiable, "telegram_notifications_$event");
if ($isDiscordEnabled && $isSubscribedToDiscordEvent) {
$channels[] = DiscordChannel::class;
}
if ($isEmailEnabled && $isSubscribedToEmailEvent) {
2023-09-06 14:31:38 +02:00
$channels[] = EmailChannel::class;
}
if ($isTelegramEnabled && $isSubscribedToTelegramEvent) {
$channels[] = TelegramChannel::class;
}
return $channels;
}
function parseEnvFormatToArray($env_file_contents)
{
2023-09-08 16:16:59 +02:00
$env_array = array();
$lines = explode("\n", $env_file_contents);
foreach ($lines as $line) {
if ($line === '' || substr($line, 0, 1) === '#') {
continue;
}
$equals_pos = strpos($line, '=');
if ($equals_pos !== false) {
$key = substr($line, 0, $equals_pos);
$value = substr($line, $equals_pos + 1);
if (substr($value, 0, 1) === '"' && substr($value, -1) === '"') {
$value = substr($value, 1, -1);
} elseif (substr($value, 0, 1) === "'" && substr($value, -1) === "'") {
2023-09-08 16:16:59 +02:00
$value = substr($value, 1, -1);
}
$env_array[$key] = $value;
}
}
return $env_array;
}
2023-09-27 12:45:53 +02:00
function data_get_str($data, $key, $default = null): Stringable
{
$str = data_get($data, $key, $default) ?? $default;
return Str::of($str);
}
2023-09-28 10:53:00 +02:00
2023-09-30 15:39:40 +02:00
function generateFqdn(Server $server, string $random)
{
$wildcard = data_get($server, 'settings.wildcard_domain');
if (is_null($wildcard) || $wildcard === '') {
$wildcard = sslip($server);
}
$url = Url::fromString($wildcard);
$host = $url->getHost();
$path = $url->getPath() === '/' ? '' : $url->getPath();
$scheme = $url->getScheme();
$finalFqdn = "$scheme://{$random}.$host$path";
2023-09-30 15:39:40 +02:00
return $finalFqdn;
}
2023-09-28 10:53:00 +02:00
function sslip(Server $server)
{
if (isDev()) {
2023-09-30 15:39:40 +02:00
return "http://127.0.0.1.sslip.io";
2023-09-28 10:53:00 +02:00
}
if ($server->ip === 'host.docker.internal') {
$baseIp = base_ip();
2023-09-30 15:39:40 +02:00
return "http://$baseIp.sslip.io";
2023-09-28 10:53:00 +02:00
}
2023-09-30 15:39:40 +02:00
return "http://{$server->ip}.sslip.io";
2023-09-28 10:53:00 +02:00
}
2023-09-28 22:20:49 +02:00
function getServiceTemplates()
{
if (isDev()) {
$services = File::get(base_path('templates/service-templates.json'));
$services = collect(json_decode($services))->sortKeys();
} else {
try {
$response = Http::retry(3, 50)->get(config('constants.services.official'));
if ($response->failed()) {
return collect([]);
}
$services = $response->json();
$services = collect($services)->sortKeys();
} catch (\Throwable $e) {
$services = collect([]);
2023-09-28 22:20:49 +02:00
}
}
// $version = config('version');
// $services = $services->map(function ($service) use ($version) {
// if (version_compare($version, data_get($service, 'minVersion', '0.0.0'), '<')) {
// $service->disabled = true;
// }
// return $service;
// });
2023-09-28 22:20:49 +02:00
return $services;
}
2023-10-20 14:51:01 +02:00
function getResourceByUuid(string $uuid, ?int $teamId = null)
{
$resource = queryResourcesByUuid($uuid);
if (!is_null($teamId)) {
2023-10-20 14:58:00 +02:00
if (!is_null($resource) && $resource->environment->project->team_id === $teamId) {
2023-10-20 14:51:01 +02:00
return $resource;
}
return null;
} else {
return $resource;
}
}
function queryResourcesByUuid(string $uuid)
{
$resource = null;
$application = Application::whereUuid($uuid)->first();
if ($application) return $application;
$service = Service::whereUuid($uuid)->first();
if ($service) return $service;
$postgresql = StandalonePostgresql::whereUuid($uuid)->first();
if ($postgresql) return $postgresql;
$redis = StandaloneRedis::whereUuid($uuid)->first();
if ($redis) return $redis;
$mongodb = StandaloneMongodb::whereUuid($uuid)->first();
if ($mongodb) return $mongodb;
$mysql = StandaloneMysql::whereUuid($uuid)->first();
if ($mysql) return $mysql;
$mariadb = StandaloneMariadb::whereUuid($uuid)->first();
if ($mariadb) return $mariadb;
2023-10-20 14:51:01 +02:00
return $resource;
}
function generateDeployWebhook($resource)
{
$baseUrl = base_url();
$api = Url::fromString($baseUrl) . '/api/v1';
$endpoint = '/deploy';
$uuid = data_get($resource, 'uuid');
$url = $api . $endpoint . "?uuid=$uuid&force=false";
return $url;
}
function generateGitManualWebhook($resource, $type) {
if ($resource->getMorphClass() === 'App\Models\Application') {
$baseUrl = base_url();
$api = Url::fromString($baseUrl) . "/webhooks/source/$type/events/manual";
return $api;
}
return null;
}
function removeAnsiColors($text)
{
return preg_replace('/\e[[][A-Za-z0-9];?[0-9]*m?/', '', $text);
}