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
|
// Copyright 2019 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package android
import (
"path/filepath"
"github.com/google/blueprint"
)
func init() {
pctx.SourcePathVariable("merge_notices", "build/soong/scripts/mergenotice.py")
pctx.SourcePathVariable("generate_notice", "build/make/tools/generate-notice-files.py")
pctx.HostBinToolVariable("minigzip", "minigzip")
}
type NoticeOutputs struct {
Merged OptionalPath
TxtOutput OptionalPath
HtmlOutput OptionalPath
HtmlGzOutput OptionalPath
}
var (
mergeNoticesRule = pctx.AndroidStaticRule("mergeNoticesRule", blueprint.RuleParams{
Command: `${merge_notices} --output $out $in`,
CommandDeps: []string{"${merge_notices}"},
Description: "merge notice files into $out",
})
generateNoticeRule = pctx.AndroidStaticRule("generateNoticeRule", blueprint.RuleParams{
Command: `rm -rf $$(dirname $txtOut) $$(dirname $htmlOut) $$(dirname $out) && ` +
`mkdir -p $$(dirname $txtOut) $$(dirname $htmlOut) $$(dirname $out) && ` +
`${generate_notice} --text-output $txtOut --html-output $htmlOut -t "$title" -s $inputDir && ` +
`${minigzip} -c $htmlOut > $out`,
CommandDeps: []string{"${generate_notice}", "${minigzip}"},
Description: "produce notice file $out",
}, "txtOut", "htmlOut", "title", "inputDir")
)
func MergeNotices(ctx ModuleContext, mergedNotice WritablePath, noticePaths []Path) {
ctx.Build(pctx, BuildParams{
Rule: mergeNoticesRule,
Description: "merge notices",
Inputs: noticePaths,
Output: mergedNotice,
})
}
func BuildNoticeOutput(ctx ModuleContext, installPath InstallPath, installFilename string,
noticePaths []Path) NoticeOutputs {
// Merge all NOTICE files into one.
// TODO(jungjw): We should just produce a well-formatted NOTICE.html file in a single pass.
//
// generate-notice-files.py, which processes the merged NOTICE file, has somewhat strict rules
// about input NOTICE file paths.
// 1. Their relative paths to the src root become their NOTICE index titles. We want to use
// on-device paths as titles, and so output the merged NOTICE file the corresponding location.
// 2. They must end with .txt extension. Otherwise, they're ignored.
noticeRelPath := InstallPathToOnDevicePath(ctx, installPath.Join(ctx, installFilename+".txt"))
mergedNotice := PathForModuleOut(ctx, filepath.Join("NOTICE_FILES/src", noticeRelPath))
MergeNotices(ctx, mergedNotice, noticePaths)
// Transform the merged NOTICE file into a gzipped HTML file.
txtOuptut := PathForModuleOut(ctx, "NOTICE_txt", "NOTICE.txt")
htmlOutput := PathForModuleOut(ctx, "NOTICE_html", "NOTICE.html")
htmlGzOutput := PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
title := "Notices for " + ctx.ModuleName()
ctx.Build(pctx, BuildParams{
Rule: generateNoticeRule,
Description: "generate notice output",
Input: mergedNotice,
Output: htmlGzOutput,
ImplicitOutputs: WritablePaths{txtOuptut, htmlOutput},
Args: map[string]string{
"txtOut": txtOuptut.String(),
"htmlOut": htmlOutput.String(),
"title": title,
"inputDir": PathForModuleOut(ctx, "NOTICE_FILES/src").String(),
},
})
return NoticeOutputs{
Merged: OptionalPathForPath(mergedNotice),
TxtOutput: OptionalPathForPath(txtOuptut),
HtmlOutput: OptionalPathForPath(htmlOutput),
HtmlGzOutput: OptionalPathForPath(htmlGzOutput),
}
}
|
