miNote2/java/net/micode/notes/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";

    // 批量删除笔记的方法
    public static boolean batchDeleteNotes(ContentResolver resolver, HashSet<Long> ids) {
        // 检查传入的 id 集合是否为 null
        if (ids == null) {
            Log.d(TAG, "the ids is null");
            return true;
        }
        // 检查 id 集合是否为空
        if (ids.size() == 0) {
            Log.d(TAG, "no id is in the hashset");
            return true;
        }

        // 创建一个用于批量操作的列表
        ArrayList<ContentProviderOperation> operationList = new ArrayList<ContentProviderOperation>();
        // 遍历 id 集合
        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;
    }

    // 将单个笔记移动到指定文件夹的方法
    public static void moveNoteToFoler(ContentResolver resolver, long id, long srcFolderId, long desFolderId) {
        // 创建一个 ContentValues 对象，用于存储要更新的字段和值
        ContentValues values = new ContentValues();
        values.put(NoteColumns.PARENT_ID, desFolderId);
        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);
    }

    // 批量将笔记移动到指定文件夹的方法
    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>();
        // 遍历 id 集合
        for (long id : ids) {
            // 创建一个更新操作
            ContentProviderOperation.Builder builder = ContentProviderOperation
                    .newUpdate(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, 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, "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;
    }

    // 获取用户文件夹数量的方法，排除系统文件夹
    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;
    }

    // 检查笔记是否在数据库中可见的方法
    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;
    }

    // 检查笔记是否存在于数据库中的方法
    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;
    }

    // 检查数据是否存在于数据库中的方法
    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;
    }

    // 检查可见文件夹名称是否存在的方法
    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;
    }

    // 获取指定文件夹下的笔记小部件信息的方法
    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 对象
                        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 获取通话号码的方法
    public static String getCallNumberByNoteId(ContentResolver resolver, long noteId) {
        // 查询通话号码
        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 的方法
    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 {
                    // 获取笔记 ID
                    return cursor.getLong(0);
                } catch (IndexOutOfBoundsException e) {
                    // 处理索引越界异常
                    Log.e(TAG, "Get call note id fails " + e.toString());
                }
            }
            // 关闭游标
            cursor.close();
        }
        return 0;
    }

    // 根据笔记 ID 获取摘要的方法
    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);
    }

    // 格式化摘要的方法
    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;
    }
}