simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-12-24 19:02:46 +03:00
Code Issues Projects Releases Wiki Activity

installer: start of an easy hledger installer script, based on stack's

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2017-07-17 16:46:29 +01:00
parent 45eeb06ebc
commit d0c2dec45e
3 changed files with 839 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
hledger-install/LICENSE.get-stack Normal file
View File

@ -0,0 +1,30 @@
Copyright (c) 2015-2017, Stack contributors
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
* Neither the name of Emanuel Borsboom nor the names of other
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

12
hledger-install/README Normal file
View File

@ -0,0 +1,12 @@
A lot of specialised knowledge is still needed to be sure of
successfully building and installing hledger in all cases. For example:
running stack setup if you don't have a suitable version of ghc..
installing with your current global resolver to minimise rebuilding..
unless it's too old, in which case use the (appropriate) latest resolver..
always use ghc 8.0.2+ on osx sierra..
don't try to install hledger-ui on windows..
etc.
This installer script tries to automate the installation of stack and then hledger,
as reliably and quickly as possible, on POSIX systems.
(Windows systems have binaries and don't need this.)

797
hledger-install/hledger-install.sh Executable file
View File

@ -0,0 +1,797 @@
#!/bin/sh -e
usage() {
cat <<'HERE'
hledger-install.sh [-f|--force] [-q|--quiet] [-h|--help]
Install hledger (CLI only for now) as reliably and quickly as possible,
on any POSIX system, such as GNU/Linux, OSX, or FreeBSD.
Also installs haskell stack if needed (or with --force, always).
With --quiet, try to show less output.
Usage:
curl -sSLO https://hledger.org/hledger-install.sh
less hledger-install.sh # review for security issues
sh [-x] hledger-install.sh # to see commands being run, add -x
or, if you prefer convenience to security:
curl -sSL https://hledger.org/hledger-install.sh | sh
or
wget -qO- https://hledger.org/hledger-install.sh | sh
This is based heavily on the 2017/07/17 version of
https://github.com/commercialhaskell/stack/blob/master/etc/scripts/get-stack.sh
which is copyright (c) 2015-2017, Stack contributors.
HERE
}
HLEDGERVER=1.3
RESOLVER=lts-8
HELP=""
HOME_LOCAL_BIN="$HOME/.local/bin"
USR_LOCAL_BIN="/usr/local/bin"
QUIET=""
FORCE=""
STACK_TEMP_DIR=
# creates a temporary directory, which will be cleaned up automatically
# when the script finishes
make_temp_dir() {
STACK_TEMP_DIR="$(mktemp -d 2>/dev/null || mktemp -d -t stack)"
}
# cleanup the temporary directory if it's been created. called automatically
# when the script exits.
cleanup_temp_dir() {
if [ -n "$STACK_TEMP_DIR" ] ; then
rm -rf "$STACK_TEMP_DIR"
STACK_TEMP_DIR=
fi
}
# print a message to stderr and exit with error code
die() {
echo "$@" >&2
exit 1
}
# print a message to stdout unless '-q' passed to script
info() {
if [ -z "$QUIET" ] ; then
echo "$@"
fi
}
# print a separator for post-install messages
post_install_separator() {
info ""
info "-------------------------------------------------------------------------------"
info ""
}
# determines the the CPU's instruction set
get_isa() {
if arch | grep -q arm ; then
echo arm
else
echo x86
fi
}
# exits with code 0 if arm ISA is detected as described above
is_arm() {
test "$(get_isa)" = arm
}
# determines 64- or 32-bit architecture
# if getconf is available, it will return the arch of the OS, as desired
# if not, it will use uname to get the arch of the CPU, though the installed
# OS could be 32-bits on a 64-bit CPU
get_arch() {
if has_getconf ; then
if getconf LONG_BIT | grep -q 64 ; then
echo 64
else
echo 32
fi
else
case "$(uname -m)" in
*64)
echo 64
;;
*)
echo 32
;;
esac
fi
}
# exits with code 0 if a 64-bit architecture is detected as described above
is_64_bit() {
test "$(get_arch)" = 64
}
# prints a generic bindist notice
print_bindist_notice() {
if [ -z "$1" ] ; then
info ""
info "Using generic bindist..."
info ""
else
info ""
info "Using generic $1 bindist..."
info ""
fi
}
# Adds a `sudo` prefix if sudo is available to execute the given command
# If not, the given command is run as is
sudocmd() {
$(command -v sudo) "$@"
}
# Install dependencies for distros that use Apt
apt_install_dependencies() {
info "Installing dependencies..."
info ""
apt_get_install_pkgs "$@"
}
# Attempts an install on Ubuntu via apt, if possible
# Expects the version (in Major.Minor format, with any sub-minor removed)
# as the first and only argument
# If the version of Ubuntu is unsupported, it attempts to copy the binary
# and install the necessary dependencies explicitly.
do_ubuntu_install() {
install_dependencies() {
apt_install_dependencies g++ gcc libc6-dev libffi-dev libgmp-dev make xz-utils zlib1g-dev git gnupg
}
if is_arm ; then
install_dependencies
print_bindist_notice
install_arm_binary
elif is_64_bit ; then
install_dependencies
print_bindist_notice
install_64bit_static_binary
else
install_dependencies
print_bindist_notice
install_32bit_standard_binary
fi
}
# Attempts an install on Debian.
# Expects the single-number version as the first and only argument
# If the version of Debian is unsupported, it attempts to copy the binary
# and install the necessary dependencies explicitly.
do_debian_install() {
install_dependencies() {
apt_install_dependencies g++ gcc libc6-dev libffi-dev libgmp-dev make xz-utils zlib1g-dev
}
if is_arm ; then
install_dependencies
print_bindist_notice
install_arm_binary
elif is_64_bit ; then
install_dependencies
print_bindist_notice
install_64bit_static_binary
else
install_dependencies
print_bindist_notice
install_32bit_standard_binary
fi
}
# Attempts an install on Fedora.
# Expects the single-number version as the first and only argument
# If the version of Fedora is unsupported, it attempts to copy the binary
# and install the necessary dependencies explicitly.
do_fedora_install() {
install_dependencies() {
dnf_install_pkgs perl make automake gcc gmp-devel libffi zlib xz tar
}
if is_64_bit ; then
install_dependencies "$1"
print_bindist_notice
install_64bit_static_binary
else
install_dependencies "$1"
print_bindist_notice
install_32bit_standard_binary
fi
}
# Attempts an install on CentOS.
# Expects the single-number version as the first and only argument
# If the version of CentOS is unsupported, it attempts to copy the binary
# and install the necessary dependencies explicitly.
do_centos_install() {
install_dependencies() {
yum_install_pkgs perl make automake gcc gmp-devel libffi zlib xz tar
}
if is_64_bit ; then
install_dependencies
print_bindist_notice
install_64bit_static_binary
else
install_dependencies
case "$1" in
"6")
print_bindist_notice "libgmp4"
install_32bit_gmp4_linked_binary
;;
*)
print_bindist_notice
install_32bit_standard_binary
;;
esac
fi
}
# Attempts to install on macOS.
# If 'brew' exists, installs using Homebrew. Otherwise, installs
# the generic bindist.
do_osx_install() {
info "Using generic bindist..."
info ""
install_64bit_osx_binary
info "NOTE: You may need to run 'xcode-select --install' to set"
info " up the Xcode command-line tools, which Stack uses."
info ""
}
# Attempts to insall on FreeBSD. Installs dependencies with
# 'pkg install' and then downloads bindist.
do_freebsd_install() {
install_dependencies() {
pkg_install_pkgs devel/gmake perl5 lang/gcc misc/compat8x misc/compat9x converters/libiconv ca_root_nss
}
if is_64_bit ; then
install_dependencies
install_64bit_freebsd_binary
else
die "Sorry, there is currently no 32-bit FreeBSD binary available."
fi
}
# Alpine distro install
do_alpine_install() {
install_dependencies() {
apk_install_pkgs gmp libgcc xz make
}
install_dependencies
if is_64_bit ; then
install_64bit_static_binary
else
die "Sorry, there is currently no 32-bit Alpine Linux binary available."
fi
}
# Attempts to install on unsupported Linux distribution by downloading
# the bindist.
do_sloppy_install() {
info "This installer doesn't support your Linux distribution, trying generic"
info "bindist..."
info ""
if is_arm ; then
install_arm_binary
elif is_64_bit ; then
install_64bit_static_binary
else
install_32bit_standard_binary
fi
info "Since this installer doesn't support your Linux distribution,"
info "there is no guarantee that 'stack' will work at all! You may"
info "need to manually install some system info dependencies for GHC:"
info " gcc, make, libffi, zlib, libgmp and libtinfo"
info "Please see http://docs.haskellstack.org/en/stable/install_and_upgrade/"
info "Pull requests to add support for this distro would be welcome!"
info ""
}
# Attempts to determine the running Linux distribution.
# Prints "DISTRO;VERSION" (distribution name and version)"."
distro_info() {
parse_lsb() {
lsb_release -a 2> /dev/null | perl -ne "$1"
}
try_lsb() {
if has_lsb_release ; then
TL_DIST="$(parse_lsb 'if(/Distributor ID:\s+([^ ]+)/) { print "\L$1"; }')"
TL_VERSION="$(parse_lsb 'if(/Release:\s+([^ ]+)/) { print "\L$1"; }')"
echo "$TL_DIST;$TL_VERSION"
else
return 1
fi
}
try_release() {
parse_release() {
perl -ne "$1" /etc/*release 2>/dev/null
}
parse_release_id() {
parse_release 'if(/^(DISTRIB_)?ID\s*=\s*"?([^"]+)/) { print "\L$2"; exit 0; }'
}
parse_release_version() {
parse_release 'if(/^(DISTRIB_RELEASE|VERSION_ID)\s*=\s*"?([^"]+)/) { print $2; exit 0; }'
}
TR_RELEASE="$(parse_release_id);$(parse_release_version)"
if [ ";" = "$TR_RELEASE" ] ; then
if [ -e /etc/arch-release ] ; then
# /etc/arch-release exists but is often empty
echo "arch;"
elif [ -e /etc/centos-release ] && grep -q "\<6\>" /etc/centos-release ; then
# /etc/centos-release has a non-standard format before version 7
echo "centos;6"
else
return 1
fi
else
echo "$TR_RELEASE"
fi
}
try_issue() {
case "$(cat /etc/issue 2>/dev/null)" in
"Arch Linux"*)
echo "arch;" # n.b. Version is not available in /etc/issue on Arch
;;
"Ubuntu"*)
echo "ubuntu;$(perl -ne 'if(/Ubuntu (\d+\.\d+)/) { print $1; }' < /etc/issue)"
;;
"Debian"*)
echo "debian;$(perl -ne 'if(/Debian GNU\/Linux (\d+(\.\d+)?)/) { print $1; }' < /etc/issue)"
;;
*"SUSE"*)
echo "suse;$(perl -ne 'if(/SUSE\b.* (\d+\.\d+)/) { print $1; }' < /etc/issue)"
;;
*"NixOS"*)
echo "nixos;$(perl -ne 'if(/NixOS (\d+\.\d+)/) { print $1; }' < /etc/issue)"
;;
"CentOS"*)
echo "centos;$(perl -ne 'if(/^CentOS release (\d+)\./) { print $1; }' < /etc/issue)"
;;
*)
esac
# others do not output useful info in issue, return empty
}
try_lsb || try_release || try_issue
}
# Attempt to install on a Linux distribution
do_distro() {
if ! has_perl ; then
if ! try_install_pkgs perl ; then
#TODO: remove dependence on 'perl', which is not installed by default
#on some distributions (Fedora and RHEL, in particular).
die "This script requires 'perl', please install it to continue."
fi
fi
IFS=";" read -r DISTRO VERSION <<GETDISTRO
$(distro_info)
GETDISTRO
if [ -n "$DISTRO" ] ; then
info "Detected Linux distribution: $DISTRO"
info ""
fi
case "$DISTRO" in
ubuntu)
do_ubuntu_install "$VERSION"
;;
debian|kali|raspbian)
do_debian_install "$VERSION"
;;
fedora)
do_fedora_install "$VERSION"
;;
centos|rhel)
do_centos_install "$VERSION"
;;
alpine)
do_alpine_install "$VERSION"
;;
*)
do_sloppy_install
esac
}
# Determine operating system and attempt to install.
do_os() {
case "$(uname)" in
"Linux")
do_distro
;;
"Darwin")
do_osx_install
;;
"FreeBSD")
do_freebsd_install
;;
*)
die "Sorry, this installer does not support your operating system: $(uname).
See http://docs.haskellstack.org/en/stable/install_and_upgrade/"
esac
}
# Download a URL to file using 'curl' or 'wget'.
dl_to_file() {
if has_curl ; then
if ! curl ${QUIET:+-sS} -L -o "$2" "$1"; then
die "curl download failed: $1"
fi
elif has_wget ; then
if ! wget ${QUIET:+-q} "-O$2" "$1"; then
die "wget download failed: $1"
fi
else
# should already have checked for this, otherwise this message will probably
# not be displayed, since dl_to_stdout will be part of a pipeline
die "Neither wget nor curl is available, please install one to continue."
fi
}
# Check for 'curl' or 'wget' and attempt to install 'curl' if neither found,
# or fail the script if that is not possible.
check_dl_tools() {
if ! has_curl && ! has_wget ; then
if ! try_install_pkgs curl ; then
die "Neither wget nor curl is available, please install one to continue."
fi
fi
}
# Download a Stack bindst and install it in /usr/local/bin/stack.
install_from_bindist() {
IFB_URL="https://www.stackage.org/stack/$1"
check_dl_tools
make_temp_dir
dl_to_file "$IFB_URL" "$STACK_TEMP_DIR/$1.bindist"
mkdir -p "$STACK_TEMP_DIR/$1"
if ! tar xzf "$STACK_TEMP_DIR/$1.bindist" -C "$STACK_TEMP_DIR/$1"; then
die "Extract bindist failed"
fi
if ! sudocmd install -c -o 0 -g 0 -m 0755 "$STACK_TEMP_DIR/$1"/*/stack "$USR_LOCAL_BIN/stack"; then
die "Install to $USR_LOCAL_BIN/stack failed"
fi
post_install_separator
info "Stack has been installed to: $USR_LOCAL_BIN/stack"
info ""
check_usr_local_bin_on_path
}
install_arm_binary() {
install_from_bindist "linux-arm"
}
install_32bit_standard_binary() {
install_from_bindist "linux-i386"
}
install_64bit_static_binary() {
install_from_bindist "linux-x86_64-static"
}
install_32bit_gmp4_linked_binary() {
install_from_bindist "linux-i386-gmp4"
}
install_64bit_osx_binary() {
install_from_bindist "osx-x86_64"
}
install_64bit_freebsd_binary() {
install_from_bindist "freebsd-x86_64"
}
# Attempt to install packages using whichever of apt-get, dnf, yum, or apk is
# available.
try_install_pkgs() {
if has_apt_get ; then
apt_get_install_pkgs "$@"
elif has_dnf ; then
dnf_install_pkgs "$@"
elif has_yum ; then
yum_install_pkgs "$@"
elif has_apk ; then
apk_install_pkgs "$@"
else
return 1
fi
}
# Install packages using apt-get
apt_get_install_pkgs() {
if ! sudocmd apt-get install -y ${QUIET:+-qq} "$@"; then
die "Installing apt packages failed. Please run 'apt-get update' and try again."
fi
}
# Install packages using dnf
dnf_install_pkgs() {
if ! sudocmd dnf install -y ${QUIET:+-q} "$@"; then
die "Installing dnf packages failed. Please run 'dnf check-update' and try again."
fi
}
# Install packages using yum
yum_install_pkgs() {
if ! sudocmd yum install -y ${QUIET:+-q} "$@"; then
die "Installing yum packages failed. Please run 'yum check-update' and try again."
fi
}
# Install packages using apk
apk_install_pkgs() {
if ! sudocmd apk add --update ${QUIET:+-q} "$@"; then
die "Installing apk packages failed. Please run 'apk update' and try again."
fi
}
# Install packages using pkg
pkg_install_pkgs() {
if ! sudocmd pkg install -y "$@"; then
die "Installing pkg packages failed. Please run 'pkg update' and try again."
fi
}
# Get installed Stack version, if any
stack_version() {
stack --version | grep -o 'Version \([[:digit:]]\|\.\)\+'
}
# Get installed Stack's path
stack_location() {
command -v stack
}
# Check whether 'stack' command exists
has_stack() {
has_cmd stack
}
# Check whether 'wget' command exists
has_wget() {
has_cmd wget
}
# Check whether 'curl' command exists
has_curl() {
has_cmd curl
}
# Check whether 'lsb_release' command exists
has_lsb_release() {
has_cmd lsb_release
}
# Check whether 'sudo' command exists
has_sudo() {
has_cmd sudo
}
# Check whether 'getconf' command exists
has_getconf() {
has_cmd getconf
}
# Check whether 'brew' command exists
#has_brew() {
# has_cmd brew
#}
# Check whether 'perl' command exists
has_perl() {
has_cmd perl
}
# Check whether 'apt-get' command exists
has_apt_get() {
has_cmd apt-get
}
# Check whether 'yum' command exists
has_yum() {
has_cmd yum
}
# Check whether 'apk' command exists
has_apk() {
has_cmd apk
}
# Check whether 'dnf' command exists
has_dnf() {
has_cmd dnf
}
# Check whether the given command exists
has_cmd() {
command -v "$1" > /dev/null 2>&1
}
# Check whether the given path is listed in the PATH environment variable
on_path() {
echo ":$PATH:" | grep -q :"$1":
}
# Check whether ~/.local/bin is on the PATH, and print a warning if not.
check_home_local_bin_on_path() {
if ! on_path "$HOME_LOCAL_BIN" ; then
#TODO: offer to add it for the user (pull requests welcome!)
info "WARNING: '$HOME_LOCAL_BIN' is not on your PATH."
info " For best results, please add it to the beginning of PATH in your profile."
info ""
fi
}
# Check whether /usr/local/bin is on the PATH, and print a warning if not.
check_usr_local_bin_on_path() {
if ! on_path "$USR_LOCAL_BIN" ; then
info "WARNING: '$USR_LOCAL_BIN' is not on your PATH."
info ""
fi
}
# Check whether Stack is already installed, and print an error if it is.
check_stack_installed() {
if [ "$FORCE" != "true" ] && has_stack ; then
die "Stack $(stack_version) already appears to be installed at:
$(stack_location)
Use 'stack upgrade' or your OS's package manager to upgrade,
or pass --force to this script to install anyway."
fi
}
has_hledger() {
has_cmd hledger
}
hledger_location() {
command -v hledger
}
hledger_version() {
hledger --version | awk '{print $2}'
}
has_hledger_ui() {
has_cmd hledger-ui
}
hledger_ui_location() {
command -v hledger-ui
}
hledger_ui_version() {
hledger-ui --version | awk '{print $2}'
}
has_hledger_web() {
has_cmd hledger-web
}
hledger_web_location() {
command -v hledger-web
}
hledger_web_version() {
hledger-web --version | awk '{print $2}'
}
has_hledger_api() {
has_cmd hledger-api
}
hledger_api_location() {
command -v hledger-api
}
hledger_api_version() {
hledger-api --version | awk '{print $2}'
}
# install latest hledger release with stack
install_hledger() {
(
info "installing hledger $HLEDGERVER"
# try to ensure we use the global stack project
cd
# try installing hledger in various ways, from quickest to most reliable
# TODO should try only lts-8+ on osx sierra # if [[ $(uname) == "Darwin" ]]; then
stack install --verbosity $STACKVERB $PACKAGES ||
stack install --verbosity $STACKVERB $PACKAGES --install-ghc ||
stack install --verbosity $STACKVERB $PACKAGES --resolver $RESOLVER ||
stack install --verbosity $STACKVERB $PACKAGES --resolver $RESOLVER --install-ghc
)
}
trap cleanup_temp_dir EXIT
while [ $# -gt 0 ]; do
case "$1" in
-q|--quiet)
# This tries its best to reduce output by suppressing the script's own
# messages and passing "quiet" arguments to tools that support them.
QUIET="true"
shift
;;
-f|--force)
FORCE="true"
shift
;;
-h|--help)
HELP="true"
shift
;;
*)
echo "Invalid argument: $1" >&2
exit 1
;;
esac
done
if [[ $HELP ]] ; then
usage
exit 0
fi
if ! has_stack ; then
echo "installing stack"
do_os
fi
echo "stack $(stack_version) is installed at $(stack_location)"
if [[ -n "$QUIET" ]] ; then
STACKVERB=error #silent, error, warn, info, debug
else
STACKVERB=info
fi
PACKAGESCLI="hledger-lib-$HLEDGERVER hledger-$HLEDGERVER"
PACKAGESUI="$PACKAGESCLI hledger-ui-$HLEDGERVER"
PACKAGES="$PACKAGESUI hledger-web-$HLEDGERVER hledger-api-$HLEDGERVER"
if ! has_hledger ; then
install_hledger
fi
echo "hledger $(hledger_version) is installed at $(hledger_location)"
echo "hledger-ui $(hledger_ui_version) is installed at $(hledger_ui_location)"
echo "hledger-web $(hledger_web_version) is installed at $(hledger_web_location)"
echo "hledger-api $(hledger_api_version) is installed at $(hledger_api_location)"
check_home_local_bin_on_path