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\Hook;
  11 use Friendica\Core\Search;
  12 use Friendica\Database\DBA;
  13 use Friendica\DI;
  14 use Friendica\Model\Notification;
  15 use Friendica\Model\User;
  16 use Friendica\Core\Config\Util\ConfigFileManager;
  17 use Friendica\Util\DateTimeFormat;
  18
  19 function testdrive_install()
  20 {
  21         Hook::register('load_config',      'addon/testdrive/testdrive.php', 'testdrive_load_config');
  22         Hook::register('register_account', 'addon/testdrive/testdrive.php', 'testdrive_register_account');
  23         Hook::register('cron', 'addon/testdrive/testdrive.php', 'testdrive_cron');
  24         Hook::register('enotify','addon/testdrive/testdrive.php', 'testdrive_enotify');
  25         Hook::register('globaldir_update','addon/testdrive/testdrive.php', 'testdrive_globaldir_update');
  26 }
  27
  28 function testdrive_load_config(ConfigFileManager $loader)
  29 {
  30         DI::app()->getConfigCache()->load($loader->loadAddonConfig('testdrive'), \Friendica\Core\Config\ValueObject\Cache::SOURCE_STATIC);
  31 }
  32
  33 function testdrive_globaldir_update(array &$b)
  34 {
  35         $b['url'] = '';
  36 }
  37
  38 function testdrive_register_account($b)
  39 {
  40         $uid = $b;
  41
  42         $days = DI::config()->get('testdrive','expiredays');
  43         if (!$days) {
  44                 return;
  45         }
  46
  47         DBA::update('user', ['account_expires_on' => DateTimeFormat::convert('now +' . $days . ' days')], ['uid' => $uid]);
  48 }
  49
  50
  51 function testdrive_cron($b)
  52 {
  53         $users = DBA::selectToArray('user', [], ["`account_expires_on` < ? AND `expire_notification_sent` <= ?",
  54                 DateTimeFormat::utc('now + 5 days'), DBA::NULL_DATETIME]);
  55
  56         foreach ($users as $rr) {
  57                 DI::notify()->createFromArray([
  58                         'type' => Notification\Type::SYSTEM,
  59                         'uid' => $rr['uid'],
  60                         'system_type' => 'testdrive_expire',
  61                         'source_name'  => DI::l10n()->t('Administrator'),
  62                         'source_link'  => DI::baseUrl(),
  63                         'source_photo' => DI::baseUrl() . '/images/person-80.jpg',
  64                 ]);
  65
  66                 DBA::update('user', ['expire_notification_sent' => DateTimeFormat::utcNow()], ['uid' => $rr['uid']]);
  67         }
  68
  69         $users = DBA::selectToArray('user', [], ["`account_expired` AND `account_expires_on` < ?", DateTimeFormat::utc('now - 5 days')]);
  70         foreach($users as $rr) {
  71                 User::remove($rr['uid']);
  72         }
  73 }
  74
  75 function testdrive_enotify(array &$b)
  76 {
  77         if (!empty($b['params']) && $b['params']['type'] == Notification\Type::SYSTEM
  78                 && !empty($b['params']['system_type']) && $b['params']['system_type'] === 'testdrive_expire') {
  79                 $b['itemlink'] = DI::baseUrl();
  80                 $b['epreamble'] = $b['preamble'] = DI::l10n()->t('Your account on %s will expire in a few days.', DI::config()->get('system', 'sitename'));
  81                 $b['subject'] = DI::l10n()->t('Your Friendica test account is about to expire.');
  82                 $b['body'] = DI::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=".DI::config()->get('system', 'url')."]".DI::config()->get('config', 'sitename')."[/url]", Search::getGlobalDirectory());
  83         }
  84 }