nokogiri-backport 1.11.0

data/ext/java/nokogiri/XmlSaxParserContext.java

@@ -0,0 +1,374 @@
+/**
+ * (The MIT License)
+ *
+ * Copyright (c) 2008 - 2011:
+ *
+ * * {Aaron Patterson}[http://tenderlovemaking.com]
+ * * {Mike Dalessio}[http://mike.daless.io]
+ * * {Charles Nutter}[http://blog.headius.com]
+ * * {Sergio Arbeo}[http://www.serabe.com]
+ * * {Patrick Mahoney}[http://polycrystal.org]
+ * * {Yoko Harada}[http://yokolet.blogspot.com]
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * 'Software'), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package nokogiri;
+
+import static org.jruby.runtime.Helpers.invoke;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import org.apache.xerces.parsers.AbstractSAXParser;
+import org.jruby.Ruby;
+import org.jruby.RubyClass;
+import org.jruby.RubyFixnum;
+import org.jruby.RubyModule;
+import org.jruby.RubyObjectAdapter;
+import org.jruby.anno.JRubyClass;
+import org.jruby.anno.JRubyMethod;
+import org.jruby.exceptions.RaiseException;
+import org.jruby.javasupport.JavaEmbedUtils;
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.builtin.IRubyObject;
+import org.xml.sax.ContentHandler;
+import org.xml.sax.ErrorHandler;
+import org.xml.sax.SAXException;
+import org.xml.sax.SAXNotRecognizedException;
+import org.xml.sax.SAXNotSupportedException;
+import org.xml.sax.SAXParseException;
+
+import nokogiri.internals.NokogiriHandler;
+import nokogiri.internals.NokogiriHelpers;
+import nokogiri.internals.ParserContext;
+import nokogiri.internals.XmlSaxParser;
+
+/**
+ * Base class for the SAX parsers.
+ *
+ * @author Patrick Mahoney <pat@polycrystal.org>
+ * @author Yoko Harada <yokolet@gmail.com>
+ */
+@JRubyClass(name="Nokogiri::XML::SAX::ParserContext")
+public class XmlSaxParserContext extends ParserContext {
+
+    protected static final String FEATURE_NAMESPACES =
+        "http://xml.org/sax/features/namespaces";
+    protected static final String FEATURE_NAMESPACE_PREFIXES =
+        "http://xml.org/sax/features/namespace-prefixes";
+    protected static final String FEATURE_LOAD_EXTERNAL_DTD =
+        "http://apache.org/xml/features/nonvalidating/load-external-dtd";
+    protected static final String FEATURE_CONTINUE_AFTER_FATAL_ERROR =
+        "http://apache.org/xml/features/continue-after-fatal-error";
+
+    protected AbstractSAXParser parser;
+
+    protected NokogiriHandler handler;
+    private boolean replaceEntities = true;
+    private boolean recovery = false;
+
+    public XmlSaxParserContext(final Ruby ruby, RubyClass rubyClass) {
+        super(ruby, rubyClass);
+    }
+        
+    protected void initialize(Ruby runtime) {
+        try {
+            parser = createParser();
+        }
+        catch (SAXException se) {
+            // Unexpected failure in XML subsystem
+            RaiseException ex = runtime.newRuntimeError(se.toString());
+            ex.initCause(se);
+            throw ex;
+        }
+    }
+
+    /**
+     * Create and return a copy of this object.
+     *
+     * @return a clone of this object
+     */
+    @Override
+    public Object clone() throws CloneNotSupportedException {
+        return super.clone();
+    }
+
+    protected AbstractSAXParser createParser() throws SAXException {
+        XmlSaxParser parser = new XmlSaxParser();
+        parser.setFeature(FEATURE_NAMESPACE_PREFIXES, true);
+        parser.setFeature(FEATURE_LOAD_EXTERNAL_DTD, false);
+        return parser;
+    }
+
+    /**
+     * Create a new parser context that will parse the string
+     * <code>data</code>.
+     */
+    @JRubyMethod(name="memory", meta=true)
+    public static IRubyObject parse_memory(ThreadContext context,
+                                           IRubyObject klazz,
+                                           IRubyObject data) {
+        final Ruby runtime = context.runtime;
+        XmlSaxParserContext ctx = newInstance(runtime, (RubyClass) klazz);
+        ctx.initialize(runtime);
+        ctx.setStringInputSource(context, data, runtime.getNil());
+        return ctx;
+    }
+
+    /**
+     * Create a new parser context that will read from the file
+     * <code>data</code> and parse.
+     */
+    @JRubyMethod(name="file", meta=true)
+    public static IRubyObject parse_file(ThreadContext context,
+                                         IRubyObject klazz,
+                                         IRubyObject data) {
+        final Ruby runtime = context.runtime;
+        XmlSaxParserContext ctx = newInstance(runtime, (RubyClass) klazz);
+        ctx.initialize(context.getRuntime());
+        ctx.setInputSourceFile(context, data);
+        return ctx;
+    }
+
+    /**
+     * Create a new parser context that will read from the IO or
+     * StringIO <code>data</code> and parse.
+     *
+     * TODO: Currently ignores encoding <code>enc</code>.
+     */
+    @JRubyMethod(name="io", meta=true)
+    public static IRubyObject parse_io(ThreadContext context,
+                                       IRubyObject klazz,
+                                       IRubyObject data,
+                                       IRubyObject enc) {
+        //int encoding = (int)enc.convertToInteger().getLongValue();
+        final Ruby runtime = context.runtime;
+        XmlSaxParserContext ctx = newInstance(runtime, (RubyClass) klazz);
+        ctx.initialize(runtime);
+        ctx.setIOInputSource(context, data, runtime.getNil());
+        return ctx;
+    }
+
+    /**
+     * Create a new parser context that will read from a raw input stream.
+     * Meant to be run in a separate thread by XmlSaxPushParser.
+     */
+    static XmlSaxParserContext parse_stream(final Ruby runtime, RubyClass klazz, InputStream stream) {
+        XmlSaxParserContext ctx = newInstance(runtime, klazz);
+        ctx.initialize(runtime);
+        ctx.setInputSource(stream);
+        return ctx;
+    }
+
+    private static XmlSaxParserContext newInstance(final Ruby runtime, final RubyClass klazz) {
+        return (XmlSaxParserContext) NokogiriService.XML_SAXPARSER_CONTEXT_ALLOCATOR.allocate(runtime, klazz);
+    }
+
+    /**
+     * Set a property of the underlying parser.
+     */
+    protected void setProperty(String key, Object val)
+        throws SAXNotRecognizedException, SAXNotSupportedException {
+        parser.setProperty(key, val);
+    }
+
+    protected void setContentHandler(ContentHandler handler) {
+        parser.setContentHandler(handler);
+    }
+
+    protected void setErrorHandler(ErrorHandler handler) {
+        parser.setErrorHandler(handler);
+    }
+
+    public final NokogiriHandler getNokogiriHandler() { return handler; }
+
+    /**
+     * Perform any initialization prior to parsing with the handler
+     * <code>handlerRuby</code>. Convenience hook for subclasses.
+     */
+    protected void preParse(Ruby runtime, IRubyObject handlerRuby, NokogiriHandler handler) {
+        ((XmlSaxParser) parser).setXmlDeclHandler(handler);
+        if (recovery) {
+            try {
+                parser.setFeature(FEATURE_CONTINUE_AFTER_FATAL_ERROR, true);
+            }
+            catch (Exception e) {
+                // Unexpected failure in XML subsystem
+                throw runtime.newRuntimeError(e.getMessage());
+            }
+        }
+    }
+
+    protected void postParse(Ruby runtime, IRubyObject handlerRuby, NokogiriHandler handler) {
+        // noop
+    }
+
+    protected void do_parse() throws SAXException, IOException {
+        parser.parse(getInputSource());
+    }
+
+    @JRubyMethod
+    public IRubyObject parse_with(ThreadContext context, IRubyObject handlerRuby) {
+        final Ruby runtime = context.getRuntime();
+
+        if(!invoke(context, handlerRuby, "respond_to?", runtime.newSymbol("document")).isTrue()) {
+            throw runtime.newArgumentError("argument must respond_to document");
+        }
+
+        NokogiriHandler handler = this.handler = new NokogiriHandler(runtime, handlerRuby);
+        preParse(runtime, handlerRuby, handler);
+
+        setContentHandler(handler);
+        setErrorHandler(handler);
+
+        try{
+            setProperty("http://xml.org/sax/properties/lexical-handler", handler);
+        }
+        catch (Exception ex) {
+            throw runtime.newRuntimeError("Problem while creating XML SAX Parser: " + ex.toString());
+        }
+
+        try{
+            try {
+                do_parse();
+            }
+            catch (SAXParseException ex) {
+                // A bad document (<foo><bar></foo>) should call the
+                // error handler instead of raising a SAX exception.
+
+                // However, an EMPTY document should raise a RuntimeError.
+                // This is a bit kludgy, but AFAIK SAX doesn't distinguish
+                // between empty and bad whereas Nokogiri does.
+                String message = ex.getMessage();
+                if (message != null && message.contains("Premature end of file.") && stringDataSize < 1) {
+                    throw runtime.newRuntimeError("couldn't parse document: " + message);
+                }
+                handler.error(ex);
+            }
+        }
+        catch (SAXException ex) {
+            // Unexpected failure in XML subsystem
+            throw runtime.newRuntimeError(ex.getMessage());
+        }
+        catch (IOException ex) {
+            throw runtime.newIOErrorFromException(ex);
+        }
+
+        postParse(runtime, handlerRuby, handler);
+
+        //maybeTrimLeadingAndTrailingWhitespace(context, handlerRuby);
+
+        return runtime.getNil();
+    }
+
+    /**
+     * Can take a boolean assignment.
+     *
+     * @param context
+     * @param value
+     * @return
+     */
+    @JRubyMethod(name = "replace_entities=")
+    public IRubyObject set_replace_entities(ThreadContext context, IRubyObject value) {
+        replaceEntities = value.isTrue();
+        return this;
+    }
+
+    @JRubyMethod(name="replace_entities")
+    public IRubyObject get_replace_entities(ThreadContext context) {
+        return context.runtime.newBoolean(replaceEntities);
+    }
+
+    /**
+     * Can take a boolean assignment.
+     *
+     * @param context
+     * @param value
+     * @return
+     */
+    @JRubyMethod(name = "recovery=")
+    public IRubyObject set_recovery(ThreadContext context, IRubyObject value) {
+        recovery = value.isTrue();
+        return this;
+    }
+
+    @JRubyMethod(name="recovery")
+    public IRubyObject get_recovery(ThreadContext context) {
+        return context.runtime.newBoolean(recovery);
+    }
+
+    /**
+     * If the handler's document is a FragmentHandler, attempt to trim
+     * leading and trailing whitespace.
+     *
+     * This is a bit hackish and depends heavily on the internals of
+     * FragmentHandler.
+     */
+    protected void maybeTrimLeadingAndTrailingWhitespace(ThreadContext context, IRubyObject parser) {
+        RubyObjectAdapter adapter = JavaEmbedUtils.newObjectAdapter();
+        RubyModule mod = context.getRuntime().getClassFromPath("Nokogiri::XML::FragmentHandler");
+
+        IRubyObject handler = adapter.getInstanceVariable(parser, "@document");
+        if (handler == null || handler.isNil() || !adapter.isKindOf(handler, mod))
+            return;
+        IRubyObject stack = adapter.getInstanceVariable(handler, "@stack");
+        if (stack == null || stack.isNil())
+            return;
+        // doc is finally a DocumentFragment whose nodes we can check
+        IRubyObject doc = adapter.callMethod(stack, "first");
+        if (doc == null || doc.isNil())
+            return;
+
+        IRubyObject children;
+
+        for (;;) {
+            children = adapter.callMethod(doc, "children");
+            IRubyObject first = adapter.callMethod(children, "first");
+            if (NokogiriHelpers.isBlank(first)) adapter.callMethod(first, "unlink");
+            else break;
+        }
+
+        for (;;) {
+            children = adapter.callMethod(doc, "children");
+            IRubyObject last = adapter.callMethod(children, "last");
+            if (NokogiriHelpers.isBlank(last)) adapter.callMethod(last, "unlink");
+            else break;
+        }
+
+        // While we have a document, normalize it.
+        ((XmlNode) doc).normalize();
+    }
+
+    @JRubyMethod(name="column")
+    public IRubyObject column(ThreadContext context) {
+        final Integer number = handler.getColumn();
+        if (number == null) return context.getRuntime().getNil();
+        return RubyFixnum.newFixnum(context.getRuntime(), number.longValue());
+    }
+
+    @JRubyMethod(name="line")
+    public IRubyObject line(ThreadContext context) {
+        final Integer number = handler.getLine();
+        if (number == null) return context.getRuntime().getNil();
+        return RubyFixnum.newFixnum(context.getRuntime(), number.longValue());
+    }
+
+}

