3 * @copyright Copyright (C) 2010-2023, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Module;
24 use Friendica\BaseModule;
25 use Friendica\Core\Renderer;
26 use Friendica\Core\Search;
29 use Friendica\Model\User;
30 use Friendica\Network\HTTPException;
31 use Friendica\Protocol\Email;
32 use Friendica\Util\Strings;
35 * Invite people to friendica
37 class Invite extends BaseModule
39 protected function post(array $request = [])
41 if (!DI::userSession()->getLocalUserId()) {
42 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
45 self::checkFormSecurityTokenRedirectOnError('/', 'send_invite');
48 $config = DI::config();
50 $max_invites = intval($config->get('system', 'max_invites'));
55 $current_invites = intval(DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'sent_invites'));
56 if ($current_invites > $max_invites) {
57 throw new HTTPException\ForbiddenException(DI::l10n()->t('Total invitation limit exceeded.'));
61 $recipients = !empty($_POST['recipients']) ? explode("\n", $_POST['recipients']) : [];
62 $message = !empty($_POST['message']) ? Strings::escapeHtml(trim($_POST['message'])) : '';
65 $invitation_only = false;
66 $invites_remaining = null;
68 if ($config->get('system', 'invitation_only')) {
69 $invitation_only = true;
70 $invites_remaining = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'invites_remaining');
71 if ((!$invites_remaining) && (!$app->isSiteAdmin())) {
72 throw new HTTPException\ForbiddenException();
76 $user = User::getById(DI::userSession()->getLocalUserId());
78 foreach ($recipients as $recipient) {
79 $recipient = trim($recipient);
81 if (!filter_var($recipient, FILTER_VALIDATE_EMAIL)) {
82 DI::sysmsg()->addNotice(DI::l10n()->t('%s : Not a valid email address.', $recipient));
86 if ($invitation_only && ($invites_remaining || $app->isSiteAdmin())) {
87 $code = Model\Register::createForInvitation();
88 $nmessage = str_replace('$invite_code', $code, $message);
90 if (!$app->isSiteAdmin()) {
92 if ($invites_remaining >= 0) {
93 DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'system', 'invites_remaining', $invites_remaining);
102 $additional_headers = 'From: "' . $user['email'] . '" <' . DI::emailer()->getSiteEmailAddress() . ">\n"
103 . 'Content-type: text/plain; charset=UTF-8' . "\n"
104 . 'Content-transfer-encoding: 8bit';
108 Email::encodeHeader(DI::l10n()->t('Please join us on Friendica'), 'UTF-8'),
110 $additional_headers);
115 DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'system', 'sent_invites', $current_invites);
116 if ($current_invites > $max_invites) {
117 DI::sysmsg()->addNotice(DI::l10n()->t('Invitation limit exceeded. Please contact your site administrator.'));
121 DI::sysmsg()->addNotice(DI::l10n()->t('%s : Message delivery failed.', $recipient));
125 DI::sysmsg()->addInfo(DI::l10n()->tt('%d message sent.', '%d messages sent.', $total));
128 protected function content(array $request = []): string
130 if (!DI::userSession()->getLocalUserId()) {
131 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
135 $config = DI::config();
139 if ($config->get('system', 'invitation_only')) {
141 $x = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'invites_remaining');
142 if ((!$x) && (!$app->isSiteAdmin())) {
143 throw new HTTPException\ForbiddenException(DI::l10n()->t('You have no more invitations available'));
147 $dirLocation = Search::getGlobalDirectory();
148 if (strlen($dirLocation)) {
149 if ($config->get('config', 'register_policy') === Register::CLOSED) {
150 $linkTxt = DI::l10n()->t('Visit %s for a list of public sites that you can join. Friendica members on other sites can all connect with each other, as well as with members of many other social networks.', $dirLocation . '/servers');
152 $linkTxt = DI::l10n()->t('To accept this invitation, please visit and register at %s or any other public Friendica website.', DI::baseUrl() . '/register')
153 . "\r\n" . "\r\n" . DI::l10n()->t('Friendica sites all inter-connect to create a huge privacy-enhanced social web that is owned and controlled by its members. They can also connect with many traditional social networks. See %s for a list of alternate Friendica sites you can join.', $dirLocation . '/servers');
155 } else { // there is no global directory URL defined
156 if ($config->get('config', 'register_policy') === Register::CLOSED) {
157 return DI::l10n()->t('Our apologies. This system is not currently configured to connect with other public sites or invite members.');
159 $linkTxt = DI::l10n()->t('To accept this invitation, please visit and register at %s.', DI::baseUrl() . '/register'
160 . "\r\n" . "\r\n" . DI::l10n()->t('Friendica sites all inter-connect to create a huge privacy-enhanced social web that is owned and controlled by its members. They can also connect with many traditional social networks.'));
164 $tpl = Renderer::getMarkupTemplate('invite.tpl');
165 return Renderer::replaceMacros($tpl, [
166 '$form_security_token' => self::getFormSecurityToken('send_invite'),
167 '$title' => DI::l10n()->t('Send invitations'),
168 '$recipients' => ['recipients', DI::l10n()->t('Enter email addresses, one per line:')],
171 DI::l10n()->t('Your message:'),
172 DI::l10n()->t('You are cordially invited to join me and other close friends on Friendica - and help us to create a better social web.') . "\r\n" . "\r\n"
174 . "\r\n" . "\r\n" . (($inviteOnly) ? DI::l10n()->t('You will need to supply this invitation code: $invite_code') . "\r\n" . "\r\n" : '') . DI::l10n()->t('Once you have registered, please connect with me via my profile page at:')
175 . "\r\n" . "\r\n" . DI::baseUrl() . '/profile/' . $app->getLoggedInUserNickname()
176 . "\r\n" . "\r\n" . DI::l10n()->t('For more information about the Friendica project and why we feel it is important, please visit http://friendi.ca') . "\r\n" . "\r\n",
178 '$submit' => DI::l10n()->t('Submit')