4 * Description: Friendica addon with functions suitable for a public server. WARNING: This addon is currently not well maintained. It may produce unexpected results. Use with caution!
6 * Author: Keith Fernie <http://friendika.me4.it/profile/keith>
10 use Friendica\BaseModule;
11 use Friendica\Core\Hook;
12 use Friendica\Core\Logger;
13 use Friendica\Core\Renderer;
14 use Friendica\Database\DBA;
16 use Friendica\Model\Notification;
17 use Friendica\Model\User;
18 use Friendica\Core\Config\Util\ConfigFileManager;
19 use Friendica\Util\DateTimeFormat;
21 function public_server_install()
23 Hook::register('load_config', 'addon/public_server/public_server.php', 'public_server_load_config');
24 Hook::register('register_account', 'addon/public_server/public_server.php', 'public_server_register_account');
25 Hook::register('cron', 'addon/public_server/public_server.php', 'public_server_cron');
26 Hook::register('enotify', 'addon/public_server/public_server.php', 'public_server_enotify');
27 Hook::register('logged_in', 'addon/public_server/public_server.php', 'public_server_login');
30 function public_server_load_config(App $a, ConfigFileManager $loader)
32 $a->getConfigCache()->load($loader->loadAddonConfig('public_server'), \Friendica\Core\Config\ValueObject\Cache::SOURCE_STATIC);
35 function public_server_register_account(App $a, $b)
39 $days = DI::config()->get('public_server', 'expiredays');
40 $days_posts = DI::config()->get('public_server', 'expireposts');
45 $fields = ['account_expires_on' => DateTimeFormat::utc('now +' . $days . ' days'), 'expire' => $days_posts];
46 DBA::update('user', $fields, ['uid' => $uid]);
49 function public_server_cron(App $a, $b)
51 Logger::notice("public_server: cron start");
53 $users = DBA::selectToArray('user', [], ["`account_expires_on` > ? AND `account_expires_on` < ?
54 AND `expire_notification_sent` <= ?", DBA::NULL_DATETIME, DateTimeFormat::utc('now + 5 days'), DBA::NULL_DATETIME]);
55 foreach ($users as $rr) {
56 DI::notify()->createFromArray([
57 'type' => Notification\Type::SYSTEM,
59 'system_type' => 'public_server_expire',
60 'source_name' => DI::l10n()->t('Administrator'),
61 'source_link' => DI::baseUrl()->get(),
62 'source_photo' => DI::baseUrl()->get() . '/images/person-80.jpg',
65 $fields = ['expire_notification_sent' => DateTimeFormat::utcNow()];
66 DBA::update('user', $fields, ['uid' => $rr['uid']]);
69 $nologin = DI::config()->get('public_server', 'nologin', false);
71 $users = DBA::selectToArray('user', [], ["NOT `account_expired` AND `login_date` <= ? AND `register_date` < ? AND `account_expires_on` <= ?",
72 DBA::NULL_DATETIME, DateTimeFormat::utc('now - ' . (int)$nologin . ' days'), DBA::NULL_DATETIME]);
73 foreach ($users as $rr) {
74 $fields = ['account_expires_on' => DateTimeFormat::utc('now +6 days')];
75 DBA::update('user', $fields, ['uid' => $rr['uid']]);
79 $flagusers = DI::config()->get('public_server', 'flagusers', false);
81 $users = DBA::selectToArray('user', [], ["NOT `account_expired` AND `login_date` < ? AND `account_expires_on` <= ? AND `page-flags` = ?",
82 DateTimeFormat::utc('now - ' . (int)$flagusers . ' days'), DBA::NULL_DATETIME, User::PAGE_FLAGS_NORMAL]);
83 foreach ($users as $rr) {
84 $fields = ['account_expires_on' => DateTimeFormat::utc('now +6 days')];
85 DBA::update('user', $fields, ['uid' => $rr['uid']]);
89 $flagposts = DI::config()->get('public_server', 'flagposts');
90 $flagpostsexpire = DI::config()->get('public_server', 'flagpostsexpire');
91 if ($flagposts && $flagpostsexpire) {
92 $users = DBA::selectToArray('user', [], ["NOT `account_expired` AND `login_date` < ? AND `account_expires_on` <= ? AND NOT `expire` AND `page-flags` = ?",
93 DateTimeFormat::utc('now - ' . (int)$flagposts . ' days'), DBA::NULL_DATETIME, User::PAGE_FLAGS_NORMAL]);
94 foreach ($users as $rr) {
95 DBA::update('user', ['expire' => $flagpostsexpire], ['uid' => $rr['uid']]);
99 Logger::notice("public_server: cron end");
102 function public_server_enotify(App $a, array &$b)
104 if (!empty($b['params']) && $b['params']['type'] == Notification\Type::SYSTEM
105 && !empty($b['params']['system_type']) && $b['params']['system_type'] === 'public_server_expire') {
106 $b['itemlink'] = DI::baseUrl()->get();
107 $b['epreamble'] = $b['preamble'] = DI::l10n()->t('Your account on %s will expire in a few days.', DI::config()->get('system', 'sitename'));
108 $b['subject'] = DI::l10n()->t('Your Friendica account is about to expire.');
109 $b['body'] = DI::l10n()->t("Hi %1\$s,\n\nYour account on %2\$s will expire in less than five days. You may keep your account by logging in at least once every 30 days", $b['params']['to_name'], "[url=" . DI::config()->get('system', 'url') . "]" . DI::config()->get('config', 'sitename') . "[/url]");
113 function public_server_login(App $a, $b)
115 $days = DI::config()->get('public_server', 'expiredays');
120 $fields = ['account_expires_on' => DateTimeFormat::utc('now +' . $days . ' days')];
121 $condition = ["`uid` = ? AND `account_expires_on` > ?", DI::userSession()->getLocalUserId(), DBA::NULL_DATETIME];
122 DBA::update('user', $fields, $condition);
125 function public_server_addon_admin_post(App $a)
127 BaseModule::checkFormSecurityTokenRedirectOnError('/admin/addons/publicserver', 'publicserver');
129 DI::config()->set('public_server', 'expiredays', trim($_POST['expiredays'] ?? ''));
130 DI::config()->set('public_server', 'expireposts', trim($_POST['expireposts'] ?? ''));
131 DI::config()->set('public_server', 'nologin', trim($_POST['nologin'] ?? ''));
132 DI::config()->set('public_server', 'flagusers', trim($_POST['flagusers'] ?? ''));
133 DI::config()->set('public_server', 'flagposts', trim($_POST['flagposts'] ?? ''));
134 DI::config()->set('public_server', 'flagpostsexpire', trim($_POST['flagpostsexpire'] ?? ''));
137 function public_server_addon_admin(App $a, string &$o)
139 $token = BaseModule::getFormSecurityToken('publicserver');
140 $t = Renderer::getMarkupTemplate('admin.tpl', 'addon/public_server');
141 $o = Renderer::replaceMacros($t, [
142 '$submit' => DI::l10n()->t('Save Settings'),
143 '$form_security_token' => $token,
144 '$infotext' => DI::l10n()->t('Set any of these options to 0 to deactivate it.'),
145 '$expiredays' => ["expiredays", "Expire Days", intval(DI::config()->get('public_server', 'expiredays')), "When an account is created on the site, it is given a hard "],
146 '$expireposts' => ["expireposts", "Expire Posts", intval(DI::config()->get('public_server', 'expireposts')), "Set the default days for posts to expire here"],
147 '$nologin' => ["nologin", "No Login", intval(DI::config()->get('public_server', 'nologin')), "Remove users who have never logged in after nologin days "],
148 '$flagusers' => ["flagusers", "Flag users", intval(DI::config()->get('public_server', 'flagusers')), "Remove users who last logged in over flagusers days ago"],
149 '$flagposts' => ["flagposts", "Flag posts", intval(DI::config()->get('public_server', 'flagposts')), "For users who last logged in over flagposts days ago set post expiry days to flagpostsexpire "],
150 '$flagpostsexpire' => ["flagpostsexpire", "Flag posts expire", intval(DI::config()->get('public_server', 'flagpostsexpire'))],