data/ext/java/nokogiri/XmlSaxPushParser.java

@@ -0,0 +1,286 @@
+/**
+ * (The MIT License)
+ *
+ * Copyright (c) 2008 - 2012:
+ *
+ * * {Aaron Patterson}[http://tenderlovemaking.com]
+ * * {Mike Dalessio}[http://mike.daless.io]
+ * * {Charles Nutter}[http://blog.headius.com]
+ * * {Sergio Arbeo}[http://www.serabe.com]
+ * * {Patrick Mahoney}[http://polycrystal.org]
+ * * {Yoko Harada}[http://yokolet.blogspot.com]
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * 'Software'), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package nokogiri;
+
+import static nokogiri.internals.NokogiriHelpers.getNokogiriClass;
+import static org.jruby.runtime.Helpers.invoke;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.Future;
+import java.util.concurrent.FutureTask;
+import java.util.concurrent.ThreadFactory;
+
+import org.jruby.Ruby;
+import org.jruby.RubyClass;
+import org.jruby.RubyObject;
+import org.jruby.anno.JRubyClass;
+import org.jruby.anno.JRubyMethod;
+import org.jruby.exceptions.RaiseException;
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.builtin.IRubyObject;
+
+import nokogiri.internals.ClosedStreamException;
+import nokogiri.internals.NokogiriBlockingQueueInputStream;
+import nokogiri.internals.NokogiriHandler;
+import nokogiri.internals.NokogiriHelpers;
+import nokogiri.internals.ParserContext;
+
+/**
+ * Class for Nokogiri::XML::SAX::PushParser
+ *
+ * @author Patrick Mahoney <pat@polycrystal.org>
+ * @author Yoko Harada <yokolet@gmail.com>
+ */
+@JRubyClass(name="Nokogiri::XML::SAX::PushParser")
+public class XmlSaxPushParser extends RubyObject {
+    ParserContext.Options options;
+    IRubyObject saxParser;
+
+    NokogiriBlockingQueueInputStream stream;
+
+    private ParserTask parserTask = null;
+    private FutureTask<XmlSaxParserContext> futureTask = null;
+    private ExecutorService executor = null;
+    RaiseException ex = null;
+
+    public XmlSaxPushParser(Ruby ruby, RubyClass rubyClass) {
+        super(ruby, rubyClass);
+    }
+
+    @Override
+    public void finalize() {
+        try {
+            terminateImpl();
+        }
+        catch (Exception e) { /* ignored */ }
+    }
+
+    @JRubyMethod
+    public IRubyObject initialize_native(final ThreadContext context, IRubyObject saxParser, IRubyObject fileName) {
+        options = new ParserContext.Options(0);
+        this.saxParser = saxParser;
+        return this;
+    }
+
+    private transient IRubyObject parse_options;
+
+    private IRubyObject parse_options(final ThreadContext context) {
+        if (parse_options == null) {
+            parse_options = invoke(context, context.runtime.getClassFromPath("Nokogiri::XML::ParseOptions"), "new");
+        }
+        return parse_options;
+    }
+
+    @JRubyMethod(name="options")
+    public IRubyObject getOptions(ThreadContext context) {
+        return invoke(context, parse_options(context), "options");
+    }
+
+    @JRubyMethod(name="options=")
+    public IRubyObject setOptions(ThreadContext context, IRubyObject opts) {
+        invoke(context, parse_options(context), "options=", opts);
+        options = new ParserContext.Options(opts.convertToInteger().getLongValue());
+        return getOptions(context);
+    }
+
+    /**
+     * Can take a boolean assignment.
+     *
+     * @param context
+     * @param value
+     * @return
+     */
+    @JRubyMethod(name = "replace_entities=")
+    public IRubyObject setReplaceEntities(ThreadContext context, IRubyObject value) {
+        // Ignore the value.
+        return this;
+    }
+
+    @JRubyMethod(name="replace_entities")
+    public IRubyObject getReplaceEntities(ThreadContext context) {
+        // The java parser always replaces entities.
+        return context.getRuntime().getTrue();
+    }
+
+    @JRubyMethod
+    public IRubyObject native_write(ThreadContext context, IRubyObject chunk,
+                                    IRubyObject isLast) {
+        if (ex != null) {
+            // parser has already errored, rethrow the exception
+            throw ex;
+        }
+
+        try {
+            initialize_task(context);
+        } catch (IOException e) {
+            throw context.runtime.newRuntimeError(e.getMessage());
+        }
+        final ByteArrayInputStream data = NokogiriHelpers.stringBytesToStream(chunk);
+        if (data == null) {
+            return this;
+        }
+
+        int errorCount0 = parserTask.getErrorCount();
+
+        try {
+            Future<Void> task = stream.addChunk(data);
+            task.get();
+        } catch (ClosedStreamException ex) {
+            // this means the stream is closed, ignore this exception
+        } catch (Exception e) {
+            throw context.runtime.newRuntimeError(e.toString());
+        }
+
+        if (isLast.isTrue()) {
+            parserTask.getNokogiriHandler().endDocument();
+            terminateTask(context.runtime);
+        }
+
+        if (!options.recover && parserTask.getErrorCount() > errorCount0) {
+            terminateTask(context.runtime);
+            throw ex = parserTask.getLastError();
+        }
+
+        return this;
+    }
+
+    private void initialize_task(ThreadContext context) throws IOException {
+        if (futureTask == null || stream == null) {
+            stream = new NokogiriBlockingQueueInputStream();
+
+            assert saxParser != null : "saxParser null";
+            parserTask = new ParserTask(context, saxParser, stream);
+            futureTask = new FutureTask<XmlSaxParserContext>(parserTask);
+            executor = Executors.newSingleThreadExecutor(new ThreadFactory() {
+                @Override
+                public Thread newThread(Runnable r) {
+                    Thread t = new Thread(r);
+                    t.setName("XmlSaxPushParser");
+                    t.setDaemon(true);
+                    return t;
+                }
+            });
+            executor.submit(futureTask);
+        }
+    }
+
+    private void terminateTask(final Ruby runtime) {
+        if (executor == null) return;
+
+        try {
+            terminateImpl();
+        }
+        catch (InterruptedException e) {
+            throw runtime.newRuntimeError(e.toString());
+        }
+        catch (Exception e) {
+            throw runtime.newRuntimeError(e.toString());
+        }
+    }
+
+    private synchronized void terminateImpl() throws InterruptedException, ExecutionException {
+        terminateExecution(executor, stream, futureTask);
+
+        executor = null; stream = null; futureTask = null;
+    }
+
+    // SHARED for HtmlSaxPushParser
+    static void terminateExecution(final ExecutorService executor, final NokogiriBlockingQueueInputStream stream,
+                                   final FutureTask<?> futureTask)
+        throws InterruptedException, ExecutionException {
+
+        if (executor == null) return;
+
+        try {
+            Future<Void> task = stream.addChunk(NokogiriBlockingQueueInputStream.END);
+            task.get();
+        }
+        catch (ClosedStreamException ex) {
+            // ignore this exception, it means the stream was closed
+        }
+        futureTask.cancel(true);
+        executor.shutdown();
+    }
+
+    private static XmlSaxParserContext parse(final Ruby runtime, final InputStream stream) {
+        RubyClass klazz = getNokogiriClass(runtime, "Nokogiri::XML::SAX::ParserContext");
+        return XmlSaxParserContext.parse_stream(runtime, klazz, stream);
+    }
+
+    static class ParserTask extends ParserContext.ParserTask<XmlSaxParserContext> {
+
+        final InputStream stream;
+
+        private ParserTask(ThreadContext context, IRubyObject handler, InputStream stream) {
+            this(context, handler, parse(context.runtime, stream), stream);
+        }
+
+        // IMPL with HtmlSaxPushParser
+        protected ParserTask(ThreadContext context, IRubyObject handler, XmlSaxParserContext parser, InputStream stream) {
+            super(context, handler, parser);
+            this.stream = stream;
+        }
+
+        @Override
+        public XmlSaxParserContext call() throws Exception {
+            try {
+                parser.parse_with(context, handler);
+            }
+            finally { stream.close(); }
+            // we have to close the stream before exiting, otherwise someone
+            // can add a chunk and block on task.get() forever.
+            return parser;
+        }
+
+        final NokogiriHandler getNokogiriHandler() {
+            return parser.getNokogiriHandler();
+        }
+
+        synchronized final int getErrorCount() {
+            // check for null because thread may not have started yet
+            if (parser.getNokogiriHandler() == null) return 0;
+            return parser.getNokogiriHandler().getErrorCount();
+        }
+
+        synchronized final RaiseException getLastError() {
+            return parser.getNokogiriHandler().getLastError();
+        }
+
+    }
+
+}