1 | |
package org.apache.maven.plugin.gpg; |
2 | |
|
3 | |
import java.util.ArrayList; |
4 | |
import java.util.Iterator; |
5 | |
import java.util.List; |
6 | |
|
7 | |
import org.apache.maven.plugin.AbstractMojo; |
8 | |
import org.apache.maven.plugin.MojoExecutionException; |
9 | |
|
10 | |
|
11 | |
|
12 | |
|
13 | |
|
14 | |
|
15 | |
|
16 | |
|
17 | |
|
18 | 0 | public class HelpMojo |
19 | |
extends AbstractMojo |
20 | |
{ |
21 | |
|
22 | |
|
23 | |
|
24 | |
|
25 | |
|
26 | |
private boolean detail; |
27 | |
|
28 | |
|
29 | |
|
30 | |
|
31 | |
|
32 | |
|
33 | |
private java.lang.String goal; |
34 | |
|
35 | |
|
36 | |
|
37 | |
|
38 | |
|
39 | |
|
40 | |
private int lineLength; |
41 | |
|
42 | |
|
43 | |
|
44 | |
|
45 | |
|
46 | |
|
47 | |
private int indentSize; |
48 | |
|
49 | |
|
50 | |
|
51 | |
public void execute() |
52 | |
throws MojoExecutionException |
53 | |
{ |
54 | 0 | if ( lineLength <= 0 ) |
55 | |
{ |
56 | 0 | getLog().warn( "The parameter 'lineLength' should be positive, using '80' as default." ); |
57 | 0 | lineLength = 80; |
58 | |
} |
59 | 0 | if ( indentSize <= 0 ) |
60 | |
{ |
61 | 0 | getLog().warn( "The parameter 'indentSize' should be positive, using '2' as default." ); |
62 | 0 | indentSize = 2; |
63 | |
} |
64 | |
|
65 | 0 | StringBuffer sb = new StringBuffer(); |
66 | |
|
67 | 0 | append( sb, "org.apache.maven.plugins:maven-gpg-plugin:1.0", 0 ); |
68 | 0 | append( sb, "", 0 ); |
69 | |
|
70 | 0 | append( sb, "Maven GPG Plugin", 0 ); |
71 | 0 | append( sb, "Signs the project artifacts with GnuPG.", 1 ); |
72 | 0 | append( sb, "", 0 ); |
73 | |
|
74 | 0 | if ( goal == null || goal.length() <= 0 ) |
75 | |
{ |
76 | 0 | append( sb, "This plugin has 3 goals:", 0 ); |
77 | 0 | append( sb, "", 0 ); |
78 | |
} |
79 | |
|
80 | 0 | if ( goal == null || goal.length() <= 0 || "help".equals( goal ) ) |
81 | |
{ |
82 | 0 | append( sb, "gpg:help", 0 ); |
83 | 0 | append( sb, "Display help information on maven-gpg-plugin.\nCall\n\u00a0\u00a0mvn\u00a0gpg:help\u00a0-Ddetail=true\u00a0-Dgoal=<goal-name>\nto display parameter details.", 1 ); |
84 | 0 | append( sb, "", 0 ); |
85 | 0 | if ( detail ) |
86 | |
{ |
87 | 0 | append( sb, "Available parameters:", 1 ); |
88 | 0 | append( sb, "", 0 ); |
89 | |
|
90 | 0 | append( sb, "detail (Default: false)", 2 ); |
91 | 0 | append( sb, "If true, display all settable properties for each goal.", 3 ); |
92 | 0 | append( sb, "", 0 ); |
93 | |
|
94 | 0 | append( sb, "goal", 2 ); |
95 | 0 | append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 ); |
96 | 0 | append( sb, "", 0 ); |
97 | |
|
98 | 0 | append( sb, "indentSize (Default: 2)", 2 ); |
99 | 0 | append( sb, "The number of spaces per indentation level, should be positive.", 3 ); |
100 | 0 | append( sb, "", 0 ); |
101 | |
|
102 | 0 | append( sb, "lineLength (Default: 80)", 2 ); |
103 | 0 | append( sb, "The maximum length of a display line, should be positive.", 3 ); |
104 | 0 | append( sb, "", 0 ); |
105 | |
} |
106 | |
} |
107 | |
|
108 | 0 | if ( goal == null || goal.length() <= 0 || "sign".equals( goal ) ) |
109 | |
{ |
110 | 0 | append( sb, "gpg:sign", 0 ); |
111 | 0 | append( sb, "Sign project artifact, the POM, and attached artifacts with GnuPG for deployment.", 1 ); |
112 | 0 | append( sb, "", 0 ); |
113 | 0 | if ( detail ) |
114 | |
{ |
115 | 0 | append( sb, "Available parameters:", 1 ); |
116 | 0 | append( sb, "", 0 ); |
117 | |
|
118 | 0 | append( sb, "ascDirectory (Default: ${project.build.directory}/gpg)", 2 ); |
119 | 0 | append( sb, "The directory where to store signature files.", 3 ); |
120 | 0 | append( sb, "", 0 ); |
121 | |
|
122 | 0 | append( sb, "excludes", 2 ); |
123 | 0 | append( sb, "A list of files to exclude from being signed. Can contain Ant-style wildcards and double wildcards. The default excludes are **/*.md5 **/*.sha1 **/*.asc.", 3 ); |
124 | 0 | append( sb, "", 0 ); |
125 | |
|
126 | 0 | append( sb, "homedir", 2 ); |
127 | 0 | append( sb, "The directory from which gpg will load keyrings. If not specified, gpg will use the value configured for its installation, e.g. ~/.gnupg or %APPDATA%/gnupg.", 3 ); |
128 | 0 | append( sb, "", 0 ); |
129 | |
|
130 | 0 | append( sb, "keyname", 2 ); |
131 | 0 | append( sb, "The \'name\' of the key to sign with. Passed to gpg as --local-user.", 3 ); |
132 | 0 | append( sb, "", 0 ); |
133 | |
|
134 | 0 | append( sb, "passphrase", 2 ); |
135 | 0 | append( sb, "The passphrase to use when signing.", 3 ); |
136 | 0 | append( sb, "", 0 ); |
137 | |
|
138 | 0 | append( sb, "skip (Default: false)", 2 ); |
139 | 0 | append( sb, "Skip doing the gpg signing.", 3 ); |
140 | 0 | append( sb, "", 0 ); |
141 | |
|
142 | 0 | append( sb, "useAgent (Default: false)", 2 ); |
143 | 0 | append( sb, "Passes --use-agent or --no-use-agent to gpg. If using an agent, the passphrase is optional as the agent will provide it.", 3 ); |
144 | 0 | append( sb, "", 0 ); |
145 | |
} |
146 | |
} |
147 | |
|
148 | 0 | if ( goal == null || goal.length() <= 0 || "sign-and-deploy-file".equals( goal ) ) |
149 | |
{ |
150 | 0 | append( sb, "gpg:sign-and-deploy-file", 0 ); |
151 | 0 | append( sb, "Signs artifacts and installs the artifact in the remote repository.", 1 ); |
152 | 0 | append( sb, "", 0 ); |
153 | 0 | if ( detail ) |
154 | |
{ |
155 | 0 | append( sb, "Available parameters:", 1 ); |
156 | 0 | append( sb, "", 0 ); |
157 | |
|
158 | 0 | append( sb, "artifactId", 2 ); |
159 | 0 | append( sb, "ArtifactId of the artifact to be deployed. Retrieved from POM file if specified.", 3 ); |
160 | 0 | append( sb, "", 0 ); |
161 | |
|
162 | 0 | append( sb, "ascDirectory", 2 ); |
163 | 0 | append( sb, "The directory where to store signature files.", 3 ); |
164 | 0 | append( sb, "", 0 ); |
165 | |
|
166 | 0 | append( sb, "classifier", 2 ); |
167 | 0 | append( sb, "Add classifier to the artifact", 3 ); |
168 | 0 | append( sb, "", 0 ); |
169 | |
|
170 | 0 | append( sb, "description", 2 ); |
171 | 0 | append( sb, "Description passed to a generated POM file (in case of generatePom=true).", 3 ); |
172 | 0 | append( sb, "", 0 ); |
173 | |
|
174 | 0 | append( sb, "file", 2 ); |
175 | 0 | append( sb, "File to be deployed.", 3 ); |
176 | 0 | append( sb, "", 0 ); |
177 | |
|
178 | 0 | append( sb, "generatePom (Default: true)", 2 ); |
179 | 0 | append( sb, "Upload a POM for this artifact. Will generate a default POM if none is supplied with the pomFile argument.", 3 ); |
180 | 0 | append( sb, "", 0 ); |
181 | |
|
182 | 0 | append( sb, "groupId", 2 ); |
183 | 0 | append( sb, "GroupId of the artifact to be deployed. Retrieved from POM file if specified.", 3 ); |
184 | 0 | append( sb, "", 0 ); |
185 | |
|
186 | 0 | append( sb, "homedir", 2 ); |
187 | 0 | append( sb, "The directory from which gpg will load keyrings. If not specified, gpg will use the value configured for its installation, e.g. ~/.gnupg or %APPDATA%/gnupg.", 3 ); |
188 | 0 | append( sb, "", 0 ); |
189 | |
|
190 | 0 | append( sb, "keyname", 2 ); |
191 | 0 | append( sb, "The \'name\' of the key to sign with. Passed to gpg as --local-user.", 3 ); |
192 | 0 | append( sb, "", 0 ); |
193 | |
|
194 | 0 | append( sb, "packaging", 2 ); |
195 | 0 | append( sb, "Type of the artifact to be deployed. Retrieved from POM file if specified.", 3 ); |
196 | 0 | append( sb, "", 0 ); |
197 | |
|
198 | 0 | append( sb, "passphrase", 2 ); |
199 | 0 | append( sb, "The passphrase to use when signing.", 3 ); |
200 | 0 | append( sb, "", 0 ); |
201 | |
|
202 | 0 | append( sb, "pomFile", 2 ); |
203 | 0 | append( sb, "Location of an existing POM file to be deployed alongside the main artifact, given by the ${file} parameter.", 3 ); |
204 | 0 | append( sb, "", 0 ); |
205 | |
|
206 | 0 | append( sb, "repositoryId (Default: remote-repository)", 2 ); |
207 | 0 | append( sb, "Server Id to map on the <id> under <server> section of settings.xml. In most cases, this parameter will be required for authentication.", 3 ); |
208 | 0 | append( sb, "", 0 ); |
209 | |
|
210 | 0 | append( sb, "repositoryLayout (Default: default)", 2 ); |
211 | 0 | append( sb, "The type of remote repository layout to deploy to. Try legacy for a Maven 1.x-style repository layout.", 3 ); |
212 | 0 | append( sb, "", 0 ); |
213 | |
|
214 | 0 | append( sb, "uniqueVersion (Default: true)", 2 ); |
215 | 0 | append( sb, "Whether to deploy snapshots with a unique version or not.", 3 ); |
216 | 0 | append( sb, "", 0 ); |
217 | |
|
218 | 0 | append( sb, "url", 2 ); |
219 | 0 | append( sb, "URL where the artifact will be deployed.\nie ( file:///C:/m2-repo or scp://host.com/path/to/repo )", 3 ); |
220 | 0 | append( sb, "", 0 ); |
221 | |
|
222 | 0 | append( sb, "useAgent (Default: false)", 2 ); |
223 | 0 | append( sb, "Passes --use-agent or --no-use-agent to gpg. If using an agent, the passphrase is optional as the agent will provide it.", 3 ); |
224 | 0 | append( sb, "", 0 ); |
225 | |
|
226 | 0 | append( sb, "version", 2 ); |
227 | 0 | append( sb, "Version of the artifact to be deployed. Retrieved from POM file if specified.", 3 ); |
228 | 0 | append( sb, "", 0 ); |
229 | |
} |
230 | |
} |
231 | |
|
232 | 0 | if ( getLog().isInfoEnabled() ) |
233 | |
{ |
234 | 0 | getLog().info( sb.toString() ); |
235 | |
} |
236 | 0 | } |
237 | |
|
238 | |
|
239 | |
|
240 | |
|
241 | |
|
242 | |
|
243 | |
|
244 | |
|
245 | |
|
246 | |
|
247 | |
private static String repeat( String str, int repeat ) |
248 | |
{ |
249 | 0 | StringBuffer buffer = new StringBuffer( repeat * str.length() ); |
250 | |
|
251 | 0 | for ( int i = 0; i < repeat; i++ ) |
252 | |
{ |
253 | 0 | buffer.append( str ); |
254 | |
} |
255 | |
|
256 | 0 | return buffer.toString(); |
257 | |
} |
258 | |
|
259 | |
|
260 | |
|
261 | |
|
262 | |
|
263 | |
|
264 | |
|
265 | |
|
266 | |
|
267 | |
private void append( StringBuffer sb, String description, int indent ) |
268 | |
{ |
269 | 0 | for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); ) |
270 | |
{ |
271 | 0 | sb.append( it.next().toString() ).append( '\n' ); |
272 | |
} |
273 | 0 | } |
274 | |
|
275 | |
|
276 | |
|
277 | |
|
278 | |
|
279 | |
|
280 | |
|
281 | |
|
282 | |
|
283 | |
|
284 | |
|
285 | |
private static List toLines( String text, int indent, int indentSize, int lineLength ) |
286 | |
{ |
287 | 0 | List lines = new ArrayList(); |
288 | |
|
289 | 0 | String ind = repeat( "\t", indent ); |
290 | 0 | String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" ); |
291 | 0 | for ( int i = 0; i < plainLines.length; i++ ) |
292 | |
{ |
293 | 0 | toLines( lines, ind + plainLines[i], indentSize, lineLength ); |
294 | |
} |
295 | |
|
296 | 0 | return lines; |
297 | |
} |
298 | |
|
299 | |
|
300 | |
|
301 | |
|
302 | |
|
303 | |
|
304 | |
|
305 | |
|
306 | |
|
307 | |
private static void toLines( List lines, String line, int indentSize, int lineLength ) |
308 | |
{ |
309 | 0 | int lineIndent = getIndentLevel( line ); |
310 | 0 | StringBuffer buf = new StringBuffer( 256 ); |
311 | 0 | String[] tokens = line.split( " +" ); |
312 | 0 | for ( int i = 0; i < tokens.length; i++ ) |
313 | |
{ |
314 | 0 | String token = tokens[i]; |
315 | 0 | if ( i > 0 ) |
316 | |
{ |
317 | 0 | if ( buf.length() + token.length() >= lineLength ) |
318 | |
{ |
319 | 0 | lines.add( buf.toString() ); |
320 | 0 | buf.setLength( 0 ); |
321 | 0 | buf.append( repeat( " ", lineIndent * indentSize ) ); |
322 | |
} |
323 | |
else |
324 | |
{ |
325 | 0 | buf.append( ' ' ); |
326 | |
} |
327 | |
} |
328 | 0 | for ( int j = 0; j < token.length(); j++ ) |
329 | |
{ |
330 | 0 | char c = token.charAt( j ); |
331 | 0 | if ( c == '\t' ) |
332 | |
{ |
333 | 0 | buf.append( repeat( " ", indentSize - buf.length() % indentSize ) ); |
334 | |
} |
335 | 0 | else if ( c == '\u00A0' ) |
336 | |
{ |
337 | 0 | buf.append( ' ' ); |
338 | |
} |
339 | |
else |
340 | |
{ |
341 | 0 | buf.append( c ); |
342 | |
} |
343 | |
} |
344 | |
} |
345 | 0 | lines.add( buf.toString() ); |
346 | 0 | } |
347 | |
|
348 | |
|
349 | |
|
350 | |
|
351 | |
|
352 | |
|
353 | |
|
354 | |
private static int getIndentLevel( String line ) |
355 | |
{ |
356 | 0 | int level = 0; |
357 | 0 | for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ ) |
358 | |
{ |
359 | 0 | level++; |
360 | |
} |
361 | 0 | for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ ) |
362 | |
{ |
363 | 0 | if ( line.charAt( i ) == '\t' ) |
364 | |
{ |
365 | 0 | level++; |
366 | 0 | break; |
367 | |
} |
368 | |
} |
369 | 0 | return level; |
370 | |
} |
371 | |
} |