Compare commits

...

17 Commits

@ -0,0 +1,40 @@
/*
* Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net)
*
* Apache 2.0
* 使
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
*
*
*
*/
package net.micode.notes.gtask.exception;
// ActionFailureException 类继承自 RuntimeException用于表示操作失败的异常
public class ActionFailureException extends RuntimeException {
// 序列化版本号,用于在反序列化时验证版本兼容性
private static final long serialVersionUID = 4425249765923293627L;
// 无参数构造函数调用父类RuntimeException的无参数构造函数
public ActionFailureException() {
super();
}
// 带有一个字符串参数的构造函数,用于传递异常信息
// 调用父类RuntimeException的带有一个字符串参数的构造函数
public ActionFailureException(String paramString) {
super(paramString);
}
// 带有一个字符串参数和一个 Throwable 参数的构造函数
// 用于传递异常信息和导致此异常的原始异常(原因)
// 调用父类RuntimeException的带有一个字符串和一个 Throwable 参数的构造函数
public ActionFailureException(String paramString, Throwable paramThrowable) {
super(paramString, paramThrowable);
}
}

@ -0,0 +1,89 @@
/*
* 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.Context; // 导入用于访问应用程序上下文的类
import android.database.Cursor; // 导入用于处理数据库查询结果的类
import android.provider.ContactsContract.CommonDataKinds.Phone; // 导入与联系人电话号码相关的类
import android.provider.ContactsContract.Data; // 导入与联系人数据相关的类
import android.telephony.PhoneNumberUtils; // 导入用于处理电话号码的工具类
import android.util.Log; // 导入用于日志记录的类
import java.util.HashMap; // 导入用于创建键值对映射的哈希表类
// 定义一个名为Contact的类用于处理联系人相关的操作
public class Contact {
// 声明一个静态的HashMap用于缓存联系人电话号码和对应的姓名
private static HashMap<String, String> sContactCache;
// 定义一个静态的字符串常量,用于日志记录的标签
private static final String TAG = "Contact";
// 定义一个SQL查询条件字符串用于查询联系人姓名
private static final String CALLER_ID_SELECTION = "PHONE_NUMBERS_EQUAL(" + Phone.NUMBER
+ ",?) AND " + Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'"
+ " AND " + Data.RAW_CONTACT_ID + " IN "
+ "(SELECT raw_contact_id "
+ " FROM phone_lookup"
+ " WHERE min_match = '+')";
// 定义一个静态方法,用于根据电话号码获取联系人姓名
public static String getContact(Context context, String phoneNumber) {
// 如果联系人缓存为空则创建一个新的HashMap
if (sContactCache == null) {
sContactCache = new HashMap<String, String>();
}
// 如果缓存中已经包含该电话号码对应的联系人姓名,则直接返回
if (sContactCache.containsKey(phoneNumber)) {
return sContactCache.get(phoneNumber);
}
// 根据传入的电话号码,替换查询条件中的占位符
String selection = CALLER_ID_SELECTION.replace("+",
PhoneNumberUtils.toCallerIDMinMatch(phoneNumber));
// 使用ContentResolver查询联系人数据
Cursor cursor = context.getContentResolver().query(
Data.CONTENT_URI, // 联系人数据的URI
new String[]{Phone.DISPLAY_NAME}, // 需要查询的列,这里只查询显示名称
selection, // 查询条件
new String[]{phoneNumber}, // 查询条件中的参数值
null); // 排序方式这里为null表示不排序
// 如果查询结果不为空且游标可以移动到第一行
if (cursor!= null && cursor.moveToFirst()) {
try {
// 从查询结果中获取联系人的显示名称
String name = cursor.getString(0);
// 将电话号码和对应的联系人姓名存入缓存
sContactCache.put(phoneNumber, name);
// 返回联系人姓名
return name;
} catch (IndexOutOfBoundsException e) {
// 如果在获取字符串时发生索引越界异常,记录错误日志
Log.e(TAG, " Cursor get string error " + e.toString());
return null;
} finally {
// 无论是否发生异常,最终都要关闭游标以释放资源
cursor.close();
}
} else {
// 如果没有找到匹配的联系人,记录调试日志
Log.d(TAG, "No contact matched with number:" + phoneNumber);
return null;
}
}
}

@ -0,0 +1,156 @@
/*
* Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net)
*
* Apache 2.0
* 使
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
*
*
*
*/
package net.micode.notes.gtask.remote;
import android.app.Notification;
import android.app.NotificationManager;
import android.app.PendingIntent;
import android.content.Context;
import android.content.Intent;
import android.os.AsyncTask;
import net.micode.notes.R;
import net.micode.notes.ui.NotesListActivity;
import net.micode.notes.ui.NotesPreferenceActivity;
// GTaskASyncTask 类继承自 AsyncTask用于在后台执行与 GTask 同步相关的任务
public class GTaskASyncTask extends AsyncTask<Void, String, Integer> {
// 用于标识 GTask 同步通知的 ID
private static int GTASK_SYNC_NOTIFICATION_ID = 5234235;
// 定义一个接口,用于在任务完成时通知调用者
public interface OnCompleteListener {
// 定义任务完成时的回调方法
void onComplete();
}
// 上下文对象,用于获取系统服务等
private Context mContext;
// 通知管理器,用于管理通知
private NotificationManager mNotifiManager;
// GTask 管理器,用于执行 GTask 相关的同步操作
private GTaskManager mTaskManager;
// 任务完成监听器,用于接收任务完成的通知
private OnCompleteListener mOnCompleteListener;
// 构造函数,初始化 GTaskASyncTask 实例
public GTaskASyncTask(Context context, OnCompleteListener listener) {
// 保存上下文对象
mContext = context;
// 保存任务完成监听器
mOnCompleteListener = listener;
// 获取通知管理器
mNotifiManager = (NotificationManager) mContext
.getSystemService(Context.NOTIFICATION_SERVICE);
// 获取 GTask 管理器的单例实例
mTaskManager = GTaskManager.getInstance();
}
// 取消同步操作的方法
public void cancelSync() {
// 调用 GTask 管理器的取消同步方法
mTaskManager.cancelSync();
}
// 发布任务进度的方法,该方法名称有误,应为 publishProgress
public void publishProgess(String message) {
// 调用父类的 publishProgress 方法发布任务进度
publishProgress(new String[]{
message
});
}
// 显示通知的方法
private void showNotification(int tickerId, String content) {
// 创建一个通知对象
Notification notification = new Notification(R.drawable.notification, mContext
.getString(tickerId), System.currentTimeMillis());
// 设置通知的默认灯光效果
notification.defaults = Notification.DEFAULT_LIGHTS;
// 设置通知在被点击后自动取消
notification.flags = Notification.FLAG_AUTO_CANCEL;
PendingIntent pendingIntent;
// 根据 tickerId 判断设置不同的点击通知后的跳转意图
if (tickerId!= R.string.ticker_success) {
// 如果不是同步成功的通知,点击后跳转到 NotesPreferenceActivity
pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext,
NotesPreferenceActivity.class), 0);
} else {
// 如果是同步成功的通知,点击后跳转到 NotesListActivity
pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext,
NotesListActivity.class), 0);
}
// 设置通知的最新事件信息
notification.setLatestEventInfo(mContext, mContext.getString(R.string.app_name), content,
pendingIntent);
// 显示通知
mNotifiManager.notify(GTASK_SYNC_NOTIFICATION_ID, notification);
}
// 在后台执行的任务方法,该方法运行在子线程中
@Override
protected Integer doInBackground(Void... unused) {
// 发布任务进度,显示正在登录同步账户的信息
publishProgess(mContext.getString(R.string.sync_progress_login, NotesPreferenceActivity
.getSyncAccountName(mContext)));
// 调用 GTask 管理器的 sync 方法执行同步操作,并返回同步结果
return mTaskManager.sync(mContext, this);
}
// 当任务进度更新时调用的方法,运行在主线程中
@Override
protected void onProgressUpdate(String... progress) {
// 显示同步中的通知
showNotification(R.string.ticker_syncing, progress[0]);
// 如果上下文是 GTaskSyncService 类型,发送广播通知进度
if (mContext instanceof GTaskSyncService) {
((GTaskSyncService) mContext).sendBroadcast(progress[0]);
}
}
// 当任务执行完成后调用的方法,运行在主线程中
@Override
protected void onPostExecute(Integer result) {
// 根据同步结果显示不同的通知
if (result == GTaskManager.STATE_SUCCESS) {
// 同步成功,显示成功通知
showNotification(R.string.ticker_success, mContext.getString(
R.string.success_sync_account, mTaskManager.getSyncAccount()));
// 更新最后同步时间
NotesPreferenceActivity.setLastSyncTime(mContext, System.currentTimeMillis());
} else if (result == GTaskManager.STATE_NETWORK_ERROR) {
// 网络错误,显示网络错误通知
showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_network));
} else if (result == GTaskManager.STATE_INTERNAL_ERROR) {
// 内部错误,显示内部错误通知
showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_internal));
} else if (result == GTaskManager.STATE_SYNC_CANCELLED) {
// 同步取消,显示同步取消通知
showNotification(R.string.ticker_cancel, mContext
.getString(R.string.error_sync_cancelled));
}
// 如果任务完成监听器不为空,在新线程中调用 onComplete 方法
if (mOnCompleteListener!= null) {
new Thread(new Runnable() {
public void run() {
mOnCompleteListener.onComplete();
}
}).start();
}
}
}

