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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.80 by root, Tue Nov 7 16:30:55 2006 UTC vs.
Revision 1.108 by root, Sun Dec 31 21:02:05 2006 UTC

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.80 by root, Tue Nov 7 16:30:55 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.80 by root, Tue Nov 7 16:30:55 2006 UTC vs.
Revision 1.108 by root, Sun Dec 31 21:02:05 2006 UTC