ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.70 by root, Sun Oct 1 10:55:37 2006 UTC vs.
Revision 1.105 by root, Sun Dec 31 17:17:23 2006 UTC

1	package cf;	1	package cf;
		2
		3	use utf8;
		4	use strict;
2		5
3	use Symbol;	6	use Symbol;
4	use List::Util;	7	use List::Util;
5	use Storable;	8	use Storable;
6	use Opcode;	9	use Opcode;
7	use Safe;	10	use Safe;
8	use Safe::Hole;	11	use Safe::Hole;
9		12
		13	use Coro 3.3;
		14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18	use Coro::AIO;
		19
		20	use Fcntl;
		21	use IO::AIO 2.31 ();
		22	use YAML::Syck ();
10	use Time::HiRes;	23	use Time::HiRes;
11	use Event;	24
12	$Event::Eval = 1; # no idea why this is required, but it is	25	use Event; $Event::Eval = 1; # no idea why this is required, but it is
13		26
14	use strict;	27	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
		28	$YAML::Syck::ImplicitUnicode = 1;
15		29
16	_init_vars;	30	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
17		31
		32	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		33
18	our %COMMAND = ();	34	our %COMMAND = ();
		35	our %COMMAND_TIME = ();
		36	our %EXTCMD = ();
		37
19	our @EVENT;	38	our @EVENT;
20	our $LIBDIR = maps_directory "perl";	39	our $LIBDIR = datadir . "/ext";
21		40
22	our $TICK = MAX_TIME * 1e-6;	41	our $TICK = MAX_TIME * 1e-6;
23	our $TICK_WATCHER;	42	our $TICK_WATCHER;
24	our $NEXT_TICK;	43	our $NEXT_TICK;
		44	our $NOW;
25		45
26	our %CFG;	46	our %CFG;
27		47
		48	our $UPTIME; $UPTIME ||= time;
		49	our $RUNTIME;
		50
		51	our %MAP; # all maps
		52	our $LINK_MAP; # the special {link} map
		53	our $FREEZE;
		54
		55	binmode STDOUT;
		56	binmode STDERR;
		57
		58	# read virtual server time, if available
		59	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		60	open my $fh, "<", cf::localdir . "/runtime"
		61	or die "unable to read runtime file: $!";
		62	$RUNTIME = <$fh> + 0.;
		63	}
		64
		65	mkdir cf::localdir;
		66	mkdir cf::localdir . "/" . cf::playerdir;
		67	mkdir cf::localdir . "/" . cf::tmpdir;
		68	mkdir cf::localdir . "/" . cf::uniquedir;
		69
		70	our %EXT_CORO;
		71
28	#############################################################################	72	#############################################################################
29		73
30	=head2 GLOBAL VARIABLES	74	=head2 GLOBAL VARIABLES
31		75
32	=over 4	76	=over 4
		77
		78	=item $cf::UPTIME
		79
		80	The timestamp of the server start (so not actually an uptime).
		81
		82	=item $cf::RUNTIME
		83
		84	The time this server has run, starts at 0 and is increased by $cf::TICK on
		85	every server tick.
33		86
34	=item $cf::LIBDIR	87	=item $cf::LIBDIR
35		88
36	The perl library directory, where extensions and cf-specific modules can	89	The perl library directory, where extensions and cf-specific modules can
37	be found. It will be added to C<@INC> automatically.	90	be found. It will be added to C<@INC> automatically.
		91
		92	=item $cf::NOW
		93
		94	The time of the last (current) server tick.
38		95
39	=item $cf::TICK	96	=item $cf::TICK
40		97
41	The interval between server ticks, in seconds.	98	The interval between server ticks, in seconds.
42		99
…		…
50	=cut	107	=cut
51		108
52	BEGIN {	109	BEGIN {
53	*CORE::GLOBAL::warn = sub {	110	*CORE::GLOBAL::warn = sub {
54	my $msg = join "", @_;	111	my $msg = join "", @_;
		112	utf8::encode $msg;
		113
55	$msg .= "\n"	114	$msg .= "\n"
56	unless $msg =~ /\n$/;	115	unless $msg =~ /\n$/;
57		116
58	print STDERR "cfperl: $msg";
59	LOG llevError, "cfperl: $msg";	117	LOG llevError, "cfperl: $msg";
60	};	118	};
61	}	119	}
62		120
		121	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		122	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		123	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		124	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		125	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
63	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	126	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
64		127
65	# we bless all objects into (empty) derived classes to force a method lookup	128	# we bless all objects into (empty) derived classes to force a method lookup
66	# within the Safe compartment.	129	# within the Safe compartment.
67	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	130	for my $pkg (qw(
		131	cf::global cf::attachable
		132	cf::object cf::object::player
		133	cf::client cf::player
		134	cf::arch cf::living
		135	cf::map cf::party cf::region
		136	)) {
68	no strict 'refs';	137	no strict 'refs';
69	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	138	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
70	}	139	}
71		140
72	$Event::DIED = sub {	141	$Event::DIED = sub {
…		…
74	};	143	};
75		144
76	my %ext_pkg;	145	my %ext_pkg;
77	my @exts;	146	my @exts;
78	my @hook;	147	my @hook;
79	my %command;
80	my %extcmd;
81		148
82	=head2 UTILITY FUNCTIONS	149	=head2 UTILITY FUNCTIONS
83		150
84	=over 4	151	=over 4
85		152
…		…
107	sub to_json($) {	174	sub to_json($) {
108	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	175	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
109	JSON::Syck::Dump $_[0]	176	JSON::Syck::Dump $_[0]
110	}	177	}
111		178
		179	# main coro must never ever "block" except in Event
		180	# sync_job ensures this by running the job in a coroutine
		181	# and waiting in Event while the server is otherwise frozen
		182	sub sync_job(&) {
		183	my ($job) = @_;
		184
		185	my $busy = 1;
		186	my @res;
		187
		188	local $FREEZE = 1;
		189
		190	my $coro = Coro::async {
		191	@res = eval { $job->() };
		192	warn $@ if $@;
		193	undef $busy;
		194	};
		195
		196	if ($Coro::current == $Coro::main) {
		197	$coro->prio (Coro::PRIO_MAX);
		198	while ($busy) {
		199	Coro::cede_notself;
		200	Event::one_event unless Coro::nready;
		201	}
		202	} else {
		203	$coro->join;
		204	}
		205
		206	wantarray ? @res : $res[0]
		207	}
		208
		209	=item $coro = cf::coro { BLOCK }
		210
		211	Creates and returns a new coro. This coro is automcatially being canceled
		212	when the extension calling this is being unloaded.
		213
		214	=cut
		215
		216	sub coro(&) {
		217	my $cb = shift;
		218
		219	my $coro; $coro = async {
		220	eval {
		221	$cb->();
		222	};
		223	warn $@ if $@;
		224	};
		225
		226	$coro->on_destroy (sub {
		227	delete $EXT_CORO{$coro+0};
		228	});
		229	$EXT_CORO{$coro+0} = $coro;
		230
		231	$coro
		232	}
		233
