ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.61 by root, Sun Sep 3 22:45:56 2006 UTC vs.
Revision 1.118 by root, Mon Jan 1 21:19:52 2007 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 ();
		23	use YAML::Syck ();
10	use Time::HiRes;	24	use Time::HiRes;
11	use Event;	25
12	$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
13		27
14	use strict;	28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
		29	$YAML::Syck::ImplicitUnicode = 1;
15		30
16	_reload_1;	31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
17		32
		33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		34
18	our %COMMAND = ();	35	our %COMMAND = ();
		36	our %COMMAND_TIME = ();
		37	our %EXTCMD = ();
		38
19	our @EVENT;	39	our @EVENT;
20	our %PROP_TYPE;	40	our $LIBDIR = datadir . "/ext";
21	our %PROP_IDX;
22	our $LIBDIR = maps_directory "perl";
23		41
24	our $TICK = MAX_TIME * 1e-6;	42	our $TICK = MAX_TIME * 1e-6;
25	our $TICK_WATCHER;	43	our $TICK_WATCHER;
26	our $NEXT_TICK;	44	our $NEXT_TICK;
		45	our $NOW;
		46
		47	our %CFG;
		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
		77	our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		78
		79	#############################################################################
		80
		81	=head2 GLOBAL VARIABLES
		82
		83	=over 4
		84
		85	=item $cf::UPTIME
		86
		87	The timestamp of the server start (so not actually an uptime).
		88
		89	=item $cf::RUNTIME
		90
		91	The time this server has run, starts at 0 and is increased by $cf::TICK on
		92	every server tick.
		93
		94	=item $cf::LIBDIR
		95
		96	The perl library directory, where extensions and cf-specific modules can
		97	be found. It will be added to C<@INC> automatically.
		98
		99	=item $cf::NOW
		100
		101	The time of the last (current) server tick.
		102
		103	=item $cf::TICK
		104
		105	The interval between server ticks, in seconds.
		106
		107	=item %cf::CFG
		108
		109	Configuration for the server, loaded from C</etc/crossfire/config>, or
		110	from wherever your confdir points to.
		111
		112	=back
		113
		114	=cut
27		115
28	BEGIN {	116	BEGIN {
29	*CORE::GLOBAL::warn = sub {	117	*CORE::GLOBAL::warn = sub {
30	my $msg = join "", @_;	118	my $msg = join "", @_;
		119	utf8::encode $msg;
		120
31	$msg .= "\n"	121	$msg .= "\n"
32	unless $msg =~ /\n$/;	122	unless $msg =~ /\n$/;
33		123
34	print STDERR "cfperl: $msg";
35	LOG llevError, "cfperl: $msg";	124	LOG llevError, "cfperl: $msg";
36	};	125	};
37	}	126	}
38		127
39	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!	128	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
40		129	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
41	# generate property mutators	130	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
42	sub prop_gen {	131	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
43	my ($prefix, $class) = @_;	132	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
44
45	no strict 'refs';
46
47	for my $prop (keys %PROP_TYPE) {
48	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
49	my $sub = lc $1;
50
51	my $type = $PROP_TYPE{$prop};
52	my $idx = $PROP_IDX {$prop};
53
54	*{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
55	$_[0]->get_property ($type, $idx)
56	};
57
58	*{"$class\::set_$sub"} = sub {
59	$_[0]->set_property ($type, $idx, $_[1]);
60	} unless $ignore_set{$prop};
61	}
62	}
63
64	# auto-generate most of the API
65
66	prop_gen OBJECT_PROP => "cf::object";
67	# CFAPI_OBJECT_ANIMATION?
68	prop_gen PLAYER_PROP => "cf::object::player";
69
70	prop_gen MAP_PROP => "cf::map";
71	prop_gen ARCH_PROP => "cf::arch";
72
73	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	133	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
74		134
75	# we bless all objects into (empty) derived classes to force a method lookup	135	# we bless all objects into (empty) derived classes to force a method lookup
76	# within the Safe compartment.	136	# within the Safe compartment.
77	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	137	for my $pkg (qw(
		138	cf::global cf::attachable
		139	cf::object cf::object::player
		140	cf::client cf::player
		141	cf::arch cf::living
		142	cf::map cf::party cf::region
		143	)) {
78	no strict 'refs';	144	no strict 'refs';
79	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	145	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
80	}	146	}
81		147
82	$Event::DIED = sub {	148	$Event::DIED = sub {
…		…
84	};	150	};
85		151
86	my %ext_pkg;	152	my %ext_pkg;
87	my @exts;	153	my @exts;
88	my @hook;	154	my @hook;
89	my %command;
90	my %extcmd;
91		155
92	#############################################################################	156	=head2 UTILITY FUNCTIONS
93	# utility functions	157
		158	=over 4
		159
		160	=cut
94		161
95	use JSON::Syck (); # TODO# replace by JSON::PC once working	162	use JSON::Syck (); # TODO# replace by JSON::PC once working
		163
		164	=item $ref = cf::from_json $json
		165
		166	Converts a JSON string into the corresponding perl data structure.
		167
		168	=cut
96		169
97	sub from_json($) {	170	sub from_json($) {
98	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs	171	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
99	JSON::Syck::Load $_[0]	172	JSON::Syck::Load $_[0]
100	}	173	}
101		174
		175	=item $json = cf::to_json $ref
		176
		177	Converts a perl data structure into its JSON representation.
		178
		179	=cut
		180
102	sub to_json($) {	181	sub to_json($) {
103	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	182	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
104	JSON::Syck::Dump $_[0]	183	JSON::Syck::Dump $_[0]
105	}	184	}
106		185
		186	=item cf::sync_job { BLOCK }
		187
		188	The design of crossfire+ requires that the main coro ($Coro::main) is
		189	always able to handle events or runnable, as crossfire+ is only partly
		190	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		191
		192	If it must be done, put the blocking parts into C<sync_job>. This will run
		193	the given BLOCK in another coroutine while waiting for the result. The
		194	server will be frozen during this time, so the block should either finish
		195	fast or be very important.
		196
		197	=cut
		198
		199	sub sync_job(&) {
		200	my ($job) = @_;
		201
		202	if ($Coro::current == $Coro::main) {
		203	# this is the main coro, too bad, we have to block
		204	# till the operation succeeds, freezing the server :/
		205
		206	# TODO: use suspend/resume instead
		207	# (but this is cancel-safe)
		208	local $FREEZE = 1;
		209
		210	my $busy = 1;
		211	my @res;
		212
		213	(Coro::async {
		214	@res = eval { $job->() };
		215	warn $@ if $@;
		216	undef $busy;
		217	})->prio (Coro::PRIO_MAX);
		218
		219	while ($busy) {
		220	Coro::cede_notself;
		221	Event::one_event unless Coro::nready;
		222	}
		223
		224	wantarray ? @res : $res[0]
		225	} else {
		226	# we are in another coroutine, how wonderful, everything just works
		227
		228	$job->()
		229	}
		230	}
		231
		232	=item $coro = cf::coro { BLOCK }
		233
		234	Creates and returns a new coro. This coro is automcatially being canceled
		235	when the extension calling this is being unloaded.
		236
		237	=cut
		238
		239	sub coro(&) {
		240	my $cb = shift;
		241
		242	my $coro; $coro = async {
		243	eval {
		244	$cb->();
		245	};
		246	warn $@ if $@;
		247	};
		248
		249	$coro->on_destroy (sub {
		250	delete $EXT_CORO{$coro+0};
		251	});
		252	$EXT_CORO{$coro+0} = $coro;
		253
		254	$coro
		255	}
		256
		257	sub write_runtime {
		258	my $runtime = cf::localdir . "/runtime";
		259
		260	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		261	or return;
		262
		263	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
		264	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		265	and return;
		266
		267	aio_fsync $fh
		268	and return;
		269
		270	close $fh
		271	or return;
		272
		273	aio_rename "$runtime~", $runtime
		274	and return;
		275
		276	1
		277	}
		278
		279	=back
		280
		281	=cut
		282
