DIH's TikaEntityProcessor's handling of embedded documents

["Allison, Timothy B." <ta...@mitre.org>]

All,

  I recently took a look at the source code for TikaEntityProcessor, and I noticed that the code is not configuring the ParseContext to have Tika's AutoDetectParser (or any parser) parse documents recursively.  That is, if you have a zip file or any other container document, DIH's TikaEntityProcessor is not configured to handle/parse/extract contents from the embedded documents.

  Is this the intended behavior?  Is this what users expect?

  The change is trivial, and it probably should be configurable whether or not to have DIH parse recursively.  

  Many apologies if this is a known issue or a non-issue.

   If this is actually an issue, I'll be happy to open an issue and supply a patch.


         Best,

                 Tim


To see what I mean, grab test_recursive_embedded.docx from here (http://svn.apache.org/viewvc/tika/trunk/tika-server/src/test/resources/test_recursive_embedded.docx?view=log )

Add this pseudo test code to TestTikaEntityProcessor:

  @Test
  public void testTikaEmbeddedDocs() throws Exception {
    runFullImport(getConfigEmbedded());
    String json = JQ(req("*:*"));
    System.out.println(json);
  }

  private String getConfigEmbedded() {
    return
        "<dataConfig>" +
            "  <dataSource type=\"BinFileDataSource\"/>" +
            "  <document>" +
            "    <entity name=\"Tika\" processor=\"TikaEntityProcessor\" url=\"" +
            getFile("dihextras/test_recursive_embedded.docx").getAbsolutePath() + "\" >" +
            "      <field column=\"Author\" meta=\"true\" name=\"author\"/>" +
            "      <field column=\"title\" meta=\"true\" name=\"title\"/>" +
            "      <field column=\"text\"/>" +
            "     </entity>" +
            "  </document>" +
            "</dataConfig>";
  }

The output is this:

"response":{"numFound":1,"start":0,"docs":[
      {
        "text":"\n\n\nembed_0  \n\n\n\n\n\n\n"}]
  }


If you add this line to TikaEntityParser:

        context.set(Parser.class, tikaParser);

You get this:
      {
        "text":"\n\n\nembed_0  \n\n\n\n\n\n\n\nembed1/embed1a.txt\nembed_1a\n\n\n\nembed1/embed1b.txt\nembed_1b\n\n\n\nembed1/embed2.zip\n\n\nembed2/embed2a.txt\n\nembed_2a\n\n\n\n\n\n\nembed2/embed2b.txt\n\nembed_2b\n\n\n\n\n\n\nembed2/embed3.zip\n\n\n\n\nembed3/embed3.txt\n\n\nembed_3\r\n\r\nWhen in the Course of human events it becomes necessary for one people to dissolve the political bands which have connected them with another and to assume among the powers of the earth, the separate and equal station to which the Laws of Nature and of Nature's God entitle them, a decent respect to the opinions of mankind requires that they should declare the causes which impel them to the separation.\r\n \r\nWe hold these truths to be self-evident, that all men are created equal, that they are endowed by their Creator with certain unalienable Rights, that among these are Life, Liberty and the pursuit of Happiness. - That to secure these rights, Governments are instituted among Men, deriving their just powers from the consent of the governed, - That whenever any Form of Government becomes destructive of these ends, it is the Right of the People to alter or to abolish it, and to institute new Government, laying its foundation on such principles and organizing its powers in such form, as to them shall seem most likely to effect their Safety and Happiness. Prudence, indeed, will dictate that Governments long established should not be changed for light and transient causes; and accordingly all experience hath shewn that mankind are more disposed to suffer, while evils are sufferable than to right themselves by abolishing the forms to which they are accustomed. But when a long train of abuses and usurpations, pursuing invariably the same Object evinces a design to reduce them under absolute Despotism, it is their right, it is their duty, to throw off such Government, and to provide new Guards for their future security. - Such has been the patient sufferance of these Colonies; and such is now the necessity which constrains them to alter their former Systems of Government. The history of the present King of Great Britain is a history of repeated injuries and usurpations, all having in direct object the establishment of an absolute Tyranny over these States. To prove this, let Facts be submitted to a candid world.\r\n \r\nHe has refused his Assent to Laws, the most wholesome and necessary for the public good.\r\n \r\nHe has forbidden his Governors to pass Laws of immediate and pressing importance, unless suspended in their operation till his Assent should be obtained; and when so suspended, he has utterly neglected to attend to them.\r\n \r\nHe has refused to pass other Laws for the accommodation of large districts of people, unless those people would relinquish the right of Representation in the Legislature, a right inestimable to them and formidable to tyrants only.\r\n \r\nHe has called together legislative bodies at places unusual, uncomfortable, and distant from the depository of their Public Records, for the sole purpose of fatiguing them into e with his measures.\r\n \r\nHe has dissolved Representative Houses repeatedly, for opposing with manly firmness his invasions on the rights of the people.\r\n \r\nHe has refused for a long time, after such dissolutions, to cause others to be elected, whereby the Legislative Powers, incapable of Annihilation, have returned to the People at large for their exercise; the State remaining in the mean time exposed to all the dangers of invasion from without, and convulsions within.\r\n \r\nHe has endeavoured to prevent the population of these States; for that purpose obstructing the Laws for Naturalization of Foreigners; refusing to pass others to encourage their migrations hither, and raising the conditions of new Appropriations of Lands.\r\n \r\nHe has obstructed the Administration of Justice by refusing his Assent to Laws for establishing Judiciary Powers.\r\n \r\nHe has made Judges dependent on his Will alone for the tenure of their offices, and the amount and payment of their salaries.\r\n \r\nHe has erected a multitude of New Offices, and sent hither swarms of Officers to harass our people and eat out their substance.\r\n \r\nHe has kept among us, in times of peace, Standing Armies without the Consent of our legislatures.\r\n \r\nHe has affected to render the Military independent of and superior to the Civil Power.\r\n \r\nHe has combined with others to subject us to a jurisdiction foreign to our constitution, and unacknowledged by our laws; giving his Assent to their Acts of pretended Legislation:\r\n \r\nFor quartering large bodies of armed troops among us:\r\n \r\nFor protecting them, by a mock Trial from punishment for any Murders which they should commit on the Inhabitants of these States:\r\n \r\nFor cutting off our Trade with all parts of the world:\r\n \r\nFor imposing Taxes on us without our Consent:\r\n \r\nFor depriving us in many cases, of the benefit of Trial by Jury:\r\n \r\nFor transporting us beyond Seas to be tried for pretended offences:\r\n \r\nFor abolishing the free System of English Laws in a neighbouring Province, establishing therein an Arbitrary government, and enlarging its Boundaries so as to render it at once an example and fit instrument for introducing the same absolute rule into these Colonies\r\n \r\nFor taking away our Charters, abolishing our most valuable Laws and altering fundamentally the Forms of our Governments:\r\n \r\nFor suspending our own Legislatures, and declaring themselves invested with power to legislate for us in all cases whatsoever.\r\n \r\nHe has abdicated Government here, by declaring us out of his Protection and waging War against us.\r\n \r\nHe has plundered our seas, ravaged our coasts, burnt our towns, and destroyed the lives of our people.\r\n \r\nHe is at this time transporting large Armies of foreign Mercenaries to compleat the works of death, desolation, and tyranny, already begun with circumstances of Cruelty & Perfidy scarcely paralleled in the most barbarous ages, and totally unworthy the Head of a civilized nation.\r\n \r\nHe has constrained our fellow Citizens taken Captive on the high Seas to bear Arms against their Country, to become the executioners of their friends and Brethren, or to fall themselves by their Hands.\r\n \r\nHe has excited domestic insurrections amongst us, and has endeavoured to bring on the inhabitants of our frontiers, the merciless Indian Savages whose known rule of warfare, is an undistinguished destruction of all ages, sexes and conditions.\r\n \r\nIn every stage of these Oppressions We have Petitioned for Redress in the most humble terms: Our repeated Petitions have been answered only by repeated injury. A Prince, whose character is thus marked by every act which may define a Tyrant, is unfit to be the ruler of a free people.\r\n \r\nNor have We been wanting in attentions to our British brethren. We have warned them from time to time of attempts by their legislature to extend an unwarrantable jurisdiction over us. We have reminded them of the circumstances of our emigration and settlement here. We have appealed to their native justice and magnanimity, and we have conjured them by the ties of our common kindred to disavow these usurpations, which would inevitably interrupt our connections and correspondence. They too have been deaf to the voice of justice and of consanguinity. We must, therefore, acquiesce in the necessity, which denounces our Separation, and hold them, as we hold the rest of mankind, Enemies in War, in Peace Friends.\r\n \r\nWe, therefore, the Representatives of the united States of America, in General Congress, Assembled, appealing to the Supreme Judge of the world for the rectitude of our intentions, do, in the Name, and by Authority of the good People of these Colonies, solemnly publish and declare, That these united Colonies are, and of Right ought to be Free and Independent States, that they are Absolved from all Allegiance to the British Crown, and that all political connection between them and the State of Great Britain, is and ought to be totally dissolved; and that as Free and Independent States, they have full Power to levy War, conclude Peace, contract Alliances, establish Commerce, and to do all other Acts and Things which Independent States may of right do. - And for the support of this Declaration, with a firm reliance on the protection of Divine Providence, we mutually pledge to each other our Lives, our Fortunes, and our sacred Honor.\r\n\n\n\n\n\n\n\n\n\n\nembed3/embed4.zip\n\n\n\n\n\n\nembed4.txt\n\n\n\nembed_4\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"}]

