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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.drill.common.scanner;
import static com.fasterxml.jackson.databind.SerializationFeature.INDENT_OUTPUT;
import static java.lang.String.format;
import static java.util.Arrays.asList;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.List;
import java.util.Set;
import org.apache.drill.common.config.DrillConfig;
import org.apache.drill.common.exceptions.DrillRuntimeException;
import org.apache.drill.common.scanner.persistence.ScanResult;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectReader;
import com.fasterxml.jackson.databind.ObjectWriter;
/**
* main class to integrate classpath scanning in the build.
* @see BuildTimeScan#main(String[])
*/
public class BuildTimeScan {
private static final org.slf4j.Logger logger = org.slf4j.LoggerFactory.getLogger(BuildTimeScan.class);
private static final String REGISTRY_FILE = "META-INF/drill-module-scan/registry.json";
private static final ObjectMapper mapper = new ObjectMapper().enable(INDENT_OUTPUT);
private static final ObjectReader reader = mapper.readerFor(ScanResult.class);
private static final ObjectWriter writer = mapper.writerFor(ScanResult.class);
/**
* @return paths that have the prescanned registry file in them
*/
static Set<URL> getPrescannedPaths() {
return ClassPathScanner.forResource(REGISTRY_FILE, true);
}
/**
* loads all the prescanned resources from classpath
* @return the result of the previous scan
*/
static ScanResult load() {
return loadExcept(null);
}
/**
* loads all the prescanned resources from classpath
* (except for the target location in case it already exists)
* @return the result of the previous scan
*/
private static ScanResult loadExcept(URL ignored) {
Set<URL> preScanned = ClassPathScanner.forResource(REGISTRY_FILE, false);
ScanResult result = null;
for (URL u : preScanned) {
if (ignored!= null && u.toString().startsWith(ignored.toString())) {
continue;
}
try (InputStream reflections = u.openStream()) {
ScanResult ref = reader.readValue(reflections);
if (result == null) {
result = ref;
} else {
result = result.merge(ref);
}
} catch (IOException e) {
throw new DrillRuntimeException("can't read function registry at " + u, e);
}
}
if (result != null) {
if (logger.isInfoEnabled()) {
StringBuilder sb = new StringBuilder();
sb.append(format("Loaded prescanned packages %s from locations:\n", result.getScannedPackages()));
for (URL u : preScanned) {
sb.append('\t');
sb.append(u.toExternalForm());
sb.append('\n');
}
}
logger.info(format("Loaded prescanned packages %s from locations %s", result.getScannedPackages(), preScanned));
return result;
} else {
return ClassPathScanner.emptyResult();
}
}
private static void save(ScanResult scanResult, File file) {
try {
writer.writeValue(file, scanResult);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
/**
* to generate the prescan file during build
* @param args the root path for the classes where {@link BuildTimeScan#REGISTRY_FILE} is generated
* @throws Exception
*/
public static void main(String[] args) throws Exception {
if (args.length != 1) {
throw new IllegalArgumentException("Usage: java {cp} " + BuildTimeScan.class.getName() + " path/to/scan");
}
String basePath = args[0];
logger.info("Scanning: {}", basePath);
File registryFile = new File(basePath, REGISTRY_FILE);
File dir = registryFile.getParentFile();
if ((!dir.exists() && !dir.mkdirs()) || !dir.isDirectory()) {
throw new IllegalArgumentException("could not create dir " + dir.getAbsolutePath());
}
DrillConfig config = DrillConfig.create();
// normalize
if (!basePath.endsWith("/")) {
basePath = basePath + "/";
}
if (!basePath.startsWith("/")) {
basePath = "/" + basePath;
}
URL url = new URL("file:" + basePath);
Set<URL> markedPaths = ClassPathScanner.getMarkedPaths();
if (!markedPaths.contains(url)) {
throw new IllegalArgumentException(url + " not in " + markedPaths);
}
List<String> packagePrefixes = ClassPathScanner.getPackagePrefixes(config);
List<String> baseClasses = ClassPathScanner.getScannedBaseClasses(config);
List<String> scannedAnnotations = ClassPathScanner.getScannedAnnotations(config);
ScanResult preScanned = loadExcept(url);
ScanResult scan = ClassPathScanner.scan(
asList(url),
packagePrefixes,
baseClasses,
scannedAnnotations,
preScanned);
save(scan, registryFile);
}
}
|
