mirror of
https://github.com/LostRuins/koboldcpp.git
synced 2026-05-19 08:00:25 +00:00
* fix: Propagate version tag to WebUI asset download in self-hosted CI * refactor: Apply suggestions from @CISC Co-authored-by: Sigbjørn Skjæret <sigbjorn.skjaeret@scala.com> * fix: Skip npm build when Node.js is not installed Avoid 'no such file or directory' errors on CI runners that lack Node.js. Check if npm is available via find_program before attempting npm install + npm run build. Falls back to HF Bucket download. * fix: Use + separator for ASSETS list to fix Windows build Replace fragile \; escaping with a + separator when passing the WebUI asset list via -DASSETS to the download script. On Windows, the \; escaping was not reliably preserved through the CMake build system, causing all asset filenames to be concatenated into one (e.g., 'index.html;bundle.js;bundle.css;loading.html' as a single file), which broke the HF Bucket download and subsequent xxd.cmake step. + is safe because it is not special in cmd.exe (unlike | which is a pipe operator), not special in CMake's -D argument parser, and not a valid Windows filename character. CMakeLists.txt joins assets with + and webui-download.cmake splits them back via regex. * fix: Validate HF_WEBUI_VERSION environment variable with regex Add input validation for the HF_WEBUI_VERSION env var to prevent CMake list separator or path-traversal issues in stamp filenames and download URLs. Rejects non-conforming characters early. * fix: Remove 'latest' fallback for HF_WEBUI_VERSION When needs.determine-tag.outputs.tag_name is empty, let CMake's default resolution handle it (empty -> git-based version lookup) instead of falling back to 'latest'. This ensures the sentinel stamp file is consistent with CMake's resolution logic. * fix: Demote checksum verification failure to warning instead of hard gate * fix: End line character --------- Co-authored-by: Sigbjørn Skjæret <sigbjorn.skjaeret@scala.com>
175 lines
6.6 KiB
CMake
175 lines
6.6 KiB
CMake
include_directories(${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR})
|
|
|
|
# server-context containing the core server logic, used by llama-server and CLI
|
|
|
|
set(TARGET server-context)
|
|
|
|
add_library(${TARGET} STATIC
|
|
server-chat.cpp
|
|
server-chat.h
|
|
server-task.cpp
|
|
server-task.h
|
|
server-queue.cpp
|
|
server-queue.h
|
|
server-common.cpp
|
|
server-common.h
|
|
server-context.cpp
|
|
server-context.h
|
|
server-tools.cpp
|
|
server-tools.h
|
|
)
|
|
|
|
if (BUILD_SHARED_LIBS)
|
|
set_target_properties(${TARGET} PROPERTIES POSITION_INDEPENDENT_CODE ON)
|
|
endif()
|
|
|
|
target_include_directories(${TARGET} PRIVATE ../mtmd)
|
|
target_include_directories(${TARGET} PRIVATE ${CMAKE_SOURCE_DIR})
|
|
target_link_libraries(${TARGET} PUBLIC llama-common mtmd ${CMAKE_THREAD_LIBS_INIT})
|
|
|
|
|
|
# llama-server executable
|
|
|
|
set(TARGET llama-server)
|
|
|
|
set(TARGET_SRCS
|
|
server.cpp
|
|
server-http.cpp
|
|
server-http.h
|
|
server-models.cpp
|
|
server-models.h
|
|
)
|
|
|
|
# Option to specify custom HF bucket for webui (defaults to llama-ui)
|
|
# Usage: cmake -B build -DLLAMA_WEBUI_HF_BUCKET=llama-ui
|
|
set(LLAMA_WEBUI_HF_BUCKET "llama-ui" CACHE STRING "Hugging Face bucket name for prebuilt webui assets")
|
|
|
|
if (LLAMA_BUILD_WEBUI)
|
|
set(PUBLIC_ASSETS
|
|
index.html
|
|
bundle.js
|
|
bundle.css
|
|
loading.html
|
|
)
|
|
|
|
# Determine source of webui assets (priority: local > HF Bucket)
|
|
set(WEBUI_SOURCE "")
|
|
set(WEBUI_SOURCE_DIR "")
|
|
|
|
# Priority 1: Check for local webui build output
|
|
set(LOCAL_WEBUI_DIR "${CMAKE_CURRENT_SOURCE_DIR}/public")
|
|
|
|
# Verify all required assets exist before declaring local source valid
|
|
set(ALL_ASSETS_PRESENT TRUE)
|
|
foreach(asset ${PUBLIC_ASSETS})
|
|
if(NOT EXISTS "${LOCAL_WEBUI_DIR}/${asset}")
|
|
set(ALL_ASSETS_PRESENT FALSE)
|
|
break()
|
|
endif()
|
|
endforeach()
|
|
|
|
if(ALL_ASSETS_PRESENT)
|
|
set(WEBUI_SOURCE "local")
|
|
set(WEBUI_SOURCE_DIR "${LOCAL_WEBUI_DIR}")
|
|
message(STATUS "WebUI: using local build from ${WEBUI_SOURCE_DIR}")
|
|
endif()
|
|
|
|
# Priority 2: Build-time asset provisioning (npm build → HF Bucket fallback)
|
|
if(NOT WEBUI_SOURCE_DIR)
|
|
# Environment variable takes precedence (e.g., from CI workflows)
|
|
if(DEFINED ENV{HF_WEBUI_VERSION})
|
|
set(HF_WEBUI_VERSION "$ENV{HF_WEBUI_VERSION}")
|
|
# Validate against allowed characters to prevent CMake list separator
|
|
# or path-traversal issues in stamp filenames and download URLs
|
|
if(NOT HF_WEBUI_VERSION MATCHES "^[A-Za-z0-9._-]+$")
|
|
message(FATAL_ERROR "WebUI: invalid HF_WEBUI_VERSION='${HF_WEBUI_VERSION}' - must match ^[A-Za-z0-9._-]+$")
|
|
endif()
|
|
message(STATUS "WebUI: using HF_WEBUI_VERSION from environment=${HF_WEBUI_VERSION}")
|
|
elseif(DEFINED LLAMA_BUILD_NUMBER)
|
|
set(HF_WEBUI_VERSION "b${LLAMA_BUILD_NUMBER}")
|
|
message(STATUS "WebUI: using LLAMA_BUILD_NUMBER=${HF_WEBUI_VERSION}")
|
|
else()
|
|
set(HF_WEBUI_VERSION "")
|
|
message(STATUS "WebUI: version not specified (will use HF 'latest')")
|
|
endif()
|
|
|
|
# Stamp file embeds the version tag so a changed build number triggers
|
|
# a fresh provision run on the next `cmake --build` without reconfiguring.
|
|
if("${HF_WEBUI_VERSION}" STREQUAL "")
|
|
set(WEBUI_VERSION_TAG "provisioned")
|
|
else()
|
|
set(WEBUI_VERSION_TAG "${HF_WEBUI_VERSION}")
|
|
endif()
|
|
set(WEBUI_STAMP "${CMAKE_CURRENT_BINARY_DIR}/.webui-${WEBUI_VERSION_TAG}.stamp")
|
|
|
|
# Join assets with + separator (safe across all platforms, unlike ; and |)
|
|
string(REPLACE ";" "+" PUBLIC_ASSETS_JOINED "${PUBLIC_ASSETS}")
|
|
|
|
add_custom_command(
|
|
OUTPUT ${WEBUI_STAMP}
|
|
COMMAND ${CMAKE_COMMAND}
|
|
"-DSOURCE_DIR=${PROJECT_SOURCE_DIR}"
|
|
"-DPUBLIC_DIR=${CMAKE_CURRENT_SOURCE_DIR}/public"
|
|
"-DHF_BUCKET=${LLAMA_WEBUI_HF_BUCKET}"
|
|
"-DHF_VERSION=${HF_WEBUI_VERSION}"
|
|
"-DHF_ENABLED=${LLAMA_USE_PREBUILT_WEBUI}"
|
|
"-DASSETS=${PUBLIC_ASSETS_JOINED}"
|
|
"-DSTAMP_FILE=${WEBUI_STAMP}"
|
|
"-DNPM_DIR=${CMAKE_CURRENT_SOURCE_DIR}/webui"
|
|
-P ${PROJECT_SOURCE_DIR}/scripts/webui-download.cmake
|
|
COMMENT "Building/provisioning WebUI assets (npm build -> HF Bucket fallback)"
|
|
)
|
|
|
|
set(WEBUI_SOURCE "provisioned")
|
|
set(WEBUI_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/public")
|
|
endif()
|
|
|
|
# Process assets from the determined source
|
|
if(WEBUI_SOURCE_DIR)
|
|
foreach(asset ${PUBLIC_ASSETS})
|
|
set(input "${WEBUI_SOURCE_DIR}/${asset}")
|
|
set(output "${CMAKE_CURRENT_BINARY_DIR}/${asset}.hpp")
|
|
list(APPEND TARGET_SRCS ${output})
|
|
|
|
if(WEBUI_SOURCE STREQUAL "local")
|
|
# Local build: files exist at configure time
|
|
if(NOT EXISTS "${input}")
|
|
message(FATAL_ERROR "WebUI asset not found: ${input}")
|
|
endif()
|
|
set(dependency "${input}")
|
|
else()
|
|
# HF Bucket: files are downloaded at build time
|
|
set(dependency "${WEBUI_STAMP}")
|
|
endif()
|
|
|
|
add_custom_command(
|
|
DEPENDS ${dependency}
|
|
OUTPUT "${output}"
|
|
COMMAND "${CMAKE_COMMAND}" "-DINPUT=${input}" "-DOUTPUT=${output}" -P "${PROJECT_SOURCE_DIR}/scripts/xxd.cmake"
|
|
)
|
|
set_source_files_properties(${output} PROPERTIES GENERATED TRUE)
|
|
endforeach()
|
|
|
|
add_definitions(-DLLAMA_BUILD_WEBUI)
|
|
add_definitions(-DLLAMA_WEBUI_DEFAULT_ENABLED=1)
|
|
message(STATUS "WebUI: embedded with source: ${WEBUI_SOURCE}")
|
|
else()
|
|
# WebUI source not found - issue warning but don't fail the build
|
|
# The server will still build but without webui embedded
|
|
message(WARNING "WebUI: no source available. Neither local build (tools/server/public/) nor HF Bucket download succeeded.")
|
|
message(WARNING "WebUI: building server without embedded WebUI. Set LLAMA_BUILD_WEBUI=OFF to suppress this warning.")
|
|
add_definitions(-DLLAMA_WEBUI_DEFAULT_ENABLED=0)
|
|
endif()
|
|
else()
|
|
# WebUI is disabled at build time
|
|
add_definitions(-DLLAMA_WEBUI_DEFAULT_ENABLED=0)
|
|
endif()
|
|
|
|
add_executable(${TARGET} ${TARGET_SRCS})
|
|
install(TARGETS ${TARGET} RUNTIME)
|
|
|
|
target_include_directories(${TARGET} PRIVATE ../mtmd)
|
|
target_include_directories(${TARGET} PRIVATE ${CMAKE_SOURCE_DIR})
|
|
target_link_libraries(${TARGET} PRIVATE server-context PUBLIC llama-common cpp-httplib ${CMAKE_THREAD_LIBS_INIT})
|
|
|
|
target_compile_features(${TARGET} PRIVATE cxx_std_17)
|