diff --git a/ProcessMaker/Http/Controllers/Api/ImportController.php b/ProcessMaker/Http/Controllers/Api/ImportController.php index e008bf2e1c..a6c598afa0 100644 --- a/ProcessMaker/Http/Controllers/Api/ImportController.php +++ b/ProcessMaker/Http/Controllers/Api/ImportController.php @@ -41,7 +41,7 @@ public function preview(Request $request, $version = null): JsonResponse return response()->json(['error' => $e->getMessage()], 400); } - $options = new Options([]); + $options = new Options([], $request->user()?->id); $importer = new Importer($payload, $options); $manifest = $importer->previewImport(); @@ -80,7 +80,10 @@ public function import(Request $request): JsonResponse return response()->json(['error' => $e->getMessage()], 400); } - $options = new Options(json_decode(file_get_contents(utf8_decode($request->file('options'))), true)); + $options = new Options( + json_decode(file_get_contents(utf8_decode($request->file('options'))), true), + $request->user()?->id + ); $importer = new Importer($payload, $options); $manifest = $importer->doImport(); diff --git a/ProcessMaker/Http/Controllers/Api/ScriptController.php b/ProcessMaker/Http/Controllers/Api/ScriptController.php index 2d9172d398..7fa45f84f7 100644 --- a/ProcessMaker/Http/Controllers/Api/ScriptController.php +++ b/ProcessMaker/Http/Controllers/Api/ScriptController.php @@ -369,6 +369,7 @@ public function show(Script $script) */ public function store(Request $request) { + $this->authorizeModulesExecution($request); $request->validate(Script::rules()); $script = new Script(); $script->fill($request->input()); @@ -421,6 +422,7 @@ public function store(Request $request) */ public function update(Script $script, Request $request) { + $this->authorizeModulesExecution($request, $script); $request->validate(Script::rules($script)); $script->fill($request->input()); $original = array_intersect_key($script->getOriginal(), $script->getDirty()); @@ -437,6 +439,20 @@ public function update(Script $script, Request $request) return response($request, 204); } + private function authorizeModulesExecution(Request $request, ?Script $script = null): void + { + $executionMode = $request->input('execution_mode', $script?->execution_mode); + if ($executionMode !== Script::EXECUTION_MODE_MODULES) { + return; + } + + if ($this->canUseModules($request)) { + return; + } + + $request->merge(['execution_mode' => Script::EXECUTION_MODE_BARE]); + } + /** * Update a draft script. * @@ -514,6 +530,7 @@ public function draft(Script $script, Request $request) */ public function duplicate(Script $script, Request $request) { + $this->authorizeModulesExecution($request, $script); $request->validate(Script::rules()); $newScript = new Script(); @@ -532,12 +549,27 @@ public function duplicate(Script $script, Request $request) $newScript->description = $request->input('description'); } + $newScript->execution_mode = $request->input( + 'execution_mode', + $script->execution_mode === Script::EXECUTION_MODE_MODULES + && $this->canUseModules($request) + ? Script::EXECUTION_MODE_MODULES + : Script::EXECUTION_MODE_BARE + ); $newScript->saveOrFail(); ScriptDuplicated::dispatch($newScript, $newScript->getChanges()); return new ScriptResource($newScript); } + private function canUseModules(Request $request): bool + { + return (bool) ( + $request->user()?->is_administrator + || $request->user()?->can('run-in-process-modules') + ); + } + /** * Delete a script in a process. * diff --git a/ProcessMaker/ImportExport/Exporters/ScriptExporter.php b/ProcessMaker/ImportExport/Exporters/ScriptExporter.php index c1083bbca5..6fc731eace 100644 --- a/ProcessMaker/ImportExport/Exporters/ScriptExporter.php +++ b/ProcessMaker/ImportExport/Exporters/ScriptExporter.php @@ -6,6 +6,7 @@ use Illuminate\Support\Facades\Log; use ProcessMaker\ImportExport\DependentType; use ProcessMaker\Models\EnvironmentVariable; +use ProcessMaker\Models\Script; use ProcessMaker\Models\ScriptCategory; use ProcessMaker\Models\User; @@ -51,6 +52,13 @@ public function import() : bool // Update environment variable references in script code $this->updateEnvironmentVariableReferences(); + if ( + $this->model->execution_mode === Script::EXECUTION_MODE_MODULES + && !$this->canUseModules() + ) { + $this->model->execution_mode = Script::EXECUTION_MODE_BARE; + } + // Pre-save cleanup for data source scripts to prevent constraint violations if ($this->mode === 'update' && $this->model->exists) { // Check if this script has any data source relationships that might cause conflicts @@ -70,6 +78,15 @@ public function import() : bool return $this->model->save(); } + private function canUseModules(): bool + { + $user = $this->options->importingUserId + ? User::find($this->options->importingUserId) + : auth()->user(); + + return (bool) ($user?->is_administrator || $user?->can('run-in-process-modules')); + } + private function getEnvironmentVariables() : array { $environmentVariables = EnvironmentVariable::get(); diff --git a/ProcessMaker/Jobs/ImportV2.php b/ProcessMaker/Jobs/ImportV2.php index 8937976082..ac857031bf 100644 --- a/ProcessMaker/Jobs/ImportV2.php +++ b/ProcessMaker/Jobs/ImportV2.php @@ -83,7 +83,7 @@ private function runImport($logger) return; } - $options = new Options($options); + $options = new Options($options, $this->userId); $importer = new Importer($payload, $options, $logger); if ($this->isPreview) { $manifest = $importer->previewImport(); diff --git a/ProcessMaker/Jobs/TestScript.php b/ProcessMaker/Jobs/TestScript.php index 0e46e9a2cb..48ce1cbc82 100644 --- a/ProcessMaker/Jobs/TestScript.php +++ b/ProcessMaker/Jobs/TestScript.php @@ -15,6 +15,7 @@ use ProcessMaker\Models\User; use ProcessMaker\ScriptRunners\InProcessPhpRunner; use ProcessMaker\ScriptRuntime\ScriptExecutionContext; +use ProcessMaker\Services\ScriptExecutionModeResolver; use Throwable; class TestScript implements ShouldQueue @@ -133,7 +134,15 @@ private function runInProcessPreview(): array } $timeout = max(1, $timeout); - if (config('core-service-task.execution', 'modules') === 'modules') { + $executionMode = app(ScriptExecutionModeResolver::class)->resolve($this->script); + if ( + $executionMode === Script::EXECUTION_MODE_MODULES + && !$this->canUseModules() + ) { + $executionMode = Script::EXECUTION_MODE_BARE; + } + + if ($executionMode === Script::EXECUTION_MODE_MODULES) { $context = new ScriptExecutionContext( data: $this->data, config: $this->configuration, @@ -158,6 +167,14 @@ private function runInProcessPreview(): array return ['output' => $output]; } + private function canUseModules(): bool + { + return (bool) ( + $this->current_user?->is_administrator + || $this->current_user?->can('run-in-process-modules') + ); + } + /** * Send a response to the user interface * diff --git a/ProcessMaker/Models/Script.php b/ProcessMaker/Models/Script.php index d97984af57..c9d461ee00 100644 --- a/ProcessMaker/Models/Script.php +++ b/ProcessMaker/Models/Script.php @@ -31,6 +31,7 @@ * @property text code * @property int timeout * @property bool allow_in_process + * @property string execution_mode * * @OA\Schema( * schema="scriptsEditable", @@ -40,6 +41,7 @@ * @OA\Property(property="code", type="string"), * @OA\Property(property="timeout", type="integer"), * @OA\Property(property="allow_in_process", type="boolean"), + * @OA\Property(property="execution_mode", type="string", enum={"bare", "modules"}), * @OA\Property(property="run_as_user_id", type="integer"), * @OA\Property(property="key", type="string"), * @OA\Property(property="script_category_id", type="integer"), @@ -65,6 +67,15 @@ */ class Script extends ProcessMakerModel implements ScriptInterface { + public const EXECUTION_MODE_BARE = 'bare'; + + public const EXECUTION_MODE_MODULES = 'modules'; + + public const EXECUTION_MODES = [ + self::EXECUTION_MODE_BARE, + self::EXECUTION_MODE_MODULES, + ]; + use SerializeToIso8601; use HideSystemResources; use HasCategories; @@ -90,6 +101,7 @@ class Script extends ProcessMakerModel implements ScriptInterface 'retry_attempts' => 'integer', 'retry_wait_time' => 'integer', 'allow_in_process' => 'boolean', + 'execution_mode' => 'string', ]; protected $appends = [ @@ -120,6 +132,15 @@ public static function boot() ]); } + if ( + $script->execution_mode === self::EXECUTION_MODE_MODULES + && (!$script->allow_in_process || strtolower((string) $script->language) !== 'php') + ) { + throw \Illuminate\Validation\ValidationException::withMessages([ + 'execution_mode' => [__('Modules execution requires an allowed PHP script.')], + ]); + } + // Execute the clear cache callback $clearCacheCallback($script); }); @@ -164,6 +185,7 @@ public static function rules($existing = null) 'run_as_user_id' => 'required', 'timeout' => 'integer|min:0|max:65535', 'allow_in_process' => 'sometimes|boolean', + 'execution_mode' => ['sometimes', Rule::in(self::EXECUTION_MODES)], 'script_category_id' => [new CategoryRule($existing)], ]; } diff --git a/ProcessMaker/ScriptRunners/ScriptRunner.php b/ProcessMaker/ScriptRunners/ScriptRunner.php index b4e5805319..07408f2d8d 100644 --- a/ProcessMaker/ScriptRunners/ScriptRunner.php +++ b/ProcessMaker/ScriptRunners/ScriptRunner.php @@ -10,6 +10,7 @@ use ProcessMaker\Models\ScriptExecutor; use ProcessMaker\Models\User; use ProcessMaker\ScriptRuntime\ScriptExecutionContext; +use ProcessMaker\Services\ScriptExecutionModeResolver; class ScriptRunner { @@ -115,7 +116,10 @@ private function runInProcess($code, array $data, array $config, $timeout, ?User { $effectiveTimeout = $this->resolveTimeout((int) $timeout, (int) $this->script->timeout); - if (config('core-service-task.execution', 'modules') === 'modules') { + if ( + app(ScriptExecutionModeResolver::class)->resolve($this->script) + === Script::EXECUTION_MODE_MODULES + ) { $context = new ScriptExecutionContext( data: $data, config: $config, diff --git a/ProcessMaker/ScriptRuntime/ScriptRuntime.php b/ProcessMaker/ScriptRuntime/ScriptRuntime.php index 42c3d2b70c..43443d004e 100644 --- a/ProcessMaker/ScriptRuntime/ScriptRuntime.php +++ b/ProcessMaker/ScriptRuntime/ScriptRuntime.php @@ -59,6 +59,7 @@ public function run(string $code, ScriptExecutionContext $context): mixed { $instances = $this->instantiateModules($context); $scriptPath = $this->writeTempScript($code); + $hasExplicitReturn = $this->hasExplicitReturn($code); $accessToken = null; $envSnapshot = null; @@ -75,15 +76,28 @@ public function run(string $code, ScriptExecutionContext $context): mixed 'modules' => array_keys($instances), ]); - return (static function (string $__scriptPath, ScriptExecutionContext $__context, array $__instances) { + $result = (static function ( + string $__scriptPath, + ScriptExecutionContext $__context, + array $__instances, + bool $__hasExplicitReturn + ) { + $result = ['response' => 'Error: add a result array']; extract([ 'data' => $__context->data, 'config' => $__context->config, 'modules' => $__instances, - ] + $__instances, EXTR_SKIP); + ], EXTR_SKIP); + extract($__instances, EXTR_SKIP); - return include $__scriptPath; - })($scriptPath, $context, $instances); + $output = include $__scriptPath; + + return (($output === 1 || $output === null) && !$__hasExplicitReturn) + ? $result + : $output; + })($scriptPath, $context, $instances, $hasExplicitReturn); + + return $result; } catch (Throwable $exception) { throw new ScriptException($exception->getMessage(), (int) $exception->getCode(), $exception); } finally { @@ -223,4 +237,82 @@ private function normalizeCode(string $code): string return "isTopLevelReturn($token, $functionBodyDepths)) { + return true; + } + + $this->processArrayToken($token, $braceDepth, $pendingFunctionBody); + continue; + } + + if ($token === '{') { + $this->openBrace( + $braceDepth, + $functionBodyDepths, + $pendingFunctionBody + ); + continue; + } + + if ($token === '}') { + $this->closeBrace($braceDepth, $functionBodyDepths); + continue; + } + + if ($token === ';') { + $pendingFunctionBody = false; + } + } + + return false; + } + + private function isTopLevelReturn(array $token, array $functionBodyDepths): bool + { + return $token[0] === T_RETURN && empty($functionBodyDepths); + } + + private function processArrayToken( + array $token, + int &$braceDepth, + bool &$pendingFunctionBody + ): void { + if ($token[0] === T_FUNCTION) { + $pendingFunctionBody = true; + } + + if ($token[0] === T_CURLY_OPEN) { + $braceDepth++; + } + } + + private function openBrace( + int &$braceDepth, + array &$functionBodyDepths, + bool &$pendingFunctionBody + ): void { + $braceDepth++; + if ($pendingFunctionBody) { + $functionBodyDepths[] = $braceDepth; + $pendingFunctionBody = false; + } + } + + private function closeBrace(int &$braceDepth, array &$functionBodyDepths): void + { + if (!empty($functionBodyDepths) && end($functionBodyDepths) === $braceDepth) { + array_pop($functionBodyDepths); + } + + $braceDepth--; + } } diff --git a/ProcessMaker/ServiceTaskImplementations/CoreServiceTask.php b/ProcessMaker/ServiceTaskImplementations/CoreServiceTask.php index 070a146028..eb739c884c 100644 --- a/ProcessMaker/ServiceTaskImplementations/CoreServiceTask.php +++ b/ProcessMaker/ServiceTaskImplementations/CoreServiceTask.php @@ -9,13 +9,14 @@ use ProcessMaker\Models\User; use ProcessMaker\ScriptRunners\InProcessPhpRunner; use ProcessMaker\ScriptRuntime\ScriptExecutionContext; +use ProcessMaker\Services\ScriptExecutionModeResolver; /** * ServiceTask implementation that runs allowlisted PHP scripts in-process * without Docker or the script microservice. * - * execution=modules (default): Laravel worker + ScriptRuntime modules. - * execution=bare: PHP subprocess without Laravel (legacy). + * execution_mode=modules: Laravel worker + ScriptRuntime modules. + * execution_mode=bare: PHP subprocess without Laravel. */ class CoreServiceTask implements ServiceTaskImplementationInterface { @@ -63,7 +64,7 @@ public function run(array $data, array $config, $tokenId = '', $timeout = 0) $effectiveTimeout = $this->resolveTimeout((int) $timeout, (int) $script->timeout); - if ($this->usesModulesExecution()) { + if ($this->usesModulesExecution($script)) { $context = new ScriptExecutionContext( data: $data, config: $config, @@ -90,9 +91,10 @@ public function run(array $data, array $config, $tokenId = '', $timeout = 0) return ScriptRuntime::normalizeOutput($output); } - private function usesModulesExecution(): bool + private function usesModulesExecution(Script $script): bool { - return config('core-service-task.execution', 'modules') === 'modules'; + return app(ScriptExecutionModeResolver::class)->resolve($script) + === Script::EXECUTION_MODE_MODULES; } /** diff --git a/ProcessMaker/Services/ScriptExecutionModeResolver.php b/ProcessMaker/Services/ScriptExecutionModeResolver.php new file mode 100644 index 0000000000..8ea025cca0 --- /dev/null +++ b/ProcessMaker/Services/ScriptExecutionModeResolver.php @@ -0,0 +1,26 @@ +allow_in_process) { + return Script::EXECUTION_MODE_BARE; + } + + $mode = $script->execution_mode ?: config('core-service-task.execution', Script::EXECUTION_MODE_BARE); + + if ( + $mode !== Script::EXECUTION_MODE_MODULES + || !config('core-service-task.modules_enabled', false) + ) { + return Script::EXECUTION_MODE_BARE; + } + + return Script::EXECUTION_MODE_MODULES; + } +} diff --git a/config/core-service-task.php b/config/core-service-task.php index 9550920311..326ffbe984 100644 --- a/config/core-service-task.php +++ b/config/core-service-task.php @@ -30,7 +30,10 @@ | bare: legacy PHP subprocess without Laravel/autoload (no modules). | */ - 'execution' => env('CORE_SERVICE_TASK_EXECUTION', 'modules'), + 'execution' => env('CORE_SERVICE_TASK_EXECUTION', 'bare'), + + // Modules must be enabled globally before a script can select them. + 'modules_enabled' => env('CORE_SERVICE_TASK_MODULES_ENABLED', false), /* | Optional dedicated queue name for RunServiceTask nodes that set diff --git a/database/migrations/2026_11_12_000000_add_execution_mode_to_scripts_tables.php b/database/migrations/2026_11_12_000000_add_execution_mode_to_scripts_tables.php new file mode 100644 index 0000000000..bde692a11b --- /dev/null +++ b/database/migrations/2026_11_12_000000_add_execution_mode_to_scripts_tables.php @@ -0,0 +1,34 @@ +string('execution_mode', 16) + ->default('bare') + ->after('allow_in_process'); + }); + + Schema::table('script_versions', function (Blueprint $table): void { + $table->string('execution_mode', 16) + ->default('bare') + ->after('allow_in_process'); + }); + } + + public function down(): void + { + Schema::table('scripts', function (Blueprint $table): void { + $table->dropColumn('execution_mode'); + }); + + Schema::table('script_versions', function (Blueprint $table): void { + $table->dropColumn('execution_mode'); + }); + } +}; diff --git a/database/seeders/PermissionSeeder.php b/database/seeders/PermissionSeeder.php index 7ba4437677..420e0a8a51 100644 --- a/database/seeders/PermissionSeeder.php +++ b/database/seeders/PermissionSeeder.php @@ -66,6 +66,7 @@ class PermissionSeeder extends Seeder 'delete-scripts', 'edit-scripts', 'view-scripts', + 'run-in-process-modules', 'create-script-categories', 'delete-script-categories', 'edit-script-categories', diff --git a/resources/views/processes/scripts/edit.blade.php b/resources/views/processes/scripts/edit.blade.php index 8190826930..0b25291bee 100644 --- a/resources/views/processes/scripts/edit.blade.php +++ b/resources/views/processes/scripts/edit.blade.php @@ -99,6 +99,19 @@ class="custom-control-input"