gitea.git - Git with a cup of tea! Painless self-hosted all-in-one software development service, including Git hosting, code review, team collaboration, package registry and CI/CD: https://github.com/go-gitea/gitea

	Commit message (Expand)	Author	Age	Files	Lines
*	Use templates for issue e-mail subject and body (#8329)	guillep2k	2019-11-07	4	-30/+211
*	Unifies commit list in repository commit table and wiki revision page (#7907)	Mario Lubenka	2019-11-01	1	-0/+12
*	Fix commit expand button to not go to commit link (#8745)	Lauris BH	2019-11-01	1	-14/+27
*	[assets] configurable URL for static resources (#7911)	Jakob Ackermann	2019-10-22	1	-0/+3
*	upgrade gopkg.in/editorconfig/editorconfig-core-go.v1 (#8501)	Colin Arnott	2019-10-15	1	-2/+6
*	fix template bug on mirror repository setting page (#8438)	Lunny Xiao	2019-10-09	1	-0/+2
*	Move mirror to a standalone package from models (#7486)	Lunny Xiao	2019-10-01	1	-0/+3
*	Make link last commit massages in repository home page and commit tables (#8006)	jaqra	2019-09-10	1	-7/+26
*	Move git diff codes from models to services/gitdiff (#7889)	Lunny Xiao	2019-09-05	1	-0/+2
*	Use gitea forked macaron (#7933)	Tamal Saha	2019-08-23	2	-4/+6
*	Display ui time with customize time location (#7792)	Lunny Xiao	2019-08-15	1	-5/+5
*	Convert files to utf-8 for indexing (#7814)	guillep2k	2019-08-15	1	-56/+0
*	remove unnecessary fmt on generate bindata (#7706)	Lunny Xiao	2019-08-01	1	-1/+0
*	Un-lambda base.FileSize (#7556)	Christian Muehlhaeuser	2019-07-22	1	-4/+2
*	Display original author and URL information when showing migrated issues/comm...	mrsdizzie	2019-07-08	1	-0/+11
*	Add golangci (#6418)	kolaente	2019-06-12	2	-3/+9
*	Use vfsgen instead of go-bindata (#7080)	Lunny Xiao	2019-06-03	3	-3/+42
*	refactor: append, build variable and type switch (#4940)	Bo-Yi Wu	2019-05-28	1	-7/+6
*	Show git-notes (#6984)	Vladimir Panteleev	2019-05-24	1	-0/+12
*	Show full name if DefaultShowFullName setting activated (#6710)	Wim	2019-05-08	1	-0/+3
*	Number of commits ahead/behind in branch overview (#6695)	Mario Lubenka	2019-05-05	1	-0/+7
*	add french specific rule for translating plural texts (#6846)	ngourdon	2019-05-04	1	-0/+6
*	Allow Recaptcha service url to be configured (#6820)	zeripath	2019-05-02	1	-0/+4
*	UI: Detect and restore encoding and BOM in content (#6727)	zeripath	2019-04-26	1	-6/+8
*	Better logging (#6038) (#6095)	zeripath	2019-04-02	1	-3/+3
*	Create Progressive Web App (#4730)	SohnyBohny	2018-11-27	2	-0/+21
*	Refactor heatmap to vue component (#5401)	Lauris BH	2018-11-27	1	-3/+0
*	Set heatmap color range configurable (#5165)	Antoine GIRARD	2018-10-24	1	-0/+3
*	Detect charset and convert non UTF-8 files for display (#4950)	Lauris BH	2018-09-29	1	-1/+24
*	Add push webhook support for mirrored repositories (#4127)	Lauris BH	2018-09-06	1	-0/+2
*	Upgrade images in .drone.yml to more recent versions (#4819)	techknowlogick	2018-08-29	1	-6/+6
*	Disable 'May Import Local Repository' when is disabled by setting (Issue #477...	EnricoFerro	2018-08-24	1	-0/+3
*	Fix custom templates being ignored (#4638)	Piotr Orzechowski	2018-08-08	1	-4/+2
*	Pull request review/approval and comment on code (#3748)	Lauris BH	2018-08-06	1	-0/+26
*	Swagger.v1.json template (#3572)	Piotr Orzechowski	2018-07-28	2	-5/+32
*	Add the ability to have built in themes in Gitea (#4198)	techknowlogick	2018-07-05	1	-0/+3
*	Show second line by using >= 1 instead of > 1 (#4251)	Jonas Franz	2018-06-15	1	-1/+1
*	Issue due date (#3794)	kolaente	2018-05-01	1	-0/+3
*	Symlink icons (#1416) (#3826)	Tris Forster	2018-05-01	1	-0/+1
*	Shows total tracked time in issue and milestone list (#3341)	Jonas Franz	2018-04-29	1	-2/+3
*	Rework special link parsing in the post-processing of markup (#3354)	Morgan Bazalgette	2018-02-27	1	-25/+17
*	Escape search query (#3486)	Jonas Franz	2018-02-11	1	-0/+7
*	Refactor struct's time to remove unnecessary memory usage (#3142)	Lunny Xiao	2017-12-11	1	-8/+9
*	Add reactions to issues/PR and comments (#2856)	Lauris BH	2017-12-04	1	-0/+16
*	Expandable commit bodies (#2980)	Sondre Nilsen	2017-11-30	1	-2/+27
*	Various wiki bug fixes (#2996)	Ethan Koenig	2017-11-28	1	-0/+2
*	Fix over-escaped characters (#2956)	Ethan Koenig	2017-11-22	1	-6/+4
*	Update go-ini dependency and remove semicolon hack in translations (#2913)	Lauris BH	2017-11-15	1	-4/+0
*	Fix localization texts that contain semicolon (#2900)	Lauris BH	2017-11-13	1	-0/+4
*	Fix issue link rendering in commit messages (#2897)	Ethan Koenig	2017-11-13	1	-19/+23

/* * Copyright 1999-2006 The Apache Software Foundation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /* $Id$ */ package org.apache.fop.cli; // java import java.io.File; import java.io.FileNotFoundException; import java.io.IOException; import java.util.Locale; import java.util.Vector; import javax.swing.UIManager; import org.apache.fop.Version; import org.apache.fop.apps.FOPException; import org.apache.fop.apps.FOUserAgent; import org.apache.fop.apps.FopFactory; import org.apache.fop.apps.MimeConstants; import org.apache.fop.pdf.PDFEncryptionManager; import org.apache.fop.pdf.PDFEncryptionParams; import org.apache.fop.render.awt.AWTRenderer; import org.apache.fop.render.Renderer; import org.apache.fop.render.pdf.PDFRenderer; import org.apache.fop.render.xml.XMLRenderer; import org.apache.fop.util.CommandLineLogger; // commons logging import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; // SAX import org.xml.sax.SAXException; /** * Options parses the commandline arguments */ public class CommandLineOptions { /** Used to indicate that only the result of the XSL transformation should be output */ public static final int RENDER_NONE = -1; /* These following constants are used to describe the input (either .FO, .XML/.XSL or * intermediate format) */ /** (input) not set */ public static final int NOT_SET = 0; /** input: fo file */ public static final int FO_INPUT = 1; /** input: xml+xsl file */ public static final int XSLT_INPUT = 2; /** input: Area Tree XML file */ public static final int AREATREE_INPUT = 3; /* show configuration information */ private Boolean showConfiguration = Boolean.FALSE; /* for area tree XML output, only down to block area level */ private Boolean suppressLowLevelAreas = Boolean.FALSE; /* user configuration file */ private File userConfigFile = null; /* input fo file */ private File fofile = null; /* xsltfile (xslt transformation as input) */ private File xsltfile = null; /* xml file (xslt transformation as input) */ private File xmlfile = null; /* area tree input file */ private File areatreefile = null; /* output file */ private File outfile = null; /* input mode */ private int inputmode = NOT_SET; /* output mode */ private String outputmode = null; private FopFactory factory = FopFactory.newInstance(); private FOUserAgent foUserAgent; private InputHandler inputHandler; private Log log; private Vector xsltParams = null; private String mimicRenderer = null; /** * Construct a command line option object. */ public CommandLineOptions() { LogFactory logFactory = LogFactory.getFactory(); // Enable the simple command line logging when no other logger is // defined. if (System.getProperty("org.apache.commons.logging.Log") == null) { logFactory.setAttribute("org.apache.commons.logging.Log", CommandLineLogger.class.getName()); setLogLevel("info"); } log = LogFactory.getLog("FOP"); } /** * Parse the command line arguments. * @param args the command line arguments. * @throws FOPException for general errors * @throws FileNotFoundException if an input file wasn't found * @throws IOException if the the configuration file could not be loaded */ public void parse(String[] args) throws FOPException, IOException { boolean optionsParsed = true; foUserAgent = factory.newFOUserAgent(); try { optionsParsed = parseOptions(args); if (optionsParsed) { if (showConfiguration == Boolean.TRUE) { dumpConfiguration(); } checkSettings(); createUserConfig(); if (factory.getUserConfig() != null) { foUserAgent.configure(factory.getUserConfig()); } addXSLTParameter("fop-output-format", getOutputFormat()); addXSLTParameter("fop-version", Version.getVersion()); } } catch (FOPException e) { printUsage(); throw e; } catch (java.io.FileNotFoundException e) { printUsage(); throw e; } inputHandler = createInputHandler(); if (MimeConstants.MIME_FOP_AWT_PREVIEW.equals(outputmode)) { //set the system look&feel for the preview dialog try { UIManager.setLookAndFeel( UIManager.getSystemLookAndFeelClassName()); } catch (Exception e) { System.err.println("Couldn't set system look & feel!"); } AWTRenderer renderer = new AWTRenderer(true); renderer.setRenderable(inputHandler); //set before user agent! renderer.setUserAgent(foUserAgent); foUserAgent.setRendererOverride(renderer); } else if (MimeConstants.MIME_FOP_AREA_TREE.equals(outputmode) && mimicRenderer != null) { // render from FO to Intermediate Format Renderer targetRenderer = foUserAgent.getRendererFactory().createRenderer( foUserAgent, mimicRenderer); XMLRenderer xmlRenderer = new XMLRenderer(); xmlRenderer.setUserAgent(foUserAgent); //Tell the XMLRenderer to mimic the target renderer xmlRenderer.mimicRenderer(targetRenderer); //Make sure the prepared XMLRenderer is used foUserAgent.setRendererOverride(xmlRenderer); } } /** * @return the InputHandler instance defined by the command-line options. */ public InputHandler getInputHandler() { return inputHandler; } /** * Get the logger. * @return the logger */ public Log getLogger() { return log; } private void addXSLTParameter(String name, String value) { if (xsltParams == null) { xsltParams = new Vector(); } xsltParams.addElement(name); xsltParams.addElement(value); } /** * parses the commandline arguments * @return true if parse was successful and processing can continue, false * if processing should stop * @exception FOPException if there was an error in the format of the options */ private boolean parseOptions(String[] args) throws FOPException { for (int i = 0; i < args.length; i++) { if (args[i].equals("-x") || args[i].equals("--dump-config")) { showConfiguration = Boolean.TRUE; } else if (args[i].equals("-c")) { i = i + parseConfigurationOption(args, i); } else if (args[i].equals("-l")) { i = i + parseLanguageOption(args, i); } else if (args[i].equals("-s")) { suppressLowLevelAreas = Boolean.TRUE; } else if (args[i].equals("-d")) { setLogOption("debug", "debug"); } else if (args[i].equals("-r")) { factory.setStrictValidation(false); } else if (args[i].equals("-dpi")) { i = i + parseResolution(args, i); } else if (args[i].equals("-q") || args[i].equals("--quiet")) { setLogOption("quiet", "error"); } else if (args[i].equals("-fo")) { i = i + parseFOInputOption(args, i); } else if (args[i].equals("-xsl")) { i = i + parseXSLInputOption(args, i); } else if (args[i].equals("-xml")) { i = i + parseXMLInputOption(args, i); } else if (args[i].equals("-atin")) { i = i + parseAreaTreeInputOption(args, i); } else if (args[i].equals("-awt")) { i = i + parseAWTOutputOption(args, i); } else if (args[i].equals("-pdf")) { i = i + parsePDFOutputOption(args, i, null); } else if (args[i].equals("-pdfa1b")) { i = i + parsePDFOutputOption(args, i, "PDF/A-1b"); } else if (args[i].equals("-mif")) { i = i + parseMIFOutputOption(args, i); } else if (args[i].equals("-rtf")) { i = i + parseRTFOutputOption(args, i); } else if (args[i].equals("-tiff")) { i = i + parseTIFFOutputOption(args, i); } else if (args[i].equals("-png")) { i = i + parsePNGOutputOption(args, i); } else if (args[i].equals("-print")) { i = i + parsePrintOutputOption(args, i); // show print help if (i + 1 < args.length) { if (args[i + 1].equals("help")) { printUsagePrintOutput(); return false; } } } else if (args[i].equals("-pcl")) { i = i + parsePCLOutputOption(args, i); } else if (args[i].equals("-ps")) { i = i + parsePostscriptOutputOption(args, i); } else if (args[i].equals("-txt")) { i = i + parseTextOutputOption(args, i); } else if (args[i].equals("-svg")) { i = i + parseSVGOutputOption(args, i); } else if (args[i].equals("-afp")) { i = i + parseAFPOutputOption(args, i); } else if (args[i].equals("-foout")) { i = i + parseFOOutputOption(args, i); } else if (args[i].equals("-out")) { i = i + parseCustomOutputOption(args, i); } else if (args[i].charAt(0) != '-') { i = i + parseUnknownOption(args, i); } else if (args[i].equals("-at")) { i = i + parseAreaTreeOption(args, i); } else if (args[i].equals("-v")) { System.out.println("FOP Version " + Version.getVersion()); } else if (args[i].equals("-param")) { if (i + 2 < args.length) { String name = args[++i]; String expression = args[++i]; addXSLTParameter(name, expression); } else { throw new FOPException("invalid param usage: use -param <name> <value>"); } } else if (args[i].equals("-o")) { i = i + parsePDFOwnerPassword(args, i); } else if (args[i].equals("-u")) { i = i + parsePDFUserPassword(args, i); } else if (args[i].equals("-noprint")) { getPDFEncryptionParams().setAllowPrint(false); } else if (args[i].equals("-nocopy")) { getPDFEncryptionParams().setAllowCopyContent(false); } else if (args[i].equals("-noedit")) { getPDFEncryptionParams().setAllowEditContent(false); } else if (args[i].equals("-noannotations")) { getPDFEncryptionParams().setAllowEditAnnotations(false); } else { printUsage(); return false; } } return true; } // end parseOptions private int parseConfigurationOption(String[] args, int i) throws FOPException { if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("if you use '-c', you must specify " + "the name of the configuration file"); } else { userConfigFile = new File(args[i + 1]); return 1; } } private int parseLanguageOption(String[] args, int i) throws FOPException { if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("if you use '-l', you must specify a language"); } else { Locale.setDefault(new Locale(args[i + 1], "")); return 1; } } private int parseResolution(String[] args, int i) throws FOPException { if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException( "if you use '-dpi', you must specify a resolution (dots per inch)"); } else { foUserAgent.setTargetResolution(Integer.parseInt(args[i + 1])); return 1; } } private int parseFOInputOption(String[] args, int i) throws FOPException { inputmode = FO_INPUT; if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("you must specify the fo file for the '-fo' option"); } else { fofile = new File(args[i + 1]); return 1; } } private int parseXSLInputOption(String[] args, int i) throws FOPException { inputmode = XSLT_INPUT; if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("you must specify the stylesheet " + "file for the '-xsl' option"); } else { xsltfile = new File(args[i + 1]); return 1; } } private int parseXMLInputOption(String[] args, int i) throws FOPException { inputmode = XSLT_INPUT; if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("you must specify the input file " + "for the '-xml' option"); } else { xmlfile = new File(args[i + 1]); return 1; } } private int parseAWTOutputOption(String[] args, int i) throws FOPException { setOutputMode(MimeConstants.MIME_FOP_AWT_PREVIEW); return 0; } private int parsePDFOutputOption(String[] args, int i, String pdfAMode) throws FOPException { setOutputMode(MimeConstants.MIME_PDF); if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("you must specify the PDF output file"); } else { outfile = new File(args[i + 1]); if (pdfAMode != null) { foUserAgent.getRendererOptions().put("pdf-a-mode", pdfAMode); } return 1; } } private int parseMIFOutputOption(String[] args, int i) throws FOPException { setOutputMode(MimeConstants.MIME_MIF); if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("you must specify the MIF output file"); } else { outfile = new File(args[i + 1]); return 1; } } private int parseRTFOutputOption(String[] args, int i) throws FOPException { setOutputMode(MimeConstants.MIME_RTF); if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("you must specify the RTF output file"); } else { outfile = new File(args[i + 1]); return 1; } } private int parseTIFFOutputOption(String[] args, int i) throws FOPException { setOutputMode(MimeConstants.MIME_TIFF); if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("you must specify the TIFF output file"); } else { outfile = new File(args[i + 1]); return 1; } } private int parsePNGOutputOption(String[] args, int i) throws FOPException { setOutputMode(MimeConstants.MIME_PNG); if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("you must specify the PNG output file"); } else { outfile = new File(args[i + 1]); return 1; } } private int parsePrintOutputOption(String[] args, int i) throws FOPException { setOutputMode(MimeConstants.MIME_FOP_PRINT); return 0; } private int parsePCLOutputOption(String[] args, int i) throws FOPException { setOutputMode(MimeConstants.MIME_PCL); if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("you must specify the PDF output file"); } else { outfile = new File(args[i + 1]); return 1; } } private int parsePostscriptOutputOption(String[] args, int i) throws FOPException { setOutputMode(MimeConstants.MIME_POSTSCRIPT); if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("you must specify the PostScript output file"); } else { outfile = new File(args[i + 1]); return 1; } } private int parseTextOutputOption(String[] args, int i) throws FOPException { setOutputMode(MimeConstants.MIME_PLAIN_TEXT); if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("you must specify the text output file"); } else { outfile = new File(args[i + 1]); return 1; } } private int parseSVGOutputOption(String[] args, int i) throws FOPException { setOutputMode(MimeConstants.MIME_SVG); if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("you must specify the SVG output file"); } else { outfile = new File(args[i + 1]); return 1; } } private int parseAFPOutputOption(String[] args, int i) throws FOPException { setOutputMode(MimeConstants.MIME_AFP); if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("you must specify the AFP output file"); } else { outfile = new File(args[i + 1]); return 1; } } private int parseFOOutputOption(String[] args, int i) throws FOPException { setOutputMode(MimeConstants.MIME_XSL_FO); if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("you must specify the FO output file"); } else { outfile = new File(args[i + 1]); return 1; } } private int parseCustomOutputOption(String[] args, int i) throws FOPException { String mime = null; if ((i + 1 < args.length) || (args[i + 1].charAt(0) != '-')) { mime = args[i + 1]; if ("list".equals(mime)) { String[] mimes = foUserAgent.getRendererFactory().listSupportedMimeTypes(); System.out.println("Supported MIME types:"); for (int j = 0; j < mimes.length; j++) { System.out.println(" " + mimes[j]); } System.exit(0); } } if ((i + 2 >= args.length) || (args[i + 1].charAt(0) == '-') || (args[i + 2].charAt(0) == '-')) { throw new FOPException("you must specify the output format and the output file"); } else { setOutputMode(mime); outfile = new File(args[i + 2]); return 2; } } private int parseUnknownOption(String[] args, int i) throws FOPException { if (inputmode == NOT_SET) { inputmode = FO_INPUT; fofile = new File(args[i]); } else if (outputmode == null) { outputmode = MimeConstants.MIME_PDF; outfile = new File(args[i]); } else { throw new FOPException("Don't know what to do with " + args[i]); } return 0; } private int parseAreaTreeOption(String[] args, int i) throws FOPException { setOutputMode(MimeConstants.MIME_FOP_AREA_TREE); if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("you must specify the area-tree output file"); } else if ((i + 2 == args.length) || (args[i + 2].charAt(0) == '-')) { // only output file is specified outfile = new File(args[i + 1]); return 1; } else { // mimic format and output file have been specified mimicRenderer = args[i + 1]; outfile = new File(args[i + 2]); return 2; } } private int parseAreaTreeInputOption(String[] args, int i) throws FOPException { inputmode = AREATREE_INPUT; if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { throw new FOPException("you must specify the Area Tree file for the '-atin' option"); } else { areatreefile = new File(args[i + 1]); return 1; } } private PDFEncryptionParams getPDFEncryptionParams() throws FOPException { PDFEncryptionParams params = (PDFEncryptionParams)foUserAgent.getRendererOptions().get( PDFRenderer.ENCRYPTION_PARAMS); if (params == null) { if (!PDFEncryptionManager.checkAvailableAlgorithms()) { throw new FOPException("PDF encryption requested but it is not available." + " Please make sure MD5 and RC4 algorithms are available."); } params = new PDFEncryptionParams(); foUserAgent.getRendererOptions().put(PDFRenderer.ENCRYPTION_PARAMS, params); } return params; } private int parsePDFOwnerPassword(String[] args, int i) throws FOPException { if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { getPDFEncryptionParams().setOwnerPassword(""); return 0; } else { getPDFEncryptionParams().setOwnerPassword(args[i + 1]); return 1; } } private int parsePDFUserPassword(String[] args, int i) throws FOPException { if ((i + 1 == args.length) || (args[i + 1].charAt(0) == '-')) { getPDFEncryptionParams().setUserPassword(""); return 0; } else { getPDFEncryptionParams().setUserPassword(args[i + 1]); return 1; } } private void setOutputMode(String mime) throws FOPException { if (outputmode == null) { outputmode = mime; } else { throw new FOPException("you can only set one output method"); } } private void setLogOption (String option, String level) { if (log instanceof CommandLineLogger || System.getProperty("org.apache.commons.logging.Log") == null) { setLogLevel(level); } else if (log != null) { log.warn("The option " + option + " can only be used"); log.warn("with FOP's command line logger,"); log.warn("which is the default on the command line."); log.warn("Configure other loggers using Java system properties."); } } private void setLogLevel(String level) { // Set the level for future loggers. LogFactory.getFactory().setAttribute("level", level); if (log instanceof CommandLineLogger) { // Set the level for the logger created already. ((CommandLineLogger) log).setLogLevel(level); } } /** * checks whether all necessary information has been given in a consistent way */ private void checkSettings() throws FOPException, FileNotFoundException { if (inputmode == NOT_SET) { throw new FOPException("No input file specified"); } if (outputmode == null) { throw new FOPException("No output file specified"); } if ((outputmode.equals(MimeConstants.MIME_FOP_AWT_PREVIEW) || outputmode.equals(MimeConstants.MIME_FOP_PRINT)) && outfile != null) { throw new FOPException("Output file may not be specified " + "for AWT or PRINT output"); } if (inputmode == XSLT_INPUT) { // check whether xml *and* xslt file have been set if (xmlfile == null) { throw new FOPException("XML file must be specified for the transform mode"); } if (xsltfile == null) { throw new FOPException("XSLT file must be specified for the transform mode"); } // warning if fofile has been set in xslt mode if (fofile != null) { log.warn("Can't use fo file with transform mode! Ignoring.\n" + "Your input is " + "\n xmlfile: " + xmlfile.getAbsolutePath() + "\nxsltfile: " + xsltfile.getAbsolutePath() + "\n fofile: " + fofile.getAbsolutePath()); } if (!xmlfile.exists()) { throw new FileNotFoundException("Error: xml file " + xmlfile.getAbsolutePath() + " not found "); } if (!xsltfile.exists()) { throw new FileNotFoundException("Error: xsl file " + xsltfile.getAbsolutePath() + " not found "); } } else if (inputmode == FO_INPUT) { if (outputmode.equals(MimeConstants.MIME_XSL_FO)) { throw new FOPException( "FO output mode is only available if you use -xml and -xsl"); } if (xmlfile != null || xsltfile != null) { log.warn("fo input mode, but xmlfile or xslt file are set:"); log.error("xml file: " + xmlfile.toString()); log.error("xslt file: " + xsltfile.toString()); } if (!fofile.exists()) { throw new FileNotFoundException("Error: fo file " + fofile.getAbsolutePath() + " not found "); } } else if (inputmode == AREATREE_INPUT) { if (outputmode.equals(MimeConstants.MIME_XSL_FO)) { throw new FOPException( "FO output mode is only available if you use -xml and -xsl"); } else if (outputmode.equals(MimeConstants.MIME_FOP_AREA_TREE)) { throw new FOPException( "Area Tree Output is not available if Area Tree is used as input!"); } if (xmlfile != null || xsltfile != null) { log.warn("area tree input mode, but xmlfile or xslt file are set:"); log.error("xml file: " + xmlfile.toString()); log.error("xslt file: " + xsltfile.toString()); } if (!areatreefile.exists()) { throw new FileNotFoundException("Error: area tree file " + areatreefile.getAbsolutePath() + " not found "); } } } // end checkSettings /** * Create the user configuration. * @throws FOPException if creating the user configuration fails * @throws IOException */ private void createUserConfig() throws FOPException, IOException { if (userConfigFile == null) { return; } try { factory.setUserConfig(userConfigFile); } catch (SAXException e) { throw new FOPException(e); } } /** * @return the chosen output format (MIME type) * @throws FOPException for invalid output formats */ protected String getOutputFormat() throws FOPException { if (outputmode == null) { throw new FOPException("Renderer has not been set!"); } if (outputmode.equals(MimeConstants.MIME_FOP_AREA_TREE)) { foUserAgent.getRendererOptions().put("fineDetail", isCoarseAreaXml()); } return outputmode; } /** * Create an InputHandler object based on command-line parameters * @return a new InputHandler instance * @throws IllegalArgumentException if invalid/missing parameters */ private InputHandler createInputHandler() throws IllegalArgumentException { switch (inputmode) { case FO_INPUT: return new InputHandler(fofile); case AREATREE_INPUT: return new AreaTreeInputHandler(areatreefile); case XSLT_INPUT: return new InputHandler(xmlfile, xsltfile, xsltParams); default: throw new IllegalArgumentException("Error creating InputHandler object."); } } /** * Get the FOUserAgent for this Command-Line run * @return FOUserAgent instance */ protected FOUserAgent getFOUserAgent() { return foUserAgent; } /** * Returns the XSL-FO file if set. * @return the XSL-FO file, null if not set */ public File getFOFile() { return fofile; } /** * Returns the input XML file if set. * @return the input XML file, null if not set */ public File getXMLFile() { return xmlfile; } /** * Returns the stylesheet to be used for transformation to XSL-FO. * @return stylesheet */ public File getXSLFile() { return xsltfile; } /** * Returns the output file * @return the output file */ public File getOutputFile() { return outfile; } /** * Returns the user configuration file to be used. * @return the userconfig.xml file */ public File getUserConfigFile() { return userConfigFile; } /** * Indicates whether the XML renderer should generate coarse area XML * @return true if coarse area XML is desired */ public Boolean isCoarseAreaXml() { return suppressLowLevelAreas; } /** * Returns the input file. * @return either the fofile or the xmlfile */ public File getInputFile() { switch (inputmode) { case FO_INPUT: return fofile; case XSLT_INPUT: return xmlfile; default: return fofile; } } /** * shows the commandline syntax including a summary of all available options and some examples */ public static void printUsage() { System.err.println( "\nUSAGE\nFop [options] [-fo|-xml] infile [-xsl file] " + "[-awt|-pdf|-mif|-rtf|-tiff|-png|-pcl|-ps|-txt|-at [mime]|-print] <outfile>\n" + " [OPTIONS] \n" + " -d debug mode \n" + " -x dump configuration settings \n" + " -q quiet mode \n" + " -c cfg.xml use additional configuration file cfg.xml\n" + " -l lang the language to use for user information \n" + " -r relaxed/less strict validation (where available)\n" + " -dpi xxx target resolution in dots per inch (dpi) where xxx is a number\n" + " -s for area tree XML, down to block areas only\n" + " -v to show FOP version being used\n\n" + " -o [password] PDF file will be encrypted with option owner password\n" + " -u [password] PDF file will be encrypted with option user password\n" + " -noprint PDF file will be encrypted without printing permission\n" + " -nocopy PDF file will be encrypted without copy content permission\n" + " -noedit PDF file will be encrypted without edit content permission\n" + " -noannotations PDF file will be encrypted without edit annotation permission\n\n" + " [INPUT] \n" + " infile xsl:fo input file (the same as the next) \n" + " -fo infile xsl:fo input file \n" + " -xml infile xml input file, must be used together with -xsl \n" + " -atin infile area tree input file \n" + " -xsl stylesheet xslt stylesheet \n \n" + " -param name value <value> to use for parameter <name> in xslt stylesheet\n" + " (repeat '-param name value' for each parameter)\n \n" + " [OUTPUT] \n" + " outfile input will be rendered as PDF into outfile\n" + " -pdf outfile input will be rendered as PDF (outfile req'd)\n" + " -pdfa1b outfile input will be rendered as PDF/A-1b compliant PDF\n" + " (outfile req'd)\n" + " -awt input will be displayed on screen \n" + " -mif outfile input will be rendered as MIF (FrameMaker) (outfile req'd)\n" + " -rtf outfile input will be rendered as RTF (outfile req'd)\n" + " -tiff outfile input will be rendered as TIFF (outfile req'd)\n" + " -png outfile input will be rendered as PNG (outfile req'd)\n" + " -pcl outfile input will be rendered as PCL (outfile req'd) \n" + " -ps outfile input will be rendered as PostScript (outfile req'd) \n" + " -txt outfile input will be rendered as plain text (outfile req'd) \n" + " -svg outfile input will be rendered as an SVG slides file (outfile req'd) \n" + " -at [mime] out representation of area tree as XML (outfile req'd) \n" + " specify optional mime output to allow AT to be converted\n" + " to final format later\n" + " -print input file will be rendered and sent to the printer \n" + " see options with \"-print help\" \n" + " -out mime outfile input will be rendered using the given MIME type\n" + " (outfile req'd) Example: \"-out application/pdf D:\\out.pdf\"\n" + " (Tip: \"-out list\" prints the list of supported MIME types)\n" + "\n" + " -foout outfile input will only be XSL transformed. The intermediate \n" + " XSL-FO file is saved and no rendering is performed. \n" + " (Only available if you use -xml and -xsl parameters)\n\n" + "\n" + " [Examples]\n" + " Fop foo.fo foo.pdf \n" + " Fop -fo foo.fo -pdf foo.pdf (does the same as the previous line)\n" + " Fop -xml foo.xml -xsl foo.xsl -pdf foo.pdf\n" + " Fop -xml foo.xml -xsl foo.xsl -foout foo.fo\n" + " Fop foo.fo -mif foo.mif\n" + " Fop foo.fo -rtf foo.rtf\n" + " Fop foo.fo -print or Fop -print foo.fo \n" + " Fop foo.fo -awt \n"); } /** * shows the options for print output */ private void printUsagePrintOutput() { System.err.println("USAGE: -print [-Dstart=i] [-Dend=i] [-Dcopies=i] [-Deven=true|false] " + " org.apache.fop.apps.Fop (..) -print \n" + "Example:\n" + "java -Dstart=1 -Dend=2 org.apache.Fop.apps.Fop infile.fo -print "); } /** * Outputs all commandline settings */ private void dumpConfiguration() { log.info("Input mode: "); switch (inputmode) { case NOT_SET: log.info("not set"); break; case FO_INPUT: log.info("FO "); log.info("fo input file: " + fofile.toString()); break; case XSLT_INPUT: log.info("xslt transformation"); log.info("xml input file: " + xmlfile.toString()); log.info("xslt stylesheet: " + xsltfile.toString()); break; default: log.info("unknown input type"); } log.info("Output mode: "); if (outputmode == null) { log.info("not set"); } else if (MimeConstants.MIME_FOP_AWT_PREVIEW.equals(outputmode)) { log.info("awt on screen"); if (outfile != null) { log.error("awt mode, but outfile is set:"); log.info("out file: " + outfile.toString()); } } else if (MimeConstants.MIME_FOP_PRINT.equals(outputmode)) { log.info("print directly"); if (outfile != null) { log.error("print mode, but outfile is set:"); log.error("out file: " + outfile.toString()); } } else if (MimeConstants.MIME_FOP_AREA_TREE.equals(outputmode)) { log.info("area tree"); if (mimicRenderer != null) { log.info("mimic renderer: " + mimicRenderer); } log.info("output file: " + outfile.toString()); } else { log.info(outputmode); log.info("output file: " + outfile.toString()); } log.info("OPTIONS"); if (userConfigFile != null) { log.info("user configuration file: " + userConfigFile.toString()); } else { log.info("no user configuration file is used [default]"); } } }