[MPIR-478] Allow to save avatars images for team report during project build

Author: slawekjaranowski

pom.xml

@@ -28,7 +28,7 @@ under the License.
   </parent>
 
   <artifactId>maven-project-info-reports-plugin</artifactId>
-  <version>3.8.1-SNAPSHOT</version>
+  <version>3.9.0-SNAPSHOT</version>
   <packaging>maven-plugin</packaging>
 
   <name>Apache Maven Project Info Reports Plugin</name>
@@ -123,7 +123,7 @@ under the License.
     <sitePluginVersion>3.20.0</sitePluginVersion>
     <fluidoSkinVersion>2.0.0-M11</fluidoSkinVersion>
     <checkstyle.violation.ignore>ParameterNumber,MethodLength</checkstyle.violation.ignore>
-    <project.build.outputTimestamp>2024-10-18T09:42:43Z</project.build.outputTimestamp>
+    <project.build.outputTimestamp>2025-02-19T22:31:07Z</project.build.outputTimestamp>
   </properties>
 
   <dependencies>

src/it/team-local-avatars/pom.xml

@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Licensed to the Apache Software Foundation (ASF) under one
+  ~ or more contributor license agreements.  See the NOTICE file
+  ~ distributed with this work for additional information
+  ~ regarding copyright ownership.  The ASF licenses this file
+  ~ to you under the Apache License, Version 2.0 (the
+  ~ "License"); you may not use this file except in compliance
+  ~ with the License.  You may obtain a copy of the License at
+  ~
+  ~   http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing,
+  ~ software distributed under the License is distributed on an
+  ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  ~ KIND, either express or implied.  See the License for the
+  ~ specific language governing permissions and limitations
+  ~ under the License.
+  -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>org.apache.maven.plugins.project-info-reports</groupId>
+  <artifactId>team-local-avatars</artifactId>
+  <version>1.0-SNAPSHOT</version>
+
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+  </properties>
+
+  <developers>
+    <developer>
+      <id>one-id</id>
+      <name>one-name</name>
+      <email>[email protected]</email>
+    </developer>
+    <developer>
+      <id>two-id</id>
+      <name>two-name</name>
+    </developer>
+    <developer>
+      <id>three-id</id>
+      <name>three-name</name>
+      <email>[email protected]</email>
+    </developer>
+  </developers>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-site-plugin</artifactId>
+        <version>@sitePluginVersion@</version>
+      </plugin>
+    </plugins>
+  </build>
+
+  <reporting>
+    <excludeDefaults>true</excludeDefaults>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-project-info-reports-plugin</artifactId>
+        <version>@project.version@</version>
+        <configuration>
+          <externalAvatarImages>false</externalAvatarImages>
+        </configuration>
+        <reportSets>
+          <reportSet>
+            <reports>
+              <report>team</report>
+            </reports>
+          </reportSet>
+        </reportSets>
+      </plugin>
+    </plugins>
+  </reporting>
+</project>

src/it/team-local-avatars/verify.groovy

@@ -0,0 +1,28 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+def team = new File( basedir, 'target/site/team.html' ).text
+
+assert team.contains('<figure><img src="avatars/182138993c4de5ac312e843239b31267.jpg" /></figure>')
+assert team.contains('<figure><img src="avatars/00000000000000000000000000000000.jpg" /></figure>')
+assert team.contains('<figure><img src="avatars/0433bc9903da776c918d0c8e86d51073.jpg" /></figure>')
+
+assert new File(basedir, 'target/site/avatars/182138993c4de5ac312e843239b31267.jpg').exists()
+assert new File(basedir, 'target/site/avatars/00000000000000000000000000000000.jpg').exists()
+assert new File(basedir, 'target/site/avatars/0433bc9903da776c918d0c8e86d51073.jpg').exists()

src/main/java/org/apache/maven/report/projectinfo/TeamReport.java

@@ -20,8 +20,8 @@
 
 import javax.inject.Inject;
 
