Initial commit

application/Espo/Classes/ConsoleCommands/CheckFilePermissions.php

@@ -0,0 +1,66 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Classes\ConsoleCommands;
+
+use Espo\Core\Console\Command;
+use Espo\Core\Console\Command\Params;
+use Espo\Core\Console\IO;
+use Espo\Core\Utils\File\Manager as FileManager;
+use Espo\Core\Utils\System;
+use Espo\Core\Utils\Util;
+
+/**
+ * @noinspection PhpUnused
+ */
+class CheckFilePermissions implements Command
+{
+    public function __construct(
+        private FileManager $fileManager,
+        private System $system
+    ) {}
+
+    public function run(Params $params, IO $io): void
+    {
+        $io->writeLine("\nNote: Run this command under the web server user.\n");
+
+        $io->writeLine('Writable:');
+        $io->writeLine('');
+
+        foreach ($this->fileManager->getPermissionUtils()->getWritableList() as $path) {
+            $fullPath = Util::concatPath($this->system->getRootDir(), $path);
+
+            $isWritable = $this->fileManager->isWritable($fullPath);
+
+            $msg = " " . ($isWritable ? "OK" : "FAIL") . " : $path";
+
+            $io->writeLine($msg);
+        }
+    }
+}

application/Espo/Classes/ConsoleCommands/CreateAdminUser.php

@@ -0,0 +1,103 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Classes\ConsoleCommands;
+
+use Espo\Core\Console\Command;
+use Espo\Core\Console\Command\Params;
+use Espo\Core\Console\IO;
+use Espo\Core\Name\Field;
+use Espo\Core\Utils\Config;
+use Espo\Entities\User;
+use Espo\ORM\EntityManager;
+
+use RuntimeException;
+
+class CreateAdminUser implements Command
+{
+    public function __construct(
+        private EntityManager $entityManager,
+        private Config $config
+    ) {}
+
+    public function run(Params $params, IO $io): void
+    {
+        $userName = $params->getArgument(0);
+
+        if (!$userName) {
+            $io->writeLine("A username must be specified as the first argument.");
+            $io->setExitStatus(1);
+
+            return;
+        }
+
+        /** @var ?string $regExp */
+        $regExp = $this->config->get('userNameRegularExpression');
+
+        if (!$regExp) {
+            throw new RuntimeException("No `userNameRegularExpression` in config.");
+        }
+
+        if (
+            str_contains($userName, ' ') ||
+            preg_replace("/{$regExp}/", '_', $userName) !== $userName
+        ) {
+            $io->writeLine("Not allowed username.");
+            $io->setExitStatus(1);
+
+            return;
+        }
+
+        $repository = $this->entityManager->getRDBRepositoryByClass(User::class);
+
+        $existingUser = $repository
+            ->where(['userName' => $userName])
+            ->findOne();
+
+        if ($existingUser) {
+            $io->writeLine("A user with the same username already exists.");
+            $io->setExitStatus(1);
+
+            return;
+        }
+
+        $user = $repository->getNew();
+
+        $user->set('userName', $userName);
+        $user->set('type', User::TYPE_ADMIN);
+        $user->set(Field::NAME, $userName);
+
+        $repository->save($user);
+
+        $message = "The user '{$userName}' has been created. " .
+            "Set password with the command: `bin/command set-password {$userName}`.";
+
+        $io->writeLine($message);
+    }
+}

application/Espo/Classes/ConsoleCommands/Import.php

