nokogiri-backport 1.11.0

data/ext/nokogiri/xml_document.c

@@ -0,0 +1,622 @@
+#include <xml_document.h>
+
+static int dealloc_node_i2(xmlNodePtr key, xmlNodePtr node, xmlDocPtr doc)
+{
+  switch(node->type) {
+  case XML_ATTRIBUTE_NODE:
+    xmlFreePropList((xmlAttrPtr)node);
+    break;
+  case XML_NAMESPACE_DECL:
+    xmlFreeNs((xmlNsPtr)node);
+    break;
+  case XML_DTD_NODE:
+    xmlFreeDtd((xmlDtdPtr)node);
+    break;
+  default:
+    if(node->parent == NULL) {
+      xmlAddChild((xmlNodePtr)doc, node);
+    }
+  }
+  return ST_CONTINUE;
+}
+
+static int dealloc_node_i(st_data_t key, st_data_t node, st_data_t doc)
+{
+  return dealloc_node_i2((xmlNodePtr)key, (xmlNodePtr)node, (xmlDocPtr)doc);
+}
+
+static void remove_private(xmlNodePtr node)
+{
+  xmlNodePtr child;
+
+  for (child = node->children; child; child = child->next)
+    remove_private(child);
+
+  if ((node->type == XML_ELEMENT_NODE ||
+       node->type == XML_XINCLUDE_START ||
+       node->type == XML_XINCLUDE_END) &&
+      node->properties) {
+    for (child = (xmlNodePtr)node->properties; child; child = child->next)
+      remove_private(child);
+  }
+
+  node->_private = NULL;
+}
+
+static void mark(xmlDocPtr doc)
+{
+  nokogiriTuplePtr tuple = (nokogiriTuplePtr)doc->_private;
+  if(tuple) {
+      rb_gc_mark(tuple->doc);
+      rb_gc_mark(tuple->node_cache);
+  }
+}
+
+static void dealloc(xmlDocPtr doc)
+{
+  st_table *node_hash;
+
+  NOKOGIRI_DEBUG_START(doc);
+
+  node_hash  = DOC_UNLINKED_NODE_HASH(doc);
+
+  st_foreach(node_hash, dealloc_node_i, (st_data_t)doc);
+  st_free_table(node_hash);
+
+  free(doc->_private);
+
+  /* When both Nokogiri and libxml-ruby are loaded, make sure that all nodes
+   * have their _private pointers cleared. This is to avoid libxml-ruby's
+   * xmlDeregisterNode callback from accessing VALUE pointers from ruby's GC
+   * free context, which can result in segfaults.
+   */
+  if (xmlDeregisterNodeDefaultValue)
+    remove_private((xmlNodePtr)doc);
+
+  xmlFreeDoc(doc);
+
+  NOKOGIRI_DEBUG_END(doc);
+}
+
+static void recursively_remove_namespaces_from_node(xmlNodePtr node)
+{
+  xmlNodePtr child ;
+  xmlAttrPtr property ;
+
+  xmlSetNs(node, NULL);
+
+  for (child = node->children ; child ; child = child->next)
+    recursively_remove_namespaces_from_node(child);
+
+  if (((node->type == XML_ELEMENT_NODE) ||
+       (node->type == XML_XINCLUDE_START) ||
+       (node->type == XML_XINCLUDE_END)) &&
+      node->nsDef) {
+    xmlFreeNsList(node->nsDef);
+    node->nsDef = NULL;
+  }
+
+  if (node->type == XML_ELEMENT_NODE && node->properties != NULL) {
+    property = node->properties ;
+    while (property != NULL) {
+      if (property->ns) property->ns = NULL ;
+      property = property->next ;
+    }
+  }
+}
+
+/*
+ * call-seq:
+ *  url
+ *
+ * Get the url name for this document.
+ */
+static VALUE url(VALUE self)
+{
+  xmlDocPtr doc;
+  Data_Get_Struct(self, xmlDoc, doc);
+
+  if(doc->URL) return NOKOGIRI_STR_NEW2(doc->URL);
+
+  return Qnil;
+}
+
+/*
+ * call-seq:
+ *  root=
+ *
+ * Set the root element on this document
+ */
+static VALUE set_root(VALUE self, VALUE root)
+{
+  xmlDocPtr doc;
+  xmlNodePtr new_root;
+  xmlNodePtr old_root;
+
+  Data_Get_Struct(self, xmlDoc, doc);
+
+  old_root = NULL;
+
+  if(NIL_P(root)) {
+    old_root = xmlDocGetRootElement(doc);
+
+    if(old_root) {
+      xmlUnlinkNode(old_root);
+      nokogiri_root_node(old_root);
+    }
+
+    return root;
+  }
+
+  Data_Get_Struct(root, xmlNode, new_root);
+
+
+  /* If the new root's document is not the same as the current document,
+   * then we need to dup the node in to this document. */
+  if(new_root->doc != doc) {
+    old_root = xmlDocGetRootElement(doc);
+    if (!(new_root = xmlDocCopyNode(new_root, doc, 1))) {
+      rb_raise(rb_eRuntimeError, "Could not reparent node (xmlDocCopyNode)");
+    }
+  }
+
+  xmlDocSetRootElement(doc, new_root);
+  if(old_root) nokogiri_root_node(old_root);
+  return root;
+}
+
+/*
+ * call-seq:
+ *  root
+ *
+ * Get the root node for this document.
+ */
+static VALUE root(VALUE self)
+{
+  xmlDocPtr doc;
+  xmlNodePtr root;
+
+  Data_Get_Struct(self, xmlDoc, doc);
+
+  root = xmlDocGetRootElement(doc);
+
+  if(!root) return Qnil;
+  return Nokogiri_wrap_xml_node(Qnil, root) ;
+}
+
+/*
+ * call-seq:
+ *  encoding= encoding
+ *
+ * Set the encoding string for this Document
+ */
+static VALUE set_encoding(VALUE self, VALUE encoding)
+{
+  xmlDocPtr doc;
+  Data_Get_Struct(self, xmlDoc, doc);
+
+  if (doc->encoding)
+      free((char *)(uintptr_t) doc->encoding); /* avoid gcc cast warning */
+
+  doc->encoding = xmlStrdup((xmlChar *)StringValueCStr(encoding));
+
+  return encoding;
+}
+
+/*
+ * call-seq:
+ *  encoding
+ *
+ * Get the encoding for this Document
+ */
+static VALUE encoding(VALUE self)
+{
+  xmlDocPtr doc;
+  Data_Get_Struct(self, xmlDoc, doc);
+
+  if(!doc->encoding) return Qnil;
+  return NOKOGIRI_STR_NEW2(doc->encoding);
+}
+
+/*
+ * call-seq:
+ *  version
+ *
+ * Get the XML version for this Document
+ */
+static VALUE version(VALUE self)
+{
+  xmlDocPtr doc;
+  Data_Get_Struct(self, xmlDoc, doc);
+
+  if(!doc->version) return Qnil;
+  return NOKOGIRI_STR_NEW2(doc->version);
+}
+
+/*
+ * call-seq:
+ *  read_io(io, url, encoding, options)
+ *
+ * Create a new document from an IO object
+ */
+static VALUE read_io( VALUE klass,
+                      VALUE io,
+                      VALUE url,
+                      VALUE encoding,
+                      VALUE options )
+{
+  const char * c_url    = NIL_P(url)      ? NULL : StringValueCStr(url);
+  const char * c_enc    = NIL_P(encoding) ? NULL : StringValueCStr(encoding);
+  VALUE error_list      = rb_ary_new();
+  VALUE document;
+  xmlDocPtr doc;
+
+  xmlResetLastError();
+  xmlSetStructuredErrorFunc((void *)error_list, Nokogiri_error_array_pusher);
+
+  doc = xmlReadIO(
+      (xmlInputReadCallback)io_read_callback,
+      (xmlInputCloseCallback)io_close_callback,
+      (void *)io,
+      c_url,
+      c_enc,
+      (int)NUM2INT(options)
+  );
+  xmlSetStructuredErrorFunc(NULL, NULL);
+
+  if(doc == NULL) {
+    xmlErrorPtr error;
+
+    xmlFreeDoc(doc);
+
+    error = xmlGetLastError();
+    if(error)
+      rb_exc_raise(Nokogiri_wrap_xml_syntax_error(error));
+    else
+      rb_raise(rb_eRuntimeError, "Could not parse document");
+
+    return Qnil;
+  }
+
+  document = Nokogiri_wrap_xml_document(klass, doc);
+  rb_iv_set(document, "@errors", error_list);
+  return document;
+}
+
+/*
+ * call-seq:
+ *  read_memory(string, url, encoding, options)
+ *
+ * Create a new document from a String
+ */
+static VALUE read_memory( VALUE klass,
+                          VALUE string,
+                          VALUE url,
+                          VALUE encoding,
+                          VALUE options )
+{
+  const char * c_buffer = StringValuePtr(string);
+  const char * c_url    = NIL_P(url)      ? NULL : StringValueCStr(url);
+  const char * c_enc    = NIL_P(encoding) ? NULL : StringValueCStr(encoding);
+  int len               = (int)RSTRING_LEN(string);
+  VALUE error_list      = rb_ary_new();
+  VALUE document;
+  xmlDocPtr doc;
+
+  xmlResetLastError();
+  xmlSetStructuredErrorFunc((void *)error_list, Nokogiri_error_array_pusher);
+  doc = xmlReadMemory(c_buffer, len, c_url, c_enc, (int)NUM2INT(options));
+  xmlSetStructuredErrorFunc(NULL, NULL);
+
+  if(doc == NULL) {
+    xmlErrorPtr error;
+
+    xmlFreeDoc(doc);
+
+    error = xmlGetLastError();
+    if(error)
+      rb_exc_raise(Nokogiri_wrap_xml_syntax_error(error));
+    else
+      rb_raise(rb_eRuntimeError, "Could not parse document");
+
+    return Qnil;
+  }
+
+  document = Nokogiri_wrap_xml_document(klass, doc);
+  rb_iv_set(document, "@errors", error_list);
+  return document;
+}
+
+/*
+ * call-seq:
+ *  dup
+ *
+ * Copy this Document.  An optional depth may be passed in, but it defaults
+ * to a deep copy.  0 is a shallow copy, 1 is a deep copy.
+ */
+static VALUE duplicate_document(int argc, VALUE *argv, VALUE self)
+{
+  xmlDocPtr doc, dup;
+  VALUE copy;
+  VALUE level;
+  VALUE error_list;
+
+  if(rb_scan_args(argc, argv, "01", &level) == 0)
+    level = INT2NUM((long)1);
+
+  Data_Get_Struct(self, xmlDoc, doc);
+
+  dup = xmlCopyDoc(doc, (int)NUM2INT(level));
+
+  if(dup == NULL) return Qnil;
+
+  dup->type = doc->type;
+  copy = Nokogiri_wrap_xml_document(rb_obj_class(self), dup);
+  error_list = rb_iv_get(self, "@errors");
+  rb_iv_set(copy, "@errors", error_list);
+  return copy ;
+}
+
+/*
+ * call-seq:
+ *  new(version = default)
+ *
+ * Create a new document with +version+ (defaults to "1.0")
+ */
+static VALUE new(int argc, VALUE *argv, VALUE klass)
+{
+  xmlDocPtr doc;
+  VALUE version, rest, rb_doc ;
+
+  rb_scan_args(argc, argv, "0*", &rest);
+  version = rb_ary_entry(rest, (long)0);
+  if (NIL_P(version)) version = rb_str_new2("1.0");
+
+  doc = xmlNewDoc((xmlChar *)StringValueCStr(version));
+  rb_doc = Nokogiri_wrap_xml_document(klass, doc);
+  rb_obj_call_init(rb_doc, argc, argv);
+  return rb_doc ;
+}
+
+/*
+ *  call-seq:
+ *    remove_namespaces!
+ *
+ *  Remove all namespaces from all nodes in the document.
+ *
+ *  This could be useful for developers who either don't understand namespaces
+ *  or don't care about them.
+ *
+ *  The following example shows a use case, and you can decide for yourself
+ *  whether this is a good thing or not:
+ *
+ *    doc = Nokogiri::XML <<-EOXML
+ *       <root>
+ *         <car xmlns:part="http://general-motors.com/">
+ *           <part:tire>Michelin Model XGV</part:tire>
+ *         </car>
+ *         <bicycle xmlns:part="http://schwinn.com/">
+ *           <part:tire>I'm a bicycle tire!</part:tire>
+ *         </bicycle>
+ *       </root>
+ *       EOXML
+ *
+ *    doc.xpath("//tire").to_s # => ""
+ *    doc.xpath("//part:tire", "part" => "http://general-motors.com/").to_s # => "<part:tire>Michelin Model XGV</part:tire>"
+ *    doc.xpath("//part:tire", "part" => "http://schwinn.com/").to_s # => "<part:tire>I'm a bicycle tire!</part:tire>"
+ *
+ *    doc.remove_namespaces!
+ *
+ *    doc.xpath("//tire").to_s # => "<tire>Michelin Model XGV</tire><tire>I'm a bicycle tire!</tire>"
+ *    doc.xpath("//part:tire", "part" => "http://general-motors.com/").to_s # => ""
+ *    doc.xpath("//part:tire", "part" => "http://schwinn.com/").to_s # => ""
+ *
+ *  For more information on why this probably is *not* a good thing in general,
+ *  please direct your browser to
+ *  http://tenderlovemaking.com/2009/04/23/namespaces-in-xml.html
+ */
+VALUE remove_namespaces_bang(VALUE self)
+{
+  xmlDocPtr doc ;
+  Data_Get_Struct(self, xmlDoc, doc);
+
+  recursively_remove_namespaces_from_node((xmlNodePtr)doc);
+  return self;
+}
+
+/* call-seq: doc.create_entity(name, type, external_id, system_id, content)
+ *
+ * Create a new entity named +name+.
+ *
+ * +type+ is an integer representing the type of entity to be created, and it
+ * defaults to Nokogiri::XML::EntityDecl::INTERNAL_GENERAL.  See
+ * the constants on Nokogiri::XML::EntityDecl for more information.
+ *
+ * +external_id+, +system_id+, and +content+ set the External ID, System ID,
+ * and content respectively.  All of these parameters are optional.
+ */
+static VALUE create_entity(int argc, VALUE *argv, VALUE self)
+{
+  VALUE name;
+  VALUE type;
+  VALUE external_id;
+  VALUE system_id;
+  VALUE content;
+  xmlEntityPtr ptr;
+  xmlDocPtr doc ;
+
+  Data_Get_Struct(self, xmlDoc, doc);
+
+  rb_scan_args(argc, argv, "14", &name, &type, &external_id, &system_id,
+      &content);
+
+  xmlResetLastError();
+  ptr = xmlAddDocEntity(
+      doc,
+      (xmlChar *)(NIL_P(name)        ? NULL                        : StringValueCStr(name)),
+      (int)      (NIL_P(type)        ? XML_INTERNAL_GENERAL_ENTITY : NUM2INT(type)),
+      (xmlChar *)(NIL_P(external_id) ? NULL                        : StringValueCStr(external_id)),
+      (xmlChar *)(NIL_P(system_id)   ? NULL                        : StringValueCStr(system_id)),
+      (xmlChar *)(NIL_P(content)     ? NULL                        : StringValueCStr(content))
+    );
+
+  if(NULL == ptr) {
+    xmlErrorPtr error = xmlGetLastError();
+    if(error)
+      rb_exc_raise(Nokogiri_wrap_xml_syntax_error(error));
+    else
+      rb_raise(rb_eRuntimeError, "Could not create entity");
+
+    return Qnil;
+  }
+
+  return Nokogiri_wrap_xml_node(cNokogiriXmlEntityDecl, (xmlNodePtr)ptr);
+}
+
+static int block_caller(void * ctx, xmlNodePtr _node, xmlNodePtr _parent)
+{
+  VALUE block;
+  VALUE node;
+  VALUE parent;
+  VALUE ret;
+
+  if(_node->type == XML_NAMESPACE_DECL){
+    node = Nokogiri_wrap_xml_namespace(_parent->doc, (xmlNsPtr) _node);
+  }
+  else{
+    node   = Nokogiri_wrap_xml_node(Qnil, _node);
+  }
+  parent = _parent ? Nokogiri_wrap_xml_node(Qnil, _parent) : Qnil;
+  block  = (VALUE)ctx;
+
+  ret = rb_funcall(block, rb_intern("call"), 2, node, parent);
+
+  if(Qfalse == ret || Qnil == ret) return 0;
+
+  return 1;
+}
+
+/* call-seq:
+ *  doc.canonicalize(mode=XML_C14N_1_0,inclusive_namespaces=nil,with_comments=false)
+ *  doc.canonicalize { |obj, parent| ... }
+ *
+ * Canonicalize a document and return the results.  Takes an optional block
+ * that takes two parameters: the +obj+ and that node's +parent+.
+ * The  +obj+ will be either a Nokogiri::XML::Node, or a Nokogiri::XML::Namespace
+ * The block must return a non-nil, non-false value if the +obj+ passed in
+ * should be included in the canonicalized document.
+ */
+static VALUE nokogiri_xml_document_canonicalize(int argc, VALUE* argv, VALUE self)
+{
+  VALUE mode;
+  VALUE incl_ns;
+  VALUE with_comments;
+  xmlChar **ns;
+  long ns_len, i;
+
+  xmlDocPtr doc;
+  xmlOutputBufferPtr buf;
+  xmlC14NIsVisibleCallback cb = NULL;
+  void * ctx = NULL;
+
+  VALUE rb_cStringIO;
+  VALUE io;
+
+  rb_scan_args(argc, argv, "03", &mode, &incl_ns, &with_comments);
+
+  Data_Get_Struct(self, xmlDoc, doc);
+
+  rb_cStringIO = rb_const_get_at(rb_cObject, rb_intern("StringIO"));
+  io           = rb_class_new_instance(0, 0, rb_cStringIO);
+  buf          = xmlAllocOutputBuffer(NULL);
+
+  buf->writecallback = (xmlOutputWriteCallback)io_write_callback;
+  buf->closecallback = (xmlOutputCloseCallback)io_close_callback;
+  buf->context       = (void *)io;
+
+  if(rb_block_given_p()) {
+    cb = block_caller;
+    ctx = (void *)rb_block_proc();
+  }
+
+  if(NIL_P(incl_ns)){
+    ns = NULL;
+  }
+  else{
+    Check_Type(incl_ns, T_ARRAY);
+    ns_len = RARRAY_LEN(incl_ns);
+    ns = calloc((size_t)ns_len+1, sizeof(xmlChar *));
+    for (i = 0 ; i < ns_len ; i++) {
+      VALUE entry = rb_ary_entry(incl_ns, i);
+      ns[i] = (xmlChar*)StringValueCStr(entry);
+    }
+  }
+
+
+  xmlC14NExecute(doc, cb, ctx,
+    (int)      (NIL_P(mode)        ? 0 : NUM2INT(mode)),
+    ns,
+    (int)      RTEST(with_comments),
+    buf);
+
+  xmlOutputBufferClose(buf);
+
+  return rb_funcall(io, rb_intern("string"), 0);
+}
+
+VALUE cNokogiriXmlDocument ;
+void init_xml_document()
+{
+  VALUE nokogiri  = rb_define_module("Nokogiri");
+  VALUE xml       = rb_define_module_under(nokogiri, "XML");
+  VALUE node      = rb_define_class_under(xml, "Node", rb_cObject);
+
+  /*
+   * Nokogiri::XML::Document wraps an xml document.
+   */
+  VALUE klass = rb_define_class_under(xml, "Document", node);
+
+  cNokogiriXmlDocument = klass;
+
+  rb_define_singleton_method(klass, "read_memory", read_memory, 4);
+  rb_define_singleton_method(klass, "read_io", read_io, 4);
+  rb_define_singleton_method(klass, "new", new, -1);
+
+  rb_define_method(klass, "root", root, 0);
+  rb_define_method(klass, "root=", set_root, 1);
+  rb_define_method(klass, "encoding", encoding, 0);
+  rb_define_method(klass, "encoding=", set_encoding, 1);
+  rb_define_method(klass, "version", version, 0);
+  rb_define_method(klass, "canonicalize", nokogiri_xml_document_canonicalize, -1);
+  rb_define_method(klass, "dup", duplicate_document, -1);
+  rb_define_method(klass, "url", url, 0);
+  rb_define_method(klass, "create_entity", create_entity, -1);
+  rb_define_method(klass, "remove_namespaces!", remove_namespaces_bang, 0);
+}
+
+
+/* this takes klass as a param because it's used for HtmlDocument, too. */
+VALUE Nokogiri_wrap_xml_document(VALUE klass, xmlDocPtr doc)
+{
+  nokogiriTuplePtr tuple = (nokogiriTuplePtr)malloc(sizeof(nokogiriTuple));
+
+  VALUE rb_doc = Data_Wrap_Struct(
+      klass ? klass : cNokogiriXmlDocument,
+      mark,
+      dealloc,
+      doc
+  );
+
+  VALUE cache = rb_ary_new();
+  rb_iv_set(rb_doc, "@decorators", Qnil);
+  rb_iv_set(rb_doc, "@node_cache", cache);
+
+  tuple->doc = rb_doc;
+  tuple->unlinkedNodes = st_init_numtable_with_size(128);
+  tuple->node_cache = cache;
+  doc->_private = tuple ;
+
+  rb_obj_call_init(rb_doc, 0, NULL);
+
+  return rb_doc ;
+}

