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.88 by root, Fri Dec 15 19:29:18 2006 UTC vs.
Revision 1.108 by root, Sun Dec 31 21:02:05 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 Digest::MD5;
		21	use Fcntl;
10	use IO::AIO ();	22	use IO::AIO 2.31 ();
11	use YAML::Syck ();	23	use YAML::Syck ();
12	use Time::HiRes;	24	use Time::HiRes;
13	use Event;	25
14	$Event::Eval = 1; # no idea why this is required, but it is	26	use Event; $Event::Eval = 1; # no idea why this is required, but it is
15		27
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	29	$YAML::Syck::ImplicitUnicode = 1;
18		30
19	use strict;	31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
20		32
21	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		34
23	our %COMMAND = ();	35	our %COMMAND = ();
24	our %COMMAND_TIME = ();	36	our %COMMAND_TIME = ();
25	our %EXTCMD = ();	37	our %EXTCMD = ();
26		38
27	_init_vars;
28
29	our @EVENT;	39	our @EVENT;
30	our $LIBDIR = datadir . "/ext";	40	our $LIBDIR = datadir . "/ext";
31		41
32	our $TICK = MAX_TIME * 1e-6;	42	our $TICK = MAX_TIME * 1e-6;
33	our $TICK_WATCHER;	43	our $TICK_WATCHER;
34	our $NEXT_TICK;	44	our $NEXT_TICK;
		45	our $NOW;
35		46
36	our %CFG;	47	our %CFG;
37		48
38	our $UPTIME; $UPTIME ||= time;	49	our $UPTIME; $UPTIME ||= time;
		50	our $RUNTIME;
		51
		52	our %MAP; # all maps
		53	our $LINK_MAP; # the special {link} map
		54	our $FREEZE;
		55	our $RANDOM_MAPS = cf::localdir . "/random";
		56	our %EXT_CORO;
		57
		58	binmode STDOUT;
		59	binmode STDERR;
		60
		61	# read virtual server time, if available
		62	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		63	open my $fh, "<", cf::localdir . "/runtime"
		64	or die "unable to read runtime file: $!";
		65	$RUNTIME = <$fh> + 0.;
		66	}
		67
		68	mkdir cf::localdir;
		69	mkdir cf::localdir . "/" . cf::playerdir;
		70	mkdir cf::localdir . "/" . cf::tmpdir;
		71	mkdir cf::localdir . "/" . cf::uniquedir;
		72	mkdir $RANDOM_MAPS;
		73
		74	# a special map that is always available
		75	our $LINK_MAP;
39		76
40	#############################################################################	77	#############################################################################
41		78
42	=head2 GLOBAL VARIABLES	79	=head2 GLOBAL VARIABLES
43		80
44	=over 4	81	=over 4
45		82
46	=item $cf::UPTIME	83	=item $cf::UPTIME
47		84
48	The timestamp of the server start (so not actually an uptime).	85	The timestamp of the server start (so not actually an uptime).
		86
		87	=item $cf::RUNTIME
		88
		89	The time this server has run, starts at 0 and is increased by $cf::TICK on
		90	every server tick.
49		91
50	=item $cf::LIBDIR	92	=item $cf::LIBDIR
51		93
52	The perl library directory, where extensions and cf-specific modules can	94	The perl library directory, where extensions and cf-specific modules can
53	be found. It will be added to C<@INC> automatically.	95	be found. It will be added to C<@INC> automatically.
		96
		97	=item $cf::NOW
		98
		99	The time of the last (current) server tick.
54		100
55	=item $cf::TICK	101	=item $cf::TICK
56		102
57	The interval between server ticks, in seconds.	103	The interval between server ticks, in seconds.
58		104
…		…
66	=cut	112	=cut
67		113
68	BEGIN {	114	BEGIN {
69	*CORE::GLOBAL::warn = sub {	115	*CORE::GLOBAL::warn = sub {
70	my $msg = join "", @_;	116	my $msg = join "", @_;
		117	utf8::encode $msg;
		118
71	$msg .= "\n"	119	$msg .= "\n"
72	unless $msg =~ /\n$/;	120	unless $msg =~ /\n$/;
73		121
74	print STDERR "cfperl: $msg";
75	LOG llevError, "cfperl: $msg";	122	LOG llevError, "cfperl: $msg";
76	};	123	};
77	}	124	}
78		125
		126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		127	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		128	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		129	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		130	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
