pdfclean.sh

#!/bin/sh
######################################################################################
# TITLE: pdfclean.sh
# TYPE: Bourne Shell Script
# DESCRIPTION: Cleans a pdf file
# AUTHOR: THE ENDWARE DEVELOPMENT TEAM
# COPYRIGHT: THE ENDWARE DEVELOPMENT TEAM, 2016-2017
# CREATION DATE: JUNE 3 2016
# VERSION: 0.07 
# REVISION DATE: June 15 2018
#
# CHANGE LOG: - Added --all flag for batch job inside a directory
#             - Changed instructions
#             - Worked on instructions section + Added Acknowledgements + EULA
#             - Commented out pdfcop
#             - Commented out verapdf 
#             - File Creation
#####################################################################################
# DEPENDENCIES: perl-image-exiftool, qpdf, pdfid.py, ghostscript  
#               libfaketime, faketime, date, pdfcop,verapdf
#####################################################################################
# INSTRUCTIONS: 
#  STEP 1) RETRIEVE PACKAGES 
# $ sudo pacman -S firejail gem tor torsocks qpdf git wget perl-image-exiftool ghostscript libfaketime
# $ sudo apt-get install firejail gem tor torsocks qpdf git wget perl-image-exiftool ghostscript libfaketime
# $ sudo yum install firejail gem tor torsocks qpdf git wget perl-image-exiftool ghostscript libfaketime
#
#  STEP 2) MAKE SOME DIRECTORIES
# $ mkdir ~/bin
# $ mkdir ~/src
# $ mkdir ~/git
# $ export PATH=$PATH:/home/$USER/bin
#
#  STEP 3) DOWNLOAD pdfid
# $ cd ~/src
# $ torsocks wget http://didierstevens.com/files/software/pdfid_v0_2_1.zip
# $ unzip pdfid_v0_2_1.zip
# $ cp *.py ~/bin	e
# 
# STEP 3) INSTALL origami 
# $ gem install origami 
# $ gem install core_ext
# $ gem install psych
#
# STEP 4) DOWNLOAD origami git 
# $ cd ~/git 
# $ torsocks -i git clone https://github.com/gdelugre/origami.git
# $ cd ~/bin 
# $ mkdir -p ~/bin/config
# $ cp ~/git/origami/bin/config/pdfcop.conf.yml ~/bin/config/
# $ ln -s ~/git/origami/bin/pdfcop  pdfcop
# $ ln -s ~/git/origami/bin/pdfmetadata  pdfmetadata
# $ ln -s ~/git/origami/bin/pdf2pdfa  pdf2pdfa
# 
# STEP 5) INSTAL mat  (Not Working)
# $ cd ~/git
# $ t  torsocks git clone https://git.torproject.org/user/jvoisin/mat.git
# or
# $ torsocks git clone http://dccbbv6cooddgcrq.onion/user/jvoisin/mat.git
# $ cd ~/bin
# $ ln -s ~/git/MAT/mat mat
# $ torsocks pacman -S poppler python2-poppler mutagen python-mutagen python-cairo 
#
# STEP 6) INSTALL verapdf  ( optional requires JAVA/ Untested)
# $ cd ~/git
# $ torsocks git clone https://github.com/veraPDF/veraPDF-apps.git
# $ cd ~/git/veraPDF-apps/installer/src/main/scripts
# $ ./verapdf.sh
#
# STEP 7) Download pdf file with safedown
# $ safedown http://www.website.com/strange.pdf 
#
# STEP 8) Get and configure pdfclean.sh
# $ cd ~/bin
# $ torsocks wget https://github.com/endwall2/endware/raw/master/pdfclean.sh
# $ mv pdfclean.sh pdfclean
# $ chmod u+rwx pdfclean  
#
# STEP 9) Safemode / firejail
# $ firejail --protocol=unix  --private-tmp --private-etc=localtime --nogroups --net=none
# $ cd /dev/shm/temp
# or
# $ safemode
# STEP 10) Clean the pdf that was downloaded
# $ pdfclean strange.pdf
# 
# STEP 11) Open file with pdfviewer while in safemode
# $ mupdf strange.clean.pdf
########################################################################################
#############################################################################################################################################################################
#                                         ACKNOWLEDGEMENTS
#############################################################################################################################################################################
#  The Endware Development Team would like to acknowledge the work and efforts of OdiliTime, and SnakeDude who graciously hosted and promoted this software project.  
#  Without their efforts and their wonderful website www.endchan.xyz, The Endware Suite would not exist in the public domain at all in any form. 
#
#  So thanks to OdiliTime, and to SnakeDude for inspiring this work and for hosting and promoting it. 
#  
#  The Endware Suite including Endwall,Endsets,Endlists,Endtools,Endloads and Endtube are named in honor of Endchan.
#
#  The Endware Suite is available for download at the following locations:
#  https://gitgud.io/Endwall/ , https://github.com/endwall2/, https://www.endchan.xyz/os/, http://42xlyaqlurifvvtq.onion,
#
#  Thank you also to early beta testers including a@a, and to other contributors 
#  as well as to the detractors who helped to critique this work and to ultimately improve it.  
#  
#  We also acknowledge paste.debian.net, ix.io, gitgud and github for their hosting services, 
#  without which distribution would be limited, so thank you.
#
#  https://www.endchan.xyz, http://paste.debian.net, https://gitgud.io, https://github.com, http://ix.io  
#
#  We salute you! 
#  
#  In the end, may it all end well.
#
#  The Endware Development Team
##############################################################################################################################################################################
##############################################################################################################################################################################
#                                                              LICENSE AGREEMENT  
##############################################################################################################################################################################
#  BEGINNING OF LICENSE AGREEMENT
#  TITLE:  THE ENDWARE END USER LICENSE AGREEMENT (EULA) 
#  CREATION DATE: MARCH 19, 2016
#  VERSION: 1.17
#  VERSION DATE: JUNE 16, 2018
#  COPYRIGHT: THE ENDWARE DEVELOPMENT TEAM, 2016-2018
#  ALL RIGHTS RESERVED  
#    
#  WHAT CONSTITUTES "USE"? WHAT IS A "USER"?
#  0) a) Use of this program means the ability to study, possess, run, copy, modify, publish, distribute and sell the code as included in all lines of this file,
#        in text format or as a binary file constituting this particular program or its compiled binary machine code form, as well as the the performance 
#        of these aforementioned actions and activities. 
#  0) b) A user of this program is any individual who has been granted use as defined in section 0) a) of the LICENSE AGREEMENT, and is granted to those individuals listed in section 1.
#  WHO MAY USE THIS PROGRAM ?
#  1) a) This program may be used by any living human being, any person, any corporation, any company, and by any sentient individual with the willingness and ability to do so.
#  1) b) This program may be used by any citizen or resident of any country, and by any human being without citizenship or residency.
#  1) c) This program may be used by any civilian, military officer, government agent, private citizen, government official, sovereign, monarch, head of state,
#        dignitary, ambassador, legislator,congressional representative, member of parliament, senator, judicial official, judge, prosecutor, lawyer, law enforcement officer, 
#        police constable, noble, commoner, clergy, laity, and generally all classes and ranks of people, persons, and human beings mentioned and those not mentioned.
#  1) d) This program may be used by any human being of any sex or gender, including men, women, or any other sex, or gender not mentioned.       
#  1) e) This program may be used by any human being of any affiliation, political viewpoint, political affiliation, religious belief, religious affiliation, and by those of non-belief or non affiliation.
#  1) f) This program may be used by any human being of any race, ethnicity, identity, origin, genetic makeup, physical appearance, mental ability, and by those of any other physical 
#        or non physical characteristics of differentiation.
#  1) g) This program may be used by any human being of any sexual orientation, including heterosexual, homosexual, bisexual, asexual, or any other sexual orientation not mentioned.
#  1) h) This program may be used by all business classes and business entities, including corporations, limited liability companies, sole proprietorships, partnerships, joint venture companies, private companies, publicly owned companies, and any other business class not specifically mentioned. i
#  1) j) This program may be used by anyone. 
#  WHERE MAY A USER USE THIS PROGRAM ?
#  2) a) This program may be used in any country, in any geographic location of the planet Earth, in any marine or maritime environment, at sea, sub-sea, in a submarine, underground,
#        in the air, in an airplane, dirigible, blimp, or balloon, in a car, bus,  motor vehicle, armored transport vehicle, and at any distance from the surface of the planet Earth, including in orbit about the Earth or the Moon,
#        on a satellite orbiting about the Earth, the Moon, about any Solar System planet and its moons, on any space transport vehicle, and anywhere in the Solar System including the Moon, Mars, and all other Solar System planets not listed.  
#  2) b) This program may be used in any residential, commercial, business, and governmental property or location and in all public and private spaces. 
#  2) c) This program may be used anywhere.
#  IN WHAT CONTEXT OR CIRCUMSTANCES MAY A USER USE THIS PROGRAM?
#  3)  This program may be used by any person, human being or sentient individual for any purpose and in any context and in any setting including for personal use, academic use,
#      business use, commercial use, government use, non-governmental organization use, non-profit organization use, military use, civilian use, and generally any other use 
#      not specifically mentioned.
#  WHAT MAY A "USER" DO WITH THIS PROGRAM ?
#  4) Any user of this program is granted the freedom to study the code.
#  5) a) Any user of this program is granted the freedom to distribute, publish, and share the code with any recipient of their choice electronically or by any other method of transmission. 
#  5) b) The LICENCSE AGREEMENT, ACKNOWLEDGMENTS, Header and Instructions must remain attached to the code in their entirety when re-distributed.
#  5) c) Any user of this program is granted the freedom to sell this software as distributed or to bundle it with other software or saleable goods.
#  6) a) Any user of this program is granted the freedom to modify the code.
#  6) b) When modified, any user of this program is granted the freedom of re-distribution of their modified code if and only if the user attatchs the LICENSE AGREEMENT
#        in its entirety to their modified code before re-distribution.
#  6) c) Any user of this software is granted the freedom to sell their modified copy of this software or to bundle their modified copy with other software or saleable goods.
#  6) d) Any modified code shall be sublicensed by the modifier and distributor only under the original terms of the Endware End User License Agreement as presented in this LICENSE AGREEMENT.
#  6) e) Any user of this software agrees that any derivative works produced as a result of user modification will be sublicensed when re-distributed under the original terms of this LICENSE AGREEMENT exactly as presented.
#  7) a) Any user of this program is granted the freedom to run this code on any computer of their choice.
#  7) b) Any user of this program is granted the freedom to run as many simultaneous instances of this code, on as many computers as they are able to and desire, and for as long as they desire and are
#        able to do so with any degree of simultaneity in use. 
#  WHAT MUST A "USER" NOT DO WITH THIS PROGRAM ?
#  8) Any user of this program is not granted the freedom to procure a patent for the methods presented in this software, and agrees not to do so.
#  9) Any user of this program is not granted the freedom to arbitrarily procure a copyright on this software as presented, and agrees not to do so.
#  10) Any user of this program is not granted the freedom to obtain or retain intellectual property rights on this software as presented and agrees not to do so.
#  11) a) Any user of this program may use this software as part of a patented process, as a substitutable input into the process; however the user agrees not to attempt to patent this software as part of their patented process. 
#  11) b) This software is a tool, like a hammer, and may be used in a process which applies for and gains a patent, as a substitutable input into the process;
#         however the software tool itself may not be included in the patent or covered by the patent as a novel invention, and the user agrees not to do this and not to attempt to do this.
#  WHO GRANTS THESE FREEDOMS ?
#  12) The creators of this software are the original developer,"Endwall", and anyone listed as being a member of "The Endware Development Team" by "Endwall", as well as ancillary contributors, and user modifiers and developers of the software. 
#  13) The aforementioned freedoms of use listed in sections 4),5),6),and 7) are granted by the creators of this software and the Endware Development Team to any qualifying user listed in section 1) and 
#      comporting with any restrictions and qualifications mentioned in sections 2), 3), 8), 9), 10) and 11) of this LICENSE AGREEMENT.
#  WHAT RELATIONSHIP DO THE USERS HAVE WITH THE CREATORS OF THE SOFTWARE ?
#  14)  This software is distributed "AS IS" without any warranty and without any guaranty and the creators do not imply anything about its usefulness or efficacy.
#  15)  If the user suffers or sustains financial loss, informational loss, material loss, physical loss or data loss as a result of using, running, or modifying this software 
#       the user agrees that they will hold the creators of this software, "The Endware Development Team", "Endwall", and the programmers involved in its creation, free from prosecution, 
#       free from indemnity, and free from liability, and will not attempt to seek restitution, compensation, or payment for any such loss real or imagined.
#  16)  If a user makes a significant improvement to this software, and if this improvement is included in a release, the user agrees not to seek remuneration or payment 
#       from the creators of this software or from Endwall or from the Endware Development Team, for any such work contribution performed, and the user understands 
#       that there will be no such remuneration or payment rendered to them for any such contribution. 
#  END OF LICENSE AGREEMENT
##################################################################################################################################################################################
#  ADDITIONAL NOTES:
#  17)  If a user finds a significant flaw or makes a significant improvement to this software, please feel free to notify the original developers so that we may also
#       include your user improvement in the next release; users are not obligated to do this, but we would enjoy this courtesy tremendously.
#
#  18)  Sections 0) a) 0) b) and 1) a) are sufficient for use; however sections 1) b) through 1) j) are presented to clarify 1 a) and to enforce non-discrimination and non-exclusion of use.  
#       For example some people may choose to redefine the meaning of the words "person" "human being" or "sentient individual" to exclude certain types of people.
#       This would be deemed unacceptable and is specifically rejected by the enumeration presented.  If the wording presented is problematic please contact us and suggest a change,
#       and it will be taken into consideration.  
#################################################################################################################################################################################
####################################               BEGINNING OF PROGRAM              ########################################################################
version="0.07"
branch="gnu/linux"
rev_date="16/06/2018"

