MediaWiki (perl): различия между версиями

'''Perl-модуль MediaWiki''' — интерфейсбиблиотека на(модуль) [[для {{w |Perl]] 5}}, созданный [[w:Участник:СибирчегНоНеНарушитель|Эдуардом Черненко]] и предназначенный для написания [[w:Википедия:Бот |ботов]] для Википедии. ТекущаяПоследняя версия — '''1.08'''13 (2008-01-06). Код модуля можноисходно получитьраспространялся через {{w |CPAN}}; в архивенастоящее время может быть получен [[CPAN]]http://snapshot.debian.org/archive/debian/20120328T101221Z/pool/main/libm/libmediawiki-perl/ через snapshot.debian.org.]

* Получение и сохранение кода страниц;.

* «Prepared get» — получение вики-текста из формы редактирования вместе со спец-полями, значения которых понадобятся при сохранении страницы;.

* Отметка минорных[[w:Википедия:Малые правокизменения |малых изменений]]; ведение [[w:Справка:Список наблюдения |списка наблюдения;]].

has_filepath = 1 ; <i style="white-space: pre-wrap;" >установите в 1, если доступна страница [[Служебная:Filepath]].</i>

has_query = 1 ; <i style="white-space: pre-wrap;" >установите в 1, если доступен интерфейс [[mw:API:Query |Query API]].</i>

$c = MediaWiki->new;

$is_ok = $c->setup("config.ini");

