lib/SuikaWiki/Plugin.pm

=head1 NAME

SuikaWiki::Plugin - SuikaWiki: WikiPlugin common interface

=head1 DESCRIPTION

This module provides WikiPlugin interface implementation.

There are two interface: class methods collection and WikiPlugin object.
Class methods collection provides some useful facilities to be
called by WikiPlugin module and/or by contexts using WikiPlugin.

This module is part of SuikaWiki.

=cut

package SuikaWiki::Plugin;
use strict;
our $VERSION = do{my @r=(q$Revision: 1.16 $=~/\d+/g);sprintf "%d."."%02d" x $#r,@r};

=head1 CLASS METHODS

=over 4

=item $formatter = SuikaWiki::Plugin->formatter ($category_name)

Returns an instance of formatter whose category (context) is
$category_name.

=cut

{my %Formatter;
sub formatter ($$) {
  my $t = $_[1]; $t =~ tr/-/_/;
  unless ($Formatter{$t}) {
    $Formatter{$t} = new SuikaWiki::Plugin::xml_formatter
                       -category_name => $t;
  }
  return $Formatter{$t};
}}

{my %Formatter;
sub text_formatter ($$) {
  my $t = $_[1]; $t =~ tr/-/_/;
  unless ($Formatter{$t}) {
    $Formatter{$t} = new SuikaWiki::Plugin::text_formatter
                       -category_name => $t;
  }
  return $Formatter{$t};
}}

{my %Formatter;
sub boolean_formatter ($$) {
  my $t = $_[1]; $t =~ tr/-/_/;
  unless ($Formatter{$t}) {
    $Formatter{$t} = new SuikaWiki::Plugin::boolean_formatter
                       -category_name => $t;
  }
  return $Formatter{$t};
}}

=item $package = SuikaWiki::Plugin->module_package ($plugin_name)

Returns package name of the plugin module named $plugin_name.

=cut

## NOTE: Fix mkplugin2.pl when modify this function.
sub module_package ($$;%) {
  my ($self, $module, %opt) = @_;
  my $pack = $SuikaWiki::Plugin::Registry::Info{$module}->{module_name};
  if ($pack) {
    return $pack;
  } elsif (not $opt{allow_undef}) {
    throw SuikaWiki::Plugin::error
      -type => 'PLUGIN_NOT_FOUND',
      module => $module,
      -object => $self, method => 'module_package';
  } else {
    return undef;
  }
}

=item SuikaWiki::Plugin->load_directory ($dir1, $dir2,...)

Loads plugin modules in specified directories.

=cut

sub load_directory ($;@) {
  my $self = shift;
  for my $dir (@_) {
    opendir PDIR, $dir or throw SuikaWiki::Plugin::error
                            -type => 'PLUGIN_DIRECTORY_CANT_OPEN',
                            file => $dir,
                            message => $!,
                            -object => $self, method => 'load_directory';
    for (grep {substr ($_, -3) eq '.pm'} readdir PDIR) {
      eval { require $dir.'/'.$_ };
      if ($@) {
        throw SuikaWiki::Plugin::error
          -type => 'PLUGIN_COMPILE_ERROR',
          file => $dir.'/'.$_,
          message => $@,
          method => 'load_directory', -object => $self;
      }
    }
    closedir PDIR;
  }
}

sub load_file ($@) {
  my $self = shift;
  for (@_) {
    eval { require $_.'.pm' };
    if ($@) {
      throw SuikaWiki::Plugin::error
          -type => 'PLUGIN_COMPILE_ERROR',
          file => $_.'.pm',
          message => $@,
          method => 'load_file', -object => $self;
    }
  }
}

=back

=head1 WIKIPLUGIN MANAGER OBJECT

This part implements WikiPlugin manager object of SuikaWiki WikiPlugin 
implementation model, second edition.

Note that class methods such as C<< ->load_directory >>
and C<< ->formatter >> as also available as methods of WikiPlugin object,
although result of those operation is still "global".

WikiPlugin manager object is usually instantiated by C<init_plugins>
method of Wiki implementation object (C<SuikaWiki::Implementation> module).

  $wiki = <SuikaWiki::Implementation instance>;
  $wiki->init_plugins;
  $plugin_manager = $wiki->{plugin};

=over 4

=item $p = SuikaWiki::Plugin->new (wiki => $WIKI)

Constructs new instance of WikiPlugin manager

=cut

sub new ($;%) {
  my $class = shift;
  bless {@_}, $class;
}

sub exit ($) {
  my $self = shift;
  delete $self->{wiki};
  $self->{exited} = 1;
}

sub DESTROY ($) {
  my $self = shift;
  $self->exit unless $self->{exited};
}

=item $p->{wiki}

Wiki implementation $p is associated with

=back

=cut

package SuikaWiki::Plugin::xml_formatter;
require Message::Util::Formatter::Node;
our @ISA = 'Message::Util::Formatter::Node';
require Message::Markup::XML::Node;

sub ___rule_def ($) {
  $SuikaWiki::Plugin::Rule{$_[0]->{-category_name}} || {};
}

sub replace_option () {+{
    -class => 'Message::Markup::XML::Node',
}}

package SuikaWiki::Plugin::text_formatter;
require Message::Util::Formatter::Text;
our @ISA = 'Message::Util::Formatter::Text';

sub ___rule_def ($) {
  $SuikaWiki::Plugin::Rule{$_[0]->{-category_name}} || {};
}

package SuikaWiki::Plugin::boolean_formatter;
require Message::Util::Formatter::Boolean;
our @ISA = 'Message::Util::Formatter::Boolean';

sub ___rule_def ($) {
  $SuikaWiki::Plugin::Rule{$_[0]->{-category_name}} || {};
}

package SuikaWiki::Plugin::error;
require Message::Util::Error;
our @ISA = 'Message::Util::Error';

=head1 EXCEPTIONS

=over 4

=item PLUGIN_COMPILE_ERROR

Something wrong while loading WikiPlugin module file C<file>,
because of C<message>.

=item PLUGIN_DIRECTORY_CANT_OPEN

WikiPlugin directory C<file> cannot be opened, because of C<message>.

=item PLUGIN_NOT_FOUND

WikiPlugin module C<module> not found.

=cut

sub ___error_def () {+{
  PLUGIN_COMPILE_ERROR => {
    description => q(%t(name => method);: %t(name => file);: %t(name => message);),
  },
  PLUGIN_DIRECTORY_CANT_OPEN => {
    description => q(%t(name => method);: %t(name => file);: %t(name => message);),
  },
  PLUGIN_NOT_FOUND => {
    description => q(%t(name => method);: WikiPlugin module "%t(name => module);" not loaded),
  },
}}

=back

=head1 SEE ALSO

<IW:SuikaWiki:SuikaWiki:WikiPlugin>

C<lib/SuikaWiki/Plugin/*>,
C<misc/pluging/*>

=head1 LICENSE

Copyright 2002-2003 Wakaba <w@suika.fam.cx>

This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.

=cut

1; # $Date: 2004/06/03 06:38:48 $
1	=head1 NAME
2
3	SuikaWiki::Plugin - SuikaWiki: WikiPlugin common interface
4
5	=head1 DESCRIPTION
6
7	This module provides WikiPlugin interface implementation.
8
9	There are two interface: class methods collection and WikiPlugin object.
10	Class methods collection provides some useful facilities to be
11	called by WikiPlugin module and/or by contexts using WikiPlugin.
12
13	This module is part of SuikaWiki.
14
15	=cut
16
17	package SuikaWiki::Plugin;
18	use strict;
19	our $VERSION = do{my @r=(q$Revision: 1.16 $=~/\d+/g);sprintf "%d."."%02d" x $#r,@r};
20
21	=head1 CLASS METHODS
22
23	=over 4
24
25	=item $formatter = SuikaWiki::Plugin->formatter ($category_name)
26
27	Returns an instance of formatter whose category (context) is
28	$category_name.
29
30	=cut
31
32	{my %Formatter;
33	sub formatter ($$) {
34	my $t = $_[1]; $t =~ tr/-/_/;
35	unless ($Formatter{$t}) {
36	$Formatter{$t} = new SuikaWiki::Plugin::xml_formatter
37	-category_name => $t;
38	}
39	return $Formatter{$t};
40	}}
41
42	{my %Formatter;
43	sub text_formatter ($$) {
44	my $t = $_[1]; $t =~ tr/-/_/;
45	unless ($Formatter{$t}) {
46	$Formatter{$t} = new SuikaWiki::Plugin::text_formatter
47	-category_name => $t;
48	}
49	return $Formatter{$t};
50	}}
51
52	{my %Formatter;
53	sub boolean_formatter ($$) {
54	my $t = $_[1]; $t =~ tr/-/_/;
55	unless ($Formatter{$t}) {
56	$Formatter{$t} = new SuikaWiki::Plugin::boolean_formatter
57	-category_name => $t;
58	}
59	return $Formatter{$t};
60	}}
61
62	=item $package = SuikaWiki::Plugin->module_package ($plugin_name)
63
64	Returns package name of the plugin module named $plugin_name.
65
66	=cut
67
68	## NOTE: Fix mkplugin2.pl when modify this function.
69	sub module_package ($$;%) {
70	my ($self, $module, %opt) = @_;
71	my $pack = $SuikaWiki::Plugin::Registry::Info{$module}->{module_name};
72	if ($pack) {
73	return $pack;
74	} elsif (not $opt{allow_undef}) {
75	throw SuikaWiki::Plugin::error
76	-type => 'PLUGIN_NOT_FOUND',
77	module => $module,
78	-object => $self, method => 'module_package';
79	} else {
80	return undef;
81	}
82	}
83
84	=item SuikaWiki::Plugin->load_directory ($dir1, $dir2,...)
85
86	Loads plugin modules in specified directories.
87
88	=cut
89
90	sub load_directory ($;@) {
91	my $self = shift;
92	for my $dir (@_) {
93	opendir PDIR, $dir or throw SuikaWiki::Plugin::error
94	-type => 'PLUGIN_DIRECTORY_CANT_OPEN',
95	file => $dir,
96	message => $!,
97	-object => $self, method => 'load_directory';
98	for (grep {substr ($_, -3) eq '.pm'} readdir PDIR) {
99	eval { require $dir.'/'.$_ };
100	if ($@) {
101	throw SuikaWiki::Plugin::error
102	-type => 'PLUGIN_COMPILE_ERROR',
103	file => $dir.'/'.$_,
104	message => $@,
105	method => 'load_directory', -object => $self;
106	}
107	}
108	closedir PDIR;
109	}
110	}
111
112	sub load_file ($@) {
113	my $self = shift;
114	for (@_) {
115	eval { require $_.'.pm' };
116	if ($@) {
117	throw SuikaWiki::Plugin::error
118	-type => 'PLUGIN_COMPILE_ERROR',
119	file => $_.'.pm',
120	message => $@,
121	method => 'load_file', -object => $self;
122	}
123	}
124	}
125
126	=back
127
128	=head1 WIKIPLUGIN MANAGER OBJECT
129
130	This part implements WikiPlugin manager object of SuikaWiki WikiPlugin
131	implementation model, second edition.
132
133	Note that class methods such as C<< ->load_directory >>
134	and C<< ->formatter >> as also available as methods of WikiPlugin object,
135	although result of those operation is still "global".
136
137	WikiPlugin manager object is usually instantiated by C<init_plugins>
138	method of Wiki implementation object (C<SuikaWiki::Implementation> module).
139
140	$wiki = <SuikaWiki::Implementation instance>;
141	$wiki->init_plugins;
142	$plugin_manager = $wiki->{plugin};
143
144	=over 4
145
146	=item $p = SuikaWiki::Plugin->new (wiki => $WIKI)
147
148	Constructs new instance of WikiPlugin manager
149
150	=cut
151
152	sub new ($;%) {
153	my $class = shift;
154	bless {@_}, $class;
155	}
156
157	sub exit ($) {
158	my $self = shift;
159	delete $self->{wiki};
160	$self->{exited} = 1;
161	}
162
163	sub DESTROY ($) {
164	my $self = shift;
165	$self->exit unless $self->{exited};
166	}
167
168	=item $p->{wiki}
169
170	Wiki implementation $p is associated with
171
172	=back
173
174	=cut
175
176	package SuikaWiki::Plugin::xml_formatter;
177	require Message::Util::Formatter::Node;
178	our @ISA = 'Message::Util::Formatter::Node';
179	require Message::Markup::XML::Node;
180
181	sub ___rule_def ($) {
182	$SuikaWiki::Plugin::Rule{$_[0]->{-category_name}} \|\| {};
183	}
184
185	sub replace_option () {+{
186	-class => 'Message::Markup::XML::Node',
187	}}
188
189	package SuikaWiki::Plugin::text_formatter;
190	require Message::Util::Formatter::Text;
191	our @ISA = 'Message::Util::Formatter::Text';
192
193	sub ___rule_def ($) {
194	$SuikaWiki::Plugin::Rule{$_[0]->{-category_name}} \|\| {};
195	}
196
197	package SuikaWiki::Plugin::boolean_formatter;
198	require Message::Util::Formatter::Boolean;
199	our @ISA = 'Message::Util::Formatter::Boolean';
200
201	sub ___rule_def ($) {
202	$SuikaWiki::Plugin::Rule{$_[0]->{-category_name}} \|\| {};
203	}
204
205	package SuikaWiki::Plugin::error;
206	require Message::Util::Error;
207	our @ISA = 'Message::Util::Error';
208
209	=head1 EXCEPTIONS
210
211	=over 4
212
213	=item PLUGIN_COMPILE_ERROR
214
215	Something wrong while loading WikiPlugin module file C<file>,
216	because of C<message>.
217
218	=item PLUGIN_DIRECTORY_CANT_OPEN
219
220	WikiPlugin directory C<file> cannot be opened, because of C<message>.
221
222	=item PLUGIN_NOT_FOUND
223
224	WikiPlugin module C<module> not found.
225
226	=cut
227
228	sub ___error_def () {+{
229	PLUGIN_COMPILE_ERROR => {
230	description => q(%t(name => method);: %t(name => file);: %t(name => message);),
231	},
232	PLUGIN_DIRECTORY_CANT_OPEN => {
233	description => q(%t(name => method);: %t(name => file);: %t(name => message);),
234	},
235	PLUGIN_NOT_FOUND => {
236	description => q(%t(name => method);: WikiPlugin module "%t(name => module);" not loaded),
237	},
238	}}
239
240	=back
241
242	=head1 SEE ALSO
243
244	<IW:SuikaWiki:SuikaWiki:WikiPlugin>
245
246	C<lib/SuikaWiki/Plugin/*>,
247	C<misc/pluging/*>
248
249	=head1 LICENSE
250
251	Copyright 2002-2003 Wakaba <w@suika.fam.cx>
252
253	This program is free software; you can redistribute it and/or
254	modify it under the same terms as Perl itself.
255
256	=cut
257
258	1; # $Date: 2004/06/03 06:38:48 $