prosody
0c62bed9d338
core/hostmanager.lua

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody

Annotate

core/hostmanager.lua @ 2006:0c62bed9d338

MUC: Added support for reason messages in role and affiliation changes (e.g., reason for kick, etc).
author Waqas Hussain <waqas20@gmail.com>
date Sun, 18 Oct 2009 15:53:08 +0500
parent 1980:8fceabd84d74
child 2321:7e7484a4e821
child 2855:66a1aa0bedc0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1522
569d58d21612 Add copyright header to those files missing one
Matthew Wild <mwild1@gmail.com>
parents: 1467
diff changeset
1 -- Prosody IM
569d58d21612 Add copyright header to those files missing one
Matthew Wild <mwild1@gmail.com>
parents: 1467
diff changeset
2 -- Copyright (C) 2008-2009 Matthew Wild
569d58d21612 Add copyright header to those files missing one
Matthew Wild <mwild1@gmail.com>
parents: 1467
diff changeset
3 -- Copyright (C) 2008-2009 Waqas Hussain
569d58d21612 Add copyright header to those files missing one
Matthew Wild <mwild1@gmail.com>
parents: 1467
diff changeset
4 --
569d58d21612 Add copyright header to those files missing one
Matthew Wild <mwild1@gmail.com>
parents: 1467
diff changeset
5 -- This project is MIT/X11 licensed. Please see the
569d58d21612 Add copyright header to those files missing one
Matthew Wild <mwild1@gmail.com>
parents: 1467
diff changeset
6 -- COPYING file in the source package for more information.
569d58d21612 Add copyright header to those files missing one
Matthew Wild <mwild1@gmail.com>
parents: 1467
diff changeset
7 --
569d58d21612 Add copyright header to those files missing one
Matthew Wild <mwild1@gmail.com>
parents: 1467
diff changeset
8
1893
2d202336c9b6 hostmanager: Create ssl context for each host (fixes #30 for outgoing s2s connections)
Matthew Wild <mwild1@gmail.com>
parents: 1848
diff changeset
9 local ssl = ssl
569
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
10
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
11 local hosts = hosts;
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
12 local configmanager = require "core.configmanager";
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
13 local eventmanager = require "core.eventmanager";
1975
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
14 local modulemanager = require "core.modulemanager";
1188
fa48e69c4786 core: hosts[*].events
Waqas Hussain <waqas20@gmail.com>
parents: 1095
diff changeset
15 local events_new = require "util.events".new;
569
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16
1975
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
17 if not _G.prosody.incoming_s2s then
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
18 require "core.s2smanager";
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
19 end
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
20 local incoming_s2s = _G.prosody.incoming_s2s;
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
21
1893
2d202336c9b6 hostmanager: Create ssl context for each host (fixes #30 for outgoing s2s connections)
Matthew Wild <mwild1@gmail.com>
parents: 1848
diff changeset
22 -- These are the defaults if not overridden in the config
2d202336c9b6 hostmanager: Create ssl context for each host (fixes #30 for outgoing s2s connections)
Matthew Wild <mwild1@gmail.com>
parents: 1848
diff changeset
23 local default_ssl_ctx = { mode = "client", protocol = "sslv23", capath = "/etc/ssl/certs", verify = "none"; };
1980
8fceabd84d74 hostmanager: Create a server sslctx for incoming connections
Matthew Wild <mwild1@gmail.com>
parents: 1975
diff changeset
24 local default_ssl_ctx_in = { mode = "server", protocol = "sslv23", capath = "/etc/ssl/certs", verify = "none"; };
1893
2d202336c9b6 hostmanager: Create ssl context for each host (fixes #30 for outgoing s2s connections)
Matthew Wild <mwild1@gmail.com>
parents: 1848
diff changeset
25
575
428c951d0a33 Log in hostmanager when a vhost is activated/deactivated
Matthew Wild <mwild1@gmail.com>
parents: 569
diff changeset
26 local log = require "util.logger".init("hostmanager");
428c951d0a33 Log in hostmanager when a vhost is activated/deactivated
Matthew Wild <mwild1@gmail.com>
parents: 569
diff changeset
27
1893
2d202336c9b6 hostmanager: Create ssl context for each host (fixes #30 for outgoing s2s connections)
Matthew Wild <mwild1@gmail.com>
parents: 1848
diff changeset
28 local pairs, setmetatable = pairs, setmetatable;
569
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
29
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
30 module "hostmanager"
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
31
1095
cad4205f4925 hostmanager: Reduce log output at startup to 'debug'
Matthew Wild <mwild1@gmail.com>
parents: 749
diff changeset
32 local hosts_loaded_once;
cad4205f4925 hostmanager: Reduce log output at startup to 'debug'
Matthew Wild <mwild1@gmail.com>
parents: 749
diff changeset
33
569
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
34 local function load_enabled_hosts(config)
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
35 local defined_hosts = config or configmanager.getconfig();
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
36
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
37 for host, host_config in pairs(defined_hosts) do
1848
0033359aeb70 hostmanager: Only load vhosts, not components
Matthew Wild <mwild1@gmail.com>
parents: 1614
diff changeset
38 if host ~= "*" and (host_config.core.enabled == nil or host_config.core.enabled) and not host_config.core.component_module then
569
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
39 activate(host, host_config);
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
40 end
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
41 end
749
1359492f45d7 hostmanager: Fire event when all hosts are loaded from config
Matthew Wild <mwild1@gmail.com>
parents: 575
diff changeset
42 eventmanager.fire_event("hosts-activated", defined_hosts);
1095
cad4205f4925 hostmanager: Reduce log output at startup to 'debug'
Matthew Wild <mwild1@gmail.com>
parents: 749
diff changeset
43 hosts_loaded_once = true;
569
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
44 end
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
45
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
46 eventmanager.add_event_hook("server-starting", load_enabled_hosts);
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
47
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
48 function activate(host, host_config)
1467
fc420e9585c2 hostmanager: Add disallow_s2s to config, defaults to false unless anonymous_login is enabled, then defaults to true
Matthew Wild <mwild1@gmail.com>
parents: 1188
diff changeset
49 hosts[host] = {type = "local", connected = true, sessions = {},
fc420e9585c2 hostmanager: Add disallow_s2s to config, defaults to false unless anonymous_login is enabled, then defaults to true
Matthew Wild <mwild1@gmail.com>
parents: 1188
diff changeset
50 host = host, s2sout = {}, events = events_new(),
fc420e9585c2 hostmanager: Add disallow_s2s to config, defaults to false unless anonymous_login is enabled, then defaults to true
Matthew Wild <mwild1@gmail.com>
parents: 1188
diff changeset
51 disallow_s2s = configmanager.get(host, "core", "disallow_s2s")
fc420e9585c2 hostmanager: Add disallow_s2s to config, defaults to false unless anonymous_login is enabled, then defaults to true
Matthew Wild <mwild1@gmail.com>
parents: 1188
diff changeset
52 or (configmanager.get(host, "core", "anonymous_login")
fc420e9585c2 hostmanager: Add disallow_s2s to config, defaults to false unless anonymous_login is enabled, then defaults to true
Matthew Wild <mwild1@gmail.com>
parents: 1188
diff changeset
53 and (configmanager.get(host, "core", "disallow_s2s") ~= false))
fc420e9585c2 hostmanager: Add disallow_s2s to config, defaults to false unless anonymous_login is enabled, then defaults to true
Matthew Wild <mwild1@gmail.com>
parents: 1188
diff changeset
54 };
1614
951ed38ad64f hostmanager: Warn when user puts port configuration under vhost section
Matthew Wild <mwild1@gmail.com>
parents: 1522
diff changeset
55 for option_name in pairs(host_config.core) do
951ed38ad64f hostmanager: Warn when user puts port configuration under vhost section
Matthew Wild <mwild1@gmail.com>
parents: 1522
diff changeset
56 if option_name:match("_ports$") then
951ed38ad64f hostmanager: Warn when user puts port configuration under vhost section
Matthew Wild <mwild1@gmail.com>
parents: 1522
diff changeset
57 log("warn", "%s: Option '%s' has no effect for virtual hosts - put it in global Host \"*\" instead", host, option_name);
951ed38ad64f hostmanager: Warn when user puts port configuration under vhost section
Matthew Wild <mwild1@gmail.com>
parents: 1522
diff changeset
58 end
951ed38ad64f hostmanager: Warn when user puts port configuration under vhost section
Matthew Wild <mwild1@gmail.com>
parents: 1522
diff changeset
59 end
1893
2d202336c9b6 hostmanager: Create ssl context for each host (fixes #30 for outgoing s2s connections)
Matthew Wild <mwild1@gmail.com>
parents: 1848
diff changeset
60
1925
6897bd311afa hostmanager: Only initialse SSL contexts if SSL library available
Matthew Wild <mwild1@gmail.com>
parents: 1893
diff changeset
61 if ssl then
6897bd311afa hostmanager: Only initialse SSL contexts if SSL library available
Matthew Wild <mwild1@gmail.com>
parents: 1893
diff changeset
62 local ssl_config = host_config.core.ssl or configmanager.get("*", "core", "ssl");
6897bd311afa hostmanager: Only initialse SSL contexts if SSL library available
Matthew Wild <mwild1@gmail.com>
parents: 1893
diff changeset
63 if ssl_config then
6897bd311afa hostmanager: Only initialse SSL contexts if SSL library available
Matthew Wild <mwild1@gmail.com>
parents: 1893
diff changeset
64 hosts[host].ssl_ctx = ssl.newcontext(setmetatable(ssl_config, { __index = default_ssl_ctx }));
1980
8fceabd84d74 hostmanager: Create a server sslctx for incoming connections
Matthew Wild <mwild1@gmail.com>
parents: 1975
diff changeset
65 hosts[host].ssl_ctx_in = ssl.newcontext(setmetatable(ssl_config, { __index = default_ssl_ctx_in }));
1925
6897bd311afa hostmanager: Only initialse SSL contexts if SSL library available
Matthew Wild <mwild1@gmail.com>
parents: 1893
diff changeset
66 end
1893
2d202336c9b6 hostmanager: Create ssl context for each host (fixes #30 for outgoing s2s connections)
Matthew Wild <mwild1@gmail.com>
parents: 1848
diff changeset
67 end
2d202336c9b6 hostmanager: Create ssl context for each host (fixes #30 for outgoing s2s connections)
Matthew Wild <mwild1@gmail.com>
parents: 1848
diff changeset
68
1095
cad4205f4925 hostmanager: Reduce log output at startup to 'debug'
Matthew Wild <mwild1@gmail.com>
parents: 749
diff changeset
69 log((hosts_loaded_once and "info") or "debug", "Activated host: %s", host);
569
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
70 eventmanager.fire_event("host-activated", host, host_config);
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
71 end
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
72
1975
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
73 function deactivate(host, reason)
569
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
74 local host_session = hosts[host];
575
428c951d0a33 Log in hostmanager when a vhost is activated/deactivated
Matthew Wild <mwild1@gmail.com>
parents: 569
diff changeset
75 log("info", "Deactivating host: %s", host);
569
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
76 eventmanager.fire_event("host-deactivating", host, host_session);
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
77
1975
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
78 reason = reason or { condition = "host-gone", text = "This server has stopped serving "..host };
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
79
569
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
80 -- Disconnect local users, s2s connections
1975
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
81 if host_session.sessions then
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
82 for username, user in pairs(host_session.sessions) do
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
83 for resource, session in pairs(user.sessions) do
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
84 log("debug", "Closing connection for %s@%s/%s", username, host, resource);
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
85 session:close(reason);
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
86 end
569
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
87 end
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
88 end
1975
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
89 if host_session.s2sout then
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
90 for remotehost, session in pairs(host_session.s2sout) do
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
91 if session.close then
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
92 log("debug", "Closing outgoing connection to %s", remotehost);
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
93 if session.srv_hosts then session.srv_hosts = nil; end
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
94 session:close(reason);
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
95 end
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
96 end
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
97 end
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
98 for remote_session in pairs(incoming_s2s) do
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
99 if remote_session.to_host == host then
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
100 log("debug", "Closing incoming connection from %s", remote_session.from_host or "<unknown>");
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
101 remote_session:close(reason);
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
102 end
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
103 end
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
104
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
105 if host_session.modules then
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
106 for module in pairs(host_session.modules) do
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
107 modulemanager.unload(host, module);
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
108 end
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
109 end
a9998fac292c hostmanager: deactivate() now accepts a reason, closes s2s connections as well as disconnecting users, and unloads modules for the host
Matthew Wild <mwild1@gmail.com>
parents: 1974
diff changeset
110
569
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
111 hosts[host] = nil;
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
112 eventmanager.fire_event("host-deactivated", host);
575
428c951d0a33 Log in hostmanager when a vhost is activated/deactivated
Matthew Wild <mwild1@gmail.com>
parents: 569
diff changeset
113 log("info", "Deactivated host: %s", host);
569
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
114 end
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
115
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
116 function getconfig(name)
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
117 end
5216efe6088b Add hostmanager, and eventmanager
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
118
1974
cfac07d8428e hostmanager: Add return _M;
Matthew Wild <mwild1@gmail.com>
parents: 1925
diff changeset
119 return _M;