rotate

#!/bin/bash

# SPDX-FileCopyrightText: 2021 - 2024 sudorook <daemon@nullcodon.com>
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option)
# any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
# for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program. If not, see <https://www.gnu.org/licenses/>.

set -euo pipefail

ROOT="$(dirname "${0}")"

source "${ROOT}"/globals

# Map 2-character hexadecimal values (1 byte), in a format familiar to that
# found in the KeePassXC configuration file.
# - Two-character codes with preceding 0 are abbreviated to 1 character. For
#   example, '\x0d' is shortened to '\xd'.
# - Values with non-ambiguous ASCII values are mapped directly to the
#   character. For example, '26' maps to '&'.
# - '\xhh' values are instead returned as 'xhh' without the backslash. This is
#   to avoid the need to escape the strings every time they are passed around
#   among variables and functions.
function convert_hex_to_bytestring {
  local hex="${1}"
  local bytestring
  case "${hex}" in
    20)
      bytestring=' '
      ;;
    21)
      bytestring='!'
      ;;
    22)
      bytestring='"'
      ;;
    23)
      bytestring='#'
      ;;
    24)
      bytestring='$'
      ;;
    25)
      bytestring='%'
      ;;
    26)
      bytestring='&'
      ;;
    27)
      bytestring="'"
      ;;
    28)
      bytestring='('
      ;;
    29)
      bytestring=')'
      ;;
    2A | 2a)
      bytestring='*'
      ;;
    2B | 2b)
      bytestring='+'
      ;;
    2C | 2c)
      bytestring=','
      ;;
    2D | 2d)
      bytestring='-'
      ;;
    2E | 2e)
      bytestring='.'
      ;;
    2F | 2f)
      bytestring='/'
      ;;
    3A | 3a)
      bytestring=':'
      ;;
    3B | 3b)
      bytestring=';'
      ;;
    3C | 3c)
      bytestring='<'
      ;;
    3D | 3d)
      bytestring='='
      ;;
    3E | 3e)
      bytestring='>'
      ;;
    3F | 3f)
      bytestring='?'
      ;;
    40)
      bytestring='@'
      ;;
    5B | 5b)
      bytestring='['
      ;;
    5C | 5c)
      bytestring='\'
      ;;
    5D | 5d)
      bytestring=']'
      ;;
    5E | 5e)
      bytestring='^'
      ;;
    5F | 5f)
      bytestring='_'
      ;;
    60)
      bytestring='`'
      ;;
    7B | 7b)
      bytestring='{'
      ;;
    7C | 7c)
      bytestring='|'
      ;;
    7D | 7d)
      bytestring='}'
      ;;
    7E | 7e)
      bytestring='~'
      ;;
    00)
      bytestring='x0'  # Don't include the '\' yet -- it causes problems when passing strings around...
      ;;
    *)
      bytestring="x${hex#0}"  # Don't include the '\' yet -- it causes problems when passing strings around...
      ;;
  esac
  printf "${bytestring}"  # Use printf to avoid adding a newline to the bytestring.
}

# Converts an unsigned short int (2 bytes) to a byte array represented as
# hexadecimal values. The 2 bytes are split into two 1-byte halves and
# converted independently. Then, they are concatenated into the final byte
# string.
function convert_uint_to_bytestring {
  local int="${1}"
  local hex
  local str1
  local str2
  local bytestring
  printf -v hex "%.4x" "${int}"
  str1="$(convert_hex_to_bytestring "${hex:0:2}")"
  str2="$(convert_hex_to_bytestring "${hex:2:4}")"
  bytestring="${str1}${str2}"
  printf "${bytestring}"
}

function print_usage {
  show_header "Usage:"
  show_listitem "  -i|--input     display ID"
  show_listitem "  -r|--rotation  rotation (left, right, normal, or inverted)"
  show_listitem "  -h|--help      print (this) help message"
}

