nokogiri 1.4.3.1-java → 1.5.0-java

data/ext/java/nokogiri/XmlSaxParserContext.java

@@ -0,0 +1,367 @@
+/**
+ * (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 nokogiri.internals.NokogiriHelpers.rubyStringToString;
+import static org.jruby.javasupport.util.RuntimeHelpers.invoke;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import nokogiri.internals.NokogiriHandler;
+import nokogiri.internals.ParserContext;
+import nokogiri.internals.XmlSaxParser;
+
+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;
+
+/**
+ * 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 AbstractSAXParser parser;
+
+    protected NokogiriHandler handler = null;
+    private IRubyObject replaceEntities;
+
+    public XmlSaxParserContext(final Ruby ruby, RubyClass rubyClass) {
+        super(ruby, rubyClass);
+    }
+        
+    protected void initialize(Ruby runtime) {
+        replaceEntities = runtime.getTrue();
+        try {
+            parser = createParser();
+        } catch (SAXException se) {
+            throw RaiseException.createNativeRaiseException(runtime, se);
+        }
+    }
+
+    /**
+     * 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) {
+        XmlSaxParserContext ctx = (XmlSaxParserContext) NokogiriService.XML_SAXPARSER_CONTEXT_ALLOCATOR.allocate(context.getRuntime(), (RubyClass) klazz);
+        ctx.initialize(context.getRuntime());
+        ctx.setInputSource(context, data, context.getRuntime().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) {
+        XmlSaxParserContext ctx = (XmlSaxParserContext) NokogiriService.XML_SAXPARSER_CONTEXT_ALLOCATOR.allocate(context.getRuntime(), (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();
+        XmlSaxParserContext ctx = (XmlSaxParserContext) NokogiriService.XML_SAXPARSER_CONTEXT_ALLOCATOR.allocate(context.getRuntime(), (RubyClass) klazz);
+        ctx.initialize(context.getRuntime());
+        ctx.setInputSource(context, data, context.getRuntime().getNil());
+        return ctx;
+    }
+
+    /**
+     * Create a new parser context that will read from a raw input
+     * stream. Not a JRuby method.  Meant to be run in a separate
+     * thread by XmlSaxPushParser.
+     */
+    public static IRubyObject parse_stream(ThreadContext context,
+                                           IRubyObject klazz,
+                                           InputStream stream) {
+        XmlSaxParserContext ctx = (XmlSaxParserContext) NokogiriService.XML_SAXPARSER_CONTEXT_ALLOCATOR.allocate(context.getRuntime(), (RubyClass) klazz);
+        ctx.initialize(context.getRuntime());
+        ctx.setInputSource(stream);
+        return ctx;
+    }
+
+    /**
+     * 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 NokogiriHandler getNokogiriHandler() {
+        return handler;
+    }
+
+    /**
+     * Perform any initialization prior to parsing with the handler
+     * <code>handlerRuby</code>. Convenience hook for subclasses.
+     */
+    protected void preParse(ThreadContext context,
+                            IRubyObject handlerRuby,
+                            NokogiriHandler handler) {
+        ((XmlSaxParser) parser).setXmlDeclHandler(handler);
+    }
+
+    protected void postParse(ThreadContext context,
+                             IRubyObject handlerRuby,
+                             NokogiriHandler handler) {
+        // noop
+    }
+
+    protected void do_parse() throws SAXException, IOException {
+        parser.parse(getInputSource());
+    }
+
+    @JRubyMethod
+    public IRubyObject parse_with(ThreadContext context,
+                                  IRubyObject handlerRuby) {
+        Ruby ruby = context.getRuntime();
+
+        if(!invoke(context, handlerRuby, "respond_to?",
+                   ruby.newSymbol("document")).isTrue()) {
+            String msg = "argument must respond_to document";
+            throw ruby.newArgumentError(msg);
+        }
+
+        handler = new NokogiriHandler(ruby, handlerRuby);
+        preParse(context, handlerRuby, handler);
+
+        setContentHandler(handler);
+        setErrorHandler(handler);
+
+        try{
+            setProperty("http://xml.org/sax/properties/lexical-handler",
+                        handler);
+        } catch(Exception ex) {
+            throw ruby.newRuntimeError(
+                "Problem while creating XML SAX Parser: " + ex.toString());
+        }
+
+        try{
+            try {
+                do_parse();
+            } catch(SAXParseException spe) {
+                // 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 = spe.getMessage();
+                if ("Premature end of file.".matches(message)) {
+                    throw ruby.newRuntimeError(
+                        "couldn't parse document: " + message);
+                } else {
+                    handler.error(spe);
+                }
+
+            }
+        } catch(SAXException se) {
+            throw RaiseException.createNativeRaiseException(ruby, se);
+        } catch(IOException ioe) {
+            throw ruby.newIOErrorFromException(ioe);
+        }
+
+        postParse(context, handlerRuby, handler);
+
+        //maybeTrimLeadingAndTrailingWhitespace(context, handlerRuby);
+
+        return ruby.getNil();
+    }
+
+    /**
+     * Can take a boolean assignment.
+     *
+     * @param context
+     * @param value
+     * @return
+     */
+    @JRubyMethod(name = "replace_entities=")
+    public IRubyObject set_replace_entities(ThreadContext context,
+                                            IRubyObject value) {
+        if (!value.isTrue()) replaceEntities = context.getRuntime().getFalse();
+        else replaceEntities = context.getRuntime().getTrue();
+
+        return this;
+    }
+
+    @JRubyMethod(name="replace_entities")
+    public IRubyObject get_replace_entities(ThreadContext context) {
+        return replaceEntities;
+    }
+
+
+    /**
+     * 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) {
+        final String path = "Nokogiri::XML::FragmentHandler";
+        RubyObjectAdapter adapter = JavaEmbedUtils.newObjectAdapter();
+        RubyModule mod =
+            context.getRuntime().getClassFromPath(path);
+
+        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 (isWhitespaceText(context, first))
+                adapter.callMethod(first, "unlink");
+            else
+                break;
+        }
+
+        for (;;) {
+            children = adapter.callMethod(doc, "children");
+            IRubyObject last = adapter.callMethod(children, "last");
+            if (isWhitespaceText(context, last))
+                adapter.callMethod(last, "unlink");
+            else
+                break;
+        }
+
+        // While we have a document, normalize it.
+        ((XmlNode) doc).normalize();
+    }
+
+    protected boolean isWhitespaceText(ThreadContext context, IRubyObject obj) {
+        if (obj == null || obj.isNil()) return false;
+
+        XmlNode node = (XmlNode) obj;
+        if (!(node instanceof XmlText))
+            return false;
+
+        String content = rubyStringToString(node.content(context));
+        return content.trim().length() == 0;
+    }
+
+    @JRubyMethod(name="column")
+    public IRubyObject column(ThreadContext context) {
+        Integer number = handler.getColumn();
+        if (number == null) return context.getRuntime().getNil();
+        else return RubyFixnum.newFixnum(context.getRuntime(), number.longValue());
+    }
+
+    @JRubyMethod(name="line")
+    public IRubyObject line(ThreadContext context) {
+        Integer number = handler.getLine();
+        if (number == null) return context.getRuntime().getNil();
+        else return RubyFixnum.newFixnum(context.getRuntime(), number.longValue());
+    }
+}

data/ext/java/nokogiri/XmlSaxPushParser.java

@@ -0,0 +1,184 @@
+/**
+ * (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 nokogiri.internals.NokogiriHelpers.getNokogiriClass;
+import static org.jruby.javasupport.util.RuntimeHelpers.invoke;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.channels.ClosedChannelException;
+
+import nokogiri.internals.ParserContext;
+import nokogiri.internals.PushInputStream;
+
+import org.jruby.Ruby;
+import org.jruby.RubyClass;
+import org.jruby.RubyException;
+import org.jruby.RubyObject;
+import org.jruby.RubyString;
+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;
+
+/**
+ * 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 optionsRuby;
+    PushInputStream stream;
+    Thread reader;
+    Runner runner;
+
+    public XmlSaxPushParser(Ruby ruby, RubyClass rubyClass) {
+        super(ruby, rubyClass);
+    }
+
+    @JRubyMethod
+    public IRubyObject initialize_native(final ThreadContext context,
+                                         IRubyObject _saxParser,
+                                         IRubyObject fileName) {
+        optionsRuby = invoke(context,
+                             context.getRuntime().getClassFromPath("Nokogiri::XML::ParseOptions"),
+                             "new");
+        options = new ParserContext.Options(0);
+        stream = new PushInputStream();
+
+        runner = new Runner(context, this, stream);
+        reader = new Thread(runner);
+        reader.start();
+
+        return this;
+    }
+
+    /**
+     * Returns an integer.
+     */
+    @JRubyMethod(name="options")
+    public IRubyObject getOptions(ThreadContext context) {
+        return invoke(context, optionsRuby, "options");
+    }
+
+    /**
+     * <code>val</code> is an integer.
+     */
+    @JRubyMethod(name="options=")
+    public IRubyObject setOptions(ThreadContext context, IRubyObject val) {
+        invoke(context, optionsRuby, "options=", val);
+        options =
+            new ParserContext.Options(val.convertToInteger().getLongValue());
+        return getOptions(context);
+    }
+
+    @JRubyMethod
+    public IRubyObject native_write(ThreadContext context, IRubyObject chunk,
+                                    IRubyObject isLast) {
+        byte[] data = null;
+        if (chunk instanceof RubyString || chunk.respondsTo("to_str")) {
+            data = chunk.convertToString().getBytes();
+        } else {
+            XmlSyntaxError xmlSyntaxError = (XmlSyntaxError) NokogiriService.XML_SYNTAXERROR_ALLOCATOR.allocate(context.getRuntime(), getNokogiriClass(context.getRuntime(), "Nokogiri::XML::SyntaxError"));
+            throw new RaiseException(xmlSyntaxError);
+        }
+
+        int errorCount0 = runner.getErrorCount();
+
+        try {
+            stream.writeAndWaitForRead(data);
+        } catch (ClosedChannelException e) {
+            // ignore
+        } catch (IOException e) {
+            throw context.getRuntime().newRuntimeError(e.toString());
+        }
+
+        if (isLast.isTrue()) {
+            try {
+                stream.close();
+            } catch (IOException e) {
+                // ignore
+            }
+
+            for (;;) {
+                try {
+                    reader.join();
+                    break;
+                } catch (InterruptedException e) {
+                    // continue loop
+                }
+            }
+        }
+
+        if (!options.recover && runner.getErrorCount() > errorCount0) {
+            throw new RaiseException(runner.getLastError(), true);
+        }
+
+        return this;
+    }
+
+    protected static class Runner implements Runnable {
+        protected ThreadContext context;
+        protected IRubyObject handler;
+        protected XmlSaxParserContext parser;
+
+        public Runner(ThreadContext context,
+                      IRubyObject handler,
+                      InputStream stream) {
+            RubyClass klazz = getNokogiriClass(context.getRuntime(), "Nokogiri::XML::SAX::ParserContext");
+
+            this.context = context;
+            this.handler = handler;
+            this.parser = (XmlSaxParserContext) XmlSaxParserContext.parse_stream(context, klazz, stream);
+        }
+
+        public void run() {
+            parser.parse_with(context, handler);
+        }
+
+        public int getErrorCount() {
+            // check for null because thread may nto have started yet
+            if (parser.getNokogiriHandler() == null) return 0;
+            else return parser.getNokogiriHandler().getErrorCount();
+        }
+
+        public RubyException getLastError() {
+            return (RubyException) parser.getNokogiriHandler().getLastError();
+        }
+    }
+}