Matrix¶

#!/usr/bin/env bash
#
# update-gifproxy.sh
#
# Checks upstream for changes, replays the local m.image patch on top,
# rebuilds, restarts, and verifies. Rolls back the binary if the new one
# fails its health check.
#
# The local patch MUST be committed to git for this to work -- the rebase
# is what carries it forward. Run with no arguments to check and apply.
#
# Usage:
#   ./update-gifproxy.sh            check for updates, prompt, apply
#   ./update-gifproxy.sh --check    check only, report, change nothing
#   ./update-gifproxy.sh --force    rebuild and restart even if up to date

set -euo pipefail

REPO="/opt/giphytenormatrixproxy"
BUILD_SUBDIR="giphytenormatrixproxy"     # where go.mod lives
BINARY="${REPO}/gifproxy"
SERVICE="gifproxy"
PORT="8090"
GOPATH_BIN="/usr/local/go/bin"

# Strings that must be present in the source after a rebase. If any are
# missing, the local patch was lost and the build is aborted.
PATCH_MARKERS=(
  "notify_capabilities"
  "send_event"
  "sendStickerLegacy"
  "Math.round"
)

GREEN=$'\033[0;32m'; RED=$'\033[0;31m'; YELLOW=$'\033[0;33m'
BOLD=$'\033[1m'; RESET=$'\033[0m'

ok()   { printf '%s✓%s %s\n' "$GREEN" "$RESET" "$*"; }
warn() { printf '%s!%s %s\n' "$YELLOW" "$RESET" "$*" >&2; }
die()  { printf '%s✗%s %s\n' "$RED" "$RESET" "$*" >&2; exit 1; }

export PATH="${PATH}:${GOPATH_BIN}"

MODE="apply"
case "${1:-}" in
  --check) MODE="check" ;;
  --force) MODE="force" ;;
  "")      ;;
  *)       die "Unknown argument: $1 (use --check or --force)" ;;
esac

command -v git >/dev/null || die "git not found."
command -v go  >/dev/null || die "go not found. Is ${GOPATH_BIN} correct?"
[[ -d "$REPO/.git" ]] || die "$REPO is not a git checkout."

cd "$REPO"

# ---------------------------------------------------------------------------
# Refuse to run with uncommitted work -- the rebase would eat it
# ---------------------------------------------------------------------------

if [[ -n "$(git status --porcelain)" ]]; then
  warn "You have uncommitted changes in ${REPO}:"
  git status --short
  echo
  die "Commit them first:  git add -A && git commit -m 'local changes'"
fi

# ---------------------------------------------------------------------------
# Check upstream
# ---------------------------------------------------------------------------

echo "Fetching upstream ..."
git fetch --quiet origin

BRANCH="$(git rev-parse --abbrev-ref HEAD)"
UPSTREAM="origin/$(git rev-parse --abbrev-ref --symbolic-full-name '@{u}' 2>/dev/null | sed 's|^origin/||' || echo master)"

BEHIND="$(git rev-list --count "HEAD..${UPSTREAM}" 2>/dev/null || echo 0)"
AHEAD="$(git rev-list --count "${UPSTREAM}..HEAD" 2>/dev/null || echo 0)"

echo
echo "  branch:   ${BRANCH}"
echo "  upstream: ${UPSTREAM}"
echo "  local commits (your patch): ${AHEAD}"
echo "  new upstream commits:       ${BEHIND}"
echo

if [[ "$AHEAD" == "0" ]]; then
  warn "No local commits found. Your m.image patch may not be committed,"
  warn "which means an update would silently discard it."
fi

if [[ "$BEHIND" == "0" ]]; then
  ok "Already up to date."
  if [[ "$MODE" != "force" ]]; then
    exit 0
  fi
  echo "Continuing anyway (--force)."
