[ViewVC] Diff of: cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.86 by root, Thu Dec 14 05:09:32 2006 UTC vs. Revision 1.109 by root, Sun Dec 31 22:23:12 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.86 by root, Thu Dec 14 05:09:32 2006 UTC vs.
Revision 1.109 by root, Sun Dec 31 22:23:12 2006 UTC