function get_primary_display_info_xrandr {
  local info
  if [[ -v 1 ]] && [[ -n "${1}" ]]; then
    info="$(xrandr -q |
            sed -n "s/^${1} connected \(primary \)\?\([0-9]\+\)x\([0-9]\+\)[0-9+]\+ \([a-z]\+\)\?.*/\1|\2|\3|\4/p")"
  else
    info="$(xrandr -q |
            sed -n "s/^\([A-Za-z0-9\-]\+\) connected primary \([0-9]\+\)x\([0-9]\+\)[0-9+]\+ \([a-z]\+\)\?.*/\1|\2|\3|\4/p")"
  fi
  if [ -z "${info}" ]; then
    show_error "ERROR: Failed to parse display info. Exiting."
    exit 3
  fi
  ID="$(cut -d"|" -f1 <<< "${info}")"
  if [ -z "${ID}" ]; then
    show_error "ERROR: Could not detect primary display. Exiting."
    exit 3
  fi
  CURRENT_ROTATION="$(cut -d"|" -f4 <<< "${info}")"
  if [ -z "${CURRENT_ROTATION}" ]; then
    show_warning "WARNING: Could not detect display rotation. Assuming 'normal'."
    CURRENT_ROTATION=normal
  fi
  case "${CURRENT_ROTATION}" in
    left | right)
      RESOLUTION_X="$(cut -d"|" -f3 <<< "${info}")"
      RESOLUTION_Y="$(cut -d"|" -f2 <<< "${info}")"
      ;;
    inverted | normal)
      RESOLUTION_X="$(cut -d"|" -f2 <<< "${info}")"
      RESOLUTION_Y="$(cut -d"|" -f3 <<< "${info}")"
      ;;
    *)
      show_error "ERROR: unknown rotation ${CURRENT_ROTATION@Q}."
      return
      ;;
  esac
}

function get_primary_display_info_kde {
  local info
  local current_rotation_int

  if [[ -v 1 ]] && [[ -n "${1}" ]]; then
    info="$(kscreen-doctor --json | jq ".outputs[] | select(.name = ${1}")"
  else
    info="$(kscreen-doctor --json | jq ".outputs[] | select(.primary)")"
  fi

  ID="$(echo "${info}" | jq -r ".name")"
  if [ -z "${info}" ]; then
    show_error "ERROR: Failed to parse display info. Exiting."
    exit 3
  fi
  if [ -z "${ID}" ]; then
    show_error "ERROR: Could not detect primary display. Exiting."
    exit 3
  fi

  current_rotation_int="$(echo "${info}" | jq -r '.rotation')"
  case "${current_rotation_int}" in
    1)
      CURRENT_ROTATION=normal
      ;;
    2)
      CURRENT_ROTATION=left
      ;;
    4)
      CURRENT_ROTATION=inverted
      ;;
    8)
      CURRENT_ROTATION=right
      ;;
    *)
      show_error "ERROR: Unknown rotation code ${current_rotation_int@Q}. Exiting."
      exit 3
      ;;
  esac
}

