1
2
3
4
5
6 package org.apache.maven.plugin.lifecycle.io.xpp3;
7
8
9
10
11
12 import java.io.IOException;
13 import java.io.InputStream;
14 import java.io.Reader;
15 import java.text.DateFormat;
16 import org.apache.maven.plugin.lifecycle.Execution;
17 import org.apache.maven.plugin.lifecycle.Lifecycle;
18 import org.apache.maven.plugin.lifecycle.LifecycleConfiguration;
19 import org.apache.maven.plugin.lifecycle.Phase;
20 import org.codehaus.plexus.util.xml.XmlStreamReader;
21 import org.codehaus.plexus.util.xml.pull.EntityReplacementMap;
22 import org.codehaus.plexus.util.xml.pull.MXParser;
23 import org.codehaus.plexus.util.xml.pull.XmlPullParser;
24 import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
25
26
27
28
29
30
31 @SuppressWarnings( "all" )
32 public class LifecycleMappingsXpp3Reader
33 {
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49 private boolean addDefaultEntities = true;
50
51
52
53
54 public final ContentTransformer contentTransformer;
55
56
57
58
59
60
61 public LifecycleMappingsXpp3Reader()
62 {
63 this( new ContentTransformer()
64 {
65 public String transform( String source, String fieldName )
66 {
67 return source;
68 }
69 } );
70 }
71
72 public LifecycleMappingsXpp3Reader(ContentTransformer contentTransformer)
73 {
74 this.contentTransformer = contentTransformer;
75 }
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93 private boolean checkFieldWithDuplicate( XmlPullParser parser, String tagName, String alias, java.util.Set<String> parsed )
94 throws XmlPullParserException
95 {
96 if ( !( parser.getName().equals( tagName ) || parser.getName().equals( alias ) ) )
97 {
98 return false;
99 }
100 if ( !parsed.add( tagName ) )
101 {
102 throw new XmlPullParserException( "Duplicated tag: '" + tagName + "'", parser, null );
103 }
104 return true;
105 }
106
107
108
109
110
111
112
113
114
115
116
117
118 private void checkUnknownAttribute( XmlPullParser parser, String attribute, String tagName, boolean strict )
119 throws XmlPullParserException, IOException
120 {
121
122 if ( strict )
123 {
124 throw new XmlPullParserException( "Unknown attribute '" + attribute + "' for tag '" + tagName + "'", parser, null );
125 }
126 }
127
128
129
130
131
132
133
134
135
136
137 private void checkUnknownElement( XmlPullParser parser, boolean strict )
138 throws XmlPullParserException, IOException
139 {
140 if ( strict )
141 {
142 throw new XmlPullParserException( "Unrecognised tag: '" + parser.getName() + "'", parser, null );
143 }
144
145 for ( int unrecognizedTagCount = 1; unrecognizedTagCount > 0; )
146 {
147 int eventType = parser.next();
148 if ( eventType == XmlPullParser.START_TAG )
149 {
150 unrecognizedTagCount++;
151 }
152 else if ( eventType == XmlPullParser.END_TAG )
153 {
154 unrecognizedTagCount--;
155 }
156 }
157 }
158
159
160
161
162
163
164 public boolean getAddDefaultEntities()
165 {
166 return addDefaultEntities;
167 }
168
169
170
171
172
173
174
175
176
177
178
179 private boolean getBooleanValue( String s, String attribute, XmlPullParser parser )
180 throws XmlPullParserException
181 {
182 return getBooleanValue( s, attribute, parser, null );
183 }
184
185
186
187
188
189
190
191
192
193
194
195
196 private boolean getBooleanValue( String s, String attribute, XmlPullParser parser, String defaultValue )
197 throws XmlPullParserException
198 {
199 if ( s != null && s.length() != 0 )
200 {
201 return Boolean.valueOf( s ).booleanValue();
202 }
203 if ( defaultValue != null )
204 {
205 return Boolean.valueOf( defaultValue ).booleanValue();
206 }
207 return false;
208 }
209
210
211
212
213
214
215
216
217
218
219
220
221 private byte getByteValue( String s, String attribute, XmlPullParser parser, boolean strict )
222 throws XmlPullParserException
223 {
224 if ( s != null )
225 {
226 try
227 {
228 return Byte.valueOf( s ).byteValue();
229 }
230 catch ( NumberFormatException nfe )
231 {
232 if ( strict )
233 {
234 throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be a byte", parser, nfe );
235 }
236 }
237 }
238 return 0;
239 }
240
241
242
243
244
245
246
247
248
249
250
251 private char getCharacterValue( String s, String attribute, XmlPullParser parser )
252 throws XmlPullParserException
253 {
254 if ( s != null )
255 {
256 return s.charAt( 0 );
257 }
258 return 0;
259 }
260
261
262
263
264
265
266
267
268
269
270
271 private java.util.Date getDateValue( String s, String attribute, XmlPullParser parser )
272 throws XmlPullParserException
273 {
274 return getDateValue( s, attribute, null, parser );
275 }
276
277
278
279
280
281
282
283
284
285
286
287
288 private java.util.Date getDateValue( String s, String attribute, String dateFormat, XmlPullParser parser )
289 throws XmlPullParserException
290 {
291 if ( s != null )
292 {
293 String effectiveDateFormat = dateFormat;
294 if ( dateFormat == null )
295 {
296 effectiveDateFormat = "yyyy-MM-dd'T'HH:mm:ss.SSS";
297 }
298 if ( "long".equals( effectiveDateFormat ) )
299 {
300 try
301 {
302 return new java.util.Date( Long.parseLong( s ) );
303 }
304 catch ( NumberFormatException e )
305 {
306 throw new XmlPullParserException( e.getMessage(), parser, e );
307 }
308 }
309 else
310 {
311 try
312 {
313 DateFormat dateParser = new java.text.SimpleDateFormat( effectiveDateFormat, java.util.Locale.US );
314 return dateParser.parse( s );
315 }
316 catch ( java.text.ParseException e )
317 {
318 throw new XmlPullParserException( e.getMessage(), parser, e );
319 }
320 }
321 }
322 return null;
323 }
324
325
326
327
328
329
330
331
332
333
334
335
336 private double getDoubleValue( String s, String attribute, XmlPullParser parser, boolean strict )
337 throws XmlPullParserException
338 {
339 if ( s != null )
340 {
341 try
342 {
343 return Double.valueOf( s ).doubleValue();
344 }
345 catch ( NumberFormatException nfe )
346 {
347 if ( strict )
348 {
349 throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be a floating point number", parser, nfe );
350 }
351 }
352 }
353 return 0;
354 }
355
356
357
358
359
360
361
362
363
364
365
366
367 private float getFloatValue( String s, String attribute, XmlPullParser parser, boolean strict )
368 throws XmlPullParserException
369 {
370 if ( s != null )
371 {
372 try
373 {
374 return Float.valueOf( s ).floatValue();
375 }
376 catch ( NumberFormatException nfe )
377 {
378 if ( strict )
379 {
380 throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be a floating point number", parser, nfe );
381 }
382 }
383 }
384 return 0;
385 }
386
387
388
389
390
391
392
393
394
395
396
397
398 private int getIntegerValue( String s, String attribute, XmlPullParser parser, boolean strict )
399 throws XmlPullParserException
400 {
401 if ( s != null )
402 {
403 try
404 {
405 return Integer.valueOf( s ).intValue();
406 }
407 catch ( NumberFormatException nfe )
408 {
409 if ( strict )
410 {
411 throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be an integer", parser, nfe );
412 }
413 }
414 }
415 return 0;
416 }
417
418
419
420
421
422
423
424
425
426
427
428
429 private long getLongValue( String s, String attribute, XmlPullParser parser, boolean strict )
430 throws XmlPullParserException
431 {
432 if ( s != null )
433 {
434 try
435 {
436 return Long.valueOf( s ).longValue();
437 }
438 catch ( NumberFormatException nfe )
439 {
440 if ( strict )
441 {
442 throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be a long integer", parser, nfe );
443 }
444 }
445 }
446 return 0;
447 }
448
449
450
451
452
453
454
455
456
457
458
459
460 private String getRequiredAttributeValue( String s, String attribute, XmlPullParser parser, boolean strict )
461 throws XmlPullParserException
462 {
463 if ( s == null )
464 {
465 if ( strict )
466 {
467 throw new XmlPullParserException( "Missing required value for attribute '" + attribute + "'", parser, null );
468 }
469 }
470 return s;
471 }
472
473
474
475
476
477
478
479
480
481
482
483
484 private short getShortValue( String s, String attribute, XmlPullParser parser, boolean strict )
485 throws XmlPullParserException
486 {
487 if ( s != null )
488 {
489 try
490 {
491 return Short.valueOf( s ).shortValue();
492 }
493 catch ( NumberFormatException nfe )
494 {
495 if ( strict )
496 {
497 throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be a short integer", parser, nfe );
498 }
499 }
500 }
501 return 0;
502 }
503
504
505
506
507
508
509
510 private String getTrimmedValue( String s )
511 {
512 if ( s != null )
513 {
514 s = s.trim();
515 }
516 return s;
517 }
518
519
520
521
522
523
524
525
526 private String interpolatedTrimmed( String value, String context )
527 {
528 return getTrimmedValue( contentTransformer.transform( value, context ) );
529 }
530
531
532
533
534
535
536
537
538
539
540 private int nextTag( XmlPullParser parser )
541 throws IOException, XmlPullParserException
542 {
543 int eventType = parser.next();
544 if ( eventType == XmlPullParser.TEXT )
545 {
546 eventType = parser.next();
547 }
548 if ( eventType != XmlPullParser.START_TAG && eventType != XmlPullParser.END_TAG )
549 {
550 throw new XmlPullParserException( "expected START_TAG or END_TAG not " + XmlPullParser.TYPES[eventType], parser, null );
551 }
552 return eventType;
553 }
554
555
556
557
558
559
560
561
562
563
564
565 public LifecycleConfiguration read( XmlPullParser parser, boolean strict )
566 throws IOException, XmlPullParserException
567 {
568 LifecycleConfiguration lifecycleConfiguration = null;
569 int eventType = parser.getEventType();
570 boolean parsed = false;
571 while ( eventType != XmlPullParser.END_DOCUMENT )
572 {
573 if ( eventType == XmlPullParser.START_TAG )
574 {
575 if ( strict && ! "lifecycles".equals( parser.getName() ) )
576 {
577 throw new XmlPullParserException( "Expected root element 'lifecycles' but found '" + parser.getName() + "'", parser, null );
578 }
579 else if ( parsed )
580 {
581
582 throw new XmlPullParserException( "Duplicated tag: 'lifecycles'", parser, null );
583 }
584 lifecycleConfiguration = parseLifecycleConfiguration( parser, strict );
585 lifecycleConfiguration.setModelEncoding( parser.getInputEncoding() );
586 parsed = true;
587 }
588 eventType = parser.next();
589 }
590 if ( parsed )
591 {
592 return lifecycleConfiguration;
593 }
594 throw new XmlPullParserException( "Expected root element 'lifecycles' but found no element at all: invalid XML document", parser, null );
595 }
596
597
598
599
600
601
602
603
604
605
606
607 public LifecycleConfiguration read( Reader reader, boolean strict )
608 throws IOException, XmlPullParserException
609 {
610 XmlPullParser parser = addDefaultEntities ? new MXParser(EntityReplacementMap.defaultEntityReplacementMap) : new MXParser( );
611
612 parser.setInput( reader );
613
614
615 return read( parser, strict );
616 }
617
618
619
620
621
622
623
624
625
626
627 public LifecycleConfiguration read( Reader reader )
628 throws IOException, XmlPullParserException
629 {
630 return read( reader, true );
631 }
632
633
634
635
636
637
638
639
640
641
642
643 public LifecycleConfiguration read( InputStream in, boolean strict )
644 throws IOException, XmlPullParserException
645 {
646 return read( new XmlStreamReader( in ), strict );
647 }
648
649
650
651
652
653
654
655
656
657
658 public LifecycleConfiguration read( InputStream in )
659 throws IOException, XmlPullParserException
660 {
661 return read( new XmlStreamReader( in ) );
662 }
663
664
665
666
667
668
669
670
671
672
673
674 private Execution parseExecution( XmlPullParser parser, boolean strict )
675 throws IOException, XmlPullParserException
676 {
677 String tagName = parser.getName();
678 Execution execution = new Execution();
679 for ( int i = parser.getAttributeCount() - 1; i >= 0; i-- )
680 {
681 String name = parser.getAttributeName( i );
682 String value = parser.getAttributeValue( i );
683
684 if ( name.indexOf( ':' ) >= 0 )
685 {
686
687 }
688 else
689 {
690 checkUnknownAttribute( parser, name, tagName, strict );
691 }
692 }
693 java.util.Set<String> parsed = new java.util.HashSet<String>();
694 while ( ( strict ? parser.nextTag() : nextTag( parser ) ) == XmlPullParser.START_TAG )
695 {
696 if ( checkFieldWithDuplicate( parser, "configuration", null, parsed ) )
697 {
698 execution.setConfiguration( org.codehaus.plexus.util.xml.Xpp3DomBuilder.build( parser, true ) );
699 }
700 else if ( checkFieldWithDuplicate( parser, "goals", null, parsed ) )
701 {
702 java.util.List<String> goals = new java.util.ArrayList<String>();
703 while ( parser.nextTag() == XmlPullParser.START_TAG )
704 {
705 if ( "goal".equals( parser.getName() ) )
706 {
707 goals.add( interpolatedTrimmed( parser.nextText(), "goals" ) );
708 }
709 else
710 {
711 checkUnknownElement( parser, strict );
712 }
713 }
714 execution.setGoals( goals );
715 }
716 else
717 {
718 checkUnknownElement( parser, strict );
719 }
720 }
721 return execution;
722 }
723
724
725
726
727
728
729
730
731
732
733
734 private Lifecycle parseLifecycle( XmlPullParser parser, boolean strict )
735 throws IOException, XmlPullParserException
736 {
737 String tagName = parser.getName();
738 Lifecycle lifecycle = new Lifecycle();
739 for ( int i = parser.getAttributeCount() - 1; i >= 0; i-- )
740 {
741 String name = parser.getAttributeName( i );
742 String value = parser.getAttributeValue( i );
743
744 if ( name.indexOf( ':' ) >= 0 )
745 {
746
747 }
748 else
749 {
750 checkUnknownAttribute( parser, name, tagName, strict );
751 }
752 }
753 java.util.Set<String> parsed = new java.util.HashSet<String>();
754 while ( ( strict ? parser.nextTag() : nextTag( parser ) ) == XmlPullParser.START_TAG )
755 {
756 if ( checkFieldWithDuplicate( parser, "id", null, parsed ) )
757 {
758 lifecycle.setId( interpolatedTrimmed( parser.nextText(), "id" ) );
759 }
760 else if ( checkFieldWithDuplicate( parser, "phases", null, parsed ) )
761 {
762 java.util.List<Phase> phases = new java.util.ArrayList<Phase>();
763 while ( parser.nextTag() == XmlPullParser.START_TAG )
764 {
765 if ( "phase".equals( parser.getName() ) )
766 {
767 phases.add( parsePhase( parser, strict ) );
768 }
769 else
770 {
771 checkUnknownElement( parser, strict );
772 }
773 }
774 lifecycle.setPhases( phases );
775 }
776 else
777 {
778 checkUnknownElement( parser, strict );
779 }
780 }
781 return lifecycle;
782 }
783
784
785
786
787
788
789
790
791
792
793
794 private LifecycleConfiguration parseLifecycleConfiguration( XmlPullParser parser, boolean strict )
795 throws IOException, XmlPullParserException
796 {
797 String tagName = parser.getName();
798 LifecycleConfiguration lifecycleConfiguration = new LifecycleConfiguration();
799 for ( int i = parser.getAttributeCount() - 1; i >= 0; i-- )
800 {
801 String name = parser.getAttributeName( i );
802 String value = parser.getAttributeValue( i );
803
804 if ( name.indexOf( ':' ) >= 0 )
805 {
806
807 }
808 else if ( "xmlns".equals( name ) )
809 {
810
811 }
812 else
813 {
814 checkUnknownAttribute( parser, name, tagName, strict );
815 }
816 }
817 java.util.Set<String> parsed = new java.util.HashSet<String>();
818 while ( ( strict ? parser.nextTag() : nextTag( parser ) ) == XmlPullParser.START_TAG )
819 {
820 if ( "lifecycle".equals( parser.getName() ) )
821 {
822 java.util.List<Lifecycle> lifecycles = lifecycleConfiguration.getLifecycles();
823 if ( lifecycles == null )
824 {
825 lifecycles = new java.util.ArrayList<Lifecycle>();
826 }
827 lifecycles.add( parseLifecycle( parser, strict ) );
828 lifecycleConfiguration.setLifecycles( lifecycles );
829 }
830 else
831 {
832 checkUnknownElement( parser, strict );
833 }
834 }
835 return lifecycleConfiguration;
836 }
837
838
839
840
841
842
843
844
845
846
847
848 private Phase parsePhase( XmlPullParser parser, boolean strict )
849 throws IOException, XmlPullParserException
850 {
851 String tagName = parser.getName();
852 Phase phase = new Phase();
853 for ( int i = parser.getAttributeCount() - 1; i >= 0; i-- )
854 {
855 String name = parser.getAttributeName( i );
856 String value = parser.getAttributeValue( i );
857
858 if ( name.indexOf( ':' ) >= 0 )
859 {
860
861 }
862 else
863 {
864 checkUnknownAttribute( parser, name, tagName, strict );
865 }
866 }
867 java.util.Set<String> parsed = new java.util.HashSet<String>();
868 while ( ( strict ? parser.nextTag() : nextTag( parser ) ) == XmlPullParser.START_TAG )
869 {
870 if ( checkFieldWithDuplicate( parser, "id", null, parsed ) )
871 {
872 phase.setId( interpolatedTrimmed( parser.nextText(), "id" ) );
873 }
874 else if ( checkFieldWithDuplicate( parser, "executions", null, parsed ) )
875 {
876 java.util.List<Execution> executions = new java.util.ArrayList<Execution>();
877 while ( parser.nextTag() == XmlPullParser.START_TAG )
878 {
879 if ( "execution".equals( parser.getName() ) )
880 {
881 executions.add( parseExecution( parser, strict ) );
882 }
883 else
884 {
885 checkUnknownElement( parser, strict );
886 }
887 }
888 phase.setExecutions( executions );
889 }
890 else if ( checkFieldWithDuplicate( parser, "configuration", null, parsed ) )
891 {
892 phase.setConfiguration( org.codehaus.plexus.util.xml.Xpp3DomBuilder.build( parser, true ) );
893 }
894 else
895 {
896 checkUnknownElement( parser, strict );
897 }
898 }
899 return phase;
900 }
901
902
903
904
905
906
907 public void setAddDefaultEntities( boolean addDefaultEntities )
908 {
909 this.addDefaultEntities = addDefaultEntities;
910 }
911
912 public static interface ContentTransformer
913 {
914
915
916
917
918
919
920
921 String transform( String source, String fieldName );
922 }
923
924 }