/*
 * 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.
 */     //用于存储Notes的数据，以及根据数据更改Notes结构体的变量
//数据库操作引用
package net.micode.notes.data;//数据库操作，SQLOpenhelper,对一些note和文件进行数据库的操作。比如删除文件后，将文件里的note也相应删除

import android.content.ContentValues;//.就是用于保存一些数据
import android.content.Context;//加载和访问资源
import android.database.sqlite.SQLiteDatabase;//主要提供了对应于添加、删除、更新、查询的操作
import android.database.sqlite.SQLiteOpenHelper;//用来管理数据的创建和版本更新
import android.util.Log;//安卓日志类接口

import net.micode.notes.data.Notes.DataColumns;//创建根目录文件夹、移动便签及清空垃圾文件夹
import net.micode.notes.data.Notes.DataConstants;//移动便签
import net.micode.notes.data.Notes.NoteColumns;//数据库操作，用SQLOpenhelper,对一些note和文件进行数据库的操作，比如删除文件后，将文件里的note也相应删除


public class NotesDatabaseHelper extends SQLiteOpenHelper {//新建一个自定义的类继承SQLiiteOpenHelper，实现对数据库的各种操作，如创建、增添、删减、修改等。是一个辅助类
    private static final String DB_NAME = "note.db";//定义部分常量

    private static final int DB_VERSION = 4;//数据库版本号为4

    public interface TABLE {//接口，分成note和data，在后面的程序里分别使用过
        public static final String NOTE = "note";//以下为表格项目内容

        public static final String DATA = "data";//数据库中需要存储的项目的名称，就类似创建一个表格的表头的内容。
    }

    private static final String TAG = "NotesDatabaseHelper";//存储便签编号的一个数据表格

    private static NotesDatabaseHelper mInstance;//实例化一个databaseHelper； 创建NotesDatabaseHelper对象mInstance

    private static final String CREATE_NOTE_TABLE_SQL =//SQL的触发器是一个能由系统自动执行对数据库修改的语句，由文件的增加事件触发。文件夹中移入一个Note之后需要更改的数据的表格。
        "CREATE TABLE " + TABLE.NOTE + "(" +//SQL的触发器是一个能由系统自动执行对数据库修改的语句，由文件的减少事件触发。
            NoteColumns.ID + " INTEGER PRIMARY KEY," +//文件夹插入Note后需要更改的数据的表格
            NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," +//文件夹删除Note后需要更改的数据的表格
            NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," +
            NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," +//应用界面颜色选择
            NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +//创建时间数据
            NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," +
            NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +
            NoteColumns.NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," +//文件夹中便签数据初始化为0
            NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," +//SQL的触发器是一个能由系统自动执行对数据库修改的语句，由文件的插入事件触发
            NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," +
            NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," +
            NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," +
            NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," +
            NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," +
            NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," +
            NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," +
            NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" +//数据库中需要存储的项目的名称，就相当于创建一个表格的表头的内容
        ")";//QL的触发器是一个能由系统自动执行对数据库修改的语句，由新导入数据事件触发。

    private static final String CREATE_DATA_TABLE_SQL =//.SQL的触发器是一个能由系统自动执行对数据库修改的语句，由文件的删除事件触发。
        "CREATE TABLE " + TABLE.DATA + "(" +//note删除数据触发
            DataColumns.ID + " INTEGER PRIMARY KEY," +
            DataColumns.MIME_TYPE + " TEXT NOT NULL," +
            DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," +
            NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +
            NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +
            DataColumns.CONTENT + " TEXT NOT NULL DEFAULT ''," +
            DataColumns.DATA1 + " INTEGER," +
            DataColumns.DATA2 + " INTEGER," +
            DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," +
            DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," +
            DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" +
        ")";//和上面的功能一样，主要是存储的项目不同

