java/demo/src/com/google/phonenumbers/PhoneNumberParserServlet.java

   1 /*
   2  * Copyright (C) 2011 The Libphonenumber Authors
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  * @author Shaopeng Jia
  17  */
  18
  19 package com.google.phonenumbers;
  20
  21 import com.google.i18n.phonenumbers.AsYouTypeFormatter;
  22 import com.google.i18n.phonenumbers.NumberParseException;
  23 import com.google.i18n.phonenumbers.PhoneNumberToCarrierMapper;
  24 import com.google.i18n.phonenumbers.PhoneNumberUtil;
  25 import com.google.i18n.phonenumbers.PhoneNumberUtil.PhoneNumberFormat;
  26 import com.google.i18n.phonenumbers.PhoneNumberUtil.PhoneNumberType;
  27 import com.google.i18n.phonenumbers.Phonenumber.PhoneNumber;
  28 import com.google.i18n.phonenumbers.geocoding.PhoneNumberOfflineGeocoder;
  29
  30 import org.apache.commons.fileupload.FileItemIterator;
  31 import org.apache.commons.fileupload.FileItemStream;
  32 import org.apache.commons.fileupload.FileUploadException;
  33 import org.apache.commons.fileupload.servlet.ServletFileUpload;
  34 import org.apache.commons.fileupload.util.Streams;
  35 import org.apache.commons.io.IOUtils;
  36
  37 import java.io.IOException;
  38 import java.io.InputStream;
  39 import java.util.Locale;
  40 import java.util.StringTokenizer;
  41
  42 import javax.servlet.http.HttpServlet;
  43 import javax.servlet.http.HttpServletRequest;
  44 import javax.servlet.http.HttpServletResponse;
  45
  46 /**
  47  * A servlet that accepts requests that contain strings representing a phone number and a default
  48  * country, and responds with results from parsing, validating and formatting the number. The
  49  * default country is a two-letter region code representing the country that we are expecting the
  50  * number to be from.
  51  */
  52 @SuppressWarnings("serial")
  53 public class PhoneNumberParserServlet extends HttpServlet {
  54   private PhoneNumberUtil phoneUtil = PhoneNumberUtil.getInstance();
  55   public void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException {
  56     String phoneNumber = null;
  57     String defaultCountry = null;
  58     String languageCode = "en";  // Default languageCode to English if nothing is entered.
  59     String regionCode = "";
  60     String fileContents = null;
  61     ServletFileUpload upload = new ServletFileUpload();
  62     upload.setSizeMax(50000);
  63     try {
  64       FileItemIterator iterator = upload.getItemIterator(req);
  65       while (iterator.hasNext()) {
  66         FileItemStream item = iterator.next();
  67         InputStream in = item.openStream();
  68         if (item.isFormField()) {
  69           String fieldName = item.getFieldName();
  70           if (fieldName.equals("phoneNumber")) {
  71             phoneNumber = Streams.asString(in, "UTF-8");
  72           } else if (fieldName.equals("defaultCountry")) {
  73             defaultCountry = Streams.asString(in).toUpperCase();
  74           } else if (fieldName.equals("languageCode")) {
  75             String languageEntered = Streams.asString(in).toLowerCase();
  76             if (languageEntered.length() > 0) {
  77               languageCode = languageEntered;
  78             }
  79           } else if (fieldName.equals("regionCode")) {
  80             regionCode = Streams.asString(in).toUpperCase();
  81           }
  82         } else {
  83           try {
  84             fileContents = IOUtils.toString(in);
  85           } finally {
  86             IOUtils.closeQuietly(in);
  87           }
  88         }
  89       }
  90     } catch (FileUploadException e1) {
  91       e1.printStackTrace();
  92     }
  93
  94     StringBuilder output;
  95     if (fileContents.length() == 0) {
  96       output = getOutputForSingleNumber(phoneNumber, defaultCountry, languageCode, regionCode);
  97       resp.setContentType("text/html");
  98       resp.setCharacterEncoding("UTF-8");
  99       resp.getWriter().println("<html><head>");
 100       resp.getWriter().println(
 101           "<link type=\"text/css\" rel=\"stylesheet\" href=\"/stylesheets/main.css\" />");
 102       resp.getWriter().println("</head>");
 103       resp.getWriter().println("<body>");
 104       resp.getWriter().println("Phone Number entered: " + phoneNumber + "<br>");
 105       resp.getWriter().println("defaultCountry entered: " + defaultCountry + "<br>");
 106       resp.getWriter().println(
 107           "Language entered: " + languageCode +
 108               (regionCode.length() == 0 ? "" : " (" + regionCode + ")" + "<br>"));
 109     } else {
 110       output = getOutputForFile(defaultCountry, fileContents);
 111       resp.setContentType("text/html");
 112     }
 113     resp.getWriter().println(output);
 114     resp.getWriter().println("</body></html>");
 115   }
 116
 117   private StringBuilder getOutputForFile(String defaultCountry, String fileContents) {
 118     StringBuilder output = new StringBuilder();
 119     output.append("<HTML><HEAD><TITLE>Results generated from phone numbers in the file provided:"
 120         + "</TITLE></HEAD><BODY>");
 121     output.append("<TABLE align=center border=1>");
 122     output.append("<TH align=center>ID</TH>");
 123     output.append("<TH align=center>Raw phone number</TH>");
 124     output.append("<TH align=center>Pretty formatting</TH>");
 125     output.append("<TH align=center>International format</TH>");
 126
 127     int phoneNumberId = 0;
 128     StringTokenizer tokenizer = new StringTokenizer(fileContents, ",");
 129     while (tokenizer.hasMoreTokens()) {
 130       String numberStr = tokenizer.nextToken();
 131       phoneNumberId++;
 132       output.append("<TR>");
 133       output.append("<TD align=center>").append(phoneNumberId).append(" </TD> \n");
 134       output.append("<TD align=center>").append(numberStr).append(" </TD> \n");
 135       try {
 136         PhoneNumber number = phoneUtil.parseAndKeepRawInput(numberStr, defaultCountry);
 137         boolean isNumberValid = phoneUtil.isValidNumber(number);
 138         String prettyFormat = isNumberValid
 139             ? phoneUtil.formatInOriginalFormat(number, defaultCountry)
 140             : "invalid";
 141         String internationalFormat = isNumberValid
 142             ? phoneUtil.format(number, PhoneNumberFormat.INTERNATIONAL)
 143             : "invalid";
 144
 145         output.append("<TD align=center>").append(prettyFormat).append(" </TD> \n");
 146         output.append("<TD align=center>").append(internationalFormat).append(" </TD> \n");
 147       } catch (NumberParseException e) {
 148         output.append("<TD align=center colspan=2>").append(e.toString()).append(" </TD> \n");
 149       }
 150       output.append("</TR>");
 151     }
 152     output.append("</BODY></HTML>");
 153     return output;
 154   }
 155
 156   private void appendLine(String title, String data, StringBuilder output) {
 157     output.append("<TR>");
 158     output.append("<TH>").append(title).append("</TH>");
 159     output.append("<TD>").append(data.length() > 0 ? data : "&nbsp;").append("</TD>");
 160     output.append("</TR>");
 161   }
 162
 163   /**
 164    * The defaultCountry here is used for parsing phoneNumber. The languageCode and regionCode are
 165    * used to specify the language used for displaying the area descriptions generated from phone
 166    * number geocoding.
 167    */
 168   private StringBuilder getOutputForSingleNumber(
 169       String phoneNumber, String defaultCountry, String languageCode, String regionCode) {
 170     StringBuilder output = new StringBuilder();
 171     try {
 172       PhoneNumber number = phoneUtil.parseAndKeepRawInput(phoneNumber, defaultCountry);
 173       output.append("<DIV>");
 174       output.append("<TABLE border=1>");
 175       output.append("<TR><TD colspan=2>Parsing Result</TD></TR>");
 176
 177       appendLine("country_code", Integer.toString(number.getCountryCode()), output);
 178       appendLine("national_number", Long.toString(number.getNationalNumber()), output);
 179       appendLine("extension", number.getExtension(), output);
 180       appendLine("country_code_source", number.getCountryCodeSource().toString(), output);
 181       appendLine("italian_leading_zero", Boolean.toString(number.isItalianLeadingZero()), output);
 182       appendLine("raw_input", number.getRawInput(), output);
 183       output.append("</TABLE>");
 184       output.append("</DIV>");
 185
 186       boolean isPossible = phoneUtil.isPossibleNumber(number);
 187       boolean isNumberValid = phoneUtil.isValidNumber(number);
 188       PhoneNumberType numberType = phoneUtil.getNumberType(number);
 189
 190       output.append("<DIV>");
 191       output.append("<TABLE border=1>");
 192       output.append("<TR><TD colspan=2>Validation Results</TD></TR>");
 193       appendLine("Result from isPossibleNumber()", Boolean.toString(isPossible), output);
 194       if (!isPossible) {
 195         appendLine("Result from isPossibleNumberWithReason()",
 196                    phoneUtil.isPossibleNumberWithReason(number).toString(), output);
 197         output.append("<TR><TD colspan=2>Note: numbers that are not possible have type " +
 198                       "UNKNOWN, an unknown region, and are considered invalid.</TD></TR>");
 199       } else {
 200         appendLine("Result from isValidNumber()", Boolean.toString(isNumberValid), output);
 201         if (isNumberValid) {
 202           if (!defaultCountry.isEmpty() && defaultCountry != "ZZ") {
 203             appendLine(
 204                 "Result from isValidNumberForRegion()",
 205                 Boolean.toString(phoneUtil.isValidNumberForRegion(number, defaultCountry)),
 206                 output);
 207           }
 208         }
 209         String region = phoneUtil.getRegionCodeForNumber(number);
 210         appendLine("Phone Number region", region == null ? "" : region, output);
 211         appendLine("Result from getNumberType()", numberType.toString(), output);
 212       }
 213       output.append("</TABLE>");
 214       output.append("</DIV>");
 215
 216       output.append("<DIV>");
 217       output.append("<TABLE border=1>");
 218       output.append("<TR><TD colspan=2>Formatting Results</TD></TR>");
 219       appendLine("E164 format",
 220                  isNumberValid ? phoneUtil.format(number, PhoneNumberFormat.E164) : "invalid",
 221                  output);
 222       appendLine("Original format",
 223                  phoneUtil.formatInOriginalFormat(number, defaultCountry), output);
 224       appendLine("National format", phoneUtil.format(number, PhoneNumberFormat.NATIONAL), output);
 225       appendLine(
 226           "International format",
 227           isNumberValid ? phoneUtil.format(number, PhoneNumberFormat.INTERNATIONAL) : "invalid",
 228           output);
 229       appendLine(
 230           "Out-of-country format from US",
 231           isNumberValid ? phoneUtil.formatOutOfCountryCallingNumber(number, "US") : "invalid",
 232           output);
 233       appendLine(
 234           "Out-of-country format from CH",
 235           isNumberValid ? phoneUtil.formatOutOfCountryCallingNumber(number, "CH") : "invalid",
 236           output);
 237       output.append("</TABLE>");
 238       output.append("</DIV>");
 239
 240       AsYouTypeFormatter formatter = phoneUtil.getAsYouTypeFormatter(defaultCountry);
 241       int rawNumberLength = phoneNumber.length();
 242       output.append("<DIV>");
 243       output.append("<TABLE border=1>");
 244       output.append("<TR><TD colspan=2>AsYouTypeFormatter Results</TD></TR>");
 245       for (int i = 0; i < rawNumberLength; i++) {
 246         // Note this doesn't handle supplementary characters, but it shouldn't be a big deal as
 247         // there are no dial-pad characters in the supplementary range.
 248         char inputChar = phoneNumber.charAt(i);
 249         appendLine("Char entered: '" + inputChar + "' Output: ",
 250                    formatter.inputDigit(inputChar), output);
 251       }
 252       output.append("</TABLE>");
 253       output.append("</DIV>");
 254
 255       if (isNumberValid) {
 256         output.append("<DIV>");
 257         output.append("<TABLE border=1>");
 258         output.append("<TR><TD colspan=2>PhoneNumberOfflineGeocoder Results</TD></TR>");
 259         appendLine(
 260             "Location",
 261             PhoneNumberOfflineGeocoder.getInstance().getDescriptionForNumber(
 262                 number, new Locale(languageCode, regionCode)),
 263             output);
 264         output.append("</TABLE>");
 265         output.append("</DIV>");
 266
 267         if (numberType == PhoneNumberType.MOBILE ||
 268             numberType == PhoneNumberType.FIXED_LINE_OR_MOBILE ||
 269             numberType == PhoneNumberType.PAGER) {
 270           output.append("<DIV>");
 271           output.append("<TABLE border=1>");
 272           output.append("<TR><TD colspan=2>PhoneNumberToCarrierMapper Results</TD></TR>");
 273           appendLine(
 274               "Carrier",
 275               PhoneNumberToCarrierMapper.getInstance().getDescriptionForNumber(
 276                   number, new Locale(languageCode, regionCode)),
 277               output);
 278           output.append("</TABLE>");
 279           output.append("</DIV>");
 280         }
 281       }
 282     } catch (NumberParseException e) {
 283       output.append(e.toString());
 284     }
 285     return output;
 286   }
 287 }