324 lines
11 KiB
Python
Executable File
324 lines
11 KiB
Python
Executable File
#!/usr/bin/env python
|
|
|
|
#***************************************************************************
|
|
#* *
|
|
#* Copyright (c) 2009 Yorik van Havre <yorik@uncreated.net> *
|
|
#* *
|
|
#* This program is free software; you can redistribute it and/or modify *
|
|
#* it under the terms of the GNU Lesser General Public License (LGPL) *
|
|
#* as published by the Free Software Foundation; either version 2 of *
|
|
#* the License, or (at your option) any later version. *
|
|
#* for detail see the LICENCE text file. *
|
|
#* *
|
|
#* This program is distributed in the hope that it will be useful, *
|
|
#* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
#* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
#* GNU Library General Public License for more details. *
|
|
#* *
|
|
#* You should have received a copy of the GNU Library General Public *
|
|
#* License along with this program; if not, write to the Free Software *
|
|
#* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
|
|
#* USA *
|
|
#* *
|
|
#***************************************************************************
|
|
|
|
__title__="buildpdf"
|
|
__author__ = "Yorik van Havre <yorik@uncreated.net>"
|
|
__url__ = "http://www.freecadweb.org"
|
|
|
|
"""
|
|
This script builds a pdf file from a local copy of the wiki
|
|
"""
|
|
|
|
Workbenches=["Part","PartDesign","Sketcher","Constraints","Draft","Path","Fem","Arch","TechDraw","Raytracing","OpenSCAD","Robot","Mesh"]
|
|
|
|
TOC="""Online_Help_Startpage
|
|
About_FreeCAD
|
|
Feature_list
|
|
Installing
|
|
Getting_started
|
|
Mouse_Model
|
|
Document_structure
|
|
Property_editor
|
|
Import_Export
|
|
Workbenches
|
|
|
|
WorkbenchesList
|
|
|
|
Interface_Customization
|
|
Preferences_Editor
|
|
Macros
|
|
Introduction_to_Python
|
|
Python_scripting_tutorial
|
|
Topological_data_scripting
|
|
Mesh_Scripting
|
|
Mesh_to_Part
|
|
Scenegraph
|
|
Pivy
|
|
|
|
begin
|
|
|
|
PySide
|
|
PySide_Beginner_Examples
|
|
PySide_Medium_Examples
|
|
PySide_Advanced_Examples
|
|
|
|
end
|
|
|
|
Scripted_objects
|
|
Embedding_FreeCAD
|
|
Embedding_FreeCADGui
|
|
Code_snippets"""
|
|
|
|
import sys, os, re, tempfile, getopt, shutil, time
|
|
from urllib.request import urlopen
|
|
from urllib.error import HTTPError
|
|
|
|
# CONFIGURATION #################################################
|
|
|
|
INDEX = "Online_Help_Toc" # the start page from where to crawl the wiki
|
|
PDFCONVERTOR = 'wkhtmltopdf' # can be 'pisa', 'htmldoc', 'wkhtmltopdf' or 'firefox'
|
|
VERBOSE = True # set true to get output messages
|
|
INCLUDECOMMANDS = True # if true, the command pages of each workbench are included after each WB page
|
|
OVERWRITE = False # if true, pdf files are recreated even if already existing
|
|
FIREFOXPDFFOLDER = os.path.expanduser("~")+os.sep+"PDF" # if firefox is used, set this to where it places its pdf files by default
|
|
COVER = "http://www.freecadweb.org/wiki/images/7/79/Freecad-pdf-cover.svg"
|
|
|
|
# END CONFIGURATION ##############################################
|
|
|
|
|
|
FOLDER = "./localwiki"
|
|
|
|
fcount = dcount = 0
|
|
|
|
def crawl():
|
|
"creates a pdf file from the localwiki folder"
|
|
|
|
# tests ###############################################
|
|
|
|
if PDFCONVERTOR == 'pisa':
|
|
try:
|
|
import ho.pisa as pisa
|
|
except:
|
|
"Error: Python-pisa not installed, exiting."
|
|
return 1
|
|
elif PDFCONVERTOR == 'htmldoc':
|
|
if os.system('htmldoc --version'):
|
|
print("Error: Htmldoc not found, exiting.")
|
|
return 1
|
|
try:
|
|
from PyPDF2 import PdfFileReader,PdfFileWriter
|
|
except:
|
|
print("Error: Python-pypdf2 not installed, exiting.")
|
|
|
|
# run ########################################################
|
|
|
|
buildpdffiles()
|
|
joinpdf()
|
|
|
|
if VERBOSE: print("All done!")
|
|
return 0
|
|
|
|
|
|
def buildpdffiles():
|
|
"scans a folder for html files and converts them all to pdf"
|
|
templist = os.listdir(FOLDER)
|
|
if PDFCONVERTOR == 'wkhtmltopdf':
|
|
makeStyleSheet()
|
|
global fileslist
|
|
fileslist = []
|
|
for i in templist:
|
|
if i[-5:] == '.html':
|
|
fileslist.append(i)
|
|
print("converting ",len(fileslist)," pages")
|
|
i = 1
|
|
for f in fileslist:
|
|
print(i," : ",f)
|
|
if PDFCONVERTOR == 'pisa':
|
|
createpdf_pisa(f[:-5])
|
|
elif PDFCONVERTOR == 'wkhtmltopdf':
|
|
createpdf_wkhtmltopdf(f[:-5])
|
|
elif PDFCONVERTOR == 'firefox':
|
|
createpdf_firefox(f[:-5])
|
|
else:
|
|
createpdf_htmldoc(f[:-5])
|
|
i += 1
|
|
|
|
|
|
def fetch_resources(uri, rel):
|
|
"""
|
|
Callback to allow pisa/reportlab to retrieve Images,Stylesheets, etc.
|
|
'uri' is the href attribute from the html link element.
|
|
'rel' gives a relative path, but it's not used here.
|
|
|
|
Note from Yorik: Not working!!
|
|
"""
|
|
path = os.path.join(FOLDER,uri.replace("./", ""))
|
|
return path
|
|
|
|
def createpdf_pisa(pagename):
|
|
"creates a pdf file from a saved page using pisa (python module)"
|
|
import ho.pisa as pisa
|
|
if (not exists(pagename+".pdf",image=True)) or OVERWRITE:
|
|
infile = open(FOLDER + os.sep + pagename+'.html','ro')
|
|
outfile = open(FOLDER + os.sep + pagename+'.pdf','wb')
|
|
if VERBOSE: print("Converting " + pagename + " to pdf...")
|
|
pdf = pisa.CreatePDF(infile,outfile,FOLDER,link_callback=fetch_resources)
|
|
outfile.close()
|
|
if pdf.err:
|
|
return pdf.err
|
|
return 0
|
|
|
|
|
|
def createpdf_firefox(pagename):
|
|
"creates a pdf file from a saved page using firefox (needs command line printing extension)"
|
|
# the default printer will be used, so make sure it is set to pdf
|
|
# command line printing extension http://forums.mozillazine.org/viewtopic.php?f=38&t=2729795
|
|
if (not exists(pagename+".pdf",image=True)) or OVERWRITE:
|
|
infile = FOLDER + os.sep + pagename+'.html'
|
|
outfile = FOLDER + os.sep + pagename+'.pdf'
|
|
os.system('firefox -print ' + infile)
|
|
time.sleep(6)
|
|
if os.path.exists(FIREFOXPDFFOLDER + os.sep + pagename + ".pdf"):
|
|
shutil.move(FIREFOXPDFFOLDER+os.sep+pagename+".pdf",outfile)
|
|
else:
|
|
print("-----------------------------------------> Couldn't find print output!")
|
|
|
|
|
|
def createpdf_htmldoc(pagename):
|
|
"creates a pdf file from a saved page using htmldoc (external app, but supports images)"
|
|
if (not exists(pagename+".pdf",image=True)) or OVERWRITE:
|
|
infile = FOLDER + os.sep + pagename+'.html'
|
|
outfile = FOLDER + os.sep + pagename+'.pdf'
|
|
return os.system('htmldoc --webpage --textfont sans --browserwidth 840 -f '+outfile+' '+infile)
|
|
|
|
|
|
def createpdf_wkhtmltopdf(pagename):
|
|
"creates a pdf file from a saved page using htmldoc (external app, but supports images)"
|
|
if (not exists(pagename+".pdf",image=True)) or OVERWRITE:
|
|
infile = FOLDER + os.sep + pagename+'.html'
|
|
outfile = FOLDER + os.sep + pagename+'.pdf'
|
|
cmd = 'wkhtmltopdf -L 5mm --user-style-sheet '+FOLDER+os.sep+'wkhtmltopdf.css '+infile+' '+outfile
|
|
print(cmd)
|
|
#return os.system(cmd)
|
|
else:
|
|
print("skipping")
|
|
|
|
|
|
def joinpdf():
|
|
"creates one pdf file from several others, following order from the cover"
|
|
from PyPDF2 import PdfFileReader,PdfFileWriter
|
|
if VERBOSE: print("Building table of contents...")
|
|
|
|
result = PdfFileWriter()
|
|
createCover()
|
|
inputfile = PdfFileReader(open(FOLDER+os.sep+'Cover.pdf','rb'))
|
|
result.addPage(inputfile.getPage(0))
|
|
count = 1
|
|
|
|
tocfile = createTOC()
|
|
parent = False
|
|
for page in tocfile:
|
|
page = page.strip()
|
|
if page:
|
|
if page[0] == "#":
|
|
continue
|
|
if page == "begin":
|
|
parent = True
|
|
continue
|
|
if page == "end":
|
|
parent = False
|
|
continue
|
|
if VERBOSE: print('Appending',page, "at position",count)
|
|
title = page.replace("_"," ")
|
|
pdffile = page + ".pdf"
|
|
if exists(pdffile,True):
|
|
inputfile = PdfFileReader(open(FOLDER + os.sep + pdffile,'rb'))
|
|
numpages = inputfile.getNumPages()
|
|
for i in range(numpages):
|
|
result.addPage(inputfile.getPage(i))
|
|
if parent == True:
|
|
parent = result.addBookmark(title,count)
|
|
elif parent == False:
|
|
result.addBookmark(title,count)
|
|
else:
|
|
result.addBookmark(title,count,parent)
|
|
count += numpages
|
|
else:
|
|
print("page",pdffile,"not found, aborting.")
|
|
sys.exit()
|
|
|
|
if VERBOSE: print("Writing...")
|
|
outputfile = open(FOLDER+os.sep+"freecad.pdf",'wb')
|
|
result.write(outputfile)
|
|
outputfile.close()
|
|
if VERBOSE:
|
|
print(' ')
|
|
print('Successfully created '+FOLDER+os.sep+'freecad.pdf')
|
|
|
|
|
|
def createTOC():
|
|
"populates the TOC"
|
|
tocfile = TOC.split("\n")
|
|
files = [f for f in os.listdir(FOLDER) if f.endswith(".pdf")]
|
|
wbpages = []
|
|
for wb in Workbenches:
|
|
wbpage += "begin"
|
|
if wb+"_Workbench" in files:
|
|
wbpages.append(wb+"_Workbench")
|
|
for f in files:
|
|
if f.lower().startswith(wb.lower()+"_"):
|
|
if (not f.lower().endswith("_workbench")) and (not f.lower().endswith("tutorial")):
|
|
wb.append(f)
|
|
if wb+"_tutorial" in files:
|
|
wbpages.append(wb+"_tutorial")
|
|
wbpages.append("end")
|
|
toc = []
|
|
for i in tocfile:
|
|
if i == "WorkbenchesList":
|
|
toc.extend(wbpages)
|
|
else:
|
|
toc.append(i)
|
|
return toc
|
|
|
|
|
|
def local(page,image=False):
|
|
"returns a local path for a given page/image"
|
|
if image:
|
|
return FOLDER + os.sep + page
|
|
else:
|
|
return FOLDER + os.sep + page + '.html'
|
|
|
|
|
|
def exists(page,image=False):
|
|
"checks if given page/image already exists"
|
|
path = local(page,image)
|
|
if os.path.exists(path): return True
|
|
return False
|
|
|
|
|
|
def makeStyleSheet():
|
|
"Creates a stylesheet for wkhtmltopdf"
|
|
outputfile = open(FOLDER+os.sep+"wkhtmltopdf.css",'wb')
|
|
outputfile.write("""
|
|
.printfooter {
|
|
display:none !important;
|
|
}
|
|
""")
|
|
outputfile.close()
|
|
|
|
|
|
def createCover():
|
|
"downloads and creates a cover page"
|
|
if VERBOSE: print("fetching " + COVER)
|
|
data = (urlopen(COVER).read())
|
|
path = FOLDER + os.sep + "Cover.svg"
|
|
fil = open(path,'wb')
|
|
fil.write(data)
|
|
fil.close()
|
|
os.system('inkscape --export-pdf='+FOLDER+os.sep+'Cover.pdf'+' '+FOLDER+os.sep+'Cover.svg')
|
|
|
|
|
|
if __name__ == "__main__":
|
|
crawl()
|