/*
 * 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.data;

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;

/**
 * 笔记数据库帮助类
 * 继承自SQLiteOpenHelper，负责创建和管理笔记数据库
 */
public class NotesDatabaseHelper extends SQLiteOpenHelper {
    // 数据库名称常量
    private static final String DB_NAME = "note.db";
    
    // 数据库版本常量，用于数据库升级
    private static final int DB_VERSION = 4;
    
    /**
     * 数据库表名接口
     * 定义数据库中的表名
     */
    public interface TABLE {
        // 笔记表名
        public static final String NOTE = "note";
        
        // 数据表名
        public static final String DATA = "data";
    }
    
    // 日志标签，用于调试
    private static final String TAG = "NotesDatabaseHelper";
    
    // 单例实例
    private static NotesDatabaseHelper mInstance;
    
    /**
     * 创建笔记表的SQL语句
     * 定义了笔记表的结构和字段
     */
    private static final String CREATE_NOTE_TABLE_SQL =
        "CREATE TABLE " + TABLE.NOTE + "(" +            // 创建笔记表
            NoteColumns.ID + " INTEGER PRIMARY KEY," +  // 主键ID
            NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," +  // 父文件夹ID
            NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," +  // 提醒日期
            NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," +  // 背景颜色ID
            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," +  // 笔记数量（用于文件夹）
            NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," +  // 内容摘要
            NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," +  // 类型（笔记/文件夹/系统）
            NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," +  // 小部件ID
            NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," +  // 小部件类型
            NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," +  // 同步ID
            NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," +  // 本地修改标志
            NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," +  // 原始父文件夹ID
            NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," +  // Google任务ID
            NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" +  // 版本号
        ")";
    
    /**
     * 创建数据表的SQL语句
     * 定义了数据表的结构和字段
     */
    private static final String CREATE_DATA_TABLE_SQL =
        "CREATE TABLE " + TABLE.DATA + "(" +            // 创建数据表
            DataColumns.ID + " INTEGER PRIMARY KEY," +  // 主键ID
            DataColumns.MIME_TYPE + " TEXT NOT NULL," +  // MIME类型
            DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," +  // 关联的笔记ID
            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," +  // 通用数据字段1（整数）
            DataColumns.DATA2 + " INTEGER," +  // 通用数据字段2（整数）
            DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," +  // 通用数据字段3（文本）
            DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," +  // 通用数据字段4（文本）
            DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" +  // 通用数据字段5（文本）
        ")";
    
    /**
     * 创建数据表索引的SQL语句
     * 为note_id字段创建索引以提高查询性能
     */
    private static final String CREATE_DATA_NOTE_ID_INDEX_SQL =
        "CREATE INDEX IF NOT EXISTS note_id_index ON " +  // 创建索引
        TABLE.DATA + "(" + DataColumns.NOTE_ID + ");";  // 在note_id字段上创建索引
    
    /**
     * 更新笔记时增加文件夹计数器的触发器
     * 当笔记的父文件夹ID更新时，增加新文件夹的笔记计数
     */
    private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER =
        "CREATE TRIGGER increase_folder_count_on_update "+  // 创建触发器
        " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE +  // 在PARENT_ID更新后触发
        " BEGIN " +  // 触发器开始
        "  UPDATE " + TABLE.NOTE +  // 更新笔记表
        "   SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" +  // 笔记计数加1
        "  WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" +  // 更新新父文件夹
        " END";  // 触发器结束
    
    /**
     * 更新笔记时减少文件夹计数器的触发器
     * 当笔记的父文件夹ID更新时，减少原文件夹的笔记计数
     */
    private static final String NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER =
        "CREATE TRIGGER decrease_folder_count_on_update " +  // 创建触发器
        " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE +  // 在PARENT_ID更新后触发
        " BEGIN " +  // 触发器开始
        "  UPDATE " + TABLE.NOTE +  // 更新笔记表
        "   SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" +  // 笔记计数减1
        "  WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID +  // 更新原父文件夹
        "  AND " + NoteColumns.NOTES_COUNT + ">0" + ";" +  // 确保计数不小于0
        " END";  // 触发器结束
    
    /**
     * 插入笔记时增加文件夹计数器的触发器
     * 当插入新笔记时，增加其父文件夹的笔记计数
     */
    private static final String NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER =
        "CREATE TRIGGER increase_folder_count_on_insert " +  // 创建触发器
        " AFTER INSERT ON " + TABLE.NOTE +  // 在插入笔记后触发
        " BEGIN " +  // 触发器开始
        "  UPDATE " + TABLE.NOTE +  // 更新笔记表
        "   SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" +  // 笔记计数加1
        "  WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" +  // 更新父文件夹
        " END";  // 触发器结束
    