@ -0,0 +1,458 @@
/*
* Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net)
*
* Apache 2.0
* 使
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
*
*
*
*/
package net.micode.notes.gtask.remote;
import android.accounts.Account;
import android.accounts.AccountManager;
import android.accounts.AccountManagerFuture;
import android.app.Activity;
import android.os.Bundle;
import android.text.TextUtils;
import android.util.Log;
import net.micode.notes.gtask.data.Node;
import net.micode.notes.gtask.data.Task;
import net.micode.notes.gtask.data.TaskList;
import net.micode.notes.gtask.exception.ActionFailureException;
net.micode.notes.gtask.exception.NetworkFailureException;
import net.micode.notes.tool.GTaskStringUtils;
import net.micode.notes.ui.NotesPreferenceActivity;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.cookie.Cookie;
import org.apache.http.impl.client.BasicCookieStore;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.params.BasicHttpParams;
import org.apache.http.params.HttpConnectionParams;
import org.apache.http.params.HttpParams;
import org.apache.http.params.HttpProtocolParams;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.LinkedList;
import java.util.List;
import java.util.zip.GZIPInputStream;
import java.util.zip.Inflater;
import java.util.zip.InflaterInputStream;
// GTaskClient 类负责与 Google 任务GTask服务器进行交互包括登录、创建任务、获取任务列表等操作
public class GTaskClient {
// 用于日志记录的标签,使用类的简单名称
private static final String TAG = GTaskClient.class.getSimpleName();
// GTask 服务的基本 URL
private static final String GTASK_URL = "https://mail.google.com/tasks/";
// 获取任务列表的 URL
private static final String GTASK_GET_URL = "https://mail.google.com/tasks/ig";
// 提交任务操作的 URL
private static final String GTASK_POST_URL = "https://mail.google.com/tasks/r/ig";
// GTaskClient 的单例实例
private static GTaskClient mInstance = null;
// HTTP 客户端,用于发送请求
private DefaultHttpClient mHttpClient;
// 当前使用的获取任务列表的 URL
private String mGetUrl;
// 当前使用的提交任务操作的 URL
private String mPostUrl;
// 客户端版本号
private long mClientVersion;
// 登录状态
private boolean mLoggedin;
// 上次登录时间
private long mLastLoginTime;
// 操作 ID用于标识每个请求
private int mActionId;
// 当前登录的账户
private Account mAccount;
// 存储待提交的更新操作的 JSON 数组
private JSONArray mUpdateArray;
// 私有构造函数,用于初始化 GTaskClient 的成员变量
private GTaskClient() {
mHttpClient = null;
mGetUrl = GTASK_GET_URL;
mPostUrl = GTASK_POST_URL;
mClientVersion = -1;
mLoggedin = false;
mLastLoginTime = 0;
mActionId = 1;
mAccount = null;
mUpdateArray = null;
}
// 获取 GTaskClient 单例实例的方法
public static synchronized GTaskClient getInstance() {
if (mInstance == null) {
mInstance = new GTaskClient();
}
return mInstance;
}
// 登录方法,用于登录 Google 账户并获取 GTask 服务的授权
public boolean login(Activity activity) {
// 设定 cookie 过期时间为 5 分钟
final long interval = 1000 * 60 * 5;
// 如果距离上次登录时间超过 5 分钟,标记为未登录
if (mLastLoginTime + interval < System.currentTimeMillis()) {
mLoggedin = false;
}
// 如果账户切换,标记为未登录
if (mLoggedin
&&!TextUtils.equals(getSyncAccount().name, NotesPreferenceActivity
.getSyncAccountName(activity))) {
mLoggedin = false;
}
// 如果已经登录,直接返回 true
if (mLoggedin) {
Log.d(TAG, "already logged in");
return true;
}
// 更新上次登录时间
mLastLoginTime = System.currentTimeMillis();
// 登录 Google 账户获取认证令牌
String authToken = loginGoogleAccount(activity, false);
if (authToken == null) {
Log.e(TAG, "login google account failed");
return false;
}
// 如果是自定义域名账户,进行特殊处理
if (!(mAccount.name.toLowerCase().endsWith("gmail.com") || mAccount.name.toLowerCase()
.endsWith("googlemail.com"))) {
// 构建自定义域名的 URL
StringBuilder url = new StringBuilder(GTASK_URL).append("a/");
int index = mAccount.name.indexOf('@') + 1;
String suffix = mAccount.name.substring(index);
url.append(suffix + "/");
mGetUrl = url.toString() + "ig";
mPostUrl = url.toString() + "r/ig";
// 尝试使用自定义域名 URL 登录 GTask
if (tryToLoginGtask(activity, authToken)) {
mLoggedin = true;
}
}
// 如果使用自定义域名未登录成功,尝试使用 Google 官方 URL 登录
if (!mLoggedin) {
mGetUrl = GTASK_GET_URL;
mPostUrl = GTASK_POST_URL;
if (!tryToLoginGtask(activity, authToken)) {
return false;
}
}
mLoggedin = true;
return true;
}
// 登录 Google 账户并获取认证令牌的方法
private String loginGoogleAccount(Activity activity, boolean invalidateToken) {
String authToken;
// 获取账户管理器
AccountManager accountManager = AccountManager.get(activity);
// 获取所有 Google 账户
Account[] accounts = accountManager.getAccountsByType("com.google");
// 如果没有可用的 Google 账户,返回 null
if (accounts.length == 0) {
Log.e(TAG, "there is no available google account");
return null;
}
// 获取设置中的同步账户名称
String accountName = NotesPreferenceActivity.getSyncAccountName(activity);
Account account = null;
// 查找与设置中账户名称相同的账户
for (Account a : accounts) {
if (a.name.equals(accountName)) {
account = a;
break;
}
}
// 如果未找到匹配的账户,记录错误并返回 null
if (account!= null) {
mAccount = account;
} else {
Log.e(TAG, "unable to get an account with the same name in the settings");
return null;
}
// 获取认证令牌
AccountManagerFuture<Bundle> accountManagerFuture = accountManager.getAuthToken(account,
"goanna_mobile", null, activity, null, null);
try {
// 获取包含认证令牌的 Bundle
Bundle authTokenBundle = accountManagerFuture.getResult();
authToken = authTokenBundle.getString(AccountManager.KEY_AUTHTOKEN);
// 如果需要使令牌失效,进行相应操作并重新登录
if (invalidateToken) {
accountManager.invalidateAuthToken("com.google", authToken);
loginGoogleAccount(activity, false);
}
} catch (Exception e) {
Log.e(TAG, "get auth token failed");
authToken = null;
}
return authToken;
}
// 尝试使用认证令牌登录 GTask 的方法
private boolean tryToLoginGtask(Activity activity, String authToken) {
// 先尝试使用当前认证令牌登录 GTask
if (!loginGtask(authToken)) {
// 如果登录失败,使当前认证令牌失效并重新获取
authToken = loginGoogleAccount(activity, true);
if (authToken == null) {
Log.e(TAG, "login google account failed");
return false;
}
// 再次尝试使用新的认证令牌登录 GTask
if (!loginGtask(authToken)) {
Log.e(TAG, "login gtask failed");
return false;
}
}
return true;
}
// 使用认证令牌登录 GTask 的具体方法
private boolean loginGtask(String authToken) {
// 设置连接超时时间和套接字超时时间
int timeoutConnection = 10000;
int timeoutSocket = 15000;
// 创建 HTTP 参数对象
HttpParams httpParameters = new BasicHttpParams();
// 设置连接超时时间
HttpConnectionParams.setConnectionTimeout(httpParameters, timeoutConnection);
// 设置套接字超时时间
HttpConnectionParams.setSoTimeout(httpParameters, timeoutSocket);
// 创建默认的 HTTP 客户端
mHttpClient = new DefaultHttpClient(httpParameters);
// 创建一个基本的 cookie 存储对象
BasicCookieStore localBasicCookieStore = new BasicCookieStore();
// 设置 HTTP 客户端的 cookie 存储
mHttpClient.setCookieStore(localBasicCookieStore);
// 禁用 Expect: 100 - continue 行为
HttpProtocolParams.setUseExpectContinue(mHttpClient.getParams(), false);
// 构建登录 URL
try {
String loginUrl = mGetUrl + "?auth=" + authToken;
// 创建 HTTP GET 请求
HttpGet httpGet = new HttpGet(loginUrl);
HttpResponse response = null;
// 执行 HTTP GET 请求
response = mHttpClient.execute(httpGet);
// 获取响应中的 cookie
List<Cookie> cookies = mHttpClient.getCookieStore().getCookies();
boolean hasAuthCookie = false;
// 检查是否存在包含 "GTL" 的认证 cookie
for (Cookie cookie : cookies) {
if (cookie.getName().contains("GTL")) {
hasAuthCookie = true;
}
}
// 如果没有找到认证 cookie记录警告
if (!hasAuthCookie) {
Log.w(TAG, "it seems that there is no auth cookie");
}
// 获取客户端版本号
String resString = getResponseContent(response.getEntity());
String jsBegin = "_setup(";
String jsEnd = ")}</script>";
int begin = resString.indexOf(jsBegin);
int end = resString.lastIndexOf(jsEnd);
String jsString = null;
// 如果找到包含客户端版本号的 JSON 字符串
if (begin!= -1 && end!= -1 && begin < end) {
jsString = resString.substring(begin + jsBegin.length(), end);
}
// 将 JSON 字符串转换为 JSONObject
JSONObject js = new JSONObject(jsString);
// 获取客户端版本号
mClientVersion = js.getLong("v");
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
return false;
} catch (Exception e) {
// 捕获所有异常
Log.e(TAG, "httpget gtask_url failed");
return false;
}
return true;
}
// 获取并递增操作 ID 的方法
private int getActionId() {
return mActionId++;
}
// 创建一个用于提交任务操作的 HttpPost 对象的方法
private HttpPost createHttpPost() {
HttpPost httpPost = new HttpPost(mPostUrl);
// 设置请求头的内容类型
httpPost.setHeader("Content-Type", "application/x-www-form-urlencoded;charset=utf-8");
// 设置请求头的 AT 字段
httpPost.setHeader("AT", "1");
return httpPost;
}
// 从 HTTP 响应实体中获取响应内容的方法
private String getResponseContent(HttpEntity entity) throws IOException {
String contentEncoding = null;
// 获取响应实体的内容编码
if (entity.getContentEncoding()!= null) {
contentEncoding = entity.getContentEncoding().getValue();
Log.d(TAG, "encoding: " + contentEncoding);
}
// 获取响应实体的输入流
InputStream input = entity.getContent();
// 如果内容编码是 gzip解压输入流
if (contentEncoding!= null && contentEncoding.equalsIgnoreCase("gzip")) {
input = new GZIPInputStream(entity.getContent());
}
// 如果内容编码是 deflate解压输入流
else if (contentEncoding!= null && contentEncoding.equalsIgnoreCase("deflate")) {
Inflater inflater = new Inflater(true);
input = new InflaterInputStream(entity.getContent(), inflater);
}
try {
// 创建输入流读取器
InputStreamReader isr = new InputStreamReader(input);
// 创建缓冲读取器
BufferedReader br = new BufferedReader(isr);
// 创建字符串构建器
StringBuilder sb = new StringBuilder();
// 逐行读取响应内容并添加到字符串构建器
while (true) {
String buff = br.readLine();
if (buff == null) {
return sb.toString();
}
sb = sb.append(buff);
}
} finally {
// 关闭输入流
input.close();
}
}
// 向 GTask 服务器发送 POST 请求的方法
private JSONObject postRequest(JSONObject js) throws NetworkFailureException {
// 如果未登录,抛出异常
if (!mLoggedin) {
Log.e(TAG, "please login first");
throw new ActionFailureException("not logged in");
}
// 创建 HttpPost 对象
HttpPost httpPost = createHttpPost();
try {
// 创建一个包含请求参数的链表
LinkedList<BasicNameValuePair> list = new LinkedList<BasicNameValuePair>();
// 添加请求参数
list.add(new BasicNameValuePair("r", js.toString()));
// 创建 URL 编码的表单实体
UrlEncodedFormEntity entity = new UrlEncodedFormEntity(list, "UTF-8");
// 设置 HttpPost 的实体
httpPost.setEntity(entity);
// 执行 POST 请求
HttpResponse response = mHttpClient.execute(httpPost);
// 获取响应内容并转换为 JSONObject
String jsString = getResponseContent(response.getEntity());
return new JSONObject(jsString);
} catch (ClientProtocolException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
throw new NetworkFailureException("postRequest failed");
} catch (IOException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
throw new NetworkFailureException("postRequest failed");
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("unable to convert response content to jsonobject");
} catch (Exception e) {
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("error occurs when posting request");
}
}
// 创建任务的方法
public void createTask(Task task) throws NetworkFailureException {
// 提交之前的更新操作
commitUpdate();
try {
// 创建一个用于 POST 请求的 JSONObject
JSONObject jsPost = new JSONObject();
// 创建一个包含操作的 JSON 数组
JSONArray actionList = new JSONArray();
// 添加创建任务的操作到 JSON 数组
actionList.put(task.getCreateAction(getActionId()));
// 将操作数组添加到请求的 JSONObject 中
jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList);
// 添加客户端版本号到请求的 JSONObject 中
jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion);
// 发送 POST 请求并获取响应
JSONObject jsResponse = postRequest(jsPost);
// 从响应中获取结果
JSONObject jsResult = (JSONObject) jsResponse.getJSONArray(
GTaskStringUtils.GTASK_JSON_RESULTS).get(0);
// 设置任务的 GID
task.setGid(jsResult.getString(GTaskStringUtils.GTASK_JSON_NEW_ID));
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("create task: handing jsonobject failed");
}
}
// 创建任务列表的方法
public void createTaskList(TaskList tasklist) throws NetworkFailureException {
// 提交之前的更新

@ -0,0 +1,443 @@
/*
* Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net)
*
* Apache 2.0
* 使
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
*
*
*
*/
package net.micode.notes.gtask.remote;
import android.app.Activity;
import android.content.ContentResolver;
import android.content.ContentUris;
import android.content.ContentValues;
import android.content.Context;
import android.database.Cursor;
import android.util.Log;
import net.micode.notes.R;
import net.micode.notes.data.Notes;
import net.micode.notes.data.Notes.DataColumns;
import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.gtask.data.MetaData;
import net.micode.notes.gtask.data.Node;
import net.micode.notes.gtask.data.SqlNote;
import net.micode.notes.gtask.data.Task;
import net.micode.notes.gtask.data.TaskList;
import net.micode.notes.gtask.exception.ActionFailureException;
import net.micode.notes.gtask.exception.NetworkFailureException;
import net.micode.notes.tool.DataUtils;
import net.micode.notes.tool.GTaskStringUtils;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
// GTaskManager 类负责管理与 Google 任务GTask的同步操作包括登录、获取任务列表、同步本地和远程数据等
public class GTaskManager {
// 用于日志记录的标签,使用类的简单名称
private static final String TAG = GTaskManager.class.getSimpleName();
// 同步成功的状态码
public static final int STATE_SUCCESS = 0;
// 网络错误的状态码
public static final int STATE_NETWORK_ERROR = 1;
// 内部错误的状态码
public static final int STATE_INTERNAL_ERROR = 2;
// 同步进行中的状态码
public static final int STATE_SYNC_IN_PROGRESS = 3;
// 同步取消的状态码
public static final int STATE_SYNC_CANCELLED = 4;
// GTaskManager 的单例实例
private static GTaskManager mInstance = null;
// 用于获取认证令牌的 Activity
private Activity mActivity;
// 上下文对象
private Context mContext;
// 内容解析器,用于操作本地数据
private ContentResolver mContentResolver;
// 同步是否正在进行的标志
private boolean mSyncing;
// 同步是否被取消的标志
private boolean mCancelled;
// 存储远程任务列表的 HashMap键为任务列表的 GID值为 TaskList 对象
private HashMap<String, TaskList> mGTaskListHashMap;
// 存储远程节点(任务或任务列表)的 HashMap键为节点的 GID值为 Node 对象
private HashMap<String, Node> mGTaskHashMap;
// 存储元数据的 HashMap键为相关的 GID值为 MetaData 对象
private HashMap<String, MetaData> mMetaHashMap;
// 元数据任务列表
private TaskList mMetaList;
// 存储本地已删除笔记 ID 的 HashSet
private HashSet<Long> mLocalDeleteIdMap;
// 从 GID 到本地笔记 ID 的映射 HashMap
private HashMap<String, Long> mGidToNid;
// 从本地笔记 ID 到 GID 的映射 HashMap
private HashMap<Long, String> mNidToGid;
// 私有构造函数,用于初始化 GTaskManager 的成员变量
private GTaskManager() {
mSyncing = false;
mCancelled = false;
mGTaskListHashMap = new HashMap<String, TaskList>();
mGTaskHashMap = new HashMap<String, Node>();
mMetaHashMap = new HashMap<String, MetaData>();
mMetaList = null;
mLocalDeleteIdMap = new HashSet<Long>();
mGidToNid = new HashMap<String, Long>();
mNidToGid = new HashMap<Long, String>();
}
// 获取 GTaskManager 单例实例的方法
public static synchronized GTaskManager getInstance() {
if (mInstance == null) {
mInstance = new GTaskManager();
}
return mInstance;
}
// 设置用于获取认证令牌的 Activity 的方法
public synchronized void setActivityContext(Activity activity) {
// 用于获取认证令牌
mActivity = activity;
}
// 执行同步操作的方法
public int sync(Context context, GTaskASyncTask asyncTask) {
// 如果同步正在进行,返回同步进行中的状态码
if (mSyncing) {
Log.d(TAG, "Sync is in progress");
return STATE_SYNC_IN_PROGRESS;
}
// 设置上下文和内容解析器
mContext = context;
mContentResolver = mContext.getContentResolver();
// 标记同步开始
mSyncing = true;
mCancelled = false;
// 清空各种存储数据的集合
mGTaskListHashMap.clear();
mGTaskHashMap.clear();
mMetaHashMap.clear();
mLocalDeleteIdMap.clear();
mGidToNid.clear();
mNidToGid.clear();
try {
// 获取 GTaskClient 实例
GTaskClient client = GTaskClient.getInstance();
// 重置更新数组
client.resetUpdateArray();
// 登录 Google 任务
if (!mCancelled) {
if (!client.login(mActivity)) {
throw new NetworkFailureException("login google task failed");
}
}
// 从 Google 获取任务列表
asyncTask.publishProgess(mContext.getString(R.string.sync_progress_init_list));
initGTaskList();
// 执行内容同步工作
asyncTask.publishProgess(mContext.getString(R.string.sync_progress_syncing));
syncContent();
} catch (NetworkFailureException e) {
Log.e(TAG, e.toString());
return STATE_NETWORK_ERROR;
} catch (ActionFailureException e) {
Log.e(TAG, e.toString());
return STATE_INTERNAL_ERROR;
} catch (Exception e) {
Log.e(TAG, e.toString());
e.printStackTrace();
return STATE_INTERNAL_ERROR;
} finally {
// 清空各种存储数据的集合
mGTaskListHashMap.clear();
mGTaskHashMap.clear();
mMetaHashMap.clear();
mLocalDeleteIdMap.clear();
mGidToNid.clear();
mNidToGid.clear();
// 标记同步结束
mSyncing = false;
}
// 返回同步结果状态码
return mCancelled? STATE_SYNC_CANCELLED : STATE_SUCCESS;
}
// 初始化远程任务列表的方法
private void initGTaskList() throws NetworkFailureException {
// 如果同步被取消,直接返回
if (mCancelled)
return;
// 获取 GTaskClient 实例
GTaskClient client = GTaskClient.getInstance();
try {
// 获取远程任务列表的 JSON 数组
JSONArray jsTaskLists = client.getTaskLists();
// 首先初始化元数据任务列表
mMetaList = null;
for (int i = 0; i < jsTaskLists.length(); i++) {
// 获取每个任务列表的 JSONObject
JSONObject object = jsTaskLists.getJSONObject(i);
// 获取任务列表的 GID
String gid = object.getString(GTaskStringUtils.GTASK_JSON_ID);
// 获取任务列表的名称
String name = object.getString(GTaskStringUtils.GTASK_JSON_NAME);
// 如果是元数据任务列表
if (name.equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META)) {
// 创建元数据任务列表对象
mMetaList = new TaskList();
// 根据远程 JSON 数据设置元数据任务列表的内容
mMetaList.setContentByRemoteJSON(object);
// 加载元数据
JSONArray jsMetas = client.getTaskList(gid);
for (int j = 0; j < jsMetas.length(); j++) {
// 获取每个元数据的 JSONObject
object = (JSONObject) jsMetas.getJSONObject(j);
// 创建元数据对象
MetaData metaData = new MetaData();
// 根据远程 JSON 数据设置元数据的内容
metaData.setContentByRemoteJSON(object);
// 如果元数据值得保存
if (metaData.isWorthSaving()) {
// 将元数据添加到元数据任务列表
mMetaList.addChildTask(metaData);
// 如果元数据有 GID将其添加到元数据 HashMap 中
if (metaData.getGid()!= null) {
mMetaHashMap.put(metaData.getRelatedGid(), metaData);
}
}
}
}
}
// 如果元数据任务列表不存在,创建一个
if (mMetaList == null) {
mMetaList = new TaskList();
mMetaList.setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META);
GTaskClient.getInstance().createTaskList(mMetaList);
}
// 初始化任务列表
for (int i = 0; i < jsTaskLists.length(); i++) {
// 获取每个任务列表的 JSONObject
object = jsTaskLists.getJSONObject(i);
// 获取任务列表的 GID
String gid = object.getString(GTaskStringUtils.GTASK_JSON_ID);
// 获取任务列表的名称
String name = object.getString(GTaskStringUtils.GTASK_JSON_NAME);
// 如果是普通任务列表
if (name.startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX)
&&!name.equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META)) {
// 创建任务列表对象
TaskList tasklist = new TaskList();
// 根据远程 JSON 数据设置任务列表的内容
tasklist.setContentByRemoteJSON(object);
// 将任务列表添加到任务列表 HashMap 中
mGTaskListHashMap.put(gid, tasklist);
// 将任务列表添加到节点 HashMap 中
mGTaskHashMap.put(gid, tasklist);
// 加载任务
JSONArray jsTasks = client.getTaskList(gid);
for (int j = 0; j < jsTasks.length(); j++) {
// 获取每个任务的 JSONObject
object = (JSONObject) jsTasks.getJSONObject(j);
// 获取任务的 GID
gid = object.getString(GTaskStringUtils.GTASK_JSON_ID);
// 创建任务对象
Task task = new Task();
// 根据远程 JSON 数据设置任务的内容
task.setContentByRemoteJSON(object);
// 如果任务值得保存
if (task.isWorthSaving()) {
// 设置任务的元信息
task.setMetaInfo(mMetaHashMap.get(gid));
// 将任务添加到任务列表
tasklist.addChildTask(task);
// 将任务添加到节点 HashMap 中
mGTaskHashMap.put(gid, task);
}
}
}
}
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("initGTaskList: handing JSONObject failed");
}
}
// 同步本地和远程内容的方法
private void syncContent() throws NetworkFailureException {
int syncType;
Cursor c = null;
String gid;
Node node;
// 清空本地已删除笔记 ID 的集合
mLocalDeleteIdMap.clear();
// 如果同步被取消,直接返回
if (mCancelled) {
return;
}
// 处理本地已删除的笔记
try {
// 查询本地回收站中的笔记
c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE,
"(type<>? AND parent_id=?)", new String[] {
String.valueOf(Notes.TYPE_SYSTEM), String.valueOf(Notes.ID_TRASH_FOLER)
}, null);
if (c!= null) {
while (c.moveToNext()) {
// 获取笔记的 GID
gid = c.getString(SqlNote.GTASK_ID_COLUMN);
// 获取对应的节点
node = mGTaskHashMap.get(gid);
if (node!= null) {
// 从节点 HashMap 中移除该节点
mGTaskHashMap.remove(gid);
// 执行内容同步操作
doContentSync(Node.SYNC_ACTION_DEL_REMOTE, node, c);
}
// 将本地已删除笔记的 ID 添加到集合中
mLocalDeleteIdMap.add(c.getLong(SqlNote.ID_COLUMN));
}
} else {
Log.w(TAG, "failed to query trash folder");
}
} finally {
// 关闭游标
if (c!= null) {
c.close();
c = null;
}
}
// 首先同步文件夹
syncFolder();
// 处理本地数据库中已存在的笔记
try {
// 查询本地非回收站中的普通笔记
c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE,
"(type=? AND parent_id<>?)", new String[] {
String.valueOf(Notes.TYPE_NOTE), String.valueOf(Notes.ID_TRASH_FOLER)
}, NoteColumns.TYPE + " DESC");
if (c!= null) {
while (c.moveToNext()) {
// 获取笔记的 GID
gid = c.getString(SqlNote.GTASK_ID_COLUMN);
// 获取对应的节点
node = mGTaskHashMap.get(gid);
if (node!= null) {
// 从节点 HashMap 中移除该节点
mGTaskHashMap.remove(gid);
// 记录 GID 与本地笔记 ID 的映射关系
mGidToNid.put(gid, c.getLong(SqlNote.ID_COLUMN));
mNidToGid.put(c.getLong(SqlNote.ID_COLUMN), gid);
// 获取同步类型
syncType = node.getSyncAction(c);
} else {
// 如果 GID 为空,说明是本地新增的笔记
if (c.getString(SqlNote.GTASK_ID_COLUMN).trim().length() == 0) {
syncType = Node.SYNC_ACTION_ADD_REMOTE;
} else {
// 否则是远程已删除的笔记
syncType = Node.SYNC_ACTION_DEL_LOCAL;
}
}
// 执行内容同步操作
doContentSync(syncType, node, c);
}
} else {
Log.w(TAG, "failed to query existing note in database");
}
} finally {
// 关闭游标
if (c!= null) {
c.close();
c = null;
}
}
// 处理剩余的未处理节点
Iterator<Map.Entry<String, Node>> iter = mGTaskHashMap.entrySet().iterator();
while (iter.hasNext()) {
Map.Entry<String, Node> entry = iter.next();
node = entry.getValue();
// 执行添加到本地的同步操作
doContentSync(Node.SYNC_ACTION_ADD_LOCAL, node, null);
}
// 如果同步未被取消
if (!mCancelled) {
// 批量删除本地已删除的笔记
if (!DataUtils.batchDeleteNotes(mContentResolver, mLocalDeleteIdMap)) {
throw new ActionFailureException("failed to batch-delete local deleted notes");
}
}
// 如果同步未被取消
if (!mCancelled) {
// 提交更新
GTaskClient.getInstance().commitUpdate();
// 刷新本地同步 ID
refreshLocalSyncId();
}
}
// 同步文件夹的方法
private void syncFolder() throws NetworkFailureException {
Cursor c = null;
String gid;
Node node;
int syncType;
// 如果同步被取消,直接返回
if (mCancelled) {
return;
}
// 处理根文件夹
try {
// 查询根文件夹的信息
c = mContentResolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI,
Notes.ID_ROOT_FOLDER), SqlNote.PROJECTION_NOTE, null, null, null);
if (c!= null) {
c.moveToNext();
// 获取根文件夹的 GID
gid = c.getString(SqlNote.GTASK_ID_COLUMN);
// 获取对应的节点
node = mGTaskHashMap.get(gid);
if (node!= null) {
// 从节点 HashMap 中移除该节点
m

@ -0,0 +1,177 @@
/*
* Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net)
*
* Apache 2.0
* 使
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
*
*
*
*/
package net.micode.notes.gtask.remote;
import android.app.Activity;
import android.app.Service;
import android.content.Context;
import android.content.Intent;
import android.os.Bundle;
import android.os.IBinder;
// GTaskSyncService 是一个 Android 服务类,用于管理 Google 任务GTask的同步操作
// 提供了启动同步、取消同步的功能,并通过广播通知同步状态和进度
public class GTaskSyncService extends Service {
// 用于在 Intent 中传递同步操作类型的字符串名称
public final static String ACTION_STRING_NAME = "sync_action_type";
// 启动同步操作的类型标识
public final static int ACTION_START_SYNC = 0;
// 取消同步操作的类型标识
public final static int ACTION_CANCEL_SYNC = 1;
// 无效操作的类型标识
public final static int ACTION_INVALID = 2;
// 用于发送广播的名称
public final static String GTASK_SERVICE_BROADCAST_NAME = "net.micode.notes.gtask.remote.gtask_sync_service";
// 广播中用于表示是否正在同步的字段名称
public final static String GTASK_SERVICE_BROADCAST_IS_SYNCING = "isSyncing";
// 广播中用于表示同步进度消息的字段名称
public final static String GTASK_SERVICE_BROADCAST_PROGRESS_MSG = "progressMsg";
// 当前正在执行的同步任务
private static GTaskASyncTask mSyncTask = null;
// 当前同步的进度消息
private static String mSyncProgress = "";
// 启动同步任务的方法
private void startSync() {
// 如果同步任务尚未创建
if (mSyncTask == null) {
// 创建一个新的 GTaskASyncTask 实例,并传入当前服务上下文和一个任务完成监听器
mSyncTask = new GTaskASyncTask(this, new GTaskASyncTask.OnCompleteListener() {
// 当同步任务完成时,执行该方法
public void onComplete() {
// 将同步任务实例置为 null
mSyncTask = null;
// 发送广播通知同步完成,消息为空字符串
sendBroadcast("");
// 停止当前服务
stopSelf();
}
});
// 发送广播通知同步开始,消息为空字符串
sendBroadcast("");
// 执行同步任务
mSyncTask.execute();
}
}
// 取消同步任务的方法
private void cancelSync() {
// 如果同步任务正在进行
if (mSyncTask!= null) {
// 调用同步任务的取消同步方法
mSyncTask.cancelSync();
}
}
// 当服务创建时调用的方法
@Override
public void onCreate() {
// 将同步任务实例置为 null
mSyncTask = null;
}
// 当服务接收到启动命令时调用的方法
@Override
public int onStartCommand(Intent intent, int flags, int startId) {
// 获取 Intent 中携带的额外数据
Bundle bundle = intent.getExtras();
// 如果额外数据存在且包含同步操作类型字段
if (bundle!= null && bundle.containsKey(ACTION_STRING_NAME)) {
// 根据同步操作类型执行相应的操作
switch (bundle.getInt(ACTION_STRING_NAME, ACTION_INVALID)) {
case ACTION_START_SYNC:
// 启动同步任务
startSync();
break;
case ACTION_CANCEL_SYNC:
// 取消同步任务
cancelSync();
break;
default:
break;
}
// 返回 START_STICKY 表示如果服务被系统杀死,在有足够内存时会自动重启
return START_STICKY;
}
// 如果未包含同步操作类型字段,调用父类的 onStartCommand 方法
return super.onStartCommand(intent, flags, startId);
}
// 当系统内存不足时调用的方法
@Override
public void onLowMemory() {
// 如果同步任务正在进行
if (mSyncTask!= null) {
// 取消同步任务
mSyncTask.cancelSync();
}
}
// 当客户端绑定到服务时调用的方法,由于该服务不支持绑定,返回 null
@Override
public IBinder onBind(Intent intent) {
return null;
}
// 发送广播的方法,用于通知同步状态和进度
public void sendBroadcast(String msg) {
// 更新同步进度消息
mSyncProgress = msg;
// 创建一个新的 Intent设置广播名称
Intent intent = new Intent(GTASK_SERVICE_BROADCAST_NAME);
// 在 Intent 中添加是否正在同步的信息
intent.putExtra(GTASK_SERVICE_BROADCAST_IS_SYNCING, mSyncTask!= null);
// 在 Intent 中添加同步进度消息
intent.putExtra(GTASK_SERVICE_BROADCAST_PROGRESS_MSG, msg);
// 发送广播
sendBroadcast(intent);
}
// 外部调用启动同步的静态方法
public static void startSync(Activity activity) {
// 设置 GTaskManager 的 Activity 上下文
GTaskManager.getInstance().setActivityContext(activity);
// 创建一个 Intent指定要启动的服务为 GTaskSyncService
Intent intent = new Intent(activity, GTaskSyncService.class);
// 在 Intent 中添加启动同步的操作类型
intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_START_SYNC);
// 启动服务
activity.startService(intent);
}
// 外部调用取消同步的静态方法
public static void cancelSync(Context context) {
// 创建一个 Intent指定要启动的服务为 GTaskSyncService
Intent intent = new Intent(context, GTaskSyncService.class);
// 在 Intent 中添加取消同步的操作类型
intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_CANCEL_SYNC);
// 启动服务
context.startService(intent);
}
// 判断是否正在进行同步的静态方法
public static boolean isSyncing() {
// 通过判断同步任务实例是否为 null 来确定是否正在同步
return mSyncTask!= null;
}
// 获取当前同步进度消息的静态方法
public static String getProgressString() {
// 返回当前的同步进度消息
return mSyncProgress;
}
}

