Refactor update_libchdb.sh for system-wide install and improve README documentation

Author: JakkuSakura

.gitignore

@@ -2,7 +2,7 @@
 Cargo.lock
 *.tar.gz
 *.so
-*.h
+chdb.h
 var
 udf
 *.parquet

README.md

@@ -3,21 +3,42 @@
 [![Rust](https://github.com/chdb-io/chdb-rust/actions/workflows/rust.yml/badge.svg)](https://github.com/chdb-io/chdb-rust/actions/workflows/rust.yml)
 
 # chdb-rust <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/d/d5/Rust_programming_language_black_logo.svg/1024px-Rust_programming_language_black_logo.svg.png" height=20 />
+
 Experimental [chDB](https://github.com/chdb-io/chdb) FFI bindings for Rust
 
-### Status
+## Status
 
 - Experimental, unstable, subject to changes
-- Requires [`libchdb`](https://github.com/chdb-io/chdb) on the system
+- Requires [`libchdb`](https://github.com/chdb-io/chdb) on the system. You can install the compatible version from
+  `install_libchdb.sh`
+
+## Usage
+
+### Install libchdb
+
+You can install it system-wide
+
+```bash
+./update_libchdb.sh --global
+```
+
+or use it in a local directory
+
+```bash
+./update_libchdb.sh --local
+```
+
+### Build
 
-#### Build binding
 ```bash
-./update_libchdb.sh
 RUST_BACKTRACE=full cargo build --verbose
+
 ```
 
 ### Run tests
+
 `cargo test`
 
 ### Examples
+
 See `tests` directory.

build.rs

@@ -16,7 +16,7 @@ fn main() {
     let bindings = bindgen::Builder::default()
         // The input header we would like to generate
         // bindings for.
-        .header("chdb.h")
+        .header("wrapper.h")
         // Tell cargo to invalidate the built crate whenever any of the
         // included header files changed.
         .parse_callbacks(Box::new(bindgen::CargoCallbacks::new()))

update_libchdb.sh

@@ -1,13 +1,37 @@
-
 #!/bin/bash
+
 set -e
-cd $(dirname "${BASH_SOURCE[0]}")
+
+# Check for necessary tools
+command -v curl >/dev/null 2>&1 || { echo >&2 "curl is required but it's not installed. Aborting."; exit 1; }
+command -v tar >/dev/null 2>&1 || { echo >&2 "tar is required but it's not installed. Aborting."; exit 1; }
+
+# Function to download and extract the file
+download_and_extract() {
+    local url=$1
+    local file="libchdb.tar.gz"
+
+    echo "Attempting to download $PLATFORM from $url"
+
+    # Download the file with a retry logic
+    if curl -L -o "$file" "$url"; then
+        echo "Download successful."
+
+        # Optional: Verify download integrity here, if checksums are provided
+
+        # Untar the file
+        if tar -xzf "$file"; then
+            echo "Extraction successful."
+            return 0
+        fi
+    fi
+    return 1
+}
 
 # Get the newest release version
-# LATEST_RELEASE=$(curl --silent "https://api.github.com/repos/chdb-io/chdb/releases/latest" | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')
 LATEST_RELEASE=v2.1.1
 
-# Download the correct version based on the platform
+# Select the correct package based on OS and architecture
 case "$(uname -s)" in
     Linux)
         if [[ $(uname -m) == "aarch64" ]]; then
@@ -29,18 +53,79 @@ case "$(uname -s)" in
         ;;
 esac
 
+# Main download URL
 DOWNLOAD_URL="https://github.com/chdb-io/chdb/releases/download/$LATEST_RELEASE/$PLATFORM"
+FALLBACK_URL="https://github.com/chdb-io/chdb/releases/latest/download/$PLATFORM"
+
+# Try the main download URL first
+if ! download_and_extract "$DOWNLOAD_URL"; then
+    echo "Retrying with fallback URL..."
+    if ! download_and_extract "$FALLBACK_URL"; then
+        echo "Both primary and fallback downloads failed. Aborting."
+        exit 1
+    fi
+fi
+
+# check if --local flag is passed
+if [[ "$1" == "--local" ]]; then
+    # Set execute permission for libchdb.so
+    chmod +x libchdb.so
+
+    # Clean up
+    rm -f libchdb.tar.gz
+    exit 0
+elif [[ "$1" == "--global" ]]; then
+  # If current uid is not 0, check if sudo is available and request the user to input the password
+  if [[ $EUID -ne 0 ]]; then
+      command -v sudo >/dev/null 2>&1 || { echo >&2 "This script requires sudo privileges but sudo is not installed. Aborting."; exit 1; }
+      echo "Installation requires administrative access. You will be prompted for your password."
+  fi
+
+  # Define color messages if terminal supports them
+  if [[ -t 1 ]]; then
+      RED='\033[0;31m'
+      GREEN='\033[0;32m'
+      NC='\033[0m'  # No Color
+      REDECHO() { echo -e "${RED}$@${NC}"; }
+      GREENECHO() { echo -e "${GREEN}$@${NC}"; }
+      ENDECHO() { echo -ne "${NC}"; }
+  else
+      REDECHO() { echo "$@"; }
+      GREENECHO() { echo "$@"; }
+      ENDECHO() { :; }
+  fi
+
+  # Use sudo if not running as root
+  SUDO=''
+  if [[ $EUID -ne 0 ]]; then
+      SUDO='sudo'
+      GREENECHO "\nYou will be asked for your sudo password to install:"
+      echo "    libchdb.so to /usr/local/lib/"
+      echo "    chdb.h to /usr/local/include/"
+  fi
+
+  # Make sure the library and header directory exists
+  ${SUDO} mkdir -p /usr/local/lib /usr/local/include || true
 
-echo "Downloading $PLATFORM from $DOWNLOAD_URL"
+  # Install the library and header file
+  ${SUDO} /bin/cp libchdb.so /usr/local/lib/
+  ${SUDO} /bin/cp chdb.h /usr/local/include/
 
-# Download the file
-curl -L -o libchdb.tar.gz $DOWNLOAD_URL
+  # Set execute permission for libchdb.so
+  ${SUDO} chmod +x /usr/local/lib/libchdb.so
 
-# Untar the file
-tar -xzf libchdb.tar.gz
+  # Update library cache (Linux specific)
+  if [[ "$(uname -s)" == "Linux" ]]; then
+      ${SUDO} ldconfig
+  fi
 
-# Set execute permission for libchdb.so
-chmod +x libchdb.so
+  # Clean up
+  rm -f libchdb.tar.gz libchdb.so chdb.h
 
-# Clean up
-rm -f libchdb.tar.gz
+  GREENECHO "Installation completed successfully." ; ENDECHO
+  GREENECHO "If any error occurred, please report it to:" ; ENDECHO
+  GREENECHO "    https://github.com/chdb-io/chdb/issues/new/choose" ; ENDECHO
+else
+  echo "Invalid option. Use --local to install locally or --global to install globally."
+  exit 1
+fi

wrapper.h

@@ -0,0 +1 @@
+#include "chdb.h"