/*
 * 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.model;
import android.content.ContentProviderOperation;//批量的更新、插入、删除数据。
import android.content.ContentProviderResult;//操作的结果
import android.content.ContentUris;//用于添加和获取Uri后面的ID
import android.content.ContentValues;//一种用来存储基本数据类型数据的存储机制
import android.content.Context;//需要用该类来弄清楚调用者的实例
import android.content.OperationApplicationException;//操作应用程序容错
import android.net.Uri;//表示待操作的数据
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.DataColumns;
import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.data.Notes.TextNote;

import java.util.ArrayList;


public class Note {//单个便签项
    private ContentValues mNoteDiffValues;
    //ContentValues 是Android SQLite库提供的一个类，用于存储键值对。在SQLite中，通常使用ContentValues来构建要插入到数据库中的行或用于更新现有行的数据。它基本上是一个HashMap，其中键是字符串（代表列名），值是对应要插入或更新的数据。
    private NoteData mNoteData;//见下方自定义的NoteData类，用于记录便签内容
    private static final String TAG = "Note";//定义一个初始化后不可改变的静态变量作为数据库的标记
    /**
     * Create a new note id for adding a new note to databases
     */
    public static synchronized long getNewNoteId(Context context, long folderId) {
        // Create a new note in the database
        ContentValues values = new ContentValues();
        long createdTime = System.currentTimeMillis();//获取时间
        values.put(NoteColumns.CREATED_DATE, createdTime);//设置创建日期
        values.put(NoteColumns.MODIFIED_DATE, createdTime);//设置修改日期
        values.put(NoteColumns.TYPE, Notes.TYPE_NOTE);//类型
        values.put(NoteColumns.LOCAL_MODIFIED, 1);//通常用于存储与该记录相关的最后修改时间戳。这个时间戳通常是用来跟踪记录的版本或最后一次修改的时间，这样开发者就可以知道哪些记录是最新的，或者在数据同步时决定哪些记录需要更新。
        values.put(NoteColumns.PARENT_ID, folderId);//设置ID
        Uri uri = context.getContentResolver().insert(Notes.CONTENT_NOTE_URI, values);
        //Uri（统一资源标识符）在Android中用于标识内容提供者中的数据
        //将内容提供者对象中的数据插入到由uri指定的位置。

        long noteId = 0;
        try {
            noteId = Long.valueOf(uri.getPathSegments().get(1));
        } catch (NumberFormatException e) {
            Log.e(TAG, "Get note id error :" + e.toString());
            noteId = 0;
        }//验证noteID是否正确
        /*
         * try-catch异常处理，在此块中的代码可能会引发异常，并且该异常将被捕获并处理
         * uri.getPathSegments()：从uri对象中获取路径段的列表。URI的路径部分通常包含多个由斜杠(/)分隔的段
         * get(1)：从路径段的列表中获取第二个元素（索引从0开始）
         * Long.valueOf(...)：尝试将获取到的字符串转换为Long对象。
         * 将转换得到的Long对象赋值给noteId变量。
         * catch (NumberFormatException e) 如果在try块中的代码引发NumberFormatException异常（例如，当尝试将非数字字符串转换为数字时），则执行此catch块。
         * Log.e(TAG, "Get note id error :" + e.toString())使用Android的日志系统记录一个错误消息。TAG是一个常量，通常用于标识日志消息的来源。e.toString()将异常的详细信息转换为字符串，并附加到错误消息中
         *将noteId设置为0，表示未能从URI获取有效的笔记ID。
         */
        if (noteId == -1) {
            throw new IllegalStateException("Wrong note id:" + noteId);
        }//如果验证失败抛出异常
        return noteId;
    }

    public Note() {
        mNoteDiffValues = new ContentValues();
        mNoteData = new NoteData();
    }//构造函数

    public void setNoteValue(String key, String value) {
        mNoteDiffValues.put(key, value);
        mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
        mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
    }//设置数据库表格的标签属性数据

    public void setTextData(String key, String value) {
        mNoteData.setTextData(key, value);
    }//设置数据库表格的标签文本内容的数据

    public void setTextDataId(long id) {
        mNoteData.setTextDataId(id);
    }//设置文本数据的ID

    public long getTextDataId() {
        return mNoteData.mTextDataId;
    }//设置电话号码数据的ID

    public void setCallDataId(long id) {
        mNoteData.setCallDataId(id);
    }//得到电话号码数据的ID

    public void setCallData(String key, String value) {
        mNoteData.setCallData(key, value);
    }

    public boolean isLocalModified() {
        return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified();
    }//判断是否是本地修改

    public boolean syncNote(Context context, long noteId) {//同步
        if (noteId <= 0) {
            throw new IllegalArgumentException("Wrong note id:" + noteId);
        }

        if (!isLocalModified()) {
            return true;
        }//没修改不需要同步

        /*
         * In theory, once data changed, the note should be updated on {@link NoteColumns#LOCAL_MODIFIED} and
         * {@link NoteColumns#MODIFIED_DATE}. For data safety, though update note fails, we also update thenote data info
         * 从理论上讲，当数据发生变化时，应该在LOCAL_MODIFIED和MODIFIED_DATE两个字段上更新笔记。但是，为了数据安全，即使更新笔记的操作失败，我们仍然会更新笔记的数据信息。
         */
        if (context.getContentResolver().update(
                ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), mNoteDiffValues, null,
                null) == 0) {
            Log.e(TAG, "Update note error, should not happen");
            // Do not return, fall through
        }//如果笔记更新失败记录日志
        mNoteDiffValues.clear();//清除数据库标签属性中的所有内容

        if (mNoteData.isLocalModified()
                && (mNoteData.pushIntoContentResolver(context, noteId) == null)) {
            return false;
        }//如果笔记内容在本地被修改，把笔记内容推送到内容解析器，如果失败则返回false

        return true;
    }

    private class NoteData {//定义一个基本的便签内容的数据类，主要包含文本数据和电话号码数据
        private long mTextDataId;

        private ContentValues mTextDataValues;//文本数据

        private long mCallDataId;

        private ContentValues mCallDataValues;////电话号码数据

        private static final String TAG = "NoteData";

        public NoteData() {
            mTextDataValues = new ContentValues();
            mCallDataValues = new ContentValues();
            mTextDataId = 0;
            mCallDataId = 0;
        }//构造函数

        boolean isLocalModified() {
            return mTextDataValues.size() > 0 || mCallDataValues.size() > 0;
        }//判断是否是本地修改

        void setTextDataId(long id) {
            if(id <= 0) {
                throw new IllegalArgumentException("Text data id should larger than 0");
            }
            mTextDataId = id;
        }

        void setCallDataId(long id) {
            if (id <= 0) {
                throw new IllegalArgumentException("Call data id should larger than 0");
            }
            mCallDataId = id;
        }

        void setCallData(String key, String value) {
            mCallDataValues.put(key, value);
            mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
            mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
        }

        void setTextData(String key, String value) {
            mTextDataValues.put(key, value);
            mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
            mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
        }

        Uri pushIntoContentResolver(Context context, long noteId) {//将新的数据通过Uri的操作存储到数据库
            /**
             * Check for safety
             */
            if (noteId <= 0) {
                throw new IllegalArgumentException("Wrong note id:" + noteId);
            }//判断数据是否合法

            ArrayList<ContentProviderOperation> operationList = new ArrayList<ContentProviderOperation>();
            //定义了一个名为operationList的ArrayList，这个ArrayList可以存储ContentProviderOperation对象，初始化这个ArrayList。
            //ContentProviderOperation是Android中用于表示内容提供者操作（如插入、更新、删除等）的类
            ContentProviderOperation.Builder builder = null;
            //Builder是Android框架中ContentProviderOperation类的一个内部类。Builder模式是一种设计模式，它允许一个对象的构建与它的表示分离，使得同样的构建过程可以创建不同的表示。

            if(mTextDataValues.size() > 0) {//把文本数据存入DataColumns
                mTextDataValues.put(DataColumns.NOTE_ID, noteId);
                if (mTextDataId == 0) {//如果是首次插入数据
                    mTextDataValues.put(DataColumns.MIME_TYPE, TextNote.CONTENT_ITEM_TYPE);
                    Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI,
                            mTextDataValues);//向指定的URL插入数据
                    try {
                        setTextDataId(Long.valueOf(uri.getPathSegments().get(1)));
                    } catch (NumberFormatException e) {
                        Log.e(TAG, "Insert new text data fail with noteId" + noteId);
                        mTextDataValues.clear();
                        return null;
                    }
                } else {//如果数据已经存在，更新数据
                    builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(
                            Notes.CONTENT_DATA_URI, mTextDataId));
                    builder.withValues(mTextDataValues);
                    operationList.add(builder.build());//加入操作列表
                }
                mTextDataValues.clear();//清空
            }

            if(mCallDataValues.size() > 0) {//把电话号码数据存入DataColumns
                mCallDataValues.put(DataColumns.NOTE_ID, noteId);
                if (mCallDataId == 0) {
                    mCallDataValues.put(DataColumns.MIME_TYPE, CallNote.CONTENT_ITEM_TYPE);
                    Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI,
                            mCallDataValues);
                    try {
                        setCallDataId(Long.valueOf(uri.getPathSegments().get(1)));
                    } catch (NumberFormatException e) {
                        Log.e(TAG, "Insert new call data fail with noteId" + noteId);
                        mCallDataValues.clear();
                        return null;
                    }
                } else {
                    builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(
                            Notes.CONTENT_DATA_URI, mCallDataId));
                    builder.withValues(mCallDataValues);
                    operationList.add(builder.build());
                }
                mCallDataValues.clear();
            }

            if (operationList.size() > 0) {
                try {
                    ContentProviderResult[] results = context.getContentResolver().applyBatch(
                            Notes.AUTHORITY, operationList);//执行操作列表中的多个操作
                    return (results == null || results.length == 0 || results[0] == null) ? null
                            : ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId);
                } catch (RemoteException e) {//捕获RemoteException，这是当尝试与远程服务（如Content Provider）通信或远程方法调用（RPC）时抛出，表示远程对象调用失败。
                    Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));
                    return null;
                } catch (OperationApplicationException e) {//OperationApplicationException通常表示应用层操作失败。
                    Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));
                    return null;
                }
            }
            return null;
        }
    }
}
