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\Hook;
  12 use Friendica\Core\Logger;
  13 use Friendica\Core\Renderer;
  14 use Friendica\Database\DBA;
  15 use Friendica\DI;
  16 use Friendica\Util\ConfigFileLoader;
  17 use Friendica\Util\DateTimeFormat;
  18 use Friendica\Util\Strings;
  19
  20 function public_server_install()
  21 {
  22         Hook::register('load_config',      'addon/public_server/public_server.php', 'public_server_load_config');
  23         Hook::register('register_account', 'addon/public_server/public_server.php', 'public_server_register_account');
  24         Hook::register('cron', 'addon/public_server/public_server.php', 'public_server_cron');
  25         Hook::register('enotify', 'addon/public_server/public_server.php', 'public_server_enotify');
  26         Hook::register('logged_in', 'addon/public_server/public_server.php', 'public_server_login');
  27 }
  28
  29 function public_server_uninstall()
  30 {
  31         Hook::unregister('load_config',      'addon/public_server/public_server.php', 'public_server_load_config');
  32         Hook::unregister('register_account', 'addon/public_server/public_server.php', 'public_server_register_account');
  33         Hook::unregister('cron', 'addon/public_server/public_server.php', 'public_server_cron');
  34         Hook::unregister('enotify', 'addon/public_server/public_server.php', 'public_server_enotify');
  35         Hook::unregister('logged_in', 'addon/public_server/public_server.php', 'public_server_login');
  36 }
  37
  38 function public_server_load_config(App $a, ConfigFileLoader $loader)
  39 {
  40         $a->getConfigCache()->load($loader->loadAddonConfig('public_server'));
  41 }
  42
  43 function public_server_register_account($a, $b)
  44 {
  45         $uid = $b;
  46
  47         $days = DI::config()->get('public_server', 'expiredays');
  48         $days_posts = DI::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         $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'  => DI::l10n()->t('Administrator'),
  76                                 'source_link'  => DI::baseUrl()->get(),
  77                                 'source_photo' => DI::baseUrl()->get() . '/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 = DI::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 = DI::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 = DI::config()->get('public_server', 'flagposts');
 110         $flagpostsexpire = DI::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 (!empty($b['params']) && $b['params']['type'] == NOTIFY_SYSTEM
 127                 && !empty($b['params']['system_type']) && $b['params']['system_type'] === 'public_server_expire') {
 128                 $b['itemlink'] = DI::baseUrl()->get();
 129                 $b['epreamble'] = $b['preamble'] = DI::l10n()->t('Your account on %s will expire in a few days.', DI::config()->get('system', 'sitename'));
 130                 $b['subject'] = DI::l10n()->t('Your Friendica account is about to expire.');
 131                 $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]");
 132         }
 133 }
 134
 135 function public_server_login($a, $b)
 136 {
 137         $days = DI::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 = (!empty($_POST['expiredays']) ? Strings::escapeTags(trim($_POST['expiredays'])) : '');
 151         $expireposts = (!empty($_POST['expireposts']) ? Strings::escapeTags(trim($_POST['expireposts'])) : '');
 152         $nologin = (!empty($_POST['nologin']) ? Strings::escapeTags(trim($_POST['nologin'])) : '');
 153         $flagusers = (!empty($_POST['flagusers']) ? Strings::escapeTags(trim($_POST['flagusers'])) : '');
 154         $flagposts = (!empty($_POST['flagposts']) ? Strings::escapeTags(trim($_POST['flagposts'])) : '');
 155         $flagpostsexpire = (!empty($_POST['flagpostsexpire']) ? Strings::escapeTags(trim($_POST['flagpostsexpire'])) : '');
 156         DI::config()->set('public_server', 'expiredays', $expiredays);
 157         DI::config()->set('public_server', 'expireposts', $expireposts);
 158         DI::config()->set('public_server', 'nologin', $nologin);
 159         DI::config()->set('public_server', 'flagusers', $flagusers);
 160         DI::config()->set('public_server', 'flagposts', $flagposts);
 161         DI::config()->set('public_server', 'flagpostsexpire', $flagpostsexpire);
 162         info(DI::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' => DI::l10n()->t('Save Settings'),
 171                 '$form_security_token' => $token,
 172                 '$infotext' => DI::l10n()->t('Set any of these options to 0 to deactivate it.'),
 173                 '$expiredays' => ["expiredays","Expire Days", intval(DI::config()->get('public_server', 'expiredays')), "When an account is created on the site, it is given a hard "],
 174                 '$expireposts' => ["expireposts", "Expire Posts", intval(DI::config()->get('public_server', 'expireposts')), "Set the default days for posts to expire here"],
 175                 '$nologin' => ["nologin", "No Login", intval(DI::config()->get('public_server', 'nologin')), "Remove users who have never logged in after nologin days "],
 176                 '$flagusers' => ["flagusers", "Flag users", intval(DI::config()->get('public_server', 'flagusers')), "Remove users who last logged in over flagusers days ago"],
 177                 '$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 "],
 178                 '$flagpostsexpire' => ["flagpostsexpire", "Flag posts expire", intval(DI::config()->get('public_server', 'flagpostsexpire'))],
 179         ]);
 180 }