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\ConfigFileLoader;
19 use Friendica\Util\DateTimeFormat;
20 use Friendica\Util\Strings;
22 function public_server_install()
24 Hook::register('load_config', 'addon/public_server/public_server.php', 'public_server_load_config');
25 Hook::register('register_account', 'addon/public_server/public_server.php', 'public_server_register_account');
26 Hook::register('cron', 'addon/public_server/public_server.php', 'public_server_cron');
27 Hook::register('enotify', 'addon/public_server/public_server.php', 'public_server_enotify');
28 Hook::register('logged_in', 'addon/public_server/public_server.php', 'public_server_login');
31 function public_server_load_config(App $a, ConfigFileLoader $loader)
33 $a->getConfigCache()->load($loader->loadAddonConfig('public_server'));
36 function public_server_register_account($a, $b)
40 $days = DI::config()->get('public_server', 'expiredays');
41 $days_posts = DI::config()->get('public_server', 'expireposts');
46 $fields = ['account_expires_on' => DateTimeFormat::utc('now +' . $days . ' days'), 'expire' => $days_posts];
47 DBA::update('user', $fields, ['uid' => $uid]);
50 function public_server_cron($a, $b)
52 Logger::notice("public_server: cron start");
54 $users = DBA::selectToArray('user', [], ["`account_expires_on` < UTC_TIMESTAMP() + INTERVAL ? DAY AND
55 `account_expires_on` > ? AND `expire_notification_sent` <= ?", 5, DBA::NULL_DATETIME, DBA::NULL_DATETIME]);
56 foreach ($users as $rr) {
57 DI::notify()->createFromArray([
58 'type' => Notification\Type::SYSTEM,
60 'system_type' => 'public_server_expire',
61 'source_name' => DI::l10n()->t('Administrator'),
62 'source_link' => DI::baseUrl()->get(),
63 'source_photo' => DI::baseUrl()->get() . '/images/person-80.jpg',
66 $fields = ['expire_notification_sent' => DateTimeFormat::utcNow()];
67 DBA::update('user', $fields, ['uid' => $rr['uid']]);
70 $nologin = DI::config()->get('public_server', 'nologin', false);
72 $users = DBA::selectToArray('user', [], ["NOT `account_expired` AND `login_date` <= ? AND `register_date` < UTC_TIMESTAMP() - INTERVAL ? DAY AND `account_expires_on` <= ?",
73 DBA::NULL_DATETIME, $nologin, DBA::NULL_DATETIME]);
74 foreach ($users as $rr) {
75 $fields = ['account_expires_on' => DateTimeFormat::utc('now +6 days')];
76 DBA::update('user', $fields, ['uid' => $rr['uid']]);
80 $flagusers = DI::config()->get('public_server', 'flagusers', false);
82 $users = DBA::selectToArray('user', [], ["NOT `account_expired` AND `login_date` < UTC_TIMESTAMP() - INTERVAL ? DAY AND `account_expires_on` <= ? AND `page-flags` = ?",
83 $flagusers, DBA::NULL_DATETIME, User::PAGE_FLAGS_NORMAL]);
84 foreach ($users as $rr) {
85 $fields = ['account_expires_on' => DateTimeFormat::utc('now +6 days')];
86 DBA::update('user', $fields, ['uid' => $rr['uid']]);
90 $flagposts = DI::config()->get('public_server', 'flagposts');
91 $flagpostsexpire = DI::config()->get('public_server', 'flagpostsexpire');
92 if ($flagposts && $flagpostsexpire) {
93 $users = DBA::selectToArray('user', [], ["NOT `account_expired` AND `login_date` < UTC_TIMESTAMP() - INTERVAL ? DAY AND `account_expires_on` <= ? AND NOT `expire` AND `page-flags` = ?",
94 $flagposts, DBA::NULL_DATETIME, User::PAGE_FLAGS_NORMAL]);
95 foreach ($users as $rr) {
96 DBA::update('user', ['expire' => $flagpostsexpire], ['uid' => $rr['uid']]);
100 Logger::notice("public_server: cron end");
103 function public_server_enotify(&$a, &$b)
105 if (!empty($b['params']) && $b['params']['type'] == Notification\Type::SYSTEM
106 && !empty($b['params']['system_type']) && $b['params']['system_type'] === 'public_server_expire') {
107 $b['itemlink'] = DI::baseUrl()->get();
108 $b['epreamble'] = $b['preamble'] = DI::l10n()->t('Your account on %s will expire in a few days.', DI::config()->get('system', 'sitename'));
109 $b['subject'] = DI::l10n()->t('Your Friendica account is about to expire.');
110 $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]");
114 function public_server_login($a, $b)
116 $days = DI::config()->get('public_server', 'expiredays');
121 $fields = ['account_expires_on' => DateTimeFormat::utc('now +' . $days . ' days')];
122 $condition = ["`uid` = ? AND `account_expires_on` > ?", local_user(), DBA::NULL_DATETIME];
123 DBA::update('user', $fields, $condition);
126 function public_server_addon_admin_post(&$a)
128 BaseModule::checkFormSecurityTokenRedirectOnError('/admin/addons/publicserver', 'publicserver');
129 $expiredays = (!empty($_POST['expiredays']) ? Strings::escapeTags(trim($_POST['expiredays'])) : '');
130 $expireposts = (!empty($_POST['expireposts']) ? Strings::escapeTags(trim($_POST['expireposts'])) : '');
131 $nologin = (!empty($_POST['nologin']) ? Strings::escapeTags(trim($_POST['nologin'])) : '');
132 $flagusers = (!empty($_POST['flagusers']) ? Strings::escapeTags(trim($_POST['flagusers'])) : '');
133 $flagposts = (!empty($_POST['flagposts']) ? Strings::escapeTags(trim($_POST['flagposts'])) : '');
134 $flagpostsexpire = (!empty($_POST['flagpostsexpire']) ? Strings::escapeTags(trim($_POST['flagpostsexpire'])) : '');
135 DI::config()->set('public_server', 'expiredays', $expiredays);
136 DI::config()->set('public_server', 'expireposts', $expireposts);
137 DI::config()->set('public_server', 'nologin', $nologin);
138 DI::config()->set('public_server', 'flagusers', $flagusers);
139 DI::config()->set('public_server', 'flagposts', $flagposts);
140 DI::config()->set('public_server', 'flagpostsexpire', $flagpostsexpire);
143 function public_server_addon_admin(&$a, &$o)
145 $token = BaseModule::getFormSecurityToken("publicserver");
146 $t = Renderer::getMarkupTemplate("admin.tpl", "addon/public_server");
147 $o = Renderer::replaceMacros($t, [
148 '$submit' => DI::l10n()->t('Save Settings'),
149 '$form_security_token' => $token,
150 '$infotext' => DI::l10n()->t('Set any of these options to 0 to deactivate it.'),
151 '$expiredays' => ["expiredays","Expire Days", intval(DI::config()->get('public_server', 'expiredays')), "When an account is created on the site, it is given a hard "],
152 '$expireposts' => ["expireposts", "Expire Posts", intval(DI::config()->get('public_server', 'expireposts')), "Set the default days for posts to expire here"],
153 '$nologin' => ["nologin", "No Login", intval(DI::config()->get('public_server', 'nologin')), "Remove users who have never logged in after nologin days "],
154 '$flagusers' => ["flagusers", "Flag users", intval(DI::config()->get('public_server', 'flagusers')), "Remove users who last logged in over flagusers days ago"],
155 '$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 "],
156 '$flagpostsexpire' => ["flagpostsexpire", "Flag posts expire", intval(DI::config()->get('public_server', 'flagpostsexpire'))],