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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.72 by root, Sun Oct 1 11:41:37 2006 UTC vs.
Revision 1.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;
		22	use IO::AIO 2.31 ();
10	use YAML::Syck ();	23	use YAML::Syck ();
11	use Time::HiRes;	24	use Time::HiRes;
12	use Event;	25
13	$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
14		27
15	# 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?
16	$YAML::Syck::ImplicitUnicode = 1;	29	$YAML::Syck::ImplicitUnicode = 1;
17		30
18	use strict;	31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
19		32
20	_init_vars;	33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
21		34
22	our %COMMAND = ();	35	our %COMMAND = ();
		36	our %COMMAND_TIME = ();
		37	our %EXTCMD = ();
		38
23	our @EVENT;	39	our @EVENT;
24	our $LIBDIR = maps_directory "perl";	40	our $LIBDIR = datadir . "/ext";
25		41
26	our $TICK = MAX_TIME * 1e-6;	42	our $TICK = MAX_TIME * 1e-6;
27	our $TICK_WATCHER;	43	our $TICK_WATCHER;
28	our $NEXT_TICK;	44	our $NEXT_TICK;
		45	our $NOW;
29		46
30	our %CFG;	47	our %CFG;
31		48
		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;
		76
32	#############################################################################	77	#############################################################################
33		78
34	=head2 GLOBAL VARIABLES	79	=head2 GLOBAL VARIABLES
35		80
36	=over 4	81	=over 4
		82
		83	=item $cf::UPTIME
		84
		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.
37		91
38	=item $cf::LIBDIR	92	=item $cf::LIBDIR
39		93
40	The perl library directory, where extensions and cf-specific modules can	94	The perl library directory, where extensions and cf-specific modules can
41	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.
42		100
43	=item $cf::TICK	101	=item $cf::TICK
44		102
45	The interval between server ticks, in seconds.	103	The interval between server ticks, in seconds.
46		104
54	=cut	112	=cut
55		113
56	BEGIN {	114	BEGIN {
57	*CORE::GLOBAL::warn = sub {	115	*CORE::GLOBAL::warn = sub {
58	my $msg = join "", @_;	116	my $msg = join "", @_;
		117	utf8::encode $msg;
		118
59	$msg .= "\n"	119	$msg .= "\n"
60	unless $msg =~ /\n$/;	120	unless $msg =~ /\n$/;
61		121
62	print STDERR "cfperl: $msg";
63	LOG llevError, "cfperl: $msg";	122	LOG llevError, "cfperl: $msg";
64	};	123	};
65	}	124	}
66		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';
67	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	131	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
68		132
69	# 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
70	# within the Safe compartment.	134	# within the Safe compartment.
71	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	135	for my $pkg (qw(
		136	cf::global cf::attachable
		137	cf::object cf::object::player
		138	cf::client cf::player
		139	cf::arch cf::living
		140	cf::map cf::party cf::region
		141	)) {
72	no strict 'refs';	142	no strict 'refs';
73	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	143	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
74	}	144	}
75		145
76	$Event::DIED = sub {	146	$Event::DIED = sub {
…		…
78	};	148	};
79		149
80	my %ext_pkg;	150	my %ext_pkg;
81	my @exts;	151	my @exts;
82	my @hook;	152	my @hook;
83	my %command;
84	my %extcmd;
85		153
86	=head2 UTILITY FUNCTIONS	154	=head2 UTILITY FUNCTIONS
87		155
88	=over 4	156	=over 4
89		157
…		…
111	sub to_json($) {	179	sub to_json($) {
112	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
113	JSON::Syck::Dump $_[0]	181	JSON::Syck::Dump $_[0]
114	}	182	}
115		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
116	=back	272	=back
117		273
118	=cut	274	=cut
119		275
120	#############################################################################	276	#############################################################################
121		277
122	=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+).
123		390
124	=over 4	391	=over 4
125		392
126	=item $object->attach ($attachment, key => $value...)
127
128	=item $object->detach ($attachment)
129
130	Attach/detach a pre-registered attachment to an object.
131
132	=item $player->attach ($attachment, key => $value...)
133
134	=item $player->detach ($attachment)
135
136	Attach/detach a pre-registered attachment to a player.
137
138	=item $map->attach ($attachment, key => $value...)	393	=item $attachable->attach ($attachment, key => $value...)
139		394
140	=item $map->detach ($attachment)	395	=item $attachable->detach ($attachment)
141		396
142	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.
143		399
144	=item $bool = $object->attached ($name)	400	Example, attach a minesweeper attachment to the given object, making it a
		401	10x10 minesweeper game:
