Class DefaultSiteTool

java.lang.Object
org.apache.maven.doxia.tools.DefaultSiteTool
All Implemented Interfaces:
SiteTool
@Singleton @Named public class DefaultSiteTool extends Object implements SiteTool
Default implementation of the site tool.

  • Field Details

    • LOGGER

      private static final org.slf4j.Logger LOGGER

    • repositorySystem

      @Inject protected org.eclipse.aether.RepositorySystem repositorySystem
      The component that is used to resolve additional required artifacts.

    • artifactHandlerManager

      @Inject private org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager
      The component used for getting artifact handlers.

    • i18n

      @Inject protected org.codehaus.plexus.i18n.I18N i18n
      Internationalization.

    • assembler

      @Inject protected SiteModelInheritanceAssembler assembler
      The component for assembling inheritance.

  • Constructor Details

    • DefaultSiteTool

      public DefaultSiteTool()

  • Method Details

    • getSkinArtifactFromRepository

      public org.apache.maven.artifact.Artifact getSkinArtifactFromRepository(org.eclipse.aether.RepositorySystemSession repoSession, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories, Skin skin) throws SiteToolException
      Get a skin artifact from one of the repositories.
      Specified by:
      getSkinArtifactFromRepository in interface SiteTool
      Parameters:
      repoSession - the repository system session, not null.
      remoteProjectRepositories - the Maven remote project repositories, not null.
      skin - the Skin model, not null.
      Returns:
      the Skin artifact defined in a SiteModel from a given project
      Throws:
      SiteToolException - if any

    • getRelativePath

      @Deprecated public String getRelativePath(String to, String from)
      Deprecated.
      This method is not implemented according to the URI specification and has many weird corner cases where it doesn't do the right thing. Please consider using a better implemented method from a different library such as org.apache.http.client.utils.URIUtils#resolve.
      Specified by:
      getRelativePath in interface SiteTool
      Parameters:
      to - the to url of file as string
      from - the from url of file as string
      Returns:
      a relative path from from to to.

    • getRelativeFilePath

      private static String getRelativeFilePath(String oldPath, String newPath)

    • getSiteDescriptor

      public File getSiteDescriptor(File siteDirectory, Locale locale)
      Get a site descriptor from the project's site directory.
      Specified by:
      getSiteDescriptor in interface SiteTool
      Parameters:
      siteDirectory - the site directory, not null
      locale - the locale wanted for the site descriptor, not null. Most specific to least specific lookup from site_language_country_variant.xml, site_language_country.xml, site_language.xml}, to site.xml as last resort for Locale.ROOT, if provided locale defines a variant and/or a country and/or a language.
      Returns:
      the most specific site descriptor file for the given locale

    • getSiteDescriptorFromRepository

      File getSiteDescriptorFromRepository(org.apache.maven.project.MavenProject project, org.eclipse.aether.RepositorySystemSession repoSession, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories, Locale locale) throws SiteToolException
      Get a site descriptor from one of the repositories.
      Parameters:
      project - the Maven project, not null.
      repoSession - the repository system session, not null.
      remoteProjectRepositories - the Maven remote project repositories, not null.
      locale - the locale wanted for the site descriptor, not null. See getSiteDescriptor(File, Locale) for details.
      Returns:
      the site descriptor into the local repository after download of it from repositories or null if not found in repositories.
      Throws:
      SiteToolException - if any

    • getSiteModel

      @Deprecated public SiteModel getSiteModel(File siteDirectory, Locale locale, org.apache.maven.project.MavenProject project, List<org.apache.maven.project.MavenProject> reactorProjects, org.eclipse.aether.RepositorySystemSession repoSession, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories) throws SiteToolException
      Deprecated.
      Description copied from interface: SiteTool
      Get a site model for a project.
      Specified by:
      getSiteModel in interface SiteTool
      Parameters:
      siteDirectory - the site directory, may be null if project from repository
      locale - the locale used for the i18n in SiteModel, not null. See SiteTool.getSiteDescriptor(File, Locale) for details.
      project - the Maven project, not null.
      reactorProjects - the Maven reactor projects, not null.
      repoSession - the repository system session, not null.
      remoteProjectRepositories - the Maven remote project repositories, not null.
      Returns:
      the SiteModel object corresponding to the site.xml file with some interpolations.
      Throws:
      SiteToolException - if any

    • getSiteModel

      public SiteModel getSiteModel(File siteDirectory, Locale locale, org.apache.maven.execution.MavenExecutionRequest request, org.apache.maven.project.MavenProject project, List<org.apache.maven.project.MavenProject> reactorProjects, org.eclipse.aether.RepositorySystemSession repoSession, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories) throws SiteToolException
      Description copied from interface: SiteTool
      Get a site model for a project.
      Specified by:
      getSiteModel in interface SiteTool
      Parameters:
      siteDirectory - the site directory, may be null if project from repository
      locale - the locale used for the i18n in SiteModel, not null. See SiteTool.getSiteDescriptor(File, Locale) for details.
      request - the Maven execution request, not null. This is needed to get the user properties and the system properties for interpolation.
      project - the Maven project, not null.
      reactorProjects - the Maven reactor projects, not null.
      repoSession - the repository system session, not null.
      remoteProjectRepositories - the Maven remote project repositories, not null.
      Returns:
      the SiteModel object corresponding to the site.xml file with some interpolations.
      Throws:
      SiteToolException - if any

    • getInterpolatedSiteDescriptorContent

      @Deprecated public String getInterpolatedSiteDescriptorContent(Map<String,String> props, org.apache.maven.project.MavenProject aProject, String siteDescriptorContent) throws SiteToolException
      Deprecated.
      Description copied from interface: SiteTool
      Interpolating several expressions in the site descriptor content. Actually, the expressions can be in the project, the environment variables and the specific properties like encoding.

      For instance:

      ${project.name}
      The value from the POM of:

      <project>
        <name>myProjectName</name>
      </project>

      ${my.value}
      The value from the POM of:

      <properties>
        <my.value>hello</my.value>
      </properties>

      ${JAVA_HOME}
      The value of JAVA_HOME in the environment variables
      Specified by:
      getInterpolatedSiteDescriptorContent in interface SiteTool
      Parameters:
      props - a map used for interpolation, not null.
      aProject - a Maven project, not null.
      siteDescriptorContent - the site descriptor file, not null.
      Returns:
      the interpolated site descriptor content.
      Throws:
      SiteToolException - if errors happened during the interpolation.

    • getInterpolatedSiteDescriptorContent

      private String getInterpolatedSiteDescriptorContent(org.apache.maven.execution.MavenExecutionRequest request, org.apache.maven.project.MavenProject aProject, String siteDescriptorContent, boolean isEarly) throws SiteToolException
      Interpolation similar to what AbstractStringBasedModelInterpolator.java is doing.
      Parameters:
      request -
      aProject -
      siteDescriptorContent -
      isEarly -
      Returns:
      the interpolated site descriptor content
      Throws:
      SiteToolException

    • mergeProperties

      private static Properties mergeProperties(org.apache.maven.execution.MavenExecutionRequest request, org.apache.maven.project.MavenProject aProject)
      Merge properties from different sources in the following order (with later sources overriding earlier ones):
      1. System properties from the Maven execution request
      2. Project properties from the Maven project
      3. User properties from the Maven execution request
      Parameters:
      request -
      aProject -
      Returns:

    • populateParentMenu

      private void populateParentMenu(SiteModel siteModel, Locale locale, org.apache.maven.project.MavenProject project, org.apache.maven.project.MavenProject parentProject, boolean keepInheritedRefs)
      Populate the pre-defined parent menu of the site model, if used through <menu ref="parent"/>.
      Parameters:
      siteModel - the Doxia Sitetools SiteModel, not null.
      locale - the locale used for the i18n in SiteModel, not null.
      project - a Maven project, not null.
      parentProject - a Maven parent project, not null.
      keepInheritedRefs - used for inherited references.

    • populateModulesMenu

      private void populateModulesMenu(SiteModel siteModel, Locale locale, org.apache.maven.project.MavenProject project, List<org.apache.maven.project.MavenProject> reactorProjects, boolean keepInheritedRefs) throws SiteToolException, IOException
      Populate the pre-defined modules menu of the model, if used through <menu ref="modules"/>.
      Parameters:
      siteModel - the Doxia Sitetools SiteModel, not null.
      locale - the locale used for the i18n in SiteModel, not null.
      project - a Maven project, not null.
      reactorProjects - the Maven reactor projects, not null.
      keepInheritedRefs - used for inherited references.
      Throws:
      SiteToolException - if any
      IOException

    • getModuleFromReactor

      private org.apache.maven.project.MavenProject getModuleFromReactor(org.apache.maven.project.MavenProject project, List<org.apache.maven.project.MavenProject> reactorProjects, String module) throws IOException
      Throws:
      IOException

    • populateReportsMenu

      public void populateReportsMenu(SiteModel siteModel, Locale locale, Map<String, List<org.apache.maven.reporting.MavenReport>> categories)
      Populate the pre-defined reports menu of the site model, if used through <menu ref="reports"/>. Notice this menu reference is translated into 2 separate menus: "Project Information" and "Project Reports".
      Specified by:
      populateReportsMenu in interface SiteTool
      Parameters:
      siteModel - the Doxia Sitetools SiteModel, not null.
      locale - the locale used for the i18n in SiteModel, not null. See SiteTool.getSiteDescriptor(File, Locale) for details.
      categories - reports per category to put in "Reports" or "Information" menus, not null.
      See Also:
      • MavenReport.CATEGORY_PROJECT_INFORMATION
      • MavenReport.CATEGORY_PROJECT_REPORTS

    • getSiteLocales

      public List<Locale> getSiteLocales(String locales)
      Extracts from a comma-separated list the locales that are available in site-tool resource bundle.
      Specified by:
      getSiteLocales in interface SiteTool
      Parameters:
      locales - A comma separated list of locales
      Returns:
      a list of Locales.

    • codeToLocale

      private Locale codeToLocale(String localeCode)
      Converts a locale code like "en", "en_US" or "en_US_win" to a java.util.Locale object.

      If localeCode = system, return the current value of the default locale for this instance of the Java Virtual Machine.

      If localeCode = default, return the root locale.

      Parameters:
      localeCode - the locale code string.
      Returns:
      a java.util.Locale object instanced or null if errors occurred
      See Also:

    • getNormalizedPath

      protected static String getNormalizedPath(String path)
      Parameters:
      path - could be null.
      Returns:
      the path normalized, i.e. by eliminating "/../" and "/./" in the path.
      See Also:
      • FilenameUtils.normalize(String)

    • createSiteDescriptorArtifactRequest

      private org.eclipse.aether.resolution.ArtifactRequest createSiteDescriptorArtifactRequest(org.apache.maven.project.MavenProject project, String localeStr, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories)
      Parameters:
      project - not null
      localeStr - not null
      remoteProjectRepositories - not null
      Returns:
      the site descriptor artifact request

    • resolveSiteDescriptor

      private File resolveSiteDescriptor(org.apache.maven.project.MavenProject project, org.eclipse.aether.RepositorySystemSession repoSession, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories, Locale locale) throws org.eclipse.aether.resolution.ArtifactResolutionException
      Parameters:
      project - not null
      repoSession - the repository system session not null
      remoteProjectRepositories - not null
      locale - not null
      Returns:
      the resolved site descriptor or null if not found in repositories.
      Throws:
      org.eclipse.aether.resolution.ArtifactResolutionException - if any

    • deletePseudoSiteDescriptorMarkerFile

      private void deletePseudoSiteDescriptorMarkerFile(org.eclipse.aether.RepositorySystemSession repoSession, org.eclipse.aether.resolution.ArtifactRequest request)

    • getSiteModel

      private Map.Entry<SiteModel, org.apache.maven.project.MavenProject> getSiteModel(int depth, File siteDirectory, Locale locale, org.apache.maven.execution.MavenExecutionRequest request, org.apache.maven.project.MavenProject project, org.eclipse.aether.RepositorySystemSession repoSession, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories) throws SiteToolException
      Parameters:
      depth - depth of project
      siteDirectory - , can be null if project.basedir is null, ie POM from repository
      locale - not null
      project - not null
      repoSession - not null
      remoteProjectRepositories - not null
      Returns:
      the site model depending the locale and the parent project
      Throws:
      SiteToolException - if any

    • readSiteModel

      private SiteModel readSiteModel(String siteDescriptorContent, org.apache.maven.project.MavenProject project, Locale locale) throws SiteToolException
      Parameters:
      siteDescriptorContent - not null
      Returns:
      the site model object
      Throws:
      SiteToolException - if any

    • convertOldToNewSiteModel

      private SiteModel convertOldToNewSiteModel(DecorationModel oldModel)

    • convertBanner

      private Banner convertBanner(Banner oldBanner)

    • convertImage

      private Image convertImage(String src, String position, String height, String width, String border, String alt)

    • convertLinkItem

      private LinkItem convertLinkItem(LinkItem oldLinkItem)

    • convertMenuItems

      private List<MenuItem> convertMenuItems(List<MenuItem> oldMenuItems)

    • isOldSiteModel

      private boolean isOldSiteModel(String siteDescriptorContent) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException, IOException
      Throws:
      org.codehaus.plexus.util.xml.pull.XmlPullParserException
      IOException

    • getDefaultSiteModel

      private SiteModel getDefaultSiteModel() throws SiteToolException
      Throws:
      SiteToolException

    • siteModelToString

      private String siteModelToString(SiteModel siteModel) throws SiteToolException
      Throws:
      SiteToolException

    • buildRelativePath

      private static String buildRelativePath(String toPath, String fromPath, char separatorChar)

    • appendMenuItem

      private void appendMenuItem(org.apache.maven.project.MavenProject project, Menu menu, String name, String href, String defaultHref)
      Parameters:
      project - not null
      menu - not null
      name - not null
      href - could be null
      defaultHref - could be null

    • createCategoryMenu

      private MenuItem createCategoryMenu(String name, String href, List<org.apache.maven.reporting.MavenReport> categoryReports, Locale locale)
      Parameters:
      name - not null
      href - not null
      categoryReports - not null
      locale - not null
      Returns:
      the menu item object

    • isEmptyList

      private static boolean isEmptyList(List<?> list)
      Convenience method.
      Parameters:
      list - could be null
      Returns:
      true if the list is null or empty

    • getDistMgmntSiteUrl

      private static String getDistMgmntSiteUrl(org.apache.maven.project.MavenProject project)
      Return distributionManagement.site.url if defined, null otherwise.
      Parameters:
      project - not null
      Returns:
      could be null

    • getDistMgmntSiteUrl

      private static String getDistMgmntSiteUrl(org.apache.maven.model.DistributionManagement distMgmnt)

    • getPlugin

      private static org.apache.maven.model.Plugin getPlugin(org.apache.maven.project.MavenProject project, String pluginId)
      Parameters:
      project - the project
      pluginId - The id of the plugin
      Returns:
      The information about the plugin.

    • getPluginParameter

      private static String getPluginParameter(org.apache.maven.project.MavenProject project, String pluginId, String param)
      Parameters:
      project - the project
      pluginId - The pluginId
      param - The child which should be checked.
      Returns:
      The value of the dom tree.

    • urlEncode

      private static String urlEncode(String url)