Skip to content

Added a hook to insert addthis toolbar inside header of any page #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Daniel-KM wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added a hook to insert addthis toolbar inside header of any page #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4eec17a
Internalized functions in plugin class.
Daniel-KM Dec 7, 2013
10e7f04
Added a hook to insert addthis toolbar inside header of any page.
Daniel-KM Dec 7, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
214 changes: 194 additions & 20 deletions SocialBookmarkingPlugin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,14 @@
* @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
*/


require_once dirname(__FILE__) . '/helpers/SocialBookmarkingFunctions.php';

/**
* Social Bookmarking plugin.
*/
class SocialBookmarkingPlugin extends Omeka_Plugin_AbstractPlugin
{
const ADDTHIS_SERVICES_URL = 'http://cache.addthiscdn.com/services/v1/sharing.en.xml';
const SERVICE_SETTINGS_OPTION = 'social_bookmarking_services';
const ADD_TO_HEADER_OPTION = 'social_bookmarking_add_to_header';
const ADD_TO_OMEKA_ITEMS_OPTION = 'social_bookmarking_add_to_omeka_items';
const ADD_TO_OMEKA_COLLECTIONS_OPTION = 'social_bookmarking_add_to_omeka_collections';

Expand All @@ -29,6 +27,7 @@ class SocialBookmarkingPlugin extends Omeka_Plugin_AbstractPlugin
'initialize',
'config_form',
'config',
'public_header',
'public_items_show',
'public_collections_show'
);
Expand All @@ -38,16 +37,34 @@ class SocialBookmarkingPlugin extends Omeka_Plugin_AbstractPlugin
*/
protected $_options = array(
'social_bookmarking_services' => '',
'social_bookmarking_add_to_header' => '1',
'social_bookmarking_add_to_omeka_items' => '1',
'social_bookmarking_add_to_omeka_collections' => '1',
);

/**
* @var array Default services.
*/
protected $_defaultEnabledServiceCodes = array(
'facebook',
'twitter',
'linkedin',
'pinterest',
'email',
'google',
'orkut',
'delicious',
'digg',
'stumbleupon',
'yahoobkm'
);

/**
* Install the plugin.
*/
public function hookInstall()
{
$this->_options['social_bookmarking_services'] = serialize(social_bookmarking_get_default_service_settings());
$this->_options['social_bookmarking_services'] = serialize($this->_get_default_service_settings());
$this->_installOptions();
}

Expand All @@ -67,14 +84,14 @@ public function hookUninstall()
public function hookUpgrade($args)
{
$booleanFilter = new Omeka_Filter_Boolean;
$newServiceSettings = social_bookmarking_get_default_service_settings();
$oldServiceSettings = social_bookmarking_get_service_settings();
$newServiceSettings = $this->_get_default_service_settings();
$oldServiceSettings = $this->_get_service_settings();
foreach($newServiceSettings as $serviceCode => $value) {
if (array_key_exists($serviceCode, $oldServiceSettings)) {
$newServiceSettings[$serviceCode] = $booleanFilter->filter($oldServiceSettings[$serviceCode]);
}
}
social_bookmarking_set_service_settings($newServiceSettings);
$this->_set_service_settings($newServiceSettings);
}

/**
Expand All @@ -86,11 +103,26 @@ public function hookInitialize()
}

/**
* Display the plugin config form.
* Render the config form.
*/
public function hookConfigForm()
{
require dirname(__FILE__) . '/config_form.php';
// Set form defaults.
$services = $this->_get_services();
$serviceSettings = $this->_get_service_settings();
$setServices = array();
foreach($services as $serviceCode => $serviceInfo) {
$setServices[$serviceCode] = array_key_exists($serviceCode, $serviceSettings)
? $serviceSettings[$serviceCode]
: false;
}

echo get_view()->partial(
'plugins/social-bookmarking-config-form.php',
array(
'services' => $services,
'setServices' => $setServices,
));
}

