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.72 by root, Sun Oct 1 11:41:37 2006 UTC vs.
Revision 1.105 by root, Sun Dec 31 17:17:23 2006 UTC

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

Diff Legend

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