4 * Description: Friendica addon with functions suitable for a public server.
6 * Author: Keith Fernie <http://friendika.me4.it/profile/keith>
9 use Friendica\Core\Addon;
10 use Friendica\Core\Config;
11 use Friendica\Core\L10n;
12 use Friendica\Database\DBA;
13 use Friendica\Util\DateTimeFormat;
14 use Friendica\Util\Security;
16 function public_server_install()
18 Addon::registerHook('load_config', 'addon/public_server/public_server.php', 'public_server_load_config');
19 Addon::registerHook('register_account', 'addon/public_server/public_server.php', 'public_server_register_account');
20 Addon::registerHook('cron', 'addon/public_server/public_server.php', 'public_server_cron');
21 Addon::registerHook('enotify', 'addon/public_server/public_server.php', 'public_server_enotify');
22 Addon::registerHook('logged_in', 'addon/public_server/public_server.php', 'public_server_login');
25 function public_server_uninstall()
27 Addon::unregisterHook('load_config', 'addon/public_server/public_server.php', 'public_server_load_config');
28 Addon::unregisterHook('register_account', 'addon/public_server/public_server.php', 'public_server_register_account');
29 Addon::unregisterHook('cron', 'addon/public_server/public_server.php', 'public_server_cron');
30 Addon::unregisterHook('enotify', 'addon/public_server/public_server.php', 'public_server_enotify');
31 Addon::unregisterHook('logged_in', 'addon/public_server/public_server.php', 'public_server_login');
34 function public_server_load_config(\Friendica\App $a)
36 $a->loadConfigFile(__DIR__. '/config/public_server.ini.php');
39 function public_server_register_account($a, $b)
43 $days = Config::get('public_server', 'expiredays');
44 $days_posts = Config::get('public_server', 'expireposts');
49 $fields = ['account_expires_on' => DateTimeFormat::utc('now +' . $days . ' days'), 'expire' => $days_posts];
50 DBA::update('user', $fields, ['uid' => $uid]);
53 function public_server_cron($a, $b)
55 logger("public_server: cron start");
57 require_once('include/enotify.php');
58 $r = q("SELECT * FROM `user` WHERE `account_expires_on` < UTC_TIMESTAMP() + INTERVAL 5 DAY AND
59 `account_expires_on` > '%s' AND
60 `expire_notification_sent` <= '%s'",
61 DBA::escape(NULL_DATE), DBA::escape(NULL_DATE));
63 if (DBA::isResult($r)) {
67 'type' => NOTIFY_SYSTEM,
68 'system_type' => 'public_server_expire',
69 'language' => $rr['language'],
70 'to_name' => $rr['username'],
71 'to_email' => $rr['email'],
72 'source_name' => L10n::t('Administrator'),
73 'source_link' => $a->getBaseURL(),
74 'source_photo' => $a->getBaseURL() . '/images/person-80.jpg',
77 $fields = ['expire_notification_sent' => DateTimeFormat::utcNow()];
78 DBA::update('user', $fields, ['uid' => $rr['uid']]);
82 $nologin = Config::get('public_server', 'nologin', false);
84 $r = q("SELECT `uid` FROM `user` WHERE NOT `account_expired` AND `login_date` <= '%s' AND `register_date` < UTC_TIMESTAMP() - INTERVAL %d DAY AND `account_expires_on` <= '%s'",
85 DBA::escape(NULL_DATE), intval($nologin), DBA::escape(NULL_DATE));
86 if (DBA::isResult($r)) {
88 $fields = ['account_expires_on' => DateTimeFormat::utc('now +6 days')];
89 DBA::update('user', $fields, ['uid' => $rr['uid']]);
94 $flagusers = Config::get('public_server', 'flagusers', false);
96 $r = q("SELECT `uid` FROM `user` WHERE NOT `account_expired` AND `login_date` < UTC_TIMESTAMP() - INTERVAL %d DAY AND `account_expires_on` <= '%s' AND `page-flags` = 0",
97 intval($flagusers), DBA::escape(NULL_DATE));
98 if (DBA::isResult($r)) {
100 $fields = ['account_expires_on' => DateTimeFormat::utc('now +6 days')];
101 DBA::update('user', $fields, ['uid' => $rr['uid']]);
106 $flagposts = Config::get('public_server', 'flagposts');
107 $flagpostsexpire = Config::get('public_server', 'flagpostsexpire');
108 if ($flagposts && $flagpostsexpire) {
109 $r = q("SELECT `uid` FROM `user` WHERE NOT `account_expired` AND `login_date` < UTC_TIMESTAMP() - INTERVAL %d DAY AND `account_expires_on` <= '%s' and `expire` = 0 AND `page-flags` = 0",
110 intval($flagposts), DBA::escape(NULL_DATE));
111 if (DBA::isResult($r)) {
112 foreach ($r as $rr) {
113 DBA::update('user', ['expire' => $flagpostsexpire], ['uid' => $rr['uid']]);
118 logger("public_server: cron end");
121 function public_server_enotify(&$a, &$b)
123 if (x($b, 'params') && $b['params']['type'] == NOTIFY_SYSTEM
124 && x($b['params'], 'system_type') && $b['params']['system_type'] === 'public_server_expire') {
125 $b['itemlink'] = $a->getBaseURL();
126 $b['epreamble'] = $b['preamble'] = L10n::t('Your account on %s will expire in a few days.', Config::get('system', 'sitename'));
127 $b['subject'] = L10n::t('Your Friendica account is about to expire.');
128 $b['body'] = 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=" . Config::get('system', 'url') . "]" . Config::get('config', 'sitename') . "[/url]");
132 function public_server_login($a, $b)
134 $days = Config::get('public_server', 'expiredays');
139 $fields = ['account_expires_on' => DateTimeFormat::utc('now +' . $days . ' days')];
140 $condition = ["`uid` = ? AND `account_expires_on` > ?", local_user(), NULL_DATE];
141 DBA::update('user', $fields, $condition);
144 function public_server_addon_admin_post(&$a)
146 Security::check_form_security_token_redirectOnErr('/admin/addons/publicserver', 'publicserver');
147 $expiredays = (x($_POST, 'expiredays') ? notags(trim($_POST['expiredays'])) : '');
148 $expireposts = (x($_POST, 'expireposts') ? notags(trim($_POST['expireposts'])) : '');
149 $nologin = (x($_POST, 'nologin') ? notags(trim($_POST['nologin'])) : '');
150 $flagusers = (x($_POST, 'flagusers') ? notags(trim($_POST['flagusers'])) : '');
151 $flagposts = (x($_POST, 'flagposts') ? notags(trim($_POST['flagposts'])) : '');
152 $flagpostsexpire = (x($_POST, 'flagpostsexpire') ? notags(trim($_POST['flagpostsexpire'])) : '');
153 Config::set('public_server', 'expiredays', $expiredays);
154 Config::set('public_server', 'expireposts', $expireposts);
155 Config::set('public_server', 'nologin', $nologin);
156 Config::set('public_server', 'flagusers', $flagusers);
157 Config::set('public_server', 'flagposts', $flagposts);
158 Config::set('public_server', 'flagpostsexpire', $flagpostsexpire);
159 info(L10n::t('Settings saved').EOL);
162 function public_server_addon_admin(&$a, &$o)
164 $token = Security::get_form_security_token("publicserver");
165 $t = get_markup_template("admin.tpl", "addon/public_server");
166 $o = replace_macros($t, [
167 '$submit' => L10n::t('Save Settings'),
168 '$form_security_token' => $token,
169 '$infotext' => L10n::t('Set any of these options to 0 to deactivate it.'),
170 '$expiredays' => ["expiredays","Expire Days", intval(Config::get('public_server', 'expiredays')), "When an account is created on the site, it is given a hard "],
171 '$expireposts' => ["expireposts", "Expire Posts", intval(Config::get('public_server', 'expireposts')), "Set the default days for posts to expire here"],
172 '$nologin' => ["nologin", "No Login", intval(Config::get('public_server', 'nologin')), "Remove users who have never logged in after nologin days "],
173 '$flagusers' => ["flagusers", "Flag users", intval(Config::get('public_server', 'flagusers')), "Remove users who last logged in over flagusers days ago"],
174 '$flagposts' => ["flagposts", "Flag posts", intval(Config::get('public_server', 'flagposts')), "For users who last logged in over flagposts days ago set post expiry days to flagpostsexpire "],
175 '$flagpostsexpire' => ["flagpostsexpire", "Flag posts expire", intval(Config::get('public_server', 'flagpostsexpire'))],