Технология их разработки и применения на "пальцах"
О назначении ботов - одним предложением
Реализация практически любых новых функкциональных возможностей программы СайтСпутник -
самостоятельно, независимо от разработчика программы.
Доступно в программе SiteSputnik (http://sitesputnik.ru/),
начиная с версии 9.7.1 от 16.05.2019.
Выражаю благодарность Дмитрию "MOS" за конструктивный диалог, состоявшийся в процессе разработки данной функции программы.
Пример разработки новой функции своими силами
В СайтСпутнике, например, нет следующей функции, которая в некоторых случаях может быть весьма полезной:
отправка новых ссылок, найденных при очередном выполнении Проекта, в заданную папку.
В качестве демонстрационного Проекта возьмем следующий простой Проект:
наблюдение за появлением новых ссылок на трёх первых страницах выдачи Яндекса по запросу: Дмитрий Медведев.
Внешний вид этого Проекта представлен на картинке ниже:
(http://sitesputnik.ru/Help/Pic/F/Bot_Simple_Project.png)Технология разработки новой функции СайтСпутника своими силами такова.
Создаём текст Бота (пояснения к нему смотрите ниже) и
помещаем его в пакетный bat-файл с именем, например: "Файлы\Medvedev&Yandex.bat":
chcp 1251>nul
mkdir "C:\NewsMedvedev"
copy "{folder}\Экспорт-новые-txt.txt" "C:\NewsMedvedev"
Пояснение:
1-я строка - это вспомогательная команда для работы с русской кодировкой в bat-файле (это особенность синтаксиса bat-файлов; так надо).
2-я строка - это команда Windows, создающая на диске "C:\" папку "NewsMedvedev" (если папка существует, то эту команду можно опустить).
3-я строка - это команда Windows, копирующая файл "{folder}\Экспорт-новые-txt.txt" в папку "C:\NewsMedvedev".
Параметр {folder} по умолчанию содержит полное имя папки с результатами работы программы СайтСпутник.
Наглядный пример такой папки приведен на картинке ниже:
(http://sitesputnik.ru/Help/Pic/F/Bot_Folder.png)- В коричневую рамочку на картинке обведён файл "Экспорт-новые-txt.txt".
- Он как раз и содержит список новых ссылок, которые ни разу не были найдены ранее при выполнении данного Проекта.
- Именно его в третьей строке Бота прописано скопировать в папку "C:\NewsMedvedev".
(Все документы, создаваемые СайтСпутником, а их более 60 видов, перечислены на ссылке выдача СайтСпутника (http://sitesputnik.ru/Help/Documents.htm).)
Теперь осталось только вызвать из Проекта этот Бот в тот момент, когда список с новыми ссылками сформирован.
Для этого:
- выбираем Бот из меню (большая красная стрелочка на картинке ниже),
- прописываем ему фактические параметры, если они есть (синяя стрелочка),
- прописываем ему "Стартовую площадку" - "После открытия всех Источников" (зелёная стрелочка).
"Стартовая площадка" определяет как раз тот момент, когда Бот следует выполнить.
Полный текст Проекта состоит из двух строк и имеет следующий вид:
(http://sitesputnik.ru/Help/Pic/F/Bot_Project_Bat.png)Не набирайте вручную с клавиатуры имена ботов, названия стартовых площадок, параметры, получающие значения по умолчанию, -
используйте для этого меню. Руками требуется набирать только фактические значения параметров, если они есть.
Усовершенствуем Бот.
Если Бот будет выглядеть так:
chcp 1251>nul
mkdir "{AnyDir}"
copy "{folder}\Экспорт-новые-txt.txt" "{AnyDir}"
(мы сами ввели в него произвольный параметр, названный {AnyDir} ),
а обращение к нему в Проекте, например, так:
(http://sitesputnik.ru/Help/Pic/F/Bot_With_Parameter.png)то мы может применить разные имена папок в разных Проектах, указывая их при обращении к Боту.
Важно
- Это был самый простой Бот, на примере которого продемонстрирована технология реализации новой функции СайтСпутника своими силами.
- В данном крайнем случае обошлось без программирования - достаточно было команд Windows.
О назначении ботов - одним абзацем
- Расширение функциональных возможностей СайтСпутника за счет применения:
♦ уже существующего программного обеспечения широкого профиля,
♦ новых программ, разработанных специально для СайтСпутника.
- Привлечение к разработке новых функций СайтСпутника (к разработке ботов):
♦ сторонних программистов,
♦ продвинутых пользователей.
- Обеспечение их независимости от разработчика СайтСпутника.
- Доступность применения ботов, поддерживающих новые функции, обычным Пользователям.
Пример новой функции c применением программирования
В СайтСпутнике, например, нет следующей функции:
- определение новостей и сообщений, попавших хотя бы в одну Рубрику,
- оформление из них отдельного файла (полнотекстовой новостной ленты),
- отправка этой новостной ленты в заданную локальную папку.
Среди команд Windows и среди множества других готовых программ нет программы, которая умеет делать это.
"Берём" любой язык программирования, пишем такую программу сами и используем её в Боте.
В отличии от первого примера - это другой крайний случай, самый сложный, но и самый мощный - запрограммировать можно практически любую обработку информации.
Исходный текст программы, реализующей рассматриваемую новую функцию, приведен ниже.
При необходимости сделаю к нему пояснения персонально или здесь на форуме.
program Bot_NewsFromRubricsOnly; // Автор Мыльников Алексей Борисович: 1a@sitesputnik.ru, +7(8442)73-71-23,+7(905)392-97-92
// Назначение: Бот СайтСпутника - принимает в первом параметре P1 папку с результатами работы СайтСпутника {folder}, берет в ней файл с Чистым потоком, а именно: "Чистый поток.htm",
uses // считывает его, оставляет только Новости попавшие в Рубрики и сохраняет их в файле ЧП.htm, размещенном в парке, указнной во втором параметре
Windows, SysUtils, // Язык программирования Delphi XE2 - чисто для лучшего понимания (практически это язык Паскаль).
StrUtils; // Бот применяется со Стартовой площадки: "После формирования всех рубрик и потоков"
var i,j : integer;
S, Sw, fn: string;
NS : TextFile;
begin
fn:=ParamStr(1)+'\Чистый поток.htm'; if(not(FileExists(fn)))then EXIT; // Если не существует файла "Чистый поток", то на этом обработка заканчивается
S:=''; // В переменную S считаю
AssignFile(NS,fn,CP_UTF8); // весь контент файла с Чистым потоком
try Reset(NS); while(not(eof(NS)))do begin readln(NS,Sw); S:=S+Sw+#13#10; end; except end;
CloseFile(NS); // и закрою файл
//============== Собственно работа по контенту Чистого потока ================//
i:=0; Sw:=''; fn:='';
repeat i:=PosEx('[INPUT id=y-i',S,i+1); if(i=0)then BREAK; // Признак начала очередной Новости
if(pos(' CHECKED ',copy(S,i,30))=0)then CONTINUE; // Она не попала ни в одну Рубрику, следовательно, игнорирую её, и переходу к выбору следующей Новости
j:=PosEx('[br ""]',S,i)+6; // j установил на окончание Новости, попавшей хотя бы в одну Рубрику
if(Sw='')then begin // Это первая Новость, попавшая хоть в одну Рубрику, следовательно, создам Результирующий файл, в который буду выводить Новости
fn:=ParamStr(2); if(fn='')then fn:='C:'; ForceDirectories(fn); // в fn - имя папки, в которой сформирую файл ЧП.htm, если этой папки нет, то создам её
fn:=fn+'\ЧП.htm'; AssignFile(NS,fn,CP_UTF8); Rewrite(NS); // Создаю файл ЧП.htm в кодировке Юникод и в следующм операторе выведу в него стандартный заголовок
Writeln(NS,'[html][meta http-equiv="content-type" content="text/html; charset=UTF-8"][body][h1]Новости, попавшие в Рубрики[/h1]'+DateTimeToStr(Now)+'');// Формирование html-файла стандартное - заголовок
end;
Sw:=copy(S,i,j-i+1); // Собственно, выкусил очередную Новость, попавшую в Рубрику
Writeln(NS,Sw); // и вывожу её в файл
until(false);
if(fn='')then EXIT; // В Рубрики ничего не попало, файл результирующий не создавался, выхожу из бота
writeln(NS,'[/boby][/html]');// Формирование html-файла стандартное - окончание
CloseFile(NS); // Закрываю Результирующий файл ЧП.htm
//============== Собственно работа окончена ==================================//
end.
Программа написана на языке программирования Delphi - это "современный Pascal", который часто используется при изучении основ программирования.
Транслируем программу и exe-модуль помещаем, например, в папку "Exe\Bots" под именем "Bot_NewsFromRubricsOnly.exe".
Обращение к этому боту (непосредственно к написанной нами программе) из Проекта может быть, например, таким:
(http://sitesputnik.ru/Help/Pic/F/Bot_With_Par_Sputnic.png)Пояснение:
- Параметр {folder} - это папка с результами работы СайтСпутника, в ней есть файл "Чистый поток.htm" (обведен синей рамочкой на одной из картинок выше),
- Бот принимает этот файл через первый параметр - смотрите в исходном тексте программы 10-ую строку: "fn:=ParamStr(1)+'\Чистый поток.htm';".
- Параметр {DeskTop}\Потоки - это папка "Потоки", размещённая на Рабочем столе Вашего компьютера, которую Бот использует для отправки в неё результата своей работы.
- Стартовая площадка "После формирования всех рубрик и потоков" означает, что вызов бота осуществится в SiteSputnik News после выполнения соответствующих действий.
Напоминание: используйте меню при прописке Ботов в Проектах.
Дополнительные замечания:
- по описанной выше технологии к СайтСпутнику можно "прикрутить" самые разнообразные программы,
- важно, чтобы к таким программам можно было обратиться из командной строки,
- разработка ботов доступна программистам или продвинутым Пользователям, а не только разработчику СайтСпутника,
- применение Ботов доступно обычным Пользователям.
О ботах СайтСпутника - общие положения
Основные понятия:
- При выполнении Проектов программа Сайт Спутник может запускать бот-программы.
- Бот-программы могут быть запущены с нескольких стартовых площадок (см. ниже) СайтСпутника.
- Они (боты) могут быть запущены как с ожиданием окончания их работы, так и без него.
- Ботам может быть передана информация, добытая СайтСпутником.
- Они (Боты) могут переработать информацию и передать её "обратно" в программу.
- Боты могут поставить "свою" информацию СайтСпутнику.
Бот-программа:
- Боты могут быть созданы как:
♦ bat-файлы-с-параметрами,
♦ cmd-файлы-с-параметрами,
♦ exe-файлы-с-параметрами.
- В качестве программ, входящих в состав Бота, может быть использован любой исполняемый код, например:
♦ любые команды операционной системы,
♦ любые готовые программы, запускаемые из командной строки,
♦ программы на любом языке программирования, разработанные независимыми программистами для СайтСпутника.
- Никакие API со стороны программы СайтСпутник не используются.
- Обмен данными между Ботами и СайтСпутником осуществляется через параметры ботов.
Параметры ботов по умолчанию:
- С разных стартовых площадок СайтСпутника, ботам доступны разные параметры.
- Перечень основных параметров следующий.
♦ URL - адрес Источника или целевой ссылки, выбираемой из Источника (в зависимости от стартовой площадки).
♦ IN - полное имя файла, в котором СайтСпутник сохранил контент Источника, или целевой ссылки из Источника.
♦ OUT - по умолчанию получает то же значение что и параметр IN, но используется, как правило,
для удобства, для явного указания имени стороннего файла, хотя это можно сделать и через произвольный параметр (см. ниже).
♦ Folder - полное имя папки, в которую СайтСпутник складывает добытые результаты (промежуточные и конечные).
Это очень важный параметр. Из него Бот может получить, а затем обработать и вернуть в СайтСпутник:
♦ Списки адресов или сниппетов всех целевых ссылок, полученных при выполнении Проекта.
♦ Списки адресов или сниппетов только новых целевых ссылок, только новых сайтов, только новых доменов 3-го уровня.
♦ Статистические данные по источникам, рубрикам, доменам.
♦ Содержание Рубрик, создаваемых СайтСпутником.
♦ Практически любой из 60 документов из выдачи СайтСпутника (http://sitesputnik.ru/Help/Documents.htm),
♦ Alias - полное имя текущего ящика (папки, в которой выполняется Проект).
♦ Box - последнее имя из полного имени текущего ящика.
♦ Number - порядковый номер Проекта, выполняемого в текущем ящике.
♦ DeskTop - полное имя папки Рабочего стола компьютера.
♦ MainDir - полное имя корневой папки программы СайтСпутник.
♦ Date - текущая дата.
♦ Time - текущее время.
♦ Wait=Yes - применяется, если нужно дождаться завершения работы бота, иначе явно примените Wait=No.
♦ Quote=Yes - обеспечивает автоматическую расстановку двойных кавычек для фактических значений параметров.
Если Вы собираетесь расставить кавычки сами, то явно примените Quote=No.
♦ Произвольный параметр - одно произвольное слово, взятое в фигурные скобки, - по умолчанию получает пустое значение.
- Один и тот же параметр в тексте Бота может быть применен несколько раз.
- Параметры по умолчанию могут быть применены при назначении фактических значений параметров,
(смотрите, например, ниже в демонстрационном примере Проекта: Folder={IN} ).
- Как уже сообщалось выше: Боты могут изменить полученную через параметры информацию и вернуть её "обратно" в СайтСпутник.
Фактические значения параметров:
- Параметрам ботов можно явно присвоить необходимые фактические (конкретные) значения, например:
♦ Folder="D:\Рабочая папка\Shop",
♦ out="D:\Рабочая папка\Shop\FilName.html"
♦ Слово1=2019
Стартовые площадки для ботов
Стартовые площадки служат для запуска размещенных на них Ботов.
В настоящей реализации СайтСпутника их девять.
Боты могут быть выполнены:
- В самом начале работы Проекта,
- Перед открытием страницы Источника,
- После открытия страницы Источника,
- После открытия всех Источников, (эти четыре площадки доступны в SiteSputnik Pro)
- Перед рубрикацией и анализом конкретной ссылки,
- Во время рубрикации и анализа конкретной ссылки-GoBot:,
а именно, в моменты выполнения операции:
GoBOT:<имя и параметры Бот-программы>,
- После рубрикации и анализа конкретной ссылки,
- После формирования конкретной рубрики,
- После формирования всех рубрик и потоков (в самом конце работы Проекта в SiteSputnik News).
- Десятая площадка находится за рамками выполнения Проекта (смотрите на картинке ниже по красной стрелочке):
(http://sitesputnik.ru/Help/Pic/F/Bot_Manually.png)Эта площадка служит для ручного запуска Ботов.
Важно:
Выполняя Проект, СайтСпутник последовательно проходит через все страртовые площадки и проверяет их содержание.
