/*
* 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;
import android.content.ContentValues;
import android.content.Intent;
import android.content.UriMatcher;
import android.database.Cursor;
import android.database.sqlite.SQLiteDatabase;
import android.net.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;
/**
* 便签应用的Content Provider,负责处理便签数据的CRUD操作和搜索功能
*
* 核心职责:
*
* - 提供便签数据的Content Provider访问接口
* - 处理便签和便签详细数据的查询、插入、更新、删除操作
* - 支持便签搜索和搜索建议功能
* - 管理便签数据的版本控制
* - 在数据变更时通知相关组件
*
*
* 设计意图:
*
* - 遵循Android Content Provider设计规范,提供统一的数据访问接口
* - 使用UriMatcher处理不同类型的URI请求
* - 实现数据的封装和隔离,保护数据安全
* - 支持跨应用数据访问(如果需要)
* - 集成Android搜索框架,支持全局搜索
*
*
* 继承关系:
*
* - 直接继承自{@link android.content.ContentProvider},实现标准的Content Provider接口
*
*
* 与其他类的关键关联:
*
* - 依赖{@link NotesDatabaseHelper}获取数据库实例,进行底层数据操作
* - 使用{@link Notes}类中定义的常量和URI,作为数据访问的标准
* - 实现{@link SearchManager}接口,支持Android全局搜索功能
* - 被应用的UI组件和Widget组件使用,作为数据访问的主要入口
*
*
* URI匹配规则:
*
* - content://micode_notes/note - 所有便签和文件夹
* - content://micode_notes/note/# - 单个便签或文件夹
* - content://micode_notes/data - 所有便签详细数据
* - content://micode_notes/data/# - 单个便签详细数据
* - content://micode_notes/search - 搜索便签
* - content://micode_notes/search_suggest_query - 搜索建议
*
*
*/
public class NotesProvider extends ContentProvider {
/**
* UriMatcher实例,用于匹配不同类型的URI请求
*
* 用途:根据URI路径和格式,将请求分发到不同的处理逻辑
*
* 初始化:在静态代码块中初始化,添加所有支持的URI模式
*/
private static final UriMatcher mMatcher;
/**
* 数据库辅助类实例,用于获取SQLiteDatabase对象
*
* 用途:提供底层数据库操作支持,包括创建、打开和升级数据库
*
* 初始化:在onCreate方法中通过单例模式获取实例
*/
private NotesDatabaseHelper mHelper;
/**
* 日志标签,用于调试和日志记录
*/
private static final String TAG = "NotesProvider";
/**
* URI类型常量:表示所有便签和文件夹的集合
*/
private static final int URI_NOTE = 1;
/**
* URI类型常量:表示单个便签或文件夹
*/
private static final int URI_NOTE_ITEM = 2;
/**
* URI类型常量:表示所有便签详细数据的集合
*/
private static final int URI_DATA = 3;
/**
* URI类型常量:表示单个便签详细数据
*/
private static final int URI_DATA_ITEM = 4;
/**
* URI类型常量:表示便签搜索请求
*/
private static final int URI_SEARCH = 5;
/**
* URI类型常量:表示搜索建议请求
*/
private static final int URI_SEARCH_SUGGEST = 6;
/**
* 静态代码块,初始化UriMatcher实例,添加所有支持的URI模式
*
* 注册的URI模式包括:
*
* - note - 所有便签和文件夹
* - note/# - 单个便签或文件夹
* - data - 所有便签详细数据
* - data/# - 单个便签详细数据
* - search - 便签搜索
* - search_suggest_query - 搜索建议
* - search_suggest_query/* - 带查询参数的搜索建议
*
*/
static {
mMatcher = new UriMatcher(UriMatcher.NO_MATCH);
mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE);
mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM);
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);
}
/**
* 便签搜索的投影列定义,用于构建搜索结果
*
* 包含以下字段:
*
* - 便签ID
* - 搜索建议的额外数据(便签ID)
* - 搜索建议的文本1(便签内容,去除换行符和空格)
* - 搜索建议的文本2(便签内容,去除换行符和空格)
* - 搜索结果图标
* - 搜索结果的意图动作(查看)
* - 搜索结果的意图数据类型
*
*
* 特殊处理:
*
* - 使用SQLite函数TRIM和REPLACE去除便签内容中的换行符(x'0A')和空格
* - 使用固定的搜索结果图标
*
*/
private static final String NOTES_SEARCH_PROJECTION = NoteColumns.ID + ","
+ NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + ","
+ "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_1 + ","
+ "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_2 + ","
+ R.drawable.search_result + " AS " + SearchManager.SUGGEST_COLUMN_ICON_1 + ","
+ "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + ","
+ "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA;
/**
* 便签搜索的SQL查询语句,用于执行实际的搜索操作
*
* 查询条件:
*
* - 便签内容包含搜索关键字(LIKE ?)
* - 便签不在回收站中(PARENT_ID <> TRASH_FOLDER)
* - 便签类型为普通便签(TYPE = TYPE_NOTE)
*
*
* 用途:在URI_SEARCH和URI_SEARCH_SUGGEST类型的请求中执行搜索操作
*/
private static String NOTES_SNIPPET_SEARCH_QUERY = "SELECT " + NOTES_SEARCH_PROJECTION
+ " FROM " + TABLE.NOTE
+ " WHERE " + NoteColumns.SNIPPET + " LIKE ?"
+ " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER
+ " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE;
/**
* 初始化Content Provider
*
* 业务逻辑:
*
* - 获取NotesDatabaseHelper的单例实例
* - 初始化数据库连接
*
*
* 与其他类的交互:
*
* - 调用{@link NotesDatabaseHelper#getInstance(android.content.Context)}获取数据库辅助类实例
*
*
* @return true 初始化成功
* @see android.content.ContentProvider#onCreate()
*/
@Override
public boolean onCreate() {
mHelper = NotesDatabaseHelper.getInstance(getContext());
return true;
}
/**
* 处理查询请求,根据URI类型返回相应的Cursor对象
*
* 业务逻辑:
*
* - 根据URI类型分发到不同的查询逻辑
* - 获取可读数据库实例
* - 执行查询操作,返回Cursor对象
* - 为Cursor设置通知URI,以便数据变更时接收通知
*
*
* URI类型处理:
*
* - {@link #URI_NOTE} - 查询所有便签和文件夹
* - {@link #URI_NOTE_ITEM} - 查询单个便签或文件夹
* - {@link #URI_DATA} - 查询所有便签详细数据
* - {@link #URI_DATA_ITEM} - 查询单个便签详细数据
* - {@link #URI_SEARCH} - 执行便签搜索
* - {@link #URI_SEARCH_SUGGEST} - 提供搜索建议
*
*
* 与其他类的交互:
*
* - 使用{@link NotesDatabaseHelper#getReadableDatabase()}获取可读数据库
* - 使用{@link SQLiteDatabase}执行查询操作
* - 使用{@link SearchManager}处理搜索相关请求
*
*
* 特殊处理:
*
* - 搜索请求不允许指定sortOrder和projection参数
* - 搜索结果会去除换行符和空格,以便显示更多信息
* - 搜索范围不包括回收站中的便签
*
*
* @param uri 请求的URI
* @param projection 返回的列名数组
* @param selection 查询条件
* @param selectionArgs 查询条件参数
* @param sortOrder 排序方式
* @return Cursor 查询结果的Cursor对象,或null如果查询失败
* @throws IllegalArgumentException 如果URI无效或参数不符合要求
* @see android.content.ContentProvider#query(android.net.Uri, java.lang.String[], java.lang.String, java.lang.String[], java.lang.String)
*/
@Override
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,
String sortOrder) {
Cursor c = null;
SQLiteDatabase db = mHelper.getReadableDatabase();
String id = null;
switch (mMatcher.match(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);
c = db.query(TABLE.NOTE, projection, NoteColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs, null, null, sortOrder);
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);
c = db.query(TABLE.DATA, projection, DataColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs, null, null, sortOrder);
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) {
if (uri.getPathSegments().size() > 1) {
searchString = uri.getPathSegments().get(1);
}
} else {
searchString = uri.getQueryParameter("pattern");
}
if (TextUtils.isEmpty(searchString)) {
return null;
}
try {
searchString = String.format("%%%s%%", searchString);
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);
}
if (c != null) {
c.setNotificationUri(getContext().getContentResolver(), uri);
}
return c;
}
/**
* 处理插入请求,根据URI类型插入数据并返回新的URI
*
* 业务逻辑:
*
* - 根据URI类型分发到不同的插入逻辑
* - 获取可写数据库实例
* - 执行插入操作,返回插入的行ID
* - 通知相关URI的数据变更
* - 返回包含新ID的URI
*
*
* URI类型处理:
*
* - {@link #URI_NOTE} - 插入便签或文件夹
* - {@link #URI_DATA} - 插入便签详细数据
*
*
* 与其他类的交互:
*
* - 使用{@link NotesDatabaseHelper#getWritableDatabase()}获取可写数据库
* - 使用{@link SQLiteDatabase}执行插入操作
* - 通过{@link android.content.ContentResolver#notifyChange(android.net.Uri, android.database.ContentObserver)}通知数据变更
*
*
* 特殊处理:
*
* - 插入数据时,记录插入的noteId和dataId
* - 插入成功后,通知相关URI的数据变更
*
*
* @param uri 请求的URI
* @param values 要插入的数据
* @return Uri 包含新插入行ID的URI
* @throws IllegalArgumentException 如果URI无效
* @see android.content.ContentProvider#insert(android.net.Uri, android.content.ContentValues)
*/
@Override
public Uri insert(Uri uri, ContentValues values) {
SQLiteDatabase db = mHelper.getWritableDatabase();
long dataId = 0, noteId = 0, insertedId = 0;
switch (mMatcher.match(uri)) {
case URI_NOTE:
insertedId = noteId = db.insert(TABLE.NOTE, null, values);
break;
case URI_DATA:
if (values.containsKey(DataColumns.NOTE_ID)) {
noteId = values.getAsLong(DataColumns.NOTE_ID);
} else {
Log.d(TAG, "Wrong data format without note id:" + values.toString());
}
insertedId = dataId = db.insert(TABLE.DATA, null, values);
break;
default:
throw new IllegalArgumentException("Unknown URI " + uri);
}
// Notify the note uri
if (noteId > 0) {
getContext().getContentResolver().notifyChange(
ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null);
}
// Notify the data uri
if (dataId > 0) {
getContext().getContentResolver().notifyChange(
ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null);
}
return ContentUris.withAppendedId(uri, insertedId);
}
/**
* 处理删除请求,根据URI类型删除数据并返回删除的行数
*
* 业务逻辑:
*
* - 根据URI类型分发到不同的删除逻辑
* - 获取可写数据库实例
* - 执行删除操作,返回删除的行数
* - 通知相关URI的数据变更
*
*
* URI类型处理:
*
* - {@link #URI_NOTE} - 删除便签或文件夹
* - {@link #URI_NOTE_ITEM} - 删除单个便签或文件夹
* - {@link #URI_DATA} - 删除便签详细数据
* - {@link #URI_DATA_ITEM} - 删除单个便签详细数据
*
*
* 与其他类的交互:
*
* - 使用{@link NotesDatabaseHelper#getWritableDatabase()}获取可写数据库
* - 使用{@link SQLiteDatabase}执行删除操作
* - 通过{@link android.content.ContentResolver#notifyChange(android.net.Uri, android.database.ContentObserver)}通知数据变更
*
*
* 特殊处理:
*
* - 删除便签时,跳过ID小于等于0的系统文件夹
* - 删除数据时,同时通知CONTENT_NOTE_URI的数据变更
*
*
* @param uri 请求的URI
* @param selection 删除条件
* @param selectionArgs 删除条件参数
* @return int 删除的行数
* @throws IllegalArgumentException 如果URI无效
* @see android.content.ContentProvider#delete(android.net.Uri, java.lang.String, java.lang.String[])
*/
@Override
public int delete(Uri uri, String selection, String[] selectionArgs) {
int count = 0;
String id = null;
SQLiteDatabase db = mHelper.getWritableDatabase();
boolean deleteData = false;
switch (mMatcher.match(uri)) {
case URI_NOTE:
selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 ";
count = db.delete(TABLE.NOTE, selection, selectionArgs);
break;
case URI_NOTE_ITEM:
id = uri.getPathSegments().get(1);
/**
* ID that smaller than 0 is system folder which is not allowed to
* trash
*/
long noteId = Long.valueOf(id);
if (noteId <= 0) {
break;
}
count = db.delete(TABLE.NOTE,
NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs);
break;
case URI_DATA:
count = db.delete(TABLE.DATA, selection, selectionArgs);
deleteData = true;
break;
case URI_DATA_ITEM:
id = uri.getPathSegments().get(1);
count = db.delete(TABLE.DATA,
DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs);
deleteData = true;
break;
default:
throw new IllegalArgumentException("Unknown URI " + uri);
}
if (count > 0) {
if (deleteData) {
getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);
}
getContext().getContentResolver().notifyChange(uri, null);
}
return count;
}
/**
* 处理更新请求,根据URI类型更新数据并返回更新的行数
*
* 业务逻辑:
*
* - 根据URI类型分发到不同的更新逻辑
* - 获取可写数据库实例
* - 对于便签更新,先增加版本号
* - 执行更新操作,返回更新的行数
* - 通知相关URI的数据变更
*
*
* URI类型处理:
*
* - {@link #URI_NOTE} - 更新便签或文件夹
* - {@link #URI_NOTE_ITEM} - 更新单个便签或文件夹
* - {@link #URI_DATA} - 更新便签详细数据
* - {@link #URI_DATA_ITEM} - 更新单个便签详细数据
*
*
* 与其他类的交互:
*
* - 使用{@link NotesDatabaseHelper#getWritableDatabase()}获取可写数据库
* - 使用{@link SQLiteDatabase}执行更新操作
* - 调用{@link #increaseNoteVersion(long, String, String[])}增加便签版本号
* - 通过{@link android.content.ContentResolver#notifyChange(android.net.Uri, android.database.ContentObserver)}通知数据变更
*
*
* 特殊处理:
*
* - 更新便签时,自动增加版本号
* - 更新数据时,同时通知CONTENT_NOTE_URI的数据变更
*
*
* @param uri 请求的URI
* @param values 要更新的数据
* @param selection 更新条件
* @param selectionArgs 更新条件参数
* @return int 更新的行数
* @throws IllegalArgumentException 如果URI无效
* @see android.content.ContentProvider#update(android.net.Uri, android.content.ContentValues, java.lang.String, java.lang.String[])
*/
@Override
public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) {
int count = 0;
String id = null;
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);
increaseNoteVersion(Long.valueOf(id), selection, selectionArgs);
count = db.update(TABLE.NOTE, values, NoteColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs);
break;
case URI_DATA:
count = db.update(TABLE.DATA, values, selection, selectionArgs);
updateData = true;
break;
case URI_DATA_ITEM:
id = uri.getPathSegments().get(1);
count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs);
updateData = true;
break;
default:
throw new IllegalArgumentException("Unknown URI " + uri);
}
if (count > 0) {
if (updateData) {
getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);
}
getContext().getContentResolver().notifyChange(uri, null);
}
return count;
}
/**
* 辅助方法,处理查询条件,将额外条件添加到现有条件中
*
* 业务逻辑:
*
* - 如果selection不为空,将其包装为" AND (selection)"格式
* - 否则返回空字符串
*
*
* @param selection 原始查询条件
* @return String 处理后的查询条件
*/
private String parseSelection(String selection) {
return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : "");
}
/**
* 辅助方法,增加便签的版本号
*
* 业务逻辑:
*
* - 构建UPDATE语句,将版本号加1
* - 根据id和selection参数构建WHERE子句
* - 执行SQL语句,更新版本号
*
*
* 与其他类的交互:
*
* - 使用{@link NotesDatabaseHelper#getWritableDatabase()}获取可写数据库
* - 使用{@link SQLiteDatabase#execSQL(String)}执行SQL语句
*
*
* 特殊处理:
*
* - 直接使用字符串拼接构建SQL语句,存在SQL注入风险
* - 使用replaceFirst替换占位符,仅适用于简单的条件
* - TODO: 考虑使用PreparedStatement或参数化查询,提高安全性
*
*
* @param id 便签ID,-1表示更新多个便签
* @param selection 更新条件
* @param selectionArgs 更新条件参数
*/
private void increaseNoteVersion(long id, String selection, String[] selectionArgs) {
StringBuilder sql = new StringBuilder(120);
sql.append("UPDATE ");
sql.append(TABLE.NOTE);
sql.append(" SET ");
sql.append(NoteColumns.VERSION);
sql.append("=" + NoteColumns.VERSION + "+1 ");
if (id > 0 || !TextUtils.isEmpty(selection)) {
sql.append(" WHERE ");
}
if (id > 0) {
sql.append(NoteColumns.ID + "=" + String.valueOf(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());
}
/**
* 获取URI对应的MIME类型
*
* 注意:该方法目前未实现,返回null
*
* TODO: 实现该方法,返回正确的MIME类型
*
* @param uri 请求的URI
* @return String URI对应的MIME类型,目前返回null
* @see android.content.ContentProvider#getType(android.net.Uri)
*/
@Override
public String getType(Uri uri) {
// TODO Auto-generated method stub
return null;
}
}