nokogiri 1.18.0.rc1-x86_64-linux-gnu

data/ext/nokogiri/xml_relax_ng.c

@@ -0,0 +1,149 @@
+#include <nokogiri.h>
+
+VALUE cNokogiriXmlRelaxNG;
+
+static void
+_noko_xml_relax_ng_deallocate(void *data)
+{
+  xmlRelaxNGPtr schema = data;
+  xmlRelaxNGFree(schema);
+}
+
+static const rb_data_type_t xml_relax_ng_type = {
+  .wrap_struct_name = "xmlRelaxNG",
+  .function = {
+    .dfree = _noko_xml_relax_ng_deallocate,
+  },
+  .flags = RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED,
+};
+
+static VALUE
+noko_xml_relax_ng__validate_document(VALUE self, VALUE document)
+{
+  xmlDocPtr doc;
+  xmlRelaxNGPtr schema;
+  VALUE errors;
+  xmlRelaxNGValidCtxtPtr valid_ctxt;
+
+  TypedData_Get_Struct(self, xmlRelaxNG, &xml_relax_ng_type, schema);
+  doc = noko_xml_document_unwrap(document);
+
+  errors = rb_ary_new();
+
+  valid_ctxt = xmlRelaxNGNewValidCtxt(schema);
+
+  if (NULL == valid_ctxt) {
+    /* we have a problem */
+    rb_raise(rb_eRuntimeError, "Could not create a validation context");
+  }
+
+  xmlRelaxNGSetValidStructuredErrors(
+    valid_ctxt,
+    noko__error_array_pusher,
+    (void *)errors
+  );
+
+  xmlRelaxNGValidateDoc(valid_ctxt, doc);
+
+  xmlRelaxNGFreeValidCtxt(valid_ctxt);
+
+  return errors;
+}
+
+static VALUE
+_noko_xml_relax_ng_parse_schema(
+  VALUE rb_class,
+  xmlRelaxNGParserCtxtPtr c_parser_context,
+  VALUE rb_parse_options
+)
+{
+  VALUE rb_errors;
+  VALUE rb_schema;
+  xmlRelaxNGPtr c_schema;
+  libxmlStructuredErrorHandlerState handler_state;
+
+  if (NIL_P(rb_parse_options)) {
+    rb_parse_options = rb_const_get_at(
+                         rb_const_get_at(mNokogiriXml, rb_intern("ParseOptions")),
+                         rb_intern("DEFAULT_SCHEMA")
+                       );
+  }
+
+  rb_errors = rb_ary_new();
+
+  noko__structured_error_func_save_and_set(&handler_state, (void *)rb_errors, noko__error_array_pusher);
+  xmlRelaxNGSetParserStructuredErrors(
+    c_parser_context,
+    noko__error_array_pusher,
+    (void *)rb_errors
+  );
+
+  c_schema = xmlRelaxNGParse(c_parser_context);
+
+  xmlRelaxNGFreeParserCtxt(c_parser_context);
+  noko__structured_error_func_restore(&handler_state);
+
+  if (NULL == c_schema) {
+    VALUE exception = rb_funcall(cNokogiriXmlSyntaxError, rb_intern("aggregate"), 1, rb_errors);
+
+    if (RB_TEST(exception)) {
+      rb_exc_raise(exception);
+    } else {
+      rb_raise(rb_eRuntimeError, "Could not parse document");
+    }
+  }
+
+  rb_schema = TypedData_Wrap_Struct(rb_class, &xml_relax_ng_type, c_schema);
+  rb_iv_set(rb_schema, "@errors", rb_errors);
+  rb_iv_set(rb_schema, "@parse_options", rb_parse_options);
+
+  return rb_schema;
+}
+
+/*
+ * :call-seq:
+ *   from_document(document) → Nokogiri::XML::RelaxNG
+ *   from_document(document, parse_options) → Nokogiri::XML::RelaxNG
+ *
+ * Parse a RELAX NG schema definition from a Document to create a new Nokogiri::XML::RelaxNG.
+ *
+ * [Parameters]
+ * - +document+ (XML::Document) A document containing the RELAX NG schema definition
+ * - +parse_options+ (Nokogiri::XML::ParseOptions)
+ *   Defaults to ParseOptions::DEFAULT_SCHEMA ⚠ Unused
+ *
+ * [Returns] Nokogiri::XML::RelaxNG
+ *
+ * ⚠ +parse_options+ is currently unused by this method and is present only as a placeholder for
+ * future functionality.
+ */
+static VALUE
+noko_xml_relax_ng_s_from_document(int argc, VALUE *argv, VALUE rb_class)
+{
+  /* TODO: deprecate this method and put file-or-string logic into .new so that becomes the
+   * preferred entry point, and this can become a private method */
+  VALUE rb_document;
+  VALUE rb_parse_options;
+  xmlDocPtr c_document;
+  xmlRelaxNGParserCtxtPtr c_parser_context;
+
+  rb_scan_args(argc, argv, "11", &rb_document, &rb_parse_options);
+
+  c_document = noko_xml_document_unwrap(rb_document);
+  c_document = c_document->doc; /* In case someone passes us a node. ugh. */
+
+  c_parser_context = xmlRelaxNGNewDocParserCtxt(c_document);
+
+  return _noko_xml_relax_ng_parse_schema(rb_class, c_parser_context, rb_parse_options);
+}
+
+void
+noko_init_xml_relax_ng(void)
+{
+  assert(cNokogiriXmlSchema);
+  cNokogiriXmlRelaxNG = rb_define_class_under(mNokogiriXml, "RelaxNG", cNokogiriXmlSchema);
+
+  rb_define_singleton_method(cNokogiriXmlRelaxNG, "from_document", noko_xml_relax_ng_s_from_document, -1);
+
+  rb_define_private_method(cNokogiriXmlRelaxNG, "validate_document", noko_xml_relax_ng__validate_document, 1);
+}

