В этой заметке я хочу показать несложный пример использования Phing для создания резервных копий базы данных (MySQL) и их отправки в репозиторий Subversion.

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

Примечание. Если вы слышите слово Phing впервые, то, думаю, вам будет интересно почитать статью Программирование на PHP. Избавляемся от рутинных операций с помощью Phing, а может быть и весь раздел Phing этого блога

Возвращаемся к нашей задаче.

Для создания резервной копии базы можно использовать утилиту mysqldump. В её параметрах нужно указать имя пользователя базы, его пароль и название базы. Дополнительно нужно задать имя файла в который мы сохраняем дамп.

Например, так

mysqldump -uпользователь -pпароль название_базы > dump.sql

Для сохранения файла в Subversion используется команда commit.

svn.exe commit -m “db_backup” --username имя --password пароль имя_файла

Здесь мы указываем текст сообщения (после параметра -m), имя пользователя Subversion, его пароль и имя файла, который нужно сохранить.

Примечание. Подробнее об этой системе контроля версий можно почитать в разделе Subversion.

Теперь рассмотрим build-файл.

<?xml version="1.0" encoding="UTF-8"?>
<project name="DbBackup" default="commit" basedir=".">

	<property name="DUMP_FILE" value="dump.sql" />
	<property name="MYSQL_PATH" value="путь_к_mysql" />
	<property name="DB_NAME" value="имя_базы_данных" />
	<property name="DB_HOST" value="localhost" />
	<property name="DB_USER" value="имя_пользователя_mysql" />
	<property name="DB_PASS" value="пароль_mysql" />

	<property name="SVN_USER" value="имя_пользователя_subversion" />
	<property name="SVN_PASS" value="пароль_subversion" />

	<target name="backup">
		<exec command="${MYSQL_PATH}mysqldump -u${DB_USER} -p${DB_PASS} ${DB_NAME} > ${DUMP_FILE}" dir="." />
	</target>

	<target name="commit" depends="backup">
		<exec command="svn.exe commit -m "db_backup" --username ${SVN_USER} --password ${SVN_PASS} ${DUMP_FILE}" dir="." />
	</target>
</project>

Как видите, большую часть файла занимают свойства (имена, пароли, адрес сервера, размещение mysqldump).

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

Для выполнение наших команд мы использовали стандартную задачу exec. Как несложно догадаться она просто выполняет указанную команду.

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

Думаю, вы догадались, что используя такие build-файлы можно автоматизировать работу с любыми консольными программами.

Конечно, создание самого build-файла отнимает немного времени, но вы быстро его вернете и, кроме того, будете делать меньше ошибок (особенно если нужно выполнять длинные последовательности операций).

И в заключение, небольшой совет. По-умолчанию Phing не выводит результат выполнения команды. Т.е. вы не знаете выполнилась на самом деле команда или нет.

Например, если в данном примере написать sbn.exe вместо svn.exe и запустить этот build-файл, то в результате вы увидите обычное сообщение BUILD FINISHED. Естественно, новая версия файла в репозитории сохранена не будет.

Поэтому на этапе тестирования очень полезно запускать phing с параметром -verbose.

phing -verbose

В этом случае вы увидите множество интересных сообщений и в том числе

“sbn.exe” не является внутренней или внешней командой …

После того, как вы убедитесь, что всё работает правильно, можно перейти обычный режим.

Время – деньги. Цените его!

На сегодняшний день большинство web приложений содержит множество конфигурационных файлов с различными настройками. Например, имя домена, параметры подключения к базе данных, размещение библиотек и т.д.

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

Представьте ситуацию. Вы делаете сайт, сначала тестируете его локально, а затем переносите на сервер. Естественно, перед загрузкой на сервер нужно будет как минимум изменить параметры подключения к БД.

Затем вы находите ошибку (или просто решаете что-то изменить) и процесс повторяется заново.

Каждый раз менять настройки вам быстро надоест, особенно если изменить нужно не один файл, а несколько. Да и забыть что-то очень легко.

В этой статье я покажу небольшой пример как с помощью Phing можно автоматизировать такие операции.

Примечание. Почитать о том что такое Phing и зачем нужен можно здесь.

Прежде всего, сформулируем задачу.

Чтобы ничего не придумывать я возьму пример из предыдущей статьи. Напомню, речь там шла об использовании Яндекс.Карт.

Дело в том, что для вставки карты на свой сайт нужно получить у Яндекса специальный API-ключ, который выдается для каждого домена отдельно. Т.е. ключ, полученный для mydomen.local, не будет работать на mydomen.com.

Таким образом, перед переносом страницы с картой на сервер нужно изменить этот ключ.

UPD. Когда я практически дописывал этот пост пришел комментарий к предыдущей статье от Андрея Кармацкого, в котором он рассказал, что api-ключ, полученный для любого домена, будет работать и на localhost.