112	=back	234	=back
113		235
		236	=cut
		237
114	#############################################################################	238	#############################################################################
115		239
116	=head2 EVENTS AND OBJECT ATTACHMENTS	240	=head2 ATTACHABLE OBJECTS
		241
		242	Many objects in crossfire are so-called attachable objects. That means you can
		243	attach callbacks/event handlers (a collection of which is called an "attachment")
		244	to it. All such attachable objects support the following methods.
		245
		246	In the following description, CLASS can be any of C<global>, C<object>
		247	C<player>, C<client> or C<map> (i.e. the attachable objects in
		248	crossfire+).
117		249
118	=over 4	250	=over 4
119		251
120	=item $object->attach ($attachment, key => $value...)
121
122	=item $object->detach ($attachment)
123
124	Attach/detach a pre-registered attachment to an object.
125
126	=item $player->attach ($attachment, key => $value...)
127
128	=item $player->detach ($attachment)
129
130	Attach/detach a pre-registered attachment to a player.
131
132	=item $map->attach ($attachment, key => $value...)	252	=item $attachable->attach ($attachment, key => $value...)
133		253
134	=item $map->detach ($attachment)	254	=item $attachable->detach ($attachment)
135		255
136	Attach/detach a pre-registered attachment to a map.	256	Attach/detach a pre-registered attachment to a specific object and give it
		257	the specified key/value pairs as arguments.
137		258
138	=item $bool = $object->attached ($name)	259	Example, attach a minesweeper attachment to the given object, making it a
		260	10x10 minesweeper game:
139		261
140	=item $bool = $player->attached ($name)	262	$obj->attach (minesweeper => width => 10, height => 10);
141		263
142	=item $bool = $map->attached ($name)	264	=item $bool = $attachable->attached ($name)
143		265
144	Checks wether the named attachment is currently attached to the object.	266	Checks wether the named attachment is currently attached to the object.
145		267
146	=item cf::attach_global ...	268	=item cf::CLASS->attach ...
147		269
148	Attach handlers for global events.	270	=item cf::CLASS->detach ...
149		271
150	This and all following C<attach_*>-functions expect any number of the	272	Define an anonymous attachment and attach it to all objects of the given
151	following handler/hook descriptions:	273	CLASS. See the next function for an explanation of its arguments.
		274
		275	You can attach to global events by using the C<cf::global> class.
		276
		277	Example, log all player logins:
		278
		279	cf::player->attach (
		280	on_login => sub {
		281	my ($pl) = @_;
		282	...
		283	},
		284	);
		285
		286	Example, attach to the jeweler skill:
		287
		288	cf::object->attach (
		289	type => cf::SKILL,
		290	subtype => cf::SK_JEWELER,
		291	on_use_skill => sub {
		292	my ($sk, $ob, $part, $dir, $msg) = @_;
		293	...
		294	},
		295	);
		296
		297	=item cf::CLASS::attachment $name, ...
		298
		299	Register an attachment by C<$name> through which attachable objects of the
		300	given CLASS can refer to this attachment.
		301
		302	Some classes such as crossfire maps and objects can specify attachments
		303	that are attached at load/instantiate time, thus the need for a name.
		304
		305	These calls expect any number of the following handler/hook descriptions:
152		306
153	=over 4	307	=over 4
154		308
155	=item prio => $number	309	=item prio => $number
156		310
…		…
158	by another C<prio> setting). Lower priority handlers get executed	312	by another C<prio> setting). Lower priority handlers get executed
159	earlier. The default priority is C<0>, and many built-in handlers are	313	earlier. The default priority is C<0>, and many built-in handlers are
160	registered at priority C<-1000>, so lower priorities should not be used	314	registered at priority C<-1000>, so lower priorities should not be used
161	unless you know what you are doing.	315	unless you know what you are doing.
162		316
		317	=item type => $type
		318
		319	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		320	given type of objects only (the additional parameter C<subtype> can be
		321	used to further limit to the given subtype).
		322
