Merge pull request #246 from contactashish13/issue-243

add revision support

Author: selul

classes/Visualizer/Module.php

@@ -323,6 +323,50 @@ private function _getHTML( $rows ) {
 		);
 	}
 
+	/**
+	 * Undo revisions for the chart, and if necessary, restore the earliest version.
+	 *
+	 * @return bool If any revisions were found.
+	 */
+	protected function undoRevisions( $chart_id, $restore = false ) {
+		$revisions = wp_get_post_revisions( $chart_id, array( 'order' => 'ASC' ) );
+		if ( $revisions ) {
+			$revision_ids = array_keys( $revisions );
+
+			// when we restore, a new revision is likely to be created. so, let's disable revisions for the time being.
+			add_filter( 'wp_revisions_to_keep', '__return_false' );
+
+			if ( $restore ) {
+				// restore to the oldest one i.e. the first one.
+				wp_restore_post_revision( $revision_ids[0] );
+			}
+
+			// delete all revisions.
+			foreach ( $revision_ids as $id ) {
+				wp_delete_post_revision( $id );
+			}
+
+			return true;
+		}
+		return false;
+	}
+
+	/**
+	 * If existing revisions exist for the chart, restore the earliest version and then create a new revision to initiate editing.
+	 */
+	protected function handleExistingRevisions( $chart_id, $chart ) {
+		// undo revisions.
+		$revisions_found    = $this->undoRevisions( $chart_id, true );
+		// create revision for the edit action.
+		wp_save_post_revision( $chart_id );
+
+		if ( $revisions_found ) {
+			// fetch chart data again in case it was updated by an earlier revision.
+			$chart = get_post( $chart_id );
+		}
+		return $chart;
+	}
+
 	/**
 	 * Returns the language of the locale.
 	 *
@@ -339,4 +383,5 @@ protected function get_language() {
 		}
 		return reset( $array );
 	}
+
 }

classes/Visualizer/Module/Admin.php

@@ -62,9 +62,71 @@ public function __construct( Visualizer_Plugin $plugin ) {
 		$this->_addFilter( 'visualizer_get_chart_counts', 'getChartCountsByTypeAndMeta' );
 		$this->_addFilter( 'visualizer_feedback_review_trigger', 'feedbackReviewTrigger' );
 
+		// revision support.
+		$this->_addFilter( 'wp_revisions_to_keep', 'limitRevisions', null, 10, 2 );
+		$this->_addAction( '_wp_put_post_revision', 'addRevision', null, 10, 1 );
+		$this->_addAction( 'wp_restore_post_revision', 'restoreRevision', null, 10, 2 );
+
 		$this->_addAction( 'admin_init', 'init' );
 	}
 
+	/**
+	 * No limits on revisions.
+	 */
+	public function limitRevisions( $num, $post ) {
+		if ( Visualizer_Plugin::CPT_VISUALIZER === $post->post_type ) {
+			return -1;
+		}
+		return $num;
+	}
+
+	/**
+	 * Add a revision.
+	 */
+	public function addRevision( $revision_id ) {
+		$parent_id = wp_is_post_revision( $revision_id );
+		if ( Visualizer_Plugin::CPT_VISUALIZER === get_post_type( $parent_id ) ) {
+			// add the meta data to this revision.
+			$meta = get_post_meta( $parent_id, '', true );
+
+			if ( $meta ) {
+				foreach ( $meta as $key => $value ) {
+					if ( 0 === strpos( $key, 'visualizer' ) ) {
+						add_metadata( 'post', $revision_id, $key, maybe_unserialize( $value[0] ) );
+					}
+				}
+			}
+		}
+	}
+
+	/**
+	 * Restore a revision.
+	 */
+	public function restoreRevision( $post_id, $revision_id ) {
+		if ( Visualizer_Plugin::CPT_VISUALIZER === get_post_type( $post_id ) ) {
+			// get the meta information from the revision.
+			$meta = get_metadata( 'post', $revision_id, '', true );
+
+			// delete all meta information from the post before adding.
+			$post_meta = get_post_meta( $post_id, '', true );
+			if ( $post_meta ) {
+				foreach ( $meta as $key => $value ) {
+					if ( 0 === strpos( $key, 'visualizer' ) ) {
+						delete_post_meta( $post_id, $key );
+					}
+				}
+			}
+
+			if ( $meta ) {
+				foreach ( $meta as $key => $value ) {
+					if ( 0 === strpos( $key, 'visualizer' ) ) {
+						add_post_meta( $post_id, $key, maybe_unserialize( $value[0] ) );
+					}
+				}
+			}
+		}
+	}
+
 	/**
 	 * Admin init.
 	 *
@@ -441,6 +503,10 @@ public function renderLibraryPage() {
 		$query  = new WP_Query( $query_args );
 		while ( $query->have_posts() ) {
 			$chart = $query->next_post();
+
+			// if the user has updated a chart and instead of saving it, has closed the modal. If the user refreshes, they should get the original chart.
+			$chart = $this->handleExistingRevisions( $chart->ID, $chart );
+
 			// fetch and update settings
 			$settings = get_post_meta( $chart->ID, Visualizer_Plugin::CF_SETTINGS, true );
 			unset( $settings['height'], $settings['width'] );

classes/Visualizer/Module/Chart.php

@@ -57,9 +57,7 @@ public function __construct( Visualizer_Plugin $plugin ) {
 		$this->_addAjaxAction( Visualizer_Plugin::ACTION_EDIT_CHART, 'renderChartPages' );
 		$this->_addAjaxAction( Visualizer_Plugin::ACTION_UPLOAD_DATA, 'uploadData' );
 		$this->_addAjaxAction( Visualizer_Plugin::ACTION_CLONE_CHART, 'cloneChart' );
-		// Added by Ash/Upwork
 		$this->_addAjaxAction( Visualizer_Plugin::ACTION_EXPORT_DATA, 'exportData' );
-		// Added by Ash/Upwork
 	}
 
 	/**
@@ -273,6 +271,17 @@ public function renderChartPages() {
 			$tab = 'settings';
 		}
 
+		if ( isset( $_POST['cancel'] ) && 1 === intval( $_POST['cancel'] ) ) {
+			// if the cancel button is clicked.
+			$this->undoRevisions( $chart_id, true );
+		} elseif ( isset( $_POST['save'] ) && 1 === intval( $_POST['save'] ) ) {
+			// if the save button is clicked.
+			$this->undoRevisions( $chart_id, false );
+		} else {
+			// if the edit button is clicked.
+			$this->_chart = $this->handleExistingRevisions( $chart_id, $this->_chart );
+		}
+
 		switch ( $tab ) {
 			case 'settings':
 				$this->_handleDataAndSettingsPage();
@@ -357,6 +366,9 @@ private function _handleDataAndSettingsPage() {
 			$render->button = filter_input( INPUT_GET, 'action' ) == Visualizer_Plugin::ACTION_EDIT_CHART
 				? esc_html__( 'Save Chart', 'visualizer' )
 				: esc_html__( 'Create Chart', 'visualizer' );
+			if ( filter_input( INPUT_GET, 'action' ) == Visualizer_Plugin::ACTION_EDIT_CHART ) {
+				$render->cancel_button = esc_html__( 'Cancel', 'visualizer' );
+			}
 		} else {
 			$render->button = esc_attr__( 'Insert Chart', 'visualizer' );
 		}
@@ -599,4 +611,5 @@ private function _handleDataPage() {
 		$this->_addAction( 'admin_head', 'renderFlattrScript' );
 		wp_iframe( array( $render, 'render' ) );
 	}
+
 }

classes/Visualizer/Module/Setup.php

@@ -110,6 +110,7 @@ public function setupCustomPostTypes() {
 			Visualizer_Plugin::CPT_VISUALIZER, array(
 				'label'  => 'Visualizer Charts',
 				'public' => false,
+				'supports' => array( 'revisions' ),
 			)
 		);
 	}

classes/Visualizer/Render/Page/Data.php

@@ -254,6 +254,10 @@ class="dashicons dashicons-lock"></span></h2>
 					<form id="settings-form" action="<?php echo add_query_arg( 'nonce', wp_create_nonce() ); ?>"
 						  method="post">
 						<?php echo $this->sidebar; ?>
+						<input type="hidden" name="save" value="1">
+					</form>
+					<form id="cancel-form" action="<?php echo add_query_arg( 'nonce', wp_create_nonce() ); ?>" method="post">
+						<input type="hidden" name="cancel" value="1">
 					</form>
 				</ul>
 			</li>
@@ -415,6 +419,9 @@ protected function _renderToolbar() {
 			echo '</div>';
 		}
 		echo '<input type="submit" id="settings-button" class="button button-primary button-large push-right" value="', $this->button, '">';
+		if ( isset( $this->cancel_button ) ) {
+			echo '<input type="submit" id="cancel-button" class="button button-secondary button-large push-right" value="', $this->cancel_button, '">';
+		}
 	}
 
 }

css/library.css

@@ -287,3 +287,7 @@ input:checked + .visualizer-slider:before {
 	font-weight: bold;
 	text-align: center;
 }
+
+button.media-modal-close {
+	display: none !important;
+}

js/frame.js

@@ -72,6 +72,10 @@
             return false;
         });
 
+        $('#cancel-button').click(function () {
+            $('#cancel-form').submit();
+        });
+
     });
 
     function init_permissions(){