107	#############################################################################	283	#############################################################################
108	# "new" plug-in system
109		284
110	=head3 EVENTS AND OBJECT ATTACHMENTS	285	package cf::path;
		286
		287	sub new {
		288	my ($class, $path, $base) = @_;
		289
		290	$path = $path->as_string if ref $path;
		291
		292	my $self = bless { }, $class;
		293
		294	# {... are special paths that are not touched
		295	# ?xxx/... are special absolute paths
		296	# ?random/... random maps
		297	# /! non-realised random map exit
		298	# /... normal maps
		299	# ~/... per-player maps without a specific player (DO NOT USE)
		300	# ~user/... per-player map of a specific user
		301
		302	if ($path =~ /^{/) {
		303	# fine as it is
		304	} elsif ($path =~ s{^\?random/}{}) {
		305	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
		306	$self->{random} = cf::from_json $data;
		307	} else {
		308	if ($path =~ s{^~([^/]+)?}{}) {
		309	$self->{user_rel} = 1;
		310
		311	if (defined $1) {
		312	$self->{user} = $1;
		313	} elsif ($base =~ m{^~([^/]+)/}) {
		314	$self->{user} = $1;
		315	} else {
		316	warn "cannot resolve user-relative path without user <$path,$base>\n";
		317	}
		318	} elsif ($path =~ /^\//) {
		319	# already absolute
		320	} else {
		321	$base =~ s{[^/]+/?$}{};
		322	return $class->new ("$base/$path");
		323	}
		324
		325	for ($path) {
		326	redo if s{/\.?/}{/};
		327	redo if s{/[^/]+/\.\./}{/};
		328	}
		329	}
		330
		331	$self->{path} = $path;
		332
		333	$self
		334	}
		335
		336	# the name / primary key / in-game path
		337	sub as_string {
		338	my ($self) = @_;
		339
		340	$self->{user_rel} ? "~$self->{user}$self->{path}"
		341	: $self->{random} ? "?random/$self->{path}"
		342	: $self->{path}
		343	}
		344
		345	# the displayed name, this is a one way mapping
		346	sub visible_name {
		347	my ($self) = @_;
		348
		349	# if (my $rmp = $self->{random}) {
		350	# # todo: be more intelligent about this
		351	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
		352	# } else {
		353	$self->as_string
		354	# }
		355	}
		356
		357	# escape the /'s in the path
		358	sub _escaped_path {
		359	# ∕ is U+2215
		360	(my $path = $_[0]{path}) =~ s/\//∕/g;
		361	$path
		362	}
		363
		364	# the original (read-only) location
		365	sub load_path {
		366	my ($self) = @_;
		367
		368	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		369	}
		370
		371	# the temporary/swap location
		372	sub save_path {
		373	my ($self) = @_;
		374
		375	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
		376	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
		377	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
		378	}
		379
		380	# the unique path, might be eq to save_path
		381	sub uniq_path {
		382	my ($self) = @_;
		383
		384	$self->{user_rel} || $self->{random}
		385	? undef
		386	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
		387	}
		388
		389	# return random map parameters, or undef
		390	sub random_map_params {
		391	my ($self) = @_;
		392
		393	$self->{random}
		394	}
		395
		396	# this is somewhat ugly, but style maps do need special treatment
		397	sub is_style_map {
		398	$_[0]{path} =~ m{^/styles/}
		399	}
		400
		401	package cf;
		402
		403	#############################################################################
		404
		405	=head2 ATTACHABLE OBJECTS
		406
		407	Many objects in crossfire are so-called attachable objects. That means you can
		408	attach callbacks/event handlers (a collection of which is called an "attachment")
		409	to it. All such attachable objects support the following methods.
		410
		411	In the following description, CLASS can be any of C<global>, C<object>
		412	C<player>, C<client> or C<map> (i.e. the attachable objects in
		413	crossfire+).
111		414
112	=over 4	415	=over 4
113		416
114	=item $object->attach ($attachment, key => $value...)
115
116	=item $object->detach ($attachment)
117
118	Attach/detach a pre-registered attachment to an object.
119
120	=item $player->attach ($attachment, key => $value...)
121
122	=item $player->detach ($attachment)
123
124	Attach/detach a pre-registered attachment to a player.
125
126	=item $map->attach ($attachment, key => $value...)	417	=item $attachable->attach ($attachment, key => $value...)
127		418
128	=item $map->detach ($attachment)	419	=item $attachable->detach ($attachment)
129		420
130	Attach/detach a pre-registered attachment to a map.	421	Attach/detach a pre-registered attachment to a specific object and give it
		422	the specified key/value pairs as arguments.
131		423
132	=item $bool = $object->attached ($name)	424	Example, attach a minesweeper attachment to the given object, making it a
		425	10x10 minesweeper game:
133		426
134	=item $bool = $player->attached ($name)	427	$obj->attach (minesweeper => width => 10, height => 10);
135		428
136	=item $bool = $map->attached ($name)	429	=item $bool = $attachable->attached ($name)
137		430
138	Checks wether the named attachment is currently attached to the object.	431	Checks wether the named attachment is currently attached to the object.
139		432
140	=item cf::attach_global ...	433	=item cf::CLASS->attach ...
141		434
142	Attach handlers for global events.	435	=item cf::CLASS->detach ...
143		436
144	This and all following C<attach_*>-functions expect any number of the	437	Define an anonymous attachment and attach it to all objects of the given
145	following handler/hook descriptions:	438	CLASS. See the next function for an explanation of its arguments.
		439
		440	You can attach to global events by using the C<cf::global> class.
		441
		442	Example, log all player logins:
		443
		444	cf::player->attach (
		445	on_login => sub {
		446	my ($pl) = @_;
		447	...
		448	},
		449	);
		450
		451	Example, attach to the jeweler skill:
		452
		453	cf::object->attach (
		454	type => cf::SKILL,
		455	subtype => cf::SK_JEWELER,
		456	on_use_skill => sub {
		457	my ($sk, $ob, $part, $dir, $msg) = @_;
		458	...
		459	},
		460	);
		461
		462	=item cf::CLASS::attachment $name, ...
		463
		464	Register an attachment by C<$name> through which attachable objects of the
		465	given CLASS can refer to this attachment.
		466
		467	Some classes such as crossfire maps and objects can specify attachments
		468	that are attached at load/instantiate time, thus the need for a name.
		469
		470	These calls expect any number of the following handler/hook descriptions:
146		471
147	=over 4	472	=over 4
148		473
149	=item prio => $number	474	=item prio => $number
150		475
…		…
152	by another C<prio> setting). Lower priority handlers get executed	477	by another C<prio> setting). Lower priority handlers get executed
153	earlier. The default priority is C<0>, and many built-in handlers are	478	earlier. The default priority is C<0>, and many built-in handlers are
154	registered at priority C<-1000>, so lower priorities should not be used	479	registered at priority C<-1000>, so lower priorities should not be used
155	unless you know what you are doing.	480	unless you know what you are doing.
156		481
		482	=item type => $type
		483
		484	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		485	given type of objects only (the additional parameter C<subtype> can be
		486	used to further limit to the given subtype).
		487
