src/com/hughes/android/dictionary/parser/EnWiktionaryXmlParser.java

   1 // Copyright 2011 Google Inc. All Rights Reserved.
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 package com.hughes.android.dictionary.parser;
  16
  17 import java.io.BufferedInputStream;
  18 import java.io.DataInputStream;
  19 import java.io.EOFException;
  20 import java.io.File;
  21 import java.io.FileInputStream;
  22 import java.io.IOException;
  23 import java.util.ArrayList;
  24 import java.util.Arrays;
  25 import java.util.Collection;
  26 import java.util.LinkedHashSet;
  27 import java.util.List;
  28 import java.util.Map;
  29 import java.util.Set;
  30 import java.util.logging.Logger;
  31 import java.util.regex.Pattern;
  32
  33 import com.hughes.android.dictionary.engine.EntryTypeName;
  34 import com.hughes.android.dictionary.engine.IndexBuilder;
  35 import com.hughes.android.dictionary.engine.IndexedEntry;
  36 import com.hughes.android.dictionary.engine.PairEntry;
  37 import com.hughes.android.dictionary.engine.PairEntry.Pair;
  38
  39 public class EnWiktionaryXmlParser {
  40
  41   private static final String TRANSLITERATION_FORMAT = " (tr. %s)";
  42
  43   static final Logger LOG = Logger.getLogger(EnWiktionaryXmlParser.class.getName());
  44
  45   // TODO: process {{ttbc}} lines
  46
  47   static final Pattern partOfSpeechHeader = Pattern.compile(
  48       "Noun|Verb|Adjective|Adverb|Pronoun|Conjunction|Interjection|" +
  49       "Preposition|Proper noun|Article|Prepositional phrase|Acronym|" +
  50       "Abbreviation|Initialism|Contraction|Prefix|Suffix|Symbol|Letter|" +
  51       "Ligature|Idiom|Phrase|\\{\\{acronym\\}\\}|\\{\\{initialism\\}\\}|" +
  52       // These are @deprecated:
  53       "Noun form|Verb form|Adjective form|Nominal phrase|Noun phrase|" +
  54       "Verb phrase|Transitive verb|Intransitive verb|Reflexive verb|" +
  55       // These are extras I found:
  56       "Determiner|Numeral|Number|Cardinal number|Ordinal number|Proverb|" +
  57       "Particle|Interjection|Pronominal adverb" +
  58       "Han character|Hanzi|Hanja|Kanji|Katakana character|Syllable");
  59
  60   final IndexBuilder enIndexBuilder;
  61   final IndexBuilder foreignIndexBuilder;
  62   final Pattern langPattern;
  63   final Pattern langCodePattern;
  64   final boolean swap;
  65
  66   public EnWiktionaryXmlParser(final IndexBuilder enIndexBuilder, final IndexBuilder otherIndexBuilder, final Pattern langPattern, final Pattern langCodePattern, final boolean swap) {
  67     this.enIndexBuilder = enIndexBuilder;
  68     this.foreignIndexBuilder = otherIndexBuilder;
  69     this.langPattern = langPattern;
  70     this.langCodePattern = langCodePattern;
  71     this.swap = swap;
  72   }
  73
  74
  75   public void parse(final File file, final int pageLimit) throws IOException {
  76     int pageCount = 0;
  77     final DataInputStream dis = new DataInputStream(new BufferedInputStream(new FileInputStream(file)));
  78     while (true) {
  79       if (pageLimit >= 0 && pageCount >= pageLimit) {
  80         return;
  81       }
  82
  83       final String title;
  84       try {
  85         title = dis.readUTF();
  86       } catch (EOFException e) {
  87         dis.close();
  88         return;
  89       }
  90       final String heading = dis.readUTF();
  91       final int bytesLength = dis.readInt();
  92       final byte[] bytes = new byte[bytesLength];
  93       dis.readFully(bytes);
  94       final String text = new String(bytes, "UTF8");
  95
  96       parseSection(title, heading, text);
  97
  98       ++pageCount;
  99       if (pageCount % 1000 == 0) {
 100         LOG.info("pageCount=" + pageCount);
 101       }
 102     }
 103   }
 104
 105   private void parseSection(final String title, String heading, final String text) {
 106     if (title.startsWith("Wiktionary:") ||
 107         title.startsWith("Template:") ||
 108         title.startsWith("Appendix:") ||
 109         title.startsWith("Category:") ||
 110         title.startsWith("Index:") ||
 111         title.startsWith("MediaWiki:") ||
 112         title.startsWith("TransWiki:") ||
 113         title.startsWith("Citations:") ||
 114         title.startsWith("Concordance:") ||
 115         title.startsWith("Help:")) {
 116       return;
 117     }
 118
 119     heading = heading.replaceAll("=", "").trim();
 120     if (heading.equals("English")) {
 121       doEnglishWord(title, text);
 122     } else if (langPattern.matcher(heading).find()){
 123       doForeignWord(heading, title, text);
 124     }
 125
 126   }  // endPage()
 127
 128   // -------------------------------------------------------------------------
 129
 130   private void doEnglishWord(String title, String text) {
 131
 132     String pos = null;
 133     int posDepth = -1;
 134
 135     final WikiTokenizer wikiTokenizer = new WikiTokenizer(text);
 136     while (wikiTokenizer.nextToken() != null) {
 137
 138       if (wikiTokenizer.isHeading()) {
 139         final String headerName = wikiTokenizer.headingWikiText();
 140
 141         if (wikiTokenizer.headingDepth() <= posDepth) {
 142           pos = null;
 143           posDepth = -1;
 144         }
 145
 146         if (partOfSpeechHeader.matcher(headerName).matches()) {
 147           posDepth = wikiTokenizer.headingDepth();
 148           pos = wikiTokenizer.headingWikiText();
 149           // TODO: if we're inside the POS section, we should handle the first title line...
 150
 151         } else if (headerName.equals("Translations")) {
 152           if (pos == null) {
 153             LOG.warning("Translations without POS: " + title);
 154           }
 155           doTranslations(title, wikiTokenizer, pos);
 156         } else if (headerName.equals("Pronunciation")) {
 157           //doPronunciation(wikiLineReader);
 158         }
 159       }
 160     }
 161   }
 162
 163
 164   private static Set<String> encodings = new LinkedHashSet<String>(Arrays.asList("zh-ts",
 165       "sd-Arab", "ku-Arab", "Arab", "unicode", "Laoo", "ur-Arab", "Thai",
 166       "fa-Arab", "Khmr", "zh-tsp", "Cyrl", "IPAchar", "ug-Arab", "ko-inline",
 167       "Jpan", "Kore", "Hebr", "rfscript", "Beng", "Mong", "Knda", "Cyrs",
 168       "yue-tsj", "Mlym", "Tfng", "Grek", "yue-yue-j"));
 169
 170   private void doTranslations(final String title, final WikiTokenizer wikiTokenizer, final String pos) {
 171     if (title.equals("absolutely")) {
 172       //System.out.println();
 173     }
 174
 175     String topLevelLang = null;
 176     String sense = null;
 177     boolean done = false;
 178     while (wikiTokenizer.nextToken() != null) {
 179       if (wikiTokenizer.isHeading()) {
 180         wikiTokenizer.returnToLineStart();
 181         return;
 182       }
 183       if (done) {
 184         continue;
 185       }
 186
 187       // Check whether we care about this line:
 188
 189       if (wikiTokenizer.isFunction()) {
 190         final String functionName = wikiTokenizer.functionName();
 191         final List<String> positionArgs = wikiTokenizer.functionPositionArgs();
 192
 193         if (functionName.equals("trans-top")) {
 194           sense = null;
 195           if (wikiTokenizer.functionPositionArgs().size() >= 1) {
 196             sense = positionArgs.get(0);
 197             // TODO: could emphasize words in [[brackets]] inside sense.
 198             sense = WikiTokenizer.toPlainText(sense);
 199             //LOG.info("Sense: " + sense);
 200           }
 201         } else if (functionName.equals("trans-bottom")) {
 202           sense = null;
 203         } else if (functionName.equals("trans-mid")) {
 204         } else if (functionName.equals("trans-see")) {
 205           // TODO: would also be nice...
 206         } else if (functionName.startsWith("picdic")) {
 207         } else if (functionName.startsWith("checktrans")) {
 208           done = true;
 209         } else if (functionName.startsWith("ttbc")) {
 210           wikiTokenizer.nextLine();
 211           // TODO: would be great to handle ttbc
 212           // TODO: Check this: done = true;
 213         } else {
 214           LOG.warning("Unexpected translation wikifunction: " + wikiTokenizer.token() + ", title=" + title);
 215         }
 216       } else if (wikiTokenizer.isListItem()) {
 217         final String line = wikiTokenizer.listItemWikiText();
 218         // This line could produce an output...
 219
 220         if (line.contains("ich hoan dich gear")) {
 221           //System.out.println();
 222         }
 223
 224         // First strip the language and check whether it matches.
 225         // And hold onto it for sub-lines.
 226         final int colonIndex = line.indexOf(":");
 227         if (colonIndex == -1) {
 228           continue;
 229         }
 230
 231         final String lang = trim(WikiTokenizer.toPlainText(line.substring(0, colonIndex)));
 232         final boolean appendLang;
 233         if (wikiTokenizer.listItemPrefix().length() == 1) {
 234           topLevelLang = lang;
 235           final boolean thisFind = langPattern.matcher(lang).find();
 236           if (!thisFind) {
 237             continue;
 238           }
 239           appendLang = !langPattern.matcher(lang).matches();
 240         } else if (topLevelLang == null) {
 241           continue;
 242         } else {
 243           // Two-level -- the only way we won't append is if this second level matches exactly.
 244           if (!langPattern.matcher(lang).matches() && !langPattern.matcher(topLevelLang).find()) {
 245             continue;
 246           }
 247           appendLang = !langPattern.matcher(lang).matches();
 248         }
 249
 250         String rest = line.substring(colonIndex + 1).trim();
 251         if (rest.length() > 0) {
 252           doTranslationLine(line, appendLang ? lang : null, title, pos, sense, rest);
 253         }
 254
 255       } else if (wikiTokenizer.remainderStartsWith("''See''")) {
 256         wikiTokenizer.nextLine();
 257         LOG.fine("Skipping line: " + wikiTokenizer.token());
 258       } else if (wikiTokenizer.isWikiLink()) {
 259         final String wikiLink = wikiTokenizer.wikiLinkText();
 260         if (wikiLink.contains(":") && wikiLink.contains(title)) {
 261         } else if (wikiLink.contains("Category:")) {
 262         } else  {
 263           LOG.warning("Unexpected wikiLink: " + wikiTokenizer.token() + ", title=" + title);
 264         }
 265       } else if (wikiTokenizer.isNewline() || wikiTokenizer.isMarkup() || wikiTokenizer.isComment()) {
 266       } else {
 267         final String token = wikiTokenizer.token();
 268         if (token.equals("----")) {
 269         } else {
 270           LOG.warning("Unexpected translation token: " + wikiTokenizer.token() + ", title=" + title);
 271         }
 272       }
 273
 274     }
 275   }
 276
 277   private static <T> T get(final List<T> list, final int index, final T defaultValue) {
 278     return index < list.size() ? list.get(index) : defaultValue;
 279   }
 280
 281   private static <T> T get(final List<T> list, final int index) {
 282     return get(list, index, null);
 283   }
 284
 285   private static <T> T remove(final List<T> list, final int index, final T defaultValue) {
 286     return index < list.size() ? list.remove(index) : defaultValue;
 287   }
 288
 289
 290   static final class Callback implements WikiTokenizer.Callback {
 291     public Callback(IndexedEntry indexedEntry, IndexBuilder defaultIndexBuilder,
 292         StringBuilder builder, Map<String, WikiFunctionCallback> functionCallbacks) {
 293       this.indexedEntry = indexedEntry;
 294       this.defaultIndexBuilder = defaultIndexBuilder;
 295       this.builder = builder;
 296       this.functionCallbacks = functionCallbacks;
 297     }
 298
 299     final IndexedEntry indexedEntry;
 300     final IndexBuilder defaultIndexBuilder;
 301     final StringBuilder builder;
 302     final Map<String,WikiFunctionCallback> functionCallbacks;
 303
 304     // TODO: the classes of text are wrong....
 305
 306     @Override
 307     public void onPlainText(WikiTokenizer wikiTokenizer) {
 308       final String plainText = wikiTokenizer.token();
 309       builder.append(plainText);
 310       defaultIndexBuilder.addEntryWithString(indexedEntry, plainText, EntryTypeName.WIKTIONARY_TRANSLATION_OTHER_TEXT);
 311     }
 312
 313     @Override
 314     public void onWikiLink(WikiTokenizer wikiTokenizer) {
 315       final String plainText = wikiTokenizer.wikiLinkText();
 316       builder.append(plainText);
 317       // TODO: should check for English before appending.
 318       defaultIndexBuilder.addEntryWithString(indexedEntry, plainText, EntryTypeName.WIKTIONARY_TRANSLATION_WIKI_TEXT);
 319     }
 320
 321     @Override
 322     public void onFunction(String functionName,
 323         List<String> functionPositionArgs, Map<String, String> functionNamedArgs) {
 324     }
 325
 326     @Override
 327     public void onMarkup(WikiTokenizer wikiTokenizer) {
 328       // Do nothing.
 329     }
 330
 331     @Override
 332     public void onComment(WikiTokenizer wikiTokenizer) {
 333       // Do nothing.
 334     }
 335
 336     @Override
 337     public void onNewline(WikiTokenizer wikiTokenizer) {
 338       assert false;
 339     }
 340
 341     @Override
 342     public void onHeading(WikiTokenizer wikiTokenizer) {
 343       assert false;
 344     }
 345
 346     @Override
 347     public void onListItem(WikiTokenizer wikiTokenizer) {
 348       assert false;
 349     }
 350   }
 351
 352   private void doTranslationLine(final String line, final String lang, final String title, final String pos, final String sense, final String rest) {
 353     // Good chance we'll actually file this one...
 354     final PairEntry pairEntry = new PairEntry();
 355     final IndexedEntry indexedEntry = new IndexedEntry(pairEntry);
 356
 357     final StringBuilder foreignText = new StringBuilder();
 358     final WikiTokenizer wikiTokenizer = new WikiTokenizer(rest, false);
 359     while (wikiTokenizer.nextToken() != null) {
 360
 361       if (wikiTokenizer.isPlainText()) {
 362         final String plainText = wikiTokenizer.token();
 363         foreignText.append(plainText);
 364         foreignIndexBuilder.addEntryWithString(indexedEntry, plainText, EntryTypeName.WIKTIONARY_TRANSLATION_OTHER_TEXT);
 365
 366       } else if (wikiTokenizer.isWikiLink()) {
 367         final String plainText = wikiTokenizer.wikiLinkText();
 368         foreignText.append(plainText);
 369         // TODO: should check for English before appending.
 370         foreignIndexBuilder.addEntryWithString(indexedEntry, plainText, EntryTypeName.WIKTIONARY_TRANSLATION_WIKI_TEXT);
 371
 372       } else if (wikiTokenizer.isFunction()) {
 373         final String functionName = wikiTokenizer.functionName();
 374         final List<String> args = wikiTokenizer.functionPositionArgs();
 375         final Map<String,String> namedArgs = wikiTokenizer.functionNamedArgs();
 376
 377         if (functionName.equals("t") || functionName.equals("t+") || functionName.equals("t-") || functionName.equals("tø") || functionName.equals("apdx-t")) {
 378           if (args.size() < 2) {
 379             LOG.warning("{{t}} with too few args: " + line + ", title=" + title);
 380             continue;
 381           }
 382           final String langCode = get(args, 0);
 383           final String word = get(args, 1);
 384           final String gender = get(args, 2);
 385           final String transliteration = namedArgs.get("tr");
 386           if (foreignText.length() > 0) {
 387             foreignText.append("");
 388           }
 389           foreignText.append(word);
 390           foreignIndexBuilder.addEntryWithString(indexedEntry, word, EntryTypeName.WIKTIONARY_TITLE_SINGLE, EntryTypeName.WIKTIONARY_TITLE_MULTI);
 391           if (gender != null) {
 392             foreignText.append(String.format(" {%s}", gender));
 393           }
 394           if (transliteration != null) {
 395             foreignText.append(String.format(TRANSLITERATION_FORMAT, transliteration));
 396             foreignIndexBuilder.addEntryWithString(indexedEntry, transliteration, EntryTypeName.WIKTIONARY_TRANSLITERATION);
 397           }
 398         } else if (functionName.equals("qualifier")) {
 399           if (args.size() == 0) {
 400            foreignText.append(wikiTokenizer.token());
 401           } else {
 402             String qualifier = args.get(0);
 403             if (!namedArgs.isEmpty() || args.size() > 1) {
 404               LOG.warning("weird qualifier: " + line);
 405             }
 406             // Unindexed!
 407             foreignText.append("(").append(qualifier).append(")");
 408           }
 409         } else if (encodings.contains(functionName)) {
 410           foreignText.append("").append(args.get(0));
 411           foreignIndexBuilder.addEntryWithString(indexedEntry, args.get(0), EntryTypeName.WIKTIONARY_TRANSLATION_OTHER_TEXT);
 412         } else if (isGender(functionName)) {
 413           appendGender(foreignText, functionName, args);
 414         } else if (functionName.equals("g")) {
 415           foreignText.append("{g}");
 416         } else if (functionName.equals("l")) {
 417           // encodes text in various langs.
 418           // lang is arg 0.
 419           foreignText.append("").append(args.get(1));
 420           foreignIndexBuilder.addEntryWithString(indexedEntry, args.get(1), EntryTypeName.WIKTIONARY_TRANSLATION_OTHER_TEXT);
 421           // TODO: transliteration
 422         } else if (functionName.equals("term")) {
 423           // cross-reference to another dictionary
 424           foreignText.append("").append(args.get(0));
 425           foreignIndexBuilder.addEntryWithString(indexedEntry, args.get(0), EntryTypeName.WIKTIONARY_TRANSLATION_OTHER_TEXT);
 426           // TODO: transliteration
 427         } else if (functionName.equals("italbrac") || functionName.equals("gloss")) {
 428           // TODO: put this text aside to use it.
 429           foreignText.append("[").append(args.get(0)).append("]");
 430           foreignIndexBuilder.addEntryWithString(indexedEntry, args.get(0), EntryTypeName.WIKTIONARY_TRANSLATION_OTHER_TEXT);
 431         } else if (functionName.equals("ttbc")) {
 432           LOG.warning("Unexpected {{ttbc}}");
 433         } else if (functionName.equals("trreq")) {
 434         } else if (functionName.equals("not used")) {
 435           foreignText.append("(not used)");
 436         } else if (functionName.equals("t-image")) {
 437           // American sign language
 438         } else {
 439           // Unindexed!
 440           namedArgs.keySet().removeAll(USELESS_WIKI_ARGS);
 441           WikiTokenizer.appendFunction(foreignText.append("{{"), functionName, args, namedArgs).append("}}");
 442         }
 443
 444       } else if (wikiTokenizer.isNewline()) {
 445       } else if (wikiTokenizer.isComment()) {
 446       } else if (wikiTokenizer.isMarkup()) {
 447       } else {
 448         LOG.warning("Bad translation token: " + wikiTokenizer.token());
 449       }
 450     }
 451     if (foreignText.length() == 0) {
 452       LOG.warning("Empty foreignText: " + line);
 453       return;
 454     }
 455
 456     if (lang != null) {
 457       foreignText.insert(0, String.format("(%s) ", lang));
 458     }
 459
 460     StringBuilder englishText = new StringBuilder();
 461
 462     englishText.append(title);
 463     if (sense != null) {
 464       englishText.append(" (").append(sense).append(")");
 465       enIndexBuilder.addEntryWithString(indexedEntry, sense, EntryTypeName.WIKTIONARY_TRANSLATION_SENSE, EntryTypeName.WIKTIONARY_TRANSLATION_SENSE);
 466     }
 467     if (pos != null) {
 468       englishText.append(" (").append(pos.toLowerCase()).append(")");
 469     }
 470     enIndexBuilder.addEntryWithString(indexedEntry, title, EntryTypeName.WIKTIONARY_TITLE_SINGLE, EntryTypeName.WIKTIONARY_TITLE_MULTI);
 471
 472     final Pair pair = new Pair(trim(englishText.toString()), trim(foreignText.toString()), swap);
 473     pairEntry.pairs.add(pair);
 474     if (!pairsAdded.add(pair.toString())) {
 475       LOG.warning("Duplicate pair: " + pair.toString());
 476     }
 477     if (pair.toString().equals("libero {m} :: free (adjective)")) {
 478       System.out.println();
 479     }
 480
 481   }
 482
 483
 484   private void appendGender(final StringBuilder otherText,
 485       final String functionName, final List<String> args) {
 486     otherText.append("{");
 487     otherText.append(functionName);
 488     for (int i = 0; i < args.size(); ++i) {
 489       otherText.append("|").append(args.get(i));
 490     }
 491     otherText.append("}");
 492   }
 493
 494
 495   private boolean isGender(final String functionName) {
 496     return functionName.equals("m") || functionName.equals("f") || functionName.equals("n") || functionName.equals("p");
 497   }
 498
 499   Set<String> pairsAdded = new LinkedHashSet<String>();
 500
 501   // -------------------------------------------------------------------------
 502
 503   private void doForeignWord(final String lang, final String title, final String text) {
 504     final WikiTokenizer wikiTokenizer = new WikiTokenizer(text);
 505     while (wikiTokenizer.nextToken() != null) {
 506       if (wikiTokenizer.isHeading()) {
 507         final String headingName = wikiTokenizer.headingWikiText();
 508         if (headingName.equals("Translations")) {
 509           LOG.warning("Translations not in English section: " + title);
 510         } else if (headingName.equals("Pronunciation")) {
 511           //doPronunciation(wikiLineReader);
 512         } else if (partOfSpeechHeader.matcher(headingName).matches()) {
 513           doForeignPartOfSpeech(lang, title, headingName, wikiTokenizer.headingDepth(), wikiTokenizer);
 514         }
 515       } else {
 516       }
 517     }
 518   }
 519
 520   static final class ListSection {
 521     final String firstPrefix;
 522     final String firstLine;
 523     final List<String> nextPrefixes = new ArrayList<String>();
 524     final List<String> nextLines = new ArrayList<String>();
 525
 526     public ListSection(String firstPrefix, String firstLine) {
 527       this.firstPrefix = firstPrefix;
 528       this.firstLine = firstLine;
 529     }
 530
 531     @Override
 532     public String toString() {
 533       return firstPrefix + firstLine + "{ " + nextPrefixes + "}";
 534     }
 535   }
 536
 537
 538   int foreignCount = 0;
 539   private void doForeignPartOfSpeech(final String lang, String title, final String posHeading, final int posDepth, WikiTokenizer wikiTokenizer) {
 540     if (++foreignCount % 1000 == 0) {
 541       LOG.info("***" + lang + ", " + title + ", pos=" + posHeading + ", foreignCount=" + foreignCount);
 542     }
 543     if (title.equals("moro")) {
 544       System.out.println();
 545     }
 546
 547     boolean titleAppended = false;
 548     final StringBuilder foreignBuilder = new StringBuilder();
 549     final Collection<String> wordForms = new ArrayList<String>();
 550     final List<ListSection> listSections = new ArrayList<ListSection>();
 551
 552     try {
 553
 554     ListSection lastListSection = null;
 555
 556     int currentHeadingDepth = posDepth;
 557     while (wikiTokenizer.nextToken() != null) {
 558       if (wikiTokenizer.isHeading()) {
 559         currentHeadingDepth = wikiTokenizer.headingDepth();
 560
 561         if (currentHeadingDepth <= posDepth) {
 562           wikiTokenizer.returnToLineStart();
 563           return;
 564         }
 565       }
 566
 567       if (currentHeadingDepth > posDepth) {
 568         // TODO: deal with other neat info sections
 569         continue;
 570       }
 571
 572       if (wikiTokenizer.isFunction()) {
 573         final String name = wikiTokenizer.functionName();
 574         final List<String> args = wikiTokenizer.functionPositionArgs();
 575         final Map<String,String> namedArgs = wikiTokenizer.functionNamedArgs();
 576         // First line is generally a repeat of the title with some extra information.
 577         // We need to build up the left side (foreign text, tokens) separately from the
 578         // right side (English).  The left-side may get paired with multiple right sides.
 579         // The left side should get filed under every form of the word in question (singular, plural).
 580
 581         // For verbs, the conjugation comes later on in a deeper section.
 582         // Ideally, we'd want to file every English entry with the verb
 583         // under every verb form coming from the conjugation.
 584         // Ie. under "fa": see: "make :: fare" and "do :: fare"
 585         // But then where should we put the conjugation table?
 586         // I think just under fare.  But then we need a way to link to the entry (actually the row, since entries doesn't show up!)
 587         // for the conjugation table from "fa".
 588         // Would like to be able to link to a lang#token.
 589         if (isGender(name)) {
 590           appendGender(foreignBuilder, name, args);
 591         } else if (name.equals("wikipedia")) {
 592           namedArgs.remove("lang");
 593           if (args.size() > 1 || !namedArgs.isEmpty()) {
 594             // Unindexed!
 595             foreignBuilder.append(wikiTokenizer.token());
 596           } else if (args.size() == 1) {
 597             foreignBuilder.append(wikiTokenizer.token());
 598           } else {
 599             //foreignBuilder.append(title);
 600           }
 601         } else if (name.equals("attention") || name.equals("zh-attention")) {
 602           // See: http://en.wiktionary.org/wiki/Template:attention
 603           // Ignore these.
 604         // TODO: head } else if (name.equals("head")) {
 605         } else if (name.equals("infl")) {
 606           // See: http://en.wiktionary.org/wiki/Template:infl
 607           final String langCode = get(args, 0);
 608           String head = namedArgs.remove("head");
 609           if (head == null) {
 610             head = namedArgs.remove("title"); // Bug
 611           }
 612           if (head == null) {
 613             head = title;
 614           } else {
 615             head = WikiTokenizer.toPlainText(head);
 616           }
 617           titleAppended = true;
 618
 619           namedArgs.keySet().removeAll(USELESS_WIKI_ARGS);
 620
 621           final String tr = namedArgs.remove("tr");
 622           String g = namedArgs.remove("g");
 623           if (g == null) {
 624             g = namedArgs.remove("gender");
 625           }
 626           final String g2 = namedArgs.remove("g2");
 627           final String g3 = namedArgs.remove("g3");
 628
 629           foreignBuilder.append(head);
 630
 631           if (g != null) {
 632             foreignBuilder.append(" {").append(g);
 633             if (g2 != null) {
 634               foreignBuilder.append("|").append(g2);
 635             }
 636             if (g3 != null) {
 637               foreignBuilder.append("|").append(g3);
 638             }
 639             foreignBuilder.append("}");
 640           }
 641
 642           if (tr != null) {
 643             foreignBuilder.append(String.format(TRANSLITERATION_FORMAT, tr));
 644             wordForms.add(tr);
 645           }
 646
 647           final String pos = get(args, 1);
 648           if (pos != null) {
 649             foreignBuilder.append(" (").append(pos).append(")");
 650           }
 651           for (int i = 2; i < args.size(); i += 2) {
 652             final String inflName = get(args, i);
 653             final String inflValue = get(args, i + 1);
 654             foreignBuilder.append(", ").append(WikiTokenizer.toPlainText(inflName));
 655             if (inflValue != null && inflValue.length() > 0) {
 656               foreignBuilder.append(": ").append(WikiTokenizer.toPlainText(inflValue));
 657               wordForms.add(inflValue);
 658             }
 659           }
 660           for (final String key : namedArgs.keySet()) {
 661             final String value = WikiTokenizer.toPlainText(namedArgs.get(key));
 662             foreignBuilder.append(" ").append(key).append("=").append(value);
 663             wordForms.add(value);
 664           }
 665         } else if (name.equals("it-noun")) {
 666           titleAppended = true;
 667           final String base = get(args, 0);
 668           final String gender = get(args, 1);
 669           final String singular = base + get(args, 2);
 670           final String plural = base + get(args, 3);
 671           foreignBuilder.append(String.format(" %s {%s}, %s {pl}", singular, gender, plural, plural));
 672           wordForms.add(singular);
 673           wordForms.add(plural);
 674           if (!namedArgs.isEmpty() || args.size() > 4) {
 675             LOG.warning("Invalid it-noun: " + wikiTokenizer.token());
 676           }
 677         } else if (name.equals("it-proper noun")) {
 678           foreignBuilder.append(wikiTokenizer.token());
 679         } else if (name.equals("it-adj")) {
 680           foreignBuilder.append(wikiTokenizer.token());
 681         } else if (name.startsWith("it-conj")) {
 682           if (name.equals("it-conj-are")) {
 683             itConjAre(args, namedArgs);
 684           } else if (name.equals("it-conj-ere")) {
 685           } else if (name.equals("it-conj-ire")) {
 686           } else {
 687             LOG.warning("Unknown conjugation: " + wikiTokenizer.token());
 688           }
 689         } else {
 690           // Unindexed!
 691           foreignBuilder.append(wikiTokenizer.token());
 692           // LOG.warning("Unknown function: " + wikiTokenizer.token());
 693         }
 694       } else if (wikiTokenizer.isListItem()) {
 695         final String prefix = wikiTokenizer.listItemPrefix();
 696         if (lastListSection != null &&
 697             prefix.startsWith(lastListSection.firstPrefix) &&
 698             prefix.length() > lastListSection.firstPrefix.length()) {
 699           lastListSection.nextPrefixes.add(prefix);
 700           lastListSection.nextLines.add(wikiTokenizer.listItemWikiText());
 701         } else {
 702           lastListSection = new ListSection(prefix, wikiTokenizer.listItemWikiText());
 703           listSections.add(lastListSection);
 704         }
 705       } else if (lastListSection != null) {
 706         // Don't append anything after the lists, because there's crap.
 707       } else if (wikiTokenizer.isWikiLink()) {
 708         // Unindexed!
 709         foreignBuilder.append(wikiTokenizer.wikiLinkText());
 710
 711       } else if (wikiTokenizer.isPlainText()) {
 712         // Unindexed!
 713         foreignBuilder.append(wikiTokenizer.token());
 714
 715       } else if (wikiTokenizer.isMarkup() || wikiTokenizer.isNewline() || wikiTokenizer.isComment()) {
 716         // Do nothing.
 717       } else {
 718         LOG.warning("Unexpected token: " + wikiTokenizer.token());
 719       }
 720     }
 721
 722     } finally {
 723       // Here's where we exit.
 724       // Should we make an entry even if there are no foreign list items?
 725       String foreign = foreignBuilder.toString().trim();
 726       if (!titleAppended && !foreign.toLowerCase().startsWith(title.toLowerCase())) {
 727         foreign = String.format("%s %s", title, foreign);
 728       }
 729       if (!langPattern.matcher(lang).matches()) {
 730         foreign = String.format("(%s) %s", lang, foreign);
 731       }
 732       for (final ListSection listSection : listSections) {
 733         doForeignListItem(foreign, title, wordForms, listSection);
 734       }
 735     }
 736   }
 737
 738
 739   static final Pattern UNINDEXED_WIKI_TEXT = Pattern.compile(
 740       "(first|second|third)-person (singular|plural)|" +
 741       "present tense|" +
 742       "imperative"
 743       );
 744
 745   // Might only want to remove "lang" if it's equal to "zh", for example.
 746   static final Set<String> USELESS_WIKI_ARGS = new LinkedHashSet<String>(Arrays.asList("lang", "sc", "sort", "cat"));
 747
 748   private void doForeignListItem(final String foreignText, String title, final Collection<String> forms, final ListSection listSection) {
 749
 750     final String prefix = listSection.firstPrefix;
 751     if (prefix.length() > 1) {
 752       // Could just get looser and say that any prefix longer than first is a sublist.
 753       LOG.warning("Prefix too long: " + listSection);
 754       return;
 755     }
 756
 757     final PairEntry pairEntry = new PairEntry();
 758     final IndexedEntry indexedEntry = new IndexedEntry(pairEntry);
 759
 760     final StringBuilder englishBuilder = new StringBuilder();
 761
 762     final String mainLine = listSection.firstLine;
 763     final WikiTokenizer englishTokenizer = new WikiTokenizer(mainLine, false);
 764     while (englishTokenizer.nextToken() != null) {
 765       // TODO handle form of....
 766       if (englishTokenizer.isPlainText()) {
 767         englishBuilder.append(englishTokenizer.token());
 768         enIndexBuilder.addEntryWithString(indexedEntry, englishTokenizer.token(), EntryTypeName.WIKTIONARY_ENGLISH_DEF);
 769       } else if (englishTokenizer.isWikiLink()) {
 770         final String text = englishTokenizer.wikiLinkText();
 771         final String link = englishTokenizer.wikiLinkDest();
 772         if (link != null) {
 773           if (link.contains("#English")) {
 774             englishBuilder.append(text);
 775             enIndexBuilder.addEntryWithString(indexedEntry, text, EntryTypeName.WIKTIONARY_ENGLISH_DEF_WIKI_LINK);
 776           } else if (link.contains("#") && this.langPattern.matcher(link).find()) {
 777             englishBuilder.append(text);
 778             foreignIndexBuilder.addEntryWithString(indexedEntry, text, EntryTypeName.WIKTIONARY_ENGLISH_DEF_OTHER_LANG);
 779           } else if (link.equals("plural")) {
 780             englishBuilder.append(text);
 781           } else {
 782             //LOG.warning("Special link: " + englishTokenizer.token());
 783             enIndexBuilder.addEntryWithString(indexedEntry, text, EntryTypeName.WIKTIONARY_ENGLISH_DEF_WIKI_LINK);
 784             englishBuilder.append(text);
 785           }
 786         } else {
 787           // link == null
 788           englishBuilder.append(text);
 789           if (!UNINDEXED_WIKI_TEXT.matcher(text).find()) {
 790             enIndexBuilder.addEntryWithString(indexedEntry, text, EntryTypeName.WIKTIONARY_ENGLISH_DEF_WIKI_LINK);
 791           }
 792         }
 793       } else if (englishTokenizer.isFunction()) {
 794         final String name = englishTokenizer.functionName();
 795         final List<String> args = englishTokenizer.functionPositionArgs();
 796         final Map<String,String> namedArgs = englishTokenizer.functionNamedArgs();
 797
 798         if (
 799             name.equals("form of") ||
 800             name.contains("conjugation of") ||
 801             name.contains("participle of") ||
 802             name.contains("gerund of") ||
 803             name.contains("feminine of") ||
 804             name.contains("plural of")) {
 805           String formName = name;
 806           if (name.equals("form of")) {
 807             formName = remove(args, 0, null);
 808           }
 809           if (formName == null) {
 810             LOG.warning("Missing form name: " + title);
 811             formName = "form of";
 812           }
 813           String baseForm = get(args, 1, "");
 814           if ("".equals(baseForm)) {
 815             baseForm = get(args, 0, null);
 816             remove(args, 1, "");
 817           } else {
 818             remove(args, 0, null);
 819           }
 820           namedArgs.keySet().removeAll(USELESS_WIKI_ARGS);
 821           WikiTokenizer.appendFunction(englishBuilder.append("{"), formName, args, namedArgs).append("}");
 822           if (baseForm != null) {
 823             foreignIndexBuilder.addEntryWithString(indexedEntry, baseForm, EntryTypeName.WIKTIONARY_BASE_FORM_SINGLE, EntryTypeName.WIKTIONARY_BASE_FORM_MULTI);
 824           } else {
 825             // null baseForm happens in Danish.
 826             LOG.warning("Null baseform: " + title);
 827           }
 828 //        } else if (name.equals("defn")) {
 829           // TODO: test me!
 830           // Do nothing.
 831           // http://en.wiktionary.org/wiki/Wiktionary:Requests_for_deletion/Others#Template:defn
 832           // Redundant, used for the same purpose as {{rfdef}}, but this
 833           // doesn't produce the "This word needs a definition" text.
 834           // Delete or redirect.
 835         } else {
 836           namedArgs.keySet().removeAll(USELESS_WIKI_ARGS);
 837           if (args.size() == 0 && namedArgs.isEmpty()) {
 838             englishBuilder.append("{").append(name).append("}");
 839           } else {
 840             WikiTokenizer.appendFunction(englishBuilder.append("{{"), name, args, namedArgs).append("}}");
 841           }
 842 //          LOG.warning("Unexpected function: " + englishTokenizer.token());
 843         }
 844       } else {
 845         if (englishTokenizer.isComment() || englishTokenizer.isMarkup()) {
 846         } else {
 847           LOG.warning("Unexpected definition type: " + englishTokenizer.token());
 848         }
 849       }
 850     }
 851
 852     final String english = trim(englishBuilder.toString());
 853     if (english.length() > 0) {
 854       final Pair pair = new Pair(english, trim(foreignText), this.swap);
 855       pairEntry.pairs.add(pair);
 856       foreignIndexBuilder.addEntryWithString(indexedEntry, title, EntryTypeName.WIKTIONARY_TITLE_SINGLE, EntryTypeName.WIKTIONARY_TITLE_MULTI);
 857       for (final String form : forms) {
 858         foreignIndexBuilder.addEntryWithString(indexedEntry, form, EntryTypeName.WIKTIONARY_INFLECTD_FORM_SINGLE, EntryTypeName.WIKTIONARY_INFLECTED_FORM_MULTI);
 859       }
 860     }
 861
 862     // Do examples.
 863     String lastForeign = null;
 864     for (int i = 0; i < listSection.nextPrefixes.size(); ++i) {
 865       final String nextPrefix = listSection.nextPrefixes.get(i);
 866       final String nextLine = listSection.nextLines.get(i);
 867       int dash = nextLine.indexOf("&mdash;");
 868       int mdashLen = 7;
 869       if (dash == -1) {
 870         dash = nextLine.indexOf("—");
 871         mdashLen = 1;
 872       }
 873       if (dash == -1) {
 874         dash = nextLine.indexOf(" - ");
 875         mdashLen = 3;
 876       }
 877
 878       if ((nextPrefix.equals("#:") || nextPrefix.equals("##:")) && dash != -1) {
 879         final String foreignEx = nextLine.substring(0, dash);
 880         final String englishEx = nextLine.substring(dash + mdashLen);
 881         final Pair pair = new Pair(formatAndIndexExampleString(englishEx, enIndexBuilder, indexedEntry), formatAndIndexExampleString(foreignEx, foreignIndexBuilder, indexedEntry), swap);
 882         if (pair.lang1 != "--" && pair.lang1 != "--") {
 883           pairEntry.pairs.add(pair);
 884         }
 885         lastForeign = null;
 886       } else if (nextPrefix.equals("#:") || nextPrefix.equals("##:")){
 887         final Pair pair = new Pair("--", formatAndIndexExampleString(nextLine, null, indexedEntry), swap);
 888         lastForeign = nextLine;
 889         if (pair.lang1 != "--" && pair.lang1 != "--") {
 890           pairEntry.pairs.add(pair);
 891         }
 892       } else if (nextPrefix.equals("#::") || nextPrefix.equals("#**")) {
 893         if (lastForeign != null && pairEntry.pairs.size() > 0) {
 894           pairEntry.pairs.remove(pairEntry.pairs.size() - 1);
 895           final Pair pair = new Pair(formatAndIndexExampleString(nextLine, enIndexBuilder, indexedEntry), formatAndIndexExampleString(lastForeign, foreignIndexBuilder, indexedEntry), swap);
 896           if (pair.lang1 != "--" || pair.lang2 != "--") {
 897             pairEntry.pairs.add(pair);
 898           }
 899           lastForeign = null;
 900         } else {
 901           LOG.warning("TODO: English example with no foreign: " + title + ", " + nextLine);
 902           final Pair pair = new Pair("--", formatAndIndexExampleString(nextLine, null, indexedEntry), swap);
 903           if (pair.lang1 != "--" || pair.lang2 != "--") {
 904             pairEntry.pairs.add(pair);
 905           }
 906         }
 907       } else if (nextPrefix.equals("#*")) {
 908         // Can't really index these.
 909         final Pair pair = new Pair("--", formatAndIndexExampleString(nextLine, null, indexedEntry), swap);
 910         lastForeign = nextLine;
 911         if (pair.lang1 != "--" || pair.lang2 != "--") {
 912           pairEntry.pairs.add(pair);
 913         }
 914       } else if (nextPrefix.equals("#::*") || nextPrefix.equals("##") || nextPrefix.equals("#*:") || nextPrefix.equals("#:*") || true) {
 915         final Pair pair = new Pair("--", formatAndIndexExampleString(nextLine, null, indexedEntry), swap);
 916         if (pair.lang1 != "--" || pair.lang2 != "--") {
 917           pairEntry.pairs.add(pair);
 918         }
 919 //      } else {
 920 //        assert false;
 921       }
 922     }
 923   }
 924
 925   private String formatAndIndexExampleString(final String example, final IndexBuilder indexBuilder, final IndexedEntry indexedEntry) {
 926     final WikiTokenizer wikiTokenizer = new WikiTokenizer(example, false);
 927     final StringBuilder builder = new StringBuilder();
 928     boolean insideTripleQuotes = false;
 929     while (wikiTokenizer.nextToken() != null) {
 930       if (wikiTokenizer.isPlainText()) {
 931         builder.append(wikiTokenizer.token());
 932         if (indexBuilder != null) {
 933           indexBuilder.addEntryWithString(indexedEntry, wikiTokenizer.token(), EntryTypeName.WIKTIONARY_EXAMPLE);
 934         }
 935       } else if (wikiTokenizer.isWikiLink()) {
 936         final String text = wikiTokenizer.wikiLinkText().replaceAll("'", "");
 937         builder.append(text);
 938         if (indexBuilder != null) {
 939           indexBuilder.addEntryWithString(indexedEntry, text, EntryTypeName.WIKTIONARY_EXAMPLE);
 940         }
 941       } else if (wikiTokenizer.isFunction()) {
 942         builder.append(wikiTokenizer.token());
 943       } else if (wikiTokenizer.isMarkup()) {
 944         if (wikiTokenizer.token().equals("'''")) {
 945           insideTripleQuotes = !insideTripleQuotes;
 946         }
 947       } else if (wikiTokenizer.isComment() || wikiTokenizer.isNewline()) {
 948         // Do nothing.
 949       } else {
 950         LOG.warning("unexpected token: " + wikiTokenizer.token());
 951       }
 952     }
 953     final String result = trim(builder.toString());
 954     return result.length() > 0 ? result : "--";
 955   }
 956
 957
 958   private void itConjAre(List<String> args, Map<String, String> namedArgs) {
 959     final String base = args.get(0);
 960     final String aux = args.get(1);
 961
 962     putIfMissing(namedArgs, "inf", base + "are");
 963     putIfMissing(namedArgs, "aux", aux);
 964     putIfMissing(namedArgs, "ger", base + "ando");
 965     putIfMissing(namedArgs, "presp", base + "ante");
 966     putIfMissing(namedArgs, "pastp", base + "ato");
 967     // Present
 968     putIfMissing(namedArgs, "pres1s", base + "o");
 969     putIfMissing(namedArgs, "pres2s", base + "i");
 970     putIfMissing(namedArgs, "pres3s", base + "a");
 971     putIfMissing(namedArgs, "pres1p", base + "iamo");
 972     putIfMissing(namedArgs, "pres2p", base + "ate");
 973     putIfMissing(namedArgs, "pres3p", base + "ano");
 974     // Imperfect
 975     putIfMissing(namedArgs, "imperf1s", base + "avo");
 976     putIfMissing(namedArgs, "imperf2s", base + "avi");
 977     putIfMissing(namedArgs, "imperf3s", base + "ava");
 978     putIfMissing(namedArgs, "imperf1p", base + "avamo");
 979     putIfMissing(namedArgs, "imperf2p", base + "avate");
 980     putIfMissing(namedArgs, "imperf3p", base + "avano");
 981     // Passato remoto
 982     putIfMissing(namedArgs, "prem1s", base + "ai");
 983     putIfMissing(namedArgs, "prem2s", base + "asti");
 984     putIfMissing(namedArgs, "prem3s", base + "ò");
 985     putIfMissing(namedArgs, "prem1p", base + "ammo");
 986     putIfMissing(namedArgs, "prem2p", base + "aste");
 987     putIfMissing(namedArgs, "prem3p", base + "arono");
 988     // Future
 989     putIfMissing(namedArgs, "fut1s", base + "erò");
 990     putIfMissing(namedArgs, "fut2s", base + "erai");
 991     putIfMissing(namedArgs, "fut3s", base + "erà");
 992     putIfMissing(namedArgs, "fut1p", base + "eremo");
 993     putIfMissing(namedArgs, "fut2p", base + "erete");
 994     putIfMissing(namedArgs, "fut3p", base + "eranno");
 995     // Conditional
 996     putIfMissing(namedArgs, "cond1s", base + "erei");
 997     putIfMissing(namedArgs, "cond2s", base + "eresti");
 998     putIfMissing(namedArgs, "cond3s", base + "erebbe");
 999     putIfMissing(namedArgs, "cond1p", base + "eremmo");
1000     putIfMissing(namedArgs, "cond2p", base + "ereste");
1001     putIfMissing(namedArgs, "cond3p", base + "erebbero");
1002     // Subjunctive / congiuntivo
1003     putIfMissing(namedArgs, "sub123s", base + "i");
1004     putIfMissing(namedArgs, "sub1p", base + "iamo");
1005     putIfMissing(namedArgs, "sub2p", base + "iate");
1006     putIfMissing(namedArgs, "sub3p", base + "ino");
1007     // Imperfect subjunctive
1008     putIfMissing(namedArgs, "impsub12s", base + "assi");
1009     putIfMissing(namedArgs, "impsub3s", base + "asse");
1010     putIfMissing(namedArgs, "impsub1p", base + "assimo");
1011     putIfMissing(namedArgs, "impsub2p", base + "aste");
1012     putIfMissing(namedArgs, "impsub3p", base + "assero");
1013     // Imperative
1014     putIfMissing(namedArgs, "imp2s", base + "a");
1015     putIfMissing(namedArgs, "imp3s", base + "i");
1016     putIfMissing(namedArgs, "imp1p", base + "iamo");
1017     putIfMissing(namedArgs, "imp2p", base + "ate");
1018     putIfMissing(namedArgs, "imp3p", base + "ino");
1019
1020
1021     itConj(args, namedArgs);
1022   }
1023
1024
1025   private void itConj(List<String> args, Map<String, String> namedArgs) {
1026     // TODO Auto-generated method stub
1027
1028   }
1029
1030
1031   private static void putIfMissing(final Map<String, String> namedArgs, final String key,
1032       final String value) {
1033     final String oldValue = namedArgs.get(key);
1034     if (oldValue == null || oldValue.length() == 0) {
1035       namedArgs.put(key, value);
1036     }
1037   }
1038
1039   // TODO: check how ='' and =| are manifested....
1040   // TODO: get this right in -are
1041   private static void putOrNullify(final Map<String, String> namedArgs, final String key,
1042       final String value) {
1043     final String oldValue = namedArgs.get(key);
1044     if (oldValue == null/* || oldValue.length() == 0*/) {
1045       namedArgs.put(key, value);
1046     } else {
1047       if (oldValue.equals("''")) {
1048         namedArgs.put(key, "");
1049       }
1050     }
1051   }
1052
1053   static final Pattern whitespace = Pattern.compile("\\s+");
1054   static String trim(final String s) {
1055     return whitespace.matcher(s).replaceAll(" ").trim();
1056   }
1057
1058
1059 }