Работая над одним крупным проектом (который очень скоро Вы увидите в портфолио), передо мной была поставлена задача «подкрутить» к проекту автономную статистику Piwik. Т.е. Нужно было на персональных страницах пользователей, зарегистрированных в системе, поставить полноценный движок статистики, который предоставлял бы им исчерпывающую информацию о посещениях этих страниц. Мой коллега, перебрав кучу подобных движков остановился на Piwik и я его полностью поддержал: выбор был действительно хорош и очень грамотно написан, еще и Open Source!

Основными прелестями системы является (с точки зрения программиста):

• Высокая производительность;
• Развитая модульная система;
• Симпатичный, ненавязчивый интерфейс;
• Rest-сервисы;

Много рассказывать не буду: лучше один раз увидеть…

Установка данной системы на сайт очень проста:

1. Скопируйте Piwik в Ваш проект, напр., public_html/stats
2. Удалите файл config.ini с папки config
3. Пройдите по адресу yoursite/stats
4. Запустится автоматический установщик — вбейте все нужные параматры
5. Все, система установлена

 

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

---

Итак, что требовалось написать? При создании аккаунта пользователя нужно было автоматически завести аккаунт в Piwik + добавить "сайт" для подсчета статистики и назначить права доступа созданного пользователя для созданного сайта. Кроме того, в аккаунте нужно было показать краткий отчет за текщий день и за последний месяц.

 

Решение

---

Решение пришло не сразу, но покопавшись в исходниках системы и немного погуглив, решение нашлось. Бросалась в глаза поддержка Rest технологии, которая давала возможности для доступа к API отдельных модулей и получать от них внятные ответы.

После проб и ошибок, решил ситуацию написанием собственной модели  для управления Piwik с помощью Rest технологии.

Вот исходный код модели, думаю многим, кто заинтересовался, готовый код придется по-вкусу.<?php /** * @see Zend_Rest_Client */ require_once 'Zend/Rest/Client.php'; /** * Класс для управления статистикой Piwik * * @uses Zend_Rest_Client * @version 0.0.0.6 * @author Васильев Андрей Николаевич (illusive [at] meta [dot] ua) * @link http://web-blog.org.ua/ */ class StatService { /** * Адрес по которому работает Piwik * * @var string */ protected $piwik_url; /** * Логин суперпользователя статистики * * @var string */ protected $superLogin = '******'; /** * Пароль суперпользователя статистики * * @var string */ protected $superPassword = '*************'; /** * Конструктор класса * * @param string $url */ public function __construct($url) { $this->piwik_url = $url; } /** * Добавляет сайт * * @param string $siteName * @param array|string $urls * @return id - если успешно, в противном случае - false */ public function addSite($siteName, $urls) { $client = new Zend_Rest_Client($this->piwik_url); $client->module('API'); $client->method('SitesManager.addSite'); $client->format('xml'); $client->token_auth(md5($this->superLogin.md5($this->superPassword))); $client->siteName($siteName); $client->urls($urls); try { return $client->get()->row; } catch (Exception $e) { return false; } } /** * Делает изменения в уже созданном сайте * * @param int $idSite * @param string $siteName * @param array|string $urls * @return Zend_Rest_Client_Result - если успешно, в противном случае - false */ public function updateSite($idSite, $siteName, $urls = null) { $client = new Zend_Rest_Client($this->piwik_url); $client->module('API'); $client->method('SitesManager.updateSite'); $client->format('xml'); $client->token_auth(md5($this->superLogin.md5($this->superPassword))); $client->siteName($siteName); $client->idSite($idSite); $client->urls($urls); try { return $client->get(); } catch (Exception $e) { return false; } } /** * Удаляет сайт из статистики * * @param int $idSite * @return Zend_Rest_Client_Result - если успешно, в противном случае - false */ public function deleteSite($idSite) { $client = new Zend_Rest_Client($this->piwik_url); $client->module('API'); $client->method('SitesManager.deleteSite'); $client->format('xml'); $client->token_auth(md5($this->superLogin.md5($this->superPassword))); $client->idSite($idSite); try { return $client->get(); } catch (Exception $e) { return false; } } /** * Создает нового пользователя. По параметру $alias (полный адрес к сайту) * определяется сайт, за который ответственный пользователь * * @param string $userLogin * @param string $password * @param string $email * @param string $alias * @return Zend_Rest_Client_Result - если успешно, в противном случае - false */ public function addUser($userLogin,$password,$email,$alias) { $client = new Zend_Rest_Client($this->piwik_url); $client->module('API'); $client->method('UsersManager.addUser'); $client->format('xml'); $client->token_auth(md5($this->superLogin.md5($this->superPassword))); $client->userLogin($userLogin); $client->password($password); $client->email($email); $client->alias($alias); try { return $client->get(); } catch (Exception $e) { return false; } } /** * Меняет параметры и настройки аккаунта пользователя * * @param string $userLogin * @param string $password * @param string $email * @param string $alias * @return Zend_Rest_Client_Result - если успешно, в противном случае - false */ public function updateUser($userLogin, $password = false, $email = false, $alias = false) { $client = new Zend_Rest_Client($this->piwik_url); $client->module('API'); $client->method('UsersManager.updateUser'); $client->format('xml'); $client->token_auth(md5($this->superLogin.md5($this->superPassword))); $client->userLogin($userLogin); $client->password($password); $client->email($email); $client->alias($alias); try { return $client->get(); } catch (Exception $e) { return false; } } /** * Задает права конкретного пользователя для конкретного сайта * * @param string $userLogin * @param string $access * @param string|array $idSites * @return Zend_Rest_Client_Result - если успешно, в противном случае - false */ public function setUserAccess($userLogin, $access, $idSites) { $client = new Zend_Rest_Client($this->piwik_url); $client->module('API'); $client->method('UsersManager.setUserAccess'); $client->format('xml'); $client->token_auth(md5($this->superLogin.md5($this->superPassword))); $client->userLogin($userLogin); $client->access($access); $client->idSites($idSites); try { return $client->get(); } catch (Exception $e) { return false; } } /** * Удаляет пользователя * * @param string $userLogin * @return Zend_Rest_Client_Result - если успешно, в противном случае - false */ public function deleteUser($userLogin) { $client = new Zend_Rest_Client($this->piwik_url); $client->module('API'); $client->method('UsersManager.deleteUser'); $client->format('xml'); $client->token_auth(md5($this->superLogin.md5($this->superPassword))); $client->userLogin($userLogin); try { return $client->get(); } catch (Exception $e) { return false; } } /** * Отдает отчет * * @param int $idSite * @param string $login * @param string $password * @param string $period * @return Zend_Rest_Client_Result - если успешно, в противном случае - false */ public function getSummary($idSite,$login,$password,$period = 'month') { $client = new Zend_Rest_Client($this->piwik_url); $client->module('API'); $client->method('VisitsSummary.get'); $client->format('xml'); $client->token_auth(md5($login.$password)); $client->idSite($idSite); $client->period($period); $client->date('today'); try { return $client->get(); } catch (Exception $e) { return false; } } } ?>