Напомню, ключ указывается внутри тега script в заголовке страницы.

<script src="http://api-maps.yandex.ru/1.0/index.xml?key=key_for_local_domen" type="text/javascript"></script>

Здесь нам нужно key_for_local_domen заменить на новый ключ.

Посмотрим как с помощью Phing решить эту задачу.

Создаем в корне проекта файл с названием build.xml

<?xml version="1.0" encoding="UTF-8"?>
<project name="IPLocYandexMaps" default="deploy" basedir=".">

	<property name="DEPLOY_DIR" value="deploy" />
	<property name="SRC_DIR" value="public_html" />
	<property name="DEPLOY_KEY" value="api-key-for-my-host" />

	<target name="prepare">
		<echo msg="Removing old files..." />
		<delete dir="${DEPLOY_DIR}" includeemptydirs="true" verbose="true" failonerror="true" />
		<echo msg="Creating new dir..." />
		<mkdir dir="${DEPLOY_DIR}" />
	</target>

	<target name="copyfiles" depends="prepare">
		<echo msg="Copying main files..." />
		<copy todir="${DEPLOY_DIR}">
			<fileset dir="${SRC_DIR}">
				<include name="index.php" />
			</fileset>
			<filterchain>
				<replaceregexp>
					<regexp pattern="index.xml\?key=(.*?)"" replace="index.xml?key=${DEPLOY_KEY}"" />
				</replaceregexp>
			</filterchain>
		</copy>
	</target>

	<target name="deploy" depends="copyfiles">
	</target>
</project>

Теперь рассмотрим как это все работает.

В начале (строки 4-6) мы объявили три константы:
DEPLOY_DIR – имя папки, в которой будет размещен измененный файл (в данном примере – index.php);
SRC_DIR – имя папки с исходным файом;
DEPLOY_KEY – API-ключ.

Затем мы написали операцию prepare (строки 8-13). Она сначала удаляет папку ${DEPLOY_DIR} со всем содержимым, и сразу же создает её заново. Такой подход гарантирует, что если мы решим изменить имя файла со страницей, то в папке deploy не останется файл со старым именем.

И, самое интересное, операция copyfiles.

Сначала мы создаем задачу копирования (тег copy, строка 17) и указываем какие файлы нужно скопировать (в данном случае это только один файл – index.php).

После этого добавляем задачу filterchain (строки 21-25), т.е. создаем цепочку фильтров, которая будет применена к каждому копируемому файлу.

Чтобы заменить ключ нам хватит всего одного фильтра, который выполнит замену на основе регулярного выражения (строки 22-24). Фильтр создаем с помощью тегов replaceregexp и regexp.

Для regexp нужно задать параметры в атрибутах:

pattern – регулярное выражение;
replace – текст на который будет заменен результат поиска.

Вот и все, теперь с помощью этого build файла мы сможем изменять ключ буквально одним нажатием кнопки.

Примечание. Последняя операция сама по себе ничего не делает, а просто запускает предыдущие.

Кстати, есть ещё одно преимущество такого подхода. Т.к. Phing копирует файл с новым ключом в отдельную папку, то ваша локальная версия страницы остается в рабочем состоянии.

Представьте сколько времени можно сэкономить если вам нужно заниматься поддержкой страниц с такими картами на десятке разных доменов

Удачи!

Интересно почитать.

Оригинальные и очень красивые отделочные материалы – РБО и сайдинг бамбуковый.
Создаем собственный микроклимат с помощью BIOCLIMATIC.

Тема работы с Phing уже не однократно поднималась в этом блоге. Переоценить значение этого инструмента очень сложно. Но всегда наступает момент, когда стандартных возможностей становиться недостаточно. В такой ситуации вы можете сами написать нужные функции и оформить их в виде задач.

В этой статье я покажу пример создания такой задачи.

Примечание. Я предполагаю, что вы хотя бы в общих чертах знакомы с Phing и знаете как его установить и написать простейший build файл. Если нет, советую сначала почитать эти статьи: Программирование на PHP. Избавляемся от рутинных операций с помощью Phing и Использование Phing для сборки web приложений.

Допустим, нам нужно изменять кодировку файлов. На PHP сделать это можно, например, с помощью функции mb_convert_encoding. В качестве параметров она принимает:
- исходный текст;
- нужную кодировку;
- исходную кодировку.
А после выполнения возвращает перекодированный текст.

Т.е. можно написать элементарный PHP скрипт, который будет изменять кодировки указанных файлов.

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

С другой стороны, с помощью Phing мы можем запустить несколько операций нажатием одной кнопки. Почему бы не добавить сюда и перекодировку?

Итак, приступим.

Шаг 1. Составляем перечень исходных данных.

