3 * Copyright (C) 2009-2024 SonarSource SA
4 * mailto:info AT sonarsource DOT com
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 3 of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 package org.sonar.server.notification.email.telemetry;
22 import com.google.common.net.InternetDomainName;
23 import java.util.Optional;
25 import org.apache.commons.lang3.StringUtils;
26 import org.sonar.db.DbClient;
27 import org.sonar.db.DbSession;
28 import org.sonar.telemetry.core.Dimension;
29 import org.sonar.telemetry.core.Granularity;
30 import org.sonar.telemetry.core.TelemetryDataProvider;
31 import org.sonar.telemetry.core.TelemetryDataType;
33 import static org.sonar.server.email.EmailSmtpConfiguration.EMAIL_CONFIG_SMTP_HOST;
35 public class EmailConfigHostTelemetryProvider implements TelemetryDataProvider<String> {
36 private final DbClient dbClient;
38 public EmailConfigHostTelemetryProvider(DbClient dbClient) {
39 this.dbClient = dbClient;
43 public String getMetricKey() {
44 return "email_conf_host";
48 public Dimension getDimension() {
49 return Dimension.INSTALLATION;
53 public Granularity getGranularity() {
54 return Granularity.WEEKLY;
58 public TelemetryDataType getType() {
59 return TelemetryDataType.STRING;
63 public Optional<String> getValue() {
64 try (DbSession dbSession = dbClient.openSession(false)) {
65 return dbClient.internalPropertiesDao()
66 .selectByKey(dbSession, EMAIL_CONFIG_SMTP_HOST)
67 .map(EmailConfigHostTelemetryProvider::extractDomain);
71 private static String extractDomain(String host) {
72 if (StringUtils.isEmpty(host)) {
73 return "EMPTY_DOMAIN";
76 host = host.contains("://") ? StringUtils.substringBefore(StringUtils.substringAfter(host, "://"), "/") : StringUtils.substringBefore(host, "/");
77 return InternetDomainName.from(host).topPrivateDomain().toString();
78 } catch (RuntimeException e) {
79 return switch (StringUtils.substringBefore(e.getMessage(), ":")) {
80 case "Not a valid domain name" -> "NOT_VALID_DOMAIN_NAME";
81 case "Not under a public suffix" -> "DOMAIN_NOT_UNDER_PUBLIC_SUFFIX";
82 default -> "NOT_VALID_DOMAIN";