79	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	131	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
80		132
81	# we bless all objects into (empty) derived classes to force a method lookup	133	# we bless all objects into (empty) derived classes to force a method lookup
82	# within the Safe compartment.	134	# within the Safe compartment.
83	for my $pkg (qw(	135	for my $pkg (qw(
		136	cf::global cf::attachable
84	cf::object cf::object::player	137	cf::object cf::object::player
85	cf::client_socket cf::player	138	cf::client cf::player
86	cf::arch cf::living	139	cf::arch cf::living
87	cf::map cf::party cf::region	140	cf::map cf::party cf::region
88	)) {	141	)) {
89	no strict 'refs';	142	no strict 'refs';
90	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	143	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
…		…
126	sub to_json($) {	179	sub to_json($) {
127	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
128	JSON::Syck::Dump $_[0]	181	JSON::Syck::Dump $_[0]
129	}	182	}
130		183
		184	=item cf::sync_job { BLOCK }
		185
		186	The design of crossfire+ requires that the main coro ($Coro::main) is
		187	always able to handle events or runnable, as crossfire+ is only partly
		188	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		189
		190	If it must be done, put the blocking parts into C<sync_job>. This will run
		191	the given BLOCK in another coroutine while waiting for the result. The
		192	server will be frozen during this time, so the block should either finish
		193	fast or be very important.
		194
		195	=cut
		196
		197	sub sync_job(&) {
		198	my ($job) = @_;
		199
		200	my $busy = 1;
		201	my @res;
		202
		203	# TODO: use suspend/resume instead
		204	local $FREEZE = 1;
		205
		206	my $coro = Coro::async {
		207	@res = eval { $job->() };
		208	warn $@ if $@;
		209	undef $busy;
		210	};
		211
		212	if ($Coro::current == $Coro::main) {
		213	$coro->prio (Coro::PRIO_MAX);
		214	while ($busy) {
		215	Coro::cede_notself;
		216	Event::one_event unless Coro::nready;
		217	}
		218	} else {
		219	$coro->join;
		220	}
		221
		222	wantarray ? @res : $res[0]
		223	}
		224
		225	=item $coro = cf::coro { BLOCK }
		226
		227	Creates and returns a new coro. This coro is automcatially being canceled
		228	when the extension calling this is being unloaded.
		229
		230	=cut
		231
		232	sub coro(&) {
		233	my $cb = shift;
		234
		235	my $coro; $coro = async {
		236	eval {
		237	$cb->();
		238	};
		239	warn $@ if $@;
		240	};
		241
		242	$coro->on_destroy (sub {
		243	delete $EXT_CORO{$coro+0};
		244	});
		245	$EXT_CORO{$coro+0} = $coro;
		246
		247	$coro
		248	}
		249
		250	sub write_runtime {
		251	my $runtime = cf::localdir . "/runtime";
		252
		253	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		254	or return;
		255
		256	my $value = $cf::RUNTIME;
		257	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		258	and return;
		259
		260	aio_fsync $fh
		261	and return;
		262
		263	close $fh
		264	or return;
		265
		266	aio_rename "$runtime~", $runtime
		267	and return;
		268
		269	1
		270	}
		271
131	=back	272	=back
132		273
133	=cut	274	=cut
134		275
135	#############################################################################	276	#############################################################################
136		277
137	=head2 EVENTS AND OBJECT ATTACHMENTS	278	package cf::path;
		279
		280	sub new {
		281	my ($class, $path, $base) = @_;
		282
		283	my $self = bless { }, $class;
		284
		285	if ($path =~ s{^\?random/}{}) {
		286	$self->{random} = cf::from_json $path;
		287	} else {
		288	if ($path =~ s{^~([^/]+)?}{}) {
		289	$self->{user_rel} = 1;
		290
		291	if (defined $1) {
		292	$self->{user} = $1;
		293	} elsif ($base =~ m{^~([^/]+)/}) {
		294	$self->{user} = $1;
		295	} else {
		296	warn "cannot resolve user-relative path without user <$path,$base>\n";
		297	}
		298	} elsif ($path =~ /^\//) {
		299	# already absolute
		300	} else {
		301	$base =~ s{[^/]+/?$}{};
		302	return $class->new ("$base/$path");
		303	}
		304
		305	for ($path) {
		306	redo if s{/\.?/}{/};
		307	redo if s{/[^/]+/\.\./}{/};
		308	}
		309	}
		310
		311	$self->{path} = $path;
		312
		313	$self
		314	}
		315
		316	# the name / primary key / in-game path
		317	sub as_string {
		318	my ($self) = @_;
		319
		320	$self->{user_rel} ? "~$self->{user}$self->{path}"
		321	: $self->{random} ? "?random/$self->{path}"
		322	: $self->{path}
		323	}
		324
		325	# the displayed name, this is a one way mapping
		326	sub visible_name {
		327	my ($self) = @_;
		328
		329	$self->{random} ? "?random/$self->{random}{origin_map}+$self->{random}{origin_x}+$self->{random}{origin_y}/$self->{random}{dungeon_level}"
		330	: $self->as_string
		331	}
		332
		333	# escape the /'s in the path
		334	sub _escaped_path {
		335	# ∕ is U+2215
		336	(my $path = $_[0]{path}) =~ s/\//∕/g;
		337	$path
		338	}
		339
		340	# the original (read-only) location
		341	sub load_path {
		342	my ($self) = @_;
		343
		344	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		345	}
		346
		347	# the temporary/swap location
		348	sub save_path {
		349	my ($self) = @_;
		350
		351	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
		352	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, Digest::MD5::md5_hex $self->{path}
		353	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
		354	}
		355
		356	# the unique path, might be eq to save_path
		357	sub uniq_path {
		358	my ($self) = @_;
		359
		360	$self->{user_rel} || $self->{random}
		361	? undef
		362	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
		363	}
		364
		365	# return random map parameters, or undef
		366	sub random_map_params {
		367	my ($self) = @_;
		368
		369	$self->{random}
		370	}
		371
		372	# this is somewhat ugly, but style maps do need special treatment
		373	sub is_style_map {
		374	$_[0]{path} =~ m{^/styles/}
		375	}
		376
		377	package cf;
		378
		379	#############################################################################
		380
		381	=head2 ATTACHABLE OBJECTS
		382
		383	Many objects in crossfire are so-called attachable objects. That means you can
		384	attach callbacks/event handlers (a collection of which is called an "attachment")
		385	to it. All such attachable objects support the following methods.
		386
		387	In the following description, CLASS can be any of C<global>, C<object>
		388	C<player>, C<client> or C<map> (i.e. the attachable objects in
		389	crossfire+).
138		390
139	=over 4	391	=over 4
140		392
141	=item $object->attach ($attachment, key => $value...)
142
143	=item $object->detach ($attachment)
144
145	Attach/detach a pre-registered attachment to an object.
146
147	=item $player->attach ($attachment, key => $value...)
148
149	=item $player->detach ($attachment)
150
151	Attach/detach a pre-registered attachment to a player.
152
153	=item $map->attach ($attachment, key => $value...)	393	=item $attachable->attach ($attachment, key => $value...)
154		394
155	=item $map->detach ($attachment)	395	=item $attachable->detach ($attachment)
156		396
157	Attach/detach a pre-registered attachment to a map.	397	Attach/detach a pre-registered attachment to a specific object and give it
		398	the specified key/value pairs as arguments.
158		399
159	=item $bool = $object->attached ($name)	400	Example, attach a minesweeper attachment to the given object, making it a
		401	10x10 minesweeper game:
160		402
161	=item $bool = $player->attached ($name)	403	$obj->attach (minesweeper => width => 10, height => 10);
162		404
163	=item $bool = $map->attached ($name)	405	=item $bool = $attachable->attached ($name)
164		406
165	Checks wether the named attachment is currently attached to the object.	407	Checks wether the named attachment is currently attached to the object.
166		408
167	=item cf::attach_global ...	409	=item cf::CLASS->attach ...
168		410
169	Attach handlers for global events.	411	=item cf::CLASS->detach ...
170		412
171	This and all following C<attach_*>-functions expect any number of the	413	Define an anonymous attachment and attach it to all objects of the given
172	following handler/hook descriptions:	414	CLASS. See the next function for an explanation of its arguments.
		415
		416	You can attach to global events by using the C<cf::global> class.
		417
		418	Example, log all player logins:
		419
		420	cf::player->attach (
		421	on_login => sub {
		422	my ($pl) = @_;
		423	...
		424	},
		425	);
		426
		427	Example, attach to the jeweler skill:
		428
		429	cf::object->attach (
		430	type => cf::SKILL,
		431	subtype => cf::SK_JEWELER,
		432	on_use_skill => sub {
		433	my ($sk, $ob, $part, $dir, $msg) = @_;
		434	...
		435	},
		436	);
		437
		438	=item cf::CLASS::attachment $name, ...
		439
		440	Register an attachment by C<$name> through which attachable objects of the
		441	given CLASS can refer to this attachment.
		442
		443	Some classes such as crossfire maps and objects can specify attachments
		444	that are attached at load/instantiate time, thus the need for a name.
		445
		446	These calls expect any number of the following handler/hook descriptions:
173		447
174	=over 4	448	=over 4
175		449
176	=item prio => $number	450	=item prio => $number
177		451
…		…
179	by another C<prio> setting). Lower priority handlers get executed	453	by another C<prio> setting). Lower priority handlers get executed
180	earlier. The default priority is C<0>, and many built-in handlers are	454	earlier. The default priority is C<0>, and many built-in handlers are
181	registered at priority C<-1000>, so lower priorities should not be used	455	registered at priority C<-1000>, so lower priorities should not be used
182	unless you know what you are doing.	456	unless you know what you are doing.
183		457
		458	=item type => $type
		459
		460	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		461	given type of objects only (the additional parameter C<subtype> can be
		462	used to further limit to the given subtype).
		463