-import java.security.MessageDigest;
-import java.security.NoSuchAlgorithmException;
+import java.io.IOException;
+import java.io.UncheckedIOException;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
@@ -36,6 +36,7 @@
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.project.ProjectBuilder;
+import org.apache.maven.report.projectinfo.avatars.AvatarsProvider;
 import org.apache.maven.reporting.MavenReportException;
 import org.apache.maven.repository.RepositorySystem;
 import org.codehaus.plexus.i18n.I18N;
@@ -52,19 +53,51 @@ public class TeamReport extends AbstractProjectInfoReport {
     /**
      * Shows avatar images for team members that have a) properties/picUrl set b) An avatar at gravatar.com for their
      * email address
-     * <p/>
-     * Future versions of this plugin may implement different strategies for resolving avatar images, possibly
-     * using different providers.
-     *<p>
-     *<strong>Note</strong>: This property will be renamed to {@code tteam.showAvatarImages} in 3.0.
+     *
      * @since 2.6
      */
     @Parameter(property = "teamlist.showAvatarImages", defaultValue = "true")
     private boolean showAvatarImages;
 
+    /**
+     * Indicate if URL should be used for avatar images.
+     * <p>
+     * If set to <code>false</code> images will be downloaded and attached to report during build.
+     * Local path will be used for images.
+     *
+     * @since 3.9.0
+     */
+    @Parameter(property = "teamlist.externalAvatarImages", defaultValue = "true")
+    private boolean externalAvatarImages;
+
+    /**
+     * Base URL for avatar provider.
+     *
+     * @since 3.9.0
+     */
+    @Parameter(property = "teamlist.avatarBaseUrl", defaultValue = "https://www.gravatar.com/avatar/")
+    private String avatarBaseUrl;
+
+    /**
+     * Provider name for avatar images.
+     * <p>
+     * Report has one implementation for gravatar.com. Users can provide other by implementing {@link AvatarsProvider}.
+     *
+     * @since 3.9.0
+     */
+    @Parameter(property = "teamlist.avatarProviderName", defaultValue = "gravatar")
+    private String avatarProviderName;
+
+    private final Map<String, AvatarsProvider> avatarsProviders;
+
     @Inject
-    public TeamReport(RepositorySystem repositorySystem, I18N i18n, ProjectBuilder projectBuilder) {
+    public TeamReport(
+            RepositorySystem repositorySystem,
+            I18N i18n,
+            ProjectBuilder projectBuilder,
+            Map<String, AvatarsProvider> avatarsProviders) {
         super(repositorySystem, i18n, projectBuilder);
+        this.avatarsProviders = avatarsProviders;
     }
 
     // ----------------------------------------------------------------------
@@ -83,9 +116,22 @@ public boolean canGenerateReport() throws MavenReportException {
     }
 
     @Override
-    public void executeReport(Locale locale) {
-        ProjectTeamRenderer r =
-                new ProjectTeamRenderer(getSink(), project.getModel(), getI18N(locale), locale, showAvatarImages);
+    public void executeReport(Locale locale) throws MavenReportException {
+        AvatarsProvider avatarsProvider = avatarsProviders.get(avatarProviderName);
+        if (avatarsProvider == null) {
+            throw new MavenReportException("No AvatarsProvider found for name " + avatarProviderName);
+        }
+        avatarsProvider.setBaseUrl(avatarBaseUrl);
+        avatarsProvider.setOutputDirectory(getReportOutputDirectory());
+
+        ProjectTeamRenderer r = new ProjectTeamRenderer(
+                getSink(),
+                project.getModel(),
+                getI18N(locale),
+                locale,
+                showAvatarImages,
+                externalAvatarImages,
+                avatarsProvider);
         r.render();
     }
 
@@ -134,20 +180,24 @@ private static class ProjectTeamRenderer extends AbstractProjectInfoRenderer {
 
         private final boolean showAvatarImages;
 
-        private final String protocol;
+        private final boolean externalAvatarImages;
 
-        ProjectTeamRenderer(Sink sink, Model model, I18N i18n, Locale locale, boolean showAvatarImages) {
+        private final AvatarsProvider avatarsProvider;
+
+        ProjectTeamRenderer(
+                Sink sink,
+                Model model,
+                I18N i18n,
+                Locale locale,
+                boolean showAvatarImages,
+                boolean externalAvatarImages,
+                AvatarsProvider avatarsProvider) {
             super(sink, i18n, locale);
 
             this.model = model;
             this.showAvatarImages = showAvatarImages;
-
-            // prepare protocol for gravatar
-            if (model.getUrl() != null && model.getUrl().startsWith("https://")) {
-                this.protocol = "https";
-            } else {
-                this.protocol = "http";
-            }
+            this.externalAvatarImages = externalAvatarImages;
+            this.avatarsProvider = avatarsProvider;
         }
 
         @Override
@@ -226,10 +276,7 @@ private void renderTeamMember(Contributor member, Map<String, Boolean> headersMa
                 Properties properties = member.getProperties();
                 String picUrl = properties.getProperty("picUrl");
                 if (picUrl == null || picUrl.isEmpty()) {
-                    picUrl = getGravatarUrl(member.getEmail());
-                }
-                if (picUrl == null || picUrl.isEmpty()) {
-                    picUrl = getSpacerGravatarUrl();
+                    picUrl = getExternalAvatarUrl(member.getEmail());
                 }
                 sink.tableCell();
                 sink.figure();
@@ -288,32 +335,13 @@ private void renderTeamMember(Contributor member, Map<String, Boolean> headersMa
             sink.tableRow_();
         }
 
-        private static final String AVATAR_SIZE = "s=60";
-
-        private String getSpacerGravatarUrl() {
-            return protocol + "://www.gravatar.com/avatar/00000000000000000000000000000000?d=blank&f=y&" + AVATAR_SIZE;
-        }
-
-        private String getGravatarUrl(String email) {
-            if (email == null) {
-                return null;
-            }
-            email = StringUtils.trim(email);
-            email = email.toLowerCase();
-            MessageDigest md;
+        private String getExternalAvatarUrl(String email) {
             try {
-                md = MessageDigest.getInstance("MD5");
-                md.update(email.getBytes());
-                byte[] byteData = md.digest();
-                StringBuilder sb = new StringBuilder();
-                final int lowerEightBitsOnly = 0xff;
-                for (byte aByteData : byteData) {
-                    sb.append(Integer.toString((aByteData & lowerEightBitsOnly) + 0x100, 16)
-                            .substring(1));
-                }
-                return protocol + "://www.gravatar.com/avatar/" + sb.toString() + "?d=mm&" + AVATAR_SIZE;
-            } catch (NoSuchAlgorithmException e) {
-                return null;
+                return externalAvatarImages
+                        ? avatarsProvider.getExternalAvatarUrl(email)
+                        : avatarsProvider.getLocalAvatarPath(email);
+            } catch (IOException e) {
+                throw new UncheckedIOException(e);
             }
         }
 

src/main/java/org/apache/maven/report/projectinfo/avatars/AvatarsProvider.java

@@ -0,0 +1,59 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.report.projectinfo.avatars;
+
+import java.io.File;
+import java.io.IOException;
+
+/**
+ * Avatar provider API.
+ */
+public interface AvatarsProvider {
+
+    /**
+     * Set a base URL for provider
+     *
+     * @param baseUrl for provider
+     */
+    void setBaseUrl(String baseUrl);
+
+    /**
+     * Set site output directory. Used to store avatar images in project.
+     *
+     * @param outputDirectory a site output directory
+     */
+    void setOutputDirectory(File outputDirectory);
+
+    /**
+     * Return an external URL for gravatar image.
+     *
+     * @param email email address for gravatar image
+     * @return an external URL
+     */
+    String getExternalAvatarUrl(String email);
+
+    /**
+     * Return a local path to downloaded avatar image.
+     *
+     * @param email email address for gravatar image
+     * @return a local avatar path
+     * @throws IOException if problem with image downloading
+     */
+    String getLocalAvatarPath(String email) throws IOException;
+}