Исходя из перечня параметров функции mb_convert_encoding нам потребуются:
- название исходной кодировки файлов;
- название кодировки, в которую мы хотим преобразовать файлы;
- список файлов;
- папку, в которую будем складывать перекодированные файл.

Теперь взгляните на пример использования нашей задачи.

<taskdef name="convencoding" classname="phing.tasks.my.convEncodingTask" />

<target name="convertencoding">
	<convencoding fromencoding="windows-1251" toencoding="utf-8"
		targetdir="new_dir">
		<fileset dir="src_dir" />
	</convencoding>
</target>

Разберем его подробнее.

В первой строке мы подключаем нашу задачу. Конечно, на данный момент мы её еще не написали, но уже сейчас нужно определиться с её размещением и названием (задается в атрибуте classname).

В данном случае, она должна находиться в папке phing.tasks.my. Тут phing указывает на папку в которую он установлен, а все точки нужно заменить на «\» (или «/»).

После этого мы создаем новую операцию (target) и в неё добавляем нашу задачу (convencoding) (строки 4-7).
В её атрибутах указываем три параметра:
- fromencoding – исходная кодировка;
- toencoding – кодировка, которую нужно получить;
- targetdir – папка, в которую будем складывать перекодированные файлы.

И добавляем тег fileset, в котором определяем список исходных файлов.

Шаг 2. Создаем скрипт задачи.

Для этого заходим в папку с phing/tasks/, создаем в ней папку my, а в ней файл convEncodingTask.php. Этот файл будет содержать весь код нашей задачи. Его название составляется из названия задачи и слова Task.

Этот файл должен содержать класс, название которого совпадает с именем файла и, кроме того, он должен быть потомком класса Task.

Объявляем класс.

require_once 'phing/Task.php';

class convEncodingTask extends Task {

}

Шаг 3. Работа с атрибутами.

Как я уже говорил, все исходные данные для задач Phing мы передаем в атрибутах. Поэтому объявляем свойства для каждого атрибута (область видимости – protected).

protected $targetDir;
protected $fromEncoding;
protected $toEncoding;
protected $filesets    = array();
protected $failonerror = false;

Названия свойств должны совпадать с названиями атрибутов.

Обратите внимание на свойство $filesets, которому мы присвоили пустой массив. В нем будет храниться список файлов, который мы задали с помощью задачи fileset (строка 7 в первом листинге).

Последнее свойство используется для того, чтобы разработчик build файла мог указать нужно ли продолжать выполнение при возникновении ошибки в этой задаче.

Каждый атрибут с исходными данными должен иметь соответствующее свойство и метод, который его устанавливает.

Тут важно понимать, что Phing вызывает эти методы сам, т.е. нам нужно их только объявить.

public function setTargetDir($targetDir) {
	$this->targetDir = $targetDir;
}

public function setFromEncoding($fromEncoding) {
	$this->fromEncoding = $fromEncoding;
}

public function setToEncoding($toEncoding) {
	$this->toEncoding = $toEncoding;
}

public function setFailonerror($value) {
	$this->failonerror = $value;
}

Как видите, эти методы просто устанавливают значения соответствующих свойств. Их имена образуются добавлением приставки set к имени свойства.

Шаг 4. Добавляем поддержку списка файлов.

Отдельных пояснений требует метод установки списка файлов. Называется он createFileSet.

В нём мы создаем объект типа FileSet, сохраняем его в массиве $this->filesets. Этот метод должен возвратить сохраненный объект.

public function createFileSet() {
	$num = array_push($this->filesets, new FileSet());
	return $this->filesets[$num - 1];
}

Еще раз хочу напомнить. Напрямую к этим методам мы обращаться не будем. Это сделает Phing без нашего участия. Поэтому очень важно правильно записать имена методов и проследить за типом возвращаемых значений.

Шаг 5. Инициализация

Тут нам нужно просто объявить метод init

public function init() {
    return true;
}

Шаг 6. Пишем основной метод.

В нём мы будем выполнять изменение кодировок файлов. На момент его запуска Phing установит значения всех свойств, т.е. мы можем ими спокойно пользоваться (внутри этого метода).

Теперь взгляните на код метода.