184	=item on_I<event> => \&cb	464	=item on_I<event> => \&cb
185		465
186	Call the given code reference whenever the named event happens (event is	466	Call the given code reference whenever the named event happens (event is
187	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	467	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
188	handlers are recognised generally depends on the type of object these	468	handlers are recognised generally depends on the type of object these
…		…
197	package and register them. Only handlers for eevents supported by the	477	package and register them. Only handlers for eevents supported by the
198	object/class are recognised.	478	object/class are recognised.
199		479
200	=back	480	=back
201		481
202	=item cf::attach_to_type $object_type, $subtype, ...	482	Example, define an attachment called "sockpuppet" that calls the given
		483	event handler when a monster attacks:
203		484
204	Attach handlers for a specific object type (e.g. TRANSPORT) and	485	cf::object::attachment sockpuppet =>
205	subtype. If C<$subtype> is zero or undef, matches all objects of the given	486	on_skill_attack => sub {
206	type.	487	my ($self, $victim) = @_;
207		488	...
208	=item cf::attach_to_objects ...
209
210	Attach handlers to all objects. Do not use this except for debugging or
211	very rare events, as handlers are (obviously) called for I<all> objects in
212	the game.
213
214	=item cf::attach_to_players ...
215
216	Attach handlers to all players.
217
218	=item cf::attach_to_maps ...
219
220	Attach handlers to all maps.
221
222	=item cf:register_attachment $name, ...
223
224	Register an attachment by name through which objects can refer to this
225	attachment.
226
227	=item cf:register_player_attachment $name, ...
228
229	Register an attachment by name through which players can refer to this
230	attachment.
231
232	=item cf:register_map_attachment $name, ...
233
234	Register an attachment by name through which maps can refer to this
235	attachment.
236
237	=cut
238
239	# the following variables are defined in .xs and must not be re-created
240	our @CB_GLOBAL = (); # registry for all global events
241	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
242	our @CB_PLAYER = ();
243	our @CB_TYPE = (); # registry for type (cf-object class) based events
244	our @CB_MAP = ();
245
246	my %attachment;
247
248	sub _attach_cb($\%$$$) {
249	my ($registry, $undo, $event, $prio, $cb) = @_;
250
251	use sort 'stable';
252
253	$cb = [$prio, $cb];
254
255	@{$registry->[$event]} = sort
256	{ $a->[0] cmp $b->[0] }
257	@{$registry->[$event] || []}, $cb;
258
259	push @{$undo->{cb}}, [$event, $cb];
260	}
261
262	# attach handles attaching event callbacks
263	# the only thing the caller has to do is pass the correct
264	# registry (== where the callback attaches to).
265	sub _attach(\@$@) {
266	my ($registry, $klass, @arg) = @_;
267
268	my $prio = 0;
269
270	my %undo = (
271	registry => $registry,
272	cb => [],
273	);
274
275	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
276
277	while (@arg) {
278	my $type = shift @arg;
279
280	if ($type eq "prio") {
281	$prio = shift @arg;
282
283	} elsif ($type eq "package") {
284	my $pkg = shift @arg;
285
286	while (my ($name, $id) = each %cb_id) {
287	if (my $cb = $pkg->can ($name)) {
288	_attach_cb $registry, %undo, $id, $prio, $cb;
289	}
290	}	489	}
291
292	} elsif (exists $cb_id{$type}) {
293	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
294
295	} elsif (ref $type) {
296	warn "attaching objects not supported, ignoring.\n";
297
298	} else {
299	shift @arg;
300	warn "attach argument '$type' not supported, ignoring.\n";
301	}
302	}
303
304	\%undo
305	}
306
307	sub _attach_attachment {
308	my ($obj, $name, %arg) = @_;
309
310	return if exists $obj->{_attachment}{$name};
311
312	my $res;
313
314	if (my $attach = $attachment{$name}) {
315	my $registry = $obj->registry;
316
317	for (@$attach) {
318	my ($klass, @attach) = @$_;
319	$res = _attach @$registry, $klass, @attach;
320	}
321
322	$obj->{$name} = \%arg;
323	} else {
324	warn "object uses attachment '$name' that is not available, postponing.\n";
325	}
326
327	$obj->{_attachment}{$name} = undef;
328
329	$res->{attachment} = $name;
330	$res
331	}
332
333	*cf::object::attach =
334	*cf::player::attach =
335	*cf::map::attach = sub {
336	my ($obj, $name, %arg) = @_;
337
338	_attach_attachment $obj, $name, %arg;
339	};
340
341	# all those should be optimised
342	*cf::object::detach =
343	*cf::player::detach =
344	*cf::map::detach = sub {
345	my ($obj, $name) = @_;
346
347	delete $obj->{_attachment}{$name};
348	reattach ($obj);
349	};
350
351	*cf::object::attached =
352	*cf::player::attached =
353	*cf::map::attached = sub {
354	my ($obj, $name) = @_;
355
356	exists $obj->{_attachment}{$name}
357	};
358
359	sub attach_global {
360	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
361	}
362
363	sub attach_to_type {
364	my $type = shift;
365	my $subtype = shift;
366
367	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
368	}
369
370	sub attach_to_objects {
371	_attach @CB_OBJECT, KLASS_OBJECT, @_
372	}
373
374	sub attach_to_players {
375	_attach @CB_PLAYER, KLASS_PLAYER, @_
376	}
377
378	sub attach_to_maps {
379	_attach @CB_MAP, KLASS_MAP, @_
380	}
381
382	sub register_attachment {
383	my $name = shift;
384
385	$attachment{$name} = [[KLASS_OBJECT, @_]];
386	}
387
388	sub register_player_attachment {
389	my $name = shift;
390
391	$attachment{$name} = [[KLASS_PLAYER, @_]];
392	}
393
394	sub register_map_attachment {
395	my $name = shift;
396
397	$attachment{$name} = [[KLASS_MAP, @_]];
398	}
399
400	our $override;
401	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
402
403	sub override {
404	$override = 1;
405	@invoke_results = ();
406	}
407
408	sub do_invoke {
409	my $event = shift;
410	my $callbacks = shift;
411
412	@invoke_results = ();
413
414	local $override;
415
416	for (@$callbacks) {
417	eval { &{$_->[1]} };
418
419	if ($@) {
420	warn "$@";
421	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
422	override;
423	}
424
425	return 1 if $override;
426	}
427
428	0	490	}
429	}
430		491
431	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	492	=item $attachable->valid
432
433	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
434
435	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
436
437	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
438
439	Generate a global/object/player/map-specific event with the given arguments.
440
441	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
442	removed in future versions), and there is no public API to access override
443	results (if you must, access C<@cf::invoke_results> directly).
444
445	=back
446
447	=cut
448
449	#############################################################################
450
451	=head2 METHODS VALID FOR ALL CORE OBJECTS
452
453	=over 4
454
455	=item $object->valid, $player->valid, $map->valid
456		493
457	Just because you have a perl object does not mean that the corresponding	494	Just because you have a perl object does not mean that the corresponding
458	C-level object still exists. If you try to access an object that has no	495	C-level object still exists. If you try to access an object that has no
459	valid C counterpart anymore you get an exception at runtime. This method	496	valid C counterpart anymore you get an exception at runtime. This method
460	can be used to test for existence of the C object part without causing an	497	can be used to test for existence of the C object part without causing an
461	exception.	498	exception.
462		499
		500	=cut
		501
		502	# the following variables are defined in .xs and must not be re-created
		503	our @CB_GLOBAL = (); # registry for all global events
		504	our @CB_ATTACHABLE = (); # registry for all attachables
		505	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		506	our @CB_PLAYER = ();
		507	our @CB_CLIENT = ();
		508	our @CB_TYPE = (); # registry for type (cf-object class) based events
		509	our @CB_MAP = ();
		510
		511	my %attachment;
		512
		513	sub _attach_cb($$$$) {
		514	my ($registry, $event, $prio, $cb) = @_;
		515
		516	use sort 'stable';
		517
		518	$cb = [$prio, $cb];
		519
		520	@{$registry->[$event]} = sort
		521	{ $a->[0] cmp $b->[0] }
		522	@{$registry->[$event] || []}, $cb;
		523	}
		524
		525	# hack
		526	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		527
		528	# attach handles attaching event callbacks
		529	# the only thing the caller has to do is pass the correct
		530	# registry (== where the callback attaches to).
		531	sub _attach {
		532	my ($registry, $klass, @arg) = @_;
		533
		534	my $object_type;
		535	my $prio = 0;
		536	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		537
		538	#TODO: get rid of this hack
		539	if ($attachable_klass{$klass}) {
		540	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		541	}
		542
		543	while (@arg) {
		544	my $type = shift @arg;
		545
		546	if ($type eq "prio") {
		547	$prio = shift @arg;
		548
		549	} elsif ($type eq "type") {
		550	$object_type = shift @arg;
		551	$registry = $CB_TYPE[$object_type] ||= [];
		552
		553	} elsif ($type eq "subtype") {
		554	defined $object_type or Carp::croak "subtype specified without type";
		555	my $object_subtype = shift @arg;
		556	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		557
		558	} elsif ($type eq "package") {
		559	my $pkg = shift @arg;
		560
		561	while (my ($name, $id) = each %cb_id) {
		562	if (my $cb = $pkg->can ($name)) {
		563	_attach_cb $registry, $id, $prio, $cb;
		564	}
		565	}
		566
		567	} elsif (exists $cb_id{$type}) {
		568	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		569
		570	} elsif (ref $type) {
		571	warn "attaching objects not supported, ignoring.\n";
		572
		573	} else {
		574	shift @arg;
		575	warn "attach argument '$type' not supported, ignoring.\n";
		576	}
		577	}
		578	}
		579
		580	sub _object_attach {
		581	my ($obj, $name, %arg) = @_;
		582
		583	return if exists $obj->{_attachment}{$name};
		584
		585	if (my $attach = $attachment{$name}) {
		586	my $registry = $obj->registry;
		587
		588	for (@$attach) {
		589	my ($klass, @attach) = @$_;
		590	_attach $registry, $klass, @attach;
		591	}
		592
		593	$obj->{$name} = \%arg;
		594	} else {
		595	warn "object uses attachment '$name' that is not available, postponing.\n";
		596	}
		597
		598	$obj->{_attachment}{$name} = undef;
		599	}
		600
		601	sub cf::attachable::attach {
		602	if (ref $_[0]) {
		603	_object_attach @_;
		604	} else {
		605	_attach shift->_attach_registry, @_;
		606	}
		607	};
		608
		609	# all those should be optimised
		610	sub cf::attachable::detach {
		611	my ($obj, $name) = @_;
		612
		613	if (ref $obj) {
		614	delete $obj->{_attachment}{$name};
		615	reattach ($obj);
		616	} else {
		617	Carp::croak "cannot, currently, detach class attachments";
		618	}
		619	};
		620
		621	sub cf::attachable::attached {
		622	my ($obj, $name) = @_;
		623
		624	exists $obj->{_attachment}{$name}
		625	}
		626
		627	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		628	eval "#line " . __LINE__ . " 'cf.pm'
		629	sub cf::\L$klass\E::_attach_registry {
		630	(\\\@CB_$klass, KLASS_$klass)
		631	}
		632
		633	sub cf::\L$klass\E::attachment {
		634	my \$name = shift;
		635
		636	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		637	}
		638	";
		639	die if $@;
		640	}
		641
		642	our $override;
		643	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		644
		645	sub override {
		646	$override = 1;
		647	@invoke_results = ();
		648	}
		649
		650	sub do_invoke {
		651	my $event = shift;
		652	my $callbacks = shift;
		653
		654	@invoke_results = ();
		655
		656	local $override;
		657
		658	for (@$callbacks) {
		659	eval { &{$_->[1]} };
		660
		661	if ($@) {
		662	warn "$@";
		663	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		664	override;
		665	}
		666
		667	return 1 if $override;
		668	}
		669
		670	0
		671	}
		672
		673	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		674
		675	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		676
		677	Generate an object-specific event with the given arguments.
		678
		679	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		680	removed in future versions), and there is no public API to access override
		681	results (if you must, access C<@cf::invoke_results> directly).
		682