@ -0,0 +1,101 @@
/*
* Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net)
*
* Apache 2.0
* 使
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
*
*
*
*/
package net.micode.notes.gtask.data;
import android.database.Cursor;
import android.util.Log;
import net.micode.notes.tool.GTaskStringUtils;
import org.json.JSONException;
import org.json.JSONObject;
// MetaData 类继承自 Task 类,用于处理与 GTask 相关的元数据
public class MetaData extends Task {
// 用于日志记录的标签,使用类的简单名称
private final static String TAG = MetaData.class.getSimpleName();
// 存储相关 GTask ID 的成员变量
private String mRelatedGid = null;
// 设置元数据的方法,接受 GTask ID 和包含元信息的 JSONObject
public void setMeta(String gid, JSONObject metaInfo) {
try {
// 将 GTask ID 放入元信息的 JSONObject 中,使用 GTaskStringUtils 中的常量作为键
metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid);
} catch (JSONException e) {
// 如果放入过程中出现 JSON 异常,记录错误日志
Log.e(TAG, "failed to put related gid");
}
// 将包含元信息的 JSONObject 转换为字符串,并设置为笔记内容
setNotes(metaInfo.toString());
// 设置名称为 GTaskStringUtils 中定义的元数据笔记名称
setName(GTaskStringUtils.META_NOTE_NAME);
}
// 获取相关 GTask ID 的方法
public String getRelatedGid() {
return mRelatedGid;
}
// 判断是否值得保存的方法,重写自父类
@Override
public boolean isWorthSaving() {
// 如果笔记内容不为空,则返回 true即值得保存
return getNotes()!= null;
}
// 根据远程 JSON 数据设置内容的方法,重写自父类
@Override
public void setContentByRemoteJSON(JSONObject js) {
// 调用父类的 setContentByRemoteJSON 方法,先处理通用部分
super.setContentByRemoteJSON(js);
if (getNotes()!= null) {
try {
// 将获取到的笔记内容(字符串)转换为 JSONObject
JSONObject metaInfo = new JSONObject(getNotes().trim());
// 从转换后的 JSONObject 中获取相关的 GTask ID
mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID);
} catch (JSONException e) {
// 如果获取过程中出现 JSON 异常,记录警告日志
Log.w(TAG, "failed to get related gid");
// 异常情况下将相关 GTask ID 设置为 null
mRelatedGid = null;
}
}
}
// 根据本地 JSON 数据设置内容的方法,重写自父类
@Override
public void setContentByLocalJSON(JSONObject js) {
// 该方法不应该被调用,抛出 IllegalAccessError 异常
throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called");
}
// 从内容中获取本地 JSON 数据的方法,重写自父类
@Override
public JSONObject getLocalJSONFromContent() {
// 该方法不应该被调用,抛出 IllegalAccessError 异常
throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called");
}
// 根据 Cursor 获取同步操作的方法,重写自父类
@Override
public int getSyncAction(Cursor c) {
// 该方法不应该被调用,抛出 IllegalAccessError 异常
throw new IllegalAccessError("MetaData:getSyncAction should not be called");
}
}

