Internet Archive BookReader, an open-source online book viewer is now available as a plugin for ResourceSpace. IA BookReader comes with many unique features such as text search and is also mobile friendly. ResourceSpace is an online digital asset management software and is also open source. For more information on BookReader or ResourceSpace you can view the README in BookReader-source or visit their websites in Tools & Documentation.
Start by getting a copy of the repo.
Go into the config folder and edit the config.php file. There are 3 variables required pertaining to resourcespace:
$private_key = "your_private_api_key"
$user = "username"
$url = "http://.../path/to/resourcespace/"
The $user and $url are your resourcespace username and resourcespace address. You can find your private API key from the user accounts page. You can get there by going to your resourcespace instance and hitting Admin -> Manage users and locating your username.
Once finished, make sure to save and depending on how you plan to enable the plugin, you may or may not need to package your plugin. Continued in Enabling the plugin.
There are two ways to add the plugins to resourcespace outlined in the knowledge base under Managing Plugins.
If you plan to use the plugin manager, then you will need to package the plugin and upload it to resourcespace.
- Perform a tar and gzip on the plugin resulting in
bookreader.tar.gz. - Rename the zipped file to
bookreader.rsp.
This creates a ResourceSpace plugin file that you can upload. Now continue to follow the steps in the link Managing Plugins under The Plugin Manager. Note that this is the recommended way of enabling plugins safely and easily according to the resourcespace page.
If you plan to manually configurate the files then I will outline possible steps.
- Grab the entire bookreader folder and place it into your
.../resourcespace/plugins/folder. - Enable the plugin by adding bookreader to
$pluginsininclude/config.phpwith the line:
array_push($plugins, 'bookreader');
// or
$plugins = 'bookreader';
Alternatively, you can try these steps.
- Grab the entire bookreader folder and place it into your
.../resourcespace/plugins/folder manually. - Open up your resourcespace instance on the web and log in as an admin.
- Go to the plugin manager by choosing
Admin -> System -> Manage plugins. - Find the bookreader plugin in the available plugins list or search for it using the search bar.
- Click Activate to enable the plugin.
Disabling the plugin is very easy and only requires a few steps. If you enabled the plugin by manually configurating the include/config.php file, you will need to comment out or remove bookreader from $plugins first.
- Open up your resourcespace instance on the web and log in as an admin.
- Go to the plugin manager by choosing
Admin -> System -> Manage plugins. - Click Deactivate to disable the plugin.
-
Internet Archive Bookreader home page.
-
Internet Archive Bookreader github.
-
ResourceSpace home page.
-
ResourceSpace knowledge base link for writing your own plugin.
-
ResourceSpace knowledge base link for RESTful API.
-
Apache PDFBox, a Java PDF library.
-
My Java code behind pdfbox_search.jar on github
To better understand the job of search_inside.php I will provide a short demo/walkthrough below. Running search_inside.php will call pdfbox_search.jar, so it may be worth having a look at it's Java code in this repo. I will perform a run on a local file. In the live version, the shell command will be passed to you through BookReader. The output of the file should match BookReader's search api.
Here is the result for entering the command on a local file test.pdf and searching for the text Ancient:
java -jar pdfbox_search.jar 'Acta Vic' './test.pdf' 'Ancient' 'jQuery1234567890' 'abbyy'
callback:jQuery1234567890
ia:Acta Vic
term:ancient
pages:78
text:O {{{ancient}}} fane, O venerable shrine,
page_num:15
page_size:419.4,692.75
text_bounds:512.66,504.65997,221.28398,72.50001
term_bounds:112.724,512.66,504.65997,83.30001
text:and show the development in China from the {{{ancient}}} fish and key or
page_num:29
page_size:426.25,698.15
text_bounds:580.26,572.26,339.46002,44.100002
term_bounds:269.77603,580.26,572.26,240.69601
The first 4 lines are part of the header and contain information that was passed to PDFBox. The next blocks of text contain information about the matches that are found. In this case we found 2 matches for Ancient.
The resulting output needs to be changed into a json format and the text_bounds and term_bounds must be scaled to its correct size. The dimensions of the files stored in resourcespace could be different than what PDFBox parsed. This is because of the way resourcespace handles pdfs by splitting them into jpgs.
Applying this change, search_inside.php concludes and prints:
jQuery1234567890( {
"ia": "Acta Vic",
"q": "\"ancient\"",
"page_count": 78,
"leaf0_missing": true,
"matches": [
{
"text": "O {{{ancient}}} fane, O venerable shrine,",
"par": [{
"page": 15, "page_width": 3495, "page_height": 5773,
"b": 4272.2283363407, "t": 4205.5604573223, "r": 1844.0331666667, "l": 604.16675,
"boxes": [
{"r": 939.36666666667, "b": 4272.2283363407, "t": 4205.5604573223, "l": 694.16675}
]
}]
},
{
"text": "and show the development in China from the {{{ancient}}} fish and key or ",
"par": [{
"page": 29, "page_width": 3552, "page_height": 5818,
"b": 4835.56926162, "t": 4768.9016400487, "r": 2828.7671344047, "l": 367.4913949654,
"boxes": [
{"r": 2248.0808411965, "b": 4835.56926162, "t": 4768.9016400487, "l": 2005.7530264399}
]
}]
},
]
} )
It is now in the correct format and the BookReader search plugin will handle the output. For info on how BookReader does this, you can read the code in BookReader-source/BookReader/plugins/plugins.search.js. I hope this helped.