Voltron: Новая страница: «{{Статья|Опубликована|osgeo4w-packaging}} {{Аннотация|Как создаются пакеты для OSGeo4W.}} Это руководс…»

2012-07-19T13:39:01Z

Новая страница: «{{Статья|Опубликована|osgeo4w-packaging}} {{Аннотация|Как создаются пакеты для OSGeo4W.}} Это руководс…»

Новая страница

{{Статья|Опубликована|osgeo4w-packaging}}
{{Аннотация|Как создаются пакеты для OSGeo4W.}}

Это руководство объясняет основные этапы создания нового программного пакета для установщика OSGeo4W. По материалам [http://trac.osgeo.org/osgeo4w/wiki/PackagingInstructions OSGeo4W Wiki].

=== Общие сведения ===

OSGeo4W — специальный установщик, ориентированный на распространение различного ПО для работы с пространственными данными для операционных систем семейства Windows (XP, Vista и др.). При помощи OSGeo4W можно установить GDAL/OGR, GRASS, MapServer, OpenEV, uDIG, QGIS а также множество других пакетов (ознакомиться с [http://trac.osgeo.org/osgeo4w/wiki/PackageListing полным списком]).

Установка ПО с OSGeo4W сводится к нескольким простым шагам:

# [http://download.osgeo.org/osgeo4w/osgeo4w-setup.exe загрузить установщик]. Для пользователей, у которых возникают проблемы с доступом к серверу download.osgeo.org, создан [http://download2.osgeo.org/osgeo4w/osgeo4w-setup-it.exe альтернативный установщик], работающий с зеркалом download2.osgeo.org
# запустить установщик
# выбрать пункт «Стандартная Desktop установка» и нажать «Далее»
# выбрать пакеты для установки и нажать «Далее»
# выбранные пакеты и необходимые зависимости будут загружены и установлены автоматически

После установки настольные приложения можно запустить выполнив «Пуск → Программы → OSGeo4W». Утилиты командной строки можно запускать из командной строки OSGeo4W Shell, а web-приложения будут доступны по адресу [http://localhost/ http://localhost/].

Ознакомиться с подробным описанием установки через OSGeo4W на примере QGIS можно в соответствующей [http://gis-lab.info/qa/qgis-osgeo4w.html статье].

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

=== Подготовка к созданию пакета для OSGeo4W ===

Каким бы большим ни был список пакетов OSGeo4W, всегда найдется что-то нужное и в то же время не представленное в этом списке. Так было с [http://gis-lab.info/blog/2009-07/statist/ matplotlib] и [http://gis-lab.info/blog/2011-05/tinyows-osgeo4w/ TinyOWS].

Итак, вы решили добавить новый пакет в OSGeo4W. Сначала необходимо получить разрешение от разработчиков. Как показывает практика, если предлагаемый к включению пакет не имеет особых зависимостей, является свободным ПО и вы готовы взять на себя поддержку, то возражений не возникает. После получения разрешения нужно сформировать пакет и загрузить его на сервер.

=== Формат пакета и структура каталогов ===

Каждый пакет OSGeo4W представляет собой архив tar сжатый bzip2, который при установке разворачивается в корневой каталог OSGeo4W. Все пакеты имеют свой файл setup.hint с описанием и списком зависимостей.

Структура дерева каталогов установленного OSGeo4W описанa на [http://trac.osgeo.org/osgeo4w/wiki/DirectoryLayout специальной странице], приводить ее здесь мы не будем. Перед подготовкой пакета необходимо изучить структуру каталогов и определиться в каких каталогах должны быть ваши файлы. Соответственно, все пути в архиве должны задаваться относительно корневого каталога OSGeo4W.

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

<pre>upload.osgeo.org:/osgeo/download/osgeo4w/release/<package></pre>

Просмотреть текущее [http://download.osgeo.org/osgeo4w/release дерево каталогов].

Каждый пакет имеет свой каталог в котором находится файл <tt>setup.hint</tt>, а также одна или несколько версий пакета в виде архивов .tar.bz2. Имя архива должно соответствовать опеределенным требованиям: в начале идет базовое название пакета, затем через дефис версия упакованного ПО, и, наконец, тоже через дефис версия самого пакета.

[[Файл:osgeo4w-packaging-01.png|center]]

Нужно помнить, что базовое имя пакета и название каталога в дереве OSGeo4W должны совпадать, т.е. в каталоге <tt>tinyows</tt> должны быть файлы <tt>tinyows-<версия>-<ревизия>.tar.bz2</tt>.

Иногда один программный комплекс разбивается на несколько пакетов (например, GDAL). В этом случае отдельные компоненты располагаются во вложенных папках базового каталога. Например, драйвер Oracle 10g для GDAL будет лежать в каталоге <tt>release/gdal/gdal-oracle10g</tt>, а пакет будет называться <tt>gdal-oracle10g-1.5.0-1.tar.bz2</tt>.

'''ВАЖНО!''' Для создания архива необходимо использовать tar и bzip2 из состава самого OSGeo4W (<tt>%OSGEO4W_ROOT%\apps\msys\bin</tt>) или «родные» tar/bzip2 в Linux. Архивы, созданные 7-zip, установщиком не распознаются, а созданные при помощи bzip2 из gnuwin32 и/или cygwin работают с переменным успехом.

В каталоге пакета обязательно должен присутствовать файл <tt>setup.hint</tt> с коротким и длинным описанием пакета, а также со списком зависимостей. Так выглядит <tt>setup.hint</tt> для TinyOWS:

<pre>
sdesc: "High performance WFS-T server"
ldesc: "High performance Web Feature Service (WFS-T) server"
category: Web
requires: apache msvcrt iconv fcgi libxml2 regex
</pre>

=== Пакетирование web-приложений ===

При создании структуры каталогов пакета придерживаемся следующих рекомендаций:
<ul>
<li>приложения устанавливаются во вложенные папки каталога <tt>%OSGEO4W_ROOT%\apps\</tt>. Например, при создании пакета TinyOWS, в каталоге <tt>tinyows</tt> находится конфигурационный файл и папка <tt>schema</tt> с файлами схем</li>
<li>алиас "/cgi-bin/" сервера Apache указывает на каталог <tt>%OSGEO4W_ROOT%\bin\</tt>, поэтому файл <tt>tinyows.exe</tt> должен быть распакован именно туда</li>
<li>в каталоге <tt>%OSGEO4W_ROOT%\httpd.d\</tt> находятся алиасы сервера Apache. Этот каталог сканируется при запуске сервера и найденные в нем файлы загружаются. Алиасы используются для настройки web-приложений, например, для TinуOWS в этом файле задается расположение файла конфигурации и каталог схем (назначение макроса <tt>@osgeo4w@</tt> обясняется ниже) 
<pre>SetEnv TINYOWS_CONFIG_FILE "@osgeo4w@/apps/tinyows/config.xml"
SetEnv TINYOWS_SCHEMA_DIR "@osgeo4w@/apps/tinyows/schema/"</pre>
ВАЖНО! Имя файла должно соответствовать шаблону 
<pre>httpd_*.conf</pre>
Символ «*» (звездочка) заменяется названием приложения, наш файл называется <tt>httpd_tinyows.conf</tt></li>
<li>алиас "/ms_tmp/" сервера Apache указывает на каталог <tt>%OSGEO4W_ROOT%\tmp\ms_tmp\</tt> и создан доступа к временным файлам web-приложений</li>
<li>web-приложения должны поставляться с файлом <tt>.pkg</tt> в каталоге <tt>%OSGEO4W_ROOT%\apache\htdocs\</tt>, чтобы ссылка на приложение отображалась на стартовой странице OSGeo4W. В этом файле (его еще называют Index Package File) должен находиться небольшой фрагмент HTML кода, который автоматически будет включен в код стартовой страницы. Код должен содержать краткое описание приложения и предоставлять ссылки для доступа к соответствующим псевдонимам сервера Apache. Ниже дается пример такого файла 
<pre><h3>Foobar Application</h3>
<a href="/foobar/">Foobar demo</a></pre>
Имя файла должно соответствовать шаблону (обратите внимание на двойное расширение!) 
<pre>packagename.pkg.html</pre></li>
</ul>

=== Послеустановочные действия ===

Пакет может выполнять послеустановочные действия, чаще всего это необходимо для обновления конфигурационных файлов (актуализация путей относительно установочного каталога) и создания ярлыков. За выполнение послеустановочных действий отвечает .bat-файл, находящийся в каталоге <tt>/etc/postinstall</tt> пакета. Имя этого файла должно совпадать с именем пакета, например: <tt>/etc/postinstall/tinyows.bat</tt>. Командный файл будет запущен после распаковки архива с предустановленными переменными окружения OSGEO4W_STARTMENU, OSGEO4W_HOME и OSGEO4W_HOME_MSYS, а каталог <tt>OSGEO4W_HOME/bin</tt> будет включен в пременную PATH.

==== Замена текста ====

Для примера рассмотрим корректировку путей в конфигурационном файле TinyOWS. Изначально файл <tt>apps/tinyows/config.xml</tt> выглядит так

<pre>
<tinyows online_resource="http://127.0.0.1/cgi-bin/tinyows.exe"
schema_dir="D:/package/apps/tinyows/schema/">

<pg host="127.0.0.1" user="postgres" password="postgres" dbname="tinyows_demo" port="5432"/>

<metadata name="TinyOWS Server"
title="TinyOWS Server - Demo Service" />

<layer retrievable="1"
writable="1"
ns_prefix="tows"
ns_uri="http://www.tinyows.org/"
name="world"
title="World Administrative Boundaries" />

<layer retrievable="1"
writable="1"
ns_prefix="tows"
ns_uri="http://www.tinyows.org/"
name="france"
title="French Administrative Sub Boundaries (IGN - GeoFLA Departements)" />

</tinyows>
</pre>

Видно, что путь в строке

<pre>schema_dir="D:/package/apps/tinyows/schema/"</pre>

задан жестко, и после установки будет указывать на несуществующий каталог. Чтобы после установки этот путь указывал на правильный каталог внутри папки OSGeo4W нужно:

<ul>
<li>заменить ту часть пути, которая может измениться, на переменную @osgeo4w@ 
<pre>schema_dir="@osgeo4w@/apps/tinyows/schema/"</pre></li>
<li>в файл etc/postinstall/tinyows.bat добавить строку 
<pre>textreplace -sf apps/tinyows/config.xml -df apps/tinyows/config.xml -map @osgeo4w@ %OSGEO4W_ROOT%</pre></li>
</ul>

Формат команды замены следующий:

<pre>textreplace -sf исходный_файл -df файл_назначения -map найти_строку заменить</pre>

Аналогичным образом выполняется замена и в файле <tt>httpd.d/httpd_tinyows.conf</tt>

Примечание: с апреля 2008 года утилита <tt>textreplace</tt> умеет выполнять замену «на месте» и можно использовать новый синтаксис. Так, команда

<pre>textreplace -std -t apps/tinyows/config.xml</pre>

выполнить стандартную подстановку, заменив все вхождения <tt>@osgeo4w@</tt> на реальный путь к корневому каталогу OSGeo4W.

При необходимости выполнять корректировку путей в коде на Python в начало файла <tt>postinstall.bat</tt> необходимо добавить следующую строку

<pre>set OSGEO4W_ROOT=%OSGEO4W_ROOT:\=\\%</pre>

Это заставит <tt>textreplace</tt> использовать двойные слеши, т.е. вместо <tt>C:\OSGeo4W</tt> будет подставлено <tt>C:\\OSGeo4W</tt>.

==== Создание ярлыков ====

Еще одним послеустановочным действием является создание ярлыков для запуска ПО. Как и в случае с заменой строк, для этих целей существует утилита <tt>xxmklink.exe</tt> (входит в состав пакета msvcrt). Это консольное приложение, запустив его без параметров вы получите список всех опций. Ниже приводится несколько примеров использования.

Создание папки и ярлыка в меню «Пуск»

<pre>
mkdir "%OSGEO4W_STARTMENU%"
mkdir "%OSGEO4W_STARTMENU%\Apache"
xxmklink "%OSGEO4W_STARTMENU%\Apache\OSGEO4W-Apache-Install.lnk" %OSGEO4W_ROOT%\Apache\bin\httpd.exe " -k install -n \"Apache OSGEO4W Web Server\""
</pre>

Ярлык со специальной иконкой

<pre>xxmklink "%OSGEO4W_STARTMENU%\ttt.lnk" cmd.exe "" . "my_desc" 1 "%OSGEO4W_ROOT%\OSGeo4W.ico"</pre>

Ярлык на «Рабочем столе»

<pre>xxmklink "%ALLUSERSPROFILE%\Desktop\OpenEV.lnk" "%OSGEO4W_ROOT%\bin\openev.bat" " " \ "OSGeo4W OpenEV" 1 "%OSGEO4W_ROOT%\apps\openev\icon.ico"</pre>

Кроме обновления конфигурационных файлов и создания ярлыков из этих командных файлов можно запускать любую команду DOS и любое установленное приложение с нужными параметрами.

=== Переменные окружения и запуск ===

Некоторым приложениям необходимо наличие определенных переменных окружения. Установка переменных окружения в командной строке OSGeo4W выполняется при помощи файла инициализации в <tt>/etc/ini</tt>. Это обычный .bat файл, в котором прописана установка необходимых переменных, например

<pre>SET GDAL_DATA=%OSGEO4W_ROOT%\share\gdal</pre>

Эти файлы выполняются в случайном порядке скриптом <tt>%OSGEO4W_ROOT%\OSGeo4W.bat</tt>, который отвечает за создание среды для командной строки OSGeo4W. Переменная OSGEO4W_ROOT устанавливается автоматически.

Для запуска приложений с определенным набором переменных окружения используются .bat файлы. Так, чтобы запустить приложение <tt>foo.exe</tt> со стандартным набором переменных окружения, необходимо создать командный файл <tt>foo.bat.tmpl</tt> следующего содержания

<pre>
@echo off
SET OSGEO4W_ROOT=@osgeo4w@
call "%OSGEO4W_ROOT%\bin\o4w_env.bat"
start "Foo window title" /B "%OSGEO4W_ROOT%\bin\foo.exe" %*
@echo on
</pre>

Это файл должен находиться в каталоге <tt>/bin</tt> пакета. А в файле <tt>postinstall.bat</tt> необходимо предусмотреть установку корректного пути для OSGEO4W_ROOT и переименование <tt>foo.bat.tmpl</tt> в <tt>foo.bat</tt>. За примерами можно обратиться к существующим пакетам, например, qgis.

=== Загрузка пакета на сервер и документирование ===

После того, как структура каталогов пакета подготовлена и все файлы разложены на свои места, создаём архив

<pre>tar cjvf tinyows-1.0.0rc1-1.tar.bz2 apps/ bin/ etc/ httpd.d/</pre>

При помощи WinSCP или SSH подключаемся к серверу upload.osgeo.org (нужен [http://www.osgeo.org/osgeo_userid OSGeo Id] и соответсвующие права доступа), создаем каталог для нового пакета, копируем в него файл <tt>setup.hint</tt> и сам пакет.

Проверим, правильно ли мы сформировали пакет:
<ul>
<li>создаём тестовый setup.ini (файл со списком доступных пакетов): 
<pre>http://upload.osgeo.org/cgi-bin/osgeo4w-regen.sh</pre></li>
<li>проверяем версии пакетов 
<pre>http://download.osgeo.org/osgeo4w/versions_test.html</pre></li>
<li>тестируем установку, запуская установщик с параметром -t и тестовым ini-файлом 
<pre>osgeo4w-setup.exe -t http://download.osgeo.org/osgeo4w/setup_test.ini</pre></li>
<li>если все установилось и работает правильно, переносим изменения в основной файл: 
<pre>http://upload.osgeo.org/cgi-bin/osgeo4w-promote.sh</pre></li>
</ul>

Осталось добавить новый пакет в [http://trac.osgeo.org/osgeo4w/wiki/PackageListing список пакетов] и создать ссылку на страничку пакета, где должны быть:

* краткое описание пакета
* ссылка на сайт запакетированного ПО
* имя ментейнера (ссылка на страницу с контактными данными)
* дополнительная информация о том, как пакет интегрирован в OSGeo4W

=== Ссылки по теме ===

* [http://trac.osgeo.org/osgeo4w/wiki/PackagingInstructions OSGeo4W Packaging Instructions]
* [http://gis-lab.info/qa/qgis-osgeo4w.html Установка QGIS/GRASS с помощью OSGeo4W]

Создание пакета для OSGeo4W - История изменений

Voltron: Новая страница: «{{Статья|Опубликована|osgeo4w-packaging}} {{Аннотация|Как создаются пакеты для OSGeo4W.}} Это руководс…»