    private static final String CREATE_DATA_NOTE_ID_INDEX_SQL =//将便签的ID作为数据库的ID
        "CREATE INDEX IF NOT EXISTS note_id_index ON " +
        TABLE.DATA + "(" + DataColumns.NOTE_ID + ");";//存储便签编号的一个数据表格
//以下几个都是在创建触发器(trigger)。触发器是一些在特定的数据库事件(database-event) 发生时自动进行的数据库操作(trigger-action).
    /**
     * Increase folder's note count when move note to the folder//Increase增加文件,Decrease减少文件
     */
    private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER =//将新的note移入该文件夹时，更新该文件夹note的数量
        "CREATE TRIGGER increase_folder_count_on_update "+
        " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE +
        " BEGIN " +
        "  UPDATE " + TABLE.NOTE +
        "   SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" +
        "  WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" +
        " END";//在文件夹中移入一个Note之后需要更改的数据的表格
//将新的note移入该文件夹时，更新该文件夹note的数量
    /**
     * Decrease folder's note count when move note from folder
     */
    private static final String NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER =//从文件夹中移出一个note时，更新数量
        "CREATE TRIGGER decrease_folder_count_on_update " +
        " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE +
        " BEGIN " +
        "  UPDATE " + TABLE.NOTE +
        "   SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" +
        "  WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID +
        "  AND " + NoteColumns.NOTES_COUNT + ">0" + ";" +//在文件夹中移出一个Note之后需要更改的数据的表格
        " END";

    /**
     * Increase folder's note count when insert new note to the folder   当在文件夹中插入一个新的note时增加note数量
     */
    private static final String NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER =//文件夹中创建新便签，文件夹便签数量+1，启动自定义的数据库insert触发器，附带相关的一系列操作
        "CREATE TRIGGER increase_folder_count_on_insert " +
        " AFTER INSERT ON " + TABLE.NOTE +
        " BEGIN " +
        "  UPDATE " + TABLE.NOTE +
        "   SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" +
        "  WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" +
        " END";// 在文件夹中插入一个Note之后需要更改的数据的表格

    /**
     * Decrease folder's note count when delete note from the folder  在文件夹中删除文件
     */
    private static final String NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER =//文件夹中删除便签，文件夹便签数量-1
        "CREATE TRIGGER decrease_folder_count_on_delete " +//定义一个更新文件夹中便签数目的SQL语句。当有便签从该文件夹中删除时使用
        " AFTER DELETE ON " + TABLE.NOTE +
        " BEGIN " +
        "  UPDATE " + TABLE.NOTE +
        "   SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" +
        "  WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID +
        "  AND " + NoteColumns.NOTES_COUNT + ">0;" +
        " END";//在文件夹中删除一个Note之后需要更改的数据的表格

    /**  SQL语句：当note插入新data时修改状态
     * Update note's content when insert data with type {@link DataConstants#NOTE}//在数据库中新增note或插入内容
     */ //构建一条SQL语句，用于实现在note中输入data后，进行当前状态的更新
    private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER =//当note插入新的数据时，更新note的内容，并更改表格
        "CREATE TRIGGER update_note_content_on_insert " +
        " AFTER INSERT ON " + TABLE.DATA +
        " WHEN new." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" +
        " BEGIN" +
        "  UPDATE " + TABLE.NOTE +
        "   SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT +
        "  WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" +
        " END";

    /**
     * Update note's content when data with {@link DataConstants#NOTE} type has changed//note发生变化时触发update
     */   //实现在note中改变data后，进行当前状态的更新
    private static final String DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER =//便签数据更新时，启动数据库update触发器
        "CREATE TRIGGER update_note_content_on_update " +
        " AFTER UPDATE ON " + TABLE.DATA +
        " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" +
        " BEGIN" +
        "  UPDATE " + TABLE.NOTE +
        "   SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT +
        "  WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" +
        " END";//Note数据被修改后需要更改的数据的表格

    /**
     * Update note's content when data with {@link DataConstants#NOTE} type has deleted
     */
    private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER =//便签数据更新时，启动数据库delete触发器
        "CREATE TRIGGER update_note_content_on_delete " +//构建一条SQL语句，用于实现在note中删除data后，进行当前状态的更新
        " AFTER delete ON " + TABLE.DATA +
        " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" +
        " BEGIN" +
        "  UPDATE " + TABLE.NOTE +
        "   SET " + NoteColumns.SNIPPET + "=''" +
        "  WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" +
        " END";

    /**
     * Delete datas belong to note which has been deleted  删除数据库中的数据，当这些数据在本地被删除
     */
    private static final String NOTE_DELETE_DATA_ON_DELETE_TRIGGER =
        "CREATE TRIGGER delete_data_on_delete " +
        " AFTER DELETE ON " + TABLE.NOTE +
        " BEGIN" +
        "  DELETE FROM " + TABLE.DATA +
        "   WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" +
        " END";

