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\Notify\Type;
  15 use Friendica\Model\User;
  16 use Friendica\Util\ConfigFileLoader;
  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
  29
  30 function testdrive_uninstall() {
  31
  32         Hook::unregister('load_config',      'addon/testdrive/testdrive.php', 'testdrive_load_config');
  33         Hook::unregister('register_account', 'addon/testdrive/testdrive.php', 'testdrive_register_account');
  34         Hook::unregister('cron', 'addon/testdrive/testdrive.php', 'testdrive_cron');
  35         Hook::unregister('enotify','addon/testdrive/testdrive.php', 'testdrive_enotify');
  36         Hook::unregister('globaldir_update','addon/testdrive/testdrive.php', 'testdrive_globaldir_update');
  37
  38 }
  39
  40 function testdrive_load_config(App $a, ConfigFileLoader $loader)
  41 {
  42         $a->getConfigCache()->load($loader->loadAddonConfig('testdrive'));
  43 }
  44
  45 function testdrive_globaldir_update($a,&$b) {
  46         $b['url'] = '';
  47 }
  48
  49 function testdrive_register_account($a,$b) {
  50
  51         $uid = $b;
  52
  53         $days = DI::config()->get('testdrive','expiredays');
  54         if(! $days)
  55                 return;
  56
  57         $r = q("UPDATE user set account_expires_on = '%s' where uid = %d",
  58                 DBA::escape(DateTimeFormat::convert('now +' . $days . ' days')),
  59                 intval($uid)
  60         );
  61
  62 };
  63
  64
  65 function testdrive_cron($a,$b) {
  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' => Type::SYSTEM,
  74                                 'system_type' => 'testdrive_expire',
  75                                 'language'     => $rr['language'],
  76                                 'to_name'      => $rr['username'],
  77                                 'to_email'     => $rr['email'],
  78                                 'source_name'  => DI::l10n()->t('Administrator'),
  79                                 'source_link'  => DI::baseUrl()->get(),
  80                                 'source_photo' => DI::baseUrl()->get() . '/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'] == Type::SYSTEM
 101                 && !empty($b['params']['system_type']) && $b['params']['system_type'] === 'testdrive_expire') {
 102         $b['itemlink'] = DI::baseUrl()->get();
 103         $b['epreamble'] = $b['preamble'] = DI::l10n()->t('Your account on %s will expire in a few days.', DI::config()->get('system', 'sitename'));
 104         $b['subject'] = DI::l10n()->t('Your Friendica test account is about to expire.');
 105         $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());
 106     }
 107 }