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