Class: Clacky::Server::HttpServer

Inherits:
Object
  • Object
show all
Defined in:
lib/clacky/server/http_server.rb

Overview

HttpServer runs an embedded WEBrick HTTP server with WebSocket support.

Routes:

GET  /ws                     → WebSocket upgrade (all real-time communication)
*    /api/*                  → JSON REST API (sessions, tasks, schedules)
GET  /**                     → static files served from lib/clacky/web/ directory

Defined Under Namespace

Classes: WebSocketConnection

Constant Summary collapse

WEB_ROOT = 
File.expand_path("../web", __dir__)
EXCHANGE_RATE_PRIMARY_BASE_URL = 
"https://open.er-api.com/v6/latest"
EXCHANGE_RATE_FALLBACK_URL = 
"https://api.frankfurter.app/latest"
OSS_CDN_BASE = 
"https://oss.1024code.com/openclacky"
DEFAULT_SOUL_MD =

Default SOUL.md written when the user skips the onboard conversation. A richer version is created by the Agent during the soul_setup phase.

<<~MD.freeze
  # Clacky — Agent Soul

  You are Clacky, a friendly and capable AI coding assistant and technical
  co-founder. You are sharp, concise, and proactive. You speak plainly and
  avoid unnecessary formality. You love helping people ship great software.

  ## Personality
  - Warm and encouraging, but direct and honest
  - Think step-by-step before acting; explain your reasoning briefly
  - Prefer doing over talking — use tools, write code, ship results
  - Adapt your language and tone to match the user's style

  ## Strengths
  - Full-stack software development (Ruby, Python, JS, and more)
  - Architectural thinking and code review
  - Debugging tricky problems with patience and creativity
  - Breaking big goals into small, executable steps
MD
DEFAULT_SOUL_MD_ZH =

Default SOUL.md for Chinese-language users.

<<~MD.freeze
  # Clacky — 助手灵魂

  你是 Clacky，一位友好、能干的 AI 编程助手和技术联合创始人。
  你思维敏锐、言简意赅、主动积极。你说话直接，不喜欢过度客套。
  你热爱帮助用户打造优秀的软件产品。

  **重要：始终用中文回复用户。**

  ## 性格特点
  - 热情鼓励，但直接诚实
  - 行动前先思考；简要说明你的推理过程
  - 重行动而非空谈 —— 善用工具，写代码，交付结果
  - 根据用户的风格调整语气和表达方式

  ## 核心能力
  - 全栈软件开发（Ruby、Python、JS 等）
  - 架构设计与代码审查
  - 耐心细致地调试复杂问题
  - 将大目标拆解为可执行的小步骤
MD
BRAND_HEARTBEAT_MUTEX =

Process-wide mutex guarding heartbeat trigger state. Used by #trigger_async_heartbeat! to ensure only one heartbeat Thread is in flight at a time, no matter how many concurrent /api/brand/status requests arrive from the Web UI poller.

Mutex.new
BRAND_DIST_REFRESH_MUTEX =

Mutex + inflight flag for async distribution refresh. Mirrors the heartbeat pattern above so the same guarantees hold: at most one refresh thread per process regardless of how many concurrent /api/brand/status polls arrive from the Web UI.

Mutex.new
IGNORED_FILE_ENTRIES =

Lists one directory level inside the session's working_dir (lazy, per-layer). Path traversal outside working_dir is rejected. Noisy dirs are hidden.

%w[.git .svn .hg node_modules .DS_Store .bundle vendor/bundle tmp .sass-cache].freeze
PROFILE_USER_AGENTS_DIR =

── Profile API (USER.md / SOUL.md) ──────────────────────────────

User can override the built-in defaults by writing their own ~/.clacky/agents/USER.md and ~/.clacky/agents/SOUL.md. These endpoints let the Web UI read and edit those files.

File.expand_path("~/.clacky/agents").freeze
PROFILE_MAX_BYTES =

Hard limit; prevents runaway content.

50_000
MEMORIES_DIR =

── Memories API (~/.clacky/memories/*.md) ───────────────────────

Long-term memories are plain Markdown files with YAML frontmatter stored under ~/.clacky/memories/. These endpoints let the user inspect, edit, create, and delete them from the Web UI.

File.expand_path("~/.clacky/memories").freeze
MEMORY_MAX_BYTES = 
50_000
@@brand_heartbeat_inflight =

Tracks whether a heartbeat Thread is currently running.

false
@@brand_dist_refresh_inflight = 
false

Instance Method Summary collapse

Constructor Details

#initialize(host: "127.0.0.1", port: 7070, agent_config:, client_factory:, brand_test: false, sessions_dir: nil, socket: nil, master_pid: nil) ⇒ HttpServer

Returns a new instance of HttpServer.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/clacky/server/http_server.rb', line 177

def initialize(host: "127.0.0.1", port: 7070, agent_config:, client_factory:, brand_test: false, sessions_dir: nil, socket: nil, master_pid: nil)
  @host           = host
  @port           = port
  @agent_config   = agent_config
  @client_factory = client_factory  # callable: -> { Clacky::Client.new(...) }
  @brand_test     = brand_test      # when true, skip remote API calls for license activation
  @inherited_socket  = socket        # TCPServer socket passed from Master (nil = standalone mode)
  @master_pid        = master_pid    # Master PID so we can send USR1 on upgrade/restart
  # Capture the absolute path of the entry script and original ARGV at startup,
  # so api_restart can re-exec the correct binary even if cwd changes later.
  @restart_script = File.expand_path($0)
  @restart_argv   = ARGV.dup
  @session_manager = Clacky::SessionManager.new(sessions_dir: sessions_dir)
  @registry        = SessionRegistry.new(
    session_manager:  @session_manager,
    session_restorer: method(:build_session_from_data),
    agent_config:     @agent_config
  )
  @ws_clients      = {}   # session_id => [WebSocketConnection, ...]
  @all_ws_conns    = []   # every connected WS client, regardless of session subscription
  @ws_mutex        = Mutex.new
  # Version cache: { latest: "x.y.z", checked_at: Time }
  @version_cache   = nil
  @version_mutex   = Mutex.new
  @scheduler       = Scheduler.new(
    session_registry: @registry,
    session_builder:  method(:build_session),
    task_runner:      method(:run_agent_task)
  )
  @channel_manager = Clacky::Channel::ChannelManager.new(
    session_registry:  @registry,
    session_builder:   method(:build_session),
    run_agent_task:    method(:run_agent_task),
    interrupt_session: method(:interrupt_session),
    channel_config:    Clacky::ChannelConfig.load
  )
  @browser_manager = Clacky::BrowserManager.instance
  @skill_loader    = Clacky::SkillLoader.new(working_dir: nil, brand_config: Clacky::BrandConfig.load)
  # Lazy: process-wide MCP registry. Created on first /api/mcp/:name access
  # so test setups that override Dir.home in before-hooks still work.
  @mcp_registry_mutex = Mutex.new
  # Access key authentication:
  # - localhost (127.0.0.1 / ::1) is always trusted; auth is skipped entirely.
  # - Any other bind address requires CLACKY_ACCESS_KEY env var.
  @localhost_only      = local_host?(@host)
  @access_key          = @localhost_only ? nil : resolve_access_key
  @auth_failures       = {}
  @auth_failures_mutex = Mutex.new
  if @localhost_only
    Clacky::Logger.info("[HttpServer] Localhost mode — authentication disabled")
  else
    Clacky::Logger.info("[HttpServer] Public mode — access key authentication ENABLED")
  end
end

Instance Method Details

#_dispatch_rest(req, res) ⇒ Object 



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/clacky/server/http_server.rb', line 509

def _dispatch_rest(req, res)
  path   = req.path
  method = req.request_method

  # HTTP API extensions declared in an ext.yml container mount at
  # /api/ext/<ext_id>/... Routed through a separate dispatcher so the
  # host's giant case table stays focused on built-in endpoints.
  if path.start_with?(Clacky::Server::ApiExtensionDispatcher::MOUNT_PREFIX)
    return if Clacky::Server::ApiExtensionDispatcher.handle(req, res, http_server: self)
  end

  case [method, path]
  when ["GET",    "/api/sessions"]      then api_list_sessions(req, res)
  when ["POST",   "/api/sessions"]      then api_create_session(req, res)
  when ["GET",    "/api/cron-tasks"]    then api_list_cron_tasks(res)
  when ["POST",   "/api/cron-tasks"]    then api_create_cron_task(req, res)
  when ["GET",    "/api/skills"]         then api_list_skills(res)
  when ["GET",    "/api/agents"]         then api_list_agents(res)
  when ["GET",    "/api/config"]        then api_get_config(req, res)
  when ["GET",    "/api/config/settings"]  then api_get_settings(res)
  when ["GET",    "/api/exchange-rate"]    then api_exchange_rate(req, res)
  when ["PATCH",  "/api/config/settings"]  then api_update_settings(req, res)
  when ["POST",   "/api/config/models"] then api_add_model(req, res)
  when ["POST",   "/api/config/test"]   then api_test_config(req, res)
  when ["POST",   "/api/config/media/test"] then api_test_media_config(req, res)
  when ["GET",    "/api/config/media"]  then api_get_media_config(res)
  when ["GET",    "/api/config/ocr"]    then api_get_ocr_config(res)
  when ["PATCH",  "/api/config/ocr"]    then api_update_ocr_config(req, res)
  when ["POST",   "/api/config/ocr/test"] then api_test_ocr_config(req, res)
  when ["POST",   "/api/internal/ocr-image"] then api_internal_ocr_image(req, res)
  when ["GET",    "/api/providers"]     then api_list_providers(res)
  when ["GET",    "/api/onboard/status"]    then api_onboard_status(res)
  when ["POST",   "/api/onboard/device/start"] then api_onboard_device_start(req, res)
  when ["POST",   "/api/onboard/device/poll"]  then api_onboard_device_poll(req, res)
  when ["GET",    "/api/browser/status"]    then api_browser_status(res)
  when ["POST",   "/api/browser/configure"]  then api_browser_configure(req, res)
  when ["POST",   "/api/browser/reload"]    then api_browser_reload(res)
  when ["POST",   "/api/browser/toggle"]    then api_browser_toggle(res)
  when ["GET",    "/api/backup/status"]     then api_backup_status(res)
  when ["POST",   "/api/backup/run"]        then api_backup_run(res)
  when ["GET",    "/api/backup/download"]   then api_backup_download(res)
  when ["POST",   "/api/backup/restore"]    then api_backup_restore(req, res)
  when ["POST",   "/api/backup/open-folder"] then api_backup_open_folder(res)
  when ["PATCH",  "/api/backup/config"]     then api_backup_config(req, res)
  when ["POST",   "/api/telemetry"]        then api_telemetry(req, res)
  when ["POST",   "/api/onboard/complete"]  then api_onboard_complete(req, res)
  when ["POST",   "/api/onboard/skip-soul"] then api_onboard_skip_soul(req, res)
  when ["GET",    "/api/store/skills"]          then api_store_skills(res)
  when ["GET",    "/api/store/extensions"]          then api_store_extensions(req, res)
  when ["GET",    "/api/store/extensions/brand"]   then api_store_extensions_brand(res)
  when ["GET",    "/api/store/extensions/installed"] then api_store_extensions_installed(res)
  when ["GET",    "/api/store/extension"]       then api_store_extension_detail(req, res)
  when ["POST",   "/api/store/extension/install"]  then api_store_extension_install(req, res)
  when ["POST",   "/api/store/extension/disable"] then api_store_extension_disable(req, res)
  when ["POST",   "/api/store/extension/enable"]  then api_store_extension_enable(req, res)
  when ["DELETE", "/api/store/extension"]         then api_store_extension_uninstall(req, res)
  when ["GET",    "/api/brand/status"]      then api_brand_status(res)
  when ["POST",   "/api/brand/activate"]    then api_brand_activate(req, res)
  when ["DELETE", "/api/brand/license"]     then api_brand_deactivate(res)
  when ["GET",    "/api/brand/skills"]      then api_brand_skills(res)
  when ["GET",    "/api/brand"]             then api_brand_info(res)
  when ["GET",    "/api/creator/skills"]    then api_creator_skills(res)
  when ["GET",    "/api/trash"]     then api_trash(req, res)
  when ["POST",   "/api/trash/restore"] then api_trash_restore(req, res)
  when ["DELETE", "/api/trash"]     then api_trash_delete(req, res)
  when ["GET",    "/api/trash/sessions"]     then api_trash_sessions(req, res)
  when ["POST",   "/api/trash/sessions/restore"] then api_trash_session_restore(req, res)
  when ["DELETE", "/api/trash/sessions"]     then api_trash_sessions_delete(req, res)
  when ["GET",    "/api/profile"]   then api_profile_get(res)
  when ["PUT",    "/api/profile"]   then api_profile_put(req, res)
  when ["GET",    "/api/memories"]  then api_memories_list(res)
  when ["POST",   "/api/memories"]  then api_memories_create(req, res)
  when ["GET",    "/api/channels"]          then api_list_channels(res)
  when ["GET",    "/api/mcp"]               then api_mcp_list(res)
  when ["POST",   "/api/tool/browser"]      then api_tool_browser(req, res)
  when ["POST",   "/api/upload"]            then api_upload_file(req, res)
  when ["POST",   "/api/file-action"]       then api_file_action(req, res)
  when ["GET",    "/api/local-image"]       then api_serve_local_image(req, res)
  when ["POST",   "/api/media/image"]       then api_media_image(req, res)
  when ["POST",   "/api/media/video"]       then api_media_video(req, res)
  when ["GET",    "/api/media/video/status"] then api_media_video_status(req, res)
  when ["POST",   "/api/media/audio/speech"] then api_media_audio_speech(req, res)
  when ["POST",   "/api/media/audio/transcriptions"] then api_media_audio_transcriptions(req, res)
  when ["POST",   "/api/media/video/understand"]     then api_media_video_understand(req, res)
  when ["GET",    "/api/media/types"]       then api_media_types(res)
  when ["GET",    "/api/version"]           then api_get_version(res)
  when ["POST",   "/api/version/upgrade"]   then api_upgrade_version(req, res)
  when ["POST",   "/api/restart"]           then api_restart(req, res)
  when ["GET",    "/api/billing/summary"]   then api_billing_summary(req, res)
  when ["GET",    "/api/billing/daily"]     then api_billing_daily(req, res)
  when ["GET",    "/api/billing/records"]   then api_billing_records(req, res)
  when ["GET",    "/api/billing/sessions"]  then api_billing_sessions(req, res)
  when ["DELETE", "/api/billing/clear"]     then api_billing_clear(req, res)        when ["PATCH",  "/api/sessions/:id/model"] then api_switch_session_model(req, res)
  when ["PATCH",  "/api/sessions/:id/working_dir"] then api_change_session_working_dir(req, res)
  else
    if method == "POST" && path.match?(%r{^/api/channels/[^/]+/send$})
      platform = path.sub("/api/channels/", "").sub("/send", "")
      api_send_channel_message(platform, req, res)
    elsif method == "GET" && path.match?(%r{^/api/channels/group_history/})
      chat_id = URI.decode_www_form_component(path.sub("/api/channels/group_history/", ""))
      api_group_history(chat_id, res)
    elsif method == "GET" && path.match?(%r{^/api/channels/[^/]+/users$})
      platform = path.sub("/api/channels/", "").sub("/users", "")
      api_list_channel_users(platform, res)
    elsif method == "POST" && path.match?(%r{^/api/channels/[^/]+/test$})
      platform = path.sub("/api/channels/", "").sub("/test", "")
      api_test_channel(platform, req, res)
    elsif method == "PATCH" && path.match?(%r{^/api/channels/[^/]+/enabled$})
      platform = path.sub("/api/channels/", "").sub("/enabled", "")
      api_toggle_channel(platform, req, res)
    elsif method == "POST" && path.start_with?("/api/channels/")
      platform = path.sub("/api/channels/", "")
      api_save_channel(platform, req, res)
    elsif method == "DELETE" && path.start_with?("/api/channels/")
      platform = path.sub("/api/channels/", "")
      api_delete_channel(platform, res)
    elsif method == "POST" && path.match?(%r{^/api/mcp/[^/]+/probe$})
      name = path.sub("/api/mcp/", "").sub("/probe", "")
      api_mcp_probe(name, res)
    elsif method == "GET" && path.match?(%r{^/api/mcp/[^/]+/tools$})
      name = path.sub("/api/mcp/", "").sub("/tools", "")
      api_mcp_tools(name, res)
    elsif method == "POST" && path.match?(%r{^/api/mcp/[^/]+/call$})
      name = path.sub("/api/mcp/", "").sub("/call", "")
      api_mcp_call(name, req, res)
    elsif method == "POST" && path == "/api/mcp"
      api_mcp_create(req, res)
    elsif method == "PATCH" && path.match?(%r{^/api/mcp/[^/]+/enabled$})
      name = path.sub("/api/mcp/", "").sub("/enabled", "")
      api_mcp_toggle(name, req, res)
    elsif method == "PUT" && path.match?(%r{^/api/mcp/[^/]+$})
      name = path.sub("/api/mcp/", "")
      api_mcp_update(name, req, res)
    elsif method == "DELETE" && path.match?(%r{^/api/mcp/[^/]+$})
      name = path.sub("/api/mcp/", "")
      api_mcp_delete(name, req, res)
    elsif method == "GET" && path.match?(%r{^/api/sessions/[^/]+/skills$})
      session_id = path.sub("/api/sessions/", "").sub("/skills", "")
      api_session_skills(session_id, res)
    elsif method == "GET" && path.match?(%r{^/api/agents/[^/]+/skills$})
      agent_id = path[%r{^/api/agents/([^/]+)/skills$}, 1]
      api_agent_skills(agent_id, res)
    elsif method == "GET" && path.match?(%r{^/api/sessions/[^/]+/git/[a-z]+$})
      session_id = path[%r{^/api/sessions/([^/]+)/git/}, 1]
      action     = path[%r{/git/([a-z]+)$}, 1]
      api_session_git(session_id, action, req, res)
    elsif method == "POST" && path.match?(%r{^/api/sessions/[^/]+/git/commit$})
      session_id = path[%r{^/api/sessions/([^/]+)/git/}, 1]
      api_session_git_commit(session_id, req, res)
    elsif method == "GET" && path.match?(%r{^/api/sessions/[^/]+/time_machine$})
      session_id = path.sub("/api/sessions/", "").sub("/time_machine", "")
      api_session_time_machine(session_id, res)
    elsif method == "POST" && path.match?(%r{^/api/sessions/[^/]+/time_machine/switch$})
      session_id = path[%r{^/api/sessions/([^/]+)/time_machine/}, 1]
      api_session_time_machine_switch(session_id, req, res)
    elsif method == "GET" && path.match?(%r{^/api/sessions/[^/]+/time_machine/\d+/diff$})
      session_id = path[%r{^/api/sessions/([^/]+)/time_machine/}, 1]
      task_id    = path[%r{/time_machine/(\d+)/diff$}, 1].to_i
      api_session_time_machine_diff(session_id, task_id, req, res)
    elsif method == "GET" && path.match?(%r{^/api/sessions/[^/]+/time_machine/\d+/restore_preview$})
      session_id = path[%r{^/api/sessions/([^/]+)/time_machine/}, 1]
      task_id    = path[%r{/time_machine/(\d+)/restore_preview$}, 1].to_i
      api_session_time_machine_restore_preview(session_id, task_id, res)
    elsif method == "GET" && path == "/api/dirs"
      api_browse_dirs(req, res)
    elsif method == "POST" && path == "/api/dirs/mkdir"
      api_dirs_mkdir(req, res)
    elsif method == "GET" && path.match?(%r{^/api/sessions/[^/]+/files$})
      session_id = path.sub("/api/sessions/", "").sub("/files", "")
      api_session_files(session_id, req, res)
    elsif method == "GET" && path.match?(%r{^/api/sessions/[^/]+/export$})
      session_id = path.sub("/api/sessions/", "").sub("/export", "")
      api_export_session(session_id, res)
    elsif method == "GET" && path.match?(%r{^/api/sessions/[^/]+/messages$})
      session_id = path.sub("/api/sessions/", "").sub("/messages", "")
      api_session_messages(session_id, req, res)
    elsif method == "GET" && path.match?(%r{^/api/sessions/[^/]+$})
      session_id = path.sub("/api/sessions/", "")
      api_get_session(session_id, res)
    elsif method == "PATCH" && path.match?(%r{^/api/sessions/[^/]+$})
      session_id = path.sub("/api/sessions/", "")
      api_rename_session(session_id, req, res)
    elsif method == "PATCH" && path.match?(%r{^/api/sessions/[^/]+/model$})
      session_id = path.sub("/api/sessions/", "").sub("/model", "")
      api_switch_session_model(session_id, req, res)
    elsif method == "PATCH" && path.match?(%r{^/api/sessions/[^/]+/reasoning_effort$})
      session_id = path.sub("/api/sessions/", "").sub("/reasoning_effort", "")
      api_switch_session_reasoning_effort(session_id, req, res)
    elsif method == "PATCH" && path.match?(%r{^/api/sessions/[^/]+/submodel$})
      session_id = path.sub("/api/sessions/", "").sub("/submodel", "")
      api_switch_session_submodel(session_id, req, res)
    elsif method == "POST" && path.match?(%r{^/api/sessions/[^/]+/benchmark$})
      session_id = path.sub("/api/sessions/", "").sub("/benchmark", "")
      api_benchmark_session_models(session_id, req, res)
    elsif method == "PATCH" && path.match?(%r{^/api/sessions/[^/]+/working_dir$})
      session_id = path.sub("/api/sessions/", "").sub("/working_dir", "")
      api_change_session_working_dir(session_id, req, res)
    elsif method == "POST" && path.match?(%r{^/api/sessions/[^/]+/fork$})
      session_id = path.sub("/api/sessions/", "").sub("/fork", "")
      api_fork_session(session_id, req, res)
    elsif method == "DELETE" && path.start_with?("/api/sessions/")
      session_id = path.sub("/api/sessions/", "")
      api_delete_session(session_id, res)
    elsif method == "DELETE" && path.match?(%r{^/api/trash/sessions/[^/]+$})
      session_id = path.sub("/api/trash/sessions/", "")
      api_trash_session_delete_one(session_id, res)
    elsif method == "POST" && path.match?(%r{^/api/config/models/[^/]+/default$})
      id = path.sub("/api/config/models/", "").sub("/default", "")
      api_set_default_model(id, res)
    elsif method == "PATCH" && path.match?(%r{^/api/config/models/[^/]+$})
      id = path.sub("/api/config/models/", "")
      api_update_model(id, req, res)
    elsif method == "DELETE" && path.match?(%r{^/api/config/models/[^/]+$})
      id = path.sub("/api/config/models/", "")
      api_delete_model(id, res)
    elsif method == "PATCH" && path.match?(%r{^/api/config/media/(image|video|audio|stt|video_understanding)$})
      kind = path.sub("/api/config/media/", "")
      api_update_media_config(kind, req, res)
    elsif method == "POST" && path.match?(%r{^/api/cron-tasks/[^/]+/run$})
      name = URI.decode_www_form_component(path.sub("/api/cron-tasks/", "").sub("/run", ""))
      api_run_cron_task(name, res)
    elsif method == "PATCH" && path.match?(%r{^/api/cron-tasks/[^/]+$})
      name = URI.decode_www_form_component(path.sub("/api/cron-tasks/", ""))
      api_update_cron_task(name, req, res)
    elsif method == "DELETE" && path.match?(%r{^/api/cron-tasks/[^/]+$})
      name = URI.decode_www_form_component(path.sub("/api/cron-tasks/", ""))
      api_delete_cron_task(name, res)
    elsif method == "PATCH" && path.match?(%r{^/api/skills/[^/]+/toggle$})
      name = URI.decode_www_form_component(path.sub("/api/skills/", "").sub("/toggle", ""))
      api_toggle_skill(name, req, res)
    elsif method == "GET" && path.match?(%r{^/api/skills/[^/]+/content$})
      name = URI.decode_www_form_component(path.sub("/api/skills/", "").sub("/content", ""))
      api_skill_content_get(name, res)
    elsif method == "PUT" && path.match?(%r{^/api/skills/[^/]+/content$})
      name = URI.decode_www_form_component(path.sub("/api/skills/", "").sub("/content", ""))
      api_skill_content_update(name, req, res)
    elsif method == "DELETE" && path.match?(%r{^/api/skills/[^/]+$})
      name = URI.decode_www_form_component(path.sub("/api/skills/", ""))
      api_delete_skill(name, res)
    elsif method == "DELETE" && path.match?(%r{^/api/brand/skills/[^/]+$})
      slug = URI.decode_www_form_component(path.sub("/api/brand/skills/", ""))
      api_delete_brand_skill(slug, res)
    elsif method == "POST" && path.match?(%r{^/api/brand/skills/[^/]+/install$})
      slug = URI.decode_www_form_component(path.sub("/api/brand/skills/", "").sub("/install", ""))
      api_brand_skill_install(slug, req, res)
    elsif method == "POST" && path.match?(%r{^/api/my-skills/[^/]+/publish$})
      name = URI.decode_www_form_component(path.sub("/api/my-skills/", "").sub("/publish", ""))
      api_publish_my_skill(name, req, res)
    elsif method == "GET" && path.match?(%r{^/api/memories/[^/]+$})
      filename = URI.decode_www_form_component(path.sub("/api/memories/", ""))
      api_memories_get(filename, res)
    elsif method == "PUT" && path.match?(%r{^/api/memories/[^/]+$})
      filename = URI.decode_www_form_component(path.sub("/api/memories/", ""))
      api_memories_update(filename, req, res)
    elsif method == "DELETE" && path.match?(%r{^/api/memories/[^/]+$})
      filename = URI.decode_www_form_component(path.sub("/api/memories/", ""))
      api_memories_delete(filename, res)
    else
      not_found(res)
    end
  end
end

#api_add_model(req, res) ⇒ Object

POST /api/config/models Body: { model, base_url, api_key, anthropic_format, type? } Creates a new model entry, returns { ok:true, id, index } so the frontend can record the new id without reloading the whole list.



5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
 
# File 'lib/clacky/server/http_server.rb', line 5597

def api_add_model(req, res)
  body = parse_json_body(req)
  return json_response(res, 400, { error: "Invalid JSON" }) unless body

  model    = body["model"].to_s.strip
  base_url = body["base_url"].to_s.strip
  api_key  = body["api_key"].to_s
  # When duplicating, the frontend sends source_id so we can inherit the
  # real key without ever transmitting it back to the client.
  if api_key.empty? || api_key.include?("****")
    source_id = body["source_id"].to_s
    unless source_id.empty?
      source  = @agent_config.models.find { |m| m["id"] == source_id }
      api_key = source["api_key"].to_s if source
    end
  end
  if api_key.empty? || api_key.include?("****")
    return json_response(res, 422, { error: "api_key is required" })
  end

  entry = {
    "id"               => SecureRandom.uuid,
    "model"            => model,
    "base_url"         => base_url,
    "api_key"          => api_key,
    "anthropic_format" => body["anthropic_format"] || false,
    "provider_id"      => body["provider_id"].to_s.strip.then { |v| v.empty? ? nil : v }
  }
  type = body["type"].to_s
  unless type.empty?
    # Preserve the single-slot "default" invariant.
    if type == "default"
      @agent_config.models.each { |m| m.delete("type") if m["type"] == "default" }
    end
    entry["type"] = type
  end

  @agent_config.models << entry
  # If this is the only model and no default marker exists yet,
  # adopt it as the default so downstream lookups resolve cleanly.
  if @agent_config.models.none? { |m| m["type"] == "default" }
    entry["type"] = "default"
    @agent_config.current_model_id    = entry["id"]
    @agent_config.current_model_index = @agent_config.models.length - 1
  elsif type == "default"
    # Re-anchor current_* to the newly-defaulted entry.
    @agent_config.current_model_id    = entry["id"]
    @agent_config.current_model_index = @agent_config.models.length - 1
  end

  @agent_config.save
  json_response(res, 200, {
    ok:    true,
    id:    entry["id"],
    index: @agent_config.models.length - 1
  })
rescue => e
  json_response(res, 422, { error: e.message })
end

#api_agent_skills(agent_id, res) ⇒ Object

GET /api/agents/:id/skills — like api_session_skills but keyed on an agent id rather than a live session. Used by the New Session page so the first-message composer can offer slash-command autocomplete before a session exists.



4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
 
# File 'lib/clacky/server/http_server.rb', line 4289

def api_agent_skills(agent_id, res)
  profile = begin
    Clacky::AgentProfile.load(agent_id)
  rescue StandardError
    nil
  end

  @skill_loader.load_all
  skills = @skill_loader.user_invocable_skills
  skills = skills.select { |s| s.allowed_for_agent?(profile.name) } if profile

  loaded_from = @skill_loader.loaded_from
  skill_data = skills.map do |skill|
    {
      name:           skill.identifier,
      name_zh:        skill.name_zh,
      description:    skill.description || skill.context_description,
      description_zh: skill.description_zh,
      encrypted:      skill.encrypted?,
      source_type:    loaded_from[skill.identifier],
      always_show:    skill.always_show
    }
  end

  json_response(res, 200, { skills: skill_data })
end

#api_backup_config(req, res) ⇒ Object

Body: { enabled?, cron?, dest_dir?, keep?, include_sessions? }



1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
 
# File 'lib/clacky/server/http_server.rb', line 1473

def api_backup_config(req, res)
  body = parse_json_body(req) || {}
  cfg = BackupManager.update_config(
    enabled:          body.key?("enabled") ? body["enabled"] : nil,
    cron:             body["cron"],
    dest_dir:         body.key?("dest_dir") ? body["dest_dir"] : nil,
    keep:             body["keep"],
    include_sessions: body.key?("include_sessions") ? body["include_sessions"] : nil
  )
  json_response(res, 200, { ok: true, config: cfg, status: BackupManager.status })
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_backup_download(res) ⇒ Object

GET /api/backup/download — build a one-off archive and stream it directly to the browser. Not written to dest_dir nor recorded.



1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/clacky/server/http_server.rb', line 1460

def api_backup_download(res)
  result = BackupManager.build_download!
  res.status                = 200
  res["Content-Type"]       = "application/gzip"
  res["Content-Disposition"] = %(attachment; filename="#{result[:filename]}")
  res["Cache-Control"]      = "no-store"
  res.body                  = File.binread(result[:path])
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
ensure
  FileUtils.rm_f(result[:path]) if result && result[:path]
end

#api_backup_open_folder(res) ⇒ Object

POST /api/backup/open-folder — open the backup destination in Finder/Explorer



5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
 
# File 'lib/clacky/server/http_server.rb', line 5481

def api_backup_open_folder(res)
  dest = BackupManager.status["dest_dir"]
  FileUtils.mkdir_p(dest)
  host_os = RbConfig::CONFIG["host_os"]
  if host_os =~ /darwin/
    system("open", dest)
  elsif host_os =~ /linux/
    if File.exist?("/proc/version") && File.read("/proc/version").downcase.include?("microsoft")
      windows_path, = Open3.capture2("wslpath", "-w", dest)
      system("explorer.exe", windows_path.strip) unless windows_path.strip.empty?
    else
      system("xdg-open", dest)
    end
  end
  json_response(res, 200, { ok: true, dest_dir: dest })
rescue => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_backup_restore(req, res) ⇒ Object

POST /api/backup/restore — accept a tar.gz upload, extract over ~/.clacky, hot-restart



5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
 
# File 'lib/clacky/server/http_server.rb', line 5439

def api_backup_restore(req, res)
  body = req.body.to_s
  return json_response(res, 400, { error: "Empty body" }) if body.empty?

  clacky_dir = File.expand_path("~/.clacky")
  stamp      = Time.now.strftime("%Y%m%d-%H%M%S")
  tmp_archive = File.join(Dir.tmpdir, "clacky-restore-#{stamp}.tar.gz")
  tmp_backup  = File.join(Dir.tmpdir, "clacky-pre-restore-#{stamp}")

  File.binwrite(tmp_archive, body)

  FileUtils.cp_r(clacky_dir, tmp_backup)

  result = system("tar", "-xzf", tmp_archive, "-C", clacky_dir)
  unless result
    FileUtils.rm_rf(clacky_dir)
    FileUtils.cp_r(tmp_backup, clacky_dir)
    return json_response(res, 500, { error: "Failed to extract archive" })
  end

  json_response(res, 200, { ok: true })

  Thread.new do
    sleep 0.5
    if @master_pid
      begin
        Process.kill("USR1", @master_pid)
      rescue Errno::ESRCH
        standalone_exec_restart
      end
    else
      standalone_exec_restart
    end
  end
rescue => e
  json_response(res, 500, { ok: false, error: e.message })
ensure
  FileUtils.rm_f(tmp_archive) if tmp_archive
  FileUtils.rm_rf(tmp_backup) if tmp_backup && Dir.exist?(tmp_backup)
end

#api_backup_run(res) ⇒ Object

POST /api/backup/run — run a backup immediately.



1449
1450
1451
1452
1453
1454
1455
1456
 
# File 'lib/clacky/server/http_server.rb', line 1449

def api_backup_run(res)
  result = BackupManager.run!
  json_response(res, 200, { ok: true, archive: File.basename(result[:archive]),
                            size: result[:size], dest_dir: result[:dest_dir],
                            status: BackupManager.status })
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_backup_status(res) ⇒ Object

GET /api/backup/status



1442
1443
1444
1445
1446
 
# File 'lib/clacky/server/http_server.rb', line 1442

def api_backup_status(res)
  json_response(res, 200, BackupManager.status)
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_benchmark_session_models(session_id, _req, res) ⇒ Object

POST /api/sessions/:id/benchmark

Speed-test every configured model in one shot so the user can pick the fastest available model for this session. We send a minimal one-token request to each model in parallel (one thread per model) and measure total HTTP duration — for non-streaming calls this equals the user's perceived time-to-first-token, so the field is named ttft_ms for forward-compatibility with a future streaming implementation.

Cost note: each request is max_tokens: 1 + a 2-byte prompt, so the total cost across a dozen models is well under one cent.

Response shape:

{
ok: true,
results: [
  { model_id: "...", model: "...", ttft_ms: 812, ok: true },
  { model_id: "...", model: "...", ok: false, error: "timeout" },
  ...
]
}


6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
 
# File 'lib/clacky/server/http_server.rb', line 6042

def api_benchmark_session_models(session_id, _req, res)
  return json_response(res, 404, { error: "Session not found" }) unless @registry.ensure(session_id)

  # Snapshot the models list — @agent_config.models is a shared reference
  # that the user might mutate from the settings panel during the test;
  # a shallow dup is enough since we only read string fields below.
  models = Array(@agent_config.models).dup
  return json_response(res, 200, { ok: true, results: [] }) if models.empty?

  # Kick off one thread per model. We deliberately cap per-request wall
  # time inside each thread via a Faraday timeout so a single dead model
  # can't block the response. The outer join uses a generous ceiling
  # (timeout + small buffer) as a last-resort safety net.
  per_model_timeout = 15
  threads = models.map do |m|
    Thread.new do
      Thread.current.report_on_exception = false
      benchmark_single_model(m, per_model_timeout)
    end
  end

  results = threads.map do |t|
    if t.join(per_model_timeout + 3)
      t.value rescue { ok: false, error: "thread failed" }
    else
      t.kill
      { ok: false, error: "Request timed out" }
    end
  end

  json_response(res, 200, { ok: true, results: results })
rescue => e
  Clacky::Logger.error("[benchmark] #{e.class}: #{e.message}", error: e)
  json_response(res, 500, { error: e.message })
end

#api_billing_clear(req, res) ⇒ Object

DELETE /api/billing/clear # Clears billing records Query params: scope (today|all, default: today)



2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
 
# File 'lib/clacky/server/http_server.rb', line 2938

def api_billing_clear(req, res)
  require_relative "../billing/billing_store"

  query = URI.decode_www_form(req.query_string.to_s).to_h
  scope = query["scope"] || "today"

  store = Clacky::Billing::BillingStore.new
  deleted = store.clear(scope: scope.to_sym)

  json_response(res, 200, { ok: true, deleted: deleted, scope: scope })
rescue => e
  json_response(res, 500, { error: e.message })
end

#api_billing_daily(req, res) ⇒ Object

GET /api/billing/daily Returns daily cost breakdown Query params: days (default: 30), model (optional)



2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
 
# File 'lib/clacky/server/http_server.rb', line 2883

def api_billing_daily(req, res)
  require_relative "../billing/billing_store"

  query = URI.decode_www_form(req.query_string.to_s).to_h
  days  = [(query["days"] || "30").to_i, 90].min
  model = query["model"]

  store = Clacky::Billing::BillingStore.new
  daily = store.daily_breakdown(days: days, model: model)

  json_response(res, 200, { days: daily })
end

#api_billing_records(req, res) ⇒ Object

GET /api/billing/records Returns recent billing records Query params: limit (default: 100), model, session_id



2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/clacky/server/http_server.rb', line 2899

def api_billing_records(req, res)
  require_relative "../billing/billing_store"

  query      = URI.decode_www_form(req.query_string.to_s).to_h
  limit      = [(query["limit"] || "100").to_i, 500].min
  model      = query["model"]
  session_id = query["session_id"]

  store   = Clacky::Billing::BillingStore.new
  records = store.query(model: model, session_id: session_id, limit: limit)

  json_response(res, 200, {
    records: records.map(&:to_h),
    count: records.size
  })
end

#api_billing_sessions(req, res) ⇒ Object

GET /api/billing/sessions Returns session-level billing summary Query params: period (day|week|month|year|all, default: month), model, limit



2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
 
# File 'lib/clacky/server/http_server.rb', line 2919

def api_billing_sessions(req, res)
  require_relative "../billing/billing_store"

  query = URI.decode_www_form(req.query_string.to_s).to_h
  period = (query["period"] || "month").to_sym
  model = query["model"]
  limit = [(query["limit"] || "50").to_i, 200].min

  store = Clacky::Billing::BillingStore.new
  sessions = store.session_summary(period: period, model: model, limit: limit)

  json_response(res, 200, {
    sessions: sessions,
    count: sessions.size
  })
end

#api_billing_summary(req, res) ⇒ Object

GET /api/billing/summary Returns billing summary for a time period Query params: period (day|week|month|year|all, default: month), model (optional)



2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
 
# File 'lib/clacky/server/http_server.rb', line 2867

def api_billing_summary(req, res)
  require_relative "../billing/billing_store"

  query  = URI.decode_www_form(req.query_string.to_s).to_h
  period = (query["period"] || "month").to_sym
  model  = query["model"]

  store   = Clacky::Billing::BillingStore.new
  summary = store.summary(period: period, model: model)

  json_response(res, 200, summary)
end

#api_brand_activate(req, res) ⇒ Object

POST /api/brand/activate Body: { license_key: "XXXX-XXXX-XXXX-XXXX-XXXX" } Activates the license and persists the result to brand.yml.



2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
 
# File 'lib/clacky/server/http_server.rb', line 2314

def api_brand_activate(req, res)
  body = parse_json_body(req)
  key  = body["license_key"].to_s.strip

  if key.empty?
    json_response(res, 422, { ok: false, error: "license_key is required" })
    return
  end

  brand  = Clacky::BrandConfig.load
  result = @brand_test ? brand.activate_mock!(key) : brand.activate!(key)

  if result[:success]
    # Refresh skill_loader with the now-activated brand config so brand
    # skills are loadable from this point forward (e.g. after sync).
    @skill_loader = Clacky::SkillLoader.new(working_dir: nil, brand_config: brand)
    # Install all brand skills in the background on first activation so
    # they are available immediately without manual user action.
    brand.sync_brand_skills_async!(install_new: true)
    json_response(res, 200, {
      ok:            true,
      product_name:  result[:product_name] || brand.product_name,
      user_id:       result[:user_id] || brand.license_user_id,
      user_licensed: brand.user_licensed?,
      theme_color:   brand.theme_color
    })
  else
    json_response(res, 422, { ok: false, error: result[:message] })
  end
end

#api_brand_info(res) ⇒ Object

GET /api/brand Returns brand metadata consumed by the WebUI on boot to dynamically replace branding strings.



2855
2856
2857
2858
 
# File 'lib/clacky/server/http_server.rb', line 2855

def api_brand_info(res)
  brand = Clacky::BrandConfig.load
  json_response(res, 200, brand.to_h)
end

#api_brand_skill_install(slug, req, res) ⇒ Object

POST /api/brand/skills/:name/install Downloads and installs (or updates) the given brand skill. Body may optionally contain { skill_info: ... } from the frontend cache; otherwise we re-fetch to get the download_url.



2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
 
# File 'lib/clacky/server/http_server.rb', line 2772

def api_brand_skill_install(slug, req, res)
  brand = Clacky::BrandConfig.load

  # Free-mode: branded but not activated. Fall back to the public free
  # skills endpoint and install with encrypted: false. Paid (encrypted)
  # skills still require activation and will return 404 here.
  unless brand.activated?
    fetch_result = brand.fetch_free_skills!
    unless fetch_result[:success]
      json_response(res, 422, { ok: false, error: fetch_result[:error] })
      return
    end

    skill_info = fetch_result[:skills].find { |s| s["name"] == slug }
    unless skill_info
      json_response(res, 404, { ok: false, error: "Skill '#{slug}' is not a free skill — activate your license to access it." })
      return
    end

    result = brand.install_free_skill!(skill_info)
    if result[:success]
      @skill_loader = Clacky::SkillLoader.new(working_dir: nil, brand_config: brand)
      json_response(res, 200, { ok: true, name: result[:name], version: result[:version] })
    else
      json_response(res, 422, { ok: false, error: result[:error] })
    end
    return
  end

  # Re-fetch the skills list to get the authoritative download_url
  if @brand_test
    all_skills = mock_brand_skills(brand)[:skills]
  else
    fetch_result = brand.fetch_brand_skills!
    unless fetch_result[:success]
      json_response(res, 422, { ok: false, error: fetch_result[:error] })
      return
    end
    all_skills = fetch_result[:skills]
  end

  skill_info = all_skills.find { |s| s["name"] == slug }
  unless skill_info
    json_response(res, 404, { ok: false, error: "Skill '#{slug}' not found in license" })
    return
  end

  # In brand-test mode use the mock installer which writes a real .enc file
  # so the full decrypt → load → invoke code-path is exercised end-to-end.
  result = @brand_test ? brand.install_mock_brand_skill!(skill_info) : brand.install_brand_skill!(skill_info)

  if result[:success]
    # Reload skills so the Agent can pick up the new skill immediately.
    # Re-create the loader with the current brand_config so brand skills are decryptable.
    @skill_loader = Clacky::SkillLoader.new(working_dir: nil, brand_config: brand)
    json_response(res, 200, { ok: true, name: result[:name], version: result[:version] })
  else
    json_response(res, 422, { ok: false, error: result[:error] })
  end
rescue StandardError, ScriptError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_brand_skills(res) ⇒ Object

POST /api/store/skills/:slug/install



2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
 
# File 'lib/clacky/server/http_server.rb', line 2703

def api_brand_skills(res)
  brand = Clacky::BrandConfig.load

  unless brand.activated?
    # Free-mode: branded but no license. Return the unencrypted skills
    # available to anonymous installs so the Brand Skills tab is not
    # empty and the user can install/use them without a serial number.
    # Each skill is tagged is_free=true so the UI can show a "Free" badge.
    result = brand.fetch_free_skills!

    if result[:success]
      free_skills = result[:skills].map { |s| s.merge("is_free" => true) }
      json_response(res, 200, {
        ok:                true,
        skills:            free_skills,
        free_mode:         true,
        paid_skills_count: result[:paid_skills_count].to_i
      })
    else
      json_response(res, 200, {
        ok:                true,
        skills:            [],
        free_mode:         true,
        paid_skills_count: 0,
        warning_code:      "remote_unavailable",
        warning:           result[:error] || "Could not reach the license server."
      })
    end
    return
  end

  if @brand_test
    # Return mock skills in brand-test mode instead of calling the remote API
    result = mock_brand_skills(brand)
  else
    result = brand.fetch_brand_skills!
  end

  if result[:success]
    json_response(res, 200, { ok: true, skills: result[:skills], expires_at: result[:expires_at] })
  else
    # Remote API failed — fall back to locally installed skills so the user
    # can still see and use what they already have. Surface a soft warning.
    local_skills = brand.installed_brand_skills.map do |name, meta|
      {
        "name"              => meta["name"] || name,
        "name_zh"           => meta["name_zh"].to_s,
        # Use locally cached description so it renders correctly offline
        "description"       => meta["description"].to_s,
        "description_zh"    => meta["description_zh"].to_s,
        "installed_version" => meta["version"],
        "needs_update"      => false
      }
    end
    json_response(res, 200, {
      ok:           true,
      skills:       local_skills,
      # warning_code lets the frontend render a localized message.
      # `warning` is kept for back-compat and as an English fallback.
      warning_code: "remote_unavailable",
      warning:      "Could not reach the license server. Showing locally installed skills only."
    })
  end
end

#api_brand_status(res) ⇒ Object

GET /api/brand/status Returns whether brand activation is needed. Mirrors the onboard/status pattern so the frontend can gate on it.

Response:

{ branded: false }                              → no brand, nothing to do
{ branded: true, needs_activation: true,
product_name: "JohnAI" }                     → license key required
{ branded: true, needs_activation: false,
product_name: "JohnAI", warning: "..." }     → activated, possible warning


2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
 
# File 'lib/clacky/server/http_server.rb', line 2226

def api_brand_status(res)
  brand = Clacky::BrandConfig.load

  unless brand.branded?
    json_response(res, 200, { branded: false })
    return
  end

  unless brand.activated?
    # Refresh public brand assets (logo, theme, homepage_url, support_*)
    # if due. This catches the common case of `install.sh --brand-name=X`
    # which writes only product_name + package_name — without this poll
    # the user would never see the brand's logo/theme until activation.
    # Completely asynchronous: we do NOT wait for the network round-trip.
    #
    # `distribution_refresh_pending` lets the Web UI know a refresh is
    # in flight, so it can re-poll /api/brand shortly and apply the
    # logo/theme without requiring the user to activate or refresh the
    # page first.
    refresh_pending = false
    if brand.distribution_refresh_due?
      trigger_async_distribution_refresh!
      refresh_pending = true
    end

    json_response(res, 200, {
      branded:                       true,
      needs_activation:              true,
      product_name:                  brand.product_name,
      homepage_url:                  brand.homepage_url,
      logo_url:                      brand.logo_url,
      theme_color:                   brand.theme_color,
      test_mode:                     @brand_test,
      distribution_refresh_pending:  refresh_pending
    })
    return
  end

  # Send heartbeat asynchronously if interval has elapsed (once per day).
  #
  # We must NOT block this HTTP response on the heartbeat call: a slow or
  # unreachable license server would otherwise stall the Web UI's first
  # paint for up to ~92s (2 hosts × 2 attempts × 23s timeout). The fresh
  # expires_at / last_heartbeat will be picked up on the next /api/brand/status
  # poll, which is sufficient for a once-per-day check.
  if brand.heartbeat_due?
    trigger_async_heartbeat!
  else
    Clacky::Logger.debug("[Brand] api_brand_status: heartbeat not due yet")
  end

  Clacky::Logger.debug("[Brand] api_brand_status: expired=#{brand.expired?} grace_exceeded=#{brand.grace_period_exceeded?} expires_at=#{brand.license_expires_at&.iso8601 || "nil"}")

  warning      = nil
  warning_type = nil
  if brand.expired?
    warning      = "Your #{brand.product_name} license has expired. Please renew to continue."
    warning_type = "expired"
  elsif brand.grace_period_exceeded?
    warning      = "License server unreachable for more than 3 days. Please check your connection."
    warning_type = "unreachable"
  elsif brand.license_expires_at && !brand.expired?
    days_remaining = ((brand.license_expires_at - Time.now.utc) / 86_400).ceil
    if days_remaining <= 7
      warning      = "Your #{brand.product_name} license expires in #{days_remaining} day#{"s" if days_remaining != 1}. Please renew soon."
      warning_type = "expiring"
    end
  end

  Clacky::Logger.debug("[Brand] api_brand_status: warning=#{warning.inspect} warning_type=#{warning_type.inspect}")

  json_response(res, 200, {
    branded:          true,
    needs_activation: false,
    product_name:     brand.product_name,
    homepage_url:     brand.homepage_url,
    logo_url:         brand.logo_url,
    warning:          warning,
    warning_type:     warning_type,
    test_mode:        @brand_test,
    user_licensed:    brand.user_licensed?,
    license_user_id:  brand.license_user_id
  })
end

#api_browse_dirs(req, res) ⇒ Object

GET /api/dirs?path=<absolute-or-~-path> Session-independent directory browser used by the New Session modal, where no session (and thus no working_dir) exists yet. Always operates in absolute mode and lists directories only.



4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
 
# File 'lib/clacky/server/http_server.rb', line 4524

def api_browse_dirs(req, res)
  query = URI.decode_www_form(req.query_string.to_s).to_h
  rel   = query["path"].to_s.strip
  show_hidden = query["show_hidden"] == "true"
  rel   = Dir.home if rel.empty?
  target = File.expand_path(rel.start_with?("~") ? rel.sub(/\A~/, Dir.home) : rel)

  # The requested directory may not exist yet (e.g. the default
  # ~/clacky_workspace before any session created it). Instead of 404,
  # walk up to the nearest existing ancestor so the picker stays usable.
  until Dir.exist?(target)
    parent = File.dirname(target)
    break if parent == target
    target = parent
  end
  return json_response(res, 404, { error: "Directory not found" }) unless Dir.exist?(target)

  entries = Dir.children(target).reject do |name|
    IGNORED_FILE_ENTRIES.include?(name) || (!show_hidden && name.start_with?("."))
  end
  items = entries.filter_map do |name|
    full = File.join(target, name)
    next unless File.directory?(full) && File.exist?(full)
    { name: name, path: full, type: "dir" }
  rescue StandardError
    nil
  end
  items.sort_by! { |it| it[:name].downcase }

  json_response(res, 200, { root: target, path: target, parent: File.dirname(target), home: Dir.home, default: default_working_dir, entries: items })
rescue StandardError => e
  json_response(res, 500, { error: e.message })
end

#api_browser_configure(req, res) ⇒ Object

POST /api/browser/configure Called by browser-setup skill to write browser.yml and hot-reload the daemon. Body: { chrome_version: "146" }



1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
 
# File 'lib/clacky/server/http_server.rb', line 1412

def api_browser_configure(req, res)
  body          = JSON.parse(req.body.to_s) rescue {}
  chrome_version = body["chrome_version"].to_s.strip
  return json_response(res, 422, { ok: false, error: "chrome_version is required" }) if chrome_version.empty?

  @browser_manager.configure(chrome_version: chrome_version)
  json_response(res, 200, { ok: true })
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_browser_reload(res) ⇒ Object

POST /api/browser/reload Called by browser-setup skill after writing browser.yml. Hot-reloads the MCP daemon with the new configuration.



1426
1427
1428
1429
1430
1431
 
# File 'lib/clacky/server/http_server.rb', line 1426

def api_browser_reload(res)
  @browser_manager.reload
  json_response(res, 200, { ok: true })
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_browser_status(res) ⇒ Object 



1405
1406
1407
 
# File 'lib/clacky/server/http_server.rb', line 1405

def api_browser_status(res)
  json_response(res, 200, @browser_manager.status)
end

#api_browser_toggle(res) ⇒ Object

POST /api/browser/toggle



1434
1435
1436
1437
1438
1439
 
# File 'lib/clacky/server/http_server.rb', line 1434

def api_browser_toggle(res)
  enabled = @browser_manager.toggle
  json_response(res, 200, { ok: true, enabled: enabled })
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_change_session_working_dir(session_id, req, res) ⇒ Object 



6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
 
# File 'lib/clacky/server/http_server.rb', line 6117

def api_change_session_working_dir(session_id, req, res)
  body = parse_json_body(req)
  new_dir = body["working_dir"].to_s.strip

  return json_response(res, 400, { error: "working_dir is required" }) if new_dir.empty?
  return json_response(res, 404, { error: "Session not found" }) unless @registry.ensure(session_id)

  # Expand ~ to home directory
  expanded_dir = File.expand_path(new_dir)

  # Auto-create the directory if it doesn't exist yet.
  FileUtils.mkdir_p(expanded_dir)

  agent = nil
  @registry.with_session(session_id) { |s| agent = s[:agent] }
  
  # Change the agent's working directory
  agent.change_working_dir(expanded_dir)
  
  # Persist the change
  @session_manager.save(agent.to_session_data)
  
  # Broadcast update to all clients
  broadcast_session_update(session_id)
  
  json_response(res, 200, { ok: true, working_dir: expanded_dir })
rescue => e
  json_response(res, 500, { error: e.message })
end

#api_create_cron_task(req, res) ⇒ Object

POST /api/cron-tasks — create task file + schedule in one step Body: { name, content, cron, enabled? }



4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
 
# File 'lib/clacky/server/http_server.rb', line 4126

def api_create_cron_task(req, res)
  body    = parse_json_body(req)
  name    = body["name"].to_s.strip
  content = body["content"].to_s
  cron    = body["cron"].to_s.strip
  enabled = body.key?("enabled") ? body["enabled"] : true

  return json_response(res, 422, { error: "name is required" })    if name.empty?
  return json_response(res, 422, { error: "content is required" }) if content.empty?
  return json_response(res, 422, { error: "cron is required" })    if cron.empty?

  fields = cron.strip.split(/\s+/)
  unless fields.size == 5
    return json_response(res, 422, { error: "cron must have 5 fields (min hour dom month dow)" })
  end

  @scheduler.create_cron_task(name: name, content: content, cron: cron, enabled: enabled)
  json_response(res, 201, { ok: true, name: name })
end

#api_create_session(req, res) ⇒ Object 



809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
 
# File 'lib/clacky/server/http_server.rb', line 809

def api_create_session(req, res)
  body = parse_json_body(req)
  name = body["name"]
  return json_response(res, 400, { error: "name is required" }) if name.nil? || name.strip.empty?

  # Optional agent_profile; defaults to "general" if omitted or invalid
  profile = body["agent_profile"].to_s.strip
  profile = "general" if profile.empty?

  # Optional source; defaults to :manual. Accept "system" for skill-launched sessions
  # (e.g. /onboard, /browser-setup, /channel-manager).
  raw_source = body["source"].to_s.strip
  source = %w[manual cron channel setup].include?(raw_source) ? raw_source.to_sym : :manual

  raw_dir = body["working_dir"].to_s.strip
  working_dir = raw_dir.empty? ? default_working_dir : File.expand_path(raw_dir)

  # Optional model override — passed as a stable model id (matches the
  # id returned by GET /api/config). Name-based override was removed:
  # a bare model name can't disambiguate between entries from different
  # providers (e.g. "deepseek-v4-pro" on DeepSeek direct vs its dsk-*
  # alias on OpenClacky/Bedrock), and mutating current_model["model"]
  # kept the wrong api_key / base_url / api format, producing
  # "unknown model" errors at the provider.
  model_id_override = body["model_id"].to_s.strip
  model_id_override = nil if model_id_override.empty?

  if model_id_override && !@agent_config.models.any? { |m| m["id"] == model_id_override }
    return json_response(res, 400, { error: "Model not found in configuration" })
  end

  # Create working directory if it doesn't exist
  # Allow multiple sessions in the same directory
  FileUtils.mkdir_p(working_dir)

  session_id = build_session(name: name, working_dir: working_dir, profile: profile, source: source, model_id: model_id_override)
  broadcast_session_update(session_id)
  json_response(res, 201, { session: @registry.session_summary(session_id) })
end

#api_delete_brand_skill(slug, res) ⇒ Object

DELETE /api/brand/skills/:slug Uninstalls a brand skill by removing its files and metadata.



2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
 
# File 'lib/clacky/server/http_server.rb', line 2837

def api_delete_brand_skill(slug, res)
  brand = Clacky::BrandConfig.load
  installed = brand.installed_brand_skills
  unless installed.key?(slug)
    json_response(res, 404, { ok: false, error: "Brand skill '#{slug}' is not installed" })
    return
  end

  brand.delete_brand_skill!(slug)
  @skill_loader = Clacky::SkillLoader.new(working_dir: nil, brand_config: brand)
  json_response(res, 200, { ok: true })
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_delete_channel(platform, res) ⇒ Object

DELETE /api/channels/:platform Disables the platform (keeps credentials, sets enabled: false).



3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
 
# File 'lib/clacky/server/http_server.rb', line 3943

def api_delete_channel(platform, res)
  platform = platform.to_sym
  config   = Clacky::ChannelConfig.load
  config.disable_platform(platform)
  config.save

  @channel_manager.reload_platform(platform, config)

  json_response(res, 200, { ok: true })
rescue StandardError => e
  json_response(res, 422, { ok: false, error: e.message })
end

#api_delete_cron_task(name, res) ⇒ Object

DELETE /api/cron-tasks/:name — remove task file + schedule



4165
4166
4167
4168
4169
4170
4171
 
# File 'lib/clacky/server/http_server.rb', line 4165

def api_delete_cron_task(name, res)
  if @scheduler.delete_cron_task(name)
    json_response(res, 200, { ok: true })
  else
    json_response(res, 404, { error: "Cron task not found: #{name}" })
  end
end

#api_delete_model(id, res) ⇒ Object

DELETE /api/config/models/:id



5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
 
# File 'lib/clacky/server/http_server.rb', line 5726

def api_delete_model(id, res)
  models = @agent_config.models
  return json_response(res, 404, { error: "model not found" }) unless models.any? { |m| m["id"] == id }
  return json_response(res, 422, { error: "cannot delete the last model" }) if models.length <= 1

  index = models.find_index { |m| m["id"] == id }
  removed = models.delete_at(index)

  # Re-anchor current_* if we just deleted the active model.
  if @agent_config.current_model_id == removed["id"]
    new_default = models.find { |m| m["type"] == "default" } || models.first
    # If the removed model was the default, promote the new current
    # model so the config always has exactly one default entry.
    if removed["type"] == "default" && new_default && new_default["type"] != "default"
      new_default["type"] = "default"
    end
    @agent_config.current_model_id    = new_default["id"]
    @agent_config.current_model_index = models.find_index { |m| m["id"] == new_default["id"] } || 0
  elsif @agent_config.current_model_index >= models.length
    @agent_config.current_model_index = models.length - 1
  end

  @agent_config.save
  json_response(res, 200, { ok: true })
rescue => e
  json_response(res, 422, { error: e.message })
end

#api_delete_session(session_id, res) ⇒ Object 



6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
 
# File 'lib/clacky/server/http_server.rb', line 6156

def api_delete_session(session_id, res)
  # A session exists if it's either in the runtime registry OR on disk.
  # Old sessions that were never restored into memory this server run
  # (e.g. shown via "load more" in the WebUI list) are disk-only — we
  # must still be able to delete them. Previously this endpoint only
  # consulted @registry and returned 404 for disk-only sessions,
  # causing the "can't delete old sessions" bug.
  in_registry = @registry.exist?(session_id)
  on_disk     = !@session_manager.load(session_id).nil?

  unless in_registry || on_disk
    return json_response(res, 404, { error: "Session not found" })
  end

  # Registry delete is best-effort — only meaningful when the session
  # is actually live (cancels idle timer, interrupts the agent thread).
  # For disk-only sessions this is a no-op and returns false, which is
  # fine and no longer blocks the disk cleanup below.
  @registry.delete(session_id) if in_registry

  # Soft-delete: move session to trash instead of permanently destroying it.
  @session_manager.soft_delete(session_id) if on_disk

  # Notify any still-connected clients (mainly matters when the
  # session was live, but harmless otherwise).
  broadcast(session_id, { type: "session_deleted", session_id: session_id })
  unsubscribe_all(session_id)

  json_response(res, 200, { ok: true })
end

#api_dirs_mkdir(req, res) ⇒ Object

POST /api/dirs/mkdir Body: { parent: "/abs/parent", name: "New Folder" }



4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
 
# File 'lib/clacky/server/http_server.rb', line 4572

def api_dirs_mkdir(req, res)
  body   = parse_json_body(req)
  parent = body["parent"].to_s
  name   = body["name"].to_s.strip

  return json_response(res, 422, { error: "parent must be an absolute path" }) unless parent.start_with?("/")
  return json_response(res, 422, { error: "name is invalid" }) unless picker_valid_name?(name)

  parent = File.expand_path(parent)
  return json_response(res, 404, { error: "Parent directory not found" }) unless Dir.exist?(parent)

  target = File.join(parent, name)
  return json_response(res, 422, { error: "Already exists" }) if File.exist?(target)

  FileUtils.mkdir_p(target)
  json_response(res, 200, { ok: true, path: target, name: name })
rescue StandardError => e
  json_response(res, 500, { error: e.message })
end

#api_exchange_rate(req, res) ⇒ Object

GET /api/exchange-rate?from=USD&to=CNY Fetches the latest exchange rate on demand. The browser still owns the saved preference in localStorage; this API is only a lightweight proxy that avoids CORS issues and normalizes provider responses.



879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
 
# File 'lib/clacky/server/http_server.rb', line 879

def api_exchange_rate(req, res)
  query = URI.decode_www_form(req.query_string.to_s).to_h
  from  = normalize_currency_code(query["from"], fallback: "USD")
  to    = normalize_currency_code(query["to"], fallback: "CNY")

  unless from && to
    return json_response(res, 400, { error: "from and to must be 3-letter currency codes" })
  end

  data = fetch_exchange_rate(from, to)
  json_response(res, 200, data)
rescue StandardError => e
  Clacky::Logger.warn("[ExchangeRate] failed: #{e.class}: #{e.message}")
  json_response(res, 502, { error: "Failed to fetch exchange rate" })
end

#api_export_session(session_id, res) ⇒ Object

Export a session bundle as a .zip download containing:

- session.json          (always)
- chunk-*.md            (0..N archived conversation chunks)
- logs/clacky-YYYY-MM-DD.log  (today's logger file, if present)

Useful for debugging — user clicks "download" in the WebUI status bar and we can ask them to attach the zip to a bug report.



6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
 
# File 'lib/clacky/server/http_server.rb', line 6193

def api_export_session(session_id, res)
  bundle = @session_manager.files_for(session_id)
  unless bundle
    return json_response(res, 404, { error: "Session not found" })
  end

  require "zip"

  short_id = bundle[:session][:session_id].to_s[0..7]
  # Build the zip entirely in memory — session files are small (< few MB).
  buffer = Zip::OutputStream.write_buffer do |zos|
    zos.put_next_entry("session.json")
    zos.write(File.binread(bundle[:json_path]))

    bundle[:chunks].each do |chunk_path|
      # Preserve original chunk filename so the ordering (chunk-1.md, chunk-2.md, ...) is clear.
      zos.put_next_entry(File.basename(chunk_path))
      zos.write(File.binread(chunk_path))
    end

    log_path = Clacky::Logger.current_log_file
    if log_path && File.exist?(log_path)
      zos.put_next_entry("logs/#{File.basename(log_path)}")
      zos.write(File.binread(log_path))
    end
  end
  buffer.rewind
  data = buffer.read

  filename = "clacky-session-#{short_id}.zip"
  res.status = 200
  res.content_type = "application/zip"
  res["Content-Disposition"] = %(attachment; filename="#{filename}")
  res["Access-Control-Allow-Origin"] = "*"
  # Force a fresh copy each time — debugging sessions get new chunks over time.
  res["Cache-Control"] = "no-store"
  res.body = data
rescue => e
  Clacky::Logger.error("Session export failed: #{e.message}") if defined?(Clacky::Logger)
  json_response(res, 500, { error: "Export failed: #{e.message}" })
end

#api_file_action(req, res) ⇒ Object

POST /api/file-action Unified file action endpoint — open locally or download. Body: { path: String, action: "open" | "download" } open: opens the file with the OS default handler (local deployments). download: returns the file as a download (remote deployments).



3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
 
# File 'lib/clacky/server/http_server.rb', line 3791

def api_file_action(req, res)
  body = parse_json_body(req)
  path = body["path"]
  action = body["action"] || "open"

  return json_response(res, 400, { error: "path is required" }) unless path && !path.empty?

  # Path arrives already percent-decoded by the click handler; normalize
  # Windows drive letters (WSL) BEFORE expand_path or the drive is treated
  # as relative and corrupted. No-op on macOS/Linux.
  linux_path = Utils::EnvironmentDetector.win_to_linux_path(path)
  linux_path = File.expand_path(linux_path)

  return json_response(res, 404, { error: "file not found" }) unless File.exist?(linux_path)

  case action
  when "open"
    result = Utils::EnvironmentDetector.open_file(linux_path)
    return json_response(res, 501, { error: "unsupported OS" }) if result.nil?
    json_response(res, 200, { ok: true })
  when "reveal"
    Utils::EnvironmentDetector.reveal_file(linux_path)
    json_response(res, 200, { ok: true })
  when "download"
    serve_file_download(res, linux_path)
  when "display-path"
    display = Utils::EnvironmentDetector.linux_to_win_path(linux_path)
    json_response(res, 200, { ok: true, path: display })
  else
    json_response(res, 400, { error: "invalid action. Must be 'open', 'reveal', 'download' or 'display-path'" })
  end
rescue => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_fork_session(session_id, req, res) ⇒ Object 



6147
6148
6149
6150
6151
6152
6153
6154
 
# File 'lib/clacky/server/http_server.rb', line 6147

def api_fork_session(session_id, req, res)
  fork_data = @session_manager.fork(session_id)
  return json_response(res, 404, { error: "Session not found" }) unless fork_data

  fork_id = fork_data[:session_id]
  broadcast_session_update(fork_id)
  json_response(res, 201, { session: @registry.snapshot(fork_id) })
end

#api_get_config(req, res) ⇒ Object

GET /api/config — return current model configurations



5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
 
# File 'lib/clacky/server/http_server.rb', line 5404

def api_get_config(req, res)
  models = @agent_config.models.map.with_index do |m, i|
    {
      id:               m["id"],   # Stable runtime id — use this for switching
      index:            i,
      model:            m["model"],
      base_url:         m["base_url"],
      api_key_masked:   mask_api_key(m["api_key"]),
      anthropic_format: m["anthropic_format"] || false,
      provider_id:      m["provider_id"],
      type:             m["type"]
    }
  end
  # Filter out auto-injected models (lite, derived media) AND media
  # entries (image/video/audio/ocr) — those are managed via the dedicated
  # media-config UI, not the chat-model card list.
  models.reject! do |m|
    raw = @agent_config.models[m[:index]]
    raw["auto_injected"] ||
      Clacky::Providers::MEDIA_KINDS.include?(raw["type"].to_s) ||
      raw["type"].to_s == "ocr"
  end
  # Capabilities follow the model the *session* is actually running on
  # (it may differ from the global default after a per-session switch).
  query   = URI.decode_www_form(req.query_string.to_s).to_h
  cfg     = config_for_session(query["session_id"]) || @agent_config
  json_response(res, 200, {
    models: models,
    current_index: @agent_config.current_model_index,
    current_id: @agent_config.current_model&.dig("id"),
    media_capabilities: media_capabilities_payload(cfg)
  })
end

#api_get_media_config(res) ⇒ Object

GET /api/config/media Used by the Settings UI to render the tri-state media controls. Per-kind payload mirrors AgentConfig#media_state.



1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
 
# File 'lib/clacky/server/http_server.rb', line 1744

def api_get_media_config(res)
  out = {}
  Clacky::Providers::MEDIA_KINDS.each do |t|
    state = @agent_config.media_state(t)
    entry = @agent_config.find_model_by_type(t)
    out[t] = {
      source:     state["source"],
      model:      state["model"],
      base_url:   state["base_url"],
      api_key_masked: entry ? mask_api_key(entry["api_key"]) : nil,
      provider:   state["provider"],
      available:  state["available"],
      aliases:    state["aliases"] || {},
      stale:      state["stale"] || false,
      requested_model: state["requested_model"],
      configured: state["configured"]
    }
  end

  # Surface what the current default model can offer, even when the
  # user is currently in "off" — the UI uses this to render the
  # auto-mode preview ("Auto would use X").
  default = @agent_config.find_model_by_type("default")
  provider_id = default && Clacky::Providers.resolve_provider(
    base_url: default["base_url"],
    api_key:  default["api_key"]
  )
  defaults = {}
  Clacky::Providers::MEDIA_KINDS.each do |t|
    defaults[t] = {
      provider:  provider_id,
      model:     provider_id ? Clacky::Providers.default_media_model(provider_id, t) : nil,
      available: provider_id ? Clacky::Providers.media_models(provider_id, t) : [],
      aliases:   provider_id ? Clacky::Providers.media_model_aliases(provider_id, t) : {}
    }
  end

  json_response(res, 200, { media: out, default_provider: defaults })
end

#api_get_ocr_config(res) ⇒ Object

GET /api/config/ocr Returns the OCR sidecar state for the Settings UI. Mirrors media_state in shape so the UI can render OCR with the same row component.



1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
 
# File 'lib/clacky/server/http_server.rb', line 1921

def api_get_ocr_config(res)
  state = @agent_config.ocr_state
  entry = @agent_config.find_model_by_type("ocr")

  out = {
    source:         state["source"],
    model:          state["model"],
    base_url:       state["base_url"],
    api_key_masked: entry ? mask_api_key(entry["api_key"]) : nil,
    provider:       state["provider"],
    available:      state["available"],
    stale:          state["stale"] || false,
    requested_model: state["requested_model"],
    configured:     state["configured"],
    primary:        state["primary"] || false
  }

  # Auto-mode preview: surface what the OCR sidecar *would* be if the
  # user flipped to "auto" — derived from the same provider as the
  # current default model.
  default = @agent_config.find_model_by_type("default")
  provider_id = default && Clacky::Providers.resolve_provider(
    base_url: default["base_url"],
    api_key:  default["api_key"]
  )
  default_preview = {
    provider:  provider_id,
    model:     provider_id ? Clacky::Providers.default_ocr_model(provider_id) : nil,
    available: provider_id ? Clacky::Providers.ocr_models(provider_id) : []
  }

  json_response(res, 200, { ocr: out, default_provider: default_preview })
end

#api_get_session(session_id, res) ⇒ Object

GET /api/sessions/:id — fetch a single session by id (memory + disk merged). Used by the frontend Router when navigating to a session that isn't in the paged sidebar list (search results, URL deep links, share links, browser back/forward, external notifications, etc.).



803
804
805
806
807
 
# File 'lib/clacky/server/http_server.rb', line 803

def api_get_session(session_id, res)
  row = @registry.snapshot(session_id)
  return json_response(res, 404, { error: "Session not found" }) unless row
  json_response(res, 200, { session: row })
end

#api_get_settings(res) ⇒ Object

GET /api/config/settings — return advanced settings



5533
5534
5535
5536
5537
5538
5539
5540
5541
 
# File 'lib/clacky/server/http_server.rb', line 5533

def api_get_settings(res)
  json_response(res, 200, {
    ok: true,
    enable_compression: @agent_config.enable_compression,
    enable_prompt_caching: @agent_config.enable_prompt_caching,
    memory_update_enabled: @agent_config.memory_update_enabled,
    proxy_url: @agent_config.proxy_url.to_s
  })
end

#api_get_version(res) ⇒ Object

GET /api/version Returns current version and latest version from RubyGems (cached for 1 hour).



2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
 
# File 'lib/clacky/server/http_server.rb', line 2954

def api_get_version(res)
  current = Clacky::VERSION
  latest  = fetch_latest_version_cached
  brand   = Clacky::BrandConfig.load
  cli_cmd = brand.branded? && brand.package_name && !brand.package_name.empty? ? brand.package_name : "openclacky"
  json_response(res, 200, {
    current:      current,
    latest:       latest,
    needs_update: latest ? version_older?(current, latest) : false,
    launcher:     ENV["CLACKY_LAUNCHER"] || "cli",
    cli_command:  cli_cmd
  })
end

#api_group_history(chat_id, res) ⇒ Object 



3758
3759
3760
3761
3762
3763
 
# File 'lib/clacky/server/http_server.rb', line 3758

def api_group_history(chat_id, res)
  messages = @channel_manager.group_history(chat_id)
  json_response(res, 200, { chat_id: chat_id, messages: messages })
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_internal_ocr_image(req, res) ⇒ Object

POST /api/internal/ocr-image Internal endpoint used by parser scripts (e.g. pdf_parser_vlm.py) to transcribe a single image via the configured OCR sidecar. Localhost- only by virtue of the standard auth path: when the server binds to 127.0.0.1 (@localhost_only), check_access_key returns true without requiring a token, so parsers running on the same host can call this endpoint with no extra wiring.

Request: multipart/form-data with field "image" (binary), optional "prompt" OR JSON body { "data_url": "data:image/png;base64,...", "prompt": "..." } Response: { ok: true, text: "..." } or { ok: false, message: "..." }



2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
 
# File 'lib/clacky/server/http_server.rb', line 2046

def api_internal_ocr_image(req, res)
  entry = @agent_config.find_model_by_type("ocr")
  unless entry
    return json_response(res, 503, { ok: false, message: "OCR sidecar not configured" })
  end

  prompt   = nil
  data_url = nil
  bytes    = nil
  mime     = "image/png"

  ctype = req.content_type.to_s
  if ctype.start_with?("multipart/form-data")
    parts = req.query
    if (img = parts["image"])
      bytes = img.respond_to?(:read) ? img.read : img.to_s
      mime  = (img.respond_to?(:[]) ? img["content-type"].to_s : nil)
      mime  = "image/png" if mime.nil? || mime.empty?
    end
    prompt = parts["prompt"].to_s if parts["prompt"]
  else
    body = parse_json_body(req) || {}
    data_url = body["data_url"].to_s
    prompt   = body["prompt"].to_s if body["prompt"]
  end

  image =
    if bytes && !bytes.empty?
      { bytes: bytes, mime_type: mime }
    elsif data_url && !data_url.empty?
      { data_url: data_url }
    else
      return json_response(res, 400, { ok: false, message: "image or data_url required" })
    end

  text = Clacky::Vision::Resolver.new(entry).describe(image, prompt: prompt)
  if text && !text.strip.empty?
    json_response(res, 200, { ok: true, text: text })
  else
    json_response(res, 200, { ok: false, message: "OCR returned empty result" })
  end
rescue => e
  json_response(res, 500, { ok: false, message: e.message })
end

#api_list_agents(res) ⇒ Object

GET /api/agents — list all available agent profiles (default + user override + ext). Each entry carries { id, title, title_zh, description, description_zh, source, order, layer, author }. Extensions can supply title_zh / description_zh / author in their ext.yml so the New Session cards read naturally and credit their author.



4235
4236
4237
4238
 
# File 'lib/clacky/server/http_server.rb', line 4235

def api_list_agents(res)
  agents = Clacky::AgentProfile.all
  json_response(res, 200, { agents: agents })
end

#api_list_channel_users(platform, res) ⇒ Object

GET /api/channels/:platform/users Returns the list of known user IDs for the given platform. These are users who have sent at least one message to the bot in this server session.

For Weixin: returns users with a cached context_token (required for proactive messaging). For Feishu / WeCom: returns user IDs extracted from channel session bindings.

Response:

200 { users: ["uid1", "uid2", ...] }


3750
3751
3752
3753
3754
3755
3756
 
# File 'lib/clacky/server/http_server.rb', line 3750

def api_list_channel_users(platform, res)
  platform = platform.to_sym
  users    = @channel_manager.known_users(platform)
  json_response(res, 200, { platform: platform, users: users })
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_list_channels(res) ⇒ Object 



3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
 
# File 'lib/clacky/server/http_server.rb', line 3400

def api_list_channels(res)
  config   = Clacky::ChannelConfig.load
  running  = @channel_manager.running_platforms

  platforms = Clacky::Channel::Adapters.all.map do |klass|
    platform = klass.platform_id
    raw      = config.instance_variable_get(:@channels)[platform.to_s] || {}
    {
      platform:  platform,
      enabled:   !!raw["enabled"],
      running:   running.include?(platform),
      has_config: !config.platform_config(platform).nil?
    }.merge(platform_safe_fields(platform, config))
  end

  json_response(res, 200, { channels: platforms })
end

#api_list_cron_tasks(res) ⇒ Object

GET /api/cron-tasks



4120
4121
4122
 
# File 'lib/clacky/server/http_server.rb', line 4120

def api_list_cron_tasks(res)
  json_response(res, 200, { cron_tasks: @scheduler.list_cron_tasks })
end

#api_list_providers(res) ⇒ Object

GET /api/providers — return built-in provider presets for quick setup



5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
 
# File 'lib/clacky/server/http_server.rb', line 5832

def api_list_providers(res)
  providers = Clacky::Providers::PRESETS.map do |id, preset|
    {
      id:                id,
      name:              preset["name"],
      # Optional i18n key for the display name (localised per UI language);
      # frontend falls back to `name` when absent or untranslated.
      name_key:          preset["name_key"],
      base_url:          preset["base_url"],
      default_model:     preset["default_model"],
      models:            preset["models"] || [],
      # Frontend uses this to render a Base URL dropdown (regional /
      # billing-plan variants) when present. Absent for single-endpoint
      # providers — UI renders a plain text input in that case.
      endpoint_variants: preset["endpoint_variants"],
      website_url:       preset["website_url"]
    }
  end
  json_response(res, 200, { providers: providers })
end

#api_list_sessions(req, res) ⇒ Object

── REST API ──────────────────────────────────────────────────────────────



774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
 
# File 'lib/clacky/server/http_server.rb', line 774

def api_list_sessions(req, res)
  query        = URI.decode_www_form(req.query_string.to_s).to_h
  limit        = [query["limit"].to_i.then { |n| n > 0 ? n : 20 }, 50].min
  before       = query["before"].to_s.strip.then  { |v| v.empty? ? nil : v }
  q            = query["q"].to_s.strip.then       { |v| v.empty? ? nil : v }
  q_scope      = query["q_scope"].to_s.strip.then { |v| %w[name content].include?(v) ? v : "name" }
  date         = query["date"].to_s.strip.then    { |v| v.empty? ? nil : v }
  type         = query["type"].to_s.strip.then    { |v| v.empty? ? nil : v }
  exclude_type = query["exclude_type"].to_s.strip.then { |v| v.empty? ? nil : v }
  # Backward-compat: ?source=<x> and ?profile=coding → type
  type ||= query["profile"].to_s.strip.then { |v| v.empty? ? nil : v }
  type ||= query["source"].to_s.strip.then  { |v| v.empty? ? nil : v }

  sessions = @registry.list(limit: limit + 1, before: before, q: q, q_scope: q_scope, date: date, type: type, exclude_type: exclude_type)

  pinned_part, non_pinned_part = sessions.partition { |s| s[:pinned] }
  has_more = non_pinned_part.size > limit
  non_pinned_part = non_pinned_part.first(limit)
  sessions = pinned_part + non_pinned_part

  stats = @registry.cron_stats
  json_response(res, 200, { sessions: sessions, has_more: has_more,
                            cron_count: stats[:count], latest_cron_updated_at: stats[:latest_updated_at] })
end

#api_list_skills(res) ⇒ Object

GET /api/skills — list all loaded skills with metadata



4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
 
# File 'lib/clacky/server/http_server.rb', line 4195

def api_list_skills(res)
  @skill_loader.load_all  # refresh from disk on each request
  upload_meta = Clacky::BrandConfig.load_upload_meta
  shadowed    = @skill_loader.shadowed_by_local

  skills = @skill_loader.all_skills.reject(&:brand_skill).map do |skill|
    source = @skill_loader.loaded_from[skill.identifier]
    meta   = upload_meta[skill.identifier] || {}

    # Compute local modification time of SKILL.md for "has local changes" indicator
    skill_md_path = File.join(skill.directory.to_s, "SKILL.md")
    local_modified_at = File.exist?(skill_md_path) ? File.mtime(skill_md_path).utc.iso8601 : nil

    entry = {
      name:              skill.identifier,
      name_zh:           skill.name_zh,
      description:       skill.context_description,
      description_zh:    skill.description_zh,
      source:            source,
      always_show:       skill.always_show,
      enabled:           !skill.disabled?,
      invalid:           skill.invalid?,
      warnings:          skill.warnings,
      platform_version:  meta["platform_version"],
      uploaded_at:       meta["uploaded_at"],
      local_modified_at: local_modified_at,
      # true when this local skill is shadowing a same-named brand skill
      shadowing_brand:   shadowed.key?(skill.identifier)
    }
    entry[:invalid_reason] = skill.invalid_reason if skill.invalid?
    entry
  end
  json_response(res, 200, { skills: skills })
end

#api_mcp_call(name, req, res) ⇒ Object

POST /api/mcp/:name/call body: { tool: "...", arguments: ... } Forwards a tools/call to the configured MCP server and returns its raw result. Subagents call this from their shell tool via curl — there is no Ruby-side bridge tool anymore.



3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
 
# File 'lib/clacky/server/http_server.rb', line 3508

def api_mcp_call(name, req, res)
  unless mcp_registry.configured?(name)
    json_response(res, 404, { ok: false, error: "MCP server '#{name}' not found in mcp.json" })
    return
  end

  body = parse_json_body(req) || {}
  tool = body["tool"] || body[:tool]
  arguments = body["arguments"] || body[:arguments] || {}

  if tool.nil? || tool.to_s.strip.empty?
    json_response(res, 400, { ok: false, error: "missing required field: tool" })
    return
  end

  result = mcp_registry.call_tool(name, tool, arguments)
  json_response(res, 200, { ok: true, result: result })
rescue Clacky::Mcp::Client::McpError, Clacky::Mcp::Client::TransportError => e
  json_response(res, 502, { ok: false, error: e.message })
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_mcp_create(req, res) ⇒ Object

POST /api/mcp { name, command, args, env{}, cwd?, description? }



3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
 
# File 'lib/clacky/server/http_server.rb', line 3593

def api_mcp_create(req, res)
  return unless mcp_localhost_only(req, res)

  body = parse_json_body(req)
  name, spec, err = mcp_validate_spec(body)
  if err
    json_response(res, 400, { ok: false, error: err })
    return
  end

  data = mcp_load_raw_config
  if data["mcpServers"].key?(name)
    json_response(res, 409, { ok: false, error: "MCP server '#{name}' already exists. Use PUT to update." })
    return
  end

  data["mcpServers"][name] = spec
  mcp_write_raw_config(data)
  @mcp_registry_mutex.synchronize { @mcp_registry&.reload }
  json_response(res, 200, { ok: true, name: name, config_path: mcp_config_path })
end

#api_mcp_delete(name, req, res) ⇒ Object

DELETE /api/mcp/:name



3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
 
# File 'lib/clacky/server/http_server.rb', line 3640

def api_mcp_delete(name, req, res)
  return unless mcp_localhost_only(req, res)

  data = mcp_load_raw_config
  unless data["mcpServers"].key?(name)
    json_response(res, 404, { ok: false, error: "MCP server '#{name}' not found" })
    return
  end

  data["mcpServers"].delete(name)
  mcp_write_raw_config(data)
  @mcp_registry_mutex.synchronize { @mcp_registry&.reload }
  json_response(res, 200, { ok: true, name: name })
end

#api_mcp_list(res) ⇒ Object

GET /api/mcp Lists configured MCP servers without spawning any subprocess. Honors both ~/.clacky/mcp.json (global) and project-level overrides.



3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
 
# File 'lib/clacky/server/http_server.rb', line 3421

def api_mcp_list(res)
  data = mcp_load_raw_config
  servers = (data["mcpServers"] || {}).map do |name, spec|
    next nil unless spec.is_a?(Hash)

    type = (spec["type"] || (spec["url"] ? "http" : "stdio")).to_s
    {
      name:        name.to_s,
      type:        type,
      description: spec["description"] || "",
      command:     spec["command"],
      args:        Array(spec["args"]),
      url:         spec["url"],
      disabled:    spec["disabled"] == true,
      has_env:     spec["env"].is_a?(Hash) && !spec["env"].empty?,
      has_headers: spec["headers"].is_a?(Hash) && !spec["headers"].empty?,
    }
  end.compact

  json_response(res, 200, {
    configured:    !servers.empty?,
    config_path:   mcp_config_path,
    config_exists: File.exist?(mcp_config_path),
    servers:       servers,
  })
end

#api_mcp_probe(name, res) ⇒ Object

POST /api/mcp/:name/probe Spawns the MCP server briefly to fetch its tool catalog, then shuts it down. Used by the WebUI to display each server's tool list on demand. No state survives the request — the next agent run does its own lazy spawn.



3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
 
# File 'lib/clacky/server/http_server.rb', line 3452

def api_mcp_probe(name, res)
  registry = Clacky::Mcp::Registry.new(idle_timeout: 0)
  unless registry.configured?(name)
    json_response(res, 404, { ok: false, error: "MCP server '#{name}' not found in mcp.json" })
    return
  end

  tools = registry.tool_definitions(name).map do |defn|
    fn = defn[:function] || defn["function"] || {}
    {
      name:         fn[:name] || fn["name"],
      description:  fn[:description] || fn["description"] || "",
      input_schema: fn[:parameters] || fn["parameters"] || {},
    }
  end

  json_response(res, 200, { ok: true, name: name, tools: tools, tool_count: tools.length })
rescue Clacky::Mcp::Client::McpError, Clacky::Mcp::Client::TransportError => e
  json_response(res, 502, { ok: false, error: e.message })
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
ensure
  registry&.shutdown
end

#api_mcp_toggle(name, req, res) ⇒ Object

PATCH /api/mcp/:name/enabled body: { enabled: true|false }



3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
 
# File 'lib/clacky/server/http_server.rb', line 3656

def api_mcp_toggle(name, req, res)
  return unless mcp_localhost_only(req, res)

  body = parse_json_body(req) || {}
  enabled = body["enabled"]
  if enabled.nil? || ![true, false].include?(enabled)
    json_response(res, 400, { ok: false, error: "enabled (boolean) is required" })
    return
  end

  data = mcp_load_raw_config
  spec = data["mcpServers"][name]
  unless spec.is_a?(Hash)
    json_response(res, 404, { ok: false, error: "MCP server '#{name}' not found" })
    return
  end

  if enabled
    spec.delete("disabled")
  else
    spec["disabled"] = true
  end
  mcp_write_raw_config(data)

  @mcp_registry_mutex.synchronize { @mcp_registry&.reload }

  json_response(res, 200, { ok: true, name: name, disabled: spec["disabled"] == true })
end

#api_mcp_tools(name, res) ⇒ Object

GET /api/mcp/:name/tools Returns the live tool catalog for an MCP server, using the process-wide registry. The first call cold-starts the server; later calls hit cache. Subagents use this as a discovery endpoint, replacing the deleted mcp_call tool's hidden tool list.



3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
 
# File 'lib/clacky/server/http_server.rb', line 3482

def api_mcp_tools(name, res)
  unless mcp_registry.configured?(name)
    json_response(res, 404, { ok: false, error: "MCP server '#{name}' not found in mcp.json" })
    return
  end

  tools = mcp_registry.tool_definitions(name).map do |defn|
    fn = defn[:function] || defn["function"] || {}
    {
      name:         fn[:name] || fn["name"],
      description:  fn[:description] || fn["description"] || "",
      input_schema: fn[:parameters] || fn["parameters"] || {},
    }
  end

  json_response(res, 200, { ok: true, name: name, tools: tools, tool_count: tools.length })
rescue Clacky::Mcp::Client::McpError, Clacky::Mcp::Client::TransportError => e
  json_response(res, 502, { ok: false, error: e.message })
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_mcp_update(name, req, res) ⇒ Object

PUT /api/mcp/:name { command, args, env{}, cwd?, description? } Replaces the entire spec. Path :name wins over body name.



3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
 
# File 'lib/clacky/server/http_server.rb', line 3617

def api_mcp_update(name, req, res)
  return unless mcp_localhost_only(req, res)

  body = parse_json_body(req).merge("name" => name)
  _, spec, err = mcp_validate_spec(body)
  if err
    json_response(res, 400, { ok: false, error: err })
    return
  end

  data = mcp_load_raw_config
  unless data["mcpServers"].key?(name)
    json_response(res, 404, { ok: false, error: "MCP server '#{name}' not found" })
    return
  end

  data["mcpServers"][name] = spec
  mcp_write_raw_config(data)
  @mcp_registry_mutex.synchronize { @mcp_registry&.reload }
  json_response(res, 200, { ok: true, name: name })
end

#api_media_audio_speech(req, res) ⇒ Object 



1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
 
# File 'lib/clacky/server/http_server.rb', line 1598

def api_media_audio_speech(req, res)
  body = parse_json_body(req)
  return json_response(res, 400, { error: "Invalid JSON" }) unless body

  input = body["input"].to_s
  if input.strip.empty?
    return json_response(res, 422, { error: "input is required" })
  end

  voice      = body["voice"]
  output_dir = body["output_dir"].to_s
  output_dir = @agent_config.default_working_dir || Dir.pwd if output_dir.empty?

  session_id = body["session_id"].to_s
  session_id = nil if session_id.empty?

  result = Clacky::Media::Generator.new(@agent_config).generate_speech(
    input: input,
    voice: voice,
    output_dir: output_dir
  )
  if result["success"]
    log_media_usage(result, prompt: input, session_id: session_id)
  end
  status = result["success"] ? 200 : 422
  json_response(res, status, result)
rescue StandardError => e
  json_response(res, 500, { error: e.message })
end

#api_media_audio_transcriptions(req, res) ⇒ Object 



1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
 
# File 'lib/clacky/server/http_server.rb', line 1628

def api_media_audio_transcriptions(req, res)
  body = parse_json_body(req)
  return json_response(res, 400, { error: "Invalid JSON" }) unless body

  audio_b64 = body["audio_base64"].to_s
  if audio_b64.empty?
    return json_response(res, 422, { error: "audio_base64 is required" })
  end

  mime_type = body["mime_type"].to_s
  mime_type = "audio/webm" if mime_type.empty?

  result = Clacky::Media::Generator.new(@agent_config).generate_transcription(
    audio_base64: audio_b64,
    mime_type: mime_type
  )
  if result["success"]
    Clacky::Logger.info("[Media] stt generated model=#{result["model"]} provider=#{result["provider"]} cost_usd=#{result["cost_usd"].to_f}")
  end
  status = result["success"] ? 200 : 422
  json_response(res, status, result)
rescue StandardError => e
  json_response(res, 500, { error: e.message })
end

#api_media_image(req, res) ⇒ Object

POST /api/media/image Body: { "prompt": "...", "aspect_ratio": "landscape|square|portrait", "output_dir": "<absolute path, optional>" } Routes to the model configured with type=image in agent_config.



1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
 
# File 'lib/clacky/server/http_server.rb', line 1502

def api_media_image(req, res)
  body = parse_json_body(req)
  return json_response(res, 400, { error: "Invalid JSON" }) unless body

  prompt = body["prompt"].to_s
  if prompt.strip.empty?
    return json_response(res, 422, { error: "prompt is required" })
  end

  aspect_ratio = body["aspect_ratio"].to_s
  aspect_ratio = "landscape" if aspect_ratio.empty?
  output_dir   = body["output_dir"].to_s
  output_dir   = @agent_config.default_working_dir || Dir.pwd if output_dir.empty?

  session_id = body["session_id"].to_s
  session_id = nil if session_id.empty?

  result = Clacky::Media::Generator.new(@agent_config).generate_image(
    prompt: prompt,
    aspect_ratio: aspect_ratio,
    output_dir: output_dir,
    image: body["image"],
    images: body["images"]
  )
  if result["success"]
    log_media_usage(result, prompt: prompt, session_id: session_id)
  end
  status = result["success"] ? 200 : 422
  json_response(res, status, result)
rescue StandardError => e
  json_response(res, 500, { error: e.message })
end

#api_media_types(res) ⇒ Object

GET /api/media/types Returns which media types are configured in agent_config.models. Used by the media-gen skill to decide whether to surface generation capabilities to the user.



1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
 
# File 'lib/clacky/server/http_server.rb', line 1722

def api_media_types(res)
  out = {}
  Clacky::Providers::MEDIA_KINDS.each do |t|
    state = @agent_config.media_state(t)
    out[t] =
      if state["configured"]
        {
          configured: true,
          model:      state["model"],
          base_url:   state["base_url"],
          source:     state["source"]
        }
      else
        { configured: false, source: "off" }
      end
  end
  json_response(res, 200, out)
end

#api_media_video(req, res) ⇒ Object 



1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
 
# File 'lib/clacky/server/http_server.rb', line 1535

def api_media_video(req, res)
  body = parse_json_body(req)
  return json_response(res, 400, { error: "Invalid JSON" }) unless body

  prompt = body["prompt"].to_s
  if prompt.strip.empty?
    return json_response(res, 422, { error: "prompt is required" })
  end

  aspect_ratio = body["aspect_ratio"].to_s
  aspect_ratio = "landscape" if aspect_ratio.empty?
  duration     = body["duration_seconds"]
  image        = body["image"]
  output_dir   = body["output_dir"].to_s
  output_dir   = @agent_config.default_working_dir || Dir.pwd if output_dir.empty?

  session_id = body["session_id"].to_s
  session_id = nil if session_id.empty?

  result = Clacky::Media::Generator.new(@agent_config).generate_video(
    prompt: prompt,
    aspect_ratio: aspect_ratio,
    duration_seconds: duration,
    output_dir: output_dir,
    image: image,
    first_frame: body["first_frame"],
    last_frame: body["last_frame"],
    reference_images: body["reference_images"],
    reference_videos: body["reference_videos"],
    reference_audios: body["reference_audios"],
    resolution: body["resolution"],
    generate_audio: body["generate_audio"],
    watermark: body["watermark"],
    seed: body["seed"]
  )
  if result["success"]
    log_media_usage(result, prompt: prompt, session_id: session_id)
  end
  status = result["success"] ? 200 : 422
  json_response(res, status, result)
rescue StandardError => e
  json_response(res, 500, { error: e.message })
end

#api_media_video_status(req, res) ⇒ Object 



1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
 
# File 'lib/clacky/server/http_server.rb', line 1579

def api_media_video_status(req, res)
  query   = URI.decode_www_form(req.query_string.to_s).to_h
  task_id = query["task_id"].to_s
  if task_id.strip.empty?
    return json_response(res, 422, { error: "task_id is required" })
  end

  output_dir = query["output_dir"].to_s
  output_dir = @agent_config.default_working_dir || Dir.pwd if output_dir.empty?

  result = Clacky::Media::Generator.new(@agent_config).video_status(
    task_id: task_id,
    output_dir: output_dir
  )
  json_response(res, 200, result)
rescue StandardError => e
  json_response(res, 500, { error: e.message })
end

#api_media_video_understand(req, res) ⇒ Object 



1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/clacky/server/http_server.rb', line 1653

def api_media_video_understand(req, res)
  body = parse_json_body(req)
  return json_response(res, 400, { error: "Invalid JSON" }) unless body

  video_b64 = body["video_base64"].to_s
  if video_b64.empty?
    return json_response(res, 422, { error: "video_base64 is required" })
  end

  mime_type = body["mime_type"].to_s
  mime_type = "image/png" if mime_type.empty?

  prompt = body["prompt"].to_s

  result = Clacky::Media::Generator.new(@agent_config).understand_video(
    video_base64: video_b64,
    mime_type: mime_type,
    prompt: prompt
  )
  if result["success"]
    Clacky::Logger.info("[Media] video_understanding generated model=#{result["model"]} provider=#{result["provider"]} cost_usd=#{result["cost_usd"].to_f}")
  end
  status = result["success"] ? 200 : 422
  json_response(res, status, result)
rescue StandardError => e
  json_response(res, 500, { error: e.message })
end

#api_onboard_complete(req, res) ⇒ Object

POST /api/onboard/complete Called after key setup is done (soul_setup is optional/skipped). Creates the default session if none exists yet, returns it.



2094
2095
2096
2097
2098
 
# File 'lib/clacky/server/http_server.rb', line 2094

def api_onboard_complete(req, res)
  create_default_session if @registry.list(limit: 1).empty?
  first_session = @registry.list(limit: 1).first
  json_response(res, 200, { ok: true, session: first_session })
end

#api_onboard_device_poll(req, res) ⇒ Object

POST /api/onboard/device/poll { device_code } Polls the platform once. While pending, returns { status: "pending" }. On approval, persists the issued key into agent_config and returns { status: "approved" } so the frontend can proceed to the onboard session.



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'lib/clacky/server/http_server.rb', line 1018

def api_onboard_device_poll(req, res)
  body        = parse_json_body(req) || {}
  device_code = body["device_code"].to_s
  if device_code.empty?
    return json_response(res, 422, { ok: false, error: "device_code is required" })
  end

  client = Clacky::PlatformHttpClient.new
  result = client.post("/api/v1/device/token", { device_code: device_code })
  data   = result[:data] || {}
  status = data["status"]

  if result[:success] && status == "approved"
    persist_onboard_model(
      api_key:  data["api_key"],
      base_url: data["base_url"],
      model:    data["default_model"]
    ) if data["api_key"]
    if data["device_token"]
      Clacky::Identity.load.bind!(
        device_token: data["device_token"],
        user_id:      data["user_id"]
      )
    end
    json_response(res, 200, {
      ok:            true,
      status:        "approved",
      default_model: data["default_model"]
    })
  elsif status == "pending"
    json_response(res, 200, { ok: true, status: "pending" })
  else
    # denied / expired / consumed / network error — surface to the client.
    json_response(res, 200, {
      ok:     false,
      status: status || "error",
      error:  result[:error]
    })
  end
end

#api_onboard_device_start(req, res) ⇒ Object

POST /api/onboard/device/start Kicks off a device-authorization flow against the platform. Returns the device_code (held by the client for polling) plus the user-facing verification URL the browser should open.



992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'lib/clacky/server/http_server.rb', line 992

def api_onboard_device_start(req, res)
  client = Clacky::PlatformHttpClient.new
  result = client.post("/api/v1/device/authorize", {
    device_id:   onboard_device_id,
    device_info: { os: RUBY_PLATFORM, hostname: Socket.gethostname, app_version: Clacky::VERSION }
  })

  if result[:success]
    data = result[:data]
    json_response(res, 200, {
      ok:                        true,
      device_code:               data["device_code"],
      user_code:                 data["user_code"],
      verification_uri:          data["verification_uri"],
      verification_uri_complete: data["verification_uri_complete"],
      interval:                  data["interval"] || 5
    })
  else
    json_response(res, 502, { ok: false, error: result[:error] })
  end
end

#api_onboard_skip_soul(req, res) ⇒ Object

POST /api/onboard/skip-soul Writes a minimal SOUL.md so the soul_setup phase is not re-triggered on the next server start when the user chooses to skip the conversation.



2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
 
# File 'lib/clacky/server/http_server.rb', line 2103

def api_onboard_skip_soul(req, res)
  body = parse_json_body(req)
  lang = body["lang"].to_s.strip
  soul_content = lang == "zh" ? DEFAULT_SOUL_MD_ZH : DEFAULT_SOUL_MD

  agents_dir = File.expand_path("~/.clacky/agents")
  FileUtils.mkdir_p(agents_dir)
  soul_path = File.join(agents_dir, "SOUL.md")
  unless File.exist?(soul_path)
    File.write(soul_path, soul_content)
  end
  json_response(res, 200, { ok: true })
end

#api_onboard_status(res) ⇒ Object

GET /api/onboard/status Phase "key_setup" → no API key configured yet Phase "soul_setup" → key configured, but ~/.clacky/agents/SOUL.md missing needs_onboard: false → fully set up branded: true → running under a brand; hide the OpenClacky AI Keys block



979
980
981
982
983
984
985
986
 
# File 'lib/clacky/server/http_server.rb', line 979

def api_onboard_status(res)
  branded = Clacky::BrandConfig.load.branded?
  if !@agent_config.models_configured?
    json_response(res, 200, { needs_onboard: true, phase: "key_setup", branded: branded })
  else
    json_response(res, 200, { needs_onboard: false, branded: branded })
  end
end

#api_rename_session(session_id, req, res) ⇒ Object 



5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
 
# File 'lib/clacky/server/http_server.rb', line 5883

def api_rename_session(session_id, req, res)
  body = parse_json_body(req)
  new_name = body["name"]&.to_s&.strip
  pinned = body["pinned"]

  return json_response(res, 404, { error: "Session not found" }) unless @registry.ensure(session_id)

  agent = nil
  @registry.with_session(session_id) { |s| agent = s[:agent] }
  
  # Update name if provided
  if new_name && !new_name.empty?
    agent.rename(new_name)
  end
  
  # Update pinned status if provided
  if !pinned.nil?
    agent.pinned = pinned
  end
  
  # Save session data
  @session_manager.save(agent.to_session_data)
  
  # Broadcast update event
  update_data = { type: "session_updated", session_id: session_id }
  update_data[:name] = new_name if new_name && !new_name.empty?
  update_data[:pinned] = pinned unless pinned.nil?
  broadcast(session_id, update_data)
  
  response_data = { ok: true }
  response_data[:name] = new_name if new_name && !new_name.empty?
  response_data[:pinned] = pinned unless pinned.nil?
  json_response(res, 200, response_data)
rescue => e
  json_response(res, 500, { error: e.message })
end

#api_restart(req, res) ⇒ Object

POST /api/restart Re-execs the current process so the newly installed gem version is loaded. Uses the absolute script path captured at startup to avoid relative-path issues. Responds 200 first, then waits briefly for WEBrick to flush the response before exec.



3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
 
# File 'lib/clacky/server/http_server.rb', line 3256

def api_restart(req, res)
  json_response(res, 200, { ok: true, message: "Restarting…" })

  Thread.new do
    sleep 0.5  # Let WEBrick flush the HTTP response

    if @master_pid
      # Worker mode: tell master to hot-restart. Master will TERM us after the
      # new worker boots; our trap("TERM") then runs shutdown_proc, which detaches
      # the inherited listen socket before WEBrick shutdown. Do NOT exit(0) here —
      # that bypasses trap handlers and lets the OS close(fd) on a socket shared
      # with master+new worker, corrupting the listener on Linux/WSL.
      Clacky::Logger.info("[Restart] Sending USR1 to master (PID=#{@master_pid})")
      begin
        Process.kill("USR1", @master_pid)
      rescue Errno::ESRCH
        Clacky::Logger.warn("[Restart] Master PID=#{@master_pid} not found, falling back to exec.")
        standalone_exec_restart
      end
    else
      # Standalone mode (no master): fall back to the original exec approach.
      standalone_exec_restart
    end
  end
end

#api_run_cron_task(name, res) ⇒ Object

POST /api/cron-tasks/:name/run — execute immediately



4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
 
# File 'lib/clacky/server/http_server.rb', line 4174

def api_run_cron_task(name, res)
  unless @scheduler.list_tasks.include?(name)
    return json_response(res, 404, { error: "Cron task not found: #{name}" })
  end

  prompt       = @scheduler.read_task(name)
  session_name = "▶ #{name} #{Time.now.strftime("%H:%M")}"
  working_dir  = File.expand_path("~/clacky_workspace")
  FileUtils.mkdir_p(working_dir)

  session_id = build_session(name: session_name, working_dir: working_dir, permission_mode: :auto_approve)
  @registry.update(session_id, pending_task: prompt, pending_working_dir: working_dir)

  json_response(res, 202, { ok: true, session: @registry.session_summary(session_id) })
rescue => e
  json_response(res, 422, { error: e.message })
end

#api_save_channel(platform, req, res) ⇒ Object

POST /api/channels/:platform Body: { fields... } (platform-specific credential fields) Saves credentials and optionally (re)starts the adapter.



3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
 
# File 'lib/clacky/server/http_server.rb', line 3905

def api_save_channel(platform, req, res)
  platform = platform.to_sym
  body     = parse_json_body(req)
  config   = Clacky::ChannelConfig.load

  fields = body.transform_keys(&:to_sym).reject { |k, _| k == :platform }
  fields = fields.transform_values { |v| v.is_a?(String) ? v.strip : v }

  # Record when the token was last updated so clients can detect re-login
  fields[:token_updated_at] = Time.now.to_i if platform == :weixin && fields.key?(:token)
  fields[:token_updated_at] = Time.now.to_i if platform == :discord && fields.key?(:bot_token)

  # Validate credentials against live API before persisting.
  # Merge with existing config so partial updates (e.g. allowed_users only) still validate correctly.
  klass = Clacky::Channel::Adapters.find(platform)
  if klass && klass.respond_to?(:test_connection)
    existing = config.platform_config(platform) || {}
    merged   = existing.merge(fields)
    result   = klass.test_connection(merged)
    unless result[:ok]
      json_response(res, 422, { ok: false, error: result[:error] || "Credential validation failed" })
      return
    end
  end

  config.set_platform(platform, **fields)
  config.save

  # Hot-reload: stop existing adapter for this platform (if running) and restart
  @channel_manager.reload_platform(platform, config)

  json_response(res, 200, { ok: true })
rescue StandardError => e
  json_response(res, 422, { ok: false, error: e.message })
end

#api_send_channel_message(platform, req, res) ⇒ Object

POST /api/channels/:platform/send Proactively send a message to a user via the given IM platform.

Body:

{ "message": "hello",            # required
"user_id": "some_user_id" }    # optional — defaults to most-recently active user

Response:

200 { ok: true }
400 { ok: false, error: "..." }  — missing/invalid params or platform not running
503 { ok: false, error: "..." }  — no known users (nobody has messaged the bot yet)

Constraints:

- The platform adapter must be running (channel must be enabled + connected).
- For Weixin (iLink protocol), a context_token is required per message. This is
automatically looked up from the in-memory cache populated by inbound messages.
If no token exists for the target user (i.e. the user has never messaged the bot
in this server session), the message cannot be delivered.


3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
 
# File 'lib/clacky/server/http_server.rb', line 3703

def api_send_channel_message(platform, req, res)
  platform = platform.to_sym
  body     = parse_json_body(req)
  message  = body["message"].to_s.strip

  if message.empty?
    json_response(res, 400, { ok: false, error: "message is required" })
    return
  end

  # Resolve target user_id
  user_id = body["user_id"].to_s.strip
  if user_id.empty?
    # Default to the most-recently active user for this platform
    known = @channel_manager.known_users(platform)
    if known.empty?
      json_response(res, 503, {
        ok:    false,
        error: "No known users for :#{platform}. The user must send a message to the bot first."
      })
      return
    end
    user_id = known.last
  end

  result = @channel_manager.send_to_user(platform, user_id, message)
  if result.nil?
    json_response(res, 400, {
      ok:    false,
      error: "Failed to send message. The :#{platform} adapter may not be running, or no context_token is available for user #{user_id}."
    })
  else
    json_response(res, 200, { ok: true, platform: platform, user_id: user_id })
  end
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_serve_local_image(req, res) ⇒ Object

GET /api/local-image?path=file:///path/to/image.png GET /api/local-image?path=/path/to/image.png

Serves a local image file with the correct Content-Type. Used by the Web UI to render local images that would otherwise be blocked by the browser's security policy (file:// from http:// origin).



3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
 
# File 'lib/clacky/server/http_server.rb', line 3846

def api_serve_local_image(req, res)
  raw_path = URI.decode_www_form(req.query_string.to_s).to_h["path"].to_s
  return json_response(res, 400, { error: "path is required" }) if raw_path.empty?

  # Strip file://, decode, WSL drive-letter normalize, then expand — in
  # this order (normalize must precede expand_path). No-op on macOS/Linux.
  path = Utils::EnvironmentDetector.resolve_local_path(raw_path)

  # Security: only serve media files (images + videos)
  ext = File.extname(path).downcase
  unless Utils::FileProcessor::LOCAL_MEDIA_EXTENSIONS.include?(ext)
    return json_response(res, 403, { error: "not a supported media file" })
  end

  return json_response(res, 404, { error: "file not found" }) unless File.exist?(path)

  file_size = File.size(path)
  mime = Utils::FileProcessor::MIME_TYPES[ext] || "application/octet-stream"

  # ETag from mtime+size so an overwritten same-name file invalidates the
  # browser cache. Use no-cache (revalidate every time) rather than
  # max-age: unchanged files return 304 (no body), changed files return
  # the new bytes.
  stat = File.stat(path)
  etag = %(W/"#{stat.mtime.to_i}-#{stat.size}")
  res["Cache-Control"] = "private, no-cache"
  res["ETag"] = etag
  if req["If-None-Match"] == etag
    res.status = 304
    res.body = ""
    return
  end

  # Support HTTP Range requests for video seeking
  range_header = req["Range"]
  if range_header && range_header =~ /\Abytes=(\d*)-(\d*)\z/
    start_byte = ($1.empty? ? 0 : $1.to_i)
    end_byte   = ($2.empty? ? file_size - 1 : $2.to_i)
    end_byte   = [end_byte, file_size - 1].min

    res.status = 206
    res["Content-Type"]  = mime
    res["Content-Range"] = "bytes #{start_byte}-#{end_byte}/#{file_size}"
    res["Accept-Ranges"] = "bytes"
    res["Content-Length"] = (end_byte - start_byte + 1).to_s
    IO.binread(path, end_byte - start_byte + 1, start_byte).then { |data| res.body = data }
  else
    res.status         = 200
    res["Content-Type"] = mime
    res["Accept-Ranges"] = "bytes"
    res.body = File.binread(path)
  end
rescue => e
  json_response(res, 500, { error: e.message })
end

#api_session_files(session_id, req, res) ⇒ Object 



4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
 
# File 'lib/clacky/server/http_server.rb', line 4459

def api_session_files(session_id, req, res)
  unless @registry.ensure(session_id)
    return json_response(res, 404, { error: "Session not found" })
  end
  session = @registry.get(session_id)
  agent   = session && session[:agent]
  return json_response(res, 404, { error: "Session not found" }) unless agent

  root = File.expand_path(agent.working_dir.to_s)
  return json_response(res, 404, { error: "Working directory not found" }) unless Dir.exist?(root)

  query = URI.decode_www_form(req.query_string.to_s).to_h
  rel = query["path"].to_s
  absolute_mode = query["absolute"] == "true"
  show_hidden = query["show_hidden"] == "true"

  # Absolute mode: allow browsing outside working directory (e.g., root "/")
  if absolute_mode
    target = File.expand_path(rel.empty? ? "/" : rel)
    display_root = target
    # Normalize rel for API response
    rel = target
  else
    rel = rel.sub(%r{\A/+}, "").strip
    target = File.expand_path(File.join(root, rel))
    display_root = root

    # Reject traversal outside the working directory.
    unless target == root || target.start_with?("#{root}/")
      return json_response(res, 403, { error: "Path outside working directory" })
    end
  end

  return json_response(res, 404, { error: "Directory not found" }) unless Dir.exist?(target)
  entries = Dir.children(target).reject do |name|
    IGNORED_FILE_ENTRIES.include?(name) || (!show_hidden && name.start_with?("."))
  end

  items = entries.filter_map do |name|
    full = File.join(target, name)
    is_dir = File.directory?(full)
    # Skip symlinks pointing outside the root, and anything unreadable.
    next unless File.exist?(full)
    {
      name:  name,
      path:  "#{rel}/#{name}".gsub(%r{/+}, "/"),
      type:  is_dir ? "dir" : "file",
      size:  is_dir ? nil : (File.size(full) rescue nil)
    }
  rescue StandardError
    nil
  end

  # Directories first, then files; both case-insensitive alphabetical.
  items.sort_by! { |it| [it[:type] == "dir" ? 0 : 1, it[:name].downcase] }

  json_response(res, 200, { root: display_root, path: rel, home: Dir.home, default: default_working_dir, entries: items })
rescue StandardError => e
  json_response(res, 500, { error: e.message })
end

#api_session_git(session_id, action, req, res) ⇒ Object

working_dir. action ∈ status|diff|log|branches. diff accepts ?file=, log accepts ?limit=.



4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
 
# File 'lib/clacky/server/http_server.rb', line 4317

def api_session_git(session_id, action, req, res)
  dir = git_session_dir(session_id, res)
  return unless dir

  unless Clacky::Server::GitPanel.repo?(dir)
    return json_response(res, 200, { repo: false })
  end

  query = URI.decode_www_form(req.query_string.to_s).to_h
  case action
  when "status"
    json_response(res, 200, { repo: true }.merge(Clacky::Server::GitPanel.status(dir)))
  when "diff"
    json_response(res, 200, { repo: true, diff: Clacky::Server::GitPanel.diff(dir, file: query["file"]) })
  when "log"
    json_response(res, 200, { repo: true, commits: Clacky::Server::GitPanel.log(dir, limit: query["limit"] || 50) })
  when "branches"
    json_response(res, 200, { repo: true, branches: Clacky::Server::GitPanel.branches(dir) })
  else
    json_response(res, 404, { error: "Unknown git action" })
  end
end

#api_session_git_commit(session_id, req, res) ⇒ Object

POST /api/sessions/:id/git/commit — body: { message:, files: [..] }.



4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
 
# File 'lib/clacky/server/http_server.rb', line 4341

def api_session_git_commit(session_id, req, res)
  dir = git_session_dir(session_id, res)
  return unless dir

  unless Clacky::Server::GitPanel.repo?(dir)
    return json_response(res, 400, { error: "Not a git repository" })
  end

  body = parse_json_body(req)
  result = Clacky::Server::GitPanel.commit(dir, message: body["message"], files: body["files"])
  if result[:ok]
    json_response(res, 200, result)
  else
    json_response(res, 422, { error: result[:error] })
  end
end

#api_session_messages(session_id, req, res) ⇒ Object

GET /api/sessions/:id/messages?limit=20&before=1709123456.789 Replays conversation history for a session via the agent's replay_history method. Returns a list of UI events (same format as WS events) for the frontend to render.



5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
 
# File 'lib/clacky/server/http_server.rb', line 5856

def api_session_messages(session_id, req, res)
  unless @registry.ensure(session_id)
    Clacky::Logger.warn("[messages] registry.ensure failed", session_id: session_id)
    return json_response(res, 404, { error: "Session not found" })
  end

  # Parse query params
  query   = URI.decode_www_form(req.query_string.to_s).to_h
  limit   = [query["limit"].to_i.then { |n| n > 0 ? n : 20 }, 100].min
  before  = query["before"]&.to_f

  agent = nil
  @registry.with_session(session_id) { |s| agent = s[:agent] }

  unless agent
    Clacky::Logger.warn("[messages] agent is nil", session_id: session_id)
    return json_response(res, 200, { events: [], has_more: false })
  end

  # Collect events emitted by replay_history via a lightweight collector UI
  collected = []
  collector = HistoryCollector.new(session_id, collected)
  result    = agent.replay_history(collector, limit: limit, before: before)

  json_response(res, 200, { events: collected, has_more: result[:has_more] })
end

#api_session_skills(session_id, res) ⇒ Object

GET /api/sessions/:id/skills — list user-invocable skills for a session, filtered by the session's agent profile. Used by the frontend slash-command autocomplete so only skills valid for the current profile are suggested.



4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
 
# File 'lib/clacky/server/http_server.rb', line 4243

def api_session_skills(session_id, res)
  unless @registry.ensure(session_id)
    json_response(res, 404, { error: "Session not found" })
    return
  end
  session = @registry.get(session_id)
  unless session
    json_response(res, 404, { error: "Session not found" })
    return
  end

  agent = session[:agent]
  unless agent
    json_response(res, 404, { error: "Agent not found" })
    return
  end

  agent.skill_loader.load_all
  profile = agent.agent_profile

  skills = agent.skill_loader.user_invocable_skills
  skills = skills.select { |s| s.allowed_for_agent?(profile.name) } if profile

  loader      = agent.skill_loader
  loaded_from = loader.loaded_from

            skill_data = skills.map do |skill|
    source_type = loaded_from[skill.identifier]
    {
      name:           skill.identifier,
      name_zh:        skill.name_zh,
      description:    skill.description || skill.context_description,
      description_zh: skill.description_zh,
      encrypted:      skill.encrypted?,
      source_type:    source_type,
      always_show:    skill.always_show
    }
  end

  json_response(res, 200, { skills: skill_data })
end

#api_session_time_machine(session_id, res) ⇒ Object

GET /api/sessions/:id/time_machine — task history for the Time Machine panel. Mirrors the CLI menu: each entry carries id, summary, status (current/past/undone) and whether it branches.



4361
4362
4363
4364
4365
4366
4367
 
# File 'lib/clacky/server/http_server.rb', line 4361

def api_session_time_machine(session_id, res)
  agent = time_machine_agent(session_id, res)
  return unless agent

  history = agent.get_task_history(limit: 20)
  json_response(res, 200, { tasks: history })
end

#api_session_time_machine_diff(session_id, task_id, req, res) ⇒ Object

GET /api/sessions/:id/time_machine/:task_id/diff Without ?path: returns the file list this task touched. With ?path=: returns the unified diff of that file.



4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
 
# File 'lib/clacky/server/http_server.rb', line 4390

def api_session_time_machine_diff(session_id, task_id, req, res)
  agent = time_machine_agent(session_id, res)
  return unless agent

  rel = req.query["path"].to_s
  if rel.empty?
    json_response(res, 200, { ok: true, task_id: task_id, files: agent.task_diff_files(task_id) })
  else
    diff = agent.task_file_diff(task_id, rel)
    if diff.nil?
      json_response(res, 404, { ok: false, error: "No diff for #{rel}" })
    else
      json_response(res, 200, { ok: true, task_id: task_id }.merge(diff))
    end
  end
end

#api_session_time_machine_restore_preview(session_id, task_id, res) ⇒ Object

GET /api/sessions/:id/time_machine/:task_id/restore_preview Returns the file-level effect of switching back to this task without actually performing the switch. Lets the UI render an honest confirmation listing the files that would be overwritten/created/deleted.



4411
4412
4413
4414
4415
4416
4417
 
# File 'lib/clacky/server/http_server.rb', line 4411

def api_session_time_machine_restore_preview(session_id, task_id, res)
  agent = time_machine_agent(session_id, res)
  return unless agent

  changes = agent.preview_restore_to_task(task_id)
  json_response(res, 200, { ok: true, task_id: task_id, changes: changes })
end

#api_session_time_machine_switch(session_id, req, res) ⇒ Object

POST /api/sessions/:id/time_machine/switch — body: { task_id: }. Restores the working tree to the end-of-task state of task_id.



4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
 
# File 'lib/clacky/server/http_server.rb', line 4371

def api_session_time_machine_switch(session_id, req, res)
  agent = time_machine_agent(session_id, res)
  return unless agent

  body = parse_json_body(req)
  task_id = body["task_id"].to_i
  result = agent.switch_to_task(task_id)
  if result[:success]
    @session_manager.save(agent.to_session_data(status: :success))
    broadcast_session_update(session_id)
    json_response(res, 200, { ok: true, message: result[:message], task_id: result[:task_id] })
  else
    json_response(res, 422, { ok: false, error: result[:message] })
  end
end

#api_set_default_model(id, res) ⇒ Object

POST /api/config/models/:id/default Makes the identified model the new "default" (global initial model for new sessions AND current model for this server instance).



5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
 
# File 'lib/clacky/server/http_server.rb', line 5757

def api_set_default_model(id, res)
  ok = @agent_config.set_default_model_by_id(id)
  return json_response(res, 404, { error: "model not found" }) unless ok

  @agent_config.current_model_id    = id
  @agent_config.current_model_index = @agent_config.models.find_index { |m| m["id"] == id } || 0
  @agent_config.save
  json_response(res, 200, { ok: true })
rescue => e
  json_response(res, 422, { error: e.message })
end

#api_store_extension_detail(req, res) ⇒ Object

GET /api/store/extension?id=[&source=brand]

Detail for a single extension. Pass source=brand to query brand-private extensions via the license-gated API; omit (or any other value) for the public marketplace API.



2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
 
# File 'lib/clacky/server/http_server.rb', line 2563

def api_store_extension_detail(req, res)
  id = req.query["id"].to_s
  if id.strip.empty?
    json_response(res, 400, { ok: false, error: "Missing id." })
    return
  end

  brand  = Clacky::BrandConfig.load
  result = if req.query["source"] == "brand"
    brand.brand_extension_detail!(id)
  else
    brand.extension_detail!(id)
  end

  if result[:success] && result[:extension]
    ext  = result[:extension]
    slug = ext["name"] || ext[:name] || ext["slug"] || ext[:slug]
    container = extension_container(slug)
    ext  = ext.merge(
      "installed"         => !container.nil?,
      "installed_version" => container&.dig(:version),
      "removable"         => container && container[:layer] == :installed,
      "disabled"          => container ? container[:disabled] == true : false
    )
    json_response(res, 200, { ok: true, extension: ext })
  else
    container = extension_container(id)
    if container && container[:layer] == :installed
      market = fetch_batch_market_data([id])[id]
      # Fall back to local ext.yml for self-authored extensions.
      local_name   = container[:name].to_s.then { |n| n.empty? ? id : n }
      local_desc   = container.dig(:raw, "description").to_s
      local_author = container[:author].to_s
      local_units  = units_from_container(container)
      ext = {
        "id"                => id,
        "name"              => market ? (market["name"] || id) : local_name,
        "name_zh"           => market&.dig("name_zh"),
        "name_en"           => market&.dig("name_en"),
        "slug"              => id,
        "version"           => market ? (market["version"] || container[:version]) : container[:version],
        "installed_version" => container[:version],
        "description"       => market ? market["description"] : local_desc,
        "author"            => market ? market["author"] : local_author,
        "icon_url"          => market&.dig("icon_url"),
        "units"             => market ? market["units"] : local_units,
        "homepage"          => market ? (market["homepage"] || "") : container[:homepage].to_s,
        "origin"            => market ? (market["origin"] || container[:origin]) : container[:origin],
        "hub_active"        => market&.dig("hub_active"),
        # Only mark as unlisted when the extension was published to the
        # marketplace (origin != "self") but is no longer listed there.
        "unlisted"          => market.nil? && container[:origin].to_s != "self",
        "installed"         => true,
        "removable"         => true,
        "disabled"          => container[:disabled] == true,
      }
      json_response(res, 200, { ok: true, extension: ext })
    else
      json_response(res, 404, { ok: false, error: result[:error] || "Not found" })
    end
  end
end

#api_store_extension_disable(req, res) ⇒ Object

POST /api/store/extension/disable body: { id: }



2637
2638
2639
 
# File 'lib/clacky/server/http_server.rb', line 2637

def api_store_extension_disable(req, res)
  toggle_extension(req, res, :disable)
end

#api_store_extension_enable(req, res) ⇒ Object

POST /api/store/extension/enable body: { id: }



2642
2643
2644
 
# File 'lib/clacky/server/http_server.rb', line 2642

def api_store_extension_enable(req, res)
  toggle_extension(req, res, :enable)
end

#api_store_extension_install(req, res) ⇒ Object

DELETE /api/store/extension body: { id: }



2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
 
# File 'lib/clacky/server/http_server.rb', line 2661

def api_store_extension_install(req, res)
  body         = parse_json_body(req)
  download_url = body["download_url"].to_s.strip
  name         = body["name"].to_s.strip

  if download_url.empty?
    json_response(res, 400, { ok: false, error: "Missing download_url." })
    return
  end

  Clacky::ExtensionPackager.install(download_url, force: true)
  Clacky::ExtensionLoader.invalidate_cache!
  Clacky::Telemetry.extension_install!(name) unless name.empty?
  json_response(res, 200, { ok: true, name: name })
rescue Clacky::ExtensionPackager::Error => e
  json_response(res, 422, { ok: false, error: e.message })
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_store_extension_uninstall(req, res) ⇒ Object 



2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
 
# File 'lib/clacky/server/http_server.rb', line 2681

def api_store_extension_uninstall(req, res)
  body = parse_json_body(req)
  id = body["id"].to_s
  purge_data = body["purge_data"] == true
  container = extension_container(id)
  if container.nil?
    json_response(res, 404, { ok: false, error: "Not installed." })
    return
  end
  unless container[:layer] == :installed
    json_response(res, 422, { ok: false, error: "Only marketplace-installed extensions can be removed." })
    return
  end

  if Clacky::ExtensionLoader.uninstall!(id, purge_data: purge_data)
    json_response(res, 200, { ok: true, id: id })
  else
    json_response(res, 404, { ok: false, error: "Not installed." })
  end
end

#api_store_extensions(req, res) ⇒ Object

GET /api/store/extensions?q=&sort=

Public extension marketplace catalog — always returns the full public catalog regardless of brand status. Both brand and non-brand users see the same public marketplace here.



2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
 
# File 'lib/clacky/server/http_server.rb', line 2386

def api_store_extensions(req, res)
  brand  = Clacky::BrandConfig.load
  result = brand.search_extensions!(query: req.query["q"], sort: req.query["sort"])

  if result[:success]
    installed = installed_extension_containers
    extensions = Array(result[:extensions]).map do |ext|
      slug      = ext["name"] || ext[:name] || ext["slug"] || ext[:slug]
      container = installed[slug]
      ext.merge(
        "installed"         => !container.nil?,
        "installed_version" => container&.dig(:version)
      )
    end
    json_response(res, 200, { ok: true, extensions: extensions })
  else
    json_response(res, 200, {
      ok:         true,
      extensions: [],
      warning:    result[:error] || "Could not reach the extension store."
    })
  end
end

#api_store_extensions_brand(res) ⇒ Object

GET /api/store/extensions/brand

Brand-private extension catalog — only available to users with an activated brand license. Returns extensions belonging to this brand via BrandConfig#fetch_brand_extensions!. Returns 403 when the license is not activated.



2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
 
# File 'lib/clacky/server/http_server.rb', line 2416

def api_store_extensions_brand(res)
  brand = Clacky::BrandConfig.load

  unless brand.activated?
    json_response(res, 403, { ok: false, error: "Brand license not activated." })
    return
  end

  result = brand.fetch_brand_extensions!

  if result[:success]
    installed = installed_extension_containers
    extensions = Array(result[:extensions]).map do |ext|
      slug      = ext["name"] || ext[:name] || ext["slug"] || ext[:slug]
      container = installed[slug]
      # Merge local container data (e.g. emoji) for self-authored extensions.
      local_overrides = {}
      if container && ext["emoji"].to_s.empty?
        local_emoji = container.dig(:raw, "emoji") || container[:emoji]
        local_overrides["emoji"] = local_emoji if local_emoji.to_s.strip != ""
      end
      ext.merge(
        "installed"         => !ext["installed_version"].nil?,
        "installed_version" => ext["installed_version"],
        **local_overrides
      )
    end
    json_response(res, 200, { ok: true, extensions: extensions })
  else
    json_response(res, 200, {
      ok:         true,
      extensions: [],
      warning:    result[:error] || "Could not reach the extension store."
    })
  end
end

#api_store_extensions_installed(res) ⇒ Object

GET /api/store/extensions/installed

Returns all locally installed extensions (all layers: builtin, installed, local) regardless of whether they are still listed on the marketplace.



2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
 
# File 'lib/clacky/server/http_server.rb', line 2457

def api_store_extensions_installed(res)
  result   = Clacky::ExtensionLoader.load_all
  disabled = Clacky::ExtensionLoader.disabled_ids

  local_entries = Array(result&.containers).filter_map do |ext_id, container|
    next unless container[:layer] == :installed

    [ext_id, container]
  end.to_h

  market_by_slug = fetch_batch_market_data(local_entries.keys)

  extensions = local_entries.map do |ext_id, container|
    market = market_by_slug[ext_id]
    # For self-authored (origin: self) extensions market is nil.
    # Fall back to local ext.yml data so name/description/author are populated.
    local_name   = container[:name].to_s.then { |n| n.empty? ? ext_id : n }
    local_desc   = container.dig(:raw, "description").to_s
    local_author = container[:author].to_s
    local_units  = units_from_container(container)
    {
      "id"                => ext_id,
      "name"              => market ? (market["name"] || ext_id) : local_name,
      "display_name"      => market&.dig("display_name"),
      "display_name_zh"   => market&.dig("display_name_zh"),
      "name_zh"           => market&.dig("name_zh"),
      "name_en"           => market&.dig("name_en"),
      "slug"              => ext_id,
      "version"           => market ? (market["version"] || container[:version]) : container[:version],
      "installed_version" => container[:version],
      "description"       => market ? market["description"] : local_desc,
      "author"            => market ? market["author"] : local_author,
      "icon_url"          => market&.dig("icon_url"),
      "units"             => market ? market["units"] : local_units,
      "homepage"          => market ? (market["homepage"] || "") : container[:homepage].to_s,
      "origin"            => market ? (market["origin"] || container[:origin]) : container[:origin],
      "hub_active"        => market&.dig("hub_active"),
      "download_count"    => market&.dig("download_count").to_i,
      # Only mark as unlisted when the extension was published to the
      # marketplace (origin != "self") but is no longer listed there.
      # Self-authored extensions (origin: self) have never been published
      # and should never show the "unlisted" badge.
      "unlisted"          => market.nil? && container[:origin].to_s != "self",
      "layer"             => container[:layer].to_s,
      "installed"         => true,
      "removable"         => true,
      "disabled"          => disabled.include?(ext_id),
    }
  end

  json_response(res, 200, { ok: true, extensions: extensions })
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_store_skills(res) ⇒ Object

GET /api/brand/skills Fetches the brand skills list from the cloud, enriched with local installed version. Returns 200 with skill list, or 403 when license is not activated. If the remote API call fails, falls back to locally installed skills with a warning. GET /api/store/skills Returns the public skill store catalog from the OpenClacky Cloud API. Requires an activated license — uses HMAC auth with scope: "store" to fetch platform-wide published public skills (not filtered by the user's own skills). Falls back to the hardcoded catalog when license is not activated or API is unavailable.



2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
 
# File 'lib/clacky/server/http_server.rb', line 2365

def api_store_skills(res)
  brand  = Clacky::BrandConfig.load
  result = brand.fetch_store_skills!

  if result[:success]
    json_response(res, 200, { ok: true, skills: result[:skills] })
  else
    # License not activated or remote API unavailable — return empty list
    json_response(res, 200, {
      ok:      true,
      skills:  [],
      warning: result[:error] || "Could not reach the skill store."
    })
  end
end

#api_switch_session_model(session_id, req, res) ⇒ Object 



5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
 
# File 'lib/clacky/server/http_server.rb', line 5920

def api_switch_session_model(session_id, req, res)
  body = parse_json_body(req)
  model_id = body["model_id"].to_s.strip

  return json_response(res, 400, { error: "model_id is required" }) if model_id.empty?
  return json_response(res, 404, { error: "Session not found" }) unless @registry.ensure(session_id)

  agent = nil
  @registry.with_session(session_id) { |s| agent = s[:agent] }

  # With Plan B (shared @models reference), every session's AgentConfig
  # points at the same @models array as the global @agent_config. So
  # resolving the model by stable id here and in agent.switch_model_by_id
  # will always agree — no more index divergence after add/delete.
  target_model = @agent_config.models.find { |m| m["id"] == model_id }
  if target_model.nil?
    return json_response(res, 400, { error: "Model not found in configuration" })
  end

  # Switch to the model by id (unified interface with CLI)
  # Handles: config.switch_model_by_id + client rebuild + message_compressor rebuild
  success = agent.switch_model_by_id(model_id)

  unless success
    return json_response(res, 500, { error: "Failed to switch model" })
  end

  # Persist the change (saves to session file, NOT global config.yml)
  @session_manager.save(agent.to_session_data)

  # Broadcast update to all clients
  broadcast_session_update(session_id)

  json_response(res, 200, { ok: true, model_id: model_id, model: target_model["model"] })
rescue => e
  json_response(res, 500, { error: e.message })
end

#api_switch_session_reasoning_effort(session_id, req, res) ⇒ Object

PATCH /api/sessions/:id/reasoning_effort Body: { "reasoning_effort": "off" | "low" | "medium" | "high" | "xhigh" }



5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
 
# File 'lib/clacky/server/http_server.rb', line 5960

def api_switch_session_reasoning_effort(session_id, req, res)
  body = parse_json_body(req)
  raw = body["reasoning_effort"]
  return json_response(res, 404, { error: "Session not found" }) unless @registry.ensure(session_id)

  agent = nil
  @registry.with_session(session_id) { |s| agent = s[:agent] }
  return json_response(res, 404, { error: "Session not found" }) unless agent

  agent.reasoning_effort = raw
  @session_manager.save(agent.to_session_data)
  broadcast_session_update(session_id)

  json_response(res, 200, { ok: true, reasoning_effort: agent.reasoning_effort })
rescue => e
  json_response(res, 500, { error: e.message })
end

#api_switch_session_submodel(session_id, req, res) ⇒ Object

PATCH /api/sessions/:id/submodel Body: { "model_name": "dsk-deepseek-v4-pro" | null }

Pin this session to a sub-model under its current card without touching credentials or the global @models. Pass null/empty to clear and fall back to the card default. The name must appear in the provider preset's "models" list — anything else is rejected.



5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
 
# File 'lib/clacky/server/http_server.rb', line 5985

def api_switch_session_submodel(session_id, req, res)
  body = parse_json_body(req)
  raw = body["model_name"]
  model_name = raw.is_a?(String) ? raw.strip : nil

  return json_response(res, 404, { error: "Session not found" }) unless @registry.ensure(session_id)

  agent = nil
  @registry.with_session(session_id) { |s| agent = s[:agent] }
  return json_response(res, 404, { error: "Session not found" }) unless agent

  if model_name && !model_name.empty?
    info = agent.current_model_info
    # Prefer explicitly saved provider_id, fall back to base_url lookup
    provider_id = info&.dig(:provider_id).to_s.strip.then { |v| v.empty? ? nil : v }
    provider_id ||= (info && Clacky::Providers.find_by_base_url(info[:base_url]))
    allowed = provider_id ? Clacky::Providers.models(provider_id) : []
    if allowed.empty?
      return json_response(res, 400, { error: "Current model has no provider preset; sub-model switching unavailable" })
    end
    unless allowed.include?(model_name)
      return json_response(res, 400, { error: "Sub-model '#{model_name}' not listed under provider '#{provider_id}'" })
    end
  else
    model_name = nil
  end

  agent.set_session_sub_model(model_name)
  @session_manager.save(agent.to_session_data)
  broadcast_session_update(session_id)

  json_response(res, 200, { ok: true, sub_model: agent.current_model_info[:sub_model] })
rescue => e
  json_response(res, 500, { error: e.message })
end

#api_telemetry(req, res) ⇒ Object

POST /api/telemetry Body: { "event": "share_open" | "share_download", ... } Fire-and-forget telemetry from the WebUI frontend.



1490
1491
1492
1493
1494
1495
1496
 
# File 'lib/clacky/server/http_server.rb', line 1490

def api_telemetry(req, res)
  body = parse_json_body(req) || {}
  Clacky::Telemetry.share!(event: body["event"], extra: body["extra"])
  json_response(res, 200, { ok: true })
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#api_test_channel(platform, req, res) ⇒ Object

POST /api/channels/:platform/test Body: { fields... } (credentials to test — NOT saved) Tests connectivity using the provided credentials without persisting.



3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
 
# File 'lib/clacky/server/http_server.rb', line 3987

def api_test_channel(platform, req, res)
  platform = platform.to_sym
  body     = parse_json_body(req)
  fields   = body.transform_keys(&:to_sym).reject { |k, _| k == :platform }

  klass = Clacky::Channel::Adapters.find(platform)
  unless klass
    json_response(res, 404, { ok: false, error: "Unknown platform: #{platform}" })
    return
  end

  result = klass.test_connection(fields)
  json_response(res, 200, result)
rescue StandardError => e
  json_response(res, 200, { ok: false, error: e.message })
end

#api_test_config(req, res) ⇒ Object

POST /api/config/test — test connection for a single model config Body: { model, base_url, api_key, anthropic_format }



5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
 
# File 'lib/clacky/server/http_server.rb', line 5771

def api_test_config(req, res)
  body = parse_json_body(req)
  return json_response(res, 400, { error: "Invalid JSON" }) unless body

  api_key = body["api_key"].to_s
  if api_key.include?("****")
    model_id = body["id"].to_s
    entry = nil
    if !model_id.empty?
      entry = @agent_config.models.find { |m| m["id"] == model_id }
    end
    if entry.nil? && body.key?("index")
      entry = @agent_config.models[body["index"].to_i]
    end
    entry ||= @agent_config.models[@agent_config.current_model_index]
    api_key = entry ? entry["api_key"].to_s : ""
  end

  model            = body["model"].to_s
  base_url         = body["base_url"].to_s
  anthropic_format = body["anthropic_format"] || false

  result, used_base_url = try_test_with_base_url(api_key, base_url, model, anthropic_format)

  if result[:success] && used_base_url != base_url
    json_response(res, 200, {
      ok:                  true,
      message:             "Connected (auto-corrected base_url to add /v1)",
      effective_base_url:  used_base_url
    })
  elsif result[:success]
    json_response(res, 200, { ok: true, message: "Connected successfully" })
  else
    json_response(res, 200, { ok: false, message: result[:error].to_s, error_code: result[:error_code] })
  end
rescue => e
  json_response(res, 200, { ok: false, message: e.message })
end

#api_test_media_config(req, res) ⇒ Object

PATCH /api/config/media/:kind Body: { source: "off"|"auto"|"custom", model?, base_url?, api_key?, anthropic_format? } off / auto — remove any custom entry; "auto" lets the virtual derivation in AgentConfig#find_model_by_type take over. custom — replace any existing custom entry with the supplied fields. POST /api/config/media/test Body: { kind, source, model, base_url, api_key } Lightweight preflight: GET <base_url>/models to verify connectivity, auth, and that the requested model is exposed by the endpoint. No image is generated — zero cost, sub-second.



1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
 
# File 'lib/clacky/server/http_server.rb', line 1795

def api_test_media_config(req, res)
  body = parse_json_body(req) || {}
  kind = body["kind"].to_s
  return json_response(res, 422, { error: "invalid kind" }) unless %w[image video audio].include?(kind)
  return json_response(res, 422, { error: "only image kind supported" }) unless kind == "image"

  api_key = body["api_key"].to_s
  if api_key.empty? || api_key.include?("****")
    existing = @agent_config.find_model_by_type(kind) || {}
    api_key = existing["api_key"].to_s
  end

  model    = body["model"].to_s.strip
  base_url = body["base_url"].to_s.strip

  if model.empty? || base_url.empty? || api_key.empty?
    return json_response(res, 200, { ok: false, message: "model, base_url, api_key are required" })
  end

  result = preflight_media_endpoint(base_url: base_url, api_key: api_key, model: model)
  json_response(res, 200, result)
rescue => e
  json_response(res, 200, { ok: false, message: e.message })
end

#api_test_ocr_config(req, res) ⇒ Object

POST /api/config/ocr/test Reuses the media preflight (GET /models) — same connectivity check.



2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
 
# File 'lib/clacky/server/http_server.rb', line 2014

def api_test_ocr_config(req, res)
  body = parse_json_body(req) || {}
  api_key = body["api_key"].to_s
  if api_key.empty? || api_key.include?("****")
    existing = @agent_config.find_model_by_type("ocr") || {}
    api_key = existing["api_key"].to_s
  end

  model    = body["model"].to_s.strip
  base_url = body["base_url"].to_s.strip

  if model.empty? || base_url.empty? || api_key.empty?
    return json_response(res, 200, { ok: false, message: "model, base_url, api_key are required" })
  end

  result = preflight_media_endpoint(base_url: base_url, api_key: api_key, model: model)
  json_response(res, 200, result)
rescue => e
  json_response(res, 200, { ok: false, message: e.message })
end

#api_toggle_channel(platform, req, res) ⇒ Object

PATCH /api/channels/:platform/enabled Body: { enabled: true|false } Toggles the platform on/off without touching credentials. Enabling requires the platform to already be configured.



3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
 
# File 'lib/clacky/server/http_server.rb', line 3960

def api_toggle_channel(platform, req, res)
  platform = platform.to_sym
  enabled  = parse_json_body(req)["enabled"] == true

  config = Clacky::ChannelConfig.load

  if enabled
    unless config.platform_config(platform)
      json_response(res, 422, { ok: false, error: "Platform is not configured yet" })
      return
    end
    config.enable_platform(platform)
  else
    config.disable_platform(platform)
  end

  config.save
  @channel_manager.reload_platform(platform, config)

  json_response(res, 200, { ok: true, enabled: config.enabled?(platform) })
rescue StandardError => e
  json_response(res, 422, { ok: false, error: e.message })
end

#api_toggle_skill(name, req, res) ⇒ Object

Body: { enabled: true/false }



4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
 
# File 'lib/clacky/server/http_server.rb', line 4604

def api_toggle_skill(name, req, res)
  body    = parse_json_body(req)
  enabled = body["enabled"]

  if enabled.nil?
    json_response(res, 422, { error: "enabled field required" })
    return
  end

  skill = @skill_loader.toggle_skill(name, enabled: enabled)
  json_response(res, 200, { ok: true, name: skill.identifier, enabled: !skill.disabled? })
rescue Clacky::AgentError => e
  json_response(res, 422, { error: e.message })
end

#api_tool_browser(req, res) ⇒ Object

GET /api/channels Returns current config and running status for all supported platforms. POST /api/tool/browser Executes a browser tool action via the shared BrowserManager daemon. Used by skill scripts to reuse the server's existing Chrome connection without spawning a second MCP daemon.

Request body: JSON with same params as the browser tool { "action": "snapshot", "interactive": true, ... }

Response: JSON result from the browser tool



3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
 
# File 'lib/clacky/server/http_server.rb', line 3387

def api_tool_browser(req, res)
  params = parse_json_body(req)
  action = params["action"]
  return json_response(res, 400, { error: "action is required" }) if action.nil? || action.empty?

  tool   = Clacky::Tools::Browser.new
  result = tool.execute(**params.transform_keys(&:to_sym))

  json_response(res, 200, result)
rescue StandardError => e
  json_response(res, 500, { error: e.message })
end

#api_update_cron_task(name, req, res) ⇒ Object

PATCH /api/cron-tasks/:name — update content and/or cron/enabled Body: { content?, cron?, enabled? }



4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
 
# File 'lib/clacky/server/http_server.rb', line 4148

def api_update_cron_task(name, req, res)
  body    = parse_json_body(req)
  content = body["content"]
  cron    = body["cron"]&.to_s&.strip
  enabled = body["enabled"]

  if cron && cron.split(/\s+/).size != 5
    return json_response(res, 422, { error: "cron must have 5 fields (min hour dom month dow)" })
  end

  @scheduler.update_cron_task(name, content: content, cron: cron, enabled: enabled)
  json_response(res, 200, { ok: true, name: name })
rescue => e
  json_response(res, 404, { error: e.message })
end

#api_update_media_config(kind, req, res) ⇒ Object 



1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
 
# File 'lib/clacky/server/http_server.rb', line 1869

def api_update_media_config(kind, req, res)
  body = parse_json_body(req) || {}
  source = body["source"].to_s
  unless %w[off auto custom].include?(source)
    return json_response(res, 422, { error: "invalid source" })
  end

  @agent_config.models.reject! { |m| m["type"] == kind }

  case source
  when "off"
    @agent_config.models << {
      "id"       => SecureRandom.uuid,
      "type"     => kind,
      "disabled" => true
    }
  when "auto"
    override = body["model"].to_s.strip
    unless override.empty?
      @agent_config.models << {
        "id"    => SecureRandom.uuid,
        "type"  => kind,
        "model" => override
      }
    end
  when "custom"
    model    = body["model"].to_s.strip
    base_url = body["base_url"].to_s.strip
    api_key  = body["api_key"].to_s
    if model.empty? || base_url.empty? || api_key.empty? || api_key.include?("****")
      return json_response(res, 422, { error: "model, base_url, api_key are required" })
    end

    @agent_config.models << {
      "id"               => SecureRandom.uuid,
      "model"            => model,
      "base_url"         => base_url,
      "api_key"          => api_key,
      "anthropic_format" => body["anthropic_format"] || false,
      "type"             => kind
    }
  end

  @agent_config.save
  json_response(res, 200, { ok: true, state: @agent_config.media_state(kind) })
rescue => e
  json_response(res, 422, { error: e.message })
end

#api_update_model(id, req, res) ⇒ Object

PATCH /api/config/models/:id Body: any subset of { model, base_url, api_key, anthropic_format, type } Rules (the whole reason we moved off bulk save):

- Missing key  → field untouched
- api_key with "****" (masked display value) → IGNORED (never overwrites)
- api_key empty string → IGNORED (defensive; treat as "not changed")
- api_key real non-masked value → stored
- type="default" transparently clears the marker on other models
- Unknown id → 404


5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
 
# File 'lib/clacky/server/http_server.rb', line 5666

def api_update_model(id, req, res)
  body = parse_json_body(req)
  return json_response(res, 400, { error: "Invalid JSON" }) unless body

  target = @agent_config.models.find { |m| m["id"] == id }
  return json_response(res, 404, { error: "model not found" }) unless target

  if body.key?("model")
    v = body["model"].to_s.strip
    target["model"] = v unless v.empty?
  end
  if body.key?("base_url")
    v = body["base_url"].to_s.strip
    target["base_url"] = v unless v.empty?
  end
  if body.key?("anthropic_format")
    target["anthropic_format"] = !!body["anthropic_format"]
  end
  if body.key?("provider_id")
    v = body["provider_id"].to_s.strip
    if v.empty?
      target.delete("provider_id")
    else
      target["provider_id"] = v
    end
  end
  if body.key?("api_key")
    new_key = body["api_key"].to_s
    # Only store a real, unmasked, non-empty value. This is the
    # single place the "api_key disappeared" bug can no longer
    # happen — there is no path that writes "" into api_key.
    if !new_key.empty? && !new_key.include?("****")
      target["api_key"] = new_key
    end
  end
  if body.key?("type")
    new_type = body["type"]
    new_type = nil if new_type.is_a?(String) && new_type.strip.empty?
    if new_type == "default"
      @agent_config.models.each do |m|
        next if m["id"] == id
        m.delete("type") if m["type"] == "default"
      end
      target["type"] = "default"
      @agent_config.current_model_id    = target["id"]
      @agent_config.current_model_index = @agent_config.models.find_index { |m| m["id"] == id } || 0
    elsif new_type.nil?
      target.delete("type")
    else
      target["type"] = new_type
    end
  end

  @agent_config.save
  json_response(res, 200, { ok: true })
rescue => e
  json_response(res, 422, { error: e.message })
end

#api_update_ocr_config(req, res) ⇒ Object

PATCH /api/config/ocr Body: { source: "off"|"auto"|"custom", model?, base_url?, api_key?, anthropic_format? } Mirrors api_update_media_config but for the single "ocr" type.



1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
 
# File 'lib/clacky/server/http_server.rb', line 1959

def api_update_ocr_config(req, res)
  body = parse_json_body(req) || {}
  source = body["source"].to_s
  unless %w[off auto custom].include?(source)
    return json_response(res, 422, { error: "invalid source" })
  end

  @agent_config.models.reject! { |m| m["type"] == "ocr" }

  case source
  when "off"
    @agent_config.models << {
      "id"       => SecureRandom.uuid,
      "type"     => "ocr",
      "disabled" => true
    }
  when "auto"
    override = body["model"].to_s.strip
    unless override.empty?
      @agent_config.models << {
        "id"    => SecureRandom.uuid,
        "type"  => "ocr",
        "model" => override
      }
    end
  when "custom"
    model    = body["model"].to_s.strip
    base_url = body["base_url"].to_s.strip
    api_key  = body["api_key"].to_s
    if api_key.include?("****")
      existing = @agent_config.models.find { |m| m["type"] == "ocr" && m["api_key"] }
      api_key = existing ? existing["api_key"].to_s : ""
    end
    if model.empty? || base_url.empty? || api_key.empty?
      return json_response(res, 422, { error: "model, base_url, api_key are required" })
    end

    @agent_config.models << {
      "id"               => SecureRandom.uuid,
      "model"            => model,
      "base_url"         => base_url,
      "api_key"          => api_key,
      "anthropic_format" => body["anthropic_format"] || false,
      "type"             => "ocr"
    }
  end

  @agent_config.save
  json_response(res, 200, { ok: true, state: @agent_config.ocr_state })
rescue => e
  json_response(res, 422, { error: e.message })
end

#api_update_settings(req, res) ⇒ Object

PATCH /api/config/settings — update advanced settings



5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
 
# File 'lib/clacky/server/http_server.rb', line 5544

def api_update_settings(req, res)
  body = parse_json_body(req)
  return json_response(res, 400, { error: "Invalid JSON" }) unless body

  if body.key?("enable_compression")
    @agent_config.enable_compression = !!body["enable_compression"]
  end
  if body.key?("enable_prompt_caching")
    @agent_config.enable_prompt_caching = !!body["enable_prompt_caching"]
  end
  if body.key?("memory_update_enabled")
    @agent_config.memory_update_enabled = !!body["memory_update_enabled"]
  end
  if body.key?("proxy_url")
    raw = body["proxy_url"].to_s.strip
    if raw.empty?
      @agent_config.proxy_url = nil
    else
      begin
        uri = URI.parse(raw)
        unless uri.is_a?(URI::HTTP) && uri.host && !uri.host.empty?
          return json_response(res, 422, { error: "proxy_url must be a valid http(s) URL" })
        end
      rescue URI::InvalidURIError
        return json_response(res, 422, { error: "proxy_url is not a valid URL" })
      end
      @agent_config.proxy_url = raw
    end
  end

  @agent_config.save
  json_response(res, 200, { ok: true })
rescue => e
  json_response(res, 422, { error: e.message })
end

#api_upgrade_version(req, res) ⇒ Object

POST /api/version/upgrade Upgrades openclacky in a background thread, streaming output via WebSocket broadcast. If the user's gem source is the official RubyGems, use gem update. Otherwise (e.g. Aliyun mirror) download the .gem from OSS CDN to bypass mirror lag.



2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
 
# File 'lib/clacky/server/http_server.rb', line 2972

def api_upgrade_version(req, res)
  json_response(res, 202, { ok: true, message: "Upgrade started" })

  Thread.new do
    begin
      if official_gem_source?
        upgrade_via_gem_update
      else
        upgrade_via_oss_cdn
      end
    rescue StandardError => e
      Clacky::Logger.error("[Upgrade] Exception: #{e.class}: #{e.message}\n#{e.backtrace.first(5).join("\n")}")
      broadcast_all(type: "upgrade_log", line: "\n✗ Error during upgrade: #{e.message}\n")
      broadcast_all(type: "upgrade_complete", success: false)
    end
  end
end

#api_upload_file(req, res) ⇒ Object

POST /api/upload Accepts a multipart/form-data file upload (field name: "file"). Runs the file through FileProcessor: saves original + generates structured preview (Markdown) for Office/ZIP files so the agent can read them directly.



3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
 
# File 'lib/clacky/server/http_server.rb', line 3769

def api_upload_file(req, res)
  upload = parse_multipart_upload(req, "file")
  unless upload
    json_response(res, 400, { ok: false, error: "No file field found in multipart body" })
    return
  end

  saved = Clacky::Utils::FileProcessor.save(
    body:     upload[:data],
    filename: upload[:filename].to_s
  )

  json_response(res, 200, { ok: true, name: saved[:name], path: saved[:path] })
rescue => e
  json_response(res, 500, { ok: false, error: e.message })
end

#broadcast(session_id, event) ⇒ Object

Broadcast an event to all clients subscribed to a session. Dead connections (broken pipe / closed socket / deadline exceeded) are removed automatically. Connections already marked closed are skipped upfront so one sluggish client can't delay delivery to healthy ones.



6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
 
# File 'lib/clacky/server/http_server.rb', line 6671

def broadcast(session_id, event)
  # Drop events emitted by a superseded agent thread. A thread carrying a
  # :task_epoch only gets through while it still owns the session; an
  # interrupted-but-unwinding old thread (e.g. a late show_progress
  # "done" from an ensure block) is silently dropped so it can't disturb
  # the new task's UI. Threads without :task_epoch (HTTP handlers, the
  # task supervisor itself) are never affected.
  my_epoch = Thread.current[:task_epoch]
  return if my_epoch && @registry.current_epoch(session_id) != my_epoch

  clients = @ws_mutex.synchronize { (@ws_clients[session_id] || []).dup }
  dead = []
  clients.each do |conn|
    if conn.closed?
      dead << conn
      next
    end
    dead << conn unless conn.send_json(event)
  end
  return if dead.empty?

  @ws_mutex.synchronize do
    (@ws_clients[session_id] || []).reject! { |conn| dead.include?(conn) }
    @all_ws_conns.reject! { |conn| dead.include?(conn) }
  end
end

#broadcast_all(event) ⇒ Object

Broadcast an event to every connected client (regardless of session subscription). Dead connections are removed automatically.



6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
 
# File 'lib/clacky/server/http_server.rb', line 6700

def broadcast_all(event)
  clients = @ws_mutex.synchronize { @all_ws_conns.dup }
  dead = []
  clients.each do |conn|
    if conn.closed?
      dead << conn
      next
    end
    dead << conn unless conn.send_json(event)
  end
  return if dead.empty?

  @ws_mutex.synchronize do
    @all_ws_conns.reject! { |conn| dead.include?(conn) }
    @ws_clients.each_value { |list| list.reject! { |conn| dead.include?(conn) } }
  end
end

#broadcast_session_update(session_id) ⇒ Object

Broadcast a session_update event to all clients so they can patch their local session list without needing a full session_list refresh.



6720
6721
6722
6723
6724
6725
 
# File 'lib/clacky/server/http_server.rb', line 6720

def broadcast_session_update(session_id)
  session = @registry.snapshot(session_id)
  return unless session

  broadcast_all(type: "session_update", session: session)
end

#build_session(name:, working_dir: nil, permission_mode: :confirm_all, profile: "general", source: :manual, model_id: nil) ⇒ Object

Create a session in the registry and wire up Agent + WebUIController. Returns the new session_id. Build a new agent session.

Parameters:

  • name (String) —

    display name for the session

  • working_dir (String) (defaults to: nil) —

    working directory for the agent

  • permission_mode (Symbol) (defaults to: :confirm_all) —

    :confirm_all (default, human present) or :auto_approve (unattended — suppresses request_user_feedback waits)



6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
 
# File 'lib/clacky/server/http_server.rb', line 6740

def build_session(name:, working_dir: nil, permission_mode: :confirm_all, profile: "general", source: :manual, model_id: nil)
  working_dir ||= default_working_dir
  FileUtils.mkdir_p(working_dir) unless Dir.exist?(working_dir)
  session_id = Clacky::SessionManager.generate_id
  @registry.create(session_id: session_id)

  config = @agent_config.deep_copy
  config.permission_mode = permission_mode

  # Apply model override BEFORE creating the client — otherwise the
  # client is built from the default model entry and may route through
  # the wrong provider (e.g. sending a deepseek-v4-pro request to the
  # Bedrock-format OpenClacky endpoint, which replies "unknown model").
  #
  # We use switch_model_by_id (not a name-based rewrite of
  # current_model["model"]) because:
  #   1. Ids uniquely identify an entry across providers; names can
  #      collide between entries (deepseek vs dsk-deepseek aliases).
  #   2. switch_model_by_id only flips per-session @current_model_id
  #      in the dup'd config — it never mutates the shared @models
  #      array (see AgentConfig#deep_copy's shared-ref contract).
  #      A name rewrite would have leaked into every live session
  #      AND corrupted the on-disk config at next save.
  config.switch_model_by_id(model_id) if model_id

  # Build client from the (possibly overridden) config so api format
  # detection (Bedrock vs OpenAI vs Anthropic) uses the correct model.
  client = Clacky::Client.new(
    config.api_key,
    base_url: config.base_url,
    model: config.model_name,
    anthropic_format: config.anthropic_format?
  )

  broadcaster = method(:broadcast)
  ui = WebUIController.new(session_id, broadcaster)
  agent = Clacky::Agent.new(client, config, working_dir: working_dir, ui: ui, profile: profile,
                            session_id: session_id, source: source)
  agent.rename(name) unless name.nil? || name.empty?
  idle_timer = build_idle_timer(session_id, agent)

  @registry.with_session(session_id) do |s|
    s[:agent]      = agent
    s[:ui]         = ui
    s[:idle_timer] = idle_timer
  end

  # Persist an initial snapshot so the session is immediately visible in registry.list
  # (which reads from disk). Without this, new sessions only appear after their first task.
  @session_manager.save(agent.to_session_data)

  session_id
end

#build_session_from_data(session_data, permission_mode: :confirm_all) ⇒ Object

Restore a persisted session from saved session_data (from SessionManager). The agent keeps its original session_id so the frontend URL hash stays valid across server restarts.



6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
 
# File 'lib/clacky/server/http_server.rb', line 6797

def build_session_from_data(session_data, permission_mode: :confirm_all)
  original_id = session_data[:session_id]

  client = @client_factory.call
  config = @agent_config.deep_copy
  config.permission_mode = permission_mode
  broadcaster = method(:broadcast)
  ui = WebUIController.new(original_id, broadcaster)
  # Restore the agent profile from the persisted session; fall back to "general"
  # for sessions saved before the agent_profile field was introduced.
  profile = session_data[:agent_profile].to_s
  profile = "general" if profile.empty?
  agent = Clacky::Agent.from_session(client, config, session_data, ui: ui, profile: profile)
  idle_timer = build_idle_timer(original_id, agent)

  # Register session atomically with a fully-built agent so no concurrent
  # caller ever sees agent=nil for this session. The duplicate-restore guard
  # is handled upstream by SessionRegistry#ensure via @restoring.
  @registry.create(session_id: original_id)
  @registry.with_session(original_id) do |s|
    s[:agent]      = agent
    s[:ui]         = ui
    s[:idle_timer] = idle_timer
  end

  original_id
end

#config_for_session(session_id) ⇒ Object

Resolve the AgentConfig for a given session, falling back to nil when the session isn't live so callers can use the global config instead.



5502
5503
5504
5505
5506
5507
5508
5509
 
# File 'lib/clacky/server/http_server.rb', line 5502

def config_for_session(session_id)
  return nil if session_id.to_s.strip.empty?
  return nil unless @registry.ensure(session_id)

  agent = nil
  @registry.with_session(session_id) { |s| agent = s[:agent] }
  agent&.config
end

#create_default_session ⇒ Object

Auto-restore persisted sessions (or create a fresh default) when the server starts. Skipped when no API key is configured (onboard flow will handle it).

Strategy: load the most recent sessions from ~/.clacky/sessions/ for the current working directory and restore them into @registry so their IDs are stable across restarts (frontend hash stays valid). If no persisted sessions exist, fall back to creating a brand-new default session.



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
 
# File 'lib/clacky/server/http_server.rb', line 856

def create_default_session
  return unless @agent_config.models_configured?

  # Restore up to 2 sessions per source type from disk. Earlier this was
  # 5/source (≤20 sessions), which exceeded max_idle_agents=10 and caused
  # the first user message after a restart to spend several seconds in
  # evict_excess_idle! serializing 10+ sessions back to disk. 2/source
  # keeps the most-recent items hot for fast switch without blowing the
  # idle budget.
  @registry.restore_from_disk(n: 2)

  # If nothing was restored (no persisted sessions), create a fresh default.
  unless @registry.list(limit: 1).any?
    working_dir = default_working_dir
    FileUtils.mkdir_p(working_dir) unless Dir.exist?(working_dir)
    build_session(name: "Session 1", working_dir: working_dir)
  end
end

#default_working_dir ⇒ Object

── Helpers ───────────────────────────────────────────────────────────────



6729
6730
6731
 
# File 'lib/clacky/server/http_server.rb', line 6729

def default_working_dir
  @agent_config&.default_working_dir || File.expand_path("~/clacky_workspace")
end

#deliver_confirmation(session_id, conf_id, result) ⇒ Object 



6452
6453
6454
6455
6456
 
# File 'lib/clacky/server/http_server.rb', line 6452

def deliver_confirmation(session_id, conf_id, result)
  ui = nil
  @registry.with_session(session_id) { |s| ui = s[:ui] }
  ui&.deliver_confirmation(conf_id, result)
end

#dispatch(req, res) ⇒ Object

── Router ────────────────────────────────────────────────────────────────



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/clacky/server/http_server.rb', line 436

def dispatch(req, res)
  path   = req.path
  method = req.request_method

  Thread.current[:lang] = req["X-Lang"].to_s.strip.then { |l| l.empty? ? nil : l }

  # Access key guard (skip for WebSocket upgrades)
  return unless check_access_key(req, res)

  # WebSocket upgrade — no timeout applied (long-lived connection)
  if websocket_upgrade?(req)
    handle_websocket(req, res)
    return
  end

  # Wrap all REST handlers in a timeout so a hung handler (e.g. infinite
  # recursion in chunk parsing) returns a proper 503 instead of an empty 200.
  #
  # Brand/license endpoints call PlatformHttpClient which retries across two
  # hosts with OPEN_TIMEOUT=8s per attempt × 2 attempts = up to ~16s on the
  # primary alone, before failing over to the fallback domain.  Give them a
  # generous 90s so retry + failover can complete without being cut short.
  timeout_sec = if path.start_with?("/api/brand")
    90
  elsif path.start_with?(Clacky::Server::ApiExtensionDispatcher::MOUNT_PREFIX)
    # api_ext dispatcher applies its own per-route timeout (capped at
    # ApiExtension::MAX_TIMEOUT). Use the upper bound here so the outer
    # guard never cuts a long-running custom handler short.
    Clacky::ApiExtension::MAX_TIMEOUT + 30
  elsif path == "/api/tool/browser"
    30
  elsif path == "/api/exchange-rate"
    20
  elsif path.end_with?("/benchmark")
    20
  elsif path == "/api/media/image"
    # Image generation routes through OpenRouter (chat completions
    # with modalities:["image"]); end-to-end latency is commonly
    # 20-60s and can exceed 2 minutes for or-gpt-image-2 under load.
    300
  elsif path == "/api/media/video/status"
    # Single upstream task lookup; returns in well under a second.
    30
  elsif path == "/api/media/video"
    # Video generation (Veo via the gateway) runs an async submit+poll
    # cycle that routinely takes 1-3 minutes and can approach the
    # gateway's 8-minute ceiling. Give the local handler headroom.
    600
  elsif path == "/api/media/audio/speech"
    120
  elsif path == "/api/media/audio/transcriptions"
    30
  elsif path == "/api/media/video/understand"
    60
  elsif path.start_with?("/api/backup/download") || path == "/api/backup/run" || path == "/api/backup/restore"
    # Building/extracting a tar.gz of ~/.clacky can take a while.
    120
  elsif path == "/api/store/extension/install"
    300
  else
    30
  end
  Timeout.timeout(timeout_sec) do
    _dispatch_rest(req, res)
  end
rescue Timeout::Error
  Clacky::Logger.warn("[HTTP 503] #{method} #{path} timed out after #{timeout_sec}s")
  json_response(res, 503, { error: "Request timed out" })
rescue => e
  Clacky::Logger.warn("[HTTP 500] #{e.class}: #{e.message}\n#{e.backtrace.first(5).join("\n")}")
  json_response(res, 500, { error: e.message })
end

#extension_container(slug) ⇒ Object

Locate an installed container by slug/id (nil when not installed).



2627
2628
2629
2630
2631
2632
2633
2634
 
# File 'lib/clacky/server/http_server.rb', line 2627

def extension_container(slug)
  return nil if slug.to_s.strip.empty?

  result = Clacky::ExtensionLoader.load_all
  Array(result&.containers).to_h[slug.to_s]
rescue StandardError
  nil
end

#fetch_exchange_rate(from, to) ⇒ Object 



901
902
903
904
905
906
 
# File 'lib/clacky/server/http_server.rb', line 901

def fetch_exchange_rate(from, to)
  fetch_open_exchange_rate(from, to)
rescue StandardError => primary_error
  Clacky::Logger.warn("[ExchangeRate] primary source failed: #{primary_error.message}")
  fetch_frankfurter_exchange_rate(from, to)
end

#fetch_exchange_rate_json(url) ⇒ Object 



943
944
945
946
947
948
949
950
951
952
953
954
955
 
# File 'lib/clacky/server/http_server.rb', line 943

def fetch_exchange_rate_json(url)
  uri = URI(url)
  http = Net::HTTP.new(uri.host, uri.port)
  http.use_ssl = uri.scheme == "https"
  http.open_timeout = 5
  http.read_timeout = 8

  req = Net::HTTP::Get.new(uri.request_uri, "Accept" => "application/json")
  response = http.request(req)
  raise "HTTP #{response.code}" unless response.is_a?(Net::HTTPSuccess)

  JSON.parse(response.body.to_s)
end

#fetch_frankfurter_exchange_rate(from, to) ⇒ Object 



926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'lib/clacky/server/http_server.rb', line 926

def fetch_frankfurter_exchange_rate(from, to)
  query = URI.encode_www_form("from" => from, "to" => to)
  data  = fetch_exchange_rate_json("#{EXCHANGE_RATE_FALLBACK_URL}?#{query}")

  rate = positive_float(data.dig("rates", to))
  raise "frankfurter.app missing #{to} rate" unless rate

  {
    from: from,
    to: to,
    rate: rate,
    date: data["date"].to_s,
    updated_at: data["date"].to_s,
    source: "frankfurter.app"
  }
end

#fetch_open_exchange_rate(from, to) ⇒ Object 



908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
 
# File 'lib/clacky/server/http_server.rb', line 908

def fetch_open_exchange_rate(from, to)
  data = fetch_exchange_rate_json("#{EXCHANGE_RATE_PRIMARY_BASE_URL}/#{URI.encode_www_form_component(from)}")
  raise "open.er-api.com returned #{data["result"] || "unknown"}" unless data["result"] == "success"

  rate = positive_float(data.dig("rates", to))
  raise "open.er-api.com missing #{to} rate" unless rate

  updated_at = data["time_last_update_utc"].to_s
  {
    from: from,
    to: to,
    rate: rate,
    date: parse_exchange_rate_date(updated_at),
    updated_at: updated_at,
    source: "open.er-api.com"
  }
end

#handle_edit_message(session_id, content, created_at) ⇒ Object

── Session actions ───────────────────────────────────────────────────────



6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
 
# File 'lib/clacky/server/http_server.rb', line 6393

def handle_edit_message(session_id, content, created_at)
  return unless @registry.exist?(session_id)

  agent = nil
  @registry.with_session(session_id) { |s| agent = s[:agent] }
  return unless agent

  if agent.history.respond_to?(:truncate_from_created_at) && !created_at.to_s.empty?
    agent.history.truncate_from_created_at(created_at)
  end

  handle_user_message(session_id, content)
end

#handle_user_message(session_id, content, files = []) ⇒ Object 



6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
 
# File 'lib/clacky/server/http_server.rb', line 6407

def handle_user_message(session_id, content, files = [])
  return unless @registry.exist?(session_id)

  session = @registry.get(session_id)
  
  # If session is running, interrupt it first (mimics CLI behavior)
  if session[:status] == :running
    interrupt_session(session_id)

    # Give the old thread a short window to exit cleanly.
    # In the common case it returns within milliseconds (Thread#raise
    # lands on a tight loop or LLM read). If it can't be reached in
    # time (e.g. blocked in a slow subagent syscall), we proceed anyway:
    # the agent's check_stale! checkpoints will refuse to mutate
    # history once the new thread takes over.
    old_thread = nil
    @registry.with_session(session_id) { |s| old_thread = s[:thread] }
    old_thread&.join(2)
  end

  agent = nil
  @registry.with_session(session_id) { |s| agent = s[:agent] }
  return unless agent

  # Auto-name the session from the first user message (before agent starts running).
  # Skip if the name looks like it was set by the user (not a system-generated "Session N").
  if agent.history.empty? && agent.name.match?(/\ASession \d+\z/)
    auto_name = content.gsub(/\s+/, " ").strip[0, 30]
    auto_name += "…" if content.strip.length > 30
    agent.rename(auto_name)
    broadcast(session_id, { type: "session_renamed", session_id: session_id, name: auto_name })
  end

  # Broadcast user message through web_ui so channel subscribers (飞书/企微) receive it.
  # created_at is shared with agent.run so the history entry and the bubble use the same value.
  msg_created_at = Time.now.to_f
  web_ui = nil
  @registry.with_session(session_id) { |s| web_ui = s[:ui] }
  web_ui&.show_user_message(content, created_at: msg_created_at, source: :web)

  # File references are now handled inside agent.run — injected as a system_injected
  # message after the user message, so replay_history skips them automatically.
  run_agent_task(session_id, agent) { agent.run(content, files: files, created_at: msg_created_at) }
end

#handle_websocket(req, res) ⇒ Object

Hijacks the TCP socket from WEBrick and upgrades it to WebSocket.



6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
 
# File 'lib/clacky/server/http_server.rb', line 6242

def handle_websocket(req, res)
  socket = req.instance_variable_get(:@socket)

  # Server handshake — parse the upgrade request
  handshake = WebSocket::Handshake::Server.new
  handshake << build_handshake_request(req)
  unless handshake.finished? && handshake.valid?
    Clacky::Logger.warn("WebSocket handshake invalid")
    return
  end

  # Send the 101 Switching Protocols response
  socket.write(handshake.to_s)

  version  = handshake.version
  incoming = WebSocket::Frame::Incoming::Server.new(version: version)
  conn     = WebSocketConnection.new(socket, version)

  on_ws_open(conn)

  begin
    buf = String.new("", encoding: "BINARY")
    loop do
      chunk = socket.read_nonblock(4096, buf, exception: false)
      case chunk
      when :wait_readable
        IO.select([socket], nil, nil, 30)
      when nil
        break  # EOF
      else
        incoming << chunk.dup
        while (frame = incoming.next)
          case frame.type
          when :text
            on_ws_message(conn, frame.data)
          when :binary
            on_ws_message(conn, frame.data)
          when :ping
            conn.send_raw(:pong, frame.data)
          when :close
            conn.send_raw(:close, "")
            break
          end
        end
      end
    end
  rescue IOError, Errno::ECONNRESET, Errno::EPIPE, Errno::EBADF
    # Client disconnected or socket became invalid
  ensure
    on_ws_close(conn)
    socket.close rescue nil
  end

  # Tell WEBrick not to send any response (we handled everything)
  res.instance_variable_set(:@header, {})
  res.status = -1
rescue => e
  Clacky::Logger.error("WebSocket handler error: #{e.class}: #{e.message}")
end

#installed_extension_containers ⇒ Object 



2536
2537
2538
2539
2540
2541
 
# File 'lib/clacky/server/http_server.rb', line 2536

def installed_extension_containers
  result = Clacky::ExtensionLoader.load_all
  Array(result&.containers).filter_map { |id, c| [id, c] if c[:layer] == :installed }.to_h
rescue StandardError
  {}
end

#installed_extension_slugs ⇒ Object

Slugs of every extension container currently loaded (any layer), used to flag "installed" on the public marketplace catalog.



2529
2530
2531
2532
2533
2534
 
# File 'lib/clacky/server/http_server.rb', line 2529

def installed_extension_slugs
  result = Clacky::ExtensionLoader.load_all
  Array(result&.containers).map { |id, _c| id }.to_set
rescue StandardError
  Set.new
end

#interrupt_session(session_id) ⇒ Object

Interrupt a running agent session.

Thread#raise is best-effort: it unblocks most pure-Ruby waits and Faraday reads, but can't reach a thread stuck in a C-extension syscall until that syscall returns. We raise once and return immediately.

Correctness of the takeover does not depend on the old thread dying promptly: each new task claims a fresh epoch (see run_agent_task), and any status write or UI broadcast from a superseded thread is fenced off by that epoch. A stale thread that lingers in a syscall is harmless — it self-terminates at the next check_stale! checkpoint, or when the syscall returns; either way it can no longer touch the live session.



6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
 
# File 'lib/clacky/server/http_server.rb', line 6470

def interrupt_session(session_id)
  @registry.with_session(session_id) do |s|
    s[:idle_timer]&.cancel
    thread = s[:thread]
    next unless thread&.alive?

    Clacky::Logger.info("[interrupt] session=#{session_id} raise")
    begin
      thread.raise(Clacky::AgentInterrupted, "Interrupted by user")
    rescue ThreadError => e
      Clacky::Logger.warn("[interrupt] raise failed: #{e.message}")
    end
  end
end

#json_response(res, status, data) ⇒ Object 



6854
6855
6856
6857
6858
6859
 
# File 'lib/clacky/server/http_server.rb', line 6854

def json_response(res, status, data)
  res.status       = status
  res.content_type = "application/json; charset=utf-8"
  res["Access-Control-Allow-Origin"] = "*"
  res.body = JSON.generate(data)
end

#mask_api_key(key) ⇒ Object

Mask API key for display: show first 8 + last 4 chars, middle replaced with **** Mask an api_key for safe display / transport to the browser.

Contract: the returned string MUST contain "****" so callers (incl. the frontend) can reliably detect "this is a display placeholder, not a real key" and refuse to treat it as input. The old behaviour of returning the raw value for short keys was a correctness bug — it leaked short keys in plaintext to GET /api/config, and it let short masked values slip past the frontend's mask-detection.



6845
6846
6847
6848
6849
6850
6851
6852
 
# File 'lib/clacky/server/http_server.rb', line 6845

def mask_api_key(key)
  return "" if key.nil? || key.empty?
  if key.length <= 12
    # Very short key — show the first char only, redact the rest.
    return "#{key[0]}****"
  end
  "#{key[0..7]}****#{key[-4..]}"
end

#media_capabilities_payload(cfg = @agent_config) ⇒ Object

Capability summary for the model dropdown's footer. vision — true when the current default model handles images itself OR a vision sidecar is configured (ocr_state covers both). image/video/audio — true only when a dedicated sidecar is configured; the chat model can never generate these on its own.



5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
 
# File 'lib/clacky/server/http_server.rb', line 5516

def media_capabilities_payload(cfg = @agent_config)
  ocr = cfg.ocr_state
  out = {
    vision: {
      configured: !!ocr["configured"],
      primary:    !!ocr["primary"],
      model:      ocr["model"]
    }
  }
  Clacky::Providers::MEDIA_KINDS.each do |t|
    state = cfg.media_state(t)
    out[t] = { configured: !!state["configured"], model: state["model"] }
  end
  out
end

#normalize_currency_code(value, fallback:) ⇒ Object 



895
896
897
898
899
 
# File 'lib/clacky/server/http_server.rb', line 895

def normalize_currency_code(value, fallback:)
  code = value.to_s.strip.upcase
  code = fallback if code.empty?
  code.match?(/\A[A-Z]{3}\z/) ? code : nil
end

#not_found(res) ⇒ Object 



6917
6918
6919
6920
 
# File 'lib/clacky/server/http_server.rb', line 6917

def not_found(res)
  res.status = 404
  res.body   = "Not Found"
end

#on_ws_close(conn) ⇒ Object 



6386
6387
6388
6389
 
# File 'lib/clacky/server/http_server.rb', line 6386

def on_ws_close(conn)
  @ws_mutex.synchronize { @all_ws_conns.delete(conn) }
  unsubscribe(conn)
end

#on_ws_message(conn, raw) ⇒ Object 



6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
 
# File 'lib/clacky/server/http_server.rb', line 6315

def on_ws_message(conn, raw)
  msg = JSON.parse(raw)
  type = msg["type"]

  case type
  when "subscribe"
    session_id = msg["session_id"]
    if @registry.ensure(session_id)
      conn.session_id = session_id
      subscribe(session_id, conn)
      conn.send_json(type: "subscribed", session_id: session_id)
      # Push a fresh snapshot so a reconnecting tab sees the true current
      # status (it may have missed session_update events while offline).
      if (snap = @registry.snapshot(session_id))
        conn.send_json(type: "session_update", session: snap)
      end
      # If a shell command is still running, replay progress + buffered stdout
      # to the newly subscribed tab so it sees the live state it may have missed.
      @registry.with_session(session_id) { |s| s[:ui]&.replay_live_state }
    else
      conn.send_json(type: "error", message: "Session not found: #{session_id}")
    end

  when "edit_message"
    session_id = msg["session_id"] || conn.session_id
    handle_edit_message(session_id, msg["content"].to_s, msg["created_at"].to_s)

  when "message"
    session_id = msg["session_id"] || conn.session_id
    Thread.current[:lang] = msg["lang"].to_s.strip.then { |l| l.empty? ? nil : l }
    # Merge legacy images array into files as { data_url:, name:, mime_type: } entries
    raw_images = (msg["images"] || []).map do |data_url|
      { "data_url" => data_url, "name" => "image.jpg", "mime_type" => "image/jpeg" }
    end
    handle_user_message(session_id, msg["content"].to_s, (msg["files"] || []) + raw_images)

  when "confirmation"
    session_id = msg["session_id"] || conn.session_id
    deliver_confirmation(session_id, msg["id"], msg["result"])

  when "interrupt"
    session_id = msg["session_id"] || conn.session_id
    interrupt_session(session_id)

  when "list_sessions"
    stats = @registry.cron_stats
    page = @registry.list(limit: 21, exclude_type: "cron")
    has_more = page.size > 20
    all_sessions = page.first(20)
    conn.send_json(type: "session_list", sessions: all_sessions, has_more: has_more,
                   cron_count: stats[:count], latest_cron_updated_at: stats[:latest_updated_at])

  when "run_task"
    # Client sends this after subscribing to guarantee it's ready to receive
    # broadcasts before the agent starts executing.
    session_id = msg["session_id"] || conn.session_id
    start_pending_task(session_id)

  when "ping"
    conn.send_json(type: "pong")

  else
    conn.send_json(type: "error", message: "Unknown message type: #{type}")
  end
rescue JSON::ParserError => e
  conn.send_json(type: "error", message: "Invalid JSON: #{e.message}")
rescue => e
  Clacky::Logger.error("[on_ws_message] #{e.class}: #{e.message}\n#{e.backtrace.first(10).join("\n")}")
  conn.send_json(type: "error", message: e.message)
end

#on_ws_open(conn) ⇒ Object 



6310
6311
6312
6313
 
# File 'lib/clacky/server/http_server.rb', line 6310

def on_ws_open(conn)
  @ws_mutex.synchronize { @all_ws_conns << conn }
  # Client will send a "subscribe" message to bind to a session
end

#parse_exchange_rate_date(value) ⇒ Object 



964
965
966
967
968
969
970
 
# File 'lib/clacky/server/http_server.rb', line 964

def parse_exchange_rate_date(value)
  return "" if value.to_s.strip.empty?

  Date.parse(value.to_s).iso8601
rescue ArgumentError
  ""
end

#parse_json_body(req) ⇒ Object 



6861
6862
6863
6864
6865
6866
6867
 
# File 'lib/clacky/server/http_server.rb', line 6861

def parse_json_body(req)
  return {} if req.body.nil? || req.body.empty?

  JSON.parse(req.body)
rescue JSON::ParserError
  {}
end

#positive_float(value) ⇒ Object 



957
958
959
960
961
962
 
# File 'lib/clacky/server/http_server.rb', line 957

def positive_float(value)
  rate = Float(value)
  rate.positive? ? rate : nil
rescue ArgumentError, TypeError
  nil
end

#run_session_task(session_id, prompt, display_message: nil) ⇒ Object

for the client to subscribe. The user bubble is persisted via display_text (Agent#run → history → replay_history), so the frontend only needs to navigate over and load history — no realtime broadcast, no subscribe-timing race. This is the stable entry point for programmatic "create session + run now" flows (spawn, extensions).



6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
 
# File 'lib/clacky/server/http_server.rb', line 6489

def run_session_task(session_id, prompt, display_message: nil)
  return unless @registry.exist?(session_id)

  agent = nil
  web_ui = nil
  @registry.with_session(session_id) do |s|
    agent = s[:agent]
    web_ui = s[:ui]
  end
  return unless agent

  web_ui&.show_user_message(display_message, source: :web) if display_message

  run_agent_task(session_id, agent) { agent.run(prompt, display_text: display_message) }
end

#serve_file_download(res, path) ⇒ Object

Stream a file to the client as a download. Content-Type is always application/octet-stream — the browser determines file type and handling from the filename extension in Content-Disposition.



3829
3830
3831
3832
3833
3834
3835
3836
3837
 
# File 'lib/clacky/server/http_server.rb', line 3829

def serve_file_download(res, path)
  filename = File.basename(path)

  res.status                  = 200
  res["Content-Type"]         = "application/octet-stream"
  res["Content-Disposition"]  = "attachment; filename=\"#{filename}\""
  res["Content-Length"]       = File.size(path).to_s
  res.body = File.binread(path)
end

#start ⇒ Object 



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/clacky/server/http_server.rb', line 232

def start
  @start_time = Time.now
  # One-time migration: move legacy trash contents into file-trash/ subdirectory.
  Clacky::TrashDirectory.migrate_legacy_if_needed

  # Enable console logging for the server process so log lines are visible in the terminal.
  Clacky::Logger.console = true

  Clacky::Logger.info("[HttpServer PID=#{Process.pid}] start() mode=#{@inherited_socket ? 'worker' : 'standalone'} inherited_socket=#{@inherited_socket.inspect} master_pid=#{@master_pid.inspect}")

  # Expose server address and brand name to all child processes (skill scripts, shell commands, etc.)
  # so they can call back into the server without hardcoding the port,
  # and use the correct product name without re-reading brand.yml.
  # CLACKY_SERVER_HOST always points at 127.0.0.1 so child processes hit
  # the loopback listener (no access key required), regardless of bind.
  ENV["CLACKY_SERVER_PORT"]  = @port.to_s
  ENV["CLACKY_SERVER_HOST"]  = "127.0.0.1"
  product_name = Clacky::BrandConfig.load.product_name
  ENV["CLACKY_PRODUCT_NAME"] = (product_name.nil? || product_name.strip.empty?) ? "OpenClacky" : product_name

  # Override WEBrick's built-in signal traps via StartCallback,
  # which fires after WEBrick sets its own INT/TERM handlers.
  # This ensures Ctrl-C always exits immediately.
  #
  # When running as a worker under Master, DoNotListen: true prevents WEBrick
  # from calling bind() on its own — we inject the inherited socket instead.
  webrick_opts = {
    BindAddress:   @host,
    Port:          @port,
    Logger:        WEBrick::Log.new(File::NULL),
    AccessLog:     [],
    StartCallback: proc { }  # signal traps set below, after `server` is created
  }
  webrick_opts[:DoNotListen] = true if @inherited_socket
  Clacky::Logger.info("[HttpServer PID=#{Process.pid}] WEBrick DoNotListen=#{webrick_opts[:DoNotListen].inspect}")

  server = WEBrick::HTTPServer.new(**webrick_opts)

  # Override WEBrick's signal traps now that `server` is available.
  # On INT/TERM: call server.shutdown (graceful), with a 1s hard-kill fallback.
  # Also stop BrowserManager so the chrome-devtools-mcp node process is killed
  # before this worker exits — otherwise it becomes an orphan and holds port 7070.
  shutdown_once = false
  shutdown_proc = proc do
    next if shutdown_once
    shutdown_once = true
    # Persist in-flight agent sessions BEFORE starting the forced-exit
    # timer, so any new messages added to @history since the last save
    # are on disk before the new worker reads them after a hot restart.
    interrupt_all_agents

    # Detach the inherited (shared) listen socket BEFORE WEBrick.shutdown
    # so that cleanup_listener does not call shutdown(SHUT_RDWR)+close on
    # it — that would propagate to every process sharing the underlying
    # kernel socket (Master + new worker), breaking subsequent accept()
    # on Linux. macOS's BSD stack tolerates this; Linux does not.
    if @inherited_socket && server.listeners.include?(@inherited_socket)
      server.listeners.delete(@inherited_socket)
      Clacky::Logger.info("[HttpServer PID=#{Process.pid}] detached inherited socket fd=#{@inherited_socket.fileno} before shutdown")
    end
    # Close the loopback listener we created in this worker so the port
    # is freed before the next worker starts (hot restart path).
    if @loopback_listener
      server.listeners.delete(@loopback_listener)
      @loopback_listener.close rescue nil
      @loopback_listener = nil
    end
    t1 = Thread.new { @channel_manager.stop rescue nil }
    t2 = Thread.new { Clacky::BrowserManager.instance.stop rescue nil }
    t3 = Thread.new { @mcp_registry&.shutdown rescue nil }
    t1.join(1.5)
    t2.join(1.5)
    t3.join(1.5)
    server.shutdown rescue nil
  end
  trap("INT")  { shutdown_proc.call }
  trap("TERM") { shutdown_proc.call }

  if @inherited_socket
    server.listeners << @inherited_socket
    Clacky::Logger.info("[HttpServer PID=#{Process.pid}] injected inherited fd=#{@inherited_socket.fileno} listeners=#{server.listeners.map(&:fileno).inspect}")
  else
    Clacky::Logger.info("[HttpServer PID=#{Process.pid}] standalone, WEBrick listeners=#{server.listeners.map(&:fileno).inspect}")
  end

  # When bound to a specific non-loopback address (e.g. 192.168.x.x),
  # local skills using 127.0.0.1 cannot reach the server. Attach an
  # extra loopback listener so child processes (curl in skills, MCP, etc.)
  # can always talk to the server via 127.0.0.1 without an access key.
  # Skipped for 0.0.0.0 (already covers loopback) and for loopback binds.
  @loopback_listener = nil
  if !@localhost_only && @host.to_s != "0.0.0.0"
    begin
      @loopback_listener = TCPServer.new("127.0.0.1", @port)
      @loopback_listener.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEADDR, true)
      server.listeners << @loopback_listener
      Clacky::Logger.info("[HttpServer PID=#{Process.pid}] added loopback listener fd=#{@loopback_listener.fileno} on 127.0.0.1:#{@port}")
    rescue Errno::EADDRINUSE, Errno::EACCES => e
      Clacky::Logger.warn("[HttpServer PID=#{Process.pid}] could not add loopback listener on 127.0.0.1:#{@port}: #{e.class}: #{e.message}")
      @loopback_listener = nil
    end
  end

  # Mount API + WebSocket handler (takes priority).
  # Use a custom Servlet so that DELETE/PUT/PATCH requests are not rejected
  # by WEBrick's default method whitelist before reaching our dispatcher.
  dispatcher = self
  servlet_class = Class.new(WEBrick::HTTPServlet::AbstractServlet) do
    define_method(:do_GET)     { |req, res| dispatcher.send(:dispatch, req, res) }
    define_method(:do_POST)    { |req, res| dispatcher.send(:dispatch, req, res) }
    define_method(:do_PUT)     { |req, res| dispatcher.send(:dispatch, req, res) }
    define_method(:do_DELETE)  { |req, res| dispatcher.send(:dispatch, req, res) }
    define_method(:do_PATCH)   { |req, res| dispatcher.send(:dispatch, req, res) }
    define_method(:do_OPTIONS) { |req, res| dispatcher.send(:dispatch, req, res) }
  end
  server.mount("/api", servlet_class)
  server.mount("/ws",  servlet_class)

  # Health check endpoint — no auth, minimal overhead.
  # Docker / orchestrators can probe this to decide container health.
  server.mount_proc("/health") do |_req, res|
    res.status          = 200
    res["Content-Type"] = "application/json"
    res.body            = '{"status":"ok"}'
  end

  # Mount static file handler for the entire web directory.
  # Use mount_proc so we can inject no-cache headers on every response,
  # preventing stale JS/CSS from being served after a gem update.
  #
  # Special case: GET / and GET /index.html are served with server-side
  # rendering — the {{BRAND_NAME}} placeholder is replaced before delivery
  # so the correct brand name appears on first paint with no JS flash.
  file_handler = WEBrick::HTTPServlet::FileHandler.new(server, WEB_ROOT,
                                                       FancyIndexing: false)
  index_html_path = File.join(WEB_ROOT, "index.html")

  server.mount_proc("/") do |req, res|
    if req.path == "/" || req.path == "/index.html"
      product_name = Clacky::BrandConfig.load.product_name || "OpenClacky"
      pure         = req.query["pure"] == "true"
      html = File.read(index_html_path)
                 .gsub("{{BRAND_NAME}}", product_name)
                 .gsub("{{EXT_SCRIPTS}}", pure ? "" : self.send(:webui_ext_script_tags))
      res.status                = 200
      res["Content-Type"]       = "text/html; charset=utf-8"
      res["Cache-Control"]      = "no-store"
      res["Pragma"]             = "no-cache"
      res.body                  = html
    elsif req.path.start_with?("/agent_ui/")
      self.send(:serve_agent_ui, req, res)
    elsif req.path.start_with?("/agent_avatar/")
      self.send(:serve_agent_avatar, req, res)
    elsif req.path.start_with?("/ext_ui/")
      self.send(:serve_ext_ui, req, res)
    else
      file_handler.service(req, res)
      res["Cache-Control"] = "no-store"
      res["Pragma"]        = "no-cache"
    end
  end

  # Auto-create a default session on startup
  create_default_session

  # Load api backends contributed by ext.yml containers into the shared
  # ApiExtension registry. Each unit mounts at /api/ext/<ext_id>/. Done
  # here (not at gem load) so handlers can resolve session_manager and
  # other host helpers as soon as they are wired up.
  Clacky::ApiExtensionLoader.load_all

  # Static verification of every ext.yml container: unknown keys, bad
  # scopes, dangling agent→panel references, layer-shadow warnings.
  # Errors from the loader itself are already surfaced elsewhere; this
  # pass covers the whole-program checks an author needs to see at boot.
  report_extension_issues

  # Start the background scheduler
  @scheduler.start
  puts "   Scheduler: #{@scheduler.schedules.size} task(s) loaded"

  # Reclaim orphaned Time Machine snapshots (sessions deleted earlier
  # without snapshot cleanup). Runs off-thread so startup stays fast.
  Thread.new do
    begin
      n = Clacky::SessionManager.cleanup_orphan_snapshots
      puts "   Snapshots: reclaimed #{n} orphan dir(s)" if n.positive?
    rescue StandardError => e
      Clacky::Logger.error("snapshot_cleanup_error", error: e)
    end
  end

  # Start IM channel adapters (non-blocking — each platform runs in its own thread)
  @channel_manager.start

  # Start browser MCP daemon if browser.yml is configured (non-blocking)
  @browser_manager.start

  server.start
end

#start_pending_task(session_id) ⇒ Object

Start the pending task for a session. Called when the client sends "run_task" over WS — by that point the client has already subscribed, so every broadcast will be delivered.



6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
 
# File 'lib/clacky/server/http_server.rb', line 6508

def start_pending_task(session_id)
  return unless @registry.exist?(session_id)

  session = @registry.get(session_id)
  prompt          = session[:pending_task]
  working_dir     = session[:pending_working_dir]
  display_message = session[:pending_display_message]
  return unless prompt  # nothing pending

  # Clear the pending fields so a re-connect doesn't re-run
  @registry.update(session_id, pending_task: nil, pending_working_dir: nil, pending_display_message: nil)

  agent = nil
  @registry.with_session(session_id) { |s| agent = s[:agent] }
  return unless agent

  # Surface a user message on screen before the agent starts thinking, so
  # programmatically-submitted tasks (e.g. meeting summarization) don't
  # appear as a thinking spinner with no preceding message. When a short
  # display_message is provided we show that instead of the full prompt.
  if display_message
    web_ui = nil
    @registry.with_session(session_id) { |s| web_ui = s[:ui] }
    web_ui&.show_user_message(display_message, source: :web)
  end

  run_agent_task(session_id, agent) { agent.run(prompt, display_text: display_message) }
end

#subscribe(session_id, conn) ⇒ Object

── WebSocket subscription management ─────────────────────────────────────



6647
6648
6649
6650
6651
6652
6653
6654
6655
 
# File 'lib/clacky/server/http_server.rb', line 6647

def subscribe(session_id, conn)
  @ws_mutex.synchronize do
    # Remove conn from any previous session subscription first,
    # so switching sessions never results in duplicate delivery.
    @ws_clients.each_value { |list| list.delete(conn) }
    @ws_clients[session_id] ||= []
    @ws_clients[session_id] << conn unless @ws_clients[session_id].include?(conn)
  end
end

#toggle_extension(req, res, action) ⇒ Object 



2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/clacky/server/http_server.rb', line 2646

def toggle_extension(req, res, action)
  id = parse_json_body(req)["id"].to_s
  container = extension_container(id)
  if container.nil?
    json_response(res, 404, { ok: false, error: "Not installed." })
    return
  end

  action == :disable ? Clacky::ExtensionLoader.disable!(id) : Clacky::ExtensionLoader.enable!(id)
  json_response(res, 200, { ok: true, id: id, disabled: action == :disable })
rescue StandardError => e
  json_response(res, 500, { ok: false, error: e.message })
end

#trigger_async_distribution_refresh! ⇒ Object

Fire a public-distribution refresh in a background Thread.

Used for installs that have a package_name configured via install.sh but haven't activated a license yet — they would otherwise never see the brand logo / theme / homepage_url until activation. See BrandConfig#refresh_distribution! for the end-to-end flow.

Contract mirrors #trigger_async_heartbeat!:

* At most one refresh Thread in flight process-wide.
* Caller never waits — Web UI first paint is not blocked on network.
* All exceptions are swallowed; a refresh failure must not crash the
server or leak through the web stack.


2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
 
# File 'lib/clacky/server/http_server.rb', line 2184

def trigger_async_distribution_refresh!
  BRAND_DIST_REFRESH_MUTEX.synchronize do
    if @@brand_dist_refresh_inflight
      Clacky::Logger.debug("[Brand] distribution refresh already in flight, skipping")
      return
    end
    @@brand_dist_refresh_inflight = true
  end

  Thread.new do
    Clacky::Logger.info("[Brand] async distribution refresh starting...")
    begin
      brand  = Clacky::BrandConfig.load
      result = brand.refresh_distribution!
      if result[:success]
        Clacky::Logger.info("[Brand] async distribution refresh OK")
      else
        Clacky::Logger.debug("[Brand] async distribution refresh skipped/failed — #{result[:message]}")
      end
      # Free-mode skill sync: branded + unactivated installs need their
      # creator's free skills auto-installed for the "no serial number" UX.
      brand.sync_free_skills_async!
    rescue StandardError => e
      Clacky::Logger.warn("[Brand] async distribution refresh raised: #{e.class}: #{e.message}")
    ensure
      BRAND_DIST_REFRESH_MUTEX.synchronize do
        @@brand_dist_refresh_inflight = false
      end
    end
  end
end

#trigger_async_heartbeat! ⇒ Object

Fire a heartbeat in a background Thread without blocking the caller.

Contract:

* Only one heartbeat Thread may be running at any moment across the
whole process. If one is already in flight, this call is a no-op.
* The caller never waits: it returns immediately after (at most)
spawning the Thread.
* The Thread rescues everything so a network failure cannot kill the
server or leak an exception through the web stack.


2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
 
# File 'lib/clacky/server/http_server.rb', line 2143

def trigger_async_heartbeat!
  BRAND_HEARTBEAT_MUTEX.synchronize do
    if @@brand_heartbeat_inflight
      Clacky::Logger.debug("[Brand] heartbeat already in flight, skipping")
      return
    end
    @@brand_heartbeat_inflight = true
  end

  Thread.new do
    Clacky::Logger.info("[Brand] async heartbeat starting...")
    begin
      brand  = Clacky::BrandConfig.load
      result = brand.heartbeat!
      if result[:success]
        Clacky::Logger.info("[Brand] async heartbeat OK")
      else
        Clacky::Logger.warn("[Brand] async heartbeat failed — #{result[:message]}")
      end
    rescue StandardError => e
      Clacky::Logger.warn("[Brand] async heartbeat raised: #{e.class}: #{e.message}")
    ensure
      BRAND_HEARTBEAT_MUTEX.synchronize do
        @@brand_heartbeat_inflight = false
      end
    end
  end
end

#unsubscribe(conn) ⇒ Object 



6657
6658
6659
6660
6661
 
# File 'lib/clacky/server/http_server.rb', line 6657

def unsubscribe(conn)
  @ws_mutex.synchronize do
    @ws_clients.each_value { |list| list.delete(conn) }
  end
end

#unsubscribe_all(session_id) ⇒ Object 



6663
6664
6665
 
# File 'lib/clacky/server/http_server.rb', line 6663

def unsubscribe_all(session_id)
  @ws_mutex.synchronize { @ws_clients.delete(session_id) }
end

#websocket_upgrade?(req) ⇒ Boolean

── WebSocket ─────────────────────────────────────────────────────────────

Returns:

  • (Boolean) 


6237
6238
6239
 
# File 'lib/clacky/server/http_server.rb', line 6237

def websocket_upgrade?(req)
  req["Upgrade"]&.downcase == "websocket"
end