function recenter_qt_application {
  local appname="${1}"
  local config="${2}"
  local pattern="${3}"

  local width
  local height
  local titlebar_height
  local x_left_to_left
  local x_left_to_right
  local y_top_to_titlebar_top
  local y_top_to_titlebar_bottom
  local y_top_to_bottom
  local screen_width
  local screen_height
  local geometry_string
  local geometry_string_new
  local geometry_array_uint=()
  local geometry_array_byte=()

  if ! [ -f "${config}" ]; then
    show_warning "WARNING: ${1} cache file ${config@Q} missing. Skipping."
    return
  fi
  geometry_string="$(sed -n "s/^${pattern}\ \?=\ \?@ByteArray(\(.*\))$/\1/p" "${config}")"
  read -r -a geometry_array_uint <<< "$(printf "${geometry_string}" |
                                        od -A n -t u2 --endian=big |
                                        tr -d '\n')"

  if [ ${#geometry_array_uint[@]} -eq 0 ]; then
    show_warning "WARNING: Failed to parse ${config@Q}. Skipping."
    return
  elif ! [ ${#geometry_array_uint[@]} -eq 24 ]; then
    show_warning "WARNING: Unexpected # of values in ${config@Q} geometry bytestring. Skipping."
    return
  fi

  # Compute the application dimensions from the geometry string. The '/2*2'
  # part of each expression is to ensure that the dimensions are even numbers
  # (there are divide-by-2 operations when computing the center), and the '+1'
  # is so that values are 'rounded' up to the nearest even number instead of
  # rounded down.
  width=$(((geometry_array_uint[9] - geometry_array_uint[5] + 1) / 2 * 2))
  height=$(((geometry_array_uint[11] - geometry_array_uint[15] + 1) / 2 * 2))
  titlebar_height=$(((geometry_array_uint[15] - geometry_array_uint[7] + 1) / 2 * 2))

  case "${ROTATION}" in
    left | right)
      x_left_to_left=$(((RESOLUTION_Y - width) / 2))
      x_left_to_right=$((x_left_to_left + width))
      y_top_to_titlebar_top=$(((RESOLUTION_X - height - PANEL_OFFSET - 20) / 2)) # 20 is hard-coded to match default display position
      y_top_to_titlebar_bottom=$((y_top_to_titlebar_top + titlebar_height))
      y_top_to_bottom=$((y_top_to_titlebar_bottom + height))
      screen_width="${RESOLUTION_Y}"
      screen_height="${RESOLUTION_X}"
      ;;
    inverted | normal)
      x_left_to_left=$(((RESOLUTION_X - width) / 2))
      x_left_to_right=$((x_left_to_left + width))
      y_top_to_titlebar_top=$(((RESOLUTION_Y - height - PANEL_OFFSET - 20) / 2)) # 20 is hard-coded to match default display position
      y_top_to_titlebar_bottom=$((y_top_to_titlebar_top + titlebar_height))
      y_top_to_bottom=$((y_top_to_titlebar_bottom + height))
      screen_width="${RESOLUTION_X}"
      screen_height="${RESOLUTION_Y}"
      ;;
    *)
      show_error "ERROR: unknown rotation ${ROTATION@Q}."
      return
      ;;
  esac

  geometry_array_uint[5]="${x_left_to_left}"
  geometry_array_uint[13]="${x_left_to_left}"
  geometry_array_uint[26]="${x_left_to_left}"
  geometry_array_uint[9]="${x_left_to_right}"
  geometry_array_uint[17]="${x_left_to_right}"
  geometry_array_uint[30]="${x_left_to_right}"
  geometry_array_uint[24]="${screen_width}"
  # geometry_array_uint[33]="${screen_height}"
  geometry_array_uint[7]="${y_top_to_titlebar_top}"
  geometry_array_uint[15]="${y_top_to_titlebar_bottom}"
  geometry_array_uint[28]="${y_top_to_titlebar_bottom}"
  geometry_array_uint[11]="${y_top_to_bottom}"
  geometry_array_uint[19]="${y_top_to_bottom}"
  geometry_array_uint[32]="${y_top_to_bottom}"

  local i
  for i in "${geometry_array_uint[@]}"; do
    geometry_array_byte+=($(convert_uint_to_bytestring "${i}"))
  done
  printf -v geometry_string_new '%s' "${geometry_array_byte[@]}"

  # Convert the 'xhh' values to '\xhh' and the 'x0's to '\0's.
  geometry_string_new="$(printf "${geometry_string_new}" |
                         sed -e 's/x0/\\0/g' -e 's/x/\\x/g')"

  # ${geometry_string_new} is changed ('\' -> '\\') so '\'s next to '('s don't
  # get parsed as opening braces for capture groups.
  sed -i.bak \
    's/^'"${pattern}"'\(\ \?=\ \?@ByteArray(\).*)$/'"${pattern}"'\1'"${geometry_string_new//\\/\\\\}"')/g' \
    "${config}"
}

function recenter_bleachbit {
  local width
  local height
  local offset_x
  local offset_y
  local config="${HOME}/.config/bleachbit/bleachbit.ini"
  if ! [ -f "${config}" ]; then
    show_warning "WARNING: Bleachbit config file missing. Skipping."
    return
  fi
  width="$(sed -n 's/window_width = \([0-9]\+\)/\1/p' "${config}")"
  height="$(sed -n 's/window_height = \([0-9]\+\)/\1/p' "${config}")"
  case "${ROTATION}" in
    left | right)
      offset_y=$(((RESOLUTION_X - height - PANEL_OFFSET - 20) / 2)) # 20 is hard-coded to match default display position
      offset_x=$(((RESOLUTION_Y - width) / 2))
      ;;
    inverted | normal)
      offset_x=$(((RESOLUTION_X - width) / 2))
      offset_y=$(((RESOLUTION_Y - height - PANEL_OFFSET - 20) / 2)) # 20 is hard-coded to match default display position
      ;;
    *)
      show_error "ERROR: unknown rotation ${ROTATION@Q}."
      return
      ;;
  esac
  sed -i.bak \
    -e "s/^\(window_width = \)[0-9]\+/\1${width}/g" \
    -e "s/^\(window_height = \)[0-9]\+/\1${height}/g" \
    -e "s/^\(window_x = \)[0-9]\+/\1${offset_x}/g" \
    -e "s/^\(window_y = \)[0-9]\+/\1${offset_y}/g" \
    "${config}"
}