    /**
     * 删除笔记时减少文件夹计数器的触发器
     * 当删除笔记时，减少其父文件夹的笔记计数
     */
    private static final String NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER =
        "CREATE TRIGGER decrease_folder_count_on_delete " +  // 创建触发器
        " AFTER DELETE ON " + TABLE.NOTE +  // 在删除笔记后触发
        " BEGIN " +  // 触发器开始
        "  UPDATE " + TABLE.NOTE +  // 更新笔记表
        "   SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" +  // 笔记计数减1
        "  WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID +  // 更新原父文件夹
        "  AND " + NoteColumns.NOTES_COUNT + ">0;" +  // 确保计数不小于0
        " END";  // 触发器结束
    
    /**
     * 插入数据时更新笔记内容的触发器
     * 当插入类型为NOTE的数据时，更新对应笔记的摘要
     */
    private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER =
        "CREATE TRIGGER update_note_content_on_insert " +  // 创建触发器
        " AFTER INSERT ON " + TABLE.DATA +  // 在插入数据后触发
        " WHEN new." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" +  // 仅当MIME类型为NOTE时
        " BEGIN" +  // 触发器开始
        "  UPDATE " + TABLE.NOTE +  // 更新笔记表
        "   SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT +  // 设置摘要为内容
        "  WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" +  // 更新对应的笔记
        " END";  // 触发器结束
    
    /**
     * 更新数据时更新笔记内容的触发器
     * 当更新类型为NOTE的数据时，更新对应笔记的摘要
     */
    private static final String DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER =
        "CREATE TRIGGER update_note_content_on_update " +  // 创建触发器
        " AFTER UPDATE ON " + TABLE.DATA +  // 在更新数据后触发
        " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" +  // 仅当MIME类型为NOTE时
        " BEGIN" +  // 触发器开始
        "  UPDATE " + TABLE.NOTE +  // 更新笔记表
        "   SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT +  // 设置摘要为内容
        "  WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" +  // 更新对应的笔记
        " END";  // 触发器结束
    
    /**
     * 删除数据时更新笔记内容的触发器
     * 当删除类型为NOTE的数据时，清空对应笔记的摘要
     */
    private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER =
        "CREATE TRIGGER update_note_content_on_delete " +  // 创建触发器
        " AFTER delete ON " + TABLE.DATA +  // 在删除数据后触发
        " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" +  // 仅当MIME类型为NOTE时
        " BEGIN" +  // 触发器开始
        "  UPDATE " + TABLE.NOTE +  // 更新笔记表
        "   SET " + NoteColumns.SNIPPET + "=''" +  // 清空摘要
        "  WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" +  // 更新对应的笔记
        " END";  // 触发器结束
    
    /**
     * 删除笔记时删除相关数据的触发器
     * 当删除笔记时，自动删除该笔记的所有相关数据
     */
    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 + ";" +  // 删除笔记ID对应的数据
        " END";  // 触发器结束
    
    /**
     * 删除文件夹时删除其下所有笔记的触发器
     * 当删除文件夹时，自动删除该文件夹下的所有笔记
     */
    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 + ";" +  // 删除父文件夹ID为被删除ID的笔记
        " END";  // 触发器结束
    
    /**
     * 移动文件夹到回收站时移动其下所有笔记的触发器
     * 当移动文件夹到回收站时，自动移动该文件夹下的所有笔记到回收站
     */
    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";  // 触发器结束
    
    /**
     * 构造函数
     * @param context 应用上下文
     */
    public NotesDatabaseHelper(Context context) {
        super(context, DB_NAME, null, DB_VERSION);  // 调用父类构造函数
    }
    
    /**
     * 创建笔记表
     * @param db SQLite数据库对象
     */
    public void createNoteTable(SQLiteDatabase db) {
        db.execSQL(CREATE_NOTE_TABLE_SQL);  // 执行创建笔记表的SQL语句
        reCreateNoteTableTriggers(db);  // 重新创建笔记表的触发器
        createSystemFolder(db);  // 创建系统文件夹
        Log.d(TAG, "note table has been created");  // 日志记录
    }
    
