package gov.uspto.patent.model;

import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import com.google.common.base.Preconditions;
import com.google.common.base.Strings;

import gov.uspto.patent.InvalidDataException;

/**
 * Document ID for Patents and Patent Applications
 *
 * <p>
 * <h3>US Patent Document IDs are alpha-numeric (letters and numbers)</h3>
 * <ul>
 * <li>Design Patent</li>
 * <ul>
 * <li>start with "D" e.g. D321987</li>
 * </ul>
 * <li>Plant Patent</li>
 * <ul>
 * <li>start with "PP" e.g. PP07514</li>
 * </ul>
 * <li>Reissued Patents</li>
 * <ul>
 * <li>start with "RE" e.g. RE12345</li>
 * </ul>
 * <li>Fractional Patents</li>
 * <ul>
 * <li>end with [A-O] e.g. D90793½ becomes D90793H</li>
 * <li>issued ____ to 1966</li>
 * <li>purpose was to group patent families issued together</li>
 * </ul>
 * <li>Additions of Improvements</li>
 * <ul>
 * <li>start with "AI" e.g. AI000318</li>
 * <li>issued 1838 to 1861</li>
 * <li>about 300 issued</li>
 * <li>replace by a continuing patent application (continuation, divisional, or
 * continuation-in-part)</li>
 * </ul>
 * <li>X-Patents</li>
 * <ul>
 * <li>start with "X" e.g. X007640 or X9670H</li>
 * <li>issued July 1790 to July 1836</li>
 * <li>USPTO fire of July 1836, majority of patents destroyed</li>
 * <li>approximately 106 patent where recovered; inventors where asked to
 * provide their copies</li>
 * </ul>
 * <li>X-Patents Reissued</li>
 * <ul>
 * <li>start with "RX" e.g. RX00116</li>
 * </ul>
 * </ul>
 * </p>
 *
 * <p>
 * <h3>Defensive Publication or Disclosure</h3> Mostly unneeded once
 * applications became public after 18 months, started in 1999 from the American
 * Inventors Protection Act "AIPA"; Similar protections exist by filing and
 * abandoning an application.
 * <ul>
 * <li>Statutory Invention Registration (SIR) / H-Documents</li>
 * <ul>
 * <li>start with "H" e.g. H001234</li>
 * <li>issued May 8, 1985 to March 16, 2013 (America Invents Act "AIA")</li>
 * <li>replaced Defensive Publication</li>
 * <li>replaced by the publishing of applications</li>
 * </ul>
 * <li>Defensive Publication / Technical Disclosure / T-Documents</li>
 * <ul>
 * <li>start with "T" e.g. T855019</li>
 * <li>issued April 1968 to May 8, 1985</li>
 * <li>replaced by Statutory Invention Registration (SIR)</li>
 * </ul>
 * <li>IBM technical disclosure bulletin (TDB)</li>
 * <ul>
 * <li>issued 1968 to 1998</li>
 * <li>more than 83,500 issued</li>
 * <li>Used by patent examiners</li>
 * <li>cited 48,000+ times in US patents</li>
 * <li>example cite: IBM Technical Disclosure Bulletin, vol. 36, No. 6A, Jun.
 * 1993, pp. 261-264.</li>
 * </ul>
 * </ul>
 *
 * <p>
 * <h3>Take Note</h3> Any patent can cite anything from the past, which includes
 * disclosures, X-Patents and Fractional Patents.
 * </p>
 *
 * @see WIPO ST.14.
 * @see https://en.wikipedia.org/wiki/X-Patent
 */
public class DocumentId implements Comparable<DocumentId> {
	private DocumentIdType docIdType;
	private CountryCode countryCode;
	private String docNumber;
	private String name; // name used in citation.
	private String kindCode; // different patent offices have different kindcodes.
	private DocumentDate date;
	private PatentType patentType; // defined with application id or derived from kindcode.
	private String rawText; // capture raw string before parsing into parts; mainly for debugging.
	private boolean allowLeadingZeros; // Need this for the one case in greenbook where the appId has a zero

	/*
	 * Parsing of Document Id into its parts, such as Citation PatentIds.
	 */
	private static final Pattern PARSE_PATTERN = Pattern.compile("^(\\D\\D)(\\d{1,4}[/-])?(X?\\d+)(\\D\\d?)?$");

	public DocumentId(CountryCode countryCode, String docNumber) throws IllegalArgumentException {
		this(countryCode, docNumber, null);
	}

	public DocumentId(CountryCode countryCode, String docNumber, boolean allowLeadingZeros)
			throws IllegalArgumentException {
		this(countryCode, docNumber, null, allowLeadingZeros);
	}

	public DocumentId(CountryCode countryCode, String docNumber, String kindCode) {
		Preconditions.checkNotNull(countryCode, "CountryCode can not be set to Null");
		Preconditions.checkNotNull(docNumber, "DocNumber can not be set to Null");

		this.countryCode = countryCode;
		setDocNumber(docNumber);
		this.kindCode = kindCode;
	}

	public DocumentId(CountryCode countryCode, String docNumber, String kindCode, boolean allowLeadingZeros) {
		Preconditions.checkNotNull(countryCode, "CountryCode can not be set to Null");
		Preconditions.checkNotNull(docNumber, "DocNumber can not be set to Null");
		this.allowLeadingZeros = allowLeadingZeros;
		this.countryCode = countryCode;
		setDocNumber(docNumber);
		this.kindCode = kindCode;
	}

	public void setRawText(String raw) {
		this.rawText = raw;
	}