157	=item on_I<event> => \&cb	488	=item on_I<event> => \&cb
158		489
159	Call the given code reference whenever the named event happens (event is	490	Call the given code reference whenever the named event happens (event is
160	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	491	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
161	handlers are recognised generally depends on the type of object these	492	handlers are recognised generally depends on the type of object these
…		…
170	package and register them. Only handlers for eevents supported by the	501	package and register them. Only handlers for eevents supported by the
171	object/class are recognised.	502	object/class are recognised.
172		503
173	=back	504	=back
174		505
175	=item cf::attach_to_type $object_type, $subtype, ...	506	Example, define an attachment called "sockpuppet" that calls the given
		507	event handler when a monster attacks:
176		508
177	Attach handlers for a specific object type (e.g. TRANSPORT) and	509	cf::object::attachment sockpuppet =>
178	subtype. If C<$subtype> is zero or undef, matches all objects of the given	510	on_skill_attack => sub {
179	type.	511	my ($self, $victim) = @_;
180		512	...
181	=item cf::attach_to_objects ...
182
183	Attach handlers to all objects. Do not use this except for debugging or
184	very rare events, as handlers are (obviously) called for I<all> objects in
185	the game.
186
187	=item cf::attach_to_players ...
188
189	Attach handlers to all players.
190
191	=item cf::attach_to_maps ...
192
193	Attach handlers to all maps.
194
195	=item cf:register_attachment $name, ...
196
197	Register an attachment by name through which objects can refer to this
198	attachment.
199
200	=item cf:register_player_attachment $name, ...
201
202	Register an attachment by name through which players can refer to this
203	attachment.
204
205	=item cf:register_map_attachment $name, ...
206
207	Register an attachment by name through which maps can refer to this
208	attachment.
209
210	=cut
211
212	# the following variables are defined in .xs and must not be re-created
213	our @CB_GLOBAL = (); # registry for all global events
214	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
215	our @CB_PLAYER = ();
216	our @CB_TYPE = (); # registry for type (cf-object class) based events
217	our @CB_MAP = ();
218
219	my %attachment;
220
221	sub _attach_cb($\%$$$) {
222	my ($registry, $undo, $event, $prio, $cb) = @_;
223
224	use sort 'stable';
225
226	$cb = [$prio, $cb];
227
228	@{$registry->[$event]} = sort
229	{ $a->[0] cmp $b->[0] }
230	@{$registry->[$event] || []}, $cb;
231
232	push @{$undo->{cb}}, [$event, $cb];
233	}
234
235	# attach handles attaching event callbacks
236	# the only thing the caller has to do is pass the correct
237	# registry (== where the callback attaches to).
238	sub _attach(\@$@) {
239	my ($registry, $klass, @arg) = @_;
240
241	my $prio = 0;
242
243	my %undo = (
244	registry => $registry,
245	cb => [],
246	);
247
248	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
249
250	while (@arg) {
251	my $type = shift @arg;
252
253	if ($type eq "prio") {
254	$prio = shift @arg;
255
256	} elsif ($type eq "package") {
257	my $pkg = shift @arg;
258
259	while (my ($name, $id) = each %cb_id) {
260	if (my $cb = $pkg->can ($name)) {
261	_attach_cb $registry, %undo, $id, $prio, $cb;
262	}
263	}	513	}
264
265	} elsif (exists $cb_id{$type}) {
266	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
267
268	} elsif (ref $type) {
269	warn "attaching objects not supported, ignoring.\n";
270
271	} else {
272	shift @arg;
273	warn "attach argument '$type' not supported, ignoring.\n";
274	}
275	}
276
277	\%undo
278	}
279
280	sub _attach_attachment {
281	my ($obj, $name, %arg) = @_;
282
283	return if exists $obj->{_attachment}{$name};
284
285	my $res;
286
287	if (my $attach = $attachment{$name}) {
288	my $registry = $obj->registry;
289
290	for (@$attach) {
291	my ($klass, @attach) = @$_;
292	$res = _attach @$registry, $klass, @attach;
293	}
294
295	$obj->{$name} = \%arg;
296	} else {
297	warn "object uses attachment '$name' that is not available, postponing.\n";
298	}
299
300	$obj->{_attachment}{$name} = undef;
301
302	$res->{attachment} = $name;
303	$res
304	}
305
306	*cf::object::attach =
307	*cf::player::attach =
308	*cf::map::attach = sub {
309	my ($obj, $name, %arg) = @_;
310
311	_attach_attachment $obj, $name, %arg;
312	};
313
314	# all those should be optimised
315	*cf::object::detach =
316	*cf::player::detach =
317	*cf::map::detach = sub {
318	my ($obj, $name) = @_;
319
320	delete $obj->{_attachment}{$name};
321	reattach ($obj);
322	};
323
324	*cf::object::attached =
325	*cf::player::attached =
326	*cf::map::attached = sub {
327	my ($obj, $name) = @_;
328
329	exists $obj->{_attachment}{$name}
330	};
331
332	sub attach_global {
333	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
334	}
335
336	sub attach_to_type {
337	my $type = shift;
338	my $subtype = shift;
339
340	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
341	}
342
343	sub attach_to_objects {
344	_attach @CB_OBJECT, KLASS_OBJECT, @_
345	}
346
347	sub attach_to_players {
348	_attach @CB_PLAYER, KLASS_PLAYER, @_
349	}
350
351	sub attach_to_maps {
352	_attach @CB_MAP, KLASS_MAP, @_
353	}
354
355	sub register_attachment {
356	my $name = shift;
357
358	$attachment{$name} = [[KLASS_OBJECT, @_]];
359	}
360
361	sub register_player_attachment {
362	my $name = shift;
363
364	$attachment{$name} = [[KLASS_PLAYER, @_]];
365	}
366
367	sub register_map_attachment {
368	my $name = shift;
369
370	$attachment{$name} = [[KLASS_MAP, @_]];
371	}
372
373	our $override;
374	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
375
376	sub override {
377	$override = 1;
378	@invoke_results = ();
379	}
380
381	sub do_invoke {
382	my $event = shift;
383	my $callbacks = shift;
384
385	@invoke_results = ();
386
387	local $override;
388
389	for (@$callbacks) {
390	eval { &{$_->[1]} };
391
392	if ($@) {
393	warn "$@";
394	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";
395	override;
396	}
397
398	return 1 if $override;
399	}
400
401	0	514	}
402	}
403		515
404	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	516	=item $attachable->valid
405
406	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
407
408	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
409
410	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
411
412	Generate a global/object/player/map-specific event with the given arguments.
413
414	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
415	removed in future versions), and there is no public API to access override
416	results (if you must, access C<@cf::invoke_results> directly).
417
418	=back
419
420	=head2 methods valid for all pointers
421
422	=over 4
423
424	=item $object->valid
425
426	=item $player->valid
427
428	=item $map->valid
429		517
430	Just because you have a perl object does not mean that the corresponding	518	Just because you have a perl object does not mean that the corresponding
431	C-level object still exists. If you try to access an object that has no	519	C-level object still exists. If you try to access an object that has no
432	valid C counterpart anymore you get an exception at runtime. This method	520	valid C counterpart anymore you get an exception at runtime. This method
433	can be used to test for existence of the C object part without causing an	521	can be used to test for existence of the C object part without causing an
434	exception.	522	exception.
435		523
		524	=cut
		525
		526	# the following variables are defined in .xs and must not be re-created
		527	our @CB_GLOBAL = (); # registry for all global events
		528	our @CB_ATTACHABLE = (); # registry for all attachables
		529	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		530	our @CB_PLAYER = ();
		531	our @CB_CLIENT = ();
		532	our @CB_TYPE = (); # registry for type (cf-object class) based events
		533	our @CB_MAP = ();
		534
		535	my %attachment;
		536
		537	sub _attach_cb($$$$) {
		538	my ($registry, $event, $prio, $cb) = @_;
		539
		540	use sort 'stable';
		541
		542	$cb = [$prio, $cb];
		543
		544	@{$registry->[$event]} = sort
		545	{ $a->[0] cmp $b->[0] }
		546	@{$registry->[$event] || []}, $cb;
		547	}
		548
		549	# hack
		550	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		551
		552	# attach handles attaching event callbacks
		553	# the only thing the caller has to do is pass the correct
		554	# registry (== where the callback attaches to).
		555	sub _attach {
		556	my ($registry, $klass, @arg) = @_;
		557
		558	my $object_type;
		559	my $prio = 0;
		560	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		561
		562	#TODO: get rid of this hack
		563	if ($attachable_klass{$klass}) {
		564	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		565	}
		566
		567	while (@arg) {
		568	my $type = shift @arg;
		569
		570	if ($type eq "prio") {
		571	$prio = shift @arg;
		572
		573	} elsif ($type eq "type") {
		574	$object_type = shift @arg;
		575	$registry = $CB_TYPE[$object_type] ||= [];
		576
		577	} elsif ($type eq "subtype") {
		578	defined $object_type or Carp::croak "subtype specified without type";
		579	my $object_subtype = shift @arg;
		580	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		581
		582	} elsif ($type eq "package") {
		583	my $pkg = shift @arg;
		584
		585	while (my ($name, $id) = each %cb_id) {
		586	if (my $cb = $pkg->can ($name)) {
		587	_attach_cb $registry, $id, $prio, $cb;
		588	}
		589	}
		590
		591	} elsif (exists $cb_id{$type}) {
		592	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		593
		594	} elsif (ref $type) {
		595	warn "attaching objects not supported, ignoring.\n";
		596
		597	} else {
		598	shift @arg;
		599	warn "attach argument '$type' not supported, ignoring.\n";
		600	}
		601	}
		602	}
		603
		604	sub _object_attach {
		605	my ($obj, $name, %arg) = @_;
		606
		607	return if exists $obj->{_attachment}{$name};
		608
		609	if (my $attach = $attachment{$name}) {
		610	my $registry = $obj->registry;
		611
		612	for (@$attach) {
		613	my ($klass, @attach) = @$_;
		614	_attach $registry, $klass, @attach;
		615	}
		616
		617	$obj->{$name} = \%arg;
		618	} else {
		619	warn "object uses attachment '$name' that is not available, postponing.\n";
		620	}
		621
		622	$obj->{_attachment}{$name} = undef;
		623	}
		624
		625	sub cf::attachable::attach {
		626	if (ref $_[0]) {
		627	_object_attach @_;
		628	} else {
		629	_attach shift->_attach_registry, @_;
		630	}
		631	};
		632
		633	# all those should be optimised
		634	sub cf::attachable::detach {
		635	my ($obj, $name) = @_;
		636
		637	if (ref $obj) {
		638	delete $obj->{_attachment}{$name};
		639	reattach ($obj);
		640	} else {
		641	Carp::croak "cannot, currently, detach class attachments";
		642	}
		643	};
		644
		645	sub cf::attachable::attached {
		646	my ($obj, $name) = @_;
		647
		648	exists $obj->{_attachment}{$name}
		649	}
		650
		651	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		652	eval "#line " . __LINE__ . " 'cf.pm'
		653	sub cf::\L$klass\E::_attach_registry {
		654	(\\\@CB_$klass, KLASS_$klass)
		655	}
		656
		657	sub cf::\L$klass\E::attachment {
		658	my \$name = shift;
		659
		660	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		661	}
		662	";
		663	die if $@;
		664	}
		665
		666	our $override;
		667	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		668
		669	sub override {
		670	$override = 1;
		671	@invoke_results = ();
		672	}
		673
		674	sub do_invoke {
		675	my $event = shift;
		676	my $callbacks = shift;
		677
		678	@invoke_results = ();
		679
		680	local $override;
		681
		682	for (@$callbacks) {
		683	eval { &{$_->[1]} };
		684
		685	if ($@) {
		686	warn "$@";
		687	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		688	override;
		689	}
		690
		691	return 1 if $override;
		692	}
		693
		694	0
		695	}
		696
		697	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		698
		699	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		700
		701	Generate an object-specific event with the given arguments.
		702
		703	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		704	removed in future versions), and there is no public API to access override
		705	results (if you must, access C<@cf::invoke_results> directly).
		706
