Руководство по РНР 3.0 - Функции работы с Hyperwave

Вступление

Hyperwave был разработан IICM в Гразе (Graz). Первоначально пакет назывался Hyper-G и был изменен на Hyperwave после коммерциализации (где-то в 1996).

Hyperwave не является свободно распространяемым ПО. Текущая версия, 4.0, доступна www.hyperwave.com. Существует 30-дневная версия.

Hyperwave - это информационная сиситема, похожая на базы данных (HIS, Hyperwave Information Server). Она напраавлена на хранение документов и управление ими. Документом может быть любая часть данных, которая может быть сохранена в файле. Каждый документ сопровождается своей объектной записью. Объектная запись содержит мета-данные документа. Мета-данные - это список атрибутов, который может быть расширен пользователем. Постоянные атрибуты всегда назначаются сервером Hyperwave, остальные могут меняться пользователем.

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

Говорят, что hw_pipedocument() и hw_gettext() выполняют вставку ссылок в документ автоматически, однако быстро сказка сказывается, да не просто дело делается. Вставка ссылок предполагает неизменную иерархию документов. На веб-сервере существует иерархия, полученная от файловой системы, но Hyperwave имеет свою собственную иерархию и имена не отражают позицию объекта в этой иерархии. Поэтому оздание ссылок прежде всего требует маппинга имен из иерархии Hyperwave в соотвествующие имена иерархии веб. Фундаментальное отличие между Hyperwave и Веб заключается в том, что в Hyperwave имя и иерархия - суть разные понятия. Имя не содержит никакой информации о положении объекта в иерархии. В Веб имя содержит и информацию о том, гед объект расположен иерархически. Это указывает на два возможных пути маппинга. В URL можно отражать иерархию Hyperwave и имя объекта или только имя. С цель сделать вещи проще, второй вариант более применим. Объект Hyperwave с именем 'my_object' мапится в 'http://host/my_object' безотносительно к его положению в иерархии Hyperwave. Объект с именем 'parent/my_object' может быть порожден 'my_object' в иерархии Hyperwave, однако в пространстве имен Веб оно проявится как противоположное и пользователь может быть неприятно удивлен. Это может быть предотвращено только путем оригинального именования объектов.

Применение этого решения порождает вторую проблему. Как вы запускаете php3? URL http://host/my_object не вызовет ни одного скрипта php3 до тех пор, пока вы не укажете вашему веб-скрверу переписать ее подобным образом: 'http://host/php3_script/my_object' и переменная $PATH_INFO должна быть равна скрипту 'php3_script', и возвращется объект с именем 'my_object' от Hyperwave сервера. Это только один недостаток, который может быть исправлен легко. Переписывание URL не дает доступа к другим документам веб-сервера. Скрипт php3 для поиска в Hyperwave сервере принципиально невозможен. По этой причине вам необходимо по меньшей мере два переназначения правила для исключения постоянных URLов, начинающихся с http://host/Hyperwave. Это - основное разделение пространства имен между Hyperwave и веб серверами.

На основе вышеизложенных механизмов ссылки вставляются в документ.

Это получается более сложно, если php3 не запущено как скрипт module/CGI, а как самостоятельное приложение, т.е. дампит содержимое Hyperwave сервера на CD-ROM. В этом случае имеет смысл сохранять иерархию Hyperwave и мапить ее на файловую систему. Это может вызвать конфликты с именамаи объектов если оини отражают свою собственную иерархию (если имена включают символ "/"). Однако, "/" может быть заменен на другой символ, типа "_", и все вроде встенет на свои места.

Сетевой протокол соединяется с Hyperwave сервером HG-CSP (Hyper-G Client/Server Protocol). Он основан на сообщениях, инициирующих определенный события, например получекния объектной записи. Вранних версиях Hyperwave сервера предлагалось два родных клиента (Harmony, Amadeus) для связи с сервером. Оба они исчезли после коммерциализации Hyperwave. На замену пришло нечто, называемое wavemaster. Wavemaster - это нечто протоколоподобное, конвертирующее HTTP в HG-CSP. Идея состоит в том, чтобы все администрирование базами данных и визуализация документов должно осуществляться через Веб-интерфейс. Wavemaster обеспечивает множество плейсхолдеров (placeholders) для постоянных операций по насторйке интерфейса. Эти плейсхолдеры называются языком PLACE. PLACE-у недостает множества преимуществ настоящих языков программирования, и любые расширения - это только увеличение списка плейсхолдеров. Это дает мне основание к использованию JavaScript, который, IMHO, не делает жизнь легче.

Добавление поддержки Hyperwave в PHP3 было введено с целью заполнить пробелы языков програмирования в управлении интерфейсов. Оно выполлняет все сообщения, определенные в HG-CSP, и более сложныве команды по получению завершенных документов.

Hyperwave имеет свою собственную терминологию для именования различных порций информации. Это было заимствовонно и расширенно. Практически все функции оперируют с одним из следующих типов данны:

  • object ID: уникально целое значение для каждого объекта в Hyperwave сервере. Это также одни из атрибутов объектной записи (ObjectID). ИД объектов часто используются в качестве входных параметров для спецификации объекта.

  • object record: строка с парами атрибут-значение в фоме атрибут=значение. пары одделены одна от друкой символом возврата каретки. ОБъектная запись может быть просто переконвертирована в объектный массив: hw_object2array(). Несколько функций (их имена заканчиваются на obj) возвращают объектные записи.

  • object array: ассоциативный массив со всеми атрибутами объекта. Ключ - имя атрибута. Если атрибут встречается в объектной записи несколько раз, это ведет к появлению другого индекса или индексного массива. Атрибуты, определнные в языке, будут иметь множство ключей, аббревиатур языка в ассоциативном массиве. Все другие множественные атрибуты формируют индексные массивы. Функции php3 никогда не возвращают объектных массивов.

  • hw_document: это совершенно новый тип данных, который описывает наличный документ, напимер HTML, PDF и др. Он несколько оптимизированн под HTML, но может быть использован и с другими форматами.

Несколько функций, возвращающих массивы объектных записей также возвращают ассоциативный массив со статистической информацией о нем. Этот массив - последний элемент массива объектных записей. Статистический массив содержит следующие поля:

Hidden

Число объектных записей с атрибутом PresentationHints, установленным в Hidden.

CollectionHead

Число объектных записей с атрибутом PresentationHints, установлденным в CollectionHead.

FullCollectionHead

Число объектных записей с атрибутом PresentationHints, установленным в FullCollectionHead.

CollectionHeadNr

Индекс в массиве объектных записей с атрибутом PresentationHints, установленным в CollectionHead.

FullCollectionHeadNr

Индекс в массиве объектных записей с атрибутом PresentationHints, установленным в FullCollectionHead.

Total

Общее число объектных записей.

Интеграция с Apache

Модуль Hyperwave лучьше всего использовать, когда PHP3 скомпилированн в как модуль Apache. В этом случае основной Hyperwave сервер может быть скрыт от пользователя почти полностью, если Apache использует свой движок. Это объясняют следующие инструкции.

С тех пор, как PHP3 с Hyperwave поддерживают встраивание в Апач, предполагается, что родное решение Hyperwave - wavemaster - автоматически замещается. Т.е. Апач примет на себя функции веб-интерфейса к Hyperwave. Это не есть необходимость, но конфигурация упрощается. Идея достаточно проста. Перво-наперво вам необходим PHP3-скрипт, который оценивает переменную PATH_INFO и рассматривает ее значение как имя Hyperwave объекта. Пусть скрипт называется 'Hyperwave'. URL http://your.hostname/Hyperwave/name_of_object возвратит Hyperwave объект с именем 'name_of_object'. Реакция скрипта зависит от типа объекта. Если это коллекция, он возможно вернет список наследников. Если это документ, он возвратит mime-тип и содержание. Небольшое улучшение может быть достигнуто, если используется движок перезаписи Апача. С точки зрения пользователя, это более прямой путь, если URL http://your.hostname/name_of_object будет возвращать объект. Правило перезаписи достаточно простое:


RewriteRule ^/(.*) /usr/local/apache/htdocs/HyperWave/$1 [L]

Теперь каждый URL относится к объекту в Hyperwave серере. Это основание для простого решения проблемы. Это еще не путь для выполнения различных скриптов, например поиска, как в скрипте 'Hyperwave'. Это может быть решено другим правилом перезаписи:


RewriteRule ^/hw/(.*) /usr/local/apache/htdocs/hw/$1 [L]

При этом будет зарезервирована директория /usr/local/apache/htdocs/hw для допонительных скриптов и других файлов. Следует удостоверится, что это правило выполнится перед рассмотренным выше. Есть небольшой недостаток - все объекты Hyperwave, чье имя начинается с '/hw' будут скрытыми. Поэтому, будьте уверены, что вы не используете таких имен. Если вам необходимо больше директорий, например для изображений, добавьте еще правила или сложите все в оодной директории. Наконец, не забудьте запустить перезаписывающий движок с


RewriteEngine on

Мой опыт подсказывает, что вам понадобятся следующие скрипты:

  • для возврвта самого объекта

  • для разрешения проблемы поиска

  • для идентификации вас

  • для установки профиля

  • один для каждой дополнительной функции, как то показа атрибутов объекта. показа информации о пользователе, показа статуса сервера и др.

Замечания

Еще несколько заечаний:

  • Функция hw_InsertDocument расщеплена на hw_InsertObject() и hw_PutDocument().

  • Имена некоторых функций пока еще не подтверждены.

  • Мольшинство функций требуют текущее соединение как первый параметр. Это ведет к достаточно большому количеству лишнего набора, что в большинстве случев излищне, поскольку существует только одно соединение. Соединение по умолчанию предоставляет улучшенный вариант решения.


hw_Changeobject

hw_Changeobject -- Сменить объект
Описание

int hw_changeobject(int connection, int object_to_change, string commands);

Команда позволяет удалить, добавить или модифицировать индивидуальные атрибуты объектной записи. Объекты указываются идентификатором оюъекта, object_to_change; команды придерживаются следующего синитаксиса:

<command> ::= <remcmd> |
              <addcmd> |
              <remcmd> "\" <addcmd>

<remcmd>  ::= "rem " <attribute> "=" <value>

<addcmd>  ::= "add " <attribute> "=" <value>                

Заметим, что в запросе на удаление или перемещение атрибута, его старое значение также поддерживается (некоторые атрибуты могут иметь одновременно несколько значений). Команда, подобная rem attr=value\add attr=value позводяет модифицировать атрибуты за одну операцию.

Возвращает True при отсутствии ошибок, иначе False.


hw_Children

hw_Children -- ID наследников объекта
Описание

array hw_children(int connection, int objectID);

Возвращает массив идентификаторов объектов. Каждый иденитификатор - часть коллекции с идентификатором objectID. Массив содержит всех наследников, документы и коллекции.


hw_ChildrenObj

hw_ChildrenObj -- объектные записи наследников.
Описание

array hw_childrenobj(int connection, int objectID);

Возвращает массив объектных записей. Каждая запись - часть коллекции с идентификатором objectID. Массив содержит всех наследников, документы и коллекции.


hw_Close

hw_Close -- закрыть соединение Hyperwave
Описание

int hw_close(int connection);

Возвращет false, если соединение не является действующим, в противном случае - true. Closes закрывает соединение с Hyperwave сервером с указанным номером соединения connection.


hw_Connect

hw_Connect -- открыть соединение.

hw_Cp

hw_Cp -- копировать оюъекты

hw_Deleteobject

hw_Deleteobject -- удалить объект

hw_DocByAnchor

hw_DocByAnchor -- ИД объекта, относящегося к якорю
Описание

int hw_docbyanchor(int connection, int anchorID);

Возвращает идентификатор оъекта документа, который относится к якорю anchorID.


hw_DocByAnchorObj

hw_DocByAnchorObj -- объектная запись объекта, относящегося к якорю
Описание

string hw_docbyanchorobj(int connection, int anchorID);

Возвращает объектную запись объекта документа, относящегося к якорю anchorID.


hw_DocumentAttributes

hw_DocumentAttributes -- объектная запись Hyperwave документа

hw_DocumentBodyTag

hw_DocumentBodyTag -- тег body hw-документа

hw_DocumentSize

hw_DocumentSize -- размер hw-документа

hw_ErrorMsg

hw_ErrorMsg -- возврат сообщения об ошибке
Описание

string hw_errormsg(int connection);

Возвращает строку, содержащую последнее сообщени об ошибке или 'No Error'. Если возвратилось False, функция не выполнилась. Сообщение относится к последней команде.


hw_EditText

hw_EditText -- получение текстового документа

hw_Error

hw_Error -- номер ошибки
Описание

int hw_error(int connection);

Возвращет номер последней ошибки. Если 0 - ошибок не было. Ошибка относится к последней команде.


hw_Free_Document

hw_Free_Document -- освободить hw-документ
Описание

int hw_free_document(int hw_document);

освобождает память, занятую hw-документом.


hw_GetParents

hw_GetParents -- ИД родителей объекта
Описание

array hw_getparentsobj(int connection, int objectID);

Возвращает индексированный массив идентификаторов объектов. Каждый ИД объекта относится к родителям объекта с идентификатором objectID.


hw_GetParentsObj

hw_GetParentsObj -- объектные записи родителей
Описание

array hw_getparentsobj(int connection, int objectID);

Возвращает индексированный массив объектных записей плюс ассоциативный массив со статистической информацией об объектных записях. Ассоциативный массив - последний член возвращенного массива. Каждая объектная запись относится к родителю объекта с ИД objectID.


hw_GetChildColl

hw_GetChildColl -- ИД объекта коллекции наследников

hw_GetChildCollObj

hw_GetChildCollObj -- объектные записи коллекции наследников

hw_GetSrcByDestObj

hw_GetSrcByDestObj -- возвращает якорные точки объекта
Описание

array hw_getsrcbydestobj(int connection, int objectID);

Возвращает объектные записи всех якорных точек объекта с ИД objectID. Объект может быть как документом, так и якорем.

Смотри также hw_GetAnchors().


hw_GetObject

hw_GetObject -- объектная запись

hw_GetAndLock

hw_GetAndLock -- вернуть объектную запись и запереть объект
Описание

string hw_getandlock(int connection, int objectID);

Возвращает объектную запись объекта с ИД objectID. Объект также запирается, поэтому другие позователи не имеют к нему доступа, пока объект не будет разблокирован.

Смотри также hw_Unlock(), hw_GetObject().


hw_GetText

hw_GetText -- получить текстовый документ
Описание

int hw_gettext(int connection, int objectID, int rootID);

Возвращается документ с идентификатором объекта objectID. Если документ имеет якоря, которые можно вставить, то они будут сразу вставлены. Опциональный параметр rootID определяет, как ссылки будут вставляться в документ. По умолчанию подставляется 0, что означает конструирование ссылок из имен объктов назначения ссылок. Это применимо для веб-приложений. Если ссылка указывает на объект с именем 'internet_movie', ссылка HTML будет выглядеть как <A HREF="/internet_movie">. Настоящее положение исходного объекта и объекта назначения в иерархии документа полностью игнорируется. Вы будете вынуждены установить ваш браузер, переписать URL приблизительно так: example '/my_script.php3/internet_movie'. 'my_script.php3' обработает $PATH_INFO и выдаст документ.

Если rootID не равен 0, ссылка конструируется из всех имен, начиная с объекта с ИД rootID, разделенных слешами от текущего объекта. Если для предидущего примера документ 'internet_movie' расположен в 'a-b-c-internet_movie', где '-' - разделители между уровнями иерархии, и исходный документ расположен по пути 'a-b-d-source', результирующая HTML-ссылка будет: <A HREF="../c/internet_movie">. Это используется, если вы хотите утянуть се содержание сервера на диск и мапить иерархию докмента на файловую систему.

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

Смотри также hw_PipeDocument(), hw_FreeDocument(), hw_DocumentBodyTag(), hw_DocumentSize(), hw_OutputDocument().


hw_GetObjectByQuery

hw_GetObjectByQuery -- поиск объекта

hw_GetObjectByQueryObj

hw_GetObjectByQueryObj -- поиск объекта

hw_GetObjectByQueryColl

hw_GetObjectByQueryColl -- поиск объекта в коллекции

hw_GetObjectByQueryCollObj

hw_GetObjectByQueryCollObj -- search object in collection

hw_GetChildDocColl

hw_GetChildDocColl -- ИД объектов наследуемых документов коллекции

hw_GetChildDocCollObj

hw_GetChildDocCollObj -- объектные записи наследуемых документов коллекции

hw_GetAnchors

Описание

array hw_getanchors(int connection, int objectID);

Возвращает массив идентификаторов объектов для якорей документа с ИД objectID.


hw_GetAnchorsObj

hw_GetAnchorsObj -- объектные записи якорей документа
Описание

array hw_getanchorsobj(int connection, int objectID);

Возвращает массив объектных записей для якорей документа с ИД objectID.


hw_Mv

hw_Mv -- переместить объект

hw_Identify

hw_Identify -- идентификация пользователя

hw_InCollections

hw_InCollections -- есть ли такой объект в коллекции
Описание

array hw_incollections(int connection, array object_id_array, array collection_id array, int return_collections);

Проверяет, является ли множество объектов (документов или коллекций), определенное в object_id_array, частью коллекций, определенных в коллекции id_array. Если четвертый параметр return_collections равен 0, подмножество идентификаторов объектов, которое является частью коллекций (т.е. документы или коллекции, которые являются наследниками одной или более коллекций идентификаторов коллекции или их подколлекций, рекурсивно) возвращается как массив. Когда четвертый праметр равен 1, однако, множество соллекций, которые имеют наследников в этом подмножестве, возвращается как массив. Это позволяет пользователю, например, подчеркнуть часть иерархии коллекции, которая содержит находки предидущего запроса, в графическом виде.


hw_Info

hw_Info -- информация о соединении
Описание

string hw_info(int connection);

Возвращает сведения о текущем соединении. Возвращаемая строка имеет следующий формат: <Serverstring>, <Host>, <Port>, <Username>, <Port of Client>, <Byte swapping>


hw_InsColl

hw_InsColl -- добавление коллекции
Описание

int hw_inscoll(int connection, int objectID, array object_array);

Вставить новую коллекцию с атрибутами как в object_array в коллекцию с идентификатором objectID.


hw_InsDoc

hw_InsDoc -- добавление доукмента

hw_InsertDocument

hw_InsertDocument -- добавление любого документа

hw_New_Document

hw_New_Document -- создание нового документа

hw_Objrec2Array

hw_Objrec2Array -- конвертировать атрибуты из объектной записи в объектный массив
Описание

array hw_objrec2array(string object_record);

Преобразует object_record в объектный массив.


hw_OutputDocument

hw_OutputDocument -- печать hw-документа
Описание

int hw_outputdocument(int hw_document);

Печатает документ без тега BODY.


hw_pConnect

hw_pConnect -- создание устойчивого соединения с базой данных

hw_PipeDocument

hw_PipeDocument -- полдучение любого документа

hw_Root

hw_Root -- идентификатор коренного объекта
Описание

int hw_root();

Возвращает объектный идентификатор для гиперкоренной коллекции. Обычно это 0. Наследная коллекция от гиперкорневой - корневая, на сервере, с которым установлено соединение.


hw_Unlock

hw_Unlock -- разблокировать объект

hw_Username

hw_Username -- имя текущего пользователя
Описание

string hw_getusername(int connection);

Возвращает имя пользователя соединения.

Назад, к содержанию




HTML Site Map

Rambler's Top100
© 2009 Тест скорости интернета |  Boont.Ru