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