## initial flag switch states
state="file"

##  get input list from shell argument 
for arg in $@
do 
 if [ "$arg" == "--help" ]
 then
 echo "PDFCLEAN: Clean a pdf of metadata and javascript and format it using ghostscript."
 echo " "
 echo "USAGE:  pdfclean --option file.pdf" 
 echo "pdfclean --help    # print usage information"
 echo "pdfclean --version # print version information"
 echo "pdfclean file.pdf  # standard pdf clean on one file" 
 echo "pdfclean --all # creates a list of all pdf files in the pwd and operates on them"
 echo " "
 shift 
 exit 0
 elif [ "$arg" == "--version" ]
 then
 echo "PDFCLEAN: version "$version", branch: "$branch", revision date: "$rev_date" "
 echo "Copyright: 2015-2017, THE ENDWARE DEVELOPMENT TEAM" 
 shift
 exit 0
 elif [ "$arg" == "--all" ]
 then
 state="all"
 shift
 shift 
 fi  

# store the argument
arghold="$arg"
 
done

# last argument is assumed to be a filename

## pdf cleaning function
cleanpdf(){
file=$1
rt=$( echo "$file" | cut -d . -f 1 ) 

exiftool -all= "$file" 
qpdf --suppress-recovery --object-streams=generate --decrypt --linearize "$file" "$file"_sane 

# set pdfmark with metadata
echo "[ /Producer () /DOCINFO pdfmark ]" > pdfmark 
LANG=C 
TZ=UTC 
faketime "1970-01-01 00:00:00 UTC" /bin/date
# reconstruct file with ghostscript
gs -dPDFA=2 -dColorConversionStrategy=/UseDeviceIndependentColor -dBATCH -dNOPAUSE -sDEVICE=pdfwrite -sProcessColorModel=DeviceCMYK -dPDFACompatibilityPolicy=1 -sOutputFile="${file%.*}".clean.pdf "$file"_sane "$(pwd)"/pdfmark 

## Add this back in  if you have a custom PDFA_def.ps file
#/path/to/custom/PDFA_def.ps "$file"_sane "$(pwd)"/pdfmark 

##### ENFORCE PDFA  
pdf2pdfa -o "$rt".pdfa_clean.pdf "${file%.*}".clean.pdf  

## VERAPDF ##  JAVA required
#verapdf --flavour 2b --format text "$rt".pdfa_clean.pdf 2>/dev/null PASS /dev/shm/temp/"$rt".pdfa_clean.pdf 

##  PDFCOP 
pdfcop -p paranoid "$rt".pdfa_clean.pdf    
pdfcop -p paranoid "$rt".pdfa_clean.pdf | grep policy

## observe data types post cleaning/ reconstruction
pdfid.py "$rt".pdfa_clean.pdf 
## observe the metadata post cleaning/ reconstruction
pdfmetadata "$rt".pdfa_clean.pdf

## delete intermediary files
rm "$file"_sane
rm pdfmark
}

if [ "$state" == "all" ]
then
ls *.pdf > file_list.txt 
IFS=$'\n' 
# main loop
 for file in $(cat file_list.txt) 
 do
 echo "Cleaning $file"
 cleanpdf $file
 echo "$file has been cleaned."
 done
 rm file_list.txt
elif [ "$arghold" != "" ]
then
 cleanpdf $arghold
else 
 echo "Usage Error: Type pdfclean --help for usage "
fi

exit "$?"

####################################                END OF PROGRAM                ##########################################################################