testdrive/testdrive.php

   1 <?php
   2 /**
   3  * Name: testdrive
   4  * Description: Sample Friendica addon for creating a test drive Friendica site with automatic account expiration.
   5  * Version: 1.0
   6  * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
   7  */
   8
   9 use Friendica\App;
  10 use Friendica\Core\Addon;
  11 use Friendica\Core\Config;
  12 use Friendica\Core\L10n;
  13 use Friendica\Database\DBA;
  14 use Friendica\Model\User;
  15 use Friendica\Util\DateTimeFormat;
  16
  17 function testdrive_install() {
  18
  19         Addon::registerHook('load_config',      'addon/testdrive/testdrive.php', 'testdrive_load_config');
  20         Addon::registerHook('register_account', 'addon/testdrive/testdrive.php', 'testdrive_register_account');
  21         Addon::registerHook('cron', 'addon/testdrive/testdrive.php', 'testdrive_cron');
  22         Addon::registerHook('enotify','addon/testdrive/testdrive.php', 'testdrive_enotify');
  23         Addon::registerHook('globaldir_update','addon/testdrive/testdrive.php', 'testdrive_globaldir_update');
  24
  25 }
  26
  27
  28 function testdrive_uninstall() {
  29
  30         Addon::unregisterHook('load_config',      'addon/testdrive/testdrive.php', 'testdrive_load_config');
  31         Addon::unregisterHook('register_account', 'addon/testdrive/testdrive.php', 'testdrive_register_account');
  32         Addon::unregisterHook('cron', 'addon/testdrive/testdrive.php', 'testdrive_cron');
  33         Addon::unregisterHook('enotify','addon/testdrive/testdrive.php', 'testdrive_enotify');
  34         Addon::unregisterHook('globaldir_update','addon/testdrive/testdrive.php', 'testdrive_globaldir_update');
  35
  36 }
  37
  38 function testdrive_load_config(App $a)
  39 {
  40         $a->loadConfigFile(__DIR__ . '/config/testdrive.config.php');
  41 }
  42
  43 function testdrive_globaldir_update($a,&$b) {
  44         $b['url'] = '';
  45 }
  46
  47 function testdrive_register_account($a,$b) {
  48
  49         $uid = $b;
  50
  51         $days = Config::get('testdrive','expiredays');
  52         if(! $days)
  53                 return;
  54
  55         $r = q("UPDATE user set account_expires_on = '%s' where uid = %d",
  56                 DBA::escape(DateTimeFormat::convert('now +' . $days . ' days')),
  57                 intval($uid)
  58         );
  59
  60 };
  61
  62
  63 function testdrive_cron($a,$b) {
  64         require_once('include/enotify.php');
  65
  66         $r = q("select * from user where account_expires_on < UTC_TIMESTAMP() + INTERVAL 5 DAY and
  67                 expire_notification_sent = '0000-00-00 00:00:00' ");
  68
  69         if(count($r)) {
  70                 foreach($r as $rr) {
  71                         notification([
  72                                 'uid' => $rr['uid'],
  73                                 'type' => NOTIFY_SYSTEM,
  74                                 'system_type' => 'testdrive_expire',
  75                                 'language'     => $rr['language'],
  76                                 'to_name'      => $rr['username'],
  77                                 'to_email'     => $rr['email'],
  78                                 'source_name'  => L10n::t('Administrator'),
  79                                 'source_link'  => $a->getBaseURL(),
  80                                 'source_photo' => $a->getBaseURL() . '/images/person-80.jpg',
  81                         ]);
  82
  83                         q("update user set expire_notification_sent = '%s' where uid = %d",
  84                                 DBA::escape(DateTimeFormat::utcNow()),
  85                                 intval($rr['uid'])
  86                         );
  87
  88                 }
  89         }
  90
  91         $r = q("select * from user where account_expired = 1 and account_expires_on < UTC_TIMESTAMP() - INTERVAL 5 DAY ");
  92         if(count($r)) {
  93                 foreach($r as $rr) {
  94                         User::remove($rr['uid']);
  95                 }
  96         }
  97 }
  98
  99 function testdrive_enotify(&$a, &$b) {
 100     if (!empty($b['params']) && $b['params']['type'] == NOTIFY_SYSTEM
 101                 && !empty($b['params']['system_type']) && $b['params']['system_type'] === 'testdrive_expire') {
 102         $b['itemlink'] = $a->getBaseURL();
 103         $b['epreamble'] = $b['preamble'] = L10n::t('Your account on %s will expire in a few days.', Config::get('system', 'sitename'));
 104         $b['subject'] = L10n::t('Your Friendica test account is about to expire.');
 105         $b['body'] = L10n::t("Hi %1\$s,\n\nYour test account on %2\$s will expire in less than five days. We hope you enjoyed this test drive and use this opportunity to find a permanent Friendica website for your integrated social communications. A list of public sites is available at %s/siteinfo - and for more information on setting up your own Friendica server please see the Friendica project website at https://friendi.ca.", $b['params']['to_name'], "[url=".Config::get('system', 'url')."]".Config::get('config', 'sitename')."[/url]", get_server());
 106     }
 107 }