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

/**
 *导入所需的类和包，包括Android的联系人相关类、电话号码工具类以及日志记录类。
 */

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;                                         //用于在Android中记录调试信息的类。
import java.util.HashMap;                                        //Java中的HashMap类，用于存储联系人姓名和手机号码的映射关系。

public class Contact {
    private static HashMap<String, String> sContactCache;
    private static final String TAG = "Contact";                 //包含一个私有静态变量sContactCache，
                                                                 //用于缓存联系人信息，以及一个私有静态常量TAG，用于在日志中标识这个类。
                                                                 //键值对（数据结构）（电话号码可以作为键，联系人姓名作为值）TAG是用于日志记录的标签常量。

    private static final String CALLER_ID_SELECTION = "PHONE_NUMBERS_EQUAL(" + Phone.NUMBER  //PHONE_NUMBERS_EQUAL()是一个内置函数，用于比较两个电话号码是否相等。
    + ",?) AND " + Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'"//Phone.NUMBER是通讯录中电话号码的列名
        + " AND " + Data.RAW_CONTACT_ID + " IN "                       //Data.MIMETYPE是通讯录数据中的MIME类型列名，用于指定查询电话号码的数据类型为电话号码。
            + "(SELECT raw_contact_id "                                //Phone.CONTENT_ITEM_TYPE是电话号码的MIME类型值。
            + " FROM phone_lookup"                                     //Data.RAW_CONTACT_ID是通讯录数据中的原始联系人ID列名。
            + " WHERE min_match = '+')";                               //phone_lookup是一个表名，用于存储电话号码的查找结果。

    /**
     * 用于获取给定电话号码对应的联系人姓名.
      * @param context
     * @param phoneNumber
     * @return
     */

    public static String getContact(Context context, String phoneNumber) {
        if(sContactCache == null) {                                //首先检查sContactCache是否为null，如果是，则初始化一个新的HashMap.
            sContactCache = new HashMap<String, String>();
        }

        if(sContactCache.containsKey(phoneNumber)) {               //接下来，如果sContactCache中包含给定电话号码的键值对，则直接返回缓存中的联系人姓名。
            return sContactCache.get(phoneNumber);
        }

        String selection = CALLER_ID_SELECTION.replace("+", //首先将给定的电话号码转换为最小匹配形式，然后使用replace()方法将查询条件中的"+"替换为最小匹配的电话号码形式。
                PhoneNumberUtils.toCallerIDMinMatch(phoneNumber));
        Cursor cursor = context.getContentResolver().query(        //执行了一个查询操作，该方法会返回一个Cursor对象，用于遍历查询结果
                Data.CONTENT_URI,                                  //指定了要查询的数据表的URI，表示通讯录数据。
                new String [] { Phone.DISPLAY_NAME },              //是要查询的列名，这里是查询联系人的显示名称。
                selection,                                         //是查询条件，根据前面处理过的最小匹配电话号码来查询匹配的联系人信息。
                new String[] { phoneNumber },                      //是查询条件中的参数值，用于替换查询条件中的"?"占位符。
                null);                                             //最后一个参数是排序方式，这里为空，表示不进行排序。

        if (cursor != null && cursor.moveToFirst()) {              //这个条件语句检查Cursor对象是否不为空，并且能够将游标移动到第一行。如果满足条件，则表示查询结果非空且至少存在一个匹配项。
            try {
                String name = cursor.getString(0);               //获取查询结果中第一列（索引为0）的数据，即联系人的显示名称。
                sContactCache.put(phoneNumber, name);              //将此信息存储在sContactCache缓存中
                return name;
            } catch (IndexOutOfBoundsException e) {                //如果在获取查询结果的过程中发生异常，说明查询结果中没有有效数据，此时会打印错误日志并返回null
                Log.e(TAG, " Cursor get string error " + e.toString());
                return null;
            } finally {                                            //无论是否出现异常，最后都会通过cursor.close()方法关闭Cursor对象，释放资源。
                cursor.close();
            }
        } else {                                                   //如果查询结果为空或者没有匹配项，就会执行这个分支。它会打印调试日志，指示没有找到与给定电话号码匹配的联系人，并返回null。
            Log.d(TAG, "No contact matched with number:" + phoneNumber);
            return null;
        }
    }
}

