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.71 by root, Sun Oct 1 10:59:30 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
114	=cut	236	=cut
115		237
116	#############################################################################	238	#############################################################################
117		239
118	=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+).
119		249
120	=over 4	250	=over 4
121		251
122	=item $object->attach ($attachment, key => $value...)
123
124	=item $object->detach ($attachment)
125
126	Attach/detach a pre-registered attachment to an object.
127
128	=item $player->attach ($attachment, key => $value...)
129
130	=item $player->detach ($attachment)
131
132	Attach/detach a pre-registered attachment to a player.
133
134	=item $map->attach ($attachment, key => $value...)	252	=item $attachable->attach ($attachment, key => $value...)
135		253
136	=item $map->detach ($attachment)	254	=item $attachable->detach ($attachment)
137		255
138	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.
139		258
140	=item $bool = $object->attached ($name)	259	Example, attach a minesweeper attachment to the given object, making it a
		260	10x10 minesweeper game:
141		261
142	=item $bool = $player->attached ($name)	262	$obj->attach (minesweeper => width => 10, height => 10);
143		263
144	=item $bool = $map->attached ($name)	264	=item $bool = $attachable->attached ($name)
145		265
146	Checks wether the named attachment is currently attached to the object.	266	Checks wether the named attachment is currently attached to the object.
147		267
148	=item cf::attach_global ...	268	=item cf::CLASS->attach ...
149		269
150	Attach handlers for global events.	270	=item cf::CLASS->detach ...
151		271
152	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
153	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:
154		306
155	=over 4	307	=over 4
156		308
157	=item prio => $number	309	=item prio => $number
158		310
…		…
160	by another C<prio> setting). Lower priority handlers get executed	312	by another C<prio> setting). Lower priority handlers get executed
161	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
162	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
163	unless you know what you are doing.	315	unless you know what you are doing.
164		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
165	=item on_I<event> => \&cb	323	=item on_I<event> => \&cb
166		324
167	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
168	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
169	handlers are recognised generally depends on the type of object these	327	handlers are recognised generally depends on the type of object these
…		…
178	package and register them. Only handlers for eevents supported by the	336	package and register them. Only handlers for eevents supported by the
179	object/class are recognised.	337	object/class are recognised.
180		338
181	=back	339	=back
182		340
183	=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:
184		343
185	Attach handlers for a specific object type (e.g. TRANSPORT) and	344	cf::object::attachment sockpuppet =>
186	subtype. If C<$subtype> is zero or undef, matches all objects of the given	345	on_skill_attack => sub {
187	type.	346	my ($self, $victim) = @_;
188		347	...
189	=item cf::attach_to_objects ...
190
191	Attach handlers to all objects. Do not use this except for debugging or
192	very rare events, as handlers are (obviously) called for I<all> objects in
193	the game.
194
195	=item cf::attach_to_players ...
196
197	Attach handlers to all players.
198
199	=item cf::attach_to_maps ...
200
201	Attach handlers to all maps.
202
203	=item cf:register_attachment $name, ...
204
205	Register an attachment by name through which objects can refer to this
206	attachment.
207
208	=item cf:register_player_attachment $name, ...
209
210	Register an attachment by name through which players can refer to this
211	attachment.
212
213	=item cf:register_map_attachment $name, ...
214
215	Register an attachment by name through which maps can refer to this
216	attachment.
217
218	=cut
219
220	# the following variables are defined in .xs and must not be re-created
221	our @CB_GLOBAL = (); # registry for all global events
222	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
223	our @CB_PLAYER = ();
224	our @CB_TYPE = (); # registry for type (cf-object class) based events
225	our @CB_MAP = ();
226
227	my %attachment;
228
229	sub _attach_cb($\%$$$) {
230	my ($registry, $undo, $event, $prio, $cb) = @_;
231
232	use sort 'stable';
233
234	$cb = [$prio, $cb];
235
236	@{$registry->[$event]} = sort
237	{ $a->[0] cmp $b->[0] }
238	@{$registry->[$event] || []}, $cb;
239
240	push @{$undo->{cb}}, [$event, $cb];
241	}
242
243	# attach handles attaching event callbacks
244	# the only thing the caller has to do is pass the correct
245	# registry (== where the callback attaches to).
246	sub _attach(\@$@) {
247	my ($registry, $klass, @arg) = @_;
248
249	my $prio = 0;
250
251	my %undo = (
252	registry => $registry,
253	cb => [],
254	);
255
256	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
257
258	while (@arg) {
259	my $type = shift @arg;
260
261	if ($type eq "prio") {
262	$prio = shift @arg;
263
264	} elsif ($type eq "package") {
265	my $pkg = shift @arg;
266
267	while (my ($name, $id) = each %cb_id) {
268	if (my $cb = $pkg->can ($name)) {
269	_attach_cb $registry, %undo, $id, $prio, $cb;
270	}
271	}	348	}
272
273	} elsif (exists $cb_id{$type}) {
274	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
275
276	} elsif (ref $type) {
277	warn "attaching objects not supported, ignoring.\n";
278
279	} else {
280	shift @arg;
281	warn "attach argument '$type' not supported, ignoring.\n";
282	}
283	}
284
285	\%undo
286	}
287
288	sub _attach_attachment {
289	my ($obj, $name, %arg) = @_;
290
291	return if exists $obj->{_attachment}{$name};
292
293	my $res;
294
295	if (my $attach = $attachment{$name}) {
296	my $registry = $obj->registry;
297
298	for (@$attach) {
299	my ($klass, @attach) = @$_;
300	$res = _attach @$registry, $klass, @attach;
301	}
302
303	$obj->{$name} = \%arg;
304	} else {
305	warn "object uses attachment '$name' that is not available, postponing.\n";
306	}
307
308	$obj->{_attachment}{$name} = undef;
309
310	$res->{attachment} = $name;
311	$res
312	}
313
314	*cf::object::attach =
315	*cf::player::attach =
316	*cf::map::attach = sub {
317	my ($obj, $name, %arg) = @_;
318
319	_attach_attachment $obj, $name, %arg;
320	};
321
322	# all those should be optimised
323	*cf::object::detach =
324	*cf::player::detach =
325	*cf::map::detach = sub {
326	my ($obj, $name) = @_;
327
328	delete $obj->{_attachment}{$name};
329	reattach ($obj);
330	};
331
332	*cf::object::attached =
333	*cf::player::attached =
334	*cf::map::attached = sub {
335	my ($obj, $name) = @_;
336
337	exists $obj->{_attachment}{$name}
338	};
339
340	sub attach_global {
341	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
342	}
343
344	sub attach_to_type {
345	my $type = shift;
346	my $subtype = shift;
347
348	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
349	}
350
351	sub attach_to_objects {
352	_attach @CB_OBJECT, KLASS_OBJECT, @_
353	}
354
355	sub attach_to_players {
356	_attach @CB_PLAYER, KLASS_PLAYER, @_
357	}
358
359	sub attach_to_maps {
360	_attach @CB_MAP, KLASS_MAP, @_
361	}
362
363	sub register_attachment {
364	my $name = shift;
365
366	$attachment{$name} = [[KLASS_OBJECT, @_]];
367	}
368
369	sub register_player_attachment {
370	my $name = shift;
371
372	$attachment{$name} = [[KLASS_PLAYER, @_]];
373	}
374
375	sub register_map_attachment {
376	my $name = shift;
377
378	$attachment{$name} = [[KLASS_MAP, @_]];
379	}
380
381	our $override;
382	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
383
384	sub override {
385	$override = 1;
386	@invoke_results = ();
387	}
388
389	sub do_invoke {
390	my $event = shift;
391	my $callbacks = shift;
392
393	@invoke_results = ();
394
395	local $override;
396
397	for (@$callbacks) {
398	eval { &{$_->[1]} };
399
400	if ($@) {
401	warn "$@";
402	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
403	override;
404	}
405
406	return 1 if $override;
407	}
408
409	0	349	}
410	}
411		350
412	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	351	=item $attachable->valid
413
414	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
415
416	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
417
418	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
419
420	Generate a global/object/player/map-specific event with the given arguments.
421
422	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
423	removed in future versions), and there is no public API to access override
424	results (if you must, access C<@cf::invoke_results> directly).
425
426	=back
427
428	=cut
429
430	#############################################################################
431
432	=head2 METHODS VALID FOR ALL CORE OBJECTS
433
434	=over 4
435
436	=item $object->valid, $player->valid, $map->valid
437		352
438	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
439	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
440	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
441	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
442	exception.	357	exception.
443		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
444	=back	542	=back
445		543
446	=cut	544	=cut
447
448	*cf::object::valid =
449	*cf::player::valid =
450	*cf::map::valid = \&cf::_valid;
451		545
452	#############################################################################	546	#############################################################################
453	# object support	547	# object support
454		548
455	sub instantiate {
456	my ($obj, $data) = @_;
457
458	$data = from_json $data;
459
460	for (@$data) {
461	my ($name, $args) = @$_;
462
463	$obj->attach ($name, %{$args || {} });
464	}
465	}
466
467	# basically do the same as instantiate, without calling instantiate
468	sub reattach {	549	sub reattach {
		550	# basically do the same as instantiate, without calling instantiate
469	my ($obj) = @_;	551	my ($obj) = @_;
		552
470	my $registry = $obj->registry;	553	my $registry = $obj->registry;
471		554
472	@$registry = ();	555	@$registry = ();
473		556
474	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	557	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
475		558
476	for my $name (keys %{ $obj->{_attachment} || {} }) {	559	for my $name (keys %{ $obj->{_attachment} || {} }) {
477	if (my $attach = $attachment{$name}) {	560	if (my $attach = $attachment{$name}) {
478	for (@$attach) {	561	for (@$attach) {
479	my ($klass, @attach) = @$_;	562	my ($klass, @attach) = @$_;
480	_attach @$registry, $klass, @attach;	563	_attach $registry, $klass, @attach;
481	}	564	}
482	} else {	565	} else {
483	warn "object uses attachment '$name' that is not available, postponing.\n";	566	warn "object uses attachment '$name' that is not available, postponing.\n";
484	}	567	}
485	}	568	}
486	}	569	}
487		570
488	sub object_freezer_save {	571	cf::attachable->attach (
489	my ($filename, $rdata, $objs) = @_;
490
491	if (length $$rdata) {
492	warn sprintf "saving %s (%d,%d)\n",
493	$filename, length $$rdata, scalar @$objs;
494
495	if (open my $fh, ">:raw", "$filename~") {
496	chmod SAVE_MODE, $fh;
497	syswrite $fh, $$rdata;
498	close $fh;
499
500	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
501	chmod SAVE_MODE, $fh;
502	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
503	close $fh;
504	rename "$filename.pst~", "$filename.pst";
505	} else {
506	unlink "$filename.pst";
507	}
508
509	rename "$filename~", $filename;
510	} else {
511	warn "FATAL: $filename~: $!\n";
512	}
513	} else {
514	unlink $filename;
515	unlink "$filename.pst";
516	}
517	}
518
519	sub object_thawer_load {
520	my ($filename) = @_;
521
522	local $/;
523
524	my $av;
525
526	#TODO: use sysread etc.
527	if (open my $data, "<:raw:perlio", $filename) {
528	$data = <$data>;
529	if (open my $pst, "<:raw:perlio", "$filename.pst") {
530	$av = eval { (Storable::thaw <$pst>)->{objs} };
531	}
532	return ($data, $av);
533	}
534
535	()
536	}
537
538	attach_to_objects
539	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,
540	on_clone => sub {	585	on_clone => sub {
541	my ($src, $dst) = @_;	586	my ($src, $dst) = @_;
542		587
543	@{$dst->registry} = @{$src->registry};	588	@{$dst->registry} = @{$src->registry};
544		589
545	%$dst = %$src;	590	%$dst = %$src;
546		591
547	%{$dst->{_attachment}} = %{$src->{_attachment}}	592	%{$dst->{_attachment}} = %{$src->{_attachment}}
548	if exists $src->{_attachment};	593	if exists $src->{_attachment};
549	},	594	},
550	;	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	}
551		659
552	#############################################################################	660	#############################################################################
553	# old plug-in events	661	# command handling &c
554		662
555	sub inject_event {	663	=item cf::register_command $name => \&callback($ob,$args);
556	my $extension = shift;
557	my $event_code = shift;
558		664
559	my $cb = $hook[$event_code]{$extension}	665	Register a callback for execution when the client sends the user command
560	or return;	666	$name.
561		667
562	&$cb	668	=cut
563	}
564
565	sub inject_global_event {
566	my $event = shift;
567
568	my $cb = $hook[$event]
569	or return;
570
571	List::Util::max map &$_, values %$cb
572	}
573
574	sub inject_command {
575	my ($name, $obj, $params) = @_;
576
577	for my $cmd (@{ $command{$name} }) {
578	$cmd->[1]->($obj, $params);
579	}
580
581	-1
582	}
583		669
584	sub register_command {	670	sub register_command {
585	my ($name, $time, $cb) = @_;	671	my ($name, $cb) = @_;
586		672
587	my $caller = caller;	673	my $caller = caller;
588	#warn "registering command '$name/$time' to '$caller'";	674	#warn "registering command '$name/$time' to '$caller'";
589		675
590	push @{ $command{$name} }, [$time, $cb, $caller];	676	push @{ $COMMAND{$name} }, [$caller, $cb];
591	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
592	}	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
593		687
594	sub register_extcmd {	688	sub register_extcmd {
595	my ($name, $cb) = @_;	689	my ($name, $cb) = @_;
596		690
597	my $caller = caller;	691	my $caller = caller;
598	#warn "registering extcmd '$name' to '$caller'";	692	#warn "registering extcmd '$name' to '$caller'";
599		693
600	$extcmd{$name} = [$cb, $caller];	694	$EXTCMD{$name} = [$cb, $caller];
601	}	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	);
602		728
603	sub register {	729	sub register {
604	my ($base, $pkg) = @_;	730	my ($base, $pkg) = @_;
605		731
606	#TODO	732	#TODO
…		…
625	. "#line 1 \"$path\"\n{\n"	751	. "#line 1 \"$path\"\n{\n"
626	. (do { local $/; <$fh> })	752	. (do { local $/; <$fh> })
627	. "\n};\n1";	753	. "\n};\n1";
628		754
629	eval $source	755	eval $source
630	or die "$path: $@";	756	or die $@ ? "$path: $@\n"
		757	: "extension disabled.\n";
631		758
632	push @exts, $pkg;	759	push @exts, $pkg;
633	$ext_pkg{$base} = $pkg;	760	$ext_pkg{$base} = $pkg;
634		761
635	# no strict 'refs';	762	# no strict 'refs';
…		…
648	# for my $idx (0 .. $#PLUGIN_EVENT) {	775	# for my $idx (0 .. $#PLUGIN_EVENT) {
649	# delete $hook[$idx]{$pkg};	776	# delete $hook[$idx]{$pkg};
650	# }	777	# }
651		778
652	# remove commands	779	# remove commands
653	for my $name (keys %command) {	780	for my $name (keys %COMMAND) {
654	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	781	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
655		782
656	if (@cb) {	783	if (@cb) {
657	$command{$name} = \@cb;	784	$COMMAND{$name} = \@cb;
658	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
659	} else {	785	} else {
660	delete $command{$name};
661	delete $COMMAND{"$name\000"};	786	delete $COMMAND{$name};
662	}	787	}
663	}	788	}
664		789
665	# remove extcmds	790	# remove extcmds
666	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	791	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
667	delete $extcmd{$name};	792	delete $EXTCMD{$name};
668	}	793	}
669		794
670	if (my $cb = $pkg->can ("unload")) {	795	if (my $cb = $pkg->can ("unload")) {
671	eval {	796	eval {
672	$cb->($pkg);	797	$cb->($pkg);
…		…
676		801
677	Symbol::delete_package $pkg;	802	Symbol::delete_package $pkg;
678	}	803	}
679		804
680	sub load_extensions {	805	sub load_extensions {
681	my $LIBDIR = maps_directory "perl";
682
683	for my $ext (<$LIBDIR/*.ext>) {	806	for my $ext (<$LIBDIR/*.ext>) {
684	next unless -r $ext;	807	next unless -r $ext;
685	eval {	808	eval {
686	load_extension $ext;	809	load_extension $ext;
687	1	810	1
688	} or warn "$ext not loaded: $@";	811	} or warn "$ext not loaded: $@";
689	}	812	}
690	}	813	}
691		814
692	#############################################################################	815	#############################################################################
693	# extcmd framework, basically convert ext <msg>
694	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
695
696	attach_to_players
697	on_extcmd => sub {
698	my ($pl, $buf) = @_;
699
700	my $msg = eval { from_json $buf };
701
702	if (ref $msg) {
703	if (my $cb = $extcmd{$msg->{msgtype}}) {
704	if (my %reply = $cb->[0]->($pl, $msg)) {
705	$pl->ext_reply ($msg->{msgid}, %reply);
706	}
707	}
708	} else {
709	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
710	}
711
712	cf::override;
713	},
714	;
715
716	#############################################################################
717	# load/save/clean perl data associated with a map	816	# load/save/clean perl data associated with a map
718		817
719	*cf::mapsupport::on_clean = sub {	818	*cf::mapsupport::on_clean = sub {
720	my ($map) = @_;	819	my ($map) = @_;
721		820
…		…
723	defined $path or return;	822	defined $path or return;
724		823
725	unlink "$path.pst";	824	unlink "$path.pst";
726	};	825	};
727		826
728	attach_to_maps prio => -10000, package => cf::mapsupport::;	827	cf::map->attach (prio => -10000, package => cf::mapsupport::);
729		828
730	#############################################################################	829	#############################################################################
731	# load/save perl data associated with player->ob objects	830	# load/save perl data associated with player->ob objects
732		831
733	sub all_objects(@) {	832	sub all_objects(@) {
734	@_, map all_objects ($_->inv), @_	833	@_, map all_objects ($_->inv), @_
735	}	834	}
736		835
737	# TODO: compatibility cruft, remove when no longer needed	836	# TODO: compatibility cruft, remove when no longer needed
738	attach_to_players	837	cf::player->attach (
739	on_load => sub {	838	on_load => sub {
740	my ($pl, $path) = @_;	839	my ($pl, $path) = @_;
741		840
742	for my $o (all_objects $pl->ob) {	841	for my $o (all_objects $pl->ob) {
743	if (my $value = $o->get_ob_key_value ("_perl_data")) {	842	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
745		844
746	%$o = %{ Storable::thaw pack "H*", $value };	845	%$o = %{ Storable::thaw pack "H*", $value };
747	}	846	}
748	}	847	}
749	},	848	},
750	;	849	);
751		850
752	#############################################################################	851	#############################################################################
753		852
754	=head2 CORE EXTENSIONS	853	=head2 CORE EXTENSIONS
755		854
756	Functions and methods that extend core crossfire objects.	855	Functions and methods that extend core crossfire objects.
		856
		857	=head3 cf::player
757		858
758	=over 4	859	=over 4
759		860
760	=item cf::player::exists $login	861	=item cf::player::exists $login
761		862
…		…
766	sub cf::player::exists($) {	867	sub cf::player::exists($) {
767	cf::player::find $_[0]	868	cf::player::find $_[0]
768	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;
769	}	870	}
770		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
771	=item $player->reply ($npc, $msg[, $flags])	892	=item $player_object->reply ($npc, $msg[, $flags])
772		893
773	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>
774	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
775	dialogue with the given NPC character.	896	dialogue with the given NPC character.
776		897
777	=cut	898	=cut
778		899
779	# rough implementation of a future "reply" method that works	900	# rough implementation of a future "reply" method that works
780	# with dialog boxes.	901	# with dialog boxes.
		902	#TODO: the first argument must go, split into a $npc->reply_to ( method
781	sub cf::object::player::reply($$$;$) {	903	sub cf::object::player::reply($$$;$) {
782	my ($self, $npc, $msg, $flags) = @_;	904	my ($self, $npc, $msg, $flags) = @_;
783		905
784	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	906	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
785		907
…		…
789	$msg = $npc->name . " says: $msg" if $npc;	911	$msg = $npc->name . " says: $msg" if $npc;
790	$self->message ($msg, $flags);	912	$self->message ($msg, $flags);
791	}	913	}
792	}	914	}
793		915
794	=item $player->ext_reply ($msgid, $msgtype, %msg)	916	=item $player_object->may ("access")
795		917
796	Sends an ext reply to the player.	918	Returns wether the given player is authorized to access resource "access"
		919	(e.g. "command_wizcast").
797		920
798	=cut	921	=cut
799		922
800	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 {
801	my ($self, $id, %msg) = @_;	1009	my ($self, $cb) = @_;
802		1010
803	$msg{msgid} = $id;	1011	my $coro; $coro = async {
		1012	eval {
		1013	$cb->();
		1014	};
		1015	warn $@ if $@;
		1016	};
804		1017
805	$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
806	}	1025	}
		1026
		1027	cf::client->attach (
		1028	on_destroy => sub {
		1029	my ($ns) = @_;
		1030
		1031	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1032	},
		1033	);
807		1034
808	=back	1035	=back
809		1036
810	=cut
811
812	#############################################################################
813		1037
814	=head2 SAFE SCRIPTING	1038	=head2 SAFE SCRIPTING
815		1039
816	Functions that provide a safe environment to compile and execute	1040	Functions that provide a safe environment to compile and execute
817	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
818	itself. Looping constructs, I/O operators and other built-in functionality	1042	itself. Looping constructs, I/O operators and other built-in functionality
819	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
820	functions and methods that cna be called is greatly reduced.	1044	functions and methods that can be called is greatly reduced.
821		1045
822	=cut	1046	=cut
823		1047
824	our $safe = new Safe "safe";	1048	our $safe = new Safe "safe";
825	our $safe_hole = new Safe::Hole;	1049	our $safe_hole = new Safe::Hole;
…		…
832		1056
833	=pod	1057	=pod
834		1058
835	The following fucntions and emthods are available within a safe environment:	1059	The following fucntions and emthods are available within a safe environment:
836		1060
837	cf::object contr pay_amount pay_player	1061	cf::object contr pay_amount pay_player map
838	cf::object::player player	1062	cf::object::player player
839	cf::player peaceful	1063	cf::player peaceful
		1064	cf::map trigger
840		1065
841	=cut	1066	=cut
842		1067
843	for (	1068	for (
844	["cf::object" => qw(contr pay_amount pay_player)],	1069	["cf::object" => qw(contr pay_amount pay_player map)],
845	["cf::object::player" => qw(player)],	1070	["cf::object::player" => qw(player)],
846	["cf::player" => qw(peaceful)],	1071	["cf::player" => qw(peaceful)],
		1072	["cf::map" => qw(trigger)],
847	) {	1073	) {
848	no strict 'refs';	1074	no strict 'refs';
849	my ($pkg, @funs) = @$_;	1075	my ($pkg, @funs) = @$_;
850	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1076	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
851	for @funs;	1077	for @funs;
…		…
961		1187
962	Immediately write the database to disk I<if it is dirty>.	1188	Immediately write the database to disk I<if it is dirty>.
963		1189
964	=cut	1190	=cut
965		1191
		1192	our $DB;
		1193
966	{	1194	{
967	my $db;
968	my $path = cf::localdir . "/database.pst";	1195	my $path = cf::localdir . "/database.pst";
969		1196
970	sub db_load() {	1197	sub db_load() {
971	warn "loading database $path\n";#d# remove later	1198	warn "loading database $path\n";#d# remove later
972	$db = stat $path ? Storable::retrieve $path : { };	1199	$DB = stat $path ? Storable::retrieve $path : { };
973	}	1200	}
974		1201
975	my $pid;	1202	my $pid;
976		1203
977	sub db_save() {	1204	sub db_save() {
978	warn "saving database $path\n";#d# remove later	1205	warn "saving database $path\n";#d# remove later
979	waitpid $pid, 0 if $pid;	1206	waitpid $pid, 0 if $pid;
980	if (0 == ($pid = fork)) {	1207	if (0 == ($pid = fork)) {
981	$db->{_meta}{version} = 1;	1208	$DB->{_meta}{version} = 1;
982	Storable::nstore $db, "$path~";	1209	Storable::nstore $DB, "$path~";
983	rename "$path~", $path;	1210	rename "$path~", $path;
984	cf::_exit 0 if defined $pid;	1211	cf::_exit 0 if defined $pid;
985	}	1212	}
986	}	1213	}
987		1214
…		…
990	sub db_sync() {	1217	sub db_sync() {
991	db_save if $dirty;	1218	db_save if $dirty;
992	undef $dirty;	1219	undef $dirty;
993	}	1220	}
994		1221
995	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 {
996	db_sync;	1223	db_sync;
997	});	1224	});
998		1225
999	sub db_dirty() {	1226	sub db_dirty() {
1000	$dirty = 1;	1227	$dirty = 1;
1001	$idle->start;	1228	$idle->start;
1002	}	1229	}
1003		1230
1004	sub db_get($;$) {	1231	sub db_get($;$) {
1005	@_ >= 2	1232	@_ >= 2
1006	? $db->{$_[0]}{$_[1]}	1233	? $DB->{$_[0]}{$_[1]}
1007	: ($db->{$_[0]} ||= { })	1234	: ($DB->{$_[0]} ||= { })
1008	}	1235	}
1009		1236
1010	sub db_put($$;$) {	1237	sub db_put($$;$) {
1011	if (@_ >= 3) {	1238	if (@_ >= 3) {
1012	$db->{$_[0]}{$_[1]} = $_[2];	1239	$DB->{$_[0]}{$_[1]} = $_[2];
1013	} else {	1240	} else {
1014	$db->{$_[0]} = $_[1];	1241	$DB->{$_[0]} = $_[1];
1015	}	1242	}
1016	db_dirty;	1243	db_dirty;
1017	}	1244	}
1018		1245
1019	attach_global	1246	cf::global->attach (
1020	prio => 10000,	1247	prio => 10000,
1021	on_cleanup => sub {	1248	on_cleanup => sub {
1022	db_sync;	1249	db_sync;
1023	},	1250	},
1024	;	1251	);
1025	}	1252	}
1026		1253
1027	#############################################################################	1254	#############################################################################
1028	# the server's main()	1255	# the server's main()
1029		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
1030	sub main {	1265	sub main {
		1266	cfg_load;
1031	db_load;	1267	db_load;
1032	load_extensions;	1268	load_extensions;
1033	Event::loop;	1269	Event::loop;
1034	}	1270	}
1035		1271
1036	#############################################################################	1272	#############################################################################
1037	# initialisation	1273	# initialisation
1038		1274
1039	sub _perl_reload(&) {	1275	sub _perl_reload() {
1040	my ($msg) = @_;	1276	warn "reloading...";
1041
1042	$msg->("reloading...");
1043		1277
1044	eval {	1278	eval {
		1279	local $FREEZE = 1;
		1280
		1281	cf::emergency_save;
		1282
1045	# cancel all watchers	1283	# cancel all watchers
1046	$_->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 = ();
1047		1291
1048	# unload all extensions	1292	# unload all extensions
1049	for (@exts) {	1293	for (@exts) {
1050	$msg->("unloading <$_>");	1294	warn "unloading <$_>";
1051	unload_extension $_;	1295	unload_extension $_;
1052	}	1296	}
1053		1297
1054	# unload all modules loaded from $LIBDIR	1298	# unload all modules loaded from $LIBDIR
1055	while (my ($k, $v) = each %INC) {	1299	while (my ($k, $v) = each %INC) {
1056	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1300	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1057		1301
1058	$msg->("removing <$k>");	1302	warn "removing <$k>";
1059	delete $INC{$k};	1303	delete $INC{$k};
1060		1304
1061	$k =~ s/\.pm$//;	1305	$k =~ s/\.pm$//;
1062	$k =~ s/\//::/g;	1306	$k =~ s/\//::/g;
1063		1307
…		…
1068	Symbol::delete_package $k;	1312	Symbol::delete_package $k;
1069	}	1313	}
1070		1314
1071	# sync database to disk	1315	# sync database to disk
1072	cf::db_sync;	1316	cf::db_sync;
		1317	IO::AIO::flush;
1073		1318
1074	# get rid of safe::, as good as possible	1319	# get rid of safe::, as good as possible
1075	Symbol::delete_package "safe::$_"	1320	Symbol::delete_package "safe::$_"
1076	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);
1077		1322
1078	# remove register_script_function callbacks	1323	# remove register_script_function callbacks
1079	# TODO	1324	# TODO
1080		1325
1081	# unload cf.pm "a bit"	1326	# unload cf.pm "a bit"
…		…
1084	# don't, removes xs symbols, too,	1329	# don't, removes xs symbols, too,
1085	# and global variables created in xs	1330	# and global variables created in xs
1086	#Symbol::delete_package __PACKAGE__;	1331	#Symbol::delete_package __PACKAGE__;
1087		1332
1088	# reload cf.pm	1333	# reload cf.pm
1089	$msg->("reloading cf.pm");	1334	warn "reloading cf.pm";
1090	require cf;	1335	require cf;
		1336	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1091		1337
1092	# load database again	1338	# load config and database again
		1339	cf::cfg_load;
1093	cf::db_load;	1340	cf::db_load;
1094		1341
1095	# load extensions	1342	# load extensions
1096	$msg->("load extensions");	1343	warn "load extensions";
1097	cf::load_extensions;	1344	cf::load_extensions;
1098		1345
1099	# reattach attachments to objects	1346	# reattach attachments to objects
1100	$msg->("reattach");	1347	warn "reattach";
1101	_global_reattach;	1348	_global_reattach;
1102	};	1349	};
1103	$msg->($@) if $@;	1350	warn $@ if $@;
1104		1351
1105	$msg->("reloaded");	1352	warn "reloaded";
1106	};	1353	};
1107		1354
1108	sub perl_reload() {	1355	sub perl_reload() {
1109	_perl_reload {	1356	_perl_reload;
1110	warn $_[0];
1111	print "$_[0]\n";
1112	};
1113	}	1357	}
1114		1358
		1359	register "<global>", __PACKAGE__;
		1360
1115	register_command "perl-reload", 0, sub {	1361	register_command "perl-reload" => sub {
1116	my ($who, $arg) = @_;	1362	my ($who, $arg) = @_;
1117		1363
1118	if ($who->flag (FLAG_WIZ)) {	1364	if ($who->flag (FLAG_WIZ)) {
		1365	$who->message ("reloading...");
1119	_perl_reload {	1366	_perl_reload;
1120	warn $_[0];
1121	$who->message ($_[0]);
1122	};
1123	}	1367	}
1124	};	1368	};
1125		1369
1126	register "<global>", __PACKAGE__;
1127
1128	unshift @INC, $LIBDIR;	1370	unshift @INC, $LIBDIR;
1129		1371
1130	$TICK_WATCHER = Event->timer (	1372	$TICK_WATCHER = Event->timer (
		1373	reentrant => 0,
1131	prio => 1,	1374	prio => 0,
1132	at => $NEXT_TICK || 1,	1375	at => $NEXT_TICK || $TICK,
		1376	data => WF_AUTOCANCEL,
1133	cb => sub {	1377	cb => sub {
		1378	unless ($FREEZE) {
1134	cf::server_tick; # one server iteration	1379	cf::server_tick; # one server iteration
		1380	$RUNTIME += $TICK;
		1381	}
1135		1382
1136	my $NOW = Event::time;
1137	$NEXT_TICK += $TICK;	1383	$NEXT_TICK += $TICK;
1138		1384
1139	# if we are delayed by four ticks, skip them all	1385	# if we are delayed by four ticks or more, skip them all
1140	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1386	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1141		1387
1142	$TICK_WATCHER->at ($NEXT_TICK);	1388	$TICK_WATCHER->at ($NEXT_TICK);
1143	$TICK_WATCHER->start;	1389	$TICK_WATCHER->start;
1144	},	1390	},
1145	);	1391	);
1146		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
1147	1	1410	1
1148		1411

Diff Legend

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