data/ext/nokogiri/xml_sax_parser.c

@@ -0,0 +1,403 @@
+#include <nokogiri.h>
+
+VALUE cNokogiriXmlSaxParser ;
+
+static ID id_start_document;
+static ID id_end_document;
+static ID id_start_element;
+static ID id_end_element;
+static ID id_start_element_namespace;
+static ID id_end_element_namespace;
+static ID id_comment;
+static ID id_characters;
+static ID id_xmldecl;
+static ID id_error;
+static ID id_warning;
+static ID id_cdata_block;
+static ID id_processing_instruction;
+static ID id_reference;
+
+static size_t
+xml_sax_parser_memsize(const void *data)
+{
+  return sizeof(xmlSAXHandler);
+}
+
+/* Used by Nokogiri::XML::SAX::Parser and Nokogiri::HTML::SAX::Parser */
+static const rb_data_type_t xml_sax_parser_type = {
+  .wrap_struct_name = "xmlSAXHandler",
+  .function = {
+    .dfree = RUBY_TYPED_DEFAULT_FREE,
+    .dsize = xml_sax_parser_memsize
+  },
+  .flags = RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED
+};
+
+static void
+noko_xml_sax_parser_start_document_callback(void *ctx)
+{
+  xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr)ctx;
+  VALUE self = (VALUE)ctxt->_private;
+  VALUE doc = rb_iv_get(self, "@document");
+
+  xmlSAX2StartDocument(ctx);
+
+  if (ctxt->standalone != -1) { /* -1 means there was no declaration */
+    VALUE encoding = Qnil ;
+    VALUE standalone = Qnil;
+    VALUE version;
+
+    if (ctxt->encoding) {
+      encoding = NOKOGIRI_STR_NEW2(ctxt->encoding) ;
+    } else if (ctxt->input && ctxt->input->encoding) { // unnecessary after v2.12.0 / gnome/libxml2@ec7be506
+      encoding = NOKOGIRI_STR_NEW2(ctxt->input->encoding) ;
+    }
+
+    version = ctxt->version ? NOKOGIRI_STR_NEW2(ctxt->version) : Qnil;
+
+    /* TODO try using xmlSAX2IsStandalone */
+    switch (ctxt->standalone) {
+      case 0:
+        standalone = NOKOGIRI_STR_NEW2("no");
+        break;
+      case 1:
+        standalone = NOKOGIRI_STR_NEW2("yes");
+        break;
+    }
+
+    rb_funcall(doc, id_xmldecl, 3, version, encoding, standalone);
+  }
+
+  rb_funcall(doc, id_start_document, 0);
+}
+
+static void
+noko_xml_sax_parser_end_document_callback(void *ctx)
+{
+  xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr)ctx;
+  VALUE self = (VALUE)ctxt->_private;
+  VALUE doc = rb_iv_get(self, "@document");
+
+  rb_funcall(doc, id_end_document, 0);
+}
+
+static void
+noko_xml_sax_parser_start_element_callback(void *ctx, const xmlChar *name, const xmlChar **atts)
+{
+  xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr)ctx;
+  VALUE self = (VALUE)ctxt->_private;
+  VALUE doc = rb_iv_get(self, "@document");
+
+  VALUE attributes = rb_ary_new();
+  const xmlChar *attr;
+  int i = 0;
+  if (atts) {
+    while ((attr = atts[i]) != NULL) {
+      const xmlChar *val = atts[i + 1];
+      VALUE value = val != NULL ? NOKOGIRI_STR_NEW2(val) : Qnil;
+      rb_ary_push(attributes, rb_ary_new3(2, NOKOGIRI_STR_NEW2(attr), value));
+      i += 2;
+    }
+  }
+
+  rb_funcall(doc,
+             id_start_element,
+             2,
+             NOKOGIRI_STR_NEW2(name),
+             attributes
+            );
+}
+
+static void
+noko_xml_sax_parser_end_element_callback(void *ctx, const xmlChar *name)
+{
+  xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr)ctx;
+  VALUE self = (VALUE)ctxt->_private;
+  VALUE doc = rb_iv_get(self, "@document");
+
+  rb_funcall(doc, id_end_element, 1, NOKOGIRI_STR_NEW2(name));
+}
+
+static VALUE
+xml_sax_parser_marshal_attributes(int attributes_len, const xmlChar **c_attributes)
+{
+  VALUE rb_array = rb_ary_new2((long)attributes_len);
+  VALUE cNokogiriXmlSaxParserAttribute;
+
+  cNokogiriXmlSaxParserAttribute = rb_const_get_at(cNokogiriXmlSaxParser, rb_intern("Attribute"));
+  if (c_attributes) {
+    /* Each attribute is an array of [localname, prefix, URI, value, end] */
+    int i;
+    for (i = 0; i < attributes_len * 5; i += 5) {
+      VALUE rb_constructor_args[4], rb_attribute;
+
+      rb_constructor_args[0] = RBSTR_OR_QNIL(c_attributes[i + 0]); /* localname */
+      rb_constructor_args[1] = RBSTR_OR_QNIL(c_attributes[i + 1]); /* prefix */
+      rb_constructor_args[2] = RBSTR_OR_QNIL(c_attributes[i + 2]); /* URI */
+
+      /* value */
+      rb_constructor_args[3] = NOKOGIRI_STR_NEW((const char *)c_attributes[i + 3],
+                               (c_attributes[i + 4] - c_attributes[i + 3]));
+
+      rb_attribute = rb_class_new_instance(4, rb_constructor_args, cNokogiriXmlSaxParserAttribute);
+      rb_ary_push(rb_array, rb_attribute);
+    }
+  }
+
+  return rb_array;
+}
+
+static void
+noko_xml_sax_parser_start_element_ns_callback(
+  void *ctx,
+  const xmlChar *localname,
+  const xmlChar *prefix,
+  const xmlChar *uri,
+  int nb_namespaces,
+  const xmlChar **namespaces,
+  int nb_attributes,
+  int nb_defaulted,
+  const xmlChar **attributes)
+{
+  xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr)ctx;
+  VALUE self = (VALUE)ctxt->_private;
+  VALUE doc = rb_iv_get(self, "@document");
+
+  VALUE attribute_ary = xml_sax_parser_marshal_attributes(nb_attributes, attributes);
+
+  VALUE ns_list = rb_ary_new2((long)nb_namespaces);
+
+  if (namespaces) {
+    int i;
+    for (i = 0; i < nb_namespaces * 2; i += 2) {
+      rb_ary_push(ns_list,
+                  rb_ary_new3((long)2,
+                              RBSTR_OR_QNIL(namespaces[i + 0]),
+                              RBSTR_OR_QNIL(namespaces[i + 1])
+                             )
+                 );
+    }
+  }
+
+  rb_funcall(doc,
+             id_start_element_namespace,
+             5,
+             NOKOGIRI_STR_NEW2(localname),
+             attribute_ary,
+             RBSTR_OR_QNIL(prefix),
+             RBSTR_OR_QNIL(uri),
+             ns_list
+            );
+}
+
+/**
+ * end_element_ns was borrowed heavily from libxml-ruby.
+ */
+static void
+noko_xml_sax_parser_end_element_ns_callback(
+  void *ctx,
+  const xmlChar *localname,
+  const xmlChar *prefix,
+  const xmlChar *uri)
+{
+  xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr)ctx;
+  VALUE self = (VALUE)ctxt->_private;
+  VALUE doc = rb_iv_get(self, "@document");
+
+  rb_funcall(doc, id_end_element_namespace, 3,
+             NOKOGIRI_STR_NEW2(localname),
+             RBSTR_OR_QNIL(prefix),
+             RBSTR_OR_QNIL(uri)
+            );
+}
+
+static void
+noko_xml_sax_parser_characters_callback(void *ctx, const xmlChar *ch, int len)
+{
+  xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr)ctx;
+  VALUE self = (VALUE)ctxt->_private;
+  VALUE doc = rb_iv_get(self, "@document");
+
+  VALUE str = NOKOGIRI_STR_NEW(ch, len);
+  rb_funcall(doc, id_characters, 1, str);
+}
+
+static void
+noko_xml_sax_parser_comment_callback(void *ctx, const xmlChar *value)
+{
+  xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr)ctx;
+  VALUE self = (VALUE)ctxt->_private;
+  VALUE doc = rb_iv_get(self, "@document");
+
+  VALUE str = NOKOGIRI_STR_NEW2(value);
+  rb_funcall(doc, id_comment, 1, str);
+}
+
+PRINTFLIKE_DECL(2, 3)
+static void
+noko_xml_sax_parser_warning_callback(void *ctx, const char *msg, ...)
+{
+  xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr)ctx;
+  VALUE self = (VALUE)ctxt->_private;
+  VALUE doc = rb_iv_get(self, "@document");
+
+  VALUE rb_message;
+
+#ifdef TRUFFLERUBY_NOKOGIRI_SYSTEM_LIBRARIES
+  /* It is not currently possible to pass var args from native
+     functions to sulong, so we work around the issue here. */
+  rb_message = rb_sprintf("warning_func: %s", msg);
+#else
+  va_list args;
+  va_start(args, msg);
+  rb_message = rb_vsprintf(msg, args);
+  va_end(args);
+#endif
+
+  rb_funcall(doc, id_warning, 1, rb_message);
+}
+
+PRINTFLIKE_DECL(2, 3)
+static void
+noko_xml_sax_parser_error_callback(void *ctx, const char *msg, ...)
+{
+  xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr)ctx;
+  VALUE self = (VALUE)ctxt->_private;
+  VALUE doc = rb_iv_get(self, "@document");
+
+  VALUE rb_message;
+
+#ifdef TRUFFLERUBY_NOKOGIRI_SYSTEM_LIBRARIES
+  /* It is not currently possible to pass var args from native
+     functions to sulong, so we work around the issue here. */
+  rb_message = rb_sprintf("error_func: %s", msg);
+#else
+  va_list args;
+  va_start(args, msg);
+  rb_message = rb_vsprintf(msg, args);
+  va_end(args);
+#endif
+
+  rb_funcall(doc, id_error, 1, rb_message);
+}
+
+static void
+noko_xml_sax_parser_cdata_block_callback(void *ctx, const xmlChar *value, int len)
+{
+  xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr)ctx;
+  VALUE self = (VALUE)ctxt->_private;
+  VALUE doc = rb_iv_get(self, "@document");
+
+  VALUE string = NOKOGIRI_STR_NEW(value, len);
+  rb_funcall(doc, id_cdata_block, 1, string);
+}
+
+static void
+noko_xml_sax_parser_processing_instruction_callback(void *ctx, const xmlChar *name, const xmlChar *content)
+{
+  xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr)ctx;
+  VALUE self = (VALUE)ctxt->_private;
+  VALUE doc = rb_iv_get(self, "@document");
+
+  VALUE rb_content = content ? NOKOGIRI_STR_NEW2(content) : Qnil;
+
+  rb_funcall(doc,
+             id_processing_instruction,
+             2,
+             NOKOGIRI_STR_NEW2(name),
+             rb_content
+            );
+}
+
+static void
+noko_xml_sax_parser_reference_callback(void *ctx, const xmlChar *name)
+{
+  xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr)ctx;
+  xmlEntityPtr entity = xmlSAX2GetEntity(ctxt, name);
+
+  VALUE self = (VALUE)ctxt->_private;
+  VALUE doc = rb_iv_get(self, "@document");
+
+  if (entity && entity->content) {
+    rb_funcall(doc, id_reference, 2, NOKOGIRI_STR_NEW2(entity->name), NOKOGIRI_STR_NEW2(entity->content));
+  } else {
+    rb_funcall(doc, id_reference, 2, NOKOGIRI_STR_NEW2(name), Qnil);
+  }
+}
+
+static VALUE
+noko_xml_sax_parser__initialize_native(VALUE self)
+{
+  xmlSAXHandlerPtr handler = noko_xml_sax_parser_unwrap(self);
+
+  handler->startDocument = noko_xml_sax_parser_start_document_callback;
+  handler->endDocument = noko_xml_sax_parser_end_document_callback;
+  handler->startElement = noko_xml_sax_parser_start_element_callback;
+  handler->endElement = noko_xml_sax_parser_end_element_callback;
+  handler->startElementNs = noko_xml_sax_parser_start_element_ns_callback;
+  handler->endElementNs = noko_xml_sax_parser_end_element_ns_callback;
+  handler->characters = noko_xml_sax_parser_characters_callback;
+  handler->comment = noko_xml_sax_parser_comment_callback;
+  handler->warning = noko_xml_sax_parser_warning_callback;
+  handler->error = noko_xml_sax_parser_error_callback;
+  handler->cdataBlock = noko_xml_sax_parser_cdata_block_callback;
+  handler->processingInstruction = noko_xml_sax_parser_processing_instruction_callback;
+  handler->reference = noko_xml_sax_parser_reference_callback;
+
+  /* use some of libxml2's default callbacks to managed DTDs and entities */
+  handler->getEntity = xmlSAX2GetEntity;
+  handler->internalSubset = xmlSAX2InternalSubset;
+  handler->externalSubset = xmlSAX2ExternalSubset;
+  handler->isStandalone = xmlSAX2IsStandalone;
+  handler->hasInternalSubset = xmlSAX2HasInternalSubset;
+  handler->hasExternalSubset = xmlSAX2HasExternalSubset;
+  handler->resolveEntity = xmlSAX2ResolveEntity;
+  handler->getParameterEntity = xmlSAX2GetParameterEntity;
+  handler->entityDecl = xmlSAX2EntityDecl;
+  handler->unparsedEntityDecl = xmlSAX2UnparsedEntityDecl;
+
+  handler->initialized = XML_SAX2_MAGIC;
+
+  return self;
+}
+
+static VALUE
+noko_xml_sax_parser_allocate(VALUE klass)
+{
+  xmlSAXHandlerPtr handler;
+  return TypedData_Make_Struct(klass, xmlSAXHandler, &xml_sax_parser_type, handler);
+}
+
+xmlSAXHandlerPtr
+noko_xml_sax_parser_unwrap(VALUE rb_sax_handler)
+{
+  xmlSAXHandlerPtr c_sax_handler;
+  TypedData_Get_Struct(rb_sax_handler, xmlSAXHandler, &xml_sax_parser_type, c_sax_handler);
+  return c_sax_handler;
+}
+
+void
+noko_init_xml_sax_parser(void)
+{
+  cNokogiriXmlSaxParser = rb_define_class_under(mNokogiriXmlSax, "Parser", rb_cObject);
+
+  rb_define_alloc_func(cNokogiriXmlSaxParser, noko_xml_sax_parser_allocate);
+
+  rb_define_private_method(cNokogiriXmlSaxParser, "initialize_native",
+                           noko_xml_sax_parser__initialize_native, 0);
+
+  id_start_document = rb_intern("start_document");
+  id_end_document = rb_intern("end_document");
+  id_start_element = rb_intern("start_element");
+  id_end_element = rb_intern("end_element");
+  id_comment = rb_intern("comment");
+  id_characters = rb_intern("characters");
+  id_xmldecl = rb_intern("xmldecl");
+  id_error = rb_intern("error");
+  id_warning = rb_intern("warning");
+  id_cdata_block = rb_intern("cdata_block");
+  id_start_element_namespace = rb_intern("start_element_namespace");
+  id_end_element_namespace = rb_intern("end_element_namespace");
+  id_processing_instruction = rb_intern("processing_instruction");
+  id_reference = rb_intern("reference");
+}