pkgs/applications/science/misc/openrefine/default.nix

   1 { lib
   2 , stdenv
   3 , fetchFromGitHub
   4 , buildNpmPackage
   5 , curl
   6 , jdk
   7 , jq
   8 , makeWrapper
   9 , maven
  10 }:
  11
  12 let
  13   version = "3.8.5";
  14   src = fetchFromGitHub {
  15     owner = "openrefine";
  16     repo = "openrefine";
  17     rev = version;
  18     hash = "sha256-8QAnZCvSUMuRj/Rd85j79GXDQxl8HlEaiU4StsXDdpU=";
  19   };
  20
  21   npmPkg = buildNpmPackage {
  22     inherit src version;
  23
  24     pname = "openrefine-npm";
  25     sourceRoot = "${src.name}/main/webapp";
  26
  27     npmDepsHash = "sha256-u9qledNFqGgMmOIsm2T8w3UoaLbb7WtksUw6xLoRgU8=";
  28
  29     # package.json doesn't supply a version, which npm doesn't like - fix this.
  30     # directly referencing jq because buildNpmPackage doesn't pass
  31     # nativeBuildInputs through to fetchNpmDeps
  32     postPatch = ''
  33       NEW_PACKAGE_JSON=$(mktemp)
  34       ${jq}/bin/jq '. + {version: $ENV.version}' package.json > $NEW_PACKAGE_JSON
  35       cp $NEW_PACKAGE_JSON package.json
  36     '';
  37
  38     dontNpmBuild = true;
  39     installPhase = ''
  40       mkdir -p $out
  41       cp -r modules/core/3rdparty/* $out/
  42     '';
  43   };
  44
  45 in maven.buildMavenPackage {
  46   inherit src version;
  47
  48   pname = "openrefine";
  49
  50   postPatch = ''
  51     cp -r ${npmPkg} main/webapp/modules/core/3rdparty
  52   '';
  53
  54   mvnJdk = jdk;
  55   mvnParameters = "-pl !packaging";
  56   mvnHash = "sha256-SrEsJfiZrPy2zZ0Vzl7+d+8XUHGd2DOOs+PHBOZrbIU=";
  57
  58   nativeBuildInputs = [ makeWrapper ];
  59
  60   doCheck = false;
  61
  62   installPhase = ''
  63     mkdir -p $out/lib/server/target/lib
  64     cp -r server/target/lib/* $out/lib/server/target/lib/
  65     cp server/target/openrefine-*-server.jar $out/lib/server/target/lib/
  66
  67     mkdir -p $out/lib/webapp
  68     cp -r main/webapp/{WEB-INF,modules} $out/lib/webapp/
  69     (
  70       cd extensions
  71       for ext in * ; do
  72         if [ -d "$ext/module" ] ; then
  73           mkdir -p "$out/lib/webapp/extensions/$ext"
  74           cp -r "$ext/module" "$out/lib/webapp/extensions/$ext/"
  75         fi
  76       done
  77     )
  78
  79     mkdir -p $out/etc
  80     cp refine.ini $out/etc/
  81
  82     mkdir -p $out/bin
  83     cp refine $out/bin/
  84   '';
  85
  86   preFixup = ''
  87     find $out -name '*.java' -delete
  88     sed -i -E 's|^(butterfly\.modules\.path =).*extensions.*$|\1 '"$out/lib/webapp/extensions|" \
  89       $out/lib/webapp/WEB-INF/butterfly.properties
  90
  91     sed -i 's|^cd `dirname \$0`$|cd '"$out/lib|" $out/bin/refine
  92
  93     cat >> $out/etc/refine.ini <<EOF
  94     REFINE_WEBAPP='$out/lib/webapp'
  95     REFINE_LIB_DIR='$out/lib/server/target/lib'
  96
  97     JAVA_HOME='${jdk.home}'
  98
  99     # non-headless mode tries to launch a browser, causing a
 100     # number of purity problems
 101     JAVA_OPTIONS='-Drefine.headless=true'
 102     EOF
 103
 104     wrapProgram $out/bin/refine \
 105       --prefix PATH : '${lib.makeBinPath [ jdk curl ]}' \
 106       --set-default REFINE_INI_PATH "$out/etc/refine.ini"
 107   '';
 108
 109   passthru = {
 110     inherit npmPkg;
 111     updateScript = ./update.sh;
 112   };
 113
 114   meta = with lib; {
 115     description = "Power tool for working with messy data and improving it";
 116     homepage = "https://openrefine.org";
 117     license = licenses.bsd3;
 118     maintainers = with maintainers; [ ris ];
 119     sourceProvenance = with sourceTypes; [
 120       fromSource
 121       binaryBytecode  # maven dependencies
 122     ];
 123     broken = stdenv.hostPlatform.isDarwin;  # builds, doesn't run
 124     mainProgram = "refine";
 125   };
 126 }