/*
 * 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.app.SearchManager;  // 导入搜索管理器类
import android.content.ContentProvider;  // 导入内容提供者基类
import android.content.ContentUris;  // 导入内容URI工具类
import android.content.ContentValues;  // 导入内容值类
import android.content.Intent;  // 导入意图类
import android.content.UriMatcher;  // 导入URI匹配器类
import android.database.Cursor;  // 导入数据库游标类
import android.database.sqlite.SQLiteDatabase;  // 导入SQLite数据库类
import android.net.Uri;  // 导入URI类
import android.text.TextUtils;  // 导入文本工具类
import android.util.Log;  // 导入日志类

import net.micode.notes.R;  // 导入资源类
import net.micode.notes.data.Notes.DataColumns;  // 导入数据列接口
import net.micode.notes.data.Notes.NoteColumns;  // 导入笔记列接口
import net.micode.notes.data.NotesDatabaseHelper.TABLE;  // 导入表名接口

/**
 * 笔记内容提供者
 * 继承自ContentProvider，提供对笔记数据的CRUD操作
 * 支持内容提供者标准操作和搜索建议
 */
public class NotesProvider extends ContentProvider {
    // URI匹配器，用于匹配不同的URI请求
    private static final UriMatcher mMatcher;
    
    // 数据库帮助类实例
    private NotesDatabaseHelper mHelper;
    
    // 日志标签
    private static final String TAG = "NotesProvider";
    
    // URI匹配码常量
    private static final int URI_NOTE            = 1;  // 笔记表
    private static final int URI_NOTE_ITEM       = 2;  // 单个笔记项
    private static final int URI_DATA            = 3;  // 数据表
    private static final int URI_DATA_ITEM       = 4;  // 单个数据项
    private static final int URI_SEARCH          = 5;  // 搜索
    private static final int URI_SEARCH_SUGGEST  = 6;  // 搜索建议

