xiaomi/tool/DataUtils.java

/*
 * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
 *
 * 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 net.micode.notes.tool;

import android.content.ContentProviderOperation;
import android.content.ContentProviderResult;
import android.content.ContentResolver;
import android.content.ContentUris;
import android.content.ContentValues;
import android.content.OperationApplicationException;
import android.database.Cursor;
import android.os.RemoteException;
import android.util.Log;

import net.micode.notes.data.Notes;
import net.micode.notes.data.Notes.CallNote;
import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute;

import java.util.ArrayList;
import java.util.HashSet;

public class DataUtils {
    public static final String TAG = "DataUtils";

    /**
     * 批量删除笔记。
     *
     * @param resolver ContentResolver实例，用于执行删除操作。
     * @param ids 要删除的笔记ID集合。
     * @return 如果成功删除所有笔记返回true，否则返回false。
     */
    public static boolean batchDeleteNotes(ContentResolver resolver, HashSet<Long> ids) {
        // 检查传入的ID集合是否为null或为空
        if (ids == null || ids.size() == 0) {
            Log.d(TAG, "the ids is null or empty");
            return true;
        }

        // 创建操作列表
        ArrayList<ContentProviderOperation> operationList = new ArrayList<ContentProviderOperation>();
        for (long id : ids) {
            // 不允许删除系统文件夹根目录
            if (id == Notes.ID_ROOT_FOLDER) {
                Log.e(TAG, "Don't delete system folder root");
                continue;
            }
            // 构建删除操作
            ContentProviderOperation.Builder builder = ContentProviderOperation
                    .newDelete(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id));
            operationList.add(builder.build());
        }

        try {
            // 执行批量操作
            ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList);
            // 检查操作是否成功
            if (results == null || results.length == 0 || results[0] == null) {
                Log.d(TAG, "delete notes failed, ids:" + ids.toString());
                return false;
            }
            return true;
        } catch (RemoteException e) {
            Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));
        } catch (OperationApplicationException e) {
            Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));
        }
        return false;
    }

    /**
     * 将笔记移动到指定文件夹。
     *
     * @param resolver ContentResolver实例，用于执行更新操作。
     * @param id 要移动的笔记ID。
     * @param srcFolderId 笔记当前所在文件夹ID。
     * @param desFolderId 笔记要移动到的目标文件夹ID。
     */
    public static void moveNoteToFoler(ContentResolver resolver, long id, long srcFolderId, long desFolderId) {
        // 创建更新操作的值集
        ContentValues values = new ContentValues();
        // 设置新的父文件夹ID
        values.put(NoteColumns.PARENT_ID, desFolderId);
        // 记录原始父文件夹ID
        values.put(NoteColumns.ORIGIN_PARENT_ID, srcFolderId);
        // 标记笔记为已修改
        values.put(NoteColumns.LOCAL_MODIFIED, 1);
        // 执行更新操作
        resolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id), values, null, null);
    }

    /**
     * 批量将笔记移动到指定文件夹。
     *
     * @param resolver ContentResolver实例，用于执行批量更新操作。
     * @param ids 要移动的笔记ID集合。
     * @param folderId 目标文件夹ID。
     * @return 如果成功移动所有笔记返回true，否则返回false。
     */
    public static boolean batchMoveToFolder(ContentResolver resolver, HashSet<Long> ids, long folderId) {
        // 检查传入的ID集合是否为null
        if (ids == null) {
            Log.d(TAG, "the ids is null");
            return true;
        }

        // 创建操作列表
        ArrayList<ContentProviderOperation> operationList = new ArrayList<ContentProviderOperation>();
        for (long id : ids) {
            // 构建更新操作
            ContentProviderOperation.Builder builder = ContentProviderOperation
                    .newUpdate(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id));
            // 设置新的父文件夹ID
            builder.withValue(NoteColumns.PARENT_ID, folderId);
            // 标记笔记为已修改
            builder.withValue(NoteColumns.LOCAL_MODIFIED, 1);
            operationList.add(builder.build());
        }

        try {
            // 执行批量操作
            ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList);
            // 检查操作是否成功
            if (results == null || results.length == 0 || results[0] == null) {
                Log.d(TAG, "move notes failed, ids:" + ids.toString());
                return false;
            }
            return true;
        } catch (RemoteException e) {
            Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));
        } catch (OperationApplicationException e) {
            Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));
        }
        return false;
    }

    /**
     * 获取用户文件夹数量（排除系统文件夹）。
     *
     * @param resolver ContentResolver实例，用于执行查询操作。
     * @return 用户文件夹的数量。
     */
    public static int getUserFolderCount(ContentResolver resolver) {
        // 执行查询操作，计算非系统文件夹的数量
        Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI,
                new String[] { "COUNT(*)" },
                NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>?",
                new String[] { String.valueOf(Notes.TYPE_FOLDER), String.valueOf(Notes.ID_TRASH_FOLER)},
                null);

        int count = 0;
        if (cursor != null) {
            if (cursor.moveToFirst()) {
                try {
                    count = cursor.getInt(0);
                } catch (IndexOutOfBoundsException e) {
                    Log.e(TAG, "get folder count failed:" + e.toString());
                } finally {
                    cursor.close();
                }
            }
        }
        return count;
    }

    /**
     * 检查指定类型的笔记是否在笔记数据库中可见。
     *
     * @param resolver ContentResolver实例，用于执行查询操作。
     * @param noteId 笔记ID。
     * @param type 笔记类型。
     * @return 如果笔记存在且可见返回true，否则返回false。
     */
    public static boolean visibleInNoteDatabase(ContentResolver resolver, long noteId, int type) {
        // 执行查询操作，检查指定类型的笔记是否存在且不在回收站中
        Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId),
                null,
                NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER,
                new String [] {String.valueOf(type)},
                null);

        boolean exist = false;
        if (cursor != null) {
            if (cursor.getCount() > 0) {
                exist = true;
            }
            cursor.close();
        }
        return exist;
    }

    /**
     * 检查笔记是否存在于笔记数据库中。
     *
     * @param resolver ContentResolver实例，用于执行查询操作。
     * @param noteId 笔记ID。
     * @return 如果笔记存在返回true，否则返回false。
     */
    public static boolean existInNoteDatabase(ContentResolver resolver, long noteId) {
        // 执行查询操作，检查笔记是否存在
        Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId),
                null, null, null, null);

        boolean exist = false;
        if (cursor != null) {
            if (cursor.getCount() > 0) {
                exist = true;
            }
            cursor.close();
        }
        return exist;
    }

    /**
     * 检查数据是否存在于数据数据库中。
     *
     * @param resolver ContentResolver实例，用于执行查询操作。
     * @param dataId 数据ID。
     * @return 如果数据存在返回true，否则返回false。
     */
    public static boolean existInDataDatabase(ContentResolver resolver, long dataId) {
        // 执行查询操作，检查数据是否存在
        Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId),
                null, null, null, null);

        boolean exist = false;
        if (cursor != null) {
            if (cursor.getCount() > 0) {
                exist = true;
            }
            cursor.close();
        }
        return exist;
    }

    /**
     * 检查文件夹名称是否在笔记数据库中可见。
     *
     * @param resolver ContentResolver实例，用于执行查询操作。
     * @param name 文件夹名称。
     * @return 如果文件夹名称存在返回true，否则返回false。
     */
    public static boolean checkVisibleFolderName(ContentResolver resolver, String name) {
        // 执行查询操作，检查文件夹名称是否存在于非回收站的文件夹中
        Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, null,
                NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER +
                        " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER +
                        " AND " + NoteColumns.SNIPPET + "=?",
                new String[] { name }, null);
        boolean exist = false;
        if (cursor != null) {
            if (cursor.getCount() > 0) {
                exist = true;
            }
            cursor.close();
        }
        return exist;
    }

    /**
     * 获取指定文件夹中所有笔记的小部件属性。
     *
     * @param resolver ContentResolver实例，用于执行查询操作。
     * @param folderId 文件夹ID。
     * @return 包含小部件属性的HashSet。
     */
    public static HashSet<AppWidgetAttribute> getFolderNoteWidget(ContentResolver resolver, long folderId) {
        // 执行查询操作，获取文件夹中笔记的小部件属性
        Cursor c = resolver.query(Notes.CONTENT_NOTE_URI,
                new String[] { NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE },
                NoteColumns.PARENT_ID + "=?",
                new String[] { String.valueOf(folderId) },
                null);

        HashSet<AppWidgetAttribute> set = null;
        if (c != null) {
            if (c.moveToFirst()) {
                set = new HashSet<AppWidgetAttribute>();
                do {
                    try {
                        AppWidgetAttribute widget = new AppWidgetAttribute();
                        widget.widgetId = c.getInt(0);
                        widget.widgetType = c.getInt(1);
                        set.add(widget);
                    } catch (IndexOutOfBoundsException e) {
                        Log.e(TAG, e.toString());
                    }
                } while (c.moveToNext());
            }
            c.close();
        }
        return set;
    }

    /**
     * 通过笔记ID获取电话号码。
     *
     * @param resolver ContentResolver实例，用于执行查询操作。
     * @param noteId 笔记ID。
     * @return 电话号码字符串。
     */
    public static String getCallNumberByNoteId(ContentResolver resolver, long noteId) {
        // 执行查询操作，获取与笔记ID关联的电话号码
        Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI,
                new String [] { CallNote.PHONE_NUMBER },
                CallNote.NOTE_ID + "=? AND " + CallNote.MIME_TYPE + "=?",
                new String [] { String.valueOf(noteId), CallNote.CONTENT_ITEM_TYPE },
                null);

        if (cursor != null && cursor.moveToFirst()) {
            try {
                return cursor.getString(0);
            } catch (IndexOutOfBoundsException e) {
                Log.e(TAG, "Get call number fails " + e.toString());
            } finally {
                cursor.close();
            }
        }
        return "";
    }

    /**
     * 通过电话号码和通话日期获取笔记ID。
     *
     * @param resolver ContentResolver实例，用于执行查询操作。
     * @param phoneNumber 电话号码。
     * @param callDate 通话日期。
     * @return 笔记ID。
     */
    public static long getNoteIdByPhoneNumberAndCallDate(ContentResolver resolver, String phoneNumber, long callDate) {
        // 执行查询操作，获取与电话号码和通话日期关联的笔记ID
        Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI,
                new String [] { CallNote.NOTE_ID },
                CallNote.CALL_DATE + "=? AND " + CallNote.MIME_TYPE + "=? AND PHONE_NUMBERS_EQUAL(" + CallNote.PHONE_NUMBER + ",?)",
                new String [] { String.valueOf(callDate), CallNote.CONTENT_ITEM_TYPE, phoneNumber },
                null);

        if (cursor != null) {
            if (cursor.moveToFirst()) {
                try {
                    return cursor.getLong(0);
                } catch (IndexOutOfBoundsException e) {
                    Log.e(TAG, "Get call note id fails " + e.toString());
                }
            }
            cursor.close();
        }
        return 0;
    }

    /**
     * 通过笔记ID获取笔记摘要。
     *
     * @param resolver ContentResolver实例，用于执行查询操作。
     * @param noteId 笔记ID。
     * @return 笔记摘要字符串。
     */
    public static String getSnippetById(ContentResolver resolver, long noteId) {
        // 执行查询操作，获取笔记摘要
        Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI,
                new String [] { NoteColumns.SNIPPET },
                NoteColumns.ID + "=?",
                new String [] { String.valueOf(noteId)},
                null);

        if (cursor != null) {
            String snippet = "";
            if (cursor.moveToFirst()) {
                snippet = cursor.getString(0);
            }
            cursor.close();
            return snippet;
        }
        throw new IllegalArgumentException("Note is not found with id: " + noteId);
    }

    /**
     * 格式化笔记摘要。
     *
     * @param snippet 笔记摘要。
     * @return 格式化后的笔记摘要。
     */
    public static String getFormattedSnippet(String snippet) {
        // 去除摘要两端的空白字符，并去除换行符
        if (snippet != null) {
            snippet = snippet.trim();
            int index = snippet.indexOf('\n');
            if (index != -1) {
                snippet = snippet.substring(0, index);
            }
        }
        return snippet;
    }
}