1 package org.apache.maven.plugins.site.deploy;
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 import org.apache.maven.artifact.manager.WagonManager;
23 import org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor;
24 import org.apache.maven.execution.MavenExecutionRequest;
25 import org.apache.maven.execution.MavenSession;
26 import org.apache.maven.model.DistributionManagement;
27 import org.apache.maven.model.Site;
28 import org.apache.maven.plugin.MojoExecutionException;
29 import org.apache.maven.plugin.logging.Log;
30 import org.apache.maven.plugins.annotations.Component;
31 import org.apache.maven.plugins.annotations.Parameter;
32 import org.apache.maven.plugins.site.AbstractSiteMojo;
33 import org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository;
34 import org.apache.maven.project.MavenProject;
35 import org.apache.maven.settings.Proxy;
36 import org.apache.maven.settings.Server;
37 import org.apache.maven.settings.Settings;
38 import org.apache.maven.settings.crypto.DefaultSettingsDecryptionRequest;
39 import org.apache.maven.settings.crypto.SettingsDecrypter;
40 import org.apache.maven.settings.crypto.SettingsDecryptionResult;
41 import org.apache.maven.wagon.CommandExecutionException;
42 import org.apache.maven.wagon.CommandExecutor;
43 import org.apache.maven.wagon.ConnectionException;
44 import org.apache.maven.wagon.ResourceDoesNotExistException;
45 import org.apache.maven.wagon.TransferFailedException;
46 import org.apache.maven.wagon.UnsupportedProtocolException;
47 import org.apache.maven.wagon.Wagon;
48 import org.apache.maven.wagon.authentication.AuthenticationException;
49 import org.apache.maven.wagon.authentication.AuthenticationInfo;
50 import org.apache.maven.wagon.authorization.AuthorizationException;
51 import org.apache.maven.wagon.observers.Debug;
52 import org.apache.maven.wagon.proxy.ProxyInfo;
53 import org.apache.maven.wagon.repository.Repository;
54 import org.codehaus.classworlds.ClassRealm;
55 import org.codehaus.plexus.PlexusConstants;
56 import org.codehaus.plexus.PlexusContainer;
57 import org.codehaus.plexus.component.configurator.ComponentConfigurationException;
58 import org.codehaus.plexus.component.configurator.ComponentConfigurator;
59 import org.codehaus.plexus.component.repository.exception.ComponentLifecycleException;
60 import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
61 import org.codehaus.plexus.configuration.PlexusConfiguration;
62 import org.codehaus.plexus.configuration.xml.XmlPlexusConfiguration;
63 import org.codehaus.plexus.context.Context;
64 import org.codehaus.plexus.context.ContextException;
65 import org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable;
66 import org.codehaus.plexus.util.StringUtils;
67 import org.codehaus.plexus.util.xml.Xpp3Dom;
68
69 import java.io.File;
70 import java.lang.reflect.Method;
71 import java.net.MalformedURLException;
72 import java.net.URL;
73 import java.util.List;
74 import java.util.Locale;
75 import java.util.Set;
76
77
78
79
80
81
82
83
84 public abstract class AbstractDeployMojo
85 extends AbstractSiteMojo
86 implements Contextualizable
87 {
88
89
90
91
92
93 @Parameter( alias = "outputDirectory", defaultValue = "${project.reporting.outputDirectory}", required = true )
94 private File inputDirectory;
95
96
97
98
99
100
101
102 @Parameter( property = "maven.site.chmod", defaultValue = "true" )
103 private boolean chmod;
104
105
106
107
108
109
110
111 @Parameter( property = "maven.site.chmod.mode", defaultValue = "g+w,a+rX" )
112 private String chmodMode;
113
114
115
116
117
118
119
120 @Parameter( property = "maven.site.chmod.options", defaultValue = "-Rf" )
121 private String chmodOptions;
122
123
124
125
126
127
128 @Parameter( property = "maven.site.deploy.skip", defaultValue = "false" )
129 private boolean skipDeploy;
130
131
132
133 @Component
134 private WagonManager wagonManager;
135
136
137
138
139 @Parameter( defaultValue = "${settings}", readonly = true )
140 private Settings settings;
141
142
143
144
145 @Parameter( defaultValue = "${session}", readonly = true )
146 protected MavenSession mavenSession;
147
148 private String topDistributionManagementSiteUrl;
149
150 private Site deploySite;
151
152 private PlexusContainer container;
153
154
155
156
157 public void execute()
158 throws MojoExecutionException
159 {
160 if ( skip && isDeploy() )
161 {
162 getLog().info( "maven.site.skip = true: Skipping site deployment" );
163 return;
164 }
165
166 if ( skipDeploy && isDeploy() )
167 {
168 getLog().info( "maven.site.deploy.skip = true: Skipping site deployment" );
169 return;
170 }
171
172 deployTo( new BugFixedRepository( getDeploySite().getId(), getDeploySite().getUrl() ) );
173 }
174
175
176
177
178
179
180
181
182 protected static String appendSlash( final String url )
183 {
184 if ( url.endsWith( "/" ) )
185 {
186 return url;
187 }
188 else
189 {
190 return url + "/";
191 }
192 }
193
194
195
196
197
198
199
200 protected abstract boolean isDeploy();
201
202
203
204
205
206
207
208
209
210
211 protected String getTopDistributionManagementSiteUrl()
212 throws MojoExecutionException
213 {
214 if ( topDistributionManagementSiteUrl == null )
215 {
216 topDistributionManagementSiteUrl = determineTopDistributionManagementSiteUrl();
217
218 if ( !isDeploy() )
219 {
220 getLog().debug( "distributionManagement.site.url relative path: " + getDeployModuleDirectory() );
221 }
222 }
223 return topDistributionManagementSiteUrl;
224 }
225
226 protected abstract String determineTopDistributionManagementSiteUrl()
227 throws MojoExecutionException;
228
229
230
231
232
233
234
235
236
237
238 protected Site getDeploySite()
239 throws MojoExecutionException
240 {
241 if ( deploySite == null )
242 {
243 deploySite = determineDeploySite();
244 }
245 return deploySite;
246 }
247
248 protected abstract Site determineDeploySite()
249 throws MojoExecutionException;
250
251
252
253
254
255
256
257 protected String getDeployModuleDirectory()
258 throws MojoExecutionException
259 {
260 String relative = siteTool.getRelativePath( getSite( project ).getUrl(),
261 getTopDistributionManagementSiteUrl() );
262
263
264
265 relative = relative.replace( '\\', '/' );
266
267 return ( "".equals( relative ) ) ? "./" : relative;
268 }
269
270
271
272
273
274
275
276
277
278
279 private void deployTo( final Repository repository )
280 throws MojoExecutionException
281 {
282 if ( !inputDirectory.exists() )
283 {
284 throw new MojoExecutionException( "The site does not exist, please run site:site first" );
285 }
286
287 if ( getLog().isDebugEnabled() )
288 {
289 getLog().debug( "Deploying to '" + repository.getUrl() + "',\n Using credentials from server id '"
290 + repository.getId() + "'" );
291 }
292
293 deploy( inputDirectory, repository );
294 }
295
296 private void deploy( final File directory, final Repository repository )
297 throws MojoExecutionException
298 {
299
300 final Wagon wagon = getWagon( repository, wagonManager );
301
302 try
303 {
304 configureWagon( wagon, repository.getId(), settings, container, getLog() );
305 }
306 catch ( TransferFailedException e )
307 {
308 throw new MojoExecutionException( "Unable to configure Wagon: '" + repository.getProtocol() + "'", e );
309 }
310
311 try
312 {
313 final ProxyInfo proxyInfo;
314 if ( !isMaven3OrMore() )
315 {
316 proxyInfo = getProxyInfo( repository, wagonManager );
317 }
318 else
319 {
320 try
321 {
322 SettingsDecrypter settingsDecrypter = container.lookup( SettingsDecrypter.class );
323
324 proxyInfo = getProxy( repository, settingsDecrypter );
325 }
326 catch ( ComponentLookupException cle )
327 {
328 throw new MojoExecutionException( "Unable to lookup SettingsDecrypter: " + cle.getMessage(), cle );
329 }
330 }
331
332 push( directory, repository, wagon, proxyInfo, getLocales(), getDeployModuleDirectory() );
333
334 if ( chmod )
335 {
336 chmod( wagon, repository, chmodOptions, chmodMode );
337 }
338 }
339 finally
340 {
341 try
342 {
343 wagon.disconnect();
344 }
345 catch ( ConnectionException e )
346 {
347 getLog().error( "Error disconnecting wagon - ignored", e );
348 }
349 }
350 }
351
352 private Wagon getWagon( final Repository repository, final WagonManager manager )
353 throws MojoExecutionException
354 {
355 final Wagon wagon;
356
357 try
358 {
359 wagon = manager.getWagon( repository );
360 }
361 catch ( UnsupportedProtocolException e )
362 {
363 String shortMessage = "Unsupported protocol: '" + repository.getProtocol() + "' for site deployment to "
364 + "distributionManagement.site.url=" + repository.getUrl() + ".";
365 String longMessage =
366 "\n" + shortMessage + "\n" + "Currently supported protocols are: " + getSupportedProtocols() + ".\n"
367 + " Protocols may be added through wagon providers.\n" + " For more information, see "
368 + "http://maven.apache.org/plugins/maven-site-plugin/examples/adding-deploy-protocol.html";
369
370 getLog().error( longMessage );
371
372 throw new MojoExecutionException( shortMessage );
373 }
374 catch ( TransferFailedException e )
375 {
376 throw new MojoExecutionException( "Unable to configure Wagon: '" + repository.getProtocol() + "'", e );
377 }
378
379 if ( !wagon.supportsDirectoryCopy() )
380 {
381 throw new MojoExecutionException(
382 "Wagon protocol '" + repository.getProtocol() + "' doesn't support directory copying" );
383 }
384
385 return wagon;
386 }
387
388 private String getSupportedProtocols()
389 {
390 try
391 {
392 Set<String> protocols = container.lookupMap( Wagon.class ).keySet();
393
394 return StringUtils.join( protocols.iterator(), ", " );
395 }
396 catch ( ComponentLookupException e )
397 {
398
399 getLog().error( e );
400 }
401 return "";
402 }
403
404 private void push( final File inputDirectory, final Repository repository, final Wagon wagon,
405 final ProxyInfo proxyInfo, final List<Locale> localesList, final String relativeDir )
406 throws MojoExecutionException
407 {
408 AuthenticationInfo authenticationInfo = wagonManager.getAuthenticationInfo( repository.getId() );
409 getLog().debug( "authenticationInfo with id '" + repository.getId() + "': "
410 + ( ( authenticationInfo == null ) ? "-" : authenticationInfo.getUserName() ) );
411
412 try
413 {
414 if ( getLog().isDebugEnabled() )
415 {
416 Debug debug = new Debug();
417
418 wagon.addSessionListener( debug );
419
420 wagon.addTransferListener( debug );
421 }
422
423 if ( proxyInfo != null )
424 {
425 getLog().debug( "connect with proxyInfo" );
426 wagon.connect( repository, authenticationInfo, proxyInfo );
427 }
428 else if ( proxyInfo == null && authenticationInfo != null )
429 {
430 getLog().debug( "connect with authenticationInfo and without proxyInfo" );
431 wagon.connect( repository, authenticationInfo );
432 }
433 else
434 {
435 getLog().debug( "connect without authenticationInfo and without proxyInfo" );
436 wagon.connect( repository );
437 }
438
439 getLog().info( "Pushing " + inputDirectory );
440
441
442 final String defaultLocale = localesList.get( 0 ).getLanguage();
443
444 for ( Locale locale : localesList )
445 {
446 if ( locale.getLanguage().equals( defaultLocale ) )
447 {
448
449
450 getLog().info( " >>> to " + repository.getUrl() + relativeDir );
451
452 wagon.putDirectory( inputDirectory, relativeDir );
453 }
454 else
455 {
456 getLog().info( " >>> to " + repository.getUrl() + locale.getLanguage() + "/" + relativeDir );
457
458 wagon.putDirectory( new File( inputDirectory, locale.getLanguage() ),
459 locale.getLanguage() + "/" + relativeDir );
460 }
461 }
462 }
463 catch ( ResourceDoesNotExistException e )
464 {
465 throw new MojoExecutionException( "Error uploading site", e );
466 }
467 catch ( TransferFailedException e )
468 {
469 throw new MojoExecutionException( "Error uploading site", e );
470 }
471 catch ( AuthorizationException e )
472 {
473 throw new MojoExecutionException( "Error uploading site", e );
474 }
475 catch ( ConnectionException e )
476 {
477 throw new MojoExecutionException( "Error uploading site", e );
478 }
479 catch ( AuthenticationException e )
480 {
481 throw new MojoExecutionException( "Error uploading site", e );
482 }
483 }
484
485 private static void chmod( final Wagon wagon, final Repository repository, final String chmodOptions,
486 final String chmodMode )
487 throws MojoExecutionException
488 {
489 try
490 {
491 if ( wagon instanceof CommandExecutor )
492 {
493 CommandExecutor exec = (CommandExecutor) wagon;
494 exec.executeCommand( "chmod " + chmodOptions + " " + chmodMode + " " + repository.getBasedir() );
495 }
496
497 }
498 catch ( CommandExecutionException e )
499 {
500 throw new MojoExecutionException( "Error uploading site", e );
501 }
502 }
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522 public static ProxyInfo getProxyInfo( Repository repository, WagonManager wagonManager )
523 {
524 ProxyInfo proxyInfo = wagonManager.getProxy( repository.getProtocol() );
525
526 if ( proxyInfo == null )
527 {
528 return null;
529 }
530
531 String host = repository.getHost();
532 String nonProxyHostsAsString = proxyInfo.getNonProxyHosts();
533 for ( String nonProxyHost : StringUtils.split( nonProxyHostsAsString, ",;|" ) )
534 {
535 if ( StringUtils.contains( nonProxyHost, "*" ) )
536 {
537
538 final int pos = nonProxyHost.indexOf( '*' );
539 String nonProxyHostPrefix = nonProxyHost.substring( 0, pos );
540 String nonProxyHostSuffix = nonProxyHost.substring( pos + 1 );
541
542 if ( StringUtils.isNotEmpty( nonProxyHostPrefix ) && host.startsWith( nonProxyHostPrefix )
543 && StringUtils.isEmpty( nonProxyHostSuffix ) )
544 {
545 return null;
546 }
547
548 if ( StringUtils.isEmpty( nonProxyHostPrefix ) && StringUtils.isNotEmpty( nonProxyHostSuffix )
549 && host.endsWith( nonProxyHostSuffix ) )
550 {
551 return null;
552 }
553
554 if ( StringUtils.isNotEmpty( nonProxyHostPrefix ) && host.startsWith( nonProxyHostPrefix )
555 && StringUtils.isNotEmpty( nonProxyHostSuffix ) && host.endsWith( nonProxyHostSuffix ) )
556 {
557 return null;
558 }
559 }
560 else if ( host.equals( nonProxyHost ) )
561 {
562 return null;
563 }
564 }
565 return proxyInfo;
566 }
567
568
569
570
571
572
573
574
575 private ProxyInfo getProxy( Repository repository, SettingsDecrypter settingsDecrypter )
576 {
577 String protocol = repository.getProtocol();
578 String url = repository.getUrl();
579
580 getLog().debug( "repository protocol " + protocol );
581
582 String originalProtocol = protocol;
583
584
585
586
587 if ( StringUtils.equalsIgnoreCase( "dav", protocol ) && url.startsWith( "dav:" ) )
588 {
589 url = url.substring( 4 );
590 if ( url.startsWith( "http" ) )
591 {
592 try
593 {
594 URL urlSite = new URL( url );
595 protocol = urlSite.getProtocol();
596 getLog().debug( "found dav protocol so transform to real transport protocol " + protocol );
597 }
598 catch ( MalformedURLException e )
599 {
600 getLog().warn( "fail to build URL with " + url );
601 }
602
603 }
604 }
605 else
606 {
607 getLog().debug( "getProxy 'protocol': " + protocol );
608 }
609 if ( mavenSession != null && protocol != null )
610 {
611 MavenExecutionRequest request = mavenSession.getRequest();
612
613 if ( request != null )
614 {
615 List<Proxy> proxies = request.getProxies();
616
617 if ( proxies != null )
618 {
619 for ( Proxy proxy : proxies )
620 {
621 if ( proxy.isActive() && ( protocol.equalsIgnoreCase( proxy.getProtocol() )
622 || originalProtocol.equalsIgnoreCase( proxy.getProtocol() ) ) )
623 {
624 SettingsDecryptionResult result =
625 settingsDecrypter.decrypt( new DefaultSettingsDecryptionRequest( proxy ) );
626 proxy = result.getProxy();
627
628 ProxyInfo proxyInfo = new ProxyInfo();
629 proxyInfo.setHost( proxy.getHost() );
630
631
632 proxyInfo.setType( protocol );
633 proxyInfo.setPort( proxy.getPort() );
634 proxyInfo.setNonProxyHosts( proxy.getNonProxyHosts() );
635 proxyInfo.setUserName( proxy.getUsername() );
636 proxyInfo.setPassword( proxy.getPassword() );
637
638 getLog().debug( "found proxyInfo "
639 + ( "host:port " + proxyInfo.getHost() + ":" + proxyInfo.getPort()
640 + ", " + proxyInfo.getUserName() ) );
641
642 return proxyInfo;
643 }
644 }
645 }
646 }
647 }
648 getLog().debug( "getProxy 'protocol': " + protocol + " no ProxyInfo found" );
649 return null;
650 }
651
652
653
654
655
656
657
658
659
660
661
662
663 private static void configureWagon( Wagon wagon, String repositoryId, Settings settings, PlexusContainer container,
664 Log log )
665 throws TransferFailedException
666 {
667 log.debug( " configureWagon " );
668
669
670 for ( Server server : settings.getServers() )
671 {
672 String id = server.getId();
673
674 log.debug( "configureWagon server " + id );
675
676 if ( id != null && id.equals( repositoryId ) && ( server.getConfiguration() != null ) )
677 {
678 final PlexusConfiguration plexusConf =
679 new XmlPlexusConfiguration( (Xpp3Dom) server.getConfiguration() );
680
681 ComponentConfigurator componentConfigurator = null;
682 try
683 {
684 componentConfigurator =
685 (ComponentConfigurator) container.lookup( ComponentConfigurator.ROLE, "basic" );
686 if ( isMaven3OrMore() )
687 {
688 componentConfigurator.configureComponent( wagon, plexusConf,
689 container.getContainerRealm() );
690 }
691 else
692 {
693 configureWagonWithMaven2( componentConfigurator, wagon, plexusConf, container );
694 }
695 }
696 catch ( final ComponentLookupException e )
697 {
698 throw new TransferFailedException(
699 "While configuring wagon for \'" + repositoryId + "\': Unable to lookup wagon configurator."
700 + " Wagon configuration cannot be applied.", e );
701 }
702 catch ( ComponentConfigurationException e )
703 {
704 throw new TransferFailedException( "While configuring wagon for \'" + repositoryId
705 + "\': Unable to apply wagon configuration.", e );
706 }
707 finally
708 {
709 if ( componentConfigurator != null )
710 {
711 try
712 {
713 container.release( componentConfigurator );
714 }
715 catch ( ComponentLifecycleException e )
716 {
717 log.error( "Problem releasing configurator - ignoring: " + e.getMessage() );
718 }
719 }
720 }
721 }
722 }
723 }
724
725 private static void configureWagonWithMaven2( ComponentConfigurator componentConfigurator, Wagon wagon,
726 PlexusConfiguration plexusConf, PlexusContainer container )
727 throws ComponentConfigurationException
728 {
729
730
731
732
733 try
734 {
735 Method methodContainerRealm = container.getClass().getMethod( "getContainerRealm" );
736 ClassRealm realm = (ClassRealm) methodContainerRealm.invoke( container );
737
738 Method methodConfigure = componentConfigurator.getClass().getMethod( "configureComponent",
739 new Class[]{ Object.class,
740 PlexusConfiguration.class,
741 ClassRealm.class } );
742
743 methodConfigure.invoke( componentConfigurator, wagon, plexusConf, realm );
744 }
745 catch ( Exception e )
746 {
747 throw new ComponentConfigurationException(
748 "Failed to configure wagon component for a Maven2 use " + e.getMessage(), e );
749 }
750 }
751
752
753
754
755 public void contextualize( Context context )
756 throws ContextException
757 {
758 container = (PlexusContainer) context.get( PlexusConstants.PLEXUS_KEY );
759 }
760
761
762
763
764
765
766
767
768
769 protected static Site getSite( final MavenProject project )
770 throws MojoExecutionException
771 {
772 final DistributionManagement distributionManagement = project.getDistributionManagement();
773
774 if ( distributionManagement == null )
775 {
776 throw new MojoExecutionException( "Missing distribution management in project " + getFullName( project ) );
777 }
778
779 final Site site = distributionManagement.getSite();
780
781 if ( site == null )
782 {
783 throw new MojoExecutionException( "Missing site information in the distribution management of the project "
784 + getFullName( project ) );
785 }
786
787 if ( site.getUrl() == null || site.getId() == null )
788 {
789 throw new MojoExecutionException( "Missing site data: specify url and id for project "
790 + getFullName( project ) );
791 }
792
793 return site;
794 }
795
796 private static String getFullName( MavenProject project )
797 {
798 return project.getName() + " (" + project.getGroupId() + ':' + project.getArtifactId() + ':'
799 + project.getVersion() + ')';
800 }
801
802
803
804
805
806
807
808
809
810
811
812
813
814 protected MavenProject getTopLevelProject( MavenProject project )
815 throws MojoExecutionException
816 {
817 Site site = getSite( project );
818
819 MavenProject parent = project;
820
821 while ( parent.getParent() != null )
822 {
823 MavenProject oldProject = parent;
824
825 parent = siteTool.getParentProject( parent, reactorProjects, localRepository );
826
827 Site oldSite = site;
828
829 try
830 {
831 site = getSite( parent );
832 }
833 catch ( MojoExecutionException e )
834 {
835 return oldProject;
836 }
837
838
839 URIPathDescriptor siteURI = new URIPathDescriptor( URIEncoder.encodeURI( site.getUrl() ), "" );
840 URIPathDescriptor oldSiteURI = new URIPathDescriptor( URIEncoder.encodeURI( oldSite.getUrl() ), "" );
841
842 if ( !siteURI.sameSite( oldSiteURI.getBaseURI() ) )
843 {
844 return oldProject;
845 }
846 }
847
848 return parent;
849 }
850
851 private static class URIEncoder
852 {
853 private static final String MARK = "-_.!~*'()";
854 private static final String RESERVED = ";/?:@&=+$,";
855
856 public static String encodeURI( final String uriString )
857 {
858 final char[] chars = uriString.toCharArray();
859 final StringBuilder uri = new StringBuilder( chars.length );
860
861
862 if ( uriString.startsWith( "dav:http" ) )
863 {
864
865 chars[3] = '-';
866 }
867
868 for ( char c : chars )
869 {
870 if ( ( c >= '0' && c <= '9' ) || ( c >= 'a' && c <= 'z' ) || ( c >= 'A' && c <= 'Z' )
871 || MARK.indexOf( c ) != -1 || RESERVED.indexOf( c ) != -1 )
872 {
873 uri.append( c );
874 }
875 else
876 {
877 uri.append( '%' );
878 uri.append( Integer.toHexString( (int) c ) );
879 }
880 }
881 return uri.toString();
882 }
883 }
884 }