@ -0,0 +1,47 @@
/*
* Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net)
*
* Apache 2.0
* 使
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
*
*
*
*/
package net.micode.notes.gtask.exception;
// NetworkFailureException 类继承自 Exception 类,用于表示网络相关的失败异常
public class NetworkFailureException extends Exception {
// 序列化版本号,用于在反序列化时验证版本兼容性
// 确保不同版本的类在反序列化时的一致性
private static final long serialVersionUID = 2107610287180234136L;
// 无参数构造函数
// 调用父类Exception的无参数构造函数
// 用于在不需要提供具体异常信息时创建一个 NetworkFailureException 异常对象
public NetworkFailureException() {
super();
}
// 带有一个字符串参数的构造函数
// 接受一个字符串参数 paramString用于描述异常的详细信息
// 通过调用父类Exception的相应构造函数将异常信息传递给父类
// 方便在捕获异常时获取具体的错误描述
public NetworkFailureException(String paramString) {
super(paramString);
}
// 带有一个字符串参数和一个 Throwable 参数的构造函数
// 接受一个字符串参数 paramString 和一个 Throwable 参数 paramThrowable
// paramString 用于描述异常的具体信息paramThrowable 用于指定导致此异常的原始异常(原因)
// 调用父类Exception的相应构造函数将异常信息和原始异常传递给父类
// 这样在捕获异常时,可以更全面地了解异常的情况和根源
public NetworkFailureException(String paramString, Throwable paramThrowable) {
super(paramString, paramThrowable);
}
}

@ -0,0 +1,116 @@
/*
* Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net)
*
* Apache 2.0
* 使
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
*
*
*
*/
package net.micode.notes.gtask.data;
import android.database.Cursor;
import org.json.JSONObject;
// 定义一个抽象类 Node作为一个基础类可能用于表示与 GTask 相关的数据节点
public abstract class Node {
// 定义同步操作的常量,表示无操作
public static final int SYNC_ACTION_NONE = 0;
// 定义同步操作的常量,表示在远程添加
public static final int SYNC_ACTION_ADD_REMOTE = 1;
// 定义同步操作的常量,表示在本地添加
public static final int SYNC_ACTION_ADD_LOCAL = 2;
// 定义同步操作的常量,表示在远程删除
public static final int SYNC_ACTION_DEL_REMOTE = 3;
// 定义同步操作的常量,表示在本地删除
public static final int SYNC_ACTION_DEL_LOCAL = 4;
// 定义同步操作的常量,表示在远程更新
public static final int SYNC_ACTION_UPDATE_REMOTE = 5;
// 定义同步操作的常量,表示在本地更新
public static final int SYNC_ACTION_UPDATE_LOCAL = 6;
// 定义同步操作的常量,表示更新冲突
public static final int SYNC_ACTION_UPDATE_CONFLICT = 7;
// 定义同步操作的常量,表示出现错误
public static final int SYNC_ACTION_ERROR = 8;
// 存储 GTask ID 的成员变量
private String mGid;
// 存储名称的成员变量
private String mName;
// 存储最后修改时间的成员变量
private long mLastModified;
// 存储是否删除标志的成员变量
private boolean mDeleted;
// 构造函数,初始化成员变量的默认值
public Node() {
mGid = null;
mName = "";
mLastModified = 0;
mDeleted = false;
}
// 抽象方法,根据给定的操作 ID 获取创建操作的 JSONObject
public abstract JSONObject getCreateAction(int actionId);
// 抽象方法,根据给定的操作 ID 获取更新操作的 JSONObject
public abstract JSONObject getUpdateAction(int actionId);
// 抽象方法,根据远程 JSON 数据设置内容
public abstract void setContentByRemoteJSON(JSONObject js);
// 抽象方法,根据本地 JSON 数据设置内容
public abstract void setContentByLocalJSON(JSONObject js);
// 抽象方法,从内容中获取本地 JSON 数据
public abstract JSONObject getLocalJSONFromContent();
// 抽象方法,根据 Cursor 获取同步操作
public abstract int getSyncAction(Cursor c);
// 设置 GTask ID 的方法
public void setGid(String gid) {
this.mGid = gid;
}
// 设置名称的方法
public void setName(String name) {
this.mName = name;
}
// 设置最后修改时间的方法
public void setLastModified(long lastModified) {
this.mLastModified = lastModified;
}
// 设置是否删除标志的方法
public void setDeleted(boolean deleted) {
this.mDeleted = deleted;
}
// 获取 GTask ID 的方法
public String getGid() {
return this.mGid;
}
// 获取名称的方法
public String getName() {
return this.mName;
}
// 获取最后修改时间的方法
public long getLastModified() {
return this.mLastModified;
}
// 获取是否删除标志的方法
public boolean getDeleted() {
return this.mDeleted;
}
}

@ -0,0 +1,302 @@
/*
* 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.net.Uri; // 导入用于处理 URI 的类
// 定义一个名为 Notes 的类,用于管理笔记相关的常量和操作
public class Notes {
// 定义内容提供者的权限字符串
public static final String AUTHORITY = "micode_notes";
// 定义用于日志记录的标签
public static final String TAG = "Notes";
// 定义笔记类型的常量
public static final int TYPE_NOTE = 0;
// 定义文件夹类型的常量
public static final int TYPE_FOLDER = 1;
// 定义系统类型的常量
public static final int TYPE_SYSTEM = 2;
/**
* ID
* {@link Notes#ID_ROOT_FOLDER }
* {@link Notes#ID_TEMPARAY_FOLDER }
* {@link Notes#ID_CALL_RECORD_FOLDER}
*/
// 根文件夹的 ID
public static final int ID_ROOT_FOLDER = 0;
// 临时文件夹的 ID
public static final int ID_TEMPARAY_FOLDER = -1;
// 通话记录文件夹的 ID
public static final int ID_CALL_RECORD_FOLDER = -2;
// 回收站文件夹的 ID
public static final int ID_TRASH_FOLER = -3;
// 定义一些用于 Intent 传递数据的键
public static final String INTENT_EXTRA_ALERT_DATE = "net.micode.notes.alert_date";
public static final String INTENT_EXTRA_BACKGROUND_ID = "net.micode.notes.background_color_id";
public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_id";
public static final String INTENT_EXTRA_WIDGET_TYPE = "net.micode.notes.widget_type";
public static final String INTENT_EXTRA_FOLDER_ID = "net.micode.notes.folder_id";
public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date";
// 定义无效的小部件类型常量
public static final int TYPE_WIDGET_INVALIDE = -1;
// 定义 2x 大小的小部件类型常量
public static final int TYPE_WIDGET_2X = 0;
// 定义 4x 大小的小部件类型常量
public static final int TYPE_WIDGET_4X = 1;
// 定义一个内部静态类,用于存储数据相关的常量
public static class DataConstants {
// 文本笔记的 MIME 类型
public static final String NOTE = TextNote.CONTENT_ITEM_TYPE;
// 通话笔记的 MIME 类型
public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE;
}
/**
* Uri
*/
// 定义查询所有笔记和文件夹的 Uri
public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note");
/**
* Uri
*/
// 定义查询数据的 Uri
public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data");
// 定义一个接口,用于存储笔记相关的列名
public interface NoteColumns {
/**
* ID
* <P> (long) </P>
*/
public static final String ID = "_id";
/**
* ID
* <P> (long) </P>
*/
public static final String PARENT_ID = "parent_id";
/**
*
* <P> (long) </P>
*/
public static final String CREATED_DATE = "created_date";
/**
*
* <P> (long) </P>
*/
public static final String MODIFIED_DATE = "modified_date";
/**
*
* <P> (long) </P>
*/
public static final String ALERTED_DATE = "alert_date";
/**
*
* <P> </P>
*/
public static final String SNIPPET = "snippet";
/**
* ID
* <P> (long) </P>
*/
public static final String WIDGET_ID = "widget_id";
/**
*
* <P> (long) </P>
*/
public static final String WIDGET_TYPE = "widget_type";
/**
* ID
* <P> (long) </P>
*/
public static final String BG_COLOR_ID = "bg_color_id";
/**
*
* <P> </P>
*/
public static final String HAS_ATTACHMENT = "has_attachment";
/**
*
* <P> (long) </P>
*/
public static final String NOTES_COUNT = "notes_count";
/**
*
* <P> </P>
*/
public static final String TYPE = "type";
/**
* ID
* <P> (long) </P>
*/
public static final String SYNC_ID = "sync_id";
/**
*
* <P> </P>
*/
public static final String LOCAL_MODIFIED = "local_modified";
/**
* ID
* <P> </P>
*/
public static final String ORIGIN_PARENT_ID = "origin_parent_id";
/**
* gtask ID
* <P> </P>
*/
public static final String GTASK_ID = "gtask_id";
/**
*
* <P> (long) </P>
*/
public static final String VERSION = "version";
}
// 定义一个接口,用于存储数据相关的列名
public interface DataColumns {
/**
* ID
* <P> (long) </P>
*/
public static final String ID = "_id";
/**
* MIME
* <P> </P>
*/
public static final String MIME_TYPE = "mime_type";
/**
* ID
* <P> (long) </P>
*/
public static final String NOTE_ID = "note_id";
/**
*
* <P> (long) </P>
*/
public static final String CREATED_DATE = "created_date";
/**
*
* <P> (long) </P>
*/
public static final String MODIFIED_DATE = "modified_date";
/**
*
* <P> </P>
*/
public static final String CONTENT = "content";
/**
* {@link #MIMETYPE}
* <P> </P>
*/
public static final String DATA1 = "data1";
/**
* {@link #MIMETYPE}
* <P> </P>
*/
public static final String DATA2 = "data2";
/**
* {@link #MIMETYPE}
* <P> </P>
*/
public static final String DATA3 = "data3";
/**
* {@link #MIMETYPE}
* <P> </P>
*/
public static final String DATA4 = "data4";
/**
* {@link #MIMETYPE}
* <P> </P>
*/
public static final String DATA5 = "data5";
}
// 定义一个静态内部类,用于表示文本笔记
public static final class TextNote implements DataColumns {
/**
* checklist
* <P> 1checklist 0 </P>
*/
public static final String MODE = DATA1;
// checklist 模式的常量值
public static final int MODE_CHECK_LIST = 1;
// 文本笔记的内容类型(用于 ContentProvider
public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note";
// 文本笔记的单个项目内容类型(用于 ContentProvider
public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note";
// 文本笔记的 Uri
public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note");
}
// 定义一个静态内部类,用于表示通话笔记
public static final class CallNote implements DataColumns {
/**
*
* <P> (long) </P>
*/
public static final String CALL_DATE = DATA1;
/**
*
* <P> </P>
*/
public static final String PHONE_NUMBER = DATA3;
// 通话笔记的内容类型(用于 ContentProvider
public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note";
// 通话笔记的单个项目内容类型(用于 ContentProvider
public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note";
// 通话笔记的 Uri
public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note");
}
}

