friendica-addons/randplace/randplace.php

158 lines
4 KiB
PHP
Raw Permalink Normal View History

2011-09-25 08:56:03 +00:00
<?php
/**
* Name: Random place
* Description: Sample Friendica addon. Set a random place when posting.
2011-09-25 08:56:03 +00:00
* Version: 1.0
* Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
2018-01-15 13:15:33 +00:00
*
*
*
2011-09-25 08:56:03 +00:00
*
2012-04-11 12:24:45 +00:00
* Addons are registered with the system through the admin
* panel.
2011-09-25 08:56:03 +00:00
*
* When registration is detected, the system calls the addon
2011-09-25 08:56:03 +00:00
* name_install() function, located in 'addon/name/name.php',
* where 'name' is the name of the addon.
2018-01-15 13:15:33 +00:00
* If the addon is removed from the configuration list, the
2011-09-25 08:56:03 +00:00
* system will call the name_uninstall() function.
*
*/
use Friendica\App;
use Friendica\Core\Hook;
use Friendica\Core\Logger;
use Friendica\Core\Renderer;
use Friendica\DI;
2011-09-25 08:56:03 +00:00
function randplace_install()
{
/*
* Our demo addon will attach in three places.
2011-09-25 08:56:03 +00:00
* The first is just prior to storing a local post.
*/
Hook::register('post_local', 'addon/randplace/randplace.php', 'randplace_post_hook');
2011-09-25 08:56:03 +00:00
/*
* Then we'll attach into the addon settings page, and also the
2011-09-25 08:56:03 +00:00
* settings post hook so that we can create and update
* user preferences.
*/
Hook::register('addon_settings', 'addon/randplace/randplace.php', 'randplace_settings');
Hook::register('addon_settings_post', 'addon/randplace/randplace.php', 'randplace_settings_post');
2011-09-25 08:56:03 +00:00
Logger::notice("installed randplace");
2011-09-25 08:56:03 +00:00
}
function randplace_uninstall()
{
/*
* This function should undo anything that was done in name_install()
*
* Except hooks, they are all unregistered automatically and don't need to be unregistered manually.
2011-09-25 08:56:03 +00:00
*/
Logger::notice("removed randplace");
2011-09-25 08:56:03 +00:00
}
function randplace_post_hook(&$item)
{
/*
2011-09-25 08:56:03 +00:00
* An item was posted on the local system.
* We are going to look for specific items:
* - A status post by a profile owner
* - The profile owner must have allowed our addon
2011-09-25 08:56:03 +00:00
*/
Logger::notice('randplace invoked');
2011-09-25 08:56:03 +00:00
2022-10-20 21:51:49 +00:00
if (!DI::userSession()->getLocalUserId()) {
/* non-zero if this is a logged in user of this system */
2011-09-25 08:56:03 +00:00
return;
}
2011-09-25 08:56:03 +00:00
2022-10-20 21:51:49 +00:00
if (DI::userSession()->getLocalUserId() != $item['uid']) {
/* Does this person own the post? */
2011-09-25 08:56:03 +00:00
return;
}
2011-09-25 08:56:03 +00:00
if ($item['parent']) {
/* If the item has a parent, this is a comment or something else, not a status post. */
2011-09-25 08:56:03 +00:00
return;
}
2011-09-25 08:56:03 +00:00
/* Retrieve our personal config setting */
2022-10-20 21:51:49 +00:00
$active = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'randplace', 'enable');
2011-09-25 08:56:03 +00:00
if (!$active) {
2011-09-25 08:56:03 +00:00
return;
}
2011-09-25 08:56:03 +00:00
/**
*
* OK, we're allowed to do our stuff.
* Here's what we are going to do:
* load the list of timezone names, and use that to generate a list of world cities.
* Then we'll pick one of those at random and put it in the "location" field for the post.
*
*/
2018-01-15 13:15:33 +00:00
$cities = [];
2011-09-25 08:56:03 +00:00
$zones = timezone_identifiers_list();
foreach($zones as $zone) {
if ((strpos($zone, '/')) && (! stristr($zone, 'US/')) && (! stristr($zone, 'Etc/'))) {
$cities[] = str_replace('_', ' ',substr($zone, strpos($zone, '/') + 1));
}
2011-09-25 08:56:03 +00:00
}
if (!count($cities)) {
2011-09-25 08:56:03 +00:00
return;
}
2011-09-25 08:56:03 +00:00
$city = array_rand($cities,1);
$item['location'] = $cities[$city];
return;
}
/**
* Callback from the settings post function.
* $post contains the $_POST array.
* We will make sure we've got a valid user account
* and if so set our configuration setting for this person.
*/
function randplace_settings_post($post)
{
2022-10-20 21:51:49 +00:00
if (!DI::userSession()->getLocalUserId()) {
2011-09-25 08:56:03 +00:00
return;
}
if ($_POST['randplace-submit']) {
2022-10-20 21:51:49 +00:00
DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'randplace', 'enable', intval($_POST['randplace']));
}
2011-09-25 08:56:03 +00:00
}
/**
* Called from the Addon Setting form.
2011-09-25 08:56:03 +00:00
* Add our own settings info to the page.
*/
function randplace_settings(array &$data)
{
2022-10-20 21:51:49 +00:00
if(!DI::userSession()->getLocalUserId()) {
2011-09-25 08:56:03 +00:00
return;
}
2011-09-25 08:56:03 +00:00
2022-10-20 21:51:49 +00:00
$enabled = DI::pConfig()->get(DI::userSession()->getLocalUserId(),'randplace','enable');
2011-09-25 08:56:03 +00:00
$t = Renderer::getMarkupTemplate('settings.tpl', 'addon/randplace/');
$html = Renderer::replaceMacros($t, [
'$enabled' => ['randplace', DI::l10n()->t('Enable Randplace Addon'), $enabled],
]);
2011-09-25 08:56:03 +00:00
$data = [
'addon' => 'randplace',
'title' => DI::l10n()->t('Randplace Settings'),
'html' => $html,
];
2011-09-25 08:56:03 +00:00
}