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