core/src/com/google/zxing/client/result/VCardResultParser.java

   1 /*
   2  * Copyright 2008 ZXing 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
  17 package com.google.zxing.client.result;
  18
  19 import com.google.zxing.Result;
  20
  21 import java.util.Vector;
  22
  23 /**
  24  * Parses contact information formatted according to the VCard (2.1) format. This is not a complete
  25  * implementation but should parse information as commonly encoded in 2D barcodes.
  26  *
  27  * @author srowen@google.com (Sean Owen)
  28  */
  29 final class VCardResultParser extends ResultParser {
  30
  31   private VCardResultParser() {
  32   }
  33
  34   public static AddressBookParsedResult parse(Result result) {
  35     String rawText = result.getText();
  36     if (rawText == null || !rawText.startsWith("BEGIN:VCARD") || !rawText.endsWith("END:VCARD")) {
  37       return null;
  38     }
  39     String[] names = matchVCardPrefixedField("FN", rawText, true);
  40     if (names == null) {
  41       // If no display names found, look for regular name fields and format them
  42       names = matchVCardPrefixedField("N", rawText, true);
  43       formatNames(names);
  44     }
  45     String[] phoneNumbers = matchVCardPrefixedField("TEL", rawText, true);
  46     String[] emails = matchVCardPrefixedField("EMAIL", rawText, true);
  47     String note = matchSingleVCardPrefixedField("NOTE", rawText, false);
  48     String address = matchSingleVCardPrefixedField("ADR", rawText, true);
  49     address = formatAddress(address);
  50     String org = matchSingleVCardPrefixedField("ORG", rawText, true);
  51     String birthday = matchSingleVCardPrefixedField("BDAY", rawText, true);
  52     if (birthday != null && !isStringOfDigits(birthday, 8)) {
  53       return null;
  54     }
  55     String title = matchSingleVCardPrefixedField("TITLE", rawText, true);
  56     return new AddressBookParsedResult(names, phoneNumbers, emails, note, address, org, birthday, title);
  57   }
  58
  59   private static String[] matchVCardPrefixedField(String prefix, String rawText, boolean trim) {
  60     Vector matches = null;
  61     int i = 0;
  62     final int max = rawText.length();
  63     while (i < max) {
  64       i = rawText.indexOf(prefix, i);
  65       if (i < 0) {
  66         break;
  67       }
  68       if (i > 0 && rawText.charAt(i - 1) != '\n') {
  69         // then this didn't start a new token, we matched in the middle of something
  70         i++;
  71         continue;
  72       }
  73       i += prefix.length(); // Skip past this prefix we found to start
  74       if (rawText.charAt(i) != ':' && rawText.charAt(i) != ';') {
  75         continue;
  76       }
  77       while (rawText.charAt(i) != ':') { // Skip until a colon
  78         i++;
  79       }
  80       i++; // skip colon
  81       int start = i; // Found the start of a match here
  82       i = rawText.indexOf((int) '\n', i); // Really, ends in \r\n
  83       if (i < 0) {
  84         // No terminating end character? uh, done. Set i such that loop terminates and break
  85         i = max;
  86       } else if (i > start) {
  87         // found a match
  88         if (matches == null) {
  89           matches = new Vector(3); // lazy init
  90         }
  91         String element = rawText.substring(start, i);
  92         if (trim) {
  93           element = element.trim();
  94         }
  95         matches.addElement(element);
  96         i++;
  97       } else {
  98         i++;
  99       }
 100     }
 101     if (matches == null || matches.isEmpty()) {
 102       return null;
 103     }
 104     return toStringArray(matches);
 105   }
 106
 107   static String matchSingleVCardPrefixedField(String prefix, String rawText, boolean trim) {
 108     String[] values = matchVCardPrefixedField(prefix, rawText, trim);
 109     return values == null ? null : values[0];
 110   }
 111
 112   private static String formatAddress(String address) {
 113     if (address == null) {
 114       return null;
 115     }
 116     int length = address.length();
 117     StringBuffer newAddress = new StringBuffer(length);
 118     for (int j = 0; j < length; j++) {
 119       char c = address.charAt(j);
 120       if (c == ';') {
 121         newAddress.append(' ');
 122       } else {
 123         newAddress.append(c);
 124       }
 125     }
 126     return newAddress.toString().trim();
 127   }
 128
 129   /**
 130    * Formats name fields of the form "Public;John;Q.;Reverend;III" into a form like
 131    * "Reverend John Q. Public III".
 132    *
 133    * @param names name values to format, in place
 134    */
 135   private static void formatNames(String[] names) {
 136     if (names != null) {
 137       for (int i = 0; i < names.length; i++) {
 138         String name = names[i];
 139         String[] components = new String[5];
 140         int start = 0;
 141         int end;
 142         int componentIndex = 0;
 143         while ((end = name.indexOf(';', start)) > 0) {
 144           components[componentIndex] = name.substring(start, end);
 145           componentIndex++;
 146           start = end + 1;
 147         }
 148         components[componentIndex] = name.substring(start);
 149         StringBuffer newName = new StringBuffer();
 150         maybeAppendComponent(components, 3, newName);
 151         maybeAppendComponent(components, 1, newName);
 152         maybeAppendComponent(components, 2, newName);
 153         maybeAppendComponent(components, 0, newName);
 154         maybeAppendComponent(components, 4, newName);
 155         names[i] = newName.toString().trim();
 156       }
 157     }
 158   }
 159
 160   private static void maybeAppendComponent(String[] components, int i, StringBuffer newName) {
 161     if (components[i] != null) {
 162       newName.append(' ');
 163       newName.append(components[i]);
 164     }
 165   }
 166
 167 }