Introduce Animated Logo to Chrome on Android

chrome/android/java/src/org/chromium/chrome/browser/ntp/NewTabPage.java

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.chrome.browser.ntp;
 
 import android.app.Activity;
 import android.app.Dialog;
 import android.content.Context;
 import android.graphics.Bitmap;
 import android.graphics.Canvas;
 import android.graphics.Rect;
+import android.text.TextUtils;
 import android.view.ContextMenu;
 import android.view.LayoutInflater;
 import android.view.Menu;
 import android.view.MenuItem.OnMenuItemClickListener;
 import android.view.View;
 
 import org.chromium.base.ApiCompatibilityUtils;
 import org.chromium.base.VisibleForTesting;
 import org.chromium.base.metrics.RecordHistogram;
 import org.chromium.base.metrics.RecordUserAction;
@@ skipping 25 matching lines @@
 import org.chromium.chrome.browser.tab.Tab;
 import org.chromium.chrome.browser.tabmodel.TabModel.TabLaunchType;
 import org.chromium.chrome.browser.tabmodel.TabModelSelector;
 import org.chromium.chrome.browser.util.FeatureUtilities;
 import org.chromium.content_public.browser.LoadUrlParams;
 import org.chromium.ui.base.DeviceFormFactor;
 import org.chromium.ui.base.PageTransition;
 
 import java.util.concurrent.TimeUnit;
 
+import jp.tomorrowkey.android.gifplayer.BaseGifImage;
+
 /**
  * Provides functionality when the user interacts with the NTP.
  */
 public class NewTabPage
         implements NativePage, InvalidationAwareThumbnailProvider, TemplateUrlServiceObserver {
 
     // The number of times that an opt-out promo will be shown.
     private static final int MAX_OPT_OUT_PROMO_COUNT = 10;
 
     // MostVisitedItem Context menu item IDs.
@@ skipping 12 matching lines @@
     private final int mBackgroundColor;
     private final NewTabPageView mNewTabPageView;
 
     private MostVisitedSites mMostVisitedSites;
     private FaviconHelper mFaviconHelper;
     private LargeIconBridge mLargeIconBridge;
     private LogoBridge mLogoBridge;
     private boolean mSearchProviderHasLogo;
     private final boolean mOptOutPromoShown;
     private String mOnLogoClickUrl;
+    private String mGifUrl;

[newt (away), 2015/09/18 20:46:02]

Call this "mAnimatedLogoUrl". Yes, it's a gif, but that's not its most
descriptive aspect (it's sort of like naming a variable "integer". Yes, it's an
integer, *but* what's it used for?)

[Ian Wen, 2015/09/22 21:39:06]

Done.

     private FakeboxDelegate mFakeboxDelegate;
 
     // The timestamp at which the constructor was called.
     private final long mConstructedTimeNs;
 
     private boolean mIsLoaded;
 
     // Whether destroy() has been called.
     private boolean mIsDestroyed;
 
@@ skipping 245 matching lines @@
                 FaviconAvailabilityCallback callback) {
             if (mIsDestroyed) return;
             if (mFaviconHelper == null) mFaviconHelper = new FaviconHelper();
             mFaviconHelper.ensureFaviconIsAvailable(mProfile, mTab.getWebContents(), pageUrl,
                     faviconUrl, callback);
         }
 
         @Override
         public void openLogoLink() {
             if (mIsDestroyed) return;
             if (mOnLogoClickUrl == null) return;

[newt (away), 2015/09/18 20:46:02]

This check should be moved inside the if clause below. Otherwise, we'll never be
able to show animated logos if mOnLogoClickUrl is null.

[Ian Wen, 2015/09/22 21:39:06]

Done.

-            mTab.loadUrl(new LoadUrlParams(mOnLogoClickUrl, PageTransition.LINK));
+
+            if (TextUtils.isEmpty(mGifUrl) || mNewTabPageView.isGifPlaying()) {

[newt (away), 2015/09/18 20:46:02]

I'd rename this method to onLogoClicked() since it has multiple behaviors now.
I'd also add a parameter "isAnimatedLogoShowing" instead of querying
mNewTabPageView.isGifPlaying().

[Ian Wen, 2015/09/22 21:39:06]

Done.

+                mTab.loadUrl(new LoadUrlParams(mOnLogoClickUrl, PageTransition.LINK));
+            } else {
+                mLogoBridge.getGif(new LogoBridge.GifListener() {
+                    @Override
+                    public void onGifDownloaded(byte[] bytes) {

[newt (away), 2015/09/18 20:46:02]

add "if (mIsDestroyed) return;" or "assert !mIsDestroyed" is you're feeling
overly confident that this can't be called after onDestroy().

[Ian Wen, 2015/09/22 21:39:06]

Done.

+                        mNewTabPageView.updateLogoGif(new BaseGifImage(bytes));
+                    }
+                }, mGifUrl);
+            }
         }
 
         @Override
         public void getSearchProviderLogo(final LogoObserver logoObserver) {
             if (mIsDestroyed) return;
             LogoObserver wrapperCallback = new LogoObserver() {
                 @Override
                 public void onLogoAvailable(Logo logo, boolean fromCache) {
                     if (mIsDestroyed) return;
                     mOnLogoClickUrl = logo != null ? logo.onClickUrl : null;
+                    mGifUrl = logo != null ? logo.gifUrl : null;
                     logoObserver.onLogoAvailable(logo, fromCache);
                 }
             };
             mLogoBridge.getCurrentLogo(wrapperCallback);
         }
 
         @Override
         public void onLoadingComplete() {
             long loadTimeMs = (System.nanoTime() - mConstructedTimeNs) / 1000000;
             RecordHistogram.recordTimesHistogram(
@@ skipping 228 matching lines @@
         public void onBookmarkSelected(String url, String title, Bitmap favicon) {
             if (mDialog != null) mDialog.dismiss();
             mTab.loadUrl(new LoadUrlParams(url));
         }
 
         public void setDialog(Dialog dialog) {
             mDialog = dialog;
         }
     }
 }