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