Итак, пройдемся по методам данного класса и разъясним немного ситуацию. Перед тем как использовать данный класс необходимо сначала показать ему адрес в Интернете, по которому работает наш Piwik. Например, example.com/stats/.

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

 

Метод addSite

---

Параметры: $siteName - имя сайта, $urls - строка или массив адресов, по которым вести мониторинг для данного сайта. Метод заводит сайт Piwik и возвращает его идентификатор.

 

Метод updateSite

---

Нужно передать идентификатор созданного сайта и параметры, которые надо поменять. Результат: объект Zend_Rest_Client_Result.

 

Метод deleteSite

---

Метод очень простой. Нужно передать в него идентификатор удаляемого сайта. В результате получите объект Zend_Rest_Client_Result.

 

Метод addUser

---

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

 

Метод updateUser

---

Меняет параметры уже созданного пользователя. Нужно обязательно передать логин, а остальные по желанию. Ответ тот же.

 

Метод setUserAccess

---

Устанавливает права доступа конкретного пользователя. Логин, право доступа ('view','admin') и идентификатор сайта, для которого нужно установить доступ. Ответы без изменений.

 

Метод deleteUser

---

Удаляет пользователя из системы. Укажите только логин удаляемого пользователя.

 

Метод getSummary

---

Очень интересный метод. Возвращает объект Zend_Rest_Client_Result с  статистическими показателями за определенный период от указанного дня. В результате Вы можете показать статистику пользователю в его аккаунте и предложить перейти в Piwik для получения более детального отчета (кстати, для этих вещей есть возможность автоматической логинизации пользователя, но задача это тривиальная и хорошо расписана в разделе FAQ Piwik'а).

Работа всего класса заключается в посылке Piwik'у REST запросов, которые передают необходимые параметры и дают возможность получить информацию. Эта система статистики мне очень понравилась, но она, ИМХО, еще немного сыровата, но уже довольно приличная.

P.S. Обратите внимание, что пароль во всех методах передается у меня в виде md5 хеша!

 

Пивик хорошо себя ведёт на маленьких проектах.

Установил на свои, в среднем посещаемость 15-20 тысяч в сутки, не смог обработать и показать статистику за день, решения по кэшированию не встретил и отправил в печь.

Знакомство продолжалось ровно 2 дня.