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

Diff Legend

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