server/lib/cf.pm

package cf;

use Symbol;
use List::Util;
use Storable;

use strict;

our %COMMAND;
our @EVENT;
our %PROP_TYPE;
our %PROP_IDX;

BEGIN {
   @EVENT = map lc, @EVENT;

   *CORE::GLOBAL::warn = sub {
      my $msg = join "", @_;
      $msg .= "\n"
         unless $msg =~ /\n$/;

      print STDERR "cfperl: $msg";
      LOG llevError, "cfperl: $msg";
   };
}

my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!

# generate property mutators
sub prop_gen {
   my ($prefix, $class) = @_;

   no strict 'refs';

   for my $prop (keys %PROP_TYPE) {
      $prop =~ /^\Q$prefix\E_(.*$)/ or next;
      my $sub = lc $1;

      my $type = $PROP_TYPE{$prop};
      my $idx  = $PROP_IDX {$prop};

      *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
         $_[0]->get_property ($type, $idx)
      };

      *{"$class\::set_$sub"} = sub {
         $_[0]->set_property ($type, $idx, $_[1]);
      } unless $ignore_set{$prop};
   }
}

# auto-generate most of the API

prop_gen OBJECT_PROP => "cf::object";
# CFAPI_OBJECT_ANIMATION?
prop_gen PLAYER_PROP => "cf::object::player";

prop_gen MAP_PROP    => "cf::map";
prop_gen ARCH_PROP   => "cf::arch";

# guessed hierarchies

@cf::object::player::ISA = 'cf::object';
@cf::object::map::ISA    = 'cf::object';

my %ext_pkg;
my @exts;
my @hook;
my %command;
my %extcmd;

sub inject_event {
   my $extension = shift;
   my $event_code = shift;

   my $cb = $hook[$event_code]{$extension}
      or return;

   &$cb
}

sub inject_global_event {
   my $event = shift;

   my $cb = $hook[$event]
      or return;

   List::Util::max map &$_, values %$cb
}

sub inject_command {
   my ($name, $obj, $params) = @_;

   for my $cmd (@{ $command{$name} }) {
      $cmd->[1]->($obj, $params);
   }

   -1
}

sub register_command {
   my ($name, $time, $cb) = @_;

   my $caller = caller;

   warn "registering command '$name/$time' to '$caller'";

   push @{ $command{$name} }, [$time, $cb, $caller];
   $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
}

sub register {
   my ($base, $pkg) = @_;

   for my $idx (0 .. $#EVENT) {
      if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
         warn "registering $EVENT[$idx] hook to '$pkg'\n";
         $hook[$idx]{$base} = $ref;
      }
   }
}

sub load_extension {
   my ($path) = @_;

   $path =~ /([^\/\\]+)\.ext$/ or die "$path";
   my $base = $1;
   my $pkg = $1;
   $pkg =~ s/[^[:word:]]/_/g;
   $pkg = "cf::ext::$pkg";

   warn "loading '$path' into '$pkg'\n";

   open my $fh, "<:utf8", $path
      or die "$path: $!";

   my $source =
      "package $pkg; use strict; use utf8;\n"
      . "#line 1 \"$path\"\n{\n"
      . (do { local $/; <$fh> })
      . "\n};\n1";

   eval $source
      or die "$path: $@";

   push @exts, $pkg;
   $ext_pkg{$base} = $pkg;

#   no strict 'refs';
#   @{"$pkg\::ISA"} = cf::ext::;

   register $base, $pkg;
}

sub unload_extension {
   my ($pkg) = @_;

   warn "removing extension $pkg\n";

   # remove hooks
   for my $idx (0 .. $#EVENT) {
      delete $hook[$idx]{$pkg};
   }

   # remove commands
   for my $name (keys %command) {
      my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };

      if (@cb) {
         $command{$name} = \@cb;
         $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
      } else {
         delete $command{$name};
         delete $COMMAND{"$name\000"};
      }
   }

   # remove extcmds
   for my $name (keys %command) {
      my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };

      if (@cb) {
         $command{$name} = \@cb;
         $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
      } else {
         delete $command{$name};
         delete $COMMAND{"$name\000"};
      }
   }


   Symbol::delete_package $pkg;
}