@ -0,0 +1,281 @@
/*
* 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; // 用于管理 SQLite 数据库的类
import android.database.sqlite.SQLiteOpenHelper; // 用于创建和管理 SQLite 数据库版本的辅助类
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," + // 唯一标识列,整数类型,主键
NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + // 父 ID 列,整数类型,默认值为 0
NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," + // 提醒日期列,整数类型,默认值为 0
NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," + // 背景颜色 ID 列,整数类型,默认值为 0
NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + // 创建日期列,整数类型,默认值为当前时间戳(毫秒)
NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," + // 是否有附件列,整数类型,默认值为 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 ''," + // 文件夹名称或笔记文本内容列,文本类型,默认值为空字符串
NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," + // 文件类型列,整数类型,默认值为 0
NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," + // 小部件 ID 列,整数类型,默认值为 0
NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," + // 小部件类型列,整数类型,默认值为 -1
NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," + // 同步 ID 列,整数类型,默认值为 0
NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," + // 本地修改标志列,整数类型,默认值为 0
NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + // 移动到临时文件夹之前的原始父 ID 列,整数类型,默认值为 0
NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," + // gtask ID 列,文本类型,默认值为空字符串
NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" + // 版本号列,整数类型,默认值为 0
")";
// 创建数据表的 SQL 语句
private static final String CREATE_DATA_TABLE_SQL =
"CREATE TABLE " + TABLE.DATA + "(" +
DataColumns.ID + " INTEGER PRIMARY KEY," + // 唯一标识列,整数类型,主键
DataColumns.MIME_TYPE + " TEXT NOT NULL," + // MIME 类型列,文本类型,不能为空
DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," + // 所属笔记 ID 列,整数类型,默认值为 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," + // 通用数据列 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文本类型默认值为空字符串
")";
// 创建数据表里 note_id 索引的 SQL 语句
private static final String CREATE_DATA_NOTE_ID_INDEX_SQL =
"CREATE INDEX IF NOT EXISTS note_id_index ON " +
TABLE.DATA + "(" + DataColumns.NOTE_ID + ");";
// 当将笔记移动到文件夹时,增加文件夹的笔记数量的触发器 SQL 语句
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 +
" BEGIN " +
" UPDATE " + TABLE.NOTE +
" SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" +
" WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" +
" END";
// 当将笔记从文件夹移出时,减少文件夹的笔记数量的触发器 SQL 语句
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 +
" 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";
// 当插入新笔记到文件夹时,增加文件夹的笔记数量的触发器 SQL 语句
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" +
" WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" +
" END";
// 当从文件夹删除笔记时,减少文件夹的笔记数量的触发器 SQL 语句
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" +
" WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID +
" AND " + NoteColumns.NOTES_COUNT + ">0;" +
" END";
// 当插入类型为 {@link DataConstants#NOTE} 的数据时,更新笔记内容的触发器 SQL 语句
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 + "'" +
" BEGIN" +
" UPDATE " + TABLE.NOTE +
" SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT +
" WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" +
" END";
// 当类型为 {@link DataConstants#NOTE} 的数据发生变化时,更新笔记内容的触发器 SQL 语句
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 + "'" +
" BEGIN" +
" UPDATE " + TABLE.NOTE +
" SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT +
" WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" +
" END";
// 当类型为 {@link DataConstants#NOTE} 的数据被删除时,更新笔记内容的触发器 SQL 语句
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 + "'" +
" BEGIN" +
" UPDATE " + TABLE.NOTE +
" SET " + NoteColumns.SNIPPET + "=''" +
" WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" +
" END";
// 当删除笔记时,删除该笔记所属数据的触发器 SQL 语句
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";
// 当删除文件夹时,删除该文件夹下所有笔记的触发器 SQL 语句
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";
// 当文件夹被移动到回收站时,移动该文件夹下所有笔记的触发器 SQL 语句
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) {
db.execSQL(CREATE_NOTE_TABLE_SQL); // 执行创建笔记表的 SQL 语句
reCreateNoteTableTriggers(db); // 重新创建笔记表的触发器
createSystemFolder(db); // 创建系统文件夹
Log.d(TAG, "note table has been created"); // 记录日志,表明笔记表已创建
}
// 重新创建笔记表触发器的方法
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);
}
// 创建系统文件夹的方法
private void createSystemFolder(SQLiteDatabase db) {
ContentValues values = new ContentValues(); // 创建一个 ContentValues 对象,用于存储要插入的数据
// 创建通话记录文件夹
values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER);
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
db.insert(TABLE.NOTE, null, values);
// 创建根文件夹
values.clear(); // 清空 ContentValues 对象
values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER);
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
db.insert(TABLE.NOTE, null, values);
// 创建临时文件夹
values.clear();
values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER);
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
db.insert(TABLE.NOTE, null, values);
// 创建回收站文件夹
values.clear();
values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER);
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
db.insert(TABLE.NOTE, null, values);
}
// 创建数据表的方法
public void createDataTable(SQLiteDatabase db) {
db.execSQL(CREATE_DATA_TABLE_SQL); // 执行创建数据表的 SQL 语句
reCreateDataTableTriggers(db); // 重新创建数据表的触发器
db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL); // 执行创建数据表里 note_id 索引的 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);
db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER);
db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER);
}
// 获取单例实例的方法
static synchronized NotesDatabaseHelper get

@ -0,0 +1,377 @@
/*
* Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net)
*
* Apache 2.0
* 使
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
*
*
*
*/
package net.micode.notes.data;
import android.app.SearchManager; // 用于管理搜索功能的类
import android.content.ContentProvider; // 用于在不同的应用程序之间共享数据的抽象类
import android.content.ContentUris; // 用于操作包含 ID 的 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; // 用于表示统一资源标识符
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 的类,用于提供笔记数据的访问
public class NotesProvider extends ContentProvider {
// 用于匹配 Uri 的 UriMatcher 实例
private static final UriMatcher mMatcher;
// 数据库帮助类的实例
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; // 匹配搜索建议的 Uri
// 静态代码块,用于初始化 UriMatcher
static {
mMatcher = new UriMatcher(UriMatcher.NO_MATCH);
// 添加匹配查询所有笔记的 Uri
mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE);
// 添加匹配查询单个笔记的 Uri其中 # 表示匹配一个数字(笔记的 ID
mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM);
// 添加匹配查询所有数据的 Uri
mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA);
// 添加匹配查询单个数据的 Uri其中 # 表示匹配一个数字(数据的 ID
mMatcher.addURI(Notes.AUTHORITY, "data/#", URI_DATA_ITEM);
// 添加匹配搜索的 Uri
mMatcher.addURI(Notes.AUTHORITY, "search", URI_SEARCH);
// 添加匹配搜索建议的 Uri其中 SearchManager.SUGGEST_URI_PATH_QUERY 是搜索建议路径的常量
mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY, URI_SEARCH_SUGGEST);
// 添加匹配带参数的搜索建议的 Uri
mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY + "/*", URI_SEARCH_SUGGEST);
}
/**
* x'0A' sqlite '\n'
* '\n' 便
*/
// 定义搜索投影的 SQL 语句,用于搜索结果的列选择
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 查询语句
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;
// 初始化 ContentProvider 时调用的方法
@Override
public boolean onCreate() {
// 获取数据库帮助类的实例
mHelper = NotesDatabaseHelper.getInstance(getContext());
return true;
}
// 处理查询请求的方法
@Override
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,
String sortOrder) {
Cursor c = null;
// 获取可读的数据库实例
SQLiteDatabase db = mHelper.getReadableDatabase();
String id = null;
// 根据 Uri 匹配结果进行不同的查询操作
switch (mMatcher.match(uri)) {
case URI_NOTE:
// 查询所有笔记
c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null,
sortOrder);
break;
case URI_NOTE_ITEM:
// 获取 Uri 中笔记的 ID
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:
// 获取 Uri 中数据的 ID
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;
// 如果是搜索建议的 Uri获取搜索字符串
if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) {
if (uri.getPathSegments().size() > 1) {
searchString = uri.getPathSegments().get(1);
}
} else {
// 如果是搜索的 Uri从查询参数中获取搜索字符串
searchString = uri.getQueryParameter("pattern");
}
// 如果搜索字符串为空,返回 null
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:
// 如果 Uri 不匹配任何已知模式,抛出异常
throw new IllegalArgumentException("Unknown URI " + uri);
}
// 如果查询结果不为空,设置通知 Uri
if (c!= null) {
c.setNotificationUri(getContext().getContentResolver(), uri);
}
return c;
}
// 处理插入请求的方法
@Override
public Uri insert(Uri uri, ContentValues values) {
// 获取可写的数据库实例
SQLiteDatabase db = mHelper.getWritableDatabase();
long dataId = 0, noteId = 0, insertedId = 0;
// 根据 Uri 匹配结果进行不同的插入操作
switch (mMatcher.match(uri)) {
case URI_NOTE:
// 插入笔记
insertedId = noteId = db.insert(TABLE.NOTE, null, values);
break;
case URI_DATA:
// 如果 ContentValues 中包含所属笔记的 ID
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:
// 如果 Uri 不匹配任何已知模式,抛出异常
throw new IllegalArgumentException("Unknown URI " + uri);
}
// 如果插入了笔记,通知笔记 Uri 发生变化
if (noteId > 0) {
getContext().getContentResolver().notifyChange(
ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null);
}
// 如果插入了数据,通知数据 Uri 发生变化
if (dataId > 0) {
getContext().getContentResolver().notifyChange(
ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null);
}
// 返回插入数据的 Uri
return ContentUris.withAppendedId(uri, insertedId);
}
// 处理删除请求的方法
@Override
public int delete(Uri uri, String selection, String[] selectionArgs) {
int count = 0;
String id = null;
// 获取可写的数据库实例
SQLiteDatabase db = mHelper.getWritableDatabase();
boolean deleteData = false;
// 根据 Uri 匹配结果进行不同的删除操作
switch (mMatcher.match(uri)) {
case URI_NOTE:
// 添加条件,确保只删除 ID 大于 0 的笔记
selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 ";
// 删除笔记
count = db.delete(TABLE.NOTE, selection, selectionArgs);
break;
case URI_NOTE_ITEM:
// 获取 Uri 中笔记的 ID
id = uri.getPathSegments().get(1);
// 检查 ID 是否小于等于 0系统文件夹不允许删除
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:
// 获取 Uri 中数据的 ID
id = uri.getPathSegments().get(1);
// 删除单个数据
count = db.delete(TABLE.DATA,
DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs);
deleteData = true;
break;
default:
// 如果 Uri 不匹配任何已知模式,抛出异常
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);
}
return count;
}
// 处理更新请求的方法
@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;
// 根据 Uri 匹配结果进行不同的更新操作
switch (mMatcher.match(uri)) {
case URI_NOTE:
// 增加笔记的版本号
increaseNoteVersion(-1, selection, selectionArgs);
// 更新笔记
count = db.update(TABLE.NOTE, values, selection, selectionArgs);
break;
case URI_NOTE_ITEM:
// 获取 Uri 中笔记的 ID
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:
// 获取 Uri 中数据的 ID
id = uri.getPathSegments().get(1);
// 更新单个数据
count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs);
updateData = true;
break;
default:
// 如果 Uri 不匹配任何已知模式,抛出异常
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);
}
return count;
}
// 解析查询条件的方法
private String parseSelection(String selection) {
// 如果查询条件不为空,添加 AND 关键字并包裹查询条件
return (!TextUtils.isEmpty(selection)? " AND (" + selection + ')' : "");
}
// 增加笔记版本号的方法
private void increaseNoteVersion(long id, String selection, String[] selectionArgs) {
// 创建 SQL 语句构建器
StringBuilder sql = new StringBuilder(120);
// 添加更新表名
sql.append("UPDATE ");
sql.append(TABLE.NOTE);
// 添加更新的列和操作,将版本号加 1
sql.append(" SET ");
sql.append(NoteColumns.VERSION);
sql.append("=" + NoteColumns.VERSION + "+1 ");
// 如果有指定的 ID 或查询条件,添加 WHERE 子句
if (id > 0 ||!TextUtils.isEmpty(selection)) {
sql.append(" WHERE ");
}
// 如果有指定的 ID添加 ID 条件
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);
}
// 执行 SQL 语句
mHelper.getWritableDatabase().execSQL(sql.toString());
}
// 获取 Uri 对应的 MIME 类型的方法,暂时未实现
@Override
public String getType(Uri uri) {
// TODO Auto-generated method stub
return null;
}
}

