/*
 * 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,           // 便签ID
        NoteColumns.BG_COLOR_ID,  // 便签背景颜色ID
        NoteColumns.SNIPPET       // 便签摘要内容
    };

    // 投影列索引常量
    public static final int COLUMN_ID           = 0;
    public static final int COLUMN_BG_COLOR_ID  = 1;
    public static final int COLUMN_SNIPPET      = 2;

    private static final String TAG = "NoteWidgetProvider";

    /**
     * 当小部件被删除时调用，负责清理数据库中相关的小部件ID引用
     * 
     * @param context 应用上下文
     * @param appWidgetIds 被删除的小部件ID数组
     */
    @Override
    public void onDeleted(Context context, int[] appWidgetIds) {
        ContentValues values = new ContentValues();
        values.put(NoteColumns.WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID);
        // 更新数据库中所有关联这些小部件ID的便签记录，将其widget_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])});
        }
    }

    /**
     * 获取与指定小部件ID关联的便签信息
     * 
     * @param context 应用上下文
     * @param widgetId 小部件ID
     * @return 包含便签信息的Cursor对象
     */
    private Cursor getNoteWidgetInfo(Context context, int widgetId) {
        // 查询数据库，获取与指定小部件ID关联且不在回收站中的便签
        return context.getContentResolver().query(Notes.CONTENT_NOTE_URI,
                PROJECTION,
                NoteColumns.WIDGET_ID + "=? AND " + NoteColumns.PARENT_ID + "<>?",
                new String[] { String.valueOf(widgetId), String.valueOf(Notes.ID_TRASH_FOLER) },
                null);
    }

    /**
     * 更新指定的便签小部件，使用默认模式(非隐私模式)
     * 
     * @param context 应用上下文
     * @param appWidgetManager 小部件管理器
     * @param appWidgetIds 需要更新的小部件ID数组
     */
    protected void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
        update(context, appWidgetManager, appWidgetIds, false);
    }

    /**
     * 更新指定的便签小部件
     * 
     * @param context 应用上下文
     * @param appWidgetManager 小部件管理器
     * @param appWidgetIds 需要更新的小部件ID数组
     * @param privacyMode 是否使用隐私模式
     */
    private void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds,
            boolean privacyMode) {
        // 遍历所有需要更新的小部件ID
        for (int i = 0; i < appWidgetIds.length; i++) {
            if (appWidgetIds[i] != AppWidgetManager.INVALID_APPWIDGET_ID) {
                // 设置默认值
                int bgId = ResourceParser.getDefaultBgId(context);
                String snippet = "";
                
                // 创建用于启动便签编辑界面的Intent
                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()) {
                    // 检查是否有多个便签关联到同一个小部件ID(这是异常情况)
                    if (c.getCount() > 1) {
                        Log.e(TAG, "Multiple message with same widget id:" + appWidgetIds[i]);
                        c.close();
                        return;
                    }
                    
                    // 从Cursor中获取便签内容和背景色
                    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);
                }

                // 关闭Cursor释放资源
                if (c != null) {
                    c.close();
                }

                // 创建RemoteViews对象用于更新小部件UI
                RemoteViews rv = new RemoteViews(context.getPackageName(), getLayoutId());
                rv.setImageViewResource(R.id.widget_bg_image, getBgResourceId(bgId));
                intent.putExtra(Notes.INTENT_EXTRA_BACKGROUND_ID, bgId);
                
                /**
                 * 生成用于启动小部件宿主应用的PendingIntent
                 */
                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);
            }
        }
    }

    /**
     * 根据背景颜色ID获取对应的背景资源ID
     * 子类必须实现此方法以提供具体的背景资源映射
     * 
     * @param bgId 背景颜色ID
     * @return 对应的背景资源ID
     */
    protected abstract int getBgResourceId(int bgId);

    /**
     * 获取小部件的布局资源ID
     * 子类必须实现此方法以指定具体的布局文件
     * 
     * @return 布局资源ID
     */
    protected abstract int getLayoutId();

    /**
     * 获取小部件类型
     * 子类必须实现此方法以返回具体的小部件类型标识
     * 
     * @return 小部件类型
     */
    protected abstract int getWidgetType();
}