sub load_extensions {
   my $LIBDIR = maps_directory "perl";

   for my $ext (<$LIBDIR/*.ext>) {
      next unless -r $ext;
      eval {
         load_extension $ext;
         1
      } or warn "$ext not loaded: $@";
   }
}

register_command "perl-reload", 0, sub {
   my ($who, $arg) = @_;

   if ($who->flag (FLAG_WIZ)) {
      $who->message ("reloading...");

      warn "reloading...\n";
      eval {
         unload_extension $_ for @exts;
         delete $INC{"cf.pm"};

         # don't, removes xs symbols, too
         #Symbol::delete_package $pkg;

         require cf;
      };
      warn $@ if $@;
      $who->message ($@) if $@;
      warn "reloaded\n";

      $who->message ("reloaded");
   } else {
      $who->message ("Intruder Alert!");
   }
};

#############################################################################
# extcmd framework, basically convert ext <id> <pkg> arg1 args
# into pkg::->on_extcmd_arg1 (...) while shortcutting a few

sub on_extcmd {
   my ($pl, $buf) = @_;

   my ($id, $pkg, $name, $data) = split / /, $buf, 4;

   if (my $method = "cf::ext::$pkg"->can ("on_extcmd_$name")) {
      $method->($pl, $id, $buf);
   }
}

#############################################################################
# load/save/clean perl data associated with a map

*on_mapclean = sub {
   my ($map) = @_;

   my $path = $map->tmpname;
   defined $path or return;

   unlink "$path.cfperl";
};

*on_mapin =
*on_mapload = sub {
   my ($map) = @_;

   my $path = $map->tmpname;
   $path = $map->path unless defined $path;

   open my $fh, "<:raw", "$path.cfperl"
      or return; # no perl data

   my $data = Storable::thaw do { local $/; <$fh> };

   $data->{version} <= 1
      or return; # too new

   $map->_set_obs ($data->{obs});
};

*on_mapout = sub {
   my ($map) = @_;

   my $path = $map->tmpname;
   $path = $map->path unless defined $path;

   my $obs = $map->_get_obs;

   if (defined $obs) {
      open my $fh, ">:raw", "$path.cfperl"
         or die "$path.cfperl: $!";

      stat $path;

      print $fh Storable::nfreeze {
         size    => (stat _)[7],
         time    => (stat _)[9],
         version => 1,
         obs     => $obs,
      };

      chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
   } else {
      unlink "$path.cfperl";
   }
};

#############################################################################
# load/save perl data associated with player->ob objects

*on_player_load = sub {
   my ($ob, $path) = @_;

   if (open my $fh, "<:raw", "$path.cfperl") {

      #d##TODO#remove

      my $data = Storable::thaw do { local $/; <$fh> };

      $data->{version} <= 1
         or return; # too new

      %$ob = %{$data->{ob}};
      return;
   }

   for my $o ($ob, $ob->inv) {
      if (my $value = $o->get_ob_key_value ("_perl_data")) {
         $o->set_ob_key_value ("_perl_data");

         %$o = %{ Storable::thaw pack "H*", $value };
      }
   }
};

*on_player_save = sub {
   my ($ob, $path) = @_;

   $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
      for grep %$_, $ob, $ob->inv;

   unlink "$path.cfperl";#d##TODO#remove
};

register "<global>", __PACKAGE__;

load_extensions;

1

Revision:	1.15
Committed:	Sun Jun 11 15:02:16 2006 UTC (17 years, 11 months ago) by root
Branch:	MAIN
Changes since 1.14:	+29 -0 lines
Log Message:	implement 'ext' packet for extensions to hook directly into the protocol
#	User	Rev	Content
1	root	1.1	package cf;
2
3			use Symbol;
4			use List::Util;
5	root	1.6	use Storable;
6	root	1.1
7			use strict;
8
9			our %COMMAND;
10			our @EVENT;
11			our %PROP_TYPE;
12			our %PROP_IDX;
13
14			BEGIN {
15			@EVENT = map lc, @EVENT;
16
17			*CORE::GLOBAL::warn = sub {
18			my $msg = join "", @_;
19			$msg .= "\n"
20			unless $msg =~ /\n$/;
21
22			print STDERR "cfperl: $msg";
23			LOG llevError, "cfperl: $msg";
24			};
25			}
26
27	root	1.9	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!
28
29	root	1.1	# generate property mutators
30			sub prop_gen {
31			my ($prefix, $class) = @_;
32
33			no strict 'refs';
34
35			for my $prop (keys %PROP_TYPE) {
36			$prop =~ /^\Q$prefix\E_(.*$)/ or next;
37			my $sub = lc $1;
38
39			my $type = $PROP_TYPE{$prop};
40			my $idx = $PROP_IDX {$prop};
41
42			{"$class\::get_$sub"} = {"$class\::$sub"} = sub {
43			$_[0]->get_property ($type, $idx)
44			};
45
46			*{"$class\::set_$sub"} = sub {
47			$_[0]->set_property ($type, $idx, $_[1]);
48	root	1.9	} unless $ignore_set{$prop};
49	root	1.1	}
50			}
51
52			# auto-generate most of the API
53
54			prop_gen OBJECT_PROP => "cf::object";
55			# CFAPI_OBJECT_ANIMATION?
56			prop_gen PLAYER_PROP => "cf::object::player";
57
58			prop_gen MAP_PROP => "cf::map";
59			prop_gen ARCH_PROP => "cf::arch";
60
61			# guessed hierarchies
62
63			@cf::object::player::ISA = 'cf::object';
64			@cf::object::map::ISA = 'cf::object';
65
66	root	1.5	my %ext_pkg;
67	root	1.1	my @exts;
68			my @hook;
69			my %command;
70	root	1.15	my %extcmd;
71	root	1.1
72			sub inject_event {
73	root	1.14	my $extension = shift;
74			my $event_code = shift;
75	root	1.1
76	root	1.14	my $cb = $hook[$event_code]{$extension}
77	root	1.5	or return;
78
79	root	1.14	&$cb
80	root	1.5	}
81
82			sub inject_global_event {
83	root	1.12	my $event = shift;
84	root	1.5
85	root	1.12	my $cb = $hook[$event]
86	root	1.1	or return;
87
88	root	1.12	List::Util::max map &$_, values %$cb
89	root	1.1	}
90
91			sub inject_command {
92			my ($name, $obj, $params) = @_;
93
94			for my $cmd (@{ $command{$name} }) {
95			$cmd->[1]->($obj, $params);
96			}
97
98			-1
99			}
100
101			sub register_command {
102			my ($name, $time, $cb) = @_;
103
104			my $caller = caller;
105
106	root	1.4	warn "registering command '$name/$time' to '$caller'";
107
108	root	1.1	push @{ $command{$name} }, [$time, $cb, $caller];
109			$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
110			}
111
112	root	1.6	sub register {
113			my ($base, $pkg) = @_;
114
115			for my $idx (0 .. $#EVENT) {
116			if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
117			warn "registering $EVENT[$idx] hook to '$pkg'\n";
118			$hook[$idx]{$base} = $ref;
119			}
120			}
121			}
122
123	root	1.1	sub load_extension {
124			my ($path) = @_;
125
126			$path =~ /([^\/\\]+)\.ext$/ or die "$path";
127	root	1.5	my $base = $1;
128	root	1.1	my $pkg = $1;
129			$pkg =~ s/[^[:word:]]/_/g;
130			$pkg = "cf::ext::$pkg";
131
132			warn "loading '$path' into '$pkg'\n";
133
134			open my $fh, "<:utf8", $path
135			or die "$path: $!";
136
137			my $source =
138			"package $pkg; use strict; use utf8;\n"
139			. "#line 1 \"$path\"\n{\n"
140			. (do { local $/; <$fh> })
141			. "\n};\n1";
142
143			eval $source
144			or die "$path: $@";
145
146			push @exts, $pkg;
147	root	1.5	$ext_pkg{$base} = $pkg;
148	root	1.1
149	root	1.6	# no strict 'refs';
150	root	1.1	# @{"$pkg\::ISA"} = cf::ext::;
151
152	root	1.6	register $base, $pkg;
153	root	1.1	}
154
155			sub unload_extension {
156			my ($pkg) = @_;
157
158			warn "removing extension $pkg\n";
159
160			# remove hooks
161			for my $idx (0 .. $#EVENT) {
162			delete $hook[$idx]{$pkg};
163			}
164
165			# remove commands
166			for my $name (keys %command) {
167			my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
168
169			if (@cb) {
170			$command{$name} = \@cb;
171			$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
172			} else {
173			delete $command{$name};
174			delete $COMMAND{"$name\000"};
175			}
176			}
177
178	root	1.15	# remove extcmds
179			for my $name (keys %command) {
180			my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
181
182			if (@cb) {
183			$command{$name} = \@cb;
184			$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
185			} else {
186			delete $command{$name};
187			delete $COMMAND{"$name\000"};
188			}
189			}
190
191
192	root	1.1	Symbol::delete_package $pkg;
193			}
194
195			sub load_extensions {
196			my $LIBDIR = maps_directory "perl";
197
198			for my $ext (<$LIBDIR/*.ext>) {
199	root	1.3	next unless -r $ext;
200	root	1.2	eval {
201			load_extension $ext;
202			1
203			} or warn "$ext not loaded: $@";
204	root	1.1	}
205			}
206
207			register_command "perl-reload", 0, sub {
208			my ($who, $arg) = @_;
209
210			if ($who->flag (FLAG_WIZ)) {
211	root	1.3	$who->message ("reloading...");
212
213	root	1.1	warn "reloading...\n";
214	root	1.4	eval {
215			unload_extension $_ for @exts;
216			delete $INC{"cf.pm"};
217
218			# don't, removes xs symbols, too
219			#Symbol::delete_package $pkg;
220
221			require cf;
222			};
223			warn $@ if $@;
224			$who->message ($@) if $@;
225	root	1.1	warn "reloaded\n";
226	root	1.3
227			$who->message ("reloaded");
228			} else {
229			$who->message ("Intruder Alert!");
230	root	1.1	}
231			};
232
233	root	1.8	#############################################################################
234	root	1.15	# extcmd framework, basically convert ext <id> <pkg> arg1 args
235			# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
236
237			sub on_extcmd {
238			my ($pl, $buf) = @_;
239
240			my ($id, $pkg, $name, $data) = split / /, $buf, 4;
241
242			if (my $method = "cf::ext::$pkg"->can ("on_extcmd_$name")) {
243			$method->($pl, $id, $buf);
244			}
245			}
246
247			#############################################################################
248	root	1.8	# load/save/clean perl data associated with a map
249
250	root	1.7	*on_mapclean = sub {
251	root	1.13	my ($map) = @_;
252	root	1.7
253			my $path = $map->tmpname;
254			defined $path or return;
255
256			unlink "$path.cfperl";
257			};
258
259	root	1.6	*on_mapin =
260			*on_mapload = sub {
261	root	1.13	my ($map) = @_;
262	root	1.6
263			my $path = $map->tmpname;
264			$path = $map->path unless defined $path;
265
266			open my $fh, "<:raw", "$path.cfperl"
267			or return; # no perl data
268
269			my $data = Storable::thaw do { local $/; <$fh> };
270
271			$data->{version} <= 1
272			or return; # too new
273
274			$map->_set_obs ($data->{obs});
275			};
276
277			*on_mapout = sub {
278	root	1.13	my ($map) = @_;
279	root	1.6
280			my $path = $map->tmpname;
281			$path = $map->path unless defined $path;
282
283			my $obs = $map->_get_obs;
284
285			if (defined $obs) {
286			open my $fh, ">:raw", "$path.cfperl"
287			or die "$path.cfperl: $!";
288
289	root	1.8	stat $path;
290
291			print $fh Storable::nfreeze {
292			size => (stat _)[7],
293			time => (stat _)[9],
294			version => 1,
295			obs => $obs,
296			};
297
298			chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible g
299			} else {
300			unlink "$path.cfperl";
301			}
302			};
303
304			#############################################################################
305			# load/save perl data associated with player->ob objects
306
307			*on_player_load = sub {
308	root	1.13	my ($ob, $path) = @_;
309	root	1.8
310	root	1.11	if (open my $fh, "<:raw", "$path.cfperl") {
311	root	1.8
312	root	1.11	#d##TODO#remove
313	root	1.8
314	root	1.11	my $data = Storable::thaw do { local $/; <$fh> };
315	root	1.8
316	root	1.11	$data->{version} <= 1
317			or return; # too new
318
319			%$ob = %{$data->{ob}};
320			return;
321			}
322
323			for my $o ($ob, $ob->inv) {
324			if (my $value = $o->get_ob_key_value ("_perl_data")) {
325			$o->set_ob_key_value ("_perl_data");
326
327			%$o = %{ Storable::thaw pack "H*", $value };
328			}
329			}
330	root	1.8	};
331
332			*on_player_save = sub {
333	root	1.13	my ($ob, $path) = @_;
334	root	1.8
335	root	1.11	$_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
336			for grep %$_, $ob, $ob->inv;
337
338			unlink "$path.cfperl";#d##TODO#remove
339	root	1.6	};
340
341			register "<global>", __PACKAGE__;
342
343	root	1.1	load_extensions;
344
345			1
346