File Coverage

blib/lib/MediaWiki/EditFramework/Page.pm

Criterion	Covered	Total	%
statement	14	37	37.8
branch	0	8	0.0
condition			n/a
subroutine	5	8	62.5
pod	2	4	50.0
total	21	57	36.8

=head1 NAME

MediaWiki::EditFramework::Page - a MediaWiki page object.

=head1 SYNOPSIS

 use MediaWiki::EditFramework;

 my $wiki = MediaWiki::EditFramework->new('example.com', 'wiki');
 my $page = $wiki->get_page('Main_Page');
 my $text = $page->get_text;
 $text =~ s/old thing/new update/g;
 $page->edit($text, 'update page');

=head1 DESCRIPTION

This module represents a MediaWiki page.  When instantiated, it gets the
page information from the site.  The last modified timestamp is stored when
the page is retrieved, and passed back via the I method to allow the
server to properly detect edit conflicts.

=head2 METHODS

=over

=cut

package MediaWiki::EditFramework::Page;
use strict;
use warnings;
use Data::Dumper;


sub new ($$$) {
	my ($class,$api,$title) = @_;
	my $page = $api->{0}->get_page({title=>$title});
	bless [$api,$page], $class;
}

sub _dump_text {
  my ($self,$prefix,$text) = @_;
  my ($mw,$page) = @$self;

  if (defined $mw->{text_dump_dir}) {
    my $title = $page->{title};
    $title =~ s:/:-:g;

    open my($fh), '>', "$mw->{text_dump_dir}/$prefix-$title";
    print $fh $text;
    close $fh;
  }
}
=item B

Get the current page text.

=cut

sub get_text( $ ) {
  my $self = shift;
  my ($mw,$page) = @$self;
  $self->_dump_text(read=>$page->{'*'});
  return $page->{'*'};
}

=item B(I,I)

Replace the text of the page with the specified I.  Using the
specified I as the edit summary to describe the edit.

The original timestamp will be passed back; if the page was editing between
when it was retrieved and when edit is called, and the server cannot
automatically merge our edit, then the edit will be rejected in order to
prevent clobbering the other edit.

If the L object has an I in effect,
that will be prepended to the page name.  This allow redirecting the output
from an edit into user space, to facilitate testing bot code.

=cut

sub edit( $$$ ) {
	my ($self,$text,$summary) = @_;
	my $mw = $self->[0];
	my $page = $self->[1];
	my $p = $mw->{write_prefix};

	$self->_dump_text(write=>$text);

	my %qh = (
		action=>'edit',
		bot=>1,
		title=>($p.$page->{title}),
		text=>$text,
		summary=>$summary,
	);

	$qh{basetimestamp}=$page->{timestamp} if $p eq '';

	eval {
		warn "edit $qh{title}";
		$mw->{0}->edit(\%qh)
		  or croak $mw->{error}->{code} . ': ' . $mw->{error}->{details};
	};

	die "Edit failed: ". Data::Dumper::Dumper($@) if $@;
}

=item B

Returns true if the underlying page existed on the server when the page was
retrieved, false if it is a new page.

=back

=cut

sub exists {
	my ($self) = @_;
	return exists $self->[1]->{'*'};
}

=head1 COPYRIGHT

Copyright (C) 2012 by Steve Sanbeg

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.10.1 or,
at your option, any later version of Perl 5 you may have available.

=cut

1;