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

Diff Legend

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