EhViewer/app/src/main/java/com/hippo/conaco/Conaco.java

/*
 * Copyright 2015-2016 Hippo Seven
 *
 * 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.hippo.conaco;

import android.os.Process;
import android.util.Log;

import androidx.annotation.IntDef;
import androidx.annotation.UiThread;

import com.hippo.beerbelly.BeerBelly;
import com.hippo.yorozuya.thread.PriorityThreadFactory;
import com.hippo.yorozuya.thread.SerialThreadExecutor;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.LinkedList;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;

import okhttp3.OkHttpClient;

@SuppressWarnings("rawtypes")
public final class Conaco<V> {

    public static final int SOURCE_MEMORY = 0;
    public static final int SOURCE_DISK = 1;
    public static final int SOURCE_NETWORK = 2;
    private static final String TAG = Conaco.class.getSimpleName();
    private final ValueHelper<V> mHelper;
    private final ValueCache<V> mCache;
    private final OkHttpClient mOkHttpClient;
    private final Register<V> mRegister;
    private final SerialThreadExecutor mDiskExecutor;
    private final ThreadPoolExecutor mNetworkExecutor;
    private final AtomicInteger mIdGenerator;
    private final boolean mDebug;

    private Conaco(Builder<V> builder) {
        mHelper = builder.objectHelper;

        BeerBelly.BeerBellyParams beerBellyParams = new BeerBelly.BeerBellyParams();
        beerBellyParams.hasMemoryCache = builder.hasMemoryCache;
        beerBellyParams.memoryCacheMaxSize = builder.memoryCacheMaxSize;
        beerBellyParams.hasDiskCache = builder.hasDiskCache;
        beerBellyParams.diskCacheDir = builder.diskCacheDir;
        beerBellyParams.diskCacheMaxSize = builder.diskCacheMaxSize;

        mCache = new ValueCache<>(beerBellyParams, mHelper);
        mOkHttpClient = builder.okHttpClient;

        mRegister = new Register<>();

        mDiskExecutor = new SerialThreadExecutor(3000L, new LinkedList<>(),
                new PriorityThreadFactory("Conaco-Disk", Process.THREAD_PRIORITY_BACKGROUND));
        mNetworkExecutor = new ThreadPoolExecutor(3, 3, 5L, TimeUnit.SECONDS,
                new LinkedBlockingQueue<>(),
                new PriorityThreadFactory("Conaco-Network", Process.THREAD_PRIORITY_BACKGROUND));

        mIdGenerator = new AtomicInteger();

        mDebug = builder.debug;
    }

    public BeerBelly getBeerBelly() {
        return mCache;
    }

    private void onUnregisterConacoTask(ConacoTask<V> task) {
        ConacoTask<V> next = mRegister.getByKey(task.getKey());
        if (next != null) {
            startConacoTask(next);
        }
    }

    private void startConacoTask(ConacoTask<V> task) {
        Unikery<V> unikery = task.getUnikery();

        // Can't unikery is gone, finish the task now
        if (unikery == null) {
            finishConacoTask(task);
            return;
        }

        String key = task.getKey();
        V value = null;

        // Get from memory
        if (key != null && task.useMemoryCache() && mHelper.useMemoryCache(key, null)) {
            value = mCache.getFromMemory(key);
        }

        if (value == null || !unikery.onGetValue(value, SOURCE_MEMORY)) {
            unikery.onMiss(SOURCE_MEMORY);
            task.start();
        } else {
            // Get the object, finish the task
            finishConacoTask(task);
        }
    }

    @UiThread
    public void load(ConacoTask.Builder<V> builder) {
        builder.isValid();

        if (mDebug) {
            Log.d(TAG, "Key " + builder.getKey());
            Log.d(TAG, "Url " + builder.getUrl());
        }

        Unikery<V> unikery = builder.getUnikery();

        // Cancel first
        cancel(unikery);

        // Build conaco task
        int id;
        //noinspection StatementWithEmptyBody
        while ((id = mIdGenerator.getAndIncrement()) == Unikery.INVALID_ID) ;
        unikery.setTaskId(id);
        builder.setId(id)
                .setHelper(mHelper)
                .setCache(mCache)
                .setOkHttpClient(mOkHttpClient)
                .setDiskExecutor(mDiskExecutor)
                .setNetworkExecutor(mNetworkExecutor)
                .setConaco(this);
        ConacoTask<V> task = builder.build();

        if (!mRegister.register(id, task)) {
            startConacoTask(task);
        } else {
            // The key is repeated, wait
            unikery.onWait();
        }
    }

    @UiThread
    public void cancel(Unikery<V> unikery) {
        int id = unikery.getTaskId();
        if (id != Unikery.INVALID_ID) {
            unikery.setTaskId(Unikery.INVALID_ID);
            ConacoTask<V> task = mRegister.unregister(id);
            if (task != null) {
                task.stop();
                // Don't need unikery anymore
                task.clearUnikery();
                // Callback
                onUnregisterConacoTask(task);
            } else {
                Log.e(TAG, "Can't find conaco task by id " + id);
            }
        }
    }

    public boolean isLoading(Unikery<V> unikery) {
        int id = unikery.getTaskId();
        return id != Unikery.INVALID_ID && mRegister.contain(id);
    }

    /**
     * Unregister task, reset unikery id, clear unikery in task, call next
     */
    void finishConacoTask(ConacoTask<V> task) {
        mRegister.unregister(task.getId());
        Unikery unikery = task.getUnikery();
        if (unikery != null) {
            unikery.setTaskId(Unikery.INVALID_ID);
        }
        task.clearUnikery();

        onUnregisterConacoTask(task);
    }

    @IntDef({SOURCE_MEMORY, SOURCE_DISK, SOURCE_NETWORK})
    @Retention(RetentionPolicy.SOURCE)
    public @interface Source {
    }

    public static class Builder<T> extends BeerBelly.BeerBellyParams {
        /**
         * The client to get image from internet
         */
        public OkHttpClient okHttpClient = null;

        /**
         * Decode, get size and others
         */
        public ValueHelper<T> objectHelper = null;

        public boolean debug = false;

        @Override
        public void isValid() throws IllegalStateException {
            super.isValid();

            if (okHttpClient == null) {
                throw new IllegalStateException("No http client? How can I load image via url?");
            }
        }

        public Conaco<T> build() {
            isValid();
            return new Conaco<>(this);
        }
    }
}