public function main() {
	//проверяем, установлен ли модуль Multibyte String
	if (function_exists("mb_convert_encoding")) {
		//начинаем обработку
		//(у нас может быть несколько наборов файлов FileSet)
		foreach ($this->filesets as $fs) {
			try {
				//получаем массив со списком исходных файлов
				$files = $fs->getDirectoryScanner($this->project)->getIncludedFiles();
				$fullPath = realpath($fs->getDir($this->project));
				//изменяем кодировку каждого файла
				foreach ($files as $file) {
					$this->log('Converting file ' . $file);
					//формируем путь к конвертированному файлу
					$target = $this->targetDir . '/' . str_replace($fullPath, '', $file);
					if (file_exists(dirname($target)) == false) {
						mkdir(dirname($target), 0700, true);
					}
					//конвертируем файл
					file_put_contents($target, mb_convert_encoding(file_get_contents($fullPath . '/' . $file), $this->toEncoding, $this->fromEncoding));
				}
			} catch (BuildException $be) {
				// папка не существует или доступ к ней закрыт
				if ($this->failonerror) {
					throw $be;
				} else {
					$this->log($be->getMessage(), $this->quiet ? Project::MSG_VERBOSE : Project::MSG_WARN);
				}
			}
		}
	}
	else {
		//ошибка (недоступна функция mb_convert_encoding)
		$be = new BuildException('No Multibyte String support');
		if ($this->failonerror) {
			throw $be;
		}
		else {
			//если нужно продолжать выполнение build файла, несмотрая на ошибку, просто пишем в лог
			$this->log($be->getMessage(), $this->quiet ? Project::MSG_VERBOSE : Project::MSG_WARN);
		}
	}
}

Больше чем вы ожидали? Давайте посмотрим внимательнее. Большую часть здесь занимают: работа со списком файлов, различные проверки и обработка ошибок.

Рассмотрим все по порядку.

В строке 3 мы проверяем, доступна ли функция mb_convert_encoding. Если нет, то создаем исключение (BuildException) и в зависимости от значения свойства failonerror либо отправляем его, либо пишем сообщение в лог.

Если функция доступна, начинаем обработку файлов.

Как вы помните, список файлов хранится в свойстве filesets, точнее в нем хранится массив объектов FileSet, каждый из которых содержит список файлов.

Поэтому для обработки всех файлов нам нужно использовать два вложенных цикла. Внешний (строка 6) проходит по всем объектам FileSet, а внутренний (строка 12) – по всем файлам в этих объектах.

Вы, наверное, заметили, что здесь мы используем свойство, которого не объявляли ($this->project). Это свойство содержит объект с данными проекта и создается автоматически. В данном случае мы его используем при получении имен файлов.

Кроме того, мы используем несколько методов объекта FileSet. Например, getDirectoryScanner (объявлен в файле phing\types\AbstractFileSet.php). Подробно я на них останавливаться не буду, названия говорят сами за себя. В любом случае, они нам нужны только для того, чтобы получить список исходных файлов. И в большинстве задач этот код (строки 9-10) меняться не будет.

Во внутреннем цикле (строки 12-21) мы формируем пути к перекодированным файлам и изменяем кодировку (строка 20).

Обратите внимание на строку 13. В ней мы записываем в лог имена всех переименованных файлов. Эти записи очень помогают при поиске ошибок в build файлах.

В строках 22-29 мы перехватываем и обрабатываем возможные исключения.

Заключение.

Как видите, создание собственно задачи для Phing не намного сложнее разработки обычного PHP скрипта. Нужно только знать несколько правил и особенностей.

По большому счету, написать скрипт с аналогичной функциональностью было бы сложнее, т.к. пришлось бы писать парсер для xml файла или придумывать другой способ ввода информации.

Скачать.

Если вы хотите поэкспериментировать – качайте архив с этой задачей. В нем же находится небольшая инструкция по установке.

Интересно почитать.

Учимся профессионально водить с авто инструктором.
Рассказать о чем-то всему миру можно с помощью бесплатные объявления казахстан.
Позаботиться о своем здоровье вам помогут в клиника Марыныч.

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

В стандартной комплектации Phing загрузку по FTP не поддерживает (кстати, довольно странно). Но, естественно, писать самостоятельно этот task не придется. Все уже сделано за нас .

Я нашел два task’а, предназначенных для работы с FTP: FtpUploadTask и FtpDeploy.

Т.к., судя по описанию, возможности и настройки практически идентичны, я расскажу только о первом. К тому же его автор ведет собственный блог (Чудо{вищные} заметки) и написал довольно много интересных статей о Phing.

Прежде чем перейти к описанию, хочу предупредить.

Не ставьте эксперименты на вашем рабочем сервере! Установите локальный FTP (вполне подойдет FileZilla Server (http://filezilla-project.org/)) и тестируйте на нём.

Устанавливаем task.

Качаем файл FtpUploadTask.php и сохраняем его в папку $PHING_DIR$/tasks/ext/ ($PHING_DIR$ – папка в которую установлен Phing).

Объявляем новый task. Для этого в build файл добавляем строку.

<taskdef name="ftpupload" classname="phing.tasks.ext.FtpUploadTask" />

Теперь можно использовать ftpupload для отправки файлов на сервер.

Я приведу пример задачи, которую написал в дополнение к предыдущей статье.

<target name="deploy" depends="copyfiles, gzipjs, minifycss">
	<ftpupload host="host" username="user" password="pass" cleanDir="true" targetDir="/app_folder/">
		<fileset dir="${DEPLOY_DIR}">
		</fileset>
	</ftpupload>
</target>

Здесь мы указали следующие параметры:

1) host – адрес сервера;

2) username – имя пользователя (с правами записи);

