From 5103c706857719615102eda7cfd823b0723a1476 Mon Sep 17 00:00:00 2001
From: Jeff Tilson <jrtilson@gmail.com>
Date: Fri, 5 Apr 2013 13:35:13 -0400
Subject: Allow pages revisions to be reverted or deleted

---
 mod/pages/actions/annotations/page/delete.php     | 25 +++++++
 mod/pages/languages/en.php                        |  5 ++
 mod/pages/lib/pages.php                           |  7 +-
 mod/pages/pages/pages/edit.php                    | 13 +++-
 mod/pages/start.php                               | 79 ++++++++++++++++++++++-
 mod/pages/views/default/annotation/page.php       | 18 ++++++
 mod/pages/views/default/object/page_top.php       | 26 +++++---
 mod/pages/views/default/pages/sidebar/history.php |  1 +
 8 files changed, 160 insertions(+), 14 deletions(-)
 create mode 100644 mod/pages/actions/annotations/page/delete.php

(limited to 'mod/pages')

diff --git a/mod/pages/actions/annotations/page/delete.php b/mod/pages/actions/annotations/page/delete.php
new file mode 100644
index 000000000..792b7c0bc
--- /dev/null
+++ b/mod/pages/actions/annotations/page/delete.php
@@ -0,0 +1,25 @@
+<?php
+/**
+ * Remove a page (revision) annotation
+ *
+ * @package ElggPages
+ */
+
+// Ensure we're logged in
+if (!elgg_is_logged_in()) {
+	forward();
+}
+
+// Make sure we can get the annotations and entity in question
+$annotation_id = (int) get_input('annotation_id');
+$annotation = elgg_get_annotation_from_id($annotation_id);
+$entity = get_entity($annotation->entity_guid);
+
+if ($annotation && $entity->canEdit() && $annotation->canEdit()) {
+	$annotation->delete();
+	system_message(elgg_echo("pages:revision:delete:success"));
+} else {
+	register_error(elgg_echo("pages:revision:delete:failure"));
+}
+
+forward("pages/history/{$annotation->entity_guid}");
\ No newline at end of file
diff --git a/mod/pages/languages/en.php b/mod/pages/languages/en.php
index 930676b3e..13b6ece2a 100644
--- a/mod/pages/languages/en.php
+++ b/mod/pages/languages/en.php
@@ -25,6 +25,8 @@ $english = array(
 	'pages:history' => "History",
 	'pages:view' => "View page",
 	'pages:revision' => "Revision",
+	'pages:current_revision' => "Current Revision",
+	'pages:revert' => "Revert",
 
 	'pages:navigation' => "Navigation",
 	'pages:new' => "A new page",
@@ -75,6 +77,9 @@ View and comment on the new page:
 	'pages:error:no_title' => 'You must specify a title for this page.',
 	'pages:delete:success' => 'The page was successfully deleted.',
 	'pages:delete:failure' => 'The page could not be deleted.',
+	'pages:revision:delete:success' => 'The page revision was successfully deleted.',
+	'pages:revision:delete:failure' => 'The page revision could not be deleted.',
+	'pages:revision:not_found' => 'Cannot find this revision.',
 
 	/**
 	 * Page
diff --git a/mod/pages/lib/pages.php b/mod/pages/lib/pages.php
index afe42b68f..7f90d53d8 100644
--- a/mod/pages/lib/pages.php
+++ b/mod/pages/lib/pages.php
@@ -9,7 +9,7 @@
  * @param ElggObject $page
  * @return array
  */
-function pages_prepare_form_vars($page = null, $parent_guid = 0) {
+function pages_prepare_form_vars($page = null, $parent_guid = 0, $revision = null) {
 
 	// input names => defaults
 	$values = array(
@@ -41,6 +41,11 @@ function pages_prepare_form_vars($page = null, $parent_guid = 0) {
 
 	elgg_clear_sticky_form('page');
 
+	// load the revision annotation if requested
+	if ($revision instanceof ElggAnnotation && $revision->entity_guid == $page->getGUID()) {
+		$values['description'] = $revision->value;
+	}
+
 	return $values;
 }
 
diff --git a/mod/pages/pages/pages/edit.php b/mod/pages/pages/pages/edit.php
index 1f411b94d..a925cdc55 100644
--- a/mod/pages/pages/pages/edit.php
+++ b/mod/pages/pages/pages/edit.php
@@ -8,6 +8,7 @@
 gatekeeper();
 
 $page_guid = (int)get_input('guid');
+$revision = (int)get_input('annotation_id');
 $page = get_entity($page_guid);
 if (!$page) {
 	register_error(elgg_echo('noaccess'));
@@ -28,7 +29,17 @@ elgg_push_breadcrumb(elgg_echo('edit'));
 $title = elgg_echo("pages:edit");
 
 if ($page->canEdit()) {
-	$vars = pages_prepare_form_vars($page);
+
+	if ($revision) {
+		$revision = elgg_get_annotation_from_id($revision);
+		if (!$revision || !($revision->entity_guid == $page_guid)) {
+			register_error(elgg_echo('pages:revision:not_found'));
+			forward(REFERER);
+		}
+	}
+
+	$vars = pages_prepare_form_vars($page, $page->parent_guid, $revision);
+	
 	$content = elgg_view_form('pages/edit', array(), $vars);
 } else {
 	$content = elgg_echo("pages:noaccess");
diff --git a/mod/pages/start.php b/mod/pages/start.php
index 8debeef24..780d3d9a7 100644
--- a/mod/pages/start.php
+++ b/mod/pages/start.php
@@ -28,9 +28,10 @@ function pages_init() {
 	elgg_register_annotation_url_handler('page', 'pages_revision_url');
 
 	// Register some actions
-	$action_base = elgg_get_plugins_path() . 'pages/actions/pages';
-	elgg_register_action("pages/edit", "$action_base/edit.php");
-	elgg_register_action("pages/delete", "$action_base/delete.php");
+	$action_base = elgg_get_plugins_path() . 'pages/actions';
+	elgg_register_action("pages/edit", "$action_base/pages/edit.php");
+	elgg_register_action("pages/delete", "$action_base/pages/delete.php");
+	elgg_register_action("annotations/page/delete", "$action_base/annotations/page/delete.php");
 
 	// Extend the main css view
 	elgg_extend_view('css/elgg', 'pages/css');
@@ -82,6 +83,9 @@ function pages_init() {
 
 	// register ecml views to parse
 	elgg_register_plugin_hook_handler('get_views', 'ecml', 'pages_ecml_views_hook');
+
+	// hook into annotation menu
+	elgg_register_plugin_hook_handler('register', 'menu:annotation', 'pages_annotation_menu_setup');
 }
 
 /**
@@ -362,3 +366,72 @@ function pages_ecml_views_hook($hook, $entity_type, $return_value, $params) {
 
 	return $return_value;
 }
+
+/**
+ * Adds items to "page" annotations menu
+ *
+ * @param unknown_type $hook
+ * @param unknown_type $entity_type
+ * @param unknown_type $return_value
+ * @param unknown_type $params
+ */
+function pages_annotation_menu_setup($hook, $type, $return, $params) {
+	$annotation = $params['annotation'];
+	/* @var ElggAnnotation $annotation */
+
+	$entity = get_entity($annotation->entity_guid);
+
+	if ($annotation->name == 'page' && $entity->canEdit() && $annotation->canEdit()) {
+		// Get last revision
+		$revisions = elgg_get_annotations(array(
+			'annotation_name' => 'page', 
+			'limit' => 1, 
+			'guid' => $annotation->entity_guid,
+			'reverse_order_by' => true,
+		));
+
+		// Check if this annotation is the last revision
+		if ($revisions) {
+			$current_revision = $revisions[0];
+			if ($current_revision == $annotation) {
+				// Don't allow any actions on last revision, just display 'current revision'
+				$options = array(
+					'name' => 'current',
+					'href' => false,
+					'text' => elgg_echo('pages:current_revision'),
+					'encode_text' => false
+				);
+				$return[] = ElggMenuItem::factory($options);
+				return $return;
+			}
+		}
+
+		// Revert
+		$options = array(
+			'name' => 'revert',
+			'href' => elgg_http_add_url_query_elements("pages/edit/{$annotation->entity_guid}", array(
+				'annotation_id' => $annotation->id
+			)),
+			'text' => elgg_echo('pages:revert'),
+			'encode_text' => false
+		);
+		$return[] = ElggMenuItem::factory($options);
+
+
+		// Delete
+		$url = elgg_http_add_url_query_elements('action/annotations/page/delete', array(
+			'annotation_id' => $annotation->id,
+		));
+
+		$options = array(
+			'name' => 'delete',
+			'href' => $url,
+			'text' => "<span class=\"elgg-icon elgg-icon-delete\"></span>",
+			'confirm' => elgg_echo('deleteconfirm'),
+			'encode_text' => false
+		);
+		$return[] = ElggMenuItem::factory($options);
+	}
+
+	return $return;
+}
diff --git a/mod/pages/views/default/annotation/page.php b/mod/pages/views/default/annotation/page.php
index a621b9281..ecb289092 100644
--- a/mod/pages/views/default/annotation/page.php
+++ b/mod/pages/views/default/annotation/page.php
@@ -39,4 +39,22 @@ $body = <<< HTML
 <p class="elgg-subtext">$subtitle</p>
 HTML;
 
+if (!elgg_in_context('widgets')) {
+	$menu = elgg_view_menu('annotation', array(
+		'annotation' => $annotation,
+		'sort_by' => 'priority',
+		'class' => 'elgg-menu-hz float-alt',
+	));
+}
+
+$body = <<<HTML
+<div class="mbn">
+	$menu
+	<h3>$title_link</h3>
+	<span class="elgg-subtext">
+		$subtitle
+	</span>
+</div>
+HTML;
+
 echo elgg_view_image_block($icon, $body);
\ No newline at end of file
diff --git a/mod/pages/views/default/object/page_top.php b/mod/pages/views/default/object/page_top.php
index 945a22eed..f35202993 100644
--- a/mod/pages/views/default/object/page_top.php
+++ b/mod/pages/views/default/object/page_top.php
@@ -60,18 +60,26 @@ if ($comments_count != 0 && !$revision) {
 	$comments_link = '';
 }
 
-$metadata = elgg_view_menu('entity', array(
-	'entity' => $vars['entity'],
-	'handler' => 'pages',
-	'sort_by' => 'priority',
-	'class' => 'elgg-menu-hz',
-));
-
 $subtitle = "$editor_text $comments_link $categories";
 
 // do not show the metadata and controls in widget view
-if (elgg_in_context('widgets') || $revision) {
-	$metadata = '';
+if (!elgg_in_context('widgets')) {
+	// If we're looking at a revision, display annotation menu
+	if ($revision) {
+		$metadata = elgg_view_menu('annotation', array(
+			'annotation' => $annotation,
+			'sort_by' => 'priority',
+			'class' => 'elgg-menu-hz float-alt',
+		));
+	} else {
+		// Regular entity menu
+		$metadata = elgg_view_menu('entity', array(
+			'entity' => $vars['entity'],
+			'handler' => 'pages',
+			'sort_by' => 'priority',
+			'class' => 'elgg-menu-hz',
+		));
+	}
 }
 
 if ($full) {
diff --git a/mod/pages/views/default/pages/sidebar/history.php b/mod/pages/views/default/pages/sidebar/history.php
index 7077edb9a..e0e8ed11a 100644
--- a/mod/pages/views/default/pages/sidebar/history.php
+++ b/mod/pages/views/default/pages/sidebar/history.php
@@ -14,6 +14,7 @@ if ($vars['page']) {
 		'limit' => 20,
 		'reverse_order_by' => true
 	);
+	elgg_push_context('widgets');
 	$content = elgg_list_annotations($options);
 }
 
-- 
cgit v1.2.3