Commit 6b5c6b78 authored by nik's avatar nik
Browse files

platform: add UTM parameters to download URLs from About popup

Introduce IdeUrlTrackingParametersProvider service which is overriden in products to append necessary parameters, remove 'fromIDE' parameter from *ApplicationInfo.xml files.
(IDEA-CR-27675, IDEA-183268)
parent 426f1ea6
Showing with 88 additions and 34 deletions
+88 -34
......@@ -2,7 +2,7 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://jetbrains.org/intellij/schema/application-info http://jetbrains.org/intellij/schema/ApplicationInfo.xsd">
<version major="2018" minor="1" eap="true"/>
<company name="JetBrains s.r.o." url="https://www.jetbrains.com/?fromIDE"/>
<company name="JetBrains s.r.o." url="https://www.jetbrains.com"/>
<build number="__BUILD_NUMBER__" date="__BUILD_DATE__"/>
<logo url="/idea_community_logo.png" textcolor="e5e5e5" progressColor="ed566a" progressX="117" progressY="280" progressHeight="3" />
<about url="/idea_community_about.png" foreground="939598" copyrightForeground="939598" linkColor="095fdc" logoX="540" logoY="300" logoW="100" logoH="100"/>
......
/*
* Copyright 2000-2017 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
*/
package com.intellij.openapi.application;
import com.intellij.openapi.components.ServiceManager;
import org.jetbrains.annotations.NotNull;
/**
* Allows IDEs to add tracking parameters to URLs which are opened from IDE and lead to company sites (e.g. download/update links, product documentation).
* Override this service in your IDE to append tracking parameters to these URLs if you need to collect statistics on your site.
* <br>
* This service isn't supposed to be overridden in regular plugins.
*/
public class IdeUrlTrackingParametersProvider {
public static IdeUrlTrackingParametersProvider getInstance() {
return ServiceManager.getService(IdeUrlTrackingParametersProvider.class);
}
/**
* @return {@code originalUrl} with appended parameters
*/
@NotNull
public String augmentUrl(@NotNull String originalUrl) {
return originalUrl;
}
}
......@@ -18,6 +18,7 @@ package com.intellij.openapi.application.impl;
import com.google.common.annotations.VisibleForTesting;
import com.intellij.ide.plugins.PluginManagerCore;
import com.intellij.openapi.application.ApplicationNamesInfo;
import com.intellij.openapi.application.IdeUrlTrackingParametersProvider;
import com.intellij.openapi.application.PathManager;
import com.intellij.openapi.application.ex.ApplicationInfoEx;
import com.intellij.openapi.util.BuildNumber;
......@@ -28,7 +29,6 @@ import com.intellij.openapi.util.registry.Registry;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.ui.JBColor;
import com.intellij.util.ArrayUtil;
import com.intellij.util.ObjectUtils;
import com.intellij.util.PlatformUtils;
import com.intellij.util.SystemProperties;
import com.intellij.util.containers.ContainerUtil;
......@@ -331,7 +331,7 @@ public class ApplicationInfoImpl extends ApplicationInfoEx {
@Override
public String getCompanyURL() {
return myCompanyUrl;
return IdeUrlTrackingParametersProvider.getInstance().augmentUrl(myCompanyUrl);
}
@Nullable
......
/*
* Copyright 2000-2017 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
*/
package com.intellij.ide.customization;
import com.intellij.openapi.application.ApplicationInfo;
import com.intellij.openapi.application.IdeUrlTrackingParametersProvider;
import com.intellij.openapi.diagnostic.Logger;
import org.apache.http.client.utils.URIBuilder;
import org.jetbrains.annotations.NotNull;
import java.net.URISyntaxException;
/**
* @author nik
*/
public class UtmIdeUrlTrackingParametersProvider extends IdeUrlTrackingParametersProvider {
private static final Logger LOG = Logger.getInstance(UtmIdeUrlTrackingParametersProvider.class);
@NotNull
@Override
public String augmentUrl(@NotNull String originalUrl) {
try {
ApplicationInfo info = ApplicationInfo.getInstance();
String productVersion = info.getMajorVersion() + "." + info.getMinorVersionMainPart();
return new URIBuilder(originalUrl).addParameter("utm_source", "product")
.addParameter("utm_medium", "link")
.addParameter("utm_campaign", info.getBuild().getProductCode())
.addParameter("utm_content", productVersion)
.build().toString();
}
catch (URISyntaxException e) {
LOG.warn(originalUrl, e);
return originalUrl;
}
}
}
......@@ -23,6 +23,7 @@ import com.intellij.ide.plugins.IdeaPluginDescriptor;
import com.intellij.ide.plugins.PluginManagerCore;
import com.intellij.internal.statistic.UsageTrigger;
import com.intellij.openapi.application.ApplicationInfo;
import com.intellij.openapi.application.IdeUrlTrackingParametersProvider;
import com.intellij.openapi.application.ex.ApplicationInfoEx;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.extensions.ExtensionPointName;
......@@ -31,7 +32,6 @@ import com.intellij.openapi.help.WebHelpProvider;
import com.intellij.openapi.ui.Messages;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.reference.SoftReference;
import com.intellij.util.PlatformUtils;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.Nullable;
......@@ -86,14 +86,7 @@ public class HelpManagerImpl extends HelpManager {
if (!url.endsWith("/")) url += "/";
url += productVersion + "/?" + id;
if (PlatformUtils.isJetBrainsProduct()) {
String productCode = info.getBuild().getProductCode();
if(!StringUtil.isEmpty(productCode)) {
url += "&utm_source=from_product&utm_medium=help_link&utm_campaign=" + productCode + "&utm_content=" + productVersion;
}
}
BrowserUtil.browse(url);
BrowserUtil.browse(IdeUrlTrackingParametersProvider.getInstance().augmentUrl(url));
return;
}
......
......@@ -8,10 +8,7 @@ import com.intellij.ide.plugins.IdeaPluginDescriptor;
import com.intellij.notification.Notification;
import com.intellij.notification.NotificationListener;
import com.intellij.notification.NotificationType;
import com.intellij.openapi.application.ApplicationInfo;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.application.ApplicationNamesInfo;
import com.intellij.openapi.application.PathManager;
import com.intellij.openapi.application.*;
import com.intellij.openapi.application.ex.ApplicationEx;
import com.intellij.openapi.application.ex.ApplicationManagerEx;
import com.intellij.openapi.application.impl.ApplicationImpl;
......@@ -33,7 +30,6 @@ import com.intellij.util.SystemProperties;
import com.intellij.util.containers.ContainerUtil;
import com.intellij.util.text.DateFormatUtil;
import com.intellij.util.ui.JBUI;
import org.apache.http.client.utils.URIBuilder;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
......@@ -43,7 +39,6 @@ import java.awt.*;
import java.awt.event.ActionEvent;
import java.io.File;
import java.io.IOException;
import java.net.URISyntaxException;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.*;
......@@ -338,18 +333,6 @@ class UpdateInfoDialog extends AbstractUpdateDialog {
}
private static String augmentUrl(String url) {
try {
ApplicationInfo info = ApplicationInfo.getInstance();
String productVersion = info.getMajorVersion() + "." + info.getMinorVersionMainPart();
return new URIBuilder(url).addParameter("utm_source", "product")
.addParameter("utm_medium", "link")
.addParameter("utm_campaign", info.getBuild().getProductCode())
.addParameter("utm_content", productVersion)
.build().toString();
}
catch (URISyntaxException e) {
Logger.getInstance(UpdateInfoDialog.class).warn(url, e);
return url;
}
return IdeUrlTrackingParametersProvider.getInstance().augmentUrl(url);
}
}
\ No newline at end of file
......@@ -152,6 +152,8 @@
<applicationService serviceInterface="com.intellij.ide.externalComponents.ExternalComponentManager"
serviceImplementation="com.intellij.ide.externalComponents.ExternalComponentManagerImpl"/>
<applicationService serviceImplementation="com.intellij.openapi.application.IdeUrlTrackingParametersProvider"/>
<applicationService serviceInterface="com.intellij.featureStatistics.FeatureUsageTracker"
serviceImplementation="com.intellij.featureStatistics.FeatureUsageTrackerImpl"/>
<applicationService serviceInterface="com.intellij.reporting.FreezeLogger"
......
<component>
<version codename="Community Edition" major="10" minor="0" eap="true" update-channel="IDEA10EAP"/>
<company name="JetBrains s.r.o." url="https://www.jetbrains.com/?fromIDE"/>
<company name="JetBrains s.r.o." url="https://www.jetbrains.com"/>
<build number="__BUILD_NUMBER__" date="__BUILD_DATE__"/>
<logo url="/idea_community_logo.png" textcolor="FFFFFF"/>
<about url="/idea_community_about.png"/>
......
......@@ -2,7 +2,7 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://jetbrains.org/intellij/schema/application-info http://jetbrains.org/intellij/schema/ApplicationInfo.xsd">
<version major="2017" minor="3" eap="false"/>
<company name="JetBrains s.r.o." url="https://www.jetbrains.com/?fromIDE" copyrightStart="2010"/>
<company name="JetBrains s.r.o." url="https://www.jetbrains.com" copyrightStart="2010"/>
<build number="__BUILD_NUMBER__" date="__BUILD_DATE__"/>
<logo url="/pycharm_edu_logo.png" textcolor="e5e5e5" progressColor="21d688" progressY="281" progressTailIcon="/community_progress_tail.png"/>
<about url="/pycharm_edu_about.png" logoX="540" logoY="300" logoW="100" logoH="100" foreground="e5e5e5"
......
......@@ -24,6 +24,9 @@
</application-components>
<extensions defaultExtensionNs="com.intellij">
<applicationService serviceInterface="com.intellij.openapi.application.IdeUrlTrackingParametersProvider"
serviceImplementation="com.intellij.ide.customization.UtmIdeUrlTrackingParametersProvider"
overrides="true"/>
<applicationService serviceInterface="com.intellij.openapi.fileEditor.impl.EditorEmptyTextPainter"
serviceImplementation="com.jetbrains.python.edu.PyStudyInstructionPainter" overrides="true"/>
<programRunner implementation="com.jetbrains.python.edu.debugger.PyEduDebugRunner"/>
......
......@@ -13,4 +13,10 @@
</component>
</application-components>
<extensions defaultExtensionNs="com.intellij">
<applicationService serviceInterface="com.intellij.openapi.application.IdeUrlTrackingParametersProvider"
serviceImplementation="com.intellij.ide.customization.UtmIdeUrlTrackingParametersProvider"
overrides="true"/>
</extensions>
</idea-plugin>
......@@ -2,7 +2,7 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://jetbrains.org/intellij/schema/application-info http://jetbrains.org/intellij/schema/ApplicationInfo.xsd">
<version major="2017" minor="3" eap="true"/>
<company name="JetBrains s.r.o." url="https://www.jetbrains.com/?fromIDE" copyrightStart="2010"/>
<company name="JetBrains s.r.o." url="https://www.jetbrains.com" copyrightStart="2010"/>
<build number="__BUILD_NUMBER__" date="__BUILD_DATE__"/>
<logo url="/pycharm_core_logo.png" textcolor="ffffff" progressColor="fffd9a" progressX="114" progressY="278" progressHeight="3"/>
<about url="/pycharm_core_about.png" logoX="540" logoY="300" logoW="100" logoH="100" foreground="cccccc"
......
......@@ -143,6 +143,9 @@
</extensionPoints>
<extensions defaultExtensionNs="com.intellij">
<applicationService serviceInterface="com.intellij.openapi.application.IdeUrlTrackingParametersProvider"
serviceImplementation="com.intellij.ide.customization.UtmIdeUrlTrackingParametersProvider"
overrides="true"/>
<!--<expectedTypesProvider implementation="com.intellij.codeInsight.JavaExpectedTypesProvider"/>-->
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment