unreal-engine-mcp-server 0.5.4 → 0.5.5

package/src/tools/handlers/system-handlers.ts

@@ -1,564 +0,0 @@
-import { cleanObject } from '../../utils/safe-json.js';
-import { ITools } from '../../types/tool-interfaces.js';
-import { executeAutomationRequest } from './common-handlers.js';
-
-export async function handleSystemTools(action: string, args: any, tools: ITools) {
-  const sysAction = String(action || '').toLowerCase();
-  switch (sysAction) {
-    case 'show_fps':
-      await tools.systemTools.executeConsoleCommand(args.enabled !== false ? 'stat fps' : 'stat fps 0');
-      return { success: true, message: `FPS display ${args.enabled !== false ? 'enabled' : 'disabled'}`, action: 'show_fps' };
-    case 'profile': {
-      const rawType = typeof args?.profileType === 'string' ? args.profileType.trim() : '';
-      const profileKey = rawType ? rawType.toLowerCase() : 'cpu';
-      const enabled = args?.enabled !== false;
-
-      // Use built-in stat commands that are known to exist in editor builds.
-      // "stat unit" is a safe choice for CPU profiling in most configurations.
-      const profileMap: Record<string, string> = {
-        cpu: 'stat unit',
-        gamethread: 'stat game',
-        renderthread: 'stat scenerendering',
-        gpu: 'stat gpu',
-        memory: 'stat memory',
-        fps: 'stat fps',
-        all: 'stat unit'
-      };
-
-      const cmd = profileMap[profileKey];
-      if (!cmd) {
-        return {
-          success: false,
-          error: 'INVALID_PROFILE_TYPE',
-          message: `Unsupported profileType: ${rawType || String(args?.profileType ?? '')}`,
-          action: 'profile',
-          profileType: args?.profileType
-        };
-      }
-
-      await tools.systemTools.executeConsoleCommand(cmd);
-      return {
-        success: true,
-        message: `Profiling ${enabled ? 'enabled' : 'disabled'} (${rawType || 'CPU'})`,
-        action: 'profile',
-        profileType: rawType || 'CPU'
-      };
-    }
-    case 'set_quality':
-      const quality = args.quality || args.level || 'medium'; // handle 'level' as well since test uses it
-      let qVal: number;
-      if (typeof quality === 'number') {
-        qVal = quality;
-      } else {
-        const qStr = String(quality).toLowerCase();
-        qVal = (qStr === 'high' || qStr === 'epic') ? 3 : (qStr === 'low' ? 0 : (qStr === 'cinematic' ? 4 : 1));
-      }
-
-      const category = String(args.category || 'ViewDistance').toLowerCase();
-      let cvar = 'sg.ViewDistanceQuality';
-
-      if (category.includes('shadow')) cvar = 'sg.ShadowQuality';
-      else if (category.includes('texture')) cvar = 'sg.TextureQuality';
-      else if (category.includes('effect')) cvar = 'sg.EffectsQuality';
-      else if (category.includes('postprocess')) cvar = 'sg.PostProcessQuality';
-      else if (category.includes('foliage')) cvar = 'sg.FoliageQuality';
-      else if (category.includes('shading')) cvar = 'sg.ShadingQuality';
-      else if (category.includes('globalillumination') || category.includes('gi')) cvar = 'sg.GlobalIlluminationQuality';
-      else if (category.includes('reflection')) cvar = 'sg.ReflectionQuality';
-      else if (category.includes('viewdistance')) cvar = 'sg.ViewDistanceQuality';
-
-      await tools.systemTools.executeConsoleCommand(`${cvar} ${qVal}`);
-      return { success: true, message: `${category} quality derived from '${quality}' set to ${qVal} via ${cvar}`, action: 'set_quality' };
-    case 'execute_command':
-      return cleanObject(await tools.systemTools.executeConsoleCommand(args.command));
-    case 'create_widget': {
-      const name = typeof args?.name === 'string' ? args.name.trim() : '';
-      const widgetPathRaw = typeof args?.widgetPath === 'string' ? args.widgetPath.trim() : '';
-
-      // If name is missing but widgetPath is provided, try to extract name from path
-      let effectiveName = name || `NewWidget_${Date.now()}`;
-      let effectivePath = typeof args?.savePath === 'string' ? args.savePath.trim() : '';
-
-      if (!name && widgetPathRaw) {
-        const parts = widgetPathRaw.split('/').filter((p: string) => p.length > 0);
-        if (parts.length > 0) {
-          effectiveName = parts[parts.length - 1];
-          // If path was provided as widgetPath, use the directory as savePath if savePath wasn't explicit
-          if (!effectivePath) {
-            effectivePath = '/' + parts.slice(0, parts.length - 1).join('/');
-          }
-        }
-      }
-
-      if (!effectiveName) {
-        return {
-          success: false,
-          error: 'INVALID_ARGUMENT',
-          message: 'Widget name is required for creation',
-          action: 'create_widget'
-        };
-      }
-
-      try {
-        const res = await tools.uiTools.createWidget({
-          name: effectiveName,
-          type: args?.widgetType,
-          savePath: effectivePath
-        });
-
-        return cleanObject({
-          ...res,
-          action: 'create_widget'
-        });
-      } catch (error) {
-        const msg = error instanceof Error ? error.message : String(error);
-        return {
-          success: false,
-          error: `Failed to create widget: ${msg}`,
-          message: msg,
-          action: 'create_widget'
-        };
-      }
-    }
-    case 'show_widget': {
-      const widgetId = typeof args?.widgetId === 'string' ? args.widgetId.trim() : '';
-
-      if (widgetId.toLowerCase() === 'notification') {
-        const text = typeof args?.message === 'string' && args.message.trim().length > 0
-          ? args.message
-          : 'Notification';
-        const duration = typeof args?.duration === 'number' ? args.duration : undefined;
-
-        try {
-          const res = await tools.uiTools.showNotification({ text, duration });
-          const ok = res && (res as any).success !== false;
-          if (ok) {
-            return {
-              success: true,
-              message: (res as any).message || 'Notification shown',
-              action: 'show_widget',
-              widgetId,
-              handled: true
-            };
-          }
-          return cleanObject({
-            success: false,
-            error: (res as any)?.error || 'NOTIFICATION_FAILED',
-            message: (res as any)?.message || 'Failed to show notification',
-            action: 'show_widget',
-            widgetId
-          });
-        } catch (error) {
-          const msg = error instanceof Error ? error.message : String(error);
-          return {
-            success: false,
-            error: 'NOTIFICATION_FAILED',
-            message: msg,
-            action: 'show_widget',
-            widgetId
-          };
-        }
-      }
-
-      const widgetPath = (typeof args?.widgetPath === 'string' ? args.widgetPath.trim() : '') || (typeof args?.name === 'string' ? args.name.trim() : '');
-      if (!widgetPath) {
-        return {
-          success: false,
-          error: 'INVALID_ARGUMENT',
-          message: 'widgetPath (or name) is required to show a widget',
-          action: 'show_widget',
-          widgetId
-        };
-      }
-
-      return cleanObject(await tools.uiTools.showWidget(widgetPath));
-    }
-    case 'add_widget_child': {
-      const widgetPath = typeof args?.widgetPath === 'string' ? args.widgetPath.trim() : '';
-      const childClass = typeof args?.childClass === 'string' ? args.childClass.trim() : '';
-      const parentName = typeof args?.parentName === 'string' ? args.parentName.trim() : undefined;
-
-      if (!widgetPath || !childClass) {
-        return {
-          success: false,
-          error: 'INVALID_ARGUMENT',
-          message: 'widgetPath and childClass are required',
-          action: 'add_widget_child'
-        };
-      }
-
-      // Use the UITools wrapper. Note: componentName is required by the wrapper but not used by the bridge command for add_widget_child.
-      // We'll pass a dummy name.
-      try {
-        const res = await tools.uiTools.addWidgetComponent({
-          widgetName: widgetPath,
-          componentType: childClass as any, // Cast to any since the type definition in UITools might be restrictive 
-          componentName: 'NewChild', // Dummy name
-          slot: parentName ? { position: [0, 0] } : undefined // Trigger 'parent' logic if needed, though simple map uses 'Root' if slot present
-        });
-        return cleanObject({
-          ...res,
-          action: 'add_widget_child'
-        });
-      } catch (error) {
-        const msg = error instanceof Error ? error.message : String(error);
-        return {
-          success: false,
-          error: `Failed to add widget child: ${msg}`,
-          message: msg,
-          action: 'add_widget_child'
-        };
-      }
-    }
-    case 'set_cvar': {
-      // Accept multiple parameter names: name, cvar, key
-      const rawInput = typeof args?.name === 'string' && args.name.trim().length > 0
-        ? args.name.trim()
-        : (typeof args?.cvar === 'string' ? args.cvar.trim()
-          : (typeof args?.key === 'string' ? args.key.trim()
-            : (typeof args?.command === 'string' ? args.command.trim() : '')));
-
-      // Some callers pass a full "cvar value" command string.
-      const tokens = rawInput.split(/\s+/).filter(Boolean);
-      const rawName = tokens[0] ?? '';
-
-      if (!rawName) {
-        return {
-          success: false,
-          error: 'INVALID_ARGUMENT',
-          message: 'CVar name is required',
-          action: 'set_cvar'
-        };
-      }
-
-      const value = (args?.value !== undefined && args?.value !== null)
-        ? args.value
-        : (tokens.length > 1 ? tokens.slice(1).join(' ') : '');
-      await tools.systemTools.executeConsoleCommand(`${rawName} ${value}`);
-      return {
-        success: true,
-        message: `CVar ${rawName} set to ${value}`,
-        action: 'set_cvar',
-        cvar: rawName,
-        value
-      };
-    }
-    case 'get_project_settings': {
-      const section = typeof args?.category === 'string' && args.category.trim().length > 0
-        ? args.category
-        : args?.section;
-      const resp = await tools.systemTools.getProjectSettings(section);
-      if (resp && resp.success && (resp.settings || resp.data || resp.result)) {
-        return cleanObject({
-          success: true,
-          message: 'Project settings retrieved',
-          settings: resp.settings || resp.data || resp.result,
-          ...resp
-        });
-      }
-      return cleanObject(resp);
-    }
-    case 'validate_assets': {
-      const paths: string[] = Array.isArray(args?.paths) ? args.paths : [];
-      if (!paths.length) {
-        // If no paths provided, we can either validate everything (too slow) or just return success with a note.
-        // For safety, let's just warn but succeed, or maybe validate /Game/ if we wanted to be bold.
-        // Let's stick to "nothing to validate" but success=true, OR check the args properly. 
-        // If the user INTENDED to validate everything, they should probably say so. 
-        // But to "fix" the issue of empty results, maybe we can assume they want to validate the current open asset? 
-        // No, safer to just return a clear message. 
-        // Actually, let's allow it to start a validation of "/Game" if explicit empty list was NOT passed, but here "paths" is derived.
-        // The issue was "validate_assets" tool call with no args.
-        // Let's check /Game/ by default if nothing specified? That might be immense.
-        // Better: Return success=false to indicate they need to provide paths? 
-        // The prompt asked to "fix" the issue. The issue was "Message: No asset paths provided...". 
-        // Maybe that IS correct behavior? 
-        // Let's make it try to validate the set of open assets if possible? No easy way to get that here.
-        // Let's just update the message to be more helpful or return false.
-        // Actually, I'll update it to validate '/Game/' non-recursively? No.
-        // Let's just return success: false so the user knows they missed an arg.
-        return {
-          success: false,
-          error: 'INVALID_ARGUMENT',
-          message: 'Please provide array of "paths" to validate assets.',
-          action: 'validate_assets',
-          results: []
-        };
-      }
-
-      const results: any[] = [];
-      for (const rawPath of paths) {
-        const assetPath = typeof rawPath === 'string' ? rawPath : String(rawPath ?? '');
-        try {
-          const res = await tools.assetTools.validate({ assetPath });
-          results.push({ assetPath, ...res });
-        } catch (error) {
-          results.push({
-            assetPath,
-            success: false,
-            error: error instanceof Error ? error.message : String(error)
-          });
-        }
-      }
-
-      return {
-        success: true,
-        message: 'Asset validation completed',
-        action: 'validate_assets',
-        results
-      };
-    }
-    case 'play_sound': {
-      const soundPath = typeof args?.soundPath === 'string' ? args.soundPath.trim() : '';
-      const volume = typeof args?.volume === 'number' ? args.volume : undefined;
-      const pitch = typeof args?.pitch === 'number' ? args.pitch : undefined;
-
-      // Volume 0 should behave as a silent, handled no-op
-      if (typeof volume === 'number' && volume <= 0) {
-        return {
-          success: true,
-          message: 'Sound request handled (volume is 0 - silent)',
-          action: 'play_sound',
-          soundPath,
-          volume,
-          pitch,
-          handled: true
-        };
-      }
-
-      try {
-        const res = await tools.audioTools.playSound(soundPath, volume, pitch);
-        if (!res || res.success === false) {
-          const errText = String(res?.error || '').toLowerCase();
-          const isMissingAsset = errText.includes('asset_not_found') || errText.includes('asset not found');
-
-          if (isMissingAsset || !soundPath) {
-            // Attempt fallback to a known engine sound
-            const fallbackPath = '/Engine/EditorSounds/Notifications/CompileSuccess_Cue';
-            if (soundPath !== fallbackPath) {
-              const fallbackRes = await tools.audioTools.playSound(fallbackPath, volume, pitch);
-              if (fallbackRes.success) {
-                return {
-                  success: true,
-                  message: `Sound asset not found, played fallback sound: ${fallbackPath}`,
-                  action: 'play_sound',
-                  soundPath: fallbackPath,
-                  originalPath: soundPath,
-                  volume,
-                  pitch
-                };
-              }
-            }
-
-            return {
-              success: false,
-              error: 'ASSET_NOT_FOUND',
-              message: 'Sound asset not found (and fallback failed)',
-              action: 'play_sound',
-              soundPath,
-              volume,
-              pitch
-            };
-          }
-
-          return cleanObject({
-            success: false,
-            error: res?.error || 'Failed to play 2D sound',
-            action: 'play_sound',
-            soundPath,
-            volume,
-            pitch
-          });
-        }
-
-        return cleanObject({
-          ...res,
-          action: 'play_sound',
-          soundPath,
-          volume,
-          pitch
-        });
-      } catch (error) {
-        const msg = error instanceof Error ? error.message : String(error);
-        const lowered = msg.toLowerCase();
-        const isMissingAsset = lowered.includes('asset_not_found') || lowered.includes('asset not found');
-
-        if (isMissingAsset || !soundPath) {
-          return {
-            success: false,
-            error: 'ASSET_NOT_FOUND',
-            message: 'Sound asset not found',
-            action: 'play_sound',
-            soundPath,
-            volume,
-            pitch
-          };
-        }
-
-        // Fallback: If asset not found, try playing default engine sound
-        if (isMissingAsset) {
-          const fallbackSound = '/Engine/EditorSounds/Notifications/CompileSuccess_Cue';
-          try {
-            const fallbackRes = await tools.audioTools.playSound(fallbackSound, volume, pitch);
-            if (fallbackRes && fallbackRes.success) {
-              return {
-                success: true,
-                message: `Original sound not found. Played fallback sound: ${fallbackSound}`,
-                action: 'play_sound',
-                soundPath,
-                fallback: true,
-                volume,
-                pitch
-              };
-            }
-          } catch (_fallbackErr) {
-            // Ignore fallback failure and return original error
-          }
-        }
-
-        return {
-          success: false,
-          error: `Failed to play 2D sound: ${msg}`,
-          action: 'play_sound',
-          soundPath,
-          volume,
-          pitch
-        };
-      }
-    }
-    case 'screenshot': {
-      const includeMetadata = args?.includeMetadata === true;
-      const filenameArg = typeof args?.filename === 'string' ? args.filename : undefined;
-
-      if (includeMetadata) {
-        const baseName = filenameArg && filenameArg.trim().length > 0
-          ? filenameArg.trim()
-          : `Screenshot_${Date.now()}`;
-
-        try {
-          await tools.editorTools.takeScreenshot(baseName);
-        } catch (error) {
-          const msg = error instanceof Error ? error.message : String(error);
-          return {
-            success: false,
-            error: 'SCREENSHOT_FAILED',
-            message: msg,
-            filename: baseName,
-            includeMetadata: true,
-            metadata: args?.metadata,
-            action: 'screenshot'
-          };
-        }
-
-        return {
-          success: true,
-          message: `Metadata screenshot captured: ${baseName}`,
-          filename: baseName,
-          includeMetadata: true,
-          metadata: args?.metadata,
-          action: 'screenshot',
-          handled: true
-        };
-      }
-
-      return cleanObject(await tools.editorTools.takeScreenshot(filenameArg));
-    }
-    case 'set_resolution': {
-      const parseResolution = (value: unknown): { width?: number; height?: number } => {
-        if (typeof value !== 'string') return {};
-        const m = value.trim().match(/^(\d+)x(\d+)$/i);
-        if (!m) return {};
-        return { width: Number(m[1]), height: Number(m[2]) };
-      };
-
-      const parsed = parseResolution(args?.resolution);
-      const width = Number.isFinite(Number(args.width)) ? Number(args.width) : (parsed.width ?? NaN);
-      const height = Number.isFinite(Number(args.height)) ? Number(args.height) : (parsed.height ?? NaN);
-      if (!Number.isFinite(width) || !Number.isFinite(height) || width <= 0 || height <= 0) {
-        return {
-          success: false,
-          error: 'VALIDATION_ERROR',
-          message: 'Validation error: Invalid resolution: width and height must be positive numbers',
-          action: 'set_resolution'
-        };
-      }
-      const windowed = args.windowed !== false; // default to windowed=true
-      const suffix = windowed ? 'w' : 'f';
-      await tools.systemTools.executeConsoleCommand(`r.SetRes ${width}x${height}${suffix}`);
-      return {
-        success: true,
-        message: `Resolution set to ${width}x${height} (${windowed ? 'windowed' : 'fullscreen'})`,
-        action: 'set_resolution'
-      };
-    }
-    case 'set_fullscreen': {
-      const parseResolution = (value: unknown): { width?: number; height?: number } => {
-        if (typeof value !== 'string') return {};
-        const m = value.trim().match(/^(\d+)x(\d+)$/i);
-        if (!m) return {};
-        return { width: Number(m[1]), height: Number(m[2]) };
-      };
-
-      const parsed = parseResolution(args?.resolution);
-      const width = Number.isFinite(Number(args.width)) ? Number(args.width) : (parsed.width ?? NaN);
-      const height = Number.isFinite(Number(args.height)) ? Number(args.height) : (parsed.height ?? NaN);
-
-      const windowed = args.windowed === true || args.enabled === false; // default to fullscreen when omitted, but respect enabled=false (meaning windowed)
-      const suffix = windowed ? 'w' : 'f';
-
-      if (!Number.isFinite(width) || !Number.isFinite(height) || width <= 0 || height <= 0) {
-        // If only toggling mode and no resolution provided, attempt a mode toggle.
-        if (typeof args?.windowed === 'boolean' || typeof args?.enabled === 'boolean') {
-          await tools.systemTools.executeConsoleCommand(`r.FullScreenMode ${windowed ? 1 : 0}`);
-          return {
-            success: true,
-            message: `Fullscreen mode toggled (${windowed ? 'windowed' : 'fullscreen'})`,
-            action: 'set_fullscreen',
-            handled: true
-          };
-        }
-
-        return {
-          success: false,
-          error: 'VALIDATION_ERROR',
-          message: 'Invalid resolution: provide width/height or resolution like "1920x1080"',
-          action: 'set_fullscreen'
-        };
-      }
-
-      await tools.systemTools.executeConsoleCommand(`r.SetRes ${width}x${height}${suffix}`);
-      return {
-        success: true,
-        message: `Fullscreen mode set to ${width}x${height} (${windowed ? 'windowed' : 'fullscreen'})`,
-        action: 'set_fullscreen'
-      };
-    }
-    case 'read_log':
-      return cleanObject(await tools.logTools.readOutputLog(args));
-    default:
-      const res = await executeAutomationRequest(tools, 'system_control', args, 'Automation bridge not available for system control operations');
-      return cleanObject(res);
-  }
-}
-
-export async function handleConsoleCommand(args: any, tools: ITools) {
-  const rawCommand = typeof args?.command === 'string' ? args.command : '';
-  const trimmed = rawCommand.trim();
-
-  if (!trimmed) {
-    return cleanObject({
-      success: false,
-      error: 'EMPTY_COMMAND',
-      message: 'Console command is empty',
-      command: rawCommand
-    });
-  }
-
-  const res = await executeAutomationRequest(
-    tools,
-    'console_command',
-    { ...args, command: trimmed },
-    'Automation bridge not available for console command operations'
-  );
-  return cleanObject(res);
-}