function recenter_transmission {
  local width
  local height
  local offset_x
  local offset_y
  local config="${HOME}/.config/transmission/settings.json"
  if ! [ -f "${config}" ]; then
    show_warning "WARNING: Transmission config file missing. Skipping."
    return
  fi
  width="$(sed -n 's/.*"main-window-width": \([0-9]\+\),/\1/p' "${config}")"
  height="$(sed -n 's/.*"main-window-height": \([0-9]\+\),/\1/p' "${config}")"
  case "${ROTATION}" in
    left | right)
      offset_y=$(((RESOLUTION_X - height - PANEL_OFFSET) / 2))
      offset_x=$(((RESOLUTION_Y - width) / 2))
      ;;
    inverted | normal)
      offset_x=$(((RESOLUTION_X - width) / 2))
      offset_y=$(((RESOLUTION_Y - height - PANEL_OFFSET) / 2))
      ;;
    *)
      show_error "ERROR: unknown rotation ${ROTATION@Q}."
      return
      ;;
  esac
  sed -i.bak \
    -e "s/\(.*\"main-window-width\": \)[0-9]\+,/\1${width},/g" \
    -e "s/\(.*\"main-window-height\": \)[0-9]\+,/\1${height},/g" \
    -e "s/\(.*\"main-window-x\": \)[0-9]\+,/\1${offset_x},/g" \
    -e "s/\(.*\"main-window-y\": \)[0-9]\+,/\1${offset_y},/g" \
    "${config}"
}

function rotate_cinnamon_monitor_xml {
  local config="${HOME}/.config/cinnamon-monitors.xml"
  if ! [ -f "${config}" ]; then
    show_warning "${config@Q} not found. Skipping."
  else
    sed -i.bak \
      "s,<rotation>[a-z]\+</rotation>,<rotation>${ROTATION}</rotation>,g" \
      "${config}"
  fi
}

function parse_rotation {
  case ${ROTATION,,} in
    right)
      ROTATION=right
      ;;
    left)
      ROTATION=left
      ;;
    normal | none)
      ROTATION=normal
      ;;
    inverted)
      ROTATION=inverted
      ;;
    *)
      show_error "ERROR: invalid rotation ${ROTATION@Q}. Exiting."
      print_usage
      exit 3
      ;;
  esac
}

function rotate_display_xrandr {
  xrandr --output "${ID}" --rotate "${ROTATION}"
}

function rotate_display_kde {
  kscreen-doctor output."${ID}".rotation."${ROTATION}"
}

function change_gnome_desktop_bg {
  case ${ROTATION} in
    right | left)
      if [ -f "${VERTICAL_BG}" ]; then
        dconf write /org/gnome/desktop/background/picture-uri "'file://${VERTICAL_BG}'"
      else
        show_warning "Background ${VERTICAL_BG@Q} not found. Skipping."
      fi
      ;;
    normal | inverted)
      if [ -f "${HORIZONTAL_BG}" ]; then
        dconf write /org/gnome/desktop/background/picture-uri "'file://${HORIZONTAL_BG}'"
      else
        show_warning "Background ${HORIZONTAL_BG@Q} not found. Skipping."
      fi
      ;;
    *)
      show_error "ERROR: invalid rotation ${ROTATION@Q}. Exiting."
      print_usage
      exit 3
      ;;
  esac
}

