nixpkgs/pkgs/games/simutrans/default.nix
Chuck a45b3ad89f
makeWrapper: Remove unused extraFlagsArray feature
There is a bug in this feature: It allows extra arguments to leak in
from the environment. For example:

  $ export extraFlagsArray=date
  $ man ls

Note that you get the man page for date rather than for ls. This happens
because 'man' happens to use a wrapper (to add groff to its PATH).

An attempt to fix this was made in 5ae18574fc in PR #19328 for
issue #2537, but 1. That change didn't actually fix the problem because
it addressed makeWrapper's environment during the build process, not the
constructed wrapper script's environment after installation, and 2. That
change was apparently accidentally lost when merged with 7ff6eec5fd.

Rather than trying to fix the bug again, we remove the extraFlagsArray
feature, since it has never been used in the public repo in the ten
years it has been available.

wrapAclocal continues to use its own, separate flavor of extraFlagsArray
in a more limited context. The analogous bug there was fixed in
4d7d10da6b in 2011.
2019-09-25 09:23:09 -07:00

171 lines
5.4 KiB
Nix

{ stdenv, fetchurl, pkgconfig, unzip, zlib, libpng, bzip2, SDL, SDL_mixer
, buildEnv, config, runtimeShell
}:
let
# Choose your "paksets" of objects, images, text, music, etc.
paksets = config.simutrans.paksets or "pak64 pak64.japan pak128 pak128.britain pak128.german";
result = with stdenv.lib; withPaks (
if paksets == "*" then attrValues pakSpec # taking all
else map (name: pakSpec.${name}) (splitString " " paksets)
);
ver1 = "120";
ver2 = "2";
ver3 = "2";
version = "${ver1}.${ver2}.${ver3}";
ver_dash = "${ver1}-${ver2}-${ver3}";
binary_src = fetchurl {
url = "mirror://sourceforge/simutrans/simutrans/${ver_dash}/simutrans-src-${ver_dash}.zip";
sha256 = "1yi6rwbrnfd65qfz63cncw2n56pbypvg6cllwh71mgvs6x2c28kz";
};
# As of 2015/03, many packsets still didn't have a release for version 120.
pakSpec = stdenv.lib.mapAttrs
(pakName: attrs: mkPak (attrs // {inherit pakName;}))
{
pak64 = {
srcPath = "120-2/simupak64-120-2";
sha256 = "1s310pssar4s1nf6gi9cizbx4m75avqm2qk039ha5rk8jk4lzkmk";
};
"pak64.japan" = {
# No release for 120.2 yet!
srcPath = "120-0/simupak64.japan-120-0-1";
sha256 = "14swy3h4ij74bgaw7scyvmivfb5fmp21nixmhlpk3mav3wr3167i";
};
pak128 = {
srcPath = "pak128%20for%20ST%20120.2.2%20%282.7%2C%20minor%20changes%29/pak128";
sha256 = "1x6g6yfv1hvjyh3ciccly1i2k2n2b63dw694gdg4j90a543rmclg";
};
"pak128.britain" = {
srcPath = "pak128.Britain%20for%20120-1/pak128.Britain.1.17-120-1";
sha256 = "1nviwqizvch9n3n826nmmi7c707dxv0727m7lhc1n2zsrrxcxlr5";
};
"pak128.cs" = { # note: it needs pak128 to work
url = "mirror://sourceforge/simutrans/Pak128.CS/pak128.cz_v.0.2.1.zip";
sha256 = "008d8x1s0vxsq78rkczlnf57pv1n5hi1v5nbd1l5w3yls7lk11sc";
};
"pak128.german" = {
url = "mirror://sourceforge/simutrans/PAK128.german/"
+ "PAK128.german_0.10.x_for_ST_120.x/PAK128.german_0.10.3_for_ST_120.x.zip";
sha256 = "1379zcviyf3v0wsli33sqa509k6zlw6fkk57vahc44mrnhka5fpb";
};
/* This release contains accented filenames that prevent unzipping.
"pak192.comic" = {
srcPath = "pak192comic%20for%20${ver2_dash}/pak192comic-0.4-${ver2_dash}up";
sha256 = throw "";
};
*/
};
mkPak = {
sha256, pakName, srcPath ? null
, url ? "mirror://sourceforge/simutrans/${pakName}/${srcPath}.zip"
}:
stdenv.mkDerivation {
name = "simutrans-${pakName}";
dontUnpack = true;
preferLocalBuild = true;
installPhase = let src = fetchurl { inherit url sha256; };
in ''
mkdir -p "$out/share/simutrans/${pakName}"
cd "$out/share/simutrans/${pakName}"
"${unzip}/bin/unzip" "${src}"
chmod -R +w . # some zipfiles need that
set +o pipefail # no idea why it's needed
toStrip=`find . -iname '*.pak' | head -n 1 | sed 's|\./\(.*\)/[^/]*$|\1|'`
echo "Detected path '$toStrip' to strip"
mv ./"$toStrip"/* .
rmdir -p "$toStrip"
'';
};
/* The binaries need all data in one directory; the default is directory
of the executable, and another option is the current directory :-/ */
withPaks = paks: buildEnv {
inherit (binaries) name;
paths = [binaries] ++ paks;
postBuild = ''
rm "$out/bin" && mkdir "$out/bin"
cat > "$out/bin/simutrans" <<EOF
#!${runtimeShell}
cd "$out"/share/simutrans
exec "${binaries}/bin/simutrans" -use_workdir "\$@"
EOF
chmod +x "$out/bin/simutrans"
'';
passthru.meta = binaries.meta // { hydraPlatforms = []; };
passthru.binaries = binaries;
};
binaries = stdenv.mkDerivation {
pname = "simutrans";
inherit version;
src = binary_src;
sourceRoot = ".";
nativeBuildInputs = [ pkgconfig ];
buildInputs = [ zlib libpng bzip2 SDL SDL_mixer unzip ];
configurePhase = let
# Configuration as per the readme.txt and config.template
platform =
if stdenv.isLinux then "linux" else
if stdenv.isDarwin then "mac" else throw "add your platform";
config = ''
BACKEND = mixer_sdl
COLOUR_DEPTH = 16
OSTYPE = ${platform}
VERBOSE = 1
'';
#TODO: MULTI_THREAD = 1 is "highly recommended",
# but it's roughly doubling CPU usage for me
in ''
echo "${config}" > config.default
# Use ~/.simutrans instead of ~/simutrans
substituteInPlace simsys.cc --replace '%s/simutrans' '%s/.simutrans'
# use -O2 optimization (defaults are -O or -O3)
sed -i -e '/CFLAGS += -O/d' Makefile
export CFLAGS+=-O2
'';
enableParallelBuilding = true;
installPhase = ''
mkdir -p $out/share/
mv simutrans $out/share/
mkdir -p $out/bin/
mv build/default/sim $out/bin/simutrans
'';
meta = with stdenv.lib; {
description = "A simulation game in which the player strives to run a successful transport system";
longDescription = ''
Simutrans is a cross-platform simulation game in which the
player strives to run a successful transport system by
transporting goods, passengers, and mail between
places. Simutrans is an open source remake of Transport Tycoon.
'';
homepage = http://www.simutrans.com/;
license = with licenses; [ artistic1 gpl1Plus ];
maintainers = with maintainers; [ kkallio vcunat phile314 ];
platforms = with platforms; linux; # TODO: ++ darwin;
};
};
in result