previewer: pdfjs plugin addition

[bouzlibop]

• Adds pdfjs previewer.

Signed-off-by: Adrian Pawel Baran adrian.pawel.baran@cern.ch

[bouzlibop]

@lnielsen-cern Please check also this: zenodo/zenodo#15

[lnielsen]

Please use double quotes `"""instead of single quotes'''```.

[jirikuncar]

@bouzlibop if we are keeping previous implementation we need to create separate bundles. Please check also annotations interface that it's still working. Thank you.

WDYT about commit message: previewer: pdfjs plugin addition ?

[bouzlibop]

@jirikuncar, the new commit message title sounds good.

I checked the annotations module. Thanks for pointing that out. I'll prepare a separate bundle for this new pdfjs previewer. I believe that it would be worth to have the name "pdfjs" for the bundle for new previewer and change the name of the bundle used in annotations to sth else. Just to keep the clearness of naming (this is what I've used: http://mozilla.github.io/pdf.js/).

[jirikuncar]

@bouzlibop I have made some little fixes for annotations module. Feel free to rename the bundles after #2410 is merged.

[invenio-developers]

1: D208 Docstring is over-indented
118:1: F999 redefinition of unused 'compile_text' from line 111

[bouzlibop]

@lnielsen-cern Here I put the url to my repository with customized pdfjs-build.
I tested it and it's working. Probably it should be one of zenodo repositories.

[jirikuncar]

Can you use the upstream package and just install custom js/css files from Invenio (Zenodo) repo?

[bouzlibop]

The official bower package for pdfjs is pdfjs-dist, but this one can be probably only used to build own version of the viewer and it doesn't contain the official version of the viewer (the one I am using here).
The two example ways of how to obtain this official viewer are:

