/*
 * 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.
 */

// 包声明，表明该类属于 net.micode.notes.data 包
package net.micode.notes.data;

// 导入 Android 上下文相关类，用于获取应用程序的上下文信息
import android.content.Context;
// 导入 Android 数据库游标类，用于处理数据库查询结果
import android.database.Cursor;
// 导入联系人合约中电话相关的类，用于操作联系人的电话号码信息
import android.provider.ContactsContract.CommonDataKinds.Phone;
// 导入联系人合约中数据相关的类，用于操作联系人的数据信息
import android.provider.ContactsContract.Data;
// 导入电话号码处理工具类，用于处理电话号码的格式等操作
import android.telephony.PhoneNumberUtils;
// 导入日志工具类，用于记录应用程序的日志信息
import android.util.Log;

// 导入 Java 中的 HashMap 类，用于存储键值对数据
import java.util.HashMap;

/**
 * Contact 类用于根据电话号码从联系人数据库中获取联系人姓名，并使用缓存机制提高查询效率。
 */
public class Contact {
    // 静态变量，用于缓存电话号码和对应的联系人姓名，避免重复查询数据库
    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 = '+')";

    /**
     * 根据电话号码从联系人数据库中获取联系人姓名。
     *
     * @param context     应用程序的上下文对象，用于获取内容解析器
     * @param phoneNumber 要查询的电话号码
     * @return 如果找到匹配的联系人，则返回联系人姓名；否则返回 null
     */
    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));
        // 使用内容解析器查询联系人数据库，获取匹配的联系人姓名
        Cursor cursor = context.getContentResolver().query(
                Data.CONTENT_URI, // 查询的内容 URI
                new String[]{Phone.DISPLAY_NAME}, // 查询的列名，只查询联系人姓名
                selection, // 查询的条件语句
                new String[]{phoneNumber}, // 查询条件的参数
                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());
                // 发生异常时返回 null
                return null;
            } finally {
                // 无论是否发生异常，最后都关闭游标，释放资源
                cursor.close();
            }
        } else {
            // 如果没有找到匹配的联系人，记录日志信息
            Log.d(TAG, "No contact matched with number:" + phoneNumber);
            // 返回 null
            return null;
        }
    }
}