Инструментарий

Хороший мастер работает лишь со своим инструментом, и сильно расстраивается когда оного нет под рукой, так и я — всё своё ношу с собой:

• IDE — PHP Storm
• Менеджер БД — SQLYog
• Всяко-разно — notepad++, putty, winscp…

PHP Storm

IDE решает многие задачи и проблемы, которые постоянно возникают перед разработчиком. Мой выбор остановился на PHP Storm, а до того я успел попробовать Zend Studio, Eclipse, Aptana, NetBeans и еще несколько о которых и не вспомню. Что же хорошего в данной IDE:

• java — т.е. нам практически любая платформа по плечу
• автодополнение — очень адекватное, и приучает к документированию кода
• автосохранение — забудьте про ctrl+s
• автозаливка (FTP/SFTP)
• автозаливка после комита
• исправление ошибок
• поддержка VCS
• рефакторинг
• поиск и замена по файлам – работает просто отлично, и частенько меня выручала
• отличная поддержка HTML/CSS/JS
• Zen coding из коробки (советую таки узнать что это ;)

Но без недостатков не бывает:

• java — т.е. любит память, и IDE приходится время от времени перезапускать — где-то раз в неделю
• цена — сейчас, со скидкой, это $50 (до 27-го ноября)

Отдельно оговорюсь насчет цены — у меня купленная версия, но так же есть Open Source лицензия, ее тоже можно получить, но только надо запастись терпением (как можно догадаться — у меня терпения не хватило). Насчет же NetBeans — задолбал он своей нестабильной работой и такими же обновлениями.

В качестве заключения: мои слова ничего не значат, верьте своим глазам — попробуйте триал, благо целого месяца хватит на распробовать ;)

Кстати, если кому нравится моя тёмная схема для PHP Storm, то её можно забрать с dropbox’a

SQLYog

Для работы с MySQL использую SQLYog, что же в нём такого хорошего:

• автодополнение
• профайлер
• автоформатирование запросов
• синхронизация структуры БД и данных при необходимости
• SSH туннель — если у вас есть SSH, то SQLYog в игре
• HTTP туннель — хотя хватит доступа и к FTP
• отлично работает под wine (по правде говоря есть огрехи, но совсем мелкие)

Ну не без ложки дёгтя:

• цена — от $69, но есть триальная и урезанная фришная версия

Опять же, есть триал — пробуйте, и забудьте про phpMyAdmin как про страшный сон.

Ещё чуть-чуть

Ой, ну дальше дело вкуса:

• Notepad++ — всегда на подхвате, открывает большие файлы, понимает все кодировки, с плагином hex-редактор
• PuTTY — без него никак, (puttygen рулит кстати)
• TotalCmd – файловый менеджер + FTP клиентб недавно вышла 8-ая версия (beta), не купил, жмакаю раз в неделю кнопку с циферкой
• WinScp – SFTP клиент (файловый менеджер over SSH)

Да, я работаю на винде, набор инструментов для Linux и Мас отличается лишь набором дополнительных тулзов…

Фишки PHP и 5.3 в частности

phpDocumentor

Я уже упоминал о крутом автодополнение в IDE, тук вот, чтобы этого добиться необходимо описывать классы, методы и функции используя doc comment’ы:

/**
 * @property integer $id
 * @property string $login
 * ...
 */
class Row
{

}

В результате IDE будет подсказывать нам всё что нужно:

Еще примерчик:

/**
 * @return Users\Row
 */
function getUser()
{
     return Registry::get("user");
}

/* @var Users\Row $user */
$user = Registry::get("user");

В IDE похожий результат:

Кроме бенефитов для IDE есть еще возможность сгенерировать техническую документацию используя PHPDocumentor:

/**
 * <code>
 * $this->getByLoginOrPasswordAndEmail(
 *      'vasya', md5(123456), 'vasya@mail.ru'
 *  )
 * </code>
 */
function getByColumnsFinder()
{
    /*...*/
}

Обернётся в:

Tips & Tricks: Fixme Comment

Заметки на будущее прям в коде:

// TODO: do something with some function
// FIXME: hands
// XXX: may be broken

IDE нынче умные пошли, и все такие заметки соберут до кучи:

Tips & Tricks: о include и require

А вы смотрели что возвращают функции include и require? А если в подключаемом файле используется return?

$config = require 'config.php';

<? // config.php
    return array(
        'DB' => array(...)
    );

Достаточно универсальный способ для подключения конфигурационных файлов.

Tips & Tricks: о фильтрации данных

На дворе уже закат PHP 5.2, а фильтры не используем:

// return string or false
filter_var('bob@example', FILTER_VALIDATE_EMAIL);
filter_var('bob@example.com', FILTER_VALIDATE_EMAIL);

// return string or false
filter_var('http://example.com', FILTER_VALIDATE_URL);

По теме:

• http://www.php.net/manual/en/function.filter-var.php
• http://www.php.net/manual/en/filter.filters.validate.php
• http://www.php.net/manual/en/function.filter-var-array.php

Иногда обработку массива превращают в что-то невообразимое, можно же проще:

  // array of ids
$ids = $Request->getParam("ids");

  // to integer
$ids = array_map("intval", $ids);

  // without zero
$ids = array_filter($ids);

  // unique
$ids = array_unique($ids);

  // prepare for SQL
$idsStr = join(",", $ids);

А бывают ситуации, когда в форме есть несколько submit кнопок, и надо понимать что же было нажато (о да, это плохие формы)

<form>
    ...
    <input type="submit" name="disable" value="Disable selected" />
    <input type="submit" name="enable" value="Enable selected" />
</form>

<?php  // gets current action
$action = current(array_intersect(array_keys(
    $_REQUEST), array('disable', 'enable')
));

Tips & Tricks: glob

Уже везде упоминали функцию glob, но мы всё так же её игнорируем, так что я решил её опять вспомнить:

$controllers = glob('/modules/*/controllers/*.php');

$modules = glob('/modules/*', GLOB_ONLYDIR);

Tips & Tricks: mysqlnd

Если у вас высокопроизводительное приложение, если вам знакомо понятие master и slave, если разруливаете это ручками, то вот оно — прозрение:

// in config
[myapp]
master[]=localhost:/tmp/mysql.sock
slave[]=192.168.2.27:3306

// in sources
$mysqli = new mysqli("myapp", "username", "password", "database");
$pdo = new PDO("mysql:host=myapp;dbname=database", "username", "password");

По теме:

• http://www.php.net/manual/en/book.mysqlnd.php
• Replication and load balancing mysqlnd plugin for all PHP MySQL extensions released

P.S. О, это уже было в … твитере ;)

Reflection

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

PHP 5.3

Приведу краткие тезисы по теме новшеств в PHP 5.3 (да, да, жевано-пережевано, но повторить то стоит)

Анонимные функции

Используете jQuery, значит ничего нового тут не увидите:

$ids = array_map(function($el){
    return intval($el);
}, $ids);
  // or
$toInt = function($el){
    return intval($el);
};
$ids = array_map($toInt, $ids);
  // or
$int = $toInt($el);

Замыкания

Смотреть в код до наступления понимания происходящего:

function getTimeout() {
    $el = "15 minutes";

    return function() use ($el){
        return intval($el);
    };
}

$timeOut = getTimeout();
echo $timeOut(); // >> 15

Магический метод __invoke()

Вместо слов, лишь код:

class Row
{
    function __invoke()
    {
        return $this->login;
    }
}

$user = new Users\Row();
$var = $user(); // >> return user login

Namespaces

Про пространство имён не писал лишь ленивый, но я предлагаю простую ассоциацию c файловой системой (спасибо за бэкслеш, ассоциация будет с Windows):

\              << Default namespace - root
\Exception
\StdClass
\Application   << Our namespace - Application
            \Model
                  \User
                  \Group
            \Controller
                  \User

