krynn/krynn.php

   1 <?php
   2 /**
   3  * Name: Dragonlance Krynn locales
   4  * Description: Set a random locale from the Dragonlance Realm of Krynn when posting. Based on the planets frindica addon by Mike Macgirvin and Tony Baldwin
   5  * Version: 1.0
   6  * Planets Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
   7  * Planets Author: Tony Baldwin <https://free-haven.org/profile/tony>
   8  * Author: Dylan Thiedeke <https://theronin.net/profile/swathe>
   9  *
  10  *"My body was my sacrifice... for my magic. This damage is permanent." - Raistlin Majere
  11  */
  12 use Friendica\Core\Hook;
  13 use Friendica\Core\L10n;
  14 use Friendica\Core\Logger;
  15 use Friendica\Core\PConfig;
  16 use Friendica\DI;
  17
  18 function krynn_install() {
  19
  20         /**
  21          *
  22          * Our demo addon will attach in three places.
  23          * The first is just prior to storing a local post.
  24          *
  25          */
  26
  27         Hook::register('post_local', 'addon/krynn/krynn.php', 'krynn_post_hook');
  28
  29         /**
  30          *
  31          * Then we'll attach into the addon settings page, and also the
  32          * settings post hook so that we can create and update
  33          * user preferences.
  34          *
  35          */
  36
  37         Hook::register('addon_settings', 'addon/krynn/krynn.php', 'krynn_settings');
  38         Hook::register('addon_settings_post', 'addon/krynn/krynn.php', 'krynn_settings_post');
  39
  40         Logger::log("installed krynn");
  41 }
  42
  43
  44 function krynn_uninstall() {
  45
  46         /**
  47          *
  48          * uninstall unregisters any hooks created with register_hook
  49          * during install. It may also delete configuration settings
  50          * and any other cleanup.
  51          *
  52          */
  53
  54         Hook::unregister('post_local',    'addon/krynn/krynn.php', 'krynn_post_hook');
  55         Hook::unregister('addon_settings', 'addon/krynn/krynn.php', 'krynn_settings');
  56         Hook::unregister('addon_settings_post', 'addon/krynn/krynn.php', 'krynn_settings_post');
  57
  58
  59         Logger::log("removed krynn");
  60 }
  61
  62
  63
  64 function krynn_post_hook($a, &$item) {
  65
  66         /**
  67          *
  68          * An item was posted on the local system.
  69          * We are going to look for specific items:
  70          *      - A status post by a profile owner
  71          *      - The profile owner must have allowed our addon
  72          *
  73          */
  74
  75         Logger::log('krynn invoked');
  76
  77         if(! local_user())   /* non-zero if this is a logged in user of this system */
  78                 return;
  79
  80         if(local_user() != $item['uid'])    /* Does this person own the post? */
  81                 return;
  82
  83         if($item['parent'])   /* If the item has a parent, this is a comment or something else, not a status post. */
  84                 return;
  85
  86         /* Retrieve our personal config setting */
  87
  88         $active = PConfig::get(local_user(), 'krynn', 'enable');
  89
  90         if(! $active)
  91                 return;
  92
  93         /**
  94          *
  95          * OK, we're allowed to do our stuff.
  96          * Here's what we are going to do:
  97          * load the list of timezone names, and use that to generate a list of krynn locales.
  98          * Then we'll pick one of those at random and put it in the "location" field for the post.
  99          *
 100          */
 101
 102         $krynn = ['Ansalon','Abanasinia','Solace','Haven','Gateway','Qualinost','Ankatavaka','Pax Tharkas','Ergoth','Newsea','Straights of Schallsea','Plains of Dust','Tarsis','Barren Hills','Que Shu','Citadel of Light','Solinari','Hedge Maze','Tower of High Sorcery','Inn of the Last Home','Last Heroes Tomb','Academy of Sorcery','Gods Row','Temple of Majere','Temple of Kiri-Jolith','Temple of Mishakal','Temple of Zeboim','The Trough','Sad Town','Xak Tsaroth','Zhaman','Skullcap','Saifhum','Karthay','Mithas','Kothas','Silver Dragon Mountain','Silvanesti'];
 103
 104         $planet = array_rand($krynn,1);
 105         $item['location'] = $krynn[$planet];
 106
 107         return;
 108 }
 109
 110
 111
 112
 113 /**
 114  *
 115  * Callback from the settings post function.
 116  * $post contains the $_POST array.
 117  * We will make sure we've got a valid user account
 118  * and if so set our configuration setting for this person.
 119  *
 120  */
 121
 122 function krynn_settings_post($a,$post) {
 123         if(! local_user())
 124                 return;
 125         if($_POST['krynn-submit'])
 126                 PConfig::set(local_user(),'krynn','enable',intval($_POST['krynn']));
 127 }
 128
 129
 130 /**
 131  *
 132  * Called from the addon Setting form.
 133  * Add our own settings info to the page.
 134  *
 135  */
 136
 137
 138
 139 function krynn_settings(&$a,&$s) {
 140
 141         if(! local_user())
 142                 return;
 143
 144         /* Add our stylesheet to the page so we can make our settings look nice */
 145
 146         $a->page['htmlhead'] .= '<link rel="stylesheet"  type="text/css" href="' . DI::baseUrl()->get() . '/addon/krynn/krynn.css' . '" media="all" />' . "\r\n";
 147
 148         /* Get the current state of our config variable */
 149
 150         $enabled = PConfig::get(local_user(),'krynn','enable');
 151
 152         $checked = (($enabled) ? ' checked="checked" ' : '');
 153
 154         /* Add some HTML to the existing form */
 155
 156     $s .= '<span id="settings_krynn_inflated" class="settings-block fakelink" style="display: block;" onclick="openClose(\'settings_krynn_expanded\'); openClose(\'settings_krynn_inflated\');">';
 157         $s .= '<h3>' . L10n::t('Krynn') . '</h3>';
 158         $s .= '</span>';
 159         $s .= '<div id="settings_krynn_expanded" class="settings-block" style="display: none;">';
 160         $s .= '<span class="fakelink" onclick="openClose(\'settings_krynn_expanded\'); openClose(\'settings_krynn_inflated\');">';
 161         $s .= '<h3>' . L10n::t('Krynn') . '</h3>';
 162         $s .= '</span>';
 163
 164
 165     $s .= '<div class="settings-block">';
 166         $s .= '<h3>' . L10n::t('Krynn Settings') . '</h3>';
 167         $s .= '<div id="krynn-enable-wrapper">';
 168         $s .= '<label id="krynn-enable-label" for="krynn-checkbox">' . L10n::t('Enable Krynn Addon') . '</label>';
 169         $s .= '<input id="krynn-checkbox" type="checkbox" name="krynn" value="1" ' . $checked . '/>';
 170         $s .= '</div><div class="clear"></div></div>';
 171         /* provide a submit button */
 172
 173         $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="krynn-submit" class="settings-submit" value="' . L10n::t('Save Settings') . '" /></div></div>';
 174
 175 }
 176
 177