tarball-cloud.sh

#!/bin/bash

# Copyright (©) 2003-2025 Teus Benschop.

# 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, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


DEBIANSOURCE=`dirname $0`
cd $DEBIANSOURCE
DEBIANSOURCE=`pwd`
echo Running script in $DEBIANSOURCE.


# If the debian/README* or README.Debian files contain no useful content,
# they should be updated with something useful, or else be removed.


echo Remove unwanted files from the Debian packaging.
find . -name .DS_Store -delete
echo Remove macOS extended attributes fromm the packaging.
# The attributes would make their way into the tarball,
# get unpacked within Debian,
# and would cause lintian errors.
xattr -r -c *


echo Remove macOS extended attributes fromm the core cloud library.
CLOUDSOURCE="../cloud"
pushd $CLOUDSOURCE
if [ $? -ne 0 ]; then exit; fi
CLOUDSOURCE=`pwd`
xattr -r -c *
echo Create a tarball of the core cloud library.
rm -f bibledit*gz
make dist --jobs=8
if [ $? -ne 0 ]; then exit; fi
popd


# The script unpacks the Bibledit Cloud tarball,
# modifies it, and repacks it into a Debian tarball.
# Reasons for doing so are among others:
# - The Debian builder would otherwise notice differences
#   between the supplied tarball and the modified source.
#   dpkg-source: error: aborting due to unexpected upstream changes
# - In this way it does not need to generate patches in the 'debian' folder.
# - Comply with the Debian Free Software Guidelines.


TMPDEBIAN=/tmp/bibledit-debian
echo Unpack the tarball and source in working folder $TMPDEBIAN.
rm -rf $TMPDEBIAN
if [ $? -ne 0 ]; then exit; fi
mkdir $TMPDEBIAN
if [ $? -ne 0 ]; then exit; fi
cd $TMPDEBIAN
if [ $? -ne 0 ]; then exit; fi
tar xf $CLOUDSOURCE/bibledit*gz
if [ $? -ne 0 ]; then exit; fi
cd bibledit*
if [ $? -ne 0 ]; then exit; fi


echo Change \"bibledit\" to \"bibledit-cloud\" in configuring code.
sed -i.bak 's/share\/bibledit/share\/bibledit-cloud/g' configure.ac
if [ $? -ne 0 ]; then exit; fi
sed -i.bak 's/\[bibledit\]/\[bibledit-cloud\]/g' configure.ac
if [ $? -ne 0 ]; then exit; fi
rm configure.ac.bak
if [ $? -ne 0 ]; then exit; fi


echo Set the name of the binary to bibledit-cloud.
sed -i.bak 's/.*PROGRAMS.*/bin_PROGRAMS = bibledit-cloud/' Makefile.am
if [ $? -ne 0 ]; then exit; fi
sed -i.bak 's/server_/bibledit_cloud_/g' Makefile.am
if [ $? -ne 0 ]; then exit; fi
sed -i.bak '/unittest_/d' Makefile.am
if [ $? -ne 0 ]; then exit; fi
sed -i.bak '/generate_/d' Makefile.am
if [ $? -ne 0 ]; then exit; fi
rm Makefile.am.bak
if [ $? -ne 0 ]; then exit; fi


echo Remove client man file.
rm man/bibledit.1
if [ $? -ne 0 ]; then exit; fi
sed -i.bak 's/man\/bibledit\.1 //g' Makefile.am
if [ $? -ne 0 ]; then exit; fi
rm Makefile.am.bak
if [ $? -ne 0 ]; then exit; fi


echo Remove some files from the core library
# It does not use the "bibledit" shell script.
# That script writes to the crontab.
# Delete it so it can't be used accidentially.
rm bibledit
if [ $? -ne 0 ]; then exit; fi
rm generate
#if [ $? -ne 0 ]; then exit; fi
rm valgrind
if [ $? -ne 0 ]; then exit; fi
rm dev
if [ $? -ne 0 ]; then exit; fi
# No test data in the Debian tarball.
# Some data gives a lintian warning like this:
# W: bibledit-cloud-data: executable-not-elf-or-script usr/share/bibledit-cloud/unittests/..
# There will be licensing issues to be fixed too.
rm -rf unittests
if [ $? -ne 0 ]; then exit; fi


