Википедия:MediaWiki (perl)

Материал из Википедии — свободной энциклопедии

Perl-модуль MediaWiki — интерфейс на Perl, созданный Эдуардом Черненко и предназначенный для написания ботов для Википедии. Текущая версия — 1.08. Код модуля можно получить в архиве CPAN.

[править] Возможности

• Получение и сохранение кода страниц;
• «Prepared get» — получение вики-текста из формы редактирования вместе со спец-полями, значения которых понадобятся при сохранении страницы;
• Отметка минорных правок; ведение списка наблюдения;
• [SYSOP] Установка и снятие защиты страниц;
• [SYSOP] Удаление и восстановление страниц;
• [SYSOP] Блокировка/разблокировка пользователей;
• Загрузка изображений;
• Просмотр истории страниц и функция быстрого отката (пока что всегда в обход админ-интерфейса);
• Получение листинга категорий.

[править] Недоработки

• Нет контроля предупреждений при загрузке изображений.

[править] Пример конфигурационного файла

 [bot]
 user = VasyaPupkinBot
 pass = 123456
 
 [wiki]
 host = ru.wikipedia.org
 path = w

 has_filepath = 1 ; установите в 1, если доступна страница Служебная:Filepath
 has_query = 1 ; установите в 1, если доступен интерфейс Query API

 [tmp]
 msgcache = /tmp/mediawiki.msg

[править] Интерфейс

 use MediaWiki;

 $c = MediaWiki->new;
 $is_ok = $c->setup("config.ini");
 $is_ok = $c->setup({
        'bot' => { 'user' => 'Vasya', 'pass' => '123456' },
        'wiki' => {
                'host => 'en.wikipedia.org',
                'path' => 'w'
        }})
 $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;

[править] Подробное описание функций и свойств

[править] Обработка ошибок

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

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

[править] Известные ошибки

ERR_NO_INIHASH

Функция $c->setup() вызвана с конфигурационным файлом в качестве параметра, но отсутствует модуль Config::IniHash

ERR_PARSE_INI

Парсер конфигурационного файла вернул ошибку

ERR_NO_AUTHINFO

Вызвана функция $c->login(), но не указано, какое имя пользователя и пароль использовать

ERR_NO_MSGCACHE

Вызвана функция $c->refresh_messages(), но в конфигурации не задан путь к кэшу сообщений (или же отсутствует модуль Data::Dumper)

ERR_LOGIN_FAILED

Попытка входа не вернула HTTP-ответ 302; возможно, задан неправильный пароль

ERR_LOOP

Бесконечный цикл в модуле (либо внутренняя ошибка модуля, либо баг в вики-движке)

ERR_NOT_FOUND

Вызвана функция $c->text(), но требуемой страницы не существует

[править] Примеры

Примечание: все примеры начинаются со строк

use MediaWiki;
my $c = MediaWiki->new();
$c->setup();

[править] Простые примеры

[править] Создание подготовленных страниц

 opendir D, "articles";
 while(defined ($file = readdir(D)))
 {
   if(($file =~ s/\.txt$//) == 1)
   {
      my $text;
      open F, "$file.txt";
      read F, $text, -s F;
      close F;

      $c->text($file, $text);
   }
 }
 closedir D;

[править] Бот автозамен

 for(my $i = 0; $i < 10000; $i ++)
 {
    my $pg = $c->random();
    $pg->replace(\&my_replacements);
 }

[править] Более сложные примеры

[править] Антивандальный бот

Откатывает blanking (очистку страниц) и блокирует того, кто очищает страницы более пяти раз, на срок 1 час. Если это делает единственный автор страницы, то ставит пометку {{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->{content} .= "{{db-author}}"; # Delete note for admins
         $pg->{summary} = "+ {{db-author}}"
         $pg->save();
      }
      else
      {
        $users{$blanker} = 1 + (exists $users{$blanker} ? $users{$blanker} : 0);
        if($users{$blanker} > 5)
        {
          $c->block($blanker, "1 hour");
          delete $users{$blanker};
        }
      }
    }
 }

[править] Ссылки

• Страница модуля на CPAN Проверено 28 августа 2006 г.

• Исходный код версии 1.08 Проверено 28 августа 2006 г.

[править] См. также

• Википедия:Правила применения ботов
• meta:Using the python wikipediabot^(англ.)