Initial commit

application/Espo/Core/Utils/SystemUser.php

@@ -0,0 +1,71 @@
+<?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\Core\Utils;
+
+/**
+ * A system user utility.
+ */
+class SystemUser
+{
+    /**
+     * A system user username.
+     */
+    public const NAME = 'system';
+
+    private const ID = 'system';
+    private const UUID = 'ffffffff-ffff-ffff-ffff-ffffffffffff';
+
+    private string $id;
+
+    public function __construct(Metadata $metadata, Config $config)
+    {
+        $id = $config->get('systemUserId');
+
+        if ($id) {
+            $this->id = $id;
+
+            return;
+        }
+
+        $isUuid = $metadata->get(['app', 'recordId', 'dbType']) === 'uuid';
+
+        $this->id = $isUuid ?
+            self::UUID :
+            self::ID;
+    }
+
+    /**
+     * Get a system user ID.
+     */
+    public function getId(): string
+    {
+        return $this->id;
+    }
+}