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