• объявляя namespace — мы добавляем новый класс в иерархию «папок» — cd && mkdir
• говоря use — используем директорию из иерархии (1 или более) — как команда cd
• говоря use as — используем под определенным именем — ln
• всегда можно обращаться идя от корня (абсолютный путь: \Application\Model\Group)

Позднее статическое связывание

Эта непонятная фигня означает, что когда вы наследуете класс от статического, то у вас возникнут проблемы с доступом к статическим методам наследуемого класса, приведу наглядный (я надеюсь) пример:

class Latin
{
     const CHARS = 'abc...';
     static function getChars() {
         return self::CHARS;
     }
}
class French extends Latin
{
    const CHARS = 'aàábc...';
}

echo French::getChars(); // >> abc...

В PHP 5.3 решается просто:

class Latin
{
     const CHARS = 'abc...';
     static function getChars() {
         return static::CHARS; // << static
     }
}
class French extends Latin
{
    const CHARS = 'aàábc...';
}

echo French::getChars(); // >> aàábc...

Почти фреймворк

Ой, велосипед, да на «новых» технологиях, нямочка, зацените-ка контроллер:

namespace Bluz;
return
/**
 * @acl View User Profile
 * @cache 5 minutes
 * @param integer $id
 * @return closure
 */
function($id) use ($bootstrap, $app, $view) {
    /**
     * @var closure $bootstrap
     * @var Application $app
     * @var View $view
     */
     $view->user = $app->getDb()->getRow("...", array($id));
};

• Контроллер — анонимная функция возвращаемая при подключении файла
• Может вернуть что угодно, лишь бы было callable
• Принимает параметры с реквеста, уже отфильтрованнные (описали же в doccomment’e правила)
• Кеширует результат выполнения на 5 минут (опять reflection)
• Acl тут тоже не просто так ;)

Возможно выложим на общее обозрение сие творение, ну когда отшлифуем его ;)

Если что-то позабыл

Позабыл я о небольшом изменении в поведении тернарного оператора «(statement)?(then):(else)», у него появилось мини-сокращение:

echo $var?$var:'nil';
// ? : improvements
echo $var?:'nil';

Что-то оно не очень, можно было сделать лучше (эти примеры не работают!):

echo $var?;
// or
echo isset($var['elem'])?$var['elem'];

Еще «незаслужено» обошёл стороной метки:

// labels
start: echo "start"; goto finish;

echo "never";

finish: echo "finish";

Но наверное вы в курсе:

P.S. Всё это и еще немного больше я обычно рассказываю на лекциях в своём отделе ;)

Другие посты на эту тему

• No Related Post

С текущим списком тем и докладчиков можно ознакомиться на странице.

Событие будет интересно не только тем, кто использует Zend Framework, но и всем веб-разработчикам и PHP программистам в частности.

Место проведения — отель “Казацкий”, г. Киев, ул. Михайловская 1/3 (Площадь Независимости).

Стоимость участия и другая необходимая информация доступна на странице.

Для участия в конференции необходимо пройти регистрацию на странице, а затем произвести оплату из личного кабинета.

Сайт конференции – http://frameworksdays.com/event/zend-framework-day-2011
Наши новости в twitter – http://twitter.com/fwdays
Наша страница в facebook – http://facebook.com/fwdays

Другие посты на эту тему

• Мастер-класс Юры Артюха
• Мастер-класс по Sphinx
• Конференция ZFConf 2011
• ZFConf Ukraine
• Анонс мастер-классов по JavaScript’у
• Мастер-классы по JavaScript’у
• PDFEED – или RSS2PDF в новом обличье

Для начала нам потребуется скачать последнюю версию форума с официального сайта, а поскольку я тут успел наступить на одни грабли — то качаем последнюю бету — vanilla-core-2.0.18b2.

Встраиваем

По умолчанию, Vanilla форум имеет прекрасную возможность — встраиваться в любую HTML страничку посредством JavaScript’a, для этого нам понадобится активировать плагин <Embed> Vanilla (идет в стандартной поставке) и получить код скрипта:

<script type="text/javascript" src="http://forum.your-domain.com/plugins/embedvanilla/remote.js"></script>

Так же советую использовать дефолтную тему «Embed-Friendly» для встроенного форума — она достаточно простая и удобная для кастомизации.

Единственная проблема которая у меня возникла при подобном подключении форума — это ошибки JavaScript’a — разработчики форума не в курсе о методе jQuery().delegate() и используют jQuery('a').live('click'), чем вызывают не очень адекватное поведение ссылок на странице без атрибута href.

Интеграция с использованием ProxyConnect

Как понятно из подзаголовка, нам потребуется скачать плагин Vanilla ProxyConnect. Устанавливаем и идем настраивать (Users > Authentication):

Тут всё просто, по пунктам (пути в примере полные, могут быть относительные):

1. Ваш сайт
2. Страничка для получения данных о вашем пользователе (о ней чуть далее)
3. Страница регистрации
4. Страница входа
5. Страница выхода

Теперь займемся пунктом 2 — Authenticate URL. Это страничка, где у вас должны выводиться данные вашего текущего пользователя в простом формате:

UniqueID=1279
Name=Bob
Email=bob@gmail.com
TransientKey=qwerty
DateOfBirth=1970-01-01
Gender=Male
Roles=Member,Admin

• UniqueID — обязательное поле, UID пользователя в вашей системе
• Name — обязательное поле, username, или как он у вас обзывается
• Email — обязательное поле, email вашего пользователя
• TransientKey — ключ, для предотвращения CSRF атак (вам скорей всего не понадобится, для wordpress обязательно)
• DateOfBirth — дата рождения
• Gender — мальчик/девочка, Male/Female
• Roles — роли пользователя на Vanilla форуме, через запятую, можно IDшниками

Если у вас Zend Framework, то action будет выглядеть как-то так:

// disable View
$this->_helper->layout()->disableLayout();
$this->_helper->viewRenderer->setNoRender(true);

// get current User
$user = Zend_Auth::getInstance()->getIdentity();
if ($user) {
echo "UniqueID={$user->id}\n"
     . "Name={$user->username}\n"
     . "Email={$user->email}\n"
     . "Roles={$user->role}\n";
} else {
echo "UniqueID=\n"
     . "Name=\n"
     . "Email=\n";
}

Как это работает — когда пользователь заходит на форум, то Vanilla незаметно так стучится на нашу страничку с текущей сессией пользователя, и пытается получить о нем информацию. Если это удалось, то движок пытается найти соответсвующую запись у себя в БД — если нашел, то мы авторизированы, если не нашел соответсвия — регистриует нового пользователя с указанными данными и так же авторизирует. Если наша страничка не вернула данных о пользователе, то он либо будет послан на страницу Sign In указанную в настройках ProxyConnect, либо отобразит страницу авторизации форума (зависит, от того, что разрешено пользователю guest).

Из замеченного: для разлогинивания на форуме следует чистить куки:

// vanilla forum logout
setcookie('Vanilla', ' ', time() - 3600, '/', '.domain.com');
unset($_COOKIE['Vanilla']);

Если пользователь авторизирован в вашей системе, а при входе на форум требуется логинится (банально клацнуть на кнопку, для запуска процесса авторизации), то это тоже поправимо — следует в вашем методе логина добавить следующую очистку куков (я их еще и в логаут добавил, так на всяк случай):

setcookie("Vanilla", "deleted", time() - 1,'/', ".domain.com", false);
setcookie("Vanilla-Volatile", "deleted", time() - 1, '/', ".domain.com", false);

Официальная документация по ProxyConnect

Портирование с phpBB, vBulletin и т.д.

На случай если вы решили сменить движок форума, то это тоже предусмотрено ;) Качаем Vanilla Porter и заливаем его в корень вашего текущего форума (phpBB или что там у вас). Далее следуем простой инструкции по переносу данных:

1. Экспорт форума в TXT файл хитрого формата
2. Импорт этого самого файла

Как просто-то :) Ну для наглядности приведу еще скриншот самой тулзы:

Но без нюансов тоже не обошлось — первое с чем столкнулся это непонимание формата файла в архиве, пришлось распаковывать и заливать. Второе — во время импорта все текущие пользователи Vanilla будут удалены, включая вашу учетную запись, так что в определенный момент вам надо будет указать email нового админа из портированных данных, после чего вы получите ошибку авторизации, без паники, логинимся заново под новым админом и продолжаем импорт данных (будет такая кнопочка). Следующий шаг — вам потребуется назначить права для всех ролей пользователей, которые были перенесены со старого движка. И напоследок, когда пользователи со старой системы попробуют зайти на новый форум им высветится следующий диалог (это верно для Vanilla + ProxyConnect):

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

Еще такой момент, умные дядьки часто изменяют алгоритм хэшированя паролей, на этот случай прийдется выполнить следующие действия:

1. Заменить имя метода хэширования на некоторый произвольный
2. Добавить его поддержку в файле vanilla/library/core/class.passwordhash.php

С первым всё совсем просто:

UPDATE GDN_User SET HashMethod = 'myHash' WHERE HashMethod = 'phpBB';

Второй пункт тоже не сложен — нам потребуется найти switch в методе CheckPassword() и добавить туда новый case:

switch(strtolower($Method)) {
/* ... */
    case 'myhash':
        $Result = myMegaHashFunction($Password, $StoredHash);
        break;
/* ... */
}

Документация по Vanilla Porter

Вместо вывода

Форум действительно стоит того, чтобы его установить и опробовать: много локализаций (включая русский и арабский) и полезных плагинов; простые для адаптации темы (хоть и Smarty используется); и таки удобная система интеграции.

Другие посты на эту тему

• No Related Post

Основные подготовительные работы по конференции закончены. Доклады сформированы. Среди спикеров представители KnpLabs, Magento, JetBrains, Sphinx и других известных компаний.

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

Пожалуйста, обратите внимание на то, что изменилось место проведения! Мероприятие будет проходить на прошлогодней площадке — в актовом зале ЛГТЦ (Ленгипротранс-Центр), по адресу: Московский пр., 143, ст. м. «Электросила». Кофе-брейки и обсуждения на флипчартах будут проходить в фойе.

Cписок докладов

• Гибкая архитектура Zend Framework приложений с использованием Dependency Injection — Алексей Качаев (Сogniance, Senior PHP Developer)
• Воюем за ресурсы: Повышение производительности Zend Framework приложения с помощью phpDaemon, Varnish и ESI — Алексей Качаев (Сogniance, Senior PHP Developer)
• Behavior Driven Development в PHP и Zend Framework — Константин Кудряшов (KnpLabs, Senior Web Developer)
• Разделение труда: Организация многозадачной, распределенной системы в Zend Framework с помощью Job Queue — Александр Готгельф (Magento, PHP-разработчик)
• Как может помочь среда разработки при написании приложения на Zend Framework? — Николай Матвеев (JetBrains, разработчик)
• Создание REST-API для сторонних разработчиков и мобильных устройств с авторизацией по протоколу OAuth 1.0 — Дмитрий Чижевский (Дзен-мани, разработчик)
• Толстая модель: История разработки собственного ORM — Михаил Шамин (Геометрия, ведущий разработчик)
• Что такое Sphinx, зачем он вообще нужен и как его использовать с PHP (от простого индекса до поискового кластера) — Владимир Федорков (Sphinx, Director of Professional Services)

Стоимость участия в мероприятии составит 1500 руб. В данную сумму входит: участие в самой конференции, кофе-брейки (от внешней кейтеринг-компании), пакет материалов участника и доступ к профессиональным видеозаписям докладов (после мероприятия). Доступно множество способов оплаты.

Торопитесь, количество мест ограничено!

Обязательно следите за последними новостями:

• RSS-канал: feeds.feedburner.com/zfconf
• Twitter: @zfconf
• Группа ВКонтакте: vkontakte.ru/club14951507

Организатор: компания Wizartech
Партнеры: сообщество zendframework.ru и конференция ZFConf Ukraine

Другие посты на эту тему

• Zend Framework Day
• Мастер-класс Юры Артюха
• Мастер-класс по Sphinx
• ZFConf Ukraine
• Анонс мастер-классов по JavaScript’у
• Facing refucktoring
• Мастер-классы по JavaScript’у
• Под впечатлением от ZFConf

В компанию NIX Solutions требуются PHP разработчики.

Текст вакансии перепечатывать не буду, а скажу, что требуется:

• Опыт работы в коммерческих проектах с каким-нибудь из PHP фреймворков: Zend Framework, Yii, Code Igniter, CakePHP или Symfony
• Опыт работы с JavaScript фреймворком jQuery, или Dojo Toolkit, MooTools, YUI
• Ответить на наши вопросы

Вопросы элементарные, на них ответит каждый, кто в теме:

— Что нового в PHP 5.3?

— Какие паттерны знаете?

— Как сохранить в MySQL дерево категорий произвольной вложенности?

— Напишите функцию для вывода дерева категорий в HTML.

— Что нового в HTML5?

— Написать HTML код для следующих CSS селекторов:

#my .pm.tt strong, li li a:hover+span {
    color:#f00; // какой это цвет?
}

— Что знаете о CSS3?

— Что такое прототип в js?

— Как организовать классическое наследование в js?

— Что такое bubbling?

— Используя native js изменить текст следующего тега на “Hello World!”:

<div class="tutu bubu" >
    Example!
</div>

Используя js фреймворк изменить цвет последнего элемента списка на желтый по завершению загрузки DOM’а:

<ul>
    <li><a href="#" id="my">Tic-tac-toe</a></li>
    <li></li>
    ...
    <li>Yellow string!</li>
</ul>

С нашей стороны — обеспечим интересной работой и белую ЗП по ЧП. И, конечно же, дружный коллектив, фото с бани мне, правда, приложить не разрешили, но так оно и есть…

Другие посты на эту тему

• No Related Post

Не так давно я описывал процесс рефакторинга одного проекта зашедшего в отдел, мы вместе посмеялись да поплакали, но ведать мораль оттуда не вынесли. И в этой истории мы не «белые и пушистые»…

История начиналась банально — проект загибается, заказчик ищет новую команду разработки и находит нас. Мы такие все из себя, на белом коне въезжаем в проект, а там ничего страшного, просто функциональный plain PHP код, т.е. классов нет, функций практически тоже (один файл functions.php, а в нем dbconnect(), userlogin() да функция-шаблонизатор, и что-то еще по мелочи). Смотрим — а проблема то в нагрузке — до 10 000 онлайн пользователей и в это время на сайт и зайти нельзя. Хорошо, задача ясна, садим в проект разработчика, который знаком с оптимизацией, ну и он начал работать. И да, после двух недель работы (а может и больше, уже не помню) сайт ожил, чуть-чуть индексов, чуть-чуть кеширования, еще немного оптимизации SQL запросов и нагрузка на сервера спала.

Заказчик доволен, и уже у него появляются «хотелки» на новый фичи, да немного еще старых багов подкидывает на фикс. В этот момент эффективность нашего разработчика сильно падает — он то любит заниматься оптимизацией, а вот эти CSS да JavaScript ну ой как туго идут…

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

В проекте всё меньше и меньше работы, задачи скатываются до уровня trivial, и мы принимаем решение посадить в него «зелёного» бойца, дабы опробовать его, да и заказчик дал на это добро. Старт был гладким, а потом начались проблемы, то вылезли за сроки, которые сами и оговорили, то на сервер залили не совсем рабочий код. И как итог — «Спасибо, что помогли, вы меня действительно выручили, но дальше я обойдусь без вас»

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

Шаблонизатор

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

