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

Diff Legend

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