else
  echo "${BOLD}New upstream commits:${RESET}"
  git --no-pager log --oneline --no-decorate "HEAD..${UPSTREAM}" | sed 's/^/  /'
  echo

  # Flag changes to the file carrying the local patch.
  if git diff --name-only "HEAD..${UPSTREAM}" | grep -q 'index\.html'; then
    warn "Upstream modified index.html -- the file your patch lives in."
    warn "A rebase conflict is likely. Resolve carefully."
    echo
  fi

  if [[ "$MODE" == "check" ]]; then
    echo "Check-only mode; nothing applied."
    exit 0
  fi

  read -rp "Apply these updates and rebuild? [y/N] " REPLY
  [[ "$REPLY" =~ ^[Yy]$ ]] || { echo "Aborted."; exit 0; }
fi

# ---------------------------------------------------------------------------
# Rebase the local patch on top of upstream
# ---------------------------------------------------------------------------

PREV_HEAD="$(git rev-parse HEAD)"

if [[ "$BEHIND" != "0" ]]; then
  echo "Rebasing local patch onto ${UPSTREAM} ..."
  if ! git rebase "${UPSTREAM}"; then
    git rebase --abort || true
    echo
    die "Rebase conflict. Nothing changed. Resolve by hand:
       cd ${REPO}
       git rebase ${UPSTREAM}
       # fix conflicts in index.html, then:
       git add -A && git rebase --continue
     Then re-run this script with --force."
  fi
  ok "Rebase clean."
fi

# ---------------------------------------------------------------------------
# Confirm the patch survived
# ---------------------------------------------------------------------------

