public_server/public_server.php

   1 <?php
   2 /**
   3  * Name: public_server
   4  * Description: Friendica addon with functions suitable for a public server.
   5  * Version: 1.1
   6  * Author: Keith Fernie <http://friendika.me4.it/profile/keith>
   7  */
   8
   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
  15 function public_server_install()
  16 {
  17         Addon::registerHook('load_config',      'addon/public_server/public_server.php', 'public_server_load_config');
  18         Addon::registerHook('register_account', 'addon/public_server/public_server.php', 'public_server_register_account');
  19         Addon::registerHook('cron', 'addon/public_server/public_server.php', 'public_server_cron');
  20         Addon::registerHook('enotify', 'addon/public_server/public_server.php', 'public_server_enotify');
  21         Addon::registerHook('logged_in', 'addon/public_server/public_server.php', 'public_server_login');
  22 }
  23
  24 function public_server_uninstall()
  25 {
  26         Addon::unregisterHook('load_config',      'addon/public_server/public_server.php', 'public_server_load_config');
  27         Addon::unregisterHook('register_account', 'addon/public_server/public_server.php', 'public_server_register_account');
  28         Addon::unregisterHook('cron', 'addon/public_server/public_server.php', 'public_server_cron');
  29         Addon::unregisterHook('enotify', 'addon/public_server/public_server.php', 'public_server_enotify');
  30         Addon::unregisterHook('logged_in', 'addon/public_server/public_server.php', 'public_server_login');
  31 }
  32
  33 function public_server_load_config(\Friendica\App $a)
  34 {
  35         $a->loadConfigFile(__DIR__. '/config/public_server.ini.php');
  36 }
  37
  38 function public_server_register_account($a, $b)
  39 {
  40         $uid = $b;
  41
  42         $days = Config::get('public_server', 'expiredays');
  43         $days_posts = Config::get('public_server', 'expireposts');
  44         if (!$days) {
  45                 return;
  46         }
  47
  48         $fields = ['account_expires_on' => DateTimeFormat::utc('now +' . $days . ' days'), 'expire' => $days_posts];
  49         DBA::update('user', $fields, ['uid' => $uid]);
  50 }
  51
  52 function public_server_cron($a, $b)
  53 {
  54         logger("public_server: cron start");
  55
  56         require_once('include/enotify.php');
  57         $r = q("SELECT * FROM `user` WHERE `account_expires_on` < UTC_TIMESTAMP() + INTERVAL 5 DAY AND
  58                 `account_expires_on` > '%s' AND
  59                 `expire_notification_sent` <= '%s'",
  60                 DBA::escape(NULL_DATE), DBA::escape(NULL_DATE));
  61
  62         if (DBA::isResult($r)) {
  63                 foreach ($r as $rr) {
  64                         notification([
  65                                 'uid' => $rr['uid'],
  66                                 'type' => NOTIFY_SYSTEM,
  67                                 'system_type' => 'public_server_expire',
  68                                 'language'     => $rr['language'],
  69                                 'to_name'      => $rr['username'],
  70                                 'to_email'     => $rr['email'],
  71                                 'source_name'  => L10n::t('Administrator'),
  72                                 'source_link'  => $a->get_baseurl(),
  73                                 'source_photo' => $a->get_baseurl() . '/images/person-80.jpg',
  74                         ]);
  75
  76                         $fields = ['expire_notification_sent' => DateTimeFormat::utcNow()];
  77                         DBA::update('user', $fields, ['uid' => $rr['uid']]);
  78                 }
  79         }
  80
  81         $nologin = Config::get('public_server', 'nologin', false);
  82         if ($nologin) {
  83                 $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'",
  84                         DBA::escape(NULL_DATE), intval($nologin), DBA::escape(NULL_DATE));
  85                 if (DBA::isResult($r)) {
  86                         foreach ($r as $rr) {
  87                                 $fields = ['account_expires_on' => DateTimeFormat::utc('now +6 days')];
  88                                 DBA::update('user', $fields, ['uid' => $rr['uid']]);
  89                         }
  90                 }
  91         }
  92
  93         $flagusers = Config::get('public_server', 'flagusers', false);
  94         if ($flagusers) {
  95                 $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",
  96                         intval($flagusers), DBA::escape(NULL_DATE));
  97                 if (DBA::isResult($r)) {
  98                         foreach ($r as $rr) {
  99                                 $fields = ['account_expires_on' => DateTimeFormat::utc('now +6 days')];
 100                                 DBA::update('user', $fields, ['uid' => $rr['uid']]);
 101                         }
 102                 }
 103         }
 104
 105         $flagposts = Config::get('public_server', 'flagposts');
 106         $flagpostsexpire = Config::get('public_server', 'flagpostsexpire');
 107         if ($flagposts && $flagpostsexpire) {
 108                 $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",
 109                         intval($flagposts), DBA::escape(NULL_DATE));
 110                 if (DBA::isResult($r)) {
 111                         foreach ($r as $rr) {
 112                                 DBA::update('user', ['expire' => $flagpostsexpire], ['uid' => $rr['uid']]);
 113                         }
 114                 }
 115         }
 116
 117         logger("public_server: cron end");
 118 }
 119
 120 function public_server_enotify(&$a, &$b)
 121 {
 122         if (x($b, 'params') && $b['params']['type'] == NOTIFY_SYSTEM
 123                 && x($b['params'], 'system_type') && $b['params']['system_type'] === 'public_server_expire') {
 124                 $b['itemlink'] = $a->get_baseurl();
 125                 $b['epreamble'] = $b['preamble'] = L10n::t('Your account on %s will expire in a few days.', Config::get('system', 'sitename'));
 126                 $b['subject'] = L10n::t('Your Friendica account is about to expire.');
 127                 $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]");
 128         }
 129 }
 130
 131 function public_server_login($a, $b)
 132 {
 133         $days = Config::get('public_server', 'expiredays');
 134         if (!$days) {
 135                 return;
 136         }
 137
 138         $fields = ['account_expires_on' => DateTimeFormat::utc('now +' . $days . ' days')];
 139         $condition = ["`uid` = ? AND `account_expires_on` > ?", local_user(), NULL_DATE];
 140         DBA::update('user', $fields, $condition);
 141 }
 142
 143 function public_server_addon_admin_post(&$a)
 144 {
 145         check_form_security_token_redirectOnErr('/admin/addons/publicserver', 'publicserver');
 146         $expiredays = (x($_POST, 'expiredays') ? notags(trim($_POST['expiredays'])) : '');
 147         $expireposts = (x($_POST, 'expireposts') ? notags(trim($_POST['expireposts'])) : '');
 148         $nologin = (x($_POST, 'nologin') ? notags(trim($_POST['nologin'])) : '');
 149         $flagusers = (x($_POST, 'flagusers') ? notags(trim($_POST['flagusers'])) : '');
 150         $flagposts = (x($_POST, 'flagposts') ? notags(trim($_POST['flagposts'])) : '');
 151         $flagpostsexpire = (x($_POST, 'flagpostsexpire') ? notags(trim($_POST['flagpostsexpire'])) : '');
 152         Config::set('public_server', 'expiredays', $expiredays);
 153         Config::set('public_server', 'expireposts', $expireposts);
 154         Config::set('public_server', 'nologin', $nologin);
 155         Config::set('public_server', 'flagusers', $flagusers);
 156         Config::set('public_server', 'flagposts', $flagposts);
 157         Config::set('public_server', 'flagpostsexpire', $flagpostsexpire);
 158         info(L10n::t('Settings saved').EOL);
 159 }
 160
 161 function public_server_addon_admin(&$a, &$o)
 162 {
 163         $token = get_form_security_token("publicserver");
 164         $t = get_markup_template("admin.tpl", "addon/public_server");
 165         $o = replace_macros($t, [
 166                 '$submit' => L10n::t('Save Settings'),
 167                 '$form_security_token' => $token,
 168                 '$infotext' => L10n::t('Set any of these options to 0 to deactivate it.'),
 169                 '$expiredays' => ["expiredays","Expire Days", intval(Config::get('public_server', 'expiredays')), "When an account is created on the site, it is given a hard "],
 170                 '$expireposts' => ["expireposts", "Expire Posts", intval(Config::get('public_server', 'expireposts')), "Set the default days for posts to expire here"],
 171                 '$nologin' => ["nologin", "No Login", intval(Config::get('public_server', 'nologin')), "Remove users who have never logged in after nologin days "],
 172                 '$flagusers' => ["flagusers", "Flag users", intval(Config::get('public_server', 'flagusers')), "Remove users who last logged in over flagusers days ago"],
 173                 '$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 "],
 174                 '$flagpostsexpire' => ["flagpostsexpire", "Flag posts expire", intval(Config::get('public_server', 'flagpostsexpire'))],
 175         ]);
 176 }