    /**
     * Delete notes belong to folder which has been deleted   删除文件夹中已被删除的便签
     */
    private static final String FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER =
        "CREATE TRIGGER folder_delete_notes_on_delete " +
        " AFTER DELETE ON " + TABLE.NOTE +
        " BEGIN" +
        "  DELETE FROM " + TABLE.NOTE +
        "   WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" +
        " END";//删除已删除的文件夹的便签后需要更改的数据的表格

    /**
     * Move notes belong to folder which has been moved to trash folder
     */
    private static final String FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER =
        "CREATE TRIGGER folder_move_notes_on_trash " +
        " AFTER UPDATE ON " + TABLE.NOTE +
        " WHEN new." + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER +
        " BEGIN" +
        "  UPDATE " + TABLE.NOTE +
        "   SET " + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER +
        "  WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" +
        " END";//还原垃圾桶中便签后需要更改的数据的表格

    public NotesDatabaseHelper(Context context) {///继承父类构造方法
        super(context, DB_NAME, null, DB_VERSION);//构造函数，传入数据库的名称和版本
    }

    public void createNoteTable(SQLiteDatabase db) {//当创建SQLiteOpenHelper时，自动执行onCreate（）方法;即自动创建一个数据库
        db.execSQL(CREATE_NOTE_TABLE_SQL);//.执行有更改行为的sql语句
        reCreateNoteTableTriggers(db);
        createSystemFolder(db);
        Log.d(TAG, "note table has been created");//调用系统输出调试信息，Log.d()是debug的意思。
    }//创建表格，存储标签属性