echo Disable mach.h definitions.
# On Debian hurd-i386 it has the header mach/mach.h.
# But it does not have the 64 bits statistics definitions.
# It fails to compile there.
# So disable them.
sed -i.bak '/HAVE_MACH_MACH/d' configure.ac
if [ $? -ne 0 ]; then exit; fi
rm configure.ac.bak
if [ $? -ne 0 ]; then exit; fi


echo Link with the system-provided mbed TLS library.
# It is important to use the system-provided mbedtls library because it is a security library.
# This way, Debian updates to mbedtls become available to Bibledit too.
# Were the library embedded, this would not be the case.
# Fix for lintian error "embedded-library usr/bin/bibledit: mbedtls":
# * Remove mbedtls from the list of sources to compile.
# * Add -lmbedtls and friends to the linker flags.
sed -i.bak '/mbedtls\//d' Makefile.am
if [ $? -ne 0 ]; then exit; fi
sed -i.bak 's/# debian//g' Makefile.am
if [ $? -ne 0 ]; then exit; fi
rm *.bak
# Also remove the embedded *.h files to be sure building does not reference them.
# There had been a case that building used the embedded *.h files, leading to segmentation faults.
# For cleanness, remove the whole mbedtls directory, so all traces of it are gone completely.
rm -rf mbedtls*


echo Link with the system-provided utf8proc library.
sed -i.bak '/utf8proc/d' Makefile.am
if [ $? -ne 0 ]; then exit; fi
rm *.bak
# Remove the embedded utf8proc files.
rm -rf utf8proc*


echo Reconfiguring the source.
./reconfigure
if [ $? -ne 0 ]; then exit; fi
rm -rf autom4te.cache
if [ $? -ne 0 ]; then exit; fi


echo Remove extra license files.
# Fix for the lintian warnings "extra-license-file".
find . -name COPYING -delete
if [ $? -ne 0 ]; then exit; fi
find . -name LICENSE -delete
if [ $? -ne 0 ]; then exit; fi


echo Remove extra font files.
# Fix for the lintian warning "duplicate-font-file".
rm fonts/SILEOT.ttf
if [ $? -ne 0 ]; then exit; fi


echo Remove unwanted files.
find . -name .DS_Store -delete
echo Remove macOS extended attributes.
# The attributes would make their way into the tarball,
# get unpacked within Debian,
# and would cause build errors there.
xattr -r -c *


echo Configure and clean the source.
./configure
if [ $? -ne 0 ]; then exit; fi
pkgdata/create.sh
if [ $? -ne 0 ]; then exit; fi
make distclean --jobs=8
if [ $? -ne 0 ]; then exit; fi


echo Create updated renamed tarball for Debian.
cd $TMPDEBIAN
OLDTARDIR=`ls`
NEWTARDIR=${OLDTARDIR/bibledit/bibledit-cloud}
mv $OLDTARDIR $NEWTARDIR
tar czf $NEWTARDIR.tar.gz $NEWTARDIR
if [ $? -ne 0 ]; then exit; fi


echo Copy the Debian tarball to the Desktop.
rm -f ~/Desktop/bibledit-*gz
cp $TMPDEBIAN/*.gz ~/Desktop
if [ $? -ne 0 ]; then exit; fi


source ~/scr/sid-ip
if [ $? -ne 0 ]; then exit; fi
echo The IP address of the Debian machine is $DEBIANSID.
echo Copy the Debian tarball to the Debian builder.
scp ~/Desktop/*.gz $DEBIANSID:.
if [ $? -ne 0 ]; then exit; fi


echo Ready creating bibledit-cloud tarball for Debian.