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

Diff Legend

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