$is_ok = $c->setup({

$is_ok = $c->switch('starwars.wikia.com');

$is_ok = $c->switch('en.wikipedia.org',
'w', { 'has_query' => 1, 'has_filepath' => 1 });

$whoami = $c->user();

$text = $c->text("page_name_here");

$is_ok = $c->text("page_name_here", "some new text");

$c->refresh_messages();

$msg = $c->message("MediaWiki_message_name");

die unless $c->exists("page_name");

my($articles_p, $subcats_p) = $c->readcat("category_name");

$is_ok = $c->upload("image_name", `cat myfoto.jpg`, "some notes", $force);

$is_ok = $c->block("VasyaPupkin", "2 days");

$is_ok = $c->unblock("VasyaPupkin");

$c->{summary} = "Automatic auto-replacements 1.2";

$c->{minor} = 1;

$c->{watch} = 1;

if(!$is_ok)

{

$err = $c->{error};

# do something

}

$pg = $c->random();

$pg = $c->get("page_name");

$pg = $c->get("page_name", "");

$pg = $c->get("page_name", "rw");

$is_ok = $pg->load();

$is_ok = $pg->save();

$text = $pg->oldid($old_version_id);

$text = $pg->content();

$title = $pg->title();

$is_ok = $pg->delete();

$is_ok = $pg->restore();

$is_ok = $pg->protect();

$is_ok = $pg->protect($edit_protection);

$is_ok = $pg->protect($edit_protection, $move_protection);

$is_ok = $pg->move("new_name");

$is_ok = $pg->watch();

$is_ok = $pg->unwatch();

$is_ok = $pg->upload(`cat myfoto.jpg`, "some notes", $force);

$is_ok = $pg->block("2 days");

$is_ok = $pg->unblock();

$pg->history(sub { my $edit_p = shift; } );

$pg->history_clear();

my $edit_p = $pg->last_edit;

my $edit_p = $pg->find_diff(qr/some_regex/);

$is_ok = $pg->markpatrolled();

$is_ok = $pg->revert();

$pg->{history_step} = 10;

$is_ok = $pg->replace(sub { my $text_p = shift; } );

$is_ok = $pg->remove("some_regex_here");

$is_ok = $pg->remove_template("template_name");

$pg->{content} = "new text";

$pg->{summary} = "do something strange";

$pg->{minor} = 0;

$pg->{watch} = 1;

</presource>

| <code >MediaWiki->new ()</code>

| <nowiki>$c->setup ([ $ini_file_name | $config_hash_pointer ])</nowiki>

| Читает конфигурационный файл (если не указан, то берётся файл "<code >.bot.ini"</code> из домашнего каталога текущего пользователя) и настраивает клиент. Если указаны имя пользователя и пароль, то вызывает <code >$c->login()</code>. Если в качестве параметра передаётся указатель на хэш-массив, то он будет использован как источник конфигурации (<code >{ 'bot' => { 'user' => ..., 'pass' => ...}, 'wiki' => ... }</code>).

| $c->login ([$user {{nobr|[, $password]}}])

| ПроизводитВыполняет «вход» в системувики и сохраняет полученные [[{{w |cookie]]}} в файле <code >.lwpcookies.txt</code> в домашнем каталоге пользователя.

| $c->switch (($wiki_hash_pointer | $wiki_host {{nobr|[, $wiki_path]}} {{nobr|[, $wiki_hash_pointer]}}))

| Частично перенастраивает клиент (обычно используется для интервики-ботов). Первый необязательный параметр -— имя сервера (например, <code >'ru.wikipedia.org'</code>), второй необязательный — путь к <code >index.php/query.php</code> (например, <code >'w'</code>). Самый последний параметр (первый встретившийся указатель на хэш-массив) воспринимается как дополнительные ключи, которые необходимо изменить в разделе конфигурации '<code >wiki'</code> (например, <code >'has_filepath'</code>). Все ключи, не изменяемые явно, сохранят своё значение. После перенастройки будет выполнена попытка входа под тем же именем и паролем, что и при начальной конфигурации, если таковые были заданы. '''Примечание:''' информация о всех вызовах <code >$c->login ()</code> сохраняется — при обратном переключении будут использованы cookie, полученные при первом входе.

| <code >$c->user ()</code>

| Возвращает имя пользователя, полученное из конфигурационного файла, или делает правку в [[w:Википедия:Песочница |песочнице]] и получает IP-адрес из истории страницы. В последнем случае результат не кэшируется (не вызывайте эту функцию несколько раз, а запоминайте результат, если он используется несколько раз).

| $c->text( ($page_name {{nobr|[, $new_text ]}})

| Если задан параметр <code >$new_text</code>, то сохраняет страницу <code >$page_name</code> с его содержимым в качестве текста. В противном случае возвращает текущий вики-текст.

| <code >$c->refresh_messages ()</code>

| <code >$c->message ($message_name)</code>

| <code >$c->exists ($page_name)</code>

| <code >$c->readcat($category_name)</code>

| Читает содержимое категории. Возвращает два указателя на массивы, первый со списком статей, а второй -— со списком подкатегорий (без префикса пространства имён «Категория:»). {{/QUERY}}

| $c->upload($image_name, $content {{nobr|[, $description}} {{nobr|[, $force]]}});

| Выгружает картинку под именем «ИзображениеФайл:$image_name» и содержимым $content. Если описание не указано, то будет использована пустая строка. Флаг $force заставляет игнорировать предупреждения (важно: в этой версии предупреждение приводит к отказу от загрузки).

| <code >$c->filepath ($image_name)</code>

| <code >$c->download($image_name)</code>

| <code >$c->block ($user_name, $block_time)</code>

| <code >$c->unblock ($user_name)</code>

| <code >$c->random ()</code>

| $c->get ($page {{nobr|[, $mode]}})

| Возвращает дескриптор страницы $page. Параметр $mode может принимать значения «», «r», «w» или «rw» (по умолчанию «r»). Если указан флаг '''r''', то будет получен текст страницы, а если указан флаг '''w''', то страница будет подготовлена к сохранению -— загружается не сырой текст, а сразу форма редактирования, из которой получаются значения полей, которые понадобятся при сохранении страницы. ''Примечание'': режим подготовки автоматически отключается после первого сохранения страницы.

| <code >$c->{minor}</code>

| Если задано в 1, то все изменения отмечаются как [[w:Википедия:Малые изменения |малые]], установка значения в 0 отключает это поведение. Если значение не определено, то используется значение настроек аккаунта.

| <code >$c->{watch}</code>

| Если задано в 1, то изменяемые страницы будут включаться в [[Служебнаяw:WatchlistСправка:Список наблюдения |список наблюдения]], установка значения в 0 отключает это поведение. Если значение не определено, то используется значение настроек аккаунта.

| <code >$c->{summary}</code>

| Краткое описание для правок, производимых ботом. Также используется в качестве причины переименования страниц, блокировки пользователей и т.  п. Если значение неопределено и не задано в дескрипторе страницы, то используется строка <code >"Bot: Edward's framework"</code>.

|-

| <code >$c->{error}</code>

| <code >$c->{on_error}</code>

| <code >$pg->load ()</code>

| Получает содержимое страницы. Автоматически вызывается из <code >$c->random</code> и <code >$c->get</code>, если флаг <code >r</code> не был отключён.

| <code >$pg->save ()</code>

| <code >$pg->content ()</code>

| <code >$pg->oldid ($id)</code>

| <code >$pg->title ()</code>

| <code >$pg->delete ()</code>

| <code >$pg->restore ()</code>

| Защищает страницу от изменений. Понимаются следующие режимы защиты: 2 — изменения может производить только администратор, 1 — все, кроме анонимов и [[Служебная:Contributions/newbies|новичков]], 0 — нет защиты. Первый параметр указывает защиту от правок текста, второй -— от переименований. Если указан лишь один параметр, то второй устанавливается в такое же значение. Вызов без параметров аналогичен ''$pg->protect(1, 1)''. Для снятия защиты используется вызов ''$pg->protect(0)''.

| <code >$pg->move ($new_name)</code>

| $pg->watch ({{nobr|[$unwatch]}})

| <code >$pg->unwatch ()</code>

| АналогСиноним ''$pg->watch(1)''.

| $pg->upload ($content, {{nobr|[, $description}} {{nobr|[, $force]]}})

| <code >$pg->block ($block_time)</code>

| <code >$pg->unblock ()</code>

|-

| <code >$pg->history (&cb)</code>

Эта функция использует тот же кэш истории, что и ''last_edit ()'', ''revert ()'' и т.  п.

| <code >$pg->history_clear ()</code>

| <code >$pg->last_edit ()</code>

| <code >$pg->find_diff ($regex)</code>

| <code >$pg->markpatrolled ()</code>

| <code >$pg->revert ()</code>

| Откатывает изменения, внесённые пользователем, который последним редактировал эту страницу. Эта функция '''не''' использует администраторский инструмент быстрого отката и может использоваться кем угодно. В качестве краткого описания будет использовано MediaWiki-сообщение [[MediaWiki:Revertpage|Revertpage]]. ''Примечание:'' если вы определили необходимость отката из функции history(), то ''опережение'' бота другим пользователем не приведёт к откату к неправильной версии -— эта ситуация будет обработана корректно (но только если между вызовами history/last_edit и revert не очищался кэш).

| <code >$pg->replace (&cb)</code>

| <code >$pg->remove ($regex)</code>

| <code >$pg->remove_template ($template_name)</code>

| <code >$pg->{content}</code>

| <code >$pg->{minor}</code>

| <code >$pg->{watch} </code>

| <code >$pg->{summary}</code>

| <code >$pg->{history_step}</code>

На данный момент все функции, для которых явно не описано возвращаемое значение, возвращают 1 при успехе и undef при ошибке. Можно проверить код ошибки в <code >$c->{error}</code>, но пока ещё не все ошибки модуль обрабатывает должным образом (0 в <code >$c->{error}</code> может означать как успех, так и неизвестную ошибку).

Также можно указать callback (указатель на функцию), который будет вызываться при возникновении ошибки; он помещается в <code >$c->{on_error}</code>. Данная функция вызывается без параметров (код ошибки — в <code >$c->{error}</code>).

==== Антивандальный бот ====

Откатывает «очистку страниц» ({{lang |en|''blanking'' (очистку страниц}) и блокирует того, кто очищает страницы более пяти раз, на срок 1  час. Если это делает единственный автор страницы, то ставит пометку {{tl|db-author}} (но не удаляет статью — возможно, это была ошибка).

$c->{summary} = "Vandalism: blanking more than 5 times";

my %users = ();
my %articles = ();

while (1)

{

my $pg = $c->random ();

if ($pg->content () eq '')

{

my $e = $pg->last_edit;

$blanker = $e->{user};

$pg->revert ();

$e = $pg->last_edit;

if($e->{user} eq $blanker) { # Only author

$pg->{contentsummary} .= "+ {{db-author}}"; # Delete note for admins

$users{$blanker}

if ($users{$blanker} > 5) {

$users{c->block($blanker} =, "1 + (exists $users{$blanker} ? $users{$blanker} : 0hour");

if( delete $users{$blanker} > 5);

}

* {{citeCite web | url = http://search.cpan.org/src/~SPECTRUM/MediaWiki-1.08/lib12/ | title =Исходный кодMediaWiki-1.12 версии| author = Черненко Эдуард Павлович | work = search.cpan.org | archiveurl = //web.archive.org/web/20080125200743/http://search.cpan.org/~spectrum/MediaWiki-1.0812/ |accessdate archivedate =28 августа2008-01-25 | deadlink = 2006sure}}

* [[w:{{Wikipedia-inline |Википедия:Правила применения ботов]]}}

{{Темы |Программное обеспечение |Справочники}}