diff options
Diffstat (limited to 'nixpkgs/pkgs/servers/web-apps/matomo/default.nix')
-rw-r--r-- | nixpkgs/pkgs/servers/web-apps/matomo/default.nix | 125 |
1 files changed, 125 insertions, 0 deletions
diff --git a/nixpkgs/pkgs/servers/web-apps/matomo/default.nix b/nixpkgs/pkgs/servers/web-apps/matomo/default.nix new file mode 100644 index 000000000000..c9584fb25e35 --- /dev/null +++ b/nixpkgs/pkgs/servers/web-apps/matomo/default.nix @@ -0,0 +1,125 @@ +{ lib, stdenv, fetchurl, makeWrapper, php, nixosTests }: + +let + versions = { + matomo = { + version = "4.16.1"; + hash = "sha256-cGnsxfpvt7FyhxFcA2/gWWe7CyanVGZVKtCDES3XLdI="; + }; + matomo_5 = { + version = "5.0.2"; + hash = "sha256-rLAShJLtzd3HB1Je+P+i8GKWdeklyC2sTnmPR07Md+8="; + }; + matomo-beta = { + version = "5.0.0"; + # `beta` examples: "b1", "rc1", null + # when updating: use null if stable version is >= latest beta or release candidate + beta = "rc9"; + hash = "sha256-OXxJCEXcrl6UXYh+jbNqLQGYphrSjxaOAZg3AZVPAqs="; + }; + }; + common = pname: { version, hash, beta ? null }: + let + fullVersion = version + lib.optionalString (beta != null) "-${toString beta}"; + name = "${pname}-${fullVersion}"; + in + + stdenv.mkDerivation rec { + inherit name; + version = fullVersion; + + src = fetchurl { + url = "https://builds.matomo.org/matomo-${version}.tar.gz"; + inherit hash; + }; + + nativeBuildInputs = [ makeWrapper ]; + + patches = [ + # This changes the default value of the database server field + # from 127.0.0.1 to localhost. + # unix socket authentication only works with localhost, + # but password-based SQL authentication works with both. + # TODO: is upstream interested in this? + # -> discussion at https://github.com/matomo-org/matomo/issues/12646 + ./make-localhost-default-database-host.patch + # This changes the default config for path.geoip2 so that it doesn't point + # to the nix store. + (if lib.versionOlder version "5.0" + then ./change-path-geoip2-4.x.patch + else ./change-path-geoip2-5.x.patch) + ]; + + # this bootstrap.php adds support for getting PIWIK_USER_PATH + # from an environment variable. Point it to a mutable location + # to be able to use matomo read-only from the nix store + postPatch = '' + cp ${./bootstrap.php} bootstrap.php + ''; + + # TODO: future versions might rename the PIWIK_… variables to MATOMO_… + # TODO: Move more unnecessary files from share/, especially using PIWIK_INCLUDE_PATH. + # See https://forum.matomo.org/t/bootstrap-php/5926/10 and + # https://github.com/matomo-org/matomo/issues/11654#issuecomment-297730843 + installPhase = '' + runHook preInstall + + # copy everything to share/, used as webroot folder, and then remove what's known to be not needed + mkdir -p $out/share + cp -ra * $out/share/ + # tmp/ is created by matomo in PIWIK_USER_PATH + rmdir $out/share/tmp + # config/ needs to be accessed by PIWIK_USER_PATH anyway + ln -s $out/share/config $out/ + + makeWrapper ${php}/bin/php $out/bin/matomo-console \ + --add-flags "$out/share/console" + + runHook postInstall + ''; + + filesToFix = [ + "misc/composer/build-xhprof.sh" + "misc/composer/clean-xhprof.sh" + "misc/cron/archive.sh" + "plugins/GeoIp2/config/config.php" + "plugins/Installation/FormDatabaseSetup.php" + "vendor/pear/archive_tar/sync-php4" + "vendor/szymach/c-pchart/coverage.sh" + "vendor/matomo/matomo-php-tracker/run_tests.sh" + "vendor/twig/twig/drupal_test.sh" + ]; + + # This fixes the consistency check in the admin interface + # + # The filesToFix list may contain files that are exclusive to only one of the versions we build + # make sure to test for existence to avoid erroring on an incompatible version and failing + postFixup = '' + pushd $out/share > /dev/null + for f in $filesToFix; do + if [ -f "$f" ]; then + length="$(wc -c "$f" | cut -d' ' -f1)" + hash="$(md5sum "$f" | cut -d' ' -f1)" + sed -i "s:\\(\"$f\"[^(]*(\\).*:\\1\"$length\", \"$hash\"),:g" config/manifest.inc.php + else + echo "INFO(files-to-fix): $f does not exist in this version" + fi + done + popd > /dev/null + ''; + + passthru = { + tests = nixosTests.matomo."${pname}"; + }; + + meta = with lib; { + description = "A real-time web analytics application"; + mainProgram = "matomo-console"; + license = licenses.gpl3Plus; + homepage = "https://matomo.org/"; + platforms = platforms.all; + maintainers = with maintainers; [ florianjacob kiwi sebbel twey boozedog ] ++ teams.flyingcircus.members; + }; + }; +in +lib.mapAttrs common versions |