    private void reCreateNoteTableTriggers(SQLiteDatabase db) {//xecSQL是数据库操作的API，主要是更改行为的SQL语句。在这里主要是用来重新创建上述定义的表格用的，先删除原来有的数据库的触发器再重新创建新的数据库
        db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_update");//创建增加文件夹的触发器
        db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_update");//创建减少文件夹的触发器
        db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_delete");//创建删除减少文件夹的触发器
        db.execSQL("DROP TRIGGER IF EXISTS delete_data_on_delete");//创建删除数据的触发器
        db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_insert");//创建插入文件夹的触发器
        db.execSQL("DROP TRIGGER IF EXISTS folder_delete_notes_on_delete");//创建删除note的触发器
        db.execSQL("DROP TRIGGER IF EXISTS folder_move_notes_on_trash");//.创建移除note的触发器

        db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER);//创建自己的数据库操作
        db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER);//创建更新减少文件夹的触发器
        db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER);//创建删除减少文件夹的触发器
        db.execSQL(NOTE_DELETE_DATA_ON_DELETE_TRIGGER);//创建删除标记已删除数据的触发器
        db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER);//创建插入文件夹的触发器
        db.execSQL(FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER);// 创建删除notes的触发器
        db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER);//创建将回收站中的notes还原的触发器
    }//execSQL通过添加sql语句可以执行sql操作

    private void createSystemFolder(SQLiteDatabase db) {//创建几个系统文件夹
        ContentValues values = new ContentValues();//向数据库中插入数据，就要新建一个contentValues的对象。但只能存储基本类型数据

        /**
         * call record foler for call notes  储存呼叫记录的文件夹：
         */
        values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER);//放入数据(NoteColumns的id,呼叫记录文件夹的ld）
        values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);//将note的文件夹类型，与要放入数据库记录的格式类型映射，形成values的键-值
        db.insert(TABLE.NOTE, null, values);// 在对数据库进行操作时，要有一个contentValues的对象，具体方法是：db.insert(database_name,null,initialValues)，插入成功就返回记录的id否则返回-1；

        /**
         * root folder which is default folder  根文件夹是默认文件夹
         */
        values.clear();// 代码段：对根目录进行修改，将ID与数据库ID进行映射
        values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER);//将数据库ID与通话记录文件夹ID形成映射
        values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);//将数据库中数据类型与通话记录文件夹类型形成映射
        db.insert(TABLE.NOTE, null, values);//插入ContantValues对象

        /**
         * temporary folder which is used for moving note   设置临时文件夹作为文件移动的有效目标
         */ //移动note的临时文件夹
        values.clear();//临时文件夹的修改操作
        values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER);//将数据库ID与通话记录文件夹ID形成映射
        values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);//将数据库中数据类型与通话记录文件夹类型形成映射
        db.insert(TABLE.NOTE, null, values);// 插入ContantValues对象

        /**
         * create trash folder   创建回收站
         *///垃圾文件夹
        values.clear();//创建垃圾文件夹的操作
        values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER);//将数据库ID与通话记录文件夹ID形成映射
        values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);//将数据库中数据类型与通话记录文件夹类型形成映射
        db.insert(TABLE.NOTE, null, values);// 插入ContantValues对象
    }

    public void createDataTable(SQLiteDatabase db) {//创建表格（用来存储标签内容）
        db.execSQL(CREATE_DATA_TABLE_SQL);// 用来重新创建note对应的data的表格，用来重新创建上述定义的表格用的，先删除原来有的数据库的触发器再重新创建新的数据库，输入是一个SQLiteDatabase类的对象
        reCreateDataTableTriggers(db);//重新建立数据表的触发器
        db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL);
        Log.d(TAG, "data table has been created");
    }

    private void reCreateDataTableTriggers(SQLiteDatabase db) {//删除重建表格
        db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_insert");//往表中增加一行
        db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_update");
        db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_delete");

        db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER);//同上面的execSQL
        db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER);
        db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER);
    }

    static synchronized NotesDatabaseHelper getInstance(Context context) {//如果NotesDatabaseHelper的实例创建失败，那就重新建一个，重新分配内从空间
        if (mInstance == null) {
            mInstance = new NotesDatabaseHelper(context);
        }
        return mInstance;//为解决同一时刻只能有一个线程执行，在写程序库代码时，有时有一个类需要被所有的其它类使用
    }

    @Override  // @Override 伪代码，表示方法重写
    public void onCreate(SQLiteDatabase db) {//在NotesDatabaseHelper对象生命周期开始时创建Note table和Datatable
        createNoteTable(db);//函数：生命周期开始的时候oncreate 被调用，这里对其进行重写，加入notes表单和数据表单
        createDataTable(db);
    }//实现两个表格（上面创建的两个表格）

    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {//.数据库版本的更新，包括数据库内容的更改
        boolean reCreateTriggers = false;// 是否重建的信号
        boolean skipV2 = false;//是否从V2升级到V3

        if (oldVersion == 1) {//旧版本为1
            upgradeToV2(db);//更新到V2
            skipV2 = true; // this upgrade including the upgrade from v2 to v3
            oldVersion++;
        }//旧版本为V2，并且支持V2

        if (oldVersion == 2 && !skipV2) {//判断当前版本是不是二代
            upgradeToV3(db);
            reCreateTriggers = true;
            oldVersion++;//旧版本为3
        }

        if (oldVersion == 3) {//从V3升级到V4
            upgradeToV4(db);
            oldVersion++;
        }

        if (reCreateTriggers) {//重新创建的同时，创建新的note table和datatable
            reCreateNoteTableTriggers(db);//重新创建数据表头；前面一个应该为创建便签表头
            reCreateDataTableTriggers(db);
        }

        if (oldVersion != newVersion) {//判断当前版本是不是最新的
            throw new IllegalStateException("Upgrade notes database to version " + newVersion
                    + "fails");
        }
    }//数据库版本的更新（数据库内容的更改）

    private void upgradeToV2(SQLiteDatabase db) {
        db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE);
        db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA);
        createNoteTable(db);
        createDataTable(db);
    }//更新到版本2

    private void upgradeToV3(SQLiteDatabase db) {//数据库版本升级到V3
        // drop unused triggers
        db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_insert");//往数据库中增加一行内容
        db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_delete");//语句：删除重复的东西
        db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_update");
        // add a column for gtask id
        db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID//为 Gtask id在数据库中增加一列
                + " TEXT NOT NULL DEFAULT ''");
        // add a trash system folder
        ContentValues values = new ContentValues();//添加垃圾系统文件夹
        values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER);//为变量赋值
        values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
        db.insert(TABLE.NOTE, null, values);//插入到表中
    }//更新到V3版本

    private void upgradeToV4(SQLiteDatabase db) {//数据库版本升级到V4
        db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION
                + " INTEGER NOT NULL DEFAULT 0");
    }
}
