Использование XML в среде Delphi. Использование XML Document Object Model

Последнее время много внимания уделяется построение систем электронного бизнеса, или как их еще называют - B2B (business to business). Учитывая рекомендации по построению обменных потоковых систем координирующего интернет-технологий органа - WWW Consortium: акцент сделан в сторону XML-технологий и построение систем обмена XML-документами.

Преимущество использования XML в электронном бизнесе - высокая эффективность B2B систем при низких затратах на ее создание за счет четкого и наглядного представления структурированной информации, возможность использования современных сетевых протоколов и создания бизнес-систем реального времени.

Независимость представления информации в виде XML документов позволяет разным, участвующим в электронном бизнесе, фирмам производить независимое друг от друга ПО.

Во всех системах обмен, как правило, строится по одинаковой схеме, с использованием HTTP запросов. В качестве протокола защиты информации применяется протокол SSL (но это отдельная тема).

Один из возможных вариантов обработки XML сообщения является построение BIN/CGI (ISAPI)-приложений или COM (серверных) компонент, формирующих или обрабатывающих XML-документы.

С одной стороны, приложение выступает в качестве клиента, которое в режиме POST выдает HTTP запрос, с другой стороны, находится WEB сервер на стороне которого осуществляется обработка запроса и выдача ответа. В информационном обмене используются XML-документы.

Один из наиболее эффективных вариантов реализации - использование существующего XML-парсера, поддерживающего DOM модель. Такой парсер является дистрибутивной поставкой Win`98 или составной частью IE 4,7 и выше (для Win`95) и представляет COM сервер, находящийся в библиотеке msxml.dll.

Модель компонентных объектов (COM) - представляет инкапсулированные данные и методы в единую сущность и способ доступа к ним через систему интерфейсов. Средствами Delphi достаточно просто осуществить доступ к классам COM-объекта (в одном COM-сервере может быть включено несколько классов). Доступ к объектам осуществляется путем инициализации экземпляра класса через систему интерфейсов. Описание интерфейсов осуществляется языком определения интерфейсов (IDL), которое возможно осуществить средствами среды автоматически.

Средствами Delphi осуществляется импорт из COM-сервера msxml.dll , строится файлы описания интерфейса IDL и файл бинарного описания типов библиотеки - TLB. Данная операция осуществляется через системное меню: Project | Type Library Import: (рисунок 1). Далее появляется диалоговое окно (рисунок 2), в котором необходимо выбрать COM-объект (в нашем случае объект зарегистрирован под именем "Microsoft.XMLDom (Version 2.0)") и создать TLB-файл (кнопка Create Unit ). Используя TLB-файл, среда генерирует "паскалевский" файл описания COM-сервера - MSXML_TLB.pas

В файле MSXML_TLB.pas описаны все интерфейсы, константы и соклассы COM-сервера.

Для доступа к объектам COM-элемента, необходимо в директиве USES добавить имя файла описания библиотеки (MSXML_TLB.pas). Ниже представлена простейшая программа, использующая DOM стандартный анализатор msxml.dll, которая загружает XML-документ и отображает его в элементе текстового поля Memo1.

uses Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs, OleServer, MSXML_TLB, StdCtrls; type TForm1 = class (TForm) Button1: TButton; Memo1: TMemo; procedure Button1Click(Sender: TObject); end; var Form1: TForm1; implementation {$R *.DFM} Procedure TForm1.Button1Click(Sender: Tobject); // объявление сокласса объекта DOMDocument; var coDoc: CoDOMDocument; // класс, согласованный с интерфейсом IDOMDocument; var Doc: IXMLDOMDocument; begin // создание экземпляра объекта DOMDocument; Doc:= coDoc.Create; // вызов метода Load экземпляра объекта DOMDocument; Doc.load("data.xml"); // доступ к свойстве xml экземпляра объекта DOMDocument; Memo1.Text:=Doc.xml; end; end.

Концепция DOM - объектная модель документа

Каждый XML документ представляется в виде набора множества объектов (классов), с помощью которых возможен доступ к отдельным элементам (полям объекта). DOM - интерфейс описывает доступ как к простым объектам типа DOMString или CharacterData, так и к частям или отдельным элементам XML документа: DOMFragmentElement, DOMNode, DOMElement.

Ниже приведены самые важные свойства и методы объектов XMLDOMDocument, XMLDOMNode, XMLDOMNodeList. Необходимо отметить, что представленные ниже методы и функции объектов DOM модели (Document Object Model) используются Microsoft XML-анализатором msxml.dll и несколько шире, чем утвержденная W3C Консорциумом DOM модель.

Более полное описание интерфейса DOM объектов можно найти на

Объект XMLDOMDocument
Представляет верхний уровень объектной иерархии и содержит методы для работы с документом: его загрузки, анализа, создания в нем элементов, атрибутов, комментариев и т.д. .
Свойства
Async Свойство идентифицирующее текущий режим обработки
ParseError Возвращает ссылку на объект обработки ошибки XMLDOMParseError
Включение - выключение верификации документа.
url Возвращает URL документа
documentElement Содержит ссылку на корневой элемент документа в виде объекта XMLDOMElement.
Методы
load(url)
loadXML(xmlString)
Загружает XML документ,
save(objTarget) Сохраняет XML документ в файле
abort Прерывание процесса загрузки и обработки документа.
createAttribute (name) Создает для текущего элемента новый атрибут с указанным именем.
createNode(Type, name, nameSpaceURI) Создает узел указанного типа и названия
createElement(tagName) Создает элемент документа с указанным названием.
createTextNode(data) Создает текст внутри документа
getElementsByTagName(tagname) Возвращает ссылку на коллекцию элементов документа с заданным именем
nodeFromID(idString) Поиск элемента по идентификатору

Объект XMLDOMNode
Объект XMLDOMNode, реализующий базовый DOM интерфейс Node , предназначен для манипулирования с отдельным узлом дерева документа. Его свойства и методы позволяют получать и изменять полную информацию о текущем узле - его тип, название, полное название, его содержимое, список дочерних элементов и т.д.
Свойства
nodeName, baseName Возвращает название текущего узла.
prefix Возвращает Namespace префикс.
dataType Определяет тип содержимого текущего узла
nodeType, nodeTypeString Возвращает тип текущего узла:
attributes Возвращает список атрибутов текущего узла в виде коллекции XMLDOMNamedNodeMap.
text Возвращает содержимое текущего поддерева в виде текста
xml Возвращает XML-представление текущего поддерева.
nodeValue Возвращает содержимое текущего узла.
childNodes Возвращает список дочерних элементов в виде XMLDOMNodeList.
firstChild, lastChild Возвращает первый/последний дочерний элемент
previousSibling ,nextSibling Возвращает предыдущий /следующий сестринский элемент.
parentNode Содержит ссылку на родительский элемент.
ownerDocument Возвращает указатель на документ, в котором находится текущий узел.
Методы
appendChild(newChild) Добавляет текущему узлу новый дочерний элемент.
insertBefore(newChild, refChild) Вставляет дочерний узел, располагая его в текущем поддереве "левее" узла, указанного параметром refChild.
cloneNode (deep) Создание копии текущего элемента.
getAttribute (name)
getAttributeNode (name)
setAttribute(name, value)
setAttributeNode(XMLDOMAttribute)
Доступ к атрибутам (создание, чтение, запись) объекта. Name - имя атрибута, value - его значение. Возращает значение объект XMLDOMAttribute.
replaceChild(newChild, oldChild) removeChild(oldChild) Замена объекта oldChild текущего списка дочерних объектов на newChild. Удаление объекта oldChild
selectNodes(patternString) selectSingleNode(patternString) Возвращает объект XMLDOMNodeList, выбранное по шаблону поиска или первый узел
transformNode(stylesheet)
transformNodeToObject(stylesheet, outputObject)
Назначает стилевую таблицу для поддерева текущего узла и возвращает строку - результат обработки. В качестве параметра передается ссылка на объект DOMDocument, в котором находятся XSL инструкции.

