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