SUNScholar/Media Filters/4.X

From Libopedia
Jump to navigation Jump to search 
Back to Media Filters

Requirements

Check the following and then return. 

http://wiki.lib.sun.ac.za/index.php/SUNScholar/Install_DSpace/S03#Step_3.2

Step 1 - Login to the server

http://wiki.lib.sun.ac.za/index.php/SUNScholar/Prepare_Ubuntu/S01

Step 2 - Install the Ubuntu software packages

Type the following: 

sudo apt-get install xpdf poppler-utils curl

Step 3 - Install the java packages

Step 3A - Install "jai_imageio.jar"

mkdir $HOME/temp 

cd $HOME/temp

curl -O http://download.java.net/media/jai-imageio/builds/release/1.1/jai_imageio-1_1-lib-linux-i586.tar.gz

tar -xzvf jai_imageio-1_1-lib-linux-i586.tar.gz

 mvn install:install-file \
                    -Dfile=jai_imageio-1_1/lib/jai_imageio.jar  \
                    -DgroupId=com.sun.media                     \
                    -DartifactId=jai_imageio                    \
                    -Dversion=1.0_01                            \
                    -Dpackaging=jar                             \
                    -DgeneratePom=true

Step 3B - Install "jai_core.jar"

mkdir $HOME/temp 

cd $HOME/temp 

wget --no-check-certificate https://m2.duraspace.org/content/repositories/thirdparty/org/fcrepo/jai_core/1.1.2_01/jai_core-1.1.2_01.jar

mvn install:install-file \
                    -Dfile=jai_core-1.1.2_01.jar  \
                    -DgroupId=javax.media                      \
                    -DartifactId=jai_core                      \
                    -Dversion=1.1.2_01                         \
                    -Dpackaging=jar                            \
                    -DgeneratePom=true

Step 4 - Configuration

Step 4A

Edit the "dspace.cfg" file. 

nano /home/dspace/source/dspace/config/dspace.cfg

First enable thumbnails, search for following and change to true: 

webui.browse.thumbnail.show = true

webui.item.thumbnail.show = true

webui.preview.enabled = true

webui.preview.brand = My Institution Name

webui.preview.brand.abbrev = MyOrg

Second, be sure there is a value for thumbnail.maxwidth and that it corresponds to the size you want for preview images for the UI.

Search for the following and modify. 

# maximum width and height of generated thumbnails
thumbnail.maxwidth  = 160
thumbnail.maxheight = 160

Step 4B

Search for "filter.plugins" and replace with the following. 

filter.plugins = \
        PDF Text Extractor, \
        PDF Thumbnail, \
        HTML Text Extractor, \
        Word Text Extractor, \
        PowerPoint Text Extractor, \
        JPEG Thumbnail, \
        Branded Preview JPEG

Step 4C

Change the MediaFilter plugin configuration to remove the old "org.dspace.app.mediafilter.PDFFilter" and add the new filters "org.dspace.app.mediafilter.XPDF2Text = PDF Text Extractor" and "org.dspace.app.mediafilter.XPDF2Thumbnail = PDF Thumbnail". Replace with the following. 

plugin.named.org.dspace.app.mediafilter.FormatFilter = \
  org.dspace.app.mediafilter.XPDF2Text = PDF Text Extractor, \
  org.dspace.app.mediafilter.XPDF2Thumbnail = PDF Thumbnail, \
  org.dspace.app.mediafilter.HTMLFilter = HTML Text Extractor, \
  org.dspace.app.mediafilter.WordFilter = Word Text Extractor, \
  org.dspace.app.mediafilter.PowerPointFilter = PowerPoint Text Extractor, \
  org.dspace.app.mediafilter.JPEGFilter = JPEG Thumbnail, \
  org.dspace.app.mediafilter.BrandedPreviewJPEGFilter = Branded Preview JPEG

Step 4D

Then replace "filter.org.dspace.app.mediafilter.PDFFilter.inputFormats = Adobe PDF" with the following: 

filter.org.dspace.app.mediafilter.XPDF2Thumbnail.inputFormats = Adobe PDF
filter.org.dspace.app.mediafilter.XPDF2Text.inputFormats = Adobe PDF

Step 4E

Above the comment, "#Custom settings for PDFFilter", add the following: 

#The paths to the XPDF utilities
xpdf.path.pdftotext = /usr/bin/pdftotext
xpdf.path.pdftoppm  = /usr/bin/pdftoppm
xpdf.path.pdfinfo   = /usr/bin/pdfinfo
NANO Editor Help
CTL+O = Save the file and then press Enter
CTL+X = Exit "nano"
CTL+K = Delete line
CTL+U = Undelete line
CTL+W = Search for %%string%%
CTL+\ = Search for %%string%% and replace with $$string$$
CTL+C = Show line numbers

More info = http://en.wikipedia.org/wiki/Nano_(text_editor)

Step 4 - Build and Install

Perform the following as the "dspace" user.

To build, type the following: 

cd /home/dspace/source

mvn -U clean package -Pxpdf-mediafilter-support

To install, type the following: (Replace XXX with your DSpace version number) 

cd /home/dspace/source/dspace/target/dspace-XXX-build

ant update

ant clean_backups

Step 5 - Update dspace rebuild script

If the test build works then add the switch"-Pxpdf-mediafilter-support" to the dspace rebuild script, so that: 

mvn -U clean package

becomes 

mvn -U clean package -Pxpdf-mediafilter-support

See: http://wiki.lib.sun.ac.za/index.php/SUNScholar/Rebuild_DSpace

Step 6 - Test the media filers

Restart DSpace and then type the following to test. Select an item that has pdf files attached and use it as replacement for "123456789/29097". 

/home/dspace/bin/dspace filter-media -n -v -i 123456789/29097

Step 7 - Create new thumbnails

Now that the tests have worked, type the following to force creation of new thumbnails for the entire system. The script is configured to do 1000 items at a time only. This saves on memory and CPU time. Therefore on a large system you may need to run the script several times. Also make sure that the dspace user has full read/write access to all items in the assetstore folders. 

sudo chmod 0777 -R /home/dspace/assetstore/

/home/dspace/bin/dspace filter-media -n -v -f -m 1000 -p "PDF Thumbnail"

Step 8 - Add a daily admin task

See: http://wiki.lib.sun.ac.za/index.php/SUNScholar/Daily_Admin. Check the "filter-media" options!

References

Retrieved from "http://wiki.lib.sun.ac.za/index.php?title=SUNScholar/Media_Filters/4.X&oldid=33070"