463	=back	683	=back
464		684
465	=cut	685	=cut
466
467	*cf::object::valid =
468	*cf::player::valid =
469	*cf::map::valid = \&cf::_valid;
470		686
471	#############################################################################	687	#############################################################################
472	# object support	688	# object support
473		689
474	sub instantiate {
475	my ($obj, $data) = @_;
476
477	$data = from_json $data;
478
479	for (@$data) {
480	my ($name, $args) = @$_;
481
482	$obj->attach ($name, %{$args || {} });
483	}
484	}
485
486	# basically do the same as instantiate, without calling instantiate
487	sub reattach {	690	sub reattach {
		691	# basically do the same as instantiate, without calling instantiate
488	my ($obj) = @_;	692	my ($obj) = @_;
		693
489	my $registry = $obj->registry;	694	my $registry = $obj->registry;
490		695
491	@$registry = ();	696	@$registry = ();
492		697
493	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	698	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
494		699
495	for my $name (keys %{ $obj->{_attachment} || {} }) {	700	for my $name (keys %{ $obj->{_attachment} || {} }) {
496	if (my $attach = $attachment{$name}) {	701	if (my $attach = $attachment{$name}) {
497	for (@$attach) {	702	for (@$attach) {
498	my ($klass, @attach) = @$_;	703	my ($klass, @attach) = @$_;
499	_attach @$registry, $klass, @attach;	704	_attach $registry, $klass, @attach;
500	}	705	}
501	} else {	706	} else {
502	warn "object uses attachment '$name' that is not available, postponing.\n";	707	warn "object uses attachment '$name' that is not available, postponing.\n";
503	}	708	}
504	}	709	}
505	}	710	}
506		711
507	sub object_freezer_save {	712	cf::attachable->attach (
508	my ($filename, $rdata, $objs) = @_;
509
510	if (length $$rdata) {
511	warn sprintf "saving %s (%d,%d)\n",
512	$filename, length $$rdata, scalar @$objs;
513
514	if (open my $fh, ">:raw", "$filename~") {
515	chmod SAVE_MODE, $fh;
516	syswrite $fh, $$rdata;
517	close $fh;
518
519	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
520	chmod SAVE_MODE, $fh;
521	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
522	close $fh;
523	rename "$filename.pst~", "$filename.pst";
524	} else {
525	unlink "$filename.pst";
526	}
527
528	rename "$filename~", $filename;
529	} else {
530	warn "FATAL: $filename~: $!\n";
531	}
532	} else {
533	unlink $filename;
534	unlink "$filename.pst";
535	}
536	}
537
538	sub object_freezer_as_string {
539	my ($rdata, $objs) = @_;
540
541	use Data::Dumper;
542
543	$$rdata . Dumper $objs
544	}
545
546	sub object_thawer_load {
547	my ($filename) = @_;
548
549	local $/;
550
551	my $av;
552
553	#TODO: use sysread etc.
554	if (open my $data, "<:raw:perlio", $filename) {
555	$data = <$data>;
556	if (open my $pst, "<:raw:perlio", "$filename.pst") {
557	$av = eval { (Storable::thaw <$pst>)->{objs} };
558	}
559	return ($data, $av);
560	}
561
562	()
563	}
564
565	attach_to_objects
566	prio => -1000000,	713	prio => -1000000,
		714	on_instantiate => sub {
		715	my ($obj, $data) = @_;
		716
		717	$data = from_json $data;
		718
		719	for (@$data) {
		720	my ($name, $args) = @$_;
		721
		722	$obj->attach ($name, %{$args || {} });
		723	}
		724	},
		725	on_reattach => \&reattach,
