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.76 by root, Mon Oct 2 15:28:36 2006 UTC vs.
Revision 1.107 by root, Sun Dec 31 18:10:40 2006 UTC

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

Diff Legend

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