163	=item on_I<event> => \&cb	323	=item on_I<event> => \&cb
164		324
165	Call the given code reference whenever the named event happens (event is	325	Call the given code reference whenever the named event happens (event is
166	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	326	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
167	handlers are recognised generally depends on the type of object these	327	handlers are recognised generally depends on the type of object these
…		…
176	package and register them. Only handlers for eevents supported by the	336	package and register them. Only handlers for eevents supported by the
177	object/class are recognised.	337	object/class are recognised.
178		338
179	=back	339	=back
180		340
181	=item cf::attach_to_type $object_type, $subtype, ...	341	Example, define an attachment called "sockpuppet" that calls the given
		342	event handler when a monster attacks:
182		343
183	Attach handlers for a specific object type (e.g. TRANSPORT) and	344	cf::object::attachment sockpuppet =>
184	subtype. If C<$subtype> is zero or undef, matches all objects of the given	345	on_skill_attack => sub {
185	type.	346	my ($self, $victim) = @_;
186		347	...
187	=item cf::attach_to_objects ...
188
189	Attach handlers to all objects. Do not use this except for debugging or
190	very rare events, as handlers are (obviously) called for I<all> objects in
191	the game.
192
193	=item cf::attach_to_players ...
194
195	Attach handlers to all players.
196
197	=item cf::attach_to_maps ...
198
199	Attach handlers to all maps.
200
201	=item cf:register_attachment $name, ...
202
203	Register an attachment by name through which objects can refer to this
204	attachment.
205
206	=item cf:register_player_attachment $name, ...
207
208	Register an attachment by name through which players can refer to this
209	attachment.
210
211	=item cf:register_map_attachment $name, ...
212
213	Register an attachment by name through which maps can refer to this
214	attachment.
215
216	=cut
217
218	# the following variables are defined in .xs and must not be re-created
219	our @CB_GLOBAL = (); # registry for all global events
220	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
221	our @CB_PLAYER = ();
222	our @CB_TYPE = (); # registry for type (cf-object class) based events
223	our @CB_MAP = ();
224
225	my %attachment;
226
227	sub _attach_cb($\%$$$) {
228	my ($registry, $undo, $event, $prio, $cb) = @_;
229
230	use sort 'stable';
231
232	$cb = [$prio, $cb];
233
234	@{$registry->[$event]} = sort
235	{ $a->[0] cmp $b->[0] }
236	@{$registry->[$event] || []}, $cb;
237
238	push @{$undo->{cb}}, [$event, $cb];
239	}
240
241	# attach handles attaching event callbacks
242	# the only thing the caller has to do is pass the correct
243	# registry (== where the callback attaches to).
244	sub _attach(\@$@) {
245	my ($registry, $klass, @arg) = @_;
246
247	my $prio = 0;
248
249	my %undo = (
250	registry => $registry,
251	cb => [],
252	);
253
254	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
255
256	while (@arg) {
257	my $type = shift @arg;
258
259	if ($type eq "prio") {
260	$prio = shift @arg;
261
262	} elsif ($type eq "package") {
263	my $pkg = shift @arg;
264
265	while (my ($name, $id) = each %cb_id) {
266	if (my $cb = $pkg->can ($name)) {
267	_attach_cb $registry, %undo, $id, $prio, $cb;
268	}
269	}	348	}
270
271	} elsif (exists $cb_id{$type}) {
272	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
273
274	} elsif (ref $type) {
275	warn "attaching objects not supported, ignoring.\n";
276
277	} else {
278	shift @arg;
279	warn "attach argument '$type' not supported, ignoring.\n";
280	}
281	}
282
283	\%undo
284	}
285
286	sub _attach_attachment {
287	my ($obj, $name, %arg) = @_;
288
289	return if exists $obj->{_attachment}{$name};
290
291	my $res;
292
293	if (my $attach = $attachment{$name}) {
294	my $registry = $obj->registry;
295
296	for (@$attach) {
297	my ($klass, @attach) = @$_;
298	$res = _attach @$registry, $klass, @attach;
299	}
300
301	$obj->{$name} = \%arg;
302	} else {
303	warn "object uses attachment '$name' that is not available, postponing.\n";
304	}
305
306	$obj->{_attachment}{$name} = undef;
307
308	$res->{attachment} = $name;
309	$res
310	}
311
312	*cf::object::attach =
313	*cf::player::attach =
314	*cf::map::attach = sub {
315	my ($obj, $name, %arg) = @_;
316
317	_attach_attachment $obj, $name, %arg;
318	};
319
320	# all those should be optimised
321	*cf::object::detach =
322	*cf::player::detach =
323	*cf::map::detach = sub {
324	my ($obj, $name) = @_;
325
326	delete $obj->{_attachment}{$name};
327	reattach ($obj);
328	};
329
330	*cf::object::attached =
331	*cf::player::attached =
332	*cf::map::attached = sub {
333	my ($obj, $name) = @_;
334
335	exists $obj->{_attachment}{$name}
336	};
337
338	sub attach_global {
339	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
340	}
341
342	sub attach_to_type {
343	my $type = shift;
344	my $subtype = shift;
345
346	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
347	}
348
349	sub attach_to_objects {
350	_attach @CB_OBJECT, KLASS_OBJECT, @_
351	}
352
353	sub attach_to_players {
354	_attach @CB_PLAYER, KLASS_PLAYER, @_
355	}
356
357	sub attach_to_maps {
358	_attach @CB_MAP, KLASS_MAP, @_
359	}
360
361	sub register_attachment {
362	my $name = shift;
363
364	$attachment{$name} = [[KLASS_OBJECT, @_]];
365	}
366
367	sub register_player_attachment {
368	my $name = shift;
369
370	$attachment{$name} = [[KLASS_PLAYER, @_]];
371	}
372
373	sub register_map_attachment {
374	my $name = shift;
375
376	$attachment{$name} = [[KLASS_MAP, @_]];
377	}
378
379	our $override;
380	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
381
382	sub override {
383	$override = 1;
384	@invoke_results = ();
385	}
386
387	sub do_invoke {
388	my $event = shift;
389	my $callbacks = shift;
390
391	@invoke_results = ();
392
393	local $override;
394
395	for (@$callbacks) {
396	eval { &{$_->[1]} };
397
398	if ($@) {
399	warn "$@";
400	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
401	override;
402	}
403
404	return 1 if $override;
405	}
406
407	0	349	}
408	}
409		350
410	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	351	=item $attachable->valid
411
412	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
413
414	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
415
416	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
417
418	Generate a global/object/player/map-specific event with the given arguments.
419
420	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
421	removed in future versions), and there is no public API to access override
422	results (if you must, access C<@cf::invoke_results> directly).
423
424	=back
425
426	#############################################################################
427
428	=head2 METHODS VALID FOR ALL CORE OBJECTS
429
430	=over 4
431
432	=item $object->valid, $player->valid, $map->valid
433		352
434	Just because you have a perl object does not mean that the corresponding	353	Just because you have a perl object does not mean that the corresponding
435	C-level object still exists. If you try to access an object that has no	354	C-level object still exists. If you try to access an object that has no
436	valid C counterpart anymore you get an exception at runtime. This method	355	valid C counterpart anymore you get an exception at runtime. This method
437	can be used to test for existence of the C object part without causing an	356	can be used to test for existence of the C object part without causing an
438	exception.	357	exception.
439		358
		359	=cut
		360
		361	# the following variables are defined in .xs and must not be re-created
		362	our @CB_GLOBAL = (); # registry for all global events
		363	our @CB_ATTACHABLE = (); # registry for all attachables
		364	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		365	our @CB_PLAYER = ();
		366	our @CB_CLIENT = ();
		367	our @CB_TYPE = (); # registry for type (cf-object class) based events
		368	our @CB_MAP = ();
		369
		370	my %attachment;
		371
		372	sub _attach_cb($$$$) {
		373	my ($registry, $event, $prio, $cb) = @_;
		374
		375	use sort 'stable';
		376
		377	$cb = [$prio, $cb];
		378
		379	@{$registry->[$event]} = sort
		380	{ $a->[0] cmp $b->[0] }
		381	@{$registry->[$event] || []}, $cb;
		382	}
		383
		384	# hack
		385	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		386
		387	# attach handles attaching event callbacks
		388	# the only thing the caller has to do is pass the correct
		389	# registry (== where the callback attaches to).
		390	sub _attach {
		391	my ($registry, $klass, @arg) = @_;
		392
		393	my $object_type;
		394	my $prio = 0;
		395	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		396
		397	#TODO: get rid of this hack
		398	if ($attachable_klass{$klass}) {
		399	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		400	}
		401
		402	while (@arg) {
		403	my $type = shift @arg;
		404
		405	if ($type eq "prio") {
		406	$prio = shift @arg;
		407
		408	} elsif ($type eq "type") {
		409	$object_type = shift @arg;
		410	$registry = $CB_TYPE[$object_type] ||= [];
		411
		412	} elsif ($type eq "subtype") {
		413	defined $object_type or Carp::croak "subtype specified without type";
		414	my $object_subtype = shift @arg;
		415	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		416
		417	} elsif ($type eq "package") {
		418	my $pkg = shift @arg;
		419
		420	while (my ($name, $id) = each %cb_id) {
		421	if (my $cb = $pkg->can ($name)) {
		422	_attach_cb $registry, $id, $prio, $cb;
		423	}
		424	}
		425
		426	} elsif (exists $cb_id{$type}) {
		427	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		428
		429	} elsif (ref $type) {
		430	warn "attaching objects not supported, ignoring.\n";
		431
		432	} else {
		433	shift @arg;
		434	warn "attach argument '$type' not supported, ignoring.\n";
		435	}
		436	}
		437	}
		438
		439	sub _object_attach {
		440	my ($obj, $name, %arg) = @_;
		441
		442	return if exists $obj->{_attachment}{$name};
		443
		444	if (my $attach = $attachment{$name}) {
		445	my $registry = $obj->registry;
		446
		447	for (@$attach) {
		448	my ($klass, @attach) = @$_;
		449	_attach $registry, $klass, @attach;
		450	}
		451
		452	$obj->{$name} = \%arg;
		453	} else {
		454	warn "object uses attachment '$name' that is not available, postponing.\n";
		455	}
		456
		457	$obj->{_attachment}{$name} = undef;
		458	}
		459
		460	sub cf::attachable::attach {
		461	if (ref $_[0]) {
		462	_object_attach @_;
		463	} else {
		464	_attach shift->_attach_registry, @_;
		465	}
		466	};
		467
		468	# all those should be optimised
		469	sub cf::attachable::detach {
		470	my ($obj, $name) = @_;
		471
		472	if (ref $obj) {
		473	delete $obj->{_attachment}{$name};
		474	reattach ($obj);
		475	} else {
		476	Carp::croak "cannot, currently, detach class attachments";
		477	}
		478	};
		479
		480	sub cf::attachable::attached {
		481	my ($obj, $name) = @_;
		482
		483	exists $obj->{_attachment}{$name}
		484	}
		485
		486	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		487	eval "#line " . __LINE__ . " 'cf.pm'
		488	sub cf::\L$klass\E::_attach_registry {
		489	(\\\@CB_$klass, KLASS_$klass)
		490	}
		491
		492	sub cf::\L$klass\E::attachment {
		493	my \$name = shift;
		494
		495	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		496	}
		497	";
		498	die if $@;
		499	}
		500
		501	our $override;
		502	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		503
		504	sub override {
		505	$override = 1;
		506	@invoke_results = ();
		507	}
		508
		509	sub do_invoke {
		510	my $event = shift;
		511	my $callbacks = shift;
		512
		513	@invoke_results = ();
		514
		515	local $override;
		516
		517	for (@$callbacks) {
		518	eval { &{$_->[1]} };
		519
		520	if ($@) {
		521	warn "$@";
		522	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		523	override;
		524	}
		525
		526	return 1 if $override;
		527	}
		528
		529	0
		530	}
		531
		532	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		533
		534	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		535
		536	Generate an object-specific event with the given arguments.
		537
		538	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		539	removed in future versions), and there is no public API to access override
		540	results (if you must, access C<@cf::invoke_results> directly).
		541