145		402
146	=item $bool = $player->attached ($name)	403	$obj->attach (minesweeper => width => 10, height => 10);
147		404
148	=item $bool = $map->attached ($name)	405	=item $bool = $attachable->attached ($name)
149		406
150	Checks wether the named attachment is currently attached to the object.	407	Checks wether the named attachment is currently attached to the object.
151		408
152	=item cf::attach_global ...	409	=item cf::CLASS->attach ...
153		410
154	Attach handlers for global events.	411	=item cf::CLASS->detach ...
155		412
156	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
157	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:
158		447
159	=over 4	448	=over 4
160		449
161	=item prio => $number	450	=item prio => $number
162		451
…		…
164	by another C<prio> setting). Lower priority handlers get executed	453	by another C<prio> setting). Lower priority handlers get executed
165	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
166	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
167	unless you know what you are doing.	456	unless you know what you are doing.
168		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
169	=item on_I<event> => \&cb	464	=item on_I<event> => \&cb
170		465
171	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
172	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
173	handlers are recognised generally depends on the type of object these	468	handlers are recognised generally depends on the type of object these
…		…
182	package and register them. Only handlers for eevents supported by the	477	package and register them. Only handlers for eevents supported by the
183	object/class are recognised.	478	object/class are recognised.
184		479
185	=back	480	=back
186		481
187	=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:
188		484
189	Attach handlers for a specific object type (e.g. TRANSPORT) and	485	cf::object::attachment sockpuppet =>
190	subtype. If C<$subtype> is zero or undef, matches all objects of the given	486	on_skill_attack => sub {
191	type.	487	my ($self, $victim) = @_;
192		488	...
193	=item cf::attach_to_objects ...
194
195	Attach handlers to all objects. Do not use this except for debugging or
196	very rare events, as handlers are (obviously) called for I<all> objects in
197	the game.
198
199	=item cf::attach_to_players ...
200
201	Attach handlers to all players.
202
203	=item cf::attach_to_maps ...
204
205	Attach handlers to all maps.
206
207	=item cf:register_attachment $name, ...
208
209	Register an attachment by name through which objects can refer to this
210	attachment.
211
212	=item cf:register_player_attachment $name, ...
213
214	Register an attachment by name through which players can refer to this
215	attachment.
216
217	=item cf:register_map_attachment $name, ...
218
219	Register an attachment by name through which maps can refer to this
220	attachment.
221
222	=cut
223
224	# the following variables are defined in .xs and must not be re-created
225	our @CB_GLOBAL = (); # registry for all global events
226	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
227	our @CB_PLAYER = ();
228	our @CB_TYPE = (); # registry for type (cf-object class) based events
229	our @CB_MAP = ();
230
231	my %attachment;
232
233	sub _attach_cb($\%$$$) {
234	my ($registry, $undo, $event, $prio, $cb) = @_;
235
236	use sort 'stable';
237
238	$cb = [$prio, $cb];
239
240	@{$registry->[$event]} = sort
241	{ $a->[0] cmp $b->[0] }
242	@{$registry->[$event] \|\| []}, $cb;
243
244	push @{$undo->{cb}}, [$event, $cb];
245	}
246
247	# attach handles attaching event callbacks
248	# the only thing the caller has to do is pass the correct
249	# registry (== where the callback attaches to).
250	sub _attach(\@$@) {
251	my ($registry, $klass, @arg) = @_;
252
253	my $prio = 0;
254
255	my %undo = (
256	registry => $registry,
257	cb => [],
258	);
259
260	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
261
262	while (@arg) {
263	my $type = shift @arg;
264
265	if ($type eq "prio") {
266	$prio = shift @arg;
267
268	} elsif ($type eq "package") {
269	my $pkg = shift @arg;
270
271	while (my ($name, $id) = each %cb_id) {
272	if (my $cb = $pkg->can ($name)) {
273	_attach_cb $registry, %undo, $id, $prio, $cb;
274	}
275	}	489	}
276
277	} elsif (exists $cb_id{$type}) {
278	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
279
280	} elsif (ref $type) {
281	warn "attaching objects not supported, ignoring.\n";
282
283	} else {
284	shift @arg;
285	warn "attach argument '$type' not supported, ignoring.\n";
286	}
287	}
288
289	\%undo
290	}
291
292	sub _attach_attachment {
293	my ($obj, $name, %arg) = @_;
294
295	return if exists $obj->{_attachment}{$name};
296
297	my $res;
298
299	if (my $attach = $attachment{$name}) {
300	my $registry = $obj->registry;
301
302	for (@$attach) {
303	my ($klass, @attach) = @$_;
304	$res = _attach @$registry, $klass, @attach;
305	}
306
307	$obj->{$name} = \%arg;
308	} else {
309	warn "object uses attachment '$name' that is not available, postponing.\n";
310	}
311
312	$obj->{_attachment}{$name} = undef;
313
314	$res->{attachment} = $name;
315	$res
316	}
317
318	*cf::object::attach =
319	*cf::player::attach =
320	*cf::map::attach = sub {
321	my ($obj, $name, %arg) = @_;
322
323	_attach_attachment $obj, $name, %arg;
324	};
325
326	# all those should be optimised
327	*cf::object::detach =
328	*cf::player::detach =
329	*cf::map::detach = sub {
330	my ($obj, $name) = @_;
331
332	delete $obj->{_attachment}{$name};
333	reattach ($obj);
334	};
335
336	*cf::object::attached =
337	*cf::player::attached =
338	*cf::map::attached = sub {
339	my ($obj, $name) = @_;
340
341	exists $obj->{_attachment}{$name}
342	};
343
344	sub attach_global {
345	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
346	}
347
348	sub attach_to_type {
349	my $type = shift;
350	my $subtype = shift;
351
352	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
353	}
354
355	sub attach_to_objects {
356	_attach @CB_OBJECT, KLASS_OBJECT, @_
357	}
358
359	sub attach_to_players {
360	_attach @CB_PLAYER, KLASS_PLAYER, @_
361	}
362
363	sub attach_to_maps {
364	_attach @CB_MAP, KLASS_MAP, @_
365	}
366
367	sub register_attachment {
368	my $name = shift;
369
370	$attachment{$name} = [[KLASS_OBJECT, @_]];
371	}
372
373	sub register_player_attachment {
374	my $name = shift;
375
376	$attachment{$name} = [[KLASS_PLAYER, @_]];
377	}
378
379	sub register_map_attachment {
380	my $name = shift;
381
382	$attachment{$name} = [[KLASS_MAP, @_]];
383	}
384
385	our $override;
386	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
387
388	sub override {
389	$override = 1;
390	@invoke_results = ();
391	}
392
393	sub do_invoke {
394	my $event = shift;
395	my $callbacks = shift;
396
397	@invoke_results = ();
398
399	local $override;
400
401	for (@$callbacks) {
402	eval { &{$_->[1]} };
403
404	if ($@) {
405	warn "$@";
406	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
407	override;
408	}
409
410	return 1 if $override;
411	}
412
413	0	490	}
414	}
415		491
416	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	492	=item $attachable->valid
417
418	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
419
420	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
421
422	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
423
424	Generate a global/object/player/map-specific event with the given arguments.
425
426	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
427	removed in future versions), and there is no public API to access override
428	results (if you must, access C<@cf::invoke_results> directly).
429
430	=back
431
432	=cut
433
434	#############################################################################
435
436	=head2 METHODS VALID FOR ALL CORE OBJECTS
437
438	=over 4
439
440	=item $object->valid, $player->valid, $map->valid
441		493
442	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
443	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
444	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
445	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
446	exception.	498	exception.
447		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
448	=back	683	=back
449		684
450	=cut	685	=cut
451
452	*cf::object::valid =
453	*cf::player::valid =
454	*cf::map::valid = \&cf::_valid;
455		686
456	#############################################################################	687	#############################################################################
457	# object support	688	# object support
458		689
459	sub instantiate {
460	my ($obj, $data) = @_;
461
462	$data = from_json $data;
463
464	for (@$data) {
465	my ($name, $args) = @$_;
466
467	$obj->attach ($name, %{$args \|\| {} });
468	}
469	}
470
471	# basically do the same as instantiate, without calling instantiate
472	sub reattach {	690	sub reattach {
		691	# basically do the same as instantiate, without calling instantiate
473	my ($obj) = @_;	692	my ($obj) = @_;
		693
474	my $registry = $obj->registry;	694	my $registry = $obj->registry;
475		695
476	@$registry = ();	696	@$registry = ();
477		697
478	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };	698	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
479		699
480	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {	700	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
481	if (my $attach = $attachment{$name}) {	701	if (my $attach = $attachment{$name}) {
482	for (@$attach) {	702	for (@$attach) {
483	my ($klass, @attach) = @$_;	703	my ($klass, @attach) = @$_;
484	_attach @$registry, $klass, @attach;	704	_attach $registry, $klass, @attach;
485	}	705	}
486	} else {	706	} else {
487	warn "object uses attachment '$name' that is not available, postponing.\n";	707	warn "object uses attachment '$name' that is not available, postponing.\n";
488	}	708	}
489	}	709	}
490	}	710	}
491		711
492	sub object_freezer_save {	712	cf::attachable->attach (
493	my ($filename, $rdata, $objs) = @_;
494
495	if (length $$rdata) {
496	warn sprintf "saving %s (%d,%d)\n",
497	$filename, length $$rdata, scalar @$objs;
498
499	if (open my $fh, ">:raw", "$filename~") {
500	chmod SAVE_MODE, $fh;
501	syswrite $fh, $$rdata;
502	close $fh;
503
504	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
505	chmod SAVE_MODE, $fh;
506	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
507	close $fh;
508	rename "$filename.pst~", "$filename.pst";
509	} else {
510	unlink "$filename.pst";
511	}
512
513	rename "$filename~", $filename;
514	} else {
515	warn "FATAL: $filename~: $!\n";
516	}
517	} else {
518	unlink $filename;
519	unlink "$filename.pst";
520	}
521	}
522
523	sub object_thawer_load {
524	my ($filename) = @_;
525
526	local $/;
527
528	my $av;
529
530	#TODO: use sysread etc.
531	if (open my $data, "<:raw:perlio", $filename) {
532	$data = <$data>;
533	if (open my $pst, "<:raw:perlio", "$filename.pst") {
534	$av = eval { (Storable::thaw <$pst>)->{objs} };
535	}
536	return ($data, $av);
537	}
538
539	()
540	}
541
542	attach_to_objects
543	prio => -1000000,	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,
544	on_clone => sub {	726	on_clone => sub {
545	my ($src, $dst) = @_;	727	my ($src, $dst) = @_;
546		728
547	@{$dst->registry} = @{$src->registry};	729	@{$dst->registry} = @{$src->registry};
548		730
549	%$dst = %$src;	731	%$dst = %$src;
550		732
551	%{$dst->{_attachment}} = %{$src->{_attachment}}	733	%{$dst->{_attachment}} = %{$src->{_attachment}}
552	if exists $src->{_attachment};	734	if exists $src->{_attachment};
553	},	735	},
554	;	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	}
555		800
556	#############################################################################	801	#############################################################################
557	# old plug-in events	802	# command handling &c
558		803
559	sub inject_event {	804	=item cf::register_command $name => \&callback($ob,$args);
560	my $extension = shift;
561	my $event_code = shift;
562		805
563	my $cb = $hook[$event_code]{$extension}	806	Register a callback for execution when the client sends the user command
564	or return;	807	$name.
565		808
566	&$cb	809	=cut
567	}
568
569	sub inject_global_event {
570	my $event = shift;
571
572	my $cb = $hook[$event]
573	or return;
574
575	List::Util::max map &$_, values %$cb
576	}
577
578	sub inject_command {
579	my ($name, $obj, $params) = @_;
580
581	for my $cmd (@{ $command{$name} }) {
582	$cmd->[1]->($obj, $params);
583	}
584
585	-1
586	}
587		810
588	sub register_command {	811	sub register_command {
589	my ($name, $time, $cb) = @_;	812	my ($name, $cb) = @_;
590		813
591	my $caller = caller;	814	my $caller = caller;
592	#warn "registering command '$name/$time' to '$caller'";	815	#warn "registering command '$name/$time' to '$caller'";
593		816
594	push @{ $command{$name} }, [$time, $cb, $caller];	817	push @{ $COMMAND{$name} }, [$caller, $cb];
595	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
596	}	818	}
		819
		820	=item cf::register_extcmd $name => \&callback($pl,$packet);
		821
		822	Register a callbackf ro execution when the client sends an extcmd packet.
		823
		824	If the callback returns something, it is sent back as if reply was being
		825	called.
		826
		827	=cut
