public_server/public_server.php

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