440	=back	542	=back
441		543
442	=cut	544	=cut
443
444	*cf::object::valid =
445	*cf::player::valid =
446	*cf::map::valid = \&cf::_valid;
447		545
448	#############################################################################	546	#############################################################################
449	# object support	547	# object support
450		548
451	sub instantiate {
452	my ($obj, $data) = @_;
453
454	$data = from_json $data;
455
456	for (@$data) {
457	my ($name, $args) = @$_;
458
459	$obj->attach ($name, %{$args || {} });
460	}
461	}
462
463	# basically do the same as instantiate, without calling instantiate
464	sub reattach {	549	sub reattach {
		550	# basically do the same as instantiate, without calling instantiate
465	my ($obj) = @_;	551	my ($obj) = @_;
		552
466	my $registry = $obj->registry;	553	my $registry = $obj->registry;
467		554
468	@$registry = ();	555	@$registry = ();
469		556
470	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	557	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
471		558
472	for my $name (keys %{ $obj->{_attachment} || {} }) {	559	for my $name (keys %{ $obj->{_attachment} || {} }) {
473	if (my $attach = $attachment{$name}) {	560	if (my $attach = $attachment{$name}) {
474	for (@$attach) {	561	for (@$attach) {
475	my ($klass, @attach) = @$_;	562	my ($klass, @attach) = @$_;
476	_attach @$registry, $klass, @attach;	563	_attach $registry, $klass, @attach;
477	}	564	}
478	} else {	565	} else {
479	warn "object uses attachment '$name' that is not available, postponing.\n";	566	warn "object uses attachment '$name' that is not available, postponing.\n";
480	}	567	}
481	}	568	}
482	}	569	}
483		570
484	sub object_freezer_save {	571	cf::attachable->attach (
485	my ($filename, $rdata, $objs) = @_;
486
487	if (length $$rdata) {
488	warn sprintf "saving %s (%d,%d)\n",
489	$filename, length $$rdata, scalar @$objs;
490
491	if (open my $fh, ">:raw", "$filename~") {
492	chmod SAVE_MODE, $fh;
493	syswrite $fh, $$rdata;
494	close $fh;
495
496	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
497	chmod SAVE_MODE, $fh;
498	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
499	close $fh;
500	rename "$filename.pst~", "$filename.pst";
501	} else {
502	unlink "$filename.pst";
503	}
504
505	rename "$filename~", $filename;
506	} else {
507	warn "FATAL: $filename~: $!\n";
508	}
509	} else {
510	unlink $filename;
511	unlink "$filename.pst";
512	}
513	}
514
515	sub object_thawer_load {
516	my ($filename) = @_;
517
518	local $/;
519
520	my $av;
521
522	#TODO: use sysread etc.
523	if (open my $data, "<:raw:perlio", $filename) {
524	$data = <$data>;
525	if (open my $pst, "<:raw:perlio", "$filename.pst") {
526	$av = eval { (Storable::thaw <$pst>)->{objs} };
527	}
528	return ($data, $av);
529	}
530
531	()
532	}
533
534	attach_to_objects
535	prio => -1000000,	572	prio => -1000000,
		573	on_instantiate => sub {
		574	my ($obj, $data) = @_;
		575
		576	$data = from_json $data;
		577
		578	for (@$data) {
		579	my ($name, $args) = @$_;
		580
		581	$obj->attach ($name, %{$args || {} });
		582	}
		583	},
		584	on_reattach => \&reattach,