Если говорить о функции-шаблонизаторе, то вот элементарный пример:

/**
 * @param string
 * @param array
 */
function template($path, $vars = array()) {
    extract($vars);
    include $path;
}

template("templates/index.phtml", array(
    "foo" => "bar",
    "user" => $user
));

Остальное остается на совести разработчика, собственно даже в тот же Smarty можно впихнуть логику при должном желании.

Сущности

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

Контроллеры

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

Работа с БД

Как я описывал выше, SQL запросы встречались в проекте везде и всюду, и даже процесс экранирования входных данных в них был разный. Привести к единому стилю, создать нормальный врапер для БД, или хотя бы заменить использование расширения mysql на что-либо более современное.

Можно было бы написать простой врапер для врапера PDO за 20 минут, конечно он не будет универсален, но облегчит труд рефакторинга:

• легко логировать используя одну точку входа
• можно быстро добавить кеширование для всех запросов

Кеширование

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

Работа над ошибками

Тут все легко, если вы открываете PHP файл, а вам IDE подсказывает кричит о ошибках в коде, то уделите пять минут времени и исправьте их:

И еще — в обязательном порядке включите отображение ошибок, и запомните — «подавленный» Notice крадет время:

error_reporting(E_ALL);
ini_set('display_errors', '1');

Тестирование

— Unit тестирование? О чем речь, у нас тут запара, надо выкатывать на лив!
Ну-ну…

Клиентская оптимизация

Этого пункта не коснулся ни один из разработчиков, участвовавших в проекте, и это действительно огорчает. Конечно, главная страничка проекта не слишком и тяжела — всего 300кб, но на них приходится 15 JS файлов, 18 картинок в CSS (спрайты спасут сервер), так же стоило потереть старые хуки для браузеров (IE5.5 и IE6), облегчить верстку, ведь 8,7kb это не так уж и мало (слишком много таблиц).

Собственно, сайт по оценке YSlow получает оценку C (70), что я считаю недопустимым, для сравнения мой блог с кучей картинок — A (90). Как улучшить эти показания очень хорошо рассказывает сайт webo.in, и я думаю ему стоит уделить место в закладках.

«Не наш» проект

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

P.S

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

P.P.S

Если вы уже загорелись начать рефакторинг, то я вас еще чуть-чуть еще отвлеку — стоит рефакторинг правильно «продать» заказчику, который любит и умеет считать деньги, с ним стоит разговаривать именно в этом ключе. Удачи вам.

Другие посты на эту тему

• No Related Post

Управление событиями в jQuery

Первая глава посвящена полностью jQuery — основной акцент конечно сделан на события: события мышки и клавиатуры, отправка формы и манипуляции с ее элементами, затронуты методы live и die, но как-то мало о селекторах — лишь ссылка на официальную документацию, я бы привел больше примеров с селекторами форм. В целом, примеры достаточно простые и будут понятны любому новичку.

Связка PHP и jQuery

Данная глава посвящена AJAX’у, тема раскрыта практически полностью, хорошо описана обработка ошибок, за что автор получает плюс в карму ;)

Работа с XML документами и JSON

Каждому формату по главе, и да работа с XML и JSON описано очень хорошо, особенно то что касается PHP части . Порадовало, что автор ссылается на PHP 5.3, за что получает еще один плюс к своей карме.

Работа с формами

Работа с формами — этот момент вызывает ступор у многих web-разработчиков, особенно если требуется динамическая форма, с валидацией, и другими плюшками, а тут всё просто и на примерах — must have (скачайте и посмотрите). За использование filter_var еще один плюс.

Добавление визуальных эффектов для форм

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

Создание прикольных навигационных меню

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

Работа с данными используя PHP и jQuery

Тривиальные задачи (автодополнение, облако тегов) и простые примеры работы с БД (хотя для кого-то они окажутся в новинку), но почему-то без использования PDO.

Улучшаем сайт

Это правильная глава, тут о кросс-доменных запросах пишут и почему-то сюда попала статья о создании jQuery плагинов, но от этого не стало хуже.

Firebug

В конце книги нас решили познакомить с полезным инструментом — Firebug, но как-то скромно.

Оформление книги

Тут чуть-чуть покритикую так как мне не понравилось сразу несколько вещей:

• Неужели сложно для примеров кода сделать адекватное форматирование?
• Подсветка синтаксиса, даже элементарная, очень положительно сказывается на читаемости кода
• Скриншоты с браузера — лучше убрать адресную строку и подобную лабуду, или по крайней мере делать их в одном браузере

Итого

И что мы имеем? Хорошая книга, которая содержит много «правильныx» примеров — простых, доступных, охватывающих большинство задач, которые ставятся web-разработчикам в 90% проектов. Книга рассчитана на начинающих разработчиков, но пригодиться в качестве шпаргалки и для более продвинутой аудитории.

Немного огорчило, что автор забыл про все jQuery плагины, да и про jQuery UI стоило замолвить слово, хотя возможно не тот формат.

Другие посты на эту тему

• jQuery для начинающих. Часть 9. Пишем плагины анимации
• jQuery для начинающих. Часть 8. Расширяем фильтры
• jQuery для начинающих. Часть 7. Пишем плагины
• jQuery для начинающих. Часть 6. События
• (a) Sexy Images jQuery плагин
• jQuery для начинающих. Часть 5. Эффекты
• jQuery iPhone UI
• 10 jQuery Datagrid плагинов

27го ноября в Киеве пройдет бесплатная, международная совместная конференция ZFConf Ukraine & MageConf. Цель конференции – объединить лучших специалистов PHP и Zend Framework Украины, России и других стран СНГ.

ZFConf Ukraine – первая в Украине конференция по Zend Framework, проводится в партнерстве с ZFConf Russia и сообществом zendframework.ru. ZFConf Russia была первой конференцией по Zend Framework и прошла в марте этого года в Санкт-Петербурге, Россия, собрав более 200 участников из России, Беларуси, Украины, Литвы и других стран СНГ

Конференция MageConf впервые прошла в мае 2010 года в Киеве. Это была первая конференция из серии PHP and Zend Framework в Украине. Ее посетили более 150 специалистов.

Конференция пройдет 27 ноября, в Киеве

• Место: КиевЭкспоПлаза, ул. Салютная 2б, 3 павильон
• Время: 27 ноября 2010 г. (с 11:00 до 19:00)
• Длительность: 1 полный день
• Формат: доклады в три потока и обсуждения на флипчарте (в перерывах)
• Язык докладов: русский
• Стоимость участия: бесплатно
• Потоки: Zend Framework, PHP, Magento.
• Аудитория: Разработчики ПО и специалисты по Project Management с Украины, России и близлежащих стран СНГ. Ожидаемое количество участников – 500 человек.

Доклады

1. Встречайте Zend Framework 2.0 — Александр Веремьев / Zend Framework Core команда (Zend Technologies)
2. Эволюция ZF: архитектура, шаблоны, рефакторинг — Виктор Фараздаги / Component Maintainer и Contributor ZF 2.0 (4C)
3. Юнит тестирование в Zend Framework 2.0 — Ростислав Михайлив / Chief Developer / Software Architect (Gadu-Gadu)
4. Хранение, обработка и отдача статики с использованием \Zend \File. Опыт социальной сети starlook.ru — Кирилл Мокевнин / Senior developer (undev)
5. Чуть сложнее чем Singleton: аннотации, IOC, АОП — Кирилл Чебунин / Senior PHP Developer (Альпари)
6. Doctrine 2 — Валерий Рабиевский / Team leader (stfalcon.com)

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

Регистрируясь на одну конференцию, вы автоматически получаете доступ и на другую.

По независящим от меня причинам, организовать ZFConf Kharkov у меня так и не получилось, но могу посоветовать всем моим читателям посетить данную конференцию — будет действительно интересно

Другие посты на эту тему

