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