536	on_clone => sub {	585	on_clone => sub {
537	my ($src, $dst) = @_;	586	my ($src, $dst) = @_;
538		587
539	@{$dst->registry} = @{$src->registry};	588	@{$dst->registry} = @{$src->registry};
540		589
541	%$dst = %$src;	590	%$dst = %$src;
542		591
543	%{$dst->{_attachment}} = %{$src->{_attachment}}	592	%{$dst->{_attachment}} = %{$src->{_attachment}}
544	if exists $src->{_attachment};	593	if exists $src->{_attachment};
545	},	594	},
546	;	595	);
		596
		597	sub object_freezer_save {
		598	my ($filename, $rdata, $objs) = @_;
		599
		600	sync_job {
		601	if (length $$rdata) {
		602	warn sprintf "saving %s (%d,%d)\n",
		603	$filename, length $$rdata, scalar @$objs;
		604
		605	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		606	chmod SAVE_MODE, $fh;
		607	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		608	aio_fsync $fh;
		609	close $fh;
		610
		611	if (@$objs) {
		612	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		613	chmod SAVE_MODE, $fh;
		614	my $data = Storable::nfreeze { version => 1, objs => $objs };
		615	aio_write $fh, 0, (length $data), $data, 0;
		616	aio_fsync $fh;
		617	close $fh;
		618	aio_rename "$filename.pst~", "$filename.pst";
		619	}
		620	} else {
		621	aio_unlink "$filename.pst";
		622	}
		623
		624	aio_rename "$filename~", $filename;
		625	} else {
		626	warn "FATAL: $filename~: $!\n";
		627	}
		628	} else {
		629	aio_unlink $filename;
		630	aio_unlink "$filename.pst";
		631	}
		632	}
		633	}
		634
		635	sub object_freezer_as_string {
		636	my ($rdata, $objs) = @_;
		637
		638	use Data::Dumper;
		639
		640	$$rdata . Dumper $objs
		641	}
		642
		643	sub object_thawer_load {
		644	my ($filename) = @_;
		645
		646	my ($data, $av);
		647
		648	(aio_load $filename, $data) >= 0
		649	or return;
		650
		651	unless (aio_stat "$filename.pst") {
		652	(aio_load "$filename.pst", $av) >= 0
		653	or return;
		654	$av = eval { (Storable::thaw <$av>)->{objs} };
		655	}
		656
		657	return ($data, $av);
		658	}
547		659
548	#############################################################################	660	#############################################################################
549	# old plug-in events	661	# command handling &c
550		662
551	sub inject_event {	663	=item cf::register_command $name => \&callback($ob,$args);
552	my $extension = shift;
553	my $event_code = shift;
554		664
555	my $cb = $hook[$event_code]{$extension}	665	Register a callback for execution when the client sends the user command
556	or return;	666	$name.
557		667
558	&$cb	668	=cut
559	}
560
561	sub inject_global_event {
562	my $event = shift;
563
564	my $cb = $hook[$event]
565	or return;
566
567	List::Util::max map &$_, values %$cb
568	}
569
570	sub inject_command {
571	my ($name, $obj, $params) = @_;
572
573	for my $cmd (@{ $command{$name} }) {
574	$cmd->[1]->($obj, $params);
575	}
576
577	-1
578	}
579		669
580	sub register_command {	670	sub register_command {
581	my ($name, $time, $cb) = @_;	671	my ($name, $cb) = @_;
582		672
583	my $caller = caller;	673	my $caller = caller;
584	#warn "registering command '$name/$time' to '$caller'";	674	#warn "registering command '$name/$time' to '$caller'";
585		675
586	push @{ $command{$name} }, [$time, $cb, $caller];	676	push @{ $COMMAND{$name} }, [$caller, $cb];
587	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
588	}	677	}
		678
		679	=item cf::register_extcmd $name => \&callback($pl,$packet);
		680
		681	Register a callbackf ro execution when the client sends an extcmd packet.
		682
		683	If the callback returns something, it is sent back as if reply was being
		684	called.
		685
		686	=cut
589		687
590	sub register_extcmd {	688	sub register_extcmd {
591	my ($name, $cb) = @_;	689	my ($name, $cb) = @_;
592		690
593	my $caller = caller;	691	my $caller = caller;
594	#warn "registering extcmd '$name' to '$caller'";	692	#warn "registering extcmd '$name' to '$caller'";
595		693
596	$extcmd{$name} = [$cb, $caller];	694	$EXTCMD{$name} = [$cb, $caller];
597	}	695	}
		696
		697	cf::player->attach (
		698	on_command => sub {
		699	my ($pl, $name, $params) = @_;
		700
		701	my $cb = $COMMAND{$name}
		702	or return;
		703
		704	for my $cmd (@$cb) {
		705	$cmd->[1]->($pl->ob, $params);
		706	}
		707
		708	cf::override;
		709	},
		710	on_extcmd => sub {
		711	my ($pl, $buf) = @_;
		712
		713	my $msg = eval { from_json $buf };
		714
		715	if (ref $msg) {
		716	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		717	if (my %reply = $cb->[0]->($pl, $msg)) {
		718	$pl->ext_reply ($msg->{msgid}, %reply);
		719	}
		720	}
		721	} else {
		722	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		723	}
		724
		725	cf::override;
		726	},
		727	);
