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\Config;
  11 use Friendica\Core\Hook;
  12 use Friendica\Core\L10n;
  13 use Friendica\Database\DBA;
  14 use Friendica\Model\User;
  15 use Friendica\Util\ConfigFileLoader;
  16 use Friendica\Util\DateTimeFormat;
  17
  18 function testdrive_install() {
  19
  20         Hook::register('load_config',      'addon/testdrive/testdrive.php', 'testdrive_load_config');
  21         Hook::register('register_account', 'addon/testdrive/testdrive.php', 'testdrive_register_account');
  22         Hook::register('cron', 'addon/testdrive/testdrive.php', 'testdrive_cron');
  23         Hook::register('enotify','addon/testdrive/testdrive.php', 'testdrive_enotify');
  24         Hook::register('globaldir_update','addon/testdrive/testdrive.php', 'testdrive_globaldir_update');
  25
  26 }
  27
  28
  29 function testdrive_uninstall() {
  30
  31         Hook::unregister('load_config',      'addon/testdrive/testdrive.php', 'testdrive_load_config');
  32         Hook::unregister('register_account', 'addon/testdrive/testdrive.php', 'testdrive_register_account');
  33         Hook::unregister('cron', 'addon/testdrive/testdrive.php', 'testdrive_cron');
  34         Hook::unregister('enotify','addon/testdrive/testdrive.php', 'testdrive_enotify');
  35         Hook::unregister('globaldir_update','addon/testdrive/testdrive.php', 'testdrive_globaldir_update');
  36
  37 }
  38
  39 function testdrive_load_config(App $a, ConfigFileLoader $loader)
  40 {
  41         $a->getConfigCache()->load($loader->loadAddonConfig('testdrive'));
  42 }
  43
  44 function testdrive_globaldir_update($a,&$b) {
  45         $b['url'] = '';
  46 }
  47
  48 function testdrive_register_account($a,$b) {
  49
  50         $uid = $b;
  51
  52         $days = Config::get('testdrive','expiredays');
  53         if(! $days)
  54                 return;
  55
  56         $r = q("UPDATE user set account_expires_on = '%s' where uid = %d",
  57                 DBA::escape(DateTimeFormat::convert('now +' . $days . ' days')),
  58                 intval($uid)
  59         );
  60
  61 };
  62
  63
  64 function testdrive_cron($a,$b) {
  65         $r = q("select * from user where account_expires_on < UTC_TIMESTAMP() + INTERVAL 5 DAY and
  66                 expire_notification_sent = '0000-00-00 00:00:00' ");
  67
  68         if(count($r)) {
  69                 foreach($r as $rr) {
  70                         notification([
  71                                 'uid' => $rr['uid'],
  72                                 'type' => NOTIFY_SYSTEM,
  73                                 'system_type' => 'testdrive_expire',
  74                                 'language'     => $rr['language'],
  75                                 'to_name'      => $rr['username'],
  76                                 'to_email'     => $rr['email'],
  77                                 'source_name'  => L10n::t('Administrator'),
  78                                 'source_link'  => $a->getBaseURL(),
  79                                 'source_photo' => $a->getBaseURL() . '/images/person-80.jpg',
  80                         ]);
  81
  82                         q("update user set expire_notification_sent = '%s' where uid = %d",
  83                                 DBA::escape(DateTimeFormat::utcNow()),
  84                                 intval($rr['uid'])
  85                         );
  86
  87                 }
  88         }
  89
  90         $r = q("select * from user where account_expired = 1 and account_expires_on < UTC_TIMESTAMP() - INTERVAL 5 DAY ");
  91         if(count($r)) {
  92                 foreach($r as $rr) {
  93                         User::remove($rr['uid']);
  94                 }
  95         }
  96 }
  97
  98 function testdrive_enotify(&$a, &$b) {
  99     if (!empty($b['params']) && $b['params']['type'] == NOTIFY_SYSTEM
 100                 && !empty($b['params']['system_type']) && $b['params']['system_type'] === 'testdrive_expire') {
 101         $b['itemlink'] = $a->getBaseURL();
 102         $b['epreamble'] = $b['preamble'] = L10n::t('Your account on %s will expire in a few days.', Config::get('system', 'sitename'));
 103         $b['subject'] = L10n::t('Your Friendica test account is about to expire.');
 104         $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());
 105     }
 106 }