aboutsummaryrefslogtreecommitdiffstats
path: root/share/qbs/modules/archiver/archiver.qbs
blob: 069e76717d71ea84509010f11006133de2c128cf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of Qbs.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms and
** conditions see http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

import qbs.Environment
import qbs.File
import qbs.Host
import qbs.FileInfo
import qbs.Probes

Module {
    // jar is a suitable fallback for creating zip files as they are the same format
    // This will most likely end up being used on Windows
    Depends { name: "java"; required: false }

    Probes.BinaryProbe {
        id: tarProbe
        names: ["tar"]
    }

    Probes.BinaryProbe {
        id: zipProbe
        names: ["zip"]
    }

    Probes.BinaryProbe {
        id: sevenZipProbe
        names: ["7z"]
        platformSearchPaths: {
            var paths = base;
            if (Host.os().includes("windows")) {
                var env32 = Environment.getEnv("PROGRAMFILES(X86)");
                var env64 = Environment.getEnv("PROGRAMFILES");
                if (env64 === env32 && env64.endsWith(" (x86)"))
                    env64 = env64.slice(0, -(" (x86)".length)); // QTBUG-3845
                paths.push(FileInfo.joinPaths(env64, "7-Zip"));
                paths.push(FileInfo.joinPaths(env32, "7-Zip"));
            }
            return paths;
        }
    }

    property string type
    property string archiveBaseName: product.targetName
    property string workingDirectory
    property stringList flags: []
    property path outputDirectory: product.destinationDirectory
    property string archiveExtension: {
        if (type === "7zip")
            return "7z";
        if (type == "tar") {
            var extension = "tar";
            if (compressionType !== "none")
                extension += "." + compressionType;
            return extension;
        }
        if (type === "zip")
            return "zip";
        return undefined;
    }
    property string command: {
        if (type === "7zip")
            return sevenZipProbe.filePath;
        if (type === "tar") {
            if (tarProbe.found)
                return tarProbe.filePath;
            if (sevenZipProbe.found)
                return sevenZipProbe.filePath;
        }
        if (type === "zip") {
            // Prefer zip (probably Info-Zip) and fall back to 7z or jar when it's not available
            // (as is the likely case on Windows)
            if (zipProbe.found)
                return zipProbe.filePath;
            if (sevenZipProbe.found)
                return sevenZipProbe.filePath;
            if (java.present)
                return java.jarFilePath;
        }
        return undefined;
    }

    property string compressionLevel
    property string compressionType: {
        if (type === "tar")
            return "gz";
        return undefined;
    }

    PropertyOptions {
        name: "type"
        description: "The type of archive to create."
        allowedValues: ["7zip", "tar", "zip"]
    }

    PropertyOptions {
        name: "compressionLevel"
        description: "How much effort to put into compression.\n"
            + "Higher numbers mean smaller archive files at the cost of taking more time.\n"
            + "This property is only used for the '7zip' and 'zip' types.\n"
            + "'7zip' only supports 0 and odd numbers."
        allowedValues: [undefined, "0", "1", "2", "3", "4", "5", "6", "7", "8", "9"]
    }

    PropertyOptions {
        name: "compressionType"
        description: "The compression format to use.\n"
            + "For tar archives, the respective tool needs to be present.\n"
            + "This property is only used for the 'tar' and 'zip' types."
        allowedValues: ["none", "gz", "bz2", "Z", "xz", "deflate", "store"]
    }

    Rule {
        inputs: ["archiver.input-list"]

        Artifact {
            filePath: FileInfo.joinPaths(product.moduleProperty("archiver", "outputDirectory"),
                              product.moduleProperty("archiver", "archiveBaseName") + '.'
                                         + product.moduleProperty("archiver", "archiveExtension"));
            fileTags: ["archiver.archive"]
        }

        prepare: {
            var binary = product.moduleProperty("archiver", "command");
            var binaryName = FileInfo.baseName(binary);
            var args = [];
            var commands = [];
            var type = product.moduleProperty("archiver", "type");
            var compression = product.moduleProperty("archiver", "compressionType");
            var compressionLevel = product.moduleProperty("archiver", "compressionLevel");
            if (binaryName === "7z") {
                var rmCommand = new JavaScriptCommand();
                rmCommand.silent = true;
                rmCommand.sourceCode = function() {
                    if (File.exists(output.filePath))
                        File.remove(output.filePath);
                };
                commands.push(rmCommand);
                args.push("a", "-y", "-mmt=on");
                switch (type) {
                case "7zip":
                    args.push("-t7z");
                    break;
                case "zip":
                    args.push("-tzip");
                    break;
                case "tar":
                    if (compression === "gz")
                        args.push("-tgzip");
                    else if (compression === "bz2")
                        args.push("-tbzip2");
                    else
                        args.push("-ttar");
                    break;
                default:
                    throw "7zip: unrecognized archive type: '" + type + "'";
                }

                if (compressionLevel)
                    args.push("-mx" + compressionLevel);
                args = args.concat(product.moduleProperty("archiver", "flags"));
                args.push(output.filePath);
                args.push("@" + input.filePath);
            } else if (binaryName === "tar" && type === "tar") {
                args.push("-c");
                if (compression === "gz")
                    args.push("-z");
                else if (compression === "bz2")
                    args.push("-j");
                else if (compression === "Z")
                    args.push("-Z");
                else if (compression === "xz")
                    args.push("-J");
                args.push("-f", output.filePath, "-T", input.filePath);
                args = args.concat(product.moduleProperty("archiver", "flags"));
            } else if (binaryName === "jar" && type === "zip") {
                if (compression === "none" || compressionLevel === "0")
                    args.push("-0");

                args.push("-cfM", output.filePath, "@" + input.filePath);
                args = args.concat(product.moduleProperty("archiver", "flags"));
            } else if (binaryName === "zip" && type === "zip") {
                // The "zip" program included with most Linux and Unix distributions
                // (including macOS) is Info-ZIP's Zip, so this should be fairly portable.
                if (compression === "none") {
                    args.push("-0");
                } else {
                    compression = compression === "bz2" ? "bzip2" : compression;
                    if (["store", "deflate", "bzip2"].includes(compression))
                        args.push("-Z", compression);

                    if (compressionLevel)
                        args.push("-" + compressionLevel);
                }

                args.push("-r", output.filePath, ".", "-i@" + input.filePath);
                args = args.concat(product.moduleProperty("archiver", "flags"));
            } else if (["tar", "zip", "jar"].includes(binaryName)) {
                throw binaryName + ": unrecognized archive type: '" + type + "'";
            } else if (binaryName) {
                throw "unrecognized archive tool: '" + binaryName + "'";
            } else {
                throw "no archive tool available to produce archive type: '" + type + "'";
            }

            var archiverCommand = new Command(binary, args);
            archiverCommand.description = "creating archive file " + output.fileName;
            archiverCommand.highlight = "linker";
            archiverCommand.workingDirectory
                    = product.moduleProperty("archiver", "workingDirectory");
            commands.push(archiverCommand);
            return commands;
        }
    }
}