data/ext/nokogiri/xml_document.h

@@ -0,0 +1,23 @@
+#ifndef NOKOGIRI_XML_DOCUMENT
+#define NOKOGIRI_XML_DOCUMENT
+
+#include <nokogiri.h>
+
+struct _nokogiriTuple {
+  VALUE         doc;
+  st_table     *unlinkedNodes;
+  VALUE         node_cache;
+};
+typedef struct _nokogiriTuple nokogiriTuple;
+typedef nokogiriTuple * nokogiriTuplePtr;
+
+void init_xml_document();
+VALUE Nokogiri_wrap_xml_document(VALUE klass, xmlDocPtr doc);
+
+#define DOC_RUBY_OBJECT_TEST(x) ((nokogiriTuplePtr)(x->_private))
+#define DOC_RUBY_OBJECT(x) (((nokogiriTuplePtr)(x->_private))->doc)
+#define DOC_UNLINKED_NODE_HASH(x) (((nokogiriTuplePtr)(x->_private))->unlinkedNodes)
+#define DOC_NODE_CACHE(x) (((nokogiriTuplePtr)(x->_private))->node_cache)
+
+extern VALUE cNokogiriXmlDocument ;
+#endif

data/ext/nokogiri/xml_document_fragment.c

@@ -0,0 +1,48 @@
+#include <xml_document_fragment.h>
+
+/*
+ * call-seq:
+ *  new(document)
+ *
+ * Create a new DocumentFragment element on the +document+
+ */
+static VALUE new(int argc, VALUE *argv, VALUE klass)
+{
+  xmlDocPtr xml_doc;
+  xmlNodePtr node;
+  VALUE document;
+  VALUE rest;
+  VALUE rb_node;
+
+  rb_scan_args(argc, argv, "1*", &document, &rest);
+
+  Data_Get_Struct(document, xmlDoc, xml_doc);
+
+  node = xmlNewDocFragment(xml_doc->doc);
+
+  nokogiri_root_node(node);
+
+  rb_node = Nokogiri_wrap_xml_node(klass, node);
+  rb_obj_call_init(rb_node, argc, argv);
+
+  if(rb_block_given_p()) rb_yield(rb_node);
+
+  return rb_node;
+}
+
+VALUE cNokogiriXmlDocumentFragment;
+void init_xml_document_fragment()
+{
+  VALUE nokogiri = rb_define_module("Nokogiri");
+  VALUE xml = rb_define_module_under(nokogiri, "XML");
+  VALUE node = rb_define_class_under(xml, "Node", rb_cObject);
+
+  /*
+   * DocumentFragment represents a DocumentFragment node in an xml document.
+   */
+  VALUE klass = rb_define_class_under(xml, "DocumentFragment", node);
+
+  cNokogiriXmlDocumentFragment = klass;
+
+  rb_define_singleton_method(klass, "new", new, -1);
+}

data/ext/nokogiri/xml_document_fragment.h

@@ -0,0 +1,10 @@
+#ifndef NOKOGIRI_XML_DOCUMENT_FRAGMENT
+#define NOKOGIRI_XML_DOCUMENT_FRAGMENT
+
+#include <nokogiri.h>
+
+void init_xml_document_fragment();
+
+extern VALUE cNokogiriXmlDocumentFragment;
+#endif
+