1 | |
package org.apache.maven.plugins.linkcheck; |
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-linkcheck-plugin:1.1", 0 ); |
68 | 0 | append( sb, "", 0 ); |
69 | |
|
70 | 0 | append( sb, "Maven Linkcheck Plugin", 0 ); |
71 | 0 | append( sb, "This plugin allows you to generate a linkcheck report of your project\'s documentation.", 1 ); |
72 | 0 | append( sb, "", 0 ); |
73 | |
|
74 | 0 | if ( goal == null || goal.length() <= 0 ) |
75 | |
{ |
76 | 0 | append( sb, "This plugin has 2 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, "linkcheck:help", 0 ); |
83 | 0 | append( sb, "Display help information on maven-linkcheck-plugin.\nCall\n\u00a0\u00a0mvn\u00a0linkcheck: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 || "linkcheck".equals( goal ) ) |
109 | |
{ |
110 | 0 | append( sb, "linkcheck:linkcheck", 0 ); |
111 | 0 | append( sb, "Generates a Linkcheck report.", 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, "baseURL (Default: ${project.url})", 2 ); |
119 | 0 | append( sb, "The base URL to use for absolute links (eg /index.html) in the site.", 3 ); |
120 | 0 | append( sb, "", 0 ); |
121 | |
|
122 | 0 | append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 ); |
123 | 0 | append( sb, "The file encoding to use when Linkcheck reads the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used.", 3 ); |
124 | 0 | append( sb, "", 0 ); |
125 | |
|
126 | 0 | append( sb, "excludedHttpStatusErrors", 2 ); |
127 | 0 | append( sb, "The list of HTTP errors to ignored, like 404.", 3 ); |
128 | 0 | append( sb, "", 0 ); |
129 | |
|
130 | 0 | append( sb, "excludedHttpStatusWarnings", 2 ); |
131 | 0 | append( sb, "The list of HTTP warnings to ignored, like 301.", 3 ); |
132 | 0 | append( sb, "", 0 ); |
133 | |
|
134 | 0 | append( sb, "excludedLinks", 2 ); |
135 | 0 | append( sb, "The list of links to exclude.\nNote: Patterns like **/dummy/* are allowed for excludedLink.", 3 ); |
136 | 0 | append( sb, "", 0 ); |
137 | |
|
138 | 0 | append( sb, "excludedPages", 2 ); |
139 | 0 | append( sb, "A list of pages to exclude.\nNote:\n\n-\tThis report, i.e. linkcheck.html, is always excluded.\n-\tMay contain Ant-style wildcards and double wildcards, e.g. apidocs/**, etc.\n", 3 ); |
140 | 0 | append( sb, "", 0 ); |
141 | |
|
142 | 0 | append( sb, "forceSite (Default: true)", 2 ); |
143 | 0 | append( sb, "true to force the site generation, false otherwise. Using this parameter ensures that all documents have been correctly generated.", 3 ); |
144 | 0 | append( sb, "", 0 ); |
145 | |
|
146 | 0 | append( sb, "httpClientParameters", 2 ); |
147 | 0 | append( sb, "The extra HttpClient parameters to be used when fetching links. For instance:\n<httpClientParameters>\n\u00a0<property>\n\u00a0\u00a0<name>http.protocol.max-redirects</name>\n\u00a0\u00a0<value>10</value>\n\u00a0</property>\n</httpClientParameters>\nSee HttpClient preference page", 3 ); |
148 | 0 | append( sb, "", 0 ); |
149 | |
|
150 | 0 | append( sb, "httpFollowRedirect (Default: true)", 2 ); |
151 | 0 | append( sb, "If online, the HTTP method should automatically follow HTTP redirects, false otherwise.", 3 ); |
152 | 0 | append( sb, "", 0 ); |
153 | |
|
154 | 0 | append( sb, "httpMethod (Default: head)", 2 ); |
155 | 0 | append( sb, "The HTTP method to use. Currently supported are \'GET\' and \'HEAD\'.\nHTTP GET\n\tThe HTTP GET method is defined in section 9.3 of RFC2616: The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI.\nHTTP HEAD\n\tThe HTTP HEAD method is defined in section 9.4 of RFC2616: The HEAD method is identical to GET except that the server MUST NOT return a message-body in the response.\n", 3 ); |
156 | 0 | append( sb, "", 0 ); |
157 | |
|
158 | 0 | append( sb, "linkcheckCache (Default: ${project.build.directory}/linkcheck/linkcheck.cache)", 2 ); |
159 | 0 | append( sb, "The location of the Linkcheck cache file.", 3 ); |
160 | 0 | append( sb, "", 0 ); |
161 | |
|
162 | 0 | append( sb, "linkcheckOutput (Default: ${project.build.directory}/linkcheck/linkcheck.xml)", 2 ); |
163 | 0 | append( sb, "The location of the Linkcheck report file.", 3 ); |
164 | 0 | append( sb, "", 0 ); |
165 | |
|
166 | 0 | append( sb, "offline (Default: ${settings.offline})", 2 ); |
167 | 0 | append( sb, "Whether we are offline or not.", 3 ); |
168 | 0 | append( sb, "", 0 ); |
169 | |
|
170 | 0 | append( sb, "outputDirectory", 2 ); |
171 | 0 | append( sb, "Report output directory.", 3 ); |
172 | 0 | append( sb, "", 0 ); |
173 | |
|
174 | 0 | append( sb, "skip (Default: false)", 2 ); |
175 | 0 | append( sb, "true to skip the report execution, false otherwise. The purpose is to prevent infinite call when forceSite is enable.", 3 ); |
176 | 0 | append( sb, "", 0 ); |
177 | |
|
178 | 0 | append( sb, "timeout (Default: 2000)", 2 ); |
179 | 0 | append( sb, "Set the timeout to be used when fetching links. A value of zero means the timeout is not used.", 3 ); |
180 | 0 | append( sb, "", 0 ); |
181 | |
} |
182 | |
} |
183 | |
|
184 | 0 | if ( getLog().isInfoEnabled() ) |
185 | |
{ |
186 | 0 | getLog().info( sb.toString() ); |
187 | |
} |
188 | 0 | } |
189 | |
|
190 | |
|
191 | |
|
192 | |
|
193 | |
|
194 | |
|
195 | |
|
196 | |
|
197 | |
|
198 | |
|
199 | |
private static String repeat( String str, int repeat ) |
200 | |
{ |
201 | 0 | StringBuffer buffer = new StringBuffer( repeat * str.length() ); |
202 | |
|
203 | 0 | for ( int i = 0; i < repeat; i++ ) |
204 | |
{ |
205 | 0 | buffer.append( str ); |
206 | |
} |
207 | |
|
208 | 0 | return buffer.toString(); |
209 | |
} |
210 | |
|
211 | |
|
212 | |
|
213 | |
|
214 | |
|
215 | |
|
216 | |
|
217 | |
|
218 | |
|
219 | |
private void append( StringBuffer sb, String description, int indent ) |
220 | |
{ |
221 | 0 | for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); ) |
222 | |
{ |
223 | 0 | sb.append( it.next().toString() ).append( '\n' ); |
224 | |
} |
225 | 0 | } |
226 | |
|
227 | |
|
228 | |
|
229 | |
|
230 | |
|
231 | |
|
232 | |
|
233 | |
|
234 | |
|
235 | |
|
236 | |
|
237 | |
private static List toLines( String text, int indent, int indentSize, int lineLength ) |
238 | |
{ |
239 | 0 | List lines = new ArrayList(); |
240 | |
|
241 | 0 | String ind = repeat( "\t", indent ); |
242 | 0 | String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" ); |
243 | 0 | for ( int i = 0; i < plainLines.length; i++ ) |
244 | |
{ |
245 | 0 | toLines( lines, ind + plainLines[i], indentSize, lineLength ); |
246 | |
} |
247 | |
|
248 | 0 | return lines; |
249 | |
} |
250 | |
|
251 | |
|
252 | |
|
253 | |
|
254 | |
|
255 | |
|
256 | |
|
257 | |
|
258 | |
|
259 | |
private static void toLines( List lines, String line, int indentSize, int lineLength ) |
260 | |
{ |
261 | 0 | int lineIndent = getIndentLevel( line ); |
262 | 0 | StringBuffer buf = new StringBuffer( 256 ); |
263 | 0 | String[] tokens = line.split( " +" ); |
264 | 0 | for ( int i = 0; i < tokens.length; i++ ) |
265 | |
{ |
266 | 0 | String token = tokens[i]; |
267 | 0 | if ( i > 0 ) |
268 | |
{ |
269 | 0 | if ( buf.length() + token.length() >= lineLength ) |
270 | |
{ |
271 | 0 | lines.add( buf.toString() ); |
272 | 0 | buf.setLength( 0 ); |
273 | 0 | buf.append( repeat( " ", lineIndent * indentSize ) ); |
274 | |
} |
275 | |
else |
276 | |
{ |
277 | 0 | buf.append( ' ' ); |
278 | |
} |
279 | |
} |
280 | 0 | for ( int j = 0; j < token.length(); j++ ) |
281 | |
{ |
282 | 0 | char c = token.charAt( j ); |
283 | 0 | if ( c == '\t' ) |
284 | |
{ |
285 | 0 | buf.append( repeat( " ", indentSize - buf.length() % indentSize ) ); |
286 | |
} |
287 | 0 | else if ( c == '\u00A0' ) |
288 | |
{ |
289 | 0 | buf.append( ' ' ); |
290 | |
} |
291 | |
else |
292 | |
{ |
293 | 0 | buf.append( c ); |
294 | |
} |
295 | |
} |
296 | |
} |
297 | 0 | lines.add( buf.toString() ); |
298 | 0 | } |
299 | |
|
300 | |
|
301 | |
|
302 | |
|
303 | |
|
304 | |
|
305 | |
|
306 | |
private static int getIndentLevel( String line ) |
307 | |
{ |
308 | 0 | int level = 0; |
309 | 0 | for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ ) |
310 | |
{ |
311 | 0 | level++; |
312 | |
} |
313 | 0 | for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ ) |
314 | |
{ |
315 | 0 | if ( line.charAt( i ) == '\t' ) |
316 | |
{ |
317 | 0 | level++; |
318 | 0 | break; |
319 | |
} |
320 | |
} |
321 | 0 | return level; |
322 | |
} |
323 | |
} |