436	=back	707	=back
437		708
438	=cut	709	=cut
439
440	*cf::object::valid =
441	*cf::player::valid =
442	*cf::map::valid = \&cf::_valid;
443		710
444	#############################################################################	711	#############################################################################
445	# object support	712	# object support
446		713
447	sub instantiate {
448	my ($obj, $data) = @_;
449
450	$data = from_json $data;
451
452	for (@$data) {
453	my ($name, $args) = @$_;
454
455	$obj->attach ($name, %{$args || {} });
456	}
457	}
458
459	# basically do the same as instantiate, without calling instantiate
460	sub reattach {	714	sub reattach {
		715	# basically do the same as instantiate, without calling instantiate
461	my ($obj) = @_;	716	my ($obj) = @_;
		717
462	my $registry = $obj->registry;	718	my $registry = $obj->registry;
463		719
464	@$registry = ();	720	@$registry = ();
465		721
466	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	722	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
467		723
468	for my $name (keys %{ $obj->{_attachment} || {} }) {	724	for my $name (keys %{ $obj->{_attachment} || {} }) {
469	if (my $attach = $attachment{$name}) {	725	if (my $attach = $attachment{$name}) {
470	for (@$attach) {	726	for (@$attach) {
471	my ($klass, @attach) = @$_;	727	my ($klass, @attach) = @$_;
472	_attach @$registry, $klass, @attach;	728	_attach $registry, $klass, @attach;
473	}	729	}
474	} else {	730	} else {
475	warn "object uses attachment '$name' that is not available, postponing.\n";	731	warn "object uses attachment '$name' that is not available, postponing.\n";
476	}	732	}
477	}	733	}
478	}	734	}
479		735
480	sub object_freezer_save {	736	cf::attachable->attach (
481	my ($filename, $rdata, $objs) = @_;
482
483	if (length $$rdata) {
484	warn sprintf "saving %s (%d,%d)\n",
485	$filename, length $$rdata, scalar @$objs;
486
487	if (open my $fh, ">:raw", "$filename~") {
488	chmod SAVE_MODE, $fh;
489	syswrite $fh, $$rdata;
490	close $fh;
491
492	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
493	chmod SAVE_MODE, $fh;
494	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
495	close $fh;
496	rename "$filename.pst~", "$filename.pst";
497	} else {
498	unlink "$filename.pst";
499	}
500
501	rename "$filename~", $filename;
502	} else {
503	warn "FATAL: $filename~: $!\n";
504	}
505	} else {
506	unlink $filename;
507	unlink "$filename.pst";
508	}
509	}
510
511	sub object_thawer_load {
512	my ($filename) = @_;
513
514	local $/;
515
516	my $av;
517
518	#TODO: use sysread etc.
519	if (open my $data, "<:raw:perlio", $filename) {
520	$data = <$data>;
521	if (open my $pst, "<:raw:perlio", "$filename.pst") {
522	$av = eval { (Storable::thaw <$pst>)->{objs} };
523	}
524	return ($data, $av);
525	}
526
527	()
528	}
529
530	attach_to_objects
531	prio => -1000000,	737	prio => -1000000,
		738	on_instantiate => sub {
		739	my ($obj, $data) = @_;
		740
		741	$data = from_json $data;
		742
		743	for (@$data) {
		744	my ($name, $args) = @$_;
		745
		746	$obj->attach ($name, %{$args || {} });
		747	}
		748	},
		749	on_reattach => \&reattach,
532	on_clone => sub {	750	on_clone => sub {
533	my ($src, $dst) = @_;	751	my ($src, $dst) = @_;
534		752
535	@{$dst->registry} = @{$src->registry};	753	@{$dst->registry} = @{$src->registry};
536		754
537	%$dst = %$src;	755	%$dst = %$src;
538		756
539	%{$dst->{_attachment}} = %{$src->{_attachment}}	757	%{$dst->{_attachment}} = %{$src->{_attachment}}
540	if exists $src->{_attachment};	758	if exists $src->{_attachment};
541	},	759	},
542	;	760	);
		761
		762	sub object_freezer_save {
		763	my ($filename, $rdata, $objs) = @_;
		764
		765	sync_job {
		766	if (length $$rdata) {
		767	warn sprintf "saving %s (%d,%d)\n",
		768	$filename, length $$rdata, scalar @$objs;
		769
		770	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		771	chmod SAVE_MODE, $fh;
		772	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		773	aio_fsync $fh;
		774	close $fh;
		775
		776	if (@$objs) {
		777	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		778	chmod SAVE_MODE, $fh;
		779	my $data = Storable::nfreeze { version => 1, objs => $objs };
		780	aio_write $fh, 0, (length $data), $data, 0;
		781	aio_fsync $fh;
		782	close $fh;
		783	aio_rename "$filename.pst~", "$filename.pst";
		784	}
		785	} else {
		786	aio_unlink "$filename.pst";
		787	}
		788
		789	aio_rename "$filename~", $filename;
		790	} else {
		791	warn "FATAL: $filename~: $!\n";
		792	}
		793	} else {
		794	aio_unlink $filename;
		795	aio_unlink "$filename.pst";
		796	}
		797	}
		798	}
		799
		800	sub object_freezer_as_string {
		801	my ($rdata, $objs) = @_;
		802
		803	use Data::Dumper;
		804
		805	$$rdata . Dumper $objs
		806	}
		807
		808	sub object_thawer_load {
		809	my ($filename) = @_;
		810
		811	my ($data, $av);
		812
		813	(aio_load $filename, $data) >= 0
		814	or return;
		815
		816	unless (aio_stat "$filename.pst") {
		817	(aio_load "$filename.pst", $av) >= 0
		818	or return;
		819	$av = eval { (Storable::thaw $av)->{objs} };
		820	}
		821
		822	warn sprintf "loading %s (%d)\n",
		823	$filename, length $data, scalar @{$av || []};#d#
		824	return ($data, $av);
		825	}
543		826
544	#############################################################################	827	#############################################################################
545	# old plug-in events	828	# command handling &c
546		829
547	sub inject_event {	830	=item cf::register_command $name => \&callback($ob,$args);
548	my $extension = shift;
549	my $event_code = shift;
550		831
551	my $cb = $hook[$event_code]{$extension}	832	Register a callback for execution when the client sends the user command
552	or return;	833	$name.
553		834
554	&$cb	835	=cut
555	}
556
557	sub inject_global_event {
558	my $event = shift;
559
560	my $cb = $hook[$event]
561	or return;
562
563	List::Util::max map &$_, values %$cb
564	}
565
566	sub inject_command {
567	my ($name, $obj, $params) = @_;
568
569	for my $cmd (@{ $command{$name} }) {
570	$cmd->[1]->($obj, $params);
571	}
572
573	-1
574	}
575		836
576	sub register_command {	837	sub register_command {
577	my ($name, $time, $cb) = @_;	838	my ($name, $cb) = @_;
578		839
579	my $caller = caller;	840	my $caller = caller;
580	#warn "registering command '$name/$time' to '$caller'";	841	#warn "registering command '$name/$time' to '$caller'";
581		842
582	push @{ $command{$name} }, [$time, $cb, $caller];	843	push @{ $COMMAND{$name} }, [$caller, $cb];
583	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
584	}	844	}
		845
		846	=item cf::register_extcmd $name => \&callback($pl,$packet);
		847
		848	Register a callbackf ro execution when the client sends an extcmd packet.
		849
		850	If the callback returns something, it is sent back as if reply was being
		851	called.
		852
		853	=cut
585		854
586	sub register_extcmd {	855	sub register_extcmd {
587	my ($name, $cb) = @_;	856	my ($name, $cb) = @_;
588		857
589	my $caller = caller;	858	my $caller = caller;
590	#warn "registering extcmd '$name' to '$caller'";	859	#warn "registering extcmd '$name' to '$caller'";
591		860
592	$extcmd{$name} = [$cb, $caller];	861	$EXTCMD{$name} = [$cb, $caller];
593	}	862	}
		863
		864	cf::player->attach (
		865	on_command => sub {
		866	my ($pl, $name, $params) = @_;
		867
		868	my $cb = $COMMAND{$name}
		869	or return;
		870
		871	for my $cmd (@$cb) {
		872	$cmd->[1]->($pl->ob, $params);
		873	}
		874
		875	cf::override;
		876	},
		877	on_extcmd => sub {
		878	my ($pl, $buf) = @_;
		879
		880	my $msg = eval { from_json $buf };
		881
		882	if (ref $msg) {
		883	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		884	if (my %reply = $cb->[0]->($pl, $msg)) {
		885	$pl->ext_reply ($msg->{msgid}, %reply);
		886	}
		887	}
		888	} else {
		889	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		890	}
		891
		892	cf::override;
		893	},
		894	);
