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