597		828
598	sub register_extcmd {	829	sub register_extcmd {
599	my ($name, $cb) = @_;	830	my ($name, $cb) = @_;
600		831
601	my $caller = caller;	832	my $caller = caller;
602	#warn "registering extcmd '$name' to '$caller'";	833	#warn "registering extcmd '$name' to '$caller'";
603		834
604	$extcmd{$name} = [$cb, $caller];	835	$EXTCMD{$name} = [$cb, $caller];
605	}	836	}
		837
		838	cf::player->attach (
		839	on_command => sub {
		840	my ($pl, $name, $params) = @_;
		841
		842	my $cb = $COMMAND{$name}
		843	or return;
		844
		845	for my $cmd (@$cb) {
		846	$cmd->[1]->($pl->ob, $params);
		847	}
		848
		849	cf::override;
		850	},
		851	on_extcmd => sub {
		852	my ($pl, $buf) = @_;
		853
		854	my $msg = eval { from_json $buf };
		855
		856	if (ref $msg) {
		857	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		858	if (my %reply = $cb->[0]->($pl, $msg)) {
		859	$pl->ext_reply ($msg->{msgid}, %reply);
		860	}
		861	}
		862	} else {
		863	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		864	}
		865
		866	cf::override;
		867	},
		868	);
606		869
607	sub register {	870	sub register {
608	my ($base, $pkg) = @_;	871	my ($base, $pkg) = @_;
609		872
610	#TODO	873	#TODO
…		…
629	. "#line 1 \"$path\"\n{\n"	892	. "#line 1 \"$path\"\n{\n"
630	. (do { local $/; <$fh> })	893	. (do { local $/; <$fh> })
631	. "\n};\n1";	894	. "\n};\n1";
632		895
633	eval $source	896	eval $source
634	or die "$path: $@";	897	or die $@ ? "$path: $@\n"
		898	: "extension disabled.\n";
635		899
636	push @exts, $pkg;	900	push @exts, $pkg;
637	$ext_pkg{$base} = $pkg;	901	$ext_pkg{$base} = $pkg;
638		902
639	# no strict 'refs';	903	# no strict 'refs';
…		…
652	# for my $idx (0 .. $#PLUGIN_EVENT) {	916	# for my $idx (0 .. $#PLUGIN_EVENT) {
653	# delete $hook[$idx]{$pkg};	917	# delete $hook[$idx]{$pkg};
654	# }	918	# }
655		919
656	# remove commands	920	# remove commands
657	for my $name (keys %command) {	921	for my $name (keys %COMMAND) {
658	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	922	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
659		923
660	if (@cb) {	924	if (@cb) {
661	$command{$name} = \@cb;	925	$COMMAND{$name} = \@cb;
662	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
663	} else {	926	} else {
664	delete $command{$name};
665	delete $COMMAND{"$name\000"};	927	delete $COMMAND{$name};
666	}	928	}
667	}	929	}
668		930
669	# remove extcmds	931	# remove extcmds
670	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	932	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
671	delete $extcmd{$name};	933	delete $EXTCMD{$name};
672	}	934	}
673		935
674	if (my $cb = $pkg->can ("unload")) {	936	if (my $cb = $pkg->can ("unload")) {
675	eval {	937	eval {
676	$cb->($pkg);	938	$cb->($pkg);
…		…
680		942
681	Symbol::delete_package $pkg;	943	Symbol::delete_package $pkg;
682	}	944	}
683		945
684	sub load_extensions {	946	sub load_extensions {
685	my $LIBDIR = maps_directory "perl";
686
687	for my $ext (<$LIBDIR/*.ext>) {	947	for my $ext (<$LIBDIR/*.ext>) {
688	next unless -r $ext;	948	next unless -r $ext;
689	eval {	949	eval {
690	load_extension $ext;	950	load_extension $ext;
691	1	951	1
692	} or warn "$ext not loaded: $@";	952	} or warn "$ext not loaded: $@";
693	}	953	}
694	}	954	}
695		955
696	#############################################################################	956	#############################################################################
697	# extcmd framework, basically convert ext <msg>
698	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
699
700	attach_to_players
701	on_extcmd => sub {
702	my ($pl, $buf) = @_;
703
704	my $msg = eval { from_json $buf };
705
706	if (ref $msg) {
707	if (my $cb = $extcmd{$msg->{msgtype}}) {
708	if (my %reply = $cb->[0]->($pl, $msg)) {
709	$pl->ext_reply ($msg->{msgid}, %reply);
710	}
711	}
712	} else {
713	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
714	}
715
716	cf::override;
717	},
718	;
719
720	#############################################################################
721	# load/save/clean perl data associated with a map	957	# load/save/clean perl data associated with a map
722		958
723	*cf::mapsupport::on_clean = sub {	959	*cf::mapsupport::on_clean = sub {
724	my ($map) = @_;	960	my ($map) = @_;
725		961
…		…
727	defined $path or return;	963	defined $path or return;
728		964
729	unlink "$path.pst";	965	unlink "$path.pst";
730	};	966	};
731		967
732	attach_to_maps prio => -10000, package => cf::mapsupport::;	968	cf::map->attach (prio => -10000, package => cf::mapsupport::);
733		969
734	#############################################################################	970	#############################################################################
735	# load/save perl data associated with player->ob objects	971	# load/save perl data associated with player->ob objects
736		972
737	sub all_objects(@) {	973	sub all_objects(@) {
738	@_, map all_objects ($_->inv), @_	974	@_, map all_objects ($_->inv), @_
739	}	975	}
740		976
741	# TODO: compatibility cruft, remove when no longer needed	977	# TODO: compatibility cruft, remove when no longer needed
742	attach_to_players	978	cf::player->attach (
743	on_load => sub {	979	on_load => sub {
744	my ($pl, $path) = @_;	980	my ($pl, $path) = @_;
745		981
746	for my $o (all_objects $pl->ob) {	982	for my $o (all_objects $pl->ob) {
747	if (my $value = $o->get_ob_key_value ("_perl_data")) {	983	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
749		985
750	%$o = %{ Storable::thaw pack "H*", $value };	986	%$o = %{ Storable::thaw pack "H*", $value };
751	}	987	}
752	}	988	}
753	},	989	},
754	;	990	);
755		991
756	#############################################################################	992	#############################################################################
757		993
758	=head2 CORE EXTENSIONS	994	=head2 CORE EXTENSIONS
759		995
760	Functions and methods that extend core crossfire objects.	996	Functions and methods that extend core crossfire objects.
		997
		998	=head3 cf::player
761		999
762	=over 4	1000	=over 4
763		1001
764	=item cf::player::exists $login	1002	=item cf::player::exists $login
765		1003
…		…
770	sub cf::player::exists($) {	1008	sub cf::player::exists($) {
771	cf::player::find $_[0]	1009	cf::player::find $_[0]
772	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;
773	}	1011	}
774		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
775	=item $player->reply ($npc, $msg[, $flags])	1033	=item $player_object->reply ($npc, $msg[, $flags])
776		1034
777	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>
778	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
779	dialogue with the given NPC character.	1037	dialogue with the given NPC character.
780		1038
781	=cut	1039	=cut
782		1040
783	# rough implementation of a future "reply" method that works	1041	# rough implementation of a future "reply" method that works
784	# with dialog boxes.	1042	# with dialog boxes.
		1043	#TODO: the first argument must go, split into a $npc->reply_to ( method
785	sub cf::object::player::reply($$$;$) {	1044	sub cf::object::player::reply($$$;$) {
786	my ($self, $npc, $msg, $flags) = @_;	1045	my ($self, $npc, $msg, $flags) = @_;
787		1046
788	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;	1047	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
789		1048
…		…
793	$msg = $npc->name . " says: $msg" if $npc;	1052	$msg = $npc->name . " says: $msg" if $npc;
794	$self->message ($msg, $flags);	1053	$self->message ($msg, $flags);
795	}	1054	}
796	}	1055	}
797		1056
798	=item $player->ext_reply ($msgid, $msgtype, %msg)	1057	=item $player_object->may ("access")
799		1058
800	Sends an ext reply to the player.	1059	Returns wether the given player is authorized to access resource "access"
		1060	(e.g. "command_wizcast").
801		1061
802	=cut	1062	=cut
803		1063
804	sub cf::player::ext_reply($$$%) {	1064	sub cf::object::player::may {
		1065	my ($self, $access) = @_;
		1066
		1067	$self->flag (cf::FLAG_WIZ) \|\|
		1068	(ref $cf::CFG{"may_$access"}
		1069	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		1070	: $cf::CFG{"may_$access"})
		1071	}
		1072
		1073	=head3 cf::client
		1074
		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 {
805	my ($self, $id, %msg) = @_;	1150	my ($self, $cb) = @_;
806		1151
807	$msg{msgid} = $id;	1152	my $coro; $coro = async {
		1153	eval {
		1154	$cb->();
		1155	};
		1156	warn $@ if $@;
		1157	};
808		1158
809	$self->send ("ext " . to_json \%msg);	1159	$coro->on_destroy (sub {
		1160	delete $self->{_coro}{$coro+0};
		1161	});
		1162
		1163	$self->{_coro}{$coro+0} = $coro;
		1164
		1165	$coro
810	}	1166	}
		1167
		1168	cf::client->attach (
		1169	on_destroy => sub {
		1170	my ($ns) = @_;
		1171
		1172	$_->cancel for values %{ (delete $ns->{_coro}) \|\| {} };
		1173	},
		1174	);
811		1175
812	=back	1176	=back
813		1177
814	=cut
815
816	#############################################################################
817		1178
818	=head2 SAFE SCRIPTING	1179	=head2 SAFE SCRIPTING
819		1180
820	Functions that provide a safe environment to compile and execute	1181	Functions that provide a safe environment to compile and execute
821	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
822	itself. Looping constructs, I/O operators and other built-in functionality	1183	itself. Looping constructs, I/O operators and other built-in functionality
823	is not available in the safe scripting environment, and the number of	1184	is not available in the safe scripting environment, and the number of
824	functions and methods that cna be called is greatly reduced.	1185	functions and methods that can be called is greatly reduced.
825		1186
826	=cut	1187	=cut
827		1188
828	our $safe = new Safe "safe";	1189	our $safe = new Safe "safe";
829	our $safe_hole = new Safe::Hole;	1190	our $safe_hole = new Safe::Hole;
…		…
836		1197
837	=pod	1198	=pod
838		1199
839	The following fucntions and emthods are available within a safe environment:	1200	The following fucntions and emthods are available within a safe environment:
840		1201
841	cf::object contr pay_amount pay_player	1202	cf::object contr pay_amount pay_player map
842	cf::object::player player	1203	cf::object::player player
843	cf::player peaceful	1204	cf::player peaceful
		1205	cf::map trigger
844		1206
845	=cut	1207	=cut
846		1208
847	for (	1209	for (
848	["cf::object" => qw(contr pay_amount pay_player)],	1210	["cf::object" => qw(contr pay_amount pay_player map)],
849	["cf::object::player" => qw(player)],	1211	["cf::object::player" => qw(player)],
850	["cf::player" => qw(peaceful)],	1212	["cf::player" => qw(peaceful)],
		1213	["cf::map" => qw(trigger)],
851	) {	1214	) {
852	no strict 'refs';	1215	no strict 'refs';
853	my ($pkg, @funs) = @$_;	1216	my ($pkg, @funs) = @$_;
854	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1217	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
855	for @funs;	1218	for @funs;
…		…
965		1328
966	Immediately write the database to disk I<if it is dirty>.	1329	Immediately write the database to disk I<if it is dirty>.
967		1330
968	=cut	1331	=cut
969		1332
		1333	our $DB;
		1334
970	{	1335	{
971	my $db;
972	my $path = cf::localdir . "/database.pst";	1336	my $path = cf::localdir . "/database.pst";
973		1337
974	sub db_load() {	1338	sub db_load() {
975	warn "loading database $path\n";#d# remove later	1339	warn "loading database $path\n";#d# remove later
976	$db = stat $path ? Storable::retrieve $path : { };	1340	$DB = stat $path ? Storable::retrieve $path : { };
977	}	1341	}
978		1342
979	my $pid;	1343	my $pid;
980		1344
981	sub db_save() {	1345	sub db_save() {
982	warn "saving database $path\n";#d# remove later	1346	warn "saving database $path\n";#d# remove later
983	waitpid $pid, 0 if $pid;	1347	waitpid $pid, 0 if $pid;
984	if (0 == ($pid = fork)) {	1348	if (0 == ($pid = fork)) {
985	$db->{_meta}{version} = 1;	1349	$DB->{_meta}{version} = 1;
986	Storable::nstore $db, "$path~";	1350	Storable::nstore $DB, "$path~";
987	rename "$path~", $path;	1351	rename "$path~", $path;
988	cf::_exit 0 if defined $pid;	1352	cf::_exit 0 if defined $pid;
989	}	1353	}
990	}	1354	}
991		1355
…		…
994	sub db_sync() {	1358	sub db_sync() {
995	db_save if $dirty;	1359	db_save if $dirty;
996	undef $dirty;	1360	undef $dirty;
997	}	1361	}
998		1362
999	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	1363	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1000	db_sync;	1364	db_sync;
1001	});	1365	});
1002		1366
1003	sub db_dirty() {	1367	sub db_dirty() {
1004	$dirty = 1;	1368	$dirty = 1;
1005	$idle->start;	1369	$idle->start;
1006	}	1370	}
1007		1371
1008	sub db_get($;$) {	1372	sub db_get($;$) {
1009	@_ >= 2	1373	@_ >= 2
1010	? $db->{$_[0]}{$_[1]}	1374	? $DB->{$_[0]}{$_[1]}
1011	: ($db->{$_[0]} \|\|= { })	1375	: ($DB->{$_[0]} \|\|= { })
1012	}	1376	}
1013		1377
1014	sub db_put($$;$) {	1378	sub db_put($$;$) {
1015	if (@_ >= 3) {	1379	if (@_ >= 3) {
1016	$db->{$_[0]}{$_[1]} = $_[2];	1380	$DB->{$_[0]}{$_[1]} = $_[2];
1017	} else {	1381	} else {
1018	$db->{$_[0]} = $_[1];	1382	$DB->{$_[0]} = $_[1];
1019	}	1383	}
1020	db_dirty;	1384	db_dirty;
1021	}	1385	}
1022		1386
1023	attach_global	1387	cf::global->attach (
1024	prio => 10000,	1388	prio => 10000,
1025	on_cleanup => sub {	1389	on_cleanup => sub {
1026	db_sync;	1390	db_sync;
1027	},	1391	},
1028	;	1392	);
1029	}	1393	}
1030		1394
1031	#############################################################################	1395	#############################################################################
1032	# the server's main()	1396	# the server's main()
1033		1397
1034	sub load_cfg {	1398	sub cfg_load {
1035	open my $fh, "<:utf8", cf::confdir . "/config"	1399	open my $fh, "<:utf8", cf::confdir . "/config"
1036	or return;	1400	or return;
1037		1401
1038	local $/;	1402	local $/;
1039	*CFG = YAML::Syck::Load <$fh>;	1403	*CFG = YAML::Syck::Load <$fh>;
1040
1041	use Data::Dumper; warn Dumper \%CFG;
1042	}	1404	}
1043		1405
1044	sub main {	1406	sub main {
1045	load_cfg;	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
		1415	cfg_load;
1046	db_load;	1416	db_load;
1047	load_extensions;	1417	load_extensions;
1048	Event::loop;	1418	Event::loop;
1049	}	1419	}
1050		1420
1051	#############################################################################	1421	#############################################################################
1052	# initialisation	1422	# initialisation
1053		1423
1054	sub _perl_reload(&) {	1424	sub perl_reload() {
1055	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	}
1056		1430
1057	$msg->("reloading...");	1431	warn "reloading...";
		1432
		1433	local $FREEZE = 1;
		1434	cf::emergency_save;
1058		1435
1059	eval {	1436	eval {
		1437	# if anything goes wrong in here, we should simply crash as we already saved
		1438
1060	# cancel all watchers	1439	# cancel all watchers
1061	$_->cancel for Event::all_watchers;	1440	for (Event::all_watchers) {
		1441	$_->cancel if $_->data & WF_AUTOCANCEL;
		1442	}
		1443
		1444	# cancel all extension coros
		1445	$_->cancel for values %EXT_CORO;
		1446	%EXT_CORO = ();
1062		1447
1063	# unload all extensions	1448	# unload all extensions
1064	for (@exts) {	1449	for (@exts) {
1065	$msg->("unloading <$_>");	1450	warn "unloading <$_>";
1066	unload_extension $_;	1451	unload_extension $_;
1067	}	1452	}
1068		1453
1069	# unload all modules loaded from $LIBDIR	1454	# unload all modules loaded from $LIBDIR
1070	while (my ($k, $v) = each %INC) {	1455	while (my ($k, $v) = each %INC) {
1071	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1456	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1072		1457
1073	$msg->("removing <$k>");	1458	warn "removing <$k>";
1074	delete $INC{$k};	1459	delete $INC{$k};
1075		1460
1076	$k =~ s/\.pm$//;	1461	$k =~ s/\.pm$//;
1077	$k =~ s/\//::/g;	1462	$k =~ s/\//::/g;
1078		1463
…		…
1083	Symbol::delete_package $k;	1468	Symbol::delete_package $k;
1084	}	1469	}
1085		1470
1086	# sync database to disk	1471	# sync database to disk
1087	cf::db_sync;	1472	cf::db_sync;
		1473	IO::AIO::flush;
1088		1474
1089	# get rid of safe::, as good as possible	1475	# get rid of safe::, as good as possible
1090	Symbol::delete_package "safe::$_"	1476	Symbol::delete_package "safe::$_"
1091	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);
1092		1478
1093	# remove register_script_function callbacks	1479	# remove register_script_function callbacks
1094	# TODO	1480	# TODO
1095		1481
1096	# unload cf.pm "a bit"	1482	# unload cf.pm "a bit"
…		…
1099	# don't, removes xs symbols, too,	1485	# don't, removes xs symbols, too,
1100	# and global variables created in xs	1486	# and global variables created in xs
1101	#Symbol::delete_package __PACKAGE__;	1487	#Symbol::delete_package __PACKAGE__;
1102		1488
1103	# reload cf.pm	1489	# reload cf.pm
1104	$msg->("reloading cf.pm");	1490	warn "reloading cf.pm";
1105	require cf;	1491	require cf;
		1492	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1106		1493
1107	# load database again	1494	# load config and database again
		1495	cf::cfg_load;
1108	cf::db_load;	1496	cf::db_load;
1109		1497
1110	# load extensions	1498	# load extensions
1111	$msg->("load extensions");	1499	warn "load extensions";
1112	cf::load_extensions;	1500	cf::load_extensions;
1113		1501
1114	# reattach attachments to objects	1502	# reattach attachments to objects
1115	$msg->("reattach");	1503	warn "reattach";
1116	_global_reattach;	1504	_global_reattach;
1117	};	1505	};
1118	$msg->($@) if $@;
1119		1506
1120	$msg->("reloaded");	1507	if ($@) {
		1508	warn $@;
		1509	warn "error while reloading, exiting.";
		1510	exit 1;
		1511	}
		1512
		1513	warn "reloaded successfully";
1121	};	1514	};
1122		1515
1123	sub perl_reload() {	1516	#############################################################################
1124	_perl_reload {
1125	warn $_[0];
1126	print "$_[0]\n";
1127	};
1128	}
1129		1517
		1518	unless ($LINK_MAP) {
		1519	$LINK_MAP = cf::map::new;
		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);
		1527	}
		1528
		1529	register "<global>", __PACKAGE__;
		1530
1130	register_command "perl-reload", 0, sub {	1531	register_command "perl-reload" => sub {
1131	my ($who, $arg) = @_;	1532	my ($who, $arg) = @_;
1132		1533
1133	if ($who->flag (FLAG_WIZ)) {	1534	if ($who->flag (FLAG_WIZ)) {
		1535	$who->message ("start of reload.");
1134	_perl_reload {	1536	perl_reload;
1135	warn $_[0];	1537	$who->message ("end of reload.");
1136	$who->message ($_[0]);
1137	};
1138	}	1538	}
1139	};	1539	};
1140		1540
1141	register "<global>", __PACKAGE__;
1142
1143	unshift @INC, $LIBDIR;	1541	unshift @INC, $LIBDIR;
1144		1542
1145	$TICK_WATCHER = Event->timer (	1543	$TICK_WATCHER = Event->timer (
		1544	reentrant => 0,
1146	prio => 1,	1545	prio => 0,
1147	at => $NEXT_TICK \|\| 1,	1546	at => $NEXT_TICK \|\| $TICK,
		1547	data => WF_AUTOCANCEL,
1148	cb => sub {	1548	cb => sub {
		1549	unless ($FREEZE) {
1149	cf::server_tick; # one server iteration	1550	cf::server_tick; # one server iteration
		1551	$RUNTIME += $TICK;
		1552	}
1150		1553
1151	my $NOW = Event::time;
1152	$NEXT_TICK += $TICK;	1554	$NEXT_TICK += $TICK;
1153		1555
1154	# if we are delayed by four ticks, skip them all	1556	# if we are delayed by four ticks or more, skip them all
1155	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1557	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1156		1558
1157	$TICK_WATCHER->at ($NEXT_TICK);	1559	$TICK_WATCHER->at ($NEXT_TICK);
1158	$TICK_WATCHER->start;	1560	$TICK_WATCHER->start;
1159	},	1561	},
1160	);	1562	);
1161		1563
		1564	IO::AIO::max_poll_time $TICK * 0.2;
		1565
		1566	Event->io (
		1567	fd => IO::AIO::poll_fileno,
		1568	poll => 'r',
		1569	prio => 5,
		1570	data => WF_AUTOCANCEL,
		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	);
		1585
1162	1	1586	1
1163		1587

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.72 by root, Sun Oct 1 11:41:37 2006 UTC vs. Revision 1.108 by root, Sun Dec 31 21:02:05 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.72 by root, Sun Oct 1 11:41:37 2006 UTC vs.
Revision 1.108 by root, Sun Dec 31 21:02:05 2006 UTC