Skip to content
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

Zendified code, fixed controller bugs and upgraded Readme. #27

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Zendified code, fixed controller bugs and upgraded Readme. #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b09a0cb
Added an option to display a checkbox for terms of use.
Daniel-KM Nov 27, 2013
940a960
Moved some files for a better theming, in accordance to Zend.
Daniel-KM Sep 1, 2014
052d3bb
Adapted paths according to the previous commit.
Daniel-KM Sep 1, 2014
3b2397a
Cleaned whitespaces and line endings.
Daniel-KM Sep 1, 2014
60d59d8
Normalized spaces before/after parenthesis and other symbols.
Daniel-KM Sep 1, 2014
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
216 changes: 137 additions & 79 deletions CommentingPlugin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,63 @@
<?php

define('COMMENTING_PLUGIN_DIR', PLUGIN_DIR . '/Commenting');

/**
* CommentingPlugin class
*
* @copyright Copyright 2011-2013 Roy Rosenzweig Center for History and New Media
* @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
* @package Commenting
*/

/**
* Commenting plugin.
*/
class CommentingPlugin extends Omeka_Plugin_AbstractPlugin
{
/**
* @var array Hooks for the plugin.
*/
protected $_hooks = array(
'initialize',
'install',
'upgrade',
'uninstall',
'public_items_show',
'public_collections_show',
'public_head',
'admin_head',
'config_form',
'config',
'define_acl',
'public_head',
'admin_head',
'public_items_show',
'public_collections_show',
'after_delete_record',
'upgrade',
'initialize'
'define_acl',
);

/**
* @var array Filters for the plugin.
*/
protected $_filters = array(
'admin_navigation_main',
'search_record_types',
'api_resources',
'api_extend_items',
'api_extend_collections'
'api_extend_collections',
);

/**
* @var array Options and their default values.
*/
protected $_options = array(
// serialize(array()) = 'a:0:{}'.
'commenting_comment_roles' => 'a:0:{}',
'commenting_moderate_roles' => 'a:0:{}',
'commenting_reqapp_comment_roles' => 'a:0:{}',
'commenting_view_roles' => 'a:0:{}',
'commenting_comments_label' => 'Comments',
'commenting_flag_email' => '',
'commenting_threaded' => false,
'commenting_legal_text' => '',
'commenting_allow_public' => true,
'commenting_require_public_moderation' => true,
'commenting_allow_public_view' => true,
'commenting_wpapi_key' => '',
);

/**
Expand All @@ -38,15 +71,18 @@ public function hookInitialize()
public function setUp()
{

if(plugin_is_active('SimplePages')) {
if (plugin_is_active('SimplePages')) {
$this->_filters[] = 'api_extend_simple_pages';
}
if(plugin_is_active('ExhibitBuilder')) {
if (plugin_is_active('ExhibitBuilder')) {
$this->_filters[] = 'api_extend_exhibit_pages';
}
parent::setUp();
}

/**
* Install the plugin.
*/
public function hookInstall()
{
$db = $this->_db;
Expand All @@ -73,57 +109,70 @@ public function hookInstall()
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
";
$db->query($sql);
set_option('commenting_comment_roles', serialize(array()));
set_option('commenting_moderate_roles', serialize(array()));
set_option('commenting_reqapp_comment_roles', serialize(array()));
set_option('commenting_view_roles', serialize(array()));

$html = '<p>';
$html .= __('I agree with %s terms of use %s and I accept to free my contribution under the licence %s CC BY-SA %s.',
'<a rel="licence" href="#" target="_blank">', '</a>',
'<a rel="licence" href="https://creativecommons.org/licenses/by-sa/3.0/" target="_blank">', '</a>'
);
$html .= '</p>';
$this->_options['commenting_legal_text'] = $html;

$this->_installOptions();
}

/**
* Upgrade the plugin.
*/
public function hookUpgrade($args)
{
$db = $this->_db;
$old = $args['old_version'];
$new = $args['new_version'];

if(version_compare($old, '1.0', '<')) {
if(!get_option('commenting_comment_roles')) {
if (version_compare($old, '1.0', '<')) {
if (!get_option('commenting_comment_roles')) {
$commentRoles = array('super');
set_option('commenting_comment_roles', serialize($commentRoles));
}

if(!get_option('commenting_moderate_roles')) {
if (!get_option('commenting_moderate_roles')) {
$moderateRoles = array('super');
set_option('commenting_moderate_roles', serialize($moderateRoles));
}

if(!get_option('commenting_noapp_comment_roles')) {
if (!get_option('commenting_noapp_comment_roles')) {
set_option('commenting_noapp_comment_roles', serialize(array()));
}

if(!get_option('commenting_view_roles')) {
if (!get_option('commenting_view_roles')) {
set_option('commenting_view_roles', serialize(array()));
}
}

if(version_compare($old, '2.0', '<')) {
if (version_compare($old, '2.0', '<')) {
$sql = "ALTER TABLE `$db->Comment` ADD `flagged` BOOLEAN NOT NULL DEFAULT '0' AFTER `approved` ";
$db->query($sql);
}

if(version_compare($old, '2.1', '<')) {
if (version_compare($old, '2.1', '<')) {
delete_option('commenting_noapp_comment_roles');
set_option('commenting_reqapp_comment_roles', serialize(array()));
$sql = "ALTER TABLE `$db->Comment` CHANGE `flagged` `flagged` TINYINT( 1 ) NOT NULL DEFAULT '0'";
$db->query($sql);
}
}

/**
* Uninstall the plugin.
*/
public function hookUninstall()
{
$db = get_db();
$sql = "DROP TABLE IF EXISTS `$db->Comment`";
$db->query($sql);

$this->_uninstallOptions();
}

public function hookPublicHead()
Expand All @@ -143,33 +192,37 @@ public function hookAfterDeleteRecord($args)
{
$record = $args['record'];
$type = get_class($record);
$comments = get_db()->getTable('Comment')->findBy(array('record_type'=>$type, 'record_id'=>$record->id));
foreach($comments as $comment) {
$comments = get_db()->getTable('Comment')->findBy(array('record_type' => $type, 'record_id' => $record->id));
foreach ($comments as $comment) {
$comment->delete();
}
}

/**
* Helper to append comments and comment form to a page.
*/
public static function showComments($args = array())
{
$view = isset($args['view']) ? $args['view'] : get_view();
echo "<div id='comments-container'>";
if( (get_option('commenting_allow_public') == 1)
if ((get_option('commenting_allow_public') == 1)
|| (get_option('commenting_allow_public_view') == 1)
|| is_allowed('Commenting_Comment', 'show') ) {
if(isset($args['view'])) {
$view = $args['view'];
} else {
$view = get_view();
}

$view->addHelperPath(COMMENTING_PLUGIN_DIR . '/helpers', 'Commenting_View_Helper_');
$options = array('threaded'=> get_option('commenting_threaded'), 'approved'=>true);
|| is_allowed('Commenting_Comment', 'show')
) {
$options = array(
'threaded' => get_option('commenting_threaded'),
'approved' => true,
);

$comments = isset($args['comments']) ? $args['comments'] : $view->getComments($options);
echo $view->partial('comments.php', array('comments'=>$comments, 'threaded'=>$options['threaded']));
echo $view->partial('common/comments.php', array(
'comments' => $comments,
'threaded' => $options['threaded'],
));
}

if( (get_option('commenting_allow_public') == 1)
|| is_allowed('Commenting_Comment', 'add') ) {
if ((get_option('commenting_allow_public') == 1)
|| is_allowed('Commenting_Comment', 'add')) {
echo "<div id='comment-main-container'>";
echo $view->getCommentForm();
echo "</div>";
Expand All @@ -187,26 +240,31 @@ public function hookPublicCollectionsShow($args)
self::showComments($args);
}

public function hookConfigForm()
{
echo get_view()->partial(
'plugins/commenting-config-form.php'
);
}

public function hookConfig($args)
{
$post = $args['post'];
foreach($post as $key=>$value) {
if( ($key == 'commenting_comment_roles') ||
($key == 'commenting_moderate_roles') ||
($key == 'commenting_view_roles') ||
($key == 'commenting_reqapp_comment_roles')
) {
$value = serialize($value);
}
foreach (array(
'commenting_comment_roles',
'commenting_moderate_roles',
'commenting_view_roles',
'commenting_reqapp_comment_roles',
) as $posted) {
$post[$posted] = isset($post[$posted])
? serialize($post[$posted])
: serialize(array());
}
foreach ($post as $key => $value) {
set_option($key, $value);
}
}

public function hookConfigForm()
{
include COMMENTING_PLUGIN_DIR . '/config_form.php';
}

public function hookDefineAcl($args)
{
$acl = $args['acl'];
Expand All @@ -215,43 +273,43 @@ public function hookDefineAcl($args)
$moderateRoles = unserialize(get_option('commenting_moderate_roles'));
$viewRoles = unserialize(get_option('commenting_view_roles'));
$acl->allow(null, 'Commenting_Comment', array('flag'));
if($viewRoles !== false) {
foreach($viewRoles as $role) {
if ($viewRoles !== false) {
foreach ($viewRoles as $role) {
//check that all the roles exist, in case a plugin-added role has been removed (e.g. GuestUser)
if($acl->hasRole($role)) {
if ($acl->hasRole($role)) {
$acl->allow($role, 'Commenting_Comment', 'show');
}
}

foreach($commentRoles as $role) {
if($acl->hasRole($role)) {
foreach ($commentRoles as $role) {
if ($acl->hasRole($role)) {
$acl->allow($role, 'Commenting_Comment', 'add');
}
}

foreach($moderateRoles as $role) {
if($acl->hasRole($role)) {
foreach ($moderateRoles as $role) {
if ($acl->hasRole($role)) {
$acl->allow($role, 'Commenting_Comment', array(
'update-approved',
'update-spam',
'update-flagged',
'batch-delete',
'browse',
'delete'
));
'update-approved',
'update-spam',
'update-flagged',
'batch-delete',
'browse',
'delete',
));
}
}

if(get_option('commenting_allow_public')) {
if (get_option('commenting_allow_public')) {
$acl->allow(null, 'Commenting_Comment', array('show', 'add'));
}
}
}

public function filterAdminNavigationMain($tabs)
{
if(is_allowed('Commenting_Comment', 'update-approved') ) {
$tabs[] = array('uri'=> url('commenting/comment/browse'), 'label'=>__('Comments') );
if (is_allowed('Commenting_Comment', 'update-approved')) {
$tabs[] = array('uri' => url('commenting/comment/browse'), 'label' => __('Comments'));
}

return $tabs;
Expand All @@ -266,9 +324,9 @@ public function filterSearchRecordTypes($types)
public function filterApiResources($apiResources)
{
$apiResources['comments'] = array(
'record_type' => 'Comment',
'actions' => array('get', 'index'),
'index_params' => array('record_type', 'record_id')
'record_type' => 'Comment',
'actions' => array('get', 'index'),
'index_params' => array('record_type', 'record_id'),
);
return $apiResources;
}
Expand Down Expand Up @@ -298,20 +356,20 @@ private function _filterApiExtendRecords($extend, $args)
$record = $args['record'];
$recordClass = get_class($record);
$extend['comments'] = array(
'count' => $this->_countComments($record),
'resource' => 'comments',
'url' => Omeka_Record_Api_AbstractRecordAdapter::getResourceUrl("/comments?record_type=$recordClass&record_id={$record->id}"),
);
'count' => $this->_countComments($record),
'resource' => 'comments',
'url' => Omeka_Record_Api_AbstractRecordAdapter::getResourceUrl("/comments?record_type=$recordClass&record_id={$record->id}"),
);

return $extend;
}

private function _countComments($record)
{
$params = array(
'record_type' => get_class($record),
'record_id' => $record->id
);
'record_type' => get_class($record),
'record_id' => $record->id
);
return get_db()->getTable('Comment')->count($params);
}
}
0 README → README.md
View file
Open in desktop
File renamed without changes.
Loading