@ -0,0 +1,257 @@
/*
* Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net)
*
* Apache 2.0
* 使
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
*
*
*
*/
package net.micode.notes.gtask.data;
import android.content.ContentResolver; // 用于与 ContentProvider 进行交互的类
import android.content.ContentUris; // 用于操作包含 ID 的 Uri 的工具类
import android.content.ContentValues; // 用于存储一组键值对,通常用于插入或更新数据库记录
import android.content.Context; // 提供对应用程序环境的全局信息访问
import android.database.Cursor; // 用于遍历查询结果集的类
import android.net.Uri; // 用于表示统一资源标识符
import android.util.Log; // 用于记录日志信息的类
import net.micode.notes.data.Notes; // 导入与笔记相关的类
import net.micode.notes.data.Notes.DataColumns; // 导入数据列相关的接口
import net.micode.notes.data.Notes.DataConstants; // 导入数据常量相关的类
import net.micode.notes.data.Notes.NoteColumns; // 导入笔记列相关的接口
import net.micode.notes.data.NotesDatabaseHelper.TABLE; // 导入数据库表名相关的接口
import net.micode.notes.gtask.exception.ActionFailureException; // 导入自定义的异常类
import org.json.JSONException; // 用于处理 JSON 异常的类
import org.json.JSONObject; // 用于处理 JSON 对象的类
// SqlData 类用于处理与 SQLite 数据库中数据相关的操作
public class SqlData {
// 用于日志记录的标签,使用类的简单名称
private static final String TAG = SqlData.class.getSimpleName();
// 定义无效的 ID 值
private static final int INVALID_ID = -99999;
// 定义查询数据时使用的投影列
public static final String[] PROJECTION_DATA = new String[] {
DataColumns.ID, // 数据的唯一标识
DataColumns.MIME_TYPE, // 数据的 MIME 类型
DataColumns.CONTENT, // 数据的内容
DataColumns.DATA1, // 通用数据列 1
DataColumns.DATA3 // 通用数据列 3
};
// 定义投影列中数据 ID 所在的索引
public static final int DATA_ID_COLUMN = 0;
// 定义投影列中数据 MIME 类型所在的索引
public static final int DATA_MIME_TYPE_COLUMN = 1;
// 定义投影列中数据内容所在的索引
public static final int DATA_CONTENT_COLUMN = 2;
// 定义投影列中数据通用列 1 所在的索引
public static final int DATA_CONTENT_DATA_1_COLUMN = 3;
// 定义投影列中数据通用列 3 所在的索引
public static final int DATA_CONTENT_DATA_3_COLUMN = 4;
// 用于与 ContentProvider 进行交互的 ContentResolver 对象
private ContentResolver mContentResolver;
// 表示是否为创建操作的标志
private boolean mIsCreate;
// 数据的 ID
private long mDataId;
// 数据的 MIME 类型
private String mDataMimeType;
// 数据的内容
private String mDataContent;
// 数据通用列 1 的值
private long mDataContentData1;
// 数据通用列 3 的值
private String mDataContentData3;
// 用于存储数据差异的 ContentValues 对象
private ContentValues mDiffDataValues;
// 构造函数,用于创建一个新的 SqlData 对象,通常用于创建新的数据记录
public SqlData(Context context) {
// 获取应用程序的 ContentResolver
mContentResolver = context.getContentResolver();
// 标记为创建操作
mIsCreate = true;
// 初始化数据 ID 为无效值
mDataId = INVALID_ID;
// 设置默认的 MIME 类型
mDataMimeType = DataConstants.NOTE;
// 设置默认的数据内容
mDataContent = "";
// 设置默认的数据通用列 1 的值
mDataContentData1 = 0;
// 设置默认的数据通用列 3 的值
mDataContentData3 = "";
// 初始化用于存储数据差异的 ContentValues 对象
mDiffDataValues = new ContentValues();
}
// 构造函数,用于从 Cursor 中加载数据,通常用于从数据库中读取已有的数据记录
public SqlData(Context context, Cursor c) {
// 获取应用程序的 ContentResolver
mContentResolver = context.getContentResolver();
// 标记为非创建操作
mIsCreate = false;
// 从 Cursor 中加载数据
loadFromCursor(c);
// 初始化用于存储数据差异的 ContentValues 对象
mDiffDataValues = new ContentValues();
}
// 从 Cursor 中加载数据的私有方法
private void loadFromCursor(Cursor c) {
// 从 Cursor 中获取数据的 ID
mDataId = c.getLong(DATA_ID_COLUMN);
// 从 Cursor 中获取数据的 MIME 类型
mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN);
// 从 Cursor 中获取数据的内容
mDataContent = c.getString(DATA_CONTENT_COLUMN);
// 从 Cursor 中获取数据通用列 1 的值
mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN);
// 从 Cursor 中获取数据通用列 3 的值
mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN);
}
// 根据 JSON 对象设置数据内容的方法
public void setContent(JSONObject js) throws JSONException {
// 从 JSON 对象中获取数据 ID如果不存在则使用无效 ID
long dataId = js.has(DataColumns.ID)? js.getLong(DataColumns.ID) : INVALID_ID;
// 如果是创建操作或者当前数据 ID 与 JSON 中的数据 ID 不一致
if (mIsCreate || mDataId!= dataId) {
// 将数据 ID 放入差异值中
mDiffDataValues.put(DataColumns.ID, dataId);
}
// 更新当前数据 ID
mDataId = dataId;
// 从 JSON 对象中获取数据 MIME 类型,如果不存在则使用默认值
String dataMimeType = js.has(DataColumns.MIME_TYPE)? js.getString(DataColumns.MIME_TYPE)
: DataConstants.NOTE;
// 如果是创建操作或者当前 MIME 类型与 JSON 中的 MIME 类型不一致
if (mIsCreate ||!mDataMimeType.equals(dataMimeType)) {
// 将数据 MIME 类型放入差异值中
mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType);
}
// 更新当前数据 MIME 类型
mDataMimeType = dataMimeType;
// 从 JSON 对象中获取数据内容,如果不存在则使用空字符串
String dataContent = js.has(DataColumns.CONTENT)? js.getString(DataColumns.CONTENT) : "";
// 如果是创建操作或者当前数据内容与 JSON 中的数据内容不一致
if (mIsCreate ||!mDataContent.equals(dataContent)) {
// 将数据内容放入差异值中
mDiffDataValues.put(DataColumns.CONTENT, dataContent);
}
// 更新当前数据内容
mDataContent = dataContent;
// 从 JSON 对象中获取数据通用列 1 的值,如果不存在则使用 0
long dataContentData1 = js.has(DataColumns.DATA1)? js.getLong(DataColumns.DATA1) : 0;
// 如果是创建操作或者当前数据通用列 1 的值与 JSON 中的值不一致
if (mIsCreate || mDataContentData1!= dataContentData1) {
// 将数据通用列 1 的值放入差异值中
mDiffDataValues.put(DataColumns.DATA1, dataContentData1);
}
// 更新当前数据通用列 1 的值
mDataContentData1 = dataContentData1;
// 从 JSON 对象中获取数据通用列 3 的值,如果不存在则使用空字符串
String dataContentData3 = js.has(DataColumns.DATA3)? js.getString(DataColumns.DATA3) : "";
// 如果是创建操作或者当前数据通用列 3 的值与 JSON 中的值不一致
if (mIsCreate ||!mDataContentData3.equals(dataContentData3)) {
// 将数据通用列 3 的值放入差异值中
mDiffDataValues.put(DataColumns.DATA3, dataContentData3);
}
// 更新当前数据通用列 3 的值
mDataContentData3 = dataContentData3;
}
// 获取当前数据内容的 JSON 对象的方法
public JSONObject getContent() throws JSONException {
// 如果是创建操作,说明数据可能还未存入数据库,记录错误日志并返回 null
if (mIsCreate) {
Log.e(TAG, "it seems that we haven't created this in database yet");
return null;
}
// 创建一个新的 JSON 对象
JSONObject js = new JSONObject();
// 将数据 ID 放入 JSON 对象中
js.put(DataColumns.ID, mDataId);
// 将数据 MIME 类型放入 JSON 对象中
js.put(DataColumns.MIME_TYPE, mDataMimeType);
// 将数据内容放入 JSON 对象中
js.put(DataColumns.CONTENT, mDataContent);
// 将数据通用列 1 的值放入 JSON 对象中
js.put(DataColumns.DATA1, mDataContentData1);
// 将数据通用列 3 的值放入 JSON 对象中
js.put(DataColumns.DATA3, mDataContentData3);
// 返回包含数据内容的 JSON 对象
return js;
}
// 提交数据到数据库的方法
public void commit(long noteId, boolean validateVersion, long version) {
// 如果是创建操作
if (mIsCreate) {
// 如果数据 ID 为无效值且差异值中包含数据 ID移除差异值中的数据 ID
if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) {
mDiffDataValues.remove(DataColumns.ID);
}
// 将所属笔记的 ID 放入差异值中
mDiffDataValues.put(DataColumns.NOTE_ID, noteId);
// 向 ContentProvider 插入数据
Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues);
try {
// 从插入操作返回的 Uri 中获取数据的 ID
mDataId = Long.valueOf(uri.getPathSegments().get(1));
} catch (NumberFormatException e) {
// 如果获取数据 ID 时发生异常,记录错误日志并抛出异常
Log.e(TAG, "Get note id error :" + e.toString());
throw new ActionFailureException("create note failed");
}
} else {
// 如果差异值中有数据需要更新
if (mDiffDataValues.size() > 0) {
int result = 0;
// 如果不需要验证版本
if (!validateVersion) {
// 更新数据
result = mContentResolver.update(ContentUris.withAppendedId(
Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null);
} else {
// 更新数据,并添加版本验证条件
result = mContentResolver.update(ContentUris.withAppendedId(
Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues,
"? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE
+ " WHERE " + NoteColumns.VERSION + "=?)", new String[] {
String.valueOf(noteId), String.valueOf(version)
});
}
// 如果更新结果为 0说明可能没有更新记录警告日志
if (result == 0) {
Log.w(TAG, "there is no update. maybe user updates note when syncing");
}
}
}
// 清空差异值
mDiffDataValues.clear();
// 标记为非创建操作
mIsCreate = false;
}
// 获取数据 ID 的方法
public long getId() {
return mDataId;
}
}

