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