RE: DIH's TikaEntityProcessor's handling of embedded documents

["Allison, Timothy B." <ta...@mitre.org>]

Got it.  Thank you.  SOLR-7189.



-----Original Message-----
From: Alexandre Rafalovitch [mailto:arafalov@gmail.com] 
Sent: Wednesday, March 04, 2015 12:31 PM
To: solr-user
Subject: Re: DIH's TikaEntityProcessor's handling of embedded documents

DIH does not get as much attention as other parts of the system. If
you see a clear way to improve it, I'd say go ahead and file the
issue. If you can provide the patch which passes the tests and -
ideally - includes new tests, this would be even greater.

Regards,
   Alex.

----
Solr Analyzers, Tokenizers, Filters, URPs and even a newsletter:
http://www.solr-start.com/


On 4 March 2015 at 11:06, Allison, Timothy B. <ta...@mitre.org> wrote:
> All,
>
>   I recently took a look at the source code for TikaEntityProcessor, and I noticed that the code is not configuring the ParseContext to have Tika's AutoDetectParser (or any parser) parse documents recursively.  That is, if you have a zip file or any other container document, DIH's TikaEntityProcessor is not configured to handle/parse/extract contents from the embedded documents.
>
>   Is this the intended behavior?  Is this what users expect?
>
>   The change is trivial, and it probably should be configurable whether or not to have DIH parse recursively.
>
>   Many apologies if this is a known issue or a non-issue.
>
>    If this is actually an issue, I'll be happy to open an issue and supply a patch.
>
>
>          Best,
>
>                  Tim

Re: DIH's TikaEntityProcessor's handling of embedded documents

[Alexandre Rafalovitch <ar...@gmail.com>]

DIH does not get as much attention as other parts of the system. If
you see a clear way to improve it, I'd say go ahead and file the
issue. If you can provide the patch which passes the tests and -
ideally - includes new tests, this would be even greater.

Regards,
   Alex.

----
Solr Analyzers, Tokenizers, Filters, URPs and even a newsletter:
http://www.solr-start.com/


On 4 March 2015 at 11:06, Allison, Timothy B. <ta...@mitre.org> wrote:
> All,
>
>   I recently took a look at the source code for TikaEntityProcessor, and I noticed that the code is not configuring the ParseContext to have Tika's AutoDetectParser (or any parser) parse documents recursively.  That is, if you have a zip file or any other container document, DIH's TikaEntityProcessor is not configured to handle/parse/extract contents from the embedded documents.
>
>   Is this the intended behavior?  Is this what users expect?
>
>   The change is trivial, and it probably should be configurable whether or not to have DIH parse recursively.
>
>   Many apologies if this is a known issue or a non-issue.
>
>    If this is actually an issue, I'll be happy to open an issue and supply a patch.
>
>
>          Best,
>
>                  Tim