1. Use the official repo https://github.com/mozilla/pdf.js as endpoint for bower install and then build the viewer locally (node make generic)
2. Use the 3rd party repo (eg. git://github.com/RiptideCloud/pdfjs-build.git), which comes with the prebuild version of the viewer

And then, there still remains the problem with some paths hardcoded in the scripts (like PDFJS.imageResourcesPath for example), which we need to customize in order to make the viewer work in invenio.

The simplest solution which comes to my mind (as I mentioned in the first comment) is to fork the 3rd party repo and make the changes we need.

But I'm not sure if this is the best way to solve this.

[lnielsen]

During integration on Zenodo I've made some changes that should likely be added to the pull request, so I'm just changing it to WIP

[bouzlibop]

@lnielsen-cern could you please specify what are those changes that needs to be add here ?

[lnielsen]

Yes, it is in these commits:
zenodo/invenio@8061bf7
zenodo/invenio@a5e7429
zenodo/invenio@12e5e3e
zenodo/invenio@0ca6c46
zenodo/invenio@da81901

However, also we should like copy the viewer html and css into Invenio and use the standard bower build of pdfjs.

[bouzlibop]

@lnielsen-cern I got through the commits you pointed out and applied the changes to this PR. Now I will try to look into switching to bower build.

[bouzlibop]

@lnielsen-cern what do you mean by "use the standard bower build of pdfjs" ? Should we use the official repo https://github.com/mozilla/pdf.js as endpoint for bower install and then build the viewer locally (node make generic) ? Or should we do it in some other way?

[lnielsen]

Official is probably not the right word. "Existing" bower package is better. As far as I remember you said that the official build could not be used out of the box.

[bouzlibop]

I think that this one - mozilla/pdfjs-dist - can be used only for building some custom viewer. In our case we can use this one: RiptideCloud/pdfjs-build or (as I mentioned in the previous comment) - we can use official mozilla/pdfjs repo as endpoint for bower and then locally perform node make generic to build the viewer.

In either case, what about this changes https://github.com/bouzlibop/pdfjs-build/compare/RiptideCloud:master...master#diff-564dfd8dd910689dffde37ab83a2a010L58 in viewer.js ? Do you think we can solve that problem with relative path?

[lnielsen]

and then locally perform node make generic to build the viewer.

I would like to avoid running extra commands besides bower install so probably best to use RiptideCloud/pdfjs-build

In either case, what about this changes bouzlibop/pdfjs-build@RiptideCloud:master...master#diff-564dfd8dd910689dffde37ab83a2a010L58 in viewer.js ? Do you think we can solve that problem with relative path?

The viewer.js I would simply integrate in Invenio source code.

[bouzlibop]

@lnielsen-cern I've just added the full screen mode and I've changed the structure a little bit - now I'm using the RiptideCloud/pdfjs-build package. I still have to test a few things here, but meanwhile if you find a time please have a birds-eye view over the changes 😄

[jirikuncar]

I guess this https://github.com/bouzlibop/invenio/blob/zenodo-194-pdfpreviewer/invenio/modules/previewer/static/js/previewer/pdfjs_previewer/pdfjs.js#L5625-L5668 can be moved out because the button is defined here https://github.com/inveniosoftware/invenio/pull/2402/files#diff-d555729c3cdb5523bfba4e8c872f6c7bR79

[jirikuncar]

I would rename invenio/modules/previewer/static/js/previewer/pdfjs_previewer/pdfjs.js to invenio/modules/previewer/static/js/previewer/pdfjs/viewer.js and prepare initial commit with original version in name of the original author and then commit our changes.

[lnielsen]

@bouzlibop Can you take https://github.com/lnielsen-cern/invenio/tree/pu-previewer-pdfjs and repush this PR. I've rebased the code, cleaned up some few things and checked that all code from Zenodo was integrated.

Once it's done, you can remove the WIP from the title, so that can get it integrated.

[bouzlibop]

@lnielsen-cern, many thanks for the clean up.

Today I tested this PR (after taking the lnielsen-cern/invenio/tree/pu-previewer-pdfjs) and in order to make things work I did some changes in this commit 49d6b69. Specifically files:

• invenio/modules/previewer/bundles.py
• invenio/modules/previewer/static/css/previewer/pdfjs/viewer.css

Could you have a look at this final version?

PS: I tested this PR in both invenio and zenodo (ASSETS_DEBUG=False/True)

[lnielsen]

LGTM. Just missing the test to pass (seems to be a sphinx doc build issue).

[bouzlibop]

@jirikuncar, I think it's ready to be merged.

[lnielsen]

@bouzlibop Can you just try to run ``python setup.py build_sphinx -b html" locally to see why the documentation build fails.

[bouzlibop]

/home/adrian/.virtualenvs/invenio/src/invenio/docs/ext/elasticsearch.rst:21: WARNING: autodoc: failed to import module u'invenio.ext.elasticsearch'; the following exception was raised:
Traceback (most recent call last):
  File "/home/adrian/.virtualenvs/invenio/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 335, in import_object
    __import__(self.modname)
  File "/home/adrian/.virtualenvs/invenio/src/invenio/invenio/ext/elasticsearch/__init__.py", line 86, in <module>
    from pyelasticsearch import ElasticSearch as PyElasticSearch
ImportError: No module named pyelasticsearch
/home/adrian/.virtualenvs/invenio/src/invenio/docs/modules/jsonalchemy.rst:557: WARNING: autodoc: failed to import class u'MongoDBStorage' from module u'invenio.modules.jsonalchemy.jsonext.engines.mongodb_pymongo'; the following exception was raised:
Traceback (most recent call last):
  File "/home/adrian/.virtualenvs/invenio/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 335, in import_object
    __import__(self.modname)
  File "/home/adrian/.virtualenvs/invenio/src/invenio/invenio/modules/jsonalchemy/jsonext/engines/mongodb_pymongo.py", line 22, in <module>
    import pymongo
ImportError: No module named pymongo
/home/adrian/.virtualenvs/invenio/src/invenio/docs/modules/oauthclient.rst:37: WARNING: autodoc: failed to import module u'invenio.modules.oauthclient.contrib.github'; the following exception was raised:
Traceback (most recent call last):
  File "/home/adrian/.virtualenvs/invenio/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 335, in import_object
    __import__(self.modname)
  File "/home/adrian/.virtualenvs/invenio/src/invenio/invenio/modules/oauthclient/contrib/github.py", line 80, in <module>
    import github3
ImportError: No module named github3

[jirikuncar]

you need to run pip install -e .[docs] first.

[bouzlibop]

Thanks @jirikuncar, now there are no errors during python setup.py build_sphinx -b html. I will try to restart Travis build then.