startup script

[WolfgangFahl]

see #2760

#!/bin/bash
# WF 2025-12-15
# dual backend scholia startup

# Configuration
SCHOLIA_CFG=$HOME/.scholia
SRC_DIR=$HOME/source/python

if [ -f $HOME/source/bash/mp/bash_messages ]
then	
  source $HOME/source/bash/mp/bash_messages
else
  # setup simpler versions of error success action and warn
  error() { echo "ERROR: $*"; exit 1; }
  success() { echo "SUCCESS: $*"; }
  action() { echo "ACTION: $*"; }
  warn() { echo "WARNING: $*"; }
fi

mkdir -p "$SCHOLIA_CFG"
mkdir -p "$SRC_DIR"

# Apply local patches for a given tag from $SCHOLIA_CFG/patches/<tag>
apply_patches() {
  local tag="$1"
  local repo_dir="$SRC_DIR/$tag"
  local patch_root="$SCHOLIA_CFG/patches"

  if [ ! -d "$repo_dir" ]; then
    warn "apply_patches: repo dir does not exist: $repo_dir"
    return 0
  fi

  if [ ! -d "$patch_root" ]; then
    error  "No patches found at ($patch_root). Skipping."
    return 0
  fi

  action "Applying patches for $tag from $patch_root"

  rsync -av \
    --exclude='.git' --exclude='*.patch' --exclude='*.diff' \
    "$patch_root"/ "$repo_dir"/
}


#
# Helper function to generate scholia.ini
# params
#  1: tag - e.g. scholia or scholia-qlever
#  2: backend - The backend to use (wdqs or qlever)
#  3: domain - where the backend runs
#
create_scholia_ini() {
  local tag="$1"
  local backend="$2"
  local domain="$3"
  local ini="$SRC_DIR/$tag/scholia.ini"
  
  action "Generating scholia.ini for $tag with $backend backend..."
  
  if [ ! -d "$SRC_DIR/$tag" ]
  then
    warn "scholia.ini generation needs existing $SRC_DIR/$tag"
    return
  fi

  # Append configuration based on backend
  case "$backend" in
    wdqs)
      cat <<EOF > "$ini"
# scholia.ini file generated at $(date)
# params: tag=$tag backend=$backend domain=$domain
[query-server]
sparql_endpoint = https://wdqs.$domain/sparql
sparql_editurl = https://wdqs.$domain/#
sparql_embedurl = https://wdqs.$domain/embed.html#
sparql_endpoint_name = $domain WDQS
EOF
      ;;

    qlever)
      cat <<EOF > "$ini"
# scholia.ini file generated at $(date)
# params: tag=$tag backend=$backend domain=$domain
[query-server]
sparql_endpoint = https://qlever-api.$domain
sparql_editurl = https://qlever.$domain/wikidata/?query=
sparql_embedurl = 
sparql_endpoint_name = $domain QLever
EOF
      ;;
      
    *)
      warn "Unknown backend '$backend'"
      ;;
  esac
}

#
# stop running scholia processes
# params
#  1: tag    - e.g. scholia / scholia-qlever
#  2: port   - e.g. 8100
#
stop() {
  local tag="$1"
  local port="$2"
  local pids=$(pgrep -f "scholia run --port=$port")
  
  if [ -z "$pids" ]; then
    action "No running $tag scholia processes found on port $port"
    return 0
  fi
  
  action "Killing running $tag scholia processes on port $port: $pids"
  kill $pids
  sleep 1
  
  # Force kill if still running
  pids=$(pgrep -f "scholia run --port=$port")
  if [ -n "$pids" ]; then
    warn "Force killing $tag processes: $pids"
    kill -9 $pids
  fi
}
#
# start the given scholia version
# params
#  1: tag    - e.g. scholia / scholia-qlever
#  2: branch - e.g. main / qlever
#  3: port   - e.g. 8100
#  4: repo   - git url
#
start() {
  local tag="$1"
  local branch="$2"
  local port="$3"
  local repo="$4"
  
  local log_file="$SCHOLIA_CFG/$tag.log"
  # does not work with patches
  #local cmd=$(which scholia)

  # does not work with scholia.ini
  #local cmd="python3 runserver.py"
  #local options=""

  local cmd="python"
  local options="-m scholia run --port=$port"

  action "Setting up $tag on branch '$branch'..."
  
  cd "$SRC_DIR" || exit 1

  # Handle Git: Clone or Pull
  if [ ! -d "$tag" ]; then
    action "Cloning $repo..."
    git clone "$repo" "$tag"
    cd "$tag" || exit 1
    git checkout "$branch"
  else
    cd "$tag" || exit 1
    action "Pulling latest changes..."
    git fetch origin
    git checkout "$branch"
    git pull origin "$branch"
  fi

  # Handle Python Venv
  if [ ! -d ".venv" ]; then
    action "Creating virtual environment... in $(pwd)"
    python3 -m venv .venv
  fi
  
  source .venv/bin/activate

  # apply patches 
  apply_patches $tag
  # uncomment to debug patches that might be missing
  #grep port scholia/__main__.py

  # Install dependencies
  action "pip installing development mode $tag ..."
  pip install -e . >>"$log_file" 2>&1


  # Start in background
  action "Starting server on port $port with nohup..."
  action "$cmd $options"
  action "Logs redirected to: $log_file"
  
  # Assumes runserver.py is written to accept the port as the first argument
  nohup "$cmd" $options > "$log_file" 2>&1 &
  
  PID=$!
  success "$tag started with PID: $PID"
}

# --- Execution ---

# 1. Standard Scholia
create_scholia_ini scholia wdqs bitplan.com
stop scholia 8100
start scholia main 8100 https://github.com/WDscholia/scholia 

# 2. Q Lever Backend Scholia
create_scholia_ini scholia-qlever qlever bitplan.com
stop scholia-qlever 8101
start scholia-qlever qlever 8101 https://github.com/ad-freiburg/scholia.git