android/src/com/android/tools/idea/stats/UsageTrackerAnalyticsImpl.java

/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * Licensed 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 com.android.tools.idea.stats;

import com.android.tools.idea.startup.AndroidStudioSpecificInitializer;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
import com.intellij.ide.util.PropertiesComponent;
import com.intellij.internal.statistic.StatisticsUploadAssistant;
import com.intellij.openapi.application.ApplicationInfo;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.updateSettings.impl.UpdateChecker;
import com.intellij.openapi.util.text.StringUtil;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.NameValuePair;
import org.apache.http.StatusLine;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.utils.HttpClientUtils;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.message.BasicNameValuePair;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.io.IOException;
import java.util.List;

/**
 * An implementation of the Usage Tracker that reports to Google Analytics
 */
public class UsageTrackerAnalyticsImpl extends UsageTracker {

  private static final Logger LOG = Logger.getInstance(UsageTrackerAnalyticsImpl.class);
  @NonNls private static final String ANALYTICS_URL = "https://ssl.google-analytics.com/collect";
  @NonNls private static final String ANAYLTICS_ID = "UA-19996407-3";
  @NonNls private static final String ANALYTICS_APP = "Android Studio";

  private static final List<? extends NameValuePair> analyticsBaseData = ImmutableList
    .of(new BasicNameValuePair("v", "1"),
        new BasicNameValuePair("tid", ANAYLTICS_ID),
        new BasicNameValuePair("t", "event"),
        new BasicNameValuePair("an", ANALYTICS_APP),
        new BasicNameValuePair("av", ApplicationInfo.getInstance().getFullVersion()),
        new BasicNameValuePair("cid", UpdateChecker.getInstallationUID(PropertiesComponent.getInstance())));

  /**
   * Track an event with Analytics, only works with Android Studio
   * Do NOT track any information that can identify the user
   */
  @Override
  public void trackEvent(@NotNull String eventCategory,
                         @NotNull String eventAction,
                         @Nullable String eventLabel,
                         @Nullable Integer eventValue) {

    if (ApplicationManager.getApplication().isUnitTestMode()) {
      return;
    }

    if (!AndroidStudioSpecificInitializer.isAndroidStudio()) {
      return;
    }

    if (!StatisticsUploadAssistant.isSendAllowed()) {
      return;
    }

    List<NameValuePair> postData = Lists.newArrayList(analyticsBaseData);

    postData.add(new BasicNameValuePair("ec", eventCategory));
    postData.add(new BasicNameValuePair("ea", eventAction));
    if(!StringUtil.isEmpty(eventLabel)) {
      postData.add(new BasicNameValuePair("el", eventLabel));
    }
    if(eventValue != null) {
      if(eventValue < 0) {
        LOG.debug("Attempting to send negative event value to the analytics server");
      }
      postData.add(new BasicNameValuePair("ev", eventValue.toString()));
    }
    sendPing(postData);
  }

  /**
   * Send a ping to Analytics on a separate thread
   */
  private static void sendPing(@NotNull final List<? extends NameValuePair> postData) {
    ApplicationManager.getApplication().executeOnPooledThread(new Runnable() {
      @Override
      public void run() {
        CloseableHttpClient client = HttpClientBuilder.create().build();
        HttpPost request = new HttpPost(ANALYTICS_URL);
        try {
          request.setEntity(new UrlEncodedFormEntity(postData));
          HttpResponse response = client.execute(request);
          StatusLine status = response.getStatusLine();
          HttpEntity entity = response.getEntity(); // throw it away, don't care, not sure if we need to read in the response?
          if (status.getStatusCode() >= 300) {
            LOG.debug("Non 200 status code : " + status.getStatusCode() + " - " + status.getReasonPhrase());
            // something went wrong, fail quietly, we probably have to diagnose analytics errors on our side
            // usually analytics accepts ANY request and always returns 200
          }
        }
        catch (IOException e) {
          LOG.debug("IOException during Analytics Ping", e.getMessage());
          // something went wrong, fail quietly
        }
        finally {
          HttpClientUtils.closeQuietly(client);
        }
      }
    });
  }
}