567	on_clone => sub {	726	on_clone => sub {
568	my ($src, $dst) = @_;	727	my ($src, $dst) = @_;
569		728
570	@{$dst->registry} = @{$src->registry};	729	@{$dst->registry} = @{$src->registry};
571		730
572	%$dst = %$src;	731	%$dst = %$src;
573		732
574	%{$dst->{_attachment}} = %{$src->{_attachment}}	733	%{$dst->{_attachment}} = %{$src->{_attachment}}
575	if exists $src->{_attachment};	734	if exists $src->{_attachment};
576	},	735	},
577	;	736	);
		737
		738	sub object_freezer_save {
		739	my ($filename, $rdata, $objs) = @_;
		740
		741	sync_job {
		742	if (length $$rdata) {
		743	warn sprintf "saving %s (%d,%d)\n",
		744	$filename, length $$rdata, scalar @$objs;
		745
		746	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		747	chmod SAVE_MODE, $fh;
		748	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		749	aio_fsync $fh;
		750	close $fh;
		751
		752	if (@$objs) {
		753	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		754	chmod SAVE_MODE, $fh;
		755	my $data = Storable::nfreeze { version => 1, objs => $objs };
		756	aio_write $fh, 0, (length $data), $data, 0;
		757	aio_fsync $fh;
		758	close $fh;
		759	aio_rename "$filename.pst~", "$filename.pst";
		760	}
		761	} else {
		762	aio_unlink "$filename.pst";
		763	}
		764
		765	aio_rename "$filename~", $filename;
		766	} else {
		767	warn "FATAL: $filename~: $!\n";
		768	}
		769	} else {
		770	aio_unlink $filename;
		771	aio_unlink "$filename.pst";
		772	}
		773	}
		774	}
		775
		776	sub object_freezer_as_string {
		777	my ($rdata, $objs) = @_;
		778
		779	use Data::Dumper;
		780
		781	$$rdata . Dumper $objs
		782	}
		783
		784	sub object_thawer_load {
		785	my ($filename) = @_;
		786
		787	my ($data, $av);
		788
		789	(aio_load $filename, $data) >= 0
		790	or return;
		791
		792	unless (aio_stat "$filename.pst") {
		793	(aio_load "$filename.pst", $av) >= 0
		794	or return;
		795	$av = eval { (Storable::thaw <$av>)->{objs} };
		796	}
		797
		798	return ($data, $av);
		799	}
