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

Здесь будет документация по проекту.

Общая информация

Проект SapExtension представляет собой набор скриптов, предназначенный для сбора информации с аккаунта вебмастера системы SAPE.RU.

Зачем это нужно?

Традиционно система SAPE.RU не балует участвующих в ней вебмастеров развёрнутой статистикой. Это и понятно - у системы много своих забот, обязательств, которые система должна выполнять. Данный программный комплекс берёт на себя часть функций по сбору информации о сайтах вебмастера в системе, их параметрах, страницах, ссылок. Каждый раз, когда SapExtension просматривает аккаунт пользователя и находит различие в параметрах сайтов, ссылок или страниц сайтов, она записывает новые данные и время записи. Таким образом в базе данных хранится хронологическая информация о состоянии сайтов, ссылок и страниц, становится возможным формировать любые запросы к базе данных, чтобы увидеть ту или иную динамику (статистику) по интересующим объектам.

Алгоритмы анализа не входят в этот проект. SapExtension только помогает собирать статистику, её же анализ следует делать в пакетах, специально предназначенных для этой цели - например, математическом пакете SciLab, MatLab, Mathematica, Maple, Maxima или же в банальном Open Office Calc или Microsoft Excel.

Путём SQL-запросов к базе данных Вы можете сформировать любые статистические ряды, которые затем можно обстоятельно, подробно и во всех деталях проанализировать в вышеуказанных профессиональных математических пакетах.

Системные требования

Программный комплекс SapExtension имеет следующие системные и несистемные :) требования:

Установка

В этом разделе находится подробное описание процесса установки SapExtension на сервер.

Описана процедуры подготовки файлов, базы данных, а также процедура настройки SapExtension.

Подготовка файлов

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

Для того, чтобы продолжить, сначала скачайте последнюю версию SapExtension со страницы закачек.

Создайте на Вашем сервере папку, куда вы будете устанавливать SapExtension, например, /home/www/sapextension. (В дальнейшем в этом руководстве мы будем считать, что вы установили комплекс в эту папку для Linux-систем, или в папку C:\www\sapextension для Windows-систем.)

Распакуйте содержимое скачанного архива в папку, которую вы создали.

Содержимое папки должно быть примерно таким:

..
|
|-> classes
| |
| |-> core
| | |
| | SAPE_HTML.php
| | SAPE_Object.php
| |
| |-> objects
| | |
| | SAPE_Link.php
| | SAPE_Main.php
| | SAPE_Notice.php
| | SAPE_Page.php
| | SAPE_Site.php
|
|-> db
| |
| db_content.sql
| db_structure.sql
|
config-sample.php
get_links.php
get_notices.php
get_pages.php
get_sape.php
get_sites.php
index.php

Подготовка базы данных

Прежде всего, Вы должны создать базу данных на сервере MySQL. Для этого запустите phpMyAdmin и создайте на сервере базу данных, которую будет использовать SapExtension. Пусть, например, Вы создали базу данных sapextension.

Теперь Вы должны выполнить 2 запроса, которые находятся в подпапке db корневой директории SapExtension. Вот они:

  • Структура базы данных - db_structure.sql. Этот файл содержит начальную структуру базы данных. Он нужен для того, чтобы инициализировать нашу базу данных.
  • Наполнение базы данных - db_content.sql. Этот файл содержит в себе пункты каталога, который использует SAPE.RU для категоризации сайтов, а также пункты Яндекс-каталога, DMOZ-каталога, и может содержать любые другие каталоги и их пункты.

Выполните в свежесозданной базе два запроса: сначала тот, что содержится в файле инициализации структуры БД - db_structure.sql, а следом за ним запрос, содержащий пункты каталогов - db_content.sql.

В результате у Вас должна появиться готовая к использованию база данных.

Настройка SapExtension

Самое время настроить SapExtension. Все настройки делаются путём редактирования файла config-sample.php. В нём содержаться все основные настройки. После завершения редактирования сохраните файл, закройте редактор и переименуйте файл config-sample.php в config.php.

Откройте файл config-sample.php в любом текстовом редакторе.

Первое, что мы должны сделать, это прописать логин и пароль от аккаунта в системе SAPE.RU. Напоминаем, что Вы должны быть уже зарегистрированы в системе SAPE.RU. Если это ещё не так, то зарегистрируйтесь по этой ссылке.

Найдите следующие строки:



<?php
define
('LOGIN''-----');                         //здесь впечатайте Ваш Логин
define('PASSWORD''--------');                   //здесь впечатайте Ваш пароль
?>

Вместо чёрточек впечатайте Ваш логин и пароль в соответствующих строках.

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

Найдите следующие строки:



<?php
$db_username 
'-----';                    //здесь впечатайте Ваш Логин для связи с БД
$db_password '------------';                //здесь впечатайте Ваш пароль для связи с БД
$db_host 'localhost';                    //здесь впечатайте сервер Вашей БД
$db_name '-----';                    //здесь впечатайте имя Вашей БД
$db_interface 'mysqli';                //интерфейс PHP для БД [mysql | mysqli]
?>

Отредактируйте строки в соответствии с Вашими настройками, вставив вместо чёрточек свои значения.

На этом этапе настройка SapExtension полностью завершена, и Вы можете приступать к сбору статистики.

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

Настройка сервера

Данный раздел документации находится в разработке.

Планируется осветить следующие пункты:

  1. Настройка планировщика задач (crontab в Linux)
  2. Настройка Планировщика Задач в Windows

Использование

Данный раздел документации находится в разработке.

Его содержание планируется быть таким:

  1. Использование проекта
  2. Что, как и где хранится (описание структуры БД)
  3. Написание запросов к БД, чтобы сформировать ту или иную статистику (примеры запросов, дающие полезную информацию)

Лицензия

Данный программный продукт использует Open-Source лицензию GNU/GPL v.2. Вот официальная ссылка на постоянный текст этой лицензии: http://www.gnu.org/licenses/old-licenses/gpl-2.0.html

А по этой ссылке вы можете ознакомиться с этой лицензией на русском языке: http://andyceo.ruware.com/book/gnu-gpl-v-2-russian

При любых разногласиях и разночтениях преимущество остаётся за оригинальной лицензией на английском языке.