3) password – пароль;

4) cleanDir – удаляем все старые файлы;

5) targetDir – папка в которую будет загружено приложение.

Список загружаемых файлов создаем с помощью fileset, т.е. в данном случае мы включили все файлы приложения.

Кроме того, можно задать ещё несколько параметров, например, явно указать порт FTP сервера. Полный список параметров можно посмотреть здесь.

Как видите, Phing – это очень удобный инструмент, особенно если вы нашли все необходимые task'и . Но, в любом случае, если вы можете написать PHP скрипт, который решает вашу задачу, то переделать его в виде task’а будет совсем не сложно.

До встречи!

P.S. Ещё раз хочу напомнить. Подумайте дважды (лучше трижды), прежде чем запускать ftpupload с параметрами cleanDir="true" targetDir="/". Восстановить файлы будет НЕВОЗМОЖНО.

Интересно почитать:

Маленькие хитрости Google – найдем наших конкурентов в AdSense.

Современные IDE буквально «нашпигованы» различными возможностями. Тем не менее, предусмотреть все невозможно и возникают ситуации, когда нужно использовать дополнительные программы. Речь, прежде всего, идет о различных консольных утилитах.

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

Прежде чем приступать к настройке Eclipse, необходимо определиться с параметрами, которые нужно передавать программе.

В качестве примера рассмотрим запуск Phing (о нем речь шла в прошлой статье).

Формат команды такой:

phing -f mybuildfile.xml mytarget

Сначала идет имя программы, затем имя build файла (mybuildfile.xml) и название задачи которую нужно выполнить (mytarget). Тут предполагается:

1) что система знает, где находится phing (путь указан в переменной PATH), если это не так, то необходимо явно указать путь к нему;

2) вы выполняете команду в папке, в которой находится файл mybuildfile.xml (в противном случае нужно указать его размещение).

Кроме того, поддерживается сокращенный вариант записи команды.

Например, если опустить название файла, то Phing попытается использовать файл build.xml. Название задачи тоже можно не указывать. В этом случае её имя будет взято из атрибута default тега project.

Теперь посмотрим, как запустить эти команды из Eclipse. Для начала сделаем вариант запуска без параметров.

Открываем меню Run – External Tools – Open External Tools Dialog…

В левой части окна выбираем пункт Program и нажимаем кнопку «New launch configuration» (обведена зеленым).

В правой части окна указываем:

1) Имя задачи (поле Name).

2) Размещение программы (Location). Я указал абсолютный путь к файлу phing.bat.

3) Рабочую папку (Working Directory). Чтобы её выбрать нажимаем кнопку «Browse Workspace» (обведена синим) и выбираем текущий проект.

4) Нажимаем Apply и закрываем это окно.

Описанные настройки показаны на скриншоте.

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

Как видите, в первом пункте меню появилась наша новая команда (Phing).

Теперь добавим возможность запуска произвольной задачи из build файла. Для этого снова открываем Open External Tools Dialog и создаем ещё одну команду (Phing custom). Настройки такие же, только в поле Arguments задаем параметр ${string_prompt}. Его можно выбрать, нажав на кнопку Variables (обведена красным).

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

Таким же образом, можно добавить поддержку практически любых консольных утилит в Eclipse.

Удачи!

В этой статье я хочу рассказать об использовании Phing при разработке небольшого web приложения. Почему небольшого? Все очень просто. С одной стороны в качестве примера будет использован реальный build файл, а не упрощенный вариант из учебника. А с другой – этот build файл достаточно короткий, и о нем можно было рассказать в рамках статьи .

Примечание. Phing – это система сборки проектов, основанная на Apache Ant. Я предполагаю, что вы знаете как её установить и настроить. Если нет – читайте «Программирование на PHP. Избавляемся от рутинных операций с помощью Phing».

Итак, приступим.

Недавно я писал о генераторе форм для фреймворка CodeIgniter. Как вы понимаете приложение небольшое, но, тем не менее, перед переносом его на сервер нужно сделать массу рутинных операций.

1) Subversion в каждой папке приложения создает скрытую папку “.svn”, что значительно усложняет «ручное» копирование файлов. Т.е. каждую папку придется копировать отдельно.

2) JavaScript и CSS файлы желательно сжать.

3) Кроме того, много маленьких файлов загружаются дольше, чем один большой. Т.к. в данном приложении используется 5 js-файлов, то разумно будет объединить их в один. С другой стороны, во время разработки удобнее работать именно с 5-тью маленькими файлами.