@@ -0,0 +1,137 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Classes\ConsoleCommands;
+
+use Espo\Tools\Import\Service;
+
+use Espo\Core\Utils\File\Manager as FileManager;
+use Espo\Core\Console\Command;
+use Espo\Core\Console\Command\Params;
+use Espo\Core\Console\IO;
+
+use Throwable;
+
+class Import implements Command
+{
+    public function __construct(private Service $service, private FileManager $fileManager)
+    {}
+
+    public function run(Params $params, IO $io) : void
+    {
+        $id = $params->getOption('id');
+        $filePath = $params->getOption('file');
+        $paramsId = $params->getOption('paramsId');
+
+        $forceResume = $params->hasFlag('resume');
+        $revert = $params->hasFlag('revert');
+
+        if (!$id && $filePath) {
+            if (!$paramsId) {
+                $io->writeLine("You need to specify --params-id option.");
+
+                return;
+            }
+
+            if (!$this->fileManager->isFile($filePath)) {
+                $io->writeLine("File not found.");
+
+                return;
+            }
+
+            $contents = $this->fileManager->getContents($filePath);
+
+            try {
+                $result = $this->service->importContentsWithParamsId($contents, $paramsId);
+
+                $resultId = $result->getId();
+                $countCreated = $result->getCountCreated();
+                $countUpdated = $result->getCountUpdated();
+                $countError = $result->getCountError();
+                $countDuplicate = $result->getCountDuplicate();
+            } catch (Throwable $e) {
+                $io->writeLine("Error occurred: " . $e->getMessage());
+
+                return;
+            }
+
+            $io->writeLine("Finished.");
+            $io->writeLine("  Import ID: {$resultId}");
+            $io->writeLine("  Created: {$countCreated}");
+            $io->writeLine("  Updated: {$countUpdated}");
+            $io->writeLine("  Duplicates: {$countDuplicate}");
+            $io->writeLine("  Errors: {$countError}");
+
+            return;
+        }
+
+        if ($id && $revert) {
+            $io->writeLine("Reverting import...");
+
+            try {
+                $this->service->revert($id);
+            } catch (Throwable $e) {
+                $io->writeLine("Error occurred: " . $e->getMessage());
+
+                return;
+            }
+
+            $io->writeLine("Finished.");
+
+            return;
+        }
+
+        if ($id) {
+            $io->writeLine("Running import, this may take a while...");
+
+            try {
+                $result = $this->service->importById($id, true, $forceResume);
+            } catch (Throwable $e) {
+                $io->writeLine("Error occurred: " . $e->getMessage());
+
+                return;
+            }
+
+            $countCreated = $result->getCountCreated();
+            $countUpdated = $result->getCountUpdated();
+            $countError = $result->getCountError();
+            $countDuplicate = $result->getCountDuplicate();
+
+            $io->writeLine("Finished.");
+            $io->writeLine("  Created: {$countCreated}");
+            $io->writeLine("  Updated: {$countUpdated}");
+            $io->writeLine("  Duplicates: {$countDuplicate}");
+            $io->writeLine("  Errors: {$countError}");
+
+            return;
+        }
+
+        $io->writeLine("Not enough params passed.");
+    }
+}

application/Espo/Classes/ConsoleCommands/PopulateArrayValues.php

@@ -0,0 +1,108 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Classes\ConsoleCommands;
+
+use Espo\Core\Console\Command;
+use Espo\Core\Console\Command\Params;
+use Espo\Core\Console\IO;
+use Espo\Core\Exceptions\Error;
+use Espo\Core\ORM\Entity as CoreEntity;
+use Espo\Entities\ArrayValue;
+use Espo\ORM\Entity;
+use Espo\ORM\EntityManager;
+use Espo\Repositories\ArrayValue as ArrayValueRepository;
+
+class PopulateArrayValues implements Command
+{
+    private EntityManager $entityManager;
+
+    public function __construct(EntityManager $entityManager)
+    {
+        $this->entityManager = $entityManager;
+    }
+
+    /**
+     * @throws Error
+     */
+    public function run(Params $params, IO $io): void
+    {
+        $entityType = $params->getArgument(0);
+        $field = $params->getArgument(1);
+
+        if (!$entityType || !$field) {
+            throw new Error("Entity type and field should be passed as arguments.");
+        }
+
+        if (!$this->entityManager->hasRepository($entityType)) {
+            throw new Error("Bad entity type.");
+        }
+
+        $defs = $this->entityManager->getDefs()->getEntity($entityType);
+
+        if (!$defs->hasAttribute($field)) {
+            throw new Error("Bad field.");
+        }
+
+        if ($defs->getAttribute($field)->getType() !== Entity::JSON_ARRAY) {
+            throw new Error("Non-array field.");
+        }
+
+        if ($defs->getAttribute($field)->isNotStorable()) {
+            throw new Error("Not-storable field.");
+        }
+
+        if (!$defs->getAttribute($field)->getParam('storeArrayValues')) {
+            throw new Error("Array values disabled for the field..");
+        }
+
+        $collection = $this->entityManager
+            ->getRDBRepository($entityType)
+            ->sth()
+            ->find();
+
+        /** @var ArrayValueRepository $repository */
+        $repository = $this->entityManager->getRepository(ArrayValue::ENTITY_TYPE);
+
+        foreach ($collection as $i => $entity) {
+            if (!$entity instanceof CoreEntity) {
+                throw new Error();
+            }
+
+            $repository->storeEntityAttribute($entity, $field);
+
+            if ($i % 1000 === 0) {
+                $io->write('.');
+            }
+        }
+
+        $io->writeLine('');
+        $io->writeLine('Done.');
+    }
+}

