librats 0.7.2 → 0.9.0

package/README.md

@@ -117,6 +117,12 @@ client.onFileProgress((transferId, progressPercent, status) => {
   console.log(`Transfer ${transferId}: ${progressPercent}% - ${status}`);
 });
 
+// Accept incoming transfer offers (transfers are push-only)
+client.onFileRequest((peerId, transferId, filename) => {
+  console.log(`Incoming offer "${filename}" from ${peerId}`);
+  client.acceptFileTransfer(transferId, `./downloads/${filename}`);
+});
+
 client.start();
 
 // Send a file to a peer
@@ -181,10 +187,8 @@ client.publishJsonToTopic('general-chat', JSON.stringify(message));
 #### File Transfer
 
 - `sendFile(peerId: string, filePath: string, remoteFilename?: string): string | null` - Send file
-- `sendDirectory(peerId: string, dirPath: string, remoteDirName?: string, recursive?: boolean): string | null` - Send directory
-- `requestFile(peerId: string, remoteFilePath: string, localPath: string): string | null` - Request file
-- `requestDirectory(peerId: string, remoteDirPath: string, localDirPath: string, recursive?: boolean): string | null` - Request directory
-- `acceptFileTransfer(transferId: string, localPath: string): boolean` - Accept file transfer
+- `sendDirectory(peerId: string, dirPath: string, remoteDirName?: string): string | null` - Send directory (always recursive)
+- `acceptFileTransfer(transferId: string, localPath: string): boolean` - Accept an incoming file/directory transfer offer
 - `rejectFileTransfer(transferId: string, reason?: string): boolean` - Reject file transfer
 - `cancelFileTransfer(transferId: string): boolean` - Cancel file transfer
 - `pauseFileTransfer(transferId: string): boolean` - Pause file transfer
@@ -223,6 +227,7 @@ client.publishJsonToTopic('general-chat', JSON.stringify(message));
 - `onJson(callback: (peerId: string, jsonStr: string) => void): void` - Set JSON message callback
 - `onDisconnect(callback: (peerId: string) => void): void` - Set disconnect callback
 - `onFileProgress(callback: (transferId: string, progressPercent: number, status: string) => void): void` - Set file progress callback
+- `onFileRequest(callback: (peerId: string, transferId: string, filename: string) => void): void` - Set incoming transfer offer callback (respond with `acceptFileTransfer`/`rejectFileTransfer`)
 
 ### Utility Functions
 

package/lib/index.d.ts

@@ -225,33 +225,13 @@ export class RatsClient {
   sendFile(peerId: string, filePath: string, remoteFilename?: string): string | null;
 
   /**
-   * Send a directory to a peer
+   * Send a directory to a peer. Directory transfers are always recursive.
    * @param peerId - ID of the peer to send to
    * @param dirPath - Local path to the directory
    * @param remoteDirName - Optional directory name on remote side
-   * @param recursive - Whether to send recursively (default: true)
    * @returns Transfer ID, or null if failed
    */
-  sendDirectory(peerId: string, dirPath: string, remoteDirName?: string, recursive?: boolean): string | null;
-
-  /**
-   * Request a file from a peer
-   * @param peerId - ID of the peer to request from
-   * @param remoteFilePath - Path to the file on remote side
-   * @param localPath - Local path where file should be saved
-   * @returns Transfer ID, or null if failed
-   */
-  requestFile(peerId: string, remoteFilePath: string, localPath: string): string | null;
-
-  /**
-   * Request a directory from a peer
-   * @param peerId - ID of the peer to request from
-   * @param remoteDirPath - Path to the directory on remote side
-   * @param localDirPath - Local path where directory should be saved
-   * @param recursive - Whether to request recursively (default: true)
-   * @returns Transfer ID, or null if failed
-   */
-  requestDirectory(peerId: string, remoteDirPath: string, localDirPath: string, recursive?: boolean): string | null;
+  sendDirectory(peerId: string, dirPath: string, remoteDirName?: string): string | null;
 
   /**
    * Accept an incoming file transfer
@@ -668,6 +648,13 @@ export class RatsClient {
    * @param callback - Function to call with transfer ID, progress percentage, and status
    */
   onFileProgress(callback: (transferId: string, progressPercent: number, status: string) => void): void;
+
+  /**
+   * Set callback for incoming file/directory transfer offers. Respond by calling
+   * acceptFileTransfer() or rejectFileTransfer() with the given transfer ID.
+   * @param callback - Function to call with peer ID, transfer ID, and the offered file/directory name
+   */
+  onFileRequest(callback: (peerId: string, transferId: string, filename: string) => void): void;
 }
 
 // ============ Utility Functions ============

package/native-src/CMakeLists.txt

