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