Support for Glide 4.0 (#802)

Author: samtstern

app/build.gradle

@@ -47,6 +47,9 @@ dependencies {
     compile('com.facebook.android:facebook-android-sdk:4.25.0')
     compile("com.twitter.sdk.android:twitter-core:3.0.0@aar") { transitive = true }
 
+    compile 'com.github.bumptech.glide:glide:4.1.1'
+    annotationProcessor 'com.github.bumptech.glide:compiler:4.1.1'
+
     // The following dependencies are not required to use the Firebase UI library.
     // They are used to make some aspects of the demo app implementation simpler for
     // demonstrative purposes, and you may find them useful in your own apps; YMMV.

app/src/main/java/com/firebase/uidemo/auth/SignedInActivity.java

@@ -31,11 +31,11 @@
 import android.widget.ImageView;
 import android.widget.TextView;
 
-import com.bumptech.glide.Glide;
 import com.firebase.ui.auth.AuthUI;
 import com.firebase.ui.auth.AuthUI.IdpConfig;
 import com.firebase.ui.auth.IdpResponse;
 import com.firebase.uidemo.R;
+import com.firebase.uidemo.storage.GlideApp;
 import com.google.android.gms.tasks.OnCompleteListener;
 import com.google.android.gms.tasks.Task;
 import com.google.firebase.auth.EmailAuthProvider;
@@ -165,7 +165,7 @@ public void onComplete(@NonNull Task<Void> task) {
     private void populateProfile() {
         FirebaseUser user = FirebaseAuth.getInstance().getCurrentUser();
         if (user.getPhotoUrl() != null) {
-            Glide.with(this)
+            GlideApp.with(this)
                     .load(user.getPhotoUrl())
                     .fitCenter()
                     .into(mUserProfilePicture);

app/src/main/java/com/firebase/uidemo/storage/ImageActivity.java

@@ -13,8 +13,7 @@
 import android.widget.ImageView;
 import android.widget.Toast;
 
-import com.bumptech.glide.Glide;
-import com.firebase.ui.storage.images.FirebaseImageLoader;
+import com.bumptech.glide.load.resource.drawable.DrawableTransitionOptions;
 import com.firebase.uidemo.R;
 import com.firebase.uidemo.util.SignInResultNotifier;
 import com.google.android.gms.tasks.OnFailureListener;
@@ -131,11 +130,11 @@ public void onFailure(@NonNull Exception e) {
     @OnClick(R.id.button_download_direct)
     protected void downloadDirect() {
         // Download directly from StorageReference using Glide
-        Glide.with(this)
-                .using(new FirebaseImageLoader())
+        // (See MyAppGlideModule for Loader registration)
+        GlideApp.with(this)
                 .load(mImageRef)
                 .centerCrop()
-                .crossFade()
+                .transition(DrawableTransitionOptions.withCrossFade())
                 .into(mImageView);
     }
 

app/src/main/java/com/firebase/uidemo/storage/MyAppGlideModule.java

@@ -0,0 +1,28 @@
+package com.firebase.uidemo.storage;
+
+import android.content.Context;
+
+import com.bumptech.glide.Glide;
+import com.bumptech.glide.Registry;
+import com.bumptech.glide.annotation.GlideModule;
+import com.bumptech.glide.module.AppGlideModule;
+import com.firebase.ui.storage.images.FirebaseImageLoader;
+import com.google.firebase.storage.StorageReference;
+
+import java.io.InputStream;
+
+/**
+ * Glide module to register {@link com.firebase.ui.storage.images.FirebaseImageLoader}.
+ * See: http://bumptech.github.io/glide/doc/generatedapi.html
+ */
+@GlideModule
+public class MyAppGlideModule extends AppGlideModule {
+
+    @Override
+    public void registerComponents(Context context, Glide glide, Registry registry) {
+        // Register FirebaseImageLoader to handle StorageReference
+        registry.append(StorageReference.class, InputStream.class,
+                new FirebaseImageLoader.Factory());
+    }
+
+}

library/quality/findbugs-filter.xml

@@ -4,4 +4,16 @@
         <Class name="com.firebase.ui.database.TestUtils"/>
         <Bug pattern="RV_RETURN_VALUE_IGNORED"/>
     </Match>
-</FindBugsFilter>
+
+    <!-- Generated class from Glide annotation processing -->
+    <Match>
+        <Class name="com.firebase.uidemo.storage.GlideOptions" />
+        <Bug pattern="CN_IMPLEMENTS_CLONE_BUT_NOT_CLONEABLE" />
+    </Match>
+
+    <!-- Generated class from Glide annotation processing -->
+    <Match>
+        <Class name="com.firebase.uidemo.storage.GlideRequest" />
+        <Bug pattern="CN_IMPLEMENTS_CLONE_BUT_NOT_CLONEABLE" />
+    </Match>
+</FindBugsFilter>

storage/README.md

@@ -12,7 +12,22 @@ from a [`StorageReference`][storage-reference] and display it using the popular
 [Glide][glide] library. This technique allows you to get all of Glide's performance
 benefits while leveraging Cloud Storage's authenticated storage capabilities.
 
-To load an image from a `StorageReference`, simply use the `FirebaseImageLoader` class:
+To load an image from a `StorageReference`, first register in your `AppGlideModule`:
+
+```java
+@GlideModule
+public class MyAppGlideModule extends AppGlideModule {
+
+    @Override
+    public void registerComponents(Context context, Registry registry) {
+        // Register FirebaseImageLoader to handle StorageReference
+        registry.append(StorageReference.class, InputStream.class,
+                new FirebaseImageLoader.Factory());
+    }
+}
+```
+
+Then you can load a `StorageReference` into an `ImageView`:
 
 ```java
 // Reference to an image file in Cloud Storage
@@ -21,9 +36,9 @@ StorageReference storageReference = ...;
 // ImageView in your Activity
 ImageView imageView = ...;
 
-// Load the image using Glide
-Glide.with(this /* context */)
-        .using(new FirebaseImageLoader())
+// Download directly from StorageReference using Glide
+// (See MyAppGlideModule for Loader registration)
+GlidApp.with(this /* context */)
         .load(storageReference)
         .into(imageView);
 ```

storage/build.gradle

@@ -24,7 +24,7 @@ dependencies {
     compile "com.android.support:appcompat-v7:$supportLibraryVersion"
     compile "com.android.support:palette-v7:$supportLibraryVersion"
 
-    compile 'com.github.bumptech.glide:glide:3.7.0'
+    provided 'com.github.bumptech.glide:glide:4.1.1'
 
     compile "com.google.firebase:firebase-storage:$firebaseVersion"
 }

storage/src/main/java/com/firebase/ui/storage/images/FirebaseImageLoader.java

@@ -1,56 +1,131 @@
 package com.firebase.ui.storage.images;
 
+import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
 import android.util.Log;
 
 import com.bumptech.glide.Priority;
+import com.bumptech.glide.load.DataSource;
+import com.bumptech.glide.load.Key;
+import com.bumptech.glide.load.Options;
 import com.bumptech.glide.load.data.DataFetcher;
-import com.bumptech.glide.load.model.stream.StreamModelLoader;
-import com.google.android.gms.tasks.Tasks;
+import com.bumptech.glide.load.model.ModelLoader;
+import com.bumptech.glide.load.model.ModelLoaderFactory;
+import com.bumptech.glide.load.model.MultiModelLoaderFactory;
+import com.google.android.gms.tasks.OnFailureListener;
+import com.google.android.gms.tasks.OnSuccessListener;
 import com.google.firebase.storage.StorageReference;
 import com.google.firebase.storage.StreamDownloadTask;
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.nio.charset.Charset;
+import java.security.MessageDigest;
 
 /**
  * ModelLoader implementation to download images from FirebaseStorage with Glide.
+ *
+ * <p>
+ * First, register this class in your AppGlideModule:
+ * <pre>
+ *         {@literal @}Override
+ *         public void registerComponents(Context context, Registry registry) {
+ *             // Register FirebaseImageLoader to handle StorageReference
+ *             registry.append(StorageReference.class, InputStream.class,
+ *                     new FirebaseImageLoader.Factory());
+ *         }
+ * </pre>
+ *
  * <p>
- * Sample Usage:
+ * Then load a StorageReference into an ImageView.
  * <pre>
  *     StorageReference ref = FirebaseStorage.getInstance().getReference().child("myimage");
  *     ImageView iv = (ImageView) findViewById(R.id.my_image_view);
  *
- *     Glide.with(this)
- *         .using(new FirebaseImageLoader())
+ *     GlideApp.with(this)
  *         .load(ref)
  *         .into(iv);
  * </pre>
  */
-public class FirebaseImageLoader implements StreamModelLoader<StorageReference> {
+public class FirebaseImageLoader implements ModelLoader<StorageReference, InputStream> {
 
     private static final String TAG = "FirebaseImageLoader";
 
+
+    /**
+     * Factory to create {@link FirebaseImageLoader}.
+     */
+    public static class Factory implements ModelLoaderFactory<StorageReference, InputStream> {
+
+        @Override
+        public ModelLoader<StorageReference, InputStream> build(MultiModelLoaderFactory factory) {
+            return new FirebaseImageLoader();
+        }
+
+        @Override
+        public void teardown() {
+            // No-op
+        }
+    }
+
+    @Nullable
     @Override
-    public DataFetcher<InputStream> getResourceFetcher(StorageReference model, int width, int height) {
-        return new FirebaseStorageFetcher(model);
+    public LoadData<InputStream> buildLoadData(StorageReference reference,
+                                               int height,
+                                               int width,
+                                               Options options) {
+        return new LoadData<>(
+                new FirebaseStorageKey(reference),
+                new FirebaseStorageFetcher(reference));
     }
 
-    private class FirebaseStorageFetcher implements DataFetcher<InputStream> {
+    @Override
+    public boolean handles(StorageReference reference) {
+        return true;
+    }
+
+    private static class FirebaseStorageKey implements Key {
+
+        private StorageReference mRef;
+
+        public FirebaseStorageKey(StorageReference ref) {
+            mRef = ref;
+        }
+
+        @Override
+        public void updateDiskCacheKey(MessageDigest digest) {
+            digest.update(mRef.getPath().getBytes(Charset.defaultCharset()));
+        }
+    }
+
+    private static class FirebaseStorageFetcher implements DataFetcher<InputStream> {
 
         private StorageReference mRef;
         private StreamDownloadTask mStreamTask;
         private InputStream mInputStream;
 
-        FirebaseStorageFetcher(StorageReference ref) {
+        public FirebaseStorageFetcher(StorageReference ref) {
             mRef = ref;
         }
 
         @Override
-        public InputStream loadData(Priority priority) throws Exception {
+        public void loadData(Priority priority,
+                             final DataCallback<? super InputStream> callback) {
             mStreamTask = mRef.getStream();
-            mInputStream = Tasks.await(mStreamTask).getStream();
-
-            return mInputStream;
+            mStreamTask
+                    .addOnSuccessListener(new OnSuccessListener<StreamDownloadTask.TaskSnapshot>() {
+                        @Override
+                        public void onSuccess(StreamDownloadTask.TaskSnapshot snapshot) {
+                            mInputStream = snapshot.getStream();
+                            callback.onDataReady(mInputStream);
+                        }
+                    })
+                    .addOnFailureListener(new OnFailureListener() {
+                        @Override
+                        public void onFailure(@NonNull Exception e) {
+                            callback.onLoadFailed(e);
+                        }
+                    });
         }
 
         @Override
@@ -66,17 +141,22 @@ public void cleanup() {
             }
         }
 
-        @Override
-        public String getId() {
-            return mRef.getPath();
-        }
-
         @Override
         public void cancel() {
             // Cancel task if possible
             if (mStreamTask != null && mStreamTask.isInProgress()) {
                 mStreamTask.cancel();
             }
         }
+
+        @Override
+        public Class<InputStream> getDataClass() {
+            return InputStream.class;
+        }
+
+        @Override
+        public DataSource getDataSource() {
+            return DataSource.REMOTE;
+        }
     }
 }