@ -0,0 +1,350 @@
/*
* Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net)
*
* Apache 2.0
* 使
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
*
*
*
*/
package net.micode.notes.gtask.data;
import android.appwidget.AppWidgetManager; // 用于管理应用小部件的类
import android.content.ContentResolver; // 用于与 ContentProvider 进行交互的类
import android.content.ContentValues; // 用于存储一组键值对,通常用于插入或更新数据库记录
import android.content.Context; // 提供对应用程序环境的全局信息访问
import android.database.Cursor; // 用于遍历查询结果集的类
import android.net.Uri; // 用于表示统一资源标识符
import android.util.Log; // 用于记录日志信息的类
import net.micode.notes.data.Notes; // 导入与笔记相关的类
import net.micode.notes.data.Notes.DataColumns; // 导入数据列相关的接口
import net.micode.notes.data.Notes.NoteColumns; // 导入笔记列相关的接口
import net.micode.notes.gtask.exception.ActionFailureException; // 导入自定义的异常类
import net.micode.notes.tool.GTaskStringUtils; // 导入与 GTask 字符串处理相关的工具类
import net.micode.notes.tool.ResourceParser; // 导入资源解析工具类
import org.json.JSONArray; // 用于处理 JSON 数组的类
import org.json.JSONException; // 用于处理 JSON 异常的类
import org.json.JSONObject; // 用于处理 JSON 对象的类
import java.util.ArrayList; // 用于处理动态数组的类
// SqlNote 类用于处理与 SQLite 数据库中笔记相关的操作
public class SqlNote {
// 用于日志记录的标签,使用类的简单名称
private static final String TAG = SqlNote.class.getSimpleName();
// 定义无效的 ID 值
private static final int INVALID_ID = -99999;
// 定义查询笔记时使用的投影列
public static final String[] PROJECTION_NOTE = new String[] {
NoteColumns.ID, // 笔记的唯一标识
NoteColumns.ALERTED_DATE, // 提醒日期
NoteColumns.BG_COLOR_ID, // 背景颜色 ID
NoteColumns.CREATED_DATE, // 创建日期
NoteColumns.HAS_ATTACHMENT, // 是否有附件
NoteColumns.MODIFIED_DATE, // 修改日期
NoteColumns.NOTES_COUNT, // 子笔记数量
NoteColumns.PARENT_ID, // 父笔记 ID
NoteColumns.SNIPPET, // 摘要
NoteColumns.TYPE, // 笔记类型
NoteColumns.WIDGET_ID, // 小部件 ID
NoteColumns.WIDGET_TYPE, // 小部件类型
NoteColumns.SYNC_ID, // 同步 ID
NoteColumns.LOCAL_MODIFIED, // 本地修改标识
NoteColumns.ORIGIN_PARENT_ID, // 原始父笔记 ID
NoteColumns.GTASK_ID, // GTask ID
NoteColumns.VERSION // 版本号
};
// 定义投影列中笔记 ID 所在的索引
public static final int ID_COLUMN = 0;
// 定义投影列中提醒日期所在的索引
public static final int ALERTED_DATE_COLUMN = 1;
// 定义投影列中背景颜色 ID 所在的索引
public static final int BG_COLOR_ID_COLUMN = 2;
// 定义投影列中创建日期所在的索引
public static final int CREATED_DATE_COLUMN = 3;
// 定义投影列中是否有附件所在的索引
public static final int HAS_ATTACHMENT_COLUMN = 4;
// 定义投影列中修改日期所在的索引
public static final int MODIFIED_DATE_COLUMN = 5;
// 定义投影列中子笔记数量所在的索引
public static final int NOTES_COUNT_COLUMN = 6;
// 定义投影列中父笔记 ID 所在的索引
public static final int PARENT_ID_COLUMN = 7;
// 定义投影列中摘要所在的索引
public static final int SNIPPET_COLUMN = 8;
// 定义投影列中笔记类型所在的索引
public static final int TYPE_COLUMN = 9;
// 定义投影列中小部件 ID 所在的索引
public static final int WIDGET_ID_COLUMN = 10;
// 定义投影列中小部件类型所在的索引
public static final int WIDGET_TYPE_COLUMN = 11;
// 定义投影列中同步 ID 所在的索引
public static final int SYNC_ID_COLUMN = 12;
// 定义投影列中本地修改标识所在的索引
public static final int LOCAL_MODIFIED_COLUMN = 13;
// 定义投影列中原始父笔记 ID 所在的索引
public static final int ORIGIN_PARENT_ID_COLUMN = 14;
// 定义投影列中 GTask ID 所在的索引
public static final int GTASK_ID_COLUMN = 15;
// 定义投影列中版本号所在的索引
public static final int VERSION_COLUMN = 16;
// 应用程序上下文
private Context mContext;
// 用于与 ContentProvider 进行交互的 ContentResolver 对象
private ContentResolver mContentResolver;
// 表示是否为创建操作的标志
private boolean mIsCreate;
// 笔记的 ID
private long mId;
// 提醒日期
private long mAlertDate;
// 背景颜色 ID
private int mBgColorId;
// 创建日期
private long mCreatedDate;
// 是否有附件
private int mHasAttachment;
// 修改日期
private long mModifiedDate;
// 父笔记 ID
private long mParentId;
// 摘要
private String mSnippet;
// 笔记类型
private int mType;
// 小部件 ID
private int mWidgetId;
// 小部件类型
private int mWidgetType;
// 原始父笔记 ID
private long mOriginParent;
// 版本号
private long mVersion;
// 用于存储笔记差异的 ContentValues 对象
private ContentValues mDiffNoteValues;
// 用于存储笔记关联数据的列表
private ArrayList<SqlData> mDataList;
// 构造函数,用于创建一个新的 SqlNote 对象,通常用于创建新的笔记记录
public SqlNote(Context context) {
mContext = context;
mContentResolver = context.getContentResolver();
mIsCreate = true;
mId = INVALID_ID;
mAlertDate = 0;
mBgColorId = ResourceParser.getDefaultBgId(context); // 获取默认背景颜色 ID
mCreatedDate = System.currentTimeMillis(); // 设置当前时间为创建日期
mHasAttachment = 0;
mModifiedDate = System.currentTimeMillis(); // 设置当前时间为修改日期
mParentId = 0;
mSnippet = "";
mType = Notes.TYPE_NOTE; // 默认笔记类型为普通笔记
mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID; // 无效的小部件 ID
mWidgetType = Notes.TYPE_WIDGET_INVALIDE; // 无效的小部件类型
mOriginParent = 0;
mVersion = 0;
mDiffNoteValues = new ContentValues();
mDataList = new ArrayList<SqlData>();
}
// 构造函数,用于从 Cursor 中加载数据,通常用于从数据库中读取已有的笔记记录
public SqlNote(Context context, Cursor c) {
mContext = context;
mContentResolver = context.getContentResolver();
mIsCreate = false;
loadFromCursor(c);
mDataList = new ArrayList<SqlData>();
if (mType == Notes.TYPE_NOTE)
loadDataContent(); // 如果是普通笔记,加载关联数据
mDiffNoteValues = new ContentValues();
}
// 构造函数,根据给定的笔记 ID 从数据库加载数据
public SqlNote(Context context, long id) {
mContext = context;
mContentResolver = context.getContentResolver();
mIsCreate = false;
loadFromCursor(id);
mDataList = new ArrayList<SqlData>();
if (mType == Notes.TYPE_NOTE)
loadDataContent();
mDiffNoteValues = new ContentValues();
}
// 根据笔记 ID 从数据库查询并加载数据的私有方法
private void loadFromCursor(long id) {
Cursor c = null;
try {
// 使用 ContentResolver 查询指定 ID 的笔记
c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)",
new String[] {
String.valueOf(id)
}, null);
if (c!= null) {
c.moveToNext();
loadFromCursor(c); // 调用另一个 loadFromCursor 方法处理查询结果
} else {
Log.w(TAG, "loadFromCursor: cursor = null"); // 如果查询结果为空,记录警告日志
}
} finally {
if (c!= null)
c.close(); // 关闭 Cursor释放资源
}
}
// 从 Cursor 中加载笔记数据的私有方法
private void loadFromCursor(Cursor c) {
mId = c.getLong(ID_COLUMN);
mAlertDate = c.getLong(ALERTED_DATE_COLUMN);
mBgColorId = c.getInt(BG_COLOR_ID_COLUMN);
mCreatedDate = c.getLong(CREATED_DATE_COLUMN);
mHasAttachment = c.getInt(HAS_ATTACHMENT_COLUMN);
mModifiedDate = c.getLong(MODIFIED_DATE_COLUMN);
mParentId = c.getLong(PARENT_ID_COLUMN);
mSnippet = c.getString(SNIPPET_COLUMN);
mType = c.getInt(TYPE_COLUMN);
mWidgetId = c.getInt(WIDGET_ID_COLUMN);
mWidgetType = c.getInt(WIDGET_TYPE_COLUMN);
mVersion = c.getLong(VERSION_COLUMN);
}
// 加载笔记关联数据的私有方法
private void loadDataContent() {
Cursor c = null;
mDataList.clear(); // 清空原有的数据列表
try {
// 使用 ContentResolver 查询与当前笔记关联的数据
c = mContentResolver.query(Notes.CONTENT_DATA_URI, SqlData.PROJECTION_DATA,
"(note_id=?)", new String[] {
String.valueOf(mId)
}, null);
if (c!= null) {
if (c.getCount() == 0) {
Log.w(TAG, "it seems that the note has not data"); // 如果没有关联数据,记录警告日志
return;
}
while (c.moveToNext()) {
SqlData data = new SqlData(mContext, c); // 根据查询结果创建 SqlData 对象
mDataList.add(data); // 将创建的 SqlData 对象添加到列表中
}
} else {
Log.w(TAG, "loadDataContent: cursor = null"); // 如果查询结果为空,记录警告日志
}
} finally {
if (c!= null)
c.close(); // 关闭 Cursor释放资源
}
}
// 根据 JSON 对象设置笔记内容的方法
public boolean setContent(JSONObject js) {
try {
// 从 JSON 对象中获取笔记部分的内容
JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) {
Log.w(TAG, "cannot set system folder"); // 如果是系统文件夹,记录警告日志
} else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) {
// 对于文件夹,只能更新摘要和类型
String snippet = note.has(NoteColumns.SNIPPET)? note
.getString(NoteColumns.SNIPPET) : "";
if (mIsCreate ||!mSnippet.equals(snippet)) {
mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); // 将摘要差异放入 ContentValues
}
mSnippet = snippet;
int type = note.has(NoteColumns.TYPE)? note.getInt(NoteColumns.TYPE)
: Notes.TYPE_NOTE;
if (mIsCreate || mType!= type) {
mDiffNoteValues.put(NoteColumns.TYPE, type); // 将类型差异放入 ContentValues
}
mType = type;
} else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_NOTE) {
JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
long id = note.has(NoteColumns.ID)? note.getLong(NoteColumns.ID) : INVALID_ID;
if (mIsCreate || mId!= id) {
mDiffNoteValues.put(NoteColumns.ID, id); // 将 ID 差异放入 ContentValues
}
mId = id;
long alertDate = note.has(NoteColumns.ALERTED_DATE)? note
.getLong(NoteColumns.ALERTED_DATE) : 0;
if (mIsCreate || mAlertDate!= alertDate) {
mDiffNoteValues.put(NoteColumns.ALERTED_DATE, alertDate); // 将提醒日期差异放入 ContentValues
}
mAlertDate = alertDate;
int bgColorId = note.has(NoteColumns.BG_COLOR_ID)? note
.getInt(NoteColumns.BG_COLOR_ID) : ResourceParser.getDefaultBgId(mContext);
if (mIsCreate || mBgColorId!= bgColorId) {
mDiffNoteValues.put(NoteColumns.BG_COLOR_ID, bgColorId); // 将背景颜色 ID 差异放入 ContentValues
}
mBgColorId = bgColorId;
long createDate = note.has(NoteColumns.CREATED_DATE)? note
.getLong(NoteColumns.CREATED_DATE) : System.currentTimeMillis();
if (mIsCreate || mCreatedDate!= createDate) {
mDiffNoteValues.put(NoteColumns.CREATED_DATE, createDate); // 将创建日期差异放入 ContentValues
}
mCreatedDate = createDate;
int hasAttachment = note.has(NoteColumns.HAS_ATTACHMENT)? note
.getInt(NoteColumns.HAS_ATTACHMENT) : 0;
if (mIsCreate || mHasAttachment!= hasAttachment) {
mDiffNoteValues.put(NoteColumns.HAS_ATTACHMENT, hasAttachment); // 将是否有附件差异放入 ContentValues
}
mHasAttachment = hasAttachment;
long modifiedDate = note.has(NoteColumns.MODIFIED_DATE)? note
.getLong(NoteColumns.MODIFIED_DATE) : System.currentTimeMillis();
if (mIsCreate || mModifiedDate!= modifiedDate) {
mDiffNoteValues.put(NoteColumns.MODIFIED_DATE, modifiedDate); // 将修改日期差异放入 ContentValues
}
mModifiedDate = modifiedDate;
long parentId = note.has(NoteColumns.PARENT_ID)? note
.getLong(NoteColumns.PARENT_ID) : 0;
if (mIsCreate || mParentId!= parentId) {
mDiffNoteValues.put(NoteColumns.PARENT_ID, parentId); // 将父笔记 ID 差异放入 ContentValues
}
mParentId = parentId;
String snippet = note.has(NoteColumns.SNIPPET)? note
.getString(NoteColumns.SNIPPET) : "";
if (mIsCreate ||!mSnippet.equals(snippet)) {
mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); // 将摘要差异放入 ContentValues
}
mSnippet = snippet;
int type = note.has(NoteColumns.TYPE)? note.getInt(NoteColumns.TYPE)
: Notes.TYPE_NOTE;
if (mIsCreate || mType!= type) {
mDiffNoteValues.put(NoteColumns.TYPE, type); // 将笔记类型差异放入 ContentValues
}
mType = type;
int widgetId = note.has(NoteColumns.WIDGET_ID)? note.getInt(NoteColumns.WIDGET_ID)
: AppWidgetManager.INVALID_APPWIDGET_ID;
if (mIsCreate || mWidgetId!= widgetId) {
mDiffNoteValues.put(NoteColumns.WIDGET_ID, widgetId); // 将小部件 ID 差异放入 ContentValues
}
mWidgetId = widgetId;
int widgetType = note.has(NoteColumns.WIDGET_TYPE)? note
.getInt(NoteColumns.WIDGET_TYPE) : Notes.TYPE_WIDGET_INVALIDE;
if (mIsCreate || mWidgetType!= widgetType) {
mDiffNoteValues.put(NoteColumns.WIDGET_TYPE, widgetType); // 将小部件类型差异放入 ContentValues
}
mWidgetType = widgetType;
long originParent = note.has(NoteColumns.ORIGIN_PARENT_ID

@ -0,0 +1,356 @@
/*
* Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net)
*
* Apache 2.0
* 使
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
*
*
*
*/
package net.micode.notes.gtask.data;
import android.database.Cursor;
import android.text.TextUtils;
import android.util.Log;
import net.micode.notes.data.Notes;
import net.micode.notes.data.Notes.DataColumns;
import net.micode.notes.data.Notes.DataConstants;
import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.gtask.exception.ActionFailureException;
import net.micode.notes.tool.GTaskStringUtils;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
// Task 类继承自 Node 类,用于表示任务相关的数据和操作
public class Task extends Node {
// 用于日志记录的标签,使用类的简单名称
private static final String TAG = Task.class.getSimpleName();
// 表示任务是否完成的标志
private boolean mCompleted;
// 任务的备注信息
private String mNotes;
// 任务的元信息,以 JSONObject 形式存储
private JSONObject mMetaInfo;
// 任务的前一个兄弟任务
private Task mPriorSibling;
// 任务所属的任务列表
private TaskList mParent;
// 构造函数,初始化任务的默认状态
public Task() {
super(); // 调用父类的构造函数
mCompleted = false;
mNotes = null;
mPriorSibling = null;
mParent = null;
mMetaInfo = null;
}
// 根据操作 ID 获取创建任务的 JSON 对象
public JSONObject getCreateAction(int actionId) {
JSONObject js = new JSONObject();
try {
// 设置操作类型为创建
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);
// 设置操作 ID
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
// 设置任务在父任务列表中的索引
js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this));
// 设置任务实体的变化信息
JSONObject entity = new JSONObject();
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");
entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_TASK);
if (getNotes()!= null) {
entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes());
}
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
// 设置父任务列表的 ID
js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid());
// 设置目标父任务的类型
js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_GROUP);
// 设置任务列表的 ID
js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid());
// 如果存在前一个兄弟任务,设置其 ID
if (mPriorSibling!= null) {
js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid());
}
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to generate task-create jsonobject");
}
return js;
}
// 根据操作 ID 获取更新任务的 JSON 对象
public JSONObject getUpdateAction(int actionId) {
JSONObject js = new JSONObject();
try {
// 设置操作类型为更新
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE);
// 设置操作 ID
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
// 设置任务的 ID
js.put(GTaskStringUtils.GTASK_JSON_ID, getGid());
// 设置任务实体的变化信息
JSONObject entity = new JSONObject();
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
if (getNotes()!= null) {
entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes());
}
entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted());
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to generate task-update jsonobject");
}
return js;
}
// 根据远程 JSON 数据设置任务内容
public void setContentByRemoteJSON(JSONObject js) {
if (js!= null) {
try {
// 如果 JSON 数据包含任务 ID设置任务 ID
if (js.has(GTaskStringUtils.GTASK_JSON_ID)) {
setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID));
}
// 如果 JSON 数据包含最后修改时间,设置最后修改时间
if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) {
setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED));
}
// 如果 JSON 数据包含任务名称,设置任务名称
if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) {
setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME));
}
// 如果 JSON 数据包含任务备注,设置任务备注
if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) {
setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES));
}
// 如果 JSON 数据包含删除标志,设置删除标志
if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) {
setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED));
}
// 如果 JSON 数据包含完成标志,设置完成标志
if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) {
setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED));
}
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to get task content from jsonobject");
}
}
}
// 根据本地 JSON 数据设置任务内容
public void setContentByLocalJSON(JSONObject js) {
if (js == null ||!js.has(GTaskStringUtils.META_HEAD_NOTE)
||!js.has(GTaskStringUtils.META_HEAD_DATA)) {
Log.w(TAG, "setContentByLocalJSON: nothing is avaiable");
}
try {
JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
// 如果笔记类型不是普通笔记,记录错误日志并返回
if (note.getInt(NoteColumns.TYPE)!= Notes.TYPE_NOTE) {
Log.e(TAG, "invalid type");
return;
}
// 遍历数据数组,找到 MIME 类型为笔记的项,设置任务名称
for (int i = 0; i < dataArray.length(); i++) {
JSONObject data = dataArray.getJSONObject(i);
if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) {
setName(data.getString(DataColumns.CONTENT));
break;
}
}
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
}
}
// 从任务内容中获取本地 JSON 对象
public JSONObject getLocalJSONFromContent() {
String name = getName();
try {
if (mMetaInfo == null) {
// 新创建的任务(从网页创建)
if (name == null) {
Log.w(TAG, "the note seems to be an empty one");
return null;
}
JSONObject js = new JSONObject();
JSONObject note = new JSONObject();
JSONArray dataArray = new JSONArray();
JSONObject data = new JSONObject();
data.put(DataColumns.CONTENT, name);
dataArray.put(data);
js.put(GTaskStringUtils.META_HEAD_DATA, dataArray);
note.put(NoteColumns.TYPE, Notes.TYPE_NOTE);
js.put(GTaskStringUtils.META_HEAD_NOTE, note);
return js;
} else {
// 已同步的任务
JSONObject note = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
JSONArray dataArray = mMetaInfo.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
// 遍历数据数组,找到 MIME 类型为笔记的项,更新任务名称
for (int i = 0; i < dataArray.length(); i++) {
JSONObject data = dataArray.getJSONObject(i);
if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) {
data.put(DataColumns.CONTENT, getName());
break;
}
}
note.put(NoteColumns.TYPE, Notes.TYPE_NOTE);
return mMetaInfo;
}
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
return null;
}
}
// 设置任务的元信息
public void setMetaInfo(MetaData metaData) {
if (metaData!= null && metaData.getNotes()!= null) {
try {
mMetaInfo = new JSONObject(metaData.getNotes());
} catch (JSONException e) {
Log.w(TAG, e.toString());
mMetaInfo = null;
}
}
}
// 根据数据库游标获取同步操作类型
public int getSyncAction(Cursor c) {
try {
JSONObject noteInfo = null;
if (mMetaInfo!= null && mMetaInfo.has(GTaskStringUtils.META_HEAD_NOTE)) {
noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
}
if (noteInfo == null) {
Log.w(TAG, "it seems that note meta has been deleted");
return SYNC_ACTION_UPDATE_REMOTE;
}
if (!noteInfo.has(NoteColumns.ID)) {
Log.w(TAG, "remote note id seems to be deleted");
return SYNC_ACTION_UPDATE_LOCAL;
}
// 验证笔记 ID
if (c.getLong(SqlNote.ID_COLUMN)!= noteInfo.getLong(NoteColumns.ID)) {
Log.w(TAG, "note id doesn't match");
return SYNC_ACTION_UPDATE_LOCAL;
}
if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) {
// 没有本地更新
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
// 两边都没有更新
return SYNC_ACTION_NONE;
} else {
// 应用远程更新到本地
return SYNC_ACTION_UPDATE_LOCAL;
}
} else {
// 验证 GTask ID
if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) {
Log.e(TAG, "gtask id doesn't match");
return SYNC_ACTION_ERROR;
}
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
// 只有本地修改
return SYNC_ACTION_UPDATE_REMOTE;
} else {
return SYNC_ACTION_UPDATE_CONFLICT;
}
}
} catch (Exception e) {
Log.e(TAG, e.toString());
e.printStackTrace();
}
return SYNC_ACTION_ERROR;
}
// 判断任务是否值得保存
public boolean isWorthSaving() {
return mMetaInfo!= null || (getName()!= null && getName().trim().length() > 0)
|| (getNotes()!= null && getNotes().trim().length() > 0);
}
// 设置任务是否完成
public void setCompleted(boolean completed) {
this.mCompleted = completed;
}
// 设置任务的备注信息
public void setNotes(String notes) {
this.mNotes = notes;
}
// 设置任务的前一个兄弟任务
public void setPriorSibling(Task priorSibling) {
this.mPriorSibling = priorSibling;
}
// 设置任务所属的任务列表
public void setParent(TaskList parent) {
this.mParent = parent;
}
// 获取任务是否完成
public boolean getCompleted() {
return this.mCompleted;
}
// 获取任务的备注信息
public String getNotes() {
return this.mNotes;
}
// 获取任务的前一个兄弟任务
public Task getPriorSibling() {
return this.mPriorSibling;
}
// 获取任务所属的任务列表
public TaskList getParent() {
return this.mParent;
}
}