	public String getRawText() {
		return rawText;
	}

	public void setPatentType(PatentType patentType) {
		this.patentType = patentType;
	}

	public PatentType getPatentType() {
		return patentType;
	}

	public void setType(DocumentIdType docIdType) {
		Preconditions.checkNotNull(docIdType, "DocumentIdType can not be set to Null");
		this.docIdType = docIdType;
	}

	public DocumentIdType getType() {
		return docIdType;
	}

	private void setDocNumber(String publicationId) {
		Preconditions.checkNotNull(publicationId, "DocNumber can not be set to Null!");
		// Remove Leading Zeros.
		if (!allowLeadingZeros) {
			this.docNumber = publicationId.replaceFirst("^0+(?!$)", "");
		} else {
			this.docNumber = publicationId;
		}
	}

	public String getDocNumber() {
		return docNumber;
	}

	/**
	 * Full String ID Representation, example: US12345A1
	 * 
	 * @return
	 */
	public String getId() {
		StringBuilder strb = new StringBuilder();

		if (!docNumber.startsWith("PCT/")) {
			strb.append(countryCode);
		}
		strb.append(docNumber);

		if (kindCode != null) {
			strb.append(kindCode);
		}

		return strb.toString();
	}

	/**
	 * Full String ID Representation, leaving off kindcode, example: US12345
	 * 
	 * @return
	 */
	public String getIdNoKind() {
		StringBuilder strb = new StringBuilder();

		if (!docNumber.startsWith("PCT/")) {
			strb.append(countryCode);
		}
		strb.append(docNumber);

		return strb.toString();
	}

	/**
	 * Full String ID Representation, example: US12345A1
	 * 
	 * @param zeroPadMinLen - anything under provided length will be padded with
	 *                      leading zeros
	 * @return
	 */
	public String getId(int zeroPadMinLen) {
		StringBuilder strb = new StringBuilder().append(countryCode);

		strb.append(Strings.padStart(docNumber, zeroPadMinLen, '0'));

		if (kindCode != null) {
			strb.append(kindCode);
		}

		return strb.toString();
	}

	public CountryCode getCountryCode() {
		return countryCode;
	}

	public void setKindCode(String kindCode) {
		this.kindCode = kindCode;
	}

	public String getKindCode() {
		return kindCode;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public DocumentDate getDate() {
		return date;
	}

	public void setDate(DocumentDate date) {
		this.date = date;
	}

	@Override
	public boolean equals(Object o) {
		if (o == null) {
			return false;
		}

		if (!(o instanceof DocumentId)) {
			return false;
		}

		DocumentId other = (DocumentId) o;
		if (this.docNumber != null && this.docNumber != null) {
			if (this.docNumber.equals(other.docNumber) && this.docNumber.equals(other.docNumber)) {
				return true;
			} else {
				return false;
			}
		} else {
			return false;
		}
	}

	public String toTextNoKind() {
		return getIdNoKind();
	}

	public String toText() {
		return getId();
	}

	public String toText(int zeroPadMinLen) {
		return getId(zeroPadMinLen);
	}

	/**
	 * Parse Patent DocumentId into its parts.
	 * 
	 * <p>
	 * Note: this may not work for all variations from all countries, may countries
	 * may have a different numbering system, many also have multiple different
	 * numbering systems.
	 * </p>
	 * 
	 * @see http://www.wipo.int/export/sites/www/standards/en/pdf/07-02-02.pdf
	 * 
	 * @param documentIdStr
	 * @return DocumentId
	 * @throws InvalidDataException
	 */
	public static DocumentId fromText(final String documentIdStr, int year) throws InvalidDataException {
		String docIdStr = documentIdStr.replaceAll(" ", "");
		Matcher matcher = PARSE_PATTERN.matcher(docIdStr);
		if (matcher.matches()) {
			String country = matcher.group(1);

			CountryCode cntyCode = CountryCode.fromString(country);
			if (CountryCode.UNKNOWN == cntyCode || year < 1978) {
				cntyCode = CountryCodeHistory.getCurrentCode(country, year);
			}

			String applicationYear = matcher.group(2); // applications ids
														// sometimes has the
														// year.
			String id = matcher.group(3);
			String kindCode = matcher.group(4);

			DocumentId docId = new DocumentId(cntyCode, id, kindCode);
			if (applicationYear != null && applicationYear.length() == 4) {
				docId.setDate(new DocumentDate(applicationYear.replace("/", "")));
			}
			docId.setRawText(documentIdStr);
			return docId;
		} else {
			throw new InvalidDataException("Failed to parse DocumentId text: " + documentIdStr);
		}
	}

	public static List<DocumentId> getByType(Collection<DocumentId> docIds, DocumentIdType type) {
		List<DocumentId> redIds = new LinkedList<DocumentId>();

		for (DocumentId docId : docIds) {
			if (docId != null && docId.getType() == type) {
				redIds.add(docId);
			}
		}

		return redIds;
	}

	@Override
	public int compareTo(DocumentId o) {
		if (getDate() == null || o.getDate() == null || getDate().getDate() == null || o.getDate().getDate() == null) {
			return 1;
		}
		return getDate().getDate().compareTo(o.getDate().getDate());
	}

	@Override
	public String toString() {
		return "DocumentId [docIdType=" + docIdType + ", countryCode=" + countryCode + ", docNumber=" + docNumber
				+ ", name=" + name + ", kindCode=" + kindCode + ", date=" + date + ", patentType=" + patentType
				+ ", getId()=" + getId() + "]";
	}

}