application/Espo/Classes/ConsoleCommands/PopulateNumbers.php

@@ -0,0 +1,116 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Classes\ConsoleCommands;
+
+use Espo\Core\Console\Command;
+use Espo\Core\Console\Command\Params;
+use Espo\Core\Console\Exceptions\ArgumentNotSpecified;
+use Espo\Core\Console\Exceptions\InvalidArgument;
+use Espo\Core\Console\IO;
+use Espo\Core\Exceptions\Error;
+use Espo\Core\FieldProcessing\NextNumber\BeforeSaveProcessor;
+use Espo\Core\Name\Field;
+use Espo\Core\ORM\Entity as CoreEntity;
+use Espo\Core\ORM\Repository\Option\SaveOption;
+use Espo\ORM\EntityManager;
+use Espo\ORM\Query\Part\Order;
+
+class PopulateNumbers implements Command
+{
+    private BeforeSaveProcessor $beforeSaveProcessor;
+    private EntityManager $entityManager;
+
+    public function __construct(
+        BeforeSaveProcessor $beforeSaveProcessor,
+        EntityManager $entityManager
+    ) {
+        $this->beforeSaveProcessor = $beforeSaveProcessor;
+        $this->entityManager = $entityManager;
+    }
+
+    /**
+     * @throws Error
+     */
+    public function run(Params $params, IO $io): void
+    {
+        $entityType = $params->getArgument(0);
+        $field = $params->getArgument(1);
+
+        $orderBy = $params->getOption('orderBy') ?? Field::CREATED_AT;
+        $order = strtoupper($params->getOption('order') ?? Order::ASC);
+
+        if (!$entityType) {
+            throw new ArgumentNotSpecified("No entity type argument.");
+        }
+
+        if (!$field) {
+            throw new ArgumentNotSpecified("No field argument.");
+        }
+
+        if ($order !== Order::ASC && $order !== Order::DESC) {
+            throw new InvalidArgument("Bad order option.");
+        }
+
+        $fieldType = $this->entityManager
+            ->getDefs()
+            ->getEntity($entityType)
+            ->getField($field)
+            ->getType();
+
+        if ($fieldType !== 'number') {
+            throw new InvalidArgument("Field `{$field}` is not of `number` type.");
+        }
+
+        $collection = $this->entityManager
+            ->getRDBRepository($entityType)
+            ->where([
+                $field => null,
+            ])
+            ->order($orderBy, $order)
+            ->sth()
+            ->find();
+
+        foreach ($collection as $i => $entity) {
+            if (!$entity instanceof CoreEntity) {
+                throw new Error();
+            }
+
+            $this->beforeSaveProcessor->processPopulate($entity, $field);
+            $this->entityManager->saveEntity($entity, [SaveOption::IMPORT => true]);
+
+            if ($i % 1000 === 0) {
+                $io->write('.');
+            }
+        }
+
+        $io->writeLine('');
+        $io->writeLine('Done.');
+    }
+}

application/Espo/Classes/ConsoleCommands/RebuildCategoryPaths.php

@@ -0,0 +1,69 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Classes\ConsoleCommands;
+
+use Espo\Core\Console\Command;
+use Espo\Core\Console\Command\Params;
+use Espo\Core\Console\IO;
+use Espo\Tools\CategoryTree\RebuildPaths;
+use Exception;
+
+class RebuildCategoryPaths implements Command
+{
+    private RebuildPaths $rebuildPaths;
+
+    public function __construct(RebuildPaths $rebuildPaths)
+    {
+        $this->rebuildPaths = $rebuildPaths;
+    }
+
+    public function run(Params $params, IO $io): void
+    {
+        $entityType = $params->getArgument(0);
+
+        if (!$entityType) {
+            $io->setExitStatus(1);
+            $io->writeLine("Error: No entity type. Should be specified as the first argument.");
+
+            return;
+        }
+
+        try {
+            $this->rebuildPaths->run($entityType);
+        } catch (Exception $e) {
+            $io->setExitStatus(1);
+            $io->writeLine("Error: " . $e->getMessage());
+
+            return;
+        }
+
+        $io->writeLine("Done.");
+    }
+}