@ -0,0 +1,381 @@
/*
* Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net)
*
* Apache 2.0
* 使
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
*
*
*
*/
package net.micode.notes.gtask.data;
import android.database.Cursor;
import android.util.Log;
import net.micode.notes.data.Notes;
import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.gtask.exception.ActionFailureException;
import net.micode.notes.tool.GTaskStringUtils;
import org.json.JSONException;
import org.json.JSONObject;
import java.util.ArrayList;
// TaskList 类继承自 Node 类,用于表示任务列表相关的数据和操作
public class TaskList extends Node {
// 用于日志记录的标签,使用类的简单名称
private static final String TAG = TaskList.class.getSimpleName();
// 任务列表的索引
private int mIndex;
// 存储任务列表中的任务
private ArrayList<Task> mChildren;
// 构造函数,初始化任务列表
public TaskList() {
super(); // 调用父类的构造函数
mChildren = new ArrayList<Task>(); // 初始化任务列表
mIndex = 1; // 设置默认索引为 1
}
// 获取用于创建任务列表的 JSON 对象
public JSONObject getCreateAction(int actionId) {
JSONObject js = new JSONObject();
try {
// 设置操作类型为创建
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);
// 设置操作 ID
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
// 设置任务列表的索引
js.put(GTaskStringUtils.GTASK_JSON_INDEX, mIndex);
// 设置任务列表实体的变化信息
JSONObject entity = new JSONObject();
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");
entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_GROUP);
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to generate tasklist-create jsonobject");
}
return js;
}
// 获取用于更新任务列表的 JSON 对象
public JSONObject getUpdateAction(int actionId) {
JSONObject js = new JSONObject();
try {
// 设置操作类型为更新
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE);
// 设置操作 ID
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
// 设置任务列表的 ID
js.put(GTaskStringUtils.GTASK_JSON_ID, getGid());
// 设置任务列表实体的变化信息
JSONObject entity = new JSONObject();
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted());
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to generate tasklist-update jsonobject");
}
return js;
}
// 根据远程 JSON 数据设置任务列表的内容
public void setContentByRemoteJSON(JSONObject js) {
if (js!= null) {
try {
// 如果 JSON 数据包含任务列表 ID设置任务列表 ID
if (js.has(GTaskStringUtils.GTASK_JSON_ID)) {
setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID));
}
// 如果 JSON 数据包含最后修改时间,设置最后修改时间
if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) {
setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED));
}
// 如果 JSON 数据包含任务列表名称,设置任务列表名称
if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) {
setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME));
}
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to get tasklist content from jsonobject");
}
}
}
// 根据本地 JSON 数据设置任务列表的内容
public void setContentByLocalJSON(JSONObject js) {
if (js == null ||!js.has(GTaskStringUtils.META_HEAD_NOTE)) {
Log.w(TAG, "setContentByLocalJSON: nothing is avaiable");
}
try {
// 获取 JSON 数据中的文件夹信息
JSONObject folder = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
// 如果文件夹类型是普通文件夹
if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) {
// 获取文件夹摘要信息并设置任务列表名称
String name = folder.getString(NoteColumns.SNIPPET);
setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + name);
}
// 如果文件夹类型是系统文件夹
else if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) {
// 如果是根文件夹
if (folder.getLong(NoteColumns.ID) == Notes.ID_ROOT_FOLDER)
setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT);
// 如果是通话记录文件夹
else if (folder.getLong(NoteColumns.ID) == Notes.ID_CALL_RECORD_FOLDER)
setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX
+ GTaskStringUtils.FOLDER_CALL_NOTE);
else
Log.e(TAG, "invalid system folder");
} else {
Log.e(TAG, "error type");
}
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
}
}
// 从任务列表内容中获取本地 JSON 对象
public JSONObject getLocalJSONFromContent() {
try {
JSONObject js = new JSONObject();
JSONObject folder = new JSONObject();
// 获取任务列表名称
String folderName = getName();
// 如果名称以特定前缀开头,去掉前缀
if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX))
folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(),
folderName.length());
// 设置文件夹摘要信息
folder.put(NoteColumns.SNIPPET, folderName);
// 根据文件夹名称判断类型并设置
if (folderName.equals(GTaskStringUtils.FOLDER_DEFAULT)
|| folderName.equals(GTaskStringUtils.FOLDER_CALL_NOTE))
folder.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
else
folder.put(NoteColumns.TYPE, Notes.TYPE_FOLDER);
// 将文件夹信息放入 JSON 对象
js.put(GTaskStringUtils.META_HEAD_NOTE, folder);
return js;
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
return null;
}
}
// 根据数据库游标获取任务列表的同步操作类型
public int getSyncAction(Cursor c) {
try {
// 如果本地没有修改
if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) {
// 如果远程和本地的同步 ID 相同,说明两边都没有更新
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
return SYNC_ACTION_NONE;
} else {
// 应用远程更新到本地
return SYNC_ACTION_UPDATE_LOCAL;
}
} else {
// 验证 GTask ID
if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) {
Log.e(TAG, "gtask id doesn't match");
return SYNC_ACTION_ERROR;
}
// 如果本地和远程的同步 ID 相同,说明只有本地修改
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
return SYNC_ACTION_UPDATE_REMOTE;
} else {
// 对于文件夹冲突,直接应用本地修改
return SYNC_ACTION_UPDATE_REMOTE;
}
}
} catch (Exception e) {
Log.e(TAG, e.toString());
e.printStackTrace();
}
return SYNC_ACTION_ERROR;
}
// 获取任务列表中任务的数量
public int getChildTaskCount() {
return mChildren.size();
}
// 向任务列表中添加一个任务
public boolean addChildTask(Task task) {
boolean ret = false;
// 如果任务不为空且任务列表中不包含该任务
if (task!= null &&!mChildren.contains(task)) {
// 将任务添加到任务列表
ret = mChildren.add(task);
if (ret) {
// 设置任务的前一个兄弟任务和所属任务列表
task.setPriorSibling(mChildren.isEmpty()? null : mChildren
.get(mChildren.size() - 1));
task.setParent(this);
}
}
return ret;
}
// 在指定索引位置向任务列表中添加一个任务
public boolean addChildTask(Task task, int index) {
if (index < 0 || index > mChildren.size()) {
Log.e(TAG, "add child task: invalid index");
return false;
}
int pos = mChildren.indexOf(task);
// 如果任务不为空且任务列表中不包含该任务
if (task!= null && pos == -1) {
// 在指定索引位置添加任务
mChildren.add(index, task);
// 更新任务列表中的任务关系
Task preTask = null;
Task afterTask = null;
if (index!= 0)
preTask = mChildren.get(index - 1);
if (index!= mChildren.size() - 1)
afterTask = mChildren.get(index + 1);
// 设置任务的前一个兄弟任务
task.setPriorSibling(preTask);
// 如果后一个任务存在,设置其后一个任务的前一个兄弟任务
if (afterTask!= null)
afterTask.setPriorSibling(task);
}
return true;
}
// 从任务列表中移除一个任务
public boolean removeChildTask(Task task) {
boolean ret = false;
// 获取任务在任务列表中的索引
int index = mChildren.indexOf(task);
// 如果任务存在于任务列表中
if (index!= -1) {
// 从任务列表中移除任务
ret = mChildren.remove(task);
if (ret) {
// 重置任务的前一个兄弟任务和所属任务列表
task.setPriorSibling(null);
task.setParent(null);
// 更新任务列表中的任务关系
if (index!= mChildren.size()) {
mChildren.get(index).setPriorSibling(
index == 0? null : mChildren.get(index - 1));
}
}
}
return ret;
}
// 在任务列表中移动一个任务到指定索引位置
public boolean moveChildTask(Task task, int index) {
if (index < 0 || index >= mChildren.size()) {
Log.e(TAG, "move child task: invalid index");
return false;
}
int pos = mChildren.indexOf(task);
// 如果任务不存在于任务列表中
if (pos == -1) {
Log.e(TAG, "move child task: the task should in the list");
return false;
}
// 如果任务当前位置和目标位置相同,直接返回 true
if (pos == index)
return true;
// 先移除任务,再在指定位置添加任务
return (removeChildTask(task) && addChildTask(task, index));
}
// 根据任务的 GID 在任务列表中查找任务
public Task findChildTaskByGid(String gid) {
for (int i = 0; i < mChildren.size(); i++) {
Task t = mChildren.get(i);
// 如果找到匹配 GID 的任务,返回该任务
if (t.getGid().equals(gid)) {
return t;
}
}
return null;
}
// 获取任务在任务列表中的索引
public int getChildTaskIndex(Task task) {
return mChildren.indexOf(task);
}
// 根据索引获取任务列表中的任务
public Task getChildTaskByIndex(int index) {
if (index < 0 || index >= mChildren.size()) {
Log.e(TAG, "getTaskByIndex: invalid index");
return null;
}
// 返回指定索引位置的任务
return mChildren.get(index);
}
// 根据任务的 GID 获取任务列表中的任务(方法名拼写错误,应为 getChildTaskByGid
public Task getChilTaskByGid(String gid) {
for (Task task : mChildren) {
// 如果找到匹配 GID 的任务,返回该任务
if (task.getGid().equals(gid))
return task;
}
return null;
}
// 获取任务列表中的所有任务
public ArrayList<Task> getChildTaskList() {
return this.mChildren;
}
// 设置任务列表的索引
public void setIndex(int index) {
this.mIndex = index;
}
// 获取任务列表的索引
public int getIndex() {
return this.mIndex;
}
}

177
data

@ -0,0 +1,177 @@
/*
* Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net)
*
* 遵循 Apache 许可证 2.0 版(“许可证”);
* 除非遵守许可证,否则不得使用此文件。
* 你可以在以下网址获取许可证副本:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 除非适用法律要求或书面同意,
* 根据许可证分发的软件按“原样”分发,
* 不附带任何明示或暗示的保证或条件。
* 请参阅许可证,了解具体的权限和限制。
*/
package net.micode.notes.gtask.remote;
import android.app.Activity;
import android.app.Service;
import android.content.Context;
import android.content.Intent;
import android.os.Bundle;
import android.os.IBinder;
// GTaskSyncService 是一个 Android 服务类,用于管理 Google 任务GTask的同步操作
// 提供了启动同步、取消同步的功能,并通过广播通知同步状态和进度
public class GTaskSyncService extends Service {
// 用于在 Intent 中传递同步操作类型的字符串名称
public final static String ACTION_STRING_NAME = "sync_action_type";
// 启动同步操作的类型标识
public final static int ACTION_START_SYNC = 0;
// 取消同步操作的类型标识
public final static int ACTION_CANCEL_SYNC = 1;
// 无效操作的类型标识
public final static int ACTION_INVALID = 2;
// 用于发送广播的名称
public final static String GTASK_SERVICE_BROADCAST_NAME = "net.micode.notes.gtask.remote.gtask_sync_service";
// 广播中用于表示是否正在同步的字段名称
public final static String GTASK_SERVICE_BROADCAST_IS_SYNCING = "isSyncing";
// 广播中用于表示同步进度消息的字段名称
public final static String GTASK_SERVICE_BROADCAST_PROGRESS_MSG = "progressMsg";
// 当前正在执行的同步任务
private static GTaskASyncTask mSyncTask = null;
// 当前同步的进度消息
private static String mSyncProgress = "";
// 启动同步任务的方法
private void startSync() {
// 如果同步任务尚未创建
if (mSyncTask == null) {
// 创建一个新的 GTaskASyncTask 实例,并传入当前服务上下文和一个任务完成监听器
mSyncTask = new GTaskASyncTask(this, new GTaskASyncTask.OnCompleteListener() {
// 当同步任务完成时,执行该方法
public void onComplete() {
// 将同步任务实例置为 null
mSyncTask = null;
// 发送广播通知同步完成,消息为空字符串
sendBroadcast("");
// 停止当前服务
stopSelf();
}
});
// 发送广播通知同步开始,消息为空字符串
sendBroadcast("");
// 执行同步任务
mSyncTask.execute();
}
}
// 取消同步任务的方法
private void cancelSync() {
// 如果同步任务正在进行
if (mSyncTask!= null) {
// 调用同步任务的取消同步方法
mSyncTask.cancelSync();
}
}
// 当服务创建时调用的方法
@Override
public void onCreate() {
// 将同步任务实例置为 null
mSyncTask = null;
}
// 当服务接收到启动命令时调用的方法
@Override
public int onStartCommand(Intent intent, int flags, int startId) {
// 获取 Intent 中携带的额外数据
Bundle bundle = intent.getExtras();
// 如果额外数据存在且包含同步操作类型字段
if (bundle!= null && bundle.containsKey(ACTION_STRING_NAME)) {
// 根据同步操作类型执行相应的操作
switch (bundle.getInt(ACTION_STRING_NAME, ACTION_INVALID)) {
case ACTION_START_SYNC:
// 启动同步任务
startSync();
break;
case ACTION_CANCEL_SYNC:
// 取消同步任务
cancelSync();
break;
default:
break;
}
// 返回 START_STICKY 表示如果服务被系统杀死,在有足够内存时会自动重启
return START_STICKY;
}
// 如果未包含同步操作类型字段,调用父类的 onStartCommand 方法
return super.onStartCommand(intent, flags, startId);
}
// 当系统内存不足时调用的方法
@Override
public void onLowMemory() {
// 如果同步任务正在进行
if (mSyncTask!= null) {
// 取消同步任务
mSyncTask.cancelSync();
}
}
// 当客户端绑定到服务时调用的方法,由于该服务不支持绑定,返回 null
@Override
public IBinder onBind(Intent intent) {
return null;
}
// 发送广播的方法,用于通知同步状态和进度
public void sendBroadcast(String msg) {
// 更新同步进度消息
mSyncProgress = msg;
// 创建一个新的 Intent设置广播名称
Intent intent = new Intent(GTASK_SERVICE_BROADCAST_NAME);
// 在 Intent 中添加是否正在同步的信息
intent.putExtra(GTASK_SERVICE_BROADCAST_IS_SYNCING, mSyncTask!= null);
// 在 Intent 中添加同步进度消息
intent.putExtra(GTASK_SERVICE_BROADCAST_PROGRESS_MSG, msg);
// 发送广播
sendBroadcast(intent);
}
// 外部调用启动同步的静态方法
public static void startSync(Activity activity) {
// 设置 GTaskManager 的 Activity 上下文
GTaskManager.getInstance().setActivityContext(activity);
// 创建一个 Intent指定要启动的服务为 GTaskSyncService
Intent intent = new Intent(activity, GTaskSyncService.class);
// 在 Intent 中添加启动同步的操作类型
intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_START_SYNC);
// 启动服务
activity.startService(intent);
}
// 外部调用取消同步的静态方法
public static void cancelSync(Context context) {
// 创建一个 Intent指定要启动的服务为 GTaskSyncService
Intent intent = new Intent(context, GTaskSyncService.class);
// 在 Intent 中添加取消同步的操作类型
intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_CANCEL_SYNC);
// 启动服务
context.startService(intent);
}
// 判断是否正在进行同步的静态方法
public static boolean isSyncing() {
// 通过判断同步任务实例是否为 null 来确定是否正在同步
return mSyncTask!= null;
}
// 获取当前同步进度消息的静态方法
public static String getProgressString() {
// 返回当前的同步进度消息
return mSyncProgress;
}
}
Loading…
Cancel
Save