• Zend Framework Day
• Мастер-класс Юры Артюха
• Мастер-класс по Sphinx
• Конференция ZFConf 2011
• Анонс мастер-классов по JavaScript’у
• Мастер-классы по JavaScript’у
• PDFEED – или RSS2PDF в новом обличье

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

Установку CouchDB описывать не буду, собственно его сборкой я и не занимался. Перейдем сразу к Futon’у

Futon

После сборки и запуска CouchDB по адресу http://localhost:5984/_utils/ вам будет доступен web-интерфейс для управления БД — это и есть Futon. При помощи данного инструмента мы и будет проводить все описанные далее манипуляции.

Создание базы данных

Тут вроде все просто, кликаем Create Database:

Наблюдал странный баг, когда попытался создать БД “example” и “example/users”, Futon ругался, я не понял… Возможно он плохо дружит с БД в названии которых присутствует слэш.

Создание документов

Теперь пора создавать документы по которым будем осуществлять дальнейший поиск. Возьмем тривиальную задачу — будем «забивать» библиотеку:

Id документа должен быть строкой, по этой причине Id=1 заключен в кавычки, конечно можно использовать и автоматически генерируемое значение, и это даже правильно (иначе вам придется следить за ними на уровне приложения), но уж больно они громоздкие, по этой причине я буду сочинять свои.

Немного погодя понимаешь, что необходимо сохранять не просто текстовое поле, а набор данных, нам понадобится массив или даже объект (после и перед скобочками необходимо ставить пробел или перенос каретки):

Теперь можем чуть-чуть потренироваться опрашивая сервер:

Информация о БД — http://localhost:5984/simple/:

{
"db_name":"simple",
"doc_count":4,
"doc_del_count":1,
"update_seq":9,
"purge_seq":0,
"compact_running":false,
"disk_size":36953,
"instance_start_time":"1284023758033358",
"disk_format_version":5,
"committed_update_seq":9
}

Вывод записи по Id — http://localhost:5984/simple/1/:

{
"_id":"1",
"_rev":"3-eef52c024c2b27dadda90e0a510015b8",
"title":"Улитка на склоне",
"ISBN":["978-5-17-057930-3","978-5-403-00677-4"]
}

Вывод всех записей — http://localhost:5984/simple/_all_docs:

{"total_rows":4,"offset":0,"rows":[
{"id":"1","key":"1","value":{"rev":"3-eef52c024c2b27dadda90e0a510015b8"}},
{"id":"2","key":"2","value":{"rev":"2-ccf196a429e2f118a7b558eb049e5773"}},
{"id":"3","key":"3","value":{"rev":"1-d49358e63c151f2f3ea7066146f24a66"}},
{"id":"44","key":"44","value":{"rev":"1-c0d28980139f7f4c372ca86306147b55"}}
]}

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

REST API

Но не Fucon’ом единым, CouchDB предоставляет REST интерфейс для работы с базой (собственно, Fucon через него и работает, можете посмотреть в консоли FireBug’a — очень наглядно), а это значит приблизительно следующее:

• Если мы хотим получить информацию — отправляем GET запрос (как в примерах выше)
• Если надо создать документ — POST
• Необходимо что-то изменить — PUT
• COPY для копирования
• DELETE для удаления

Что-бы не быть голословным приведу пример создания и изменения документа:

# создаем документ, UUID генерируется автоматически
curl -X POST http://localhost:5984/simple -d '{"title":"Hello World!!!"}' -H "Content-Type:application/json"
>> {"ok":true,"id":"dbc21298bfb3f78ebe815cdb7000ae98","rev":"1-f33e3c9b23e594593e93181763f0fb1b"}

# создаем документ, UUID задаем явно
curl -X PUT http://localhost:5984/simple/hello -d '{"title":"Hello World!"}' -H "Content-Type:application/json"
>> {"ok":true,"id":"hello","rev":"1-f33e3c9b23e594593e93181763f0fb1b"}

# получение документа
curl -X GET http://localhost:5984/simple/hello
>> {"_id":"hello","_rev":"1-f33e3c9b23e594593e93181763f0fb1b","title":"Hello World!!!"}

# редактирование документа, необходимо указывать ревизию редактируемого документа
curl -X PUT http://localhost:5984/simple/hello -d '{"_rev":"1-f33e3c9b23e594593e93181763f0fb1b","body":"My world"}' -H "Content-Type:application/json"
>> {"ok":true,"id":"hello","rev":"2-493961fb199ea564f532de44d8be2650"}

# копирование документа
curl -X COPY http://localhost:5984/simple/hello -H "Destination:hello2"
>> {"id":"hello2","rev":"1-1053fa7d0d20242aeeb1ba24ffd94977"}

# получения всех документов
curl -X GET http://localhost:5984/simple/_all_docs
{"total_rows":2,"offset":0,"rows":[
  {"id":"hello","key":"hello","value":{"rev":"2-493961fb199ea564f532de44d8be2650"}},
  {"id":"hello2","key":"hello2","value":{"rev":"1-1053fa7d0d20242aeeb1ba24ffd94977"}}
]}

# удаление документа
curl -X DELETE http://localhost:5984/simple/hello2?rev=1-1053fa7d0d20242aeeb1ba24ffd94977
>> {"ok":true,"id":"hello2","rev":"2-72d1c6aa20574c9444eae3d90715a862"}

# получение UUID
curl -X GET http://localhost:5984/_uuids?count=1
>> {"uuids":["dbc21298bfb3f78ebe815cdb70014788"]}

View

Но вернемся к Fucon’у — настал черед создать view, идем в пункт “Temporary View…”:

Затем создаем map функцию:

function(doc) {
  emit(doc.title, doc.genre);
}

Функция emit принимает в качестве параметров ключ и значение, данный параметры могут быть простыми, как в примере выше, или составными — массив или объект. Историю почему функция носит такое имя я рассказать не могу, зваться бы ей push

Cохраняем view как документ _design/books с именем genre — таки view это обычный документ в нашей БД, можем его даже пощупать:

{
   "_id": "_design/books",
   "_rev": "1-532d13f2b2ef9dea495df8230f31b0bf",
   "language": "javascript",
   "views": {
       "genre": {
           "map": "function(doc) {\n  emit(doc.title, doc.genre);\n}"
       }
   }
}

Результатом нашей работы будет следующий набор данных:

// URL: http://localhost:5984/simple/_design/books/_view/genre
// UTF я привел к русскому

{"total_rows":5,"offset":0,"rows":[
  {"id":"44","key":"Будущее, ХХ век. Исследователи","value":"fantastic"},
  {"id":"55","key":"Винни-Пух","value":"child"},
  {"id":"2","key":"Пикник на обочине","value":"fantastic"},
  {"id":"3","key":"Трудно быть богом","value":"fantastic"},
  {"id":"1","key":"Улитка на склоне","value":"fantastic"}
]}

Тем кто с SQL знаком

ORDER BY

CouchDB сортирует выборку по ключу передаваемому в функцию emit первым параметром. Следовательно, если нам надо отсортировать по названию книги, то map функцию придется изменить:

function(doc) {
  emit(doc.title, {title:doc.title, isbn:doc.ISBN});
}

Так же можно задать составной ключ:

function(doc) {
  emit([doc.genre, doc.title], {title:doc.title, isbn:doc.ISBN});
}

Для обратного порядка есть параметр ?descending=true

WHERE

Большинство логики ложится непосредственно на функцию map — именно она в ответе за условия поиска:

function(doc) {
    if (doc.authors.length > 1)
        emit(doc._id, {title:doc.title, isbn:doc.ISBN});
}

Но так же есть возможность простой фильтрации по ключу:

function(doc) {
    // ключом будет цена книги
    emit(doc.price, {title:doc.title, isbn:doc.ISBN});
}

Получить книги с определенной ценой: ?key=235
Получить все книги из диапазона цен: ?startkey=200&endkey=300

