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\DBM;
13 use Friendica\Util\DateTimeFormat;
15 function public_server_install()
17 Addon::registerHook('register_account', 'addon/public_server/public_server.php', 'public_server_register_account');
18 Addon::registerHook('cron', 'addon/public_server/public_server.php', 'public_server_cron');
19 Addon::registerHook('enotify', 'addon/public_server/public_server.php', 'public_server_enotify');
20 Addon::registerHook('logged_in', 'addon/public_server/public_server.php', 'public_server_login');
23 function public_server_uninstall()
25 Addon::unregisterHook('register_account', 'addon/public_server/public_server.php', 'public_server_register_account');
26 Addon::unregisterHook('cron', 'addon/public_server/public_server.php', 'public_server_cron');
27 Addon::unregisterHook('enotify', 'addon/public_server/public_server.php', 'public_server_enotify');
28 Addon::unregisterHook('logged_in', 'addon/public_server/public_server.php', 'public_server_login');
31 function public_server_register_account($a, $b)
35 $days = Config::get('public_server', 'expiredays');
36 $days_posts = Config::get('public_server', 'expireposts');
41 $fields = ['account_expires_on' => DateTimeFormat::utc('now +' . $days . ' days'), 'expire' => $days_posts];
42 dba::update('user', $fields, ['uid' => $uid]);
45 function public_server_cron($a, $b)
47 logger("public_server: cron start");
49 require_once('include/enotify.php');
50 $r = q("SELECT * FROM `user` WHERE `account_expires_on` < UTC_TIMESTAMP() + INTERVAL 5 DAY AND
51 `account_expires_on` > '%s' AND
52 `expire_notification_sent` <= '%s'",
53 dbesc(NULL_DATE), dbesc(NULL_DATE));
55 if (DBM::is_result($r)) {
59 'type' => NOTIFY_SYSTEM,
60 'system_type' => 'public_server_expire',
61 'language' => $rr['language'],
62 'to_name' => $rr['username'],
63 'to_email' => $rr['email'],
64 'source_name' => L10n::t('Administrator'),
65 'source_link' => $a->get_baseurl(),
66 'source_photo' => $a->get_baseurl() . '/images/person-80.jpg',
69 $fields = ['expire_notification_sent' => DateTimeFormat::utcNow()];
70 dba::update('user', $fields, ['uid' => $rr['uid']]);
74 $nologin = Config::get('public_server', 'nologin', false);
76 $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'",
77 dbesc(NULL_DATE), intval($nologin), dbesc(NULL_DATE));
78 if (DBM::is_result($r)) {
80 $fields = ['account_expires_on' => DateTimeFormat::utc('now +6 days')];
81 dba::update('user', $fields, ['uid' => $rr['uid']]);
86 $flagusers = Config::get('public_server', 'flagusers', false);
88 $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",
89 intval($flagusers), dbesc(NULL_DATE));
90 if (DBM::is_result($r)) {
92 $fields = ['account_expires_on' => DateTimeFormat::utc('now +6 days')];
93 dba::update('user', $fields, ['uid' => $rr['uid']]);
98 $flagposts = Config::get('public_server', 'flagposts');
99 $flagpostsexpire = Config::get('public_server', 'flagpostsexpire');
100 if ($flagposts && $flagpostsexpire) {
101 $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",
102 intval($flagposts), dbesc(NULL_DATE));
103 if (DBM::is_result($r)) {
104 foreach ($r as $rr) {
105 dba::update('user', ['expire' => $flagpostsexpire], ['uid' => $rr['uid']]);
110 logger("public_server: cron end");
113 function public_server_enotify(&$a, &$b)
115 if (x($b, 'params') && $b['params']['type'] == NOTIFY_SYSTEM
116 && x($b['params'], 'system_type') && $b['params']['system_type'] === 'public_server_expire') {
117 $b['itemlink'] = $a->get_baseurl();
118 $b['epreamble'] = $b['preamble'] = L10n::t('Your account on %s will expire in a few days.', Config::get('system', 'sitename'));
119 $b['subject'] = L10n::t('Your Friendica account is about to expire.');
120 $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=" . $app->config["system"]["url"] . "]" . $app->config["sitename"] . "[/url]");
124 function public_server_login($a, $b)
126 $days = Config::get('public_server', 'expiredays');
131 $fields = ['account_expires_on' => DateTimeFormat::utc('now +' . $days . ' days')];
132 $condition = ["`uid` = ? AND `account_expires_on` > ?", local_user(), NULL_DATE];
133 dba::update('user', $fields, $condition);
136 function public_server_addon_admin_post(&$a)
138 check_form_security_token_redirectOnErr('/admin/addons/publicserver', 'publicserver');
139 $expiredays = (x($_POST, 'expiredays') ? notags(trim($_POST['expiredays'])) : '');
140 $expireposts = (x($_POST, 'expireposts') ? notags(trim($_POST['expireposts'])) : '');
141 $nologin = (x($_POST, 'nologin') ? notags(trim($_POST['nologin'])) : '');
142 $flagusers = (x($_POST, 'flagusers') ? notags(trim($_POST['flagusers'])) : '');
143 $flagposts = (x($_POST, 'flagposts') ? notags(trim($_POST['flagposts'])) : '');
144 $flagpostsexpire = (x($_POST, 'flagpostsexpire') ? notags(trim($_POST['flagpostsexpire'])) : '');
145 Config::set('public_server', 'expiredays', $expiredays);
146 Config::set('public_server', 'expireposts', $expireposts);
147 Config::set('public_server', 'nologin', $nologin);
148 Config::set('public_server', 'flagusers', $flagusers);
149 Config::set('public_server', 'flagposts', $flagposts);
150 Config::set('public_server', 'flagpostsexpire', $flagpostsexpire);
151 info(L10n::t('Settings saved').EOL);
154 function public_server_addon_admin(&$a, &$o)
156 $token = get_form_security_token("publicserver");
157 $t = get_markup_template("admin.tpl", "addon/public_server");
158 $o = replace_macros($t, [
159 '$submit' => L10n::t('Save Settings'),
160 '$form_security_token' => $token,
161 '$infotext' => L10n::t('Set any of these options to 0 to deactivate it.'),
162 '$expiredays' => ["expiredays","Expire Days", intval(Config::get('public_server', 'expiredays')), "When an account is created on the site, it is given a hard "],
163 '$expireposts' => ["expireposts", "Expire Posts", intval(Config::get('public_server', 'expireposts')), "Set the default days for posts to expire here"],
164 '$nologin' => ["nologin", "No Login", intval(Config::get('public_server', 'nologin')), "Remove users who have never logged in after nologin days "],
165 '$flagusers' => ["flagusers", "Flag users", intval(Config::get('public_server', 'flagusers')), "Remove users who last logged in over flagusers days ago"],
166 '$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 "],
167 '$flagpostsexpire' => ["flagpostsexpire", "Flag posts expire", intval(Config::get('public_server', 'flagpostsexpire'))],