FileAttachment.java

浏览该文件的文档.

package com.netease.nimlib.sdk.msg.attachment;

import android.net.Uri;
import android.text.TextUtils;
import com.netease.nimlib.NimNosSceneKeyConstant;
import com.netease.nimlib.log.NimLog;
import com.netease.nimlib.sdk.util.UriUtils;
import com.netease.nimlib.util.JSONHelper;
import com.netease.nimlib.util.MD5;
import com.netease.nimlib.util.StringUtil;
import com.netease.nimlib.util.storage.NimStorageType;
import com.netease.nimlib.util.storage.NimStorageUtil;
import java.io.File;
import org.json.JSONObject;

/**
 * 带有文件的附件类型的基类
 * 描述文件的相关信息
 */
public class FileAttachment implements MsgAttachment {

    private static final String TAG = "FileAttachment";
    public static final String KEY_DOT = ".";

    /**
     * 文件路径
     */
    protected String path;

    /**
     * 文件大小
     */
    protected long size;

    /**
     * 文件内容的MD5
     */
    protected String md5;

    /**
     * 文件下载地址
     */
    protected String url;

    /**
     * 文件显示名
     */
    protected String displayName;

    /**
     * 文件后缀名
     */
    protected String extension;

    /**
     * 过期时间（仅对文件类型有效）
     */
    private long expire;

    /**
     * 上传文件时用的对token对应的场景，默认{@link NimNosSceneKeyConstant#NIM_DEFAULT_IM}
     */
    protected String nosTokenSceneKey = NimNosSceneKeyConstant.NIM_DEFAULT_IM;

    /**
     * 如果服务器存在相同的附件文件，是否强制重新上传 ， 默认false
     */
    protected boolean forceUpload = false;
    /**
     * 是否是uri
     */
    private   boolean     isUri         = false;

    public FileAttachment() {

    }

    public FileAttachment(String attach) {
        fromJson(attach);
    }

    /**
     * 获取文件本地路径，若文件不存在，返回null
     *
     * @return 文件路径
     */
    public String getPath() {
        try {
            String path = getPathForSave();
            if(TextUtils.isEmpty(path)){
                return null;
            }
            return new File(path).exists() ? path : null;
        }
        catch (Throwable e) {
        NimLog.e(TAG, "getPath exception", e);
            return null;
        }
    }

    /**
     * 获取用于保存该文件的位置
     *
     * @return 文件路径
     */
    public String getPathForSave() {
        if (!isUri && !TextUtils.isEmpty(path)) {
            return path;
        } else {
            return NimStorageUtil.getWritePath(getFileName(), storageType());
        }
    }

    /**
     * 获取缩略图文件的本地路径，若文件不存在，返回null
     *
     * @return 文件路径
     */
    public String getThumbPath() {
        String path = getThumbPathForSave();
        return new File(path).exists() ? path : null;
    }

    /**
     * 获取用于保存缩略图文件的位置
     *
     * @return 文件路径
     */
    public String getThumbPathForSave() {
        String fileName = getFileName();
        if (!TextUtils.isEmpty(fileName)) {
            int dotIndex = fileName.lastIndexOf(".");
            // 如果找到了 '.' 而且最后一个字符不是 '.'，则需要进行裁剪
            if (dotIndex >= 0 && dotIndex < fileName.length() - 1) {
                fileName = fileName.substring(0, dotIndex);
            }
        }
        return NimStorageUtil.getWritePath(fileName, NimStorageType.TYPE_THUMB_IMAGE);
    }

    /**
     * 设置文件路径
     *
     * @param path 文件路径
     */
    public void setPath(String path) {
        this.path = path;
        this.isUri = UriUtils.isFileOrContentUri(path);
    }

    /**
     * 设置文件uri，
     * 仅支持ContentResolver.SCHEME_FILE类型和ContentResolver.SCHEME_CONTENT类型的uri
     * 仅支持发送消息时使用，接收的消息附件不支持uri
     * @param uri
     * @return false表示不支持的uri
     */
    public boolean setUri(Uri uri) {
        if(uri == null)
        {
            return false;
        }

        if(!UriUtils.isFileOrContentUri(uri))
        {
            return false;
        }
        isUri = true;
        this.path = uri.toString();
        return true;
    }

    public Uri getUri() {
        if(!isUri)
        {
            return null;
        }
        return UriUtils.string2Uri(path);
    }



    /**
     * 获取文件大小，单位为byte
     *
     * @return 文件大小
     */
    public long getSize() {
        return size;
    }

    /**
     * 设置文件大小，单位为byte
     *
     * @param size 文件大小
     */
    public void setSize(long size) {
        this.size = size;
    }

    /**
     * 获取文件内容MD5
     *
     * @return 内容MD5
     */
    public String getMd5() {
        return md5;
    }

    /**
     * 设置文件内容MD5
     *
     * @param md5 内容MD5
     */
    public void setMd5(String md5) {
        this.md5 = md5;
    }

    /**
     * 获取文件在服务器上的下载url。若文件还未上传，返回null
     *
     * @return 源站url
     */
    public String getUrl() {
        return url;
    }