Если у нас составной ключ, то startkey и endkey должны быть составными: ?startkey=[100]&endkey=[300] (фильтр накладывается лишь на первый элемент составного ключа)

Если мы имеем дело с текстовым ключом, то можно получить конструкцию аналогичную LIKE “Ul%” используя следующий запрос: ?startkey=”ul”&endkey=”UL\ufff0″.

Порядок сортировки ключей следующий:

  ` ^ _ - , ; : ! ? . ' " ( ) [ ] { } @ * / \ & # % + < = > | ~ $ 0 1 2 3 4 5 6 7 8 9
a A b B c C d D e E f F g G h H i I j J k K l L m M n N o O p P q Q r R s S t T u U v V w W x X y Y z Z

Больше информации о сортировке найдете в wiki: View сollation

LIMIT и OFFSET

Существуют следующие параметры ?limit=5&skip=10, вроде то что нужно, но, не ведитесь на эту провокацию, CouchDb все равно будет считывать пропущенные документы, но лишь отображать их не будет. Правильным является использование параметра startkey + limit. Алгоритм следующий:

• Выбираем необходимое количество элементов rows_per_page + еще один
• Отображаем rows_per_page элементов пользователю
• Запасной элемент (его ключ) используем для получения next_startkey (т.е. ссылки на следующую страницу)
• Ключ первого элемента используем для получения ссылки на предыдущую страницу

SUM, COUNT

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

// map
function(doc) {
  // ключом будет жанр книги
  emit(doc._id, doc.title);
}
// reduce
function(keys,values) {
    return values.length;
}
// результат
{"rows":[
  {"key":null,"value":4}
]}
// можно еще упростить данный пример

Или лучше среднюю стоимость книг:

// map
function(doc) {
  emit(doc._id, doc.price);
}
// reduce
function(keys,values) {
    return Math.floor(sum(values)/values.length);
}
// результат
{"rows":[
{"key":null,"value":233}
]}

Если надобности в reduce нет, то можно отключить, используя параметр ?reduce=false

У функции reduce есть еще третий параметр — rereduce. Насколько я понял, в том случае, когда у нас очень большая база, документы в reduce функцию будут поступать пачками, и пока rereduce=false у нас все хорошо, и функция работает как обычно, но когда rereduce=true то к нам на вход попадут в качестве values промежуточные данные вычислений.

GROUP BY

Для организации группировки нам понадобится reduce функция и параметр ?group=true. Приведу пример вычисления средней стоимости книг, с группировкой по жанру:

// map
function(doc) {
  // ключом будет жанр книги
  emit(doc.genre, doc.price);
}

// reduce
function(keys,values) {
    return Math.floor(sum(values)/values.length);
}

// результат
{"rows":[
{"key":"child","value":145},
{"key":"fantastic","value":263}
]}

Так же возможна группировка по составному ключу, тут пригодится параметр ?group_level=1, с его помощью можно указывать уровень группировки, приведу пример из руководства:

// у нас есть следующие ключи
["a",1,1]
["a",3,4]
["a",3,8]
["b",2,6]
["b",2,6]
["c",1,5]
["c",4,2]

При ?group_level=1 функция reduce будет запущена 3 раза, по разу для каждого из следующих сетов:

// set "a"
["a",1,1]
["a",3,4]
["a",3,8]
// set "b"
["b",2,6]
["b",2,6]
// set "c"
["c",1,5]
["c",4,2]

При ?group_level=2 функция reduce будет запущена 5 раз, по разу для каждого из следующих сетов:

// set "a", 1
["a",1,1]
// set "a", 3
["a",3,4]
["a",3,8]
// set "b", 2
["b",2,6]
["b",2,6]
// set "c",1
["c",1,5]
// set "c",4
["c",4,2]

Возвращаясь к нашим книгам, то можно сделать следующий финт ушами (?group_level=2):

// map
function(doc) {
  // первый параметр ключа - жанр, второй - цена в сотнях
  emit([doc.genre, Math.floor(doc.price/100)], doc.price);
}
// reduce
function(keys,values) {
    return Math.floor(sum(values)/values.length);
}
// результат
{"rows":[
{"key":["child",1],"value":145},
{"key":["fantastic",2],"value":244},
{"key":["fantastic",3],"value":302}
]}

Связанные документы

Теперь надо бы добавить авторов книг, но как-то не очень хочется добавлять к каждому документу объект со всеми свойствами, так и хочется создать новую таблицу «пользователи», но у нас не та БД. По этой причине создаем новые документы с атрибутом type=author:

{
   "_id": "author_1",
   "name": "Alan Alexander Milne",
   "type": "author"
}

В книгах добавляем type=book и ссылку на автора:

{
   /*...*/
   "authors": [
       "author_1"
   ],
   "type": "book"
}

Теперь надо создать view, чтобы возвращались лишь книги:

function(doc) {
    if (doc.type != "book") return;
    emit(doc._id, {title:doc.title, isbn:doc.ISBN});
}

Чтобы получить связанные документы (авторов из нашего примера) в функцию emit необходимо передать в качестве параметра объект следующего вида:

{
    _id:"author_2"
}

А map функция приобретет следующий вид:

function(doc) {
  if (doc.type != "book") return;

  emit([doc._id, 'book', 0], {title:doc.title, isbn:doc.ISBN});
  if (doc.authors) {
    for (var i in doc.authors) {
      emit([doc._id, 'author', Number(i)+1], {_id:doc.authors[i]})
    }
  }
}

Но и этого мало, запрос при этом должен иметь вид http://localhost:5984/simple/_design/books/_view/all?include_docs=true:

{"total_rows":14,"offset":0,"rows":[
    {
        "id":"1",
        "key":["1","author",1],
        "value":{"_id":"author_2"},
        "doc":{"_id":"author_2","_rev":"1-d39dd295bf1b91f27e329362a727eaf8","name":"Arcadiy Strugackiy","type":"author"}
    },
    {
        "id":"1",
        "key":["1","author",2],
        "value":{"_id":"author_3"},
        "doc":{"_id":"author_3","_rev":"1-eeaadba334acb0afdd5d4d7a6eb3a11b","name":"Boris Strugackiy","type":"author"}
    },
    {
        "id":"1",
        "key":["1","doc",0],
        "value":{"title":"Улитка на склоне","isbn":["978-5-17-057930-3","978-5-403-00677-4"]},
        "doc":{
            "_id":"1",
            "_rev":"8-1777bfc0f098b2382543ec5e48bc3b44",
            "title":"Улитка на склоне","ISBN":["978-5-17-057930-3","978-5-403-00677-4"],
            "genre":"fantastic","price":235,"type":"book",
            "authors":["author_2","author_3"]
        }
    },
    /* ... skip ... */
    {
        "id":"55",
        "key":["55","author",1],
        "value":{"_id":"author_1"},
        "doc":{"_id":"author_1","_rev":"3-b3bce00a63620dbf4dd14b1337802e78","name":"Alan Alexander Milne","type":"author"}
    },
    {
        "id":"55",
        "key":["55","doc",0],
        "value":{"title":"Винни-Пух","isbn":["978-5-17-066600-3","978-5-271-27610-1","978-985-16-8371-6"]},
        "doc":{
            "_id":"55",
            "_rev":"4-ea5acfb3800e0414bf20fb2a5150a586",
            "title":"Винни-Пух","ISBN":["978-5-17-066600-3","978-5-271-27610-1","978-985-16-8371-6"],
            "genre":"child","authors":["author_1"],"type":"book"
        }
    }
]}

Теперь остается собрать этот view в человеческий вид, и так хочется использовать reduce функцию, но вот беда, с параметром ?include_docs=true это невозможно.

Я не думаю, что это правильно и соответствует идеологии CouchDB, скорей всего стоит забыть о JOIN-подобных конструкциях

Немного о правах доступа

Если вы уже успели немного изучить интерфейс Fucon’а, то уже обратили внимание на кнопочку “Security”, нажимаем — в появившемся окошке можно установить имена/роли админов и пользователей (первые могут редактировать документы, вторые — не должен):

Если список reader’ов пуст, то БД считается публичной, и для чтения данных пароль не потребуется, иначе потребуется авторизация:

# получение документа + авторизация
curl -X GET http://username:password@localhost:5984/simple/hello
>> {"_id":"hello","_rev":"1-f33e3c9b23e594593e93181763f0fb1b","title":"Hello World!!!"}

Собственно, мы редактируем документ db_name/_security, единственное отличие, он не имеет ревизии, дабы увеличить скорость работы авторизации

Поддерживаются следующие обработчики для авторизации:

• OAuth
• cookie
• default (используется для HTTP авторизации, описанной в RFC 2617)

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

Теперь можно попробовать создать несколько пользователей с разными ролями, Logout » Signup:

Результатом станет появление документа в БД _users:

{
   "_id": "org.couchdb.user:guest",
   "_rev": "1-9eeb0dcc95d472849590885bcc5f242c",
   "name": "guest",
   "salt": "dbc21298bfb3f78ebe815cdb7000e180",
   "password_sha": "3d447e52765d76064223f501f16a9213d43a5ee5",
   "type": "user",
   "roles": []
}

Побуем:

curl -X GET http://guest:123456@localhost:5984/simple/_all_docs
>> {"error":"unauthorized","reason":"You are not authorized to access this db."}

Добавим ему роль reader и пробуем:

 curl -X GET http://guest:123456@localhost:5984/simple/_all_docs
>> {"total_rows":1,"offset":0,"rows":[{"id":"hello","key":"hello","value":{"rev":"4-2edebeac5a6e202b7d468c2d2fcd434c"}}]}

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

curl -X POST http://guest:123456@localhost:5984/simple -d '{"title":"Hello World!!!"}' -H "Content-Type:application/json"
>> {"ok":true,"id":"dbc21298bfb3f78ebe815cdb7000eb31","rev":"1-f33e3c9b23e594593e93181763f0fb1b"}

Результат немного неожиданный, документ создали, хоть guest=reader. В действительности для разграничений прав доступа необходимо создать функцию валидации данных, и в ней организовывать логику разделения прав. Для этой цели создайте любой design документ с атрибутом validate_doc_update, в котором и будет описана наша функция:

{
   "_id": "_design/validate",
   "_rev": "4-e53c54b69a5916ddc06a4fd16f4b299d",
   "validate_doc_update": "function(new_doc, old_doc, userCtx) { /* code here */  }"
}

К примеру, функция которая разрешает доступ лишь для редакторов будет иметь следующий вид:

function(new_doc, old_doc, userCtx) {
    if(userCtx.roles.indexOf("editor") === -1) {
      throw({unauthorized: "You are not an editor."});
    }
}

Валидация

Прочитав предыдущий параграф возникает резонная мысль — значит CouchDB позволяет проверять данные перед занесением их в БД. О, да, и вот тому наглядный такой пример:

function(newDoc, oldDoc, userCtx) {
  function require(field, message) {
    message = message || "Document must have a " + field;
    if (!newDoc[field]) throw({forbidden : message});
  };

  if (newDoc.type == "post") {
    require("title");
    require("created_at");
    require("body");
    require("author");
  }
  if (newDoc.type == "comment") {
    require("name");
    require("created_at");
    require("comment", "You may not leave an empty comment");
  }
}

Хранение файлов

Отдельно стоит отметить, что файлы стоит хранить в самой CouchDB, так как хранятся они как есть на файловой системе, без всяких извращений, как то свойственно SQL. Из Fucon’а вы сможете легко добавить несколько аттачей к документу:

{
   "_id": "1",
   "_rev": "10-6754a5ad1330a6b8ebb544d052f2b03c",
   "title": "Ulitka na sklone",
   "_attachments": {
       "ulitka.jpeg": { // данный файл будет доступен по адресу http://localhost:5984/simple/1/ulitka.jpeg
           "content_type": "image/jpeg",
           "revpos": 10,
           "length": 25227,
           "stub": true
       }
   }
}

Документация

• Introduction to CouchDB views
• HTTP Document API
• HTTP view API
• View Snippets (полезные примеры)
• Interactive CouchDB (можно попробовать в живую)
• Recipes
• Security
• Validation
• Database Queries the CouchDB Way

Обзор CouchDB 1.0 и сравнение с версией 0.11, полезно почитать:

• Nice URLs with Rewrite Rules and Virtual Hosts
• Views; JOINs Redux, Raw Collation for Speed
• New Features in Replication
• Users, Authentication, Authorisation and Permissions

P.S. Есть чем дополнить/исправить — пишите комментарии.

Другие посты на эту тему

• No Related Post

История одного рефакторинга, или о сказ о том как не надо разрабатывать на PHP…

Началось все как всегда, откуда-то появляется заказчик весь в слезах и трансе, орет не своим голосом: «Спасите, помогите, мой проект тормозит, от меня пользователи бегут. У вас неделя…»

Развернули проект на нашем сервере — н-да уж… Дальше был анализ сего творения фирмы «Q» (кто следит за мной, знает о какой украинской фирме речь), смех сквозь слезы, и истерика в течении недели. Ну для начала был взят XDEBUG и посмотрели профайлером что там и как (кликабельно):

Такую клевую штуку рисует Webgrind, удобно и наглядно

Т.е. у нас страница, которая выводит приветствие + выбор языка + выбор категории для просмотра (захардкоденных кстати) генерировалась за 4,6 секунды на сервере с Core2 Quad CPU Q6600@2.40GHz/16Gb (истерика и лучи ненависти конторе «Q»).

Куда более жутка картина ожидала нас на главной странице:

До применения Zend Framework’a нас отделяло еще несколько недель оптимизации г..кода…

FastTemplate такой «Fast»

Если присмотреться, то на предыдущем скрине видно, что очень дорого нам обходится некая функция parse_body:

Внутри нас ждет:

• вызов strtoupper — 56560 раз
• вызов str_replace — 56560 раз

Смотрим на код:

// $content - шаблон
// $rec - переменные
$content = preg_replace("/\\$([A-Z][A-Z0-9_]+)/", "@\\1@", $content);
if (is_array($rec)) {
    foreach ($rec as $key => $value) {
        $name = strtoupper($key);
        $content = str_replace("@$name@", "$value", "$content");
    }
}
return $content;

Т.е. в самом начале мы ищем в шаблонах что-то вроде $HTTP_PATH, заменяем это на @HTTP_PATH@, потом перебором пытаемся заменить все известные переменные. Есть одна проблема — шаблонов у нас много, в них используется совсем чуть-чуть из пары сотен переменных. Простая замена str_replace на preg_replace_callback дала прирост в пару секунд (т.е. около 10%).

Примеры кода

Слабонервным лучше пропустить данный абзац.

Классика плохого PHP кода, встречается у индусов и наших студентов:

function n() {
   global $db, $CONSTANTS, $user, ...; // много одним словом

   echo $CONSTANTS[HOMEPAGE_BANNER1_ID];  // думаете это константа?
   echo $CONSTANTS[HOMEPAGE_BANNER2_ID];  // а знаете, что внутри?
   echo $CONSTANTS[HOMEPAGE_BANNER3_ID];  // 1, 2, 3, которые меняются совсем не там где объявляются О_о
}

Использование файловой системы вместо системы контроля версий:

tpl
|-- index.tpl
|-- index2.tpl
|-- index3.tpl
|-- index__.tpl
`-- index.44.tpl

