planets/planets.php

   1 <?php
   2 /**
   3  * Name: Random Planet, Empirial Version
   4  * Description: Sample Friendica addon. Set a random planet from the Emprire when posting.
   5  * Version: 1.0
   6  * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
   7  * Author: Tony Baldwin <https://free-haven.org/profile/tony>
   8  */
   9 use Friendica\Core\Hook;
  10 use Friendica\Core\L10n;
  11 use Friendica\Core\Logger;
  12 use Friendica\Core\PConfig;
  13 use Friendica\DI;
  14
  15 function planets_install() {
  16
  17         /**
  18          *
  19          * Our demo addon will attach in three places.
  20          * The first is just prior to storing a local post.
  21          *
  22          */
  23
  24         Hook::register('post_local', 'addon/planets/planets.php', 'planets_post_hook');
  25
  26         /**
  27          *
  28          * Then we'll attach into the addon settings page, and also the
  29          * settings post hook so that we can create and update
  30          * user preferences.
  31          *
  32          */
  33
  34         Hook::register('addon_settings', 'addon/planets/planets.php', 'planets_settings');
  35         Hook::register('addon_settings_post', 'addon/planets/planets.php', 'planets_settings_post');
  36
  37         Logger::log("installed planets");
  38 }
  39
  40
  41 function planets_uninstall() {
  42
  43         /**
  44          *
  45          * uninstall unregisters any hooks created with register_hook
  46          * during install. It may also delete configuration settings
  47          * and any other cleanup.
  48          *
  49          */
  50
  51         Hook::unregister('post_local',    'addon/planets/planets.php', 'planets_post_hook');
  52         Hook::unregister('addon_settings', 'addon/planets/planets.php', 'planets_settings');
  53         Hook::unregister('addon_settings_post', 'addon/planets/planets.php', 'planets_settings_post');
  54
  55
  56         Logger::log("removed planets");
  57 }
  58
  59
  60
  61 function planets_post_hook($a, &$item) {
  62
  63         /**
  64          *
  65          * An item was posted on the local system.
  66          * We are going to look for specific items:
  67          *      - A status post by a profile owner
  68          *      - The profile owner must have allowed our addon
  69          *
  70          */
  71
  72         Logger::log('planets invoked');
  73
  74         if(! local_user())   /* non-zero if this is a logged in user of this system */
  75                 return;
  76
  77         if(local_user() != $item['uid'])    /* Does this person own the post? */
  78                 return;
  79
  80         if($item['parent'])   /* If the item has a parent, this is a comment or something else, not a status post. */
  81                 return;
  82
  83         /* Retrieve our personal config setting */
  84
  85         $active = DI::pConfig()->get(local_user(), 'planets', 'enable');
  86
  87         if(! $active)
  88                 return;
  89
  90         /**
  91          *
  92          * OK, we're allowed to do our stuff.
  93          * Here's what we are going to do:
  94          * load the list of timezone names, and use that to generate a list of world planets.
  95          * Then we'll pick one of those at random and put it in the "location" field for the post.
  96          *
  97          */
  98
  99         $planets = ['Alderaan','Tatooine','Dagobah','Polis Massa','Coruscant','Hoth','Endor','Kamino','Rattatak','Mustafar','Iego','Geonosis','Felucia','Dantooine','Ansion','Artaru','Bespin','Boz Pity','Cato Neimoidia','Christophsis','Kashyyyk','Kessel','Malastare','Mygeeto','Nar Shaddaa','Ord Mantell','Saleucami','Subterrel','Death Star','Teth','Tund','Utapau','Yavin'];
 100
 101         $planet = array_rand($planets,1);
 102         $item['location'] = $planets[$planet];
 103
 104         return;
 105 }
 106
 107
 108
 109
 110 /**
 111  *
 112  * Callback from the settings post function.
 113  * $post contains the $_POST array.
 114  * We will make sure we've got a valid user account
 115  * and if so set our configuration setting for this person.
 116  *
 117  */
 118
 119 function planets_settings_post($a,$post) {
 120         if(! local_user())
 121                 return;
 122         if($_POST['planets-submit'])
 123                 PConfig::set(local_user(),'planets','enable',intval($_POST['planets']));
 124 }
 125
 126
 127 /**
 128  *
 129  * Called from the Addon Setting form.
 130  * Add our own settings info to the page.
 131  *
 132  */
 133
 134
 135
 136 function planets_settings(&$a,&$s) {
 137
 138         if(! local_user())
 139                 return;
 140
 141         /* Add our stylesheet to the page so we can make our settings look nice */
 142
 143         DI::page()['htmlhead'] .= '<link rel="stylesheet"  type="text/css" href="' . DI::baseUrl()->get() . '/addon/planets/planets.css' . '" media="all" />' . "\r\n";
 144
 145         /* Get the current state of our config variable */
 146
 147         $enabled = DI::pConfig()->get(local_user(),'planets','enable');
 148
 149         $checked = (($enabled) ? ' checked="checked" ' : '');
 150
 151         /* Add some HTML to the existing form */
 152
 153     $s .= '<span id="settings_planets_inflated" class="settings-block fakelink" style="display: block;" onclick="openClose(\'settings_planets_expanded\'); openClose(\'settings_planets_inflated\');">';
 154         $s .= '<h3>' . L10n::t('Planets') . '</h3>';
 155         $s .= '</span>';
 156         $s .= '<div id="settings_planets_expanded" class="settings-block" style="display: none;">';
 157         $s .= '<span class="fakelink" onclick="openClose(\'settings_planets_expanded\'); openClose(\'settings_planets_inflated\');">';
 158         $s .= '<h3>' . L10n::t('Planets') . '</h3>';
 159         $s .= '</span>';
 160
 161     $s .= '<div class="settings-block">';
 162         $s .= '<h3>' . L10n::t('Planets Settings') . '</h3>';
 163         $s .= '<div id="planets-enable-wrapper">';
 164         $s .= '<label id="planets-enable-label" for="planets-checkbox">' . L10n::t('Enable Planets Addon') . '</label>';
 165         $s .= '<input id="planets-checkbox" type="checkbox" name="planets" value="1" ' . $checked . '/>';
 166         $s .= '</div><div class="clear"></div></div>';
 167
 168         /* provide a submit button */
 169
 170         $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="planets-submit" class="settings-submit" value="' . L10n::t('Save Settings') . '" /></div></div>';
 171
 172 }