    // 静态代码块，初始化URI匹配器
    static {
        mMatcher = new UriMatcher(UriMatcher.NO_MATCH);  // 创建URI匹配器
        mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE);  // 匹配笔记表
        mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM);  // 匹配单个笔记，#表示数字ID
        mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA);  // 匹配数据表
        mMatcher.addURI(Notes.AUTHORITY, "data/#", URI_DATA_ITEM);  // 匹配单个数据
        mMatcher.addURI(Notes.AUTHORITY, "search", URI_SEARCH);  // 匹配搜索
        mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY, URI_SEARCH_SUGGEST);  // 匹配搜索建议查询
        mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY + "/*", URI_SEARCH_SUGGEST);  // 匹配搜索建议带查询词
    }

    /**
     * 搜索投影：定义搜索结果的列
     * x'0A' 代表SQLite中的'\n'字符。对于搜索结果中的标题和内容，
     * 我们将修剪'\n'和空格以显示更多信息。
     */
    private static final String NOTES_SEARCH_PROJECTION = NoteColumns.ID + ","  // 笔记ID
        + NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + ","  // 作为建议的额外数据
        + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_1 + ","  // 建议文本1，移除换行符
        + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_2 + ","  // 建议文本2，移除换行符
        + R.drawable.search_result + " AS " + SearchManager.SUGGEST_COLUMN_ICON_1 + ","  // 建议图标，使用资源ID
        + "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + ","  // 建议意图动作
        + "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA;  // 建议意图数据

    /**
     * 笔记摘要搜索查询语句
     * 在笔记表中搜索摘要包含指定内容的笔记
     * 排除回收站中的笔记，只搜索普通笔记
     */
    private static String NOTES_SNIPPET_SEARCH_QUERY = "SELECT " + NOTES_SEARCH_PROJECTION  // 选择搜索投影
        + " FROM " + TABLE.NOTE  // 从笔记表
        + " WHERE " + NoteColumns.SNIPPET + " LIKE ?"  // 条件：摘要LIKE参数
        + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER  // 且不在回收站中
        + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE;  // 且类型为笔记

    /**
     * 创建内容提供者
     * 初始化数据库帮助类实例
     * @return 总是返回true，表示创建成功
     */
    @Override
    public boolean onCreate() {
        mHelper = NotesDatabaseHelper.getInstance(getContext());  // 获取数据库帮助类实例（单例）
        return true;  // 返回true表示创建成功
    }

    /**
     * 查询方法
     * 根据URI匹配不同的查询操作
     * @param uri 查询的URI
     * @param projection 要返回的列
     * @param selection 选择条件
     * @param selectionArgs 选择参数
     * @param sortOrder 排序方式
     * @return 查询结果的游标
     */
    @Override
    public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,
            String sortOrder) {
        Cursor c = null;  // 游标变量
        SQLiteDatabase db = mHelper.getReadableDatabase();  // 获取可读数据库
        String id = null;  // ID变量
        switch (mMatcher.match(uri)) {  // 根据URI匹配码进行分支
            case URI_NOTE:  // 查询笔记表
                c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null,
                        sortOrder);  // 执行查询
                break;
            case URI_NOTE_ITEM:  // 查询单个笔记
                id = uri.getPathSegments().get(1);  // 获取URI路径段中的ID（第二个段）
                c = db.query(TABLE.NOTE, projection, NoteColumns.ID + "=" + id
                        + parseSelection(selection), selectionArgs, null, null, sortOrder);  // 执行带ID的查询
                break;
            case URI_DATA:  // 查询数据表
                c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null,
                        sortOrder);  // 执行查询
                break;
            case URI_DATA_ITEM:  // 查询单个数据
                id = uri.getPathSegments().get(1);  // 获取URI路径段中的ID
                c = db.query(TABLE.DATA, projection, DataColumns.ID + "=" + id
                        + parseSelection(selection), selectionArgs, null, null, sortOrder);  // 执行带ID的查询
                break;
            case URI_SEARCH:  // 搜索
            case URI_SEARCH_SUGGEST:  // 搜索建议
                // 搜索和搜索建议不支持自定义排序和投影
                if (sortOrder != null || projection != null) {
                    throw new IllegalArgumentException(
                            "do not specify sortOrder, selection, selectionArgs, or projection" + "with this query");
                }

                String searchString = null;  // 搜索字符串
                // 获取搜索字符串
                if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) {
                    // 从URI路径段获取搜索建议查询词
                    if (uri.getPathSegments().size() > 1) {
                        searchString = uri.getPathSegments().get(1);  // 获取查询词
                    }
                } else {
                    // 从查询参数获取搜索模式
                    searchString = uri.getQueryParameter("pattern");  // 获取pattern参数
                }

                if (TextUtils.isEmpty(searchString)) {  // 如果搜索字符串为空
                    return null;  // 返回null
                }

                try {
                    searchString = String.format("%%%s%%", searchString);  // 格式化为LIKE模式：%keyword%
                    c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY,
                            new String[] { searchString });  // 执行原始查询
                } catch (IllegalStateException ex) {
                    Log.e(TAG, "got exception: " + ex.toString());  // 记录异常
                }
                break;
            default:
                throw new IllegalArgumentException("Unknown URI " + uri);  // 未知URI异常
        }
        if (c != null) {
            c.setNotificationUri(getContext().getContentResolver(), uri);  // 设置通知URI，用于数据变化通知
        }
        return c;  // 返回游标
    }

    /**
     * 插入方法
     * 根据URI匹配不同的插入操作
     * @param uri 插入的URI
     * @param values 要插入的值
     * @return 新插入项的URI
     */
    @Override
    public Uri insert(Uri uri, ContentValues values) {
        SQLiteDatabase db = mHelper.getWritableDatabase();  // 获取可写数据库
        long dataId = 0, noteId = 0, insertedId = 0;  // 插入的ID
        switch (mMatcher.match(uri)) {
            case URI_NOTE:  // 插入笔记
                insertedId = noteId = db.insert(TABLE.NOTE, null, values);  // 插入笔记，返回ID
                break;
            case URI_DATA:  // 插入数据
                if (values.containsKey(DataColumns.NOTE_ID)) {
                    noteId = values.getAsLong(DataColumns.NOTE_ID);  // 获取关联的笔记ID
                } else {
                    Log.d(TAG, "Wrong data format without note id:" + values.toString());  // 记录警告
                }
                insertedId = dataId = db.insert(TABLE.DATA, null, values);  // 插入数据，返回ID
                break;
            default:
                throw new IllegalArgumentException("Unknown URI " + uri);  // 未知URI异常
        }
        // 通知笔记URI变化
        if (noteId > 0) {
            getContext().getContentResolver().notifyChange(
                    ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null);  // 通知笔记URI变化
        }

        // 通知数据URI变化
        if (dataId > 0) {
            getContext().getContentResolver().notifyChange(
                    ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null);  // 通知数据URI变化
        }

        return ContentUris.withAppendedId(uri, insertedId);  // 返回新插入项的URI
    }

    /**
     * 删除方法
     * 根据URI匹配不同的删除操作
     * @param uri 删除的URI
     * @param selection 选择条件
     * @param selectionArgs 选择参数
     * @return 删除的行数
     */
    @Override
    public int delete(Uri uri, String selection, String[] selectionArgs) {
        int count = 0;  // 删除计数
        String id = null;  // ID变量
        SQLiteDatabase db = mHelper.getWritableDatabase();  // 获取可写数据库
        boolean deleteData = false;  // 是否删除数据标志
        switch (mMatcher.match(uri)) {
            case URI_NOTE:  // 删除笔记
                // 系统文件夹不允许删除（ID小于等于0）
                selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 ";  // 添加ID>0条件
                count = db.delete(TABLE.NOTE, selection, selectionArgs);  // 执行删除
                break;
            case URI_NOTE_ITEM:  // 删除单个笔记
                id = uri.getPathSegments().get(1);  // 获取ID
                long noteId = Long.valueOf(id);  // 转换为长整型
                if (noteId <= 0) {  // 系统文件夹不允许删除
                    break;
                }
                count = db.delete(TABLE.NOTE,
                        NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs);  // 执行带ID的删除
                break;
            case URI_DATA:  // 删除数据
                count = db.delete(TABLE.DATA, selection, selectionArgs);  // 执行删除
                deleteData = true;  // 标记为删除数据
                break;
            case URI_DATA_ITEM:  // 删除单个数据
                id = uri.getPathSegments().get(1);  // 获取ID
                count = db.delete(TABLE.DATA,
                        DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs);  // 执行带ID的删除
                deleteData = true;  // 标记为删除数据
                break;
            default:
                throw new IllegalArgumentException("Unknown URI " + uri);  // 未知URI异常
        }
        if (count > 0) {  // 如果删除了数据
            if (deleteData) {  // 如果是删除数据
                getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);  // 通知笔记URI变化
            }
            getContext().getContentResolver().notifyChange(uri, null);  // 通知当前URI变化
        }
        return count;  // 返回删除计数
    }

    /**
     * 更新方法
     * 根据URI匹配不同的更新操作
     * @param uri 更新的URI
     * @param values 要更新的值
     * @param selection 选择条件
     * @param selectionArgs 选择参数
     * @return 更新的行数
     */
    @Override
    public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) {
        int count = 0;  // 更新计数
        String id = null;  // ID变量
        SQLiteDatabase db = mHelper.getWritableDatabase();  // 获取可写数据库
        boolean updateData = false;  // 是否更新数据标志
        switch (mMatcher.match(uri)) {
            case URI_NOTE:  // 更新笔记
                increaseNoteVersion(-1, selection, selectionArgs);  // 增加笔记版本
                count = db.update(TABLE.NOTE, values, selection, selectionArgs);  // 执行更新
                break;
            case URI_NOTE_ITEM:  // 更新单个笔记
                id = uri.getPathSegments().get(1);  // 获取ID
                increaseNoteVersion(Long.valueOf(id), selection, selectionArgs);  // 增加笔记版本
                count = db.update(TABLE.NOTE, values, NoteColumns.ID + "=" + id
                        + parseSelection(selection), selectionArgs);  // 执行带ID的更新
                break;
            case URI_DATA:  // 更新数据
                count = db.update(TABLE.DATA, values, selection, selectionArgs);  // 执行更新
                updateData = true;  // 标记为更新数据
                break;
            case URI_DATA_ITEM:  // 更新单个数据
                id = uri.getPathSegments().get(1);  // 获取ID
                count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id
                        + parseSelection(selection), selectionArgs);  // 执行带ID的更新
                updateData = true;  // 标记为更新数据
                break;
            default:
                throw new IllegalArgumentException("Unknown URI " + uri);  // 未知URI异常
        }

        if (count > 0) {  // 如果更新了数据
            if (updateData) {  // 如果是更新数据
                getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);  // 通知笔记URI变化
            }
            getContext().getContentResolver().notifyChange(uri, null);  // 通知当前URI变化
        }
        return count;  // 返回更新计数
    }

    /**
     * 解析选择语句
     * 将选择语句包装在AND条件中
     * @param selection 原始选择语句
     * @return 解析后的选择语句
     */
    private String parseSelection(String selection) {
        return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : "");  // 如果不为空则添加AND和括号
    }

    /**
     * 增加笔记版本
     * 当笔记被修改时增加其版本号
     * @param id 笔记ID，如果为-1则使用选择语句
     * @param selection 选择语句
     * @param selectionArgs 选择参数
     */
    private void increaseNoteVersion(long id, String selection, String[] selectionArgs) {
        StringBuilder sql = new StringBuilder(120);  // 构建SQL语句
        sql.append("UPDATE ");  // UPDATE关键字
        sql.append(TABLE.NOTE);  // 表名
        sql.append(" SET ");  // SET关键字
        sql.append(NoteColumns.VERSION);  // 版本字段
        sql.append("=" + NoteColumns.VERSION + "+1 ");  // 版本号加1

        if (id > 0 || !TextUtils.isEmpty(selection)) {  // 如果有条件
            sql.append(" WHERE ");  // WHERE关键字
        }
        if (id > 0) {  // 如果有指定ID
            sql.append(NoteColumns.ID + "=" + String.valueOf(id));  // ID条件
        }
        if (!TextUtils.isEmpty(selection)) {  // 如果有选择语句
            String selectString = id > 0 ? parseSelection(selection) : selection;  // 解析选择语句
            // 替换参数占位符
            for (String args : selectionArgs) {
                selectString = selectString.replaceFirst("\\?", args);  // 替换问号为实际参数
            }
            sql.append(selectString);  // 添加选择条件
        }

        mHelper.getWritableDatabase().execSQL(sql.toString());  // 执行SQL
    }

    /**
     * 获取MIME类型
     * 此处未实现，返回null
     * @param uri URI
     * @return MIME类型字符串
     */
    @Override
    public String getType(Uri uri) {
        // TODO Auto-generated method stub
        return null;  // 暂未实现
    }
}