С базой данных тот же номер — таблицы categories_old, items_1 и т.д.

Если мальчик любит труд
тычет в книжку пальчик,
про такого пишут тут:
он хороший мальчик.

Это, как вы понимаете, не про наших «мальчиков», у наших 9 000 notices на главной. Да и manual’ами пользуются только слабаки:

// мы не читаем мануалов
while ($row = mysql_fetch_array($res)) {
      if ($row) {
            foreach ($row AS $key => $field) {
                if (ereg("^[0-9]+", $key)) {
                    unset($row[$key]);
                }
            }
      }
      $rows[] = $row;
}
// если чуть-чуть допилить
// мелочь, конечно, но прирост ~0,1 сек т.к. имеет место 23162 вызовов
while ($row = mysql_fetch_array($res, MYSQL_ASSOC)) {
      $rows[] = $row;
}

Далее просто гениальное решение, тайный смысл этого творения я не осилил:

$sqls[] = $sql;
if (is_array($sqls)) {
    foreach ($sqls AS $ssql) {
        if ($ssql) {
            $res = mysql_db_query($db['name'], $ssql, $db['id']);
            if (!$res) {
                return 0;
            }
        }
    }
} else {
    return 0;
}

Подсчет результатов поиска, что может быть проще:

// перед выполнением запроса можно подсчитать кол-во результатов
// воспользовавшись функцией db_count (вызывается в 96 разных местах)
function db_count($sql) {
    global $db;
    $res = mysql_db_query($db['name'], $sql, $db['id']);
    $result = mysql_num_rows($res);
    return $result;
}

