4 * Description: Friendica addon with functions suitable for a public server.
6 * Author: Keith Fernie <http://friendika.me4.it/profile/keith>
10 use Friendica\BaseModule;
11 use Friendica\Core\Addon;
12 use Friendica\Core\Config;
13 use Friendica\Core\Hook;
14 use Friendica\Core\L10n;
15 use Friendica\Core\Logger;
16 use Friendica\Core\Renderer;
17 use Friendica\Database\DBA;
18 use Friendica\Util\DateTimeFormat;
19 use Friendica\Util\Strings;
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_uninstall()
32 Hook::unregister('load_config', 'addon/public_server/public_server.php', 'public_server_load_config');
33 Hook::unregister('register_account', 'addon/public_server/public_server.php', 'public_server_register_account');
34 Hook::unregister('cron', 'addon/public_server/public_server.php', 'public_server_cron');
35 Hook::unregister('enotify', 'addon/public_server/public_server.php', 'public_server_enotify');
36 Hook::unregister('logged_in', 'addon/public_server/public_server.php', 'public_server_login');
39 function public_server_load_config(App $a)
41 $a->loadConfigFile(__DIR__ . '/config/public_server.config.php');
44 function public_server_register_account($a, $b)
48 $days = Config::get('public_server', 'expiredays');
49 $days_posts = Config::get('public_server', 'expireposts');
54 $fields = ['account_expires_on' => DateTimeFormat::utc('now +' . $days . ' days'), 'expire' => $days_posts];
55 DBA::update('user', $fields, ['uid' => $uid]);
58 function public_server_cron($a, $b)
60 Logger::log("public_server: cron start");
62 require_once('include/enotify.php');
63 $r = q("SELECT * FROM `user` WHERE `account_expires_on` < UTC_TIMESTAMP() + INTERVAL 5 DAY AND
64 `account_expires_on` > '%s' AND
65 `expire_notification_sent` <= '%s'",
66 DBA::NULL_DATETIME, DBA::NULL_DATETIME);
68 if (DBA::isResult($r)) {
72 'type' => NOTIFY_SYSTEM,
73 'system_type' => 'public_server_expire',
74 'language' => $rr['language'],
75 'to_name' => $rr['username'],
76 'to_email' => $rr['email'],
77 'source_name' => L10n::t('Administrator'),
78 'source_link' => $a->getBaseURL(),
79 'source_photo' => $a->getBaseURL() . '/images/person-80.jpg',
82 $fields = ['expire_notification_sent' => DateTimeFormat::utcNow()];
83 DBA::update('user', $fields, ['uid' => $rr['uid']]);
87 $nologin = Config::get('public_server', 'nologin', false);
89 $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'",
90 DBA::NULL_DATETIME, intval($nologin), DBA::NULL_DATETIME);
91 if (DBA::isResult($r)) {
93 $fields = ['account_expires_on' => DateTimeFormat::utc('now +6 days')];
94 DBA::update('user', $fields, ['uid' => $rr['uid']]);
99 $flagusers = Config::get('public_server', 'flagusers', false);
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 `page-flags` = 0",
102 intval($flagusers), DBA::NULL_DATETIME);
103 if (DBA::isResult($r)) {
104 foreach ($r as $rr) {
105 $fields = ['account_expires_on' => DateTimeFormat::utc('now +6 days')];
106 DBA::update('user', $fields, ['uid' => $rr['uid']]);
111 $flagposts = Config::get('public_server', 'flagposts');
112 $flagpostsexpire = Config::get('public_server', 'flagpostsexpire');
113 if ($flagposts && $flagpostsexpire) {
114 $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",
115 intval($flagposts), DBA::NULL_DATETIME);
116 if (DBA::isResult($r)) {
117 foreach ($r as $rr) {
118 DBA::update('user', ['expire' => $flagpostsexpire], ['uid' => $rr['uid']]);
123 Logger::log("public_server: cron end");
126 function public_server_enotify(&$a, &$b)
128 if (!empty($b['params']) && $b['params']['type'] == NOTIFY_SYSTEM
129 && !empty($b['params']['system_type']) && $b['params']['system_type'] === 'public_server_expire') {
130 $b['itemlink'] = $a->getBaseURL();
131 $b['epreamble'] = $b['preamble'] = L10n::t('Your account on %s will expire in a few days.', Config::get('system', 'sitename'));
132 $b['subject'] = L10n::t('Your Friendica account is about to expire.');
133 $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]");
137 function public_server_login($a, $b)
139 $days = Config::get('public_server', 'expiredays');
144 $fields = ['account_expires_on' => DateTimeFormat::utc('now +' . $days . ' days')];
145 $condition = ["`uid` = ? AND `account_expires_on` > ?", local_user(), DBA::NULL_DATETIME];
146 DBA::update('user', $fields, $condition);
149 function public_server_addon_admin_post(&$a)
151 BaseModule::checkFormSecurityTokenRedirectOnError('/admin/addons/publicserver', 'publicserver');
152 $expiredays = (!empty($_POST['expiredays']) ? Strings::escapeTags(trim($_POST['expiredays'])) : '');
153 $expireposts = (!empty($_POST['expireposts']) ? Strings::escapeTags(trim($_POST['expireposts'])) : '');
154 $nologin = (!empty($_POST['nologin']) ? Strings::escapeTags(trim($_POST['nologin'])) : '');
155 $flagusers = (!empty($_POST['flagusers']) ? Strings::escapeTags(trim($_POST['flagusers'])) : '');
156 $flagposts = (!empty($_POST['flagposts']) ? Strings::escapeTags(trim($_POST['flagposts'])) : '');
157 $flagpostsexpire = (!empty($_POST['flagpostsexpire']) ? Strings::escapeTags(trim($_POST['flagpostsexpire'])) : '');
158 Config::set('public_server', 'expiredays', $expiredays);
159 Config::set('public_server', 'expireposts', $expireposts);
160 Config::set('public_server', 'nologin', $nologin);
161 Config::set('public_server', 'flagusers', $flagusers);
162 Config::set('public_server', 'flagposts', $flagposts);
163 Config::set('public_server', 'flagpostsexpire', $flagpostsexpire);
164 info(L10n::t('Settings saved').EOL);
167 function public_server_addon_admin(&$a, &$o)
169 $token = BaseModule::getFormSecurityToken("publicserver");
170 $t = Renderer::getMarkupTemplate("admin.tpl", "addon/public_server");
171 $o = Renderer::replaceMacros($t, [
172 '$submit' => L10n::t('Save Settings'),
173 '$form_security_token' => $token,
174 '$infotext' => L10n::t('Set any of these options to 0 to deactivate it.'),
175 '$expiredays' => ["expiredays","Expire Days", intval(Config::get('public_server', 'expiredays')), "When an account is created on the site, it is given a hard "],
176 '$expireposts' => ["expireposts", "Expire Posts", intval(Config::get('public_server', 'expireposts')), "Set the default days for posts to expire here"],
177 '$nologin' => ["nologin", "No Login", intval(Config::get('public_server', 'nologin')), "Remove users who have never logged in after nologin days "],
178 '$flagusers' => ["flagusers", "Flag users", intval(Config::get('public_server', 'flagusers')), "Remove users who last logged in over flagusers days ago"],
179 '$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 "],
180 '$flagpostsexpire' => ["flagpostsexpire", "Flag posts expire", intval(Config::get('public_server', 'flagpostsexpire'))],