function change_cinnamon_desktop_bg {
  case ${ROTATION} in
    right | left)
      if [ -f "${VERTICAL_BG}" ]; then
        dconf write /org/cinnamon/desktop/background/picture-uri "'file://${VERTICAL_BG}'"
      else
        show_warning "Background ${VERTICAL_BG@Q} not found. Skipping."
      fi
      ;;
    normal | inverted)
      if [ -f "${HORIZONTAL_BG}" ]; then
        dconf write /org/cinnamon/desktop/background/picture-uri "'file://${HORIZONTAL_BG}'"
      else
        show_warning "Background ${HORIZONTAL_BG@Q} not found. Skipping."
      fi
      ;;
    *)
      show_error "ERROR: invalid rotation ${ROTATION@Q}. Exiting."
      print_usage
      exit 3
      ;;
  esac
}

function change_kde_desktop_bg {
  case "${ROTATION}" in
    right | left)
      plasma-apply-wallpaperimage "${VERTICAL_BG}"
      ;;
    normal | inverted)
      plasma-apply-wallpaperimage "${HORIZONTAL_BG}"
      ;;
    *)
      show_error "ERROR: invalid rotation ${ROTATION@Q}. Exiting."
      print_usage
      exit 3
      ;;
  esac
}

VERTICAL_BG="/usr/share/backgrounds/timed/24-hours-timed.xml"
HORIZONTAL_BG="/usr/share/backgrounds/timed/island-timed.xml"
CENTER=false

PANEL_OFFSET=40  # height (in pixels) of the panel

OPTIONS=i:r:hc
LONGOPTIONS=input:,rotation:,help,center
PARSED=$(getopt -o "${OPTIONS}" --long "${LONGOPTIONS}" -n "${0}" -- "${@}")
eval set -- "${PARSED}"

while [ ${#} -ge 1 ]; do
  case "${1}" in
    -i | --input)
      ID="${2}"
      shift 2
      ;;
    -r | --rotation)
      ROTATION="${2}"
      parse_rotation
      shift 2
      ;;
    -c | --center)
      CENTER=true
      shift
      ;;
    -h | --help)
      print_usage
      shift
      exit
      ;;
    --)
      shift
      break
      ;;
    *)
      show_error "ERROR: invalid flag ${1@Q}."
      print_usage
      exit 3
      ;;
  esac
done

case "${XDG_CURRENT_DESKTOP}" in
  X-Cinnamon)
    ! check_command xrandr dconf sed && exit 3
    get_primary_display_info_xrandr "${ID:-}"
    if ! [[ "${ROTATION}" = "${CURRENT_ROTATION}" ]]; then
      rotate_display_xrandr
      change_cinnamon_desktop_bg
      rotate_cinnamon_monitor_xml
    else
      show_info "Leaving current rotation ${CURRENT_ROTATION@Q} unchanged."
    fi
    ;;
  GNOME)
    get_primary_display_info_xrandr "${ID:-}"
    if ! [[ "${ROTATION}" = "${CURRENT_ROTATION}" ]]; then
      if [[ "${XDG_SESSION_TYPE}" = x11 ]]; then
        ! check_command xrandr dconf sed && exit 3
        rotate_display_xrandr
        change_gnome_desktop_bg
      fi
    else
      show_info "Leaving current rotation ${CURRENT_ROTATION@Q} unchanged."
    fi
    ;;
  KDE)
    get_primary_display_info_kde "${ID:-}"
    if ! [[ "${ROTATION}" = "${CURRENT_ROTATION}" ]]; then
      ! check_command kscreen-doctor jq grep && exit 3
      rotate_display_kde
    else
      show_info "Leaving current rotation ${CURRENT_ROTATION@Q} unchanged."
    fi
    ;;
  *)
    show_error "ERROR: Environment ${XDG_CURRENT_DESKTOP@Q} unsupported. Exiting."
    exit 3
    ;;
esac

if "${CENTER}"; then
  ! check_command sed && exit 3

  recenter_bleachbit
  recenter_transmission

  recenter_qt_application \
    "Clementine" \
    "${HOME}/.config/Clementine/Clementine.conf" \
    "geometry"

  recenter_qt_application \
    "KeePassXC" \
    "${HOME}/.cache/keepassxc/keepassxc.ini" \
    "MainWindowGeometry"

  recenter_qt_application \
    "VLC" \
    "${HOME}/.config/vlc/vlc-qt-interface.conf" \
    "geometry"
fi