Постраничная навигация, и это тоже можем:

// пошел запрос к БД
$res = mysql_db_query($db['name'], $sql, $db['id']);
// подсчитали итого (хотя до этого уже был вызван db_count)
$row_count = mysql_num_rows($res);
// подсчитали сколько у нас страниц получается
$page_count = floor($row_count / $pager['per_page'] + 1);

// это offset
$bi = ($pos - 1) * $pager['per_page'];

// теперь выбираем только нужные записи
for ($i = $bi; $i < $bi + $pager["per_page"]; $i++) {
    if ($i >= $row_count) {
        break;
    }

    if (!mysql_data_seek($res, $i)) {
        break;
    }

    if (!($row = mysql_fetch_assoc($res))) {
        break;
    }
    // складируем результат
    $new_rows[] = $row;
}

Повторение строк — мы не ищем легких путей (str_repeat):

// в файле categories.sql.php
// функция которая строит select для HTML
$offset_string  = '';
for ($i = 1; $i < $rec['level']; $i++) {
    $offset_string .= '&nbsp;&nbsp;&nbsp;&nbsp;';
}

Если нам надо обрезать строку на 100 символов, и при этом не кромсать слова то вот оно решение:

$data['row']['description'] = substr($description, 0, 100);

$i = 100;
while (!($description[$i] == " " || $description[$i] == "_") && $i < strlen($description)):
    $data['row']['description'] .= $description[$i];
    $i++;
endwhile;

if ($i < strlen($description)) {
    $data['row']['description'] .= "...";
}

У нас так много глобальных переменных, там есть конечно $db, и она же передается во все функции которые работают с БД:

function db_query($db, $sql) {}
function db_sql_query($db, $sql) {}
function db_count($db, $sql) {}
// и т.д.
// но почему не так, ведь у нас одна БД
function db_query($sql) {
    global $db;
}

Пусть на море качка, но мы всегда прибережем обходные пути:

$sql = "SELECT id, name, pasw from users where name = '$_POST[username]'";

Про агрегирование в SQL мы не знаем:

// $rows - записи из БД
foreach ($rows as $value) {
      $total += $value["price"];
}

Необходимо SEO URL? Не проблема:

switch ($params[1]):
       case "usageagreement":
            $page_id = 13;
       break;
       case "privacypolicy":
            $page_id = 14;
       break;
       case "termsandconditions":
            $page_id = 15;
       break;
       case "affiliates":
            $page_id = 22;
       break;
       case "aboutus":
            $page_id = 19;
       break;
endswitch;

Ладно с PHP, но HTML то можно было подучить:

<!-- id такой id -->
<div id="banner">...</div>
<div id="banner">...</div>
<div id="banner">...</div>
<div id="banner">...</div>

<!-- class это почти style -->
<li class="padding-left:15px;">...</li>

<!-- табличная верстка -->
<!-- хотя не стоит 10 вложенных таблиц расписывать -->

<!-- margin, что такое margin? -->
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;

Применение Zend_Cache

Кеш спасет мир, подумали мы и прикрутили его для всех SQL запросов (благо кто-то догадался написать единую функцию db_sql_query) и всех вызовов parse_body. Для начала попробовали кешировать в файлы, на тестовом сервере это помогло, на живом — нет. Причина — у нас так много мелких шаблонов (~200 для главной), что операции с файловой системой свели на нет прирост кеширования.

Вторая попытка оказалась более удачной, решили применить memcache — прирост скорости ~180%. Какой клевый показатель, но верен лишь в 100% попадании в кеш, таким образом перед нами вырисовывалась перспектива полного рефакторинга системы.

Немного клиентской оптимизации

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

FileETag MTime Size

AddOutputFilterByType DEFLATE text/html text/plain text/xml text/css text/javascript application/x-javascript

<ifModule mod_expires.c>
  ExpiresActive On
  ExpiresDefault "access plus 1 seconds"
  ExpiresByType text/html "access plus 1 seconds"
  ExpiresByType image/x-icon "access plus 2592000 seconds"
  ExpiresByType image/gif "access plus 2592000 seconds"
  ExpiresByType image/jpeg "access plus 2592000 seconds"
  ExpiresByType image/png "access plus 2592000 seconds"
  ExpiresByType text/css "access plus 604800 seconds"
  ExpiresByType text/javascript "access plus 216000 seconds"
  ExpiresByType application/x-javascript "access plus 216000 seconds"
</ifModule>

А далее все по порядку:

• Оптимизация изображений для web (есть такой пункт в Photoshop) — 40% на всех JPEG фалах
• Спрайты — кропотливая работа, десятки обращений к серверу можно свести к единицам
• Жмем JavaScript и CSS — ~50%
• И последним пунктом — nginx для всего этого добра

Zend Framework

А теперь расскажу о том, как проект медленно переезжает на Zend Framework. Начинается всё с простой проверки в index.php (о да в нашей системе одна точка входа):

// список модулей, которые уже отрефакторили
$modules = array (
    '/search/',
    '/about/'
);

$path = $_SERVER['REQUEST_URI'];

// нас устроила такая простая проверка,
// но запрос вида /search/?... уже не будет обрабатываться
if(in_array($path, $modules)) {
    // подключаем ZF (внутри стандартный код из сгенерированного public/index.php)
    require 'loader.php';
    exit();
}

// а эта будет
foreach ($modules as $module) {
    if (strpos($path, $module) === 0) {
        require 'loader.php';
        exit();
    }
}

Если у нас не одна точка входа, то в каждом файле, которые были затронуты делаем простую вставку:

$_SERVER['REQUEST_URI'] = str_replace($_SERVER['PHP_SELF'], '/admin/', $_SERVER['REQUEST_URI']);
require 'loader.php';
exit();

Что-бы забыть «глобальный» ужас, жизненно-необходимые переменный были закинуты в Zend_Registry (а в дальнейшем закинуты в конфигурационный файл application.ini, где им самое место).

Так же Zend_Translate была скормлена таблица с переводами (см. адаптер array)

Результат

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

Еще наглядный скриншот среднего/максимального времени генерации страниц по датам: http://screencast.com/t/NDY1NGE5

Другие посты на эту тему

• Конференция ZFConf 2011
• Под впечатлением от ZFConf
• Пишем свой провайдер для Zend_Tool
• ZFCore – CMF на Zend Frameworkе
• Первая в России конференция по Zend Framework
• Пишем свой PHP Framework
• Юнит тестирование приложений на Zend Framework’е
• Zend Framework hacks