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

Diff Legend

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