    /**
     * 设置文件在服务器上的下载url
     *
     * @param url
     */
    public void setUrl(String url) {
        this.url = url;
    }

    /**
     * 获取文件后缀名
     *
     * @return 后缀名
     */
    public String getExtension() {
        return extension;
    }

    /**
     * 设置文件后缀名
     *
     * @param extension 后缀名
     */
    public void setExtension(String extension) {
        this.extension = extension;
    }

    /**
     * 获取文件名。
     *
     * @return
     */
    public String getFileName() {
        if(isUri)
        {
            if (TextUtils.isEmpty(md5)) {
                if (TextUtils.isEmpty(url)) {
                    return MD5.getStringMD5(path);
                }
                return MD5.getStringMD5(url);
            } else {
                return md5;
            }
        }
        else if (!TextUtils.isEmpty(path)) {
            return StringUtil.nameOfPath(path);
        } else {
            if (TextUtils.isEmpty(md5)) {
                return MD5.getStringMD5(url);
            } else {
                return md5;
            }
        }
    }

    /**
     * 获取文件的显示名。可以和文件名不同，仅用于界面展示
     *
     * @return 文件显示名
     */
    public String getDisplayName() {
        return displayName;
    }

    /**
     * 设置文件显示名
     *
     * @param displayName 文件显示名
     */
    public void setDisplayName(String displayName) {
        this.displayName = displayName;
    }


    /**
     * 获取文件上传时的nos scene
     *
     * @return nos scene
     */
    public String getNosTokenSceneKey() {
        return nosTokenSceneKey;
    }

    /**
     * 设置文件上传时的nos scene
     *
     * @param nosTokenSceneKey
     */
    public void setNosTokenSceneKey(String nosTokenSceneKey) {
        if (TextUtils.isEmpty(nosTokenSceneKey)) {
            return;
        }
        this.nosTokenSceneKey = nosTokenSceneKey;
    }

    public long getExpire() {
        return expire;
    }

    /**
     * 文件是否强制重新上传
     *
     * @return force upload
     */
    public boolean isForceUpload() {
        return forceUpload;
    }

    /**
     * 设置文件是否强制重新上传，默认false
     *
     * @param forceUpload 是否强制重新上传
     */
    public void setForceUpload(boolean forceUpload) {
        this.forceUpload = forceUpload;
    }

    protected NimStorageType storageType() {
        return NimStorageType.TYPE_FILE;
    }

    protected void save(JSONObject json) {

    }

    protected void load(JSONObject json) {

    }

    public static final String KEY_PATH = "path";
    public static final String KEY_NAME = "name";
    public static final String KEY_SIZE = "size";
    public static final String KEY_MD5 = "md5";
    public static final String KEY_URL = "url";
    public static final String KEY_EXT = "ext";
    public static final String KEY_SCENE = "sen";
    public static final String KEY_FORCE_UPLOAD = "force_upload";
    public static final String KEY_EXPIRE = "expire";

    public static final String KEY_V2_INTERNAL_UPLOAD_STATE = "KEY_V2_INTERNAL_UPLOAD_STATE";

    @Override
    public String toJson(boolean send) {
        JSONObject object = new JSONObject();
        try {
            if (!send && !TextUtils.isEmpty(path)) {
                object.put(KEY_PATH, path);
            }

            if (!TextUtils.isEmpty(md5)) {
                object.put(KEY_MD5, md5);
            }

            if (!TextUtils.isEmpty(displayName)) {
                object.put(KEY_NAME, displayName);
            }

            object.put(KEY_URL, url);
            object.put(KEY_SIZE, size);


            if (!TextUtils.isEmpty(extension)) {
                object.put(KEY_EXT, extension);
            }
            if (!TextUtils.isEmpty(nosTokenSceneKey)) {
                object.put(KEY_SCENE, nosTokenSceneKey);
            }

            if (expire > 0) {
                object.put(KEY_EXPIRE, expire);
            }

            object.put(KEY_FORCE_UPLOAD, forceUpload);
            save(object);

        } catch (Exception e) {
            e.printStackTrace();
        }

        return object.toString();
    }

    private void fromJson(String attach) {
        JSONObject json = JSONHelper.parse(attach);
        if(json == null)
        {
            return;
        }
        path = JSONHelper.getString(json, KEY_PATH);
        Uri uri = UriUtils.string2Uri(path);
        if(UriUtils.isFileOrContentUri(uri))
        {
            isUri = true;
        }
        md5 = JSONHelper.getString(json, KEY_MD5);
        url = JSONHelper.getString(json, KEY_URL);
        displayName = JSONHelper.getString(json, KEY_NAME);
        size = JSONHelper.getLong(json, KEY_SIZE);
        extension = JSONHelper.getString(json, KEY_EXT);
        if(extension != null && extension.startsWith(KEY_DOT))
        {
            extension = extension.substring(1);
        }
        setNosTokenSceneKey(JSONHelper.getString(json, KEY_SCENE));
        forceUpload = JSONHelper.getBoolean(json, KEY_FORCE_UPLOAD);
        expire = JSONHelper.getLong(json, KEY_EXPIRE);
        load(json);
    }
}