Использование XML в бизнесе.

Для более ясной картины необходимо пояснение, а зачем все это нужно с тем, что бы понять, как это работает:

При построении B2B или корпоративной ERP системы, при организации информационного обмена XML-документами между предприятиями или филиалами пр-я, используются эффективно себя зарекомендовавшая система передачи информации на основе имеющихся WEB серверов по HTTP протоколам.

С одной стороны, приложение выступает в качестве клиента, которое в режиме POST выдает HTTP запрос, с другой стороны, находится WEB сервер, на стороне которого осуществляется обработка запроса и выдача ответа. В качестве обмена используются XML-документы.

Например, в простой корпоративной ERP системе бухгалтерской программе (АСУ Бухучет) необходимо сформировать некий запрос на выписку накладной и передать его в филиал, который имеет склад (АСУ Склад). АРМ Аналогичная постановка задачи при создании В2В системы, когда Предприятие А запрашивает наличие продукции (делает заказ на приобретение) у Поставщика В.

Предприятие А и его программа выступает в качестве клиента. Склад обслуживает Поставщик В, у которого находится складской комплекс БД на SQL сервере. Обмен осуществляется через корпоративный WEB сервер Поставщика В.

Ниже представлен следующий типовой алгоритм обмена:


Рисунок 3.
  1. Предприятие А инициирует процесс А (заказ продукции), который выступает в качестве WEB-клиента.
  2. Процесс А формирует XML документ (например запрос- накладная) и передает его как POST запрос http на WEB сервер Поставщика В. В качестве URI - используется идентификатор ресурса обрабатывающего приложения. URI может быть одинаковым как для всех типов документов, либо индивидуальным для каждого типа. Все зависит от структуры B2B (WEB) сервера.
  3. WEB сервер анализирует запрос и порождает серверный Процесс В , передавая в качестве параметра тело XML документа.
    Процессе В запускается WEB-сервером и обрабатывается либо как ASP страница,CGI (ISAPI) - приложение или JAVA севрлет (серверное приложение)
  4. Процесс В - формирует запрос на SQL-сервер базы данных.
  5. SQL-сервер производит необходимые операции в БД, формирует ответ и возвращает его Процессу В .
  6. По ответу от SQL-сервера Процесс В формирует XML документ (ответ) и возращает его как на ответ на http запрос клиентскому приложению.
  7. Далее, в зависимости от ситуации на стороне клиента формируется либо новый http запрос, либо заканчивается сеанс.

Несколько слов об организации документооборота.

Общим правилом разработки системы обмена XML документами является:

  • во-первых - разработка схемы потоков электронных документов и их структуры;
  • во-вторых - разработка таблиц функций процессов (подпроцессов) т.е. какую функцию по отношению к какому XML-документу будет реализовывать каждый процесс.

Каждый XML документ, подобно HTML документу, должен состоять из заголовка сообщения (информация заключенная тагами) и тела сообщения (для запроса эта информация обрамленная тагами для ответа на запрос). Для того, чтобы XML документ был правильно сформирован, необходимо его две составные части "Заголовок" и "Запрос" обрамить тегами, например. Вид типового документа представлен ниже:

Заголовок (Рисунок 4), в отличие HTML документа, должен содержать разного рода служебную информацию, в том числе информацию о типе передаваемого документа и процессе его обработки. В информационную обработку поступает тело документа, т.е. содержательная часть обрамленная тагами. Следует отметить, что структуру заголовков должна быть единой для всех типов документов.

Для запущенного сервером Процесса, алгоритм обработки предпочтительно (но не обязательно) строить следующим образом:


Рисунок 6.

Некоторые принципиальные моменты при создании клиентской части

Как уже пояснялось, при создание XML-документа используется его представление в виде DOM модели. Ниже приведен пример части текста Delphi программы создания заголовка xml сообщения.

procedure TThread1.HeaderCreate(Sender: Tobject); var // объявление сокласса, необходим для создания coDoc: CoDomDocument ; // объекта XMLDomDocument Doc: DomDocument ; r: IXMLDOMElement; Node: IXMLDOMElement; // DOMText txt: IXMLDOMText; // DOMAttribute attr: IXMLDOMAttribute; begin // создание документа DOM Doc:=coDoc.Create; Doc.Set_async(false); // начальная инициация DOM документа Doc.LoadXML("
"); // создание DOMElement (таг <Sender >) Node:= Doc.createElement ("Sender"); // создание текстового узла "ООО "Тайфун" " txt:= Doc.createTextNode("ООО "Тайфун""); // присвоение узлу <Sender > значение // текстового узла "ООО "Тайфун" " Node.appendChild(txt); // добавление элемента <Sender > в корень документа как дочернего r.appendChild(Node); <From > Node:= Doc.createElement ("From"); txt:= Doc.createTextNode("http://tayfun.ru/xml/default.asp"); Node.appendChild(txt); r.appendChild(Node); // аналогичные операции для тага <To > Node:= Doc.createElement ("To"); txt:= Doc.createTextNode("http://irbis.ru"); Node.appendChild(txt); r.appendChild(Node); // создание DOMElement () Node:= Doc.createElement ("TypeDocument"); // создание узла XMLDOMAttribute Att:= Doc.createAttribute ("Id ", " Order"); // Node.appendChild(Att); r.appendChild(Node); end;

Следует отметить, что объявление переменной coDoc: CoDomDocument и Doc: DomDocument , а также ее создание методом Create (Doc:=coDoc.Create;) осуществляется один раз. Объявление переменной находится в секции описания глобальных переменных, а не в локальной процедуре, как было продемонстрировано для наглядности в данном примере (т.е. одна глобальная переменная типа DomDocument на один программный модуль).

Результатом работы вышеприведенной программы будет созданный заголовок, применительно к нашему примеру xml-документа: изображен на рисунке 5.


Рисунок 5.


Рисунок 6.

Основное преимущество передачи информации в виде XML-документов в том, что существует возможно формировать сообщение, используя независимые структуры таблиц в СУБД как на принимаемой, так и на передаваемой стороне. Используя наш пример, пусть требуется передать информацию об инвойсах Предприятия А, из СУБД имеющий структуру, изображенную на рисунке 6

Для формирования xml-документа, содержащего инвойс первоначально строится SQL-запрос (запрос А) с информацией о самом инвойсе:

SELECT * FROM Invoice_General WHERE InvoiceNum = :num SELECT Goods,Qulity,Price, HZ_cod FROM Goods WHERE InvoiceNum = :num // :num - параметр, который задает номер инвойса.

Ниже представлена часть программы, формирующей тело xml-документа:

procedure TThread1.DataBodyCreate(Sender: Tobject); var // объявление сокласса и объекта XMLDomDocument //coDoc: CoDomDocument ; // должно быть глобальным, для всего модуля. //Doc: DomDocument ; // объявление объектов DOMElement r: IXMLDOMElement; // DOMElement; Node, Node2: IXMLDOMElement; Node3, Node4: IXMLDOMElement; // DOMText txt: IXMLDOMText; str: String; // InvoiceNumber: integer; - глобальная переменная - // имеет значение 987654 // queryA, queryB: String; - глобальная переменная, // имеет значение,соответствующее запросу // queryA - запрос А генеральная информацией об инвойсе // queryB - запрос B информация о товарах, описываемых в // инвойсе (см. текст) begin Query.Close; // см. по тексту "запрос А" Query.Text:= queryA; // выполнение запроса Query.ExecSQL; Query.Open; // получение адреса корневого элемента r:=Doc.Get_documentElement; Node2:= Doc.createElement (" Request "); // создание DOMElement (таг) Node:= Doc.createElement ("Invoice"); // добавление элемента в корень r.appendChild(Node2); // добавление элемента в Node2. appendChild(Node); // создание DOMElement (таг) Node3:= Doc.createElement ("Depurture") ; // добавление элемента в Node. appendChild(Node3); // обращение к полю "Depurture" запроса str:= Query.FieldByName("Depurture").AsString; // создание текстового узла = значению поля // присвоение узлу значение // текстового узла, переменной str Node.appendChild(txt); // аналогичные операции для тага , , // , // (поле DB "Consignee") Node:= Doc.createElement ("Destination"); // имя поля БД может и не совпадать с именем str:= Query.FieldByName("Consignee ").AsString; // тага, в этом преимущество использования txt:= Doc.createTextNode(str); // DOM интерфейса перед СУБД, имеющим поддержку XML-интерфейса, // типа ORACLE 8i или Ms SQL 2000 Node.appendChild(txt); ... // формирование запроса на спецификацию по товарам // закрывает запрос для доступа Query.Close; // см. по тексту "запрос В", информац. О товарах Query.Text:= queryВ; // присваивание значения параметров Query.Params.AsInteger:= InvoiceNumber; // выполнение запроса Query2.ExecSQL; // открытие доступа к данным запроса Query.Open; // создание DOMElement (таг) Node3:= Doc.createElement (" Imems") ; // добавление элемента в Node. appendChild(Node3); // цикл по всем строкам запроса while not Eof.Query do begin Node4:= Doc.createElement ("Imem"); // добавление элемента в Node3.appendChild(Node4); // формирование данных для тага str:= Query.FieldByName("Price").AsString; txt:= Doc.createTextNode(str); Node.appendChild(txt); ... // аналогичные операции для тагов , , end; end;

В результате выполнения данной процедуры формируется следующий текст XML-документа:


Для формирования запроса используется метод Open объекта IXMLHttpRequest :

procedure Open(const bstrMethod, - тип метода ="POST" bstrUrl, - Url адрес сервера varAsync, - режим связи асинхронный/синхронный = true bstrUser, - имя пользователя для аутентификации bstrPassword) - пароль

Создании серверной части обработки документа

Как было отмечено ранее, обработка HTTP запроса может осуществляться либо CGI-приложениями, либо Java-сервлетами. Возможен и вариант написания ASP-страниц. Но в этом случае передача данных возможна только методом "GET" через строку запроса. Хотя, обработка HTTP запроса ASP-страниц работает более эффективнее, чем CGI-приложением. Однако, на мой взгляд, без разницы, как обрабатывать, а важнее решить вопрос - как построить программу обработки, а не какими средствами.

Если из предыдущей главы мы рассмотрели варианты формирования XML-документ, то задача серверного приложения обратная - разбор XML-документов. Ниже представлена часть программы, осуществляющей разбор xml-документа:

procedure Tthread1.DataParser(Sender: Tobject); var // объявление объектов DOMElement r,FNode: IXMLDOMElement; Str,Filename: String; parm: String; // объявление сокласса и CoDocXML, CoDocXSL, CoDocResult: CoDomDocument ; // объекта XMLDomDocument XMLDoc, XSLDoc, ResultDoc: DomDocument ; // HttpStr: String; - глобальная переменная, содержащая строку HTTP запроса Begin XMLDoc:=coDocXML.Create; XMLDoc.LoadXML(HttpStr); // получение адреса корневого элемента r:=Doc.Get_documentElement; // получение значения элемента FNode:= r.SelectSingleNode("//TypeDocument"); // получение значения атрибута id="Order" FileName:= FNode.GetAttibute("id"); // и формирование имени файла Order.xsl FileName:= FileName+".xsl"; // создание документа XSLDoc XSLDoc:=coDocXSL.Create; XSLDoc.LoadXML(FileName); // создание документа XMLDoc ResultDoc:=coDocResult.Create; // установка синхронного режима обработки ResultDoc.Set_async(false); // установка проверки разбора ResultDoc.validateOnParse:= true; // разбор XMLDoc по XSL-шаблону XMLDoc.transformNodeToObject(XSLDoc, ResultDoc); // переменной Str присваивается текстовое значение // результирующего документа. Str:= ResultDoc.text; // поиск элемента FNode:= r.SelectSingleNode("//InvoiceNumber"); // и получение значения элемента parm:= FNode.text; // закрывает запрос для доступа Query.Close; Query.Text:= Str; // присваивание значения параметра Query.Params.AsString:= parm; // выполнение запроса Query.ExecSQL; end;

Вся изюминка разбора заключается в применении XSL-шаблона, который сформирован для каждого типа документа индивидуально. Результатом разбора является строка SQL-запроса. В последствие выполнение сформированной строки SQL-запроса осуществит необходимые изменения данных в СУБД.

Преимущество использования разбора через шаблон еще и в том, что получается некая гибкость данных, и получается полная независимость работы алгоритма от программного кода. Ниже приведен используемый для обработки документа типа ORDER текст XSL-шаблона:

INSERT into TABREG (FROM, TO, TYPEDOC,body) VALUES(" ", "", "") INSERT into GOODS (invoiceNumber, name, price, quality) VALUES(" :num", "", "", " ")

Поясняя вышеприведенный пример, надо отметить, что использование пары тагов и носит формальный характер, т.к. после разбора в результирующем XML-документе формально должен присутствовать хотя бы один узел. Метод ResultDoc.text присваивает текстовое значение полученного в ходе разбора XML-документа ResultDoc. В этом случае значением является все то, что обрамлено пары тегов и, т.е. сформированный нами SQL-запрос.

Другой особенностью написания программы надо отметить возможность использования SQL-параметра :num. Использование параметра позволяет упростить текст xsl-шаблона. Определение значение соответствующих элементов узлов XML-документа определяется первоначально выбора по имени соответствующего узла, например:

Коротко об XSL

Аббревиатура XSL происходит от eXtensible Stylesheet Language - язык форматирования таблиц стилей (XML данных). Как понятно из заголовка eXtensible Stylesheet Language (XSL) используется для форматирования XML данных. По определению W3C XSL состоит из двух частей:

  • XSLT - XSL Transformation. Язык, используемый для преобразования или форматирования (трансформирования) XML документов. Таким образом, при помощи XSLT мы можем получить разные разрезы множества данных и формы представления данных.
  • Элементы форматирования. К этим элементам относятся все элементы типографического оформления данных, после их обработки их при помощи XSL. Используется только для формирования HTML страниц.

При помощи XSLT мы можем отобрать нужные нам данные из XML файла, и оформить их в виде для предоставления пользователю. Например, в нашем случае мы преобразовали XML данные в виде SQL запроса. Классическое применение XSL - это, как правило форматирование данных в виде HTML страниц или более редкое представление в виде RTF файлов.