@@ -1,53 +1,63 @@
-cmake_minimum_required(VERSION 3.10)
-
-# Get version from git
-find_package(Git QUIET)
-if(GIT_FOUND)
-    # Get the current git tag/commit
-    execute_process(
-        COMMAND ${GIT_EXECUTABLE} describe --tags --always --dirty
-        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        OUTPUT_VARIABLE GIT_DESCRIBE
-        OUTPUT_STRIP_TRAILING_WHITESPACE
-        ERROR_QUIET
-    )
-    
-    # Extract version from git tag (format: v1.2.3 or 1.2.3)
-    execute_process(
-        COMMAND ${GIT_EXECUTABLE} describe --tags --abbrev=0
-        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        OUTPUT_VARIABLE GIT_TAG
-        OUTPUT_STRIP_TRAILING_WHITESPACE
-        ERROR_QUIET
-    )
-    
-    # Get commit count (revision number)
-    execute_process(
-        COMMAND ${GIT_EXECUTABLE} rev-list --count HEAD
-        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        OUTPUT_VARIABLE GIT_REVISION_COUNT
-        OUTPUT_STRIP_TRAILING_WHITESPACE
-        ERROR_QUIET
-    )
-    
-    # Parse version components
-    if(GIT_TAG MATCHES "^v?([0-9]+)\\.([0-9]+)\\.([0-9]+)")
-        set(VERSION_MAJOR ${CMAKE_MATCH_1})
-        set(VERSION_MINOR ${CMAKE_MATCH_2})
-        set(VERSION_PATCH ${CMAKE_MATCH_3})
+cmake_minimum_required(VERSION 3.14)
+
+# Allow consumers (vcpkg/Conan/source tarballs) to bypass git lookup by
+# passing -DRATS_VERSION_OVERRIDE=X.Y.Z on the configure line.
+if(DEFINED RATS_VERSION_OVERRIDE AND RATS_VERSION_OVERRIDE MATCHES "^([0-9]+)\\.([0-9]+)\\.([0-9]+)$")
+    set(VERSION_MAJOR ${CMAKE_MATCH_1})
+    set(VERSION_MINOR ${CMAKE_MATCH_2})
+    set(VERSION_PATCH ${CMAKE_MATCH_3})
+    set(GIT_DESCRIBE "${RATS_VERSION_OVERRIDE}")
+    set(GIT_REVISION_COUNT 0)
+else()
+    # Get version from git
+    find_package(Git QUIET)
+    if(GIT_FOUND AND EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/.git")
+        # Get the current git tag/commit
+        execute_process(
+            COMMAND ${GIT_EXECUTABLE} describe --tags --always --dirty
+            WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+            OUTPUT_VARIABLE GIT_DESCRIBE
+            OUTPUT_STRIP_TRAILING_WHITESPACE
+            ERROR_QUIET
+        )
+
+        # Extract version from git tag (format: v1.2.3 or 1.2.3)
+        execute_process(
+            COMMAND ${GIT_EXECUTABLE} describe --tags --abbrev=0
+            WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+            OUTPUT_VARIABLE GIT_TAG
+            OUTPUT_STRIP_TRAILING_WHITESPACE
+            ERROR_QUIET
+        )
+
+        # Get commit count (revision number)
+        execute_process(
+            COMMAND ${GIT_EXECUTABLE} rev-list --count HEAD
+            WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+            OUTPUT_VARIABLE GIT_REVISION_COUNT
+            OUTPUT_STRIP_TRAILING_WHITESPACE
+            ERROR_QUIET
+        )
+
+        # Parse version components
+        if(GIT_TAG MATCHES "^v?([0-9]+)\\.([0-9]+)\\.([0-9]+)")
+            set(VERSION_MAJOR ${CMAKE_MATCH_1})
+            set(VERSION_MINOR ${CMAKE_MATCH_2})
+            set(VERSION_PATCH ${CMAKE_MATCH_3})
+        else()
+            # Fallback to default version
+            set(VERSION_MAJOR 1)
+            set(VERSION_MINOR 0)
+            set(VERSION_PATCH 0)
+        endif()
     else()
-        # Fallback to default version
+        # Fallback when git is not available (e.g. source tarball builds)
         set(VERSION_MAJOR 1)
         set(VERSION_MINOR 0)
         set(VERSION_PATCH 0)
+        set(GIT_DESCRIBE "unknown")
+        set(GIT_REVISION_COUNT 0)
     endif()
-else()
-    # Fallback when git is not available
-    set(VERSION_MAJOR 1)
-    set(VERSION_MINOR 0)
-    set(VERSION_PATCH 0)
-    set(GIT_DESCRIBE "unknown")
-    set(GIT_REVISION_COUNT 0)
 endif()
 
 # Set build number to revision count (commit count)
@@ -129,6 +139,7 @@ set(LIBRARY_SOURCES
     src/krpc.cpp
     src/krpc.h
     src/librats.cpp
+    src/librats_discovery.cpp
     src/librats_reconnection.cpp
     src/librats_logging.cpp
     src/librats_encryption.cpp
@@ -136,6 +147,7 @@ set(LIBRARY_SOURCES
     src/librats_gossipsub.cpp
     src/librats_mdns.cpp
     src/librats_persistence.cpp
+    src/librats_statistic.cpp
     src/librats.h
     src/sha1.cpp
     src/sha1.h
@@ -157,13 +169,17 @@ set(LIBRARY_SOURCES
     src/rats_export.h
     ${PROJECT_BINARY_DIR}/src/version.h
 
-# Buffer utilities for bittorrent and file transfer
+# Buffer utilities for async I/O, file transfer, and bittorrent
     src/receive_buffer.h
     src/receive_buffer.cpp
     src/chained_send_buffer.h
     src/chained_send_buffer.cpp
 
-# Cypto algorithms including Noise Protocol needed
+# Platform-optimal I/O multiplexing (epoll/kqueue/IOCP)
+    src/io_poller.h
+    src/io_poller.cpp
+
+# Crypto algorithms including Noise Protocol
     src/crypto/curve25519.c
     src/crypto/curve25519.h
     src/crypto/chacha.c
@@ -273,9 +289,21 @@ endif()
 # Enable Position Independent Code for static library (required for linking into shared objects)
 set_target_properties(rats PROPERTIES POSITION_INDEPENDENT_CODE ON)
 
-# Include directories
-target_include_directories(rats PUBLIC ${PROJECT_BINARY_DIR}/src src)
-target_include_directories(rats PUBLIC ${PROJECT_SOURCE_DIR}/src/crypto)
+# GNUInstallDirs supplies CMAKE_INSTALL_INCLUDEDIR / LIBDIR / BINDIR. Include
+# it unconditionally so the INSTALL_INTERFACE generator expression below
+# resolves correctly even when RATS_INSTALL is later disabled.
+include(GNUInstallDirs)
+
+# Include directories. INSTALL_INTERFACE entries are only consumed via the
+# exported target, so they are safe to declare even when RATS_INSTALL is OFF.
+target_include_directories(rats
+    PUBLIC
+        $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/src>
+        $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/src/crypto>
+        $<BUILD_INTERFACE:${PROJECT_BINARY_DIR}/src>
+        $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/librats>
+        $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/librats/crypto>
+)
 
 # Find and link threading support
 find_package(Threads REQUIRED)
@@ -430,6 +458,8 @@ if(RATS_BUILD_TESTS)
         tests/test_stun.cpp
         tests/test_turn.cpp
         tests/test_ice.cpp
+# I/O poller abstraction (epoll/kqueue/IOCP)
+        tests/test_io_poller.cpp
 # Buffer utilities for file transfer and bittorrent
         tests/test_receive_buffer.cpp
         tests/test_chained_send_buffer.cpp
@@ -505,4 +535,56 @@ endif()
 # Examples (basic examples always built; BT examples require RATS_SEARCH_FEATURES)
 if(RATS_BUILD_EXAMPLES)
     add_subdirectory(examples)
+endif()
+
+# -----------------------------------------------------------------------------
+# Install / export configuration (consumed by vcpkg, Conan, and find_package)
+# -----------------------------------------------------------------------------
+option(RATS_INSTALL "Generate install rules and package config" ON)
+
+if(RATS_INSTALL)
+    include(CMakePackageConfigHelpers)
+
+    install(TARGETS rats
+        EXPORT ratsTargets
+        ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+        RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+        INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/librats
+    )
+
+    # Headers form a tightly coupled graph (librats.h pulls in dht/krpc/bencode/
+    # bt_*/storage/io_poller/etc.), so install the whole header tree under
+    # include/librats/. .cpp / .c / .in files are excluded.
+    install(DIRECTORY ${PROJECT_SOURCE_DIR}/src/
+        DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/librats
+        FILES_MATCHING
+            PATTERN "*.h"
+            PATTERN "*.hpp"
+    )
+    install(FILES ${PROJECT_BINARY_DIR}/src/version.h
+        DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/librats
+    )
+
+    install(EXPORT ratsTargets
+        FILE ratsTargets.cmake
+        NAMESPACE rats::
+        DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/rats
+    )
+
+    configure_package_config_file(
+        ${PROJECT_SOURCE_DIR}/cmake/ratsConfig.cmake.in
+        ${PROJECT_BINARY_DIR}/cmake/ratsConfig.cmake
+        INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/rats
+    )
+    write_basic_package_version_file(
+        ${PROJECT_BINARY_DIR}/cmake/ratsConfigVersion.cmake
+        VERSION ${PROJECT_VERSION}
+        COMPATIBILITY SameMajorVersion
+    )
+    install(FILES
+        ${PROJECT_BINARY_DIR}/cmake/ratsConfig.cmake
+        ${PROJECT_BINARY_DIR}/cmake/ratsConfigVersion.cmake
+        DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/rats
+    )
 endif()

package/native-src/cmake/ratsConfig.cmake.in

@@ -0,0 +1,8 @@
+@PACKAGE_INIT@
+
+include(CMakeFindDependencyMacro)
+find_dependency(Threads)
+
+include("${CMAKE_CURRENT_LIST_DIR}/ratsTargets.cmake")
+
+check_required_components(rats)