/**
Expand All @@ -99,45 +131,187 @@ public function hookConfigForm()
public function hookConfig($args)
{
$post = $args['post'];
unset($post['install_plugin']);

set_option(SocialBookmarkingPlugin::ADD_TO_HEADER_OPTION, $post[SocialBookmarkingPlugin::ADD_TO_HEADER_OPTION]);
set_option(SocialBookmarkingPlugin::ADD_TO_OMEKA_ITEMS_OPTION, $post[SocialBookmarkingPlugin::ADD_TO_OMEKA_ITEMS_OPTION]);
unset($post[SocialBookmarkingPlugin::ADD_TO_OMEKA_ITEMS_OPTION]);

set_option(SocialBookmarkingPlugin::ADD_TO_OMEKA_COLLECTIONS_OPTION, $post[SocialBookmarkingPlugin::ADD_TO_OMEKA_COLLECTIONS_OPTION]);

unset($post[SocialBookmarkingPlugin::ADD_TO_HEADER_OPTION]);
unset($post[SocialBookmarkingPlugin::ADD_TO_OMEKA_ITEMS_OPTION]);
unset($post[SocialBookmarkingPlugin::ADD_TO_OMEKA_COLLECTIONS_OPTION]);

$serviceSettings = social_bookmarking_get_service_settings();
$serviceSettings = $this->_get_service_settings();
$booleanFilter = new Omeka_Filter_Boolean;
foreach($post as $key => $value) {
if (array_key_exists($key, $serviceSettings)) {
$serviceSettings[$key] = $booleanFilter->filter($value);
}
else {
$serviceSettings[$key] = false;
}
}
social_bookmarking_set_service_settings($serviceSettings);
$this->_set_service_settings($serviceSettings);
}

public function hookPublicItemsShow()
/**
* Hook for public header.
*/
public function hookPublicHeader($args)
{
if (get_option(SocialBookmarkingPlugin::ADD_TO_HEADER_OPTION) == '1') {
$view = $args['view'];
$vars = $view->getVars();
$request = Zend_Controller_Front::getInstance()->getRequest();
$params = $request->getParams();

// We need absolute urls and getRequestUri() doesn't return domain.
$url = WEB_ROOT . $request->getPathInfo();
if ($params['action'] == 'show' && in_array($params['controller'], array(
'collections',
'items',
'files',
))) {
$recordType = $view->singularize($params['controller']);
$record = get_current_record($recordType);
$title = isset($vars['title'])
? $vars['title']
: strip_formatting(metadata($record, array('Dublin Core', 'Title')));
$description = strip_formatting(metadata($record, array('Dublin Core', 'Description')));
}
else {
$title= isset($vars['title']) ? $vars['title'] : get_option('site_title');
$description = '';
}
echo $view->partial('social-bookmarking-toolbar.php', array(
'url' => $url,
'title' => $title,
'description' => $description,
'services' => $this->_get_services(),
'serviceSettings' => $this->_get_service_settings(),
));
}
}

/**
* Hook for public items show view.
*/
public function hookPublicItemsShow($args)
{
if (get_option(SocialBookmarkingPlugin::ADD_TO_OMEKA_ITEMS_OPTION) == '1') {
$item = get_current_record('item');
$view = $args['view'];
$item = $args['item'];
$url = record_url($item, 'show', true);
$title = strip_formatting(metadata($item, array('Dublin Core', 'Title')));
$description = strip_formatting(metadata($item, array('Dublin Core', 'Description')));
echo '<h2>' . __('Social Bookmarking') . '</h2>';
echo social_bookmarking_toolbar($url, $title, $description);
echo $view->partial('social-bookmarking-toolbar.php', array(
'url' => $url,
'title' => $title,
'description' => $description,
'services' => $this->_get_services(),
'serviceSettings' => $this->_get_service_settings(),
));
}
}

public function hookPublicCollectionsShow()
/**
* Hook for public collections show view.
*/
public function hookPublicCollectionsShow($args)
{
if (get_option(SocialBookmarkingPlugin::ADD_TO_OMEKA_COLLECTIONS_OPTION) == '1') {
$collection = get_current_record('collection');
$view = $args['view'];
$collection = $args['collection'];
$url = record_url($collection, 'show', true);
$title = strip_formatting(metadata($collection, array('Dublin Core', 'Title')));
$description = strip_formatting(metadata($collection, array('Dublin Core', 'Description')));
echo '<h2>' . __('Social Bookmarking') . '</h2>';
echo social_bookmarking_toolbar($url, $title, $description);
echo $view->partial('social-bookmarking-toolbar.php', array(
'url' => $url,
'title' => $title,
'description' => $description,
'services' => $this->_get_services(),
'serviceSettings' => $this->_get_service_settings(),
));
}
}

/**
* Gets the service settings from the database.
*/
protected function _get_service_settings()
{
$serviceSettings = unserialize(get_option(SocialBookmarkingPlugin::SERVICE_SETTINGS_OPTION));
ksort($serviceSettings);
return $serviceSettings;
}

/**
* Saves the service settings in the database.
*/
protected function _set_service_settings($serviceSettings)
{
set_option(SocialBookmarkingPlugin::SERVICE_SETTINGS_OPTION, serialize($serviceSettings));
}

/**
* Sets default service settings.
*/
protected function _get_default_service_settings()
{
$services = $this->_get_services();
$serviceSettings = array();
foreach($services as $serviceCode => $serviceInfo) {
$serviceSettings[$serviceCode] = in_array($serviceCode, $this->_defaultEnabledServiceCodes);
}
return $serviceSettings;
}

/**
* Gets current services from AddThis.
*/
protected function _get_services()
{
static $services = null;
$booleanFilter = new Omeka_Filter_Boolean;
if (!$services) {
$xml = $this->_get_services_xml();
$services = array();
foreach ($xml->data->services->service as $service) {
$serviceCode = (string)$service->code;
$services[$serviceCode] = array(
'code' => $serviceCode,
'name' => (string)$service->name,
'icon' => (string)$service->icon,
'script_only' => $booleanFilter->filter((string)$service->script_only),
);
}
}
return $services;
}

/**
* Gets one current service from AddThis.
*/
protected function _get_service($serviceCode)
{
$services = $this->_get_services();
if (array_key_exists($serviceCode, $services)) {
return $services[$serviceCode];
}
return null;
}

/**
* Gets list of services from AddThis.
*/
protected function _get_services_xml()
{
static $xml = null;
if (!$xml) {
$file = file_get_contents(SocialBookmarkingPlugin::ADDTHIS_SERVICES_URL);
$xml = new SimpleXMLElement($file);
}
return $xml;
}
}
Loading