echo "Verifying local patch is still present ..."
MISSING=()
for marker in "${PATCH_MARKERS[@]}"; do
  if ! grep -rq "$marker" "${REPO}/${BUILD_SUBDIR}"/*.html 2>/dev/null; then
    MISSING+=("$marker")
  fi
done

if (( ${#MISSING[@]} > 0 )); then
  git reset --hard "$PREV_HEAD"
  die "Patch markers missing after rebase: ${MISSING[*]}
     Rolled back to ${PREV_HEAD}. Nothing was rebuilt."
fi
ok "All patch markers present."

# ---------------------------------------------------------------------------
# Build
# ---------------------------------------------------------------------------

BACKUP="${BINARY}.prev"
[[ -f "$BINARY" ]] && cp -f "$BINARY" "$BACKUP"

echo "Building ..."
cd "${REPO}/${BUILD_SUBDIR}"
if ! go build -o "${BINARY}.new" . ; then
  cd "$REPO"
  git reset --hard "$PREV_HEAD"
  die "Build failed. Source rolled back; running binary untouched."
fi
mv -f "${BINARY}.new" "$BINARY"
ok "Built."

# ---------------------------------------------------------------------------
# Restart and health check
# ---------------------------------------------------------------------------

echo "Restarting ${SERVICE} ..."
systemctl restart "$SERVICE"
sleep 2

HEALTHY=true

if ! systemctl is-active --quiet "$SERVICE"; then
  HEALTHY=false
  warn "Service is not active."
fi

if ! curl -sf "localhost:${PORT}/_matrix/key/v2/server" >/dev/null; then
  HEALTHY=false
  warn "Federation key endpoint did not respond."
fi

# The served HTML is embedded in the binary, so this proves the rebuild
# actually picked up the patched source.
if ! curl -sf "localhost:${PORT}/" | grep -q "notify_capabilities"; then
  HEALTHY=false
  warn "Served HTML does not contain the patch. Build did not embed it."
fi

if [[ "$HEALTHY" != true ]]; then
  echo
  warn "Health check failed. Rolling back."
  if [[ -f "$BACKUP" ]]; then
    mv -f "$BACKUP" "$BINARY"
    systemctl restart "$SERVICE"
    warn "Previous binary restored. Source is at the new commit --"
    warn "run 'git reset --hard ${PREV_HEAD}' in ${REPO} to revert that too."
  fi
  journalctl -u "$SERVICE" -n 30 --no-pager
  exit 1
fi

rm -f "$BACKUP"

ok "Service healthy on port ${PORT}."
echo
echo "${BOLD}Remaining manual step:${RESET} purge the Cloudflare cache for"
echo "gifs.hylianux.com, then hard-reload Element (Ctrl-Shift-R)."
echo

<#
.SYNOPSIS
    Registers the GIF picker widget on a Matrix account.

.DESCRIPTION
    Writes the `m.widgets` account data event via the Matrix client-server API.
    This is per-user account data stored on the homeserver, so it follows the
    user to every device and every Element instance they log into. It only
    needs to be run once per person.

.PARAMETER Remove
    Unregisters the picker instead of installing it.

.EXAMPLE
    .\set-gif-picker.ps1

.EXAMPLE
    .\set-gif-picker.ps1 -Remove

.NOTES
    Works on Windows PowerShell 5.1 and PowerShell 7+.
    If Windows blocks the script, run it as:
        powershell -ExecutionPolicy Bypass -File .\set-gif-picker.ps1
#>

[CmdletBinding()]
param(
    [switch]$Remove
)

Set-StrictMode -Version Latest
$ErrorActionPreference = 'Stop'

# ---------------------------------------------------------------------------
# Site configuration -- edit these to match your deployment
# ---------------------------------------------------------------------------

$Homeserver = 'https://matrix.hylianux.com'   # client-server API base URL
$ServerName = 'hylianux.com'                  # the domain in your MXIDs
$WidgetName = 'GIFs'                          # label shown in Element

# NOTE: single quotes are required. $theme is a literal placeholder that
# Element substitutes at load time -- it must NOT be expanded by PowerShell.
$PickerUrl = 'https://gifs.hylianux.com/?theme=$theme'

# ---------------------------------------------------------------------------

function Write-Ok    { param($m) Write-Host "[OK] $m"   -ForegroundColor Green }
function Write-Warn  { param($m) Write-Host "[!]  $m"   -ForegroundColor Yellow }
function Stop-Fail   { param($m) Write-Host "[X]  $m"   -ForegroundColor Red; exit 1 }

# Windows PowerShell 5.1 defaults to TLS 1.0 in some configurations.
if ($PSVersionTable.PSVersion.Major -lt 6) {
    [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
}

# ---------------------------------------------------------------------------
# Gather credentials
# ---------------------------------------------------------------------------

Write-Host ''
Write-Host 'Matrix GIF picker setup' -ForegroundColor White
Write-Host ''
Write-Host 'This registers the GIF picker widget on your Matrix account.'
Write-Host 'You will need an access token.'
Write-Host ''
Write-Host 'Where to find your access token in Element:' -ForegroundColor White
Write-Host ''
Write-Host '  Element Web / Desktop'
Write-Host '    Settings -> Help & About -> Advanced -> Access Token'
Write-Host '    (click "<click to reveal>", then copy it)'
Write-Host ''
Write-Host '  Element mobile'
Write-Host '    Settings -> Help & About -> Advanced -> Access Token'
Write-Host ''
Write-Host 'Treat this token like a password.' -ForegroundColor Yellow
Write-Host 'It grants full access to your account. Close this window when you'
Write-Host 'are done, and never paste it into a chat or an issue tracker.'
Write-Host ''

$Username = Read-Host "Username (just the local part, e.g. 'alice')"
$Username = $Username.TrimStart('@')          # tolerate a leading @
$Username = $Username.Split(':')[0]           # tolerate a pasted full MXID
if ([string]::IsNullOrWhiteSpace($Username)) { Stop-Fail 'No username entered.' }

$SecureToken = Read-Host 'Access token' -AsSecureString
if ($PSVersionTable.PSVersion.Major -ge 7) {
    $Token = ConvertFrom-SecureString $SecureToken -AsPlainText
} else {
    $bstr = [Runtime.InteropServices.Marshal]::SecureStringToBSTR($SecureToken)
    try   { $Token = [Runtime.InteropServices.Marshal]::PtrToStringBSTR($bstr) }
    finally { [Runtime.InteropServices.Marshal]::ZeroFreeBSTR($bstr) }
}
if ([string]::IsNullOrWhiteSpace($Token)) { Stop-Fail 'No token entered.' }

$Mxid    = "@$Username`:$ServerName"
$Headers = @{ Authorization = "Bearer $Token" }

function Get-Endpoint {
    param([string]$Id)
    "$Homeserver/_matrix/client/v3/user/$([uri]::EscapeDataString($Id))/account_data/m.widgets"
}

# ---------------------------------------------------------------------------
# Verify the token actually belongs to this account
# ---------------------------------------------------------------------------

Write-Host ''
Write-Host "Verifying token against $Homeserver ..."

try {
    $whoami = Invoke-RestMethod -Method Get -Headers $Headers `
        -Uri "$Homeserver/_matrix/client/v3/account/whoami"
} catch {
    $detail = $null
    if ($_.ErrorDetails) { $detail = $_.ErrorDetails.Message }
    if ($detail -and $detail -match 'M_UNKNOWN_TOKEN') {
        Stop-Fail 'Homeserver rejected the token. It may be expired -- grab a fresh one from Element.'
    }
    Stop-Fail "Could not reach the homeserver. Check `$Homeserver in this script. ($($_.Exception.Message))"
}

$ActualMxid = $whoami.user_id

if ($ActualMxid -ne $Mxid) {
    Write-Warn "Token belongs to $ActualMxid, but you entered $Mxid."
    Write-Warn "A token can only write its own account data, so $Mxid would fail."
    $reply = Read-Host "Use $ActualMxid instead? [y/N]"
    if ($reply -notmatch '^[Yy]$') { Stop-Fail 'Aborted. Re-run with the correct username.' }
    $Mxid = $ActualMxid
}

Write-Ok "Authenticated as $Mxid"

$Endpoint = Get-Endpoint $Mxid

# ---------------------------------------------------------------------------
# Build the payload
# ---------------------------------------------------------------------------

if ($Remove) {
    $Payload = '{}'
    $Action  = 'Removing'
} else {
    # Built as an object and serialized, so quoting and escaping are handled
    # correctly. $PickerUrl is single-quoted above, so $theme stays literal.
    $Payload = [ordered]@{
        stickerpicker = [ordered]@{
            content = [ordered]@{
                type          = 'm.stickerpicker'
                url           = $PickerUrl
                name          = $WidgetName
                creatorUserId = $Mxid
                data          = @{}
            }
            sender    = $Mxid
            state_key = 'stickerpicker'
            type      = 'm.widget'
            id        = 'stickerpicker'
        }
    } | ConvertTo-Json -Depth 6 -Compress
    $Action = 'Registering'
}

Write-Host "$Action the picker for $Mxid ..."

try {
    Invoke-RestMethod -Method Put -Headers $Headers -Uri $Endpoint `
        -ContentType 'application/json; charset=utf-8' -Body $Payload | Out-Null
} catch {
    $detail = $_.Exception.Message
    if ($_.ErrorDetails) { $detail = $_.ErrorDetails.Message }
    Write-Host ''
    Stop-Fail "Homeserver returned an error: $detail"
}

Write-Ok 'Account data written.'

# ---------------------------------------------------------------------------
# Read it back
# ---------------------------------------------------------------------------

try {
    $verify = Invoke-RestMethod -Method Get -Headers $Headers -Uri $Endpoint
} catch {
    $verify = $null
}

if ($Remove) {
    Write-Ok 'Picker removed.'
} elseif ($verify -and ($verify | ConvertTo-Json -Depth 6 -Compress) -match 'm\.stickerpicker') {
    Write-Ok 'Verified: the widget is present on the account.'
} else {
    Write-Warn 'Write succeeded but read-back looks wrong.'
}

Write-Host ''
Write-Host 'Next step:' -ForegroundColor White -NoNewline
Write-Host ' hard-reload Element (Ctrl-Shift-R, or fully quit and reopen'
Write-Host "the desktop/mobile app). A $WidgetName button should appear in the message composer."
Write-Host ''
Write-Host 'If the button does not appear, the account data is set correctly but' -ForegroundColor DarkGray
Write-Host 'Element has cached the old state -- log out and back in as a last resort.' -ForegroundColor DarkGray
Write-Host 'To undo this entirely, re-run with:  .\set-gif-picker.ps1 -Remove' -ForegroundColor DarkGray
Write-Host ''

Remove-Variable Token, SecureToken, Headers -ErrorAction SilentlyContinue