XSL файл описывает шаблон (template), согласно которому будет совершаться преобразование XML данных. Возвращаясь к xsl-шаблонам, в XSLT можно выделить следующие элементы (директивы):

XSL-директивы описание
xsl:apply-templates Директива, указывающая на применение соответствующих шаблонов атрибуту select="имя шаблона"
xsl:attribute создает дерево атрибутов и добавляет его в выходной элемент, параметр name="имя атрибута", namespace - URI на пространство имен (префикс пространства имен)
xsl:call-template вызывает шаблон, атрибуту name=" URI на шаблон"
xsl:choose
xsl:when
xsl:otherwise
осуществление выбора по условию xsl:when expr="вычисление выражения на script ",
language="language-name"
test= "вычисляемое выражение"
xsl:comment генерирует комментарий в выходной документ
xsl:copy
xsl:copy-of
копирует текущей узел в выходной источник или вставляет фрагмент документа в узел, где атрибут select="имя узла источника"
xsl:element создает выходной элемент по имени, атрибут name="имя элемента", namespace="uri ссылка на пространство имен"
xsl:for-each повторно применяет шаблон ко всем узлам списка узлов, атрибут select задает список узлов
xsl:if проверка условия, задается атрибутом test в виде выражения
xsl:include включает внешний шаблон, атрибут href = "URI reference"
xsl:output специфицирует выходной результат, атрибут method может иметь значения "xml", "html" или "text"
xsl:param специфицирует значение параметров, атрибут name="имя параметра", select = "значение"
xsl:processing-instruction создает инструкцию обработки, атрибут name="имя процесс инструкции"
xsl:sort сортирует множество узлов, атрибуты select = "имя узла", data-type = тип данных {"text" | "number" | Qname}, order = направление сортировки {"ascending" | "descending"}
xsl:stylesheet определяет документ xsl-шаблонов, является корневым элементом для XSLT
xsl:template определяет xsl-шаблон, атрибут name= " URI префикс на имя шаблона", match= "указание на узел, к которому применяется шаблон"
xsl:text генерирует текст в выходной поток, атрибут disable-output-escaping = "yes" или "no", указывает на возможность генерации символов ESC
xsl:value-of вставляет значение выбранного узла как текст, атрибут select= "указатель на узел" из которого берут значение
xsl:variable специфицирует значение границ переменных, атрибут name = "имя переменной", select = "вычисление значения переменной"
xsl:with-param применяет параметр к шаблону, атрибут name ="имя параметра", select = выражение для вычисления текущего контекста, значение по умолчанию "."

Заключение

В заключение, необходимо отметить, что использование стандартного XML-парсера msxml.dll является не единственным средством разбора и создания XML-документов. Например, для создание XML документов эффективно использовать компоненты TPageProduser и TТableProduser . Но, данная статья лишь подчеркивает широту и возможность применения на практике DOM модели.

Автор будет очень благодарен за отзывы об актуальности темы, общем содержании, стиле изложения, а также всем остальным комментариям, которые помогут в дальнейшем улучшить качество написания сборника статей и выпуску книги, освещающую тему практической стороны использования XML-документов в электронной коммерции. Более подробную информацию о практической стороне применения электронных документов можно почерпнуть на авторском сайте www.eDocs.al.ru Также на авторском сайте планируется разместить исходные тексты и примеры.

Сегодня решил немного продолжить тему работы с XML-RPC в WordPress. Как это обычно со мной бывает, идея родилась в момент чтения случайного блога, вздумалось взглянуть на работу с постами в блоге и, заодно, попробовать написать что-нибудь под свои нужды.

Естественно программу я сегодня не выложу, но некоторые выкладки, листинги и идеи в посте будут присутствовать.

Вкратце работу с XML-RPC я рассматривал в посте "XML-RPC в Delphi . Первое знакомство с WordPress изнутри." Сегодня попробуем продвинуться дальше в своей работе и использовать несколько взаимосвязанных методов для получения определенной информации из блога.

Конкретизируем цель на сегодня : необходимо получить данные по постам в блоге, используя доступные методы из API WordPress .

Для достижения поставленной цели нам понадобятся следующие модули Delphi: XMLIntf , xmldom , XMLDoc и библиотека synapce или компонент Indy idHTTP (кому как угодно).

1. Тестируем соединение с блогом.

Полагаю, что первое, что следует сделать - это проверить корректность работы с блогом на предмет следующих возможных ошибок:

1. В блоге отключена возможность использования XML-RPC

2. Пользователь предоставил некорректные данные (url, логин или пароль).

Для проверки возможности работы с XML-RPC в блоге достаточно воспользоваться методом demo.sayHello . Если ответом будет строка "Hello" , значит всё в порядке и можно приступать к следующему шагу проверки. Для выполнения этой проверки нам потребуется выполнить три простенькие задачки:

  • сформировать правильный XML-документ
  • отправить запрос на сервер и получить ответ
  • проанализировать ответ

Формируем XML-документ, который должен выглядеть так:

demo.sayHello

test

Для этого воспользуемся интерфейсом IXMLDocument:

var doc: IXMLDocument; //документ

Root: IXMLNode; //корневой узел

inherited Create;

doc:=NewXMLDocument();//создаем пустой документ

Root:=Doc.CreateElement("methodCall","");//добавляем корневой узел

Doc.DocumentElement:=Root;

Root.AddChild("methodName").NodeValue:="demo.sayHello";//добавляем название метода

Root.AddChild("params").AddChild("param").AddChild("value").AddChild("string").NodeValue:="test";//записываем параметры метода

Так как сам по себе XML-документ достаточно простой, то я позволил себе немного "похалявить" и последней строкой кода записал сразу все узлы и значение единственного параметра для нашего метода.
Теперь можно отправить документ на сервер и получить ответ:

with THTTPSend.Create do

Doc.SaveToStream(Document);//записываем документ в тело запроса

if HTTPMethod("POST",aURL) then

//запрос успешно отправлен и получен ответ

//запрос не удался

Что мне нравится в Synapce , так это то, что не требуется лишних "телодвижений" в плане заполнения заголовков Content-Length , Content-Type и пр. Конечно никто не мешает заполнить все возможные заголовки самому, но можно обойтись и так, как показал я выше - всё на автомате.
Двигаемся дальше - проводим анализ ответа.
Позволю себе напомнить Вам, что удачная отправка запроса на сервер никак не свидетельствует о том, что мы успешно получили доступ к XML-RPC блога. Удачная отправка запроса свидетельствует только о том, что мы отправили запрос и получили ответ, а _что_ находится в ответе ошибка или нет - мы пока не знаем.
Чтобы пока не забивать голову лишними способами и методами парсинга ответа от сервера, предлагаю в данном случае остановиться на применении простой проверки:

В соответствии со спецификацией XML-RPC сообщения об ошибках содержится в узле с названием fault. Следовательно, применительно к нашему случаю достаточно проверить наличие такого узла в ответном XML-документе - если его нет, то значит проверка прошла успешно, был сформирован корректный запрос и XML-RPC работает исправно.
Переходим к следующему шагу - проверке на корректность предоставленных данных пользователем и возможности работы пользователя с XML-RPC блога.
С XML-RPC блога имеет право работать только администратор, следовательно, необходимо узнать кто пробует получить доступ. Для этого воспользуемся методом wp.getUsersBlogs . Параметрами метода являются логин и пароль.
Но прежде, чем приступим к отправке запроса и получению ответа, думаю, стоит немного задуматься о будущем и предусмотреть работу с ошибками, формирование документов и т.д.
В предыдущей проверке, можно сказать, было баловство - простейших вариант работы типа:
отправил/получил/тут_же_разобрал/забыл/пошел_дальше.
Так как я планирую развивать модуль по работе с API WordPress и дальше, то есть смысл определиться со следующими моментами в работе:

1. Сформировать "скелет" документа

2. Записать в документ все необходимые параметры, учитывая типы данных

3. Отправить запрос и получить ответ от сервера

4. Проанализировать ответ и, если в ответе содержится сообщение об ошибке, то правильно его прочитать

Все эти четыре шага я сделал отдельными методами класса. Под "скелетом" документа я понимаю следующее содержимое:

MethodName

То есть часть документа, содержащая имя метода и узел params без содержимого. Дальше на останется только правильно заполнить список параметров. Чем мы сейчас и займемся.

Всего в XML-RPC предусмотрено использование шести простых типов данных:

1. int и i4 - целые числаinteger)

2. double - дробные числа

3. string - строки

4. base64 - закодированная строка

5. dateTime.iso8601 - дата/время

Заводим новый тип данных:

TSimpleType = (tsInt, tsI4, tsString, tsDouble, tsDateTime, tsBase64, tsBoolean);

С помощью значений этого типа будем определять тэг для значения параметра.

Так как операции создания "скелета" документа и добавления параметров метода разнесены по разным функциям, то создадим ещё один вспомогательный тип данных:

PXMLDocument = ^IXMLDocument;

Теперь сам метод добавления параметра в документ:

procedure TBlog.SetParam(SimpleType: TSimpleType; Value: string;

Document: PXMLDocument);

var Root: IXMLNode;

if Document^.IsEmptyDoc then Exit;//документ пуст

Root:=Document^.DocumentElement.ChildNodes.FindNode("params");

if Root=nil then Exit; //узел не найден

case SimpleType of

tsInt:Root.AddChild("param").AddChild("value").AddChild("int").NodeValue:=Value;

tsI4:Root.AddChild("param").AddChild("value").AddChild("i4").NodeValue:=Value;

tsString:Root.AddChild("param").AddChild("value").AddChild("string").NodeValue:=Value;

tsDouble:Root.AddChild("param").AddChild("value").AddChild("double").NodeValue:=Value;

tsDateTime:Root.AddChild("param").AddChild("value").AddChild("dateTime.iso8601").NodeValue:=Value;

tsBase64:Root.AddChild("param").AddChild("value").AddChild("base64").NodeValue:=Value;

tsBoolean:Root.AddChild("param").AddChild("value").AddChild("boolean").NodeValue:=Value;

Этот метод работает только в случае записи простого типа. При работе со структурами необходимо доработать алгоритм.

Теперь про анализ сообщений об ошибке. Рассмотрим пример того, как выглядит сообщение об ошибке в XML-RPC:

faultCode

403

faultString

Bad login/pass combination.

Сообщение об ошибке приходит нам в структуре. Причём, если считать, что теги member нумеруются от нуля, то каждый чётный элемент структуры - это код ошибки, а нечётный - текст ошибки. Следовательно метод обработки сообщений об ошибке может выглядеть так:

function TBlog.ParseErrors(aDocument: PXMLDocument): TStringList;

List: IDOMNodeList;

List:=aDocument^.DOMDocument.getElementsByTagName("member");

Result:=TStringList.Create;

for i:=0 to List.length-1 do

0:code:=(List.item[i].lastChild.firstChild as IDOMNodeEx).text; //чётный элемент - читаем код ошибки

1://нечётный элемент - читаем текст ошибки и записываем результат

Result.Add(code+" "+(List.item[i].lastChild.firstChild as IDOMNodeEx).text);

Здесь код и текст ошибки записывается в TStringList. Думаю, что при необходимости можно легко сделать, чтобы код и текст читались в разные списки или массивы. Нам пока это не требуется.

Отправку документа мы уже рассматривали, поэтому сразу привожу метод проверки данных на корректность:

function TBlog.CheckUserAccess(const aURL, aUser, aPassword: string;var Error:string): boolean;

var Doc:IXMLDocument;

Doc:=GetDocument("wp.getUsersBlogs"); //создали "скелет"

//добавляем параметры

SetParam(tsString,aUser,@Doc);

SetParam(tsString,aPassword,@Doc);

SendQuery(@Doc,aURL); //отправляем запрос

if not Doc.IsEmptyDoc then //если документ записан корректно

if Doc.DocumentElement.ChildNodes.FindNode("fault")<>nil then //есть сообщение об ошибке

Если пришло сообщение об ошибке, то записываем сообщение в переменную Error. В данном случае структура содержит только одно сообщение об ошибке - поэтому я так легко прописал:

Error:=ParseErrors(@Doc).Strings;

Итак, две проверки сделаны и мы определили, что XML-RPC включен и работает исправно, а пользователь ввёл корректные данные логина и пароля и может работать с API WordPress. Что дальше? А дальше начинаем основную работу - получаем данные по комментариям в блоге.

2. Получаем данные о постах блога.

Итак, что предоставляет в наше распоряжение WordPress. Сначала сделаем кратки обзор методов из xmlrpc.php.

wp.getPostStatusList - выводит значения для статуса поста. По сути на выходе будем имеет четыре строки: "draft", "pending", "private", "publish".

Пока этот метод нам бесполезен.

blogger.getRecentPosts - эта функция уже из API Blogger, но поддерживается в WordPress. На выходе будем иметь последние посты блога, включая весь контент поста.

Можно использовать метод, НО работа программы будет замедлена так как придётся "тягать" по Сети пост целиком. А если попробуем получить список постов блога целиком, то, видимо придётся ложиться спать, не дождавшись результата. Следовательно - пока оставляем метод в стороне.

metaWeblog.getRecentPosts - аналогично предыдущему методу.

mt.getRecentPostTitles - метод из MovableType API. Судя по названию - то, что нам надо. Смотрим описание метода.

Метод возвращает список, содержащий заголовки постов блога. При этом контент в список не записывается.

Входные параметры:

  • String blogid
  • String username
  • String password
  • int numberOfPosts

blogid всегда равен 1 (см. описание в xmlrpc.php)

numberOfPosts - количество постов, которые необходимо вывести в список. Если параметр имеет значение больше, чем количество постов в блоге, то метод возвращает список всех постов.

Осталось узнать, что из себя представляет этот список. А на выходе мы будем иметь массив структур, включающий в себя:

  • дату создания элемента
  • userid
  • postid
  • заголовок.

Замечательно. Воспользуемся этим методом, а заодно научимся анализировать сложные структуры ответа.

Про создание запроса, думаю, писать не стоит. Процедура аналогична той, что рассмотрена выше. А на анализе ответа сервера остановимся подробно. Стем как выглядит тип struct (структура) мы познакомились при парсинге ответа, содержащего ошибку авторизации. Посмотрим, что из себя представляет массив.

Массивы не имеют названия и описываются тегом . Он содержит один элемент и один или несколько дочерних элементов , где задаются данные. В качестве элементов массива могут выступать любые другие типы в произвольном порядке, а также другие массивы - что позволяет описывать многомерные массивы. Так же можно описывать массив структур. Например, массив из четырех элементо будет выглядеть так:

34

Привет, Мир!

0

-34

У нас на выходе из метода mt.getRecentPostTitles
будет содержаться массив структур , причём одна структура - это информация по одному посту блога. Следовательно, чтение данных по постам блога можно условно разделить на следующие шаги:

1. Выделяем из XML-документа все элементы value

2. В каждом value читаем все элементы member

3. каждый второй дочерний элемент у member - данные по посту, которые необходимо запомнить.

Начнем сразу с обработки ответа. Вводим новый тип данных:

TBlogPost = packed record

user_id: integer;

dateCreated: string;//пока будем хранить дату "как есть"

TBlogPosts = array of TBlogPost;

Обрабатываем ответ сервера.

//т.к. в массиве всего 1 тэг data, то можно получить список элементов так

Values:=Doc.DOMDocument.getElementsByTagName("data").item.childNodes;

SetLength(Result,Values.length);

for i:= 0 to Values.length-1 do

Members:=Values[i].firstChild.childNodes;//получили все members для 1 value

for j:=0 to Members.length - 1 do

with Result[i]do

0:dateCreated:=(Members[j].lastChild.firstChild as IDOMNodeEx).text;

1:user_id:=StrToInt((Members[j].lastChild.firstChild as IDOMNodeEx).text);

2:id:=StrToInt((Members[j].lastChild.firstChild as IDOMNodeEx).text);

3:title:=(Members[j].lastChild.firstChild as IDOMNodeEx).text;

Соответственно, если получено сообщение об ошибке, то можно воспользоваться рассмотренной ранее функцией.

На сегодня всё. В следующий раз продолжим работу с API и попробуем получить все комментарии из блога.

Сегодня решил немного продолжить тему работы с XML-RPC в WordPress. Как это обычно со мной бывает, идея родилась в момент чтения случайного блога, вздумалось взглянуть на работу с постами в блоге и, заодно, попробовать написать что-нибудь под свои нужды.

Естественно программу я сегодня не выложу, но некоторые выкладки, листинги и идеи в посте будут присутствовать.

Вкратце работу с XML-RPC я рассматривал в посте “ ” Сегодня попробуем продвинуться дальше в своей работе и использовать несколько взаимосвязанных методов для получения определенной информации из блога.

Конкретизируем цель на сегодня : необходимо получить данные по постам в блоге, используя доступные методы из API WordPress .

Для достижения поставленной цели нам понадобятся следующие модули Delphi: XMLIntf , xmldom , XMLDoc и библиотека synapce или компонент Indy idHTTP (кому как угодно).

1. Тестируем соединение с блогом.

Полагаю, что первое, что следует сделать - это проверить корректность работы с блогом на предмет следующих возможных ошибок:

  1. В блоге отключена возможность использования XML-RPC
  2. Пользователь предоставил некорректные данные (url, логин или пароль).

Для проверки возможности работы с XML-RPC в блоге достаточно воспользоваться методом demo.sayHello . Если ответом будет строка “Hello” , значит всё в порядке и можно приступать к следующему шагу проверки. Для выполнения этой проверки нам потребуется выполнить три простенькие задачки:

  • сформировать правильный XML-документ
  • отправить запрос на сервер и получить ответ
  • проанализировать ответ

Формируем XML-документ, который должен выглядеть так:

demo.sayHello test

Для этого воспользуемся интерфейсом IXMLDocument:

[ ... ] var doc: IXMLDocument; //документ Root: IXMLNode; //корневой узел begin inherited Create; doc: = NewXMLDocument() ; //создаем пустой документ Root: = Doc. CreateElement ("methodCall" , "" ) ; //добавляем корневой узел Doc. DocumentElement : = Root; Root. AddChild ("methodName" ) . NodeValue : = "demo.sayHello" ; //добавляем название метода Root. AddChild ("params" ) . AddChild ("param" ) . AddChild ("value" ) . AddChild ("string" ) . NodeValue : = "test" ; //записываем параметры метода [ ... ]

Так как сам по себе XML-документ достаточно простой, то я позволил себе немного “похалявить” и последней строкой кода записал сразу все узлы и значение единственного параметра для нашего метода.
Теперь можно отправить документ на сервер и получить ответ:

[ ... ] with THTTPSend. Create do begin Doc. SaveToStream (Document) ; //записываем документ в тело запроса if HTTPMethod("POST" , aURL) then begin //запрос успешно отправлен и получен ответ end else begin //запрос не удался end ; end ; [ ... ]

Что мне нравится в Synapce , так это то, что не требуется лишних “телодвижений” в плане заполнения заголовков Content-Length , Content-Type и пр. Конечно никто не мешает заполнить все возможные заголовки самому, но можно обойтись и так, как показал я выше - всё на автомате.
Двигаемся дальше - проводим анализ ответа.
Позволю себе напомнить Вам, что удачная отправка запроса на сервер никак не свидетельствует о том, что мы успешно получили доступ к XML-RPC блога. Удачная отправка запроса свидетельствует только о том, что мы отправили запрос и получили ответ, а _что_ находится в ответе ошибка или нет - мы пока не знаем .
Чтобы пока не забивать голову лишними способами и методами парсинга ответа от сервера, предлагаю в данном случае остановиться на применении простой проверки:

[ ... ] Doc. LoadFromStream (Document, xetUTF_8) ; //записали XML-документ if Doc. DocumentElement . ChildNodes . FindNode ("fault" ) = nil then ShowMessage("XML-RPC работает исправно" ) [ ... ]

В соответствии со спецификацией XML-RPC сообщения об ошибках содержится в узле с названием fault. Следовательно, применительно к нашему случаю достаточно проверить наличие такого узла в ответном XML-документе - если его нет, то значит проверка прошла успешно, был сформирован корректный запрос и XML-RPC работает исправно.
Переходим к следующему шагу - проверке на корректность предоставленных данных пользователем и возможности работы пользователя с XML-RPC блога .
С XML-RPC блога имеет право работать только администратор, следовательно, необходимо узнать кто пробует получить доступ. Для этого воспользуемся методом wp.getUsersBlogs . Параметрами метода являются логин и пароль.
Но прежде, чем приступим к отправке запроса и получению ответа, думаю, стоит немного задуматься о будущем и предусмотреть работу с ошибками, формирование документов и т.д.
В предыдущей проверке, можно сказать, было баловство - простейших вариант работы типа:
отправил/получил/тут_же_разобрал/забыл/пошел_дальше.
Так как я планирую развивать модуль по работе с API WordPress и дальше, то есть смысл определиться со следующими моментами в работе:

  1. Сформировать “скелет” документа
  2. Записать в документ все необходимые параметры, учитывая типы данных
  3. Отправить запрос и получить ответ от сервера
  4. Проанализировать ответ и, если в ответе содержится сообщение об ошибке, то правильно его прочитать

Все эти четыре шага я сделал отдельными методами класса. Под “скелетом” документа я понимаю следующее содержимое:

MethodName

То есть часть документа, содержащая имя метода и узел params без содержимого. Дальше на останется только правильно заполнить список параметров. Чем мы сейчас и займемся.

Всего в XML-RPC предусмотрено использование шести простых типов данных:

  1. int и i4 - целые числаinteger)
  2. double - дробные числа
  3. string - строки
  4. base64 - закодированная строка
  5. dateTime.iso8601 - дата/время
  6. boolean

Заводим новый тип данных:

TSimpleType = (tsInt, tsI4, tsString, tsDouble, tsDateTime, tsBase64, tsBoolean) ;

С помощью значений этого типа будем определять тэг для значения параметра.

Так как операции создания “скелета” документа и добавления параметров метода разнесены по разным функциям, то создадим ещё один вспомогательный тип данных:

PXMLDocument = ^ IXMLDocument;

Теперь сам метод добавления параметра в документ:

procedure TBlog. SetParam (SimpleType: TSimpleType; Value: string ; Document: PXMLDocument) ; var Root: IXMLNode; begin if Document^ . IsEmptyDoc then Exit; //документ пуст Root: = Document^ . DocumentElement . ChildNodes . FindNode ("params" ) ; if Root= nil then Exit; //узел не найден case SimpleType of tsInt: Root. AddChild ("param" ) . AddChild ("value" ) . AddChild ("int" ) . NodeValue : = Value; tsI4: Root. AddChild ("param" ) . AddChild ("value" ) . AddChild ("i4" ) . NodeValue : = Value; tsString: Root. AddChild ("param" ) . AddChild ("value" ) . AddChild ("string" ) . NodeValue : = Value; tsDouble: Root. AddChild ("param" ) . AddChild ("value" ) . AddChild ("double" ) . NodeValue : = Value; tsDateTime: Root. AddChild ("param" ) . AddChild ("value" ) . AddChild ("dateTime.iso8601" ) . NodeValue : = Value; tsBase64: Root. AddChild ("param" ) . AddChild ("value" ) . AddChild ("base64" ) . NodeValue : = Value; tsBoolean: Root. AddChild ("param" ) . AddChild ("value" ) . AddChild ("boolean" ) . NodeValue : = Value; end ; end ;

Этот метод работает только в случае записи простого типа. При работе со структурами необходимо доработать алгоритм.

Теперь про анализ сообщений об ошибке. Рассмотрим пример того, как выглядит сообщение об ошибке в XML-RPC:

faultCode 403 faultString Bad login/pass combination.

Сообщение об ошибке приходит нам в структуре. Причём, если считать, что теги member нумеруются от нуля, то каждый чётный элемент структуры - это код ошибки, а нечётный - текст ошибки. Следовательно метод обработки сообщений об ошибке может выглядеть так:

function TBlog. ParseErrors (aDocument: PXMLDocument) : TStringList; var i: integer ; List: IDOMNodeList; code: string ; begin List: = aDocument^ . DOMDocument . getElementsByTagName ("member" ) ; Result: = TStringList. Create ; for i: = 0 to List. length - 1 do begin case i mod 2 of 0 : code: = (List. item [ i] . lastChild . firstChild as IDOMNodeEx) . text ; //чётный элемент - читаем код ошибки 1 : //нечётный элемент - читаем текст ошибки и записываем результат Result. Add (code+ " " + (List. item [ i] . lastChild . firstChild as IDOMNodeEx) . text ) ; end ; end ; end ;

Здесь код и текст ошибки записывается в TStringList. Думаю, что при необходимости можно легко сделать, чтобы код и текст читались в разные списки или массивы. Нам пока это не требуется.

Отправку документа мы уже рассматривали, поэтому сразу привожу метод проверки данных на корректность:

function TBlog. CheckUserAccess (const aURL, aUser, aPassword: string ; var Error: string ) : boolean ; var Doc: IXMLDocument; begin Doc: = GetDocument("wp.getUsersBlogs" ) ; //создали "скелет" //добавляем параметры SetParam(tsString, aUser, @ Doc) ; SetParam(tsString, aPassword, @ Doc) ; SendQuery(@ Doc, aURL) ; //отправляем запрос if not Doc. IsEmptyDoc then //если документ записан корректно begin if Doc. DocumentElement . ChildNodes . FindNode ("fault" ) < > nil then //есть сообщение об ошибке begin Result: = false ; Error: = ParseErrors(@ Doc) . Strings [ 0 ] ; end else Result: = true ; end else Result: = false ; end ;

Если пришло сообщение об ошибке, то записываем сообщение в переменную Error. В данном случае структура содержит только одно сообщение об ошибке - поэтому я так легко прописал:

Error: = ParseErrors(@ Doc) . Strings [ 0 ] ;

Итак, две проверки сделаны и мы определили, что XML-RPC включен и работает исправно, а пользователь ввёл корректные данные логина и пароля и может работать с API WordPress. Что дальше? А дальше начинаем основную работу - получаем данные по комментариям в блоге.

2. Получаем данные о постах блога.

Итак, что предоставляет в наше распоряжение WordPress. Сначала сделаем кратки обзор методов из xmlrpc.php.

wp.getPostStatusList - выводит значения для статуса поста. По сути на выходе будем имеет четыре строки: ‘draft’, ‘pending’, ‘private’, ‘publish’.

Пока этот метод нам бесполезен.

blogger.getRecentPosts - эта функция уже из API Blogger, но поддерживается в WordPress. На выходе будем иметь последние посты блога, включая весь контент поста.

Можно использовать метод, НО работа программы будет замедлена так как придётся “тягать” по Сети пост целиком. А если попробуем получить список постов блога целиком, то, видимо придётся ложиться спать, не дождавшись результата. Следовательно - пока оставляем метод в стороне.

metaWeblog.getRecentPosts - аналогично предыдущему методу.

mt.getRecentPostTitles - метод из MovableType API. Судя по названию - то, что нам надо. Смотрим описание метода.

Метод возвращает список, содержащий заголовки постов блога. При этом контент в список не записывается.

Входные параметры:

  • String blogid
  • String username
  • String password
  • int numberOfPosts

blogid всегда равен 1 (см. описание в xmlrpc.php)

numberOfPosts - количество постов, которые необходимо вывести в список. Если параметр имеет значение больше, чем количество постов в блоге, то метод возвращает список всех постов.

Осталось узнать, что из себя представляет этот список. А на выходе мы будем иметь массив структур, включающий в себя:

  • дату создания элемента
  • userid
  • postid
  • заголовок.

Замечательно. Воспользуемся этим методом, а заодно научимся анализировать сложные структуры ответа.

Про создание запроса, думаю, писать не стоит. Процедура аналогична той, что рассмотрена выше. А на анализе ответа сервера остановимся подробно. Стем как выглядит тип struct (структура) мы познакомились при парсинге ответа, содержащего ошибку авторизации. Посмотрим, что из себя представляет массив.

Массивы не имеют названия и описываются тегом . Он содержит один элемент и один или несколько дочерних элементов , где задаются данные. В качестве элементов массива могут выступать любые другие типы в произвольном порядке, а также другие массивы - что позволяет описывать многомерные массивы. Так же можно описывать массив структур. Например, массив из четырех элементо будет выглядеть так:

34 Привет, Мир! 0 -34

У нас на выходе из метода mt.getRecentPostTitles
будет содержаться массив структур , причём одна структура - это информация по одному посту блога. Следовательно, чтение данных по постам блога можно условно разделить на следующие шаги:

  1. Выделяем из XML-документа все элементы . firstChild . childNodes ; //получили все members для 1 value for j: = 0 to Members. length - 1 do begin with Result[ i] do case j of 0 : dateCreated: = (Members[ j] . lastChild . firstChild as IDOMNodeEx) . text ; 1 : user_id: = StrToInt ((Members[ j] . lastChild . firstChild as IDOMNodeEx) . text ) ; 2 : id: = StrToInt ((Members[ j] . lastChild . firstChild as IDOMNodeEx) . text ) ; 3 : title: = (Members[ j] . lastChild . firstChild as IDOMNodeEx) . text ; end ; end ; end ; [ ... ]

    Соответственно, если получено сообщение об ошибке, то можно воспользоваться рассмотренной ранее функцией.

    На сегодня всё. В следующий раз продолжим работу с API и попробуем получить все комментарии из блога.

У многих программистов Delphi, сохранение настроек ассоциируется с использованием INI файлов в своих программах. Применение данного метода, в более менее серьезных проектах, необходимо избегать, так как это ограничивает в гибкости, что препятствует дальнейшему расширению программы. Стоит сказать, что такой подход достаточно популярен, в силу своей простоты использования и наличия встроенных средств в среду разработки.

Тем не менее, идеальным вариантом для хранения настроек программы являются структурированные XML файлы. Их преимущество заключается в том, что количество параметров может быть не фиксированным. Чтобы лучше это понять, рассмотрим конкретный пример.

В программе USearch , при клике по записи, появляется контекстное меню , в котором отображается список пунктов. Эти пункты являются командами, которые в свою очередь загружаются из файла настроек. В случае, если бы настройки хранились в INI файле, то программа могла бы сохранять и загружать определенное количество команд, например 10 или 50. Как только потребуется большее значение, придется заново переписывать код и соответственно повторно компилировать его.


Применяя подход с использованием XML файлов, у нас появится возможность загружать все параметры секции динамически. Ко всему этому, файл конфигурации станет более изящным, без избыточной нумерации параметров. Однако, стандартные средства для работы с XML в Delphi имеют множество недостатков, поэтому рекомендую использовать стандартную библиотеку MSXML . Обычно она по-умолчанию входит в состав операционных систем семейства Windows.


Для подключения MSXML , нам необходимо сформировать файл интерфейса со списком всех функций, импортировав его из COM-сервера. Как импортировать интерфейс написано не мало подробных статей, я же предлагаю вам скачать файл MSXML2_TLB.PAS уже готовый к использованию. После того, как файл будет скачан, разместите его рядом с вашим проектом, либо закиньте в папку lib среды Delphi. Таким образом, все создаваемые программы смогут использовать модуль MSXML , достаточно лишь дописать в uses строчку MSXML2_TLB .

Для наглядности, рассмотрим следующий пример применения этой библиотеки:

Procedure LoadData; var XMLDoc: DOMDocument; Root: IXMLDOMElement; begin XMLDoc:= CoDOMDocument.Create; XMLDoc.Load("settins.xml"); Root:= XMLDoc.DocumentElement; ShowMessage(Root.SelectSingleNode("size/width").Text); Root:= nil; XMLDoc:= nil; end;

Сначала создается экземпляр класса DOMDocument , после чего в память загружается содержимое файла settings.xml . Так как по стандарту любой XML файл должен содержать корневой тэг (в данном случае config ), то нам необходимо его получить, используя функцию DocumentElement . Затем происходит вывод содержимого между тэгами , которые в свою очередь находятся между тэгами . Таким образом из файла settings.xml , наш метод выведет в MessageBox текст "100px" .

500px 100px

Здесь применен метод SelectSingleNode , который в качестве параметра принимает строку

Всех приветствую! Несколько лет писал на Матлабе, а тут приспичило на Дельфи программу написать.

Мне необходимо научиться работать с xml-документами. Работаю в RAD Stiduo XE3. Там есть компонент TXMLDocument, наверно, известный многим программящим на Delphi. Вроде бы и умеет много. Но проблема в том, что по нему нет понятной документации и описания. Хэлп в RAD Studio - фигня, потому что нормальной информации там нет; только разбросанная по страницам скудная справка по некоторым методам и процедурам (без примеров и нормального описания). Перерыл весь инет. Нашёл только темы на форумах с решением конкретных задач, где надо ещё час догадываться, что делает та или иная строка, связанная с обращением к xml-файлу.
Мне же нужно руководство по основным функциям, процедурам и методам, применяемым при работе с xml. Учебник, мануал, описание. Или хотя бы "xml в Delphi для чайников". Например:

Для открытия xml-файла используем метод XMLDocument1.LoadFromFile("filemane.xml"), где filename - имя файла.
Переменная nodelist типа IXMLNode служит для хранения списка дочерних элементов. Для определения этого списка служит метод Xmldocument1.DocumentElement (где XMLDocument1 - исследуемый xml-файл).
Чтобы запросить содержимое дочернего элемента "element1" используется метод XMLDocument1.DocumentElement.ChildNodes[ "element1"].Text...

и в таком духе дальше по всем применяемым методам, процедурам, типам данных.
Где найти подобные мануалы/описания? Кто может помочь?

Если нужна конкретная задача, опишу её.
Имеется xml-документ вида:



LTM


fon.png
up.jpg

pano_u.jpg
pano_f.jpg


start.jpg
tmb.jpg




1910
768
512
1024
768



Some text
Some errortext
Other errortext

В коде программы имеем:

var
...
parent, child1: IXMLNode;

begin
XMLDocument1.LoadFromFile("f:\filename.x ml");
XMLDocument1.Active:=true;
.
.
end

Что надо научиться делать:
(заранее извиняюсь, если неверно называю составляющие xml-документа)
1. Получить имя корневого элемента (в нашем случае ltm), а также список его атрибутов (version, type) и их значения ("1.0", "settings").
2. Получить количество элементов, являющихся дочерними по отношению к корневому. В данном случае их 7: templateFiles, dimensions, hotspot, hotspot, data, data, data. Получить имена элементов (тэгов) (templateFiles, dimensions и т. п.). Получив количество элементов и научившись извлекать их имена, я прогоню цикл от 0 до count-1 и сделаю что мне нужно.
3. Получить количество и список атрибутов требуемого элемента. Например, для элемента hotspot. Правильный ответ будет 4 атрибута. Для первого элемента hotspot это будут name, style, scena, ath. Для второго - то же, только вместо атрибута ath - атрибут rz.
Заметьте, в файле 2 элемента hotspot, с разными атрибутами. Вот как с ними работать (если одноимённых элементов больше 1)?
Я хочу так: получаю список дочерних элементов по отн. к корневому (см. п. 2), прогоняю по ним цикл с for и найду элементы hotspot, у которых параметр name равен требуемому (скажем "hs015_2" - такой элемент будет заведомо один). Можно ли как-то решить этот вопрос без цикла? То есть, получить значение атрибута scena для элемента hotspot, у которого name="hs015_2"?
4. Проделать вышеописанное по отношению к узлам и элементам, являющимся дочерними по отношению к дочерним. В моём примере - узел (дочерний по отношению к и родительский по отношению к и.
Если я правильно понимаю, надо как-то передать содержимое узла в переменную типа IXMLNode и делать то же, что и в п.1-3. Так?

5. Надо научиться изменять вышеуказанные параметры (задавать свои).

Вроде пока всё. На данном этапе мне важнее всего синтаксические конструкции.
Кто владеет этой темой, напишите пожалуйста и другие синтаксические конструкции для решения вышеописанных вопросов (как получить атрибуты, их кол-во, кол-во элементов, их имена и т. п.). Главное сейчас - овладеть синтаксисом, а свой алгоритм я уж реализую потом. Заранее всем огромное спасибо!

P.S. Очень не хотелось бы писать с нуля свой парсер XML только потому, что к имеющимся нет нормального описания.