598		728
599	sub register {	729	sub register {
600	my ($base, $pkg) = @_;	730	my ($base, $pkg) = @_;
601		731
602	#TODO	732	#TODO
…		…
621	. "#line 1 \"$path\"\n{\n"	751	. "#line 1 \"$path\"\n{\n"
622	. (do { local $/; <$fh> })	752	. (do { local $/; <$fh> })
623	. "\n};\n1";	753	. "\n};\n1";
624		754
625	eval $source	755	eval $source
626	or die "$path: $@";	756	or die $@ ? "$path: $@\n"
		757	: "extension disabled.\n";
627		758
628	push @exts, $pkg;	759	push @exts, $pkg;
629	$ext_pkg{$base} = $pkg;	760	$ext_pkg{$base} = $pkg;
630		761
631	# no strict 'refs';	762	# no strict 'refs';
…		…
644	# for my $idx (0 .. $#PLUGIN_EVENT) {	775	# for my $idx (0 .. $#PLUGIN_EVENT) {
645	# delete $hook[$idx]{$pkg};	776	# delete $hook[$idx]{$pkg};
646	# }	777	# }
647		778
648	# remove commands	779	# remove commands
649	for my $name (keys %command) {	780	for my $name (keys %COMMAND) {
650	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	781	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
651		782
652	if (@cb) {	783	if (@cb) {
653	$command{$name} = \@cb;	784	$COMMAND{$name} = \@cb;
654	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
655	} else {	785	} else {
656	delete $command{$name};
657	delete $COMMAND{"$name\000"};	786	delete $COMMAND{$name};
658	}	787	}
659	}	788	}
660		789
661	# remove extcmds	790	# remove extcmds
662	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	791	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
663	delete $extcmd{$name};	792	delete $EXTCMD{$name};
664	}	793	}
665		794
666	if (my $cb = $pkg->can ("unload")) {	795	if (my $cb = $pkg->can ("unload")) {
667	eval {	796	eval {
668	$cb->($pkg);	797	$cb->($pkg);
…		…
672		801
673	Symbol::delete_package $pkg;	802	Symbol::delete_package $pkg;
674	}	803	}
675		804
676	sub load_extensions {	805	sub load_extensions {
677	my $LIBDIR = maps_directory "perl";
678
679	for my $ext (<$LIBDIR/*.ext>) {	806	for my $ext (<$LIBDIR/*.ext>) {
680	next unless -r $ext;	807	next unless -r $ext;
681	eval {	808	eval {
682	load_extension $ext;	809	load_extension $ext;
683	1	810	1
684	} or warn "$ext not loaded: $@";	811	} or warn "$ext not loaded: $@";
685	}	812	}
686	}	813	}
687		814
688	#############################################################################	815	#############################################################################
689	# extcmd framework, basically convert ext <msg>
690	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
691
692	attach_to_players
693	on_extcmd => sub {
694	my ($pl, $buf) = @_;
695
696	my $msg = eval { from_json $buf };
697
698	if (ref $msg) {
699	if (my $cb = $extcmd{$msg->{msgtype}}) {
700	if (my %reply = $cb->[0]->($pl, $msg)) {
701	$pl->ext_reply ($msg->{msgid}, %reply);
702	}
703	}
704	} else {
705	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
706	}
707
708	cf::override;
709	},
710	;
711
712	#############################################################################
713	# load/save/clean perl data associated with a map	816	# load/save/clean perl data associated with a map
714		817
715	*cf::mapsupport::on_clean = sub {	818	*cf::mapsupport::on_clean = sub {
716	my ($map) = @_;	819	my ($map) = @_;
717		820
…		…
719	defined $path or return;	822	defined $path or return;
720		823
721	unlink "$path.pst";	824	unlink "$path.pst";
722	};	825	};
723		826
724	attach_to_maps prio => -10000, package => cf::mapsupport::;	827	cf::map->attach (prio => -10000, package => cf::mapsupport::);
725		828
726	#############################################################################	829	#############################################################################
727	# load/save perl data associated with player->ob objects	830	# load/save perl data associated with player->ob objects
728		831
729	sub all_objects(@) {	832	sub all_objects(@) {
730	@_, map all_objects ($_->inv), @_	833	@_, map all_objects ($_->inv), @_
731	}	834	}
732		835
733	# TODO: compatibility cruft, remove when no longer needed	836	# TODO: compatibility cruft, remove when no longer needed
734	attach_to_players	837	cf::player->attach (
735	on_load => sub {	838	on_load => sub {
736	my ($pl, $path) = @_;	839	my ($pl, $path) = @_;
737		840
738	for my $o (all_objects $pl->ob) {	841	for my $o (all_objects $pl->ob) {
739	if (my $value = $o->get_ob_key_value ("_perl_data")) {	842	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
741		844
742	%$o = %{ Storable::thaw pack "H*", $value };	845	%$o = %{ Storable::thaw pack "H*", $value };
743	}	846	}
744	}	847	}
745	},	848	},
746	;	849	);
747		850
748	#############################################################################	851	#############################################################################
749		852
750	=head2 CORE EXTENSIONS	853	=head2 CORE EXTENSIONS
751		854
752	Functions and methods that extend core crossfire objects.	855	Functions and methods that extend core crossfire objects.
		856
		857	=head3 cf::player
753		858
754	=over 4	859	=over 4
755		860
756	=item cf::player::exists $login	861	=item cf::player::exists $login
757		862
…		…
762	sub cf::player::exists($) {	867	sub cf::player::exists($) {
763	cf::player::find $_[0]	868	cf::player::find $_[0]
764	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	869	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
765	}	870	}
766		871
		872	=item $player->ext_reply ($msgid, $msgtype, %msg)
		873
		874	Sends an ext reply to the player.
		875
		876	=cut
		877
		878	sub cf::player::ext_reply($$$%) {
		879	my ($self, $id, %msg) = @_;
		880
		881	$msg{msgid} = $id;
		882
		883	$self->send ("ext " . to_json \%msg);
		884	}
		885
		886	=back
		887
		888	=head3 cf::object::player
		889
		890	=over 4
		891
767	=item $player->reply ($npc, $msg[, $flags])	892	=item $player_object->reply ($npc, $msg[, $flags])
768		893
769	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	894	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
770	can be C<undef>. Does the right thing when the player is currently in a	895	can be C<undef>. Does the right thing when the player is currently in a
771	dialogue with the given NPC character.	896	dialogue with the given NPC character.
772		897
773	=cut	898	=cut
774		899
775	# rough implementation of a future "reply" method that works	900	# rough implementation of a future "reply" method that works
776	# with dialog boxes.	901	# with dialog boxes.
		902	#TODO: the first argument must go, split into a $npc->reply_to ( method
777	sub cf::object::player::reply($$$;$) {	903	sub cf::object::player::reply($$$;$) {
778	my ($self, $npc, $msg, $flags) = @_;	904	my ($self, $npc, $msg, $flags) = @_;
779		905
780	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	906	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
781		907
…		…
785	$msg = $npc->name . " says: $msg" if $npc;	911	$msg = $npc->name . " says: $msg" if $npc;
786	$self->message ($msg, $flags);	912	$self->message ($msg, $flags);
787	}	913	}
788	}	914	}
789		915
790	=item $player->ext_reply ($msgid, $msgtype, %msg)	916	=item $player_object->may ("access")
791		917
792	Sends an ext reply to the player.	918	Returns wether the given player is authorized to access resource "access"
		919	(e.g. "command_wizcast").
793		920
794	=cut	921	=cut
795		922
796	sub cf::player::ext_reply($$$%) {	923	sub cf::object::player::may {
		924	my ($self, $access) = @_;
		925
		926	$self->flag (cf::FLAG_WIZ) ||
		927	(ref $cf::CFG{"may_$access"}
		928	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		929	: $cf::CFG{"may_$access"})
		930	}
		931
		932	=head3 cf::client
		933
		934	=over 4
		935
		936	=item $client->send_drawinfo ($text, $flags)
		937
		938	Sends a drawinfo packet to the client. Circumvents output buffering so
		939	should not be used under normal circumstances.
		940
		941	=cut
		942
		943	sub cf::client::send_drawinfo {
		944	my ($self, $text, $flags) = @_;
		945
		946	utf8::encode $text;
		947	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		948	}
		949
		950
		951	=item $success = $client->query ($flags, "text", \&cb)
		952
		953	Queues a query to the client, calling the given callback with
		954	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		955	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		956
		957	Queries can fail, so check the return code. Or don't, as queries will become
		958	reliable at some point in the future.
		959
		960	=cut
		961
		962	sub cf::client::query {
		963	my ($self, $flags, $text, $cb) = @_;
		964
		965	return unless $self->state == ST_PLAYING
		966	|| $self->state == ST_SETUP
		967	|| $self->state == ST_CUSTOM;
		968
		969	$self->state (ST_CUSTOM);
		970
		971	utf8::encode $text;
		972	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		973
		974	$self->send_packet ($self->{query_queue}[0][0])
		975	if @{ $self->{query_queue} } == 1;
		976	}
		977
		978	cf::client->attach (
		979	on_reply => sub {
		980	my ($ns, $msg) = @_;
		981
		982	# this weird shuffling is so that direct followup queries
		983	# get handled first
		984	my $queue = delete $ns->{query_queue};
		985
		986	(shift @$queue)->[1]->($msg);
		987
		988	push @{ $ns->{query_queue} }, @$queue;
		989
		990	if (@{ $ns->{query_queue} } == @$queue) {
		991	if (@$queue) {
		992	$ns->send_packet ($ns->{query_queue}[0][0]);
		993	} else {
		994	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		995	}
		996	}
		997	},
		998	);
		999
		1000	=item $client->coro (\&cb)
		1001
		1002	Create a new coroutine, running the specified callback. The coroutine will
		1003	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1004	or loss of connection).
		1005
		1006	=cut
		1007
		1008	sub cf::client::coro {
797	my ($self, $id, %msg) = @_;	1009	my ($self, $cb) = @_;
798		1010
799	$msg{msgid} = $id;	1011	my $coro; $coro = async {
		1012	eval {
		1013	$cb->();
		1014	};
		1015	warn $@ if $@;
		1016	};
800		1017
801	$self->send ("ext " . to_json \%msg);	1018	$coro->on_destroy (sub {
		1019	delete $self->{_coro}{$coro+0};
		1020	});
		1021
		1022	$self->{_coro}{$coro+0} = $coro;
		1023
		1024	$coro
802	}	1025	}
		1026
		1027	cf::client->attach (
		1028	on_destroy => sub {
		1029	my ($ns) = @_;
		1030
		1031	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1032	},
		1033	);
803		1034
804	=back	1035	=back
805		1036
806	=cut
807
808	#############################################################################
809		1037
810	=head2 SAFE SCRIPTING	1038	=head2 SAFE SCRIPTING
811		1039
812	Functions that provide a safe environment to compile and execute	1040	Functions that provide a safe environment to compile and execute
813	snippets of perl code without them endangering the safety of the server	1041	snippets of perl code without them endangering the safety of the server
814	itself. Looping constructs, I/O operators and other built-in functionality	1042	itself. Looping constructs, I/O operators and other built-in functionality
815	is not available in the safe scripting environment, and the number of	1043	is not available in the safe scripting environment, and the number of
816	functions and methods that cna be called is greatly reduced.	1044	functions and methods that can be called is greatly reduced.
817		1045
818	=cut	1046	=cut
819		1047
820	our $safe = new Safe "safe";	1048	our $safe = new Safe "safe";
821	our $safe_hole = new Safe::Hole;	1049	our $safe_hole = new Safe::Hole;
…		…
828		1056
829	=pod	1057	=pod
830		1058
831	The following fucntions and emthods are available within a safe environment:	1059	The following fucntions and emthods are available within a safe environment:
832		1060
833	cf::object contr pay_amount pay_player	1061	cf::object contr pay_amount pay_player map
834	cf::object::player player	1062	cf::object::player player
835	cf::player peaceful	1063	cf::player peaceful
		1064	cf::map trigger
836		1065
837	=cut	1066	=cut
838		1067
839	for (	1068	for (
840	["cf::object" => qw(contr pay_amount pay_player)],	1069	["cf::object" => qw(contr pay_amount pay_player map)],
841	["cf::object::player" => qw(player)],	1070	["cf::object::player" => qw(player)],
842	["cf::player" => qw(peaceful)],	1071	["cf::player" => qw(peaceful)],
		1072	["cf::map" => qw(trigger)],
843	) {	1073	) {
844	no strict 'refs';	1074	no strict 'refs';
845	my ($pkg, @funs) = @$_;	1075	my ($pkg, @funs) = @$_;
846	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1076	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
847	for @funs;	1077	for @funs;
…		…
912	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1142	*{"safe::$fun"} = $safe_hole->wrap ($cb);
913	}	1143	}
914		1144
915	=back	1145	=back
916		1146
		1147	=cut
		1148
917	#############################################################################	1149	#############################################################################
918		1150
919	=head2 EXTENSION DATABASE SUPPORT	1151	=head2 EXTENSION DATABASE SUPPORT
920		1152
921	Crossfire maintains a very simple database for extension use. It can	1153	Crossfire maintains a very simple database for extension use. It can
…		…
955		1187
956	Immediately write the database to disk I<if it is dirty>.	1188	Immediately write the database to disk I<if it is dirty>.
957		1189
958	=cut	1190	=cut
959		1191
		1192	our $DB;
		1193
960	{	1194	{
961	my $db;
962	my $path = cf::localdir . "/database.pst";	1195	my $path = cf::localdir . "/database.pst";
963		1196
964	sub db_load() {	1197	sub db_load() {
965	warn "loading database $path\n";#d# remove later	1198	warn "loading database $path\n";#d# remove later
966	$db = stat $path ? Storable::retrieve $path : { };	1199	$DB = stat $path ? Storable::retrieve $path : { };
967	}	1200	}
968		1201
969	my $pid;	1202	my $pid;
970		1203
971	sub db_save() {	1204	sub db_save() {
972	warn "saving database $path\n";#d# remove later	1205	warn "saving database $path\n";#d# remove later
973	waitpid $pid, 0 if $pid;	1206	waitpid $pid, 0 if $pid;
974	if (0 == ($pid = fork)) {	1207	if (0 == ($pid = fork)) {
975	$db->{_meta}{version} = 1;	1208	$DB->{_meta}{version} = 1;
976	Storable::nstore $db, "$path~";	1209	Storable::nstore $DB, "$path~";
977	rename "$path~", $path;	1210	rename "$path~", $path;
978	cf::_exit 0 if defined $pid;	1211	cf::_exit 0 if defined $pid;
979	}	1212	}
980	}	1213	}
981		1214
…		…
984	sub db_sync() {	1217	sub db_sync() {
985	db_save if $dirty;	1218	db_save if $dirty;
986	undef $dirty;	1219	undef $dirty;
987	}	1220	}
988		1221
989	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	1222	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
990	db_sync;	1223	db_sync;
991	});	1224	});
992		1225
993	sub db_dirty() {	1226	sub db_dirty() {
994	$dirty = 1;	1227	$dirty = 1;
995	$idle->start;	1228	$idle->start;
996	}	1229	}
997		1230
998	sub db_get($;$) {	1231	sub db_get($;$) {
999	@_ >= 2	1232	@_ >= 2
1000	? $db->{$_[0]}{$_[1]}	1233	? $DB->{$_[0]}{$_[1]}
1001	: ($db->{$_[0]} ||= { })	1234	: ($DB->{$_[0]} ||= { })
1002	}	1235	}
1003		1236
1004	sub db_put($$;$) {	1237	sub db_put($$;$) {
1005	if (@_ >= 3) {	1238	if (@_ >= 3) {
1006	$db->{$_[0]}{$_[1]} = $_[2];	1239	$DB->{$_[0]}{$_[1]} = $_[2];
1007	} else {	1240	} else {
1008	$db->{$_[0]} = $_[1];	1241	$DB->{$_[0]} = $_[1];
1009	}	1242	}
1010	db_dirty;	1243	db_dirty;
1011	}	1244	}
1012		1245
1013	attach_global	1246	cf::global->attach (
1014	prio => 10000,	1247	prio => 10000,
1015	on_cleanup => sub {	1248	on_cleanup => sub {
1016	db_sync;	1249	db_sync;
1017	},	1250	},
1018	;	1251	);
1019	}	1252	}
1020		1253
1021	#############################################################################	1254	#############################################################################
1022	# the server's main()	1255	# the server's main()
1023		1256
		1257	sub cfg_load {
		1258	open my $fh, "<:utf8", cf::confdir . "/config"
		1259	or return;
		1260
		1261	local $/;
		1262	*CFG = YAML::Syck::Load <$fh>;
		1263	}
		1264
1024	sub main {	1265	sub main {
		1266	cfg_load;
1025	db_load;	1267	db_load;
1026	load_extensions;	1268	load_extensions;
1027	Event::loop;	1269	Event::loop;
1028	}	1270	}
1029		1271
1030	#############################################################################	1272	#############################################################################
1031	# initialisation	1273	# initialisation
1032		1274
1033	sub _perl_reload(&) {	1275	sub _perl_reload() {
1034	my ($msg) = @_;	1276	warn "reloading...";
1035
1036	$msg->("reloading...");
1037		1277
1038	eval {	1278	eval {
		1279	local $FREEZE = 1;
		1280
		1281	cf::emergency_save;
		1282
1039	# cancel all watchers	1283	# cancel all watchers
1040	$_->cancel for Event::all_watchers;	1284	for (Event::all_watchers) {
		1285	$_->cancel if $_->data & WF_AUTOCANCEL;
		1286	}
		1287
		1288	# cancel all extension coros
		1289	$_->cancel for values %EXT_CORO;
		1290	%EXT_CORO = ();
1041		1291
1042	# unload all extensions	1292	# unload all extensions
1043	for (@exts) {	1293	for (@exts) {
1044	$msg->("unloading <$_>");	1294	warn "unloading <$_>";
1045	unload_extension $_;	1295	unload_extension $_;
1046	}	1296	}
1047		1297
1048	# unload all modules loaded from $LIBDIR	1298	# unload all modules loaded from $LIBDIR
1049	while (my ($k, $v) = each %INC) {	1299	while (my ($k, $v) = each %INC) {
1050	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1300	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1051		1301
1052	$msg->("removing <$k>");	1302	warn "removing <$k>";
1053	delete $INC{$k};	1303	delete $INC{$k};
1054		1304
1055	$k =~ s/\.pm$//;	1305	$k =~ s/\.pm$//;
1056	$k =~ s/\//::/g;	1306	$k =~ s/\//::/g;
1057		1307
…		…
1062	Symbol::delete_package $k;	1312	Symbol::delete_package $k;
1063	}	1313	}
1064		1314
1065	# sync database to disk	1315	# sync database to disk
1066	cf::db_sync;	1316	cf::db_sync;
		1317	IO::AIO::flush;
1067		1318
1068	# get rid of safe::, as good as possible	1319	# get rid of safe::, as good as possible
1069	Symbol::delete_package "safe::$_"	1320	Symbol::delete_package "safe::$_"
1070	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	1321	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1071		1322
1072	# remove register_script_function callbacks	1323	# remove register_script_function callbacks
1073	# TODO	1324	# TODO
1074		1325
1075	# unload cf.pm "a bit"	1326	# unload cf.pm "a bit"
…		…
1078	# don't, removes xs symbols, too,	1329	# don't, removes xs symbols, too,
1079	# and global variables created in xs	1330	# and global variables created in xs
1080	#Symbol::delete_package __PACKAGE__;	1331	#Symbol::delete_package __PACKAGE__;
1081		1332
1082	# reload cf.pm	1333	# reload cf.pm
1083	$msg->("reloading cf.pm");	1334	warn "reloading cf.pm";
1084	require cf;	1335	require cf;
		1336	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1085		1337
1086	# load database again	1338	# load config and database again
		1339	cf::cfg_load;
1087	cf::db_load;	1340	cf::db_load;
1088		1341
1089	# load extensions	1342	# load extensions
1090	$msg->("load extensions");	1343	warn "load extensions";
1091	cf::load_extensions;	1344	cf::load_extensions;
1092		1345
1093	# reattach attachments to objects	1346	# reattach attachments to objects
1094	$msg->("reattach");	1347	warn "reattach";
1095	_global_reattach;	1348	_global_reattach;
1096	};	1349	};
1097	$msg->($@) if $@;	1350	warn $@ if $@;
1098		1351
1099	$msg->("reloaded");	1352	warn "reloaded";
1100	};	1353	};
1101		1354
1102	sub perl_reload() {	1355	sub perl_reload() {
1103	_perl_reload {	1356	_perl_reload;
1104	warn $_[0];
1105	print "$_[0]\n";
1106	};
1107	}	1357	}
1108		1358
		1359	register "<global>", __PACKAGE__;
		1360
1109	register_command "perl-reload", 0, sub {	1361	register_command "perl-reload" => sub {
1110	my ($who, $arg) = @_;	1362	my ($who, $arg) = @_;
1111		1363
1112	if ($who->flag (FLAG_WIZ)) {	1364	if ($who->flag (FLAG_WIZ)) {
		1365	$who->message ("reloading...");
1113	_perl_reload {	1366	_perl_reload;
1114	warn $_[0];
1115	$who->message ($_[0]);
1116	};
1117	}	1367	}
1118	};	1368	};
1119		1369
1120	register "<global>", __PACKAGE__;
1121
1122	unshift @INC, $LIBDIR;	1370	unshift @INC, $LIBDIR;
1123		1371
1124	$TICK_WATCHER = Event->timer (	1372	$TICK_WATCHER = Event->timer (
		1373	reentrant => 0,
1125	prio => 1,	1374	prio => 0,
1126	at => $NEXT_TICK || 1,	1375	at => $NEXT_TICK || $TICK,
		1376	data => WF_AUTOCANCEL,
1127	cb => sub {	1377	cb => sub {
		1378	unless ($FREEZE) {
1128	cf::server_tick; # one server iteration	1379	cf::server_tick; # one server iteration
		1380	$RUNTIME += $TICK;
		1381	}
1129		1382
1130	my $NOW = Event::time;
1131	$NEXT_TICK += $TICK;	1383	$NEXT_TICK += $TICK;
1132		1384
1133	# if we are delayed by four ticks, skip them all	1385	# if we are delayed by four ticks or more, skip them all
1134	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1386	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1135		1387
1136	$TICK_WATCHER->at ($NEXT_TICK);	1388	$TICK_WATCHER->at ($NEXT_TICK);
1137	$TICK_WATCHER->start;	1389	$TICK_WATCHER->start;
1138	},	1390	},
1139	);	1391	);
1140		1392
		1393	IO::AIO::max_poll_time $TICK * 0.2;
		1394
		1395	Event->io (fd => IO::AIO::poll_fileno,
		1396	poll => 'r',
		1397	prio => 5,
		1398	data => WF_AUTOCANCEL,
		1399	cb => \&IO::AIO::poll_cb);
		1400
		1401	# we must not ever block the main coroutine
		1402	$Coro::idle = sub {
		1403	#Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
		1404	warn "FATAL: Coro::idle was called, major BUG\n";
		1405	(Coro::unblock_sub {
		1406	Event::one_event;
		1407	})->();
		1408	};
		1409
1141	1	1410	1
1142		1411

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines