JAVA,CPP: libphonenumber 4.1.

Review URL: http://codereview.appspot.com/5303049

cpp/CMakeLists.txt

@@ -18,7 +18,7 @@ cmake_minimum_required (VERSION 2.8)
 
 project (libphonenumber)
 set (libphonenumber_VERSION_MAJOR 4)
-set (libphonenumber_VERSION_MINOR 0)
+set (libphonenumber_VERSION_MINOR 1)
 
 # Helper functions dealing with finding libraries and programs this library
 # depends on.

cpp/src/phonenumbers/phonenumberutil.cc

@@ -1117,6 +1117,10 @@ void PhoneNumberUtil::FormatInOriginalFormat(const PhoneNumber& number,
                                              string* formatted_number) const {
   DCHECK(formatted_number);
 
+  if (number.has_raw_input() && !IsValidNumber(number)) {
+    formatted_number->assign(number.raw_input());
+    return;
+  }
   if (!number.has_country_code_source()) {
     Format(number, NATIONAL, formatted_number);
     return;
@@ -1917,13 +1921,6 @@ PhoneNumberUtil::MaybeStripInternationalPrefixAndNormalize(
   }
   // Attempt to parse the first digits as an international prefix.
   const RegExp& idd_pattern = regexp_cache->GetRegExp(possible_idd_prefix);
-  if (ParsePrefixAsIdd(idd_pattern, number)) {
-    Normalize(number);
-    return PhoneNumber::FROM_NUMBER_WITH_IDD;
-  }
-  // If still not found, then try and normalize the number and then try again.
-  // This shouldn't be done before, since non-numeric characters (+ and ~) may
-  // legally be in the international prefix.
   Normalize(number);
   return ParsePrefixAsIdd(idd_pattern, number)
       ? PhoneNumber::FROM_NUMBER_WITH_IDD

cpp/src/phonenumbers/phonenumberutil.h

@@ -325,7 +325,8 @@ class PhoneNumberUtil : public Singleton<PhoneNumberUtil> {
   // number is parsed from. The original format is embedded in the
   // country_code_source field of the PhoneNumber object passed in. If such
   // information is missing, the number will be formatted into the NATIONAL
-  // format by default.
+  // format by default. When the number is an invalid number, the method returns
+  // the raw input when it is available.
   void FormatInOriginalFormat(const PhoneNumber& number,
                               const string& region_calling_from,
                               string* formatted_number) const;
@@ -548,7 +549,9 @@ class PhoneNumberUtil : public Singleton<PhoneNumberUtil> {
 
   // The minimum and maximum length of the national significant number.
   static const size_t kMinLengthForNsn = 3;
-  static const size_t kMaxLengthForNsn = 15;
+  // The ITU says the maximum length should be 15, but we have found longer
+  // numbers in Germany.
+  static const size_t kMaxLengthForNsn = 16;
   // The maximum length of the country calling code.
   static const size_t kMaxLengthCountryCode = 3;
 

cpp/test/phonenumbers/phonenumberutil_test.cc

@@ -543,7 +543,7 @@ TEST_F(PhoneNumberUtilTest, FormatOutOfCountryCallingNumber) {
   EXPECT_EQ("1 650 253 0000", formatted_number);
   phone_util_.FormatOutOfCountryCallingNumber(test_number, RegionCode::PL(),
                                               &formatted_number);
-  EXPECT_EQ("0~0 1 650 253 0000", formatted_number);
+  EXPECT_EQ("00 1 650 253 0000", formatted_number);
 
   test_number.set_country_code(44);
   test_number.set_national_number(7912345678ULL);
@@ -1280,7 +1280,7 @@ TEST_F(PhoneNumberUtilTest, IsPossibleNumberWithReason) {
   EXPECT_EQ(PhoneNumberUtil::TOO_SHORT,
             phone_util_.IsPossibleNumberWithReason(ad_number));
   ad_number.set_country_code(376);
-  ad_number.set_national_number(1234567890123456ULL);
+  ad_number.set_national_number(12345678901234567ULL);
   EXPECT_EQ(PhoneNumberUtil::TOO_LONG,
             phone_util_.IsPossibleNumberWithReason(ad_number));
 }
@@ -1421,6 +1421,27 @@ TEST_F(PhoneNumberUtilTest, FormatUsingOriginalNumberFormat) {
   phone_util_.FormatInOriginalFormat(phone_number, RegionCode::GB(),
                                      &formatted_number);
   EXPECT_EQ("(020) 8765 4321", formatted_number);
+
+  // Invalid numbers should be formatted using its raw input when that is
+  // available. Note area codes starting with 7 are intentionally excluded in
+  // the test metadata for testing purposes.
+  phone_number.Clear();
+  formatted_number.clear();
+  EXPECT_EQ(PhoneNumberUtil::NO_PARSING_ERROR,
+            phone_util_.ParseAndKeepRawInput("7345678901", RegionCode::US(),
+                                             &phone_number));
+  phone_util_.FormatInOriginalFormat(phone_number, RegionCode::US(),
+                                     &formatted_number);
+  EXPECT_EQ("7345678901", formatted_number);
+
+  // When the raw input is unavailable, format as usual.
+  phone_number.Clear();
+  formatted_number.clear();
+  EXPECT_EQ(PhoneNumberUtil::NO_PARSING_ERROR,
+            phone_util_.Parse("7345678901", RegionCode::US(), &phone_number));
+  phone_util_.FormatInOriginalFormat(phone_number, RegionCode::US(),
+                                     &formatted_number);
+  EXPECT_EQ("734 567 8901", formatted_number);
 }
 
 TEST_F(PhoneNumberUtilTest, IsPremiumRate) {

debian/changelog

@@ -1,3 +1,9 @@
+libphonenumber (4.1) lucid; urgency=low
+
+  * Version update.
+
+ -- Fredrik Roubert <roubert@google.com>  Wed, 19 Oct 2011 13:30:18 +0200
+
 libphonenumber (4.0) lucid; urgency=low
 
   * Version update.

java/release_notes.txt

@@ -1,3 +1,26 @@
+October 19th, 2011: libphonenumber-4.1
+* Code changes
+ - Update code and metadata for countries with IDD "8~10" to accept phone
+   numbers where the "~" is omitted.
+ - Modify formatInOriginalFormat to use raw_input (when present) when the number
+   is considered as invalid by the library.
+ - Add ShortNumberUtil to deal with international short phone numbers, such as
+   short codes and emergency numbers.
+ - Increase the maximum phone-number length accepted when parsing (now set to
+   16).
+
+* Metadata changes
+ - Updates: BF, BN, CN, DE, DK, DO, FR, IN, KI, KW, MC, MD, ML, PA, QA, SB, UK,
+   WS
+ - Emergency number information also added to: AE, AF, AL, AM, AR, AT, AU, BA,
+   BB, BD, BE, BG, BH, BO, BR, BY, CA, CH, CL, CN, CO, CR, CY, CZ, DE, DJ, DK,
+   DO, DZ, EC, EE, EG, ES, FI, FJ, FO, FR, GB, GE, GF, GH, GI, GL, GR, GT, GY,
+   HK, HN, HR, HU, ID, IE, IL, IN, IR, IS, IT, JM, JO, JP, KR, KW, KY, KZ, LB,
+   LK, LT, LU, LV, MA, MC, MD, ME, MK, ML, MM, MN, MO, MT, MU, MV, MX, MY, NG,
+   NI, NL, NO, NP, OM, PA, PE, PH, PK, PL, PM, PT, PY, QA, RO, RS, RU, RW, SA,
+   SB, SD, SE, SG, SI, SK, SL, SM, SR, SV, SY, TD, TH, TJ, TM, TN, TR, TT, TW,
+   UA, UG, US, UY, UZ, VA, VE, VN, VU, ZA, ZM, ZW
+
 October 6th, 2011: libphonenumber-4.0
 * Code changes
  - New function formatNumberForMobileDialing, which attempts to format a number in

java/src/com/google/i18n/phonenumbers/PhoneNumberUtil.java

@@ -59,7 +59,8 @@ public class PhoneNumberUtil {
   static final int REGEX_FLAGS = Pattern.UNICODE_CASE | Pattern.CASE_INSENSITIVE;
   // The minimum and maximum length of the national significant number.
   private static final int MIN_LENGTH_FOR_NSN = 3;
-  static final int MAX_LENGTH_FOR_NSN = 15;
+  // The ITU says the maximum length should be 15, but we have found longer numbers in Germany.
+  static final int MAX_LENGTH_FOR_NSN = 16;
   // The maximum length of the country calling code.
   static final int MAX_LENGTH_COUNTRY_CODE = 3;
   static final String META_DATA_FILE_PREFIX =
@@ -651,7 +652,6 @@ public class PhoneNumberUtil {
    *                string if no character used to start phone numbers (such as + or any digit) is
    *                found in the number
    */
-  // @VisibleForTesting
   static String extractPossibleNumber(String number) {
     Matcher m = VALID_START_CHAR_PATTERN.matcher(number);
     if (m.find()) {
@@ -1280,7 +1280,8 @@ public class PhoneNumberUtil {
    * Formats a phone number using the original phone number format that the number is parsed from.
    * The original format is embedded in the country_code_source field of the PhoneNumber object
    * passed in. If such information is missing, the number will be formatted into the NATIONAL
-   * format by default.
+   * format by default. When the number is an invalid number, the method returns the raw input when
+   * it is available.
    *
    * @param number  the phone number that needs to be formatted in its original number format
    * @param regionCallingFrom  the region whose IDD needs to be prefixed if the original number
@@ -1288,6 +1289,9 @@ public class PhoneNumberUtil {
    * @return  the formatted phone number in its original number format
    */
   public String formatInOriginalFormat(PhoneNumber number, String regionCallingFrom) {
+    if (number.hasRawInput() && !isValidNumber(number)) {
+      return number.getRawInput();
+    }
     if (!number.hasCountryCodeSource()) {
       return format(number, PhoneNumberFormat.NATIONAL);
     }
@@ -2203,13 +2207,6 @@ public class PhoneNumberUtil {
     }
     // Attempt to parse the first digits as an international prefix.
     Pattern iddPattern = regexCache.getPatternForRegex(possibleIddPrefix);
-    if (parsePrefixAsIdd(iddPattern, number)) {
-      normalize(number);
-      return CountryCodeSource.FROM_NUMBER_WITH_IDD;
-    }
-    // If still not found, then try and normalize the number and then try again. This shouldn't be
-    // done before, since non-numeric characters (+ and ~) may legally be in the international
-    // prefix.
     normalize(number);
     return parsePrefixAsIdd(iddPattern, number)
            ? CountryCodeSource.FROM_NUMBER_WITH_IDD

java/src/com/google/i18n/phonenumbers/ShortNumberUtil.java

@@ -0,0 +1,77 @@
+/*
+ * Copyright (C) 2011 The Libphonenumber Authors
+ *
+ * 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.google.i18n.phonenumbers;
+
+import com.google.i18n.phonenumbers.Phonemetadata.PhoneNumberDesc;
+
+import java.util.regex.Pattern;
+
+/*
+ * Utility for international short phone numbers, such as short codes and emergency numbers. Note
+ * most commercial short numbers are not handled here, but by the PhoneNumberUtil.
+ *
+ * @author Shaopeng Jia
+ */
+public class ShortNumberUtil {
+
+  private static PhoneNumberUtil phoneUtil;
+
+  public ShortNumberUtil() {
+    phoneUtil = PhoneNumberUtil.getInstance();
+  }
+
+  // @VisibleForTesting
+  ShortNumberUtil(PhoneNumberUtil util) {
+    phoneUtil = util;
+  }
+
+  /**
+   * Returns true if the number might be used to connect to an emergency service in the given
+   * region.
+   *
+   * This method takes into account cases where the number might contain formatting, or might have
+   * additional digits appended (when it is okay to do that in the region specified).
+   *
+   * @param number  the phone number to test
+   * @param regionCode  the region where the phone number is being dialed
+   * @return  if the number might be used to connect to an emergency service in the given region.
+   */
+  public boolean connectsToEmergencyNumber(String number, String regionCode) {
+    number = PhoneNumberUtil.extractPossibleNumber(number);
+    if (PhoneNumberUtil.PLUS_CHARS_PATTERN.matcher(number).lookingAt()) {
+      // Returns false if the number starts with a plus sign. We don't believe dialing the country
+      // code before emergency numbers (e.g. +1911) works, but later, if that proves to work, we can
+      // add additional logic here to handle it.
+      return false;
+    }
+    String normalizedNumber = PhoneNumberUtil.normalizeDigitsOnly(number);
+    PhoneNumberDesc emergencyNumberDesc = phoneUtil.getMetadataForRegion(regionCode).getEmergency();
+    Pattern emergencyNumberPattern =
+        Pattern.compile(emergencyNumberDesc.getNationalNumberPattern());
+    if (regionCode == "BR") {
+      // This is to prevent Brazilian local numbers which start with 911 being incorrectly
+      // classified as emergency numbers. In Brazil, it is impossible to append additional digits to
+      // an emergency number to dial the number.
+      if (!emergencyNumberPattern.matcher(normalizedNumber).matches()) {
+        return false;
+      }
+    }
+
+    // Check the prefix against possible emergency numbers for this region.
+    return emergencyNumberPattern.matcher(normalizedNumber).lookingAt();
+  }
+}