    /**
     * 重新创建笔记表的触发器
     * @param db SQLite数据库对象
     */
    private void reCreateNoteTableTriggers(SQLiteDatabase db) {
        // 删除已存在的触发器
        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");
        db.execSQL("DROP TRIGGER IF EXISTS folder_move_notes_on_trash");
        
        // 重新创建触发器
        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);
        db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER);
    }
    
    /**
     * 创建系统文件夹
     * @param db SQLite数据库对象
     */
    private void createSystemFolder(SQLiteDatabase db) {
        ContentValues values = new ContentValues();  // 创建内容值对象
        
        /**
         * 通话记录文件夹
         * 用于存储通话笔记
         */
        values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER);  // 设置ID为通话记录文件夹ID
        values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);  // 设置类型为系统类型
        db.insert(TABLE.NOTE, null, values);  // 插入数据
        
        /**
         * 根文件夹
         * 默认文件夹
         */
        values.clear();  // 清空内容值
        values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER);  // 设置ID为根文件夹ID
        values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);  // 设置类型为系统类型
        db.insert(TABLE.NOTE, null, values);  // 插入数据
        
        /**
         * 临时文件夹
         * 用于移动笔记时的临时存储
         */
        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);  // 插入数据
        
        /**
         * 回收站文件夹
         * 用于存储已删除的笔记
         */
        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);  // 插入数据
    }
    
    /**
     * 创建数据表
     * @param db SQLite数据库对象
     */
    public void createDataTable(SQLiteDatabase db) {
        db.execSQL(CREATE_DATA_TABLE_SQL);  // 执行创建数据表的SQL语句
        reCreateDataTableTriggers(db);  // 重新创建数据表的触发器
        db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL);  // 创建数据表索引
        Log.d(TAG, "data table has been created");  // 日志记录
    }
    
    /**
     * 重新创建数据表的触发器
     * @param db SQLite数据库对象
     */
    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);
        db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER);
        db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER);
    }
    
    /**
     * 获取单例实例
     * 使用单例模式确保整个应用中只有一个数据库实例
     * @param context 应用上下文
     * @return 数据库帮助类实例
     */
    static synchronized NotesDatabaseHelper getInstance(Context context) {
        if (mInstance == null) {  // 如果实例为空
            mInstance = new NotesDatabaseHelper(context);  // 创建新实例
        }
        return mInstance;  // 返回实例
    }
    
    /**
     * 创建数据库
     * 当数据库第一次创建时调用
     * @param db SQLite数据库对象
     */
    @Override
    public void onCreate(SQLiteDatabase db) {
        createNoteTable(db);  // 创建笔记表
        createDataTable(db);  // 创建数据表
    }
    
    /**
     * 升级数据库
     * 当数据库版本升级时调用
     * @param db SQLite数据库对象
     * @param oldVersion 旧版本号
     * @param newVersion 新版本号
     */
    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
        boolean reCreateTriggers = false;  // 是否需要重新创建触发器
        boolean skipV2 = false;  // 是否跳过V2升级
        
        // 从版本1升级到版本2
        if (oldVersion == 1) {
            upgradeToV2(db);  // 执行V2升级
            skipV2 = true;  // 这个升级包含了从V2到V3的升级
            oldVersion++;  // 增加版本号
        }
        
        // 从版本2升级到版本3（如果没有跳过）
        if (oldVersion == 2 && !skipV2) {
            upgradeToV3(db);  // 执行V3升级
            reCreateTriggers = true;  // 需要重新创建触发器
            oldVersion++;  // 增加版本号
        }
        
        // 从版本3升级到版本4
        if (oldVersion == 3) {
            upgradeToV4(db);  // 执行V4升级
            oldVersion++;  // 增加版本号
        }
        
        // 如果需要重新创建触发器
        if (reCreateTriggers) {
            reCreateNoteTableTriggers(db);  // 重新创建笔记表触发器
            reCreateDataTableTriggers(db);  // 重新创建数据表触发器
        }
        
        // 如果升级后版本号不匹配，抛出异常
        if (oldVersion != newVersion) {
            throw new IllegalStateException("Upgrade notes database to version " + newVersion
                    + "fails");
        }
    }
    
    /**
     * 升级数据库到V2版本
     * 这是完全重建数据库的重大升级
     * @param db SQLite数据库对象
     */
    private void upgradeToV2(SQLiteDatabase db) {
        db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE);  // 删除已存在的note表
        db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA);  // 删除已存在的data表
        createNoteTable(db);  // 重新创建note表
        createDataTable(db);  // 重新创建data表
    }
    
    /**
     * 升级数据库到V3版本
     * 添加Google任务ID字段和回收站文件夹
     * @param db SQLite数据库对象
     */
    private void upgradeToV3(SQLiteDatabase db) {
        // 删除未使用的触发器
        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");
        
        // 添加Google任务ID字段
        db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID
                + " TEXT NOT NULL DEFAULT ''");
        
        // 添加回收站系统文件夹
        ContentValues values = new ContentValues();  // 创建内容值对象
        values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER);  // 设置ID为回收站文件夹ID
        values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);  // 设置类型为系统类型
        db.insert(TABLE.NOTE, null, values);  // 插入数据
    }
    
    /**
     * 升级数据库到V4版本
     * 添加版本号字段
     * @param db SQLite数据库对象
     */
    private void upgradeToV4(SQLiteDatabase db) {
        db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION
                + " INTEGER NOT NULL DEFAULT 0");  // 添加版本号字段
    }
}