578		800
579	#############################################################################	801	#############################################################################
580	# command handling &c	802	# command handling &c
581		803
582	=item cf::register_command $name => \&callback($ob,$args);	804	=item cf::register_command $name => \&callback($ob,$args);
…		…
611	#warn "registering extcmd '$name' to '$caller'";	833	#warn "registering extcmd '$name' to '$caller'";
612		834
613	$EXTCMD{$name} = [$cb, $caller];	835	$EXTCMD{$name} = [$cb, $caller];
614	}	836	}
615		837
616	attach_to_players	838	cf::player->attach (
617	on_command => sub {	839	on_command => sub {
618	my ($pl, $name, $params) = @_;	840	my ($pl, $name, $params) = @_;
619		841
620	my $cb = $COMMAND{$name}	842	my $cb = $COMMAND{$name}
621	or return;	843	or return;
…		…
641	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	863	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
642	}	864	}
643		865
644	cf::override;	866	cf::override;
645	},	867	},
646	;	868	);
647		869
648	sub register {	870	sub register {
649	my ($base, $pkg) = @_;	871	my ($base, $pkg) = @_;
650		872
651	#TODO	873	#TODO
…		…
741	defined $path or return;	963	defined $path or return;
742		964
743	unlink "$path.pst";	965	unlink "$path.pst";
744	};	966	};
745		967
746	attach_to_maps prio => -10000, package => cf::mapsupport::;	968	cf::map->attach (prio => -10000, package => cf::mapsupport::);
747		969
748	#############################################################################	970	#############################################################################
749	# load/save perl data associated with player->ob objects	971	# load/save perl data associated with player->ob objects
750		972
751	sub all_objects(@) {	973	sub all_objects(@) {
752	@_, map all_objects ($_->inv), @_	974	@_, map all_objects ($_->inv), @_
753	}	975	}
754		976
755	# TODO: compatibility cruft, remove when no longer needed	977	# TODO: compatibility cruft, remove when no longer needed
756	attach_to_players	978	cf::player->attach (
757	on_load => sub {	979	on_load => sub {
758	my ($pl, $path) = @_;	980	my ($pl, $path) = @_;
759		981
760	for my $o (all_objects $pl->ob) {	982	for my $o (all_objects $pl->ob) {
761	if (my $value = $o->get_ob_key_value ("_perl_data")) {	983	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
763		985
764	%$o = %{ Storable::thaw pack "H*", $value };	986	%$o = %{ Storable::thaw pack "H*", $value };
765	}	987	}
766	}	988	}
767	},	989	},
768	;	990	);
769		991
770	#############################################################################	992	#############################################################################
771		993
772	=head2 CORE EXTENSIONS	994	=head2 CORE EXTENSIONS
773		995
774	Functions and methods that extend core crossfire objects.	996	Functions and methods that extend core crossfire objects.
		997
		998	=head3 cf::player
775		999
776	=over 4	1000	=over 4
777		1001
778	=item cf::player::exists $login	1002	=item cf::player::exists $login
779		1003
…		…
784	sub cf::player::exists($) {	1008	sub cf::player::exists($) {
785	cf::player::find $_[0]	1009	cf::player::find $_[0]
786	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1010	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
787	}	1011	}
788		1012
		1013	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1014
		1015	Sends an ext reply to the player.
		1016
		1017	=cut
		1018
		1019	sub cf::player::ext_reply($$$%) {
		1020	my ($self, $id, %msg) = @_;
		1021
		1022	$msg{msgid} = $id;
		1023
		1024	$self->send ("ext " . to_json \%msg);
		1025	}
		1026
		1027	=back
		1028
		1029	=head3 cf::object::player
		1030
		1031	=over 4
		1032
789	=item $player_object->reply ($npc, $msg[, $flags])	1033	=item $player_object->reply ($npc, $msg[, $flags])
790		1034
791	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1035	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
792	can be C<undef>. Does the right thing when the player is currently in a	1036	can be C<undef>. Does the right thing when the player is currently in a
793	dialogue with the given NPC character.	1037	dialogue with the given NPC character.
794		1038
795	=cut	1039	=cut
796		1040
797	# rough implementation of a future "reply" method that works	1041	# rough implementation of a future "reply" method that works
798	# with dialog boxes.	1042	# with dialog boxes.
		1043	#TODO: the first argument must go, split into a $npc->reply_to ( method
799	sub cf::object::player::reply($$$;$) {	1044	sub cf::object::player::reply($$$;$) {
800	my ($self, $npc, $msg, $flags) = @_;	1045	my ($self, $npc, $msg, $flags) = @_;
801		1046
802	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1047	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
803		1048
…		…
807	$msg = $npc->name . " says: $msg" if $npc;	1052	$msg = $npc->name . " says: $msg" if $npc;
808	$self->message ($msg, $flags);	1053	$self->message ($msg, $flags);
809	}	1054	}
810	}	1055	}
811		1056
812	=item $player->ext_reply ($msgid, $msgtype, %msg)
813
814	Sends an ext reply to the player.
815
816	=cut
817
818	sub cf::player::ext_reply($$$%) {
819	my ($self, $id, %msg) = @_;
820
821	$msg{msgid} = $id;
822
823	$self->send ("ext " . to_json \%msg);
824	}
825
826	=item $player_object->may ("access")	1057	=item $player_object->may ("access")
827		1058
828	Returns wether the given player is authorized to access resource "access"	1059	Returns wether the given player is authorized to access resource "access"
829	(e.g. "command_wizcast").	1060	(e.g. "command_wizcast").
830		1061
…		…
837	(ref $cf::CFG{"may_$access"}	1068	(ref $cf::CFG{"may_$access"}
838	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1069	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
839	: $cf::CFG{"may_$access"})	1070	: $cf::CFG{"may_$access"})
840	}	1071	}
841		1072
842	=cut	1073	=head3 cf::client
843		1074
844	#############################################################################	1075	=over 4
		1076
		1077	=item $client->send_drawinfo ($text, $flags)
		1078
		1079	Sends a drawinfo packet to the client. Circumvents output buffering so
		1080	should not be used under normal circumstances.
		1081
		1082	=cut
		1083
		1084	sub cf::client::send_drawinfo {
		1085	my ($self, $text, $flags) = @_;
		1086
		1087	utf8::encode $text;
		1088	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1089	}
		1090
		1091
		1092	=item $success = $client->query ($flags, "text", \&cb)
		1093
		1094	Queues a query to the client, calling the given callback with
		1095	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1096	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1097
		1098	Queries can fail, so check the return code. Or don't, as queries will become
		1099	reliable at some point in the future.
		1100
		1101	=cut
		1102
		1103	sub cf::client::query {
		1104	my ($self, $flags, $text, $cb) = @_;
		1105
		1106	return unless $self->state == ST_PLAYING
		1107	|| $self->state == ST_SETUP
		1108	|| $self->state == ST_CUSTOM;
		1109
		1110	$self->state (ST_CUSTOM);
		1111
		1112	utf8::encode $text;
		1113	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1114
		1115	$self->send_packet ($self->{query_queue}[0][0])
		1116	if @{ $self->{query_queue} } == 1;
		1117	}
		1118
		1119	cf::client->attach (
		1120	on_reply => sub {
		1121	my ($ns, $msg) = @_;
		1122
		1123	# this weird shuffling is so that direct followup queries
		1124	# get handled first
		1125	my $queue = delete $ns->{query_queue};
		1126
		1127	(shift @$queue)->[1]->($msg);
		1128
		1129	push @{ $ns->{query_queue} }, @$queue;
		1130
		1131	if (@{ $ns->{query_queue} } == @$queue) {
		1132	if (@$queue) {
		1133	$ns->send_packet ($ns->{query_queue}[0][0]);
		1134	} else {
		1135	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1136	}
		1137	}
		1138	},
		1139	);
		1140
		1141	=item $client->coro (\&cb)
		1142
		1143	Create a new coroutine, running the specified callback. The coroutine will
		1144	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1145	or loss of connection).
		1146
		1147	=cut
		1148
		1149	sub cf::client::coro {
		1150	my ($self, $cb) = @_;
		1151
		1152	my $coro; $coro = async {
		1153	eval {
		1154	$cb->();
		1155	};
		1156	warn $@ if $@;
		1157	};
		1158
		1159	$coro->on_destroy (sub {
		1160	delete $self->{_coro}{$coro+0};
		1161	});
		1162
		1163	$self->{_coro}{$coro+0} = $coro;
		1164
		1165	$coro
		1166	}
		1167
		1168	cf::client->attach (
		1169	on_destroy => sub {
		1170	my ($ns) = @_;
		1171
		1172	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1173	},
		1174	);
		1175
		1176	=back
		1177
845		1178
846	=head2 SAFE SCRIPTING	1179	=head2 SAFE SCRIPTING
847		1180
848	Functions that provide a safe environment to compile and execute	1181	Functions that provide a safe environment to compile and execute
849	snippets of perl code without them endangering the safety of the server	1182	snippets of perl code without them endangering the safety of the server
…		…
864		1197
865	=pod	1198	=pod
866		1199
867	The following fucntions and emthods are available within a safe environment:	1200	The following fucntions and emthods are available within a safe environment:
868		1201
869	cf::object contr pay_amount pay_player	1202	cf::object contr pay_amount pay_player map
870	cf::object::player player	1203	cf::object::player player
871	cf::player peaceful	1204	cf::player peaceful
		1205	cf::map trigger
