nanorc/install.sh

#!/bin/sh

# IMPROVED NANO SYNTAX HIGHLIGHTING FILES
# Get nano editor better to use and see.

# Copyright (C) 2014+ Anthony Scopatz et al.
# 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/>.
# https://spdx.org/licenses/GPL-3.0-or-later.html

# Help:
# Sed: http://www.grymoire.com/Unix/Sed.html

# Bash Variables
# Ativate or not the erros (1=activated)
OPTERR=1
# Separator (useful for simulate arrays)
G_IFS=" "

# Global Variables
G_VERSION="2019.10.17"
G_DEPS="unzip sed"
G_FILE="${HOME}/.nanorc"
G_REPO_MASTER="https://github.com/scopatz/nanorc/archive/master.zip"
G_REPO_RELEASE="https://github.com/scopatz/nanorc/archive/${G_VERSION}.zip"
unset G_LITE G_UNSTABLE G_VERBOSE G_DIR G_THEME

# Exit Values Help
# 0 - OK
# 1 - Big problem

# Functions

# Show the usage/help
f_menu_usage(){
  echo "Usage: $0 [ -h|-l|-u|-v|-w ] [ -d DIR ] [ -t THEME ]"
  echo
  echo "IMPROVED NANO SYNTAX HIGHLIGHTING FILES"
  echo "Get nano editor better to use and see."
  echo
  echo "-h    Show help or usage."
  echo "-l    Activate lite installation."
  echo "        We will take account your existing .nanorc files."
  echo "-u    Use the unstable branch (master)."
  echo "-v    Show version, license and other info."
  echo "-w    Turn the script more verbose, often to tests."
  echo
  echo "-d DIR"
  echo "      Give other directory for installation."
  echo "        Default: ~/.nano/nanorc/"
  echo
  echo "-t THEME"
  echo "      Give other theme for installation."
  echo "        Default: scopatz"
  echo "        Options: nano, tpro"
  exit 1
}

# Show version, license and other file.
f_menu_version(){
  echo "IMPROVED NANO SYNTAX HIGHLIGHTING FILES"
  echo "Version ${G_VERSION}"
  echo
  echo "Copyright (C) 2014+ Anthony Scopatz et al."
  echo "License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>."
  echo "This is free software: you are free to change and redistribute it."
  echo "There is NO WARRANTY, to the extent permitted by law."
  echo
  echo "Written by Anthony Scopatz and others."
  echo
  echo "For bugs report, please fill an issue at https://github.com/scopatz/nanorc"

  exit 0
}

# Check dependencies
f_check_deps(){
  DEPS_MISSED=""

  # If there isn't the dependency the $DEPS_MISSED will be populated.
  for DEP in $G_DEPS; do
    if [ ! "$(command -v "$DEP")" ]; then
      DEPS_MISSED="${DEP} ${DEPS_MISSED}"
    fi
  done

  # Error if $DEPS_MISSED is populated.
  if [ "$DEPS_MISSED" = "" ]; then
    return 0
  else
    for DEP in $DEPS_MISSED; do
      echo "The '${DEP}' program is required but was not found. Install '${DEP}' first and then run this script again." >&2
    done
    return 1
  fi
}

# Set IFS
f_set_ifs(){
  temp=$IFS
  IFS=$G_IFS
  G_IFS=temp
}

# Set Variable
# Receives two parameters:
#  1. the variable name
#  2. a value
# Sources:  https://unix.stackexchange.com/questions/23111/what-is-the-eval-command-in-bash
f_set_variable(){
  varname=$1
  varvalue=""
  shift

  # Because 'sh' do not recognize indirect expansion "${!#}" like bash.
  # Alert! The backslash "\" is needed!
  eval varvalue="\$${varname}"

  if [ -z "${varvalue}" ]; then
    eval "$varname=${*}"
  else
    echo "Error: ${varname} already set."
    usage
  fi
}



_update_nanorc(){
  touch ~/.nanorc

  # add all includes from ~/.nano/nanorc if they're not already there
  while read -r inc; do
      if ! grep -q "$inc" "${NANORC_FILE}"; then
          echo "$inc" >> "$NANORC_FILE"
      fi
  done < ~/.nano/nanorc
}

_update_nanorc_lite(){
  sed -i '/include "\/usr\/share\/nano\/\*\.nanorc"/i include "~\/.nano\/*.nanorc"' "${NANORC_FILE}"
}




# Install
# Sources: https://www.cyberciti.biz/faq/download-a-file-with-curl-on-linux-unix-command-line/
f_install(){
  temp="temp.zip"
  begin="# BEGIN"
  end="# END"
  theme="${G_DIR}/themes/${G_THEME}/"

  if [ ! cd "$HOME" ]; then
    echo "Error: Cannot open or access ${HOME} directory."
    exit 1
  fi

  mkdir -p "$G_DIR"

  if [ ! -d "$G_DIR" ]; then
    echo "Error: ${G_DIR} is not a directory or cannot be accessed or created."
    usage
  fi

  if [ "$G_UNSTABLE" = true ]; then
    curl -L -o $temp $G_REPO_MASTER
  else
    curl -L -o $temp $G_REPO_RELEASE
  fi

  unzip -u $temp
  rm $temp

  if [ "$G_UNSTABLE" = true ]; then
    mv "nanorc-master/*" "$G_DIR"
    rm -rf "nanorc-master"
  else
    mv "nanorc-${G_VERSION}" "$G_DIR"
    rm -rf "nanorc-${G_VERSION}"
  fi

  if [ ! -d "$theme" ]; then
    echo "Error: ${G_THEME} is not a theme or cannot be accessed."
    usage
  fi

  touch "$G_FILE"

  { echo "$begin";
    echo "";
    echo "$end";
  } >> $G_FILE

  if [ "$G_LITE" = true ]; then
    sed -n -i.bkp '/'"$begin"'/,/'"$end"'/ {
        /'"$begin"'/n
        /'"$end"'/ !{
          s/*//
          r  
        }
    #    r theme
    # write the includes
    }' $G_FILE

    _update_nanorc_lite
  else
    _update_nanorc
  fi
}

# update.
# write comments, options, gui, rebindings, includes highlights (according theme)
# lite = maintains the nano nanorc files'
# get the list of nano's files and include only ours (exclude).
# big change: update all nanorc
# big change: install "only" the themed nanorc files and .nanorc

# next: more shellcheck and get file and write it

# ============================
#
# MAIN / Init of script
#
# =============================

# Pre-check
f_set_ifs
f_check_deps && exit 1

# Menu
# Getopts: https://www.shellscript.sh/tips/getopts/
while getopts "d:hlt:uvw" c; do
  case $c in
    d) f_set_variable G_DIR "$OPTARG" ;;
    h) f_menu_usage ;;
    l) f_set_variable G_LITE true ;;
    t) f_set_variable G_THEME "$OPTARG" ;;
    u) f_set_variable G_UNSTABLE true ;;
    v) f_menu_version ;;
    w) f_set_variable G_VERBOSE true ;;
    *) f_menu_usage ;;
  esac
done

# Set defaults if there is not.
[ -z "$G_DIR" ] && G_DIR="${HOME}/.nano/nanorc/"
[ -z "$G_THEME" ] && G_THEME="scopatz"

# Set verbose
if [ "$G_VERBOSE" = true ]; then
  set -x
fi

# Install
f_install

# Post-check
f_set_ifs
exit 0