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.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
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	# 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
120	=back	234	=back
121		235
122	=cut	236	=cut
123		237
124	#############################################################################	238	#############################################################################
125		239
126	=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+).
127		249
128	=over 4	250	=over 4
129		251
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...)	252	=item $attachable->attach ($attachment, key => $value...)
143		253
144	=item $map->detach ($attachment)	254	=item $attachable->detach ($attachment)
145		255
146	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.
147		258
148	=item $bool = $object->attached ($name)	259	Example, attach a minesweeper attachment to the given object, making it a
		260	10x10 minesweeper game:
149		261
150	=item $bool = $player->attached ($name)	262	$obj->attach (minesweeper => width => 10, height => 10);
151		263
152	=item $bool = $map->attached ($name)	264	=item $bool = $attachable->attached ($name)
153		265
154	Checks wether the named attachment is currently attached to the object.	266	Checks wether the named attachment is currently attached to the object.
155		267
156	=item cf::attach_global ...	268	=item cf::CLASS->attach ...
157		269
158	Attach handlers for global events.	270	=item cf::CLASS->detach ...
159		271
160	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
161	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:
162		306
163	=over 4	307	=over 4
164		308
165	=item prio => $number	309	=item prio => $number
166		310
…		…
168	by another C<prio> setting). Lower priority handlers get executed	312	by another C<prio> setting). Lower priority handlers get executed
169	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
170	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
171	unless you know what you are doing.	315	unless you know what you are doing.
172		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
173	=item on_I<event> => \&cb	323	=item on_I<event> => \&cb
174		324
175	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
176	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
177	handlers are recognised generally depends on the type of object these	327	handlers are recognised generally depends on the type of object these
…		…
186	package and register them. Only handlers for eevents supported by the	336	package and register them. Only handlers for eevents supported by the
187	object/class are recognised.	337	object/class are recognised.
188		338
189	=back	339	=back
190		340
191	=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:
192		343
193	Attach handlers for a specific object type (e.g. TRANSPORT) and	344	cf::object::attachment sockpuppet =>
194	subtype. If C<$subtype> is zero or undef, matches all objects of the given	345	on_skill_attack => sub {
195	type.	346	my ($self, $victim) = @_;
196		347	...
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	}	348	}
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	349	}
418	}
419		350
420	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	351	=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		352
446	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
447	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
448	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
449	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
450	exception.	357	exception.
451		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
452	=back	542	=back
453		543
454	=cut	544	=cut
455
456	*cf::object::valid =
457	*cf::player::valid =
458	*cf::map::valid = \&cf::_valid;
459		545
460	#############################################################################	546	#############################################################################
461	# object support	547	# object support
462		548
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 {	549	sub reattach {
		550	# basically do the same as instantiate, without calling instantiate
477	my ($obj) = @_;	551	my ($obj) = @_;
		552
478	my $registry = $obj->registry;	553	my $registry = $obj->registry;
479		554
480	@$registry = ();	555	@$registry = ();
481		556
482	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	557	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
483		558
484	for my $name (keys %{ $obj->{_attachment} || {} }) {	559	for my $name (keys %{ $obj->{_attachment} || {} }) {
485	if (my $attach = $attachment{$name}) {	560	if (my $attach = $attachment{$name}) {
486	for (@$attach) {	561	for (@$attach) {
487	my ($klass, @attach) = @$_;	562	my ($klass, @attach) = @$_;
488	_attach @$registry, $klass, @attach;	563	_attach $registry, $klass, @attach;
489	}	564	}
490	} else {	565	} else {
491	warn "object uses attachment '$name' that is not available, postponing.\n";	566	warn "object uses attachment '$name' that is not available, postponing.\n";
492	}	567	}
493	}	568	}
494	}	569	}
495		570
496	sub object_freezer_save {	571	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,	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,
548	on_clone => sub {	585	on_clone => sub {
549	my ($src, $dst) = @_;	586	my ($src, $dst) = @_;
550		587
551	@{$dst->registry} = @{$src->registry};	588	@{$dst->registry} = @{$src->registry};
552		589
553	%$dst = %$src;	590	%$dst = %$src;
554		591
555	%{$dst->{_attachment}} = %{$src->{_attachment}}	592	%{$dst->{_attachment}} = %{$src->{_attachment}}
556	if exists $src->{_attachment};	593	if exists $src->{_attachment};
557	},	594	},
558	;	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	}
559		659
560	#############################################################################	660	#############################################################################
561	# old plug-in events	661	# command handling &c
562		662
563	sub inject_event {	663	=item cf::register_command $name => \&callback($ob,$args);
564	my $extension = shift;
565	my $event_code = shift;
566		664
567	my $cb = $hook[$event_code]{$extension}	665	Register a callback for execution when the client sends the user command
568	or return;	666	$name.
569		667
570	&$cb	668	=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		669
592	sub register_command {	670	sub register_command {
593	my ($name, $time, $cb) = @_;	671	my ($name, $cb) = @_;
594		672
595	my $caller = caller;	673	my $caller = caller;
596	#warn "registering command '$name/$time' to '$caller'";	674	#warn "registering command '$name/$time' to '$caller'";
597		675
598	push @{ $command{$name} }, [$time, $cb, $caller];	676	push @{ $COMMAND{$name} }, [$caller, $cb];
599	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
600	}	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
601		687
602	sub register_extcmd {	688	sub register_extcmd {
603	my ($name, $cb) = @_;	689	my ($name, $cb) = @_;
604		690
605	my $caller = caller;	691	my $caller = caller;
606	#warn "registering extcmd '$name' to '$caller'";	692	#warn "registering extcmd '$name' to '$caller'";
607		693
608	$extcmd{$name} = [$cb, $caller];	694	$EXTCMD{$name} = [$cb, $caller];
609	}	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	);
610		728
611	sub register {	729	sub register {
612	my ($base, $pkg) = @_;	730	my ($base, $pkg) = @_;
613		731
614	#TODO	732	#TODO
…		…
633	. "#line 1 \"$path\"\n{\n"	751	. "#line 1 \"$path\"\n{\n"
634	. (do { local $/; <$fh> })	752	. (do { local $/; <$fh> })
635	. "\n};\n1";	753	. "\n};\n1";
636		754
637	eval $source	755	eval $source
638	or die "$path: $@";	756	or die $@ ? "$path: $@\n"
		757	: "extension disabled.\n";
639		758
640	push @exts, $pkg;	759	push @exts, $pkg;
641	$ext_pkg{$base} = $pkg;	760	$ext_pkg{$base} = $pkg;
642		761
643	# no strict 'refs';	762	# no strict 'refs';
…		…
656	# for my $idx (0 .. $#PLUGIN_EVENT) {	775	# for my $idx (0 .. $#PLUGIN_EVENT) {
657	# delete $hook[$idx]{$pkg};	776	# delete $hook[$idx]{$pkg};
658	# }	777	# }
659		778
660	# remove commands	779	# remove commands
661	for my $name (keys %command) {	780	for my $name (keys %COMMAND) {
662	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	781	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
663		782
664	if (@cb) {	783	if (@cb) {
665	$command{$name} = \@cb;	784	$COMMAND{$name} = \@cb;
666	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
667	} else {	785	} else {
668	delete $command{$name};
669	delete $COMMAND{"$name\000"};	786	delete $COMMAND{$name};
670	}	787	}
671	}	788	}
672		789
673	# remove extcmds	790	# remove extcmds
674	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	791	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
675	delete $extcmd{$name};	792	delete $EXTCMD{$name};
676	}	793	}
677		794
678	if (my $cb = $pkg->can ("unload")) {	795	if (my $cb = $pkg->can ("unload")) {
679	eval {	796	eval {
680	$cb->($pkg);	797	$cb->($pkg);
…		…
684		801
685	Symbol::delete_package $pkg;	802	Symbol::delete_package $pkg;
686	}	803	}
687		804
688	sub load_extensions {	805	sub load_extensions {
689	my $LIBDIR = maps_directory "perl";
690
691	for my $ext (<$LIBDIR/*.ext>) {	806	for my $ext (<$LIBDIR/*.ext>) {
692	next unless -r $ext;	807	next unless -r $ext;
693	eval {	808	eval {
694	load_extension $ext;	809	load_extension $ext;
695	1	810	1
696	} or warn "$ext not loaded: $@";	811	} or warn "$ext not loaded: $@";
697	}	812	}
698	}	813	}
699		814
700	#############################################################################	815	#############################################################################
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	816	# load/save/clean perl data associated with a map
726		817
727	*cf::mapsupport::on_clean = sub {	818	*cf::mapsupport::on_clean = sub {
728	my ($map) = @_;	819	my ($map) = @_;
729		820
…		…
731	defined $path or return;	822	defined $path or return;
732		823
733	unlink "$path.pst";	824	unlink "$path.pst";
734	};	825	};
735		826
736	attach_to_maps prio => -10000, package => cf::mapsupport::;	827	cf::map->attach (prio => -10000, package => cf::mapsupport::);
737		828
738	#############################################################################	829	#############################################################################
739	# load/save perl data associated with player->ob objects	830	# load/save perl data associated with player->ob objects
740		831
741	sub all_objects(@) {	832	sub all_objects(@) {
742	@_, map all_objects ($_->inv), @_	833	@_, map all_objects ($_->inv), @_
743	}	834	}
744		835
745	# TODO: compatibility cruft, remove when no longer needed	836	# TODO: compatibility cruft, remove when no longer needed
746	attach_to_players	837	cf::player->attach (
747	on_load => sub {	838	on_load => sub {
748	my ($pl, $path) = @_;	839	my ($pl, $path) = @_;
749		840
750	for my $o (all_objects $pl->ob) {	841	for my $o (all_objects $pl->ob) {
751	if (my $value = $o->get_ob_key_value ("_perl_data")) {	842	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
753		844
754	%$o = %{ Storable::thaw pack "H*", $value };	845	%$o = %{ Storable::thaw pack "H*", $value };
755	}	846	}
756	}	847	}
757	},	848	},
758	;	849	);
759		850
760	#############################################################################	851	#############################################################################
761		852
762	=head2 CORE EXTENSIONS	853	=head2 CORE EXTENSIONS
763		854
764	Functions and methods that extend core crossfire objects.	855	Functions and methods that extend core crossfire objects.
		856
		857	=head3 cf::player
765		858
766	=over 4	859	=over 4
767		860
768	=item cf::player::exists $login	861	=item cf::player::exists $login
769		862
…		…
774	sub cf::player::exists($) {	867	sub cf::player::exists($) {
775	cf::player::find $_[0]	868	cf::player::find $_[0]
776	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;
777	}	870	}
778		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
779	=item $object->reply ($npc, $msg[, $flags])	892	=item $player_object->reply ($npc, $msg[, $flags])
780		893
781	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>
782	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
783	dialogue with the given NPC character.	896	dialogue with the given NPC character.
784		897
785	=cut	898	=cut
786		899
787	# rough implementation of a future "reply" method that works	900	# rough implementation of a future "reply" method that works
788	# with dialog boxes.	901	# with dialog boxes.
		902	#TODO: the first argument must go, split into a $npc->reply_to ( method
789	sub cf::object::player::reply($$$;$) {	903	sub cf::object::player::reply($$$;$) {
790	my ($self, $npc, $msg, $flags) = @_;	904	my ($self, $npc, $msg, $flags) = @_;
791		905
792	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	906	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
793		907
…		…
797	$msg = $npc->name . " says: $msg" if $npc;	911	$msg = $npc->name . " says: $msg" if $npc;
798	$self->message ($msg, $flags);	912	$self->message ($msg, $flags);
799	}	913	}
800	}	914	}
801		915
802	=item $player->ext_reply ($msgid, $msgtype, %msg)	916	=item $player_object->may ("access")
803		917
804	Sends an ext reply to the player.	918	Returns wether the given player is authorized to access resource "access"
		919	(e.g. "command_wizcast").
805		920
806	=cut	921	=cut
807		922
808	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 {
809	my ($self, $id, %msg) = @_;	1009	my ($self, $cb) = @_;
810		1010
811	$msg{msgid} = $id;	1011	my $coro; $coro = async {
		1012	eval {
		1013	$cb->();
		1014	};
		1015	warn $@ if $@;
		1016	};
812		1017
813	$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
814	}	1025	}
		1026
		1027	cf::client->attach (
		1028	on_destroy => sub {
		1029	my ($ns) = @_;
		1030
		1031	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1032	},
		1033	);
815		1034
816	=back	1035	=back
817		1036
818	=cut
819
820	#############################################################################
821		1037
822	=head2 SAFE SCRIPTING	1038	=head2 SAFE SCRIPTING
823		1039
824	Functions that provide a safe environment to compile and execute	1040	Functions that provide a safe environment to compile and execute
825	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
826	itself. Looping constructs, I/O operators and other built-in functionality	1042	itself. Looping constructs, I/O operators and other built-in functionality
827	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
828	functions and methods that cna be called is greatly reduced.	1044	functions and methods that can be called is greatly reduced.
829		1045
830	=cut	1046	=cut
831		1047
832	our $safe = new Safe "safe";	1048	our $safe = new Safe "safe";
833	our $safe_hole = new Safe::Hole;	1049	our $safe_hole = new Safe::Hole;
…		…
840		1056
841	=pod	1057	=pod
842		1058
843	The following fucntions and emthods are available within a safe environment:	1059	The following fucntions and emthods are available within a safe environment:
844		1060
845	cf::object contr pay_amount pay_player	1061	cf::object contr pay_amount pay_player map
846	cf::object::player player	1062	cf::object::player player
847	cf::player peaceful	1063	cf::player peaceful
		1064	cf::map trigger
848		1065
849	=cut	1066	=cut
850		1067
851	for (	1068	for (
852	["cf::object" => qw(contr pay_amount pay_player)],	1069	["cf::object" => qw(contr pay_amount pay_player map)],
853	["cf::object::player" => qw(player)],	1070	["cf::object::player" => qw(player)],
854	["cf::player" => qw(peaceful)],	1071	["cf::player" => qw(peaceful)],
		1072	["cf::map" => qw(trigger)],
855	) {	1073	) {
856	no strict 'refs';	1074	no strict 'refs';
857	my ($pkg, @funs) = @$_;	1075	my ($pkg, @funs) = @$_;
858	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1076	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
859	for @funs;	1077	for @funs;
…		…
969		1187
970	Immediately write the database to disk I<if it is dirty>.	1188	Immediately write the database to disk I<if it is dirty>.
971		1189
972	=cut	1190	=cut
973		1191
		1192	our $DB;
		1193
974	{	1194	{
975	my $db;
976	my $path = cf::localdir . "/database.pst";	1195	my $path = cf::localdir . "/database.pst";
977		1196
978	sub db_load() {	1197	sub db_load() {
979	warn "loading database $path\n";#d# remove later	1198	warn "loading database $path\n";#d# remove later
980	$db = stat $path ? Storable::retrieve $path : { };	1199	$DB = stat $path ? Storable::retrieve $path : { };
981	}	1200	}
982		1201
983	my $pid;	1202	my $pid;
984		1203
985	sub db_save() {	1204	sub db_save() {
986	warn "saving database $path\n";#d# remove later	1205	warn "saving database $path\n";#d# remove later
987	waitpid $pid, 0 if $pid;	1206	waitpid $pid, 0 if $pid;
988	if (0 == ($pid = fork)) {	1207	if (0 == ($pid = fork)) {
989	$db->{_meta}{version} = 1;	1208	$DB->{_meta}{version} = 1;
990	Storable::nstore $db, "$path~";	1209	Storable::nstore $DB, "$path~";
991	rename "$path~", $path;	1210	rename "$path~", $path;
992	cf::_exit 0 if defined $pid;	1211	cf::_exit 0 if defined $pid;
993	}	1212	}
994	}	1213	}
995		1214
…		…
998	sub db_sync() {	1217	sub db_sync() {
999	db_save if $dirty;	1218	db_save if $dirty;
1000	undef $dirty;	1219	undef $dirty;
1001	}	1220	}
1002		1221
1003	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 {
1004	db_sync;	1223	db_sync;
1005	});	1224	});
1006		1225
1007	sub db_dirty() {	1226	sub db_dirty() {
1008	$dirty = 1;	1227	$dirty = 1;
1009	$idle->start;	1228	$idle->start;
1010	}	1229	}
1011		1230
1012	sub db_get($;$) {	1231	sub db_get($;$) {
1013	@_ >= 2	1232	@_ >= 2
1014	? $db->{$_[0]}{$_[1]}	1233	? $DB->{$_[0]}{$_[1]}
1015	: ($db->{$_[0]} ||= { })	1234	: ($DB->{$_[0]} ||= { })
1016	}	1235	}
1017		1236
1018	sub db_put($$;$) {	1237	sub db_put($$;$) {
1019	if (@_ >= 3) {	1238	if (@_ >= 3) {
1020	$db->{$_[0]}{$_[1]} = $_[2];	1239	$DB->{$_[0]}{$_[1]} = $_[2];
1021	} else {	1240	} else {
1022	$db->{$_[0]} = $_[1];	1241	$DB->{$_[0]} = $_[1];
1023	}	1242	}
1024	db_dirty;	1243	db_dirty;
1025	}	1244	}
1026		1245
1027	attach_global	1246	cf::global->attach (
1028	prio => 10000,	1247	prio => 10000,
1029	on_cleanup => sub {	1248	on_cleanup => sub {
1030	db_sync;	1249	db_sync;
1031	},	1250	},
1032	;	1251	);
1033	}	1252	}
1034		1253
1035	#############################################################################	1254	#############################################################################
1036	# the server's main()	1255	# the server's main()
1037		1256
…		…
1051	}	1270	}
1052		1271
1053	#############################################################################	1272	#############################################################################
1054	# initialisation	1273	# initialisation
1055		1274
1056	sub _perl_reload(&) {	1275	sub _perl_reload() {
1057	my ($msg) = @_;	1276	warn "reloading...";
1058
1059	$msg->("reloading...");
1060		1277
1061	eval {	1278	eval {
		1279	local $FREEZE = 1;
		1280
		1281	cf::emergency_save;
		1282
1062	# cancel all watchers	1283	# cancel all watchers
1063	$_->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 = ();
1064		1291
1065	# unload all extensions	1292	# unload all extensions
1066	for (@exts) {	1293	for (@exts) {
1067	$msg->("unloading <$_>");	1294	warn "unloading <$_>";
1068	unload_extension $_;	1295	unload_extension $_;
1069	}	1296	}
1070		1297
1071	# unload all modules loaded from $LIBDIR	1298	# unload all modules loaded from $LIBDIR
1072	while (my ($k, $v) = each %INC) {	1299	while (my ($k, $v) = each %INC) {
1073	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1300	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1074		1301
1075	$msg->("removing <$k>");	1302	warn "removing <$k>";
1076	delete $INC{$k};	1303	delete $INC{$k};
1077		1304
1078	$k =~ s/\.pm$//;	1305	$k =~ s/\.pm$//;
1079	$k =~ s/\//::/g;	1306	$k =~ s/\//::/g;
1080		1307
…		…
1085	Symbol::delete_package $k;	1312	Symbol::delete_package $k;
1086	}	1313	}
1087		1314
1088	# sync database to disk	1315	# sync database to disk
1089	cf::db_sync;	1316	cf::db_sync;
		1317	IO::AIO::flush;
1090		1318
1091	# get rid of safe::, as good as possible	1319	# get rid of safe::, as good as possible
1092	Symbol::delete_package "safe::$_"	1320	Symbol::delete_package "safe::$_"
1093	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);
1094		1322
1095	# remove register_script_function callbacks	1323	# remove register_script_function callbacks
1096	# TODO	1324	# TODO
1097		1325
1098	# unload cf.pm "a bit"	1326	# unload cf.pm "a bit"
…		…
1101	# don't, removes xs symbols, too,	1329	# don't, removes xs symbols, too,
1102	# and global variables created in xs	1330	# and global variables created in xs
1103	#Symbol::delete_package __PACKAGE__;	1331	#Symbol::delete_package __PACKAGE__;
1104		1332
1105	# reload cf.pm	1333	# reload cf.pm
1106	$msg->("reloading cf.pm");	1334	warn "reloading cf.pm";
1107	require cf;	1335	require cf;
		1336	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1108		1337
1109	# load config and database again	1338	# load config and database again
1110	cf::cfg_load;	1339	cf::cfg_load;
1111	cf::db_load;	1340	cf::db_load;
1112		1341
1113	# load extensions	1342	# load extensions
1114	$msg->("load extensions");	1343	warn "load extensions";
1115	cf::load_extensions;	1344	cf::load_extensions;
1116		1345
1117	# reattach attachments to objects	1346	# reattach attachments to objects
1118	$msg->("reattach");	1347	warn "reattach";
1119	_global_reattach;	1348	_global_reattach;
1120	};	1349	};
1121	$msg->($@) if $@;	1350	warn $@ if $@;
1122		1351
1123	$msg->("reloaded");	1352	warn "reloaded";
1124	};	1353	};
1125		1354
1126	sub perl_reload() {	1355	sub perl_reload() {
1127	_perl_reload {	1356	_perl_reload;
1128	warn $_[0];
1129	print "$_[0]\n";
1130	};
1131	}	1357	}
1132		1358
		1359	register "<global>", __PACKAGE__;
		1360
1133	register_command "perl-reload", 0, sub {	1361	register_command "perl-reload" => sub {
1134	my ($who, $arg) = @_;	1362	my ($who, $arg) = @_;
1135		1363
1136	if ($who->flag (FLAG_WIZ)) {	1364	if ($who->flag (FLAG_WIZ)) {
		1365	$who->message ("reloading...");
1137	_perl_reload {	1366	_perl_reload;
1138	warn $_[0];
1139	$who->message ($_[0]);
1140	};
1141	}	1367	}
1142	};	1368	};
1143		1369
1144	register "<global>", __PACKAGE__;
1145
1146	unshift @INC, $LIBDIR;	1370	unshift @INC, $LIBDIR;
1147		1371
1148	$TICK_WATCHER = Event->timer (	1372	$TICK_WATCHER = Event->timer (
		1373	reentrant => 0,
1149	prio => 1,	1374	prio => 0,
1150	at => $NEXT_TICK || 1,	1375	at => $NEXT_TICK || $TICK,
		1376	data => WF_AUTOCANCEL,
1151	cb => sub {	1377	cb => sub {
		1378	unless ($FREEZE) {
1152	cf::server_tick; # one server iteration	1379	cf::server_tick; # one server iteration
		1380	$RUNTIME += $TICK;
		1381	}
1153		1382
1154	my $NOW = Event::time;
1155	$NEXT_TICK += $TICK;	1383	$NEXT_TICK += $TICK;
1156		1384
1157	# if we are delayed by four ticks, skip them all	1385	# if we are delayed by four ticks or more, skip them all
1158	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1386	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1159		1387
1160	$TICK_WATCHER->at ($NEXT_TICK);	1388	$TICK_WATCHER->at ($NEXT_TICK);
1161	$TICK_WATCHER->start;	1389	$TICK_WATCHER->start;
1162	},	1390	},
1163	);	1391	);
1164		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
1165	1	1410	1
1166		1411

Diff Legend

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