872		1206
873	=cut	1207	=cut
874		1208
875	for (	1209	for (
876	["cf::object" => qw(contr pay_amount pay_player)],	1210	["cf::object" => qw(contr pay_amount pay_player map)],
877	["cf::object::player" => qw(player)],	1211	["cf::object::player" => qw(player)],
878	["cf::player" => qw(peaceful)],	1212	["cf::player" => qw(peaceful)],
		1213	["cf::map" => qw(trigger)],
879	) {	1214	) {
880	no strict 'refs';	1215	no strict 'refs';
881	my ($pkg, @funs) = @$_;	1216	my ($pkg, @funs) = @$_;
882	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1217	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
883	for @funs;	1218	for @funs;
…		…
1047	$DB->{$_[0]} = $_[1];	1382	$DB->{$_[0]} = $_[1];
1048	}	1383	}
1049	db_dirty;	1384	db_dirty;
1050	}	1385	}
1051		1386
1052	attach_global	1387	cf::global->attach (
1053	prio => 10000,	1388	prio => 10000,
1054	on_cleanup => sub {	1389	on_cleanup => sub {
1055	db_sync;	1390	db_sync;
1056	},	1391	},
1057	;	1392	);
1058	}	1393	}
1059		1394
1060	#############################################################################	1395	#############################################################################
1061	# the server's main()	1396	# the server's main()
1062		1397
…		…
1067	local $/;	1402	local $/;
1068	*CFG = YAML::Syck::Load <$fh>;	1403	*CFG = YAML::Syck::Load <$fh>;
1069	}	1404	}
1070		1405
1071	sub main {	1406	sub main {
		1407	# we must not ever block the main coroutine
		1408	local $Coro::idle = sub {
		1409	Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
		1410	(Coro::unblock_sub {
		1411	Event::one_event;
		1412	})->();
		1413	};
		1414
1072	cfg_load;	1415	cfg_load;
1073	db_load;	1416	db_load;
1074	load_extensions;	1417	load_extensions;
1075	Event::loop;	1418	Event::loop;
1076	}	1419	}
1077		1420
1078	#############################################################################	1421	#############################################################################
1079	# initialisation	1422	# initialisation
1080		1423
1081	sub _perl_reload(&) {	1424	sub perl_reload() {
1082	my ($msg) = @_;	1425	# can/must only be called in main
		1426	if ($Coro::current != $Coro::main) {
		1427	warn "can only reload from main coroutine\n";
		1428	return;
		1429	}
1083		1430
1084	$msg->("reloading...");	1431	warn "reloading...";
		1432
		1433	local $FREEZE = 1;
		1434	cf::emergency_save;
1085		1435
1086	eval {	1436	eval {
		1437	# if anything goes wrong in here, we should simply crash as we already saved
		1438
1087	# cancel all watchers	1439	# cancel all watchers
1088	for (Event::all_watchers) {	1440	for (Event::all_watchers) {
1089	$_->cancel if $_->data & WF_AUTOCANCEL;	1441	$_->cancel if $_->data & WF_AUTOCANCEL;
1090	}	1442	}
1091		1443
		1444	# cancel all extension coros
		1445	$_->cancel for values %EXT_CORO;
		1446	%EXT_CORO = ();
		1447
1092	# unload all extensions	1448	# unload all extensions
1093	for (@exts) {	1449	for (@exts) {
1094	$msg->("unloading <$_>");	1450	warn "unloading <$_>";
1095	unload_extension $_;	1451	unload_extension $_;
1096	}	1452	}
1097		1453
1098	# unload all modules loaded from $LIBDIR	1454	# unload all modules loaded from $LIBDIR
1099	while (my ($k, $v) = each %INC) {	1455	while (my ($k, $v) = each %INC) {
1100	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1456	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1101		1457
1102	$msg->("removing <$k>");	1458	warn "removing <$k>";
1103	delete $INC{$k};	1459	delete $INC{$k};
1104		1460
1105	$k =~ s/\.pm$//;	1461	$k =~ s/\.pm$//;
1106	$k =~ s/\//::/g;	1462	$k =~ s/\//::/g;
1107		1463
…		…
1112	Symbol::delete_package $k;	1468	Symbol::delete_package $k;
1113	}	1469	}
1114		1470
1115	# sync database to disk	1471	# sync database to disk
1116	cf::db_sync;	1472	cf::db_sync;
		1473	IO::AIO::flush;
1117		1474
1118	# get rid of safe::, as good as possible	1475	# get rid of safe::, as good as possible
1119	Symbol::delete_package "safe::$_"	1476	Symbol::delete_package "safe::$_"
1120	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	1477	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1121		1478
1122	# remove register_script_function callbacks	1479	# remove register_script_function callbacks
1123	# TODO	1480	# TODO
1124		1481
1125	# unload cf.pm "a bit"	1482	# unload cf.pm "a bit"
…		…
1128	# don't, removes xs symbols, too,	1485	# don't, removes xs symbols, too,
1129	# and global variables created in xs	1486	# and global variables created in xs
1130	#Symbol::delete_package __PACKAGE__;	1487	#Symbol::delete_package __PACKAGE__;
1131		1488
1132	# reload cf.pm	1489	# reload cf.pm
1133	$msg->("reloading cf.pm");	1490	warn "reloading cf.pm";
1134	require cf;	1491	require cf;
		1492	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1135		1493
1136	# load config and database again	1494	# load config and database again
1137	cf::cfg_load;	1495	cf::cfg_load;
1138	cf::db_load;	1496	cf::db_load;
1139		1497
1140	# load extensions	1498	# load extensions
1141	$msg->("load extensions");	1499	warn "load extensions";
1142	cf::load_extensions;	1500	cf::load_extensions;
1143		1501
1144	# reattach attachments to objects	1502	# reattach attachments to objects
1145	$msg->("reattach");	1503	warn "reattach";
1146	_global_reattach;	1504	_global_reattach;
1147	};	1505	};
1148	$msg->($@) if $@;
1149		1506
1150	$msg->("reloaded");	1507	if ($@) {
		1508	warn $@;
		1509	warn "error while reloading, exiting.";
		1510	exit 1;
		1511	}
		1512
		1513	warn "reloaded successfully";
1151	};	1514	};
1152		1515
1153	sub perl_reload() {	1516	#############################################################################
1154	_perl_reload {	1517
1155	warn $_[0];	1518	unless ($LINK_MAP) {
1156	print "$_[0]\n";	1519	$LINK_MAP = cf::map::new;
1157	};	1520
		1521	$LINK_MAP->width (41);
		1522	$LINK_MAP->height (41);
		1523	$LINK_MAP->alloc;
		1524	$LINK_MAP->path ("{link}");
		1525	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		1526	$LINK_MAP->in_memory (MAP_IN_MEMORY);
1158	}	1527	}
1159		1528
1160	register "<global>", __PACKAGE__;	1529	register "<global>", __PACKAGE__;
1161		1530
1162	register_command "perl-reload" => sub {	1531	register_command "perl-reload" => sub {
1163	my ($who, $arg) = @_;	1532	my ($who, $arg) = @_;
1164		1533
1165	if ($who->flag (FLAG_WIZ)) {	1534	if ($who->flag (FLAG_WIZ)) {
		1535	$who->message ("start of reload.");
1166	_perl_reload {	1536	perl_reload;
1167	warn $_[0];	1537	$who->message ("end of reload.");
1168	$who->message ($_[0]);
1169	};
1170	}	1538	}
1171	};	1539	};
1172		1540
1173	unshift @INC, $LIBDIR;	1541	unshift @INC, $LIBDIR;
1174		1542
1175	$TICK_WATCHER = Event->timer (	1543	$TICK_WATCHER = Event->timer (
		1544	reentrant => 0,
1176	prio => 1,	1545	prio => 0,
1177	async => 1,
1178	at => $NEXT_TICK || 1,	1546	at => $NEXT_TICK || $TICK,
1179	data => WF_AUTOCANCEL,	1547	data => WF_AUTOCANCEL,
1180	cb => sub {	1548	cb => sub {
		1549	unless ($FREEZE) {
1181	cf::server_tick; # one server iteration	1550	cf::server_tick; # one server iteration
		1551	$RUNTIME += $TICK;
		1552	}
1182		1553
1183	my $NOW = Event::time;
1184	$NEXT_TICK += $TICK;	1554	$NEXT_TICK += $TICK;
1185		1555
1186	# if we are delayed by four ticks or more, skip them all	1556	# if we are delayed by four ticks or more, skip them all
1187	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1557	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1188		1558
1189	$TICK_WATCHER->at ($NEXT_TICK);	1559	$TICK_WATCHER->at ($NEXT_TICK);
1190	$TICK_WATCHER->start;	1560	$TICK_WATCHER->start;
1191	},	1561	},
1192	);	1562	);
1193		1563
1194	IO::AIO::max_poll_time $TICK * 0.2;	1564	IO::AIO::max_poll_time $TICK * 0.2;
1195		1565
		1566	Event->io (
1196	Event->io (fd => IO::AIO::poll_fileno,	1567	fd => IO::AIO::poll_fileno,
1197	poll => 'r',	1568	poll => 'r',
1198	prio => 5,	1569	prio => 5,
1199	data => WF_AUTOCANCEL,	1570	data => WF_AUTOCANCEL,
1200	cb => \&IO::AIO::poll_cb);	1571	cb => \&IO::AIO::poll_cb,
		1572	);
		1573
		1574	Event->timer (
		1575	data => WF_AUTOCANCEL,
		1576	after => 0,
		1577	interval => 10,
		1578	cb => sub {
		1579	(Coro::unblock_sub {
		1580	write_runtime
		1581	or warn "ERROR: unable to write runtime file: $!";
		1582	})->();
		1583	},
		1584	);
1201		1585
1202	1	1586	1
1203		1587

Diff Legend

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