594		895
595	sub register {	896	sub register {
596	my ($base, $pkg) = @_;	897	my ($base, $pkg) = @_;
597		898
598	#TODO	899	#TODO
…		…
617	. "#line 1 \"$path\"\n{\n"	918	. "#line 1 \"$path\"\n{\n"
618	. (do { local $/; <$fh> })	919	. (do { local $/; <$fh> })
619	. "\n};\n1";	920	. "\n};\n1";
620		921
621	eval $source	922	eval $source
622	or die "$path: $@";	923	or die $@ ? "$path: $@\n"
		924	: "extension disabled.\n";
623		925
624	push @exts, $pkg;	926	push @exts, $pkg;
625	$ext_pkg{$base} = $pkg;	927	$ext_pkg{$base} = $pkg;
626		928
627	# no strict 'refs';	929	# no strict 'refs';
…		…
640	# for my $idx (0 .. $#PLUGIN_EVENT) {	942	# for my $idx (0 .. $#PLUGIN_EVENT) {
641	# delete $hook[$idx]{$pkg};	943	# delete $hook[$idx]{$pkg};
642	# }	944	# }
643		945
644	# remove commands	946	# remove commands
645	for my $name (keys %command) {	947	for my $name (keys %COMMAND) {
646	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	948	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
647		949
648	if (@cb) {	950	if (@cb) {
649	$command{$name} = \@cb;	951	$COMMAND{$name} = \@cb;
650	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
651	} else {	952	} else {
652	delete $command{$name};
653	delete $COMMAND{"$name\000"};	953	delete $COMMAND{$name};
654	}	954	}
655	}	955	}
656		956
657	# remove extcmds	957	# remove extcmds
658	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	958	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
659	delete $extcmd{$name};	959	delete $EXTCMD{$name};
660	}	960	}
661		961
662	if (my $cb = $pkg->can ("unload")) {	962	if (my $cb = $pkg->can ("unload")) {
663	eval {	963	eval {
664	$cb->($pkg);	964	$cb->($pkg);
…		…
668		968
669	Symbol::delete_package $pkg;	969	Symbol::delete_package $pkg;
670	}	970	}
671		971
672	sub load_extensions {	972	sub load_extensions {
673	my $LIBDIR = maps_directory "perl";
674
675	for my $ext (<$LIBDIR/*.ext>) {	973	for my $ext (<$LIBDIR/*.ext>) {
676	next unless -r $ext;	974	next unless -r $ext;
677	eval {	975	eval {
678	load_extension $ext;	976	load_extension $ext;
679	1	977	1
680	} or warn "$ext not loaded: $@";	978	} or warn "$ext not loaded: $@";
681	}	979	}
682	}	980	}
683		981
684	sub _perl_reload(&) {
685	my ($msg) = @_;
686
687	$msg->("reloading...");
688
689	eval {
690	# 1. cancel all watchers
691	$_->cancel for Event::all_watchers;
692
693	# 2. unload all extensions
694	for (@exts) {
695	$msg->("unloading <$_>");
696	unload_extension $_;
697	}
698
699	# 3. unload all modules loaded from $LIBDIR
700	while (my ($k, $v) = each %INC) {
701	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
702
703	$msg->("removing <$k>");
704	delete $INC{$k};
705
706	$k =~ s/\.pm$//;
707	$k =~ s/\//::/g;
708
709	if (my $cb = $k->can ("unload_module")) {
710	$cb->();
711	}
712
713	Symbol::delete_package $k;
714	}
715
716	# 4. get rid of safe::, as good as possible
717	Symbol::delete_package "safe::$_"
718	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
719
720	# 5. remove register_script_function callbacks
721	# TODO
722
723	# 6. unload cf.pm "a bit"
724	delete $INC{"cf.pm"};
725
726	# don't, removes xs symbols, too,
727	# and global variables created in xs
728	#Symbol::delete_package __PACKAGE__;
729
730	# 7. reload cf.pm
731	$msg->("reloading cf.pm");
732	require cf;
733
734	$msg->("load extensions");
735	cf::load_extensions;
736	};
737	$msg->($@) if $@;
738
739	$msg->("reloaded");
740	};
741
742	sub perl_reload() {
743	_perl_reload {
744	warn $_[0];
745	print "$_[0]\n";
746	};
747	}
748
749	register_command "perl-reload", 0, sub {
750	my ($who, $arg) = @_;
751
752	if ($who->flag (FLAG_WIZ)) {
753	_perl_reload {
754	warn $_[0];
755	$who->message ($_[0]);
756	};
757	}
758	};
759
760	#############################################################################
761	# extcmd framework, basically convert ext <msg>
762	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
763
764	attach_to_players
765	on_extcmd => sub {
766	my ($pl, $buf) = @_;
767
768	my $msg = eval { from_json $buf };
769
770	if (ref $msg) {
771	if (my $cb = $extcmd{$msg->{msgtype}}) {
772	if (my %reply = $cb->[0]->($pl, $msg)) {
773	$pl->ext_reply ($msg->{msgid}, %reply);
774	}
775	}
776	} else {
777	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
778	}
779
780	cf::override;
781	},
782	;
783
784	#############################################################################	982	#############################################################################
785	# load/save/clean perl data associated with a map	983	# load/save/clean perl data associated with a map
786		984
787	*cf::mapsupport::on_clean = sub {	985	*cf::mapsupport::on_clean = sub {
788	my ($map) = @_;	986	my ($map) = @_;
…		…
791	defined $path or return;	989	defined $path or return;
792		990
793	unlink "$path.pst";	991	unlink "$path.pst";
794	};	992	};
795		993
796	attach_to_maps prio => -10000, package => cf::mapsupport::;	994	cf::map->attach (prio => -10000, package => cf::mapsupport::);
797		995
798	#############################################################################	996	#############################################################################
799	# load/save perl data associated with player->ob objects	997	# load/save perl data associated with player->ob objects
800		998
801	sub all_objects(@) {	999	sub all_objects(@) {
802	@_, map all_objects ($_->inv), @_	1000	@_, map all_objects ($_->inv), @_
803	}	1001	}
804		1002
805	# TODO: compatibility cruft, remove when no longer needed	1003	# TODO: compatibility cruft, remove when no longer needed
806	attach_to_players	1004	cf::player->attach (
807	on_load => sub {	1005	on_load => sub {
808	my ($pl, $path) = @_;	1006	my ($pl, $path) = @_;
809		1007
810	for my $o (all_objects $pl->ob) {	1008	for my $o (all_objects $pl->ob) {
811	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1009	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
813		1011
814	%$o = %{ Storable::thaw pack "H*", $value };	1012	%$o = %{ Storable::thaw pack "H*", $value };
815	}	1013	}
816	}	1014	}
817	},	1015	},
818	;	1016	);
819		1017
820	#############################################################################	1018	#############################################################################
821	# core extensions - in perl	1019
		1020	=head2 CORE EXTENSIONS
		1021
		1022	Functions and methods that extend core crossfire objects.
		1023
		1024	=head3 cf::player
		1025
		1026	=over 4
822		1027
823	=item cf::player::exists $login	1028	=item cf::player::exists $login
824		1029
825	Returns true when the given account exists.	1030	Returns true when the given account exists.
826		1031
…		…
829	sub cf::player::exists($) {	1034	sub cf::player::exists($) {
830	cf::player::find $_[0]	1035	cf::player::find $_[0]
831	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1036	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
832	}	1037	}
833		1038
		1039	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1040
		1041	Sends an ext reply to the player.
		1042
		1043	=cut
		1044
		1045	sub cf::player::ext_reply($$$%) {
		1046	my ($self, $id, %msg) = @_;
		1047
		1048	$msg{msgid} = $id;
		1049
		1050	$self->send ("ext " . to_json \%msg);
		1051	}
		1052
		1053	=back
		1054
		1055
		1056	=head3 cf::map
		1057
		1058	=over 4
		1059
		1060	=cut
		1061
		1062	package cf::map;
		1063
		1064	use Fcntl;
		1065	use Coro::AIO;
		1066
		1067	our $MAX_RESET = 7200;
		1068	our $DEFAULT_RESET = 3600;
		1069
		1070	sub generate_random_map {
		1071	my ($path, $rmp) = @_;
		1072
		1073	# mit "rum" bekleckern, nicht
		1074	cf::map::_create_random_map
		1075	$path,
		1076	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1077	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1078	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1079	$rmp->{exit_on_final_map},
		1080	$rmp->{xsize}, $rmp->{ysize},
		1081	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1082	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1083	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1084	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1085	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1086	(cf::region::find $rmp->{region})
		1087	}
		1088
		1089	# and all this just because we cannot iterate over
		1090	# all maps in C++...
		1091	sub change_all_map_light {
		1092	my ($change) = @_;
		1093
		1094	$_->change_map_light ($change) for values %cf::MAP;
		1095	}
		1096
		1097	sub try_load_header($) {
		1098	my ($path) = @_;
		1099
		1100	utf8::encode $path;
		1101	aio_open $path, O_RDONLY, 0
		1102	or return;
		1103
		1104	my $map = cf::map::new
		1105	or return;
		1106
		1107	$map->load_header ($path)
		1108	or return;
		1109
		1110	$map->{load_path} = $path;
		1111
		1112	$map
		1113	}
		1114
		1115	sub find_map {
		1116	my ($path, $origin) = @_;
		1117
		1118	#warn "find_map<$path,$origin>\n";#d#
		1119
		1120	$path = new cf::path $path, $origin && $origin->path;
		1121	my $key = $path->as_string;
		1122
		1123	$cf::MAP{$key} || do {
		1124	# do it the slow way
		1125	my $map = try_load_header $path->save_path;
		1126
		1127	if ($map) {
		1128	# safety
		1129	$map->{instantiate_time} = $cf::RUNTIME
		1130	if $map->{instantiate_time} > $cf::RUNTIME;
		1131	} else {
		1132	if (my $rmp = $path->random_map_params) {
		1133	$map = generate_random_map $key, $rmp;
		1134	} else {
		1135	$map = try_load_header $path->load_path;
		1136	}
		1137
		1138	$map or return;
		1139
		1140	$map->{load_original} = 1;
		1141	$map->{instantiate_time} = $cf::RUNTIME;
		1142	$map->instantiate;
		1143
		1144	# per-player maps become, after loading, normal maps
		1145	$map->per_player (0) if $path->{user_rel};
		1146	}
		1147	#Coro::Timer::sleep 1;#d#
		1148
		1149	$map->path ($key);
		1150	$map->{path} = $path;
		1151	$map->{last_save} = $cf::RUNTIME;
		1152	$map->last_access ($cf::RUNTIME);
		1153
		1154	if ($map->should_reset) {
		1155	$map->reset;
		1156	$map = find_map $path;
		1157	}
		1158
		1159	$cf::MAP{$key} = $map
		1160	}
		1161	}
		1162
		1163	sub load {
		1164	my ($self) = @_;
		1165
		1166	return if $self->in_memory != cf::MAP_SWAPPED;
		1167
		1168	$self->in_memory (cf::MAP_LOADING);
		1169
		1170	my $path = $self->{path};
		1171
		1172	$self->alloc;
		1173	$self->load_objects ($self->{load_path}, 1)
		1174	or return;
		1175
		1176	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1177	if delete $self->{load_original};
		1178
		1179	if (my $uniq = $path->uniq_path) {
		1180	utf8::encode $uniq;
		1181	if (aio_open $uniq, O_RDONLY, 0) {
		1182	$self->clear_unique_items;
		1183	$self->load_objects ($uniq, 0);
		1184	}
		1185	}
		1186
		1187	# now do the right thing for maps
		1188	$self->link_multipart_objects;
		1189
		1190	if ($self->{path}->is_style_map) {
		1191	$self->{deny_save} = 1;
		1192	$self->{deny_reset} = 1;
		1193	} else {
		1194	$self->fix_auto_apply;
		1195	$self->decay_objects;
		1196	$self->update_buttons;
		1197	$self->set_darkness_map;
		1198	$self->difficulty ($self->estimate_difficulty)
		1199	unless $self->difficulty;
		1200	$self->activate;
		1201	}
		1202
		1203	$self->in_memory (cf::MAP_IN_MEMORY);
		1204	}
		1205
		1206	sub load_map_sync {
		1207	my ($path, $origin) = @_;
		1208
		1209	#warn "load_map_sync<$path, $origin>\n";#d#
		1210
		1211	cf::sync_job {
		1212	my $map = cf::map::find_map $path, $origin
		1213	or return;
		1214	$map->load;
		1215	$map
		1216	}
		1217	}
		1218
		1219	sub save {
		1220	my ($self) = @_;
		1221
		1222	$self->{last_save} = $cf::RUNTIME;
		1223
		1224	return unless $self->dirty;
		1225
		1226	my $save = $self->{path}->save_path; utf8::encode $save;
		1227	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
		1228
		1229	$self->{load_path} = $save;
		1230
		1231	return if $self->{deny_save};
		1232
		1233	if ($uniq) {
		1234	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1235	$self->save_objects ($uniq, cf::IO_UNIQUES);
		1236	} else {
		1237	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		1238	}
		1239	}
		1240
		1241	sub swap_out {
		1242	my ($self) = @_;
		1243
		1244	return if $self->players;
		1245	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1246	return if $self->{deny_save};
		1247
		1248	$self->save;
		1249	$self->clear;
		1250	$self->in_memory (cf::MAP_SWAPPED);
		1251	}
		1252
		1253	sub reset_at {
		1254	my ($self) = @_;
		1255
		1256	# TODO: safety, remove and allow resettable per-player maps
		1257	return 1e99 if $self->{path}{user_rel};
		1258	return 1e99 if $self->{deny_reset};
		1259
		1260	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1261	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1262
		1263	$time + $to
		1264	}
		1265
		1266	sub should_reset {
		1267	my ($self) = @_;
		1268
		1269	$self->reset_at <= $cf::RUNTIME
		1270	}
		1271
		1272	sub unlink_save {
		1273	my ($self) = @_;
		1274
		1275	utf8::encode (my $save = $self->{path}->save_path);
		1276	aioreq_pri 3; IO::AIO::aio_unlink $save;
		1277	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
		1278	}
		1279
		1280	sub rename {
		1281	my ($self, $new_path) = @_;
		1282
		1283	$self->unlink_save;
		1284
		1285	delete $cf::MAP{$self->path};
		1286	$self->{path} = new cf::path $new_path;
		1287	$self->path ($self->{path}->as_string);
		1288	$cf::MAP{$self->path} = $self;
		1289
		1290	$self->save;
		1291	}
		1292
		1293	sub reset {
		1294	my ($self) = @_;
		1295
		1296	return if $self->players;
		1297	return if $self->{path}{user_rel};#d#
		1298
		1299	warn "resetting map ", $self->path;#d#
		1300
		1301	delete $cf::MAP{$self->path};
		1302
		1303	$_->clear_links_to ($self) for values %cf::MAP;
		1304
		1305	$self->unlink_save;
		1306	$self->destroy;
		1307	}
		1308
		1309	my $nuke_counter = "aaaa";
		1310
		1311	sub nuke {
		1312	my ($self) = @_;
		1313
		1314	$self->{deny_save} = 1;
		1315	$self->reset_timeout (1);
		1316	$self->rename ("{nuke}/" . ($nuke_counter++));
		1317	$self->reset; # polite request, might not happen
		1318	}
		1319
		1320	sub customise_for {
		1321	my ($map, $ob) = @_;
		1322
		1323	if ($map->per_player) {
		1324	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};
		1325	}
		1326
		1327	$map
		1328	}
		1329
		1330	sub emergency_save {
		1331	local $cf::FREEZE = 1;
		1332
		1333	warn "enter emergency map save\n";
		1334
		1335	cf::sync_job {
		1336	warn "begin emergency map save\n";
		1337	$_->save for values %cf::MAP;
		1338	};
		1339
		1340	warn "end emergency map save\n";
		1341	}
		1342
		1343	package cf;
		1344
		1345	=back
		1346
		1347
		1348	=head3 cf::object::player
		1349
		1350	=over 4
		1351
834	=item $player->reply ($npc, $msg[, $flags])	1352	=item $player_object->reply ($npc, $msg[, $flags])
835		1353
836	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1354	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
837	can be C<undef>. Does the right thing when the player is currently in a	1355	can be C<undef>. Does the right thing when the player is currently in a
838	dialogue with the given NPC character.	1356	dialogue with the given NPC character.
839		1357
840	=cut	1358	=cut
841		1359
842	# rough implementation of a future "reply" method that works	1360	# rough implementation of a future "reply" method that works
843	# with dialog boxes.	1361	# with dialog boxes.
		1362	#TODO: the first argument must go, split into a $npc->reply_to ( method
844	sub cf::object::player::reply($$$;$) {	1363	sub cf::object::player::reply($$$;$) {
845	my ($self, $npc, $msg, $flags) = @_;	1364	my ($self, $npc, $msg, $flags) = @_;
846		1365
847	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1366	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
848		1367
…		…
852	$msg = $npc->name . " says: $msg" if $npc;	1371	$msg = $npc->name . " says: $msg" if $npc;
853	$self->message ($msg, $flags);	1372	$self->message ($msg, $flags);
854	}	1373	}
855	}	1374	}
856		1375
857	=item $player->ext_reply ($msgid, $msgtype, %msg)	1376	=item $player_object->may ("access")
858		1377
859	Sends an ext reply to the player.	1378	Returns wether the given player is authorized to access resource "access"
		1379	(e.g. "command_wizcast").
860		1380
861	=cut	1381	=cut
862		1382
863	sub cf::player::ext_reply($$$%) {	1383	sub cf::object::player::may {
		1384	my ($self, $access) = @_;
		1385
		1386	$self->flag (cf::FLAG_WIZ) ||
		1387	(ref $cf::CFG{"may_$access"}
		1388	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		1389	: $cf::CFG{"may_$access"})
		1390	}
		1391
		1392	=item $player_object->enter_link
		1393
		1394	Freezes the player and moves him/her to a special map (C<{link}>).
		1395
		1396	The player should be reaosnably safe there for short amounts of time. You
		1397	I<MUST> call C<leave_link> as soon as possible, though.
		1398
		1399	=item $player_object->leave_link ($map, $x, $y)
		1400
		1401	Moves the player out of the specila link map onto the given map. If the
		1402	map is not valid (or omitted), the player will be moved back to the
		1403	location he/she was before the call to C<enter_link>, or, if that fails,
		1404	to the emergency map position.
		1405
		1406	Might block.
		1407
		1408	=cut
		1409
		1410	sub cf::object::player::enter_link {
		1411	my ($self) = @_;
		1412
		1413	return if $self->map == $LINK_MAP;
		1414
		1415	$self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
		1416	if $self->map;
		1417
		1418	$self->enter_map ($LINK_MAP, 20, 20);
		1419	$self->deactivate_recursive;
		1420	}
		1421
		1422	sub cf::object::player::leave_link {
		1423	my ($self, $map, $x, $y) = @_;
		1424
		1425	my $link_pos = delete $self->{_link_pos};
		1426
		1427	unless ($map) {
		1428	# restore original map position
		1429	($map, $x, $y) = @{ $link_pos || [] };
		1430	$map = cf::map::find_map $map;
		1431
		1432	unless ($map) {
		1433	($map, $x, $y) = @$EMERGENCY_POSITION;
		1434	$map = cf::map::find_map $map
		1435	or die "FATAL: cannot load emergency map\n";
		1436	}
		1437	}
		1438
		1439	($x, $y) = (-1, -1)
		1440	unless (defined $x) && (defined $y);
		1441
		1442	# use -1 or undef as default coordinates, not 0, 0
		1443	($x, $y) = ($map->enter_x, $map->enter_y)
		1444	if $x <=0 && $y <= 0;
		1445
		1446	$map->load;
		1447
		1448	$self->activate_recursive;
		1449	$self->enter_map ($map, $x, $y);
		1450	}
		1451
		1452	=item $player_object->goto_map ($path, $x, $y)
		1453
		1454	=cut
		1455
		1456	sub cf::object::player::goto_map {
		1457	my ($self, $path, $x, $y) = @_;
		1458
		1459	$self->enter_link;
		1460
		1461	(Coro::async {
		1462	$path = new cf::path $path;
		1463
		1464	my $map = cf::map::find_map $path->as_string;
		1465	$map = $map->customise_for ($self) if $map;
		1466
		1467	warn "entering ", $map->path, " at ($x, $y)\n"
		1468	if $map;
		1469
		1470	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1471
		1472	$self->leave_link ($map, $x, $y);
		1473	})->prio (1);
		1474	}
		1475
		1476	=item $player_object->enter_exit ($exit_object)
		1477
		1478	=cut
		1479
		1480	sub parse_random_map_params {
		1481	my ($spec) = @_;
		1482
		1483	my $rmp = { # defaults
		1484	xsize => 10,
		1485	ysize => 10,
		1486	};
		1487
		1488	for (split /\n/, $spec) {
		1489	my ($k, $v) = split /\s+/, $_, 2;
		1490
		1491	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1492	}
		1493
		1494	$rmp
		1495	}
		1496
		1497	sub prepare_random_map {
		1498	my ($exit) = @_;
		1499
		1500	# all this does is basically replace the /! path by
		1501	# a new random map path (?random/...) with a seed
		1502	# that depends on the exit object
		1503
		1504	my $rmp = parse_random_map_params $exit->msg;
		1505
		1506	if ($exit->map) {
		1507	$rmp->{region} = $exit->map->region_name;
		1508	$rmp->{origin_map} = $exit->map->path;
		1509	$rmp->{origin_x} = $exit->x;
		1510	$rmp->{origin_y} = $exit->y;
		1511	}
		1512
		1513	$rmp->{random_seed} ||= $exit->random_seed;
		1514
		1515	my $data = cf::to_json $rmp;
		1516	my $md5 = Digest::MD5::md5_hex $data;
		1517
		1518	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
		1519	aio_write $fh, 0, (length $data), $data, 0;
		1520
		1521	$exit->slaying ("?random/$md5");
		1522	$exit->msg (undef);
		1523	}
		1524	}
		1525
		1526	sub cf::object::player::enter_exit {
864	my ($self, $id, %msg) = @_;	1527	my ($self, $exit) = @_;
865		1528
866	$msg{msgid} = $id;	1529	return unless $self->type == cf::PLAYER;
867		1530
868	$self->send ("ext " . to_json \%msg);	1531	$self->enter_link;
869	}
870		1532
871	#############################################################################	1533	(Coro::async {
872	# map scripting support	1534	unless (eval {
		1535
		1536	prepare_random_map $exit
		1537	if $exit->slaying eq "/!";
		1538
		1539	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
		1540	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
		1541
		1542	1;
		1543	}) {
		1544	$self->message ("Something went wrong deep within the crossfire server. "
		1545	. "I'll try to bring you back to the map you were before. "
		1546	. "Please report this to the dungeon master",
		1547	cf::NDI_UNIQUE | cf::NDI_RED);
		1548
		1549	warn "ERROR in enter_exit: $@";
		1550	$self->leave_link;
		1551	}
		1552	})->prio (1);
		1553	}
		1554
		1555	=head3 cf::client
		1556
		1557	=over 4
		1558
		1559	=item $client->send_drawinfo ($text, $flags)
		1560
		1561	Sends a drawinfo packet to the client. Circumvents output buffering so
		1562	should not be used under normal circumstances.
		1563
		1564	=cut
		1565
		1566	sub cf::client::send_drawinfo {
		1567	my ($self, $text, $flags) = @_;
		1568
		1569	utf8::encode $text;
		1570	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1571	}
		1572
		1573
		1574	=item $success = $client->query ($flags, "text", \&cb)
		1575
		1576	Queues a query to the client, calling the given callback with
		1577	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1578	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1579
		1580	Queries can fail, so check the return code. Or don't, as queries will become
		1581	reliable at some point in the future.
		1582
		1583	=cut
		1584
		1585	sub cf::client::query {
		1586	my ($self, $flags, $text, $cb) = @_;
		1587
		1588	return unless $self->state == ST_PLAYING
		1589	|| $self->state == ST_SETUP
		1590	|| $self->state == ST_CUSTOM;
		1591
		1592	$self->state (ST_CUSTOM);
		1593
		1594	utf8::encode $text;
		1595	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1596
		1597	$self->send_packet ($self->{query_queue}[0][0])
		1598	if @{ $self->{query_queue} } == 1;
		1599	}
		1600
		1601	cf::client->attach (
		1602	on_reply => sub {
		1603	my ($ns, $msg) = @_;
		1604
		1605	# this weird shuffling is so that direct followup queries
		1606	# get handled first
		1607	my $queue = delete $ns->{query_queue};
		1608
		1609	(shift @$queue)->[1]->($msg);
		1610
		1611	push @{ $ns->{query_queue} }, @$queue;
		1612
		1613	if (@{ $ns->{query_queue} } == @$queue) {
		1614	if (@$queue) {
		1615	$ns->send_packet ($ns->{query_queue}[0][0]);
		1616	} else {
		1617	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1618	}
		1619	}
		1620	},
		1621	);
		1622
		1623	=item $client->coro (\&cb)
		1624
		1625	Create a new coroutine, running the specified callback. The coroutine will
		1626	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1627	or loss of connection).
		1628
		1629	=cut
		1630
		1631	sub cf::client::coro {
		1632	my ($self, $cb) = @_;
		1633
		1634	my $coro; $coro = async {
		1635	eval {
		1636	$cb->();
		1637	};
		1638	warn $@ if $@;
		1639	};
		1640
		1641	$coro->on_destroy (sub {
		1642	delete $self->{_coro}{$coro+0};
		1643	});
		1644
		1645	$self->{_coro}{$coro+0} = $coro;
		1646
		1647	$coro
		1648	}
		1649
		1650	cf::client->attach (
		1651	on_destroy => sub {
		1652	my ($ns) = @_;
		1653
		1654	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1655	},
		1656	);
		1657
		1658	=back
		1659
		1660
		1661	=head2 SAFE SCRIPTING
		1662
		1663	Functions that provide a safe environment to compile and execute
		1664	snippets of perl code without them endangering the safety of the server
		1665	itself. Looping constructs, I/O operators and other built-in functionality
		1666	is not available in the safe scripting environment, and the number of
		1667	functions and methods that can be called is greatly reduced.
		1668
		1669	=cut
873		1670
874	our $safe = new Safe "safe";	1671	our $safe = new Safe "safe";
875	our $safe_hole = new Safe::Hole;	1672	our $safe_hole = new Safe::Hole;
876		1673
877	$SIG{FPE} = 'IGNORE';	1674	$SIG{FPE} = 'IGNORE';
878		1675
879	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	1676	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
880		1677
881	# here we export the classes and methods available to script code	1678	# here we export the classes and methods available to script code
882		1679
		1680	=pod
		1681
		1682	The following fucntions and emthods are available within a safe environment:
		1683
		1684	cf::object contr pay_amount pay_player map
		1685	cf::object::player player
		1686	cf::player peaceful
		1687	cf::map trigger
		1688
		1689	=cut
		1690
883	for (	1691	for (
884	["cf::object" => qw(contr pay_amount pay_player)],	1692	["cf::object" => qw(contr pay_amount pay_player map)],
885	["cf::object::player" => qw(player)],	1693	["cf::object::player" => qw(player)],
886	["cf::player" => qw(peaceful)],	1694	["cf::player" => qw(peaceful)],
		1695	["cf::map" => qw(trigger)],
887	) {	1696	) {
888	no strict 'refs';	1697	no strict 'refs';
889	my ($pkg, @funs) = @$_;	1698	my ($pkg, @funs) = @$_;
890	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1699	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
891	for @funs;	1700	for @funs;
892	}	1701	}
		1702
		1703	=over 4
		1704
		1705	=item @retval = safe_eval $code, [var => value, ...]
		1706
		1707	Compiled and executes the given perl code snippet. additional var/value
		1708	pairs result in temporary local (my) scalar variables of the given name
		1709	that are available in the code snippet. Example:
		1710
		1711	my $five = safe_eval '$first + $second', first => 1, second => 4;
		1712
		1713	=cut
893		1714
894	sub safe_eval($;@) {	1715	sub safe_eval($;@) {
895	my ($code, %vars) = @_;	1716	my ($code, %vars) = @_;
896		1717
897	my $qcode = $code;	1718	my $qcode = $code;
…		…
920	}	1741	}
921		1742
922	wantarray ? @res : $res[0]	1743	wantarray ? @res : $res[0]
923	}	1744	}
924		1745
		1746	=item cf::register_script_function $function => $cb
		1747
		1748	Register a function that can be called from within map/npc scripts. The
		1749	function should be reasonably secure and should be put into a package name
		1750	like the extension.
		1751
		1752	Example: register a function that gets called whenever a map script calls
		1753	C<rent::overview>, as used by the C<rent> extension.
		1754
		1755	cf::register_script_function "rent::overview" => sub {
		1756	...
		1757	};
		1758
		1759	=cut
		1760
925	sub register_script_function {	1761	sub register_script_function {
926	my ($fun, $cb) = @_;	1762	my ($fun, $cb) = @_;
927		1763
928	no strict 'refs';	1764	no strict 'refs';
929	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1765	*{"safe::$fun"} = $safe_hole->wrap ($cb);
930	}	1766	}
931		1767
		1768	=back
		1769
		1770	=cut
		1771
		1772	#############################################################################
		1773
		1774	=head2 EXTENSION DATABASE SUPPORT
		1775
		1776	Crossfire maintains a very simple database for extension use. It can
		1777	currently store anything that can be serialised using Storable, which
		1778	excludes objects.
		1779
		1780	The parameter C<$family> should best start with the name of the extension
		1781	using it, it should be unique.
		1782
		1783	=over 4
		1784
		1785	=item $hashref = cf::db_get $family
		1786
		1787	Return a hashref for use by the extension C<$family>, which can be
		1788	modified. After modifications, you have to call C<cf::db_dirty> or
		1789	C<cf::db_sync>.
		1790
		1791	=item $value = cf::db_get $family => $key
		1792
		1793	Returns a single value from the database
		1794
		1795	=item cf::db_put $family => $hashref
		1796
		1797	Stores the given family hashref into the database. Updates are delayed, if
		1798	you want the data to be synced to disk immediately, use C<cf::db_sync>.
		1799
		1800	=item cf::db_put $family => $key => $value
		1801
		1802	Stores the given C<$value> in the family hash. Updates are delayed, if you
		1803	want the data to be synced to disk immediately, use C<cf::db_sync>.
		1804
		1805	=item cf::db_dirty
		1806
		1807	Marks the database as dirty, to be updated at a later time.
		1808
		1809	=item cf::db_sync
		1810
		1811	Immediately write the database to disk I<if it is dirty>.
		1812
		1813	=cut
		1814
		1815	our $DB;
		1816
		1817	{
		1818	my $path = cf::localdir . "/database.pst";
		1819
		1820	sub db_load() {
		1821	warn "loading database $path\n";#d# remove later
		1822	$DB = stat $path ? Storable::retrieve $path : { };
		1823	}
		1824
		1825	my $pid;
		1826
		1827	sub db_save() {
		1828	warn "saving database $path\n";#d# remove later
		1829	waitpid $pid, 0 if $pid;
		1830	if (0 == ($pid = fork)) {
		1831	$DB->{_meta}{version} = 1;
		1832	Storable::nstore $DB, "$path~";
		1833	rename "$path~", $path;
		1834	cf::_exit 0 if defined $pid;
		1835	}
		1836	}
		1837
		1838	my $dirty;
		1839
		1840	sub db_sync() {
		1841	db_save if $dirty;
		1842	undef $dirty;
		1843	}
		1844
		1845	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
		1846	db_sync;
		1847	});
		1848
		1849	sub db_dirty() {
		1850	$dirty = 1;
		1851	$idle->start;
		1852	}
		1853
		1854	sub db_get($;$) {
		1855	@_ >= 2
		1856	? $DB->{$_[0]}{$_[1]}
		1857	: ($DB->{$_[0]} ||= { })
		1858	}
		1859
		1860	sub db_put($$;$) {
		1861	if (@_ >= 3) {
		1862	$DB->{$_[0]}{$_[1]} = $_[2];
		1863	} else {
		1864	$DB->{$_[0]} = $_[1];
		1865	}
		1866	db_dirty;
		1867	}
		1868
		1869	cf::global->attach (
		1870	prio => 10000,
		1871	on_cleanup => sub {
		1872	db_sync;
		1873	},
		1874	);
		1875	}
		1876
932	#############################################################################	1877	#############################################################################
933	# the server's main()	1878	# the server's main()
934		1879
		1880	sub cfg_load {
		1881	open my $fh, "<:utf8", cf::confdir . "/config"
		1882	or return;
		1883
		1884	local $/;
		1885	*CFG = YAML::Syck::Load <$fh>;
		1886	}
		1887
935	sub main {	1888	sub main {
		1889	# we must not ever block the main coroutine
		1890	local $Coro::idle = sub {
		1891	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		1892	(Coro::unblock_sub {
		1893	Event::one_event;
		1894	})->();
		1895	};
		1896
		1897	cfg_load;
		1898	db_load;
936	load_extensions;	1899	load_extensions;
937	Event::loop;	1900	Event::loop;
938	}	1901	}
939		1902
940	#############################################################################	1903	#############################################################################
941	# initialisation	1904	# initialisation
942		1905
		1906	sub reload() {
		1907	# can/must only be called in main
		1908	if ($Coro::current != $Coro::main) {
		1909	warn "can only reload from main coroutine\n";
		1910	return;
		1911	}
		1912
		1913	warn "reloading...";
		1914
		1915	local $FREEZE = 1;
		1916	cf::emergency_save;
		1917
		1918	eval {
		1919	# if anything goes wrong in here, we should simply crash as we already saved
		1920
		1921	# cancel all watchers
		1922	for (Event::all_watchers) {
		1923	$_->cancel if $_->data & WF_AUTOCANCEL;
		1924	}
		1925
		1926	# cancel all extension coros
		1927	$_->cancel for values %EXT_CORO;
		1928	%EXT_CORO = ();
		1929
		1930	# unload all extensions
		1931	for (@exts) {
		1932	warn "unloading <$_>";
		1933	unload_extension $_;
		1934	}
		1935
		1936	# unload all modules loaded from $LIBDIR
		1937	while (my ($k, $v) = each %INC) {
		1938	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		1939
		1940	warn "removing <$k>";
		1941	delete $INC{$k};
		1942
		1943	$k =~ s/\.pm$//;
		1944	$k =~ s/\//::/g;
		1945
		1946	if (my $cb = $k->can ("unload_module")) {
		1947	$cb->();
		1948	}
		1949
		1950	Symbol::delete_package $k;
		1951	}
		1952
		1953	# sync database to disk
		1954	cf::db_sync;
		1955	IO::AIO::flush;
		1956
		1957	# get rid of safe::, as good as possible
		1958	Symbol::delete_package "safe::$_"
		1959	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		1960
		1961	# remove register_script_function callbacks
		1962	# TODO
		1963
		1964	# unload cf.pm "a bit"
		1965	delete $INC{"cf.pm"};
		1966
		1967	# don't, removes xs symbols, too,
		1968	# and global variables created in xs
		1969	#Symbol::delete_package __PACKAGE__;
		1970
		1971	# reload cf.pm
		1972	warn "reloading cf.pm";
		1973	require cf;
		1974	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		1975
		1976	# load config and database again
		1977	cf::cfg_load;
		1978	cf::db_load;
		1979
		1980	# load extensions
		1981	warn "load extensions";
		1982	cf::load_extensions;
		1983
		1984	# reattach attachments to objects
		1985	warn "reattach";
		1986	_global_reattach;
		1987	};
		1988
		1989	if ($@) {
		1990	warn $@;
		1991	warn "error while reloading, exiting.";
		1992	exit 1;
		1993	}
		1994
		1995	warn "reloaded successfully";
		1996	};
		1997
		1998	#############################################################################
		1999
		2000	unless ($LINK_MAP) {
		2001	$LINK_MAP = cf::map::new;
		2002
		2003	$LINK_MAP->width (41);
		2004	$LINK_MAP->height (41);
		2005	$LINK_MAP->alloc;
		2006	$LINK_MAP->path ("{link}");
		2007	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		2008	$LINK_MAP->in_memory (MAP_IN_MEMORY);
		2009
		2010	# dirty hack because... archetypes are not yet loaded
		2011	Event->timer (
		2012	after => 2,
		2013	cb => sub {
		2014	$_[0]->w->cancel;
		2015
		2016	# provide some exits "home"
		2017	my $exit = cf::object::new "exit";
		2018
		2019	$exit->slaying ($EMERGENCY_POSITION->[0]);
		2020	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
		2021	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
		2022
		2023	$LINK_MAP->insert ($exit->clone, 19, 19);
		2024	$LINK_MAP->insert ($exit->clone, 19, 20);
		2025	$LINK_MAP->insert ($exit->clone, 19, 21);
		2026	$LINK_MAP->insert ($exit->clone, 20, 19);
		2027	$LINK_MAP->insert ($exit->clone, 20, 21);
		2028	$LINK_MAP->insert ($exit->clone, 21, 19);
		2029	$LINK_MAP->insert ($exit->clone, 21, 20);
		2030	$LINK_MAP->insert ($exit->clone, 21, 21);
		2031
		2032	$exit->destroy;
		2033	});
		2034
		2035	$LINK_MAP->{deny_save} = 1;
		2036	$LINK_MAP->{deny_reset} = 1;
		2037
		2038	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
		2039	}
		2040
943	register "<global>", __PACKAGE__;	2041	register "<global>", __PACKAGE__;
944		2042
		2043	register_command "reload" => sub {
		2044	my ($who, $arg) = @_;
		2045
		2046	if ($who->flag (FLAG_WIZ)) {
		2047	$who->message ("start of reload.");
		2048	reload;
		2049	$who->message ("end of reload.");
		2050	}
		2051	};
		2052
945	unshift @INC, $LIBDIR;	2053	unshift @INC, $LIBDIR;
946		2054
947	$TICK_WATCHER = Event->timer (	2055	$TICK_WATCHER = Event->timer (
		2056	reentrant => 0,
948	prio => 1,	2057	prio => 0,
949	at => $NEXT_TICK || 1,	2058	at => $NEXT_TICK || $TICK,
		2059	data => WF_AUTOCANCEL,
950	cb => sub {	2060	cb => sub {
		2061	unless ($FREEZE) {
951	cf::server_tick; # one server iteration	2062	cf::server_tick; # one server iteration
		2063	$RUNTIME += $TICK;
		2064	}
952		2065
953	my $NOW = Event::time;
954	$NEXT_TICK += $TICK;	2066	$NEXT_TICK += $TICK;
955		2067
956	# if we are delayed by four ticks, skip them all	2068	# if we are delayed by four ticks or more, skip them all
957	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2069	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
958		2070
959	$TICK_WATCHER->at ($NEXT_TICK);	2071	$TICK_WATCHER->at ($NEXT_TICK);
960	$TICK_WATCHER->start;	2072	$TICK_WATCHER->start;
961	},	2073	},
962	);	2074	);
963		2075
964	_reload_2;	2076	IO::AIO::max_poll_time $TICK * 0.2;
		2077
		2078	Event->io (
		2079	fd => IO::AIO::poll_fileno,
		2080	poll => 'r',
		2081	prio => 5,
		2082	data => WF_AUTOCANCEL,
		2083	cb => \&IO::AIO::poll_cb,
		2084	);
		2085
		2086	Event->timer (
		2087	data => WF_AUTOCANCEL,
		2088	after => 0,
		2089	interval => 10,
		2090	cb => sub {
		2091	(Coro::unblock_sub {
		2092	write_runtime
		2093	or warn "ERROR: unable to write runtime file: $!";
		2094	})->();
		2095	},
		2096	);
965		2097
966	1	2098	1
967		2099

Diff Legend

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