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

Diff Legend

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