4) Раз мы объединяем несколько js-файлов в один, то необходимо изменить теги <script> в заголовках страниц.

5) Практически все современные браузеры поддерживают gzip сжатие. Поэтому сделаем архивную версию объединенного JavaScript файла (для браузеров, которые поддерживают gzip, будем отдавать архивную версию, всем остальным – обычную).

Как видите, работы не много. Но представьте, вы подготовили приложения для размещения на сервере, и нашли ошибку или решили что-то изменить. Исправить сжатые js файлы конечно можно, но, поверьте, это далеко не самое увлекательное занятие . Т.е. вам придется внести исправления в исходный вариант и выполнить все шаги с 1 по 5 заново.

Естественно такую работу можно автоматизировать и Phing отлично подойдет в этой ситуации.

Рассмотрим размещение файлов проекта.

css/
	ie6styles.css
	styles.css
images/
	add.png
	ci_logo.jpg
	.......
lib/
	jquery/
		jquery.js
	tabs/
		jquery-ui-personalized-1.5.2.js
	tooltip/
		jquery.dimensions.js
		jquery.tooltip.js
	mainscripts.js
index.html
.htaccess
build.xml

Здесь index.html – единственная страница приложения, build.xml – файл с задачами для Phing, .htaccess – определяет в каком случае отправлять архивную версию js файла (подробнее здесь).

Переходим к build файлу. Т.к. он довольно объемный я буду приводить его по частям. Прежде всего, создаем проект и несколько свойств.

<project name="CIFormBuilder" default="deploy" basedir=".">

	<property name="DEPLOY_DIR" value="deploy" />
	<property name="IMG_DIR" value="images" />
	<property name="CSS_DIR" value="css" />
	<property name="LIB_DIR" value="lib" />

	<property name="GLOBAL_LIB_DIR" value="E:/www/libs" />

	.............

</project>

Имя (name) проекта выбираем произвольно. В атрибуте default указываем название задачи, которая будет выполняться по умолчанию. basedir – корневая папка проекта.

С помощью свойств (property) мы объявили константы, которые в данном случае содержат имена папок.

Отдельно хочу остановиться на GLOBAL_LIB_DIR. Это свойство содержит имя папки, в которой находятся PHP скрипты для сжатия файлов (подробнее о них ниже).

Как вы, наверное, догадались, все файлы проекта, предназначенные для размещения на сервере, мы скопируем в папку deploy. Поэтому, прежде всего, создаем её.

<target name="prepare">
	<echo msg="Removing old files..." />
	<delete dir="${DEPLOY_DIR}" includeemptydirs="true" verbose="true" failonerror="true" />
	<echo msg="Creating new dir..." />
	<mkdir dir="${DEPLOY_DIR}" />
</target>

Эта задача сначала пытается удалить папку deploy (операция delete) вместе со всем содержимым, а затем с помощью mkdir создает её заново. Таким образом, можно быть уверенным, что проект не будет содержать старых файлов.

Примечание. Операция echo выводит произвольное сообщение. К сожалению, русские буквы отображаются не правильно.

Теперь копируем в эту папку все файлы кроме js и css. И сразу же исправляем теги <script> в index.html.

Разберем эту задачу подробнее. В первой строке мы задали название и указали, что эта задача зависит от prepare. Т.е. при вызове copyfiles всегда предварительно будет выполняться prepare.

В строках 3-9 мы копируем файлы картинок. Для этого используется операция copy, а список файлов, которые нужно скопировать, создается с помощью fileset.

После этого копируем index.html и .htaccess. Здесь наибольший интерес представляет операция filterchain. Она создает цепочку фильтров, через которые пропускаются файлы. В данном случае фильтр только один. В нем мы используем операцию замены по регулярному выражению replaceregexp.

Первое правило (строка 18) удаляет все теги <script>. Второе – находит тег </head> и вставляет перед ним тег скрипт со ссылкой на объединенный js файл (global.js). Третье – добавляет к именам css файлов суффикс -min (сжатые версии файлов).

Таким образом, в папку deploy будет записан исправленный index.html.

Теперь займемся сжатием файлов.

В стандартную поставку Phing нужные нам задачи не входят. Поэтому нам понадобятся две библиотеки: JSMin и CSSMin. Размещаем их в папке, которую мы задали в свойстве GLOBAL_LIB_DIR.

Напрямую работать с библиотеками Phing не может. Поэтому нужно создать соответствующие операции (tasks). Каждая такая операция представляет собой PHP класс. Описать его в рамках одной статьи не реально, да и необходимости в этом нет. Для бибилиотеки JsMin я нашел готовое решение и в течении 15 минут переписал его для использования с CSSMin (в конце статьи приведена ссылка на архив с этими файлами).

Т.е. вам нужно просто распаковать этот архив в папку #PHING_DIR#/tasks.

Для того, чтобы Phing узнал о том, что вы создали операцию необходимо в build файле использовать taskdef. Выглядит это так:

<taskdef name="stubjsmin" classname="phing.tasks.my.stubJsMinTask" />
<taskdef name="stubcssmin" classname="phing.tasks.my.stubCssMinTask" />

Правила следующие. Имя должно совпадать с именем класса, но без окончания task. Имя класса (classname) задает имя класса с учетом пути к нему (в качестве разделителя папок используется точка).

Теперь напишем задачу, которая будет сжимать js файлы. Сначала создадим набор файлов (fileset).

<fileset id="srcjs" dir="${LIB_DIR}">
	<include name="jquery/jquery.js" />
	<include name="tabs/jquery-ui-personalized-1.5.2.js" />
	<include name="tooltip/jquery.dimensions.js" />
	<include name="tooltip/jquery.tooltip.js" />
	<include name="mainscripts.js" />
</fileset>

Теперь сжимаем файлы.

<target name="minifyjs">
	<echo msg="Minifying JavaScript files..." />
	<stubjsmin jsminpath="${GLOBAL_LIB_DIR}/jsmin/jsmin-1.1.1.php"
		targetdir="${DEPLOY_DIR}/${LIB_DIR}">
		<fileset refid="srcjs" />
	</stubjsmin>
</target>

Здесь нужно отметить два момента.

Первый – использование операции stubjsmin. В её параметрах мы указываем размещение библиотеки JSmin и путь к папке, в которой будут размещены сжатые файлы. При записи сжатых файлов будет сохранена структура папок, в которых они размещены.

Второй – использование fileset внутри stubjsmin. Имя набора файлов указывается с помощью параметра refid.

Сжатие CSS файлов выполняется точно также.

<target name="minifycss">
	<echo msg="Minifying CSS files..." />
	<stubcssmin cssminpath="${GLOBAL_LIB_DIR}/cssmin/cssmin_v.1.0.php"
		targetdir="${DEPLOY_DIR}/${CSS_DIR}">
		<fileset dir="${CSS_DIR}" />
	</stubcssmin>
</target>

Теперь объединяем JavaScript файлы в один и удаляем сжатые версии js файлов.

<target name="combinejs" depends="minifyjs">
	<echo msg="Creating single js file..." />
	<append destFile="${DEPLOY_DIR}/${LIB_DIR}/global.js">
		<filelist dir="${DEPLOY_DIR}/${LIB_DIR}"
			files="jquery/jquery-min.js, tabs/jquery-ui-personalized-1.5.2-min.js, tooltip/jquery.dimensions-min.js, tooltip/jquery.tooltip-min.js, mainscripts-min.js" />
	</append>
	<echo msg="Deleting minified js files..." />
	<delete includeemptydirs="true">
		<fileset dir="${DEPLOY_DIR}/${LIB_DIR}">
			<include name="**" />
			<exclude name="global.js" />
		</fileset>
	</delete>
</target>

Операций всего две.

1) Объединение файлов (append). Файл, в который будет записан результат, задается с помощью параметра destFile, а файлы-источники – с помощью filelist. Это важный момент, т.к. нам нужно объединять файлы в определенном порядке (сначала библиотеки, а потом функции, их использующие). А filelist в отличие от fileset сохраняет не только имена файлов, но и порядок в котором они перечислены.

2) Удаление (delete) ненужных файлов. Здесь все просто. Удаляем все файлы и папки кроме global.js (строка 11).

Теперь нам нужно заархивировать (gzip) файл global.js.

Тут я столкнулся с одним непонятным моментом. В принципе, существует операция tar, в параметрах которой можно указать метод сжатия – gzip.

<tar destfile="archive_name.gz" basedir="." compression="gzip" />

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

В общем, разбираться было лень, и я решил задачу «в лоб». Использовал архиватор 7-zip. Для выполнения системных команд в Phing предусмотрена операция exec.

Обратите внимание. Если путь к файлу содержит пробелы, то его нужно взять в кавычки, которые задаются с помощью эскейп последовательности ". Параметр dir указывает рабочую папку программы.

И завершающий штрих. Задача deploy. Сама по себе она ничего не делает, но в её параметре depends перечислены задачи, которые должны быть выполнены при её вызове.

<target name="deploy" depends="copyfiles, gzipjs, minifycss">
</target>

Таким образом, если выполнить команду

e:\projectfolder> phing

в корневой папке проекта, то будут последовательно запущены все перечисленные в этой статье задачи.
Примечание. Если имя build файла не указано явно, то Phing ищет build.xml. Тоже самое касается задачи. По умолчанию выполняется та, которая указана в параметре default (в данном случае – это deploy).

Скачать

Архив с stubJsMinTask и stubCssMinTask.

Если возникли вопросы или замечания, не стесняемся, комментарии открыты .

До встречи!

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

Речь, конечно, пойдет о Phing. Он позволяет автоматизировать большинство рутинных операций, с которыми вы можете столкнуться во время разработки.

Принцип работы следующий. Вы создаете xml файл, в который записываете необходимые группы действия (о синтаксисе этого файла немного ниже), после этого вы сможете выполнить любую группу действий всего одной командой. Т.е., по большому счету, phing можно считать «продвинутой» версией командных файлов.

Примечание. Проект Phing основан на Apache Ant о котором я уже писал. Синтаксис файлов практически одинаков, основная разница заключается в том, что ant ориентирован в первую очередь на Java, а phing – на PHP.

Сделать даже сокращенный обзор возможностей такого инструмента в рамках статьи практически невозможно, поэтому я только покажу парочку практических примеров, чтобы вы могли сформировать общее представление о нем (если у вас его еще нет ).

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

Переходим к установке. Phing распространяется в двух вариантах. В виде PEAR пакета и как отдельный дистрибутив.

Для первого варианта установка сводится к выполнению двух команд:
pear channel-discover pear.phing.info
pear install phing/phing

А второй – достаточно подробно описан в документации, и останавливаться на нем я не буду.

Теперь выбираем проект и создаем для него build файл.

Для этого примера я взял проект с такой структурой:

public_html
	index.php
	js/
	css/
	system/
		application/
		............

Как видите, проект довольно простой, содержит две папки с таблицами стилей и JavaScript файлами, а в папке system – находится фреймворк CodeIgniter и php скрипты самого приложения (папка application).

Допустим, мы хотим передать кому-то архив с этим web приложением. Естественно, архив несложно создать вручную, всего пара кликов мышкой. Но подождите, если мы не хотим включать в него файлы фреймворка, то нам придется вручную сортировать файлы для архива.

Попробуем автоматизировать эту работу с помощью Phing.

Прежде всего, создадим папку, в которую будет помещен архив. Для этого создаем файл build.xml и пишем в него следующее:

<?xml version="1.0" encoding="UTF-8"?>
<project name="PhingTesting" default="packSrc" basedir=".">
	<target name="prepare">
		<mkdir dir="archive"></mkdir>
	</target>
	<target name="packSrc" depends="prepare"></target>
</project>

Разберем, что здесь написано.

Первая строка – обычный заголовок xml файла. Сразу за ней мы добавили тег project, внутри которого будут находиться все задачи данного проекта. Этот тег имеет три атрибута:
name – имя проекта;
default – имя задачи, которая будет выполняться по-умолчанию;
basedir – корневая папка проекта.

Внутри тега project может находиться любое количество тегов target, которые соответствуют конкретным задачам. Наша первая задача (строки 3-5) называется prepare и содержит всего одну операцию (task) – mkdir, которая создает папку.

Обратите внимание, что все операции по-сути являются обычными xml тегами, а в их атрибутах указываются параметры операций. В данном случае в атрибуте dir мы указали имя папки, которую нужно создать.

Теперь выполняем команду

phing prepare

Примечание. Название файла может быть любым, но если оно отличается от build.xml его придется указывать явно (например, phing my_file.xml prepare).

Теперь переходим к созданию архива.

<target name="packSrc" depends="prepare">
	<zip destfile="archive/my_project.zip" basedir="public_html"></zip>
</target>

Для этого мы создадим еще одну задачу – packSrc. Кстати, обратите внимание на ее атрибут depends. В нем можно перечислить задачи, которые должны быть выполнены раньше текущей. В данном случае в этом атрибуте мы указали задачу prepare, т.е. теперь нам не нужно запускать ее вручную.

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

На данный момент в архив будет добавляться весь проект целиком. Исправляем ситуацию.

<zip destfile="archive/my_project.zip">
	<fileset dir="public_html">
		<include name="index.php"></include>
		<include name="css/**"></include>
		<include name="js/**"></include>
		<include name="system/application/**"></include>
	</fileset>
</zip>

Как видите, мы добавили вложенный тег fileset, который предназначен для создания набора файлов. Добавление и удаление конкретных файлов и папок в набор выполняется тегами include и exclude, в атрибуте name которых указывают конкретное имя.

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

Кроме того, с помощью Phing можно запускать тесты, создавать документацию (PHPdocumentor), переименовывать файлы и папки, менять их содержимое, «заливать» файлы на сервер и выполнять множество других операций. К тому же вы всегда сможете расширить функциональность любой из стандартных задач Phing или написать свою собственную.

В заключение хочу сказать, что на первый взгляд использование такого инструмента для небольших проектов может показаться нерациональным. К тому же он требует некоторого времени на изучение. Но, если вы начнете им пользоваться, то вряд ли захотите возвращаться к «старому стилю» работы