telephony/java/com/android/internal/telephony/IccRecords.java - platform/frameworks/base - Git at Google

 /*
  * Copyright (C) 2006 The Android Open Source Project
  *
  * 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 com.android.internal.telephony;

 import android.os.AsyncResult;
 import android.os.Handler;
 import android.os.Message;
 import android.os.Registrant;
 import android.os.RegistrantList;

 import com.android.internal.telephony.gsm.UsimServiceTable;
 import com.android.internal.telephony.ims.IsimRecords;

 /**
  * {@hide}
  */
 public abstract class IccRecords extends Handler implements IccConstants {

     protected static final boolean DBG = true;
     // ***** Instance Variables

     protected PhoneBase phone;
     protected RegistrantList recordsLoadedRegistrants = new RegistrantList();

     protected int recordsToLoad;  // number of pending load requests

     protected AdnRecordCache adnCache;

     // ***** Cached SIM State; cleared on channel close

     protected boolean recordsRequested = false; // true if we've made requests for the sim records

     public String iccid;
     protected String msisdn = null;  // My mobile number
     protected String msisdnTag = null;
     protected String voiceMailNum = null;
     protected String voiceMailTag = null;
     protected String newVoiceMailNum = null;
     protected String newVoiceMailTag = null;
     protected boolean isVoiceMailFixed = false;
     protected int countVoiceMessages = 0;

     protected int mncLength = UNINITIALIZED;
     protected int mailboxIndex = 0; // 0 is no mailbox dailing number associated

     protected String spn;

     // ***** Constants

     // Markers for mncLength
     protected static final int UNINITIALIZED = -1;
     protected static final int UNKNOWN = 0;

     // Bitmasks for SPN display rules.
     protected static final int SPN_RULE_SHOW_SPN  = 0x01;
     protected static final int SPN_RULE_SHOW_PLMN = 0x02;

     // ***** Event Constants
     protected static final int EVENT_SET_MSISDN_DONE = 30;

     public static final int EVENT_GET_ICC_RECORD_DONE = 100;

     /**
      * Generic ICC record loaded callback. Subclasses can call EF load methods on
      * {@link IccFileHandler} passing a Message for onLoaded with the what field set to
      * {@link #EVENT_GET_ICC_RECORD_DONE} and the obj field set to an instance
      * of this interface. The {@link #handleMessage} method in this class will print a
      * log message using {@link #getEfName()} and decrement {@link #recordsToLoad}.
      *
      * If the record load was successful, {@link #onRecordLoaded} will be called with the result.
      * Otherwise, an error log message will be output by {@link #handleMessage} and
      * {@link #onRecordLoaded} will not be called.
      */
     public interface IccRecordLoaded {
         String getEfName();
         void onRecordLoaded(AsyncResult ar);
     }

     // ***** Constructor

     public IccRecords(PhoneBase p) {
         this.phone = p;
     }

     /**
      * Call when the IccRecords object is no longer going to be used.
      */
     public abstract void dispose();

     protected abstract void onRadioOffOrNotAvailable();

     //***** Public Methods
     public AdnRecordCache getAdnCache() {
         return adnCache;
     }

     public void registerForRecordsLoaded(Handler h, int what, Object obj) {
         Registrant r = new Registrant(h, what, obj);
         recordsLoadedRegistrants.add(r);

         if (recordsToLoad == 0 && recordsRequested == true) {
             r.notifyRegistrant(new AsyncResult(null, null, null));
         }
     }

     public void unregisterForRecordsLoaded(Handler h) {
         recordsLoadedRegistrants.remove(h);
     }

     /**
      * Get the International Mobile Subscriber ID (IMSI) on a SIM
      * for GSM, UMTS and like networks. Default is null if IMSI is
      * not supported or unavailable.
      *
      * @return null if SIM is not yet ready or unavailable
      */
     public String getIMSI() {
         return null;
     }

     public String getMsisdnNumber() {
         return msisdn;
     }

     /**
      * Set subscriber number to SIM record
      *
      * The subscriber number is stored in EF_MSISDN (TS 51.011)
      *
      * When the operation is complete, onComplete will be sent to its handler
      *
      * @param alphaTag alpha-tagging of the dailing nubmer (up to 10 characters)
      * @param number dailing nubmer (up to 20 digits)
      *        if the number starts with '+', then set to international TOA
      * @param onComplete
      *        onComplete.obj will be an AsyncResult
      *        ((AsyncResult)onComplete.obj).exception == null on success
      *        ((AsyncResult)onComplete.obj).exception != null on fail
      */
     public void setMsisdnNumber(String alphaTag, String number,
             Message onComplete) {

         msisdn = number;
         msisdnTag = alphaTag;

         if(DBG) log("Set MSISDN: " + msisdnTag +" " + msisdn);


         AdnRecord adn = new AdnRecord(msisdnTag, msisdn);

         new AdnRecordLoader(phone).updateEF(adn, EF_MSISDN, EF_EXT1, 1, null,
                 obtainMessage(EVENT_SET_MSISDN_DONE, onComplete));
     }

     public String getMsisdnAlphaTag() {
         return msisdnTag;
     }

     public String getVoiceMailNumber() {
         return voiceMailNum;
     }

     /**
      * Return Service Provider Name stored in SIM (EF_SPN=0x6F46) or in RUIM (EF_RUIM_SPN=0x6F41)
      * @return null if SIM is not yet ready or no RUIM entry
      */
     public String getServiceProviderName() {
         return spn;
     }

     /**
      * Set voice mail number to SIM record
      *
      * The voice mail number can be stored either in EF_MBDN (TS 51.011) or
      * EF_MAILBOX_CPHS (CPHS 4.2)
      *
      * If EF_MBDN is available, store the voice mail number to EF_MBDN
      *
      * If EF_MAILBOX_CPHS is enabled, store the voice mail number to EF_CHPS
      *
      * So the voice mail number will be stored in both EFs if both are available
      *
      * Return error only if both EF_MBDN and EF_MAILBOX_CPHS fail.
      *
      * When the operation is complete, onComplete will be sent to its handler
      *
      * @param alphaTag alpha-tagging of the dailing nubmer (upto 10 characters)
      * @param voiceNumber dailing nubmer (upto 20 digits)
      *        if the number is start with '+', then set to international TOA
      * @param onComplete
      *        onComplete.obj will be an AsyncResult
      *        ((AsyncResult)onComplete.obj).exception == null on success
      *        ((AsyncResult)onComplete.obj).exception != null on fail
      */
     public abstract void setVoiceMailNumber(String alphaTag, String voiceNumber,
             Message onComplete);

     public String getVoiceMailAlphaTag() {
         return voiceMailTag;
     }

     /**
      * Sets the SIM voice message waiting indicator records
      * @param line GSM Subscriber Profile Number, one-based. Only '1' is supported
      * @param countWaiting The number of messages waiting, if known. Use
      *                     -1 to indicate that an unknown number of
      *                      messages are waiting
      */
     public abstract void setVoiceMessageWaiting(int line, int countWaiting);

     /** @return  true if there are messages waiting, false otherwise. */
     public boolean getVoiceMessageWaiting() {
         return countVoiceMessages != 0;
     }

     /**
      * Returns number of voice messages waiting, if available
      * If not available (eg, on an older CPHS SIM) -1 is returned if
      * getVoiceMessageWaiting() is true
      */
     public int getVoiceMessageCount() {
         return countVoiceMessages;
     }

     /**
      * Called by STK Service when REFRESH is received.
      * @param fileChanged indicates whether any files changed
      * @param fileList if non-null, a list of EF files that changed
      */
     public abstract void onRefresh(boolean fileChanged, int[] fileList);


     public boolean getRecordsLoaded() {
         if (recordsToLoad == 0 && recordsRequested == true) {
             return true;
         } else {
             return false;
         }
     }

     //***** Overridden from Handler
     @Override
     public void handleMessage(Message msg) {
         switch (msg.what) {
             case EVENT_GET_ICC_RECORD_DONE:
                 try {
                     AsyncResult ar = (AsyncResult) msg.obj;
                     IccRecordLoaded recordLoaded = (IccRecordLoaded) ar.userObj;
                     if (DBG) log(recordLoaded.getEfName() + " LOADED");

                     if (ar.exception != null) {
                         loge("Record Load Exception: " + ar.exception);
                     } else {
                         recordLoaded.onRecordLoaded(ar);
                     }
                 }catch (RuntimeException exc) {
                     // I don't want these exceptions to be fatal
                     loge("Exception parsing SIM record: " + exc);
                 } finally {
                     // Count up record load responses even if they are fails
                     onRecordLoaded();
                 }
                 break;

             default:
                 super.handleMessage(msg);
         }
     }

     protected abstract void onRecordLoaded();

     protected abstract void onAllRecordsLoaded();

     /**
      * Returns the SpnDisplayRule based on settings on the SIM and the
      * specified plmn (currently-registered PLMN).  See TS 22.101 Annex A
      * and TS 51.011 10.3.11 for details.
      *
      * If the SPN is not found on the SIM, the rule is always PLMN_ONLY.
      * Generally used for GSM/UMTS and the like SIMs.
      */
     public abstract int getDisplayRule(String plmn);

     /**
      * Return true if "Restriction of menu options for manual PLMN selection"
      * bit is set or EF_CSP data is unavailable, return false otherwise.
      * Generally used for GSM/UMTS and the like SIMs.
      */
     public boolean isCspPlmnEnabled() {
         return false;
     }

     /**
      * Returns the 5 or 6 digit MCC/MNC of the operator that
      * provided the SIM card. Returns null of SIM is not yet ready
      * or is not valid for the type of IccCard. Generally used for
      * GSM/UMTS and the like SIMS
      */
     public String getOperatorNumeric() {
         return null;
     }

     /**
      * Get the current Voice call forwarding flag for GSM/UMTS and the like SIMs
      *
      * @return true if enabled
      */
     public boolean getVoiceCallForwardingFlag() {
         return false;
     }

     /**
      * Set the voice call forwarding flag for GSM/UMTS and the like SIMs
      *
      * @param line to enable/disable
      * @param enable
      */
     public void setVoiceCallForwardingFlag(int line, boolean enable) {
     }

     /**
      * Indicates wether SIM is in provisioned state or not.
      * Overridden only if SIM can be dynamically provisioned via OTA.
      *
      * @return true if provisioned
      */
     public boolean isProvisioned () {
         return true;
     }

     /**
      * Write string to log file
      *
      * @param s is the string to write
      */
     protected abstract void log(String s);

     /**
      * Write error string to log file.
      *
      * @param s is the string to write
      */
     protected abstract void loge(String s);

     /**
      * Return an interface to retrieve the ISIM records for IMS, if available.
      * @return the interface to retrieve the ISIM records, or null if not supported
      */
     public IsimRecords getIsimRecords() {
         return null;
     }

     public UsimServiceTable getUsimServiceTable() {
         return null;
     }
 }
	/*
	* Copyright (C) 2006 The Android Open Source Project
	*
	* 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 com.android.internal.telephony;

	import android.os.AsyncResult;
	import android.os.Handler;
	import android.os.Message;
	import android.os.Registrant;
	import android.os.RegistrantList;

	import com.android.internal.telephony.gsm.UsimServiceTable;
	import com.android.internal.telephony.ims.IsimRecords;

	/**
	* {@hide}
	*/
	public abstract class IccRecords extends Handler implements IccConstants {

	protected static final boolean DBG = true;
	// ***** Instance Variables

	protected PhoneBase phone;
	protected RegistrantList recordsLoadedRegistrants = new RegistrantList();

	protected int recordsToLoad; // number of pending load requests

	protected AdnRecordCache adnCache;

	// ***** Cached SIM State; cleared on channel close

	protected boolean recordsRequested = false; // true if we've made requests for the sim records

	public String iccid;
	protected String msisdn = null; // My mobile number
	protected String msisdnTag = null;
	protected String voiceMailNum = null;
	protected String voiceMailTag = null;
	protected String newVoiceMailNum = null;
	protected String newVoiceMailTag = null;
	protected boolean isVoiceMailFixed = false;
	protected int countVoiceMessages = 0;

	protected int mncLength = UNINITIALIZED;
	protected int mailboxIndex = 0; // 0 is no mailbox dailing number associated

	protected String spn;

	// ***** Constants

	// Markers for mncLength
	protected static final int UNINITIALIZED = -1;
	protected static final int UNKNOWN = 0;

	// Bitmasks for SPN display rules.
	protected static final int SPN_RULE_SHOW_SPN = 0x01;
	protected static final int SPN_RULE_SHOW_PLMN = 0x02;

	// ***** Event Constants
	protected static final int EVENT_SET_MSISDN_DONE = 30;

	public static final int EVENT_GET_ICC_RECORD_DONE = 100;

	/**
	* Generic ICC record loaded callback. Subclasses can call EF load methods on
	* {@link IccFileHandler} passing a Message for onLoaded with the what field set to
	* {@link #EVENT_GET_ICC_RECORD_DONE} and the obj field set to an instance
	* of this interface. The {@link #handleMessage} method in this class will print a
	* log message using {@link #getEfName()} and decrement {@link #recordsToLoad}.
	*
	* If the record load was successful, {@link #onRecordLoaded} will be called with the result.
	* Otherwise, an error log message will be output by {@link #handleMessage} and
	* {@link #onRecordLoaded} will not be called.
	*/
	public interface IccRecordLoaded {
	String getEfName();
	void onRecordLoaded(AsyncResult ar);
	}

	// ***** Constructor

	public IccRecords(PhoneBase p) {
	this.phone = p;
	}

	/**
	* Call when the IccRecords object is no longer going to be used.
	*/
	public abstract void dispose();

	protected abstract void onRadioOffOrNotAvailable();

	//***** Public Methods
	public AdnRecordCache getAdnCache() {
	return adnCache;
	}

	public void registerForRecordsLoaded(Handler h, int what, Object obj) {
	Registrant r = new Registrant(h, what, obj);
	recordsLoadedRegistrants.add(r);

	if (recordsToLoad == 0 && recordsRequested == true) {
	r.notifyRegistrant(new AsyncResult(null, null, null));
	}
	}

	public void unregisterForRecordsLoaded(Handler h) {
	recordsLoadedRegistrants.remove(h);
	}

	/**
	* Get the International Mobile Subscriber ID (IMSI) on a SIM
	* for GSM, UMTS and like networks. Default is null if IMSI is
	* not supported or unavailable.
	*
	* @return null if SIM is not yet ready or unavailable
	*/
	public String getIMSI() {
	return null;
	}

	public String getMsisdnNumber() {
	return msisdn;
	}

	/**
	* Set subscriber number to SIM record
	*
	* The subscriber number is stored in EF_MSISDN (TS 51.011)
	*
	* When the operation is complete, onComplete will be sent to its handler
	*
	* @param alphaTag alpha-tagging of the dailing nubmer (up to 10 characters)
	* @param number dailing nubmer (up to 20 digits)
	* if the number starts with '+', then set to international TOA
	* @param onComplete
	* onComplete.obj will be an AsyncResult
	* ((AsyncResult)onComplete.obj).exception == null on success
	* ((AsyncResult)onComplete.obj).exception != null on fail
	*/
	public void setMsisdnNumber(String alphaTag, String number,
	Message onComplete) {

	msisdn = number;
	msisdnTag = alphaTag;

	if(DBG) log("Set MSISDN: " + msisdnTag +" " + msisdn);


	AdnRecord adn = new AdnRecord(msisdnTag, msisdn);

	new AdnRecordLoader(phone).updateEF(adn, EF_MSISDN, EF_EXT1, 1, null,
	obtainMessage(EVENT_SET_MSISDN_DONE, onComplete));
	}

	public String getMsisdnAlphaTag() {
	return msisdnTag;
	}

	public String getVoiceMailNumber() {
	return voiceMailNum;
	}

	/**
	* Return Service Provider Name stored in SIM (EF_SPN=0x6F46) or in RUIM (EF_RUIM_SPN=0x6F41)
	* @return null if SIM is not yet ready or no RUIM entry
	*/
	public String getServiceProviderName() {
	return spn;
	}

	/**
	* Set voice mail number to SIM record
	*
	* The voice mail number can be stored either in EF_MBDN (TS 51.011) or
	* EF_MAILBOX_CPHS (CPHS 4.2)
	*
	* If EF_MBDN is available, store the voice mail number to EF_MBDN
	*
	* If EF_MAILBOX_CPHS is enabled, store the voice mail number to EF_CHPS
	*
	* So the voice mail number will be stored in both EFs if both are available
	*
	* Return error only if both EF_MBDN and EF_MAILBOX_CPHS fail.
	*
	* When the operation is complete, onComplete will be sent to its handler
	*
	* @param alphaTag alpha-tagging of the dailing nubmer (upto 10 characters)
	* @param voiceNumber dailing nubmer (upto 20 digits)
	* if the number is start with '+', then set to international TOA
	* @param onComplete
	* onComplete.obj will be an AsyncResult
	* ((AsyncResult)onComplete.obj).exception == null on success
	* ((AsyncResult)onComplete.obj).exception != null on fail
	*/
	public abstract void setVoiceMailNumber(String alphaTag, String voiceNumber,
	Message onComplete);

	public String getVoiceMailAlphaTag() {
	return voiceMailTag;
	}

	/**
	* Sets the SIM voice message waiting indicator records
	* @param line GSM Subscriber Profile Number, one-based. Only '1' is supported
	* @param countWaiting The number of messages waiting, if known. Use
	* -1 to indicate that an unknown number of
	* messages are waiting
	*/
	public abstract void setVoiceMessageWaiting(int line, int countWaiting);

	/** @return true if there are messages waiting, false otherwise. */
	public boolean getVoiceMessageWaiting() {
	return countVoiceMessages != 0;
	}

	/**
	* Returns number of voice messages waiting, if available
	* If not available (eg, on an older CPHS SIM) -1 is returned if
	* getVoiceMessageWaiting() is true
	*/
	public int getVoiceMessageCount() {
	return countVoiceMessages;
	}

	/**
	* Called by STK Service when REFRESH is received.
	* @param fileChanged indicates whether any files changed
	* @param fileList if non-null, a list of EF files that changed
	*/
	public abstract void onRefresh(boolean fileChanged, int[] fileList);


	public boolean getRecordsLoaded() {
	if (recordsToLoad == 0 && recordsRequested == true) {
	return true;
	} else {
	return false;
	}
	}

	//***** Overridden from Handler
	@Override
	public void handleMessage(Message msg) {
	switch (msg.what) {
	case EVENT_GET_ICC_RECORD_DONE:
	try {
	AsyncResult ar = (AsyncResult) msg.obj;
	IccRecordLoaded recordLoaded = (IccRecordLoaded) ar.userObj;
	if (DBG) log(recordLoaded.getEfName() + " LOADED");

	if (ar.exception != null) {
	loge("Record Load Exception: " + ar.exception);
	} else {
	recordLoaded.onRecordLoaded(ar);
	}
	}catch (RuntimeException exc) {
	// I don't want these exceptions to be fatal
	loge("Exception parsing SIM record: " + exc);
	} finally {
	// Count up record load responses even if they are fails
	onRecordLoaded();
	}
	break;

	default:
	super.handleMessage(msg);
	}
	}

	protected abstract void onRecordLoaded();

	protected abstract void onAllRecordsLoaded();

	/**
	* Returns the SpnDisplayRule based on settings on the SIM and the
	* specified plmn (currently-registered PLMN). See TS 22.101 Annex A
	* and TS 51.011 10.3.11 for details.
	*
	* If the SPN is not found on the SIM, the rule is always PLMN_ONLY.
	* Generally used for GSM/UMTS and the like SIMs.
	*/
	public abstract int getDisplayRule(String plmn);

	/**
	* Return true if "Restriction of menu options for manual PLMN selection"
	* bit is set or EF_CSP data is unavailable, return false otherwise.
	* Generally used for GSM/UMTS and the like SIMs.
	*/
	public boolean isCspPlmnEnabled() {
	return false;
	}

	/**
	* Returns the 5 or 6 digit MCC/MNC of the operator that
	* provided the SIM card. Returns null of SIM is not yet ready
	* or is not valid for the type of IccCard. Generally used for
	* GSM/UMTS and the like SIMS
	*/
	public String getOperatorNumeric() {
	return null;
	}

	/**
	* Get the current Voice call forwarding flag for GSM/UMTS and the like SIMs
	*
	* @return true if enabled
	*/
	public boolean getVoiceCallForwardingFlag() {
	return false;
	}

	/**
	* Set the voice call forwarding flag for GSM/UMTS and the like SIMs
	*
	* @param line to enable/disable
	* @param enable
	*/
	public void setVoiceCallForwardingFlag(int line, boolean enable) {
	}

	/**
	* Indicates wether SIM is in provisioned state or not.
	* Overridden only if SIM can be dynamically provisioned via OTA.
	*
	* @return true if provisioned
	*/
	public boolean isProvisioned () {
	return true;
	}

	/**
	* Write string to log file
	*
	* @param s is the string to write
	*/
	protected abstract void log(String s);

	/**
	* Write error string to log file.
	*
	* @param s is the string to write
	*/
	protected abstract void loge(String s);

	/**
	* Return an interface to retrieve the ISIM records for IMS, if available.
	* @return the interface to retrieve the ISIM records, or null if not supported
	*/
	public IsimRecords getIsimRecords() {
	return null;
	}

	public UsimServiceTable getUsimServiceTable() {
	return null;
	}
	}