/*
 * 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.widget;
import android.app.PendingIntent;
import android.appwidget.AppWidgetManager;
import android.appwidget.AppWidgetProvider;
import android.content.ContentValues;
import android.content.Context;
import android.content.Intent;
import android.database.Cursor;
import android.util.Log;
import android.widget.RemoteViews;

import net.micode.notes.R;
import net.micode.notes.data.Notes;
import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.tool.ResourceParser;
import net.micode.notes.ui.NoteEditActivity;
import net.micode.notes.ui.NotesListActivity;

public abstract class NoteWidgetProvider extends AppWidgetProvider {
    public static final String [] PROJECTION = new String [] {
        NoteColumns.ID,
        NoteColumns.BG_COLOR_ID,
        NoteColumns.SNIPPET
    };/*一个抽象类 NoteWidgetProvider，它继承自 AppWidgetProvider 类。

在这个抽象类中定义了一个公共静态常量数组 PROJECTION，该数组包含三个字符串元素，这些字符串元素对应着笔记应用中的一些数据库列名，包括笔记的 ID、背景颜色 ID 和摘录内容。*/

    public static final int COLUMN_ID           = 0;// 笔记 ID 列在 PROJECTION 数组中的索引
    public static final int COLUMN_BG_COLOR_ID  = 1;// 笔记背景颜色 ID 列在 PROJECTION 数组中的索引
    public static final int COLUMN_SNIPPET      = 2;// 笔记摘录内容列在 PROJECTION 数组中的索引

    private static final String TAG = "NoteWidgetProvider";// 日志输出标识符

    @Override
    public void onDeleted(Context context, int[] appWidgetIds) {
        ContentValues values = new ContentValues();
        values.put(NoteColumns.WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID);
        for (int i = 0; i < appWidgetIds.length; i++) {
            context.getContentResolver().update(Notes.CONTENT_NOTE_URI,
                    values,
                    NoteColumns.WIDGET_ID + "=?",
                    new String[] { String.valueOf(appWidgetIds[i])});
        }
    }/*这是 NoteWidgetProvider 抽象类中的一个公共方法 onDeleted()，它重写了父类 AppWidgetProvider 中的方法，用于处理小部件被删除的事件。

在该方法中，首先创建了一个 ContentValues 对象 values，并将 NoteColumns.WIDGET_ID 的值设为 AppWidgetManager.INVALID_APPWIDGET_ID，表示小部件已被删除。

然后遍历传入的 appWidgetIds 数组，将每个小部件的 NoteColumns.WIDGET_ID 列更新为 AppWidgetManager.INVALID_APPWIDGET_ID，以便将小部件与笔记数据库中的记录解除绑定。

具体地，使用 getContentResolver() 获取一个 ContentResolver 对象，调用 update() 方法对笔记数据库中的记录进行更新。更新的条件为 NoteColumns.WIDGET_ID + "=?"，即 NoteColumns.WIDGET_ID 等于当前小部件 ID，更新的数据为 values 对象，其中 NoteColumns.WIDGET_ID 的值已经被设置为 AppWidgetManager.INVALID_APPWIDGET_ID。*/

    private Cursor getNoteWidgetInfo(Context context, int widgetId) {// 使用 getContentResolver() 方法获取 ContentResolver 对象，通过该对象进行对笔记数据库的查询操作
        return context.getContentResolver().query(Notes.CONTENT_NOTE_URI, // 使用 query() 方法查询笔记数据库，返回一个 Cursor 对象
        return context.getContentResolver().query(// 查询的 URI，笔记数据库中笔记的内容保存在该 URI 下
                PROJECTION,
                Notes.CONTENT_NOTE_URI,
                PROJECTION,
                NoteColumns.WIDGET_ID + "=? AND " + NoteColumns.PARENT_ID + "<>?",// 查询的列，即笔记 ID、笔记背景颜色 ID 和笔记摘录内容
                new String[] { String.valueOf(widgetId), String.valueOf(Notes.ID_TRASH_FOLER) },//查询的条件，即笔记关联的小部件 ID 以及笔记的父 ID 不为回收站的笔记
                null);// 排序方式，这里为 null 表示不排序
    }

    protected void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
        update(context, appWidgetManager, appWidgetIds, false);
    }/*这是 NoteWidgetProvider 抽象类中的一个受保护的方法 update()，它接受一个 Context 对象、一个 AppWidgetManager 对象和一个整型数组 appWidgetIds 作为参数，并在方法中调用了另一个同名方法。*/

    private void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds,
            boolean privacyMode) {
        for (int i = 0; i < appWidgetIds.length; i++) {
            if (appWidgetIds[i] != AppWidgetManager.INVALID_APPWIDGET_ID) {
                int bgId = ResourceParser.getDefaultBgId(context);
                String snippet = "";
                Intent intent = new Intent(context, NoteEditActivity.class);
                intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
                intent.putExtra(Notes.INTENT_EXTRA_WIDGET_ID, appWidgetIds[i]);
                intent.putExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, getWidgetType());

                Cursor c = getNoteWidgetInfo(context, appWidgetIds[i]);
                if (c != null && c.moveToFirst()) {
                    if (c.getCount() > 1) {
                        Log.e(TAG, "Multiple message with same widget id:" + appWidgetIds[i]);
                        c.close();
                        return;
                    }
                    snippet = c.getString(COLUMN_SNIPPET);
                    bgId = c.getInt(COLUMN_BG_COLOR_ID);
                    intent.putExtra(Intent.EXTRA_UID, c.getLong(COLUMN_ID));
                    intent.setAction(Intent.ACTION_VIEW);
                } else {
                    snippet = context.getResources().getString(R.string.widget_havenot_content);
                    intent.setAction(Intent.ACTION_INSERT_OR_EDIT);
                }

                if (c != null) {
                    c.close();
                }

                RemoteViews rv = new RemoteViews(context.getPackageName(), getLayoutId());
                rv.setImageViewResource(R.id.widget_bg_image, getBgResourceId(bgId));
                intent.putExtra(Notes.INTENT_EXTRA_BACKGROUND_ID, bgId);
                /**
                 * Generate the pending intent to start host for the widget
                 */
                PendingIntent pendingIntent = null;
                if (privacyMode) {
                    rv.setTextViewText(R.id.widget_text,
                            context.getString(R.string.widget_under_visit_mode));
                    pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], new Intent(
                            context, NotesListActivity.class), PendingIntent.FLAG_UPDATE_CURRENT);
                } else {
                    rv.setTextViewText(R.id.widget_text, snippet);
                    pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], intent,
                            PendingIntent.FLAG_UPDATE_CURRENT);
                }

                rv.setOnClickPendingIntent(R.id.widget_text, pendingIntent);
                appWidgetManager.updateAppWidget(appWidgetIds[i], rv);
            }
        }
    }/*这是 `NoteWidgetProvider` 抽象类中的一个私有方法 `update()`，它接受一个 `Context` 对象、一个 `AppWidgetManager` 对象、一个整型数组 `appWidgetIds` 和一个布尔型参数 `privacyMode` 作为参数。该方法用于更新小部件的显示内容和点击事件。

方法中首先对 `appWidgetIds` 数组进行遍历，对于每个小部件 ID，如果它不等于 `AppWidgetManager.INVALID_APPWIDGET_ID`，则执行以下操作：

- 获取小部件的默认背景 ID，以及一个空的摘录字符串。
- 创建一个 `NoteEditActivity` 的意图，并将小部件 ID、小部件类型等信息作为附加数据放入其中。
- 调用 `getNoteWidgetInfo()` 方法获取与当前小部件关联的笔记信息，并根据结果设置摘录字符串、背景 ID 和意图的操作类型。
- 根据背景 ID 创建一个 `RemoteViews` 对象，并将背景图片、背景 ID 和点击事件所需的 `PendingIntent` 添加到其中。
- 调用 `AppWidgetManager` 的 `updateAppWidget()` 方法更新小部件的显示内容。

如果 `privacyMode` 为 `true`，则小部件将显示 "隐私模式"，并且点击小部件将启动 `NotesListActivity`；否则，小部件将显示与笔记关联的摘录字符串，点击小部件将启动 `NoteEditActivity`。*/

    protected abstract int getBgResourceId(int bgId);//用于获取小部件的背景资源 ID。

    protected abstract int getLayoutId();//用于获取小部件的布局资源 ID。

    protected abstract int getWidgetType();//用于获取小部件的类型。
}
